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