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