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