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