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