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