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