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