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