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