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