projects / exim.git / blob
? search:


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