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