projects / exim.git / blob
? search:


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