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