projects / exim.git / blob
? search:


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