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