Sqlite: new main option sqlite_dbfile
[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
691ca88c
JH
1794 + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "%s",
1795 expand_string(notifier_socket));
2f2dd3a5
JH
1796#else
1797len = offsetof(struct sockaddr_un, sun_path)
691ca88c
JH
1798 + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s",
1799 expand_string(notifier_socket));
2f2dd3a5 1800#endif
04403ab0 1801
3978c243 1802if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
8d2cbee4 1803 { where = US"connect"; goto bad2; }
04403ab0
JH
1804
1805buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1806if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1807
8d2cbee4
JH
1808FD_ZERO(&fds); FD_SET(fd, &fds);
1809tv.tv_sec = 2; tv.tv_usec = 0;
1810if (select(fd + 1, (SELECT_ARG2_TYPE *)&fds, NULL, NULL, &tv) != 1)
1811 {
1812 DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1813 len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1814 }
1815else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1816 { where = US"recv"; goto bad2; }
04403ab0
JH
1817
1818close(fd);
2f2dd3a5
JH
1819#ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1820Uunlink(sname);
1821#endif
04403ab0
JH
1822return string_copyn(buf, len);
1823
8d2cbee4
JH
1824bad2:
1825#ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1826 Uunlink(sname);
1827#endif
04403ab0
JH
1828bad:
1829 close(fd);
1830 DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1831 return NULL;
1832}
1833
1834
059ec3d9
PH
1835/*************************************************
1836* Find value of a variable *
1837*************************************************/
1838
1839/* The table of variables is kept in alphabetic order, so we can search it
1840using a binary chop. The "choplen" variable is nothing to do with the binary
1841chop.
1842
1843Arguments:
1844 name the name of the variable being sought
1845 exists_only TRUE if this is a def: test; passed on to find_header()
1846 skipping TRUE => skip any processing evaluation; this is not the same as
1847 exists_only because def: may test for values that are first
1848 evaluated here
1849 newsize pointer to an int which is initially zero; if the answer is in
1850 a new memory buffer, *newsize is set to its size
1851
1852Returns: NULL if the variable does not exist, or
1853 a pointer to the variable's contents, or
1854 something non-NULL if exists_only is TRUE
1855*/
1856
1857static uschar *
1858find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1859{
9d1c15ef
JH
1860var_entry * vp;
1861uschar *s, *domain;
1862uschar **ss;
1863void * val;
059ec3d9 1864
38a0a95f
PH
1865/* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1866Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1867release 4.64 onwards arbitrary names are permitted, as long as the first 5
641cb756
PH
1868characters are acl_c or acl_m and the sixth is either a digit or an underscore
1869(this gave backwards compatibility at the changeover). There may be built-in
1870variables whose names start acl_ but they should never start in this way. This
1871slightly messy specification is a consequence of the history, needless to say.
47ca6d6c 1872
38a0a95f
PH
1873If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1874set, in which case give an error. */
47ca6d6c 1875
641cb756
PH
1876if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1877 !isalpha(name[5]))
38a0a95f 1878 {
fa7b17bd
JH
1879 tree_node * node =
1880 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1881 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1882 }
1883else if (Ustrncmp(name, "r_", 2) == 0)
1884 {
1885 tree_node * node = tree_search(router_var, name + 2);
63df3f26 1886 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
47ca6d6c
PH
1887 }
1888
38a0a95f 1889/* Handle $auth<n> variables. */
f78eb7c6
PH
1890
1891if (Ustrncmp(name, "auth", 4) == 0)
1892 {
1893 uschar *endptr;
1894 int n = Ustrtoul(name + 4, &endptr, 10);
1895 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
f38917cc
JH
1896 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1897 }
1898else if (Ustrncmp(name, "regex", 5) == 0)
1899 {
1900 uschar *endptr;
1901 int n = Ustrtoul(name + 5, &endptr, 10);
1902 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1903 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
f78eb7c6
PH
1904 }
1905
47ca6d6c
PH
1906/* For all other variables, search the table */
1907
9d1c15ef
JH
1908if (!(vp = find_var_ent(name)))
1909 return NULL; /* Unknown variable name */
059ec3d9 1910
9d1c15ef
JH
1911/* Found an existing variable. If in skipping state, the value isn't needed,
1912and we want to avoid processing (such as looking up the host name). */
059ec3d9 1913
9d1c15ef
JH
1914if (skipping)
1915 return US"";
059ec3d9 1916
9d1c15ef
JH
1917val = vp->value;
1918switch (vp->type)
1919 {
1920 case vtype_filter_int:
8768d548 1921 if (!f.filter_running) return NULL;
63df3f26
JH
1922 /* Fall through */
1923 /* VVVVVVVVVVVV */
9d1c15ef 1924 case vtype_int:
63df3f26
JH
1925 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1926 return var_buffer;
9d1c15ef
JH
1927
1928 case vtype_ino:
63df3f26
JH
1929 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1930 return var_buffer;
9d1c15ef
JH
1931
1932 case vtype_gid:
63df3f26
JH
1933 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1934 return var_buffer;
9d1c15ef
JH
1935
1936 case vtype_uid:
63df3f26
JH
1937 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1938 return var_buffer;
9d1c15ef
JH
1939
1940 case vtype_bool:
63df3f26
JH
1941 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1942 return var_buffer;
9d1c15ef
JH
1943
1944 case vtype_stringptr: /* Pointer to string */
63df3f26 1945 return (s = *((uschar **)(val))) ? s : US"";
9d1c15ef
JH
1946
1947 case vtype_pid:
63df3f26
JH
1948 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1949 return var_buffer;
9d1c15ef
JH
1950
1951 case vtype_load_avg:
63df3f26
JH
1952 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1953 return var_buffer;
9d1c15ef
JH
1954
1955 case vtype_host_lookup: /* Lookup if not done so */
2d0dc929
JH
1956 if ( !sender_host_name && sender_host_address
1957 && !host_lookup_failed && host_name_lookup() == OK)
63df3f26 1958 host_build_sender_fullhost();
2d0dc929 1959 return sender_host_name ? sender_host_name : US"";
9d1c15ef
JH
1960
1961 case vtype_localpart: /* Get local part from address */
f3ebb786
JH
1962 if (!(s = *((uschar **)(val)))) return US"";
1963 if (!(domain = Ustrrchr(s, '@'))) return s;
63df3f26
JH
1964 if (domain - s > sizeof(var_buffer) - 1)
1965 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1966 " in string expansion", sizeof(var_buffer));
f3ebb786 1967 return string_copyn(s, domain - s);
9d1c15ef
JH
1968
1969 case vtype_domain: /* Get domain from address */
f3ebb786 1970 if (!(s = *((uschar **)(val)))) return US"";
63df3f26 1971 domain = Ustrrchr(s, '@');
f3ebb786 1972 return domain ? domain + 1 : US"";
9d1c15ef
JH
1973
1974 case vtype_msgheaders:
bce15b62 1975 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
9d1c15ef
JH
1976
1977 case vtype_msgheaders_raw:
bce15b62
JH
1978 return find_header(NULL, newsize,
1979 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
9d1c15ef
JH
1980
1981 case vtype_msgbody: /* Pointer to msgbody string */
1982 case vtype_msgbody_end: /* Ditto, the end of the msg */
63df3f26 1983 ss = (uschar **)(val);
d315eda1 1984 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
059ec3d9 1985 {
63df3f26
JH
1986 uschar *body;
1987 off_t start_offset = SPOOL_DATA_START_OFFSET;
1988 int len = message_body_visible;
1989 if (len > message_size) len = message_size;
1990 *ss = body = store_malloc(len+1);
1991 body[0] = 0;
1992 if (vp->type == vtype_msgbody_end)
9d1c15ef 1993 {
63df3f26
JH
1994 struct stat statbuf;
1995 if (fstat(deliver_datafile, &statbuf) == 0)
1996 {
1997 start_offset = statbuf.st_size - len;
1998 if (start_offset < SPOOL_DATA_START_OFFSET)
1999 start_offset = SPOOL_DATA_START_OFFSET;
2000 }
9d1c15ef 2001 }
d4ff61d1
JH
2002 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
2003 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
2004 strerror(errno));
63df3f26
JH
2005 len = read(deliver_datafile, body, len);
2006 if (len > 0)
9d1c15ef 2007 {
63df3f26
JH
2008 body[len] = 0;
2009 if (message_body_newlines) /* Separate loops for efficiency */
2010 while (len > 0)
2011 { if (body[--len] == 0) body[len] = ' '; }
2012 else
2013 while (len > 0)
2014 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
9d1c15ef 2015 }
059ec3d9 2016 }
d315eda1 2017 return *ss ? *ss : US"";
059ec3d9 2018
9d1c15ef 2019 case vtype_todbsdin: /* BSD inbox time of day */
63df3f26 2020 return tod_stamp(tod_bsdin);
059ec3d9 2021
9d1c15ef 2022 case vtype_tode: /* Unix epoch time of day */
63df3f26 2023 return tod_stamp(tod_epoch);
059ec3d9 2024
9d1c15ef 2025 case vtype_todel: /* Unix epoch/usec time of day */
63df3f26 2026 return tod_stamp(tod_epoch_l);
f5787926 2027
9d1c15ef 2028 case vtype_todf: /* Full time of day */
63df3f26 2029 return tod_stamp(tod_full);
059ec3d9 2030
9d1c15ef 2031 case vtype_todl: /* Log format time of day */
63df3f26 2032 return tod_stamp(tod_log_bare); /* (without timezone) */
059ec3d9 2033
9d1c15ef 2034 case vtype_todzone: /* Time zone offset only */
63df3f26 2035 return tod_stamp(tod_zone);
059ec3d9 2036
9d1c15ef 2037 case vtype_todzulu: /* Zulu time */
63df3f26 2038 return tod_stamp(tod_zulu);
059ec3d9 2039
9d1c15ef 2040 case vtype_todlf: /* Log file datestamp tod */
63df3f26 2041 return tod_stamp(tod_log_datestamp_daily);
059ec3d9 2042
9d1c15ef 2043 case vtype_reply: /* Get reply address */
bce15b62
JH
2044 s = find_header(US"reply-to:", newsize,
2045 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2046 headers_charset);
9cffa436
JH
2047 if (s) while (isspace(*s)) s++;
2048 if (!s || !*s)
63df3f26
JH
2049 {
2050 *newsize = 0; /* For the *s==0 case */
bce15b62
JH
2051 s = find_header(US"from:", newsize,
2052 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2053 headers_charset);
63df3f26 2054 }
9cffa436 2055 if (s)
63df3f26
JH
2056 {
2057 uschar *t;
2058 while (isspace(*s)) s++;
2059 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
2060 while (t > s && isspace(t[-1])) t--;
2061 *t = 0;
2062 }
9cffa436 2063 return s ? s : US"";
059ec3d9 2064
9d1c15ef
JH
2065 case vtype_string_func:
2066 {
6d95688d 2067 stringptr_fn_t * fn = (stringptr_fn_t *) val;
9d1c15ef
JH
2068 return fn();
2069 }
8e669ac1 2070
9d1c15ef
JH
2071 case vtype_pspace:
2072 {
2073 int inodes;
8c513105 2074 sprintf(CS var_buffer, PR_EXIM_ARITH,
9d1c15ef
JH
2075 receive_statvfs(val == (void *)TRUE, &inodes));
2076 }
2077 return var_buffer;
8e669ac1 2078
9d1c15ef
JH
2079 case vtype_pinodes:
2080 {
2081 int inodes;
2082 (void) receive_statvfs(val == (void *)TRUE, &inodes);
2083 sprintf(CS var_buffer, "%d", inodes);
2084 }
2085 return var_buffer;
80a47a2c 2086
9d1c15ef 2087 case vtype_cert:
63df3f26 2088 return *(void **)val ? US"<cert>" : US"";
80a47a2c 2089
63df3f26 2090#ifndef DISABLE_DKIM
9d1c15ef 2091 case vtype_dkim:
63df3f26
JH
2092 return dkim_exim_expand_query((int)(long)val);
2093#endif
059ec3d9 2094
9d1c15ef 2095 }
6c08476d
LM
2096
2097return NULL; /* Unknown variable. Silences static checkers. */
059ec3d9
PH
2098}
2099
2100
2101
2102
d9b2312b
JH
2103void
2104modify_variable(uschar *name, void * value)
2105{
9d1c15ef
JH
2106var_entry * vp;
2107if ((vp = find_var_ent(name))) vp->value = value;
d9b2312b
JH
2108return; /* Unknown variable name, fail silently */
2109}
2110
2111
2112
2113
2114
cf0812d5 2115
059ec3d9
PH
2116/*************************************************
2117* Read and expand substrings *
2118*************************************************/
2119
2120/* This function is called to read and expand argument substrings for various
2121expansion items. Some have a minimum requirement that is less than the maximum;
2122in these cases, the first non-present one is set to NULL.
2123
2124Arguments:
2125 sub points to vector of pointers to set
2126 n maximum number of substrings
2127 m minimum required
2128 sptr points to current string pointer
2129 skipping the skipping flag
2130 check_end if TRUE, check for final '}'
2131 name name of item, for error message
b0e85a8f
JH
2132 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2133 the store.
059ec3d9
PH
2134
2135Returns: 0 OK; string pointer updated
2136 1 curly bracketing error (too few arguments)
2137 2 too many arguments (only if check_end is set); message set
2138 3 other error (expansion failure)
2139*/
2140
2141static int
55414b25 2142read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
b0e85a8f 2143 BOOL check_end, uschar *name, BOOL *resetok)
059ec3d9 2144{
55414b25 2145const uschar *s = *sptr;
059ec3d9
PH
2146
2147while (isspace(*s)) s++;
d7978c0f 2148for (int i = 0; i < n; i++)
059ec3d9
PH
2149 {
2150 if (*s != '{')
2151 {
e47376be
JH
2152 if (i < m)
2153 {
2154 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2155 "(min is %d)", name, m);
2156 return 1;
2157 }
059ec3d9
PH
2158 sub[i] = NULL;
2159 break;
2160 }
e47376be
JH
2161 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2162 return 3;
059ec3d9
PH
2163 if (*s++ != '}') return 1;
2164 while (isspace(*s)) s++;
2165 }
2166if (check_end && *s++ != '}')
2167 {
2168 if (s[-1] == '{')
2169 {
e47376be 2170 expand_string_message = string_sprintf("Too many arguments for '%s' "
059ec3d9
PH
2171 "(max is %d)", name, n);
2172 return 2;
2173 }
e47376be 2174 expand_string_message = string_sprintf("missing '}' after '%s'", name);
059ec3d9
PH
2175 return 1;
2176 }
2177
2178*sptr = s;
2179return 0;
2180}
2181
2182
2183
2184
641cb756
PH
2185/*************************************************
2186* Elaborate message for bad variable *
2187*************************************************/
2188
2189/* For the "unknown variable" message, take a look at the variable's name, and
2190give additional information about possible ACL variables. The extra information
2191is added on to expand_string_message.
2192
2193Argument: the name of the variable
2194Returns: nothing
2195*/
2196
2197static void
2198check_variable_error_message(uschar *name)
2199{
2200if (Ustrncmp(name, "acl_", 4) == 0)
2201 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2202 (name[4] == 'c' || name[4] == 'm')?
2203 (isalpha(name[5])?
2204 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2205 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2206 ) :
2207 US"user-defined ACL variables must start acl_c or acl_m");
2208}
2209
2210
2211
f60d98e8
JH
2212/*
2213Load args from sub array to globals, and call acl_check().
ef21c07d 2214Sub array will be corrupted on return.
f60d98e8
JH
2215
2216Returns: OK access is granted by an ACCEPT verb
6e3b198d 2217 DISCARD access is (apparently) granted by a DISCARD verb
f60d98e8
JH
2218 FAIL access is denied
2219 FAIL_DROP access is denied; drop the connection
2220 DEFER can't tell at the moment
2221 ERROR disaster
2222*/
2223static int
2224eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2225{
2226int i;
ef21c07d
JH
2227int sav_narg = acl_narg;
2228int ret;
93a6fce2 2229uschar * dummy_logmsg;
faa05a93 2230extern int acl_where;
f60d98e8 2231
0539a19d 2232if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
ef21c07d
JH
2233for (i = 0; i < nsub && sub[i+1]; i++)
2234 {
93a6fce2 2235 uschar * tmp = acl_arg[i];
ef21c07d
JH
2236 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2237 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2238 }
2239acl_narg = i;
bef3ea7f 2240while (i < nsub)
ef21c07d
JH
2241 {
2242 sub[i+1] = acl_arg[i];
2243 acl_arg[i++] = NULL;
2244 }
f60d98e8
JH
2245
2246DEBUG(D_expand)
e1d04f48 2247 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
f60d98e8 2248 sub[0],
60f8e1e8
JH
2249 acl_narg>0 ? acl_arg[0] : US"<none>",
2250 acl_narg>1 ? " +more" : "");
f60d98e8 2251
93a6fce2 2252ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
ef21c07d
JH
2253
2254for (i = 0; i < nsub; i++)
2255 acl_arg[i] = sub[i+1]; /* restore old args */
2256acl_narg = sav_narg;
2257
2258return ret;
f60d98e8
JH
2259}
2260
2261
2262
2263
7f69e814
JH
2264/* Return pointer to dewrapped string, with enclosing specified chars removed.
2265The given string is modified on return. Leading whitespace is skipped while
2266looking for the opening wrap character, then the rest is scanned for the trailing
2267(non-escaped) wrap character. A backslash in the string will act as an escape.
2268
2269A nul is written over the trailing wrap, and a pointer to the char after the
2270leading wrap is returned.
2271
2272Arguments:
2273 s String for de-wrapping
2274 wrap Two-char string, the first being the opener, second the closer wrapping
2275 character
2276Return:
2277 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2278*/
2279
2280static uschar *
2281dewrap(uschar * s, const uschar * wrap)
2282{
2283uschar * p = s;
2284unsigned depth = 0;
2285BOOL quotesmode = wrap[0] == wrap[1];
2286
2287while (isspace(*p)) p++;
2288
2289if (*p == *wrap)
2290 {
2291 s = ++p;
2292 wrap++;
2293 while (*p)
2294 {
2295 if (*p == '\\') p++;
2296 else if (!quotesmode && *p == wrap[-1]) depth++;
2297 else if (*p == *wrap)
2298 if (depth == 0)
2299 {
2300 *p = '\0';
2301 return s;
2302 }
2303 else
2304 depth--;
2305 p++;
2306 }
2307 }
2308expand_string_message = string_sprintf("missing '%c'", *wrap);
2309return NULL;
2310}
2311
2312
2313/* Pull off the leading array or object element, returning
2314a copy in an allocated string. Update the list pointer.
2315
2316The element may itself be an abject or array.
2317Return NULL when the list is empty.
2318*/
2319
2320static uschar *
2321json_nextinlist(const uschar ** list)
2322{
2323unsigned array_depth = 0, object_depth = 0;
2324const uschar * s = *list, * item;
2325
2326while (isspace(*s)) s++;
2327
2328for (item = s;
2329 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2330 s++)
2331 switch (*s)
2332 {
2333 case '[': array_depth++; break;
2334 case ']': array_depth--; break;
2335 case '{': object_depth++; break;
2336 case '}': object_depth--; break;
2337 }
2338*list = *s ? s+1 : s;
2339if (item == s) return NULL;
2340item = string_copyn(item, s - item);
2341DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2342return US item;
2343}
2344
2345
2346
21aa0597
JH
2347/************************************************/
2348/* Return offset in ops table, or -1 if not found.
2349Repoint to just after the operator in the string.
2350
2351Argument:
2352 ss string representation of operator
2353 opname split-out operator name
2354*/
2355
2356static int
2357identify_operator(const uschar ** ss, uschar ** opname)
2358{
2359const uschar * s = *ss;
2360uschar name[256];
2361
2362/* Numeric comparisons are symbolic */
2363
2364if (*s == '=' || *s == '>' || *s == '<')
2365 {
2366 int p = 0;
2367 name[p++] = *s++;
2368 if (*s == '=')
2369 {
2370 name[p++] = '=';
2371 s++;
2372 }
2373 name[p] = 0;
2374 }
2375
2376/* All other conditions are named */
2377
2378else
2379 s = read_name(name, sizeof(name), s, US"_");
2380*ss = s;
2381
2382/* If we haven't read a name, it means some non-alpha character is first. */
2383
2384if (!name[0])
2385 {
2386 expand_string_message = string_sprintf("condition name expected, "
2387 "but found \"%.16s\"", s);
2388 return -1;
2389 }
2390if (opname)
2391 *opname = string_copy(name);
2392
2393return chop_match(name, cond_table, nelem(cond_table));
2394}
2395
2396
7ef88aa0
JH
2397/*************************************************
2398* Handle MD5 or SHA-1 computation for HMAC *
2399*************************************************/
2400
2401/* These are some wrapping functions that enable the HMAC code to be a bit
2402cleaner. A good compiler will spot the tail recursion.
2403
2404Arguments:
2405 type HMAC_MD5 or HMAC_SHA1
2406 remaining are as for the cryptographic hash functions
2407
2408Returns: nothing
2409*/
2410
2411static void
2412chash_start(int type, void * base)
2413{
2414if (type == HMAC_MD5)
2415 md5_start((md5 *)base);
2416else
2417 sha1_start((hctx *)base);
2418}
2419
2420static void
2421chash_mid(int type, void * base, const uschar * string)
2422{
2423if (type == HMAC_MD5)
2424 md5_mid((md5 *)base, string);
2425else
2426 sha1_mid((hctx *)base, string);
2427}
2428
2429static void
2430chash_end(int type, void * base, const uschar * string, int length,
2431 uschar * digest)
2432{
2433if (type == HMAC_MD5)
2434 md5_end((md5 *)base, string, length, digest);
2435else
2436 sha1_end((hctx *)base, string, length, digest);
2437}
2438
2439
2440
2441
2442/* Do an hmac_md5. The result is _not_ nul-terminated, and is sized as
2443the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2444
2445Arguments:
2446 key encoding key, nul-terminated
2447 src data to be hashed, nul-terminated
2448 buf output buffer
2449 len size of output buffer
2450*/
2451
2452static void
2453hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2454{
2455md5 md5_base;
2456const uschar * keyptr;
2457uschar * p;
2458unsigned int keylen;
2459
2460#define MD5_HASHLEN 16
2461#define MD5_HASHBLOCKLEN 64
2462
2463uschar keyhash[MD5_HASHLEN];
2464uschar innerhash[MD5_HASHLEN];
2465uschar finalhash[MD5_HASHLEN];
2466uschar innerkey[MD5_HASHBLOCKLEN];
2467uschar outerkey[MD5_HASHBLOCKLEN];
2468
2469keyptr = key;
2470keylen = Ustrlen(keyptr);
2471
2472/* If the key is longer than the hash block length, then hash the key
2473first */
2474
2475if (keylen > MD5_HASHBLOCKLEN)
2476 {
2477 chash_start(HMAC_MD5, &md5_base);
2478 chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2479 keyptr = keyhash;
2480 keylen = MD5_HASHLEN;
2481 }
2482
2483/* Now make the inner and outer key values */
2484
2485memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2486memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2487
2488for (int i = 0; i < keylen; i++)
2489 {
2490 innerkey[i] ^= keyptr[i];
2491 outerkey[i] ^= keyptr[i];
2492 }
2493
2494/* Now do the hashes */
2495
2496chash_start(HMAC_MD5, &md5_base);
2497chash_mid(HMAC_MD5, &md5_base, innerkey);
2498chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2499
2500chash_start(HMAC_MD5, &md5_base);
2501chash_mid(HMAC_MD5, &md5_base, outerkey);
2502chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2503
2504/* Encode the final hash as a hex string, limited by output buffer size */
2505
2506p = buf;
2507for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2508 {
2509 if (j-- <= 0) break;
2510 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2511 if (j-- <= 0) break;
2512 *p++ = hex_digits[finalhash[i] & 0x0f];
2513 }
2514return;
2515}
2516
2517
059ec3d9
PH
2518/*************************************************
2519* Read and evaluate a condition *
2520*************************************************/
2521
2522/*
2523Arguments:
2524 s points to the start of the condition text
b0e85a8f
JH
2525 resetok points to a BOOL which is written false if it is unsafe to
2526 free memory. Certain condition types (acl) may have side-effect
2527 allocation which must be preserved.
059ec3d9
PH
2528 yield points to a BOOL to hold the result of the condition test;
2529 if NULL, we are just reading through a condition that is
2530 part of an "or" combination to check syntax, or in a state
2531 where the answer isn't required
2532
2533Returns: a pointer to the first character after the condition, or
2534 NULL after an error
2535*/
2536
55414b25
JH
2537static const uschar *
2538eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
059ec3d9
PH
2539{
2540BOOL testfor = TRUE;
2541BOOL tempcond, combined_cond;
2542BOOL *subcondptr;
5cfd2e57 2543BOOL sub2_honour_dollar = TRUE;
7f69e814 2544BOOL is_forany, is_json, is_jsons;
56dbf856 2545int rc, cond_type, roffset;
97d17305 2546int_eximarith_t num[2];
059ec3d9 2547struct stat statbuf;
21aa0597 2548uschar * opname;
059ec3d9 2549uschar name[256];
55414b25 2550const uschar *sub[10];
059ec3d9
PH
2551
2552const pcre *re;
2553const uschar *rerror;
2554
2555for (;;)
2556 {
2557 while (isspace(*s)) s++;
2558 if (*s == '!') { testfor = !testfor; s++; } else break;
2559 }
2560
21aa0597 2561switch(cond_type = identify_operator(&s, &opname))
059ec3d9 2562 {
9b4768fa
PH
2563 /* def: tests for a non-empty variable, or for the existence of a header. If
2564 yield == NULL we are in a skipping state, and don't care about the answer. */
059ec3d9
PH
2565
2566 case ECOND_DEF:
059ec3d9 2567 {
bce15b62 2568 uschar * t;
059ec3d9 2569
bce15b62
JH
2570 if (*s != ':')
2571 {
2572 expand_string_message = US"\":\" expected after \"def\"";
2573 return NULL;
2574 }
059ec3d9 2575
f3ebb786 2576 s = read_name(name, sizeof(name), s+1, US"_");
059ec3d9 2577
bce15b62
JH
2578 /* Test for a header's existence. If the name contains a closing brace
2579 character, this may be a user error where the terminating colon has been
2580 omitted. Set a flag to adjust a subsequent error message in this case. */
059ec3d9 2581
bce15b62
JH
2582 if ( ( *(t = name) == 'h'
2583 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2584 )
2585 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2586 )
2587 {
f3ebb786 2588 s = read_header_name(name, sizeof(name), s);
bce15b62
JH
2589 /* {-for-text-editors */
2590 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2591 if (yield) *yield =
2592 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2593 }
059ec3d9 2594
bce15b62
JH
2595 /* Test for a variable's having a non-empty value. A non-existent variable
2596 causes an expansion failure. */
2597
2598 else
059ec3d9 2599 {
bce15b62
JH
2600 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2601 {
f3ebb786
JH
2602 expand_string_message = name[0]
2603 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2604 : US"variable name omitted after \"def:\"";
bce15b62
JH
2605 check_variable_error_message(name);
2606 return NULL;
2607 }
2608 if (yield) *yield = (t[0] != 0) == testfor;
059ec3d9 2609 }
059ec3d9 2610
bce15b62
JH
2611 return s;
2612 }
059ec3d9
PH
2613
2614
2615 /* first_delivery tests for first delivery attempt */
2616
2617 case ECOND_FIRST_DELIVERY:
5694b905 2618 if (yield) *yield = f.deliver_firsttime == testfor;
059ec3d9
PH
2619 return s;
2620
2621
2622 /* queue_running tests for any process started by a queue runner */
2623
2624 case ECOND_QUEUE_RUNNING:
5694b905 2625 if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
059ec3d9
PH
2626 return s;
2627
2628
2629 /* exists: tests for file existence
2630 isip: tests for any IP address
2631 isip4: tests for an IPv4 address
2632 isip6: tests for an IPv6 address
2633 pam: does PAM authentication
2634 radius: does RADIUS authentication
2635 ldapauth: does LDAP authentication
2636 pwcheck: does Cyrus SASL pwcheck authentication
2637 */
2638
2639 case ECOND_EXISTS:
2640 case ECOND_ISIP:
2641 case ECOND_ISIP4:
2642 case ECOND_ISIP6:
2643 case ECOND_PAM:
2644 case ECOND_RADIUS:
2645 case ECOND_LDAPAUTH:
2646 case ECOND_PWCHECK:
2647
2648 while (isspace(*s)) s++;
b5b871ac 2649 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
059ec3d9 2650
b0e85a8f 2651 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
5694b905 2652 if (!sub[0]) return NULL;
b5b871ac 2653 /* {-for-text-editors */
059ec3d9
PH
2654 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2655
5694b905 2656 if (!yield) return s; /* No need to run the test if skipping */
059ec3d9
PH
2657
2658 switch(cond_type)
2659 {
2660 case ECOND_EXISTS:
2661 if ((expand_forbid & RDO_EXISTS) != 0)
2662 {
2663 expand_string_message = US"File existence tests are not permitted";
2664 return NULL;
2665 }
2666 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2667 break;
2668
2669 case ECOND_ISIP:
2670 case ECOND_ISIP4:
2671 case ECOND_ISIP6:
2672 rc = string_is_ip_address(sub[0], NULL);
7e66e54d 2673 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
059ec3d9
PH
2674 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2675 break;
2676
2677 /* Various authentication tests - all optionally compiled */
2678
2679 case ECOND_PAM:
2680 #ifdef SUPPORT_PAM
2681 rc = auth_call_pam(sub[0], &expand_string_message);
2682 goto END_AUTH;
2683 #else
2684 goto COND_FAILED_NOT_COMPILED;
2685 #endif /* SUPPORT_PAM */
2686
2687 case ECOND_RADIUS:
2688 #ifdef RADIUS_CONFIG_FILE
2689 rc = auth_call_radius(sub[0], &expand_string_message);
2690 goto END_AUTH;
2691 #else
2692 goto COND_FAILED_NOT_COMPILED;
2693 #endif /* RADIUS_CONFIG_FILE */
2694
2695 case ECOND_LDAPAUTH:
2696 #ifdef LOOKUP_LDAP
2697 {
2698 /* Just to keep the interface the same */
2699 BOOL do_cache;
2700 int old_pool = store_pool;
2701 store_pool = POOL_SEARCH;
2702 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2703 &expand_string_message, &do_cache);
2704 store_pool = old_pool;
2705 }
2706 goto END_AUTH;
2707 #else
2708 goto COND_FAILED_NOT_COMPILED;
2709 #endif /* LOOKUP_LDAP */
2710
2711 case ECOND_PWCHECK:
2712 #ifdef CYRUS_PWCHECK_SOCKET
2713 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2714 goto END_AUTH;
2715 #else
2716 goto COND_FAILED_NOT_COMPILED;
2717 #endif /* CYRUS_PWCHECK_SOCKET */
2718
2719 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2720 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2721 END_AUTH:
2722 if (rc == ERROR || rc == DEFER) return NULL;
2723 *yield = (rc == OK) == testfor;
2724 #endif
2725 }
2726 return s;
2727
2728
333eea9c
JH
2729 /* call ACL (in a conditional context). Accept true, deny false.
2730 Defer is a forced-fail. Anything set by message= goes to $value.
f60d98e8
JH
2731 Up to ten parameters are used; we use the braces round the name+args
2732 like the saslauthd condition does, to permit a variable number of args.
2733 See also the expansion-item version EITEM_ACL and the traditional
2734 acl modifier ACLC_ACL.
fd5dad68
JH
2735 Since the ACL may allocate new global variables, tell our caller to not
2736 reclaim memory.
f60d98e8 2737 */
333eea9c
JH
2738
2739 case ECOND_ACL:
bef3ea7f 2740 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
333eea9c 2741 {
55414b25 2742 uschar *sub[10];
333eea9c 2743 uschar *user_msg;
333eea9c 2744 BOOL cond = FALSE;
333eea9c
JH
2745
2746 while (isspace(*s)) s++;
6d9cfc47 2747 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
333eea9c 2748
0539a19d 2749 switch(read_subs(sub, nelem(sub), 1,
b0e85a8f 2750 &s, yield == NULL, TRUE, US"acl", resetok))
333eea9c 2751 {
f60d98e8
JH
2752 case 1: expand_string_message = US"too few arguments or bracketing "
2753 "error for acl";
2754 case 2:
2755 case 3: return NULL;
333eea9c 2756 }
f60d98e8 2757
5694b905 2758 if (yield)
9e70917d 2759 {
17ccbda6 2760 int rc;
9e70917d 2761 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
17ccbda6 2762 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
f60d98e8
JH
2763 {
2764 case OK:
2765 cond = TRUE;
2766 case FAIL:
bef3ea7f 2767 lookup_value = NULL;
f60d98e8 2768 if (user_msg)
acec9514 2769 lookup_value = string_copy(user_msg);
b5b871ac 2770 *yield = cond == testfor;
f60d98e8
JH
2771 break;
2772
2773 case DEFER:
8768d548 2774 f.expand_string_forcedfail = TRUE;
6e3b198d 2775 /*FALLTHROUGH*/
f60d98e8 2776 default:
17ccbda6
JH
2777 expand_string_message = string_sprintf("%s from acl \"%s\"",
2778 rc_names[rc], sub[0]);
f60d98e8
JH
2779 return NULL;
2780 }
9e70917d 2781 }
f60d98e8 2782 return s;
333eea9c 2783 }
333eea9c
JH
2784
2785
059ec3d9
PH
2786 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2787
b0e85a8f 2788 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
059ec3d9
PH
2789
2790 However, the last two are optional. That is why the whole set is enclosed
333eea9c 2791 in their own set of braces. */
059ec3d9
PH
2792
2793 case ECOND_SASLAUTHD:
0539a19d
JH
2794#ifndef CYRUS_SASLAUTHD_SOCKET
2795 goto COND_FAILED_NOT_COMPILED;
2796#else
059ec3d9 2797 {
0539a19d
JH
2798 uschar *sub[4];
2799 while (isspace(*s)) s++;
2800 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2801 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2802 resetok))
2803 {
2804 case 1: expand_string_message = US"too few arguments or bracketing "
2805 "error for saslauthd";
2806 case 2:
2807 case 3: return NULL;
2808 }
5694b905
JH
2809 if (!sub[2]) sub[3] = NULL; /* realm if no service */
2810 if (yield)
0539a19d
JH
2811 {
2812 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2813 &expand_string_message);
2814 if (rc == ERROR || rc == DEFER) return NULL;
2815 *yield = (rc == OK) == testfor;
2816 }
2817 return s;
059ec3d9 2818 }
0539a19d 2819#endif /* CYRUS_SASLAUTHD_SOCKET */
059ec3d9
PH
2820
2821
2822 /* symbolic operators for numeric and string comparison, and a number of
2823 other operators, all requiring two arguments.
2824
76dca828
PP
2825 crypteq: encrypts plaintext and compares against an encrypted text,
2826 using crypt(), crypt16(), MD5 or SHA-1
2827 inlist/inlisti: checks if first argument is in the list of the second
059ec3d9
PH
2828 match: does a regular expression match and sets up the numerical
2829 variables if it succeeds
2830 match_address: matches in an address list
2831 match_domain: matches in a domain list
32d668a5 2832 match_ip: matches a host list that is restricted to IP addresses
059ec3d9 2833 match_local_part: matches in a local part list
059ec3d9
PH
2834 */
2835
059ec3d9
PH
2836 case ECOND_MATCH_ADDRESS:
2837 case ECOND_MATCH_DOMAIN:
32d668a5 2838 case ECOND_MATCH_IP:
059ec3d9 2839 case ECOND_MATCH_LOCAL_PART:
da6dbe26
PP
2840#ifndef EXPAND_LISTMATCH_RHS
2841 sub2_honour_dollar = FALSE;
2842#endif
2843 /* FALLTHROUGH */
2844
2845 case ECOND_CRYPTEQ:
2846 case ECOND_INLIST:
2847 case ECOND_INLISTI:
2848 case ECOND_MATCH:
059ec3d9
PH
2849
2850 case ECOND_NUM_L: /* Numerical comparisons */
2851 case ECOND_NUM_LE:
2852 case ECOND_NUM_E:
2853 case ECOND_NUM_EE:
2854 case ECOND_NUM_G:
2855 case ECOND_NUM_GE:
2856
2857 case ECOND_STR_LT: /* String comparisons */
2858 case ECOND_STR_LTI:
2859 case ECOND_STR_LE:
2860 case ECOND_STR_LEI:
2861 case ECOND_STR_EQ:
2862 case ECOND_STR_EQI:
2863 case ECOND_STR_GT:
2864 case ECOND_STR_GTI:
2865 case ECOND_STR_GE:
2866 case ECOND_STR_GEI:
2867
d7978c0f 2868 for (int i = 0; i < 2; i++)
059ec3d9 2869 {
da6dbe26
PP
2870 /* Sometimes, we don't expand substrings; too many insecure configurations
2871 created using match_address{}{} and friends, where the second param
2872 includes information from untrustworthy sources. */
2873 BOOL honour_dollar = TRUE;
2874 if ((i > 0) && !sub2_honour_dollar)
2875 honour_dollar = FALSE;
2876
059ec3d9
PH
2877 while (isspace(*s)) s++;
2878 if (*s != '{')
2879 {
2880 if (i == 0) goto COND_FAILED_CURLY_START;
2881 expand_string_message = string_sprintf("missing 2nd string in {} "
21aa0597 2882 "after \"%s\"", opname);
059ec3d9
PH
2883 return NULL;
2884 }
d584cdca
JH
2885 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2886 honour_dollar, resetok)))
2887 return NULL;
2888 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2889 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2890 " for security reasons\n");
059ec3d9
PH
2891 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2892
2893 /* Convert to numerical if required; we know that the names of all the
2894 conditions that compare numbers do not start with a letter. This just saves
2895 checking for them individually. */
2896
5694b905 2897 if (!isalpha(opname[0]) && yield)
5dd1517f
PH
2898 if (sub[i][0] == 0)
2899 {
2900 num[i] = 0;
2901 DEBUG(D_expand)
e1d04f48 2902 debug_printf_indent("empty string cast to zero for numerical comparison\n");
5dd1517f
PH
2903 }
2904 else
2905 {
7685ce68 2906 num[i] = expanded_string_integer(sub[i], FALSE);
5694b905 2907 if (expand_string_message) return NULL;
5dd1517f 2908 }
059ec3d9
PH
2909 }
2910
2911 /* Result not required */
2912
5694b905 2913 if (!yield) return s;
059ec3d9
PH
2914
2915 /* Do an appropriate comparison */
2916
2917 switch(cond_type)
2918 {
2919 case ECOND_NUM_E:
2920 case ECOND_NUM_EE:
b5b871ac 2921 tempcond = (num[0] == num[1]);
059ec3d9
PH
2922 break;
2923
2924 case ECOND_NUM_G:
b5b871ac 2925 tempcond = (num[0] > num[1]);
059ec3d9
PH
2926 break;
2927
2928 case ECOND_NUM_GE:
b5b871ac 2929 tempcond = (num[0] >= num[1]);
059ec3d9
PH
2930 break;
2931
2932 case ECOND_NUM_L:
b5b871ac 2933 tempcond = (num[0] < num[1]);
059ec3d9
PH
2934 break;
2935
2936 case ECOND_NUM_LE:
b5b871ac 2937 tempcond = (num[0] <= num[1]);
059ec3d9
PH
2938 break;
2939
2940 case ECOND_STR_LT:
b5b871ac 2941 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
059ec3d9
PH
2942 break;
2943
2944 case ECOND_STR_LTI:
b5b871ac 2945 tempcond = (strcmpic(sub[0], sub[1]) < 0);
059ec3d9
PH
2946 break;
2947
2948 case ECOND_STR_LE:
b5b871ac 2949 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
059ec3d9
PH
2950 break;
2951
2952 case ECOND_STR_LEI:
b5b871ac 2953 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
059ec3d9
PH
2954 break;
2955
2956 case ECOND_STR_EQ:
b5b871ac 2957 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
059ec3d9
PH
2958 break;
2959
2960 case ECOND_STR_EQI:
b5b871ac 2961 tempcond = (strcmpic(sub[0], sub[1]) == 0);
059ec3d9
PH
2962 break;
2963
2964 case ECOND_STR_GT:
b5b871ac 2965 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
059ec3d9
PH
2966 break;
2967
2968 case ECOND_STR_GTI:
b5b871ac 2969 tempcond = (strcmpic(sub[0], sub[1]) > 0);
059ec3d9
PH
2970 break;
2971
2972 case ECOND_STR_GE:
b5b871ac 2973 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
059ec3d9
PH
2974 break;
2975
2976 case ECOND_STR_GEI:
b5b871ac 2977 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
059ec3d9
PH
2978 break;
2979
2980 case ECOND_MATCH: /* Regular expression match */
3d2e82c5 2981 if (!(re = pcre_compile(CS sub[1], PCRE_COPT, CCSS &rerror,
5694b905 2982 &roffset, NULL)))
059ec3d9
PH
2983 {
2984 expand_string_message = string_sprintf("regular expression error in "
2985 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2986 return NULL;
2987 }
b5b871ac 2988 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
059ec3d9
PH
2989 break;
2990
2991 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2992 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2993 goto MATCHED_SOMETHING;
2994
2995 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2996 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2997 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2998 goto MATCHED_SOMETHING;
2999
32d668a5 3000 case ECOND_MATCH_IP: /* Match IP address in a host list */
7e66e54d 3001 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
32d668a5
PH
3002 {
3003 expand_string_message = string_sprintf("\"%s\" is not an IP address",
3004 sub[0]);
3005 return NULL;
3006 }
3007 else
3008 {
3009 unsigned int *nullcache = NULL;
3010 check_host_block cb;
3011
3012 cb.host_name = US"";
3013 cb.host_address = sub[0];
3014
3015 /* If the host address starts off ::ffff: it is an IPv6 address in
3016 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3017 addresses. */
3018
3019 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3020 cb.host_address + 7 : cb.host_address;
3021
3022 rc = match_check_list(
3023 &sub[1], /* the list */
3024 0, /* separator character */
3025 &hostlist_anchor, /* anchor pointer */
3026 &nullcache, /* cache pointer */
3027 check_host, /* function for testing */
3028 &cb, /* argument for function */
3029 MCL_HOST, /* type of check */
3030 sub[0], /* text for debugging */
3031 NULL); /* where to pass back data */
3032 }
3033 goto MATCHED_SOMETHING;
3034
059ec3d9
PH
3035 case ECOND_MATCH_LOCAL_PART:
3036 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3037 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
3038 /* Fall through */
9a26b6b2 3039 /* VVVVVVVVVVVV */
059ec3d9
PH
3040 MATCHED_SOMETHING:
3041 switch(rc)
3042 {
3043 case OK:
b5b871ac 3044 tempcond = TRUE;
059ec3d9
PH
3045 break;
3046
3047 case FAIL:
b5b871ac 3048 tempcond = FALSE;
059ec3d9
PH
3049 break;
3050
3051 case DEFER:
3052 expand_string_message = string_sprintf("unable to complete match "
3053 "against \"%s\": %s", sub[1], search_error_message);
3054 return NULL;
3055 }
3056
3057 break;
3058
3059 /* Various "encrypted" comparisons. If the second string starts with
3060 "{" then an encryption type is given. Default to crypt() or crypt16()
3061 (build-time choice). */
b5b871ac 3062 /* }-for-text-editors */
059ec3d9
PH
3063
3064 case ECOND_CRYPTEQ:
3065 #ifndef SUPPORT_CRYPTEQ
3066 goto COND_FAILED_NOT_COMPILED;
3067 #else
3068 if (strncmpic(sub[1], US"{md5}", 5) == 0)
3069 {
3070 int sublen = Ustrlen(sub[1]+5);
3071 md5 base;
3072 uschar digest[16];
3073
3074 md5_start(&base);
cfab9d68 3075 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
059ec3d9
PH
3076
3077 /* If the length that we are comparing against is 24, the MD5 digest
3078 is expressed as a base64 string. This is the way LDAP does it. However,
3079 some other software uses a straightforward hex representation. We assume
3080 this if the length is 32. Other lengths fail. */
3081
3082 if (sublen == 24)
3083 {
1f20760b 3084 uschar *coded = b64encode(CUS digest, 16);
059ec3d9
PH
3085 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3086 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
b5b871ac 3087 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
059ec3d9
PH
3088 }
3089 else if (sublen == 32)
3090 {
059ec3d9 3091 uschar coded[36];
d7978c0f 3092 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
059ec3d9
PH
3093 coded[32] = 0;
3094 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3095 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
b5b871ac 3096 tempcond = (strcmpic(coded, sub[1]+5) == 0);
059ec3d9
PH
3097 }
3098 else
3099 {
3100 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3101 "fail\n crypted=%s\n", sub[1]+5);
b5b871ac 3102 tempcond = FALSE;
059ec3d9
PH
3103 }
3104 }
3105
3106 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3107 {
3108 int sublen = Ustrlen(sub[1]+6);
5fb822fc 3109 hctx h;
059ec3d9
PH
3110 uschar digest[20];
3111
5fb822fc 3112 sha1_start(&h);
cfab9d68 3113 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
059ec3d9
PH
3114
3115 /* If the length that we are comparing against is 28, assume the SHA1
3116 digest is expressed as a base64 string. If the length is 40, assume a
3117 straightforward hex representation. Other lengths fail. */
3118
3119 if (sublen == 28)
3120 {
1f20760b 3121 uschar *coded = b64encode(CUS digest, 20);
059ec3d9
PH
3122 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3123 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
b5b871ac 3124 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
059ec3d9
PH
3125 }
3126 else if (sublen == 40)
3127 {
059ec3d9 3128 uschar coded[44];
d7978c0f 3129 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
059ec3d9
PH
3130 coded[40] = 0;
3131 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3132 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
b5b871ac 3133 tempcond = (strcmpic(coded, sub[1]+6) == 0);
059ec3d9
PH
3134 }
3135 else
3136 {
3137 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3138 "fail\n crypted=%s\n", sub[1]+6);
b5b871ac 3139 tempcond = FALSE;
059ec3d9
PH
3140 }
3141 }
3142
3143 else /* {crypt} or {crypt16} and non-{ at start */
76dca828 3144 /* }-for-text-editors */
059ec3d9
PH
3145 {
3146 int which = 0;
3147 uschar *coded;
3148
3149 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3150 {
3151 sub[1] += 7;
3152 which = 1;
3153 }
3154 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3155 {
3156 sub[1] += 9;
3157 which = 2;
3158 }
b5b871ac 3159 else if (sub[1][0] == '{') /* }-for-text-editors */
059ec3d9
PH
3160 {
3161 expand_string_message = string_sprintf("unknown encryption mechanism "
3162 "in \"%s\"", sub[1]);
3163 return NULL;
3164 }
3165
3166 switch(which)
3167 {
3168 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3169 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
3170 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3171 }
3172
3173 #define STR(s) # s
3174 #define XSTR(s) STR(s)
3175 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3176 " subject=%s\n crypted=%s\n",
9dc2b215 3177 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
059ec3d9
PH
3178 coded, sub[1]);
3179 #undef STR
3180 #undef XSTR
3181
3182 /* If the encrypted string contains fewer than two characters (for the
3183 salt), force failure. Otherwise we get false positives: with an empty
3184 string the yield of crypt() is an empty string! */
3185
9dc2b215
JH
3186 if (coded)
3187 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3188 else if (errno == EINVAL)
3189 tempcond = FALSE;
3190 else
3191 {
3192 expand_string_message = string_sprintf("crypt error: %s\n",
3193 US strerror(errno));
3194 return NULL;
3195 }
059ec3d9
PH
3196 }
3197 break;
3198 #endif /* SUPPORT_CRYPTEQ */
76dca828
PP
3199
3200 case ECOND_INLIST:
3201 case ECOND_INLISTI:
3202 {
55414b25 3203 const uschar * list = sub[1];
76dca828 3204 int sep = 0;
76dca828
PP
3205 uschar *save_iterate_item = iterate_item;
3206 int (*compare)(const uschar *, const uschar *);
3207
21aa0597 3208 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);
82dbd376 3209
b5b871ac 3210 tempcond = FALSE;
55414b25
JH
3211 compare = cond_type == ECOND_INLISTI
3212 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
76dca828 3213
55414b25 3214 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
05e796ad
JH
3215 {
3216 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
76dca828
PP
3217 if (compare(sub[0], iterate_item) == 0)
3218 {
b5b871ac 3219 tempcond = TRUE;
76dca828
PP
3220 break;
3221 }
05e796ad 3222 }
76dca828 3223 iterate_item = save_iterate_item;
76dca828
PP
3224 }
3225
059ec3d9
PH
3226 } /* Switch for comparison conditions */
3227
b5b871ac 3228 *yield = tempcond == testfor;
059ec3d9
PH
3229 return s; /* End of comparison conditions */
3230
3231
3232 /* and/or: computes logical and/or of several conditions */
3233
3234 case ECOND_AND:
3235 case ECOND_OR:
5694b905 3236 subcondptr = (yield == NULL) ? NULL : &tempcond;
059ec3d9
PH
3237 combined_cond = (cond_type == ECOND_AND);
3238
3239 while (isspace(*s)) s++;
b5b871ac 3240 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
059ec3d9
PH
3241
3242 for (;;)
3243 {
3244 while (isspace(*s)) s++;
b5b871ac 3245 /* {-for-text-editors */
059ec3d9 3246 if (*s == '}') break;
b5b871ac 3247 if (*s != '{') /* }-for-text-editors */
059ec3d9
PH
3248 {
3249 expand_string_message = string_sprintf("each subcondition "
21aa0597 3250 "inside an \"%s{...}\" condition must be in its own {}", opname);
059ec3d9
PH
3251 return NULL;
3252 }
3253
b0e85a8f 3254 if (!(s = eval_condition(s+1, resetok, subcondptr)))
059ec3d9
PH
3255 {
3256 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
21aa0597 3257 expand_string_message, opname);
059ec3d9
PH
3258 return NULL;
3259 }
3260 while (isspace(*s)) s++;
3261
b5b871ac 3262 /* {-for-text-editors */
059ec3d9
PH
3263 if (*s++ != '}')
3264 {
b5b871ac 3265 /* {-for-text-editors */
059ec3d9 3266 expand_string_message = string_sprintf("missing } at end of condition "
21aa0597 3267 "inside \"%s\" group", opname);
059ec3d9
PH
3268 return NULL;
3269 }
3270
5694b905 3271 if (yield)
059ec3d9
PH
3272 if (cond_type == ECOND_AND)
3273 {
3274 combined_cond &= tempcond;
3275 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3276 } /* evaluate any more */
3277 else
3278 {
3279 combined_cond |= tempcond;
3280 if (combined_cond) subcondptr = NULL; /* once true, don't */
3281 } /* evaluate any more */
059ec3d9
PH
3282 }
3283
5694b905 3284 if (yield) *yield = (combined_cond == testfor);
059ec3d9
PH
3285 return ++s;
3286
3287
0ce9abe6
PH
3288 /* forall/forany: iterates a condition with different values */
3289
7f69e814
JH
3290 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3291 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3292 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3293 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3294 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3295 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3296
3297 FORMANY:
0ce9abe6 3298 {
55414b25 3299 const uschar * list;
0ce9abe6 3300 int sep = 0;
282b357d 3301 uschar *save_iterate_item = iterate_item;
0ce9abe6 3302
21aa0597 3303 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
82dbd376 3304
0ce9abe6 3305 while (isspace(*s)) s++;
b5b871ac 3306 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
5694b905
JH
3307 if (!(sub[0] = expand_string_internal(s, TRUE, &s, yield == NULL, TRUE, resetok)))
3308 return NULL;
b5b871ac 3309 /* {-for-text-editors */
0ce9abe6
PH
3310 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3311
3312 while (isspace(*s)) s++;
b5b871ac 3313 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
0ce9abe6
PH
3314
3315 sub[1] = s;
3316
3317 /* Call eval_condition once, with result discarded (as if scanning a
3318 "false" part). This allows us to find the end of the condition, because if
3319 the list it empty, we won't actually evaluate the condition for real. */
3320
b0e85a8f 3321 if (!(s = eval_condition(sub[1], resetok, NULL)))
0ce9abe6
PH
3322 {
3323 expand_string_message = string_sprintf("%s inside \"%s\" condition",
21aa0597 3324 expand_string_message, opname);
0ce9abe6
PH
3325 return NULL;
3326 }
3327 while (isspace(*s)) s++;
3328
b5b871ac 3329 /* {-for-text-editors */
0ce9abe6
PH
3330 if (*s++ != '}')
3331 {
b5b871ac 3332 /* {-for-text-editors */
0ce9abe6 3333 expand_string_message = string_sprintf("missing } at end of condition "
21aa0597 3334 "inside \"%s\"", opname);
0ce9abe6
PH
3335 return NULL;
3336 }
3337
7f69e814 3338 if (yield) *yield = !testfor;
55414b25 3339 list = sub[0];
7f69e814
JH
3340 if (is_json) list = dewrap(string_copy(list), US"[]");
3341 while ((iterate_item = is_json
3342 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
0ce9abe6 3343 {
7f69e814
JH
3344 if (is_jsons)
3345 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3346 {
3347 expand_string_message =
3348 string_sprintf("%s wrapping string result for extract jsons",
3349 expand_string_message);
3350 iterate_item = save_iterate_item;
3351 return NULL;
3352 }
3353
f3ebb786 3354 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
b0e85a8f 3355 if (!eval_condition(sub[1], resetok, &tempcond))
0ce9abe6
PH
3356 {
3357 expand_string_message = string_sprintf("%s inside \"%s\" condition",
21aa0597 3358 expand_string_message, opname);
e58c13cc 3359 iterate_item = save_iterate_item;
0ce9abe6
PH
3360 return NULL;
3361 }
21aa0597 3362 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
0ce9abe6
PH
3363 tempcond? "true":"false");
3364
7f69e814
JH
3365 if (yield) *yield = (tempcond == testfor);
3366 if (tempcond == is_forany) break;
0ce9abe6
PH
3367 }
3368
282b357d 3369 iterate_item = save_iterate_item;
0ce9abe6
PH
3370 return s;
3371 }
3372
3373
f3766eb5
NM
3374 /* The bool{} expansion condition maps a string to boolean.
3375 The values supported should match those supported by the ACL condition
3376 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3377 of true/false. Note that Router "condition" rules have a different
3378 interpretation, where general data can be used and only a few values
3379 map to FALSE.
3380 Note that readconf.c boolean matching, for boolean configuration options,
6a8de854
PP
3381 only matches true/yes/false/no.
3382 The bool_lax{} condition matches the Router logic, which is much more
3383 liberal. */
f3766eb5 3384 case ECOND_BOOL:
6a8de854 3385 case ECOND_BOOL_LAX:
f3766eb5
NM
3386 {
3387 uschar *sub_arg[1];
71265ae9 3388 uschar *t, *t2;
6a8de854 3389 uschar *ourname;
f3766eb5
NM
3390 size_t len;
3391 BOOL boolvalue = FALSE;
3392 while (isspace(*s)) s++;
b5b871ac 3393 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
6a8de854 3394 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
b0e85a8f 3395 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
f3766eb5 3396 {
6a8de854
PP
3397 case 1: expand_string_message = string_sprintf(
3398 "too few arguments or bracketing error for %s",
3399 ourname);
f3766eb5
NM
3400 /*FALLTHROUGH*/
3401 case 2:
3402 case 3: return NULL;
3403 }
3404 t = sub_arg[0];
3405 while (isspace(*t)) t++;
3406 len = Ustrlen(t);
71265ae9
PP
3407 if (len)
3408 {
3409 /* trailing whitespace: seems like a good idea to ignore it too */
3410 t2 = t + len - 1;
3411 while (isspace(*t2)) t2--;
3412 if (t2 != (t + len))
3413 {
3414 *++t2 = '\0';
3415 len = t2 - t;
3416 }
3417 }
f3766eb5 3418 DEBUG(D_expand)
e1d04f48 3419 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
6a8de854
PP
3420 /* logic for the lax case from expand_check_condition(), which also does
3421 expands, and the logic is both short and stable enough that there should
3422 be no maintenance burden from replicating it. */
f3766eb5
NM
3423 if (len == 0)
3424 boolvalue = FALSE;
51c7471d
JH
3425 else if (*t == '-'
3426 ? Ustrspn(t+1, "0123456789") == len-1
3427 : Ustrspn(t, "0123456789") == len)
6a8de854 3428 {
f3766eb5 3429 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
6a8de854
PP
3430 /* expand_check_condition only does a literal string "0" check */
3431 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3432 boolvalue = TRUE;
3433 }
f3766eb5
NM
3434 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3435 boolvalue = TRUE;
3436 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3437 boolvalue = FALSE;
6a8de854
PP
3438 else if (cond_type == ECOND_BOOL_LAX)
3439 boolvalue = TRUE;
f3766eb5
NM
3440 else
3441 {
3442 expand_string_message = string_sprintf("unrecognised boolean "
3443 "value \"%s\"", t);
3444 return NULL;
3445 }
e1d04f48 3446 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
c7c833c6 3447 boolvalue? "true":"false");
5694b905 3448 if (yield) *yield = (boolvalue == testfor);
f3766eb5
NM
3449 return s;
3450 }
3451
7ef88aa0
JH
3452#ifdef EXPERIMENTAL_SRS_NATIVE
3453 case ECOND_INBOUND_SRS:
3454 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */
3455 {
3456 uschar * sub[2];
3457 const pcre * re;
3458 int ovec[3*(4+1)];
3459 int n;
3460 uschar cksum[4];
3461 BOOL boolvalue = FALSE;
3462
3463 switch(read_subs(sub, 2, 2, CUSS &s, yield == NULL, FALSE, US"inbound_srs", resetok))
3464 {
3465 case 1: expand_string_message = US"too few arguments or bracketing "
3466 "error for inbound_srs";
3467 case 2:
3468 case 3: return NULL;
3469 }
3470
3471 /* Match the given local_part against the SRS-encoded pattern */
3472
3473 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]+)=([^=]*)=(.*)$",
3474 TRUE, FALSE);
3475 if (pcre_exec(re, NULL, CS sub[0], Ustrlen(sub[0]), 0, PCRE_EOPT,
3476 ovec, nelem(ovec)) < 0)
3477 {
3478 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3479 goto srs_result;
3480 }
3481
3482 /* Side-effect: record the decoded recipient */
3483
3484 srs_recipient = string_sprintf("%.*S@%.*S", /* lowercased */
3485 ovec[9]-ovec[8], sub[0] + ovec[8], /* substring 4 */
3486 ovec[7]-ovec[6], sub[0] + ovec[6]); /* substring 3 */
3487
3488 /* If a zero-length secret was given, we're done. Otherwise carry on
3489 and validate the given SRS local_part againt our secret. */
3490
3491 if (!*sub[1])
3492 {
3493 boolvalue = TRUE;
3494 goto srs_result;
3495 }
3496
3497 /* check the timestamp */
3498 {
3499 struct timeval now;
3500 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3501 long d;
3502
3503 gettimeofday(&now, NULL);
3504 now.tv_sec /= 86400; /* days since epoch */
3505
3506 /* Decode substring 2 from base32 to a number */
3507
3508 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3509 {
3510 uschar * t = Ustrchr(base32_chars, *ss++);
3511 d = d * 32 + (t - base32_chars);
3512 }
3513
3514 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3515 {
3516 DEBUG(D_expand) debug_printf("SRS too old\n");
3517 goto srs_result;
3518 }
3519 }
3520
3521 /* check length of substring 1, the offered checksum */
3522
3523 if (ovec[3]-ovec[2] != 4)
3524 {
3525 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3526 goto srs_result;
3527 }
3528
3529 /* Hash the address with our secret, and compare that computed checksum
3530 with the one extracted from the arg */
3531
3532 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3533 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3534 {
3535 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3536 goto srs_result;
3537 }
3538 boolvalue = TRUE;
3539
3540srs_result:
3541 if (yield) *yield = (boolvalue == testfor);
3542 return s;
3543 }
3544#endif /*EXPERIMENTAL_SRS_NATIVE*/
3545
059ec3d9
PH
3546 /* Unknown condition */
3547
3548 default:
21aa0597
JH
3549 if (!expand_string_message || !*expand_string_message)
3550 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3551 return NULL;
059ec3d9
PH
3552 } /* End switch on condition type */
3553
3554/* Missing braces at start and end of data */
3555
3556COND_FAILED_CURLY_START:
21aa0597 3557expand_string_message = string_sprintf("missing { after \"%s\"", opname);
059ec3d9
PH
3558return NULL;
3559
3560COND_FAILED_CURLY_END:
3561expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
21aa0597 3562 opname);
059ec3d9
PH
3563return NULL;
3564
3565/* A condition requires code that is not compiled */
3566
3567#if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3568 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3569 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3570COND_FAILED_NOT_COMPILED:
3571expand_string_message = string_sprintf("support for \"%s\" not compiled",
21aa0597 3572 opname);
059ec3d9
PH
3573return NULL;
3574#endif
3575}
3576
3577
3578
3579
3580/*************************************************
3581* Save numerical variables *
3582*************************************************/
3583
3584/* This function is called from items such as "if" that want to preserve and
3585restore the numbered variables.
3586
3587Arguments:
3588 save_expand_string points to an array of pointers to set
3589 save_expand_nlength points to an array of ints for the lengths
3590
3591Returns: the value of expand max to save
3592*/
3593
3594static int
3595save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3596{
d7978c0f 3597for (int i = 0; i <= expand_nmax; i++)
059ec3d9
PH
3598 {
3599 save_expand_nstring[i] = expand_nstring[i];
3600 save_expand_nlength[i] = expand_nlength[i];
3601 }
3602return expand_nmax;
3603}
3604
3605
3606
3607/*************************************************
3608* Restore numerical variables *
3609*************************************************/
3610
3611/* This function restored saved values of numerical strings.
3612
3613Arguments:
3614 save_expand_nmax the number of strings to restore
3615 save_expand_string points to an array of pointers
3616 save_expand_nlength points to an array of ints
3617
3618Returns: nothing
3619*/
3620
3621static void
3622restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3623 int *save_expand_nlength)
3624{
059ec3d9 3625expand_nmax = save_expand_nmax;
d7978c0f 3626for (int i = 0; i <= expand_nmax; i++)
059ec3d9
PH
3627 {
3628 expand_nstring[i] = save_expand_nstring[i];
3629 expand_nlength[i] = save_expand_nlength[i];
3630 }
3631}
3632
3633
3634
3635
3636
3637/*************************************************
3638* Handle yes/no substrings *
3639*************************************************/
3640
3641/* This function is used by ${if}, ${lookup} and ${extract} to handle the
3642alternative substrings that depend on whether or not the condition was true,
3643or the lookup or extraction succeeded. The substrings always have to be
3644expanded, to check their syntax, but "skipping" is set when the result is not
3645needed - this avoids unnecessary nested lookups.
3646
3647Arguments:
3648 skipping TRUE if we were skipping when this item was reached
3649 yes TRUE if the first string is to be used, else use the second
3650 save_lookup a value to put back into lookup_value before the 2nd expansion
3651 sptr points to the input string pointer
acec9514 3652 yieldptr points to the output growable-string pointer
f90d49f7
JH
3653 type "lookup", "if", "extract", "run", "env", "listextract" or
3654 "certextract" for error message
b0e85a8f
JH
3655 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3656 the store.
059ec3d9
PH
3657
3658Returns: 0 OK; lookup_value has been reset to save_lookup
3659 1 expansion failed
3660 2 expansion failed because of bracketing error
3661*/
3662
3663static int
55414b25 3664process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
acec9514 3665 gstring ** yieldptr, uschar *type, BOOL *resetok)
059ec3d9
PH
3666{
3667int rc = 0;
55414b25 3668const uschar *s = *sptr; /* Local value */
059ec3d9 3669uschar *sub1, *sub2;
e47376be 3670const uschar * errwhere;
059ec3d9
PH
3671
3672/* If there are no following strings, we substitute the contents of $value for
063b1e99 3673lookups and for extractions in the success case. For the ${if item, the string
8e669ac1 3674"true" is substituted. In the fail case, nothing is substituted for all three
063b1e99 3675items. */
059ec3d9
PH
3676
3677while (isspace(*s)) s++;
3678if (*s == '}')
3679 {
9e09521e
JH
3680 if (type[0] == 'i')
3681 {
3682 if (yes && !skipping)
acec9514 3683 *yieldptr = string_catn(*yieldptr, US"true", 4);
9e09521e
JH
3684 }
3685 else
3686 {
3687 if (yes && lookup_value && !skipping)
acec9514 3688 *yieldptr = string_cat(*yieldptr, lookup_value);
9e09521e
JH
3689 lookup_value = save_lookup;
3690 }
059ec3d9
PH
3691 s++;
3692 goto RETURN;
3693 }
3694
9b4768fa
PH
3695/* The first following string must be braced. */
3696
e47376be
JH
3697if (*s++ != '{')
3698 {
3699 errwhere = US"'yes' part did not start with '{'";
3700 goto FAILED_CURLY;
3701 }
9b4768fa 3702
059ec3d9
PH
3703/* Expand the first substring. Forced failures are noticed only if we actually
3704want this string. Set skipping in the call in the fail case (this will always
3705be the case if we were already skipping). */
3706
b0e85a8f 3707sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
8768d548
JH
3708if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3709f.expand_string_forcedfail = FALSE;
e47376be
JH
3710if (*s++ != '}')
3711 {
3712 errwhere = US"'yes' part did not end with '}'";
3713 goto FAILED_CURLY;
3714 }
059ec3d9
PH
3715
3716/* If we want the first string, add it to the output */
3717
3718if (yes)
acec9514 3719 *yieldptr = string_cat(*yieldptr, sub1);
059ec3d9 3720
fa01e4f8
JH
3721/* If this is called from a lookup/env or a (cert)extract, we want to restore
3722$value to what it was at the start of the item, so that it has this value
3723during the second string expansion. For the call from "if" or "run" to this
3724function, save_lookup is set to lookup_value, so that this statement does
3725nothing. */
059ec3d9
PH
3726
3727lookup_value = save_lookup;
3728
3729/* There now follows either another substring, or "fail", or nothing. This
3730time, forced failures are noticed only if we want the second string. We must
3731set skipping in the nested call if we don't want this string, or if we were
3732already skipping. */
3733
3734while (isspace(*s)) s++;
3735if (*s == '{')
3736 {
b0e85a8f 3737 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
8768d548
JH
3738 if (sub2 == NULL && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3739 f.expand_string_forcedfail = FALSE;
e47376be
JH
3740 if (*s++ != '}')
3741 {
3742 errwhere = US"'no' part did not start with '{'";
3743 goto FAILED_CURLY;
3744 }
059ec3d9
PH
3745
3746 /* If we want the second string, add it to the output */
3747
3748 if (!yes)
acec9514 3749 *yieldptr = string_cat(*yieldptr, sub2);
059ec3d9
PH
3750 }
3751
3752/* If there is no second string, but the word "fail" is present when the use of
3753the second string is wanted, set a flag indicating it was a forced failure
3754rather than a syntactic error. Swallow the terminating } in case this is nested
3755inside another lookup or if or extract. */
3756
3757else if (*s != '}')
3758 {
3759 uschar name[256];
55414b25
JH
3760 /* deconst cast ok here as source is s anyway */
3761 s = US read_name(name, sizeof(name), s, US"_");
059ec3d9
PH
3762 if (Ustrcmp(name, "fail") == 0)
3763 {
3764 if (!yes && !skipping)
3765 {
3766 while (isspace(*s)) s++;
e47376be
JH
3767 if (*s++ != '}')
3768 {
3769 errwhere = US"did not close with '}' after forcedfail";
3770 goto FAILED_CURLY;
3771 }
059ec3d9
PH
3772 expand_string_message =
3773 string_sprintf("\"%s\" failed and \"fail\" requested", type);
8768d548 3774 f.expand_string_forcedfail = TRUE;
059ec3d9
PH
3775 goto FAILED;
3776 }
3777 }
3778 else
3779 {
3780 expand_string_message =
3781 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3782 goto FAILED;
3783 }
3784 }
3785
3786/* All we have to do now is to check on the final closing brace. */
3787
3788while (isspace(*s)) s++;
e47376be
JH
3789if (*s++ != '}')
3790 {
3791 errwhere = US"did not close with '}'";
3792 goto FAILED_CURLY;
3793 }
059ec3d9 3794
059ec3d9
PH
3795
3796RETURN:
e47376be 3797/* Update the input pointer value before returning */
059ec3d9
PH
3798*sptr = s;
3799return rc;
e47376be
JH
3800
3801FAILED_CURLY:
3802 /* Get here if there is a bracketing failure */
3803 expand_string_message = string_sprintf(
3804 "curly-bracket problem in conditional yes/no parsing: %s\n"
3805 " remaining string is '%s'", errwhere, --s);
3806 rc = 2;
3807 goto RETURN;
3808
3809FAILED:
3810 /* Get here for other failures */
3811 rc = 1;
3812 goto RETURN;
059ec3d9
PH
3813}
3814
3815
3816
3817
1549ea3b
PH
3818/********************************************************
3819* prvs: Get last three digits of days since Jan 1, 1970 *
3820********************************************************/
3821
3822/* This is needed to implement the "prvs" BATV reverse
3823 path signing scheme
3824
3825Argument: integer "days" offset to add or substract to
3826 or from the current number of days.
3827
3828Returns: pointer to string containing the last three
3829 digits of the number of days since Jan 1, 1970,
3830 modified by the offset argument, NULL if there
3831 was an error in the conversion.
3832
3833*/
3834
3835static uschar *
3836prvs_daystamp(int day_offset)
3837{
f3ebb786 3838uschar *days = store_get(32, FALSE); /* Need at least 24 for cases */
a86229cf 3839(void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
1549ea3b 3840 (time(NULL) + day_offset*86400)/86400);
e169f567 3841return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
1549ea3b
PH
3842}
3843
3844
3845
3846/********************************************************
3847* prvs: perform HMAC-SHA1 computation of prvs bits *
3848********************************************************/
3849
3850/* This is needed to implement the "prvs" BATV reverse
3851 path signing scheme
3852
3853Arguments:
3854 address RFC2821 Address to use
3855 key The key to use (must be less than 64 characters
3856 in size)
3857 key_num Single-digit key number to use. Defaults to
3858 '0' when NULL.
3859
3860Returns: pointer to string containing the first three
3861 bytes of the final hash in hex format, NULL if
3862 there was an error in the process.
3863*/
3864
3865static uschar *
3866prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3867{
acec9514
JH
3868gstring * hash_source;
3869uschar * p;
5fb822fc 3870hctx h;
1549ea3b
PH
3871uschar innerhash[20];
3872uschar finalhash[20];
3873uschar innerkey[64];
3874uschar outerkey[64];
f3ebb786 3875uschar *finalhash_hex;
1549ea3b 3876
5694b905 3877if (!key_num)
1549ea3b
PH
3878 key_num = US"0";
3879
3880if (Ustrlen(key) > 64)
3881 return NULL;
3882
acec9514
JH
3883hash_source = string_catn(NULL, key_num, 1);
3884hash_source = string_catn(hash_source, daystamp, 3);
3885hash_source = string_cat(hash_source, address);
3886(void) string_from_gstring(hash_source);
1549ea3b 3887
acec9514
JH
3888DEBUG(D_expand)
3889 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
1549ea3b
PH
3890
3891memset(innerkey, 0x36, 64);
3892memset(outerkey, 0x5c, 64);
3893
d7978c0f 3894for (int i = 0; i < Ustrlen(key); i++)
1549ea3b
PH
3895 {
3896 innerkey[i] ^= key[i];
3897 outerkey[i] ^= key[i];
3898 }
3899
5fb822fc
JH
3900chash_start(HMAC_SHA1, &h);
3901chash_mid(HMAC_SHA1, &h, innerkey);
acec9514 3902chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
1549ea3b 3903
5fb822fc
JH
3904chash_start(HMAC_SHA1, &h);
3905chash_mid(HMAC_SHA1, &h, outerkey);
3906chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
1549ea3b 3907
f3ebb786
JH
3908/* Hashing is deemed sufficient to de-taint any input data */
3909
3910p = finalhash_hex = store_get(40, FALSE);
d7978c0f 3911for (int i = 0; i < 3; i++)
1549ea3b
PH
3912 {
3913 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3914 *p++ = hex_digits[finalhash[i] & 0x0f];
3915 }
3916*p = '\0';
3917
3918return finalhash_hex;
3919}
3920
3921
3922
3923
059ec3d9
PH
3924/*************************************************
3925* Join a file onto the output string *
3926*************************************************/
3927
fa01e4f8
JH
3928/* This is used for readfile/readsock and after a run expansion.
3929It joins the contents of a file onto the output string, globally replacing
3930newlines with a given string (optionally).
059ec3d9
PH
3931
3932Arguments:
3933 f the FILE
acec9514 3934 yield pointer to the expandable string struct
059ec3d9
PH
3935 eol newline replacement string, or NULL
3936
acec9514 3937Returns: new pointer for expandable string, terminated if non-null
059ec3d9
PH
3938*/
3939
acec9514
JH
3940static gstring *
3941cat_file(FILE *f, gstring *yield, uschar *eol)
059ec3d9 3942{
059ec3d9
PH
3943uschar buffer[1024];
3944
fa01e4f8 3945while (Ufgets(buffer, sizeof(buffer), f))
059ec3d9
PH
3946 {
3947 int len = Ustrlen(buffer);
fa01e4f8 3948 if (eol && buffer[len-1] == '\n') len--;
acec9514 3949 yield = string_catn(yield, buffer, len);
8487aee9 3950 if (eol && buffer[len])
acec9514 3951 yield = string_cat(yield, eol);
059ec3d9
PH
3952 }
3953
acec9514 3954(void) string_from_gstring(yield);
059ec3d9
PH
3955return yield;
3956}
3957
3958
01603eec 3959#ifndef DISABLE_TLS
afdb5e9c
JH
3960static gstring *
3961cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
3962{
3963int rc;
afdb5e9c
JH
3964uschar buffer[1024];
3965
d7978c0f
JH
3966/*XXX could we read direct into a pre-grown string? */
3967
afdb5e9c 3968while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
d7978c0f 3969 for (uschar * s = buffer; rc--; s++)
afdb5e9c
JH
3970 yield = eol && *s == '\n'
3971 ? string_cat(yield, eol) : string_catn(yield, s, 1);
3972
3973/* We assume that all errors, and any returns of zero bytes,
3974are actually EOF. */
3975
3976(void) string_from_gstring(yield);
3977return yield;
3978}
3979#endif
059ec3d9
PH
3980
3981
3982/*************************************************
3983* Evaluate numeric expression *
3984*************************************************/
3985
af561417
PH
3986/* This is a set of mutually recursive functions that evaluate an arithmetic
3987expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3988these functions that is called from elsewhere is eval_expr, whose interface is:
059ec3d9
PH
3989
3990Arguments:
af561417
PH
3991 sptr pointer to the pointer to the string - gets updated
3992 decimal TRUE if numbers are to be assumed decimal
3993 error pointer to where to put an error message - must be NULL on input
3994 endket TRUE if ')' must terminate - FALSE for external call
059ec3d9 3995
af561417
PH
3996Returns: on success: the value of the expression, with *error still NULL
3997 on failure: an undefined value, with *error = a message
059ec3d9
PH
3998*/
3999
97d17305 4000static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
af561417 4001
059ec3d9 4002
97d17305 4003static int_eximarith_t
059ec3d9
PH
4004eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4005{
4006uschar *s = *sptr;
97d17305 4007int_eximarith_t x = eval_op_or(&s, decimal, error);
aa3c7e48
JH
4008
4009if (!*error)
af561417 4010 if (endket)
af561417
PH
4011 if (*s != ')')
4012 *error = US"expecting closing parenthesis";
4013 else
4014 while (isspace(*(++s)));
aa3c7e48
JH
4015 else if (*s)
4016 *error = US"expecting operator";
059ec3d9
PH
4017*sptr = s;
4018return x;
4019}
4020
af561417 4021
97d17305 4022static int_eximarith_t
af561417 4023eval_number(uschar **sptr, BOOL decimal, uschar **error)
059ec3d9 4024{
aa3c7e48 4025int c;
97d17305 4026int_eximarith_t n;
059ec3d9 4027uschar *s = *sptr;
aa3c7e48 4028
059ec3d9 4029while (isspace(*s)) s++;
aa3c7e48 4030if (isdigit((c = *s)))
059ec3d9
PH
4031 {
4032 int count;
97d17305 4033 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
059ec3d9 4034 s += count;
97d17305
JH
4035 switch (tolower(*s))
4036 {
4037 default: break;
4038 case 'k': n *= 1024; s++; break;
4039 case 'm': n *= 1024*1024; s++; break;
4040 case 'g': n *= 1024*1024*1024; s++; break;
4041 }
059ec3d9
PH
4042 while (isspace (*s)) s++;
4043 }
4044else if (c == '(')
4045 {
4046 s++;
4047 n = eval_expr(&s, decimal, error, 1);
4048 }
4049else
4050 {
4051 *error = US"expecting number or opening parenthesis";
4052 n = 0;
4053 }
4054*sptr = s;
4055return n;
4056}
4057
af561417 4058
97d17305 4059static int_eximarith_t
aa7c82b2 4060eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
4061{
4062uschar *s = *sptr;
97d17305 4063int_eximarith_t x;
af561417
PH
4064while (isspace(*s)) s++;
4065if (*s == '+' || *s == '-' || *s == '~')
4066 {
4067 int op = *s++;
4068 x = eval_op_unary(&s, decimal, error);
4069 if (op == '-') x = -x;
4070 else if (op == '~') x = ~x;
4071 }
4072else
af561417 4073 x = eval_number(&s, decimal, error);
aa3c7e48 4074
af561417
PH
4075*sptr = s;
4076return x;
4077}
4078
4079
97d17305 4080static int_eximarith_t
aa7c82b2 4081eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
059ec3d9
PH
4082{
4083uschar *s = *sptr;
97d17305 4084int_eximarith_t x = eval_op_unary(&s, decimal, error);
5694b905 4085if (!*error)
059ec3d9 4086 {
5591031b 4087 while (*s == '*' || *s == '/' || *s == '%')
059ec3d9
PH
4088 {
4089 int op = *s++;
97d17305 4090 int_eximarith_t y = eval_op_unary(&s, decimal, error);
5694b905 4091 if (*error) break;
053a9aa3
PP
4092 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4093 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4094 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4c04137d 4095 * -N*M is INT_MIN will yield INT_MIN.
053a9aa3
PP
4096 * Since we don't support floating point, this is somewhat simpler.
4097 * Ideally, we'd return an error, but since we overflow for all other
4098 * arithmetic, consistency suggests otherwise, but what's the correct value
4099 * to use? There is none.
4100 * The C standard guarantees overflow for unsigned arithmetic but signed
4101 * overflow invokes undefined behaviour; in practice, this is overflow
4102 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4103 * that long/longlong larger than int are available, or we could just work
4104 * with larger types. We should consider whether to guarantee 32bit eval
4105 * and 64-bit working variables, with errors returned. For now ...
4106 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4107 * can just let the other invalid results occur otherwise, as they have
4108 * until now. For this one case, we can coerce.
4109 */
4328fd3c 4110 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
053a9aa3
PP
4111 {
4112 DEBUG(D_expand)
97d17305 4113 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4328fd3c
JH
4114 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4115 x = EXIM_ARITH_MAX;
053a9aa3
PP
4116 continue;
4117 }
a5b52695
PP
4118 if (op == '*')
4119 x *= y;
4120 else
4121 {
4122 if (y == 0)
54e7ce4a 4123 {
a5b52695
PP
4124 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4125 x = 0;
4126 break;
54e7ce4a 4127 }
a5b52695
PP
4128 if (op == '/')
4129 x /= y;
4130 else
4131 x %= y;
4132 }
059ec3d9
PH
4133 }
4134 }
4135*sptr = s;
4136return x;
4137}
4138
4139
97d17305 4140static int_eximarith_t
aa7c82b2 4141eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
4142{
4143uschar *s = *sptr;
97d17305 4144int_eximarith_t x = eval_op_mult(&s, decimal, error);
6e3b198d 4145if (!*error)
af561417
PH
4146 {
4147 while (*s == '+' || *s == '-')
4148 {
4149 int op = *s++;
97d17305 4150 int_eximarith_t y = eval_op_mult(&s, decimal, error);
6e3b198d
JH
4151 if (*error) break;
4152 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4153 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4154 { /* over-conservative check */
4155 *error = op == '+'
4156 ? US"overflow in sum" : US"overflow in difference";
4157 break;
4158 }
af561417
PH
4159 if (op == '+') x += y; else x -= y;
4160 }
4161 }
4162*sptr = s;
4163return x;
4164}
4165
4166
97d17305 4167static int_eximarith_t
aa7c82b2 4168eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
4169{
4170uschar *s = *sptr;
97d17305 4171int_eximarith_t x = eval_op_sum(&s, decimal, error);
5694b905 4172if (!*error)
af561417
PH
4173 {
4174 while ((*s == '<' || *s == '>') && s[1] == s[0])
4175 {
97d17305 4176 int_eximarith_t y;
af561417
PH
4177 int op = *s++;
4178 s++;
4179 y = eval_op_sum(&s, decimal, error);
5694b905 4180 if (*error) break;
af561417
PH
4181 if (op == '<') x <<= y; else x >>= y;
4182 }
4183 }
4184*sptr = s;
4185return x;
4186}
4187
4188
97d17305 4189static int_eximarith_t
aa7c82b2 4190eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
4191{
4192uschar *s = *sptr;
97d17305 4193int_eximarith_t x = eval_op_shift(&s, decimal, error);
5694b905 4194if (!*error)
af561417
PH
4195 {
4196 while (*s == '&')
4197 {
97d17305 4198 int_eximarith_t y;
af561417
PH
4199 s++;
4200 y = eval_op_shift(&s, decimal, error);
5694b905 4201 if (*error) break;
af561417
PH
4202 x &= y;
4203 }
4204 }
4205*sptr = s;
4206return x;
4207}
4208
4209
97d17305 4210static int_eximarith_t
aa7c82b2 4211eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
4212{
4213uschar *s = *sptr;
97d17305 4214int_eximarith_t x = eval_op_and(&s, decimal, error);
5694b905 4215if (!*error)
af561417
PH
4216 {
4217 while (*s == '^')
4218 {
97d17305 4219 int_eximarith_t y;
af561417
PH
4220 s++;
4221 y = eval_op_and(&s, decimal, error);
5694b905 4222 if (*error) break;
af561417
PH
4223 x ^= y;
4224 }
4225 }
4226*sptr = s;
4227return x;
4228}
4229
4230
97d17305 4231static int_eximarith_t
aa7c82b2 4232eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
4233{
4234uschar *s = *sptr;
97d17305 4235int_eximarith_t x = eval_op_xor(&s, decimal, error);
5694b905 4236if (!*error)
af561417
PH
4237 {
4238 while (*s == '|')
4239 {
97d17305 4240 int_eximarith_t y;
af561417
PH
4241 s++;
4242 y = eval_op_xor(&s, decimal, error);
5694b905 4243 if (*error) break;
af561417
PH
4244 x |= y;
4245 }
4246 }
4247*sptr = s;
4248return x;
4249}
4250
059ec3d9
PH
4251
4252
21aa0597
JH
4253/************************************************/
4254/* Comparison operation for sort expansion. We need to avoid
4255re-expanding the fields being compared, so need a custom routine.
4256
4257Arguments:
4258 cond_type Comparison operator code
4259 leftarg, rightarg Arguments for comparison
4260
4261Return true iff (leftarg compare rightarg)
4262*/
4263
4264static BOOL
4265sortsbefore(int cond_type, BOOL alpha_cond,
4266 const uschar * leftarg, const uschar * rightarg)
4267{
4268int_eximarith_t l_num, r_num;
4269
4270if (!alpha_cond)
4271 {
4272 l_num = expanded_string_integer(leftarg, FALSE);
4273 if (expand_string_message) return FALSE;
4274 r_num = expanded_string_integer(rightarg, FALSE);
4275 if (expand_string_message) return FALSE;
4276
4277 switch (cond_type)
4278 {
4279 case ECOND_NUM_G: return l_num > r_num;
4280 case ECOND_NUM_GE: return l_num >= r_num;
4281 case ECOND_NUM_L: return l_num < r_num;
4282 case ECOND_NUM_LE: return l_num <= r_num;
4283 default: break;
4284 }
4285 }
4286else
4287 switch (cond_type)
4288 {
4289 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4290 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4291 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4292 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4293 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4294 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4295 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4296 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4297 default: break;
4298 }
4299return FALSE; /* should not happen */
4300}
4301
4302
059ec3d9
PH
4303/*************************************************
4304* Expand string *
4305*************************************************/
4306
4307/* Returns either an unchanged string, or the expanded string in stacking pool
4308store. Interpreted sequences are:
4309
4310 \... normal escaping rules
4311 $name substitutes the variable
4312 ${name} ditto
4313 ${op:string} operates on the expanded string value
4314 ${item{arg1}{arg2}...} expands the args and then does the business
4315 some literal args are not enclosed in {}
4316
4317There are now far too many operators and item types to make it worth listing
4318them here in detail any more.
4319
4320We use an internal routine recursively to handle embedded substrings. The
4321external function follows. The yield is NULL if the expansion failed, and there
4322are two cases: if something collapsed syntactically, or if "fail" was given
4c04137d 4323as the action on a lookup failure. These can be distinguished by looking at the
059ec3d9
PH
4324variable expand_string_forcedfail, which is TRUE in the latter case.
4325
4326The skipping flag is set true when expanding a substring that isn't actually
4327going to be used (after "if" or "lookup") and it prevents lookups from
4328happening lower down.
4329
4330Store usage: At start, a store block of the length of the input plus 64
4331is obtained. This is expanded as necessary by string_cat(), which might have to
4332get a new block, or might be able to expand the original. At the end of the
4333function we can release any store above that portion of the yield block that
4334was actually used. In many cases this will be optimal.
4335
4336However: if the first item in the expansion is a variable name or header name,
4337we reset the store before processing it; if the result is in fresh store, we
4338use that without copying. This is helpful for expanding strings like
4339$message_headers which can get very long.
4340
d6b4d938
TF
4341There's a problem if a ${dlfunc item has side-effects that cause allocation,
4342since resetting the store at the end of the expansion will free store that was
4343allocated by the plugin code as well as the slop after the expanded string. So
b0e85a8f
JH
4344we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4345and, given the acl condition, ${if }. This is an unfortunate consequence of
4346string expansion becoming too powerful.
d6b4d938 4347
059ec3d9
PH
4348Arguments:
4349 string the string to be expanded
4350 ket_ends true if expansion is to stop at }
4351 left if not NULL, a pointer to the first character after the
4352 expansion is placed here (typically used with ket_ends)
4353 skipping TRUE for recursive calls when the value isn't actually going
4354 to be used (to allow for optimisation)
da6dbe26
PP
4355 honour_dollar TRUE if $ is to be expanded,
4356 FALSE if it's just another character
b0e85a8f
JH
4357 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4358 the store.
059ec3d9
PH
4359
4360Returns: NULL if expansion fails:
4361 expand_string_forcedfail is set TRUE if failure was forced
4362 expand_string_message contains a textual error message
4363 a pointer to the expanded string on success
4364*/
4365
4366static uschar *
55414b25 4367expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
b0e85a8f 4368 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
059ec3d9 4369{
f3ebb786 4370rmark reset_point = store_mark();
acec9514 4371gstring * yield = string_get(Ustrlen(string) + 64);
5f5be492 4372int item_type;
55414b25 4373const uschar *s = string;
059ec3d9
PH
4374uschar *save_expand_nstring[EXPAND_MAXN+1];
4375int save_expand_nlength[EXPAND_MAXN+1];
d6b4d938 4376BOOL resetok = TRUE;
059ec3d9 4377
e1d04f48 4378expand_level++;
e47376be 4379DEBUG(D_expand)
ae8f9024
JH
4380 DEBUG(D_noutf8)
4381 debug_printf_indent("/%s: %s\n",
4382 skipping ? "---scanning" : "considering", string);
4383 else
4384 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
4385 skipping
4386 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4387 : "considering",
4388 string);
e47376be 4389
8768d548 4390f.expand_string_forcedfail = FALSE;
059ec3d9
PH
4391expand_string_message = US"";
4392
f3ebb786
JH
4393if (is_tainted(string))
4394 {
4395 expand_string_message =
4396 string_sprintf("attempt to expand tainted string '%s'", s);
4397 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4398 goto EXPAND_FAILED;
4399 }
4400
059ec3d9
PH
4401while (*s != 0)
4402 {
4403 uschar *value;
4404 uschar name[256];
4405
4406 /* \ escapes the next character, which must exist, or else
4407 the expansion fails. There's a special escape, \N, which causes
4408 copying of the subject verbatim up to the next \N. Otherwise,
4409 the escapes are the standard set. */
4410
4411 if (*s == '\\')
4412 {
4413 if (s[1] == 0)
4414 {
4415 expand_string_message = US"\\ at end of string";
4416 goto EXPAND_FAILED;
4417 }
4418
4419 if (s[1] == 'N')
4420 {
55414b25 4421 const uschar * t = s + 2;
059ec3d9 4422 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
acec9514 4423 yield = string_catn(yield, t, s - t);
059ec3d9
PH
4424 if (*s != 0) s += 2;
4425 }
4426
4427 else
4428 {
4429 uschar ch[1];
4430 ch[0] = string_interpret_escape(&s);
4431 s++;
acec9514 4432 yield = string_catn(yield, ch, 1);
059ec3d9
PH
4433 }
4434
4435 continue;
4436 }
4437
2e23003a 4438 /*{*/
059ec3d9
PH
4439 /* Anything other than $ is just copied verbatim, unless we are
4440 looking for a terminating } character. */
4441
2e23003a 4442 /*{*/
059ec3d9
PH
4443 if (ket_ends && *s == '}') break;
4444
da6dbe26 4445 if (*s != '$' || !honour_dollar)
059ec3d9 4446 {
acec9514 4447 yield = string_catn(yield, s++, 1);
059ec3d9
PH
4448 continue;
4449 }
4450
4451 /* No { after the $ - must be a plain name or a number for string
4452 match variable. There has to be a fudge for variables that are the
4453 names of header fields preceded by "$header_" because header field
4454 names can contain any printing characters except space and colon.
4455 For those that don't like typing this much, "$h_" is a synonym for
4456 "$header_". A non-existent header yields a NULL value; nothing is
2e23003a 4457 inserted. */ /*}*/
059ec3d9
PH
4458
4459 if (isalpha((*(++s))))
4460 {
4461 int len;
4462 int newsize = 0;
bb07bcd3 4463 gstring * g = NULL;
bce15b62 4464 uschar * t;
059ec3d9
PH
4465
4466 s = read_name(name, sizeof(name), s, US"_");
4467
4468 /* If this is the first thing to be expanded, release the pre-allocated
4469 buffer. */
4470
bb07bcd3 4471 if (!yield)
f3ebb786 4472 g = store_get(sizeof(gstring), FALSE);
bb07bcd3 4473 else if (yield->ptr == 0)
059ec3d9 4474 {
f3ebb786 4475 if (resetok) reset_point = store_reset(reset_point);
059ec3d9 4476 yield = NULL;
f3ebb786
JH
4477 reset_point = store_mark();
4478 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
059ec3d9
PH
4479 }
4480
4481 /* Header */
4482
bce15b62
JH
4483 if ( ( *(t = name) == 'h'
4484 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4485 )
4486 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4487 )
059ec3d9 4488 {
bce15b62
JH
4489 unsigned flags = *name == 'r' ? FH_WANT_RAW
4490 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4491 : 0;
4492 uschar * charset = *name == 'b' ? NULL : headers_charset;
4493
059ec3d9 4494 s = read_header_name(name, sizeof(name), s);
bce15b62 4495 value = find_header(name, &newsize, flags, charset);
059ec3d9
PH
4496
4497 /* If we didn't find the header, and the header contains a closing brace
0d85fa3f 4498 character, this may be a user error where the terminating colon
059ec3d9
PH
4499 has been omitted. Set a flag to adjust the error message in this case.
4500 But there is no error here - nothing gets inserted. */
4501
acec9514 4502 if (!value)
059ec3d9 4503 {
5694b905 4504 if (Ustrchr(name, '}')) malformed_header = TRUE;
059ec3d9
PH
4505 continue;
4506 }
4507 }
4508
4509 /* Variable */
4510
63df3f26 4511 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
059ec3d9 4512 {
63df3f26
JH
4513 expand_string_message =
4514 string_sprintf("unknown variable name \"%s\"", name);
4515 check_variable_error_message(name);
4516 goto EXPAND_FAILED;
059ec3d9
PH
4517 }
4518
4519 /* If the data is known to be in a new buffer, newsize will be set to the
4520 size of that buffer. If this is the first thing in an expansion string,
4521 yield will be NULL; just point it at the new store instead of copying. Many
4522 expansion strings contain just one reference, so this is a useful
acec9514
JH
4523 optimization, especially for humungous headers. We need to use a gstring
4524 structure that is not allocated after that new-buffer, else a later store
4525 reset in the middle of the buffer will make it inaccessible. */
059ec3d9
PH
4526
4527 len = Ustrlen(value);
acec9514 4528 if (!yield && newsize != 0)
059ec3d9 4529 {
acec9514
JH
4530 yield = g;
4531 yield->size = newsize;
4532 yield->ptr = len;
4533 yield->s = value;
059ec3d9 4534 }
bb07bcd3
JH
4535 else
4536 yield = string_catn(yield, value, len);
059ec3d9
PH
4537
4538 continue;
4539 }
4540
4541 if (isdigit(*s))
4542 {
4543 int n;
55414b25 4544 s = read_cnumber(&n, s);
059ec3d9 4545 if (n >= 0 && n <= expand_nmax)
acec9514 4546 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
059ec3d9
PH
4547 continue;
4548 }
4549
2e23003a 4550 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
059ec3d9 4551
2e23003a 4552 if (*s != '{') /*}*/
059ec3d9 4553 {
2e23003a 4554 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
059ec3d9
PH
4555 goto EXPAND_FAILED;
4556 }
4557
4558 /* After { there can be various things, but they all start with
4559 an initial word, except for a number for a string match variable. */
4560
4561 if (isdigit((*(++s))))
4562 {
4563 int n;
55414b25 4564 s = read_cnumber(&n, s); /*{*/
059ec3d9 4565 if (*s++ != '}')
2e23003a 4566 { /*{*/
059ec3d9
PH
4567 expand_string_message = US"} expected after number";
4568 goto EXPAND_FAILED;
4569 }
4570 if (n >= 0 && n <= expand_nmax)
acec9514 4571 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
059ec3d9
PH
4572 continue;
4573 }
4574
4575 if (!isalpha(*s))
4576 {
2e23003a 4577 expand_string_message = US"letter or digit expected after ${"; /*}*/
059ec3d9
PH
4578 goto EXPAND_FAILED;
4579 }
4580
4581 /* Allow "-" in names to cater for substrings with negative
4582 arguments. Since we are checking for known names after { this is
4583 OK. */
4584
4585 s = read_name(name, sizeof(name), s, US"_-");
0539a19d 4586 item_type = chop_match(name, item_table, nelem(item_table));
059ec3d9
PH
4587
4588 switch(item_type)
4589 {
525239c1 4590 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
333eea9c 4591 If the ACL returns accept or reject we return content set by "message ="
723c72e6
JH
4592 There is currently no limit on recursion; this would have us call
4593 acl_check_internal() directly and get a current level from somewhere.
f60d98e8
JH
4594 See also the acl expansion condition ECOND_ACL and the traditional
4595 acl modifier ACLC_ACL.
be7a5781 4596 Assume that the function has side-effects on the store that must be preserved.
723c72e6
JH
4597 */
4598
4599 case EITEM_ACL:
333eea9c 4600 /* ${acl {name} {arg1}{arg2}...} */
723c72e6 4601 {
333eea9c 4602 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
723c72e6 4603 uschar *user_msg;
17ccbda6 4604 int rc;
333eea9c 4605
089fc87a
JH
4606 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4607 &resetok))
723c72e6
JH
4608 {
4609 case 1: goto EXPAND_FAILED_CURLY;
4610 case 2:
4611 case 3: goto EXPAND_FAILED;
4612 }
4613 if (skipping) continue;
4614
be7a5781 4615 resetok = FALSE;
17ccbda6 4616 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
723c72e6
JH
4617 {
4618 case OK:
333eea9c 4619 case FAIL:
187bc588 4620 DEBUG(D_expand)
e1d04f48 4621 debug_printf_indent("acl expansion yield: %s\n", user_msg);
723c72e6 4622 if (user_msg)
acec9514 4623 yield = string_cat(yield, user_msg);
723c72e6 4624 continue;
333eea9c 4625
723c72e6 4626 case DEFER:
8768d548 4627 f.expand_string_forcedfail = TRUE;
6e3b198d 4628 /*FALLTHROUGH*/
723c72e6 4629 default:
17ccbda6
JH
4630 expand_string_message = string_sprintf("%s from acl \"%s\"",
4631 rc_names[rc], sub[0]);
723c72e6
JH
4632 goto EXPAND_FAILED;
4633 }
4634 }
4635
dfbcb5ac
JH
4636 case EITEM_AUTHRESULTS:
4637 /* ${authresults {mysystemname}} */
4638 {
4639 uschar *sub_arg[1];
4640
4641 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4642 &resetok))
4643 {
4644 case 1: goto EXPAND_FAILED_CURLY;
4645 case 2:
4646 case 3: goto EXPAND_FAILED;
4647 }
4648
4649 yield = string_append(yield, 3,
4650 US"Authentication-Results: ", sub_arg[0], US"; none");
4651 yield->ptr -= 6;
4652
40394cc1 4653 yield = authres_local(yield, sub_arg[0]);
dfbcb5ac
JH
4654 yield = authres_iprev(yield);
4655 yield = authres_smtpauth(yield);
4656#ifdef SUPPORT_SPF
4657 yield = authres_spf(yield);
4658#endif
4659#ifndef DISABLE_DKIM
4660 yield = authres_dkim(yield);
617d3932 4661#endif
1a2e76e1 4662#ifdef SUPPORT_DMARC
c9cf9ac4
JH
4663 yield = authres_dmarc(yield);
4664#endif
617d3932
JH
4665#ifdef EXPERIMENTAL_ARC
4666 yield = authres_arc(yield);
dfbcb5ac
JH
4667#endif
4668 continue;
4669 }
4670
059ec3d9
PH
4671 /* Handle conditionals - preserve the values of the numerical expansion
4672 variables in case they get changed by a regular expression match in the
4673 condition. If not, they retain their external settings. At the end
4674 of this "if" section, they get restored to their previous values. */
4675
4676 case EITEM_IF:
4677 {
4678 BOOL cond = FALSE;
55414b25 4679 const uschar *next_s;
059ec3d9
PH
4680 int save_expand_nmax =
4681 save_expand_strings(save_expand_nstring, save_expand_nlength);
4682
4683 while (isspace(*s)) s++;
5694b905
JH
4684 if (!(next_s = eval_condition(s, &resetok, skipping ? NULL : &cond)))
4685 goto EXPAND_FAILED; /* message already set */
059ec3d9
PH
4686
4687 DEBUG(D_expand)
ae8f9024
JH
4688 DEBUG(D_noutf8)
4689 {
4690 debug_printf_indent("|--condition: %.*s\n", (int)(next_s - s), s);
4691 debug_printf_indent("|-----result: %s\n", cond ? "true" : "false");
4692 }
4693 else
4694 {
4695 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4696 "condition: %.*s\n",
4697 (int)(next_s - s), s);
4698 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4699 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4700 "result: %s\n",
4701 cond ? "true" : "false");
4702 }
059ec3d9
PH
4703
4704 s = next_s;
4705
4706 /* The handling of "yes" and "no" result strings is now in a separate
4707 function that is also used by ${lookup} and ${extract} and ${run}. */
4708
4709 switch(process_yesno(
4710 skipping, /* were previously skipping */
4711 cond, /* success/failure indicator */
4712 lookup_value, /* value to reset for string2 */
4713 &s, /* input pointer */
4714 &yield, /* output pointer */
b0e85a8f
JH
4715 US"if", /* condition type */
4716 &resetok))
059ec3d9
PH
4717 {
4718 case 1: goto EXPAND_FAILED; /* when all is well, the */
4719 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4720 }
4721
4722 /* Restore external setting of expansion variables for continuation
4723 at this level. */
4724
b0e85a8f
JH
4725 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4726 save_expand_nlength);
059ec3d9
PH
4727 continue;
4728 }
4729
8c5d388a 4730#ifdef SUPPORT_I18N
ed0512a1
JH
4731 case EITEM_IMAPFOLDER:
4732 { /* ${imapfolder {name}{sep]{specials}} */
4733 uschar *sub_arg[3];
4734 uschar *encoded;
4735
0539a19d
JH
4736 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4737 &resetok))
ed0512a1
JH
4738 {
4739 case 1: goto EXPAND_FAILED_CURLY;
4740 case 2:
4741 case 3: goto EXPAND_FAILED;
4742 }
4743
5694b905 4744 if (!sub_arg[1]) /* One argument */
ed0512a1 4745 {
0539a19d 4746 sub_arg[1] = US"/"; /* default separator */
ed0512a1
JH
4747 sub_arg[2] = NULL;
4748 }
0539a19d 4749 else if (Ustrlen(sub_arg[1]) != 1)
ed0512a1 4750 {
94431adb 4751 expand_string_message =
ed0512a1 4752 string_sprintf(
94431adb 4753 "IMAP folder separator must be one character, found \"%s\"",
ed0512a1
JH
4754 sub_arg[1]);
4755 goto EXPAND_FAILED;
4756 }
4757
ed0512a1 4758 if (!skipping)
f267271d
JH
4759 {
4760 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4761 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4762 goto EXPAND_FAILED;
acec9514 4763 yield = string_cat(yield, encoded);
f267271d 4764 }
ed0512a1
JH
4765 continue;
4766 }
4767#endif
4768
059ec3d9
PH
4769 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4770 expanding an internal string that isn't actually going to be used. All we
4771 need to do is check the syntax, so don't do a lookup at all. Preserve the
4772 values of the numerical expansion variables in case they get changed by a
4773 partial lookup. If not, they retain their external settings. At the end
4774 of this "lookup" section, they get restored to their previous values. */
4775
4776 case EITEM_LOOKUP:
4777 {
4778 int stype, partial, affixlen, starflags;
4779 int expand_setup = 0;
4780 int nameptr = 0;
55414b25
JH
4781 uschar *key, *filename;
4782 const uschar *affix;
059ec3d9
PH
4783 uschar *save_lookup_value = lookup_value;
4784 int save_expand_nmax =
4785 save_expand_strings(save_expand_nstring, save_expand_nlength);
4786
4787 if ((expand_forbid & RDO_LOOKUP) != 0)
4788 {
4789 expand_string_message = US"lookup expansions are not permitted";
4790 goto EXPAND_FAILED;
4791 }
4792
4793 /* Get the key we are to look up for single-key+file style lookups.
4794 Otherwise set the key NULL pro-tem. */
4795
4796 while (isspace(*s)) s++;
2e23003a 4797 if (*s == '{') /*}*/
059ec3d9 4798 {
b0e85a8f 4799 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
e47376be
JH
4800 if (!key) goto EXPAND_FAILED; /*{{*/
4801 if (*s++ != '}')
4802 {
4803 expand_string_message = US"missing '}' after lookup key";
4804 goto EXPAND_FAILED_CURLY;
4805 }
059ec3d9
PH
4806 while (isspace(*s)) s++;
4807 }
4808 else key = NULL;
4809
4810 /* Find out the type of database */
4811
4812 if (!isalpha(*s))
4813 {
4814 expand_string_message = US"missing lookup type";
4815 goto EXPAND_FAILED;
4816 }
4817
4818 /* The type is a string that may contain special characters of various
4819 kinds. Allow everything except space or { to appear; the actual content
2e23003a 4820 is checked by search_findtype_partial. */ /*}*/
059ec3d9 4821
2e23003a 4822 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
059ec3d9
PH
4823 {
4824 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4825 s++;
4826 }
4827 name[nameptr] = 0;
4828 while (isspace(*s)) s++;
4829
4830 /* Now check for the individual search type and any partial or default
4831 options. Only those types that are actually in the binary are valid. */
4832
4833 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4834 &starflags);
4835 if (stype < 0)
4836 {
4837 expand_string_message = search_error_message;
4838 goto EXPAND_FAILED;
4839 }
4840
4841 /* Check that a key was provided for those lookup types that need it,
4842 and was not supplied for those that use the query style. */
4843
13b685f9 4844 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
059ec3d9 4845 {
5694b905 4846 if (!key)
059ec3d9
PH
4847 {
4848 expand_string_message = string_sprintf("missing {key} for single-"
4849 "key \"%s\" lookup", name);
4850 goto EXPAND_FAILED;
4851 }
4852 }
4853 else
4854 {
5694b905 4855 if (key)
059ec3d9
PH
4856 {
4857 expand_string_message = string_sprintf("a single key was given for "
4858 "lookup type \"%s\", which is not a single-key lookup type", name);
4859 goto EXPAND_FAILED;
4860 }
4861 }
4862
4863 /* Get the next string in brackets and expand it. It is the file name for
13b685f9
PH
4864 single-key+file lookups, and the whole query otherwise. In the case of
4865 queries that also require a file name (e.g. sqlite), the file name comes
4866 first. */
059ec3d9 4867
e47376be
JH
4868 if (*s != '{')
4869 {
4870 expand_string_message = US"missing '{' for lookup file-or-query arg";
4871 goto EXPAND_FAILED_CURLY;
4872 }
5694b905
JH
4873 if (!(filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
4874 goto EXPAND_FAILED;
e47376be
JH
4875 if (*s++ != '}')
4876 {
4877 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4878 goto EXPAND_FAILED_CURLY;
4879 }
059ec3d9
PH
4880 while (isspace(*s)) s++;
4881
4882 /* If this isn't a single-key+file lookup, re-arrange the variables
13b685f9
PH
4883 to be appropriate for the search_ functions. For query-style lookups,
4884 there is just a "key", and no file name. For the special query-style +
4885 file types, the query (i.e. "key") starts with a file name. */
059ec3d9 4886
e47376be 4887 if (!key)
059ec3d9 4888 {
13b685f9 4889 while (isspace(*filename)) filename++;
059ec3d9 4890 key = filename;
13b685f9
PH
4891
4892 if (mac_islookup(stype, lookup_querystyle))
13b685f9 4893 filename = NULL;
13b685f9 4894 else
298849d8
JH
4895 if (*filename == '/')
4896 {
4897 while (*key && !isspace(*key)) key++;
4898 if (*key) *key++ = '\0';
4899 }
4900 else
4901 filename = NULL;
059ec3d9
PH
4902 }
4903
4904 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4905 the entry was not found. Note that there is no search_close() function.
4906 Files are left open in case of re-use. At suitable places in higher logic,
4907 search_tidyup() is called to tidy all open files. This can save opening
4908 the same file several times. However, files may also get closed when
4909 others are opened, if too many are open at once. The rule is that a
4910 handle should not be used after a second search_open().
4911
4912 Request that a partial search sets up $1 and maybe $2 by passing
4913 expand_setup containing zero. If its value changes, reset expand_nmax,
4914 since new variables will have been set. Note that at the end of this
4915 "lookup" section, the old numeric variables are restored. */
4916
4917 if (skipping)
4918 lookup_value = NULL;
4919 else
4920 {
4921 void *handle = search_open(filename, stype, 0, NULL, NULL);
5694b905 4922 if (!handle)
059ec3d9
PH
4923 {
4924 expand_string_message = search_error_message;
4925 goto EXPAND_FAILED;
4926 }
4927 lookup_value = search_find(handle, filename, key, partial, affix,
4928 affixlen, starflags, &expand_setup);
8768d548 4929 if (f.search_find_defer)
059ec3d9
PH
4930 {
4931 expand_string_message =
b72aab72
PP
4932 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4933 string_printing2(key, FALSE), search_error_message);
059ec3d9
PH
4934 goto EXPAND_FAILED;
4935 }
4936 if (expand_setup > 0) expand_nmax = expand_setup;
4937 }
4938
4939 /* The handling of "yes" and "no" result strings is now in a separate
4940 function that is also used by ${if} and ${extract}. */
4941
4942 switch(process_yesno(
4943 skipping, /* were previously skipping */
4944 lookup_value != NULL, /* success/failure indicator */
4945 save_lookup_value, /* value to reset for string2 */
4946 &s, /* input pointer */
4947 &yield, /* output pointer */
b0e85a8f
JH
4948 US"lookup", /* condition type */
4949 &resetok))
059ec3d9
PH
4950 {
4951 case 1: goto EXPAND_FAILED; /* when all is well, the */
4952 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4953 }
4954
4955 /* Restore external setting of expansion variables for carrying on
4956 at this level, and continue. */
4957
4958 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4959 save_expand_nlength);
4960 continue;
4961 }
4962
4963 /* If Perl support is configured, handle calling embedded perl subroutines,
4964 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4965 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4966 arguments (defined below). */
4967
059ec3d9
PH
4968 #define EXIM_PERL_MAX_ARGS 8
4969
4970 case EITEM_PERL:
1a46a8c5 4971 #ifndef EXIM_PERL
2e23003a 4972 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
1a46a8c5
PH
4973 "is not included in this binary";
4974 goto EXPAND_FAILED;
4975
4976 #else /* EXIM_PERL */
059ec3d9
PH
4977 {
4978 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
acec9514 4979 gstring *new_yield;
059ec3d9
PH
4980
4981 if ((expand_forbid & RDO_PERL) != 0)
4982 {
4983 expand_string_message = US"Perl calls are not permitted";
4984 goto EXPAND_FAILED;
4985 }
4986
4987 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
b0e85a8f 4988 US"perl", &resetok))
059ec3d9
PH
4989 {
4990 case 1: goto EXPAND_FAILED_CURLY;
4991 case 2:
4992 case 3: goto EXPAND_FAILED;
4993 }
4994
4995 /* If skipping, we don't actually do anything */
4996
4997 if (skipping) continue;
4998
4999 /* Start the interpreter if necessary */
5000
5001 if (!opt_perl_started)
5002 {
5003 uschar *initerror;
5694b905 5004 if (!opt_perl_startup)
059ec3d9
PH
5005 {
5006 expand_string_message = US"A setting of perl_startup is needed when "
5007 "using the Perl interpreter";
5008 goto EXPAND_FAILED;
5009 }
5010 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5694b905 5011 if ((initerror = init_perl(opt_perl_startup)))
059ec3d9
PH
5012 {
5013 expand_string_message =
5014 string_sprintf("error in perl_startup code: %s\n", initerror);
5015 goto EXPAND_FAILED;
5016 }
5017 opt_perl_started = TRUE;
5018 }
5019
5020 /* Call the function */
5021
5022 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
acec9514 5023 new_yield = call_perl_cat(yield, &expand_string_message,
059ec3d9
PH
5024 sub_arg[0], sub_arg + 1);
5025
5026 /* NULL yield indicates failure; if the message pointer has been set to
5027 NULL, the yield was undef, indicating a forced failure. Otherwise the
5028 message will indicate some kind of Perl error. */
5029
5694b905 5030 if (!new_yield)
059ec3d9 5031 {
5694b905 5032 if (!expand_string_message)
059ec3d9
PH
5033 {
5034 expand_string_message =
5035 string_sprintf("Perl subroutine \"%s\" returned undef to force "
5036 "failure", sub_arg[0]);
8768d548 5037 f.expand_string_forcedfail = TRUE;
059ec3d9
PH
5038 }
5039 goto EXPAND_FAILED;
5040 }
5041
5042 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5043 set during a callback from Perl. */
5044
8768d548 5045 f.expand_string_forcedfail = FALSE;
059ec3d9
PH
5046 yield = new_yield;
5047 continue;
5048 }
5049 #endif /* EXIM_PERL */
5050
fffda43a
TK
5051 /* Transform email address to "prvs" scheme to use
5052 as BATV-signed return path */
5053
5054 case EITEM_PRVS:
5055 {
5056 uschar *sub_arg[3];
5057 uschar *p,*domain;
5058
b0e85a8f 5059 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
fffda43a
TK
5060 {
5061 case 1: goto EXPAND_FAILED_CURLY;
5062 case 2:
5063 case 3: goto EXPAND_FAILED;
5064 }
5065
5066 /* If skipping, we don't actually do anything */
5067 if (skipping) continue;
5068
5069 /* sub_arg[0] is the address */
db4dcd57
JH
5070 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
5071 || domain == sub_arg[0] || Ustrlen(domain) == 1)
fffda43a 5072 {
cb9328de
PH
5073 expand_string_message = US"prvs first argument must be a qualified email address";
5074 goto EXPAND_FAILED;
5075 }
5076
db4dcd57 5077 /* Calculate the hash. The third argument must be a single-digit
cb9328de
PH
5078 key number, or unset. */
5079
db4dcd57
JH
5080 if ( sub_arg[2]
5081 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
cb9328de 5082 {
db4dcd57 5083 expand_string_message = US"prvs third argument must be a single digit";
fffda43a
TK
5084 goto EXPAND_FAILED;
5085 }
5086
db4dcd57
JH
5087 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5088 if (!p)
fffda43a 5089 {
cb9328de 5090 expand_string_message = US"prvs hmac-sha1 conversion failed";
fffda43a
TK
5091 goto EXPAND_FAILED;
5092 }
5093
5094 /* Now separate the domain from the local part */
5095 *domain++ = '\0';
5096
acec9514
JH
5097 yield = string_catn(yield, US"prvs=", 5);
5098 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5099 yield = string_catn(yield, prvs_daystamp(7), 3);
5100 yield = string_catn(yield, p, 6);
5101 yield = string_catn(yield, US"=", 1);
5102 yield = string_cat (yield, sub_arg[0]);
5103 yield = string_catn(yield, US"@", 1);
5104 yield = string_cat (yield, domain);
fffda43a
TK
5105
5106 continue;
5107 }
5108
5109 /* Check a prvs-encoded address for validity */
5110
5111 case EITEM_PRVSCHECK:
5112 {
5113 uschar *sub_arg[3];
acec9514 5114 gstring * g;
fffda43a
TK
5115 const pcre *re;
5116 uschar *p;
72fdd6ae
PH
5117
5118 /* TF: Ugliness: We want to expand parameter 1 first, then set
fffda43a
TK
5119 up expansion variables that are used in the expansion of
5120 parameter 2. So we clone the string for the first
72fdd6ae
PH
5121 expansion, where we only expand parameter 1.
5122
5123 PH: Actually, that isn't necessary. The read_subs() function is
5124 designed to work this way for the ${if and ${lookup expansions. I've
5125 tidied the code.
5126 */
fffda43a
TK
5127
5128 /* Reset expansion variables */
5129 prvscheck_result = NULL;
5130 prvscheck_address = NULL;
5131 prvscheck_keynum = NULL;
5132
b0e85a8f 5133 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
fffda43a
TK
5134 {
5135 case 1: goto EXPAND_FAILED_CURLY;
5136 case 2:
5137 case 3: goto EXPAND_FAILED;
5138 }
5139
a48ced90 5140 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
fffda43a
TK
5141 TRUE,FALSE);
5142
72fdd6ae
PH
5143 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5144 {
a48ced90
TK
5145 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5146 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5147 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5148 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
fffda43a
TK
5149 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5150
e1d04f48
JH
5151 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
5152 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
5153 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5154 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
5155 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
fffda43a
TK
5156
5157 /* Set up expansion variables */
acec9514
JH
5158 g = string_cat (NULL, local_part);
5159 g = string_catn(g, US"@", 1);
5160 g = string_cat (g, domain);
5161 prvscheck_address = string_from_gstring(g);
fffda43a
TK
5162 prvscheck_keynum = string_copy(key_num);
5163
72fdd6ae 5164 /* Now expand the second argument */
b0e85a8f 5165 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
fffda43a
TK
5166 {
5167 case 1: goto EXPAND_FAILED_CURLY;
5168 case 2:
5169 case 3: goto EXPAND_FAILED;
5170 }
5171
fffda43a 5172 /* Now we have the key and can check the address. */
72fdd6ae
PH
5173
5174 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5175 daystamp);
5176
acec9514 5177 if (!p)
fffda43a
TK
5178 {
5179 expand_string_message = US"hmac-sha1 conversion failed";
5180 goto EXPAND_FAILED;
5181 }
5182
e1d04f48
JH
5183 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5184 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
72fdd6ae 5185
fffda43a
TK
5186 if (Ustrcmp(p,hash) == 0)
5187 {
5188 /* Success, valid BATV address. Now check the expiry date. */
5189 uschar *now = prvs_daystamp(0);
5190 unsigned int inow = 0,iexpire = 1;
5191
ff790e47
PH
5192 (void)sscanf(CS now,"%u",&inow);
5193 (void)sscanf(CS daystamp,"%u",&iexpire);
fffda43a 5194
aded2255 5195 /* When "iexpire" is < 7, a "flip" has occurred.
fffda43a
TK
5196 Adjust "inow" accordingly. */
5197 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5198
686c36b7 5199 if (iexpire >= inow)
fffda43a
TK
5200 {
5201 prvscheck_result = US"1";
e1d04f48 5202 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
fffda43a 5203 }
db4dcd57 5204 else
fffda43a
TK
5205 {
5206 prvscheck_result = NULL;
e1d04f48 5207 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
fffda43a
TK
5208 }
5209 }
5210 else
5211 {
5212 prvscheck_result = NULL;
e1d04f48 5213 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
fffda43a 5214 }
72fdd6ae
PH
5215
5216 /* Now expand the final argument. We leave this till now so that
5217 it can include $prvscheck_result. */
5218
b0e85a8f 5219 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
72fdd6ae
PH
5220 {
5221 case 1: goto EXPAND_FAILED_CURLY;
5222 case 2:
5223 case 3: goto EXPAND_FAILED;
5224 }
5225
acec9514 5226 yield = string_cat(yield,
c2f669a4 5227 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
72fdd6ae
PH
5228
5229 /* Reset the "internal" variables afterwards, because they are in
5230 dynamic store that will be reclaimed if the expansion succeeded. */
5231
5232 prvscheck_address = NULL;
5233 prvscheck_keynum = NULL;
5234 }
fffda43a 5235 else
fffda43a 5236 /* Does not look like a prvs encoded address, return the empty string.
72fdd6ae
PH
5237 We need to make sure all subs are expanded first, so as to skip over
5238 the entire item. */
5239
b0e85a8f 5240 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
fffda43a
TK
5241 {
5242 case 1: goto EXPAND_FAILED_CURLY;
5243 case 2:
5244 case 3: goto EXPAND_FAILED;
5245 }
fffda43a
TK
5246
5247 continue;
5248 }
5249
059ec3d9
PH
5250 /* Handle "readfile" to insert an entire file */
5251
5252 case EITEM_READFILE:
5253 {
5254 FILE *f;
5255 uschar *sub_arg[2];
5256
5257 if ((expand_forbid & RDO_READFILE) != 0)
5258 {
5259 expand_string_message = US"file insertions are not permitted";
5260 goto EXPAND_FAILED;
5261 }
5262
b0e85a8f 5263 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
059ec3d9
PH
5264 {
5265 case 1: goto EXPAND_FAILED_CURLY;
5266 case 2:
5267 case 3: goto EXPAND_FAILED;
5268 }
5269
5270 /* If skipping, we don't actually do anything */
5271
5272 if (skipping) continue;
5273
5274 /* Open the file and read it */
5275
4a5cbaff 5276 if (!(f = Ufopen(sub_arg[0], "rb")))
059ec3d9
PH
5277 {
5278 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
5279 goto EXPAND_FAILED;
5280 }
5281
acec9514 5282 yield = cat_file(f, yield, sub_arg[1]);
f1e894f3 5283 (void)fclose(f);
059ec3d9
PH
5284 continue;
5285 }
5286
4a5cbaff
JH
5287 /* Handle "readsocket" to insert data from a socket, either
5288 Inet or Unix domain */
059ec3d9
PH
5289
5290 case EITEM_READSOCK:
5291 {
c05bdbd6 5292 client_conn_ctx cctx;
059ec3d9 5293 int timeout = 5;
03f110c5 5294 int save_ptr = gstring_length(yield);
dca6d121 5295 FILE * fp = NULL;
afdb5e9c
JH
5296 uschar * arg;
5297 uschar * sub_arg[4];
5298 uschar * server_name = NULL;
5299 host_item host;
8de9db65 5300 BOOL do_shutdown = TRUE;
01603eec 5301 BOOL do_tls = FALSE; /* Only set under ! DISABLE_TLS */
4a5cbaff 5302 blob reqstr;
059ec3d9 5303
8de9db65 5304 if (expand_forbid & RDO_READSOCK)
059ec3d9
PH
5305 {
5306 expand_string_message = US"socket insertions are not permitted";
5307 goto EXPAND_FAILED;
5308 }
5309
5310 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5311 because there may be a string for expansion on failure. */
5312
b0e85a8f 5313 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
059ec3d9
PH
5314 {
5315 case 1: goto EXPAND_FAILED_CURLY;
5316 case 2: /* Won't occur: no end check */
5317 case 3: goto EXPAND_FAILED;
5318 }
5319
4a5cbaff
JH
5320 /* Grab the request string, if any */
5321
5322 reqstr.data = sub_arg[1];
5323 reqstr.len = Ustrlen(sub_arg[1]);
5324
8de9db65
JH
5325 /* Sort out timeout, if given. The second arg is a list with the first element
5326 being a time value. Any more are options of form "name=value". Currently the
5327 only option recognised is "shutdown". */
059ec3d9 5328
8de9db65 5329 if (sub_arg[2])
059ec3d9 5330 {
8de9db65
JH
5331 const uschar * list = sub_arg[2];
5332 uschar * item;
5333 int sep = 0;
5334
c06ddd66
JH
5335 if ( !(item = string_nextinlist(&list, &sep, NULL, 0))
5336 || !*item
5337 || (timeout = readconf_readtime(item, 0, FALSE)) < 0)
059ec3d9 5338 {
8de9db65 5339 expand_string_message = string_sprintf("bad time value %s", item);
059ec3d9
PH
5340 goto EXPAND_FAILED;
5341 }
8de9db65
JH
5342
5343 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5344 if (Ustrncmp(item, US"shutdown=", 9) == 0)
afdb5e9c 5345 { if (Ustrcmp(item + 9, US"no") == 0) do_shutdown = FALSE; }
01603eec 5346#ifndef DISABLE_TLS
afdb5e9c
JH
5347 else if (Ustrncmp(item, US"tls=", 4) == 0)
5348 { if (Ustrcmp(item + 9, US"no") != 0) do_tls = TRUE; }
5349#endif
059ec3d9 5350 }
afdb5e9c
JH
5351 else
5352 sub_arg[3] = NULL; /* No eol if no timeout */
059ec3d9 5353
1cce3af8
PH
5354 /* If skipping, we don't actually do anything. Otherwise, arrange to
5355 connect to either an IP or a Unix socket. */
059ec3d9
PH
5356
5357 if (!skipping)
5358 {
1cce3af8 5359 /* Handle an IP (internet) domain */
059ec3d9 5360
91ecef39 5361 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
059ec3d9 5362 {
b1f8e4f8 5363 int port;
afdb5e9c
JH
5364 uschar * port_name;
5365
5366 server_name = sub_arg[0] + 5;
5367 port_name = Ustrrchr(server_name, ':');
1cce3af8
PH
5368
5369 /* Sort out the port */
5370
4a5cbaff 5371 if (!port_name)
1cce3af8
PH
5372 {
5373 expand_string_message =
5374 string_sprintf("missing port for readsocket %s", sub_arg[0]);
5375 goto EXPAND_FAILED;
5376 }
5377 *port_name++ = 0; /* Terminate server name */
5378
5379 if (isdigit(*port_name))
5380 {
5381 uschar *end;
5382 port = Ustrtol(port_name, &end, 0);
5383 if (end != port_name + Ustrlen(port_name))
5384 {
5385 expand_string_message =
5386 string_sprintf("invalid port number %s", port_name);
5387 goto EXPAND_FAILED;
5388 }
5389 }
5390 else
5391 {
5392 struct servent *service_info = getservbyname(CS port_name, "tcp");
4a5cbaff 5393 if (!service_info)
1cce3af8
PH
5394 {
5395 expand_string_message = string_sprintf("unknown port \"%s\"",
5396 port_name);
5397 goto EXPAND_FAILED;
5398 }
5399 port = ntohs(service_info->s_port);
5400 }
5401
b10c87b3 5402 /*XXX we trust that the request is idempotent for TFO. Hmm. */
c05bdbd6 5403 cctx.sock = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
afdb5e9c
JH
5404 timeout, &host, &expand_string_message,
5405 do_tls ? NULL : &reqstr);
90341c71 5406 callout_address = NULL;
c05bdbd6 5407 if (cctx.sock < 0)
48334568
JH
5408 goto SOCK_FAIL;
5409 if (!do_tls)
5410 reqstr.len = 0;
059ec3d9
PH
5411 }
5412
1cce3af8
PH
5413 /* Handle a Unix domain socket */
5414
5415 else
059ec3d9 5416 {
4a5cbaff 5417 struct sockaddr_un sockun; /* don't call this "sun" ! */
a401ddaa 5418 int rc;
4a5cbaff 5419
c05bdbd6 5420 if ((cctx.sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
1cce3af8
PH
5421 {
5422 expand_string_message = string_sprintf("failed to create socket: %s",
5423 strerror(errno));
5424 goto SOCK_FAIL;
5425 }
5426
5427 sockun.sun_family = AF_UNIX;
5428 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
5429 sub_arg[0]);
13c7874e 5430 server_name = US sockun.sun_path;
a401ddaa
PH
5431
5432 sigalrm_seen = FALSE;
c2a1bba0 5433 ALARM(timeout);
c05bdbd6 5434 rc = connect(cctx.sock, (struct sockaddr *)(&sockun), sizeof(sockun));
c2a1bba0 5435 ALARM_CLR(0);
734e1499 5436 if (sigalrm_seen)
1cce3af8 5437 {
734e1499 5438 expand_string_message = US "socket connect timed out";
1cce3af8
PH
5439 goto SOCK_FAIL;
5440 }
734e1499 5441 if (rc < 0)
a401ddaa 5442 {
734e1499
PH
5443 expand_string_message = string_sprintf("failed to connect to socket "
5444 "%s: %s", sub_arg[0], strerror(errno));
a401ddaa
PH
5445 goto SOCK_FAIL;
5446 }
afdb5e9c
JH
5447 host.name = server_name;
5448 host.address = US"";
059ec3d9 5449 }
1cce3af8 5450
e1d04f48 5451 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
059ec3d9 5452
01603eec 5453#ifndef DISABLE_TLS
afdb5e9c
JH
5454 if (do_tls)
5455 {
c05bdbd6 5456 smtp_connect_args conn_args = {.host = &host };
9377b957 5457 tls_support tls_dummy = {.sni=NULL};
afdb5e9c
JH
5458 uschar * errstr;
5459
c05bdbd6 5460 if (!tls_client_start(&cctx, &conn_args, NULL, &tls_dummy, &errstr))
afdb5e9c
JH
5461 {
5462 expand_string_message = string_sprintf("TLS connect failed: %s", errstr);
5463 goto SOCK_FAIL;
5464 }
5465 }
5466#endif
5467
567e584c 5468 /* Allow sequencing of test actions */
9f01e50d 5469 testharness_pause_ms(100);
567e584c 5470
4a5cbaff 5471 /* Write the request string, if not empty or already done */
059ec3d9 5472
4a5cbaff 5473 if (reqstr.len)
059ec3d9 5474 {
e1d04f48 5475 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
4a5cbaff 5476 reqstr.data);
afdb5e9c 5477 if ( (
01603eec 5478#ifndef DISABLE_TLS
0578f405 5479 do_tls ? tls_write(cctx.tls_ctx, reqstr.data, reqstr.len, FALSE) :
afdb5e9c 5480#endif
c05bdbd6 5481 write(cctx.sock, reqstr.data, reqstr.len)) != reqstr.len)
059ec3d9
PH
5482 {
5483 expand_string_message = string_sprintf("request write to socket "
5484 "failed: %s", strerror(errno));
5485 goto SOCK_FAIL;
5486 }
5487 }
5488
c1114884
PH
5489 /* Shut down the sending side of the socket. This helps some servers to
5490 recognise that it is their turn to do some work. Just in case some
5491 system doesn't have this function, make it conditional. */
5492
8de9db65 5493#ifdef SHUT_WR
0578f405 5494 if (!do_tls && do_shutdown) shutdown(cctx.sock, SHUT_WR);
8de9db65 5495#endif
c1114884 5496
9f01e50d 5497 testharness_pause_ms(100);
567e584c 5498
059ec3d9
PH
5499 /* Now we need to read from the socket, under a timeout. The function
5500 that reads a file can be used. */
5501
0578f405 5502 if (!do_tls)
c05bdbd6 5503 fp = fdopen(cctx.sock, "rb");
059ec3d9 5504 sigalrm_seen = FALSE;
c2a1bba0 5505 ALARM(timeout);
afdb5e9c 5506 yield =
01603eec 5507#ifndef DISABLE_TLS
0578f405 5508 do_tls ? cat_file_tls(cctx.tls_ctx, yield, sub_arg[3]) :
afdb5e9c 5509#endif
8768d548 5510 cat_file(fp, yield, sub_arg[3]);
c2a1bba0 5511 ALARM_CLR(0);
afdb5e9c 5512
01603eec 5513#ifndef DISABLE_TLS
0578f405 5514 if (do_tls)
afdb5e9c 5515 {
c05bdbd6
JH
5516 tls_close(cctx.tls_ctx, TRUE);
5517 close(cctx.sock);
afdb5e9c
JH
5518 }
5519 else
5520#endif
8768d548 5521 (void)fclose(fp);
059ec3d9
PH
5522
5523 /* After a timeout, we restore the pointer in the result, that is,
5524 make sure we add nothing from the socket. */
5525
5526 if (sigalrm_seen)
5527 {
03f110c5 5528 if (yield) yield->ptr = save_ptr;
1cce3af8 5529 expand_string_message = US "socket read timed out";
059ec3d9
PH
5530 goto SOCK_FAIL;
5531 }
5532 }
5533
5534 /* The whole thing has worked (or we were skipping). If there is a
5535 failure string following, we need to skip it. */
5536
5537 if (*s == '{')
5538 {
5694b905 5539 if (!expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok))
059ec3d9 5540 goto EXPAND_FAILED;
e47376be
JH
5541 if (*s++ != '}')
5542 {
5543 expand_string_message = US"missing '}' closing failstring for readsocket";
5544 goto EXPAND_FAILED_CURLY;
5545 }
059ec3d9
PH
5546 while (isspace(*s)) s++;
5547 }
e47376be 5548
8de9db65 5549 READSOCK_DONE:
e47376be
JH
5550 if (*s++ != '}')
5551 {
5552 expand_string_message = US"missing '}' closing readsocket";
5553 goto EXPAND_FAILED_CURLY;
5554 }
059ec3d9
PH
5555 continue;
5556
5557 /* Come here on failure to create socket, connect socket, write to the
5558 socket, or timeout on reading. If another substring follows, expand and
5559 use it. Otherwise, those conditions give expand errors. */
5560
8de9db65 5561 SOCK_FAIL:
059ec3d9
PH
5562 if (*s != '{') goto EXPAND_FAILED;
5563 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
c2f669a4
JH
5564 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5565 goto EXPAND_FAILED;
acec9514 5566 yield = string_cat(yield, arg);
e47376be
JH
5567 if (*s++ != '}')
5568 {
5569 expand_string_message = US"missing '}' closing failstring for readsocket";
5570 goto EXPAND_FAILED_CURLY;
5571 }
059ec3d9 5572 while (isspace(*s)) s++;
8de9db65 5573 goto READSOCK_DONE;
059ec3d9
PH
5574 }
5575
5576 /* Handle "run" to execute a program. */
5577
5578 case EITEM_RUN:
5579 {
5580 FILE *f;
059ec3d9 5581 uschar *arg;
55414b25 5582 const uschar **argv;
059ec3d9
PH
5583 pid_t pid;
5584 int fd_in, fd_out;
059ec3d9
PH
5585
5586 if ((expand_forbid & RDO_RUN) != 0)
5587 {
5588 expand_string_message = US"running a command is not permitted";
5589 goto EXPAND_FAILED;
5590 }
5591
5592 while (isspace(*s)) s++;
e47376be
JH
5593 if (*s != '{')
5594 {
5595 expand_string_message = US"missing '{' for command arg of run";
5596 goto EXPAND_FAILED_CURLY;
5597 }
5694b905
JH
5598 if (!(arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
5599 goto EXPAND_FAILED;
059ec3d9 5600 while (isspace(*s)) s++;
e47376be
JH
5601 if (*s++ != '}')
5602 {
5603 expand_string_message = US"missing '}' closing command arg of run";
5604 goto EXPAND_FAILED_CURLY;
5605 }
059ec3d9
PH
5606
5607 if (skipping) /* Just pretend it worked when we're skipping */
20fcb1e7 5608 {
059ec3d9 5609 runrc = 0;
20fcb1e7
JH
5610 lookup_value = NULL;
5611 }
059ec3d9
PH
5612 else
5613 {
5614 if (!transport_set_up_command(&argv, /* anchor for arg list */
5615 arg, /* raw command */
5616 FALSE, /* don't expand the arguments */
5617 0, /* not relevant when... */
5618 NULL, /* no transporting address */
5619 US"${run} expansion", /* for error messages */
5620 &expand_string_message)) /* where to put error message */
059ec3d9 5621 goto EXPAND_FAILED;
059ec3d9
PH
5622
5623 /* Create the child process, making it a group leader. */
5624
eb24befc
JH
5625 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5626 US"expand-run")) < 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 7633 {
e68def51 7634 BOOL needs_quote = (!*sub); /* TRUE for empty string */
059ec3d9
PH
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 {
e68def51
JH
7754 uschar * buff = store_get(4, is_tainted(sub));
7755 while (*sub)
059ec3d9
PH
7756 {
7757 int c;
059ec3d9
PH
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
e68def51 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
e68def51
JH
7778 /* Manually track tainting, as we deal in individual chars below */
7779
7780 if (is_tainted(sub))
7781 if (yield->s && yield->ptr)
7782 gstring_rebuffer(yield);
7783 else
7784 yield->s = store_get(yield->size = Ustrlen(sub), TRUE);
7785
7786 /* Check the UTF-8, byte-by-byte */
7787
7788 while (*sub)
b9c2e32f 7789 {
0a682b6c 7790 complete = 0;
e8e86723 7791 uschar c = *sub++;
b9c2e32f 7792
e3dd1d67 7793 if (bytes_left)
b9c2e32f
AR
7794 {
7795 if ((c & 0xc0) != 0x80)
b9c2e32f
AR
7796 /* wrong continuation byte; invalidate all bytes */
7797 complete = 1; /* error */
b9c2e32f
AR
7798 else
7799 {
7800 codepoint = (codepoint << 6) | (c & 0x3f);
7801 seq_buff[index++] = c;
7802 if (--bytes_left == 0) /* codepoint complete */
b9c2e32f 7803 if(codepoint > 0x10FFFF) /* is it too large? */
e8e86723 7804 complete = -1; /* error (RFC3629 limit) */
b9c2e32f
AR
7805 else
7806 { /* finished; output utf-8 sequence */
acec9514 7807 yield = string_catn(yield, seq_buff, seq_len);
b9c2e32f
AR
7808 index = 0;
7809 }
b9c2e32f
AR
7810 }
7811 }
7812 else /* no bytes left: new sequence */
7813 {
e68def51 7814 if(!(c & 0x80)) /* 1-byte sequence, US-ASCII, keep it */
b9c2e32f 7815 {
acec9514 7816 yield = string_catn(yield, &c, 1);
b9c2e32f
AR
7817 continue;
7818 }
7819 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7820 {
10cc8a1e
AR
7821 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7822 complete = -1;
7823 else
7824 {
7825 bytes_left = 1;
7826 codepoint = c & 0x1f;
7827 }
b9c2e32f
AR
7828 }
7829 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7830 {
7831 bytes_left = 2;
7832 codepoint = c & 0x0f;
7833 }
7834 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7835 {
7836 bytes_left = 3;
7837 codepoint = c & 0x07;
7838 }
7839 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7840 complete = -1;
7841
7842 seq_buff[index++] = c;
7843 seq_len = bytes_left + 1;
7844 } /* if(bytes_left) */
7845
7846 if (complete != 0)
7847 {
7848 bytes_left = index = 0;
acec9514 7849 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
b9c2e32f
AR
7850 }
7851 if ((complete == 1) && ((c & 0x80) == 0))
4e08fd50 7852 /* ASCII character follows incomplete sequence */
acec9514 7853 yield = string_catn(yield, &c, 1);
b9c2e32f 7854 }
0a682b6c
PP
7855 /* If given a sequence truncated mid-character, we also want to report ?
7856 * Eg, ${length_1:フィル} is one byte, not one character, so we expect
7857 * ${utf8clean:${length_1:フィル}} to yield '?' */
7858 if (bytes_left != 0)
0a682b6c 7859 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
e68def51 7860
b9c2e32f
AR
7861 continue;
7862 }
7863
8c5d388a 7864#ifdef SUPPORT_I18N
4e08fd50
JH
7865 case EOP_UTF8_DOMAIN_TO_ALABEL:
7866 {
7867 uschar * error = NULL;
7868 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7869 if (error)
7870 {
7871 expand_string_message = string_sprintf(
7872 "error converting utf8 (%s) to alabel: %s",
7873 string_printing(sub), error);
7874 goto EXPAND_FAILED;
7875 }
acec9514 7876 yield = string_cat(yield, s);
4e08fd50
JH
7877 continue;
7878 }
7879
7880 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7881 {
7882 uschar * error = NULL;
7883 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7884 if (error)
7885 {
7886 expand_string_message = string_sprintf(
7887 "error converting alabel (%s) to utf8: %s",
7888 string_printing(sub), error);
7889 goto EXPAND_FAILED;
7890 }
acec9514 7891 yield = string_cat(yield, s);
4e08fd50
JH
7892 continue;
7893 }
7894
7895 case EOP_UTF8_LOCALPART_TO_ALABEL:
7896 {
7897 uschar * error = NULL;
7898 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7899 if (error)
7900 {
7901 expand_string_message = string_sprintf(
7902 "error converting utf8 (%s) to alabel: %s",
7903 string_printing(sub), error);
7904 goto EXPAND_FAILED;
7905 }
acec9514
JH
7906 yield = string_cat(yield, s);
7907 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
4e08fd50
JH
7908 continue;
7909 }
7910
7911 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7912 {
7913 uschar * error = NULL;
7914 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7915 if (error)
7916 {
7917 expand_string_message = string_sprintf(
7918 "error converting alabel (%s) to utf8: %s",
7919 string_printing(sub), error);
7920 goto EXPAND_FAILED;
7921 }
acec9514 7922 yield = string_cat(yield, s);
4e08fd50
JH
7923 continue;
7924 }
7925#endif /* EXPERIMENTAL_INTERNATIONAL */
7926
059ec3d9
PH
7927 /* escape turns all non-printing characters into escape sequences. */
7928
7929 case EOP_ESCAPE:
7930 {
3367f8c2 7931 const uschar * t = string_printing(sub);
acec9514 7932 yield = string_cat(yield, t);
059ec3d9
PH
7933 continue;
7934 }
7935
3367f8c2
JH
7936 case EOP_ESCAPE8BIT:
7937 {
3367f8c2
JH
7938 uschar c;
7939
d7978c0f 7940 for (const uschar * s = sub; (c = *s); s++)
3367f8c2 7941 yield = c < 127 && c != '\\'
acec9514 7942 ? string_catn(yield, s, 1)
52f12a7c 7943 : string_fmt_append(yield, "\\%03o", c);
3367f8c2
JH
7944 continue;
7945 }
7946
059ec3d9
PH
7947 /* Handle numeric expression evaluation */
7948
7949 case EOP_EVAL:
7950 case EOP_EVAL10:
7951 {
7952 uschar *save_sub = sub;
7953 uschar *error = NULL;
97d17305 7954 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
52f12a7c 7955 if (error)
059ec3d9
PH
7956 {
7957 expand_string_message = string_sprintf("error in expression "
bb07bcd3
JH
7958 "evaluation: %s (after processing \"%.*s\")", error,
7959 (int)(sub-save_sub), save_sub);
059ec3d9
PH
7960 goto EXPAND_FAILED;
7961 }
52f12a7c 7962 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
059ec3d9
PH
7963 continue;
7964 }
7965
aded2255 7966 /* Handle time period formatting */
059ec3d9 7967
f90d018c
PH
7968 case EOP_TIME_EVAL:
7969 {
7970 int n = readconf_readtime(sub, 0, FALSE);
7971 if (n < 0)
7972 {
7973 expand_string_message = string_sprintf("string \"%s\" is not an "
7974 "Exim time interval in \"%s\" operator", sub, name);
7975 goto EXPAND_FAILED;
7976 }
52f12a7c 7977 yield = string_fmt_append(yield, "%d", n);
f90d018c
PH
7978 continue;
7979 }
7980
059ec3d9
PH
7981 case EOP_TIME_INTERVAL:
7982 {
7983 int n;
7984 uschar *t = read_number(&n, sub);
7985 if (*t != 0) /* Not A Number*/
7986 {
7987 expand_string_message = string_sprintf("string \"%s\" is not a "
7988 "positive number in \"%s\" operator", sub, name);
7989 goto EXPAND_FAILED;
7990 }
7991 t = readconf_printtime(n);
acec9514 7992 yield = string_cat(yield, t);
059ec3d9
PH
7993 continue;
7994 }
7995
7996 /* Convert string to base64 encoding */
7997
7998 case EOP_STR2B64:
9aa35e9c 7999 case EOP_BASE64:
59b87190 8000 {
01603eec 8001#ifndef DISABLE_TLS
59b87190
JH
8002 uschar * s = vp && *(void **)vp->value
8003 ? tls_cert_der_b64(*(void **)vp->value)
1f20760b 8004 : b64encode(CUS sub, Ustrlen(sub));
b81207d2 8005#else
1f20760b 8006 uschar * s = b64encode(CUS sub, Ustrlen(sub));
b81207d2 8007#endif
acec9514 8008 yield = string_cat(yield, s);
59b87190
JH
8009 continue;
8010 }
059ec3d9 8011
9aa35e9c
JH
8012 case EOP_BASE64D:
8013 {
59b87190 8014 uschar * s;
9aa35e9c
JH
8015 int len = b64decode(sub, &s);
8016 if (len < 0)
8017 {
8018 expand_string_message = string_sprintf("string \"%s\" is not "
8019 "well-formed for \"%s\" operator", sub, name);
8020 goto EXPAND_FAILED;
8021 }
acec9514 8022 yield = string_cat(yield, s);
9aa35e9c
JH
8023 continue;
8024 }
8025
059ec3d9
PH
8026 /* strlen returns the length of the string */
8027
8028 case EOP_STRLEN:
52f12a7c 8029 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
059ec3d9 8030 continue;
059ec3d9
PH
8031
8032 /* length_n or l_n takes just the first n characters or the whole string,
8033 whichever is the shorter;
8034
8035 substr_m_n, and s_m_n take n characters from offset m; negative m take
8036 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
8037 takes the rest, either to the right or to the left.
8038
8039 hash_n or h_n makes a hash of length n from the string, yielding n
8040 characters from the set a-z; hash_n_m makes a hash of length n, but
8041 uses m characters from the set a-zA-Z0-9.
8042
8043 nhash_n returns a single number between 0 and n-1 (in text form), while
8044 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
8045 between 0 and n-1 and the second between 0 and m-1. */
8046
8047 case EOP_LENGTH:
8048 case EOP_L:
8049 case EOP_SUBSTR:
8050 case EOP_S:
8051 case EOP_HASH:
8052 case EOP_H:
8053 case EOP_NHASH:
8054 case EOP_NH:
8055 {
8056 int sign = 1;
8057 int value1 = 0;
8058 int value2 = -1;
8059 int *pn;
8060 int len;
8061 uschar *ret;
8062
52f12a7c 8063 if (!arg)
059ec3d9
PH
8064 {
8065 expand_string_message = string_sprintf("missing values after %s",
8066 name);
8067 goto EXPAND_FAILED;
8068 }
8069
8070 /* "length" has only one argument, effectively being synonymous with
8071 substr_0_n. */
8072
8073 if (c == EOP_LENGTH || c == EOP_L)
8074 {
8075 pn = &value2;
8076 value2 = 0;
8077 }
8078
8079 /* The others have one or two arguments; for "substr" the first may be
8080 negative. The second being negative means "not supplied". */
8081
8082 else
8083 {
8084 pn = &value1;
8085 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8086 }
8087
8088 /* Read up to two numbers, separated by underscores */
8089
8090 ret = arg;
8091 while (*arg != 0)
8092 {
8093 if (arg != ret && *arg == '_' && pn == &value1)
8094 {
8095 pn = &value2;
8096 value2 = 0;
8097 if (arg[1] != 0) arg++;
8098 }
8099 else if (!isdigit(*arg))
8100 {
8101 expand_string_message =
8102 string_sprintf("non-digit after underscore in \"%s\"", name);
8103 goto EXPAND_FAILED;
8104 }
8105 else *pn = (*pn)*10 + *arg++ - '0';
8106 }
8107 value1 *= sign;
8108
8109 /* Perform the required operation */
8110
5694b905
JH
8111 ret = c == EOP_HASH || c == EOP_H
8112 ? compute_hash(sub, value1, value2, &len)
8113 : c == EOP_NHASH || c == EOP_NH
8114 ? compute_nhash(sub, value1, value2, &len)
8115 : extract_substr(sub, value1, value2, &len);
8116 if (!ret) goto EXPAND_FAILED;
059ec3d9 8117
acec9514 8118 yield = string_catn(yield, ret, len);
059ec3d9
PH
8119 continue;
8120 }
8121
8122 /* Stat a path */
8123
8124 case EOP_STAT:
8125 {
059ec3d9
PH
8126 uschar smode[12];
8127 uschar **modetable[3];
059ec3d9
PH
8128 mode_t mode;
8129 struct stat st;
8130
52f12a7c 8131 if (expand_forbid & RDO_EXISTS)
254e032f
PH
8132 {
8133 expand_string_message = US"Use of the stat() expansion is not permitted";
8134 goto EXPAND_FAILED;
8135 }
8136
059ec3d9
PH
8137 if (stat(CS sub, &st) < 0)
8138 {
8139 expand_string_message = string_sprintf("stat(%s) failed: %s",
8140 sub, strerror(errno));
8141 goto EXPAND_FAILED;
8142 }
8143 mode = st.st_mode;
8144 switch (mode & S_IFMT)
8145 {
8146 case S_IFIFO: smode[0] = 'p'; break;
8147 case S_IFCHR: smode[0] = 'c'; break;
8148 case S_IFDIR: smode[0] = 'd'; break;
8149 case S_IFBLK: smode[0] = 'b'; break;
8150 case S_IFREG: smode[0] = '-'; break;
8151 default: smode[0] = '?'; break;
8152 }
8153
8154 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8155 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8156 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8157
d7978c0f 8158 for (int i = 0; i < 3; i++)
059ec3d9
PH
8159 {
8160 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8161 mode >>= 3;
8162 }
8163
8164 smode[10] = 0;
52f12a7c
JH
8165 yield = string_fmt_append(yield,
8166 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
b1c749bb 8167 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
059ec3d9
PH
8168 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8169 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
b1c749bb 8170 (long)st.st_gid, st.st_size, (long)st.st_atime,
059ec3d9 8171 (long)st.st_mtime, (long)st.st_ctime);
059ec3d9
PH
8172 continue;
8173 }
8174
17c76198 8175 /* vaguely random number less than N */
9e3331ea
TK
8176
8177 case EOP_RANDINT:
8178 {
52f12a7c 8179 int_eximarith_t max = expanded_string_integer(sub, TRUE);
9e3331ea 8180
52f12a7c 8181 if (expand_string_message)
9e3331ea 8182 goto EXPAND_FAILED;
52f12a7c 8183 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
9e3331ea
TK
8184 continue;
8185 }
8186
83e029d5
PP
8187 /* Reverse IP, including IPv6 to dotted-nibble */
8188
8189 case EOP_REVERSE_IP:
8190 {
8191 int family, maskptr;
8192 uschar reversed[128];
8193
8194 family = string_is_ip_address(sub, &maskptr);
8195 if (family == 0)
8196 {
8197 expand_string_message = string_sprintf(
8198 "reverse_ip() not given an IP address [%s]", sub);
8199 goto EXPAND_FAILED;
8200 }
8201 invert_address(reversed, sub);
acec9514 8202 yield = string_cat(yield, reversed);
83e029d5
PP
8203 continue;
8204 }
8205
059ec3d9
PH
8206 /* Unknown operator */
8207
8208 default:
52f12a7c
JH
8209 expand_string_message =
8210 string_sprintf("unknown expansion operator \"%s\"", name);
8211 goto EXPAND_FAILED;
059ec3d9
PH
8212 }
8213 }
8214
8215 /* Handle a plain name. If this is the first thing in the expansion, release
8216 the pre-allocated buffer. If the result data is known to be in a new buffer,
8217 newsize will be set to the size of that buffer, and we can just point at that
8218 store instead of copying. Many expansion strings contain just one reference,
8219 so this is a useful optimization, especially for humungous headers
8220 ($message_headers). */
2e23003a 8221 /*{*/
059ec3d9
PH
8222 if (*s++ == '}')
8223 {
8224 int len;
8225 int newsize = 0;
bb07bcd3 8226 gstring * g = NULL;
acec9514 8227
bb07bcd3 8228 if (!yield)
f3ebb786 8229 g = store_get(sizeof(gstring), FALSE);
bb07bcd3 8230 else if (yield->ptr == 0)
059ec3d9 8231 {
f3ebb786 8232 if (resetok) reset_point = store_reset(reset_point);
059ec3d9 8233 yield = NULL;
f3ebb786
JH
8234 reset_point = store_mark();
8235 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
059ec3d9 8236 }
8487aee9 8237 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
059ec3d9
PH
8238 {
8239 expand_string_message =
8240 string_sprintf("unknown variable in \"${%s}\"", name);
641cb756 8241 check_variable_error_message(name);
059ec3d9
PH
8242 goto EXPAND_FAILED;
8243 }
8244 len = Ustrlen(value);
8487aee9 8245 if (!yield && newsize)
059ec3d9 8246 {
acec9514
JH
8247 yield = g;
8248 yield->size = newsize;
8249 yield->ptr = len;
8250 yield->s = value;
059ec3d9 8251 }
8487aee9 8252 else
acec9514 8253 yield = string_catn(yield, value, len);
059ec3d9
PH
8254 continue;
8255 }
8256
8257 /* Else there's something wrong */
8258
8259 expand_string_message =
8260 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8261 "in a variable reference)", name);
8262 goto EXPAND_FAILED;
8263 }
8264
8265/* If we hit the end of the string when ket_ends is set, there is a missing
8266terminating brace. */
8267
8268if (ket_ends && *s == 0)
8269 {
617d3932
JH
8270 expand_string_message = malformed_header
8271 ? US"missing } at end of string - could be header name not terminated by colon"
8272 : US"missing } at end of string";
059ec3d9
PH
8273 goto EXPAND_FAILED;
8274 }
8275
8276/* Expansion succeeded; yield may still be NULL here if nothing was actually
8277added to the string. If so, set up an empty string. Add a terminating zero. If
8278left != NULL, return a pointer to the terminator. */
8279
acec9514
JH
8280if (!yield)
8281 yield = string_get(1);
8282(void) string_from_gstring(yield);
8283if (left) *left = s;
059ec3d9
PH
8284
8285/* Any stacking store that was used above the final string is no longer needed.
8286In many cases the final string will be the first one that was got and so there
8287will be optimal store usage. */
8288
f3ebb786 8289if (resetok) gstring_release_unused(yield);
b0e85a8f
JH
8290else if (resetok_p) *resetok_p = FALSE;
8291
059ec3d9 8292DEBUG(D_expand)
f3ebb786
JH
8293 {
8294 BOOL tainted = is_tainted(yield->s);
ae8f9024
JH
8295 DEBUG(D_noutf8)
8296 {
8297 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8298 debug_printf_indent("%sresult: %s\n",
8299 skipping ? "|-----" : "\\_____", yield->s);
f3ebb786
JH
8300 if (tainted)
8301 debug_printf_indent("%s \\__(tainted)\n",
8302 skipping ? "| " : " ");
ae8f9024
JH
8303 if (skipping)
8304 debug_printf_indent("\\___skipping: result is not used\n");
8305 }
8306 else
8307 {
8308 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8309 "expanding: %.*s\n",
8310 (int)(s - string), string);
f3ebb786 8311 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
ae8f9024
JH
8312 "result: %s\n",
8313 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8314 yield->s);
f3ebb786
JH
8315 if (tainted)
8316 debug_printf_indent("%s(tainted)\n",
8317 skipping
8318 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
ae8f9024
JH
8319 if (skipping)
8320 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8321 "skipping: result is not used\n");
8322 }
f3ebb786 8323 }
e1d04f48 8324expand_level--;
acec9514 8325return yield->s;
059ec3d9
PH
8326
8327/* This is the failure exit: easiest to program with a goto. We still need
8328to update the pointer to the terminator, for cases of nested calls with "fail".
8329*/
8330
8331EXPAND_FAILED_CURLY:
e47376be
JH
8332if (malformed_header)
8333 expand_string_message =
8334 US"missing or misplaced { or } - could be header name not terminated by colon";
8335
8336else if (!expand_string_message || !*expand_string_message)
8337 expand_string_message = US"missing or misplaced { or }";
059ec3d9
PH
8338
8339/* At one point, Exim reset the store to yield (if yield was not NULL), but
8340that is a bad idea, because expand_string_message is in dynamic store. */
8341
8342EXPAND_FAILED:
acec9514 8343if (left) *left = s;
059ec3d9 8344DEBUG(D_expand)
ae8f9024
JH
8345 DEBUG(D_noutf8)
8346 {
8347 debug_printf_indent("|failed to expand: %s\n", string);
8348 debug_printf_indent("%serror message: %s\n",
8349 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8350 if (f.expand_string_forcedfail)
8351 debug_printf_indent("\\failure was forced\n");
8352 }
8353 else
8354 {
8355 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8356 string);
8357 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8358 "error message: %s\n",
8359 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8360 expand_string_message);
8361 if (f.expand_string_forcedfail)
8362 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8363 }
ce93c6d8 8364if (resetok_p && !resetok) *resetok_p = FALSE;
e1d04f48 8365expand_level--;
059ec3d9
PH
8366return NULL;
8367}
8368
8369
8370/* This is the external function call. Do a quick check for any expansion
8371metacharacters, and if there are none, just return the input string.
8372
8373Argument: the string to be expanded
8374Returns: the expanded string, or NULL if expansion failed; if failure was
8375 due to a lookup deferring, search_find_defer will be TRUE
8376*/
8377
ce93c6d8
JH
8378const uschar *
8379expand_cstring(const uschar * string)
059ec3d9 8380{
ce93c6d8
JH
8381if (Ustrpbrk(string, "$\\") != NULL)
8382 {
8383 int old_pool = store_pool;
8384 uschar * s;
8385
8768d548 8386 f.search_find_defer = FALSE;
ce93c6d8
JH
8387 malformed_header = FALSE;
8388 store_pool = POOL_MAIN;
8389 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
8390 store_pool = old_pool;
8391 return s;
8392 }
8393return string;
059ec3d9
PH
8394}
8395
8396
ce93c6d8
JH
8397uschar *
8398expand_string(uschar * string)
55414b25 8399{
ce93c6d8 8400return US expand_cstring(CUS string);
55414b25
JH
8401}
8402
8403
8404
ce93c6d8
JH
8405
8406
059ec3d9
PH
8407/*************************************************
8408* Expand and copy *
8409*************************************************/
8410
8411/* Now and again we want to expand a string and be sure that the result is in a
8412new bit of store. This function does that.
55414b25 8413Since we know it has been copied, the de-const cast is safe.
059ec3d9
PH
8414
8415Argument: the string to be expanded
8416Returns: the expanded string, always in a new bit of store, or NULL
8417*/
8418
8419uschar *
55414b25 8420expand_string_copy(const uschar *string)
059ec3d9 8421{
55414b25 8422const uschar *yield = expand_cstring(string);
059ec3d9 8423if (yield == string) yield = string_copy(string);
55414b25 8424return US yield;
059ec3d9
PH
8425}
8426
8427
8428
8429/*************************************************
8430* Expand and interpret as an integer *
8431*************************************************/
8432
8433/* Expand a string, and convert the result into an integer.
8434
d45b1de8
PH
8435Arguments:
8436 string the string to be expanded
8437 isplus TRUE if a non-negative number is expected
059ec3d9
PH
8438
8439Returns: the integer value, or
8440 -1 for an expansion error ) in both cases, message in
8441 -2 for an integer interpretation error ) expand_string_message
d45b1de8 8442 expand_string_message is set NULL for an OK integer
059ec3d9
PH
8443*/
8444
97d17305 8445int_eximarith_t
d45b1de8 8446expand_string_integer(uschar *string, BOOL isplus)
059ec3d9 8447{
7685ce68
TF
8448return expanded_string_integer(expand_string(string), isplus);
8449}
8450
8451
8452/*************************************************
8453 * Interpret string as an integer *
8454 *************************************************/
8455
8456/* Convert a string (that has already been expanded) into an integer.
8457
8458This function is used inside the expansion code.
8459
8460Arguments:
8461 s the string to be expanded
8462 isplus TRUE if a non-negative number is expected
8463
8464Returns: the integer value, or
8465 -1 if string is NULL (which implies an expansion error)
8466 -2 for an integer interpretation error
8467 expand_string_message is set NULL for an OK integer
8468*/
8469
8470static int_eximarith_t
55414b25 8471expanded_string_integer(const uschar *s, BOOL isplus)
7685ce68 8472{
97d17305 8473int_eximarith_t value;
059ec3d9
PH
8474uschar *msg = US"invalid integer \"%s\"";
8475uschar *endptr;
8476
d45b1de8
PH
8477/* If expansion failed, expand_string_message will be set. */
8478
5694b905 8479if (!s) return -1;
059ec3d9
PH
8480
8481/* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8482to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8483systems, so we set it zero ourselves. */
8484
8485errno = 0;
d45b1de8 8486expand_string_message = NULL; /* Indicates no error */
b52bc06e
NM
8487
8488/* Before Exim 4.64, strings consisting entirely of whitespace compared
8489equal to 0. Unfortunately, people actually relied upon that, so preserve
8490the behaviour explicitly. Stripping leading whitespace is a harmless
8491noop change since strtol skips it anyway (provided that there is a number
8492to find at all). */
8493if (isspace(*s))
8494 {
8495 while (isspace(*s)) ++s;
8496 if (*s == '\0')
8497 {
8498 DEBUG(D_expand)
e1d04f48 8499 debug_printf_indent("treating blank string as number 0\n");
b52bc06e
NM
8500 return 0;
8501 }
8502 }
8503
aa7c82b2 8504value = strtoll(CS s, CSS &endptr, 10);
059ec3d9
PH
8505
8506if (endptr == s)
8507 {
8508 msg = US"integer expected but \"%s\" found";
8509 }
d45b1de8
PH
8510else if (value < 0 && isplus)
8511 {
8512 msg = US"non-negative integer expected but \"%s\" found";
8513 }
059ec3d9
PH
8514else
8515 {
4eb9d6ef 8516 switch (tolower(*endptr))
059ec3d9 8517 {
4eb9d6ef
JH
8518 default:
8519 break;
8520 case 'k':
4328fd3c 8521 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
aa7c82b2 8522 else value *= 1024;
4eb9d6ef
JH
8523 endptr++;
8524 break;
8525 case 'm':
4328fd3c 8526 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
4eb9d6ef
JH
8527 else value *= 1024*1024;
8528 endptr++;
8529 break;
8530 case 'g':
4328fd3c 8531 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
4eb9d6ef
JH
8532 else value *= 1024*1024*1024;
8533 endptr++;
8534 break;
059ec3d9
PH
8535 }
8536 if (errno == ERANGE)
8537 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8538 else
8539 {
8540 while (isspace(*endptr)) endptr++;
725735cd 8541 if (*endptr == 0) return value;
059ec3d9
PH
8542 }
8543 }
8544
8545expand_string_message = string_sprintf(CS msg, s);
8546return -2;
8547}
8548
059ec3d9 8549
9c695f6d
JH
8550/* These values are usually fixed boolean values, but they are permitted to be
8551expanded strings.
8552
8553Arguments:
8554 addr address being routed
8555 mtype the module type
8556 mname the module name
8557 dbg_opt debug selectors
8558 oname the option name
8559 bvalue the router's boolean value
8560 svalue the router's string value
8561 rvalue where to put the returned value
8562
8563Returns: OK value placed in rvalue
8564 DEFER expansion failed
8565*/
8566
8567int
8568exp_bool(address_item *addr,
8569 uschar *mtype, uschar *mname, unsigned dbg_opt,
8570 uschar *oname, BOOL bvalue,
8571 uschar *svalue, BOOL *rvalue)
8572{
8573uschar *expanded;
5694b905 8574if (!svalue) { *rvalue = bvalue; return OK; }
9c695f6d 8575
5694b905 8576if (!(expanded = expand_string(svalue)))
9c695f6d 8577 {
8768d548 8578 if (f.expand_string_forcedfail)
9c695f6d
JH
8579 {
8580 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8581 *rvalue = bvalue;
8582 return OK;
8583 }
8584 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8585 oname, mname, mtype, expand_string_message);
8586 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8587 return DEFER;
8588 }
8589
8590DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8591 expanded);
8592
8593if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8594 *rvalue = TRUE;
8595else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8596 *rvalue = FALSE;
8597else
8598 {
8599 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8600 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8601 return DEFER;
8602 }
8603
8604return OK;
8605}
8606
8607
8608
f42deca9
JH
8609/* Avoid potentially exposing a password in a string about to be logged */
8610
8611uschar *
8612expand_hide_passwords(uschar * s)
8613{
8614return ( ( Ustrstr(s, "failed to expand") != NULL
8615 || Ustrstr(s, "expansion of ") != NULL
0a682b6c 8616 )
f42deca9
JH
8617 && ( Ustrstr(s, "mysql") != NULL
8618 || Ustrstr(s, "pgsql") != NULL
8619 || Ustrstr(s, "redis") != NULL
8620 || Ustrstr(s, "sqlite") != NULL
8621 || Ustrstr(s, "ldap:") != NULL
8622 || Ustrstr(s, "ldaps:") != NULL
8623 || Ustrstr(s, "ldapi:") != NULL
8624 || Ustrstr(s, "ldapdn:") != NULL
8625 || Ustrstr(s, "ldapm:") != NULL
0a682b6c 8626 ) )
f42deca9
JH
8627 ? US"Temporary internal error" : s;
8628}
8629
8630
617d3932
JH
8631/* Read given named file into big_buffer. Use for keying material etc.
8632The content will have an ascii NUL appended.
8633
8634Arguments:
8635 filename as it says
8636
8637Return: pointer to buffer, or NULL on error.
8638*/
8639
8640uschar *
8641expand_file_big_buffer(const uschar * filename)
8642{
8643int fd, off = 0, len;
8644
9e21ce8f 8645if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
617d3932
JH
8646 {
8647 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8648 filename);
8649 return NULL;
8650 }
8651
8652do
8653 {
8654 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8655 {
8656 (void) close(fd);
8657 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8658 return NULL;
8659 }
8660 off += len;
8661 }
8662while (len > 0);
8663
8664(void) close(fd);
8665big_buffer[off] = '\0';
8666return big_buffer;
8667}
8668
8669
f42deca9 8670
cf0812d5
JH
8671/*************************************************
8672* Error-checking for testsuite *
8673*************************************************/
8674typedef struct {
cf0812d5
JH
8675 uschar * region_start;
8676 uschar * region_end;
8677 const uschar *var_name;
90341c71 8678 const uschar *var_data;
cf0812d5
JH
8679} err_ctx;
8680
8681static void
8682assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8683{
8684err_ctx * e = ctx;
8685if (var_data >= e->region_start && var_data < e->region_end)
90341c71 8686 {
cf0812d5 8687 e->var_name = CUS var_name;
90341c71
JH
8688 e->var_data = CUS var_data;
8689 }
cf0812d5
JH
8690}
8691
8692void
8693assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8694{
ce93c6d8
JH
8695err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8696 .var_name = NULL, .var_data = NULL };
cf0812d5
JH
8697
8698/* check acl_ variables */
8699tree_walk(acl_var_c, assert_variable_notin, &e);
8700tree_walk(acl_var_m, assert_variable_notin, &e);
8701
8702/* check auth<n> variables */
d7978c0f 8703for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
cf0812d5
JH
8704 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
8705
8706/* check regex<n> variables */
d7978c0f 8707for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
cf0812d5
JH
8708 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
8709
8710/* check known-name variables */
d7978c0f 8711for (var_entry * v = var_table; v < var_table + var_table_size; v++)
cf0812d5
JH
8712 if (v->type == vtype_stringptr)
8713 assert_variable_notin(US v->name, *(USS v->value), &e);
8714
ce93c6d8
JH
8715/* check dns and address trees */
8716tree_walk(tree_dns_fails, assert_variable_notin, &e);
8717tree_walk(tree_duplicates, assert_variable_notin, &e);
8718tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8719tree_walk(tree_unusable, assert_variable_notin, &e);
8720
cf0812d5 8721if (e.var_name)
90341c71
JH
8722 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8723 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
ce93c6d8 8724 e.var_name, filename, linenumber, e.var_data);
cf0812d5
JH
8725}
8726
8727
9c695f6d 8728
059ec3d9
PH
8729/*************************************************
8730**************************************************
8731* Stand-alone test program *
8732**************************************************
8733*************************************************/
8734
8735#ifdef STAND_ALONE
8736
8737
8738BOOL
8739regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
8740{
8741int ovector[3*(EXPAND_MAXN+1)];
8742int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
0539a19d 8743 ovector, nelem(ovector));
059ec3d9
PH
8744BOOL yield = n >= 0;
8745if (n == 0) n = EXPAND_MAXN + 1;
8746if (yield)
8747 {
d7978c0f
JH
8748 expand_nmax = setup < 0 ? 0 : setup + 1;
8749 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
059ec3d9
PH
8750 {
8751 expand_nstring[expand_nmax] = subject + ovector[nn];
8752 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8753 }
8754 expand_nmax--;
8755 }
8756return yield;
8757}
8758
8759
8760int main(int argc, uschar **argv)
8761{
059ec3d9
PH
8762uschar buffer[1024];
8763
8764debug_selector = D_v;
8765debug_file = stderr;
8766debug_fd = fileno(debug_file);
8767big_buffer = malloc(big_buffer_size);
8768
d7978c0f 8769for (int i = 1; i < argc; i++)
059ec3d9
PH
8770 {
8771 if (argv[i][0] == '+')
8772 {
8773 debug_trace_memory = 2;
8774 argv[i]++;
8775 }
8776 if (isdigit(argv[i][0]))
8777 debug_selector = Ustrtol(argv[i], NULL, 0);
8778 else
8779 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8780 Ustrlen(argv[i]))
8781 {
de78e2d5 8782#ifdef LOOKUP_LDAP
059ec3d9 8783 eldap_default_servers = argv[i];
de78e2d5
JH
8784#endif
8785#ifdef LOOKUP_MYSQL
059ec3d9 8786 mysql_servers = argv[i];
de78e2d5
JH
8787#endif
8788#ifdef LOOKUP_PGSQL
059ec3d9 8789 pgsql_servers = argv[i];
de78e2d5
JH
8790#endif
8791#ifdef LOOKUP_REDIS
9bdd29ad 8792 redis_servers = argv[i];
de78e2d5 8793#endif
059ec3d9 8794 }
de78e2d5 8795#ifdef EXIM_PERL
059ec3d9 8796 else opt_perl_startup = argv[i];
de78e2d5 8797#endif
059ec3d9
PH
8798 }
8799
8800printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8801
8802expand_nstring[1] = US"string 1....";
8803expand_nlength[1] = 8;
8804expand_nmax = 1;
8805
8806#ifdef EXIM_PERL
8807if (opt_perl_startup != NULL)
8808 {
8809 uschar *errstr;
8810 printf("Starting Perl interpreter\n");
8811 errstr = init_perl(opt_perl_startup);
8812 if (errstr != NULL)
8813 {
8814 printf("** error in perl_startup code: %s\n", errstr);
8815 return EXIT_FAILURE;
8816 }
8817 }
8818#endif /* EXIM_PERL */
8819
f3ebb786
JH
8820/* Thie deliberately regards the input as untainted, so that it can be
8821expanded; only reasonable since this is a test for string-expansions. */
8822
059ec3d9
PH
8823while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8824 {
f3ebb786 8825 rmark reset_point = store_mark();
059ec3d9 8826 uschar *yield = expand_string(buffer);
f3ebb786 8827 if (yield)
059ec3d9 8828 printf("%s\n", yield);
059ec3d9
PH
8829 else
8830 {
8768d548 8831 if (f.search_find_defer) printf("search_find deferred\n");
059ec3d9 8832 printf("Failed: %s\n", expand_string_message);
8768d548 8833 if (f.expand_string_forcedfail) printf("Forced failure\n");
059ec3d9
PH
8834 printf("\n");
8835 }
f3ebb786 8836 store_reset(reset_point);
059ec3d9
PH
8837 }
8838
8839search_tidyup();
8840
8841return 0;
8842}
8843
8844#endif
8845
9e4dddbd 8846/* vi: aw ai sw=2
b9c2e32f 8847*/
059ec3d9 8848/* End of expand.c */