projects / exim.git / blob
? search:


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