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