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