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