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. */
3592 /* check the timestamp */
3595 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3599 gettimeofday(&now, NULL);
3600 now.tv_sec /= 86400; /* days since epoch */
3602 /* Decode substring 2 from base32 to a number */
3604 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3606 uschar * t = Ustrchr(base32_chars, *ss++);
3607 d = d * 32 + (t - base32_chars);
3610 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3612 DEBUG(D_expand) debug_printf("SRS too old\n");
3617 /* check length of substring 1, the offered checksum */
3619 if (ovec[3]-ovec[2] != 4)
3621 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3625 /* Hash the address with our secret, and compare that computed checksum
3626 with the one extracted from the arg */
3628 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3629 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3631 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3637 /* pcre2_match_data_free(md); gen ctx needs no free */
3638 if (yield) *yield = (boolvalue == testfor);
3641 #endif /*SUPPORT_SRS*/
3643 /* Unknown condition */
3646 if (!expand_string_message || !*expand_string_message)
3647 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3649 } /* End switch on condition type */
3651 /* Missing braces at start and end of data */
3653 COND_FAILED_CURLY_START:
3654 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3657 COND_FAILED_CURLY_END:
3658 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3662 /* A condition requires code that is not compiled */
3664 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3665 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3666 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3667 COND_FAILED_NOT_COMPILED:
3668 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3677 /*************************************************
3678 * Save numerical variables *
3679 *************************************************/
3681 /* This function is called from items such as "if" that want to preserve and
3682 restore the numbered variables.
3685 save_expand_string points to an array of pointers to set
3686 save_expand_nlength points to an array of ints for the lengths
3688 Returns: the value of expand max to save
3692 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3694 for (int i = 0; i <= expand_nmax; i++)
3696 save_expand_nstring[i] = expand_nstring[i];
3697 save_expand_nlength[i] = expand_nlength[i];
3704 /*************************************************
3705 * Restore numerical variables *
3706 *************************************************/
3708 /* This function restored saved values of numerical strings.
3711 save_expand_nmax the number of strings to restore
3712 save_expand_string points to an array of pointers
3713 save_expand_nlength points to an array of ints
3719 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3720 int *save_expand_nlength)
3722 expand_nmax = save_expand_nmax;
3723 for (int i = 0; i <= expand_nmax; i++)
3725 expand_nstring[i] = save_expand_nstring[i];
3726 expand_nlength[i] = save_expand_nlength[i];
3734 /*************************************************
3735 * Handle yes/no substrings *
3736 *************************************************/
3738 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3739 alternative substrings that depend on whether or not the condition was true,
3740 or the lookup or extraction succeeded. The substrings always have to be
3741 expanded, to check their syntax, but "skipping" is set when the result is not
3742 needed - this avoids unnecessary nested lookups.
3746 skipping TRUE if we were skipping when this item was reached
3747 yes TRUE if the first string is to be used, else use the second
3748 save_lookup a value to put back into lookup_value before the 2nd expansion
3749 sptr points to the input string pointer
3750 yieldptr points to the output growable-string pointer
3751 type "lookup", "if", "extract", "run", "env", "listextract" or
3752 "certextract" for error message
3753 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3756 Returns: 0 OK; lookup_value has been reset to save_lookup
3758 2 expansion failed because of bracketing error
3762 process_yesno(esi_flags flags, BOOL yes, uschar *save_lookup, const uschar **sptr,
3763 gstring ** yieldptr, uschar *type, BOOL *resetok)
3766 const uschar *s = *sptr; /* Local value */
3767 uschar *sub1, *sub2;
3768 const uschar * errwhere;
3770 flags &= ESI_SKIPPING; /* Ignore all buf the skipping flag */
3772 /* If there are no following strings, we substitute the contents of $value for
3773 lookups and for extractions in the success case. For the ${if item, the string
3774 "true" is substituted. In the fail case, nothing is substituted for all three
3777 if (skip_whitespace(&s) == '}')
3781 if (yes && !(flags & ESI_SKIPPING))
3782 *yieldptr = string_catn(*yieldptr, US"true", 4);
3786 if (yes && lookup_value && !(flags & ESI_SKIPPING))
3787 *yieldptr = string_cat(*yieldptr, lookup_value);
3788 lookup_value = save_lookup;
3794 /* The first following string must be braced. */
3798 errwhere = US"'yes' part did not start with '{'"; /*}}*/
3802 /* Expand the first substring. Forced failures are noticed only if we actually
3803 want this string. Set skipping in the call in the fail case (this will always
3804 be the case if we were already skipping). */
3806 sub1 = expand_string_internal(s,
3807 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yes ? ESI_NOFLAGS : ESI_SKIPPING),
3809 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3810 f.expand_string_forcedfail = FALSE;
3814 errwhere = US"'yes' part did not end with '}'";
3818 /* If we want the first string, add it to the output */
3821 *yieldptr = string_cat(*yieldptr, sub1);
3823 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3824 $value to what it was at the start of the item, so that it has this value
3825 during the second string expansion. For the call from "if" or "run" to this
3826 function, save_lookup is set to lookup_value, so that this statement does
3829 lookup_value = save_lookup;
3831 /* There now follows either another substring, or "fail", or nothing. This
3832 time, forced failures are noticed only if we want the second string. We must
3833 set skipping in the nested call if we don't want this string, or if we were
3834 already skipping. */
3836 if (skip_whitespace(&s) == '{') /*}*/
3838 esi_flags s_flags = ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags;
3839 if (yes) s_flags |= ESI_SKIPPING;
3840 sub2 = expand_string_internal(s+1, s_flags, &s, resetok, NULL);
3841 if (!sub2 && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3842 f.expand_string_forcedfail = FALSE; /*{*/
3845 errwhere = US"'no' part did not start with '{'"; /*}*/
3849 /* If we want the second string, add it to the output */
3852 *yieldptr = string_cat(*yieldptr, sub2);
3855 /* If there is no second string, but the word "fail" is present when the use of
3856 the second string is wanted, set a flag indicating it was a forced failure
3857 rather than a syntactic error. Swallow the terminating } in case this is nested
3858 inside another lookup or if or extract. */
3863 /* deconst cast ok here as source is s anyway */
3864 s = US read_name(name, sizeof(name), s, US"_");
3865 if (Ustrcmp(name, "fail") == 0)
3867 if (!yes && !(flags & ESI_SKIPPING))
3869 Uskip_whitespace(&s); /*{{*/
3872 errwhere = US"did not close with '}' after forcedfail";
3875 expand_string_message =
3876 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3877 f.expand_string_forcedfail = TRUE;
3883 expand_string_message =
3884 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3889 /* All we have to do now is to check on the final closing brace. */
3891 skip_whitespace(&s); /*{{*/
3894 errwhere = US"did not close with '}'";
3900 /* Update the input pointer value before returning */
3905 /* Get here if there is a bracketing failure */
3906 expand_string_message = string_sprintf(
3907 "curly-bracket problem in conditional yes/no parsing: %s\n"
3908 " remaining string is '%s'", errwhere, --s);
3913 /* Get here for other failures */
3921 /********************************************************
3922 * prvs: Get last three digits of days since Jan 1, 1970 *
3923 ********************************************************/
3925 /* This is needed to implement the "prvs" BATV reverse
3928 Argument: integer "days" offset to add or substract to
3929 or from the current number of days.
3931 Returns: pointer to string containing the last three
3932 digits of the number of days since Jan 1, 1970,
3933 modified by the offset argument, NULL if there
3934 was an error in the conversion.
3939 prvs_daystamp(int day_offset)
3941 uschar * days = store_get(32, GET_UNTAINTED); /* Need at least 24 for cases */
3942 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3943 (time(NULL) + day_offset*86400)/86400);
3944 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3949 /********************************************************
3950 * prvs: perform HMAC-SHA1 computation of prvs bits *
3951 ********************************************************/
3953 /* This is needed to implement the "prvs" BATV reverse
3957 address RFC2821 Address to use
3958 key The key to use (must be less than 64 characters
3960 key_num Single-digit key number to use. Defaults to
3963 Returns: pointer to string containing the first three
3964 bytes of the final hash in hex format, NULL if
3965 there was an error in the process.
3969 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3971 gstring * hash_source;
3974 uschar innerhash[20];
3975 uschar finalhash[20];
3976 uschar innerkey[64];
3977 uschar outerkey[64];
3978 uschar *finalhash_hex;
3983 if (Ustrlen(key) > 64)
3986 hash_source = string_catn(NULL, key_num, 1);
3987 hash_source = string_catn(hash_source, daystamp, 3);
3988 hash_source = string_cat(hash_source, address);
3991 debug_printf_indent("prvs: hash source is '%Y'\n", hash_source);
3993 memset(innerkey, 0x36, 64);
3994 memset(outerkey, 0x5c, 64);
3996 for (int i = 0; i < Ustrlen(key); i++)
3998 innerkey[i] ^= key[i];
3999 outerkey[i] ^= key[i];
4002 chash_start(HMAC_SHA1, &h);
4003 chash_mid(HMAC_SHA1, &h, innerkey);
4004 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
4006 chash_start(HMAC_SHA1, &h);
4007 chash_mid(HMAC_SHA1, &h, outerkey);
4008 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
4010 /* Hashing is deemed sufficient to de-taint any input data */
4012 p = finalhash_hex = store_get(40, GET_UNTAINTED);
4013 for (int i = 0; i < 3; i++)
4015 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4016 *p++ = hex_digits[finalhash[i] & 0x0f];
4020 return finalhash_hex;
4026 /*************************************************
4027 * Join a file onto the output string *
4028 *************************************************/
4030 /* This is used for readfile/readsock and after a run expansion.
4031 It joins the contents of a file onto the output string, globally replacing
4032 newlines with a given string (optionally).
4036 yield pointer to the expandable string struct
4037 eol newline replacement string, or NULL
4039 Returns: new pointer for expandable string, terminated if non-null
4043 cat_file(FILE * f, gstring * yield, uschar * eol)
4045 uschar buffer[1024];
4047 while (Ufgets(buffer, sizeof(buffer), f))
4049 int len = Ustrlen(buffer);
4050 if (eol && buffer[len-1] == '\n') len--;
4051 yield = string_catn(yield, buffer, len);
4052 if (eol && buffer[len])
4053 yield = string_cat(yield, eol);
4061 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
4064 uschar buffer[1024];
4066 /*XXX could we read direct into a pre-grown string? */
4068 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
4069 for (uschar * s = buffer; rc--; s++)
4070 yield = eol && *s == '\n'
4071 ? string_cat(yield, eol) : string_catn(yield, s, 1);
4073 /* We assume that all errors, and any returns of zero bytes,
4074 are actually EOF. */
4081 /*************************************************
4082 * Evaluate numeric expression *
4083 *************************************************/
4085 /* This is a set of mutually recursive functions that evaluate an arithmetic
4086 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
4087 these functions that is called from elsewhere is eval_expr, whose interface is:
4090 sptr pointer to the pointer to the string - gets updated
4091 decimal TRUE if numbers are to be assumed decimal
4092 error pointer to where to put an error message - must be NULL on input
4093 endket TRUE if ')' must terminate - FALSE for external call
4095 Returns: on success: the value of the expression, with *error still NULL
4096 on failure: an undefined value, with *error = a message
4099 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4102 static int_eximarith_t
4103 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4106 int_eximarith_t x = eval_op_or(&s, decimal, error);
4111 *error = US"expecting closing parenthesis";
4113 while (isspace(*++s));
4115 *error = US"expecting operator";
4121 static int_eximarith_t
4122 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4128 if (isdigit((c = Uskip_whitespace(&s))))
4131 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4133 switch (tolower(*s))
4136 case 'k': n *= 1024; s++; break;
4137 case 'm': n *= 1024*1024; s++; break;
4138 case 'g': n *= 1024*1024*1024; s++; break;
4140 Uskip_whitespace(&s);
4145 n = eval_expr(&s, decimal, error, 1);
4149 *error = US"expecting number or opening parenthesis";
4157 static int_eximarith_t
4158 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4162 Uskip_whitespace(&s);
4163 if (*s == '+' || *s == '-' || *s == '~')
4166 x = eval_op_unary(&s, decimal, error);
4167 if (op == '-') x = -x;
4168 else if (op == '~') x = ~x;
4171 x = eval_number(&s, decimal, error);
4178 static int_eximarith_t
4179 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4182 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4185 while (*s == '*' || *s == '/' || *s == '%')
4188 int_eximarith_t y = eval_op_unary(&s, decimal, error);
4190 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4191 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4192 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4193 * -N*M is INT_MIN will yield INT_MIN.
4194 * Since we don't support floating point, this is somewhat simpler.
4195 * Ideally, we'd return an error, but since we overflow for all other
4196 * arithmetic, consistency suggests otherwise, but what's the correct value
4197 * to use? There is none.
4198 * The C standard guarantees overflow for unsigned arithmetic but signed
4199 * overflow invokes undefined behaviour; in practice, this is overflow
4200 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4201 * that long/longlong larger than int are available, or we could just work
4202 * with larger types. We should consider whether to guarantee 32bit eval
4203 * and 64-bit working variables, with errors returned. For now ...
4204 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4205 * can just let the other invalid results occur otherwise, as they have
4206 * until now. For this one case, we can coerce.
4208 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4211 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4212 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4222 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4238 static int_eximarith_t
4239 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4242 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4245 while (*s == '+' || *s == '-')
4248 int_eximarith_t y = eval_op_mult(&s, decimal, error);
4250 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4251 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4252 { /* over-conservative check */
4254 ? US"overflow in sum" : US"overflow in difference";
4257 if (op == '+') x += y; else x -= y;
4265 static int_eximarith_t
4266 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4269 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4272 while ((*s == '<' || *s == '>') && s[1] == s[0])
4277 y = eval_op_sum(&s, decimal, error);
4279 if (op == '<') x <<= y; else x >>= y;
4287 static int_eximarith_t
4288 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4291 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4298 y = eval_op_shift(&s, decimal, error);
4308 static int_eximarith_t
4309 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4312 int_eximarith_t x = eval_op_and(&s, decimal, error);
4319 y = eval_op_and(&s, decimal, error);
4329 static int_eximarith_t
4330 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4333 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4340 y = eval_op_xor(&s, decimal, error);
4351 /************************************************/
4352 /* Comparison operation for sort expansion. We need to avoid
4353 re-expanding the fields being compared, so need a custom routine.
4356 cond_type Comparison operator code
4357 leftarg, rightarg Arguments for comparison
4359 Return true iff (leftarg compare rightarg)
4363 sortsbefore(int cond_type, BOOL alpha_cond,
4364 const uschar * leftarg, const uschar * rightarg)
4366 int_eximarith_t l_num, r_num;
4370 l_num = expanded_string_integer(leftarg, FALSE);
4371 if (expand_string_message) return FALSE;
4372 r_num = expanded_string_integer(rightarg, FALSE);
4373 if (expand_string_message) return FALSE;
4377 case ECOND_NUM_G: return l_num > r_num;
4378 case ECOND_NUM_GE: return l_num >= r_num;
4379 case ECOND_NUM_L: return l_num < r_num;
4380 case ECOND_NUM_LE: return l_num <= r_num;
4387 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4388 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4389 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4390 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4391 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4392 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4393 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4394 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4397 return FALSE; /* should not happen */
4401 /* Expand a named list. Return false on failure. */
4403 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4405 tree_node *t = NULL;
4406 const uschar * list;
4409 BOOL needsep = FALSE;
4410 #define LISTNAMED_BUF_SIZE 256
4411 uschar b[LISTNAMED_BUF_SIZE];
4412 uschar * buffer = b;
4414 if (*name == '+') name++;
4415 if (!listtype) /* no-argument version */
4417 if ( !(t = tree_search(addresslist_anchor, name))
4418 && !(t = tree_search(domainlist_anchor, name))
4419 && !(t = tree_search(hostlist_anchor, name)))
4420 t = tree_search(localpartlist_anchor, name);
4422 else switch(*listtype) /* specific list-type version */
4424 case 'a': t = tree_search(addresslist_anchor, name); break;
4425 case 'd': t = tree_search(domainlist_anchor, name); break;
4426 case 'h': t = tree_search(hostlist_anchor, name); break;
4427 case 'l': t = tree_search(localpartlist_anchor, name); break;
4429 expand_string_message = US"bad suffix on \"list\" operator";
4435 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4437 : *listtype=='a'?"address "
4438 : *listtype=='d'?"domain "
4439 : *listtype=='h'?"host "
4440 : *listtype=='l'?"localpart "
4445 list = ((namedlist_block *)(t->data.ptr))->string;
4447 /* The list could be quite long so we (re)use a buffer for each element
4448 rather than getting each in new memory */
4450 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, GET_TAINTED);
4451 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4453 uschar * buf = US" : ";
4455 yield = string_catn(yield, buf, 3);
4459 if (*item == '+') /* list item is itself a named list */
4461 yield = expand_listnamed(yield, item, listtype);
4462 if (expand_string_message)
4466 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
4469 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4471 for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4473 yield = string_catn(yield, item, cp - CS item);
4474 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4475 yield = string_catn(yield, US"::", 2);
4476 else /* sep in item; should already be doubled; emit once */
4478 yield = string_catn(yield, US tok, 1);
4479 if (*cp == sep) cp++;
4482 yield = string_cat(yield, item);
4485 yield = string_cat(yield, item);
4492 /************************************************/
4494 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4498 debug_printf_indent("|");
4500 debug_printf_indent(UTF8_VERT_RIGHT);
4502 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4506 debug_printf(UTF8_HORIZ);
4508 debug_printf("%s: %.*s\n", what, nchar, value);
4509 if (is_tainted(value))
4512 debug_printf_indent("%s \\__", skipping ? "| " : " ");
4514 debug_printf_indent("%s",
4516 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
4517 debug_printf("(tainted)\n");
4522 /*************************************************
4524 *************************************************/
4526 /* Returns either an unchanged string, or the expanded string in stacking pool
4527 store. Interpreted sequences are:
4529 \... normal escaping rules
4530 $name substitutes the variable
4532 ${op:string} operates on the expanded string value
4533 ${item{arg1}{arg2}...} expands the args and then does the business
4534 some literal args are not enclosed in {}
4536 There are now far too many operators and item types to make it worth listing
4537 them here in detail any more.
4539 We use an internal routine recursively to handle embedded substrings. The
4540 external function follows. The yield is NULL if the expansion failed, and there
4541 are two cases: if something collapsed syntactically, or if "fail" was given
4542 as the action on a lookup failure. These can be distinguished by looking at the
4543 variable expand_string_forcedfail, which is TRUE in the latter case.
4545 The skipping flag is set true when expanding a substring that isn't actually
4546 going to be used (after "if" or "lookup") and it prevents lookups from
4547 happening lower down.
4549 Store usage: At start, a store block of the length of the input plus 64
4550 is obtained. This is expanded as necessary by string_cat(), which might have to
4551 get a new block, or might be able to expand the original. At the end of the
4552 function we can release any store above that portion of the yield block that
4553 was actually used. In many cases this will be optimal.
4555 However: if the first item in the expansion is a variable name or header name,
4556 we reset the store before processing it; if the result is in fresh store, we
4557 use that without copying. This is helpful for expanding strings like
4558 $message_headers which can get very long.
4560 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4561 since resetting the store at the end of the expansion will free store that was
4562 allocated by the plugin code as well as the slop after the expanded string. So
4563 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4564 and, given the acl condition, ${if }. This is an unfortunate consequence of
4565 string expansion becoming too powerful.
4568 string the string to be expanded
4570 brace_ends expansion is to stop at }
4571 honour_dollar TRUE if $ is to be expanded,
4572 FALSE if it's just another character
4573 skipping TRUE for recursive calls when the value isn't actually going
4574 to be used (to allow for optimisation)
4575 left if not NULL, a pointer to the first character after the
4576 expansion is placed here (typically used with brace_ends)
4577 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4579 textonly_p if not NULL, pointer to flag - write bool for only-met-text
4581 Returns: NULL if expansion fails:
4582 expand_string_forcedfail is set TRUE if failure was forced
4583 expand_string_message contains a textual error message
4584 a pointer to the expanded string on success
4588 expand_string_internal(const uschar * string, esi_flags flags, const uschar ** left,
4589 BOOL *resetok_p, BOOL * textonly_p)
4591 rmark reset_point = store_mark();
4592 gstring * yield = string_get(Ustrlen(string) + 64);
4594 const uschar * s = string;
4595 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4596 int save_expand_nlength[EXPAND_MAXN+1];
4597 BOOL resetok = TRUE, first = TRUE, textonly = TRUE;
4600 f.expand_string_forcedfail = FALSE;
4601 expand_string_message = US"";
4603 if (is_tainted(string))
4605 expand_string_message =
4606 string_sprintf("attempt to expand tainted string '%s'", s);
4607 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4618 debug_printf_indent("%c%s: %s\n",
4620 flags & ESI_SKIPPING ? "---scanning" : "considering", s);
4622 debug_printf_indent("%s%s: %s\n",
4623 first ? UTF8_DOWN_RIGHT : UTF8_VERT_RIGHT,
4624 flags & ESI_SKIPPING
4625 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4631 /* \ escapes the next character, which must exist, or else
4632 the expansion fails. There's a special escape, \N, which causes
4633 copying of the subject verbatim up to the next \N. Otherwise,
4634 the escapes are the standard set. */
4640 expand_string_message = US"\\ at end of string";
4646 const uschar * t = s + 2;
4647 for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4650 debug_expansion_interim(US"protected", t, (int)(s - t), !!(flags & ESI_SKIPPING));
4651 yield = string_catn(yield, t, s - t);
4659 debug_printf_indent("|backslashed: '\\%c'\n", s[1]);
4661 debug_printf_indent(UTF8_VERT_RIGHT "backslashed: '\\%c'\n", s[1]);
4662 ch[0] = string_interpret_escape(&s);
4664 yield = string_catn(yield, ch, 1);
4670 /* Anything other than $ is just copied verbatim, unless we are
4671 looking for a terminating } character. */
4673 if (flags & ESI_BRACE_ENDS && *s == '}') break;
4675 if (*s != '$' || !(flags & ESI_HONOR_DOLLAR))
4678 for (const uschar * t = s+1;
4679 *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4681 DEBUG(D_expand) debug_expansion_interim(US"text", s, i, !!(flags & ESI_SKIPPING));
4683 yield = string_catn(yield, s, i);
4689 /* No { after the $ - must be a plain name or a number for string
4690 match variable. There has to be a fudge for variables that are the
4691 names of header fields preceded by "$header_" because header field
4692 names can contain any printing characters except space and colon.
4693 For those that don't like typing this much, "$h_" is a synonym for
4694 "$header_". A non-existent header yields a NULL value; nothing is
4699 const uschar * value;
4700 int newsize = 0, len;
4704 s = read_name(name, sizeof(name), s, US"_");
4706 /* If this is the first thing to be expanded, release the pre-allocated
4710 g = store_get(sizeof(gstring), GET_UNTAINTED);
4711 else if (yield->ptr == 0)
4713 if (resetok) reset_point = store_reset(reset_point);
4715 reset_point = store_mark();
4716 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
4721 if ( ( *(t = name) == 'h'
4722 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4724 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4727 unsigned flags = *name == 'r' ? FH_WANT_RAW
4728 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4730 const uschar * charset = *name == 'b' ? NULL : headers_charset;
4732 s = read_header_name(name, sizeof(name), s);
4733 value = find_header(name, &newsize, flags, charset);
4735 /* If we didn't find the header, and the header contains a closing brace
4736 character, this may be a user error where the terminating colon
4737 has been omitted. Set a flag to adjust the error message in this case.
4738 But there is no error here - nothing gets inserted. */
4742 if (Ustrchr(name, '}')) malformed_header = TRUE;
4749 else if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
4751 expand_string_message =
4752 string_sprintf("unknown variable name \"%s\"", name);
4753 check_variable_error_message(name);
4757 /* If the data is known to be in a new buffer, newsize will be set to the
4758 size of that buffer. If this is the first thing in an expansion string,
4759 yield will be NULL; just point it at the new store instead of copying. Many
4760 expansion strings contain just one reference, so this is a useful
4761 optimization, especially for humungous headers. We need to use a gstring
4762 structure that is not allocated after that new-buffer, else a later store
4763 reset in the middle of the buffer will make it inaccessible. */
4765 len = Ustrlen(value);
4766 DEBUG(D_expand) debug_expansion_interim(US"value", value, len, !!(flags & ESI_SKIPPING));
4767 if (!yield && newsize != 0)
4770 yield->size = newsize;
4772 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4775 yield = string_catn(yield, value, len);
4780 if (isdigit(*s)) /* A $<n> variable */
4783 s = read_cnumber(&n, s);
4784 if (n >= 0 && n <= expand_nmax)
4786 DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], !!(flags & ESI_SKIPPING));
4787 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4792 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4794 if (*s != '{') /*}*/
4796 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4800 /* After { there can be various things, but they all start with
4801 an initial word, except for a number for a string match variable. */ /*}*/
4806 s = read_cnumber(&n, s); /*{{*/
4809 expand_string_message = US"} expected after number";
4812 if (n >= 0 && n <= expand_nmax)
4814 DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], !!(flags & ESI_SKIPPING));
4815 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4822 expand_string_message = US"letter or digit expected after ${"; /*}*/
4826 /* Allow "-" in names to cater for substrings with negative
4827 arguments. Since we are checking for known names after { this is
4830 s = read_name(name, sizeof(name), s, US"_-");
4831 item_type = chop_match(name, item_table, nelem(item_table));
4833 /* Switch on item type. All nondefault choices should "continue* when
4834 skipping, but "break" otherwise so we get debug output for the item
4837 int expansion_start = gstring_length(yield);
4840 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4841 If the ACL returns accept or reject we return content set by "message ="
4842 There is currently no limit on recursion; this would have us call
4843 acl_check_internal() directly and get a current level from somewhere.
4844 See also the acl expansion condition ECOND_ACL and the traditional
4845 acl modifier ACLC_ACL.
4846 Assume that the function has side-effects on the store that must be preserved.
4850 /* ${acl {name} {arg1}{arg2}...} */
4852 uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4856 switch(read_subs(sub, nelem(sub), 1, &s, flags, TRUE, name, &resetok, NULL))
4858 case -1: continue; /* skipping */
4859 case 1: goto EXPAND_FAILED_CURLY;
4861 case 3: goto EXPAND_FAILED;
4865 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4870 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4872 yield = string_cat(yield, user_msg);
4876 f.expand_string_forcedfail = TRUE;
4879 expand_string_message = string_sprintf("%s from acl \"%s\"",
4880 rc_names[rc], sub[0]);
4886 case EITEM_AUTHRESULTS:
4887 /* ${authresults {mysystemname}} */
4889 uschar * sub_arg[1];
4891 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4893 case -1: continue; /* If skipping, we don't actually do anything */
4894 case 1: goto EXPAND_FAILED_CURLY;
4896 case 3: goto EXPAND_FAILED;
4899 yield = string_append(yield, 3,
4900 US"Authentication-Results: ", sub_arg[0], US"; none");
4901 yield->ptr -= 6; /* ignore tha ": none" for now */
4903 yield = authres_local(yield, sub_arg[0]);
4904 yield = authres_iprev(yield);
4905 yield = authres_smtpauth(yield);
4907 yield = authres_spf(yield);
4909 #ifndef DISABLE_DKIM
4910 yield = authres_dkim(yield);
4912 #ifdef SUPPORT_DMARC
4913 yield = authres_dmarc(yield);
4915 #ifdef EXPERIMENTAL_ARC
4916 yield = authres_arc(yield);
4921 /* Handle conditionals - preserve the values of the numerical expansion
4922 variables in case they get changed by a regular expression match in the
4923 condition. If not, they retain their external settings. At the end
4924 of this "if" section, they get restored to their previous values. */
4929 const uschar *next_s;
4930 int save_expand_nmax =
4931 save_expand_strings(save_expand_nstring, save_expand_nlength);
4932 uschar * save_lookup_value = lookup_value;
4934 Uskip_whitespace(&s);
4935 if (!(next_s = eval_condition(s, &resetok, flags & ESI_SKIPPING ? NULL : &cond)))
4936 goto EXPAND_FAILED; /* message already set */
4940 debug_expansion_interim(US"condition", s, (int)(next_s - s), !!(flags & ESI_SKIPPING));
4941 debug_expansion_interim(US"result",
4942 cond ? US"true" : US"false", cond ? 4 : 5, !!(flags & ESI_SKIPPING));
4947 /* The handling of "yes" and "no" result strings is now in a separate
4948 function that is also used by ${lookup} and ${extract} and ${run}. */
4950 switch(process_yesno(
4951 flags, /* were previously skipping */
4952 cond, /* success/failure indicator */
4953 lookup_value, /* value to reset for string2 */
4954 &s, /* input pointer */
4955 &yield, /* output pointer */
4956 US"if", /* condition type */
4959 case 1: goto EXPAND_FAILED; /* when all is well, the */
4960 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4963 /* Restore external setting of expansion variables for continuation
4966 lookup_value = save_lookup_value;
4967 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4968 save_expand_nlength);
4973 case EITEM_IMAPFOLDER:
4974 { /* ${imapfolder {name}{sep}{specials}} */
4978 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4980 case 1: goto EXPAND_FAILED_CURLY;
4982 case 3: goto EXPAND_FAILED;
4985 if (!sub_arg[1]) /* One argument */
4987 sub_arg[1] = US"/"; /* default separator */
4990 else if (Ustrlen(sub_arg[1]) != 1)
4992 expand_string_message =
4994 "IMAP folder separator must be one character, found \"%s\"",
4999 if (flags & ESI_SKIPPING) continue;
5001 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
5002 sub_arg[1][0], sub_arg[2], &expand_string_message)))
5004 yield = string_cat(yield, encoded);
5009 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
5010 expanding an internal string that isn't actually going to be used. All we
5011 need to do is check the syntax, so don't do a lookup at all. Preserve the
5012 values of the numerical expansion variables in case they get changed by a
5013 partial lookup. If not, they retain their external settings. At the end
5014 of this "lookup" section, they get restored to their previous values. */
5018 int stype, partial, affixlen, starflags;
5019 int expand_setup = 0;
5021 uschar * key, * filename;
5022 const uschar * affix, * opts;
5023 uschar * save_lookup_value = lookup_value;
5024 int save_expand_nmax =
5025 save_expand_strings(save_expand_nstring, save_expand_nlength);
5027 if (expand_forbid & RDO_LOOKUP)
5029 expand_string_message = US"lookup expansions are not permitted";
5033 /* Get the key we are to look up for single-key+file style lookups.
5034 Otherwise set the key NULL pro-tem. */
5036 if (Uskip_whitespace(&s) == '{') /*}*/
5038 key = expand_string_internal(s+1,
5039 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
5040 if (!key) goto EXPAND_FAILED; /*{{*/
5043 expand_string_message = US"missing '}' after lookup key";
5044 goto EXPAND_FAILED_CURLY;
5046 Uskip_whitespace(&s);
5050 /* Find out the type of database */
5054 expand_string_message = US"missing lookup type";
5058 /* The type is a string that may contain special characters of various
5059 kinds. Allow everything except space or { to appear; the actual content
5060 is checked by search_findtype_partial. */ /*}*/
5062 while (*s && *s != '{' && !isspace(*s)) /*}*/
5064 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
5067 name[nameptr] = '\0';
5068 Uskip_whitespace(&s);
5070 /* Now check for the individual search type and any partial or default
5071 options. Only those types that are actually in the binary are valid. */
5073 if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
5074 &starflags, &opts)) < 0)
5076 expand_string_message = search_error_message;
5080 /* Check that a key was provided for those lookup types that need it,
5081 and was not supplied for those that use the query style. */
5083 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
5087 expand_string_message = string_sprintf("missing {key} for single-"
5088 "key \"%s\" lookup", name);
5094 expand_string_message = string_sprintf("a single key was given for "
5095 "lookup type \"%s\", which is not a single-key lookup type", name);
5099 /* Get the next string in brackets and expand it. It is the file name for
5100 single-key+file lookups, and the whole query otherwise. In the case of
5101 queries that also require a file name (e.g. sqlite), the file name comes
5106 expand_string_message = US"missing '{' for lookup file-or-query arg";
5107 goto EXPAND_FAILED_CURLY; /*}}*/
5109 if (!(filename = expand_string_internal(s+1,
5110 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5115 expand_string_message = US"missing '}' closing lookup file-or-query arg";
5116 goto EXPAND_FAILED_CURLY;
5118 Uskip_whitespace(&s);
5120 /* If this isn't a single-key+file lookup, re-arrange the variables
5121 to be appropriate for the search_ functions. For query-style lookups,
5122 there is just a "key", and no file name. For the special query-style +
5123 file types, the query (i.e. "key") starts with a file name. */
5126 key = search_args(stype, name, filename, &filename, opts);
5128 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5129 the entry was not found. Note that there is no search_close() function.
5130 Files are left open in case of re-use. At suitable places in higher logic,
5131 search_tidyup() is called to tidy all open files. This can save opening
5132 the same file several times. However, files may also get closed when
5133 others are opened, if too many are open at once. The rule is that a
5134 handle should not be used after a second search_open().
5136 Request that a partial search sets up $1 and maybe $2 by passing
5137 expand_setup containing zero. If its value changes, reset expand_nmax,
5138 since new variables will have been set. Note that at the end of this
5139 "lookup" section, the old numeric variables are restored. */
5141 if (flags & ESI_SKIPPING)
5142 lookup_value = NULL;
5145 void * handle = search_open(filename, stype, 0, NULL, NULL);
5148 expand_string_message = search_error_message;
5151 lookup_value = search_find(handle, filename, key, partial, affix,
5152 affixlen, starflags, &expand_setup, opts);
5153 if (f.search_find_defer)
5155 expand_string_message =
5156 string_sprintf("lookup of \"%s\" gave DEFER: %s",
5157 string_printing2(key, SP_TAB), search_error_message);
5160 if (expand_setup > 0) expand_nmax = expand_setup;
5163 /* The handling of "yes" and "no" result strings is now in a separate
5164 function that is also used by ${if} and ${extract}. */
5166 switch(process_yesno(
5167 flags, /* were previously skipping */
5168 lookup_value != NULL, /* success/failure indicator */
5169 save_lookup_value, /* value to reset for string2 */
5170 &s, /* input pointer */
5171 &yield, /* output pointer */
5172 US"lookup", /* condition type */
5175 case 1: goto EXPAND_FAILED; /* when all is well, the */
5176 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5179 /* Restore external setting of expansion variables for carrying on
5180 at this level, and continue. */
5182 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5183 save_expand_nlength);
5185 if (flags & ESI_SKIPPING) continue;
5189 /* If Perl support is configured, handle calling embedded perl subroutines,
5190 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5191 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5192 arguments (defined below). */
5194 #define EXIM_PERL_MAX_ARGS 8
5198 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
5199 "is not included in this binary";
5202 #else /* EXIM_PERL */
5204 uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5205 gstring * new_yield;
5207 if (expand_forbid & RDO_PERL)
5209 expand_string_message = US"Perl calls are not permitted";
5213 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, flags, TRUE,
5214 name, &resetok, NULL))
5216 case -1: continue; /* If skipping, we don't actually do anything */
5217 case 1: goto EXPAND_FAILED_CURLY;
5219 case 3: goto EXPAND_FAILED;
5222 /* Start the interpreter if necessary */
5224 if (!opt_perl_started)
5227 if (!opt_perl_startup)
5229 expand_string_message = US"A setting of perl_startup is needed when "
5230 "using the Perl interpreter";
5233 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5234 if ((initerror = init_perl(opt_perl_startup)))
5236 expand_string_message =
5237 string_sprintf("error in perl_startup code: %s\n", initerror);
5240 opt_perl_started = TRUE;
5243 /* Call the function */
5245 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5246 new_yield = call_perl_cat(yield, &expand_string_message,
5247 sub_arg[0], sub_arg + 1);
5249 /* NULL yield indicates failure; if the message pointer has been set to
5250 NULL, the yield was undef, indicating a forced failure. Otherwise the
5251 message will indicate some kind of Perl error. */
5255 if (!expand_string_message)
5257 expand_string_message =
5258 string_sprintf("Perl subroutine \"%s\" returned undef to force "
5259 "failure", sub_arg[0]);
5260 f.expand_string_forcedfail = TRUE;
5265 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5266 set during a callback from Perl. */
5268 f.expand_string_forcedfail = FALSE;
5272 #endif /* EXIM_PERL */
5274 /* Transform email address to "prvs" scheme to use
5275 as BATV-signed return path */
5279 uschar * sub_arg[3], * p, * domain;
5281 switch(read_subs(sub_arg, 3, 2, &s, flags, TRUE, name, &resetok, NULL))
5283 case -1: continue; /* If skipping, we don't actually do anything */
5284 case 1: goto EXPAND_FAILED_CURLY;
5286 case 3: goto EXPAND_FAILED;
5289 /* sub_arg[0] is the address */
5290 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
5291 || domain == sub_arg[0] || Ustrlen(domain) == 1)
5293 expand_string_message = US"prvs first argument must be a qualified email address";
5297 /* Calculate the hash. The third argument must be a single-digit
5298 key number, or unset. */
5301 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5303 expand_string_message = US"prvs third argument must be a single digit";
5307 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5310 expand_string_message = US"prvs hmac-sha1 conversion failed";
5314 /* Now separate the domain from the local part */
5317 yield = string_catn(yield, US"prvs=", 5);
5318 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5319 yield = string_catn(yield, prvs_daystamp(7), 3);
5320 yield = string_catn(yield, p, 6);
5321 yield = string_catn(yield, US"=", 1);
5322 yield = string_cat (yield, sub_arg[0]);
5323 yield = string_catn(yield, US"@", 1);
5324 yield = string_cat (yield, domain);
5329 /* Check a prvs-encoded address for validity */
5331 case EITEM_PRVSCHECK:
5333 uschar * sub_arg[3], * p;
5335 const pcre2_code * re;
5337 /* Reset expansion variables */
5338 prvscheck_result = NULL;
5339 prvscheck_address = NULL;
5340 prvscheck_keynum = NULL;
5342 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5344 case 1: goto EXPAND_FAILED_CURLY;
5346 case 3: goto EXPAND_FAILED;
5349 re = regex_must_compile(
5350 US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5351 MCS_CASELESS | MCS_CACHEABLE, FALSE);
5353 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5355 uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5356 uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5357 uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5358 uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5359 uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5363 debug_printf_indent("prvscheck localpart: %s\n", local_part);
5364 debug_printf_indent("prvscheck key number: %s\n", key_num);
5365 debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5366 debug_printf_indent("prvscheck hash: %s\n", hash);
5367 debug_printf_indent("prvscheck domain: %s\n", domain);
5370 /* Set up expansion variables */
5371 g = string_cat (NULL, local_part);
5372 g = string_catn(g, US"@", 1);
5373 g = string_cat (g, domain);
5374 prvscheck_address = string_from_gstring(g);
5375 prvscheck_keynum = string_copy(key_num);
5377 /* Now expand the second argument */
5378 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5380 case 1: goto EXPAND_FAILED_CURLY;
5382 case 3: goto EXPAND_FAILED;
5385 /* Now we have the key and can check the address. */
5387 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5391 expand_string_message = US"hmac-sha1 conversion failed";
5395 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5396 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
5398 if (Ustrcmp(p,hash) == 0)
5400 /* Success, valid BATV address. Now check the expiry date. */
5401 uschar *now = prvs_daystamp(0);
5402 unsigned int inow = 0,iexpire = 1;
5404 (void)sscanf(CS now,"%u",&inow);
5405 (void)sscanf(CS daystamp,"%u",&iexpire);
5407 /* When "iexpire" is < 7, a "flip" has occurred.
5408 Adjust "inow" accordingly. */
5409 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5411 if (iexpire >= inow)
5413 prvscheck_result = US"1";
5414 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $prvscheck_result set to 1\n");
5418 prvscheck_result = NULL;
5419 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $prvscheck_result unset\n");
5424 prvscheck_result = NULL;
5425 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $prvscheck_result unset\n");
5428 /* Now expand the final argument. We leave this till now so that
5429 it can include $prvscheck_result. */
5431 switch(read_subs(sub_arg, 1, 0, &s, flags, TRUE, name, &resetok, NULL))
5433 case 1: goto EXPAND_FAILED_CURLY;
5435 case 3: goto EXPAND_FAILED;
5438 yield = string_cat(yield,
5439 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5441 /* Reset the "internal" variables afterwards, because they are in
5442 dynamic store that will be reclaimed if the expansion succeeded. */
5444 prvscheck_address = NULL;
5445 prvscheck_keynum = NULL;
5448 /* Does not look like a prvs encoded address, return the empty string.
5449 We need to make sure all subs are expanded first, so as to skip over
5452 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5454 case 1: goto EXPAND_FAILED_CURLY;
5456 case 3: goto EXPAND_FAILED;
5459 if (flags & ESI_SKIPPING) continue;
5463 /* Handle "readfile" to insert an entire file */
5465 case EITEM_READFILE:
5468 uschar * sub_arg[2];
5470 if ((expand_forbid & RDO_READFILE) != 0)
5472 expand_string_message = US"file insertions are not permitted";
5476 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5478 case -1: continue; /* If skipping, we don't actually do anything */
5479 case 1: goto EXPAND_FAILED_CURLY;
5481 case 3: goto EXPAND_FAILED;
5484 /* Open the file and read it */
5486 if (!(f = Ufopen(sub_arg[0], "rb")))
5488 expand_string_message = string_open_failed("%s", sub_arg[0]);
5492 yield = cat_file(f, yield, sub_arg[1]);
5497 /* Handle "readsocket" to insert data from a socket, either
5498 Inet or Unix domain */
5500 case EITEM_READSOCK:
5503 uschar * sub_arg[4];
5505 if (expand_forbid & RDO_READSOCK)
5507 expand_string_message = US"socket insertions are not permitted";
5511 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5512 because there may be a string for expansion on failure. */
5514 switch(read_subs(sub_arg, 4, 2, &s, flags, FALSE, name, &resetok, NULL))
5516 case 1: goto EXPAND_FAILED_CURLY;
5517 case 2: /* Won't occur: no end check */
5518 case 3: goto EXPAND_FAILED;
5521 /* If skipping, we don't actually do anything. Otherwise, arrange to
5522 connect to either an IP or a Unix socket. */
5524 if (!(flags & ESI_SKIPPING))
5526 int stype = search_findtype(US"readsock", 8);
5529 int expand_setup = -1;
5532 /* If the reqstr is empty, flag that and set a dummy */
5536 g = string_append_listele(g, ',', US"send=no");
5537 sub_arg[1] = US"DUMMY";
5540 /* Re-marshall the options */
5544 const uschar * list = sub_arg[2];
5548 /* First option has no tag and is timeout */
5549 if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5550 g = string_append_listele(g, ',',
5551 string_sprintf("timeout=%s", item));
5553 /* The rest of the options from the expansion */
5554 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5555 g = string_append_listele(g, ',', item);
5557 /* possibly plus an EOL string. Process with escapes, to protect
5558 from list-processing. The only current user of eol= in search
5559 options is the readsock expansion. */
5561 if (sub_arg[3] && *sub_arg[3])
5562 g = string_append_listele(g, ',',
5563 string_sprintf("eol=%s",
5564 string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5567 /* Gat a (possibly cached) handle for the connection */
5569 if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5571 if (*expand_string_message) goto EXPAND_FAILED;
5572 expand_string_message = search_error_message;
5573 search_error_message = NULL;
5577 /* Get (possibly cached) results for the lookup */
5578 /* sspec: sub_arg[0] req: sub_arg[1] opts: g */
5580 if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5581 &expand_setup, string_from_gstring(g))))
5582 yield = string_cat(yield, s);
5583 else if (f.search_find_defer)
5585 expand_string_message = search_error_message;
5586 search_error_message = NULL;
5590 { /* should not happen, at present */
5591 expand_string_message = search_error_message;
5592 search_error_message = NULL;
5597 /* The whole thing has worked (or we were skipping). If there is a
5598 failure string following, we need to skip it. */
5600 if (*s == '{') /*}*/
5602 if (!expand_string_internal(s+1,
5603 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL))
5604 goto EXPAND_FAILED; /*{*/
5607 expand_string_message = US"missing '}' closing failstring for readsocket";
5608 goto EXPAND_FAILED_CURLY;
5610 Uskip_whitespace(&s);
5613 READSOCK_DONE: /*{*/
5616 expand_string_message = US"missing '}' closing readsocket";
5617 goto EXPAND_FAILED_CURLY;
5619 if (flags & ESI_SKIPPING) continue;
5622 /* Come here on failure to create socket, connect socket, write to the
5623 socket, or timeout on reading. If another substring follows, expand and
5624 use it. Otherwise, those conditions give expand errors. */
5627 if (*s != '{') goto EXPAND_FAILED; /*}*/
5628 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5629 if (!(arg = expand_string_internal(s+1,
5630 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR, &s, &resetok, NULL)))
5632 yield = string_cat(yield, arg); /*{*/
5635 expand_string_message = US"missing '}' closing failstring for readsocket";
5636 goto EXPAND_FAILED_CURLY;
5638 Uskip_whitespace(&s);
5642 /* Handle "run" to execute a program. */
5647 const uschar * arg, ** argv;
5648 unsigned late_expand = TSUC_EXPAND_ARGS | TSUC_ALLOW_TAINTED_ARGS | TSUC_ALLOW_RECIPIENTS;
5650 if (expand_forbid & RDO_RUN)
5652 expand_string_message = US"running a command is not permitted";
5656 /* Handle options to the "run" */
5659 if (Ustrncmp(++s, "preexpand", 9) == 0)
5660 { late_expand = 0; s += 9; }
5663 const uschar * t = s;
5664 while (isalpha(*++t)) ;
5665 expand_string_message = string_sprintf("bad option '%.*s' for run",
5669 Uskip_whitespace(&s);
5671 if (*s != '{') /*}*/
5673 expand_string_message = US"missing '{' for command arg of run";
5674 goto EXPAND_FAILED_CURLY; /*"}*/
5678 if (late_expand) /* this is the default case */
5682 /* Locate the end of the args */
5683 (void) expand_string_internal(s,
5684 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &t, NULL, NULL);
5686 arg = flags & ESI_SKIPPING ? NULL : string_copyn(s, n);
5692 debug_printf_indent("args string for ${run} expand before split\n");
5693 if (!(arg = expand_string_internal(s,
5694 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5696 Uskip_whitespace(&s);
5701 expand_string_message = US"missing '}' closing command arg of run";
5702 goto EXPAND_FAILED_CURLY;
5705 if (flags & ESI_SKIPPING) /* Just pretend it worked when we're skipping */
5708 lookup_value = NULL;
5715 if (!transport_set_up_command(&argv, /* anchor for arg list */
5716 arg, /* raw command */
5717 late_expand, /* expand args if not already done */
5718 0, /* not relevant when... */
5719 NULL, /* no transporting address */
5720 US"${run} expansion", /* for error messages */
5721 &expand_string_message)) /* where to put error message */
5724 /* Create the child process, making it a group leader. */
5726 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5727 US"expand-run")) < 0)
5729 expand_string_message =
5730 string_sprintf("couldn't create child process: %s", strerror(errno));
5734 /* Nothing is written to the standard input. */
5738 /* Read the pipe to get the command's output into $value (which is kept
5739 in lookup_value). Read during execution, so that if the output exceeds
5740 the OS pipe buffer limit, we don't block forever. Remember to not release
5741 memory just allocated for $value. */
5744 f = fdopen(fd_out, "rb");
5745 sigalrm_seen = FALSE;
5747 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5751 /* Wait for the process to finish, applying the timeout, and inspect its
5752 return code for serious disasters. Simple non-zero returns are passed on.
5755 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5757 if (sigalrm_seen || runrc == -256)
5759 expand_string_message = US"command timed out";
5760 killpg(pid, SIGKILL); /* Kill the whole process group */
5763 else if (runrc == -257)
5764 expand_string_message = string_sprintf("wait() failed: %s",
5768 expand_string_message = string_sprintf("command killed by signal %d",
5775 /* Process the yes/no strings; $value may be useful in both cases */
5777 switch(process_yesno(
5778 flags, /* were previously skipping */
5779 runrc == 0, /* success/failure indicator */
5780 lookup_value, /* value to reset for string2 */
5781 &s, /* input pointer */
5782 &yield, /* output pointer */
5783 US"run", /* condition type */
5786 case 1: goto EXPAND_FAILED; /* when all is well, the */
5787 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5790 if (flags & ESI_SKIPPING) continue;
5794 /* Handle character translation for "tr" */
5798 int oldptr = gstring_length(yield);
5802 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5804 case -1: continue; /* skipping */
5805 case 1: goto EXPAND_FAILED_CURLY;
5807 case 3: goto EXPAND_FAILED;
5810 yield = string_cat(yield, sub[0]);
5811 o2m = Ustrlen(sub[2]) - 1;
5813 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5815 uschar * m = Ustrrchr(sub[1], yield->s[oldptr]);
5819 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5826 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5827 expanded arguments. */
5836 int val[2] = { 0, -1 };
5839 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5840 Ensure that sub[2] is set in the ${length } case. */
5843 switch(read_subs(sub, item_type == EITEM_LENGTH ? 2:3, 2, &s, flags,
5844 TRUE, name, &resetok, NULL))
5846 case -1: continue; /* skipping */
5847 case 1: goto EXPAND_FAILED_CURLY;
5849 case 3: goto EXPAND_FAILED;
5852 /* Juggle the arguments if there are only two of them: always move the
5853 string to the last position and make ${length{n}{str}} equivalent to
5854 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5860 if (item_type == EITEM_LENGTH)
5867 for (int i = 0; i < 2; i++) if (sub[i])
5869 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5870 if (*ret != 0 || (i != 0 && val[i] < 0))
5872 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5873 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5879 item_type == EITEM_HASH
5880 ? compute_hash(sub[2], val[0], val[1], &len)
5881 : item_type == EITEM_NHASH
5882 ? compute_nhash(sub[2], val[0], val[1], &len)
5883 : extract_substr(sub[2], val[0], val[1], &len);
5886 yield = string_catn(yield, ret, len);
5890 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5891 This code originally contributed by Steve Haslam. It currently supports
5892 the use of MD5 and SHA-1 hashes.
5894 We need some workspace that is large enough to handle all the supported
5895 hash types. Use macros to set the sizes rather than be too elaborate. */
5897 #define MAX_HASHLEN 20
5898 #define MAX_HASHBLOCKLEN 64
5907 int hashlen; /* Number of octets for the hash algorithm's output */
5908 int hashblocklen; /* Number of octets the hash algorithm processes */
5909 uschar * keyptr, * p;
5910 unsigned int keylen;
5912 uschar keyhash[MAX_HASHLEN];
5913 uschar innerhash[MAX_HASHLEN];
5914 uschar finalhash[MAX_HASHLEN];
5915 uschar finalhash_hex[2*MAX_HASHLEN];
5916 uschar innerkey[MAX_HASHBLOCKLEN];
5917 uschar outerkey[MAX_HASHBLOCKLEN];
5919 switch (read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5921 case -1: continue; /* skipping */
5922 case 1: goto EXPAND_FAILED_CURLY;
5924 case 3: goto EXPAND_FAILED;
5927 if (Ustrcmp(sub[0], "md5") == 0)
5930 use_base = &md5_base;
5934 else if (Ustrcmp(sub[0], "sha1") == 0)
5937 use_base = &sha1_ctx;
5943 expand_string_message =
5944 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5949 keylen = Ustrlen(keyptr);
5951 /* If the key is longer than the hash block length, then hash the key
5954 if (keylen > hashblocklen)
5956 chash_start(type, use_base);
5957 chash_end(type, use_base, keyptr, keylen, keyhash);
5962 /* Now make the inner and outer key values */
5964 memset(innerkey, 0x36, hashblocklen);
5965 memset(outerkey, 0x5c, hashblocklen);
5967 for (int i = 0; i < keylen; i++)
5969 innerkey[i] ^= keyptr[i];
5970 outerkey[i] ^= keyptr[i];
5973 /* Now do the hashes */
5975 chash_start(type, use_base);
5976 chash_mid(type, use_base, innerkey);
5977 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5979 chash_start(type, use_base);
5980 chash_mid(type, use_base, outerkey);
5981 chash_end(type, use_base, innerhash, hashlen, finalhash);
5983 /* Encode the final hash as a hex string */
5986 for (int i = 0; i < hashlen; i++)
5988 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5989 *p++ = hex_digits[finalhash[i] & 0x0f];
5992 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5993 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5995 yield = string_catn(yield, finalhash_hex, hashlen*2);
5999 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
6000 We have to save the numerical variables and restore them afterwards. */
6004 const pcre2_code * re;
6005 int moffset, moffsetextra, slen;
6006 pcre2_match_data * md;
6008 uschar * subject, * sub[3];
6009 int save_expand_nmax =
6010 save_expand_strings(save_expand_nstring, save_expand_nlength);
6011 unsigned sub_textonly = 0;
6013 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, &sub_textonly))
6015 case -1: continue; /* skipping */
6016 case 1: goto EXPAND_FAILED_CURLY;
6018 case 3: goto EXPAND_FAILED;
6021 /* Compile the regular expression */
6023 re = regex_compile(sub[1],
6024 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
6025 &expand_string_message, pcre_gen_cmp_ctx);
6029 md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
6031 /* Now run a loop to do the substitutions as often as necessary. It ends
6032 when there are no more matches. Take care over matches of the null string;
6033 do the same thing as Perl does. */
6036 slen = Ustrlen(sub[0]);
6037 moffset = moffsetextra = 0;
6042 PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
6043 int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
6044 PCRE_EOPT | emptyopt, md, pcre_gen_mtc_ctx);
6047 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
6048 is not necessarily the end. We want to repeat the match from one
6049 character further along, but leaving the basic offset the same (for
6050 copying below). We can't be at the end of the string - that was checked
6051 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
6052 finished; copy the remaining string and end the loop. */
6062 yield = string_catn(yield, subject+moffset, slen-moffset);
6066 /* Match - set up for expanding the replacement. */
6067 DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
6069 if (n == 0) n = EXPAND_MAXN + 1;
6071 for (int nn = 0; nn < n*2; nn += 2)
6073 expand_nstring[expand_nmax] = subject + ovec[nn];
6074 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
6078 /* Copy the characters before the match, plus the expanded insertion. */
6080 yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
6082 if (!(insert = expand_string(sub[2])))
6084 yield = string_cat(yield, insert);
6090 /* If we have matched an empty string, first check to see if we are at
6091 the end of the subject. If so, the loop is over. Otherwise, mimic
6092 what Perl's /g options does. This turns out to be rather cunning. First
6093 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
6094 string at the same point. If this fails (picked up above) we advance to
6095 the next character. */
6097 if (ovec[0] == ovec[1])
6099 if (ovec[0] == slen) break;
6100 emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
6104 /* All done - restore numerical variables. */
6106 /* pcre2_match_data_free(md); gen ctx needs no free */
6107 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6108 save_expand_nlength);
6112 /* Handle keyed and numbered substring extraction. If the first argument
6113 consists entirely of digits, then a numerical extraction is assumed. */
6117 int field_number = 1;
6118 BOOL field_number_set = FALSE;
6119 uschar * save_lookup_value = lookup_value, * sub[3];
6120 int save_expand_nmax =
6121 save_expand_strings(save_expand_nstring, save_expand_nlength);
6123 /* On reflection the original behaviour of extract-json for a string
6124 result, leaving it quoted, was a mistake. But it was already published,
6125 hence the addition of jsons. In a future major version, make json
6126 work like josons, and withdraw jsons. */
6128 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
6130 /* Check for a format-variant specifier */
6132 if (Uskip_whitespace(&s) != '{') /*}*/
6133 if (Ustrncmp(s, "json", 4) == 0)
6134 if (*(s += 4) == 's')
6135 {fmt = extract_jsons; s++;}
6139 /* While skipping we cannot rely on the data for expansions being
6140 available (eg. $item) hence cannot decide on numeric vs. keyed.
6141 Read a maximum of 5 arguments (including the yes/no) */
6143 if (flags & ESI_SKIPPING)
6145 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
6147 if (!expand_string_internal(s+1,
6148 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL))
6149 goto EXPAND_FAILED; /*'{'*/
6152 expand_string_message = US"missing '{' for arg of extract";
6153 goto EXPAND_FAILED_CURLY;
6155 Uskip_whitespace(&s);
6157 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
6158 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
6162 Uskip_whitespace(&s);
6166 expand_string_message = US"missing '}' closing extract";
6167 goto EXPAND_FAILED_CURLY;
6171 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
6173 if (Uskip_whitespace(&s) == '{') /*'}'*/
6175 if (!(sub[i] = expand_string_internal(s+1,
6176 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6177 goto EXPAND_FAILED; /*'{'*/
6180 expand_string_message = string_sprintf(
6181 "missing '}' closing arg %d of extract", i+1);
6182 goto EXPAND_FAILED_CURLY;
6185 /* After removal of leading and trailing white space, the first
6186 argument must not be empty; if it consists entirely of digits
6187 (optionally preceded by a minus sign), this is a numerical
6188 extraction, and we expect 3 arguments (normal) or 2 (json). */
6194 uschar * p = sub[0];
6196 Uskip_whitespace(&p);
6200 while (len > 0 && isspace(p[len-1])) len--;
6205 expand_string_message = US"first argument of \"extract\" must "
6215 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6219 if (fmt == extract_basic) j = 3; /* Need 3 args */
6220 field_number_set = TRUE;
6226 expand_string_message = string_sprintf(
6227 "missing '{' for arg %d of extract", i+1);
6228 goto EXPAND_FAILED_CURLY;
6232 /* Extract either the numbered or the keyed substring into $value. If
6233 skipping, just pretend the extraction failed. */
6235 if (flags & ESI_SKIPPING)
6236 lookup_value = NULL;
6240 lookup_value = field_number_set
6241 ? expand_gettokened(field_number, sub[1], sub[2])
6242 : expand_getkeyed(sub[0], sub[1]);
6249 const uschar * list;
6251 /* Array: Bracket-enclosed and comma-separated.
6252 Object: Brace-enclosed, comma-sep list of name:value pairs */
6254 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6256 expand_string_message =
6257 string_sprintf("%s wrapping %s for extract json",
6258 expand_string_message,
6259 field_number_set ? "array" : "object");
6260 goto EXPAND_FAILED_CURLY;
6264 if (field_number_set)
6266 if (field_number <= 0)
6268 expand_string_message = US"first argument of \"extract\" must "
6269 "be greater than zero";
6272 while (field_number > 0 && (item = json_nextinlist(&list)))
6274 if ((lookup_value = s = item))
6277 while (--s >= lookup_value && isspace(*s)) *s = '\0';
6282 lookup_value = NULL;
6283 while ((item = json_nextinlist(&list)))
6285 /* Item is: string name-sep value. string is quoted.
6286 Dequote the string and compare with the search key. */
6288 if (!(item = dewrap(item, US"\"\"")))
6290 expand_string_message =
6291 string_sprintf("%s wrapping string key for extract json",
6292 expand_string_message);
6293 goto EXPAND_FAILED_CURLY;
6295 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
6297 s = item + Ustrlen(item) + 1;
6298 if (Uskip_whitespace(&s) != ':')
6300 expand_string_message =
6301 US"missing object value-separator for extract json";
6302 goto EXPAND_FAILED_CURLY;
6305 Uskip_whitespace(&s);
6313 if ( fmt == extract_jsons
6315 && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6317 expand_string_message =
6318 string_sprintf("%s wrapping string result for extract jsons",
6319 expand_string_message);
6320 goto EXPAND_FAILED_CURLY;
6325 /* If no string follows, $value gets substituted; otherwise there can
6326 be yes/no strings, as for lookup or if. */
6328 switch(process_yesno(
6329 flags, /* were previously skipping */
6330 lookup_value != NULL, /* success/failure indicator */
6331 save_lookup_value, /* value to reset for string2 */
6332 &s, /* input pointer */
6333 &yield, /* output pointer */
6334 US"extract", /* condition type */
6337 case 1: goto EXPAND_FAILED; /* when all is well, the */
6338 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6341 /* All done - restore numerical variables. */
6343 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6344 save_expand_nlength);
6346 if (flags & ESI_SKIPPING) continue;
6350 /* return the Nth item from a list */
6352 case EITEM_LISTEXTRACT:
6354 int field_number = 1;
6355 uschar * save_lookup_value = lookup_value, * sub[2];
6356 int save_expand_nmax =
6357 save_expand_strings(save_expand_nstring, save_expand_nlength);
6359 /* Read the field & list arguments */
6360 /*XXX Could we use read_subs here (and get better efficiency for skipping)? */
6362 for (int i = 0; i < 2; i++)
6364 if (Uskip_whitespace(&s) != '{') /*}*/
6366 expand_string_message = string_sprintf(
6367 "missing '{' for arg %d of listextract", i+1); /*}*/
6368 goto EXPAND_FAILED_CURLY;
6371 sub[i] = expand_string_internal(s+1,
6372 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6373 if (!sub[i]) goto EXPAND_FAILED; /*{{*/
6376 expand_string_message = string_sprintf(
6377 "missing '}' closing arg %d of listextract", i+1);
6378 goto EXPAND_FAILED_CURLY;
6381 /* After removal of leading and trailing white space, the first
6382 argument must be numeric and nonempty. */
6390 Uskip_whitespace(&p);
6394 while (len > 0 && isspace(p[len-1])) len--;
6397 if (!*p && !(flags & ESI_SKIPPING))
6399 expand_string_message = US"first argument of \"listextract\" must "
6409 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6412 expand_string_message = US"first argument of \"listextract\" must "
6420 /* Extract the numbered element into $value. If
6421 skipping, just pretend the extraction failed. */
6423 lookup_value = flags & ESI_SKIPPING ? NULL : expand_getlistele(field_number, sub[1]);
6425 /* If no string follows, $value gets substituted; otherwise there can
6426 be yes/no strings, as for lookup or if. */
6428 switch(process_yesno(
6429 flags, /* were previously skipping */
6430 lookup_value != NULL, /* success/failure indicator */
6431 save_lookup_value, /* value to reset for string2 */
6432 &s, /* input pointer */
6433 &yield, /* output pointer */
6434 US"listextract", /* condition type */
6437 case 1: goto EXPAND_FAILED; /* when all is well, the */
6438 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6441 /* All done - restore numerical variables. */
6443 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6444 save_expand_nlength);
6446 if (flags & ESI_SKIPPING) continue;
6450 case EITEM_LISTQUOTE:
6453 switch(read_subs(sub, 2, 2, &s, flags, TRUE, name, &resetok, NULL))
6455 case -1: continue; /* skipping */
6456 case 1: goto EXPAND_FAILED_CURLY;
6458 case 3: goto EXPAND_FAILED;
6460 if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6462 if (c == sep) yield = string_catn(yield, sub[1], 1);
6463 yield = string_catn(yield, sub[1], 1);
6465 else yield = string_catn(yield, US" ", 1);
6470 case EITEM_CERTEXTRACT:
6472 uschar * save_lookup_value = lookup_value, * sub[2];
6473 int save_expand_nmax =
6474 save_expand_strings(save_expand_nstring, save_expand_nlength);
6476 /* Read the field argument */
6477 if (Uskip_whitespace(&s) != '{') /*}*/
6479 expand_string_message = US"missing '{' for field arg of certextract";
6480 goto EXPAND_FAILED_CURLY; /*}*/
6482 sub[0] = expand_string_internal(s+1,
6483 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6484 if (!sub[0]) goto EXPAND_FAILED; /*{{*/
6487 expand_string_message = US"missing '}' closing field arg of certextract";
6488 goto EXPAND_FAILED_CURLY;
6490 /* strip spaces fore & aft */
6495 Uskip_whitespace(&p);
6499 while (len > 0 && isspace(p[len-1])) len--;
6503 /* inspect the cert argument */
6504 if (Uskip_whitespace(&s) != '{') /*}*/
6506 expand_string_message = US"missing '{' for cert variable arg of certextract";
6507 goto EXPAND_FAILED_CURLY; /*}*/
6511 expand_string_message = US"second argument of \"certextract\" must "
6512 "be a certificate variable";
6515 sub[1] = expand_string_internal(s+1,
6516 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6517 if (!sub[1]) goto EXPAND_FAILED; /*{{*/
6520 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6521 goto EXPAND_FAILED_CURLY;
6524 if (flags & ESI_SKIPPING)
6525 lookup_value = NULL;
6528 lookup_value = expand_getcertele(sub[0], sub[1]);
6529 if (*expand_string_message) goto EXPAND_FAILED;
6531 switch(process_yesno(
6532 flags, /* were previously skipping */
6533 lookup_value != NULL, /* success/failure indicator */
6534 save_lookup_value, /* value to reset for string2 */
6535 &s, /* input pointer */
6536 &yield, /* output pointer */
6537 US"certextract", /* condition type */
6540 case 1: goto EXPAND_FAILED; /* when all is well, the */
6541 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6544 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6545 save_expand_nlength);
6546 if (flags & ESI_SKIPPING) continue;
6549 #endif /*DISABLE_TLS*/
6551 /* Handle list operations */
6557 int sep = 0, save_ptr = gstring_length(yield);
6558 uschar outsep[2] = { '\0', '\0' };
6559 const uschar *list, *expr, *temp;
6560 uschar * save_iterate_item = iterate_item;
6561 uschar * save_lookup_value = lookup_value;
6563 Uskip_whitespace(&s);
6564 if (*s++ != '{') /*}*/
6566 expand_string_message =
6567 string_sprintf("missing '{' for first arg of %s", name);
6568 goto EXPAND_FAILED_CURLY; /*}*/
6571 if (!(list = expand_string_internal(s,
6572 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6573 goto EXPAND_FAILED; /*{{*/
6576 expand_string_message =
6577 string_sprintf("missing '}' closing first arg of %s", name);
6578 goto EXPAND_FAILED_CURLY;
6581 if (item_type == EITEM_REDUCE)
6584 Uskip_whitespace(&s);
6585 if (*s++ != '{') /*}*/
6587 expand_string_message = US"missing '{' for second arg of reduce";
6588 goto EXPAND_FAILED_CURLY; /*}*/
6590 t = expand_string_internal(s,
6591 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6592 if (!t) goto EXPAND_FAILED;
6593 lookup_value = t; /*{{*/
6596 expand_string_message = US"missing '}' closing second arg of reduce";
6597 goto EXPAND_FAILED_CURLY;
6601 Uskip_whitespace(&s);
6602 if (*s++ != '{') /*}*/
6604 expand_string_message =
6605 string_sprintf("missing '{' for last arg of %s", name); /*}*/
6606 goto EXPAND_FAILED_CURLY;
6611 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6612 if scanning a "false" part). This allows us to find the end of the
6613 condition, because if the list is empty, we won't actually evaluate the
6614 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6615 the normal internal expansion function. */
6617 if (item_type != EITEM_FILTER)
6618 temp = expand_string_internal(s,
6619 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL);
6621 if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6625 expand_string_message = string_sprintf("%s inside \"%s\" item",
6626 expand_string_message, name);
6630 Uskip_whitespace(&s); /*{{{*/
6633 expand_string_message = string_sprintf("missing } at end of condition "
6634 "or expression inside \"%s\"; could be an unquoted } in the content",
6639 Uskip_whitespace(&s); /*{{*/
6642 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6647 /* If we are skipping, we can now just move on to the next item. When
6648 processing for real, we perform the iteration. */
6650 if (flags & ESI_SKIPPING) continue;
6651 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6653 *outsep = (uschar)sep; /* Separator as a string */
6655 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6656 name, iterate_item, lookup_value);
6658 if (item_type == EITEM_FILTER)
6661 /* the condition could modify $value, as a side-effect */
6662 uschar * save_value = lookup_value;
6664 if (!eval_condition(expr, &resetok, &condresult))
6666 iterate_item = save_iterate_item;
6667 lookup_value = save_lookup_value;
6668 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6669 expand_string_message, name);
6672 lookup_value = save_value;
6673 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6674 condresult? "true":"false");
6676 temp = iterate_item; /* TRUE => include this item */
6678 continue; /* FALSE => skip this item */
6681 else /* EITEM_MAP and EITEM_REDUCE */
6683 /* the expansion could modify $value, as a side-effect */
6684 uschar * t = expand_string_internal(expr,
6685 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, NULL, &resetok, NULL);
6688 iterate_item = save_iterate_item;
6689 expand_string_message = string_sprintf("%s inside \"%s\" item",
6690 expand_string_message, name);
6693 if (item_type == EITEM_REDUCE)
6695 lookup_value = t; /* Update the value of $value */
6696 continue; /* and continue the iteration */
6700 /* We reach here for FILTER if the condition is true, always for MAP,
6701 and never for REDUCE. The value in "temp" is to be added to the output
6702 list that is being created, ensuring that any occurrences of the
6703 separator character are doubled. Unless we are dealing with the first
6704 item of the output list, add in a space if the new item begins with the
6705 separator character, or is an empty string. */
6707 /*XXX is there not a standard support function for this, appending to a list? */
6708 /* yes, string_append_listele(), but it depends on lack of text before the list */
6710 if ( yield && yield->ptr != save_ptr
6711 && (temp[0] == *outsep || temp[0] == 0))
6712 yield = string_catn(yield, US" ", 1);
6714 /* Add the string in "temp" to the output list that we are building,
6715 This is done in chunks by searching for the separator character. */
6719 size_t seglen = Ustrcspn(temp, outsep);
6721 yield = string_catn(yield, temp, seglen + 1);
6723 /* If we got to the end of the string we output one character
6724 too many; backup and end the loop. Otherwise arrange to double the
6727 if (!temp[seglen]) { yield->ptr--; break; }
6728 yield = string_catn(yield, outsep, 1);
6732 /* Output a separator after the string: we will remove the redundant
6733 final one at the end. */
6735 yield = string_catn(yield, outsep, 1);
6736 } /* End of iteration over the list loop */
6738 /* REDUCE has generated no output above: output the final value of
6741 if (item_type == EITEM_REDUCE)
6743 yield = string_cat(yield, lookup_value);
6744 lookup_value = save_lookup_value; /* Restore $value */
6747 /* FILTER and MAP generate lists: if they have generated anything, remove
6748 the redundant final separator. Even though an empty item at the end of a
6749 list does not count, this is tidier. */
6751 else if (yield && yield->ptr != save_ptr) yield->ptr--;
6753 /* Restore preserved $item */
6755 iterate_item = save_iterate_item;
6756 if (flags & ESI_SKIPPING) continue;
6762 int sep = 0, cond_type;
6763 const uschar * srclist, * cmp, * xtract;
6764 uschar * opname, * srcitem;
6765 const uschar * dstlist = NULL, * dstkeylist = NULL;
6766 uschar * tmp, * save_iterate_item = iterate_item;
6768 Uskip_whitespace(&s);
6769 if (*s++ != '{') /*}*/
6771 expand_string_message = US"missing '{' for list arg of sort";
6772 goto EXPAND_FAILED_CURLY; /*}*/
6775 srclist = expand_string_internal(s,
6776 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6777 if (!srclist) goto EXPAND_FAILED; /*{{*/
6780 expand_string_message = US"missing '}' closing list arg of sort";
6781 goto EXPAND_FAILED_CURLY;
6784 Uskip_whitespace(&s);
6785 if (*s++ != '{') /*}*/
6787 expand_string_message = US"missing '{' for comparator arg of sort";
6788 goto EXPAND_FAILED_CURLY; /*}*/
6791 cmp = expand_string_internal(s,
6792 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6793 if (!cmp) goto EXPAND_FAILED; /*{{*/
6796 expand_string_message = US"missing '}' closing comparator arg of sort";
6797 goto EXPAND_FAILED_CURLY;
6800 if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6802 if (!expand_string_message)
6803 expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6808 case ECOND_NUM_L: case ECOND_NUM_LE:
6809 case ECOND_NUM_G: case ECOND_NUM_GE:
6810 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6811 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6815 expand_string_message = US"comparator not handled for sort";
6819 Uskip_whitespace(&s);
6820 if (*s++ != '{') /*}*/
6822 expand_string_message = US"missing '{' for extractor arg of sort";
6823 goto EXPAND_FAILED_CURLY; /*}*/
6827 if (!(tmp = expand_string_internal(s,
6828 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL)))
6830 xtract = string_copyn(xtract, s - xtract);
6834 expand_string_message = US"missing '}' closing extractor arg of sort";
6835 goto EXPAND_FAILED_CURLY;
6840 expand_string_message = US"missing } at end of \"sort\"";
6844 if (flags & ESI_SKIPPING) continue;
6846 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6848 uschar * srcfield, * dstitem;
6849 gstring * newlist = NULL, * newkeylist = NULL;
6851 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6853 /* extract field for comparisons */
6854 iterate_item = srcitem;
6855 if ( !(srcfield = expand_string_internal(xtract,
6856 ESI_HONOR_DOLLAR, NULL, &resetok, NULL))
6859 expand_string_message = string_sprintf(
6860 "field-extract in sort: \"%s\"", xtract);
6864 /* Insertion sort */
6866 /* copy output list until new-item < list-item */
6867 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6871 /* field for comparison */
6872 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6875 /* String-comparator names start with a letter; numeric names do not */
6877 if (sortsbefore(cond_type, isalpha(opname[0]),
6878 srcfield, dstfield))
6880 /* New-item sorts before this dst-item. Append new-item,
6881 then dst-item, then remainder of dst list. */
6883 newlist = string_append_listele(newlist, sep, srcitem);
6884 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6887 newlist = string_append_listele(newlist, sep, dstitem);
6888 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6890 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */
6891 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6893 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6895 newlist = string_append_listele(newlist, sep, dstitem);
6896 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6902 newlist = string_append_listele(newlist, sep, dstitem);
6903 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6906 /* If we ran out of dstlist without consuming srcitem, append it */
6909 newlist = string_append_listele(newlist, sep, srcitem);
6910 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6913 dstlist = newlist->s;
6914 dstkeylist = newkeylist->s;
6916 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6917 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6921 yield = string_cat(yield, dstlist);
6923 /* Restore preserved $item */
6924 iterate_item = save_iterate_item;
6928 expand_string_message = US"Internal error in sort (list mismatch)";
6933 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6934 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6935 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6936 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6938 #define EXPAND_DLFUNC_MAX_ARGS 8
6941 #ifndef EXPAND_DLFUNC
6942 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6943 "is not included in this binary";
6946 #else /* EXPAND_DLFUNC */
6949 exim_dlfunc_t * func;
6952 uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6954 if (expand_forbid & RDO_DLFUNC)
6956 expand_string_message =
6957 US"dynamically-loaded functions are not permitted";
6961 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, flags,
6962 TRUE, name, &resetok, NULL))
6964 case -1: continue; /* skipping */
6965 case 1: goto EXPAND_FAILED_CURLY;
6967 case 3: goto EXPAND_FAILED;
6970 /* Look up the dynamically loaded object handle in the tree. If it isn't
6971 found, dlopen() the file and put the handle in the tree for next time. */
6973 if (!(t = tree_search(dlobj_anchor, argv[0])))
6975 void * handle = dlopen(CS argv[0], RTLD_LAZY);
6978 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6979 argv[0], dlerror());
6980 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6983 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), argv[0]);
6984 Ustrcpy(t->name, argv[0]);
6985 t->data.ptr = handle;
6986 (void)tree_insertnode(&dlobj_anchor, t);
6989 /* Having obtained the dynamically loaded object handle, look up the
6990 function pointer. */
6992 if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6994 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6995 "%s", argv[1], argv[0], dlerror());
6996 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
7000 /* Call the function and work out what to do with the result. If it
7001 returns OK, we have a replacement string; if it returns DEFER then
7002 expansion has failed in a non-forced manner; if it returns FAIL then
7003 failure was forced; if it returns ERROR or any other value there's a
7004 problem, so panic slightly. In any case, assume that the function has
7005 side-effects on the store that must be preserved. */
7009 for (argc = 0; argv[argc]; argc++) ;
7011 if ((status = func(&result, argc - 2, &argv[2])) != OK)
7013 expand_string_message = result ? result : US"(no message)";
7014 if (status == FAIL_FORCED)
7015 f.expand_string_forcedfail = TRUE;
7016 else if (status != FAIL)
7017 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
7018 argv[0], argv[1], status, expand_string_message);
7022 if (result) yield = string_cat(yield, result);
7025 #endif /* EXPAND_DLFUNC */
7027 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
7030 uschar *save_lookup_value = lookup_value;
7032 if (Uskip_whitespace(&s) != '{') /*}*/
7035 key = expand_string_internal(s+1,
7036 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7037 if (!key) goto EXPAND_FAILED; /*{{*/
7040 expand_string_message = US"missing '}' for name arg of env";
7041 goto EXPAND_FAILED_CURLY;
7044 lookup_value = US getenv(CS key);
7046 switch(process_yesno(
7047 flags, /* were previously skipping */
7048 lookup_value != NULL, /* success/failure indicator */
7049 save_lookup_value, /* value to reset for string2 */
7050 &s, /* input pointer */
7051 &yield, /* output pointer */
7052 US"env", /* condition type */
7055 case 1: goto EXPAND_FAILED; /* when all is well, the */
7056 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
7058 if (flags & ESI_SKIPPING) continue;
7063 case EITEM_SRS_ENCODE:
7064 /* ${srs_encode {secret} {return_path} {orig_domain}} */
7069 BOOL quoted = FALSE;
7071 switch (read_subs(sub, 3, 3, CUSS &s, flags, TRUE, name, &resetok, NULL))
7073 case -1: continue; /* skipping */
7074 case 1: goto EXPAND_FAILED_CURLY;
7076 case 3: goto EXPAND_FAILED;
7078 if (flags & ESI_SKIPPING) continue;
7080 if (sub[1] && *(sub[1]))
7082 g = string_catn(g, US"SRS0=", 5);
7084 /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
7085 hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
7086 g = string_catn(g, cksum, sizeof(cksum));
7087 g = string_catn(g, US"=", 1);
7089 /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
7094 gettimeofday(&now, NULL);
7095 i = (now.tv_sec / 86400) & 0x3ff;
7096 g = string_catn(g, &base32_chars[i >> 5], 1);
7097 g = string_catn(g, &base32_chars[i & 0x1f], 1);
7099 g = string_catn(g, US"=", 1);
7101 /* ${domain:$return_path}=${local_part:$return_path} */
7103 int start, end, domain;
7104 uschar * t = parse_extract_address(sub[1], &expand_string_message,
7105 &start, &end, &domain, FALSE);
7111 if (domain > 0) g = string_cat(g, t + domain);
7112 g = string_catn(g, US"=", 1);
7114 s = domain > 0 ? string_copyn(t, domain - 1) : t;
7115 if ((quoted = Ustrchr(s, '"') != NULL))
7118 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
7119 while (*s) /* de-quote */
7121 while (*s && *s != '"') h = string_catn(h, s++, 1);
7123 while (*s && *s != '"') h = string_catn(h, s++, 1);
7126 gstring_release_unused(h);
7127 s = string_from_gstring(h);
7129 g = string_cat(g, s);
7132 /* Assume that if the original local_part had quotes
7133 it was for good reason */
7135 if (quoted) yield = string_catn(yield, US"\"", 1);
7136 yield = gstring_append(yield, g);
7137 if (quoted) yield = string_catn(yield, US"\"", 1);
7139 /* @$original_domain */
7140 yield = string_catn(yield, US"@", 1);
7141 yield = string_cat(yield, sub[2]);
7144 DEBUG(D_expand) debug_printf_indent("null return_path for srs-encode\n");
7148 #endif /*SUPPORT_SRS*/
7152 } /* EITEM_* switch */
7155 DEBUG(D_expand) /* only if not the sole expansion of the line */
7156 if (yield && (expansion_start > 0 || *s))
7157 debug_expansion_interim(US"item-res",
7158 yield->s + expansion_start, yield->ptr - expansion_start,
7159 !!(flags & ESI_SKIPPING));
7165 /* Control reaches here if the name is not recognized as one of the more
7166 complicated expansion items. Check for the "operator" syntax (name terminated
7167 by a colon). Some of the operators have arguments, separated by _ from the
7173 uschar * arg = NULL, * sub;
7175 var_entry * vp = NULL;
7178 /* Owing to an historical mis-design, an underscore may be part of the
7179 operator name, or it may introduce arguments. We therefore first scan the
7180 table of names that contain underscores. If there is no match, we cut off
7181 the arguments and then scan the main table. */
7183 if ((c = chop_match(name, op_table_underscore,
7184 nelem(op_table_underscore))) < 0)
7186 if ((arg = Ustrchr(name, '_')))
7188 if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
7189 c += nelem(op_table_underscore);
7190 if (arg) *arg++ = '_'; /* Put back for error messages */
7193 /* Deal specially with operators that might take a certificate variable
7194 as we do not want to do the usual expansion. For most, expand the string.*/
7205 const uschar * s1 = s;
7206 sub = expand_string_internal(s+2,
7207 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s1, &resetok, NULL);
7208 if (!sub) goto EXPAND_FAILED; /*{*/
7211 expand_string_message =
7212 string_sprintf("missing '}' closing cert arg of %s", name);
7213 goto EXPAND_FAILED_CURLY;
7215 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
7225 sub = expand_string_internal(s+1,
7226 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7227 if (!sub) goto EXPAND_FAILED;
7232 /* If we are skipping, we don't need to perform the operation at all.
7233 This matters for operations like "mask", because the data may not be
7234 in the correct format when skipping. For example, the expression may test
7235 for the existence of $sender_host_address before trying to mask it. For
7236 other operations, doing them may not fail, but it is a waste of time. */
7238 if (flags & ESI_SKIPPING && c >= 0) continue;
7240 /* Otherwise, switch on the operator type. After handling go back
7241 to the main loop top. */
7244 unsigned expansion_start = gstring_length(yield);
7250 unsigned long int n = Ustrtoul(sub, &t, 10);
7255 expand_string_message = string_sprintf("argument for base32 "
7256 "operator is \"%s\", which is not a decimal number", sub);
7260 g = string_catn(g, &base32_chars[n & 0x1f], 1);
7262 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7269 unsigned long int n = 0;
7272 uschar * t = Ustrchr(base32_chars, *tt++);
7275 expand_string_message = string_sprintf("argument for base32d "
7276 "operator is \"%s\", which is not a base 32 number", sub);
7279 n = n * 32 + (t - base32_chars);
7281 yield = string_fmt_append(yield, "%ld", n);
7288 unsigned long int n = Ustrtoul(sub, &t, 10);
7291 expand_string_message = string_sprintf("argument for base62 "
7292 "operator is \"%s\", which is not a decimal number", sub);
7295 yield = string_cat(yield, string_base62_32(n)); /*XXX only handles 32b input range. Need variants? */
7299 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7304 unsigned long int n = 0;
7307 uschar *t = Ustrchr(base62_chars, *tt++);
7310 expand_string_message = string_sprintf("argument for base62d "
7311 "operator is \"%s\", which is not a base %d number", sub,
7315 n = n * BASE_62 + (t - base62_chars);
7317 yield = string_fmt_append(yield, "%ld", n);
7323 uschar *expanded = expand_string_internal(sub,
7324 ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, NULL, &resetok, NULL);
7327 expand_string_message =
7328 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7329 expand_string_message);
7332 yield = string_cat(yield, expanded);
7339 uschar *t = sub - 1;
7340 while (*(++t) != 0) { *t = tolower(*t); count++; }
7341 yield = string_catn(yield, sub, count);
7348 uschar *t = sub - 1;
7349 while (*(++t) != 0) { *t = toupper(*t); count++; }
7350 yield = string_catn(yield, sub, count);
7356 if (vp && *(void **)vp->value)
7358 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7359 yield = string_cat(yield, cp);
7367 md5_end(&base, sub, Ustrlen(sub), digest);
7368 for (int j = 0; j < 16; j++)
7369 yield = string_fmt_append(yield, "%02x", digest[j]);
7375 if (vp && *(void **)vp->value)
7377 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7378 yield = string_cat(yield, cp);
7386 sha1_end(&h, sub, Ustrlen(sub), digest);
7387 for (int j = 0; j < 20; j++)
7388 yield = string_fmt_append(yield, "%02X", digest[j]);
7394 #ifdef EXIM_HAVE_SHA2
7395 if (vp && *(void **)vp->value)
7396 if (c == EOP_SHA256)
7397 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7399 expand_string_message = US"sha2_N not supported with certificates";
7404 hashmethod m = !arg ? HASH_SHA2_256
7405 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7406 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7407 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7410 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7412 expand_string_message = US"unrecognised sha2 variant";
7416 exim_sha_update_string(&h, sub);
7417 exim_sha_finish(&h, &b);
7419 yield = string_fmt_append(yield, "%02X", *b.data++);
7422 expand_string_message = US"sha256 only supported with TLS";
7427 #ifdef EXIM_HAVE_SHA3
7431 hashmethod m = !arg ? HASH_SHA3_256
7432 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7433 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7434 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7435 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7438 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7440 expand_string_message = US"unrecognised sha3 variant";
7444 exim_sha_update_string(&h, sub);
7445 exim_sha_finish(&h, &b);
7447 yield = string_fmt_append(yield, "%02X", *b.data++);
7451 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7455 /* Line-wrap a string as if it is a header line */
7457 case EOP_HEADERWRAP:
7459 unsigned col = 80, lim = 998;
7464 const uschar * list = arg;
7466 if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7469 if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7473 if ((s = wrap_header(sub, col, lim, US"\t", 8)))
7474 yield = string_cat(yield, s);
7478 /* Convert hex encoding to base64 encoding */
7488 for (enc = sub; *enc; enc++)
7490 if (!isxdigit(*enc))
7492 expand_string_message = string_sprintf("\"%s\" is not a hex "
7501 expand_string_message = string_sprintf("\"%s\" contains an odd "
7502 "number of characters", sub);
7506 while ((c = *in++) != 0)
7508 if (isdigit(c)) c -= '0';
7509 else c = toupper(c) - 'A' + 10;
7519 enc = b64encode(CUS sub, out - sub);
7520 yield = string_cat(yield, enc);
7524 /* Convert octets outside 0x21..0x7E to \xXX form */
7528 uschar *t = sub - 1;
7531 if (*t < 0x21 || 0x7E < *t)
7532 yield = string_fmt_append(yield, "\\x%02x", *t);
7534 yield = string_catn(yield, t, 1);
7539 /* count the number of list elements */
7543 int cnt = 0, sep = 0;
7544 uschar * buf = store_get(2, sub);
7546 while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7547 yield = string_fmt_append(yield, "%d", cnt);
7551 /* expand a named list given the name */
7552 /* handles nested named lists; requotes as colon-sep list */
7555 expand_string_message = NULL;
7556 yield = expand_listnamed(yield, sub, arg);
7557 if (expand_string_message)
7561 /* quote a list-item for the given list-separator */
7563 /* mask applies a mask to an IP address; for example the result of
7564 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7571 int type, mask, maskoffset;
7575 if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7577 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7582 if (maskoffset == 0)
7584 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7589 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7591 if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7593 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7598 /* If an optional 'n' was given, ipv6 gets normalised output:
7599 colons rather than dots, and zero-compressed. */
7601 normalised = arg && *arg == 'n';
7603 /* Convert the address to binary integer(s) and apply the mask */
7605 sub[maskoffset] = 0;
7606 count = host_aton(sub, binary);
7607 host_mask(count, binary, mask);
7609 /* Convert to masked textual format and add to output. */
7611 if (type == 4 || !normalised)
7612 yield = string_catn(yield, buffer,
7613 host_nmtoa(count, binary, mask, buffer, '.'));
7616 ipv6_nmtoa(binary, buffer);
7617 yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7623 case EOP_IPV6DENORM:
7625 int type = string_is_ip_address(sub, NULL);
7632 (void) host_aton(sub, binary);
7635 case 4: /* convert to IPv4-mapped IPv6 */
7636 binary[0] = binary[1] = 0;
7637 binary[2] = 0x0000ffff;
7638 (void) host_aton(sub, binary+3);
7642 expand_string_message =
7643 string_sprintf("\"%s\" is not an IP address", sub);
7647 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7648 ? ipv6_nmtoa(binary, buffer)
7649 : host_nmtoa(4, binary, -1, buffer, ':')
7655 case EOP_LOCAL_PART:
7659 int start, end, domain;
7660 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7663 if (c != EOP_DOMAIN)
7664 yield = c == EOP_LOCAL_PART && domain > 0
7665 ? string_catn(yield, t, domain - 1)
7666 : string_cat(yield, t);
7667 else if (domain > 0)
7668 yield = string_cat(yield, t + domain);
7674 uschar outsep[2] = { ':', '\0' };
7675 uschar *address, *error;
7676 int save_ptr = gstring_length(yield);
7677 int start, end, domain; /* Not really used */
7679 if (Uskip_whitespace(&sub) == '>')
7680 if (*outsep = *++sub) ++sub;
7683 expand_string_message = string_sprintf("output separator "
7684 "missing in expanding ${addresses:%s}", --sub);
7687 f.parse_allow_group = TRUE;
7691 uschar * p = parse_find_address_end(sub, FALSE);
7692 uschar saveend = *p;
7694 address = parse_extract_address(sub, &error, &start, &end, &domain,
7698 /* Add the address to the output list that we are building. This is
7699 done in chunks by searching for the separator character. At the
7700 start, unless we are dealing with the first address of the output
7701 list, add in a space if the new address begins with the separator
7702 character, or is an empty string. */
7706 if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7707 yield = string_catn(yield, US" ", 1);
7711 size_t seglen = Ustrcspn(address, outsep);
7712 yield = string_catn(yield, address, seglen + 1);
7714 /* If we got to the end of the string we output one character
7717 if (address[seglen] == '\0') { yield->ptr--; break; }
7718 yield = string_catn(yield, outsep, 1);
7719 address += seglen + 1;
7722 /* Output a separator after the string: we will remove the
7723 redundant final one at the end. */
7725 yield = string_catn(yield, outsep, 1);
7728 if (saveend == '\0') break;
7732 /* If we have generated anything, remove the redundant final
7735 if (yield && yield->ptr != save_ptr) yield->ptr--;
7736 f.parse_allow_group = FALSE;
7741 /* quote puts a string in quotes if it is empty or contains anything
7742 other than alphamerics, underscore, dot, or hyphen.
7744 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7745 be quoted in order to be a valid local part.
7747 In both cases, newlines and carriage returns are converted into \n and \r
7751 case EOP_QUOTE_LOCAL_PART:
7754 BOOL needs_quote = (!*sub); /* TRUE for empty string */
7755 uschar *t = sub - 1;
7758 while (!needs_quote && *++t)
7759 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7761 else /* EOP_QUOTE_LOCAL_PART */
7762 while (!needs_quote && *++t)
7763 needs_quote = !isalnum(*t)
7764 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7765 && (*t != '.' || t == sub || !t[1]);
7769 yield = string_catn(yield, US"\"", 1);
7773 yield = string_catn(yield, US"\\n", 2);
7774 else if (*t == '\r')
7775 yield = string_catn(yield, US"\\r", 2);
7778 if (*t == '\\' || *t == '"')
7779 yield = string_catn(yield, US"\\", 1);
7780 yield = string_catn(yield, t, 1);
7782 yield = string_catn(yield, US"\"", 1);
7785 yield = string_cat(yield, sub);
7789 /* quote_lookuptype does lookup-specific quoting */
7794 uschar * opt = Ustrchr(arg, '_');
7796 if (opt) *opt++ = 0;
7798 if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7800 expand_string_message = search_error_message;
7804 if (lookup_list[n]->quote)
7805 sub = (lookup_list[n]->quote)(sub, opt, (unsigned)n);
7811 expand_string_message = string_sprintf(
7812 "\"%s\" unrecognized after \"${quote_%s\"", /*}*/
7817 yield = string_cat(yield, sub);
7821 /* rx quote sticks in \ before any non-alphameric character so that
7822 the insertion works in a regular expression. */
7826 uschar *t = sub - 1;
7830 yield = string_catn(yield, US"\\", 1);
7831 yield = string_catn(yield, t, 1);
7836 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7837 prescribed by the RFC, if there are characters that need to be encoded */
7840 yield = string_cat(yield,
7841 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7845 /* RFC 2047 decode */
7851 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7852 headers_charset, '?', &len, &error);
7855 expand_string_message = error;
7858 yield = string_catn(yield, decoded, len);
7862 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7867 uschar * buff = store_get(4, sub);
7872 if (c > 255) c = '_';
7874 yield = string_catn(yield, buff, 1);
7879 /* replace illegal UTF-8 sequences by replacement character */
7881 #define UTF8_REPLACEMENT_CHAR US"?"
7885 int seq_len = 0, index = 0, bytes_left = 0, complete;
7886 u_long codepoint = (u_long)-1;
7887 uschar seq_buff[4]; /* accumulate utf-8 here */
7889 /* Manually track tainting, as we deal in individual chars below */
7892 yield = string_get_tainted(Ustrlen(sub), sub);
7893 else if (!yield->s || !yield->ptr)
7895 yield->s = store_get(yield->size = Ustrlen(sub), sub);
7896 gstring_reset(yield);
7898 else if (is_incompatible(yield->s, sub))
7899 gstring_rebuffer(yield, sub);
7901 /* Check the UTF-8, byte-by-byte */
7910 if ((c & 0xc0) != 0x80)
7911 /* wrong continuation byte; invalidate all bytes */
7912 complete = 1; /* error */
7915 codepoint = (codepoint << 6) | (c & 0x3f);
7916 seq_buff[index++] = c;
7917 if (--bytes_left == 0) /* codepoint complete */
7918 if(codepoint > 0x10FFFF) /* is it too large? */
7919 complete = -1; /* error (RFC3629 limit) */
7920 else if ( (codepoint & 0x1FF800 ) == 0xD800 ) /* surrogate */
7921 /* A UTF-16 surrogate (which should be one of a pair that
7922 encode a Unicode codepoint that is outside the Basic
7923 Multilingual Plane). Error, not UTF8.
7924 RFC2279.2 is slightly unclear on this, but
7925 https://unicodebook.readthedocs.io/issues.html#strict-utf8-decoder
7926 says "Surrogates characters are also invalid in UTF-8:
7927 characters in U+D800—U+DFFF have to be rejected." */
7930 { /* finished; output utf-8 sequence */
7931 yield = string_catn(yield, seq_buff, seq_len);
7936 else /* no bytes left: new sequence */
7938 if (!(c & 0x80)) /* 1-byte sequence, US-ASCII, keep it */
7940 yield = string_catn(yield, &c, 1);
7943 if ((c & 0xe0) == 0xc0) /* 2-byte sequence */
7944 if (c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7949 codepoint = c & 0x1f;
7951 else if ((c & 0xf0) == 0xe0) /* 3-byte sequence */
7954 codepoint = c & 0x0f;
7956 else if ((c & 0xf8) == 0xf0) /* 4-byte sequence */
7959 codepoint = c & 0x07;
7961 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7964 seq_buff[index++] = c;
7965 seq_len = bytes_left + 1;
7966 } /* if(bytes_left) */
7970 bytes_left = index = 0;
7971 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7973 if ((complete == 1) && ((c & 0x80) == 0))
7974 /* ASCII character follows incomplete sequence */
7975 yield = string_catn(yield, &c, 1);
7977 /* If given a sequence truncated mid-character, we also want to report ?
7978 Eg, ${length_1:フィル} is one byte, not one character, so we expect
7979 ${utf8clean:${length_1:フィル}} to yield '?' */
7981 if (bytes_left != 0)
7982 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7988 case EOP_UTF8_DOMAIN_TO_ALABEL:
7990 uschar * error = NULL;
7991 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7994 expand_string_message = string_sprintf(
7995 "error converting utf8 (%s) to alabel: %s",
7996 string_printing(sub), error);
7999 yield = string_cat(yield, s);
8003 case EOP_UTF8_DOMAIN_FROM_ALABEL:
8005 uschar * error = NULL;
8006 uschar * s = string_domain_alabel_to_utf8(sub, &error);
8009 expand_string_message = string_sprintf(
8010 "error converting alabel (%s) to utf8: %s",
8011 string_printing(sub), error);
8014 yield = string_cat(yield, s);
8018 case EOP_UTF8_LOCALPART_TO_ALABEL:
8020 uschar * error = NULL;
8021 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
8024 expand_string_message = string_sprintf(
8025 "error converting utf8 (%s) to alabel: %s",
8026 string_printing(sub), error);
8029 yield = string_cat(yield, s);
8030 DEBUG(D_expand) debug_printf_indent("yield: '%Y'\n", yield);
8034 case EOP_UTF8_LOCALPART_FROM_ALABEL:
8036 uschar * error = NULL;
8037 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
8040 expand_string_message = string_sprintf(
8041 "error converting alabel (%s) to utf8: %s",
8042 string_printing(sub), error);
8045 yield = string_cat(yield, s);
8048 #endif /* EXPERIMENTAL_INTERNATIONAL */
8050 /* escape turns all non-printing characters into escape sequences. */
8054 const uschar * t = string_printing(sub);
8055 yield = string_cat(yield, t);
8059 case EOP_ESCAPE8BIT:
8063 for (const uschar * s = sub; (c = *s); s++)
8064 yield = c < 127 && c != '\\'
8065 ? string_catn(yield, s, 1)
8066 : string_fmt_append(yield, "\\%03o", c);
8070 /* Handle numeric expression evaluation */
8075 uschar *save_sub = sub;
8076 uschar *error = NULL;
8077 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
8080 expand_string_message = string_sprintf("error in expression "
8081 "evaluation: %s (after processing \"%.*s\")", error,
8082 (int)(sub-save_sub), save_sub);
8085 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
8089 /* Handle time period formatting */
8093 int n = readconf_readtime(sub, 0, FALSE);
8096 expand_string_message = string_sprintf("string \"%s\" is not an "
8097 "Exim time interval in \"%s\" operator", sub, name);
8100 yield = string_fmt_append(yield, "%d", n);
8104 case EOP_TIME_INTERVAL:
8107 uschar *t = read_number(&n, sub);
8108 if (*t != 0) /* Not A Number*/
8110 expand_string_message = string_sprintf("string \"%s\" is not a "
8111 "positive number in \"%s\" operator", sub, name);
8114 t = readconf_printtime(n);
8115 yield = string_cat(yield, t);
8119 /* Convert string to base64 encoding */
8125 uschar * s = vp && *(void **)vp->value
8126 ? tls_cert_der_b64(*(void **)vp->value)
8127 : b64encode(CUS sub, Ustrlen(sub));
8129 uschar * s = b64encode(CUS sub, Ustrlen(sub));
8131 yield = string_cat(yield, s);
8138 int len = b64decode(sub, &s, sub);
8141 expand_string_message = string_sprintf("string \"%s\" is not "
8142 "well-formed for \"%s\" operator", sub, name);
8145 yield = string_cat(yield, s);
8149 /* strlen returns the length of the string */
8152 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
8155 /* length_n or l_n takes just the first n characters or the whole string,
8156 whichever is the shorter;
8158 substr_m_n, and s_m_n take n characters from offset m; negative m take
8159 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
8160 takes the rest, either to the right or to the left.
8162 hash_n or h_n makes a hash of length n from the string, yielding n
8163 characters from the set a-z; hash_n_m makes a hash of length n, but
8164 uses m characters from the set a-zA-Z0-9.
8166 nhash_n returns a single number between 0 and n-1 (in text form), while
8167 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
8168 between 0 and n-1 and the second between 0 and m-1. */
8188 expand_string_message = string_sprintf("missing values after %s",
8193 /* "length" has only one argument, effectively being synonymous with
8196 if (c == EOP_LENGTH || c == EOP_L)
8202 /* The others have one or two arguments; for "substr" the first may be
8203 negative. The second being negative means "not supplied". */
8208 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8211 /* Read up to two numbers, separated by underscores */
8216 if (arg != ret && *arg == '_' && pn == &value1)
8220 if (arg[1] != 0) arg++;
8222 else if (!isdigit(*arg))
8224 expand_string_message =
8225 string_sprintf("non-digit after underscore in \"%s\"", name);
8228 else *pn = (*pn)*10 + *arg++ - '0';
8232 /* Perform the required operation */
8234 ret = c == EOP_HASH || c == EOP_H
8235 ? compute_hash(sub, value1, value2, &len)
8236 : c == EOP_NHASH || c == EOP_NH
8237 ? compute_nhash(sub, value1, value2, &len)
8238 : extract_substr(sub, value1, value2, &len);
8239 if (!ret) goto EXPAND_FAILED;
8241 yield = string_catn(yield, ret, len);
8250 uschar **modetable[3];
8254 if (expand_forbid & RDO_EXISTS)
8256 expand_string_message = US"Use of the stat() expansion is not permitted";
8260 if (stat(CS sub, &st) < 0)
8262 expand_string_message = string_sprintf("stat(%s) failed: %s",
8263 sub, strerror(errno));
8267 switch (mode & S_IFMT)
8269 case S_IFIFO: smode[0] = 'p'; break;
8270 case S_IFCHR: smode[0] = 'c'; break;
8271 case S_IFDIR: smode[0] = 'd'; break;
8272 case S_IFBLK: smode[0] = 'b'; break;
8273 case S_IFREG: smode[0] = '-'; break;
8274 default: smode[0] = '?'; break;
8277 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8278 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8279 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8281 for (int i = 0; i < 3; i++)
8283 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8288 yield = string_fmt_append(yield,
8289 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8290 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8291 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8292 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8293 (long)st.st_gid, st.st_size, (long)st.st_atime,
8294 (long)st.st_mtime, (long)st.st_ctime);
8298 /* vaguely random number less than N */
8302 int_eximarith_t max = expanded_string_integer(sub, TRUE);
8304 if (expand_string_message)
8306 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8310 /* Reverse IP, including IPv6 to dotted-nibble */
8312 case EOP_REVERSE_IP:
8314 int family, maskptr;
8315 uschar reversed[128];
8317 family = string_is_ip_address(sub, &maskptr);
8320 expand_string_message = string_sprintf(
8321 "reverse_ip() not given an IP address [%s]", sub);
8324 invert_address(reversed, sub);
8325 yield = string_cat(yield, reversed);
8329 /* Unknown operator */
8332 expand_string_message =
8333 string_sprintf("unknown expansion operator \"%s\"", name);
8335 } /* EOP_* switch */
8339 const uschar * res = string_from_gstring(yield);
8340 const uschar * s = res + expansion_start;
8341 int i = gstring_length(yield) - expansion_start;
8342 BOOL tainted = is_tainted(s);
8346 debug_printf_indent("|-----op-res: %.*s\n", i, s);
8349 debug_printf_indent("%s \\__", flags & ESI_SKIPPING ? "| " : " ");
8350 debug_print_taint(res);
8355 debug_printf_indent(UTF8_VERT_RIGHT
8356 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8357 "op-res: %.*s\n", i, s);
8360 debug_printf_indent("%s",
8361 flags & ESI_SKIPPING
8362 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8363 debug_print_taint(res);
8371 /* Not an item or an operator */
8372 /* Handle a plain name. If this is the first thing in the expansion, release
8373 the pre-allocated buffer. If the result data is known to be in a new buffer,
8374 newsize will be set to the size of that buffer, and we can just point at that
8375 store instead of copying. Many expansion strings contain just one reference,
8376 so this is a useful optimization, especially for humungous headers
8377 ($message_headers). */
8381 const uschar * value;
8387 g = store_get(sizeof(gstring), GET_UNTAINTED);
8388 else if (yield->ptr == 0)
8390 if (resetok) reset_point = store_reset(reset_point);
8392 reset_point = store_mark();
8393 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
8395 if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
8397 expand_string_message =
8398 string_sprintf("unknown variable in \"${%s}\"", name);
8399 check_variable_error_message(name);
8402 len = Ustrlen(value);
8403 if (!yield && newsize)
8406 yield->size = newsize;
8408 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8411 yield = string_catn(yield, value, len);
8415 /* Else there's something wrong */
8417 expand_string_message =
8418 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8419 "in a variable reference)", name);
8423 /* If we hit the end of the string when brace_ends is set, there is a missing
8424 terminating brace. */
8426 if (flags & ESI_BRACE_ENDS && !*s)
8428 expand_string_message = malformed_header
8429 ? US"missing } at end of string - could be header name not terminated by colon"
8430 : US"missing } at end of string";
8434 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8435 added to the string. If so, set up an empty string. Add a terminating zero. If
8436 left != NULL, return a pointer to the terminator. */
8442 yield = string_get(1);
8443 res = string_from_gstring(yield);
8444 if (left) *left = s;
8446 /* Any stacking store that was used above the final string is no longer needed.
8447 In many cases the final string will be the first one that was got and so there
8448 will be optimal store usage. */
8450 if (resetok) gstring_release_unused(yield);
8451 else if (resetok_p) *resetok_p = FALSE;
8455 BOOL tainted = is_tainted(res);
8458 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8459 debug_printf_indent("%sresult: %s\n",
8460 flags & ESI_SKIPPING ? "|-----" : "\\_____", res);
8463 debug_printf_indent("%s \\__", flags & ESI_SKIPPING ? "| " : " ");
8464 debug_print_taint(res);
8466 if (flags & ESI_SKIPPING)
8467 debug_printf_indent("\\___skipping: result is not used\n");
8471 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8472 "expanding: %.*s\n",
8473 (int)(s - string), string);
8474 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8476 flags & ESI_SKIPPING ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8480 debug_printf_indent("%s",
8481 flags & ESI_SKIPPING
8482 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8483 debug_print_taint(res);
8485 if (flags & ESI_SKIPPING)
8486 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8487 "skipping: result is not used\n");
8490 if (textonly_p) *textonly_p = textonly;
8495 /* This is the failure exit: easiest to program with a goto. We still need
8496 to update the pointer to the terminator, for cases of nested calls with "fail".
8499 EXPAND_FAILED_CURLY:
8500 if (malformed_header)
8501 expand_string_message =
8502 US"missing or misplaced { or } - could be header name not terminated by colon";
8504 else if (!expand_string_message || !*expand_string_message)
8505 expand_string_message = US"missing or misplaced { or }";
8507 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8508 that is a bad idea, because expand_string_message is in dynamic store. */
8511 if (left) *left = s;
8516 debug_printf_indent("|failed to expand: %s\n", string);
8517 debug_printf_indent("%serror message: %s\n",
8518 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8519 if (f.expand_string_forcedfail)
8520 debug_printf_indent("\\failure was forced\n");
8524 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8526 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8527 "error message: %s\n",
8528 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8529 expand_string_message);
8530 if (f.expand_string_forcedfail)
8531 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8534 if (resetok_p && !resetok) *resetok_p = FALSE;
8541 /* This is the external function call. Do a quick check for any expansion
8542 metacharacters, and if there are none, just return the input string.
8545 the string to be expanded
8546 optional pointer for return boolean indicating no-dynamic-expansions
8548 Returns: the expanded string, or NULL if expansion failed; if failure was
8549 due to a lookup deferring, search_find_defer will be TRUE
8553 expand_string_2(const uschar * string, BOOL * textonly_p)
8555 if (Ustrpbrk(string, "$\\") != NULL)
8557 int old_pool = store_pool;
8560 f.search_find_defer = FALSE;
8561 malformed_header = FALSE;
8562 store_pool = POOL_MAIN;
8563 s = expand_string_internal(string, ESI_HONOR_DOLLAR, NULL, NULL, textonly_p);
8564 store_pool = old_pool;
8567 if (textonly_p) *textonly_p = TRUE;
8572 expand_cstring(const uschar * string)
8573 { return expand_string_2(string, NULL); }
8576 expand_string(uschar * string)
8577 { return US expand_string_2(CUS string, NULL); }
8584 /*************************************************
8586 *************************************************/
8588 /* Now and again we want to expand a string and be sure that the result is in a
8589 new bit of store. This function does that.
8590 Since we know it has been copied, the de-const cast is safe.
8592 Argument: the string to be expanded
8593 Returns: the expanded string, always in a new bit of store, or NULL
8597 expand_string_copy(const uschar *string)
8599 const uschar *yield = expand_cstring(string);
8600 if (yield == string) yield = string_copy(string);
8606 /*************************************************
8607 * Expand and interpret as an integer *
8608 *************************************************/
8610 /* Expand a string, and convert the result into an integer.
8613 string the string to be expanded
8614 isplus TRUE if a non-negative number is expected
8616 Returns: the integer value, or
8617 -1 for an expansion error ) in both cases, message in
8618 -2 for an integer interpretation error ) expand_string_message
8619 expand_string_message is set NULL for an OK integer
8623 expand_string_integer(uschar *string, BOOL isplus)
8625 return expanded_string_integer(expand_string(string), isplus);
8629 /*************************************************
8630 * Interpret string as an integer *
8631 *************************************************/
8633 /* Convert a string (that has already been expanded) into an integer.
8635 This function is used inside the expansion code.
8638 s the string to be expanded
8639 isplus TRUE if a non-negative number is expected
8641 Returns: the integer value, or
8642 -1 if string is NULL (which implies an expansion error)
8643 -2 for an integer interpretation error
8644 expand_string_message is set NULL for an OK integer
8647 static int_eximarith_t
8648 expanded_string_integer(const uschar *s, BOOL isplus)
8650 int_eximarith_t value;
8651 uschar *msg = US"invalid integer \"%s\"";
8654 /* If expansion failed, expand_string_message will be set. */
8658 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8659 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8660 systems, so we set it zero ourselves. */
8663 expand_string_message = NULL; /* Indicates no error */
8665 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8666 equal to 0. Unfortunately, people actually relied upon that, so preserve
8667 the behaviour explicitly. Stripping leading whitespace is a harmless
8668 noop change since strtol skips it anyway (provided that there is a number
8671 if (Uskip_whitespace(&s) == '\0')
8674 debug_printf_indent("treating blank string as number 0\n");
8678 value = strtoll(CS s, CSS &endptr, 10);
8681 msg = US"integer expected but \"%s\" found";
8682 else if (value < 0 && isplus)
8683 msg = US"non-negative integer expected but \"%s\" found";
8686 switch (tolower(*endptr))
8691 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8696 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8697 else value *= 1024*1024;
8701 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8702 else value *= 1024*1024*1024;
8706 if (errno == ERANGE)
8707 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8709 if (Uskip_whitespace(&endptr) == 0) return value;
8712 expand_string_message = string_sprintf(CS msg, s);
8717 /* These values are usually fixed boolean values, but they are permitted to be
8721 addr address being routed
8722 mtype the module type
8723 mname the module name
8724 dbg_opt debug selectors
8725 oname the option name
8726 bvalue the router's boolean value
8727 svalue the router's string value
8728 rvalue where to put the returned value
8730 Returns: OK value placed in rvalue
8731 DEFER expansion failed
8735 exp_bool(address_item *addr,
8736 uschar *mtype, uschar *mname, unsigned dbg_opt,
8737 uschar *oname, BOOL bvalue,
8738 uschar *svalue, BOOL *rvalue)
8741 if (!svalue) { *rvalue = bvalue; return OK; }
8743 if (!(expanded = expand_string(svalue)))
8745 if (f.expand_string_forcedfail)
8747 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8751 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8752 oname, mname, mtype, expand_string_message);
8753 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8757 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8760 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8762 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8766 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8767 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8776 /* Avoid potentially exposing a password in a string about to be logged */
8779 expand_hide_passwords(uschar * s)
8781 return ( ( Ustrstr(s, "failed to expand") != NULL
8782 || Ustrstr(s, "expansion of ") != NULL
8784 && ( Ustrstr(s, "mysql") != NULL
8785 || Ustrstr(s, "pgsql") != NULL
8786 || Ustrstr(s, "redis") != NULL
8787 || Ustrstr(s, "sqlite") != NULL
8788 || Ustrstr(s, "ldap:") != NULL
8789 || Ustrstr(s, "ldaps:") != NULL
8790 || Ustrstr(s, "ldapi:") != NULL
8791 || Ustrstr(s, "ldapdn:") != NULL
8792 || Ustrstr(s, "ldapm:") != NULL
8794 ? US"Temporary internal error" : s;
8798 /* Read given named file into big_buffer. Use for keying material etc.
8799 The content will have an ascii NUL appended.
8804 Return: pointer to buffer, or NULL on error.
8808 expand_file_big_buffer(const uschar * filename)
8810 int fd, off = 0, len;
8812 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8814 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8821 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8824 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8832 big_buffer[off] = '\0';
8838 /*************************************************
8839 * Error-checking for testsuite *
8840 *************************************************/
8842 uschar * region_start;
8843 uschar * region_end;
8844 const uschar *var_name;
8845 const uschar *var_data;
8848 /* Called via tree_walk, which allows nonconst name/data. Our usage is const. */
8850 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8853 if (var_data >= e->region_start && var_data < e->region_end)
8855 e->var_name = CUS var_name;
8856 e->var_data = CUS var_data;
8861 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8863 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8864 .var_name = NULL, .var_data = NULL };
8866 /* check acl_ variables */
8867 tree_walk(acl_var_c, assert_variable_notin, &e);
8868 tree_walk(acl_var_m, assert_variable_notin, &e);
8870 /* check auth<n> variables.
8871 assert_variable_notin() treats as const, so deconst is safe. */
8872 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8873 assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8875 #ifdef WITH_CONTENT_SCAN
8876 /* check regex<n> variables. assert_variable_notin() treats as const. */
8877 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8878 assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8881 /* check known-name variables */
8882 for (var_entry * v = var_table; v < var_table + nelem(var_table); v++)
8883 if (v->type == vtype_stringptr)
8884 assert_variable_notin(US v->name, *(USS v->value), &e);
8886 /* check dns and address trees */
8887 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8888 tree_walk(tree_duplicates, assert_variable_notin, &e);
8889 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8890 tree_walk(tree_unusable, assert_variable_notin, &e);
8893 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8894 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8895 e.var_name, filename, linenumber, e.var_data);
8900 /*************************************************
8901 **************************************************
8902 * Stand-alone test program *
8903 **************************************************
8904 *************************************************/
8910 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8912 int ovec[3*(EXPAND_MAXN+1)];
8913 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8915 BOOL yield = n >= 0;
8916 if (n == 0) n = EXPAND_MAXN + 1;
8919 expand_nmax = setup < 0 ? 0 : setup + 1;
8920 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8922 expand_nstring[expand_nmax] = subject + ovec[nn];
8923 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8931 int main(int argc, uschar **argv)
8933 uschar buffer[1024];
8935 debug_selector = D_v;
8936 debug_file = stderr;
8937 debug_fd = fileno(debug_file);
8938 big_buffer = malloc(big_buffer_size);
8941 for (int i = 1; i < argc; i++)
8943 if (argv[i][0] == '+')
8945 debug_trace_memory = 2;
8948 if (isdigit(argv[i][0]))
8949 debug_selector = Ustrtol(argv[i], NULL, 0);
8951 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8955 eldap_default_servers = argv[i];
8958 mysql_servers = argv[i];
8961 pgsql_servers = argv[i];
8964 redis_servers = argv[i];
8968 else opt_perl_startup = argv[i];
8972 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8974 expand_nstring[1] = US"string 1....";
8975 expand_nlength[1] = 8;
8979 if (opt_perl_startup != NULL)
8982 printf("Starting Perl interpreter\n");
8983 errstr = init_perl(opt_perl_startup);
8986 printf("** error in perl_startup code: %s\n", errstr);
8987 return EXIT_FAILURE;
8990 #endif /* EXIM_PERL */
8992 /* Thie deliberately regards the input as untainted, so that it can be
8993 expanded; only reasonable since this is a test for string-expansions. */
8995 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8997 rmark reset_point = store_mark();
8998 uschar *yield = expand_string(buffer);
9000 printf("%s\n", yield);
9003 if (f.search_find_defer) printf("search_find deferred\n");
9004 printf("Failed: %s\n", expand_string_message);
9005 if (f.expand_string_forcedfail) printf("Forced failure\n");
9008 store_reset(reset_point);
9016 #endif /*STAND_ALONE*/
9018 #endif /*!MACRO_PREDEF*/
9021 /* End of expand.c */