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