Fix cert fingerprint path to deny noncerts
[exim.git] / src / src / expand.c
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
5a66c31b 5/* Copyright (c) University of Cambridge 1995 - 2014 */
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
b0e85a8f 16static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL, 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 95
9d1c15ef
JH
96#ifndef nelements
97# define nelements(arr) (sizeof(arr) / sizeof(*arr))
98#endif
059ec3d9
PH
99
100/*************************************************
101* Local statics and tables *
102*************************************************/
103
104/* Table of item names, and corresponding switch numbers. The names must be in
105alphabetical order. */
106
107static uschar *item_table[] = {
723c72e6 108 US"acl",
9d1c15ef 109 US"certextract",
1a46a8c5 110 US"dlfunc",
059ec3d9 111 US"extract",
29f89cad 112 US"filter",
059ec3d9
PH
113 US"hash",
114 US"hmac",
115 US"if",
116 US"length",
aa26e137 117 US"listextract",
059ec3d9 118 US"lookup",
29f89cad 119 US"map",
059ec3d9 120 US"nhash",
1a46a8c5 121 US"perl",
fffda43a
TK
122 US"prvs",
123 US"prvscheck",
059ec3d9
PH
124 US"readfile",
125 US"readsocket",
29f89cad 126 US"reduce",
059ec3d9
PH
127 US"run",
128 US"sg",
129 US"substr",
130 US"tr" };
131
132enum {
723c72e6 133 EITEM_ACL,
9d1c15ef 134 EITEM_CERTEXTRACT,
1a46a8c5 135 EITEM_DLFUNC,
059ec3d9 136 EITEM_EXTRACT,
29f89cad 137 EITEM_FILTER,
059ec3d9
PH
138 EITEM_HASH,
139 EITEM_HMAC,
140 EITEM_IF,
141 EITEM_LENGTH,
aa26e137 142 EITEM_LISTEXTRACT,
059ec3d9 143 EITEM_LOOKUP,
29f89cad 144 EITEM_MAP,
059ec3d9 145 EITEM_NHASH,
1a46a8c5 146 EITEM_PERL,
fffda43a
TK
147 EITEM_PRVS,
148 EITEM_PRVSCHECK,
059ec3d9
PH
149 EITEM_READFILE,
150 EITEM_READSOCK,
29f89cad 151 EITEM_REDUCE,
059ec3d9
PH
152 EITEM_RUN,
153 EITEM_SG,
154 EITEM_SUBSTR,
155 EITEM_TR };
156
157/* Tables of operator names, and corresponding switch numbers. The names must be
158in alphabetical order. There are two tables, because underscore is used in some
159cases to introduce arguments, whereas for other it is part of the name. This is
160an historical mis-design. */
161
162static uschar *op_table_underscore[] = {
163 US"from_utf8",
164 US"local_part",
165 US"quote_local_part",
83e029d5 166 US"reverse_ip",
f90d018c 167 US"time_eval",
059ec3d9
PH
168 US"time_interval"};
169
170enum {
171 EOP_FROM_UTF8,
172 EOP_LOCAL_PART,
173 EOP_QUOTE_LOCAL_PART,
83e029d5 174 EOP_REVERSE_IP,
f90d018c 175 EOP_TIME_EVAL,
059ec3d9
PH
176 EOP_TIME_INTERVAL };
177
178static uschar *op_table_main[] = {
179 US"address",
29f89cad 180 US"addresses",
059ec3d9
PH
181 US"base62",
182 US"base62d",
183 US"domain",
184 US"escape",
185 US"eval",
186 US"eval10",
187 US"expand",
188 US"h",
189 US"hash",
190 US"hex2b64",
c393f931 191 US"hexquote",
059ec3d9
PH
192 US"l",
193 US"lc",
194 US"length",
a64a3dfa
JH
195 US"listcount",
196 US"listnamed",
059ec3d9
PH
197 US"mask",
198 US"md5",
199 US"nh",
200 US"nhash",
201 US"quote",
9e3331ea 202 US"randint",
059ec3d9 203 US"rfc2047",
9c57cbc0 204 US"rfc2047d",
059ec3d9
PH
205 US"rxquote",
206 US"s",
207 US"sha1",
9ef9101c 208 US"sha256",
059ec3d9
PH
209 US"stat",
210 US"str2b64",
211 US"strlen",
212 US"substr",
b9c2e32f
AR
213 US"uc",
214 US"utf8clean" };
059ec3d9
PH
215
216enum {
217 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
29f89cad 218 EOP_ADDRESSES,
059ec3d9
PH
219 EOP_BASE62,
220 EOP_BASE62D,
221 EOP_DOMAIN,
222 EOP_ESCAPE,
223 EOP_EVAL,
224 EOP_EVAL10,
225 EOP_EXPAND,
226 EOP_H,
227 EOP_HASH,
228 EOP_HEX2B64,
c393f931 229 EOP_HEXQUOTE,
059ec3d9
PH
230 EOP_L,
231 EOP_LC,
232 EOP_LENGTH,
a64a3dfa
JH
233 EOP_LISTCOUNT,
234 EOP_LISTNAMED,
059ec3d9
PH
235 EOP_MASK,
236 EOP_MD5,
237 EOP_NH,
238 EOP_NHASH,
239 EOP_QUOTE,
9e3331ea 240 EOP_RANDINT,
059ec3d9 241 EOP_RFC2047,
9c57cbc0 242 EOP_RFC2047D,
059ec3d9
PH
243 EOP_RXQUOTE,
244 EOP_S,
245 EOP_SHA1,
9ef9101c 246 EOP_SHA256,
059ec3d9
PH
247 EOP_STAT,
248 EOP_STR2B64,
249 EOP_STRLEN,
250 EOP_SUBSTR,
b9c2e32f
AR
251 EOP_UC,
252 EOP_UTF8CLEAN };
059ec3d9
PH
253
254
255/* Table of condition names, and corresponding switch numbers. The names must
256be in alphabetical order. */
257
258static uschar *cond_table[] = {
259 US"<",
260 US"<=",
261 US"=",
262 US"==", /* Backward compatibility */
263 US">",
264 US">=",
333eea9c 265 US"acl",
059ec3d9 266 US"and",
f3766eb5 267 US"bool",
6a8de854 268 US"bool_lax",
059ec3d9
PH
269 US"crypteq",
270 US"def",
271 US"eq",
272 US"eqi",
273 US"exists",
274 US"first_delivery",
0ce9abe6
PH
275 US"forall",
276 US"forany",
059ec3d9
PH
277 US"ge",
278 US"gei",
279 US"gt",
280 US"gti",
76dca828
PP
281 US"inlist",
282 US"inlisti",
059ec3d9
PH
283 US"isip",
284 US"isip4",
285 US"isip6",
286 US"ldapauth",
287 US"le",
288 US"lei",
289 US"lt",
290 US"lti",
291 US"match",
292 US"match_address",
293 US"match_domain",
32d668a5 294 US"match_ip",
059ec3d9
PH
295 US"match_local_part",
296 US"or",
297 US"pam",
298 US"pwcheck",
299 US"queue_running",
300 US"radius",
301 US"saslauthd"
302};
303
304enum {
305 ECOND_NUM_L,
306 ECOND_NUM_LE,
307 ECOND_NUM_E,
308 ECOND_NUM_EE,
309 ECOND_NUM_G,
310 ECOND_NUM_GE,
333eea9c 311 ECOND_ACL,
059ec3d9 312 ECOND_AND,
f3766eb5 313 ECOND_BOOL,
6a8de854 314 ECOND_BOOL_LAX,
059ec3d9
PH
315 ECOND_CRYPTEQ,
316 ECOND_DEF,
317 ECOND_STR_EQ,
318 ECOND_STR_EQI,
319 ECOND_EXISTS,
320 ECOND_FIRST_DELIVERY,
0ce9abe6
PH
321 ECOND_FORALL,
322 ECOND_FORANY,
059ec3d9
PH
323 ECOND_STR_GE,
324 ECOND_STR_GEI,
325 ECOND_STR_GT,
326 ECOND_STR_GTI,
76dca828
PP
327 ECOND_INLIST,
328 ECOND_INLISTI,
059ec3d9
PH
329 ECOND_ISIP,
330 ECOND_ISIP4,
331 ECOND_ISIP6,
332 ECOND_LDAPAUTH,
333 ECOND_STR_LE,
334 ECOND_STR_LEI,
335 ECOND_STR_LT,
336 ECOND_STR_LTI,
337 ECOND_MATCH,
338 ECOND_MATCH_ADDRESS,
339 ECOND_MATCH_DOMAIN,
32d668a5 340 ECOND_MATCH_IP,
059ec3d9
PH
341 ECOND_MATCH_LOCAL_PART,
342 ECOND_OR,
343 ECOND_PAM,
344 ECOND_PWCHECK,
345 ECOND_QUEUE_RUNNING,
346 ECOND_RADIUS,
347 ECOND_SASLAUTHD
348};
349
350
351/* Type for main variable table */
352
353typedef struct {
1ba28e2b
PP
354 const char *name;
355 int type;
356 void *value;
059ec3d9
PH
357} var_entry;
358
359/* Type for entries pointing to address/length pairs. Not currently
360in use. */
361
362typedef struct {
363 uschar **address;
364 int *length;
365} alblock;
366
367/* Types of table entry */
368
369enum {
370 vtype_int, /* value is address of int */
371 vtype_filter_int, /* ditto, but recognized only when filtering */
372 vtype_ino, /* value is address of ino_t (not always an int) */
373 vtype_uid, /* value is address of uid_t (not always an int) */
374 vtype_gid, /* value is address of gid_t (not always an int) */
11d7e4fa 375 vtype_bool, /* value is address of bool */
059ec3d9
PH
376 vtype_stringptr, /* value is address of pointer to string */
377 vtype_msgbody, /* as stringptr, but read when first required */
378 vtype_msgbody_end, /* ditto, the end of the message */
ff75a1f7
PH
379 vtype_msgheaders, /* the message's headers, processed */
380 vtype_msgheaders_raw, /* the message's headers, unprocessed */
059ec3d9
PH
381 vtype_localpart, /* extract local part from string */
382 vtype_domain, /* extract domain from string */
362145b5 383 vtype_string_func, /* value is string returned by given function */
059ec3d9
PH
384 vtype_todbsdin, /* value not used; generate BSD inbox tod */
385 vtype_tode, /* value not used; generate tod in epoch format */
f5787926 386 vtype_todel, /* value not used; generate tod in epoch/usec format */
059ec3d9
PH
387 vtype_todf, /* value not used; generate full tod */
388 vtype_todl, /* value not used; generate log tod */
389 vtype_todlf, /* value not used; generate log file datestamp tod */
390 vtype_todzone, /* value not used; generate time zone only */
391 vtype_todzulu, /* value not used; generate zulu tod */
392 vtype_reply, /* value not used; get reply from headers */
393 vtype_pid, /* value not used; result is pid */
394 vtype_host_lookup, /* value not used; get host name */
5cb8cbc6
PH
395 vtype_load_avg, /* value not used; result is int from os_getloadavg */
396 vtype_pspace, /* partition space; value is T/F for spool/log */
9d1c15ef
JH
397 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
398 vtype_cert /* SSL certificate */
80a47a2c
TK
399 #ifndef DISABLE_DKIM
400 ,vtype_dkim /* Lookup of value in DKIM signature */
401 #endif
059ec3d9
PH
402 };
403
362145b5
JH
404static uschar * fn_recipients(void);
405
059ec3d9
PH
406/* This table must be kept in alphabetical order. */
407
408static var_entry var_table[] = {
38a0a95f
PH
409 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
410 they will be confused with user-creatable ACL variables. */
525239c1
JH
411 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
412 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
413 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
414 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
415 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
416 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
417 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
418 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
419 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
420 { "acl_narg", vtype_int, &acl_narg },
059ec3d9
PH
421 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
422 { "address_data", vtype_stringptr, &deliver_address_data },
423 { "address_file", vtype_stringptr, &address_file },
424 { "address_pipe", vtype_stringptr, &address_pipe },
2d07a215 425 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
059ec3d9
PH
426 { "authenticated_id", vtype_stringptr, &authenticated_id },
427 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
428 { "authentication_failed",vtype_int, &authentication_failed },
9e949f00
PP
429#ifdef WITH_CONTENT_SCAN
430 { "av_failed", vtype_int, &av_failed },
431#endif
8523533c
TK
432#ifdef EXPERIMENTAL_BRIGHTMAIL
433 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
434 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
435 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
436 { "bmi_deliver", vtype_int, &bmi_deliver },
437#endif
059ec3d9
PH
438 { "body_linecount", vtype_int, &body_linecount },
439 { "body_zerocount", vtype_int, &body_zerocount },
440 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
441 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
442 { "caller_gid", vtype_gid, &real_gid },
443 { "caller_uid", vtype_uid, &real_uid },
444 { "compile_date", vtype_stringptr, &version_date },
445 { "compile_number", vtype_stringptr, &version_cnumber },
e5a9dba6 446 { "csa_status", vtype_stringptr, &csa_status },
6a8f9482
TK
447#ifdef EXPERIMENTAL_DCC
448 { "dcc_header", vtype_stringptr, &dcc_header },
449 { "dcc_result", vtype_stringptr, &dcc_result },
450#endif
8523533c
TK
451#ifdef WITH_OLD_DEMIME
452 { "demime_errorlevel", vtype_int, &demime_errorlevel },
453 { "demime_reason", vtype_stringptr, &demime_reason },
fb2274d4 454#endif
80a47a2c
TK
455#ifndef DISABLE_DKIM
456 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
457 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
458 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
459 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
460 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
461 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
2df588c9 462 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
e08d09e5 463 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
80a47a2c
TK
464 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
465 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
466 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
467 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
468 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
469 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
470 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
471 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
e08d09e5 472 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
9e5d6b55 473 { "dkim_signers", vtype_stringptr, &dkim_signers },
80a47a2c
TK
474 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
475 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
4840604e
TL
476#endif
477#ifdef EXPERIMENTAL_DMARC
478 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
8c8b8274 479 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
4840604e
TL
480 { "dmarc_status", vtype_stringptr, &dmarc_status },
481 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
482 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
8523533c 483#endif
059ec3d9 484 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
93655c46 485 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
059ec3d9
PH
486 { "dnslist_text", vtype_stringptr, &dnslist_text },
487 { "dnslist_value", vtype_stringptr, &dnslist_value },
488 { "domain", vtype_stringptr, &deliver_domain },
489 { "domain_data", vtype_stringptr, &deliver_domain_data },
490 { "exim_gid", vtype_gid, &exim_gid },
491 { "exim_path", vtype_stringptr, &exim_path },
492 { "exim_uid", vtype_uid, &exim_uid },
8523533c
TK
493#ifdef WITH_OLD_DEMIME
494 { "found_extension", vtype_stringptr, &found_extension },
8e669ac1 495#endif
362145b5 496 { "headers_added", vtype_string_func, &fn_hdrs_added },
059ec3d9
PH
497 { "home", vtype_stringptr, &deliver_home },
498 { "host", vtype_stringptr, &deliver_host },
499 { "host_address", vtype_stringptr, &deliver_host_address },
500 { "host_data", vtype_stringptr, &host_data },
b08b24c8 501 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
059ec3d9
PH
502 { "host_lookup_failed", vtype_int, &host_lookup_failed },
503 { "inode", vtype_ino, &deliver_inode },
504 { "interface_address", vtype_stringptr, &interface_address },
505 { "interface_port", vtype_int, &interface_port },
0ce9abe6 506 { "item", vtype_stringptr, &iterate_item },
059ec3d9
PH
507 #ifdef LOOKUP_LDAP
508 { "ldap_dn", vtype_stringptr, &eldap_dn },
509 #endif
510 { "load_average", vtype_load_avg, NULL },
511 { "local_part", vtype_stringptr, &deliver_localpart },
512 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
513 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
514 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
515 { "local_scan_data", vtype_stringptr, &local_scan_data },
516 { "local_user_gid", vtype_gid, &local_user_gid },
517 { "local_user_uid", vtype_uid, &local_user_uid },
518 { "localhost_number", vtype_int, &host_number },
5cb8cbc6 519 { "log_inodes", vtype_pinodes, (void *)FALSE },
8e669ac1 520 { "log_space", vtype_pspace, (void *)FALSE },
4e0983dc 521 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
059ec3d9 522 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
8523533c
TK
523#ifdef WITH_CONTENT_SCAN
524 { "malware_name", vtype_stringptr, &malware_name },
525#endif
d677b2f2 526 { "max_received_linelength", vtype_int, &max_received_linelength },
059ec3d9
PH
527 { "message_age", vtype_int, &message_age },
528 { "message_body", vtype_msgbody, &message_body },
529 { "message_body_end", vtype_msgbody_end, &message_body_end },
530 { "message_body_size", vtype_int, &message_body_size },
1ab52c69 531 { "message_exim_id", vtype_stringptr, &message_id },
059ec3d9 532 { "message_headers", vtype_msgheaders, NULL },
ff75a1f7 533 { "message_headers_raw", vtype_msgheaders_raw, NULL },
059ec3d9 534 { "message_id", vtype_stringptr, &message_id },
2e0c1448 535 { "message_linecount", vtype_int, &message_linecount },
059ec3d9 536 { "message_size", vtype_int, &message_size },
8523533c
TK
537#ifdef WITH_CONTENT_SCAN
538 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
539 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
540 { "mime_boundary", vtype_stringptr, &mime_boundary },
541 { "mime_charset", vtype_stringptr, &mime_charset },
542 { "mime_content_description", vtype_stringptr, &mime_content_description },
543 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
544 { "mime_content_id", vtype_stringptr, &mime_content_id },
545 { "mime_content_size", vtype_int, &mime_content_size },
546 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
547 { "mime_content_type", vtype_stringptr, &mime_content_type },
548 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
549 { "mime_filename", vtype_stringptr, &mime_filename },
550 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
551 { "mime_is_multipart", vtype_int, &mime_is_multipart },
552 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
553 { "mime_part_count", vtype_int, &mime_part_count },
554#endif
059ec3d9
PH
555 { "n0", vtype_filter_int, &filter_n[0] },
556 { "n1", vtype_filter_int, &filter_n[1] },
557 { "n2", vtype_filter_int, &filter_n[2] },
558 { "n3", vtype_filter_int, &filter_n[3] },
559 { "n4", vtype_filter_int, &filter_n[4] },
560 { "n5", vtype_filter_int, &filter_n[5] },
561 { "n6", vtype_filter_int, &filter_n[6] },
562 { "n7", vtype_filter_int, &filter_n[7] },
563 { "n8", vtype_filter_int, &filter_n[8] },
564 { "n9", vtype_filter_int, &filter_n[9] },
565 { "original_domain", vtype_stringptr, &deliver_domain_orig },
566 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
567 { "originator_gid", vtype_gid, &originator_gid },
568 { "originator_uid", vtype_uid, &originator_uid },
569 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
570 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
571 { "pid", vtype_pid, NULL },
572 { "primary_hostname", vtype_stringptr, &primary_hostname },
a3c86431 573#ifdef EXPERIMENTAL_PROXY
a3bddaa8
TL
574 { "proxy_host_address", vtype_stringptr, &proxy_host_address },
575 { "proxy_host_port", vtype_int, &proxy_host_port },
a3c86431 576 { "proxy_session", vtype_bool, &proxy_session },
eb57651e
TL
577 { "proxy_target_address",vtype_stringptr, &proxy_target_address },
578 { "proxy_target_port", vtype_int, &proxy_target_port },
a3c86431 579#endif
fffda43a
TK
580 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
581 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
582 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
059ec3d9
PH
583 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
584 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
585 { "rcpt_count", vtype_int, &rcpt_count },
586 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
587 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
588 { "received_count", vtype_int, &received_count },
589 { "received_for", vtype_stringptr, &received_for },
194cc0e4
PH
590 { "received_ip_address", vtype_stringptr, &interface_address },
591 { "received_port", vtype_int, &interface_port },
059ec3d9 592 { "received_protocol", vtype_stringptr, &received_protocol },
7dbf77c9 593 { "received_time", vtype_int, &received_time },
059ec3d9 594 { "recipient_data", vtype_stringptr, &recipient_data },
8e669ac1 595 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
362145b5 596 { "recipients", vtype_string_func, &fn_recipients },
059ec3d9 597 { "recipients_count", vtype_int, &recipients_count },
8523533c
TK
598#ifdef WITH_CONTENT_SCAN
599 { "regex_match_string", vtype_stringptr, &regex_match_string },
600#endif
059ec3d9
PH
601 { "reply_address", vtype_reply, NULL },
602 { "return_path", vtype_stringptr, &return_path },
603 { "return_size_limit", vtype_int, &bounce_return_size_limit },
181d9bf8 604 { "router_name", vtype_stringptr, &router_name },
059ec3d9
PH
605 { "runrc", vtype_int, &runrc },
606 { "self_hostname", vtype_stringptr, &self_hostname },
607 { "sender_address", vtype_stringptr, &sender_address },
2a3eea10 608 { "sender_address_data", vtype_stringptr, &sender_address_data },
059ec3d9
PH
609 { "sender_address_domain", vtype_domain, &sender_address },
610 { "sender_address_local_part", vtype_localpart, &sender_address },
611 { "sender_data", vtype_stringptr, &sender_data },
612 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
613 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
614 { "sender_host_address", vtype_stringptr, &sender_host_address },
615 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
11d7e4fa 616 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
059ec3d9
PH
617 { "sender_host_name", vtype_host_lookup, NULL },
618 { "sender_host_port", vtype_int, &sender_host_port },
619 { "sender_ident", vtype_stringptr, &sender_ident },
870f6ba8
TF
620 { "sender_rate", vtype_stringptr, &sender_rate },
621 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
622 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
059ec3d9 623 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
8e669ac1 624 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
41c7c167
PH
625 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
626 { "sending_port", vtype_int, &sending_port },
8e669ac1 627 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
3ee512ff
PH
628 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
629 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
b01dd148 630 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
8f128379 631 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
059ec3d9
PH
632 { "sn0", vtype_filter_int, &filter_sn[0] },
633 { "sn1", vtype_filter_int, &filter_sn[1] },
634 { "sn2", vtype_filter_int, &filter_sn[2] },
635 { "sn3", vtype_filter_int, &filter_sn[3] },
636 { "sn4", vtype_filter_int, &filter_sn[4] },
637 { "sn5", vtype_filter_int, &filter_sn[5] },
638 { "sn6", vtype_filter_int, &filter_sn[6] },
639 { "sn7", vtype_filter_int, &filter_sn[7] },
640 { "sn8", vtype_filter_int, &filter_sn[8] },
641 { "sn9", vtype_filter_int, &filter_sn[9] },
8523533c
TK
642#ifdef WITH_CONTENT_SCAN
643 { "spam_bar", vtype_stringptr, &spam_bar },
644 { "spam_report", vtype_stringptr, &spam_report },
645 { "spam_score", vtype_stringptr, &spam_score },
646 { "spam_score_int", vtype_stringptr, &spam_score_int },
647#endif
648#ifdef EXPERIMENTAL_SPF
65a7d8c3 649 { "spf_guess", vtype_stringptr, &spf_guess },
8523533c
TK
650 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
651 { "spf_received", vtype_stringptr, &spf_received },
652 { "spf_result", vtype_stringptr, &spf_result },
653 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
654#endif
059ec3d9 655 { "spool_directory", vtype_stringptr, &spool_directory },
5cb8cbc6 656 { "spool_inodes", vtype_pinodes, (void *)TRUE },
8e669ac1 657 { "spool_space", vtype_pspace, (void *)TRUE },
8523533c
TK
658#ifdef EXPERIMENTAL_SRS
659 { "srs_db_address", vtype_stringptr, &srs_db_address },
660 { "srs_db_key", vtype_stringptr, &srs_db_key },
661 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
662 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
663 { "srs_recipient", vtype_stringptr, &srs_recipient },
664 { "srs_status", vtype_stringptr, &srs_status },
665#endif
059ec3d9 666 { "thisaddress", vtype_stringptr, &filter_thisaddress },
817d9f57 667
d9b2312b 668 /* The non-(in,out) variables are now deprecated */
817d9f57
JH
669 { "tls_bits", vtype_int, &tls_in.bits },
670 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
671 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
d9b2312b
JH
672
673 { "tls_in_bits", vtype_int, &tls_in.bits },
674 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
675 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
44662487 676 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
9d1c15ef
JH
677 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
678 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
d9b2312b
JH
679 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
680#if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
681 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
682#endif
817d9f57 683 { "tls_out_bits", vtype_int, &tls_out.bits },
cb9d95ae 684 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
817d9f57 685 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
44662487 686 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
9d1c15ef
JH
687 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
688 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
817d9f57
JH
689 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
690#if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
691 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
7be682ca 692#endif
d9b2312b 693
613dd4ae
JH
694 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
695#if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
696 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
697#endif
817d9f57 698
059ec3d9
PH
699 { "tod_bsdinbox", vtype_todbsdin, NULL },
700 { "tod_epoch", vtype_tode, NULL },
f5787926 701 { "tod_epoch_l", vtype_todel, NULL },
059ec3d9
PH
702 { "tod_full", vtype_todf, NULL },
703 { "tod_log", vtype_todl, NULL },
704 { "tod_logfile", vtype_todlf, NULL },
705 { "tod_zone", vtype_todzone, NULL },
706 { "tod_zulu", vtype_todzulu, NULL },
d68218c7
JH
707#ifdef EXPERIMENTAL_TPDA
708 { "tpda_defer_errno", vtype_int, &tpda_defer_errno },
709 { "tpda_defer_errstr", vtype_stringptr, &tpda_defer_errstr },
710 { "tpda_delivery_confirmation", vtype_stringptr, &tpda_delivery_confirmation },
711 { "tpda_delivery_domain", vtype_stringptr, &tpda_delivery_domain },
712 { "tpda_delivery_fqdn", vtype_stringptr, &tpda_delivery_fqdn },
713 { "tpda_delivery_ip", vtype_stringptr, &tpda_delivery_ip },
714 { "tpda_delivery_local_part",vtype_stringptr,&tpda_delivery_local_part },
715 { "tpda_delivery_port", vtype_int, &tpda_delivery_port },
716#endif
181d9bf8 717 { "transport_name", vtype_stringptr, &transport_name },
059ec3d9
PH
718 { "value", vtype_stringptr, &lookup_value },
719 { "version_number", vtype_stringptr, &version_string },
720 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
721 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
722 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
723 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
724 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
725 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
726};
727
728static int var_table_size = sizeof(var_table)/sizeof(var_entry);
729static uschar var_buffer[256];
730static BOOL malformed_header;
731
732/* For textual hashes */
733
1ba28e2b
PP
734static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
735 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
736 "0123456789";
059ec3d9
PH
737
738enum { HMAC_MD5, HMAC_SHA1 };
739
740/* For numeric hashes */
741
742static unsigned int prime[] = {
743 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
744 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
745 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
746
747/* For printing modes in symbolic form */
748
749static uschar *mtable_normal[] =
750 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
751
752static uschar *mtable_setid[] =
753 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
754
755static uschar *mtable_sticky[] =
756 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
757
758
759
760/*************************************************
761* Tables for UTF-8 support *
762*************************************************/
763
764/* Table of the number of extra characters, indexed by the first character
765masked with 0x3f. The highest number for a valid UTF-8 character is in fact
7660x3d. */
767
768static uschar utf8_table1[] = {
769 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
770 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
771 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
772 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
773
774/* These are the masks for the data bits in the first byte of a character,
775indexed by the number of additional bytes. */
776
777static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
778
779/* Get the next UTF-8 character, advancing the pointer. */
780
781#define GETUTF8INC(c, ptr) \
782 c = *ptr++; \
783 if ((c & 0xc0) == 0xc0) \
784 { \
785 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
786 int s = 6*a; \
787 c = (c & utf8_table2[a]) << s; \
788 while (a-- > 0) \
789 { \
790 s -= 6; \
791 c |= (*ptr++ & 0x3f) << s; \
792 } \
793 }
794
795
796/*************************************************
797* Binary chop search on a table *
798*************************************************/
799
800/* This is used for matching expansion items and operators.
801
802Arguments:
803 name the name that is being sought
804 table the table to search
805 table_size the number of items in the table
806
807Returns: the offset in the table, or -1
808*/
809
810static int
811chop_match(uschar *name, uschar **table, int table_size)
812{
813uschar **bot = table;
814uschar **top = table + table_size;
815
816while (top > bot)
817 {
818 uschar **mid = bot + (top - bot)/2;
819 int c = Ustrcmp(name, *mid);
820 if (c == 0) return mid - table;
821 if (c > 0) bot = mid + 1; else top = mid;
822 }
823
824return -1;
825}
826
827
828
829/*************************************************
830* Check a condition string *
831*************************************************/
832
833/* This function is called to expand a string, and test the result for a "true"
834or "false" value. Failure of the expansion yields FALSE; logged unless it was a
be7a5781
JH
835forced fail or lookup defer.
836
837We used to release all store used, but this is not not safe due
838to ${dlfunc } and ${acl }. In any case expand_string_internal()
839is reasonably careful to release what it can.
059ec3d9 840
6a8de854
PP
841The actual false-value tests should be replicated for ECOND_BOOL_LAX.
842
059ec3d9
PH
843Arguments:
844 condition the condition string
845 m1 text to be incorporated in panic error
846 m2 ditto
847
848Returns: TRUE if condition is met, FALSE if not
849*/
850
851BOOL
852expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
853{
854int rc;
059ec3d9
PH
855uschar *ss = expand_string(condition);
856if (ss == NULL)
857 {
858 if (!expand_string_forcedfail && !search_find_defer)
859 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
860 "for %s %s: %s", condition, m1, m2, expand_string_message);
861 return FALSE;
862 }
863rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
864 strcmpic(ss, US"false") != 0;
059ec3d9
PH
865return rc;
866}
867
868
869
17c76198 870
9e3331ea
TK
871/*************************************************
872* Pseudo-random number generation *
873*************************************************/
874
875/* Pseudo-random number generation. The result is not "expected" to be
876cryptographically strong but not so weak that someone will shoot themselves
877in the foot using it as a nonce in some email header scheme or whatever
878weirdness they'll twist this into. The result should ideally handle fork().
879
880However, if we're stuck unable to provide this, then we'll fall back to
881appallingly bad randomness.
882
17c76198
PP
883If SUPPORT_TLS is defined then this will not be used except as an emergency
884fallback.
9e3331ea
TK
885
886Arguments:
887 max range maximum
888Returns a random number in range [0, max-1]
889*/
890
17c76198
PP
891#ifdef SUPPORT_TLS
892# define vaguely_random_number vaguely_random_number_fallback
893#endif
9e3331ea 894int
17c76198 895vaguely_random_number(int max)
9e3331ea 896{
17c76198
PP
897#ifdef SUPPORT_TLS
898# undef vaguely_random_number
899#endif
9e3331ea
TK
900 static pid_t pid = 0;
901 pid_t p2;
902#if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
903 struct timeval tv;
904#endif
905
906 p2 = getpid();
907 if (p2 != pid)
908 {
909 if (pid != 0)
910 {
911
912#ifdef HAVE_ARC4RANDOM
913 /* cryptographically strong randomness, common on *BSD platforms, not
914 so much elsewhere. Alas. */
915 arc4random_stir();
916#elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
917#ifdef HAVE_SRANDOMDEV
918 /* uses random(4) for seeding */
919 srandomdev();
920#else
921 gettimeofday(&tv, NULL);
922 srandom(tv.tv_sec | tv.tv_usec | getpid());
923#endif
924#else
925 /* Poor randomness and no seeding here */
926#endif
927
928 }
929 pid = p2;
930 }
931
932#ifdef HAVE_ARC4RANDOM
933 return arc4random() % max;
934#elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
935 return random() % max;
936#else
937 /* This one returns a 16-bit number, definitely not crypto-strong */
938 return random_number(max);
939#endif
940}
941
17c76198
PP
942
943
9e3331ea 944
059ec3d9
PH
945/*************************************************
946* Pick out a name from a string *
947*************************************************/
948
949/* If the name is too long, it is silently truncated.
950
951Arguments:
952 name points to a buffer into which to put the name
953 max is the length of the buffer
954 s points to the first alphabetic character of the name
955 extras chars other than alphanumerics to permit
956
957Returns: pointer to the first character after the name
958
959Note: The test for *s != 0 in the while loop is necessary because
960Ustrchr() yields non-NULL if the character is zero (which is not something
961I expected). */
962
963static uschar *
964read_name(uschar *name, int max, uschar *s, uschar *extras)
965{
966int ptr = 0;
967while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
968 {
969 if (ptr < max-1) name[ptr++] = *s;
970 s++;
971 }
972name[ptr] = 0;
973return s;
974}
975
976
977
978/*************************************************
979* Pick out the rest of a header name *
980*************************************************/
981
982/* A variable name starting $header_ (or just $h_ for those who like
983abbreviations) might not be the complete header name because headers can
984contain any printing characters in their names, except ':'. This function is
985called to read the rest of the name, chop h[eader]_ off the front, and put ':'
986on the end, if the name was terminated by white space.
987
988Arguments:
989 name points to a buffer in which the name read so far exists
990 max is the length of the buffer
991 s points to the first character after the name so far, i.e. the
992 first non-alphameric character after $header_xxxxx
993
994Returns: a pointer to the first character after the header name
995*/
996
997static uschar *
998read_header_name(uschar *name, int max, uschar *s)
999{
1000int prelen = Ustrchr(name, '_') - name + 1;
1001int ptr = Ustrlen(name) - prelen;
1002if (ptr > 0) memmove(name, name+prelen, ptr);
1003while (mac_isgraph(*s) && *s != ':')
1004 {
1005 if (ptr < max-1) name[ptr++] = *s;
1006 s++;
1007 }
1008if (*s == ':') s++;
1009name[ptr++] = ':';
1010name[ptr] = 0;
1011return s;
1012}
1013
1014
1015
1016/*************************************************
1017* Pick out a number from a string *
1018*************************************************/
1019
1020/* Arguments:
1021 n points to an integer into which to put the number
1022 s points to the first digit of the number
1023
1024Returns: a pointer to the character after the last digit
1025*/
1026
1027static uschar *
1028read_number(int *n, uschar *s)
1029{
1030*n = 0;
1031while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1032return s;
1033}
1034
1035
1036
1037/*************************************************
1038* Extract keyed subfield from a string *
1039*************************************************/
1040
1041/* The yield is in dynamic store; NULL means that the key was not found.
1042
1043Arguments:
1044 key points to the name of the key
1045 s points to the string from which to extract the subfield
1046
1047Returns: NULL if the subfield was not found, or
1048 a pointer to the subfield's data
1049*/
1050
1051static uschar *
1052expand_getkeyed(uschar *key, uschar *s)
1053{
1054int length = Ustrlen(key);
1055while (isspace(*s)) s++;
1056
1057/* Loop to search for the key */
1058
1059while (*s != 0)
1060 {
1061 int dkeylength;
1062 uschar *data;
1063 uschar *dkey = s;
1064
1065 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1066 dkeylength = s - dkey;
1067 while (isspace(*s)) s++;
1068 if (*s == '=') while (isspace((*(++s))));
1069
1070 data = string_dequote(&s);
1071 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1072 return data;
1073
1074 while (isspace(*s)) s++;
1075 }
1076
1077return NULL;
1078}
1079
1080
1081
9d1c15ef
JH
1082static var_entry *
1083find_var_ent(uschar * name)
1084{
1085int first = 0;
1086int last = var_table_size;
1087
1088while (last > first)
1089 {
1090 int middle = (first + last)/2;
1091 int c = Ustrcmp(name, var_table[middle].name);
1092
1093 if (c > 0) { first = middle + 1; continue; }
1094 if (c < 0) { last = middle; continue; }
1095 return &var_table[middle];
1096 }
1097return NULL;
1098}
059ec3d9
PH
1099
1100/*************************************************
1101* Extract numbered subfield from string *
1102*************************************************/
1103
1104/* Extracts a numbered field from a string that is divided by tokens - for
1105example a line from /etc/passwd is divided by colon characters. First field is
1106numbered one. Negative arguments count from the right. Zero returns the whole
1107string. Returns NULL if there are insufficient tokens in the string
1108
1109***WARNING***
1110Modifies final argument - this is a dynamically generated string, so that's OK.
1111
1112Arguments:
1113 field number of field to be extracted,
1114 first field = 1, whole string = 0, last field = -1
1115 separators characters that are used to break string into tokens
1116 s points to the string from which to extract the subfield
1117
1118Returns: NULL if the field was not found,
1119 a pointer to the field's data inside s (modified to add 0)
1120*/
1121
1122static uschar *
1123expand_gettokened (int field, uschar *separators, uschar *s)
1124{
1125int sep = 1;
1126int count;
1127uschar *ss = s;
1128uschar *fieldtext = NULL;
1129
1130if (field == 0) return s;
1131
1132/* Break the line up into fields in place; for field > 0 we stop when we have
1133done the number of fields we want. For field < 0 we continue till the end of
1134the string, counting the number of fields. */
1135
1136count = (field > 0)? field : INT_MAX;
1137
1138while (count-- > 0)
1139 {
1140 size_t len;
1141
1142 /* Previous field was the last one in the string. For a positive field
1143 number, this means there are not enough fields. For a negative field number,
1144 check that there are enough, and scan back to find the one that is wanted. */
1145
1146 if (sep == 0)
1147 {
1148 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1149 if ((-field) == (INT_MAX - count - 1)) return s;
1150 while (field++ < 0)
1151 {
1152 ss--;
1153 while (ss[-1] != 0) ss--;
1154 }
1155 fieldtext = ss;
1156 break;
1157 }
1158
1159 /* Previous field was not last in the string; save its start and put a
1160 zero at its end. */
1161
1162 fieldtext = ss;
1163 len = Ustrcspn(ss, separators);
1164 sep = ss[len];
1165 ss[len] = 0;
1166 ss += len + 1;
1167 }
1168
1169return fieldtext;
1170}
1171
1172
aa26e137 1173static uschar *
9d1c15ef 1174expand_getlistele(int field, uschar * list)
aa26e137
JH
1175{
1176uschar * tlist= list;
1177int sep= 0;
1178uschar dummy;
1179
1180if(field<0)
1181{
1182 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1183 sep= 0;
1184}
1185if(field==0) return NULL;
1186while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1187return string_nextinlist(&list, &sep, NULL, 0);
1188}
059ec3d9 1189
9d1c15ef
JH
1190
1191/* Certificate fields, by name. Worry about by-OID later */
9e4dddbd 1192/* Names are chosen to not have common prefixes */
9d1c15ef
JH
1193
1194#ifdef SUPPORT_TLS
1195typedef struct
1196{
1197uschar * name;
9e4dddbd
JH
1198int namelen;
1199uschar * (*getfn)(void * cert, uschar * mod);
9d1c15ef
JH
1200} certfield;
1201static certfield certfields[] =
1202{ /* linear search; no special order */
9e4dddbd
JH
1203 { US"version", 7, &tls_cert_version },
1204 { US"serial_number", 13, &tls_cert_serial_number },
1205 { US"subject", 7, &tls_cert_subject },
1206 { US"notbefore", 9, &tls_cert_not_before },
1207 { US"notafter", 8, &tls_cert_not_after },
1208 { US"issuer", 6, &tls_cert_issuer },
1209 { US"signature", 9, &tls_cert_signature },
1210 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1211 { US"subj_altname", 12, &tls_cert_subject_altname },
1212 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1213 { US"crl_uri", 7, &tls_cert_crl_uri },
9d1c15ef
JH
1214};
1215
1216static uschar *
1217expand_getcertele(uschar * field, uschar * certvar)
1218{
1219var_entry * vp;
1220certfield * cp;
1221
1222if (!(vp = find_var_ent(certvar)))
1223 {
1224 expand_string_message =
1225 string_sprintf("no variable named \"%s\"", certvar);
1226 return NULL; /* Unknown variable name */
1227 }
1228/* NB this stops us passing certs around in variable. Might
1229want to do that in future */
1230if (vp->type != vtype_cert)
1231 {
1232 expand_string_message =
1233 string_sprintf("\"%s\" is not a certificate", certvar);
1234 return NULL; /* Unknown variable name */
1235 }
1236if (!*(void **)vp->value)
1237 return NULL;
1238
1239if (*field >= '0' && *field <= '9')
1240 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1241
1242for(cp = certfields;
1243 cp < certfields + nelements(certfields);
1244 cp++)
9e4dddbd
JH
1245 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1246 {
1247 uschar * modifier = *(field += cp->namelen) == ','
1248 ? ++field : NULL;
1249 return (*cp->getfn)( *(void **)vp->value, modifier );
1250 }
9d1c15ef
JH
1251
1252expand_string_message =
1253 string_sprintf("bad field selector \"%s\" for certextract", field);
1254return NULL;
1255}
1256#endif /*SUPPORT_TLS*/
1257
059ec3d9
PH
1258/*************************************************
1259* Extract a substring from a string *
1260*************************************************/
1261
1262/* Perform the ${substr or ${length expansion operations.
1263
1264Arguments:
1265 subject the input string
1266 value1 the offset from the start of the input string to the start of
1267 the output string; if negative, count from the right.
1268 value2 the length of the output string, or negative (-1) for unset
1269 if value1 is positive, unset means "all after"
1270 if value1 is negative, unset means "all before"
1271 len set to the length of the returned string
1272
1273Returns: pointer to the output string, or NULL if there is an error
1274*/
1275
1276static uschar *
1277extract_substr(uschar *subject, int value1, int value2, int *len)
1278{
1279int sublen = Ustrlen(subject);
1280
1281if (value1 < 0) /* count from right */
1282 {
1283 value1 += sublen;
1284
1285 /* If the position is before the start, skip to the start, and adjust the
1286 length. If the length ends up negative, the substring is null because nothing
1287 can precede. This falls out naturally when the length is unset, meaning "all
1288 to the left". */
1289
1290 if (value1 < 0)
1291 {
1292 value2 += value1;
1293 if (value2 < 0) value2 = 0;
1294 value1 = 0;
1295 }
1296
1297 /* Otherwise an unset length => characters before value1 */
1298
1299 else if (value2 < 0)
1300 {
1301 value2 = value1;
1302 value1 = 0;
1303 }
1304 }
1305
1306/* For a non-negative offset, if the starting position is past the end of the
1307string, the result will be the null string. Otherwise, an unset length means
1308"rest"; just set it to the maximum - it will be cut down below if necessary. */
1309
1310else
1311 {
1312 if (value1 > sublen)
1313 {
1314 value1 = sublen;
1315 value2 = 0;
1316 }
1317 else if (value2 < 0) value2 = sublen;
1318 }
1319
1320/* Cut the length down to the maximum possible for the offset value, and get
1321the required characters. */
1322
1323if (value1 + value2 > sublen) value2 = sublen - value1;
1324*len = value2;
1325return subject + value1;
1326}
1327
1328
1329
1330
1331/*************************************************
1332* Old-style hash of a string *
1333*************************************************/
1334
1335/* Perform the ${hash expansion operation.
1336
1337Arguments:
1338 subject the input string (an expanded substring)
1339 value1 the length of the output string; if greater or equal to the
1340 length of the input string, the input string is returned
1341 value2 the number of hash characters to use, or 26 if negative
1342 len set to the length of the returned string
1343
1344Returns: pointer to the output string, or NULL if there is an error
1345*/
1346
1347static uschar *
1348compute_hash(uschar *subject, int value1, int value2, int *len)
1349{
1350int sublen = Ustrlen(subject);
1351
1352if (value2 < 0) value2 = 26;
1353else if (value2 > Ustrlen(hashcodes))
1354 {
1355 expand_string_message =
1356 string_sprintf("hash count \"%d\" too big", value2);
1357 return NULL;
1358 }
1359
1360/* Calculate the hash text. We know it is shorter than the original string, so
1361can safely place it in subject[] (we know that subject is always itself an
1362expanded substring). */
1363
1364if (value1 < sublen)
1365 {
1366 int c;
1367 int i = 0;
1368 int j = value1;
1369 while ((c = (subject[j])) != 0)
1370 {
1371 int shift = (c + j++) & 7;
1372 subject[i] ^= (c << shift) | (c >> (8-shift));
1373 if (++i >= value1) i = 0;
1374 }
1375 for (i = 0; i < value1; i++)
1376 subject[i] = hashcodes[(subject[i]) % value2];
1377 }
1378else value1 = sublen;
1379
1380*len = value1;
1381return subject;
1382}
1383
1384
1385
1386
1387/*************************************************
1388* Numeric hash of a string *
1389*************************************************/
1390
1391/* Perform the ${nhash expansion operation. The first characters of the
1392string are treated as most important, and get the highest prime numbers.
1393
1394Arguments:
1395 subject the input string
1396 value1 the maximum value of the first part of the result
1397 value2 the maximum value of the second part of the result,
1398 or negative to produce only a one-part result
1399 len set to the length of the returned string
1400
1401Returns: pointer to the output string, or NULL if there is an error.
1402*/
1403
1404static uschar *
1405compute_nhash (uschar *subject, int value1, int value2, int *len)
1406{
1407uschar *s = subject;
1408int i = 0;
1409unsigned long int total = 0; /* no overflow */
1410
1411while (*s != 0)
1412 {
1413 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1414 total += prime[i--] * (unsigned int)(*s++);
1415 }
1416
1417/* If value2 is unset, just compute one number */
1418
1419if (value2 < 0)
1420 {
1421 s = string_sprintf("%d", total % value1);
1422 }
1423
1424/* Otherwise do a div/mod hash */
1425
1426else
1427 {
1428 total = total % (value1 * value2);
1429 s = string_sprintf("%d/%d", total/value2, total % value2);
1430 }
1431
1432*len = Ustrlen(s);
1433return s;
1434}
1435
1436
1437
1438
1439
1440/*************************************************
1441* Find the value of a header or headers *
1442*************************************************/
1443
1444/* Multiple instances of the same header get concatenated, and this function
1445can also return a concatenation of all the header lines. When concatenating
1446specific headers that contain lists of addresses, a comma is inserted between
1447them. Otherwise we use a straight concatenation. Because some messages can have
1448pathologically large number of lines, there is a limit on the length that is
1449returned. Also, to avoid massive store use which would result from using
1450string_cat() as it copies and extends strings, we do a preliminary pass to find
1451out exactly how much store will be needed. On "normal" messages this will be
1452pretty trivial.
1453
1454Arguments:
1455 name the name of the header, without the leading $header_ or $h_,
1456 or NULL if a concatenation of all headers is required
1457 exists_only TRUE if called from a def: test; don't need to build a string;
1458 just return a string that is not "" and not "0" if the header
1459 exists
1460 newsize return the size of memory block that was obtained; may be NULL
1461 if exists_only is TRUE
1462 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
ff75a1f7
PH
1463 other than concatenating, will be done on the header. Also used
1464 for $message_headers_raw.
059ec3d9
PH
1465 charset name of charset to translate MIME words to; used only if
1466 want_raw is false; if NULL, no translation is done (this is
1467 used for $bh_ and $bheader_)
1468
1469Returns: NULL if the header does not exist, else a pointer to a new
1470 store block
1471*/
1472
1473static uschar *
1474find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1475 uschar *charset)
1476{
1477BOOL found = name == NULL;
1478int comma = 0;
1479int len = found? 0 : Ustrlen(name);
1480int i;
1481uschar *yield = NULL;
1482uschar *ptr = NULL;
1483
1484/* Loop for two passes - saves code repetition */
1485
1486for (i = 0; i < 2; i++)
1487 {
1488 int size = 0;
1489 header_line *h;
1490
1491 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1492 {
1493 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1494 {
1495 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1496 {
1497 int ilen;
1498 uschar *t;
1499
1500 if (exists_only) return US"1"; /* don't need actual string */
1501 found = TRUE;
1502 t = h->text + len; /* text to insert */
1503 if (!want_raw) /* unless wanted raw, */
1504 while (isspace(*t)) t++; /* remove leading white space */
1505 ilen = h->slen - (t - h->text); /* length to insert */
1506
fd700877
PH
1507 /* Unless wanted raw, remove trailing whitespace, including the
1508 newline. */
1509
1510 if (!want_raw)
1511 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1512
059ec3d9
PH
1513 /* Set comma = 1 if handling a single header and it's one of those
1514 that contains an address list, except when asked for raw headers. Only
1515 need to do this once. */
1516
1517 if (!want_raw && name != NULL && comma == 0 &&
1518 Ustrchr("BCFRST", h->type) != NULL)
1519 comma = 1;
1520
1521 /* First pass - compute total store needed; second pass - compute
1522 total store used, including this header. */
1523
fd700877 1524 size += ilen + comma + 1; /* +1 for the newline */
059ec3d9
PH
1525
1526 /* Second pass - concatentate the data, up to a maximum. Note that
1527 the loop stops when size hits the limit. */
1528
1529 if (i != 0)
1530 {
1531 if (size > header_insert_maxlen)
1532 {
fd700877 1533 ilen -= size - header_insert_maxlen - 1;
059ec3d9
PH
1534 comma = 0;
1535 }
1536 Ustrncpy(ptr, t, ilen);
1537 ptr += ilen;
fd700877
PH
1538
1539 /* For a non-raw header, put in the comma if needed, then add
3168332a
PH
1540 back the newline we removed above, provided there was some text in
1541 the header. */
fd700877 1542
3168332a 1543 if (!want_raw && ilen > 0)
059ec3d9 1544 {
3168332a 1545 if (comma != 0) *ptr++ = ',';
059ec3d9
PH
1546 *ptr++ = '\n';
1547 }
1548 }
1549 }
1550 }
1551 }
1552
fd700877
PH
1553 /* At end of first pass, return NULL if no header found. Then truncate size
1554 if necessary, and get the buffer to hold the data, returning the buffer size.
1555 */
059ec3d9
PH
1556
1557 if (i == 0)
1558 {
1559 if (!found) return NULL;
1560 if (size > header_insert_maxlen) size = header_insert_maxlen;
1561 *newsize = size + 1;
1562 ptr = yield = store_get(*newsize);
1563 }
1564 }
1565
059ec3d9
PH
1566/* That's all we do for raw header expansion. */
1567
1568if (want_raw)
1569 {
1570 *ptr = 0;
1571 }
1572
fd700877
PH
1573/* Otherwise, remove a final newline and a redundant added comma. Then we do
1574RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
059ec3d9
PH
1575function can return an error with decoded data if the charset translation
1576fails. If decoding fails, it returns NULL. */
1577
1578else
1579 {
1580 uschar *decoded, *error;
3168332a 1581 if (ptr > yield && ptr[-1] == '\n') ptr--;
fd700877 1582 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
059ec3d9 1583 *ptr = 0;
a0d6ba8a
PH
1584 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1585 newsize, &error);
059ec3d9
PH
1586 if (error != NULL)
1587 {
1588 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1589 " input was: %s\n", error, yield);
1590 }
1591 if (decoded != NULL) yield = decoded;
1592 }
1593
1594return yield;
1595}
1596
1597
1598
1599
362145b5
JH
1600/*************************************************
1601* Return list of recipients *
1602*************************************************/
1603/* A recipients list is available only during system message filtering,
1604during ACL processing after DATA, and while expanding pipe commands
1605generated from a system filter, but not elsewhere. */
1606
1607static uschar *
1608fn_recipients(void)
1609{
1610if (!enable_dollar_recipients) return NULL; else
1611 {
1612 int size = 128;
1613 int ptr = 0;
1614 int i;
1615 uschar * s = store_get(size);
1616 for (i = 0; i < recipients_count; i++)
1617 {
1618 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1619 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1620 Ustrlen(recipients_list[i].address));
1621 }
1622 s[ptr] = 0; /* string_cat() leaves room */
1623 return s;
1624 }
1625}
1626
1627
059ec3d9
PH
1628/*************************************************
1629* Find value of a variable *
1630*************************************************/
1631
1632/* The table of variables is kept in alphabetic order, so we can search it
1633using a binary chop. The "choplen" variable is nothing to do with the binary
1634chop.
1635
1636Arguments:
1637 name the name of the variable being sought
1638 exists_only TRUE if this is a def: test; passed on to find_header()
1639 skipping TRUE => skip any processing evaluation; this is not the same as
1640 exists_only because def: may test for values that are first
1641 evaluated here
1642 newsize pointer to an int which is initially zero; if the answer is in
1643 a new memory buffer, *newsize is set to its size
1644
1645Returns: NULL if the variable does not exist, or
1646 a pointer to the variable's contents, or
1647 something non-NULL if exists_only is TRUE
1648*/
1649
1650static uschar *
1651find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1652{
9d1c15ef
JH
1653var_entry * vp;
1654uschar *s, *domain;
1655uschar **ss;
1656void * val;
059ec3d9 1657
38a0a95f
PH
1658/* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1659Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1660release 4.64 onwards arbitrary names are permitted, as long as the first 5
641cb756
PH
1661characters are acl_c or acl_m and the sixth is either a digit or an underscore
1662(this gave backwards compatibility at the changeover). There may be built-in
1663variables whose names start acl_ but they should never start in this way. This
1664slightly messy specification is a consequence of the history, needless to say.
47ca6d6c 1665
38a0a95f
PH
1666If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1667set, in which case give an error. */
47ca6d6c 1668
641cb756
PH
1669if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1670 !isalpha(name[5]))
38a0a95f
PH
1671 {
1672 tree_node *node =
1673 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1674 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
47ca6d6c
PH
1675 }
1676
38a0a95f 1677/* Handle $auth<n> variables. */
f78eb7c6
PH
1678
1679if (Ustrncmp(name, "auth", 4) == 0)
1680 {
1681 uschar *endptr;
1682 int n = Ustrtoul(name + 4, &endptr, 10);
1683 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1684 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1685 }
1686
47ca6d6c
PH
1687/* For all other variables, search the table */
1688
9d1c15ef
JH
1689if (!(vp = find_var_ent(name)))
1690 return NULL; /* Unknown variable name */
059ec3d9 1691
9d1c15ef
JH
1692/* Found an existing variable. If in skipping state, the value isn't needed,
1693and we want to avoid processing (such as looking up the host name). */
059ec3d9 1694
9d1c15ef
JH
1695if (skipping)
1696 return US"";
059ec3d9 1697
9d1c15ef
JH
1698val = vp->value;
1699switch (vp->type)
1700 {
1701 case vtype_filter_int:
1702 if (!filter_running) return NULL;
1703 /* Fall through */
1704 /* VVVVVVVVVVVV */
1705 case vtype_int:
1706 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1707 return var_buffer;
1708
1709 case vtype_ino:
1710 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1711 return var_buffer;
1712
1713 case vtype_gid:
1714 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1715 return var_buffer;
1716
1717 case vtype_uid:
1718 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1719 return var_buffer;
1720
1721 case vtype_bool:
1722 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1723 return var_buffer;
1724
1725 case vtype_stringptr: /* Pointer to string */
1726 s = *((uschar **)(val));
1727 return (s == NULL)? US"" : s;
1728
1729 case vtype_pid:
1730 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1731 return var_buffer;
1732
1733 case vtype_load_avg:
1734 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1735 return var_buffer;
1736
1737 case vtype_host_lookup: /* Lookup if not done so */
1738 if (sender_host_name == NULL && sender_host_address != NULL &&
1739 !host_lookup_failed && host_name_lookup() == OK)
1740 host_build_sender_fullhost();
1741 return (sender_host_name == NULL)? US"" : sender_host_name;
1742
1743 case vtype_localpart: /* Get local part from address */
1744 s = *((uschar **)(val));
1745 if (s == NULL) return US"";
1746 domain = Ustrrchr(s, '@');
1747 if (domain == NULL) return s;
1748 if (domain - s > sizeof(var_buffer) - 1)
1749 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1750 " in string expansion", sizeof(var_buffer));
1751 Ustrncpy(var_buffer, s, domain - s);
1752 var_buffer[domain - s] = 0;
1753 return var_buffer;
1754
1755 case vtype_domain: /* Get domain from address */
1756 s = *((uschar **)(val));
1757 if (s == NULL) return US"";
1758 domain = Ustrrchr(s, '@');
1759 return (domain == NULL)? US"" : domain + 1;
1760
1761 case vtype_msgheaders:
1762 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1763
1764 case vtype_msgheaders_raw:
1765 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1766
1767 case vtype_msgbody: /* Pointer to msgbody string */
1768 case vtype_msgbody_end: /* Ditto, the end of the msg */
1769 ss = (uschar **)(val);
1770 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
059ec3d9 1771 {
9d1c15ef
JH
1772 uschar *body;
1773 off_t start_offset = SPOOL_DATA_START_OFFSET;
1774 int len = message_body_visible;
1775 if (len > message_size) len = message_size;
1776 *ss = body = store_malloc(len+1);
1777 body[0] = 0;
1778 if (vp->type == vtype_msgbody_end)
059ec3d9 1779 {
9d1c15ef
JH
1780 struct stat statbuf;
1781 if (fstat(deliver_datafile, &statbuf) == 0)
1782 {
1783 start_offset = statbuf.st_size - len;
1784 if (start_offset < SPOOL_DATA_START_OFFSET)
1785 start_offset = SPOOL_DATA_START_OFFSET;
1786 }
1787 }
1788 lseek(deliver_datafile, start_offset, SEEK_SET);
1789 len = read(deliver_datafile, body, len);
1790 if (len > 0)
1791 {
1792 body[len] = 0;
1793 if (message_body_newlines) /* Separate loops for efficiency */
1794 {
1795 while (len > 0)
1796 { if (body[--len] == 0) body[len] = ' '; }
1797 }
1798 else
1799 {
1800 while (len > 0)
1801 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1802 }
059ec3d9 1803 }
9d1c15ef
JH
1804 }
1805 return (*ss == NULL)? US"" : *ss;
059ec3d9 1806
9d1c15ef
JH
1807 case vtype_todbsdin: /* BSD inbox time of day */
1808 return tod_stamp(tod_bsdin);
059ec3d9 1809
9d1c15ef
JH
1810 case vtype_tode: /* Unix epoch time of day */
1811 return tod_stamp(tod_epoch);
059ec3d9 1812
9d1c15ef
JH
1813 case vtype_todel: /* Unix epoch/usec time of day */
1814 return tod_stamp(tod_epoch_l);
f5787926 1815
9d1c15ef
JH
1816 case vtype_todf: /* Full time of day */
1817 return tod_stamp(tod_full);
059ec3d9 1818
9d1c15ef
JH
1819 case vtype_todl: /* Log format time of day */
1820 return tod_stamp(tod_log_bare); /* (without timezone) */
059ec3d9 1821
9d1c15ef
JH
1822 case vtype_todzone: /* Time zone offset only */
1823 return tod_stamp(tod_zone);
059ec3d9 1824
9d1c15ef
JH
1825 case vtype_todzulu: /* Zulu time */
1826 return tod_stamp(tod_zulu);
059ec3d9 1827
9d1c15ef
JH
1828 case vtype_todlf: /* Log file datestamp tod */
1829 return tod_stamp(tod_log_datestamp_daily);
059ec3d9 1830
9d1c15ef
JH
1831 case vtype_reply: /* Get reply address */
1832 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1833 headers_charset);
1834 if (s != NULL) while (isspace(*s)) s++;
1835 if (s == NULL || *s == 0)
1836 {
1837 *newsize = 0; /* For the *s==0 case */
1838 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1839 }
1840 if (s != NULL)
1841 {
1842 uschar *t;
1843 while (isspace(*s)) s++;
1844 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1845 while (t > s && isspace(t[-1])) t--;
1846 *t = 0;
1847 }
1848 return (s == NULL)? US"" : s;
059ec3d9 1849
9d1c15ef
JH
1850 case vtype_string_func:
1851 {
1852 uschar * (*fn)() = val;
1853 return fn();
1854 }
8e669ac1 1855
9d1c15ef
JH
1856 case vtype_pspace:
1857 {
1858 int inodes;
1859 sprintf(CS var_buffer, "%d",
1860 receive_statvfs(val == (void *)TRUE, &inodes));
1861 }
1862 return var_buffer;
8e669ac1 1863
9d1c15ef
JH
1864 case vtype_pinodes:
1865 {
1866 int inodes;
1867 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1868 sprintf(CS var_buffer, "%d", inodes);
1869 }
1870 return var_buffer;
80a47a2c 1871
9d1c15ef
JH
1872 case vtype_cert:
1873 return *(void **)val ? US"<cert>" : US"";
80a47a2c 1874
9d1c15ef
JH
1875 #ifndef DISABLE_DKIM
1876 case vtype_dkim:
1877 return dkim_exim_expand_query((int)(long)val);
1878 #endif
059ec3d9 1879
9d1c15ef 1880 }
059ec3d9
PH
1881}
1882
1883
1884
1885
d9b2312b
JH
1886void
1887modify_variable(uschar *name, void * value)
1888{
9d1c15ef
JH
1889var_entry * vp;
1890if ((vp = find_var_ent(name))) vp->value = value;
d9b2312b
JH
1891return; /* Unknown variable name, fail silently */
1892}
1893
1894
1895
1896
1897
059ec3d9
PH
1898/*************************************************
1899* Read and expand substrings *
1900*************************************************/
1901
1902/* This function is called to read and expand argument substrings for various
1903expansion items. Some have a minimum requirement that is less than the maximum;
1904in these cases, the first non-present one is set to NULL.
1905
1906Arguments:
1907 sub points to vector of pointers to set
1908 n maximum number of substrings
1909 m minimum required
1910 sptr points to current string pointer
1911 skipping the skipping flag
1912 check_end if TRUE, check for final '}'
1913 name name of item, for error message
b0e85a8f
JH
1914 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1915 the store.
059ec3d9
PH
1916
1917Returns: 0 OK; string pointer updated
1918 1 curly bracketing error (too few arguments)
1919 2 too many arguments (only if check_end is set); message set
1920 3 other error (expansion failure)
1921*/
1922
1923static int
1924read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
b0e85a8f 1925 BOOL check_end, uschar *name, BOOL *resetok)
059ec3d9
PH
1926{
1927int i;
1928uschar *s = *sptr;
1929
1930while (isspace(*s)) s++;
1931for (i = 0; i < n; i++)
1932 {
1933 if (*s != '{')
1934 {
1935 if (i < m) return 1;
1936 sub[i] = NULL;
1937 break;
1938 }
b0e85a8f 1939 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
059ec3d9
PH
1940 if (sub[i] == NULL) return 3;
1941 if (*s++ != '}') return 1;
1942 while (isspace(*s)) s++;
1943 }
1944if (check_end && *s++ != '}')
1945 {
1946 if (s[-1] == '{')
1947 {
1948 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1949 "(max is %d)", name, n);
1950 return 2;
1951 }
1952 return 1;
1953 }
1954
1955*sptr = s;
1956return 0;
1957}
1958
1959
1960
1961
641cb756
PH
1962/*************************************************
1963* Elaborate message for bad variable *
1964*************************************************/
1965
1966/* For the "unknown variable" message, take a look at the variable's name, and
1967give additional information about possible ACL variables. The extra information
1968is added on to expand_string_message.
1969
1970Argument: the name of the variable
1971Returns: nothing
1972*/
1973
1974static void
1975check_variable_error_message(uschar *name)
1976{
1977if (Ustrncmp(name, "acl_", 4) == 0)
1978 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1979 (name[4] == 'c' || name[4] == 'm')?
1980 (isalpha(name[5])?
1981 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1982 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1983 ) :
1984 US"user-defined ACL variables must start acl_c or acl_m");
1985}
1986
1987
1988
f60d98e8
JH
1989/*
1990Load args from sub array to globals, and call acl_check().
ef21c07d 1991Sub array will be corrupted on return.
f60d98e8
JH
1992
1993Returns: OK access is granted by an ACCEPT verb
1994 DISCARD access is granted by a DISCARD verb
1995 FAIL access is denied
1996 FAIL_DROP access is denied; drop the connection
1997 DEFER can't tell at the moment
1998 ERROR disaster
1999*/
2000static int
2001eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2002{
2003int i;
ef21c07d
JH
2004uschar *tmp;
2005int sav_narg = acl_narg;
2006int ret;
faa05a93 2007extern int acl_where;
f60d98e8 2008
ef21c07d
JH
2009if(--nsub > sizeof(acl_arg)/sizeof(*acl_arg)) nsub = sizeof(acl_arg)/sizeof(*acl_arg);
2010for (i = 0; i < nsub && sub[i+1]; i++)
2011 {
2012 tmp = acl_arg[i];
2013 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2014 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2015 }
2016acl_narg = i;
bef3ea7f 2017while (i < nsub)
ef21c07d
JH
2018 {
2019 sub[i+1] = acl_arg[i];
2020 acl_arg[i++] = NULL;
2021 }
f60d98e8
JH
2022
2023DEBUG(D_expand)
2024 debug_printf("expanding: acl: %s arg: %s%s\n",
2025 sub[0],
60f8e1e8
JH
2026 acl_narg>0 ? acl_arg[0] : US"<none>",
2027 acl_narg>1 ? " +more" : "");
f60d98e8 2028
05caaeaa 2029ret = acl_eval(acl_where, sub[0], user_msgp, &tmp);
ef21c07d
JH
2030
2031for (i = 0; i < nsub; i++)
2032 acl_arg[i] = sub[i+1]; /* restore old args */
2033acl_narg = sav_narg;
2034
2035return ret;
f60d98e8
JH
2036}
2037
2038
2039
2040
059ec3d9
PH
2041/*************************************************
2042* Read and evaluate a condition *
2043*************************************************/
2044
2045/*
2046Arguments:
2047 s points to the start of the condition text
b0e85a8f
JH
2048 resetok points to a BOOL which is written false if it is unsafe to
2049 free memory. Certain condition types (acl) may have side-effect
2050 allocation which must be preserved.
059ec3d9
PH
2051 yield points to a BOOL to hold the result of the condition test;
2052 if NULL, we are just reading through a condition that is
2053 part of an "or" combination to check syntax, or in a state
2054 where the answer isn't required
2055
2056Returns: a pointer to the first character after the condition, or
2057 NULL after an error
2058*/
2059
2060static uschar *
b0e85a8f 2061eval_condition(uschar *s, BOOL *resetok, BOOL *yield)
059ec3d9
PH
2062{
2063BOOL testfor = TRUE;
2064BOOL tempcond, combined_cond;
2065BOOL *subcondptr;
5cfd2e57 2066BOOL sub2_honour_dollar = TRUE;
059ec3d9 2067int i, rc, cond_type, roffset;
97d17305 2068int_eximarith_t num[2];
059ec3d9
PH
2069struct stat statbuf;
2070uschar name[256];
f60d98e8 2071uschar *sub[10];
059ec3d9
PH
2072
2073const pcre *re;
2074const uschar *rerror;
2075
2076for (;;)
2077 {
2078 while (isspace(*s)) s++;
2079 if (*s == '!') { testfor = !testfor; s++; } else break;
2080 }
2081
2082/* Numeric comparisons are symbolic */
2083
2084if (*s == '=' || *s == '>' || *s == '<')
2085 {
2086 int p = 0;
2087 name[p++] = *s++;
2088 if (*s == '=')
2089 {
2090 name[p++] = '=';
2091 s++;
2092 }
2093 name[p] = 0;
2094 }
2095
2096/* All other conditions are named */
2097
2098else s = read_name(name, 256, s, US"_");
2099
2100/* If we haven't read a name, it means some non-alpha character is first. */
2101
2102if (name[0] == 0)
2103 {
2104 expand_string_message = string_sprintf("condition name expected, "
2105 "but found \"%.16s\"", s);
2106 return NULL;
2107 }
2108
2109/* Find which condition we are dealing with, and switch on it */
2110
2111cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
2112switch(cond_type)
2113 {
9b4768fa
PH
2114 /* def: tests for a non-empty variable, or for the existence of a header. If
2115 yield == NULL we are in a skipping state, and don't care about the answer. */
059ec3d9
PH
2116
2117 case ECOND_DEF:
2118 if (*s != ':')
2119 {
2120 expand_string_message = US"\":\" expected after \"def\"";
2121 return NULL;
2122 }
2123
2124 s = read_name(name, 256, s+1, US"_");
2125
0d85fa3f
PH
2126 /* Test for a header's existence. If the name contains a closing brace
2127 character, this may be a user error where the terminating colon has been
2128 omitted. Set a flag to adjust a subsequent error message in this case. */
059ec3d9
PH
2129
2130 if (Ustrncmp(name, "h_", 2) == 0 ||
2131 Ustrncmp(name, "rh_", 3) == 0 ||
2132 Ustrncmp(name, "bh_", 3) == 0 ||
2133 Ustrncmp(name, "header_", 7) == 0 ||
2134 Ustrncmp(name, "rheader_", 8) == 0 ||
2135 Ustrncmp(name, "bheader_", 8) == 0)
2136 {
2137 s = read_header_name(name, 256, s);
b5b871ac 2138 /* {-for-text-editors */
0d85fa3f 2139 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
059ec3d9
PH
2140 if (yield != NULL) *yield =
2141 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2142 }
2143
9b4768fa
PH
2144 /* Test for a variable's having a non-empty value. A non-existent variable
2145 causes an expansion failure. */
059ec3d9
PH
2146
2147 else
2148 {
2149 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2150 if (value == NULL)
2151 {
2152 expand_string_message = (name[0] == 0)?
2153 string_sprintf("variable name omitted after \"def:\"") :
2154 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
641cb756 2155 check_variable_error_message(name);
059ec3d9
PH
2156 return NULL;
2157 }
9b4768fa 2158 if (yield != NULL) *yield = (value[0] != 0) == testfor;
059ec3d9
PH
2159 }
2160
2161 return s;
2162
2163
2164 /* first_delivery tests for first delivery attempt */
2165
2166 case ECOND_FIRST_DELIVERY:
2167 if (yield != NULL) *yield = deliver_firsttime == testfor;
2168 return s;
2169
2170
2171 /* queue_running tests for any process started by a queue runner */
2172
2173 case ECOND_QUEUE_RUNNING:
2174 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2175 return s;
2176
2177
2178 /* exists: tests for file existence
2179 isip: tests for any IP address
2180 isip4: tests for an IPv4 address
2181 isip6: tests for an IPv6 address
2182 pam: does PAM authentication
2183 radius: does RADIUS authentication
2184 ldapauth: does LDAP authentication
2185 pwcheck: does Cyrus SASL pwcheck authentication
2186 */
2187
2188 case ECOND_EXISTS:
2189 case ECOND_ISIP:
2190 case ECOND_ISIP4:
2191 case ECOND_ISIP6:
2192 case ECOND_PAM:
2193 case ECOND_RADIUS:
2194 case ECOND_LDAPAUTH:
2195 case ECOND_PWCHECK:
2196
2197 while (isspace(*s)) s++;
b5b871ac 2198 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
059ec3d9 2199
b0e85a8f 2200 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
059ec3d9 2201 if (sub[0] == NULL) return NULL;
b5b871ac 2202 /* {-for-text-editors */
059ec3d9
PH
2203 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2204
2205 if (yield == NULL) return s; /* No need to run the test if skipping */
2206
2207 switch(cond_type)
2208 {
2209 case ECOND_EXISTS:
2210 if ((expand_forbid & RDO_EXISTS) != 0)
2211 {
2212 expand_string_message = US"File existence tests are not permitted";
2213 return NULL;
2214 }
2215 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2216 break;
2217
2218 case ECOND_ISIP:
2219 case ECOND_ISIP4:
2220 case ECOND_ISIP6:
2221 rc = string_is_ip_address(sub[0], NULL);
7e66e54d 2222 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
059ec3d9
PH
2223 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2224 break;
2225
2226 /* Various authentication tests - all optionally compiled */
2227
2228 case ECOND_PAM:
2229 #ifdef SUPPORT_PAM
2230 rc = auth_call_pam(sub[0], &expand_string_message);
2231 goto END_AUTH;
2232 #else
2233 goto COND_FAILED_NOT_COMPILED;
2234 #endif /* SUPPORT_PAM */
2235
2236 case ECOND_RADIUS:
2237 #ifdef RADIUS_CONFIG_FILE
2238 rc = auth_call_radius(sub[0], &expand_string_message);
2239 goto END_AUTH;
2240 #else
2241 goto COND_FAILED_NOT_COMPILED;
2242 #endif /* RADIUS_CONFIG_FILE */
2243
2244 case ECOND_LDAPAUTH:
2245 #ifdef LOOKUP_LDAP
2246 {
2247 /* Just to keep the interface the same */
2248 BOOL do_cache;
2249 int old_pool = store_pool;
2250 store_pool = POOL_SEARCH;
2251 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2252 &expand_string_message, &do_cache);
2253 store_pool = old_pool;
2254 }
2255 goto END_AUTH;
2256 #else
2257 goto COND_FAILED_NOT_COMPILED;
2258 #endif /* LOOKUP_LDAP */
2259
2260 case ECOND_PWCHECK:
2261 #ifdef CYRUS_PWCHECK_SOCKET
2262 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2263 goto END_AUTH;
2264 #else
2265 goto COND_FAILED_NOT_COMPILED;
2266 #endif /* CYRUS_PWCHECK_SOCKET */
2267
2268 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2269 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2270 END_AUTH:
2271 if (rc == ERROR || rc == DEFER) return NULL;
2272 *yield = (rc == OK) == testfor;
2273 #endif
2274 }
2275 return s;
2276
2277
333eea9c
JH
2278 /* call ACL (in a conditional context). Accept true, deny false.
2279 Defer is a forced-fail. Anything set by message= goes to $value.
f60d98e8
JH
2280 Up to ten parameters are used; we use the braces round the name+args
2281 like the saslauthd condition does, to permit a variable number of args.
2282 See also the expansion-item version EITEM_ACL and the traditional
2283 acl modifier ACLC_ACL.
fd5dad68
JH
2284 Since the ACL may allocate new global variables, tell our caller to not
2285 reclaim memory.
f60d98e8 2286 */
333eea9c
JH
2287
2288 case ECOND_ACL:
bef3ea7f 2289 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
333eea9c 2290 {
333eea9c 2291 uschar *user_msg;
333eea9c 2292 BOOL cond = FALSE;
bef3ea7f
JH
2293 int size = 0;
2294 int ptr = 0;
333eea9c
JH
2295
2296 while (isspace(*s)) s++;
6d9cfc47 2297 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
333eea9c 2298
f60d98e8 2299 switch(read_subs(sub, sizeof(sub)/sizeof(*sub), 1,
b0e85a8f 2300 &s, yield == NULL, TRUE, US"acl", resetok))
333eea9c 2301 {
f60d98e8
JH
2302 case 1: expand_string_message = US"too few arguments or bracketing "
2303 "error for acl";
2304 case 2:
2305 case 3: return NULL;
333eea9c 2306 }
f60d98e8 2307
b0e85a8f 2308 *resetok = FALSE;
bef3ea7f 2309 if (yield != NULL) switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
f60d98e8
JH
2310 {
2311 case OK:
2312 cond = TRUE;
2313 case FAIL:
bef3ea7f 2314 lookup_value = NULL;
f60d98e8 2315 if (user_msg)
bef3ea7f 2316 {
f60d98e8 2317 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
bef3ea7f
JH
2318 lookup_value[ptr] = '\0';
2319 }
b5b871ac 2320 *yield = cond == testfor;
f60d98e8
JH
2321 break;
2322
2323 case DEFER:
2324 expand_string_forcedfail = TRUE;
2325 default:
2326 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2327 return NULL;
2328 }
2329 return s;
333eea9c 2330 }
333eea9c
JH
2331
2332
059ec3d9
PH
2333 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2334
b0e85a8f 2335 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
059ec3d9
PH
2336
2337 However, the last two are optional. That is why the whole set is enclosed
333eea9c 2338 in their own set of braces. */
059ec3d9
PH
2339
2340 case ECOND_SASLAUTHD:
2341 #ifndef CYRUS_SASLAUTHD_SOCKET
2342 goto COND_FAILED_NOT_COMPILED;
2343 #else
2344 while (isspace(*s)) s++;
b5b871ac 2345 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
b0e85a8f 2346 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd", resetok))
059ec3d9
PH
2347 {
2348 case 1: expand_string_message = US"too few arguments or bracketing "
2349 "error for saslauthd";
2350 case 2:
2351 case 3: return NULL;
2352 }
2353 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2354 if (yield != NULL)
2355 {
2356 int rc;
2357 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2358 &expand_string_message);
2359 if (rc == ERROR || rc == DEFER) return NULL;
2360 *yield = (rc == OK) == testfor;
2361 }
2362 return s;
2363 #endif /* CYRUS_SASLAUTHD_SOCKET */
2364
2365
2366 /* symbolic operators for numeric and string comparison, and a number of
2367 other operators, all requiring two arguments.
2368
76dca828
PP
2369 crypteq: encrypts plaintext and compares against an encrypted text,
2370 using crypt(), crypt16(), MD5 or SHA-1
2371 inlist/inlisti: checks if first argument is in the list of the second
059ec3d9
PH
2372 match: does a regular expression match and sets up the numerical
2373 variables if it succeeds
2374 match_address: matches in an address list
2375 match_domain: matches in a domain list
32d668a5 2376 match_ip: matches a host list that is restricted to IP addresses
059ec3d9 2377 match_local_part: matches in a local part list
059ec3d9
PH
2378 */
2379
059ec3d9
PH
2380 case ECOND_MATCH_ADDRESS:
2381 case ECOND_MATCH_DOMAIN:
32d668a5 2382 case ECOND_MATCH_IP:
059ec3d9 2383 case ECOND_MATCH_LOCAL_PART:
da6dbe26
PP
2384#ifndef EXPAND_LISTMATCH_RHS
2385 sub2_honour_dollar = FALSE;
2386#endif
2387 /* FALLTHROUGH */
2388
2389 case ECOND_CRYPTEQ:
2390 case ECOND_INLIST:
2391 case ECOND_INLISTI:
2392 case ECOND_MATCH:
059ec3d9
PH
2393
2394 case ECOND_NUM_L: /* Numerical comparisons */
2395 case ECOND_NUM_LE:
2396 case ECOND_NUM_E:
2397 case ECOND_NUM_EE:
2398 case ECOND_NUM_G:
2399 case ECOND_NUM_GE:
2400
2401 case ECOND_STR_LT: /* String comparisons */
2402 case ECOND_STR_LTI:
2403 case ECOND_STR_LE:
2404 case ECOND_STR_LEI:
2405 case ECOND_STR_EQ:
2406 case ECOND_STR_EQI:
2407 case ECOND_STR_GT:
2408 case ECOND_STR_GTI:
2409 case ECOND_STR_GE:
2410 case ECOND_STR_GEI:
2411
2412 for (i = 0; i < 2; i++)
2413 {
da6dbe26
PP
2414 /* Sometimes, we don't expand substrings; too many insecure configurations
2415 created using match_address{}{} and friends, where the second param
2416 includes information from untrustworthy sources. */
2417 BOOL honour_dollar = TRUE;
2418 if ((i > 0) && !sub2_honour_dollar)
2419 honour_dollar = FALSE;
2420
059ec3d9
PH
2421 while (isspace(*s)) s++;
2422 if (*s != '{')
2423 {
2424 if (i == 0) goto COND_FAILED_CURLY_START;
2425 expand_string_message = string_sprintf("missing 2nd string in {} "
2426 "after \"%s\"", name);
2427 return NULL;
2428 }
da6dbe26 2429 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
b0e85a8f 2430 honour_dollar, resetok);
059ec3d9
PH
2431 if (sub[i] == NULL) return NULL;
2432 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2433
2434 /* Convert to numerical if required; we know that the names of all the
2435 conditions that compare numbers do not start with a letter. This just saves
2436 checking for them individually. */
2437
d6066548 2438 if (!isalpha(name[0]) && yield != NULL)
059ec3d9 2439 {
5dd1517f
PH
2440 if (sub[i][0] == 0)
2441 {
2442 num[i] = 0;
2443 DEBUG(D_expand)
2444 debug_printf("empty string cast to zero for numerical comparison\n");
2445 }
2446 else
2447 {
2448 num[i] = expand_string_integer(sub[i], FALSE);
2449 if (expand_string_message != NULL) return NULL;
2450 }
059ec3d9
PH
2451 }
2452 }
2453
2454 /* Result not required */
2455
2456 if (yield == NULL) return s;
2457
2458 /* Do an appropriate comparison */
2459
2460 switch(cond_type)
2461 {
2462 case ECOND_NUM_E:
2463 case ECOND_NUM_EE:
b5b871ac 2464 tempcond = (num[0] == num[1]);
059ec3d9
PH
2465 break;
2466
2467 case ECOND_NUM_G:
b5b871ac 2468 tempcond = (num[0] > num[1]);
059ec3d9
PH
2469 break;
2470
2471 case ECOND_NUM_GE:
b5b871ac 2472 tempcond = (num[0] >= num[1]);
059ec3d9
PH
2473 break;
2474
2475 case ECOND_NUM_L:
b5b871ac 2476 tempcond = (num[0] < num[1]);
059ec3d9
PH
2477 break;
2478
2479 case ECOND_NUM_LE:
b5b871ac 2480 tempcond = (num[0] <= num[1]);
059ec3d9
PH
2481 break;
2482
2483 case ECOND_STR_LT:
b5b871ac 2484 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
059ec3d9
PH
2485 break;
2486
2487 case ECOND_STR_LTI:
b5b871ac 2488 tempcond = (strcmpic(sub[0], sub[1]) < 0);
059ec3d9
PH
2489 break;
2490
2491 case ECOND_STR_LE:
b5b871ac 2492 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
059ec3d9
PH
2493 break;
2494
2495 case ECOND_STR_LEI:
b5b871ac 2496 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
059ec3d9
PH
2497 break;
2498
2499 case ECOND_STR_EQ:
b5b871ac 2500 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
059ec3d9
PH
2501 break;
2502
2503 case ECOND_STR_EQI:
b5b871ac 2504 tempcond = (strcmpic(sub[0], sub[1]) == 0);
059ec3d9
PH
2505 break;
2506
2507 case ECOND_STR_GT:
b5b871ac 2508 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
059ec3d9
PH
2509 break;
2510
2511 case ECOND_STR_GTI:
b5b871ac 2512 tempcond = (strcmpic(sub[0], sub[1]) > 0);
059ec3d9
PH
2513 break;
2514
2515 case ECOND_STR_GE:
b5b871ac 2516 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
059ec3d9
PH
2517 break;
2518
2519 case ECOND_STR_GEI:
b5b871ac 2520 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
059ec3d9
PH
2521 break;
2522
2523 case ECOND_MATCH: /* Regular expression match */
2524 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2525 NULL);
2526 if (re == NULL)
2527 {
2528 expand_string_message = string_sprintf("regular expression error in "
2529 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2530 return NULL;
2531 }
b5b871ac 2532 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
059ec3d9
PH
2533 break;
2534
2535 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2536 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2537 goto MATCHED_SOMETHING;
2538
2539 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2540 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2541 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2542 goto MATCHED_SOMETHING;
2543
32d668a5 2544 case ECOND_MATCH_IP: /* Match IP address in a host list */
7e66e54d 2545 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
32d668a5
PH
2546 {
2547 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2548 sub[0]);
2549 return NULL;
2550 }
2551 else
2552 {
2553 unsigned int *nullcache = NULL;
2554 check_host_block cb;
2555
2556 cb.host_name = US"";
2557 cb.host_address = sub[0];
2558
2559 /* If the host address starts off ::ffff: it is an IPv6 address in
2560 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2561 addresses. */
2562
2563 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2564 cb.host_address + 7 : cb.host_address;
2565
2566 rc = match_check_list(
2567 &sub[1], /* the list */
2568 0, /* separator character */
2569 &hostlist_anchor, /* anchor pointer */
2570 &nullcache, /* cache pointer */
2571 check_host, /* function for testing */
2572 &cb, /* argument for function */
2573 MCL_HOST, /* type of check */
2574 sub[0], /* text for debugging */
2575 NULL); /* where to pass back data */
2576 }
2577 goto MATCHED_SOMETHING;
2578
059ec3d9
PH
2579 case ECOND_MATCH_LOCAL_PART:
2580 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2581 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2582 /* Fall through */
9a26b6b2 2583 /* VVVVVVVVVVVV */
059ec3d9
PH
2584 MATCHED_SOMETHING:
2585 switch(rc)
2586 {
2587 case OK:
b5b871ac 2588 tempcond = TRUE;
059ec3d9
PH
2589 break;
2590
2591 case FAIL:
b5b871ac 2592 tempcond = FALSE;
059ec3d9
PH
2593 break;
2594
2595 case DEFER:
2596 expand_string_message = string_sprintf("unable to complete match "
2597 "against \"%s\": %s", sub[1], search_error_message);
2598 return NULL;
2599 }
2600
2601 break;
2602
2603 /* Various "encrypted" comparisons. If the second string starts with
2604 "{" then an encryption type is given. Default to crypt() or crypt16()
2605 (build-time choice). */
b5b871ac 2606 /* }-for-text-editors */
059ec3d9
PH
2607
2608 case ECOND_CRYPTEQ:
2609 #ifndef SUPPORT_CRYPTEQ
2610 goto COND_FAILED_NOT_COMPILED;
2611 #else
2612 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2613 {
2614 int sublen = Ustrlen(sub[1]+5);
2615 md5 base;
2616 uschar digest[16];
2617
2618 md5_start(&base);
2619 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2620
2621 /* If the length that we are comparing against is 24, the MD5 digest
2622 is expressed as a base64 string. This is the way LDAP does it. However,
2623 some other software uses a straightforward hex representation. We assume
2624 this if the length is 32. Other lengths fail. */
2625
2626 if (sublen == 24)
2627 {
2628 uschar *coded = auth_b64encode((uschar *)digest, 16);
2629 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2630 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
b5b871ac 2631 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
059ec3d9
PH
2632 }
2633 else if (sublen == 32)
2634 {
2635 int i;
2636 uschar coded[36];
2637 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2638 coded[32] = 0;
2639 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2640 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
b5b871ac 2641 tempcond = (strcmpic(coded, sub[1]+5) == 0);
059ec3d9
PH
2642 }
2643 else
2644 {
2645 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2646 "fail\n crypted=%s\n", sub[1]+5);
b5b871ac 2647 tempcond = FALSE;
059ec3d9
PH
2648 }
2649 }
2650
2651 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2652 {
2653 int sublen = Ustrlen(sub[1]+6);
2654 sha1 base;
2655 uschar digest[20];
2656
2657 sha1_start(&base);
2658 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2659
2660 /* If the length that we are comparing against is 28, assume the SHA1
2661 digest is expressed as a base64 string. If the length is 40, assume a
2662 straightforward hex representation. Other lengths fail. */
2663
2664 if (sublen == 28)
2665 {
2666 uschar *coded = auth_b64encode((uschar *)digest, 20);
2667 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2668 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
b5b871ac 2669 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
059ec3d9
PH
2670 }
2671 else if (sublen == 40)
2672 {
2673 int i;
2674 uschar coded[44];
2675 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2676 coded[40] = 0;
2677 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2678 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
b5b871ac 2679 tempcond = (strcmpic(coded, sub[1]+6) == 0);
059ec3d9
PH
2680 }
2681 else
2682 {
2683 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2684 "fail\n crypted=%s\n", sub[1]+6);
b5b871ac 2685 tempcond = FALSE;
059ec3d9
PH
2686 }
2687 }
2688
2689 else /* {crypt} or {crypt16} and non-{ at start */
76dca828 2690 /* }-for-text-editors */
059ec3d9
PH
2691 {
2692 int which = 0;
2693 uschar *coded;
2694
2695 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2696 {
2697 sub[1] += 7;
2698 which = 1;
2699 }
2700 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2701 {
2702 sub[1] += 9;
2703 which = 2;
2704 }
b5b871ac 2705 else if (sub[1][0] == '{') /* }-for-text-editors */
059ec3d9
PH
2706 {
2707 expand_string_message = string_sprintf("unknown encryption mechanism "
2708 "in \"%s\"", sub[1]);
2709 return NULL;
2710 }
2711
2712 switch(which)
2713 {
2714 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2715 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2716 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2717 }
2718
2719 #define STR(s) # s
2720 #define XSTR(s) STR(s)
2721 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2722 " subject=%s\n crypted=%s\n",
2723 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2724 coded, sub[1]);
2725 #undef STR
2726 #undef XSTR
2727
2728 /* If the encrypted string contains fewer than two characters (for the
2729 salt), force failure. Otherwise we get false positives: with an empty
2730 string the yield of crypt() is an empty string! */
2731
b5b871ac
JH
2732 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2733 (Ustrcmp(coded, sub[1]) == 0);
059ec3d9
PH
2734 }
2735 break;
2736 #endif /* SUPPORT_CRYPTEQ */
76dca828
PP
2737
2738 case ECOND_INLIST:
2739 case ECOND_INLISTI:
2740 {
2741 int sep = 0;
76dca828
PP
2742 uschar *save_iterate_item = iterate_item;
2743 int (*compare)(const uschar *, const uschar *);
2744
b5b871ac 2745 tempcond = FALSE;
76dca828
PP
2746 if (cond_type == ECOND_INLISTI)
2747 compare = strcmpic;
2748 else
2749 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2750
2751 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2752 if (compare(sub[0], iterate_item) == 0)
2753 {
b5b871ac 2754 tempcond = TRUE;
76dca828
PP
2755 break;
2756 }
2757 iterate_item = save_iterate_item;
76dca828
PP
2758 }
2759
059ec3d9
PH
2760 } /* Switch for comparison conditions */
2761
b5b871ac 2762 *yield = tempcond == testfor;
059ec3d9
PH
2763 return s; /* End of comparison conditions */
2764
2765
2766 /* and/or: computes logical and/or of several conditions */
2767
2768 case ECOND_AND:
2769 case ECOND_OR:
2770 subcondptr = (yield == NULL)? NULL : &tempcond;
2771 combined_cond = (cond_type == ECOND_AND);
2772
2773 while (isspace(*s)) s++;
b5b871ac 2774 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
059ec3d9
PH
2775
2776 for (;;)
2777 {
2778 while (isspace(*s)) s++;
b5b871ac 2779 /* {-for-text-editors */
059ec3d9 2780 if (*s == '}') break;
b5b871ac 2781 if (*s != '{') /* }-for-text-editors */
059ec3d9
PH
2782 {
2783 expand_string_message = string_sprintf("each subcondition "
2784 "inside an \"%s{...}\" condition must be in its own {}", name);
2785 return NULL;
2786 }
2787
b0e85a8f 2788 if (!(s = eval_condition(s+1, resetok, subcondptr)))
059ec3d9
PH
2789 {
2790 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2791 expand_string_message, name);
2792 return NULL;
2793 }
2794 while (isspace(*s)) s++;
2795
b5b871ac 2796 /* {-for-text-editors */
059ec3d9
PH
2797 if (*s++ != '}')
2798 {
b5b871ac 2799 /* {-for-text-editors */
059ec3d9
PH
2800 expand_string_message = string_sprintf("missing } at end of condition "
2801 "inside \"%s\" group", name);
2802 return NULL;
2803 }
2804
2805 if (yield != NULL)
2806 {
2807 if (cond_type == ECOND_AND)
2808 {
2809 combined_cond &= tempcond;
2810 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2811 } /* evaluate any more */
2812 else
2813 {
2814 combined_cond |= tempcond;
2815 if (combined_cond) subcondptr = NULL; /* once true, don't */
2816 } /* evaluate any more */
2817 }
2818 }
2819
2820 if (yield != NULL) *yield = (combined_cond == testfor);
2821 return ++s;
2822
2823
0ce9abe6
PH
2824 /* forall/forany: iterates a condition with different values */
2825
2826 case ECOND_FORALL:
2827 case ECOND_FORANY:
2828 {
2829 int sep = 0;
282b357d 2830 uschar *save_iterate_item = iterate_item;
0ce9abe6
PH
2831
2832 while (isspace(*s)) s++;
b5b871ac 2833 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
b0e85a8f 2834 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
0ce9abe6 2835 if (sub[0] == NULL) return NULL;
b5b871ac 2836 /* {-for-text-editors */
0ce9abe6
PH
2837 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2838
2839 while (isspace(*s)) s++;
b5b871ac 2840 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
0ce9abe6
PH
2841
2842 sub[1] = s;
2843
2844 /* Call eval_condition once, with result discarded (as if scanning a
2845 "false" part). This allows us to find the end of the condition, because if
2846 the list it empty, we won't actually evaluate the condition for real. */
2847
b0e85a8f 2848 if (!(s = eval_condition(sub[1], resetok, NULL)))
0ce9abe6
PH
2849 {
2850 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2851 expand_string_message, name);
2852 return NULL;
2853 }
2854 while (isspace(*s)) s++;
2855
b5b871ac 2856 /* {-for-text-editors */
0ce9abe6
PH
2857 if (*s++ != '}')
2858 {
b5b871ac 2859 /* {-for-text-editors */
0ce9abe6
PH
2860 expand_string_message = string_sprintf("missing } at end of condition "
2861 "inside \"%s\"", name);
2862 return NULL;
2863 }
2864
2865 if (yield != NULL) *yield = !testfor;
2866 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2867 {
2868 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
b0e85a8f 2869 if (!eval_condition(sub[1], resetok, &tempcond))
0ce9abe6
PH
2870 {
2871 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2872 expand_string_message, name);
e58c13cc 2873 iterate_item = save_iterate_item;
0ce9abe6
PH
2874 return NULL;
2875 }
2876 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2877 tempcond? "true":"false");
2878
2879 if (yield != NULL) *yield = (tempcond == testfor);
2880 if (tempcond == (cond_type == ECOND_FORANY)) break;
2881 }
2882
282b357d 2883 iterate_item = save_iterate_item;
0ce9abe6
PH
2884 return s;
2885 }
2886
2887
f3766eb5
NM
2888 /* The bool{} expansion condition maps a string to boolean.
2889 The values supported should match those supported by the ACL condition
2890 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2891 of true/false. Note that Router "condition" rules have a different
2892 interpretation, where general data can be used and only a few values
2893 map to FALSE.
2894 Note that readconf.c boolean matching, for boolean configuration options,
6a8de854
PP
2895 only matches true/yes/false/no.
2896 The bool_lax{} condition matches the Router logic, which is much more
2897 liberal. */
f3766eb5 2898 case ECOND_BOOL:
6a8de854 2899 case ECOND_BOOL_LAX:
f3766eb5
NM
2900 {
2901 uschar *sub_arg[1];
71265ae9 2902 uschar *t, *t2;
6a8de854 2903 uschar *ourname;
f3766eb5
NM
2904 size_t len;
2905 BOOL boolvalue = FALSE;
2906 while (isspace(*s)) s++;
b5b871ac 2907 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
6a8de854 2908 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
b0e85a8f 2909 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
f3766eb5 2910 {
6a8de854
PP
2911 case 1: expand_string_message = string_sprintf(
2912 "too few arguments or bracketing error for %s",
2913 ourname);
f3766eb5
NM
2914 /*FALLTHROUGH*/
2915 case 2:
2916 case 3: return NULL;
2917 }
2918 t = sub_arg[0];
2919 while (isspace(*t)) t++;
2920 len = Ustrlen(t);
71265ae9
PP
2921 if (len)
2922 {
2923 /* trailing whitespace: seems like a good idea to ignore it too */
2924 t2 = t + len - 1;
2925 while (isspace(*t2)) t2--;
2926 if (t2 != (t + len))
2927 {
2928 *++t2 = '\0';
2929 len = t2 - t;
2930 }
2931 }
f3766eb5 2932 DEBUG(D_expand)
6a8de854
PP
2933 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2934 /* logic for the lax case from expand_check_condition(), which also does
2935 expands, and the logic is both short and stable enough that there should
2936 be no maintenance burden from replicating it. */
f3766eb5
NM
2937 if (len == 0)
2938 boolvalue = FALSE;
51c7471d
JH
2939 else if (*t == '-'
2940 ? Ustrspn(t+1, "0123456789") == len-1
2941 : Ustrspn(t, "0123456789") == len)
6a8de854 2942 {
f3766eb5 2943 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
6a8de854
PP
2944 /* expand_check_condition only does a literal string "0" check */
2945 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2946 boolvalue = TRUE;
2947 }
f3766eb5
NM
2948 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2949 boolvalue = TRUE;
2950 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2951 boolvalue = FALSE;
6a8de854
PP
2952 else if (cond_type == ECOND_BOOL_LAX)
2953 boolvalue = TRUE;
f3766eb5
NM
2954 else
2955 {
2956 expand_string_message = string_sprintf("unrecognised boolean "
2957 "value \"%s\"", t);
2958 return NULL;
2959 }
5ee6f336 2960 if (yield != NULL) *yield = (boolvalue == testfor);
f3766eb5
NM
2961 return s;
2962 }
2963
059ec3d9
PH
2964 /* Unknown condition */
2965
2966 default:
2967 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2968 return NULL;
2969 } /* End switch on condition type */
2970
2971/* Missing braces at start and end of data */
2972
2973COND_FAILED_CURLY_START:
2974expand_string_message = string_sprintf("missing { after \"%s\"", name);
2975return NULL;
2976
2977COND_FAILED_CURLY_END:
2978expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2979 name);
2980return NULL;
2981
2982/* A condition requires code that is not compiled */
2983
2984#if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2985 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2986 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2987COND_FAILED_NOT_COMPILED:
2988expand_string_message = string_sprintf("support for \"%s\" not compiled",
2989 name);
2990return NULL;
2991#endif
2992}
2993
2994
2995
2996
2997/*************************************************
2998* Save numerical variables *
2999*************************************************/
3000
3001/* This function is called from items such as "if" that want to preserve and
3002restore the numbered variables.
3003
3004Arguments:
3005 save_expand_string points to an array of pointers to set
3006 save_expand_nlength points to an array of ints for the lengths
3007
3008Returns: the value of expand max to save
3009*/
3010
3011static int
3012save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3013{
3014int i;
3015for (i = 0; i <= expand_nmax; i++)
3016 {
3017 save_expand_nstring[i] = expand_nstring[i];
3018 save_expand_nlength[i] = expand_nlength[i];
3019 }
3020return expand_nmax;
3021}
3022
3023
3024
3025/*************************************************
3026* Restore numerical variables *
3027*************************************************/
3028
3029/* This function restored saved values of numerical strings.
3030
3031Arguments:
3032 save_expand_nmax the number of strings to restore
3033 save_expand_string points to an array of pointers
3034 save_expand_nlength points to an array of ints
3035
3036Returns: nothing
3037*/
3038
3039static void
3040restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3041 int *save_expand_nlength)
3042{
3043int i;
3044expand_nmax = save_expand_nmax;
3045for (i = 0; i <= expand_nmax; i++)
3046 {
3047 expand_nstring[i] = save_expand_nstring[i];
3048 expand_nlength[i] = save_expand_nlength[i];
3049 }
3050}
3051
3052
3053
3054
3055
3056/*************************************************
3057* Handle yes/no substrings *
3058*************************************************/
3059
3060/* This function is used by ${if}, ${lookup} and ${extract} to handle the
3061alternative substrings that depend on whether or not the condition was true,
3062or the lookup or extraction succeeded. The substrings always have to be
3063expanded, to check their syntax, but "skipping" is set when the result is not
3064needed - this avoids unnecessary nested lookups.
3065
3066Arguments:
3067 skipping TRUE if we were skipping when this item was reached
3068 yes TRUE if the first string is to be used, else use the second
3069 save_lookup a value to put back into lookup_value before the 2nd expansion
3070 sptr points to the input string pointer
3071 yieldptr points to the output string pointer
3072 sizeptr points to the output string size
3073 ptrptr points to the output string pointer
3074 type "lookup" or "if" or "extract" or "run", for error message
b0e85a8f
JH
3075 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3076 the store.
059ec3d9
PH
3077
3078Returns: 0 OK; lookup_value has been reset to save_lookup
3079 1 expansion failed
3080 2 expansion failed because of bracketing error
3081*/
3082
3083static int
3084process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
b0e85a8f 3085 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
059ec3d9
PH
3086{
3087int rc = 0;
3088uschar *s = *sptr; /* Local value */
3089uschar *sub1, *sub2;
3090
3091/* If there are no following strings, we substitute the contents of $value for
063b1e99 3092lookups and for extractions in the success case. For the ${if item, the string
8e669ac1 3093"true" is substituted. In the fail case, nothing is substituted for all three
063b1e99 3094items. */
059ec3d9
PH
3095
3096while (isspace(*s)) s++;
3097if (*s == '}')
3098 {
063b1e99
PH
3099 if (type[0] == 'i')
3100 {
8e669ac1 3101 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
063b1e99
PH
3102 }
3103 else
8e669ac1 3104 {
063b1e99
PH
3105 if (yes && lookup_value != NULL)
3106 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3107 Ustrlen(lookup_value));
3108 lookup_value = save_lookup;
3109 }
059ec3d9
PH
3110 s++;
3111 goto RETURN;
3112 }
3113
9b4768fa
PH
3114/* The first following string must be braced. */
3115
3116if (*s++ != '{') goto FAILED_CURLY;
3117
059ec3d9
PH
3118/* Expand the first substring. Forced failures are noticed only if we actually
3119want this string. Set skipping in the call in the fail case (this will always
3120be the case if we were already skipping). */
3121
b0e85a8f 3122sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
059ec3d9
PH
3123if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3124expand_string_forcedfail = FALSE;
3125if (*s++ != '}') goto FAILED_CURLY;
3126
3127/* If we want the first string, add it to the output */
3128
3129if (yes)
3130 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3131
3132/* If this is called from a lookup or an extract, we want to restore $value to
3133what it was at the start of the item, so that it has this value during the
d20976dc
PH
3134second string expansion. For the call from "if" or "run" to this function,
3135save_lookup is set to lookup_value, so that this statement does nothing. */
059ec3d9
PH
3136
3137lookup_value = save_lookup;
3138
3139/* There now follows either another substring, or "fail", or nothing. This
3140time, forced failures are noticed only if we want the second string. We must
3141set skipping in the nested call if we don't want this string, or if we were
3142already skipping. */
3143
3144while (isspace(*s)) s++;
3145if (*s == '{')
3146 {
b0e85a8f 3147 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
059ec3d9
PH
3148 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3149 expand_string_forcedfail = FALSE;
3150 if (*s++ != '}') goto FAILED_CURLY;
3151
3152 /* If we want the second string, add it to the output */
3153
3154 if (!yes)
3155 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3156 }
3157
3158/* If there is no second string, but the word "fail" is present when the use of
3159the second string is wanted, set a flag indicating it was a forced failure
3160rather than a syntactic error. Swallow the terminating } in case this is nested
3161inside another lookup or if or extract. */
3162
3163else if (*s != '}')
3164 {
3165 uschar name[256];
3166 s = read_name(name, sizeof(name), s, US"_");
3167 if (Ustrcmp(name, "fail") == 0)
3168 {
3169 if (!yes && !skipping)
3170 {
3171 while (isspace(*s)) s++;
3172 if (*s++ != '}') goto FAILED_CURLY;
3173 expand_string_message =
3174 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3175 expand_string_forcedfail = TRUE;
3176 goto FAILED;
3177 }
3178 }
3179 else
3180 {
3181 expand_string_message =
3182 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3183 goto FAILED;
3184 }
3185 }
3186
3187/* All we have to do now is to check on the final closing brace. */
3188
3189while (isspace(*s)) s++;
3190if (*s++ == '}') goto RETURN;
3191
3192/* Get here if there is a bracketing failure */
3193
3194FAILED_CURLY:
3195rc++;
3196
3197/* Get here for other failures */
3198
3199FAILED:
3200rc++;
3201
3202/* Update the input pointer value before returning */
3203
3204RETURN:
3205*sptr = s;
3206return rc;
3207}
3208
3209
3210
3211
059ec3d9
PH
3212/*************************************************
3213* Handle MD5 or SHA-1 computation for HMAC *
3214*************************************************/
3215
3216/* These are some wrapping functions that enable the HMAC code to be a bit
3217cleaner. A good compiler will spot the tail recursion.
3218
3219Arguments:
3220 type HMAC_MD5 or HMAC_SHA1
3221 remaining are as for the cryptographic hash functions
3222
3223Returns: nothing
3224*/
3225
3226static void
3227chash_start(int type, void *base)
3228{
3229if (type == HMAC_MD5)
3230 md5_start((md5 *)base);
3231else
3232 sha1_start((sha1 *)base);
3233}
3234
3235static void
3236chash_mid(int type, void *base, uschar *string)
3237{
3238if (type == HMAC_MD5)
3239 md5_mid((md5 *)base, string);
3240else
3241 sha1_mid((sha1 *)base, string);
3242}
3243
3244static void
3245chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3246{
3247if (type == HMAC_MD5)
3248 md5_end((md5 *)base, string, length, digest);
3249else
3250 sha1_end((sha1 *)base, string, length, digest);
3251}
3252
3253
3254
3255
3256
1549ea3b
PH
3257/********************************************************
3258* prvs: Get last three digits of days since Jan 1, 1970 *
3259********************************************************/
3260
3261/* This is needed to implement the "prvs" BATV reverse
3262 path signing scheme
3263
3264Argument: integer "days" offset to add or substract to
3265 or from the current number of days.
3266
3267Returns: pointer to string containing the last three
3268 digits of the number of days since Jan 1, 1970,
3269 modified by the offset argument, NULL if there
3270 was an error in the conversion.
3271
3272*/
3273
3274static uschar *
3275prvs_daystamp(int day_offset)
3276{
a86229cf
PH
3277uschar *days = store_get(32); /* Need at least 24 for cases */
3278(void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
1549ea3b 3279 (time(NULL) + day_offset*86400)/86400);
e169f567 3280return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
1549ea3b
PH
3281}
3282
3283
3284
3285/********************************************************
3286* prvs: perform HMAC-SHA1 computation of prvs bits *
3287********************************************************/
3288
3289/* This is needed to implement the "prvs" BATV reverse
3290 path signing scheme
3291
3292Arguments:
3293 address RFC2821 Address to use
3294 key The key to use (must be less than 64 characters
3295 in size)
3296 key_num Single-digit key number to use. Defaults to
3297 '0' when NULL.
3298
3299Returns: pointer to string containing the first three
3300 bytes of the final hash in hex format, NULL if
3301 there was an error in the process.
3302*/
3303
3304static uschar *
3305prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3306{
3307uschar *hash_source, *p;
3308int size = 0,offset = 0,i;
3309sha1 sha1_base;
3310void *use_base = &sha1_base;
3311uschar innerhash[20];
3312uschar finalhash[20];
3313uschar innerkey[64];
3314uschar outerkey[64];
3315uschar *finalhash_hex = store_get(40);
3316
3317if (key_num == NULL)
3318 key_num = US"0";
3319
3320if (Ustrlen(key) > 64)
3321 return NULL;
3322
3323hash_source = string_cat(NULL,&size,&offset,key_num,1);
3324string_cat(hash_source,&size,&offset,daystamp,3);
3325string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3326hash_source[offset] = '\0';
3327
3328DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3329
3330memset(innerkey, 0x36, 64);
3331memset(outerkey, 0x5c, 64);
3332
3333for (i = 0; i < Ustrlen(key); i++)
3334 {
3335 innerkey[i] ^= key[i];
3336 outerkey[i] ^= key[i];
3337 }
3338
3339chash_start(HMAC_SHA1, use_base);
3340chash_mid(HMAC_SHA1, use_base, innerkey);
3341chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3342
3343chash_start(HMAC_SHA1, use_base);
3344chash_mid(HMAC_SHA1, use_base, outerkey);
3345chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3346
3347p = finalhash_hex;
3348for (i = 0; i < 3; i++)
3349 {
3350 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3351 *p++ = hex_digits[finalhash[i] & 0x0f];
3352 }
3353*p = '\0';
3354
3355return finalhash_hex;
3356}
3357
3358
3359
3360
059ec3d9
PH
3361/*************************************************
3362* Join a file onto the output string *
3363*************************************************/
3364
3365/* This is used for readfile and after a run expansion. It joins the contents
3366of a file onto the output string, globally replacing newlines with a given
3367string (optionally). The file is closed at the end.
3368
3369Arguments:
3370 f the FILE
3371 yield pointer to the expandable string
3372 sizep pointer to the current size
3373 ptrp pointer to the current position
3374 eol newline replacement string, or NULL
3375
3376Returns: new value of string pointer
3377*/
3378
3379static uschar *
3380cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3381{
3382int eollen;
3383uschar buffer[1024];
3384
3385eollen = (eol == NULL)? 0 : Ustrlen(eol);
3386
3387while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3388 {
3389 int len = Ustrlen(buffer);
3390 if (eol != NULL && buffer[len-1] == '\n') len--;
3391 yield = string_cat(yield, sizep, ptrp, buffer, len);
3392 if (buffer[len] != 0)
3393 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3394 }
3395
3396if (yield != NULL) yield[*ptrp] = 0;
3397
3398return yield;
3399}
3400
3401
3402
3403
3404/*************************************************
3405* Evaluate numeric expression *
3406*************************************************/
3407
af561417
PH
3408/* This is a set of mutually recursive functions that evaluate an arithmetic
3409expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3410these functions that is called from elsewhere is eval_expr, whose interface is:
059ec3d9
PH
3411
3412Arguments:
af561417
PH
3413 sptr pointer to the pointer to the string - gets updated
3414 decimal TRUE if numbers are to be assumed decimal
3415 error pointer to where to put an error message - must be NULL on input
3416 endket TRUE if ')' must terminate - FALSE for external call
059ec3d9 3417
af561417
PH
3418Returns: on success: the value of the expression, with *error still NULL
3419 on failure: an undefined value, with *error = a message
059ec3d9
PH
3420*/
3421
97d17305 3422static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
af561417 3423
059ec3d9 3424
97d17305 3425static int_eximarith_t
059ec3d9
PH
3426eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3427{
3428uschar *s = *sptr;
97d17305 3429int_eximarith_t x = eval_op_or(&s, decimal, error);
059ec3d9
PH
3430if (*error == NULL)
3431 {
af561417 3432 if (endket)
059ec3d9 3433 {
af561417
PH
3434 if (*s != ')')
3435 *error = US"expecting closing parenthesis";
3436 else
3437 while (isspace(*(++s)));
059ec3d9 3438 }
af561417 3439 else if (*s != 0) *error = US"expecting operator";
059ec3d9 3440 }
059ec3d9
PH
3441*sptr = s;
3442return x;
3443}
3444
af561417 3445
97d17305 3446static int_eximarith_t
af561417 3447eval_number(uschar **sptr, BOOL decimal, uschar **error)
059ec3d9
PH
3448{
3449register int c;
97d17305 3450int_eximarith_t n;
059ec3d9
PH
3451uschar *s = *sptr;
3452while (isspace(*s)) s++;
3453c = *s;
af561417 3454if (isdigit(c))
059ec3d9
PH
3455 {
3456 int count;
97d17305 3457 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
059ec3d9 3458 s += count;
97d17305
JH
3459 switch (tolower(*s))
3460 {
3461 default: break;
3462 case 'k': n *= 1024; s++; break;
3463 case 'm': n *= 1024*1024; s++; break;
3464 case 'g': n *= 1024*1024*1024; s++; break;
3465 }
059ec3d9
PH
3466 while (isspace (*s)) s++;
3467 }
3468else if (c == '(')
3469 {
3470 s++;
3471 n = eval_expr(&s, decimal, error, 1);
3472 }
3473else
3474 {
3475 *error = US"expecting number or opening parenthesis";
3476 n = 0;
3477 }
3478*sptr = s;
3479return n;
3480}
3481
af561417 3482
97d17305 3483static int_eximarith_t
aa7c82b2 3484eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
3485{
3486uschar *s = *sptr;
97d17305 3487int_eximarith_t x;
af561417
PH
3488while (isspace(*s)) s++;
3489if (*s == '+' || *s == '-' || *s == '~')
3490 {
3491 int op = *s++;
3492 x = eval_op_unary(&s, decimal, error);
3493 if (op == '-') x = -x;
3494 else if (op == '~') x = ~x;
3495 }
3496else
3497 {
3498 x = eval_number(&s, decimal, error);
3499 }
3500*sptr = s;
3501return x;
3502}
3503
3504
97d17305 3505static int_eximarith_t
aa7c82b2 3506eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
059ec3d9
PH
3507{
3508uschar *s = *sptr;
97d17305 3509int_eximarith_t x = eval_op_unary(&s, decimal, error);
059ec3d9
PH
3510if (*error == NULL)
3511 {
5591031b 3512 while (*s == '*' || *s == '/' || *s == '%')
059ec3d9
PH
3513 {
3514 int op = *s++;
97d17305 3515 int_eximarith_t y = eval_op_unary(&s, decimal, error);
059ec3d9 3516 if (*error != NULL) break;
053a9aa3
PP
3517 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3518 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3519 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3520 * -N*M is INT_MIN will yielf INT_MIN.
3521 * Since we don't support floating point, this is somewhat simpler.
3522 * Ideally, we'd return an error, but since we overflow for all other
3523 * arithmetic, consistency suggests otherwise, but what's the correct value
3524 * to use? There is none.
3525 * The C standard guarantees overflow for unsigned arithmetic but signed
3526 * overflow invokes undefined behaviour; in practice, this is overflow
3527 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3528 * that long/longlong larger than int are available, or we could just work
3529 * with larger types. We should consider whether to guarantee 32bit eval
3530 * and 64-bit working variables, with errors returned. For now ...
3531 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3532 * can just let the other invalid results occur otherwise, as they have
3533 * until now. For this one case, we can coerce.
3534 */
4328fd3c 3535 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
053a9aa3
PP
3536 {
3537 DEBUG(D_expand)
97d17305 3538 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4328fd3c
JH
3539 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3540 x = EXIM_ARITH_MAX;
053a9aa3
PP
3541 continue;
3542 }
a5b52695
PP
3543 if (op == '*')
3544 x *= y;
3545 else
3546 {
3547 if (y == 0)
54e7ce4a 3548 {
a5b52695
PP
3549 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3550 x = 0;
3551 break;
54e7ce4a 3552 }
a5b52695
PP
3553 if (op == '/')
3554 x /= y;
3555 else
3556 x %= y;
3557 }
059ec3d9
PH
3558 }
3559 }
3560*sptr = s;
3561return x;
3562}
3563
3564
97d17305 3565static int_eximarith_t
aa7c82b2 3566eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
3567{
3568uschar *s = *sptr;
97d17305 3569int_eximarith_t x = eval_op_mult(&s, decimal, error);
af561417
PH
3570if (*error == NULL)
3571 {
3572 while (*s == '+' || *s == '-')
3573 {
3574 int op = *s++;
97d17305 3575 int_eximarith_t y = eval_op_mult(&s, decimal, error);
af561417
PH
3576 if (*error != NULL) break;
3577 if (op == '+') x += y; else x -= y;
3578 }
3579 }
3580*sptr = s;
3581return x;
3582}
3583
3584
97d17305 3585static int_eximarith_t
aa7c82b2 3586eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
3587{
3588uschar *s = *sptr;
97d17305 3589int_eximarith_t x = eval_op_sum(&s, decimal, error);
af561417
PH
3590if (*error == NULL)
3591 {
3592 while ((*s == '<' || *s == '>') && s[1] == s[0])
3593 {
97d17305 3594 int_eximarith_t y;
af561417
PH
3595 int op = *s++;
3596 s++;
3597 y = eval_op_sum(&s, decimal, error);
3598 if (*error != NULL) break;
3599 if (op == '<') x <<= y; else x >>= y;
3600 }
3601 }
3602*sptr = s;
3603return x;
3604}
3605
3606
97d17305 3607static int_eximarith_t
aa7c82b2 3608eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
3609{
3610uschar *s = *sptr;
97d17305 3611int_eximarith_t x = eval_op_shift(&s, decimal, error);
af561417
PH
3612if (*error == NULL)
3613 {
3614 while (*s == '&')
3615 {
97d17305 3616 int_eximarith_t y;
af561417
PH
3617 s++;
3618 y = eval_op_shift(&s, decimal, error);
3619 if (*error != NULL) break;
3620 x &= y;
3621 }
3622 }
3623*sptr = s;
3624return x;
3625}
3626
3627
97d17305 3628static int_eximarith_t
aa7c82b2 3629eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
3630{
3631uschar *s = *sptr;
97d17305 3632int_eximarith_t x = eval_op_and(&s, decimal, error);
af561417
PH
3633if (*error == NULL)
3634 {
3635 while (*s == '^')
3636 {
97d17305 3637 int_eximarith_t y;
af561417
PH
3638 s++;
3639 y = eval_op_and(&s, decimal, error);
3640 if (*error != NULL) break;
3641 x ^= y;
3642 }
3643 }
3644*sptr = s;
3645return x;
3646}
3647
3648
97d17305 3649static int_eximarith_t
aa7c82b2 3650eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
af561417
PH
3651{
3652uschar *s = *sptr;
97d17305 3653int_eximarith_t x = eval_op_xor(&s, decimal, error);
af561417
PH
3654if (*error == NULL)
3655 {
3656 while (*s == '|')
3657 {
97d17305 3658 int_eximarith_t y;
af561417
PH
3659 s++;
3660 y = eval_op_xor(&s, decimal, error);
3661 if (*error != NULL) break;
3662 x |= y;
3663 }
3664 }
3665*sptr = s;
3666return x;
3667}
3668
059ec3d9
PH
3669
3670
3671/*************************************************
3672* Expand string *
3673*************************************************/
3674
3675/* Returns either an unchanged string, or the expanded string in stacking pool
3676store. Interpreted sequences are:
3677
3678 \... normal escaping rules
3679 $name substitutes the variable
3680 ${name} ditto
3681 ${op:string} operates on the expanded string value
3682 ${item{arg1}{arg2}...} expands the args and then does the business
3683 some literal args are not enclosed in {}
3684
3685There are now far too many operators and item types to make it worth listing
3686them here in detail any more.
3687
3688We use an internal routine recursively to handle embedded substrings. The
3689external function follows. The yield is NULL if the expansion failed, and there
3690are two cases: if something collapsed syntactically, or if "fail" was given
3691as the action on a lookup failure. These can be distinguised by looking at the
3692variable expand_string_forcedfail, which is TRUE in the latter case.
3693
3694The skipping flag is set true when expanding a substring that isn't actually
3695going to be used (after "if" or "lookup") and it prevents lookups from
3696happening lower down.
3697
3698Store usage: At start, a store block of the length of the input plus 64
3699is obtained. This is expanded as necessary by string_cat(), which might have to
3700get a new block, or might be able to expand the original. At the end of the
3701function we can release any store above that portion of the yield block that
3702was actually used. In many cases this will be optimal.
3703
3704However: if the first item in the expansion is a variable name or header name,
3705we reset the store before processing it; if the result is in fresh store, we
3706use that without copying. This is helpful for expanding strings like
3707$message_headers which can get very long.
3708
d6b4d938
TF
3709There's a problem if a ${dlfunc item has side-effects that cause allocation,
3710since resetting the store at the end of the expansion will free store that was
3711allocated by the plugin code as well as the slop after the expanded string. So
b0e85a8f
JH
3712we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3713and, given the acl condition, ${if }. This is an unfortunate consequence of
3714string expansion becoming too powerful.
d6b4d938 3715
059ec3d9
PH
3716Arguments:
3717 string the string to be expanded
3718 ket_ends true if expansion is to stop at }
3719 left if not NULL, a pointer to the first character after the
3720 expansion is placed here (typically used with ket_ends)
3721 skipping TRUE for recursive calls when the value isn't actually going
3722 to be used (to allow for optimisation)
da6dbe26
PP
3723 honour_dollar TRUE if $ is to be expanded,
3724 FALSE if it's just another character
b0e85a8f
JH
3725 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3726 the store.
059ec3d9
PH
3727
3728Returns: NULL if expansion fails:
3729 expand_string_forcedfail is set TRUE if failure was forced
3730 expand_string_message contains a textual error message
3731 a pointer to the expanded string on success
3732*/
3733
3734static uschar *
3735expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
b0e85a8f 3736 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
059ec3d9
PH
3737{
3738int ptr = 0;
3739int size = Ustrlen(string)+ 64;
3740int item_type;
3741uschar *yield = store_get(size);
3742uschar *s = string;
3743uschar *save_expand_nstring[EXPAND_MAXN+1];
3744int save_expand_nlength[EXPAND_MAXN+1];
d6b4d938 3745BOOL resetok = TRUE;
059ec3d9
PH
3746
3747expand_string_forcedfail = FALSE;
3748expand_string_message = US"";
3749
3750while (*s != 0)
3751 {
3752 uschar *value;
3753 uschar name[256];
3754
3755 /* \ escapes the next character, which must exist, or else
3756 the expansion fails. There's a special escape, \N, which causes
3757 copying of the subject verbatim up to the next \N. Otherwise,
3758 the escapes are the standard set. */
3759
3760 if (*s == '\\')
3761 {
3762 if (s[1] == 0)
3763 {
3764 expand_string_message = US"\\ at end of string";
3765 goto EXPAND_FAILED;
3766 }
3767
3768 if (s[1] == 'N')
3769 {
3770 uschar *t = s + 2;
3771 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3772 yield = string_cat(yield, &size, &ptr, t, s - t);
3773 if (*s != 0) s += 2;
3774 }
3775
3776 else
3777 {
3778 uschar ch[1];
3779 ch[0] = string_interpret_escape(&s);
3780 s++;
3781 yield = string_cat(yield, &size, &ptr, ch, 1);
3782 }
3783
3784 continue;
3785 }
3786
2e23003a 3787 /*{*/
059ec3d9
PH
3788 /* Anything other than $ is just copied verbatim, unless we are
3789 looking for a terminating } character. */
3790
2e23003a 3791 /*{*/
059ec3d9
PH
3792 if (ket_ends && *s == '}') break;
3793
da6dbe26 3794 if (*s != '$' || !honour_dollar)
059ec3d9
PH
3795 {
3796 yield = string_cat(yield, &size, &ptr, s++, 1);
3797 continue;
3798 }
3799
3800 /* No { after the $ - must be a plain name or a number for string
3801 match variable. There has to be a fudge for variables that are the
3802 names of header fields preceded by "$header_" because header field
3803 names can contain any printing characters except space and colon.
3804 For those that don't like typing this much, "$h_" is a synonym for
3805 "$header_". A non-existent header yields a NULL value; nothing is
2e23003a 3806 inserted. */ /*}*/
059ec3d9
PH
3807
3808 if (isalpha((*(++s))))
3809 {
3810 int len;
3811 int newsize = 0;
3812
3813 s = read_name(name, sizeof(name), s, US"_");
3814
3815 /* If this is the first thing to be expanded, release the pre-allocated
3816 buffer. */
3817
3818 if (ptr == 0 && yield != NULL)
3819 {
d6b4d938 3820 if (resetok) store_reset(yield);
059ec3d9
PH
3821 yield = NULL;
3822 size = 0;
3823 }
3824
3825 /* Header */
3826
3827 if (Ustrncmp(name, "h_", 2) == 0 ||
3828 Ustrncmp(name, "rh_", 3) == 0 ||
3829 Ustrncmp(name, "bh_", 3) == 0 ||
3830 Ustrncmp(name, "header_", 7) == 0 ||
3831 Ustrncmp(name, "rheader_", 8) == 0 ||
3832 Ustrncmp(name, "bheader_", 8) == 0)
3833 {
3834 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3835 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3836 s = read_header_name(name, sizeof(name), s);
3837 value = find_header(name, FALSE, &newsize, want_raw, charset);
3838
3839 /* If we didn't find the header, and the header contains a closing brace
0d85fa3f 3840 character, this may be a user error where the terminating colon
059ec3d9
PH
3841 has been omitted. Set a flag to adjust the error message in this case.
3842 But there is no error here - nothing gets inserted. */
3843
3844 if (value == NULL)
3845 {
3846 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3847 continue;
3848 }
3849 }
3850
3851 /* Variable */
3852
3853 else
3854 {
3855 value = find_variable(name, FALSE, skipping, &newsize);
3856 if (value == NULL)
3857 {
3858 expand_string_message =
3859 string_sprintf("unknown variable name \"%s\"", name);
641cb756 3860 check_variable_error_message(name);
059ec3d9
PH
3861 goto EXPAND_FAILED;
3862 }
3863 }
3864
3865 /* If the data is known to be in a new buffer, newsize will be set to the
3866 size of that buffer. If this is the first thing in an expansion string,
3867 yield will be NULL; just point it at the new store instead of copying. Many
3868 expansion strings contain just one reference, so this is a useful
3869 optimization, especially for humungous headers. */
3870
3871 len = Ustrlen(value);
3872 if (yield == NULL && newsize != 0)
3873 {
3874 yield = value;
3875 size = newsize;
3876 ptr = len;
3877 }
3878 else yield = string_cat(yield, &size, &ptr, value, len);
3879
3880 continue;
3881 }
3882
3883 if (isdigit(*s))
3884 {
3885 int n;
3886 s = read_number(&n, s);
3887 if (n >= 0 && n <= expand_nmax)
3888 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3889 expand_nlength[n]);
3890 continue;
3891 }
3892
2e23003a 3893 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
059ec3d9 3894
2e23003a 3895 if (*s != '{') /*}*/
059ec3d9 3896 {
2e23003a 3897 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
059ec3d9
PH
3898 goto EXPAND_FAILED;
3899 }
3900
3901 /* After { there can be various things, but they all start with
3902 an initial word, except for a number for a string match variable. */
3903
3904 if (isdigit((*(++s))))
3905 {
3906 int n;
2e23003a 3907 s = read_number(&n, s); /*{*/
059ec3d9 3908 if (*s++ != '}')
2e23003a 3909 { /*{*/
059ec3d9
PH
3910 expand_string_message = US"} expected after number";
3911 goto EXPAND_FAILED;
3912 }
3913 if (n >= 0 && n <= expand_nmax)
3914 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3915 expand_nlength[n]);
3916 continue;
3917 }
3918
3919 if (!isalpha(*s))
3920 {
2e23003a 3921 expand_string_message = US"letter or digit expected after ${"; /*}*/
059ec3d9
PH
3922 goto EXPAND_FAILED;
3923 }
3924
3925 /* Allow "-" in names to cater for substrings with negative
3926 arguments. Since we are checking for known names after { this is
3927 OK. */
3928
3929 s = read_name(name, sizeof(name), s, US"_-");
3930 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3931
3932 switch(item_type)
3933 {
525239c1 3934 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
333eea9c 3935 If the ACL returns accept or reject we return content set by "message ="
723c72e6
JH
3936 There is currently no limit on recursion; this would have us call
3937 acl_check_internal() directly and get a current level from somewhere.
f60d98e8
JH
3938 See also the acl expansion condition ECOND_ACL and the traditional
3939 acl modifier ACLC_ACL.
be7a5781 3940 Assume that the function has side-effects on the store that must be preserved.
723c72e6
JH
3941 */
3942
3943 case EITEM_ACL:
333eea9c 3944 /* ${acl {name} {arg1}{arg2}...} */
723c72e6 3945 {
333eea9c 3946 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
723c72e6 3947 uschar *user_msg;
333eea9c 3948
b0e85a8f 3949 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl", &resetok))
723c72e6
JH
3950 {
3951 case 1: goto EXPAND_FAILED_CURLY;
3952 case 2:
3953 case 3: goto EXPAND_FAILED;
3954 }
3955 if (skipping) continue;
3956
be7a5781 3957 resetok = FALSE;
f60d98e8 3958 switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
723c72e6
JH
3959 {
3960 case OK:
333eea9c 3961 case FAIL:
187bc588
JH
3962 DEBUG(D_expand)
3963 debug_printf("acl expansion yield: %s\n", user_msg);
723c72e6
JH
3964 if (user_msg)
3965 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3966 continue;
333eea9c 3967
723c72e6 3968 case DEFER:
333eea9c 3969 expand_string_forcedfail = TRUE;
723c72e6 3970 default:
333eea9c 3971 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
723c72e6
JH
3972 goto EXPAND_FAILED;
3973 }
3974 }
3975
059ec3d9
PH
3976 /* Handle conditionals - preserve the values of the numerical expansion
3977 variables in case they get changed by a regular expression match in the
3978 condition. If not, they retain their external settings. At the end
3979 of this "if" section, they get restored to their previous values. */
3980
3981 case EITEM_IF:
3982 {
3983 BOOL cond = FALSE;
3984 uschar *next_s;
3985 int save_expand_nmax =
3986 save_expand_strings(save_expand_nstring, save_expand_nlength);
3987
3988 while (isspace(*s)) s++;
b0e85a8f 3989 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
059ec3d9
PH
3990 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3991
3992 DEBUG(D_expand)
3993 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3994 cond? "true" : "false");
3995
3996 s = next_s;
3997
3998 /* The handling of "yes" and "no" result strings is now in a separate
3999 function that is also used by ${lookup} and ${extract} and ${run}. */
4000
4001 switch(process_yesno(
4002 skipping, /* were previously skipping */
4003 cond, /* success/failure indicator */
4004 lookup_value, /* value to reset for string2 */
4005 &s, /* input pointer */
4006 &yield, /* output pointer */
4007 &size, /* output size */
4008 &ptr, /* output current point */
b0e85a8f
JH
4009 US"if", /* condition type */
4010 &resetok))
059ec3d9
PH
4011 {
4012 case 1: goto EXPAND_FAILED; /* when all is well, the */
4013 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4014 }
4015
4016 /* Restore external setting of expansion variables for continuation
4017 at this level. */
4018
b0e85a8f
JH
4019 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4020 save_expand_nlength);
059ec3d9
PH
4021 continue;
4022 }
4023
4024 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4025 expanding an internal string that isn't actually going to be used. All we
4026 need to do is check the syntax, so don't do a lookup at all. Preserve the
4027 values of the numerical expansion variables in case they get changed by a
4028 partial lookup. If not, they retain their external settings. At the end
4029 of this "lookup" section, they get restored to their previous values. */
4030
4031 case EITEM_LOOKUP:
4032 {
4033 int stype, partial, affixlen, starflags;
4034 int expand_setup = 0;
4035 int nameptr = 0;
4036 uschar *key, *filename, *affix;
4037 uschar *save_lookup_value = lookup_value;
4038 int save_expand_nmax =
4039 save_expand_strings(save_expand_nstring, save_expand_nlength);
4040
4041 if ((expand_forbid & RDO_LOOKUP) != 0)
4042 {
4043 expand_string_message = US"lookup expansions are not permitted";
4044 goto EXPAND_FAILED;
4045 }
4046
4047 /* Get the key we are to look up for single-key+file style lookups.
4048 Otherwise set the key NULL pro-tem. */
4049
4050 while (isspace(*s)) s++;
2e23003a 4051 if (*s == '{') /*}*/
059ec3d9 4052 {
b0e85a8f 4053 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
2e23003a 4054 if (key == NULL) goto EXPAND_FAILED; /*{*/
059ec3d9
PH
4055 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4056 while (isspace(*s)) s++;
4057 }
4058 else key = NULL;
4059
4060 /* Find out the type of database */
4061
4062 if (!isalpha(*s))
4063 {
4064 expand_string_message = US"missing lookup type";
4065 goto EXPAND_FAILED;
4066 }
4067
4068 /* The type is a string that may contain special characters of various
4069 kinds. Allow everything except space or { to appear; the actual content
2e23003a 4070 is checked by search_findtype_partial. */ /*}*/
059ec3d9 4071
2e23003a 4072 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
059ec3d9
PH
4073 {
4074 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4075 s++;
4076 }
4077 name[nameptr] = 0;
4078 while (isspace(*s)) s++;
4079
4080 /* Now check for the individual search type and any partial or default
4081 options. Only those types that are actually in the binary are valid. */
4082
4083 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4084 &starflags);
4085 if (stype < 0)
4086 {
4087 expand_string_message = search_error_message;
4088 goto EXPAND_FAILED;
4089 }
4090
4091 /* Check that a key was provided for those lookup types that need it,
4092 and was not supplied for those that use the query style. */
4093
13b685f9 4094 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
059ec3d9
PH
4095 {
4096 if (key == NULL)
4097 {
4098 expand_string_message = string_sprintf("missing {key} for single-"
4099 "key \"%s\" lookup", name);
4100 goto EXPAND_FAILED;
4101 }
4102 }
4103 else
4104 {
4105 if (key != NULL)
4106 {
4107 expand_string_message = string_sprintf("a single key was given for "
4108 "lookup type \"%s\", which is not a single-key lookup type", name);
4109 goto EXPAND_FAILED;
4110 }
4111 }
4112
4113 /* Get the next string in brackets and expand it. It is the file name for
13b685f9
PH
4114 single-key+file lookups, and the whole query otherwise. In the case of
4115 queries that also require a file name (e.g. sqlite), the file name comes
4116 first. */
059ec3d9
PH
4117
4118 if (*s != '{') goto EXPAND_FAILED_CURLY;
b0e85a8f 4119 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
059ec3d9
PH
4120 if (filename == NULL) goto EXPAND_FAILED;
4121 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4122 while (isspace(*s)) s++;
4123
4124 /* If this isn't a single-key+file lookup, re-arrange the variables
13b685f9
PH
4125 to be appropriate for the search_ functions. For query-style lookups,
4126 there is just a "key", and no file name. For the special query-style +
4127 file types, the query (i.e. "key") starts with a file name. */
059ec3d9
PH
4128
4129 if (key == NULL)
4130 {
13b685f9 4131 while (isspace(*filename)) filename++;
059ec3d9 4132 key = filename;
13b685f9
PH
4133
4134 if (mac_islookup(stype, lookup_querystyle))
4135 {
4136 filename = NULL;
4137 }
4138 else
4139 {
4140 if (*filename != '/')
4141 {
4142 expand_string_message = string_sprintf(
4143 "absolute file name expected for \"%s\" lookup", name);
4144 goto EXPAND_FAILED;
4145 }
4146 while (*key != 0 && !isspace(*key)) key++;
4147 if (*key != 0) *key++ = 0;
4148 }
059ec3d9
PH
4149 }
4150
4151 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4152 the entry was not found. Note that there is no search_close() function.
4153 Files are left open in case of re-use. At suitable places in higher logic,
4154 search_tidyup() is called to tidy all open files. This can save opening
4155 the same file several times. However, files may also get closed when
4156 others are opened, if too many are open at once. The rule is that a
4157 handle should not be used after a second search_open().
4158
4159 Request that a partial search sets up $1 and maybe $2 by passing
4160 expand_setup containing zero. If its value changes, reset expand_nmax,
4161 since new variables will have been set. Note that at the end of this
4162 "lookup" section, the old numeric variables are restored. */
4163
4164 if (skipping)
4165 lookup_value = NULL;
4166 else
4167 {
4168 void *handle = search_open(filename, stype, 0, NULL, NULL);
4169 if (handle == NULL)
4170 {
4171 expand_string_message = search_error_message;
4172 goto EXPAND_FAILED;
4173 }
4174 lookup_value = search_find(handle, filename, key, partial, affix,
4175 affixlen, starflags, &expand_setup);
4176 if (search_find_defer)
4177 {
4178 expand_string_message =
b72aab72
PP
4179 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4180 string_printing2(key, FALSE), search_error_message);
059ec3d9
PH
4181 goto EXPAND_FAILED;
4182 }
4183 if (expand_setup > 0) expand_nmax = expand_setup;
4184 }
4185
4186 /* The handling of "yes" and "no" result strings is now in a separate
4187 function that is also used by ${if} and ${extract}. */
4188
4189 switch(process_yesno(
4190 skipping, /* were previously skipping */
4191 lookup_value != NULL, /* success/failure indicator */
4192 save_lookup_value, /* value to reset for string2 */
4193 &s, /* input pointer */
4194 &yield, /* output pointer */
4195 &size, /* output size */
4196 &ptr, /* output current point */
b0e85a8f
JH
4197 US"lookup", /* condition type */
4198 &resetok))
059ec3d9
PH
4199 {
4200 case 1: goto EXPAND_FAILED; /* when all is well, the */
4201 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4202 }
4203
4204 /* Restore external setting of expansion variables for carrying on
4205 at this level, and continue. */
4206
4207 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4208 save_expand_nlength);
4209 continue;
4210 }
4211
4212 /* If Perl support is configured, handle calling embedded perl subroutines,
4213 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4214 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4215 arguments (defined below). */
4216
059ec3d9
PH
4217 #define EXIM_PERL_MAX_ARGS 8
4218
4219 case EITEM_PERL:
1a46a8c5 4220 #ifndef EXIM_PERL
2e23003a 4221 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
1a46a8c5
PH
4222 "is not included in this binary";
4223 goto EXPAND_FAILED;
4224
4225 #else /* EXIM_PERL */
059ec3d9
PH
4226 {
4227 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4228 uschar *new_yield;
4229
4230 if ((expand_forbid & RDO_PERL) != 0)
4231 {
4232 expand_string_message = US"Perl calls are not permitted";
4233 goto EXPAND_FAILED;
4234 }
4235
4236 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
b0e85a8f 4237 US"perl", &resetok))
059ec3d9
PH
4238 {
4239 case 1: goto EXPAND_FAILED_CURLY;
4240 case 2:
4241 case 3: goto EXPAND_FAILED;
4242 }
4243
4244 /* If skipping, we don't actually do anything */
4245
4246 if (skipping) continue;
4247
4248 /* Start the interpreter if necessary */
4249
4250 if (!opt_perl_started)
4251 {
4252 uschar *initerror;
4253 if (opt_perl_startup == NULL)
4254 {
4255 expand_string_message = US"A setting of perl_startup is needed when "
4256 "using the Perl interpreter";
4257 goto EXPAND_FAILED;
4258 }
4259 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4260 initerror = init_perl(opt_perl_startup);
4261 if (initerror != NULL)
4262 {
4263 expand_string_message =
4264 string_sprintf("error in perl_startup code: %s\n", initerror);
4265 goto EXPAND_FAILED;
4266 }
4267 opt_perl_started = TRUE;
4268 }
4269
4270 /* Call the function */
4271
4272 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4273 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4274 sub_arg[0], sub_arg + 1);
4275
4276 /* NULL yield indicates failure; if the message pointer has been set to
4277 NULL, the yield was undef, indicating a forced failure. Otherwise the
4278 message will indicate some kind of Perl error. */
4279
4280 if (new_yield == NULL)
4281 {
4282 if (expand_string_message == NULL)
4283 {
4284 expand_string_message =
4285 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4286 "failure", sub_arg[0]);
4287 expand_string_forcedfail = TRUE;
4288 }
4289 goto EXPAND_FAILED;
4290 }
4291
4292 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4293 set during a callback from Perl. */
4294
4295 expand_string_forcedfail = FALSE;
4296 yield = new_yield;
4297 continue;
4298 }
4299 #endif /* EXIM_PERL */
4300
fffda43a
TK
4301 /* Transform email address to "prvs" scheme to use
4302 as BATV-signed return path */
4303
4304 case EITEM_PRVS:
4305 {
4306 uschar *sub_arg[3];
4307 uschar *p,*domain;
4308
b0e85a8f 4309 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
fffda43a
TK
4310 {
4311 case 1: goto EXPAND_FAILED_CURLY;
4312 case 2:
4313 case 3: goto EXPAND_FAILED;
4314 }
4315
4316 /* If skipping, we don't actually do anything */
4317 if (skipping) continue;
4318
4319 /* sub_arg[0] is the address */
4320 domain = Ustrrchr(sub_arg[0],'@');
4321 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4322 {
cb9328de
PH
4323 expand_string_message = US"prvs first argument must be a qualified email address";
4324 goto EXPAND_FAILED;
4325 }
4326
4327 /* Calculate the hash. The second argument must be a single-digit
4328 key number, or unset. */
4329
4330 if (sub_arg[2] != NULL &&
4331 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4332 {
4333 expand_string_message = US"prvs second argument must be a single digit";
fffda43a
TK
4334 goto EXPAND_FAILED;
4335 }
4336
fffda43a
TK
4337 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4338 if (p == NULL)
4339 {
cb9328de 4340 expand_string_message = US"prvs hmac-sha1 conversion failed";
fffda43a
TK
4341 goto EXPAND_FAILED;
4342 }
4343
4344 /* Now separate the domain from the local part */
4345 *domain++ = '\0';
4346
4347 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
fffda43a
TK
4348 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4349 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4350 string_cat(yield,&size,&ptr,p,6);
a48ced90
TK
4351 string_cat(yield,&size,&ptr,US"=",1);
4352 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
fffda43a
TK
4353 string_cat(yield,&size,&ptr,US"@",1);
4354 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4355
4356 continue;
4357 }
4358
4359 /* Check a prvs-encoded address for validity */
4360
4361 case EITEM_PRVSCHECK:
4362 {
4363 uschar *sub_arg[3];
4364 int mysize = 0, myptr = 0;
4365 const pcre *re;
4366 uschar *p;
72fdd6ae
PH
4367
4368 /* TF: Ugliness: We want to expand parameter 1 first, then set
fffda43a
TK
4369 up expansion variables that are used in the expansion of
4370 parameter 2. So we clone the string for the first
72fdd6ae
PH
4371 expansion, where we only expand parameter 1.
4372
4373 PH: Actually, that isn't necessary. The read_subs() function is
4374 designed to work this way for the ${if and ${lookup expansions. I've
4375 tidied the code.
4376 */
fffda43a
TK
4377
4378 /* Reset expansion variables */
4379 prvscheck_result = NULL;
4380 prvscheck_address = NULL;
4381 prvscheck_keynum = NULL;
4382
b0e85a8f 4383 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
fffda43a
TK
4384 {
4385 case 1: goto EXPAND_FAILED_CURLY;
4386 case 2:
4387 case 3: goto EXPAND_FAILED;
4388 }
4389
a48ced90 4390 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
fffda43a
TK
4391 TRUE,FALSE);
4392
72fdd6ae
PH
4393 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4394 {
a48ced90
TK
4395 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4396 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4397 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4398 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
fffda43a
TK
4399 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4400
4401 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4402 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4403 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4404 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4405 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4406
4407 /* Set up expansion variables */
4408 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
2740a2ca 4409 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
fffda43a
TK
4410 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4411 prvscheck_address[myptr] = '\0';
4412 prvscheck_keynum = string_copy(key_num);
4413
72fdd6ae 4414 /* Now expand the second argument */
b0e85a8f 4415 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
fffda43a
TK
4416 {
4417 case 1: goto EXPAND_FAILED_CURLY;
4418 case 2:
4419 case 3: goto EXPAND_FAILED;
4420 }
4421
fffda43a 4422 /* Now we have the key and can check the address. */
72fdd6ae
PH
4423
4424 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4425 daystamp);
4426
fffda43a
TK
4427 if (p == NULL)
4428 {
4429 expand_string_message = US"hmac-sha1 conversion failed";
4430 goto EXPAND_FAILED;
4431 }
4432
4433 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4434 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
72fdd6ae 4435
fffda43a
TK
4436 if (Ustrcmp(p,hash) == 0)
4437 {
4438 /* Success, valid BATV address. Now check the expiry date. */
4439 uschar *now = prvs_daystamp(0);
4440 unsigned int inow = 0,iexpire = 1;
4441
ff790e47
PH
4442 (void)sscanf(CS now,"%u",&inow);
4443 (void)sscanf(CS daystamp,"%u",&iexpire);
fffda43a
TK
4444
4445 /* When "iexpire" is < 7, a "flip" has occured.
4446 Adjust "inow" accordingly. */
4447 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4448
686c36b7 4449 if (iexpire >= inow)
fffda43a
TK
4450 {
4451 prvscheck_result = US"1";
4452 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4453 }
4454 else
4455 {
4456 prvscheck_result = NULL;
4457 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4458 }
4459 }
4460 else
4461 {
4462 prvscheck_result = NULL;
4463 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4464 }
72fdd6ae
PH
4465
4466 /* Now expand the final argument. We leave this till now so that
4467 it can include $prvscheck_result. */
4468
b0e85a8f 4469 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
72fdd6ae
PH
4470 {
4471 case 1: goto EXPAND_FAILED_CURLY;
4472 case 2:
4473 case 3: goto EXPAND_FAILED;
4474 }
4475
4476 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4477 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4478 else
4479 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4480
4481 /* Reset the "internal" variables afterwards, because they are in
4482 dynamic store that will be reclaimed if the expansion succeeded. */
4483
4484 prvscheck_address = NULL;
4485 prvscheck_keynum = NULL;
4486 }
fffda43a
TK
4487 else
4488 {
4489 /* Does not look like a prvs encoded address, return the empty string.
72fdd6ae
PH
4490 We need to make sure all subs are expanded first, so as to skip over
4491 the entire item. */
4492
b0e85a8f 4493 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
fffda43a
TK
4494 {
4495 case 1: goto EXPAND_FAILED_CURLY;
4496 case 2:
4497 case 3: goto EXPAND_FAILED;
4498 }
4499 }
4500
4501 continue;
4502 }
4503
059ec3d9
PH
4504 /* Handle "readfile" to insert an entire file */
4505
4506 case EITEM_READFILE:
4507 {
4508 FILE *f;
4509 uschar *sub_arg[2];
4510
4511 if ((expand_forbid & RDO_READFILE) != 0)
4512 {
4513 expand_string_message = US"file insertions are not permitted";
4514 goto EXPAND_FAILED;
4515 }
4516
b0e85a8f 4517 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
059ec3d9
PH
4518 {
4519 case 1: goto EXPAND_FAILED_CURLY;
4520 case 2:
4521 case 3: goto EXPAND_FAILED;
4522 }
4523
4524 /* If skipping, we don't actually do anything */
4525
4526 if (skipping) continue;
4527
4528 /* Open the file and read it */
4529
4530 f = Ufopen(sub_arg[0], "rb");
4531 if (f == NULL)
4532 {
4533 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4534 goto EXPAND_FAILED;
4535 }
4536
4537 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
f1e894f3 4538 (void)fclose(f);
059ec3d9
PH
4539 continue;
4540 }
4541
4542 /* Handle "readsocket" to insert data from a Unix domain socket */
4543
4544 case EITEM_READSOCK:
4545 {
4546 int fd;
4547 int timeout = 5;
4548 int save_ptr = ptr;
4549 FILE *f;
4550 struct sockaddr_un sockun; /* don't call this "sun" ! */
4551 uschar *arg;
4552 uschar *sub_arg[4];
4553
4554 if ((expand_forbid & RDO_READSOCK) != 0)
4555 {
4556 expand_string_message = US"socket insertions are not permitted";
4557 goto EXPAND_FAILED;
4558 }
4559
4560 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4561 because there may be a string for expansion on failure. */
4562
b0e85a8f 4563 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
059ec3d9
PH
4564 {
4565 case 1: goto EXPAND_FAILED_CURLY;
4566 case 2: /* Won't occur: no end check */
4567 case 3: goto EXPAND_FAILED;
4568 }
4569
4570 /* Sort out timeout, if given */
4571
4572 if (sub_arg[2] != NULL)
4573 {
4574 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4575 if (timeout < 0)
4576 {
4577 expand_string_message = string_sprintf("bad time value %s",
4578 sub_arg[2]);
4579 goto EXPAND_FAILED;
4580 }
4581 }
4582 else sub_arg[3] = NULL; /* No eol if no timeout */
4583
1cce3af8
PH
4584 /* If skipping, we don't actually do anything. Otherwise, arrange to
4585 connect to either an IP or a Unix socket. */
059ec3d9
PH
4586
4587 if (!skipping)
4588 {
1cce3af8 4589 /* Handle an IP (internet) domain */
059ec3d9 4590
91ecef39 4591 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
059ec3d9 4592 {
b1f8e4f8 4593 int port;
1cce3af8
PH
4594 uschar *server_name = sub_arg[0] + 5;
4595 uschar *port_name = Ustrrchr(server_name, ':');
4596
4597 /* Sort out the port */
4598
4599 if (port_name == NULL)
4600 {
4601 expand_string_message =
4602 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4603 goto EXPAND_FAILED;
4604 }
4605 *port_name++ = 0; /* Terminate server name */
4606
4607 if (isdigit(*port_name))
4608 {
4609 uschar *end;
4610 port = Ustrtol(port_name, &end, 0);
4611 if (end != port_name + Ustrlen(port_name))
4612 {
4613 expand_string_message =
4614 string_sprintf("invalid port number %s", port_name);
4615 goto EXPAND_FAILED;
4616 }
4617 }
4618 else
4619 {
4620 struct servent *service_info = getservbyname(CS port_name, "tcp");
4621 if (service_info == NULL)
4622 {
4623 expand_string_message = string_sprintf("unknown port \"%s\"",
4624 port_name);
4625 goto EXPAND_FAILED;
4626 }
4627 port = ntohs(service_info->s_port);
4628 }
4629
b1f8e4f8
JH
4630 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4631 timeout, NULL, &expand_string_message)) < 0)
1cce3af8 4632 goto SOCK_FAIL;
059ec3d9
PH
4633 }
4634
1cce3af8
PH
4635 /* Handle a Unix domain socket */
4636
4637 else
059ec3d9 4638 {
a401ddaa 4639 int rc;
1cce3af8
PH
4640 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4641 {
4642 expand_string_message = string_sprintf("failed to create socket: %s",
4643 strerror(errno));
4644 goto SOCK_FAIL;
4645 }
4646
4647 sockun.sun_family = AF_UNIX;
4648 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4649 sub_arg[0]);
a401ddaa
PH
4650
4651 sigalrm_seen = FALSE;
4652 alarm(timeout);
4653 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4654 alarm(0);
734e1499 4655 if (sigalrm_seen)
1cce3af8 4656 {
734e1499 4657 expand_string_message = US "socket connect timed out";
1cce3af8
PH
4658 goto SOCK_FAIL;
4659 }
734e1499 4660 if (rc < 0)
a401ddaa 4661 {
734e1499
PH
4662 expand_string_message = string_sprintf("failed to connect to socket "
4663 "%s: %s", sub_arg[0], strerror(errno));
a401ddaa
PH
4664 goto SOCK_FAIL;
4665 }
059ec3d9 4666 }
1cce3af8 4667
059ec3d9
PH
4668 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4669
4670 /* Write the request string, if not empty */
4671
4672 if (sub_arg[1][0] != 0)
4673 {
4674 int len = Ustrlen(sub_arg[1]);
4675 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4676 sub_arg[1]);
4677 if (write(fd, sub_arg[1], len) != len)
4678 {
4679 expand_string_message = string_sprintf("request write to socket "
4680 "failed: %s", strerror(errno));
4681 goto SOCK_FAIL;
4682 }
4683 }
4684
c1114884
PH
4685 /* Shut down the sending side of the socket. This helps some servers to
4686 recognise that it is their turn to do some work. Just in case some
4687 system doesn't have this function, make it conditional. */
4688
4689 #ifdef SHUT_WR
4690 shutdown(fd, SHUT_WR);
4691 #endif
4692
059ec3d9
PH
4693 /* Now we need to read from the socket, under a timeout. The function
4694 that reads a file can be used. */
4695
4696 f = fdopen(fd, "rb");
4697 sigalrm_seen = FALSE;
4698 alarm(timeout);
4699 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4700 alarm(0);
f1e894f3 4701 (void)fclose(f);
059ec3d9
PH
4702
4703 /* After a timeout, we restore the pointer in the result, that is,
4704 make sure we add nothing from the socket. */
4705
4706 if (sigalrm_seen)
4707 {
4708 ptr = save_ptr;
1cce3af8 4709 expand_string_message = US "socket read timed out";
059ec3d9
PH
4710 goto SOCK_FAIL;
4711 }
4712 }
4713
4714 /* The whole thing has worked (or we were skipping). If there is a
4715 failure string following, we need to skip it. */
4716
4717 if (*s == '{')
4718 {
b0e85a8f 4719 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
059ec3d9
PH
4720 goto EXPAND_FAILED;
4721 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4722 while (isspace(*s)) s++;
4723 }
4724 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4725 continue;
4726
4727 /* Come here on failure to create socket, connect socket, write to the
4728 socket, or timeout on reading. If another substring follows, expand and
4729 use it. Otherwise, those conditions give expand errors. */
4730
4731 SOCK_FAIL:
4732 if (*s != '{') goto EXPAND_FAILED;
4733 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
b0e85a8f 4734 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
059ec3d9
PH
4735 if (arg == NULL) goto EXPAND_FAILED;
4736 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4737 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4738 while (isspace(*s)) s++;
4739 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4740 continue;
4741 }
4742
4743 /* Handle "run" to execute a program. */
4744
4745 case EITEM_RUN:
4746 {
4747 FILE *f;
059ec3d9
PH
4748 uschar *arg;
4749 uschar **argv;
4750 pid_t pid;
4751 int fd_in, fd_out;
4752 int lsize = 0;
4753 int lptr = 0;
4754
4755 if ((expand_forbid & RDO_RUN) != 0)
4756 {
4757 expand_string_message = US"running a command is not permitted";
4758 goto EXPAND_FAILED;
4759 }
4760
4761 while (isspace(*s)) s++;
4762 if (*s != '{') goto EXPAND_FAILED_CURLY;
b0e85a8f 4763 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
059ec3d9
PH
4764 if (arg == NULL) goto EXPAND_FAILED;
4765 while (isspace(*s)) s++;
4766 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4767
4768 if (skipping) /* Just pretend it worked when we're skipping */
4769 {
4770 runrc = 0;
4771 }
4772 else
4773 {
4774 if (!transport_set_up_command(&argv, /* anchor for arg list */
4775 arg, /* raw command */
4776 FALSE, /* don't expand the arguments */
4777 0, /* not relevant when... */
4778 NULL, /* no transporting address */
4779 US"${run} expansion", /* for error messages */
4780 &expand_string_message)) /* where to put error message */
4781 {
4782 goto EXPAND_FAILED;
4783 }
4784
4785 /* Create the child process, making it a group leader. */
4786
4787 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4788
4789 if (pid < 0)
4790 {
4791 expand_string_message =
4792 string_sprintf("couldn't create child process: %s", strerror(errno));
4793 goto EXPAND_FAILED;
4794 }
4795
4796 /* Nothing is written to the standard input. */
4797
f1e894f3 4798 (void)close(fd_in);
059ec3d9 4799
ac53fcda
PP
4800 /* Read the pipe to get the command's output into $value (which is kept
4801 in lookup_value). Read during execution, so that if the output exceeds
4802 the OS pipe buffer limit, we don't block forever. */
4803
4804 f = fdopen(fd_out, "rb");
4805 sigalrm_seen = FALSE;
4806 alarm(60);
4807 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4808 alarm(0);
4809 (void)fclose(f);
4810
059ec3d9
PH
4811 /* Wait for the process to finish, applying the timeout, and inspect its
4812 return code for serious disasters. Simple non-zero returns are passed on.
4813 */
4814
ac53fcda 4815 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
059ec3d9 4816 {
ac53fcda 4817 if (sigalrm_seen == TRUE || runrc == -256)
059ec3d9
PH
4818 {
4819 expand_string_message = string_sprintf("command timed out");
4820 killpg(pid, SIGKILL); /* Kill the whole process group */
4821 }
4822
4823 else if (runrc == -257)
4824 expand_string_message = string_sprintf("wait() failed: %s",
4825 strerror(errno));
4826
4827 else
4828 expand_string_message = string_sprintf("command killed by signal %d",
4829 -runrc);
4830
4831 goto EXPAND_FAILED;
4832 }
059ec3d9
PH
4833 }
4834
d20976dc 4835 /* Process the yes/no strings; $value may be useful in both cases */
059ec3d9
PH
4836
4837 switch(process_yesno(
4838 skipping, /* were previously skipping */
4839 runrc == 0, /* success/failure indicator */
d20976dc 4840 lookup_value, /* value to reset for string2 */
059ec3d9
PH
4841 &s, /* input pointer */
4842 &yield, /* output pointer */
4843 &size, /* output size */
4844 &ptr, /* output current point */
b0e85a8f
JH
4845 US"run", /* condition type */
4846 &resetok))
059ec3d9
PH
4847 {
4848 case 1: goto EXPAND_FAILED; /* when all is well, the */
4849 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4850 }
4851
4852 continue;
4853 }
4854
4855 /* Handle character translation for "tr" */
4856
4857 case EITEM_TR:
4858 {
4859 int oldptr = ptr;
4860 int o2m;
4861 uschar *sub[3];
4862
b0e85a8f 4863 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
059ec3d9
PH
4864 {
4865 case 1: goto EXPAND_FAILED_CURLY;
4866 case 2:
4867 case 3: goto EXPAND_FAILED;
4868 }
4869
4870 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4871 o2m = Ustrlen(sub[2]) - 1;
4872
4873 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4874 {
4875 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4876 if (m != NULL)
4877 {
4878 int o = m - sub[1];
4879 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4880 }
4881 }
4882
4883 continue;
4884 }
4885
4886 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4887 expanded arguments. */
4888
4889 case EITEM_HASH:
4890 case EITEM_LENGTH:
4891 case EITEM_NHASH:
4892 case EITEM_SUBSTR:
4893 {
4894 int i;
4895 int len;
4896 uschar *ret;
4897 int val[2] = { 0, -1 };
4898 uschar *sub[3];
4899
4900 /* "length" takes only 2 arguments whereas the others take 2 or 3.
2e23003a 4901 Ensure that sub[2] is set in the ${length } case. */
059ec3d9
PH
4902
4903 sub[2] = NULL;
4904 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
b0e85a8f 4905 TRUE, name, &resetok))
059ec3d9
PH
4906 {
4907 case 1: goto EXPAND_FAILED_CURLY;
4908 case 2:
4909 case 3: goto EXPAND_FAILED;
4910 }
4911
4912 /* Juggle the arguments if there are only two of them: always move the
4913 string to the last position and make ${length{n}{str}} equivalent to
4914 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4915
4916 if (sub[2] == NULL)
4917 {
4918 sub[2] = sub[1];
4919 sub[1] = NULL;
4920 if (item_type == EITEM_LENGTH)
4921 {
4922 sub[1] = sub[0];
4923 sub[0] = NULL;
4924 }
4925 }
4926
4927 for (i = 0; i < 2; i++)
4928 {
4929 if (sub[i] == NULL) continue;
4930 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4931 if (*ret != 0 || (i != 0 && val[i] < 0))
4932 {
4933 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4934 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4935 goto EXPAND_FAILED;
4936 }
4937 }
4938
4939 ret =
4940 (item_type == EITEM_HASH)?
4941 compute_hash(sub[2], val[0], val[1], &len) :
4942 (item_type == EITEM_NHASH)?
4943 compute_nhash(sub[2], val[0], val[1], &len) :
4944 extract_substr(sub[2], val[0], val[1], &len);
4945
4946 if (ret == NULL) goto EXPAND_FAILED;
4947 yield = string_cat(yield, &size, &ptr, ret, len);
4948 continue;
4949 }
4950
4951 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4952 This code originally contributed by Steve Haslam. It currently supports
4953 the use of MD5 and SHA-1 hashes.
4954
4955 We need some workspace that is large enough to handle all the supported
4956 hash types. Use macros to set the sizes rather than be too elaborate. */
4957
4958 #define MAX_HASHLEN 20
4959 #define MAX_HASHBLOCKLEN 64
4960
4961 case EITEM_HMAC:
4962 {
4963 uschar *sub[3];
4964 md5 md5_base;
4965 sha1 sha1_base;
4966 void *use_base;
4967 int type, i;
4968 int hashlen; /* Number of octets for the hash algorithm's output */
4969 int hashblocklen; /* Number of octets the hash algorithm processes */
4970 uschar *keyptr, *p;
4971 unsigned int keylen;
4972
4973 uschar keyhash[MAX_HASHLEN];
4974 uschar innerhash[MAX_HASHLEN];
4975 uschar finalhash[MAX_HASHLEN];
4976 uschar finalhash_hex[2*MAX_HASHLEN];
4977 uschar innerkey[MAX_HASHBLOCKLEN];
4978 uschar outerkey[MAX_HASHBLOCKLEN];
4979
b0e85a8f 4980 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
059ec3d9
PH
4981 {
4982 case 1: goto EXPAND_FAILED_CURLY;
4983 case 2:
4984 case 3: goto EXPAND_FAILED;
4985 }
4986
4987 if (Ustrcmp(sub[0], "md5") == 0)
4988 {
4989 type = HMAC_MD5;
4990 use_base = &md5_base;
4991 hashlen = 16;
4992 hashblocklen = 64;
4993 }
4994 else if (Ustrcmp(sub[0], "sha1") == 0)
4995 {
4996 type = HMAC_SHA1;
4997 use_base = &sha1_base;
4998 hashlen = 20;
4999 hashblocklen = 64;
5000 }
5001 else
5002 {
5003 expand_string_message =
5004 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5005 goto EXPAND_FAILED;
5006 }
5007
5008 keyptr = sub[1];
5009 keylen = Ustrlen(keyptr);
5010
5011 /* If the key is longer than the hash block length, then hash the key
5012 first */
5013
5014 if (keylen > hashblocklen)
5015 {
5016 chash_start(type, use_base);
5017 chash_end(type, use_base, keyptr, keylen, keyhash);
5018 keyptr = keyhash;
5019 keylen = hashlen;
5020 }
5021
5022 /* Now make the inner and outer key values */
5023
5024 memset(innerkey, 0x36, hashblocklen);
5025 memset(outerkey, 0x5c, hashblocklen);
5026
5027 for (i = 0; i < keylen; i++)
5028 {
5029 innerkey[i] ^= keyptr[i];
5030 outerkey[i] ^= keyptr[i];
5031 }
5032
5033 /* Now do the hashes */
5034
5035 chash_start(type, use_base);
5036 chash_mid(type, use_base, innerkey);
5037 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5038
5039 chash_start(type, use_base);
5040 chash_mid(type, use_base, outerkey);
5041 chash_end(type, use_base, innerhash, hashlen, finalhash);
5042
5043 /* Encode the final hash as a hex string */
5044
5045 p = finalhash_hex;
5046 for (i = 0; i < hashlen; i++)
5047 {
5048 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5049 *p++ = hex_digits[finalhash[i] & 0x0f];
5050 }
5051
5052 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5053 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5054
5055 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5056 }
5057
5058 continue;
5059
5060 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5061 We have to save the numerical variables and restore them afterwards. */
5062
5063 case EITEM_SG:
5064 {
5065 const pcre *re;
5066 int moffset, moffsetextra, slen;
5067 int roffset;
5068 int emptyopt;
5069 const uschar *rerror;
5070 uschar *subject;
5071 uschar *sub[3];
5072 int save_expand_nmax =
5073 save_expand_strings(save_expand_nstring, save_expand_nlength);
5074
b0e85a8f 5075 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
059ec3d9
PH
5076 {
5077 case 1: goto EXPAND_FAILED_CURLY;
5078 case 2:
5079 case 3: goto EXPAND_FAILED;
5080 }
5081
5082 /* Compile the regular expression */
5083
5084 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5085 NULL);
5086
5087 if (re == NULL)
5088 {
5089 expand_string_message = string_sprintf("regular expression error in "
5090 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5091 goto EXPAND_FAILED;
5092 }
5093
5094 /* Now run a loop to do the substitutions as often as necessary. It ends
5095 when there are no more matches. Take care over matches of the null string;
5096 do the same thing as Perl does. */
5097
5098 subject = sub[0];
5099 slen = Ustrlen(sub[0]);
5100 moffset = moffsetextra = 0;
5101 emptyopt = 0;
5102
5103 for (;;)
5104 {
5105 int ovector[3*(EXPAND_MAXN+1)];
5106 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5107 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
5108 int nn;
5109 uschar *insert;
5110
5111 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5112 is not necessarily the end. We want to repeat the match from one
5113 character further along, but leaving the basic offset the same (for
5114 copying below). We can't be at the end of the string - that was checked
5115 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5116 finished; copy the remaining string and end the loop. */
5117
5118 if (n < 0)
5119 {
5120 if (emptyopt != 0)
5121 {
5122 moffsetextra = 1;
5123 emptyopt = 0;
5124 continue;
5125 }
5126 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5127 break;
5128 }
5129
5130 /* Match - set up for expanding the replacement. */
5131
5132 if (n == 0) n = EXPAND_MAXN + 1;
5133 expand_nmax = 0;
5134 for (nn = 0; nn < n*2; nn += 2)
5135 {
5136 expand_nstring[expand_nmax] = subject + ovector[nn];
5137 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5138 }
5139 expand_nmax--;
5140
5141 /* Copy the characters before the match, plus the expanded insertion. */
5142
5143 yield = string_cat(yield, &size, &ptr, subject + moffset,
5144 ovector[0] - moffset);
5145 insert = expand_string(sub[2]);
5146 if (insert == NULL) goto EXPAND_FAILED;
5147 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5148
5149 moffset = ovector[1];
5150 moffsetextra = 0;
5151 emptyopt = 0;
5152
5153 /* If we have matched an empty string, first check to see if we are at
5154 the end of the subject. If so, the loop is over. Otherwise, mimic
5155 what Perl's /g options does. This turns out to be rather cunning. First
5156 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5157 string at the same point. If this fails (picked up above) we advance to
5158 the next character. */
5159
5160 if (ovector[0] == ovector[1])
5161 {
5162 if (ovector[0] == slen) break;
5163 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5164 }
5165 }
5166
5167 /* All done - restore numerical variables. */
5168
5169 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5170 save_expand_nlength);
5171 continue;
5172 }
5173
5174 /* Handle keyed and numbered substring extraction. If the first argument
5175 consists entirely of digits, then a numerical extraction is assumed. */
5176
5177 case EITEM_EXTRACT:
5178 {
5179 int i;
5180 int j = 2;
5181 int field_number = 1;
5182 BOOL field_number_set = FALSE;
5183 uschar *save_lookup_value = lookup_value;
5184 uschar *sub[3];
5185 int save_expand_nmax =
5186 save_expand_strings(save_expand_nstring, save_expand_nlength);
5187
5188 /* Read the arguments */
5189
5190 for (i = 0; i < j; i++)
5191 {
5192 while (isspace(*s)) s++;
aa26e137 5193 if (*s == '{') /*}*/
059ec3d9 5194 {
b0e85a8f
JH
5195 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5196 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
059ec3d9
PH
5197 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5198
5199 /* After removal of leading and trailing white space, the first
5200 argument must not be empty; if it consists entirely of digits
5201 (optionally preceded by a minus sign), this is a numerical
5202 extraction, and we expect 3 arguments. */
5203
5204 if (i == 0)
5205 {
5206 int len;
5207 int x = 0;
5208 uschar *p = sub[0];
5209
5210 while (isspace(*p)) p++;
5211 sub[0] = p;
5212
5213 len = Ustrlen(p);
5214 while (len > 0 && isspace(p[len-1])) len--;
5215 p[len] = 0;
5216
e2803e40 5217 if (*p == 0 && !skipping)
059ec3d9 5218 {
554d2369
TF
5219 expand_string_message = US"first argument of \"extract\" must "
5220 "not be empty";
059ec3d9
PH
5221 goto EXPAND_FAILED;
5222 }
5223
5224 if (*p == '-')
5225 {
5226 field_number = -1;
5227 p++;
5228 }
5229 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5230 if (*p == 0)
5231 {
5232 field_number *= x;
5233 j = 3; /* Need 3 args */
5234 field_number_set = TRUE;
5235 }
5236 }
5237 }
5238 else goto EXPAND_FAILED_CURLY;
5239 }
5240
5241 /* Extract either the numbered or the keyed substring into $value. If
5242 skipping, just pretend the extraction failed. */
5243
5244 lookup_value = skipping? NULL : field_number_set?
5245 expand_gettokened(field_number, sub[1], sub[2]) :
5246 expand_getkeyed(sub[0], sub[1]);
5247
5248 /* If no string follows, $value gets substituted; otherwise there can
5249 be yes/no strings, as for lookup or if. */
5250
aa26e137
JH
5251 switch(process_yesno(
5252 skipping, /* were previously skipping */
5253 lookup_value != NULL, /* success/failure indicator */
5254 save_lookup_value, /* value to reset for string2 */
5255 &s, /* input pointer */
5256 &yield, /* output pointer */
5257 &size, /* output size */
5258 &ptr, /* output current point */
5259 US"extract", /* condition type */
5260 &resetok))
5261 {
5262 case 1: goto EXPAND_FAILED; /* when all is well, the */
5263 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5264 }
5265
5266 /* All done - restore numerical variables. */
5267
5268 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5269 save_expand_nlength);
5270
5271 continue;
5272 }
5273
5274 /* return the Nth item from a list */
5275
5276 case EITEM_LISTEXTRACT:
5277 {
5278 int i;
5279 int field_number = 1;
5280 uschar *save_lookup_value = lookup_value;
5281 uschar *sub[2];
5282 int save_expand_nmax =
5283 save_expand_strings(save_expand_nstring, save_expand_nlength);
5284
5285 /* Read the field & list arguments */
5286
5287 for (i = 0; i < 2; i++)
5288 {
5289 while (isspace(*s)) s++;
5290 if (*s != '{') /*}*/
5291 goto EXPAND_FAILED_CURLY;
5292
5293 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5294 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5295 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5296
5297 /* After removal of leading and trailing white space, the first
5298 argument must be numeric and nonempty. */
5299
5300 if (i == 0)
5301 {
5302 int len;
5303 int x = 0;
5304 uschar *p = sub[0];
5305
5306 while (isspace(*p)) p++;
5307 sub[0] = p;
5308
5309 len = Ustrlen(p);
5310 while (len > 0 && isspace(p[len-1])) len--;
5311 p[len] = 0;
5312
5313 if (!*p && !skipping)
5314 {
5315 expand_string_message = US"first argument of \"listextract\" must "
5316 "not be empty";
5317 goto EXPAND_FAILED;
5318 }
5319
5320 if (*p == '-')
5321 {
5322 field_number = -1;
5323 p++;
5324 }
5325 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5326 if (*p)
5327 {
5328 expand_string_message = US"first argument of \"listextract\" must "
5329 "be numeric";
5330 goto EXPAND_FAILED;
5331 }
5332 field_number *= x;
5333 }
5334 }
5335
5336 /* Extract the numbered element into $value. If
5337 skipping, just pretend the extraction failed. */
5338
5339 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5340
5341 /* If no string follows, $value gets substituted; otherwise there can
5342 be yes/no strings, as for lookup or if. */
5343
059ec3d9
PH
5344 switch(process_yesno(
5345 skipping, /* were previously skipping */
5346 lookup_value != NULL, /* success/failure indicator */
5347 save_lookup_value, /* value to reset for string2 */
5348 &s, /* input pointer */
5349 &yield, /* output pointer */
5350 &size, /* output size */
5351 &ptr, /* output current point */
b0e85a8f
JH
5352 US"extract", /* condition type */
5353 &resetok))
059ec3d9
PH
5354 {
5355 case 1: goto EXPAND_FAILED; /* when all is well, the */
5356 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5357 }
5358
5359 /* All done - restore numerical variables. */
5360
5361 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5362 save_expand_nlength);
5363
5364 continue;
5365 }
1a46a8c5 5366
9d1c15ef
JH
5367#ifdef SUPPORT_TLS
5368 case EITEM_CERTEXTRACT:
5369 {
9d1c15ef
JH
5370 uschar *save_lookup_value = lookup_value;
5371 uschar *sub[2];
5372 int save_expand_nmax =
5373 save_expand_strings(save_expand_nstring, save_expand_nlength);
5374
5375 /* Read the field argument */
5376 while (isspace(*s)) s++;
5377 if (*s != '{') /*}*/
5378 goto EXPAND_FAILED_CURLY;
5379 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5380 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5381 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5382 /* strip spaces fore & aft */
5383 {
5384 int len;
9d1c15ef
JH
5385 uschar *p = sub[0];
5386
5387 while (isspace(*p)) p++;
5388 sub[0] = p;
5389
5390 len = Ustrlen(p);
5391 while (len > 0 && isspace(p[len-1])) len--;
5392 p[len] = 0;
5393 }
5394
5395 /* inspect the cert argument */
5396 while (isspace(*s)) s++;
5397 if (*s != '{') /*}*/
5398 goto EXPAND_FAILED_CURLY;
5399 if (*++s != '$')
5400 {
5401 expand_string_message = US"second argument of \"certextract\" must "
5402 "be a certificate variable";
5403 goto EXPAND_FAILED;
5404 }
5405 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5406 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5407 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5408
5409 if (skipping)
5410 lookup_value = NULL;
5411 else
5412 {
5413 lookup_value = expand_getcertele(sub[0], sub[1]);
5414 if (*expand_string_message) goto EXPAND_FAILED;
5415 }
5416 switch(process_yesno(
5417 skipping, /* were previously skipping */
5418 lookup_value != NULL, /* success/failure indicator */
5419 save_lookup_value, /* value to reset for string2 */
5420 &s, /* input pointer */
5421 &yield, /* output pointer */
5422 &size, /* output size */
5423 &ptr, /* output current point */
5424 US"extract", /* condition type */
5425 &resetok))
5426 {
5427 case 1: goto EXPAND_FAILED; /* when all is well, the */
5428 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5429 }
5430
5431 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5432 save_expand_nlength);
5433 continue;
5434 }
5435#endif /*SUPPORT_TLS*/
5436
29f89cad
PH
5437 /* Handle list operations */
5438
5439 case EITEM_FILTER:
5440 case EITEM_MAP:
5441 case EITEM_REDUCE:
5442 {
5443 int sep = 0;
5444 int save_ptr = ptr;
5445 uschar outsep[2] = { '\0', '\0' };
5446 uschar *list, *expr, *temp;
5447 uschar *save_iterate_item = iterate_item;
5448 uschar *save_lookup_value = lookup_value;
5449
5450 while (isspace(*s)) s++;
5451 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5452
b0e85a8f 5453 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
29f89cad
PH
5454 if (list == NULL) goto EXPAND_FAILED;
5455 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5456
5457 if (item_type == EITEM_REDUCE)
5458 {
5459 while (isspace(*s)) s++;
5460 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
b0e85a8f 5461 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
29f89cad
PH
5462 if (temp == NULL) goto EXPAND_FAILED;
5463 lookup_value = temp;
5464 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5465 }
5466
5467 while (isspace(*s)) s++;
5468 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5469
5470 expr = s;
5471
5472 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5473 if scanning a "false" part). This allows us to find the end of the
5474 condition, because if the list is empty, we won't actually evaluate the
5475 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5476 the normal internal expansion function. */
5477
5478 if (item_type == EITEM_FILTER)
5479 {
b0e85a8f 5480 temp = eval_condition(expr, &resetok, NULL);
29f89cad
PH
5481 if (temp != NULL) s = temp;
5482 }
5483 else
5484 {
b0e85a8f 5485 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
29f89cad
PH
5486 }
5487
5488 if (temp == NULL)
5489 {
5490 expand_string_message = string_sprintf("%s inside \"%s\" item",
5491 expand_string_message, name);
5492 goto EXPAND_FAILED;
5493 }
5494
5495 while (isspace(*s)) s++;
5496 if (*s++ != '}')
2e23003a 5497 { /*{*/
29f89cad
PH
5498 expand_string_message = string_sprintf("missing } at end of condition "
5499 "or expression inside \"%s\"", name);
5500 goto EXPAND_FAILED;
5501 }
5502
2e23003a 5503 while (isspace(*s)) s++; /*{*/
29f89cad 5504 if (*s++ != '}')
2e23003a 5505 { /*{*/
29f89cad
PH
5506 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5507 name);
5508 goto EXPAND_FAILED;
5509 }
5510
5511 /* If we are skipping, we can now just move on to the next item. When
5512 processing for real, we perform the iteration. */
5513
5514 if (skipping) continue;
5515 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5516 {
5517 *outsep = (uschar)sep; /* Separator as a string */
5518
5519 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5520
5521 if (item_type == EITEM_FILTER)
5522 {
5523 BOOL condresult;
b0e85a8f 5524 if (eval_condition(expr, &resetok, &condresult) == NULL)
29f89cad 5525 {
e58c13cc
PH
5526 iterate_item = save_iterate_item;
5527 lookup_value = save_lookup_value;
29f89cad
PH
5528 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5529 expand_string_message, name);
5530 goto EXPAND_FAILED;
5531 }
5532 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5533 condresult? "true":"false");
5534 if (condresult)
5535 temp = iterate_item; /* TRUE => include this item */
5536 else
5537 continue; /* FALSE => skip this item */
5538 }
5539
5540 /* EITEM_MAP and EITEM_REDUCE */
5541
5542 else
5543 {
b0e85a8f 5544 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
29f89cad
PH
5545 if (temp == NULL)
5546 {
e58c13cc 5547 iterate_item = save_iterate_item;
29f89cad
PH
5548 expand_string_message = string_sprintf("%s inside \"%s\" item",
5549 expand_string_message, name);
5550 goto EXPAND_FAILED;
5551 }
5552 if (item_type == EITEM_REDUCE)
5553 {
5554 lookup_value = temp; /* Update the value of $value */
5555 continue; /* and continue the iteration */
5556 }
5557 }
5558
5559 /* We reach here for FILTER if the condition is true, always for MAP,
5560 and never for REDUCE. The value in "temp" is to be added to the output
5561 list that is being created, ensuring that any occurrences of the
5562 separator character are doubled. Unless we are dealing with the first
5563 item of the output list, add in a space if the new item begins with the
5564 separator character, or is an empty string. */
5565
5566 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5567 yield = string_cat(yield, &size, &ptr, US" ", 1);
5568
5569 /* Add the string in "temp" to the output list that we are building,
5570 This is done in chunks by searching for the separator character. */
5571
5572 for (;;)
5573 {
5574 size_t seglen = Ustrcspn(temp, outsep);
5575 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5576
5577 /* If we got to the end of the string we output one character
5578 too many; backup and end the loop. Otherwise arrange to double the
5579 separator. */
5580
5581 if (temp[seglen] == '\0') { ptr--; break; }
5582 yield = string_cat(yield, &size, &ptr, outsep, 1);
5583 temp += seglen + 1;
5584 }
5585
5586 /* Output a separator after the string: we will remove the redundant
5587 final one at the end. */
5588
5589 yield = string_cat(yield, &size, &ptr, outsep, 1);
5590 } /* End of iteration over the list loop */
5591
5592 /* REDUCE has generated no output above: output the final value of
5593 $value. */
5594
5595 if (item_type == EITEM_REDUCE)
5596 {
5597 yield = string_cat(yield, &size, &ptr, lookup_value,
5598 Ustrlen(lookup_value));
5599 lookup_value = save_lookup_value; /* Restore $value */
5600 }
5601
5602 /* FILTER and MAP generate lists: if they have generated anything, remove
5603 the redundant final separator. Even though an empty item at the end of a
5604 list does not count, this is tidier. */
5605
5606 else if (ptr != save_ptr) ptr--;
5607
5608 /* Restore preserved $item */
5609
5610 iterate_item = save_iterate_item;
5611 continue;
5612 }
5613
5614
2e23003a 5615 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
1a46a8c5
PH
5616 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5617 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5618 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5619
5620 #define EXPAND_DLFUNC_MAX_ARGS 8
5621
5622 case EITEM_DLFUNC:
5623 #ifndef EXPAND_DLFUNC
2e23003a 5624 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
1a46a8c5
PH
5625 "is not included in this binary";
5626 goto EXPAND_FAILED;
5627
5628 #else /* EXPAND_DLFUNC */
5629 {
5630 tree_node *t;
5631 exim_dlfunc_t *func;
5632 uschar *result;
5633 int status, argc;
5634 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5635
5636 if ((expand_forbid & RDO_DLFUNC) != 0)
5637 {
5638 expand_string_message =
5639 US"dynamically-loaded functions are not permitted";
5640 goto EXPAND_FAILED;
5641 }
5642
5643 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
b0e85a8f 5644 TRUE, US"dlfunc", &resetok))
1a46a8c5
PH
5645 {
5646 case 1: goto EXPAND_FAILED_CURLY;
5647 case 2:
5648 case 3: goto EXPAND_FAILED;
5649 }
5650
5651 /* If skipping, we don't actually do anything */
5652
5653 if (skipping) continue;
5654
5655 /* Look up the dynamically loaded object handle in the tree. If it isn't
5656 found, dlopen() the file and put the handle in the tree for next time. */
5657
5658 t = tree_search(dlobj_anchor, argv[0]);
5659 if (t == NULL)
5660 {
5661 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5662 if (handle == NULL)
5663 {
5664 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5665 argv[0], dlerror());
5666 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5667 goto EXPAND_FAILED;
5668 }
5669 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5670 Ustrcpy(t->name, argv[0]);
5671 t->data.ptr = handle;
5672 (void)tree_insertnode(&dlobj_anchor, t);
5673 }
5674
5675 /* Having obtained the dynamically loaded object handle, look up the
5676 function pointer. */
5677
5678 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5679 if (func == NULL)
5680 {
5681 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5682 "%s", argv[1], argv[0], dlerror());
7dbf77c9 5683 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
1a46a8c5
PH
5684 goto EXPAND_FAILED;
5685 }
5686
5687 /* Call the function and work out what to do with the result. If it
5688 returns OK, we have a replacement string; if it returns DEFER then
5689 expansion has failed in a non-forced manner; if it returns FAIL then
5690 failure was forced; if it returns ERROR or any other value there's a
d6b4d938
TF
5691 problem, so panic slightly. In any case, assume that the function has
5692 side-effects on the store that must be preserved. */
1a46a8c5 5693
d6b4d938 5694 resetok = FALSE;
1a46a8c5
PH
5695 result = NULL;
5696 for (argc = 0; argv[argc] != NULL; argc++);
5697 status = func(&result, argc - 2, &argv[2]);
5698 if(status == OK)
5699 {
5700 if (result == NULL) result = US"";
5701 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5702 continue;
5703 }
5704 else
5705 {
5706 expand_string_message = result == NULL ? US"(no message)" : result;
5707 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5708 else if(status != FAIL)
5709 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5710 argv[0], argv[1], status, expand_string_message);
5711 goto EXPAND_FAILED;
5712 }
5713 }
5714 #endif /* EXPAND_DLFUNC */
2e23003a 5715 } /* EITEM_* switch */
059ec3d9
PH
5716
5717 /* Control reaches here if the name is not recognized as one of the more
5718 complicated expansion items. Check for the "operator" syntax (name terminated
5719 by a colon). Some of the operators have arguments, separated by _ from the
5720 name. */
5721
5722 if (*s == ':')
5723 {
5724 int c;
5725 uschar *arg = NULL;
6a8a60e0 5726 uschar *sub;
e3dd1d67 5727 var_entry *vp = NULL;
059ec3d9
PH
5728
5729 /* Owing to an historical mis-design, an underscore may be part of the
5730 operator name, or it may introduce arguments. We therefore first scan the
5731 table of names that contain underscores. If there is no match, we cut off
5732 the arguments and then scan the main table. */
5733
6a8a60e0
JH
5734 if ((c = chop_match(name, op_table_underscore,
5735 sizeof(op_table_underscore)/sizeof(uschar *))) < 0)
059ec3d9
PH
5736 {
5737 arg = Ustrchr(name, '_');
5738 if (arg != NULL) *arg = 0;
5739 c = chop_match(name, op_table_main,
5740 sizeof(op_table_main)/sizeof(uschar *));
5741 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5742 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5743 }
5744
6a8a60e0
JH
5745 /* Deal specially with operators that might take a certificate variable
5746 as we do not want to do the usual expansion. For most, expand the string.*/
5747 switch(c)
5748 {
80c974f8 5749#ifdef SUPPORT_TLS
6a8a60e0 5750 case EOP_MD5:
9ef9101c
JH
5751 case EOP_SHA1:
5752 case EOP_SHA256:
6a8a60e0
JH
5753 if (s[1] == '$')
5754 {
5755 uschar * s1 = s;
5756 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
5757 FALSE, &resetok);
5758 if (!sub) goto EXPAND_FAILED; /*{*/
5759 if (*s1 != '}') goto EXPAND_FAILED_CURLY;
5760 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
5761 {
5762 s = s1+1;
5763 break;
5764 }
fabe4dd9 5765 vp = NULL;
6a8a60e0 5766 }
6a8a60e0 5767 /*FALLTHROUGH*/
80c974f8 5768#endif
6a8a60e0
JH
5769 default:
5770 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5771 if (!sub) goto EXPAND_FAILED;
5772 s++;
5773 break;
5774 }
5775
059ec3d9
PH
5776 /* If we are skipping, we don't need to perform the operation at all.
5777 This matters for operations like "mask", because the data may not be
5778 in the correct format when skipping. For example, the expression may test
5779 for the existence of $sender_host_address before trying to mask it. For
5780 other operations, doing them may not fail, but it is a waste of time. */
5781
5782 if (skipping && c >= 0) continue;
5783
5784 /* Otherwise, switch on the operator type */
5785
5786 switch(c)
5787 {
5788 case EOP_BASE62:
5789 {
5790 uschar *t;
5791 unsigned long int n = Ustrtoul(sub, &t, 10);
5792 if (*t != 0)
5793 {
5794 expand_string_message = string_sprintf("argument for base62 "
5795 "operator is \"%s\", which is not a decimal number", sub);
5796 goto EXPAND_FAILED;
5797 }
5798 t = string_base62(n);
5799 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5800 continue;
5801 }
5802
9a799bc0
PH
5803 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5804
059ec3d9
PH
5805 case EOP_BASE62D:
5806 {
5807 uschar buf[16];
5808 uschar *tt = sub;
5809 unsigned long int n = 0;
5810 while (*tt != 0)
5811 {
5812 uschar *t = Ustrchr(base62_chars, *tt++);
5813 if (t == NULL)
5814 {
5815 expand_string_message = string_sprintf("argument for base62d "
9a799bc0
PH
5816 "operator is \"%s\", which is not a base %d number", sub,
5817 BASE_62);
059ec3d9
PH
5818 goto EXPAND_FAILED;
5819 }
9a799bc0 5820 n = n * BASE_62 + (t - base62_chars);
059ec3d9
PH
5821 }
5822 (void)sprintf(CS buf, "%ld", n);
5823 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5824 continue;
5825 }
5826
5827 case EOP_EXPAND:
5828 {
b0e85a8f 5829 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
059ec3d9
PH
5830 if (expanded == NULL)
5831 {
5832 expand_string_message =
5833 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5834 expand_string_message);
5835 goto EXPAND_FAILED;
5836 }
5837 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5838 continue;
5839 }
5840
5841 case EOP_LC:
5842 {
5843 int count = 0;
5844 uschar *t = sub - 1;
5845 while (*(++t) != 0) { *t = tolower(*t); count++; }
5846 yield = string_cat(yield, &size, &ptr, sub, count);
5847 continue;
5848 }
5849
5850 case EOP_UC:
5851 {
5852 int count = 0;
5853 uschar *t = sub - 1;
5854 while (*(++t) != 0) { *t = toupper(*t); count++; }
5855 yield = string_cat(yield, &size, &ptr, sub, count);
5856 continue;
5857 }
5858
5859 case EOP_MD5:
80c974f8 5860#ifdef SUPPORT_TLS
6a8a60e0
JH
5861 if (vp && *(void **)vp->value)
5862 {
5863 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
e3dd1d67 5864 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6a8a60e0
JH
5865 }
5866 else
80c974f8 5867#endif
6a8a60e0
JH
5868 {
5869 md5 base;
5870 uschar digest[16];
5871 int j;
5872 char st[33];
5873 md5_start(&base);
5874 md5_end(&base, sub, Ustrlen(sub), digest);
5875 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5876 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5877 }
059ec3d9 5878 continue;
059ec3d9
PH
5879
5880 case EOP_SHA1:
80c974f8 5881#ifdef SUPPORT_TLS
6a8a60e0
JH
5882 if (vp && *(void **)vp->value)
5883 {
5884 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
e3dd1d67 5885 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6a8a60e0
JH
5886 }
5887 else
80c974f8 5888#endif
6a8a60e0
JH
5889 {
5890 sha1 base;
5891 uschar digest[20];
5892 int j;
5893 char st[41];
5894 sha1_start(&base);
5895 sha1_end(&base, sub, Ustrlen(sub), digest);
5896 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5897 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5898 }
059ec3d9 5899 continue;
059ec3d9 5900
9ef9101c
JH
5901 case EOP_SHA256:
5902#ifdef SUPPORT_TLS
5903 if (vp && *(void **)vp->value)
5904 {
5905 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
5906 yield = string_cat(yield, &size, &ptr, cp, (int)strlen(cp));
5907 }
5908 else
5909#endif
5910 expand_string_message = US"sha256 only supported for certificates";
5911 continue;
5912
059ec3d9
PH
5913 /* Convert hex encoding to base64 encoding */
5914
5915 case EOP_HEX2B64:
5916 {
5917 int c = 0;
5918 int b = -1;
5919 uschar *in = sub;
5920 uschar *out = sub;
5921 uschar *enc;
5922
5923 for (enc = sub; *enc != 0; enc++)
5924 {
5925 if (!isxdigit(*enc))
5926 {
5927 expand_string_message = string_sprintf("\"%s\" is not a hex "
5928 "string", sub);
5929 goto EXPAND_FAILED;
5930 }
5931 c++;
5932 }
5933
5934 if ((c & 1) != 0)
5935 {
5936 expand_string_message = string_sprintf("\"%s\" contains an odd "
5937 "number of characters", sub);
5938 goto EXPAND_FAILED;
5939 }
5940
5941 while ((c = *in++) != 0)
5942 {
5943 if (isdigit(c)) c -= '0';
5944 else c = toupper(c) - 'A' + 10;
5945 if (b == -1)
5946 {
5947 b = c << 4;
5948 }
5949 else
5950 {
5951 *out++ = b | c;
5952 b = -1;
5953 }
5954 }
5955
5956 enc = auth_b64encode(sub, out - sub);
5957 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5958 continue;
5959 }
5960
c393f931
TF
5961 /* Convert octets outside 0x21..0x7E to \xXX form */
5962
5963 case EOP_HEXQUOTE:
5964 {
5965 uschar *t = sub - 1;
5966 while (*(++t) != 0)
5967 {
5968 if (*t < 0x21 || 0x7E < *t)
5969 yield = string_cat(yield, &size, &ptr,
5970 string_sprintf("\\x%02x", *t), 4);
5971 else
5972 yield = string_cat(yield, &size, &ptr, t, 1);
5973 }
5974 continue;
5975 }
5976
a64a3dfa
JH
5977 /* count the number of list elements */
5978
5979 case EOP_LISTCOUNT:
5980 {
5981 int cnt = 0;
5982 int sep = 0;
5983 uschar * cp;
5984 uschar buffer[256];
5985
5986 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
5987 cp = string_sprintf("%d", cnt);
5988 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
5989 continue;
5990 }
5991
042eb971 5992 /* expand a named list given the name */
a64a3dfa 5993 /* handles nested named lists; requotes as colon-sep list */
042eb971 5994
a64a3dfa 5995 case EOP_LISTNAMED:
042eb971
JH
5996 {
5997 tree_node *t = NULL;
5998 uschar * list;
5999 int sep = 0;
6000 uschar * item;
6d9cfc47 6001 uschar * suffix = US"";
042eb971
JH
6002 BOOL needsep = FALSE;
6003 uschar buffer[256];
6004
6005 if (*sub == '+') sub++;
6006 if (arg == NULL) /* no-argument version */
6007 {
6008 if (!(t = tree_search(addresslist_anchor, sub)) &&
6009 !(t = tree_search(domainlist_anchor, sub)) &&
6010 !(t = tree_search(hostlist_anchor, sub)))
6011 t = tree_search(localpartlist_anchor, sub);
6012 }
6013 else switch(*arg) /* specific list-type version */
6014 {
6d9cfc47
JH
6015 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6016 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6017 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6018 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
042eb971
JH
6019 default:
6020 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6021 goto EXPAND_FAILED;
6022 }
6023
6024 if(!t)
6025 {
6026 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6027 sub, !arg?""
6028 : *arg=='a'?"address "
6029 : *arg=='d'?"domain "
6030 : *arg=='h'?"host "
6031 : *arg=='l'?"localpart "
6032 : 0);
6033 goto EXPAND_FAILED;
6034 }
6035
042eb971
JH
6036 list = ((namedlist_block *)(t->data.ptr))->string;
6037
6038 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6039 {
6040 uschar * buf = US" : ";
6041 if (needsep)
6042 yield = string_cat(yield, &size, &ptr, buf, 3);
6043 else
6044 needsep = TRUE;
6045
6046 if (*item == '+') /* list item is itself a named list */
6047 {
a64a3dfa 6048 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
b0e85a8f 6049 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
042eb971
JH
6050 }
6051 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6052 {
6053 char * cp;
6054 char tok[3];
6055 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6056 while ((cp= strpbrk((const char *)item, tok)))
6057 {
6058 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
6059 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6060 {
6061 yield = string_cat(yield, &size, &ptr, US"::", 2);
6d9cfc47 6062 item = (uschar *)cp;
042eb971
JH
6063 }
6064 else /* sep in item; should already be doubled; emit once */
6065 {
6066 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
6067 if (*cp == sep) cp++;
6d9cfc47 6068 item = (uschar *)cp;
042eb971
JH
6069 }
6070 }
6071 }
6072 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
6073 }
6074 continue;
6075 }
6076
059ec3d9
PH
6077 /* mask applies a mask to an IP address; for example the result of
6078 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6079
6080 case EOP_MASK:
6081 {
6082 int count;
6083 uschar *endptr;
6084 int binary[4];
6085 int mask, maskoffset;
6086 int type = string_is_ip_address(sub, &maskoffset);
6087 uschar buffer[64];
6088
6089 if (type == 0)
6090 {
6091 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6092 sub);
6093 goto EXPAND_FAILED;
6094 }
6095
6096 if (maskoffset == 0)
6097 {
6098 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6099 sub);
6100 goto EXPAND_FAILED;
6101 }
6102
6103 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6104
6105 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6106 {
6107 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6108 sub);
6109 goto EXPAND_FAILED;
6110 }
6111
6112 /* Convert the address to binary integer(s) and apply the mask */
6113
6114 sub[maskoffset] = 0;
6115 count = host_aton(sub, binary);
6116 host_mask(count, binary, mask);
6117
6118 /* Convert to masked textual format and add to output. */
6119
6120 yield = string_cat(yield, &size, &ptr, buffer,
6f0c9a4f 6121 host_nmtoa(count, binary, mask, buffer, '.'));
059ec3d9
PH
6122 continue;
6123 }
6124
6125 case EOP_ADDRESS:
6126 case EOP_LOCAL_PART:
6127 case EOP_DOMAIN:
6128 {
6129 uschar *error;
6130 int start, end, domain;
6131 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6132 FALSE);
6133 if (t != NULL)
6134 {
6135 if (c != EOP_DOMAIN)
6136 {
6137 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6138 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
6139 }
6140 else if (domain != 0)
6141 {
6142 domain += start;
6143 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
6144 }
6145 }
6146 continue;
6147 }
6148
29f89cad
PH
6149 case EOP_ADDRESSES:
6150 {
6151 uschar outsep[2] = { ':', '\0' };
6152 uschar *address, *error;
6153 int save_ptr = ptr;
6154 int start, end, domain; /* Not really used */
6155
6156 while (isspace(*sub)) sub++;
6157 if (*sub == '>') { *outsep = *++sub; ++sub; }
6158 parse_allow_group = TRUE;
6159
6160 for (;;)
6161 {
6162 uschar *p = parse_find_address_end(sub, FALSE);
6163 uschar saveend = *p;
6164 *p = '\0';
6165 address = parse_extract_address(sub, &error, &start, &end, &domain,
6166 FALSE);
6167 *p = saveend;
6168
6169 /* Add the address to the output list that we are building. This is
6170 done in chunks by searching for the separator character. At the
6171 start, unless we are dealing with the first address of the output
6172 list, add in a space if the new address begins with the separator
6173 character, or is an empty string. */
6174
6175 if (address != NULL)
6176 {
6177 if (ptr != save_ptr && address[0] == *outsep)
6178 yield = string_cat(yield, &size, &ptr, US" ", 1);
6179
6180 for (;;)
6181 {
6182 size_t seglen = Ustrcspn(address, outsep);
6183 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
6184
6185 /* If we got to the end of the string we output one character
6186 too many. */
6187
6188 if (address[seglen] == '\0') { ptr--; break; }
6189 yield = string_cat(yield, &size, &ptr, outsep, 1);
6190 address += seglen + 1;
6191 }
6192
6193 /* Output a separator after the string: we will remove the
6194 redundant final one at the end. */
6195
6196 yield = string_cat(yield, &size, &ptr, outsep, 1);
6197 }
6198
6199 if (saveend == '\0') break;
6200 sub = p + 1;
6201 }
6202
6203 /* If we have generated anything, remove the redundant final
6204 separator. */
6205
6206 if (ptr != save_ptr) ptr--;
6207 parse_allow_group = FALSE;
6208 continue;
6209 }
6210
6211
059ec3d9
PH
6212 /* quote puts a string in quotes if it is empty or contains anything
6213 other than alphamerics, underscore, dot, or hyphen.
6214
6215 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6216 be quoted in order to be a valid local part.
6217
6218 In both cases, newlines and carriage returns are converted into \n and \r
6219 respectively */
6220
6221 case EOP_QUOTE:
6222 case EOP_QUOTE_LOCAL_PART:
6223 if (arg == NULL)
6224 {
6225 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6226 uschar *t = sub - 1;
6227
6228 if (c == EOP_QUOTE)
6229 {
6230 while (!needs_quote && *(++t) != 0)
6231 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6232 }
6233 else /* EOP_QUOTE_LOCAL_PART */
6234 {
6235 while (!needs_quote && *(++t) != 0)
6236 needs_quote = !isalnum(*t) &&
6237 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6238 (*t != '.' || t == sub || t[1] == 0);
6239 }
6240
6241 if (needs_quote)
6242 {
6243 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6244 t = sub - 1;
6245 while (*(++t) != 0)
6246 {
6247 if (*t == '\n')
6248 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6249 else if (*t == '\r')
6250 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6251 else
6252 {
6253 if (*t == '\\' || *t == '"')
6254 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6255 yield = string_cat(yield, &size, &ptr, t, 1);
6256 }
6257 }
6258 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6259 }
6260 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6261 continue;
6262 }
6263
6264 /* quote_lookuptype does lookup-specific quoting */
6265
6266 else
6267 {
6268 int n;
6269 uschar *opt = Ustrchr(arg, '_');
6270
6271 if (opt != NULL) *opt++ = 0;
6272
6273 n = search_findtype(arg, Ustrlen(arg));
6274 if (n < 0)
6275 {
6276 expand_string_message = search_error_message;
6277 goto EXPAND_FAILED;
6278 }
6279
e6d225ae
DW
6280 if (lookup_list[n]->quote != NULL)
6281 sub = (lookup_list[n]->quote)(sub, opt);
059ec3d9
PH
6282 else if (opt != NULL) sub = NULL;
6283
6284 if (sub == NULL)
6285 {
6286 expand_string_message = string_sprintf(
6287 "\"%s\" unrecognized after \"${quote_%s\"",
6288 opt, arg);
6289 goto EXPAND_FAILED;
6290 }
6291
6292 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6293 continue;
6294 }
6295
6296 /* rx quote sticks in \ before any non-alphameric character so that
6297 the insertion works in a regular expression. */
6298
6299 case EOP_RXQUOTE:
6300 {
6301 uschar *t = sub - 1;
6302 while (*(++t) != 0)
6303 {
6304 if (!isalnum(*t))
6305 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6306 yield = string_cat(yield, &size, &ptr, t, 1);
6307 }
6308 continue;
6309 }
6310
6311 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6312 prescribed by the RFC, if there are characters that need to be encoded */
6313
6314 case EOP_RFC2047:
6315 {
14702f5b 6316 uschar buffer[2048];
059ec3d9 6317 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
46218253 6318 buffer, sizeof(buffer), FALSE);
059ec3d9
PH
6319 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6320 continue;
6321 }
6322
9c57cbc0
PH
6323 /* RFC 2047 decode */
6324
6325 case EOP_RFC2047D:
6326 {
6327 int len;
6328 uschar *error;
6329 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6330 headers_charset, '?', &len, &error);
6331 if (error != NULL)
6332 {
6333 expand_string_message = error;
6334 goto EXPAND_FAILED;
6335 }
6336 yield = string_cat(yield, &size, &ptr, decoded, len);
6337 continue;
6338 }
6339
059ec3d9
PH
6340 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6341 underscores */
6342
6343 case EOP_FROM_UTF8:
6344 {
6345 while (*sub != 0)
6346 {
6347 int c;
6348 uschar buff[4];
6349 GETUTF8INC(c, sub);
6350 if (c > 255) c = '_';
6351 buff[0] = c;
6352 yield = string_cat(yield, &size, &ptr, buff, 1);
6353 }
6354 continue;
6355 }
6356
b9c2e32f
AR
6357 /* replace illegal UTF-8 sequences by replacement character */
6358
6359 #define UTF8_REPLACEMENT_CHAR US"?"
6360
6361 case EOP_UTF8CLEAN:
6362 {
6363 int seq_len, index = 0;
e3dd1d67 6364 int bytes_left = 0;
b9c2e32f
AR
6365 uschar seq_buff[4]; /* accumulate utf-8 here */
6366
6367 while (*sub != 0)
6368 {
6369 int complete;
6370 long codepoint;
6371 uschar c;
6372
6373 complete = 0;
6374 c = *sub++;
e3dd1d67 6375 if (bytes_left)
b9c2e32f
AR
6376 {
6377 if ((c & 0xc0) != 0x80)
6378 {
6379 /* wrong continuation byte; invalidate all bytes */
6380 complete = 1; /* error */
6381 }
6382 else
6383 {
6384 codepoint = (codepoint << 6) | (c & 0x3f);
6385 seq_buff[index++] = c;
6386 if (--bytes_left == 0) /* codepoint complete */
6387 {
6388 if(codepoint > 0x10FFFF) /* is it too large? */
6389 complete = -1; /* error */
6390 else
6391 { /* finished; output utf-8 sequence */
6392 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6393 index = 0;
6394 }
6395 }
6396 }
6397 }
6398 else /* no bytes left: new sequence */
6399 {
6400 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6401 {
6402 yield = string_cat(yield, &size, &ptr, &c, 1);
6403 continue;
6404 }
6405 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6406 {
10cc8a1e
AR
6407 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6408 complete = -1;
6409 else
6410 {
6411 bytes_left = 1;
6412 codepoint = c & 0x1f;
6413 }
b9c2e32f
AR
6414 }
6415 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6416 {
6417 bytes_left = 2;
6418 codepoint = c & 0x0f;
6419 }
6420 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6421 {
6422 bytes_left = 3;
6423 codepoint = c & 0x07;
6424 }
6425 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6426 complete = -1;
6427
6428 seq_buff[index++] = c;
6429 seq_len = bytes_left + 1;
6430 } /* if(bytes_left) */
6431
6432 if (complete != 0)
6433 {
6434 bytes_left = index = 0;
6435 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6436 }
6437 if ((complete == 1) && ((c & 0x80) == 0))
6438 { /* ASCII character follows incomplete sequence */
6439 yield = string_cat(yield, &size, &ptr, &c, 1);
6440 }
6441 }
6442 continue;
6443 }
6444
059ec3d9
PH
6445 /* escape turns all non-printing characters into escape sequences. */
6446
6447 case EOP_ESCAPE:
6448 {
6449 uschar *t = string_printing(sub);
6450 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6451 continue;
6452 }
6453
6454 /* Handle numeric expression evaluation */
6455
6456 case EOP_EVAL:
6457 case EOP_EVAL10:
6458 {
6459 uschar *save_sub = sub;
6460 uschar *error = NULL;
97d17305 6461 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
059ec3d9
PH
6462 if (error != NULL)
6463 {
6464 expand_string_message = string_sprintf("error in expression "
6465 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6466 save_sub);
6467 goto EXPAND_FAILED;
6468 }
97d17305 6469 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
059ec3d9
PH
6470 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6471 continue;
6472 }
6473
6474 /* Handle time period formating */
6475
f90d018c
PH
6476 case EOP_TIME_EVAL:
6477 {
6478 int n = readconf_readtime(sub, 0, FALSE);
6479 if (n < 0)
6480 {
6481 expand_string_message = string_sprintf("string \"%s\" is not an "
6482 "Exim time interval in \"%s\" operator", sub, name);
6483 goto EXPAND_FAILED;
6484 }
6485 sprintf(CS var_buffer, "%d", n);
6486 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6487 continue;
6488 }
6489
059ec3d9
PH
6490 case EOP_TIME_INTERVAL:
6491 {
6492 int n;
6493 uschar *t = read_number(&n, sub);
6494 if (*t != 0) /* Not A Number*/
6495 {
6496 expand_string_message = string_sprintf("string \"%s\" is not a "
6497 "positive number in \"%s\" operator", sub, name);
6498 goto EXPAND_FAILED;
6499 }
6500 t = readconf_printtime(n);
6501 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6502 continue;
6503 }
6504
6505 /* Convert string to base64 encoding */
6506
6507 case EOP_STR2B64:
6508 {
6509 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6510 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6511 continue;
6512 }
6513
6514 /* strlen returns the length of the string */
6515
6516 case EOP_STRLEN:
6517 {
6518 uschar buff[24];
6519 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6520 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6521 continue;
6522 }
6523
6524 /* length_n or l_n takes just the first n characters or the whole string,
6525 whichever is the shorter;
6526
6527 substr_m_n, and s_m_n take n characters from offset m; negative m take
6528 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6529 takes the rest, either to the right or to the left.
6530
6531 hash_n or h_n makes a hash of length n from the string, yielding n
6532 characters from the set a-z; hash_n_m makes a hash of length n, but
6533 uses m characters from the set a-zA-Z0-9.
6534
6535 nhash_n returns a single number between 0 and n-1 (in text form), while
6536 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6537 between 0 and n-1 and the second between 0 and m-1. */
6538
6539 case EOP_LENGTH:
6540 case EOP_L:
6541 case EOP_SUBSTR:
6542 case EOP_S:
6543 case EOP_HASH:
6544 case EOP_H:
6545 case EOP_NHASH:
6546 case EOP_NH:
6547 {
6548 int sign = 1;
6549 int value1 = 0;
6550 int value2 = -1;
6551 int *pn;
6552 int len;
6553 uschar *ret;
6554
6555 if (arg == NULL)
6556 {
6557 expand_string_message = string_sprintf("missing values after %s",
6558 name);
6559 goto EXPAND_FAILED;
6560 }
6561
6562 /* "length" has only one argument, effectively being synonymous with
6563 substr_0_n. */
6564
6565 if (c == EOP_LENGTH || c == EOP_L)
6566 {
6567 pn = &value2;
6568 value2 = 0;
6569 }
6570
6571 /* The others have one or two arguments; for "substr" the first may be
6572 negative. The second being negative means "not supplied". */
6573
6574 else
6575 {
6576 pn = &value1;
6577 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6578 }
6579
6580 /* Read up to two numbers, separated by underscores */
6581
6582 ret = arg;
6583 while (*arg != 0)
6584 {
6585 if (arg != ret && *arg == '_' && pn == &value1)
6586 {
6587 pn = &value2;
6588 value2 = 0;
6589 if (arg[1] != 0) arg++;
6590 }
6591 else if (!isdigit(*arg))
6592 {
6593 expand_string_message =
6594 string_sprintf("non-digit after underscore in \"%s\"", name);
6595 goto EXPAND_FAILED;
6596 }
6597 else *pn = (*pn)*10 + *arg++ - '0';
6598 }
6599 value1 *= sign;
6600
6601 /* Perform the required operation */
6602
6603 ret =
6604 (c == EOP_HASH || c == EOP_H)?
6605 compute_hash(sub, value1, value2, &len) :
6606 (c == EOP_NHASH || c == EOP_NH)?
6607 compute_nhash(sub, value1, value2, &len) :
6608 extract_substr(sub, value1, value2, &len);
6609
6610 if (ret == NULL) goto EXPAND_FAILED;
6611 yield = string_cat(yield, &size, &ptr, ret, len);
6612 continue;
6613 }
6614
6615 /* Stat a path */
6616
6617 case EOP_STAT:
6618 {
6619 uschar *s;
6620 uschar smode[12];
6621 uschar **modetable[3];
6622 int i;
6623 mode_t mode;
6624 struct stat st;
6625
254e032f
PH
6626 if ((expand_forbid & RDO_EXISTS) != 0)
6627 {
6628 expand_string_message = US"Use of the stat() expansion is not permitted";
6629 goto EXPAND_FAILED;
6630 }
6631
059ec3d9
PH
6632 if (stat(CS sub, &st) < 0)
6633 {
6634 expand_string_message = string_sprintf("stat(%s) failed: %s",
6635 sub, strerror(errno));
6636 goto EXPAND_FAILED;
6637 }
6638 mode = st.st_mode;
6639 switch (mode & S_IFMT)
6640 {
6641 case S_IFIFO: smode[0] = 'p'; break;
6642 case S_IFCHR: smode[0] = 'c'; break;
6643 case S_IFDIR: smode[0] = 'd'; break;
6644 case S_IFBLK: smode[0] = 'b'; break;
6645 case S_IFREG: smode[0] = '-'; break;
6646 default: smode[0] = '?'; break;
6647 }
6648
6649 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6650 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6651 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6652
6653 for (i = 0; i < 3; i++)
6654 {
6655 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6656 mode >>= 3;
6657 }
6658
6659 smode[10] = 0;
6660 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
b1c749bb 6661 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
059ec3d9
PH
6662 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6663 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
b1c749bb 6664 (long)st.st_gid, st.st_size, (long)st.st_atime,
059ec3d9
PH
6665 (long)st.st_mtime, (long)st.st_ctime);
6666 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6667 continue;
6668 }
6669
17c76198 6670 /* vaguely random number less than N */
9e3331ea
TK
6671
6672 case EOP_RANDINT:
6673 {
97d17305 6674 int_eximarith_t max;
9e3331ea
TK
6675 uschar *s;
6676
6677 max = expand_string_integer(sub, TRUE);
6678 if (expand_string_message != NULL)
6679 goto EXPAND_FAILED;
17c76198 6680 s = string_sprintf("%d", vaguely_random_number((int)max));
9e3331ea
TK
6681 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6682 continue;
6683 }
6684
83e029d5
PP
6685 /* Reverse IP, including IPv6 to dotted-nibble */
6686
6687 case EOP_REVERSE_IP:
6688 {
6689 int family, maskptr;
6690 uschar reversed[128];
6691
6692 family = string_is_ip_address(sub, &maskptr);
6693 if (family == 0)
6694 {
6695 expand_string_message = string_sprintf(
6696 "reverse_ip() not given an IP address [%s]", sub);
6697 goto EXPAND_FAILED;
6698 }
6699 invert_address(reversed, sub);
6700 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6701 continue;
6702 }
6703
059ec3d9
PH
6704 /* Unknown operator */
6705
6706 default:
6707 expand_string_message =
6708 string_sprintf("unknown expansion operator \"%s\"", name);
6709 goto EXPAND_FAILED;
6710 }
6711 }
6712
6713 /* Handle a plain name. If this is the first thing in the expansion, release
6714 the pre-allocated buffer. If the result data is known to be in a new buffer,
6715 newsize will be set to the size of that buffer, and we can just point at that
6716 store instead of copying. Many expansion strings contain just one reference,
6717 so this is a useful optimization, especially for humungous headers
6718 ($message_headers). */
2e23003a 6719 /*{*/
059ec3d9
PH
6720 if (*s++ == '}')
6721 {
6722 int len;
6723 int newsize = 0;
6724 if (ptr == 0)
6725 {
d6b4d938 6726 if (resetok) store_reset(yield);
059ec3d9
PH
6727 yield = NULL;
6728 size = 0;
6729 }
6730 value = find_variable(name, FALSE, skipping, &newsize);
6731 if (value == NULL)
6732 {
6733 expand_string_message =
6734 string_sprintf("unknown variable in \"${%s}\"", name);
641cb756 6735 check_variable_error_message(name);
059ec3d9
PH
6736 goto EXPAND_FAILED;
6737 }
6738 len = Ustrlen(value);
6739 if (yield == NULL && newsize != 0)
6740 {
6741 yield = value;
6742 size = newsize;
6743 ptr = len;
6744 }
6745 else yield = string_cat(yield, &size, &ptr, value, len);
6746 continue;
6747 }
6748
6749 /* Else there's something wrong */
6750
6751 expand_string_message =
6752 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6753 "in a variable reference)", name);
6754 goto EXPAND_FAILED;
6755 }
6756
6757/* If we hit the end of the string when ket_ends is set, there is a missing
6758terminating brace. */
6759
6760if (ket_ends && *s == 0)
6761 {
6762 expand_string_message = malformed_header?
6763 US"missing } at end of string - could be header name not terminated by colon"
6764 :
6765 US"missing } at end of string";
6766 goto EXPAND_FAILED;
6767 }
6768
6769/* Expansion succeeded; yield may still be NULL here if nothing was actually
6770added to the string. If so, set up an empty string. Add a terminating zero. If
6771left != NULL, return a pointer to the terminator. */
6772
6773if (yield == NULL) yield = store_get(1);
6774yield[ptr] = 0;
6775if (left != NULL) *left = s;
6776
6777/* Any stacking store that was used above the final string is no longer needed.
6778In many cases the final string will be the first one that was got and so there
6779will be optimal store usage. */
6780
d6b4d938 6781if (resetok) store_reset(yield + ptr + 1);
b0e85a8f
JH
6782else if (resetok_p) *resetok_p = FALSE;
6783
059ec3d9
PH
6784DEBUG(D_expand)
6785 {
6786 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6787 yield);
6788 if (skipping) debug_printf("skipping: result is not used\n");
6789 }
6790return yield;
6791
6792/* This is the failure exit: easiest to program with a goto. We still need
6793to update the pointer to the terminator, for cases of nested calls with "fail".
6794*/
6795
6796EXPAND_FAILED_CURLY:
6797expand_string_message = malformed_header?
6798 US"missing or misplaced { or } - could be header name not terminated by colon"
6799 :
6800 US"missing or misplaced { or }";
6801
6802/* At one point, Exim reset the store to yield (if yield was not NULL), but
6803that is a bad idea, because expand_string_message is in dynamic store. */
6804
6805EXPAND_FAILED:
6806if (left != NULL) *left = s;
6807DEBUG(D_expand)
6808 {
6809 debug_printf("failed to expand: %s\n", string);
6810 debug_printf(" error message: %s\n", expand_string_message);
6811 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6812 }
b0e85a8f 6813if (resetok_p) *resetok_p = resetok;
059ec3d9
PH
6814return NULL;
6815}
6816
6817
6818/* This is the external function call. Do a quick check for any expansion
6819metacharacters, and if there are none, just return the input string.
6820
6821Argument: the string to be expanded
6822Returns: the expanded string, or NULL if expansion failed; if failure was
6823 due to a lookup deferring, search_find_defer will be TRUE
6824*/
6825
6826uschar *
6827expand_string(uschar *string)
6828{
6829search_find_defer = FALSE;
6830malformed_header = FALSE;
6831return (Ustrpbrk(string, "$\\") == NULL)? string :
b0e85a8f 6832 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
059ec3d9
PH
6833}
6834
6835
6836
6837/*************************************************
6838* Expand and copy *
6839*************************************************/
6840
6841/* Now and again we want to expand a string and be sure that the result is in a
6842new bit of store. This function does that.
6843
6844Argument: the string to be expanded
6845Returns: the expanded string, always in a new bit of store, or NULL
6846*/
6847
6848uschar *
6849expand_string_copy(uschar *string)
6850{
6851uschar *yield = expand_string(string);
6852if (yield == string) yield = string_copy(string);
6853return yield;
6854}
6855
6856
6857
6858/*************************************************
6859* Expand and interpret as an integer *
6860*************************************************/
6861
6862/* Expand a string, and convert the result into an integer.
6863
d45b1de8
PH
6864Arguments:
6865 string the string to be expanded
6866 isplus TRUE if a non-negative number is expected
059ec3d9
PH
6867
6868Returns: the integer value, or
6869 -1 for an expansion error ) in both cases, message in
6870 -2 for an integer interpretation error ) expand_string_message
d45b1de8 6871 expand_string_message is set NULL for an OK integer
059ec3d9
PH
6872*/
6873
97d17305 6874int_eximarith_t
d45b1de8 6875expand_string_integer(uschar *string, BOOL isplus)
059ec3d9 6876{
97d17305 6877int_eximarith_t value;
059ec3d9
PH
6878uschar *s = expand_string(string);
6879uschar *msg = US"invalid integer \"%s\"";
6880uschar *endptr;
6881
d45b1de8
PH
6882/* If expansion failed, expand_string_message will be set. */
6883
059ec3d9
PH
6884if (s == NULL) return -1;
6885
6886/* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6887to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6888systems, so we set it zero ourselves. */
6889
6890errno = 0;
d45b1de8 6891expand_string_message = NULL; /* Indicates no error */
b52bc06e
NM
6892
6893/* Before Exim 4.64, strings consisting entirely of whitespace compared
6894equal to 0. Unfortunately, people actually relied upon that, so preserve
6895the behaviour explicitly. Stripping leading whitespace is a harmless
6896noop change since strtol skips it anyway (provided that there is a number
6897to find at all). */
6898if (isspace(*s))
6899 {
6900 while (isspace(*s)) ++s;
6901 if (*s == '\0')
6902 {
6903 DEBUG(D_expand)
6904 debug_printf("treating blank string as number 0\n");
6905 return 0;
6906 }
6907 }
6908
aa7c82b2 6909value = strtoll(CS s, CSS &endptr, 10);
059ec3d9
PH
6910
6911if (endptr == s)
6912 {
6913 msg = US"integer expected but \"%s\" found";
6914 }
d45b1de8
PH
6915else if (value < 0 && isplus)
6916 {
6917 msg = US"non-negative integer expected but \"%s\" found";
6918 }
059ec3d9
PH
6919else
6920 {
4eb9d6ef 6921 switch (tolower(*endptr))
059ec3d9 6922 {
4eb9d6ef
JH
6923 default:
6924 break;
6925 case 'k':
4328fd3c 6926 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
aa7c82b2 6927 else value *= 1024;
4eb9d6ef
JH
6928 endptr++;
6929 break;
6930 case 'm':
4328fd3c 6931 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
4eb9d6ef
JH
6932 else value *= 1024*1024;
6933 endptr++;
6934 break;
6935 case 'g':
4328fd3c 6936 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
4eb9d6ef
JH
6937 else value *= 1024*1024*1024;
6938 endptr++;
6939 break;
059ec3d9
PH
6940 }
6941 if (errno == ERANGE)
6942 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6943 else
6944 {
6945 while (isspace(*endptr)) endptr++;
725735cd 6946 if (*endptr == 0) return value;
059ec3d9
PH
6947 }
6948 }
6949
6950expand_string_message = string_sprintf(CS msg, s);
6951return -2;
6952}
6953
059ec3d9
PH
6954
6955/*************************************************
6956**************************************************
6957* Stand-alone test program *
6958**************************************************
6959*************************************************/
6960
6961#ifdef STAND_ALONE
6962
6963
6964BOOL
6965regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6966{
6967int ovector[3*(EXPAND_MAXN+1)];
6968int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6969 ovector, sizeof(ovector)/sizeof(int));
6970BOOL yield = n >= 0;
6971if (n == 0) n = EXPAND_MAXN + 1;
6972if (yield)
6973 {
6974 int nn;
6975 expand_nmax = (setup < 0)? 0 : setup + 1;
6976 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6977 {
6978 expand_nstring[expand_nmax] = subject + ovector[nn];
6979 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6980 }
6981 expand_nmax--;
6982 }
6983return yield;
6984}
6985
6986
6987int main(int argc, uschar **argv)
6988{
6989int i;
6990uschar buffer[1024];
6991
6992debug_selector = D_v;
6993debug_file = stderr;
6994debug_fd = fileno(debug_file);
6995big_buffer = malloc(big_buffer_size);
6996
6997for (i = 1; i < argc; i++)
6998 {
6999 if (argv[i][0] == '+')
7000 {
7001 debug_trace_memory = 2;
7002 argv[i]++;
7003 }
7004 if (isdigit(argv[i][0]))
7005 debug_selector = Ustrtol(argv[i], NULL, 0);
7006 else
7007 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7008 Ustrlen(argv[i]))
7009 {
7010 #ifdef LOOKUP_LDAP
7011 eldap_default_servers = argv[i];
7012 #endif
7013 #ifdef LOOKUP_MYSQL
7014 mysql_servers = argv[i];
7015 #endif
7016 #ifdef LOOKUP_PGSQL
7017 pgsql_servers = argv[i];
7018 #endif
9bdd29ad
TL
7019 #ifdef EXPERIMENTAL_REDIS
7020 redis_servers = argv[i];
7021 #endif
059ec3d9
PH
7022 }
7023 #ifdef EXIM_PERL
7024 else opt_perl_startup = argv[i];
7025 #endif
7026 }
7027
7028printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7029
7030expand_nstring[1] = US"string 1....";
7031expand_nlength[1] = 8;
7032expand_nmax = 1;
7033
7034#ifdef EXIM_PERL
7035if (opt_perl_startup != NULL)
7036 {
7037 uschar *errstr;
7038 printf("Starting Perl interpreter\n");
7039 errstr = init_perl(opt_perl_startup);
7040 if (errstr != NULL)
7041 {
7042 printf("** error in perl_startup code: %s\n", errstr);
7043 return EXIT_FAILURE;
7044 }
7045 }
7046#endif /* EXIM_PERL */
7047
7048while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7049 {
7050 void *reset_point = store_get(0);
7051 uschar *yield = expand_string(buffer);
7052 if (yield != NULL)
7053 {
7054 printf("%s\n", yield);
7055 store_reset(reset_point);
7056 }
7057 else
7058 {
7059 if (search_find_defer) printf("search_find deferred\n");
7060 printf("Failed: %s\n", expand_string_message);
7061 if (expand_string_forcedfail) printf("Forced failure\n");
7062 printf("\n");
7063 }
7064 }
7065
7066search_tidyup();
7067
7068return 0;
7069}
7070
7071#endif
7072
9e4dddbd 7073/* vi: aw ai sw=2
b9c2e32f 7074*/
059ec3d9 7075/* End of expand.c */