1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2022 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
11 /* Functions for handling string expansion. */
17 # include "macro_predef.h"
20 typedef unsigned esi_flags;
22 #define ESI_BRACE_ENDS BIT(0) /* expansion should stop at } */
23 #define ESI_HONOR_DOLLAR BIT(1) /* $ is meaningfull */
24 #define ESI_SKIPPING BIT(2) /* value will not be needed */
26 /* Recursively called function */
28 static uschar *expand_string_internal(const uschar *, esi_flags, const uschar **, BOOL *, BOOL *);
29 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
32 # ifndef SUPPORT_CRYPTEQ
33 # define SUPPORT_CRYPTEQ
38 # include "lookups/ldap.h"
41 #ifdef SUPPORT_CRYPTEQ
46 extern char* crypt16(char*, char*);
50 /* The handling of crypt16() is a mess. I will record below the analysis of the
51 mess that was sent to me. We decided, however, to make changing this very low
52 priority, because in practice people are moving away from the crypt()
53 algorithms nowadays, so it doesn't seem worth it.
56 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
57 the first 8 characters of the password using a 20-round version of crypt
58 (standard crypt does 25 rounds). It then crypts the next 8 characters,
59 or an empty block if the password is less than 9 characters, using a
60 20-round version of crypt and the same salt as was used for the first
61 block. Characters after the first 16 are ignored. It always generates
62 a 16-byte hash, which is expressed together with the salt as a string
63 of 24 base 64 digits. Here are some links to peruse:
65 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
66 http://seclists.org/bugtraq/1999/Mar/0076.html
68 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
69 and OSF/1. This is the same as the standard crypt if given a password
70 of 8 characters or less. If given more, it first does the same as crypt
71 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
72 using as salt the first two base 64 digits from the first hash block.
73 If the password is more than 16 characters then it crypts the 17th to 24th
74 characters using as salt the first two base 64 digits from the second hash
75 block. And so on: I've seen references to it cutting off the password at
76 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
78 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
79 http://seclists.org/bugtraq/1999/Mar/0109.html
80 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
81 TET1_html/sec.c222.html#no_id_208
83 Exim has something it calls "crypt16". It will either use a native
84 crypt16 or its own implementation. A native crypt16 will presumably
85 be the one that I called "crypt16" above. The internal "crypt16"
86 function, however, is a two-block-maximum implementation of what I called
87 "bigcrypt". The documentation matches the internal code.
89 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
90 that crypt16 and bigcrypt were different things.
92 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
93 to whatever it is using under that name. This unfortunately sets a
94 precedent for using "{crypt16}" to identify two incompatible algorithms
95 whose output can't be distinguished. With "{crypt16}" thus rendered
96 ambiguous, I suggest you deprecate it and invent two new identifiers
97 for the two algorithms.
99 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
100 of the password separately means they can be cracked separately, so
101 the double-length hash only doubles the cracking effort instead of
102 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
103 bcrypt ({CRYPT}$2a$).
109 /*************************************************
110 * Local statics and tables *
111 *************************************************/
113 /* Table of item names, and corresponding switch numbers. The names must be in
114 alphabetical order. */
116 static uschar *item_table[] = {
186 /* Tables of operator names, and corresponding switch numbers. The names must be
187 in alphabetical order. There are two tables, because underscore is used in some
188 cases to introduce arguments, whereas for other it is part of the name. This is
189 an historical mis-design. */
191 static uschar * op_table_underscore[] = {
194 US"quote_local_part",
199 ,US"utf8_domain_from_alabel",
200 US"utf8_domain_to_alabel",
201 US"utf8_localpart_from_alabel",
202 US"utf8_localpart_to_alabel"
209 EOP_QUOTE_LOCAL_PART,
214 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
215 EOP_UTF8_DOMAIN_TO_ALABEL,
216 EOP_UTF8_LOCALPART_FROM_ALABEL,
217 EOP_UTF8_LOCALPART_TO_ALABEL
221 static uschar *op_table_main[] = {
269 EOP_ADDRESS = nelem(op_table_underscore),
316 /* Table of condition names, and corresponding switch numbers. The names must
317 be in alphabetical order. */
319 static uschar *cond_table[] = {
323 US"==", /* Backward compatibility */
363 US"match_local_part",
388 ECOND_FIRST_DELIVERY,
416 ECOND_MATCH_LOCAL_PART,
426 /* Types of table entry */
429 vtype_int, /* value is address of int */
430 vtype_filter_int, /* ditto, but recognized only when filtering */
431 vtype_ino, /* value is address of ino_t (not always an int) */
432 vtype_uid, /* value is address of uid_t (not always an int) */
433 vtype_gid, /* value is address of gid_t (not always an int) */
434 vtype_bool, /* value is address of bool */
435 vtype_stringptr, /* value is address of pointer to string */
436 vtype_msgbody, /* as stringptr, but read when first required */
437 vtype_msgbody_end, /* ditto, the end of the message */
438 vtype_msgheaders, /* the message's headers, processed */
439 vtype_msgheaders_raw, /* the message's headers, unprocessed */
440 vtype_localpart, /* extract local part from string */
441 vtype_domain, /* extract domain from string */
442 vtype_string_func, /* value is string returned by given function */
443 vtype_todbsdin, /* value not used; generate BSD inbox tod */
444 vtype_tode, /* value not used; generate tod in epoch format */
445 vtype_todel, /* value not used; generate tod in epoch/usec format */
446 vtype_todf, /* value not used; generate full tod */
447 vtype_todl, /* value not used; generate log tod */
448 vtype_todlf, /* value not used; generate log file datestamp tod */
449 vtype_todzone, /* value not used; generate time zone only */
450 vtype_todzulu, /* value not used; generate zulu tod */
451 vtype_reply, /* value not used; get reply from headers */
452 vtype_pid, /* value not used; result is pid */
453 vtype_host_lookup, /* value not used; get host name */
454 vtype_load_avg, /* value not used; result is int from os_getloadavg */
455 vtype_pspace, /* partition space; value is T/F for spool/log */
456 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
457 vtype_cert /* SSL certificate */
459 ,vtype_dkim /* Lookup of value in DKIM signature */
463 /* Type for main variable table */
471 /* Type for entries pointing to address/length pairs. Not currently
479 static uschar * fn_recipients(void);
480 typedef uschar * stringptr_fn_t(void);
481 static uschar * fn_queue_size(void);
483 /* This table must be kept in alphabetical order. */
485 static var_entry var_table[] = {
486 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
487 they will be confused with user-creatable ACL variables. */
488 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
489 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
490 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
491 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
492 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
493 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
494 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
495 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
496 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
497 { "acl_narg", vtype_int, &acl_narg },
498 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
499 { "address_data", vtype_stringptr, &deliver_address_data },
500 { "address_file", vtype_stringptr, &address_file },
501 { "address_pipe", vtype_stringptr, &address_pipe },
502 #ifdef EXPERIMENTAL_ARC
503 { "arc_domains", vtype_string_func, (void *) &fn_arc_domains },
504 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
505 { "arc_state", vtype_stringptr, &arc_state },
506 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
508 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
509 { "authenticated_id", vtype_stringptr, &authenticated_id },
510 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
511 { "authentication_failed",vtype_int, &authentication_failed },
512 #ifdef WITH_CONTENT_SCAN
513 { "av_failed", vtype_int, &av_failed },
515 #ifdef EXPERIMENTAL_BRIGHTMAIL
516 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
517 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
518 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
519 { "bmi_deliver", vtype_int, &bmi_deliver },
521 { "body_linecount", vtype_int, &body_linecount },
522 { "body_zerocount", vtype_int, &body_zerocount },
523 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
524 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
525 { "caller_gid", vtype_gid, &real_gid },
526 { "caller_uid", vtype_uid, &real_uid },
527 { "callout_address", vtype_stringptr, &callout_address },
528 { "compile_date", vtype_stringptr, &version_date },
529 { "compile_number", vtype_stringptr, &version_cnumber },
530 { "config_dir", vtype_stringptr, &config_main_directory },
531 { "config_file", vtype_stringptr, &config_main_filename },
532 { "csa_status", vtype_stringptr, &csa_status },
533 #ifdef EXPERIMENTAL_DCC
534 { "dcc_header", vtype_stringptr, &dcc_header },
535 { "dcc_result", vtype_stringptr, &dcc_result },
538 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
539 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
540 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
541 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
542 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
543 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
544 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
545 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
546 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
547 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
548 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
549 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
550 { "dkim_key_length", vtype_int, &dkim_key_length },
551 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
552 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
553 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
554 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
555 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
556 { "dkim_signers", vtype_stringptr, &dkim_signers },
557 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
558 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
561 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
562 { "dmarc_status", vtype_stringptr, &dmarc_status },
563 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
564 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
566 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
567 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
568 { "dnslist_text", vtype_stringptr, &dnslist_text },
569 { "dnslist_value", vtype_stringptr, &dnslist_value },
570 { "domain", vtype_stringptr, &deliver_domain },
571 { "domain_data", vtype_stringptr, &deliver_domain_data },
572 #ifndef DISABLE_EVENT
573 { "event_data", vtype_stringptr, &event_data },
575 /*XXX want to use generic vars for as many of these as possible*/
576 { "event_defer_errno", vtype_int, &event_defer_errno },
578 { "event_name", vtype_stringptr, &event_name },
580 { "exim_gid", vtype_gid, &exim_gid },
581 { "exim_path", vtype_stringptr, &exim_path },
582 { "exim_uid", vtype_uid, &exim_uid },
583 { "exim_version", vtype_stringptr, &version_string },
584 { "headers_added", vtype_string_func, (void *) &fn_hdrs_added },
585 { "home", vtype_stringptr, &deliver_home },
586 { "host", vtype_stringptr, &deliver_host },
587 { "host_address", vtype_stringptr, &deliver_host_address },
588 { "host_data", vtype_stringptr, &host_data },
589 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
590 { "host_lookup_failed", vtype_int, &host_lookup_failed },
591 { "host_port", vtype_int, &deliver_host_port },
592 { "initial_cwd", vtype_stringptr, &initial_cwd },
593 { "inode", vtype_ino, &deliver_inode },
594 { "interface_address", vtype_stringptr, &interface_address },
595 { "interface_port", vtype_int, &interface_port },
596 { "item", vtype_stringptr, &iterate_item },
598 { "ldap_dn", vtype_stringptr, &eldap_dn },
600 { "load_average", vtype_load_avg, NULL },
601 { "local_part", vtype_stringptr, &deliver_localpart },
602 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
603 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
604 { "local_part_prefix_v", vtype_stringptr, &deliver_localpart_prefix_v },
605 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
606 { "local_part_suffix_v", vtype_stringptr, &deliver_localpart_suffix_v },
607 #ifdef HAVE_LOCAL_SCAN
608 { "local_scan_data", vtype_stringptr, &local_scan_data },
610 { "local_user_gid", vtype_gid, &local_user_gid },
611 { "local_user_uid", vtype_uid, &local_user_uid },
612 { "localhost_number", vtype_int, &host_number },
613 { "log_inodes", vtype_pinodes, (void *)FALSE },
614 { "log_space", vtype_pspace, (void *)FALSE },
615 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
616 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
617 #ifdef WITH_CONTENT_SCAN
618 { "malware_name", vtype_stringptr, &malware_name },
620 { "max_received_linelength", vtype_int, &max_received_linelength },
621 { "message_age", vtype_int, &message_age },
622 { "message_body", vtype_msgbody, &message_body },
623 { "message_body_end", vtype_msgbody_end, &message_body_end },
624 { "message_body_size", vtype_int, &message_body_size },
625 { "message_exim_id", vtype_stringptr, &message_id },
626 { "message_headers", vtype_msgheaders, NULL },
627 { "message_headers_raw", vtype_msgheaders_raw, NULL },
628 { "message_id", vtype_stringptr, &message_id },
629 { "message_linecount", vtype_int, &message_linecount },
630 { "message_size", vtype_int, &message_size },
632 { "message_smtputf8", vtype_bool, &message_smtputf8 },
634 #ifdef WITH_CONTENT_SCAN
635 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
636 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
637 { "mime_boundary", vtype_stringptr, &mime_boundary },
638 { "mime_charset", vtype_stringptr, &mime_charset },
639 { "mime_content_description", vtype_stringptr, &mime_content_description },
640 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
641 { "mime_content_id", vtype_stringptr, &mime_content_id },
642 { "mime_content_size", vtype_int, &mime_content_size },
643 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
644 { "mime_content_type", vtype_stringptr, &mime_content_type },
645 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
646 { "mime_filename", vtype_stringptr, &mime_filename },
647 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
648 { "mime_is_multipart", vtype_int, &mime_is_multipart },
649 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
650 { "mime_part_count", vtype_int, &mime_part_count },
652 { "n0", vtype_filter_int, &filter_n[0] },
653 { "n1", vtype_filter_int, &filter_n[1] },
654 { "n2", vtype_filter_int, &filter_n[2] },
655 { "n3", vtype_filter_int, &filter_n[3] },
656 { "n4", vtype_filter_int, &filter_n[4] },
657 { "n5", vtype_filter_int, &filter_n[5] },
658 { "n6", vtype_filter_int, &filter_n[6] },
659 { "n7", vtype_filter_int, &filter_n[7] },
660 { "n8", vtype_filter_int, &filter_n[8] },
661 { "n9", vtype_filter_int, &filter_n[9] },
662 { "original_domain", vtype_stringptr, &deliver_domain_orig },
663 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
664 { "originator_gid", vtype_gid, &originator_gid },
665 { "originator_uid", vtype_uid, &originator_uid },
666 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
667 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
668 { "pid", vtype_pid, NULL },
670 { "prdr_requested", vtype_bool, &prdr_requested },
672 { "primary_hostname", vtype_stringptr, &primary_hostname },
673 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
674 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
675 { "proxy_external_port", vtype_int, &proxy_external_port },
676 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
677 { "proxy_local_port", vtype_int, &proxy_local_port },
678 { "proxy_session", vtype_bool, &proxy_session },
680 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
681 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
682 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
683 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
684 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
685 { "queue_name", vtype_stringptr, &queue_name },
686 { "queue_size", vtype_string_func, &fn_queue_size },
687 { "rcpt_count", vtype_int, &rcpt_count },
688 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
689 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
690 { "received_count", vtype_int, &received_count },
691 { "received_for", vtype_stringptr, &received_for },
692 { "received_ip_address", vtype_stringptr, &interface_address },
693 { "received_port", vtype_int, &interface_port },
694 { "received_protocol", vtype_stringptr, &received_protocol },
695 { "received_time", vtype_int, &received_time.tv_sec },
696 { "recipient_data", vtype_stringptr, &recipient_data },
697 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
698 { "recipients", vtype_string_func, (void *) &fn_recipients },
699 { "recipients_count", vtype_int, &recipients_count },
700 { "regex_cachesize", vtype_int, ®ex_cachesize },/* undocumented; devel observability */
701 #ifdef WITH_CONTENT_SCAN
702 { "regex_match_string", vtype_stringptr, ®ex_match_string },
704 { "reply_address", vtype_reply, NULL },
705 { "return_path", vtype_stringptr, &return_path },
706 { "return_size_limit", vtype_int, &bounce_return_size_limit },
707 { "router_name", vtype_stringptr, &router_name },
708 { "runrc", vtype_int, &runrc },
709 { "self_hostname", vtype_stringptr, &self_hostname },
710 { "sender_address", vtype_stringptr, &sender_address },
711 { "sender_address_data", vtype_stringptr, &sender_address_data },
712 { "sender_address_domain", vtype_domain, &sender_address },
713 { "sender_address_local_part", vtype_localpart, &sender_address },
714 { "sender_data", vtype_stringptr, &sender_data },
715 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
716 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
717 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
718 { "sender_helo_verified",vtype_string_func, (void *) &sender_helo_verified_boolstr },
719 { "sender_host_address", vtype_stringptr, &sender_host_address },
720 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
721 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
722 { "sender_host_name", vtype_host_lookup, NULL },
723 { "sender_host_port", vtype_int, &sender_host_port },
724 { "sender_ident", vtype_stringptr, &sender_ident },
725 { "sender_rate", vtype_stringptr, &sender_rate },
726 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
727 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
728 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
729 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
730 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
731 { "sending_port", vtype_int, &sending_port },
732 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
733 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
734 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
735 { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
736 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
737 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
738 { "sn0", vtype_filter_int, &filter_sn[0] },
739 { "sn1", vtype_filter_int, &filter_sn[1] },
740 { "sn2", vtype_filter_int, &filter_sn[2] },
741 { "sn3", vtype_filter_int, &filter_sn[3] },
742 { "sn4", vtype_filter_int, &filter_sn[4] },
743 { "sn5", vtype_filter_int, &filter_sn[5] },
744 { "sn6", vtype_filter_int, &filter_sn[6] },
745 { "sn7", vtype_filter_int, &filter_sn[7] },
746 { "sn8", vtype_filter_int, &filter_sn[8] },
747 { "sn9", vtype_filter_int, &filter_sn[9] },
748 #ifdef WITH_CONTENT_SCAN
749 { "spam_action", vtype_stringptr, &spam_action },
750 { "spam_bar", vtype_stringptr, &spam_bar },
751 { "spam_report", vtype_stringptr, &spam_report },
752 { "spam_score", vtype_stringptr, &spam_score },
753 { "spam_score_int", vtype_stringptr, &spam_score_int },
756 { "spf_guess", vtype_stringptr, &spf_guess },
757 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
758 { "spf_received", vtype_stringptr, &spf_received },
759 { "spf_result", vtype_stringptr, &spf_result },
760 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
761 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
763 { "spool_directory", vtype_stringptr, &spool_directory },
764 { "spool_inodes", vtype_pinodes, (void *)TRUE },
765 { "spool_space", vtype_pspace, (void *)TRUE },
767 { "srs_recipient", vtype_stringptr, &srs_recipient },
769 { "thisaddress", vtype_stringptr, &filter_thisaddress },
771 /* The non-(in,out) variables are now deprecated */
772 { "tls_bits", vtype_int, &tls_in.bits },
773 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
774 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
776 { "tls_in_bits", vtype_int, &tls_in.bits },
777 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
778 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
779 { "tls_in_cipher_std", vtype_stringptr, &tls_in.cipher_stdname },
780 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
781 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
782 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
783 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
784 #ifndef DISABLE_TLS_RESUME
785 { "tls_in_resumption", vtype_int, &tls_in.resumption },
788 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
790 { "tls_in_ver", vtype_stringptr, &tls_in.ver },
791 { "tls_out_bits", vtype_int, &tls_out.bits },
792 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
793 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
794 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },
796 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
798 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
799 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
800 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
801 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
802 #ifndef DISABLE_TLS_RESUME
803 { "tls_out_resumption", vtype_int, &tls_out.resumption },
806 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
809 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
811 { "tls_out_ver", vtype_stringptr, &tls_out.ver },
813 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
815 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
818 { "tod_bsdinbox", vtype_todbsdin, NULL },
819 { "tod_epoch", vtype_tode, NULL },
820 { "tod_epoch_l", vtype_todel, NULL },
821 { "tod_full", vtype_todf, NULL },
822 { "tod_log", vtype_todl, NULL },
823 { "tod_logfile", vtype_todlf, NULL },
824 { "tod_zone", vtype_todzone, NULL },
825 { "tod_zulu", vtype_todzulu, NULL },
826 { "transport_name", vtype_stringptr, &transport_name },
827 { "value", vtype_stringptr, &lookup_value },
828 { "verify_mode", vtype_stringptr, &verify_mode },
829 { "version_number", vtype_stringptr, &version_string },
830 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
831 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
832 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
833 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
834 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
835 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
838 static int var_table_size = nelem(var_table);
843 uschar * fn_arc_domains(void) {return NULL;}
844 uschar * fn_hdrs_added(void) {return NULL;}
845 uschar * fn_queue_size(void) {return NULL;}
846 uschar * fn_recipients(void) {return NULL;}
847 uschar * sender_helo_verified_boolstr(void) {return NULL;}
848 uschar * smtp_cmd_hist(void) {return NULL;}
853 expansion_items(void)
856 for (int i = 0; i < nelem(item_table); i++)
858 spf(buf, sizeof(buf), CUS"_EXP_ITEM_%T", item_table[i]);
859 builtin_macro_create(buf);
863 expansion_operators(void)
866 for (int i = 0; i < nelem(op_table_underscore); i++)
868 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_underscore[i]);
869 builtin_macro_create(buf);
871 for (int i = 0; i < nelem(op_table_main); i++)
873 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_main[i]);
874 builtin_macro_create(buf);
878 expansion_conditions(void)
881 for (int i = 0; i < nelem(cond_table); i++)
883 spf(buf, sizeof(buf), CUS"_EXP_COND_%T", cond_table[i]);
884 builtin_macro_create(buf);
888 expansion_variables(void)
891 for (int i = 0; i < nelem(var_table); i++)
893 spf(buf, sizeof(buf), CUS"_EXP_VAR_%T", var_table[i].name);
894 builtin_macro_create(buf);
902 expansion_operators();
903 expansion_conditions();
904 expansion_variables();
907 #else /*!MACRO_PREDEF*/
909 static uschar var_buffer[256];
910 static BOOL malformed_header;
912 /* For textual hashes */
914 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
915 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
918 enum { HMAC_MD5, HMAC_SHA1 };
920 /* For numeric hashes */
922 static unsigned int prime[] = {
923 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
924 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
925 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
927 /* For printing modes in symbolic form */
929 static uschar *mtable_normal[] =
930 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
932 static uschar *mtable_setid[] =
933 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
935 static uschar *mtable_sticky[] =
936 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
938 /* flags for find_header() */
939 #define FH_EXISTS_ONLY BIT(0)
940 #define FH_WANT_RAW BIT(1)
941 #define FH_WANT_LIST BIT(2)
944 /*************************************************
945 * Tables for UTF-8 support *
946 *************************************************/
948 /* Table of the number of extra characters, indexed by the first character
949 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
952 static uschar utf8_table1[] = {
953 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
954 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
955 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
956 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
958 /* These are the masks for the data bits in the first byte of a character,
959 indexed by the number of additional bytes. */
961 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
963 /* Get the next UTF-8 character, advancing the pointer. */
965 #define GETUTF8INC(c, ptr) \
967 if ((c & 0xc0) == 0xc0) \
969 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
971 c = (c & utf8_table2[a]) << s; \
975 c |= (*ptr++ & 0x3f) << s; \
981 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
983 /*************************************************
984 * Binary chop search on a table *
985 *************************************************/
987 /* This is used for matching expansion items and operators.
990 name the name that is being sought
991 table the table to search
992 table_size the number of items in the table
994 Returns: the offset in the table, or -1
998 chop_match(uschar *name, uschar **table, int table_size)
1000 uschar **bot = table;
1001 uschar **top = table + table_size;
1005 uschar **mid = bot + (top - bot)/2;
1006 int c = Ustrcmp(name, *mid);
1007 if (c == 0) return mid - table;
1008 if (c > 0) bot = mid + 1; else top = mid;
1016 /*************************************************
1017 * Check a condition string *
1018 *************************************************/
1020 /* This function is called to expand a string, and test the result for a "true"
1021 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
1022 forced fail or lookup defer.
1024 We used to release all store used, but this is not not safe due
1025 to ${dlfunc } and ${acl }. In any case expand_string_internal()
1026 is reasonably careful to release what it can.
1028 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
1031 condition the condition string
1032 m1 text to be incorporated in panic error
1035 Returns: TRUE if condition is met, FALSE if not
1039 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
1041 uschar * ss = expand_string(condition);
1044 if (!f.expand_string_forcedfail && !f.search_find_defer)
1045 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
1046 "for %s %s: %s", condition, m1, m2, expand_string_message);
1049 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
1050 strcmpic(ss, US"false") != 0;
1056 /*************************************************
1057 * Pseudo-random number generation *
1058 *************************************************/
1060 /* Pseudo-random number generation. The result is not "expected" to be
1061 cryptographically strong but not so weak that someone will shoot themselves
1062 in the foot using it as a nonce in some email header scheme or whatever
1063 weirdness they'll twist this into. The result should ideally handle fork().
1065 However, if we're stuck unable to provide this, then we'll fall back to
1066 appallingly bad randomness.
1068 If DISABLE_TLS is not defined then this will not be used except as an emergency
1073 Returns a random number in range [0, max-1]
1077 # define vaguely_random_number vaguely_random_number_fallback
1080 vaguely_random_number(int max)
1083 # undef vaguely_random_number
1085 static pid_t pid = 0;
1088 if ((p2 = getpid()) != pid)
1093 #ifdef HAVE_ARC4RANDOM
1094 /* cryptographically strong randomness, common on *BSD platforms, not
1095 so much elsewhere. Alas. */
1096 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1099 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1100 # ifdef HAVE_SRANDOMDEV
1101 /* uses random(4) for seeding */
1106 gettimeofday(&tv, NULL);
1107 srandom(tv.tv_sec | tv.tv_usec | getpid());
1111 /* Poor randomness and no seeding here */
1118 #ifdef HAVE_ARC4RANDOM
1119 return arc4random() % max;
1120 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1121 return random() % max;
1123 /* This one returns a 16-bit number, definitely not crypto-strong */
1124 return random_number(max);
1131 /*************************************************
1132 * Pick out a name from a string *
1133 *************************************************/
1135 /* If the name is too long, it is silently truncated.
1138 name points to a buffer into which to put the name
1139 max is the length of the buffer
1140 s points to the first alphabetic character of the name
1141 extras chars other than alphanumerics to permit
1143 Returns: pointer to the first character after the name
1145 Note: The test for *s != 0 in the while loop is necessary because
1146 Ustrchr() yields non-NULL if the character is zero (which is not something
1149 static const uschar *
1150 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1153 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1155 if (ptr < max-1) name[ptr++] = *s;
1164 /*************************************************
1165 * Pick out the rest of a header name *
1166 *************************************************/
1168 /* A variable name starting $header_ (or just $h_ for those who like
1169 abbreviations) might not be the complete header name because headers can
1170 contain any printing characters in their names, except ':'. This function is
1171 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1172 on the end, if the name was terminated by white space.
1175 name points to a buffer in which the name read so far exists
1176 max is the length of the buffer
1177 s points to the first character after the name so far, i.e. the
1178 first non-alphameric character after $header_xxxxx
1180 Returns: a pointer to the first character after the header name
1183 static const uschar *
1184 read_header_name(uschar *name, int max, const uschar *s)
1186 int prelen = Ustrchr(name, '_') - name + 1;
1187 int ptr = Ustrlen(name) - prelen;
1188 if (ptr > 0) memmove(name, name+prelen, ptr);
1189 while (mac_isgraph(*s) && *s != ':')
1191 if (ptr < max-1) name[ptr++] = *s;
1202 /*************************************************
1203 * Pick out a number from a string *
1204 *************************************************/
1207 n points to an integer into which to put the number
1208 s points to the first digit of the number
1210 Returns: a pointer to the character after the last digit
1212 /*XXX consider expanding to int_eximarith_t. But the test for
1213 "overbig numbers" in 0002 still needs to overflow it. */
1216 read_number(int *n, uschar *s)
1219 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1223 static const uschar *
1224 read_cnumber(int *n, const uschar *s)
1227 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1233 /*************************************************
1234 * Extract keyed subfield from a string *
1235 *************************************************/
1237 /* The yield is in dynamic store; NULL means that the key was not found.
1240 key points to the name of the key
1241 s points to the string from which to extract the subfield
1243 Returns: NULL if the subfield was not found, or
1244 a pointer to the subfield's data
1248 expand_getkeyed(const uschar * key, const uschar * s)
1250 int length = Ustrlen(key);
1251 Uskip_whitespace(&s);
1253 /* Loop to search for the key */
1259 const uschar * dkey = s;
1261 while (*s && *s != '=' && !isspace(*s)) s++;
1262 dkeylength = s - dkey;
1263 if (Uskip_whitespace(&s) == '=') while (isspace(*++s));
1265 data = string_dequote(&s);
1266 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1269 Uskip_whitespace(&s);
1278 find_var_ent(uschar * name)
1281 int last = var_table_size;
1283 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; }
1290 return &var_table[middle];
1295 /*************************************************
1296 * Extract numbered subfield from string *
1297 *************************************************/
1299 /* Extracts a numbered field from a string that is divided by tokens - for
1300 example a line from /etc/passwd is divided by colon characters. First field is
1301 numbered one. Negative arguments count from the right. Zero returns the whole
1302 string. Returns NULL if there are insufficient tokens in the string
1305 Modifies final argument - this is a dynamically generated string, so that's OK.
1308 field number of field to be extracted,
1309 first field = 1, whole string = 0, last field = -1
1310 separators characters that are used to break string into tokens
1311 s points to the string from which to extract the subfield
1313 Returns: NULL if the field was not found,
1314 a pointer to the field's data inside s (modified to add 0)
1318 expand_gettokened (int field, uschar *separators, uschar *s)
1323 uschar *fieldtext = NULL;
1325 if (field == 0) return s;
1327 /* Break the line up into fields in place; for field > 0 we stop when we have
1328 done the number of fields we want. For field < 0 we continue till the end of
1329 the string, counting the number of fields. */
1331 count = (field > 0)? field : INT_MAX;
1337 /* Previous field was the last one in the string. For a positive field
1338 number, this means there are not enough fields. For a negative field number,
1339 check that there are enough, and scan back to find the one that is wanted. */
1343 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1344 if ((-field) == (INT_MAX - count - 1)) return s;
1348 while (ss[-1] != 0) ss--;
1354 /* Previous field was not last in the string; save its start and put a
1358 len = Ustrcspn(ss, separators);
1369 expand_getlistele(int field, const uschar * list)
1371 const uschar * tlist = list;
1373 /* Tainted mem for the throwaway element copies */
1374 uschar * dummy = store_get(2, GET_TAINTED);
1378 for (field++; string_nextinlist(&tlist, &sep, dummy, 1); ) field++;
1381 if (field == 0) return NULL;
1382 while (--field > 0 && (string_nextinlist(&list, &sep, dummy, 1))) ;
1383 return string_nextinlist(&list, &sep, NULL, 0);
1387 /* Certificate fields, by name. Worry about by-OID later */
1388 /* Names are chosen to not have common prefixes */
1395 uschar * (*getfn)(void * cert, uschar * mod);
1397 static certfield certfields[] =
1398 { /* linear search; no special order */
1399 { US"version", 7, &tls_cert_version },
1400 { US"serial_number", 13, &tls_cert_serial_number },
1401 { US"subject", 7, &tls_cert_subject },
1402 { US"notbefore", 9, &tls_cert_not_before },
1403 { US"notafter", 8, &tls_cert_not_after },
1404 { US"issuer", 6, &tls_cert_issuer },
1405 { US"signature", 9, &tls_cert_signature },
1406 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1407 { US"subj_altname", 12, &tls_cert_subject_altname },
1408 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1409 { US"crl_uri", 7, &tls_cert_crl_uri },
1413 expand_getcertele(uschar * field, uschar * certvar)
1417 if (!(vp = find_var_ent(certvar)))
1419 expand_string_message =
1420 string_sprintf("no variable named \"%s\"", certvar);
1421 return NULL; /* Unknown variable name */
1423 /* NB this stops us passing certs around in variable. Might
1424 want to do that in future */
1425 if (vp->type != vtype_cert)
1427 expand_string_message =
1428 string_sprintf("\"%s\" is not a certificate", certvar);
1429 return NULL; /* Unknown variable name */
1431 if (!*(void **)vp->value)
1434 if (*field >= '0' && *field <= '9')
1435 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1437 for (certfield * cp = certfields;
1438 cp < certfields + nelem(certfields);
1440 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1442 uschar * modifier = *(field += cp->namelen) == ','
1444 return (*cp->getfn)( *(void **)vp->value, modifier );
1447 expand_string_message =
1448 string_sprintf("bad field selector \"%s\" for certextract", field);
1451 #endif /*DISABLE_TLS*/
1453 /*************************************************
1454 * Extract a substring from a string *
1455 *************************************************/
1457 /* Perform the ${substr or ${length expansion operations.
1460 subject the input string
1461 value1 the offset from the start of the input string to the start of
1462 the output string; if negative, count from the right.
1463 value2 the length of the output string, or negative (-1) for unset
1464 if value1 is positive, unset means "all after"
1465 if value1 is negative, unset means "all before"
1466 len set to the length of the returned string
1468 Returns: pointer to the output string, or NULL if there is an error
1472 extract_substr(uschar *subject, int value1, int value2, int *len)
1474 int sublen = Ustrlen(subject);
1476 if (value1 < 0) /* count from right */
1480 /* If the position is before the start, skip to the start, and adjust the
1481 length. If the length ends up negative, the substring is null because nothing
1482 can precede. This falls out naturally when the length is unset, meaning "all
1488 if (value2 < 0) value2 = 0;
1492 /* Otherwise an unset length => characters before value1 */
1494 else if (value2 < 0)
1501 /* For a non-negative offset, if the starting position is past the end of the
1502 string, the result will be the null string. Otherwise, an unset length means
1503 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1507 if (value1 > sublen)
1512 else if (value2 < 0) value2 = sublen;
1515 /* Cut the length down to the maximum possible for the offset value, and get
1516 the required characters. */
1518 if (value1 + value2 > sublen) value2 = sublen - value1;
1520 return subject + value1;
1526 /*************************************************
1527 * Old-style hash of a string *
1528 *************************************************/
1530 /* Perform the ${hash expansion operation.
1533 subject the input string (an expanded substring)
1534 value1 the length of the output string; if greater or equal to the
1535 length of the input string, the input string is returned
1536 value2 the number of hash characters to use, or 26 if negative
1537 len set to the length of the returned string
1539 Returns: pointer to the output string, or NULL if there is an error
1543 compute_hash(uschar *subject, int value1, int value2, int *len)
1545 int sublen = Ustrlen(subject);
1547 if (value2 < 0) value2 = 26;
1548 else if (value2 > Ustrlen(hashcodes))
1550 expand_string_message =
1551 string_sprintf("hash count \"%d\" too big", value2);
1555 /* Calculate the hash text. We know it is shorter than the original string, so
1556 can safely place it in subject[] (we know that subject is always itself an
1557 expanded substring). */
1559 if (value1 < sublen)
1564 while ((c = (subject[j])) != 0)
1566 int shift = (c + j++) & 7;
1567 subject[i] ^= (c << shift) | (c >> (8-shift));
1568 if (++i >= value1) i = 0;
1570 for (i = 0; i < value1; i++)
1571 subject[i] = hashcodes[(subject[i]) % value2];
1573 else value1 = sublen;
1582 /*************************************************
1583 * Numeric hash of a string *
1584 *************************************************/
1586 /* Perform the ${nhash expansion operation. The first characters of the
1587 string are treated as most important, and get the highest prime numbers.
1590 subject the input string
1591 value1 the maximum value of the first part of the result
1592 value2 the maximum value of the second part of the result,
1593 or negative to produce only a one-part result
1594 len set to the length of the returned string
1596 Returns: pointer to the output string, or NULL if there is an error.
1600 compute_nhash (uschar *subject, int value1, int value2, int *len)
1602 uschar *s = subject;
1604 unsigned long int total = 0; /* no overflow */
1608 if (i == 0) i = nelem(prime) - 1;
1609 total += prime[i--] * (unsigned int)(*s++);
1612 /* If value2 is unset, just compute one number */
1615 s = string_sprintf("%lu", total % value1);
1617 /* Otherwise do a div/mod hash */
1621 total = total % (value1 * value2);
1622 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1633 /*************************************************
1634 * Find the value of a header or headers *
1635 *************************************************/
1637 /* Multiple instances of the same header get concatenated, and this function
1638 can also return a concatenation of all the header lines. When concatenating
1639 specific headers that contain lists of addresses, a comma is inserted between
1640 them. Otherwise we use a straight concatenation. Because some messages can have
1641 pathologically large number of lines, there is a limit on the length that is
1645 name the name of the header, without the leading $header_ or $h_,
1646 or NULL if a concatenation of all headers is required
1647 newsize return the size of memory block that was obtained; may be NULL
1648 if exists_only is TRUE
1649 flags FH_EXISTS_ONLY
1650 set if called from a def: test; don't need to build a string;
1651 just return a string that is not "" and not "0" if the header
1654 set if called for $rh_ or $rheader_ items; no processing,
1655 other than concatenating, will be done on the header. Also used
1656 for $message_headers_raw.
1658 Double colon chars in the content, and replace newline with
1659 colon between each element when concatenating; returning a
1660 colon-sep list (elements might contain newlines)
1661 charset name of charset to translate MIME words to; used only if
1662 want_raw is false; if NULL, no translation is done (this is
1663 used for $bh_ and $bheader_)
1665 Returns: NULL if the header does not exist, else a pointer to a new
1670 find_header(uschar *name, int *newsize, unsigned flags, const uschar *charset)
1673 int len = name ? Ustrlen(name) : 0;
1677 for (header_line * h = header_list; h; h = h->next)
1678 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1679 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1684 if (flags & FH_EXISTS_ONLY)
1685 return US"1"; /* don't need actual string */
1688 s = h->text + len; /* text to insert */
1689 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1690 Uskip_whitespace(&s); /* remove leading white space */
1691 t = h->text + h->slen; /* end-point */
1693 /* Unless wanted raw, remove trailing whitespace, including the
1696 if (flags & FH_WANT_LIST)
1697 while (t > s && t[-1] == '\n') t--;
1698 else if (!(flags & FH_WANT_RAW))
1700 while (t > s && isspace(t[-1])) t--;
1702 /* Set comma if handling a single header and it's one of those
1703 that contains an address list, except when asked for raw headers. Only
1704 need to do this once. */
1706 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1709 /* Trim the header roughly if we're approaching limits */
1711 if (gstring_length(g) + inc > header_insert_maxlen)
1712 inc = header_insert_maxlen - gstring_length(g);
1714 /* For raw just copy the data; for a list, add the data as a colon-sep
1715 list-element; for comma-list add as an unchecked comma,newline sep
1716 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1717 stripped trailing WS above including the newline). We ignore the potential
1718 expansion due to colon-doubling, just leaving the loop if the limit is met
1721 if (flags & FH_WANT_LIST)
1722 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1723 else if (flags & FH_WANT_RAW)
1724 g = string_catn(g, s, (unsigned)inc);
1726 g = string_append2_listele_n(g, comma ? US",\n" : US"\n",
1729 if (gstring_length(g) >= header_insert_maxlen) break;
1732 if (!found) return NULL; /* No header found */
1733 if (!g) return US"";
1735 /* That's all we do for raw header expansion. */
1738 if (flags & FH_WANT_RAW)
1739 return string_from_gstring(g);
1741 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1742 The rfc2047_decode2() function can return an error with decoded data if the
1743 charset translation fails. If decoding fails, it returns NULL. */
1747 uschar * error, * decoded = rfc2047_decode2(string_from_gstring(g),
1748 check_rfc2047_length, charset, '?', NULL, newsize, &error);
1750 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1751 " input was: %s\n", error, g->s);
1752 return decoded ? decoded : string_from_gstring(g);
1759 /* Append a "local" element to an Authentication-Results: header
1760 if this was a non-smtp message.
1764 authres_local(gstring * g, const uschar * sysname)
1766 if (!f.authentication_local)
1768 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1769 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1774 /* Append an "iprev" element to an Authentication-Results: header
1775 if we have attempted to get the calling host's name.
1779 authres_iprev(gstring * g)
1781 if (sender_host_name)
1782 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1783 else if (host_lookup_deferred)
1784 g = string_cat(g, US";\n\tiprev=temperror");
1785 else if (host_lookup_failed)
1786 g = string_cat(g, US";\n\tiprev=fail");
1790 if (sender_host_address)
1791 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1797 /*************************************************
1798 * Return list of recipients *
1799 *************************************************/
1800 /* A recipients list is available only during system message filtering,
1801 during ACL processing after DATA, and while expanding pipe commands
1802 generated from a system filter, but not elsewhere. */
1810 if (!f.enable_dollar_recipients) return NULL;
1812 for (int i = 0; i < recipients_count; i++)
1814 s = recipients_list[i].address;
1815 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1817 return g ? g->s : NULL;
1821 /*************************************************
1822 * Return size of queue *
1823 *************************************************/
1824 /* Ask the daemon for the queue size */
1829 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1833 const uschar * where;
1836 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
1838 DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));
1842 len = daemon_client_sockname(&sa_un, &sname);
1844 if (bind(fd, (const struct sockaddr *)&sa_un, (socklen_t)len) < 0)
1845 { where = US"bind"; goto bad; }
1848 debug_printf("local addr '%s%s'\n",
1849 *sa_un.sun_path ? "" : "@",
1850 sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1853 len = daemon_notifier_sockname(&sa_un);
1854 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
1855 { where = US"connect"; goto bad2; }
1857 buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1858 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1860 if (poll_one_fd(fd, POLLIN, 2 * 1000) != 1)
1862 DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1863 len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1865 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1866 { where = US"recv"; goto bad2; }
1869 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1872 return string_copyn(buf, len);
1875 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1880 DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1885 /*************************************************
1886 * Find value of a variable *
1887 *************************************************/
1889 /* The table of variables is kept in alphabetic order, so we can search it
1890 using a binary chop. The "choplen" variable is nothing to do with the binary
1894 name the name of the variable being sought
1895 exists_only TRUE if this is a def: test; passed on to find_header()
1896 skipping TRUE => skip any processing evaluation; this is not the same as
1897 exists_only because def: may test for values that are first
1899 newsize pointer to an int which is initially zero; if the answer is in
1900 a new memory buffer, *newsize is set to its size
1902 Returns: NULL if the variable does not exist, or
1903 a pointer to the variable's contents, or
1904 something non-NULL if exists_only is TRUE
1907 static const uschar *
1908 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1915 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1916 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1917 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1918 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1919 (this gave backwards compatibility at the changeover). There may be built-in
1920 variables whose names start acl_ but they should never start in this way. This
1921 slightly messy specification is a consequence of the history, needless to say.
1923 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1924 set, in which case give an error. */
1926 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1930 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1931 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1933 else if (Ustrncmp(name, "r_", 2) == 0)
1935 tree_node * node = tree_search(router_var, name + 2);
1936 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1939 /* Handle $auth<n>, $regex<n> variables. */
1941 if (Ustrncmp(name, "auth", 4) == 0)
1944 int n = Ustrtoul(name + 4, &endptr, 10);
1945 if (!*endptr && n != 0 && n <= AUTH_VARS)
1946 return auth_vars[n-1] ? auth_vars[n-1] : US"";
1948 #ifdef WITH_CONTENT_SCAN
1949 else if (Ustrncmp(name, "regex", 5) == 0)
1952 int n = Ustrtoul(name + 5, &endptr, 10);
1953 if (!*endptr && n != 0 && n <= REGEX_VARS)
1954 return regex_vars[n-1] ? regex_vars[n-1] : US"";
1958 /* For all other variables, search the table */
1960 if (!(vp = find_var_ent(name)))
1961 return NULL; /* Unknown variable name */
1963 /* Found an existing variable. If in skipping state, the value isn't needed,
1964 and we want to avoid processing (such as looking up the host name). */
1972 case vtype_filter_int:
1973 if (!f.filter_running) return NULL;
1977 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1981 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1985 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1989 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1993 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1996 case vtype_stringptr: /* Pointer to string */
1997 return (s = *((uschar **)(val))) ? s : US"";
2000 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
2003 case vtype_load_avg:
2004 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
2007 case vtype_host_lookup: /* Lookup if not done so */
2008 if ( !sender_host_name && sender_host_address
2009 && !host_lookup_failed && host_name_lookup() == OK)
2010 host_build_sender_fullhost();
2011 return sender_host_name ? sender_host_name : US"";
2013 case vtype_localpart: /* Get local part from address */
2014 if (!(s = *((uschar **)(val)))) return US"";
2015 if (!(domain = Ustrrchr(s, '@'))) return s;
2016 if (domain - s > sizeof(var_buffer) - 1)
2017 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
2018 " in string expansion", sizeof(var_buffer));
2019 return string_copyn(s, domain - s);
2021 case vtype_domain: /* Get domain from address */
2022 if (!(s = *((uschar **)(val)))) return US"";
2023 domain = Ustrrchr(s, '@');
2024 return domain ? domain + 1 : US"";
2026 case vtype_msgheaders:
2027 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
2029 case vtype_msgheaders_raw:
2030 return find_header(NULL, newsize,
2031 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
2033 case vtype_msgbody: /* Pointer to msgbody string */
2034 case vtype_msgbody_end: /* Ditto, the end of the msg */
2035 ss = (uschar **)(val);
2036 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
2039 off_t start_offset = SPOOL_DATA_START_OFFSET;
2040 int len = message_body_visible;
2042 if (len > message_size) len = message_size;
2043 *ss = body = store_get(len+1, GET_TAINTED);
2045 if (vp->type == vtype_msgbody_end)
2047 struct stat statbuf;
2048 if (fstat(deliver_datafile, &statbuf) == 0)
2050 start_offset = statbuf.st_size - len;
2051 if (start_offset < SPOOL_DATA_START_OFFSET)
2052 start_offset = SPOOL_DATA_START_OFFSET;
2055 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
2056 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
2058 if ((len = read(deliver_datafile, body, len)) > 0)
2061 if (message_body_newlines) /* Separate loops for efficiency */
2063 { if (body[--len] == 0) body[len] = ' '; }
2066 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
2069 return *ss ? *ss : US"";
2071 case vtype_todbsdin: /* BSD inbox time of day */
2072 return tod_stamp(tod_bsdin);
2074 case vtype_tode: /* Unix epoch time of day */
2075 return tod_stamp(tod_epoch);
2077 case vtype_todel: /* Unix epoch/usec time of day */
2078 return tod_stamp(tod_epoch_l);
2080 case vtype_todf: /* Full time of day */
2081 return tod_stamp(tod_full);
2083 case vtype_todl: /* Log format time of day */
2084 return tod_stamp(tod_log_bare); /* (without timezone) */
2086 case vtype_todzone: /* Time zone offset only */
2087 return tod_stamp(tod_zone);
2089 case vtype_todzulu: /* Zulu time */
2090 return tod_stamp(tod_zulu);
2092 case vtype_todlf: /* Log file datestamp tod */
2093 return tod_stamp(tod_log_datestamp_daily);
2095 case vtype_reply: /* Get reply address */
2096 s = find_header(US"reply-to:", newsize,
2097 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2099 if (s) Uskip_whitespace(&s);
2102 *newsize = 0; /* For the *s==0 case */
2103 s = find_header(US"from:", newsize,
2104 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2110 Uskip_whitespace(&s);
2111 for (t = s; *t; t++) if (*t == '\n') *t = ' ';
2112 while (t > s && isspace(t[-1])) t--;
2115 return s ? s : US"";
2117 case vtype_string_func:
2119 stringptr_fn_t * fn = (stringptr_fn_t *) val;
2121 return s ? s : US"";
2127 sprintf(CS var_buffer, PR_EXIM_ARITH,
2128 receive_statvfs(val == (void *)TRUE, &inodes));
2135 (void) receive_statvfs(val == (void *)TRUE, &inodes);
2136 sprintf(CS var_buffer, "%d", inodes);
2141 return *(void **)val ? US"<cert>" : US"";
2143 #ifndef DISABLE_DKIM
2145 return dkim_exim_expand_query((int)(long)val);
2150 return NULL; /* Unknown variable. Silences static checkers. */
2157 modify_variable(uschar *name, void * value)
2160 if ((vp = find_var_ent(name))) vp->value = value;
2161 return; /* Unknown variable name, fail silently */
2169 /*************************************************
2170 * Read and expand substrings *
2171 *************************************************/
2173 /* This function is called to read and expand argument substrings for various
2174 expansion items. Some have a minimum requirement that is less than the maximum;
2175 in these cases, the first non-present one is set to NULL.
2178 sub points to vector of pointers to set
2179 n maximum number of substrings
2181 sptr points to current string pointer
2183 skipping the skipping flag
2184 check_end if TRUE, check for final '}'
2185 name name of item, for error message
2186 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2188 textonly_p if not NULL, pointer to bitmask of which subs were text-only
2189 (did not change when expended)
2191 Returns: -1 OK; string pointer updated, but in "skipping" mode
2192 0 OK; string pointer updated
2193 1 curly bracketing error (too few arguments)
2194 2 too many arguments (only if check_end is set); message set
2195 3 other error (expansion failure)
2199 read_subs(uschar ** sub, int n, int m, const uschar ** sptr, esi_flags flags,
2200 BOOL check_end, uschar * name, BOOL * resetok, unsigned * textonly_p)
2202 const uschar * s = *sptr;
2203 unsigned textonly_l = 0;
2205 Uskip_whitespace(&s);
2206 for (int i = 0; i < n; i++)
2213 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2214 "(min is %d)", name, m);
2220 if (!(sub[i] = expand_string_internal(s+1,
2221 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, &s, resetok,
2222 textonly_p ? &textonly : NULL)))
2224 if (*s++ != '}') return 1;
2225 if (textonly_p && textonly) textonly_l |= BIT(i);
2226 Uskip_whitespace(&s);
2228 if (check_end && *s++ != '}')
2232 expand_string_message = string_sprintf("Too many arguments for '%s' "
2233 "(max is %d)", name, n);
2236 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2240 if (textonly_p) *textonly_p = textonly_l;
2242 return flags & ESI_SKIPPING ? -1 : 0;
2248 /*************************************************
2249 * Elaborate message for bad variable *
2250 *************************************************/
2252 /* For the "unknown variable" message, take a look at the variable's name, and
2253 give additional information about possible ACL variables. The extra information
2254 is added on to expand_string_message.
2256 Argument: the name of the variable
2261 check_variable_error_message(uschar *name)
2263 if (Ustrncmp(name, "acl_", 4) == 0)
2264 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2265 (name[4] == 'c' || name[4] == 'm')?
2267 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2268 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2270 US"user-defined ACL variables must start acl_c or acl_m");
2276 Load args from sub array to globals, and call acl_check().
2277 Sub array will be corrupted on return.
2279 Returns: OK access is granted by an ACCEPT verb
2280 DISCARD access is (apparently) granted by a DISCARD verb
2281 FAIL access is denied
2282 FAIL_DROP access is denied; drop the connection
2283 DEFER can't tell at the moment
2287 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2290 int sav_narg = acl_narg;
2292 uschar * dummy_logmsg;
2293 extern int acl_where;
2295 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2296 for (i = 0; i < nsub && sub[i+1]; i++)
2298 uschar * tmp = acl_arg[i];
2299 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2300 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2305 sub[i+1] = acl_arg[i];
2306 acl_arg[i++] = NULL;
2310 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2312 acl_narg>0 ? acl_arg[0] : US"<none>",
2313 acl_narg>1 ? " +more" : "");
2315 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2317 for (i = 0; i < nsub; i++)
2318 acl_arg[i] = sub[i+1]; /* restore old args */
2319 acl_narg = sav_narg;
2327 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2328 The given string is modified on return. Leading whitespace is skipped while
2329 looking for the opening wrap character, then the rest is scanned for the trailing
2330 (non-escaped) wrap character. A backslash in the string will act as an escape.
2332 A nul is written over the trailing wrap, and a pointer to the char after the
2333 leading wrap is returned.
2336 s String for de-wrapping
2337 wrap Two-char string, the first being the opener, second the closer wrapping
2340 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2344 dewrap(uschar * s, const uschar * wrap)
2348 BOOL quotesmode = wrap[0] == wrap[1];
2350 if (Uskip_whitespace(&p) == *wrap)
2356 if (*p == '\\') p++;
2357 else if (!quotesmode && *p == wrap[-1]) depth++;
2358 else if (*p == *wrap)
2369 expand_string_message = string_sprintf("missing '%c'", *wrap);
2374 /* Pull off the leading array or object element, returning
2375 a copy in an allocated string. Update the list pointer.
2377 The element may itself be an abject or array.
2378 Return NULL when the list is empty.
2382 json_nextinlist(const uschar ** list)
2384 unsigned array_depth = 0, object_depth = 0;
2385 const uschar * s = *list, * item;
2387 skip_whitespace(&s);
2390 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2394 case '[': array_depth++; break;
2395 case ']': array_depth--; break;
2396 case '{': object_depth++; break;
2397 case '}': object_depth--; break;
2399 *list = *s ? s+1 : s;
2400 if (item == s) return NULL;
2401 item = string_copyn(item, s - item);
2402 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2408 /************************************************/
2409 /* Return offset in ops table, or -1 if not found.
2410 Repoint to just after the operator in the string.
2413 ss string representation of operator
2414 opname split-out operator name
2418 identify_operator(const uschar ** ss, uschar ** opname)
2420 const uschar * s = *ss;
2423 /* Numeric comparisons are symbolic */
2425 if (*s == '=' || *s == '>' || *s == '<')
2437 /* All other conditions are named */
2440 s = read_name(name, sizeof(name), s, US"_");
2443 /* If we haven't read a name, it means some non-alpha character is first. */
2447 expand_string_message = string_sprintf("condition name expected, "
2448 "but found \"%.16s\"", s);
2452 *opname = string_copy(name);
2454 return chop_match(name, cond_table, nelem(cond_table));
2458 /*************************************************
2459 * Handle MD5 or SHA-1 computation for HMAC *
2460 *************************************************/
2462 /* These are some wrapping functions that enable the HMAC code to be a bit
2463 cleaner. A good compiler will spot the tail recursion.
2466 type HMAC_MD5 or HMAC_SHA1
2467 remaining are as for the cryptographic hash functions
2473 chash_start(int type, void * base)
2475 if (type == HMAC_MD5)
2476 md5_start((md5 *)base);
2478 sha1_start((hctx *)base);
2482 chash_mid(int type, void * base, const uschar * string)
2484 if (type == HMAC_MD5)
2485 md5_mid((md5 *)base, string);
2487 sha1_mid((hctx *)base, string);
2491 chash_end(int type, void * base, const uschar * string, int length,
2494 if (type == HMAC_MD5)
2495 md5_end((md5 *)base, string, length, digest);
2497 sha1_end((hctx *)base, string, length, digest);
2504 /* Do an hmac_md5. The result is _not_ nul-terminated, and is sized as
2505 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2508 key encoding key, nul-terminated
2509 src data to be hashed, nul-terminated
2511 len size of output buffer
2515 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2518 const uschar * keyptr;
2520 unsigned int keylen;
2522 #define MD5_HASHLEN 16
2523 #define MD5_HASHBLOCKLEN 64
2525 uschar keyhash[MD5_HASHLEN];
2526 uschar innerhash[MD5_HASHLEN];
2527 uschar finalhash[MD5_HASHLEN];
2528 uschar innerkey[MD5_HASHBLOCKLEN];
2529 uschar outerkey[MD5_HASHBLOCKLEN];
2532 keylen = Ustrlen(keyptr);
2534 /* If the key is longer than the hash block length, then hash the key
2537 if (keylen > MD5_HASHBLOCKLEN)
2539 chash_start(HMAC_MD5, &md5_base);
2540 chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2542 keylen = MD5_HASHLEN;
2545 /* Now make the inner and outer key values */
2547 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2548 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2550 for (int i = 0; i < keylen; i++)
2552 innerkey[i] ^= keyptr[i];
2553 outerkey[i] ^= keyptr[i];
2556 /* Now do the hashes */
2558 chash_start(HMAC_MD5, &md5_base);
2559 chash_mid(HMAC_MD5, &md5_base, innerkey);
2560 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2562 chash_start(HMAC_MD5, &md5_base);
2563 chash_mid(HMAC_MD5, &md5_base, outerkey);
2564 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2566 /* Encode the final hash as a hex string, limited by output buffer size */
2569 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2571 if (j-- <= 0) break;
2572 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2573 if (j-- <= 0) break;
2574 *p++ = hex_digits[finalhash[i] & 0x0f];
2578 #endif /*SUPPORT_SRS*/
2581 /*************************************************
2582 * Read and evaluate a condition *
2583 *************************************************/
2587 s points to the start of the condition text
2588 resetok points to a BOOL which is written false if it is unsafe to
2589 free memory. Certain condition types (acl) may have side-effect
2590 allocation which must be preserved.
2591 yield points to a BOOL to hold the result of the condition test;
2592 if NULL, we are just reading through a condition that is
2593 part of an "or" combination to check syntax, or in a state
2594 where the answer isn't required
2596 Returns: a pointer to the first character after the condition, or
2600 static const uschar *
2601 eval_condition(const uschar * s, BOOL * resetok, BOOL * yield)
2603 BOOL testfor = TRUE;
2604 BOOL tempcond, combined_cond;
2606 BOOL sub2_honour_dollar = TRUE;
2607 BOOL is_forany, is_json, is_jsons;
2609 int_eximarith_t num[2];
2610 struct stat statbuf;
2613 const uschar * sub[10];
2614 unsigned sub_textonly = 0;
2617 if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;
2619 switch(cond_type = identify_operator(&s, &opname))
2621 /* def: tests for a non-empty variable, or for the existence of a header. If
2622 yield == NULL we are in a skipping state, and don't care about the answer. */
2630 expand_string_message = US"\":\" expected after \"def\"";
2634 s = read_name(name, sizeof(name), s+1, US"_");
2636 /* Test for a header's existence. If the name contains a closing brace
2637 character, this may be a user error where the terminating colon has been
2638 omitted. Set a flag to adjust a subsequent error message in this case. */
2640 if ( ( *(t = name) == 'h'
2641 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2643 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2646 s = read_header_name(name, sizeof(name), s);
2647 /* {-for-text-editors */
2648 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2650 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2653 /* Test for a variable's having a non-empty value. A non-existent variable
2654 causes an expansion failure. */
2658 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2660 expand_string_message = name[0]
2661 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2662 : US"variable name omitted after \"def:\"";
2663 check_variable_error_message(name);
2666 if (yield) *yield = (t[0] != 0) == testfor;
2673 /* first_delivery tests for first delivery attempt */
2675 case ECOND_FIRST_DELIVERY:
2676 if (yield) *yield = f.deliver_firsttime == testfor;
2680 /* queue_running tests for any process started by a queue runner */
2682 case ECOND_QUEUE_RUNNING:
2683 if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2687 /* exists: tests for file existence
2688 isip: tests for any IP address
2689 isip4: tests for an IPv4 address
2690 isip6: tests for an IPv6 address
2691 pam: does PAM authentication
2692 radius: does RADIUS authentication
2693 ldapauth: does LDAP authentication
2694 pwcheck: does Cyrus SASL pwcheck authentication
2703 case ECOND_LDAPAUTH:
2706 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2710 sub[0] = expand_string_internal(s+1,
2711 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
2712 &s, resetok, &textonly);
2713 if (!sub[0]) return NULL;
2714 if (textonly) sub_textonly |= BIT(0);
2716 /* {-for-text-editors */
2717 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2719 if (!yield) return s; /* No need to run the test if skipping */
2724 if ((expand_forbid & RDO_EXISTS) != 0)
2726 expand_string_message = US"File existence tests are not permitted";
2729 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2735 rc = string_is_ip_address(sub[0], NULL);
2736 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2737 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2740 /* Various authentication tests - all optionally compiled */
2744 rc = auth_call_pam(sub[0], &expand_string_message);
2747 goto COND_FAILED_NOT_COMPILED;
2748 #endif /* SUPPORT_PAM */
2751 #ifdef RADIUS_CONFIG_FILE
2752 rc = auth_call_radius(sub[0], &expand_string_message);
2755 goto COND_FAILED_NOT_COMPILED;
2756 #endif /* RADIUS_CONFIG_FILE */
2758 case ECOND_LDAPAUTH:
2761 /* Just to keep the interface the same */
2763 int old_pool = store_pool;
2764 store_pool = POOL_SEARCH;
2765 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2766 &expand_string_message, &do_cache);
2767 store_pool = old_pool;
2771 goto COND_FAILED_NOT_COMPILED;
2772 #endif /* LOOKUP_LDAP */
2775 #ifdef CYRUS_PWCHECK_SOCKET
2776 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2779 goto COND_FAILED_NOT_COMPILED;
2780 #endif /* CYRUS_PWCHECK_SOCKET */
2782 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2783 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2785 if (rc == ERROR || rc == DEFER) return NULL;
2786 *yield = (rc == OK) == testfor;
2792 /* call ACL (in a conditional context). Accept true, deny false.
2793 Defer is a forced-fail. Anything set by message= goes to $value.
2794 Up to ten parameters are used; we use the braces round the name+args
2795 like the saslauthd condition does, to permit a variable number of args.
2796 See also the expansion-item version EITEM_ACL and the traditional
2797 acl modifier ACLC_ACL.
2798 Since the ACL may allocate new global variables, tell our caller to not
2803 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2809 Uskip_whitespace(&s);
2810 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2812 switch(read_subs(sub, nelem(sub), 1, &s,
2813 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2815 case 1: expand_string_message = US"too few arguments or bracketing "
2818 case 3: return NULL;
2824 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2825 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2830 lookup_value = NULL;
2832 lookup_value = string_copy(user_msg);
2833 *yield = cond == testfor;
2837 f.expand_string_forcedfail = TRUE;
2840 expand_string_message = string_sprintf("%s from acl \"%s\"",
2841 rc_names[rc], sub[0]);
2849 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2851 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2853 However, the last two are optional. That is why the whole set is enclosed
2854 in their own set of braces. */
2856 case ECOND_SASLAUTHD:
2857 #ifndef CYRUS_SASLAUTHD_SOCKET
2858 goto COND_FAILED_NOT_COMPILED;
2862 Uskip_whitespace(&s);
2863 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2864 switch(read_subs(sub, nelem(sub), 2, &s,
2865 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2867 case 1: expand_string_message = US"too few arguments or bracketing "
2868 "error for saslauthd";
2870 case 3: return NULL;
2872 if (!sub[2]) sub[3] = NULL; /* realm if no service */
2875 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2876 &expand_string_message);
2877 if (rc == ERROR || rc == DEFER) return NULL;
2878 *yield = (rc == OK) == testfor;
2882 #endif /* CYRUS_SASLAUTHD_SOCKET */
2885 /* symbolic operators for numeric and string comparison, and a number of
2886 other operators, all requiring two arguments.
2888 crypteq: encrypts plaintext and compares against an encrypted text,
2889 using crypt(), crypt16(), MD5 or SHA-1
2890 inlist/inlisti: checks if first argument is in the list of the second
2891 match: does a regular expression match and sets up the numerical
2892 variables if it succeeds
2893 match_address: matches in an address list
2894 match_domain: matches in a domain list
2895 match_ip: matches a host list that is restricted to IP addresses
2896 match_local_part: matches in a local part list
2899 case ECOND_MATCH_ADDRESS:
2900 case ECOND_MATCH_DOMAIN:
2901 case ECOND_MATCH_IP:
2902 case ECOND_MATCH_LOCAL_PART:
2903 #ifndef EXPAND_LISTMATCH_RHS
2904 sub2_honour_dollar = FALSE;
2913 case ECOND_NUM_L: /* Numerical comparisons */
2920 case ECOND_STR_LT: /* String comparisons */
2931 for (int i = 0; i < 2; i++)
2934 /* Sometimes, we don't expand substrings; too many insecure configurations
2935 created using match_address{}{} and friends, where the second param
2936 includes information from untrustworthy sources. */
2937 /*XXX is this moot given taint-tracking? */
2939 esi_flags flags = ESI_BRACE_ENDS;
2941 if (!(i > 0 && !sub2_honour_dollar)) flags |= ESI_HONOR_DOLLAR;
2942 if (!yield) flags |= ESI_SKIPPING;
2944 if (Uskip_whitespace(&s) != '{')
2946 if (i == 0) goto COND_FAILED_CURLY_START;
2947 expand_string_message = string_sprintf("missing 2nd string in {} "
2948 "after \"%s\"", opname);
2951 if (!(sub[i] = expand_string_internal(s+1, flags, &s, resetok, &textonly)))
2953 if (textonly) sub_textonly |= BIT(i);
2954 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2955 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2956 " for security reasons\n");
2957 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2959 /* Convert to numerical if required; we know that the names of all the
2960 conditions that compare numbers do not start with a letter. This just saves
2961 checking for them individually. */
2963 if (!isalpha(opname[0]) && yield)
2968 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2972 num[i] = expanded_string_integer(sub[i], FALSE);
2973 if (expand_string_message) return NULL;
2977 /* Result not required */
2979 if (!yield) return s;
2981 /* Do an appropriate comparison */
2987 tempcond = (num[0] == num[1]); break;
2990 tempcond = (num[0] > num[1]); break;
2993 tempcond = (num[0] >= num[1]); break;
2996 tempcond = (num[0] < num[1]); break;
2999 tempcond = (num[0] <= num[1]); break;
3002 tempcond = (Ustrcmp(sub[0], sub[1]) < 0); break;
3005 tempcond = (strcmpic(sub[0], sub[1]) < 0); break;
3008 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0); break;
3011 tempcond = (strcmpic(sub[0], sub[1]) <= 0); break;
3014 tempcond = (Ustrcmp(sub[0], sub[1]) == 0); break;
3017 tempcond = (strcmpic(sub[0], sub[1]) == 0); break;
3020 tempcond = (Ustrcmp(sub[0], sub[1]) > 0); break;
3023 tempcond = (strcmpic(sub[0], sub[1]) > 0); break;
3026 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0); break;
3029 tempcond = (strcmpic(sub[0], sub[1]) >= 0); break;
3031 case ECOND_MATCH: /* Regular expression match */
3033 const pcre2_code * re = regex_compile(sub[1],
3034 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
3035 &expand_string_message, pcre_gen_cmp_ctx);
3039 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
3043 case ECOND_MATCH_ADDRESS: /* Match in an address list */
3044 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0,
3045 CUSS &lookup_value);
3046 goto MATCHED_SOMETHING;
3048 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
3049 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
3050 MCL_DOMAIN + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3051 goto MATCHED_SOMETHING;
3053 case ECOND_MATCH_IP: /* Match IP address in a host list */
3054 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
3056 expand_string_message = string_sprintf("\"%s\" is not an IP address",
3062 unsigned int *nullcache = NULL;
3063 check_host_block cb;
3065 cb.host_name = US"";
3066 cb.host_address = sub[0];
3068 /* If the host address starts off ::ffff: it is an IPv6 address in
3069 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3072 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3073 cb.host_address + 7 : cb.host_address;
3075 rc = match_check_list(
3076 &sub[1], /* the list */
3077 0, /* separator character */
3078 &hostlist_anchor, /* anchor pointer */
3079 &nullcache, /* cache pointer */
3080 check_host, /* function for testing */
3081 &cb, /* argument for function */
3082 MCL_HOST, /* type of check */
3083 sub[0], /* text for debugging */
3084 CUSS &lookup_value); /* where to pass back data */
3086 goto MATCHED_SOMETHING;
3088 case ECOND_MATCH_LOCAL_PART:
3089 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3090 MCL_LOCALPART + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3096 case OK: tempcond = TRUE; break;
3097 case FAIL: tempcond = FALSE; break;
3100 expand_string_message = string_sprintf("unable to complete match "
3101 "against \"%s\": %s", sub[1], search_error_message);
3107 /* Various "encrypted" comparisons. If the second string starts with
3108 "{" then an encryption type is given. Default to crypt() or crypt16()
3109 (build-time choice). */
3110 /* }-for-text-editors */
3113 #ifndef SUPPORT_CRYPTEQ
3114 goto COND_FAILED_NOT_COMPILED;
3116 if (strncmpic(sub[1], US"{md5}", 5) == 0)
3118 int sublen = Ustrlen(sub[1]+5);
3123 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3125 /* If the length that we are comparing against is 24, the MD5 digest
3126 is expressed as a base64 string. This is the way LDAP does it. However,
3127 some other software uses a straightforward hex representation. We assume
3128 this if the length is 32. Other lengths fail. */
3132 uschar *coded = b64encode(CUS digest, 16);
3133 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3134 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3135 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3137 else if (sublen == 32)
3140 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3142 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3143 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3144 tempcond = (strcmpic(coded, sub[1]+5) == 0);
3148 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3149 "fail\n crypted=%s\n", sub[1]+5);
3154 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3156 int sublen = Ustrlen(sub[1]+6);
3161 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3163 /* If the length that we are comparing against is 28, assume the SHA1
3164 digest is expressed as a base64 string. If the length is 40, assume a
3165 straightforward hex representation. Other lengths fail. */
3169 uschar *coded = b64encode(CUS digest, 20);
3170 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3171 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3172 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3174 else if (sublen == 40)
3177 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3179 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3180 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3181 tempcond = (strcmpic(coded, sub[1]+6) == 0);
3185 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3186 "fail\n crypted=%s\n", sub[1]+6);
3191 else /* {crypt} or {crypt16} and non-{ at start */
3192 /* }-for-text-editors */
3197 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3202 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3207 else if (sub[1][0] == '{') /* }-for-text-editors */
3209 expand_string_message = string_sprintf("unknown encryption mechanism "
3210 "in \"%s\"", sub[1]);
3216 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3217 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
3218 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3222 #define XSTR(s) STR(s)
3223 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3224 " subject=%s\n crypted=%s\n",
3225 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3230 /* If the encrypted string contains fewer than two characters (for the
3231 salt), force failure. Otherwise we get false positives: with an empty
3232 string the yield of crypt() is an empty string! */
3235 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3236 else if (errno == EINVAL)
3240 expand_string_message = string_sprintf("crypt error: %s\n",
3241 US strerror(errno));
3246 #endif /* SUPPORT_CRYPTEQ */
3251 const uschar * list = sub[1];
3253 uschar *save_iterate_item = iterate_item;
3254 int (*compare)(const uschar *, const uschar *);
3256 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);
3259 compare = cond_type == ECOND_INLISTI
3260 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3262 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3264 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3265 if (compare(sub[0], iterate_item) == 0)
3268 lookup_value = iterate_item;
3272 iterate_item = save_iterate_item;
3275 } /* Switch for comparison conditions */
3277 *yield = tempcond == testfor;
3278 return s; /* End of comparison conditions */
3281 /* and/or: computes logical and/or of several conditions */
3285 subcondptr = (yield == NULL) ? NULL : &tempcond;
3286 combined_cond = (cond_type == ECOND_AND);
3288 Uskip_whitespace(&s);
3289 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3293 /* {-for-text-editors */
3294 if (Uskip_whitespace(&s) == '}') break;
3295 if (*s != '{') /* }-for-text-editors */
3297 expand_string_message = string_sprintf("each subcondition "
3298 "inside an \"%s{...}\" condition must be in its own {}", opname);
3302 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3304 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3305 expand_string_message, opname);
3308 Uskip_whitespace(&s);
3310 /* {-for-text-editors */
3313 /* {-for-text-editors */
3314 expand_string_message = string_sprintf("missing } at end of condition "
3315 "inside \"%s\" group", opname);
3320 if (cond_type == ECOND_AND)
3322 combined_cond &= tempcond;
3323 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3324 } /* evaluate any more */
3327 combined_cond |= tempcond;
3328 if (combined_cond) subcondptr = NULL; /* once true, don't */
3329 } /* evaluate any more */
3332 if (yield) *yield = (combined_cond == testfor);
3336 /* forall/forany: iterates a condition with different values */
3338 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3339 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3340 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3341 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3342 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3343 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3347 const uschar * list;
3349 uschar *save_iterate_item = iterate_item;
3351 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3353 Uskip_whitespace(&s);
3354 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3355 if (!(sub[0] = expand_string_internal(s,
3356 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
3357 &s, resetok, NULL)))
3359 /* {-for-text-editors */
3360 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3362 Uskip_whitespace(&s);
3363 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3367 /* Call eval_condition once, with result discarded (as if scanning a
3368 "false" part). This allows us to find the end of the condition, because if
3369 the list it empty, we won't actually evaluate the condition for real. */
3371 if (!(s = eval_condition(sub[1], resetok, NULL)))
3373 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3374 expand_string_message, opname);
3377 Uskip_whitespace(&s);
3379 /* {-for-text-editors */
3382 /* {-for-text-editors */
3383 expand_string_message = string_sprintf("missing } at end of condition "
3384 "inside \"%s\"", opname);
3388 if (yield) *yield = !testfor;
3390 if (is_json) list = dewrap(string_copy(list), US"[]");
3391 while ((iterate_item = is_json
3392 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3395 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3397 expand_string_message =
3398 string_sprintf("%s wrapping string result for extract jsons",
3399 expand_string_message);
3400 iterate_item = save_iterate_item;
3404 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3405 if (!eval_condition(sub[1], resetok, &tempcond))
3407 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3408 expand_string_message, opname);
3409 iterate_item = save_iterate_item;
3412 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3413 tempcond? "true":"false");
3415 if (yield) *yield = (tempcond == testfor);
3416 if (tempcond == is_forany) break;
3419 iterate_item = save_iterate_item;
3424 /* The bool{} expansion condition maps a string to boolean.
3425 The values supported should match those supported by the ACL condition
3426 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3427 of true/false. Note that Router "condition" rules have a different
3428 interpretation, where general data can be used and only a few values
3430 Note that readconf.c boolean matching, for boolean configuration options,
3431 only matches true/yes/false/no.
3432 The bool_lax{} condition matches the Router logic, which is much more
3435 case ECOND_BOOL_LAX:
3441 BOOL boolvalue = FALSE;
3443 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3444 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3445 switch(read_subs(sub_arg, 1, 1, &s,
3446 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, ourname, resetok, NULL))
3448 case 1: expand_string_message = string_sprintf(
3449 "too few arguments or bracketing error for %s",
3453 case 3: return NULL;
3456 Uskip_whitespace(&t);
3457 if ((len = Ustrlen(t)))
3459 /* trailing whitespace: seems like a good idea to ignore it too */
3461 while (isspace(*t2)) t2--;
3462 if (t2 != (t + len))
3469 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3470 /* logic for the lax case from expand_check_condition(), which also does
3471 expands, and the logic is both short and stable enough that there should
3472 be no maintenance burden from replicating it. */
3476 ? Ustrspn(t+1, "0123456789") == len-1
3477 : Ustrspn(t, "0123456789") == len)
3479 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3480 /* expand_check_condition only does a literal string "0" check */
3481 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3484 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3486 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3488 else if (cond_type == ECOND_BOOL_LAX)
3492 expand_string_message = string_sprintf("unrecognised boolean "
3496 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3497 boolvalue? "true":"false");
3498 if (yield) *yield = (boolvalue == testfor);
3503 case ECOND_INBOUND_SRS:
3504 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */
3507 const pcre2_code * re;
3508 pcre2_match_data * md;
3512 BOOL boolvalue = FALSE;
3514 switch(read_subs(sub, 2, 2, CUSS &s,
3515 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, name, resetok, NULL))
3517 case 1: expand_string_message = US"too few arguments or bracketing "
3518 "error for inbound_srs";
3520 case 3: return NULL;
3523 /* Match the given local_part against the SRS-encoded pattern */
3525 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]+)=([^=]*)=(.*)$",
3526 MCS_CASELESS | MCS_CACHEABLE, FALSE);
3527 md = pcre2_match_data_create(4+1, pcre_gen_ctx);
3528 if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,
3529 md, pcre_gen_mtc_ctx) < 0)
3531 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3534 ovec = pcre2_get_ovector_pointer(md);
3536 if (sub[0][0] == '"')
3538 else for (uschar * s = sub[0]; *s; s++)
3539 if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3540 { quoting = 1; break; }
3542 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3544 /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3546 srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S", /* lowercased */
3548 (int) (ovec[9]-ovec[8]), sub[0] + ovec[8], /* substr 4 */
3550 (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */
3552 /* If a zero-length secret was given, we're done. Otherwise carry on
3553 and validate the given SRS local_part againt our secret. */
3561 /* check the timestamp */
3564 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3568 gettimeofday(&now, NULL);
3569 now.tv_sec /= 86400; /* days since epoch */
3571 /* Decode substring 2 from base32 to a number */
3573 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3575 uschar * t = Ustrchr(base32_chars, *ss++);
3576 d = d * 32 + (t - base32_chars);
3579 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3581 DEBUG(D_expand) debug_printf("SRS too old\n");
3586 /* check length of substring 1, the offered checksum */
3588 if (ovec[3]-ovec[2] != 4)
3590 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3594 /* Hash the address with our secret, and compare that computed checksum
3595 with the one extracted from the arg */
3597 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3598 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3600 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3606 /* pcre2_match_data_free(md); gen ctx needs no free */
3607 if (yield) *yield = (boolvalue == testfor);
3610 #endif /*SUPPORT_SRS*/
3612 /* Unknown condition */
3615 if (!expand_string_message || !*expand_string_message)
3616 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3618 } /* End switch on condition type */
3620 /* Missing braces at start and end of data */
3622 COND_FAILED_CURLY_START:
3623 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3626 COND_FAILED_CURLY_END:
3627 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3631 /* A condition requires code that is not compiled */
3633 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3634 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3635 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3636 COND_FAILED_NOT_COMPILED:
3637 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3646 /*************************************************
3647 * Save numerical variables *
3648 *************************************************/
3650 /* This function is called from items such as "if" that want to preserve and
3651 restore the numbered variables.
3654 save_expand_string points to an array of pointers to set
3655 save_expand_nlength points to an array of ints for the lengths
3657 Returns: the value of expand max to save
3661 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3663 for (int i = 0; i <= expand_nmax; i++)
3665 save_expand_nstring[i] = expand_nstring[i];
3666 save_expand_nlength[i] = expand_nlength[i];
3673 /*************************************************
3674 * Restore numerical variables *
3675 *************************************************/
3677 /* This function restored saved values of numerical strings.
3680 save_expand_nmax the number of strings to restore
3681 save_expand_string points to an array of pointers
3682 save_expand_nlength points to an array of ints
3688 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3689 int *save_expand_nlength)
3691 expand_nmax = save_expand_nmax;
3692 for (int i = 0; i <= expand_nmax; i++)
3694 expand_nstring[i] = save_expand_nstring[i];
3695 expand_nlength[i] = save_expand_nlength[i];
3703 /*************************************************
3704 * Handle yes/no substrings *
3705 *************************************************/
3707 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3708 alternative substrings that depend on whether or not the condition was true,
3709 or the lookup or extraction succeeded. The substrings always have to be
3710 expanded, to check their syntax, but "skipping" is set when the result is not
3711 needed - this avoids unnecessary nested lookups.
3715 skipping TRUE if we were skipping when this item was reached
3716 yes TRUE if the first string is to be used, else use the second
3717 save_lookup a value to put back into lookup_value before the 2nd expansion
3718 sptr points to the input string pointer
3719 yieldptr points to the output growable-string pointer
3720 type "lookup", "if", "extract", "run", "env", "listextract" or
3721 "certextract" for error message
3722 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3725 Returns: 0 OK; lookup_value has been reset to save_lookup
3727 2 expansion failed because of bracketing error
3731 process_yesno(esi_flags flags, BOOL yes, uschar *save_lookup, const uschar **sptr,
3732 gstring ** yieldptr, uschar *type, BOOL *resetok)
3735 const uschar *s = *sptr; /* Local value */
3736 uschar *sub1, *sub2;
3737 const uschar * errwhere;
3739 flags &= ESI_SKIPPING; /* Ignore all buf the skipping flag */
3741 /* If there are no following strings, we substitute the contents of $value for
3742 lookups and for extractions in the success case. For the ${if item, the string
3743 "true" is substituted. In the fail case, nothing is substituted for all three
3746 if (skip_whitespace(&s) == '}')
3750 if (yes && !(flags & ESI_SKIPPING))
3751 *yieldptr = string_catn(*yieldptr, US"true", 4);
3755 if (yes && lookup_value && !(flags & ESI_SKIPPING))
3756 *yieldptr = string_cat(*yieldptr, lookup_value);
3757 lookup_value = save_lookup;
3763 /* The first following string must be braced. */
3767 errwhere = US"'yes' part did not start with '{'"; /*}}*/
3771 /* Expand the first substring. Forced failures are noticed only if we actually
3772 want this string. Set skipping in the call in the fail case (this will always
3773 be the case if we were already skipping). */
3775 sub1 = expand_string_internal(s,
3776 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yes ? ESI_NOFLAGS : ESI_SKIPPING),
3778 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3779 f.expand_string_forcedfail = FALSE;
3783 errwhere = US"'yes' part did not end with '}'";
3787 /* If we want the first string, add it to the output */
3790 *yieldptr = string_cat(*yieldptr, sub1);
3792 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3793 $value to what it was at the start of the item, so that it has this value
3794 during the second string expansion. For the call from "if" or "run" to this
3795 function, save_lookup is set to lookup_value, so that this statement does
3798 lookup_value = save_lookup;
3800 /* There now follows either another substring, or "fail", or nothing. This
3801 time, forced failures are noticed only if we want the second string. We must
3802 set skipping in the nested call if we don't want this string, or if we were
3803 already skipping. */
3805 if (skip_whitespace(&s) == '{') /*}*/
3807 esi_flags s_flags = ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags;
3808 if (yes) s_flags |= ESI_SKIPPING;
3809 sub2 = expand_string_internal(s+1, s_flags, &s, resetok, NULL);
3810 if (!sub2 && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3811 f.expand_string_forcedfail = FALSE; /*{*/
3814 errwhere = US"'no' part did not start with '{'"; /*}*/
3818 /* If we want the second string, add it to the output */
3821 *yieldptr = string_cat(*yieldptr, sub2);
3824 /* If there is no second string, but the word "fail" is present when the use of
3825 the second string is wanted, set a flag indicating it was a forced failure
3826 rather than a syntactic error. Swallow the terminating } in case this is nested
3827 inside another lookup or if or extract. */
3832 /* deconst cast ok here as source is s anyway */
3833 s = US read_name(name, sizeof(name), s, US"_");
3834 if (Ustrcmp(name, "fail") == 0)
3836 if (!yes && !(flags & ESI_SKIPPING))
3838 Uskip_whitespace(&s); /*{{*/
3841 errwhere = US"did not close with '}' after forcedfail";
3844 expand_string_message =
3845 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3846 f.expand_string_forcedfail = TRUE;
3852 expand_string_message =
3853 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3858 /* All we have to do now is to check on the final closing brace. */
3860 skip_whitespace(&s); /*{{*/
3863 errwhere = US"did not close with '}'";
3869 /* Update the input pointer value before returning */
3874 /* Get here if there is a bracketing failure */
3875 expand_string_message = string_sprintf(
3876 "curly-bracket problem in conditional yes/no parsing: %s\n"
3877 " remaining string is '%s'", errwhere, --s);
3882 /* Get here for other failures */
3890 /********************************************************
3891 * prvs: Get last three digits of days since Jan 1, 1970 *
3892 ********************************************************/
3894 /* This is needed to implement the "prvs" BATV reverse
3897 Argument: integer "days" offset to add or substract to
3898 or from the current number of days.
3900 Returns: pointer to string containing the last three
3901 digits of the number of days since Jan 1, 1970,
3902 modified by the offset argument, NULL if there
3903 was an error in the conversion.
3908 prvs_daystamp(int day_offset)
3910 uschar * days = store_get(32, GET_UNTAINTED); /* Need at least 24 for cases */
3911 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3912 (time(NULL) + day_offset*86400)/86400);
3913 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3918 /********************************************************
3919 * prvs: perform HMAC-SHA1 computation of prvs bits *
3920 ********************************************************/
3922 /* This is needed to implement the "prvs" BATV reverse
3926 address RFC2821 Address to use
3927 key The key to use (must be less than 64 characters
3929 key_num Single-digit key number to use. Defaults to
3932 Returns: pointer to string containing the first three
3933 bytes of the final hash in hex format, NULL if
3934 there was an error in the process.
3938 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3940 gstring * hash_source;
3943 uschar innerhash[20];
3944 uschar finalhash[20];
3945 uschar innerkey[64];
3946 uschar outerkey[64];
3947 uschar *finalhash_hex;
3952 if (Ustrlen(key) > 64)
3955 hash_source = string_catn(NULL, key_num, 1);
3956 hash_source = string_catn(hash_source, daystamp, 3);
3957 hash_source = string_cat(hash_source, address);
3958 (void) string_from_gstring(hash_source);
3961 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3963 memset(innerkey, 0x36, 64);
3964 memset(outerkey, 0x5c, 64);
3966 for (int i = 0; i < Ustrlen(key); i++)
3968 innerkey[i] ^= key[i];
3969 outerkey[i] ^= key[i];
3972 chash_start(HMAC_SHA1, &h);
3973 chash_mid(HMAC_SHA1, &h, innerkey);
3974 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3976 chash_start(HMAC_SHA1, &h);
3977 chash_mid(HMAC_SHA1, &h, outerkey);
3978 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3980 /* Hashing is deemed sufficient to de-taint any input data */
3982 p = finalhash_hex = store_get(40, GET_UNTAINTED);
3983 for (int i = 0; i < 3; i++)
3985 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3986 *p++ = hex_digits[finalhash[i] & 0x0f];
3990 return finalhash_hex;
3996 /*************************************************
3997 * Join a file onto the output string *
3998 *************************************************/
4000 /* This is used for readfile/readsock and after a run expansion.
4001 It joins the contents of a file onto the output string, globally replacing
4002 newlines with a given string (optionally).
4006 yield pointer to the expandable string struct
4007 eol newline replacement string, or NULL
4009 Returns: new pointer for expandable string, terminated if non-null
4013 cat_file(FILE * f, gstring * yield, uschar * eol)
4015 uschar buffer[1024];
4017 while (Ufgets(buffer, sizeof(buffer), f))
4019 int len = Ustrlen(buffer);
4020 if (eol && buffer[len-1] == '\n') len--;
4021 yield = string_catn(yield, buffer, len);
4022 if (eol && buffer[len])
4023 yield = string_cat(yield, eol);
4031 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
4034 uschar buffer[1024];
4036 /*XXX could we read direct into a pre-grown string? */
4038 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
4039 for (uschar * s = buffer; rc--; s++)
4040 yield = eol && *s == '\n'
4041 ? string_cat(yield, eol) : string_catn(yield, s, 1);
4043 /* We assume that all errors, and any returns of zero bytes,
4044 are actually EOF. */
4051 /*************************************************
4052 * Evaluate numeric expression *
4053 *************************************************/
4055 /* This is a set of mutually recursive functions that evaluate an arithmetic
4056 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
4057 these functions that is called from elsewhere is eval_expr, whose interface is:
4060 sptr pointer to the pointer to the string - gets updated
4061 decimal TRUE if numbers are to be assumed decimal
4062 error pointer to where to put an error message - must be NULL on input
4063 endket TRUE if ')' must terminate - FALSE for external call
4065 Returns: on success: the value of the expression, with *error still NULL
4066 on failure: an undefined value, with *error = a message
4069 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4072 static int_eximarith_t
4073 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4076 int_eximarith_t x = eval_op_or(&s, decimal, error);
4081 *error = US"expecting closing parenthesis";
4083 while (isspace(*++s));
4085 *error = US"expecting operator";
4091 static int_eximarith_t
4092 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4098 if (isdigit((c = Uskip_whitespace(&s))))
4101 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4103 switch (tolower(*s))
4106 case 'k': n *= 1024; s++; break;
4107 case 'm': n *= 1024*1024; s++; break;
4108 case 'g': n *= 1024*1024*1024; s++; break;
4110 Uskip_whitespace(&s);
4115 n = eval_expr(&s, decimal, error, 1);
4119 *error = US"expecting number or opening parenthesis";
4127 static int_eximarith_t
4128 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4132 Uskip_whitespace(&s);
4133 if (*s == '+' || *s == '-' || *s == '~')
4136 x = eval_op_unary(&s, decimal, error);
4137 if (op == '-') x = -x;
4138 else if (op == '~') x = ~x;
4141 x = eval_number(&s, decimal, error);
4148 static int_eximarith_t
4149 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4152 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4155 while (*s == '*' || *s == '/' || *s == '%')
4158 int_eximarith_t y = eval_op_unary(&s, decimal, error);
4160 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4161 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4162 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4163 * -N*M is INT_MIN will yield INT_MIN.
4164 * Since we don't support floating point, this is somewhat simpler.
4165 * Ideally, we'd return an error, but since we overflow for all other
4166 * arithmetic, consistency suggests otherwise, but what's the correct value
4167 * to use? There is none.
4168 * The C standard guarantees overflow for unsigned arithmetic but signed
4169 * overflow invokes undefined behaviour; in practice, this is overflow
4170 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4171 * that long/longlong larger than int are available, or we could just work
4172 * with larger types. We should consider whether to guarantee 32bit eval
4173 * and 64-bit working variables, with errors returned. For now ...
4174 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4175 * can just let the other invalid results occur otherwise, as they have
4176 * until now. For this one case, we can coerce.
4178 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4181 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4182 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4192 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4208 static int_eximarith_t
4209 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4212 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4215 while (*s == '+' || *s == '-')
4218 int_eximarith_t y = eval_op_mult(&s, decimal, error);
4220 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4221 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4222 { /* over-conservative check */
4224 ? US"overflow in sum" : US"overflow in difference";
4227 if (op == '+') x += y; else x -= y;
4235 static int_eximarith_t
4236 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4239 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4242 while ((*s == '<' || *s == '>') && s[1] == s[0])
4247 y = eval_op_sum(&s, decimal, error);
4249 if (op == '<') x <<= y; else x >>= y;
4257 static int_eximarith_t
4258 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4261 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4268 y = eval_op_shift(&s, decimal, error);
4278 static int_eximarith_t
4279 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4282 int_eximarith_t x = eval_op_and(&s, decimal, error);
4289 y = eval_op_and(&s, decimal, error);
4299 static int_eximarith_t
4300 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4303 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4310 y = eval_op_xor(&s, decimal, error);
4321 /************************************************/
4322 /* Comparison operation for sort expansion. We need to avoid
4323 re-expanding the fields being compared, so need a custom routine.
4326 cond_type Comparison operator code
4327 leftarg, rightarg Arguments for comparison
4329 Return true iff (leftarg compare rightarg)
4333 sortsbefore(int cond_type, BOOL alpha_cond,
4334 const uschar * leftarg, const uschar * rightarg)
4336 int_eximarith_t l_num, r_num;
4340 l_num = expanded_string_integer(leftarg, FALSE);
4341 if (expand_string_message) return FALSE;
4342 r_num = expanded_string_integer(rightarg, FALSE);
4343 if (expand_string_message) return FALSE;
4347 case ECOND_NUM_G: return l_num > r_num;
4348 case ECOND_NUM_GE: return l_num >= r_num;
4349 case ECOND_NUM_L: return l_num < r_num;
4350 case ECOND_NUM_LE: return l_num <= r_num;
4357 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4358 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4359 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4360 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4361 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4362 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4363 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4364 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4367 return FALSE; /* should not happen */
4371 /* Expand a named list. Return false on failure. */
4373 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4375 tree_node *t = NULL;
4376 const uschar * list;
4379 BOOL needsep = FALSE;
4380 #define LISTNAMED_BUF_SIZE 256
4381 uschar b[LISTNAMED_BUF_SIZE];
4382 uschar * buffer = b;
4384 if (*name == '+') name++;
4385 if (!listtype) /* no-argument version */
4387 if ( !(t = tree_search(addresslist_anchor, name))
4388 && !(t = tree_search(domainlist_anchor, name))
4389 && !(t = tree_search(hostlist_anchor, name)))
4390 t = tree_search(localpartlist_anchor, name);
4392 else switch(*listtype) /* specific list-type version */
4394 case 'a': t = tree_search(addresslist_anchor, name); break;
4395 case 'd': t = tree_search(domainlist_anchor, name); break;
4396 case 'h': t = tree_search(hostlist_anchor, name); break;
4397 case 'l': t = tree_search(localpartlist_anchor, name); break;
4399 expand_string_message = US"bad suffix on \"list\" operator";
4405 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4407 : *listtype=='a'?"address "
4408 : *listtype=='d'?"domain "
4409 : *listtype=='h'?"host "
4410 : *listtype=='l'?"localpart "
4415 list = ((namedlist_block *)(t->data.ptr))->string;
4417 /* The list could be quite long so we (re)use a buffer for each element
4418 rather than getting each in new memory */
4420 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, GET_TAINTED);
4421 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4423 uschar * buf = US" : ";
4425 yield = string_catn(yield, buf, 3);
4429 if (*item == '+') /* list item is itself a named list */
4431 yield = expand_listnamed(yield, item, listtype);
4432 if (expand_string_message)
4436 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
4439 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4441 for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4443 yield = string_catn(yield, item, cp - CS item);
4444 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4445 yield = string_catn(yield, US"::", 2);
4446 else /* sep in item; should already be doubled; emit once */
4448 yield = string_catn(yield, US tok, 1);
4449 if (*cp == sep) cp++;
4452 yield = string_cat(yield, item);
4455 yield = string_cat(yield, item);
4462 /************************************************/
4464 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4468 debug_printf_indent("|");
4470 debug_printf_indent(UTF8_VERT_RIGHT);
4472 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4476 debug_printf(UTF8_HORIZ);
4478 debug_printf("%s: %.*s\n", what, nchar, value);
4479 if (is_tainted(value))
4482 debug_printf_indent("%s \\__", skipping ? "| " : " ");
4484 debug_printf_indent("%s",
4486 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
4487 debug_printf("(tainted)\n");
4492 /*************************************************
4494 *************************************************/
4496 /* Returns either an unchanged string, or the expanded string in stacking pool
4497 store. Interpreted sequences are:
4499 \... normal escaping rules
4500 $name substitutes the variable
4502 ${op:string} operates on the expanded string value
4503 ${item{arg1}{arg2}...} expands the args and then does the business
4504 some literal args are not enclosed in {}
4506 There are now far too many operators and item types to make it worth listing
4507 them here in detail any more.
4509 We use an internal routine recursively to handle embedded substrings. The
4510 external function follows. The yield is NULL if the expansion failed, and there
4511 are two cases: if something collapsed syntactically, or if "fail" was given
4512 as the action on a lookup failure. These can be distinguished by looking at the
4513 variable expand_string_forcedfail, which is TRUE in the latter case.
4515 The skipping flag is set true when expanding a substring that isn't actually
4516 going to be used (after "if" or "lookup") and it prevents lookups from
4517 happening lower down.
4519 Store usage: At start, a store block of the length of the input plus 64
4520 is obtained. This is expanded as necessary by string_cat(), which might have to
4521 get a new block, or might be able to expand the original. At the end of the
4522 function we can release any store above that portion of the yield block that
4523 was actually used. In many cases this will be optimal.
4525 However: if the first item in the expansion is a variable name or header name,
4526 we reset the store before processing it; if the result is in fresh store, we
4527 use that without copying. This is helpful for expanding strings like
4528 $message_headers which can get very long.
4530 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4531 since resetting the store at the end of the expansion will free store that was
4532 allocated by the plugin code as well as the slop after the expanded string. So
4533 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4534 and, given the acl condition, ${if }. This is an unfortunate consequence of
4535 string expansion becoming too powerful.
4538 string the string to be expanded
4540 brace_ends expansion is to stop at }
4541 honour_dollar TRUE if $ is to be expanded,
4542 FALSE if it's just another character
4543 skipping TRUE for recursive calls when the value isn't actually going
4544 to be used (to allow for optimisation)
4545 left if not NULL, a pointer to the first character after the
4546 expansion is placed here (typically used with brace_ends)
4547 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4549 textonly_p if not NULL, pointer to flag - write bool for only-met-text
4551 Returns: NULL if expansion fails:
4552 expand_string_forcedfail is set TRUE if failure was forced
4553 expand_string_message contains a textual error message
4554 a pointer to the expanded string on success
4558 expand_string_internal(const uschar * string, esi_flags flags, const uschar ** left,
4559 BOOL *resetok_p, BOOL * textonly_p)
4561 rmark reset_point = store_mark();
4562 gstring * yield = string_get(Ustrlen(string) + 64);
4564 const uschar * s = string;
4565 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4566 int save_expand_nlength[EXPAND_MAXN+1];
4567 BOOL resetok = TRUE, first = TRUE, textonly = TRUE;
4570 f.expand_string_forcedfail = FALSE;
4571 expand_string_message = US"";
4573 if (is_tainted(string))
4575 expand_string_message =
4576 string_sprintf("attempt to expand tainted string '%s'", s);
4577 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4588 debug_printf_indent("%c%s: %s\n",
4590 flags & ESI_SKIPPING ? "---scanning" : "considering", s);
4592 debug_printf_indent("%s%s: %s\n",
4593 first ? UTF8_DOWN_RIGHT : UTF8_VERT_RIGHT,
4594 flags & ESI_SKIPPING
4595 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4601 /* \ escapes the next character, which must exist, or else
4602 the expansion fails. There's a special escape, \N, which causes
4603 copying of the subject verbatim up to the next \N. Otherwise,
4604 the escapes are the standard set. */
4610 expand_string_message = US"\\ at end of string";
4616 const uschar * t = s + 2;
4617 for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4620 debug_expansion_interim(US"protected", t, (int)(s - t), !!(flags & ESI_SKIPPING));
4621 yield = string_catn(yield, t, s - t);
4629 debug_printf_indent("|backslashed: '\\%c'\n", s[1]);
4631 debug_printf_indent(UTF8_VERT_RIGHT "backslashed: '\\%c'\n", s[1]);
4632 ch[0] = string_interpret_escape(&s);
4634 yield = string_catn(yield, ch, 1);
4640 /* Anything other than $ is just copied verbatim, unless we are
4641 looking for a terminating } character. */
4643 if (flags & ESI_BRACE_ENDS && *s == '}') break;
4645 if (*s != '$' || !(flags & ESI_HONOR_DOLLAR))
4648 for (const uschar * t = s+1;
4649 *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4651 DEBUG(D_expand) debug_expansion_interim(US"text", s, i, !!(flags & ESI_SKIPPING));
4653 yield = string_catn(yield, s, i);
4659 /* No { after the $ - must be a plain name or a number for string
4660 match variable. There has to be a fudge for variables that are the
4661 names of header fields preceded by "$header_" because header field
4662 names can contain any printing characters except space and colon.
4663 For those that don't like typing this much, "$h_" is a synonym for
4664 "$header_". A non-existent header yields a NULL value; nothing is
4669 const uschar * value;
4670 int newsize = 0, len;
4674 s = read_name(name, sizeof(name), s, US"_");
4676 /* If this is the first thing to be expanded, release the pre-allocated
4680 g = store_get(sizeof(gstring), GET_UNTAINTED);
4681 else if (yield->ptr == 0)
4683 if (resetok) reset_point = store_reset(reset_point);
4685 reset_point = store_mark();
4686 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
4691 if ( ( *(t = name) == 'h'
4692 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4694 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4697 unsigned flags = *name == 'r' ? FH_WANT_RAW
4698 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4700 const uschar * charset = *name == 'b' ? NULL : headers_charset;
4702 s = read_header_name(name, sizeof(name), s);
4703 value = find_header(name, &newsize, flags, charset);
4705 /* If we didn't find the header, and the header contains a closing brace
4706 character, this may be a user error where the terminating colon
4707 has been omitted. Set a flag to adjust the error message in this case.
4708 But there is no error here - nothing gets inserted. */
4712 if (Ustrchr(name, '}')) malformed_header = TRUE;
4719 else if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
4721 expand_string_message =
4722 string_sprintf("unknown variable name \"%s\"", name);
4723 check_variable_error_message(name);
4727 /* If the data is known to be in a new buffer, newsize will be set to the
4728 size of that buffer. If this is the first thing in an expansion string,
4729 yield will be NULL; just point it at the new store instead of copying. Many
4730 expansion strings contain just one reference, so this is a useful
4731 optimization, especially for humungous headers. We need to use a gstring
4732 structure that is not allocated after that new-buffer, else a later store
4733 reset in the middle of the buffer will make it inaccessible. */
4735 len = Ustrlen(value);
4736 if (!yield && newsize != 0)
4739 yield->size = newsize;
4741 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4744 yield = string_catn(yield, value, len);
4752 s = read_cnumber(&n, s);
4753 if (n >= 0 && n <= expand_nmax)
4754 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4758 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4760 if (*s != '{') /*}*/
4762 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4766 /* After { there can be various things, but they all start with
4767 an initial word, except for a number for a string match variable. */ /*}*/
4772 s = read_cnumber(&n, s); /*{{*/
4775 expand_string_message = US"} expected after number";
4778 if (n >= 0 && n <= expand_nmax)
4779 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4785 expand_string_message = US"letter or digit expected after ${"; /*}*/
4789 /* Allow "-" in names to cater for substrings with negative
4790 arguments. Since we are checking for known names after { this is
4793 s = read_name(name, sizeof(name), s, US"_-");
4794 item_type = chop_match(name, item_table, nelem(item_table));
4796 /* Switch on item type. All nondefault choices should "continue* when
4797 skipping, but "break" otherwise so we get debug output for the item
4800 int start = gstring_length(yield);
4803 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4804 If the ACL returns accept or reject we return content set by "message ="
4805 There is currently no limit on recursion; this would have us call
4806 acl_check_internal() directly and get a current level from somewhere.
4807 See also the acl expansion condition ECOND_ACL and the traditional
4808 acl modifier ACLC_ACL.
4809 Assume that the function has side-effects on the store that must be preserved.
4813 /* ${acl {name} {arg1}{arg2}...} */
4815 uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4819 switch(read_subs(sub, nelem(sub), 1, &s, flags, TRUE, name, &resetok, NULL))
4821 case -1: continue; /* skipping */
4822 case 1: goto EXPAND_FAILED_CURLY;
4824 case 3: goto EXPAND_FAILED;
4828 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4833 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4835 yield = string_cat(yield, user_msg);
4839 f.expand_string_forcedfail = TRUE;
4842 expand_string_message = string_sprintf("%s from acl \"%s\"",
4843 rc_names[rc], sub[0]);
4849 case EITEM_AUTHRESULTS:
4850 /* ${authresults {mysystemname}} */
4852 uschar * sub_arg[1];
4854 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4856 case 1: goto EXPAND_FAILED_CURLY;
4858 case 3: goto EXPAND_FAILED;
4860 /*XXX no skipping-optimisation? */
4862 yield = string_append(yield, 3,
4863 US"Authentication-Results: ", sub_arg[0], US"; none");
4866 yield = authres_local(yield, sub_arg[0]);
4867 yield = authres_iprev(yield);
4868 yield = authres_smtpauth(yield);
4870 yield = authres_spf(yield);
4872 #ifndef DISABLE_DKIM
4873 yield = authres_dkim(yield);
4875 #ifdef SUPPORT_DMARC
4876 yield = authres_dmarc(yield);
4878 #ifdef EXPERIMENTAL_ARC
4879 yield = authres_arc(yield);
4884 /* Handle conditionals - preserve the values of the numerical expansion
4885 variables in case they get changed by a regular expression match in the
4886 condition. If not, they retain their external settings. At the end
4887 of this "if" section, they get restored to their previous values. */
4892 const uschar *next_s;
4893 int save_expand_nmax =
4894 save_expand_strings(save_expand_nstring, save_expand_nlength);
4895 uschar * save_lookup_value = lookup_value;
4897 Uskip_whitespace(&s);
4898 if (!(next_s = eval_condition(s, &resetok, flags & ESI_SKIPPING ? NULL : &cond)))
4899 goto EXPAND_FAILED; /* message already set */
4903 debug_expansion_interim(US"condition", s, (int)(next_s - s), !!(flags & ESI_SKIPPING));
4904 debug_expansion_interim(US"result",
4905 cond ? US"true" : US"false", cond ? 4 : 5, !!(flags & ESI_SKIPPING));
4910 /* The handling of "yes" and "no" result strings is now in a separate
4911 function that is also used by ${lookup} and ${extract} and ${run}. */
4913 switch(process_yesno(
4914 flags, /* were previously skipping */
4915 cond, /* success/failure indicator */
4916 lookup_value, /* value to reset for string2 */
4917 &s, /* input pointer */
4918 &yield, /* output pointer */
4919 US"if", /* condition type */
4922 case 1: goto EXPAND_FAILED; /* when all is well, the */
4923 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4926 /* Restore external setting of expansion variables for continuation
4929 lookup_value = save_lookup_value;
4930 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4931 save_expand_nlength);
4936 case EITEM_IMAPFOLDER:
4937 { /* ${imapfolder {name}{sep}{specials}} */
4941 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4943 case 1: goto EXPAND_FAILED_CURLY;
4945 case 3: goto EXPAND_FAILED;
4947 /*XXX no skipping-optimisation? */
4949 if (!sub_arg[1]) /* One argument */
4951 sub_arg[1] = US"/"; /* default separator */
4954 else if (Ustrlen(sub_arg[1]) != 1)
4956 expand_string_message =
4958 "IMAP folder separator must be one character, found \"%s\"",
4963 if (flags & ESI_SKIPPING) continue;
4965 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4966 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4968 yield = string_cat(yield, encoded);
4973 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4974 expanding an internal string that isn't actually going to be used. All we
4975 need to do is check the syntax, so don't do a lookup at all. Preserve the
4976 values of the numerical expansion variables in case they get changed by a
4977 partial lookup. If not, they retain their external settings. At the end
4978 of this "lookup" section, they get restored to their previous values. */
4982 int stype, partial, affixlen, starflags;
4983 int expand_setup = 0;
4985 uschar * key, * filename;
4986 const uschar * affix, * opts;
4987 uschar * save_lookup_value = lookup_value;
4988 int save_expand_nmax =
4989 save_expand_strings(save_expand_nstring, save_expand_nlength);
4991 if (expand_forbid & RDO_LOOKUP)
4993 expand_string_message = US"lookup expansions are not permitted";
4997 /* Get the key we are to look up for single-key+file style lookups.
4998 Otherwise set the key NULL pro-tem. */
5000 if (Uskip_whitespace(&s) == '{') /*}*/
5002 key = expand_string_internal(s+1,
5003 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
5004 if (!key) goto EXPAND_FAILED; /*{{*/
5007 expand_string_message = US"missing '}' after lookup key";
5008 goto EXPAND_FAILED_CURLY;
5010 Uskip_whitespace(&s);
5014 /* Find out the type of database */
5018 expand_string_message = US"missing lookup type";
5022 /* The type is a string that may contain special characters of various
5023 kinds. Allow everything except space or { to appear; the actual content
5024 is checked by search_findtype_partial. */ /*}*/
5026 while (*s && *s != '{' && !isspace(*s)) /*}*/
5028 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
5031 name[nameptr] = '\0';
5032 Uskip_whitespace(&s);
5034 /* Now check for the individual search type and any partial or default
5035 options. Only those types that are actually in the binary are valid. */
5037 if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
5038 &starflags, &opts)) < 0)
5040 expand_string_message = search_error_message;
5044 /* Check that a key was provided for those lookup types that need it,
5045 and was not supplied for those that use the query style. */
5047 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
5051 expand_string_message = string_sprintf("missing {key} for single-"
5052 "key \"%s\" lookup", name);
5058 expand_string_message = string_sprintf("a single key was given for "
5059 "lookup type \"%s\", which is not a single-key lookup type", name);
5063 /* Get the next string in brackets and expand it. It is the file name for
5064 single-key+file lookups, and the whole query otherwise. In the case of
5065 queries that also require a file name (e.g. sqlite), the file name comes
5070 expand_string_message = US"missing '{' for lookup file-or-query arg";
5071 goto EXPAND_FAILED_CURLY; /*}}*/
5073 if (!(filename = expand_string_internal(s+1,
5074 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5079 expand_string_message = US"missing '}' closing lookup file-or-query arg";
5080 goto EXPAND_FAILED_CURLY;
5082 Uskip_whitespace(&s);
5084 /* If this isn't a single-key+file lookup, re-arrange the variables
5085 to be appropriate for the search_ functions. For query-style lookups,
5086 there is just a "key", and no file name. For the special query-style +
5087 file types, the query (i.e. "key") starts with a file name. */
5090 key = search_args(stype, name, filename, &filename, opts);
5092 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5093 the entry was not found. Note that there is no search_close() function.
5094 Files are left open in case of re-use. At suitable places in higher logic,
5095 search_tidyup() is called to tidy all open files. This can save opening
5096 the same file several times. However, files may also get closed when
5097 others are opened, if too many are open at once. The rule is that a
5098 handle should not be used after a second search_open().
5100 Request that a partial search sets up $1 and maybe $2 by passing
5101 expand_setup containing zero. If its value changes, reset expand_nmax,
5102 since new variables will have been set. Note that at the end of this
5103 "lookup" section, the old numeric variables are restored. */
5105 if (flags & ESI_SKIPPING)
5106 lookup_value = NULL;
5109 void * handle = search_open(filename, stype, 0, NULL, NULL);
5112 expand_string_message = search_error_message;
5115 lookup_value = search_find(handle, filename, key, partial, affix,
5116 affixlen, starflags, &expand_setup, opts);
5117 if (f.search_find_defer)
5119 expand_string_message =
5120 string_sprintf("lookup of \"%s\" gave DEFER: %s",
5121 string_printing2(key, SP_TAB), search_error_message);
5124 if (expand_setup > 0) expand_nmax = expand_setup;
5127 /* The handling of "yes" and "no" result strings is now in a separate
5128 function that is also used by ${if} and ${extract}. */
5130 switch(process_yesno(
5131 flags, /* were previously skipping */
5132 lookup_value != NULL, /* success/failure indicator */
5133 save_lookup_value, /* value to reset for string2 */
5134 &s, /* input pointer */
5135 &yield, /* output pointer */
5136 US"lookup", /* condition type */
5139 case 1: goto EXPAND_FAILED; /* when all is well, the */
5140 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5143 /* Restore external setting of expansion variables for carrying on
5144 at this level, and continue. */
5146 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5147 save_expand_nlength);
5149 if (flags & ESI_SKIPPING) continue;
5153 /* If Perl support is configured, handle calling embedded perl subroutines,
5154 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5155 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5156 arguments (defined below). */
5158 #define EXIM_PERL_MAX_ARGS 8
5162 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
5163 "is not included in this binary";
5166 #else /* EXIM_PERL */
5168 uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5169 gstring * new_yield;
5171 if (expand_forbid & RDO_PERL)
5173 expand_string_message = US"Perl calls are not permitted";
5177 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, flags, TRUE,
5178 name, &resetok, NULL))
5180 case -1: continue; /* If skipping, we don't actually do anything */
5181 case 1: goto EXPAND_FAILED_CURLY;
5183 case 3: goto EXPAND_FAILED;
5186 /* Start the interpreter if necessary */
5188 if (!opt_perl_started)
5191 if (!opt_perl_startup)
5193 expand_string_message = US"A setting of perl_startup is needed when "
5194 "using the Perl interpreter";
5197 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5198 if ((initerror = init_perl(opt_perl_startup)))
5200 expand_string_message =
5201 string_sprintf("error in perl_startup code: %s\n", initerror);
5204 opt_perl_started = TRUE;
5207 /* Call the function */
5209 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5210 new_yield = call_perl_cat(yield, &expand_string_message,
5211 sub_arg[0], sub_arg + 1);
5213 /* NULL yield indicates failure; if the message pointer has been set to
5214 NULL, the yield was undef, indicating a forced failure. Otherwise the
5215 message will indicate some kind of Perl error. */
5219 if (!expand_string_message)
5221 expand_string_message =
5222 string_sprintf("Perl subroutine \"%s\" returned undef to force "
5223 "failure", sub_arg[0]);
5224 f.expand_string_forcedfail = TRUE;
5229 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5230 set during a callback from Perl. */
5232 f.expand_string_forcedfail = FALSE;
5236 #endif /* EXIM_PERL */
5238 /* Transform email address to "prvs" scheme to use
5239 as BATV-signed return path */
5243 uschar * sub_arg[3], * p, * domain;
5245 switch(read_subs(sub_arg, 3, 2, &s, flags, TRUE, name, &resetok, NULL))
5247 case -1: continue; /* If skipping, we don't actually do anything */
5248 case 1: goto EXPAND_FAILED_CURLY;
5250 case 3: goto EXPAND_FAILED;
5253 /* sub_arg[0] is the address */
5254 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
5255 || domain == sub_arg[0] || Ustrlen(domain) == 1)
5257 expand_string_message = US"prvs first argument must be a qualified email address";
5261 /* Calculate the hash. The third argument must be a single-digit
5262 key number, or unset. */
5265 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5267 expand_string_message = US"prvs third argument must be a single digit";
5271 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5274 expand_string_message = US"prvs hmac-sha1 conversion failed";
5278 /* Now separate the domain from the local part */
5281 yield = string_catn(yield, US"prvs=", 5);
5282 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5283 yield = string_catn(yield, prvs_daystamp(7), 3);
5284 yield = string_catn(yield, p, 6);
5285 yield = string_catn(yield, US"=", 1);
5286 yield = string_cat (yield, sub_arg[0]);
5287 yield = string_catn(yield, US"@", 1);
5288 yield = string_cat (yield, domain);
5293 /* Check a prvs-encoded address for validity */
5295 case EITEM_PRVSCHECK:
5297 uschar * sub_arg[3], * p;
5299 const pcre2_code * re;
5301 /* Reset expansion variables */
5302 prvscheck_result = NULL;
5303 prvscheck_address = NULL;
5304 prvscheck_keynum = NULL;
5306 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5308 case 1: goto EXPAND_FAILED_CURLY;
5310 case 3: goto EXPAND_FAILED;
5313 re = regex_must_compile(
5314 US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5315 MCS_CASELESS | MCS_CACHEABLE, FALSE);
5317 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5319 uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5320 uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5321 uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5322 uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5323 uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5327 debug_printf_indent("prvscheck localpart: %s\n", local_part);
5328 debug_printf_indent("prvscheck key number: %s\n", key_num);
5329 debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5330 debug_printf_indent("prvscheck hash: %s\n", hash);
5331 debug_printf_indent("prvscheck domain: %s\n", domain);
5334 /* Set up expansion variables */
5335 g = string_cat (NULL, local_part);
5336 g = string_catn(g, US"@", 1);
5337 g = string_cat (g, domain);
5338 prvscheck_address = string_from_gstring(g);
5339 prvscheck_keynum = string_copy(key_num);
5341 /* Now expand the second argument */
5342 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5344 case 1: goto EXPAND_FAILED_CURLY;
5346 case 3: goto EXPAND_FAILED;
5349 /* Now we have the key and can check the address. */
5351 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5355 expand_string_message = US"hmac-sha1 conversion failed";
5359 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5360 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
5362 if (Ustrcmp(p,hash) == 0)
5364 /* Success, valid BATV address. Now check the expiry date. */
5365 uschar *now = prvs_daystamp(0);
5366 unsigned int inow = 0,iexpire = 1;
5368 (void)sscanf(CS now,"%u",&inow);
5369 (void)sscanf(CS daystamp,"%u",&iexpire);
5371 /* When "iexpire" is < 7, a "flip" has occurred.
5372 Adjust "inow" accordingly. */
5373 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5375 if (iexpire >= inow)
5377 prvscheck_result = US"1";
5378 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
5382 prvscheck_result = NULL;
5383 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
5388 prvscheck_result = NULL;
5389 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
5392 /* Now expand the final argument. We leave this till now so that
5393 it can include $prvscheck_result. */
5395 switch(read_subs(sub_arg, 1, 0, &s, flags, TRUE, name, &resetok, NULL))
5397 case 1: goto EXPAND_FAILED_CURLY;
5399 case 3: goto EXPAND_FAILED;
5402 yield = string_cat(yield,
5403 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5405 /* Reset the "internal" variables afterwards, because they are in
5406 dynamic store that will be reclaimed if the expansion succeeded. */
5408 prvscheck_address = NULL;
5409 prvscheck_keynum = NULL;
5412 /* Does not look like a prvs encoded address, return the empty string.
5413 We need to make sure all subs are expanded first, so as to skip over
5416 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5418 case 1: goto EXPAND_FAILED_CURLY;
5420 case 3: goto EXPAND_FAILED;
5423 if (flags & ESI_SKIPPING) continue;
5427 /* Handle "readfile" to insert an entire file */
5429 case EITEM_READFILE:
5432 uschar * sub_arg[2];
5434 if ((expand_forbid & RDO_READFILE) != 0)
5436 expand_string_message = US"file insertions are not permitted";
5440 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5442 case 1: goto EXPAND_FAILED_CURLY;
5444 case 3: goto EXPAND_FAILED;
5447 /* If skipping, we don't actually do anything */
5449 if (flags & ESI_SKIPPING) continue;
5451 /* Open the file and read it */
5453 if (!(f = Ufopen(sub_arg[0], "rb")))
5455 expand_string_message = string_open_failed("%s", sub_arg[0]);
5459 yield = cat_file(f, yield, sub_arg[1]);
5464 /* Handle "readsocket" to insert data from a socket, either
5465 Inet or Unix domain */
5467 case EITEM_READSOCK:
5470 uschar * sub_arg[4];
5472 if (expand_forbid & RDO_READSOCK)
5474 expand_string_message = US"socket insertions are not permitted";
5478 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5479 because there may be a string for expansion on failure. */
5481 switch(read_subs(sub_arg, 4, 2, &s, flags, FALSE, name, &resetok, NULL))
5483 case 1: goto EXPAND_FAILED_CURLY;
5484 case 2: /* Won't occur: no end check */
5485 case 3: goto EXPAND_FAILED;
5488 /* If skipping, we don't actually do anything. Otherwise, arrange to
5489 connect to either an IP or a Unix socket. */
5491 if (!(flags & ESI_SKIPPING))
5493 int stype = search_findtype(US"readsock", 8);
5496 int expand_setup = -1;
5499 /* If the reqstr is empty, flag that and set a dummy */
5503 g = string_append_listele(g, ',', US"send=no");
5504 sub_arg[1] = US"DUMMY";
5507 /* Re-marshall the options */
5511 const uschar * list = sub_arg[2];
5515 /* First option has no tag and is timeout */
5516 if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5517 g = string_append_listele(g, ',',
5518 string_sprintf("timeout=%s", item));
5520 /* The rest of the options from the expansion */
5521 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5522 g = string_append_listele(g, ',', item);
5524 /* possibly plus an EOL string. Process with escapes, to protect
5525 from list-processing. The only current user of eol= in search
5526 options is the readsock expansion. */
5528 if (sub_arg[3] && *sub_arg[3])
5529 g = string_append_listele(g, ',',
5530 string_sprintf("eol=%s",
5531 string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5534 /* Gat a (possibly cached) handle for the connection */
5536 if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5538 if (*expand_string_message) goto EXPAND_FAILED;
5539 expand_string_message = search_error_message;
5540 search_error_message = NULL;
5544 /* Get (possibly cached) results for the lookup */
5545 /* sspec: sub_arg[0] req: sub_arg[1] opts: g */
5547 if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5548 &expand_setup, string_from_gstring(g))))
5549 yield = string_cat(yield, s);
5550 else if (f.search_find_defer)
5552 expand_string_message = search_error_message;
5553 search_error_message = NULL;
5557 { /* should not happen, at present */
5558 expand_string_message = search_error_message;
5559 search_error_message = NULL;
5564 /* The whole thing has worked (or we were skipping). If there is a
5565 failure string following, we need to skip it. */
5567 if (*s == '{') /*}*/
5569 if (!expand_string_internal(s+1,
5570 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL))
5571 goto EXPAND_FAILED; /*{*/
5574 expand_string_message = US"missing '}' closing failstring for readsocket";
5575 goto EXPAND_FAILED_CURLY;
5577 Uskip_whitespace(&s);
5580 READSOCK_DONE: /*{*/
5583 expand_string_message = US"missing '}' closing readsocket";
5584 goto EXPAND_FAILED_CURLY;
5586 if (flags & ESI_SKIPPING) continue;
5589 /* Come here on failure to create socket, connect socket, write to the
5590 socket, or timeout on reading. If another substring follows, expand and
5591 use it. Otherwise, those conditions give expand errors. */
5594 if (*s != '{') goto EXPAND_FAILED; /*}*/
5595 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5596 if (!(arg = expand_string_internal(s+1,
5597 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR, &s, &resetok, NULL)))
5599 yield = string_cat(yield, arg); /*{*/
5602 expand_string_message = US"missing '}' closing failstring for readsocket";
5603 goto EXPAND_FAILED_CURLY;
5605 Uskip_whitespace(&s);
5609 /* Handle "run" to execute a program. */
5614 const uschar * arg, ** argv;
5615 BOOL late_expand = TRUE;
5617 if (expand_forbid & RDO_RUN)
5619 expand_string_message = US"running a command is not permitted";
5623 /* Handle options to the "run" */
5627 if (Ustrncmp(++s, "preexpand", 9) == 0)
5628 { late_expand = FALSE; s += 9; }
5631 const uschar * t = s;
5632 while (isalpha(*++t)) ;
5633 expand_string_message = string_sprintf("bad option '%.*s' for run",
5638 Uskip_whitespace(&s);
5640 if (*s != '{') /*}*/
5642 expand_string_message = US"missing '{' for command arg of run";
5643 goto EXPAND_FAILED_CURLY; /*"}*/
5647 if (late_expand) /* this is the default case */
5651 /* Locate the end of the args */
5652 (void) expand_string_internal(s,
5653 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &t, NULL, NULL);
5655 arg = flags & ESI_SKIPPING ? NULL : string_copyn(s, n);
5661 debug_printf_indent("args string for ${run} expand before split\n");
5662 if (!(arg = expand_string_internal(s,
5663 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5665 Uskip_whitespace(&s);
5670 expand_string_message = US"missing '}' closing command arg of run";
5671 goto EXPAND_FAILED_CURLY;
5674 if (flags & ESI_SKIPPING) /* Just pretend it worked when we're skipping */
5677 lookup_value = NULL;
5684 if (!transport_set_up_command(&argv, /* anchor for arg list */
5685 arg, /* raw command */
5686 late_expand, /* expand args if not already done */
5687 0, /* not relevant when... */
5688 NULL, /* no transporting address */
5689 late_expand, /* allow tainted args, when expand-after-split */
5690 US"${run} expansion", /* for error messages */
5691 &expand_string_message)) /* where to put error message */
5694 /* Create the child process, making it a group leader. */
5696 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5697 US"expand-run")) < 0)
5699 expand_string_message =
5700 string_sprintf("couldn't create child process: %s", strerror(errno));
5704 /* Nothing is written to the standard input. */
5708 /* Read the pipe to get the command's output into $value (which is kept
5709 in lookup_value). Read during execution, so that if the output exceeds
5710 the OS pipe buffer limit, we don't block forever. Remember to not release
5711 memory just allocated for $value. */
5714 f = fdopen(fd_out, "rb");
5715 sigalrm_seen = FALSE;
5717 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5721 /* Wait for the process to finish, applying the timeout, and inspect its
5722 return code for serious disasters. Simple non-zero returns are passed on.
5725 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5727 if (sigalrm_seen || runrc == -256)
5729 expand_string_message = US"command timed out";
5730 killpg(pid, SIGKILL); /* Kill the whole process group */
5733 else if (runrc == -257)
5734 expand_string_message = string_sprintf("wait() failed: %s",
5738 expand_string_message = string_sprintf("command killed by signal %d",
5745 /* Process the yes/no strings; $value may be useful in both cases */
5747 switch(process_yesno(
5748 flags, /* were previously skipping */
5749 runrc == 0, /* success/failure indicator */
5750 lookup_value, /* value to reset for string2 */
5751 &s, /* input pointer */
5752 &yield, /* output pointer */
5753 US"run", /* condition type */
5756 case 1: goto EXPAND_FAILED; /* when all is well, the */
5757 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5760 if (flags & ESI_SKIPPING) continue;
5764 /* Handle character translation for "tr" */
5768 int oldptr = gstring_length(yield);
5772 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5774 case -1: continue; /* skipping */
5775 case 1: goto EXPAND_FAILED_CURLY;
5777 case 3: goto EXPAND_FAILED;
5780 yield = string_cat(yield, sub[0]);
5781 o2m = Ustrlen(sub[2]) - 1;
5783 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5785 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5789 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5796 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5797 expanded arguments. */
5806 int val[2] = { 0, -1 };
5809 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5810 Ensure that sub[2] is set in the ${length } case. */
5813 switch(read_subs(sub, item_type == EITEM_LENGTH ? 2:3, 2, &s, flags,
5814 TRUE, name, &resetok, NULL))
5816 case -1: continue; /* skipping */
5817 case 1: goto EXPAND_FAILED_CURLY;
5819 case 3: goto EXPAND_FAILED;
5822 /* Juggle the arguments if there are only two of them: always move the
5823 string to the last position and make ${length{n}{str}} equivalent to
5824 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5830 if (item_type == EITEM_LENGTH)
5837 for (int i = 0; i < 2; i++) if (sub[i])
5839 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5840 if (*ret != 0 || (i != 0 && val[i] < 0))
5842 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5843 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5849 item_type == EITEM_HASH
5850 ? compute_hash(sub[2], val[0], val[1], &len)
5851 : item_type == EITEM_NHASH
5852 ? compute_nhash(sub[2], val[0], val[1], &len)
5853 : extract_substr(sub[2], val[0], val[1], &len);
5856 yield = string_catn(yield, ret, len);
5860 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5861 This code originally contributed by Steve Haslam. It currently supports
5862 the use of MD5 and SHA-1 hashes.
5864 We need some workspace that is large enough to handle all the supported
5865 hash types. Use macros to set the sizes rather than be too elaborate. */
5867 #define MAX_HASHLEN 20
5868 #define MAX_HASHBLOCKLEN 64
5877 int hashlen; /* Number of octets for the hash algorithm's output */
5878 int hashblocklen; /* Number of octets the hash algorithm processes */
5879 uschar * keyptr, * p;
5880 unsigned int keylen;
5882 uschar keyhash[MAX_HASHLEN];
5883 uschar innerhash[MAX_HASHLEN];
5884 uschar finalhash[MAX_HASHLEN];
5885 uschar finalhash_hex[2*MAX_HASHLEN];
5886 uschar innerkey[MAX_HASHBLOCKLEN];
5887 uschar outerkey[MAX_HASHBLOCKLEN];
5889 switch (read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5891 case -1: continue; /* skipping */
5892 case 1: goto EXPAND_FAILED_CURLY;
5894 case 3: goto EXPAND_FAILED;
5897 if (Ustrcmp(sub[0], "md5") == 0)
5900 use_base = &md5_base;
5904 else if (Ustrcmp(sub[0], "sha1") == 0)
5907 use_base = &sha1_ctx;
5913 expand_string_message =
5914 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5919 keylen = Ustrlen(keyptr);
5921 /* If the key is longer than the hash block length, then hash the key
5924 if (keylen > hashblocklen)
5926 chash_start(type, use_base);
5927 chash_end(type, use_base, keyptr, keylen, keyhash);
5932 /* Now make the inner and outer key values */
5934 memset(innerkey, 0x36, hashblocklen);
5935 memset(outerkey, 0x5c, hashblocklen);
5937 for (int i = 0; i < keylen; i++)
5939 innerkey[i] ^= keyptr[i];
5940 outerkey[i] ^= keyptr[i];
5943 /* Now do the hashes */
5945 chash_start(type, use_base);
5946 chash_mid(type, use_base, innerkey);
5947 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5949 chash_start(type, use_base);
5950 chash_mid(type, use_base, outerkey);
5951 chash_end(type, use_base, innerhash, hashlen, finalhash);
5953 /* Encode the final hash as a hex string */
5956 for (int i = 0; i < hashlen; i++)
5958 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5959 *p++ = hex_digits[finalhash[i] & 0x0f];
5962 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5963 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5965 yield = string_catn(yield, finalhash_hex, hashlen*2);
5969 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5970 We have to save the numerical variables and restore them afterwards. */
5974 const pcre2_code * re;
5975 int moffset, moffsetextra, slen;
5976 pcre2_match_data * md;
5978 uschar * subject, * sub[3];
5979 int save_expand_nmax =
5980 save_expand_strings(save_expand_nstring, save_expand_nlength);
5981 unsigned sub_textonly = 0;
5983 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, &sub_textonly))
5985 case -1: continue; /* skipping */
5986 case 1: goto EXPAND_FAILED_CURLY;
5988 case 3: goto EXPAND_FAILED;
5991 /* Compile the regular expression */
5993 re = regex_compile(sub[1],
5994 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
5995 &expand_string_message, pcre_gen_cmp_ctx);
5999 md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
6001 /* Now run a loop to do the substitutions as often as necessary. It ends
6002 when there are no more matches. Take care over matches of the null string;
6003 do the same thing as Perl does. */
6006 slen = Ustrlen(sub[0]);
6007 moffset = moffsetextra = 0;
6012 PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
6013 int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
6014 PCRE_EOPT | emptyopt, md, pcre_gen_mtc_ctx);
6017 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
6018 is not necessarily the end. We want to repeat the match from one
6019 character further along, but leaving the basic offset the same (for
6020 copying below). We can't be at the end of the string - that was checked
6021 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
6022 finished; copy the remaining string and end the loop. */
6032 yield = string_catn(yield, subject+moffset, slen-moffset);
6036 /* Match - set up for expanding the replacement. */
6037 DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
6039 if (n == 0) n = EXPAND_MAXN + 1;
6041 for (int nn = 0; nn < n*2; nn += 2)
6043 expand_nstring[expand_nmax] = subject + ovec[nn];
6044 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
6048 /* Copy the characters before the match, plus the expanded insertion. */
6050 yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
6052 if (!(insert = expand_string(sub[2])))
6054 yield = string_cat(yield, insert);
6060 /* If we have matched an empty string, first check to see if we are at
6061 the end of the subject. If so, the loop is over. Otherwise, mimic
6062 what Perl's /g options does. This turns out to be rather cunning. First
6063 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
6064 string at the same point. If this fails (picked up above) we advance to
6065 the next character. */
6067 if (ovec[0] == ovec[1])
6069 if (ovec[0] == slen) break;
6070 emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
6074 /* All done - restore numerical variables. */
6076 /* pcre2_match_data_free(md); gen ctx needs no free */
6077 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6078 save_expand_nlength);
6082 /* Handle keyed and numbered substring extraction. If the first argument
6083 consists entirely of digits, then a numerical extraction is assumed. */
6087 int field_number = 1;
6088 BOOL field_number_set = FALSE;
6089 uschar * save_lookup_value = lookup_value, * sub[3];
6090 int save_expand_nmax =
6091 save_expand_strings(save_expand_nstring, save_expand_nlength);
6093 /* On reflection the original behaviour of extract-json for a string
6094 result, leaving it quoted, was a mistake. But it was already published,
6095 hence the addition of jsons. In a future major version, make json
6096 work like josons, and withdraw jsons. */
6098 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
6100 /* Check for a format-variant specifier */
6102 if (Uskip_whitespace(&s) != '{') /*}*/
6103 if (Ustrncmp(s, "json", 4) == 0)
6104 if (*(s += 4) == 's')
6105 {fmt = extract_jsons; s++;}
6109 /* While skipping we cannot rely on the data for expansions being
6110 available (eg. $item) hence cannot decide on numeric vs. keyed.
6111 Read a maximum of 5 arguments (including the yes/no) */
6113 if (flags & ESI_SKIPPING)
6115 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
6117 if (!expand_string_internal(s+1,
6118 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL))
6119 goto EXPAND_FAILED; /*'{'*/
6122 expand_string_message = US"missing '{' for arg of extract";
6123 goto EXPAND_FAILED_CURLY;
6125 Uskip_whitespace(&s);
6127 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
6128 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
6132 Uskip_whitespace(&s);
6136 expand_string_message = US"missing '}' closing extract";
6137 goto EXPAND_FAILED_CURLY;
6141 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
6143 if (Uskip_whitespace(&s) == '{') /*'}'*/
6145 if (!(sub[i] = expand_string_internal(s+1,
6146 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6147 goto EXPAND_FAILED; /*'{'*/
6150 expand_string_message = string_sprintf(
6151 "missing '}' closing arg %d of extract", i+1);
6152 goto EXPAND_FAILED_CURLY;
6155 /* After removal of leading and trailing white space, the first
6156 argument must not be empty; if it consists entirely of digits
6157 (optionally preceded by a minus sign), this is a numerical
6158 extraction, and we expect 3 arguments (normal) or 2 (json). */
6164 uschar * p = sub[0];
6166 Uskip_whitespace(&p);
6170 while (len > 0 && isspace(p[len-1])) len--;
6175 expand_string_message = US"first argument of \"extract\" must "
6185 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6189 if (fmt == extract_basic) j = 3; /* Need 3 args */
6190 field_number_set = TRUE;
6196 expand_string_message = string_sprintf(
6197 "missing '{' for arg %d of extract", i+1);
6198 goto EXPAND_FAILED_CURLY;
6202 /* Extract either the numbered or the keyed substring into $value. If
6203 skipping, just pretend the extraction failed. */
6205 if (flags & ESI_SKIPPING)
6206 lookup_value = NULL;
6210 lookup_value = field_number_set
6211 ? expand_gettokened(field_number, sub[1], sub[2])
6212 : expand_getkeyed(sub[0], sub[1]);
6219 const uschar * list;
6221 /* Array: Bracket-enclosed and comma-separated.
6222 Object: Brace-enclosed, comma-sep list of name:value pairs */
6224 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6226 expand_string_message =
6227 string_sprintf("%s wrapping %s for extract json",
6228 expand_string_message,
6229 field_number_set ? "array" : "object");
6230 goto EXPAND_FAILED_CURLY;
6234 if (field_number_set)
6236 if (field_number <= 0)
6238 expand_string_message = US"first argument of \"extract\" must "
6239 "be greater than zero";
6242 while (field_number > 0 && (item = json_nextinlist(&list)))
6244 if ((lookup_value = s = item))
6247 while (--s >= lookup_value && isspace(*s)) *s = '\0';
6252 lookup_value = NULL;
6253 while ((item = json_nextinlist(&list)))
6255 /* Item is: string name-sep value. string is quoted.
6256 Dequote the string and compare with the search key. */
6258 if (!(item = dewrap(item, US"\"\"")))
6260 expand_string_message =
6261 string_sprintf("%s wrapping string key for extract json",
6262 expand_string_message);
6263 goto EXPAND_FAILED_CURLY;
6265 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
6267 s = item + Ustrlen(item) + 1;
6268 if (Uskip_whitespace(&s) != ':')
6270 expand_string_message =
6271 US"missing object value-separator for extract json";
6272 goto EXPAND_FAILED_CURLY;
6275 Uskip_whitespace(&s);
6283 if ( fmt == extract_jsons
6285 && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6287 expand_string_message =
6288 string_sprintf("%s wrapping string result for extract jsons",
6289 expand_string_message);
6290 goto EXPAND_FAILED_CURLY;
6295 /* If no string follows, $value gets substituted; otherwise there can
6296 be yes/no strings, as for lookup or if. */
6298 switch(process_yesno(
6299 flags, /* were previously skipping */
6300 lookup_value != NULL, /* success/failure indicator */
6301 save_lookup_value, /* value to reset for string2 */
6302 &s, /* input pointer */
6303 &yield, /* output pointer */
6304 US"extract", /* condition type */
6307 case 1: goto EXPAND_FAILED; /* when all is well, the */
6308 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6311 /* All done - restore numerical variables. */
6313 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6314 save_expand_nlength);
6316 if (flags & ESI_SKIPPING) continue;
6320 /* return the Nth item from a list */
6322 case EITEM_LISTEXTRACT:
6324 int field_number = 1;
6325 uschar * save_lookup_value = lookup_value, * sub[2];
6326 int save_expand_nmax =
6327 save_expand_strings(save_expand_nstring, save_expand_nlength);
6329 /* Read the field & list arguments */
6331 for (int i = 0; i < 2; i++)
6333 if (Uskip_whitespace(&s) != '{') /*}*/
6335 expand_string_message = string_sprintf(
6336 "missing '{' for arg %d of listextract", i+1); /*}*/
6337 goto EXPAND_FAILED_CURLY;
6340 sub[i] = expand_string_internal(s+1,
6341 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6342 if (!sub[i]) goto EXPAND_FAILED; /*{{*/
6345 expand_string_message = string_sprintf(
6346 "missing '}' closing arg %d of listextract", i+1);
6347 goto EXPAND_FAILED_CURLY;
6350 /* After removal of leading and trailing white space, the first
6351 argument must be numeric and nonempty. */
6359 Uskip_whitespace(&p);
6363 while (len > 0 && isspace(p[len-1])) len--;
6366 if (!*p && !(flags & ESI_SKIPPING))
6368 expand_string_message = US"first argument of \"listextract\" must "
6378 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6381 expand_string_message = US"first argument of \"listextract\" must "
6389 /* Extract the numbered element into $value. If
6390 skipping, just pretend the extraction failed. */
6392 lookup_value = flags & ESI_SKIPPING ? NULL : expand_getlistele(field_number, sub[1]);
6394 /* If no string follows, $value gets substituted; otherwise there can
6395 be yes/no strings, as for lookup or if. */
6397 switch(process_yesno(
6398 flags, /* were previously skipping */
6399 lookup_value != NULL, /* success/failure indicator */
6400 save_lookup_value, /* value to reset for string2 */
6401 &s, /* input pointer */
6402 &yield, /* output pointer */
6403 US"listextract", /* condition type */
6406 case 1: goto EXPAND_FAILED; /* when all is well, the */
6407 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6410 /* All done - restore numerical variables. */
6412 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6413 save_expand_nlength);
6415 if (flags & ESI_SKIPPING) continue;
6419 case EITEM_LISTQUOTE:
6422 switch(read_subs(sub, 2, 2, &s, flags, TRUE, name, &resetok, NULL))
6424 case -1: continue; /* skipping */
6425 case 1: goto EXPAND_FAILED_CURLY;
6427 case 3: goto EXPAND_FAILED;
6429 if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6431 if (c == sep) yield = string_catn(yield, sub[1], 1);
6432 yield = string_catn(yield, sub[1], 1);
6434 else yield = string_catn(yield, US" ", 1);
6439 case EITEM_CERTEXTRACT:
6441 uschar * save_lookup_value = lookup_value, * sub[2];
6442 int save_expand_nmax =
6443 save_expand_strings(save_expand_nstring, save_expand_nlength);
6445 /* Read the field argument */
6446 if (Uskip_whitespace(&s) != '{') /*}*/
6448 expand_string_message = US"missing '{' for field arg of certextract";
6449 goto EXPAND_FAILED_CURLY; /*}*/
6451 sub[0] = expand_string_internal(s+1,
6452 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6453 if (!sub[0]) goto EXPAND_FAILED; /*{{*/
6456 expand_string_message = US"missing '}' closing field arg of certextract";
6457 goto EXPAND_FAILED_CURLY;
6459 /* strip spaces fore & aft */
6464 Uskip_whitespace(&p);
6468 while (len > 0 && isspace(p[len-1])) len--;
6472 /* inspect the cert argument */
6473 if (Uskip_whitespace(&s) != '{') /*}*/
6475 expand_string_message = US"missing '{' for cert variable arg of certextract";
6476 goto EXPAND_FAILED_CURLY; /*}*/
6480 expand_string_message = US"second argument of \"certextract\" must "
6481 "be a certificate variable";
6484 sub[1] = expand_string_internal(s+1,
6485 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6486 if (!sub[1]) goto EXPAND_FAILED; /*{{*/
6489 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6490 goto EXPAND_FAILED_CURLY;
6493 if (flags & ESI_SKIPPING)
6494 lookup_value = NULL;
6497 lookup_value = expand_getcertele(sub[0], sub[1]);
6498 if (*expand_string_message) goto EXPAND_FAILED;
6500 switch(process_yesno(
6501 flags, /* were previously skipping */
6502 lookup_value != NULL, /* success/failure indicator */
6503 save_lookup_value, /* value to reset for string2 */
6504 &s, /* input pointer */
6505 &yield, /* output pointer */
6506 US"certextract", /* condition type */
6509 case 1: goto EXPAND_FAILED; /* when all is well, the */
6510 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6513 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6514 save_expand_nlength);
6515 if (flags & ESI_SKIPPING) continue;
6518 #endif /*DISABLE_TLS*/
6520 /* Handle list operations */
6526 int sep = 0, save_ptr = gstring_length(yield);
6527 uschar outsep[2] = { '\0', '\0' };
6528 const uschar *list, *expr, *temp;
6529 uschar * save_iterate_item = iterate_item;
6530 uschar * save_lookup_value = lookup_value;
6532 Uskip_whitespace(&s);
6533 if (*s++ != '{') /*}*/
6535 expand_string_message =
6536 string_sprintf("missing '{' for first arg of %s", name);
6537 goto EXPAND_FAILED_CURLY; /*}*/
6540 if (!(list = expand_string_internal(s,
6541 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6542 goto EXPAND_FAILED; /*{{*/
6545 expand_string_message =
6546 string_sprintf("missing '}' closing first arg of %s", name);
6547 goto EXPAND_FAILED_CURLY;
6550 if (item_type == EITEM_REDUCE)
6553 Uskip_whitespace(&s);
6554 if (*s++ != '{') /*}*/
6556 expand_string_message = US"missing '{' for second arg of reduce";
6557 goto EXPAND_FAILED_CURLY; /*}*/
6559 t = expand_string_internal(s,
6560 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6561 if (!t) goto EXPAND_FAILED;
6562 lookup_value = t; /*{{*/
6565 expand_string_message = US"missing '}' closing second arg of reduce";
6566 goto EXPAND_FAILED_CURLY;
6570 Uskip_whitespace(&s);
6571 if (*s++ != '{') /*}*/
6573 expand_string_message =
6574 string_sprintf("missing '{' for last arg of %s", name); /*}*/
6575 goto EXPAND_FAILED_CURLY;
6580 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6581 if scanning a "false" part). This allows us to find the end of the
6582 condition, because if the list is empty, we won't actually evaluate the
6583 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6584 the normal internal expansion function. */
6586 if (item_type != EITEM_FILTER)
6587 temp = expand_string_internal(s,
6588 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL);
6590 if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6594 expand_string_message = string_sprintf("%s inside \"%s\" item",
6595 expand_string_message, name);
6599 Uskip_whitespace(&s); /*{{{*/
6602 expand_string_message = string_sprintf("missing } at end of condition "
6603 "or expression inside \"%s\"; could be an unquoted } in the content",
6608 Uskip_whitespace(&s); /*{{*/
6611 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6616 /* If we are skipping, we can now just move on to the next item. When
6617 processing for real, we perform the iteration. */
6619 if (flags & ESI_SKIPPING) continue;
6620 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6622 *outsep = (uschar)sep; /* Separator as a string */
6624 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6625 name, iterate_item, lookup_value);
6627 if (item_type == EITEM_FILTER)
6630 /* the condition could modify $value, as a side-effect */
6631 uschar * save_value = lookup_value;
6633 if (!eval_condition(expr, &resetok, &condresult))
6635 iterate_item = save_iterate_item;
6636 lookup_value = save_lookup_value;
6637 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6638 expand_string_message, name);
6641 lookup_value = save_value;
6642 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6643 condresult? "true":"false");
6645 temp = iterate_item; /* TRUE => include this item */
6647 continue; /* FALSE => skip this item */
6650 else /* EITEM_MAP and EITEM_REDUCE */
6652 /* the expansion could modify $value, as a side-effect */
6653 uschar * t = expand_string_internal(expr,
6654 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, NULL, &resetok, NULL);
6657 iterate_item = save_iterate_item;
6658 expand_string_message = string_sprintf("%s inside \"%s\" item",
6659 expand_string_message, name);
6662 if (item_type == EITEM_REDUCE)
6664 lookup_value = t; /* Update the value of $value */
6665 continue; /* and continue the iteration */
6669 /* We reach here for FILTER if the condition is true, always for MAP,
6670 and never for REDUCE. The value in "temp" is to be added to the output
6671 list that is being created, ensuring that any occurrences of the
6672 separator character are doubled. Unless we are dealing with the first
6673 item of the output list, add in a space if the new item begins with the
6674 separator character, or is an empty string. */
6676 /*XXX is there not a standard support function for this, appending to a list? */
6677 /* yes, string_append_listele(), but it depends on lack of text before the list */
6679 if ( yield && yield->ptr != save_ptr
6680 && (temp[0] == *outsep || temp[0] == 0))
6681 yield = string_catn(yield, US" ", 1);
6683 /* Add the string in "temp" to the output list that we are building,
6684 This is done in chunks by searching for the separator character. */
6688 size_t seglen = Ustrcspn(temp, outsep);
6690 yield = string_catn(yield, temp, seglen + 1);
6692 /* If we got to the end of the string we output one character
6693 too many; backup and end the loop. Otherwise arrange to double the
6696 if (!temp[seglen]) { yield->ptr--; break; }
6697 yield = string_catn(yield, outsep, 1);
6701 /* Output a separator after the string: we will remove the redundant
6702 final one at the end. */
6704 yield = string_catn(yield, outsep, 1);
6705 } /* End of iteration over the list loop */
6707 /* REDUCE has generated no output above: output the final value of
6710 if (item_type == EITEM_REDUCE)
6712 yield = string_cat(yield, lookup_value);
6713 lookup_value = save_lookup_value; /* Restore $value */
6716 /* FILTER and MAP generate lists: if they have generated anything, remove
6717 the redundant final separator. Even though an empty item at the end of a
6718 list does not count, this is tidier. */
6720 else if (yield && yield->ptr != save_ptr) yield->ptr--;
6722 /* Restore preserved $item */
6724 iterate_item = save_iterate_item;
6725 if (flags & ESI_SKIPPING) continue;
6731 int sep = 0, cond_type;
6732 const uschar * srclist, * cmp, * xtract;
6733 uschar * opname, * srcitem;
6734 const uschar * dstlist = NULL, * dstkeylist = NULL;
6735 uschar * tmp, * save_iterate_item = iterate_item;
6737 Uskip_whitespace(&s);
6738 if (*s++ != '{') /*}*/
6740 expand_string_message = US"missing '{' for list arg of sort";
6741 goto EXPAND_FAILED_CURLY; /*}*/
6744 srclist = expand_string_internal(s,
6745 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6746 if (!srclist) goto EXPAND_FAILED; /*{{*/
6749 expand_string_message = US"missing '}' closing list arg of sort";
6750 goto EXPAND_FAILED_CURLY;
6753 Uskip_whitespace(&s);
6754 if (*s++ != '{') /*}*/
6756 expand_string_message = US"missing '{' for comparator arg of sort";
6757 goto EXPAND_FAILED_CURLY; /*}*/
6760 cmp = expand_string_internal(s,
6761 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6762 if (!cmp) goto EXPAND_FAILED; /*{{*/
6765 expand_string_message = US"missing '}' closing comparator arg of sort";
6766 goto EXPAND_FAILED_CURLY;
6769 if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6771 if (!expand_string_message)
6772 expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6777 case ECOND_NUM_L: case ECOND_NUM_LE:
6778 case ECOND_NUM_G: case ECOND_NUM_GE:
6779 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6780 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6784 expand_string_message = US"comparator not handled for sort";
6788 Uskip_whitespace(&s);
6789 if (*s++ != '{') /*}*/
6791 expand_string_message = US"missing '{' for extractor arg of sort";
6792 goto EXPAND_FAILED_CURLY; /*}*/
6796 if (!(tmp = expand_string_internal(s,
6797 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL)))
6799 xtract = string_copyn(xtract, s - xtract);
6803 expand_string_message = US"missing '}' closing extractor arg of sort";
6804 goto EXPAND_FAILED_CURLY;
6809 expand_string_message = US"missing } at end of \"sort\"";
6813 if (flags & ESI_SKIPPING) continue;
6815 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6817 uschar * srcfield, * dstitem;
6818 gstring * newlist = NULL, * newkeylist = NULL;
6820 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6822 /* extract field for comparisons */
6823 iterate_item = srcitem;
6824 if ( !(srcfield = expand_string_internal(xtract,
6825 ESI_HONOR_DOLLAR, NULL, &resetok, NULL))
6828 expand_string_message = string_sprintf(
6829 "field-extract in sort: \"%s\"", xtract);
6833 /* Insertion sort */
6835 /* copy output list until new-item < list-item */
6836 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6840 /* field for comparison */
6841 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6844 /* String-comparator names start with a letter; numeric names do not */
6846 if (sortsbefore(cond_type, isalpha(opname[0]),
6847 srcfield, dstfield))
6849 /* New-item sorts before this dst-item. Append new-item,
6850 then dst-item, then remainder of dst list. */
6852 newlist = string_append_listele(newlist, sep, srcitem);
6853 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6856 newlist = string_append_listele(newlist, sep, dstitem);
6857 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6859 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */
6860 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6862 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6864 newlist = string_append_listele(newlist, sep, dstitem);
6865 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6871 newlist = string_append_listele(newlist, sep, dstitem);
6872 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6875 /* If we ran out of dstlist without consuming srcitem, append it */
6878 newlist = string_append_listele(newlist, sep, srcitem);
6879 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6882 dstlist = newlist->s;
6883 dstkeylist = newkeylist->s;
6885 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6886 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6890 yield = string_cat(yield, dstlist);
6892 /* Restore preserved $item */
6893 iterate_item = save_iterate_item;
6897 expand_string_message = US"Internal error in sort (list mismatch)";
6902 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6903 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6904 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6905 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6907 #define EXPAND_DLFUNC_MAX_ARGS 8
6910 #ifndef EXPAND_DLFUNC
6911 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6912 "is not included in this binary";
6915 #else /* EXPAND_DLFUNC */
6918 exim_dlfunc_t * func;
6921 uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6923 if (expand_forbid & RDO_DLFUNC)
6925 expand_string_message =
6926 US"dynamically-loaded functions are not permitted";
6930 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, flags,
6931 TRUE, name, &resetok, NULL))
6933 case -1: continue; /* skipping */
6934 case 1: goto EXPAND_FAILED_CURLY;
6936 case 3: goto EXPAND_FAILED;
6939 /* Look up the dynamically loaded object handle in the tree. If it isn't
6940 found, dlopen() the file and put the handle in the tree for next time. */
6942 if (!(t = tree_search(dlobj_anchor, argv[0])))
6944 void * handle = dlopen(CS argv[0], RTLD_LAZY);
6947 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6948 argv[0], dlerror());
6949 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6952 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), argv[0]);
6953 Ustrcpy(t->name, argv[0]);
6954 t->data.ptr = handle;
6955 (void)tree_insertnode(&dlobj_anchor, t);
6958 /* Having obtained the dynamically loaded object handle, look up the
6959 function pointer. */
6961 if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6963 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6964 "%s", argv[1], argv[0], dlerror());
6965 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6969 /* Call the function and work out what to do with the result. If it
6970 returns OK, we have a replacement string; if it returns DEFER then
6971 expansion has failed in a non-forced manner; if it returns FAIL then
6972 failure was forced; if it returns ERROR or any other value there's a
6973 problem, so panic slightly. In any case, assume that the function has
6974 side-effects on the store that must be preserved. */
6978 for (argc = 0; argv[argc]; argc++) ;
6980 if ((status = func(&result, argc - 2, &argv[2])) != OK)
6982 expand_string_message = result ? result : US"(no message)";
6983 if (status == FAIL_FORCED)
6984 f.expand_string_forcedfail = TRUE;
6985 else if (status != FAIL)
6986 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6987 argv[0], argv[1], status, expand_string_message);
6991 if (result) yield = string_cat(yield, result);
6994 #endif /* EXPAND_DLFUNC */
6996 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6999 uschar *save_lookup_value = lookup_value;
7001 if (Uskip_whitespace(&s) != '{') /*}*/
7004 key = expand_string_internal(s+1,
7005 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7006 if (!key) goto EXPAND_FAILED; /*{{*/
7009 expand_string_message = US"missing '}' for name arg of env";
7010 goto EXPAND_FAILED_CURLY;
7013 lookup_value = US getenv(CS key);
7015 switch(process_yesno(
7016 flags, /* were previously skipping */
7017 lookup_value != NULL, /* success/failure indicator */
7018 save_lookup_value, /* value to reset for string2 */
7019 &s, /* input pointer */
7020 &yield, /* output pointer */
7021 US"env", /* condition type */
7024 case 1: goto EXPAND_FAILED; /* when all is well, the */
7025 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
7027 if (flags & ESI_SKIPPING) continue;
7032 case EITEM_SRS_ENCODE:
7033 /* ${srs_encode {secret} {return_path} {orig_domain}} */
7038 BOOL quoted = FALSE;
7040 switch (read_subs(sub, 3, 3, CUSS &s, flags, TRUE, name, &resetok, NULL))
7042 case -1: continue; /* skipping */
7043 case 1: goto EXPAND_FAILED_CURLY;
7045 case 3: goto EXPAND_FAILED;
7048 if (sub[1] && *(sub[1]))
7050 g = string_catn(g, US"SRS0=", 5);
7052 /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
7053 hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
7054 g = string_catn(g, cksum, sizeof(cksum));
7055 g = string_catn(g, US"=", 1);
7057 /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
7063 gettimeofday(&now, NULL);
7064 for (unsigned long i = (now.tv_sec / 86400) & 0x3ff; i; i >>= 5)
7065 h = string_catn(h, &base32_chars[i & 0x1f], 1);
7066 if (h) while (h->ptr > 0)
7067 g = string_catn(g, &h->s[--h->ptr], 1);
7069 g = string_catn(g, US"=", 1);
7071 /* ${domain:$return_path}=${local_part:$return_path} */
7073 int start, end, domain;
7074 uschar * t = parse_extract_address(sub[1], &expand_string_message,
7075 &start, &end, &domain, FALSE);
7081 if (domain > 0) g = string_cat(g, t + domain);
7082 g = string_catn(g, US"=", 1);
7084 s = domain > 0 ? string_copyn(t, domain - 1) : t;
7085 if ((quoted = Ustrchr(s, '"') != NULL))
7088 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
7089 while (*s) /* de-quote */
7091 while (*s && *s != '"') h = string_catn(h, s++, 1);
7093 while (*s && *s != '"') h = string_catn(h, s++, 1);
7096 gstring_release_unused(h);
7097 s = string_from_gstring(h);
7099 g = string_cat(g, s);
7102 /* Assume that if the original local_part had quotes
7103 it was for good reason */
7105 if (quoted) yield = string_catn(yield, US"\"", 1);
7106 yield = string_catn(yield, g->s, g->ptr);
7107 if (quoted) yield = string_catn(yield, US"\"", 1);
7109 /* @$original_domain */
7110 yield = string_catn(yield, US"@", 1);
7111 yield = string_cat(yield, sub[2]);
7114 DEBUG(D_expand) debug_printf_indent("null return_path for srs-encode\n");
7118 #endif /*SUPPORT_SRS*/
7122 } /* EITEM_* switch */
7126 if (yield && (start > 0 || *s)) /* only if not the sole expansion of the line */
7127 debug_expansion_interim(US"item-res",
7128 yield->s + start, yield->ptr - start, !!(flags & ESI_SKIPPING));
7134 /* Control reaches here if the name is not recognized as one of the more
7135 complicated expansion items. Check for the "operator" syntax (name terminated
7136 by a colon). Some of the operators have arguments, separated by _ from the
7142 uschar * arg = NULL, * sub;
7144 var_entry * vp = NULL;
7147 /* Owing to an historical mis-design, an underscore may be part of the
7148 operator name, or it may introduce arguments. We therefore first scan the
7149 table of names that contain underscores. If there is no match, we cut off
7150 the arguments and then scan the main table. */
7152 if ((c = chop_match(name, op_table_underscore,
7153 nelem(op_table_underscore))) < 0)
7155 if ((arg = Ustrchr(name, '_')))
7157 if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
7158 c += nelem(op_table_underscore);
7159 if (arg) *arg++ = '_'; /* Put back for error messages */
7162 /* Deal specially with operators that might take a certificate variable
7163 as we do not want to do the usual expansion. For most, expand the string.*/
7173 const uschar * s1 = s;
7174 sub = expand_string_internal(s+2,
7175 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s1, &resetok, NULL);
7176 if (!sub) goto EXPAND_FAILED; /*{*/
7179 expand_string_message =
7180 string_sprintf("missing '}' closing cert arg of %s", name);
7181 goto EXPAND_FAILED_CURLY;
7183 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
7193 sub = expand_string_internal(s+1,
7194 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7195 if (!sub) goto EXPAND_FAILED;
7200 /* If we are skipping, we don't need to perform the operation at all.
7201 This matters for operations like "mask", because the data may not be
7202 in the correct format when skipping. For example, the expression may test
7203 for the existence of $sender_host_address before trying to mask it. For
7204 other operations, doing them may not fail, but it is a waste of time. */
7206 if (flags & ESI_SKIPPING && c >= 0) continue;
7208 /* Otherwise, switch on the operator type. After handling go back
7209 to the main loop top. */
7212 int start = yield->ptr;
7218 unsigned long int n = Ustrtoul(sub, &t, 10);
7223 expand_string_message = string_sprintf("argument for base32 "
7224 "operator is \"%s\", which is not a decimal number", sub);
7228 g = string_catn(g, &base32_chars[n & 0x1f], 1);
7230 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7237 unsigned long int n = 0;
7240 uschar * t = Ustrchr(base32_chars, *tt++);
7243 expand_string_message = string_sprintf("argument for base32d "
7244 "operator is \"%s\", which is not a base 32 number", sub);
7247 n = n * 32 + (t - base32_chars);
7249 yield = string_fmt_append(yield, "%ld", n);
7256 unsigned long int n = Ustrtoul(sub, &t, 10);
7259 expand_string_message = string_sprintf("argument for base62 "
7260 "operator is \"%s\", which is not a decimal number", sub);
7263 yield = string_cat(yield, string_base62(n));
7267 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7272 unsigned long int n = 0;
7275 uschar *t = Ustrchr(base62_chars, *tt++);
7278 expand_string_message = string_sprintf("argument for base62d "
7279 "operator is \"%s\", which is not a base %d number", sub,
7283 n = n * BASE_62 + (t - base62_chars);
7285 yield = string_fmt_append(yield, "%ld", n);
7291 uschar *expanded = expand_string_internal(sub,
7292 ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, NULL, &resetok, NULL);
7295 expand_string_message =
7296 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7297 expand_string_message);
7300 yield = string_cat(yield, expanded);
7307 uschar *t = sub - 1;
7308 while (*(++t) != 0) { *t = tolower(*t); count++; }
7309 yield = string_catn(yield, sub, count);
7316 uschar *t = sub - 1;
7317 while (*(++t) != 0) { *t = toupper(*t); count++; }
7318 yield = string_catn(yield, sub, count);
7324 if (vp && *(void **)vp->value)
7326 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7327 yield = string_cat(yield, cp);
7335 md5_end(&base, sub, Ustrlen(sub), digest);
7336 for (int j = 0; j < 16; j++)
7337 yield = string_fmt_append(yield, "%02x", digest[j]);
7343 if (vp && *(void **)vp->value)
7345 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7346 yield = string_cat(yield, cp);
7354 sha1_end(&h, sub, Ustrlen(sub), digest);
7355 for (int j = 0; j < 20; j++)
7356 yield = string_fmt_append(yield, "%02X", digest[j]);
7362 #ifdef EXIM_HAVE_SHA2
7363 if (vp && *(void **)vp->value)
7364 if (c == EOP_SHA256)
7365 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7367 expand_string_message = US"sha2_N not supported with certificates";
7372 hashmethod m = !arg ? HASH_SHA2_256
7373 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7374 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7375 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7378 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7380 expand_string_message = US"unrecognised sha2 variant";
7384 exim_sha_update_string(&h, sub);
7385 exim_sha_finish(&h, &b);
7387 yield = string_fmt_append(yield, "%02X", *b.data++);
7390 expand_string_message = US"sha256 only supported with TLS";
7395 #ifdef EXIM_HAVE_SHA3
7399 hashmethod m = !arg ? HASH_SHA3_256
7400 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7401 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7402 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7403 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7406 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7408 expand_string_message = US"unrecognised sha3 variant";
7412 exim_sha_update_string(&h, sub);
7413 exim_sha_finish(&h, &b);
7415 yield = string_fmt_append(yield, "%02X", *b.data++);
7419 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7423 /* Convert hex encoding to base64 encoding */
7433 for (enc = sub; *enc; enc++)
7435 if (!isxdigit(*enc))
7437 expand_string_message = string_sprintf("\"%s\" is not a hex "
7446 expand_string_message = string_sprintf("\"%s\" contains an odd "
7447 "number of characters", sub);
7451 while ((c = *in++) != 0)
7453 if (isdigit(c)) c -= '0';
7454 else c = toupper(c) - 'A' + 10;
7464 enc = b64encode(CUS sub, out - sub);
7465 yield = string_cat(yield, enc);
7469 /* Convert octets outside 0x21..0x7E to \xXX form */
7473 uschar *t = sub - 1;
7476 if (*t < 0x21 || 0x7E < *t)
7477 yield = string_fmt_append(yield, "\\x%02x", *t);
7479 yield = string_catn(yield, t, 1);
7484 /* count the number of list elements */
7488 int cnt = 0, sep = 0;
7489 uschar * buf = store_get(2, sub);
7491 while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7492 yield = string_fmt_append(yield, "%d", cnt);
7496 /* expand a named list given the name */
7497 /* handles nested named lists; requotes as colon-sep list */
7500 expand_string_message = NULL;
7501 yield = expand_listnamed(yield, sub, arg);
7502 if (expand_string_message)
7506 /* quote a list-item for the given list-separator */
7508 /* mask applies a mask to an IP address; for example the result of
7509 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7516 int type, mask, maskoffset;
7520 if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7522 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7527 if (maskoffset == 0)
7529 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7534 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7536 if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7538 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7543 /* If an optional 'n' was given, ipv6 gets normalised output:
7544 colons rather than dots, and zero-compressed. */
7546 normalised = arg && *arg == 'n';
7548 /* Convert the address to binary integer(s) and apply the mask */
7550 sub[maskoffset] = 0;
7551 count = host_aton(sub, binary);
7552 host_mask(count, binary, mask);
7554 /* Convert to masked textual format and add to output. */
7556 if (type == 4 || !normalised)
7557 yield = string_catn(yield, buffer,
7558 host_nmtoa(count, binary, mask, buffer, '.'));
7561 ipv6_nmtoa(binary, buffer);
7562 yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7568 case EOP_IPV6DENORM:
7570 int type = string_is_ip_address(sub, NULL);
7577 (void) host_aton(sub, binary);
7580 case 4: /* convert to IPv4-mapped IPv6 */
7581 binary[0] = binary[1] = 0;
7582 binary[2] = 0x0000ffff;
7583 (void) host_aton(sub, binary+3);
7587 expand_string_message =
7588 string_sprintf("\"%s\" is not an IP address", sub);
7592 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7593 ? ipv6_nmtoa(binary, buffer)
7594 : host_nmtoa(4, binary, -1, buffer, ':')
7600 case EOP_LOCAL_PART:
7604 int start, end, domain;
7605 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7608 if (c != EOP_DOMAIN)
7609 yield = c == EOP_LOCAL_PART && domain > 0
7610 ? string_catn(yield, t, domain - 1)
7611 : string_cat(yield, t);
7612 else if (domain > 0)
7613 yield = string_cat(yield, t + domain);
7619 uschar outsep[2] = { ':', '\0' };
7620 uschar *address, *error;
7621 int save_ptr = gstring_length(yield);
7622 int start, end, domain; /* Not really used */
7624 if (Uskip_whitespace(&sub) == '>')
7625 if (*outsep = *++sub) ++sub;
7628 expand_string_message = string_sprintf("output separator "
7629 "missing in expanding ${addresses:%s}", --sub);
7632 f.parse_allow_group = TRUE;
7636 uschar * p = parse_find_address_end(sub, FALSE);
7637 uschar saveend = *p;
7639 address = parse_extract_address(sub, &error, &start, &end, &domain,
7643 /* Add the address to the output list that we are building. This is
7644 done in chunks by searching for the separator character. At the
7645 start, unless we are dealing with the first address of the output
7646 list, add in a space if the new address begins with the separator
7647 character, or is an empty string. */
7651 if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7652 yield = string_catn(yield, US" ", 1);
7656 size_t seglen = Ustrcspn(address, outsep);
7657 yield = string_catn(yield, address, seglen + 1);
7659 /* If we got to the end of the string we output one character
7662 if (address[seglen] == '\0') { yield->ptr--; break; }
7663 yield = string_catn(yield, outsep, 1);
7664 address += seglen + 1;
7667 /* Output a separator after the string: we will remove the
7668 redundant final one at the end. */
7670 yield = string_catn(yield, outsep, 1);
7673 if (saveend == '\0') break;
7677 /* If we have generated anything, remove the redundant final
7680 if (yield && yield->ptr != save_ptr) yield->ptr--;
7681 f.parse_allow_group = FALSE;
7686 /* quote puts a string in quotes if it is empty or contains anything
7687 other than alphamerics, underscore, dot, or hyphen.
7689 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7690 be quoted in order to be a valid local part.
7692 In both cases, newlines and carriage returns are converted into \n and \r
7696 case EOP_QUOTE_LOCAL_PART:
7699 BOOL needs_quote = (!*sub); /* TRUE for empty string */
7700 uschar *t = sub - 1;
7703 while (!needs_quote && *++t)
7704 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7706 else /* EOP_QUOTE_LOCAL_PART */
7707 while (!needs_quote && *++t)
7708 needs_quote = !isalnum(*t)
7709 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7710 && (*t != '.' || t == sub || !t[1]);
7714 yield = string_catn(yield, US"\"", 1);
7718 yield = string_catn(yield, US"\\n", 2);
7719 else if (*t == '\r')
7720 yield = string_catn(yield, US"\\r", 2);
7723 if (*t == '\\' || *t == '"')
7724 yield = string_catn(yield, US"\\", 1);
7725 yield = string_catn(yield, t, 1);
7727 yield = string_catn(yield, US"\"", 1);
7730 yield = string_cat(yield, sub);
7734 /* quote_lookuptype does lookup-specific quoting */
7739 uschar * opt = Ustrchr(arg, '_');
7741 if (opt) *opt++ = 0;
7743 if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7745 expand_string_message = search_error_message;
7749 if (lookup_list[n]->quote)
7750 sub = (lookup_list[n]->quote)(sub, opt, (unsigned)n);
7756 expand_string_message = string_sprintf(
7757 "\"%s\" unrecognized after \"${quote_%s\"", /*}*/
7762 yield = string_cat(yield, sub);
7766 /* rx quote sticks in \ before any non-alphameric character so that
7767 the insertion works in a regular expression. */
7771 uschar *t = sub - 1;
7775 yield = string_catn(yield, US"\\", 1);
7776 yield = string_catn(yield, t, 1);
7781 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7782 prescribed by the RFC, if there are characters that need to be encoded */
7785 yield = string_cat(yield,
7786 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7790 /* RFC 2047 decode */
7796 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7797 headers_charset, '?', &len, &error);
7800 expand_string_message = error;
7803 yield = string_catn(yield, decoded, len);
7807 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7812 uschar * buff = store_get(4, sub);
7817 if (c > 255) c = '_';
7819 yield = string_catn(yield, buff, 1);
7824 /* replace illegal UTF-8 sequences by replacement character */
7826 #define UTF8_REPLACEMENT_CHAR US"?"
7830 int seq_len = 0, index = 0;
7832 long codepoint = -1;
7834 uschar seq_buff[4]; /* accumulate utf-8 here */
7836 /* Manually track tainting, as we deal in individual chars below */
7838 if (!yield->s || !yield->ptr)
7839 yield->s = store_get(yield->size = Ustrlen(sub), sub);
7840 else if (is_incompatible(yield->s, sub))
7841 gstring_rebuffer(yield, sub);
7843 /* Check the UTF-8, byte-by-byte */
7852 if ((c & 0xc0) != 0x80)
7853 /* wrong continuation byte; invalidate all bytes */
7854 complete = 1; /* error */
7857 codepoint = (codepoint << 6) | (c & 0x3f);
7858 seq_buff[index++] = c;
7859 if (--bytes_left == 0) /* codepoint complete */
7860 if(codepoint > 0x10FFFF) /* is it too large? */
7861 complete = -1; /* error (RFC3629 limit) */
7863 { /* finished; output utf-8 sequence */
7864 yield = string_catn(yield, seq_buff, seq_len);
7869 else /* no bytes left: new sequence */
7871 if(!(c & 0x80)) /* 1-byte sequence, US-ASCII, keep it */
7873 yield = string_catn(yield, &c, 1);
7876 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7878 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7883 codepoint = c & 0x1f;
7886 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7889 codepoint = c & 0x0f;
7891 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7894 codepoint = c & 0x07;
7896 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7899 seq_buff[index++] = c;
7900 seq_len = bytes_left + 1;
7901 } /* if(bytes_left) */
7905 bytes_left = index = 0;
7906 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7908 if ((complete == 1) && ((c & 0x80) == 0))
7909 /* ASCII character follows incomplete sequence */
7910 yield = string_catn(yield, &c, 1);
7912 /* If given a sequence truncated mid-character, we also want to report ?
7913 Eg, ${length_1:フィル} is one byte, not one character, so we expect
7914 ${utf8clean:${length_1:フィル}} to yield '?' */
7916 if (bytes_left != 0)
7917 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7923 case EOP_UTF8_DOMAIN_TO_ALABEL:
7925 uschar * error = NULL;
7926 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7929 expand_string_message = string_sprintf(
7930 "error converting utf8 (%s) to alabel: %s",
7931 string_printing(sub), error);
7934 yield = string_cat(yield, s);
7938 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7940 uschar * error = NULL;
7941 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7944 expand_string_message = string_sprintf(
7945 "error converting alabel (%s) to utf8: %s",
7946 string_printing(sub), error);
7949 yield = string_cat(yield, s);
7953 case EOP_UTF8_LOCALPART_TO_ALABEL:
7955 uschar * error = NULL;
7956 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7959 expand_string_message = string_sprintf(
7960 "error converting utf8 (%s) to alabel: %s",
7961 string_printing(sub), error);
7964 yield = string_cat(yield, s);
7965 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7969 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7971 uschar * error = NULL;
7972 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7975 expand_string_message = string_sprintf(
7976 "error converting alabel (%s) to utf8: %s",
7977 string_printing(sub), error);
7980 yield = string_cat(yield, s);
7983 #endif /* EXPERIMENTAL_INTERNATIONAL */
7985 /* escape turns all non-printing characters into escape sequences. */
7989 const uschar * t = string_printing(sub);
7990 yield = string_cat(yield, t);
7994 case EOP_ESCAPE8BIT:
7998 for (const uschar * s = sub; (c = *s); s++)
7999 yield = c < 127 && c != '\\'
8000 ? string_catn(yield, s, 1)
8001 : string_fmt_append(yield, "\\%03o", c);
8005 /* Handle numeric expression evaluation */
8010 uschar *save_sub = sub;
8011 uschar *error = NULL;
8012 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
8015 expand_string_message = string_sprintf("error in expression "
8016 "evaluation: %s (after processing \"%.*s\")", error,
8017 (int)(sub-save_sub), save_sub);
8020 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
8024 /* Handle time period formatting */
8028 int n = readconf_readtime(sub, 0, FALSE);
8031 expand_string_message = string_sprintf("string \"%s\" is not an "
8032 "Exim time interval in \"%s\" operator", sub, name);
8035 yield = string_fmt_append(yield, "%d", n);
8039 case EOP_TIME_INTERVAL:
8042 uschar *t = read_number(&n, sub);
8043 if (*t != 0) /* Not A Number*/
8045 expand_string_message = string_sprintf("string \"%s\" is not a "
8046 "positive number in \"%s\" operator", sub, name);
8049 t = readconf_printtime(n);
8050 yield = string_cat(yield, t);
8054 /* Convert string to base64 encoding */
8060 uschar * s = vp && *(void **)vp->value
8061 ? tls_cert_der_b64(*(void **)vp->value)
8062 : b64encode(CUS sub, Ustrlen(sub));
8064 uschar * s = b64encode(CUS sub, Ustrlen(sub));
8066 yield = string_cat(yield, s);
8073 int len = b64decode(sub, &s);
8076 expand_string_message = string_sprintf("string \"%s\" is not "
8077 "well-formed for \"%s\" operator", sub, name);
8080 yield = string_cat(yield, s);
8084 /* strlen returns the length of the string */
8087 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
8090 /* length_n or l_n takes just the first n characters or the whole string,
8091 whichever is the shorter;
8093 substr_m_n, and s_m_n take n characters from offset m; negative m take
8094 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
8095 takes the rest, either to the right or to the left.
8097 hash_n or h_n makes a hash of length n from the string, yielding n
8098 characters from the set a-z; hash_n_m makes a hash of length n, but
8099 uses m characters from the set a-zA-Z0-9.
8101 nhash_n returns a single number between 0 and n-1 (in text form), while
8102 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
8103 between 0 and n-1 and the second between 0 and m-1. */
8123 expand_string_message = string_sprintf("missing values after %s",
8128 /* "length" has only one argument, effectively being synonymous with
8131 if (c == EOP_LENGTH || c == EOP_L)
8137 /* The others have one or two arguments; for "substr" the first may be
8138 negative. The second being negative means "not supplied". */
8143 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8146 /* Read up to two numbers, separated by underscores */
8151 if (arg != ret && *arg == '_' && pn == &value1)
8155 if (arg[1] != 0) arg++;
8157 else if (!isdigit(*arg))
8159 expand_string_message =
8160 string_sprintf("non-digit after underscore in \"%s\"", name);
8163 else *pn = (*pn)*10 + *arg++ - '0';
8167 /* Perform the required operation */
8169 ret = c == EOP_HASH || c == EOP_H
8170 ? compute_hash(sub, value1, value2, &len)
8171 : c == EOP_NHASH || c == EOP_NH
8172 ? compute_nhash(sub, value1, value2, &len)
8173 : extract_substr(sub, value1, value2, &len);
8174 if (!ret) goto EXPAND_FAILED;
8176 yield = string_catn(yield, ret, len);
8185 uschar **modetable[3];
8189 if (expand_forbid & RDO_EXISTS)
8191 expand_string_message = US"Use of the stat() expansion is not permitted";
8195 if (stat(CS sub, &st) < 0)
8197 expand_string_message = string_sprintf("stat(%s) failed: %s",
8198 sub, strerror(errno));
8202 switch (mode & S_IFMT)
8204 case S_IFIFO: smode[0] = 'p'; break;
8205 case S_IFCHR: smode[0] = 'c'; break;
8206 case S_IFDIR: smode[0] = 'd'; break;
8207 case S_IFBLK: smode[0] = 'b'; break;
8208 case S_IFREG: smode[0] = '-'; break;
8209 default: smode[0] = '?'; break;
8212 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8213 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8214 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8216 for (int i = 0; i < 3; i++)
8218 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8223 yield = string_fmt_append(yield,
8224 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8225 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8226 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8227 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8228 (long)st.st_gid, st.st_size, (long)st.st_atime,
8229 (long)st.st_mtime, (long)st.st_ctime);
8233 /* vaguely random number less than N */
8237 int_eximarith_t max = expanded_string_integer(sub, TRUE);
8239 if (expand_string_message)
8241 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8245 /* Reverse IP, including IPv6 to dotted-nibble */
8247 case EOP_REVERSE_IP:
8249 int family, maskptr;
8250 uschar reversed[128];
8252 family = string_is_ip_address(sub, &maskptr);
8255 expand_string_message = string_sprintf(
8256 "reverse_ip() not given an IP address [%s]", sub);
8259 invert_address(reversed, sub);
8260 yield = string_cat(yield, reversed);
8264 /* Unknown operator */
8267 expand_string_message =
8268 string_sprintf("unknown expansion operator \"%s\"", name);
8270 } /* EOP_* switch */
8274 const uschar * s = yield->s + start;
8275 int i = yield->ptr - start;
8276 BOOL tainted = is_tainted(s);
8280 debug_printf_indent("|-----op-res: %.*s\n", i, s);
8283 debug_printf_indent("%s \\__", flags & ESI_SKIPPING ? "| " : " ");
8284 debug_print_taint(yield->s);
8289 debug_printf_indent(UTF8_VERT_RIGHT
8290 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8291 "op-res: %.*s\n", i, s);
8294 debug_printf_indent("%s",
8295 flags & ESI_SKIPPING
8296 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8297 debug_print_taint(yield->s);
8305 /* Not an item or an operator */
8306 /* Handle a plain name. If this is the first thing in the expansion, release
8307 the pre-allocated buffer. If the result data is known to be in a new buffer,
8308 newsize will be set to the size of that buffer, and we can just point at that
8309 store instead of copying. Many expansion strings contain just one reference,
8310 so this is a useful optimization, especially for humungous headers
8311 ($message_headers). */
8315 const uschar * value;
8321 g = store_get(sizeof(gstring), GET_UNTAINTED);
8322 else if (yield->ptr == 0)
8324 if (resetok) reset_point = store_reset(reset_point);
8326 reset_point = store_mark();
8327 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
8329 if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
8331 expand_string_message =
8332 string_sprintf("unknown variable in \"${%s}\"", name);
8333 check_variable_error_message(name);
8336 len = Ustrlen(value);
8337 if (!yield && newsize)
8340 yield->size = newsize;
8342 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8345 yield = string_catn(yield, value, len);
8349 /* Else there's something wrong */
8351 expand_string_message =
8352 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8353 "in a variable reference)", name);
8357 /* If we hit the end of the string when brace_ends is set, there is a missing
8358 terminating brace. */
8360 if (flags & ESI_BRACE_ENDS && !*s)
8362 expand_string_message = malformed_header
8363 ? US"missing } at end of string - could be header name not terminated by colon"
8364 : US"missing } at end of string";
8368 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8369 added to the string. If so, set up an empty string. Add a terminating zero. If
8370 left != NULL, return a pointer to the terminator. */
8373 yield = string_get(1);
8374 (void) string_from_gstring(yield);
8375 if (left) *left = s;
8377 /* Any stacking store that was used above the final string is no longer needed.
8378 In many cases the final string will be the first one that was got and so there
8379 will be optimal store usage. */
8381 if (resetok) gstring_release_unused(yield);
8382 else if (resetok_p) *resetok_p = FALSE;
8386 BOOL tainted = is_tainted(yield->s);
8389 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8390 debug_printf_indent("%sresult: %s\n",
8391 flags & ESI_SKIPPING ? "|-----" : "\\_____", yield->s);
8394 debug_printf_indent("%s \\__", flags & ESI_SKIPPING ? "| " : " ");
8395 debug_print_taint(yield->s);
8397 if (flags & ESI_SKIPPING)
8398 debug_printf_indent("\\___skipping: result is not used\n");
8402 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8403 "expanding: %.*s\n",
8404 (int)(s - string), string);
8405 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8407 flags & ESI_SKIPPING ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8411 debug_printf_indent("%s",
8412 flags & ESI_SKIPPING
8413 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8414 debug_print_taint(yield->s);
8416 if (flags & ESI_SKIPPING)
8417 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8418 "skipping: result is not used\n");
8421 if (textonly_p) *textonly_p = textonly;
8425 /* This is the failure exit: easiest to program with a goto. We still need
8426 to update the pointer to the terminator, for cases of nested calls with "fail".
8429 EXPAND_FAILED_CURLY:
8430 if (malformed_header)
8431 expand_string_message =
8432 US"missing or misplaced { or } - could be header name not terminated by colon";
8434 else if (!expand_string_message || !*expand_string_message)
8435 expand_string_message = US"missing or misplaced { or }";
8437 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8438 that is a bad idea, because expand_string_message is in dynamic store. */
8441 if (left) *left = s;
8446 debug_printf_indent("|failed to expand: %s\n", string);
8447 debug_printf_indent("%serror message: %s\n",
8448 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8449 if (f.expand_string_forcedfail)
8450 debug_printf_indent("\\failure was forced\n");
8454 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8456 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8457 "error message: %s\n",
8458 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8459 expand_string_message);
8460 if (f.expand_string_forcedfail)
8461 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8464 if (resetok_p && !resetok) *resetok_p = FALSE;
8471 /* This is the external function call. Do a quick check for any expansion
8472 metacharacters, and if there are none, just return the input string.
8475 the string to be expanded
8476 optional pointer for return boolean indicating no-dynamic-expansions
8478 Returns: the expanded string, or NULL if expansion failed; if failure was
8479 due to a lookup deferring, search_find_defer will be TRUE
8483 expand_string_2(const uschar * string, BOOL * textonly_p)
8485 if (Ustrpbrk(string, "$\\") != NULL)
8487 int old_pool = store_pool;
8490 f.search_find_defer = FALSE;
8491 malformed_header = FALSE;
8492 store_pool = POOL_MAIN;
8493 s = expand_string_internal(string, ESI_HONOR_DOLLAR, NULL, NULL, textonly_p);
8494 store_pool = old_pool;
8497 if (textonly_p) *textonly_p = TRUE;
8502 expand_cstring(const uschar * string)
8503 { return expand_string_2(string, NULL); }
8506 expand_string(uschar * string)
8507 { return US expand_string_2(CUS string, NULL); }
8514 /*************************************************
8516 *************************************************/
8518 /* Now and again we want to expand a string and be sure that the result is in a
8519 new bit of store. This function does that.
8520 Since we know it has been copied, the de-const cast is safe.
8522 Argument: the string to be expanded
8523 Returns: the expanded string, always in a new bit of store, or NULL
8527 expand_string_copy(const uschar *string)
8529 const uschar *yield = expand_cstring(string);
8530 if (yield == string) yield = string_copy(string);
8536 /*************************************************
8537 * Expand and interpret as an integer *
8538 *************************************************/
8540 /* Expand a string, and convert the result into an integer.
8543 string the string to be expanded
8544 isplus TRUE if a non-negative number is expected
8546 Returns: the integer value, or
8547 -1 for an expansion error ) in both cases, message in
8548 -2 for an integer interpretation error ) expand_string_message
8549 expand_string_message is set NULL for an OK integer
8553 expand_string_integer(uschar *string, BOOL isplus)
8555 return expanded_string_integer(expand_string(string), isplus);
8559 /*************************************************
8560 * Interpret string as an integer *
8561 *************************************************/
8563 /* Convert a string (that has already been expanded) into an integer.
8565 This function is used inside the expansion code.
8568 s the string to be expanded
8569 isplus TRUE if a non-negative number is expected
8571 Returns: the integer value, or
8572 -1 if string is NULL (which implies an expansion error)
8573 -2 for an integer interpretation error
8574 expand_string_message is set NULL for an OK integer
8577 static int_eximarith_t
8578 expanded_string_integer(const uschar *s, BOOL isplus)
8580 int_eximarith_t value;
8581 uschar *msg = US"invalid integer \"%s\"";
8584 /* If expansion failed, expand_string_message will be set. */
8588 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8589 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8590 systems, so we set it zero ourselves. */
8593 expand_string_message = NULL; /* Indicates no error */
8595 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8596 equal to 0. Unfortunately, people actually relied upon that, so preserve
8597 the behaviour explicitly. Stripping leading whitespace is a harmless
8598 noop change since strtol skips it anyway (provided that there is a number
8601 if (Uskip_whitespace(&s) == '\0')
8604 debug_printf_indent("treating blank string as number 0\n");
8608 value = strtoll(CS s, CSS &endptr, 10);
8611 msg = US"integer expected but \"%s\" found";
8612 else if (value < 0 && isplus)
8613 msg = US"non-negative integer expected but \"%s\" found";
8616 switch (tolower(*endptr))
8621 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8626 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8627 else value *= 1024*1024;
8631 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8632 else value *= 1024*1024*1024;
8636 if (errno == ERANGE)
8637 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8639 if (Uskip_whitespace(&endptr) == 0) return value;
8642 expand_string_message = string_sprintf(CS msg, s);
8647 /* These values are usually fixed boolean values, but they are permitted to be
8651 addr address being routed
8652 mtype the module type
8653 mname the module name
8654 dbg_opt debug selectors
8655 oname the option name
8656 bvalue the router's boolean value
8657 svalue the router's string value
8658 rvalue where to put the returned value
8660 Returns: OK value placed in rvalue
8661 DEFER expansion failed
8665 exp_bool(address_item *addr,
8666 uschar *mtype, uschar *mname, unsigned dbg_opt,
8667 uschar *oname, BOOL bvalue,
8668 uschar *svalue, BOOL *rvalue)
8671 if (!svalue) { *rvalue = bvalue; return OK; }
8673 if (!(expanded = expand_string(svalue)))
8675 if (f.expand_string_forcedfail)
8677 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8681 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8682 oname, mname, mtype, expand_string_message);
8683 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8687 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8690 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8692 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8696 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8697 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8706 /* Avoid potentially exposing a password in a string about to be logged */
8709 expand_hide_passwords(uschar * s)
8711 return ( ( Ustrstr(s, "failed to expand") != NULL
8712 || Ustrstr(s, "expansion of ") != NULL
8714 && ( Ustrstr(s, "mysql") != NULL
8715 || Ustrstr(s, "pgsql") != NULL
8716 || Ustrstr(s, "redis") != NULL
8717 || Ustrstr(s, "sqlite") != NULL
8718 || Ustrstr(s, "ldap:") != NULL
8719 || Ustrstr(s, "ldaps:") != NULL
8720 || Ustrstr(s, "ldapi:") != NULL
8721 || Ustrstr(s, "ldapdn:") != NULL
8722 || Ustrstr(s, "ldapm:") != NULL
8724 ? US"Temporary internal error" : s;
8728 /* Read given named file into big_buffer. Use for keying material etc.
8729 The content will have an ascii NUL appended.
8734 Return: pointer to buffer, or NULL on error.
8738 expand_file_big_buffer(const uschar * filename)
8740 int fd, off = 0, len;
8742 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8744 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8751 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8754 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8762 big_buffer[off] = '\0';
8768 /*************************************************
8769 * Error-checking for testsuite *
8770 *************************************************/
8772 uschar * region_start;
8773 uschar * region_end;
8774 const uschar *var_name;
8775 const uschar *var_data;
8778 /* Called via tree_walk, which allows nonconst name/data. Our usage is const. */
8780 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8783 if (var_data >= e->region_start && var_data < e->region_end)
8785 e->var_name = CUS var_name;
8786 e->var_data = CUS var_data;
8791 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8793 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8794 .var_name = NULL, .var_data = NULL };
8796 /* check acl_ variables */
8797 tree_walk(acl_var_c, assert_variable_notin, &e);
8798 tree_walk(acl_var_m, assert_variable_notin, &e);
8800 /* check auth<n> variables.
8801 assert_variable_notin() treats as const, so deconst is safe. */
8802 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8803 assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8805 #ifdef WITH_CONTENT_SCAN
8806 /* check regex<n> variables. assert_variable_notin() treats as const. */
8807 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8808 assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8811 /* check known-name variables */
8812 for (var_entry * v = var_table; v < var_table + var_table_size; v++)
8813 if (v->type == vtype_stringptr)
8814 assert_variable_notin(US v->name, *(USS v->value), &e);
8816 /* check dns and address trees */
8817 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8818 tree_walk(tree_duplicates, assert_variable_notin, &e);
8819 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8820 tree_walk(tree_unusable, assert_variable_notin, &e);
8823 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8824 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8825 e.var_name, filename, linenumber, e.var_data);
8830 /*************************************************
8831 **************************************************
8832 * Stand-alone test program *
8833 **************************************************
8834 *************************************************/
8840 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8842 int ovec[3*(EXPAND_MAXN+1)];
8843 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8845 BOOL yield = n >= 0;
8846 if (n == 0) n = EXPAND_MAXN + 1;
8849 expand_nmax = setup < 0 ? 0 : setup + 1;
8850 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8852 expand_nstring[expand_nmax] = subject + ovec[nn];
8853 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8861 int main(int argc, uschar **argv)
8863 uschar buffer[1024];
8865 debug_selector = D_v;
8866 debug_file = stderr;
8867 debug_fd = fileno(debug_file);
8868 big_buffer = malloc(big_buffer_size);
8871 for (int i = 1; i < argc; i++)
8873 if (argv[i][0] == '+')
8875 debug_trace_memory = 2;
8878 if (isdigit(argv[i][0]))
8879 debug_selector = Ustrtol(argv[i], NULL, 0);
8881 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8885 eldap_default_servers = argv[i];
8888 mysql_servers = argv[i];
8891 pgsql_servers = argv[i];
8894 redis_servers = argv[i];
8898 else opt_perl_startup = argv[i];
8902 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8904 expand_nstring[1] = US"string 1....";
8905 expand_nlength[1] = 8;
8909 if (opt_perl_startup != NULL)
8912 printf("Starting Perl interpreter\n");
8913 errstr = init_perl(opt_perl_startup);
8916 printf("** error in perl_startup code: %s\n", errstr);
8917 return EXIT_FAILURE;
8920 #endif /* EXIM_PERL */
8922 /* Thie deliberately regards the input as untainted, so that it can be
8923 expanded; only reasonable since this is a test for string-expansions. */
8925 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8927 rmark reset_point = store_mark();
8928 uschar *yield = expand_string(buffer);
8930 printf("%s\n", yield);
8933 if (f.search_find_defer) printf("search_find deferred\n");
8934 printf("Failed: %s\n", expand_string_message);
8935 if (f.expand_string_forcedfail) printf("Forced failure\n");
8938 store_reset(reset_point);
8946 #endif /*STAND_ALONE*/
8948 #endif /*!MACRO_PREDEF*/
8951 /* End of expand.c */