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