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