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