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