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