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