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