b4e2a5a834163f3561ef6d80e6a9476cc8fddc83
[exim.git] / src / src / expand.c
1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2014 */
6 /* See the file NOTICE for conditions of use and distribution. */
7
8
9 /* Functions for handling string expansion. */
10
11
12 #include "exim.h"
13
14 /* Recursively called function */
15
16 static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *);
17 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
18
19 #ifdef STAND_ALONE
20 #ifndef SUPPORT_CRYPTEQ
21 #define SUPPORT_CRYPTEQ
22 #endif
23 #endif
24
25 #ifdef LOOKUP_LDAP
26 #include "lookups/ldap.h"
27 #endif
28
29 #ifdef SUPPORT_CRYPTEQ
30 #ifdef CRYPT_H
31 #include <crypt.h>
32 #endif
33 #ifndef HAVE_CRYPT16
34 extern char* crypt16(char*, char*);
35 #endif
36 #endif
37
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
42
43 <quote>
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. Charaters after the first 16 are ignored. It always generates
50 a 16-byte hash, which is expressed together with the salt as a string
51 of 24 base 64 digits. Here are some links to peruse:
52
53 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
54 http://seclists.org/bugtraq/1999/Mar/0076.html
55
56 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
57 and OSF/1. This is the same as the standard crypt if given a password
58 of 8 characters or less. If given more, it first does the same as crypt
59 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
60 using as salt the first two base 64 digits from the first hash block.
61 If the password is more than 16 characters then it crypts the 17th to 24th
62 characters using as salt the first two base 64 digits from the second hash
63 block. And so on: I've seen references to it cutting off the password at
64 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
65
66 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
67 http://seclists.org/bugtraq/1999/Mar/0109.html
68 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
69 TET1_html/sec.c222.html#no_id_208
70
71 Exim has something it calls "crypt16". It will either use a native
72 crypt16 or its own implementation. A native crypt16 will presumably
73 be the one that I called "crypt16" above. The internal "crypt16"
74 function, however, is a two-block-maximum implementation of what I called
75 "bigcrypt". The documentation matches the internal code.
76
77 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
78 that crypt16 and bigcrypt were different things.
79
80 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
81 to whatever it is using under that name. This unfortunately sets a
82 precedent for using "{crypt16}" to identify two incompatible algorithms
83 whose output can't be distinguished. With "{crypt16}" thus rendered
84 ambiguous, I suggest you deprecate it and invent two new identifiers
85 for the two algorithms.
86
87 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
88 of the password separately means they can be cracked separately, so
89 the double-length hash only doubles the cracking effort instead of
90 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
91 bcrypt ({CRYPT}$2a$).
92 </quote>
93 */
94
95
96
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
100
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
103
104 static uschar *item_table[] = {
105 US"acl",
106 US"certextract",
107 US"dlfunc",
108 US"extract",
109 US"filter",
110 US"hash",
111 US"hmac",
112 US"if",
113 #ifdef EXPERIMENTAL_INTERNATIONAL
114 US"imapfolder",
115 #endif
116 US"length",
117 US"listextract",
118 US"lookup",
119 US"map",
120 US"nhash",
121 US"perl",
122 US"prvs",
123 US"prvscheck",
124 US"readfile",
125 US"readsocket",
126 US"reduce",
127 US"run",
128 US"sg",
129 US"sort",
130 US"substr",
131 US"tr" };
132
133 enum {
134 EITEM_ACL,
135 EITEM_CERTEXTRACT,
136 EITEM_DLFUNC,
137 EITEM_EXTRACT,
138 EITEM_FILTER,
139 EITEM_HASH,
140 EITEM_HMAC,
141 EITEM_IF,
142 #ifdef EXPERIMENTAL_INTERNATIONAL
143 EITEM_IMAPFOLDER,
144 #endif
145 EITEM_LENGTH,
146 EITEM_LISTEXTRACT,
147 EITEM_LOOKUP,
148 EITEM_MAP,
149 EITEM_NHASH,
150 EITEM_PERL,
151 EITEM_PRVS,
152 EITEM_PRVSCHECK,
153 EITEM_READFILE,
154 EITEM_READSOCK,
155 EITEM_REDUCE,
156 EITEM_RUN,
157 EITEM_SG,
158 EITEM_SORT,
159 EITEM_SUBSTR,
160 EITEM_TR };
161
162 /* Tables of operator names, and corresponding switch numbers. The names must be
163 in alphabetical order. There are two tables, because underscore is used in some
164 cases to introduce arguments, whereas for other it is part of the name. This is
165 an historical mis-design. */
166
167 static uschar *op_table_underscore[] = {
168 US"from_utf8",
169 US"local_part",
170 US"quote_local_part",
171 US"reverse_ip",
172 US"time_eval",
173 US"time_interval"
174 #ifdef EXPERIMENTAL_INTERNATIONAL
175 ,US"utf8_domain_from_alabel",
176 US"utf8_domain_to_alabel",
177 US"utf8_localpart_from_alabel",
178 US"utf8_localpart_to_alabel"
179 #endif
180 };
181
182 enum {
183 EOP_FROM_UTF8,
184 EOP_LOCAL_PART,
185 EOP_QUOTE_LOCAL_PART,
186 EOP_REVERSE_IP,
187 EOP_TIME_EVAL,
188 EOP_TIME_INTERVAL
189 #ifdef EXPERIMENTAL_INTERNATIONAL
190 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
191 EOP_UTF8_DOMAIN_TO_ALABEL,
192 EOP_UTF8_LOCALPART_FROM_ALABEL,
193 EOP_UTF8_LOCALPART_TO_ALABEL
194 #endif
195 };
196
197 static uschar *op_table_main[] = {
198 US"address",
199 US"addresses",
200 US"base62",
201 US"base62d",
202 US"domain",
203 US"escape",
204 US"eval",
205 US"eval10",
206 US"expand",
207 US"h",
208 US"hash",
209 US"hex2b64",
210 US"hexquote",
211 US"l",
212 US"lc",
213 US"length",
214 US"listcount",
215 US"listnamed",
216 US"mask",
217 US"md5",
218 US"nh",
219 US"nhash",
220 US"quote",
221 US"randint",
222 US"rfc2047",
223 US"rfc2047d",
224 US"rxquote",
225 US"s",
226 US"sha1",
227 US"sha256",
228 US"stat",
229 US"str2b64",
230 US"strlen",
231 US"substr",
232 US"uc",
233 US"utf8clean" };
234
235 enum {
236 EOP_ADDRESS = nelem(op_table_underscore),
237 EOP_ADDRESSES,
238 EOP_BASE62,
239 EOP_BASE62D,
240 EOP_DOMAIN,
241 EOP_ESCAPE,
242 EOP_EVAL,
243 EOP_EVAL10,
244 EOP_EXPAND,
245 EOP_H,
246 EOP_HASH,
247 EOP_HEX2B64,
248 EOP_HEXQUOTE,
249 EOP_L,
250 EOP_LC,
251 EOP_LENGTH,
252 EOP_LISTCOUNT,
253 EOP_LISTNAMED,
254 EOP_MASK,
255 EOP_MD5,
256 EOP_NH,
257 EOP_NHASH,
258 EOP_QUOTE,
259 EOP_RANDINT,
260 EOP_RFC2047,
261 EOP_RFC2047D,
262 EOP_RXQUOTE,
263 EOP_S,
264 EOP_SHA1,
265 EOP_SHA256,
266 EOP_STAT,
267 EOP_STR2B64,
268 EOP_STRLEN,
269 EOP_SUBSTR,
270 EOP_UC,
271 EOP_UTF8CLEAN };
272
273
274 /* Table of condition names, and corresponding switch numbers. The names must
275 be in alphabetical order. */
276
277 static uschar *cond_table[] = {
278 US"<",
279 US"<=",
280 US"=",
281 US"==", /* Backward compatibility */
282 US">",
283 US">=",
284 US"acl",
285 US"and",
286 US"bool",
287 US"bool_lax",
288 US"crypteq",
289 US"def",
290 US"eq",
291 US"eqi",
292 US"exists",
293 US"first_delivery",
294 US"forall",
295 US"forany",
296 US"ge",
297 US"gei",
298 US"gt",
299 US"gti",
300 US"inlist",
301 US"inlisti",
302 US"isip",
303 US"isip4",
304 US"isip6",
305 US"ldapauth",
306 US"le",
307 US"lei",
308 US"lt",
309 US"lti",
310 US"match",
311 US"match_address",
312 US"match_domain",
313 US"match_ip",
314 US"match_local_part",
315 US"or",
316 US"pam",
317 US"pwcheck",
318 US"queue_running",
319 US"radius",
320 US"saslauthd"
321 };
322
323 enum {
324 ECOND_NUM_L,
325 ECOND_NUM_LE,
326 ECOND_NUM_E,
327 ECOND_NUM_EE,
328 ECOND_NUM_G,
329 ECOND_NUM_GE,
330 ECOND_ACL,
331 ECOND_AND,
332 ECOND_BOOL,
333 ECOND_BOOL_LAX,
334 ECOND_CRYPTEQ,
335 ECOND_DEF,
336 ECOND_STR_EQ,
337 ECOND_STR_EQI,
338 ECOND_EXISTS,
339 ECOND_FIRST_DELIVERY,
340 ECOND_FORALL,
341 ECOND_FORANY,
342 ECOND_STR_GE,
343 ECOND_STR_GEI,
344 ECOND_STR_GT,
345 ECOND_STR_GTI,
346 ECOND_INLIST,
347 ECOND_INLISTI,
348 ECOND_ISIP,
349 ECOND_ISIP4,
350 ECOND_ISIP6,
351 ECOND_LDAPAUTH,
352 ECOND_STR_LE,
353 ECOND_STR_LEI,
354 ECOND_STR_LT,
355 ECOND_STR_LTI,
356 ECOND_MATCH,
357 ECOND_MATCH_ADDRESS,
358 ECOND_MATCH_DOMAIN,
359 ECOND_MATCH_IP,
360 ECOND_MATCH_LOCAL_PART,
361 ECOND_OR,
362 ECOND_PAM,
363 ECOND_PWCHECK,
364 ECOND_QUEUE_RUNNING,
365 ECOND_RADIUS,
366 ECOND_SASLAUTHD
367 };
368
369
370 /* Types of table entry */
371
372 enum vtypes {
373 vtype_int, /* value is address of int */
374 vtype_filter_int, /* ditto, but recognized only when filtering */
375 vtype_ino, /* value is address of ino_t (not always an int) */
376 vtype_uid, /* value is address of uid_t (not always an int) */
377 vtype_gid, /* value is address of gid_t (not always an int) */
378 vtype_bool, /* value is address of bool */
379 vtype_stringptr, /* value is address of pointer to string */
380 vtype_msgbody, /* as stringptr, but read when first required */
381 vtype_msgbody_end, /* ditto, the end of the message */
382 vtype_msgheaders, /* the message's headers, processed */
383 vtype_msgheaders_raw, /* the message's headers, unprocessed */
384 vtype_localpart, /* extract local part from string */
385 vtype_domain, /* extract domain from string */
386 vtype_string_func, /* value is string returned by given function */
387 vtype_todbsdin, /* value not used; generate BSD inbox tod */
388 vtype_tode, /* value not used; generate tod in epoch format */
389 vtype_todel, /* value not used; generate tod in epoch/usec format */
390 vtype_todf, /* value not used; generate full tod */
391 vtype_todl, /* value not used; generate log tod */
392 vtype_todlf, /* value not used; generate log file datestamp tod */
393 vtype_todzone, /* value not used; generate time zone only */
394 vtype_todzulu, /* value not used; generate zulu tod */
395 vtype_reply, /* value not used; get reply from headers */
396 vtype_pid, /* value not used; result is pid */
397 vtype_host_lookup, /* value not used; get host name */
398 vtype_load_avg, /* value not used; result is int from os_getloadavg */
399 vtype_pspace, /* partition space; value is T/F for spool/log */
400 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
401 vtype_cert /* SSL certificate */
402 #ifndef DISABLE_DKIM
403 ,vtype_dkim /* Lookup of value in DKIM signature */
404 #endif
405 };
406
407 /* Type for main variable table */
408
409 typedef struct {
410 const char *name;
411 enum vtypes type;
412 void *value;
413 } var_entry;
414
415 /* Type for entries pointing to address/length pairs. Not currently
416 in use. */
417
418 typedef struct {
419 uschar **address;
420 int *length;
421 } alblock;
422
423 static uschar * fn_recipients(void);
424
425 /* This table must be kept in alphabetical order. */
426
427 static var_entry var_table[] = {
428 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
429 they will be confused with user-creatable ACL variables. */
430 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
431 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
432 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
433 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
434 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
435 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
436 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
437 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
438 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
439 { "acl_narg", vtype_int, &acl_narg },
440 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
441 { "address_data", vtype_stringptr, &deliver_address_data },
442 { "address_file", vtype_stringptr, &address_file },
443 { "address_pipe", vtype_stringptr, &address_pipe },
444 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
445 { "authenticated_id", vtype_stringptr, &authenticated_id },
446 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
447 { "authentication_failed",vtype_int, &authentication_failed },
448 #ifdef WITH_CONTENT_SCAN
449 { "av_failed", vtype_int, &av_failed },
450 #endif
451 #ifdef EXPERIMENTAL_BRIGHTMAIL
452 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
453 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
454 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
455 { "bmi_deliver", vtype_int, &bmi_deliver },
456 #endif
457 { "body_linecount", vtype_int, &body_linecount },
458 { "body_zerocount", vtype_int, &body_zerocount },
459 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
460 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
461 { "caller_gid", vtype_gid, &real_gid },
462 { "caller_uid", vtype_uid, &real_uid },
463 { "compile_date", vtype_stringptr, &version_date },
464 { "compile_number", vtype_stringptr, &version_cnumber },
465 { "config_dir", vtype_stringptr, &config_main_directory },
466 { "config_file", vtype_stringptr, &config_main_filename },
467 { "csa_status", vtype_stringptr, &csa_status },
468 #ifdef EXPERIMENTAL_DCC
469 { "dcc_header", vtype_stringptr, &dcc_header },
470 { "dcc_result", vtype_stringptr, &dcc_result },
471 #endif
472 #ifdef WITH_OLD_DEMIME
473 { "demime_errorlevel", vtype_int, &demime_errorlevel },
474 { "demime_reason", vtype_stringptr, &demime_reason },
475 #endif
476 #ifndef DISABLE_DKIM
477 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
478 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
479 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
480 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
481 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
482 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
483 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
484 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
485 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
486 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
487 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
488 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
489 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
490 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
491 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
492 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
493 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
494 { "dkim_signers", vtype_stringptr, &dkim_signers },
495 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
496 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
497 #endif
498 #ifdef EXPERIMENTAL_DMARC
499 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
500 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
501 { "dmarc_status", vtype_stringptr, &dmarc_status },
502 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
503 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
504 #endif
505 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
506 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
507 { "dnslist_text", vtype_stringptr, &dnslist_text },
508 { "dnslist_value", vtype_stringptr, &dnslist_value },
509 { "domain", vtype_stringptr, &deliver_domain },
510 { "domain_data", vtype_stringptr, &deliver_domain_data },
511 #ifdef EXPERIMENTAL_EVENT
512 { "event_data", vtype_stringptr, &event_data },
513
514 /*XXX want to use generic vars for as many of these as possible*/
515 { "event_defer_errno", vtype_int, &event_defer_errno },
516
517 { "event_name", vtype_stringptr, &event_name },
518 #endif
519 { "exim_gid", vtype_gid, &exim_gid },
520 { "exim_path", vtype_stringptr, &exim_path },
521 { "exim_uid", vtype_uid, &exim_uid },
522 { "exim_version", vtype_stringptr, &version_string },
523 #ifdef WITH_OLD_DEMIME
524 { "found_extension", vtype_stringptr, &found_extension },
525 #endif
526 { "headers_added", vtype_string_func, &fn_hdrs_added },
527 { "home", vtype_stringptr, &deliver_home },
528 { "host", vtype_stringptr, &deliver_host },
529 { "host_address", vtype_stringptr, &deliver_host_address },
530 { "host_data", vtype_stringptr, &host_data },
531 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
532 { "host_lookup_failed", vtype_int, &host_lookup_failed },
533 { "host_port", vtype_int, &deliver_host_port },
534 { "inode", vtype_ino, &deliver_inode },
535 { "interface_address", vtype_stringptr, &interface_address },
536 { "interface_port", vtype_int, &interface_port },
537 { "item", vtype_stringptr, &iterate_item },
538 #ifdef LOOKUP_LDAP
539 { "ldap_dn", vtype_stringptr, &eldap_dn },
540 #endif
541 { "load_average", vtype_load_avg, NULL },
542 { "local_part", vtype_stringptr, &deliver_localpart },
543 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
544 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
545 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
546 { "local_scan_data", vtype_stringptr, &local_scan_data },
547 { "local_user_gid", vtype_gid, &local_user_gid },
548 { "local_user_uid", vtype_uid, &local_user_uid },
549 { "localhost_number", vtype_int, &host_number },
550 { "log_inodes", vtype_pinodes, (void *)FALSE },
551 { "log_space", vtype_pspace, (void *)FALSE },
552 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
553 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
554 #ifdef WITH_CONTENT_SCAN
555 { "malware_name", vtype_stringptr, &malware_name },
556 #endif
557 { "max_received_linelength", vtype_int, &max_received_linelength },
558 { "message_age", vtype_int, &message_age },
559 { "message_body", vtype_msgbody, &message_body },
560 { "message_body_end", vtype_msgbody_end, &message_body_end },
561 { "message_body_size", vtype_int, &message_body_size },
562 { "message_exim_id", vtype_stringptr, &message_id },
563 { "message_headers", vtype_msgheaders, NULL },
564 { "message_headers_raw", vtype_msgheaders_raw, NULL },
565 { "message_id", vtype_stringptr, &message_id },
566 { "message_linecount", vtype_int, &message_linecount },
567 { "message_size", vtype_int, &message_size },
568 #ifdef EXPERIMENTAL_INTERNATIONAL
569 { "message_smtputf8", vtype_bool, &message_smtputf8 },
570 #endif
571 #ifdef WITH_CONTENT_SCAN
572 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
573 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
574 { "mime_boundary", vtype_stringptr, &mime_boundary },
575 { "mime_charset", vtype_stringptr, &mime_charset },
576 { "mime_content_description", vtype_stringptr, &mime_content_description },
577 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
578 { "mime_content_id", vtype_stringptr, &mime_content_id },
579 { "mime_content_size", vtype_int, &mime_content_size },
580 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
581 { "mime_content_type", vtype_stringptr, &mime_content_type },
582 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
583 { "mime_filename", vtype_stringptr, &mime_filename },
584 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
585 { "mime_is_multipart", vtype_int, &mime_is_multipart },
586 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
587 { "mime_part_count", vtype_int, &mime_part_count },
588 #endif
589 { "n0", vtype_filter_int, &filter_n[0] },
590 { "n1", vtype_filter_int, &filter_n[1] },
591 { "n2", vtype_filter_int, &filter_n[2] },
592 { "n3", vtype_filter_int, &filter_n[3] },
593 { "n4", vtype_filter_int, &filter_n[4] },
594 { "n5", vtype_filter_int, &filter_n[5] },
595 { "n6", vtype_filter_int, &filter_n[6] },
596 { "n7", vtype_filter_int, &filter_n[7] },
597 { "n8", vtype_filter_int, &filter_n[8] },
598 { "n9", vtype_filter_int, &filter_n[9] },
599 { "original_domain", vtype_stringptr, &deliver_domain_orig },
600 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
601 { "originator_gid", vtype_gid, &originator_gid },
602 { "originator_uid", vtype_uid, &originator_uid },
603 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
604 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
605 { "pid", vtype_pid, NULL },
606 { "primary_hostname", vtype_stringptr, &primary_hostname },
607 #ifdef EXPERIMENTAL_PROXY
608 { "proxy_host_address", vtype_stringptr, &proxy_host_address },
609 { "proxy_host_port", vtype_int, &proxy_host_port },
610 { "proxy_session", vtype_bool, &proxy_session },
611 { "proxy_target_address",vtype_stringptr, &proxy_target_address },
612 { "proxy_target_port", vtype_int, &proxy_target_port },
613 #endif
614 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
615 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
616 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
617 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
618 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
619 { "rcpt_count", vtype_int, &rcpt_count },
620 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
621 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
622 { "received_count", vtype_int, &received_count },
623 { "received_for", vtype_stringptr, &received_for },
624 { "received_ip_address", vtype_stringptr, &interface_address },
625 { "received_port", vtype_int, &interface_port },
626 { "received_protocol", vtype_stringptr, &received_protocol },
627 { "received_time", vtype_int, &received_time },
628 { "recipient_data", vtype_stringptr, &recipient_data },
629 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
630 { "recipients", vtype_string_func, &fn_recipients },
631 { "recipients_count", vtype_int, &recipients_count },
632 #ifdef WITH_CONTENT_SCAN
633 { "regex_match_string", vtype_stringptr, &regex_match_string },
634 #endif
635 { "reply_address", vtype_reply, NULL },
636 { "return_path", vtype_stringptr, &return_path },
637 { "return_size_limit", vtype_int, &bounce_return_size_limit },
638 { "router_name", vtype_stringptr, &router_name },
639 { "runrc", vtype_int, &runrc },
640 { "self_hostname", vtype_stringptr, &self_hostname },
641 { "sender_address", vtype_stringptr, &sender_address },
642 { "sender_address_data", vtype_stringptr, &sender_address_data },
643 { "sender_address_domain", vtype_domain, &sender_address },
644 { "sender_address_local_part", vtype_localpart, &sender_address },
645 { "sender_data", vtype_stringptr, &sender_data },
646 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
647 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
648 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
649 { "sender_host_address", vtype_stringptr, &sender_host_address },
650 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
651 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
652 { "sender_host_name", vtype_host_lookup, NULL },
653 { "sender_host_port", vtype_int, &sender_host_port },
654 { "sender_ident", vtype_stringptr, &sender_ident },
655 { "sender_rate", vtype_stringptr, &sender_rate },
656 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
657 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
658 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
659 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
660 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
661 { "sending_port", vtype_int, &sending_port },
662 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
663 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
664 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
665 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
666 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
667 { "sn0", vtype_filter_int, &filter_sn[0] },
668 { "sn1", vtype_filter_int, &filter_sn[1] },
669 { "sn2", vtype_filter_int, &filter_sn[2] },
670 { "sn3", vtype_filter_int, &filter_sn[3] },
671 { "sn4", vtype_filter_int, &filter_sn[4] },
672 { "sn5", vtype_filter_int, &filter_sn[5] },
673 { "sn6", vtype_filter_int, &filter_sn[6] },
674 { "sn7", vtype_filter_int, &filter_sn[7] },
675 { "sn8", vtype_filter_int, &filter_sn[8] },
676 { "sn9", vtype_filter_int, &filter_sn[9] },
677 #ifdef WITH_CONTENT_SCAN
678 { "spam_action", vtype_stringptr, &spam_action },
679 { "spam_bar", vtype_stringptr, &spam_bar },
680 { "spam_report", vtype_stringptr, &spam_report },
681 { "spam_score", vtype_stringptr, &spam_score },
682 { "spam_score_int", vtype_stringptr, &spam_score_int },
683 #endif
684 #ifdef EXPERIMENTAL_SPF
685 { "spf_guess", vtype_stringptr, &spf_guess },
686 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
687 { "spf_received", vtype_stringptr, &spf_received },
688 { "spf_result", vtype_stringptr, &spf_result },
689 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
690 #endif
691 { "spool_directory", vtype_stringptr, &spool_directory },
692 { "spool_inodes", vtype_pinodes, (void *)TRUE },
693 { "spool_space", vtype_pspace, (void *)TRUE },
694 #ifdef EXPERIMENTAL_SRS
695 { "srs_db_address", vtype_stringptr, &srs_db_address },
696 { "srs_db_key", vtype_stringptr, &srs_db_key },
697 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
698 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
699 { "srs_recipient", vtype_stringptr, &srs_recipient },
700 { "srs_status", vtype_stringptr, &srs_status },
701 #endif
702 { "thisaddress", vtype_stringptr, &filter_thisaddress },
703
704 /* The non-(in,out) variables are now deprecated */
705 { "tls_bits", vtype_int, &tls_in.bits },
706 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
707 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
708
709 { "tls_in_bits", vtype_int, &tls_in.bits },
710 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
711 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
712 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
713 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
714 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
715 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
716 #if defined(SUPPORT_TLS)
717 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
718 #endif
719 { "tls_out_bits", vtype_int, &tls_out.bits },
720 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
721 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
722 #ifdef EXPERIMENTAL_DANE
723 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
724 #endif
725 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
726 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
727 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
728 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
729 #if defined(SUPPORT_TLS)
730 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
731 #endif
732 #ifdef EXPERIMENTAL_DANE
733 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
734 #endif
735
736 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
737 #if defined(SUPPORT_TLS)
738 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
739 #endif
740
741 { "tod_bsdinbox", vtype_todbsdin, NULL },
742 { "tod_epoch", vtype_tode, NULL },
743 { "tod_epoch_l", vtype_todel, NULL },
744 { "tod_full", vtype_todf, NULL },
745 { "tod_log", vtype_todl, NULL },
746 { "tod_logfile", vtype_todlf, NULL },
747 { "tod_zone", vtype_todzone, NULL },
748 { "tod_zulu", vtype_todzulu, NULL },
749 { "transport_name", vtype_stringptr, &transport_name },
750 { "value", vtype_stringptr, &lookup_value },
751 { "verify_mode", vtype_stringptr, &verify_mode },
752 { "version_number", vtype_stringptr, &version_string },
753 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
754 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
755 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
756 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
757 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
758 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
759 };
760
761 static int var_table_size = nelem(var_table);
762 static uschar var_buffer[256];
763 static BOOL malformed_header;
764
765 /* For textual hashes */
766
767 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
768 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
769 "0123456789";
770
771 enum { HMAC_MD5, HMAC_SHA1 };
772
773 /* For numeric hashes */
774
775 static unsigned int prime[] = {
776 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
777 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
778 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
779
780 /* For printing modes in symbolic form */
781
782 static uschar *mtable_normal[] =
783 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
784
785 static uschar *mtable_setid[] =
786 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
787
788 static uschar *mtable_sticky[] =
789 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
790
791
792
793 /*************************************************
794 * Tables for UTF-8 support *
795 *************************************************/
796
797 /* Table of the number of extra characters, indexed by the first character
798 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
799 0x3d. */
800
801 static uschar utf8_table1[] = {
802 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
803 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
804 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
805 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
806
807 /* These are the masks for the data bits in the first byte of a character,
808 indexed by the number of additional bytes. */
809
810 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
811
812 /* Get the next UTF-8 character, advancing the pointer. */
813
814 #define GETUTF8INC(c, ptr) \
815 c = *ptr++; \
816 if ((c & 0xc0) == 0xc0) \
817 { \
818 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
819 int s = 6*a; \
820 c = (c & utf8_table2[a]) << s; \
821 while (a-- > 0) \
822 { \
823 s -= 6; \
824 c |= (*ptr++ & 0x3f) << s; \
825 } \
826 }
827
828
829 /*************************************************
830 * Binary chop search on a table *
831 *************************************************/
832
833 /* This is used for matching expansion items and operators.
834
835 Arguments:
836 name the name that is being sought
837 table the table to search
838 table_size the number of items in the table
839
840 Returns: the offset in the table, or -1
841 */
842
843 static int
844 chop_match(uschar *name, uschar **table, int table_size)
845 {
846 uschar **bot = table;
847 uschar **top = table + table_size;
848
849 while (top > bot)
850 {
851 uschar **mid = bot + (top - bot)/2;
852 int c = Ustrcmp(name, *mid);
853 if (c == 0) return mid - table;
854 if (c > 0) bot = mid + 1; else top = mid;
855 }
856
857 return -1;
858 }
859
860
861
862 /*************************************************
863 * Check a condition string *
864 *************************************************/
865
866 /* This function is called to expand a string, and test the result for a "true"
867 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
868 forced fail or lookup defer.
869
870 We used to release all store used, but this is not not safe due
871 to ${dlfunc } and ${acl }. In any case expand_string_internal()
872 is reasonably careful to release what it can.
873
874 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
875
876 Arguments:
877 condition the condition string
878 m1 text to be incorporated in panic error
879 m2 ditto
880
881 Returns: TRUE if condition is met, FALSE if not
882 */
883
884 BOOL
885 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
886 {
887 int rc;
888 uschar *ss = expand_string(condition);
889 if (ss == NULL)
890 {
891 if (!expand_string_forcedfail && !search_find_defer)
892 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
893 "for %s %s: %s", condition, m1, m2, expand_string_message);
894 return FALSE;
895 }
896 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
897 strcmpic(ss, US"false") != 0;
898 return rc;
899 }
900
901
902
903
904 /*************************************************
905 * Pseudo-random number generation *
906 *************************************************/
907
908 /* Pseudo-random number generation. The result is not "expected" to be
909 cryptographically strong but not so weak that someone will shoot themselves
910 in the foot using it as a nonce in some email header scheme or whatever
911 weirdness they'll twist this into. The result should ideally handle fork().
912
913 However, if we're stuck unable to provide this, then we'll fall back to
914 appallingly bad randomness.
915
916 If SUPPORT_TLS is defined then this will not be used except as an emergency
917 fallback.
918
919 Arguments:
920 max range maximum
921 Returns a random number in range [0, max-1]
922 */
923
924 #ifdef SUPPORT_TLS
925 # define vaguely_random_number vaguely_random_number_fallback
926 #endif
927 int
928 vaguely_random_number(int max)
929 {
930 #ifdef SUPPORT_TLS
931 # undef vaguely_random_number
932 #endif
933 static pid_t pid = 0;
934 pid_t p2;
935 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
936 struct timeval tv;
937 #endif
938
939 p2 = getpid();
940 if (p2 != pid)
941 {
942 if (pid != 0)
943 {
944
945 #ifdef HAVE_ARC4RANDOM
946 /* cryptographically strong randomness, common on *BSD platforms, not
947 so much elsewhere. Alas. */
948 #ifndef NOT_HAVE_ARC4RANDOM_STIR
949 arc4random_stir();
950 #endif
951 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
952 #ifdef HAVE_SRANDOMDEV
953 /* uses random(4) for seeding */
954 srandomdev();
955 #else
956 gettimeofday(&tv, NULL);
957 srandom(tv.tv_sec | tv.tv_usec | getpid());
958 #endif
959 #else
960 /* Poor randomness and no seeding here */
961 #endif
962
963 }
964 pid = p2;
965 }
966
967 #ifdef HAVE_ARC4RANDOM
968 return arc4random() % max;
969 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
970 return random() % max;
971 #else
972 /* This one returns a 16-bit number, definitely not crypto-strong */
973 return random_number(max);
974 #endif
975 }
976
977
978
979
980 /*************************************************
981 * Pick out a name from a string *
982 *************************************************/
983
984 /* If the name is too long, it is silently truncated.
985
986 Arguments:
987 name points to a buffer into which to put the name
988 max is the length of the buffer
989 s points to the first alphabetic character of the name
990 extras chars other than alphanumerics to permit
991
992 Returns: pointer to the first character after the name
993
994 Note: The test for *s != 0 in the while loop is necessary because
995 Ustrchr() yields non-NULL if the character is zero (which is not something
996 I expected). */
997
998 static const uschar *
999 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1000 {
1001 int ptr = 0;
1002 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1003 {
1004 if (ptr < max-1) name[ptr++] = *s;
1005 s++;
1006 }
1007 name[ptr] = 0;
1008 return s;
1009 }
1010
1011
1012
1013 /*************************************************
1014 * Pick out the rest of a header name *
1015 *************************************************/
1016
1017 /* A variable name starting $header_ (or just $h_ for those who like
1018 abbreviations) might not be the complete header name because headers can
1019 contain any printing characters in their names, except ':'. This function is
1020 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1021 on the end, if the name was terminated by white space.
1022
1023 Arguments:
1024 name points to a buffer in which the name read so far exists
1025 max is the length of the buffer
1026 s points to the first character after the name so far, i.e. the
1027 first non-alphameric character after $header_xxxxx
1028
1029 Returns: a pointer to the first character after the header name
1030 */
1031
1032 static const uschar *
1033 read_header_name(uschar *name, int max, const uschar *s)
1034 {
1035 int prelen = Ustrchr(name, '_') - name + 1;
1036 int ptr = Ustrlen(name) - prelen;
1037 if (ptr > 0) memmove(name, name+prelen, ptr);
1038 while (mac_isgraph(*s) && *s != ':')
1039 {
1040 if (ptr < max-1) name[ptr++] = *s;
1041 s++;
1042 }
1043 if (*s == ':') s++;
1044 name[ptr++] = ':';
1045 name[ptr] = 0;
1046 return s;
1047 }
1048
1049
1050
1051 /*************************************************
1052 * Pick out a number from a string *
1053 *************************************************/
1054
1055 /* Arguments:
1056 n points to an integer into which to put the number
1057 s points to the first digit of the number
1058
1059 Returns: a pointer to the character after the last digit
1060 */
1061
1062 static uschar *
1063 read_number(int *n, uschar *s)
1064 {
1065 *n = 0;
1066 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1067 return s;
1068 }
1069
1070 static const uschar *
1071 read_cnumber(int *n, const uschar *s)
1072 {
1073 *n = 0;
1074 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1075 return s;
1076 }
1077
1078
1079
1080 /*************************************************
1081 * Extract keyed subfield from a string *
1082 *************************************************/
1083
1084 /* The yield is in dynamic store; NULL means that the key was not found.
1085
1086 Arguments:
1087 key points to the name of the key
1088 s points to the string from which to extract the subfield
1089
1090 Returns: NULL if the subfield was not found, or
1091 a pointer to the subfield's data
1092 */
1093
1094 static uschar *
1095 expand_getkeyed(uschar *key, const uschar *s)
1096 {
1097 int length = Ustrlen(key);
1098 while (isspace(*s)) s++;
1099
1100 /* Loop to search for the key */
1101
1102 while (*s != 0)
1103 {
1104 int dkeylength;
1105 uschar *data;
1106 const uschar *dkey = s;
1107
1108 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1109 dkeylength = s - dkey;
1110 while (isspace(*s)) s++;
1111 if (*s == '=') while (isspace((*(++s))));
1112
1113 data = string_dequote(&s);
1114 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1115 return data;
1116
1117 while (isspace(*s)) s++;
1118 }
1119
1120 return NULL;
1121 }
1122
1123
1124
1125 static var_entry *
1126 find_var_ent(uschar * name)
1127 {
1128 int first = 0;
1129 int last = var_table_size;
1130
1131 while (last > first)
1132 {
1133 int middle = (first + last)/2;
1134 int c = Ustrcmp(name, var_table[middle].name);
1135
1136 if (c > 0) { first = middle + 1; continue; }
1137 if (c < 0) { last = middle; continue; }
1138 return &var_table[middle];
1139 }
1140 return NULL;
1141 }
1142
1143 /*************************************************
1144 * Extract numbered subfield from string *
1145 *************************************************/
1146
1147 /* Extracts a numbered field from a string that is divided by tokens - for
1148 example a line from /etc/passwd is divided by colon characters. First field is
1149 numbered one. Negative arguments count from the right. Zero returns the whole
1150 string. Returns NULL if there are insufficient tokens in the string
1151
1152 ***WARNING***
1153 Modifies final argument - this is a dynamically generated string, so that's OK.
1154
1155 Arguments:
1156 field number of field to be extracted,
1157 first field = 1, whole string = 0, last field = -1
1158 separators characters that are used to break string into tokens
1159 s points to the string from which to extract the subfield
1160
1161 Returns: NULL if the field was not found,
1162 a pointer to the field's data inside s (modified to add 0)
1163 */
1164
1165 static uschar *
1166 expand_gettokened (int field, uschar *separators, uschar *s)
1167 {
1168 int sep = 1;
1169 int count;
1170 uschar *ss = s;
1171 uschar *fieldtext = NULL;
1172
1173 if (field == 0) return s;
1174
1175 /* Break the line up into fields in place; for field > 0 we stop when we have
1176 done the number of fields we want. For field < 0 we continue till the end of
1177 the string, counting the number of fields. */
1178
1179 count = (field > 0)? field : INT_MAX;
1180
1181 while (count-- > 0)
1182 {
1183 size_t len;
1184
1185 /* Previous field was the last one in the string. For a positive field
1186 number, this means there are not enough fields. For a negative field number,
1187 check that there are enough, and scan back to find the one that is wanted. */
1188
1189 if (sep == 0)
1190 {
1191 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1192 if ((-field) == (INT_MAX - count - 1)) return s;
1193 while (field++ < 0)
1194 {
1195 ss--;
1196 while (ss[-1] != 0) ss--;
1197 }
1198 fieldtext = ss;
1199 break;
1200 }
1201
1202 /* Previous field was not last in the string; save its start and put a
1203 zero at its end. */
1204
1205 fieldtext = ss;
1206 len = Ustrcspn(ss, separators);
1207 sep = ss[len];
1208 ss[len] = 0;
1209 ss += len + 1;
1210 }
1211
1212 return fieldtext;
1213 }
1214
1215
1216 static uschar *
1217 expand_getlistele(int field, const uschar * list)
1218 {
1219 const uschar * tlist= list;
1220 int sep= 0;
1221 uschar dummy;
1222
1223 if(field<0)
1224 {
1225 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1226 sep= 0;
1227 }
1228 if(field==0) return NULL;
1229 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1230 return string_nextinlist(&list, &sep, NULL, 0);
1231 }
1232
1233
1234 /* Certificate fields, by name. Worry about by-OID later */
1235 /* Names are chosen to not have common prefixes */
1236
1237 #ifdef SUPPORT_TLS
1238 typedef struct
1239 {
1240 uschar * name;
1241 int namelen;
1242 uschar * (*getfn)(void * cert, uschar * mod);
1243 } certfield;
1244 static certfield certfields[] =
1245 { /* linear search; no special order */
1246 { US"version", 7, &tls_cert_version },
1247 { US"serial_number", 13, &tls_cert_serial_number },
1248 { US"subject", 7, &tls_cert_subject },
1249 { US"notbefore", 9, &tls_cert_not_before },
1250 { US"notafter", 8, &tls_cert_not_after },
1251 { US"issuer", 6, &tls_cert_issuer },
1252 { US"signature", 9, &tls_cert_signature },
1253 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1254 { US"subj_altname", 12, &tls_cert_subject_altname },
1255 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1256 { US"crl_uri", 7, &tls_cert_crl_uri },
1257 };
1258
1259 static uschar *
1260 expand_getcertele(uschar * field, uschar * certvar)
1261 {
1262 var_entry * vp;
1263 certfield * cp;
1264
1265 if (!(vp = find_var_ent(certvar)))
1266 {
1267 expand_string_message =
1268 string_sprintf("no variable named \"%s\"", certvar);
1269 return NULL; /* Unknown variable name */
1270 }
1271 /* NB this stops us passing certs around in variable. Might
1272 want to do that in future */
1273 if (vp->type != vtype_cert)
1274 {
1275 expand_string_message =
1276 string_sprintf("\"%s\" is not a certificate", certvar);
1277 return NULL; /* Unknown variable name */
1278 }
1279 if (!*(void **)vp->value)
1280 return NULL;
1281
1282 if (*field >= '0' && *field <= '9')
1283 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1284
1285 for(cp = certfields;
1286 cp < certfields + nelem(certfields);
1287 cp++)
1288 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1289 {
1290 uschar * modifier = *(field += cp->namelen) == ','
1291 ? ++field : NULL;
1292 return (*cp->getfn)( *(void **)vp->value, modifier );
1293 }
1294
1295 expand_string_message =
1296 string_sprintf("bad field selector \"%s\" for certextract", field);
1297 return NULL;
1298 }
1299 #endif /*SUPPORT_TLS*/
1300
1301 /*************************************************
1302 * Extract a substring from a string *
1303 *************************************************/
1304
1305 /* Perform the ${substr or ${length expansion operations.
1306
1307 Arguments:
1308 subject the input string
1309 value1 the offset from the start of the input string to the start of
1310 the output string; if negative, count from the right.
1311 value2 the length of the output string, or negative (-1) for unset
1312 if value1 is positive, unset means "all after"
1313 if value1 is negative, unset means "all before"
1314 len set to the length of the returned string
1315
1316 Returns: pointer to the output string, or NULL if there is an error
1317 */
1318
1319 static uschar *
1320 extract_substr(uschar *subject, int value1, int value2, int *len)
1321 {
1322 int sublen = Ustrlen(subject);
1323
1324 if (value1 < 0) /* count from right */
1325 {
1326 value1 += sublen;
1327
1328 /* If the position is before the start, skip to the start, and adjust the
1329 length. If the length ends up negative, the substring is null because nothing
1330 can precede. This falls out naturally when the length is unset, meaning "all
1331 to the left". */
1332
1333 if (value1 < 0)
1334 {
1335 value2 += value1;
1336 if (value2 < 0) value2 = 0;
1337 value1 = 0;
1338 }
1339
1340 /* Otherwise an unset length => characters before value1 */
1341
1342 else if (value2 < 0)
1343 {
1344 value2 = value1;
1345 value1 = 0;
1346 }
1347 }
1348
1349 /* For a non-negative offset, if the starting position is past the end of the
1350 string, the result will be the null string. Otherwise, an unset length means
1351 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1352
1353 else
1354 {
1355 if (value1 > sublen)
1356 {
1357 value1 = sublen;
1358 value2 = 0;
1359 }
1360 else if (value2 < 0) value2 = sublen;
1361 }
1362
1363 /* Cut the length down to the maximum possible for the offset value, and get
1364 the required characters. */
1365
1366 if (value1 + value2 > sublen) value2 = sublen - value1;
1367 *len = value2;
1368 return subject + value1;
1369 }
1370
1371
1372
1373
1374 /*************************************************
1375 * Old-style hash of a string *
1376 *************************************************/
1377
1378 /* Perform the ${hash expansion operation.
1379
1380 Arguments:
1381 subject the input string (an expanded substring)
1382 value1 the length of the output string; if greater or equal to the
1383 length of the input string, the input string is returned
1384 value2 the number of hash characters to use, or 26 if negative
1385 len set to the length of the returned string
1386
1387 Returns: pointer to the output string, or NULL if there is an error
1388 */
1389
1390 static uschar *
1391 compute_hash(uschar *subject, int value1, int value2, int *len)
1392 {
1393 int sublen = Ustrlen(subject);
1394
1395 if (value2 < 0) value2 = 26;
1396 else if (value2 > Ustrlen(hashcodes))
1397 {
1398 expand_string_message =
1399 string_sprintf("hash count \"%d\" too big", value2);
1400 return NULL;
1401 }
1402
1403 /* Calculate the hash text. We know it is shorter than the original string, so
1404 can safely place it in subject[] (we know that subject is always itself an
1405 expanded substring). */
1406
1407 if (value1 < sublen)
1408 {
1409 int c;
1410 int i = 0;
1411 int j = value1;
1412 while ((c = (subject[j])) != 0)
1413 {
1414 int shift = (c + j++) & 7;
1415 subject[i] ^= (c << shift) | (c >> (8-shift));
1416 if (++i >= value1) i = 0;
1417 }
1418 for (i = 0; i < value1; i++)
1419 subject[i] = hashcodes[(subject[i]) % value2];
1420 }
1421 else value1 = sublen;
1422
1423 *len = value1;
1424 return subject;
1425 }
1426
1427
1428
1429
1430 /*************************************************
1431 * Numeric hash of a string *
1432 *************************************************/
1433
1434 /* Perform the ${nhash expansion operation. The first characters of the
1435 string are treated as most important, and get the highest prime numbers.
1436
1437 Arguments:
1438 subject the input string
1439 value1 the maximum value of the first part of the result
1440 value2 the maximum value of the second part of the result,
1441 or negative to produce only a one-part result
1442 len set to the length of the returned string
1443
1444 Returns: pointer to the output string, or NULL if there is an error.
1445 */
1446
1447 static uschar *
1448 compute_nhash (uschar *subject, int value1, int value2, int *len)
1449 {
1450 uschar *s = subject;
1451 int i = 0;
1452 unsigned long int total = 0; /* no overflow */
1453
1454 while (*s != 0)
1455 {
1456 if (i == 0) i = nelem(prime) - 1;
1457 total += prime[i--] * (unsigned int)(*s++);
1458 }
1459
1460 /* If value2 is unset, just compute one number */
1461
1462 if (value2 < 0)
1463 {
1464 s = string_sprintf("%d", total % value1);
1465 }
1466
1467 /* Otherwise do a div/mod hash */
1468
1469 else
1470 {
1471 total = total % (value1 * value2);
1472 s = string_sprintf("%d/%d", total/value2, total % value2);
1473 }
1474
1475 *len = Ustrlen(s);
1476 return s;
1477 }
1478
1479
1480
1481
1482
1483 /*************************************************
1484 * Find the value of a header or headers *
1485 *************************************************/
1486
1487 /* Multiple instances of the same header get concatenated, and this function
1488 can also return a concatenation of all the header lines. When concatenating
1489 specific headers that contain lists of addresses, a comma is inserted between
1490 them. Otherwise we use a straight concatenation. Because some messages can have
1491 pathologically large number of lines, there is a limit on the length that is
1492 returned. Also, to avoid massive store use which would result from using
1493 string_cat() as it copies and extends strings, we do a preliminary pass to find
1494 out exactly how much store will be needed. On "normal" messages this will be
1495 pretty trivial.
1496
1497 Arguments:
1498 name the name of the header, without the leading $header_ or $h_,
1499 or NULL if a concatenation of all headers is required
1500 exists_only TRUE if called from a def: test; don't need to build a string;
1501 just return a string that is not "" and not "0" if the header
1502 exists
1503 newsize return the size of memory block that was obtained; may be NULL
1504 if exists_only is TRUE
1505 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1506 other than concatenating, will be done on the header. Also used
1507 for $message_headers_raw.
1508 charset name of charset to translate MIME words to; used only if
1509 want_raw is false; if NULL, no translation is done (this is
1510 used for $bh_ and $bheader_)
1511
1512 Returns: NULL if the header does not exist, else a pointer to a new
1513 store block
1514 */
1515
1516 static uschar *
1517 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1518 uschar *charset)
1519 {
1520 BOOL found = name == NULL;
1521 int comma = 0;
1522 int len = found? 0 : Ustrlen(name);
1523 int i;
1524 uschar *yield = NULL;
1525 uschar *ptr = NULL;
1526
1527 /* Loop for two passes - saves code repetition */
1528
1529 for (i = 0; i < 2; i++)
1530 {
1531 int size = 0;
1532 header_line *h;
1533
1534 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1535 {
1536 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1537 {
1538 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1539 {
1540 int ilen;
1541 uschar *t;
1542
1543 if (exists_only) return US"1"; /* don't need actual string */
1544 found = TRUE;
1545 t = h->text + len; /* text to insert */
1546 if (!want_raw) /* unless wanted raw, */
1547 while (isspace(*t)) t++; /* remove leading white space */
1548 ilen = h->slen - (t - h->text); /* length to insert */
1549
1550 /* Unless wanted raw, remove trailing whitespace, including the
1551 newline. */
1552
1553 if (!want_raw)
1554 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1555
1556 /* Set comma = 1 if handling a single header and it's one of those
1557 that contains an address list, except when asked for raw headers. Only
1558 need to do this once. */
1559
1560 if (!want_raw && name != NULL && comma == 0 &&
1561 Ustrchr("BCFRST", h->type) != NULL)
1562 comma = 1;
1563
1564 /* First pass - compute total store needed; second pass - compute
1565 total store used, including this header. */
1566
1567 size += ilen + comma + 1; /* +1 for the newline */
1568
1569 /* Second pass - concatentate the data, up to a maximum. Note that
1570 the loop stops when size hits the limit. */
1571
1572 if (i != 0)
1573 {
1574 if (size > header_insert_maxlen)
1575 {
1576 ilen -= size - header_insert_maxlen - 1;
1577 comma = 0;
1578 }
1579 Ustrncpy(ptr, t, ilen);
1580 ptr += ilen;
1581
1582 /* For a non-raw header, put in the comma if needed, then add
1583 back the newline we removed above, provided there was some text in
1584 the header. */
1585
1586 if (!want_raw && ilen > 0)
1587 {
1588 if (comma != 0) *ptr++ = ',';
1589 *ptr++ = '\n';
1590 }
1591 }
1592 }
1593 }
1594 }
1595
1596 /* At end of first pass, return NULL if no header found. Then truncate size
1597 if necessary, and get the buffer to hold the data, returning the buffer size.
1598 */
1599
1600 if (i == 0)
1601 {
1602 if (!found) return NULL;
1603 if (size > header_insert_maxlen) size = header_insert_maxlen;
1604 *newsize = size + 1;
1605 ptr = yield = store_get(*newsize);
1606 }
1607 }
1608
1609 /* That's all we do for raw header expansion. */
1610
1611 if (want_raw)
1612 {
1613 *ptr = 0;
1614 }
1615
1616 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1617 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1618 function can return an error with decoded data if the charset translation
1619 fails. If decoding fails, it returns NULL. */
1620
1621 else
1622 {
1623 uschar *decoded, *error;
1624 if (ptr > yield && ptr[-1] == '\n') ptr--;
1625 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1626 *ptr = 0;
1627 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1628 newsize, &error);
1629 if (error != NULL)
1630 {
1631 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1632 " input was: %s\n", error, yield);
1633 }
1634 if (decoded != NULL) yield = decoded;
1635 }
1636
1637 return yield;
1638 }
1639
1640
1641
1642
1643 /*************************************************
1644 * Return list of recipients *
1645 *************************************************/
1646 /* A recipients list is available only during system message filtering,
1647 during ACL processing after DATA, and while expanding pipe commands
1648 generated from a system filter, but not elsewhere. */
1649
1650 static uschar *
1651 fn_recipients(void)
1652 {
1653 if (!enable_dollar_recipients) return NULL; else
1654 {
1655 int size = 128;
1656 int ptr = 0;
1657 int i;
1658 uschar * s = store_get(size);
1659 for (i = 0; i < recipients_count; i++)
1660 {
1661 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1662 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1663 Ustrlen(recipients_list[i].address));
1664 }
1665 s[ptr] = 0; /* string_cat() leaves room */
1666 return s;
1667 }
1668 }
1669
1670
1671 /*************************************************
1672 * Find value of a variable *
1673 *************************************************/
1674
1675 /* The table of variables is kept in alphabetic order, so we can search it
1676 using a binary chop. The "choplen" variable is nothing to do with the binary
1677 chop.
1678
1679 Arguments:
1680 name the name of the variable being sought
1681 exists_only TRUE if this is a def: test; passed on to find_header()
1682 skipping TRUE => skip any processing evaluation; this is not the same as
1683 exists_only because def: may test for values that are first
1684 evaluated here
1685 newsize pointer to an int which is initially zero; if the answer is in
1686 a new memory buffer, *newsize is set to its size
1687
1688 Returns: NULL if the variable does not exist, or
1689 a pointer to the variable's contents, or
1690 something non-NULL if exists_only is TRUE
1691 */
1692
1693 static uschar *
1694 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1695 {
1696 var_entry * vp;
1697 uschar *s, *domain;
1698 uschar **ss;
1699 void * val;
1700
1701 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1702 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1703 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1704 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1705 (this gave backwards compatibility at the changeover). There may be built-in
1706 variables whose names start acl_ but they should never start in this way. This
1707 slightly messy specification is a consequence of the history, needless to say.
1708
1709 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1710 set, in which case give an error. */
1711
1712 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1713 !isalpha(name[5]))
1714 {
1715 tree_node *node =
1716 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1717 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1718 }
1719
1720 /* Handle $auth<n> variables. */
1721
1722 if (Ustrncmp(name, "auth", 4) == 0)
1723 {
1724 uschar *endptr;
1725 int n = Ustrtoul(name + 4, &endptr, 10);
1726 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1727 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1728 }
1729
1730 /* For all other variables, search the table */
1731
1732 if (!(vp = find_var_ent(name)))
1733 return NULL; /* Unknown variable name */
1734
1735 /* Found an existing variable. If in skipping state, the value isn't needed,
1736 and we want to avoid processing (such as looking up the host name). */
1737
1738 if (skipping)
1739 return US"";
1740
1741 val = vp->value;
1742 switch (vp->type)
1743 {
1744 case vtype_filter_int:
1745 if (!filter_running) return NULL;
1746 /* Fall through */
1747 /* VVVVVVVVVVVV */
1748 case vtype_int:
1749 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1750 return var_buffer;
1751
1752 case vtype_ino:
1753 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1754 return var_buffer;
1755
1756 case vtype_gid:
1757 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1758 return var_buffer;
1759
1760 case vtype_uid:
1761 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1762 return var_buffer;
1763
1764 case vtype_bool:
1765 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1766 return var_buffer;
1767
1768 case vtype_stringptr: /* Pointer to string */
1769 s = *((uschar **)(val));
1770 return (s == NULL)? US"" : s;
1771
1772 case vtype_pid:
1773 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1774 return var_buffer;
1775
1776 case vtype_load_avg:
1777 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1778 return var_buffer;
1779
1780 case vtype_host_lookup: /* Lookup if not done so */
1781 if (sender_host_name == NULL && sender_host_address != NULL &&
1782 !host_lookup_failed && host_name_lookup() == OK)
1783 host_build_sender_fullhost();
1784 return (sender_host_name == NULL)? US"" : sender_host_name;
1785
1786 case vtype_localpart: /* Get local part from address */
1787 s = *((uschar **)(val));
1788 if (s == NULL) return US"";
1789 domain = Ustrrchr(s, '@');
1790 if (domain == NULL) return s;
1791 if (domain - s > sizeof(var_buffer) - 1)
1792 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1793 " in string expansion", sizeof(var_buffer));
1794 Ustrncpy(var_buffer, s, domain - s);
1795 var_buffer[domain - s] = 0;
1796 return var_buffer;
1797
1798 case vtype_domain: /* Get domain from address */
1799 s = *((uschar **)(val));
1800 if (s == NULL) return US"";
1801 domain = Ustrrchr(s, '@');
1802 return (domain == NULL)? US"" : domain + 1;
1803
1804 case vtype_msgheaders:
1805 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1806
1807 case vtype_msgheaders_raw:
1808 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1809
1810 case vtype_msgbody: /* Pointer to msgbody string */
1811 case vtype_msgbody_end: /* Ditto, the end of the msg */
1812 ss = (uschar **)(val);
1813 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1814 {
1815 uschar *body;
1816 off_t start_offset = SPOOL_DATA_START_OFFSET;
1817 int len = message_body_visible;
1818 if (len > message_size) len = message_size;
1819 *ss = body = store_malloc(len+1);
1820 body[0] = 0;
1821 if (vp->type == vtype_msgbody_end)
1822 {
1823 struct stat statbuf;
1824 if (fstat(deliver_datafile, &statbuf) == 0)
1825 {
1826 start_offset = statbuf.st_size - len;
1827 if (start_offset < SPOOL_DATA_START_OFFSET)
1828 start_offset = SPOOL_DATA_START_OFFSET;
1829 }
1830 }
1831 lseek(deliver_datafile, start_offset, SEEK_SET);
1832 len = read(deliver_datafile, body, len);
1833 if (len > 0)
1834 {
1835 body[len] = 0;
1836 if (message_body_newlines) /* Separate loops for efficiency */
1837 {
1838 while (len > 0)
1839 { if (body[--len] == 0) body[len] = ' '; }
1840 }
1841 else
1842 {
1843 while (len > 0)
1844 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1845 }
1846 }
1847 }
1848 return (*ss == NULL)? US"" : *ss;
1849
1850 case vtype_todbsdin: /* BSD inbox time of day */
1851 return tod_stamp(tod_bsdin);
1852
1853 case vtype_tode: /* Unix epoch time of day */
1854 return tod_stamp(tod_epoch);
1855
1856 case vtype_todel: /* Unix epoch/usec time of day */
1857 return tod_stamp(tod_epoch_l);
1858
1859 case vtype_todf: /* Full time of day */
1860 return tod_stamp(tod_full);
1861
1862 case vtype_todl: /* Log format time of day */
1863 return tod_stamp(tod_log_bare); /* (without timezone) */
1864
1865 case vtype_todzone: /* Time zone offset only */
1866 return tod_stamp(tod_zone);
1867
1868 case vtype_todzulu: /* Zulu time */
1869 return tod_stamp(tod_zulu);
1870
1871 case vtype_todlf: /* Log file datestamp tod */
1872 return tod_stamp(tod_log_datestamp_daily);
1873
1874 case vtype_reply: /* Get reply address */
1875 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1876 headers_charset);
1877 if (s != NULL) while (isspace(*s)) s++;
1878 if (s == NULL || *s == 0)
1879 {
1880 *newsize = 0; /* For the *s==0 case */
1881 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1882 }
1883 if (s != NULL)
1884 {
1885 uschar *t;
1886 while (isspace(*s)) s++;
1887 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1888 while (t > s && isspace(t[-1])) t--;
1889 *t = 0;
1890 }
1891 return (s == NULL)? US"" : s;
1892
1893 case vtype_string_func:
1894 {
1895 uschar * (*fn)() = val;
1896 return fn();
1897 }
1898
1899 case vtype_pspace:
1900 {
1901 int inodes;
1902 sprintf(CS var_buffer, "%d",
1903 receive_statvfs(val == (void *)TRUE, &inodes));
1904 }
1905 return var_buffer;
1906
1907 case vtype_pinodes:
1908 {
1909 int inodes;
1910 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1911 sprintf(CS var_buffer, "%d", inodes);
1912 }
1913 return var_buffer;
1914
1915 case vtype_cert:
1916 return *(void **)val ? US"<cert>" : US"";
1917
1918 #ifndef DISABLE_DKIM
1919 case vtype_dkim:
1920 return dkim_exim_expand_query((int)(long)val);
1921 #endif
1922
1923 }
1924
1925 return NULL; /* Unknown variable. Silences static checkers. */
1926 }
1927
1928
1929
1930
1931 void
1932 modify_variable(uschar *name, void * value)
1933 {
1934 var_entry * vp;
1935 if ((vp = find_var_ent(name))) vp->value = value;
1936 return; /* Unknown variable name, fail silently */
1937 }
1938
1939
1940
1941
1942
1943 /*************************************************
1944 * Read and expand substrings *
1945 *************************************************/
1946
1947 /* This function is called to read and expand argument substrings for various
1948 expansion items. Some have a minimum requirement that is less than the maximum;
1949 in these cases, the first non-present one is set to NULL.
1950
1951 Arguments:
1952 sub points to vector of pointers to set
1953 n maximum number of substrings
1954 m minimum required
1955 sptr points to current string pointer
1956 skipping the skipping flag
1957 check_end if TRUE, check for final '}'
1958 name name of item, for error message
1959 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1960 the store.
1961
1962 Returns: 0 OK; string pointer updated
1963 1 curly bracketing error (too few arguments)
1964 2 too many arguments (only if check_end is set); message set
1965 3 other error (expansion failure)
1966 */
1967
1968 static int
1969 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1970 BOOL check_end, uschar *name, BOOL *resetok)
1971 {
1972 int i;
1973 const uschar *s = *sptr;
1974
1975 while (isspace(*s)) s++;
1976 for (i = 0; i < n; i++)
1977 {
1978 if (*s != '{')
1979 {
1980 if (i < m) return 1;
1981 sub[i] = NULL;
1982 break;
1983 }
1984 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
1985 if (sub[i] == NULL) return 3;
1986 if (*s++ != '}') return 1;
1987 while (isspace(*s)) s++;
1988 }
1989 if (check_end && *s++ != '}')
1990 {
1991 if (s[-1] == '{')
1992 {
1993 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1994 "(max is %d)", name, n);
1995 return 2;
1996 }
1997 return 1;
1998 }
1999
2000 *sptr = s;
2001 return 0;
2002 }
2003
2004
2005
2006
2007 /*************************************************
2008 * Elaborate message for bad variable *
2009 *************************************************/
2010
2011 /* For the "unknown variable" message, take a look at the variable's name, and
2012 give additional information about possible ACL variables. The extra information
2013 is added on to expand_string_message.
2014
2015 Argument: the name of the variable
2016 Returns: nothing
2017 */
2018
2019 static void
2020 check_variable_error_message(uschar *name)
2021 {
2022 if (Ustrncmp(name, "acl_", 4) == 0)
2023 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2024 (name[4] == 'c' || name[4] == 'm')?
2025 (isalpha(name[5])?
2026 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2027 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2028 ) :
2029 US"user-defined ACL variables must start acl_c or acl_m");
2030 }
2031
2032
2033
2034 /*
2035 Load args from sub array to globals, and call acl_check().
2036 Sub array will be corrupted on return.
2037
2038 Returns: OK access is granted by an ACCEPT verb
2039 DISCARD access is granted by a DISCARD verb
2040 FAIL access is denied
2041 FAIL_DROP access is denied; drop the connection
2042 DEFER can't tell at the moment
2043 ERROR disaster
2044 */
2045 static int
2046 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2047 {
2048 int i;
2049 int sav_narg = acl_narg;
2050 int ret;
2051 uschar * dummy_logmsg;
2052 extern int acl_where;
2053
2054 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2055 for (i = 0; i < nsub && sub[i+1]; i++)
2056 {
2057 uschar * tmp = acl_arg[i];
2058 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2059 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2060 }
2061 acl_narg = i;
2062 while (i < nsub)
2063 {
2064 sub[i+1] = acl_arg[i];
2065 acl_arg[i++] = NULL;
2066 }
2067
2068 DEBUG(D_expand)
2069 debug_printf("expanding: acl: %s arg: %s%s\n",
2070 sub[0],
2071 acl_narg>0 ? acl_arg[0] : US"<none>",
2072 acl_narg>1 ? " +more" : "");
2073
2074 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2075
2076 for (i = 0; i < nsub; i++)
2077 acl_arg[i] = sub[i+1]; /* restore old args */
2078 acl_narg = sav_narg;
2079
2080 return ret;
2081 }
2082
2083
2084
2085
2086 /*************************************************
2087 * Read and evaluate a condition *
2088 *************************************************/
2089
2090 /*
2091 Arguments:
2092 s points to the start of the condition text
2093 resetok points to a BOOL which is written false if it is unsafe to
2094 free memory. Certain condition types (acl) may have side-effect
2095 allocation which must be preserved.
2096 yield points to a BOOL to hold the result of the condition test;
2097 if NULL, we are just reading through a condition that is
2098 part of an "or" combination to check syntax, or in a state
2099 where the answer isn't required
2100
2101 Returns: a pointer to the first character after the condition, or
2102 NULL after an error
2103 */
2104
2105 static const uschar *
2106 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2107 {
2108 BOOL testfor = TRUE;
2109 BOOL tempcond, combined_cond;
2110 BOOL *subcondptr;
2111 BOOL sub2_honour_dollar = TRUE;
2112 int i, rc, cond_type, roffset;
2113 int_eximarith_t num[2];
2114 struct stat statbuf;
2115 uschar name[256];
2116 const uschar *sub[10];
2117
2118 const pcre *re;
2119 const uschar *rerror;
2120
2121 for (;;)
2122 {
2123 while (isspace(*s)) s++;
2124 if (*s == '!') { testfor = !testfor; s++; } else break;
2125 }
2126
2127 /* Numeric comparisons are symbolic */
2128
2129 if (*s == '=' || *s == '>' || *s == '<')
2130 {
2131 int p = 0;
2132 name[p++] = *s++;
2133 if (*s == '=')
2134 {
2135 name[p++] = '=';
2136 s++;
2137 }
2138 name[p] = 0;
2139 }
2140
2141 /* All other conditions are named */
2142
2143 else s = read_name(name, 256, s, US"_");
2144
2145 /* If we haven't read a name, it means some non-alpha character is first. */
2146
2147 if (name[0] == 0)
2148 {
2149 expand_string_message = string_sprintf("condition name expected, "
2150 "but found \"%.16s\"", s);
2151 return NULL;
2152 }
2153
2154 /* Find which condition we are dealing with, and switch on it */
2155
2156 cond_type = chop_match(name, cond_table, nelem(cond_table));
2157 switch(cond_type)
2158 {
2159 /* def: tests for a non-empty variable, or for the existence of a header. If
2160 yield == NULL we are in a skipping state, and don't care about the answer. */
2161
2162 case ECOND_DEF:
2163 if (*s != ':')
2164 {
2165 expand_string_message = US"\":\" expected after \"def\"";
2166 return NULL;
2167 }
2168
2169 s = read_name(name, 256, s+1, US"_");
2170
2171 /* Test for a header's existence. If the name contains a closing brace
2172 character, this may be a user error where the terminating colon has been
2173 omitted. Set a flag to adjust a subsequent error message in this case. */
2174
2175 if (Ustrncmp(name, "h_", 2) == 0 ||
2176 Ustrncmp(name, "rh_", 3) == 0 ||
2177 Ustrncmp(name, "bh_", 3) == 0 ||
2178 Ustrncmp(name, "header_", 7) == 0 ||
2179 Ustrncmp(name, "rheader_", 8) == 0 ||
2180 Ustrncmp(name, "bheader_", 8) == 0)
2181 {
2182 s = read_header_name(name, 256, s);
2183 /* {-for-text-editors */
2184 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2185 if (yield != NULL) *yield =
2186 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2187 }
2188
2189 /* Test for a variable's having a non-empty value. A non-existent variable
2190 causes an expansion failure. */
2191
2192 else
2193 {
2194 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2195 if (value == NULL)
2196 {
2197 expand_string_message = (name[0] == 0)?
2198 string_sprintf("variable name omitted after \"def:\"") :
2199 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2200 check_variable_error_message(name);
2201 return NULL;
2202 }
2203 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2204 }
2205
2206 return s;
2207
2208
2209 /* first_delivery tests for first delivery attempt */
2210
2211 case ECOND_FIRST_DELIVERY:
2212 if (yield != NULL) *yield = deliver_firsttime == testfor;
2213 return s;
2214
2215
2216 /* queue_running tests for any process started by a queue runner */
2217
2218 case ECOND_QUEUE_RUNNING:
2219 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2220 return s;
2221
2222
2223 /* exists: tests for file existence
2224 isip: tests for any IP address
2225 isip4: tests for an IPv4 address
2226 isip6: tests for an IPv6 address
2227 pam: does PAM authentication
2228 radius: does RADIUS authentication
2229 ldapauth: does LDAP authentication
2230 pwcheck: does Cyrus SASL pwcheck authentication
2231 */
2232
2233 case ECOND_EXISTS:
2234 case ECOND_ISIP:
2235 case ECOND_ISIP4:
2236 case ECOND_ISIP6:
2237 case ECOND_PAM:
2238 case ECOND_RADIUS:
2239 case ECOND_LDAPAUTH:
2240 case ECOND_PWCHECK:
2241
2242 while (isspace(*s)) s++;
2243 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2244
2245 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2246 if (sub[0] == NULL) return NULL;
2247 /* {-for-text-editors */
2248 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2249
2250 if (yield == NULL) return s; /* No need to run the test if skipping */
2251
2252 switch(cond_type)
2253 {
2254 case ECOND_EXISTS:
2255 if ((expand_forbid & RDO_EXISTS) != 0)
2256 {
2257 expand_string_message = US"File existence tests are not permitted";
2258 return NULL;
2259 }
2260 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2261 break;
2262
2263 case ECOND_ISIP:
2264 case ECOND_ISIP4:
2265 case ECOND_ISIP6:
2266 rc = string_is_ip_address(sub[0], NULL);
2267 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2268 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2269 break;
2270
2271 /* Various authentication tests - all optionally compiled */
2272
2273 case ECOND_PAM:
2274 #ifdef SUPPORT_PAM
2275 rc = auth_call_pam(sub[0], &expand_string_message);
2276 goto END_AUTH;
2277 #else
2278 goto COND_FAILED_NOT_COMPILED;
2279 #endif /* SUPPORT_PAM */
2280
2281 case ECOND_RADIUS:
2282 #ifdef RADIUS_CONFIG_FILE
2283 rc = auth_call_radius(sub[0], &expand_string_message);
2284 goto END_AUTH;
2285 #else
2286 goto COND_FAILED_NOT_COMPILED;
2287 #endif /* RADIUS_CONFIG_FILE */
2288
2289 case ECOND_LDAPAUTH:
2290 #ifdef LOOKUP_LDAP
2291 {
2292 /* Just to keep the interface the same */
2293 BOOL do_cache;
2294 int old_pool = store_pool;
2295 store_pool = POOL_SEARCH;
2296 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2297 &expand_string_message, &do_cache);
2298 store_pool = old_pool;
2299 }
2300 goto END_AUTH;
2301 #else
2302 goto COND_FAILED_NOT_COMPILED;
2303 #endif /* LOOKUP_LDAP */
2304
2305 case ECOND_PWCHECK:
2306 #ifdef CYRUS_PWCHECK_SOCKET
2307 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2308 goto END_AUTH;
2309 #else
2310 goto COND_FAILED_NOT_COMPILED;
2311 #endif /* CYRUS_PWCHECK_SOCKET */
2312
2313 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2314 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2315 END_AUTH:
2316 if (rc == ERROR || rc == DEFER) return NULL;
2317 *yield = (rc == OK) == testfor;
2318 #endif
2319 }
2320 return s;
2321
2322
2323 /* call ACL (in a conditional context). Accept true, deny false.
2324 Defer is a forced-fail. Anything set by message= goes to $value.
2325 Up to ten parameters are used; we use the braces round the name+args
2326 like the saslauthd condition does, to permit a variable number of args.
2327 See also the expansion-item version EITEM_ACL and the traditional
2328 acl modifier ACLC_ACL.
2329 Since the ACL may allocate new global variables, tell our caller to not
2330 reclaim memory.
2331 */
2332
2333 case ECOND_ACL:
2334 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2335 {
2336 uschar *sub[10];
2337 uschar *user_msg;
2338 BOOL cond = FALSE;
2339 int size = 0;
2340 int ptr = 0;
2341
2342 while (isspace(*s)) s++;
2343 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2344
2345 switch(read_subs(sub, nelem(sub), 1,
2346 &s, yield == NULL, TRUE, US"acl", resetok))
2347 {
2348 case 1: expand_string_message = US"too few arguments or bracketing "
2349 "error for acl";
2350 case 2:
2351 case 3: return NULL;
2352 }
2353
2354 *resetok = FALSE;
2355 if (yield != NULL) switch(eval_acl(sub, nelem(sub), &user_msg))
2356 {
2357 case OK:
2358 cond = TRUE;
2359 case FAIL:
2360 lookup_value = NULL;
2361 if (user_msg)
2362 {
2363 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2364 lookup_value[ptr] = '\0';
2365 }
2366 *yield = cond == testfor;
2367 break;
2368
2369 case DEFER:
2370 expand_string_forcedfail = TRUE;
2371 default:
2372 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2373 return NULL;
2374 }
2375 return s;
2376 }
2377
2378
2379 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2380
2381 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2382
2383 However, the last two are optional. That is why the whole set is enclosed
2384 in their own set of braces. */
2385
2386 case ECOND_SASLAUTHD:
2387 #ifndef CYRUS_SASLAUTHD_SOCKET
2388 goto COND_FAILED_NOT_COMPILED;
2389 #else
2390 {
2391 uschar *sub[4];
2392 while (isspace(*s)) s++;
2393 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2394 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2395 resetok))
2396 {
2397 case 1: expand_string_message = US"too few arguments or bracketing "
2398 "error for saslauthd";
2399 case 2:
2400 case 3: return NULL;
2401 }
2402 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2403 if (yield != NULL)
2404 {
2405 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2406 &expand_string_message);
2407 if (rc == ERROR || rc == DEFER) return NULL;
2408 *yield = (rc == OK) == testfor;
2409 }
2410 return s;
2411 }
2412 #endif /* CYRUS_SASLAUTHD_SOCKET */
2413
2414
2415 /* symbolic operators for numeric and string comparison, and a number of
2416 other operators, all requiring two arguments.
2417
2418 crypteq: encrypts plaintext and compares against an encrypted text,
2419 using crypt(), crypt16(), MD5 or SHA-1
2420 inlist/inlisti: checks if first argument is in the list of the second
2421 match: does a regular expression match and sets up the numerical
2422 variables if it succeeds
2423 match_address: matches in an address list
2424 match_domain: matches in a domain list
2425 match_ip: matches a host list that is restricted to IP addresses
2426 match_local_part: matches in a local part list
2427 */
2428
2429 case ECOND_MATCH_ADDRESS:
2430 case ECOND_MATCH_DOMAIN:
2431 case ECOND_MATCH_IP:
2432 case ECOND_MATCH_LOCAL_PART:
2433 #ifndef EXPAND_LISTMATCH_RHS
2434 sub2_honour_dollar = FALSE;
2435 #endif
2436 /* FALLTHROUGH */
2437
2438 case ECOND_CRYPTEQ:
2439 case ECOND_INLIST:
2440 case ECOND_INLISTI:
2441 case ECOND_MATCH:
2442
2443 case ECOND_NUM_L: /* Numerical comparisons */
2444 case ECOND_NUM_LE:
2445 case ECOND_NUM_E:
2446 case ECOND_NUM_EE:
2447 case ECOND_NUM_G:
2448 case ECOND_NUM_GE:
2449
2450 case ECOND_STR_LT: /* String comparisons */
2451 case ECOND_STR_LTI:
2452 case ECOND_STR_LE:
2453 case ECOND_STR_LEI:
2454 case ECOND_STR_EQ:
2455 case ECOND_STR_EQI:
2456 case ECOND_STR_GT:
2457 case ECOND_STR_GTI:
2458 case ECOND_STR_GE:
2459 case ECOND_STR_GEI:
2460
2461 for (i = 0; i < 2; i++)
2462 {
2463 /* Sometimes, we don't expand substrings; too many insecure configurations
2464 created using match_address{}{} and friends, where the second param
2465 includes information from untrustworthy sources. */
2466 BOOL honour_dollar = TRUE;
2467 if ((i > 0) && !sub2_honour_dollar)
2468 honour_dollar = FALSE;
2469
2470 while (isspace(*s)) s++;
2471 if (*s != '{')
2472 {
2473 if (i == 0) goto COND_FAILED_CURLY_START;
2474 expand_string_message = string_sprintf("missing 2nd string in {} "
2475 "after \"%s\"", name);
2476 return NULL;
2477 }
2478 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2479 honour_dollar, resetok);
2480 if (sub[i] == NULL) return NULL;
2481 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2482
2483 /* Convert to numerical if required; we know that the names of all the
2484 conditions that compare numbers do not start with a letter. This just saves
2485 checking for them individually. */
2486
2487 if (!isalpha(name[0]) && yield != NULL)
2488 {
2489 if (sub[i][0] == 0)
2490 {
2491 num[i] = 0;
2492 DEBUG(D_expand)
2493 debug_printf("empty string cast to zero for numerical comparison\n");
2494 }
2495 else
2496 {
2497 num[i] = expanded_string_integer(sub[i], FALSE);
2498 if (expand_string_message != NULL) return NULL;
2499 }
2500 }
2501 }
2502
2503 /* Result not required */
2504
2505 if (yield == NULL) return s;
2506
2507 /* Do an appropriate comparison */
2508
2509 switch(cond_type)
2510 {
2511 case ECOND_NUM_E:
2512 case ECOND_NUM_EE:
2513 tempcond = (num[0] == num[1]);
2514 break;
2515
2516 case ECOND_NUM_G:
2517 tempcond = (num[0] > num[1]);
2518 break;
2519
2520 case ECOND_NUM_GE:
2521 tempcond = (num[0] >= num[1]);
2522 break;
2523
2524 case ECOND_NUM_L:
2525 tempcond = (num[0] < num[1]);
2526 break;
2527
2528 case ECOND_NUM_LE:
2529 tempcond = (num[0] <= num[1]);
2530 break;
2531
2532 case ECOND_STR_LT:
2533 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2534 break;
2535
2536 case ECOND_STR_LTI:
2537 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2538 break;
2539
2540 case ECOND_STR_LE:
2541 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2542 break;
2543
2544 case ECOND_STR_LEI:
2545 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2546 break;
2547
2548 case ECOND_STR_EQ:
2549 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2550 break;
2551
2552 case ECOND_STR_EQI:
2553 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2554 break;
2555
2556 case ECOND_STR_GT:
2557 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2558 break;
2559
2560 case ECOND_STR_GTI:
2561 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2562 break;
2563
2564 case ECOND_STR_GE:
2565 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2566 break;
2567
2568 case ECOND_STR_GEI:
2569 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2570 break;
2571
2572 case ECOND_MATCH: /* Regular expression match */
2573 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2574 NULL);
2575 if (re == NULL)
2576 {
2577 expand_string_message = string_sprintf("regular expression error in "
2578 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2579 return NULL;
2580 }
2581 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2582 break;
2583
2584 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2585 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2586 goto MATCHED_SOMETHING;
2587
2588 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2589 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2590 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2591 goto MATCHED_SOMETHING;
2592
2593 case ECOND_MATCH_IP: /* Match IP address in a host list */
2594 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2595 {
2596 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2597 sub[0]);
2598 return NULL;
2599 }
2600 else
2601 {
2602 unsigned int *nullcache = NULL;
2603 check_host_block cb;
2604
2605 cb.host_name = US"";
2606 cb.host_address = sub[0];
2607
2608 /* If the host address starts off ::ffff: it is an IPv6 address in
2609 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2610 addresses. */
2611
2612 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2613 cb.host_address + 7 : cb.host_address;
2614
2615 rc = match_check_list(
2616 &sub[1], /* the list */
2617 0, /* separator character */
2618 &hostlist_anchor, /* anchor pointer */
2619 &nullcache, /* cache pointer */
2620 check_host, /* function for testing */
2621 &cb, /* argument for function */
2622 MCL_HOST, /* type of check */
2623 sub[0], /* text for debugging */
2624 NULL); /* where to pass back data */
2625 }
2626 goto MATCHED_SOMETHING;
2627
2628 case ECOND_MATCH_LOCAL_PART:
2629 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2630 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2631 /* Fall through */
2632 /* VVVVVVVVVVVV */
2633 MATCHED_SOMETHING:
2634 switch(rc)
2635 {
2636 case OK:
2637 tempcond = TRUE;
2638 break;
2639
2640 case FAIL:
2641 tempcond = FALSE;
2642 break;
2643
2644 case DEFER:
2645 expand_string_message = string_sprintf("unable to complete match "
2646 "against \"%s\": %s", sub[1], search_error_message);
2647 return NULL;
2648 }
2649
2650 break;
2651
2652 /* Various "encrypted" comparisons. If the second string starts with
2653 "{" then an encryption type is given. Default to crypt() or crypt16()
2654 (build-time choice). */
2655 /* }-for-text-editors */
2656
2657 case ECOND_CRYPTEQ:
2658 #ifndef SUPPORT_CRYPTEQ
2659 goto COND_FAILED_NOT_COMPILED;
2660 #else
2661 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2662 {
2663 int sublen = Ustrlen(sub[1]+5);
2664 md5 base;
2665 uschar digest[16];
2666
2667 md5_start(&base);
2668 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2669
2670 /* If the length that we are comparing against is 24, the MD5 digest
2671 is expressed as a base64 string. This is the way LDAP does it. However,
2672 some other software uses a straightforward hex representation. We assume
2673 this if the length is 32. Other lengths fail. */
2674
2675 if (sublen == 24)
2676 {
2677 uschar *coded = auth_b64encode((uschar *)digest, 16);
2678 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2679 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2680 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2681 }
2682 else if (sublen == 32)
2683 {
2684 int i;
2685 uschar coded[36];
2686 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2687 coded[32] = 0;
2688 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2689 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2690 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2691 }
2692 else
2693 {
2694 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2695 "fail\n crypted=%s\n", sub[1]+5);
2696 tempcond = FALSE;
2697 }
2698 }
2699
2700 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2701 {
2702 int sublen = Ustrlen(sub[1]+6);
2703 sha1 base;
2704 uschar digest[20];
2705
2706 sha1_start(&base);
2707 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2708
2709 /* If the length that we are comparing against is 28, assume the SHA1
2710 digest is expressed as a base64 string. If the length is 40, assume a
2711 straightforward hex representation. Other lengths fail. */
2712
2713 if (sublen == 28)
2714 {
2715 uschar *coded = auth_b64encode((uschar *)digest, 20);
2716 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2717 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2718 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2719 }
2720 else if (sublen == 40)
2721 {
2722 int i;
2723 uschar coded[44];
2724 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2725 coded[40] = 0;
2726 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2727 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2728 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2729 }
2730 else
2731 {
2732 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2733 "fail\n crypted=%s\n", sub[1]+6);
2734 tempcond = FALSE;
2735 }
2736 }
2737
2738 else /* {crypt} or {crypt16} and non-{ at start */
2739 /* }-for-text-editors */
2740 {
2741 int which = 0;
2742 uschar *coded;
2743
2744 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2745 {
2746 sub[1] += 7;
2747 which = 1;
2748 }
2749 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2750 {
2751 sub[1] += 9;
2752 which = 2;
2753 }
2754 else if (sub[1][0] == '{') /* }-for-text-editors */
2755 {
2756 expand_string_message = string_sprintf("unknown encryption mechanism "
2757 "in \"%s\"", sub[1]);
2758 return NULL;
2759 }
2760
2761 switch(which)
2762 {
2763 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2764 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2765 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2766 }
2767
2768 #define STR(s) # s
2769 #define XSTR(s) STR(s)
2770 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2771 " subject=%s\n crypted=%s\n",
2772 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2773 coded, sub[1]);
2774 #undef STR
2775 #undef XSTR
2776
2777 /* If the encrypted string contains fewer than two characters (for the
2778 salt), force failure. Otherwise we get false positives: with an empty
2779 string the yield of crypt() is an empty string! */
2780
2781 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2782 (Ustrcmp(coded, sub[1]) == 0);
2783 }
2784 break;
2785 #endif /* SUPPORT_CRYPTEQ */
2786
2787 case ECOND_INLIST:
2788 case ECOND_INLISTI:
2789 {
2790 const uschar * list = sub[1];
2791 int sep = 0;
2792 uschar *save_iterate_item = iterate_item;
2793 int (*compare)(const uschar *, const uschar *);
2794
2795 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2796
2797 tempcond = FALSE;
2798 compare = cond_type == ECOND_INLISTI
2799 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2800
2801 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2802 if (compare(sub[0], iterate_item) == 0)
2803 {
2804 tempcond = TRUE;
2805 break;
2806 }
2807 iterate_item = save_iterate_item;
2808 }
2809
2810 } /* Switch for comparison conditions */
2811
2812 *yield = tempcond == testfor;
2813 return s; /* End of comparison conditions */
2814
2815
2816 /* and/or: computes logical and/or of several conditions */
2817
2818 case ECOND_AND:
2819 case ECOND_OR:
2820 subcondptr = (yield == NULL)? NULL : &tempcond;
2821 combined_cond = (cond_type == ECOND_AND);
2822
2823 while (isspace(*s)) s++;
2824 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2825
2826 for (;;)
2827 {
2828 while (isspace(*s)) s++;
2829 /* {-for-text-editors */
2830 if (*s == '}') break;
2831 if (*s != '{') /* }-for-text-editors */
2832 {
2833 expand_string_message = string_sprintf("each subcondition "
2834 "inside an \"%s{...}\" condition must be in its own {}", name);
2835 return NULL;
2836 }
2837
2838 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2839 {
2840 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2841 expand_string_message, name);
2842 return NULL;
2843 }
2844 while (isspace(*s)) s++;
2845
2846 /* {-for-text-editors */
2847 if (*s++ != '}')
2848 {
2849 /* {-for-text-editors */
2850 expand_string_message = string_sprintf("missing } at end of condition "
2851 "inside \"%s\" group", name);
2852 return NULL;
2853 }
2854
2855 if (yield != NULL)
2856 {
2857 if (cond_type == ECOND_AND)
2858 {
2859 combined_cond &= tempcond;
2860 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2861 } /* evaluate any more */
2862 else
2863 {
2864 combined_cond |= tempcond;
2865 if (combined_cond) subcondptr = NULL; /* once true, don't */
2866 } /* evaluate any more */
2867 }
2868 }
2869
2870 if (yield != NULL) *yield = (combined_cond == testfor);
2871 return ++s;
2872
2873
2874 /* forall/forany: iterates a condition with different values */
2875
2876 case ECOND_FORALL:
2877 case ECOND_FORANY:
2878 {
2879 const uschar * list;
2880 int sep = 0;
2881 uschar *save_iterate_item = iterate_item;
2882
2883 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2884
2885 while (isspace(*s)) s++;
2886 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2887 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2888 if (sub[0] == NULL) return NULL;
2889 /* {-for-text-editors */
2890 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2891
2892 while (isspace(*s)) s++;
2893 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2894
2895 sub[1] = s;
2896
2897 /* Call eval_condition once, with result discarded (as if scanning a
2898 "false" part). This allows us to find the end of the condition, because if
2899 the list it empty, we won't actually evaluate the condition for real. */
2900
2901 if (!(s = eval_condition(sub[1], resetok, NULL)))
2902 {
2903 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2904 expand_string_message, name);
2905 return NULL;
2906 }
2907 while (isspace(*s)) s++;
2908
2909 /* {-for-text-editors */
2910 if (*s++ != '}')
2911 {
2912 /* {-for-text-editors */
2913 expand_string_message = string_sprintf("missing } at end of condition "
2914 "inside \"%s\"", name);
2915 return NULL;
2916 }
2917
2918 if (yield != NULL) *yield = !testfor;
2919 list = sub[0];
2920 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2921 {
2922 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2923 if (!eval_condition(sub[1], resetok, &tempcond))
2924 {
2925 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2926 expand_string_message, name);
2927 iterate_item = save_iterate_item;
2928 return NULL;
2929 }
2930 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2931 tempcond? "true":"false");
2932
2933 if (yield != NULL) *yield = (tempcond == testfor);
2934 if (tempcond == (cond_type == ECOND_FORANY)) break;
2935 }
2936
2937 iterate_item = save_iterate_item;
2938 return s;
2939 }
2940
2941
2942 /* The bool{} expansion condition maps a string to boolean.
2943 The values supported should match those supported by the ACL condition
2944 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2945 of true/false. Note that Router "condition" rules have a different
2946 interpretation, where general data can be used and only a few values
2947 map to FALSE.
2948 Note that readconf.c boolean matching, for boolean configuration options,
2949 only matches true/yes/false/no.
2950 The bool_lax{} condition matches the Router logic, which is much more
2951 liberal. */
2952 case ECOND_BOOL:
2953 case ECOND_BOOL_LAX:
2954 {
2955 uschar *sub_arg[1];
2956 uschar *t, *t2;
2957 uschar *ourname;
2958 size_t len;
2959 BOOL boolvalue = FALSE;
2960 while (isspace(*s)) s++;
2961 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2962 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2963 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2964 {
2965 case 1: expand_string_message = string_sprintf(
2966 "too few arguments or bracketing error for %s",
2967 ourname);
2968 /*FALLTHROUGH*/
2969 case 2:
2970 case 3: return NULL;
2971 }
2972 t = sub_arg[0];
2973 while (isspace(*t)) t++;
2974 len = Ustrlen(t);
2975 if (len)
2976 {
2977 /* trailing whitespace: seems like a good idea to ignore it too */
2978 t2 = t + len - 1;
2979 while (isspace(*t2)) t2--;
2980 if (t2 != (t + len))
2981 {
2982 *++t2 = '\0';
2983 len = t2 - t;
2984 }
2985 }
2986 DEBUG(D_expand)
2987 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2988 /* logic for the lax case from expand_check_condition(), which also does
2989 expands, and the logic is both short and stable enough that there should
2990 be no maintenance burden from replicating it. */
2991 if (len == 0)
2992 boolvalue = FALSE;
2993 else if (*t == '-'
2994 ? Ustrspn(t+1, "0123456789") == len-1
2995 : Ustrspn(t, "0123456789") == len)
2996 {
2997 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2998 /* expand_check_condition only does a literal string "0" check */
2999 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3000 boolvalue = TRUE;
3001 }
3002 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3003 boolvalue = TRUE;
3004 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3005 boolvalue = FALSE;
3006 else if (cond_type == ECOND_BOOL_LAX)
3007 boolvalue = TRUE;
3008 else
3009 {
3010 expand_string_message = string_sprintf("unrecognised boolean "
3011 "value \"%s\"", t);
3012 return NULL;
3013 }
3014 if (yield != NULL) *yield = (boolvalue == testfor);
3015 return s;
3016 }
3017
3018 /* Unknown condition */
3019
3020 default:
3021 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3022 return NULL;
3023 } /* End switch on condition type */
3024
3025 /* Missing braces at start and end of data */
3026
3027 COND_FAILED_CURLY_START:
3028 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3029 return NULL;
3030
3031 COND_FAILED_CURLY_END:
3032 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3033 name);
3034 return NULL;
3035
3036 /* A condition requires code that is not compiled */
3037
3038 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3039 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3040 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3041 COND_FAILED_NOT_COMPILED:
3042 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3043 name);
3044 return NULL;
3045 #endif
3046 }
3047
3048
3049
3050
3051 /*************************************************
3052 * Save numerical variables *
3053 *************************************************/
3054
3055 /* This function is called from items such as "if" that want to preserve and
3056 restore the numbered variables.
3057
3058 Arguments:
3059 save_expand_string points to an array of pointers to set
3060 save_expand_nlength points to an array of ints for the lengths
3061
3062 Returns: the value of expand max to save
3063 */
3064
3065 static int
3066 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3067 {
3068 int i;
3069 for (i = 0; i <= expand_nmax; i++)
3070 {
3071 save_expand_nstring[i] = expand_nstring[i];
3072 save_expand_nlength[i] = expand_nlength[i];
3073 }
3074 return expand_nmax;
3075 }
3076
3077
3078
3079 /*************************************************
3080 * Restore numerical variables *
3081 *************************************************/
3082
3083 /* This function restored saved values of numerical strings.
3084
3085 Arguments:
3086 save_expand_nmax the number of strings to restore
3087 save_expand_string points to an array of pointers
3088 save_expand_nlength points to an array of ints
3089
3090 Returns: nothing
3091 */
3092
3093 static void
3094 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3095 int *save_expand_nlength)
3096 {
3097 int i;
3098 expand_nmax = save_expand_nmax;
3099 for (i = 0; i <= expand_nmax; i++)
3100 {
3101 expand_nstring[i] = save_expand_nstring[i];
3102 expand_nlength[i] = save_expand_nlength[i];
3103 }
3104 }
3105
3106
3107
3108
3109
3110 /*************************************************
3111 * Handle yes/no substrings *
3112 *************************************************/
3113
3114 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3115 alternative substrings that depend on whether or not the condition was true,
3116 or the lookup or extraction succeeded. The substrings always have to be
3117 expanded, to check their syntax, but "skipping" is set when the result is not
3118 needed - this avoids unnecessary nested lookups.
3119
3120 Arguments:
3121 skipping TRUE if we were skipping when this item was reached
3122 yes TRUE if the first string is to be used, else use the second
3123 save_lookup a value to put back into lookup_value before the 2nd expansion
3124 sptr points to the input string pointer
3125 yieldptr points to the output string pointer
3126 sizeptr points to the output string size
3127 ptrptr points to the output string pointer
3128 type "lookup" or "if" or "extract" or "run", for error message
3129 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3130 the store.
3131
3132 Returns: 0 OK; lookup_value has been reset to save_lookup
3133 1 expansion failed
3134 2 expansion failed because of bracketing error
3135 */
3136
3137 static int
3138 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3139 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3140 {
3141 int rc = 0;
3142 const uschar *s = *sptr; /* Local value */
3143 uschar *sub1, *sub2;
3144
3145 /* If there are no following strings, we substitute the contents of $value for
3146 lookups and for extractions in the success case. For the ${if item, the string
3147 "true" is substituted. In the fail case, nothing is substituted for all three
3148 items. */
3149
3150 while (isspace(*s)) s++;
3151 if (*s == '}')
3152 {
3153 if (type[0] == 'i')
3154 {
3155 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3156 }
3157 else
3158 {
3159 if (yes && lookup_value != NULL)
3160 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3161 Ustrlen(lookup_value));
3162 lookup_value = save_lookup;
3163 }
3164 s++;
3165 goto RETURN;
3166 }
3167
3168 /* The first following string must be braced. */
3169
3170 if (*s++ != '{') goto FAILED_CURLY;
3171
3172 /* Expand the first substring. Forced failures are noticed only if we actually
3173 want this string. Set skipping in the call in the fail case (this will always
3174 be the case if we were already skipping). */
3175
3176 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3177 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3178 expand_string_forcedfail = FALSE;
3179 if (*s++ != '}') goto FAILED_CURLY;
3180
3181 /* If we want the first string, add it to the output */
3182
3183 if (yes)
3184 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3185
3186 /* If this is called from a lookup or an extract, we want to restore $value to
3187 what it was at the start of the item, so that it has this value during the
3188 second string expansion. For the call from "if" or "run" to this function,
3189 save_lookup is set to lookup_value, so that this statement does nothing. */
3190
3191 lookup_value = save_lookup;
3192
3193 /* There now follows either another substring, or "fail", or nothing. This
3194 time, forced failures are noticed only if we want the second string. We must
3195 set skipping in the nested call if we don't want this string, or if we were
3196 already skipping. */
3197
3198 while (isspace(*s)) s++;
3199 if (*s == '{')
3200 {
3201 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3202 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3203 expand_string_forcedfail = FALSE;
3204 if (*s++ != '}') goto FAILED_CURLY;
3205
3206 /* If we want the second string, add it to the output */
3207
3208 if (!yes)
3209 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3210 }
3211
3212 /* If there is no second string, but the word "fail" is present when the use of
3213 the second string is wanted, set a flag indicating it was a forced failure
3214 rather than a syntactic error. Swallow the terminating } in case this is nested
3215 inside another lookup or if or extract. */
3216
3217 else if (*s != '}')
3218 {
3219 uschar name[256];
3220 /* deconst cast ok here as source is s anyway */
3221 s = US read_name(name, sizeof(name), s, US"_");
3222 if (Ustrcmp(name, "fail") == 0)
3223 {
3224 if (!yes && !skipping)
3225 {
3226 while (isspace(*s)) s++;
3227 if (*s++ != '}') goto FAILED_CURLY;
3228 expand_string_message =
3229 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3230 expand_string_forcedfail = TRUE;
3231 goto FAILED;
3232 }
3233 }
3234 else
3235 {
3236 expand_string_message =
3237 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3238 goto FAILED;
3239 }
3240 }
3241
3242 /* All we have to do now is to check on the final closing brace. */
3243
3244 while (isspace(*s)) s++;
3245 if (*s++ == '}') goto RETURN;
3246
3247 /* Get here if there is a bracketing failure */
3248
3249 FAILED_CURLY:
3250 rc++;
3251
3252 /* Get here for other failures */
3253
3254 FAILED:
3255 rc++;
3256
3257 /* Update the input pointer value before returning */
3258
3259 RETURN:
3260 *sptr = s;
3261 return rc;
3262 }
3263
3264
3265
3266
3267 /*************************************************
3268 * Handle MD5 or SHA-1 computation for HMAC *
3269 *************************************************/
3270
3271 /* These are some wrapping functions that enable the HMAC code to be a bit
3272 cleaner. A good compiler will spot the tail recursion.
3273
3274 Arguments:
3275 type HMAC_MD5 or HMAC_SHA1
3276 remaining are as for the cryptographic hash functions
3277
3278 Returns: nothing
3279 */
3280
3281 static void
3282 chash_start(int type, void *base)
3283 {
3284 if (type == HMAC_MD5)
3285 md5_start((md5 *)base);
3286 else
3287 sha1_start((sha1 *)base);
3288 }
3289
3290 static void
3291 chash_mid(int type, void *base, uschar *string)
3292 {
3293 if (type == HMAC_MD5)
3294 md5_mid((md5 *)base, string);
3295 else
3296 sha1_mid((sha1 *)base, string);
3297 }
3298
3299 static void
3300 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3301 {
3302 if (type == HMAC_MD5)
3303 md5_end((md5 *)base, string, length, digest);
3304 else
3305 sha1_end((sha1 *)base, string, length, digest);
3306 }
3307
3308
3309
3310
3311
3312 /********************************************************
3313 * prvs: Get last three digits of days since Jan 1, 1970 *
3314 ********************************************************/
3315
3316 /* This is needed to implement the "prvs" BATV reverse
3317 path signing scheme
3318
3319 Argument: integer "days" offset to add or substract to
3320 or from the current number of days.
3321
3322 Returns: pointer to string containing the last three
3323 digits of the number of days since Jan 1, 1970,
3324 modified by the offset argument, NULL if there
3325 was an error in the conversion.
3326
3327 */
3328
3329 static uschar *
3330 prvs_daystamp(int day_offset)
3331 {
3332 uschar *days = store_get(32); /* Need at least 24 for cases */
3333 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3334 (time(NULL) + day_offset*86400)/86400);
3335 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3336 }
3337
3338
3339
3340 /********************************************************
3341 * prvs: perform HMAC-SHA1 computation of prvs bits *
3342 ********************************************************/
3343
3344 /* This is needed to implement the "prvs" BATV reverse
3345 path signing scheme
3346
3347 Arguments:
3348 address RFC2821 Address to use
3349 key The key to use (must be less than 64 characters
3350 in size)
3351 key_num Single-digit key number to use. Defaults to
3352 '0' when NULL.
3353
3354 Returns: pointer to string containing the first three
3355 bytes of the final hash in hex format, NULL if
3356 there was an error in the process.
3357 */
3358
3359 static uschar *
3360 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3361 {
3362 uschar *hash_source, *p;
3363 int size = 0,offset = 0,i;
3364 sha1 sha1_base;
3365 void *use_base = &sha1_base;
3366 uschar innerhash[20];
3367 uschar finalhash[20];
3368 uschar innerkey[64];
3369 uschar outerkey[64];
3370 uschar *finalhash_hex = store_get(40);
3371
3372 if (key_num == NULL)
3373 key_num = US"0";
3374
3375 if (Ustrlen(key) > 64)
3376 return NULL;
3377
3378 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3379 string_cat(hash_source,&size,&offset,daystamp,3);
3380 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3381 hash_source[offset] = '\0';
3382
3383 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3384
3385 memset(innerkey, 0x36, 64);
3386 memset(outerkey, 0x5c, 64);
3387
3388 for (i = 0; i < Ustrlen(key); i++)
3389 {
3390 innerkey[i] ^= key[i];
3391 outerkey[i] ^= key[i];
3392 }
3393
3394 chash_start(HMAC_SHA1, use_base);
3395 chash_mid(HMAC_SHA1, use_base, innerkey);
3396 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3397
3398 chash_start(HMAC_SHA1, use_base);
3399 chash_mid(HMAC_SHA1, use_base, outerkey);
3400 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3401
3402 p = finalhash_hex;
3403 for (i = 0; i < 3; i++)
3404 {
3405 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3406 *p++ = hex_digits[finalhash[i] & 0x0f];
3407 }
3408 *p = '\0';
3409
3410 return finalhash_hex;
3411 }
3412
3413
3414
3415
3416 /*************************************************
3417 * Join a file onto the output string *
3418 *************************************************/
3419
3420 /* This is used for readfile and after a run expansion. It joins the contents
3421 of a file onto the output string, globally replacing newlines with a given
3422 string (optionally). The file is closed at the end.
3423
3424 Arguments:
3425 f the FILE
3426 yield pointer to the expandable string
3427 sizep pointer to the current size
3428 ptrp pointer to the current position
3429 eol newline replacement string, or NULL
3430
3431 Returns: new value of string pointer
3432 */
3433
3434 static uschar *
3435 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3436 {
3437 int eollen;
3438 uschar buffer[1024];
3439
3440 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3441
3442 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3443 {
3444 int len = Ustrlen(buffer);
3445 if (eol != NULL && buffer[len-1] == '\n') len--;
3446 yield = string_cat(yield, sizep, ptrp, buffer, len);
3447 if (buffer[len] != 0)
3448 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3449 }
3450
3451 if (yield != NULL) yield[*ptrp] = 0;
3452
3453 return yield;
3454 }
3455
3456
3457
3458
3459 /*************************************************
3460 * Evaluate numeric expression *
3461 *************************************************/
3462
3463 /* This is a set of mutually recursive functions that evaluate an arithmetic
3464 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3465 these functions that is called from elsewhere is eval_expr, whose interface is:
3466
3467 Arguments:
3468 sptr pointer to the pointer to the string - gets updated
3469 decimal TRUE if numbers are to be assumed decimal
3470 error pointer to where to put an error message - must be NULL on input
3471 endket TRUE if ')' must terminate - FALSE for external call
3472
3473 Returns: on success: the value of the expression, with *error still NULL
3474 on failure: an undefined value, with *error = a message
3475 */
3476
3477 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3478
3479
3480 static int_eximarith_t
3481 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3482 {
3483 uschar *s = *sptr;
3484 int_eximarith_t x = eval_op_or(&s, decimal, error);
3485 if (*error == NULL)
3486 {
3487 if (endket)
3488 {
3489 if (*s != ')')
3490 *error = US"expecting closing parenthesis";
3491 else
3492 while (isspace(*(++s)));
3493 }
3494 else if (*s != 0) *error = US"expecting operator";
3495 }
3496 *sptr = s;
3497 return x;
3498 }
3499
3500
3501 static int_eximarith_t
3502 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3503 {
3504 register int c;
3505 int_eximarith_t n;
3506 uschar *s = *sptr;
3507 while (isspace(*s)) s++;
3508 c = *s;
3509 if (isdigit(c))
3510 {
3511 int count;
3512 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3513 s += count;
3514 switch (tolower(*s))
3515 {
3516 default: break;
3517 case 'k': n *= 1024; s++; break;
3518 case 'm': n *= 1024*1024; s++; break;
3519 case 'g': n *= 1024*1024*1024; s++; break;
3520 }
3521 while (isspace (*s)) s++;
3522 }
3523 else if (c == '(')
3524 {
3525 s++;
3526 n = eval_expr(&s, decimal, error, 1);
3527 }
3528 else
3529 {
3530 *error = US"expecting number or opening parenthesis";
3531 n = 0;
3532 }
3533 *sptr = s;
3534 return n;
3535 }
3536
3537
3538 static int_eximarith_t
3539 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3540 {
3541 uschar *s = *sptr;
3542 int_eximarith_t x;
3543 while (isspace(*s)) s++;
3544 if (*s == '+' || *s == '-' || *s == '~')
3545 {
3546 int op = *s++;
3547 x = eval_op_unary(&s, decimal, error);
3548 if (op == '-') x = -x;
3549 else if (op == '~') x = ~x;
3550 }
3551 else
3552 {
3553 x = eval_number(&s, decimal, error);
3554 }
3555 *sptr = s;
3556 return x;
3557 }
3558
3559
3560 static int_eximarith_t
3561 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3562 {
3563 uschar *s = *sptr;
3564 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3565 if (*error == NULL)
3566 {
3567 while (*s == '*' || *s == '/' || *s == '%')
3568 {
3569 int op = *s++;
3570 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3571 if (*error != NULL) break;
3572 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3573 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3574 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3575 * -N*M is INT_MIN will yielf INT_MIN.
3576 * Since we don't support floating point, this is somewhat simpler.
3577 * Ideally, we'd return an error, but since we overflow for all other
3578 * arithmetic, consistency suggests otherwise, but what's the correct value
3579 * to use? There is none.
3580 * The C standard guarantees overflow for unsigned arithmetic but signed
3581 * overflow invokes undefined behaviour; in practice, this is overflow
3582 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3583 * that long/longlong larger than int are available, or we could just work
3584 * with larger types. We should consider whether to guarantee 32bit eval
3585 * and 64-bit working variables, with errors returned. For now ...
3586 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3587 * can just let the other invalid results occur otherwise, as they have
3588 * until now. For this one case, we can coerce.
3589 */
3590 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3591 {
3592 DEBUG(D_expand)
3593 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3594 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3595 x = EXIM_ARITH_MAX;
3596 continue;
3597 }
3598 if (op == '*')
3599 x *= y;
3600 else
3601 {
3602 if (y == 0)
3603 {
3604 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3605 x = 0;
3606 break;
3607 }
3608 if (op == '/')
3609 x /= y;
3610 else
3611 x %= y;
3612 }
3613 }
3614 }
3615 *sptr = s;
3616 return x;
3617 }
3618
3619
3620 static int_eximarith_t
3621 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3622 {
3623 uschar *s = *sptr;
3624 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3625 if (*error == NULL)
3626 {
3627 while (*s == '+' || *s == '-')
3628 {
3629 int op = *s++;
3630 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3631 if (*error != NULL) break;
3632 if (op == '+') x += y; else x -= y;
3633 }
3634 }
3635 *sptr = s;
3636 return x;
3637 }
3638
3639
3640 static int_eximarith_t
3641 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3642 {
3643 uschar *s = *sptr;
3644 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3645 if (*error == NULL)
3646 {
3647 while ((*s == '<' || *s == '>') && s[1] == s[0])
3648 {
3649 int_eximarith_t y;
3650 int op = *s++;
3651 s++;
3652 y = eval_op_sum(&s, decimal, error);
3653 if (*error != NULL) break;
3654 if (op == '<') x <<= y; else x >>= y;
3655 }
3656 }
3657 *sptr = s;
3658 return x;
3659 }
3660
3661
3662 static int_eximarith_t
3663 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3664 {
3665 uschar *s = *sptr;
3666 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3667 if (*error == NULL)
3668 {
3669 while (*s == '&')
3670 {
3671 int_eximarith_t y;
3672 s++;
3673 y = eval_op_shift(&s, decimal, error);
3674 if (*error != NULL) break;
3675 x &= y;
3676 }
3677 }
3678 *sptr = s;
3679 return x;
3680 }
3681
3682
3683 static int_eximarith_t
3684 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3685 {
3686 uschar *s = *sptr;
3687 int_eximarith_t x = eval_op_and(&s, decimal, error);
3688 if (*error == NULL)
3689 {
3690 while (*s == '^')
3691 {
3692 int_eximarith_t y;
3693 s++;
3694 y = eval_op_and(&s, decimal, error);
3695 if (*error != NULL) break;
3696 x ^= y;
3697 }
3698 }
3699 *sptr = s;
3700 return x;
3701 }
3702
3703
3704 static int_eximarith_t
3705 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3706 {
3707 uschar *s = *sptr;
3708 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3709 if (*error == NULL)
3710 {
3711 while (*s == '|')
3712 {
3713 int_eximarith_t y;
3714 s++;
3715 y = eval_op_xor(&s, decimal, error);
3716 if (*error != NULL) break;
3717 x |= y;
3718 }
3719 }
3720 *sptr = s;
3721 return x;
3722 }
3723
3724
3725
3726 /*************************************************
3727 * Expand string *
3728 *************************************************/
3729
3730 /* Returns either an unchanged string, or the expanded string in stacking pool
3731 store. Interpreted sequences are:
3732
3733 \... normal escaping rules
3734 $name substitutes the variable
3735 ${name} ditto
3736 ${op:string} operates on the expanded string value
3737 ${item{arg1}{arg2}...} expands the args and then does the business
3738 some literal args are not enclosed in {}
3739
3740 There are now far too many operators and item types to make it worth listing
3741 them here in detail any more.
3742
3743 We use an internal routine recursively to handle embedded substrings. The
3744 external function follows. The yield is NULL if the expansion failed, and there
3745 are two cases: if something collapsed syntactically, or if "fail" was given
3746 as the action on a lookup failure. These can be distinguised by looking at the
3747 variable expand_string_forcedfail, which is TRUE in the latter case.
3748
3749 The skipping flag is set true when expanding a substring that isn't actually
3750 going to be used (after "if" or "lookup") and it prevents lookups from
3751 happening lower down.
3752
3753 Store usage: At start, a store block of the length of the input plus 64
3754 is obtained. This is expanded as necessary by string_cat(), which might have to
3755 get a new block, or might be able to expand the original. At the end of the
3756 function we can release any store above that portion of the yield block that
3757 was actually used. In many cases this will be optimal.
3758
3759 However: if the first item in the expansion is a variable name or header name,
3760 we reset the store before processing it; if the result is in fresh store, we
3761 use that without copying. This is helpful for expanding strings like
3762 $message_headers which can get very long.
3763
3764 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3765 since resetting the store at the end of the expansion will free store that was
3766 allocated by the plugin code as well as the slop after the expanded string. So
3767 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3768 and, given the acl condition, ${if }. This is an unfortunate consequence of
3769 string expansion becoming too powerful.
3770
3771 Arguments:
3772 string the string to be expanded
3773 ket_ends true if expansion is to stop at }
3774 left if not NULL, a pointer to the first character after the
3775 expansion is placed here (typically used with ket_ends)
3776 skipping TRUE for recursive calls when the value isn't actually going
3777 to be used (to allow for optimisation)
3778 honour_dollar TRUE if $ is to be expanded,
3779 FALSE if it's just another character
3780 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3781 the store.
3782
3783 Returns: NULL if expansion fails:
3784 expand_string_forcedfail is set TRUE if failure was forced
3785 expand_string_message contains a textual error message
3786 a pointer to the expanded string on success
3787 */
3788
3789 static uschar *
3790 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3791 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3792 {
3793 int ptr = 0;
3794 int size = Ustrlen(string)+ 64;
3795 int item_type;
3796 uschar *yield = store_get(size);
3797 const uschar *s = string;
3798 uschar *save_expand_nstring[EXPAND_MAXN+1];
3799 int save_expand_nlength[EXPAND_MAXN+1];
3800 BOOL resetok = TRUE;
3801
3802 expand_string_forcedfail = FALSE;
3803 expand_string_message = US"";
3804
3805 while (*s != 0)
3806 {
3807 uschar *value;
3808 uschar name[256];
3809
3810 /* \ escapes the next character, which must exist, or else
3811 the expansion fails. There's a special escape, \N, which causes
3812 copying of the subject verbatim up to the next \N. Otherwise,
3813 the escapes are the standard set. */
3814
3815 if (*s == '\\')
3816 {
3817 if (s[1] == 0)
3818 {
3819 expand_string_message = US"\\ at end of string";
3820 goto EXPAND_FAILED;
3821 }
3822
3823 if (s[1] == 'N')
3824 {
3825 const uschar * t = s + 2;
3826 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3827 yield = string_cat(yield, &size, &ptr, t, s - t);
3828 if (*s != 0) s += 2;
3829 }
3830
3831 else
3832 {
3833 uschar ch[1];
3834 ch[0] = string_interpret_escape(&s);
3835 s++;
3836 yield = string_cat(yield, &size, &ptr, ch, 1);
3837 }
3838
3839 continue;
3840 }
3841
3842 /*{*/
3843 /* Anything other than $ is just copied verbatim, unless we are
3844 looking for a terminating } character. */
3845
3846 /*{*/
3847 if (ket_ends && *s == '}') break;
3848
3849 if (*s != '$' || !honour_dollar)
3850 {
3851 yield = string_cat(yield, &size, &ptr, s++, 1);
3852 continue;
3853 }
3854
3855 /* No { after the $ - must be a plain name or a number for string
3856 match variable. There has to be a fudge for variables that are the
3857 names of header fields preceded by "$header_" because header field
3858 names can contain any printing characters except space and colon.
3859 For those that don't like typing this much, "$h_" is a synonym for
3860 "$header_". A non-existent header yields a NULL value; nothing is
3861 inserted. */ /*}*/
3862
3863 if (isalpha((*(++s))))
3864 {
3865 int len;
3866 int newsize = 0;
3867
3868 s = read_name(name, sizeof(name), s, US"_");
3869
3870 /* If this is the first thing to be expanded, release the pre-allocated
3871 buffer. */
3872
3873 if (ptr == 0 && yield != NULL)
3874 {
3875 if (resetok) store_reset(yield);
3876 yield = NULL;
3877 size = 0;
3878 }
3879
3880 /* Header */
3881
3882 if (Ustrncmp(name, "h_", 2) == 0 ||
3883 Ustrncmp(name, "rh_", 3) == 0 ||
3884 Ustrncmp(name, "bh_", 3) == 0 ||
3885 Ustrncmp(name, "header_", 7) == 0 ||
3886 Ustrncmp(name, "rheader_", 8) == 0 ||
3887 Ustrncmp(name, "bheader_", 8) == 0)
3888 {
3889 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3890 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3891 s = read_header_name(name, sizeof(name), s);
3892 value = find_header(name, FALSE, &newsize, want_raw, charset);
3893
3894 /* If we didn't find the header, and the header contains a closing brace
3895 character, this may be a user error where the terminating colon
3896 has been omitted. Set a flag to adjust the error message in this case.
3897 But there is no error here - nothing gets inserted. */
3898
3899 if (value == NULL)
3900 {
3901 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3902 continue;
3903 }
3904 }
3905
3906 /* Variable */
3907
3908 else
3909 {
3910 value = find_variable(name, FALSE, skipping, &newsize);
3911 if (value == NULL)
3912 {
3913 expand_string_message =
3914 string_sprintf("unknown variable name \"%s\"", name);
3915 check_variable_error_message(name);
3916 goto EXPAND_FAILED;
3917 }
3918 }
3919
3920 /* If the data is known to be in a new buffer, newsize will be set to the
3921 size of that buffer. If this is the first thing in an expansion string,
3922 yield will be NULL; just point it at the new store instead of copying. Many
3923 expansion strings contain just one reference, so this is a useful
3924 optimization, especially for humungous headers. */
3925
3926 len = Ustrlen(value);
3927 if (yield == NULL && newsize != 0)
3928 {
3929 yield = value;
3930 size = newsize;
3931 ptr = len;
3932 }
3933 else yield = string_cat(yield, &size, &ptr, value, len);
3934
3935 continue;
3936 }
3937
3938 if (isdigit(*s))
3939 {
3940 int n;
3941 s = read_cnumber(&n, s);
3942 if (n >= 0 && n <= expand_nmax)
3943 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3944 expand_nlength[n]);
3945 continue;
3946 }
3947
3948 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3949
3950 if (*s != '{') /*}*/
3951 {
3952 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3953 goto EXPAND_FAILED;
3954 }
3955
3956 /* After { there can be various things, but they all start with
3957 an initial word, except for a number for a string match variable. */
3958
3959 if (isdigit((*(++s))))
3960 {
3961 int n;
3962 s = read_cnumber(&n, s); /*{*/
3963 if (*s++ != '}')
3964 { /*{*/
3965 expand_string_message = US"} expected after number";
3966 goto EXPAND_FAILED;
3967 }
3968 if (n >= 0 && n <= expand_nmax)
3969 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3970 expand_nlength[n]);
3971 continue;
3972 }
3973
3974 if (!isalpha(*s))
3975 {
3976 expand_string_message = US"letter or digit expected after ${"; /*}*/
3977 goto EXPAND_FAILED;
3978 }
3979
3980 /* Allow "-" in names to cater for substrings with negative
3981 arguments. Since we are checking for known names after { this is
3982 OK. */
3983
3984 s = read_name(name, sizeof(name), s, US"_-");
3985 item_type = chop_match(name, item_table, nelem(item_table));
3986
3987 switch(item_type)
3988 {
3989 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3990 If the ACL returns accept or reject we return content set by "message ="
3991 There is currently no limit on recursion; this would have us call
3992 acl_check_internal() directly and get a current level from somewhere.
3993 See also the acl expansion condition ECOND_ACL and the traditional
3994 acl modifier ACLC_ACL.
3995 Assume that the function has side-effects on the store that must be preserved.
3996 */
3997
3998 case EITEM_ACL:
3999 /* ${acl {name} {arg1}{arg2}...} */
4000 {
4001 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4002 uschar *user_msg;
4003
4004 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl", &resetok))
4005 {
4006 case 1: goto EXPAND_FAILED_CURLY;
4007 case 2:
4008 case 3: goto EXPAND_FAILED;
4009 }
4010 if (skipping) continue;
4011
4012 resetok = FALSE;
4013 switch(eval_acl(sub, nelem(sub), &user_msg))
4014 {
4015 case OK:
4016 case FAIL:
4017 DEBUG(D_expand)
4018 debug_printf("acl expansion yield: %s\n", user_msg);
4019 if (user_msg)
4020 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
4021 continue;
4022
4023 case DEFER:
4024 expand_string_forcedfail = TRUE;
4025 default:
4026 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4027 goto EXPAND_FAILED;
4028 }
4029 }
4030
4031 /* Handle conditionals - preserve the values of the numerical expansion
4032 variables in case they get changed by a regular expression match in the
4033 condition. If not, they retain their external settings. At the end
4034 of this "if" section, they get restored to their previous values. */
4035
4036 case EITEM_IF:
4037 {
4038 BOOL cond = FALSE;
4039 const uschar *next_s;
4040 int save_expand_nmax =
4041 save_expand_strings(save_expand_nstring, save_expand_nlength);
4042
4043 while (isspace(*s)) s++;
4044 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
4045 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4046
4047 DEBUG(D_expand)
4048 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
4049 cond? "true" : "false");
4050
4051 s = next_s;
4052
4053 /* The handling of "yes" and "no" result strings is now in a separate
4054 function that is also used by ${lookup} and ${extract} and ${run}. */
4055
4056 switch(process_yesno(
4057 skipping, /* were previously skipping */
4058 cond, /* success/failure indicator */
4059 lookup_value, /* value to reset for string2 */
4060 &s, /* input pointer */
4061 &yield, /* output pointer */
4062 &size, /* output size */
4063 &ptr, /* output current point */
4064 US"if", /* condition type */
4065 &resetok))
4066 {
4067 case 1: goto EXPAND_FAILED; /* when all is well, the */
4068 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4069 }
4070
4071 /* Restore external setting of expansion variables for continuation
4072 at this level. */
4073
4074 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4075 save_expand_nlength);
4076 continue;
4077 }
4078
4079 #ifdef EXPERIMENTAL_INTERNATIONAL
4080 case EITEM_IMAPFOLDER:
4081 { /* ${imapfolder {name}{sep]{specials}} */
4082 uschar *sub_arg[3];
4083 uschar *encoded;
4084
4085 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4086 &resetok))
4087 {
4088 case 1: goto EXPAND_FAILED_CURLY;
4089 case 2:
4090 case 3: goto EXPAND_FAILED;
4091 }
4092
4093 if (sub_arg[1] == NULL) /* One argument */
4094 {
4095 sub_arg[1] = US"/"; /* default separator */
4096 sub_arg[2] = NULL;
4097 }
4098 else if (Ustrlen(sub_arg[1]) != 1)
4099 {
4100 expand_string_message =
4101 string_sprintf(
4102 "IMAP folder separator must be one character, found \"%s\"",
4103 sub_arg[1]);
4104 goto EXPAND_FAILED;
4105 }
4106
4107 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4108 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4109 goto EXPAND_FAILED;
4110 if (!skipping)
4111 yield = string_cat(yield, &size, &ptr, encoded, Ustrlen(encoded));
4112 continue;
4113 }
4114 #endif
4115
4116 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4117 expanding an internal string that isn't actually going to be used. All we
4118 need to do is check the syntax, so don't do a lookup at all. Preserve the
4119 values of the numerical expansion variables in case they get changed by a
4120 partial lookup. If not, they retain their external settings. At the end
4121 of this "lookup" section, they get restored to their previous values. */
4122
4123 case EITEM_LOOKUP:
4124 {
4125 int stype, partial, affixlen, starflags;
4126 int expand_setup = 0;
4127 int nameptr = 0;
4128 uschar *key, *filename;
4129 const uschar *affix;
4130 uschar *save_lookup_value = lookup_value;
4131 int save_expand_nmax =
4132 save_expand_strings(save_expand_nstring, save_expand_nlength);
4133
4134 if ((expand_forbid & RDO_LOOKUP) != 0)
4135 {
4136 expand_string_message = US"lookup expansions are not permitted";
4137 goto EXPAND_FAILED;
4138 }
4139
4140 /* Get the key we are to look up for single-key+file style lookups.
4141 Otherwise set the key NULL pro-tem. */
4142
4143 while (isspace(*s)) s++;
4144 if (*s == '{') /*}*/
4145 {
4146 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4147 if (key == NULL) goto EXPAND_FAILED; /*{*/
4148 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4149 while (isspace(*s)) s++;
4150 }
4151 else key = NULL;
4152
4153 /* Find out the type of database */
4154
4155 if (!isalpha(*s))
4156 {
4157 expand_string_message = US"missing lookup type";
4158 goto EXPAND_FAILED;
4159 }
4160
4161 /* The type is a string that may contain special characters of various
4162 kinds. Allow everything except space or { to appear; the actual content
4163 is checked by search_findtype_partial. */ /*}*/
4164
4165 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4166 {
4167 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4168 s++;
4169 }
4170 name[nameptr] = 0;
4171 while (isspace(*s)) s++;
4172
4173 /* Now check for the individual search type and any partial or default
4174 options. Only those types that are actually in the binary are valid. */
4175
4176 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4177 &starflags);
4178 if (stype < 0)
4179 {
4180 expand_string_message = search_error_message;
4181 goto EXPAND_FAILED;
4182 }
4183
4184 /* Check that a key was provided for those lookup types that need it,
4185 and was not supplied for those that use the query style. */
4186
4187 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4188 {
4189 if (key == NULL)
4190 {
4191 expand_string_message = string_sprintf("missing {key} for single-"
4192 "key \"%s\" lookup", name);
4193 goto EXPAND_FAILED;
4194 }
4195 }
4196 else
4197 {
4198 if (key != NULL)
4199 {
4200 expand_string_message = string_sprintf("a single key was given for "
4201 "lookup type \"%s\", which is not a single-key lookup type", name);
4202 goto EXPAND_FAILED;
4203 }
4204 }
4205
4206 /* Get the next string in brackets and expand it. It is the file name for
4207 single-key+file lookups, and the whole query otherwise. In the case of
4208 queries that also require a file name (e.g. sqlite), the file name comes
4209 first. */
4210
4211 if (*s != '{') goto EXPAND_FAILED_CURLY;
4212 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4213 if (filename == NULL) goto EXPAND_FAILED;
4214 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4215 while (isspace(*s)) s++;
4216
4217 /* If this isn't a single-key+file lookup, re-arrange the variables
4218 to be appropriate for the search_ functions. For query-style lookups,
4219 there is just a "key", and no file name. For the special query-style +
4220 file types, the query (i.e. "key") starts with a file name. */
4221
4222 if (key == NULL)
4223 {
4224 while (isspace(*filename)) filename++;
4225 key = filename;
4226
4227 if (mac_islookup(stype, lookup_querystyle))
4228 {
4229 filename = NULL;
4230 }
4231 else
4232 {
4233 if (*filename != '/')
4234 {
4235 expand_string_message = string_sprintf(
4236 "absolute file name expected for \"%s\" lookup", name);
4237 goto EXPAND_FAILED;
4238 }
4239 while (*key != 0 && !isspace(*key)) key++;
4240 if (*key != 0) *key++ = 0;
4241 }
4242 }
4243
4244 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4245 the entry was not found. Note that there is no search_close() function.
4246 Files are left open in case of re-use. At suitable places in higher logic,
4247 search_tidyup() is called to tidy all open files. This can save opening
4248 the same file several times. However, files may also get closed when
4249 others are opened, if too many are open at once. The rule is that a
4250 handle should not be used after a second search_open().
4251
4252 Request that a partial search sets up $1 and maybe $2 by passing
4253 expand_setup containing zero. If its value changes, reset expand_nmax,
4254 since new variables will have been set. Note that at the end of this
4255 "lookup" section, the old numeric variables are restored. */
4256
4257 if (skipping)
4258 lookup_value = NULL;
4259 else
4260 {
4261 void *handle = search_open(filename, stype, 0, NULL, NULL);
4262 if (handle == NULL)
4263 {
4264 expand_string_message = search_error_message;
4265 goto EXPAND_FAILED;
4266 }
4267 lookup_value = search_find(handle, filename, key, partial, affix,
4268 affixlen, starflags, &expand_setup);
4269 if (search_find_defer)
4270 {
4271 expand_string_message =
4272 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4273 string_printing2(key, FALSE), search_error_message);
4274 goto EXPAND_FAILED;
4275 }
4276 if (expand_setup > 0) expand_nmax = expand_setup;
4277 }
4278
4279 /* The handling of "yes" and "no" result strings is now in a separate
4280 function that is also used by ${if} and ${extract}. */
4281
4282 switch(process_yesno(
4283 skipping, /* were previously skipping */
4284 lookup_value != NULL, /* success/failure indicator */
4285 save_lookup_value, /* value to reset for string2 */
4286 &s, /* input pointer */
4287 &yield, /* output pointer */
4288 &size, /* output size */
4289 &ptr, /* output current point */
4290 US"lookup", /* condition type */
4291 &resetok))
4292 {
4293 case 1: goto EXPAND_FAILED; /* when all is well, the */
4294 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4295 }
4296
4297 /* Restore external setting of expansion variables for carrying on
4298 at this level, and continue. */
4299
4300 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4301 save_expand_nlength);
4302 continue;
4303 }
4304
4305 /* If Perl support is configured, handle calling embedded perl subroutines,
4306 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4307 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4308 arguments (defined below). */
4309
4310 #define EXIM_PERL_MAX_ARGS 8
4311
4312 case EITEM_PERL:
4313 #ifndef EXIM_PERL
4314 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4315 "is not included in this binary";
4316 goto EXPAND_FAILED;
4317
4318 #else /* EXIM_PERL */
4319 {
4320 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4321 uschar *new_yield;
4322
4323 if ((expand_forbid & RDO_PERL) != 0)
4324 {
4325 expand_string_message = US"Perl calls are not permitted";
4326 goto EXPAND_FAILED;
4327 }
4328
4329 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4330 US"perl", &resetok))
4331 {
4332 case 1: goto EXPAND_FAILED_CURLY;
4333 case 2:
4334 case 3: goto EXPAND_FAILED;
4335 }
4336
4337 /* If skipping, we don't actually do anything */
4338
4339 if (skipping) continue;
4340
4341 /* Start the interpreter if necessary */
4342
4343 if (!opt_perl_started)
4344 {
4345 uschar *initerror;
4346 if (opt_perl_startup == NULL)
4347 {
4348 expand_string_message = US"A setting of perl_startup is needed when "
4349 "using the Perl interpreter";
4350 goto EXPAND_FAILED;
4351 }
4352 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4353 initerror = init_perl(opt_perl_startup);
4354 if (initerror != NULL)
4355 {
4356 expand_string_message =
4357 string_sprintf("error in perl_startup code: %s\n", initerror);
4358 goto EXPAND_FAILED;
4359 }
4360 opt_perl_started = TRUE;
4361 }
4362
4363 /* Call the function */
4364
4365 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4366 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4367 sub_arg[0], sub_arg + 1);
4368
4369 /* NULL yield indicates failure; if the message pointer has been set to
4370 NULL, the yield was undef, indicating a forced failure. Otherwise the
4371 message will indicate some kind of Perl error. */
4372
4373 if (new_yield == NULL)
4374 {
4375 if (expand_string_message == NULL)
4376 {
4377 expand_string_message =
4378 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4379 "failure", sub_arg[0]);
4380 expand_string_forcedfail = TRUE;
4381 }
4382 goto EXPAND_FAILED;
4383 }
4384
4385 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4386 set during a callback from Perl. */
4387
4388 expand_string_forcedfail = FALSE;
4389 yield = new_yield;
4390 continue;
4391 }
4392 #endif /* EXIM_PERL */
4393
4394 /* Transform email address to "prvs" scheme to use
4395 as BATV-signed return path */
4396
4397 case EITEM_PRVS:
4398 {
4399 uschar *sub_arg[3];
4400 uschar *p,*domain;
4401
4402 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4403 {
4404 case 1: goto EXPAND_FAILED_CURLY;
4405 case 2:
4406 case 3: goto EXPAND_FAILED;
4407 }
4408
4409 /* If skipping, we don't actually do anything */
4410 if (skipping) continue;
4411
4412 /* sub_arg[0] is the address */
4413 domain = Ustrrchr(sub_arg[0],'@');
4414 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4415 {
4416 expand_string_message = US"prvs first argument must be a qualified email address";
4417 goto EXPAND_FAILED;
4418 }
4419
4420 /* Calculate the hash. The second argument must be a single-digit
4421 key number, or unset. */
4422
4423 if (sub_arg[2] != NULL &&
4424 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4425 {
4426 expand_string_message = US"prvs second argument must be a single digit";
4427 goto EXPAND_FAILED;
4428 }
4429
4430 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4431 if (p == NULL)
4432 {
4433 expand_string_message = US"prvs hmac-sha1 conversion failed";
4434 goto EXPAND_FAILED;
4435 }
4436
4437 /* Now separate the domain from the local part */
4438 *domain++ = '\0';
4439
4440 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4441 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4442 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4443 string_cat(yield,&size,&ptr,p,6);
4444 string_cat(yield,&size,&ptr,US"=",1);
4445 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4446 string_cat(yield,&size,&ptr,US"@",1);
4447 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4448
4449 continue;
4450 }
4451
4452 /* Check a prvs-encoded address for validity */
4453
4454 case EITEM_PRVSCHECK:
4455 {
4456 uschar *sub_arg[3];
4457 int mysize = 0, myptr = 0;
4458 const pcre *re;
4459 uschar *p;
4460
4461 /* TF: Ugliness: We want to expand parameter 1 first, then set
4462 up expansion variables that are used in the expansion of
4463 parameter 2. So we clone the string for the first
4464 expansion, where we only expand parameter 1.
4465
4466 PH: Actually, that isn't necessary. The read_subs() function is
4467 designed to work this way for the ${if and ${lookup expansions. I've
4468 tidied the code.
4469 */
4470
4471 /* Reset expansion variables */
4472 prvscheck_result = NULL;
4473 prvscheck_address = NULL;
4474 prvscheck_keynum = NULL;
4475
4476 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4477 {
4478 case 1: goto EXPAND_FAILED_CURLY;
4479 case 2:
4480 case 3: goto EXPAND_FAILED;
4481 }
4482
4483 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4484 TRUE,FALSE);
4485
4486 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4487 {
4488 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4489 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4490 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4491 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4492 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4493
4494 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4495 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4496 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4497 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4498 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4499
4500 /* Set up expansion variables */
4501 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4502 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4503 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4504 prvscheck_address[myptr] = '\0';
4505 prvscheck_keynum = string_copy(key_num);
4506
4507 /* Now expand the second argument */
4508 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4509 {
4510 case 1: goto EXPAND_FAILED_CURLY;
4511 case 2:
4512 case 3: goto EXPAND_FAILED;
4513 }
4514
4515 /* Now we have the key and can check the address. */
4516
4517 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4518 daystamp);
4519
4520 if (p == NULL)
4521 {
4522 expand_string_message = US"hmac-sha1 conversion failed";
4523 goto EXPAND_FAILED;
4524 }
4525
4526 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4527 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4528
4529 if (Ustrcmp(p,hash) == 0)
4530 {
4531 /* Success, valid BATV address. Now check the expiry date. */
4532 uschar *now = prvs_daystamp(0);
4533 unsigned int inow = 0,iexpire = 1;
4534
4535 (void)sscanf(CS now,"%u",&inow);
4536 (void)sscanf(CS daystamp,"%u",&iexpire);
4537
4538 /* When "iexpire" is < 7, a "flip" has occured.
4539 Adjust "inow" accordingly. */
4540 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4541
4542 if (iexpire >= inow)
4543 {
4544 prvscheck_result = US"1";
4545 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4546 }
4547 else
4548 {
4549 prvscheck_result = NULL;
4550 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4551 }
4552 }
4553 else
4554 {
4555 prvscheck_result = NULL;
4556 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4557 }
4558
4559 /* Now expand the final argument. We leave this till now so that
4560 it can include $prvscheck_result. */
4561
4562 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4563 {
4564 case 1: goto EXPAND_FAILED_CURLY;
4565 case 2:
4566 case 3: goto EXPAND_FAILED;
4567 }
4568
4569 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4570 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4571 else
4572 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4573
4574 /* Reset the "internal" variables afterwards, because they are in
4575 dynamic store that will be reclaimed if the expansion succeeded. */
4576
4577 prvscheck_address = NULL;
4578 prvscheck_keynum = NULL;
4579 }
4580 else
4581 {
4582 /* Does not look like a prvs encoded address, return the empty string.
4583 We need to make sure all subs are expanded first, so as to skip over
4584 the entire item. */
4585
4586 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4587 {
4588 case 1: goto EXPAND_FAILED_CURLY;
4589 case 2:
4590 case 3: goto EXPAND_FAILED;
4591 }
4592 }
4593
4594 continue;
4595 }
4596
4597 /* Handle "readfile" to insert an entire file */
4598
4599 case EITEM_READFILE:
4600 {
4601 FILE *f;
4602 uschar *sub_arg[2];
4603
4604 if ((expand_forbid & RDO_READFILE) != 0)
4605 {
4606 expand_string_message = US"file insertions are not permitted";
4607 goto EXPAND_FAILED;
4608 }
4609
4610 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4611 {
4612 case 1: goto EXPAND_FAILED_CURLY;
4613 case 2:
4614 case 3: goto EXPAND_FAILED;
4615 }
4616
4617 /* If skipping, we don't actually do anything */
4618
4619 if (skipping) continue;
4620
4621 /* Open the file and read it */
4622
4623 f = Ufopen(sub_arg[0], "rb");
4624 if (f == NULL)
4625 {
4626 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4627 goto EXPAND_FAILED;
4628 }
4629
4630 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4631 (void)fclose(f);
4632 continue;
4633 }
4634
4635 /* Handle "readsocket" to insert data from a Unix domain socket */
4636
4637 case EITEM_READSOCK:
4638 {
4639 int fd;
4640 int timeout = 5;
4641 int save_ptr = ptr;
4642 FILE *f;
4643 struct sockaddr_un sockun; /* don't call this "sun" ! */
4644 uschar *arg;
4645 uschar *sub_arg[4];
4646
4647 if ((expand_forbid & RDO_READSOCK) != 0)
4648 {
4649 expand_string_message = US"socket insertions are not permitted";
4650 goto EXPAND_FAILED;
4651 }
4652
4653 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4654 because there may be a string for expansion on failure. */
4655
4656 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4657 {
4658 case 1: goto EXPAND_FAILED_CURLY;
4659 case 2: /* Won't occur: no end check */
4660 case 3: goto EXPAND_FAILED;
4661 }
4662
4663 /* Sort out timeout, if given */
4664
4665 if (sub_arg[2] != NULL)
4666 {
4667 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4668 if (timeout < 0)
4669 {
4670 expand_string_message = string_sprintf("bad time value %s",
4671 sub_arg[2]);
4672 goto EXPAND_FAILED;
4673 }
4674 }
4675 else sub_arg[3] = NULL; /* No eol if no timeout */
4676
4677 /* If skipping, we don't actually do anything. Otherwise, arrange to
4678 connect to either an IP or a Unix socket. */
4679
4680 if (!skipping)
4681 {
4682 /* Handle an IP (internet) domain */
4683
4684 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4685 {
4686 int port;
4687 uschar *server_name = sub_arg[0] + 5;
4688 uschar *port_name = Ustrrchr(server_name, ':');
4689
4690 /* Sort out the port */
4691
4692 if (port_name == NULL)
4693 {
4694 expand_string_message =
4695 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4696 goto EXPAND_FAILED;
4697 }
4698 *port_name++ = 0; /* Terminate server name */
4699
4700 if (isdigit(*port_name))
4701 {
4702 uschar *end;
4703 port = Ustrtol(port_name, &end, 0);
4704 if (end != port_name + Ustrlen(port_name))
4705 {
4706 expand_string_message =
4707 string_sprintf("invalid port number %s", port_name);
4708 goto EXPAND_FAILED;
4709 }
4710 }
4711 else
4712 {
4713 struct servent *service_info = getservbyname(CS port_name, "tcp");
4714 if (service_info == NULL)
4715 {
4716 expand_string_message = string_sprintf("unknown port \"%s\"",
4717 port_name);
4718 goto EXPAND_FAILED;
4719 }
4720 port = ntohs(service_info->s_port);
4721 }
4722
4723 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4724 timeout, NULL, &expand_string_message)) < 0)
4725 goto SOCK_FAIL;
4726 }
4727
4728 /* Handle a Unix domain socket */
4729
4730 else
4731 {
4732 int rc;
4733 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4734 {
4735 expand_string_message = string_sprintf("failed to create socket: %s",
4736 strerror(errno));
4737 goto SOCK_FAIL;
4738 }
4739
4740 sockun.sun_family = AF_UNIX;
4741 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4742 sub_arg[0]);
4743
4744 sigalrm_seen = FALSE;
4745 alarm(timeout);
4746 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4747 alarm(0);
4748 if (sigalrm_seen)
4749 {
4750 expand_string_message = US "socket connect timed out";
4751 goto SOCK_FAIL;
4752 }
4753 if (rc < 0)
4754 {
4755 expand_string_message = string_sprintf("failed to connect to socket "
4756 "%s: %s", sub_arg[0], strerror(errno));
4757 goto SOCK_FAIL;
4758 }
4759 }
4760
4761 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4762
4763 /* Allow sequencing of test actions */
4764 if (running_in_test_harness) millisleep(100);
4765
4766 /* Write the request string, if not empty */
4767
4768 if (sub_arg[1][0] != 0)
4769 {
4770 int len = Ustrlen(sub_arg[1]);
4771 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4772 sub_arg[1]);
4773 if (write(fd, sub_arg[1], len) != len)
4774 {
4775 expand_string_message = string_sprintf("request write to socket "
4776 "failed: %s", strerror(errno));
4777 goto SOCK_FAIL;
4778 }
4779 }
4780
4781 /* Shut down the sending side of the socket. This helps some servers to
4782 recognise that it is their turn to do some work. Just in case some
4783 system doesn't have this function, make it conditional. */
4784
4785 #ifdef SHUT_WR
4786 shutdown(fd, SHUT_WR);
4787 #endif
4788
4789 if (running_in_test_harness) millisleep(100);
4790
4791 /* Now we need to read from the socket, under a timeout. The function
4792 that reads a file can be used. */
4793
4794 f = fdopen(fd, "rb");
4795 sigalrm_seen = FALSE;
4796 alarm(timeout);
4797 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4798 alarm(0);
4799 (void)fclose(f);
4800
4801 /* After a timeout, we restore the pointer in the result, that is,
4802 make sure we add nothing from the socket. */
4803
4804 if (sigalrm_seen)
4805 {
4806 ptr = save_ptr;
4807 expand_string_message = US "socket read timed out";
4808 goto SOCK_FAIL;
4809 }
4810 }
4811
4812 /* The whole thing has worked (or we were skipping). If there is a
4813 failure string following, we need to skip it. */
4814
4815 if (*s == '{')
4816 {
4817 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4818 goto EXPAND_FAILED;
4819 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4820 while (isspace(*s)) s++;
4821 }
4822 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4823 continue;
4824
4825 /* Come here on failure to create socket, connect socket, write to the
4826 socket, or timeout on reading. If another substring follows, expand and
4827 use it. Otherwise, those conditions give expand errors. */
4828
4829 SOCK_FAIL:
4830 if (*s != '{') goto EXPAND_FAILED;
4831 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4832 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4833 if (arg == NULL) goto EXPAND_FAILED;
4834 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4835 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4836 while (isspace(*s)) s++;
4837 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4838 continue;
4839 }
4840
4841 /* Handle "run" to execute a program. */
4842
4843 case EITEM_RUN:
4844 {
4845 FILE *f;
4846 uschar *arg;
4847 const uschar **argv;
4848 pid_t pid;
4849 int fd_in, fd_out;
4850 int lsize = 0;
4851 int lptr = 0;
4852
4853 if ((expand_forbid & RDO_RUN) != 0)
4854 {
4855 expand_string_message = US"running a command is not permitted";
4856 goto EXPAND_FAILED;
4857 }
4858
4859 while (isspace(*s)) s++;
4860 if (*s != '{') goto EXPAND_FAILED_CURLY;
4861 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4862 if (arg == NULL) goto EXPAND_FAILED;
4863 while (isspace(*s)) s++;
4864 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4865
4866 if (skipping) /* Just pretend it worked when we're skipping */
4867 {
4868 runrc = 0;
4869 }
4870 else
4871 {
4872 if (!transport_set_up_command(&argv, /* anchor for arg list */
4873 arg, /* raw command */
4874 FALSE, /* don't expand the arguments */
4875 0, /* not relevant when... */
4876 NULL, /* no transporting address */
4877 US"${run} expansion", /* for error messages */
4878 &expand_string_message)) /* where to put error message */
4879 {
4880 goto EXPAND_FAILED;
4881 }
4882
4883 /* Create the child process, making it a group leader. */
4884
4885 pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4886
4887 if (pid < 0)
4888 {
4889 expand_string_message =
4890 string_sprintf("couldn't create child process: %s", strerror(errno));
4891 goto EXPAND_FAILED;
4892 }
4893
4894 /* Nothing is written to the standard input. */
4895
4896 (void)close(fd_in);
4897
4898 /* Read the pipe to get the command's output into $value (which is kept
4899 in lookup_value). Read during execution, so that if the output exceeds
4900 the OS pipe buffer limit, we don't block forever. */
4901
4902 f = fdopen(fd_out, "rb");
4903 sigalrm_seen = FALSE;
4904 alarm(60);
4905 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4906 alarm(0);
4907 (void)fclose(f);
4908
4909 /* Wait for the process to finish, applying the timeout, and inspect its
4910 return code for serious disasters. Simple non-zero returns are passed on.
4911 */
4912
4913 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4914 {
4915 if (sigalrm_seen == TRUE || runrc == -256)
4916 {
4917 expand_string_message = string_sprintf("command timed out");
4918 killpg(pid, SIGKILL); /* Kill the whole process group */
4919 }
4920
4921 else if (runrc == -257)
4922 expand_string_message = string_sprintf("wait() failed: %s",
4923 strerror(errno));
4924
4925 else
4926 expand_string_message = string_sprintf("command killed by signal %d",
4927 -runrc);
4928
4929 goto EXPAND_FAILED;
4930 }
4931 }
4932
4933 /* Process the yes/no strings; $value may be useful in both cases */
4934
4935 switch(process_yesno(
4936 skipping, /* were previously skipping */
4937 runrc == 0, /* success/failure indicator */
4938 lookup_value, /* value to reset for string2 */
4939 &s, /* input pointer */
4940 &yield, /* output pointer */
4941 &size, /* output size */
4942 &ptr, /* output current point */
4943 US"run", /* condition type */
4944 &resetok))
4945 {
4946 case 1: goto EXPAND_FAILED; /* when all is well, the */
4947 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4948 }
4949
4950 continue;
4951 }
4952
4953 /* Handle character translation for "tr" */
4954
4955 case EITEM_TR:
4956 {
4957 int oldptr = ptr;
4958 int o2m;
4959 uschar *sub[3];
4960
4961 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4962 {
4963 case 1: goto EXPAND_FAILED_CURLY;
4964 case 2:
4965 case 3: goto EXPAND_FAILED;
4966 }
4967
4968 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4969 o2m = Ustrlen(sub[2]) - 1;
4970
4971 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4972 {
4973 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4974 if (m != NULL)
4975 {
4976 int o = m - sub[1];
4977 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4978 }
4979 }
4980
4981 continue;
4982 }
4983
4984 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4985 expanded arguments. */
4986
4987 case EITEM_HASH:
4988 case EITEM_LENGTH:
4989 case EITEM_NHASH:
4990 case EITEM_SUBSTR:
4991 {
4992 int i;
4993 int len;
4994 uschar *ret;
4995 int val[2] = { 0, -1 };
4996 uschar *sub[3];
4997
4998 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4999 Ensure that sub[2] is set in the ${length } case. */
5000
5001 sub[2] = NULL;
5002 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5003 TRUE, name, &resetok))
5004 {
5005 case 1: goto EXPAND_FAILED_CURLY;
5006 case 2:
5007 case 3: goto EXPAND_FAILED;
5008 }
5009
5010 /* Juggle the arguments if there are only two of them: always move the
5011 string to the last position and make ${length{n}{str}} equivalent to
5012 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5013
5014 if (sub[2] == NULL)
5015 {
5016 sub[2] = sub[1];
5017 sub[1] = NULL;
5018 if (item_type == EITEM_LENGTH)
5019 {
5020 sub[1] = sub[0];
5021 sub[0] = NULL;
5022 }
5023 }
5024
5025 for (i = 0; i < 2; i++)
5026 {
5027 if (sub[i] == NULL) continue;
5028 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5029 if (*ret != 0 || (i != 0 && val[i] < 0))
5030 {
5031 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5032 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5033 goto EXPAND_FAILED;
5034 }
5035 }
5036
5037 ret =
5038 (item_type == EITEM_HASH)?
5039 compute_hash(sub[2], val[0], val[1], &len) :
5040 (item_type == EITEM_NHASH)?
5041 compute_nhash(sub[2], val[0], val[1], &len) :
5042 extract_substr(sub[2], val[0], val[1], &len);
5043
5044 if (ret == NULL) goto EXPAND_FAILED;
5045 yield = string_cat(yield, &size, &ptr, ret, len);
5046 continue;
5047 }
5048
5049 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5050 This code originally contributed by Steve Haslam. It currently supports
5051 the use of MD5 and SHA-1 hashes.
5052
5053 We need some workspace that is large enough to handle all the supported
5054 hash types. Use macros to set the sizes rather than be too elaborate. */
5055
5056 #define MAX_HASHLEN 20
5057 #define MAX_HASHBLOCKLEN 64
5058
5059 case EITEM_HMAC:
5060 {
5061 uschar *sub[3];
5062 md5 md5_base;
5063 sha1 sha1_base;
5064 void *use_base;
5065 int type, i;
5066 int hashlen; /* Number of octets for the hash algorithm's output */
5067 int hashblocklen; /* Number of octets the hash algorithm processes */
5068 uschar *keyptr, *p;
5069 unsigned int keylen;
5070
5071 uschar keyhash[MAX_HASHLEN];
5072 uschar innerhash[MAX_HASHLEN];
5073 uschar finalhash[MAX_HASHLEN];
5074 uschar finalhash_hex[2*MAX_HASHLEN];
5075 uschar innerkey[MAX_HASHBLOCKLEN];
5076 uschar outerkey[MAX_HASHBLOCKLEN];
5077
5078 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5079 {
5080 case 1: goto EXPAND_FAILED_CURLY;
5081 case 2:
5082 case 3: goto EXPAND_FAILED;
5083 }
5084
5085 if (Ustrcmp(sub[0], "md5") == 0)
5086 {
5087 type = HMAC_MD5;
5088 use_base = &md5_base;
5089 hashlen = 16;
5090 hashblocklen = 64;
5091 }
5092 else if (Ustrcmp(sub[0], "sha1") == 0)
5093 {
5094 type = HMAC_SHA1;
5095 use_base = &sha1_base;
5096 hashlen = 20;
5097 hashblocklen = 64;
5098 }
5099 else
5100 {
5101 expand_string_message =
5102 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5103 goto EXPAND_FAILED;
5104 }
5105
5106 keyptr = sub[1];
5107 keylen = Ustrlen(keyptr);
5108
5109 /* If the key is longer than the hash block length, then hash the key
5110 first */
5111
5112 if (keylen > hashblocklen)
5113 {
5114 chash_start(type, use_base);
5115 chash_end(type, use_base, keyptr, keylen, keyhash);
5116 keyptr = keyhash;
5117 keylen = hashlen;
5118 }
5119
5120 /* Now make the inner and outer key values */
5121
5122 memset(innerkey, 0x36, hashblocklen);
5123 memset(outerkey, 0x5c, hashblocklen);
5124
5125 for (i = 0; i < keylen; i++)
5126 {
5127 innerkey[i] ^= keyptr[i];
5128 outerkey[i] ^= keyptr[i];
5129 }
5130
5131 /* Now do the hashes */
5132
5133 chash_start(type, use_base);
5134 chash_mid(type, use_base, innerkey);
5135 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5136
5137 chash_start(type, use_base);
5138 chash_mid(type, use_base, outerkey);
5139 chash_end(type, use_base, innerhash, hashlen, finalhash);
5140
5141 /* Encode the final hash as a hex string */
5142
5143 p = finalhash_hex;
5144 for (i = 0; i < hashlen; i++)
5145 {
5146 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5147 *p++ = hex_digits[finalhash[i] & 0x0f];
5148 }
5149
5150 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5151 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5152
5153 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5154 }
5155
5156 continue;
5157
5158 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5159 We have to save the numerical variables and restore them afterwards. */
5160
5161 case EITEM_SG:
5162 {
5163 const pcre *re;
5164 int moffset, moffsetextra, slen;
5165 int roffset;
5166 int emptyopt;
5167 const uschar *rerror;
5168 uschar *subject;
5169 uschar *sub[3];
5170 int save_expand_nmax =
5171 save_expand_strings(save_expand_nstring, save_expand_nlength);
5172
5173 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5174 {
5175 case 1: goto EXPAND_FAILED_CURLY;
5176 case 2:
5177 case 3: goto EXPAND_FAILED;
5178 }
5179
5180 /* Compile the regular expression */
5181
5182 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5183 NULL);
5184
5185 if (re == NULL)
5186 {
5187 expand_string_message = string_sprintf("regular expression error in "
5188 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5189 goto EXPAND_FAILED;
5190 }
5191
5192 /* Now run a loop to do the substitutions as often as necessary. It ends
5193 when there are no more matches. Take care over matches of the null string;
5194 do the same thing as Perl does. */
5195
5196 subject = sub[0];
5197 slen = Ustrlen(sub[0]);
5198 moffset = moffsetextra = 0;
5199 emptyopt = 0;
5200
5201 for (;;)
5202 {
5203 int ovector[3*(EXPAND_MAXN+1)];
5204 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5205 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5206 int nn;
5207 uschar *insert;
5208
5209 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5210 is not necessarily the end. We want to repeat the match from one
5211 character further along, but leaving the basic offset the same (for
5212 copying below). We can't be at the end of the string - that was checked
5213 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5214 finished; copy the remaining string and end the loop. */
5215
5216 if (n < 0)
5217 {
5218 if (emptyopt != 0)
5219 {
5220 moffsetextra = 1;
5221 emptyopt = 0;
5222 continue;
5223 }
5224 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5225 break;
5226 }
5227
5228 /* Match - set up for expanding the replacement. */
5229
5230 if (n == 0) n = EXPAND_MAXN + 1;
5231 expand_nmax = 0;
5232 for (nn = 0; nn < n*2; nn += 2)
5233 {
5234 expand_nstring[expand_nmax] = subject + ovector[nn];
5235 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5236 }
5237 expand_nmax--;
5238
5239 /* Copy the characters before the match, plus the expanded insertion. */
5240
5241 yield = string_cat(yield, &size, &ptr, subject + moffset,
5242 ovector[0] - moffset);
5243 insert = expand_string(sub[2]);
5244 if (insert == NULL) goto EXPAND_FAILED;
5245 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5246
5247 moffset = ovector[1];
5248 moffsetextra = 0;
5249 emptyopt = 0;
5250
5251 /* If we have matched an empty string, first check to see if we are at
5252 the end of the subject. If so, the loop is over. Otherwise, mimic
5253 what Perl's /g options does. This turns out to be rather cunning. First
5254 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5255 string at the same point. If this fails (picked up above) we advance to
5256 the next character. */
5257
5258 if (ovector[0] == ovector[1])
5259 {
5260 if (ovector[0] == slen) break;
5261 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5262 }
5263 }
5264
5265 /* All done - restore numerical variables. */
5266
5267 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5268 save_expand_nlength);
5269 continue;
5270 }
5271
5272 /* Handle keyed and numbered substring extraction. If the first argument
5273 consists entirely of digits, then a numerical extraction is assumed. */
5274
5275 case EITEM_EXTRACT:
5276 {
5277 int i;
5278 int j = 2;
5279 int field_number = 1;
5280 BOOL field_number_set = FALSE;
5281 uschar *save_lookup_value = lookup_value;
5282 uschar *sub[3];
5283 int save_expand_nmax =
5284 save_expand_strings(save_expand_nstring, save_expand_nlength);
5285
5286 /* Read the arguments */
5287
5288 for (i = 0; i < j; i++)
5289 {
5290 while (isspace(*s)) s++;
5291 if (*s == '{') /*}*/
5292 {
5293 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5294 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5295 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5296
5297 /* After removal of leading and trailing white space, the first
5298 argument must not be empty; if it consists entirely of digits
5299 (optionally preceded by a minus sign), this is a numerical
5300 extraction, and we expect 3 arguments. */
5301
5302 if (i == 0)
5303 {
5304 int len;
5305 int x = 0;
5306 uschar *p = sub[0];
5307
5308 while (isspace(*p)) p++;
5309 sub[0] = p;
5310
5311 len = Ustrlen(p);
5312 while (len > 0 && isspace(p[len-1])) len--;
5313 p[len] = 0;
5314
5315 if (!skipping)
5316 {
5317 if (*p == 0)
5318 {
5319 expand_string_message = US"first argument of \"extract\" must "
5320 "not be empty";
5321 goto EXPAND_FAILED;
5322 }
5323
5324 if (*p == '-')
5325 {
5326 field_number = -1;
5327 p++;
5328 }
5329 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5330 if (*p == 0)
5331 {
5332 field_number *= x;
5333 j = 3; /* Need 3 args */
5334 field_number_set = TRUE;
5335 }
5336 }
5337 }
5338 }
5339 else goto EXPAND_FAILED_CURLY;
5340 }
5341
5342 /* Extract either the numbered or the keyed substring into $value. If
5343 skipping, just pretend the extraction failed. */
5344
5345 lookup_value = skipping? NULL : field_number_set?
5346 expand_gettokened(field_number, sub[1], sub[2]) :
5347 expand_getkeyed(sub[0], sub[1]);
5348
5349 /* If no string follows, $value gets substituted; otherwise there can
5350 be yes/no strings, as for lookup or if. */
5351
5352 switch(process_yesno(
5353 skipping, /* were previously skipping */
5354 lookup_value != NULL, /* success/failure indicator */
5355 save_lookup_value, /* value to reset for string2 */
5356 &s, /* input pointer */
5357 &yield, /* output pointer */
5358 &size, /* output size */
5359 &ptr, /* output current point */
5360 US"extract", /* condition type */
5361 &resetok))
5362 {
5363 case 1: goto EXPAND_FAILED; /* when all is well, the */
5364 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5365 }
5366
5367 /* All done - restore numerical variables. */
5368
5369 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5370 save_expand_nlength);
5371
5372 continue;
5373 }
5374
5375 /* return the Nth item from a list */
5376
5377 case EITEM_LISTEXTRACT:
5378 {
5379 int i;
5380 int field_number = 1;
5381 uschar *save_lookup_value = lookup_value;
5382 uschar *sub[2];
5383 int save_expand_nmax =
5384 save_expand_strings(save_expand_nstring, save_expand_nlength);
5385
5386 /* Read the field & list arguments */
5387
5388 for (i = 0; i < 2; i++)
5389 {
5390 while (isspace(*s)) s++;
5391 if (*s != '{') /*}*/
5392 goto EXPAND_FAILED_CURLY;
5393
5394 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5395 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5396 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5397
5398 /* After removal of leading and trailing white space, the first
5399 argument must be numeric and nonempty. */
5400
5401 if (i == 0)
5402 {
5403 int len;
5404 int x = 0;
5405 uschar *p = sub[0];
5406
5407 while (isspace(*p)) p++;
5408 sub[0] = p;
5409
5410 len = Ustrlen(p);
5411 while (len > 0 && isspace(p[len-1])) len--;
5412 p[len] = 0;
5413
5414 if (!*p && !skipping)
5415 {
5416 expand_string_message = US"first argument of \"listextract\" must "
5417 "not be empty";
5418 goto EXPAND_FAILED;
5419 }
5420
5421 if (*p == '-')
5422 {
5423 field_number = -1;
5424 p++;
5425 }
5426 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5427 if (*p)
5428 {
5429 expand_string_message = US"first argument of \"listextract\" must "
5430 "be numeric";
5431 goto EXPAND_FAILED;
5432 }
5433 field_number *= x;
5434 }
5435 }
5436
5437 /* Extract the numbered element into $value. If
5438 skipping, just pretend the extraction failed. */
5439
5440 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5441
5442 /* If no string follows, $value gets substituted; otherwise there can
5443 be yes/no strings, as for lookup or if. */
5444
5445 switch(process_yesno(
5446 skipping, /* were previously skipping */
5447 lookup_value != NULL, /* success/failure indicator */
5448 save_lookup_value, /* value to reset for string2 */
5449 &s, /* input pointer */
5450 &yield, /* output pointer */
5451 &size, /* output size */
5452 &ptr, /* output current point */
5453 US"extract", /* condition type */
5454 &resetok))
5455 {
5456 case 1: goto EXPAND_FAILED; /* when all is well, the */
5457 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5458 }
5459
5460 /* All done - restore numerical variables. */
5461
5462 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5463 save_expand_nlength);
5464
5465 continue;
5466 }
5467
5468 #ifdef SUPPORT_TLS
5469 case EITEM_CERTEXTRACT:
5470 {
5471 uschar *save_lookup_value = lookup_value;
5472 uschar *sub[2];
5473 int save_expand_nmax =
5474 save_expand_strings(save_expand_nstring, save_expand_nlength);
5475
5476 /* Read the field argument */
5477 while (isspace(*s)) s++;
5478 if (*s != '{') /*}*/
5479 goto EXPAND_FAILED_CURLY;
5480 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5481 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5482 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5483 /* strip spaces fore & aft */
5484 {
5485 int len;
5486 uschar *p = sub[0];
5487
5488 while (isspace(*p)) p++;
5489 sub[0] = p;
5490
5491 len = Ustrlen(p);
5492 while (len > 0 && isspace(p[len-1])) len--;
5493 p[len] = 0;
5494 }
5495
5496 /* inspect the cert argument */
5497 while (isspace(*s)) s++;
5498 if (*s != '{') /*}*/
5499 goto EXPAND_FAILED_CURLY;
5500 if (*++s != '$')
5501 {
5502 expand_string_message = US"second argument of \"certextract\" must "
5503 "be a certificate variable";
5504 goto EXPAND_FAILED;
5505 }
5506 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5507 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5508 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5509
5510 if (skipping)
5511 lookup_value = NULL;
5512 else
5513 {
5514 lookup_value = expand_getcertele(sub[0], sub[1]);
5515 if (*expand_string_message) goto EXPAND_FAILED;
5516 }
5517 switch(process_yesno(
5518 skipping, /* were previously skipping */
5519 lookup_value != NULL, /* success/failure indicator */
5520 save_lookup_value, /* value to reset for string2 */
5521 &s, /* input pointer */
5522 &yield, /* output pointer */
5523 &size, /* output size */
5524 &ptr, /* output current point */
5525 US"extract", /* condition type */
5526 &resetok))
5527 {
5528 case 1: goto EXPAND_FAILED; /* when all is well, the */
5529 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5530 }
5531
5532 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5533 save_expand_nlength);
5534 continue;
5535 }
5536 #endif /*SUPPORT_TLS*/
5537
5538 /* Handle list operations */
5539
5540 case EITEM_FILTER:
5541 case EITEM_MAP:
5542 case EITEM_REDUCE:
5543 {
5544 int sep = 0;
5545 int save_ptr = ptr;
5546 uschar outsep[2] = { '\0', '\0' };
5547 const uschar *list, *expr, *temp;
5548 uschar *save_iterate_item = iterate_item;
5549 uschar *save_lookup_value = lookup_value;
5550
5551 while (isspace(*s)) s++;
5552 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5553
5554 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5555 if (list == NULL) goto EXPAND_FAILED;
5556 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5557
5558 if (item_type == EITEM_REDUCE)
5559 {
5560 uschar * t;
5561 while (isspace(*s)) s++;
5562 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5563 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5564 if (!t) goto EXPAND_FAILED;
5565 lookup_value = t;
5566 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5567 }
5568
5569 while (isspace(*s)) s++;
5570 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5571
5572 expr = s;
5573
5574 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5575 if scanning a "false" part). This allows us to find the end of the
5576 condition, because if the list is empty, we won't actually evaluate the
5577 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5578 the normal internal expansion function. */
5579
5580 if (item_type == EITEM_FILTER)
5581 {
5582 temp = eval_condition(expr, &resetok, NULL);
5583 if (temp != NULL) s = temp;
5584 }
5585 else
5586 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5587
5588 if (temp == NULL)
5589 {
5590 expand_string_message = string_sprintf("%s inside \"%s\" item",
5591 expand_string_message, name);
5592 goto EXPAND_FAILED;
5593 }
5594
5595 while (isspace(*s)) s++;
5596 if (*s++ != '}')
5597 { /*{*/
5598 expand_string_message = string_sprintf("missing } at end of condition "
5599 "or expression inside \"%s\"", name);
5600 goto EXPAND_FAILED;
5601 }
5602
5603 while (isspace(*s)) s++; /*{*/
5604 if (*s++ != '}')
5605 { /*{*/
5606 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5607 name);
5608 goto EXPAND_FAILED;
5609 }
5610
5611 /* If we are skipping, we can now just move on to the next item. When
5612 processing for real, we perform the iteration. */
5613
5614 if (skipping) continue;
5615 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5616 {
5617 *outsep = (uschar)sep; /* Separator as a string */
5618
5619 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5620
5621 if (item_type == EITEM_FILTER)
5622 {
5623 BOOL condresult;
5624 if (eval_condition(expr, &resetok, &condresult) == NULL)
5625 {
5626 iterate_item = save_iterate_item;
5627 lookup_value = save_lookup_value;
5628 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5629 expand_string_message, name);
5630 goto EXPAND_FAILED;
5631 }
5632 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5633 condresult? "true":"false");
5634 if (condresult)
5635 temp = iterate_item; /* TRUE => include this item */
5636 else
5637 continue; /* FALSE => skip this item */
5638 }
5639
5640 /* EITEM_MAP and EITEM_REDUCE */
5641
5642 else
5643 {
5644 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5645 temp = t;
5646 if (temp == NULL)
5647 {
5648 iterate_item = save_iterate_item;
5649 expand_string_message = string_sprintf("%s inside \"%s\" item",
5650 expand_string_message, name);
5651 goto EXPAND_FAILED;
5652 }
5653 if (item_type == EITEM_REDUCE)
5654 {
5655 lookup_value = t; /* Update the value of $value */
5656 continue; /* and continue the iteration */
5657 }
5658 }
5659
5660 /* We reach here for FILTER if the condition is true, always for MAP,
5661 and never for REDUCE. The value in "temp" is to be added to the output
5662 list that is being created, ensuring that any occurrences of the
5663 separator character are doubled. Unless we are dealing with the first
5664 item of the output list, add in a space if the new item begins with the
5665 separator character, or is an empty string. */
5666
5667 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5668 yield = string_cat(yield, &size, &ptr, US" ", 1);
5669
5670 /* Add the string in "temp" to the output list that we are building,
5671 This is done in chunks by searching for the separator character. */
5672
5673 for (;;)
5674 {
5675 size_t seglen = Ustrcspn(temp, outsep);
5676 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5677
5678 /* If we got to the end of the string we output one character
5679 too many; backup and end the loop. Otherwise arrange to double the
5680 separator. */
5681
5682 if (temp[seglen] == '\0') { ptr--; break; }
5683 yield = string_cat(yield, &size, &ptr, outsep, 1);
5684 temp += seglen + 1;
5685 }
5686
5687 /* Output a separator after the string: we will remove the redundant
5688 final one at the end. */
5689
5690 yield = string_cat(yield, &size, &ptr, outsep, 1);
5691 } /* End of iteration over the list loop */
5692
5693 /* REDUCE has generated no output above: output the final value of
5694 $value. */
5695
5696 if (item_type == EITEM_REDUCE)
5697 {
5698 yield = string_cat(yield, &size, &ptr, lookup_value,
5699 Ustrlen(lookup_value));
5700 lookup_value = save_lookup_value; /* Restore $value */
5701 }
5702
5703 /* FILTER and MAP generate lists: if they have generated anything, remove
5704 the redundant final separator. Even though an empty item at the end of a
5705 list does not count, this is tidier. */
5706
5707 else if (ptr != save_ptr) ptr--;
5708
5709 /* Restore preserved $item */
5710
5711 iterate_item = save_iterate_item;
5712 continue;
5713 }
5714
5715 case EITEM_SORT:
5716 {
5717 int sep = 0;
5718 const uschar *srclist, *cmp, *xtract;
5719 uschar *srcitem;
5720 const uschar *dstlist = NULL, *dstkeylist = NULL;
5721 uschar * tmp;
5722 uschar *save_iterate_item = iterate_item;
5723
5724 while (isspace(*s)) s++;
5725 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5726
5727 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5728 if (!srclist) goto EXPAND_FAILED;
5729 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5730
5731 while (isspace(*s)) s++;
5732 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5733
5734 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5735 if (!cmp) goto EXPAND_FAILED;
5736 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5737
5738 while (isspace(*s)) s++;
5739 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5740
5741 xtract = s;
5742 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5743 if (!tmp) goto EXPAND_FAILED;
5744 xtract = string_copyn(xtract, s - xtract);
5745
5746 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5747 /*{*/
5748 if (*s++ != '}')
5749 { /*{*/
5750 expand_string_message = US"missing } at end of \"sort\"";
5751 goto EXPAND_FAILED;
5752 }
5753
5754 if (skipping) continue;
5755
5756 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5757 {
5758 uschar * dstitem;
5759 uschar * newlist = NULL;
5760 uschar * newkeylist = NULL;
5761 uschar * srcfield;
5762
5763 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, srcitem);
5764
5765 /* extract field for comparisons */
5766 iterate_item = srcitem;
5767 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5768 TRUE, &resetok))
5769 || !*srcfield)
5770 {
5771 expand_string_message = string_sprintf(
5772 "field-extract in sort: \"%s\"", xtract);
5773 goto EXPAND_FAILED;
5774 }
5775
5776 /* Insertion sort */
5777
5778 /* copy output list until new-item < list-item */
5779 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5780 {
5781 uschar * dstfield;
5782 uschar * expr;
5783 BOOL before;
5784
5785 /* field for comparison */
5786 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5787 goto sort_mismatch;
5788
5789 /* build and run condition string */
5790 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
5791
5792 DEBUG(D_expand) debug_printf("%s: cond = \"%s\"\n", name, expr);
5793 if (!eval_condition(expr, &resetok, &before))
5794 {
5795 expand_string_message = string_sprintf("comparison in sort: %s",
5796 expr);
5797 goto EXPAND_FAILED;
5798 }
5799
5800 if (before)
5801 {
5802 /* New-item sorts before this dst-item. Append new-item,
5803 then dst-item, then remainder of dst list. */
5804
5805 newlist = string_append_listele(newlist, sep, srcitem);
5806 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5807 srcitem = NULL;
5808
5809 newlist = string_append_listele(newlist, sep, dstitem);
5810 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5811
5812 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5813 {
5814 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5815 goto sort_mismatch;
5816 newlist = string_append_listele(newlist, sep, dstitem);
5817 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5818 }
5819
5820 break;
5821 }
5822
5823 newlist = string_append_listele(newlist, sep, dstitem);
5824 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5825 }
5826
5827 /* If we ran out of dstlist without consuming srcitem, append it */
5828 if (srcitem)
5829 {
5830 newlist = string_append_listele(newlist, sep, srcitem);
5831 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5832 }
5833
5834 dstlist = newlist;
5835 dstkeylist = newkeylist;
5836
5837 DEBUG(D_expand) debug_printf("%s: dstlist = \"%s\"\n", name, dstlist);
5838 DEBUG(D_expand) debug_printf("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
5839 }
5840
5841 if (dstlist)
5842 yield = string_cat(yield, &size, &ptr, dstlist, Ustrlen(dstlist));
5843
5844 /* Restore preserved $item */
5845 iterate_item = save_iterate_item;
5846 continue;
5847
5848 sort_mismatch:
5849 expand_string_message = US"Internal error in sort (list mismatch)";
5850 goto EXPAND_FAILED;
5851 }
5852
5853
5854 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5855 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5856 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5857 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5858
5859 #define EXPAND_DLFUNC_MAX_ARGS 8
5860
5861 case EITEM_DLFUNC:
5862 #ifndef EXPAND_DLFUNC
5863 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5864 "is not included in this binary";
5865 goto EXPAND_FAILED;
5866
5867 #else /* EXPAND_DLFUNC */
5868 {
5869 tree_node *t;
5870 exim_dlfunc_t *func;
5871 uschar *result;
5872 int status, argc;
5873 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5874
5875 if ((expand_forbid & RDO_DLFUNC) != 0)
5876 {
5877 expand_string_message =
5878 US"dynamically-loaded functions are not permitted";
5879 goto EXPAND_FAILED;
5880 }
5881
5882 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5883 TRUE, US"dlfunc", &resetok))
5884 {
5885 case 1: goto EXPAND_FAILED_CURLY;
5886 case 2:
5887 case 3: goto EXPAND_FAILED;
5888 }
5889
5890 /* If skipping, we don't actually do anything */
5891
5892 if (skipping) continue;
5893
5894 /* Look up the dynamically loaded object handle in the tree. If it isn't
5895 found, dlopen() the file and put the handle in the tree for next time. */
5896
5897 t = tree_search(dlobj_anchor, argv[0]);
5898 if (t == NULL)
5899 {
5900 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5901 if (handle == NULL)
5902 {
5903 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5904 argv[0], dlerror());
5905 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5906 goto EXPAND_FAILED;
5907 }
5908 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5909 Ustrcpy(t->name, argv[0]);
5910 t->data.ptr = handle;
5911 (void)tree_insertnode(&dlobj_anchor, t);
5912 }
5913
5914 /* Having obtained the dynamically loaded object handle, look up the
5915 function pointer. */
5916
5917 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5918 if (func == NULL)
5919 {
5920 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5921 "%s", argv[1], argv[0], dlerror());
5922 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5923 goto EXPAND_FAILED;
5924 }
5925
5926 /* Call the function and work out what to do with the result. If it
5927 returns OK, we have a replacement string; if it returns DEFER then
5928 expansion has failed in a non-forced manner; if it returns FAIL then
5929 failure was forced; if it returns ERROR or any other value there's a
5930 problem, so panic slightly. In any case, assume that the function has
5931 side-effects on the store that must be preserved. */
5932
5933 resetok = FALSE;
5934 result = NULL;
5935 for (argc = 0; argv[argc] != NULL; argc++);
5936 status = func(&result, argc - 2, &argv[2]);
5937 if(status == OK)
5938 {
5939 if (result == NULL) result = US"";
5940 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5941 continue;
5942 }
5943 else
5944 {
5945 expand_string_message = result == NULL ? US"(no message)" : result;
5946 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5947 else if(status != FAIL)
5948 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5949 argv[0], argv[1], status, expand_string_message);
5950 goto EXPAND_FAILED;
5951 }
5952 }
5953 #endif /* EXPAND_DLFUNC */
5954 } /* EITEM_* switch */
5955
5956 /* Control reaches here if the name is not recognized as one of the more
5957 complicated expansion items. Check for the "operator" syntax (name terminated
5958 by a colon). Some of the operators have arguments, separated by _ from the
5959 name. */
5960
5961 if (*s == ':')
5962 {
5963 int c;
5964 uschar *arg = NULL;
5965 uschar *sub;
5966 var_entry *vp = NULL;
5967
5968 /* Owing to an historical mis-design, an underscore may be part of the
5969 operator name, or it may introduce arguments. We therefore first scan the
5970 table of names that contain underscores. If there is no match, we cut off
5971 the arguments and then scan the main table. */
5972
5973 if ((c = chop_match(name, op_table_underscore,
5974 nelem(op_table_underscore))) < 0)
5975 {
5976 arg = Ustrchr(name, '_');
5977 if (arg != NULL) *arg = 0;
5978 c = chop_match(name, op_table_main, nelem(op_table_main));
5979 if (c >= 0) c += nelem(op_table_underscore);
5980 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5981 }
5982
5983 /* Deal specially with operators that might take a certificate variable
5984 as we do not want to do the usual expansion. For most, expand the string.*/
5985 switch(c)
5986 {
5987 #ifdef SUPPORT_TLS
5988 case EOP_MD5:
5989 case EOP_SHA1:
5990 case EOP_SHA256:
5991 if (s[1] == '$')
5992 {
5993 const uschar * s1 = s;
5994 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
5995 FALSE, &resetok);
5996 if (!sub) goto EXPAND_FAILED; /*{*/
5997 if (*s1 != '}') goto EXPAND_FAILED_CURLY;
5998 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
5999 {
6000 s = s1+1;
6001 break;
6002 }
6003 vp = NULL;
6004 }
6005 /*FALLTHROUGH*/
6006 #endif
6007 default:
6008 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6009 if (!sub) goto EXPAND_FAILED;
6010 s++;
6011 break;
6012 }
6013
6014 /* If we are skipping, we don't need to perform the operation at all.
6015 This matters for operations like "mask", because the data may not be
6016 in the correct format when skipping. For example, the expression may test
6017 for the existence of $sender_host_address before trying to mask it. For
6018 other operations, doing them may not fail, but it is a waste of time. */
6019
6020 if (skipping && c >= 0) continue;
6021
6022 /* Otherwise, switch on the operator type */
6023
6024 switch(c)
6025 {
6026 case EOP_BASE62:
6027 {
6028 uschar *t;
6029 unsigned long int n = Ustrtoul(sub, &t, 10);
6030 if (*t != 0)
6031 {
6032 expand_string_message = string_sprintf("argument for base62 "
6033 "operator is \"%s\", which is not a decimal number", sub);
6034 goto EXPAND_FAILED;
6035 }
6036 t = string_base62(n);
6037 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6038 continue;
6039 }
6040
6041 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6042
6043 case EOP_BASE62D:
6044 {
6045 uschar buf[16];
6046 uschar *tt = sub;
6047 unsigned long int n = 0;
6048 while (*tt != 0)
6049 {
6050 uschar *t = Ustrchr(base62_chars, *tt++);
6051 if (t == NULL)
6052 {
6053 expand_string_message = string_sprintf("argument for base62d "
6054 "operator is \"%s\", which is not a base %d number", sub,
6055 BASE_62);
6056 goto EXPAND_FAILED;
6057 }
6058 n = n * BASE_62 + (t - base62_chars);
6059 }
6060 (void)sprintf(CS buf, "%ld", n);
6061 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
6062 continue;
6063 }
6064
6065 case EOP_EXPAND:
6066 {
6067 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6068 if (expanded == NULL)
6069 {
6070 expand_string_message =
6071 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6072 expand_string_message);
6073 goto EXPAND_FAILED;
6074 }
6075 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
6076 continue;
6077 }
6078
6079 case EOP_LC:
6080 {
6081 int count = 0;
6082 uschar *t = sub - 1;
6083 while (*(++t) != 0) { *t = tolower(*t); count++; }
6084 yield = string_cat(yield, &size, &ptr, sub, count);
6085 continue;
6086 }
6087
6088 case EOP_UC:
6089 {
6090 int count = 0;
6091 uschar *t = sub - 1;
6092 while (*(++t) != 0) { *t = toupper(*t); count++; }
6093 yield = string_cat(yield, &size, &ptr, sub, count);
6094 continue;
6095 }
6096
6097 case EOP_MD5:
6098 #ifdef SUPPORT_TLS
6099 if (vp && *(void **)vp->value)
6100 {
6101 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6102 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6103 }
6104 else
6105 #endif
6106 {
6107 md5 base;
6108 uschar digest[16];
6109 int j;
6110 char st[33];
6111 md5_start(&base);
6112 md5_end(&base, sub, Ustrlen(sub), digest);
6113 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6114 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6115 }
6116 continue;
6117
6118 case EOP_SHA1:
6119 #ifdef SUPPORT_TLS
6120 if (vp && *(void **)vp->value)
6121 {
6122 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6123 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6124 }
6125 else
6126 #endif
6127 {
6128 sha1 base;
6129 uschar digest[20];
6130 int j;
6131 char st[41];
6132 sha1_start(&base);
6133 sha1_end(&base, sub, Ustrlen(sub), digest);
6134 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6135 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6136 }
6137 continue;
6138
6139 case EOP_SHA256:
6140 #ifdef SUPPORT_TLS
6141 if (vp && *(void **)vp->value)
6142 {
6143 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6144 yield = string_cat(yield, &size, &ptr, cp, (int)Ustrlen(cp));
6145 }
6146 else
6147 #endif
6148 expand_string_message = US"sha256 only supported for certificates";
6149 continue;
6150
6151 /* Convert hex encoding to base64 encoding */
6152
6153 case EOP_HEX2B64:
6154 {
6155 int c = 0;
6156 int b = -1;
6157 uschar *in = sub;
6158 uschar *out = sub;
6159 uschar *enc;
6160
6161 for (enc = sub; *enc != 0; enc++)
6162 {
6163 if (!isxdigit(*enc))
6164 {
6165 expand_string_message = string_sprintf("\"%s\" is not a hex "
6166 "string", sub);
6167 goto EXPAND_FAILED;
6168 }
6169 c++;
6170 }
6171
6172 if ((c & 1) != 0)
6173 {
6174 expand_string_message = string_sprintf("\"%s\" contains an odd "
6175 "number of characters", sub);
6176 goto EXPAND_FAILED;
6177 }
6178
6179 while ((c = *in++) != 0)
6180 {
6181 if (isdigit(c)) c -= '0';
6182 else c = toupper(c) - 'A' + 10;
6183 if (b == -1)
6184 {
6185 b = c << 4;
6186 }
6187 else
6188 {
6189 *out++ = b | c;
6190 b = -1;
6191 }
6192 }
6193
6194 enc = auth_b64encode(sub, out - sub);
6195 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
6196 continue;
6197 }
6198
6199 /* Convert octets outside 0x21..0x7E to \xXX form */
6200
6201 case EOP_HEXQUOTE:
6202 {
6203 uschar *t = sub - 1;
6204 while (*(++t) != 0)
6205 {
6206 if (*t < 0x21 || 0x7E < *t)
6207 yield = string_cat(yield, &size, &ptr,
6208 string_sprintf("\\x%02x", *t), 4);
6209 else
6210 yield = string_cat(yield, &size, &ptr, t, 1);
6211 }
6212 continue;
6213 }
6214
6215 /* count the number of list elements */
6216
6217 case EOP_LISTCOUNT:
6218 {
6219 int cnt = 0;
6220 int sep = 0;
6221 uschar * cp;
6222 uschar buffer[256];
6223
6224 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6225 cp = string_sprintf("%d", cnt);
6226 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6227 continue;
6228 }
6229
6230 /* expand a named list given the name */
6231 /* handles nested named lists; requotes as colon-sep list */
6232
6233 case EOP_LISTNAMED:
6234 {
6235 tree_node *t = NULL;
6236 const uschar * list;
6237 int sep = 0;
6238 uschar * item;
6239 uschar * suffix = US"";
6240 BOOL needsep = FALSE;
6241 uschar buffer[256];
6242
6243 if (*sub == '+') sub++;
6244 if (arg == NULL) /* no-argument version */
6245 {
6246 if (!(t = tree_search(addresslist_anchor, sub)) &&
6247 !(t = tree_search(domainlist_anchor, sub)) &&
6248 !(t = tree_search(hostlist_anchor, sub)))
6249 t = tree_search(localpartlist_anchor, sub);
6250 }
6251 else switch(*arg) /* specific list-type version */
6252 {
6253 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6254 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6255 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6256 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6257 default:
6258 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6259 goto EXPAND_FAILED;
6260 }
6261
6262 if(!t)
6263 {
6264 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6265 sub, !arg?""
6266 : *arg=='a'?"address "
6267 : *arg=='d'?"domain "
6268 : *arg=='h'?"host "
6269 : *arg=='l'?"localpart "
6270 : 0);
6271 goto EXPAND_FAILED;
6272 }
6273
6274 list = ((namedlist_block *)(t->data.ptr))->string;
6275
6276 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6277 {
6278 uschar * buf = US" : ";
6279 if (needsep)
6280 yield = string_cat(yield, &size, &ptr, buf, 3);
6281 else
6282 needsep = TRUE;
6283
6284 if (*item == '+') /* list item is itself a named list */
6285 {
6286 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6287 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6288 }
6289 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6290 {
6291 char * cp;
6292 char tok[3];
6293 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6294 while ((cp= strpbrk((const char *)item, tok)))
6295 {
6296 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
6297 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6298 {
6299 yield = string_cat(yield, &size, &ptr, US"::", 2);
6300 item = (uschar *)cp;
6301 }
6302 else /* sep in item; should already be doubled; emit once */
6303 {
6304 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
6305 if (*cp == sep) cp++;
6306 item = (uschar *)cp;
6307 }
6308 }
6309 }
6310 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
6311 }
6312 continue;
6313 }
6314
6315 /* mask applies a mask to an IP address; for example the result of
6316 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6317
6318 case EOP_MASK:
6319 {
6320 int count;
6321 uschar *endptr;
6322 int binary[4];
6323 int mask, maskoffset;
6324 int type = string_is_ip_address(sub, &maskoffset);
6325 uschar buffer[64];
6326
6327 if (type == 0)
6328 {
6329 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6330 sub);
6331 goto EXPAND_FAILED;
6332 }
6333
6334 if (maskoffset == 0)
6335 {
6336 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6337 sub);
6338 goto EXPAND_FAILED;
6339 }
6340
6341 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6342
6343 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6344 {
6345 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6346 sub);
6347 goto EXPAND_FAILED;
6348 }
6349
6350 /* Convert the address to binary integer(s) and apply the mask */
6351
6352 sub[maskoffset] = 0;
6353 count = host_aton(sub, binary);
6354 host_mask(count, binary, mask);
6355
6356 /* Convert to masked textual format and add to output. */
6357
6358 yield = string_cat(yield, &size, &ptr, buffer,
6359 host_nmtoa(count, binary, mask, buffer, '.'));
6360 continue;
6361 }
6362
6363 case EOP_ADDRESS:
6364 case EOP_LOCAL_PART:
6365 case EOP_DOMAIN:
6366 {
6367 uschar *error;
6368 int start, end, domain;
6369 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6370 FALSE);
6371 if (t != NULL)
6372 {
6373 if (c != EOP_DOMAIN)
6374 {
6375 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6376 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
6377 }
6378 else if (domain != 0)
6379 {
6380 domain += start;
6381 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
6382 }
6383 }
6384 continue;
6385 }
6386
6387 case EOP_ADDRESSES:
6388 {
6389 uschar outsep[2] = { ':', '\0' };
6390 uschar *address, *error;
6391 int save_ptr = ptr;
6392 int start, end, domain; /* Not really used */
6393
6394 while (isspace(*sub)) sub++;
6395 if (*sub == '>') { *outsep = *++sub; ++sub; }
6396 parse_allow_group = TRUE;
6397
6398 for (;;)
6399 {
6400 uschar *p = parse_find_address_end(sub, FALSE);
6401 uschar saveend = *p;
6402 *p = '\0';
6403 address = parse_extract_address(sub, &error, &start, &end, &domain,
6404 FALSE);
6405 *p = saveend;
6406
6407 /* Add the address to the output list that we are building. This is
6408 done in chunks by searching for the separator character. At the
6409 start, unless we are dealing with the first address of the output
6410 list, add in a space if the new address begins with the separator
6411 character, or is an empty string. */
6412
6413 if (address != NULL)
6414 {
6415 if (ptr != save_ptr && address[0] == *outsep)
6416 yield = string_cat(yield, &size, &ptr, US" ", 1);
6417
6418 for (;;)
6419 {
6420 size_t seglen = Ustrcspn(address, outsep);
6421 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
6422
6423 /* If we got to the end of the string we output one character
6424 too many. */
6425
6426 if (address[seglen] == '\0') { ptr--; break; }
6427 yield = string_cat(yield, &size, &ptr, outsep, 1);
6428 address += seglen + 1;
6429 }
6430
6431 /* Output a separator after the string: we will remove the
6432 redundant final one at the end. */
6433
6434 yield = string_cat(yield, &size, &ptr, outsep, 1);
6435 }
6436
6437 if (saveend == '\0') break;
6438 sub = p + 1;
6439 }
6440
6441 /* If we have generated anything, remove the redundant final
6442 separator. */
6443
6444 if (ptr != save_ptr) ptr--;
6445 parse_allow_group = FALSE;
6446 continue;
6447 }
6448
6449
6450 /* quote puts a string in quotes if it is empty or contains anything
6451 other than alphamerics, underscore, dot, or hyphen.
6452
6453 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6454 be quoted in order to be a valid local part.
6455
6456 In both cases, newlines and carriage returns are converted into \n and \r
6457 respectively */
6458
6459 case EOP_QUOTE:
6460 case EOP_QUOTE_LOCAL_PART:
6461 if (arg == NULL)
6462 {
6463 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6464 uschar *t = sub - 1;
6465
6466 if (c == EOP_QUOTE)
6467 {
6468 while (!needs_quote && *(++t) != 0)
6469 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6470 }
6471 else /* EOP_QUOTE_LOCAL_PART */
6472 {
6473 while (!needs_quote && *(++t) != 0)
6474 needs_quote = !isalnum(*t) &&
6475 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6476 (*t != '.' || t == sub || t[1] == 0);
6477 }
6478
6479 if (needs_quote)
6480 {
6481 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6482 t = sub - 1;
6483 while (*(++t) != 0)
6484 {
6485 if (*t == '\n')
6486 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6487 else if (*t == '\r')
6488 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6489 else
6490 {
6491 if (*t == '\\' || *t == '"')
6492 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6493 yield = string_cat(yield, &size, &ptr, t, 1);
6494 }
6495 }
6496 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6497 }
6498 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6499 continue;
6500 }
6501
6502 /* quote_lookuptype does lookup-specific quoting */
6503
6504 else
6505 {
6506 int n;
6507 uschar *opt = Ustrchr(arg, '_');
6508
6509 if (opt != NULL) *opt++ = 0;
6510
6511 n = search_findtype(arg, Ustrlen(arg));
6512 if (n < 0)
6513 {
6514 expand_string_message = search_error_message;
6515 goto EXPAND_FAILED;
6516 }
6517
6518 if (lookup_list[n]->quote != NULL)
6519 sub = (lookup_list[n]->quote)(sub, opt);
6520 else if (opt != NULL) sub = NULL;
6521
6522 if (sub == NULL)
6523 {
6524 expand_string_message = string_sprintf(
6525 "\"%s\" unrecognized after \"${quote_%s\"",
6526 opt, arg);
6527 goto EXPAND_FAILED;
6528 }
6529
6530 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6531 continue;
6532 }
6533
6534 /* rx quote sticks in \ before any non-alphameric character so that
6535 the insertion works in a regular expression. */
6536
6537 case EOP_RXQUOTE:
6538 {
6539 uschar *t = sub - 1;
6540 while (*(++t) != 0)
6541 {
6542 if (!isalnum(*t))
6543 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6544 yield = string_cat(yield, &size, &ptr, t, 1);
6545 }
6546 continue;
6547 }
6548
6549 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6550 prescribed by the RFC, if there are characters that need to be encoded */
6551
6552 case EOP_RFC2047:
6553 {
6554 uschar buffer[2048];
6555 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6556 buffer, sizeof(buffer), FALSE);
6557 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6558 continue;
6559 }
6560
6561 /* RFC 2047 decode */
6562
6563 case EOP_RFC2047D:
6564 {
6565 int len;
6566 uschar *error;
6567 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6568 headers_charset, '?', &len, &error);
6569 if (error != NULL)
6570 {
6571 expand_string_message = error;
6572 goto EXPAND_FAILED;
6573 }
6574 yield = string_cat(yield, &size, &ptr, decoded, len);
6575 continue;
6576 }
6577
6578 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6579 underscores */
6580
6581 case EOP_FROM_UTF8:
6582 {
6583 while (*sub != 0)
6584 {
6585 int c;
6586 uschar buff[4];
6587 GETUTF8INC(c, sub);
6588 if (c > 255) c = '_';
6589 buff[0] = c;
6590 yield = string_cat(yield, &size, &ptr, buff, 1);
6591 }
6592 continue;
6593 }
6594
6595 /* replace illegal UTF-8 sequences by replacement character */
6596
6597 #define UTF8_REPLACEMENT_CHAR US"?"
6598
6599 case EOP_UTF8CLEAN:
6600 {
6601 int seq_len = 0, index = 0;
6602 int bytes_left = 0;
6603 long codepoint = -1;
6604 uschar seq_buff[4]; /* accumulate utf-8 here */
6605
6606 while (*sub != 0)
6607 {
6608 int complete = 0;
6609 uschar c = *sub++;
6610
6611 if (bytes_left)
6612 {
6613 if ((c & 0xc0) != 0x80)
6614 /* wrong continuation byte; invalidate all bytes */
6615 complete = 1; /* error */
6616 else
6617 {
6618 codepoint = (codepoint << 6) | (c & 0x3f);
6619 seq_buff[index++] = c;
6620 if (--bytes_left == 0) /* codepoint complete */
6621 if(codepoint > 0x10FFFF) /* is it too large? */
6622 complete = -1; /* error (RFC3629 limit) */
6623 else
6624 { /* finished; output utf-8 sequence */
6625 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6626 index = 0;
6627 }
6628 }
6629 }
6630 else /* no bytes left: new sequence */
6631 {
6632 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6633 {
6634 yield = string_cat(yield, &size, &ptr, &c, 1);
6635 continue;
6636 }
6637 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6638 {
6639 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6640 complete = -1;
6641 else
6642 {
6643 bytes_left = 1;
6644 codepoint = c & 0x1f;
6645 }
6646 }
6647 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6648 {
6649 bytes_left = 2;
6650 codepoint = c & 0x0f;
6651 }
6652 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6653 {
6654 bytes_left = 3;
6655 codepoint = c & 0x07;
6656 }
6657 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6658 complete = -1;
6659
6660 seq_buff[index++] = c;
6661 seq_len = bytes_left + 1;
6662 } /* if(bytes_left) */
6663
6664 if (complete != 0)
6665 {
6666 bytes_left = index = 0;
6667 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6668 }
6669 if ((complete == 1) && ((c & 0x80) == 0))
6670 /* ASCII character follows incomplete sequence */
6671 yield = string_cat(yield, &size, &ptr, &c, 1);
6672 }
6673 continue;
6674 }
6675
6676 #ifdef EXPERIMENTAL_INTERNATIONAL
6677 case EOP_UTF8_DOMAIN_TO_ALABEL:
6678 {
6679 uschar * error = NULL;
6680 uschar * s = string_domain_utf8_to_alabel(sub, &error);
6681 if (error)
6682 {
6683 expand_string_message = string_sprintf(
6684 "error converting utf8 (%s) to alabel: %s",
6685 string_printing(sub), error);
6686 goto EXPAND_FAILED;
6687 }
6688 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6689 continue;
6690 }
6691
6692 case EOP_UTF8_DOMAIN_FROM_ALABEL:
6693 {
6694 uschar * error = NULL;
6695 uschar * s = string_domain_alabel_to_utf8(sub, &error);
6696 if (error)
6697 {
6698 expand_string_message = string_sprintf(
6699 "error converting alabel (%s) to utf8: %s",
6700 string_printing(sub), error);
6701 goto EXPAND_FAILED;
6702 }
6703 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6704 continue;
6705 }
6706
6707 case EOP_UTF8_LOCALPART_TO_ALABEL:
6708 {
6709 uschar * error = NULL;
6710 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
6711 if (error)
6712 {
6713 expand_string_message = string_sprintf(
6714 "error converting utf8 (%s) to alabel: %s",
6715 string_printing(sub), error);
6716 goto EXPAND_FAILED;
6717 }
6718 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6719 DEBUG(D_expand) debug_printf("yield: '%s'\n", yield);
6720 continue;
6721 }
6722
6723 case EOP_UTF8_LOCALPART_FROM_ALABEL:
6724 {
6725 uschar * error = NULL;
6726 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
6727 if (error)
6728 {
6729 expand_string_message = string_sprintf(
6730 "error converting alabel (%s) to utf8: %s",
6731 string_printing(sub), error);
6732 goto EXPAND_FAILED;
6733 }
6734 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6735 continue;
6736 }
6737 #endif /* EXPERIMENTAL_INTERNATIONAL */
6738
6739 /* escape turns all non-printing characters into escape sequences. */
6740
6741 case EOP_ESCAPE:
6742 {
6743 const uschar *t = string_printing(sub);
6744 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6745 continue;
6746 }
6747
6748 /* Handle numeric expression evaluation */
6749
6750 case EOP_EVAL:
6751 case EOP_EVAL10:
6752 {
6753 uschar *save_sub = sub;
6754 uschar *error = NULL;
6755 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6756 if (error != NULL)
6757 {
6758 expand_string_message = string_sprintf("error in expression "
6759 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6760 save_sub);
6761 goto EXPAND_FAILED;
6762 }
6763 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6764 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6765 continue;
6766 }
6767
6768 /* Handle time period formating */
6769
6770 case EOP_TIME_EVAL:
6771 {
6772 int n = readconf_readtime(sub, 0, FALSE);
6773 if (n < 0)
6774 {
6775 expand_string_message = string_sprintf("string \"%s\" is not an "
6776 "Exim time interval in \"%s\" operator", sub, name);
6777 goto EXPAND_FAILED;
6778 }
6779 sprintf(CS var_buffer, "%d", n);
6780 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6781 continue;
6782 }
6783
6784 case EOP_TIME_INTERVAL:
6785 {
6786 int n;
6787 uschar *t = read_number(&n, sub);
6788 if (*t != 0) /* Not A Number*/
6789 {
6790 expand_string_message = string_sprintf("string \"%s\" is not a "
6791 "positive number in \"%s\" operator", sub, name);
6792 goto EXPAND_FAILED;
6793 }
6794 t = readconf_printtime(n);
6795 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6796 continue;
6797 }
6798
6799 /* Convert string to base64 encoding */
6800
6801 case EOP_STR2B64:
6802 {
6803 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6804 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6805 continue;
6806 }
6807
6808 /* strlen returns the length of the string */
6809
6810 case EOP_STRLEN:
6811 {
6812 uschar buff[24];
6813 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6814 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6815 continue;
6816 }
6817
6818 /* length_n or l_n takes just the first n characters or the whole string,
6819 whichever is the shorter;
6820
6821 substr_m_n, and s_m_n take n characters from offset m; negative m take
6822 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6823 takes the rest, either to the right or to the left.
6824
6825 hash_n or h_n makes a hash of length n from the string, yielding n
6826 characters from the set a-z; hash_n_m makes a hash of length n, but
6827 uses m characters from the set a-zA-Z0-9.
6828
6829 nhash_n returns a single number between 0 and n-1 (in text form), while
6830 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6831 between 0 and n-1 and the second between 0 and m-1. */
6832
6833 case EOP_LENGTH:
6834 case EOP_L:
6835 case EOP_SUBSTR:
6836 case EOP_S:
6837 case EOP_HASH:
6838 case EOP_H:
6839 case EOP_NHASH:
6840 case EOP_NH:
6841 {
6842 int sign = 1;
6843 int value1 = 0;
6844 int value2 = -1;
6845 int *pn;
6846 int len;
6847 uschar *ret;
6848
6849 if (arg == NULL)
6850 {
6851 expand_string_message = string_sprintf("missing values after %s",
6852 name);
6853 goto EXPAND_FAILED;
6854 }
6855
6856 /* "length" has only one argument, effectively being synonymous with
6857 substr_0_n. */
6858
6859 if (c == EOP_LENGTH || c == EOP_L)
6860 {
6861 pn = &value2;
6862 value2 = 0;
6863 }
6864
6865 /* The others have one or two arguments; for "substr" the first may be
6866 negative. The second being negative means "not supplied". */
6867
6868 else
6869 {
6870 pn = &value1;
6871 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6872 }
6873
6874 /* Read up to two numbers, separated by underscores */
6875
6876 ret = arg;
6877 while (*arg != 0)
6878 {
6879 if (arg != ret && *arg == '_' && pn == &value1)
6880 {
6881 pn = &value2;
6882 value2 = 0;
6883 if (arg[1] != 0) arg++;
6884 }
6885 else if (!isdigit(*arg))
6886 {
6887 expand_string_message =
6888 string_sprintf("non-digit after underscore in \"%s\"", name);
6889 goto EXPAND_FAILED;
6890 }
6891 else *pn = (*pn)*10 + *arg++ - '0';
6892 }
6893 value1 *= sign;
6894
6895 /* Perform the required operation */
6896
6897 ret =
6898 (c == EOP_HASH || c == EOP_H)?
6899 compute_hash(sub, value1, value2, &len) :
6900 (c == EOP_NHASH || c == EOP_NH)?
6901 compute_nhash(sub, value1, value2, &len) :
6902 extract_substr(sub, value1, value2, &len);
6903
6904 if (ret == NULL) goto EXPAND_FAILED;
6905 yield = string_cat(yield, &size, &ptr, ret, len);
6906 continue;
6907 }
6908
6909 /* Stat a path */
6910
6911 case EOP_STAT:
6912 {
6913 uschar *s;
6914 uschar smode[12];
6915 uschar **modetable[3];
6916 int i;
6917 mode_t mode;
6918 struct stat st;
6919
6920 if ((expand_forbid & RDO_EXISTS) != 0)
6921 {
6922 expand_string_message = US"Use of the stat() expansion is not permitted";
6923 goto EXPAND_FAILED;
6924 }
6925
6926 if (stat(CS sub, &st) < 0)
6927 {
6928 expand_string_message = string_sprintf("stat(%s) failed: %s",
6929 sub, strerror(errno));
6930 goto EXPAND_FAILED;
6931 }
6932 mode = st.st_mode;
6933 switch (mode & S_IFMT)
6934 {
6935 case S_IFIFO: smode[0] = 'p'; break;
6936 case S_IFCHR: smode[0] = 'c'; break;
6937 case S_IFDIR: smode[0] = 'd'; break;
6938 case S_IFBLK: smode[0] = 'b'; break;
6939 case S_IFREG: smode[0] = '-'; break;
6940 default: smode[0] = '?'; break;
6941 }
6942
6943 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6944 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6945 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6946
6947 for (i = 0; i < 3; i++)
6948 {
6949 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6950 mode >>= 3;
6951 }
6952
6953 smode[10] = 0;
6954 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6955 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6956 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6957 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6958 (long)st.st_gid, st.st_size, (long)st.st_atime,
6959 (long)st.st_mtime, (long)st.st_ctime);
6960 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6961 continue;
6962 }
6963
6964 /* vaguely random number less than N */
6965
6966 case EOP_RANDINT:
6967 {
6968 int_eximarith_t max;
6969 uschar *s;
6970
6971 max = expanded_string_integer(sub, TRUE);
6972 if (expand_string_message != NULL)
6973 goto EXPAND_FAILED;
6974 s = string_sprintf("%d", vaguely_random_number((int)max));
6975 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6976 continue;
6977 }
6978
6979 /* Reverse IP, including IPv6 to dotted-nibble */
6980
6981 case EOP_REVERSE_IP:
6982 {
6983 int family, maskptr;
6984 uschar reversed[128];
6985
6986 family = string_is_ip_address(sub, &maskptr);
6987 if (family == 0)
6988 {
6989 expand_string_message = string_sprintf(
6990 "reverse_ip() not given an IP address [%s]", sub);
6991 goto EXPAND_FAILED;
6992 }
6993 invert_address(reversed, sub);
6994 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6995 continue;
6996 }
6997
6998 /* Unknown operator */
6999
7000 default:
7001 expand_string_message =
7002 string_sprintf("unknown expansion operator \"%s\"", name);
7003 goto EXPAND_FAILED;
7004 }
7005 }
7006
7007 /* Handle a plain name. If this is the first thing in the expansion, release
7008 the pre-allocated buffer. If the result data is known to be in a new buffer,
7009 newsize will be set to the size of that buffer, and we can just point at that
7010 store instead of copying. Many expansion strings contain just one reference,
7011 so this is a useful optimization, especially for humungous headers
7012 ($message_headers). */
7013 /*{*/
7014 if (*s++ == '}')
7015 {
7016 int len;
7017 int newsize = 0;
7018 if (ptr == 0)
7019 {
7020 if (resetok) store_reset(yield);
7021 yield = NULL;
7022 size = 0;
7023 }
7024 value = find_variable(name, FALSE, skipping, &newsize);
7025 if (value == NULL)
7026 {
7027 expand_string_message =
7028 string_sprintf("unknown variable in \"${%s}\"", name);
7029 check_variable_error_message(name);
7030 goto EXPAND_FAILED;
7031 }
7032 len = Ustrlen(value);
7033 if (yield == NULL && newsize != 0)
7034 {
7035 yield = value;
7036 size = newsize;
7037 ptr = len;
7038 }
7039 else yield = string_cat(yield, &size, &ptr, value, len);
7040 continue;
7041 }
7042
7043 /* Else there's something wrong */
7044
7045 expand_string_message =
7046 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7047 "in a variable reference)", name);
7048 goto EXPAND_FAILED;
7049 }
7050
7051 /* If we hit the end of the string when ket_ends is set, there is a missing
7052 terminating brace. */
7053
7054 if (ket_ends && *s == 0)
7055 {
7056 expand_string_message = malformed_header?
7057 US"missing } at end of string - could be header name not terminated by colon"
7058 :
7059 US"missing } at end of string";
7060 goto EXPAND_FAILED;
7061 }
7062
7063 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7064 added to the string. If so, set up an empty string. Add a terminating zero. If
7065 left != NULL, return a pointer to the terminator. */
7066
7067 if (yield == NULL) yield = store_get(1);
7068 yield[ptr] = 0;
7069 if (left != NULL) *left = s;
7070
7071 /* Any stacking store that was used above the final string is no longer needed.
7072 In many cases the final string will be the first one that was got and so there
7073 will be optimal store usage. */
7074
7075 if (resetok) store_reset(yield + ptr + 1);
7076 else if (resetok_p) *resetok_p = FALSE;
7077
7078 DEBUG(D_expand)
7079 {
7080 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
7081 yield);
7082 if (skipping) debug_printf("skipping: result is not used\n");
7083 }
7084 return yield;
7085
7086 /* This is the failure exit: easiest to program with a goto. We still need
7087 to update the pointer to the terminator, for cases of nested calls with "fail".
7088 */
7089
7090 EXPAND_FAILED_CURLY:
7091 expand_string_message = malformed_header?
7092 US"missing or misplaced { or } - could be header name not terminated by colon"
7093 :
7094 US"missing or misplaced { or }";
7095
7096 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7097 that is a bad idea, because expand_string_message is in dynamic store. */
7098
7099 EXPAND_FAILED:
7100 if (left != NULL) *left = s;
7101 DEBUG(D_expand)
7102 {
7103 debug_printf("failed to expand: %s\n", string);
7104 debug_printf(" error message: %s\n", expand_string_message);
7105 if (expand_string_forcedfail) debug_printf("failure was forced\n");
7106 }
7107 if (resetok_p) *resetok_p = resetok;
7108 return NULL;
7109 }
7110
7111
7112 /* This is the external function call. Do a quick check for any expansion
7113 metacharacters, and if there are none, just return the input string.
7114
7115 Argument: the string to be expanded
7116 Returns: the expanded string, or NULL if expansion failed; if failure was
7117 due to a lookup deferring, search_find_defer will be TRUE
7118 */
7119
7120 uschar *
7121 expand_string(uschar *string)
7122 {
7123 search_find_defer = FALSE;
7124 malformed_header = FALSE;
7125 return (Ustrpbrk(string, "$\\") == NULL)? string :
7126 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7127 }
7128
7129
7130
7131 const uschar *
7132 expand_cstring(const uschar *string)
7133 {
7134 search_find_defer = FALSE;
7135 malformed_header = FALSE;
7136 return (Ustrpbrk(string, "$\\") == NULL)? string :
7137 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7138 }
7139
7140
7141
7142 /*************************************************
7143 * Expand and copy *
7144 *************************************************/
7145
7146 /* Now and again we want to expand a string and be sure that the result is in a
7147 new bit of store. This function does that.
7148 Since we know it has been copied, the de-const cast is safe.
7149
7150 Argument: the string to be expanded
7151 Returns: the expanded string, always in a new bit of store, or NULL
7152 */
7153
7154 uschar *
7155 expand_string_copy(const uschar *string)
7156 {
7157 const uschar *yield = expand_cstring(string);
7158 if (yield == string) yield = string_copy(string);
7159 return US yield;
7160 }
7161
7162
7163
7164 /*************************************************
7165 * Expand and interpret as an integer *
7166 *************************************************/
7167
7168 /* Expand a string, and convert the result into an integer.
7169
7170 Arguments:
7171 string the string to be expanded
7172 isplus TRUE if a non-negative number is expected
7173
7174 Returns: the integer value, or
7175 -1 for an expansion error ) in both cases, message in
7176 -2 for an integer interpretation error ) expand_string_message
7177 expand_string_message is set NULL for an OK integer
7178 */
7179
7180 int_eximarith_t
7181 expand_string_integer(uschar *string, BOOL isplus)
7182 {
7183 return expanded_string_integer(expand_string(string), isplus);
7184 }
7185
7186
7187 /*************************************************
7188 * Interpret string as an integer *
7189 *************************************************/
7190
7191 /* Convert a string (that has already been expanded) into an integer.
7192
7193 This function is used inside the expansion code.
7194
7195 Arguments:
7196 s the string to be expanded
7197 isplus TRUE if a non-negative number is expected
7198
7199 Returns: the integer value, or
7200 -1 if string is NULL (which implies an expansion error)
7201 -2 for an integer interpretation error
7202 expand_string_message is set NULL for an OK integer
7203 */
7204
7205 static int_eximarith_t
7206 expanded_string_integer(const uschar *s, BOOL isplus)
7207 {
7208 int_eximarith_t value;
7209 uschar *msg = US"invalid integer \"%s\"";
7210 uschar *endptr;
7211
7212 /* If expansion failed, expand_string_message will be set. */
7213
7214 if (s == NULL) return -1;
7215
7216 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7217 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7218 systems, so we set it zero ourselves. */
7219
7220 errno = 0;
7221 expand_string_message = NULL; /* Indicates no error */
7222
7223 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7224 equal to 0. Unfortunately, people actually relied upon that, so preserve
7225 the behaviour explicitly. Stripping leading whitespace is a harmless
7226 noop change since strtol skips it anyway (provided that there is a number
7227 to find at all). */
7228 if (isspace(*s))
7229 {
7230 while (isspace(*s)) ++s;
7231 if (*s == '\0')
7232 {
7233 DEBUG(D_expand)
7234 debug_printf("treating blank string as number 0\n");
7235 return 0;
7236 }
7237 }
7238
7239 value = strtoll(CS s, CSS &endptr, 10);
7240
7241 if (endptr == s)
7242 {
7243 msg = US"integer expected but \"%s\" found";
7244 }
7245 else if (value < 0 && isplus)
7246 {
7247 msg = US"non-negative integer expected but \"%s\" found";
7248 }
7249 else
7250 {
7251 switch (tolower(*endptr))
7252 {
7253 default:
7254 break;
7255 case 'k':
7256 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7257 else value *= 1024;
7258 endptr++;
7259 break;
7260 case 'm':
7261 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7262 else value *= 1024*1024;
7263 endptr++;
7264 break;
7265 case 'g':
7266 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7267 else value *= 1024*1024*1024;
7268 endptr++;
7269 break;
7270 }
7271 if (errno == ERANGE)
7272 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7273 else
7274 {
7275 while (isspace(*endptr)) endptr++;
7276 if (*endptr == 0) return value;
7277 }
7278 }
7279
7280 expand_string_message = string_sprintf(CS msg, s);
7281 return -2;
7282 }
7283
7284
7285 /* These values are usually fixed boolean values, but they are permitted to be
7286 expanded strings.
7287
7288 Arguments:
7289 addr address being routed
7290 mtype the module type
7291 mname the module name
7292 dbg_opt debug selectors
7293 oname the option name
7294 bvalue the router's boolean value
7295 svalue the router's string value
7296 rvalue where to put the returned value
7297
7298 Returns: OK value placed in rvalue
7299 DEFER expansion failed
7300 */
7301
7302 int
7303 exp_bool(address_item *addr,
7304 uschar *mtype, uschar *mname, unsigned dbg_opt,
7305 uschar *oname, BOOL bvalue,
7306 uschar *svalue, BOOL *rvalue)
7307 {
7308 uschar *expanded;
7309 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7310
7311 expanded = expand_string(svalue);
7312 if (expanded == NULL)
7313 {
7314 if (expand_string_forcedfail)
7315 {
7316 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7317 *rvalue = bvalue;
7318 return OK;
7319 }
7320 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7321 oname, mname, mtype, expand_string_message);
7322 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7323 return DEFER;
7324 }
7325
7326 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7327 expanded);
7328
7329 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7330 *rvalue = TRUE;
7331 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7332 *rvalue = FALSE;
7333 else
7334 {
7335 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7336 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7337 return DEFER;
7338 }
7339
7340 return OK;
7341 }
7342
7343
7344
7345
7346 /*************************************************
7347 **************************************************
7348 * Stand-alone test program *
7349 **************************************************
7350 *************************************************/
7351
7352 #ifdef STAND_ALONE
7353
7354
7355 BOOL
7356 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7357 {
7358 int ovector[3*(EXPAND_MAXN+1)];
7359 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7360 ovector, nelem(ovector));
7361 BOOL yield = n >= 0;
7362 if (n == 0) n = EXPAND_MAXN + 1;
7363 if (yield)
7364 {
7365 int nn;
7366 expand_nmax = (setup < 0)? 0 : setup + 1;
7367 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7368 {
7369 expand_nstring[expand_nmax] = subject + ovector[nn];
7370 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7371 }
7372 expand_nmax--;
7373 }
7374 return yield;
7375 }
7376
7377
7378 int main(int argc, uschar **argv)
7379 {
7380 int i;
7381 uschar buffer[1024];
7382
7383 debug_selector = D_v;
7384 debug_file = stderr;
7385 debug_fd = fileno(debug_file);
7386 big_buffer = malloc(big_buffer_size);
7387
7388 for (i = 1; i < argc; i++)
7389 {
7390 if (argv[i][0] == '+')
7391 {
7392 debug_trace_memory = 2;
7393 argv[i]++;
7394 }
7395 if (isdigit(argv[i][0]))
7396 debug_selector = Ustrtol(argv[i], NULL, 0);
7397 else
7398 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7399 Ustrlen(argv[i]))
7400 {
7401 #ifdef LOOKUP_LDAP
7402 eldap_default_servers = argv[i];
7403 #endif
7404 #ifdef LOOKUP_MYSQL
7405 mysql_servers = argv[i];
7406 #endif
7407 #ifdef LOOKUP_PGSQL
7408 pgsql_servers = argv[i];
7409 #endif
7410 #ifdef EXPERIMENTAL_REDIS
7411 redis_servers = argv[i];
7412 #endif
7413 }
7414 #ifdef EXIM_PERL
7415 else opt_perl_startup = argv[i];
7416 #endif
7417 }
7418
7419 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7420
7421 expand_nstring[1] = US"string 1....";
7422 expand_nlength[1] = 8;
7423 expand_nmax = 1;
7424
7425 #ifdef EXIM_PERL
7426 if (opt_perl_startup != NULL)
7427 {
7428 uschar *errstr;
7429 printf("Starting Perl interpreter\n");
7430 errstr = init_perl(opt_perl_startup);
7431 if (errstr != NULL)
7432 {
7433 printf("** error in perl_startup code: %s\n", errstr);
7434 return EXIT_FAILURE;
7435 }
7436 }
7437 #endif /* EXIM_PERL */
7438
7439 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7440 {
7441 void *reset_point = store_get(0);
7442 uschar *yield = expand_string(buffer);
7443 if (yield != NULL)
7444 {
7445 printf("%s\n", yield);
7446 store_reset(reset_point);
7447 }
7448 else
7449 {
7450 if (search_find_defer) printf("search_find deferred\n");
7451 printf("Failed: %s\n", expand_string_message);
7452 if (expand_string_forcedfail) printf("Forced failure\n");
7453 printf("\n");
7454 }
7455 }
7456
7457 search_tidyup();
7458
7459 return 0;
7460 }
7461
7462 #endif
7463
7464 /* vi: aw ai sw=2
7465 */
7466 /* End of expand.c */