1 /* $Cambridge: exim/src/src/expand.c,v 1.70 2006/11/13 12:07:46 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2006 */
8 /* See the file NOTICE for conditions of use and distribution. */
11 /* Functions for handling string expansion. */
17 #ifndef SUPPORT_CRYPTEQ
18 #define SUPPORT_CRYPTEQ
22 #ifdef SUPPORT_CRYPTEQ
27 extern char* crypt16(char*, char*);
32 #include "lookups/ldap.h"
37 /* Recursively called function */
39 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL);
43 /*************************************************
44 * Local statics and tables *
45 *************************************************/
47 /* Table of item names, and corresponding switch numbers. The names must be in
48 alphabetical order. */
50 static uschar *item_table[] = {
88 /* Tables of operator names, and corresponding switch numbers. The names must be
89 in alphabetical order. There are two tables, because underscore is used in some
90 cases to introduce arguments, whereas for other it is part of the name. This is
91 an historical mis-design. */
93 static uschar *op_table_underscore[] = {
103 EOP_QUOTE_LOCAL_PART,
107 static uschar *op_table_main[] = {
138 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
168 /* Table of condition names, and corresponding switch numbers. The names must
169 be in alphabetical order. */
171 static uschar *cond_table[] = {
175 US"==", /* Backward compatibility */
201 US"match_local_part",
223 ECOND_FIRST_DELIVERY,
240 ECOND_MATCH_LOCAL_PART,
250 /* Type for main variable table */
258 /* Type for entries pointing to address/length pairs. Not currently
266 /* Types of table entry */
269 vtype_int, /* value is address of int */
270 vtype_filter_int, /* ditto, but recognized only when filtering */
271 vtype_ino, /* value is address of ino_t (not always an int) */
272 vtype_uid, /* value is address of uid_t (not always an int) */
273 vtype_gid, /* value is address of gid_t (not always an int) */
274 vtype_stringptr, /* value is address of pointer to string */
275 vtype_msgbody, /* as stringptr, but read when first required */
276 vtype_msgbody_end, /* ditto, the end of the message */
277 vtype_msgheaders, /* the message's headers, processed */
278 vtype_msgheaders_raw, /* the message's headers, unprocessed */
279 vtype_localpart, /* extract local part from string */
280 vtype_domain, /* extract domain from string */
281 vtype_recipients, /* extract recipients from recipients list */
282 /* (enabled only during system filtering */
283 vtype_todbsdin, /* value not used; generate BSD inbox tod */
284 vtype_tode, /* value not used; generate tod in epoch format */
285 vtype_todf, /* value not used; generate full tod */
286 vtype_todl, /* value not used; generate log tod */
287 vtype_todlf, /* value not used; generate log file datestamp tod */
288 vtype_todzone, /* value not used; generate time zone only */
289 vtype_todzulu, /* value not used; generate zulu tod */
290 vtype_reply, /* value not used; get reply from headers */
291 vtype_pid, /* value not used; result is pid */
292 vtype_host_lookup, /* value not used; get host name */
293 vtype_load_avg, /* value not used; result is int from os_getloadavg */
294 vtype_pspace, /* partition space; value is T/F for spool/log */
295 vtype_pinodes /* partition inodes; value is T/F for spool/log */
296 #ifdef EXPERIMENTAL_DOMAINKEYS
297 ,vtype_dk_verify /* Serve request out of DomainKeys verification structure */
301 /* This table must be kept in alphabetical order. */
303 static var_entry var_table[] = {
304 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
305 they will be confused with user-creatable ACL variables. */
306 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
307 { "address_data", vtype_stringptr, &deliver_address_data },
308 { "address_file", vtype_stringptr, &address_file },
309 { "address_pipe", vtype_stringptr, &address_pipe },
310 { "authenticated_id", vtype_stringptr, &authenticated_id },
311 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
312 { "authentication_failed",vtype_int, &authentication_failed },
313 #ifdef EXPERIMENTAL_BRIGHTMAIL
314 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
315 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
316 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
317 { "bmi_deliver", vtype_int, &bmi_deliver },
319 { "body_linecount", vtype_int, &body_linecount },
320 { "body_zerocount", vtype_int, &body_zerocount },
321 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
322 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
323 { "caller_gid", vtype_gid, &real_gid },
324 { "caller_uid", vtype_uid, &real_uid },
325 { "compile_date", vtype_stringptr, &version_date },
326 { "compile_number", vtype_stringptr, &version_cnumber },
327 { "csa_status", vtype_stringptr, &csa_status },
328 #ifdef WITH_OLD_DEMIME
329 { "demime_errorlevel", vtype_int, &demime_errorlevel },
330 { "demime_reason", vtype_stringptr, &demime_reason },
332 #ifdef EXPERIMENTAL_DOMAINKEYS
333 { "dk_domain", vtype_stringptr, &dk_signing_domain },
334 { "dk_is_signed", vtype_dk_verify, NULL },
335 { "dk_result", vtype_dk_verify, NULL },
336 { "dk_selector", vtype_stringptr, &dk_signing_selector },
337 { "dk_sender", vtype_dk_verify, NULL },
338 { "dk_sender_domain", vtype_dk_verify, NULL },
339 { "dk_sender_local_part",vtype_dk_verify, NULL },
340 { "dk_sender_source", vtype_dk_verify, NULL },
341 { "dk_signsall", vtype_dk_verify, NULL },
342 { "dk_status", vtype_dk_verify, NULL },
343 { "dk_testing", vtype_dk_verify, NULL },
345 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
346 { "dnslist_text", vtype_stringptr, &dnslist_text },
347 { "dnslist_value", vtype_stringptr, &dnslist_value },
348 { "domain", vtype_stringptr, &deliver_domain },
349 { "domain_data", vtype_stringptr, &deliver_domain_data },
350 { "exim_gid", vtype_gid, &exim_gid },
351 { "exim_path", vtype_stringptr, &exim_path },
352 { "exim_uid", vtype_uid, &exim_uid },
353 #ifdef WITH_OLD_DEMIME
354 { "found_extension", vtype_stringptr, &found_extension },
356 { "home", vtype_stringptr, &deliver_home },
357 { "host", vtype_stringptr, &deliver_host },
358 { "host_address", vtype_stringptr, &deliver_host_address },
359 { "host_data", vtype_stringptr, &host_data },
360 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
361 { "host_lookup_failed", vtype_int, &host_lookup_failed },
362 { "inode", vtype_ino, &deliver_inode },
363 { "interface_address", vtype_stringptr, &interface_address },
364 { "interface_port", vtype_int, &interface_port },
366 { "ldap_dn", vtype_stringptr, &eldap_dn },
368 { "load_average", vtype_load_avg, NULL },
369 { "local_part", vtype_stringptr, &deliver_localpart },
370 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
371 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
372 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
373 { "local_scan_data", vtype_stringptr, &local_scan_data },
374 { "local_user_gid", vtype_gid, &local_user_gid },
375 { "local_user_uid", vtype_uid, &local_user_uid },
376 { "localhost_number", vtype_int, &host_number },
377 { "log_inodes", vtype_pinodes, (void *)FALSE },
378 { "log_space", vtype_pspace, (void *)FALSE },
379 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
380 #ifdef WITH_CONTENT_SCAN
381 { "malware_name", vtype_stringptr, &malware_name },
383 { "message_age", vtype_int, &message_age },
384 { "message_body", vtype_msgbody, &message_body },
385 { "message_body_end", vtype_msgbody_end, &message_body_end },
386 { "message_body_size", vtype_int, &message_body_size },
387 { "message_exim_id", vtype_stringptr, &message_id },
388 { "message_headers", vtype_msgheaders, NULL },
389 { "message_headers_raw", vtype_msgheaders_raw, NULL },
390 { "message_id", vtype_stringptr, &message_id },
391 { "message_linecount", vtype_int, &message_linecount },
392 { "message_size", vtype_int, &message_size },
393 #ifdef WITH_CONTENT_SCAN
394 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
395 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
396 { "mime_boundary", vtype_stringptr, &mime_boundary },
397 { "mime_charset", vtype_stringptr, &mime_charset },
398 { "mime_content_description", vtype_stringptr, &mime_content_description },
399 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
400 { "mime_content_id", vtype_stringptr, &mime_content_id },
401 { "mime_content_size", vtype_int, &mime_content_size },
402 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
403 { "mime_content_type", vtype_stringptr, &mime_content_type },
404 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
405 { "mime_filename", vtype_stringptr, &mime_filename },
406 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
407 { "mime_is_multipart", vtype_int, &mime_is_multipart },
408 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
409 { "mime_part_count", vtype_int, &mime_part_count },
411 { "n0", vtype_filter_int, &filter_n[0] },
412 { "n1", vtype_filter_int, &filter_n[1] },
413 { "n2", vtype_filter_int, &filter_n[2] },
414 { "n3", vtype_filter_int, &filter_n[3] },
415 { "n4", vtype_filter_int, &filter_n[4] },
416 { "n5", vtype_filter_int, &filter_n[5] },
417 { "n6", vtype_filter_int, &filter_n[6] },
418 { "n7", vtype_filter_int, &filter_n[7] },
419 { "n8", vtype_filter_int, &filter_n[8] },
420 { "n9", vtype_filter_int, &filter_n[9] },
421 { "original_domain", vtype_stringptr, &deliver_domain_orig },
422 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
423 { "originator_gid", vtype_gid, &originator_gid },
424 { "originator_uid", vtype_uid, &originator_uid },
425 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
426 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
427 { "pid", vtype_pid, NULL },
428 { "primary_hostname", vtype_stringptr, &primary_hostname },
429 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
430 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
431 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
432 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
433 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
434 { "rcpt_count", vtype_int, &rcpt_count },
435 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
436 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
437 { "received_count", vtype_int, &received_count },
438 { "received_for", vtype_stringptr, &received_for },
439 { "received_ip_address", vtype_stringptr, &interface_address },
440 { "received_port", vtype_int, &interface_port },
441 { "received_protocol", vtype_stringptr, &received_protocol },
442 { "received_time", vtype_int, &received_time },
443 { "recipient_data", vtype_stringptr, &recipient_data },
444 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
445 { "recipients", vtype_recipients, NULL },
446 { "recipients_count", vtype_int, &recipients_count },
447 #ifdef WITH_CONTENT_SCAN
448 { "regex_match_string", vtype_stringptr, ®ex_match_string },
450 { "reply_address", vtype_reply, NULL },
451 { "return_path", vtype_stringptr, &return_path },
452 { "return_size_limit", vtype_int, &bounce_return_size_limit },
453 { "runrc", vtype_int, &runrc },
454 { "self_hostname", vtype_stringptr, &self_hostname },
455 { "sender_address", vtype_stringptr, &sender_address },
456 { "sender_address_data", vtype_stringptr, &sender_address_data },
457 { "sender_address_domain", vtype_domain, &sender_address },
458 { "sender_address_local_part", vtype_localpart, &sender_address },
459 { "sender_data", vtype_stringptr, &sender_data },
460 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
461 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
462 { "sender_host_address", vtype_stringptr, &sender_host_address },
463 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
464 { "sender_host_name", vtype_host_lookup, NULL },
465 { "sender_host_port", vtype_int, &sender_host_port },
466 { "sender_ident", vtype_stringptr, &sender_ident },
467 { "sender_rate", vtype_stringptr, &sender_rate },
468 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
469 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
470 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
471 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
472 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
473 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
474 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
475 { "sn0", vtype_filter_int, &filter_sn[0] },
476 { "sn1", vtype_filter_int, &filter_sn[1] },
477 { "sn2", vtype_filter_int, &filter_sn[2] },
478 { "sn3", vtype_filter_int, &filter_sn[3] },
479 { "sn4", vtype_filter_int, &filter_sn[4] },
480 { "sn5", vtype_filter_int, &filter_sn[5] },
481 { "sn6", vtype_filter_int, &filter_sn[6] },
482 { "sn7", vtype_filter_int, &filter_sn[7] },
483 { "sn8", vtype_filter_int, &filter_sn[8] },
484 { "sn9", vtype_filter_int, &filter_sn[9] },
485 #ifdef WITH_CONTENT_SCAN
486 { "spam_bar", vtype_stringptr, &spam_bar },
487 { "spam_report", vtype_stringptr, &spam_report },
488 { "spam_score", vtype_stringptr, &spam_score },
489 { "spam_score_int", vtype_stringptr, &spam_score_int },
491 #ifdef EXPERIMENTAL_SPF
492 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
493 { "spf_received", vtype_stringptr, &spf_received },
494 { "spf_result", vtype_stringptr, &spf_result },
495 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
497 { "spool_directory", vtype_stringptr, &spool_directory },
498 { "spool_inodes", vtype_pinodes, (void *)TRUE },
499 { "spool_space", vtype_pspace, (void *)TRUE },
500 #ifdef EXPERIMENTAL_SRS
501 { "srs_db_address", vtype_stringptr, &srs_db_address },
502 { "srs_db_key", vtype_stringptr, &srs_db_key },
503 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
504 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
505 { "srs_recipient", vtype_stringptr, &srs_recipient },
506 { "srs_status", vtype_stringptr, &srs_status },
508 { "thisaddress", vtype_stringptr, &filter_thisaddress },
509 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
510 { "tls_cipher", vtype_stringptr, &tls_cipher },
511 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
512 { "tod_bsdinbox", vtype_todbsdin, NULL },
513 { "tod_epoch", vtype_tode, NULL },
514 { "tod_full", vtype_todf, NULL },
515 { "tod_log", vtype_todl, NULL },
516 { "tod_logfile", vtype_todlf, NULL },
517 { "tod_zone", vtype_todzone, NULL },
518 { "tod_zulu", vtype_todzulu, NULL },
519 { "value", vtype_stringptr, &lookup_value },
520 { "version_number", vtype_stringptr, &version_string },
521 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
522 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
523 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
524 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
525 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
526 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
529 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
530 static uschar var_buffer[256];
531 static BOOL malformed_header;
533 /* For textual hashes */
535 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
536 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
539 enum { HMAC_MD5, HMAC_SHA1 };
541 /* For numeric hashes */
543 static unsigned int prime[] = {
544 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
545 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
546 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
548 /* For printing modes in symbolic form */
550 static uschar *mtable_normal[] =
551 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
553 static uschar *mtable_setid[] =
554 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
556 static uschar *mtable_sticky[] =
557 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
561 /*************************************************
562 * Tables for UTF-8 support *
563 *************************************************/
565 /* Table of the number of extra characters, indexed by the first character
566 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
569 static uschar utf8_table1[] = {
570 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
571 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
572 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
573 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
575 /* These are the masks for the data bits in the first byte of a character,
576 indexed by the number of additional bytes. */
578 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
580 /* Get the next UTF-8 character, advancing the pointer. */
582 #define GETUTF8INC(c, ptr) \
584 if ((c & 0xc0) == 0xc0) \
586 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
588 c = (c & utf8_table2[a]) << s; \
592 c |= (*ptr++ & 0x3f) << s; \
597 /*************************************************
598 * Binary chop search on a table *
599 *************************************************/
601 /* This is used for matching expansion items and operators.
604 name the name that is being sought
605 table the table to search
606 table_size the number of items in the table
608 Returns: the offset in the table, or -1
612 chop_match(uschar *name, uschar **table, int table_size)
614 uschar **bot = table;
615 uschar **top = table + table_size;
619 uschar **mid = bot + (top - bot)/2;
620 int c = Ustrcmp(name, *mid);
621 if (c == 0) return mid - table;
622 if (c > 0) bot = mid + 1; else top = mid;
630 /*************************************************
631 * Check a condition string *
632 *************************************************/
634 /* This function is called to expand a string, and test the result for a "true"
635 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
636 forced fail or lookup defer. All store used by the function can be released on
640 condition the condition string
641 m1 text to be incorporated in panic error
644 Returns: TRUE if condition is met, FALSE if not
648 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
651 void *reset_point = store_get(0);
652 uschar *ss = expand_string(condition);
655 if (!expand_string_forcedfail && !search_find_defer)
656 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
657 "for %s %s: %s", condition, m1, m2, expand_string_message);
660 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
661 strcmpic(ss, US"false") != 0;
662 store_reset(reset_point);
668 /*************************************************
669 * Pick out a name from a string *
670 *************************************************/
672 /* If the name is too long, it is silently truncated.
675 name points to a buffer into which to put the name
676 max is the length of the buffer
677 s points to the first alphabetic character of the name
678 extras chars other than alphanumerics to permit
680 Returns: pointer to the first character after the name
682 Note: The test for *s != 0 in the while loop is necessary because
683 Ustrchr() yields non-NULL if the character is zero (which is not something
687 read_name(uschar *name, int max, uschar *s, uschar *extras)
690 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
692 if (ptr < max-1) name[ptr++] = *s;
701 /*************************************************
702 * Pick out the rest of a header name *
703 *************************************************/
705 /* A variable name starting $header_ (or just $h_ for those who like
706 abbreviations) might not be the complete header name because headers can
707 contain any printing characters in their names, except ':'. This function is
708 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
709 on the end, if the name was terminated by white space.
712 name points to a buffer in which the name read so far exists
713 max is the length of the buffer
714 s points to the first character after the name so far, i.e. the
715 first non-alphameric character after $header_xxxxx
717 Returns: a pointer to the first character after the header name
721 read_header_name(uschar *name, int max, uschar *s)
723 int prelen = Ustrchr(name, '_') - name + 1;
724 int ptr = Ustrlen(name) - prelen;
725 if (ptr > 0) memmove(name, name+prelen, ptr);
726 while (mac_isgraph(*s) && *s != ':')
728 if (ptr < max-1) name[ptr++] = *s;
739 /*************************************************
740 * Pick out a number from a string *
741 *************************************************/
744 n points to an integer into which to put the number
745 s points to the first digit of the number
747 Returns: a pointer to the character after the last digit
751 read_number(int *n, uschar *s)
754 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
760 /*************************************************
761 * Extract keyed subfield from a string *
762 *************************************************/
764 /* The yield is in dynamic store; NULL means that the key was not found.
767 key points to the name of the key
768 s points to the string from which to extract the subfield
770 Returns: NULL if the subfield was not found, or
771 a pointer to the subfield's data
775 expand_getkeyed(uschar *key, uschar *s)
777 int length = Ustrlen(key);
778 while (isspace(*s)) s++;
780 /* Loop to search for the key */
788 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
789 dkeylength = s - dkey;
790 while (isspace(*s)) s++;
791 if (*s == '=') while (isspace((*(++s))));
793 data = string_dequote(&s);
794 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
797 while (isspace(*s)) s++;
806 /*************************************************
807 * Extract numbered subfield from string *
808 *************************************************/
810 /* Extracts a numbered field from a string that is divided by tokens - for
811 example a line from /etc/passwd is divided by colon characters. First field is
812 numbered one. Negative arguments count from the right. Zero returns the whole
813 string. Returns NULL if there are insufficient tokens in the string
816 Modifies final argument - this is a dynamically generated string, so that's OK.
819 field number of field to be extracted,
820 first field = 1, whole string = 0, last field = -1
821 separators characters that are used to break string into tokens
822 s points to the string from which to extract the subfield
824 Returns: NULL if the field was not found,
825 a pointer to the field's data inside s (modified to add 0)
829 expand_gettokened (int field, uschar *separators, uschar *s)
834 uschar *fieldtext = NULL;
836 if (field == 0) return s;
838 /* Break the line up into fields in place; for field > 0 we stop when we have
839 done the number of fields we want. For field < 0 we continue till the end of
840 the string, counting the number of fields. */
842 count = (field > 0)? field : INT_MAX;
848 /* Previous field was the last one in the string. For a positive field
849 number, this means there are not enough fields. For a negative field number,
850 check that there are enough, and scan back to find the one that is wanted. */
854 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
855 if ((-field) == (INT_MAX - count - 1)) return s;
859 while (ss[-1] != 0) ss--;
865 /* Previous field was not last in the string; save its start and put a
869 len = Ustrcspn(ss, separators);
880 /*************************************************
881 * Extract a substring from a string *
882 *************************************************/
884 /* Perform the ${substr or ${length expansion operations.
887 subject the input string
888 value1 the offset from the start of the input string to the start of
889 the output string; if negative, count from the right.
890 value2 the length of the output string, or negative (-1) for unset
891 if value1 is positive, unset means "all after"
892 if value1 is negative, unset means "all before"
893 len set to the length of the returned string
895 Returns: pointer to the output string, or NULL if there is an error
899 extract_substr(uschar *subject, int value1, int value2, int *len)
901 int sublen = Ustrlen(subject);
903 if (value1 < 0) /* count from right */
907 /* If the position is before the start, skip to the start, and adjust the
908 length. If the length ends up negative, the substring is null because nothing
909 can precede. This falls out naturally when the length is unset, meaning "all
915 if (value2 < 0) value2 = 0;
919 /* Otherwise an unset length => characters before value1 */
928 /* For a non-negative offset, if the starting position is past the end of the
929 string, the result will be the null string. Otherwise, an unset length means
930 "rest"; just set it to the maximum - it will be cut down below if necessary. */
939 else if (value2 < 0) value2 = sublen;
942 /* Cut the length down to the maximum possible for the offset value, and get
943 the required characters. */
945 if (value1 + value2 > sublen) value2 = sublen - value1;
947 return subject + value1;
953 /*************************************************
954 * Old-style hash of a string *
955 *************************************************/
957 /* Perform the ${hash expansion operation.
960 subject the input string (an expanded substring)
961 value1 the length of the output string; if greater or equal to the
962 length of the input string, the input string is returned
963 value2 the number of hash characters to use, or 26 if negative
964 len set to the length of the returned string
966 Returns: pointer to the output string, or NULL if there is an error
970 compute_hash(uschar *subject, int value1, int value2, int *len)
972 int sublen = Ustrlen(subject);
974 if (value2 < 0) value2 = 26;
975 else if (value2 > Ustrlen(hashcodes))
977 expand_string_message =
978 string_sprintf("hash count \"%d\" too big", value2);
982 /* Calculate the hash text. We know it is shorter than the original string, so
983 can safely place it in subject[] (we know that subject is always itself an
984 expanded substring). */
991 while ((c = (subject[j])) != 0)
993 int shift = (c + j++) & 7;
994 subject[i] ^= (c << shift) | (c >> (8-shift));
995 if (++i >= value1) i = 0;
997 for (i = 0; i < value1; i++)
998 subject[i] = hashcodes[(subject[i]) % value2];
1000 else value1 = sublen;
1009 /*************************************************
1010 * Numeric hash of a string *
1011 *************************************************/
1013 /* Perform the ${nhash expansion operation. The first characters of the
1014 string are treated as most important, and get the highest prime numbers.
1017 subject the input string
1018 value1 the maximum value of the first part of the result
1019 value2 the maximum value of the second part of the result,
1020 or negative to produce only a one-part result
1021 len set to the length of the returned string
1023 Returns: pointer to the output string, or NULL if there is an error.
1027 compute_nhash (uschar *subject, int value1, int value2, int *len)
1029 uschar *s = subject;
1031 unsigned long int total = 0; /* no overflow */
1035 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1036 total += prime[i--] * (unsigned int)(*s++);
1039 /* If value2 is unset, just compute one number */
1043 s = string_sprintf("%d", total % value1);
1046 /* Otherwise do a div/mod hash */
1050 total = total % (value1 * value2);
1051 s = string_sprintf("%d/%d", total/value2, total % value2);
1062 /*************************************************
1063 * Find the value of a header or headers *
1064 *************************************************/
1066 /* Multiple instances of the same header get concatenated, and this function
1067 can also return a concatenation of all the header lines. When concatenating
1068 specific headers that contain lists of addresses, a comma is inserted between
1069 them. Otherwise we use a straight concatenation. Because some messages can have
1070 pathologically large number of lines, there is a limit on the length that is
1071 returned. Also, to avoid massive store use which would result from using
1072 string_cat() as it copies and extends strings, we do a preliminary pass to find
1073 out exactly how much store will be needed. On "normal" messages this will be
1077 name the name of the header, without the leading $header_ or $h_,
1078 or NULL if a concatenation of all headers is required
1079 exists_only TRUE if called from a def: test; don't need to build a string;
1080 just return a string that is not "" and not "0" if the header
1082 newsize return the size of memory block that was obtained; may be NULL
1083 if exists_only is TRUE
1084 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1085 other than concatenating, will be done on the header. Also used
1086 for $message_headers_raw.
1087 charset name of charset to translate MIME words to; used only if
1088 want_raw is false; if NULL, no translation is done (this is
1089 used for $bh_ and $bheader_)
1091 Returns: NULL if the header does not exist, else a pointer to a new
1096 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1099 BOOL found = name == NULL;
1101 int len = found? 0 : Ustrlen(name);
1103 uschar *yield = NULL;
1106 /* Loop for two passes - saves code repetition */
1108 for (i = 0; i < 2; i++)
1113 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1115 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1117 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1122 if (exists_only) return US"1"; /* don't need actual string */
1124 t = h->text + len; /* text to insert */
1125 if (!want_raw) /* unless wanted raw, */
1126 while (isspace(*t)) t++; /* remove leading white space */
1127 ilen = h->slen - (t - h->text); /* length to insert */
1129 /* Unless wanted raw, remove trailing whitespace, including the
1133 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1135 /* Set comma = 1 if handling a single header and it's one of those
1136 that contains an address list, except when asked for raw headers. Only
1137 need to do this once. */
1139 if (!want_raw && name != NULL && comma == 0 &&
1140 Ustrchr("BCFRST", h->type) != NULL)
1143 /* First pass - compute total store needed; second pass - compute
1144 total store used, including this header. */
1146 size += ilen + comma + 1; /* +1 for the newline */
1148 /* Second pass - concatentate the data, up to a maximum. Note that
1149 the loop stops when size hits the limit. */
1153 if (size > header_insert_maxlen)
1155 ilen -= size - header_insert_maxlen - 1;
1158 Ustrncpy(ptr, t, ilen);
1161 /* For a non-raw header, put in the comma if needed, then add
1162 back the newline we removed above, provided there was some text in
1165 if (!want_raw && ilen > 0)
1167 if (comma != 0) *ptr++ = ',';
1175 /* At end of first pass, return NULL if no header found. Then truncate size
1176 if necessary, and get the buffer to hold the data, returning the buffer size.
1181 if (!found) return NULL;
1182 if (size > header_insert_maxlen) size = header_insert_maxlen;
1183 *newsize = size + 1;
1184 ptr = yield = store_get(*newsize);
1188 /* That's all we do for raw header expansion. */
1195 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1196 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1197 function can return an error with decoded data if the charset translation
1198 fails. If decoding fails, it returns NULL. */
1202 uschar *decoded, *error;
1203 if (ptr > yield && ptr[-1] == '\n') ptr--;
1204 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1206 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1210 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1211 " input was: %s\n", error, yield);
1213 if (decoded != NULL) yield = decoded;
1222 /*************************************************
1223 * Find value of a variable *
1224 *************************************************/
1226 /* The table of variables is kept in alphabetic order, so we can search it
1227 using a binary chop. The "choplen" variable is nothing to do with the binary
1231 name the name of the variable being sought
1232 exists_only TRUE if this is a def: test; passed on to find_header()
1233 skipping TRUE => skip any processing evaluation; this is not the same as
1234 exists_only because def: may test for values that are first
1236 newsize pointer to an int which is initially zero; if the answer is in
1237 a new memory buffer, *newsize is set to its size
1239 Returns: NULL if the variable does not exist, or
1240 a pointer to the variable's contents, or
1241 something non-NULL if exists_only is TRUE
1245 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1248 int last = var_table_size;
1250 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1251 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1252 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1253 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1254 (this gave backwards compatibility at the changeover). There may be built-in
1255 variables whose names start acl_ but they should never start in this way. This
1256 slightly messy specification is a consequence of the history, needless to say.
1258 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1259 set, in which case give an error. */
1261 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1265 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1266 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1269 /* Handle $auth<n> variables. */
1271 if (Ustrncmp(name, "auth", 4) == 0)
1274 int n = Ustrtoul(name + 4, &endptr, 10);
1275 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1276 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1279 /* For all other variables, search the table */
1281 while (last > first)
1285 int middle = (first + last)/2;
1286 int c = Ustrcmp(name, var_table[middle].name);
1288 if (c > 0) { first = middle + 1; continue; }
1289 if (c < 0) { last = middle; continue; }
1291 /* Found an existing variable. If in skipping state, the value isn't needed,
1292 and we want to avoid processing (such as looking up the host name). */
1294 if (skipping) return US"";
1296 switch (var_table[middle].type)
1298 #ifdef EXPERIMENTAL_DOMAINKEYS
1300 case vtype_dk_verify:
1301 if (dk_verify_block == NULL) return US"";
1303 if (Ustrcmp(var_table[middle].name, "dk_result") == 0)
1304 s = dk_verify_block->result_string;
1305 if (Ustrcmp(var_table[middle].name, "dk_sender") == 0)
1306 s = dk_verify_block->address;
1307 if (Ustrcmp(var_table[middle].name, "dk_sender_domain") == 0)
1308 s = dk_verify_block->domain;
1309 if (Ustrcmp(var_table[middle].name, "dk_sender_local_part") == 0)
1310 s = dk_verify_block->local_part;
1312 if (Ustrcmp(var_table[middle].name, "dk_sender_source") == 0)
1313 switch(dk_verify_block->address_source) {
1314 case DK_EXIM_ADDRESS_NONE: s = US"0"; break;
1315 case DK_EXIM_ADDRESS_FROM_FROM: s = US"from"; break;
1316 case DK_EXIM_ADDRESS_FROM_SENDER: s = US"sender"; break;
1319 if (Ustrcmp(var_table[middle].name, "dk_status") == 0)
1320 switch(dk_verify_block->result) {
1321 case DK_EXIM_RESULT_ERR: s = US"error"; break;
1322 case DK_EXIM_RESULT_BAD_FORMAT: s = US"bad format"; break;
1323 case DK_EXIM_RESULT_NO_KEY: s = US"no key"; break;
1324 case DK_EXIM_RESULT_NO_SIGNATURE: s = US"no signature"; break;
1325 case DK_EXIM_RESULT_REVOKED: s = US"revoked"; break;
1326 case DK_EXIM_RESULT_NON_PARTICIPANT: s = US"non-participant"; break;
1327 case DK_EXIM_RESULT_GOOD: s = US"good"; break;
1328 case DK_EXIM_RESULT_BAD: s = US"bad"; break;
1331 if (Ustrcmp(var_table[middle].name, "dk_signsall") == 0)
1332 s = (dk_verify_block->signsall)? US"1" : US"0";
1334 if (Ustrcmp(var_table[middle].name, "dk_testing") == 0)
1335 s = (dk_verify_block->testing)? US"1" : US"0";
1337 if (Ustrcmp(var_table[middle].name, "dk_is_signed") == 0)
1338 s = (dk_verify_block->is_signed)? US"1" : US"0";
1340 return (s == NULL)? US"" : s;
1343 case vtype_filter_int:
1344 if (!filter_running) return NULL;
1348 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1352 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1356 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1360 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1363 case vtype_stringptr: /* Pointer to string */
1364 s = *((uschar **)(var_table[middle].value));
1365 return (s == NULL)? US"" : s;
1368 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1371 case vtype_load_avg:
1372 sprintf(CS var_buffer, "%d", os_getloadavg()); /* load_average */
1375 case vtype_host_lookup: /* Lookup if not done so */
1376 if (sender_host_name == NULL && sender_host_address != NULL &&
1377 !host_lookup_failed && host_name_lookup() == OK)
1378 host_build_sender_fullhost();
1379 return (sender_host_name == NULL)? US"" : sender_host_name;
1381 case vtype_localpart: /* Get local part from address */
1382 s = *((uschar **)(var_table[middle].value));
1383 if (s == NULL) return US"";
1384 domain = Ustrrchr(s, '@');
1385 if (domain == NULL) return s;
1386 if (domain - s > sizeof(var_buffer) - 1)
1387 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1388 "string expansion", sizeof(var_buffer));
1389 Ustrncpy(var_buffer, s, domain - s);
1390 var_buffer[domain - s] = 0;
1393 case vtype_domain: /* Get domain from address */
1394 s = *((uschar **)(var_table[middle].value));
1395 if (s == NULL) return US"";
1396 domain = Ustrrchr(s, '@');
1397 return (domain == NULL)? US"" : domain + 1;
1399 case vtype_msgheaders:
1400 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1402 case vtype_msgheaders_raw:
1403 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1405 case vtype_msgbody: /* Pointer to msgbody string */
1406 case vtype_msgbody_end: /* Ditto, the end of the msg */
1407 ss = (uschar **)(var_table[middle].value);
1408 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1411 off_t start_offset = SPOOL_DATA_START_OFFSET;
1412 int len = message_body_visible;
1413 if (len > message_size) len = message_size;
1414 *ss = body = store_malloc(len+1);
1416 if (var_table[middle].type == vtype_msgbody_end)
1418 struct stat statbuf;
1419 if (fstat(deliver_datafile, &statbuf) == 0)
1421 start_offset = statbuf.st_size - len;
1422 if (start_offset < SPOOL_DATA_START_OFFSET)
1423 start_offset = SPOOL_DATA_START_OFFSET;
1426 lseek(deliver_datafile, start_offset, SEEK_SET);
1427 len = read(deliver_datafile, body, len);
1433 if (body[--len] == '\n' || body[len] == 0) body[len] = ' ';
1437 return (*ss == NULL)? US"" : *ss;
1439 case vtype_todbsdin: /* BSD inbox time of day */
1440 return tod_stamp(tod_bsdin);
1442 case vtype_tode: /* Unix epoch time of day */
1443 return tod_stamp(tod_epoch);
1445 case vtype_todf: /* Full time of day */
1446 return tod_stamp(tod_full);
1448 case vtype_todl: /* Log format time of day */
1449 return tod_stamp(tod_log_bare); /* (without timezone) */
1451 case vtype_todzone: /* Time zone offset only */
1452 return tod_stamp(tod_zone);
1454 case vtype_todzulu: /* Zulu time */
1455 return tod_stamp(tod_zulu);
1457 case vtype_todlf: /* Log file datestamp tod */
1458 return tod_stamp(tod_log_datestamp);
1460 case vtype_reply: /* Get reply address */
1461 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1463 if (s != NULL) while (isspace(*s)) s++;
1464 if (s == NULL || *s == 0)
1466 *newsize = 0; /* For the *s==0 case */
1467 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1472 while (isspace(*s)) s++;
1473 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1474 while (t > s && isspace(t[-1])) t--;
1477 return (s == NULL)? US"" : s;
1479 /* A recipients list is available only during system message filtering,
1480 during ACL processing after DATA, and while expanding pipe commands
1481 generated from a system filter, but not elsewhere. */
1483 case vtype_recipients:
1484 if (!enable_dollar_recipients) return NULL; else
1489 s = store_get(size);
1490 for (i = 0; i < recipients_count; i++)
1492 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1493 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1494 Ustrlen(recipients_list[i].address));
1496 s[ptr] = 0; /* string_cat() leaves room */
1503 sprintf(CS var_buffer, "%d",
1504 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1511 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1512 sprintf(CS var_buffer, "%d", inodes);
1518 return NULL; /* Unknown variable name */
1524 /*************************************************
1525 * Read and expand substrings *
1526 *************************************************/
1528 /* This function is called to read and expand argument substrings for various
1529 expansion items. Some have a minimum requirement that is less than the maximum;
1530 in these cases, the first non-present one is set to NULL.
1533 sub points to vector of pointers to set
1534 n maximum number of substrings
1536 sptr points to current string pointer
1537 skipping the skipping flag
1538 check_end if TRUE, check for final '}'
1539 name name of item, for error message
1541 Returns: 0 OK; string pointer updated
1542 1 curly bracketing error (too few arguments)
1543 2 too many arguments (only if check_end is set); message set
1544 3 other error (expansion failure)
1548 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1549 BOOL check_end, uschar *name)
1554 while (isspace(*s)) s++;
1555 for (i = 0; i < n; i++)
1559 if (i < m) return 1;
1563 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1564 if (sub[i] == NULL) return 3;
1565 if (*s++ != '}') return 1;
1566 while (isspace(*s)) s++;
1568 if (check_end && *s++ != '}')
1572 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1573 "(max is %d)", name, n);
1586 /*************************************************
1587 * Elaborate message for bad variable *
1588 *************************************************/
1590 /* For the "unknown variable" message, take a look at the variable's name, and
1591 give additional information about possible ACL variables. The extra information
1592 is added on to expand_string_message.
1594 Argument: the name of the variable
1599 check_variable_error_message(uschar *name)
1601 if (Ustrncmp(name, "acl_", 4) == 0)
1602 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1603 (name[4] == 'c' || name[4] == 'm')?
1605 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1606 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1608 US"user-defined ACL variables must start acl_c or acl_m");
1613 /*************************************************
1614 * Read and evaluate a condition *
1615 *************************************************/
1619 s points to the start of the condition text
1620 yield points to a BOOL to hold the result of the condition test;
1621 if NULL, we are just reading through a condition that is
1622 part of an "or" combination to check syntax, or in a state
1623 where the answer isn't required
1625 Returns: a pointer to the first character after the condition, or
1630 eval_condition(uschar *s, BOOL *yield)
1632 BOOL testfor = TRUE;
1633 BOOL tempcond, combined_cond;
1635 int i, rc, cond_type, roffset;
1637 struct stat statbuf;
1642 const uschar *rerror;
1646 while (isspace(*s)) s++;
1647 if (*s == '!') { testfor = !testfor; s++; } else break;
1650 /* Numeric comparisons are symbolic */
1652 if (*s == '=' || *s == '>' || *s == '<')
1664 /* All other conditions are named */
1666 else s = read_name(name, 256, s, US"_");
1668 /* If we haven't read a name, it means some non-alpha character is first. */
1672 expand_string_message = string_sprintf("condition name expected, "
1673 "but found \"%.16s\"", s);
1677 /* Find which condition we are dealing with, and switch on it */
1679 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1682 /* def: tests for a non-empty variable, or for the existence of a header. If
1683 yield == NULL we are in a skipping state, and don't care about the answer. */
1688 expand_string_message = US"\":\" expected after \"def\"";
1692 s = read_name(name, 256, s+1, US"_");
1694 /* Test for a header's existence. If the name contains a closing brace
1695 character, this may be a user error where the terminating colon has been
1696 omitted. Set a flag to adjust a subsequent error message in this case. */
1698 if (Ustrncmp(name, "h_", 2) == 0 ||
1699 Ustrncmp(name, "rh_", 3) == 0 ||
1700 Ustrncmp(name, "bh_", 3) == 0 ||
1701 Ustrncmp(name, "header_", 7) == 0 ||
1702 Ustrncmp(name, "rheader_", 8) == 0 ||
1703 Ustrncmp(name, "bheader_", 8) == 0)
1705 s = read_header_name(name, 256, s);
1706 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
1707 if (yield != NULL) *yield =
1708 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1711 /* Test for a variable's having a non-empty value. A non-existent variable
1712 causes an expansion failure. */
1716 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1719 expand_string_message = (name[0] == 0)?
1720 string_sprintf("variable name omitted after \"def:\"") :
1721 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1722 check_variable_error_message(name);
1725 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1731 /* first_delivery tests for first delivery attempt */
1733 case ECOND_FIRST_DELIVERY:
1734 if (yield != NULL) *yield = deliver_firsttime == testfor;
1738 /* queue_running tests for any process started by a queue runner */
1740 case ECOND_QUEUE_RUNNING:
1741 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1745 /* exists: tests for file existence
1746 isip: tests for any IP address
1747 isip4: tests for an IPv4 address
1748 isip6: tests for an IPv6 address
1749 pam: does PAM authentication
1750 radius: does RADIUS authentication
1751 ldapauth: does LDAP authentication
1752 pwcheck: does Cyrus SASL pwcheck authentication
1761 case ECOND_LDAPAUTH:
1764 while (isspace(*s)) s++;
1765 if (*s != '{') goto COND_FAILED_CURLY_START;
1767 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1768 if (sub[0] == NULL) return NULL;
1769 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1771 if (yield == NULL) return s; /* No need to run the test if skipping */
1776 if ((expand_forbid & RDO_EXISTS) != 0)
1778 expand_string_message = US"File existence tests are not permitted";
1781 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1787 rc = string_is_ip_address(sub[0], NULL);
1788 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
1789 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1792 /* Various authentication tests - all optionally compiled */
1796 rc = auth_call_pam(sub[0], &expand_string_message);
1799 goto COND_FAILED_NOT_COMPILED;
1800 #endif /* SUPPORT_PAM */
1803 #ifdef RADIUS_CONFIG_FILE
1804 rc = auth_call_radius(sub[0], &expand_string_message);
1807 goto COND_FAILED_NOT_COMPILED;
1808 #endif /* RADIUS_CONFIG_FILE */
1810 case ECOND_LDAPAUTH:
1813 /* Just to keep the interface the same */
1815 int old_pool = store_pool;
1816 store_pool = POOL_SEARCH;
1817 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1818 &expand_string_message, &do_cache);
1819 store_pool = old_pool;
1823 goto COND_FAILED_NOT_COMPILED;
1824 #endif /* LOOKUP_LDAP */
1827 #ifdef CYRUS_PWCHECK_SOCKET
1828 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1831 goto COND_FAILED_NOT_COMPILED;
1832 #endif /* CYRUS_PWCHECK_SOCKET */
1834 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1835 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1837 if (rc == ERROR || rc == DEFER) return NULL;
1838 *yield = (rc == OK) == testfor;
1844 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1846 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1848 However, the last two are optional. That is why the whole set is enclosed
1849 in their own set or braces. */
1851 case ECOND_SASLAUTHD:
1852 #ifndef CYRUS_SASLAUTHD_SOCKET
1853 goto COND_FAILED_NOT_COMPILED;
1855 while (isspace(*s)) s++;
1856 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1857 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1859 case 1: expand_string_message = US"too few arguments or bracketing "
1860 "error for saslauthd";
1862 case 3: return NULL;
1864 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
1868 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1869 &expand_string_message);
1870 if (rc == ERROR || rc == DEFER) return NULL;
1871 *yield = (rc == OK) == testfor;
1874 #endif /* CYRUS_SASLAUTHD_SOCKET */
1877 /* symbolic operators for numeric and string comparison, and a number of
1878 other operators, all requiring two arguments.
1880 match: does a regular expression match and sets up the numerical
1881 variables if it succeeds
1882 match_address: matches in an address list
1883 match_domain: matches in a domain list
1884 match_ip: matches a host list that is restricted to IP addresses
1885 match_local_part: matches in a local part list
1886 crypteq: encrypts plaintext and compares against an encrypted text,
1887 using crypt(), crypt16(), MD5 or SHA-1
1891 case ECOND_MATCH_ADDRESS:
1892 case ECOND_MATCH_DOMAIN:
1893 case ECOND_MATCH_IP:
1894 case ECOND_MATCH_LOCAL_PART:
1897 case ECOND_NUM_L: /* Numerical comparisons */
1904 case ECOND_STR_LT: /* String comparisons */
1915 for (i = 0; i < 2; i++)
1917 while (isspace(*s)) s++;
1920 if (i == 0) goto COND_FAILED_CURLY_START;
1921 expand_string_message = string_sprintf("missing 2nd string in {} "
1922 "after \"%s\"", name);
1925 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1926 if (sub[i] == NULL) return NULL;
1927 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1929 /* Convert to numerical if required; we know that the names of all the
1930 conditions that compare numbers do not start with a letter. This just saves
1931 checking for them individually. */
1933 if (!isalpha(name[0]))
1935 num[i] = expand_string_integer(sub[i], FALSE);
1936 if (expand_string_message != NULL) return NULL;
1940 /* Result not required */
1942 if (yield == NULL) return s;
1944 /* Do an appropriate comparison */
1950 *yield = (num[0] == num[1]) == testfor;
1954 *yield = (num[0] > num[1]) == testfor;
1958 *yield = (num[0] >= num[1]) == testfor;
1962 *yield = (num[0] < num[1]) == testfor;
1966 *yield = (num[0] <= num[1]) == testfor;
1970 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
1974 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
1978 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
1982 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
1986 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
1990 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
1994 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
1998 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
2002 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2006 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2009 case ECOND_MATCH: /* Regular expression match */
2010 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2014 expand_string_message = string_sprintf("regular expression error in "
2015 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2018 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2021 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2022 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2023 goto MATCHED_SOMETHING;
2025 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2026 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2027 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2028 goto MATCHED_SOMETHING;
2030 case ECOND_MATCH_IP: /* Match IP address in a host list */
2031 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2033 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2039 unsigned int *nullcache = NULL;
2040 check_host_block cb;
2042 cb.host_name = US"";
2043 cb.host_address = sub[0];
2045 /* If the host address starts off ::ffff: it is an IPv6 address in
2046 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2049 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2050 cb.host_address + 7 : cb.host_address;
2052 rc = match_check_list(
2053 &sub[1], /* the list */
2054 0, /* separator character */
2055 &hostlist_anchor, /* anchor pointer */
2056 &nullcache, /* cache pointer */
2057 check_host, /* function for testing */
2058 &cb, /* argument for function */
2059 MCL_HOST, /* type of check */
2060 sub[0], /* text for debugging */
2061 NULL); /* where to pass back data */
2063 goto MATCHED_SOMETHING;
2065 case ECOND_MATCH_LOCAL_PART:
2066 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2067 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2082 expand_string_message = string_sprintf("unable to complete match "
2083 "against \"%s\": %s", sub[1], search_error_message);
2089 /* Various "encrypted" comparisons. If the second string starts with
2090 "{" then an encryption type is given. Default to crypt() or crypt16()
2091 (build-time choice). */
2094 #ifndef SUPPORT_CRYPTEQ
2095 goto COND_FAILED_NOT_COMPILED;
2097 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2099 int sublen = Ustrlen(sub[1]+5);
2104 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2106 /* If the length that we are comparing against is 24, the MD5 digest
2107 is expressed as a base64 string. This is the way LDAP does it. However,
2108 some other software uses a straightforward hex representation. We assume
2109 this if the length is 32. Other lengths fail. */
2113 uschar *coded = auth_b64encode((uschar *)digest, 16);
2114 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2115 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2116 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2118 else if (sublen == 32)
2122 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2124 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2125 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2126 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2130 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2131 "fail\n crypted=%s\n", sub[1]+5);
2136 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2138 int sublen = Ustrlen(sub[1]+6);
2143 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2145 /* If the length that we are comparing against is 28, assume the SHA1
2146 digest is expressed as a base64 string. If the length is 40, assume a
2147 straightforward hex representation. Other lengths fail. */
2151 uschar *coded = auth_b64encode((uschar *)digest, 20);
2152 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2153 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2154 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2156 else if (sublen == 40)
2160 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2162 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2163 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2164 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2168 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2169 "fail\n crypted=%s\n", sub[1]+6);
2174 else /* {crypt} or {crypt16} and non-{ at start */
2179 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2184 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2189 else if (sub[1][0] == '{')
2191 expand_string_message = string_sprintf("unknown encryption mechanism "
2192 "in \"%s\"", sub[1]);
2198 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2199 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2200 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2204 #define XSTR(s) STR(s)
2205 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2206 " subject=%s\n crypted=%s\n",
2207 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2212 /* If the encrypted string contains fewer than two characters (for the
2213 salt), force failure. Otherwise we get false positives: with an empty
2214 string the yield of crypt() is an empty string! */
2216 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2217 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2220 #endif /* SUPPORT_CRYPTEQ */
2221 } /* Switch for comparison conditions */
2223 return s; /* End of comparison conditions */
2226 /* and/or: computes logical and/or of several conditions */
2230 subcondptr = (yield == NULL)? NULL : &tempcond;
2231 combined_cond = (cond_type == ECOND_AND);
2233 while (isspace(*s)) s++;
2234 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2238 while (isspace(*s)) s++;
2239 if (*s == '}') break;
2242 expand_string_message = string_sprintf("each subcondition "
2243 "inside an \"%s{...}\" condition must be in its own {}", name);
2247 s = eval_condition(s+1, subcondptr);
2250 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2251 expand_string_message, name);
2254 while (isspace(*s)) s++;
2258 expand_string_message = string_sprintf("missing } at end of condition "
2259 "inside \"%s\" group", name);
2265 if (cond_type == ECOND_AND)
2267 combined_cond &= tempcond;
2268 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2269 } /* evaluate any more */
2272 combined_cond |= tempcond;
2273 if (combined_cond) subcondptr = NULL; /* once true, don't */
2274 } /* evaluate any more */
2278 if (yield != NULL) *yield = (combined_cond == testfor);
2282 /* Unknown condition */
2285 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2287 } /* End switch on condition type */
2289 /* Missing braces at start and end of data */
2291 COND_FAILED_CURLY_START:
2292 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2295 COND_FAILED_CURLY_END:
2296 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2300 /* A condition requires code that is not compiled */
2302 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2303 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2304 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2305 COND_FAILED_NOT_COMPILED:
2306 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2315 /*************************************************
2316 * Save numerical variables *
2317 *************************************************/
2319 /* This function is called from items such as "if" that want to preserve and
2320 restore the numbered variables.
2323 save_expand_string points to an array of pointers to set
2324 save_expand_nlength points to an array of ints for the lengths
2326 Returns: the value of expand max to save
2330 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2333 for (i = 0; i <= expand_nmax; i++)
2335 save_expand_nstring[i] = expand_nstring[i];
2336 save_expand_nlength[i] = expand_nlength[i];
2343 /*************************************************
2344 * Restore numerical variables *
2345 *************************************************/
2347 /* This function restored saved values of numerical strings.
2350 save_expand_nmax the number of strings to restore
2351 save_expand_string points to an array of pointers
2352 save_expand_nlength points to an array of ints
2358 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2359 int *save_expand_nlength)
2362 expand_nmax = save_expand_nmax;
2363 for (i = 0; i <= expand_nmax; i++)
2365 expand_nstring[i] = save_expand_nstring[i];
2366 expand_nlength[i] = save_expand_nlength[i];
2374 /*************************************************
2375 * Handle yes/no substrings *
2376 *************************************************/
2378 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2379 alternative substrings that depend on whether or not the condition was true,
2380 or the lookup or extraction succeeded. The substrings always have to be
2381 expanded, to check their syntax, but "skipping" is set when the result is not
2382 needed - this avoids unnecessary nested lookups.
2385 skipping TRUE if we were skipping when this item was reached
2386 yes TRUE if the first string is to be used, else use the second
2387 save_lookup a value to put back into lookup_value before the 2nd expansion
2388 sptr points to the input string pointer
2389 yieldptr points to the output string pointer
2390 sizeptr points to the output string size
2391 ptrptr points to the output string pointer
2392 type "lookup" or "if" or "extract" or "run", for error message
2394 Returns: 0 OK; lookup_value has been reset to save_lookup
2396 2 expansion failed because of bracketing error
2400 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2401 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2404 uschar *s = *sptr; /* Local value */
2405 uschar *sub1, *sub2;
2407 /* If there are no following strings, we substitute the contents of $value for
2408 lookups and for extractions in the success case. For the ${if item, the string
2409 "true" is substituted. In the fail case, nothing is substituted for all three
2412 while (isspace(*s)) s++;
2417 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2421 if (yes && lookup_value != NULL)
2422 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2423 Ustrlen(lookup_value));
2424 lookup_value = save_lookup;
2430 /* The first following string must be braced. */
2432 if (*s++ != '{') goto FAILED_CURLY;
2434 /* Expand the first substring. Forced failures are noticed only if we actually
2435 want this string. Set skipping in the call in the fail case (this will always
2436 be the case if we were already skipping). */
2438 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2439 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2440 expand_string_forcedfail = FALSE;
2441 if (*s++ != '}') goto FAILED_CURLY;
2443 /* If we want the first string, add it to the output */
2446 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2448 /* If this is called from a lookup or an extract, we want to restore $value to
2449 what it was at the start of the item, so that it has this value during the
2450 second string expansion. For the call from "if" or "run" to this function,
2451 save_lookup is set to lookup_value, so that this statement does nothing. */
2453 lookup_value = save_lookup;
2455 /* There now follows either another substring, or "fail", or nothing. This
2456 time, forced failures are noticed only if we want the second string. We must
2457 set skipping in the nested call if we don't want this string, or if we were
2458 already skipping. */
2460 while (isspace(*s)) s++;
2463 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2464 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2465 expand_string_forcedfail = FALSE;
2466 if (*s++ != '}') goto FAILED_CURLY;
2468 /* If we want the second string, add it to the output */
2471 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2474 /* If there is no second string, but the word "fail" is present when the use of
2475 the second string is wanted, set a flag indicating it was a forced failure
2476 rather than a syntactic error. Swallow the terminating } in case this is nested
2477 inside another lookup or if or extract. */
2482 s = read_name(name, sizeof(name), s, US"_");
2483 if (Ustrcmp(name, "fail") == 0)
2485 if (!yes && !skipping)
2487 while (isspace(*s)) s++;
2488 if (*s++ != '}') goto FAILED_CURLY;
2489 expand_string_message =
2490 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2491 expand_string_forcedfail = TRUE;
2497 expand_string_message =
2498 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2503 /* All we have to do now is to check on the final closing brace. */
2505 while (isspace(*s)) s++;
2506 if (*s++ == '}') goto RETURN;
2508 /* Get here if there is a bracketing failure */
2513 /* Get here for other failures */
2518 /* Update the input pointer value before returning */
2528 /*************************************************
2529 * Handle MD5 or SHA-1 computation for HMAC *
2530 *************************************************/
2532 /* These are some wrapping functions that enable the HMAC code to be a bit
2533 cleaner. A good compiler will spot the tail recursion.
2536 type HMAC_MD5 or HMAC_SHA1
2537 remaining are as for the cryptographic hash functions
2543 chash_start(int type, void *base)
2545 if (type == HMAC_MD5)
2546 md5_start((md5 *)base);
2548 sha1_start((sha1 *)base);
2552 chash_mid(int type, void *base, uschar *string)
2554 if (type == HMAC_MD5)
2555 md5_mid((md5 *)base, string);
2557 sha1_mid((sha1 *)base, string);
2561 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2563 if (type == HMAC_MD5)
2564 md5_end((md5 *)base, string, length, digest);
2566 sha1_end((sha1 *)base, string, length, digest);
2573 /********************************************************
2574 * prvs: Get last three digits of days since Jan 1, 1970 *
2575 ********************************************************/
2577 /* This is needed to implement the "prvs" BATV reverse
2580 Argument: integer "days" offset to add or substract to
2581 or from the current number of days.
2583 Returns: pointer to string containing the last three
2584 digits of the number of days since Jan 1, 1970,
2585 modified by the offset argument, NULL if there
2586 was an error in the conversion.
2591 prvs_daystamp(int day_offset)
2593 uschar *days = store_get(32); /* Need at least 24 for cases */
2594 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
2595 (time(NULL) + day_offset*86400)/86400);
2596 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2601 /********************************************************
2602 * prvs: perform HMAC-SHA1 computation of prvs bits *
2603 ********************************************************/
2605 /* This is needed to implement the "prvs" BATV reverse
2609 address RFC2821 Address to use
2610 key The key to use (must be less than 64 characters
2612 key_num Single-digit key number to use. Defaults to
2615 Returns: pointer to string containing the first three
2616 bytes of the final hash in hex format, NULL if
2617 there was an error in the process.
2621 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2623 uschar *hash_source, *p;
2624 int size = 0,offset = 0,i;
2626 void *use_base = &sha1_base;
2627 uschar innerhash[20];
2628 uschar finalhash[20];
2629 uschar innerkey[64];
2630 uschar outerkey[64];
2631 uschar *finalhash_hex = store_get(40);
2633 if (key_num == NULL)
2636 if (Ustrlen(key) > 64)
2639 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2640 string_cat(hash_source,&size,&offset,daystamp,3);
2641 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2642 hash_source[offset] = '\0';
2644 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2646 memset(innerkey, 0x36, 64);
2647 memset(outerkey, 0x5c, 64);
2649 for (i = 0; i < Ustrlen(key); i++)
2651 innerkey[i] ^= key[i];
2652 outerkey[i] ^= key[i];
2655 chash_start(HMAC_SHA1, use_base);
2656 chash_mid(HMAC_SHA1, use_base, innerkey);
2657 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2659 chash_start(HMAC_SHA1, use_base);
2660 chash_mid(HMAC_SHA1, use_base, outerkey);
2661 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2664 for (i = 0; i < 3; i++)
2666 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2667 *p++ = hex_digits[finalhash[i] & 0x0f];
2671 return finalhash_hex;
2677 /*************************************************
2678 * Join a file onto the output string *
2679 *************************************************/
2681 /* This is used for readfile and after a run expansion. It joins the contents
2682 of a file onto the output string, globally replacing newlines with a given
2683 string (optionally). The file is closed at the end.
2687 yield pointer to the expandable string
2688 sizep pointer to the current size
2689 ptrp pointer to the current position
2690 eol newline replacement string, or NULL
2692 Returns: new value of string pointer
2696 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2699 uschar buffer[1024];
2701 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2703 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2705 int len = Ustrlen(buffer);
2706 if (eol != NULL && buffer[len-1] == '\n') len--;
2707 yield = string_cat(yield, sizep, ptrp, buffer, len);
2708 if (buffer[len] != 0)
2709 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2712 if (yield != NULL) yield[*ptrp] = 0;
2720 /*************************************************
2721 * Evaluate numeric expression *
2722 *************************************************/
2724 /* This is a set of mutually recursive functions that evaluate an arithmetic
2725 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
2726 these functions that is called from elsewhere is eval_expr, whose interface is:
2729 sptr pointer to the pointer to the string - gets updated
2730 decimal TRUE if numbers are to be assumed decimal
2731 error pointer to where to put an error message - must be NULL on input
2732 endket TRUE if ')' must terminate - FALSE for external call
2734 Returns: on success: the value of the expression, with *error still NULL
2735 on failure: an undefined value, with *error = a message
2738 static int eval_op_or(uschar **, BOOL, uschar **);
2742 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2745 int x = eval_op_or(&s, decimal, error);
2751 *error = US"expecting closing parenthesis";
2753 while (isspace(*(++s)));
2755 else if (*s != 0) *error = US"expecting operator";
2763 eval_number(uschar **sptr, BOOL decimal, uschar **error)
2768 while (isspace(*s)) s++;
2773 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2775 if (tolower(*s) == 'k') { n *= 1024; s++; }
2776 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2777 while (isspace (*s)) s++;
2782 n = eval_expr(&s, decimal, error, 1);
2786 *error = US"expecting number or opening parenthesis";
2794 static int eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
2798 while (isspace(*s)) s++;
2799 if (*s == '+' || *s == '-' || *s == '~')
2802 x = eval_op_unary(&s, decimal, error);
2803 if (op == '-') x = -x;
2804 else if (op == '~') x = ~x;
2808 x = eval_number(&s, decimal, error);
2815 static int eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
2818 int x = eval_op_unary(&s, decimal, error);
2821 while (*s == '*' || *s == '/' || *s == '%')
2824 int y = eval_op_unary(&s, decimal, error);
2825 if (*error != NULL) break;
2826 if (op == '*') x *= y;
2827 else if (op == '/') x /= y;
2836 static int eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
2839 int x = eval_op_mult(&s, decimal, error);
2842 while (*s == '+' || *s == '-')
2845 int y = eval_op_mult(&s, decimal, error);
2846 if (*error != NULL) break;
2847 if (op == '+') x += y; else x -= y;
2855 static int eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
2858 int x = eval_op_sum(&s, decimal, error);
2861 while ((*s == '<' || *s == '>') && s[1] == s[0])
2866 y = eval_op_sum(&s, decimal, error);
2867 if (*error != NULL) break;
2868 if (op == '<') x <<= y; else x >>= y;
2876 static int eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
2879 int x = eval_op_shift(&s, decimal, error);
2886 y = eval_op_shift(&s, decimal, error);
2887 if (*error != NULL) break;
2896 static int eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
2899 int x = eval_op_and(&s, decimal, error);
2906 y = eval_op_and(&s, decimal, error);
2907 if (*error != NULL) break;
2916 static int eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
2919 int x = eval_op_xor(&s, decimal, error);
2926 y = eval_op_xor(&s, decimal, error);
2927 if (*error != NULL) break;
2937 /*************************************************
2939 *************************************************/
2941 /* Returns either an unchanged string, or the expanded string in stacking pool
2942 store. Interpreted sequences are:
2944 \... normal escaping rules
2945 $name substitutes the variable
2947 ${op:string} operates on the expanded string value
2948 ${item{arg1}{arg2}...} expands the args and then does the business
2949 some literal args are not enclosed in {}
2951 There are now far too many operators and item types to make it worth listing
2952 them here in detail any more.
2954 We use an internal routine recursively to handle embedded substrings. The
2955 external function follows. The yield is NULL if the expansion failed, and there
2956 are two cases: if something collapsed syntactically, or if "fail" was given
2957 as the action on a lookup failure. These can be distinguised by looking at the
2958 variable expand_string_forcedfail, which is TRUE in the latter case.
2960 The skipping flag is set true when expanding a substring that isn't actually
2961 going to be used (after "if" or "lookup") and it prevents lookups from
2962 happening lower down.
2964 Store usage: At start, a store block of the length of the input plus 64
2965 is obtained. This is expanded as necessary by string_cat(), which might have to
2966 get a new block, or might be able to expand the original. At the end of the
2967 function we can release any store above that portion of the yield block that
2968 was actually used. In many cases this will be optimal.
2970 However: if the first item in the expansion is a variable name or header name,
2971 we reset the store before processing it; if the result is in fresh store, we
2972 use that without copying. This is helpful for expanding strings like
2973 $message_headers which can get very long.
2976 string the string to be expanded
2977 ket_ends true if expansion is to stop at }
2978 left if not NULL, a pointer to the first character after the
2979 expansion is placed here (typically used with ket_ends)
2980 skipping TRUE for recursive calls when the value isn't actually going
2981 to be used (to allow for optimisation)
2983 Returns: NULL if expansion fails:
2984 expand_string_forcedfail is set TRUE if failure was forced
2985 expand_string_message contains a textual error message
2986 a pointer to the expanded string on success
2990 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
2994 int size = Ustrlen(string)+ 64;
2996 uschar *yield = store_get(size);
2998 uschar *save_expand_nstring[EXPAND_MAXN+1];
2999 int save_expand_nlength[EXPAND_MAXN+1];
3001 expand_string_forcedfail = FALSE;
3002 expand_string_message = US"";
3009 /* \ escapes the next character, which must exist, or else
3010 the expansion fails. There's a special escape, \N, which causes
3011 copying of the subject verbatim up to the next \N. Otherwise,
3012 the escapes are the standard set. */
3018 expand_string_message = US"\\ at end of string";
3025 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3026 yield = string_cat(yield, &size, &ptr, t, s - t);
3027 if (*s != 0) s += 2;
3033 ch[0] = string_interpret_escape(&s);
3035 yield = string_cat(yield, &size, &ptr, ch, 1);
3041 /* Anything other than $ is just copied verbatim, unless we are
3042 looking for a terminating } character. */
3044 if (ket_ends && *s == '}') break;
3048 yield = string_cat(yield, &size, &ptr, s++, 1);
3052 /* No { after the $ - must be a plain name or a number for string
3053 match variable. There has to be a fudge for variables that are the
3054 names of header fields preceded by "$header_" because header field
3055 names can contain any printing characters except space and colon.
3056 For those that don't like typing this much, "$h_" is a synonym for
3057 "$header_". A non-existent header yields a NULL value; nothing is
3060 if (isalpha((*(++s))))
3065 s = read_name(name, sizeof(name), s, US"_");
3067 /* If this is the first thing to be expanded, release the pre-allocated
3070 if (ptr == 0 && yield != NULL)
3079 if (Ustrncmp(name, "h_", 2) == 0 ||
3080 Ustrncmp(name, "rh_", 3) == 0 ||
3081 Ustrncmp(name, "bh_", 3) == 0 ||
3082 Ustrncmp(name, "header_", 7) == 0 ||
3083 Ustrncmp(name, "rheader_", 8) == 0 ||
3084 Ustrncmp(name, "bheader_", 8) == 0)
3086 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3087 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3088 s = read_header_name(name, sizeof(name), s);
3089 value = find_header(name, FALSE, &newsize, want_raw, charset);
3091 /* If we didn't find the header, and the header contains a closing brace
3092 character, this may be a user error where the terminating colon
3093 has been omitted. Set a flag to adjust the error message in this case.
3094 But there is no error here - nothing gets inserted. */
3098 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3107 value = find_variable(name, FALSE, skipping, &newsize);
3110 expand_string_message =
3111 string_sprintf("unknown variable name \"%s\"", name);
3112 check_variable_error_message(name);
3117 /* If the data is known to be in a new buffer, newsize will be set to the
3118 size of that buffer. If this is the first thing in an expansion string,
3119 yield will be NULL; just point it at the new store instead of copying. Many
3120 expansion strings contain just one reference, so this is a useful
3121 optimization, especially for humungous headers. */
3123 len = Ustrlen(value);
3124 if (yield == NULL && newsize != 0)
3130 else yield = string_cat(yield, &size, &ptr, value, len);
3138 s = read_number(&n, s);
3139 if (n >= 0 && n <= expand_nmax)
3140 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3145 /* Otherwise, if there's no '{' after $ it's an error. */
3149 expand_string_message = US"$ not followed by letter, digit, or {";
3153 /* After { there can be various things, but they all start with
3154 an initial word, except for a number for a string match variable. */
3156 if (isdigit((*(++s))))
3159 s = read_number(&n, s);
3162 expand_string_message = US"} expected after number";
3165 if (n >= 0 && n <= expand_nmax)
3166 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3173 expand_string_message = US"letter or digit expected after ${";
3177 /* Allow "-" in names to cater for substrings with negative
3178 arguments. Since we are checking for known names after { this is
3181 s = read_name(name, sizeof(name), s, US"_-");
3182 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3186 /* Handle conditionals - preserve the values of the numerical expansion
3187 variables in case they get changed by a regular expression match in the
3188 condition. If not, they retain their external settings. At the end
3189 of this "if" section, they get restored to their previous values. */
3195 int save_expand_nmax =
3196 save_expand_strings(save_expand_nstring, save_expand_nlength);
3198 while (isspace(*s)) s++;
3199 next_s = eval_condition(s, skipping? NULL : &cond);
3200 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3203 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3204 cond? "true" : "false");
3208 /* The handling of "yes" and "no" result strings is now in a separate
3209 function that is also used by ${lookup} and ${extract} and ${run}. */
3211 switch(process_yesno(
3212 skipping, /* were previously skipping */
3213 cond, /* success/failure indicator */
3214 lookup_value, /* value to reset for string2 */
3215 &s, /* input pointer */
3216 &yield, /* output pointer */
3217 &size, /* output size */
3218 &ptr, /* output current point */
3219 US"if")) /* condition type */
3221 case 1: goto EXPAND_FAILED; /* when all is well, the */
3222 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3225 /* Restore external setting of expansion variables for continuation
3228 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3229 save_expand_nlength);
3233 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3234 expanding an internal string that isn't actually going to be used. All we
3235 need to do is check the syntax, so don't do a lookup at all. Preserve the
3236 values of the numerical expansion variables in case they get changed by a
3237 partial lookup. If not, they retain their external settings. At the end
3238 of this "lookup" section, they get restored to their previous values. */
3242 int stype, partial, affixlen, starflags;
3243 int expand_setup = 0;
3245 uschar *key, *filename, *affix;
3246 uschar *save_lookup_value = lookup_value;
3247 int save_expand_nmax =
3248 save_expand_strings(save_expand_nstring, save_expand_nlength);
3250 if ((expand_forbid & RDO_LOOKUP) != 0)
3252 expand_string_message = US"lookup expansions are not permitted";
3256 /* Get the key we are to look up for single-key+file style lookups.
3257 Otherwise set the key NULL pro-tem. */
3259 while (isspace(*s)) s++;
3262 key = expand_string_internal(s+1, TRUE, &s, skipping);
3263 if (key == NULL) goto EXPAND_FAILED;
3264 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3265 while (isspace(*s)) s++;
3269 /* Find out the type of database */
3273 expand_string_message = US"missing lookup type";
3277 /* The type is a string that may contain special characters of various
3278 kinds. Allow everything except space or { to appear; the actual content
3279 is checked by search_findtype_partial. */
3281 while (*s != 0 && *s != '{' && !isspace(*s))
3283 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3287 while (isspace(*s)) s++;
3289 /* Now check for the individual search type and any partial or default
3290 options. Only those types that are actually in the binary are valid. */
3292 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3296 expand_string_message = search_error_message;
3300 /* Check that a key was provided for those lookup types that need it,
3301 and was not supplied for those that use the query style. */
3303 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3307 expand_string_message = string_sprintf("missing {key} for single-"
3308 "key \"%s\" lookup", name);
3316 expand_string_message = string_sprintf("a single key was given for "
3317 "lookup type \"%s\", which is not a single-key lookup type", name);
3322 /* Get the next string in brackets and expand it. It is the file name for
3323 single-key+file lookups, and the whole query otherwise. In the case of
3324 queries that also require a file name (e.g. sqlite), the file name comes
3327 if (*s != '{') goto EXPAND_FAILED_CURLY;
3328 filename = expand_string_internal(s+1, TRUE, &s, skipping);
3329 if (filename == NULL) goto EXPAND_FAILED;
3330 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3331 while (isspace(*s)) s++;
3333 /* If this isn't a single-key+file lookup, re-arrange the variables
3334 to be appropriate for the search_ functions. For query-style lookups,
3335 there is just a "key", and no file name. For the special query-style +
3336 file types, the query (i.e. "key") starts with a file name. */
3340 while (isspace(*filename)) filename++;
3343 if (mac_islookup(stype, lookup_querystyle))
3349 if (*filename != '/')
3351 expand_string_message = string_sprintf(
3352 "absolute file name expected for \"%s\" lookup", name);
3355 while (*key != 0 && !isspace(*key)) key++;
3356 if (*key != 0) *key++ = 0;
3360 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3361 the entry was not found. Note that there is no search_close() function.
3362 Files are left open in case of re-use. At suitable places in higher logic,
3363 search_tidyup() is called to tidy all open files. This can save opening
3364 the same file several times. However, files may also get closed when
3365 others are opened, if too many are open at once. The rule is that a
3366 handle should not be used after a second search_open().
3368 Request that a partial search sets up $1 and maybe $2 by passing
3369 expand_setup containing zero. If its value changes, reset expand_nmax,
3370 since new variables will have been set. Note that at the end of this
3371 "lookup" section, the old numeric variables are restored. */
3374 lookup_value = NULL;
3377 void *handle = search_open(filename, stype, 0, NULL, NULL);
3380 expand_string_message = search_error_message;
3383 lookup_value = search_find(handle, filename, key, partial, affix,
3384 affixlen, starflags, &expand_setup);
3385 if (search_find_defer)
3387 expand_string_message =
3388 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3389 search_error_message);
3392 if (expand_setup > 0) expand_nmax = expand_setup;
3395 /* The handling of "yes" and "no" result strings is now in a separate
3396 function that is also used by ${if} and ${extract}. */
3398 switch(process_yesno(
3399 skipping, /* were previously skipping */
3400 lookup_value != NULL, /* success/failure indicator */
3401 save_lookup_value, /* value to reset for string2 */
3402 &s, /* input pointer */
3403 &yield, /* output pointer */
3404 &size, /* output size */
3405 &ptr, /* output current point */
3406 US"lookup")) /* condition type */
3408 case 1: goto EXPAND_FAILED; /* when all is well, the */
3409 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3412 /* Restore external setting of expansion variables for carrying on
3413 at this level, and continue. */
3415 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3416 save_expand_nlength);
3420 /* If Perl support is configured, handle calling embedded perl subroutines,
3421 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3422 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3423 arguments (defined below). */
3425 #define EXIM_PERL_MAX_ARGS 8
3429 expand_string_message = US"\"${perl\" encountered, but this facility "
3430 "is not included in this binary";
3433 #else /* EXIM_PERL */
3435 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3438 if ((expand_forbid & RDO_PERL) != 0)
3440 expand_string_message = US"Perl calls are not permitted";
3444 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3447 case 1: goto EXPAND_FAILED_CURLY;
3449 case 3: goto EXPAND_FAILED;
3452 /* If skipping, we don't actually do anything */
3454 if (skipping) continue;
3456 /* Start the interpreter if necessary */
3458 if (!opt_perl_started)
3461 if (opt_perl_startup == NULL)
3463 expand_string_message = US"A setting of perl_startup is needed when "
3464 "using the Perl interpreter";
3467 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3468 initerror = init_perl(opt_perl_startup);
3469 if (initerror != NULL)
3471 expand_string_message =
3472 string_sprintf("error in perl_startup code: %s\n", initerror);
3475 opt_perl_started = TRUE;
3478 /* Call the function */
3480 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3481 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3482 sub_arg[0], sub_arg + 1);
3484 /* NULL yield indicates failure; if the message pointer has been set to
3485 NULL, the yield was undef, indicating a forced failure. Otherwise the
3486 message will indicate some kind of Perl error. */
3488 if (new_yield == NULL)
3490 if (expand_string_message == NULL)
3492 expand_string_message =
3493 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3494 "failure", sub_arg[0]);
3495 expand_string_forcedfail = TRUE;
3500 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3501 set during a callback from Perl. */
3503 expand_string_forcedfail = FALSE;
3507 #endif /* EXIM_PERL */
3509 /* Transform email address to "prvs" scheme to use
3510 as BATV-signed return path */
3517 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3519 case 1: goto EXPAND_FAILED_CURLY;
3521 case 3: goto EXPAND_FAILED;
3524 /* If skipping, we don't actually do anything */
3525 if (skipping) continue;
3527 /* sub_arg[0] is the address */
3528 domain = Ustrrchr(sub_arg[0],'@');
3529 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3531 expand_string_message = US"prvs first argument must be a qualified email address";
3535 /* Calculate the hash. The second argument must be a single-digit
3536 key number, or unset. */
3538 if (sub_arg[2] != NULL &&
3539 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3541 expand_string_message = US"prvs second argument must be a single digit";
3545 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3548 expand_string_message = US"prvs hmac-sha1 conversion failed";
3552 /* Now separate the domain from the local part */
3555 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3556 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3557 string_cat(yield,&size,&ptr,US"/",1);
3558 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3559 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3560 string_cat(yield,&size,&ptr,p,6);
3561 string_cat(yield,&size,&ptr,US"@",1);
3562 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3567 /* Check a prvs-encoded address for validity */
3569 case EITEM_PRVSCHECK:
3572 int mysize = 0, myptr = 0;
3576 /* TF: Ugliness: We want to expand parameter 1 first, then set
3577 up expansion variables that are used in the expansion of
3578 parameter 2. So we clone the string for the first
3579 expansion, where we only expand parameter 1.
3581 PH: Actually, that isn't necessary. The read_subs() function is
3582 designed to work this way for the ${if and ${lookup expansions. I've
3586 /* Reset expansion variables */
3587 prvscheck_result = NULL;
3588 prvscheck_address = NULL;
3589 prvscheck_keynum = NULL;
3591 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3593 case 1: goto EXPAND_FAILED_CURLY;
3595 case 3: goto EXPAND_FAILED;
3598 re = regex_must_compile(US"^prvs\\=(.+)\\/([0-9])([0-9]{3})([A-F0-9]{6})\\@(.+)$",
3601 if (regex_match_and_setup(re,sub_arg[0],0,-1))
3603 uschar *local_part = string_copyn(expand_nstring[1],expand_nlength[1]);
3604 uschar *key_num = string_copyn(expand_nstring[2],expand_nlength[2]);
3605 uschar *daystamp = string_copyn(expand_nstring[3],expand_nlength[3]);
3606 uschar *hash = string_copyn(expand_nstring[4],expand_nlength[4]);
3607 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3609 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3610 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3611 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3612 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3613 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3615 /* Set up expansion variables */
3616 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3617 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3618 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3619 prvscheck_address[myptr] = '\0';
3620 prvscheck_keynum = string_copy(key_num);
3622 /* Now expand the second argument */
3623 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3625 case 1: goto EXPAND_FAILED_CURLY;
3627 case 3: goto EXPAND_FAILED;
3630 /* Now we have the key and can check the address. */
3632 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
3637 expand_string_message = US"hmac-sha1 conversion failed";
3641 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3642 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
3644 if (Ustrcmp(p,hash) == 0)
3646 /* Success, valid BATV address. Now check the expiry date. */
3647 uschar *now = prvs_daystamp(0);
3648 unsigned int inow = 0,iexpire = 1;
3650 (void)sscanf(CS now,"%u",&inow);
3651 (void)sscanf(CS daystamp,"%u",&iexpire);
3653 /* When "iexpire" is < 7, a "flip" has occured.
3654 Adjust "inow" accordingly. */
3655 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3659 prvscheck_result = US"1";
3660 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3664 prvscheck_result = NULL;
3665 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3670 prvscheck_result = NULL;
3671 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
3674 /* Now expand the final argument. We leave this till now so that
3675 it can include $prvscheck_result. */
3677 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
3679 case 1: goto EXPAND_FAILED_CURLY;
3681 case 3: goto EXPAND_FAILED;
3684 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
3685 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
3687 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3689 /* Reset the "internal" variables afterwards, because they are in
3690 dynamic store that will be reclaimed if the expansion succeeded. */
3692 prvscheck_address = NULL;
3693 prvscheck_keynum = NULL;
3697 /* Does not look like a prvs encoded address, return the empty string.
3698 We need to make sure all subs are expanded first, so as to skip over
3701 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
3703 case 1: goto EXPAND_FAILED_CURLY;
3705 case 3: goto EXPAND_FAILED;
3712 /* Handle "readfile" to insert an entire file */
3714 case EITEM_READFILE:
3719 if ((expand_forbid & RDO_READFILE) != 0)
3721 expand_string_message = US"file insertions are not permitted";
3725 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3727 case 1: goto EXPAND_FAILED_CURLY;
3729 case 3: goto EXPAND_FAILED;
3732 /* If skipping, we don't actually do anything */
3734 if (skipping) continue;
3736 /* Open the file and read it */
3738 f = Ufopen(sub_arg[0], "rb");
3741 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3745 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3750 /* Handle "readsocket" to insert data from a Unix domain socket */
3752 case EITEM_READSOCK:
3758 struct sockaddr_un sockun; /* don't call this "sun" ! */
3762 if ((expand_forbid & RDO_READSOCK) != 0)
3764 expand_string_message = US"socket insertions are not permitted";
3768 /* Read up to 4 arguments, but don't do the end of item check afterwards,
3769 because there may be a string for expansion on failure. */
3771 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3773 case 1: goto EXPAND_FAILED_CURLY;
3774 case 2: /* Won't occur: no end check */
3775 case 3: goto EXPAND_FAILED;
3778 /* Sort out timeout, if given */
3780 if (sub_arg[2] != NULL)
3782 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3785 expand_string_message = string_sprintf("bad time value %s",
3790 else sub_arg[3] = NULL; /* No eol if no timeout */
3792 /* If skipping, we don't actually do anything. Otherwise, arrange to
3793 connect to either an IP or a Unix socket. */
3797 /* Handle an IP (internet) domain */
3799 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
3801 BOOL connected = FALSE;
3805 uschar *server_name = sub_arg[0] + 5;
3806 uschar *port_name = Ustrrchr(server_name, ':');
3808 /* Sort out the port */
3810 if (port_name == NULL)
3812 expand_string_message =
3813 string_sprintf("missing port for readsocket %s", sub_arg[0]);
3816 *port_name++ = 0; /* Terminate server name */
3818 if (isdigit(*port_name))
3821 port = Ustrtol(port_name, &end, 0);
3822 if (end != port_name + Ustrlen(port_name))
3824 expand_string_message =
3825 string_sprintf("invalid port number %s", port_name);
3831 struct servent *service_info = getservbyname(CS port_name, "tcp");
3832 if (service_info == NULL)
3834 expand_string_message = string_sprintf("unknown port \"%s\"",
3838 port = ntohs(service_info->s_port);
3841 /* Sort out the server. */
3844 shost.address = NULL;
3848 namelen = Ustrlen(server_name);
3850 /* Anything enclosed in [] must be an IP address. */
3852 if (server_name[0] == '[' &&
3853 server_name[namelen - 1] == ']')
3855 server_name[namelen - 1] = 0;
3857 if (string_is_ip_address(server_name, NULL) == 0)
3859 expand_string_message =
3860 string_sprintf("malformed IP address \"%s\"", server_name);
3863 shost.name = shost.address = server_name;
3866 /* Otherwise check for an unadorned IP address */
3868 else if (string_is_ip_address(server_name, NULL) != 0)
3869 shost.name = shost.address = server_name;
3871 /* Otherwise lookup IP address(es) from the name */
3875 shost.name = server_name;
3876 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
3877 FALSE) != HOST_FOUND)
3879 expand_string_message =
3880 string_sprintf("no IP address found for host %s", shost.name);
3885 /* Try to connect to the server - test each IP till one works */
3887 for (h = &shost; h != NULL; h = h->next)
3889 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
3890 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
3892 expand_string_message = string_sprintf("failed to create socket: "
3893 "%s", strerror(errno));
3897 if (ip_connect(fd, af, h->address, port, timeout) == 0)
3906 expand_string_message = string_sprintf("failed to connect to "
3907 "socket %s: couldn't connect to any host", sub_arg[0],
3913 /* Handle a Unix domain socket */
3917 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3919 expand_string_message = string_sprintf("failed to create socket: %s",
3924 sockun.sun_family = AF_UNIX;
3925 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3927 if(connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun)) == -1)
3929 expand_string_message = string_sprintf("failed to connect to socket "
3930 "%s: %s", sub_arg[0], strerror(errno));
3935 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
3937 /* Write the request string, if not empty */
3939 if (sub_arg[1][0] != 0)
3941 int len = Ustrlen(sub_arg[1]);
3942 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
3944 if (write(fd, sub_arg[1], len) != len)
3946 expand_string_message = string_sprintf("request write to socket "
3947 "failed: %s", strerror(errno));
3952 /* Shut down the sending side of the socket. This helps some servers to
3953 recognise that it is their turn to do some work. Just in case some
3954 system doesn't have this function, make it conditional. */
3957 shutdown(fd, SHUT_WR);
3960 /* Now we need to read from the socket, under a timeout. The function
3961 that reads a file can be used. */
3963 f = fdopen(fd, "rb");
3964 sigalrm_seen = FALSE;
3966 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
3970 /* After a timeout, we restore the pointer in the result, that is,
3971 make sure we add nothing from the socket. */
3976 expand_string_message = US "socket read timed out";
3981 /* The whole thing has worked (or we were skipping). If there is a
3982 failure string following, we need to skip it. */
3986 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
3988 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3989 while (isspace(*s)) s++;
3991 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3994 /* Come here on failure to create socket, connect socket, write to the
3995 socket, or timeout on reading. If another substring follows, expand and
3996 use it. Otherwise, those conditions give expand errors. */
3999 if (*s != '{') goto EXPAND_FAILED;
4000 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4001 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
4002 if (arg == NULL) goto EXPAND_FAILED;
4003 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4004 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4005 while (isspace(*s)) s++;
4006 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4010 /* Handle "run" to execute a program. */
4022 if ((expand_forbid & RDO_RUN) != 0)
4024 expand_string_message = US"running a command is not permitted";
4028 while (isspace(*s)) s++;
4029 if (*s != '{') goto EXPAND_FAILED_CURLY;
4030 arg = expand_string_internal(s+1, TRUE, &s, skipping);
4031 if (arg == NULL) goto EXPAND_FAILED;
4032 while (isspace(*s)) s++;
4033 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4035 if (skipping) /* Just pretend it worked when we're skipping */
4041 if (!transport_set_up_command(&argv, /* anchor for arg list */
4042 arg, /* raw command */
4043 FALSE, /* don't expand the arguments */
4044 0, /* not relevant when... */
4045 NULL, /* no transporting address */
4046 US"${run} expansion", /* for error messages */
4047 &expand_string_message)) /* where to put error message */
4052 /* Create the child process, making it a group leader. */
4054 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4058 expand_string_message =
4059 string_sprintf("couldn't create child process: %s", strerror(errno));
4063 /* Nothing is written to the standard input. */
4067 /* Wait for the process to finish, applying the timeout, and inspect its
4068 return code for serious disasters. Simple non-zero returns are passed on.
4071 if ((runrc = child_close(pid, 60)) < 0)
4075 expand_string_message = string_sprintf("command timed out");
4076 killpg(pid, SIGKILL); /* Kill the whole process group */
4079 else if (runrc == -257)
4080 expand_string_message = string_sprintf("wait() failed: %s",
4084 expand_string_message = string_sprintf("command killed by signal %d",
4090 /* Read the pipe to get the command's output into $value (which is kept
4091 in lookup_value). */
4093 f = fdopen(fd_out, "rb");
4094 lookup_value = NULL;
4095 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4099 /* Process the yes/no strings; $value may be useful in both cases */
4101 switch(process_yesno(
4102 skipping, /* were previously skipping */
4103 runrc == 0, /* success/failure indicator */
4104 lookup_value, /* value to reset for string2 */
4105 &s, /* input pointer */
4106 &yield, /* output pointer */
4107 &size, /* output size */
4108 &ptr, /* output current point */
4109 US"run")) /* condition type */
4111 case 1: goto EXPAND_FAILED; /* when all is well, the */
4112 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4118 /* Handle character translation for "tr" */
4126 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4128 case 1: goto EXPAND_FAILED_CURLY;
4130 case 3: goto EXPAND_FAILED;
4133 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4134 o2m = Ustrlen(sub[2]) - 1;
4136 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4138 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4142 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4149 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4150 expanded arguments. */
4160 int val[2] = { 0, -1 };
4163 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4164 Ensure that sub[2] is set in the ${length case. */
4167 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4170 case 1: goto EXPAND_FAILED_CURLY;
4172 case 3: goto EXPAND_FAILED;
4175 /* Juggle the arguments if there are only two of them: always move the
4176 string to the last position and make ${length{n}{str}} equivalent to
4177 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4183 if (item_type == EITEM_LENGTH)
4190 for (i = 0; i < 2; i++)
4192 if (sub[i] == NULL) continue;
4193 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4194 if (*ret != 0 || (i != 0 && val[i] < 0))
4196 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4197 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4203 (item_type == EITEM_HASH)?
4204 compute_hash(sub[2], val[0], val[1], &len) :
4205 (item_type == EITEM_NHASH)?
4206 compute_nhash(sub[2], val[0], val[1], &len) :
4207 extract_substr(sub[2], val[0], val[1], &len);
4209 if (ret == NULL) goto EXPAND_FAILED;
4210 yield = string_cat(yield, &size, &ptr, ret, len);
4214 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4215 This code originally contributed by Steve Haslam. It currently supports
4216 the use of MD5 and SHA-1 hashes.
4218 We need some workspace that is large enough to handle all the supported
4219 hash types. Use macros to set the sizes rather than be too elaborate. */
4221 #define MAX_HASHLEN 20
4222 #define MAX_HASHBLOCKLEN 64
4231 int hashlen; /* Number of octets for the hash algorithm's output */
4232 int hashblocklen; /* Number of octets the hash algorithm processes */
4234 unsigned int keylen;
4236 uschar keyhash[MAX_HASHLEN];
4237 uschar innerhash[MAX_HASHLEN];
4238 uschar finalhash[MAX_HASHLEN];
4239 uschar finalhash_hex[2*MAX_HASHLEN];
4240 uschar innerkey[MAX_HASHBLOCKLEN];
4241 uschar outerkey[MAX_HASHBLOCKLEN];
4243 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4245 case 1: goto EXPAND_FAILED_CURLY;
4247 case 3: goto EXPAND_FAILED;
4250 if (Ustrcmp(sub[0], "md5") == 0)
4253 use_base = &md5_base;
4257 else if (Ustrcmp(sub[0], "sha1") == 0)
4260 use_base = &sha1_base;
4266 expand_string_message =
4267 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4272 keylen = Ustrlen(keyptr);
4274 /* If the key is longer than the hash block length, then hash the key
4277 if (keylen > hashblocklen)
4279 chash_start(type, use_base);
4280 chash_end(type, use_base, keyptr, keylen, keyhash);
4285 /* Now make the inner and outer key values */
4287 memset(innerkey, 0x36, hashblocklen);
4288 memset(outerkey, 0x5c, hashblocklen);
4290 for (i = 0; i < keylen; i++)
4292 innerkey[i] ^= keyptr[i];
4293 outerkey[i] ^= keyptr[i];
4296 /* Now do the hashes */
4298 chash_start(type, use_base);
4299 chash_mid(type, use_base, innerkey);
4300 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4302 chash_start(type, use_base);
4303 chash_mid(type, use_base, outerkey);
4304 chash_end(type, use_base, innerhash, hashlen, finalhash);
4306 /* Encode the final hash as a hex string */
4309 for (i = 0; i < hashlen; i++)
4311 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4312 *p++ = hex_digits[finalhash[i] & 0x0f];
4315 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4316 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4318 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4323 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4324 We have to save the numerical variables and restore them afterwards. */
4329 int moffset, moffsetextra, slen;
4332 const uschar *rerror;
4335 int save_expand_nmax =
4336 save_expand_strings(save_expand_nstring, save_expand_nlength);
4338 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4340 case 1: goto EXPAND_FAILED_CURLY;
4342 case 3: goto EXPAND_FAILED;
4345 /* Compile the regular expression */
4347 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4352 expand_string_message = string_sprintf("regular expression error in "
4353 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4357 /* Now run a loop to do the substitutions as often as necessary. It ends
4358 when there are no more matches. Take care over matches of the null string;
4359 do the same thing as Perl does. */
4362 slen = Ustrlen(sub[0]);
4363 moffset = moffsetextra = 0;
4368 int ovector[3*(EXPAND_MAXN+1)];
4369 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4370 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4374 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4375 is not necessarily the end. We want to repeat the match from one
4376 character further along, but leaving the basic offset the same (for
4377 copying below). We can't be at the end of the string - that was checked
4378 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4379 finished; copy the remaining string and end the loop. */
4389 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4393 /* Match - set up for expanding the replacement. */
4395 if (n == 0) n = EXPAND_MAXN + 1;
4397 for (nn = 0; nn < n*2; nn += 2)
4399 expand_nstring[expand_nmax] = subject + ovector[nn];
4400 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4404 /* Copy the characters before the match, plus the expanded insertion. */
4406 yield = string_cat(yield, &size, &ptr, subject + moffset,
4407 ovector[0] - moffset);
4408 insert = expand_string(sub[2]);
4409 if (insert == NULL) goto EXPAND_FAILED;
4410 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4412 moffset = ovector[1];
4416 /* If we have matched an empty string, first check to see if we are at
4417 the end of the subject. If so, the loop is over. Otherwise, mimic
4418 what Perl's /g options does. This turns out to be rather cunning. First
4419 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4420 string at the same point. If this fails (picked up above) we advance to
4421 the next character. */
4423 if (ovector[0] == ovector[1])
4425 if (ovector[0] == slen) break;
4426 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4430 /* All done - restore numerical variables. */
4432 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4433 save_expand_nlength);
4437 /* Handle keyed and numbered substring extraction. If the first argument
4438 consists entirely of digits, then a numerical extraction is assumed. */
4444 int field_number = 1;
4445 BOOL field_number_set = FALSE;
4446 uschar *save_lookup_value = lookup_value;
4448 int save_expand_nmax =
4449 save_expand_strings(save_expand_nstring, save_expand_nlength);
4451 /* Read the arguments */
4453 for (i = 0; i < j; i++)
4455 while (isspace(*s)) s++;
4458 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4459 if (sub[i] == NULL) goto EXPAND_FAILED;
4460 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4462 /* After removal of leading and trailing white space, the first
4463 argument must not be empty; if it consists entirely of digits
4464 (optionally preceded by a minus sign), this is a numerical
4465 extraction, and we expect 3 arguments. */
4473 while (isspace(*p)) p++;
4477 while (len > 0 && isspace(p[len-1])) len--;
4482 expand_string_message = US"first argument of \"extract\" must "
4492 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4496 j = 3; /* Need 3 args */
4497 field_number_set = TRUE;
4501 else goto EXPAND_FAILED_CURLY;
4504 /* Extract either the numbered or the keyed substring into $value. If
4505 skipping, just pretend the extraction failed. */
4507 lookup_value = skipping? NULL : field_number_set?
4508 expand_gettokened(field_number, sub[1], sub[2]) :
4509 expand_getkeyed(sub[0], sub[1]);
4511 /* If no string follows, $value gets substituted; otherwise there can
4512 be yes/no strings, as for lookup or if. */
4514 switch(process_yesno(
4515 skipping, /* were previously skipping */
4516 lookup_value != NULL, /* success/failure indicator */
4517 save_lookup_value, /* value to reset for string2 */
4518 &s, /* input pointer */
4519 &yield, /* output pointer */
4520 &size, /* output size */
4521 &ptr, /* output current point */
4522 US"extract")) /* condition type */
4524 case 1: goto EXPAND_FAILED; /* when all is well, the */
4525 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4528 /* All done - restore numerical variables. */
4530 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4531 save_expand_nlength);
4537 /* If ${dlfunc support is configured, handle calling dynamically-loaded
4538 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
4539 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
4540 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
4542 #define EXPAND_DLFUNC_MAX_ARGS 8
4545 #ifndef EXPAND_DLFUNC
4546 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
4547 "is not included in this binary";
4550 #else /* EXPAND_DLFUNC */
4553 exim_dlfunc_t *func;
4556 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
4558 if ((expand_forbid & RDO_DLFUNC) != 0)
4560 expand_string_message =
4561 US"dynamically-loaded functions are not permitted";
4565 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
4568 case 1: goto EXPAND_FAILED_CURLY;
4570 case 3: goto EXPAND_FAILED;
4573 /* If skipping, we don't actually do anything */
4575 if (skipping) continue;
4577 /* Look up the dynamically loaded object handle in the tree. If it isn't
4578 found, dlopen() the file and put the handle in the tree for next time. */
4580 t = tree_search(dlobj_anchor, argv[0]);
4583 void *handle = dlopen(CS argv[0], RTLD_LAZY);
4586 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
4587 argv[0], dlerror());
4588 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4591 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
4592 Ustrcpy(t->name, argv[0]);
4593 t->data.ptr = handle;
4594 (void)tree_insertnode(&dlobj_anchor, t);
4597 /* Having obtained the dynamically loaded object handle, look up the
4598 function pointer. */
4600 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
4603 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
4604 "%s", argv[1], argv[0], dlerror());
4605 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4609 /* Call the function and work out what to do with the result. If it
4610 returns OK, we have a replacement string; if it returns DEFER then
4611 expansion has failed in a non-forced manner; if it returns FAIL then
4612 failure was forced; if it returns ERROR or any other value there's a
4613 problem, so panic slightly. */
4616 for (argc = 0; argv[argc] != NULL; argc++);
4617 status = func(&result, argc - 2, &argv[2]);
4620 if (result == NULL) result = US"";
4621 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
4626 expand_string_message = result == NULL ? US"(no message)" : result;
4627 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
4628 else if(status != FAIL)
4629 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
4630 argv[0], argv[1], status, expand_string_message);
4634 #endif /* EXPAND_DLFUNC */
4637 /* Control reaches here if the name is not recognized as one of the more
4638 complicated expansion items. Check for the "operator" syntax (name terminated
4639 by a colon). Some of the operators have arguments, separated by _ from the
4646 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
4647 if (sub == NULL) goto EXPAND_FAILED;
4650 /* Owing to an historical mis-design, an underscore may be part of the
4651 operator name, or it may introduce arguments. We therefore first scan the
4652 table of names that contain underscores. If there is no match, we cut off
4653 the arguments and then scan the main table. */
4655 c = chop_match(name, op_table_underscore,
4656 sizeof(op_table_underscore)/sizeof(uschar *));
4660 arg = Ustrchr(name, '_');
4661 if (arg != NULL) *arg = 0;
4662 c = chop_match(name, op_table_main,
4663 sizeof(op_table_main)/sizeof(uschar *));
4664 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
4665 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
4668 /* If we are skipping, we don't need to perform the operation at all.
4669 This matters for operations like "mask", because the data may not be
4670 in the correct format when skipping. For example, the expression may test
4671 for the existence of $sender_host_address before trying to mask it. For
4672 other operations, doing them may not fail, but it is a waste of time. */
4674 if (skipping && c >= 0) continue;
4676 /* Otherwise, switch on the operator type */
4683 unsigned long int n = Ustrtoul(sub, &t, 10);
4686 expand_string_message = string_sprintf("argument for base62 "
4687 "operator is \"%s\", which is not a decimal number", sub);
4690 t = string_base62(n);
4691 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4695 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
4701 unsigned long int n = 0;
4704 uschar *t = Ustrchr(base62_chars, *tt++);
4707 expand_string_message = string_sprintf("argument for base62d "
4708 "operator is \"%s\", which is not a base %d number", sub,
4712 n = n * BASE_62 + (t - base62_chars);
4714 (void)sprintf(CS buf, "%ld", n);
4715 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
4721 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
4722 if (expanded == NULL)
4724 expand_string_message =
4725 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
4726 expand_string_message);
4729 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
4736 uschar *t = sub - 1;
4737 while (*(++t) != 0) { *t = tolower(*t); count++; }
4738 yield = string_cat(yield, &size, &ptr, sub, count);
4745 uschar *t = sub - 1;
4746 while (*(++t) != 0) { *t = toupper(*t); count++; }
4747 yield = string_cat(yield, &size, &ptr, sub, count);
4758 md5_end(&base, sub, Ustrlen(sub), digest);
4759 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
4760 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4771 sha1_end(&base, sub, Ustrlen(sub), digest);
4772 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
4773 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4777 /* Convert hex encoding to base64 encoding */
4787 for (enc = sub; *enc != 0; enc++)
4789 if (!isxdigit(*enc))
4791 expand_string_message = string_sprintf("\"%s\" is not a hex "
4800 expand_string_message = string_sprintf("\"%s\" contains an odd "
4801 "number of characters", sub);
4805 while ((c = *in++) != 0)
4807 if (isdigit(c)) c -= '0';
4808 else c = toupper(c) - 'A' + 10;
4820 enc = auth_b64encode(sub, out - sub);
4821 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
4825 /* mask applies a mask to an IP address; for example the result of
4826 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
4833 int mask, maskoffset;
4834 int type = string_is_ip_address(sub, &maskoffset);
4839 expand_string_message = string_sprintf("\"%s\" is not an IP address",
4844 if (maskoffset == 0)
4846 expand_string_message = string_sprintf("missing mask value in \"%s\"",
4851 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
4853 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
4855 expand_string_message = string_sprintf("mask value too big in \"%s\"",
4860 /* Convert the address to binary integer(s) and apply the mask */
4862 sub[maskoffset] = 0;
4863 count = host_aton(sub, binary);
4864 host_mask(count, binary, mask);
4866 /* Convert to masked textual format and add to output. */
4868 yield = string_cat(yield, &size, &ptr, buffer,
4869 host_nmtoa(count, binary, mask, buffer, '.'));
4874 case EOP_LOCAL_PART:
4878 int start, end, domain;
4879 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
4883 if (c != EOP_DOMAIN)
4885 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
4886 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
4888 else if (domain != 0)
4891 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
4897 /* quote puts a string in quotes if it is empty or contains anything
4898 other than alphamerics, underscore, dot, or hyphen.
4900 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
4901 be quoted in order to be a valid local part.
4903 In both cases, newlines and carriage returns are converted into \n and \r
4907 case EOP_QUOTE_LOCAL_PART:
4910 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
4911 uschar *t = sub - 1;
4915 while (!needs_quote && *(++t) != 0)
4916 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4918 else /* EOP_QUOTE_LOCAL_PART */
4920 while (!needs_quote && *(++t) != 0)
4921 needs_quote = !isalnum(*t) &&
4922 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
4923 (*t != '.' || t == sub || t[1] == 0);
4928 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4933 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
4934 else if (*t == '\r')
4935 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
4938 if (*t == '\\' || *t == '"')
4939 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4940 yield = string_cat(yield, &size, &ptr, t, 1);
4943 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4945 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4949 /* quote_lookuptype does lookup-specific quoting */
4954 uschar *opt = Ustrchr(arg, '_');
4956 if (opt != NULL) *opt++ = 0;
4958 n = search_findtype(arg, Ustrlen(arg));
4961 expand_string_message = search_error_message;
4965 if (lookup_list[n].quote != NULL)
4966 sub = (lookup_list[n].quote)(sub, opt);
4967 else if (opt != NULL) sub = NULL;
4971 expand_string_message = string_sprintf(
4972 "\"%s\" unrecognized after \"${quote_%s\"",
4977 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4981 /* rx quote sticks in \ before any non-alphameric character so that
4982 the insertion works in a regular expression. */
4986 uschar *t = sub - 1;
4990 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4991 yield = string_cat(yield, &size, &ptr, t, 1);
4996 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
4997 prescribed by the RFC, if there are characters that need to be encoded */
5001 uschar buffer[2048];
5002 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5003 buffer, sizeof(buffer), FALSE);
5004 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
5008 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
5018 if (c > 255) c = '_';
5020 yield = string_cat(yield, &size, &ptr, buff, 1);
5025 /* escape turns all non-printing characters into escape sequences. */
5029 uschar *t = string_printing(sub);
5030 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5034 /* Handle numeric expression evaluation */
5039 uschar *save_sub = sub;
5040 uschar *error = NULL;
5041 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
5044 expand_string_message = string_sprintf("error in expression "
5045 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
5049 sprintf(CS var_buffer, "%d", n);
5050 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5054 /* Handle time period formating */
5058 int n = readconf_readtime(sub, 0, FALSE);
5061 expand_string_message = string_sprintf("string \"%s\" is not an "
5062 "Exim time interval in \"%s\" operator", sub, name);
5065 sprintf(CS var_buffer, "%d", n);
5066 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5070 case EOP_TIME_INTERVAL:
5073 uschar *t = read_number(&n, sub);
5074 if (*t != 0) /* Not A Number*/
5076 expand_string_message = string_sprintf("string \"%s\" is not a "
5077 "positive number in \"%s\" operator", sub, name);
5080 t = readconf_printtime(n);
5081 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5085 /* Convert string to base64 encoding */
5089 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
5090 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
5094 /* strlen returns the length of the string */
5099 (void)sprintf(CS buff, "%d", Ustrlen(sub));
5100 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
5104 /* length_n or l_n takes just the first n characters or the whole string,
5105 whichever is the shorter;
5107 substr_m_n, and s_m_n take n characters from offset m; negative m take
5108 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
5109 takes the rest, either to the right or to the left.
5111 hash_n or h_n makes a hash of length n from the string, yielding n
5112 characters from the set a-z; hash_n_m makes a hash of length n, but
5113 uses m characters from the set a-zA-Z0-9.
5115 nhash_n returns a single number between 0 and n-1 (in text form), while
5116 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
5117 between 0 and n-1 and the second between 0 and m-1. */
5137 expand_string_message = string_sprintf("missing values after %s",
5142 /* "length" has only one argument, effectively being synonymous with
5145 if (c == EOP_LENGTH || c == EOP_L)
5151 /* The others have one or two arguments; for "substr" the first may be
5152 negative. The second being negative means "not supplied". */
5157 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
5160 /* Read up to two numbers, separated by underscores */
5165 if (arg != ret && *arg == '_' && pn == &value1)
5169 if (arg[1] != 0) arg++;
5171 else if (!isdigit(*arg))
5173 expand_string_message =
5174 string_sprintf("non-digit after underscore in \"%s\"", name);
5177 else *pn = (*pn)*10 + *arg++ - '0';
5181 /* Perform the required operation */
5184 (c == EOP_HASH || c == EOP_H)?
5185 compute_hash(sub, value1, value2, &len) :
5186 (c == EOP_NHASH || c == EOP_NH)?
5187 compute_nhash(sub, value1, value2, &len) :
5188 extract_substr(sub, value1, value2, &len);
5190 if (ret == NULL) goto EXPAND_FAILED;
5191 yield = string_cat(yield, &size, &ptr, ret, len);
5201 uschar **modetable[3];
5206 if ((expand_forbid & RDO_EXISTS) != 0)
5208 expand_string_message = US"Use of the stat() expansion is not permitted";
5212 if (stat(CS sub, &st) < 0)
5214 expand_string_message = string_sprintf("stat(%s) failed: %s",
5215 sub, strerror(errno));
5219 switch (mode & S_IFMT)
5221 case S_IFIFO: smode[0] = 'p'; break;
5222 case S_IFCHR: smode[0] = 'c'; break;
5223 case S_IFDIR: smode[0] = 'd'; break;
5224 case S_IFBLK: smode[0] = 'b'; break;
5225 case S_IFREG: smode[0] = '-'; break;
5226 default: smode[0] = '?'; break;
5229 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
5230 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
5231 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
5233 for (i = 0; i < 3; i++)
5235 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
5240 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
5241 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
5242 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
5243 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
5244 (long)st.st_gid, st.st_size, (long)st.st_atime,
5245 (long)st.st_mtime, (long)st.st_ctime);
5246 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5250 /* Unknown operator */
5253 expand_string_message =
5254 string_sprintf("unknown expansion operator \"%s\"", name);
5259 /* Handle a plain name. If this is the first thing in the expansion, release
5260 the pre-allocated buffer. If the result data is known to be in a new buffer,
5261 newsize will be set to the size of that buffer, and we can just point at that
5262 store instead of copying. Many expansion strings contain just one reference,
5263 so this is a useful optimization, especially for humungous headers
5264 ($message_headers). */
5276 value = find_variable(name, FALSE, skipping, &newsize);
5279 expand_string_message =
5280 string_sprintf("unknown variable in \"${%s}\"", name);
5281 check_variable_error_message(name);
5284 len = Ustrlen(value);
5285 if (yield == NULL && newsize != 0)
5291 else yield = string_cat(yield, &size, &ptr, value, len);
5295 /* Else there's something wrong */
5297 expand_string_message =
5298 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
5299 "in a variable reference)", name);
5303 /* If we hit the end of the string when ket_ends is set, there is a missing
5304 terminating brace. */
5306 if (ket_ends && *s == 0)
5308 expand_string_message = malformed_header?
5309 US"missing } at end of string - could be header name not terminated by colon"
5311 US"missing } at end of string";
5315 /* Expansion succeeded; yield may still be NULL here if nothing was actually
5316 added to the string. If so, set up an empty string. Add a terminating zero. If
5317 left != NULL, return a pointer to the terminator. */
5319 if (yield == NULL) yield = store_get(1);
5321 if (left != NULL) *left = s;
5323 /* Any stacking store that was used above the final string is no longer needed.
5324 In many cases the final string will be the first one that was got and so there
5325 will be optimal store usage. */
5327 store_reset(yield + ptr + 1);
5330 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
5332 if (skipping) debug_printf("skipping: result is not used\n");
5336 /* This is the failure exit: easiest to program with a goto. We still need
5337 to update the pointer to the terminator, for cases of nested calls with "fail".
5340 EXPAND_FAILED_CURLY:
5341 expand_string_message = malformed_header?
5342 US"missing or misplaced { or } - could be header name not terminated by colon"
5344 US"missing or misplaced { or }";
5346 /* At one point, Exim reset the store to yield (if yield was not NULL), but
5347 that is a bad idea, because expand_string_message is in dynamic store. */
5350 if (left != NULL) *left = s;
5353 debug_printf("failed to expand: %s\n", string);
5354 debug_printf(" error message: %s\n", expand_string_message);
5355 if (expand_string_forcedfail) debug_printf("failure was forced\n");
5361 /* This is the external function call. Do a quick check for any expansion
5362 metacharacters, and if there are none, just return the input string.
5364 Argument: the string to be expanded
5365 Returns: the expanded string, or NULL if expansion failed; if failure was
5366 due to a lookup deferring, search_find_defer will be TRUE
5370 expand_string(uschar *string)
5372 search_find_defer = FALSE;
5373 malformed_header = FALSE;
5374 return (Ustrpbrk(string, "$\\") == NULL)? string :
5375 expand_string_internal(string, FALSE, NULL, FALSE);
5380 /*************************************************
5382 *************************************************/
5384 /* Now and again we want to expand a string and be sure that the result is in a
5385 new bit of store. This function does that.
5387 Argument: the string to be expanded
5388 Returns: the expanded string, always in a new bit of store, or NULL
5392 expand_string_copy(uschar *string)
5394 uschar *yield = expand_string(string);
5395 if (yield == string) yield = string_copy(string);
5401 /*************************************************
5402 * Expand and interpret as an integer *
5403 *************************************************/
5405 /* Expand a string, and convert the result into an integer.
5408 string the string to be expanded
5409 isplus TRUE if a non-negative number is expected
5411 Returns: the integer value, or
5412 -1 for an expansion error ) in both cases, message in
5413 -2 for an integer interpretation error ) expand_string_message
5414 expand_string_message is set NULL for an OK integer
5418 expand_string_integer(uschar *string, BOOL isplus)
5421 uschar *s = expand_string(string);
5422 uschar *msg = US"invalid integer \"%s\"";
5425 /* If expansion failed, expand_string_message will be set. */
5427 if (s == NULL) return -1;
5429 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
5430 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
5431 systems, so we set it zero ourselves. */
5434 expand_string_message = NULL; /* Indicates no error */
5435 value = strtol(CS s, CSS &endptr, 0);
5439 msg = US"integer expected but \"%s\" found";
5441 else if (value < 0 && isplus)
5443 msg = US"non-negative integer expected but \"%s\" found";
5447 /* Ensure we can cast this down to an int */
5448 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
5450 if (errno != ERANGE)
5452 if (tolower(*endptr) == 'k')
5454 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
5458 else if (tolower(*endptr) == 'm')
5460 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
5462 else value *= 1024*1024;
5466 if (errno == ERANGE)
5467 msg = US"absolute value of integer \"%s\" is too large (overflow)";
5470 while (isspace(*endptr)) endptr++;
5471 if (*endptr == 0) return (int)value;
5475 expand_string_message = string_sprintf(CS msg, s);
5480 /*************************************************
5481 **************************************************
5482 * Stand-alone test program *
5483 **************************************************
5484 *************************************************/
5490 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
5492 int ovector[3*(EXPAND_MAXN+1)];
5493 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
5494 ovector, sizeof(ovector)/sizeof(int));
5495 BOOL yield = n >= 0;
5496 if (n == 0) n = EXPAND_MAXN + 1;
5500 expand_nmax = (setup < 0)? 0 : setup + 1;
5501 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
5503 expand_nstring[expand_nmax] = subject + ovector[nn];
5504 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5512 int main(int argc, uschar **argv)
5515 uschar buffer[1024];
5517 debug_selector = D_v;
5518 debug_file = stderr;
5519 debug_fd = fileno(debug_file);
5520 big_buffer = malloc(big_buffer_size);
5522 for (i = 1; i < argc; i++)
5524 if (argv[i][0] == '+')
5526 debug_trace_memory = 2;
5529 if (isdigit(argv[i][0]))
5530 debug_selector = Ustrtol(argv[i], NULL, 0);
5532 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
5536 eldap_default_servers = argv[i];
5539 mysql_servers = argv[i];
5542 pgsql_servers = argv[i];
5546 else opt_perl_startup = argv[i];
5550 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
5552 expand_nstring[1] = US"string 1....";
5553 expand_nlength[1] = 8;
5557 if (opt_perl_startup != NULL)
5560 printf("Starting Perl interpreter\n");
5561 errstr = init_perl(opt_perl_startup);
5564 printf("** error in perl_startup code: %s\n", errstr);
5565 return EXIT_FAILURE;
5568 #endif /* EXIM_PERL */
5570 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
5572 void *reset_point = store_get(0);
5573 uschar *yield = expand_string(buffer);
5576 printf("%s\n", yield);
5577 store_reset(reset_point);
5581 if (search_find_defer) printf("search_find deferred\n");
5582 printf("Failed: %s\n", expand_string_message);
5583 if (expand_string_forcedfail) printf("Forced failure\n");
5595 /* End of expand.c */