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