tidying
[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
afdb5e9c
JH
3553#ifdef SUPPORT_TLS
3554static gstring *
3555cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
3556{
3557int rc;
3558uschar * s;
3559uschar buffer[1024];
3560
3561while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
3562 for (s = buffer; rc--; s++)
3563 yield = eol && *s == '\n'
3564 ? string_cat(yield, eol) : string_catn(yield, s, 1);
3565
3566/* We assume that all errors, and any returns of zero bytes,
3567are actually EOF. */
3568
3569(void) string_from_gstring(yield);
3570return yield;
3571}
3572#endif
059ec3d9
PH
3573
3574
3575/*************************************************
3576* Evaluate numeric expression *
3577*************************************************/
3578
af561417
PH
3579/* This is a set of mutually recursive functions that evaluate an arithmetic
3580expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3581these functions that is called from elsewhere is eval_expr, whose interface is:
059ec3d9
PH
3582
3583Arguments:
af561417
PH
3584 sptr pointer to the pointer to the string - gets updated
3585 decimal TRUE if numbers are to be assumed decimal
3586 error pointer to where to put an error message - must be NULL on input
3587 endket TRUE if ')' must terminate - FALSE for external call
059ec3d9 3588
af561417
PH
3589Returns: on success: the value of the expression, with *error still NULL
3590 on failure: an undefined value, with *error = a message
059ec3d9
PH
3591*/
3592
97d17305 3593static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
af561417 3594
059ec3d9 3595
97d17305 3596static int_eximarith_t
059ec3d9
PH
3597eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3598{
3599uschar *s = *sptr;
97d17305 3600int_eximarith_t x = eval_op_or(&s, decimal, error);
059ec3d9
PH
3601if (*error == NULL)
3602 {
af561417 3603 if (endket)
059ec3d9 3604 {
af561417
PH
3605 if (*s != ')')
3606 *error = US"expecting closing parenthesis";
3607 else
3608 while (isspace(*(++s)));
059ec3d9 3609 }
af561417 3610 else if (*s != 0) *error = US"expecting operator";
059ec3d9 3611 }
059ec3d9
PH
3612*sptr = s;
3613return x;
3614}
3615
af561417 3616
97d17305 3617static int_eximarith_t
af561417 3618eval_number(uschar **sptr, BOOL decimal, uschar **error)
059ec3d9
PH
3619{
3620register int c;
97d17305 3621int_eximarith_t n;
059ec3d9
PH
3622uschar *s = *sptr;
3623while (isspace(*s)) s++;
3624c = *s;
af561417 3625if (isdigit(c))
059ec3d9
PH
3626 {
3627 int count;
97d17305 3628 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
059ec3d9 3629 s += count;
97d17305
JH
3630 switch (tolower(*s))
3631 {
3632 default: break;
3633 case 'k': n *= 1024; s++; break;
3634 case 'm': n *= 1024*1024; s++; break;
3635 case 'g': n *= 1024*1024*1024; s++; break;
3636 }
059ec3d9
PH
3637 while (isspace (*s)) s++;
3638 }
3639else if (c == '(')
3640 {
3641 s++;
3642 n = eval_expr(&s, decimal, error, 1);
3643 }
3644else
3645 {
3646 *error = US"expecting number or opening parenthesis";
3647 n = 0;
3648 }
3649*sptr = s;
3650return n;
3651}
3652
af561417 3653
97d17305 3654static int_eximarith_t
aa7c82b2 3655eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
3656{
3657uschar *s = *sptr;
97d17305 3658int_eximarith_t x;
af561417
PH
3659while (isspace(*s)) s++;
3660if (*s == '+' || *s == '-' || *s == '~')
3661 {
3662 int op = *s++;
3663 x = eval_op_unary(&s, decimal, error);
3664 if (op == '-') x = -x;
3665 else if (op == '~') x = ~x;
3666 }
3667else
3668 {
3669 x = eval_number(&s, decimal, error);
3670 }
3671*sptr = s;
3672return x;
3673}
3674
3675
97d17305 3676static int_eximarith_t
aa7c82b2 3677eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
059ec3d9
PH
3678{
3679uschar *s = *sptr;
97d17305 3680int_eximarith_t x = eval_op_unary(&s, decimal, error);
059ec3d9
PH
3681if (*error == NULL)
3682 {
5591031b 3683 while (*s == '*' || *s == '/' || *s == '%')
059ec3d9
PH
3684 {
3685 int op = *s++;
97d17305 3686 int_eximarith_t y = eval_op_unary(&s, decimal, error);
059ec3d9 3687 if (*error != NULL) break;
053a9aa3
PP
3688 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3689 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3690 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4c04137d 3691 * -N*M is INT_MIN will yield INT_MIN.
053a9aa3
PP
3692 * Since we don't support floating point, this is somewhat simpler.
3693 * Ideally, we'd return an error, but since we overflow for all other
3694 * arithmetic, consistency suggests otherwise, but what's the correct value
3695 * to use? There is none.
3696 * The C standard guarantees overflow for unsigned arithmetic but signed
3697 * overflow invokes undefined behaviour; in practice, this is overflow
3698 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3699 * that long/longlong larger than int are available, or we could just work
3700 * with larger types. We should consider whether to guarantee 32bit eval
3701 * and 64-bit working variables, with errors returned. For now ...
3702 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3703 * can just let the other invalid results occur otherwise, as they have
3704 * until now. For this one case, we can coerce.
3705 */
4328fd3c 3706 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
053a9aa3
PP
3707 {
3708 DEBUG(D_expand)
97d17305 3709 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4328fd3c
JH
3710 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3711 x = EXIM_ARITH_MAX;
053a9aa3
PP
3712 continue;
3713 }
a5b52695
PP
3714 if (op == '*')
3715 x *= y;
3716 else
3717 {
3718 if (y == 0)
54e7ce4a 3719 {
a5b52695
PP
3720 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3721 x = 0;
3722 break;
54e7ce4a 3723 }
a5b52695
PP
3724 if (op == '/')
3725 x /= y;
3726 else
3727 x %= y;
3728 }
059ec3d9
PH
3729 }
3730 }
3731*sptr = s;
3732return x;
3733}
3734
3735
97d17305 3736static int_eximarith_t
aa7c82b2 3737eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
3738{
3739uschar *s = *sptr;
97d17305 3740int_eximarith_t x = eval_op_mult(&s, decimal, error);
6e3b198d 3741if (!*error)
af561417
PH
3742 {
3743 while (*s == '+' || *s == '-')
3744 {
3745 int op = *s++;
97d17305 3746 int_eximarith_t y = eval_op_mult(&s, decimal, error);
6e3b198d
JH
3747 if (*error) break;
3748 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3749 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3750 { /* over-conservative check */
3751 *error = op == '+'
3752 ? US"overflow in sum" : US"overflow in difference";
3753 break;
3754 }
af561417
PH
3755 if (op == '+') x += y; else x -= y;
3756 }
3757 }
3758*sptr = s;
3759return x;
3760}
3761
3762
97d17305 3763static int_eximarith_t
aa7c82b2 3764eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
3765{
3766uschar *s = *sptr;
97d17305 3767int_eximarith_t x = eval_op_sum(&s, decimal, error);
af561417
PH
3768if (*error == NULL)
3769 {
3770 while ((*s == '<' || *s == '>') && s[1] == s[0])
3771 {
97d17305 3772 int_eximarith_t y;
af561417
PH
3773 int op = *s++;
3774 s++;
3775 y = eval_op_sum(&s, decimal, error);
3776 if (*error != NULL) break;
3777 if (op == '<') x <<= y; else x >>= y;
3778 }
3779 }
3780*sptr = s;
3781return x;
3782}
3783
3784
97d17305 3785static int_eximarith_t
aa7c82b2 3786eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
3787{
3788uschar *s = *sptr;
97d17305 3789int_eximarith_t x = eval_op_shift(&s, decimal, error);
af561417
PH
3790if (*error == NULL)
3791 {
3792 while (*s == '&')
3793 {
97d17305 3794 int_eximarith_t y;
af561417
PH
3795 s++;
3796 y = eval_op_shift(&s, decimal, error);
3797 if (*error != NULL) break;
3798 x &= y;
3799 }
3800 }
3801*sptr = s;
3802return x;
3803}
3804
3805
97d17305 3806static int_eximarith_t
aa7c82b2 3807eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
3808{
3809uschar *s = *sptr;
97d17305 3810int_eximarith_t x = eval_op_and(&s, decimal, error);
af561417
PH
3811if (*error == NULL)
3812 {
3813 while (*s == '^')
3814 {
97d17305 3815 int_eximarith_t y;
af561417
PH
3816 s++;
3817 y = eval_op_and(&s, decimal, error);
3818 if (*error != NULL) break;
3819 x ^= y;
3820 }
3821 }
3822*sptr = s;
3823return x;
3824}
3825
3826
97d17305 3827static int_eximarith_t
aa7c82b2 3828eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
3829{
3830uschar *s = *sptr;
97d17305 3831int_eximarith_t x = eval_op_xor(&s, decimal, error);
af561417
PH
3832if (*error == NULL)
3833 {
3834 while (*s == '|')
3835 {
97d17305 3836 int_eximarith_t y;
af561417
PH
3837 s++;
3838 y = eval_op_xor(&s, decimal, error);
3839 if (*error != NULL) break;
3840 x |= y;
3841 }
3842 }
3843*sptr = s;
3844return x;
3845}
3846
059ec3d9
PH
3847
3848
3849/*************************************************
3850* Expand string *
3851*************************************************/
3852
3853/* Returns either an unchanged string, or the expanded string in stacking pool
3854store. Interpreted sequences are:
3855
3856 \... normal escaping rules
3857 $name substitutes the variable
3858 ${name} ditto
3859 ${op:string} operates on the expanded string value
3860 ${item{arg1}{arg2}...} expands the args and then does the business
3861 some literal args are not enclosed in {}
3862
3863There are now far too many operators and item types to make it worth listing
3864them here in detail any more.
3865
3866We use an internal routine recursively to handle embedded substrings. The
3867external function follows. The yield is NULL if the expansion failed, and there
3868are two cases: if something collapsed syntactically, or if "fail" was given
4c04137d 3869as the action on a lookup failure. These can be distinguished by looking at the
059ec3d9
PH
3870variable expand_string_forcedfail, which is TRUE in the latter case.
3871
3872The skipping flag is set true when expanding a substring that isn't actually
3873going to be used (after "if" or "lookup") and it prevents lookups from
3874happening lower down.
3875
3876Store usage: At start, a store block of the length of the input plus 64
3877is obtained. This is expanded as necessary by string_cat(), which might have to
3878get a new block, or might be able to expand the original. At the end of the
3879function we can release any store above that portion of the yield block that
3880was actually used. In many cases this will be optimal.
3881
3882However: if the first item in the expansion is a variable name or header name,
3883we reset the store before processing it; if the result is in fresh store, we
3884use that without copying. This is helpful for expanding strings like
3885$message_headers which can get very long.
3886
d6b4d938
TF
3887There's a problem if a ${dlfunc item has side-effects that cause allocation,
3888since resetting the store at the end of the expansion will free store that was
3889allocated by the plugin code as well as the slop after the expanded string. So
b0e85a8f
JH
3890we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3891and, given the acl condition, ${if }. This is an unfortunate consequence of
3892string expansion becoming too powerful.
d6b4d938 3893
059ec3d9
PH
3894Arguments:
3895 string the string to be expanded
3896 ket_ends true if expansion is to stop at }
3897 left if not NULL, a pointer to the first character after the
3898 expansion is placed here (typically used with ket_ends)
3899 skipping TRUE for recursive calls when the value isn't actually going
3900 to be used (to allow for optimisation)
da6dbe26
PP
3901 honour_dollar TRUE if $ is to be expanded,
3902 FALSE if it's just another character
b0e85a8f
JH
3903 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3904 the store.
059ec3d9
PH
3905
3906Returns: NULL if expansion fails:
3907 expand_string_forcedfail is set TRUE if failure was forced
3908 expand_string_message contains a textual error message
3909 a pointer to the expanded string on success
3910*/
3911
3912static uschar *
55414b25 3913expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
b0e85a8f 3914 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
059ec3d9 3915{
acec9514 3916gstring * yield = string_get(Ustrlen(string) + 64);
5f5be492 3917int item_type;
55414b25 3918const uschar *s = string;
059ec3d9
PH
3919uschar *save_expand_nstring[EXPAND_MAXN+1];
3920int save_expand_nlength[EXPAND_MAXN+1];
d6b4d938 3921BOOL resetok = TRUE;
059ec3d9 3922
e1d04f48 3923expand_level++;
e47376be 3924DEBUG(D_expand)
1b37ac39
JH
3925 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
3926 skipping
3927 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
3928 : "considering",
3929 string);
e47376be 3930
059ec3d9
PH
3931expand_string_forcedfail = FALSE;
3932expand_string_message = US"";
3933
3934while (*s != 0)
3935 {
3936 uschar *value;
3937 uschar name[256];
3938
3939 /* \ escapes the next character, which must exist, or else
3940 the expansion fails. There's a special escape, \N, which causes
3941 copying of the subject verbatim up to the next \N. Otherwise,
3942 the escapes are the standard set. */
3943
3944 if (*s == '\\')
3945 {
3946 if (s[1] == 0)
3947 {
3948 expand_string_message = US"\\ at end of string";
3949 goto EXPAND_FAILED;
3950 }
3951
3952 if (s[1] == 'N')
3953 {
55414b25 3954 const uschar * t = s + 2;
059ec3d9 3955 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
acec9514 3956 yield = string_catn(yield, t, s - t);
059ec3d9
PH
3957 if (*s != 0) s += 2;
3958 }
3959
3960 else
3961 {
3962 uschar ch[1];
3963 ch[0] = string_interpret_escape(&s);
3964 s++;
acec9514 3965 yield = string_catn(yield, ch, 1);
059ec3d9
PH
3966 }
3967
3968 continue;
3969 }
3970
2e23003a 3971 /*{*/
059ec3d9
PH
3972 /* Anything other than $ is just copied verbatim, unless we are
3973 looking for a terminating } character. */
3974
2e23003a 3975 /*{*/
059ec3d9
PH
3976 if (ket_ends && *s == '}') break;
3977
da6dbe26 3978 if (*s != '$' || !honour_dollar)
059ec3d9 3979 {
acec9514 3980 yield = string_catn(yield, s++, 1);
059ec3d9
PH
3981 continue;
3982 }
3983
3984 /* No { after the $ - must be a plain name or a number for string
3985 match variable. There has to be a fudge for variables that are the
3986 names of header fields preceded by "$header_" because header field
3987 names can contain any printing characters except space and colon.
3988 For those that don't like typing this much, "$h_" is a synonym for
3989 "$header_". A non-existent header yields a NULL value; nothing is
2e23003a 3990 inserted. */ /*}*/
059ec3d9
PH
3991
3992 if (isalpha((*(++s))))
3993 {
3994 int len;
3995 int newsize = 0;
bb07bcd3 3996 gstring * g = NULL;
bce15b62 3997 uschar * t;
059ec3d9
PH
3998
3999 s = read_name(name, sizeof(name), s, US"_");
4000
4001 /* If this is the first thing to be expanded, release the pre-allocated
4002 buffer. */
4003
bb07bcd3
JH
4004 if (!yield)
4005 g = store_get(sizeof(gstring));
4006 else if (yield->ptr == 0)
059ec3d9 4007 {
d6b4d938 4008 if (resetok) store_reset(yield);
059ec3d9 4009 yield = NULL;
bb07bcd3 4010 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
059ec3d9
PH
4011 }
4012
4013 /* Header */
4014
bce15b62
JH
4015 if ( ( *(t = name) == 'h'
4016 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4017 )
4018 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4019 )
059ec3d9 4020 {
bce15b62
JH
4021 unsigned flags = *name == 'r' ? FH_WANT_RAW
4022 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4023 : 0;
4024 uschar * charset = *name == 'b' ? NULL : headers_charset;
4025
059ec3d9 4026 s = read_header_name(name, sizeof(name), s);
bce15b62 4027 value = find_header(name, &newsize, flags, charset);
059ec3d9
PH
4028
4029 /* If we didn't find the header, and the header contains a closing brace
0d85fa3f 4030 character, this may be a user error where the terminating colon
059ec3d9
PH
4031 has been omitted. Set a flag to adjust the error message in this case.
4032 But there is no error here - nothing gets inserted. */
4033
acec9514 4034 if (!value)
059ec3d9
PH
4035 {
4036 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
4037 continue;
4038 }
4039 }
4040
4041 /* Variable */
4042
63df3f26 4043 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
059ec3d9 4044 {
63df3f26
JH
4045 expand_string_message =
4046 string_sprintf("unknown variable name \"%s\"", name);
4047 check_variable_error_message(name);
4048 goto EXPAND_FAILED;
059ec3d9
PH
4049 }
4050
4051 /* If the data is known to be in a new buffer, newsize will be set to the
4052 size of that buffer. If this is the first thing in an expansion string,
4053 yield will be NULL; just point it at the new store instead of copying. Many
4054 expansion strings contain just one reference, so this is a useful
acec9514
JH
4055 optimization, especially for humungous headers. We need to use a gstring
4056 structure that is not allocated after that new-buffer, else a later store
4057 reset in the middle of the buffer will make it inaccessible. */
059ec3d9
PH
4058
4059 len = Ustrlen(value);
acec9514 4060 if (!yield && newsize != 0)
059ec3d9 4061 {
acec9514
JH
4062 yield = g;
4063 yield->size = newsize;
4064 yield->ptr = len;
4065 yield->s = value;
059ec3d9 4066 }
bb07bcd3
JH
4067 else
4068 yield = string_catn(yield, value, len);
059ec3d9
PH
4069
4070 continue;
4071 }
4072
4073 if (isdigit(*s))
4074 {
4075 int n;
55414b25 4076 s = read_cnumber(&n, s);
059ec3d9 4077 if (n >= 0 && n <= expand_nmax)
acec9514 4078 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
059ec3d9
PH
4079 continue;
4080 }
4081
2e23003a 4082 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
059ec3d9 4083
2e23003a 4084 if (*s != '{') /*}*/
059ec3d9 4085 {
2e23003a 4086 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
059ec3d9
PH
4087 goto EXPAND_FAILED;
4088 }
4089
4090 /* After { there can be various things, but they all start with
4091 an initial word, except for a number for a string match variable. */
4092
4093 if (isdigit((*(++s))))
4094 {
4095 int n;
55414b25 4096 s = read_cnumber(&n, s); /*{*/
059ec3d9 4097 if (*s++ != '}')
2e23003a 4098 { /*{*/
059ec3d9
PH
4099 expand_string_message = US"} expected after number";
4100 goto EXPAND_FAILED;
4101 }
4102 if (n >= 0 && n <= expand_nmax)
acec9514 4103 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
059ec3d9
PH
4104 continue;
4105 }
4106
4107 if (!isalpha(*s))
4108 {
2e23003a 4109 expand_string_message = US"letter or digit expected after ${"; /*}*/
059ec3d9
PH
4110 goto EXPAND_FAILED;
4111 }
4112
4113 /* Allow "-" in names to cater for substrings with negative
4114 arguments. Since we are checking for known names after { this is
4115 OK. */
4116
4117 s = read_name(name, sizeof(name), s, US"_-");
0539a19d 4118 item_type = chop_match(name, item_table, nelem(item_table));
059ec3d9
PH
4119
4120 switch(item_type)
4121 {
525239c1 4122 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
333eea9c 4123 If the ACL returns accept or reject we return content set by "message ="
723c72e6
JH
4124 There is currently no limit on recursion; this would have us call
4125 acl_check_internal() directly and get a current level from somewhere.
f60d98e8
JH
4126 See also the acl expansion condition ECOND_ACL and the traditional
4127 acl modifier ACLC_ACL.
be7a5781 4128 Assume that the function has side-effects on the store that must be preserved.
723c72e6
JH
4129 */
4130
4131 case EITEM_ACL:
333eea9c 4132 /* ${acl {name} {arg1}{arg2}...} */
723c72e6 4133 {
333eea9c 4134 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
723c72e6 4135 uschar *user_msg;
333eea9c 4136
089fc87a
JH
4137 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4138 &resetok))
723c72e6
JH
4139 {
4140 case 1: goto EXPAND_FAILED_CURLY;
4141 case 2:
4142 case 3: goto EXPAND_FAILED;
4143 }
4144 if (skipping) continue;
4145
be7a5781 4146 resetok = FALSE;
0539a19d 4147 switch(eval_acl(sub, nelem(sub), &user_msg))
723c72e6
JH
4148 {
4149 case OK:
333eea9c 4150 case FAIL:
187bc588 4151 DEBUG(D_expand)
e1d04f48 4152 debug_printf_indent("acl expansion yield: %s\n", user_msg);
723c72e6 4153 if (user_msg)
acec9514 4154 yield = string_cat(yield, user_msg);
723c72e6 4155 continue;
333eea9c 4156
723c72e6 4157 case DEFER:
333eea9c 4158 expand_string_forcedfail = TRUE;
6e3b198d 4159 /*FALLTHROUGH*/
723c72e6 4160 default:
333eea9c 4161 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
723c72e6
JH
4162 goto EXPAND_FAILED;
4163 }
4164 }
4165
dfbcb5ac
JH
4166 case EITEM_AUTHRESULTS:
4167 /* ${authresults {mysystemname}} */
4168 {
4169 uschar *sub_arg[1];
4170
4171 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4172 &resetok))
4173 {
4174 case 1: goto EXPAND_FAILED_CURLY;
4175 case 2:
4176 case 3: goto EXPAND_FAILED;
4177 }
4178
4179 yield = string_append(yield, 3,
4180 US"Authentication-Results: ", sub_arg[0], US"; none");
4181 yield->ptr -= 6;
4182
40394cc1 4183 yield = authres_local(yield, sub_arg[0]);
dfbcb5ac
JH
4184 yield = authres_iprev(yield);
4185 yield = authres_smtpauth(yield);
4186#ifdef SUPPORT_SPF
4187 yield = authres_spf(yield);
4188#endif
4189#ifndef DISABLE_DKIM
4190 yield = authres_dkim(yield);
617d3932 4191#endif
c9cf9ac4
JH
4192#ifdef EXPERIMENTAL_DMARC
4193 yield = authres_dmarc(yield);
4194#endif
617d3932
JH
4195#ifdef EXPERIMENTAL_ARC
4196 yield = authres_arc(yield);
dfbcb5ac
JH
4197#endif
4198 continue;
4199 }
4200
059ec3d9
PH
4201 /* Handle conditionals - preserve the values of the numerical expansion
4202 variables in case they get changed by a regular expression match in the
4203 condition. If not, they retain their external settings. At the end
4204 of this "if" section, they get restored to their previous values. */
4205
4206 case EITEM_IF:
4207 {
4208 BOOL cond = FALSE;
55414b25 4209 const uschar *next_s;
059ec3d9
PH
4210 int save_expand_nmax =
4211 save_expand_strings(save_expand_nstring, save_expand_nlength);
4212
4213 while (isspace(*s)) s++;
f267271d 4214 next_s = eval_condition(s, &resetok, skipping ? NULL : &cond);
059ec3d9
PH
4215 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4216
4217 DEBUG(D_expand)
e1d04f48 4218 {
1b37ac39
JH
4219 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4220 "condition: %.*s\n",
4221 (int)(next_s - s), s);
4222 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4223 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4224 "result: %s\n",
4225 cond ? "true" : "false");
e1d04f48 4226 }
059ec3d9
PH
4227
4228 s = next_s;
4229
4230 /* The handling of "yes" and "no" result strings is now in a separate
4231 function that is also used by ${lookup} and ${extract} and ${run}. */
4232
4233 switch(process_yesno(
4234 skipping, /* were previously skipping */
4235 cond, /* success/failure indicator */
4236 lookup_value, /* value to reset for string2 */
4237 &s, /* input pointer */
4238 &yield, /* output pointer */
b0e85a8f
JH
4239 US"if", /* condition type */
4240 &resetok))
059ec3d9
PH
4241 {
4242 case 1: goto EXPAND_FAILED; /* when all is well, the */
4243 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4244 }
4245
4246 /* Restore external setting of expansion variables for continuation
4247 at this level. */
4248
b0e85a8f
JH
4249 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4250 save_expand_nlength);
059ec3d9
PH
4251 continue;
4252 }
4253
8c5d388a 4254#ifdef SUPPORT_I18N
ed0512a1
JH
4255 case EITEM_IMAPFOLDER:
4256 { /* ${imapfolder {name}{sep]{specials}} */
4257 uschar *sub_arg[3];
4258 uschar *encoded;
4259
0539a19d
JH
4260 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4261 &resetok))
ed0512a1
JH
4262 {
4263 case 1: goto EXPAND_FAILED_CURLY;
4264 case 2:
4265 case 3: goto EXPAND_FAILED;
4266 }
4267
4268 if (sub_arg[1] == NULL) /* One argument */
4269 {
0539a19d 4270 sub_arg[1] = US"/"; /* default separator */
ed0512a1
JH
4271 sub_arg[2] = NULL;
4272 }
0539a19d 4273 else if (Ustrlen(sub_arg[1]) != 1)
ed0512a1 4274 {
94431adb 4275 expand_string_message =
ed0512a1 4276 string_sprintf(
94431adb 4277 "IMAP folder separator must be one character, found \"%s\"",
ed0512a1
JH
4278 sub_arg[1]);
4279 goto EXPAND_FAILED;
4280 }
4281
ed0512a1 4282 if (!skipping)
f267271d
JH
4283 {
4284 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4285 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4286 goto EXPAND_FAILED;
acec9514 4287 yield = string_cat(yield, encoded);
f267271d 4288 }
ed0512a1
JH
4289 continue;
4290 }
4291#endif
4292
059ec3d9
PH
4293 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4294 expanding an internal string that isn't actually going to be used. All we
4295 need to do is check the syntax, so don't do a lookup at all. Preserve the
4296 values of the numerical expansion variables in case they get changed by a
4297 partial lookup. If not, they retain their external settings. At the end
4298 of this "lookup" section, they get restored to their previous values. */
4299
4300 case EITEM_LOOKUP:
4301 {
4302 int stype, partial, affixlen, starflags;
4303 int expand_setup = 0;
4304 int nameptr = 0;
55414b25
JH
4305 uschar *key, *filename;
4306 const uschar *affix;
059ec3d9
PH
4307 uschar *save_lookup_value = lookup_value;
4308 int save_expand_nmax =
4309 save_expand_strings(save_expand_nstring, save_expand_nlength);
4310
4311 if ((expand_forbid & RDO_LOOKUP) != 0)
4312 {
4313 expand_string_message = US"lookup expansions are not permitted";
4314 goto EXPAND_FAILED;
4315 }
4316
4317 /* Get the key we are to look up for single-key+file style lookups.
4318 Otherwise set the key NULL pro-tem. */
4319
4320 while (isspace(*s)) s++;
2e23003a 4321 if (*s == '{') /*}*/
059ec3d9 4322 {
b0e85a8f 4323 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
e47376be
JH
4324 if (!key) goto EXPAND_FAILED; /*{{*/
4325 if (*s++ != '}')
4326 {
4327 expand_string_message = US"missing '}' after lookup key";
4328 goto EXPAND_FAILED_CURLY;
4329 }
059ec3d9
PH
4330 while (isspace(*s)) s++;
4331 }
4332 else key = NULL;
4333
4334 /* Find out the type of database */
4335
4336 if (!isalpha(*s))
4337 {
4338 expand_string_message = US"missing lookup type";
4339 goto EXPAND_FAILED;
4340 }
4341
4342 /* The type is a string that may contain special characters of various
4343 kinds. Allow everything except space or { to appear; the actual content
2e23003a 4344 is checked by search_findtype_partial. */ /*}*/
059ec3d9 4345
2e23003a 4346 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
059ec3d9
PH
4347 {
4348 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4349 s++;
4350 }
4351 name[nameptr] = 0;
4352 while (isspace(*s)) s++;
4353
4354 /* Now check for the individual search type and any partial or default
4355 options. Only those types that are actually in the binary are valid. */
4356
4357 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4358 &starflags);
4359 if (stype < 0)
4360 {
4361 expand_string_message = search_error_message;
4362 goto EXPAND_FAILED;
4363 }
4364
4365 /* Check that a key was provided for those lookup types that need it,
4366 and was not supplied for those that use the query style. */
4367
13b685f9 4368 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
059ec3d9
PH
4369 {
4370 if (key == NULL)
4371 {
4372 expand_string_message = string_sprintf("missing {key} for single-"
4373 "key \"%s\" lookup", name);
4374 goto EXPAND_FAILED;
4375 }
4376 }
4377 else
4378 {
4379 if (key != NULL)
4380 {
4381 expand_string_message = string_sprintf("a single key was given for "
4382 "lookup type \"%s\", which is not a single-key lookup type", name);
4383 goto EXPAND_FAILED;
4384 }
4385 }
4386
4387 /* Get the next string in brackets and expand it. It is the file name for
13b685f9
PH
4388 single-key+file lookups, and the whole query otherwise. In the case of
4389 queries that also require a file name (e.g. sqlite), the file name comes
4390 first. */
059ec3d9 4391
e47376be
JH
4392 if (*s != '{')
4393 {
4394 expand_string_message = US"missing '{' for lookup file-or-query arg";
4395 goto EXPAND_FAILED_CURLY;
4396 }
b0e85a8f 4397 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
059ec3d9 4398 if (filename == NULL) goto EXPAND_FAILED;
e47376be
JH
4399 if (*s++ != '}')
4400 {
4401 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4402 goto EXPAND_FAILED_CURLY;
4403 }
059ec3d9
PH
4404 while (isspace(*s)) s++;
4405
4406 /* If this isn't a single-key+file lookup, re-arrange the variables
13b685f9
PH
4407 to be appropriate for the search_ functions. For query-style lookups,
4408 there is just a "key", and no file name. For the special query-style +
4409 file types, the query (i.e. "key") starts with a file name. */
059ec3d9 4410
e47376be 4411 if (!key)
059ec3d9 4412 {
13b685f9 4413 while (isspace(*filename)) filename++;
059ec3d9 4414 key = filename;
13b685f9
PH
4415
4416 if (mac_islookup(stype, lookup_querystyle))
13b685f9 4417 filename = NULL;
13b685f9
PH
4418 else
4419 {
4420 if (*filename != '/')
4421 {
4422 expand_string_message = string_sprintf(
4423 "absolute file name expected for \"%s\" lookup", name);
4424 goto EXPAND_FAILED;
4425 }
4426 while (*key != 0 && !isspace(*key)) key++;
4427 if (*key != 0) *key++ = 0;
4428 }
059ec3d9
PH
4429 }
4430
4431 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4432 the entry was not found. Note that there is no search_close() function.
4433 Files are left open in case of re-use. At suitable places in higher logic,
4434 search_tidyup() is called to tidy all open files. This can save opening
4435 the same file several times. However, files may also get closed when
4436 others are opened, if too many are open at once. The rule is that a
4437 handle should not be used after a second search_open().
4438
4439 Request that a partial search sets up $1 and maybe $2 by passing
4440 expand_setup containing zero. If its value changes, reset expand_nmax,
4441 since new variables will have been set. Note that at the end of this
4442 "lookup" section, the old numeric variables are restored. */
4443
4444 if (skipping)
4445 lookup_value = NULL;
4446 else
4447 {
4448 void *handle = search_open(filename, stype, 0, NULL, NULL);
4449 if (handle == NULL)
4450 {
4451 expand_string_message = search_error_message;
4452 goto EXPAND_FAILED;
4453 }
4454 lookup_value = search_find(handle, filename, key, partial, affix,
4455 affixlen, starflags, &expand_setup);
4456 if (search_find_defer)
4457 {
4458 expand_string_message =
b72aab72
PP
4459 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4460 string_printing2(key, FALSE), search_error_message);
059ec3d9
PH
4461 goto EXPAND_FAILED;
4462 }
4463 if (expand_setup > 0) expand_nmax = expand_setup;
4464 }
4465
4466 /* The handling of "yes" and "no" result strings is now in a separate
4467 function that is also used by ${if} and ${extract}. */
4468
4469 switch(process_yesno(
4470 skipping, /* were previously skipping */
4471 lookup_value != NULL, /* success/failure indicator */
4472 save_lookup_value, /* value to reset for string2 */
4473 &s, /* input pointer */
4474 &yield, /* output pointer */
b0e85a8f
JH
4475 US"lookup", /* condition type */
4476 &resetok))
059ec3d9
PH
4477 {
4478 case 1: goto EXPAND_FAILED; /* when all is well, the */
4479 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4480 }
4481
4482 /* Restore external setting of expansion variables for carrying on
4483 at this level, and continue. */
4484
4485 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4486 save_expand_nlength);
4487 continue;
4488 }
4489
4490 /* If Perl support is configured, handle calling embedded perl subroutines,
4491 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4492 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4493 arguments (defined below). */
4494
059ec3d9
PH
4495 #define EXIM_PERL_MAX_ARGS 8
4496
4497 case EITEM_PERL:
1a46a8c5 4498 #ifndef EXIM_PERL
2e23003a 4499 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
1a46a8c5
PH
4500 "is not included in this binary";
4501 goto EXPAND_FAILED;
4502
4503 #else /* EXIM_PERL */
059ec3d9
PH
4504 {
4505 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
acec9514 4506 gstring *new_yield;
059ec3d9
PH
4507
4508 if ((expand_forbid & RDO_PERL) != 0)
4509 {
4510 expand_string_message = US"Perl calls are not permitted";
4511 goto EXPAND_FAILED;
4512 }
4513
4514 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
b0e85a8f 4515 US"perl", &resetok))
059ec3d9
PH
4516 {
4517 case 1: goto EXPAND_FAILED_CURLY;
4518 case 2:
4519 case 3: goto EXPAND_FAILED;
4520 }
4521
4522 /* If skipping, we don't actually do anything */
4523
4524 if (skipping) continue;
4525
4526 /* Start the interpreter if necessary */
4527
4528 if (!opt_perl_started)
4529 {
4530 uschar *initerror;
4531 if (opt_perl_startup == NULL)
4532 {
4533 expand_string_message = US"A setting of perl_startup is needed when "
4534 "using the Perl interpreter";
4535 goto EXPAND_FAILED;
4536 }
4537 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4538 initerror = init_perl(opt_perl_startup);
4539 if (initerror != NULL)
4540 {
4541 expand_string_message =
4542 string_sprintf("error in perl_startup code: %s\n", initerror);
4543 goto EXPAND_FAILED;
4544 }
4545 opt_perl_started = TRUE;
4546 }
4547
4548 /* Call the function */
4549
4550 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
acec9514 4551 new_yield = call_perl_cat(yield, &expand_string_message,
059ec3d9
PH
4552 sub_arg[0], sub_arg + 1);
4553
4554 /* NULL yield indicates failure; if the message pointer has been set to
4555 NULL, the yield was undef, indicating a forced failure. Otherwise the
4556 message will indicate some kind of Perl error. */
4557
4558 if (new_yield == NULL)
4559 {
4560 if (expand_string_message == NULL)
4561 {
4562 expand_string_message =
4563 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4564 "failure", sub_arg[0]);
4565 expand_string_forcedfail = TRUE;
4566 }
4567 goto EXPAND_FAILED;
4568 }
4569
4570 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4571 set during a callback from Perl. */
4572
4573 expand_string_forcedfail = FALSE;
4574 yield = new_yield;
4575 continue;
4576 }
4577 #endif /* EXIM_PERL */
4578
fffda43a
TK
4579 /* Transform email address to "prvs" scheme to use
4580 as BATV-signed return path */
4581
4582 case EITEM_PRVS:
4583 {
4584 uschar *sub_arg[3];
4585 uschar *p,*domain;
4586
b0e85a8f 4587 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
fffda43a
TK
4588 {
4589 case 1: goto EXPAND_FAILED_CURLY;
4590 case 2:
4591 case 3: goto EXPAND_FAILED;
4592 }
4593
4594 /* If skipping, we don't actually do anything */
4595 if (skipping) continue;
4596
4597 /* sub_arg[0] is the address */
db4dcd57
JH
4598 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
4599 || domain == sub_arg[0] || Ustrlen(domain) == 1)
fffda43a 4600 {
cb9328de
PH
4601 expand_string_message = US"prvs first argument must be a qualified email address";
4602 goto EXPAND_FAILED;
4603 }
4604
db4dcd57 4605 /* Calculate the hash. The third argument must be a single-digit
cb9328de
PH
4606 key number, or unset. */
4607
db4dcd57
JH
4608 if ( sub_arg[2]
4609 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
cb9328de 4610 {
db4dcd57 4611 expand_string_message = US"prvs third argument must be a single digit";
fffda43a
TK
4612 goto EXPAND_FAILED;
4613 }
4614
db4dcd57
JH
4615 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
4616 if (!p)
fffda43a 4617 {
cb9328de 4618 expand_string_message = US"prvs hmac-sha1 conversion failed";
fffda43a
TK
4619 goto EXPAND_FAILED;
4620 }
4621
4622 /* Now separate the domain from the local part */
4623 *domain++ = '\0';
4624
acec9514
JH
4625 yield = string_catn(yield, US"prvs=", 5);
4626 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
4627 yield = string_catn(yield, prvs_daystamp(7), 3);
4628 yield = string_catn(yield, p, 6);
4629 yield = string_catn(yield, US"=", 1);
4630 yield = string_cat (yield, sub_arg[0]);
4631 yield = string_catn(yield, US"@", 1);
4632 yield = string_cat (yield, domain);
fffda43a
TK
4633
4634 continue;
4635 }
4636
4637 /* Check a prvs-encoded address for validity */
4638
4639 case EITEM_PRVSCHECK:
4640 {
4641 uschar *sub_arg[3];
acec9514 4642 gstring * g;
fffda43a
TK
4643 const pcre *re;
4644 uschar *p;
72fdd6ae
PH
4645
4646 /* TF: Ugliness: We want to expand parameter 1 first, then set
fffda43a
TK
4647 up expansion variables that are used in the expansion of
4648 parameter 2. So we clone the string for the first
72fdd6ae
PH
4649 expansion, where we only expand parameter 1.
4650
4651 PH: Actually, that isn't necessary. The read_subs() function is
4652 designed to work this way for the ${if and ${lookup expansions. I've
4653 tidied the code.
4654 */
fffda43a
TK
4655
4656 /* Reset expansion variables */
4657 prvscheck_result = NULL;
4658 prvscheck_address = NULL;
4659 prvscheck_keynum = NULL;
4660
b0e85a8f 4661 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
fffda43a
TK
4662 {
4663 case 1: goto EXPAND_FAILED_CURLY;
4664 case 2:
4665 case 3: goto EXPAND_FAILED;
4666 }
4667
a48ced90 4668 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
fffda43a
TK
4669 TRUE,FALSE);
4670
72fdd6ae
PH
4671 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4672 {
a48ced90
TK
4673 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4674 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4675 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4676 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
fffda43a
TK
4677 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4678
e1d04f48
JH
4679 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
4680 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
4681 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
4682 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
4683 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
fffda43a
TK
4684
4685 /* Set up expansion variables */
acec9514
JH
4686 g = string_cat (NULL, local_part);
4687 g = string_catn(g, US"@", 1);
4688 g = string_cat (g, domain);
4689 prvscheck_address = string_from_gstring(g);
fffda43a
TK
4690 prvscheck_keynum = string_copy(key_num);
4691
72fdd6ae 4692 /* Now expand the second argument */
b0e85a8f 4693 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
fffda43a
TK
4694 {
4695 case 1: goto EXPAND_FAILED_CURLY;
4696 case 2:
4697 case 3: goto EXPAND_FAILED;
4698 }
4699
fffda43a 4700 /* Now we have the key and can check the address. */
72fdd6ae
PH
4701
4702 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4703 daystamp);
4704
acec9514 4705 if (!p)
fffda43a
TK
4706 {
4707 expand_string_message = US"hmac-sha1 conversion failed";
4708 goto EXPAND_FAILED;
4709 }
4710
e1d04f48
JH
4711 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
4712 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
72fdd6ae 4713
fffda43a
TK
4714 if (Ustrcmp(p,hash) == 0)
4715 {
4716 /* Success, valid BATV address. Now check the expiry date. */
4717 uschar *now = prvs_daystamp(0);
4718 unsigned int inow = 0,iexpire = 1;
4719
ff790e47
PH
4720 (void)sscanf(CS now,"%u",&inow);
4721 (void)sscanf(CS daystamp,"%u",&iexpire);
fffda43a
TK
4722
4723 /* When "iexpire" is < 7, a "flip" has occured.
4724 Adjust "inow" accordingly. */
4725 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4726
686c36b7 4727 if (iexpire >= inow)
fffda43a
TK
4728 {
4729 prvscheck_result = US"1";
e1d04f48 4730 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
fffda43a 4731 }
db4dcd57 4732 else
fffda43a
TK
4733 {
4734 prvscheck_result = NULL;
e1d04f48 4735 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
fffda43a
TK
4736 }
4737 }
4738 else
4739 {
4740 prvscheck_result = NULL;
e1d04f48 4741 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
fffda43a 4742 }
72fdd6ae
PH
4743
4744 /* Now expand the final argument. We leave this till now so that
4745 it can include $prvscheck_result. */
4746
b0e85a8f 4747 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
72fdd6ae
PH
4748 {
4749 case 1: goto EXPAND_FAILED_CURLY;
4750 case 2:
4751 case 3: goto EXPAND_FAILED;
4752 }
4753
acec9514 4754 yield = string_cat(yield,
c2f669a4 4755 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
72fdd6ae
PH
4756
4757 /* Reset the "internal" variables afterwards, because they are in
4758 dynamic store that will be reclaimed if the expansion succeeded. */
4759
4760 prvscheck_address = NULL;
4761 prvscheck_keynum = NULL;
4762 }
fffda43a 4763 else
fffda43a 4764 /* Does not look like a prvs encoded address, return the empty string.
72fdd6ae
PH
4765 We need to make sure all subs are expanded first, so as to skip over
4766 the entire item. */
4767
b0e85a8f 4768 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
fffda43a
TK
4769 {
4770 case 1: goto EXPAND_FAILED_CURLY;
4771 case 2:
4772 case 3: goto EXPAND_FAILED;
4773 }
fffda43a
TK
4774
4775 continue;
4776 }
4777
059ec3d9
PH
4778 /* Handle "readfile" to insert an entire file */
4779
4780 case EITEM_READFILE:
4781 {
4782 FILE *f;
4783 uschar *sub_arg[2];
4784
4785 if ((expand_forbid & RDO_READFILE) != 0)
4786 {
4787 expand_string_message = US"file insertions are not permitted";
4788 goto EXPAND_FAILED;
4789 }
4790
b0e85a8f 4791 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
059ec3d9
PH
4792 {
4793 case 1: goto EXPAND_FAILED_CURLY;
4794 case 2:
4795 case 3: goto EXPAND_FAILED;
4796 }
4797
4798 /* If skipping, we don't actually do anything */
4799
4800 if (skipping) continue;
4801
4802 /* Open the file and read it */
4803
4a5cbaff 4804 if (!(f = Ufopen(sub_arg[0], "rb")))
059ec3d9
PH
4805 {
4806 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4807 goto EXPAND_FAILED;
4808 }
4809
acec9514 4810 yield = cat_file(f, yield, sub_arg[1]);
f1e894f3 4811 (void)fclose(f);
059ec3d9
PH
4812 continue;
4813 }
4814
4a5cbaff
JH
4815 /* Handle "readsocket" to insert data from a socket, either
4816 Inet or Unix domain */
059ec3d9
PH
4817
4818 case EITEM_READSOCK:
4819 {
4820 int fd;
4821 int timeout = 5;
acec9514 4822 int save_ptr = yield->ptr;
059ec3d9 4823 FILE *f;
afdb5e9c
JH
4824 uschar * arg;
4825 uschar * sub_arg[4];
4826 uschar * server_name = NULL;
4827 host_item host;
8de9db65 4828 BOOL do_shutdown = TRUE;
48334568
JH
4829 BOOL do_tls = FALSE; /* Only set under SUPPORT_TLS */
4830 void * tls_ctx = NULL; /* ditto */
4a5cbaff 4831 blob reqstr;
059ec3d9 4832
8de9db65 4833 if (expand_forbid & RDO_READSOCK)
059ec3d9
PH
4834 {
4835 expand_string_message = US"socket insertions are not permitted";
4836 goto EXPAND_FAILED;
4837 }
4838
4839 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4840 because there may be a string for expansion on failure. */
4841
b0e85a8f 4842 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
059ec3d9
PH
4843 {
4844 case 1: goto EXPAND_FAILED_CURLY;
4845 case 2: /* Won't occur: no end check */
4846 case 3: goto EXPAND_FAILED;
4847 }
4848
4a5cbaff
JH
4849 /* Grab the request string, if any */
4850
4851 reqstr.data = sub_arg[1];
4852 reqstr.len = Ustrlen(sub_arg[1]);
4853
8de9db65
JH
4854 /* Sort out timeout, if given. The second arg is a list with the first element
4855 being a time value. Any more are options of form "name=value". Currently the
4856 only option recognised is "shutdown". */
059ec3d9 4857
8de9db65 4858 if (sub_arg[2])
059ec3d9 4859 {
8de9db65
JH
4860 const uschar * list = sub_arg[2];
4861 uschar * item;
4862 int sep = 0;
4863
4864 item = string_nextinlist(&list, &sep, NULL, 0);
4865 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
059ec3d9 4866 {
8de9db65 4867 expand_string_message = string_sprintf("bad time value %s", item);
059ec3d9
PH
4868 goto EXPAND_FAILED;
4869 }
8de9db65
JH
4870
4871 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
4872 if (Ustrncmp(item, US"shutdown=", 9) == 0)
afdb5e9c
JH
4873 { if (Ustrcmp(item + 9, US"no") == 0) do_shutdown = FALSE; }
4874#ifdef SUPPORT_TLS
4875 else if (Ustrncmp(item, US"tls=", 4) == 0)
4876 { if (Ustrcmp(item + 9, US"no") != 0) do_tls = TRUE; }
4877#endif
059ec3d9 4878 }
afdb5e9c
JH
4879 else
4880 sub_arg[3] = NULL; /* No eol if no timeout */
059ec3d9 4881
1cce3af8
PH
4882 /* If skipping, we don't actually do anything. Otherwise, arrange to
4883 connect to either an IP or a Unix socket. */
059ec3d9
PH
4884
4885 if (!skipping)
4886 {
1cce3af8 4887 /* Handle an IP (internet) domain */
059ec3d9 4888
91ecef39 4889 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
059ec3d9 4890 {
b1f8e4f8 4891 int port;
afdb5e9c
JH
4892 uschar * port_name;
4893
4894 server_name = sub_arg[0] + 5;
4895 port_name = Ustrrchr(server_name, ':');
1cce3af8
PH
4896
4897 /* Sort out the port */
4898
4a5cbaff 4899 if (!port_name)
1cce3af8
PH
4900 {
4901 expand_string_message =
4902 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4903 goto EXPAND_FAILED;
4904 }
4905 *port_name++ = 0; /* Terminate server name */
4906
4907 if (isdigit(*port_name))
4908 {
4909 uschar *end;
4910 port = Ustrtol(port_name, &end, 0);
4911 if (end != port_name + Ustrlen(port_name))
4912 {
4913 expand_string_message =
4914 string_sprintf("invalid port number %s", port_name);
4915 goto EXPAND_FAILED;
4916 }
4917 }
4918 else
4919 {
4920 struct servent *service_info = getservbyname(CS port_name, "tcp");
4a5cbaff 4921 if (!service_info)
1cce3af8
PH
4922 {
4923 expand_string_message = string_sprintf("unknown port \"%s\"",
4924 port_name);
4925 goto EXPAND_FAILED;
4926 }
4927 port = ntohs(service_info->s_port);
4928 }
4929
90341c71 4930 fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
afdb5e9c
JH
4931 timeout, &host, &expand_string_message,
4932 do_tls ? NULL : &reqstr);
90341c71
JH
4933 callout_address = NULL;
4934 if (fd < 0)
48334568
JH
4935 goto SOCK_FAIL;
4936 if (!do_tls)
4937 reqstr.len = 0;
059ec3d9
PH
4938 }
4939
1cce3af8
PH
4940 /* Handle a Unix domain socket */
4941
4942 else
059ec3d9 4943 {
4a5cbaff 4944 struct sockaddr_un sockun; /* don't call this "sun" ! */
a401ddaa 4945 int rc;
4a5cbaff 4946
1cce3af8
PH
4947 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4948 {
4949 expand_string_message = string_sprintf("failed to create socket: %s",
4950 strerror(errno));
4951 goto SOCK_FAIL;
4952 }
4953
4954 sockun.sun_family = AF_UNIX;
4955 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4956 sub_arg[0]);
afdb5e9c 4957 server_name = sockun.sun_path;
a401ddaa
PH
4958
4959 sigalrm_seen = FALSE;
4960 alarm(timeout);
4961 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4962 alarm(0);
734e1499 4963 if (sigalrm_seen)
1cce3af8 4964 {
734e1499 4965 expand_string_message = US "socket connect timed out";
1cce3af8
PH
4966 goto SOCK_FAIL;
4967 }
734e1499 4968 if (rc < 0)
a401ddaa 4969 {
734e1499
PH
4970 expand_string_message = string_sprintf("failed to connect to socket "
4971 "%s: %s", sub_arg[0], strerror(errno));
a401ddaa
PH
4972 goto SOCK_FAIL;
4973 }
afdb5e9c
JH
4974 host.name = server_name;
4975 host.address = US"";
059ec3d9 4976 }
1cce3af8 4977
e1d04f48 4978 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
059ec3d9 4979
afdb5e9c
JH
4980#ifdef SUPPORT_TLS
4981 if (do_tls)
4982 {
9377b957 4983 tls_support tls_dummy = {.sni=NULL};
afdb5e9c
JH
4984 uschar * errstr;
4985
9377b957
JH
4986 if (!(tls_ctx = tls_client_start(fd, &host, NULL, NULL,
4987# ifdef SUPPORT_DANE
4988 NULL,
4989# endif
afdb5e9c
JH
4990 &tls_dummy, &errstr)))
4991 {
4992 expand_string_message = string_sprintf("TLS connect failed: %s", errstr);
4993 goto SOCK_FAIL;
4994 }
4995 }
4996#endif
4997
567e584c
JH
4998 /* Allow sequencing of test actions */
4999 if (running_in_test_harness) millisleep(100);
5000
4a5cbaff 5001 /* Write the request string, if not empty or already done */
059ec3d9 5002
4a5cbaff 5003 if (reqstr.len)
059ec3d9 5004 {
e1d04f48 5005 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
4a5cbaff 5006 reqstr.data);
afdb5e9c
JH
5007 if ( (
5008#ifdef SUPPORT_TLS
5009 tls_ctx ? tls_write(tls_ctx, reqstr.data, reqstr.len, FALSE) :
5010#endif
5011 write(fd, reqstr.data, reqstr.len)) != reqstr.len)
059ec3d9
PH
5012 {
5013 expand_string_message = string_sprintf("request write to socket "
5014 "failed: %s", strerror(errno));
5015 goto SOCK_FAIL;
5016 }
5017 }
5018
c1114884
PH
5019 /* Shut down the sending side of the socket. This helps some servers to
5020 recognise that it is their turn to do some work. Just in case some
5021 system doesn't have this function, make it conditional. */
5022
8de9db65 5023#ifdef SHUT_WR
afdb5e9c 5024 if (!tls_ctx && do_shutdown) shutdown(fd, SHUT_WR);
8de9db65 5025#endif
c1114884 5026
567e584c
JH
5027 if (running_in_test_harness) millisleep(100);
5028
059ec3d9
PH
5029 /* Now we need to read from the socket, under a timeout. The function
5030 that reads a file can be used. */
5031
afdb5e9c
JH
5032 if (!tls_ctx)
5033 f = fdopen(fd, "rb");
059ec3d9
PH
5034 sigalrm_seen = FALSE;
5035 alarm(timeout);
afdb5e9c
JH
5036 yield =
5037#ifdef SUPPORT_TLS
5038 tls_ctx ? cat_file_tls(tls_ctx, yield, sub_arg[3]) :
5039#endif
5040 cat_file(f, yield, sub_arg[3]);
059ec3d9 5041 alarm(0);
afdb5e9c
JH
5042
5043#ifdef SUPPORT_TLS
5044 if (tls_ctx)
5045 {
5046 tls_close(tls_ctx, TRUE);
5047 close(fd);
5048 }
5049 else
5050#endif
5051 (void)fclose(f);
059ec3d9
PH
5052
5053 /* After a timeout, we restore the pointer in the result, that is,
5054 make sure we add nothing from the socket. */
5055
5056 if (sigalrm_seen)
5057 {
acec9514 5058 yield->ptr = save_ptr;
1cce3af8 5059 expand_string_message = US "socket read timed out";
059ec3d9
PH
5060 goto SOCK_FAIL;
5061 }
5062 }
5063
5064 /* The whole thing has worked (or we were skipping). If there is a
5065 failure string following, we need to skip it. */
5066
5067 if (*s == '{')
5068 {
b0e85a8f 5069 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
059ec3d9 5070 goto EXPAND_FAILED;
e47376be
JH
5071 if (*s++ != '}')
5072 {
5073 expand_string_message = US"missing '}' closing failstring for readsocket";
5074 goto EXPAND_FAILED_CURLY;
5075 }
059ec3d9
PH
5076 while (isspace(*s)) s++;
5077 }
e47376be 5078
8de9db65 5079 READSOCK_DONE:
e47376be
JH
5080 if (*s++ != '}')
5081 {
5082 expand_string_message = US"missing '}' closing readsocket";
5083 goto EXPAND_FAILED_CURLY;
5084 }
059ec3d9
PH
5085 continue;
5086
5087 /* Come here on failure to create socket, connect socket, write to the
5088 socket, or timeout on reading. If another substring follows, expand and
5089 use it. Otherwise, those conditions give expand errors. */
5090
8de9db65 5091 SOCK_FAIL:
059ec3d9
PH
5092 if (*s != '{') goto EXPAND_FAILED;
5093 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
c2f669a4
JH
5094 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5095 goto EXPAND_FAILED;
acec9514 5096 yield = string_cat(yield, arg);
e47376be
JH
5097 if (*s++ != '}')
5098 {
5099 expand_string_message = US"missing '}' closing failstring for readsocket";
5100 goto EXPAND_FAILED_CURLY;
5101 }
059ec3d9 5102 while (isspace(*s)) s++;
8de9db65 5103 goto READSOCK_DONE;
059ec3d9
PH
5104 }
5105
5106 /* Handle "run" to execute a program. */
5107
5108 case EITEM_RUN:
5109 {
5110 FILE *f;
059ec3d9 5111 uschar *arg;
55414b25 5112 const uschar **argv;
059ec3d9
PH
5113 pid_t pid;
5114 int fd_in, fd_out;
059ec3d9
PH
5115
5116 if ((expand_forbid & RDO_RUN) != 0)
5117 {
5118 expand_string_message = US"running a command is not permitted";
5119 goto EXPAND_FAILED;
5120 }
5121
5122 while (isspace(*s)) s++;
e47376be
JH
5123 if (*s != '{')
5124 {
5125 expand_string_message = US"missing '{' for command arg of run";
5126 goto EXPAND_FAILED_CURLY;
5127 }
b0e85a8f 5128 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
059ec3d9
PH
5129 if (arg == NULL) goto EXPAND_FAILED;
5130 while (isspace(*s)) s++;
e47376be
JH
5131 if (*s++ != '}')
5132 {
5133 expand_string_message = US"missing '}' closing command arg of run";
5134 goto EXPAND_FAILED_CURLY;
5135 }
059ec3d9
PH
5136
5137 if (skipping) /* Just pretend it worked when we're skipping */
20fcb1e7 5138 {
059ec3d9 5139 runrc = 0;
20fcb1e7
JH
5140 lookup_value = NULL;
5141 }
059ec3d9
PH
5142 else
5143 {
5144 if (!transport_set_up_command(&argv, /* anchor for arg list */
5145 arg, /* raw command */
5146 FALSE, /* don't expand the arguments */
5147 0, /* not relevant when... */
5148 NULL, /* no transporting address */
5149 US"${run} expansion", /* for error messages */
5150 &expand_string_message)) /* where to put error message */
059ec3d9 5151 goto EXPAND_FAILED;
059ec3d9
PH
5152
5153 /* Create the child process, making it a group leader. */
5154
fa01e4f8 5155 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
059ec3d9
PH
5156 {
5157 expand_string_message =
5158 string_sprintf("couldn't create child process: %s", strerror(errno));
5159 goto EXPAND_FAILED;
5160 }
5161
5162 /* Nothing is written to the standard input. */
5163
f1e894f3 5164 (void)close(fd_in);
059ec3d9 5165
ac53fcda
PP
5166 /* Read the pipe to get the command's output into $value (which is kept
5167 in lookup_value). Read during execution, so that if the output exceeds
1a08dbc4
JH
5168 the OS pipe buffer limit, we don't block forever. Remember to not release
5169 memory just allocated for $value. */
ac53fcda 5170
1a08dbc4 5171 resetok = FALSE;
ac53fcda
PP
5172 f = fdopen(fd_out, "rb");
5173 sigalrm_seen = FALSE;
5174 alarm(60);
acec9514 5175 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
ac53fcda
PP
5176 alarm(0);
5177 (void)fclose(f);
5178
059ec3d9
PH
5179 /* Wait for the process to finish, applying the timeout, and inspect its
5180 return code for serious disasters. Simple non-zero returns are passed on.
5181 */
5182
8487aee9 5183 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
059ec3d9 5184 {
8487aee9 5185 if (sigalrm_seen || runrc == -256)
059ec3d9
PH
5186 {
5187 expand_string_message = string_sprintf("command timed out");
5188 killpg(pid, SIGKILL); /* Kill the whole process group */
5189 }
5190
5191 else if (runrc == -257)
5192 expand_string_message = string_sprintf("wait() failed: %s",
5193 strerror(errno));
5194
5195 else
5196 expand_string_message = string_sprintf("command killed by signal %d",
5197 -runrc);
5198
5199 goto EXPAND_FAILED;
5200 }
059ec3d9
PH
5201 }
5202
d20976dc 5203 /* Process the yes/no strings; $value may be useful in both cases */
059ec3d9
PH
5204
5205 switch(process_yesno(
5206 skipping, /* were previously skipping */
5207 runrc == 0, /* success/failure indicator */
d20976dc 5208 lookup_value, /* value to reset for string2 */
059ec3d9
PH
5209 &s, /* input pointer */
5210 &yield, /* output pointer */
b0e85a8f
JH
5211 US"run", /* condition type */
5212 &resetok))
059ec3d9
PH
5213 {
5214 case 1: goto EXPAND_FAILED; /* when all is well, the */
5215 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5216 }
5217
5218 continue;
5219 }
5220
5221 /* Handle character translation for "tr" */
5222
5223 case EITEM_TR:
5224 {
acec9514 5225 int oldptr = yield->ptr;
059ec3d9
PH
5226 int o2m;
5227 uschar *sub[3];
5228
b0e85a8f 5229 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
059ec3d9
PH
5230 {
5231 case 1: goto EXPAND_FAILED_CURLY;
5232 case 2:
5233 case 3: goto EXPAND_FAILED;
5234 }
5235
acec9514 5236 yield = string_cat(yield, sub[0]);
059ec3d9
PH
5237 o2m = Ustrlen(sub[2]) - 1;
5238
acec9514 5239 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
059ec3d9 5240 {
acec9514 5241 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
059ec3d9
PH
5242 if (m != NULL)
5243 {
5244 int o = m - sub[1];
acec9514 5245 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
059ec3d9
PH
5246 }
5247 }
5248
5249 continue;
5250 }
5251
5252 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5253 expanded arguments. */
5254
5255 case EITEM_HASH:
5256 case EITEM_LENGTH:
5257 case EITEM_NHASH:
5258 case EITEM_SUBSTR:
5259 {
5260 int i;
5261 int len;
5262 uschar *ret;
5263 int val[2] = { 0, -1 };
5264 uschar *sub[3];
5265
5266 /* "length" takes only 2 arguments whereas the others take 2 or 3.
2e23003a 5267 Ensure that sub[2] is set in the ${length } case. */
059ec3d9
PH
5268
5269 sub[2] = NULL;
5270 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
b0e85a8f 5271 TRUE, name, &resetok))
059ec3d9
PH
5272 {
5273 case 1: goto EXPAND_FAILED_CURLY;
5274 case 2:
5275 case 3: goto EXPAND_FAILED;
5276 }
5277
5278 /* Juggle the arguments if there are only two of them: always move the
5279 string to the last position and make ${length{n}{str}} equivalent to
5280 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5281
5282 if (sub[2] == NULL)
5283 {
5284 sub[2] = sub[1];
5285 sub[1] = NULL;
5286 if (item_type == EITEM_LENGTH)
5287 {
5288 sub[1] = sub[0];
5289 sub[0] = NULL;
5290 }
5291 }
5292
5293 for (i = 0; i < 2; i++)
5294 {
5295 if (sub[i] == NULL) continue;
5296 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5297 if (*ret != 0 || (i != 0 && val[i] < 0))
5298 {
5299 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5300 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5301 goto EXPAND_FAILED;
5302 }
5303 }
5304
5305 ret =
5306 (item_type == EITEM_HASH)?
5307 compute_hash(sub[2], val[0], val[1], &len) :
5308 (item_type == EITEM_NHASH)?
5309 compute_nhash(sub[2], val[0], val[1], &len) :
5310 extract_substr(sub[2], val[0], val[1], &len);
5311
5312 if (ret == NULL) goto EXPAND_FAILED;
acec9514 5313 yield = string_catn(yield, ret, len);
059ec3d9
PH
5314 continue;
5315 }
5316
5317 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5318 This code originally contributed by Steve Haslam. It currently supports
5319 the use of MD5 and SHA-1 hashes.
5320
5321 We need some workspace that is large enough to handle all the supported
5322 hash types. Use macros to set the sizes rather than be too elaborate. */
5323
5324 #define MAX_HASHLEN 20
5325 #define MAX_HASHBLOCKLEN 64
5326
5327 case EITEM_HMAC:
5328 {
5329 uschar *sub[3];
5330 md5 md5_base;
5fb822fc 5331 hctx sha1_ctx;
059ec3d9
PH
5332 void *use_base;
5333 int type, i;
5334 int hashlen; /* Number of octets for the hash algorithm's output */
5335 int hashblocklen; /* Number of octets the hash algorithm processes */
5336 uschar *keyptr, *p;
5337 unsigned int keylen;
5338
5339 uschar keyhash[MAX_HASHLEN];
5340 uschar innerhash[MAX_HASHLEN];
5341 uschar finalhash[MAX_HASHLEN];
5342 uschar finalhash_hex[2*MAX_HASHLEN];
5343 uschar innerkey[MAX_HASHBLOCKLEN];
5344 uschar outerkey[MAX_HASHBLOCKLEN];
5345
b0e85a8f 5346 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
059ec3d9
PH
5347 {
5348 case 1: goto EXPAND_FAILED_CURLY;
5349 case 2:
5350 case 3: goto EXPAND_FAILED;
5351 }
5352
e12b4599
JH
5353 if (!skipping)
5354 {
5355 if (Ustrcmp(sub[0], "md5") == 0)
5356 {
5357 type = HMAC_MD5;
5358 use_base = &md5_base;
5359 hashlen = 16;
5360 hashblocklen = 64;
5361 }
5362 else if (Ustrcmp(sub[0], "sha1") == 0)
5363 {
5364 type = HMAC_SHA1;
5365 use_base = &sha1_ctx;
5366 hashlen = 20;
5367 hashblocklen = 64;
5368 }
5369 else
5370 {
5371 expand_string_message =
5372 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5373 goto EXPAND_FAILED;
5374 }
059ec3d9 5375
e12b4599
JH
5376 keyptr = sub[1];
5377 keylen = Ustrlen(keyptr);
059ec3d9 5378
e12b4599
JH
5379 /* If the key is longer than the hash block length, then hash the key
5380 first */
059ec3d9 5381
e12b4599
JH
5382 if (keylen > hashblocklen)
5383 {
5384 chash_start(type, use_base);
5385 chash_end(type, use_base, keyptr, keylen, keyhash);
5386 keyptr = keyhash;
5387 keylen = hashlen;
5388 }
059ec3d9 5389
e12b4599 5390 /* Now make the inner and outer key values */
059ec3d9 5391
e12b4599
JH
5392 memset(innerkey, 0x36, hashblocklen);
5393 memset(outerkey, 0x5c, hashblocklen);
059ec3d9 5394
e12b4599
JH
5395 for (i = 0; i < keylen; i++)
5396 {
5397 innerkey[i] ^= keyptr[i];
5398 outerkey[i] ^= keyptr[i];
5399 }
059ec3d9 5400
e12b4599 5401 /* Now do the hashes */
059ec3d9 5402
e12b4599
JH
5403 chash_start(type, use_base);
5404 chash_mid(type, use_base, innerkey);
5405 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
059ec3d9 5406
e12b4599
JH
5407 chash_start(type, use_base);
5408 chash_mid(type, use_base, outerkey);
5409 chash_end(type, use_base, innerhash, hashlen, finalhash);
059ec3d9 5410
e12b4599 5411 /* Encode the final hash as a hex string */
059ec3d9 5412
e12b4599
JH
5413 p = finalhash_hex;
5414 for (i = 0; i < hashlen; i++)
5415 {
5416 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5417 *p++ = hex_digits[finalhash[i] & 0x0f];
5418 }
059ec3d9 5419
e12b4599
JH
5420 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5421 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
059ec3d9 5422
acec9514 5423 yield = string_catn(yield, finalhash_hex, hashlen*2);
e12b4599
JH
5424 }
5425 continue;
059ec3d9
PH
5426 }
5427
059ec3d9
PH
5428 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5429 We have to save the numerical variables and restore them afterwards. */
5430
5431 case EITEM_SG:
5432 {
5433 const pcre *re;
5434 int moffset, moffsetextra, slen;
5435 int roffset;
5436 int emptyopt;
5437 const uschar *rerror;
5438 uschar *subject;
5439 uschar *sub[3];
5440 int save_expand_nmax =
5441 save_expand_strings(save_expand_nstring, save_expand_nlength);
5442
b0e85a8f 5443 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
059ec3d9
PH
5444 {
5445 case 1: goto EXPAND_FAILED_CURLY;
5446 case 2:
5447 case 3: goto EXPAND_FAILED;
5448 }
5449
5450 /* Compile the regular expression */
5451
5452 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5453 NULL);
5454
5455 if (re == NULL)
5456 {
5457 expand_string_message = string_sprintf("regular expression error in "
5458 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5459 goto EXPAND_FAILED;
5460 }
5461
5462 /* Now run a loop to do the substitutions as often as necessary. It ends
5463 when there are no more matches. Take care over matches of the null string;
5464 do the same thing as Perl does. */
5465
5466 subject = sub[0];
5467 slen = Ustrlen(sub[0]);
5468 moffset = moffsetextra = 0;
5469 emptyopt = 0;
5470
5471 for (;;)
5472 {
5473 int ovector[3*(EXPAND_MAXN+1)];
5474 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
0539a19d 5475 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
059ec3d9
PH
5476 int nn;
5477 uschar *insert;
5478
5479 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5480 is not necessarily the end. We want to repeat the match from one
5481 character further along, but leaving the basic offset the same (for
5482 copying below). We can't be at the end of the string - that was checked
5483 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5484 finished; copy the remaining string and end the loop. */
5485
5486 if (n < 0)
5487 {
5488 if (emptyopt != 0)
5489 {
5490 moffsetextra = 1;
5491 emptyopt = 0;
5492 continue;
5493 }
acec9514 5494 yield = string_catn(yield, subject+moffset, slen-moffset);
059ec3d9
PH
5495 break;
5496 }
5497
5498 /* Match - set up for expanding the replacement. */
5499
5500 if (n == 0) n = EXPAND_MAXN + 1;
5501 expand_nmax = 0;
5502 for (nn = 0; nn < n*2; nn += 2)
5503 {
5504 expand_nstring[expand_nmax] = subject + ovector[nn];
5505 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5506 }
5507 expand_nmax--;
5508
5509 /* Copy the characters before the match, plus the expanded insertion. */
5510
acec9514 5511 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
059ec3d9
PH
5512 insert = expand_string(sub[2]);
5513 if (insert == NULL) goto EXPAND_FAILED;
acec9514 5514 yield = string_cat(yield, insert);
059ec3d9
PH
5515
5516 moffset = ovector[1];
5517 moffsetextra = 0;
5518 emptyopt = 0;
5519
5520 /* If we have matched an empty string, first check to see if we are at
5521 the end of the subject. If so, the loop is over. Otherwise, mimic
5522 what Perl's /g options does. This turns out to be rather cunning. First
5523 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5524 string at the same point. If this fails (picked up above) we advance to
5525 the next character. */
5526
5527 if (ovector[0] == ovector[1])
5528 {
5529 if (ovector[0] == slen) break;
5530 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5531 }
5532 }
5533
5534 /* All done - restore numerical variables. */
5535
5536 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5537 save_expand_nlength);
5538 continue;
5539 }
5540
5541 /* Handle keyed and numbered substring extraction. If the first argument
5542 consists entirely of digits, then a numerical extraction is assumed. */
5543
5544 case EITEM_EXTRACT:
5545 {
5546 int i;
1cf59ee7 5547 int j;
059ec3d9
PH
5548 int field_number = 1;
5549 BOOL field_number_set = FALSE;
5550 uschar *save_lookup_value = lookup_value;
5551 uschar *sub[3];
5552 int save_expand_nmax =
5553 save_expand_strings(save_expand_nstring, save_expand_nlength);
5554
93cc2d6e
JH
5555 /* While skipping we cannot rely on the data for expansions being
5556 available (eg. $item) hence cannot decide on numeric vs. keyed.
4c04137d 5557 Read a maximum of 5 arguments (including the yes/no) */
059ec3d9 5558
93cc2d6e
JH
5559 if (skipping)
5560 {
5561 while (isspace(*s)) s++;
1cf59ee7 5562 for (j = 5; j > 0 && *s == '{'; j--)
93cc2d6e
JH
5563 {
5564 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5565 goto EXPAND_FAILED; /*{*/
e47376be
JH
5566 if (*s++ != '}')
5567 {
5568 expand_string_message = US"missing '{' for arg of extract";
5569 goto EXPAND_FAILED_CURLY;
5570 }
93cc2d6e
JH
5571 while (isspace(*s)) s++;
5572 }
1cf59ee7
JH
5573 if ( Ustrncmp(s, "fail", 4) == 0
5574 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5575 )
5576 {
5577 s += 4;
5578 while (isspace(*s)) s++;
5579 }
93cc2d6e 5580 if (*s != '}')
e47376be
JH
5581 {
5582 expand_string_message = US"missing '}' closing extract";
93cc2d6e 5583 goto EXPAND_FAILED_CURLY;
e47376be 5584 }
93cc2d6e
JH
5585 }
5586
1cf59ee7 5587 else for (i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
059ec3d9
PH
5588 {
5589 while (isspace(*s)) s++;
aa26e137 5590 if (*s == '{') /*}*/
059ec3d9 5591 {
b0e85a8f
JH
5592 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5593 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
e47376be
JH
5594 if (*s++ != '}')
5595 {
5596 expand_string_message = string_sprintf(
e2e3255a 5597 "missing '}' closing arg %d of extract", i+1);
e47376be
JH
5598 goto EXPAND_FAILED_CURLY;
5599 }
059ec3d9
PH
5600
5601 /* After removal of leading and trailing white space, the first
5602 argument must not be empty; if it consists entirely of digits
5603 (optionally preceded by a minus sign), this is a numerical
5604 extraction, and we expect 3 arguments. */
5605
5606 if (i == 0)
5607 {
5608 int len;
5609 int x = 0;
5610 uschar *p = sub[0];
5611
5612 while (isspace(*p)) p++;
5613 sub[0] = p;
5614
5615 len = Ustrlen(p);
5616 while (len > 0 && isspace(p[len-1])) len--;
5617 p[len] = 0;
5618
93cc2d6e
JH
5619 if (*p == 0)
5620 {
5621 expand_string_message = US"first argument of \"extract\" must "
5622 "not be empty";
5623 goto EXPAND_FAILED;
5624 }
5625
5626 if (*p == '-')
5627 {
5628 field_number = -1;
5629 p++;
5630 }
5631 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5632 if (*p == 0)
82dbd376 5633 {
93cc2d6e
JH
5634 field_number *= x;
5635 j = 3; /* Need 3 args */
5636 field_number_set = TRUE;
82dbd376 5637 }
059ec3d9
PH
5638 }
5639 }
e47376be
JH
5640 else
5641 {
5642 expand_string_message = string_sprintf(
e2e3255a 5643 "missing '{' for arg %d of extract", i+1);
e47376be
JH
5644 goto EXPAND_FAILED_CURLY;
5645 }
059ec3d9
PH
5646 }
5647
5648 /* Extract either the numbered or the keyed substring into $value. If
5649 skipping, just pretend the extraction failed. */
5650
5651 lookup_value = skipping? NULL : field_number_set?
5652 expand_gettokened(field_number, sub[1], sub[2]) :
5653 expand_getkeyed(sub[0], sub[1]);
5654
5655 /* If no string follows, $value gets substituted; otherwise there can
5656 be yes/no strings, as for lookup or if. */
5657
aa26e137
JH
5658 switch(process_yesno(
5659 skipping, /* were previously skipping */
5660 lookup_value != NULL, /* success/failure indicator */
5661 save_lookup_value, /* value to reset for string2 */
5662 &s, /* input pointer */
5663 &yield, /* output pointer */
aa26e137
JH
5664 US"extract", /* condition type */
5665 &resetok))
5666 {
5667 case 1: goto EXPAND_FAILED; /* when all is well, the */
5668 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5669 }
5670
5671 /* All done - restore numerical variables. */
5672
5673 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5674 save_expand_nlength);
5675
5676 continue;
5677 }
5678
5679 /* return the Nth item from a list */
5680
5681 case EITEM_LISTEXTRACT:
5682 {
5683 int i;
5684 int field_number = 1;
5685 uschar *save_lookup_value = lookup_value;
5686 uschar *sub[2];
5687 int save_expand_nmax =
5688 save_expand_strings(save_expand_nstring, save_expand_nlength);
5689
5690 /* Read the field & list arguments */
5691
5692 for (i = 0; i < 2; i++)
5693 {
5694 while (isspace(*s)) s++;
5695 if (*s != '{') /*}*/
e47376be
JH
5696 {
5697 expand_string_message = string_sprintf(
e2e3255a 5698 "missing '{' for arg %d of listextract", i+1);
aa26e137 5699 goto EXPAND_FAILED_CURLY;
e47376be 5700 }
aa26e137
JH
5701
5702 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5703 if (!sub[i]) goto EXPAND_FAILED; /*{*/
e47376be
JH
5704 if (*s++ != '}')
5705 {
5706 expand_string_message = string_sprintf(
e2e3255a 5707 "missing '}' closing arg %d of listextract", i+1);
e47376be
JH
5708 goto EXPAND_FAILED_CURLY;
5709 }
aa26e137
JH
5710
5711 /* After removal of leading and trailing white space, the first
5712 argument must be numeric and nonempty. */
5713
5714 if (i == 0)
5715 {
5716 int len;
5717 int x = 0;
5718 uschar *p = sub[0];
5719
5720 while (isspace(*p)) p++;
5721 sub[0] = p;
5722
5723 len = Ustrlen(p);
5724 while (len > 0 && isspace(p[len-1])) len--;
5725 p[len] = 0;
5726
5727 if (!*p && !skipping)
5728 {
5729 expand_string_message = US"first argument of \"listextract\" must "
5730 "not be empty";
5731 goto EXPAND_FAILED;
5732 }
5733
5734 if (*p == '-')
5735 {
5736 field_number = -1;
5737 p++;
5738 }
5739 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5740 if (*p)
5741 {
5742 expand_string_message = US"first argument of \"listextract\" must "
5743 "be numeric";
5744 goto EXPAND_FAILED;
5745 }
5746 field_number *= x;
5747 }
5748 }
5749
5750 /* Extract the numbered element into $value. If
5751 skipping, just pretend the extraction failed. */
5752
5753 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5754
5755 /* If no string follows, $value gets substituted; otherwise there can
5756 be yes/no strings, as for lookup or if. */
5757
059ec3d9
PH
5758 switch(process_yesno(
5759 skipping, /* were previously skipping */
5760 lookup_value != NULL, /* success/failure indicator */
5761 save_lookup_value, /* value to reset for string2 */
5762 &s, /* input pointer */
5763 &yield, /* output pointer */
f90d49f7 5764 US"listextract", /* condition type */
b0e85a8f 5765 &resetok))
059ec3d9
PH
5766 {
5767 case 1: goto EXPAND_FAILED; /* when all is well, the */
5768 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5769 }
5770
5771 /* All done - restore numerical variables. */
5772
5773 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5774 save_expand_nlength);
5775
5776 continue;
5777 }
1a46a8c5 5778
9d1c15ef
JH
5779#ifdef SUPPORT_TLS
5780 case EITEM_CERTEXTRACT:
5781 {
9d1c15ef
JH
5782 uschar *save_lookup_value = lookup_value;
5783 uschar *sub[2];
5784 int save_expand_nmax =
5785 save_expand_strings(save_expand_nstring, save_expand_nlength);
5786
5787 /* Read the field argument */
5788 while (isspace(*s)) s++;
5789 if (*s != '{') /*}*/
e47376be
JH
5790 {
5791 expand_string_message = US"missing '{' for field arg of certextract";
9d1c15ef 5792 goto EXPAND_FAILED_CURLY;
e47376be 5793 }
9d1c15ef
JH
5794 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5795 if (!sub[0]) goto EXPAND_FAILED; /*{*/
e47376be
JH
5796 if (*s++ != '}')
5797 {
5798 expand_string_message = US"missing '}' closing field arg of certextract";
5799 goto EXPAND_FAILED_CURLY;
5800 }
9d1c15ef
JH
5801 /* strip spaces fore & aft */
5802 {
5803 int len;
9d1c15ef
JH
5804 uschar *p = sub[0];
5805
5806 while (isspace(*p)) p++;
5807 sub[0] = p;
5808
5809 len = Ustrlen(p);
5810 while (len > 0 && isspace(p[len-1])) len--;
5811 p[len] = 0;
5812 }
5813
5814 /* inspect the cert argument */
5815 while (isspace(*s)) s++;
5816 if (*s != '{') /*}*/
e47376be
JH
5817 {
5818 expand_string_message = US"missing '{' for cert variable arg of certextract";
9d1c15ef 5819 goto EXPAND_FAILED_CURLY;
e47376be 5820 }
9d1c15ef
JH
5821 if (*++s != '$')
5822 {
5823 expand_string_message = US"second argument of \"certextract\" must "
5824 "be a certificate variable";
5825 goto EXPAND_FAILED;
5826 }
5827 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5828 if (!sub[1]) goto EXPAND_FAILED; /*{*/
e47376be
JH
5829 if (*s++ != '}')
5830 {
5831 expand_string_message = US"missing '}' closing cert variable arg of certextract";
5832 goto EXPAND_FAILED_CURLY;
5833 }
9d1c15ef
JH
5834
5835 if (skipping)
5836 lookup_value = NULL;
5837 else
5838 {
5839 lookup_value = expand_getcertele(sub[0], sub[1]);
5840 if (*expand_string_message) goto EXPAND_FAILED;
5841 }
5842 switch(process_yesno(
5843 skipping, /* were previously skipping */
5844 lookup_value != NULL, /* success/failure indicator */
5845 save_lookup_value, /* value to reset for string2 */
5846 &s, /* input pointer */
5847 &yield, /* output pointer */
f90d49f7 5848 US"certextract", /* condition type */
9d1c15ef
JH
5849 &resetok))
5850 {
5851 case 1: goto EXPAND_FAILED; /* when all is well, the */
5852 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5853 }
5854
5855 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5856 save_expand_nlength);
5857 continue;
5858 }
5859#endif /*SUPPORT_TLS*/
5860
29f89cad
PH
5861 /* Handle list operations */
5862
5863 case EITEM_FILTER:
5864 case EITEM_MAP:
5865 case EITEM_REDUCE:
5866 {
5867 int sep = 0;
acec9514 5868 int save_ptr = yield->ptr;
29f89cad 5869 uschar outsep[2] = { '\0', '\0' };
55414b25 5870 const uschar *list, *expr, *temp;
29f89cad
PH
5871 uschar *save_iterate_item = iterate_item;
5872 uschar *save_lookup_value = lookup_value;
5873
5874 while (isspace(*s)) s++;
e47376be
JH
5875 if (*s++ != '{')
5876 {
5877 expand_string_message =
5878 string_sprintf("missing '{' for first arg of %s", name);
5879 goto EXPAND_FAILED_CURLY;
5880 }
29f89cad 5881
b0e85a8f 5882 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
29f89cad 5883 if (list == NULL) goto EXPAND_FAILED;
e47376be
JH
5884 if (*s++ != '}')
5885 {
5886 expand_string_message =
5887 string_sprintf("missing '}' closing first arg of %s", name);
5888 goto EXPAND_FAILED_CURLY;
5889 }
29f89cad
PH
5890
5891 if (item_type == EITEM_REDUCE)
5892 {
55414b25 5893 uschar * t;
29f89cad 5894 while (isspace(*s)) s++;
e47376be
JH
5895 if (*s++ != '{')
5896 {
5897 expand_string_message = US"missing '{' for second arg of reduce";
5898 goto EXPAND_FAILED_CURLY;
5899 }
55414b25 5900 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
e1af7642 5901 if (!t) goto EXPAND_FAILED;
55414b25 5902 lookup_value = t;
e47376be
JH
5903 if (*s++ != '}')
5904 {
5905 expand_string_message = US"missing '}' closing second arg of reduce";
5906 goto EXPAND_FAILED_CURLY;
5907 }
29f89cad
PH
5908 }
5909
5910 while (isspace(*s)) s++;
e47376be
JH
5911 if (*s++ != '{')
5912 {
5913 expand_string_message =
5914 string_sprintf("missing '{' for last arg of %s", name);
5915 goto EXPAND_FAILED_CURLY;
5916 }
29f89cad
PH
5917
5918 expr = s;
5919
5920 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5921 if scanning a "false" part). This allows us to find the end of the
5922 condition, because if the list is empty, we won't actually evaluate the
5923 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5924 the normal internal expansion function. */
5925
5926 if (item_type == EITEM_FILTER)
5927 {
b0e85a8f 5928 temp = eval_condition(expr, &resetok, NULL);
29f89cad
PH
5929 if (temp != NULL) s = temp;
5930 }
5931 else
b0e85a8f 5932 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
29f89cad
PH
5933
5934 if (temp == NULL)
5935 {
5936 expand_string_message = string_sprintf("%s inside \"%s\" item",
5937 expand_string_message, name);
5938 goto EXPAND_FAILED;
5939 }
5940
5941 while (isspace(*s)) s++;
5942 if (*s++ != '}')
2e23003a 5943 { /*{*/
29f89cad 5944 expand_string_message = string_sprintf("missing } at end of condition "
d584cdca
JH
5945 "or expression inside \"%s\"; could be an unquoted } in the content",
5946 name);
29f89cad
PH
5947 goto EXPAND_FAILED;
5948 }
5949
2e23003a 5950 while (isspace(*s)) s++; /*{*/
29f89cad 5951 if (*s++ != '}')
2e23003a 5952 { /*{*/
29f89cad
PH
5953 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5954 name);
5955 goto EXPAND_FAILED;
5956 }
5957
5958 /* If we are skipping, we can now just move on to the next item. When
5959 processing for real, we perform the iteration. */
5960
5961 if (skipping) continue;
9e09521e 5962 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
29f89cad
PH
5963 {
5964 *outsep = (uschar)sep; /* Separator as a string */
5965
9e09521e
JH
5966 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
5967 name, iterate_item, lookup_value);
29f89cad
PH
5968
5969 if (item_type == EITEM_FILTER)
5970 {
5971 BOOL condresult;
b0e85a8f 5972 if (eval_condition(expr, &resetok, &condresult) == NULL)
29f89cad 5973 {
e58c13cc
PH
5974 iterate_item = save_iterate_item;
5975 lookup_value = save_lookup_value;
29f89cad
PH
5976 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5977 expand_string_message, name);
5978 goto EXPAND_FAILED;
5979 }
e1d04f48 5980 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
29f89cad
PH
5981 condresult? "true":"false");
5982 if (condresult)
5983 temp = iterate_item; /* TRUE => include this item */
5984 else
5985 continue; /* FALSE => skip this item */
5986 }
5987
5988 /* EITEM_MAP and EITEM_REDUCE */
5989
5990 else
5991 {
55414b25
JH
5992 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5993 temp = t;
29f89cad
PH
5994 if (temp == NULL)
5995 {
e58c13cc 5996 iterate_item = save_iterate_item;
29f89cad
PH
5997 expand_string_message = string_sprintf("%s inside \"%s\" item",
5998 expand_string_message, name);
5999 goto EXPAND_FAILED;
6000 }
6001 if (item_type == EITEM_REDUCE)
6002 {
55414b25 6003 lookup_value = t; /* Update the value of $value */
29f89cad
PH
6004 continue; /* and continue the iteration */
6005 }
6006 }
6007
6008 /* We reach here for FILTER if the condition is true, always for MAP,
6009 and never for REDUCE. The value in "temp" is to be added to the output
6010 list that is being created, ensuring that any occurrences of the
6011 separator character are doubled. Unless we are dealing with the first
6012 item of the output list, add in a space if the new item begins with the
6013 separator character, or is an empty string. */
6014
acec9514
JH
6015 if (yield->ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
6016 yield = string_catn(yield, US" ", 1);
29f89cad
PH
6017
6018 /* Add the string in "temp" to the output list that we are building,
6019 This is done in chunks by searching for the separator character. */
6020
6021 for (;;)
6022 {
6023 size_t seglen = Ustrcspn(temp, outsep);
c2f669a4 6024
acec9514 6025 yield = string_catn(yield, temp, seglen + 1);
29f89cad
PH
6026
6027 /* If we got to the end of the string we output one character
6028 too many; backup and end the loop. Otherwise arrange to double the
6029 separator. */
6030
acec9514
JH
6031 if (temp[seglen] == '\0') { yield->ptr--; break; }
6032 yield = string_catn(yield, outsep, 1);
29f89cad
PH
6033 temp += seglen + 1;
6034 }
6035
6036 /* Output a separator after the string: we will remove the redundant
6037 final one at the end. */
6038
acec9514 6039 yield = string_catn(yield, outsep, 1);
29f89cad
PH
6040 } /* End of iteration over the list loop */
6041
6042 /* REDUCE has generated no output above: output the final value of
6043 $value. */
6044
6045 if (item_type == EITEM_REDUCE)
6046 {
acec9514 6047 yield = string_cat(yield, lookup_value);
29f89cad
PH
6048 lookup_value = save_lookup_value; /* Restore $value */
6049 }
6050
6051 /* FILTER and MAP generate lists: if they have generated anything, remove
6052 the redundant final separator. Even though an empty item at the end of a
6053 list does not count, this is tidier. */
6054
acec9514 6055 else if (yield->ptr != save_ptr) yield->ptr--;
29f89cad
PH
6056
6057 /* Restore preserved $item */
6058
6059 iterate_item = save_iterate_item;
6060 continue;
6061 }
6062
ac4ef9bd
JH
6063 case EITEM_SORT:
6064 {
6065 int sep = 0;
55414b25 6066 const uschar *srclist, *cmp, *xtract;
ac4ef9bd 6067 uschar *srcitem;
55414b25 6068 const uschar *dstlist = NULL, *dstkeylist = NULL;
ac4ef9bd
JH
6069 uschar * tmp;
6070 uschar *save_iterate_item = iterate_item;
6071
6072 while (isspace(*s)) s++;
e47376be
JH
6073 if (*s++ != '{')
6074 {
6075 expand_string_message = US"missing '{' for list arg of sort";
6076 goto EXPAND_FAILED_CURLY;
6077 }
ac4ef9bd
JH
6078
6079 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6080 if (!srclist) goto EXPAND_FAILED;
e47376be
JH
6081 if (*s++ != '}')
6082 {
6083 expand_string_message = US"missing '}' closing list arg of sort";
6084 goto EXPAND_FAILED_CURLY;
6085 }
ac4ef9bd
JH
6086
6087 while (isspace(*s)) s++;
e47376be
JH
6088 if (*s++ != '{')
6089 {
6090 expand_string_message = US"missing '{' for comparator arg of sort";
6091 goto EXPAND_FAILED_CURLY;
6092 }
ac4ef9bd
JH
6093
6094 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6095 if (!cmp) goto EXPAND_FAILED;
e47376be
JH
6096 if (*s++ != '}')
6097 {
6098 expand_string_message = US"missing '}' closing comparator arg of sort";
6099 goto EXPAND_FAILED_CURLY;
6100 }
ac4ef9bd
JH
6101
6102 while (isspace(*s)) s++;
e47376be
JH
6103 if (*s++ != '{')
6104 {
6105 expand_string_message = US"missing '{' for extractor arg of sort";
6106 goto EXPAND_FAILED_CURLY;
6107 }
ac4ef9bd
JH
6108
6109 xtract = s;
6110 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6111 if (!tmp) goto EXPAND_FAILED;
6112 xtract = string_copyn(xtract, s - xtract);
6113
e47376be
JH
6114 if (*s++ != '}')
6115 {
6116 expand_string_message = US"missing '}' closing extractor arg of sort";
6117 goto EXPAND_FAILED_CURLY;
6118 }
ac4ef9bd
JH
6119 /*{*/
6120 if (*s++ != '}')
6121 { /*{*/
6122 expand_string_message = US"missing } at end of \"sort\"";
6123 goto EXPAND_FAILED;
6124 }
6125
6126 if (skipping) continue;
6127
6128 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6129 {
6130 uschar * dstitem;
acec9514
JH
6131 gstring * newlist = NULL;
6132 gstring * newkeylist = NULL;
ac4ef9bd
JH
6133 uschar * srcfield;
6134
e1d04f48 6135 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
ac4ef9bd
JH
6136
6137 /* extract field for comparisons */
6138 iterate_item = srcitem;
6139 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6140 TRUE, &resetok))
6141 || !*srcfield)
6142 {
6143 expand_string_message = string_sprintf(
6144 "field-extract in sort: \"%s\"", xtract);
6145 goto EXPAND_FAILED;
6146 }
6147
6148 /* Insertion sort */
6149
6150 /* copy output list until new-item < list-item */
6151 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6152 {
6153 uschar * dstfield;
6154 uschar * expr;
6155 BOOL before;
6156
6157 /* field for comparison */
6158 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6159 goto sort_mismatch;
6160
6161 /* build and run condition string */
6162 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
6163
e1d04f48 6164 DEBUG(D_expand) debug_printf_indent("%s: cond = \"%s\"\n", name, expr);
ac4ef9bd
JH
6165 if (!eval_condition(expr, &resetok, &before))
6166 {
6167 expand_string_message = string_sprintf("comparison in sort: %s",
6168 expr);
6169 goto EXPAND_FAILED;
6170 }
6171
6172 if (before)
6173 {
6174 /* New-item sorts before this dst-item. Append new-item,
6175 then dst-item, then remainder of dst list. */
6176
acec9514
JH
6177 newlist = string_append_listele(newlist, sep, srcitem);
6178 newkeylist = string_append_listele(newkeylist, sep, srcfield);
ac4ef9bd
JH
6179 srcitem = NULL;
6180
acec9514
JH
6181 newlist = string_append_listele(newlist, sep, dstitem);
6182 newkeylist = string_append_listele(newkeylist, sep, dstfield);
ac4ef9bd
JH
6183
6184 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6185 {
6186 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6187 goto sort_mismatch;
acec9514
JH
6188 newlist = string_append_listele(newlist, sep, dstitem);
6189 newkeylist = string_append_listele(newkeylist, sep, dstfield);
ac4ef9bd
JH
6190 }
6191
6192 break;
6193 }
6194
acec9514
JH
6195 newlist = string_append_listele(newlist, sep, dstitem);
6196 newkeylist = string_append_listele(newkeylist, sep, dstfield);
ac4ef9bd
JH
6197 }
6198
6199 /* If we ran out of dstlist without consuming srcitem, append it */
6200 if (srcitem)
6201 {
acec9514
JH
6202 newlist = string_append_listele(newlist, sep, srcitem);
6203 newkeylist = string_append_listele(newkeylist, sep, srcfield);
ac4ef9bd
JH
6204 }
6205
acec9514
JH
6206 dstlist = newlist->s;
6207 dstkeylist = newkeylist->s;
ac4ef9bd 6208
e1d04f48
JH
6209 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6210 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
ac4ef9bd
JH
6211 }
6212
6213 if (dstlist)
acec9514 6214 yield = string_cat(yield, dstlist);
ac4ef9bd
JH
6215
6216 /* Restore preserved $item */
6217 iterate_item = save_iterate_item;
6218 continue;
6219
6220 sort_mismatch:
6221 expand_string_message = US"Internal error in sort (list mismatch)";
6222 goto EXPAND_FAILED;
6223 }
6224
29f89cad 6225
2e23003a 6226 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
1a46a8c5
PH
6227 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6228 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6229 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6230
6231 #define EXPAND_DLFUNC_MAX_ARGS 8
6232
6233 case EITEM_DLFUNC:
089fc87a
JH
6234#ifndef EXPAND_DLFUNC
6235 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6236 "is not included in this binary";
6237 goto EXPAND_FAILED;
1a46a8c5 6238
089fc87a 6239#else /* EXPAND_DLFUNC */
1a46a8c5
PH
6240 {
6241 tree_node *t;
6242 exim_dlfunc_t *func;
6243 uschar *result;
6244 int status, argc;
6245 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6246
6247 if ((expand_forbid & RDO_DLFUNC) != 0)
6248 {
6249 expand_string_message =
6250 US"dynamically-loaded functions are not permitted";
6251 goto EXPAND_FAILED;
6252 }
6253
6254 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
b0e85a8f 6255 TRUE, US"dlfunc", &resetok))
1a46a8c5
PH
6256 {
6257 case 1: goto EXPAND_FAILED_CURLY;
6258 case 2:
6259 case 3: goto EXPAND_FAILED;
6260 }
6261
6262 /* If skipping, we don't actually do anything */
6263
6264 if (skipping) continue;
6265
6266 /* Look up the dynamically loaded object handle in the tree. If it isn't
6267 found, dlopen() the file and put the handle in the tree for next time. */
6268
6269 t = tree_search(dlobj_anchor, argv[0]);
6270 if (t == NULL)
6271 {
6272 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6273 if (handle == NULL)
6274 {
6275 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6276 argv[0], dlerror());
6277 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6278 goto EXPAND_FAILED;
6279 }
6280 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6281 Ustrcpy(t->name, argv[0]);
6282 t->data.ptr = handle;
6283 (void)tree_insertnode(&dlobj_anchor, t);
6284 }
6285
6286 /* Having obtained the dynamically loaded object handle, look up the
6287 function pointer. */
6288
6289 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6290 if (func == NULL)
6291 {
6292 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6293 "%s", argv[1], argv[0], dlerror());
7dbf77c9 6294 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
1a46a8c5
PH
6295 goto EXPAND_FAILED;
6296 }
6297
6298 /* Call the function and work out what to do with the result. If it
6299 returns OK, we have a replacement string; if it returns DEFER then
6300 expansion has failed in a non-forced manner; if it returns FAIL then
6301 failure was forced; if it returns ERROR or any other value there's a
d6b4d938
TF
6302 problem, so panic slightly. In any case, assume that the function has
6303 side-effects on the store that must be preserved. */
1a46a8c5 6304
d6b4d938 6305 resetok = FALSE;
1a46a8c5
PH
6306 result = NULL;
6307 for (argc = 0; argv[argc] != NULL; argc++);
6308 status = func(&result, argc - 2, &argv[2]);
6309 if(status == OK)
6310 {
6311 if (result == NULL) result = US"";
acec9514 6312 yield = string_cat(yield, result);
1a46a8c5
PH
6313 continue;
6314 }
6315 else
6316 {
6317 expand_string_message = result == NULL ? US"(no message)" : result;
6318 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
6319 else if(status != FAIL)
6320 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6321 argv[0], argv[1], status, expand_string_message);
6322 goto EXPAND_FAILED;
6323 }
6324 }
089fc87a
JH
6325#endif /* EXPAND_DLFUNC */
6326
6327 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6328 {
6329 uschar * key;
6330 uschar *save_lookup_value = lookup_value;
6331
6332 while (isspace(*s)) s++;
6333 if (*s != '{') /*}*/
6334 goto EXPAND_FAILED;
6335
6336 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6337 if (!key) goto EXPAND_FAILED; /*{*/
e47376be
JH
6338 if (*s++ != '}')
6339 {
6340 expand_string_message = US"missing '{' for name arg of env";
6341 goto EXPAND_FAILED_CURLY;
6342 }
089fc87a
JH
6343
6344 lookup_value = US getenv(CS key);
6345
6346 switch(process_yesno(
6347 skipping, /* were previously skipping */
6348 lookup_value != NULL, /* success/failure indicator */
6349 save_lookup_value, /* value to reset for string2 */
6350 &s, /* input pointer */
6351 &yield, /* output pointer */
089fc87a
JH
6352 US"env", /* condition type */
6353 &resetok))
6354 {
6355 case 1: goto EXPAND_FAILED; /* when all is well, the */
6356 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6357 }
6358 continue;
6359 }
2e23003a 6360 } /* EITEM_* switch */
059ec3d9
PH
6361
6362 /* Control reaches here if the name is not recognized as one of the more
6363 complicated expansion items. Check for the "operator" syntax (name terminated
6364 by a colon). Some of the operators have arguments, separated by _ from the
6365 name. */
6366
6367 if (*s == ':')
6368 {
6369 int c;
6370 uschar *arg = NULL;
6a8a60e0 6371 uschar *sub;
e3dd1d67 6372 var_entry *vp = NULL;
059ec3d9
PH
6373
6374 /* Owing to an historical mis-design, an underscore may be part of the
6375 operator name, or it may introduce arguments. We therefore first scan the
6376 table of names that contain underscores. If there is no match, we cut off
6377 the arguments and then scan the main table. */
6378
6a8a60e0 6379 if ((c = chop_match(name, op_table_underscore,
0539a19d 6380 nelem(op_table_underscore))) < 0)
059ec3d9
PH
6381 {
6382 arg = Ustrchr(name, '_');
6383 if (arg != NULL) *arg = 0;
0539a19d
JH
6384 c = chop_match(name, op_table_main, nelem(op_table_main));
6385 if (c >= 0) c += nelem(op_table_underscore);
059ec3d9
PH
6386 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6387 }
6388
6a8a60e0
JH
6389 /* Deal specially with operators that might take a certificate variable
6390 as we do not want to do the usual expansion. For most, expand the string.*/
6391 switch(c)
6392 {
80c974f8 6393#ifdef SUPPORT_TLS
6a8a60e0 6394 case EOP_MD5:
9ef9101c
JH
6395 case EOP_SHA1:
6396 case EOP_SHA256:
59b87190 6397 case EOP_BASE64:
6a8a60e0
JH
6398 if (s[1] == '$')
6399 {
55414b25 6400 const uschar * s1 = s;
6a8a60e0
JH
6401 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6402 FALSE, &resetok);
6403 if (!sub) goto EXPAND_FAILED; /*{*/
e47376be
JH
6404 if (*s1 != '}')
6405 {
6406 expand_string_message =
6407 string_sprintf("missing '}' closing cert arg of %s", name);
6408 goto EXPAND_FAILED_CURLY;
6409 }
6a8a60e0
JH
6410 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6411 {
6412 s = s1+1;
6413 break;
6414 }
fabe4dd9 6415 vp = NULL;
6a8a60e0 6416 }
6a8a60e0 6417 /*FALLTHROUGH*/
80c974f8 6418#endif
6a8a60e0
JH
6419 default:
6420 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6421 if (!sub) goto EXPAND_FAILED;
6422 s++;
6423 break;
6424 }
6425
059ec3d9
PH
6426 /* If we are skipping, we don't need to perform the operation at all.
6427 This matters for operations like "mask", because the data may not be
6428 in the correct format when skipping. For example, the expression may test
6429 for the existence of $sender_host_address before trying to mask it. For
6430 other operations, doing them may not fail, but it is a waste of time. */
6431
6432 if (skipping && c >= 0) continue;
6433
6434 /* Otherwise, switch on the operator type */
6435
6436 switch(c)
6437 {
03ca21f8
JH
6438 case EOP_BASE32:
6439 {
6440 uschar *t;
6441 unsigned long int n = Ustrtoul(sub, &t, 10);
acec9514 6442 gstring * g = NULL;
03ca21f8
JH
6443
6444 if (*t != 0)
6445 {
6446 expand_string_message = string_sprintf("argument for base32 "
6447 "operator is \"%s\", which is not a decimal number", sub);
6448 goto EXPAND_FAILED;
6449 }
6450 for ( ; n; n >>= 5)
acec9514 6451 g = string_catn(g, &base32_chars[n & 0x1f], 1);
03ca21f8 6452
acec9514 6453 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
03ca21f8
JH
6454 continue;
6455 }
6456
6457 case EOP_BASE32D:
6458 {
6459 uschar *tt = sub;
6460 unsigned long int n = 0;
6461 uschar * s;
6462 while (*tt)
6463 {
6464 uschar * t = Ustrchr(base32_chars, *tt++);
6465 if (t == NULL)
6466 {
6467 expand_string_message = string_sprintf("argument for base32d "
6468 "operator is \"%s\", which is not a base 32 number", sub);
6469 goto EXPAND_FAILED;
6470 }
6471 n = n * 32 + (t - base32_chars);
6472 }
6473 s = string_sprintf("%ld", n);
acec9514 6474 yield = string_cat(yield, s);
03ca21f8
JH
6475 continue;
6476 }
6477
059ec3d9
PH
6478 case EOP_BASE62:
6479 {
6480 uschar *t;
6481 unsigned long int n = Ustrtoul(sub, &t, 10);
6482 if (*t != 0)
6483 {
6484 expand_string_message = string_sprintf("argument for base62 "
6485 "operator is \"%s\", which is not a decimal number", sub);
6486 goto EXPAND_FAILED;
6487 }
6488 t = string_base62(n);
acec9514 6489 yield = string_cat(yield, t);
059ec3d9
PH
6490 continue;
6491 }
6492
9a799bc0
PH
6493 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6494
059ec3d9
PH
6495 case EOP_BASE62D:
6496 {
6497 uschar buf[16];
6498 uschar *tt = sub;
6499 unsigned long int n = 0;
6500 while (*tt != 0)
6501 {
6502 uschar *t = Ustrchr(base62_chars, *tt++);
6503 if (t == NULL)
6504 {
6505 expand_string_message = string_sprintf("argument for base62d "
9a799bc0
PH
6506 "operator is \"%s\", which is not a base %d number", sub,
6507 BASE_62);
059ec3d9
PH
6508 goto EXPAND_FAILED;
6509 }
9a799bc0 6510 n = n * BASE_62 + (t - base62_chars);
059ec3d9
PH
6511 }
6512 (void)sprintf(CS buf, "%ld", n);
acec9514 6513 yield = string_cat(yield, buf);
059ec3d9
PH
6514 continue;
6515 }
6516
6517 case EOP_EXPAND:
6518 {
b0e85a8f 6519 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
059ec3d9
PH
6520 if (expanded == NULL)
6521 {
6522 expand_string_message =
6523 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6524 expand_string_message);
6525 goto EXPAND_FAILED;
6526 }
acec9514 6527 yield = string_cat(yield, expanded);
059ec3d9
PH
6528 continue;
6529 }
6530
6531 case EOP_LC:
6532 {
6533 int count = 0;
6534 uschar *t = sub - 1;
6535 while (*(++t) != 0) { *t = tolower(*t); count++; }
acec9514 6536 yield = string_catn(yield, sub, count);
059ec3d9
PH
6537 continue;
6538 }
6539
6540 case EOP_UC:
6541 {
6542 int count = 0;
6543 uschar *t = sub - 1;
6544 while (*(++t) != 0) { *t = toupper(*t); count++; }
acec9514 6545 yield = string_catn(yield, sub, count);
059ec3d9
PH
6546 continue;
6547 }
6548
6549 case EOP_MD5:
80c974f8 6550#ifdef SUPPORT_TLS
6a8a60e0
JH
6551 if (vp && *(void **)vp->value)
6552 {
6553 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
acec9514 6554 yield = string_cat(yield, cp);
6a8a60e0
JH
6555 }
6556 else
80c974f8 6557#endif
6a8a60e0
JH
6558 {
6559 md5 base;
6560 uschar digest[16];
6561 int j;
6562 char st[33];
6563 md5_start(&base);
6564 md5_end(&base, sub, Ustrlen(sub), digest);
6565 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
acec9514 6566 yield = string_cat(yield, US st);
6a8a60e0 6567 }
059ec3d9 6568 continue;
059ec3d9
PH
6569
6570 case EOP_SHA1:
80c974f8 6571#ifdef SUPPORT_TLS
6a8a60e0
JH
6572 if (vp && *(void **)vp->value)
6573 {
6574 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
acec9514 6575 yield = string_cat(yield, cp);
6a8a60e0
JH
6576 }
6577 else
80c974f8 6578#endif
6a8a60e0 6579 {
5fb822fc 6580 hctx h;
6a8a60e0
JH
6581 uschar digest[20];
6582 int j;
6583 char st[41];
5fb822fc
JH
6584 sha1_start(&h);
6585 sha1_end(&h, sub, Ustrlen(sub), digest);
6a8a60e0 6586 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
acec9514 6587 yield = string_catn(yield, US st, 40);
6a8a60e0 6588 }
059ec3d9 6589 continue;
059ec3d9 6590
9ef9101c 6591 case EOP_SHA256:
6e773413 6592#ifdef EXIM_HAVE_SHA2
9ef9101c
JH
6593 if (vp && *(void **)vp->value)
6594 {
6595 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
acec9514 6596 yield = string_cat(yield, cp);
9ef9101c
JH
6597 }
6598 else
cfab9d68
JH
6599 {
6600 hctx h;
6601 blob b;
6602 char st[3];
6603
d73e45df 6604 if (!exim_sha_init(&h, HASH_SHA2_256))
7b83389d
JH
6605 {
6606 expand_string_message = US"unrecognised sha256 variant";
6607 goto EXPAND_FAILED;
6608 }
cfab9d68
JH
6609 exim_sha_update(&h, sub, Ustrlen(sub));
6610 exim_sha_finish(&h, &b);
6611 while (b.len-- > 0)
6612 {
6613 sprintf(st, "%02X", *b.data++);
acec9514 6614 yield = string_catn(yield, US st, 2);
cfab9d68
JH
6615 }
6616 }
6617#else
6618 expand_string_message = US"sha256 only supported with TLS";
9ef9101c 6619#endif
9ef9101c
JH
6620 continue;
6621
6e773413
JH
6622 case EOP_SHA3:
6623#ifdef EXIM_HAVE_SHA3
6624 {
6625 hctx h;
6626 blob b;
6627 char st[3];
6628 hashmethod m = !arg ? HASH_SHA3_256
6629 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6630 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6631 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6632 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6633 : HASH_BADTYPE;
6634
7b83389d 6635 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6e773413
JH
6636 {
6637 expand_string_message = US"unrecognised sha3 variant";
6638 goto EXPAND_FAILED;
6639 }
6640
6e773413
JH
6641 exim_sha_update(&h, sub, Ustrlen(sub));
6642 exim_sha_finish(&h, &b);
6643 while (b.len-- > 0)
6644 {
6645 sprintf(st, "%02X", *b.data++);
acec9514 6646 yield = string_catn(yield, US st, 2);
6e773413
JH
6647 }
6648 }
6649 continue;
6650#else
9c29c48f 6651 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
6e773413
JH
6652 goto EXPAND_FAILED;
6653#endif
6654
059ec3d9
PH
6655 /* Convert hex encoding to base64 encoding */
6656
6657 case EOP_HEX2B64:
6658 {
6659 int c = 0;
6660 int b = -1;
6661 uschar *in = sub;
6662 uschar *out = sub;
6663 uschar *enc;
6664
6665 for (enc = sub; *enc != 0; enc++)
6666 {
6667 if (!isxdigit(*enc))
6668 {
6669 expand_string_message = string_sprintf("\"%s\" is not a hex "
6670 "string", sub);
6671 goto EXPAND_FAILED;
6672 }
6673 c++;
6674 }
6675
6676 if ((c & 1) != 0)
6677 {
6678 expand_string_message = string_sprintf("\"%s\" contains an odd "
6679 "number of characters", sub);
6680 goto EXPAND_FAILED;
6681 }
6682
6683 while ((c = *in++) != 0)
6684 {
6685 if (isdigit(c)) c -= '0';
6686 else c = toupper(c) - 'A' + 10;
6687 if (b == -1)
6688 {
6689 b = c << 4;
6690 }
6691 else
6692 {
6693 *out++ = b | c;
6694 b = -1;
6695 }
6696 }
6697
f4d091fb 6698 enc = b64encode(sub, out - sub);
acec9514 6699 yield = string_cat(yield, enc);
059ec3d9
PH
6700 continue;
6701 }
6702
c393f931
TF
6703 /* Convert octets outside 0x21..0x7E to \xXX form */
6704
6705 case EOP_HEXQUOTE:
6706 {
6707 uschar *t = sub - 1;
6708 while (*(++t) != 0)
6709 {
6710 if (*t < 0x21 || 0x7E < *t)
acec9514 6711 yield = string_catn(yield, string_sprintf("\\x%02x", *t), 4);
c393f931 6712 else
acec9514 6713 yield = string_catn(yield, t, 1);
c393f931
TF
6714 }
6715 continue;
6716 }
6717
a64a3dfa
JH
6718 /* count the number of list elements */
6719
6720 case EOP_LISTCOUNT:
6721 {
6722 int cnt = 0;
6723 int sep = 0;
6724 uschar * cp;
6725 uschar buffer[256];
6726
55414b25 6727 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
a64a3dfa 6728 cp = string_sprintf("%d", cnt);
acec9514 6729 yield = string_cat(yield, cp);
a64a3dfa
JH
6730 continue;
6731 }
6732
042eb971 6733 /* expand a named list given the name */
a64a3dfa 6734 /* handles nested named lists; requotes as colon-sep list */
042eb971 6735
a64a3dfa 6736 case EOP_LISTNAMED:
042eb971
JH
6737 {
6738 tree_node *t = NULL;
55414b25 6739 const uschar * list;
042eb971
JH
6740 int sep = 0;
6741 uschar * item;
6d9cfc47 6742 uschar * suffix = US"";
042eb971
JH
6743 BOOL needsep = FALSE;
6744 uschar buffer[256];
6745
6746 if (*sub == '+') sub++;
6747 if (arg == NULL) /* no-argument version */
6748 {
6749 if (!(t = tree_search(addresslist_anchor, sub)) &&
6750 !(t = tree_search(domainlist_anchor, sub)) &&
6751 !(t = tree_search(hostlist_anchor, sub)))
6752 t = tree_search(localpartlist_anchor, sub);
6753 }
6754 else switch(*arg) /* specific list-type version */
6755 {
6d9cfc47
JH
6756 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6757 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6758 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6759 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
042eb971
JH
6760 default:
6761 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6762 goto EXPAND_FAILED;
6763 }
6764
6765 if(!t)
6766 {
6767 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6768 sub, !arg?""
6769 : *arg=='a'?"address "
6770 : *arg=='d'?"domain "
6771 : *arg=='h'?"host "
6772 : *arg=='l'?"localpart "
6773 : 0);
6774 goto EXPAND_FAILED;
6775 }
6776
042eb971
JH
6777 list = ((namedlist_block *)(t->data.ptr))->string;
6778
acec9514 6779 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
042eb971
JH
6780 {
6781 uschar * buf = US" : ";
6782 if (needsep)
acec9514 6783 yield = string_catn(yield, buf, 3);
042eb971
JH
6784 else
6785 needsep = TRUE;
6786
6787 if (*item == '+') /* list item is itself a named list */
6788 {
a64a3dfa 6789 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
b0e85a8f 6790 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
042eb971
JH
6791 }
6792 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6793 {
6794 char * cp;
6795 char tok[3];
6796 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
5903c6ff 6797 while ((cp= strpbrk(CCS item, tok)))
042eb971 6798 {
acec9514 6799 yield = string_catn(yield, item, cp - CS item);
042eb971
JH
6800 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6801 {
acec9514 6802 yield = string_catn(yield, US"::", 2);
5903c6ff 6803 item = US cp;
042eb971
JH
6804 }
6805 else /* sep in item; should already be doubled; emit once */
6806 {
acec9514 6807 yield = string_catn(yield, US tok, 1);
042eb971 6808 if (*cp == sep) cp++;
5903c6ff 6809 item = US cp;
042eb971
JH
6810 }
6811 }
6812 }
acec9514 6813 yield = string_cat(yield, item);
042eb971
JH
6814 }
6815 continue;
6816 }
6817
059ec3d9
PH
6818 /* mask applies a mask to an IP address; for example the result of
6819 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6820
6821 case EOP_MASK:
6822 {
6823 int count;
6824 uschar *endptr;
6825 int binary[4];
6826 int mask, maskoffset;
6827 int type = string_is_ip_address(sub, &maskoffset);
6828 uschar buffer[64];
6829
6830 if (type == 0)
6831 {
6832 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6833 sub);
6834 goto EXPAND_FAILED;
6835 }
6836
6837 if (maskoffset == 0)
6838 {
6839 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6840 sub);
6841 goto EXPAND_FAILED;
6842 }
6843
6844 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6845
6846 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6847 {
6848 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6849 sub);
6850 goto EXPAND_FAILED;
6851 }
6852
6853 /* Convert the address to binary integer(s) and apply the mask */
6854
6855 sub[maskoffset] = 0;
6856 count = host_aton(sub, binary);
6857 host_mask(count, binary, mask);
6858
6859 /* Convert to masked textual format and add to output. */
6860
acec9514 6861 yield = string_catn(yield, buffer,
6f0c9a4f 6862 host_nmtoa(count, binary, mask, buffer, '.'));
059ec3d9
PH
6863 continue;
6864 }
6865
fc4a7f70
JH
6866 case EOP_IPV6NORM:
6867 case EOP_IPV6DENORM:
6868 {
6869 int type = string_is_ip_address(sub, NULL);
6870 int binary[4];
6871 uschar buffer[44];
6872
6873 switch (type)
6874 {
6875 case 6:
6876 (void) host_aton(sub, binary);
6877 break;
6878
6879 case 4: /* convert to IPv4-mapped IPv6 */
6880 binary[0] = binary[1] = 0;
6881 binary[2] = 0x0000ffff;
6882 (void) host_aton(sub, binary+3);
6883 break;
6884
6885 case 0:
6886 expand_string_message =
6887 string_sprintf("\"%s\" is not an IP address", sub);
6888 goto EXPAND_FAILED;
6889 }
6890
acec9514 6891 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
fc4a7f70
JH
6892 ? ipv6_nmtoa(binary, buffer)
6893 : host_nmtoa(4, binary, -1, buffer, ':')
6894 );
6895 continue;
6896 }
6897
059ec3d9
PH
6898 case EOP_ADDRESS:
6899 case EOP_LOCAL_PART:
6900 case EOP_DOMAIN:
6901 {
2c0f3ea1 6902 uschar * error;
059ec3d9 6903 int start, end, domain;
2c0f3ea1 6904 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
059ec3d9 6905 FALSE);
2c0f3ea1 6906 if (t)
059ec3d9
PH
6907 if (c != EOP_DOMAIN)
6908 {
6909 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
acec9514 6910 yield = string_catn(yield, sub+start, end-start);
059ec3d9
PH
6911 }
6912 else if (domain != 0)
6913 {
6914 domain += start;
acec9514 6915 yield = string_catn(yield, sub+domain, end-domain);
059ec3d9 6916 }
059ec3d9
PH
6917 continue;
6918 }
6919
29f89cad
PH
6920 case EOP_ADDRESSES:
6921 {
6922 uschar outsep[2] = { ':', '\0' };
6923 uschar *address, *error;
acec9514 6924 int save_ptr = yield->ptr;
29f89cad
PH
6925 int start, end, domain; /* Not really used */
6926
6927 while (isspace(*sub)) sub++;
1b7cf216
HSHR
6928 if (*sub == '>')
6929 if (*outsep = *++sub) ++sub;
5bfe3b35
JH
6930 else
6931 {
1b7cf216
HSHR
6932 expand_string_message = string_sprintf("output separator "
6933 "missing in expanding ${addresses:%s}", --sub);
6934 goto EXPAND_FAILED;
5bfe3b35 6935 }
29f89cad
PH
6936 parse_allow_group = TRUE;
6937
6938 for (;;)
6939 {
6940 uschar *p = parse_find_address_end(sub, FALSE);
6941 uschar saveend = *p;
6942 *p = '\0';
6943 address = parse_extract_address(sub, &error, &start, &end, &domain,
6944 FALSE);
6945 *p = saveend;
6946
6947 /* Add the address to the output list that we are building. This is
6948 done in chunks by searching for the separator character. At the
6949 start, unless we are dealing with the first address of the output
6950 list, add in a space if the new address begins with the separator
6951 character, or is an empty string. */
6952
6953 if (address != NULL)
6954 {
acec9514
JH
6955 if (yield->ptr != save_ptr && address[0] == *outsep)
6956 yield = string_catn(yield, US" ", 1);
29f89cad
PH
6957
6958 for (;;)
6959 {
6960 size_t seglen = Ustrcspn(address, outsep);
acec9514 6961 yield = string_catn(yield, address, seglen + 1);
29f89cad
PH
6962
6963 /* If we got to the end of the string we output one character
6964 too many. */
6965
acec9514
JH
6966 if (address[seglen] == '\0') { yield->ptr--; break; }
6967 yield = string_catn(yield, outsep, 1);
29f89cad
PH
6968 address += seglen + 1;
6969 }
6970
6971 /* Output a separator after the string: we will remove the
6972 redundant final one at the end. */
6973
acec9514 6974 yield = string_catn(yield, outsep, 1);
29f89cad
PH
6975 }
6976
6977 if (saveend == '\0') break;
6978 sub = p + 1;
6979 }
6980
6981 /* If we have generated anything, remove the redundant final
6982 separator. */
6983
acec9514 6984 if (yield->ptr != save_ptr) yield->ptr--;
29f89cad
PH
6985 parse_allow_group = FALSE;
6986 continue;
6987 }
6988
6989
059ec3d9
PH
6990 /* quote puts a string in quotes if it is empty or contains anything
6991 other than alphamerics, underscore, dot, or hyphen.
6992
6993 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6994 be quoted in order to be a valid local part.
6995
6996 In both cases, newlines and carriage returns are converted into \n and \r
6997 respectively */
6998
6999 case EOP_QUOTE:
7000 case EOP_QUOTE_LOCAL_PART:
7001 if (arg == NULL)
7002 {
7003 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
7004 uschar *t = sub - 1;
7005
7006 if (c == EOP_QUOTE)
7007 {
7008 while (!needs_quote && *(++t) != 0)
7009 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7010 }
7011 else /* EOP_QUOTE_LOCAL_PART */
7012 {
7013 while (!needs_quote && *(++t) != 0)
7014 needs_quote = !isalnum(*t) &&
7015 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
7016 (*t != '.' || t == sub || t[1] == 0);
7017 }
7018
7019 if (needs_quote)
7020 {
acec9514 7021 yield = string_catn(yield, US"\"", 1);
059ec3d9
PH
7022 t = sub - 1;
7023 while (*(++t) != 0)
7024 {
7025 if (*t == '\n')
acec9514 7026 yield = string_catn(yield, US"\\n", 2);
059ec3d9 7027 else if (*t == '\r')
acec9514 7028 yield = string_catn(yield, US"\\r", 2);
059ec3d9
PH
7029 else
7030 {
7031 if (*t == '\\' || *t == '"')
acec9514
JH
7032 yield = string_catn(yield, US"\\", 1);
7033 yield = string_catn(yield, t, 1);
059ec3d9
PH
7034 }
7035 }
acec9514 7036 yield = string_catn(yield, US"\"", 1);
059ec3d9 7037 }
acec9514 7038 else yield = string_cat(yield, sub);
059ec3d9
PH
7039 continue;
7040 }
7041
7042 /* quote_lookuptype does lookup-specific quoting */
7043
7044 else
7045 {
7046 int n;
7047 uschar *opt = Ustrchr(arg, '_');
7048
7049 if (opt != NULL) *opt++ = 0;
7050
7051 n = search_findtype(arg, Ustrlen(arg));
7052 if (n < 0)
7053 {
7054 expand_string_message = search_error_message;
7055 goto EXPAND_FAILED;
7056 }
7057
e6d225ae
DW
7058 if (lookup_list[n]->quote != NULL)
7059 sub = (lookup_list[n]->quote)(sub, opt);
059ec3d9
PH
7060 else if (opt != NULL) sub = NULL;
7061
7062 if (sub == NULL)
7063 {
7064 expand_string_message = string_sprintf(
7065 "\"%s\" unrecognized after \"${quote_%s\"",
7066 opt, arg);
7067 goto EXPAND_FAILED;
7068 }
7069
acec9514 7070 yield = string_cat(yield, sub);
059ec3d9
PH
7071 continue;
7072 }
7073
7074 /* rx quote sticks in \ before any non-alphameric character so that
7075 the insertion works in a regular expression. */
7076
7077 case EOP_RXQUOTE:
7078 {
7079 uschar *t = sub - 1;
7080 while (*(++t) != 0)
7081 {
7082 if (!isalnum(*t))
acec9514
JH
7083 yield = string_catn(yield, US"\\", 1);
7084 yield = string_catn(yield, t, 1);
059ec3d9
PH
7085 }
7086 continue;
7087 }
7088
7089 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7090 prescribed by the RFC, if there are characters that need to be encoded */
7091
7092 case EOP_RFC2047:
7093 {
14702f5b 7094 uschar buffer[2048];
55414b25 7095 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
46218253 7096 buffer, sizeof(buffer), FALSE);
acec9514 7097 yield = string_cat(yield, string);
059ec3d9
PH
7098 continue;
7099 }
7100
9c57cbc0
PH
7101 /* RFC 2047 decode */
7102
7103 case EOP_RFC2047D:
7104 {
7105 int len;
7106 uschar *error;
7107 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7108 headers_charset, '?', &len, &error);
7109 if (error != NULL)
7110 {
7111 expand_string_message = error;
7112 goto EXPAND_FAILED;
7113 }
acec9514 7114 yield = string_catn(yield, decoded, len);
9c57cbc0
PH
7115 continue;
7116 }
7117
059ec3d9
PH
7118 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7119 underscores */
7120
7121 case EOP_FROM_UTF8:
7122 {
7123 while (*sub != 0)
7124 {
7125 int c;
7126 uschar buff[4];
7127 GETUTF8INC(c, sub);
7128 if (c > 255) c = '_';
7129 buff[0] = c;
acec9514 7130 yield = string_catn(yield, buff, 1);
059ec3d9
PH
7131 }
7132 continue;
7133 }
7134
b9c2e32f 7135 /* replace illegal UTF-8 sequences by replacement character */
94431adb 7136
b9c2e32f
AR
7137 #define UTF8_REPLACEMENT_CHAR US"?"
7138
7139 case EOP_UTF8CLEAN:
7140 {
85098ee7 7141 int seq_len = 0, index = 0;
e3dd1d67 7142 int bytes_left = 0;
e8e86723 7143 long codepoint = -1;
b9c2e32f 7144 uschar seq_buff[4]; /* accumulate utf-8 here */
94431adb 7145
b9c2e32f
AR
7146 while (*sub != 0)
7147 {
e8e86723
JH
7148 int complete = 0;
7149 uschar c = *sub++;
b9c2e32f 7150
e3dd1d67 7151 if (bytes_left)
b9c2e32f
AR
7152 {
7153 if ((c & 0xc0) != 0x80)
b9c2e32f
AR
7154 /* wrong continuation byte; invalidate all bytes */
7155 complete = 1; /* error */
b9c2e32f
AR
7156 else
7157 {
7158 codepoint = (codepoint << 6) | (c & 0x3f);
7159 seq_buff[index++] = c;
7160 if (--bytes_left == 0) /* codepoint complete */
b9c2e32f 7161 if(codepoint > 0x10FFFF) /* is it too large? */
e8e86723 7162 complete = -1; /* error (RFC3629 limit) */
b9c2e32f
AR
7163 else
7164 { /* finished; output utf-8 sequence */
acec9514 7165 yield = string_catn(yield, seq_buff, seq_len);
b9c2e32f
AR
7166 index = 0;
7167 }
b9c2e32f
AR
7168 }
7169 }
7170 else /* no bytes left: new sequence */
7171 {
7172 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7173 {
acec9514 7174 yield = string_catn(yield, &c, 1);
b9c2e32f
AR
7175 continue;
7176 }
7177 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7178 {
10cc8a1e
AR
7179 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7180 complete = -1;
7181 else
7182 {
7183 bytes_left = 1;
7184 codepoint = c & 0x1f;
7185 }
b9c2e32f
AR
7186 }
7187 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7188 {
7189 bytes_left = 2;
7190 codepoint = c & 0x0f;
7191 }
7192 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7193 {
7194 bytes_left = 3;
7195 codepoint = c & 0x07;
7196 }
7197 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7198 complete = -1;
7199
7200 seq_buff[index++] = c;
7201 seq_len = bytes_left + 1;
7202 } /* if(bytes_left) */
7203
7204 if (complete != 0)
7205 {
7206 bytes_left = index = 0;
acec9514 7207 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
b9c2e32f
AR
7208 }
7209 if ((complete == 1) && ((c & 0x80) == 0))
4e08fd50 7210 /* ASCII character follows incomplete sequence */
acec9514 7211 yield = string_catn(yield, &c, 1);
b9c2e32f
AR
7212 }
7213 continue;
7214 }
7215
8c5d388a 7216#ifdef SUPPORT_I18N
4e08fd50
JH
7217 case EOP_UTF8_DOMAIN_TO_ALABEL:
7218 {
7219 uschar * error = NULL;
7220 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7221 if (error)
7222 {
7223 expand_string_message = string_sprintf(
7224 "error converting utf8 (%s) to alabel: %s",
7225 string_printing(sub), error);
7226 goto EXPAND_FAILED;
7227 }
acec9514 7228 yield = string_cat(yield, s);
4e08fd50
JH
7229 continue;
7230 }
7231
7232 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7233 {
7234 uschar * error = NULL;
7235 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7236 if (error)
7237 {
7238 expand_string_message = string_sprintf(
7239 "error converting alabel (%s) to utf8: %s",
7240 string_printing(sub), error);
7241 goto EXPAND_FAILED;
7242 }
acec9514 7243 yield = string_cat(yield, s);
4e08fd50
JH
7244 continue;
7245 }
7246
7247 case EOP_UTF8_LOCALPART_TO_ALABEL:
7248 {
7249 uschar * error = NULL;
7250 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7251 if (error)
7252 {
7253 expand_string_message = string_sprintf(
7254 "error converting utf8 (%s) to alabel: %s",
7255 string_printing(sub), error);
7256 goto EXPAND_FAILED;
7257 }
acec9514
JH
7258 yield = string_cat(yield, s);
7259 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
4e08fd50
JH
7260 continue;
7261 }
7262
7263 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7264 {
7265 uschar * error = NULL;
7266 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7267 if (error)
7268 {
7269 expand_string_message = string_sprintf(
7270 "error converting alabel (%s) to utf8: %s",
7271 string_printing(sub), error);
7272 goto EXPAND_FAILED;
7273 }
acec9514 7274 yield = string_cat(yield, s);
4e08fd50
JH
7275 continue;
7276 }
7277#endif /* EXPERIMENTAL_INTERNATIONAL */
7278
059ec3d9
PH
7279 /* escape turns all non-printing characters into escape sequences. */
7280
7281 case EOP_ESCAPE:
7282 {
3367f8c2 7283 const uschar * t = string_printing(sub);
acec9514 7284 yield = string_cat(yield, t);
059ec3d9
PH
7285 continue;
7286 }
7287
3367f8c2
JH
7288 case EOP_ESCAPE8BIT:
7289 {
7290 const uschar * s = sub;
7291 uschar c;
7292
4dc2379a 7293 for (s = sub; (c = *s); s++)
3367f8c2 7294 yield = c < 127 && c != '\\'
acec9514
JH
7295 ? string_catn(yield, s, 1)
7296 : string_catn(yield, string_sprintf("\\%03o", c), 4);
3367f8c2
JH
7297 continue;
7298 }
7299
059ec3d9
PH
7300 /* Handle numeric expression evaluation */
7301
7302 case EOP_EVAL:
7303 case EOP_EVAL10:
7304 {
7305 uschar *save_sub = sub;
7306 uschar *error = NULL;
97d17305 7307 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
059ec3d9
PH
7308 if (error != NULL)
7309 {
7310 expand_string_message = string_sprintf("error in expression "
bb07bcd3
JH
7311 "evaluation: %s (after processing \"%.*s\")", error,
7312 (int)(sub-save_sub), save_sub);
059ec3d9
PH
7313 goto EXPAND_FAILED;
7314 }
97d17305 7315 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
acec9514 7316 yield = string_cat(yield, var_buffer);
059ec3d9
PH
7317 continue;
7318 }
7319
7320 /* Handle time period formating */
7321
f90d018c
PH
7322 case EOP_TIME_EVAL:
7323 {
7324 int n = readconf_readtime(sub, 0, FALSE);
7325 if (n < 0)
7326 {
7327 expand_string_message = string_sprintf("string \"%s\" is not an "
7328 "Exim time interval in \"%s\" operator", sub, name);
7329 goto EXPAND_FAILED;
7330 }
7331 sprintf(CS var_buffer, "%d", n);
acec9514 7332 yield = string_cat(yield, var_buffer);
f90d018c
PH
7333 continue;
7334 }
7335
059ec3d9
PH
7336 case EOP_TIME_INTERVAL:
7337 {
7338 int n;
7339 uschar *t = read_number(&n, sub);
7340 if (*t != 0) /* Not A Number*/
7341 {
7342 expand_string_message = string_sprintf("string \"%s\" is not a "
7343 "positive number in \"%s\" operator", sub, name);
7344 goto EXPAND_FAILED;
7345 }
7346 t = readconf_printtime(n);
acec9514 7347 yield = string_cat(yield, t);
059ec3d9
PH
7348 continue;
7349 }
7350
7351 /* Convert string to base64 encoding */
7352
7353 case EOP_STR2B64:
9aa35e9c 7354 case EOP_BASE64:
59b87190 7355 {
b81207d2 7356#ifdef SUPPORT_TLS
59b87190
JH
7357 uschar * s = vp && *(void **)vp->value
7358 ? tls_cert_der_b64(*(void **)vp->value)
7359 : b64encode(sub, Ustrlen(sub));
b81207d2
JH
7360#else
7361 uschar * s = b64encode(sub, Ustrlen(sub));
7362#endif
acec9514 7363 yield = string_cat(yield, s);
59b87190
JH
7364 continue;
7365 }
059ec3d9 7366
9aa35e9c
JH
7367 case EOP_BASE64D:
7368 {
59b87190 7369 uschar * s;
9aa35e9c
JH
7370 int len = b64decode(sub, &s);
7371 if (len < 0)
7372 {
7373 expand_string_message = string_sprintf("string \"%s\" is not "
7374 "well-formed for \"%s\" operator", sub, name);
7375 goto EXPAND_FAILED;
7376 }
acec9514 7377 yield = string_cat(yield, s);
9aa35e9c
JH
7378 continue;
7379 }
7380
059ec3d9
PH
7381 /* strlen returns the length of the string */
7382
7383 case EOP_STRLEN:
7384 {
7385 uschar buff[24];
7386 (void)sprintf(CS buff, "%d", Ustrlen(sub));
acec9514 7387 yield = string_cat(yield, buff);
059ec3d9
PH
7388 continue;
7389 }
7390
7391 /* length_n or l_n takes just the first n characters or the whole string,
7392 whichever is the shorter;
7393
7394 substr_m_n, and s_m_n take n characters from offset m; negative m take
7395 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7396 takes the rest, either to the right or to the left.
7397
7398 hash_n or h_n makes a hash of length n from the string, yielding n
7399 characters from the set a-z; hash_n_m makes a hash of length n, but
7400 uses m characters from the set a-zA-Z0-9.
7401
7402 nhash_n returns a single number between 0 and n-1 (in text form), while
7403 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7404 between 0 and n-1 and the second between 0 and m-1. */
7405
7406 case EOP_LENGTH:
7407 case EOP_L:
7408 case EOP_SUBSTR:
7409 case EOP_S:
7410 case EOP_HASH:
7411 case EOP_H:
7412 case EOP_NHASH:
7413 case EOP_NH:
7414 {
7415 int sign = 1;
7416 int value1 = 0;
7417 int value2 = -1;
7418 int *pn;
7419 int len;
7420 uschar *ret;
7421
7422 if (arg == NULL)
7423 {
7424 expand_string_message = string_sprintf("missing values after %s",
7425 name);
7426 goto EXPAND_FAILED;
7427 }
7428
7429 /* "length" has only one argument, effectively being synonymous with
7430 substr_0_n. */
7431
7432 if (c == EOP_LENGTH || c == EOP_L)
7433 {
7434 pn = &value2;
7435 value2 = 0;
7436 }
7437
7438 /* The others have one or two arguments; for "substr" the first may be
7439 negative. The second being negative means "not supplied". */
7440
7441 else
7442 {
7443 pn = &value1;
7444 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7445 }
7446
7447 /* Read up to two numbers, separated by underscores */
7448
7449 ret = arg;
7450 while (*arg != 0)
7451 {
7452 if (arg != ret && *arg == '_' && pn == &value1)
7453 {
7454 pn = &value2;
7455 value2 = 0;
7456 if (arg[1] != 0) arg++;
7457 }
7458 else if (!isdigit(*arg))
7459 {
7460 expand_string_message =
7461 string_sprintf("non-digit after underscore in \"%s\"", name);
7462 goto EXPAND_FAILED;
7463 }
7464 else *pn = (*pn)*10 + *arg++ - '0';
7465 }
7466 value1 *= sign;
7467
7468 /* Perform the required operation */
7469
7470 ret =
7471 (c == EOP_HASH || c == EOP_H)?
7472 compute_hash(sub, value1, value2, &len) :
7473 (c == EOP_NHASH || c == EOP_NH)?
7474 compute_nhash(sub, value1, value2, &len) :
7475 extract_substr(sub, value1, value2, &len);
7476
7477 if (ret == NULL) goto EXPAND_FAILED;
acec9514 7478 yield = string_catn(yield, ret, len);
059ec3d9
PH
7479 continue;
7480 }
7481
7482 /* Stat a path */
7483
7484 case EOP_STAT:
7485 {
7486 uschar *s;
7487 uschar smode[12];
7488 uschar **modetable[3];
7489 int i;
7490 mode_t mode;
7491 struct stat st;
7492
254e032f
PH
7493 if ((expand_forbid & RDO_EXISTS) != 0)
7494 {
7495 expand_string_message = US"Use of the stat() expansion is not permitted";
7496 goto EXPAND_FAILED;
7497 }
7498
059ec3d9
PH
7499 if (stat(CS sub, &st) < 0)
7500 {
7501 expand_string_message = string_sprintf("stat(%s) failed: %s",
7502 sub, strerror(errno));
7503 goto EXPAND_FAILED;
7504 }
7505 mode = st.st_mode;
7506 switch (mode & S_IFMT)
7507 {
7508 case S_IFIFO: smode[0] = 'p'; break;
7509 case S_IFCHR: smode[0] = 'c'; break;
7510 case S_IFDIR: smode[0] = 'd'; break;
7511 case S_IFBLK: smode[0] = 'b'; break;
7512 case S_IFREG: smode[0] = '-'; break;
7513 default: smode[0] = '?'; break;
7514 }
7515
7516 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7517 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7518 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7519
7520 for (i = 0; i < 3; i++)
7521 {
7522 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7523 mode >>= 3;
7524 }
7525
7526 smode[10] = 0;
7527 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
b1c749bb 7528 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
059ec3d9
PH
7529 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7530 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
b1c749bb 7531 (long)st.st_gid, st.st_size, (long)st.st_atime,
059ec3d9 7532 (long)st.st_mtime, (long)st.st_ctime);
acec9514 7533 yield = string_cat(yield, s);
059ec3d9
PH
7534 continue;
7535 }
7536
17c76198 7537 /* vaguely random number less than N */
9e3331ea
TK
7538
7539 case EOP_RANDINT:
7540 {
97d17305 7541 int_eximarith_t max;
9e3331ea
TK
7542 uschar *s;
7543
7685ce68 7544 max = expanded_string_integer(sub, TRUE);
9e3331ea
TK
7545 if (expand_string_message != NULL)
7546 goto EXPAND_FAILED;
17c76198 7547 s = string_sprintf("%d", vaguely_random_number((int)max));
acec9514 7548 yield = string_cat(yield, s);
9e3331ea
TK
7549 continue;
7550 }
7551
83e029d5
PP
7552 /* Reverse IP, including IPv6 to dotted-nibble */
7553
7554 case EOP_REVERSE_IP:
7555 {
7556 int family, maskptr;
7557 uschar reversed[128];
7558
7559 family = string_is_ip_address(sub, &maskptr);
7560 if (family == 0)
7561 {
7562 expand_string_message = string_sprintf(
7563 "reverse_ip() not given an IP address [%s]", sub);
7564 goto EXPAND_FAILED;
7565 }
7566 invert_address(reversed, sub);
acec9514 7567 yield = string_cat(yield, reversed);
83e029d5
PP
7568 continue;
7569 }
7570
059ec3d9
PH
7571 /* Unknown operator */
7572
7573 default:
7574 expand_string_message =
7575 string_sprintf("unknown expansion operator \"%s\"", name);
7576 goto EXPAND_FAILED;
7577 }
7578 }
7579
7580 /* Handle a plain name. If this is the first thing in the expansion, release
7581 the pre-allocated buffer. If the result data is known to be in a new buffer,
7582 newsize will be set to the size of that buffer, and we can just point at that
7583 store instead of copying. Many expansion strings contain just one reference,
7584 so this is a useful optimization, especially for humungous headers
7585 ($message_headers). */
2e23003a 7586 /*{*/
059ec3d9
PH
7587 if (*s++ == '}')
7588 {
7589 int len;
7590 int newsize = 0;
bb07bcd3 7591 gstring * g = NULL;
acec9514 7592
bb07bcd3
JH
7593 if (!yield)
7594 g = store_get(sizeof(gstring));
7595 else if (yield->ptr == 0)
059ec3d9 7596 {
d6b4d938 7597 if (resetok) store_reset(yield);
059ec3d9 7598 yield = NULL;
bb07bcd3 7599 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
059ec3d9 7600 }
8487aee9 7601 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
059ec3d9
PH
7602 {
7603 expand_string_message =
7604 string_sprintf("unknown variable in \"${%s}\"", name);
641cb756 7605 check_variable_error_message(name);
059ec3d9
PH
7606 goto EXPAND_FAILED;
7607 }
7608 len = Ustrlen(value);
8487aee9 7609 if (!yield && newsize)
059ec3d9 7610 {
acec9514
JH
7611 yield = g;
7612 yield->size = newsize;
7613 yield->ptr = len;
7614 yield->s = value;
059ec3d9 7615 }
8487aee9 7616 else
acec9514 7617 yield = string_catn(yield, value, len);
059ec3d9
PH
7618 continue;
7619 }
7620
7621 /* Else there's something wrong */
7622
7623 expand_string_message =
7624 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7625 "in a variable reference)", name);
7626 goto EXPAND_FAILED;
7627 }
7628
7629/* If we hit the end of the string when ket_ends is set, there is a missing
7630terminating brace. */
7631
7632if (ket_ends && *s == 0)
7633 {
617d3932
JH
7634 expand_string_message = malformed_header
7635 ? US"missing } at end of string - could be header name not terminated by colon"
7636 : US"missing } at end of string";
059ec3d9
PH
7637 goto EXPAND_FAILED;
7638 }
7639
7640/* Expansion succeeded; yield may still be NULL here if nothing was actually
7641added to the string. If so, set up an empty string. Add a terminating zero. If
7642left != NULL, return a pointer to the terminator. */
7643
acec9514
JH
7644if (!yield)
7645 yield = string_get(1);
7646(void) string_from_gstring(yield);
7647if (left) *left = s;
059ec3d9
PH
7648
7649/* Any stacking store that was used above the final string is no longer needed.
7650In many cases the final string will be the first one that was got and so there
7651will be optimal store usage. */
7652
acec9514 7653if (resetok) store_reset(yield->s + (yield->size = yield->ptr + 1));
b0e85a8f
JH
7654else if (resetok_p) *resetok_p = FALSE;
7655
059ec3d9
PH
7656DEBUG(D_expand)
7657 {
1b37ac39
JH
7658 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
7659 "expanding: %.*s\n",
7660 (int)(s - string), string);
7661 debug_printf_indent("%s"
7662 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7663 "result: %s\n",
7664 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
acec9514 7665 yield->s);
1b37ac39
JH
7666 if (skipping)
7667 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7668 "skipping: result is not used\n");
059ec3d9 7669 }
e1d04f48 7670expand_level--;
acec9514 7671return yield->s;
059ec3d9
PH
7672
7673/* This is the failure exit: easiest to program with a goto. We still need
7674to update the pointer to the terminator, for cases of nested calls with "fail".
7675*/
7676
7677EXPAND_FAILED_CURLY:
e47376be
JH
7678if (malformed_header)
7679 expand_string_message =
7680 US"missing or misplaced { or } - could be header name not terminated by colon";
7681
7682else if (!expand_string_message || !*expand_string_message)
7683 expand_string_message = US"missing or misplaced { or }";
059ec3d9
PH
7684
7685/* At one point, Exim reset the store to yield (if yield was not NULL), but
7686that is a bad idea, because expand_string_message is in dynamic store. */
7687
7688EXPAND_FAILED:
acec9514 7689if (left) *left = s;
059ec3d9
PH
7690DEBUG(D_expand)
7691 {
1b37ac39
JH
7692 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
7693 string);
7694 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7695 "error message: %s\n",
7696 expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7697 expand_string_message);
7698 if (expand_string_forcedfail)
7699 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
059ec3d9 7700 }
ce93c6d8 7701if (resetok_p && !resetok) *resetok_p = FALSE;
e1d04f48 7702expand_level--;
059ec3d9
PH
7703return NULL;
7704}
7705
7706
7707/* This is the external function call. Do a quick check for any expansion
7708metacharacters, and if there are none, just return the input string.
7709
7710Argument: the string to be expanded
7711Returns: the expanded string, or NULL if expansion failed; if failure was
7712 due to a lookup deferring, search_find_defer will be TRUE
7713*/
7714
ce93c6d8
JH
7715const uschar *
7716expand_cstring(const uschar * string)
059ec3d9 7717{
ce93c6d8
JH
7718if (Ustrpbrk(string, "$\\") != NULL)
7719 {
7720 int old_pool = store_pool;
7721 uschar * s;
7722
7723 search_find_defer = FALSE;
7724 malformed_header = FALSE;
7725 store_pool = POOL_MAIN;
7726 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7727 store_pool = old_pool;
7728 return s;
7729 }
7730return string;
059ec3d9
PH
7731}
7732
7733
ce93c6d8
JH
7734uschar *
7735expand_string(uschar * string)
55414b25 7736{
ce93c6d8 7737return US expand_cstring(CUS string);
55414b25
JH
7738}
7739
7740
7741
ce93c6d8
JH
7742
7743
059ec3d9
PH
7744/*************************************************
7745* Expand and copy *
7746*************************************************/
7747
7748/* Now and again we want to expand a string and be sure that the result is in a
7749new bit of store. This function does that.
55414b25 7750Since we know it has been copied, the de-const cast is safe.
059ec3d9
PH
7751
7752Argument: the string to be expanded
7753Returns: the expanded string, always in a new bit of store, or NULL
7754*/
7755
7756uschar *
55414b25 7757expand_string_copy(const uschar *string)
059ec3d9 7758{
55414b25 7759const uschar *yield = expand_cstring(string);
059ec3d9 7760if (yield == string) yield = string_copy(string);
55414b25 7761return US yield;
059ec3d9
PH
7762}
7763
7764
7765
7766/*************************************************
7767* Expand and interpret as an integer *
7768*************************************************/
7769
7770/* Expand a string, and convert the result into an integer.
7771
d45b1de8
PH
7772Arguments:
7773 string the string to be expanded
7774 isplus TRUE if a non-negative number is expected
059ec3d9
PH
7775
7776Returns: the integer value, or
7777 -1 for an expansion error ) in both cases, message in
7778 -2 for an integer interpretation error ) expand_string_message
d45b1de8 7779 expand_string_message is set NULL for an OK integer
059ec3d9
PH
7780*/
7781
97d17305 7782int_eximarith_t
d45b1de8 7783expand_string_integer(uschar *string, BOOL isplus)
059ec3d9 7784{
7685ce68
TF
7785return expanded_string_integer(expand_string(string), isplus);
7786}
7787
7788
7789/*************************************************
7790 * Interpret string as an integer *
7791 *************************************************/
7792
7793/* Convert a string (that has already been expanded) into an integer.
7794
7795This function is used inside the expansion code.
7796
7797Arguments:
7798 s the string to be expanded
7799 isplus TRUE if a non-negative number is expected
7800
7801Returns: the integer value, or
7802 -1 if string is NULL (which implies an expansion error)
7803 -2 for an integer interpretation error
7804 expand_string_message is set NULL for an OK integer
7805*/
7806
7807static int_eximarith_t
55414b25 7808expanded_string_integer(const uschar *s, BOOL isplus)
7685ce68 7809{
97d17305 7810int_eximarith_t value;
059ec3d9
PH
7811uschar *msg = US"invalid integer \"%s\"";
7812uschar *endptr;
7813
d45b1de8
PH
7814/* If expansion failed, expand_string_message will be set. */
7815
059ec3d9
PH
7816if (s == NULL) return -1;
7817
7818/* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7819to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7820systems, so we set it zero ourselves. */
7821
7822errno = 0;
d45b1de8 7823expand_string_message = NULL; /* Indicates no error */
b52bc06e
NM
7824
7825/* Before Exim 4.64, strings consisting entirely of whitespace compared
7826equal to 0. Unfortunately, people actually relied upon that, so preserve
7827the behaviour explicitly. Stripping leading whitespace is a harmless
7828noop change since strtol skips it anyway (provided that there is a number
7829to find at all). */
7830if (isspace(*s))
7831 {
7832 while (isspace(*s)) ++s;
7833 if (*s == '\0')
7834 {
7835 DEBUG(D_expand)
e1d04f48 7836 debug_printf_indent("treating blank string as number 0\n");
b52bc06e
NM
7837 return 0;
7838 }
7839 }
7840
aa7c82b2 7841value = strtoll(CS s, CSS &endptr, 10);
059ec3d9
PH
7842
7843if (endptr == s)
7844 {
7845 msg = US"integer expected but \"%s\" found";
7846 }
d45b1de8
PH
7847else if (value < 0 && isplus)
7848 {
7849 msg = US"non-negative integer expected but \"%s\" found";
7850 }
059ec3d9
PH
7851else
7852 {
4eb9d6ef 7853 switch (tolower(*endptr))
059ec3d9 7854 {
4eb9d6ef
JH
7855 default:
7856 break;
7857 case 'k':
4328fd3c 7858 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
aa7c82b2 7859 else value *= 1024;
4eb9d6ef
JH
7860 endptr++;
7861 break;
7862 case 'm':
4328fd3c 7863 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
4eb9d6ef
JH
7864 else value *= 1024*1024;
7865 endptr++;
7866 break;
7867 case 'g':
4328fd3c 7868 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
4eb9d6ef
JH
7869 else value *= 1024*1024*1024;
7870 endptr++;
7871 break;
059ec3d9
PH
7872 }
7873 if (errno == ERANGE)
7874 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7875 else
7876 {
7877 while (isspace(*endptr)) endptr++;
725735cd 7878 if (*endptr == 0) return value;
059ec3d9
PH
7879 }
7880 }
7881
7882expand_string_message = string_sprintf(CS msg, s);
7883return -2;
7884}
7885
059ec3d9 7886
9c695f6d
JH
7887/* These values are usually fixed boolean values, but they are permitted to be
7888expanded strings.
7889
7890Arguments:
7891 addr address being routed
7892 mtype the module type
7893 mname the module name
7894 dbg_opt debug selectors
7895 oname the option name
7896 bvalue the router's boolean value
7897 svalue the router's string value
7898 rvalue where to put the returned value
7899
7900Returns: OK value placed in rvalue
7901 DEFER expansion failed
7902*/
7903
7904int
7905exp_bool(address_item *addr,
7906 uschar *mtype, uschar *mname, unsigned dbg_opt,
7907 uschar *oname, BOOL bvalue,
7908 uschar *svalue, BOOL *rvalue)
7909{
7910uschar *expanded;
7911if (svalue == NULL) { *rvalue = bvalue; return OK; }
7912
7913expanded = expand_string(svalue);
7914if (expanded == NULL)
7915 {
7916 if (expand_string_forcedfail)
7917 {
7918 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7919 *rvalue = bvalue;
7920 return OK;
7921 }
7922 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7923 oname, mname, mtype, expand_string_message);
7924 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7925 return DEFER;
7926 }
7927
7928DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7929 expanded);
7930
7931if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7932 *rvalue = TRUE;
7933else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7934 *rvalue = FALSE;
7935else
7936 {
7937 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7938 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7939 return DEFER;
7940 }
7941
7942return OK;
7943}
7944
7945
7946
f42deca9
JH
7947/* Avoid potentially exposing a password in a string about to be logged */
7948
7949uschar *
7950expand_hide_passwords(uschar * s)
7951{
7952return ( ( Ustrstr(s, "failed to expand") != NULL
7953 || Ustrstr(s, "expansion of ") != NULL
7954 )
7955 && ( Ustrstr(s, "mysql") != NULL
7956 || Ustrstr(s, "pgsql") != NULL
7957 || Ustrstr(s, "redis") != NULL
7958 || Ustrstr(s, "sqlite") != NULL
7959 || Ustrstr(s, "ldap:") != NULL
7960 || Ustrstr(s, "ldaps:") != NULL
7961 || Ustrstr(s, "ldapi:") != NULL
7962 || Ustrstr(s, "ldapdn:") != NULL
7963 || Ustrstr(s, "ldapm:") != NULL
7964 ) )
7965 ? US"Temporary internal error" : s;
7966}
7967
7968
617d3932
JH
7969/* Read given named file into big_buffer. Use for keying material etc.
7970The content will have an ascii NUL appended.
7971
7972Arguments:
7973 filename as it says
7974
7975Return: pointer to buffer, or NULL on error.
7976*/
7977
7978uschar *
7979expand_file_big_buffer(const uschar * filename)
7980{
7981int fd, off = 0, len;
7982
7983if ((fd = open(CS filename, O_RDONLY)) < 0)
7984 {
7985 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
7986 filename);
7987 return NULL;
7988 }
7989
7990do
7991 {
7992 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
7993 {
7994 (void) close(fd);
7995 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
7996 return NULL;
7997 }
7998 off += len;
7999 }
8000while (len > 0);
8001
8002(void) close(fd);
8003big_buffer[off] = '\0';
8004return big_buffer;
8005}
8006
8007
f42deca9 8008
cf0812d5
JH
8009/*************************************************
8010* Error-checking for testsuite *
8011*************************************************/
8012typedef struct {
cf0812d5
JH
8013 uschar * region_start;
8014 uschar * region_end;
8015 const uschar *var_name;
90341c71 8016 const uschar *var_data;
cf0812d5
JH
8017} err_ctx;
8018
8019static void
8020assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8021{
8022err_ctx * e = ctx;
8023if (var_data >= e->region_start && var_data < e->region_end)
90341c71 8024 {
cf0812d5 8025 e->var_name = CUS var_name;
90341c71
JH
8026 e->var_data = CUS var_data;
8027 }
cf0812d5
JH
8028}
8029
8030void
8031assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8032{
ce93c6d8
JH
8033err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8034 .var_name = NULL, .var_data = NULL };
cf0812d5
JH
8035int i;
8036var_entry * v;
8037
8038/* check acl_ variables */
8039tree_walk(acl_var_c, assert_variable_notin, &e);
8040tree_walk(acl_var_m, assert_variable_notin, &e);
8041
8042/* check auth<n> variables */
8043for (i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8044 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
8045
8046/* check regex<n> variables */
8047for (i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8048 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
8049
8050/* check known-name variables */
8051for (v = var_table; v < var_table + var_table_size; v++)
8052 if (v->type == vtype_stringptr)
8053 assert_variable_notin(US v->name, *(USS v->value), &e);
8054
ce93c6d8
JH
8055/* check dns and address trees */
8056tree_walk(tree_dns_fails, assert_variable_notin, &e);
8057tree_walk(tree_duplicates, assert_variable_notin, &e);
8058tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8059tree_walk(tree_unusable, assert_variable_notin, &e);
8060
cf0812d5 8061if (e.var_name)
90341c71
JH
8062 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8063 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
ce93c6d8 8064 e.var_name, filename, linenumber, e.var_data);
cf0812d5
JH
8065}
8066
8067
9c695f6d 8068
059ec3d9
PH
8069/*************************************************
8070**************************************************
8071* Stand-alone test program *
8072**************************************************
8073*************************************************/
8074
8075#ifdef STAND_ALONE
8076
8077
8078BOOL
8079regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
8080{
8081int ovector[3*(EXPAND_MAXN+1)];
8082int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
0539a19d 8083 ovector, nelem(ovector));
059ec3d9
PH
8084BOOL yield = n >= 0;
8085if (n == 0) n = EXPAND_MAXN + 1;
8086if (yield)
8087 {
8088 int nn;
8089 expand_nmax = (setup < 0)? 0 : setup + 1;
8090 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
8091 {
8092 expand_nstring[expand_nmax] = subject + ovector[nn];
8093 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8094 }
8095 expand_nmax--;
8096 }
8097return yield;
8098}
8099
8100
8101int main(int argc, uschar **argv)
8102{
8103int i;
8104uschar buffer[1024];
8105
8106debug_selector = D_v;
8107debug_file = stderr;
8108debug_fd = fileno(debug_file);
8109big_buffer = malloc(big_buffer_size);
8110
8111for (i = 1; i < argc; i++)
8112 {
8113 if (argv[i][0] == '+')
8114 {
8115 debug_trace_memory = 2;
8116 argv[i]++;
8117 }
8118 if (isdigit(argv[i][0]))
8119 debug_selector = Ustrtol(argv[i], NULL, 0);
8120 else
8121 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8122 Ustrlen(argv[i]))
8123 {
de78e2d5 8124#ifdef LOOKUP_LDAP
059ec3d9 8125 eldap_default_servers = argv[i];
de78e2d5
JH
8126#endif
8127#ifdef LOOKUP_MYSQL
059ec3d9 8128 mysql_servers = argv[i];
de78e2d5
JH
8129#endif
8130#ifdef LOOKUP_PGSQL
059ec3d9 8131 pgsql_servers = argv[i];
de78e2d5
JH
8132#endif
8133#ifdef LOOKUP_REDIS
9bdd29ad 8134 redis_servers = argv[i];
de78e2d5 8135#endif
059ec3d9 8136 }
de78e2d5 8137#ifdef EXIM_PERL
059ec3d9 8138 else opt_perl_startup = argv[i];
de78e2d5 8139#endif
059ec3d9
PH
8140 }
8141
8142printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8143
8144expand_nstring[1] = US"string 1....";
8145expand_nlength[1] = 8;
8146expand_nmax = 1;
8147
8148#ifdef EXIM_PERL
8149if (opt_perl_startup != NULL)
8150 {
8151 uschar *errstr;
8152 printf("Starting Perl interpreter\n");
8153 errstr = init_perl(opt_perl_startup);
8154 if (errstr != NULL)
8155 {
8156 printf("** error in perl_startup code: %s\n", errstr);
8157 return EXIT_FAILURE;
8158 }
8159 }
8160#endif /* EXIM_PERL */
8161
8162while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8163 {
8164 void *reset_point = store_get(0);
8165 uschar *yield = expand_string(buffer);
8166 if (yield != NULL)
8167 {
8168 printf("%s\n", yield);
8169 store_reset(reset_point);
8170 }
8171 else
8172 {
8173 if (search_find_defer) printf("search_find deferred\n");
8174 printf("Failed: %s\n", expand_string_message);
8175 if (expand_string_forcedfail) printf("Forced failure\n");
8176 printf("\n");
8177 }
8178 }
8179
8180search_tidyup();
8181
8182return 0;
8183}
8184
8185#endif
8186
9e4dddbd 8187/* vi: aw ai sw=2
b9c2e32f 8188*/
059ec3d9 8189/* End of expand.c */