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