Commit | Line | Data |
---|---|---|
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 |
16 | static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *); |
17 | static int_eximarith_t expanded_string_integer(const uschar *, BOOL); | |
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 | 34 | extern 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 |
39 | mess that was sent to me. We decided, however, to make changing this very low | |
40 | priority, because in practice people are moving away from the crypt() | |
41 | algorithms nowadays, so it doesn't seem worth it. | |
42 | ||
43 | <quote> | |
44 | There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts | |
45 | the first 8 characters of the password using a 20-round version of crypt | |
46 | (standard crypt does 25 rounds). It then crypts the next 8 characters, | |
47 | or an empty block if the password is less than 9 characters, using a | |
48 | 20-round version of crypt and the same salt as was used for the first | |
4c04137d | 49 | block. Characters after the first 16 are ignored. It always generates |
96c065cb PH |
50 | a 16-byte hash, which is expressed together with the salt as a string |
51 | of 24 base 64 digits. Here are some links to peruse: | |
52 | ||
53 | http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2 | |
54 | http://seclists.org/bugtraq/1999/Mar/0076.html | |
55 | ||
56 | There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix, | |
57 | and OSF/1. This is the same as the standard crypt if given a password | |
58 | of 8 characters or less. If given more, it first does the same as crypt | |
59 | using the first 8 characters, then crypts the next 8 (the 9th to 16th) | |
60 | using as salt the first two base 64 digits from the first hash block. | |
61 | If the password is more than 16 characters then it crypts the 17th to 24th | |
62 | characters using as salt the first two base 64 digits from the second hash | |
63 | block. And so on: I've seen references to it cutting off the password at | |
64 | 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links: | |
65 | ||
66 | http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2 | |
67 | http://seclists.org/bugtraq/1999/Mar/0109.html | |
68 | http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D- | |
69 | TET1_html/sec.c222.html#no_id_208 | |
70 | ||
71 | Exim has something it calls "crypt16". It will either use a native | |
72 | crypt16 or its own implementation. A native crypt16 will presumably | |
73 | be the one that I called "crypt16" above. The internal "crypt16" | |
74 | function, however, is a two-block-maximum implementation of what I called | |
75 | "bigcrypt". The documentation matches the internal code. | |
76 | ||
77 | I suspect that whoever did the "crypt16" stuff for Exim didn't realise | |
78 | that crypt16 and bigcrypt were different things. | |
79 | ||
80 | Exim uses the LDAP-style scheme identifier "{crypt16}" to refer | |
81 | to whatever it is using under that name. This unfortunately sets a | |
82 | precedent for using "{crypt16}" to identify two incompatible algorithms | |
83 | whose output can't be distinguished. With "{crypt16}" thus rendered | |
84 | ambiguous, I suggest you deprecate it and invent two new identifiers | |
85 | for the two algorithms. | |
86 | ||
87 | Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts | |
88 | of the password separately means they can be cracked separately, so | |
89 | the double-length hash only doubles the cracking effort instead of | |
90 | squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based | |
91 | bcrypt ({CRYPT}$2a$). | |
92 | </quote> | |
93 | */ | |
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 | |
102 | alphabetical order. */ | |
103 | ||
104 | static 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 | ||
135 | enum { | |
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 | |
167 | in alphabetical order. There are two tables, because underscore is used in some | |
168 | cases to introduce arguments, whereas for other it is part of the name. This is | |
169 | an historical mis-design. */ | |
170 | ||
171 | static uschar *op_table_underscore[] = { | |
172 | US"from_utf8", | |
173 | US"local_part", | |
174 | US"quote_local_part", | |
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 | |
186 | enum { | |
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 | |
201 | static 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 | |
247 | enum { | |
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 | |
295 | be in alphabetical order. */ | |
296 | ||
297 | static uschar *cond_table[] = { | |
298 | US"<", | |
299 | US"<=", | |
300 | US"=", | |
301 | US"==", /* Backward compatibility */ | |
302 | US">", | |
303 | US">=", | |
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 | ||
343 | enum { | |
344 | ECOND_NUM_L, | |
345 | ECOND_NUM_LE, | |
346 | ECOND_NUM_E, | |
347 | ECOND_NUM_EE, | |
348 | ECOND_NUM_G, | |
349 | ECOND_NUM_GE, | |
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 | 392 | enum 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 | ||
429 | typedef struct { | |
430 | const char *name; | |
431 | enum vtypes type; | |
432 | void *value; | |
433 | } var_entry; | |
434 | ||
435 | /* Type for entries pointing to address/length pairs. Not currently | |
436 | in use. */ | |
437 | ||
438 | typedef struct { | |
439 | uschar **address; | |
440 | int *length; | |
441 | } alblock; | |
059ec3d9 | 442 | |
362145b5 JH |
443 | static uschar * fn_recipients(void); |
444 | ||
059ec3d9 PH |
445 | /* This table must be kept in alphabetical order. */ |
446 | ||
447 | static 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 }, | |
4840604e TL |
521 | #endif |
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 }, | |
8523533c | 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, ®ex_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 | 790 | static int var_table_size = nelem(var_table); |
059ec3d9 PH |
791 | static uschar var_buffer[256]; |
792 | static BOOL malformed_header; | |
793 | ||
794 | /* For textual hashes */ | |
795 | ||
1ba28e2b PP |
796 | static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz" |
797 | "ABCDEFGHIJKLMNOPQRSTUVWXYZ" | |
798 | "0123456789"; | |
059ec3d9 PH |
799 | |
800 | enum { HMAC_MD5, HMAC_SHA1 }; | |
801 | ||
802 | /* For numeric hashes */ | |
803 | ||
804 | static unsigned int prime[] = { | |
805 | 2, 3, 5, 7, 11, 13, 17, 19, 23, 29, | |
806 | 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, | |
807 | 73, 79, 83, 89, 97, 101, 103, 107, 109, 113}; | |
808 | ||
809 | /* For printing modes in symbolic form */ | |
810 | ||
811 | static uschar *mtable_normal[] = | |
812 | { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" }; | |
813 | ||
814 | static uschar *mtable_setid[] = | |
815 | { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" }; | |
816 | ||
817 | static uschar *mtable_sticky[] = | |
818 | { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" }; | |
819 | ||
bce15b62 JH |
820 | /* flags for find_header() */ |
821 | #define FH_EXISTS_ONLY BIT(0) | |
822 | #define FH_WANT_RAW BIT(1) | |
823 | #define FH_WANT_LIST BIT(2) | |
059ec3d9 PH |
824 | |
825 | ||
826 | /************************************************* | |
827 | * Tables for UTF-8 support * | |
828 | *************************************************/ | |
829 | ||
830 | /* Table of the number of extra characters, indexed by the first character | |
831 | masked with 0x3f. The highest number for a valid UTF-8 character is in fact | |
832 | 0x3d. */ | |
833 | ||
834 | static uschar utf8_table1[] = { | |
835 | 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, | |
836 | 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, | |
837 | 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, | |
838 | 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 }; | |
839 | ||
840 | /* These are the masks for the data bits in the first byte of a character, | |
841 | indexed by the number of additional bytes. */ | |
842 | ||
843 | static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01}; | |
844 | ||
845 | /* Get the next UTF-8 character, advancing the pointer. */ | |
846 | ||
847 | #define GETUTF8INC(c, ptr) \ | |
848 | c = *ptr++; \ | |
849 | if ((c & 0xc0) == 0xc0) \ | |
850 | { \ | |
851 | int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \ | |
852 | int s = 6*a; \ | |
853 | c = (c & utf8_table2[a]) << s; \ | |
854 | while (a-- > 0) \ | |
855 | { \ | |
856 | s -= 6; \ | |
857 | c |= (*ptr++ & 0x3f) << s; \ | |
858 | } \ | |
859 | } | |
860 | ||
861 | ||
03ca21f8 JH |
862 | |
863 | static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567"; | |
864 | ||
059ec3d9 PH |
865 | /************************************************* |
866 | * Binary chop search on a table * | |
867 | *************************************************/ | |
868 | ||
869 | /* This is used for matching expansion items and operators. | |
870 | ||
871 | Arguments: | |
872 | name the name that is being sought | |
873 | table the table to search | |
874 | table_size the number of items in the table | |
875 | ||
876 | Returns: the offset in the table, or -1 | |
877 | */ | |
878 | ||
879 | static int | |
880 | chop_match(uschar *name, uschar **table, int table_size) | |
881 | { | |
882 | uschar **bot = table; | |
883 | uschar **top = table + table_size; | |
884 | ||
885 | while (top > bot) | |
886 | { | |
887 | uschar **mid = bot + (top - bot)/2; | |
888 | int c = Ustrcmp(name, *mid); | |
889 | if (c == 0) return mid - table; | |
890 | if (c > 0) bot = mid + 1; else top = mid; | |
891 | } | |
892 | ||
893 | return -1; | |
894 | } | |
895 | ||
896 | ||
897 | ||
898 | /************************************************* | |
899 | * Check a condition string * | |
900 | *************************************************/ | |
901 | ||
902 | /* This function is called to expand a string, and test the result for a "true" | |
903 | or "false" value. Failure of the expansion yields FALSE; logged unless it was a | |
be7a5781 JH |
904 | forced fail or lookup defer. |
905 | ||
906 | We used to release all store used, but this is not not safe due | |
907 | to ${dlfunc } and ${acl }. In any case expand_string_internal() | |
908 | is reasonably careful to release what it can. | |
059ec3d9 | 909 | |
6a8de854 PP |
910 | The actual false-value tests should be replicated for ECOND_BOOL_LAX. |
911 | ||
059ec3d9 PH |
912 | Arguments: |
913 | condition the condition string | |
914 | m1 text to be incorporated in panic error | |
915 | m2 ditto | |
916 | ||
917 | Returns: TRUE if condition is met, FALSE if not | |
918 | */ | |
919 | ||
920 | BOOL | |
921 | expand_check_condition(uschar *condition, uschar *m1, uschar *m2) | |
922 | { | |
923 | int rc; | |
059ec3d9 PH |
924 | uschar *ss = expand_string(condition); |
925 | if (ss == NULL) | |
926 | { | |
927 | if (!expand_string_forcedfail && !search_find_defer) | |
928 | log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" " | |
929 | "for %s %s: %s", condition, m1, m2, expand_string_message); | |
930 | return FALSE; | |
931 | } | |
932 | rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 && | |
933 | strcmpic(ss, US"false") != 0; | |
059ec3d9 PH |
934 | return rc; |
935 | } | |
936 | ||
937 | ||
938 | ||
17c76198 | 939 | |
9e3331ea TK |
940 | /************************************************* |
941 | * Pseudo-random number generation * | |
942 | *************************************************/ | |
943 | ||
944 | /* Pseudo-random number generation. The result is not "expected" to be | |
945 | cryptographically strong but not so weak that someone will shoot themselves | |
946 | in the foot using it as a nonce in some email header scheme or whatever | |
947 | weirdness they'll twist this into. The result should ideally handle fork(). | |
948 | ||
949 | However, if we're stuck unable to provide this, then we'll fall back to | |
950 | appallingly bad randomness. | |
951 | ||
17c76198 PP |
952 | If SUPPORT_TLS is defined then this will not be used except as an emergency |
953 | fallback. | |
9e3331ea TK |
954 | |
955 | Arguments: | |
956 | max range maximum | |
957 | Returns a random number in range [0, max-1] | |
958 | */ | |
959 | ||
17c76198 PP |
960 | #ifdef SUPPORT_TLS |
961 | # define vaguely_random_number vaguely_random_number_fallback | |
962 | #endif | |
9e3331ea | 963 | int |
17c76198 | 964 | vaguely_random_number(int max) |
9e3331ea | 965 | { |
17c76198 PP |
966 | #ifdef SUPPORT_TLS |
967 | # undef vaguely_random_number | |
968 | #endif | |
9e3331ea TK |
969 | static pid_t pid = 0; |
970 | pid_t p2; | |
971 | #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV) | |
972 | struct timeval tv; | |
973 | #endif | |
974 | ||
975 | p2 = getpid(); | |
976 | if (p2 != pid) | |
977 | { | |
978 | if (pid != 0) | |
979 | { | |
980 | ||
981 | #ifdef HAVE_ARC4RANDOM | |
982 | /* cryptographically strong randomness, common on *BSD platforms, not | |
983 | so much elsewhere. Alas. */ | |
46ca7017 | 984 | #ifndef NOT_HAVE_ARC4RANDOM_STIR |
9e3331ea | 985 | arc4random_stir(); |
46ca7017 | 986 | #endif |
9e3331ea TK |
987 | #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV) |
988 | #ifdef HAVE_SRANDOMDEV | |
989 | /* uses random(4) for seeding */ | |
990 | srandomdev(); | |
991 | #else | |
992 | gettimeofday(&tv, NULL); | |
993 | srandom(tv.tv_sec | tv.tv_usec | getpid()); | |
994 | #endif | |
995 | #else | |
996 | /* Poor randomness and no seeding here */ | |
997 | #endif | |
998 | ||
999 | } | |
1000 | pid = p2; | |
1001 | } | |
1002 | ||
1003 | #ifdef HAVE_ARC4RANDOM | |
1004 | return arc4random() % max; | |
1005 | #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV) | |
1006 | return random() % max; | |
1007 | #else | |
1008 | /* This one returns a 16-bit number, definitely not crypto-strong */ | |
1009 | return random_number(max); | |
1010 | #endif | |
1011 | } | |
1012 | ||
17c76198 PP |
1013 | |
1014 | ||
9e3331ea | 1015 | |
059ec3d9 PH |
1016 | /************************************************* |
1017 | * Pick out a name from a string * | |
1018 | *************************************************/ | |
1019 | ||
1020 | /* If the name is too long, it is silently truncated. | |
1021 | ||
1022 | Arguments: | |
1023 | name points to a buffer into which to put the name | |
1024 | max is the length of the buffer | |
1025 | s points to the first alphabetic character of the name | |
1026 | extras chars other than alphanumerics to permit | |
1027 | ||
1028 | Returns: pointer to the first character after the name | |
1029 | ||
1030 | Note: The test for *s != 0 in the while loop is necessary because | |
1031 | Ustrchr() yields non-NULL if the character is zero (which is not something | |
1032 | I expected). */ | |
1033 | ||
55414b25 JH |
1034 | static const uschar * |
1035 | read_name(uschar *name, int max, const uschar *s, uschar *extras) | |
059ec3d9 PH |
1036 | { |
1037 | int ptr = 0; | |
1038 | while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL)) | |
1039 | { | |
1040 | if (ptr < max-1) name[ptr++] = *s; | |
1041 | s++; | |
1042 | } | |
1043 | name[ptr] = 0; | |
1044 | return s; | |
1045 | } | |
1046 | ||
1047 | ||
1048 | ||
1049 | /************************************************* | |
1050 | * Pick out the rest of a header name * | |
1051 | *************************************************/ | |
1052 | ||
1053 | /* A variable name starting $header_ (or just $h_ for those who like | |
1054 | abbreviations) might not be the complete header name because headers can | |
1055 | contain any printing characters in their names, except ':'. This function is | |
1056 | called to read the rest of the name, chop h[eader]_ off the front, and put ':' | |
1057 | on the end, if the name was terminated by white space. | |
1058 | ||
1059 | Arguments: | |
1060 | name points to a buffer in which the name read so far exists | |
1061 | max is the length of the buffer | |
1062 | s points to the first character after the name so far, i.e. the | |
1063 | first non-alphameric character after $header_xxxxx | |
1064 | ||
1065 | Returns: a pointer to the first character after the header name | |
1066 | */ | |
1067 | ||
55414b25 JH |
1068 | static const uschar * |
1069 | read_header_name(uschar *name, int max, const uschar *s) | |
059ec3d9 PH |
1070 | { |
1071 | int prelen = Ustrchr(name, '_') - name + 1; | |
1072 | int ptr = Ustrlen(name) - prelen; | |
1073 | if (ptr > 0) memmove(name, name+prelen, ptr); | |
1074 | while (mac_isgraph(*s) && *s != ':') | |
1075 | { | |
1076 | if (ptr < max-1) name[ptr++] = *s; | |
1077 | s++; | |
1078 | } | |
1079 | if (*s == ':') s++; | |
1080 | name[ptr++] = ':'; | |
1081 | name[ptr] = 0; | |
1082 | return s; | |
1083 | } | |
1084 | ||
1085 | ||
1086 | ||
1087 | /************************************************* | |
1088 | * Pick out a number from a string * | |
1089 | *************************************************/ | |
1090 | ||
1091 | /* Arguments: | |
1092 | n points to an integer into which to put the number | |
1093 | s points to the first digit of the number | |
1094 | ||
1095 | Returns: a pointer to the character after the last digit | |
1096 | */ | |
13559da6 JH |
1097 | /*XXX consider expanding to int_eximarith_t. But the test for |
1098 | "overbig numbers" in 0002 still needs to overflow it. */ | |
059ec3d9 PH |
1099 | |
1100 | static uschar * | |
1101 | read_number(int *n, uschar *s) | |
1102 | { | |
1103 | *n = 0; | |
1104 | while (isdigit(*s)) *n = *n * 10 + (*s++ - '0'); | |
1105 | return s; | |
1106 | } | |
1107 | ||
55414b25 JH |
1108 | static const uschar * |
1109 | read_cnumber(int *n, const uschar *s) | |
1110 | { | |
1111 | *n = 0; | |
1112 | while (isdigit(*s)) *n = *n * 10 + (*s++ - '0'); | |
1113 | return s; | |
1114 | } | |
1115 | ||
059ec3d9 PH |
1116 | |
1117 | ||
1118 | /************************************************* | |
1119 | * Extract keyed subfield from a string * | |
1120 | *************************************************/ | |
1121 | ||
1122 | /* The yield is in dynamic store; NULL means that the key was not found. | |
1123 | ||
1124 | Arguments: | |
1125 | key points to the name of the key | |
1126 | s points to the string from which to extract the subfield | |
1127 | ||
1128 | Returns: NULL if the subfield was not found, or | |
1129 | a pointer to the subfield's data | |
1130 | */ | |
1131 | ||
1132 | static uschar * | |
55414b25 | 1133 | expand_getkeyed(uschar *key, const uschar *s) |
059ec3d9 PH |
1134 | { |
1135 | int length = Ustrlen(key); | |
1136 | while (isspace(*s)) s++; | |
1137 | ||
1138 | /* Loop to search for the key */ | |
1139 | ||
1140 | while (*s != 0) | |
1141 | { | |
1142 | int dkeylength; | |
1143 | uschar *data; | |
55414b25 | 1144 | const uschar *dkey = s; |
059ec3d9 PH |
1145 | |
1146 | while (*s != 0 && *s != '=' && !isspace(*s)) s++; | |
1147 | dkeylength = s - dkey; | |
1148 | while (isspace(*s)) s++; | |
1149 | if (*s == '=') while (isspace((*(++s)))); | |
1150 | ||
1151 | data = string_dequote(&s); | |
1152 | if (length == dkeylength && strncmpic(key, dkey, length) == 0) | |
1153 | return data; | |
1154 | ||
1155 | while (isspace(*s)) s++; | |
1156 | } | |
1157 | ||
1158 | return NULL; | |
1159 | } | |
1160 | ||
1161 | ||
1162 | ||
9d1c15ef JH |
1163 | static var_entry * |
1164 | find_var_ent(uschar * name) | |
1165 | { | |
1166 | int first = 0; | |
1167 | int last = var_table_size; | |
1168 | ||
1169 | while (last > first) | |
1170 | { | |
1171 | int middle = (first + last)/2; | |
1172 | int c = Ustrcmp(name, var_table[middle].name); | |
1173 | ||
1174 | if (c > 0) { first = middle + 1; continue; } | |
1175 | if (c < 0) { last = middle; continue; } | |
1176 | return &var_table[middle]; | |
1177 | } | |
1178 | return NULL; | |
1179 | } | |
059ec3d9 PH |
1180 | |
1181 | /************************************************* | |
1182 | * Extract numbered subfield from string * | |
1183 | *************************************************/ | |
1184 | ||
1185 | /* Extracts a numbered field from a string that is divided by tokens - for | |
1186 | example a line from /etc/passwd is divided by colon characters. First field is | |
1187 | numbered one. Negative arguments count from the right. Zero returns the whole | |
1188 | string. Returns NULL if there are insufficient tokens in the string | |
1189 | ||
1190 | ***WARNING*** | |
1191 | Modifies final argument - this is a dynamically generated string, so that's OK. | |
1192 | ||
1193 | Arguments: | |
1194 | field number of field to be extracted, | |
1195 | first field = 1, whole string = 0, last field = -1 | |
1196 | separators characters that are used to break string into tokens | |
1197 | s points to the string from which to extract the subfield | |
1198 | ||
1199 | Returns: NULL if the field was not found, | |
1200 | a pointer to the field's data inside s (modified to add 0) | |
1201 | */ | |
1202 | ||
1203 | static uschar * | |
1204 | expand_gettokened (int field, uschar *separators, uschar *s) | |
1205 | { | |
1206 | int sep = 1; | |
1207 | int count; | |
1208 | uschar *ss = s; | |
1209 | uschar *fieldtext = NULL; | |
1210 | ||
1211 | if (field == 0) return s; | |
1212 | ||
1213 | /* Break the line up into fields in place; for field > 0 we stop when we have | |
1214 | done the number of fields we want. For field < 0 we continue till the end of | |
1215 | the string, counting the number of fields. */ | |
1216 | ||
1217 | count = (field > 0)? field : INT_MAX; | |
1218 | ||
1219 | while (count-- > 0) | |
1220 | { | |
1221 | size_t len; | |
1222 | ||
1223 | /* Previous field was the last one in the string. For a positive field | |
1224 | number, this means there are not enough fields. For a negative field number, | |
1225 | check that there are enough, and scan back to find the one that is wanted. */ | |
1226 | ||
1227 | if (sep == 0) | |
1228 | { | |
1229 | if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL; | |
1230 | if ((-field) == (INT_MAX - count - 1)) return s; | |
1231 | while (field++ < 0) | |
1232 | { | |
1233 | ss--; | |
1234 | while (ss[-1] != 0) ss--; | |
1235 | } | |
1236 | fieldtext = ss; | |
1237 | break; | |
1238 | } | |
1239 | ||
1240 | /* Previous field was not last in the string; save its start and put a | |
1241 | zero at its end. */ | |
1242 | ||
1243 | fieldtext = ss; | |
1244 | len = Ustrcspn(ss, separators); | |
1245 | sep = ss[len]; | |
1246 | ss[len] = 0; | |
1247 | ss += len + 1; | |
1248 | } | |
1249 | ||
1250 | return fieldtext; | |
1251 | } | |
1252 | ||
1253 | ||
aa26e137 | 1254 | static uschar * |
55414b25 | 1255 | expand_getlistele(int field, const uschar * list) |
aa26e137 | 1256 | { |
55414b25 | 1257 | const uschar * tlist= list; |
aa26e137 JH |
1258 | int sep= 0; |
1259 | uschar dummy; | |
1260 | ||
1261 | if(field<0) | |
0f0c8159 | 1262 | { |
aa26e137 JH |
1263 | for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++; |
1264 | sep= 0; | |
0f0c8159 | 1265 | } |
aa26e137 JH |
1266 | if(field==0) return NULL; |
1267 | while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ; | |
1268 | return string_nextinlist(&list, &sep, NULL, 0); | |
1269 | } | |
059ec3d9 | 1270 | |
9d1c15ef JH |
1271 | |
1272 | /* Certificate fields, by name. Worry about by-OID later */ | |
9e4dddbd | 1273 | /* Names are chosen to not have common prefixes */ |
9d1c15ef JH |
1274 | |
1275 | #ifdef SUPPORT_TLS | |
1276 | typedef struct | |
1277 | { | |
1278 | uschar * name; | |
9e4dddbd JH |
1279 | int namelen; |
1280 | uschar * (*getfn)(void * cert, uschar * mod); | |
9d1c15ef JH |
1281 | } certfield; |
1282 | static certfield certfields[] = | |
1283 | { /* linear search; no special order */ | |
9e4dddbd JH |
1284 | { US"version", 7, &tls_cert_version }, |
1285 | { US"serial_number", 13, &tls_cert_serial_number }, | |
1286 | { US"subject", 7, &tls_cert_subject }, | |
1287 | { US"notbefore", 9, &tls_cert_not_before }, | |
1288 | { US"notafter", 8, &tls_cert_not_after }, | |
1289 | { US"issuer", 6, &tls_cert_issuer }, | |
1290 | { US"signature", 9, &tls_cert_signature }, | |
1291 | { US"sig_algorithm", 13, &tls_cert_signature_algorithm }, | |
1292 | { US"subj_altname", 12, &tls_cert_subject_altname }, | |
1293 | { US"ocsp_uri", 8, &tls_cert_ocsp_uri }, | |
1294 | { US"crl_uri", 7, &tls_cert_crl_uri }, | |
9d1c15ef JH |
1295 | }; |
1296 | ||
1297 | static uschar * | |
1298 | expand_getcertele(uschar * field, uschar * certvar) | |
1299 | { | |
1300 | var_entry * vp; | |
1301 | certfield * cp; | |
1302 | ||
1303 | if (!(vp = find_var_ent(certvar))) | |
1304 | { | |
94431adb | 1305 | expand_string_message = |
9d1c15ef JH |
1306 | string_sprintf("no variable named \"%s\"", certvar); |
1307 | return NULL; /* Unknown variable name */ | |
1308 | } | |
1309 | /* NB this stops us passing certs around in variable. Might | |
1310 | want to do that in future */ | |
1311 | if (vp->type != vtype_cert) | |
1312 | { | |
94431adb | 1313 | expand_string_message = |
9d1c15ef JH |
1314 | string_sprintf("\"%s\" is not a certificate", certvar); |
1315 | return NULL; /* Unknown variable name */ | |
1316 | } | |
1317 | if (!*(void **)vp->value) | |
1318 | return NULL; | |
1319 | ||
1320 | if (*field >= '0' && *field <= '9') | |
1321 | return tls_cert_ext_by_oid(*(void **)vp->value, field, 0); | |
1322 | ||
1323 | for(cp = certfields; | |
0539a19d | 1324 | cp < certfields + nelem(certfields); |
9d1c15ef | 1325 | cp++) |
9e4dddbd JH |
1326 | if (Ustrncmp(cp->name, field, cp->namelen) == 0) |
1327 | { | |
1328 | uschar * modifier = *(field += cp->namelen) == ',' | |
1329 | ? ++field : NULL; | |
1330 | return (*cp->getfn)( *(void **)vp->value, modifier ); | |
1331 | } | |
9d1c15ef | 1332 | |
94431adb | 1333 | expand_string_message = |
9d1c15ef JH |
1334 | string_sprintf("bad field selector \"%s\" for certextract", field); |
1335 | return NULL; | |
1336 | } | |
1337 | #endif /*SUPPORT_TLS*/ | |
1338 | ||
059ec3d9 PH |
1339 | /************************************************* |
1340 | * Extract a substring from a string * | |
1341 | *************************************************/ | |
1342 | ||
1343 | /* Perform the ${substr or ${length expansion operations. | |
1344 | ||
1345 | Arguments: | |
1346 | subject the input string | |
1347 | value1 the offset from the start of the input string to the start of | |
1348 | the output string; if negative, count from the right. | |
1349 | value2 the length of the output string, or negative (-1) for unset | |
1350 | if value1 is positive, unset means "all after" | |
1351 | if value1 is negative, unset means "all before" | |
1352 | len set to the length of the returned string | |
1353 | ||
1354 | Returns: pointer to the output string, or NULL if there is an error | |
1355 | */ | |
1356 | ||
1357 | static uschar * | |
1358 | extract_substr(uschar *subject, int value1, int value2, int *len) | |
1359 | { | |
1360 | int sublen = Ustrlen(subject); | |
1361 | ||
1362 | if (value1 < 0) /* count from right */ | |
1363 | { | |
1364 | value1 += sublen; | |
1365 | ||
1366 | /* If the position is before the start, skip to the start, and adjust the | |
1367 | length. If the length ends up negative, the substring is null because nothing | |
1368 | can precede. This falls out naturally when the length is unset, meaning "all | |
1369 | to the left". */ | |
1370 | ||
1371 | if (value1 < 0) | |
1372 | { | |
1373 | value2 += value1; | |
1374 | if (value2 < 0) value2 = 0; | |
1375 | value1 = 0; | |
1376 | } | |
1377 | ||
1378 | /* Otherwise an unset length => characters before value1 */ | |
1379 | ||
1380 | else if (value2 < 0) | |
1381 | { | |
1382 | value2 = value1; | |
1383 | value1 = 0; | |
1384 | } | |
1385 | } | |
1386 | ||
1387 | /* For a non-negative offset, if the starting position is past the end of the | |
1388 | string, the result will be the null string. Otherwise, an unset length means | |
1389 | "rest"; just set it to the maximum - it will be cut down below if necessary. */ | |
1390 | ||
1391 | else | |
1392 | { | |
1393 | if (value1 > sublen) | |
1394 | { | |
1395 | value1 = sublen; | |
1396 | value2 = 0; | |
1397 | } | |
1398 | else if (value2 < 0) value2 = sublen; | |
1399 | } | |
1400 | ||
1401 | /* Cut the length down to the maximum possible for the offset value, and get | |
1402 | the required characters. */ | |
1403 | ||
1404 | if (value1 + value2 > sublen) value2 = sublen - value1; | |
1405 | *len = value2; | |
1406 | return subject + value1; | |
1407 | } | |
1408 | ||
1409 | ||
1410 | ||
1411 | ||
1412 | /************************************************* | |
1413 | * Old-style hash of a string * | |
1414 | *************************************************/ | |
1415 | ||
1416 | /* Perform the ${hash expansion operation. | |
1417 | ||
1418 | Arguments: | |
1419 | subject the input string (an expanded substring) | |
1420 | value1 the length of the output string; if greater or equal to the | |
1421 | length of the input string, the input string is returned | |
1422 | value2 the number of hash characters to use, or 26 if negative | |
1423 | len set to the length of the returned string | |
1424 | ||
1425 | Returns: pointer to the output string, or NULL if there is an error | |
1426 | */ | |
1427 | ||
1428 | static uschar * | |
1429 | compute_hash(uschar *subject, int value1, int value2, int *len) | |
1430 | { | |
1431 | int sublen = Ustrlen(subject); | |
1432 | ||
1433 | if (value2 < 0) value2 = 26; | |
1434 | else if (value2 > Ustrlen(hashcodes)) | |
1435 | { | |
1436 | expand_string_message = | |
1437 | string_sprintf("hash count \"%d\" too big", value2); | |
1438 | return NULL; | |
1439 | } | |
1440 | ||
1441 | /* Calculate the hash text. We know it is shorter than the original string, so | |
1442 | can safely place it in subject[] (we know that subject is always itself an | |
1443 | expanded substring). */ | |
1444 | ||
1445 | if (value1 < sublen) | |
1446 | { | |
1447 | int c; | |
1448 | int i = 0; | |
1449 | int j = value1; | |
1450 | while ((c = (subject[j])) != 0) | |
1451 | { | |
1452 | int shift = (c + j++) & 7; | |
1453 | subject[i] ^= (c << shift) | (c >> (8-shift)); | |
1454 | if (++i >= value1) i = 0; | |
1455 | } | |
1456 | for (i = 0; i < value1; i++) | |
1457 | subject[i] = hashcodes[(subject[i]) % value2]; | |
1458 | } | |
1459 | else value1 = sublen; | |
1460 | ||
1461 | *len = value1; | |
1462 | return subject; | |
1463 | } | |
1464 | ||
1465 | ||
1466 | ||
1467 | ||
1468 | /************************************************* | |
1469 | * Numeric hash of a string * | |
1470 | *************************************************/ | |
1471 | ||
1472 | /* Perform the ${nhash expansion operation. The first characters of the | |
1473 | string are treated as most important, and get the highest prime numbers. | |
1474 | ||
1475 | Arguments: | |
1476 | subject the input string | |
1477 | value1 the maximum value of the first part of the result | |
1478 | value2 the maximum value of the second part of the result, | |
1479 | or negative to produce only a one-part result | |
1480 | len set to the length of the returned string | |
1481 | ||
1482 | Returns: pointer to the output string, or NULL if there is an error. | |
1483 | */ | |
1484 | ||
1485 | static uschar * | |
1486 | compute_nhash (uschar *subject, int value1, int value2, int *len) | |
1487 | { | |
1488 | uschar *s = subject; | |
1489 | int i = 0; | |
1490 | unsigned long int total = 0; /* no overflow */ | |
1491 | ||
1492 | while (*s != 0) | |
1493 | { | |
0539a19d | 1494 | if (i == 0) i = nelem(prime) - 1; |
059ec3d9 PH |
1495 | total += prime[i--] * (unsigned int)(*s++); |
1496 | } | |
1497 | ||
1498 | /* If value2 is unset, just compute one number */ | |
1499 | ||
1500 | if (value2 < 0) | |
bb07bcd3 | 1501 | s = string_sprintf("%lu", total % value1); |
059ec3d9 PH |
1502 | |
1503 | /* Otherwise do a div/mod hash */ | |
1504 | ||
1505 | else | |
1506 | { | |
1507 | total = total % (value1 * value2); | |
bb07bcd3 | 1508 | s = string_sprintf("%lu/%lu", total/value2, total % value2); |
059ec3d9 PH |
1509 | } |
1510 | ||
1511 | *len = Ustrlen(s); | |
1512 | return s; | |
1513 | } | |
1514 | ||
1515 | ||
1516 | ||
1517 | ||
1518 | ||
1519 | /************************************************* | |
1520 | * Find the value of a header or headers * | |
1521 | *************************************************/ | |
1522 | ||
1523 | /* Multiple instances of the same header get concatenated, and this function | |
1524 | can also return a concatenation of all the header lines. When concatenating | |
1525 | specific headers that contain lists of addresses, a comma is inserted between | |
1526 | them. Otherwise we use a straight concatenation. Because some messages can have | |
1527 | pathologically large number of lines, there is a limit on the length that is | |
1528 | returned. Also, to avoid massive store use which would result from using | |
1529 | string_cat() as it copies and extends strings, we do a preliminary pass to find | |
1530 | out exactly how much store will be needed. On "normal" messages this will be | |
1531 | pretty trivial. | |
1532 | ||
1533 | Arguments: | |
1534 | name the name of the header, without the leading $header_ or $h_, | |
1535 | or NULL if a concatenation of all headers is required | |
059ec3d9 PH |
1536 | newsize return the size of memory block that was obtained; may be NULL |
1537 | if exists_only is TRUE | |
bce15b62 JH |
1538 | flags FH_EXISTS_ONLY |
1539 | set if called from a def: test; don't need to build a string; | |
1540 | just return a string that is not "" and not "0" if the header | |
1541 | exists | |
1542 | FH_WANT_RAW | |
1543 | set if called for $rh_ or $rheader_ variables; no processing, | |
1544 | other than concatenating, will be done on the header. Also used | |
1545 | for $message_headers_raw. | |
1546 | FH_WANT_LIST | |
1547 | Double colon chars in the content, and replace newline with | |
1548 | colon between each element when concatenating; returning a | |
1549 | colon-sep list (elements might contain newlines) | |
059ec3d9 PH |
1550 | charset name of charset to translate MIME words to; used only if |
1551 | want_raw is false; if NULL, no translation is done (this is | |
1552 | used for $bh_ and $bheader_) | |
1553 | ||
1554 | Returns: NULL if the header does not exist, else a pointer to a new | |
1555 | store block | |
1556 | */ | |
1557 | ||
1558 | static uschar * | |
bce15b62 | 1559 | find_header(uschar *name, int *newsize, unsigned flags, uschar *charset) |
059ec3d9 | 1560 | { |
bce15b62 JH |
1561 | BOOL found = !name; |
1562 | int len = name ? Ustrlen(name) : 0; | |
1563 | BOOL comma = FALSE; | |
1564 | header_line * h; | |
1565 | gstring * g = NULL; | |
059ec3d9 | 1566 | |
bce15b62 JH |
1567 | for (h = header_list; h; h = h->next) |
1568 | if (h->type != htype_old && h->text) /* NULL => Received: placeholder */ | |
1569 | if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0)) | |
1570 | { | |
1571 | uschar * s, * t; | |
1572 | size_t inc; | |
fd700877 | 1573 | |
bce15b62 JH |
1574 | if (flags & FH_EXISTS_ONLY) |
1575 | return US"1"; /* don't need actual string */ | |
fd700877 | 1576 | |
bce15b62 JH |
1577 | found = TRUE; |
1578 | s = h->text + len; /* text to insert */ | |
1579 | if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */ | |
1580 | while (isspace(*s)) s++; /* remove leading white space */ | |
1581 | t = h->text + h->slen; /* end-point */ | |
059ec3d9 | 1582 | |
bce15b62 JH |
1583 | /* Unless wanted raw, remove trailing whitespace, including the |
1584 | newline. */ | |
059ec3d9 | 1585 | |
bce15b62 JH |
1586 | if (flags & FH_WANT_LIST) |
1587 | while (t > s && t[-1] == '\n') t--; | |
1588 | else if (!(flags & FH_WANT_RAW)) | |
1589 | { | |
1590 | while (t > s && isspace(t[-1])) t--; | |
059ec3d9 | 1591 | |
bce15b62 JH |
1592 | /* Set comma if handling a single header and it's one of those |
1593 | that contains an address list, except when asked for raw headers. Only | |
1594 | need to do this once. */ | |
059ec3d9 | 1595 | |
bce15b62 JH |
1596 | if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE; |
1597 | } | |
059ec3d9 | 1598 | |
bce15b62 JH |
1599 | /* Trim the header roughly if we're approaching limits */ |
1600 | inc = t - s; | |
1601 | if ((g ? g->ptr : 0) + inc > header_insert_maxlen) | |
1602 | inc = header_insert_maxlen - (g ? g->ptr : 0); | |
1603 | ||
1604 | /* For raw just copy the data; for a list, add the data as a colon-sep | |
1605 | list-element; for comma-list add as an unchecked comma,newline sep | |
1606 | list-elemment; for other nonraw add as an unchecked newline-sep list (we | |
1607 | stripped trailing WS above including the newline). We ignore the potential | |
1608 | expansion due to colon-doubling, just leaving the loop if the limit is met | |
1609 | or exceeded. */ | |
1610 | ||
1611 | if (flags & FH_WANT_LIST) | |
1612 | g = string_append_listele_n(g, ':', s, (unsigned)inc); | |
1613 | else if (flags & FH_WANT_RAW) | |
1614 | { | |
1615 | g = string_catn(g, s, (unsigned)inc); | |
1616 | (void) string_from_gstring(g); | |
1617 | } | |
1618 | else if (inc > 0) | |
1619 | if (comma) | |
1620 | g = string_append2_listele_n(g, US",\n", s, (unsigned)inc); | |
1621 | else | |
1622 | g = string_append2_listele_n(g, US"\n", s, (unsigned)inc); | |
059ec3d9 | 1623 | |
bce15b62 JH |
1624 | if (g && g->ptr >= header_insert_maxlen) break; |
1625 | } | |
059ec3d9 | 1626 | |
bce15b62 JH |
1627 | if (!found) return NULL; /* No header found */ |
1628 | if (!g) return US""; | |
059ec3d9 | 1629 | |
059ec3d9 PH |
1630 | /* That's all we do for raw header expansion. */ |
1631 | ||
bce15b62 JH |
1632 | *newsize = g->size; |
1633 | if (flags & FH_WANT_RAW) | |
1634 | return g->s; | |
059ec3d9 | 1635 | |
bce15b62 JH |
1636 | /* Otherwise do RFC 2047 decoding, translating the charset if requested. |
1637 | The rfc2047_decode2() function can return an error with decoded data if the | |
1638 | charset translation fails. If decoding fails, it returns NULL. */ | |
059ec3d9 PH |
1639 | |
1640 | else | |
1641 | { | |
1642 | uschar *decoded, *error; | |
bce15b62 JH |
1643 | |
1644 | decoded = rfc2047_decode2(g->s, check_rfc2047_length, charset, '?', NULL, | |
a0d6ba8a | 1645 | newsize, &error); |
bce15b62 | 1646 | if (error) |
059ec3d9 PH |
1647 | { |
1648 | DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n" | |
bce15b62 | 1649 | " input was: %s\n", error, g->s); |
059ec3d9 | 1650 | } |
bce15b62 | 1651 | return decoded ? decoded : g->s; |
059ec3d9 | 1652 | } |
059ec3d9 PH |
1653 | } |
1654 | ||
1655 | ||
1656 | ||
1657 | ||
c8599aad | 1658 | /* Append a "local" element to an Authentication-Results: header |
40394cc1 JH |
1659 | if this was a non-smtp message. |
1660 | */ | |
1661 | ||
1662 | static gstring * | |
1663 | authres_local(gstring * g, const uschar * sysname) | |
1664 | { | |
1665 | if (!authentication_local) | |
1666 | return g; | |
1667 | g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")"); | |
1668 | if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id); | |
1669 | return g; | |
1670 | } | |
1671 | ||
1672 | ||
c8599aad | 1673 | /* Append an "iprev" element to an Authentication-Results: header |
dfbcb5ac JH |
1674 | if we have attempted to get the calling host's name. |
1675 | */ | |
1676 | ||
1677 | static gstring * | |
1678 | authres_iprev(gstring * g) | |
1679 | { | |
1680 | if (sender_host_name) | |
da85c869 JH |
1681 | return string_append(g, sender_host_address ? 5 : 3, |
1682 | US";\n\tiprev=pass (", sender_host_name, US")", | |
1683 | US" smtp.client-ip=", sender_host_address); | |
dfbcb5ac | 1684 | if (host_lookup_deferred) |
e34f8ca2 | 1685 | return string_catn(g, US";\n\tiprev=temperror", 19); |
dfbcb5ac | 1686 | if (host_lookup_failed) |
e34f8ca2 | 1687 | return string_catn(g, US";\n\tiprev=fail", 13); |
dfbcb5ac JH |
1688 | return g; |
1689 | } | |
1690 | ||
1691 | ||
1692 | ||
362145b5 JH |
1693 | /************************************************* |
1694 | * Return list of recipients * | |
1695 | *************************************************/ | |
1696 | /* A recipients list is available only during system message filtering, | |
1697 | during ACL processing after DATA, and while expanding pipe commands | |
1698 | generated from a system filter, but not elsewhere. */ | |
1699 | ||
1700 | static uschar * | |
1701 | fn_recipients(void) | |
1702 | { | |
bce15b62 | 1703 | uschar * s; |
acec9514 JH |
1704 | gstring * g = NULL; |
1705 | int i; | |
1706 | ||
1707 | if (!enable_dollar_recipients) return NULL; | |
1708 | ||
1709 | for (i = 0; i < recipients_count; i++) | |
362145b5 | 1710 | { |
bce15b62 JH |
1711 | s = recipients_list[i].address; |
1712 | g = string_append2_listele_n(g, US", ", s, Ustrlen(s)); | |
362145b5 | 1713 | } |
bce15b62 | 1714 | return g ? g->s : NULL; |
362145b5 JH |
1715 | } |
1716 | ||
1717 | ||
059ec3d9 PH |
1718 | /************************************************* |
1719 | * Find value of a variable * | |
1720 | *************************************************/ | |
1721 | ||
1722 | /* The table of variables is kept in alphabetic order, so we can search it | |
1723 | using a binary chop. The "choplen" variable is nothing to do with the binary | |
1724 | chop. | |
1725 | ||
1726 | Arguments: | |
1727 | name the name of the variable being sought | |
1728 | exists_only TRUE if this is a def: test; passed on to find_header() | |
1729 | skipping TRUE => skip any processing evaluation; this is not the same as | |
1730 | exists_only because def: may test for values that are first | |
1731 | evaluated here | |
1732 | newsize pointer to an int which is initially zero; if the answer is in | |
1733 | a new memory buffer, *newsize is set to its size | |
1734 | ||
1735 | Returns: NULL if the variable does not exist, or | |
1736 | a pointer to the variable's contents, or | |
1737 | something non-NULL if exists_only is TRUE | |
1738 | */ | |
1739 | ||
1740 | static uschar * | |
1741 | find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize) | |
1742 | { | |
9d1c15ef JH |
1743 | var_entry * vp; |
1744 | uschar *s, *domain; | |
1745 | uschar **ss; | |
1746 | void * val; | |
059ec3d9 | 1747 | |
38a0a95f PH |
1748 | /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx. |
1749 | Originally, xxx had to be a number in the range 0-9 (later 0-19), but from | |
1750 | release 4.64 onwards arbitrary names are permitted, as long as the first 5 | |
641cb756 PH |
1751 | characters are acl_c or acl_m and the sixth is either a digit or an underscore |
1752 | (this gave backwards compatibility at the changeover). There may be built-in | |
1753 | variables whose names start acl_ but they should never start in this way. This | |
1754 | slightly messy specification is a consequence of the history, needless to say. | |
47ca6d6c | 1755 | |
38a0a95f PH |
1756 | If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is |
1757 | set, in which case give an error. */ | |
47ca6d6c | 1758 | |
641cb756 PH |
1759 | if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) && |
1760 | !isalpha(name[5])) | |
38a0a95f PH |
1761 | { |
1762 | tree_node *node = | |
1763 | tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4); | |
63df3f26 | 1764 | return node ? node->data.ptr : strict_acl_vars ? NULL : US""; |
47ca6d6c PH |
1765 | } |
1766 | ||
38a0a95f | 1767 | /* Handle $auth<n> variables. */ |
f78eb7c6 PH |
1768 | |
1769 | if (Ustrncmp(name, "auth", 4) == 0) | |
1770 | { | |
1771 | uschar *endptr; | |
1772 | int n = Ustrtoul(name + 4, &endptr, 10); | |
1773 | if (*endptr == 0 && n != 0 && n <= AUTH_VARS) | |
f38917cc JH |
1774 | return !auth_vars[n-1] ? US"" : auth_vars[n-1]; |
1775 | } | |
1776 | else if (Ustrncmp(name, "regex", 5) == 0) | |
1777 | { | |
1778 | uschar *endptr; | |
1779 | int n = Ustrtoul(name + 5, &endptr, 10); | |
1780 | if (*endptr == 0 && n != 0 && n <= REGEX_VARS) | |
1781 | return !regex_vars[n-1] ? US"" : regex_vars[n-1]; | |
f78eb7c6 PH |
1782 | } |
1783 | ||
47ca6d6c PH |
1784 | /* For all other variables, search the table */ |
1785 | ||
9d1c15ef JH |
1786 | if (!(vp = find_var_ent(name))) |
1787 | return NULL; /* Unknown variable name */ | |
059ec3d9 | 1788 | |
9d1c15ef JH |
1789 | /* Found an existing variable. If in skipping state, the value isn't needed, |
1790 | and we want to avoid processing (such as looking up the host name). */ | |
059ec3d9 | 1791 | |
9d1c15ef JH |
1792 | if (skipping) |
1793 | return US""; | |
059ec3d9 | 1794 | |
9d1c15ef JH |
1795 | val = vp->value; |
1796 | switch (vp->type) | |
1797 | { | |
1798 | case vtype_filter_int: | |
63df3f26 JH |
1799 | if (!filter_running) return NULL; |
1800 | /* Fall through */ | |
1801 | /* VVVVVVVVVVVV */ | |
9d1c15ef | 1802 | case vtype_int: |
63df3f26 JH |
1803 | sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */ |
1804 | return var_buffer; | |
9d1c15ef JH |
1805 | |
1806 | case vtype_ino: | |
63df3f26 JH |
1807 | sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */ |
1808 | return var_buffer; | |
9d1c15ef JH |
1809 | |
1810 | case vtype_gid: | |
63df3f26 JH |
1811 | sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */ |
1812 | return var_buffer; | |
9d1c15ef JH |
1813 | |
1814 | case vtype_uid: | |
63df3f26 JH |
1815 | sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */ |
1816 | return var_buffer; | |
9d1c15ef JH |
1817 | |
1818 | case vtype_bool: | |
63df3f26 JH |
1819 | sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */ |
1820 | return var_buffer; | |
9d1c15ef JH |
1821 | |
1822 | case vtype_stringptr: /* Pointer to string */ | |
63df3f26 | 1823 | return (s = *((uschar **)(val))) ? s : US""; |
9d1c15ef JH |
1824 | |
1825 | case vtype_pid: | |
63df3f26 JH |
1826 | sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */ |
1827 | return var_buffer; | |
9d1c15ef JH |
1828 | |
1829 | case vtype_load_avg: | |
63df3f26 JH |
1830 | sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */ |
1831 | return var_buffer; | |
9d1c15ef JH |
1832 | |
1833 | case vtype_host_lookup: /* Lookup if not done so */ | |
2d0dc929 JH |
1834 | if ( !sender_host_name && sender_host_address |
1835 | && !host_lookup_failed && host_name_lookup() == OK) | |
63df3f26 | 1836 | host_build_sender_fullhost(); |
2d0dc929 | 1837 | return sender_host_name ? sender_host_name : US""; |
9d1c15ef JH |
1838 | |
1839 | case vtype_localpart: /* Get local part from address */ | |
63df3f26 JH |
1840 | s = *((uschar **)(val)); |
1841 | if (s == NULL) return US""; | |
1842 | domain = Ustrrchr(s, '@'); | |
1843 | if (domain == NULL) return s; | |
1844 | if (domain - s > sizeof(var_buffer) - 1) | |
1845 | log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT | |
1846 | " in string expansion", sizeof(var_buffer)); | |
1847 | Ustrncpy(var_buffer, s, domain - s); | |
1848 | var_buffer[domain - s] = 0; | |
1849 | return var_buffer; | |
9d1c15ef JH |
1850 | |
1851 | case vtype_domain: /* Get domain from address */ | |
63df3f26 JH |
1852 | s = *((uschar **)(val)); |
1853 | if (s == NULL) return US""; | |
1854 | domain = Ustrrchr(s, '@'); | |
1855 | return (domain == NULL)? US"" : domain + 1; | |
9d1c15ef JH |
1856 | |
1857 | case vtype_msgheaders: | |
bce15b62 | 1858 | return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL); |
9d1c15ef JH |
1859 | |
1860 | case vtype_msgheaders_raw: | |
bce15b62 JH |
1861 | return find_header(NULL, newsize, |
1862 | exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL); | |
9d1c15ef JH |
1863 | |
1864 | case vtype_msgbody: /* Pointer to msgbody string */ | |
1865 | case vtype_msgbody_end: /* Ditto, the end of the msg */ | |
63df3f26 | 1866 | ss = (uschar **)(val); |
d315eda1 | 1867 | if (!*ss && deliver_datafile >= 0) /* Read body when needed */ |
059ec3d9 | 1868 | { |
63df3f26 JH |
1869 | uschar *body; |
1870 | off_t start_offset = SPOOL_DATA_START_OFFSET; | |
1871 | int len = message_body_visible; | |
1872 | if (len > message_size) len = message_size; | |
1873 | *ss = body = store_malloc(len+1); | |
1874 | body[0] = 0; | |
1875 | if (vp->type == vtype_msgbody_end) | |
9d1c15ef | 1876 | { |
63df3f26 JH |
1877 | struct stat statbuf; |
1878 | if (fstat(deliver_datafile, &statbuf) == 0) | |
1879 | { | |
1880 | start_offset = statbuf.st_size - len; | |
1881 | if (start_offset < SPOOL_DATA_START_OFFSET) | |
1882 | start_offset = SPOOL_DATA_START_OFFSET; | |
1883 | } | |
9d1c15ef | 1884 | } |
d4ff61d1 JH |
1885 | if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0) |
1886 | log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s", | |
1887 | strerror(errno)); | |
63df3f26 JH |
1888 | len = read(deliver_datafile, body, len); |
1889 | if (len > 0) | |
9d1c15ef | 1890 | { |
63df3f26 JH |
1891 | body[len] = 0; |
1892 | if (message_body_newlines) /* Separate loops for efficiency */ | |
1893 | while (len > 0) | |
1894 | { if (body[--len] == 0) body[len] = ' '; } | |
1895 | else | |
1896 | while (len > 0) | |
1897 | { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; } | |
9d1c15ef | 1898 | } |
059ec3d9 | 1899 | } |
d315eda1 | 1900 | return *ss ? *ss : US""; |
059ec3d9 | 1901 | |
9d1c15ef | 1902 | case vtype_todbsdin: /* BSD inbox time of day */ |
63df3f26 | 1903 | return tod_stamp(tod_bsdin); |
059ec3d9 | 1904 | |
9d1c15ef | 1905 | case vtype_tode: /* Unix epoch time of day */ |
63df3f26 | 1906 | return tod_stamp(tod_epoch); |
059ec3d9 | 1907 | |
9d1c15ef | 1908 | case vtype_todel: /* Unix epoch/usec time of day */ |
63df3f26 | 1909 | return tod_stamp(tod_epoch_l); |
f5787926 | 1910 | |
9d1c15ef | 1911 | case vtype_todf: /* Full time of day */ |
63df3f26 | 1912 | return tod_stamp(tod_full); |
059ec3d9 | 1913 | |
9d1c15ef | 1914 | case vtype_todl: /* Log format time of day */ |
63df3f26 | 1915 | return tod_stamp(tod_log_bare); /* (without timezone) */ |
059ec3d9 | 1916 | |
9d1c15ef | 1917 | case vtype_todzone: /* Time zone offset only */ |
63df3f26 | 1918 | return tod_stamp(tod_zone); |
059ec3d9 | 1919 | |
9d1c15ef | 1920 | case vtype_todzulu: /* Zulu time */ |
63df3f26 | 1921 | return tod_stamp(tod_zulu); |
059ec3d9 | 1922 | |
9d1c15ef | 1923 | case vtype_todlf: /* Log file datestamp tod */ |
63df3f26 | 1924 | return tod_stamp(tod_log_datestamp_daily); |
059ec3d9 | 1925 | |
9d1c15ef | 1926 | case vtype_reply: /* Get reply address */ |
bce15b62 JH |
1927 | s = find_header(US"reply-to:", newsize, |
1928 | exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, | |
1929 | headers_charset); | |
9cffa436 JH |
1930 | if (s) while (isspace(*s)) s++; |
1931 | if (!s || !*s) | |
63df3f26 JH |
1932 | { |
1933 | *newsize = 0; /* For the *s==0 case */ | |
bce15b62 JH |
1934 | s = find_header(US"from:", newsize, |
1935 | exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, | |
1936 | headers_charset); | |
63df3f26 | 1937 | } |
9cffa436 | 1938 | if (s) |
63df3f26 JH |
1939 | { |
1940 | uschar *t; | |
1941 | while (isspace(*s)) s++; | |
1942 | for (t = s; *t != 0; t++) if (*t == '\n') *t = ' '; | |
1943 | while (t > s && isspace(t[-1])) t--; | |
1944 | *t = 0; | |
1945 | } | |
9cffa436 | 1946 | return s ? s : US""; |
059ec3d9 | 1947 | |
9d1c15ef JH |
1948 | case vtype_string_func: |
1949 | { | |
1950 | uschar * (*fn)() = val; | |
1951 | return fn(); | |
1952 | } | |
8e669ac1 | 1953 | |
9d1c15ef JH |
1954 | case vtype_pspace: |
1955 | { | |
1956 | int inodes; | |
1957 | sprintf(CS var_buffer, "%d", | |
1958 | receive_statvfs(val == (void *)TRUE, &inodes)); | |
1959 | } | |
1960 | return var_buffer; | |
8e669ac1 | 1961 | |
9d1c15ef JH |
1962 | case vtype_pinodes: |
1963 | { | |
1964 | int inodes; | |
1965 | (void) receive_statvfs(val == (void *)TRUE, &inodes); | |
1966 | sprintf(CS var_buffer, "%d", inodes); | |
1967 | } | |
1968 | return var_buffer; | |
80a47a2c | 1969 | |
9d1c15ef | 1970 | case vtype_cert: |
63df3f26 | 1971 | return *(void **)val ? US"<cert>" : US""; |
80a47a2c | 1972 | |
63df3f26 | 1973 | #ifndef DISABLE_DKIM |
9d1c15ef | 1974 | case vtype_dkim: |
63df3f26 JH |
1975 | return dkim_exim_expand_query((int)(long)val); |
1976 | #endif | |
059ec3d9 | 1977 | |
9d1c15ef | 1978 | } |
6c08476d LM |
1979 | |
1980 | return NULL; /* Unknown variable. Silences static checkers. */ | |
059ec3d9 PH |
1981 | } |
1982 | ||
1983 | ||
1984 | ||
1985 | ||
d9b2312b JH |
1986 | void |
1987 | modify_variable(uschar *name, void * value) | |
1988 | { | |
9d1c15ef JH |
1989 | var_entry * vp; |
1990 | if ((vp = find_var_ent(name))) vp->value = value; | |
d9b2312b JH |
1991 | return; /* Unknown variable name, fail silently */ |
1992 | } | |
1993 | ||
1994 | ||
1995 | ||
1996 | ||
1997 | ||
cf0812d5 | 1998 | |
059ec3d9 PH |
1999 | /************************************************* |
2000 | * Read and expand substrings * | |
2001 | *************************************************/ | |
2002 | ||
2003 | /* This function is called to read and expand argument substrings for various | |
2004 | expansion items. Some have a minimum requirement that is less than the maximum; | |
2005 | in these cases, the first non-present one is set to NULL. | |
2006 | ||
2007 | Arguments: | |
2008 | sub points to vector of pointers to set | |
2009 | n maximum number of substrings | |
2010 | m minimum required | |
2011 | sptr points to current string pointer | |
2012 | skipping the skipping flag | |
2013 | check_end if TRUE, check for final '}' | |
2014 | name name of item, for error message | |
b0e85a8f JH |
2015 | resetok if not NULL, pointer to flag - write FALSE if unsafe to reset |
2016 | the store. | |
059ec3d9 PH |
2017 | |
2018 | Returns: 0 OK; string pointer updated | |
2019 | 1 curly bracketing error (too few arguments) | |
2020 | 2 too many arguments (only if check_end is set); message set | |
2021 | 3 other error (expansion failure) | |
2022 | */ | |
2023 | ||
2024 | static int | |
55414b25 | 2025 | read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping, |
b0e85a8f | 2026 | BOOL check_end, uschar *name, BOOL *resetok) |
059ec3d9 PH |
2027 | { |
2028 | int i; | |
55414b25 | 2029 | const uschar *s = *sptr; |
059ec3d9 PH |
2030 | |
2031 | while (isspace(*s)) s++; | |
2032 | for (i = 0; i < n; i++) | |
2033 | { | |
2034 | if (*s != '{') | |
2035 | { | |
e47376be JH |
2036 | if (i < m) |
2037 | { | |
2038 | expand_string_message = string_sprintf("Not enough arguments for '%s' " | |
2039 | "(min is %d)", name, m); | |
2040 | return 1; | |
2041 | } | |
059ec3d9 PH |
2042 | sub[i] = NULL; |
2043 | break; | |
2044 | } | |
e47376be JH |
2045 | if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok))) |
2046 | return 3; | |
059ec3d9 PH |
2047 | if (*s++ != '}') return 1; |
2048 | while (isspace(*s)) s++; | |
2049 | } | |
2050 | if (check_end && *s++ != '}') | |
2051 | { | |
2052 | if (s[-1] == '{') | |
2053 | { | |
e47376be | 2054 | expand_string_message = string_sprintf("Too many arguments for '%s' " |
059ec3d9 PH |
2055 | "(max is %d)", name, n); |
2056 | return 2; | |
2057 | } | |
e47376be | 2058 | expand_string_message = string_sprintf("missing '}' after '%s'", name); |
059ec3d9 PH |
2059 | return 1; |
2060 | } | |
2061 | ||
2062 | *sptr = s; | |
2063 | return 0; | |
2064 | } | |
2065 | ||
2066 | ||
2067 | ||
2068 | ||
641cb756 PH |
2069 | /************************************************* |
2070 | * Elaborate message for bad variable * | |
2071 | *************************************************/ | |
2072 | ||
2073 | /* For the "unknown variable" message, take a look at the variable's name, and | |
2074 | give additional information about possible ACL variables. The extra information | |
2075 | is added on to expand_string_message. | |
2076 | ||
2077 | Argument: the name of the variable | |
2078 | Returns: nothing | |
2079 | */ | |
2080 | ||
2081 | static void | |
2082 | check_variable_error_message(uschar *name) | |
2083 | { | |
2084 | if (Ustrncmp(name, "acl_", 4) == 0) | |
2085 | expand_string_message = string_sprintf("%s (%s)", expand_string_message, | |
2086 | (name[4] == 'c' || name[4] == 'm')? | |
2087 | (isalpha(name[5])? | |
2088 | US"6th character of a user-defined ACL variable must be a digit or underscore" : | |
2089 | US"strict_acl_vars is set" /* Syntax is OK, it has to be this */ | |
2090 | ) : | |
2091 | US"user-defined ACL variables must start acl_c or acl_m"); | |
2092 | } | |
2093 | ||
2094 | ||
2095 | ||
f60d98e8 JH |
2096 | /* |
2097 | Load args from sub array to globals, and call acl_check(). | |
ef21c07d | 2098 | Sub array will be corrupted on return. |
f60d98e8 JH |
2099 | |
2100 | Returns: OK access is granted by an ACCEPT verb | |
6e3b198d | 2101 | DISCARD access is (apparently) granted by a DISCARD verb |
f60d98e8 JH |
2102 | FAIL access is denied |
2103 | FAIL_DROP access is denied; drop the connection | |
2104 | DEFER can't tell at the moment | |
2105 | ERROR disaster | |
2106 | */ | |
2107 | static int | |
2108 | eval_acl(uschar ** sub, int nsub, uschar ** user_msgp) | |
2109 | { | |
2110 | int i; | |
ef21c07d JH |
2111 | int sav_narg = acl_narg; |
2112 | int ret; | |
93a6fce2 | 2113 | uschar * dummy_logmsg; |
faa05a93 | 2114 | extern int acl_where; |
f60d98e8 | 2115 | |
0539a19d | 2116 | if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg); |
ef21c07d JH |
2117 | for (i = 0; i < nsub && sub[i+1]; i++) |
2118 | { | |
93a6fce2 | 2119 | uschar * tmp = acl_arg[i]; |
ef21c07d JH |
2120 | acl_arg[i] = sub[i+1]; /* place callers args in the globals */ |
2121 | sub[i+1] = tmp; /* stash the old args using our caller's storage */ | |
2122 | } | |
2123 | acl_narg = i; | |
bef3ea7f | 2124 | while (i < nsub) |
ef21c07d JH |
2125 | { |
2126 | sub[i+1] = acl_arg[i]; | |
2127 | acl_arg[i++] = NULL; | |
2128 | } | |
f60d98e8 JH |
2129 | |
2130 | DEBUG(D_expand) | |
e1d04f48 | 2131 | debug_printf_indent("expanding: acl: %s arg: %s%s\n", |
f60d98e8 | 2132 | sub[0], |
60f8e1e8 JH |
2133 | acl_narg>0 ? acl_arg[0] : US"<none>", |
2134 | acl_narg>1 ? " +more" : ""); | |
f60d98e8 | 2135 | |
93a6fce2 | 2136 | ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg); |
ef21c07d JH |
2137 | |
2138 | for (i = 0; i < nsub; i++) | |
2139 | acl_arg[i] = sub[i+1]; /* restore old args */ | |
2140 | acl_narg = sav_narg; | |
2141 | ||
2142 | return ret; | |
f60d98e8 JH |
2143 | } |
2144 | ||
2145 | ||
2146 | ||
2147 | ||
059ec3d9 PH |
2148 | /************************************************* |
2149 | * Read and evaluate a condition * | |
2150 | *************************************************/ | |
2151 | ||
2152 | /* | |
2153 | Arguments: | |
2154 | s points to the start of the condition text | |
b0e85a8f JH |
2155 | resetok points to a BOOL which is written false if it is unsafe to |
2156 | free memory. Certain condition types (acl) may have side-effect | |
2157 | allocation which must be preserved. | |
059ec3d9 PH |
2158 | yield points to a BOOL to hold the result of the condition test; |
2159 | if NULL, we are just reading through a condition that is | |
2160 | part of an "or" combination to check syntax, or in a state | |
2161 | where the answer isn't required | |
2162 | ||
2163 | Returns: a pointer to the first character after the condition, or | |
2164 | NULL after an error | |
2165 | */ | |
2166 | ||
55414b25 JH |
2167 | static const uschar * |
2168 | eval_condition(const uschar *s, BOOL *resetok, BOOL *yield) | |
059ec3d9 PH |
2169 | { |
2170 | BOOL testfor = TRUE; | |
2171 | BOOL tempcond, combined_cond; | |
2172 | BOOL *subcondptr; | |
5cfd2e57 | 2173 | BOOL sub2_honour_dollar = TRUE; |
059ec3d9 | 2174 | int i, rc, cond_type, roffset; |
97d17305 | 2175 | int_eximarith_t num[2]; |
059ec3d9 PH |
2176 | struct stat statbuf; |
2177 | uschar name[256]; | |
55414b25 | 2178 | const uschar *sub[10]; |
059ec3d9 PH |
2179 | |
2180 | const pcre *re; | |
2181 | const uschar *rerror; | |
2182 | ||
2183 | for (;;) | |
2184 | { | |
2185 | while (isspace(*s)) s++; | |
2186 | if (*s == '!') { testfor = !testfor; s++; } else break; | |
2187 | } | |
2188 | ||
2189 | /* Numeric comparisons are symbolic */ | |
2190 | ||
2191 | if (*s == '=' || *s == '>' || *s == '<') | |
2192 | { | |
2193 | int p = 0; | |
2194 | name[p++] = *s++; | |
2195 | if (*s == '=') | |
2196 | { | |
2197 | name[p++] = '='; | |
2198 | s++; | |
2199 | } | |
2200 | name[p] = 0; | |
2201 | } | |
2202 | ||
2203 | /* All other conditions are named */ | |
2204 | ||
2205 | else s = read_name(name, 256, s, US"_"); | |
2206 | ||
2207 | /* If we haven't read a name, it means some non-alpha character is first. */ | |
2208 | ||
2209 | if (name[0] == 0) | |
2210 | { | |
2211 | expand_string_message = string_sprintf("condition name expected, " | |
2212 | "but found \"%.16s\"", s); | |
2213 | return NULL; | |
2214 | } | |
2215 | ||
2216 | /* Find which condition we are dealing with, and switch on it */ | |
2217 | ||
0539a19d | 2218 | cond_type = chop_match(name, cond_table, nelem(cond_table)); |
059ec3d9 PH |
2219 | switch(cond_type) |
2220 | { | |
9b4768fa PH |
2221 | /* def: tests for a non-empty variable, or for the existence of a header. If |
2222 | yield == NULL we are in a skipping state, and don't care about the answer. */ | |
059ec3d9 PH |
2223 | |
2224 | case ECOND_DEF: | |
059ec3d9 | 2225 | { |
bce15b62 | 2226 | uschar * t; |
059ec3d9 | 2227 | |
bce15b62 JH |
2228 | if (*s != ':') |
2229 | { | |
2230 | expand_string_message = US"\":\" expected after \"def\""; | |
2231 | return NULL; | |
2232 | } | |
059ec3d9 | 2233 | |
bce15b62 | 2234 | s = read_name(name, 256, s+1, US"_"); |
059ec3d9 | 2235 | |
bce15b62 JH |
2236 | /* Test for a header's existence. If the name contains a closing brace |
2237 | character, this may be a user error where the terminating colon has been | |
2238 | omitted. Set a flag to adjust a subsequent error message in this case. */ | |
059ec3d9 | 2239 | |
bce15b62 JH |
2240 | if ( ( *(t = name) == 'h' |
2241 | || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h' | |
2242 | ) | |
2243 | && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0) | |
2244 | ) | |
2245 | { | |
2246 | s = read_header_name(name, 256, s); | |
2247 | /* {-for-text-editors */ | |
2248 | if (Ustrchr(name, '}') != NULL) malformed_header = TRUE; | |
2249 | if (yield) *yield = | |
2250 | (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor; | |
2251 | } | |
059ec3d9 | 2252 | |
bce15b62 JH |
2253 | /* Test for a variable's having a non-empty value. A non-existent variable |
2254 | causes an expansion failure. */ | |
2255 | ||
2256 | else | |
059ec3d9 | 2257 | { |
bce15b62 JH |
2258 | if (!(t = find_variable(name, TRUE, yield == NULL, NULL))) |
2259 | { | |
2260 | expand_string_message = (name[0] == 0)? | |
2261 | string_sprintf("variable name omitted after \"def:\"") : | |
2262 | string_sprintf("unknown variable \"%s\" after \"def:\"", name); | |
2263 | check_variable_error_message(name); | |
2264 | return NULL; | |
2265 | } | |
2266 | if (yield) *yield = (t[0] != 0) == testfor; | |
059ec3d9 | 2267 | } |
059ec3d9 | 2268 | |
bce15b62 JH |
2269 | return s; |
2270 | } | |
059ec3d9 PH |
2271 | |
2272 | ||
2273 | /* first_delivery tests for first delivery attempt */ | |
2274 | ||
2275 | case ECOND_FIRST_DELIVERY: | |
2276 | if (yield != NULL) *yield = deliver_firsttime == testfor; | |
2277 | return s; | |
2278 | ||
2279 | ||
2280 | /* queue_running tests for any process started by a queue runner */ | |
2281 | ||
2282 | case ECOND_QUEUE_RUNNING: | |
2283 | if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor; | |
2284 | return s; | |
2285 | ||
2286 | ||
2287 | /* exists: tests for file existence | |
2288 | isip: tests for any IP address | |
2289 | isip4: tests for an IPv4 address | |
2290 | isip6: tests for an IPv6 address | |
2291 | pam: does PAM authentication | |
2292 | radius: does RADIUS authentication | |
2293 | ldapauth: does LDAP authentication | |
2294 | pwcheck: does Cyrus SASL pwcheck authentication | |
2295 | */ | |
2296 | ||
2297 | case ECOND_EXISTS: | |
2298 | case ECOND_ISIP: | |
2299 | case ECOND_ISIP4: | |
2300 | case ECOND_ISIP6: | |
2301 | case ECOND_PAM: | |
2302 | case ECOND_RADIUS: | |
2303 | case ECOND_LDAPAUTH: | |
2304 | case ECOND_PWCHECK: | |
2305 | ||
2306 | while (isspace(*s)) s++; | |
b5b871ac | 2307 | if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */ |
059ec3d9 | 2308 | |
b0e85a8f | 2309 | sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok); |
059ec3d9 | 2310 | if (sub[0] == NULL) return NULL; |
b5b871ac | 2311 | /* {-for-text-editors */ |
059ec3d9 PH |
2312 | if (*s++ != '}') goto COND_FAILED_CURLY_END; |
2313 | ||
2314 | if (yield == NULL) return s; /* No need to run the test if skipping */ | |
2315 | ||
2316 | switch(cond_type) | |
2317 | { | |
2318 | case ECOND_EXISTS: | |
2319 | if ((expand_forbid & RDO_EXISTS) != 0) | |
2320 | { | |
2321 | expand_string_message = US"File existence tests are not permitted"; | |
2322 | return NULL; | |
2323 | } | |
2324 | *yield = (Ustat(sub[0], &statbuf) == 0) == testfor; | |
2325 | break; | |
2326 | ||
2327 | case ECOND_ISIP: | |
2328 | case ECOND_ISIP4: | |
2329 | case ECOND_ISIP6: | |
2330 | rc = string_is_ip_address(sub[0], NULL); | |
7e66e54d | 2331 | *yield = ((cond_type == ECOND_ISIP)? (rc != 0) : |
059ec3d9 PH |
2332 | (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor; |
2333 | break; | |
2334 | ||
2335 | /* Various authentication tests - all optionally compiled */ | |
2336 | ||
2337 | case ECOND_PAM: | |
2338 | #ifdef SUPPORT_PAM | |
2339 | rc = auth_call_pam(sub[0], &expand_string_message); | |
2340 | goto END_AUTH; | |
2341 | #else | |
2342 | goto COND_FAILED_NOT_COMPILED; | |
2343 | #endif /* SUPPORT_PAM */ | |
2344 | ||
2345 | case ECOND_RADIUS: | |
2346 | #ifdef RADIUS_CONFIG_FILE | |
2347 | rc = auth_call_radius(sub[0], &expand_string_message); | |
2348 | goto END_AUTH; | |
2349 | #else | |
2350 | goto COND_FAILED_NOT_COMPILED; | |
2351 | #endif /* RADIUS_CONFIG_FILE */ | |
2352 | ||
2353 | case ECOND_LDAPAUTH: | |
2354 | #ifdef LOOKUP_LDAP | |
2355 | { | |
2356 | /* Just to keep the interface the same */ | |
2357 | BOOL do_cache; | |
2358 | int old_pool = store_pool; | |
2359 | store_pool = POOL_SEARCH; | |
2360 | rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL, | |
2361 | &expand_string_message, &do_cache); | |
2362 | store_pool = old_pool; | |
2363 | } | |
2364 | goto END_AUTH; | |
2365 | #else | |
2366 | goto COND_FAILED_NOT_COMPILED; | |
2367 | #endif /* LOOKUP_LDAP */ | |
2368 | ||
2369 | case ECOND_PWCHECK: | |
2370 | #ifdef CYRUS_PWCHECK_SOCKET | |
2371 | rc = auth_call_pwcheck(sub[0], &expand_string_message); | |
2372 | goto END_AUTH; | |
2373 | #else | |
2374 | goto COND_FAILED_NOT_COMPILED; | |
2375 | #endif /* CYRUS_PWCHECK_SOCKET */ | |
2376 | ||
2377 | #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \ | |
2378 | defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET) | |
2379 | END_AUTH: | |
2380 | if (rc == ERROR || rc == DEFER) return NULL; | |
2381 | *yield = (rc == OK) == testfor; | |
2382 | #endif | |
2383 | } | |
2384 | return s; | |
2385 | ||
2386 | ||
333eea9c JH |
2387 | /* call ACL (in a conditional context). Accept true, deny false. |
2388 | Defer is a forced-fail. Anything set by message= goes to $value. | |
f60d98e8 JH |
2389 | Up to ten parameters are used; we use the braces round the name+args |
2390 | like the saslauthd condition does, to permit a variable number of args. | |
2391 | See also the expansion-item version EITEM_ACL and the traditional | |
2392 | acl modifier ACLC_ACL. | |
fd5dad68 JH |
2393 | Since the ACL may allocate new global variables, tell our caller to not |
2394 | reclaim memory. | |
f60d98e8 | 2395 | */ |
333eea9c JH |
2396 | |
2397 | case ECOND_ACL: | |
bef3ea7f | 2398 | /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */ |
333eea9c | 2399 | { |
55414b25 | 2400 | uschar *sub[10]; |
333eea9c | 2401 | uschar *user_msg; |
333eea9c | 2402 | BOOL cond = FALSE; |
333eea9c JH |
2403 | |
2404 | while (isspace(*s)) s++; | |
6d9cfc47 | 2405 | if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/ |
333eea9c | 2406 | |
0539a19d | 2407 | switch(read_subs(sub, nelem(sub), 1, |
b0e85a8f | 2408 | &s, yield == NULL, TRUE, US"acl", resetok)) |
333eea9c | 2409 | { |
f60d98e8 JH |
2410 | case 1: expand_string_message = US"too few arguments or bracketing " |
2411 | "error for acl"; | |
2412 | case 2: | |
2413 | case 3: return NULL; | |
333eea9c | 2414 | } |
f60d98e8 | 2415 | |
9e70917d JH |
2416 | if (yield != NULL) |
2417 | { | |
2418 | *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */ | |
2419 | switch(eval_acl(sub, nelem(sub), &user_msg)) | |
f60d98e8 JH |
2420 | { |
2421 | case OK: | |
2422 | cond = TRUE; | |
2423 | case FAIL: | |
bef3ea7f | 2424 | lookup_value = NULL; |
f60d98e8 | 2425 | if (user_msg) |
acec9514 | 2426 | lookup_value = string_copy(user_msg); |
b5b871ac | 2427 | *yield = cond == testfor; |
f60d98e8 JH |
2428 | break; |
2429 | ||
2430 | case DEFER: | |
2431 | expand_string_forcedfail = TRUE; | |
6e3b198d | 2432 | /*FALLTHROUGH*/ |
f60d98e8 JH |
2433 | default: |
2434 | expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]); | |
2435 | return NULL; | |
2436 | } | |
9e70917d | 2437 | } |
f60d98e8 | 2438 | return s; |
333eea9c | 2439 | } |
333eea9c JH |
2440 | |
2441 | ||
059ec3d9 PH |
2442 | /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used: |
2443 | ||
b0e85a8f | 2444 | ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}} |
059ec3d9 PH |
2445 | |
2446 | However, the last two are optional. That is why the whole set is enclosed | |
333eea9c | 2447 | in their own set of braces. */ |
059ec3d9 PH |
2448 | |
2449 | case ECOND_SASLAUTHD: | |
0539a19d JH |
2450 | #ifndef CYRUS_SASLAUTHD_SOCKET |
2451 | goto COND_FAILED_NOT_COMPILED; | |
2452 | #else | |
059ec3d9 | 2453 | { |
0539a19d JH |
2454 | uschar *sub[4]; |
2455 | while (isspace(*s)) s++; | |
2456 | if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */ | |
2457 | switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd", | |
2458 | resetok)) | |
2459 | { | |
2460 | case 1: expand_string_message = US"too few arguments or bracketing " | |
2461 | "error for saslauthd"; | |
2462 | case 2: | |
2463 | case 3: return NULL; | |
2464 | } | |
2465 | if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */ | |
2466 | if (yield != NULL) | |
2467 | { | |
2468 | int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3], | |
2469 | &expand_string_message); | |
2470 | if (rc == ERROR || rc == DEFER) return NULL; | |
2471 | *yield = (rc == OK) == testfor; | |
2472 | } | |
2473 | return s; | |
059ec3d9 | 2474 | } |
0539a19d | 2475 | #endif /* CYRUS_SASLAUTHD_SOCKET */ |
059ec3d9 PH |
2476 | |
2477 | ||
2478 | /* symbolic operators for numeric and string comparison, and a number of | |
2479 | other operators, all requiring two arguments. | |
2480 | ||
76dca828 PP |
2481 | crypteq: encrypts plaintext and compares against an encrypted text, |
2482 | using crypt(), crypt16(), MD5 or SHA-1 | |
2483 | inlist/inlisti: checks if first argument is in the list of the second | |
059ec3d9 PH |
2484 | match: does a regular expression match and sets up the numerical |
2485 | variables if it succeeds | |
2486 | match_address: matches in an address list | |
2487 | match_domain: matches in a domain list | |
32d668a5 | 2488 | match_ip: matches a host list that is restricted to IP addresses |
059ec3d9 | 2489 | match_local_part: matches in a local part list |
059ec3d9 PH |
2490 | */ |
2491 | ||
059ec3d9 PH |
2492 | case ECOND_MATCH_ADDRESS: |
2493 | case ECOND_MATCH_DOMAIN: | |
32d668a5 | 2494 | case ECOND_MATCH_IP: |
059ec3d9 | 2495 | case ECOND_MATCH_LOCAL_PART: |
da6dbe26 PP |
2496 | #ifndef EXPAND_LISTMATCH_RHS |
2497 | sub2_honour_dollar = FALSE; | |
2498 | #endif | |
2499 | /* FALLTHROUGH */ | |
2500 | ||
2501 | case ECOND_CRYPTEQ: | |
2502 | case ECOND_INLIST: | |
2503 | case ECOND_INLISTI: | |
2504 | case ECOND_MATCH: | |
059ec3d9 PH |
2505 | |
2506 | case ECOND_NUM_L: /* Numerical comparisons */ | |
2507 | case ECOND_NUM_LE: | |
2508 | case ECOND_NUM_E: | |
2509 | case ECOND_NUM_EE: | |
2510 | case ECOND_NUM_G: | |
2511 | case ECOND_NUM_GE: | |
2512 | ||
2513 | case ECOND_STR_LT: /* String comparisons */ | |
2514 | case ECOND_STR_LTI: | |
2515 | case ECOND_STR_LE: | |
2516 | case ECOND_STR_LEI: | |
2517 | case ECOND_STR_EQ: | |
2518 | case ECOND_STR_EQI: | |
2519 | case ECOND_STR_GT: | |
2520 | case ECOND_STR_GTI: | |
2521 | case ECOND_STR_GE: | |
2522 | case ECOND_STR_GEI: | |
2523 | ||
2524 | for (i = 0; i < 2; i++) | |
2525 | { | |
da6dbe26 PP |
2526 | /* Sometimes, we don't expand substrings; too many insecure configurations |
2527 | created using match_address{}{} and friends, where the second param | |
2528 | includes information from untrustworthy sources. */ | |
2529 | BOOL honour_dollar = TRUE; | |
2530 | if ((i > 0) && !sub2_honour_dollar) | |
2531 | honour_dollar = FALSE; | |
2532 | ||
059ec3d9 PH |
2533 | while (isspace(*s)) s++; |
2534 | if (*s != '{') | |
2535 | { | |
2536 | if (i == 0) goto COND_FAILED_CURLY_START; | |
2537 | expand_string_message = string_sprintf("missing 2nd string in {} " | |
2538 | "after \"%s\"", name); | |
2539 | return NULL; | |
2540 | } | |
d584cdca JH |
2541 | if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL, |
2542 | honour_dollar, resetok))) | |
2543 | return NULL; | |
2544 | DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$')) | |
2545 | debug_printf_indent("WARNING: the second arg is NOT expanded," | |
2546 | " for security reasons\n"); | |
059ec3d9 PH |
2547 | if (*s++ != '}') goto COND_FAILED_CURLY_END; |
2548 | ||
2549 | /* Convert to numerical if required; we know that the names of all the | |
2550 | conditions that compare numbers do not start with a letter. This just saves | |
2551 | checking for them individually. */ | |
2552 | ||
d6066548 | 2553 | if (!isalpha(name[0]) && yield != NULL) |
5dd1517f PH |
2554 | if (sub[i][0] == 0) |
2555 | { | |
2556 | num[i] = 0; | |
2557 | DEBUG(D_expand) | |
e1d04f48 | 2558 | debug_printf_indent("empty string cast to zero for numerical comparison\n"); |
5dd1517f PH |
2559 | } |
2560 | else | |
2561 | { | |
7685ce68 | 2562 | num[i] = expanded_string_integer(sub[i], FALSE); |
5dd1517f PH |
2563 | if (expand_string_message != NULL) return NULL; |
2564 | } | |
059ec3d9 PH |
2565 | } |
2566 | ||
2567 | /* Result not required */ | |
2568 | ||
2569 | if (yield == NULL) return s; | |
2570 | ||
2571 | /* Do an appropriate comparison */ | |
2572 | ||
2573 | switch(cond_type) | |
2574 | { | |
2575 | case ECOND_NUM_E: | |
2576 | case ECOND_NUM_EE: | |
b5b871ac | 2577 | tempcond = (num[0] == num[1]); |
059ec3d9 PH |
2578 | break; |
2579 | ||
2580 | case ECOND_NUM_G: | |
b5b871ac | 2581 | tempcond = (num[0] > num[1]); |
059ec3d9 PH |
2582 | break; |
2583 | ||
2584 | case ECOND_NUM_GE: | |
b5b871ac | 2585 | tempcond = (num[0] >= num[1]); |
059ec3d9 PH |
2586 | break; |
2587 | ||
2588 | case ECOND_NUM_L: | |
b5b871ac | 2589 | tempcond = (num[0] < num[1]); |
059ec3d9 PH |
2590 | break; |
2591 | ||
2592 | case ECOND_NUM_LE: | |
b5b871ac | 2593 | tempcond = (num[0] <= num[1]); |
059ec3d9 PH |
2594 | break; |
2595 | ||
2596 | case ECOND_STR_LT: | |
b5b871ac | 2597 | tempcond = (Ustrcmp(sub[0], sub[1]) < 0); |
059ec3d9 PH |
2598 | break; |
2599 | ||
2600 | case ECOND_STR_LTI: | |
b5b871ac | 2601 | tempcond = (strcmpic(sub[0], sub[1]) < 0); |
059ec3d9 PH |
2602 | break; |
2603 | ||
2604 | case ECOND_STR_LE: | |
b5b871ac | 2605 | tempcond = (Ustrcmp(sub[0], sub[1]) <= 0); |
059ec3d9 PH |
2606 | break; |
2607 | ||
2608 | case ECOND_STR_LEI: | |
b5b871ac | 2609 | tempcond = (strcmpic(sub[0], sub[1]) <= 0); |
059ec3d9 PH |
2610 | break; |
2611 | ||
2612 | case ECOND_STR_EQ: | |
b5b871ac | 2613 | tempcond = (Ustrcmp(sub[0], sub[1]) == 0); |
059ec3d9 PH |
2614 | break; |
2615 | ||
2616 | case ECOND_STR_EQI: | |
b5b871ac | 2617 | tempcond = (strcmpic(sub[0], sub[1]) == 0); |
059ec3d9 PH |
2618 | break; |
2619 | ||
2620 | case ECOND_STR_GT: | |
b5b871ac | 2621 | tempcond = (Ustrcmp(sub[0], sub[1]) > 0); |
059ec3d9 PH |
2622 | break; |
2623 | ||
2624 | case ECOND_STR_GTI: | |
b5b871ac | 2625 | tempcond = (strcmpic(sub[0], sub[1]) > 0); |
059ec3d9 PH |
2626 | break; |
2627 | ||
2628 | case ECOND_STR_GE: | |
b5b871ac | 2629 | tempcond = (Ustrcmp(sub[0], sub[1]) >= 0); |
059ec3d9 PH |
2630 | break; |
2631 | ||
2632 | case ECOND_STR_GEI: | |
b5b871ac | 2633 | tempcond = (strcmpic(sub[0], sub[1]) >= 0); |
059ec3d9 PH |
2634 | break; |
2635 | ||
2636 | case ECOND_MATCH: /* Regular expression match */ | |
2637 | re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset, | |
2638 | NULL); | |
2639 | if (re == NULL) | |
2640 | { | |
2641 | expand_string_message = string_sprintf("regular expression error in " | |
2642 | "\"%s\": %s at offset %d", sub[1], rerror, roffset); | |
2643 | return NULL; | |
2644 | } | |
b5b871ac | 2645 | tempcond = regex_match_and_setup(re, sub[0], 0, -1); |
059ec3d9 PH |
2646 | break; |
2647 | ||
2648 | case ECOND_MATCH_ADDRESS: /* Match in an address list */ | |
2649 | rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL); | |
2650 | goto MATCHED_SOMETHING; | |
2651 | ||
2652 | case ECOND_MATCH_DOMAIN: /* Match in a domain list */ | |
2653 | rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL, | |
2654 | MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL); | |
2655 | goto MATCHED_SOMETHING; | |
2656 | ||
32d668a5 | 2657 | case ECOND_MATCH_IP: /* Match IP address in a host list */ |
7e66e54d | 2658 | if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0) |
32d668a5 PH |
2659 | { |
2660 | expand_string_message = string_sprintf("\"%s\" is not an IP address", | |
2661 | sub[0]); | |
2662 | return NULL; | |
2663 | } | |
2664 | else | |
2665 | { | |
2666 | unsigned int *nullcache = NULL; | |
2667 | check_host_block cb; | |
2668 | ||
2669 | cb.host_name = US""; | |
2670 | cb.host_address = sub[0]; | |
2671 | ||
2672 | /* If the host address starts off ::ffff: it is an IPv6 address in | |
2673 | IPv4-compatible mode. Find the IPv4 part for checking against IPv4 | |
2674 | addresses. */ | |
2675 | ||
2676 | cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)? | |
2677 | cb.host_address + 7 : cb.host_address; | |
2678 | ||
2679 | rc = match_check_list( | |
2680 | &sub[1], /* the list */ | |
2681 | 0, /* separator character */ | |
2682 | &hostlist_anchor, /* anchor pointer */ | |
2683 | &nullcache, /* cache pointer */ | |
2684 | check_host, /* function for testing */ | |
2685 | &cb, /* argument for function */ | |
2686 | MCL_HOST, /* type of check */ | |
2687 | sub[0], /* text for debugging */ | |
2688 | NULL); /* where to pass back data */ | |
2689 | } | |
2690 | goto MATCHED_SOMETHING; | |
2691 | ||
059ec3d9 PH |
2692 | case ECOND_MATCH_LOCAL_PART: |
2693 | rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL, | |
2694 | MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL); | |
2695 | /* Fall through */ | |
9a26b6b2 | 2696 | /* VVVVVVVVVVVV */ |
059ec3d9 PH |
2697 | MATCHED_SOMETHING: |
2698 | switch(rc) | |
2699 | { | |
2700 | case OK: | |
b5b871ac | 2701 | tempcond = TRUE; |
059ec3d9 PH |
2702 | break; |
2703 | ||
2704 | case FAIL: | |
b5b871ac | 2705 | tempcond = FALSE; |
059ec3d9 PH |
2706 | break; |
2707 | ||
2708 | case DEFER: | |
2709 | expand_string_message = string_sprintf("unable to complete match " | |
2710 | "against \"%s\": %s", sub[1], search_error_message); | |
2711 | return NULL; | |
2712 | } | |
2713 | ||
2714 | break; | |
2715 | ||
2716 | /* Various "encrypted" comparisons. If the second string starts with | |
2717 | "{" then an encryption type is given. Default to crypt() or crypt16() | |
2718 | (build-time choice). */ | |
b5b871ac | 2719 | /* }-for-text-editors */ |
059ec3d9 PH |
2720 | |
2721 | case ECOND_CRYPTEQ: | |
2722 | #ifndef SUPPORT_CRYPTEQ | |
2723 | goto COND_FAILED_NOT_COMPILED; | |
2724 | #else | |
2725 | if (strncmpic(sub[1], US"{md5}", 5) == 0) | |
2726 | { | |
2727 | int sublen = Ustrlen(sub[1]+5); | |
2728 | md5 base; | |
2729 | uschar digest[16]; | |
2730 | ||
2731 | md5_start(&base); | |
cfab9d68 | 2732 | md5_end(&base, sub[0], Ustrlen(sub[0]), digest); |
059ec3d9 PH |
2733 | |
2734 | /* If the length that we are comparing against is 24, the MD5 digest | |
2735 | is expressed as a base64 string. This is the way LDAP does it. However, | |
2736 | some other software uses a straightforward hex representation. We assume | |
2737 | this if the length is 32. Other lengths fail. */ | |
2738 | ||
2739 | if (sublen == 24) | |
2740 | { | |
cfab9d68 | 2741 | uschar *coded = b64encode(digest, 16); |
059ec3d9 PH |
2742 | DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n" |
2743 | " subject=%s\n crypted=%s\n", coded, sub[1]+5); | |
b5b871ac | 2744 | tempcond = (Ustrcmp(coded, sub[1]+5) == 0); |
059ec3d9 PH |
2745 | } |
2746 | else if (sublen == 32) | |
2747 | { | |
2748 | int i; | |
2749 | uschar coded[36]; | |
2750 | for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]); | |
2751 | coded[32] = 0; | |
2752 | DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n" | |
2753 | " subject=%s\n crypted=%s\n", coded, sub[1]+5); | |
b5b871ac | 2754 | tempcond = (strcmpic(coded, sub[1]+5) == 0); |
059ec3d9 PH |
2755 | } |
2756 | else | |
2757 | { | |
2758 | DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: " | |
2759 | "fail\n crypted=%s\n", sub[1]+5); | |
b5b871ac | 2760 | tempcond = FALSE; |
059ec3d9 PH |
2761 | } |
2762 | } | |
2763 | ||
2764 | else if (strncmpic(sub[1], US"{sha1}", 6) == 0) | |
2765 | { | |
2766 | int sublen = Ustrlen(sub[1]+6); | |
5fb822fc | 2767 | hctx h; |
059ec3d9 PH |
2768 | uschar digest[20]; |
2769 | ||
5fb822fc | 2770 | sha1_start(&h); |
cfab9d68 | 2771 | sha1_end(&h, sub[0], Ustrlen(sub[0]), digest); |
059ec3d9 PH |
2772 | |
2773 | /* If the length that we are comparing against is 28, assume the SHA1 | |
2774 | digest is expressed as a base64 string. If the length is 40, assume a | |
2775 | straightforward hex representation. Other lengths fail. */ | |
2776 | ||
2777 | if (sublen == 28) | |
2778 | { | |
cfab9d68 | 2779 | uschar *coded = b64encode(digest, 20); |
059ec3d9 PH |
2780 | DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n" |
2781 | " subject=%s\n crypted=%s\n", coded, sub[1]+6); | |
b5b871ac | 2782 | tempcond = (Ustrcmp(coded, sub[1]+6) == 0); |
059ec3d9 PH |
2783 | } |
2784 | else if (sublen == 40) | |
2785 | { | |
2786 | int i; | |
2787 | uschar coded[44]; | |
2788 | for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]); | |
2789 | coded[40] = 0; | |
2790 | DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n" | |
2791 | " subject=%s\n crypted=%s\n", coded, sub[1]+6); | |
b5b871ac | 2792 | tempcond = (strcmpic(coded, sub[1]+6) == 0); |
059ec3d9 PH |
2793 | } |
2794 | else | |
2795 | { | |
2796 | DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: " | |
2797 | "fail\n crypted=%s\n", sub[1]+6); | |
b5b871ac | 2798 | tempcond = FALSE; |
059ec3d9 PH |
2799 | } |
2800 | } | |
2801 | ||
2802 | else /* {crypt} or {crypt16} and non-{ at start */ | |
76dca828 | 2803 | /* }-for-text-editors */ |
059ec3d9 PH |
2804 | { |
2805 | int which = 0; | |
2806 | uschar *coded; | |
2807 | ||
2808 | if (strncmpic(sub[1], US"{crypt}", 7) == 0) | |
2809 | { | |
2810 | sub[1] += 7; | |
2811 | which = 1; | |
2812 | } | |
2813 | else if (strncmpic(sub[1], US"{crypt16}", 9) == 0) | |
2814 | { | |
2815 | sub[1] += 9; | |
2816 | which = 2; | |
2817 | } | |
b5b871ac | 2818 | else if (sub[1][0] == '{') /* }-for-text-editors */ |
059ec3d9 PH |
2819 | { |
2820 | expand_string_message = string_sprintf("unknown encryption mechanism " | |
2821 | "in \"%s\"", sub[1]); | |
2822 | return NULL; | |
2823 | } | |
2824 | ||
2825 | switch(which) | |
2826 | { | |
2827 | case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break; | |
2828 | case 1: coded = US crypt(CS sub[0], CS sub[1]); break; | |
2829 | default: coded = US crypt16(CS sub[0], CS sub[1]); break; | |
2830 | } | |
2831 | ||
2832 | #define STR(s) # s | |
2833 | #define XSTR(s) STR(s) | |
2834 | DEBUG(D_auth) debug_printf("crypteq: using %s()\n" | |
2835 | " subject=%s\n crypted=%s\n", | |
9dc2b215 | 2836 | which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16", |
059ec3d9 PH |
2837 | coded, sub[1]); |
2838 | #undef STR | |
2839 | #undef XSTR | |
2840 | ||
2841 | /* If the encrypted string contains fewer than two characters (for the | |
2842 | salt), force failure. Otherwise we get false positives: with an empty | |
2843 | string the yield of crypt() is an empty string! */ | |
2844 | ||
9dc2b215 JH |
2845 | if (coded) |
2846 | tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0; | |
2847 | else if (errno == EINVAL) | |
2848 | tempcond = FALSE; | |
2849 | else | |
2850 | { | |
2851 | expand_string_message = string_sprintf("crypt error: %s\n", | |
2852 | US strerror(errno)); | |
2853 | return NULL; | |
2854 | } | |
059ec3d9 PH |
2855 | } |
2856 | break; | |
2857 | #endif /* SUPPORT_CRYPTEQ */ | |
76dca828 PP |
2858 | |
2859 | case ECOND_INLIST: | |
2860 | case ECOND_INLISTI: | |
2861 | { | |
55414b25 | 2862 | const uschar * list = sub[1]; |
76dca828 | 2863 | int sep = 0; |
76dca828 PP |
2864 | uschar *save_iterate_item = iterate_item; |
2865 | int (*compare)(const uschar *, const uschar *); | |
2866 | ||
05e796ad | 2867 | DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", name, sub[0]); |
82dbd376 | 2868 | |
b5b871ac | 2869 | tempcond = FALSE; |
55414b25 JH |
2870 | compare = cond_type == ECOND_INLISTI |
2871 | ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp; | |
76dca828 | 2872 | |
55414b25 | 2873 | while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0))) |
05e796ad JH |
2874 | { |
2875 | DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item); | |
76dca828 PP |
2876 | if (compare(sub[0], iterate_item) == 0) |
2877 | { | |
b5b871ac | 2878 | tempcond = TRUE; |
76dca828 PP |
2879 | break; |
2880 | } | |
05e796ad | 2881 | } |
76dca828 | 2882 | iterate_item = save_iterate_item; |
76dca828 PP |
2883 | } |
2884 | ||
059ec3d9 PH |
2885 | } /* Switch for comparison conditions */ |
2886 | ||
b5b871ac | 2887 | *yield = tempcond == testfor; |
059ec3d9 PH |
2888 | return s; /* End of comparison conditions */ |
2889 | ||
2890 | ||
2891 | /* and/or: computes logical and/or of several conditions */ | |
2892 | ||
2893 | case ECOND_AND: | |
2894 | case ECOND_OR: | |
2895 | subcondptr = (yield == NULL)? NULL : &tempcond; | |
2896 | combined_cond = (cond_type == ECOND_AND); | |
2897 | ||
2898 | while (isspace(*s)) s++; | |
b5b871ac | 2899 | if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */ |
059ec3d9 PH |
2900 | |
2901 | for (;;) | |
2902 | { | |
2903 | while (isspace(*s)) s++; | |
b5b871ac | 2904 | /* {-for-text-editors */ |
059ec3d9 | 2905 | if (*s == '}') break; |
b5b871ac | 2906 | if (*s != '{') /* }-for-text-editors */ |
059ec3d9 PH |
2907 | { |
2908 | expand_string_message = string_sprintf("each subcondition " | |
2909 | "inside an \"%s{...}\" condition must be in its own {}", name); | |
2910 | return NULL; | |
2911 | } | |
2912 | ||
b0e85a8f | 2913 | if (!(s = eval_condition(s+1, resetok, subcondptr))) |
059ec3d9 PH |
2914 | { |
2915 | expand_string_message = string_sprintf("%s inside \"%s{...}\" condition", | |
2916 | expand_string_message, name); | |
2917 | return NULL; | |
2918 | } | |
2919 | while (isspace(*s)) s++; | |
2920 | ||
b5b871ac | 2921 | /* {-for-text-editors */ |
059ec3d9 PH |
2922 | if (*s++ != '}') |
2923 | { | |
b5b871ac | 2924 | /* {-for-text-editors */ |
059ec3d9 PH |
2925 | expand_string_message = string_sprintf("missing } at end of condition " |
2926 | "inside \"%s\" group", name); | |
2927 | return NULL; | |
2928 | } | |
2929 | ||
2930 | if (yield != NULL) | |
2931 | { | |
2932 | if (cond_type == ECOND_AND) | |
2933 | { | |
2934 | combined_cond &= tempcond; | |
2935 | if (!combined_cond) subcondptr = NULL; /* once false, don't */ | |
2936 | } /* evaluate any more */ | |
2937 | else | |
2938 | { | |
2939 | combined_cond |= tempcond; | |
2940 | if (combined_cond) subcondptr = NULL; /* once true, don't */ | |
2941 | } /* evaluate any more */ | |
2942 | } | |
2943 | } | |
2944 | ||
2945 | if (yield != NULL) *yield = (combined_cond == testfor); | |
2946 | return ++s; | |
2947 | ||
2948 | ||
0ce9abe6 PH |
2949 | /* forall/forany: iterates a condition with different values */ |
2950 | ||
2951 | case ECOND_FORALL: | |
2952 | case ECOND_FORANY: | |
2953 | { | |
55414b25 | 2954 | const uschar * list; |
0ce9abe6 | 2955 | int sep = 0; |
282b357d | 2956 | uschar *save_iterate_item = iterate_item; |
0ce9abe6 | 2957 | |
e1d04f48 | 2958 | DEBUG(D_expand) debug_printf_indent("condition: %s\n", name); |
82dbd376 | 2959 | |
0ce9abe6 | 2960 | while (isspace(*s)) s++; |
b5b871ac | 2961 | if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */ |
b0e85a8f | 2962 | sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok); |
0ce9abe6 | 2963 | if (sub[0] == NULL) return NULL; |
b5b871ac | 2964 | /* {-for-text-editors */ |
0ce9abe6 PH |
2965 | if (*s++ != '}') goto COND_FAILED_CURLY_END; |
2966 | ||
2967 | while (isspace(*s)) s++; | |
b5b871ac | 2968 | if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */ |
0ce9abe6 PH |
2969 | |
2970 | sub[1] = s; | |
2971 | ||
2972 | /* Call eval_condition once, with result discarded (as if scanning a | |
2973 | "false" part). This allows us to find the end of the condition, because if | |
2974 | the list it empty, we won't actually evaluate the condition for real. */ | |
2975 | ||
b0e85a8f | 2976 | if (!(s = eval_condition(sub[1], resetok, NULL))) |
0ce9abe6 PH |
2977 | { |
2978 | expand_string_message = string_sprintf("%s inside \"%s\" condition", | |
2979 | expand_string_message, name); | |
2980 | return NULL; | |
2981 | } | |
2982 | while (isspace(*s)) s++; | |
2983 | ||
b5b871ac | 2984 | /* {-for-text-editors */ |
0ce9abe6 PH |
2985 | if (*s++ != '}') |
2986 | { | |
b5b871ac | 2987 | /* {-for-text-editors */ |
0ce9abe6 PH |
2988 | expand_string_message = string_sprintf("missing } at end of condition " |
2989 | "inside \"%s\"", name); | |
2990 | return NULL; | |
2991 | } | |
2992 | ||
2993 | if (yield != NULL) *yield = !testfor; | |
55414b25 JH |
2994 | list = sub[0]; |
2995 | while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL) | |
0ce9abe6 | 2996 | { |
e1d04f48 | 2997 | DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, iterate_item); |
b0e85a8f | 2998 | if (!eval_condition(sub[1], resetok, &tempcond)) |
0ce9abe6 PH |
2999 | { |
3000 | expand_string_message = string_sprintf("%s inside \"%s\" condition", | |
3001 | expand_string_message, name); | |
e58c13cc | 3002 | iterate_item = save_iterate_item; |
0ce9abe6 PH |
3003 | return NULL; |
3004 | } | |
e1d04f48 | 3005 | DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", name, |
0ce9abe6 PH |
3006 | tempcond? "true":"false"); |
3007 | ||
3008 | if (yield != NULL) *yield = (tempcond == testfor); | |
3009 | if (tempcond == (cond_type == ECOND_FORANY)) break; | |
3010 | } | |
3011 | ||
282b357d | 3012 | iterate_item = save_iterate_item; |
0ce9abe6 PH |
3013 | return s; |
3014 | } | |
3015 | ||
3016 | ||
f3766eb5 NM |
3017 | /* The bool{} expansion condition maps a string to boolean. |
3018 | The values supported should match those supported by the ACL condition | |
3019 | (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas | |
3020 | of true/false. Note that Router "condition" rules have a different | |
3021 | interpretation, where general data can be used and only a few values | |
3022 | map to FALSE. | |
3023 | Note that readconf.c boolean matching, for boolean configuration options, | |
6a8de854 PP |
3024 | only matches true/yes/false/no. |
3025 | The bool_lax{} condition matches the Router logic, which is much more | |
3026 | liberal. */ | |
f3766eb5 | 3027 | case ECOND_BOOL: |
6a8de854 | 3028 | case ECOND_BOOL_LAX: |
f3766eb5 NM |
3029 | { |
3030 | uschar *sub_arg[1]; | |
71265ae9 | 3031 | uschar *t, *t2; |
6a8de854 | 3032 | uschar *ourname; |
f3766eb5 NM |
3033 | size_t len; |
3034 | BOOL boolvalue = FALSE; | |
3035 | while (isspace(*s)) s++; | |
b5b871ac | 3036 | if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */ |
6a8de854 | 3037 | ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool"; |
b0e85a8f | 3038 | switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok)) |
f3766eb5 | 3039 | { |
6a8de854 PP |
3040 | case 1: expand_string_message = string_sprintf( |
3041 | "too few arguments or bracketing error for %s", | |
3042 | ourname); | |
f3766eb5 NM |
3043 | /*FALLTHROUGH*/ |
3044 | case 2: | |
3045 | case 3: return NULL; | |
3046 | } | |
3047 | t = sub_arg[0]; | |
3048 | while (isspace(*t)) t++; | |
3049 | len = Ustrlen(t); | |
71265ae9 PP |
3050 | if (len) |
3051 | { | |
3052 | /* trailing whitespace: seems like a good idea to ignore it too */ | |
3053 | t2 = t + len - 1; | |
3054 | while (isspace(*t2)) t2--; | |
3055 | if (t2 != (t + len)) | |
3056 | { | |
3057 | *++t2 = '\0'; | |
3058 | len = t2 - t; | |
3059 | } | |
3060 | } | |
f3766eb5 | 3061 | DEBUG(D_expand) |
e1d04f48 | 3062 | debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>"); |
6a8de854 PP |
3063 | /* logic for the lax case from expand_check_condition(), which also does |
3064 | expands, and the logic is both short and stable enough that there should | |
3065 | be no maintenance burden from replicating it. */ | |
f3766eb5 NM |
3066 | if (len == 0) |
3067 | boolvalue = FALSE; | |
51c7471d JH |
3068 | else if (*t == '-' |
3069 | ? Ustrspn(t+1, "0123456789") == len-1 | |
3070 | : Ustrspn(t, "0123456789") == len) | |
6a8de854 | 3071 | { |
f3766eb5 | 3072 | boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE; |
6a8de854 PP |
3073 | /* expand_check_condition only does a literal string "0" check */ |
3074 | if ((cond_type == ECOND_BOOL_LAX) && (len > 1)) | |
3075 | boolvalue = TRUE; | |
3076 | } | |
f3766eb5 NM |
3077 | else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0) |
3078 | boolvalue = TRUE; | |
3079 | else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0) | |
3080 | boolvalue = FALSE; | |
6a8de854 PP |
3081 | else if (cond_type == ECOND_BOOL_LAX) |
3082 | boolvalue = TRUE; | |
f3766eb5 NM |
3083 | else |
3084 | { | |
3085 | expand_string_message = string_sprintf("unrecognised boolean " | |
3086 | "value \"%s\"", t); | |
3087 | return NULL; | |
3088 | } | |
e1d04f48 | 3089 | DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname, |
c7c833c6 | 3090 | boolvalue? "true":"false"); |
5ee6f336 | 3091 | if (yield != NULL) *yield = (boolvalue == testfor); |
f3766eb5 NM |
3092 | return s; |
3093 | } | |
3094 | ||
059ec3d9 PH |
3095 | /* Unknown condition */ |
3096 | ||
3097 | default: | |
3098 | expand_string_message = string_sprintf("unknown condition \"%s\"", name); | |
3099 | return NULL; | |
3100 | } /* End switch on condition type */ | |
3101 | ||
3102 | /* Missing braces at start and end of data */ | |
3103 | ||
3104 | COND_FAILED_CURLY_START: | |
3105 | expand_string_message = string_sprintf("missing { after \"%s\"", name); | |
3106 | return NULL; | |
3107 | ||
3108 | COND_FAILED_CURLY_END: | |
3109 | expand_string_message = string_sprintf("missing } at end of \"%s\" condition", | |
3110 | name); | |
3111 | return NULL; | |
3112 | ||
3113 | /* A condition requires code that is not compiled */ | |
3114 | ||
3115 | #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \ | |
3116 | !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \ | |
3117 | !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET) | |
3118 | COND_FAILED_NOT_COMPILED: | |
3119 | expand_string_message = string_sprintf("support for \"%s\" not compiled", | |
3120 | name); | |
3121 | return NULL; | |
3122 | #endif | |
3123 | } | |
3124 | ||
3125 | ||
3126 | ||
3127 | ||
3128 | /************************************************* | |
3129 | * Save numerical variables * | |
3130 | *************************************************/ | |
3131 | ||
3132 | /* This function is called from items such as "if" that want to preserve and | |
3133 | restore the numbered variables. | |
3134 | ||
3135 | Arguments: | |
3136 | save_expand_string points to an array of pointers to set | |
3137 | save_expand_nlength points to an array of ints for the lengths | |
3138 | ||
3139 | Returns: the value of expand max to save | |
3140 | */ | |
3141 | ||
3142 | static int | |
3143 | save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength) | |
3144 | { | |
3145 | int i; | |
3146 | for (i = 0; i <= expand_nmax; i++) | |
3147 | { | |
3148 | save_expand_nstring[i] = expand_nstring[i]; | |
3149 | save_expand_nlength[i] = expand_nlength[i]; | |
3150 | } | |
3151 | return expand_nmax; | |
3152 | } | |
3153 | ||
3154 | ||
3155 | ||
3156 | /************************************************* | |
3157 | * Restore numerical variables * | |
3158 | *************************************************/ | |
3159 | ||
3160 | /* This function restored saved values of numerical strings. | |
3161 | ||
3162 | Arguments: | |
3163 | save_expand_nmax the number of strings to restore | |
3164 | save_expand_string points to an array of pointers | |
3165 | save_expand_nlength points to an array of ints | |
3166 | ||
3167 | Returns: nothing | |
3168 | */ | |
3169 | ||
3170 | static void | |
3171 | restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring, | |
3172 | int *save_expand_nlength) | |
3173 | { | |
3174 | int i; | |
3175 | expand_nmax = save_expand_nmax; | |
3176 | for (i = 0; i <= expand_nmax; i++) | |
3177 | { | |
3178 | expand_nstring[i] = save_expand_nstring[i]; | |
3179 | expand_nlength[i] = save_expand_nlength[i]; | |
3180 | } | |
3181 | } | |
3182 | ||
3183 | ||
3184 | ||
3185 | ||
3186 | ||
3187 | /************************************************* | |
3188 | * Handle yes/no substrings * | |
3189 | *************************************************/ | |
3190 | ||
3191 | /* This function is used by ${if}, ${lookup} and ${extract} to handle the | |
3192 | alternative substrings that depend on whether or not the condition was true, | |
3193 | or the lookup or extraction succeeded. The substrings always have to be | |
3194 | expanded, to check their syntax, but "skipping" is set when the result is not | |
3195 | needed - this avoids unnecessary nested lookups. | |
3196 | ||
3197 | Arguments: | |
3198 | skipping TRUE if we were skipping when this item was reached | |
3199 | yes TRUE if the first string is to be used, else use the second | |
3200 | save_lookup a value to put back into lookup_value before the 2nd expansion | |
3201 | sptr points to the input string pointer | |
acec9514 | 3202 | yieldptr points to the output growable-string pointer |
f90d49f7 JH |
3203 | type "lookup", "if", "extract", "run", "env", "listextract" or |
3204 | "certextract" for error message | |
b0e85a8f JH |
3205 | resetok if not NULL, pointer to flag - write FALSE if unsafe to reset |
3206 | the store. | |
059ec3d9 PH |
3207 | |
3208 | Returns: 0 OK; lookup_value has been reset to save_lookup | |
3209 | 1 expansion failed | |
3210 | 2 expansion failed because of bracketing error | |
3211 | */ | |
3212 | ||
3213 | static int | |
55414b25 | 3214 | process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr, |
acec9514 | 3215 | gstring ** yieldptr, uschar *type, BOOL *resetok) |
059ec3d9 PH |
3216 | { |
3217 | int rc = 0; | |
55414b25 | 3218 | const uschar *s = *sptr; /* Local value */ |
059ec3d9 | 3219 | uschar *sub1, *sub2; |
e47376be | 3220 | const uschar * errwhere; |
059ec3d9 PH |
3221 | |
3222 | /* If there are no following strings, we substitute the contents of $value for | |
063b1e99 | 3223 | lookups and for extractions in the success case. For the ${if item, the string |
8e669ac1 | 3224 | "true" is substituted. In the fail case, nothing is substituted for all three |
063b1e99 | 3225 | items. */ |
059ec3d9 PH |
3226 | |
3227 | while (isspace(*s)) s++; | |
3228 | if (*s == '}') | |
3229 | { | |
9e09521e JH |
3230 | if (type[0] == 'i') |
3231 | { | |
3232 | if (yes && !skipping) | |
acec9514 | 3233 | *yieldptr = string_catn(*yieldptr, US"true", 4); |
9e09521e JH |
3234 | } |
3235 | else | |
3236 | { | |
3237 | if (yes && lookup_value && !skipping) | |
acec9514 | 3238 | *yieldptr = string_cat(*yieldptr, lookup_value); |
9e09521e JH |
3239 | lookup_value = save_lookup; |
3240 | } | |
059ec3d9 PH |
3241 | s++; |
3242 | goto RETURN; | |
3243 | } | |
3244 | ||
9b4768fa PH |
3245 | /* The first following string must be braced. */ |
3246 | ||
e47376be JH |
3247 | if (*s++ != '{') |
3248 | { | |
3249 | errwhere = US"'yes' part did not start with '{'"; | |
3250 | goto FAILED_CURLY; | |
3251 | } | |
9b4768fa | 3252 | |
059ec3d9 PH |
3253 | /* Expand the first substring. Forced failures are noticed only if we actually |
3254 | want this string. Set skipping in the call in the fail case (this will always | |
3255 | be the case if we were already skipping). */ | |
3256 | ||
b0e85a8f | 3257 | sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok); |
059ec3d9 PH |
3258 | if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED; |
3259 | expand_string_forcedfail = FALSE; | |
e47376be JH |
3260 | if (*s++ != '}') |
3261 | { | |
3262 | errwhere = US"'yes' part did not end with '}'"; | |
3263 | goto FAILED_CURLY; | |
3264 | } | |
059ec3d9 PH |
3265 | |
3266 | /* If we want the first string, add it to the output */ | |
3267 | ||
3268 | if (yes) | |
acec9514 | 3269 | *yieldptr = string_cat(*yieldptr, sub1); |
059ec3d9 | 3270 | |
fa01e4f8 JH |
3271 | /* If this is called from a lookup/env or a (cert)extract, we want to restore |
3272 | $value to what it was at the start of the item, so that it has this value | |
3273 | during the second string expansion. For the call from "if" or "run" to this | |
3274 | function, save_lookup is set to lookup_value, so that this statement does | |
3275 | nothing. */ | |
059ec3d9 PH |
3276 | |
3277 | lookup_value = save_lookup; | |
3278 | ||
3279 | /* There now follows either another substring, or "fail", or nothing. This | |
3280 | time, forced failures are noticed only if we want the second string. We must | |
3281 | set skipping in the nested call if we don't want this string, or if we were | |
3282 | already skipping. */ | |
3283 | ||
3284 | while (isspace(*s)) s++; | |
3285 | if (*s == '{') | |
3286 | { | |
b0e85a8f | 3287 | sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok); |
059ec3d9 PH |
3288 | if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED; |
3289 | expand_string_forcedfail = FALSE; | |
e47376be JH |
3290 | if (*s++ != '}') |
3291 | { | |
3292 | errwhere = US"'no' part did not start with '{'"; | |
3293 | goto FAILED_CURLY; | |
3294 | } | |
059ec3d9 PH |
3295 | |
3296 | /* If we want the second string, add it to the output */ | |
3297 | ||
3298 | if (!yes) | |
acec9514 | 3299 | *yieldptr = string_cat(*yieldptr, sub2); |
059ec3d9 PH |
3300 | } |
3301 | ||
3302 | /* If there is no second string, but the word "fail" is present when the use of | |
3303 | the second string is wanted, set a flag indicating it was a forced failure | |
3304 | rather than a syntactic error. Swallow the terminating } in case this is nested | |
3305 | inside another lookup or if or extract. */ | |
3306 | ||
3307 | else if (*s != '}') | |
3308 | { | |
3309 | uschar name[256]; | |
55414b25 JH |
3310 | /* deconst cast ok here as source is s anyway */ |
3311 | s = US read_name(name, sizeof(name), s, US"_"); | |
059ec3d9 PH |
3312 | if (Ustrcmp(name, "fail") == 0) |
3313 | { | |
3314 | if (!yes && !skipping) | |
3315 | { | |
3316 | while (isspace(*s)) s++; | |
e47376be JH |
3317 | if (*s++ != '}') |
3318 | { | |
3319 | errwhere = US"did not close with '}' after forcedfail"; | |
3320 | goto FAILED_CURLY; | |
3321 | } | |
059ec3d9 PH |
3322 | expand_string_message = |
3323 | string_sprintf("\"%s\" failed and \"fail\" requested", type); | |
3324 | expand_string_forcedfail = TRUE; | |
3325 | goto FAILED; | |
3326 | } | |
3327 | } | |
3328 | else | |
3329 | { | |
3330 | expand_string_message = | |
3331 | string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type); | |
3332 | goto FAILED; | |
3333 | } | |
3334 | } | |
3335 | ||
3336 | /* All we have to do now is to check on the final closing brace. */ | |
3337 | ||
3338 | while (isspace(*s)) s++; | |
e47376be JH |
3339 | if (*s++ != '}') |
3340 | { | |
3341 | errwhere = US"did not close with '}'"; | |
3342 | goto FAILED_CURLY; | |
3343 | } | |
059ec3d9 | 3344 | |
059ec3d9 PH |
3345 | |
3346 | RETURN: | |
e47376be | 3347 | /* Update the input pointer value before returning */ |
059ec3d9 PH |
3348 | *sptr = s; |
3349 | return rc; | |
e47376be JH |
3350 | |
3351 | FAILED_CURLY: | |
3352 | /* Get here if there is a bracketing failure */ | |
3353 | expand_string_message = string_sprintf( | |
3354 | "curly-bracket problem in conditional yes/no parsing: %s\n" | |
3355 | " remaining string is '%s'", errwhere, --s); | |
3356 | rc = 2; | |
3357 | goto RETURN; | |
3358 | ||
3359 | FAILED: | |
3360 | /* Get here for other failures */ | |
3361 | rc = 1; | |
3362 | goto RETURN; | |
059ec3d9 PH |
3363 | } |
3364 | ||
3365 | ||
3366 | ||
3367 | ||
059ec3d9 PH |
3368 | /************************************************* |
3369 | * Handle MD5 or SHA-1 computation for HMAC * | |
3370 | *************************************************/ | |
3371 | ||
3372 | /* These are some wrapping functions that enable the HMAC code to be a bit | |
3373 | cleaner. A good compiler will spot the tail recursion. | |
3374 | ||
3375 | Arguments: | |
3376 | type HMAC_MD5 or HMAC_SHA1 | |
3377 | remaining are as for the cryptographic hash functions | |
3378 | ||
3379 | Returns: nothing | |
3380 | */ | |
3381 | ||
3382 | static void | |
3383 | chash_start(int type, void *base) | |
3384 | { | |
3385 | if (type == HMAC_MD5) | |
3386 | md5_start((md5 *)base); | |
3387 | else | |
5fb822fc | 3388 | sha1_start((hctx *)base); |
059ec3d9 PH |
3389 | } |
3390 | ||
3391 | static void | |
3392 | chash_mid(int type, void *base, uschar *string) | |
3393 | { | |
3394 | if (type == HMAC_MD5) | |
3395 | md5_mid((md5 *)base, string); | |
3396 | else | |
5fb822fc | 3397 | sha1_mid((hctx *)base, string); |
059ec3d9 PH |
3398 | } |
3399 | ||
3400 | static void | |
3401 | chash_end(int type, void *base, uschar *string, int length, uschar *digest) | |
3402 | { | |
3403 | if (type == HMAC_MD5) | |
3404 | md5_end((md5 *)base, string, length, digest); | |
3405 | else | |
5fb822fc | 3406 | sha1_end((hctx *)base, string, length, digest); |
059ec3d9 PH |
3407 | } |
3408 | ||
3409 | ||
3410 | ||
3411 | ||
3412 | ||
1549ea3b PH |
3413 | /******************************************************** |
3414 | * prvs: Get last three digits of days since Jan 1, 1970 * | |
3415 | ********************************************************/ | |
3416 | ||
3417 | /* This is needed to implement the "prvs" BATV reverse | |
3418 | path signing scheme | |
3419 | ||
3420 | Argument: integer "days" offset to add or substract to | |
3421 | or from the current number of days. | |
3422 | ||
3423 | Returns: pointer to string containing the last three | |
3424 | digits of the number of days since Jan 1, 1970, | |
3425 | modified by the offset argument, NULL if there | |
3426 | was an error in the conversion. | |
3427 | ||
3428 | */ | |
3429 | ||
3430 | static uschar * | |
3431 | prvs_daystamp(int day_offset) | |
3432 | { | |
a86229cf PH |
3433 | uschar *days = store_get(32); /* Need at least 24 for cases */ |
3434 | (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */ | |
1549ea3b | 3435 | (time(NULL) + day_offset*86400)/86400); |
e169f567 | 3436 | return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100"; |
1549ea3b PH |
3437 | } |
3438 | ||
3439 | ||
3440 | ||
3441 | /******************************************************** | |
3442 | * prvs: perform HMAC-SHA1 computation of prvs bits * | |
3443 | ********************************************************/ | |
3444 | ||
3445 | /* This is needed to implement the "prvs" BATV reverse | |
3446 | path signing scheme | |
3447 | ||
3448 | Arguments: | |
3449 | address RFC2821 Address to use | |
3450 | key The key to use (must be less than 64 characters | |
3451 | in size) | |
3452 | key_num Single-digit key number to use. Defaults to | |
3453 | '0' when NULL. | |
3454 | ||
3455 | Returns: pointer to string containing the first three | |
3456 | bytes of the final hash in hex format, NULL if | |
3457 | there was an error in the process. | |
3458 | */ | |
3459 | ||
3460 | static uschar * | |
3461 | prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp) | |
3462 | { | |
acec9514 JH |
3463 | gstring * hash_source; |
3464 | uschar * p; | |
3465 | int i; | |
5fb822fc | 3466 | hctx h; |
1549ea3b PH |
3467 | uschar innerhash[20]; |
3468 | uschar finalhash[20]; | |
3469 | uschar innerkey[64]; | |
3470 | uschar outerkey[64]; | |
3471 | uschar *finalhash_hex = store_get(40); | |
3472 | ||
3473 | if (key_num == NULL) | |
3474 | key_num = US"0"; | |
3475 | ||
3476 | if (Ustrlen(key) > 64) | |
3477 | return NULL; | |
3478 | ||
acec9514 JH |
3479 | hash_source = string_catn(NULL, key_num, 1); |
3480 | hash_source = string_catn(hash_source, daystamp, 3); | |
3481 | hash_source = string_cat(hash_source, address); | |
3482 | (void) string_from_gstring(hash_source); | |
1549ea3b | 3483 | |
acec9514 JH |
3484 | DEBUG(D_expand) |
3485 | debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s); | |
1549ea3b PH |
3486 | |
3487 | memset(innerkey, 0x36, 64); | |
3488 | memset(outerkey, 0x5c, 64); | |
3489 | ||
3490 | for (i = 0; i < Ustrlen(key); i++) | |
3491 | { | |
3492 | innerkey[i] ^= key[i]; | |
3493 | outerkey[i] ^= key[i]; | |
3494 | } | |
3495 | ||
5fb822fc JH |
3496 | chash_start(HMAC_SHA1, &h); |
3497 | chash_mid(HMAC_SHA1, &h, innerkey); | |
acec9514 | 3498 | chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash); |
1549ea3b | 3499 | |
5fb822fc JH |
3500 | chash_start(HMAC_SHA1, &h); |
3501 | chash_mid(HMAC_SHA1, &h, outerkey); | |
3502 | chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash); | |
1549ea3b PH |
3503 | |
3504 | p = finalhash_hex; | |
3505 | for (i = 0; i < 3; i++) | |
3506 | { | |
3507 | *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4]; | |
3508 | *p++ = hex_digits[finalhash[i] & 0x0f]; | |
3509 | } | |
3510 | *p = '\0'; | |
3511 | ||
3512 | return finalhash_hex; | |
3513 | } | |
3514 | ||
3515 | ||
3516 | ||
3517 | ||
059ec3d9 PH |
3518 | /************************************************* |
3519 | * Join a file onto the output string * | |
3520 | *************************************************/ | |
3521 | ||
fa01e4f8 JH |
3522 | /* This is used for readfile/readsock and after a run expansion. |
3523 | It joins the contents of a file onto the output string, globally replacing | |
3524 | newlines with a given string (optionally). | |
059ec3d9 PH |
3525 | |
3526 | Arguments: | |
3527 | f the FILE | |
acec9514 | 3528 | yield pointer to the expandable string struct |
059ec3d9 PH |
3529 | eol newline replacement string, or NULL |
3530 | ||
acec9514 | 3531 | Returns: new pointer for expandable string, terminated if non-null |
059ec3d9 PH |
3532 | */ |
3533 | ||
acec9514 JH |
3534 | static gstring * |
3535 | cat_file(FILE *f, gstring *yield, uschar *eol) | |
059ec3d9 | 3536 | { |
059ec3d9 PH |
3537 | uschar buffer[1024]; |
3538 | ||
fa01e4f8 | 3539 | while (Ufgets(buffer, sizeof(buffer), f)) |
059ec3d9 PH |
3540 | { |
3541 | int len = Ustrlen(buffer); | |
fa01e4f8 | 3542 | if (eol && buffer[len-1] == '\n') len--; |
acec9514 | 3543 | yield = string_catn(yield, buffer, len); |
8487aee9 | 3544 | if (eol && buffer[len]) |
acec9514 | 3545 | yield = string_cat(yield, eol); |
059ec3d9 PH |
3546 | } |
3547 | ||
acec9514 | 3548 | (void) string_from_gstring(yield); |
059ec3d9 PH |
3549 | return yield; |
3550 | } | |
3551 | ||
3552 | ||
3553 |