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