projects / exim.git / blob
? search:


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