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_host_address", vtype_stringptr, &sender_host_address },
719 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
720 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
721 { "sender_host_name", vtype_host_lookup, NULL },
722 { "sender_host_port", vtype_int, &sender_host_port },
723 { "sender_ident", vtype_stringptr, &sender_ident },
724 { "sender_rate", vtype_stringptr, &sender_rate },
725 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
726 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
727 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
728 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
729 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
730 { "sending_port", vtype_int, &sending_port },
731 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
732 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
733 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
734 { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
735 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
736 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
737 { "sn0", vtype_filter_int, &filter_sn[0] },
738 { "sn1", vtype_filter_int, &filter_sn[1] },
739 { "sn2", vtype_filter_int, &filter_sn[2] },
740 { "sn3", vtype_filter_int, &filter_sn[3] },
741 { "sn4", vtype_filter_int, &filter_sn[4] },
742 { "sn5", vtype_filter_int, &filter_sn[5] },
743 { "sn6", vtype_filter_int, &filter_sn[6] },
744 { "sn7", vtype_filter_int, &filter_sn[7] },
745 { "sn8", vtype_filter_int, &filter_sn[8] },
746 { "sn9", vtype_filter_int, &filter_sn[9] },
747 #ifdef WITH_CONTENT_SCAN
748 { "spam_action", vtype_stringptr, &spam_action },
749 { "spam_bar", vtype_stringptr, &spam_bar },
750 { "spam_report", vtype_stringptr, &spam_report },
751 { "spam_score", vtype_stringptr, &spam_score },
752 { "spam_score_int", vtype_stringptr, &spam_score_int },
755 { "spf_guess", vtype_stringptr, &spf_guess },
756 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
757 { "spf_received", vtype_stringptr, &spf_received },
758 { "spf_result", vtype_stringptr, &spf_result },
759 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
760 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
762 { "spool_directory", vtype_stringptr, &spool_directory },
763 { "spool_inodes", vtype_pinodes, (void *)TRUE },
764 { "spool_space", vtype_pspace, (void *)TRUE },
766 { "srs_recipient", vtype_stringptr, &srs_recipient },
768 { "thisaddress", vtype_stringptr, &filter_thisaddress },
770 /* The non-(in,out) variables are now deprecated */
771 { "tls_bits", vtype_int, &tls_in.bits },
772 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
773 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
775 { "tls_in_bits", vtype_int, &tls_in.bits },
776 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
777 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
778 { "tls_in_cipher_std", vtype_stringptr, &tls_in.cipher_stdname },
779 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
780 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
781 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
782 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
783 #ifndef DISABLE_TLS_RESUME
784 { "tls_in_resumption", vtype_int, &tls_in.resumption },
787 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
789 { "tls_in_ver", vtype_stringptr, &tls_in.ver },
790 { "tls_out_bits", vtype_int, &tls_out.bits },
791 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
792 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
793 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },
795 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
797 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
798 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
799 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
800 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
801 #ifndef DISABLE_TLS_RESUME
802 { "tls_out_resumption", vtype_int, &tls_out.resumption },
805 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
808 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
810 { "tls_out_ver", vtype_stringptr, &tls_out.ver },
812 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
814 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
817 { "tod_bsdinbox", vtype_todbsdin, NULL },
818 { "tod_epoch", vtype_tode, NULL },
819 { "tod_epoch_l", vtype_todel, NULL },
820 { "tod_full", vtype_todf, NULL },
821 { "tod_log", vtype_todl, NULL },
822 { "tod_logfile", vtype_todlf, NULL },
823 { "tod_zone", vtype_todzone, NULL },
824 { "tod_zulu", vtype_todzulu, NULL },
825 { "transport_name", vtype_stringptr, &transport_name },
826 { "value", vtype_stringptr, &lookup_value },
827 { "verify_mode", vtype_stringptr, &verify_mode },
828 { "version_number", vtype_stringptr, &version_string },
829 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
830 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
831 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
832 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
833 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
834 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
837 static int var_table_size = nelem(var_table);
842 uschar * fn_arc_domains(void) {return NULL;}
843 uschar * fn_hdrs_added(void) {return NULL;}
844 uschar * fn_queue_size(void) {return NULL;}
845 uschar * fn_recipients(void) {return NULL;}
846 uschar * sender_helo_verified_boolstr(void) {return NULL;}
847 uschar * smtp_cmd_hist(void) {return NULL;}
852 expansion_items(void)
855 for (int i = 0; i < nelem(item_table); i++)
857 spf(buf, sizeof(buf), CUS"_EXP_ITEM_%T", item_table[i]);
858 builtin_macro_create(buf);
862 expansion_operators(void)
865 for (int i = 0; i < nelem(op_table_underscore); i++)
867 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_underscore[i]);
868 builtin_macro_create(buf);
870 for (int i = 0; i < nelem(op_table_main); i++)
872 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_main[i]);
873 builtin_macro_create(buf);
877 expansion_conditions(void)
880 for (int i = 0; i < nelem(cond_table); i++)
882 spf(buf, sizeof(buf), CUS"_EXP_COND_%T", cond_table[i]);
883 builtin_macro_create(buf);
887 expansion_variables(void)
890 for (int i = 0; i < nelem(var_table); i++)
892 spf(buf, sizeof(buf), CUS"_EXP_VAR_%T", var_table[i].name);
893 builtin_macro_create(buf);
901 expansion_operators();
902 expansion_conditions();
903 expansion_variables();
906 #else /*!MACRO_PREDEF*/
908 static uschar var_buffer[256];
909 static BOOL malformed_header;
911 /* For textual hashes */
913 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
914 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
917 enum { HMAC_MD5, HMAC_SHA1 };
919 /* For numeric hashes */
921 static unsigned int prime[] = {
922 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
923 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
924 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
926 /* For printing modes in symbolic form */
928 static uschar *mtable_normal[] =
929 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
931 static uschar *mtable_setid[] =
932 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
934 static uschar *mtable_sticky[] =
935 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
937 /* flags for find_header() */
938 #define FH_EXISTS_ONLY BIT(0)
939 #define FH_WANT_RAW BIT(1)
940 #define FH_WANT_LIST BIT(2)
943 /*************************************************
944 * Tables for UTF-8 support *
945 *************************************************/
947 /* Table of the number of extra characters, indexed by the first character
948 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
951 static uschar utf8_table1[] = {
952 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
953 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
954 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
955 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
957 /* These are the masks for the data bits in the first byte of a character,
958 indexed by the number of additional bytes. */
960 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
962 /* Get the next UTF-8 character, advancing the pointer. */
964 #define GETUTF8INC(c, ptr) \
966 if ((c & 0xc0) == 0xc0) \
968 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
970 c = (c & utf8_table2[a]) << s; \
974 c |= (*ptr++ & 0x3f) << s; \
980 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
982 /*************************************************
983 * Binary chop search on a table *
984 *************************************************/
986 /* This is used for matching expansion items and operators.
989 name the name that is being sought
990 table the table to search
991 table_size the number of items in the table
993 Returns: the offset in the table, or -1
997 chop_match(uschar *name, uschar **table, int table_size)
999 uschar **bot = table;
1000 uschar **top = table + table_size;
1004 uschar **mid = bot + (top - bot)/2;
1005 int c = Ustrcmp(name, *mid);
1006 if (c == 0) return mid - table;
1007 if (c > 0) bot = mid + 1; else top = mid;
1015 /*************************************************
1016 * Check a condition string *
1017 *************************************************/
1019 /* This function is called to expand a string, and test the result for a "true"
1020 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
1021 forced fail or lookup defer.
1023 We used to release all store used, but this is not not safe due
1024 to ${dlfunc } and ${acl }. In any case expand_string_internal()
1025 is reasonably careful to release what it can.
1027 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
1030 condition the condition string
1031 m1 text to be incorporated in panic error
1034 Returns: TRUE if condition is met, FALSE if not
1038 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
1040 uschar * ss = expand_string(condition);
1043 if (!f.expand_string_forcedfail && !f.search_find_defer)
1044 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
1045 "for %s %s: %s", condition, m1, m2, expand_string_message);
1048 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
1049 strcmpic(ss, US"false") != 0;
1055 /*************************************************
1056 * Pseudo-random number generation *
1057 *************************************************/
1059 /* Pseudo-random number generation. The result is not "expected" to be
1060 cryptographically strong but not so weak that someone will shoot themselves
1061 in the foot using it as a nonce in some email header scheme or whatever
1062 weirdness they'll twist this into. The result should ideally handle fork().
1064 However, if we're stuck unable to provide this, then we'll fall back to
1065 appallingly bad randomness.
1067 If DISABLE_TLS is not defined then this will not be used except as an emergency
1072 Returns a random number in range [0, max-1]
1076 # define vaguely_random_number vaguely_random_number_fallback
1079 vaguely_random_number(int max)
1082 # undef vaguely_random_number
1084 static pid_t pid = 0;
1087 if ((p2 = getpid()) != pid)
1092 #ifdef HAVE_ARC4RANDOM
1093 /* cryptographically strong randomness, common on *BSD platforms, not
1094 so much elsewhere. Alas. */
1095 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1098 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1099 # ifdef HAVE_SRANDOMDEV
1100 /* uses random(4) for seeding */
1105 gettimeofday(&tv, NULL);
1106 srandom(tv.tv_sec | tv.tv_usec | getpid());
1110 /* Poor randomness and no seeding here */
1117 #ifdef HAVE_ARC4RANDOM
1118 return arc4random() % max;
1119 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1120 return random() % max;
1122 /* This one returns a 16-bit number, definitely not crypto-strong */
1123 return random_number(max);
1130 /*************************************************
1131 * Pick out a name from a string *
1132 *************************************************/
1134 /* If the name is too long, it is silently truncated.
1137 name points to a buffer into which to put the name
1138 max is the length of the buffer
1139 s points to the first alphabetic character of the name
1140 extras chars other than alphanumerics to permit
1142 Returns: pointer to the first character after the name
1144 Note: The test for *s != 0 in the while loop is necessary because
1145 Ustrchr() yields non-NULL if the character is zero (which is not something
1148 static const uschar *
1149 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1152 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1154 if (ptr < max-1) name[ptr++] = *s;
1163 /*************************************************
1164 * Pick out the rest of a header name *
1165 *************************************************/
1167 /* A variable name starting $header_ (or just $h_ for those who like
1168 abbreviations) might not be the complete header name because headers can
1169 contain any printing characters in their names, except ':'. This function is
1170 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1171 on the end, if the name was terminated by white space.
1174 name points to a buffer in which the name read so far exists
1175 max is the length of the buffer
1176 s points to the first character after the name so far, i.e. the
1177 first non-alphameric character after $header_xxxxx
1179 Returns: a pointer to the first character after the header name
1182 static const uschar *
1183 read_header_name(uschar *name, int max, const uschar *s)
1185 int prelen = Ustrchr(name, '_') - name + 1;
1186 int ptr = Ustrlen(name) - prelen;
1187 if (ptr > 0) memmove(name, name+prelen, ptr);
1188 while (mac_isgraph(*s) && *s != ':')
1190 if (ptr < max-1) name[ptr++] = *s;
1201 /*************************************************
1202 * Pick out a number from a string *
1203 *************************************************/
1206 n points to an integer into which to put the number
1207 s points to the first digit of the number
1209 Returns: a pointer to the character after the last digit
1211 /*XXX consider expanding to int_eximarith_t. But the test for
1212 "overbig numbers" in 0002 still needs to overflow it. */
1215 read_number(int *n, uschar *s)
1218 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1222 static const uschar *
1223 read_cnumber(int *n, const uschar *s)
1226 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1232 /*************************************************
1233 * Extract keyed subfield from a string *
1234 *************************************************/
1236 /* The yield is in dynamic store; NULL means that the key was not found.
1239 key points to the name of the key
1240 s points to the string from which to extract the subfield
1242 Returns: NULL if the subfield was not found, or
1243 a pointer to the subfield's data
1247 expand_getkeyed(const uschar * key, const uschar * s)
1249 int length = Ustrlen(key);
1250 Uskip_whitespace(&s);
1252 /* Loop to search for the key */
1258 const uschar * dkey = s;
1260 while (*s && *s != '=' && !isspace(*s)) s++;
1261 dkeylength = s - dkey;
1262 if (Uskip_whitespace(&s) == '=') while (isspace(*++s));
1264 data = string_dequote(&s);
1265 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1268 Uskip_whitespace(&s);
1277 find_var_ent(uschar * name)
1280 int last = var_table_size;
1282 while (last > first)
1284 int middle = (first + last)/2;
1285 int c = Ustrcmp(name, var_table[middle].name);
1287 if (c > 0) { first = middle + 1; continue; }
1288 if (c < 0) { last = middle; continue; }
1289 return &var_table[middle];
1294 /*************************************************
1295 * Extract numbered subfield from string *
1296 *************************************************/
1298 /* Extracts a numbered field from a string that is divided by tokens - for
1299 example a line from /etc/passwd is divided by colon characters. First field is
1300 numbered one. Negative arguments count from the right. Zero returns the whole
1301 string. Returns NULL if there are insufficient tokens in the string
1304 Modifies final argument - this is a dynamically generated string, so that's OK.
1307 field number of field to be extracted,
1308 first field = 1, whole string = 0, last field = -1
1309 separators characters that are used to break string into tokens
1310 s points to the string from which to extract the subfield
1312 Returns: NULL if the field was not found,
1313 a pointer to the field's data inside s (modified to add 0)
1317 expand_gettokened (int field, uschar *separators, uschar *s)
1322 uschar *fieldtext = NULL;
1324 if (field == 0) return s;
1326 /* Break the line up into fields in place; for field > 0 we stop when we have
1327 done the number of fields we want. For field < 0 we continue till the end of
1328 the string, counting the number of fields. */
1330 count = (field > 0)? field : INT_MAX;
1336 /* Previous field was the last one in the string. For a positive field
1337 number, this means there are not enough fields. For a negative field number,
1338 check that there are enough, and scan back to find the one that is wanted. */
1342 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1343 if ((-field) == (INT_MAX - count - 1)) return s;
1347 while (ss[-1] != 0) ss--;
1353 /* Previous field was not last in the string; save its start and put a
1357 len = Ustrcspn(ss, separators);
1368 expand_getlistele(int field, const uschar * list)
1370 const uschar * tlist = list;
1372 /* Tainted mem for the throwaway element copies */
1373 uschar * dummy = store_get(2, GET_TAINTED);
1377 for (field++; string_nextinlist(&tlist, &sep, dummy, 1); ) field++;
1380 if (field == 0) return NULL;
1381 while (--field > 0 && (string_nextinlist(&list, &sep, dummy, 1))) ;
1382 return string_nextinlist(&list, &sep, NULL, 0);
1386 /* Certificate fields, by name. Worry about by-OID later */
1387 /* Names are chosen to not have common prefixes */
1394 uschar * (*getfn)(void * cert, uschar * mod);
1396 static certfield certfields[] =
1397 { /* linear search; no special order */
1398 { US"version", 7, &tls_cert_version },
1399 { US"serial_number", 13, &tls_cert_serial_number },
1400 { US"subject", 7, &tls_cert_subject },
1401 { US"notbefore", 9, &tls_cert_not_before },
1402 { US"notafter", 8, &tls_cert_not_after },
1403 { US"issuer", 6, &tls_cert_issuer },
1404 { US"signature", 9, &tls_cert_signature },
1405 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1406 { US"subj_altname", 12, &tls_cert_subject_altname },
1407 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1408 { US"crl_uri", 7, &tls_cert_crl_uri },
1412 expand_getcertele(uschar * field, uschar * certvar)
1416 if (!(vp = find_var_ent(certvar)))
1418 expand_string_message =
1419 string_sprintf("no variable named \"%s\"", certvar);
1420 return NULL; /* Unknown variable name */
1422 /* NB this stops us passing certs around in variable. Might
1423 want to do that in future */
1424 if (vp->type != vtype_cert)
1426 expand_string_message =
1427 string_sprintf("\"%s\" is not a certificate", certvar);
1428 return NULL; /* Unknown variable name */
1430 if (!*(void **)vp->value)
1433 if (*field >= '0' && *field <= '9')
1434 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1436 for (certfield * cp = certfields;
1437 cp < certfields + nelem(certfields);
1439 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1441 uschar * modifier = *(field += cp->namelen) == ','
1443 return (*cp->getfn)( *(void **)vp->value, modifier );
1446 expand_string_message =
1447 string_sprintf("bad field selector \"%s\" for certextract", field);
1450 #endif /*DISABLE_TLS*/
1452 /*************************************************
1453 * Extract a substring from a string *
1454 *************************************************/
1456 /* Perform the ${substr or ${length expansion operations.
1459 subject the input string
1460 value1 the offset from the start of the input string to the start of
1461 the output string; if negative, count from the right.
1462 value2 the length of the output string, or negative (-1) for unset
1463 if value1 is positive, unset means "all after"
1464 if value1 is negative, unset means "all before"
1465 len set to the length of the returned string
1467 Returns: pointer to the output string, or NULL if there is an error
1471 extract_substr(uschar *subject, int value1, int value2, int *len)
1473 int sublen = Ustrlen(subject);
1475 if (value1 < 0) /* count from right */
1479 /* If the position is before the start, skip to the start, and adjust the
1480 length. If the length ends up negative, the substring is null because nothing
1481 can precede. This falls out naturally when the length is unset, meaning "all
1487 if (value2 < 0) value2 = 0;
1491 /* Otherwise an unset length => characters before value1 */
1493 else if (value2 < 0)
1500 /* For a non-negative offset, if the starting position is past the end of the
1501 string, the result will be the null string. Otherwise, an unset length means
1502 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1506 if (value1 > sublen)
1511 else if (value2 < 0) value2 = sublen;
1514 /* Cut the length down to the maximum possible for the offset value, and get
1515 the required characters. */
1517 if (value1 + value2 > sublen) value2 = sublen - value1;
1519 return subject + value1;
1525 /*************************************************
1526 * Old-style hash of a string *
1527 *************************************************/
1529 /* Perform the ${hash expansion operation.
1532 subject the input string (an expanded substring)
1533 value1 the length of the output string; if greater or equal to the
1534 length of the input string, the input string is returned
1535 value2 the number of hash characters to use, or 26 if negative
1536 len set to the length of the returned string
1538 Returns: pointer to the output string, or NULL if there is an error
1542 compute_hash(uschar *subject, int value1, int value2, int *len)
1544 int sublen = Ustrlen(subject);
1546 if (value2 < 0) value2 = 26;
1547 else if (value2 > Ustrlen(hashcodes))
1549 expand_string_message =
1550 string_sprintf("hash count \"%d\" too big", value2);
1554 /* Calculate the hash text. We know it is shorter than the original string, so
1555 can safely place it in subject[] (we know that subject is always itself an
1556 expanded substring). */
1558 if (value1 < sublen)
1563 while ((c = (subject[j])) != 0)
1565 int shift = (c + j++) & 7;
1566 subject[i] ^= (c << shift) | (c >> (8-shift));
1567 if (++i >= value1) i = 0;
1569 for (i = 0; i < value1; i++)
1570 subject[i] = hashcodes[(subject[i]) % value2];
1572 else value1 = sublen;
1581 /*************************************************
1582 * Numeric hash of a string *
1583 *************************************************/
1585 /* Perform the ${nhash expansion operation. The first characters of the
1586 string are treated as most important, and get the highest prime numbers.
1589 subject the input string
1590 value1 the maximum value of the first part of the result
1591 value2 the maximum value of the second part of the result,
1592 or negative to produce only a one-part result
1593 len set to the length of the returned string
1595 Returns: pointer to the output string, or NULL if there is an error.
1599 compute_nhash (uschar *subject, int value1, int value2, int *len)
1601 uschar *s = subject;
1603 unsigned long int total = 0; /* no overflow */
1607 if (i == 0) i = nelem(prime) - 1;
1608 total += prime[i--] * (unsigned int)(*s++);
1611 /* If value2 is unset, just compute one number */
1614 s = string_sprintf("%lu", total % value1);
1616 /* Otherwise do a div/mod hash */
1620 total = total % (value1 * value2);
1621 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1632 /*************************************************
1633 * Find the value of a header or headers *
1634 *************************************************/
1636 /* Multiple instances of the same header get concatenated, and this function
1637 can also return a concatenation of all the header lines. When concatenating
1638 specific headers that contain lists of addresses, a comma is inserted between
1639 them. Otherwise we use a straight concatenation. Because some messages can have
1640 pathologically large number of lines, there is a limit on the length that is
1644 name the name of the header, without the leading $header_ or $h_,
1645 or NULL if a concatenation of all headers is required
1646 newsize return the size of memory block that was obtained; may be NULL
1647 if exists_only is TRUE
1648 flags FH_EXISTS_ONLY
1649 set if called from a def: test; don't need to build a string;
1650 just return a string that is not "" and not "0" if the header
1653 set if called for $rh_ or $rheader_ items; no processing,
1654 other than concatenating, will be done on the header. Also used
1655 for $message_headers_raw.
1657 Double colon chars in the content, and replace newline with
1658 colon between each element when concatenating; returning a
1659 colon-sep list (elements might contain newlines)
1660 charset name of charset to translate MIME words to; used only if
1661 want_raw is false; if NULL, no translation is done (this is
1662 used for $bh_ and $bheader_)
1664 Returns: NULL if the header does not exist, else a pointer to a new
1669 find_header(uschar *name, int *newsize, unsigned flags, const uschar *charset)
1672 int len = name ? Ustrlen(name) : 0;
1676 for (header_line * h = header_list; h; h = h->next)
1677 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1678 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1683 if (flags & FH_EXISTS_ONLY)
1684 return US"1"; /* don't need actual string */
1687 s = h->text + len; /* text to insert */
1688 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1689 Uskip_whitespace(&s); /* remove leading white space */
1690 t = h->text + h->slen; /* end-point */
1692 /* Unless wanted raw, remove trailing whitespace, including the
1695 if (flags & FH_WANT_LIST)
1696 while (t > s && t[-1] == '\n') t--;
1697 else if (!(flags & FH_WANT_RAW))
1699 while (t > s && isspace(t[-1])) t--;
1701 /* Set comma if handling a single header and it's one of those
1702 that contains an address list, except when asked for raw headers. Only
1703 need to do this once. */
1705 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1708 /* Trim the header roughly if we're approaching limits */
1710 if (gstring_length(g) + inc > header_insert_maxlen)
1711 inc = header_insert_maxlen - gstring_length(g);
1713 /* For raw just copy the data; for a list, add the data as a colon-sep
1714 list-element; for comma-list add as an unchecked comma,newline sep
1715 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1716 stripped trailing WS above including the newline). We ignore the potential
1717 expansion due to colon-doubling, just leaving the loop if the limit is met
1720 if (flags & FH_WANT_LIST)
1721 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1722 else if (flags & FH_WANT_RAW)
1723 g = string_catn(g, s, (unsigned)inc);
1725 g = string_append2_listele_n(g, comma ? US",\n" : US"\n",
1728 if (gstring_length(g) >= header_insert_maxlen) break;
1731 if (!found) return NULL; /* No header found */
1732 if (!g) return US"";
1734 /* That's all we do for raw header expansion. */
1737 if (flags & FH_WANT_RAW)
1738 return string_from_gstring(g);
1740 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1741 The rfc2047_decode2() function can return an error with decoded data if the
1742 charset translation fails. If decoding fails, it returns NULL. */
1746 uschar * error, * decoded = rfc2047_decode2(string_from_gstring(g),
1747 check_rfc2047_length, charset, '?', NULL, newsize, &error);
1749 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1750 " input was: %s\n", error, g->s);
1751 return decoded ? decoded : string_from_gstring(g);
1758 /* Append a "local" element to an Authentication-Results: header
1759 if this was a non-smtp message.
1763 authres_local(gstring * g, const uschar * sysname)
1765 if (!f.authentication_local)
1767 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1768 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1773 /* Append an "iprev" element to an Authentication-Results: header
1774 if we have attempted to get the calling host's name.
1778 authres_iprev(gstring * g)
1780 if (sender_host_name)
1781 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1782 else if (host_lookup_deferred)
1783 g = string_cat(g, US";\n\tiprev=temperror");
1784 else if (host_lookup_failed)
1785 g = string_cat(g, US";\n\tiprev=fail");
1789 if (sender_host_address)
1790 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1796 /*************************************************
1797 * Return list of recipients *
1798 *************************************************/
1799 /* A recipients list is available only during system message filtering,
1800 during ACL processing after DATA, and while expanding pipe commands
1801 generated from a system filter, but not elsewhere. */
1809 if (!f.enable_dollar_recipients) return NULL;
1811 for (int i = 0; i < recipients_count; i++)
1813 s = recipients_list[i].address;
1814 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1816 return g ? g->s : NULL;
1820 /*************************************************
1821 * Return size of queue *
1822 *************************************************/
1823 /* Ask the daemon for the queue size */
1828 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1832 const uschar * where;
1835 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
1837 DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));
1841 len = daemon_client_sockname(&sa_un, &sname);
1843 if (bind(fd, (const struct sockaddr *)&sa_un, (socklen_t)len) < 0)
1844 { where = US"bind"; goto bad; }
1847 debug_printf("local addr '%s%s'\n",
1848 *sa_un.sun_path ? "" : "@",
1849 sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1852 len = daemon_notifier_sockname(&sa_un);
1853 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
1854 { where = US"connect"; goto bad2; }
1856 buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1857 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1859 if (poll_one_fd(fd, POLLIN, 2 * 1000) != 1)
1861 DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1862 len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1864 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1865 { where = US"recv"; goto bad2; }
1868 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1871 return string_copyn(buf, len);
1874 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1879 DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1884 /*************************************************
1885 * Find value of a variable *
1886 *************************************************/
1888 /* The table of variables is kept in alphabetic order, so we can search it
1889 using a binary chop. The "choplen" variable is nothing to do with the binary
1893 name the name of the variable being sought
1894 exists_only TRUE if this is a def: test; passed on to find_header()
1895 skipping TRUE => skip any processing evaluation; this is not the same as
1896 exists_only because def: may test for values that are first
1898 newsize pointer to an int which is initially zero; if the answer is in
1899 a new memory buffer, *newsize is set to its size
1901 Returns: NULL if the variable does not exist, or
1902 a pointer to the variable's contents, or
1903 something non-NULL if exists_only is TRUE
1906 static const uschar *
1907 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1914 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1915 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1916 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1917 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1918 (this gave backwards compatibility at the changeover). There may be built-in
1919 variables whose names start acl_ but they should never start in this way. This
1920 slightly messy specification is a consequence of the history, needless to say.
1922 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1923 set, in which case give an error. */
1925 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1929 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1930 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1932 else if (Ustrncmp(name, "r_", 2) == 0)
1934 tree_node * node = tree_search(router_var, name + 2);
1935 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1938 /* Handle $auth<n>, $regex<n> variables. */
1940 if (Ustrncmp(name, "auth", 4) == 0)
1943 int n = Ustrtoul(name + 4, &endptr, 10);
1944 if (!*endptr && n != 0 && n <= AUTH_VARS)
1945 return auth_vars[n-1] ? auth_vars[n-1] : US"";
1947 #ifdef WITH_CONTENT_SCAN
1948 else if (Ustrncmp(name, "regex", 5) == 0)
1951 int n = Ustrtoul(name + 5, &endptr, 10);
1952 if (!*endptr && n != 0 && n <= REGEX_VARS)
1953 return regex_vars[n-1] ? regex_vars[n-1] : US"";
1957 /* For all other variables, search the table */
1959 if (!(vp = find_var_ent(name)))
1960 return NULL; /* Unknown variable name */
1962 /* Found an existing variable. If in skipping state, the value isn't needed,
1963 and we want to avoid processing (such as looking up the host name). */
1971 case vtype_filter_int:
1972 if (!f.filter_running) return NULL;
1976 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1980 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1984 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1988 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1992 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1995 case vtype_stringptr: /* Pointer to string */
1996 return (s = *((uschar **)(val))) ? s : US"";
1999 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
2002 case vtype_load_avg:
2003 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
2006 case vtype_host_lookup: /* Lookup if not done so */
2007 if ( !sender_host_name && sender_host_address
2008 && !host_lookup_failed && host_name_lookup() == OK)
2009 host_build_sender_fullhost();
2010 return sender_host_name ? sender_host_name : US"";
2012 case vtype_localpart: /* Get local part from address */
2013 if (!(s = *((uschar **)(val)))) return US"";
2014 if (!(domain = Ustrrchr(s, '@'))) return s;
2015 if (domain - s > sizeof(var_buffer) - 1)
2016 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
2017 " in string expansion", sizeof(var_buffer));
2018 return string_copyn(s, domain - s);
2020 case vtype_domain: /* Get domain from address */
2021 if (!(s = *((uschar **)(val)))) return US"";
2022 domain = Ustrrchr(s, '@');
2023 return domain ? domain + 1 : US"";
2025 case vtype_msgheaders:
2026 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
2028 case vtype_msgheaders_raw:
2029 return find_header(NULL, newsize,
2030 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
2032 case vtype_msgbody: /* Pointer to msgbody string */
2033 case vtype_msgbody_end: /* Ditto, the end of the msg */
2034 ss = (uschar **)(val);
2035 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
2038 off_t start_offset = SPOOL_DATA_START_OFFSET;
2039 int len = message_body_visible;
2041 if (len > message_size) len = message_size;
2042 *ss = body = store_get(len+1, GET_TAINTED);
2044 if (vp->type == vtype_msgbody_end)
2046 struct stat statbuf;
2047 if (fstat(deliver_datafile, &statbuf) == 0)
2049 start_offset = statbuf.st_size - len;
2050 if (start_offset < SPOOL_DATA_START_OFFSET)
2051 start_offset = SPOOL_DATA_START_OFFSET;
2054 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
2055 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
2057 if ((len = read(deliver_datafile, body, len)) > 0)
2060 if (message_body_newlines) /* Separate loops for efficiency */
2062 { if (body[--len] == 0) body[len] = ' '; }
2065 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
2068 return *ss ? *ss : US"";
2070 case vtype_todbsdin: /* BSD inbox time of day */
2071 return tod_stamp(tod_bsdin);
2073 case vtype_tode: /* Unix epoch time of day */
2074 return tod_stamp(tod_epoch);
2076 case vtype_todel: /* Unix epoch/usec time of day */
2077 return tod_stamp(tod_epoch_l);
2079 case vtype_todf: /* Full time of day */
2080 return tod_stamp(tod_full);
2082 case vtype_todl: /* Log format time of day */
2083 return tod_stamp(tod_log_bare); /* (without timezone) */
2085 case vtype_todzone: /* Time zone offset only */
2086 return tod_stamp(tod_zone);
2088 case vtype_todzulu: /* Zulu time */
2089 return tod_stamp(tod_zulu);
2091 case vtype_todlf: /* Log file datestamp tod */
2092 return tod_stamp(tod_log_datestamp_daily);
2094 case vtype_reply: /* Get reply address */
2095 s = find_header(US"reply-to:", newsize,
2096 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2098 if (s) Uskip_whitespace(&s);
2101 *newsize = 0; /* For the *s==0 case */
2102 s = find_header(US"from:", newsize,
2103 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2109 Uskip_whitespace(&s);
2110 for (t = s; *t; t++) if (*t == '\n') *t = ' ';
2111 while (t > s && isspace(t[-1])) t--;
2114 return s ? s : US"";
2116 case vtype_string_func:
2118 stringptr_fn_t * fn = (stringptr_fn_t *) val;
2120 return s ? s : US"";
2126 sprintf(CS var_buffer, PR_EXIM_ARITH,
2127 receive_statvfs(val == (void *)TRUE, &inodes));
2134 (void) receive_statvfs(val == (void *)TRUE, &inodes);
2135 sprintf(CS var_buffer, "%d", inodes);
2140 return *(void **)val ? US"<cert>" : US"";
2142 #ifndef DISABLE_DKIM
2144 return dkim_exim_expand_query((int)(long)val);
2149 return NULL; /* Unknown variable. Silences static checkers. */
2156 modify_variable(uschar *name, void * value)
2159 if ((vp = find_var_ent(name))) vp->value = value;
2160 return; /* Unknown variable name, fail silently */
2168 /*************************************************
2169 * Read and expand substrings *
2170 *************************************************/
2172 /* This function is called to read and expand argument substrings for various
2173 expansion items. Some have a minimum requirement that is less than the maximum;
2174 in these cases, the first non-present one is set to NULL.
2177 sub points to vector of pointers to set
2178 n maximum number of substrings
2180 sptr points to current string pointer
2182 skipping the skipping flag
2183 check_end if TRUE, check for final '}'
2184 name name of item, for error message
2185 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2187 textonly_p if not NULL, pointer to bitmask of which subs were text-only
2188 (did not change when expended)
2190 Returns: -1 OK; string pointer updated, but in "skipping" mode
2191 0 OK; string pointer updated
2192 1 curly bracketing error (too few arguments)
2193 2 too many arguments (only if check_end is set); message set
2194 3 other error (expansion failure)
2198 read_subs(uschar ** sub, int n, int m, const uschar ** sptr, esi_flags flags,
2199 BOOL check_end, uschar * name, BOOL * resetok, unsigned * textonly_p)
2201 const uschar * s = *sptr;
2202 unsigned textonly_l = 0;
2204 Uskip_whitespace(&s);
2205 for (int i = 0; i < n; i++)
2212 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2213 "(min is %d)", name, m);
2219 if (!(sub[i] = expand_string_internal(s+1,
2220 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, &s, resetok,
2221 textonly_p ? &textonly : NULL)))
2223 if (*s++ != '}') return 1;
2224 if (textonly_p && textonly) textonly_l |= BIT(i);
2225 Uskip_whitespace(&s);
2227 if (check_end && *s++ != '}')
2231 expand_string_message = string_sprintf("Too many arguments for '%s' "
2232 "(max is %d)", name, n);
2235 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2239 if (textonly_p) *textonly_p = textonly_l;
2241 return flags & ESI_SKIPPING ? -1 : 0;
2247 /*************************************************
2248 * Elaborate message for bad variable *
2249 *************************************************/
2251 /* For the "unknown variable" message, take a look at the variable's name, and
2252 give additional information about possible ACL variables. The extra information
2253 is added on to expand_string_message.
2255 Argument: the name of the variable
2260 check_variable_error_message(uschar *name)
2262 if (Ustrncmp(name, "acl_", 4) == 0)
2263 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2264 (name[4] == 'c' || name[4] == 'm')?
2266 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2267 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2269 US"user-defined ACL variables must start acl_c or acl_m");
2275 Load args from sub array to globals, and call acl_check().
2276 Sub array will be corrupted on return.
2278 Returns: OK access is granted by an ACCEPT verb
2279 DISCARD access is (apparently) granted by a DISCARD verb
2280 FAIL access is denied
2281 FAIL_DROP access is denied; drop the connection
2282 DEFER can't tell at the moment
2286 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2289 int sav_narg = acl_narg;
2291 uschar * dummy_logmsg;
2292 extern int acl_where;
2294 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2295 for (i = 0; i < nsub && sub[i+1]; i++)
2297 uschar * tmp = acl_arg[i];
2298 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2299 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2304 sub[i+1] = acl_arg[i];
2305 acl_arg[i++] = NULL;
2309 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2311 acl_narg>0 ? acl_arg[0] : US"<none>",
2312 acl_narg>1 ? " +more" : "");
2314 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2316 for (i = 0; i < nsub; i++)
2317 acl_arg[i] = sub[i+1]; /* restore old args */
2318 acl_narg = sav_narg;
2326 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2327 The given string is modified on return. Leading whitespace is skipped while
2328 looking for the opening wrap character, then the rest is scanned for the trailing
2329 (non-escaped) wrap character. A backslash in the string will act as an escape.
2331 A nul is written over the trailing wrap, and a pointer to the char after the
2332 leading wrap is returned.
2335 s String for de-wrapping
2336 wrap Two-char string, the first being the opener, second the closer wrapping
2339 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2343 dewrap(uschar * s, const uschar * wrap)
2347 BOOL quotesmode = wrap[0] == wrap[1];
2349 if (Uskip_whitespace(&p) == *wrap)
2355 if (*p == '\\') p++;
2356 else if (!quotesmode && *p == wrap[-1]) depth++;
2357 else if (*p == *wrap)
2368 expand_string_message = string_sprintf("missing '%c'", *wrap);
2373 /* Pull off the leading array or object element, returning
2374 a copy in an allocated string. Update the list pointer.
2376 The element may itself be an abject or array.
2377 Return NULL when the list is empty.
2381 json_nextinlist(const uschar ** list)
2383 unsigned array_depth = 0, object_depth = 0;
2384 const uschar * s = *list, * item;
2386 skip_whitespace(&s);
2389 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2393 case '[': array_depth++; break;
2394 case ']': array_depth--; break;
2395 case '{': object_depth++; break;
2396 case '}': object_depth--; break;
2398 *list = *s ? s+1 : s;
2399 if (item == s) return NULL;
2400 item = string_copyn(item, s - item);
2401 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2407 /************************************************/
2408 /* Return offset in ops table, or -1 if not found.
2409 Repoint to just after the operator in the string.
2412 ss string representation of operator
2413 opname split-out operator name
2417 identify_operator(const uschar ** ss, uschar ** opname)
2419 const uschar * s = *ss;
2422 /* Numeric comparisons are symbolic */
2424 if (*s == '=' || *s == '>' || *s == '<')
2436 /* All other conditions are named */
2439 s = read_name(name, sizeof(name), s, US"_");
2442 /* If we haven't read a name, it means some non-alpha character is first. */
2446 expand_string_message = string_sprintf("condition name expected, "
2447 "but found \"%.16s\"", s);
2451 *opname = string_copy(name);
2453 return chop_match(name, cond_table, nelem(cond_table));
2457 /*************************************************
2458 * Handle MD5 or SHA-1 computation for HMAC *
2459 *************************************************/
2461 /* These are some wrapping functions that enable the HMAC code to be a bit
2462 cleaner. A good compiler will spot the tail recursion.
2465 type HMAC_MD5 or HMAC_SHA1
2466 remaining are as for the cryptographic hash functions
2472 chash_start(int type, void * base)
2474 if (type == HMAC_MD5)
2475 md5_start((md5 *)base);
2477 sha1_start((hctx *)base);
2481 chash_mid(int type, void * base, const uschar * string)
2483 if (type == HMAC_MD5)
2484 md5_mid((md5 *)base, string);
2486 sha1_mid((hctx *)base, string);
2490 chash_end(int type, void * base, const uschar * string, int length,
2493 if (type == HMAC_MD5)
2494 md5_end((md5 *)base, string, length, digest);
2496 sha1_end((hctx *)base, string, length, digest);
2503 /* Do an hmac_md5. The result is _not_ nul-terminated, and is sized as
2504 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2507 key encoding key, nul-terminated
2508 src data to be hashed, nul-terminated
2510 len size of output buffer
2514 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2517 const uschar * keyptr;
2519 unsigned int keylen;
2521 #define MD5_HASHLEN 16
2522 #define MD5_HASHBLOCKLEN 64
2524 uschar keyhash[MD5_HASHLEN];
2525 uschar innerhash[MD5_HASHLEN];
2526 uschar finalhash[MD5_HASHLEN];
2527 uschar innerkey[MD5_HASHBLOCKLEN];
2528 uschar outerkey[MD5_HASHBLOCKLEN];
2531 keylen = Ustrlen(keyptr);
2533 /* If the key is longer than the hash block length, then hash the key
2536 if (keylen > MD5_HASHBLOCKLEN)
2538 chash_start(HMAC_MD5, &md5_base);
2539 chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2541 keylen = MD5_HASHLEN;
2544 /* Now make the inner and outer key values */
2546 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2547 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2549 for (int i = 0; i < keylen; i++)
2551 innerkey[i] ^= keyptr[i];
2552 outerkey[i] ^= keyptr[i];
2555 /* Now do the hashes */
2557 chash_start(HMAC_MD5, &md5_base);
2558 chash_mid(HMAC_MD5, &md5_base, innerkey);
2559 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2561 chash_start(HMAC_MD5, &md5_base);
2562 chash_mid(HMAC_MD5, &md5_base, outerkey);
2563 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2565 /* Encode the final hash as a hex string, limited by output buffer size */
2568 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2570 if (j-- <= 0) break;
2571 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2572 if (j-- <= 0) break;
2573 *p++ = hex_digits[finalhash[i] & 0x0f];
2577 #endif /*SUPPORT_SRS*/
2580 /*************************************************
2581 * Read and evaluate a condition *
2582 *************************************************/
2586 s points to the start of the condition text
2587 resetok points to a BOOL which is written false if it is unsafe to
2588 free memory. Certain condition types (acl) may have side-effect
2589 allocation which must be preserved.
2590 yield points to a BOOL to hold the result of the condition test;
2591 if NULL, we are just reading through a condition that is
2592 part of an "or" combination to check syntax, or in a state
2593 where the answer isn't required
2595 Returns: a pointer to the first character after the condition, or
2599 static const uschar *
2600 eval_condition(const uschar * s, BOOL * resetok, BOOL * yield)
2602 BOOL testfor = TRUE;
2603 BOOL tempcond, combined_cond;
2605 BOOL sub2_honour_dollar = TRUE;
2606 BOOL is_forany, is_json, is_jsons;
2608 int_eximarith_t num[2];
2609 struct stat statbuf;
2612 const uschar * sub[10];
2613 unsigned sub_textonly = 0;
2616 if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;
2618 switch(cond_type = identify_operator(&s, &opname))
2620 /* def: tests for a non-empty variable, or for the existence of a header. If
2621 yield == NULL we are in a skipping state, and don't care about the answer. */
2629 expand_string_message = US"\":\" expected after \"def\"";
2633 s = read_name(name, sizeof(name), s+1, US"_");
2635 /* Test for a header's existence. If the name contains a closing brace
2636 character, this may be a user error where the terminating colon has been
2637 omitted. Set a flag to adjust a subsequent error message in this case. */
2639 if ( ( *(t = name) == 'h'
2640 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2642 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2645 s = read_header_name(name, sizeof(name), s);
2646 /* {-for-text-editors */
2647 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2649 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2652 /* Test for a variable's having a non-empty value. A non-existent variable
2653 causes an expansion failure. */
2657 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2659 expand_string_message = name[0]
2660 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2661 : US"variable name omitted after \"def:\"";
2662 check_variable_error_message(name);
2665 if (yield) *yield = (t[0] != 0) == testfor;
2672 /* first_delivery tests for first delivery attempt */
2674 case ECOND_FIRST_DELIVERY:
2675 if (yield) *yield = f.deliver_firsttime == testfor;
2679 /* queue_running tests for any process started by a queue runner */
2681 case ECOND_QUEUE_RUNNING:
2682 if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2686 /* exists: tests for file existence
2687 isip: tests for any IP address
2688 isip4: tests for an IPv4 address
2689 isip6: tests for an IPv6 address
2690 pam: does PAM authentication
2691 radius: does RADIUS authentication
2692 ldapauth: does LDAP authentication
2693 pwcheck: does Cyrus SASL pwcheck authentication
2702 case ECOND_LDAPAUTH:
2705 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2709 sub[0] = expand_string_internal(s+1,
2710 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
2711 &s, resetok, &textonly);
2712 if (!sub[0]) return NULL;
2713 if (textonly) sub_textonly |= BIT(0);
2715 /* {-for-text-editors */
2716 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2718 if (!yield) return s; /* No need to run the test if skipping */
2723 if ((expand_forbid & RDO_EXISTS) != 0)
2725 expand_string_message = US"File existence tests are not permitted";
2728 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2734 rc = string_is_ip_address(sub[0], NULL);
2735 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2736 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2739 /* Various authentication tests - all optionally compiled */
2743 rc = auth_call_pam(sub[0], &expand_string_message);
2746 goto COND_FAILED_NOT_COMPILED;
2747 #endif /* SUPPORT_PAM */
2750 #ifdef RADIUS_CONFIG_FILE
2751 rc = auth_call_radius(sub[0], &expand_string_message);
2754 goto COND_FAILED_NOT_COMPILED;
2755 #endif /* RADIUS_CONFIG_FILE */
2757 case ECOND_LDAPAUTH:
2760 /* Just to keep the interface the same */
2762 int old_pool = store_pool;
2763 store_pool = POOL_SEARCH;
2764 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2765 &expand_string_message, &do_cache);
2766 store_pool = old_pool;
2770 goto COND_FAILED_NOT_COMPILED;
2771 #endif /* LOOKUP_LDAP */
2774 #ifdef CYRUS_PWCHECK_SOCKET
2775 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2778 goto COND_FAILED_NOT_COMPILED;
2779 #endif /* CYRUS_PWCHECK_SOCKET */
2781 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2782 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2784 if (rc == ERROR || rc == DEFER) return NULL;
2785 *yield = (rc == OK) == testfor;
2791 /* call ACL (in a conditional context). Accept true, deny false.
2792 Defer is a forced-fail. Anything set by message= goes to $value.
2793 Up to ten parameters are used; we use the braces round the name+args
2794 like the saslauthd condition does, to permit a variable number of args.
2795 See also the expansion-item version EITEM_ACL and the traditional
2796 acl modifier ACLC_ACL.
2797 Since the ACL may allocate new global variables, tell our caller to not
2802 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2808 Uskip_whitespace(&s);
2809 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2811 switch(read_subs(sub, nelem(sub), 1, &s,
2812 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2814 case 1: expand_string_message = US"too few arguments or bracketing "
2817 case 3: return NULL;
2823 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2824 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2829 lookup_value = NULL;
2831 lookup_value = string_copy(user_msg);
2832 *yield = cond == testfor;
2836 f.expand_string_forcedfail = TRUE;
2839 expand_string_message = string_sprintf("%s from acl \"%s\"",
2840 rc_names[rc], sub[0]);
2848 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2850 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2852 However, the last two are optional. That is why the whole set is enclosed
2853 in their own set of braces. */
2855 case ECOND_SASLAUTHD:
2856 #ifndef CYRUS_SASLAUTHD_SOCKET
2857 goto COND_FAILED_NOT_COMPILED;
2861 Uskip_whitespace(&s);
2862 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2863 switch(read_subs(sub, nelem(sub), 2, &s,
2864 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2866 case 1: expand_string_message = US"too few arguments or bracketing "
2867 "error for saslauthd";
2869 case 3: return NULL;
2871 if (!sub[2]) sub[3] = NULL; /* realm if no service */
2874 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2875 &expand_string_message);
2876 if (rc == ERROR || rc == DEFER) return NULL;
2877 *yield = (rc == OK) == testfor;
2881 #endif /* CYRUS_SASLAUTHD_SOCKET */
2884 /* symbolic operators for numeric and string comparison, and a number of
2885 other operators, all requiring two arguments.
2887 crypteq: encrypts plaintext and compares against an encrypted text,
2888 using crypt(), crypt16(), MD5 or SHA-1
2889 inlist/inlisti: checks if first argument is in the list of the second
2890 match: does a regular expression match and sets up the numerical
2891 variables if it succeeds
2892 match_address: matches in an address list
2893 match_domain: matches in a domain list
2894 match_ip: matches a host list that is restricted to IP addresses
2895 match_local_part: matches in a local part list
2898 case ECOND_MATCH_ADDRESS:
2899 case ECOND_MATCH_DOMAIN:
2900 case ECOND_MATCH_IP:
2901 case ECOND_MATCH_LOCAL_PART:
2902 #ifndef EXPAND_LISTMATCH_RHS
2903 sub2_honour_dollar = FALSE;
2912 case ECOND_NUM_L: /* Numerical comparisons */
2919 case ECOND_STR_LT: /* String comparisons */
2930 for (int i = 0; i < 2; i++)
2933 /* Sometimes, we don't expand substrings; too many insecure configurations
2934 created using match_address{}{} and friends, where the second param
2935 includes information from untrustworthy sources. */
2936 /*XXX is this moot given taint-tracking? */
2938 esi_flags flags = ESI_BRACE_ENDS;
2940 if (!(i > 0 && !sub2_honour_dollar)) flags |= ESI_HONOR_DOLLAR;
2941 if (!yield) flags |= ESI_SKIPPING;
2943 if (Uskip_whitespace(&s) != '{')
2945 if (i == 0) goto COND_FAILED_CURLY_START;
2946 expand_string_message = string_sprintf("missing 2nd string in {} "
2947 "after \"%s\"", opname);
2950 if (!(sub[i] = expand_string_internal(s+1, flags, &s, resetok, &textonly)))
2952 if (textonly) sub_textonly |= BIT(i);
2953 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2954 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2955 " for security reasons\n");
2956 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2958 /* Convert to numerical if required; we know that the names of all the
2959 conditions that compare numbers do not start with a letter. This just saves
2960 checking for them individually. */
2962 if (!isalpha(opname[0]) && yield)
2967 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2971 num[i] = expanded_string_integer(sub[i], FALSE);
2972 if (expand_string_message) return NULL;
2976 /* Result not required */
2978 if (!yield) return s;
2980 /* Do an appropriate comparison */
2986 tempcond = (num[0] == num[1]); break;
2989 tempcond = (num[0] > num[1]); break;
2992 tempcond = (num[0] >= num[1]); break;
2995 tempcond = (num[0] < num[1]); break;
2998 tempcond = (num[0] <= num[1]); break;
3001 tempcond = (Ustrcmp(sub[0], sub[1]) < 0); break;
3004 tempcond = (strcmpic(sub[0], sub[1]) < 0); break;
3007 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0); break;
3010 tempcond = (strcmpic(sub[0], sub[1]) <= 0); break;
3013 tempcond = (Ustrcmp(sub[0], sub[1]) == 0); break;
3016 tempcond = (strcmpic(sub[0], sub[1]) == 0); break;
3019 tempcond = (Ustrcmp(sub[0], sub[1]) > 0); break;
3022 tempcond = (strcmpic(sub[0], sub[1]) > 0); break;
3025 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0); break;
3028 tempcond = (strcmpic(sub[0], sub[1]) >= 0); break;
3030 case ECOND_MATCH: /* Regular expression match */
3032 const pcre2_code * re = regex_compile(sub[1],
3033 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
3034 &expand_string_message, pcre_gen_cmp_ctx);
3038 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
3042 case ECOND_MATCH_ADDRESS: /* Match in an address list */
3043 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0,
3044 CUSS &lookup_value);
3045 goto MATCHED_SOMETHING;
3047 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
3048 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
3049 MCL_DOMAIN + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3050 goto MATCHED_SOMETHING;
3052 case ECOND_MATCH_IP: /* Match IP address in a host list */
3053 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
3055 expand_string_message = string_sprintf("\"%s\" is not an IP address",
3061 unsigned int *nullcache = NULL;
3062 check_host_block cb;
3064 cb.host_name = US"";
3065 cb.host_address = sub[0];
3067 /* If the host address starts off ::ffff: it is an IPv6 address in
3068 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3071 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3072 cb.host_address + 7 : cb.host_address;
3074 rc = match_check_list(
3075 &sub[1], /* the list */
3076 0, /* separator character */
3077 &hostlist_anchor, /* anchor pointer */
3078 &nullcache, /* cache pointer */
3079 check_host, /* function for testing */
3080 &cb, /* argument for function */
3081 MCL_HOST, /* type of check */
3082 sub[0], /* text for debugging */
3083 CUSS &lookup_value); /* where to pass back data */
3085 goto MATCHED_SOMETHING;
3087 case ECOND_MATCH_LOCAL_PART:
3088 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3089 MCL_LOCALPART + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3095 case OK: tempcond = TRUE; break;
3096 case FAIL: tempcond = FALSE; break;
3099 expand_string_message = string_sprintf("unable to complete match "
3100 "against \"%s\": %s", sub[1], search_error_message);
3106 /* Various "encrypted" comparisons. If the second string starts with
3107 "{" then an encryption type is given. Default to crypt() or crypt16()
3108 (build-time choice). */
3109 /* }-for-text-editors */
3112 #ifndef SUPPORT_CRYPTEQ
3113 goto COND_FAILED_NOT_COMPILED;
3115 if (strncmpic(sub[1], US"{md5}", 5) == 0)
3117 int sublen = Ustrlen(sub[1]+5);
3122 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3124 /* If the length that we are comparing against is 24, the MD5 digest
3125 is expressed as a base64 string. This is the way LDAP does it. However,
3126 some other software uses a straightforward hex representation. We assume
3127 this if the length is 32. Other lengths fail. */
3131 uschar *coded = b64encode(CUS digest, 16);
3132 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3133 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3134 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3136 else if (sublen == 32)
3139 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3141 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3142 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3143 tempcond = (strcmpic(coded, sub[1]+5) == 0);
3147 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3148 "fail\n crypted=%s\n", sub[1]+5);
3153 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3155 int sublen = Ustrlen(sub[1]+6);
3160 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3162 /* If the length that we are comparing against is 28, assume the SHA1
3163 digest is expressed as a base64 string. If the length is 40, assume a
3164 straightforward hex representation. Other lengths fail. */
3168 uschar *coded = b64encode(CUS digest, 20);
3169 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3170 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3171 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3173 else if (sublen == 40)
3176 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3178 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3179 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3180 tempcond = (strcmpic(coded, sub[1]+6) == 0);
3184 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3185 "fail\n crypted=%s\n", sub[1]+6);
3190 else /* {crypt} or {crypt16} and non-{ at start */
3191 /* }-for-text-editors */
3196 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3201 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3206 else if (sub[1][0] == '{') /* }-for-text-editors */
3208 expand_string_message = string_sprintf("unknown encryption mechanism "
3209 "in \"%s\"", sub[1]);
3215 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3216 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
3217 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3221 #define XSTR(s) STR(s)
3222 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3223 " subject=%s\n crypted=%s\n",
3224 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3229 /* If the encrypted string contains fewer than two characters (for the
3230 salt), force failure. Otherwise we get false positives: with an empty
3231 string the yield of crypt() is an empty string! */
3234 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3235 else if (errno == EINVAL)
3239 expand_string_message = string_sprintf("crypt error: %s\n",
3240 US strerror(errno));
3245 #endif /* SUPPORT_CRYPTEQ */
3250 const uschar * list = sub[1];
3252 uschar *save_iterate_item = iterate_item;
3253 int (*compare)(const uschar *, const uschar *);
3255 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);
3258 compare = cond_type == ECOND_INLISTI
3259 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3261 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3263 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3264 if (compare(sub[0], iterate_item) == 0)
3267 lookup_value = iterate_item;
3271 iterate_item = save_iterate_item;
3274 } /* Switch for comparison conditions */
3276 *yield = tempcond == testfor;
3277 return s; /* End of comparison conditions */
3280 /* and/or: computes logical and/or of several conditions */
3284 subcondptr = (yield == NULL) ? NULL : &tempcond;
3285 combined_cond = (cond_type == ECOND_AND);
3287 Uskip_whitespace(&s);
3288 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3292 /* {-for-text-editors */
3293 if (Uskip_whitespace(&s) == '}') break;
3294 if (*s != '{') /* }-for-text-editors */
3296 expand_string_message = string_sprintf("each subcondition "
3297 "inside an \"%s{...}\" condition must be in its own {}", opname);
3301 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3303 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3304 expand_string_message, opname);
3307 Uskip_whitespace(&s);
3309 /* {-for-text-editors */
3312 /* {-for-text-editors */
3313 expand_string_message = string_sprintf("missing } at end of condition "
3314 "inside \"%s\" group", opname);
3319 if (cond_type == ECOND_AND)
3321 combined_cond &= tempcond;
3322 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3323 } /* evaluate any more */
3326 combined_cond |= tempcond;
3327 if (combined_cond) subcondptr = NULL; /* once true, don't */
3328 } /* evaluate any more */
3331 if (yield) *yield = (combined_cond == testfor);
3335 /* forall/forany: iterates a condition with different values */
3337 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3338 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3339 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3340 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3341 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3342 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3346 const uschar * list;
3348 uschar *save_iterate_item = iterate_item;
3350 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3352 Uskip_whitespace(&s);
3353 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3354 if (!(sub[0] = expand_string_internal(s,
3355 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
3356 &s, resetok, NULL)))
3358 /* {-for-text-editors */
3359 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3361 Uskip_whitespace(&s);
3362 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3366 /* Call eval_condition once, with result discarded (as if scanning a
3367 "false" part). This allows us to find the end of the condition, because if
3368 the list it empty, we won't actually evaluate the condition for real. */
3370 if (!(s = eval_condition(sub[1], resetok, NULL)))
3372 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3373 expand_string_message, opname);
3376 Uskip_whitespace(&s);
3378 /* {-for-text-editors */
3381 /* {-for-text-editors */
3382 expand_string_message = string_sprintf("missing } at end of condition "
3383 "inside \"%s\"", opname);
3387 if (yield) *yield = !testfor;
3389 if (is_json) list = dewrap(string_copy(list), US"[]");
3390 while ((iterate_item = is_json
3391 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3394 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3396 expand_string_message =
3397 string_sprintf("%s wrapping string result for extract jsons",
3398 expand_string_message);
3399 iterate_item = save_iterate_item;
3403 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3404 if (!eval_condition(sub[1], resetok, &tempcond))
3406 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3407 expand_string_message, opname);
3408 iterate_item = save_iterate_item;
3411 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3412 tempcond? "true":"false");
3414 if (yield) *yield = (tempcond == testfor);
3415 if (tempcond == is_forany) break;
3418 iterate_item = save_iterate_item;
3423 /* The bool{} expansion condition maps a string to boolean.
3424 The values supported should match those supported by the ACL condition
3425 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3426 of true/false. Note that Router "condition" rules have a different
3427 interpretation, where general data can be used and only a few values
3429 Note that readconf.c boolean matching, for boolean configuration options,
3430 only matches true/yes/false/no.
3431 The bool_lax{} condition matches the Router logic, which is much more
3434 case ECOND_BOOL_LAX:
3440 BOOL boolvalue = FALSE;
3442 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3443 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3444 switch(read_subs(sub_arg, 1, 1, &s,
3445 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, ourname, resetok, NULL))
3447 case 1: expand_string_message = string_sprintf(
3448 "too few arguments or bracketing error for %s",
3452 case 3: return NULL;
3455 Uskip_whitespace(&t);
3456 if ((len = Ustrlen(t)))
3458 /* trailing whitespace: seems like a good idea to ignore it too */
3460 while (isspace(*t2)) t2--;
3461 if (t2 != (t + len))
3468 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3469 /* logic for the lax case from expand_check_condition(), which also does
3470 expands, and the logic is both short and stable enough that there should
3471 be no maintenance burden from replicating it. */
3475 ? Ustrspn(t+1, "0123456789") == len-1
3476 : Ustrspn(t, "0123456789") == len)
3478 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3479 /* expand_check_condition only does a literal string "0" check */
3480 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3483 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3485 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3487 else if (cond_type == ECOND_BOOL_LAX)
3491 expand_string_message = string_sprintf("unrecognised boolean "
3495 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3496 boolvalue? "true":"false");
3497 if (yield) *yield = (boolvalue == testfor);
3502 case ECOND_INBOUND_SRS:
3503 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */
3506 const pcre2_code * re;
3507 pcre2_match_data * md;
3511 BOOL boolvalue = FALSE;
3513 switch(read_subs(sub, 2, 2, CUSS &s,
3514 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, name, resetok, NULL))
3516 case 1: expand_string_message = US"too few arguments or bracketing "
3517 "error for inbound_srs";
3519 case 3: return NULL;
3522 /* Match the given local_part against the SRS-encoded pattern */
3524 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]+)=([^=]*)=(.*)$",
3525 MCS_CASELESS | MCS_CACHEABLE, FALSE);
3526 md = pcre2_match_data_create(4+1, pcre_gen_ctx);
3527 if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,
3528 md, pcre_gen_mtc_ctx) < 0)
3530 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3533 ovec = pcre2_get_ovector_pointer(md);
3535 if (sub[0][0] == '"')
3537 else for (uschar * s = sub[0]; *s; s++)
3538 if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3539 { quoting = 1; break; }
3541 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3543 /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3545 srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S", /* lowercased */
3547 (int) (ovec[9]-ovec[8]), sub[0] + ovec[8], /* substr 4 */
3549 (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */
3551 /* If a zero-length secret was given, we're done. Otherwise carry on
3552 and validate the given SRS local_part againt our secret. */
3560 /* check the timestamp */
3563 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3567 gettimeofday(&now, NULL);
3568 now.tv_sec /= 86400; /* days since epoch */
3570 /* Decode substring 2 from base32 to a number */
3572 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3574 uschar * t = Ustrchr(base32_chars, *ss++);
3575 d = d * 32 + (t - base32_chars);
3578 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3580 DEBUG(D_expand) debug_printf("SRS too old\n");
3585 /* check length of substring 1, the offered checksum */
3587 if (ovec[3]-ovec[2] != 4)
3589 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3593 /* Hash the address with our secret, and compare that computed checksum
3594 with the one extracted from the arg */
3596 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3597 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3599 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3605 /* pcre2_match_data_free(md); gen ctx needs no free */
3606 if (yield) *yield = (boolvalue == testfor);
3609 #endif /*SUPPORT_SRS*/
3611 /* Unknown condition */
3614 if (!expand_string_message || !*expand_string_message)
3615 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3617 } /* End switch on condition type */
3619 /* Missing braces at start and end of data */
3621 COND_FAILED_CURLY_START:
3622 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3625 COND_FAILED_CURLY_END:
3626 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3630 /* A condition requires code that is not compiled */
3632 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3633 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3634 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3635 COND_FAILED_NOT_COMPILED:
3636 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3645 /*************************************************
3646 * Save numerical variables *
3647 *************************************************/
3649 /* This function is called from items such as "if" that want to preserve and
3650 restore the numbered variables.
3653 save_expand_string points to an array of pointers to set
3654 save_expand_nlength points to an array of ints for the lengths
3656 Returns: the value of expand max to save
3660 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3662 for (int i = 0; i <= expand_nmax; i++)
3664 save_expand_nstring[i] = expand_nstring[i];
3665 save_expand_nlength[i] = expand_nlength[i];
3672 /*************************************************
3673 * Restore numerical variables *
3674 *************************************************/
3676 /* This function restored saved values of numerical strings.
3679 save_expand_nmax the number of strings to restore
3680 save_expand_string points to an array of pointers
3681 save_expand_nlength points to an array of ints
3687 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3688 int *save_expand_nlength)
3690 expand_nmax = save_expand_nmax;
3691 for (int i = 0; i <= expand_nmax; i++)
3693 expand_nstring[i] = save_expand_nstring[i];
3694 expand_nlength[i] = save_expand_nlength[i];
3702 /*************************************************
3703 * Handle yes/no substrings *
3704 *************************************************/
3706 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3707 alternative substrings that depend on whether or not the condition was true,
3708 or the lookup or extraction succeeded. The substrings always have to be
3709 expanded, to check their syntax, but "skipping" is set when the result is not
3710 needed - this avoids unnecessary nested lookups.
3714 skipping TRUE if we were skipping when this item was reached
3715 yes TRUE if the first string is to be used, else use the second
3716 save_lookup a value to put back into lookup_value before the 2nd expansion
3717 sptr points to the input string pointer
3718 yieldptr points to the output growable-string pointer
3719 type "lookup", "if", "extract", "run", "env", "listextract" or
3720 "certextract" for error message
3721 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3724 Returns: 0 OK; lookup_value has been reset to save_lookup
3726 2 expansion failed because of bracketing error
3730 process_yesno(esi_flags flags, BOOL yes, uschar *save_lookup, const uschar **sptr,
3731 gstring ** yieldptr, uschar *type, BOOL *resetok)
3734 const uschar *s = *sptr; /* Local value */
3735 uschar *sub1, *sub2;
3736 const uschar * errwhere;
3738 flags &= ESI_SKIPPING; /* Ignore all buf the skipping flag */
3740 /* If there are no following strings, we substitute the contents of $value for
3741 lookups and for extractions in the success case. For the ${if item, the string
3742 "true" is substituted. In the fail case, nothing is substituted for all three
3745 if (skip_whitespace(&s) == '}')
3749 if (yes && !(flags & ESI_SKIPPING))
3750 *yieldptr = string_catn(*yieldptr, US"true", 4);
3754 if (yes && lookup_value && !(flags & ESI_SKIPPING))
3755 *yieldptr = string_cat(*yieldptr, lookup_value);
3756 lookup_value = save_lookup;
3762 /* The first following string must be braced. */
3766 errwhere = US"'yes' part did not start with '{'"; /*}}*/
3770 /* Expand the first substring. Forced failures are noticed only if we actually
3771 want this string. Set skipping in the call in the fail case (this will always
3772 be the case if we were already skipping). */
3774 sub1 = expand_string_internal(s,
3775 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yes ? ESI_NOFLAGS : ESI_SKIPPING),
3777 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3778 f.expand_string_forcedfail = FALSE;
3782 errwhere = US"'yes' part did not end with '}'";
3786 /* If we want the first string, add it to the output */
3789 *yieldptr = string_cat(*yieldptr, sub1);
3791 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3792 $value to what it was at the start of the item, so that it has this value
3793 during the second string expansion. For the call from "if" or "run" to this
3794 function, save_lookup is set to lookup_value, so that this statement does
3797 lookup_value = save_lookup;
3799 /* There now follows either another substring, or "fail", or nothing. This
3800 time, forced failures are noticed only if we want the second string. We must
3801 set skipping in the nested call if we don't want this string, or if we were
3802 already skipping. */
3804 if (skip_whitespace(&s) == '{') /*}*/
3806 esi_flags s_flags = ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags;
3807 if (yes) s_flags |= ESI_SKIPPING;
3808 sub2 = expand_string_internal(s+1, s_flags, &s, resetok, NULL);
3809 if (!sub2 && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3810 f.expand_string_forcedfail = FALSE; /*{*/
3813 errwhere = US"'no' part did not start with '{'"; /*}*/
3817 /* If we want the second string, add it to the output */
3820 *yieldptr = string_cat(*yieldptr, sub2);
3823 /* If there is no second string, but the word "fail" is present when the use of
3824 the second string is wanted, set a flag indicating it was a forced failure
3825 rather than a syntactic error. Swallow the terminating } in case this is nested
3826 inside another lookup or if or extract. */
3831 /* deconst cast ok here as source is s anyway */
3832 s = US read_name(name, sizeof(name), s, US"_");
3833 if (Ustrcmp(name, "fail") == 0)
3835 if (!yes && !(flags & ESI_SKIPPING))
3837 Uskip_whitespace(&s); /*{{*/
3840 errwhere = US"did not close with '}' after forcedfail";
3843 expand_string_message =
3844 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3845 f.expand_string_forcedfail = TRUE;
3851 expand_string_message =
3852 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3857 /* All we have to do now is to check on the final closing brace. */
3859 skip_whitespace(&s); /*{{*/
3862 errwhere = US"did not close with '}'";
3868 /* Update the input pointer value before returning */
3873 /* Get here if there is a bracketing failure */
3874 expand_string_message = string_sprintf(
3875 "curly-bracket problem in conditional yes/no parsing: %s\n"
3876 " remaining string is '%s'", errwhere, --s);
3881 /* Get here for other failures */
3889 /********************************************************
3890 * prvs: Get last three digits of days since Jan 1, 1970 *
3891 ********************************************************/
3893 /* This is needed to implement the "prvs" BATV reverse
3896 Argument: integer "days" offset to add or substract to
3897 or from the current number of days.
3899 Returns: pointer to string containing the last three
3900 digits of the number of days since Jan 1, 1970,
3901 modified by the offset argument, NULL if there
3902 was an error in the conversion.
3907 prvs_daystamp(int day_offset)
3909 uschar * days = store_get(32, GET_UNTAINTED); /* Need at least 24 for cases */
3910 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3911 (time(NULL) + day_offset*86400)/86400);
3912 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3917 /********************************************************
3918 * prvs: perform HMAC-SHA1 computation of prvs bits *
3919 ********************************************************/
3921 /* This is needed to implement the "prvs" BATV reverse
3925 address RFC2821 Address to use
3926 key The key to use (must be less than 64 characters
3928 key_num Single-digit key number to use. Defaults to
3931 Returns: pointer to string containing the first three
3932 bytes of the final hash in hex format, NULL if
3933 there was an error in the process.
3937 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3939 gstring * hash_source;
3942 uschar innerhash[20];
3943 uschar finalhash[20];
3944 uschar innerkey[64];
3945 uschar outerkey[64];
3946 uschar *finalhash_hex;
3951 if (Ustrlen(key) > 64)
3954 hash_source = string_catn(NULL, key_num, 1);
3955 hash_source = string_catn(hash_source, daystamp, 3);
3956 hash_source = string_cat(hash_source, address);
3957 (void) string_from_gstring(hash_source);
3960 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3962 memset(innerkey, 0x36, 64);
3963 memset(outerkey, 0x5c, 64);
3965 for (int i = 0; i < Ustrlen(key); i++)
3967 innerkey[i] ^= key[i];
3968 outerkey[i] ^= key[i];
3971 chash_start(HMAC_SHA1, &h);
3972 chash_mid(HMAC_SHA1, &h, innerkey);
3973 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3975 chash_start(HMAC_SHA1, &h);
3976 chash_mid(HMAC_SHA1, &h, outerkey);
3977 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3979 /* Hashing is deemed sufficient to de-taint any input data */
3981 p = finalhash_hex = store_get(40, GET_UNTAINTED);
3982 for (int i = 0; i < 3; i++)
3984 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3985 *p++ = hex_digits[finalhash[i] & 0x0f];
3989 return finalhash_hex;
3995 /*************************************************
3996 * Join a file onto the output string *
3997 *************************************************/
3999 /* This is used for readfile/readsock and after a run expansion.
4000 It joins the contents of a file onto the output string, globally replacing
4001 newlines with a given string (optionally).
4005 yield pointer to the expandable string struct
4006 eol newline replacement string, or NULL
4008 Returns: new pointer for expandable string, terminated if non-null
4012 cat_file(FILE * f, gstring * yield, uschar * eol)
4014 uschar buffer[1024];
4016 while (Ufgets(buffer, sizeof(buffer), f))
4018 int len = Ustrlen(buffer);
4019 if (eol && buffer[len-1] == '\n') len--;
4020 yield = string_catn(yield, buffer, len);
4021 if (eol && buffer[len])
4022 yield = string_cat(yield, eol);
4030 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
4033 uschar buffer[1024];
4035 /*XXX could we read direct into a pre-grown string? */
4037 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
4038 for (uschar * s = buffer; rc--; s++)
4039 yield = eol && *s == '\n'
4040 ? string_cat(yield, eol) : string_catn(yield, s, 1);
4042 /* We assume that all errors, and any returns of zero bytes,
4043 are actually EOF. */
4050 /*************************************************
4051 * Evaluate numeric expression *
4052 *************************************************/
4054 /* This is a set of mutually recursive functions that evaluate an arithmetic
4055 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
4056 these functions that is called from elsewhere is eval_expr, whose interface is:
4059 sptr pointer to the pointer to the string - gets updated
4060 decimal TRUE if numbers are to be assumed decimal
4061 error pointer to where to put an error message - must be NULL on input
4062 endket TRUE if ')' must terminate - FALSE for external call
4064 Returns: on success: the value of the expression, with *error still NULL
4065 on failure: an undefined value, with *error = a message
4068 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4071 static int_eximarith_t
4072 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4075 int_eximarith_t x = eval_op_or(&s, decimal, error);
4080 *error = US"expecting closing parenthesis";
4082 while (isspace(*++s));
4084 *error = US"expecting operator";
4090 static int_eximarith_t
4091 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4097 if (isdigit((c = Uskip_whitespace(&s))))
4100 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4102 switch (tolower(*s))
4105 case 'k': n *= 1024; s++; break;
4106 case 'm': n *= 1024*1024; s++; break;
4107 case 'g': n *= 1024*1024*1024; s++; break;
4109 Uskip_whitespace(&s);
4114 n = eval_expr(&s, decimal, error, 1);
4118 *error = US"expecting number or opening parenthesis";
4126 static int_eximarith_t
4127 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4131 Uskip_whitespace(&s);
4132 if (*s == '+' || *s == '-' || *s == '~')
4135 x = eval_op_unary(&s, decimal, error);
4136 if (op == '-') x = -x;
4137 else if (op == '~') x = ~x;
4140 x = eval_number(&s, decimal, error);
4147 static int_eximarith_t
4148 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4151 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4154 while (*s == '*' || *s == '/' || *s == '%')
4157 int_eximarith_t y = eval_op_unary(&s, decimal, error);
4159 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4160 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4161 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4162 * -N*M is INT_MIN will yield INT_MIN.
4163 * Since we don't support floating point, this is somewhat simpler.
4164 * Ideally, we'd return an error, but since we overflow for all other
4165 * arithmetic, consistency suggests otherwise, but what's the correct value
4166 * to use? There is none.
4167 * The C standard guarantees overflow for unsigned arithmetic but signed
4168 * overflow invokes undefined behaviour; in practice, this is overflow
4169 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4170 * that long/longlong larger than int are available, or we could just work
4171 * with larger types. We should consider whether to guarantee 32bit eval
4172 * and 64-bit working variables, with errors returned. For now ...
4173 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4174 * can just let the other invalid results occur otherwise, as they have
4175 * until now. For this one case, we can coerce.
4177 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4180 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4181 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4191 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4207 static int_eximarith_t
4208 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4211 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4214 while (*s == '+' || *s == '-')
4217 int_eximarith_t y = eval_op_mult(&s, decimal, error);
4219 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4220 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4221 { /* over-conservative check */
4223 ? US"overflow in sum" : US"overflow in difference";
4226 if (op == '+') x += y; else x -= y;
4234 static int_eximarith_t
4235 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4238 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4241 while ((*s == '<' || *s == '>') && s[1] == s[0])
4246 y = eval_op_sum(&s, decimal, error);
4248 if (op == '<') x <<= y; else x >>= y;
4256 static int_eximarith_t
4257 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4260 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4267 y = eval_op_shift(&s, decimal, error);
4277 static int_eximarith_t
4278 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4281 int_eximarith_t x = eval_op_and(&s, decimal, error);
4288 y = eval_op_and(&s, decimal, error);
4298 static int_eximarith_t
4299 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4302 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4309 y = eval_op_xor(&s, decimal, error);
4320 /************************************************/
4321 /* Comparison operation for sort expansion. We need to avoid
4322 re-expanding the fields being compared, so need a custom routine.
4325 cond_type Comparison operator code
4326 leftarg, rightarg Arguments for comparison
4328 Return true iff (leftarg compare rightarg)
4332 sortsbefore(int cond_type, BOOL alpha_cond,
4333 const uschar * leftarg, const uschar * rightarg)
4335 int_eximarith_t l_num, r_num;
4339 l_num = expanded_string_integer(leftarg, FALSE);
4340 if (expand_string_message) return FALSE;
4341 r_num = expanded_string_integer(rightarg, FALSE);
4342 if (expand_string_message) return FALSE;
4346 case ECOND_NUM_G: return l_num > r_num;
4347 case ECOND_NUM_GE: return l_num >= r_num;
4348 case ECOND_NUM_L: return l_num < r_num;
4349 case ECOND_NUM_LE: return l_num <= r_num;
4356 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4357 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4358 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4359 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4360 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4361 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4362 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4363 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4366 return FALSE; /* should not happen */
4370 /* Expand a named list. Return false on failure. */
4372 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4374 tree_node *t = NULL;
4375 const uschar * list;
4378 BOOL needsep = FALSE;
4379 #define LISTNAMED_BUF_SIZE 256
4380 uschar b[LISTNAMED_BUF_SIZE];
4381 uschar * buffer = b;
4383 if (*name == '+') name++;
4384 if (!listtype) /* no-argument version */
4386 if ( !(t = tree_search(addresslist_anchor, name))
4387 && !(t = tree_search(domainlist_anchor, name))
4388 && !(t = tree_search(hostlist_anchor, name)))
4389 t = tree_search(localpartlist_anchor, name);
4391 else switch(*listtype) /* specific list-type version */
4393 case 'a': t = tree_search(addresslist_anchor, name); break;
4394 case 'd': t = tree_search(domainlist_anchor, name); break;
4395 case 'h': t = tree_search(hostlist_anchor, name); break;
4396 case 'l': t = tree_search(localpartlist_anchor, name); break;
4398 expand_string_message = US"bad suffix on \"list\" operator";
4404 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4406 : *listtype=='a'?"address "
4407 : *listtype=='d'?"domain "
4408 : *listtype=='h'?"host "
4409 : *listtype=='l'?"localpart "
4414 list = ((namedlist_block *)(t->data.ptr))->string;
4416 /* The list could be quite long so we (re)use a buffer for each element
4417 rather than getting each in new memory */
4419 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, GET_TAINTED);
4420 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4422 uschar * buf = US" : ";
4424 yield = string_catn(yield, buf, 3);
4428 if (*item == '+') /* list item is itself a named list */
4430 yield = expand_listnamed(yield, item, listtype);
4431 if (expand_string_message)
4435 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
4438 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4440 for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4442 yield = string_catn(yield, item, cp - CS item);
4443 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4444 yield = string_catn(yield, US"::", 2);
4445 else /* sep in item; should already be doubled; emit once */
4447 yield = string_catn(yield, US tok, 1);
4448 if (*cp == sep) cp++;
4451 yield = string_cat(yield, item);
4454 yield = string_cat(yield, item);
4461 /************************************************/
4463 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4467 debug_printf_indent("|");
4469 debug_printf_indent(UTF8_VERT_RIGHT);
4471 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4475 debug_printf(UTF8_HORIZ);
4477 debug_printf("%s: %.*s\n", what, nchar, value);
4478 if (is_tainted(value))
4481 debug_printf_indent("%s \\__", skipping ? "| " : " ");
4483 debug_printf_indent("%s",
4485 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
4486 debug_printf("(tainted)\n");
4491 /*************************************************
4493 *************************************************/
4495 /* Returns either an unchanged string, or the expanded string in stacking pool
4496 store. Interpreted sequences are:
4498 \... normal escaping rules
4499 $name substitutes the variable
4501 ${op:string} operates on the expanded string value
4502 ${item{arg1}{arg2}...} expands the args and then does the business
4503 some literal args are not enclosed in {}
4505 There are now far too many operators and item types to make it worth listing
4506 them here in detail any more.
4508 We use an internal routine recursively to handle embedded substrings. The
4509 external function follows. The yield is NULL if the expansion failed, and there
4510 are two cases: if something collapsed syntactically, or if "fail" was given
4511 as the action on a lookup failure. These can be distinguished by looking at the
4512 variable expand_string_forcedfail, which is TRUE in the latter case.
4514 The skipping flag is set true when expanding a substring that isn't actually
4515 going to be used (after "if" or "lookup") and it prevents lookups from
4516 happening lower down.
4518 Store usage: At start, a store block of the length of the input plus 64
4519 is obtained. This is expanded as necessary by string_cat(), which might have to
4520 get a new block, or might be able to expand the original. At the end of the
4521 function we can release any store above that portion of the yield block that
4522 was actually used. In many cases this will be optimal.
4524 However: if the first item in the expansion is a variable name or header name,
4525 we reset the store before processing it; if the result is in fresh store, we
4526 use that without copying. This is helpful for expanding strings like
4527 $message_headers which can get very long.
4529 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4530 since resetting the store at the end of the expansion will free store that was
4531 allocated by the plugin code as well as the slop after the expanded string. So
4532 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4533 and, given the acl condition, ${if }. This is an unfortunate consequence of
4534 string expansion becoming too powerful.
4537 string the string to be expanded
4539 brace_ends expansion is to stop at }
4540 honour_dollar TRUE if $ is to be expanded,
4541 FALSE if it's just another character
4542 skipping TRUE for recursive calls when the value isn't actually going
4543 to be used (to allow for optimisation)
4544 left if not NULL, a pointer to the first character after the
4545 expansion is placed here (typically used with brace_ends)
4546 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4548 textonly_p if not NULL, pointer to flag - write bool for only-met-text
4550 Returns: NULL if expansion fails:
4551 expand_string_forcedfail is set TRUE if failure was forced
4552 expand_string_message contains a textual error message
4553 a pointer to the expanded string on success
4557 expand_string_internal(const uschar * string, esi_flags flags, const uschar ** left,
4558 BOOL *resetok_p, BOOL * textonly_p)
4560 rmark reset_point = store_mark();
4561 gstring * yield = string_get(Ustrlen(string) + 64);
4563 const uschar * s = string;
4564 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4565 int save_expand_nlength[EXPAND_MAXN+1];
4566 BOOL resetok = TRUE, first = TRUE, textonly = TRUE;
4569 f.expand_string_forcedfail = FALSE;
4570 expand_string_message = US"";
4572 if (is_tainted(string))
4574 expand_string_message =
4575 string_sprintf("attempt to expand tainted string '%s'", s);
4576 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4587 debug_printf_indent("%c%s: %s\n",
4589 flags & ESI_SKIPPING ? "---scanning" : "considering", s);
4591 debug_printf_indent("%s%s: %s\n",
4592 first ? UTF8_DOWN_RIGHT : UTF8_VERT_RIGHT,
4593 flags & ESI_SKIPPING
4594 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4600 /* \ escapes the next character, which must exist, or else
4601 the expansion fails. There's a special escape, \N, which causes
4602 copying of the subject verbatim up to the next \N. Otherwise,
4603 the escapes are the standard set. */
4609 expand_string_message = US"\\ at end of string";
4615 const uschar * t = s + 2;
4616 for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4619 debug_expansion_interim(US"protected", t, (int)(s - t), !!(flags & ESI_SKIPPING));
4620 yield = string_catn(yield, t, s - t);
4628 debug_printf_indent("|backslashed: '\\%c'\n", s[1]);
4630 debug_printf_indent(UTF8_VERT_RIGHT "backslashed: '\\%c'\n", s[1]);
4631 ch[0] = string_interpret_escape(&s);
4633 yield = string_catn(yield, ch, 1);
4639 /* Anything other than $ is just copied verbatim, unless we are
4640 looking for a terminating } character. */
4642 if (flags & ESI_BRACE_ENDS && *s == '}') break;
4644 if (*s != '$' || !(flags & ESI_HONOR_DOLLAR))
4647 for (const uschar * t = s+1;
4648 *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4650 DEBUG(D_expand) debug_expansion_interim(US"text", s, i, !!(flags & ESI_SKIPPING));
4652 yield = string_catn(yield, s, i);
4658 /* No { after the $ - must be a plain name or a number for string
4659 match variable. There has to be a fudge for variables that are the
4660 names of header fields preceded by "$header_" because header field
4661 names can contain any printing characters except space and colon.
4662 For those that don't like typing this much, "$h_" is a synonym for
4663 "$header_". A non-existent header yields a NULL value; nothing is
4668 const uschar * value;
4669 int newsize = 0, len;
4673 s = read_name(name, sizeof(name), s, US"_");
4675 /* If this is the first thing to be expanded, release the pre-allocated
4679 g = store_get(sizeof(gstring), GET_UNTAINTED);
4680 else if (yield->ptr == 0)
4682 if (resetok) reset_point = store_reset(reset_point);
4684 reset_point = store_mark();
4685 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
4690 if ( ( *(t = name) == 'h'
4691 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4693 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4696 unsigned flags = *name == 'r' ? FH_WANT_RAW
4697 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4699 const uschar * charset = *name == 'b' ? NULL : headers_charset;
4701 s = read_header_name(name, sizeof(name), s);
4702 value = find_header(name, &newsize, flags, charset);
4704 /* If we didn't find the header, and the header contains a closing brace
4705 character, this may be a user error where the terminating colon
4706 has been omitted. Set a flag to adjust the error message in this case.
4707 But there is no error here - nothing gets inserted. */
4711 if (Ustrchr(name, '}')) malformed_header = TRUE;
4718 else if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
4720 expand_string_message =
4721 string_sprintf("unknown variable name \"%s\"", name);
4722 check_variable_error_message(name);
4726 /* If the data is known to be in a new buffer, newsize will be set to the
4727 size of that buffer. If this is the first thing in an expansion string,
4728 yield will be NULL; just point it at the new store instead of copying. Many
4729 expansion strings contain just one reference, so this is a useful
4730 optimization, especially for humungous headers. We need to use a gstring
4731 structure that is not allocated after that new-buffer, else a later store
4732 reset in the middle of the buffer will make it inaccessible. */
4734 len = Ustrlen(value);
4735 if (!yield && newsize != 0)
4738 yield->size = newsize;
4740 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4743 yield = string_catn(yield, value, len);
4751 s = read_cnumber(&n, s);
4752 if (n >= 0 && n <= expand_nmax)
4753 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4757 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4759 if (*s != '{') /*}*/
4761 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4765 /* After { there can be various things, but they all start with
4766 an initial word, except for a number for a string match variable. */ /*}*/
4771 s = read_cnumber(&n, s); /*{{*/
4774 expand_string_message = US"} expected after number";
4777 if (n >= 0 && n <= expand_nmax)
4778 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4784 expand_string_message = US"letter or digit expected after ${"; /*}*/
4788 /* Allow "-" in names to cater for substrings with negative
4789 arguments. Since we are checking for known names after { this is
4792 s = read_name(name, sizeof(name), s, US"_-");
4793 item_type = chop_match(name, item_table, nelem(item_table));
4795 /* Switch on item type. All nondefault choices should "continue* when
4796 skipping, but "break" otherwise so we get debug output for the item
4799 int start = gstring_length(yield);
4802 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4803 If the ACL returns accept or reject we return content set by "message ="
4804 There is currently no limit on recursion; this would have us call
4805 acl_check_internal() directly and get a current level from somewhere.
4806 See also the acl expansion condition ECOND_ACL and the traditional
4807 acl modifier ACLC_ACL.
4808 Assume that the function has side-effects on the store that must be preserved.
4812 /* ${acl {name} {arg1}{arg2}...} */
4814 uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4818 switch(read_subs(sub, nelem(sub), 1, &s, flags, TRUE, name, &resetok, NULL))
4820 case -1: continue; /* skipping */
4821 case 1: goto EXPAND_FAILED_CURLY;
4823 case 3: goto EXPAND_FAILED;
4827 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4832 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4834 yield = string_cat(yield, user_msg);
4838 f.expand_string_forcedfail = TRUE;
4841 expand_string_message = string_sprintf("%s from acl \"%s\"",
4842 rc_names[rc], sub[0]);
4848 case EITEM_AUTHRESULTS:
4849 /* ${authresults {mysystemname}} */
4851 uschar * sub_arg[1];
4853 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4855 case 1: goto EXPAND_FAILED_CURLY;
4857 case 3: goto EXPAND_FAILED;
4859 /*XXX no skipping-optimisation? */
4861 yield = string_append(yield, 3,
4862 US"Authentication-Results: ", sub_arg[0], US"; none");
4865 yield = authres_local(yield, sub_arg[0]);
4866 yield = authres_iprev(yield);
4867 yield = authres_smtpauth(yield);
4869 yield = authres_spf(yield);
4871 #ifndef DISABLE_DKIM
4872 yield = authres_dkim(yield);
4874 #ifdef SUPPORT_DMARC
4875 yield = authres_dmarc(yield);
4877 #ifdef EXPERIMENTAL_ARC
4878 yield = authres_arc(yield);
4883 /* Handle conditionals - preserve the values of the numerical expansion
4884 variables in case they get changed by a regular expression match in the
4885 condition. If not, they retain their external settings. At the end
4886 of this "if" section, they get restored to their previous values. */
4891 const uschar *next_s;
4892 int save_expand_nmax =
4893 save_expand_strings(save_expand_nstring, save_expand_nlength);
4894 uschar * save_lookup_value = lookup_value;
4896 Uskip_whitespace(&s);
4897 if (!(next_s = eval_condition(s, &resetok, flags & ESI_SKIPPING ? NULL : &cond)))
4898 goto EXPAND_FAILED; /* message already set */
4902 debug_expansion_interim(US"condition", s, (int)(next_s - s), !!(flags & ESI_SKIPPING));
4903 debug_expansion_interim(US"result",
4904 cond ? US"true" : US"false", cond ? 4 : 5, !!(flags & ESI_SKIPPING));
4909 /* The handling of "yes" and "no" result strings is now in a separate
4910 function that is also used by ${lookup} and ${extract} and ${run}. */
4912 switch(process_yesno(
4913 flags, /* were previously skipping */
4914 cond, /* success/failure indicator */
4915 lookup_value, /* value to reset for string2 */
4916 &s, /* input pointer */
4917 &yield, /* output pointer */
4918 US"if", /* condition type */
4921 case 1: goto EXPAND_FAILED; /* when all is well, the */
4922 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4925 /* Restore external setting of expansion variables for continuation
4928 lookup_value = save_lookup_value;
4929 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4930 save_expand_nlength);
4935 case EITEM_IMAPFOLDER:
4936 { /* ${imapfolder {name}{sep}{specials}} */
4940 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4942 case 1: goto EXPAND_FAILED_CURLY;
4944 case 3: goto EXPAND_FAILED;
4946 /*XXX no skipping-optimisation? */
4948 if (!sub_arg[1]) /* One argument */
4950 sub_arg[1] = US"/"; /* default separator */
4953 else if (Ustrlen(sub_arg[1]) != 1)
4955 expand_string_message =
4957 "IMAP folder separator must be one character, found \"%s\"",
4962 if (flags & ESI_SKIPPING) continue;
4964 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4965 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4967 yield = string_cat(yield, encoded);
4972 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4973 expanding an internal string that isn't actually going to be used. All we
4974 need to do is check the syntax, so don't do a lookup at all. Preserve the
4975 values of the numerical expansion variables in case they get changed by a
4976 partial lookup. If not, they retain their external settings. At the end
4977 of this "lookup" section, they get restored to their previous values. */
4981 int stype, partial, affixlen, starflags;
4982 int expand_setup = 0;
4984 uschar * key, * filename;
4985 const uschar * affix, * opts;
4986 uschar * save_lookup_value = lookup_value;
4987 int save_expand_nmax =
4988 save_expand_strings(save_expand_nstring, save_expand_nlength);
4990 if (expand_forbid & RDO_LOOKUP)
4992 expand_string_message = US"lookup expansions are not permitted";
4996 /* Get the key we are to look up for single-key+file style lookups.
4997 Otherwise set the key NULL pro-tem. */
4999 if (Uskip_whitespace(&s) == '{') /*}*/
5001 key = expand_string_internal(s+1,
5002 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
5003 if (!key) goto EXPAND_FAILED; /*{{*/
5006 expand_string_message = US"missing '}' after lookup key";
5007 goto EXPAND_FAILED_CURLY;
5009 Uskip_whitespace(&s);
5013 /* Find out the type of database */
5017 expand_string_message = US"missing lookup type";
5021 /* The type is a string that may contain special characters of various
5022 kinds. Allow everything except space or { to appear; the actual content
5023 is checked by search_findtype_partial. */ /*}*/
5025 while (*s && *s != '{' && !isspace(*s)) /*}*/
5027 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
5030 name[nameptr] = '\0';
5031 Uskip_whitespace(&s);
5033 /* Now check for the individual search type and any partial or default
5034 options. Only those types that are actually in the binary are valid. */
5036 if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
5037 &starflags, &opts)) < 0)
5039 expand_string_message = search_error_message;
5043 /* Check that a key was provided for those lookup types that need it,
5044 and was not supplied for those that use the query style. */
5046 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
5050 expand_string_message = string_sprintf("missing {key} for single-"
5051 "key \"%s\" lookup", name);
5057 expand_string_message = string_sprintf("a single key was given for "
5058 "lookup type \"%s\", which is not a single-key lookup type", name);
5062 /* Get the next string in brackets and expand it. It is the file name for
5063 single-key+file lookups, and the whole query otherwise. In the case of
5064 queries that also require a file name (e.g. sqlite), the file name comes
5069 expand_string_message = US"missing '{' for lookup file-or-query arg";
5070 goto EXPAND_FAILED_CURLY; /*}}*/
5072 if (!(filename = expand_string_internal(s+1,
5073 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5078 expand_string_message = US"missing '}' closing lookup file-or-query arg";
5079 goto EXPAND_FAILED_CURLY;
5081 Uskip_whitespace(&s);
5083 /* If this isn't a single-key+file lookup, re-arrange the variables
5084 to be appropriate for the search_ functions. For query-style lookups,
5085 there is just a "key", and no file name. For the special query-style +
5086 file types, the query (i.e. "key") starts with a file name. */
5089 key = search_args(stype, name, filename, &filename, opts);
5091 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5092 the entry was not found. Note that there is no search_close() function.
5093 Files are left open in case of re-use. At suitable places in higher logic,
5094 search_tidyup() is called to tidy all open files. This can save opening
5095 the same file several times. However, files may also get closed when
5096 others are opened, if too many are open at once. The rule is that a
5097 handle should not be used after a second search_open().
5099 Request that a partial search sets up $1 and maybe $2 by passing
5100 expand_setup containing zero. If its value changes, reset expand_nmax,
5101 since new variables will have been set. Note that at the end of this
5102 "lookup" section, the old numeric variables are restored. */
5104 if (flags & ESI_SKIPPING)
5105 lookup_value = NULL;
5108 void * handle = search_open(filename, stype, 0, NULL, NULL);
5111 expand_string_message = search_error_message;
5114 lookup_value = search_find(handle, filename, key, partial, affix,
5115 affixlen, starflags, &expand_setup, opts);
5116 if (f.search_find_defer)
5118 expand_string_message =
5119 string_sprintf("lookup of \"%s\" gave DEFER: %s",
5120 string_printing2(key, SP_TAB), search_error_message);
5123 if (expand_setup > 0) expand_nmax = expand_setup;
5126 /* The handling of "yes" and "no" result strings is now in a separate
5127 function that is also used by ${if} and ${extract}. */
5129 switch(process_yesno(
5130 flags, /* were previously skipping */
5131 lookup_value != NULL, /* success/failure indicator */
5132 save_lookup_value, /* value to reset for string2 */
5133 &s, /* input pointer */
5134 &yield, /* output pointer */
5135 US"lookup", /* condition type */
5138 case 1: goto EXPAND_FAILED; /* when all is well, the */
5139 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5142 /* Restore external setting of expansion variables for carrying on
5143 at this level, and continue. */
5145 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5146 save_expand_nlength);
5148 if (flags & ESI_SKIPPING) continue;
5152 /* If Perl support is configured, handle calling embedded perl subroutines,
5153 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5154 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5155 arguments (defined below). */
5157 #define EXIM_PERL_MAX_ARGS 8
5161 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
5162 "is not included in this binary";
5165 #else /* EXIM_PERL */
5167 uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5168 gstring * new_yield;
5170 if (expand_forbid & RDO_PERL)
5172 expand_string_message = US"Perl calls are not permitted";
5176 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, flags, TRUE,
5177 name, &resetok, NULL))
5179 case -1: continue; /* If skipping, we don't actually do anything */
5180 case 1: goto EXPAND_FAILED_CURLY;
5182 case 3: goto EXPAND_FAILED;
5185 /* Start the interpreter if necessary */
5187 if (!opt_perl_started)
5190 if (!opt_perl_startup)
5192 expand_string_message = US"A setting of perl_startup is needed when "
5193 "using the Perl interpreter";
5196 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5197 if ((initerror = init_perl(opt_perl_startup)))
5199 expand_string_message =
5200 string_sprintf("error in perl_startup code: %s\n", initerror);
5203 opt_perl_started = TRUE;
5206 /* Call the function */
5208 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5209 new_yield = call_perl_cat(yield, &expand_string_message,
5210 sub_arg[0], sub_arg + 1);
5212 /* NULL yield indicates failure; if the message pointer has been set to
5213 NULL, the yield was undef, indicating a forced failure. Otherwise the
5214 message will indicate some kind of Perl error. */
5218 if (!expand_string_message)
5220 expand_string_message =
5221 string_sprintf("Perl subroutine \"%s\" returned undef to force "
5222 "failure", sub_arg[0]);
5223 f.expand_string_forcedfail = TRUE;
5228 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5229 set during a callback from Perl. */
5231 f.expand_string_forcedfail = FALSE;
5235 #endif /* EXIM_PERL */
5237 /* Transform email address to "prvs" scheme to use
5238 as BATV-signed return path */
5242 uschar * sub_arg[3], * p, * domain;
5244 switch(read_subs(sub_arg, 3, 2, &s, flags, TRUE, name, &resetok, NULL))
5246 case -1: continue; /* If skipping, we don't actually do anything */
5247 case 1: goto EXPAND_FAILED_CURLY;
5249 case 3: goto EXPAND_FAILED;
5252 /* sub_arg[0] is the address */
5253 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
5254 || domain == sub_arg[0] || Ustrlen(domain) == 1)
5256 expand_string_message = US"prvs first argument must be a qualified email address";
5260 /* Calculate the hash. The third argument must be a single-digit
5261 key number, or unset. */
5264 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5266 expand_string_message = US"prvs third argument must be a single digit";
5270 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5273 expand_string_message = US"prvs hmac-sha1 conversion failed";
5277 /* Now separate the domain from the local part */
5280 yield = string_catn(yield, US"prvs=", 5);
5281 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5282 yield = string_catn(yield, prvs_daystamp(7), 3);
5283 yield = string_catn(yield, p, 6);
5284 yield = string_catn(yield, US"=", 1);
5285 yield = string_cat (yield, sub_arg[0]);
5286 yield = string_catn(yield, US"@", 1);
5287 yield = string_cat (yield, domain);
5292 /* Check a prvs-encoded address for validity */
5294 case EITEM_PRVSCHECK:
5296 uschar * sub_arg[3], * p;
5298 const pcre2_code * re;
5300 /* Reset expansion variables */
5301 prvscheck_result = NULL;
5302 prvscheck_address = NULL;
5303 prvscheck_keynum = NULL;
5305 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5307 case 1: goto EXPAND_FAILED_CURLY;
5309 case 3: goto EXPAND_FAILED;
5312 re = regex_must_compile(
5313 US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5314 MCS_CASELESS | MCS_CACHEABLE, FALSE);
5316 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5318 uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5319 uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5320 uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5321 uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5322 uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5326 debug_printf_indent("prvscheck localpart: %s\n", local_part);
5327 debug_printf_indent("prvscheck key number: %s\n", key_num);
5328 debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5329 debug_printf_indent("prvscheck hash: %s\n", hash);
5330 debug_printf_indent("prvscheck domain: %s\n", domain);
5333 /* Set up expansion variables */
5334 g = string_cat (NULL, local_part);
5335 g = string_catn(g, US"@", 1);
5336 g = string_cat (g, domain);
5337 prvscheck_address = string_from_gstring(g);
5338 prvscheck_keynum = string_copy(key_num);
5340 /* Now expand the second argument */
5341 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5343 case 1: goto EXPAND_FAILED_CURLY;
5345 case 3: goto EXPAND_FAILED;
5348 /* Now we have the key and can check the address. */
5350 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5354 expand_string_message = US"hmac-sha1 conversion failed";
5358 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5359 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
5361 if (Ustrcmp(p,hash) == 0)
5363 /* Success, valid BATV address. Now check the expiry date. */
5364 uschar *now = prvs_daystamp(0);
5365 unsigned int inow = 0,iexpire = 1;
5367 (void)sscanf(CS now,"%u",&inow);
5368 (void)sscanf(CS daystamp,"%u",&iexpire);
5370 /* When "iexpire" is < 7, a "flip" has occurred.
5371 Adjust "inow" accordingly. */
5372 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5374 if (iexpire >= inow)
5376 prvscheck_result = US"1";
5377 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
5381 prvscheck_result = NULL;
5382 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
5387 prvscheck_result = NULL;
5388 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
5391 /* Now expand the final argument. We leave this till now so that
5392 it can include $prvscheck_result. */
5394 switch(read_subs(sub_arg, 1, 0, &s, flags, TRUE, name, &resetok, NULL))
5396 case 1: goto EXPAND_FAILED_CURLY;
5398 case 3: goto EXPAND_FAILED;
5401 yield = string_cat(yield,
5402 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5404 /* Reset the "internal" variables afterwards, because they are in
5405 dynamic store that will be reclaimed if the expansion succeeded. */
5407 prvscheck_address = NULL;
5408 prvscheck_keynum = NULL;
5411 /* Does not look like a prvs encoded address, return the empty string.
5412 We need to make sure all subs are expanded first, so as to skip over
5415 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5417 case 1: goto EXPAND_FAILED_CURLY;
5419 case 3: goto EXPAND_FAILED;
5422 if (flags & ESI_SKIPPING) continue;
5426 /* Handle "readfile" to insert an entire file */
5428 case EITEM_READFILE:
5431 uschar * sub_arg[2];
5433 if ((expand_forbid & RDO_READFILE) != 0)
5435 expand_string_message = US"file insertions are not permitted";
5439 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5441 case 1: goto EXPAND_FAILED_CURLY;
5443 case 3: goto EXPAND_FAILED;
5446 /* If skipping, we don't actually do anything */
5448 if (flags & ESI_SKIPPING) continue;
5450 /* Open the file and read it */
5452 if (!(f = Ufopen(sub_arg[0], "rb")))
5454 expand_string_message = string_open_failed("%s", sub_arg[0]);
5458 yield = cat_file(f, yield, sub_arg[1]);
5463 /* Handle "readsocket" to insert data from a socket, either
5464 Inet or Unix domain */
5466 case EITEM_READSOCK:
5469 uschar * sub_arg[4];
5471 if (expand_forbid & RDO_READSOCK)
5473 expand_string_message = US"socket insertions are not permitted";
5477 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5478 because there may be a string for expansion on failure. */
5480 switch(read_subs(sub_arg, 4, 2, &s, flags, FALSE, name, &resetok, NULL))
5482 case 1: goto EXPAND_FAILED_CURLY;
5483 case 2: /* Won't occur: no end check */
5484 case 3: goto EXPAND_FAILED;
5487 /* If skipping, we don't actually do anything. Otherwise, arrange to
5488 connect to either an IP or a Unix socket. */
5490 if (!(flags & ESI_SKIPPING))
5492 int stype = search_findtype(US"readsock", 8);
5495 int expand_setup = -1;
5498 /* If the reqstr is empty, flag that and set a dummy */
5502 g = string_append_listele(g, ',', US"send=no");
5503 sub_arg[1] = US"DUMMY";
5506 /* Re-marshall the options */
5510 const uschar * list = sub_arg[2];
5514 /* First option has no tag and is timeout */
5515 if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5516 g = string_append_listele(g, ',',
5517 string_sprintf("timeout=%s", item));
5519 /* The rest of the options from the expansion */
5520 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5521 g = string_append_listele(g, ',', item);
5523 /* possibly plus an EOL string. Process with escapes, to protect
5524 from list-processing. The only current user of eol= in search
5525 options is the readsock expansion. */
5527 if (sub_arg[3] && *sub_arg[3])
5528 g = string_append_listele(g, ',',
5529 string_sprintf("eol=%s",
5530 string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5533 /* Gat a (possibly cached) handle for the connection */
5535 if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5537 if (*expand_string_message) goto EXPAND_FAILED;
5538 expand_string_message = search_error_message;
5539 search_error_message = NULL;
5543 /* Get (possibly cached) results for the lookup */
5544 /* sspec: sub_arg[0] req: sub_arg[1] opts: g */
5546 if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5547 &expand_setup, string_from_gstring(g))))
5548 yield = string_cat(yield, s);
5549 else if (f.search_find_defer)
5551 expand_string_message = search_error_message;
5552 search_error_message = NULL;
5556 { /* should not happen, at present */
5557 expand_string_message = search_error_message;
5558 search_error_message = NULL;
5563 /* The whole thing has worked (or we were skipping). If there is a
5564 failure string following, we need to skip it. */
5566 if (*s == '{') /*}*/
5568 if (!expand_string_internal(s+1,
5569 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL))
5570 goto EXPAND_FAILED; /*{*/
5573 expand_string_message = US"missing '}' closing failstring for readsocket";
5574 goto EXPAND_FAILED_CURLY;
5576 Uskip_whitespace(&s);
5579 READSOCK_DONE: /*{*/
5582 expand_string_message = US"missing '}' closing readsocket";
5583 goto EXPAND_FAILED_CURLY;
5585 if (flags & ESI_SKIPPING) continue;
5588 /* Come here on failure to create socket, connect socket, write to the
5589 socket, or timeout on reading. If another substring follows, expand and
5590 use it. Otherwise, those conditions give expand errors. */
5593 if (*s != '{') goto EXPAND_FAILED; /*}*/
5594 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5595 if (!(arg = expand_string_internal(s+1,
5596 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR, &s, &resetok, NULL)))
5598 yield = string_cat(yield, arg); /*{*/
5601 expand_string_message = US"missing '}' closing failstring for readsocket";
5602 goto EXPAND_FAILED_CURLY;
5604 Uskip_whitespace(&s);
5608 /* Handle "run" to execute a program. */
5613 const uschar * arg, ** argv;
5614 BOOL late_expand = TRUE;
5616 if ((expand_forbid & RDO_RUN) != 0)
5618 expand_string_message = US"running a command is not permitted";
5622 /* Handle options to the "run" */
5626 if (Ustrncmp(++s, "preexpand", 9) == 0)
5627 { late_expand = FALSE; s += 9; }
5630 const uschar * t = s;
5631 while (isalpha(*++t)) ;
5632 expand_string_message = string_sprintf("bad option '%.*s' for run",
5637 Uskip_whitespace(&s);
5639 if (*s != '{') /*}*/
5641 expand_string_message = US"missing '{' for command arg of run";
5642 goto EXPAND_FAILED_CURLY; /*"}*/
5646 if (late_expand) /* this is the default case */
5648 int n = Ustrcspn(s, "}");
5649 arg = flags & ESI_SKIPPING ? NULL : string_copyn(s, n);
5654 if (!(arg = expand_string_internal(s,
5655 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5657 Uskip_whitespace(&s);
5662 expand_string_message = US"missing '}' closing command arg of run";
5663 goto EXPAND_FAILED_CURLY;
5666 if (flags & ESI_SKIPPING) /* Just pretend it worked when we're skipping */
5669 lookup_value = NULL;
5676 if (!transport_set_up_command(&argv, /* anchor for arg list */
5677 arg, /* raw command */
5678 late_expand, /* expand args if not already done */
5679 0, /* not relevant when... */
5680 NULL, /* no transporting address */
5681 late_expand, /* allow tainted args, when expand-after-split */
5682 US"${run} expansion", /* for error messages */
5683 &expand_string_message)) /* where to put error message */
5686 /* Create the child process, making it a group leader. */
5688 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5689 US"expand-run")) < 0)
5691 expand_string_message =
5692 string_sprintf("couldn't create child process: %s", strerror(errno));
5696 /* Nothing is written to the standard input. */
5700 /* Read the pipe to get the command's output into $value (which is kept
5701 in lookup_value). Read during execution, so that if the output exceeds
5702 the OS pipe buffer limit, we don't block forever. Remember to not release
5703 memory just allocated for $value. */
5706 f = fdopen(fd_out, "rb");
5707 sigalrm_seen = FALSE;
5709 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5713 /* Wait for the process to finish, applying the timeout, and inspect its
5714 return code for serious disasters. Simple non-zero returns are passed on.
5717 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5719 if (sigalrm_seen || runrc == -256)
5721 expand_string_message = US"command timed out";
5722 killpg(pid, SIGKILL); /* Kill the whole process group */
5725 else if (runrc == -257)
5726 expand_string_message = string_sprintf("wait() failed: %s",
5730 expand_string_message = string_sprintf("command killed by signal %d",
5737 /* Process the yes/no strings; $value may be useful in both cases */
5739 switch(process_yesno(
5740 flags, /* were previously skipping */
5741 runrc == 0, /* success/failure indicator */
5742 lookup_value, /* value to reset for string2 */
5743 &s, /* input pointer */
5744 &yield, /* output pointer */
5745 US"run", /* condition type */
5748 case 1: goto EXPAND_FAILED; /* when all is well, the */
5749 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5752 if (flags & ESI_SKIPPING) continue;
5756 /* Handle character translation for "tr" */
5760 int oldptr = gstring_length(yield);
5764 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5766 case -1: continue; /* skipping */
5767 case 1: goto EXPAND_FAILED_CURLY;
5769 case 3: goto EXPAND_FAILED;
5772 yield = string_cat(yield, sub[0]);
5773 o2m = Ustrlen(sub[2]) - 1;
5775 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5777 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5781 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5788 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5789 expanded arguments. */
5798 int val[2] = { 0, -1 };
5801 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5802 Ensure that sub[2] is set in the ${length } case. */
5805 switch(read_subs(sub, item_type == EITEM_LENGTH ? 2:3, 2, &s, flags,
5806 TRUE, name, &resetok, NULL))
5808 case -1: continue; /* skipping */
5809 case 1: goto EXPAND_FAILED_CURLY;
5811 case 3: goto EXPAND_FAILED;
5814 /* Juggle the arguments if there are only two of them: always move the
5815 string to the last position and make ${length{n}{str}} equivalent to
5816 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5822 if (item_type == EITEM_LENGTH)
5829 for (int i = 0; i < 2; i++) if (sub[i])
5831 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5832 if (*ret != 0 || (i != 0 && val[i] < 0))
5834 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5835 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5841 item_type == EITEM_HASH
5842 ? compute_hash(sub[2], val[0], val[1], &len)
5843 : item_type == EITEM_NHASH
5844 ? compute_nhash(sub[2], val[0], val[1], &len)
5845 : extract_substr(sub[2], val[0], val[1], &len);
5848 yield = string_catn(yield, ret, len);
5852 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5853 This code originally contributed by Steve Haslam. It currently supports
5854 the use of MD5 and SHA-1 hashes.
5856 We need some workspace that is large enough to handle all the supported
5857 hash types. Use macros to set the sizes rather than be too elaborate. */
5859 #define MAX_HASHLEN 20
5860 #define MAX_HASHBLOCKLEN 64
5869 int hashlen; /* Number of octets for the hash algorithm's output */
5870 int hashblocklen; /* Number of octets the hash algorithm processes */
5871 uschar * keyptr, * p;
5872 unsigned int keylen;
5874 uschar keyhash[MAX_HASHLEN];
5875 uschar innerhash[MAX_HASHLEN];
5876 uschar finalhash[MAX_HASHLEN];
5877 uschar finalhash_hex[2*MAX_HASHLEN];
5878 uschar innerkey[MAX_HASHBLOCKLEN];
5879 uschar outerkey[MAX_HASHBLOCKLEN];
5881 switch (read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5883 case -1: continue; /* skipping */
5884 case 1: goto EXPAND_FAILED_CURLY;
5886 case 3: goto EXPAND_FAILED;
5889 if (Ustrcmp(sub[0], "md5") == 0)
5892 use_base = &md5_base;
5896 else if (Ustrcmp(sub[0], "sha1") == 0)
5899 use_base = &sha1_ctx;
5905 expand_string_message =
5906 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5911 keylen = Ustrlen(keyptr);
5913 /* If the key is longer than the hash block length, then hash the key
5916 if (keylen > hashblocklen)
5918 chash_start(type, use_base);
5919 chash_end(type, use_base, keyptr, keylen, keyhash);
5924 /* Now make the inner and outer key values */
5926 memset(innerkey, 0x36, hashblocklen);
5927 memset(outerkey, 0x5c, hashblocklen);
5929 for (int i = 0; i < keylen; i++)
5931 innerkey[i] ^= keyptr[i];
5932 outerkey[i] ^= keyptr[i];
5935 /* Now do the hashes */
5937 chash_start(type, use_base);
5938 chash_mid(type, use_base, innerkey);
5939 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5941 chash_start(type, use_base);
5942 chash_mid(type, use_base, outerkey);
5943 chash_end(type, use_base, innerhash, hashlen, finalhash);
5945 /* Encode the final hash as a hex string */
5948 for (int i = 0; i < hashlen; i++)
5950 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5951 *p++ = hex_digits[finalhash[i] & 0x0f];
5954 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5955 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5957 yield = string_catn(yield, finalhash_hex, hashlen*2);
5961 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5962 We have to save the numerical variables and restore them afterwards. */
5966 const pcre2_code * re;
5967 int moffset, moffsetextra, slen;
5968 pcre2_match_data * md;
5970 uschar * subject, * sub[3];
5971 int save_expand_nmax =
5972 save_expand_strings(save_expand_nstring, save_expand_nlength);
5973 unsigned sub_textonly = 0;
5975 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, &sub_textonly))
5977 case -1: continue; /* skipping */
5978 case 1: goto EXPAND_FAILED_CURLY;
5980 case 3: goto EXPAND_FAILED;
5983 /* Compile the regular expression */
5985 re = regex_compile(sub[1],
5986 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
5987 &expand_string_message, pcre_gen_cmp_ctx);
5991 md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
5993 /* Now run a loop to do the substitutions as often as necessary. It ends
5994 when there are no more matches. Take care over matches of the null string;
5995 do the same thing as Perl does. */
5998 slen = Ustrlen(sub[0]);
5999 moffset = moffsetextra = 0;
6004 PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
6005 int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
6006 PCRE_EOPT | emptyopt, md, pcre_gen_mtc_ctx);
6009 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
6010 is not necessarily the end. We want to repeat the match from one
6011 character further along, but leaving the basic offset the same (for
6012 copying below). We can't be at the end of the string - that was checked
6013 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
6014 finished; copy the remaining string and end the loop. */
6024 yield = string_catn(yield, subject+moffset, slen-moffset);
6028 /* Match - set up for expanding the replacement. */
6029 DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
6031 if (n == 0) n = EXPAND_MAXN + 1;
6033 for (int nn = 0; nn < n*2; nn += 2)
6035 expand_nstring[expand_nmax] = subject + ovec[nn];
6036 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
6040 /* Copy the characters before the match, plus the expanded insertion. */
6042 yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
6044 if (!(insert = expand_string(sub[2])))
6046 yield = string_cat(yield, insert);
6052 /* If we have matched an empty string, first check to see if we are at
6053 the end of the subject. If so, the loop is over. Otherwise, mimic
6054 what Perl's /g options does. This turns out to be rather cunning. First
6055 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
6056 string at the same point. If this fails (picked up above) we advance to
6057 the next character. */
6059 if (ovec[0] == ovec[1])
6061 if (ovec[0] == slen) break;
6062 emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
6066 /* All done - restore numerical variables. */
6068 /* pcre2_match_data_free(md); gen ctx needs no free */
6069 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6070 save_expand_nlength);
6074 /* Handle keyed and numbered substring extraction. If the first argument
6075 consists entirely of digits, then a numerical extraction is assumed. */
6079 int field_number = 1;
6080 BOOL field_number_set = FALSE;
6081 uschar * save_lookup_value = lookup_value, * sub[3];
6082 int save_expand_nmax =
6083 save_expand_strings(save_expand_nstring, save_expand_nlength);
6085 /* On reflection the original behaviour of extract-json for a string
6086 result, leaving it quoted, was a mistake. But it was already published,
6087 hence the addition of jsons. In a future major version, make json
6088 work like josons, and withdraw jsons. */
6090 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
6092 /* Check for a format-variant specifier */
6094 if (Uskip_whitespace(&s) != '{') /*}*/
6095 if (Ustrncmp(s, "json", 4) == 0)
6096 if (*(s += 4) == 's')
6097 {fmt = extract_jsons; s++;}
6101 /* While skipping we cannot rely on the data for expansions being
6102 available (eg. $item) hence cannot decide on numeric vs. keyed.
6103 Read a maximum of 5 arguments (including the yes/no) */
6105 if (flags & ESI_SKIPPING)
6107 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
6109 if (!expand_string_internal(s+1,
6110 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL))
6111 goto EXPAND_FAILED; /*'{'*/
6114 expand_string_message = US"missing '{' for arg of extract";
6115 goto EXPAND_FAILED_CURLY;
6117 Uskip_whitespace(&s);
6119 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
6120 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
6124 Uskip_whitespace(&s);
6128 expand_string_message = US"missing '}' closing extract";
6129 goto EXPAND_FAILED_CURLY;
6133 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
6135 if (Uskip_whitespace(&s) == '{') /*'}'*/
6137 if (!(sub[i] = expand_string_internal(s+1,
6138 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6139 goto EXPAND_FAILED; /*'{'*/
6142 expand_string_message = string_sprintf(
6143 "missing '}' closing arg %d of extract", i+1);
6144 goto EXPAND_FAILED_CURLY;
6147 /* After removal of leading and trailing white space, the first
6148 argument must not be empty; if it consists entirely of digits
6149 (optionally preceded by a minus sign), this is a numerical
6150 extraction, and we expect 3 arguments (normal) or 2 (json). */
6156 uschar * p = sub[0];
6158 Uskip_whitespace(&p);
6162 while (len > 0 && isspace(p[len-1])) len--;
6167 expand_string_message = US"first argument of \"extract\" must "
6177 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6181 if (fmt == extract_basic) j = 3; /* Need 3 args */
6182 field_number_set = TRUE;
6188 expand_string_message = string_sprintf(
6189 "missing '{' for arg %d of extract", i+1);
6190 goto EXPAND_FAILED_CURLY;
6194 /* Extract either the numbered or the keyed substring into $value. If
6195 skipping, just pretend the extraction failed. */
6197 if (flags & ESI_SKIPPING)
6198 lookup_value = NULL;
6202 lookup_value = field_number_set
6203 ? expand_gettokened(field_number, sub[1], sub[2])
6204 : expand_getkeyed(sub[0], sub[1]);
6211 const uschar * list;
6213 /* Array: Bracket-enclosed and comma-separated.
6214 Object: Brace-enclosed, comma-sep list of name:value pairs */
6216 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6218 expand_string_message =
6219 string_sprintf("%s wrapping %s for extract json",
6220 expand_string_message,
6221 field_number_set ? "array" : "object");
6222 goto EXPAND_FAILED_CURLY;
6226 if (field_number_set)
6228 if (field_number <= 0)
6230 expand_string_message = US"first argument of \"extract\" must "
6231 "be greater than zero";
6234 while (field_number > 0 && (item = json_nextinlist(&list)))
6236 if ((lookup_value = s = item))
6239 while (--s >= lookup_value && isspace(*s)) *s = '\0';
6244 lookup_value = NULL;
6245 while ((item = json_nextinlist(&list)))
6247 /* Item is: string name-sep value. string is quoted.
6248 Dequote the string and compare with the search key. */
6250 if (!(item = dewrap(item, US"\"\"")))
6252 expand_string_message =
6253 string_sprintf("%s wrapping string key for extract json",
6254 expand_string_message);
6255 goto EXPAND_FAILED_CURLY;
6257 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
6259 s = item + Ustrlen(item) + 1;
6260 if (Uskip_whitespace(&s) != ':')
6262 expand_string_message =
6263 US"missing object value-separator for extract json";
6264 goto EXPAND_FAILED_CURLY;
6267 Uskip_whitespace(&s);
6275 if ( fmt == extract_jsons
6277 && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6279 expand_string_message =
6280 string_sprintf("%s wrapping string result for extract jsons",
6281 expand_string_message);
6282 goto EXPAND_FAILED_CURLY;
6287 /* If no string follows, $value gets substituted; otherwise there can
6288 be yes/no strings, as for lookup or if. */
6290 switch(process_yesno(
6291 flags, /* were previously skipping */
6292 lookup_value != NULL, /* success/failure indicator */
6293 save_lookup_value, /* value to reset for string2 */
6294 &s, /* input pointer */
6295 &yield, /* output pointer */
6296 US"extract", /* condition type */
6299 case 1: goto EXPAND_FAILED; /* when all is well, the */
6300 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6303 /* All done - restore numerical variables. */
6305 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6306 save_expand_nlength);
6308 if (flags & ESI_SKIPPING) continue;
6312 /* return the Nth item from a list */
6314 case EITEM_LISTEXTRACT:
6316 int field_number = 1;
6317 uschar * save_lookup_value = lookup_value, * sub[2];
6318 int save_expand_nmax =
6319 save_expand_strings(save_expand_nstring, save_expand_nlength);
6321 /* Read the field & list arguments */
6323 for (int i = 0; i < 2; i++)
6325 if (Uskip_whitespace(&s) != '{') /*}*/
6327 expand_string_message = string_sprintf(
6328 "missing '{' for arg %d of listextract", i+1); /*}*/
6329 goto EXPAND_FAILED_CURLY;
6332 sub[i] = expand_string_internal(s+1,
6333 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6334 if (!sub[i]) goto EXPAND_FAILED; /*{{*/
6337 expand_string_message = string_sprintf(
6338 "missing '}' closing arg %d of listextract", i+1);
6339 goto EXPAND_FAILED_CURLY;
6342 /* After removal of leading and trailing white space, the first
6343 argument must be numeric and nonempty. */
6351 Uskip_whitespace(&p);
6355 while (len > 0 && isspace(p[len-1])) len--;
6358 if (!*p && !(flags & ESI_SKIPPING))
6360 expand_string_message = US"first argument of \"listextract\" must "
6370 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6373 expand_string_message = US"first argument of \"listextract\" must "
6381 /* Extract the numbered element into $value. If
6382 skipping, just pretend the extraction failed. */
6384 lookup_value = flags & ESI_SKIPPING ? NULL : expand_getlistele(field_number, sub[1]);
6386 /* If no string follows, $value gets substituted; otherwise there can
6387 be yes/no strings, as for lookup or if. */
6389 switch(process_yesno(
6390 flags, /* were previously skipping */
6391 lookup_value != NULL, /* success/failure indicator */
6392 save_lookup_value, /* value to reset for string2 */
6393 &s, /* input pointer */
6394 &yield, /* output pointer */
6395 US"listextract", /* condition type */
6398 case 1: goto EXPAND_FAILED; /* when all is well, the */
6399 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6402 /* All done - restore numerical variables. */
6404 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6405 save_expand_nlength);
6407 if (flags & ESI_SKIPPING) continue;
6411 case EITEM_LISTQUOTE:
6414 switch(read_subs(sub, 2, 2, &s, flags, TRUE, name, &resetok, NULL))
6416 case -1: continue; /* skipping */
6417 case 1: goto EXPAND_FAILED_CURLY;
6419 case 3: goto EXPAND_FAILED;
6421 if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6423 if (c == sep) yield = string_catn(yield, sub[1], 1);
6424 yield = string_catn(yield, sub[1], 1);
6426 else yield = string_catn(yield, US" ", 1);
6431 case EITEM_CERTEXTRACT:
6433 uschar * save_lookup_value = lookup_value, * sub[2];
6434 int save_expand_nmax =
6435 save_expand_strings(save_expand_nstring, save_expand_nlength);
6437 /* Read the field argument */
6438 if (Uskip_whitespace(&s) != '{') /*}*/
6440 expand_string_message = US"missing '{' for field arg of certextract";
6441 goto EXPAND_FAILED_CURLY; /*}*/
6443 sub[0] = expand_string_internal(s+1,
6444 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6445 if (!sub[0]) goto EXPAND_FAILED; /*{{*/
6448 expand_string_message = US"missing '}' closing field arg of certextract";
6449 goto EXPAND_FAILED_CURLY;
6451 /* strip spaces fore & aft */
6456 Uskip_whitespace(&p);
6460 while (len > 0 && isspace(p[len-1])) len--;
6464 /* inspect the cert argument */
6465 if (Uskip_whitespace(&s) != '{') /*}*/
6467 expand_string_message = US"missing '{' for cert variable arg of certextract";
6468 goto EXPAND_FAILED_CURLY; /*}*/
6472 expand_string_message = US"second argument of \"certextract\" must "
6473 "be a certificate variable";
6476 sub[1] = expand_string_internal(s+1,
6477 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6478 if (!sub[1]) goto EXPAND_FAILED; /*{{*/
6481 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6482 goto EXPAND_FAILED_CURLY;
6485 if (flags & ESI_SKIPPING)
6486 lookup_value = NULL;
6489 lookup_value = expand_getcertele(sub[0], sub[1]);
6490 if (*expand_string_message) goto EXPAND_FAILED;
6492 switch(process_yesno(
6493 flags, /* were previously skipping */
6494 lookup_value != NULL, /* success/failure indicator */
6495 save_lookup_value, /* value to reset for string2 */
6496 &s, /* input pointer */
6497 &yield, /* output pointer */
6498 US"certextract", /* condition type */
6501 case 1: goto EXPAND_FAILED; /* when all is well, the */
6502 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6505 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6506 save_expand_nlength);
6507 if (flags & ESI_SKIPPING) continue;
6510 #endif /*DISABLE_TLS*/
6512 /* Handle list operations */
6518 int sep = 0, save_ptr = gstring_length(yield);
6519 uschar outsep[2] = { '\0', '\0' };
6520 const uschar *list, *expr, *temp;
6521 uschar * save_iterate_item = iterate_item;
6522 uschar * save_lookup_value = lookup_value;
6524 Uskip_whitespace(&s);
6525 if (*s++ != '{') /*}*/
6527 expand_string_message =
6528 string_sprintf("missing '{' for first arg of %s", name);
6529 goto EXPAND_FAILED_CURLY; /*}*/
6532 if (!(list = expand_string_internal(s,
6533 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6534 goto EXPAND_FAILED; /*{{*/
6537 expand_string_message =
6538 string_sprintf("missing '}' closing first arg of %s", name);
6539 goto EXPAND_FAILED_CURLY;
6542 if (item_type == EITEM_REDUCE)
6545 Uskip_whitespace(&s);
6546 if (*s++ != '{') /*}*/
6548 expand_string_message = US"missing '{' for second arg of reduce";
6549 goto EXPAND_FAILED_CURLY; /*}*/
6551 t = expand_string_internal(s,
6552 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6553 if (!t) goto EXPAND_FAILED;
6554 lookup_value = t; /*{{*/
6557 expand_string_message = US"missing '}' closing second arg of reduce";
6558 goto EXPAND_FAILED_CURLY;
6562 Uskip_whitespace(&s);
6563 if (*s++ != '{') /*}*/
6565 expand_string_message =
6566 string_sprintf("missing '{' for last arg of %s", name); /*}*/
6567 goto EXPAND_FAILED_CURLY;
6572 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6573 if scanning a "false" part). This allows us to find the end of the
6574 condition, because if the list is empty, we won't actually evaluate the
6575 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6576 the normal internal expansion function. */
6578 if (item_type != EITEM_FILTER)
6579 temp = expand_string_internal(s,
6580 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL);
6582 if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6586 expand_string_message = string_sprintf("%s inside \"%s\" item",
6587 expand_string_message, name);
6591 Uskip_whitespace(&s); /*{{{*/
6594 expand_string_message = string_sprintf("missing } at end of condition "
6595 "or expression inside \"%s\"; could be an unquoted } in the content",
6600 Uskip_whitespace(&s); /*{{*/
6603 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6608 /* If we are skipping, we can now just move on to the next item. When
6609 processing for real, we perform the iteration. */
6611 if (flags & ESI_SKIPPING) continue;
6612 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6614 *outsep = (uschar)sep; /* Separator as a string */
6616 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6617 name, iterate_item, lookup_value);
6619 if (item_type == EITEM_FILTER)
6622 /* the condition could modify $value, as a side-effect */
6623 uschar * save_value = lookup_value;
6625 if (!eval_condition(expr, &resetok, &condresult))
6627 iterate_item = save_iterate_item;
6628 lookup_value = save_lookup_value;
6629 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6630 expand_string_message, name);
6633 lookup_value = save_value;
6634 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6635 condresult? "true":"false");
6637 temp = iterate_item; /* TRUE => include this item */
6639 continue; /* FALSE => skip this item */
6642 else /* EITEM_MAP and EITEM_REDUCE */
6644 /* the expansion could modify $value, as a side-effect */
6645 uschar * t = expand_string_internal(expr,
6646 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, NULL, &resetok, NULL);
6649 iterate_item = save_iterate_item;
6650 expand_string_message = string_sprintf("%s inside \"%s\" item",
6651 expand_string_message, name);
6654 if (item_type == EITEM_REDUCE)
6656 lookup_value = t; /* Update the value of $value */
6657 continue; /* and continue the iteration */
6661 /* We reach here for FILTER if the condition is true, always for MAP,
6662 and never for REDUCE. The value in "temp" is to be added to the output
6663 list that is being created, ensuring that any occurrences of the
6664 separator character are doubled. Unless we are dealing with the first
6665 item of the output list, add in a space if the new item begins with the
6666 separator character, or is an empty string. */
6668 /*XXX is there not a standard support function for this, appending to a list? */
6669 /* yes, string_append_listele(), but it depends on lack of text before the list */
6671 if ( yield && yield->ptr != save_ptr
6672 && (temp[0] == *outsep || temp[0] == 0))
6673 yield = string_catn(yield, US" ", 1);
6675 /* Add the string in "temp" to the output list that we are building,
6676 This is done in chunks by searching for the separator character. */
6680 size_t seglen = Ustrcspn(temp, outsep);
6682 yield = string_catn(yield, temp, seglen + 1);
6684 /* If we got to the end of the string we output one character
6685 too many; backup and end the loop. Otherwise arrange to double the
6688 if (!temp[seglen]) { yield->ptr--; break; }
6689 yield = string_catn(yield, outsep, 1);
6693 /* Output a separator after the string: we will remove the redundant
6694 final one at the end. */
6696 yield = string_catn(yield, outsep, 1);
6697 } /* End of iteration over the list loop */
6699 /* REDUCE has generated no output above: output the final value of
6702 if (item_type == EITEM_REDUCE)
6704 yield = string_cat(yield, lookup_value);
6705 lookup_value = save_lookup_value; /* Restore $value */
6708 /* FILTER and MAP generate lists: if they have generated anything, remove
6709 the redundant final separator. Even though an empty item at the end of a
6710 list does not count, this is tidier. */
6712 else if (yield && yield->ptr != save_ptr) yield->ptr--;
6714 /* Restore preserved $item */
6716 iterate_item = save_iterate_item;
6717 if (flags & ESI_SKIPPING) continue;
6723 int sep = 0, cond_type;
6724 const uschar * srclist, * cmp, * xtract;
6725 uschar * opname, * srcitem;
6726 const uschar * dstlist = NULL, * dstkeylist = NULL;
6727 uschar * tmp, * save_iterate_item = iterate_item;
6729 Uskip_whitespace(&s);
6730 if (*s++ != '{') /*}*/
6732 expand_string_message = US"missing '{' for list arg of sort";
6733 goto EXPAND_FAILED_CURLY; /*}*/
6736 srclist = expand_string_internal(s,
6737 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6738 if (!srclist) goto EXPAND_FAILED; /*{{*/
6741 expand_string_message = US"missing '}' closing list arg of sort";
6742 goto EXPAND_FAILED_CURLY;
6745 Uskip_whitespace(&s);
6746 if (*s++ != '{') /*}*/
6748 expand_string_message = US"missing '{' for comparator arg of sort";
6749 goto EXPAND_FAILED_CURLY; /*}*/
6752 cmp = expand_string_internal(s,
6753 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6754 if (!cmp) goto EXPAND_FAILED; /*{{*/
6757 expand_string_message = US"missing '}' closing comparator arg of sort";
6758 goto EXPAND_FAILED_CURLY;
6761 if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6763 if (!expand_string_message)
6764 expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6769 case ECOND_NUM_L: case ECOND_NUM_LE:
6770 case ECOND_NUM_G: case ECOND_NUM_GE:
6771 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6772 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6776 expand_string_message = US"comparator not handled for sort";
6780 Uskip_whitespace(&s);
6781 if (*s++ != '{') /*}*/
6783 expand_string_message = US"missing '{' for extractor arg of sort";
6784 goto EXPAND_FAILED_CURLY; /*}*/
6788 if (!(tmp = expand_string_internal(s,
6789 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL)))
6791 xtract = string_copyn(xtract, s - xtract);
6795 expand_string_message = US"missing '}' closing extractor arg of sort";
6796 goto EXPAND_FAILED_CURLY;
6801 expand_string_message = US"missing } at end of \"sort\"";
6805 if (flags & ESI_SKIPPING) continue;
6807 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6809 uschar * srcfield, * dstitem;
6810 gstring * newlist = NULL, * newkeylist = NULL;
6812 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6814 /* extract field for comparisons */
6815 iterate_item = srcitem;
6816 if ( !(srcfield = expand_string_internal(xtract,
6817 ESI_HONOR_DOLLAR, NULL, &resetok, NULL))
6820 expand_string_message = string_sprintf(
6821 "field-extract in sort: \"%s\"", xtract);
6825 /* Insertion sort */
6827 /* copy output list until new-item < list-item */
6828 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6832 /* field for comparison */
6833 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6836 /* String-comparator names start with a letter; numeric names do not */
6838 if (sortsbefore(cond_type, isalpha(opname[0]),
6839 srcfield, dstfield))
6841 /* New-item sorts before this dst-item. Append new-item,
6842 then dst-item, then remainder of dst list. */
6844 newlist = string_append_listele(newlist, sep, srcitem);
6845 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6848 newlist = string_append_listele(newlist, sep, dstitem);
6849 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6851 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */
6852 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6854 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6856 newlist = string_append_listele(newlist, sep, dstitem);
6857 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6863 newlist = string_append_listele(newlist, sep, dstitem);
6864 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6867 /* If we ran out of dstlist without consuming srcitem, append it */
6870 newlist = string_append_listele(newlist, sep, srcitem);
6871 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6874 dstlist = newlist->s;
6875 dstkeylist = newkeylist->s;
6877 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6878 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6882 yield = string_cat(yield, dstlist);
6884 /* Restore preserved $item */
6885 iterate_item = save_iterate_item;
6889 expand_string_message = US"Internal error in sort (list mismatch)";
6894 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6895 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6896 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6897 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6899 #define EXPAND_DLFUNC_MAX_ARGS 8
6902 #ifndef EXPAND_DLFUNC
6903 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6904 "is not included in this binary";
6907 #else /* EXPAND_DLFUNC */
6910 exim_dlfunc_t * func;
6913 uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6915 if (expand_forbid & RDO_DLFUNC)
6917 expand_string_message =
6918 US"dynamically-loaded functions are not permitted";
6922 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, flags,
6923 TRUE, name, &resetok, NULL))
6925 case -1: continue; /* skipping */
6926 case 1: goto EXPAND_FAILED_CURLY;
6928 case 3: goto EXPAND_FAILED;
6931 /* Look up the dynamically loaded object handle in the tree. If it isn't
6932 found, dlopen() the file and put the handle in the tree for next time. */
6934 if (!(t = tree_search(dlobj_anchor, argv[0])))
6936 void * handle = dlopen(CS argv[0], RTLD_LAZY);
6939 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6940 argv[0], dlerror());
6941 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6944 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), argv[0]);
6945 Ustrcpy(t->name, argv[0]);
6946 t->data.ptr = handle;
6947 (void)tree_insertnode(&dlobj_anchor, t);
6950 /* Having obtained the dynamically loaded object handle, look up the
6951 function pointer. */
6953 if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6955 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6956 "%s", argv[1], argv[0], dlerror());
6957 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6961 /* Call the function and work out what to do with the result. If it
6962 returns OK, we have a replacement string; if it returns DEFER then
6963 expansion has failed in a non-forced manner; if it returns FAIL then
6964 failure was forced; if it returns ERROR or any other value there's a
6965 problem, so panic slightly. In any case, assume that the function has
6966 side-effects on the store that must be preserved. */
6970 for (argc = 0; argv[argc]; argc++) ;
6972 if ((status = func(&result, argc - 2, &argv[2])) != OK)
6974 expand_string_message = result ? result : US"(no message)";
6975 if (status == FAIL_FORCED)
6976 f.expand_string_forcedfail = TRUE;
6977 else if (status != FAIL)
6978 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6979 argv[0], argv[1], status, expand_string_message);
6983 if (result) yield = string_cat(yield, result);
6986 #endif /* EXPAND_DLFUNC */
6988 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6991 uschar *save_lookup_value = lookup_value;
6993 if (Uskip_whitespace(&s) != '{') /*}*/
6996 key = expand_string_internal(s+1,
6997 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6998 if (!key) goto EXPAND_FAILED; /*{{*/
7001 expand_string_message = US"missing '}' for name arg of env";
7002 goto EXPAND_FAILED_CURLY;
7005 lookup_value = US getenv(CS key);
7007 switch(process_yesno(
7008 flags, /* were previously skipping */
7009 lookup_value != NULL, /* success/failure indicator */
7010 save_lookup_value, /* value to reset for string2 */
7011 &s, /* input pointer */
7012 &yield, /* output pointer */
7013 US"env", /* condition type */
7016 case 1: goto EXPAND_FAILED; /* when all is well, the */
7017 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
7019 if (flags & ESI_SKIPPING) continue;
7024 case EITEM_SRS_ENCODE:
7025 /* ${srs_encode {secret} {return_path} {orig_domain}} */
7030 BOOL quoted = FALSE;
7032 switch (read_subs(sub, 3, 3, CUSS &s, flags, TRUE, name, &resetok, NULL))
7034 case -1: continue; /* skipping */
7035 case 1: goto EXPAND_FAILED_CURLY;
7037 case 3: goto EXPAND_FAILED;
7040 if (sub[1] && *(sub[1]))
7042 g = string_catn(g, US"SRS0=", 5);
7044 /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
7045 hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
7046 g = string_catn(g, cksum, sizeof(cksum));
7047 g = string_catn(g, US"=", 1);
7049 /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
7055 gettimeofday(&now, NULL);
7056 for (unsigned long i = (now.tv_sec / 86400) & 0x3ff; i; i >>= 5)
7057 h = string_catn(h, &base32_chars[i & 0x1f], 1);
7058 if (h) while (h->ptr > 0)
7059 g = string_catn(g, &h->s[--h->ptr], 1);
7061 g = string_catn(g, US"=", 1);
7063 /* ${domain:$return_path}=${local_part:$return_path} */
7065 int start, end, domain;
7066 uschar * t = parse_extract_address(sub[1], &expand_string_message,
7067 &start, &end, &domain, FALSE);
7073 if (domain > 0) g = string_cat(g, t + domain);
7074 g = string_catn(g, US"=", 1);
7076 s = domain > 0 ? string_copyn(t, domain - 1) : t;
7077 if ((quoted = Ustrchr(s, '"') != NULL))
7080 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
7081 while (*s) /* de-quote */
7083 while (*s && *s != '"') h = string_catn(h, s++, 1);
7085 while (*s && *s != '"') h = string_catn(h, s++, 1);
7088 gstring_release_unused(h);
7089 s = string_from_gstring(h);
7091 g = string_cat(g, s);
7094 /* Assume that if the original local_part had quotes
7095 it was for good reason */
7097 if (quoted) yield = string_catn(yield, US"\"", 1);
7098 yield = string_catn(yield, g->s, g->ptr);
7099 if (quoted) yield = string_catn(yield, US"\"", 1);
7101 /* @$original_domain */
7102 yield = string_catn(yield, US"@", 1);
7103 yield = string_cat(yield, sub[2]);
7106 DEBUG(D_expand) debug_printf_indent("null return_path for srs-encode\n");
7110 #endif /*SUPPORT_SRS*/
7114 } /* EITEM_* switch */
7118 if (yield && (start > 0 || *s)) /* only if not the sole expansion of the line */
7119 debug_expansion_interim(US"item-res",
7120 yield->s + start, yield->ptr - start, !!(flags & ESI_SKIPPING));
7126 /* Control reaches here if the name is not recognized as one of the more
7127 complicated expansion items. Check for the "operator" syntax (name terminated
7128 by a colon). Some of the operators have arguments, separated by _ from the
7134 uschar * arg = NULL, * sub;
7136 var_entry * vp = NULL;
7139 /* Owing to an historical mis-design, an underscore may be part of the
7140 operator name, or it may introduce arguments. We therefore first scan the
7141 table of names that contain underscores. If there is no match, we cut off
7142 the arguments and then scan the main table. */
7144 if ((c = chop_match(name, op_table_underscore,
7145 nelem(op_table_underscore))) < 0)
7147 if ((arg = Ustrchr(name, '_')))
7149 if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
7150 c += nelem(op_table_underscore);
7151 if (arg) *arg++ = '_'; /* Put back for error messages */
7154 /* Deal specially with operators that might take a certificate variable
7155 as we do not want to do the usual expansion. For most, expand the string.*/
7165 const uschar * s1 = s;
7166 sub = expand_string_internal(s+2,
7167 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s1, &resetok, NULL);
7168 if (!sub) goto EXPAND_FAILED; /*{*/
7171 expand_string_message =
7172 string_sprintf("missing '}' closing cert arg of %s", name);
7173 goto EXPAND_FAILED_CURLY;
7175 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
7185 sub = expand_string_internal(s+1,
7186 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7187 if (!sub) goto EXPAND_FAILED;
7192 /* If we are skipping, we don't need to perform the operation at all.
7193 This matters for operations like "mask", because the data may not be
7194 in the correct format when skipping. For example, the expression may test
7195 for the existence of $sender_host_address before trying to mask it. For
7196 other operations, doing them may not fail, but it is a waste of time. */
7198 if (flags & ESI_SKIPPING && c >= 0) continue;
7200 /* Otherwise, switch on the operator type. After handling go back
7201 to the main loop top. */
7204 int start = yield->ptr;
7210 unsigned long int n = Ustrtoul(sub, &t, 10);
7215 expand_string_message = string_sprintf("argument for base32 "
7216 "operator is \"%s\", which is not a decimal number", sub);
7220 g = string_catn(g, &base32_chars[n & 0x1f], 1);
7222 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7229 unsigned long int n = 0;
7232 uschar * t = Ustrchr(base32_chars, *tt++);
7235 expand_string_message = string_sprintf("argument for base32d "
7236 "operator is \"%s\", which is not a base 32 number", sub);
7239 n = n * 32 + (t - base32_chars);
7241 yield = string_fmt_append(yield, "%ld", n);
7248 unsigned long int n = Ustrtoul(sub, &t, 10);
7251 expand_string_message = string_sprintf("argument for base62 "
7252 "operator is \"%s\", which is not a decimal number", sub);
7255 yield = string_cat(yield, string_base62(n));
7259 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7264 unsigned long int n = 0;
7267 uschar *t = Ustrchr(base62_chars, *tt++);
7270 expand_string_message = string_sprintf("argument for base62d "
7271 "operator is \"%s\", which is not a base %d number", sub,
7275 n = n * BASE_62 + (t - base62_chars);
7277 yield = string_fmt_append(yield, "%ld", n);
7283 uschar *expanded = expand_string_internal(sub,
7284 ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, NULL, &resetok, NULL);
7287 expand_string_message =
7288 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7289 expand_string_message);
7292 yield = string_cat(yield, expanded);
7299 uschar *t = sub - 1;
7300 while (*(++t) != 0) { *t = tolower(*t); count++; }
7301 yield = string_catn(yield, sub, count);
7308 uschar *t = sub - 1;
7309 while (*(++t) != 0) { *t = toupper(*t); count++; }
7310 yield = string_catn(yield, sub, count);
7316 if (vp && *(void **)vp->value)
7318 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7319 yield = string_cat(yield, cp);
7327 md5_end(&base, sub, Ustrlen(sub), digest);
7328 for (int j = 0; j < 16; j++)
7329 yield = string_fmt_append(yield, "%02x", digest[j]);
7335 if (vp && *(void **)vp->value)
7337 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7338 yield = string_cat(yield, cp);
7346 sha1_end(&h, sub, Ustrlen(sub), digest);
7347 for (int j = 0; j < 20; j++)
7348 yield = string_fmt_append(yield, "%02X", digest[j]);
7354 #ifdef EXIM_HAVE_SHA2
7355 if (vp && *(void **)vp->value)
7356 if (c == EOP_SHA256)
7357 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7359 expand_string_message = US"sha2_N not supported with certificates";
7364 hashmethod m = !arg ? HASH_SHA2_256
7365 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7366 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7367 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7370 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7372 expand_string_message = US"unrecognised sha2 variant";
7376 exim_sha_update_string(&h, sub);
7377 exim_sha_finish(&h, &b);
7379 yield = string_fmt_append(yield, "%02X", *b.data++);
7382 expand_string_message = US"sha256 only supported with TLS";
7387 #ifdef EXIM_HAVE_SHA3
7391 hashmethod m = !arg ? HASH_SHA3_256
7392 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7393 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7394 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7395 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7398 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7400 expand_string_message = US"unrecognised sha3 variant";
7404 exim_sha_update_string(&h, sub);
7405 exim_sha_finish(&h, &b);
7407 yield = string_fmt_append(yield, "%02X", *b.data++);
7411 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7415 /* Convert hex encoding to base64 encoding */
7425 for (enc = sub; *enc; enc++)
7427 if (!isxdigit(*enc))
7429 expand_string_message = string_sprintf("\"%s\" is not a hex "
7438 expand_string_message = string_sprintf("\"%s\" contains an odd "
7439 "number of characters", sub);
7443 while ((c = *in++) != 0)
7445 if (isdigit(c)) c -= '0';
7446 else c = toupper(c) - 'A' + 10;
7456 enc = b64encode(CUS sub, out - sub);
7457 yield = string_cat(yield, enc);
7461 /* Convert octets outside 0x21..0x7E to \xXX form */
7465 uschar *t = sub - 1;
7468 if (*t < 0x21 || 0x7E < *t)
7469 yield = string_fmt_append(yield, "\\x%02x", *t);
7471 yield = string_catn(yield, t, 1);
7476 /* count the number of list elements */
7480 int cnt = 0, sep = 0;
7481 uschar * buf = store_get(2, sub);
7483 while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7484 yield = string_fmt_append(yield, "%d", cnt);
7488 /* expand a named list given the name */
7489 /* handles nested named lists; requotes as colon-sep list */
7492 expand_string_message = NULL;
7493 yield = expand_listnamed(yield, sub, arg);
7494 if (expand_string_message)
7498 /* quote a list-item for the given list-separator */
7500 /* mask applies a mask to an IP address; for example the result of
7501 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7508 int type, mask, maskoffset;
7512 if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7514 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7519 if (maskoffset == 0)
7521 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7526 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7528 if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7530 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7535 /* If an optional 'n' was given, ipv6 gets normalised output:
7536 colons rather than dots, and zero-compressed. */
7538 normalised = arg && *arg == 'n';
7540 /* Convert the address to binary integer(s) and apply the mask */
7542 sub[maskoffset] = 0;
7543 count = host_aton(sub, binary);
7544 host_mask(count, binary, mask);
7546 /* Convert to masked textual format and add to output. */
7548 if (type == 4 || !normalised)
7549 yield = string_catn(yield, buffer,
7550 host_nmtoa(count, binary, mask, buffer, '.'));
7553 ipv6_nmtoa(binary, buffer);
7554 yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7560 case EOP_IPV6DENORM:
7562 int type = string_is_ip_address(sub, NULL);
7569 (void) host_aton(sub, binary);
7572 case 4: /* convert to IPv4-mapped IPv6 */
7573 binary[0] = binary[1] = 0;
7574 binary[2] = 0x0000ffff;
7575 (void) host_aton(sub, binary+3);
7579 expand_string_message =
7580 string_sprintf("\"%s\" is not an IP address", sub);
7584 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7585 ? ipv6_nmtoa(binary, buffer)
7586 : host_nmtoa(4, binary, -1, buffer, ':')
7592 case EOP_LOCAL_PART:
7596 int start, end, domain;
7597 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7600 if (c != EOP_DOMAIN)
7601 yield = c == EOP_LOCAL_PART && domain > 0
7602 ? string_catn(yield, t, domain - 1)
7603 : string_cat(yield, t);
7604 else if (domain > 0)
7605 yield = string_cat(yield, t + domain);
7611 uschar outsep[2] = { ':', '\0' };
7612 uschar *address, *error;
7613 int save_ptr = gstring_length(yield);
7614 int start, end, domain; /* Not really used */
7616 if (Uskip_whitespace(&sub) == '>')
7617 if (*outsep = *++sub) ++sub;
7620 expand_string_message = string_sprintf("output separator "
7621 "missing in expanding ${addresses:%s}", --sub);
7624 f.parse_allow_group = TRUE;
7628 uschar * p = parse_find_address_end(sub, FALSE);
7629 uschar saveend = *p;
7631 address = parse_extract_address(sub, &error, &start, &end, &domain,
7635 /* Add the address to the output list that we are building. This is
7636 done in chunks by searching for the separator character. At the
7637 start, unless we are dealing with the first address of the output
7638 list, add in a space if the new address begins with the separator
7639 character, or is an empty string. */
7643 if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7644 yield = string_catn(yield, US" ", 1);
7648 size_t seglen = Ustrcspn(address, outsep);
7649 yield = string_catn(yield, address, seglen + 1);
7651 /* If we got to the end of the string we output one character
7654 if (address[seglen] == '\0') { yield->ptr--; break; }
7655 yield = string_catn(yield, outsep, 1);
7656 address += seglen + 1;
7659 /* Output a separator after the string: we will remove the
7660 redundant final one at the end. */
7662 yield = string_catn(yield, outsep, 1);
7665 if (saveend == '\0') break;
7669 /* If we have generated anything, remove the redundant final
7672 if (yield && yield->ptr != save_ptr) yield->ptr--;
7673 f.parse_allow_group = FALSE;
7678 /* quote puts a string in quotes if it is empty or contains anything
7679 other than alphamerics, underscore, dot, or hyphen.
7681 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7682 be quoted in order to be a valid local part.
7684 In both cases, newlines and carriage returns are converted into \n and \r
7688 case EOP_QUOTE_LOCAL_PART:
7691 BOOL needs_quote = (!*sub); /* TRUE for empty string */
7692 uschar *t = sub - 1;
7695 while (!needs_quote && *++t)
7696 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7698 else /* EOP_QUOTE_LOCAL_PART */
7699 while (!needs_quote && *++t)
7700 needs_quote = !isalnum(*t)
7701 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7702 && (*t != '.' || t == sub || !t[1]);
7706 yield = string_catn(yield, US"\"", 1);
7710 yield = string_catn(yield, US"\\n", 2);
7711 else if (*t == '\r')
7712 yield = string_catn(yield, US"\\r", 2);
7715 if (*t == '\\' || *t == '"')
7716 yield = string_catn(yield, US"\\", 1);
7717 yield = string_catn(yield, t, 1);
7719 yield = string_catn(yield, US"\"", 1);
7722 yield = string_cat(yield, sub);
7726 /* quote_lookuptype does lookup-specific quoting */
7731 uschar * opt = Ustrchr(arg, '_');
7733 if (opt) *opt++ = 0;
7735 if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7737 expand_string_message = search_error_message;
7741 if (lookup_list[n]->quote)
7742 sub = (lookup_list[n]->quote)(sub, opt, (unsigned)n);
7748 expand_string_message = string_sprintf(
7749 "\"%s\" unrecognized after \"${quote_%s\"", /*}*/
7754 yield = string_cat(yield, sub);
7758 /* rx quote sticks in \ before any non-alphameric character so that
7759 the insertion works in a regular expression. */
7763 uschar *t = sub - 1;
7767 yield = string_catn(yield, US"\\", 1);
7768 yield = string_catn(yield, t, 1);
7773 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7774 prescribed by the RFC, if there are characters that need to be encoded */
7777 yield = string_cat(yield,
7778 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7782 /* RFC 2047 decode */
7788 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7789 headers_charset, '?', &len, &error);
7792 expand_string_message = error;
7795 yield = string_catn(yield, decoded, len);
7799 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7804 uschar * buff = store_get(4, sub);
7809 if (c > 255) c = '_';
7811 yield = string_catn(yield, buff, 1);
7816 /* replace illegal UTF-8 sequences by replacement character */
7818 #define UTF8_REPLACEMENT_CHAR US"?"
7822 int seq_len = 0, index = 0;
7824 long codepoint = -1;
7826 uschar seq_buff[4]; /* accumulate utf-8 here */
7828 /* Manually track tainting, as we deal in individual chars below */
7830 if (!yield->s || !yield->ptr)
7831 yield->s = store_get(yield->size = Ustrlen(sub), sub);
7832 else if (is_incompatible(yield->s, sub))
7833 gstring_rebuffer(yield, sub);
7835 /* Check the UTF-8, byte-by-byte */
7844 if ((c & 0xc0) != 0x80)
7845 /* wrong continuation byte; invalidate all bytes */
7846 complete = 1; /* error */
7849 codepoint = (codepoint << 6) | (c & 0x3f);
7850 seq_buff[index++] = c;
7851 if (--bytes_left == 0) /* codepoint complete */
7852 if(codepoint > 0x10FFFF) /* is it too large? */
7853 complete = -1; /* error (RFC3629 limit) */
7855 { /* finished; output utf-8 sequence */
7856 yield = string_catn(yield, seq_buff, seq_len);
7861 else /* no bytes left: new sequence */
7863 if(!(c & 0x80)) /* 1-byte sequence, US-ASCII, keep it */
7865 yield = string_catn(yield, &c, 1);
7868 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7870 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7875 codepoint = c & 0x1f;
7878 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7881 codepoint = c & 0x0f;
7883 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7886 codepoint = c & 0x07;
7888 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7891 seq_buff[index++] = c;
7892 seq_len = bytes_left + 1;
7893 } /* if(bytes_left) */
7897 bytes_left = index = 0;
7898 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7900 if ((complete == 1) && ((c & 0x80) == 0))
7901 /* ASCII character follows incomplete sequence */
7902 yield = string_catn(yield, &c, 1);
7904 /* If given a sequence truncated mid-character, we also want to report ?
7905 Eg, ${length_1:フィル} is one byte, not one character, so we expect
7906 ${utf8clean:${length_1:フィル}} to yield '?' */
7908 if (bytes_left != 0)
7909 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7915 case EOP_UTF8_DOMAIN_TO_ALABEL:
7917 uschar * error = NULL;
7918 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7921 expand_string_message = string_sprintf(
7922 "error converting utf8 (%s) to alabel: %s",
7923 string_printing(sub), error);
7926 yield = string_cat(yield, s);
7930 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7932 uschar * error = NULL;
7933 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7936 expand_string_message = string_sprintf(
7937 "error converting alabel (%s) to utf8: %s",
7938 string_printing(sub), error);
7941 yield = string_cat(yield, s);
7945 case EOP_UTF8_LOCALPART_TO_ALABEL:
7947 uschar * error = NULL;
7948 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7951 expand_string_message = string_sprintf(
7952 "error converting utf8 (%s) to alabel: %s",
7953 string_printing(sub), error);
7956 yield = string_cat(yield, s);
7957 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7961 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7963 uschar * error = NULL;
7964 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7967 expand_string_message = string_sprintf(
7968 "error converting alabel (%s) to utf8: %s",
7969 string_printing(sub), error);
7972 yield = string_cat(yield, s);
7975 #endif /* EXPERIMENTAL_INTERNATIONAL */
7977 /* escape turns all non-printing characters into escape sequences. */
7981 const uschar * t = string_printing(sub);
7982 yield = string_cat(yield, t);
7986 case EOP_ESCAPE8BIT:
7990 for (const uschar * s = sub; (c = *s); s++)
7991 yield = c < 127 && c != '\\'
7992 ? string_catn(yield, s, 1)
7993 : string_fmt_append(yield, "\\%03o", c);
7997 /* Handle numeric expression evaluation */
8002 uschar *save_sub = sub;
8003 uschar *error = NULL;
8004 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
8007 expand_string_message = string_sprintf("error in expression "
8008 "evaluation: %s (after processing \"%.*s\")", error,
8009 (int)(sub-save_sub), save_sub);
8012 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
8016 /* Handle time period formatting */
8020 int n = readconf_readtime(sub, 0, FALSE);
8023 expand_string_message = string_sprintf("string \"%s\" is not an "
8024 "Exim time interval in \"%s\" operator", sub, name);
8027 yield = string_fmt_append(yield, "%d", n);
8031 case EOP_TIME_INTERVAL:
8034 uschar *t = read_number(&n, sub);
8035 if (*t != 0) /* Not A Number*/
8037 expand_string_message = string_sprintf("string \"%s\" is not a "
8038 "positive number in \"%s\" operator", sub, name);
8041 t = readconf_printtime(n);
8042 yield = string_cat(yield, t);
8046 /* Convert string to base64 encoding */
8052 uschar * s = vp && *(void **)vp->value
8053 ? tls_cert_der_b64(*(void **)vp->value)
8054 : b64encode(CUS sub, Ustrlen(sub));
8056 uschar * s = b64encode(CUS sub, Ustrlen(sub));
8058 yield = string_cat(yield, s);
8065 int len = b64decode(sub, &s);
8068 expand_string_message = string_sprintf("string \"%s\" is not "
8069 "well-formed for \"%s\" operator", sub, name);
8072 yield = string_cat(yield, s);
8076 /* strlen returns the length of the string */
8079 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
8082 /* length_n or l_n takes just the first n characters or the whole string,
8083 whichever is the shorter;
8085 substr_m_n, and s_m_n take n characters from offset m; negative m take
8086 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
8087 takes the rest, either to the right or to the left.
8089 hash_n or h_n makes a hash of length n from the string, yielding n
8090 characters from the set a-z; hash_n_m makes a hash of length n, but
8091 uses m characters from the set a-zA-Z0-9.
8093 nhash_n returns a single number between 0 and n-1 (in text form), while
8094 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
8095 between 0 and n-1 and the second between 0 and m-1. */
8115 expand_string_message = string_sprintf("missing values after %s",
8120 /* "length" has only one argument, effectively being synonymous with
8123 if (c == EOP_LENGTH || c == EOP_L)
8129 /* The others have one or two arguments; for "substr" the first may be
8130 negative. The second being negative means "not supplied". */
8135 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8138 /* Read up to two numbers, separated by underscores */
8143 if (arg != ret && *arg == '_' && pn == &value1)
8147 if (arg[1] != 0) arg++;
8149 else if (!isdigit(*arg))
8151 expand_string_message =
8152 string_sprintf("non-digit after underscore in \"%s\"", name);
8155 else *pn = (*pn)*10 + *arg++ - '0';
8159 /* Perform the required operation */
8161 ret = c == EOP_HASH || c == EOP_H
8162 ? compute_hash(sub, value1, value2, &len)
8163 : c == EOP_NHASH || c == EOP_NH
8164 ? compute_nhash(sub, value1, value2, &len)
8165 : extract_substr(sub, value1, value2, &len);
8166 if (!ret) goto EXPAND_FAILED;
8168 yield = string_catn(yield, ret, len);
8177 uschar **modetable[3];
8181 if (expand_forbid & RDO_EXISTS)
8183 expand_string_message = US"Use of the stat() expansion is not permitted";
8187 if (stat(CS sub, &st) < 0)
8189 expand_string_message = string_sprintf("stat(%s) failed: %s",
8190 sub, strerror(errno));
8194 switch (mode & S_IFMT)
8196 case S_IFIFO: smode[0] = 'p'; break;
8197 case S_IFCHR: smode[0] = 'c'; break;
8198 case S_IFDIR: smode[0] = 'd'; break;
8199 case S_IFBLK: smode[0] = 'b'; break;
8200 case S_IFREG: smode[0] = '-'; break;
8201 default: smode[0] = '?'; break;
8204 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8205 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8206 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8208 for (int i = 0; i < 3; i++)
8210 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8215 yield = string_fmt_append(yield,
8216 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8217 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8218 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8219 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8220 (long)st.st_gid, st.st_size, (long)st.st_atime,
8221 (long)st.st_mtime, (long)st.st_ctime);
8225 /* vaguely random number less than N */
8229 int_eximarith_t max = expanded_string_integer(sub, TRUE);
8231 if (expand_string_message)
8233 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8237 /* Reverse IP, including IPv6 to dotted-nibble */
8239 case EOP_REVERSE_IP:
8241 int family, maskptr;
8242 uschar reversed[128];
8244 family = string_is_ip_address(sub, &maskptr);
8247 expand_string_message = string_sprintf(
8248 "reverse_ip() not given an IP address [%s]", sub);
8251 invert_address(reversed, sub);
8252 yield = string_cat(yield, reversed);
8256 /* Unknown operator */
8259 expand_string_message =
8260 string_sprintf("unknown expansion operator \"%s\"", name);
8262 } /* EOP_* switch */
8266 const uschar * s = yield->s + start;
8267 int i = yield->ptr - start;
8268 BOOL tainted = is_tainted(s);
8272 debug_printf_indent("|-----op-res: %.*s\n", i, s);
8275 debug_printf_indent("%s \\__", flags & ESI_SKIPPING ? "| " : " ");
8276 debug_print_taint(yield->s);
8281 debug_printf_indent(UTF8_VERT_RIGHT
8282 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8283 "op-res: %.*s\n", i, s);
8286 debug_printf_indent("%s",
8287 flags & ESI_SKIPPING
8288 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8289 debug_print_taint(yield->s);
8297 /* Not an item or an operator */
8298 /* Handle a plain name. If this is the first thing in the expansion, release
8299 the pre-allocated buffer. If the result data is known to be in a new buffer,
8300 newsize will be set to the size of that buffer, and we can just point at that
8301 store instead of copying. Many expansion strings contain just one reference,
8302 so this is a useful optimization, especially for humungous headers
8303 ($message_headers). */
8307 const uschar * value;
8313 g = store_get(sizeof(gstring), GET_UNTAINTED);
8314 else if (yield->ptr == 0)
8316 if (resetok) reset_point = store_reset(reset_point);
8318 reset_point = store_mark();
8319 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
8321 if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
8323 expand_string_message =
8324 string_sprintf("unknown variable in \"${%s}\"", name);
8325 check_variable_error_message(name);
8328 len = Ustrlen(value);
8329 if (!yield && newsize)
8332 yield->size = newsize;
8334 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8337 yield = string_catn(yield, value, len);
8341 /* Else there's something wrong */
8343 expand_string_message =
8344 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8345 "in a variable reference)", name);
8349 /* If we hit the end of the string when brace_ends is set, there is a missing
8350 terminating brace. */
8352 if (flags & ESI_BRACE_ENDS && !*s)
8354 expand_string_message = malformed_header
8355 ? US"missing } at end of string - could be header name not terminated by colon"
8356 : US"missing } at end of string";
8360 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8361 added to the string. If so, set up an empty string. Add a terminating zero. If
8362 left != NULL, return a pointer to the terminator. */
8365 yield = string_get(1);
8366 (void) string_from_gstring(yield);
8367 if (left) *left = s;
8369 /* Any stacking store that was used above the final string is no longer needed.
8370 In many cases the final string will be the first one that was got and so there
8371 will be optimal store usage. */
8373 if (resetok) gstring_release_unused(yield);
8374 else if (resetok_p) *resetok_p = FALSE;
8378 BOOL tainted = is_tainted(yield->s);
8381 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8382 debug_printf_indent("%sresult: %s\n",
8383 flags & ESI_SKIPPING ? "|-----" : "\\_____", yield->s);
8386 debug_printf_indent("%s \\__", flags & ESI_SKIPPING ? "| " : " ");
8387 debug_print_taint(yield->s);
8389 if (flags & ESI_SKIPPING)
8390 debug_printf_indent("\\___skipping: result is not used\n");
8394 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8395 "expanding: %.*s\n",
8396 (int)(s - string), string);
8397 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8399 flags & ESI_SKIPPING ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8403 debug_printf_indent("%s",
8404 flags & ESI_SKIPPING
8405 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8406 debug_print_taint(yield->s);
8408 if (flags & ESI_SKIPPING)
8409 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8410 "skipping: result is not used\n");
8413 if (textonly_p) *textonly_p = textonly;
8417 /* This is the failure exit: easiest to program with a goto. We still need
8418 to update the pointer to the terminator, for cases of nested calls with "fail".
8421 EXPAND_FAILED_CURLY:
8422 if (malformed_header)
8423 expand_string_message =
8424 US"missing or misplaced { or } - could be header name not terminated by colon";
8426 else if (!expand_string_message || !*expand_string_message)
8427 expand_string_message = US"missing or misplaced { or }";
8429 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8430 that is a bad idea, because expand_string_message is in dynamic store. */
8433 if (left) *left = s;
8438 debug_printf_indent("|failed to expand: %s\n", string);
8439 debug_printf_indent("%serror message: %s\n",
8440 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8441 if (f.expand_string_forcedfail)
8442 debug_printf_indent("\\failure was forced\n");
8446 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8448 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8449 "error message: %s\n",
8450 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8451 expand_string_message);
8452 if (f.expand_string_forcedfail)
8453 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8456 if (resetok_p && !resetok) *resetok_p = FALSE;
8463 /* This is the external function call. Do a quick check for any expansion
8464 metacharacters, and if there are none, just return the input string.
8467 the string to be expanded
8468 optional pointer for return boolean indicating no-dynamic-expansions
8470 Returns: the expanded string, or NULL if expansion failed; if failure was
8471 due to a lookup deferring, search_find_defer will be TRUE
8475 expand_string_2(const uschar * string, BOOL * textonly_p)
8477 if (Ustrpbrk(string, "$\\") != NULL)
8479 int old_pool = store_pool;
8482 f.search_find_defer = FALSE;
8483 malformed_header = FALSE;
8484 store_pool = POOL_MAIN;
8485 s = expand_string_internal(string, ESI_HONOR_DOLLAR, NULL, NULL, textonly_p);
8486 store_pool = old_pool;
8489 if (textonly_p) *textonly_p = TRUE;
8494 expand_cstring(const uschar * string)
8495 { return expand_string_2(string, NULL); }
8498 expand_string(uschar * string)
8499 { return US expand_string_2(CUS string, NULL); }
8506 /*************************************************
8508 *************************************************/
8510 /* Now and again we want to expand a string and be sure that the result is in a
8511 new bit of store. This function does that.
8512 Since we know it has been copied, the de-const cast is safe.
8514 Argument: the string to be expanded
8515 Returns: the expanded string, always in a new bit of store, or NULL
8519 expand_string_copy(const uschar *string)
8521 const uschar *yield = expand_cstring(string);
8522 if (yield == string) yield = string_copy(string);
8528 /*************************************************
8529 * Expand and interpret as an integer *
8530 *************************************************/
8532 /* Expand a string, and convert the result into an integer.
8535 string the string to be expanded
8536 isplus TRUE if a non-negative number is expected
8538 Returns: the integer value, or
8539 -1 for an expansion error ) in both cases, message in
8540 -2 for an integer interpretation error ) expand_string_message
8541 expand_string_message is set NULL for an OK integer
8545 expand_string_integer(uschar *string, BOOL isplus)
8547 return expanded_string_integer(expand_string(string), isplus);
8551 /*************************************************
8552 * Interpret string as an integer *
8553 *************************************************/
8555 /* Convert a string (that has already been expanded) into an integer.
8557 This function is used inside the expansion code.
8560 s the string to be expanded
8561 isplus TRUE if a non-negative number is expected
8563 Returns: the integer value, or
8564 -1 if string is NULL (which implies an expansion error)
8565 -2 for an integer interpretation error
8566 expand_string_message is set NULL for an OK integer
8569 static int_eximarith_t
8570 expanded_string_integer(const uschar *s, BOOL isplus)
8572 int_eximarith_t value;
8573 uschar *msg = US"invalid integer \"%s\"";
8576 /* If expansion failed, expand_string_message will be set. */
8580 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8581 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8582 systems, so we set it zero ourselves. */
8585 expand_string_message = NULL; /* Indicates no error */
8587 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8588 equal to 0. Unfortunately, people actually relied upon that, so preserve
8589 the behaviour explicitly. Stripping leading whitespace is a harmless
8590 noop change since strtol skips it anyway (provided that there is a number
8593 if (Uskip_whitespace(&s) == '\0')
8596 debug_printf_indent("treating blank string as number 0\n");
8600 value = strtoll(CS s, CSS &endptr, 10);
8603 msg = US"integer expected but \"%s\" found";
8604 else if (value < 0 && isplus)
8605 msg = US"non-negative integer expected but \"%s\" found";
8608 switch (tolower(*endptr))
8613 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8618 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8619 else value *= 1024*1024;
8623 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8624 else value *= 1024*1024*1024;
8628 if (errno == ERANGE)
8629 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8631 if (Uskip_whitespace(&endptr) == 0) return value;
8634 expand_string_message = string_sprintf(CS msg, s);
8639 /* These values are usually fixed boolean values, but they are permitted to be
8643 addr address being routed
8644 mtype the module type
8645 mname the module name
8646 dbg_opt debug selectors
8647 oname the option name
8648 bvalue the router's boolean value
8649 svalue the router's string value
8650 rvalue where to put the returned value
8652 Returns: OK value placed in rvalue
8653 DEFER expansion failed
8657 exp_bool(address_item *addr,
8658 uschar *mtype, uschar *mname, unsigned dbg_opt,
8659 uschar *oname, BOOL bvalue,
8660 uschar *svalue, BOOL *rvalue)
8663 if (!svalue) { *rvalue = bvalue; return OK; }
8665 if (!(expanded = expand_string(svalue)))
8667 if (f.expand_string_forcedfail)
8669 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8673 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8674 oname, mname, mtype, expand_string_message);
8675 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8679 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8682 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8684 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8688 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8689 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8698 /* Avoid potentially exposing a password in a string about to be logged */
8701 expand_hide_passwords(uschar * s)
8703 return ( ( Ustrstr(s, "failed to expand") != NULL
8704 || Ustrstr(s, "expansion of ") != NULL
8706 && ( Ustrstr(s, "mysql") != NULL
8707 || Ustrstr(s, "pgsql") != NULL
8708 || Ustrstr(s, "redis") != NULL
8709 || Ustrstr(s, "sqlite") != NULL
8710 || Ustrstr(s, "ldap:") != NULL
8711 || Ustrstr(s, "ldaps:") != NULL
8712 || Ustrstr(s, "ldapi:") != NULL
8713 || Ustrstr(s, "ldapdn:") != NULL
8714 || Ustrstr(s, "ldapm:") != NULL
8716 ? US"Temporary internal error" : s;
8720 /* Read given named file into big_buffer. Use for keying material etc.
8721 The content will have an ascii NUL appended.
8726 Return: pointer to buffer, or NULL on error.
8730 expand_file_big_buffer(const uschar * filename)
8732 int fd, off = 0, len;
8734 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8736 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8743 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8746 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8754 big_buffer[off] = '\0';
8760 /*************************************************
8761 * Error-checking for testsuite *
8762 *************************************************/
8764 uschar * region_start;
8765 uschar * region_end;
8766 const uschar *var_name;
8767 const uschar *var_data;
8770 /* Called via tree_walk, which allows nonconst name/data. Our usage is const. */
8772 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8775 if (var_data >= e->region_start && var_data < e->region_end)
8777 e->var_name = CUS var_name;
8778 e->var_data = CUS var_data;
8783 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8785 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8786 .var_name = NULL, .var_data = NULL };
8788 /* check acl_ variables */
8789 tree_walk(acl_var_c, assert_variable_notin, &e);
8790 tree_walk(acl_var_m, assert_variable_notin, &e);
8792 /* check auth<n> variables.
8793 assert_variable_notin() treats as const, so deconst is safe. */
8794 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8795 assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8797 #ifdef WITH_CONTENT_SCAN
8798 /* check regex<n> variables. assert_variable_notin() treats as const. */
8799 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8800 assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8803 /* check known-name variables */
8804 for (var_entry * v = var_table; v < var_table + var_table_size; v++)
8805 if (v->type == vtype_stringptr)
8806 assert_variable_notin(US v->name, *(USS v->value), &e);
8808 /* check dns and address trees */
8809 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8810 tree_walk(tree_duplicates, assert_variable_notin, &e);
8811 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8812 tree_walk(tree_unusable, assert_variable_notin, &e);
8815 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8816 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8817 e.var_name, filename, linenumber, e.var_data);
8822 /*************************************************
8823 **************************************************
8824 * Stand-alone test program *
8825 **************************************************
8826 *************************************************/
8832 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8834 int ovec[3*(EXPAND_MAXN+1)];
8835 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8837 BOOL yield = n >= 0;
8838 if (n == 0) n = EXPAND_MAXN + 1;
8841 expand_nmax = setup < 0 ? 0 : setup + 1;
8842 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8844 expand_nstring[expand_nmax] = subject + ovec[nn];
8845 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8853 int main(int argc, uschar **argv)
8855 uschar buffer[1024];
8857 debug_selector = D_v;
8858 debug_file = stderr;
8859 debug_fd = fileno(debug_file);
8860 big_buffer = malloc(big_buffer_size);
8863 for (int i = 1; i < argc; i++)
8865 if (argv[i][0] == '+')
8867 debug_trace_memory = 2;
8870 if (isdigit(argv[i][0]))
8871 debug_selector = Ustrtol(argv[i], NULL, 0);
8873 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8877 eldap_default_servers = argv[i];
8880 mysql_servers = argv[i];
8883 pgsql_servers = argv[i];
8886 redis_servers = argv[i];
8890 else opt_perl_startup = argv[i];
8894 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8896 expand_nstring[1] = US"string 1....";
8897 expand_nlength[1] = 8;
8901 if (opt_perl_startup != NULL)
8904 printf("Starting Perl interpreter\n");
8905 errstr = init_perl(opt_perl_startup);
8908 printf("** error in perl_startup code: %s\n", errstr);
8909 return EXIT_FAILURE;
8912 #endif /* EXIM_PERL */
8914 /* Thie deliberately regards the input as untainted, so that it can be
8915 expanded; only reasonable since this is a test for string-expansions. */
8917 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8919 rmark reset_point = store_mark();
8920 uschar *yield = expand_string(buffer);
8922 printf("%s\n", yield);
8925 if (f.search_find_defer) printf("search_find deferred\n");
8926 printf("Failed: %s\n", expand_string_message);
8927 if (f.expand_string_forcedfail) printf("Forced failure\n");
8930 store_reset(reset_point);
8938 #endif /*STAND_ALONE*/
8940 #endif /*!MACRO_PREDEF*/
8943 /* End of expand.c */