353b8ea56b6cdb6a19f0226d826b681bd9254e72
[exim.git] / src / src / expand.c
1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
7
8
9 /* Functions for handling string expansion. */
10
11
12 #include "exim.h"
13
14 /* Recursively called function */
15
16 static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *);
17 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
18
19 #ifdef STAND_ALONE
20 #ifndef SUPPORT_CRYPTEQ
21 #define SUPPORT_CRYPTEQ
22 #endif
23 #endif
24
25 #ifdef LOOKUP_LDAP
26 #include "lookups/ldap.h"
27 #endif
28
29 #ifdef SUPPORT_CRYPTEQ
30 #ifdef CRYPT_H
31 #include <crypt.h>
32 #endif
33 #ifndef HAVE_CRYPT16
34 extern char* crypt16(char*, char*);
35 #endif
36 #endif
37
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
42
43 <quote>
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. Characters after the first 16 are ignored. It always generates
50 a 16-byte hash, which is expressed together with the salt as a string
51 of 24 base 64 digits. Here are some links to peruse:
52
53 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
54 http://seclists.org/bugtraq/1999/Mar/0076.html
55
56 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
57 and OSF/1. This is the same as the standard crypt if given a password
58 of 8 characters or less. If given more, it first does the same as crypt
59 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
60 using as salt the first two base 64 digits from the first hash block.
61 If the password is more than 16 characters then it crypts the 17th to 24th
62 characters using as salt the first two base 64 digits from the second hash
63 block. And so on: I've seen references to it cutting off the password at
64 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
65
66 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
67 http://seclists.org/bugtraq/1999/Mar/0109.html
68 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
69 TET1_html/sec.c222.html#no_id_208
70
71 Exim has something it calls "crypt16". It will either use a native
72 crypt16 or its own implementation. A native crypt16 will presumably
73 be the one that I called "crypt16" above. The internal "crypt16"
74 function, however, is a two-block-maximum implementation of what I called
75 "bigcrypt". The documentation matches the internal code.
76
77 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
78 that crypt16 and bigcrypt were different things.
79
80 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
81 to whatever it is using under that name. This unfortunately sets a
82 precedent for using "{crypt16}" to identify two incompatible algorithms
83 whose output can't be distinguished. With "{crypt16}" thus rendered
84 ambiguous, I suggest you deprecate it and invent two new identifiers
85 for the two algorithms.
86
87 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
88 of the password separately means they can be cracked separately, so
89 the double-length hash only doubles the cracking effort instead of
90 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
91 bcrypt ({CRYPT}$2a$).
92 </quote>
93 */
94
95
96
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
100
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
103
104 static uschar *item_table[] = {
105 US"acl",
106 US"certextract",
107 US"dlfunc",
108 US"env",
109 US"extract",
110 US"filter",
111 US"hash",
112 US"hmac",
113 US"if",
114 #ifdef SUPPORT_I18N
115 US"imapfolder",
116 #endif
117 US"length",
118 US"listextract",
119 US"lookup",
120 US"map",
121 US"nhash",
122 US"perl",
123 US"prvs",
124 US"prvscheck",
125 US"readfile",
126 US"readsocket",
127 US"reduce",
128 US"run",
129 US"sg",
130 US"sort",
131 US"substr",
132 US"tr" };
133
134 enum {
135 EITEM_ACL,
136 EITEM_CERTEXTRACT,
137 EITEM_DLFUNC,
138 EITEM_ENV,
139 EITEM_EXTRACT,
140 EITEM_FILTER,
141 EITEM_HASH,
142 EITEM_HMAC,
143 EITEM_IF,
144 #ifdef SUPPORT_I18N
145 EITEM_IMAPFOLDER,
146 #endif
147 EITEM_LENGTH,
148 EITEM_LISTEXTRACT,
149 EITEM_LOOKUP,
150 EITEM_MAP,
151 EITEM_NHASH,
152 EITEM_PERL,
153 EITEM_PRVS,
154 EITEM_PRVSCHECK,
155 EITEM_READFILE,
156 EITEM_READSOCK,
157 EITEM_REDUCE,
158 EITEM_RUN,
159 EITEM_SG,
160 EITEM_SORT,
161 EITEM_SUBSTR,
162 EITEM_TR };
163
164 /* Tables of operator names, and corresponding switch numbers. The names must be
165 in alphabetical order. There are two tables, because underscore is used in some
166 cases to introduce arguments, whereas for other it is part of the name. This is
167 an historical mis-design. */
168
169 static uschar *op_table_underscore[] = {
170 US"from_utf8",
171 US"local_part",
172 US"quote_local_part",
173 US"reverse_ip",
174 US"time_eval",
175 US"time_interval"
176 #ifdef SUPPORT_I18N
177 ,US"utf8_domain_from_alabel",
178 US"utf8_domain_to_alabel",
179 US"utf8_localpart_from_alabel",
180 US"utf8_localpart_to_alabel"
181 #endif
182 };
183
184 enum {
185 EOP_FROM_UTF8,
186 EOP_LOCAL_PART,
187 EOP_QUOTE_LOCAL_PART,
188 EOP_REVERSE_IP,
189 EOP_TIME_EVAL,
190 EOP_TIME_INTERVAL
191 #ifdef SUPPORT_I18N
192 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
193 EOP_UTF8_DOMAIN_TO_ALABEL,
194 EOP_UTF8_LOCALPART_FROM_ALABEL,
195 EOP_UTF8_LOCALPART_TO_ALABEL
196 #endif
197 };
198
199 static uschar *op_table_main[] = {
200 US"address",
201 US"addresses",
202 US"base32",
203 US"base32d",
204 US"base62",
205 US"base62d",
206 US"base64",
207 US"base64d",
208 US"domain",
209 US"escape",
210 US"escape8bit",
211 US"eval",
212 US"eval10",
213 US"expand",
214 US"h",
215 US"hash",
216 US"hex2b64",
217 US"hexquote",
218 US"ipv6denorm",
219 US"ipv6norm",
220 US"l",
221 US"lc",
222 US"length",
223 US"listcount",
224 US"listnamed",
225 US"mask",
226 US"md5",
227 US"nh",
228 US"nhash",
229 US"quote",
230 US"randint",
231 US"rfc2047",
232 US"rfc2047d",
233 US"rxquote",
234 US"s",
235 US"sha1",
236 US"sha256",
237 US"sha3",
238 US"stat",
239 US"str2b64",
240 US"strlen",
241 US"substr",
242 US"uc",
243 US"utf8clean" };
244
245 enum {
246 EOP_ADDRESS = nelem(op_table_underscore),
247 EOP_ADDRESSES,
248 EOP_BASE32,
249 EOP_BASE32D,
250 EOP_BASE62,
251 EOP_BASE62D,
252 EOP_BASE64,
253 EOP_BASE64D,
254 EOP_DOMAIN,
255 EOP_ESCAPE,
256 EOP_ESCAPE8BIT,
257 EOP_EVAL,
258 EOP_EVAL10,
259 EOP_EXPAND,
260 EOP_H,
261 EOP_HASH,
262 EOP_HEX2B64,
263 EOP_HEXQUOTE,
264 EOP_IPV6DENORM,
265 EOP_IPV6NORM,
266 EOP_L,
267 EOP_LC,
268 EOP_LENGTH,
269 EOP_LISTCOUNT,
270 EOP_LISTNAMED,
271 EOP_MASK,
272 EOP_MD5,
273 EOP_NH,
274 EOP_NHASH,
275 EOP_QUOTE,
276 EOP_RANDINT,
277 EOP_RFC2047,
278 EOP_RFC2047D,
279 EOP_RXQUOTE,
280 EOP_S,
281 EOP_SHA1,
282 EOP_SHA256,
283 EOP_SHA3,
284 EOP_STAT,
285 EOP_STR2B64,
286 EOP_STRLEN,
287 EOP_SUBSTR,
288 EOP_UC,
289 EOP_UTF8CLEAN };
290
291
292 /* Table of condition names, and corresponding switch numbers. The names must
293 be in alphabetical order. */
294
295 static uschar *cond_table[] = {
296 US"<",
297 US"<=",
298 US"=",
299 US"==", /* Backward compatibility */
300 US">",
301 US">=",
302 US"acl",
303 US"and",
304 US"bool",
305 US"bool_lax",
306 US"crypteq",
307 US"def",
308 US"eq",
309 US"eqi",
310 US"exists",
311 US"first_delivery",
312 US"forall",
313 US"forany",
314 US"ge",
315 US"gei",
316 US"gt",
317 US"gti",
318 US"inlist",
319 US"inlisti",
320 US"isip",
321 US"isip4",
322 US"isip6",
323 US"ldapauth",
324 US"le",
325 US"lei",
326 US"lt",
327 US"lti",
328 US"match",
329 US"match_address",
330 US"match_domain",
331 US"match_ip",
332 US"match_local_part",
333 US"or",
334 US"pam",
335 US"pwcheck",
336 US"queue_running",
337 US"radius",
338 US"saslauthd"
339 };
340
341 enum {
342 ECOND_NUM_L,
343 ECOND_NUM_LE,
344 ECOND_NUM_E,
345 ECOND_NUM_EE,
346 ECOND_NUM_G,
347 ECOND_NUM_GE,
348 ECOND_ACL,
349 ECOND_AND,
350 ECOND_BOOL,
351 ECOND_BOOL_LAX,
352 ECOND_CRYPTEQ,
353 ECOND_DEF,
354 ECOND_STR_EQ,
355 ECOND_STR_EQI,
356 ECOND_EXISTS,
357 ECOND_FIRST_DELIVERY,
358 ECOND_FORALL,
359 ECOND_FORANY,
360 ECOND_STR_GE,
361 ECOND_STR_GEI,
362 ECOND_STR_GT,
363 ECOND_STR_GTI,
364 ECOND_INLIST,
365 ECOND_INLISTI,
366 ECOND_ISIP,
367 ECOND_ISIP4,
368 ECOND_ISIP6,
369 ECOND_LDAPAUTH,
370 ECOND_STR_LE,
371 ECOND_STR_LEI,
372 ECOND_STR_LT,
373 ECOND_STR_LTI,
374 ECOND_MATCH,
375 ECOND_MATCH_ADDRESS,
376 ECOND_MATCH_DOMAIN,
377 ECOND_MATCH_IP,
378 ECOND_MATCH_LOCAL_PART,
379 ECOND_OR,
380 ECOND_PAM,
381 ECOND_PWCHECK,
382 ECOND_QUEUE_RUNNING,
383 ECOND_RADIUS,
384 ECOND_SASLAUTHD
385 };
386
387
388 /* Types of table entry */
389
390 enum vtypes {
391 vtype_int, /* value is address of int */
392 vtype_filter_int, /* ditto, but recognized only when filtering */
393 vtype_ino, /* value is address of ino_t (not always an int) */
394 vtype_uid, /* value is address of uid_t (not always an int) */
395 vtype_gid, /* value is address of gid_t (not always an int) */
396 vtype_bool, /* value is address of bool */
397 vtype_stringptr, /* value is address of pointer to string */
398 vtype_msgbody, /* as stringptr, but read when first required */
399 vtype_msgbody_end, /* ditto, the end of the message */
400 vtype_msgheaders, /* the message's headers, processed */
401 vtype_msgheaders_raw, /* the message's headers, unprocessed */
402 vtype_localpart, /* extract local part from string */
403 vtype_domain, /* extract domain from string */
404 vtype_string_func, /* value is string returned by given function */
405 vtype_todbsdin, /* value not used; generate BSD inbox tod */
406 vtype_tode, /* value not used; generate tod in epoch format */
407 vtype_todel, /* value not used; generate tod in epoch/usec format */
408 vtype_todf, /* value not used; generate full tod */
409 vtype_todl, /* value not used; generate log tod */
410 vtype_todlf, /* value not used; generate log file datestamp tod */
411 vtype_todzone, /* value not used; generate time zone only */
412 vtype_todzulu, /* value not used; generate zulu tod */
413 vtype_reply, /* value not used; get reply from headers */
414 vtype_pid, /* value not used; result is pid */
415 vtype_host_lookup, /* value not used; get host name */
416 vtype_load_avg, /* value not used; result is int from os_getloadavg */
417 vtype_pspace, /* partition space; value is T/F for spool/log */
418 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
419 vtype_cert /* SSL certificate */
420 #ifndef DISABLE_DKIM
421 ,vtype_dkim /* Lookup of value in DKIM signature */
422 #endif
423 };
424
425 /* Type for main variable table */
426
427 typedef struct {
428 const char *name;
429 enum vtypes type;
430 void *value;
431 } var_entry;
432
433 /* Type for entries pointing to address/length pairs. Not currently
434 in use. */
435
436 typedef struct {
437 uschar **address;
438 int *length;
439 } alblock;
440
441 static uschar * fn_recipients(void);
442
443 /* This table must be kept in alphabetical order. */
444
445 static var_entry var_table[] = {
446 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
447 they will be confused with user-creatable ACL variables. */
448 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
449 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
450 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
451 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
452 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
453 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
454 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
455 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
456 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
457 { "acl_narg", vtype_int, &acl_narg },
458 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
459 { "address_data", vtype_stringptr, &deliver_address_data },
460 { "address_file", vtype_stringptr, &address_file },
461 { "address_pipe", vtype_stringptr, &address_pipe },
462 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
463 { "authenticated_id", vtype_stringptr, &authenticated_id },
464 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
465 { "authentication_failed",vtype_int, &authentication_failed },
466 #ifdef WITH_CONTENT_SCAN
467 { "av_failed", vtype_int, &av_failed },
468 #endif
469 #ifdef EXPERIMENTAL_BRIGHTMAIL
470 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
471 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
472 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
473 { "bmi_deliver", vtype_int, &bmi_deliver },
474 #endif
475 { "body_linecount", vtype_int, &body_linecount },
476 { "body_zerocount", vtype_int, &body_zerocount },
477 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
478 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
479 { "caller_gid", vtype_gid, &real_gid },
480 { "caller_uid", vtype_uid, &real_uid },
481 { "callout_address", vtype_stringptr, &callout_address },
482 { "compile_date", vtype_stringptr, &version_date },
483 { "compile_number", vtype_stringptr, &version_cnumber },
484 { "config_dir", vtype_stringptr, &config_main_directory },
485 { "config_file", vtype_stringptr, &config_main_filename },
486 { "csa_status", vtype_stringptr, &csa_status },
487 #ifdef EXPERIMENTAL_DCC
488 { "dcc_header", vtype_stringptr, &dcc_header },
489 { "dcc_result", vtype_stringptr, &dcc_result },
490 #endif
491 #ifndef DISABLE_DKIM
492 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
493 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
494 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
495 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
496 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
497 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
498 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
499 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
500 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
501 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
502 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
503 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
504 { "dkim_key_length", vtype_int, &dkim_key_length },
505 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
506 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
507 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
508 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
509 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
510 { "dkim_signers", vtype_stringptr, &dkim_signers },
511 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
512 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
513 #endif
514 #ifdef EXPERIMENTAL_DMARC
515 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
516 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
517 { "dmarc_status", vtype_stringptr, &dmarc_status },
518 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
519 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
520 #endif
521 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
522 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
523 { "dnslist_text", vtype_stringptr, &dnslist_text },
524 { "dnslist_value", vtype_stringptr, &dnslist_value },
525 { "domain", vtype_stringptr, &deliver_domain },
526 { "domain_data", vtype_stringptr, &deliver_domain_data },
527 #ifndef DISABLE_EVENT
528 { "event_data", vtype_stringptr, &event_data },
529
530 /*XXX want to use generic vars for as many of these as possible*/
531 { "event_defer_errno", vtype_int, &event_defer_errno },
532
533 { "event_name", vtype_stringptr, &event_name },
534 #endif
535 { "exim_gid", vtype_gid, &exim_gid },
536 { "exim_path", vtype_stringptr, &exim_path },
537 { "exim_uid", vtype_uid, &exim_uid },
538 { "exim_version", vtype_stringptr, &version_string },
539 { "headers_added", vtype_string_func, &fn_hdrs_added },
540 { "home", vtype_stringptr, &deliver_home },
541 { "host", vtype_stringptr, &deliver_host },
542 { "host_address", vtype_stringptr, &deliver_host_address },
543 { "host_data", vtype_stringptr, &host_data },
544 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
545 { "host_lookup_failed", vtype_int, &host_lookup_failed },
546 { "host_port", vtype_int, &deliver_host_port },
547 { "initial_cwd", vtype_stringptr, &initial_cwd },
548 { "inode", vtype_ino, &deliver_inode },
549 { "interface_address", vtype_stringptr, &interface_address },
550 { "interface_port", vtype_int, &interface_port },
551 { "item", vtype_stringptr, &iterate_item },
552 #ifdef LOOKUP_LDAP
553 { "ldap_dn", vtype_stringptr, &eldap_dn },
554 #endif
555 { "load_average", vtype_load_avg, NULL },
556 { "local_part", vtype_stringptr, &deliver_localpart },
557 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
558 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
559 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
560 { "local_scan_data", vtype_stringptr, &local_scan_data },
561 { "local_user_gid", vtype_gid, &local_user_gid },
562 { "local_user_uid", vtype_uid, &local_user_uid },
563 { "localhost_number", vtype_int, &host_number },
564 { "log_inodes", vtype_pinodes, (void *)FALSE },
565 { "log_space", vtype_pspace, (void *)FALSE },
566 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
567 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
568 #ifdef WITH_CONTENT_SCAN
569 { "malware_name", vtype_stringptr, &malware_name },
570 #endif
571 { "max_received_linelength", vtype_int, &max_received_linelength },
572 { "message_age", vtype_int, &message_age },
573 { "message_body", vtype_msgbody, &message_body },
574 { "message_body_end", vtype_msgbody_end, &message_body_end },
575 { "message_body_size", vtype_int, &message_body_size },
576 { "message_exim_id", vtype_stringptr, &message_id },
577 { "message_headers", vtype_msgheaders, NULL },
578 { "message_headers_raw", vtype_msgheaders_raw, NULL },
579 { "message_id", vtype_stringptr, &message_id },
580 { "message_linecount", vtype_int, &message_linecount },
581 { "message_size", vtype_int, &message_size },
582 #ifdef SUPPORT_I18N
583 { "message_smtputf8", vtype_bool, &message_smtputf8 },
584 #endif
585 #ifdef WITH_CONTENT_SCAN
586 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
587 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
588 { "mime_boundary", vtype_stringptr, &mime_boundary },
589 { "mime_charset", vtype_stringptr, &mime_charset },
590 { "mime_content_description", vtype_stringptr, &mime_content_description },
591 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
592 { "mime_content_id", vtype_stringptr, &mime_content_id },
593 { "mime_content_size", vtype_int, &mime_content_size },
594 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
595 { "mime_content_type", vtype_stringptr, &mime_content_type },
596 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
597 { "mime_filename", vtype_stringptr, &mime_filename },
598 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
599 { "mime_is_multipart", vtype_int, &mime_is_multipart },
600 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
601 { "mime_part_count", vtype_int, &mime_part_count },
602 #endif
603 { "n0", vtype_filter_int, &filter_n[0] },
604 { "n1", vtype_filter_int, &filter_n[1] },
605 { "n2", vtype_filter_int, &filter_n[2] },
606 { "n3", vtype_filter_int, &filter_n[3] },
607 { "n4", vtype_filter_int, &filter_n[4] },
608 { "n5", vtype_filter_int, &filter_n[5] },
609 { "n6", vtype_filter_int, &filter_n[6] },
610 { "n7", vtype_filter_int, &filter_n[7] },
611 { "n8", vtype_filter_int, &filter_n[8] },
612 { "n9", vtype_filter_int, &filter_n[9] },
613 { "original_domain", vtype_stringptr, &deliver_domain_orig },
614 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
615 { "originator_gid", vtype_gid, &originator_gid },
616 { "originator_uid", vtype_uid, &originator_uid },
617 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
618 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
619 { "pid", vtype_pid, NULL },
620 #ifndef DISABLE_PRDR
621 { "prdr_requested", vtype_bool, &prdr_requested },
622 #endif
623 { "primary_hostname", vtype_stringptr, &primary_hostname },
624 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
625 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
626 { "proxy_external_port", vtype_int, &proxy_external_port },
627 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
628 { "proxy_local_port", vtype_int, &proxy_local_port },
629 { "proxy_session", vtype_bool, &proxy_session },
630 #endif
631 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
632 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
633 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
634 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
635 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
636 { "queue_name", vtype_stringptr, &queue_name },
637 { "rcpt_count", vtype_int, &rcpt_count },
638 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
639 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
640 { "received_count", vtype_int, &received_count },
641 { "received_for", vtype_stringptr, &received_for },
642 { "received_ip_address", vtype_stringptr, &interface_address },
643 { "received_port", vtype_int, &interface_port },
644 { "received_protocol", vtype_stringptr, &received_protocol },
645 { "received_time", vtype_int, &received_time.tv_sec },
646 { "recipient_data", vtype_stringptr, &recipient_data },
647 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
648 { "recipients", vtype_string_func, &fn_recipients },
649 { "recipients_count", vtype_int, &recipients_count },
650 #ifdef WITH_CONTENT_SCAN
651 { "regex_match_string", vtype_stringptr, &regex_match_string },
652 #endif
653 { "reply_address", vtype_reply, NULL },
654 { "return_path", vtype_stringptr, &return_path },
655 { "return_size_limit", vtype_int, &bounce_return_size_limit },
656 { "router_name", vtype_stringptr, &router_name },
657 { "runrc", vtype_int, &runrc },
658 { "self_hostname", vtype_stringptr, &self_hostname },
659 { "sender_address", vtype_stringptr, &sender_address },
660 { "sender_address_data", vtype_stringptr, &sender_address_data },
661 { "sender_address_domain", vtype_domain, &sender_address },
662 { "sender_address_local_part", vtype_localpart, &sender_address },
663 { "sender_data", vtype_stringptr, &sender_data },
664 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
665 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
666 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
667 { "sender_host_address", vtype_stringptr, &sender_host_address },
668 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
669 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
670 { "sender_host_name", vtype_host_lookup, NULL },
671 { "sender_host_port", vtype_int, &sender_host_port },
672 { "sender_ident", vtype_stringptr, &sender_ident },
673 { "sender_rate", vtype_stringptr, &sender_rate },
674 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
675 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
676 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
677 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
678 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
679 { "sending_port", vtype_int, &sending_port },
680 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
681 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
682 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
683 { "smtp_command_history", vtype_string_func, &smtp_cmd_hist },
684 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
685 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
686 { "sn0", vtype_filter_int, &filter_sn[0] },
687 { "sn1", vtype_filter_int, &filter_sn[1] },
688 { "sn2", vtype_filter_int, &filter_sn[2] },
689 { "sn3", vtype_filter_int, &filter_sn[3] },
690 { "sn4", vtype_filter_int, &filter_sn[4] },
691 { "sn5", vtype_filter_int, &filter_sn[5] },
692 { "sn6", vtype_filter_int, &filter_sn[6] },
693 { "sn7", vtype_filter_int, &filter_sn[7] },
694 { "sn8", vtype_filter_int, &filter_sn[8] },
695 { "sn9", vtype_filter_int, &filter_sn[9] },
696 #ifdef WITH_CONTENT_SCAN
697 { "spam_action", vtype_stringptr, &spam_action },
698 { "spam_bar", vtype_stringptr, &spam_bar },
699 { "spam_report", vtype_stringptr, &spam_report },
700 { "spam_score", vtype_stringptr, &spam_score },
701 { "spam_score_int", vtype_stringptr, &spam_score_int },
702 #endif
703 #ifdef EXPERIMENTAL_SPF
704 { "spf_guess", vtype_stringptr, &spf_guess },
705 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
706 { "spf_received", vtype_stringptr, &spf_received },
707 { "spf_result", vtype_stringptr, &spf_result },
708 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
709 #endif
710 { "spool_directory", vtype_stringptr, &spool_directory },
711 { "spool_inodes", vtype_pinodes, (void *)TRUE },
712 { "spool_space", vtype_pspace, (void *)TRUE },
713 #ifdef EXPERIMENTAL_SRS
714 { "srs_db_address", vtype_stringptr, &srs_db_address },
715 { "srs_db_key", vtype_stringptr, &srs_db_key },
716 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
717 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
718 { "srs_recipient", vtype_stringptr, &srs_recipient },
719 { "srs_status", vtype_stringptr, &srs_status },
720 #endif
721 { "thisaddress", vtype_stringptr, &filter_thisaddress },
722
723 /* The non-(in,out) variables are now deprecated */
724 { "tls_bits", vtype_int, &tls_in.bits },
725 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
726 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
727
728 { "tls_in_bits", vtype_int, &tls_in.bits },
729 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
730 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
731 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
732 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
733 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
734 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
735 #if defined(SUPPORT_TLS)
736 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
737 #endif
738 { "tls_out_bits", vtype_int, &tls_out.bits },
739 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
740 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
741 #ifdef EXPERIMENTAL_DANE
742 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
743 #endif
744 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
745 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
746 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
747 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
748 #if defined(SUPPORT_TLS)
749 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
750 #endif
751 #ifdef EXPERIMENTAL_DANE
752 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
753 #endif
754
755 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
756 #if defined(SUPPORT_TLS)
757 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
758 #endif
759
760 { "tod_bsdinbox", vtype_todbsdin, NULL },
761 { "tod_epoch", vtype_tode, NULL },
762 { "tod_epoch_l", vtype_todel, NULL },
763 { "tod_full", vtype_todf, NULL },
764 { "tod_log", vtype_todl, NULL },
765 { "tod_logfile", vtype_todlf, NULL },
766 { "tod_zone", vtype_todzone, NULL },
767 { "tod_zulu", vtype_todzulu, NULL },
768 { "transport_name", vtype_stringptr, &transport_name },
769 { "value", vtype_stringptr, &lookup_value },
770 { "verify_mode", vtype_stringptr, &verify_mode },
771 { "version_number", vtype_stringptr, &version_string },
772 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
773 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
774 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
775 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
776 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
777 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
778 };
779
780 static int var_table_size = nelem(var_table);
781 static uschar var_buffer[256];
782 static BOOL malformed_header;
783
784 /* For textual hashes */
785
786 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
787 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
788 "0123456789";
789
790 enum { HMAC_MD5, HMAC_SHA1 };
791
792 /* For numeric hashes */
793
794 static unsigned int prime[] = {
795 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
796 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
797 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
798
799 /* For printing modes in symbolic form */
800
801 static uschar *mtable_normal[] =
802 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
803
804 static uschar *mtable_setid[] =
805 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
806
807 static uschar *mtable_sticky[] =
808 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
809
810
811
812 /*************************************************
813 * Tables for UTF-8 support *
814 *************************************************/
815
816 /* Table of the number of extra characters, indexed by the first character
817 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
818 0x3d. */
819
820 static uschar utf8_table1[] = {
821 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
822 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
823 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
824 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
825
826 /* These are the masks for the data bits in the first byte of a character,
827 indexed by the number of additional bytes. */
828
829 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
830
831 /* Get the next UTF-8 character, advancing the pointer. */
832
833 #define GETUTF8INC(c, ptr) \
834 c = *ptr++; \
835 if ((c & 0xc0) == 0xc0) \
836 { \
837 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
838 int s = 6*a; \
839 c = (c & utf8_table2[a]) << s; \
840 while (a-- > 0) \
841 { \
842 s -= 6; \
843 c |= (*ptr++ & 0x3f) << s; \
844 } \
845 }
846
847
848
849 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
850
851 /*************************************************
852 * Binary chop search on a table *
853 *************************************************/
854
855 /* This is used for matching expansion items and operators.
856
857 Arguments:
858 name the name that is being sought
859 table the table to search
860 table_size the number of items in the table
861
862 Returns: the offset in the table, or -1
863 */
864
865 static int
866 chop_match(uschar *name, uschar **table, int table_size)
867 {
868 uschar **bot = table;
869 uschar **top = table + table_size;
870
871 while (top > bot)
872 {
873 uschar **mid = bot + (top - bot)/2;
874 int c = Ustrcmp(name, *mid);
875 if (c == 0) return mid - table;
876 if (c > 0) bot = mid + 1; else top = mid;
877 }
878
879 return -1;
880 }
881
882
883
884 /*************************************************
885 * Check a condition string *
886 *************************************************/
887
888 /* This function is called to expand a string, and test the result for a "true"
889 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
890 forced fail or lookup defer.
891
892 We used to release all store used, but this is not not safe due
893 to ${dlfunc } and ${acl }. In any case expand_string_internal()
894 is reasonably careful to release what it can.
895
896 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
897
898 Arguments:
899 condition the condition string
900 m1 text to be incorporated in panic error
901 m2 ditto
902
903 Returns: TRUE if condition is met, FALSE if not
904 */
905
906 BOOL
907 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
908 {
909 int rc;
910 uschar *ss = expand_string(condition);
911 if (ss == NULL)
912 {
913 if (!expand_string_forcedfail && !search_find_defer)
914 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
915 "for %s %s: %s", condition, m1, m2, expand_string_message);
916 return FALSE;
917 }
918 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
919 strcmpic(ss, US"false") != 0;
920 return rc;
921 }
922
923
924
925
926 /*************************************************
927 * Pseudo-random number generation *
928 *************************************************/
929
930 /* Pseudo-random number generation. The result is not "expected" to be
931 cryptographically strong but not so weak that someone will shoot themselves
932 in the foot using it as a nonce in some email header scheme or whatever
933 weirdness they'll twist this into. The result should ideally handle fork().
934
935 However, if we're stuck unable to provide this, then we'll fall back to
936 appallingly bad randomness.
937
938 If SUPPORT_TLS is defined then this will not be used except as an emergency
939 fallback.
940
941 Arguments:
942 max range maximum
943 Returns a random number in range [0, max-1]
944 */
945
946 #ifdef SUPPORT_TLS
947 # define vaguely_random_number vaguely_random_number_fallback
948 #endif
949 int
950 vaguely_random_number(int max)
951 {
952 #ifdef SUPPORT_TLS
953 # undef vaguely_random_number
954 #endif
955 static pid_t pid = 0;
956 pid_t p2;
957 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
958 struct timeval tv;
959 #endif
960
961 p2 = getpid();
962 if (p2 != pid)
963 {
964 if (pid != 0)
965 {
966
967 #ifdef HAVE_ARC4RANDOM
968 /* cryptographically strong randomness, common on *BSD platforms, not
969 so much elsewhere. Alas. */
970 #ifndef NOT_HAVE_ARC4RANDOM_STIR
971 arc4random_stir();
972 #endif
973 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
974 #ifdef HAVE_SRANDOMDEV
975 /* uses random(4) for seeding */
976 srandomdev();
977 #else
978 gettimeofday(&tv, NULL);
979 srandom(tv.tv_sec | tv.tv_usec | getpid());
980 #endif
981 #else
982 /* Poor randomness and no seeding here */
983 #endif
984
985 }
986 pid = p2;
987 }
988
989 #ifdef HAVE_ARC4RANDOM
990 return arc4random() % max;
991 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
992 return random() % max;
993 #else
994 /* This one returns a 16-bit number, definitely not crypto-strong */
995 return random_number(max);
996 #endif
997 }
998
999
1000
1001
1002 /*************************************************
1003 * Pick out a name from a string *
1004 *************************************************/
1005
1006 /* If the name is too long, it is silently truncated.
1007
1008 Arguments:
1009 name points to a buffer into which to put the name
1010 max is the length of the buffer
1011 s points to the first alphabetic character of the name
1012 extras chars other than alphanumerics to permit
1013
1014 Returns: pointer to the first character after the name
1015
1016 Note: The test for *s != 0 in the while loop is necessary because
1017 Ustrchr() yields non-NULL if the character is zero (which is not something
1018 I expected). */
1019
1020 static const uschar *
1021 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1022 {
1023 int ptr = 0;
1024 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1025 {
1026 if (ptr < max-1) name[ptr++] = *s;
1027 s++;
1028 }
1029 name[ptr] = 0;
1030 return s;
1031 }
1032
1033
1034
1035 /*************************************************
1036 * Pick out the rest of a header name *
1037 *************************************************/
1038
1039 /* A variable name starting $header_ (or just $h_ for those who like
1040 abbreviations) might not be the complete header name because headers can
1041 contain any printing characters in their names, except ':'. This function is
1042 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1043 on the end, if the name was terminated by white space.
1044
1045 Arguments:
1046 name points to a buffer in which the name read so far exists
1047 max is the length of the buffer
1048 s points to the first character after the name so far, i.e. the
1049 first non-alphameric character after $header_xxxxx
1050
1051 Returns: a pointer to the first character after the header name
1052 */
1053
1054 static const uschar *
1055 read_header_name(uschar *name, int max, const uschar *s)
1056 {
1057 int prelen = Ustrchr(name, '_') - name + 1;
1058 int ptr = Ustrlen(name) - prelen;
1059 if (ptr > 0) memmove(name, name+prelen, ptr);
1060 while (mac_isgraph(*s) && *s != ':')
1061 {
1062 if (ptr < max-1) name[ptr++] = *s;
1063 s++;
1064 }
1065 if (*s == ':') s++;
1066 name[ptr++] = ':';
1067 name[ptr] = 0;
1068 return s;
1069 }
1070
1071
1072
1073 /*************************************************
1074 * Pick out a number from a string *
1075 *************************************************/
1076
1077 /* Arguments:
1078 n points to an integer into which to put the number
1079 s points to the first digit of the number
1080
1081 Returns: a pointer to the character after the last digit
1082 */
1083 /*XXX consider expanding to int_eximarith_t. But the test for
1084 "overbig numbers" in 0002 still needs to overflow it. */
1085
1086 static uschar *
1087 read_number(int *n, uschar *s)
1088 {
1089 *n = 0;
1090 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1091 return s;
1092 }
1093
1094 static const uschar *
1095 read_cnumber(int *n, const uschar *s)
1096 {
1097 *n = 0;
1098 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1099 return s;
1100 }
1101
1102
1103
1104 /*************************************************
1105 * Extract keyed subfield from a string *
1106 *************************************************/
1107
1108 /* The yield is in dynamic store; NULL means that the key was not found.
1109
1110 Arguments:
1111 key points to the name of the key
1112 s points to the string from which to extract the subfield
1113
1114 Returns: NULL if the subfield was not found, or
1115 a pointer to the subfield's data
1116 */
1117
1118 static uschar *
1119 expand_getkeyed(uschar *key, const uschar *s)
1120 {
1121 int length = Ustrlen(key);
1122 while (isspace(*s)) s++;
1123
1124 /* Loop to search for the key */
1125
1126 while (*s != 0)
1127 {
1128 int dkeylength;
1129 uschar *data;
1130 const uschar *dkey = s;
1131
1132 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1133 dkeylength = s - dkey;
1134 while (isspace(*s)) s++;
1135 if (*s == '=') while (isspace((*(++s))));
1136
1137 data = string_dequote(&s);
1138 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1139 return data;
1140
1141 while (isspace(*s)) s++;
1142 }
1143
1144 return NULL;
1145 }
1146
1147
1148
1149 static var_entry *
1150 find_var_ent(uschar * name)
1151 {
1152 int first = 0;
1153 int last = var_table_size;
1154
1155 while (last > first)
1156 {
1157 int middle = (first + last)/2;
1158 int c = Ustrcmp(name, var_table[middle].name);
1159
1160 if (c > 0) { first = middle + 1; continue; }
1161 if (c < 0) { last = middle; continue; }
1162 return &var_table[middle];
1163 }
1164 return NULL;
1165 }
1166
1167 /*************************************************
1168 * Extract numbered subfield from string *
1169 *************************************************/
1170
1171 /* Extracts a numbered field from a string that is divided by tokens - for
1172 example a line from /etc/passwd is divided by colon characters. First field is
1173 numbered one. Negative arguments count from the right. Zero returns the whole
1174 string. Returns NULL if there are insufficient tokens in the string
1175
1176 ***WARNING***
1177 Modifies final argument - this is a dynamically generated string, so that's OK.
1178
1179 Arguments:
1180 field number of field to be extracted,
1181 first field = 1, whole string = 0, last field = -1
1182 separators characters that are used to break string into tokens
1183 s points to the string from which to extract the subfield
1184
1185 Returns: NULL if the field was not found,
1186 a pointer to the field's data inside s (modified to add 0)
1187 */
1188
1189 static uschar *
1190 expand_gettokened (int field, uschar *separators, uschar *s)
1191 {
1192 int sep = 1;
1193 int count;
1194 uschar *ss = s;
1195 uschar *fieldtext = NULL;
1196
1197 if (field == 0) return s;
1198
1199 /* Break the line up into fields in place; for field > 0 we stop when we have
1200 done the number of fields we want. For field < 0 we continue till the end of
1201 the string, counting the number of fields. */
1202
1203 count = (field > 0)? field : INT_MAX;
1204
1205 while (count-- > 0)
1206 {
1207 size_t len;
1208
1209 /* Previous field was the last one in the string. For a positive field
1210 number, this means there are not enough fields. For a negative field number,
1211 check that there are enough, and scan back to find the one that is wanted. */
1212
1213 if (sep == 0)
1214 {
1215 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1216 if ((-field) == (INT_MAX - count - 1)) return s;
1217 while (field++ < 0)
1218 {
1219 ss--;
1220 while (ss[-1] != 0) ss--;
1221 }
1222 fieldtext = ss;
1223 break;
1224 }
1225
1226 /* Previous field was not last in the string; save its start and put a
1227 zero at its end. */
1228
1229 fieldtext = ss;
1230 len = Ustrcspn(ss, separators);
1231 sep = ss[len];
1232 ss[len] = 0;
1233 ss += len + 1;
1234 }
1235
1236 return fieldtext;
1237 }
1238
1239
1240 static uschar *
1241 expand_getlistele(int field, const uschar * list)
1242 {
1243 const uschar * tlist= list;
1244 int sep= 0;
1245 uschar dummy;
1246
1247 if(field<0)
1248 {
1249 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1250 sep= 0;
1251 }
1252 if(field==0) return NULL;
1253 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1254 return string_nextinlist(&list, &sep, NULL, 0);
1255 }
1256
1257
1258 /* Certificate fields, by name. Worry about by-OID later */
1259 /* Names are chosen to not have common prefixes */
1260
1261 #ifdef SUPPORT_TLS
1262 typedef struct
1263 {
1264 uschar * name;
1265 int namelen;
1266 uschar * (*getfn)(void * cert, uschar * mod);
1267 } certfield;
1268 static certfield certfields[] =
1269 { /* linear search; no special order */
1270 { US"version", 7, &tls_cert_version },
1271 { US"serial_number", 13, &tls_cert_serial_number },
1272 { US"subject", 7, &tls_cert_subject },
1273 { US"notbefore", 9, &tls_cert_not_before },
1274 { US"notafter", 8, &tls_cert_not_after },
1275 { US"issuer", 6, &tls_cert_issuer },
1276 { US"signature", 9, &tls_cert_signature },
1277 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1278 { US"subj_altname", 12, &tls_cert_subject_altname },
1279 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1280 { US"crl_uri", 7, &tls_cert_crl_uri },
1281 };
1282
1283 static uschar *
1284 expand_getcertele(uschar * field, uschar * certvar)
1285 {
1286 var_entry * vp;
1287 certfield * cp;
1288
1289 if (!(vp = find_var_ent(certvar)))
1290 {
1291 expand_string_message =
1292 string_sprintf("no variable named \"%s\"", certvar);
1293 return NULL; /* Unknown variable name */
1294 }
1295 /* NB this stops us passing certs around in variable. Might
1296 want to do that in future */
1297 if (vp->type != vtype_cert)
1298 {
1299 expand_string_message =
1300 string_sprintf("\"%s\" is not a certificate", certvar);
1301 return NULL; /* Unknown variable name */
1302 }
1303 if (!*(void **)vp->value)
1304 return NULL;
1305
1306 if (*field >= '0' && *field <= '9')
1307 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1308
1309 for(cp = certfields;
1310 cp < certfields + nelem(certfields);
1311 cp++)
1312 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1313 {
1314 uschar * modifier = *(field += cp->namelen) == ','
1315 ? ++field : NULL;
1316 return (*cp->getfn)( *(void **)vp->value, modifier );
1317 }
1318
1319 expand_string_message =
1320 string_sprintf("bad field selector \"%s\" for certextract", field);
1321 return NULL;
1322 }
1323 #endif /*SUPPORT_TLS*/
1324
1325 /*************************************************
1326 * Extract a substring from a string *
1327 *************************************************/
1328
1329 /* Perform the ${substr or ${length expansion operations.
1330
1331 Arguments:
1332 subject the input string
1333 value1 the offset from the start of the input string to the start of
1334 the output string; if negative, count from the right.
1335 value2 the length of the output string, or negative (-1) for unset
1336 if value1 is positive, unset means "all after"
1337 if value1 is negative, unset means "all before"
1338 len set to the length of the returned string
1339
1340 Returns: pointer to the output string, or NULL if there is an error
1341 */
1342
1343 static uschar *
1344 extract_substr(uschar *subject, int value1, int value2, int *len)
1345 {
1346 int sublen = Ustrlen(subject);
1347
1348 if (value1 < 0) /* count from right */
1349 {
1350 value1 += sublen;
1351
1352 /* If the position is before the start, skip to the start, and adjust the
1353 length. If the length ends up negative, the substring is null because nothing
1354 can precede. This falls out naturally when the length is unset, meaning "all
1355 to the left". */
1356
1357 if (value1 < 0)
1358 {
1359 value2 += value1;
1360 if (value2 < 0) value2 = 0;
1361 value1 = 0;
1362 }
1363
1364 /* Otherwise an unset length => characters before value1 */
1365
1366 else if (value2 < 0)
1367 {
1368 value2 = value1;
1369 value1 = 0;
1370 }
1371 }
1372
1373 /* For a non-negative offset, if the starting position is past the end of the
1374 string, the result will be the null string. Otherwise, an unset length means
1375 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1376
1377 else
1378 {
1379 if (value1 > sublen)
1380 {
1381 value1 = sublen;
1382 value2 = 0;
1383 }
1384 else if (value2 < 0) value2 = sublen;
1385 }
1386
1387 /* Cut the length down to the maximum possible for the offset value, and get
1388 the required characters. */
1389
1390 if (value1 + value2 > sublen) value2 = sublen - value1;
1391 *len = value2;
1392 return subject + value1;
1393 }
1394
1395
1396
1397
1398 /*************************************************
1399 * Old-style hash of a string *
1400 *************************************************/
1401
1402 /* Perform the ${hash expansion operation.
1403
1404 Arguments:
1405 subject the input string (an expanded substring)
1406 value1 the length of the output string; if greater or equal to the
1407 length of the input string, the input string is returned
1408 value2 the number of hash characters to use, or 26 if negative
1409 len set to the length of the returned string
1410
1411 Returns: pointer to the output string, or NULL if there is an error
1412 */
1413
1414 static uschar *
1415 compute_hash(uschar *subject, int value1, int value2, int *len)
1416 {
1417 int sublen = Ustrlen(subject);
1418
1419 if (value2 < 0) value2 = 26;
1420 else if (value2 > Ustrlen(hashcodes))
1421 {
1422 expand_string_message =
1423 string_sprintf("hash count \"%d\" too big", value2);
1424 return NULL;
1425 }
1426
1427 /* Calculate the hash text. We know it is shorter than the original string, so
1428 can safely place it in subject[] (we know that subject is always itself an
1429 expanded substring). */
1430
1431 if (value1 < sublen)
1432 {
1433 int c;
1434 int i = 0;
1435 int j = value1;
1436 while ((c = (subject[j])) != 0)
1437 {
1438 int shift = (c + j++) & 7;
1439 subject[i] ^= (c << shift) | (c >> (8-shift));
1440 if (++i >= value1) i = 0;
1441 }
1442 for (i = 0; i < value1; i++)
1443 subject[i] = hashcodes[(subject[i]) % value2];
1444 }
1445 else value1 = sublen;
1446
1447 *len = value1;
1448 return subject;
1449 }
1450
1451
1452
1453
1454 /*************************************************
1455 * Numeric hash of a string *
1456 *************************************************/
1457
1458 /* Perform the ${nhash expansion operation. The first characters of the
1459 string are treated as most important, and get the highest prime numbers.
1460
1461 Arguments:
1462 subject the input string
1463 value1 the maximum value of the first part of the result
1464 value2 the maximum value of the second part of the result,
1465 or negative to produce only a one-part result
1466 len set to the length of the returned string
1467
1468 Returns: pointer to the output string, or NULL if there is an error.
1469 */
1470
1471 static uschar *
1472 compute_nhash (uschar *subject, int value1, int value2, int *len)
1473 {
1474 uschar *s = subject;
1475 int i = 0;
1476 unsigned long int total = 0; /* no overflow */
1477
1478 while (*s != 0)
1479 {
1480 if (i == 0) i = nelem(prime) - 1;
1481 total += prime[i--] * (unsigned int)(*s++);
1482 }
1483
1484 /* If value2 is unset, just compute one number */
1485
1486 if (value2 < 0)
1487 s = string_sprintf("%d", total % value1);
1488
1489 /* Otherwise do a div/mod hash */
1490
1491 else
1492 {
1493 total = total % (value1 * value2);
1494 s = string_sprintf("%d/%d", total/value2, total % value2);
1495 }
1496
1497 *len = Ustrlen(s);
1498 return s;
1499 }
1500
1501
1502
1503
1504
1505 /*************************************************
1506 * Find the value of a header or headers *
1507 *************************************************/
1508
1509 /* Multiple instances of the same header get concatenated, and this function
1510 can also return a concatenation of all the header lines. When concatenating
1511 specific headers that contain lists of addresses, a comma is inserted between
1512 them. Otherwise we use a straight concatenation. Because some messages can have
1513 pathologically large number of lines, there is a limit on the length that is
1514 returned. Also, to avoid massive store use which would result from using
1515 string_cat() as it copies and extends strings, we do a preliminary pass to find
1516 out exactly how much store will be needed. On "normal" messages this will be
1517 pretty trivial.
1518
1519 Arguments:
1520 name the name of the header, without the leading $header_ or $h_,
1521 or NULL if a concatenation of all headers is required
1522 exists_only TRUE if called from a def: test; don't need to build a string;
1523 just return a string that is not "" and not "0" if the header
1524 exists
1525 newsize return the size of memory block that was obtained; may be NULL
1526 if exists_only is TRUE
1527 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1528 other than concatenating, will be done on the header. Also used
1529 for $message_headers_raw.
1530 charset name of charset to translate MIME words to; used only if
1531 want_raw is false; if NULL, no translation is done (this is
1532 used for $bh_ and $bheader_)
1533
1534 Returns: NULL if the header does not exist, else a pointer to a new
1535 store block
1536 */
1537
1538 static uschar *
1539 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1540 uschar *charset)
1541 {
1542 BOOL found = name == NULL;
1543 int comma = 0;
1544 int len = found? 0 : Ustrlen(name);
1545 int i;
1546 uschar *yield = NULL;
1547 uschar *ptr = NULL;
1548
1549 /* Loop for two passes - saves code repetition */
1550
1551 for (i = 0; i < 2; i++)
1552 {
1553 int size = 0;
1554 header_line *h;
1555
1556 for (h = header_list; size < header_insert_maxlen && h; h = h->next)
1557 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1558 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1559 {
1560 int ilen;
1561 uschar *t;
1562
1563 if (exists_only) return US"1"; /* don't need actual string */
1564 found = TRUE;
1565 t = h->text + len; /* text to insert */
1566 if (!want_raw) /* unless wanted raw, */
1567 while (isspace(*t)) t++; /* remove leading white space */
1568 ilen = h->slen - (t - h->text); /* length to insert */
1569
1570 /* Unless wanted raw, remove trailing whitespace, including the
1571 newline. */
1572
1573 if (!want_raw)
1574 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1575
1576 /* Set comma = 1 if handling a single header and it's one of those
1577 that contains an address list, except when asked for raw headers. Only
1578 need to do this once. */
1579
1580 if (!want_raw && name && comma == 0 &&
1581 Ustrchr("BCFRST", h->type) != NULL)
1582 comma = 1;
1583
1584 /* First pass - compute total store needed; second pass - compute
1585 total store used, including this header. */
1586
1587 size += ilen + comma + 1; /* +1 for the newline */
1588
1589 /* Second pass - concatenate the data, up to a maximum. Note that
1590 the loop stops when size hits the limit. */
1591
1592 if (i != 0)
1593 {
1594 if (size > header_insert_maxlen)
1595 {
1596 ilen -= size - header_insert_maxlen - 1;
1597 comma = 0;
1598 }
1599 Ustrncpy(ptr, t, ilen);
1600 ptr += ilen;
1601
1602 /* For a non-raw header, put in the comma if needed, then add
1603 back the newline we removed above, provided there was some text in
1604 the header. */
1605
1606 if (!want_raw && ilen > 0)
1607 {
1608 if (comma != 0) *ptr++ = ',';
1609 *ptr++ = '\n';
1610 }
1611 }
1612 }
1613
1614 /* At end of first pass, return NULL if no header found. Then truncate size
1615 if necessary, and get the buffer to hold the data, returning the buffer size.
1616 */
1617
1618 if (i == 0)
1619 {
1620 if (!found) return NULL;
1621 if (size > header_insert_maxlen) size = header_insert_maxlen;
1622 *newsize = size + 1;
1623 ptr = yield = store_get(*newsize);
1624 }
1625 }
1626
1627 /* That's all we do for raw header expansion. */
1628
1629 if (want_raw)
1630 *ptr = 0;
1631
1632 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1633 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1634 function can return an error with decoded data if the charset translation
1635 fails. If decoding fails, it returns NULL. */
1636
1637 else
1638 {
1639 uschar *decoded, *error;
1640 if (ptr > yield && ptr[-1] == '\n') ptr--;
1641 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1642 *ptr = 0;
1643 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1644 newsize, &error);
1645 if (error != NULL)
1646 {
1647 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1648 " input was: %s\n", error, yield);
1649 }
1650 if (decoded != NULL) yield = decoded;
1651 }
1652
1653 return yield;
1654 }
1655
1656
1657
1658
1659 /*************************************************
1660 * Return list of recipients *
1661 *************************************************/
1662 /* A recipients list is available only during system message filtering,
1663 during ACL processing after DATA, and while expanding pipe commands
1664 generated from a system filter, but not elsewhere. */
1665
1666 static uschar *
1667 fn_recipients(void)
1668 {
1669 if (!enable_dollar_recipients) return NULL; else
1670 {
1671 int size = 128;
1672 int ptr = 0;
1673 int i;
1674 uschar * s = store_get(size);
1675 for (i = 0; i < recipients_count; i++)
1676 {
1677 if (i != 0) s = string_catn(s, &size, &ptr, US", ", 2);
1678 s = string_cat(s, &size, &ptr, recipients_list[i].address);
1679 }
1680 s[ptr] = 0; /* string_cat() leaves room */
1681 return s;
1682 }
1683 }
1684
1685
1686 /*************************************************
1687 * Find value of a variable *
1688 *************************************************/
1689
1690 /* The table of variables is kept in alphabetic order, so we can search it
1691 using a binary chop. The "choplen" variable is nothing to do with the binary
1692 chop.
1693
1694 Arguments:
1695 name the name of the variable being sought
1696 exists_only TRUE if this is a def: test; passed on to find_header()
1697 skipping TRUE => skip any processing evaluation; this is not the same as
1698 exists_only because def: may test for values that are first
1699 evaluated here
1700 newsize pointer to an int which is initially zero; if the answer is in
1701 a new memory buffer, *newsize is set to its size
1702
1703 Returns: NULL if the variable does not exist, or
1704 a pointer to the variable's contents, or
1705 something non-NULL if exists_only is TRUE
1706 */
1707
1708 static uschar *
1709 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1710 {
1711 var_entry * vp;
1712 uschar *s, *domain;
1713 uschar **ss;
1714 void * val;
1715
1716 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1717 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1718 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1719 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1720 (this gave backwards compatibility at the changeover). There may be built-in
1721 variables whose names start acl_ but they should never start in this way. This
1722 slightly messy specification is a consequence of the history, needless to say.
1723
1724 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1725 set, in which case give an error. */
1726
1727 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1728 !isalpha(name[5]))
1729 {
1730 tree_node *node =
1731 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1732 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1733 }
1734
1735 /* Handle $auth<n> variables. */
1736
1737 if (Ustrncmp(name, "auth", 4) == 0)
1738 {
1739 uschar *endptr;
1740 int n = Ustrtoul(name + 4, &endptr, 10);
1741 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1742 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1743 }
1744 else if (Ustrncmp(name, "regex", 5) == 0)
1745 {
1746 uschar *endptr;
1747 int n = Ustrtoul(name + 5, &endptr, 10);
1748 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1749 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1750 }
1751
1752 /* For all other variables, search the table */
1753
1754 if (!(vp = find_var_ent(name)))
1755 return NULL; /* Unknown variable name */
1756
1757 /* Found an existing variable. If in skipping state, the value isn't needed,
1758 and we want to avoid processing (such as looking up the host name). */
1759
1760 if (skipping)
1761 return US"";
1762
1763 val = vp->value;
1764 switch (vp->type)
1765 {
1766 case vtype_filter_int:
1767 if (!filter_running) return NULL;
1768 /* Fall through */
1769 /* VVVVVVVVVVVV */
1770 case vtype_int:
1771 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1772 return var_buffer;
1773
1774 case vtype_ino:
1775 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1776 return var_buffer;
1777
1778 case vtype_gid:
1779 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1780 return var_buffer;
1781
1782 case vtype_uid:
1783 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1784 return var_buffer;
1785
1786 case vtype_bool:
1787 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1788 return var_buffer;
1789
1790 case vtype_stringptr: /* Pointer to string */
1791 return (s = *((uschar **)(val))) ? s : US"";
1792
1793 case vtype_pid:
1794 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1795 return var_buffer;
1796
1797 case vtype_load_avg:
1798 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1799 return var_buffer;
1800
1801 case vtype_host_lookup: /* Lookup if not done so */
1802 if (sender_host_name == NULL && sender_host_address != NULL &&
1803 !host_lookup_failed && host_name_lookup() == OK)
1804 host_build_sender_fullhost();
1805 return (sender_host_name == NULL)? US"" : sender_host_name;
1806
1807 case vtype_localpart: /* Get local part from address */
1808 s = *((uschar **)(val));
1809 if (s == NULL) return US"";
1810 domain = Ustrrchr(s, '@');
1811 if (domain == NULL) return s;
1812 if (domain - s > sizeof(var_buffer) - 1)
1813 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1814 " in string expansion", sizeof(var_buffer));
1815 Ustrncpy(var_buffer, s, domain - s);
1816 var_buffer[domain - s] = 0;
1817 return var_buffer;
1818
1819 case vtype_domain: /* Get domain from address */
1820 s = *((uschar **)(val));
1821 if (s == NULL) return US"";
1822 domain = Ustrrchr(s, '@');
1823 return (domain == NULL)? US"" : domain + 1;
1824
1825 case vtype_msgheaders:
1826 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1827
1828 case vtype_msgheaders_raw:
1829 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1830
1831 case vtype_msgbody: /* Pointer to msgbody string */
1832 case vtype_msgbody_end: /* Ditto, the end of the msg */
1833 ss = (uschar **)(val);
1834 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1835 {
1836 uschar *body;
1837 off_t start_offset = SPOOL_DATA_START_OFFSET;
1838 int len = message_body_visible;
1839 if (len > message_size) len = message_size;
1840 *ss = body = store_malloc(len+1);
1841 body[0] = 0;
1842 if (vp->type == vtype_msgbody_end)
1843 {
1844 struct stat statbuf;
1845 if (fstat(deliver_datafile, &statbuf) == 0)
1846 {
1847 start_offset = statbuf.st_size - len;
1848 if (start_offset < SPOOL_DATA_START_OFFSET)
1849 start_offset = SPOOL_DATA_START_OFFSET;
1850 }
1851 }
1852 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1853 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1854 strerror(errno));
1855 len = read(deliver_datafile, body, len);
1856 if (len > 0)
1857 {
1858 body[len] = 0;
1859 if (message_body_newlines) /* Separate loops for efficiency */
1860 while (len > 0)
1861 { if (body[--len] == 0) body[len] = ' '; }
1862 else
1863 while (len > 0)
1864 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1865 }
1866 }
1867 return *ss ? *ss : US"";
1868
1869 case vtype_todbsdin: /* BSD inbox time of day */
1870 return tod_stamp(tod_bsdin);
1871
1872 case vtype_tode: /* Unix epoch time of day */
1873 return tod_stamp(tod_epoch);
1874
1875 case vtype_todel: /* Unix epoch/usec time of day */
1876 return tod_stamp(tod_epoch_l);
1877
1878 case vtype_todf: /* Full time of day */
1879 return tod_stamp(tod_full);
1880
1881 case vtype_todl: /* Log format time of day */
1882 return tod_stamp(tod_log_bare); /* (without timezone) */
1883
1884 case vtype_todzone: /* Time zone offset only */
1885 return tod_stamp(tod_zone);
1886
1887 case vtype_todzulu: /* Zulu time */
1888 return tod_stamp(tod_zulu);
1889
1890 case vtype_todlf: /* Log file datestamp tod */
1891 return tod_stamp(tod_log_datestamp_daily);
1892
1893 case vtype_reply: /* Get reply address */
1894 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1895 headers_charset);
1896 if (s != NULL) while (isspace(*s)) s++;
1897 if (s == NULL || *s == 0)
1898 {
1899 *newsize = 0; /* For the *s==0 case */
1900 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1901 }
1902 if (s != NULL)
1903 {
1904 uschar *t;
1905 while (isspace(*s)) s++;
1906 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1907 while (t > s && isspace(t[-1])) t--;
1908 *t = 0;
1909 }
1910 return (s == NULL)? US"" : s;
1911
1912 case vtype_string_func:
1913 {
1914 uschar * (*fn)() = val;
1915 return fn();
1916 }
1917
1918 case vtype_pspace:
1919 {
1920 int inodes;
1921 sprintf(CS var_buffer, "%d",
1922 receive_statvfs(val == (void *)TRUE, &inodes));
1923 }
1924 return var_buffer;
1925
1926 case vtype_pinodes:
1927 {
1928 int inodes;
1929 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1930 sprintf(CS var_buffer, "%d", inodes);
1931 }
1932 return var_buffer;
1933
1934 case vtype_cert:
1935 return *(void **)val ? US"<cert>" : US"";
1936
1937 #ifndef DISABLE_DKIM
1938 case vtype_dkim:
1939 return dkim_exim_expand_query((int)(long)val);
1940 #endif
1941
1942 }
1943
1944 return NULL; /* Unknown variable. Silences static checkers. */
1945 }
1946
1947
1948
1949
1950 void
1951 modify_variable(uschar *name, void * value)
1952 {
1953 var_entry * vp;
1954 if ((vp = find_var_ent(name))) vp->value = value;
1955 return; /* Unknown variable name, fail silently */
1956 }
1957
1958
1959
1960
1961
1962
1963 /*************************************************
1964 * Read and expand substrings *
1965 *************************************************/
1966
1967 /* This function is called to read and expand argument substrings for various
1968 expansion items. Some have a minimum requirement that is less than the maximum;
1969 in these cases, the first non-present one is set to NULL.
1970
1971 Arguments:
1972 sub points to vector of pointers to set
1973 n maximum number of substrings
1974 m minimum required
1975 sptr points to current string pointer
1976 skipping the skipping flag
1977 check_end if TRUE, check for final '}'
1978 name name of item, for error message
1979 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1980 the store.
1981
1982 Returns: 0 OK; string pointer updated
1983 1 curly bracketing error (too few arguments)
1984 2 too many arguments (only if check_end is set); message set
1985 3 other error (expansion failure)
1986 */
1987
1988 static int
1989 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1990 BOOL check_end, uschar *name, BOOL *resetok)
1991 {
1992 int i;
1993 const uschar *s = *sptr;
1994
1995 while (isspace(*s)) s++;
1996 for (i = 0; i < n; i++)
1997 {
1998 if (*s != '{')
1999 {
2000 if (i < m)
2001 {
2002 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2003 "(min is %d)", name, m);
2004 return 1;
2005 }
2006 sub[i] = NULL;
2007 break;
2008 }
2009 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2010 return 3;
2011 if (*s++ != '}') return 1;
2012 while (isspace(*s)) s++;
2013 }
2014 if (check_end && *s++ != '}')
2015 {
2016 if (s[-1] == '{')
2017 {
2018 expand_string_message = string_sprintf("Too many arguments for '%s' "
2019 "(max is %d)", name, n);
2020 return 2;
2021 }
2022 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2023 return 1;
2024 }
2025
2026 *sptr = s;
2027 return 0;
2028 }
2029
2030
2031
2032
2033 /*************************************************
2034 * Elaborate message for bad variable *
2035 *************************************************/
2036
2037 /* For the "unknown variable" message, take a look at the variable's name, and
2038 give additional information about possible ACL variables. The extra information
2039 is added on to expand_string_message.
2040
2041 Argument: the name of the variable
2042 Returns: nothing
2043 */
2044
2045 static void
2046 check_variable_error_message(uschar *name)
2047 {
2048 if (Ustrncmp(name, "acl_", 4) == 0)
2049 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2050 (name[4] == 'c' || name[4] == 'm')?
2051 (isalpha(name[5])?
2052 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2053 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2054 ) :
2055 US"user-defined ACL variables must start acl_c or acl_m");
2056 }
2057
2058
2059
2060 /*
2061 Load args from sub array to globals, and call acl_check().
2062 Sub array will be corrupted on return.
2063
2064 Returns: OK access is granted by an ACCEPT verb
2065 DISCARD access is (apparently) granted by a DISCARD verb
2066 FAIL access is denied
2067 FAIL_DROP access is denied; drop the connection
2068 DEFER can't tell at the moment
2069 ERROR disaster
2070 */
2071 static int
2072 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2073 {
2074 int i;
2075 int sav_narg = acl_narg;
2076 int ret;
2077 uschar * dummy_logmsg;
2078 extern int acl_where;
2079
2080 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2081 for (i = 0; i < nsub && sub[i+1]; i++)
2082 {
2083 uschar * tmp = acl_arg[i];
2084 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2085 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2086 }
2087 acl_narg = i;
2088 while (i < nsub)
2089 {
2090 sub[i+1] = acl_arg[i];
2091 acl_arg[i++] = NULL;
2092 }
2093
2094 DEBUG(D_expand)
2095 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2096 sub[0],
2097 acl_narg>0 ? acl_arg[0] : US"<none>",
2098 acl_narg>1 ? " +more" : "");
2099
2100 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2101
2102 for (i = 0; i < nsub; i++)
2103 acl_arg[i] = sub[i+1]; /* restore old args */
2104 acl_narg = sav_narg;
2105
2106 return ret;
2107 }
2108
2109
2110
2111
2112 /*************************************************
2113 * Read and evaluate a condition *
2114 *************************************************/
2115
2116 /*
2117 Arguments:
2118 s points to the start of the condition text
2119 resetok points to a BOOL which is written false if it is unsafe to
2120 free memory. Certain condition types (acl) may have side-effect
2121 allocation which must be preserved.
2122 yield points to a BOOL to hold the result of the condition test;
2123 if NULL, we are just reading through a condition that is
2124 part of an "or" combination to check syntax, or in a state
2125 where the answer isn't required
2126
2127 Returns: a pointer to the first character after the condition, or
2128 NULL after an error
2129 */
2130
2131 static const uschar *
2132 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2133 {
2134 BOOL testfor = TRUE;
2135 BOOL tempcond, combined_cond;
2136 BOOL *subcondptr;
2137 BOOL sub2_honour_dollar = TRUE;
2138 int i, rc, cond_type, roffset;
2139 int_eximarith_t num[2];
2140 struct stat statbuf;
2141 uschar name[256];
2142 const uschar *sub[10];
2143
2144 const pcre *re;
2145 const uschar *rerror;
2146
2147 for (;;)
2148 {
2149 while (isspace(*s)) s++;
2150 if (*s == '!') { testfor = !testfor; s++; } else break;
2151 }
2152
2153 /* Numeric comparisons are symbolic */
2154
2155 if (*s == '=' || *s == '>' || *s == '<')
2156 {
2157 int p = 0;
2158 name[p++] = *s++;
2159 if (*s == '=')
2160 {
2161 name[p++] = '=';
2162 s++;
2163 }
2164 name[p] = 0;
2165 }
2166
2167 /* All other conditions are named */
2168
2169 else s = read_name(name, 256, s, US"_");
2170
2171 /* If we haven't read a name, it means some non-alpha character is first. */
2172
2173 if (name[0] == 0)
2174 {
2175 expand_string_message = string_sprintf("condition name expected, "
2176 "but found \"%.16s\"", s);
2177 return NULL;
2178 }
2179
2180 /* Find which condition we are dealing with, and switch on it */
2181
2182 cond_type = chop_match(name, cond_table, nelem(cond_table));
2183 switch(cond_type)
2184 {
2185 /* def: tests for a non-empty variable, or for the existence of a header. If
2186 yield == NULL we are in a skipping state, and don't care about the answer. */
2187
2188 case ECOND_DEF:
2189 if (*s != ':')
2190 {
2191 expand_string_message = US"\":\" expected after \"def\"";
2192 return NULL;
2193 }
2194
2195 s = read_name(name, 256, s+1, US"_");
2196
2197 /* Test for a header's existence. If the name contains a closing brace
2198 character, this may be a user error where the terminating colon has been
2199 omitted. Set a flag to adjust a subsequent error message in this case. */
2200
2201 if (Ustrncmp(name, "h_", 2) == 0 ||
2202 Ustrncmp(name, "rh_", 3) == 0 ||
2203 Ustrncmp(name, "bh_", 3) == 0 ||
2204 Ustrncmp(name, "header_", 7) == 0 ||
2205 Ustrncmp(name, "rheader_", 8) == 0 ||
2206 Ustrncmp(name, "bheader_", 8) == 0)
2207 {
2208 s = read_header_name(name, 256, s);
2209 /* {-for-text-editors */
2210 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2211 if (yield != NULL) *yield =
2212 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2213 }
2214
2215 /* Test for a variable's having a non-empty value. A non-existent variable
2216 causes an expansion failure. */
2217
2218 else
2219 {
2220 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2221 if (value == NULL)
2222 {
2223 expand_string_message = (name[0] == 0)?
2224 string_sprintf("variable name omitted after \"def:\"") :
2225 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2226 check_variable_error_message(name);
2227 return NULL;
2228 }
2229 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2230 }
2231
2232 return s;
2233
2234
2235 /* first_delivery tests for first delivery attempt */
2236
2237 case ECOND_FIRST_DELIVERY:
2238 if (yield != NULL) *yield = deliver_firsttime == testfor;
2239 return s;
2240
2241
2242 /* queue_running tests for any process started by a queue runner */
2243
2244 case ECOND_QUEUE_RUNNING:
2245 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2246 return s;
2247
2248
2249 /* exists: tests for file existence
2250 isip: tests for any IP address
2251 isip4: tests for an IPv4 address
2252 isip6: tests for an IPv6 address
2253 pam: does PAM authentication
2254 radius: does RADIUS authentication
2255 ldapauth: does LDAP authentication
2256 pwcheck: does Cyrus SASL pwcheck authentication
2257 */
2258
2259 case ECOND_EXISTS:
2260 case ECOND_ISIP:
2261 case ECOND_ISIP4:
2262 case ECOND_ISIP6:
2263 case ECOND_PAM:
2264 case ECOND_RADIUS:
2265 case ECOND_LDAPAUTH:
2266 case ECOND_PWCHECK:
2267
2268 while (isspace(*s)) s++;
2269 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2270
2271 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2272 if (sub[0] == NULL) return NULL;
2273 /* {-for-text-editors */
2274 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2275
2276 if (yield == NULL) return s; /* No need to run the test if skipping */
2277
2278 switch(cond_type)
2279 {
2280 case ECOND_EXISTS:
2281 if ((expand_forbid & RDO_EXISTS) != 0)
2282 {
2283 expand_string_message = US"File existence tests are not permitted";
2284 return NULL;
2285 }
2286 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2287 break;
2288
2289 case ECOND_ISIP:
2290 case ECOND_ISIP4:
2291 case ECOND_ISIP6:
2292 rc = string_is_ip_address(sub[0], NULL);
2293 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2294 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2295 break;
2296
2297 /* Various authentication tests - all optionally compiled */
2298
2299 case ECOND_PAM:
2300 #ifdef SUPPORT_PAM
2301 rc = auth_call_pam(sub[0], &expand_string_message);
2302 goto END_AUTH;
2303 #else
2304 goto COND_FAILED_NOT_COMPILED;
2305 #endif /* SUPPORT_PAM */
2306
2307 case ECOND_RADIUS:
2308 #ifdef RADIUS_CONFIG_FILE
2309 rc = auth_call_radius(sub[0], &expand_string_message);
2310 goto END_AUTH;
2311 #else
2312 goto COND_FAILED_NOT_COMPILED;
2313 #endif /* RADIUS_CONFIG_FILE */
2314
2315 case ECOND_LDAPAUTH:
2316 #ifdef LOOKUP_LDAP
2317 {
2318 /* Just to keep the interface the same */
2319 BOOL do_cache;
2320 int old_pool = store_pool;
2321 store_pool = POOL_SEARCH;
2322 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2323 &expand_string_message, &do_cache);
2324 store_pool = old_pool;
2325 }
2326 goto END_AUTH;
2327 #else
2328 goto COND_FAILED_NOT_COMPILED;
2329 #endif /* LOOKUP_LDAP */
2330
2331 case ECOND_PWCHECK:
2332 #ifdef CYRUS_PWCHECK_SOCKET
2333 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2334 goto END_AUTH;
2335 #else
2336 goto COND_FAILED_NOT_COMPILED;
2337 #endif /* CYRUS_PWCHECK_SOCKET */
2338
2339 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2340 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2341 END_AUTH:
2342 if (rc == ERROR || rc == DEFER) return NULL;
2343 *yield = (rc == OK) == testfor;
2344 #endif
2345 }
2346 return s;
2347
2348
2349 /* call ACL (in a conditional context). Accept true, deny false.
2350 Defer is a forced-fail. Anything set by message= goes to $value.
2351 Up to ten parameters are used; we use the braces round the name+args
2352 like the saslauthd condition does, to permit a variable number of args.
2353 See also the expansion-item version EITEM_ACL and the traditional
2354 acl modifier ACLC_ACL.
2355 Since the ACL may allocate new global variables, tell our caller to not
2356 reclaim memory.
2357 */
2358
2359 case ECOND_ACL:
2360 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2361 {
2362 uschar *sub[10];
2363 uschar *user_msg;
2364 BOOL cond = FALSE;
2365 int size = 0;
2366 int ptr = 0;
2367
2368 while (isspace(*s)) s++;
2369 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2370
2371 switch(read_subs(sub, nelem(sub), 1,
2372 &s, yield == NULL, TRUE, US"acl", resetok))
2373 {
2374 case 1: expand_string_message = US"too few arguments or bracketing "
2375 "error for acl";
2376 case 2:
2377 case 3: return NULL;
2378 }
2379
2380 if (yield != NULL)
2381 {
2382 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2383 switch(eval_acl(sub, nelem(sub), &user_msg))
2384 {
2385 case OK:
2386 cond = TRUE;
2387 case FAIL:
2388 lookup_value = NULL;
2389 if (user_msg)
2390 {
2391 lookup_value = string_cat(NULL, &size, &ptr, user_msg);
2392 lookup_value[ptr] = '\0';
2393 }
2394 *yield = cond == testfor;
2395 break;
2396
2397 case DEFER:
2398 expand_string_forcedfail = TRUE;
2399 /*FALLTHROUGH*/
2400 default:
2401 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2402 return NULL;
2403 }
2404 }
2405 return s;
2406 }
2407
2408
2409 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2410
2411 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2412
2413 However, the last two are optional. That is why the whole set is enclosed
2414 in their own set of braces. */
2415
2416 case ECOND_SASLAUTHD:
2417 #ifndef CYRUS_SASLAUTHD_SOCKET
2418 goto COND_FAILED_NOT_COMPILED;
2419 #else
2420 {
2421 uschar *sub[4];
2422 while (isspace(*s)) s++;
2423 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2424 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2425 resetok))
2426 {
2427 case 1: expand_string_message = US"too few arguments or bracketing "
2428 "error for saslauthd";
2429 case 2:
2430 case 3: return NULL;
2431 }
2432 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2433 if (yield != NULL)
2434 {
2435 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2436 &expand_string_message);
2437 if (rc == ERROR || rc == DEFER) return NULL;
2438 *yield = (rc == OK) == testfor;
2439 }
2440 return s;
2441 }
2442 #endif /* CYRUS_SASLAUTHD_SOCKET */
2443
2444
2445 /* symbolic operators for numeric and string comparison, and a number of
2446 other operators, all requiring two arguments.
2447
2448 crypteq: encrypts plaintext and compares against an encrypted text,
2449 using crypt(), crypt16(), MD5 or SHA-1
2450 inlist/inlisti: checks if first argument is in the list of the second
2451 match: does a regular expression match and sets up the numerical
2452 variables if it succeeds
2453 match_address: matches in an address list
2454 match_domain: matches in a domain list
2455 match_ip: matches a host list that is restricted to IP addresses
2456 match_local_part: matches in a local part list
2457 */
2458
2459 case ECOND_MATCH_ADDRESS:
2460 case ECOND_MATCH_DOMAIN:
2461 case ECOND_MATCH_IP:
2462 case ECOND_MATCH_LOCAL_PART:
2463 #ifndef EXPAND_LISTMATCH_RHS
2464 sub2_honour_dollar = FALSE;
2465 #endif
2466 /* FALLTHROUGH */
2467
2468 case ECOND_CRYPTEQ:
2469 case ECOND_INLIST:
2470 case ECOND_INLISTI:
2471 case ECOND_MATCH:
2472
2473 case ECOND_NUM_L: /* Numerical comparisons */
2474 case ECOND_NUM_LE:
2475 case ECOND_NUM_E:
2476 case ECOND_NUM_EE:
2477 case ECOND_NUM_G:
2478 case ECOND_NUM_GE:
2479
2480 case ECOND_STR_LT: /* String comparisons */
2481 case ECOND_STR_LTI:
2482 case ECOND_STR_LE:
2483 case ECOND_STR_LEI:
2484 case ECOND_STR_EQ:
2485 case ECOND_STR_EQI:
2486 case ECOND_STR_GT:
2487 case ECOND_STR_GTI:
2488 case ECOND_STR_GE:
2489 case ECOND_STR_GEI:
2490
2491 for (i = 0; i < 2; i++)
2492 {
2493 /* Sometimes, we don't expand substrings; too many insecure configurations
2494 created using match_address{}{} and friends, where the second param
2495 includes information from untrustworthy sources. */
2496 BOOL honour_dollar = TRUE;
2497 if ((i > 0) && !sub2_honour_dollar)
2498 honour_dollar = FALSE;
2499
2500 while (isspace(*s)) s++;
2501 if (*s != '{')
2502 {
2503 if (i == 0) goto COND_FAILED_CURLY_START;
2504 expand_string_message = string_sprintf("missing 2nd string in {} "
2505 "after \"%s\"", name);
2506 return NULL;
2507 }
2508 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2509 honour_dollar, resetok);
2510 if (sub[i] == NULL) return NULL;
2511 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2512
2513 /* Convert to numerical if required; we know that the names of all the
2514 conditions that compare numbers do not start with a letter. This just saves
2515 checking for them individually. */
2516
2517 if (!isalpha(name[0]) && yield != NULL)
2518 if (sub[i][0] == 0)
2519 {
2520 num[i] = 0;
2521 DEBUG(D_expand)
2522 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2523 }
2524 else
2525 {
2526 num[i] = expanded_string_integer(sub[i], FALSE);
2527 if (expand_string_message != NULL) return NULL;
2528 }
2529 }
2530
2531 /* Result not required */
2532
2533 if (yield == NULL) return s;
2534
2535 /* Do an appropriate comparison */
2536
2537 switch(cond_type)
2538 {
2539 case ECOND_NUM_E:
2540 case ECOND_NUM_EE:
2541 tempcond = (num[0] == num[1]);
2542 break;
2543
2544 case ECOND_NUM_G:
2545 tempcond = (num[0] > num[1]);
2546 break;
2547
2548 case ECOND_NUM_GE:
2549 tempcond = (num[0] >= num[1]);
2550 break;
2551
2552 case ECOND_NUM_L:
2553 tempcond = (num[0] < num[1]);
2554 break;
2555
2556 case ECOND_NUM_LE:
2557 tempcond = (num[0] <= num[1]);
2558 break;
2559
2560 case ECOND_STR_LT:
2561 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2562 break;
2563
2564 case ECOND_STR_LTI:
2565 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2566 break;
2567
2568 case ECOND_STR_LE:
2569 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2570 break;
2571
2572 case ECOND_STR_LEI:
2573 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2574 break;
2575
2576 case ECOND_STR_EQ:
2577 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2578 break;
2579
2580 case ECOND_STR_EQI:
2581 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2582 break;
2583
2584 case ECOND_STR_GT:
2585 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2586 break;
2587
2588 case ECOND_STR_GTI:
2589 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2590 break;
2591
2592 case ECOND_STR_GE:
2593 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2594 break;
2595
2596 case ECOND_STR_GEI:
2597 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2598 break;
2599
2600 case ECOND_MATCH: /* Regular expression match */
2601 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2602 NULL);
2603 if (re == NULL)
2604 {
2605 expand_string_message = string_sprintf("regular expression error in "
2606 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2607 return NULL;
2608 }
2609 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2610 break;
2611
2612 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2613 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2614 goto MATCHED_SOMETHING;
2615
2616 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2617 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2618 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2619 goto MATCHED_SOMETHING;
2620
2621 case ECOND_MATCH_IP: /* Match IP address in a host list */
2622 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2623 {
2624 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2625 sub[0]);
2626 return NULL;
2627 }
2628 else
2629 {
2630 unsigned int *nullcache = NULL;
2631 check_host_block cb;
2632
2633 cb.host_name = US"";
2634 cb.host_address = sub[0];
2635
2636 /* If the host address starts off ::ffff: it is an IPv6 address in
2637 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2638 addresses. */
2639
2640 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2641 cb.host_address + 7 : cb.host_address;
2642
2643 rc = match_check_list(
2644 &sub[1], /* the list */
2645 0, /* separator character */
2646 &hostlist_anchor, /* anchor pointer */
2647 &nullcache, /* cache pointer */
2648 check_host, /* function for testing */
2649 &cb, /* argument for function */
2650 MCL_HOST, /* type of check */
2651 sub[0], /* text for debugging */
2652 NULL); /* where to pass back data */
2653 }
2654 goto MATCHED_SOMETHING;
2655
2656 case ECOND_MATCH_LOCAL_PART:
2657 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2658 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2659 /* Fall through */
2660 /* VVVVVVVVVVVV */
2661 MATCHED_SOMETHING:
2662 switch(rc)
2663 {
2664 case OK:
2665 tempcond = TRUE;
2666 break;
2667
2668 case FAIL:
2669 tempcond = FALSE;
2670 break;
2671
2672 case DEFER:
2673 expand_string_message = string_sprintf("unable to complete match "
2674 "against \"%s\": %s", sub[1], search_error_message);
2675 return NULL;
2676 }
2677
2678 break;
2679
2680 /* Various "encrypted" comparisons. If the second string starts with
2681 "{" then an encryption type is given. Default to crypt() or crypt16()
2682 (build-time choice). */
2683 /* }-for-text-editors */
2684
2685 case ECOND_CRYPTEQ:
2686 #ifndef SUPPORT_CRYPTEQ
2687 goto COND_FAILED_NOT_COMPILED;
2688 #else
2689 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2690 {
2691 int sublen = Ustrlen(sub[1]+5);
2692 md5 base;
2693 uschar digest[16];
2694
2695 md5_start(&base);
2696 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2697
2698 /* If the length that we are comparing against is 24, the MD5 digest
2699 is expressed as a base64 string. This is the way LDAP does it. However,
2700 some other software uses a straightforward hex representation. We assume
2701 this if the length is 32. Other lengths fail. */
2702
2703 if (sublen == 24)
2704 {
2705 uschar *coded = b64encode(digest, 16);
2706 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2707 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2708 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2709 }
2710 else if (sublen == 32)
2711 {
2712 int i;
2713 uschar coded[36];
2714 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2715 coded[32] = 0;
2716 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2717 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2718 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2719 }
2720 else
2721 {
2722 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2723 "fail\n crypted=%s\n", sub[1]+5);
2724 tempcond = FALSE;
2725 }
2726 }
2727
2728 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2729 {
2730 int sublen = Ustrlen(sub[1]+6);
2731 hctx h;
2732 uschar digest[20];
2733
2734 sha1_start(&h);
2735 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2736
2737 /* If the length that we are comparing against is 28, assume the SHA1
2738 digest is expressed as a base64 string. If the length is 40, assume a
2739 straightforward hex representation. Other lengths fail. */
2740
2741 if (sublen == 28)
2742 {
2743 uschar *coded = b64encode(digest, 20);
2744 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2745 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2746 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2747 }
2748 else if (sublen == 40)
2749 {
2750 int i;
2751 uschar coded[44];
2752 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2753 coded[40] = 0;
2754 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2755 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2756 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2757 }
2758 else
2759 {
2760 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2761 "fail\n crypted=%s\n", sub[1]+6);
2762 tempcond = FALSE;
2763 }
2764 }
2765
2766 else /* {crypt} or {crypt16} and non-{ at start */
2767 /* }-for-text-editors */
2768 {
2769 int which = 0;
2770 uschar *coded;
2771
2772 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2773 {
2774 sub[1] += 7;
2775 which = 1;
2776 }
2777 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2778 {
2779 sub[1] += 9;
2780 which = 2;
2781 }
2782 else if (sub[1][0] == '{') /* }-for-text-editors */
2783 {
2784 expand_string_message = string_sprintf("unknown encryption mechanism "
2785 "in \"%s\"", sub[1]);
2786 return NULL;
2787 }
2788
2789 switch(which)
2790 {
2791 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2792 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2793 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2794 }
2795
2796 #define STR(s) # s
2797 #define XSTR(s) STR(s)
2798 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2799 " subject=%s\n crypted=%s\n",
2800 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2801 coded, sub[1]);
2802 #undef STR
2803 #undef XSTR
2804
2805 /* If the encrypted string contains fewer than two characters (for the
2806 salt), force failure. Otherwise we get false positives: with an empty
2807 string the yield of crypt() is an empty string! */
2808
2809 if (coded)
2810 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2811 else if (errno == EINVAL)
2812 tempcond = FALSE;
2813 else
2814 {
2815 expand_string_message = string_sprintf("crypt error: %s\n",
2816 US strerror(errno));
2817 return NULL;
2818 }
2819 }
2820 break;
2821 #endif /* SUPPORT_CRYPTEQ */
2822
2823 case ECOND_INLIST:
2824 case ECOND_INLISTI:
2825 {
2826 const uschar * list = sub[1];
2827 int sep = 0;
2828 uschar *save_iterate_item = iterate_item;
2829 int (*compare)(const uschar *, const uschar *);
2830
2831 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2832
2833 tempcond = FALSE;
2834 compare = cond_type == ECOND_INLISTI
2835 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2836
2837 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2838 if (compare(sub[0], iterate_item) == 0)
2839 {
2840 tempcond = TRUE;
2841 break;
2842 }
2843 iterate_item = save_iterate_item;
2844 }
2845
2846 } /* Switch for comparison conditions */
2847
2848 *yield = tempcond == testfor;
2849 return s; /* End of comparison conditions */
2850
2851
2852 /* and/or: computes logical and/or of several conditions */
2853
2854 case ECOND_AND:
2855 case ECOND_OR:
2856 subcondptr = (yield == NULL)? NULL : &tempcond;
2857 combined_cond = (cond_type == ECOND_AND);
2858
2859 while (isspace(*s)) s++;
2860 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2861
2862 for (;;)
2863 {
2864 while (isspace(*s)) s++;
2865 /* {-for-text-editors */
2866 if (*s == '}') break;
2867 if (*s != '{') /* }-for-text-editors */
2868 {
2869 expand_string_message = string_sprintf("each subcondition "
2870 "inside an \"%s{...}\" condition must be in its own {}", name);
2871 return NULL;
2872 }
2873
2874 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2875 {
2876 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2877 expand_string_message, name);
2878 return NULL;
2879 }
2880 while (isspace(*s)) s++;
2881
2882 /* {-for-text-editors */
2883 if (*s++ != '}')
2884 {
2885 /* {-for-text-editors */
2886 expand_string_message = string_sprintf("missing } at end of condition "
2887 "inside \"%s\" group", name);
2888 return NULL;
2889 }
2890
2891 if (yield != NULL)
2892 {
2893 if (cond_type == ECOND_AND)
2894 {
2895 combined_cond &= tempcond;
2896 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2897 } /* evaluate any more */
2898 else
2899 {
2900 combined_cond |= tempcond;
2901 if (combined_cond) subcondptr = NULL; /* once true, don't */
2902 } /* evaluate any more */
2903 }
2904 }
2905
2906 if (yield != NULL) *yield = (combined_cond == testfor);
2907 return ++s;
2908
2909
2910 /* forall/forany: iterates a condition with different values */
2911
2912 case ECOND_FORALL:
2913 case ECOND_FORANY:
2914 {
2915 const uschar * list;
2916 int sep = 0;
2917 uschar *save_iterate_item = iterate_item;
2918
2919 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2920
2921 while (isspace(*s)) s++;
2922 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2923 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2924 if (sub[0] == NULL) return NULL;
2925 /* {-for-text-editors */
2926 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2927
2928 while (isspace(*s)) s++;
2929 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2930
2931 sub[1] = s;
2932
2933 /* Call eval_condition once, with result discarded (as if scanning a
2934 "false" part). This allows us to find the end of the condition, because if
2935 the list it empty, we won't actually evaluate the condition for real. */
2936
2937 if (!(s = eval_condition(sub[1], resetok, NULL)))
2938 {
2939 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2940 expand_string_message, name);
2941 return NULL;
2942 }
2943 while (isspace(*s)) s++;
2944
2945 /* {-for-text-editors */
2946 if (*s++ != '}')
2947 {
2948 /* {-for-text-editors */
2949 expand_string_message = string_sprintf("missing } at end of condition "
2950 "inside \"%s\"", name);
2951 return NULL;
2952 }
2953
2954 if (yield != NULL) *yield = !testfor;
2955 list = sub[0];
2956 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2957 {
2958 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, iterate_item);
2959 if (!eval_condition(sub[1], resetok, &tempcond))
2960 {
2961 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2962 expand_string_message, name);
2963 iterate_item = save_iterate_item;
2964 return NULL;
2965 }
2966 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", name,
2967 tempcond? "true":"false");
2968
2969 if (yield != NULL) *yield = (tempcond == testfor);
2970 if (tempcond == (cond_type == ECOND_FORANY)) break;
2971 }
2972
2973 iterate_item = save_iterate_item;
2974 return s;
2975 }
2976
2977
2978 /* The bool{} expansion condition maps a string to boolean.
2979 The values supported should match those supported by the ACL condition
2980 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2981 of true/false. Note that Router "condition" rules have a different
2982 interpretation, where general data can be used and only a few values
2983 map to FALSE.
2984 Note that readconf.c boolean matching, for boolean configuration options,
2985 only matches true/yes/false/no.
2986 The bool_lax{} condition matches the Router logic, which is much more
2987 liberal. */
2988 case ECOND_BOOL:
2989 case ECOND_BOOL_LAX:
2990 {
2991 uschar *sub_arg[1];
2992 uschar *t, *t2;
2993 uschar *ourname;
2994 size_t len;
2995 BOOL boolvalue = FALSE;
2996 while (isspace(*s)) s++;
2997 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2998 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2999 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3000 {
3001 case 1: expand_string_message = string_sprintf(
3002 "too few arguments or bracketing error for %s",
3003 ourname);
3004 /*FALLTHROUGH*/
3005 case 2:
3006 case 3: return NULL;
3007 }
3008 t = sub_arg[0];
3009 while (isspace(*t)) t++;
3010 len = Ustrlen(t);
3011 if (len)
3012 {
3013 /* trailing whitespace: seems like a good idea to ignore it too */
3014 t2 = t + len - 1;
3015 while (isspace(*t2)) t2--;
3016 if (t2 != (t + len))
3017 {
3018 *++t2 = '\0';
3019 len = t2 - t;
3020 }
3021 }
3022 DEBUG(D_expand)
3023 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3024 /* logic for the lax case from expand_check_condition(), which also does
3025 expands, and the logic is both short and stable enough that there should
3026 be no maintenance burden from replicating it. */
3027 if (len == 0)
3028 boolvalue = FALSE;
3029 else if (*t == '-'
3030 ? Ustrspn(t+1, "0123456789") == len-1
3031 : Ustrspn(t, "0123456789") == len)
3032 {
3033 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3034 /* expand_check_condition only does a literal string "0" check */
3035 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3036 boolvalue = TRUE;
3037 }
3038 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3039 boolvalue = TRUE;
3040 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3041 boolvalue = FALSE;
3042 else if (cond_type == ECOND_BOOL_LAX)
3043 boolvalue = TRUE;
3044 else
3045 {
3046 expand_string_message = string_sprintf("unrecognised boolean "
3047 "value \"%s\"", t);
3048 return NULL;
3049 }
3050 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3051 boolvalue? "true":"false");
3052 if (yield != NULL) *yield = (boolvalue == testfor);
3053 return s;
3054 }
3055
3056 /* Unknown condition */
3057
3058 default:
3059 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3060 return NULL;
3061 } /* End switch on condition type */
3062
3063 /* Missing braces at start and end of data */
3064
3065 COND_FAILED_CURLY_START:
3066 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3067 return NULL;
3068
3069 COND_FAILED_CURLY_END:
3070 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3071 name);
3072 return NULL;
3073
3074 /* A condition requires code that is not compiled */
3075
3076 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3077 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3078 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3079 COND_FAILED_NOT_COMPILED:
3080 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3081 name);
3082 return NULL;
3083 #endif
3084 }
3085
3086
3087
3088
3089 /*************************************************
3090 * Save numerical variables *
3091 *************************************************/
3092
3093 /* This function is called from items such as "if" that want to preserve and
3094 restore the numbered variables.
3095
3096 Arguments:
3097 save_expand_string points to an array of pointers to set
3098 save_expand_nlength points to an array of ints for the lengths
3099
3100 Returns: the value of expand max to save
3101 */
3102
3103 static int
3104 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3105 {
3106 int i;
3107 for (i = 0; i <= expand_nmax; i++)
3108 {
3109 save_expand_nstring[i] = expand_nstring[i];
3110 save_expand_nlength[i] = expand_nlength[i];
3111 }
3112 return expand_nmax;
3113 }
3114
3115
3116
3117 /*************************************************
3118 * Restore numerical variables *
3119 *************************************************/
3120
3121 /* This function restored saved values of numerical strings.
3122
3123 Arguments:
3124 save_expand_nmax the number of strings to restore
3125 save_expand_string points to an array of pointers
3126 save_expand_nlength points to an array of ints
3127
3128 Returns: nothing
3129 */
3130
3131 static void
3132 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3133 int *save_expand_nlength)
3134 {
3135 int i;
3136 expand_nmax = save_expand_nmax;
3137 for (i = 0; i <= expand_nmax; i++)
3138 {
3139 expand_nstring[i] = save_expand_nstring[i];
3140 expand_nlength[i] = save_expand_nlength[i];
3141 }
3142 }
3143
3144
3145
3146
3147
3148 /*************************************************
3149 * Handle yes/no substrings *
3150 *************************************************/
3151
3152 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3153 alternative substrings that depend on whether or not the condition was true,
3154 or the lookup or extraction succeeded. The substrings always have to be
3155 expanded, to check their syntax, but "skipping" is set when the result is not
3156 needed - this avoids unnecessary nested lookups.
3157
3158 Arguments:
3159 skipping TRUE if we were skipping when this item was reached
3160 yes TRUE if the first string is to be used, else use the second
3161 save_lookup a value to put back into lookup_value before the 2nd expansion
3162 sptr points to the input string pointer
3163 yieldptr points to the output string pointer
3164 sizeptr points to the output string size
3165 ptrptr points to the output string pointer
3166 type "lookup", "if", "extract", "run", "env", "listextract" or
3167 "certextract" for error message
3168 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3169 the store.
3170
3171 Returns: 0 OK; lookup_value has been reset to save_lookup
3172 1 expansion failed
3173 2 expansion failed because of bracketing error
3174 */
3175
3176 static int
3177 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3178 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3179 {
3180 int rc = 0;
3181 const uschar *s = *sptr; /* Local value */
3182 uschar *sub1, *sub2;
3183 const uschar * errwhere;
3184
3185 /* If there are no following strings, we substitute the contents of $value for
3186 lookups and for extractions in the success case. For the ${if item, the string
3187 "true" is substituted. In the fail case, nothing is substituted for all three
3188 items. */
3189
3190 while (isspace(*s)) s++;
3191 if (*s == '}')
3192 {
3193 if (type[0] == 'i')
3194 {
3195 if (yes && !skipping)
3196 *yieldptr = string_catn(*yieldptr, sizeptr, ptrptr, US"true", 4);
3197 }
3198 else
3199 {
3200 if (yes && lookup_value && !skipping)
3201 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value);
3202 lookup_value = save_lookup;
3203 }
3204 s++;
3205 goto RETURN;
3206 }
3207
3208 /* The first following string must be braced. */
3209
3210 if (*s++ != '{')
3211 {
3212 errwhere = US"'yes' part did not start with '{'";
3213 goto FAILED_CURLY;
3214 }
3215
3216 /* Expand the first substring. Forced failures are noticed only if we actually
3217 want this string. Set skipping in the call in the fail case (this will always
3218 be the case if we were already skipping). */
3219
3220 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3221 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3222 expand_string_forcedfail = FALSE;
3223 if (*s++ != '}')
3224 {
3225 errwhere = US"'yes' part did not end with '}'";
3226 goto FAILED_CURLY;
3227 }
3228
3229 /* If we want the first string, add it to the output */
3230
3231 if (yes)
3232 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1);
3233
3234 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3235 $value to what it was at the start of the item, so that it has this value
3236 during the second string expansion. For the call from "if" or "run" to this
3237 function, save_lookup is set to lookup_value, so that this statement does
3238 nothing. */
3239
3240 lookup_value = save_lookup;
3241
3242 /* There now follows either another substring, or "fail", or nothing. This
3243 time, forced failures are noticed only if we want the second string. We must
3244 set skipping in the nested call if we don't want this string, or if we were
3245 already skipping. */
3246
3247 while (isspace(*s)) s++;
3248 if (*s == '{')
3249 {
3250 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3251 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3252 expand_string_forcedfail = FALSE;
3253 if (*s++ != '}')
3254 {
3255 errwhere = US"'no' part did not start with '{'";
3256 goto FAILED_CURLY;
3257 }
3258
3259 /* If we want the second string, add it to the output */
3260
3261 if (!yes)
3262 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2);
3263 }
3264
3265 /* If there is no second string, but the word "fail" is present when the use of
3266 the second string is wanted, set a flag indicating it was a forced failure
3267 rather than a syntactic error. Swallow the terminating } in case this is nested
3268 inside another lookup or if or extract. */
3269
3270 else if (*s != '}')
3271 {
3272 uschar name[256];
3273 /* deconst cast ok here as source is s anyway */
3274 s = US read_name(name, sizeof(name), s, US"_");
3275 if (Ustrcmp(name, "fail") == 0)
3276 {
3277 if (!yes && !skipping)
3278 {
3279 while (isspace(*s)) s++;
3280 if (*s++ != '}')
3281 {
3282 errwhere = US"did not close with '}' after forcedfail";
3283 goto FAILED_CURLY;
3284 }
3285 expand_string_message =
3286 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3287 expand_string_forcedfail = TRUE;
3288 goto FAILED;
3289 }
3290 }
3291 else
3292 {
3293 expand_string_message =
3294 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3295 goto FAILED;
3296 }
3297 }
3298
3299 /* All we have to do now is to check on the final closing brace. */
3300
3301 while (isspace(*s)) s++;
3302 if (*s++ != '}')
3303 {
3304 errwhere = US"did not close with '}'";
3305 goto FAILED_CURLY;
3306 }
3307
3308
3309 RETURN:
3310 /* Update the input pointer value before returning */
3311 *sptr = s;
3312 return rc;
3313
3314 FAILED_CURLY:
3315 /* Get here if there is a bracketing failure */
3316 expand_string_message = string_sprintf(
3317 "curly-bracket problem in conditional yes/no parsing: %s\n"
3318 " remaining string is '%s'", errwhere, --s);
3319 rc = 2;
3320 goto RETURN;
3321
3322 FAILED:
3323 /* Get here for other failures */
3324 rc = 1;
3325 goto RETURN;
3326 }
3327
3328
3329
3330
3331 /*************************************************
3332 * Handle MD5 or SHA-1 computation for HMAC *
3333 *************************************************/
3334
3335 /* These are some wrapping functions that enable the HMAC code to be a bit
3336 cleaner. A good compiler will spot the tail recursion.
3337
3338 Arguments:
3339 type HMAC_MD5 or HMAC_SHA1
3340 remaining are as for the cryptographic hash functions
3341
3342 Returns: nothing
3343 */
3344
3345 static void
3346 chash_start(int type, void *base)
3347 {
3348 if (type == HMAC_MD5)
3349 md5_start((md5 *)base);
3350 else
3351 sha1_start((hctx *)base);
3352 }
3353
3354 static void
3355 chash_mid(int type, void *base, uschar *string)
3356 {
3357 if (type == HMAC_MD5)
3358 md5_mid((md5 *)base, string);
3359 else
3360 sha1_mid((hctx *)base, string);
3361 }
3362
3363 static void
3364 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3365 {
3366 if (type == HMAC_MD5)
3367 md5_end((md5 *)base, string, length, digest);
3368 else
3369 sha1_end((hctx *)base, string, length, digest);
3370 }
3371
3372
3373
3374
3375
3376 /********************************************************
3377 * prvs: Get last three digits of days since Jan 1, 1970 *
3378 ********************************************************/
3379
3380 /* This is needed to implement the "prvs" BATV reverse
3381 path signing scheme
3382
3383 Argument: integer "days" offset to add or substract to
3384 or from the current number of days.
3385
3386 Returns: pointer to string containing the last three
3387 digits of the number of days since Jan 1, 1970,
3388 modified by the offset argument, NULL if there
3389 was an error in the conversion.
3390
3391 */
3392
3393 static uschar *
3394 prvs_daystamp(int day_offset)
3395 {
3396 uschar *days = store_get(32); /* Need at least 24 for cases */
3397 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3398 (time(NULL) + day_offset*86400)/86400);
3399 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3400 }
3401
3402
3403
3404 /********************************************************
3405 * prvs: perform HMAC-SHA1 computation of prvs bits *
3406 ********************************************************/
3407
3408 /* This is needed to implement the "prvs" BATV reverse
3409 path signing scheme
3410
3411 Arguments:
3412 address RFC2821 Address to use
3413 key The key to use (must be less than 64 characters
3414 in size)
3415 key_num Single-digit key number to use. Defaults to
3416 '0' when NULL.
3417
3418 Returns: pointer to string containing the first three
3419 bytes of the final hash in hex format, NULL if
3420 there was an error in the process.
3421 */
3422
3423 static uschar *
3424 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3425 {
3426 uschar *hash_source, *p;
3427 int size = 0,offset = 0,i;
3428 hctx h;
3429 uschar innerhash[20];
3430 uschar finalhash[20];
3431 uschar innerkey[64];
3432 uschar outerkey[64];
3433 uschar *finalhash_hex = store_get(40);
3434
3435 if (key_num == NULL)
3436 key_num = US"0";
3437
3438 if (Ustrlen(key) > 64)
3439 return NULL;
3440
3441 hash_source = string_catn(NULL, &size, &offset, key_num, 1);
3442 hash_source = string_catn(hash_source, &size, &offset, daystamp, 3);
3443 hash_source = string_cat(hash_source, &size, &offset, address);
3444 hash_source[offset] = '\0';
3445
3446 DEBUG(D_expand) debug_printf_indent("prvs: hash source is '%s'\n", hash_source);
3447
3448 memset(innerkey, 0x36, 64);
3449 memset(outerkey, 0x5c, 64);
3450
3451 for (i = 0; i < Ustrlen(key); i++)
3452 {
3453 innerkey[i] ^= key[i];
3454 outerkey[i] ^= key[i];
3455 }
3456
3457 chash_start(HMAC_SHA1, &h);
3458 chash_mid(HMAC_SHA1, &h, innerkey);
3459 chash_end(HMAC_SHA1, &h, hash_source, offset, innerhash);
3460
3461 chash_start(HMAC_SHA1, &h);
3462 chash_mid(HMAC_SHA1, &h, outerkey);
3463 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3464
3465 p = finalhash_hex;
3466 for (i = 0; i < 3; i++)
3467 {
3468 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3469 *p++ = hex_digits[finalhash[i] & 0x0f];
3470 }
3471 *p = '\0';
3472
3473 return finalhash_hex;
3474 }
3475
3476
3477
3478
3479 /*************************************************
3480 * Join a file onto the output string *
3481 *************************************************/
3482
3483 /* This is used for readfile/readsock and after a run expansion.
3484 It joins the contents of a file onto the output string, globally replacing
3485 newlines with a given string (optionally).
3486
3487 Arguments:
3488 f the FILE
3489 yield pointer to the expandable string
3490 sizep pointer to the current size
3491 ptrp pointer to the current position
3492 eol newline replacement string, or NULL
3493
3494 Returns: new value of string pointer
3495 */
3496
3497 static uschar *
3498 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3499 {
3500 uschar buffer[1024];
3501
3502 while (Ufgets(buffer, sizeof(buffer), f))
3503 {
3504 int len = Ustrlen(buffer);
3505 if (eol && buffer[len-1] == '\n') len--;
3506 yield = string_catn(yield, sizep, ptrp, buffer, len);
3507 if (eol && buffer[len])
3508 yield = string_cat(yield, sizep, ptrp, eol);
3509 }
3510
3511 if (yield) yield[*ptrp] = 0;
3512
3513 return yield;
3514 }
3515
3516
3517
3518
3519 /*************************************************
3520 * Evaluate numeric expression *
3521 *************************************************/
3522
3523 /* This is a set of mutually recursive functions that evaluate an arithmetic
3524 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3525 these functions that is called from elsewhere is eval_expr, whose interface is:
3526
3527 Arguments:
3528 sptr pointer to the pointer to the string - gets updated
3529 decimal TRUE if numbers are to be assumed decimal
3530 error pointer to where to put an error message - must be NULL on input
3531 endket TRUE if ')' must terminate - FALSE for external call
3532
3533 Returns: on success: the value of the expression, with *error still NULL
3534 on failure: an undefined value, with *error = a message
3535 */
3536
3537 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3538
3539
3540 static int_eximarith_t
3541 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3542 {
3543 uschar *s = *sptr;
3544 int_eximarith_t x = eval_op_or(&s, decimal, error);
3545 if (*error == NULL)
3546 {
3547 if (endket)
3548 {
3549 if (*s != ')')
3550 *error = US"expecting closing parenthesis";
3551 else
3552 while (isspace(*(++s)));
3553 }
3554 else if (*s != 0) *error = US"expecting operator";
3555 }
3556 *sptr = s;
3557 return x;
3558 }
3559
3560
3561 static int_eximarith_t
3562 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3563 {
3564 register int c;
3565 int_eximarith_t n;
3566 uschar *s = *sptr;
3567 while (isspace(*s)) s++;
3568 c = *s;
3569 if (isdigit(c))
3570 {
3571 int count;
3572 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3573 s += count;
3574 switch (tolower(*s))
3575 {
3576 default: break;
3577 case 'k': n *= 1024; s++; break;
3578 case 'm': n *= 1024*1024; s++; break;
3579 case 'g': n *= 1024*1024*1024; s++; break;
3580 }
3581 while (isspace (*s)) s++;
3582 }
3583 else if (c == '(')
3584 {
3585 s++;
3586 n = eval_expr(&s, decimal, error, 1);
3587 }
3588 else
3589 {
3590 *error = US"expecting number or opening parenthesis";
3591 n = 0;
3592 }
3593 *sptr = s;
3594 return n;
3595 }
3596
3597
3598 static int_eximarith_t
3599 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3600 {
3601 uschar *s = *sptr;
3602 int_eximarith_t x;
3603 while (isspace(*s)) s++;
3604 if (*s == '+' || *s == '-' || *s == '~')
3605 {
3606 int op = *s++;
3607 x = eval_op_unary(&s, decimal, error);
3608 if (op == '-') x = -x;
3609 else if (op == '~') x = ~x;
3610 }
3611 else
3612 {
3613 x = eval_number(&s, decimal, error);
3614 }
3615 *sptr = s;
3616 return x;
3617 }
3618
3619
3620 static int_eximarith_t
3621 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3622 {
3623 uschar *s = *sptr;
3624 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3625 if (*error == NULL)
3626 {
3627 while (*s == '*' || *s == '/' || *s == '%')
3628 {
3629 int op = *s++;
3630 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3631 if (*error != NULL) break;
3632 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3633 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3634 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3635 * -N*M is INT_MIN will yield INT_MIN.
3636 * Since we don't support floating point, this is somewhat simpler.
3637 * Ideally, we'd return an error, but since we overflow for all other
3638 * arithmetic, consistency suggests otherwise, but what's the correct value
3639 * to use? There is none.
3640 * The C standard guarantees overflow for unsigned arithmetic but signed
3641 * overflow invokes undefined behaviour; in practice, this is overflow
3642 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3643 * that long/longlong larger than int are available, or we could just work
3644 * with larger types. We should consider whether to guarantee 32bit eval
3645 * and 64-bit working variables, with errors returned. For now ...
3646 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3647 * can just let the other invalid results occur otherwise, as they have
3648 * until now. For this one case, we can coerce.
3649 */
3650 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3651 {
3652 DEBUG(D_expand)
3653 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3654 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3655 x = EXIM_ARITH_MAX;
3656 continue;
3657 }
3658 if (op == '*')
3659 x *= y;
3660 else
3661 {
3662 if (y == 0)
3663 {
3664 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3665 x = 0;
3666 break;
3667 }
3668 if (op == '/')
3669 x /= y;
3670 else
3671 x %= y;
3672 }
3673 }
3674 }
3675 *sptr = s;
3676 return x;
3677 }
3678
3679
3680 static int_eximarith_t
3681 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3682 {
3683 uschar *s = *sptr;
3684 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3685 if (!*error)
3686 {
3687 while (*s == '+' || *s == '-')
3688 {
3689 int op = *s++;
3690 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3691 if (*error) break;
3692 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3693 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3694 { /* over-conservative check */
3695 *error = op == '+'
3696 ? US"overflow in sum" : US"overflow in difference";
3697 break;
3698 }
3699 if (op == '+') x += y; else x -= y;
3700 }
3701 }
3702 *sptr = s;
3703 return x;
3704 }
3705
3706
3707 static int_eximarith_t
3708 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3709 {
3710 uschar *s = *sptr;
3711 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3712 if (*error == NULL)
3713 {
3714 while ((*s == '<' || *s == '>') && s[1] == s[0])
3715 {
3716 int_eximarith_t y;
3717 int op = *s++;
3718 s++;
3719 y = eval_op_sum(&s, decimal, error);
3720 if (*error != NULL) break;
3721 if (op == '<') x <<= y; else x >>= y;
3722 }
3723 }
3724 *sptr = s;
3725 return x;
3726 }
3727
3728
3729 static int_eximarith_t
3730 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3731 {
3732 uschar *s = *sptr;
3733 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3734 if (*error == NULL)
3735 {
3736 while (*s == '&')
3737 {
3738 int_eximarith_t y;
3739 s++;
3740 y = eval_op_shift(&s, decimal, error);
3741 if (*error != NULL) break;
3742 x &= y;
3743 }
3744 }
3745 *sptr = s;
3746 return x;
3747 }
3748
3749
3750 static int_eximarith_t
3751 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3752 {
3753 uschar *s = *sptr;
3754 int_eximarith_t x = eval_op_and(&s, decimal, error);
3755 if (*error == NULL)
3756 {
3757 while (*s == '^')
3758 {
3759 int_eximarith_t y;
3760 s++;
3761 y = eval_op_and(&s, decimal, error);
3762 if (*error != NULL) break;
3763 x ^= y;
3764 }
3765 }
3766 *sptr = s;
3767 return x;
3768 }
3769
3770
3771 static int_eximarith_t
3772 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3773 {
3774 uschar *s = *sptr;
3775 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3776 if (*error == NULL)
3777 {
3778 while (*s == '|')
3779 {
3780 int_eximarith_t y;
3781 s++;
3782 y = eval_op_xor(&s, decimal, error);
3783 if (*error != NULL) break;
3784 x |= y;
3785 }
3786 }
3787 *sptr = s;
3788 return x;
3789 }
3790
3791
3792
3793 /*************************************************
3794 * Expand string *
3795 *************************************************/
3796
3797 /* Returns either an unchanged string, or the expanded string in stacking pool
3798 store. Interpreted sequences are:
3799
3800 \... normal escaping rules
3801 $name substitutes the variable
3802 ${name} ditto
3803 ${op:string} operates on the expanded string value
3804 ${item{arg1}{arg2}...} expands the args and then does the business
3805 some literal args are not enclosed in {}
3806
3807 There are now far too many operators and item types to make it worth listing
3808 them here in detail any more.
3809
3810 We use an internal routine recursively to handle embedded substrings. The
3811 external function follows. The yield is NULL if the expansion failed, and there
3812 are two cases: if something collapsed syntactically, or if "fail" was given
3813 as the action on a lookup failure. These can be distinguished by looking at the
3814 variable expand_string_forcedfail, which is TRUE in the latter case.
3815
3816 The skipping flag is set true when expanding a substring that isn't actually
3817 going to be used (after "if" or "lookup") and it prevents lookups from
3818 happening lower down.
3819
3820 Store usage: At start, a store block of the length of the input plus 64
3821 is obtained. This is expanded as necessary by string_cat(), which might have to
3822 get a new block, or might be able to expand the original. At the end of the
3823 function we can release any store above that portion of the yield block that
3824 was actually used. In many cases this will be optimal.
3825
3826 However: if the first item in the expansion is a variable name or header name,
3827 we reset the store before processing it; if the result is in fresh store, we
3828 use that without copying. This is helpful for expanding strings like
3829 $message_headers which can get very long.
3830
3831 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3832 since resetting the store at the end of the expansion will free store that was
3833 allocated by the plugin code as well as the slop after the expanded string. So
3834 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3835 and, given the acl condition, ${if }. This is an unfortunate consequence of
3836 string expansion becoming too powerful.
3837
3838 Arguments:
3839 string the string to be expanded
3840 ket_ends true if expansion is to stop at }
3841 left if not NULL, a pointer to the first character after the
3842 expansion is placed here (typically used with ket_ends)
3843 skipping TRUE for recursive calls when the value isn't actually going
3844 to be used (to allow for optimisation)
3845 honour_dollar TRUE if $ is to be expanded,
3846 FALSE if it's just another character
3847 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3848 the store.
3849
3850 Returns: NULL if expansion fails:
3851 expand_string_forcedfail is set TRUE if failure was forced
3852 expand_string_message contains a textual error message
3853 a pointer to the expanded string on success
3854 */
3855
3856 static uschar *
3857 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3858 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3859 {
3860 int ptr = 0;
3861 int size = Ustrlen(string)+ 64;
3862 uschar *yield = store_get(size);
3863 int item_type;
3864 const uschar *s = string;
3865 uschar *save_expand_nstring[EXPAND_MAXN+1];
3866 int save_expand_nlength[EXPAND_MAXN+1];
3867 BOOL resetok = TRUE;
3868
3869 expand_level++;
3870 DEBUG(D_expand)
3871 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
3872 skipping
3873 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
3874 : "considering",
3875 string);
3876
3877 expand_string_forcedfail = FALSE;
3878 expand_string_message = US"";
3879
3880 while (*s != 0)
3881 {
3882 uschar *value;
3883 uschar name[256];
3884
3885 /* \ escapes the next character, which must exist, or else
3886 the expansion fails. There's a special escape, \N, which causes
3887 copying of the subject verbatim up to the next \N. Otherwise,
3888 the escapes are the standard set. */
3889
3890 if (*s == '\\')
3891 {
3892 if (s[1] == 0)
3893 {
3894 expand_string_message = US"\\ at end of string";
3895 goto EXPAND_FAILED;
3896 }
3897
3898 if (s[1] == 'N')
3899 {
3900 const uschar * t = s + 2;
3901 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3902 yield = string_catn(yield, &size, &ptr, t, s - t);
3903 if (*s != 0) s += 2;
3904 }
3905
3906 else
3907 {
3908 uschar ch[1];
3909 ch[0] = string_interpret_escape(&s);
3910 s++;
3911 yield = string_catn(yield, &size, &ptr, ch, 1);
3912 }
3913
3914 continue;
3915 }
3916
3917 /*{*/
3918 /* Anything other than $ is just copied verbatim, unless we are
3919 looking for a terminating } character. */
3920
3921 /*{*/
3922 if (ket_ends && *s == '}') break;
3923
3924 if (*s != '$' || !honour_dollar)
3925 {
3926 yield = string_catn(yield, &size, &ptr, s++, 1);
3927 continue;
3928 }
3929
3930 /* No { after the $ - must be a plain name or a number for string
3931 match variable. There has to be a fudge for variables that are the
3932 names of header fields preceded by "$header_" because header field
3933 names can contain any printing characters except space and colon.
3934 For those that don't like typing this much, "$h_" is a synonym for
3935 "$header_". A non-existent header yields a NULL value; nothing is
3936 inserted. */ /*}*/
3937
3938 if (isalpha((*(++s))))
3939 {
3940 int len;
3941 int newsize = 0;
3942
3943 s = read_name(name, sizeof(name), s, US"_");
3944
3945 /* If this is the first thing to be expanded, release the pre-allocated
3946 buffer. */
3947
3948 if (ptr == 0 && yield != NULL)
3949 {