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