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