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