1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2023 */
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 */
27 # ifndef SUPPORT_CRYPTEQ
28 # define SUPPORT_CRYPTEQ
30 #endif /*!STAND_ALONE*/
33 # include "lookups/ldap.h"
36 #ifdef SUPPORT_CRYPTEQ
41 extern char* crypt16(char*, char*);
45 /* The handling of crypt16() is a mess. I will record below the analysis of the
46 mess that was sent to me. We decided, however, to make changing this very low
47 priority, because in practice people are moving away from the crypt()
48 algorithms nowadays, so it doesn't seem worth it.
51 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
52 the first 8 characters of the password using a 20-round version of crypt
53 (standard crypt does 25 rounds). It then crypts the next 8 characters,
54 or an empty block if the password is less than 9 characters, using a
55 20-round version of crypt and the same salt as was used for the first
56 block. Characters after the first 16 are ignored. It always generates
57 a 16-byte hash, which is expressed together with the salt as a string
58 of 24 base 64 digits. Here are some links to peruse:
60 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
61 http://seclists.org/bugtraq/1999/Mar/0076.html
63 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
64 and OSF/1. This is the same as the standard crypt if given a password
65 of 8 characters or less. If given more, it first does the same as crypt
66 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
67 using as salt the first two base 64 digits from the first hash block.
68 If the password is more than 16 characters then it crypts the 17th to 24th
69 characters using as salt the first two base 64 digits from the second hash
70 block. And so on: I've seen references to it cutting off the password at
71 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
73 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
74 http://seclists.org/bugtraq/1999/Mar/0109.html
75 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
76 TET1_html/sec.c222.html#no_id_208
78 Exim has something it calls "crypt16". It will either use a native
79 crypt16 or its own implementation. A native crypt16 will presumably
80 be the one that I called "crypt16" above. The internal "crypt16"
81 function, however, is a two-block-maximum implementation of what I called
82 "bigcrypt". The documentation matches the internal code.
84 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
85 that crypt16 and bigcrypt were different things.
87 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
88 to whatever it is using under that name. This unfortunately sets a
89 precedent for using "{crypt16}" to identify two incompatible algorithms
90 whose output can't be distinguished. With "{crypt16}" thus rendered
91 ambiguous, I suggest you deprecate it and invent two new identifiers
92 for the two algorithms.
94 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
95 of the password separately means they can be cracked separately, so
96 the double-length hash only doubles the cracking effort instead of
97 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
104 /*************************************************
105 * Local statics and tables *
106 *************************************************/
108 /* Table of item names, and corresponding switch numbers. The names must be in
109 alphabetical order. */
111 static uschar *item_table[] = {
181 /* Tables of operator names, and corresponding switch numbers. The names must be
182 in alphabetical order. There are two tables, because underscore is used in some
183 cases to introduce arguments, whereas for other it is part of the name. This is
184 an historical mis-design. */
186 static uschar * op_table_underscore[] = {
189 US"quote_local_part",
194 ,US"utf8_domain_from_alabel",
195 US"utf8_domain_to_alabel",
196 US"utf8_localpart_from_alabel",
197 US"utf8_localpart_to_alabel"
204 EOP_QUOTE_LOCAL_PART,
209 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
210 EOP_UTF8_DOMAIN_TO_ALABEL,
211 EOP_UTF8_LOCALPART_FROM_ALABEL,
212 EOP_UTF8_LOCALPART_TO_ALABEL
216 static uschar *op_table_main[] = {
265 EOP_ADDRESS = nelem(op_table_underscore),
313 /* Table of condition names, and corresponding switch numbers. The names must
314 be in alphabetical order. */
316 static uschar *cond_table[] = {
320 US"==", /* Backward compatibility */
360 US"match_local_part",
385 ECOND_FIRST_DELIVERY,
413 ECOND_MATCH_LOCAL_PART,
423 /* Types of table entry */
426 vtype_int, /* value is address of int */
427 vtype_filter_int, /* ditto, but recognized only when filtering */
428 vtype_ino, /* value is address of ino_t (not always an int) */
429 vtype_uid, /* value is address of uid_t (not always an int) */
430 vtype_gid, /* value is address of gid_t (not always an int) */
431 vtype_bool, /* value is address of bool */
432 vtype_stringptr, /* value is address of pointer to string */
433 vtype_msgbody, /* as stringptr, but read when first required */
434 vtype_msgbody_end, /* ditto, the end of the message */
435 vtype_msgheaders, /* the message's headers, processed */
436 vtype_msgheaders_raw, /* the message's headers, unprocessed */
437 vtype_localpart, /* extract local part from string */
438 vtype_domain, /* extract domain from string */
439 vtype_string_func, /* value is string returned by given function */
440 vtype_todbsdin, /* value not used; generate BSD inbox tod */
441 vtype_tode, /* value not used; generate tod in epoch format */
442 vtype_todel, /* value not used; generate tod in epoch/usec format */
443 vtype_todf, /* value not used; generate full tod */
444 vtype_todl, /* value not used; generate log tod */
445 vtype_todlf, /* value not used; generate log file datestamp tod */
446 vtype_todzone, /* value not used; generate time zone only */
447 vtype_todzulu, /* value not used; generate zulu tod */
448 vtype_reply, /* value not used; get reply from headers */
449 vtype_pid, /* value not used; result is pid */
450 vtype_host_lookup, /* value not used; get host name */
451 vtype_load_avg, /* value not used; result is int from os_getloadavg */
452 vtype_pspace, /* partition space; value is T/F for spool/log */
453 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
454 vtype_cert /* SSL certificate */
456 ,vtype_dkim /* Lookup of value in DKIM signature */
460 /* Type for main variable table */
468 /* Type for entries pointing to address/length pairs. Not currently
476 typedef uschar * stringptr_fn_t(void);
477 static uschar * fn_recipients(void);
478 static uschar * fn_recipients_list(void);
479 static uschar * fn_queue_size(void);
481 /* This table must be kept in alphabetical order. */
483 static var_entry var_table[] = {
484 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
485 they will be confused with user-creatable ACL variables. */
486 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
487 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
488 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
489 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
490 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
491 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
492 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
493 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
494 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
495 { "acl_narg", vtype_int, &acl_narg },
496 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
497 { "address_data", vtype_stringptr, &deliver_address_data },
498 { "address_file", vtype_stringptr, &address_file },
499 { "address_pipe", vtype_stringptr, &address_pipe },
500 #ifdef EXPERIMENTAL_ARC
501 { "arc_domains", vtype_string_func, (void *) &fn_arc_domains },
502 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
503 { "arc_state", vtype_stringptr, &arc_state },
504 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
506 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
507 { "authenticated_id", vtype_stringptr, &authenticated_id },
508 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
509 { "authentication_failed",vtype_int, &authentication_failed },
510 #ifdef WITH_CONTENT_SCAN
511 { "av_failed", vtype_int, &av_failed },
513 #ifdef EXPERIMENTAL_BRIGHTMAIL
514 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
515 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
516 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
517 { "bmi_deliver", vtype_int, &bmi_deliver },
519 { "body_linecount", vtype_int, &body_linecount },
520 { "body_zerocount", vtype_int, &body_zerocount },
521 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
522 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
523 { "caller_gid", vtype_gid, &real_gid },
524 { "caller_uid", vtype_uid, &real_uid },
525 { "callout_address", vtype_stringptr, &callout_address },
526 { "compile_date", vtype_stringptr, &version_date },
527 { "compile_number", vtype_stringptr, &version_cnumber },
528 { "config_dir", vtype_stringptr, &config_main_directory },
529 { "config_file", vtype_stringptr, &config_main_filename },
530 { "csa_status", vtype_stringptr, &csa_status },
531 #ifdef EXPERIMENTAL_DCC
532 { "dcc_header", vtype_stringptr, &dcc_header },
533 { "dcc_result", vtype_stringptr, &dcc_result },
536 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
537 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
538 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
539 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
540 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
541 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
542 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
543 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
544 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
545 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
546 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
547 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
548 { "dkim_key_length", vtype_int, &dkim_key_length },
549 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
550 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
551 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
552 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
553 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
554 { "dkim_signers", vtype_stringptr, &dkim_signers },
555 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
556 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
559 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
560 { "dmarc_status", vtype_stringptr, &dmarc_status },
561 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
562 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
564 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
565 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
566 { "dnslist_text", vtype_stringptr, &dnslist_text },
567 { "dnslist_value", vtype_stringptr, &dnslist_value },
568 { "domain", vtype_stringptr, &deliver_domain },
569 { "domain_data", vtype_stringptr, &deliver_domain_data },
570 #ifndef DISABLE_EVENT
571 { "event_data", vtype_stringptr, &event_data },
573 /*XXX want to use generic vars for as many of these as possible*/
574 { "event_defer_errno", vtype_int, &event_defer_errno },
576 { "event_name", vtype_stringptr, &event_name },
578 { "exim_gid", vtype_gid, &exim_gid },
579 { "exim_path", vtype_stringptr, &exim_path },
580 { "exim_uid", vtype_uid, &exim_uid },
581 { "exim_version", vtype_stringptr, &version_string },
582 { "headers_added", vtype_string_func, (void *) &fn_hdrs_added },
583 { "home", vtype_stringptr, &deliver_home },
584 { "host", vtype_stringptr, &deliver_host },
585 { "host_address", vtype_stringptr, &deliver_host_address },
586 { "host_data", vtype_stringptr, &host_data },
587 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
588 { "host_lookup_failed", vtype_int, &host_lookup_failed },
589 { "host_port", vtype_int, &deliver_host_port },
590 { "initial_cwd", vtype_stringptr, &initial_cwd },
591 { "inode", vtype_ino, &deliver_inode },
592 { "interface_address", vtype_stringptr, &interface_address },
593 { "interface_port", vtype_int, &interface_port },
594 { "item", vtype_stringptr, &iterate_item },
596 { "ldap_dn", vtype_stringptr, &eldap_dn },
598 { "load_average", vtype_load_avg, NULL },
599 { "local_part", vtype_stringptr, &deliver_localpart },
600 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
601 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
602 { "local_part_prefix_v", vtype_stringptr, &deliver_localpart_prefix_v },
603 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
604 { "local_part_suffix_v", vtype_stringptr, &deliver_localpart_suffix_v },
605 #ifdef HAVE_LOCAL_SCAN
606 { "local_scan_data", vtype_stringptr, &local_scan_data },
608 { "local_user_gid", vtype_gid, &local_user_gid },
609 { "local_user_uid", vtype_uid, &local_user_uid },
610 { "localhost_number", vtype_int, &host_number },
611 { "log_inodes", vtype_pinodes, (void *)FALSE },
612 { "log_space", vtype_pspace, (void *)FALSE },
613 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
614 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
615 #ifdef WITH_CONTENT_SCAN
616 { "malware_name", vtype_stringptr, &malware_name },
618 { "max_received_linelength", vtype_int, &max_received_linelength },
619 { "message_age", vtype_int, &message_age },
620 { "message_body", vtype_msgbody, &message_body },
621 { "message_body_end", vtype_msgbody_end, &message_body_end },
622 { "message_body_size", vtype_int, &message_body_size },
623 { "message_exim_id", vtype_stringptr, &message_id },
624 { "message_headers", vtype_msgheaders, NULL },
625 { "message_headers_raw", vtype_msgheaders_raw, NULL },
626 { "message_id", vtype_stringptr, &message_id },
627 { "message_linecount", vtype_int, &message_linecount },
628 { "message_size", vtype_int, &message_size },
630 { "message_smtputf8", vtype_bool, &message_smtputf8 },
632 #ifdef WITH_CONTENT_SCAN
633 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
634 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
635 { "mime_boundary", vtype_stringptr, &mime_boundary },
636 { "mime_charset", vtype_stringptr, &mime_charset },
637 { "mime_content_description", vtype_stringptr, &mime_content_description },
638 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
639 { "mime_content_id", vtype_stringptr, &mime_content_id },
640 { "mime_content_size", vtype_int, &mime_content_size },
641 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
642 { "mime_content_type", vtype_stringptr, &mime_content_type },
643 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
644 { "mime_filename", vtype_stringptr, &mime_filename },
645 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
646 { "mime_is_multipart", vtype_int, &mime_is_multipart },
647 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
648 { "mime_part_count", vtype_int, &mime_part_count },
650 { "n0", vtype_filter_int, &filter_n[0] },
651 { "n1", vtype_filter_int, &filter_n[1] },
652 { "n2", vtype_filter_int, &filter_n[2] },
653 { "n3", vtype_filter_int, &filter_n[3] },
654 { "n4", vtype_filter_int, &filter_n[4] },
655 { "n5", vtype_filter_int, &filter_n[5] },
656 { "n6", vtype_filter_int, &filter_n[6] },
657 { "n7", vtype_filter_int, &filter_n[7] },
658 { "n8", vtype_filter_int, &filter_n[8] },
659 { "n9", vtype_filter_int, &filter_n[9] },
660 { "original_domain", vtype_stringptr, &deliver_domain_orig },
661 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
662 { "originator_gid", vtype_gid, &originator_gid },
663 { "originator_uid", vtype_uid, &originator_uid },
664 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
665 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
666 { "pid", vtype_pid, NULL },
668 { "prdr_requested", vtype_bool, &prdr_requested },
670 { "primary_hostname", vtype_stringptr, &primary_hostname },
671 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
672 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
673 { "proxy_external_port", vtype_int, &proxy_external_port },
674 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
675 { "proxy_local_port", vtype_int, &proxy_local_port },
676 { "proxy_session", vtype_bool, &proxy_session },
678 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
679 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
680 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
681 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
682 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
683 { "queue_name", vtype_stringptr, &queue_name },
684 { "queue_size", vtype_string_func, (void *) &fn_queue_size },
685 { "rcpt_count", vtype_int, &rcpt_count },
686 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
687 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
688 { "received_count", vtype_int, &received_count },
689 { "received_for", vtype_stringptr, &received_for },
690 { "received_ip_address", vtype_stringptr, &interface_address },
691 { "received_port", vtype_int, &interface_port },
692 { "received_protocol", vtype_stringptr, &received_protocol },
693 { "received_time", vtype_int, &received_time.tv_sec },
694 { "recipient_data", vtype_stringptr, &recipient_data },
695 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
696 { "recipients", vtype_string_func, (void *) &fn_recipients },
697 { "recipients_count", vtype_int, &recipients_count },
698 { "recipients_list", vtype_string_func, (void *) &fn_recipients_list },
699 { "regex_cachesize", vtype_int, ®ex_cachesize },/* undocumented; devel observability */
700 #ifdef WITH_CONTENT_SCAN
701 { "regex_match_string", vtype_stringptr, ®ex_match_string },
703 { "reply_address", vtype_reply, NULL },
704 { "return_path", vtype_stringptr, &return_path },
705 { "return_size_limit", vtype_int, &bounce_return_size_limit },
706 { "router_name", vtype_stringptr, &router_name },
707 { "runrc", vtype_int, &runrc },
708 { "self_hostname", vtype_stringptr, &self_hostname },
709 { "sender_address", vtype_stringptr, &sender_address },
710 { "sender_address_data", vtype_stringptr, &sender_address_data },
711 { "sender_address_domain", vtype_domain, &sender_address },
712 { "sender_address_local_part", vtype_localpart, &sender_address },
713 { "sender_data", vtype_stringptr, &sender_data },
714 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
715 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
716 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
717 { "sender_helo_verified",vtype_string_func, (void *) &sender_helo_verified_boolstr },
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 }
840 uschar * fn_arc_domains(void) {return NULL;}
841 uschar * fn_hdrs_added(void) {return NULL;}
842 uschar * fn_queue_size(void) {return NULL;}
843 uschar * fn_recipients(void) {return NULL;}
844 uschar * fn_recipients_list(void) {return NULL;}
845 uschar * sender_helo_verified_boolstr(void) {return NULL;}
846 uschar * smtp_cmd_hist(void) {return NULL;}
851 expansion_items(void)
854 for (int i = 0; i < nelem(item_table); i++)
856 spf(buf, sizeof(buf), CUS"_EXP_ITEM_%T", item_table[i]);
857 builtin_macro_create(buf);
861 expansion_operators(void)
864 for (int i = 0; i < nelem(op_table_underscore); i++)
866 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_underscore[i]);
867 builtin_macro_create(buf);
869 for (int i = 0; i < nelem(op_table_main); i++)
871 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_main[i]);
872 builtin_macro_create(buf);
876 expansion_conditions(void)
879 for (int i = 0; i < nelem(cond_table); i++)
881 spf(buf, sizeof(buf), CUS"_EXP_COND_%T", cond_table[i]);
882 builtin_macro_create(buf);
886 expansion_variables(void)
889 for (int i = 0; i < nelem(var_table); i++)
891 spf(buf, sizeof(buf), CUS"_EXP_VAR_%T", var_table[i].name);
892 builtin_macro_create(buf);
900 expansion_operators();
901 expansion_conditions();
902 expansion_variables();
905 #else /*!MACRO_PREDEF*/
907 static uschar var_buffer[256];
908 static BOOL malformed_header;
910 /* For textual hashes */
912 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
913 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
916 enum { HMAC_MD5, HMAC_SHA1 };
918 /* For numeric hashes */
920 static unsigned int prime[] = {
921 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
922 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
923 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
925 /* For printing modes in symbolic form */
927 static uschar *mtable_normal[] =
928 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
930 static uschar *mtable_setid[] =
931 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
933 static uschar *mtable_sticky[] =
934 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
936 /* flags for find_header() */
937 #define FH_EXISTS_ONLY BIT(0)
938 #define FH_WANT_RAW BIT(1)
939 #define FH_WANT_LIST BIT(2)
941 /* Recursively called function */
942 static uschar *expand_string_internal(const uschar *, esi_flags, const uschar **, BOOL *, BOOL *);
943 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
946 /*************************************************
947 * Tables for UTF-8 support *
948 *************************************************/
950 /* Table of the number of extra characters, indexed by the first character
951 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
954 static uschar utf8_table1[] = {
955 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
956 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
957 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
958 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
960 /* These are the masks for the data bits in the first byte of a character,
961 indexed by the number of additional bytes. */
963 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
965 /* Get the next UTF-8 character, advancing the pointer. */
967 #define GETUTF8INC(c, ptr) \
969 if ((c & 0xc0) == 0xc0) \
971 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
973 c = (c & utf8_table2[a]) << s; \
977 c |= (*ptr++ & 0x3f) << s; \
983 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
985 /*************************************************
986 * Binary chop search on a table *
987 *************************************************/
989 /* This is used for matching expansion items and operators.
992 name the name that is being sought
993 table the table to search
994 table_size the number of items in the table
996 Returns: the offset in the table, or -1
1000 chop_match(uschar *name, uschar **table, int table_size)
1002 uschar **bot = table;
1003 uschar **top = table + table_size;
1007 uschar **mid = bot + (top - bot)/2;
1008 int c = Ustrcmp(name, *mid);
1009 if (c == 0) return mid - table;
1010 if (c > 0) bot = mid + 1; else top = mid;
1018 /*************************************************
1019 * Check a condition string *
1020 *************************************************/
1022 /* This function is called to expand a string, and test the result for a "true"
1023 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
1024 forced fail or lookup defer.
1026 We used to release all store used, but this is not not safe due
1027 to ${dlfunc } and ${acl }. In any case expand_string_internal()
1028 is reasonably careful to release what it can.
1030 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
1033 condition the condition string
1034 m1 text to be incorporated in panic error
1037 Returns: TRUE if condition is met, FALSE if not
1041 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
1043 uschar * ss = expand_string(condition);
1046 if (!f.expand_string_forcedfail && !f.search_find_defer)
1047 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
1048 "for %s %s: %s", condition, m1, m2, expand_string_message);
1051 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
1052 strcmpic(ss, US"false") != 0;
1058 /*************************************************
1059 * Pseudo-random number generation *
1060 *************************************************/
1062 /* Pseudo-random number generation. The result is not "expected" to be
1063 cryptographically strong but not so weak that someone will shoot themselves
1064 in the foot using it as a nonce in some email header scheme or whatever
1065 weirdness they'll twist this into. The result should ideally handle fork().
1067 However, if we're stuck unable to provide this, then we'll fall back to
1068 appallingly bad randomness.
1070 If DISABLE_TLS is not defined then this will not be used except as an emergency
1075 Returns a random number in range [0, max-1]
1079 # define vaguely_random_number vaguely_random_number_fallback
1082 vaguely_random_number(int max)
1085 # undef vaguely_random_number
1087 static pid_t pid = 0;
1090 if ((p2 = getpid()) != pid)
1095 #ifdef HAVE_ARC4RANDOM
1096 /* cryptographically strong randomness, common on *BSD platforms, not
1097 so much elsewhere. Alas. */
1098 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1101 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1102 # ifdef HAVE_SRANDOMDEV
1103 /* uses random(4) for seeding */
1108 gettimeofday(&tv, NULL);
1109 srandom(tv.tv_sec | tv.tv_usec | getpid());
1113 /* Poor randomness and no seeding here */
1120 #ifdef HAVE_ARC4RANDOM
1121 return arc4random() % max;
1122 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1123 return random() % max;
1125 /* This one returns a 16-bit number, definitely not crypto-strong */
1126 return random_number(max);
1133 /*************************************************
1134 * Pick out a name from a string *
1135 *************************************************/
1137 /* If the name is too long, it is silently truncated.
1140 name points to a buffer into which to put the name
1141 max is the length of the buffer
1142 s points to the first alphabetic character of the name
1143 extras chars other than alphanumerics to permit
1145 Returns: pointer to the first character after the name
1147 Note: The test for *s != 0 in the while loop is necessary because
1148 Ustrchr() yields non-NULL if the character is zero (which is not something
1151 static const uschar *
1152 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1155 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1157 if (ptr < max-1) name[ptr++] = *s;
1166 /*************************************************
1167 * Pick out the rest of a header name *
1168 *************************************************/
1170 /* A variable name starting $header_ (or just $h_ for those who like
1171 abbreviations) might not be the complete header name because headers can
1172 contain any printing characters in their names, except ':'. This function is
1173 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1174 on the end, if the name was terminated by white space.
1177 name points to a buffer in which the name read so far exists
1178 max is the length of the buffer
1179 s points to the first character after the name so far, i.e. the
1180 first non-alphameric character after $header_xxxxx
1182 Returns: a pointer to the first character after the header name
1185 static const uschar *
1186 read_header_name(uschar *name, int max, const uschar *s)
1188 int prelen = Ustrchr(name, '_') - name + 1;
1189 int ptr = Ustrlen(name) - prelen;
1190 if (ptr > 0) memmove(name, name+prelen, ptr);
1191 while (mac_isgraph(*s) && *s != ':')
1193 if (ptr < max-1) name[ptr++] = *s;
1204 /*************************************************
1205 * Pick out a number from a string *
1206 *************************************************/
1209 n points to an integer into which to put the number
1210 s points to the first digit of the number
1212 Returns: a pointer to the character after the last digit
1214 /*XXX consider expanding to int_eximarith_t. But the test for
1215 "overbig numbers" in 0002 still needs to overflow it. */
1218 read_number(int *n, uschar *s)
1221 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1225 static const uschar *
1226 read_cnumber(int *n, const uschar *s)
1229 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1235 /*************************************************
1236 * Extract keyed subfield from a string *
1237 *************************************************/
1239 /* The yield is in dynamic store; NULL means that the key was not found.
1242 key points to the name of the key
1243 s points to the string from which to extract the subfield
1245 Returns: NULL if the subfield was not found, or
1246 a pointer to the subfield's data
1250 expand_getkeyed(const uschar * key, const uschar * s)
1252 int length = Ustrlen(key);
1253 Uskip_whitespace(&s);
1255 /* Loop to search for the key */
1261 const uschar * dkey = s;
1263 while (*s && *s != '=' && !isspace(*s)) s++;
1264 dkeylength = s - dkey;
1265 if (Uskip_whitespace(&s) == '=') while (isspace(*++s));
1267 data = string_dequote(&s);
1268 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1271 Uskip_whitespace(&s);
1280 find_var_ent(uschar * name)
1283 int last = nelem(var_table);
1285 while (last > first)
1287 int middle = (first + last)/2;
1288 int c = Ustrcmp(name, var_table[middle].name);
1290 if (c > 0) { first = middle + 1; continue; }
1291 if (c < 0) { last = middle; continue; }
1292 return &var_table[middle];
1297 /*************************************************
1298 * Extract numbered subfield from string *
1299 *************************************************/
1301 /* Extracts a numbered field from a string that is divided by tokens - for
1302 example a line from /etc/passwd is divided by colon characters. First field is
1303 numbered one. Negative arguments count from the right. Zero returns the whole
1304 string. Returns NULL if there are insufficient tokens in the string
1307 Modifies final argument - this is a dynamically generated string, so that's OK.
1310 field number of field to be extracted,
1311 first field = 1, whole string = 0, last field = -1
1312 separators characters that are used to break string into tokens
1313 s points to the string from which to extract the subfield
1315 Returns: NULL if the field was not found,
1316 a pointer to the field's data inside s (modified to add 0)
1320 expand_gettokened (int field, uschar *separators, uschar *s)
1325 uschar *fieldtext = NULL;
1327 if (field == 0) return s;
1329 /* Break the line up into fields in place; for field > 0 we stop when we have
1330 done the number of fields we want. For field < 0 we continue till the end of
1331 the string, counting the number of fields. */
1333 count = (field > 0)? field : INT_MAX;
1339 /* Previous field was the last one in the string. For a positive field
1340 number, this means there are not enough fields. For a negative field number,
1341 check that there are enough, and scan back to find the one that is wanted. */
1345 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1346 if ((-field) == (INT_MAX - count - 1)) return s;
1350 while (ss[-1] != 0) ss--;
1356 /* Previous field was not last in the string; save its start and put a
1360 len = Ustrcspn(ss, separators);
1371 expand_getlistele(int field, const uschar * list)
1373 const uschar * tlist = list;
1375 /* Tainted mem for the throwaway element copies */
1376 uschar * dummy = store_get(2, GET_TAINTED);
1380 for (field++; string_nextinlist(&tlist, &sep, dummy, 1); ) field++;
1383 if (field == 0) return NULL;
1384 while (--field > 0 && (string_nextinlist(&list, &sep, dummy, 1))) ;
1385 return string_nextinlist(&list, &sep, NULL, 0);
1389 /* Certificate fields, by name. Worry about by-OID later */
1390 /* Names are chosen to not have common prefixes */
1397 uschar * (*getfn)(void * cert, uschar * mod);
1399 static certfield certfields[] =
1400 { /* linear search; no special order */
1401 { US"version", 7, &tls_cert_version },
1402 { US"serial_number", 13, &tls_cert_serial_number },
1403 { US"subject", 7, &tls_cert_subject },
1404 { US"notbefore", 9, &tls_cert_not_before },
1405 { US"notafter", 8, &tls_cert_not_after },
1406 { US"issuer", 6, &tls_cert_issuer },
1407 { US"signature", 9, &tls_cert_signature },
1408 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1409 { US"subj_altname", 12, &tls_cert_subject_altname },
1410 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1411 { US"crl_uri", 7, &tls_cert_crl_uri },
1415 expand_getcertele(uschar * field, uschar * certvar)
1419 if (!(vp = find_var_ent(certvar)))
1421 expand_string_message =
1422 string_sprintf("no variable named \"%s\"", certvar);
1423 return NULL; /* Unknown variable name */
1425 /* NB this stops us passing certs around in variable. Might
1426 want to do that in future */
1427 if (vp->type != vtype_cert)
1429 expand_string_message =
1430 string_sprintf("\"%s\" is not a certificate", certvar);
1431 return NULL; /* Unknown variable name */
1433 if (!*(void **)vp->value)
1436 if (*field >= '0' && *field <= '9')
1437 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1439 for (certfield * cp = certfields;
1440 cp < certfields + nelem(certfields);
1442 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1444 uschar * modifier = *(field += cp->namelen) == ','
1446 return (*cp->getfn)( *(void **)vp->value, modifier );
1449 expand_string_message =
1450 string_sprintf("bad field selector \"%s\" for certextract", field);
1453 #endif /*DISABLE_TLS*/
1455 /*************************************************
1456 * Extract a substring from a string *
1457 *************************************************/
1459 /* Perform the ${substr or ${length expansion operations.
1462 subject the input string
1463 value1 the offset from the start of the input string to the start of
1464 the output string; if negative, count from the right.
1465 value2 the length of the output string, or negative (-1) for unset
1466 if value1 is positive, unset means "all after"
1467 if value1 is negative, unset means "all before"
1468 len set to the length of the returned string
1470 Returns: pointer to the output string, or NULL if there is an error
1474 extract_substr(uschar *subject, int value1, int value2, int *len)
1476 int sublen = Ustrlen(subject);
1478 if (value1 < 0) /* count from right */
1482 /* If the position is before the start, skip to the start, and adjust the
1483 length. If the length ends up negative, the substring is null because nothing
1484 can precede. This falls out naturally when the length is unset, meaning "all
1490 if (value2 < 0) value2 = 0;
1494 /* Otherwise an unset length => characters before value1 */
1496 else if (value2 < 0)
1503 /* For a non-negative offset, if the starting position is past the end of the
1504 string, the result will be the null string. Otherwise, an unset length means
1505 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1509 if (value1 > sublen)
1514 else if (value2 < 0) value2 = sublen;
1517 /* Cut the length down to the maximum possible for the offset value, and get
1518 the required characters. */
1520 if (value1 + value2 > sublen) value2 = sublen - value1;
1522 return subject + value1;
1528 /*************************************************
1529 * Old-style hash of a string *
1530 *************************************************/
1532 /* Perform the ${hash expansion operation.
1535 subject the input string (an expanded substring)
1536 value1 the length of the output string; if greater or equal to the
1537 length of the input string, the input string is returned
1538 value2 the number of hash characters to use, or 26 if negative
1539 len set to the length of the returned string
1541 Returns: pointer to the output string, or NULL if there is an error
1545 compute_hash(uschar *subject, int value1, int value2, int *len)
1547 int sublen = Ustrlen(subject);
1549 if (value2 < 0) value2 = 26;
1550 else if (value2 > Ustrlen(hashcodes))
1552 expand_string_message =
1553 string_sprintf("hash count \"%d\" too big", value2);
1557 /* Calculate the hash text. We know it is shorter than the original string, so
1558 can safely place it in subject[] (we know that subject is always itself an
1559 expanded substring). */
1561 if (value1 < sublen)
1566 while ((c = (subject[j])) != 0)
1568 int shift = (c + j++) & 7;
1569 subject[i] ^= (c << shift) | (c >> (8-shift));
1570 if (++i >= value1) i = 0;
1572 for (i = 0; i < value1; i++)
1573 subject[i] = hashcodes[(subject[i]) % value2];
1575 else value1 = sublen;
1584 /*************************************************
1585 * Numeric hash of a string *
1586 *************************************************/
1588 /* Perform the ${nhash expansion operation. The first characters of the
1589 string are treated as most important, and get the highest prime numbers.
1592 subject the input string
1593 value1 the maximum value of the first part of the result
1594 value2 the maximum value of the second part of the result,
1595 or negative to produce only a one-part result
1596 len set to the length of the returned string
1598 Returns: pointer to the output string, or NULL if there is an error.
1602 compute_nhash (uschar *subject, int value1, int value2, int *len)
1604 uschar *s = subject;
1606 unsigned long int total = 0; /* no overflow */
1610 if (i == 0) i = nelem(prime) - 1;
1611 total += prime[i--] * (unsigned int)(*s++);
1614 /* If value2 is unset, just compute one number */
1617 s = string_sprintf("%lu", total % value1);
1619 /* Otherwise do a div/mod hash */
1623 total = total % (value1 * value2);
1624 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1635 /*************************************************
1636 * Find the value of a header or headers *
1637 *************************************************/
1639 /* Multiple instances of the same header get concatenated, and this function
1640 can also return a concatenation of all the header lines. When concatenating
1641 specific headers that contain lists of addresses, a comma is inserted between
1642 them. Otherwise we use a straight concatenation. Because some messages can have
1643 pathologically large number of lines, there is a limit on the length that is
1647 name the name of the header, without the leading $header_ or $h_,
1648 or NULL if a concatenation of all headers is required
1649 newsize return the size of memory block that was obtained; may be NULL
1650 if exists_only is TRUE
1651 flags FH_EXISTS_ONLY
1652 set if called from a def: test; don't need to build a string;
1653 just return a string that is not "" and not "0" if the header
1656 set if called for $rh_ or $rheader_ items; no processing,
1657 other than concatenating, will be done on the header. Also used
1658 for $message_headers_raw.
1660 Double colon chars in the content, and replace newline with
1661 colon between each element when concatenating; returning a
1662 colon-sep list (elements might contain newlines)
1663 charset name of charset to translate MIME words to; used only if
1664 want_raw is false; if NULL, no translation is done (this is
1665 used for $bh_ and $bheader_)
1667 Returns: NULL if the header does not exist, else a pointer to a new
1672 find_header(uschar * name, int * newsize, unsigned flags, const uschar * charset)
1675 int len = name ? Ustrlen(name) : 0;
1680 for (header_line * h = header_list; h; h = h->next)
1681 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1682 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1687 if (flags & FH_EXISTS_ONLY)
1688 return US"1"; /* don't need actual string */
1691 s = h->text + len; /* text to insert */
1692 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1693 Uskip_whitespace(&s); /* remove leading white space */
1694 t = h->text + h->slen; /* end-point */
1696 /* Unless wanted raw, remove trailing whitespace, including the
1699 if (flags & FH_WANT_LIST)
1700 while (t > s && t[-1] == '\n') t--;
1701 else if (!(flags & FH_WANT_RAW))
1703 while (t > s && isspace(t[-1])) t--;
1705 /* Set comma if handling a single header and it's one of those
1706 that contains an address list, except when asked for raw headers. Only
1707 need to do this once. */
1709 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1712 /* Trim the header roughly if we're approaching limits */
1714 if (gstring_length(g) + inc > header_insert_maxlen)
1715 inc = header_insert_maxlen - gstring_length(g);
1717 /* For raw just copy the data; for a list, add the data as a colon-sep
1718 list-element; for comma-list add as an unchecked comma,newline sep
1719 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1720 stripped trailing WS above including the newline). We ignore the potential
1721 expansion due to colon-doubling, just leaving the loop if the limit is met
1724 if (flags & FH_WANT_LIST)
1725 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1726 else if (flags & FH_WANT_RAW)
1727 g = string_catn(g, s, (unsigned)inc);
1729 g = string_append2_listele_n(g, comma ? US",\n" : US"\n",
1732 if (gstring_length(g) >= header_insert_maxlen) break;
1735 if (!found) return NULL; /* No header found */
1736 if (!g) return US"";
1738 /* That's all we do for raw header expansion. */
1741 rawhdr = string_from_gstring(g);
1742 if (flags & FH_WANT_RAW)
1745 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1746 The rfc2047_decode2() function can return an error with decoded data if the
1747 charset translation fails. If decoding fails, it returns NULL. */
1751 uschar * error, * decoded = rfc2047_decode2(rawhdr,
1752 check_rfc2047_length, charset, '?', NULL, newsize, &error);
1754 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1755 " input was: %s\n", error, rawhdr);
1756 return decoded ? decoded : rawhdr;
1763 /* Append a "local" element to an Authentication-Results: header
1764 if this was a non-smtp message.
1768 authres_local(gstring * g, const uschar * sysname)
1770 if (!f.authentication_local)
1772 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1773 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1778 /* Append an "iprev" element to an Authentication-Results: header
1779 if we have attempted to get the calling host's name.
1783 authres_iprev(gstring * g)
1785 if (sender_host_name)
1786 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1787 else if (host_lookup_deferred)
1788 g = string_cat(g, US";\n\tiprev=temperror");
1789 else if (host_lookup_failed)
1790 g = string_cat(g, US";\n\tiprev=fail");
1794 if (sender_host_address)
1795 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1801 /*************************************************
1802 * Return list of recipients *
1803 *************************************************/
1804 /* A recipients list is available only during system message filtering,
1805 during ACL processing after DATA, and while expanding pipe commands
1806 generated from a system filter, but not elsewhere. Note that this does
1807 not check for comman in the elements, and uses comma-space as seperator -
1808 so cannot be used as an exim list as-is. */
1816 if (!f.enable_dollar_recipients) return NULL;
1818 for (int i = 0; i < recipients_count; i++)
1820 s = recipients_list[i].address;
1821 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1823 gstring_release_unused(g);
1824 return string_from_gstring(g);
1827 /* Similar, but as a properly-quoted exim list */
1831 fn_recipients_list(void)
1835 if (!f.enable_dollar_recipients) return NULL;
1837 for (int i = 0; i < recipients_count; i++)
1838 g = string_append_listele(g, ':', recipients_list[i].address);
1839 gstring_release_unused(g);
1840 return string_from_gstring(g);
1844 /*************************************************
1845 * Return size of queue *
1846 *************************************************/
1847 /* Ask the daemon for the queue size */
1852 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1856 const uschar * where;
1859 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
1861 DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));
1865 len = daemon_client_sockname(&sa_un, &sname);
1867 if (bind(fd, (const struct sockaddr *)&sa_un, (socklen_t)len) < 0)
1868 { where = US"bind"; goto bad; }
1871 debug_printf("local addr '%s%s'\n",
1872 *sa_un.sun_path ? "" : "@",
1873 sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1876 len = daemon_notifier_sockname(&sa_un);
1877 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
1878 { where = US"connect"; goto bad2; }
1880 buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1881 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1883 if (poll_one_fd(fd, POLLIN, 2 * 1000) != 1)
1885 DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1886 len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1888 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1889 { where = US"recv"; goto bad2; }
1892 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1895 return string_copyn(buf, len);
1898 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1903 DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1908 /*************************************************
1909 * Find value of a variable *
1910 *************************************************/
1912 /* The table of variables is kept in alphabetic order, so we can search it
1913 using a binary chop. The "choplen" variable is nothing to do with the binary
1917 name the name of the variable being sought
1918 exists_only TRUE if this is a def: test; passed on to find_header()
1919 skipping TRUE => skip any processing evaluation; this is not the same as
1920 exists_only because def: may test for values that are first
1922 newsize pointer to an int which is initially zero; if the answer is in
1923 a new memory buffer, *newsize is set to its size
1925 Returns: NULL if the variable does not exist, or
1926 a pointer to the variable's contents, or
1927 something non-NULL if exists_only is TRUE
1930 static const uschar *
1931 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1938 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1939 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1940 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1941 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1942 (this gave backwards compatibility at the changeover). There may be built-in
1943 variables whose names start acl_ but they should never start in this way. This
1944 slightly messy specification is a consequence of the history, needless to say.
1946 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1947 set, in which case give an error. */
1949 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1953 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1954 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1956 else if (Ustrncmp(name, "r_", 2) == 0)
1958 tree_node * node = tree_search(router_var, name + 2);
1959 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1962 /* Handle $auth<n>, $regex<n> variables. */
1964 if (Ustrncmp(name, "auth", 4) == 0)
1967 int n = Ustrtoul(name + 4, &endptr, 10);
1968 if (!*endptr && n != 0 && n <= AUTH_VARS)
1969 return auth_vars[n-1] ? auth_vars[n-1] : US"";
1971 #ifdef WITH_CONTENT_SCAN
1972 else if (Ustrncmp(name, "regex", 5) == 0)
1975 int n = Ustrtoul(name + 5, &endptr, 10);
1976 if (!*endptr && n != 0 && n <= REGEX_VARS)
1977 return regex_vars[n-1] ? regex_vars[n-1] : US"";
1981 /* For all other variables, search the table */
1983 if (!(vp = find_var_ent(name)))
1984 return NULL; /* Unknown variable name */
1986 /* Found an existing variable. If in skipping state, the value isn't needed,
1987 and we want to avoid processing (such as looking up the host name). */
1995 case vtype_filter_int:
1996 if (!f.filter_running) return NULL;
2000 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
2004 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
2008 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
2012 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
2016 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
2019 case vtype_stringptr: /* Pointer to string */
2020 return (s = *((uschar **)(val))) ? s : US"";
2023 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
2026 case vtype_load_avg:
2027 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
2030 case vtype_host_lookup: /* Lookup if not done so */
2031 if ( !sender_host_name && sender_host_address
2032 && !host_lookup_failed && host_name_lookup() == OK)
2033 host_build_sender_fullhost();
2034 return sender_host_name ? sender_host_name : US"";
2036 case vtype_localpart: /* Get local part from address */
2037 if (!(s = *((uschar **)(val)))) return US"";
2038 if (!(domain = Ustrrchr(s, '@'))) return s;
2039 if (domain - s > sizeof(var_buffer) - 1)
2040 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
2041 " in string expansion", sizeof(var_buffer));
2042 return string_copyn(s, domain - s);
2044 case vtype_domain: /* Get domain from address */
2045 if (!(s = *((uschar **)(val)))) return US"";
2046 domain = Ustrrchr(s, '@');
2047 return domain ? domain + 1 : US"";
2049 case vtype_msgheaders:
2050 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
2052 case vtype_msgheaders_raw:
2053 return find_header(NULL, newsize,
2054 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
2056 case vtype_msgbody: /* Pointer to msgbody string */
2057 case vtype_msgbody_end: /* Ditto, the end of the msg */
2058 ss = (uschar **)(val);
2059 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
2062 off_t start_offset_o = spool_data_start_offset(message_id);
2063 off_t start_offset = start_offset_o;
2064 int len = message_body_visible;
2066 if (len > message_size) len = message_size;
2067 *ss = body = store_get(len+1, GET_TAINTED);
2069 if (vp->type == vtype_msgbody_end)
2071 struct stat statbuf;
2072 if (fstat(deliver_datafile, &statbuf) == 0)
2074 start_offset = statbuf.st_size - len;
2075 if (start_offset < start_offset_o)
2076 start_offset = start_offset_o;
2079 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
2080 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
2082 if ((len = read(deliver_datafile, body, len)) > 0)
2085 if (message_body_newlines) /* Separate loops for efficiency */
2087 { if (body[--len] == 0) body[len] = ' '; }
2090 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
2093 return *ss ? *ss : US"";
2095 case vtype_todbsdin: /* BSD inbox time of day */
2096 return tod_stamp(tod_bsdin);
2098 case vtype_tode: /* Unix epoch time of day */
2099 return tod_stamp(tod_epoch);
2101 case vtype_todel: /* Unix epoch/usec time of day */
2102 return tod_stamp(tod_epoch_l);
2104 case vtype_todf: /* Full time of day */
2105 return tod_stamp(tod_full);
2107 case vtype_todl: /* Log format time of day */
2108 return tod_stamp(tod_log_bare); /* (without timezone) */
2110 case vtype_todzone: /* Time zone offset only */
2111 return tod_stamp(tod_zone);
2113 case vtype_todzulu: /* Zulu time */
2114 return tod_stamp(tod_zulu);
2116 case vtype_todlf: /* Log file datestamp tod */
2117 return tod_stamp(tod_log_datestamp_daily);
2119 case vtype_reply: /* Get reply address */
2120 s = find_header(US"reply-to:", newsize,
2121 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2123 if (s) Uskip_whitespace(&s);
2126 *newsize = 0; /* For the *s==0 case */
2127 s = find_header(US"from:", newsize,
2128 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2134 Uskip_whitespace(&s);
2135 for (t = s; *t; t++) if (*t == '\n') *t = ' ';
2136 while (t > s && isspace(t[-1])) t--;
2139 return s ? s : US"";
2141 case vtype_string_func:
2143 stringptr_fn_t * fn = (stringptr_fn_t *) val;
2145 return s ? s : US"";
2151 sprintf(CS var_buffer, PR_EXIM_ARITH,
2152 receive_statvfs(val == (void *)TRUE, &inodes));
2159 (void) receive_statvfs(val == (void *)TRUE, &inodes);
2160 sprintf(CS var_buffer, "%d", inodes);
2165 return *(void **)val ? US"<cert>" : US"";
2167 #ifndef DISABLE_DKIM
2169 return dkim_exim_expand_query((int)(long)val);
2174 return NULL; /* Unknown variable. Silences static checkers. */
2181 modify_variable(uschar *name, void * value)
2184 if ((vp = find_var_ent(name))) vp->value = value;
2185 return; /* Unknown variable name, fail silently */
2193 /*************************************************
2194 * Read and expand substrings *
2195 *************************************************/
2197 /* This function is called to read and expand argument substrings for various
2198 expansion items. Some have a minimum requirement that is less than the maximum;
2199 in these cases, the first non-present one is set to NULL.
2202 sub points to vector of pointers to set
2203 n maximum number of substrings
2205 sptr points to current string pointer
2207 skipping the skipping flag
2208 check_end if TRUE, check for final '}'
2209 name name of item, for error message
2210 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2212 textonly_p if not NULL, pointer to bitmask of which subs were text-only
2213 (did not change when expended)
2215 Returns: -1 OK; string pointer updated, but in "skipping" mode
2216 0 OK; string pointer updated
2217 1 curly bracketing error (too few arguments)
2218 2 too many arguments (only if check_end is set); message set
2219 3 other error (expansion failure)
2223 read_subs(uschar ** sub, int n, int m, const uschar ** sptr, esi_flags flags,
2224 BOOL check_end, uschar * name, BOOL * resetok, unsigned * textonly_p)
2226 const uschar * s = *sptr;
2227 unsigned textonly_l = 0;
2229 Uskip_whitespace(&s);
2230 for (int i = 0; i < n; i++)
2237 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2238 "(min is %d)", name, m);
2244 if (!(sub[i] = expand_string_internal(s+1,
2245 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, &s, resetok,
2246 textonly_p ? &textonly : NULL)))
2248 if (*s++ != '}') return 1;
2249 if (textonly_p && textonly) textonly_l |= BIT(i);
2250 Uskip_whitespace(&s);
2252 if (check_end && *s++ != '}')
2256 expand_string_message = string_sprintf("Too many arguments for '%s' "
2257 "(max is %d)", name, n);
2260 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2264 if (textonly_p) *textonly_p = textonly_l;
2266 return flags & ESI_SKIPPING ? -1 : 0;
2272 /*************************************************
2273 * Elaborate message for bad variable *
2274 *************************************************/
2276 /* For the "unknown variable" message, take a look at the variable's name, and
2277 give additional information about possible ACL variables. The extra information
2278 is added on to expand_string_message.
2280 Argument: the name of the variable
2285 check_variable_error_message(uschar *name)
2287 if (Ustrncmp(name, "acl_", 4) == 0)
2288 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2289 (name[4] == 'c' || name[4] == 'm')?
2291 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2292 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2294 US"user-defined ACL variables must start acl_c or acl_m");
2300 Load args from sub array to globals, and call acl_check().
2301 Sub array will be corrupted on return.
2303 Returns: OK access is granted by an ACCEPT verb
2304 DISCARD access is (apparently) granted by a DISCARD verb
2305 FAIL access is denied
2306 FAIL_DROP access is denied; drop the connection
2307 DEFER can't tell at the moment
2311 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2314 int sav_narg = acl_narg;
2316 uschar * dummy_logmsg;
2317 extern int acl_where;
2319 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2320 for (i = 0; i < nsub && sub[i+1]; i++)
2322 uschar * tmp = acl_arg[i];
2323 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2324 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2329 sub[i+1] = acl_arg[i];
2330 acl_arg[i++] = NULL;
2334 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2336 acl_narg>0 ? acl_arg[0] : US"<none>",
2337 acl_narg>1 ? " +more" : "");
2339 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2341 for (i = 0; i < nsub; i++)
2342 acl_arg[i] = sub[i+1]; /* restore old args */
2343 acl_narg = sav_narg;
2351 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2352 The given string is modified on return. Leading whitespace is skipped while
2353 looking for the opening wrap character, then the rest is scanned for the trailing
2354 (non-escaped) wrap character. A backslash in the string will act as an escape.
2356 A nul is written over the trailing wrap, and a pointer to the char after the
2357 leading wrap is returned.
2360 s String for de-wrapping
2361 wrap Two-char string, the first being the opener, second the closer wrapping
2364 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2368 dewrap(uschar * s, const uschar * wrap)
2372 BOOL quotesmode = wrap[0] == wrap[1];
2374 if (Uskip_whitespace(&p) == *wrap)
2380 if (*p == '\\') p++;
2381 else if (!quotesmode && *p == wrap[-1]) depth++;
2382 else if (*p == *wrap)
2393 expand_string_message = string_sprintf("missing '%c'", *wrap);
2398 /* Pull off the leading array or object element, returning
2399 a copy in an allocated string. Update the list pointer.
2401 The element may itself be an abject or array.
2402 Return NULL when the list is empty.
2406 json_nextinlist(const uschar ** list)
2408 unsigned array_depth = 0, object_depth = 0;
2409 BOOL quoted = FALSE;
2410 const uschar * s = *list, * item;
2412 skip_whitespace(&s);
2415 *s && (*s != ',' || array_depth != 0 || object_depth != 0 || quoted);
2417 if (!quoted) switch (*s)
2419 case '[': array_depth++; break;
2420 case ']': array_depth--; break;
2421 case '{': object_depth++; break;
2422 case '}': object_depth--; break;
2423 case '"': quoted = TRUE;
2427 case '\\': s++; break; /* backslash protects one char */
2428 case '"': quoted = FALSE; break;
2430 *list = *s ? s+1 : s;
2431 if (item == s) return NULL;
2432 item = string_copyn(item, s - item);
2433 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2439 /************************************************/
2440 /* Return offset in ops table, or -1 if not found.
2441 Repoint to just after the operator in the string.
2444 ss string representation of operator
2445 opname split-out operator name
2449 identify_operator(const uschar ** ss, uschar ** opname)
2451 const uschar * s = *ss;
2454 /* Numeric comparisons are symbolic */
2456 if (*s == '=' || *s == '>' || *s == '<')
2468 /* All other conditions are named */
2471 s = read_name(name, sizeof(name), s, US"_");
2474 /* If we haven't read a name, it means some non-alpha character is first. */
2478 expand_string_message = string_sprintf("condition name expected, "
2479 "but found \"%.16s\"", s);
2483 *opname = string_copy(name);
2485 return chop_match(name, cond_table, nelem(cond_table));
2489 /*************************************************
2490 * Handle MD5 or SHA-1 computation for HMAC *
2491 *************************************************/
2493 /* These are some wrapping functions that enable the HMAC code to be a bit
2494 cleaner. A good compiler will spot the tail recursion.
2497 type HMAC_MD5 or HMAC_SHA1
2498 remaining are as for the cryptographic hash functions
2504 chash_start(int type, void * base)
2506 if (type == HMAC_MD5)
2507 md5_start((md5 *)base);
2509 sha1_start((hctx *)base);
2513 chash_mid(int type, void * base, const uschar * string)
2515 if (type == HMAC_MD5)
2516 md5_mid((md5 *)base, string);
2518 sha1_mid((hctx *)base, string);
2522 chash_end(int type, void * base, const uschar * string, int length,
2525 if (type == HMAC_MD5)
2526 md5_end((md5 *)base, string, length, digest);
2528 sha1_end((hctx *)base, string, length, digest);
2535 /* Do an hmac_md5. The result is _not_ nul-terminated, and is sized as
2536 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2539 key encoding key, nul-terminated
2540 src data to be hashed, nul-terminated
2542 len size of output buffer
2546 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2549 const uschar * keyptr;
2551 unsigned int keylen;
2553 #define MD5_HASHLEN 16
2554 #define MD5_HASHBLOCKLEN 64
2556 uschar keyhash[MD5_HASHLEN];
2557 uschar innerhash[MD5_HASHLEN];
2558 uschar finalhash[MD5_HASHLEN];
2559 uschar innerkey[MD5_HASHBLOCKLEN];
2560 uschar outerkey[MD5_HASHBLOCKLEN];
2563 keylen = Ustrlen(keyptr);
2565 /* If the key is longer than the hash block length, then hash the key
2568 if (keylen > MD5_HASHBLOCKLEN)
2570 chash_start(HMAC_MD5, &md5_base);
2571 chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2573 keylen = MD5_HASHLEN;
2576 /* Now make the inner and outer key values */
2578 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2579 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2581 for (int i = 0; i < keylen; i++)
2583 innerkey[i] ^= keyptr[i];
2584 outerkey[i] ^= keyptr[i];
2587 /* Now do the hashes */
2589 chash_start(HMAC_MD5, &md5_base);
2590 chash_mid(HMAC_MD5, &md5_base, innerkey);
2591 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2593 chash_start(HMAC_MD5, &md5_base);
2594 chash_mid(HMAC_MD5, &md5_base, outerkey);
2595 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2597 /* Encode the final hash as a hex string, limited by output buffer size */
2600 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2602 if (j-- <= 0) break;
2603 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2604 if (j-- <= 0) break;
2605 *p++ = hex_digits[finalhash[i] & 0x0f];
2609 #endif /*SUPPORT_SRS*/
2612 /*************************************************
2613 * Read and evaluate a condition *
2614 *************************************************/
2618 s points to the start of the condition text
2619 resetok points to a BOOL which is written false if it is unsafe to
2620 free memory. Certain condition types (acl) may have side-effect
2621 allocation which must be preserved.
2622 yield points to a BOOL to hold the result of the condition test;
2623 if NULL, we are just reading through a condition that is
2624 part of an "or" combination to check syntax, or in a state
2625 where the answer isn't required
2627 Returns: a pointer to the first character after the condition, or
2631 static const uschar *
2632 eval_condition(const uschar * s, BOOL * resetok, BOOL * yield)
2634 BOOL testfor = TRUE;
2635 BOOL tempcond, combined_cond;
2637 BOOL sub2_honour_dollar = TRUE;
2638 BOOL is_forany, is_json, is_jsons;
2640 int_eximarith_t num[2];
2641 struct stat statbuf;
2644 const uschar * sub[10];
2645 unsigned sub_textonly = 0;
2648 if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;
2650 switch(cond_type = identify_operator(&s, &opname))
2652 /* def: tests for a non-empty variable, or for the existence of a header. If
2653 yield == NULL we are in a skipping state, and don't care about the answer. */
2661 expand_string_message = US"\":\" expected after \"def\"";
2665 s = read_name(name, sizeof(name), s+1, US"_");
2667 /* Test for a header's existence. If the name contains a closing brace
2668 character, this may be a user error where the terminating colon has been
2669 omitted. Set a flag to adjust a subsequent error message in this case. */
2671 if ( ( *(t = name) == 'h'
2672 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2674 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2677 s = read_header_name(name, sizeof(name), s);
2678 /* {-for-text-editors */
2679 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2681 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2684 /* Test for a variable's having a non-empty value. A non-existent variable
2685 causes an expansion failure. */
2689 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2691 expand_string_message = name[0]
2692 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2693 : US"variable name omitted after \"def:\"";
2694 check_variable_error_message(name);
2697 if (yield) *yield = (t[0] != 0) == testfor;
2704 /* first_delivery tests for first delivery attempt */
2706 case ECOND_FIRST_DELIVERY:
2707 if (yield) *yield = f.deliver_firsttime == testfor;
2711 /* queue_running tests for any process started by a queue runner */
2713 case ECOND_QUEUE_RUNNING:
2714 if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2718 /* exists: tests for file existence
2719 isip: tests for any IP address
2720 isip4: tests for an IPv4 address
2721 isip6: tests for an IPv6 address
2722 pam: does PAM authentication
2723 radius: does RADIUS authentication
2724 ldapauth: does LDAP authentication
2725 pwcheck: does Cyrus SASL pwcheck authentication
2734 case ECOND_LDAPAUTH:
2737 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2741 sub[0] = expand_string_internal(s+1,
2742 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
2743 &s, resetok, &textonly);
2744 if (!sub[0]) return NULL;
2745 if (textonly) sub_textonly |= BIT(0);
2747 /* {-for-text-editors */
2748 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2750 if (!yield) return s; /* No need to run the test if skipping */
2755 if ((expand_forbid & RDO_EXISTS) != 0)
2757 expand_string_message = US"File existence tests are not permitted";
2760 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2766 rc = string_is_ip_address(sub[0], NULL);
2767 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2768 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2771 /* Various authentication tests - all optionally compiled */
2775 rc = auth_call_pam(sub[0], &expand_string_message);
2778 goto COND_FAILED_NOT_COMPILED;
2779 #endif /* SUPPORT_PAM */
2782 #ifdef RADIUS_CONFIG_FILE
2783 rc = auth_call_radius(sub[0], &expand_string_message);
2786 goto COND_FAILED_NOT_COMPILED;
2787 #endif /* RADIUS_CONFIG_FILE */
2789 case ECOND_LDAPAUTH:
2792 /* Just to keep the interface the same */
2794 int old_pool = store_pool;
2795 store_pool = POOL_SEARCH;
2796 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2797 &expand_string_message, &do_cache);
2798 store_pool = old_pool;
2802 goto COND_FAILED_NOT_COMPILED;
2803 #endif /* LOOKUP_LDAP */
2806 #ifdef CYRUS_PWCHECK_SOCKET
2807 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2810 goto COND_FAILED_NOT_COMPILED;
2811 #endif /* CYRUS_PWCHECK_SOCKET */
2813 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2814 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2816 if (rc == ERROR || rc == DEFER) return NULL;
2817 *yield = (rc == OK) == testfor;
2823 /* call ACL (in a conditional context). Accept true, deny false.
2824 Defer is a forced-fail. Anything set by message= goes to $value.
2825 Up to ten parameters are used; we use the braces round the name+args
2826 like the saslauthd condition does, to permit a variable number of args.
2827 See also the expansion-item version EITEM_ACL and the traditional
2828 acl modifier ACLC_ACL.
2829 Since the ACL may allocate new global variables, tell our caller to not
2834 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2840 Uskip_whitespace(&s);
2841 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2843 switch(read_subs(sub, nelem(sub), 1, &s,
2844 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2846 case 1: expand_string_message = US"too few arguments or bracketing "
2849 case 3: return NULL;
2855 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2856 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2861 lookup_value = NULL;
2863 lookup_value = string_copy(user_msg);
2864 *yield = cond == testfor;
2868 f.expand_string_forcedfail = TRUE;
2871 expand_string_message = string_sprintf("%s from acl \"%s\"",
2872 rc_names[rc], sub[0]);
2880 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2882 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2884 However, the last two are optional. That is why the whole set is enclosed
2885 in their own set of braces. */
2887 case ECOND_SASLAUTHD:
2888 #ifndef CYRUS_SASLAUTHD_SOCKET
2889 goto COND_FAILED_NOT_COMPILED;
2893 Uskip_whitespace(&s);
2894 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2895 switch(read_subs(sub, nelem(sub), 2, &s,
2896 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2898 case 1: expand_string_message = US"too few arguments or bracketing "
2899 "error for saslauthd";
2901 case 3: return NULL;
2903 if (!sub[2]) sub[3] = NULL; /* realm if no service */
2906 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2907 &expand_string_message);
2908 if (rc == ERROR || rc == DEFER) return NULL;
2909 *yield = (rc == OK) == testfor;
2913 #endif /* CYRUS_SASLAUTHD_SOCKET */
2916 /* symbolic operators for numeric and string comparison, and a number of
2917 other operators, all requiring two arguments.
2919 crypteq: encrypts plaintext and compares against an encrypted text,
2920 using crypt(), crypt16(), MD5 or SHA-1
2921 inlist/inlisti: checks if first argument is in the list of the second
2922 match: does a regular expression match and sets up the numerical
2923 variables if it succeeds
2924 match_address: matches in an address list
2925 match_domain: matches in a domain list
2926 match_ip: matches a host list that is restricted to IP addresses
2927 match_local_part: matches in a local part list
2930 case ECOND_MATCH_ADDRESS:
2931 case ECOND_MATCH_DOMAIN:
2932 case ECOND_MATCH_IP:
2933 case ECOND_MATCH_LOCAL_PART:
2934 #ifndef EXPAND_LISTMATCH_RHS
2935 sub2_honour_dollar = FALSE;
2944 case ECOND_NUM_L: /* Numerical comparisons */
2951 case ECOND_STR_LT: /* String comparisons */
2962 for (int i = 0; i < 2; i++)
2965 /* Sometimes, we don't expand substrings; too many insecure configurations
2966 created using match_address{}{} and friends, where the second param
2967 includes information from untrustworthy sources. */
2968 /*XXX is this moot given taint-tracking? */
2970 esi_flags flags = ESI_BRACE_ENDS;
2972 if (!(i > 0 && !sub2_honour_dollar)) flags |= ESI_HONOR_DOLLAR;
2973 if (!yield) flags |= ESI_SKIPPING;
2975 if (Uskip_whitespace(&s) != '{')
2977 if (i == 0) goto COND_FAILED_CURLY_START;
2978 expand_string_message = string_sprintf("missing 2nd string in {} "
2979 "after \"%s\"", opname);
2982 if (!(sub[i] = expand_string_internal(s+1, flags, &s, resetok, &textonly)))
2984 if (textonly) sub_textonly |= BIT(i);
2985 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2986 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2987 " for security reasons\n");
2988 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2990 /* Convert to numerical if required; we know that the names of all the
2991 conditions that compare numbers do not start with a letter. This just saves
2992 checking for them individually. */
2994 if (!isalpha(opname[0]) && yield)
2999 debug_printf_indent("empty string cast to zero for numerical comparison\n");
3003 num[i] = expanded_string_integer(sub[i], FALSE);
3004 if (expand_string_message) return NULL;
3008 /* Result not required */
3010 if (!yield) return s;
3012 /* Do an appropriate comparison */
3018 tempcond = (num[0] == num[1]); break;
3021 tempcond = (num[0] > num[1]); break;
3024 tempcond = (num[0] >= num[1]); break;
3027 tempcond = (num[0] < num[1]); break;
3030 tempcond = (num[0] <= num[1]); break;
3033 tempcond = (Ustrcmp(sub[0], sub[1]) < 0); break;
3036 tempcond = (strcmpic(sub[0], sub[1]) < 0); break;
3039 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0); break;
3042 tempcond = (strcmpic(sub[0], sub[1]) <= 0); break;
3045 tempcond = (Ustrcmp(sub[0], sub[1]) == 0); break;
3048 tempcond = (strcmpic(sub[0], sub[1]) == 0); break;
3051 tempcond = (Ustrcmp(sub[0], sub[1]) > 0); break;
3054 tempcond = (strcmpic(sub[0], sub[1]) > 0); break;
3057 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0); break;
3060 tempcond = (strcmpic(sub[0], sub[1]) >= 0); break;
3062 case ECOND_MATCH: /* Regular expression match */
3064 const pcre2_code * re = regex_compile(sub[1],
3065 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
3066 &expand_string_message, pcre_gen_cmp_ctx);
3070 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
3074 case ECOND_MATCH_ADDRESS: /* Match in an address list */
3075 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0,
3076 CUSS &lookup_value);
3077 goto MATCHED_SOMETHING;
3079 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
3080 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
3081 MCL_DOMAIN + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3082 goto MATCHED_SOMETHING;
3084 case ECOND_MATCH_IP: /* Match IP address in a host list */
3085 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
3087 expand_string_message = string_sprintf("\"%s\" is not an IP address",
3093 unsigned int *nullcache = NULL;
3094 check_host_block cb;
3096 cb.host_name = US"";
3097 cb.host_address = sub[0];
3099 /* If the host address starts off ::ffff: it is an IPv6 address in
3100 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3103 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3104 cb.host_address + 7 : cb.host_address;
3106 rc = match_check_list(
3107 &sub[1], /* the list */
3108 0, /* separator character */
3109 &hostlist_anchor, /* anchor pointer */
3110 &nullcache, /* cache pointer */
3111 check_host, /* function for testing */
3112 &cb, /* argument for function */
3113 MCL_HOST, /* type of check */
3114 sub[0], /* text for debugging */
3115 CUSS &lookup_value); /* where to pass back data */
3117 goto MATCHED_SOMETHING;
3119 case ECOND_MATCH_LOCAL_PART:
3120 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3121 MCL_LOCALPART + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3127 case OK: tempcond = TRUE; break;
3128 case FAIL: tempcond = FALSE; break;
3131 expand_string_message = string_sprintf("unable to complete match "
3132 "against \"%s\": %s", sub[1], search_error_message);
3138 /* Various "encrypted" comparisons. If the second string starts with
3139 "{" then an encryption type is given. Default to crypt() or crypt16()
3140 (build-time choice). */
3141 /* }-for-text-editors */
3144 #ifndef SUPPORT_CRYPTEQ
3145 goto COND_FAILED_NOT_COMPILED;
3147 if (strncmpic(sub[1], US"{md5}", 5) == 0)
3149 int sublen = Ustrlen(sub[1]+5);
3154 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3156 /* If the length that we are comparing against is 24, the MD5 digest
3157 is expressed as a base64 string. This is the way LDAP does it. However,
3158 some other software uses a straightforward hex representation. We assume
3159 this if the length is 32. Other lengths fail. */
3163 uschar *coded = b64encode(CUS digest, 16);
3164 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3165 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3166 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3168 else if (sublen == 32)
3171 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3173 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3174 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3175 tempcond = (strcmpic(coded, sub[1]+5) == 0);
3179 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3180 "fail\n crypted=%s\n", sub[1]+5);
3185 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3187 int sublen = Ustrlen(sub[1]+6);
3192 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3194 /* If the length that we are comparing against is 28, assume the SHA1
3195 digest is expressed as a base64 string. If the length is 40, assume a
3196 straightforward hex representation. Other lengths fail. */
3200 uschar *coded = b64encode(CUS digest, 20);
3201 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3202 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3203 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3205 else if (sublen == 40)
3208 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3210 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3211 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3212 tempcond = (strcmpic(coded, sub[1]+6) == 0);
3216 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3217 "fail\n crypted=%s\n", sub[1]+6);
3222 else /* {crypt} or {crypt16} and non-{ at start */
3223 /* }-for-text-editors */
3228 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3233 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3238 else if (sub[1][0] == '{') /* }-for-text-editors */
3240 expand_string_message = string_sprintf("unknown encryption mechanism "
3241 "in \"%s\"", sub[1]);
3247 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3248 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
3249 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3253 #define XSTR(s) STR(s)
3254 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3255 " subject=%s\n crypted=%s\n",
3256 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3261 /* If the encrypted string contains fewer than two characters (for the
3262 salt), force failure. Otherwise we get false positives: with an empty
3263 string the yield of crypt() is an empty string! */
3266 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3267 else if (errno == EINVAL)
3271 expand_string_message = string_sprintf("crypt error: %s\n",
3272 US strerror(errno));
3277 #endif /* SUPPORT_CRYPTEQ */
3282 const uschar * list = sub[1];
3284 uschar *save_iterate_item = iterate_item;
3285 int (*compare)(const uschar *, const uschar *);
3287 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);
3290 compare = cond_type == ECOND_INLISTI
3291 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3293 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3295 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3296 if (compare(sub[0], iterate_item) == 0)
3299 lookup_value = iterate_item;
3303 iterate_item = save_iterate_item;
3306 } /* Switch for comparison conditions */
3308 *yield = tempcond == testfor;
3309 return s; /* End of comparison conditions */
3312 /* and/or: computes logical and/or of several conditions */
3316 subcondptr = (yield == NULL) ? NULL : &tempcond;
3317 combined_cond = (cond_type == ECOND_AND);
3319 Uskip_whitespace(&s);
3320 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3324 /* {-for-text-editors */
3325 if (Uskip_whitespace(&s) == '}') break;
3326 if (*s != '{') /* }-for-text-editors */
3328 expand_string_message = string_sprintf("each subcondition "
3329 "inside an \"%s{...}\" condition must be in its own {}", opname);
3333 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3335 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3336 expand_string_message, opname);
3339 Uskip_whitespace(&s);
3341 /* {-for-text-editors */
3344 /* {-for-text-editors */
3345 expand_string_message = string_sprintf("missing } at end of condition "
3346 "inside \"%s\" group", opname);
3351 if (cond_type == ECOND_AND)
3353 combined_cond &= tempcond;
3354 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3355 } /* evaluate any more */
3358 combined_cond |= tempcond;
3359 if (combined_cond) subcondptr = NULL; /* once true, don't */
3360 } /* evaluate any more */
3363 if (yield) *yield = (combined_cond == testfor);
3367 /* forall/forany: iterates a condition with different values */
3369 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3370 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3371 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3372 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3373 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3374 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3378 const uschar * list;
3380 uschar *save_iterate_item = iterate_item;
3382 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3384 Uskip_whitespace(&s);
3385 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3386 if (!(sub[0] = expand_string_internal(s,
3387 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
3388 &s, resetok, NULL)))
3390 /* {-for-text-editors */
3391 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3393 Uskip_whitespace(&s);
3394 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3398 /* Call eval_condition once, with result discarded (as if scanning a
3399 "false" part). This allows us to find the end of the condition, because if
3400 the list it empty, we won't actually evaluate the condition for real. */
3402 if (!(s = eval_condition(sub[1], resetok, NULL)))
3404 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3405 expand_string_message, opname);
3408 Uskip_whitespace(&s);
3410 /* {-for-text-editors */
3413 /* {-for-text-editors */
3414 expand_string_message = string_sprintf("missing } at end of condition "
3415 "inside \"%s\"", opname);
3419 if (yield) *yield = !testfor;
3421 if (is_json) list = dewrap(string_copy(list), US"[]");
3422 while ((iterate_item = is_json
3423 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3426 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3428 expand_string_message =
3429 string_sprintf("%s wrapping string result for extract jsons",
3430 expand_string_message);
3431 iterate_item = save_iterate_item;
3435 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3436 if (!eval_condition(sub[1], resetok, &tempcond))
3438 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3439 expand_string_message, opname);
3440 iterate_item = save_iterate_item;
3443 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3444 tempcond? "true":"false");
3446 if (yield) *yield = (tempcond == testfor);
3447 if (tempcond == is_forany) break;
3450 iterate_item = save_iterate_item;
3455 /* The bool{} expansion condition maps a string to boolean.
3456 The values supported should match those supported by the ACL condition
3457 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3458 of true/false. Note that Router "condition" rules have a different
3459 interpretation, where general data can be used and only a few values
3461 Note that readconf.c boolean matching, for boolean configuration options,
3462 only matches true/yes/false/no.
3463 The bool_lax{} condition matches the Router logic, which is much more
3466 case ECOND_BOOL_LAX:
3472 BOOL boolvalue = FALSE;
3474 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3475 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3476 switch(read_subs(sub_arg, 1, 1, &s,
3477 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, ourname, resetok, NULL))
3479 case 1: expand_string_message = string_sprintf(
3480 "too few arguments or bracketing error for %s",
3484 case 3: return NULL;
3487 Uskip_whitespace(&t);
3488 if ((len = Ustrlen(t)))
3490 /* trailing whitespace: seems like a good idea to ignore it too */
3492 while (isspace(*t2)) t2--;
3493 if (t2 != (t + len))
3500 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3501 /* logic for the lax case from expand_check_condition(), which also does
3502 expands, and the logic is both short and stable enough that there should
3503 be no maintenance burden from replicating it. */
3507 ? Ustrspn(t+1, "0123456789") == len-1
3508 : Ustrspn(t, "0123456789") == len)
3510 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3511 /* expand_check_condition only does a literal string "0" check */
3512 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3515 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3517 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3519 else if (cond_type == ECOND_BOOL_LAX)
3523 expand_string_message = string_sprintf("unrecognised boolean "
3527 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3528 boolvalue? "true":"false");
3529 if (yield) *yield = (boolvalue == testfor);
3534 case ECOND_INBOUND_SRS:
3535 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */
3538 const pcre2_code * re;
3539 pcre2_match_data * md;
3543 BOOL boolvalue = FALSE;
3545 switch(read_subs(sub, 2, 2, CUSS &s,
3546 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, name, resetok, NULL))
3548 case 1: expand_string_message = US"too few arguments or bracketing "
3549 "error for inbound_srs";
3551 case 3: return NULL;
3554 /* Match the given local_part against the SRS-encoded pattern */
3556 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]{2})=([^=]*)=(.*)$",
3557 MCS_CASELESS | MCS_CACHEABLE, FALSE);
3558 md = pcre2_match_data_create(4+1, pcre_gen_ctx);
3559 if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,
3560 md, pcre_gen_mtc_ctx) < 0)
3562 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3565 ovec = pcre2_get_ovector_pointer(md);
3567 if (sub[0][0] == '"')
3569 else for (uschar * s = sub[0]; *s; s++)
3570 if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3571 { quoting = 1; break; }
3573 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3575 /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3577 srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S", /* lowercased */
3579 (int) (ovec[9]-ovec[8]), sub[0] + ovec[8], /* substr 4 */
3581 (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */
3583 /* If a zero-length secret was given, we're done. Otherwise carry on
3584 and validate the given SRS local_part againt our secret. */
3588 /* check the timestamp */
3591 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3595 gettimeofday(&now, NULL);
3596 now.tv_sec /= 86400; /* days since epoch */
3598 /* Decode substring 2 from base32 to a number */
3600 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3602 uschar * t = Ustrchr(base32_chars, *ss++);
3603 d = d * 32 + (t - base32_chars);
3606 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3608 DEBUG(D_expand) debug_printf("SRS too old\n");
3613 /* check length of substring 1, the offered checksum */
3615 if (ovec[3]-ovec[2] != 4)
3617 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3621 /* Hash the address with our secret, and compare that computed checksum
3622 with the one extracted from the arg */
3624 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3625 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3627 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3634 /* pcre2_match_data_free(md); gen ctx needs no free */
3635 if (yield) *yield = (boolvalue == testfor);
3638 #endif /*SUPPORT_SRS*/
3640 /* Unknown condition */
3643 if (!expand_string_message || !*expand_string_message)
3644 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3646 } /* End switch on condition type */
3648 /* Missing braces at start and end of data */
3650 COND_FAILED_CURLY_START:
3651 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3654 COND_FAILED_CURLY_END:
3655 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3659 /* A condition requires code that is not compiled */
3661 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3662 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3663 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3664 COND_FAILED_NOT_COMPILED:
3665 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3674 /*************************************************
3675 * Save numerical variables *
3676 *************************************************/
3678 /* This function is called from items such as "if" that want to preserve and
3679 restore the numbered variables.
3682 save_expand_string points to an array of pointers to set
3683 save_expand_nlength points to an array of ints for the lengths
3685 Returns: the value of expand max to save
3689 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3691 for (int i = 0; i <= expand_nmax; i++)
3693 save_expand_nstring[i] = expand_nstring[i];
3694 save_expand_nlength[i] = expand_nlength[i];
3701 /*************************************************
3702 * Restore numerical variables *
3703 *************************************************/
3705 /* This function restored saved values of numerical strings.
3708 save_expand_nmax the number of strings to restore
3709 save_expand_string points to an array of pointers
3710 save_expand_nlength points to an array of ints
3716 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3717 int *save_expand_nlength)
3719 expand_nmax = save_expand_nmax;
3720 for (int i = 0; i <= expand_nmax; i++)
3722 expand_nstring[i] = save_expand_nstring[i];
3723 expand_nlength[i] = save_expand_nlength[i];
3731 /*************************************************
3732 * Handle yes/no substrings *
3733 *************************************************/
3735 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3736 alternative substrings that depend on whether or not the condition was true,
3737 or the lookup or extraction succeeded. The substrings always have to be
3738 expanded, to check their syntax, but "skipping" is set when the result is not
3739 needed - this avoids unnecessary nested lookups.
3743 skipping TRUE if we were skipping when this item was reached
3744 yes TRUE if the first string is to be used, else use the second
3745 save_lookup a value to put back into lookup_value before the 2nd expansion
3746 sptr points to the input string pointer
3747 yieldptr points to the output growable-string pointer
3748 type "lookup", "if", "extract", "run", "env", "listextract" or
3749 "certextract" for error message
3750 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3753 Returns: 0 OK; lookup_value has been reset to save_lookup
3755 2 expansion failed because of bracketing error
3759 process_yesno(esi_flags flags, BOOL yes, uschar *save_lookup, const uschar **sptr,
3760 gstring ** yieldptr, uschar *type, BOOL *resetok)
3763 const uschar *s = *sptr; /* Local value */
3764 uschar *sub1, *sub2;
3765 const uschar * errwhere;
3767 flags &= ESI_SKIPPING; /* Ignore all buf the skipping flag */
3769 /* If there are no following strings, we substitute the contents of $value for
3770 lookups and for extractions in the success case. For the ${if item, the string
3771 "true" is substituted. In the fail case, nothing is substituted for all three
3774 if (skip_whitespace(&s) == '}')
3778 if (yes && !(flags & ESI_SKIPPING))
3779 *yieldptr = string_catn(*yieldptr, US"true", 4);
3783 if (yes && lookup_value && !(flags & ESI_SKIPPING))
3784 *yieldptr = string_cat(*yieldptr, lookup_value);
3785 lookup_value = save_lookup;
3791 /* The first following string must be braced. */
3795 errwhere = US"'yes' part did not start with '{'"; /*}}*/
3799 /* Expand the first substring. Forced failures are noticed only if we actually
3800 want this string. Set skipping in the call in the fail case (this will always
3801 be the case if we were already skipping). */
3803 sub1 = expand_string_internal(s,
3804 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yes ? ESI_NOFLAGS : ESI_SKIPPING),
3806 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3807 f.expand_string_forcedfail = FALSE;
3811 errwhere = US"'yes' part did not end with '}'";
3815 /* If we want the first string, add it to the output */
3818 *yieldptr = string_cat(*yieldptr, sub1);
3820 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3821 $value to what it was at the start of the item, so that it has this value
3822 during the second string expansion. For the call from "if" or "run" to this
3823 function, save_lookup is set to lookup_value, so that this statement does
3826 lookup_value = save_lookup;
3828 /* There now follows either another substring, or "fail", or nothing. This
3829 time, forced failures are noticed only if we want the second string. We must
3830 set skipping in the nested call if we don't want this string, or if we were
3831 already skipping. */
3833 if (skip_whitespace(&s) == '{') /*}*/
3835 esi_flags s_flags = ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags;
3836 if (yes) s_flags |= ESI_SKIPPING;
3837 sub2 = expand_string_internal(s+1, s_flags, &s, resetok, NULL);
3838 if (!sub2 && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3839 f.expand_string_forcedfail = FALSE; /*{*/
3842 errwhere = US"'no' part did not start with '{'"; /*}*/
3846 /* If we want the second string, add it to the output */
3849 *yieldptr = string_cat(*yieldptr, sub2);
3852 /* If there is no second string, but the word "fail" is present when the use of
3853 the second string is wanted, set a flag indicating it was a forced failure
3854 rather than a syntactic error. Swallow the terminating } in case this is nested
3855 inside another lookup or if or extract. */
3860 /* deconst cast ok here as source is s anyway */
3861 s = US read_name(name, sizeof(name), s, US"_");
3862 if (Ustrcmp(name, "fail") == 0)
3864 if (!yes && !(flags & ESI_SKIPPING))
3866 Uskip_whitespace(&s); /*{{*/
3869 errwhere = US"did not close with '}' after forcedfail";
3872 expand_string_message =
3873 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3874 f.expand_string_forcedfail = TRUE;
3880 expand_string_message =
3881 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3886 /* All we have to do now is to check on the final closing brace. */
3888 skip_whitespace(&s); /*{{*/
3891 errwhere = US"did not close with '}'";
3897 /* Update the input pointer value before returning */
3902 /* Get here if there is a bracketing failure */
3903 expand_string_message = string_sprintf(
3904 "curly-bracket problem in conditional yes/no parsing: %s\n"
3905 " remaining string is '%s'", errwhere, --s);
3910 /* Get here for other failures */
3918 /********************************************************
3919 * prvs: Get last three digits of days since Jan 1, 1970 *
3920 ********************************************************/
3922 /* This is needed to implement the "prvs" BATV reverse
3925 Argument: integer "days" offset to add or substract to
3926 or from the current number of days.
3928 Returns: pointer to string containing the last three
3929 digits of the number of days since Jan 1, 1970,
3930 modified by the offset argument, NULL if there
3931 was an error in the conversion.
3936 prvs_daystamp(int day_offset)
3938 uschar * days = store_get(32, GET_UNTAINTED); /* Need at least 24 for cases */
3939 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3940 (time(NULL) + day_offset*86400)/86400);
3941 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3946 /********************************************************
3947 * prvs: perform HMAC-SHA1 computation of prvs bits *
3948 ********************************************************/
3950 /* This is needed to implement the "prvs" BATV reverse
3954 address RFC2821 Address to use
3955 key The key to use (must be less than 64 characters
3957 key_num Single-digit key number to use. Defaults to
3960 Returns: pointer to string containing the first three
3961 bytes of the final hash in hex format, NULL if
3962 there was an error in the process.
3966 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3968 gstring * hash_source;
3971 uschar innerhash[20];
3972 uschar finalhash[20];
3973 uschar innerkey[64];
3974 uschar outerkey[64];
3975 uschar *finalhash_hex;
3980 if (Ustrlen(key) > 64)
3983 hash_source = string_catn(NULL, key_num, 1);
3984 hash_source = string_catn(hash_source, daystamp, 3);
3985 hash_source = string_cat(hash_source, address);
3988 debug_printf_indent("prvs: hash source is '%Y'\n", hash_source);
3990 memset(innerkey, 0x36, 64);
3991 memset(outerkey, 0x5c, 64);
3993 for (int i = 0; i < Ustrlen(key); i++)
3995 innerkey[i] ^= key[i];
3996 outerkey[i] ^= key[i];
3999 chash_start(HMAC_SHA1, &h);
4000 chash_mid(HMAC_SHA1, &h, innerkey);
4001 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
4003 chash_start(HMAC_SHA1, &h);
4004 chash_mid(HMAC_SHA1, &h, outerkey);
4005 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
4007 /* Hashing is deemed sufficient to de-taint any input data */
4009 p = finalhash_hex = store_get(40, GET_UNTAINTED);
4010 for (int i = 0; i < 3; i++)
4012 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4013 *p++ = hex_digits[finalhash[i] & 0x0f];
4017 return finalhash_hex;
4023 /*************************************************
4024 * Join a file onto the output string *
4025 *************************************************/
4027 /* This is used for readfile/readsock and after a run expansion.
4028 It joins the contents of a file onto the output string, globally replacing
4029 newlines with a given string (optionally).
4033 yield pointer to the expandable string struct
4034 eol newline replacement string, or NULL
4036 Returns: new pointer for expandable string, terminated if non-null
4040 cat_file(FILE * f, gstring * yield, uschar * eol)
4042 uschar buffer[1024];
4044 while (Ufgets(buffer, sizeof(buffer), f))
4046 int len = Ustrlen(buffer);
4047 if (eol && buffer[len-1] == '\n') len--;
4048 yield = string_catn(yield, buffer, len);
4049 if (eol && buffer[len])
4050 yield = string_cat(yield, eol);
4058 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
4061 uschar buffer[1024];
4063 /*XXX could we read direct into a pre-grown string? */
4065 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
4066 for (uschar * s = buffer; rc--; s++)
4067 yield = eol && *s == '\n'
4068 ? string_cat(yield, eol) : string_catn(yield, s, 1);
4070 /* We assume that all errors, and any returns of zero bytes,
4071 are actually EOF. */
4078 /*************************************************
4079 * Evaluate numeric expression *
4080 *************************************************/
4082 /* This is a set of mutually recursive functions that evaluate an arithmetic
4083 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
4084 these functions that is called from elsewhere is eval_expr, whose interface is:
4087 sptr pointer to the pointer to the string - gets updated
4088 decimal TRUE if numbers are to be assumed decimal
4089 error pointer to where to put an error message - must be NULL on input
4090 endket TRUE if ')' must terminate - FALSE for external call
4092 Returns: on success: the value of the expression, with *error still NULL
4093 on failure: an undefined value, with *error = a message
4096 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4099 static int_eximarith_t
4100 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4103 int_eximarith_t x = eval_op_or(&s, decimal, error);
4108 *error = US"expecting closing parenthesis";
4110 while (isspace(*++s));
4112 *error = US"expecting operator";
4118 static int_eximarith_t
4119 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4125 if (isdigit((c = Uskip_whitespace(&s))))
4128 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4130 switch (tolower(*s))
4133 case 'k': n *= 1024; s++; break;
4134 case 'm': n *= 1024*1024; s++; break;
4135 case 'g': n *= 1024*1024*1024; s++; break;
4137 Uskip_whitespace(&s);
4142 n = eval_expr(&s, decimal, error, 1);
4146 *error = US"expecting number or opening parenthesis";
4154 static int_eximarith_t
4155 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4159 Uskip_whitespace(&s);
4160 if (*s == '+' || *s == '-' || *s == '~')
4163 x = eval_op_unary(&s, decimal, error);
4164 if (op == '-') x = -x;
4165 else if (op == '~') x = ~x;
4168 x = eval_number(&s, decimal, error);
4175 static int_eximarith_t
4176 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4179 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4182 while (*s == '*' || *s == '/' || *s == '%')
4185 int_eximarith_t y = eval_op_unary(&s, decimal, error);
4187 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4188 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4189 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4190 * -N*M is INT_MIN will yield INT_MIN.
4191 * Since we don't support floating point, this is somewhat simpler.
4192 * Ideally, we'd return an error, but since we overflow for all other
4193 * arithmetic, consistency suggests otherwise, but what's the correct value
4194 * to use? There is none.
4195 * The C standard guarantees overflow for unsigned arithmetic but signed
4196 * overflow invokes undefined behaviour; in practice, this is overflow
4197 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4198 * that long/longlong larger than int are available, or we could just work
4199 * with larger types. We should consider whether to guarantee 32bit eval
4200 * and 64-bit working variables, with errors returned. For now ...
4201 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4202 * can just let the other invalid results occur otherwise, as they have
4203 * until now. For this one case, we can coerce.
4205 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4208 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4209 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4219 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4235 static int_eximarith_t
4236 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4239 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4242 while (*s == '+' || *s == '-')
4245 int_eximarith_t y = eval_op_mult(&s, decimal, error);
4247 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4248 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4249 { /* over-conservative check */
4251 ? US"overflow in sum" : US"overflow in difference";
4254 if (op == '+') x += y; else x -= y;
4262 static int_eximarith_t
4263 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4266 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4269 while ((*s == '<' || *s == '>') && s[1] == s[0])
4274 y = eval_op_sum(&s, decimal, error);
4276 if (op == '<') x <<= y; else x >>= y;
4284 static int_eximarith_t
4285 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4288 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4295 y = eval_op_shift(&s, decimal, error);
4305 static int_eximarith_t
4306 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4309 int_eximarith_t x = eval_op_and(&s, decimal, error);
4316 y = eval_op_and(&s, decimal, error);
4326 static int_eximarith_t
4327 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4330 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4337 y = eval_op_xor(&s, decimal, error);
4348 /************************************************/
4349 /* Comparison operation for sort expansion. We need to avoid
4350 re-expanding the fields being compared, so need a custom routine.
4353 cond_type Comparison operator code
4354 leftarg, rightarg Arguments for comparison
4356 Return true iff (leftarg compare rightarg)
4360 sortsbefore(int cond_type, BOOL alpha_cond,
4361 const uschar * leftarg, const uschar * rightarg)
4363 int_eximarith_t l_num, r_num;
4367 l_num = expanded_string_integer(leftarg, FALSE);
4368 if (expand_string_message) return FALSE;
4369 r_num = expanded_string_integer(rightarg, FALSE);
4370 if (expand_string_message) return FALSE;
4374 case ECOND_NUM_G: return l_num > r_num;
4375 case ECOND_NUM_GE: return l_num >= r_num;
4376 case ECOND_NUM_L: return l_num < r_num;
4377 case ECOND_NUM_LE: return l_num <= r_num;
4384 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4385 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4386 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4387 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4388 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4389 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4390 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4391 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4394 return FALSE; /* should not happen */
4398 /* Expand a named list. Return false on failure. */
4400 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4402 tree_node *t = NULL;
4403 const uschar * list;
4406 BOOL needsep = FALSE;
4407 #define LISTNAMED_BUF_SIZE 256
4408 uschar b[LISTNAMED_BUF_SIZE];
4409 uschar * buffer = b;
4411 if (*name == '+') name++;
4412 if (!listtype) /* no-argument version */
4414 if ( !(t = tree_search(addresslist_anchor, name))
4415 && !(t = tree_search(domainlist_anchor, name))
4416 && !(t = tree_search(hostlist_anchor, name)))
4417 t = tree_search(localpartlist_anchor, name);
4419 else switch(*listtype) /* specific list-type version */
4421 case 'a': t = tree_search(addresslist_anchor, name); break;
4422 case 'd': t = tree_search(domainlist_anchor, name); break;
4423 case 'h': t = tree_search(hostlist_anchor, name); break;
4424 case 'l': t = tree_search(localpartlist_anchor, name); break;
4426 expand_string_message = US"bad suffix on \"list\" operator";
4432 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4434 : *listtype=='a'?"address "
4435 : *listtype=='d'?"domain "
4436 : *listtype=='h'?"host "
4437 : *listtype=='l'?"localpart "
4442 list = ((namedlist_block *)(t->data.ptr))->string;
4444 /* The list could be quite long so we (re)use a buffer for each element
4445 rather than getting each in new memory */
4447 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, GET_TAINTED);
4448 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4450 uschar * buf = US" : ";
4452 yield = string_catn(yield, buf, 3);
4456 if (*item == '+') /* list item is itself a named list */
4458 yield = expand_listnamed(yield, item, listtype);
4459 if (expand_string_message)
4463 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
4466 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4468 for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4470 yield = string_catn(yield, item, cp - CS item);
4471 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4472 yield = string_catn(yield, US"::", 2);
4473 else /* sep in item; should already be doubled; emit once */
4475 yield = string_catn(yield, US tok, 1);
4476 if (*cp == sep) cp++;
4479 yield = string_cat(yield, item);
4482 yield = string_cat(yield, item);
4489 /************************************************/
4491 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4495 debug_printf_indent("|");
4497 debug_printf_indent(UTF8_VERT_RIGHT);
4499 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4503 debug_printf(UTF8_HORIZ);
4505 debug_printf("%s: %.*s\n", what, nchar, value);
4506 if (is_tainted(value))
4509 debug_printf_indent("%s \\__", skipping ? "| " : " ");
4511 debug_printf_indent("%s",
4513 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
4514 debug_printf("(tainted)\n");
4519 /*************************************************
4521 *************************************************/
4523 /* Returns either an unchanged string, or the expanded string in stacking pool
4524 store. Interpreted sequences are:
4526 \... normal escaping rules
4527 $name substitutes the variable
4529 ${op:string} operates on the expanded string value
4530 ${item{arg1}{arg2}...} expands the args and then does the business
4531 some literal args are not enclosed in {}
4533 There are now far too many operators and item types to make it worth listing
4534 them here in detail any more.
4536 We use an internal routine recursively to handle embedded substrings. The
4537 external function follows. The yield is NULL if the expansion failed, and there
4538 are two cases: if something collapsed syntactically, or if "fail" was given
4539 as the action on a lookup failure. These can be distinguished by looking at the
4540 variable expand_string_forcedfail, which is TRUE in the latter case.
4542 The skipping flag is set true when expanding a substring that isn't actually
4543 going to be used (after "if" or "lookup") and it prevents lookups from
4544 happening lower down.
4546 Store usage: At start, a store block of the length of the input plus 64
4547 is obtained. This is expanded as necessary by string_cat(), which might have to
4548 get a new block, or might be able to expand the original. At the end of the
4549 function we can release any store above that portion of the yield block that
4550 was actually used. In many cases this will be optimal.
4552 However: if the first item in the expansion is a variable name or header name,
4553 we reset the store before processing it; if the result is in fresh store, we
4554 use that without copying. This is helpful for expanding strings like
4555 $message_headers which can get very long.
4557 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4558 since resetting the store at the end of the expansion will free store that was
4559 allocated by the plugin code as well as the slop after the expanded string. So
4560 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4561 and, given the acl condition, ${if }. This is an unfortunate consequence of
4562 string expansion becoming too powerful.
4565 string the string to be expanded
4567 brace_ends expansion is to stop at }
4568 honour_dollar TRUE if $ is to be expanded,
4569 FALSE if it's just another character
4570 skipping TRUE for recursive calls when the value isn't actually going
4571 to be used (to allow for optimisation)
4572 left if not NULL, a pointer to the first character after the
4573 expansion is placed here (typically used with brace_ends)
4574 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4576 textonly_p if not NULL, pointer to flag - write bool for only-met-text
4578 Returns: NULL if expansion fails:
4579 expand_string_forcedfail is set TRUE if failure was forced
4580 expand_string_message contains a textual error message
4581 a pointer to the expanded string on success
4585 expand_string_internal(const uschar * string, esi_flags flags, const uschar ** left,
4586 BOOL *resetok_p, BOOL * textonly_p)
4588 rmark reset_point = store_mark();
4589 gstring * yield = string_get(Ustrlen(string) + 64);
4591 const uschar * s = string;
4592 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4593 int save_expand_nlength[EXPAND_MAXN+1];
4594 BOOL resetok = TRUE, first = TRUE, textonly = TRUE;
4597 f.expand_string_forcedfail = FALSE;
4598 expand_string_message = US"";
4600 if (is_tainted(string))
4602 expand_string_message =
4603 string_sprintf("attempt to expand tainted string '%s'", s);
4604 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4615 debug_printf_indent("%c%s: %s\n",
4617 flags & ESI_SKIPPING ? "---scanning" : "considering", s);
4619 debug_printf_indent("%s%s: %s\n",
4620 first ? UTF8_DOWN_RIGHT : UTF8_VERT_RIGHT,
4621 flags & ESI_SKIPPING
4622 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4628 /* \ escapes the next character, which must exist, or else
4629 the expansion fails. There's a special escape, \N, which causes
4630 copying of the subject verbatim up to the next \N. Otherwise,
4631 the escapes are the standard set. */
4637 expand_string_message = US"\\ at end of string";
4643 const uschar * t = s + 2;
4644 for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4647 debug_expansion_interim(US"protected", t, (int)(s - t), !!(flags & ESI_SKIPPING));
4648 yield = string_catn(yield, t, s - t);
4656 debug_printf_indent("|backslashed: '\\%c'\n", s[1]);
4658 debug_printf_indent(UTF8_VERT_RIGHT "backslashed: '\\%c'\n", s[1]);
4659 ch[0] = string_interpret_escape(&s);
4661 yield = string_catn(yield, ch, 1);
4667 /* Anything other than $ is just copied verbatim, unless we are
4668 looking for a terminating } character. */
4670 if (flags & ESI_BRACE_ENDS && *s == '}') break;
4672 if (*s != '$' || !(flags & ESI_HONOR_DOLLAR))
4675 for (const uschar * t = s+1;
4676 *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4678 DEBUG(D_expand) debug_expansion_interim(US"text", s, i, !!(flags & ESI_SKIPPING));
4680 yield = string_catn(yield, s, i);
4686 /* No { after the $ - must be a plain name or a number for string
4687 match variable. There has to be a fudge for variables that are the
4688 names of header fields preceded by "$header_" because header field
4689 names can contain any printing characters except space and colon.
4690 For those that don't like typing this much, "$h_" is a synonym for
4691 "$header_". A non-existent header yields a NULL value; nothing is
4696 const uschar * value;
4697 int newsize = 0, len;
4701 s = read_name(name, sizeof(name), s, US"_");
4703 /* If this is the first thing to be expanded, release the pre-allocated
4707 g = store_get(sizeof(gstring), GET_UNTAINTED);
4708 else if (yield->ptr == 0)
4710 if (resetok) reset_point = store_reset(reset_point);
4712 reset_point = store_mark();
4713 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
4718 if ( ( *(t = name) == 'h'
4719 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4721 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4724 unsigned flags = *name == 'r' ? FH_WANT_RAW
4725 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4727 const uschar * charset = *name == 'b' ? NULL : headers_charset;
4729 s = read_header_name(name, sizeof(name), s);
4730 value = find_header(name, &newsize, flags, charset);
4732 /* If we didn't find the header, and the header contains a closing brace
4733 character, this may be a user error where the terminating colon
4734 has been omitted. Set a flag to adjust the error message in this case.
4735 But there is no error here - nothing gets inserted. */
4739 if (Ustrchr(name, '}')) malformed_header = TRUE;
4746 else if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
4748 expand_string_message =
4749 string_sprintf("unknown variable name \"%s\"", name);
4750 check_variable_error_message(name);
4754 /* If the data is known to be in a new buffer, newsize will be set to the
4755 size of that buffer. If this is the first thing in an expansion string,
4756 yield will be NULL; just point it at the new store instead of copying. Many
4757 expansion strings contain just one reference, so this is a useful
4758 optimization, especially for humungous headers. We need to use a gstring
4759 structure that is not allocated after that new-buffer, else a later store
4760 reset in the middle of the buffer will make it inaccessible. */
4762 len = Ustrlen(value);
4763 DEBUG(D_expand) debug_expansion_interim(US"value", value, len, !!(flags & ESI_SKIPPING));
4764 if (!yield && newsize != 0)
4767 yield->size = newsize;
4769 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4772 yield = string_catn(yield, value, len);
4777 if (isdigit(*s)) /* A $<n> variable */
4780 s = read_cnumber(&n, s);
4781 if (n >= 0 && n <= expand_nmax)
4783 DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], !!(flags & ESI_SKIPPING));
4784 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4789 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4791 if (*s != '{') /*}*/
4793 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4797 /* After { there can be various things, but they all start with
4798 an initial word, except for a number for a string match variable. */ /*}*/
4803 s = read_cnumber(&n, s); /*{{*/
4806 expand_string_message = US"} expected after number";
4809 if (n >= 0 && n <= expand_nmax)
4811 DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], !!(flags & ESI_SKIPPING));
4812 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4819 expand_string_message = US"letter or digit expected after ${"; /*}*/
4823 /* Allow "-" in names to cater for substrings with negative
4824 arguments. Since we are checking for known names after { this is
4827 s = read_name(name, sizeof(name), s, US"_-");
4828 item_type = chop_match(name, item_table, nelem(item_table));
4830 /* Switch on item type. All nondefault choices should "continue* when
4831 skipping, but "break" otherwise so we get debug output for the item
4834 int expansion_start = gstring_length(yield);
4837 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4838 If the ACL returns accept or reject we return content set by "message ="
4839 There is currently no limit on recursion; this would have us call
4840 acl_check_internal() directly and get a current level from somewhere.
4841 See also the acl expansion condition ECOND_ACL and the traditional
4842 acl modifier ACLC_ACL.
4843 Assume that the function has side-effects on the store that must be preserved.
4847 /* ${acl {name} {arg1}{arg2}...} */
4849 uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4853 switch(read_subs(sub, nelem(sub), 1, &s, flags, TRUE, name, &resetok, NULL))
4855 case -1: continue; /* skipping */
4856 case 1: goto EXPAND_FAILED_CURLY;
4858 case 3: goto EXPAND_FAILED;
4862 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4867 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4869 yield = string_cat(yield, user_msg);
4873 f.expand_string_forcedfail = TRUE;
4876 expand_string_message = string_sprintf("%s from acl \"%s\"",
4877 rc_names[rc], sub[0]);
4883 case EITEM_AUTHRESULTS:
4884 /* ${authresults {mysystemname}} */
4886 uschar * sub_arg[1];
4888 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4890 case -1: continue; /* If skipping, we don't actually do anything */
4891 case 1: goto EXPAND_FAILED_CURLY;
4893 case 3: goto EXPAND_FAILED;
4896 yield = string_append(yield, 3,
4897 US"Authentication-Results: ", sub_arg[0], US"; none");
4898 yield->ptr -= 6; /* ignore tha ": none" for now */
4900 yield = authres_local(yield, sub_arg[0]);
4901 yield = authres_iprev(yield);
4902 yield = authres_smtpauth(yield);
4904 yield = authres_spf(yield);
4906 #ifndef DISABLE_DKIM
4907 yield = authres_dkim(yield);
4909 #ifdef SUPPORT_DMARC
4910 yield = authres_dmarc(yield);
4912 #ifdef EXPERIMENTAL_ARC
4913 yield = authres_arc(yield);
4918 /* Handle conditionals - preserve the values of the numerical expansion
4919 variables in case they get changed by a regular expression match in the
4920 condition. If not, they retain their external settings. At the end
4921 of this "if" section, they get restored to their previous values. */
4926 const uschar *next_s;
4927 int save_expand_nmax =
4928 save_expand_strings(save_expand_nstring, save_expand_nlength);
4929 uschar * save_lookup_value = lookup_value;
4931 Uskip_whitespace(&s);
4932 if (!(next_s = eval_condition(s, &resetok, flags & ESI_SKIPPING ? NULL : &cond)))
4933 goto EXPAND_FAILED; /* message already set */
4937 debug_expansion_interim(US"condition", s, (int)(next_s - s), !!(flags & ESI_SKIPPING));
4938 debug_expansion_interim(US"result",
4939 cond ? US"true" : US"false", cond ? 4 : 5, !!(flags & ESI_SKIPPING));
4944 /* The handling of "yes" and "no" result strings is now in a separate
4945 function that is also used by ${lookup} and ${extract} and ${run}. */
4947 switch(process_yesno(
4948 flags, /* were previously skipping */
4949 cond, /* success/failure indicator */
4950 lookup_value, /* value to reset for string2 */
4951 &s, /* input pointer */
4952 &yield, /* output pointer */
4953 US"if", /* condition type */
4956 case 1: goto EXPAND_FAILED; /* when all is well, the */
4957 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4960 /* Restore external setting of expansion variables for continuation
4963 lookup_value = save_lookup_value;
4964 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4965 save_expand_nlength);
4970 case EITEM_IMAPFOLDER:
4971 { /* ${imapfolder {name}{sep}{specials}} */
4975 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4977 case 1: goto EXPAND_FAILED_CURLY;
4979 case 3: goto EXPAND_FAILED;
4982 if (!sub_arg[1]) /* One argument */
4984 sub_arg[1] = US"/"; /* default separator */
4987 else if (Ustrlen(sub_arg[1]) != 1)
4989 expand_string_message =
4991 "IMAP folder separator must be one character, found \"%s\"",
4996 if (flags & ESI_SKIPPING) continue;
4998 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4999 sub_arg[1][0], sub_arg[2], &expand_string_message)))
5001 yield = string_cat(yield, encoded);
5006 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
5007 expanding an internal string that isn't actually going to be used. All we
5008 need to do is check the syntax, so don't do a lookup at all. Preserve the
5009 values of the numerical expansion variables in case they get changed by a
5010 partial lookup. If not, they retain their external settings. At the end
5011 of this "lookup" section, they get restored to their previous values. */
5015 int stype, partial, affixlen, starflags;
5016 int expand_setup = 0;
5018 uschar * key, * filename;
5019 const uschar * affix, * opts;
5020 uschar * save_lookup_value = lookup_value;
5021 int save_expand_nmax =
5022 save_expand_strings(save_expand_nstring, save_expand_nlength);
5024 if (expand_forbid & RDO_LOOKUP)
5026 expand_string_message = US"lookup expansions are not permitted";
5030 /* Get the key we are to look up for single-key+file style lookups.
5031 Otherwise set the key NULL pro-tem. */
5033 if (Uskip_whitespace(&s) == '{') /*}*/
5035 key = expand_string_internal(s+1,
5036 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
5037 if (!key) goto EXPAND_FAILED; /*{{*/
5040 expand_string_message = US"missing '}' after lookup key";
5041 goto EXPAND_FAILED_CURLY;
5043 Uskip_whitespace(&s);
5047 /* Find out the type of database */
5051 expand_string_message = US"missing lookup type";
5055 /* The type is a string that may contain special characters of various
5056 kinds. Allow everything except space or { to appear; the actual content
5057 is checked by search_findtype_partial. */ /*}*/
5059 while (*s && *s != '{' && !isspace(*s)) /*}*/
5061 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
5064 name[nameptr] = '\0';
5065 Uskip_whitespace(&s);
5067 /* Now check for the individual search type and any partial or default
5068 options. Only those types that are actually in the binary are valid. */
5070 if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
5071 &starflags, &opts)) < 0)
5073 expand_string_message = search_error_message;
5077 /* Check that a key was provided for those lookup types that need it,
5078 and was not supplied for those that use the query style. */
5080 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
5084 expand_string_message = string_sprintf("missing {key} for single-"
5085 "key \"%s\" lookup", name);
5091 expand_string_message = string_sprintf("a single key was given for "
5092 "lookup type \"%s\", which is not a single-key lookup type", name);
5096 /* Get the next string in brackets and expand it. It is the file name for
5097 single-key+file lookups, and the whole query otherwise. In the case of
5098 queries that also require a file name (e.g. sqlite), the file name comes
5103 expand_string_message = US"missing '{' for lookup file-or-query arg";
5104 goto EXPAND_FAILED_CURLY; /*}}*/
5106 if (!(filename = expand_string_internal(s+1,
5107 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5112 expand_string_message = US"missing '}' closing lookup file-or-query arg";
5113 goto EXPAND_FAILED_CURLY;
5115 Uskip_whitespace(&s);
5117 /* If this isn't a single-key+file lookup, re-arrange the variables
5118 to be appropriate for the search_ functions. For query-style lookups,
5119 there is just a "key", and no file name. For the special query-style +
5120 file types, the query (i.e. "key") starts with a file name. */
5123 key = search_args(stype, name, filename, &filename, opts);
5125 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5126 the entry was not found. Note that there is no search_close() function.
5127 Files are left open in case of re-use. At suitable places in higher logic,
5128 search_tidyup() is called to tidy all open files. This can save opening
5129 the same file several times. However, files may also get closed when
5130 others are opened, if too many are open at once. The rule is that a
5131 handle should not be used after a second search_open().
5133 Request that a partial search sets up $1 and maybe $2 by passing
5134 expand_setup containing zero. If its value changes, reset expand_nmax,
5135 since new variables will have been set. Note that at the end of this
5136 "lookup" section, the old numeric variables are restored. */
5138 if (flags & ESI_SKIPPING)
5139 lookup_value = NULL;
5142 void * handle = search_open(filename, stype, 0, NULL, NULL);
5145 expand_string_message = search_error_message;
5148 lookup_value = search_find(handle, filename, key, partial, affix,
5149 affixlen, starflags, &expand_setup, opts);
5150 if (f.search_find_defer)
5152 expand_string_message =
5153 string_sprintf("lookup of \"%s\" gave DEFER: %s",
5154 string_printing2(key, SP_TAB), search_error_message);
5157 if (expand_setup > 0) expand_nmax = expand_setup;
5160 /* The handling of "yes" and "no" result strings is now in a separate
5161 function that is also used by ${if} and ${extract}. */
5163 switch(process_yesno(
5164 flags, /* were previously skipping */
5165 lookup_value != NULL, /* success/failure indicator */
5166 save_lookup_value, /* value to reset for string2 */
5167 &s, /* input pointer */
5168 &yield, /* output pointer */
5169 US"lookup", /* condition type */
5172 case 1: goto EXPAND_FAILED; /* when all is well, the */
5173 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5176 /* Restore external setting of expansion variables for carrying on
5177 at this level, and continue. */
5179 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5180 save_expand_nlength);
5182 if (flags & ESI_SKIPPING) continue;
5186 /* If Perl support is configured, handle calling embedded perl subroutines,
5187 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5188 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5189 arguments (defined below). */
5191 #define EXIM_PERL_MAX_ARGS 8
5195 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
5196 "is not included in this binary";
5199 #else /* EXIM_PERL */
5201 uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5202 gstring * new_yield;
5204 if (expand_forbid & RDO_PERL)
5206 expand_string_message = US"Perl calls are not permitted";
5210 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, flags, TRUE,
5211 name, &resetok, NULL))
5213 case -1: continue; /* If skipping, we don't actually do anything */
5214 case 1: goto EXPAND_FAILED_CURLY;
5216 case 3: goto EXPAND_FAILED;
5219 /* Start the interpreter if necessary */
5221 if (!opt_perl_started)
5224 if (!opt_perl_startup)
5226 expand_string_message = US"A setting of perl_startup is needed when "
5227 "using the Perl interpreter";
5230 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5231 if ((initerror = init_perl(opt_perl_startup)))
5233 expand_string_message =
5234 string_sprintf("error in perl_startup code: %s\n", initerror);
5237 opt_perl_started = TRUE;
5240 /* Call the function */
5242 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5243 new_yield = call_perl_cat(yield, &expand_string_message,
5244 sub_arg[0], sub_arg + 1);
5246 /* NULL yield indicates failure; if the message pointer has been set to
5247 NULL, the yield was undef, indicating a forced failure. Otherwise the
5248 message will indicate some kind of Perl error. */
5252 if (!expand_string_message)
5254 expand_string_message =
5255 string_sprintf("Perl subroutine \"%s\" returned undef to force "
5256 "failure", sub_arg[0]);
5257 f.expand_string_forcedfail = TRUE;
5262 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5263 set during a callback from Perl. */
5265 f.expand_string_forcedfail = FALSE;
5269 #endif /* EXIM_PERL */
5271 /* Transform email address to "prvs" scheme to use
5272 as BATV-signed return path */
5276 uschar * sub_arg[3], * p, * domain;
5278 switch(read_subs(sub_arg, 3, 2, &s, flags, TRUE, name, &resetok, NULL))
5280 case -1: continue; /* If skipping, we don't actually do anything */
5281 case 1: goto EXPAND_FAILED_CURLY;
5283 case 3: goto EXPAND_FAILED;
5286 /* sub_arg[0] is the address */
5287 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
5288 || domain == sub_arg[0] || Ustrlen(domain) == 1)
5290 expand_string_message = US"prvs first argument must be a qualified email address";
5294 /* Calculate the hash. The third argument must be a single-digit
5295 key number, or unset. */
5298 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5300 expand_string_message = US"prvs third argument must be a single digit";
5304 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5307 expand_string_message = US"prvs hmac-sha1 conversion failed";
5311 /* Now separate the domain from the local part */
5314 yield = string_catn(yield, US"prvs=", 5);
5315 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5316 yield = string_catn(yield, prvs_daystamp(7), 3);
5317 yield = string_catn(yield, p, 6);
5318 yield = string_catn(yield, US"=", 1);
5319 yield = string_cat (yield, sub_arg[0]);
5320 yield = string_catn(yield, US"@", 1);
5321 yield = string_cat (yield, domain);
5326 /* Check a prvs-encoded address for validity */
5328 case EITEM_PRVSCHECK:
5330 uschar * sub_arg[3], * p;
5332 const pcre2_code * re;
5334 /* Reset expansion variables */
5335 prvscheck_result = NULL;
5336 prvscheck_address = NULL;
5337 prvscheck_keynum = NULL;
5339 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5341 case 1: goto EXPAND_FAILED_CURLY;
5343 case 3: goto EXPAND_FAILED;
5346 re = regex_must_compile(
5347 US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5348 MCS_CASELESS | MCS_CACHEABLE, FALSE);
5350 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5352 uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5353 uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5354 uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5355 uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5356 uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5360 debug_printf_indent("prvscheck localpart: %s\n", local_part);
5361 debug_printf_indent("prvscheck key number: %s\n", key_num);
5362 debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5363 debug_printf_indent("prvscheck hash: %s\n", hash);
5364 debug_printf_indent("prvscheck domain: %s\n", domain);
5367 /* Set up expansion variables */
5368 g = string_cat (NULL, local_part);
5369 g = string_catn(g, US"@", 1);
5370 g = string_cat (g, domain);
5371 prvscheck_address = string_from_gstring(g);
5372 prvscheck_keynum = string_copy(key_num);
5374 /* Now expand the second argument */
5375 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5377 case 1: goto EXPAND_FAILED_CURLY;
5379 case 3: goto EXPAND_FAILED;
5382 /* Now we have the key and can check the address. */
5384 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5388 expand_string_message = US"hmac-sha1 conversion failed";
5392 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5393 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
5395 if (Ustrcmp(p,hash) == 0)
5397 /* Success, valid BATV address. Now check the expiry date. */
5398 uschar *now = prvs_daystamp(0);
5399 unsigned int inow = 0,iexpire = 1;
5401 (void)sscanf(CS now,"%u",&inow);
5402 (void)sscanf(CS daystamp,"%u",&iexpire);
5404 /* When "iexpire" is < 7, a "flip" has occurred.
5405 Adjust "inow" accordingly. */
5406 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5408 if (iexpire >= inow)
5410 prvscheck_result = US"1";
5411 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $prvscheck_result set to 1\n");
5415 prvscheck_result = NULL;
5416 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $prvscheck_result unset\n");
5421 prvscheck_result = NULL;
5422 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $prvscheck_result unset\n");
5425 /* Now expand the final argument. We leave this till now so that
5426 it can include $prvscheck_result. */
5428 switch(read_subs(sub_arg, 1, 0, &s, flags, TRUE, name, &resetok, NULL))
5430 case 1: goto EXPAND_FAILED_CURLY;
5432 case 3: goto EXPAND_FAILED;
5435 yield = string_cat(yield,
5436 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5438 /* Reset the "internal" variables afterwards, because they are in
5439 dynamic store that will be reclaimed if the expansion succeeded. */
5441 prvscheck_address = NULL;
5442 prvscheck_keynum = NULL;
5445 /* Does not look like a prvs encoded address, return the empty string.
5446 We need to make sure all subs are expanded first, so as to skip over
5449 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5451 case 1: goto EXPAND_FAILED_CURLY;
5453 case 3: goto EXPAND_FAILED;
5456 if (flags & ESI_SKIPPING) continue;
5460 /* Handle "readfile" to insert an entire file */
5462 case EITEM_READFILE:
5465 uschar * sub_arg[2];
5467 if ((expand_forbid & RDO_READFILE) != 0)
5469 expand_string_message = US"file insertions are not permitted";
5473 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5475 case -1: continue; /* If skipping, we don't actually do anything */
5476 case 1: goto EXPAND_FAILED_CURLY;
5478 case 3: goto EXPAND_FAILED;
5481 /* Open the file and read it */
5483 if (!(f = Ufopen(sub_arg[0], "rb")))
5485 expand_string_message = string_open_failed("%s", sub_arg[0]);
5489 yield = cat_file(f, yield, sub_arg[1]);
5494 /* Handle "readsocket" to insert data from a socket, either
5495 Inet or Unix domain */
5497 case EITEM_READSOCK:
5500 uschar * sub_arg[4];
5502 if (expand_forbid & RDO_READSOCK)
5504 expand_string_message = US"socket insertions are not permitted";
5508 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5509 because there may be a string for expansion on failure. */
5511 switch(read_subs(sub_arg, 4, 2, &s, flags, FALSE, name, &resetok, NULL))
5513 case 1: goto EXPAND_FAILED_CURLY;
5514 case 2: /* Won't occur: no end check */
5515 case 3: goto EXPAND_FAILED;
5518 /* If skipping, we don't actually do anything. Otherwise, arrange to
5519 connect to either an IP or a Unix socket. */
5521 if (!(flags & ESI_SKIPPING))
5523 int stype = search_findtype(US"readsock", 8);
5526 int expand_setup = -1;
5529 /* If the reqstr is empty, flag that and set a dummy */
5533 g = string_append_listele(g, ',', US"send=no");
5534 sub_arg[1] = US"DUMMY";
5537 /* Re-marshall the options */
5541 const uschar * list = sub_arg[2];
5545 /* First option has no tag and is timeout */
5546 if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5547 g = string_append_listele(g, ',',
5548 string_sprintf("timeout=%s", item));
5550 /* The rest of the options from the expansion */
5551 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5552 g = string_append_listele(g, ',', item);
5554 /* possibly plus an EOL string. Process with escapes, to protect
5555 from list-processing. The only current user of eol= in search
5556 options is the readsock expansion. */
5558 if (sub_arg[3] && *sub_arg[3])
5559 g = string_append_listele(g, ',',
5560 string_sprintf("eol=%s",
5561 string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5564 /* Gat a (possibly cached) handle for the connection */
5566 if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5568 if (*expand_string_message) goto EXPAND_FAILED;
5569 expand_string_message = search_error_message;
5570 search_error_message = NULL;
5574 /* Get (possibly cached) results for the lookup */
5575 /* sspec: sub_arg[0] req: sub_arg[1] opts: g */
5577 if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5578 &expand_setup, string_from_gstring(g))))
5579 yield = string_cat(yield, s);
5580 else if (f.search_find_defer)
5582 expand_string_message = search_error_message;
5583 search_error_message = NULL;
5587 { /* should not happen, at present */
5588 expand_string_message = search_error_message;
5589 search_error_message = NULL;
5594 /* The whole thing has worked (or we were skipping). If there is a
5595 failure string following, we need to skip it. */
5597 if (*s == '{') /*}*/
5599 if (!expand_string_internal(s+1,
5600 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL))
5601 goto EXPAND_FAILED; /*{*/
5604 expand_string_message = US"missing '}' closing failstring for readsocket";
5605 goto EXPAND_FAILED_CURLY;
5607 Uskip_whitespace(&s);
5610 READSOCK_DONE: /*{*/
5613 expand_string_message = US"missing '}' closing readsocket";
5614 goto EXPAND_FAILED_CURLY;
5616 if (flags & ESI_SKIPPING) continue;
5619 /* Come here on failure to create socket, connect socket, write to the
5620 socket, or timeout on reading. If another substring follows, expand and
5621 use it. Otherwise, those conditions give expand errors. */
5624 if (*s != '{') goto EXPAND_FAILED; /*}*/
5625 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5626 if (!(arg = expand_string_internal(s+1,
5627 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR, &s, &resetok, NULL)))
5629 yield = string_cat(yield, arg); /*{*/
5632 expand_string_message = US"missing '}' closing failstring for readsocket";
5633 goto EXPAND_FAILED_CURLY;
5635 Uskip_whitespace(&s);
5639 /* Handle "run" to execute a program. */
5644 const uschar * arg, ** argv;
5645 unsigned late_expand = TSUC_EXPAND_ARGS | TSUC_ALLOW_TAINTED_ARGS | TSUC_ALLOW_RECIPIENTS;
5647 if (expand_forbid & RDO_RUN)
5649 expand_string_message = US"running a command is not permitted";
5653 /* Handle options to the "run" */
5656 if (Ustrncmp(++s, "preexpand", 9) == 0)
5657 { late_expand = 0; s += 9; }
5660 const uschar * t = s;
5661 while (isalpha(*++t)) ;
5662 expand_string_message = string_sprintf("bad option '%.*s' for run",
5666 Uskip_whitespace(&s);
5668 if (*s != '{') /*}*/
5670 expand_string_message = US"missing '{' for command arg of run";
5671 goto EXPAND_FAILED_CURLY; /*"}*/
5675 if (late_expand) /* this is the default case */
5679 /* Locate the end of the args */
5680 (void) expand_string_internal(s,
5681 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &t, NULL, NULL);
5683 arg = flags & ESI_SKIPPING ? NULL : string_copyn(s, n);
5689 debug_printf_indent("args string for ${run} expand before split\n");
5690 if (!(arg = expand_string_internal(s,
5691 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5693 Uskip_whitespace(&s);
5698 expand_string_message = US"missing '}' closing command arg of run";
5699 goto EXPAND_FAILED_CURLY;
5702 if (flags & ESI_SKIPPING) /* Just pretend it worked when we're skipping */
5705 lookup_value = NULL;
5712 if (!transport_set_up_command(&argv, /* anchor for arg list */
5713 arg, /* raw command */
5714 late_expand, /* expand args if not already done */
5715 0, /* not relevant when... */
5716 NULL, /* no transporting address */
5717 US"${run} expansion", /* for error messages */
5718 &expand_string_message)) /* where to put error message */
5721 /* Create the child process, making it a group leader. */
5723 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5724 US"expand-run")) < 0)
5726 expand_string_message =
5727 string_sprintf("couldn't create child process: %s", strerror(errno));
5731 /* Nothing is written to the standard input. */
5735 /* Read the pipe to get the command's output into $value (which is kept
5736 in lookup_value). Read during execution, so that if the output exceeds
5737 the OS pipe buffer limit, we don't block forever. Remember to not release
5738 memory just allocated for $value. */
5741 f = fdopen(fd_out, "rb");
5742 sigalrm_seen = FALSE;
5744 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5748 /* Wait for the process to finish, applying the timeout, and inspect its
5749 return code for serious disasters. Simple non-zero returns are passed on.
5752 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5754 if (sigalrm_seen || runrc == -256)
5756 expand_string_message = US"command timed out";
5757 killpg(pid, SIGKILL); /* Kill the whole process group */
5760 else if (runrc == -257)
5761 expand_string_message = string_sprintf("wait() failed: %s",
5765 expand_string_message = string_sprintf("command killed by signal %d",
5772 /* Process the yes/no strings; $value may be useful in both cases */
5774 switch(process_yesno(
5775 flags, /* were previously skipping */
5776 runrc == 0, /* success/failure indicator */
5777 lookup_value, /* value to reset for string2 */
5778 &s, /* input pointer */
5779 &yield, /* output pointer */
5780 US"run", /* condition type */
5783 case 1: goto EXPAND_FAILED; /* when all is well, the */
5784 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5787 if (flags & ESI_SKIPPING) continue;
5791 /* Handle character translation for "tr" */
5795 int oldptr = gstring_length(yield);
5799 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5801 case -1: continue; /* skipping */
5802 case 1: goto EXPAND_FAILED_CURLY;
5804 case 3: goto EXPAND_FAILED;
5807 if ( (yield = string_cat(yield, sub[0]))
5808 && (o2m = Ustrlen(sub[2]) - 1) >= 0)
5809 for (; oldptr < yield->ptr; oldptr++)
5811 uschar * m = Ustrrchr(sub[1], yield->s[oldptr]);
5815 yield->s[oldptr] = sub[2][o < o2m ? o : o2m];
5822 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5823 expanded arguments. */
5832 int val[2] = { 0, -1 };
5835 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5836 Ensure that sub[2] is set in the ${length } case. */
5839 switch(read_subs(sub, item_type == EITEM_LENGTH ? 2:3, 2, &s, flags,
5840 TRUE, name, &resetok, NULL))
5842 case -1: continue; /* skipping */
5843 case 1: goto EXPAND_FAILED_CURLY;
5845 case 3: goto EXPAND_FAILED;
5848 /* Juggle the arguments if there are only two of them: always move the
5849 string to the last position and make ${length{n}{str}} equivalent to
5850 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5856 if (item_type == EITEM_LENGTH)
5863 for (int i = 0; i < 2; i++) if (sub[i])
5865 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5866 if (*ret != 0 || (i != 0 && val[i] < 0))
5868 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5869 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5875 item_type == EITEM_HASH
5876 ? compute_hash(sub[2], val[0], val[1], &len)
5877 : item_type == EITEM_NHASH
5878 ? compute_nhash(sub[2], val[0], val[1], &len)
5879 : extract_substr(sub[2], val[0], val[1], &len);
5882 yield = string_catn(yield, ret, len);
5886 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5887 This code originally contributed by Steve Haslam. It currently supports
5888 the use of MD5 and SHA-1 hashes.
5890 We need some workspace that is large enough to handle all the supported
5891 hash types. Use macros to set the sizes rather than be too elaborate. */
5893 #define MAX_HASHLEN 20
5894 #define MAX_HASHBLOCKLEN 64
5903 int hashlen; /* Number of octets for the hash algorithm's output */
5904 int hashblocklen; /* Number of octets the hash algorithm processes */
5905 uschar * keyptr, * p;
5906 unsigned int keylen;
5908 uschar keyhash[MAX_HASHLEN];
5909 uschar innerhash[MAX_HASHLEN];
5910 uschar finalhash[MAX_HASHLEN];
5911 uschar finalhash_hex[2*MAX_HASHLEN];
5912 uschar innerkey[MAX_HASHBLOCKLEN];
5913 uschar outerkey[MAX_HASHBLOCKLEN];
5915 switch (read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5917 case -1: continue; /* skipping */
5918 case 1: goto EXPAND_FAILED_CURLY;
5920 case 3: goto EXPAND_FAILED;
5923 if (Ustrcmp(sub[0], "md5") == 0)
5926 use_base = &md5_base;
5930 else if (Ustrcmp(sub[0], "sha1") == 0)
5933 use_base = &sha1_ctx;
5939 expand_string_message =
5940 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5945 keylen = Ustrlen(keyptr);
5947 /* If the key is longer than the hash block length, then hash the key
5950 if (keylen > hashblocklen)
5952 chash_start(type, use_base);
5953 chash_end(type, use_base, keyptr, keylen, keyhash);
5958 /* Now make the inner and outer key values */
5960 memset(innerkey, 0x36, hashblocklen);
5961 memset(outerkey, 0x5c, hashblocklen);
5963 for (int i = 0; i < keylen; i++)
5965 innerkey[i] ^= keyptr[i];
5966 outerkey[i] ^= keyptr[i];
5969 /* Now do the hashes */
5971 chash_start(type, use_base);
5972 chash_mid(type, use_base, innerkey);
5973 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5975 chash_start(type, use_base);
5976 chash_mid(type, use_base, outerkey);
5977 chash_end(type, use_base, innerhash, hashlen, finalhash);
5979 /* Encode the final hash as a hex string */
5982 for (int i = 0; i < hashlen; i++)
5984 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5985 *p++ = hex_digits[finalhash[i] & 0x0f];
5988 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5989 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5991 yield = string_catn(yield, finalhash_hex, hashlen*2);
5995 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5996 We have to save the numerical variables and restore them afterwards. */
6000 const pcre2_code * re;
6001 int moffset, moffsetextra, slen;
6002 pcre2_match_data * md;
6004 uschar * subject, * sub[3];
6005 int save_expand_nmax =
6006 save_expand_strings(save_expand_nstring, save_expand_nlength);
6007 unsigned sub_textonly = 0;
6009 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, &sub_textonly))
6011 case -1: continue; /* skipping */
6012 case 1: goto EXPAND_FAILED_CURLY;
6014 case 3: goto EXPAND_FAILED;
6017 /* Compile the regular expression */
6019 re = regex_compile(sub[1],
6020 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
6021 &expand_string_message, pcre_gen_cmp_ctx);
6025 md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
6027 /* Now run a loop to do the substitutions as often as necessary. It ends
6028 when there are no more matches. Take care over matches of the null string;
6029 do the same thing as Perl does. */
6032 slen = Ustrlen(sub[0]);
6033 moffset = moffsetextra = 0;
6038 PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
6039 int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
6040 PCRE_EOPT | emptyopt, md, pcre_gen_mtc_ctx);
6043 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
6044 is not necessarily the end. We want to repeat the match from one
6045 character further along, but leaving the basic offset the same (for
6046 copying below). We can't be at the end of the string - that was checked
6047 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
6048 finished; copy the remaining string and end the loop. */
6058 yield = string_catn(yield, subject+moffset, slen-moffset);
6062 /* Match - set up for expanding the replacement. */
6063 DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
6065 if (n == 0) n = EXPAND_MAXN + 1;
6067 for (int nn = 0; nn < n*2; nn += 2)
6069 expand_nstring[expand_nmax] = subject + ovec[nn];
6070 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
6074 /* Copy the characters before the match, plus the expanded insertion. */
6076 yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
6078 if (!(insert = expand_string(sub[2])))
6080 yield = string_cat(yield, insert);
6086 /* If we have matched an empty string, first check to see if we are at
6087 the end of the subject. If so, the loop is over. Otherwise, mimic
6088 what Perl's /g options does. This turns out to be rather cunning. First
6089 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
6090 string at the same point. If this fails (picked up above) we advance to
6091 the next character. */
6093 if (ovec[0] == ovec[1])
6095 if (ovec[0] == slen) break;
6096 emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
6100 /* All done - restore numerical variables. */
6102 /* pcre2_match_data_free(md); gen ctx needs no free */
6103 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6104 save_expand_nlength);
6108 /* Handle keyed and numbered substring extraction. If the first argument
6109 consists entirely of digits, then a numerical extraction is assumed. */
6113 int field_number = 1;
6114 BOOL field_number_set = FALSE;
6115 uschar * save_lookup_value = lookup_value, * sub[3];
6116 int save_expand_nmax =
6117 save_expand_strings(save_expand_nstring, save_expand_nlength);
6119 /* On reflection the original behaviour of extract-json for a string
6120 result, leaving it quoted, was a mistake. But it was already published,
6121 hence the addition of jsons. In a future major version, make json
6122 work like josons, and withdraw jsons. */
6124 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
6126 /* Check for a format-variant specifier */
6128 if (Uskip_whitespace(&s) != '{') /*}*/
6129 if (Ustrncmp(s, "json", 4) == 0)
6130 if (*(s += 4) == 's')
6131 {fmt = extract_jsons; s++;}
6135 /* While skipping we cannot rely on the data for expansions being
6136 available (eg. $item) hence cannot decide on numeric vs. keyed.
6137 Read a maximum of 5 arguments (including the yes/no) */
6139 if (flags & ESI_SKIPPING)
6141 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
6143 if (!expand_string_internal(s+1,
6144 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL))
6145 goto EXPAND_FAILED; /*'{'*/
6148 expand_string_message = US"missing '{' for arg of extract";
6149 goto EXPAND_FAILED_CURLY;
6151 Uskip_whitespace(&s);
6153 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
6154 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
6158 Uskip_whitespace(&s);
6162 expand_string_message = US"missing '}' closing extract";
6163 goto EXPAND_FAILED_CURLY;
6167 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
6169 if (Uskip_whitespace(&s) == '{') /*'}'*/
6171 if (!(sub[i] = expand_string_internal(s+1,
6172 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6173 goto EXPAND_FAILED; /*'{'*/
6176 expand_string_message = string_sprintf(
6177 "missing '}' closing arg %d of extract", i+1);
6178 goto EXPAND_FAILED_CURLY;
6181 /* After removal of leading and trailing white space, the first
6182 argument must not be empty; if it consists entirely of digits
6183 (optionally preceded by a minus sign), this is a numerical
6184 extraction, and we expect 3 arguments (normal) or 2 (json). */
6190 uschar * p = sub[0];
6192 Uskip_whitespace(&p);
6196 while (len > 0 && isspace(p[len-1])) len--;
6201 expand_string_message = US"first argument of \"extract\" must "
6211 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6215 if (fmt == extract_basic) j = 3; /* Need 3 args */
6216 field_number_set = TRUE;
6222 expand_string_message = string_sprintf(
6223 "missing '{' for arg %d of extract", i+1);
6224 goto EXPAND_FAILED_CURLY;
6228 /* Extract either the numbered or the keyed substring into $value. If
6229 skipping, just pretend the extraction failed. */
6231 if (flags & ESI_SKIPPING)
6232 lookup_value = NULL;
6236 lookup_value = field_number_set
6237 ? expand_gettokened(field_number, sub[1], sub[2])
6238 : expand_getkeyed(sub[0], sub[1]);
6245 const uschar * list;
6247 /* Array: Bracket-enclosed and comma-separated.
6248 Object: Brace-enclosed, comma-sep list of name:value pairs */
6250 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6252 expand_string_message =
6253 string_sprintf("%s wrapping %s for extract json",
6254 expand_string_message,
6255 field_number_set ? "array" : "object");
6256 goto EXPAND_FAILED_CURLY;
6260 if (field_number_set)
6262 if (field_number <= 0)
6264 expand_string_message = US"first argument of \"extract\" must "
6265 "be greater than zero";
6268 while (field_number > 0 && (item = json_nextinlist(&list)))
6270 if ((lookup_value = s = item))
6273 while (--s >= lookup_value && isspace(*s)) *s = '\0';
6278 lookup_value = NULL;
6279 while ((item = json_nextinlist(&list)))
6281 /* Item is: string name-sep value. string is quoted.
6282 Dequote the string and compare with the search key. */
6284 if (!(item = dewrap(item, US"\"\"")))
6286 expand_string_message =
6287 string_sprintf("%s wrapping string key for extract json",
6288 expand_string_message);
6289 goto EXPAND_FAILED_CURLY;
6291 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
6293 s = item + Ustrlen(item) + 1;
6294 if (Uskip_whitespace(&s) != ':')
6296 expand_string_message =
6297 US"missing object value-separator for extract json";
6298 goto EXPAND_FAILED_CURLY;
6301 Uskip_whitespace(&s);
6309 if ( fmt == extract_jsons
6311 && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6313 expand_string_message =
6314 string_sprintf("%s wrapping string result for extract jsons",
6315 expand_string_message);
6316 goto EXPAND_FAILED_CURLY;
6321 /* If no string follows, $value gets substituted; otherwise there can
6322 be yes/no strings, as for lookup or if. */
6324 switch(process_yesno(
6325 flags, /* were previously skipping */
6326 lookup_value != NULL, /* success/failure indicator */
6327 save_lookup_value, /* value to reset for string2 */
6328 &s, /* input pointer */
6329 &yield, /* output pointer */
6330 US"extract", /* condition type */
6333 case 1: goto EXPAND_FAILED; /* when all is well, the */
6334 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6337 /* All done - restore numerical variables. */
6339 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6340 save_expand_nlength);
6342 if (flags & ESI_SKIPPING) continue;
6346 /* return the Nth item from a list */
6348 case EITEM_LISTEXTRACT:
6350 int field_number = 1;
6351 uschar * save_lookup_value = lookup_value, * sub[2];
6352 int save_expand_nmax =
6353 save_expand_strings(save_expand_nstring, save_expand_nlength);
6355 /* Read the field & list arguments */
6356 /*XXX Could we use read_subs here (and get better efficiency for skipping)? */
6358 for (int i = 0; i < 2; i++)
6360 if (Uskip_whitespace(&s) != '{') /*}*/
6362 expand_string_message = string_sprintf(
6363 "missing '{' for arg %d of listextract", i+1); /*}*/
6364 goto EXPAND_FAILED_CURLY;
6367 sub[i] = expand_string_internal(s+1,
6368 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6369 if (!sub[i]) goto EXPAND_FAILED; /*{{*/
6372 expand_string_message = string_sprintf(
6373 "missing '}' closing arg %d of listextract", i+1);
6374 goto EXPAND_FAILED_CURLY;
6377 /* After removal of leading and trailing white space, the first
6378 argument must be numeric and nonempty. */
6386 Uskip_whitespace(&p);
6390 while (len > 0 && isspace(p[len-1])) len--;
6393 if (!*p && !(flags & ESI_SKIPPING))
6395 expand_string_message = US"first argument of \"listextract\" must "
6405 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6408 expand_string_message = US"first argument of \"listextract\" must "
6416 /* Extract the numbered element into $value. If
6417 skipping, just pretend the extraction failed. */
6419 lookup_value = flags & ESI_SKIPPING ? NULL : expand_getlistele(field_number, sub[1]);
6421 /* If no string follows, $value gets substituted; otherwise there can
6422 be yes/no strings, as for lookup or if. */
6424 switch(process_yesno(
6425 flags, /* were previously skipping */
6426 lookup_value != NULL, /* success/failure indicator */
6427 save_lookup_value, /* value to reset for string2 */
6428 &s, /* input pointer */
6429 &yield, /* output pointer */
6430 US"listextract", /* condition type */
6433 case 1: goto EXPAND_FAILED; /* when all is well, the */
6434 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6437 /* All done - restore numerical variables. */
6439 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6440 save_expand_nlength);
6442 if (flags & ESI_SKIPPING) continue;
6446 case EITEM_LISTQUOTE:
6449 switch(read_subs(sub, 2, 2, &s, flags, TRUE, name, &resetok, NULL))
6451 case -1: continue; /* skipping */
6452 case 1: goto EXPAND_FAILED_CURLY;
6454 case 3: goto EXPAND_FAILED;
6456 if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6458 if (c == sep) yield = string_catn(yield, sub[1], 1);
6459 yield = string_catn(yield, sub[1], 1);
6461 else yield = string_catn(yield, US" ", 1);
6466 case EITEM_CERTEXTRACT:
6468 uschar * save_lookup_value = lookup_value, * sub[2];
6469 int save_expand_nmax =
6470 save_expand_strings(save_expand_nstring, save_expand_nlength);
6472 /* Read the field argument */
6473 if (Uskip_whitespace(&s) != '{') /*}*/
6475 expand_string_message = US"missing '{' for field arg of certextract";
6476 goto EXPAND_FAILED_CURLY; /*}*/
6478 sub[0] = expand_string_internal(s+1,
6479 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6480 if (!sub[0]) goto EXPAND_FAILED; /*{{*/
6483 expand_string_message = US"missing '}' closing field arg of certextract";
6484 goto EXPAND_FAILED_CURLY;
6486 /* strip spaces fore & aft */
6491 Uskip_whitespace(&p);
6495 while (len > 0 && isspace(p[len-1])) len--;
6499 /* inspect the cert argument */
6500 if (Uskip_whitespace(&s) != '{') /*}*/
6502 expand_string_message = US"missing '{' for cert variable arg of certextract";
6503 goto EXPAND_FAILED_CURLY; /*}*/
6507 expand_string_message = US"second argument of \"certextract\" must "
6508 "be a certificate variable";
6511 sub[1] = expand_string_internal(s+1,
6512 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6513 if (!sub[1]) goto EXPAND_FAILED; /*{{*/
6516 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6517 goto EXPAND_FAILED_CURLY;
6520 if (flags & ESI_SKIPPING)
6521 lookup_value = NULL;
6524 lookup_value = expand_getcertele(sub[0], sub[1]);
6525 if (*expand_string_message) goto EXPAND_FAILED;
6527 switch(process_yesno(
6528 flags, /* were previously skipping */
6529 lookup_value != NULL, /* success/failure indicator */
6530 save_lookup_value, /* value to reset for string2 */
6531 &s, /* input pointer */
6532 &yield, /* output pointer */
6533 US"certextract", /* condition type */
6536 case 1: goto EXPAND_FAILED; /* when all is well, the */
6537 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6540 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6541 save_expand_nlength);
6542 if (flags & ESI_SKIPPING) continue;
6545 #endif /*DISABLE_TLS*/
6547 /* Handle list operations */
6553 int sep = 0, save_ptr = gstring_length(yield);
6554 uschar outsep[2] = { '\0', '\0' };
6555 const uschar *list, *expr, *temp;
6556 uschar * save_iterate_item = iterate_item;
6557 uschar * save_lookup_value = lookup_value;
6559 Uskip_whitespace(&s);
6560 if (*s++ != '{') /*}*/
6562 expand_string_message =
6563 string_sprintf("missing '{' for first arg of %s", name);
6564 goto EXPAND_FAILED_CURLY; /*}*/
6567 DEBUG(D_expand) debug_printf_indent("%s: evaluate input list list\n", name);
6568 if (!(list = expand_string_internal(s,
6569 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6570 goto EXPAND_FAILED; /*{{*/
6573 expand_string_message =
6574 string_sprintf("missing '}' closing first arg of %s", name);
6575 goto EXPAND_FAILED_CURLY;
6578 if (item_type == EITEM_REDUCE)
6581 Uskip_whitespace(&s);
6582 if (*s++ != '{') /*}*/
6584 expand_string_message = US"missing '{' for second arg of reduce";
6585 goto EXPAND_FAILED_CURLY; /*}*/
6587 DEBUG(D_expand) debug_printf_indent("reduce: initial result list\n");
6588 t = expand_string_internal(s,
6589 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6590 if (!t) goto EXPAND_FAILED;
6591 lookup_value = t; /*{{*/
6594 expand_string_message = US"missing '}' closing second arg of reduce";
6595 goto EXPAND_FAILED_CURLY;
6599 Uskip_whitespace(&s);
6600 if (*s++ != '{') /*}*/
6602 expand_string_message =
6603 string_sprintf("missing '{' for last arg of %s", name); /*}*/
6604 goto EXPAND_FAILED_CURLY;
6609 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6610 if scanning a "false" part). This allows us to find the end of the
6611 condition, because if the list is empty, we won't actually evaluate the
6612 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6613 the normal internal expansion function. */
6615 DEBUG(D_expand) debug_printf_indent("%s: find end of conditionn\n", name);
6616 if (item_type != EITEM_FILTER)
6617 temp = expand_string_internal(s,
6618 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL);
6620 if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6624 expand_string_message = string_sprintf("%s inside \"%s\" item",
6625 expand_string_message, name);
6629 Uskip_whitespace(&s); /*{{{*/
6632 expand_string_message = string_sprintf("missing } at end of condition "
6633 "or expression inside \"%s\"; could be an unquoted } in the content",
6638 Uskip_whitespace(&s); /*{{*/
6641 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6646 /* If we are skipping, we can now just move on to the next item. When
6647 processing for real, we perform the iteration. */
6649 if (flags & ESI_SKIPPING) continue;
6650 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6652 *outsep = (uschar)sep; /* Separator as a string */
6654 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6655 name, iterate_item, lookup_value);
6657 if (item_type == EITEM_FILTER)
6660 /* the condition could modify $value, as a side-effect */
6661 uschar * save_value = lookup_value;
6663 if (!eval_condition(expr, &resetok, &condresult))
6665 iterate_item = save_iterate_item;
6666 lookup_value = save_lookup_value;
6667 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6668 expand_string_message, name);
6671 lookup_value = save_value;
6672 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6673 condresult? "true":"false");
6675 temp = iterate_item; /* TRUE => include this item */
6677 continue; /* FALSE => skip this item */
6680 else /* EITEM_MAP and EITEM_REDUCE */
6682 /* the expansion could modify $value, as a side-effect */
6683 uschar * t = expand_string_internal(expr,
6684 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, NULL, &resetok, NULL);
6687 iterate_item = save_iterate_item;
6688 expand_string_message = string_sprintf("%s inside \"%s\" item",
6689 expand_string_message, name);
6692 if (item_type == EITEM_REDUCE)
6694 lookup_value = t; /* Update the value of $value */
6695 continue; /* and continue the iteration */
6699 /* We reach here for FILTER if the condition is true, always for MAP,
6700 and never for REDUCE. The value in "temp" is to be added to the output
6701 list that is being created, ensuring that any occurrences of the
6702 separator character are doubled. Unless we are dealing with the first
6703 item of the output list, add in a space if the new item begins with the
6704 separator character, or is an empty string. */
6706 /*XXX is there not a standard support function for this, appending to a list? */
6707 /* yes, string_append_listele(), but it depends on lack of text before the list */
6709 if ( yield && yield->ptr != save_ptr
6710 && (temp[0] == *outsep || temp[0] == 0))
6711 yield = string_catn(yield, US" ", 1);
6713 /* Add the string in "temp" to the output list that we are building,
6714 This is done in chunks by searching for the separator character. */
6718 size_t seglen = Ustrcspn(temp, outsep);
6720 yield = string_catn(yield, temp, seglen + 1);
6722 /* If we got to the end of the string we output one character
6723 too many; backup and end the loop. Otherwise arrange to double the
6726 if (!temp[seglen]) { yield->ptr--; break; }
6727 yield = string_catn(yield, outsep, 1);
6731 /* Output a separator after the string: we will remove the redundant
6732 final one at the end. */
6734 yield = string_catn(yield, outsep, 1);
6735 } /* End of iteration over the list loop */
6737 /* REDUCE has generated no output above: output the final value of
6740 if (item_type == EITEM_REDUCE)
6742 yield = string_cat(yield, lookup_value);
6743 lookup_value = save_lookup_value; /* Restore $value */
6746 /* FILTER and MAP generate lists: if they have generated anything, remove
6747 the redundant final separator. Even though an empty item at the end of a
6748 list does not count, this is tidier. */
6750 else if (yield && yield->ptr != save_ptr) yield->ptr--;
6752 /* Restore preserved $item */
6754 iterate_item = save_iterate_item;
6755 if (flags & ESI_SKIPPING) continue;
6761 int sep = 0, cond_type;
6762 const uschar * srclist, * cmp, * xtract;
6763 uschar * opname, * srcitem;
6764 const uschar * dstlist = NULL, * dstkeylist = NULL;
6765 uschar * tmp, * save_iterate_item = iterate_item;
6767 Uskip_whitespace(&s);
6768 if (*s++ != '{') /*}*/
6770 expand_string_message = US"missing '{' for list arg of sort";
6771 goto EXPAND_FAILED_CURLY; /*}*/
6774 srclist = expand_string_internal(s,
6775 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6776 if (!srclist) goto EXPAND_FAILED; /*{{*/
6779 expand_string_message = US"missing '}' closing list arg of sort";
6780 goto EXPAND_FAILED_CURLY;
6783 Uskip_whitespace(&s);
6784 if (*s++ != '{') /*}*/
6786 expand_string_message = US"missing '{' for comparator arg of sort";
6787 goto EXPAND_FAILED_CURLY; /*}*/
6790 cmp = expand_string_internal(s,
6791 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6792 if (!cmp) goto EXPAND_FAILED; /*{{*/
6795 expand_string_message = US"missing '}' closing comparator arg of sort";
6796 goto EXPAND_FAILED_CURLY;
6799 if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6801 if (!expand_string_message)
6802 expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6807 case ECOND_NUM_L: case ECOND_NUM_LE:
6808 case ECOND_NUM_G: case ECOND_NUM_GE:
6809 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6810 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6814 expand_string_message = US"comparator not handled for sort";
6818 Uskip_whitespace(&s);
6819 if (*s++ != '{') /*}*/
6821 expand_string_message = US"missing '{' for extractor arg of sort";
6822 goto EXPAND_FAILED_CURLY; /*}*/
6826 if (!(tmp = expand_string_internal(s,
6827 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL)))
6829 xtract = string_copyn(xtract, s - xtract);
6833 expand_string_message = US"missing '}' closing extractor arg of sort";
6834 goto EXPAND_FAILED_CURLY;
6839 expand_string_message = US"missing } at end of \"sort\"";
6843 if (flags & ESI_SKIPPING) continue;
6845 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6847 uschar * srcfield, * dstitem;
6848 gstring * newlist = NULL, * newkeylist = NULL;
6850 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6852 /* extract field for comparisons */
6853 iterate_item = srcitem;
6854 if ( !(srcfield = expand_string_internal(xtract,
6855 ESI_HONOR_DOLLAR, NULL, &resetok, NULL))
6858 expand_string_message = string_sprintf(
6859 "field-extract in sort: \"%s\"", xtract);
6863 /* Insertion sort */
6865 /* copy output list until new-item < list-item */
6866 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6870 /* field for comparison */
6871 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6874 /* String-comparator names start with a letter; numeric names do not */
6876 if (sortsbefore(cond_type, isalpha(opname[0]),
6877 srcfield, dstfield))
6879 /* New-item sorts before this dst-item. Append new-item,
6880 then dst-item, then remainder of dst list. */
6882 newlist = string_append_listele(newlist, sep, srcitem);
6883 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6886 newlist = string_append_listele(newlist, sep, dstitem);
6887 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6889 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */
6890 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6892 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6894 newlist = string_append_listele(newlist, sep, dstitem);
6895 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6901 newlist = string_append_listele(newlist, sep, dstitem);
6902 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6905 /* If we ran out of dstlist without consuming srcitem, append it */
6908 newlist = string_append_listele(newlist, sep, srcitem);
6909 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6912 dstlist = newlist->s;
6913 dstkeylist = newkeylist->s;
6915 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6916 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6920 yield = string_cat(yield, dstlist);
6922 /* Restore preserved $item */
6923 iterate_item = save_iterate_item;
6927 expand_string_message = US"Internal error in sort (list mismatch)";
6932 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6933 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6934 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6935 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6937 #define EXPAND_DLFUNC_MAX_ARGS 8
6940 #ifndef EXPAND_DLFUNC
6941 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6942 "is not included in this binary";
6945 #else /* EXPAND_DLFUNC */
6948 exim_dlfunc_t * func;
6951 uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6953 if (expand_forbid & RDO_DLFUNC)
6955 expand_string_message =
6956 US"dynamically-loaded functions are not permitted";
6960 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, flags,
6961 TRUE, name, &resetok, NULL))
6963 case -1: continue; /* skipping */
6964 case 1: goto EXPAND_FAILED_CURLY;
6966 case 3: goto EXPAND_FAILED;
6969 /* Look up the dynamically loaded object handle in the tree. If it isn't
6970 found, dlopen() the file and put the handle in the tree for next time. */
6972 if (!(t = tree_search(dlobj_anchor, argv[0])))
6974 void * handle = dlopen(CS argv[0], RTLD_LAZY);
6977 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6978 argv[0], dlerror());
6979 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6982 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), argv[0]);
6983 Ustrcpy(t->name, argv[0]);
6984 t->data.ptr = handle;
6985 (void)tree_insertnode(&dlobj_anchor, t);
6988 /* Having obtained the dynamically loaded object handle, look up the
6989 function pointer. */
6991 if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6993 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6994 "%s", argv[1], argv[0], dlerror());
6995 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6999 /* Call the function and work out what to do with the result. If it
7000 returns OK, we have a replacement string; if it returns DEFER then
7001 expansion has failed in a non-forced manner; if it returns FAIL then
7002 failure was forced; if it returns ERROR or any other value there's a
7003 problem, so panic slightly. In any case, assume that the function has
7004 side-effects on the store that must be preserved. */
7008 for (argc = 0; argv[argc]; argc++) ;
7010 if ((status = func(&result, argc - 2, &argv[2])) != OK)
7012 expand_string_message = result ? result : US"(no message)";
7013 if (status == FAIL_FORCED)
7014 f.expand_string_forcedfail = TRUE;
7015 else if (status != FAIL)
7016 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
7017 argv[0], argv[1], status, expand_string_message);
7021 if (result) yield = string_cat(yield, result);
7024 #endif /* EXPAND_DLFUNC */
7026 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
7029 uschar *save_lookup_value = lookup_value;
7031 if (Uskip_whitespace(&s) != '{') /*}*/
7034 key = expand_string_internal(s+1,
7035 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7036 if (!key) goto EXPAND_FAILED; /*{{*/
7039 expand_string_message = US"missing '}' for name arg of env";
7040 goto EXPAND_FAILED_CURLY;
7043 lookup_value = US getenv(CS key);
7045 switch(process_yesno(
7046 flags, /* were previously skipping */
7047 lookup_value != NULL, /* success/failure indicator */
7048 save_lookup_value, /* value to reset for string2 */
7049 &s, /* input pointer */
7050 &yield, /* output pointer */
7051 US"env", /* condition type */
7054 case 1: goto EXPAND_FAILED; /* when all is well, the */
7055 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
7057 if (flags & ESI_SKIPPING) continue;
7062 case EITEM_SRS_ENCODE:
7063 /* ${srs_encode {secret} {return_path} {orig_domain}} */
7068 BOOL quoted = FALSE;
7070 switch (read_subs(sub, 3, 3, CUSS &s, flags, TRUE, name, &resetok, NULL))
7072 case -1: continue; /* skipping */
7073 case 1: goto EXPAND_FAILED_CURLY;
7075 case 3: goto EXPAND_FAILED;
7077 if (flags & ESI_SKIPPING) continue;
7079 if (sub[1] && *(sub[1]))
7081 g = string_catn(g, US"SRS0=", 5);
7083 /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
7084 hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
7085 g = string_catn(g, cksum, sizeof(cksum));
7086 g = string_catn(g, US"=", 1);
7088 /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
7093 gettimeofday(&now, NULL);
7094 i = (now.tv_sec / 86400) & 0x3ff;
7095 g = string_catn(g, &base32_chars[i >> 5], 1);
7096 g = string_catn(g, &base32_chars[i & 0x1f], 1);
7098 g = string_catn(g, US"=", 1);
7100 /* ${domain:$return_path}=${local_part:$return_path} */
7102 int start, end, domain;
7103 uschar * t = parse_extract_address(sub[1], &expand_string_message,
7104 &start, &end, &domain, FALSE);
7110 if (domain > 0) g = string_cat(g, t + domain);
7111 g = string_catn(g, US"=", 1);
7113 s = domain > 0 ? string_copyn(t, domain - 1) : t;
7114 if ((quoted = Ustrchr(s, '"') != NULL))
7117 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
7118 while (*s) /* de-quote */
7120 while (*s && *s != '"') h = string_catn(h, s++, 1);
7122 while (*s && *s != '"') h = string_catn(h, s++, 1);
7125 gstring_release_unused(h);
7126 s = string_from_gstring(h);
7128 g = string_cat(g, s);
7131 /* Assume that if the original local_part had quotes
7132 it was for good reason */
7134 if (quoted) yield = string_catn(yield, US"\"", 1);
7135 yield = gstring_append(yield, g);
7136 if (quoted) yield = string_catn(yield, US"\"", 1);
7138 /* @$original_domain */
7139 yield = string_catn(yield, US"@", 1);
7140 yield = string_cat(yield, sub[2]);
7143 DEBUG(D_expand) debug_printf_indent("null return_path for srs-encode\n");
7147 #endif /*SUPPORT_SRS*/
7151 } /* EITEM_* switch */
7154 DEBUG(D_expand) /* only if not the sole expansion of the line */
7155 if (yield && (expansion_start > 0 || *s))
7156 debug_expansion_interim(US"item-res",
7157 yield->s + expansion_start, yield->ptr - expansion_start,
7158 !!(flags & ESI_SKIPPING));
7164 /* Control reaches here if the name is not recognized as one of the more
7165 complicated expansion items. Check for the "operator" syntax (name terminated
7166 by a colon). Some of the operators have arguments, separated by _ from the
7172 uschar * arg = NULL, * sub;
7174 var_entry * vp = NULL;
7177 /* Owing to an historical mis-design, an underscore may be part of the
7178 operator name, or it may introduce arguments. We therefore first scan the
7179 table of names that contain underscores. If there is no match, we cut off
7180 the arguments and then scan the main table. */
7182 if ((c = chop_match(name, op_table_underscore,
7183 nelem(op_table_underscore))) < 0)
7185 if ((arg = Ustrchr(name, '_')))
7187 if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
7188 c += nelem(op_table_underscore);
7189 if (arg) *arg++ = '_'; /* Put back for error messages */
7192 /* Deal specially with operators that might take a certificate variable
7193 as we do not want to do the usual expansion. For most, expand the string.*/
7204 const uschar * s1 = s;
7205 sub = expand_string_internal(s+2,
7206 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s1, &resetok, NULL);
7207 if (!sub) goto EXPAND_FAILED; /*{*/
7210 expand_string_message =
7211 string_sprintf("missing '}' closing cert arg of %s", name);
7212 goto EXPAND_FAILED_CURLY;
7214 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
7224 sub = expand_string_internal(s+1,
7225 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7226 if (!sub) goto EXPAND_FAILED;
7231 /* If we are skipping, we don't need to perform the operation at all.
7232 This matters for operations like "mask", because the data may not be
7233 in the correct format when skipping. For example, the expression may test
7234 for the existence of $sender_host_address before trying to mask it. For
7235 other operations, doing them may not fail, but it is a waste of time. */
7237 if (flags & ESI_SKIPPING && c >= 0) continue;
7239 /* Otherwise, switch on the operator type. After handling go back
7240 to the main loop top. */
7243 unsigned expansion_start = gstring_length(yield);
7249 unsigned long int n = Ustrtoul(sub, &t, 10);
7254 expand_string_message = string_sprintf("argument for base32 "
7255 "operator is \"%s\", which is not a decimal number", sub);
7259 g = string_catn(g, &base32_chars[n & 0x1f], 1);
7261 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7268 unsigned long int n = 0;
7271 uschar * t = Ustrchr(base32_chars, *tt++);
7274 expand_string_message = string_sprintf("argument for base32d "
7275 "operator is \"%s\", which is not a base 32 number", sub);
7278 n = n * 32 + (t - base32_chars);
7280 yield = string_fmt_append(yield, "%ld", n);
7287 unsigned long int n = Ustrtoul(sub, &t, 10);
7290 expand_string_message = string_sprintf("argument for base62 "
7291 "operator is \"%s\", which is not a decimal number", sub);
7294 yield = string_cat(yield, string_base62_32(n)); /*XXX only handles 32b input range. Need variants? */
7298 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7303 unsigned long int n = 0;
7306 uschar *t = Ustrchr(base62_chars, *tt++);
7309 expand_string_message = string_sprintf("argument for base62d "
7310 "operator is \"%s\", which is not a base %d number", sub,
7314 n = n * BASE_62 + (t - base62_chars);
7316 yield = string_fmt_append(yield, "%ld", n);
7322 uschar *expanded = expand_string_internal(sub,
7323 ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, NULL, &resetok, NULL);
7326 expand_string_message =
7327 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7328 expand_string_message);
7331 yield = string_cat(yield, expanded);
7338 uschar *t = sub - 1;
7339 while (*(++t) != 0) { *t = tolower(*t); count++; }
7340 yield = string_catn(yield, sub, count);
7347 uschar *t = sub - 1;
7348 while (*(++t) != 0) { *t = toupper(*t); count++; }
7349 yield = string_catn(yield, sub, count);
7355 if (vp && *(void **)vp->value)
7357 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7358 yield = string_cat(yield, cp);
7366 md5_end(&base, sub, Ustrlen(sub), digest);
7367 for (int j = 0; j < 16; j++)
7368 yield = string_fmt_append(yield, "%02x", digest[j]);
7374 if (vp && *(void **)vp->value)
7376 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7377 yield = string_cat(yield, cp);
7385 sha1_end(&h, sub, Ustrlen(sub), digest);
7386 for (int j = 0; j < 20; j++)
7387 yield = string_fmt_append(yield, "%02X", digest[j]);
7393 #ifdef EXIM_HAVE_SHA2
7394 if (vp && *(void **)vp->value)
7395 if (c == EOP_SHA256)
7396 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7398 expand_string_message = US"sha2_N not supported with certificates";
7403 hashmethod m = !arg ? HASH_SHA2_256
7404 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7405 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7406 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7409 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7411 expand_string_message = US"unrecognised sha2 variant";
7415 exim_sha_update_string(&h, sub);
7416 exim_sha_finish(&h, &b);
7418 yield = string_fmt_append(yield, "%02X", *b.data++);
7421 expand_string_message = US"sha256 only supported with TLS";
7426 #ifdef EXIM_HAVE_SHA3
7430 hashmethod m = !arg ? HASH_SHA3_256
7431 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7432 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7433 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7434 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7437 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7439 expand_string_message = US"unrecognised sha3 variant";
7443 exim_sha_update_string(&h, sub);
7444 exim_sha_finish(&h, &b);
7446 yield = string_fmt_append(yield, "%02X", *b.data++);
7450 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7454 /* Line-wrap a string as if it is a header line */
7456 case EOP_HEADERWRAP:
7458 unsigned col = 80, lim = 998;
7463 const uschar * list = arg;
7465 if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7468 if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7472 if ((s = wrap_header(sub, col, lim, US"\t", 8)))
7473 yield = string_cat(yield, s);
7477 /* Convert hex encoding to base64 encoding */
7487 for (enc = sub; *enc; enc++)
7489 if (!isxdigit(*enc))
7491 expand_string_message = string_sprintf("\"%s\" is not a hex "
7500 expand_string_message = string_sprintf("\"%s\" contains an odd "
7501 "number of characters", sub);
7505 while ((c = *in++) != 0)
7507 if (isdigit(c)) c -= '0';
7508 else c = toupper(c) - 'A' + 10;
7518 enc = b64encode(CUS sub, out - sub);
7519 yield = string_cat(yield, enc);
7523 /* Convert octets outside 0x21..0x7E to \xXX form */
7527 uschar *t = sub - 1;
7530 if (*t < 0x21 || 0x7E < *t)
7531 yield = string_fmt_append(yield, "\\x%02x", *t);
7533 yield = string_catn(yield, t, 1);
7538 /* count the number of list elements */
7542 int cnt = 0, sep = 0;
7543 uschar * buf = store_get(2, sub);
7545 while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7546 yield = string_fmt_append(yield, "%d", cnt);
7550 /* expand a named list given the name */
7551 /* handles nested named lists; requotes as colon-sep list */
7554 expand_string_message = NULL;
7555 yield = expand_listnamed(yield, sub, arg);
7556 if (expand_string_message)
7560 /* quote a list-item for the given list-separator */
7562 /* mask applies a mask to an IP address; for example the result of
7563 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7570 int type, mask, maskoffset;
7574 if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7576 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7581 if (maskoffset == 0)
7583 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7588 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7590 if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7592 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7597 /* If an optional 'n' was given, ipv6 gets normalised output:
7598 colons rather than dots, and zero-compressed. */
7600 normalised = arg && *arg == 'n';
7602 /* Convert the address to binary integer(s) and apply the mask */
7604 sub[maskoffset] = 0;
7605 count = host_aton(sub, binary);
7606 host_mask(count, binary, mask);
7608 /* Convert to masked textual format and add to output. */
7610 if (type == 4 || !normalised)
7611 yield = string_catn(yield, buffer,
7612 host_nmtoa(count, binary, mask, buffer, '.'));
7615 ipv6_nmtoa(binary, buffer);
7616 yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7622 case EOP_IPV6DENORM:
7624 int type = string_is_ip_address(sub, NULL);
7631 (void) host_aton(sub, binary);
7634 case 4: /* convert to IPv4-mapped IPv6 */
7635 binary[0] = binary[1] = 0;
7636 binary[2] = 0x0000ffff;
7637 (void) host_aton(sub, binary+3);
7641 expand_string_message =
7642 string_sprintf("\"%s\" is not an IP address", sub);
7646 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7647 ? ipv6_nmtoa(binary, buffer)
7648 : host_nmtoa(4, binary, -1, buffer, ':')
7654 case EOP_LOCAL_PART:
7658 int start, end, domain;
7659 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7662 if (c != EOP_DOMAIN)
7663 yield = c == EOP_LOCAL_PART && domain > 0
7664 ? string_catn(yield, t, domain - 1)
7665 : string_cat(yield, t);
7666 else if (domain > 0)
7667 yield = string_cat(yield, t + domain);
7673 uschar outsep[2] = { ':', '\0' };
7674 uschar *address, *error;
7675 int save_ptr = gstring_length(yield);
7676 int start, end, domain; /* Not really used */
7678 if (Uskip_whitespace(&sub) == '>')
7679 if (*outsep = *++sub) ++sub;
7682 expand_string_message = string_sprintf("output separator "
7683 "missing in expanding ${addresses:%s}", --sub);
7686 f.parse_allow_group = TRUE;
7690 uschar * p = parse_find_address_end(sub, FALSE);
7691 uschar saveend = *p;
7693 address = parse_extract_address(sub, &error, &start, &end, &domain,
7697 /* Add the address to the output list that we are building. This is
7698 done in chunks by searching for the separator character. At the
7699 start, unless we are dealing with the first address of the output
7700 list, add in a space if the new address begins with the separator
7701 character, or is an empty string. */
7705 if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7706 yield = string_catn(yield, US" ", 1);
7710 size_t seglen = Ustrcspn(address, outsep);
7711 yield = string_catn(yield, address, seglen + 1);
7713 /* If we got to the end of the string we output one character
7716 if (address[seglen] == '\0') { yield->ptr--; break; }
7717 yield = string_catn(yield, outsep, 1);
7718 address += seglen + 1;
7721 /* Output a separator after the string: we will remove the
7722 redundant final one at the end. */
7724 yield = string_catn(yield, outsep, 1);
7727 if (saveend == '\0') break;
7731 /* If we have generated anything, remove the redundant final
7734 if (yield && yield->ptr != save_ptr) yield->ptr--;
7735 f.parse_allow_group = FALSE;
7740 /* quote puts a string in quotes if it is empty or contains anything
7741 other than alphamerics, underscore, dot, or hyphen.
7743 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7744 be quoted in order to be a valid local part.
7746 In both cases, newlines and carriage returns are converted into \n and \r
7750 case EOP_QUOTE_LOCAL_PART:
7753 BOOL needs_quote = (!*sub); /* TRUE for empty string */
7754 uschar *t = sub - 1;
7757 while (!needs_quote && *++t)
7758 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7760 else /* EOP_QUOTE_LOCAL_PART */
7761 while (!needs_quote && *++t)
7762 needs_quote = !isalnum(*t)
7763 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7764 && (*t != '.' || t == sub || !t[1]);
7768 yield = string_catn(yield, US"\"", 1);
7772 yield = string_catn(yield, US"\\n", 2);
7773 else if (*t == '\r')
7774 yield = string_catn(yield, US"\\r", 2);
7777 if (*t == '\\' || *t == '"')
7778 yield = string_catn(yield, US"\\", 1);
7779 yield = string_catn(yield, t, 1);
7781 yield = string_catn(yield, US"\"", 1);
7784 yield = string_cat(yield, sub);
7788 /* quote_lookuptype does lookup-specific quoting */
7793 uschar * opt = Ustrchr(arg, '_');
7795 if (opt) *opt++ = 0;
7797 if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7799 expand_string_message = search_error_message;
7803 if (lookup_list[n]->quote)
7804 sub = (lookup_list[n]->quote)(sub, opt, (unsigned)n);
7810 expand_string_message = string_sprintf(
7811 "\"%s\" unrecognized after \"${quote_%s\"", /*}*/
7816 yield = string_cat(yield, sub);
7820 /* rx quote sticks in \ before any non-alphameric character so that
7821 the insertion works in a regular expression. */
7825 uschar *t = sub - 1;
7829 yield = string_catn(yield, US"\\", 1);
7830 yield = string_catn(yield, t, 1);
7835 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7836 prescribed by the RFC, if there are characters that need to be encoded */
7839 yield = string_cat(yield,
7840 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7844 /* RFC 2047 decode */
7850 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7851 headers_charset, '?', &len, &error);
7854 expand_string_message = error;
7857 yield = string_catn(yield, decoded, len);
7861 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7866 uschar * buff = store_get(4, sub);
7871 if (c > 255) c = '_';
7873 yield = string_catn(yield, buff, 1);
7878 /* replace illegal UTF-8 sequences by replacement character */
7880 #define UTF8_REPLACEMENT_CHAR US"?"
7884 int seq_len = 0, index = 0, bytes_left = 0, complete;
7885 u_long codepoint = (u_long)-1;
7886 uschar seq_buff[4]; /* accumulate utf-8 here */
7888 /* Manually track tainting, as we deal in individual chars below */
7891 yield = string_get_tainted(Ustrlen(sub), sub);
7892 else if (!yield->s || !yield->ptr)
7894 yield->s = store_get(yield->size = Ustrlen(sub), sub);
7895 gstring_reset(yield);
7897 else if (is_incompatible(yield->s, sub))
7898 gstring_rebuffer(yield, sub);
7900 /* Check the UTF-8, byte-by-byte */
7909 if ((c & 0xc0) != 0x80)
7910 /* wrong continuation byte; invalidate all bytes */
7911 complete = 1; /* error */
7914 codepoint = (codepoint << 6) | (c & 0x3f);
7915 seq_buff[index++] = c;
7916 if (--bytes_left == 0) /* codepoint complete */
7917 if(codepoint > 0x10FFFF) /* is it too large? */
7918 complete = -1; /* error (RFC3629 limit) */
7919 else if ( (codepoint & 0x1FF800 ) == 0xD800 ) /* surrogate */
7920 /* A UTF-16 surrogate (which should be one of a pair that
7921 encode a Unicode codepoint that is outside the Basic
7922 Multilingual Plane). Error, not UTF8.
7923 RFC2279.2 is slightly unclear on this, but
7924 https://unicodebook.readthedocs.io/issues.html#strict-utf8-decoder
7925 says "Surrogates characters are also invalid in UTF-8:
7926 characters in U+D800—U+DFFF have to be rejected." */
7929 { /* finished; output utf-8 sequence */
7930 yield = string_catn(yield, seq_buff, seq_len);
7935 else /* no bytes left: new sequence */
7937 if (!(c & 0x80)) /* 1-byte sequence, US-ASCII, keep it */
7939 yield = string_catn(yield, &c, 1);
7942 if ((c & 0xe0) == 0xc0) /* 2-byte sequence */
7943 if (c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7948 codepoint = c & 0x1f;
7950 else if ((c & 0xf0) == 0xe0) /* 3-byte sequence */
7953 codepoint = c & 0x0f;
7955 else if ((c & 0xf8) == 0xf0) /* 4-byte sequence */
7958 codepoint = c & 0x07;
7960 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7963 seq_buff[index++] = c;
7964 seq_len = bytes_left + 1;
7965 } /* if(bytes_left) */
7969 bytes_left = index = 0;
7970 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7972 if ((complete == 1) && ((c & 0x80) == 0))
7973 /* ASCII character follows incomplete sequence */
7974 yield = string_catn(yield, &c, 1);
7976 /* If given a sequence truncated mid-character, we also want to report ?
7977 Eg, ${length_1:フィル} is one byte, not one character, so we expect
7978 ${utf8clean:${length_1:フィル}} to yield '?' */
7980 if (bytes_left != 0)
7981 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7987 case EOP_UTF8_DOMAIN_TO_ALABEL:
7989 uschar * error = NULL;
7990 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7993 expand_string_message = string_sprintf(
7994 "error converting utf8 (%s) to alabel: %s",
7995 string_printing(sub), error);
7998 yield = string_cat(yield, s);
8002 case EOP_UTF8_DOMAIN_FROM_ALABEL:
8004 uschar * error = NULL;
8005 uschar * s = string_domain_alabel_to_utf8(sub, &error);
8008 expand_string_message = string_sprintf(
8009 "error converting alabel (%s) to utf8: %s",
8010 string_printing(sub), error);
8013 yield = string_cat(yield, s);
8017 case EOP_UTF8_LOCALPART_TO_ALABEL:
8019 uschar * error = NULL;
8020 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
8023 expand_string_message = string_sprintf(
8024 "error converting utf8 (%s) to alabel: %s",
8025 string_printing(sub), error);
8028 yield = string_cat(yield, s);
8029 DEBUG(D_expand) debug_printf_indent("yield: '%Y'\n", yield);
8033 case EOP_UTF8_LOCALPART_FROM_ALABEL:
8035 uschar * error = NULL;
8036 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
8039 expand_string_message = string_sprintf(
8040 "error converting alabel (%s) to utf8: %s",
8041 string_printing(sub), error);
8044 yield = string_cat(yield, s);
8047 #endif /* EXPERIMENTAL_INTERNATIONAL */
8049 /* escape turns all non-printing characters into escape sequences. */
8053 const uschar * t = string_printing(sub);
8054 yield = string_cat(yield, t);
8058 case EOP_ESCAPE8BIT:
8062 for (const uschar * s = sub; (c = *s); s++)
8063 yield = c < 127 && c != '\\'
8064 ? string_catn(yield, s, 1)
8065 : string_fmt_append(yield, "\\%03o", c);
8069 /* Handle numeric expression evaluation */
8074 uschar *save_sub = sub;
8075 uschar *error = NULL;
8076 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
8079 expand_string_message = string_sprintf("error in expression "
8080 "evaluation: %s (after processing \"%.*s\")", error,
8081 (int)(sub-save_sub), save_sub);
8084 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
8088 /* Handle time period formatting */
8092 int n = readconf_readtime(sub, 0, FALSE);
8095 expand_string_message = string_sprintf("string \"%s\" is not an "
8096 "Exim time interval in \"%s\" operator", sub, name);
8099 yield = string_fmt_append(yield, "%d", n);
8103 case EOP_TIME_INTERVAL:
8106 uschar *t = read_number(&n, sub);
8107 if (*t != 0) /* Not A Number*/
8109 expand_string_message = string_sprintf("string \"%s\" is not a "
8110 "positive number in \"%s\" operator", sub, name);
8113 t = readconf_printtime(n);
8114 yield = string_cat(yield, t);
8118 /* Convert string to base64 encoding */
8124 uschar * s = vp && *(void **)vp->value
8125 ? tls_cert_der_b64(*(void **)vp->value)
8126 : b64encode(CUS sub, Ustrlen(sub));
8128 uschar * s = b64encode(CUS sub, Ustrlen(sub));
8130 yield = string_cat(yield, s);
8137 int len = b64decode(sub, &s, sub);
8140 expand_string_message = string_sprintf("string \"%s\" is not "
8141 "well-formed for \"%s\" operator", sub, name);
8144 yield = string_cat(yield, s);
8148 /* strlen returns the length of the string */
8151 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
8154 /* length_n or l_n takes just the first n characters or the whole string,
8155 whichever is the shorter;
8157 substr_m_n, and s_m_n take n characters from offset m; negative m take
8158 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
8159 takes the rest, either to the right or to the left.
8161 hash_n or h_n makes a hash of length n from the string, yielding n
8162 characters from the set a-z; hash_n_m makes a hash of length n, but
8163 uses m characters from the set a-zA-Z0-9.
8165 nhash_n returns a single number between 0 and n-1 (in text form), while
8166 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
8167 between 0 and n-1 and the second between 0 and m-1. */
8187 expand_string_message = string_sprintf("missing values after %s",
8192 /* "length" has only one argument, effectively being synonymous with
8195 if (c == EOP_LENGTH || c == EOP_L)
8201 /* The others have one or two arguments; for "substr" the first may be
8202 negative. The second being negative means "not supplied". */
8207 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8210 /* Read up to two numbers, separated by underscores */
8215 if (arg != ret && *arg == '_' && pn == &value1)
8219 if (arg[1] != 0) arg++;
8221 else if (!isdigit(*arg))
8223 expand_string_message =
8224 string_sprintf("non-digit after underscore in \"%s\"", name);
8227 else *pn = (*pn)*10 + *arg++ - '0';
8231 /* Perform the required operation */
8233 ret = c == EOP_HASH || c == EOP_H
8234 ? compute_hash(sub, value1, value2, &len)
8235 : c == EOP_NHASH || c == EOP_NH
8236 ? compute_nhash(sub, value1, value2, &len)
8237 : extract_substr(sub, value1, value2, &len);
8238 if (!ret) goto EXPAND_FAILED;
8240 yield = string_catn(yield, ret, len);
8249 uschar **modetable[3];
8253 if (expand_forbid & RDO_EXISTS)
8255 expand_string_message = US"Use of the stat() expansion is not permitted";
8259 if (stat(CS sub, &st) < 0)
8261 expand_string_message = string_sprintf("stat(%s) failed: %s",
8262 sub, strerror(errno));
8266 switch (mode & S_IFMT)
8268 case S_IFIFO: smode[0] = 'p'; break;
8269 case S_IFCHR: smode[0] = 'c'; break;
8270 case S_IFDIR: smode[0] = 'd'; break;
8271 case S_IFBLK: smode[0] = 'b'; break;
8272 case S_IFREG: smode[0] = '-'; break;
8273 default: smode[0] = '?'; break;
8276 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8277 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8278 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8280 for (int i = 0; i < 3; i++)
8282 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8287 yield = string_fmt_append(yield,
8288 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8289 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8290 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8291 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8292 (long)st.st_gid, st.st_size, (long)st.st_atime,
8293 (long)st.st_mtime, (long)st.st_ctime);
8297 /* vaguely random number less than N */
8301 int_eximarith_t max = expanded_string_integer(sub, TRUE);
8303 if (expand_string_message)
8305 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8309 /* Reverse IP, including IPv6 to dotted-nibble */
8311 case EOP_REVERSE_IP:
8313 int family, maskptr;
8314 uschar reversed[128];
8316 family = string_is_ip_address(sub, &maskptr);
8319 expand_string_message = string_sprintf(
8320 "reverse_ip() not given an IP address [%s]", sub);
8323 invert_address(reversed, sub);
8324 yield = string_cat(yield, reversed);
8328 /* Unknown operator */
8331 expand_string_message =
8332 string_sprintf("unknown expansion operator \"%s\"", name);
8334 } /* EOP_* switch */
8338 const uschar * res = string_from_gstring(yield);
8339 const uschar * s = res + expansion_start;
8340 int i = gstring_length(yield) - expansion_start;
8341 BOOL tainted = is_tainted(s);
8345 debug_printf_indent("|-----op-res: %.*s\n", i, s);
8348 debug_printf_indent("%s \\__", flags & ESI_SKIPPING ? "| " : " ");
8349 debug_print_taint(res);
8354 debug_printf_indent(UTF8_VERT_RIGHT
8355 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8356 "op-res: %.*s\n", i, s);
8359 debug_printf_indent("%s",
8360 flags & ESI_SKIPPING
8361 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8362 debug_print_taint(res);
8370 /* Not an item or an operator */
8371 /* Handle a plain name. If this is the first thing in the expansion, release
8372 the pre-allocated buffer. If the result data is known to be in a new buffer,
8373 newsize will be set to the size of that buffer, and we can just point at that
8374 store instead of copying. Many expansion strings contain just one reference,
8375 so this is a useful optimization, especially for humungous headers
8376 ($message_headers). */
8380 const uschar * value;
8386 g = store_get(sizeof(gstring), GET_UNTAINTED);
8387 else if (yield->ptr == 0)
8389 if (resetok) reset_point = store_reset(reset_point);
8391 reset_point = store_mark();
8392 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
8394 if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
8396 expand_string_message =
8397 string_sprintf("unknown variable in \"${%s}\"", name);
8398 check_variable_error_message(name);
8401 len = Ustrlen(value);
8402 if (!yield && newsize)
8405 yield->size = newsize;
8407 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8410 yield = string_catn(yield, value, len);
8414 /* Else there's something wrong */
8416 expand_string_message =
8417 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8418 "in a variable reference)", name);
8422 /* If we hit the end of the string when brace_ends is set, there is a missing
8423 terminating brace. */
8425 if (flags & ESI_BRACE_ENDS && !*s)
8427 expand_string_message = malformed_header
8428 ? US"missing } at end of string - could be header name not terminated by colon"
8429 : US"missing } at end of string";
8433 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8434 added to the string. If so, set up an empty string. Add a terminating zero. If
8435 left != NULL, return a pointer to the terminator. */
8441 yield = string_get(1);
8442 res = string_from_gstring(yield);
8443 if (left) *left = s;
8445 /* Any stacking store that was used above the final string is no longer needed.
8446 In many cases the final string will be the first one that was got and so there
8447 will be optimal store usage. */
8449 if (resetok) gstring_release_unused(yield);
8450 else if (resetok_p) *resetok_p = FALSE;
8454 BOOL tainted = is_tainted(res);
8457 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8458 debug_printf_indent("%sresult: %s\n",
8459 flags & ESI_SKIPPING ? "|-----" : "\\_____", res);
8462 debug_printf_indent("%s \\__", flags & ESI_SKIPPING ? "| " : " ");
8463 debug_print_taint(res);
8465 if (flags & ESI_SKIPPING)
8466 debug_printf_indent("\\___skipping: result is not used\n");
8470 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8471 "expanding: %.*s\n",
8472 (int)(s - string), string);
8473 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8475 flags & ESI_SKIPPING ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8479 debug_printf_indent("%s",
8480 flags & ESI_SKIPPING
8481 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8482 debug_print_taint(res);
8484 if (flags & ESI_SKIPPING)
8485 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8486 "skipping: result is not used\n");
8489 if (textonly_p) *textonly_p = textonly;
8494 /* This is the failure exit: easiest to program with a goto. We still need
8495 to update the pointer to the terminator, for cases of nested calls with "fail".
8498 EXPAND_FAILED_CURLY:
8499 if (malformed_header)
8500 expand_string_message =
8501 US"missing or misplaced { or } - could be header name not terminated by colon";
8503 else if (!expand_string_message || !*expand_string_message)
8504 expand_string_message = US"missing or misplaced { or }";
8506 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8507 that is a bad idea, because expand_string_message is in dynamic store. */
8510 if (left) *left = s;
8515 debug_printf_indent("|failed to expand: %s\n", string);
8516 debug_printf_indent("%serror message: %s\n",
8517 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8518 if (f.expand_string_forcedfail)
8519 debug_printf_indent("\\failure was forced\n");
8523 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8525 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8526 "error message: %s\n",
8527 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8528 expand_string_message);
8529 if (f.expand_string_forcedfail)
8530 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8533 if (resetok_p && !resetok) *resetok_p = FALSE;
8540 /* This is the external function call. Do a quick check for any expansion
8541 metacharacters, and if there are none, just return the input string.
8544 the string to be expanded
8545 optional pointer for return boolean indicating no-dynamic-expansions
8547 Returns: the expanded string, or NULL if expansion failed; if failure was
8548 due to a lookup deferring, search_find_defer will be TRUE
8552 expand_string_2(const uschar * string, BOOL * textonly_p)
8554 if (Ustrpbrk(string, "$\\") != NULL)
8556 int old_pool = store_pool;
8559 f.search_find_defer = FALSE;
8560 malformed_header = FALSE;
8561 store_pool = POOL_MAIN;
8562 s = expand_string_internal(string, ESI_HONOR_DOLLAR, NULL, NULL, textonly_p);
8563 store_pool = old_pool;
8566 if (textonly_p) *textonly_p = TRUE;
8571 expand_cstring(const uschar * string)
8572 { return expand_string_2(string, NULL); }
8575 expand_string(uschar * string)
8576 { return US expand_string_2(CUS string, NULL); }
8583 /*************************************************
8585 *************************************************/
8587 /* Now and again we want to expand a string and be sure that the result is in a
8588 new bit of store. This function does that.
8589 Since we know it has been copied, the de-const cast is safe.
8591 Argument: the string to be expanded
8592 Returns: the expanded string, always in a new bit of store, or NULL
8596 expand_string_copy(const uschar *string)
8598 const uschar *yield = expand_cstring(string);
8599 if (yield == string) yield = string_copy(string);
8605 /*************************************************
8606 * Expand and interpret as an integer *
8607 *************************************************/
8609 /* Expand a string, and convert the result into an integer.
8612 string the string to be expanded
8613 isplus TRUE if a non-negative number is expected
8615 Returns: the integer value, or
8616 -1 for an expansion error ) in both cases, message in
8617 -2 for an integer interpretation error ) expand_string_message
8618 expand_string_message is set NULL for an OK integer
8622 expand_string_integer(uschar *string, BOOL isplus)
8624 return expanded_string_integer(expand_string(string), isplus);
8628 /*************************************************
8629 * Interpret string as an integer *
8630 *************************************************/
8632 /* Convert a string (that has already been expanded) into an integer.
8634 This function is used inside the expansion code.
8637 s the string to be expanded
8638 isplus TRUE if a non-negative number is expected
8640 Returns: the integer value, or
8641 -1 if string is NULL (which implies an expansion error)
8642 -2 for an integer interpretation error
8643 expand_string_message is set NULL for an OK integer
8646 static int_eximarith_t
8647 expanded_string_integer(const uschar *s, BOOL isplus)
8649 int_eximarith_t value;
8650 uschar *msg = US"invalid integer \"%s\"";
8653 /* If expansion failed, expand_string_message will be set. */
8657 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8658 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8659 systems, so we set it zero ourselves. */
8662 expand_string_message = NULL; /* Indicates no error */
8664 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8665 equal to 0. Unfortunately, people actually relied upon that, so preserve
8666 the behaviour explicitly. Stripping leading whitespace is a harmless
8667 noop change since strtol skips it anyway (provided that there is a number
8670 if (Uskip_whitespace(&s) == '\0')
8673 debug_printf_indent("treating blank string as number 0\n");
8677 value = strtoll(CS s, CSS &endptr, 10);
8680 msg = US"integer expected but \"%s\" found";
8681 else if (value < 0 && isplus)
8682 msg = US"non-negative integer expected but \"%s\" found";
8685 switch (tolower(*endptr))
8690 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8695 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8696 else value *= 1024*1024;
8700 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8701 else value *= 1024*1024*1024;
8705 if (errno == ERANGE)
8706 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8708 if (Uskip_whitespace(&endptr) == 0) return value;
8711 expand_string_message = string_sprintf(CS msg, s);
8716 /* These values are usually fixed boolean values, but they are permitted to be
8720 addr address being routed
8721 mtype the module type
8722 mname the module name
8723 dbg_opt debug selectors
8724 oname the option name
8725 bvalue the router's boolean value
8726 svalue the router's string value
8727 rvalue where to put the returned value
8729 Returns: OK value placed in rvalue
8730 DEFER expansion failed
8734 exp_bool(address_item *addr,
8735 uschar *mtype, uschar *mname, unsigned dbg_opt,
8736 uschar *oname, BOOL bvalue,
8737 uschar *svalue, BOOL *rvalue)
8740 if (!svalue) { *rvalue = bvalue; return OK; }
8742 if (!(expanded = expand_string(svalue)))
8744 if (f.expand_string_forcedfail)
8746 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8750 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8751 oname, mname, mtype, expand_string_message);
8752 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8756 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8759 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8761 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8765 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8766 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8775 /* Avoid potentially exposing a password in a string about to be logged */
8778 expand_hide_passwords(uschar * s)
8780 return ( ( Ustrstr(s, "failed to expand") != NULL
8781 || Ustrstr(s, "expansion of ") != NULL
8783 && ( Ustrstr(s, "mysql") != NULL
8784 || Ustrstr(s, "pgsql") != NULL
8785 || Ustrstr(s, "redis") != NULL
8786 || Ustrstr(s, "sqlite") != NULL
8787 || Ustrstr(s, "ldap:") != NULL
8788 || Ustrstr(s, "ldaps:") != NULL
8789 || Ustrstr(s, "ldapi:") != NULL
8790 || Ustrstr(s, "ldapdn:") != NULL
8791 || Ustrstr(s, "ldapm:") != NULL
8793 ? US"Temporary internal error" : s;
8797 /* Read given named file into big_buffer. Use for keying material etc.
8798 The content will have an ascii NUL appended.
8803 Return: pointer to buffer, or NULL on error.
8807 expand_file_big_buffer(const uschar * filename)
8809 int fd, off = 0, len;
8811 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8813 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8820 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8823 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8831 big_buffer[off] = '\0';
8837 /*************************************************
8838 * Error-checking for testsuite *
8839 *************************************************/
8841 uschar * region_start;
8842 uschar * region_end;
8843 const uschar *var_name;
8844 const uschar *var_data;
8847 /* Called via tree_walk, which allows nonconst name/data. Our usage is const. */
8849 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8852 if (var_data >= e->region_start && var_data < e->region_end)
8854 e->var_name = CUS var_name;
8855 e->var_data = CUS var_data;
8860 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8862 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8863 .var_name = NULL, .var_data = NULL };
8865 /* check acl_ variables */
8866 tree_walk(acl_var_c, assert_variable_notin, &e);
8867 tree_walk(acl_var_m, assert_variable_notin, &e);
8869 /* check auth<n> variables.
8870 assert_variable_notin() treats as const, so deconst is safe. */
8871 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8872 assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8874 #ifdef WITH_CONTENT_SCAN
8875 /* check regex<n> variables. assert_variable_notin() treats as const. */
8876 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8877 assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8880 /* check known-name variables */
8881 for (var_entry * v = var_table; v < var_table + nelem(var_table); v++)
8882 if (v->type == vtype_stringptr)
8883 assert_variable_notin(US v->name, *(USS v->value), &e);
8885 /* check dns and address trees */
8886 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8887 tree_walk(tree_duplicates, assert_variable_notin, &e);
8888 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8889 tree_walk(tree_unusable, assert_variable_notin, &e);
8892 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8893 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8894 e.var_name, filename, linenumber, e.var_data);
8899 /*************************************************
8900 **************************************************
8901 * Stand-alone test program *
8902 **************************************************
8903 *************************************************/
8909 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8911 int ovec[3*(EXPAND_MAXN+1)];
8912 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8914 BOOL yield = n >= 0;
8915 if (n == 0) n = EXPAND_MAXN + 1;
8918 expand_nmax = setup < 0 ? 0 : setup + 1;
8919 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8921 expand_nstring[expand_nmax] = subject + ovec[nn];
8922 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8930 int main(int argc, uschar **argv)
8932 uschar buffer[1024];
8934 debug_selector = D_v;
8935 debug_file = stderr;
8936 debug_fd = fileno(debug_file);
8937 big_buffer = malloc(big_buffer_size);
8940 for (int i = 1; i < argc; i++)
8942 if (argv[i][0] == '+')
8944 debug_trace_memory = 2;
8947 if (isdigit(argv[i][0]))
8948 debug_selector = Ustrtol(argv[i], NULL, 0);
8950 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8954 eldap_default_servers = argv[i];
8957 mysql_servers = argv[i];
8960 pgsql_servers = argv[i];
8963 redis_servers = argv[i];
8967 else opt_perl_startup = argv[i];
8971 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8973 expand_nstring[1] = US"string 1....";
8974 expand_nlength[1] = 8;
8978 if (opt_perl_startup != NULL)
8981 printf("Starting Perl interpreter\n");
8982 errstr = init_perl(opt_perl_startup);
8985 printf("** error in perl_startup code: %s\n", errstr);
8986 return EXIT_FAILURE;
8989 #endif /* EXIM_PERL */
8991 /* Thie deliberately regards the input as untainted, so that it can be
8992 expanded; only reasonable since this is a test for string-expansions. */
8994 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8996 rmark reset_point = store_mark();
8997 uschar *yield = expand_string(buffer);
8999 printf("%s\n", yield);
9002 if (f.search_find_defer) printf("search_find deferred\n");
9003 printf("Failed: %s\n", expand_string_message);
9004 if (f.expand_string_forcedfail) printf("Forced failure\n");
9007 store_reset(reset_point);
9015 #endif /*STAND_ALONE*/
9017 #endif /*!MACRO_PREDEF*/
9020 /* End of expand.c */