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
32 /* Recursively called function */
34 static uschar *expand_string_internal(const uschar *, esi_flags, const uschar **, BOOL *, BOOL *);
35 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
37 #endif /*!STAND_ALONE*/
40 # include "lookups/ldap.h"
43 #ifdef SUPPORT_CRYPTEQ
48 extern char* crypt16(char*, char*);
52 /* The handling of crypt16() is a mess. I will record below the analysis of the
53 mess that was sent to me. We decided, however, to make changing this very low
54 priority, because in practice people are moving away from the crypt()
55 algorithms nowadays, so it doesn't seem worth it.
58 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
59 the first 8 characters of the password using a 20-round version of crypt
60 (standard crypt does 25 rounds). It then crypts the next 8 characters,
61 or an empty block if the password is less than 9 characters, using a
62 20-round version of crypt and the same salt as was used for the first
63 block. Characters after the first 16 are ignored. It always generates
64 a 16-byte hash, which is expressed together with the salt as a string
65 of 24 base 64 digits. Here are some links to peruse:
67 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
68 http://seclists.org/bugtraq/1999/Mar/0076.html
70 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
71 and OSF/1. This is the same as the standard crypt if given a password
72 of 8 characters or less. If given more, it first does the same as crypt
73 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
74 using as salt the first two base 64 digits from the first hash block.
75 If the password is more than 16 characters then it crypts the 17th to 24th
76 characters using as salt the first two base 64 digits from the second hash
77 block. And so on: I've seen references to it cutting off the password at
78 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
80 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
81 http://seclists.org/bugtraq/1999/Mar/0109.html
82 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
83 TET1_html/sec.c222.html#no_id_208
85 Exim has something it calls "crypt16". It will either use a native
86 crypt16 or its own implementation. A native crypt16 will presumably
87 be the one that I called "crypt16" above. The internal "crypt16"
88 function, however, is a two-block-maximum implementation of what I called
89 "bigcrypt". The documentation matches the internal code.
91 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
92 that crypt16 and bigcrypt were different things.
94 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
95 to whatever it is using under that name. This unfortunately sets a
96 precedent for using "{crypt16}" to identify two incompatible algorithms
97 whose output can't be distinguished. With "{crypt16}" thus rendered
98 ambiguous, I suggest you deprecate it and invent two new identifiers
99 for the two algorithms.
101 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
102 of the password separately means they can be cracked separately, so
103 the double-length hash only doubles the cracking effort instead of
104 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
105 bcrypt ({CRYPT}$2a$).
111 /*************************************************
112 * Local statics and tables *
113 *************************************************/
115 /* Table of item names, and corresponding switch numbers. The names must be in
116 alphabetical order. */
118 static uschar *item_table[] = {
188 /* Tables of operator names, and corresponding switch numbers. The names must be
189 in alphabetical order. There are two tables, because underscore is used in some
190 cases to introduce arguments, whereas for other it is part of the name. This is
191 an historical mis-design. */
193 static uschar * op_table_underscore[] = {
196 US"quote_local_part",
201 ,US"utf8_domain_from_alabel",
202 US"utf8_domain_to_alabel",
203 US"utf8_localpart_from_alabel",
204 US"utf8_localpart_to_alabel"
211 EOP_QUOTE_LOCAL_PART,
216 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
217 EOP_UTF8_DOMAIN_TO_ALABEL,
218 EOP_UTF8_LOCALPART_FROM_ALABEL,
219 EOP_UTF8_LOCALPART_TO_ALABEL
223 static uschar *op_table_main[] = {
272 EOP_ADDRESS = nelem(op_table_underscore),
320 /* Table of condition names, and corresponding switch numbers. The names must
321 be in alphabetical order. */
323 static uschar *cond_table[] = {
327 US"==", /* Backward compatibility */
367 US"match_local_part",
392 ECOND_FIRST_DELIVERY,
420 ECOND_MATCH_LOCAL_PART,
430 /* Types of table entry */
433 vtype_int, /* value is address of int */
434 vtype_filter_int, /* ditto, but recognized only when filtering */
435 vtype_ino, /* value is address of ino_t (not always an int) */
436 vtype_uid, /* value is address of uid_t (not always an int) */
437 vtype_gid, /* value is address of gid_t (not always an int) */
438 vtype_bool, /* value is address of bool */
439 vtype_stringptr, /* value is address of pointer to string */
440 vtype_msgbody, /* as stringptr, but read when first required */
441 vtype_msgbody_end, /* ditto, the end of the message */
442 vtype_msgheaders, /* the message's headers, processed */
443 vtype_msgheaders_raw, /* the message's headers, unprocessed */
444 vtype_localpart, /* extract local part from string */
445 vtype_domain, /* extract domain from string */
446 vtype_string_func, /* value is string returned by given function */
447 vtype_todbsdin, /* value not used; generate BSD inbox tod */
448 vtype_tode, /* value not used; generate tod in epoch format */
449 vtype_todel, /* value not used; generate tod in epoch/usec format */
450 vtype_todf, /* value not used; generate full tod */
451 vtype_todl, /* value not used; generate log tod */
452 vtype_todlf, /* value not used; generate log file datestamp tod */
453 vtype_todzone, /* value not used; generate time zone only */
454 vtype_todzulu, /* value not used; generate zulu tod */
455 vtype_reply, /* value not used; get reply from headers */
456 vtype_pid, /* value not used; result is pid */
457 vtype_host_lookup, /* value not used; get host name */
458 vtype_load_avg, /* value not used; result is int from os_getloadavg */
459 vtype_pspace, /* partition space; value is T/F for spool/log */
460 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
461 vtype_cert /* SSL certificate */
463 ,vtype_dkim /* Lookup of value in DKIM signature */
467 /* Type for main variable table */
475 /* Type for entries pointing to address/length pairs. Not currently
483 typedef uschar * stringptr_fn_t(void);
484 static uschar * fn_recipients(void);
485 static uschar * fn_queue_size(void);
487 /* This table must be kept in alphabetical order. */
489 static var_entry var_table[] = {
490 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
491 they will be confused with user-creatable ACL variables. */
492 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
493 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
494 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
495 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
496 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
497 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
498 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
499 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
500 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
501 { "acl_narg", vtype_int, &acl_narg },
502 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
503 { "address_data", vtype_stringptr, &deliver_address_data },
504 { "address_file", vtype_stringptr, &address_file },
505 { "address_pipe", vtype_stringptr, &address_pipe },
506 #ifdef EXPERIMENTAL_ARC
507 { "arc_domains", vtype_string_func, (void *) &fn_arc_domains },
508 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
509 { "arc_state", vtype_stringptr, &arc_state },
510 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
512 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
513 { "authenticated_id", vtype_stringptr, &authenticated_id },
514 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
515 { "authentication_failed",vtype_int, &authentication_failed },
516 #ifdef WITH_CONTENT_SCAN
517 { "av_failed", vtype_int, &av_failed },
519 #ifdef EXPERIMENTAL_BRIGHTMAIL
520 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
521 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
522 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
523 { "bmi_deliver", vtype_int, &bmi_deliver },
525 { "body_linecount", vtype_int, &body_linecount },
526 { "body_zerocount", vtype_int, &body_zerocount },
527 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
528 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
529 { "caller_gid", vtype_gid, &real_gid },
530 { "caller_uid", vtype_uid, &real_uid },
531 { "callout_address", vtype_stringptr, &callout_address },
532 { "compile_date", vtype_stringptr, &version_date },
533 { "compile_number", vtype_stringptr, &version_cnumber },
534 { "config_dir", vtype_stringptr, &config_main_directory },
535 { "config_file", vtype_stringptr, &config_main_filename },
536 { "csa_status", vtype_stringptr, &csa_status },
537 #ifdef EXPERIMENTAL_DCC
538 { "dcc_header", vtype_stringptr, &dcc_header },
539 { "dcc_result", vtype_stringptr, &dcc_result },
542 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
543 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
544 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
545 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
546 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
547 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
548 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
549 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
550 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
551 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
552 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
553 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
554 { "dkim_key_length", vtype_int, &dkim_key_length },
555 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
556 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
557 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
558 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
559 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
560 { "dkim_signers", vtype_stringptr, &dkim_signers },
561 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
562 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
565 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
566 { "dmarc_status", vtype_stringptr, &dmarc_status },
567 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
568 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
570 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
571 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
572 { "dnslist_text", vtype_stringptr, &dnslist_text },
573 { "dnslist_value", vtype_stringptr, &dnslist_value },
574 { "domain", vtype_stringptr, &deliver_domain },
575 { "domain_data", vtype_stringptr, &deliver_domain_data },
576 #ifndef DISABLE_EVENT
577 { "event_data", vtype_stringptr, &event_data },
579 /*XXX want to use generic vars for as many of these as possible*/
580 { "event_defer_errno", vtype_int, &event_defer_errno },
582 { "event_name", vtype_stringptr, &event_name },
584 { "exim_gid", vtype_gid, &exim_gid },
585 { "exim_path", vtype_stringptr, &exim_path },
586 { "exim_uid", vtype_uid, &exim_uid },
587 { "exim_version", vtype_stringptr, &version_string },
588 { "headers_added", vtype_string_func, (void *) &fn_hdrs_added },
589 { "home", vtype_stringptr, &deliver_home },
590 { "host", vtype_stringptr, &deliver_host },
591 { "host_address", vtype_stringptr, &deliver_host_address },
592 { "host_data", vtype_stringptr, &host_data },
593 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
594 { "host_lookup_failed", vtype_int, &host_lookup_failed },
595 { "host_port", vtype_int, &deliver_host_port },
596 { "initial_cwd", vtype_stringptr, &initial_cwd },
597 { "inode", vtype_ino, &deliver_inode },
598 { "interface_address", vtype_stringptr, &interface_address },
599 { "interface_port", vtype_int, &interface_port },
600 { "item", vtype_stringptr, &iterate_item },
602 { "ldap_dn", vtype_stringptr, &eldap_dn },
604 { "load_average", vtype_load_avg, NULL },
605 { "local_part", vtype_stringptr, &deliver_localpart },
606 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
607 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
608 { "local_part_prefix_v", vtype_stringptr, &deliver_localpart_prefix_v },
609 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
610 { "local_part_suffix_v", vtype_stringptr, &deliver_localpart_suffix_v },
611 #ifdef HAVE_LOCAL_SCAN
612 { "local_scan_data", vtype_stringptr, &local_scan_data },
614 { "local_user_gid", vtype_gid, &local_user_gid },
615 { "local_user_uid", vtype_uid, &local_user_uid },
616 { "localhost_number", vtype_int, &host_number },
617 { "log_inodes", vtype_pinodes, (void *)FALSE },
618 { "log_space", vtype_pspace, (void *)FALSE },
619 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
620 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
621 #ifdef WITH_CONTENT_SCAN
622 { "malware_name", vtype_stringptr, &malware_name },
624 { "max_received_linelength", vtype_int, &max_received_linelength },
625 { "message_age", vtype_int, &message_age },
626 { "message_body", vtype_msgbody, &message_body },
627 { "message_body_end", vtype_msgbody_end, &message_body_end },
628 { "message_body_size", vtype_int, &message_body_size },
629 { "message_exim_id", vtype_stringptr, &message_id },
630 { "message_headers", vtype_msgheaders, NULL },
631 { "message_headers_raw", vtype_msgheaders_raw, NULL },
632 { "message_id", vtype_stringptr, &message_id },
633 { "message_linecount", vtype_int, &message_linecount },
634 { "message_size", vtype_int, &message_size },
636 { "message_smtputf8", vtype_bool, &message_smtputf8 },
638 #ifdef WITH_CONTENT_SCAN
639 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
640 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
641 { "mime_boundary", vtype_stringptr, &mime_boundary },
642 { "mime_charset", vtype_stringptr, &mime_charset },
643 { "mime_content_description", vtype_stringptr, &mime_content_description },
644 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
645 { "mime_content_id", vtype_stringptr, &mime_content_id },
646 { "mime_content_size", vtype_int, &mime_content_size },
647 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
648 { "mime_content_type", vtype_stringptr, &mime_content_type },
649 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
650 { "mime_filename", vtype_stringptr, &mime_filename },
651 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
652 { "mime_is_multipart", vtype_int, &mime_is_multipart },
653 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
654 { "mime_part_count", vtype_int, &mime_part_count },
656 { "n0", vtype_filter_int, &filter_n[0] },
657 { "n1", vtype_filter_int, &filter_n[1] },
658 { "n2", vtype_filter_int, &filter_n[2] },
659 { "n3", vtype_filter_int, &filter_n[3] },
660 { "n4", vtype_filter_int, &filter_n[4] },
661 { "n5", vtype_filter_int, &filter_n[5] },
662 { "n6", vtype_filter_int, &filter_n[6] },
663 { "n7", vtype_filter_int, &filter_n[7] },
664 { "n8", vtype_filter_int, &filter_n[8] },
665 { "n9", vtype_filter_int, &filter_n[9] },
666 { "original_domain", vtype_stringptr, &deliver_domain_orig },
667 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
668 { "originator_gid", vtype_gid, &originator_gid },
669 { "originator_uid", vtype_uid, &originator_uid },
670 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
671 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
672 { "pid", vtype_pid, NULL },
674 { "prdr_requested", vtype_bool, &prdr_requested },
676 { "primary_hostname", vtype_stringptr, &primary_hostname },
677 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
678 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
679 { "proxy_external_port", vtype_int, &proxy_external_port },
680 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
681 { "proxy_local_port", vtype_int, &proxy_local_port },
682 { "proxy_session", vtype_bool, &proxy_session },
684 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
685 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
686 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
687 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
688 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
689 { "queue_name", vtype_stringptr, &queue_name },
690 { "queue_size", vtype_string_func, (void *) &fn_queue_size },
691 { "rcpt_count", vtype_int, &rcpt_count },
692 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
693 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
694 { "received_count", vtype_int, &received_count },
695 { "received_for", vtype_stringptr, &received_for },
696 { "received_ip_address", vtype_stringptr, &interface_address },
697 { "received_port", vtype_int, &interface_port },
698 { "received_protocol", vtype_stringptr, &received_protocol },
699 { "received_time", vtype_int, &received_time.tv_sec },
700 { "recipient_data", vtype_stringptr, &recipient_data },
701 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
702 { "recipients", vtype_string_func, (void *) &fn_recipients },
703 { "recipients_count", vtype_int, &recipients_count },
704 { "regex_cachesize", vtype_int, ®ex_cachesize },/* undocumented; devel observability */
705 #ifdef WITH_CONTENT_SCAN
706 { "regex_match_string", vtype_stringptr, ®ex_match_string },
708 { "reply_address", vtype_reply, NULL },
709 { "return_path", vtype_stringptr, &return_path },
710 { "return_size_limit", vtype_int, &bounce_return_size_limit },
711 { "router_name", vtype_stringptr, &router_name },
712 { "runrc", vtype_int, &runrc },
713 { "self_hostname", vtype_stringptr, &self_hostname },
714 { "sender_address", vtype_stringptr, &sender_address },
715 { "sender_address_data", vtype_stringptr, &sender_address_data },
716 { "sender_address_domain", vtype_domain, &sender_address },
717 { "sender_address_local_part", vtype_localpart, &sender_address },
718 { "sender_data", vtype_stringptr, &sender_data },
719 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
720 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
721 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
722 { "sender_helo_verified",vtype_string_func, (void *) &sender_helo_verified_boolstr },
723 { "sender_host_address", vtype_stringptr, &sender_host_address },
724 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
725 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
726 { "sender_host_name", vtype_host_lookup, NULL },
727 { "sender_host_port", vtype_int, &sender_host_port },
728 { "sender_ident", vtype_stringptr, &sender_ident },
729 { "sender_rate", vtype_stringptr, &sender_rate },
730 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
731 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
732 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
733 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
734 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
735 { "sending_port", vtype_int, &sending_port },
736 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
737 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
738 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
739 { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
740 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
741 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
742 { "sn0", vtype_filter_int, &filter_sn[0] },
743 { "sn1", vtype_filter_int, &filter_sn[1] },
744 { "sn2", vtype_filter_int, &filter_sn[2] },
745 { "sn3", vtype_filter_int, &filter_sn[3] },
746 { "sn4", vtype_filter_int, &filter_sn[4] },
747 { "sn5", vtype_filter_int, &filter_sn[5] },
748 { "sn6", vtype_filter_int, &filter_sn[6] },
749 { "sn7", vtype_filter_int, &filter_sn[7] },
750 { "sn8", vtype_filter_int, &filter_sn[8] },
751 { "sn9", vtype_filter_int, &filter_sn[9] },
752 #ifdef WITH_CONTENT_SCAN
753 { "spam_action", vtype_stringptr, &spam_action },
754 { "spam_bar", vtype_stringptr, &spam_bar },
755 { "spam_report", vtype_stringptr, &spam_report },
756 { "spam_score", vtype_stringptr, &spam_score },
757 { "spam_score_int", vtype_stringptr, &spam_score_int },
760 { "spf_guess", vtype_stringptr, &spf_guess },
761 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
762 { "spf_received", vtype_stringptr, &spf_received },
763 { "spf_result", vtype_stringptr, &spf_result },
764 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
765 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
767 { "spool_directory", vtype_stringptr, &spool_directory },
768 { "spool_inodes", vtype_pinodes, (void *)TRUE },
769 { "spool_space", vtype_pspace, (void *)TRUE },
771 { "srs_recipient", vtype_stringptr, &srs_recipient },
773 { "thisaddress", vtype_stringptr, &filter_thisaddress },
775 /* The non-(in,out) variables are now deprecated */
776 { "tls_bits", vtype_int, &tls_in.bits },
777 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
778 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
780 { "tls_in_bits", vtype_int, &tls_in.bits },
781 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
782 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
783 { "tls_in_cipher_std", vtype_stringptr, &tls_in.cipher_stdname },
784 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
785 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
786 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
787 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
788 #ifndef DISABLE_TLS_RESUME
789 { "tls_in_resumption", vtype_int, &tls_in.resumption },
792 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
794 { "tls_in_ver", vtype_stringptr, &tls_in.ver },
795 { "tls_out_bits", vtype_int, &tls_out.bits },
796 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
797 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
798 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },
800 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
802 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
803 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
804 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
805 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
806 #ifndef DISABLE_TLS_RESUME
807 { "tls_out_resumption", vtype_int, &tls_out.resumption },
810 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
813 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
815 { "tls_out_ver", vtype_stringptr, &tls_out.ver },
817 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
819 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
822 { "tod_bsdinbox", vtype_todbsdin, NULL },
823 { "tod_epoch", vtype_tode, NULL },
824 { "tod_epoch_l", vtype_todel, NULL },
825 { "tod_full", vtype_todf, NULL },
826 { "tod_log", vtype_todl, NULL },
827 { "tod_logfile", vtype_todlf, NULL },
828 { "tod_zone", vtype_todzone, NULL },
829 { "tod_zulu", vtype_todzulu, NULL },
830 { "transport_name", vtype_stringptr, &transport_name },
831 { "value", vtype_stringptr, &lookup_value },
832 { "verify_mode", vtype_stringptr, &verify_mode },
833 { "version_number", vtype_stringptr, &version_string },
834 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
835 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
836 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
837 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
838 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
839 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
845 uschar * fn_arc_domains(void) {return NULL;}
846 uschar * fn_hdrs_added(void) {return NULL;}
847 uschar * fn_queue_size(void) {return NULL;}
848 uschar * fn_recipients(void) {return NULL;}
849 uschar * sender_helo_verified_boolstr(void) {return NULL;}
850 uschar * smtp_cmd_hist(void) {return NULL;}
855 expansion_items(void)
858 for (int i = 0; i < nelem(item_table); i++)
860 spf(buf, sizeof(buf), CUS"_EXP_ITEM_%T", item_table[i]);
861 builtin_macro_create(buf);
865 expansion_operators(void)
868 for (int i = 0; i < nelem(op_table_underscore); i++)
870 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_underscore[i]);
871 builtin_macro_create(buf);
873 for (int i = 0; i < nelem(op_table_main); i++)
875 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_main[i]);
876 builtin_macro_create(buf);
880 expansion_conditions(void)
883 for (int i = 0; i < nelem(cond_table); i++)
885 spf(buf, sizeof(buf), CUS"_EXP_COND_%T", cond_table[i]);
886 builtin_macro_create(buf);
890 expansion_variables(void)
893 for (int i = 0; i < nelem(var_table); i++)
895 spf(buf, sizeof(buf), CUS"_EXP_VAR_%T", var_table[i].name);
896 builtin_macro_create(buf);
904 expansion_operators();
905 expansion_conditions();
906 expansion_variables();
909 #else /*!MACRO_PREDEF*/
911 static uschar var_buffer[256];
912 static BOOL malformed_header;
914 /* For textual hashes */
916 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
917 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
920 enum { HMAC_MD5, HMAC_SHA1 };
922 /* For numeric hashes */
924 static unsigned int prime[] = {
925 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
926 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
927 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
929 /* For printing modes in symbolic form */
931 static uschar *mtable_normal[] =
932 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
934 static uschar *mtable_setid[] =
935 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
937 static uschar *mtable_sticky[] =
938 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
940 /* flags for find_header() */
941 #define FH_EXISTS_ONLY BIT(0)
942 #define FH_WANT_RAW BIT(1)
943 #define FH_WANT_LIST BIT(2)
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. */
1814 if (!f.enable_dollar_recipients) return NULL;
1816 for (int i = 0; i < recipients_count; i++)
1818 s = recipients_list[i].address;
1819 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1821 return string_from_gstring(g);
1825 /*************************************************
1826 * Return size of queue *
1827 *************************************************/
1828 /* Ask the daemon for the queue size */
1833 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1837 const uschar * where;
1840 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
1842 DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));
1846 len = daemon_client_sockname(&sa_un, &sname);
1848 if (bind(fd, (const struct sockaddr *)&sa_un, (socklen_t)len) < 0)
1849 { where = US"bind"; goto bad; }
1852 debug_printf("local addr '%s%s'\n",
1853 *sa_un.sun_path ? "" : "@",
1854 sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1857 len = daemon_notifier_sockname(&sa_un);
1858 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
1859 { where = US"connect"; goto bad2; }
1861 buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1862 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1864 if (poll_one_fd(fd, POLLIN, 2 * 1000) != 1)
1866 DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1867 len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1869 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1870 { where = US"recv"; goto bad2; }
1873 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1876 return string_copyn(buf, len);
1879 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1884 DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1889 /*************************************************
1890 * Find value of a variable *
1891 *************************************************/
1893 /* The table of variables is kept in alphabetic order, so we can search it
1894 using a binary chop. The "choplen" variable is nothing to do with the binary
1898 name the name of the variable being sought
1899 exists_only TRUE if this is a def: test; passed on to find_header()
1900 skipping TRUE => skip any processing evaluation; this is not the same as
1901 exists_only because def: may test for values that are first
1903 newsize pointer to an int which is initially zero; if the answer is in
1904 a new memory buffer, *newsize is set to its size
1906 Returns: NULL if the variable does not exist, or
1907 a pointer to the variable's contents, or
1908 something non-NULL if exists_only is TRUE
1911 static const uschar *
1912 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1919 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1920 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1921 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1922 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1923 (this gave backwards compatibility at the changeover). There may be built-in
1924 variables whose names start acl_ but they should never start in this way. This
1925 slightly messy specification is a consequence of the history, needless to say.
1927 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1928 set, in which case give an error. */
1930 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1934 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1935 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1937 else if (Ustrncmp(name, "r_", 2) == 0)
1939 tree_node * node = tree_search(router_var, name + 2);
1940 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1943 /* Handle $auth<n>, $regex<n> variables. */
1945 if (Ustrncmp(name, "auth", 4) == 0)
1948 int n = Ustrtoul(name + 4, &endptr, 10);
1949 if (!*endptr && n != 0 && n <= AUTH_VARS)
1950 return auth_vars[n-1] ? auth_vars[n-1] : US"";
1952 #ifdef WITH_CONTENT_SCAN
1953 else if (Ustrncmp(name, "regex", 5) == 0)
1956 int n = Ustrtoul(name + 5, &endptr, 10);
1957 if (!*endptr && n != 0 && n <= REGEX_VARS)
1958 return regex_vars[n-1] ? regex_vars[n-1] : US"";
1962 /* For all other variables, search the table */
1964 if (!(vp = find_var_ent(name)))
1965 return NULL; /* Unknown variable name */
1967 /* Found an existing variable. If in skipping state, the value isn't needed,
1968 and we want to avoid processing (such as looking up the host name). */
1976 case vtype_filter_int:
1977 if (!f.filter_running) return NULL;
1981 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1985 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1989 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1993 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1997 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
2000 case vtype_stringptr: /* Pointer to string */
2001 return (s = *((uschar **)(val))) ? s : US"";
2004 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
2007 case vtype_load_avg:
2008 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
2011 case vtype_host_lookup: /* Lookup if not done so */
2012 if ( !sender_host_name && sender_host_address
2013 && !host_lookup_failed && host_name_lookup() == OK)
2014 host_build_sender_fullhost();
2015 return sender_host_name ? sender_host_name : US"";
2017 case vtype_localpart: /* Get local part from address */
2018 if (!(s = *((uschar **)(val)))) return US"";
2019 if (!(domain = Ustrrchr(s, '@'))) return s;
2020 if (domain - s > sizeof(var_buffer) - 1)
2021 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
2022 " in string expansion", sizeof(var_buffer));
2023 return string_copyn(s, domain - s);
2025 case vtype_domain: /* Get domain from address */
2026 if (!(s = *((uschar **)(val)))) return US"";
2027 domain = Ustrrchr(s, '@');
2028 return domain ? domain + 1 : US"";
2030 case vtype_msgheaders:
2031 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
2033 case vtype_msgheaders_raw:
2034 return find_header(NULL, newsize,
2035 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
2037 case vtype_msgbody: /* Pointer to msgbody string */
2038 case vtype_msgbody_end: /* Ditto, the end of the msg */
2039 ss = (uschar **)(val);
2040 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
2043 off_t start_offset = SPOOL_DATA_START_OFFSET;
2044 int len = message_body_visible;
2046 if (len > message_size) len = message_size;
2047 *ss = body = store_get(len+1, GET_TAINTED);
2049 if (vp->type == vtype_msgbody_end)
2051 struct stat statbuf;
2052 if (fstat(deliver_datafile, &statbuf) == 0)
2054 start_offset = statbuf.st_size - len;
2055 if (start_offset < SPOOL_DATA_START_OFFSET)
2056 start_offset = SPOOL_DATA_START_OFFSET;
2059 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
2060 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
2062 if ((len = read(deliver_datafile, body, len)) > 0)
2065 if (message_body_newlines) /* Separate loops for efficiency */
2067 { if (body[--len] == 0) body[len] = ' '; }
2070 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
2073 return *ss ? *ss : US"";
2075 case vtype_todbsdin: /* BSD inbox time of day */
2076 return tod_stamp(tod_bsdin);
2078 case vtype_tode: /* Unix epoch time of day */
2079 return tod_stamp(tod_epoch);
2081 case vtype_todel: /* Unix epoch/usec time of day */
2082 return tod_stamp(tod_epoch_l);
2084 case vtype_todf: /* Full time of day */
2085 return tod_stamp(tod_full);
2087 case vtype_todl: /* Log format time of day */
2088 return tod_stamp(tod_log_bare); /* (without timezone) */
2090 case vtype_todzone: /* Time zone offset only */
2091 return tod_stamp(tod_zone);
2093 case vtype_todzulu: /* Zulu time */
2094 return tod_stamp(tod_zulu);
2096 case vtype_todlf: /* Log file datestamp tod */
2097 return tod_stamp(tod_log_datestamp_daily);
2099 case vtype_reply: /* Get reply address */
2100 s = find_header(US"reply-to:", newsize,
2101 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2103 if (s) Uskip_whitespace(&s);
2106 *newsize = 0; /* For the *s==0 case */
2107 s = find_header(US"from:", newsize,
2108 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2114 Uskip_whitespace(&s);
2115 for (t = s; *t; t++) if (*t == '\n') *t = ' ';
2116 while (t > s && isspace(t[-1])) t--;
2119 return s ? s : US"";
2121 case vtype_string_func:
2123 stringptr_fn_t * fn = (stringptr_fn_t *) val;
2125 return s ? s : US"";
2131 sprintf(CS var_buffer, PR_EXIM_ARITH,
2132 receive_statvfs(val == (void *)TRUE, &inodes));
2139 (void) receive_statvfs(val == (void *)TRUE, &inodes);
2140 sprintf(CS var_buffer, "%d", inodes);
2145 return *(void **)val ? US"<cert>" : US"";
2147 #ifndef DISABLE_DKIM
2149 return dkim_exim_expand_query((int)(long)val);
2154 return NULL; /* Unknown variable. Silences static checkers. */
2161 modify_variable(uschar *name, void * value)
2164 if ((vp = find_var_ent(name))) vp->value = value;
2165 return; /* Unknown variable name, fail silently */
2173 /*************************************************
2174 * Read and expand substrings *
2175 *************************************************/
2177 /* This function is called to read and expand argument substrings for various
2178 expansion items. Some have a minimum requirement that is less than the maximum;
2179 in these cases, the first non-present one is set to NULL.
2182 sub points to vector of pointers to set
2183 n maximum number of substrings
2185 sptr points to current string pointer
2187 skipping the skipping flag
2188 check_end if TRUE, check for final '}'
2189 name name of item, for error message
2190 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2192 textonly_p if not NULL, pointer to bitmask of which subs were text-only
2193 (did not change when expended)
2195 Returns: -1 OK; string pointer updated, but in "skipping" mode
2196 0 OK; string pointer updated
2197 1 curly bracketing error (too few arguments)
2198 2 too many arguments (only if check_end is set); message set
2199 3 other error (expansion failure)
2203 read_subs(uschar ** sub, int n, int m, const uschar ** sptr, esi_flags flags,
2204 BOOL check_end, uschar * name, BOOL * resetok, unsigned * textonly_p)
2206 const uschar * s = *sptr;
2207 unsigned textonly_l = 0;
2209 Uskip_whitespace(&s);
2210 for (int i = 0; i < n; i++)
2217 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2218 "(min is %d)", name, m);
2224 if (!(sub[i] = expand_string_internal(s+1,
2225 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, &s, resetok,
2226 textonly_p ? &textonly : NULL)))
2228 if (*s++ != '}') return 1;
2229 if (textonly_p && textonly) textonly_l |= BIT(i);
2230 Uskip_whitespace(&s);
2232 if (check_end && *s++ != '}')
2236 expand_string_message = string_sprintf("Too many arguments for '%s' "
2237 "(max is %d)", name, n);
2240 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2244 if (textonly_p) *textonly_p = textonly_l;
2246 return flags & ESI_SKIPPING ? -1 : 0;
2252 /*************************************************
2253 * Elaborate message for bad variable *
2254 *************************************************/
2256 /* For the "unknown variable" message, take a look at the variable's name, and
2257 give additional information about possible ACL variables. The extra information
2258 is added on to expand_string_message.
2260 Argument: the name of the variable
2265 check_variable_error_message(uschar *name)
2267 if (Ustrncmp(name, "acl_", 4) == 0)
2268 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2269 (name[4] == 'c' || name[4] == 'm')?
2271 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2272 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2274 US"user-defined ACL variables must start acl_c or acl_m");
2280 Load args from sub array to globals, and call acl_check().
2281 Sub array will be corrupted on return.
2283 Returns: OK access is granted by an ACCEPT verb
2284 DISCARD access is (apparently) granted by a DISCARD verb
2285 FAIL access is denied
2286 FAIL_DROP access is denied; drop the connection
2287 DEFER can't tell at the moment
2291 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2294 int sav_narg = acl_narg;
2296 uschar * dummy_logmsg;
2297 extern int acl_where;
2299 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2300 for (i = 0; i < nsub && sub[i+1]; i++)
2302 uschar * tmp = acl_arg[i];
2303 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2304 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2309 sub[i+1] = acl_arg[i];
2310 acl_arg[i++] = NULL;
2314 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2316 acl_narg>0 ? acl_arg[0] : US"<none>",
2317 acl_narg>1 ? " +more" : "");
2319 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2321 for (i = 0; i < nsub; i++)
2322 acl_arg[i] = sub[i+1]; /* restore old args */
2323 acl_narg = sav_narg;
2331 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2332 The given string is modified on return. Leading whitespace is skipped while
2333 looking for the opening wrap character, then the rest is scanned for the trailing
2334 (non-escaped) wrap character. A backslash in the string will act as an escape.
2336 A nul is written over the trailing wrap, and a pointer to the char after the
2337 leading wrap is returned.
2340 s String for de-wrapping
2341 wrap Two-char string, the first being the opener, second the closer wrapping
2344 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2348 dewrap(uschar * s, const uschar * wrap)
2352 BOOL quotesmode = wrap[0] == wrap[1];
2354 if (Uskip_whitespace(&p) == *wrap)
2360 if (*p == '\\') p++;
2361 else if (!quotesmode && *p == wrap[-1]) depth++;
2362 else if (*p == *wrap)
2373 expand_string_message = string_sprintf("missing '%c'", *wrap);
2378 /* Pull off the leading array or object element, returning
2379 a copy in an allocated string. Update the list pointer.
2381 The element may itself be an abject or array.
2382 Return NULL when the list is empty.
2386 json_nextinlist(const uschar ** list)
2388 unsigned array_depth = 0, object_depth = 0;
2389 const uschar * s = *list, * item;
2391 skip_whitespace(&s);
2394 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2398 case '[': array_depth++; break;
2399 case ']': array_depth--; break;
2400 case '{': object_depth++; break;
2401 case '}': object_depth--; break;
2403 *list = *s ? s+1 : s;
2404 if (item == s) return NULL;
2405 item = string_copyn(item, s - item);
2406 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2412 /************************************************/
2413 /* Return offset in ops table, or -1 if not found.
2414 Repoint to just after the operator in the string.
2417 ss string representation of operator
2418 opname split-out operator name
2422 identify_operator(const uschar ** ss, uschar ** opname)
2424 const uschar * s = *ss;
2427 /* Numeric comparisons are symbolic */
2429 if (*s == '=' || *s == '>' || *s == '<')
2441 /* All other conditions are named */
2444 s = read_name(name, sizeof(name), s, US"_");
2447 /* If we haven't read a name, it means some non-alpha character is first. */
2451 expand_string_message = string_sprintf("condition name expected, "
2452 "but found \"%.16s\"", s);
2456 *opname = string_copy(name);
2458 return chop_match(name, cond_table, nelem(cond_table));
2462 /*************************************************
2463 * Handle MD5 or SHA-1 computation for HMAC *
2464 *************************************************/
2466 /* These are some wrapping functions that enable the HMAC code to be a bit
2467 cleaner. A good compiler will spot the tail recursion.
2470 type HMAC_MD5 or HMAC_SHA1
2471 remaining are as for the cryptographic hash functions
2477 chash_start(int type, void * base)
2479 if (type == HMAC_MD5)
2480 md5_start((md5 *)base);
2482 sha1_start((hctx *)base);
2486 chash_mid(int type, void * base, const uschar * string)
2488 if (type == HMAC_MD5)
2489 md5_mid((md5 *)base, string);
2491 sha1_mid((hctx *)base, string);
2495 chash_end(int type, void * base, const uschar * string, int length,
2498 if (type == HMAC_MD5)
2499 md5_end((md5 *)base, string, length, digest);
2501 sha1_end((hctx *)base, string, length, digest);
2508 /* Do an hmac_md5. The result is _not_ nul-terminated, and is sized as
2509 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2512 key encoding key, nul-terminated
2513 src data to be hashed, nul-terminated
2515 len size of output buffer
2519 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2522 const uschar * keyptr;
2524 unsigned int keylen;
2526 #define MD5_HASHLEN 16
2527 #define MD5_HASHBLOCKLEN 64
2529 uschar keyhash[MD5_HASHLEN];
2530 uschar innerhash[MD5_HASHLEN];
2531 uschar finalhash[MD5_HASHLEN];
2532 uschar innerkey[MD5_HASHBLOCKLEN];
2533 uschar outerkey[MD5_HASHBLOCKLEN];
2536 keylen = Ustrlen(keyptr);
2538 /* If the key is longer than the hash block length, then hash the key
2541 if (keylen > MD5_HASHBLOCKLEN)
2543 chash_start(HMAC_MD5, &md5_base);
2544 chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2546 keylen = MD5_HASHLEN;
2549 /* Now make the inner and outer key values */
2551 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2552 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2554 for (int i = 0; i < keylen; i++)
2556 innerkey[i] ^= keyptr[i];
2557 outerkey[i] ^= keyptr[i];
2560 /* Now do the hashes */
2562 chash_start(HMAC_MD5, &md5_base);
2563 chash_mid(HMAC_MD5, &md5_base, innerkey);
2564 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2566 chash_start(HMAC_MD5, &md5_base);
2567 chash_mid(HMAC_MD5, &md5_base, outerkey);
2568 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2570 /* Encode the final hash as a hex string, limited by output buffer size */
2573 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2575 if (j-- <= 0) break;
2576 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2577 if (j-- <= 0) break;
2578 *p++ = hex_digits[finalhash[i] & 0x0f];
2582 #endif /*SUPPORT_SRS*/
2585 /*************************************************
2586 * Read and evaluate a condition *
2587 *************************************************/
2591 s points to the start of the condition text
2592 resetok points to a BOOL which is written false if it is unsafe to
2593 free memory. Certain condition types (acl) may have side-effect
2594 allocation which must be preserved.
2595 yield points to a BOOL to hold the result of the condition test;
2596 if NULL, we are just reading through a condition that is
2597 part of an "or" combination to check syntax, or in a state
2598 where the answer isn't required
2600 Returns: a pointer to the first character after the condition, or
2604 static const uschar *
2605 eval_condition(const uschar * s, BOOL * resetok, BOOL * yield)
2607 BOOL testfor = TRUE;
2608 BOOL tempcond, combined_cond;
2610 BOOL sub2_honour_dollar = TRUE;
2611 BOOL is_forany, is_json, is_jsons;
2613 int_eximarith_t num[2];
2614 struct stat statbuf;
2617 const uschar * sub[10];
2618 unsigned sub_textonly = 0;
2621 if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;
2623 switch(cond_type = identify_operator(&s, &opname))
2625 /* def: tests for a non-empty variable, or for the existence of a header. If
2626 yield == NULL we are in a skipping state, and don't care about the answer. */
2634 expand_string_message = US"\":\" expected after \"def\"";
2638 s = read_name(name, sizeof(name), s+1, US"_");
2640 /* Test for a header's existence. If the name contains a closing brace
2641 character, this may be a user error where the terminating colon has been
2642 omitted. Set a flag to adjust a subsequent error message in this case. */
2644 if ( ( *(t = name) == 'h'
2645 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2647 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2650 s = read_header_name(name, sizeof(name), s);
2651 /* {-for-text-editors */
2652 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2654 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2657 /* Test for a variable's having a non-empty value. A non-existent variable
2658 causes an expansion failure. */
2662 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2664 expand_string_message = name[0]
2665 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2666 : US"variable name omitted after \"def:\"";
2667 check_variable_error_message(name);
2670 if (yield) *yield = (t[0] != 0) == testfor;
2677 /* first_delivery tests for first delivery attempt */
2679 case ECOND_FIRST_DELIVERY:
2680 if (yield) *yield = f.deliver_firsttime == testfor;
2684 /* queue_running tests for any process started by a queue runner */
2686 case ECOND_QUEUE_RUNNING:
2687 if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2691 /* exists: tests for file existence
2692 isip: tests for any IP address
2693 isip4: tests for an IPv4 address
2694 isip6: tests for an IPv6 address
2695 pam: does PAM authentication
2696 radius: does RADIUS authentication
2697 ldapauth: does LDAP authentication
2698 pwcheck: does Cyrus SASL pwcheck authentication
2707 case ECOND_LDAPAUTH:
2710 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2714 sub[0] = expand_string_internal(s+1,
2715 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
2716 &s, resetok, &textonly);
2717 if (!sub[0]) return NULL;
2718 if (textonly) sub_textonly |= BIT(0);
2720 /* {-for-text-editors */
2721 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2723 if (!yield) return s; /* No need to run the test if skipping */
2728 if ((expand_forbid & RDO_EXISTS) != 0)
2730 expand_string_message = US"File existence tests are not permitted";
2733 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2739 rc = string_is_ip_address(sub[0], NULL);
2740 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2741 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2744 /* Various authentication tests - all optionally compiled */
2748 rc = auth_call_pam(sub[0], &expand_string_message);
2751 goto COND_FAILED_NOT_COMPILED;
2752 #endif /* SUPPORT_PAM */
2755 #ifdef RADIUS_CONFIG_FILE
2756 rc = auth_call_radius(sub[0], &expand_string_message);
2759 goto COND_FAILED_NOT_COMPILED;
2760 #endif /* RADIUS_CONFIG_FILE */
2762 case ECOND_LDAPAUTH:
2765 /* Just to keep the interface the same */
2767 int old_pool = store_pool;
2768 store_pool = POOL_SEARCH;
2769 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2770 &expand_string_message, &do_cache);
2771 store_pool = old_pool;
2775 goto COND_FAILED_NOT_COMPILED;
2776 #endif /* LOOKUP_LDAP */
2779 #ifdef CYRUS_PWCHECK_SOCKET
2780 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2783 goto COND_FAILED_NOT_COMPILED;
2784 #endif /* CYRUS_PWCHECK_SOCKET */
2786 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2787 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2789 if (rc == ERROR || rc == DEFER) return NULL;
2790 *yield = (rc == OK) == testfor;
2796 /* call ACL (in a conditional context). Accept true, deny false.
2797 Defer is a forced-fail. Anything set by message= goes to $value.
2798 Up to ten parameters are used; we use the braces round the name+args
2799 like the saslauthd condition does, to permit a variable number of args.
2800 See also the expansion-item version EITEM_ACL and the traditional
2801 acl modifier ACLC_ACL.
2802 Since the ACL may allocate new global variables, tell our caller to not
2807 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2813 Uskip_whitespace(&s);
2814 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2816 switch(read_subs(sub, nelem(sub), 1, &s,
2817 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2819 case 1: expand_string_message = US"too few arguments or bracketing "
2822 case 3: return NULL;
2828 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2829 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2834 lookup_value = NULL;
2836 lookup_value = string_copy(user_msg);
2837 *yield = cond == testfor;
2841 f.expand_string_forcedfail = TRUE;
2844 expand_string_message = string_sprintf("%s from acl \"%s\"",
2845 rc_names[rc], sub[0]);
2853 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2855 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2857 However, the last two are optional. That is why the whole set is enclosed
2858 in their own set of braces. */
2860 case ECOND_SASLAUTHD:
2861 #ifndef CYRUS_SASLAUTHD_SOCKET
2862 goto COND_FAILED_NOT_COMPILED;
2866 Uskip_whitespace(&s);
2867 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2868 switch(read_subs(sub, nelem(sub), 2, &s,
2869 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2871 case 1: expand_string_message = US"too few arguments or bracketing "
2872 "error for saslauthd";
2874 case 3: return NULL;
2876 if (!sub[2]) sub[3] = NULL; /* realm if no service */
2879 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2880 &expand_string_message);
2881 if (rc == ERROR || rc == DEFER) return NULL;
2882 *yield = (rc == OK) == testfor;
2886 #endif /* CYRUS_SASLAUTHD_SOCKET */
2889 /* symbolic operators for numeric and string comparison, and a number of
2890 other operators, all requiring two arguments.
2892 crypteq: encrypts plaintext and compares against an encrypted text,
2893 using crypt(), crypt16(), MD5 or SHA-1
2894 inlist/inlisti: checks if first argument is in the list of the second
2895 match: does a regular expression match and sets up the numerical
2896 variables if it succeeds
2897 match_address: matches in an address list
2898 match_domain: matches in a domain list
2899 match_ip: matches a host list that is restricted to IP addresses
2900 match_local_part: matches in a local part list
2903 case ECOND_MATCH_ADDRESS:
2904 case ECOND_MATCH_DOMAIN:
2905 case ECOND_MATCH_IP:
2906 case ECOND_MATCH_LOCAL_PART:
2907 #ifndef EXPAND_LISTMATCH_RHS
2908 sub2_honour_dollar = FALSE;
2917 case ECOND_NUM_L: /* Numerical comparisons */
2924 case ECOND_STR_LT: /* String comparisons */
2935 for (int i = 0; i < 2; i++)
2938 /* Sometimes, we don't expand substrings; too many insecure configurations
2939 created using match_address{}{} and friends, where the second param
2940 includes information from untrustworthy sources. */
2941 /*XXX is this moot given taint-tracking? */
2943 esi_flags flags = ESI_BRACE_ENDS;
2945 if (!(i > 0 && !sub2_honour_dollar)) flags |= ESI_HONOR_DOLLAR;
2946 if (!yield) flags |= ESI_SKIPPING;
2948 if (Uskip_whitespace(&s) != '{')
2950 if (i == 0) goto COND_FAILED_CURLY_START;
2951 expand_string_message = string_sprintf("missing 2nd string in {} "
2952 "after \"%s\"", opname);
2955 if (!(sub[i] = expand_string_internal(s+1, flags, &s, resetok, &textonly)))
2957 if (textonly) sub_textonly |= BIT(i);
2958 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2959 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2960 " for security reasons\n");
2961 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2963 /* Convert to numerical if required; we know that the names of all the
2964 conditions that compare numbers do not start with a letter. This just saves
2965 checking for them individually. */
2967 if (!isalpha(opname[0]) && yield)
2972 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2976 num[i] = expanded_string_integer(sub[i], FALSE);
2977 if (expand_string_message) return NULL;
2981 /* Result not required */
2983 if (!yield) return s;
2985 /* Do an appropriate comparison */
2991 tempcond = (num[0] == num[1]); break;
2994 tempcond = (num[0] > num[1]); break;
2997 tempcond = (num[0] >= num[1]); break;
3000 tempcond = (num[0] < num[1]); break;
3003 tempcond = (num[0] <= num[1]); break;
3006 tempcond = (Ustrcmp(sub[0], sub[1]) < 0); break;
3009 tempcond = (strcmpic(sub[0], sub[1]) < 0); break;
3012 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0); break;
3015 tempcond = (strcmpic(sub[0], sub[1]) <= 0); break;
3018 tempcond = (Ustrcmp(sub[0], sub[1]) == 0); break;
3021 tempcond = (strcmpic(sub[0], sub[1]) == 0); break;
3024 tempcond = (Ustrcmp(sub[0], sub[1]) > 0); break;
3027 tempcond = (strcmpic(sub[0], sub[1]) > 0); break;
3030 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0); break;
3033 tempcond = (strcmpic(sub[0], sub[1]) >= 0); break;
3035 case ECOND_MATCH: /* Regular expression match */
3037 const pcre2_code * re = regex_compile(sub[1],
3038 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
3039 &expand_string_message, pcre_gen_cmp_ctx);
3043 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
3047 case ECOND_MATCH_ADDRESS: /* Match in an address list */
3048 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0,
3049 CUSS &lookup_value);
3050 goto MATCHED_SOMETHING;
3052 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
3053 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
3054 MCL_DOMAIN + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3055 goto MATCHED_SOMETHING;
3057 case ECOND_MATCH_IP: /* Match IP address in a host list */
3058 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
3060 expand_string_message = string_sprintf("\"%s\" is not an IP address",
3066 unsigned int *nullcache = NULL;
3067 check_host_block cb;
3069 cb.host_name = US"";
3070 cb.host_address = sub[0];
3072 /* If the host address starts off ::ffff: it is an IPv6 address in
3073 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3076 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3077 cb.host_address + 7 : cb.host_address;
3079 rc = match_check_list(
3080 &sub[1], /* the list */
3081 0, /* separator character */
3082 &hostlist_anchor, /* anchor pointer */
3083 &nullcache, /* cache pointer */
3084 check_host, /* function for testing */
3085 &cb, /* argument for function */
3086 MCL_HOST, /* type of check */
3087 sub[0], /* text for debugging */
3088 CUSS &lookup_value); /* where to pass back data */
3090 goto MATCHED_SOMETHING;
3092 case ECOND_MATCH_LOCAL_PART:
3093 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3094 MCL_LOCALPART + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3100 case OK: tempcond = TRUE; break;
3101 case FAIL: tempcond = FALSE; break;
3104 expand_string_message = string_sprintf("unable to complete match "
3105 "against \"%s\": %s", sub[1], search_error_message);
3111 /* Various "encrypted" comparisons. If the second string starts with
3112 "{" then an encryption type is given. Default to crypt() or crypt16()
3113 (build-time choice). */
3114 /* }-for-text-editors */
3117 #ifndef SUPPORT_CRYPTEQ
3118 goto COND_FAILED_NOT_COMPILED;
3120 if (strncmpic(sub[1], US"{md5}", 5) == 0)
3122 int sublen = Ustrlen(sub[1]+5);
3127 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3129 /* If the length that we are comparing against is 24, the MD5 digest
3130 is expressed as a base64 string. This is the way LDAP does it. However,
3131 some other software uses a straightforward hex representation. We assume
3132 this if the length is 32. Other lengths fail. */
3136 uschar *coded = b64encode(CUS digest, 16);
3137 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3138 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3139 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3141 else if (sublen == 32)
3144 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3146 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3147 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3148 tempcond = (strcmpic(coded, sub[1]+5) == 0);
3152 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3153 "fail\n crypted=%s\n", sub[1]+5);
3158 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3160 int sublen = Ustrlen(sub[1]+6);
3165 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3167 /* If the length that we are comparing against is 28, assume the SHA1
3168 digest is expressed as a base64 string. If the length is 40, assume a
3169 straightforward hex representation. Other lengths fail. */
3173 uschar *coded = b64encode(CUS digest, 20);
3174 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3175 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3176 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3178 else if (sublen == 40)
3181 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3183 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3184 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3185 tempcond = (strcmpic(coded, sub[1]+6) == 0);
3189 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3190 "fail\n crypted=%s\n", sub[1]+6);
3195 else /* {crypt} or {crypt16} and non-{ at start */
3196 /* }-for-text-editors */
3201 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3206 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3211 else if (sub[1][0] == '{') /* }-for-text-editors */
3213 expand_string_message = string_sprintf("unknown encryption mechanism "
3214 "in \"%s\"", sub[1]);
3220 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3221 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
3222 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3226 #define XSTR(s) STR(s)
3227 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3228 " subject=%s\n crypted=%s\n",
3229 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3234 /* If the encrypted string contains fewer than two characters (for the
3235 salt), force failure. Otherwise we get false positives: with an empty
3236 string the yield of crypt() is an empty string! */
3239 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3240 else if (errno == EINVAL)
3244 expand_string_message = string_sprintf("crypt error: %s\n",
3245 US strerror(errno));
3250 #endif /* SUPPORT_CRYPTEQ */
3255 const uschar * list = sub[1];
3257 uschar *save_iterate_item = iterate_item;
3258 int (*compare)(const uschar *, const uschar *);
3260 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);
3263 compare = cond_type == ECOND_INLISTI
3264 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3266 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3268 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3269 if (compare(sub[0], iterate_item) == 0)
3272 lookup_value = iterate_item;
3276 iterate_item = save_iterate_item;
3279 } /* Switch for comparison conditions */
3281 *yield = tempcond == testfor;
3282 return s; /* End of comparison conditions */
3285 /* and/or: computes logical and/or of several conditions */
3289 subcondptr = (yield == NULL) ? NULL : &tempcond;
3290 combined_cond = (cond_type == ECOND_AND);
3292 Uskip_whitespace(&s);
3293 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3297 /* {-for-text-editors */
3298 if (Uskip_whitespace(&s) == '}') break;
3299 if (*s != '{') /* }-for-text-editors */
3301 expand_string_message = string_sprintf("each subcondition "
3302 "inside an \"%s{...}\" condition must be in its own {}", opname);
3306 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3308 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3309 expand_string_message, opname);
3312 Uskip_whitespace(&s);
3314 /* {-for-text-editors */
3317 /* {-for-text-editors */
3318 expand_string_message = string_sprintf("missing } at end of condition "
3319 "inside \"%s\" group", opname);
3324 if (cond_type == ECOND_AND)
3326 combined_cond &= tempcond;
3327 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3328 } /* evaluate any more */
3331 combined_cond |= tempcond;
3332 if (combined_cond) subcondptr = NULL; /* once true, don't */
3333 } /* evaluate any more */
3336 if (yield) *yield = (combined_cond == testfor);
3340 /* forall/forany: iterates a condition with different values */
3342 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3343 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3344 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3345 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3346 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3347 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3351 const uschar * list;
3353 uschar *save_iterate_item = iterate_item;
3355 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3357 Uskip_whitespace(&s);
3358 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3359 if (!(sub[0] = expand_string_internal(s,
3360 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
3361 &s, resetok, NULL)))
3363 /* {-for-text-editors */
3364 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3366 Uskip_whitespace(&s);
3367 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3371 /* Call eval_condition once, with result discarded (as if scanning a
3372 "false" part). This allows us to find the end of the condition, because if
3373 the list it empty, we won't actually evaluate the condition for real. */
3375 if (!(s = eval_condition(sub[1], resetok, NULL)))
3377 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3378 expand_string_message, opname);
3381 Uskip_whitespace(&s);
3383 /* {-for-text-editors */
3386 /* {-for-text-editors */
3387 expand_string_message = string_sprintf("missing } at end of condition "
3388 "inside \"%s\"", opname);
3392 if (yield) *yield = !testfor;
3394 if (is_json) list = dewrap(string_copy(list), US"[]");
3395 while ((iterate_item = is_json
3396 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3399 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3401 expand_string_message =
3402 string_sprintf("%s wrapping string result for extract jsons",
3403 expand_string_message);
3404 iterate_item = save_iterate_item;
3408 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3409 if (!eval_condition(sub[1], resetok, &tempcond))
3411 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3412 expand_string_message, opname);
3413 iterate_item = save_iterate_item;
3416 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3417 tempcond? "true":"false");
3419 if (yield) *yield = (tempcond == testfor);
3420 if (tempcond == is_forany) break;
3423 iterate_item = save_iterate_item;
3428 /* The bool{} expansion condition maps a string to boolean.
3429 The values supported should match those supported by the ACL condition
3430 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3431 of true/false. Note that Router "condition" rules have a different
3432 interpretation, where general data can be used and only a few values
3434 Note that readconf.c boolean matching, for boolean configuration options,
3435 only matches true/yes/false/no.
3436 The bool_lax{} condition matches the Router logic, which is much more
3439 case ECOND_BOOL_LAX:
3445 BOOL boolvalue = FALSE;
3447 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3448 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3449 switch(read_subs(sub_arg, 1, 1, &s,
3450 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, ourname, resetok, NULL))
3452 case 1: expand_string_message = string_sprintf(
3453 "too few arguments or bracketing error for %s",
3457 case 3: return NULL;
3460 Uskip_whitespace(&t);
3461 if ((len = Ustrlen(t)))
3463 /* trailing whitespace: seems like a good idea to ignore it too */
3465 while (isspace(*t2)) t2--;
3466 if (t2 != (t + len))
3473 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3474 /* logic for the lax case from expand_check_condition(), which also does
3475 expands, and the logic is both short and stable enough that there should
3476 be no maintenance burden from replicating it. */
3480 ? Ustrspn(t+1, "0123456789") == len-1
3481 : Ustrspn(t, "0123456789") == len)
3483 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3484 /* expand_check_condition only does a literal string "0" check */
3485 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3488 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3490 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3492 else if (cond_type == ECOND_BOOL_LAX)
3496 expand_string_message = string_sprintf("unrecognised boolean "
3500 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3501 boolvalue? "true":"false");
3502 if (yield) *yield = (boolvalue == testfor);
3507 case ECOND_INBOUND_SRS:
3508 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */
3511 const pcre2_code * re;
3512 pcre2_match_data * md;
3516 BOOL boolvalue = FALSE;
3518 switch(read_subs(sub, 2, 2, CUSS &s,
3519 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, name, resetok, NULL))
3521 case 1: expand_string_message = US"too few arguments or bracketing "
3522 "error for inbound_srs";
3524 case 3: return NULL;
3527 /* Match the given local_part against the SRS-encoded pattern */
3529 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]+)=([^=]*)=(.*)$",
3530 MCS_CASELESS | MCS_CACHEABLE, FALSE);
3531 md = pcre2_match_data_create(4+1, pcre_gen_ctx);
3532 if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,
3533 md, pcre_gen_mtc_ctx) < 0)
3535 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3538 ovec = pcre2_get_ovector_pointer(md);
3540 if (sub[0][0] == '"')
3542 else for (uschar * s = sub[0]; *s; s++)
3543 if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3544 { quoting = 1; break; }
3546 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3548 /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3550 srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S", /* lowercased */
3552 (int) (ovec[9]-ovec[8]), sub[0] + ovec[8], /* substr 4 */
3554 (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */
3556 /* If a zero-length secret was given, we're done. Otherwise carry on
3557 and validate the given SRS local_part againt our secret. */
3565 /* check the timestamp */
3568 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3572 gettimeofday(&now, NULL);
3573 now.tv_sec /= 86400; /* days since epoch */
3575 /* Decode substring 2 from base32 to a number */
3577 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3579 uschar * t = Ustrchr(base32_chars, *ss++);
3580 d = d * 32 + (t - base32_chars);
3583 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3585 DEBUG(D_expand) debug_printf("SRS too old\n");
3590 /* check length of substring 1, the offered checksum */
3592 if (ovec[3]-ovec[2] != 4)
3594 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3598 /* Hash the address with our secret, and compare that computed checksum
3599 with the one extracted from the arg */
3601 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3602 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3604 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3610 /* pcre2_match_data_free(md); gen ctx needs no free */
3611 if (yield) *yield = (boolvalue == testfor);
3614 #endif /*SUPPORT_SRS*/
3616 /* Unknown condition */
3619 if (!expand_string_message || !*expand_string_message)
3620 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3622 } /* End switch on condition type */
3624 /* Missing braces at start and end of data */
3626 COND_FAILED_CURLY_START:
3627 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3630 COND_FAILED_CURLY_END:
3631 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3635 /* A condition requires code that is not compiled */
3637 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3638 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3639 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3640 COND_FAILED_NOT_COMPILED:
3641 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3650 /*************************************************
3651 * Save numerical variables *
3652 *************************************************/
3654 /* This function is called from items such as "if" that want to preserve and
3655 restore the numbered variables.
3658 save_expand_string points to an array of pointers to set
3659 save_expand_nlength points to an array of ints for the lengths
3661 Returns: the value of expand max to save
3665 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3667 for (int i = 0; i <= expand_nmax; i++)
3669 save_expand_nstring[i] = expand_nstring[i];
3670 save_expand_nlength[i] = expand_nlength[i];
3677 /*************************************************
3678 * Restore numerical variables *
3679 *************************************************/
3681 /* This function restored saved values of numerical strings.
3684 save_expand_nmax the number of strings to restore
3685 save_expand_string points to an array of pointers
3686 save_expand_nlength points to an array of ints
3692 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3693 int *save_expand_nlength)
3695 expand_nmax = save_expand_nmax;
3696 for (int i = 0; i <= expand_nmax; i++)
3698 expand_nstring[i] = save_expand_nstring[i];
3699 expand_nlength[i] = save_expand_nlength[i];
3707 /*************************************************
3708 * Handle yes/no substrings *
3709 *************************************************/
3711 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3712 alternative substrings that depend on whether or not the condition was true,
3713 or the lookup or extraction succeeded. The substrings always have to be
3714 expanded, to check their syntax, but "skipping" is set when the result is not
3715 needed - this avoids unnecessary nested lookups.
3719 skipping TRUE if we were skipping when this item was reached
3720 yes TRUE if the first string is to be used, else use the second
3721 save_lookup a value to put back into lookup_value before the 2nd expansion
3722 sptr points to the input string pointer
3723 yieldptr points to the output growable-string pointer
3724 type "lookup", "if", "extract", "run", "env", "listextract" or
3725 "certextract" for error message
3726 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3729 Returns: 0 OK; lookup_value has been reset to save_lookup
3731 2 expansion failed because of bracketing error
3735 process_yesno(esi_flags flags, BOOL yes, uschar *save_lookup, const uschar **sptr,
3736 gstring ** yieldptr, uschar *type, BOOL *resetok)
3739 const uschar *s = *sptr; /* Local value */
3740 uschar *sub1, *sub2;
3741 const uschar * errwhere;
3743 flags &= ESI_SKIPPING; /* Ignore all buf the skipping flag */
3745 /* If there are no following strings, we substitute the contents of $value for
3746 lookups and for extractions in the success case. For the ${if item, the string
3747 "true" is substituted. In the fail case, nothing is substituted for all three
3750 if (skip_whitespace(&s) == '}')
3754 if (yes && !(flags & ESI_SKIPPING))
3755 *yieldptr = string_catn(*yieldptr, US"true", 4);
3759 if (yes && lookup_value && !(flags & ESI_SKIPPING))
3760 *yieldptr = string_cat(*yieldptr, lookup_value);
3761 lookup_value = save_lookup;
3767 /* The first following string must be braced. */
3771 errwhere = US"'yes' part did not start with '{'"; /*}}*/
3775 /* Expand the first substring. Forced failures are noticed only if we actually
3776 want this string. Set skipping in the call in the fail case (this will always
3777 be the case if we were already skipping). */
3779 sub1 = expand_string_internal(s,
3780 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yes ? ESI_NOFLAGS : ESI_SKIPPING),
3782 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3783 f.expand_string_forcedfail = FALSE;
3787 errwhere = US"'yes' part did not end with '}'";
3791 /* If we want the first string, add it to the output */
3794 *yieldptr = string_cat(*yieldptr, sub1);
3796 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3797 $value to what it was at the start of the item, so that it has this value
3798 during the second string expansion. For the call from "if" or "run" to this
3799 function, save_lookup is set to lookup_value, so that this statement does
3802 lookup_value = save_lookup;
3804 /* There now follows either another substring, or "fail", or nothing. This
3805 time, forced failures are noticed only if we want the second string. We must
3806 set skipping in the nested call if we don't want this string, or if we were
3807 already skipping. */
3809 if (skip_whitespace(&s) == '{') /*}*/
3811 esi_flags s_flags = ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags;
3812 if (yes) s_flags |= ESI_SKIPPING;
3813 sub2 = expand_string_internal(s+1, s_flags, &s, resetok, NULL);
3814 if (!sub2 && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3815 f.expand_string_forcedfail = FALSE; /*{*/
3818 errwhere = US"'no' part did not start with '{'"; /*}*/
3822 /* If we want the second string, add it to the output */
3825 *yieldptr = string_cat(*yieldptr, sub2);
3828 /* If there is no second string, but the word "fail" is present when the use of
3829 the second string is wanted, set a flag indicating it was a forced failure
3830 rather than a syntactic error. Swallow the terminating } in case this is nested
3831 inside another lookup or if or extract. */
3836 /* deconst cast ok here as source is s anyway */
3837 s = US read_name(name, sizeof(name), s, US"_");
3838 if (Ustrcmp(name, "fail") == 0)
3840 if (!yes && !(flags & ESI_SKIPPING))
3842 Uskip_whitespace(&s); /*{{*/
3845 errwhere = US"did not close with '}' after forcedfail";
3848 expand_string_message =
3849 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3850 f.expand_string_forcedfail = TRUE;
3856 expand_string_message =
3857 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3862 /* All we have to do now is to check on the final closing brace. */
3864 skip_whitespace(&s); /*{{*/
3867 errwhere = US"did not close with '}'";
3873 /* Update the input pointer value before returning */
3878 /* Get here if there is a bracketing failure */
3879 expand_string_message = string_sprintf(
3880 "curly-bracket problem in conditional yes/no parsing: %s\n"
3881 " remaining string is '%s'", errwhere, --s);
3886 /* Get here for other failures */
3894 /********************************************************
3895 * prvs: Get last three digits of days since Jan 1, 1970 *
3896 ********************************************************/
3898 /* This is needed to implement the "prvs" BATV reverse
3901 Argument: integer "days" offset to add or substract to
3902 or from the current number of days.
3904 Returns: pointer to string containing the last three
3905 digits of the number of days since Jan 1, 1970,
3906 modified by the offset argument, NULL if there
3907 was an error in the conversion.
3912 prvs_daystamp(int day_offset)
3914 uschar * days = store_get(32, GET_UNTAINTED); /* Need at least 24 for cases */
3915 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3916 (time(NULL) + day_offset*86400)/86400);
3917 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3922 /********************************************************
3923 * prvs: perform HMAC-SHA1 computation of prvs bits *
3924 ********************************************************/
3926 /* This is needed to implement the "prvs" BATV reverse
3930 address RFC2821 Address to use
3931 key The key to use (must be less than 64 characters
3933 key_num Single-digit key number to use. Defaults to
3936 Returns: pointer to string containing the first three
3937 bytes of the final hash in hex format, NULL if
3938 there was an error in the process.
3942 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3944 gstring * hash_source;
3947 uschar innerhash[20];
3948 uschar finalhash[20];
3949 uschar innerkey[64];
3950 uschar outerkey[64];
3951 uschar *finalhash_hex;
3956 if (Ustrlen(key) > 64)
3959 hash_source = string_catn(NULL, key_num, 1);
3960 hash_source = string_catn(hash_source, daystamp, 3);
3961 hash_source = string_cat(hash_source, address);
3962 (void) string_from_gstring(hash_source);
3965 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3967 memset(innerkey, 0x36, 64);
3968 memset(outerkey, 0x5c, 64);
3970 for (int i = 0; i < Ustrlen(key); i++)
3972 innerkey[i] ^= key[i];
3973 outerkey[i] ^= key[i];
3976 chash_start(HMAC_SHA1, &h);
3977 chash_mid(HMAC_SHA1, &h, innerkey);
3978 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3980 chash_start(HMAC_SHA1, &h);
3981 chash_mid(HMAC_SHA1, &h, outerkey);
3982 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3984 /* Hashing is deemed sufficient to de-taint any input data */
3986 p = finalhash_hex = store_get(40, GET_UNTAINTED);
3987 for (int i = 0; i < 3; i++)
3989 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3990 *p++ = hex_digits[finalhash[i] & 0x0f];
3994 return finalhash_hex;
4000 /*************************************************
4001 * Join a file onto the output string *
4002 *************************************************/
4004 /* This is used for readfile/readsock and after a run expansion.
4005 It joins the contents of a file onto the output string, globally replacing
4006 newlines with a given string (optionally).
4010 yield pointer to the expandable string struct
4011 eol newline replacement string, or NULL
4013 Returns: new pointer for expandable string, terminated if non-null
4017 cat_file(FILE * f, gstring * yield, uschar * eol)
4019 uschar buffer[1024];
4021 while (Ufgets(buffer, sizeof(buffer), f))
4023 int len = Ustrlen(buffer);
4024 if (eol && buffer[len-1] == '\n') len--;
4025 yield = string_catn(yield, buffer, len);
4026 if (eol && buffer[len])
4027 yield = string_cat(yield, eol);
4035 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
4038 uschar buffer[1024];
4040 /*XXX could we read direct into a pre-grown string? */
4042 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
4043 for (uschar * s = buffer; rc--; s++)
4044 yield = eol && *s == '\n'
4045 ? string_cat(yield, eol) : string_catn(yield, s, 1);
4047 /* We assume that all errors, and any returns of zero bytes,
4048 are actually EOF. */
4055 /*************************************************
4056 * Evaluate numeric expression *
4057 *************************************************/
4059 /* This is a set of mutually recursive functions that evaluate an arithmetic
4060 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
4061 these functions that is called from elsewhere is eval_expr, whose interface is:
4064 sptr pointer to the pointer to the string - gets updated
4065 decimal TRUE if numbers are to be assumed decimal
4066 error pointer to where to put an error message - must be NULL on input
4067 endket TRUE if ')' must terminate - FALSE for external call
4069 Returns: on success: the value of the expression, with *error still NULL
4070 on failure: an undefined value, with *error = a message
4073 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4076 static int_eximarith_t
4077 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4080 int_eximarith_t x = eval_op_or(&s, decimal, error);
4085 *error = US"expecting closing parenthesis";
4087 while (isspace(*++s));
4089 *error = US"expecting operator";
4095 static int_eximarith_t
4096 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4102 if (isdigit((c = Uskip_whitespace(&s))))
4105 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4107 switch (tolower(*s))
4110 case 'k': n *= 1024; s++; break;
4111 case 'm': n *= 1024*1024; s++; break;
4112 case 'g': n *= 1024*1024*1024; s++; break;
4114 Uskip_whitespace(&s);
4119 n = eval_expr(&s, decimal, error, 1);
4123 *error = US"expecting number or opening parenthesis";
4131 static int_eximarith_t
4132 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4136 Uskip_whitespace(&s);
4137 if (*s == '+' || *s == '-' || *s == '~')
4140 x = eval_op_unary(&s, decimal, error);
4141 if (op == '-') x = -x;
4142 else if (op == '~') x = ~x;
4145 x = eval_number(&s, decimal, error);
4152 static int_eximarith_t
4153 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4156 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4159 while (*s == '*' || *s == '/' || *s == '%')
4162 int_eximarith_t y = eval_op_unary(&s, decimal, error);
4164 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4165 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4166 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4167 * -N*M is INT_MIN will yield INT_MIN.
4168 * Since we don't support floating point, this is somewhat simpler.
4169 * Ideally, we'd return an error, but since we overflow for all other
4170 * arithmetic, consistency suggests otherwise, but what's the correct value
4171 * to use? There is none.
4172 * The C standard guarantees overflow for unsigned arithmetic but signed
4173 * overflow invokes undefined behaviour; in practice, this is overflow
4174 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4175 * that long/longlong larger than int are available, or we could just work
4176 * with larger types. We should consider whether to guarantee 32bit eval
4177 * and 64-bit working variables, with errors returned. For now ...
4178 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4179 * can just let the other invalid results occur otherwise, as they have
4180 * until now. For this one case, we can coerce.
4182 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4185 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4186 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4196 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4212 static int_eximarith_t
4213 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4216 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4219 while (*s == '+' || *s == '-')
4222 int_eximarith_t y = eval_op_mult(&s, decimal, error);
4224 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4225 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4226 { /* over-conservative check */
4228 ? US"overflow in sum" : US"overflow in difference";
4231 if (op == '+') x += y; else x -= y;
4239 static int_eximarith_t
4240 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4243 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4246 while ((*s == '<' || *s == '>') && s[1] == s[0])
4251 y = eval_op_sum(&s, decimal, error);
4253 if (op == '<') x <<= y; else x >>= y;
4261 static int_eximarith_t
4262 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4265 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4272 y = eval_op_shift(&s, decimal, error);
4282 static int_eximarith_t
4283 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4286 int_eximarith_t x = eval_op_and(&s, decimal, error);
4293 y = eval_op_and(&s, decimal, error);
4303 static int_eximarith_t
4304 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4307 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4314 y = eval_op_xor(&s, decimal, error);
4325 /************************************************/
4326 /* Comparison operation for sort expansion. We need to avoid
4327 re-expanding the fields being compared, so need a custom routine.
4330 cond_type Comparison operator code
4331 leftarg, rightarg Arguments for comparison
4333 Return true iff (leftarg compare rightarg)
4337 sortsbefore(int cond_type, BOOL alpha_cond,
4338 const uschar * leftarg, const uschar * rightarg)
4340 int_eximarith_t l_num, r_num;
4344 l_num = expanded_string_integer(leftarg, FALSE);
4345 if (expand_string_message) return FALSE;
4346 r_num = expanded_string_integer(rightarg, FALSE);
4347 if (expand_string_message) return FALSE;
4351 case ECOND_NUM_G: return l_num > r_num;
4352 case ECOND_NUM_GE: return l_num >= r_num;
4353 case ECOND_NUM_L: return l_num < r_num;
4354 case ECOND_NUM_LE: return l_num <= r_num;
4361 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4362 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4363 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4364 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4365 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4366 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4367 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4368 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4371 return FALSE; /* should not happen */
4375 /* Expand a named list. Return false on failure. */
4377 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4379 tree_node *t = NULL;
4380 const uschar * list;
4383 BOOL needsep = FALSE;
4384 #define LISTNAMED_BUF_SIZE 256
4385 uschar b[LISTNAMED_BUF_SIZE];
4386 uschar * buffer = b;
4388 if (*name == '+') name++;
4389 if (!listtype) /* no-argument version */
4391 if ( !(t = tree_search(addresslist_anchor, name))
4392 && !(t = tree_search(domainlist_anchor, name))
4393 && !(t = tree_search(hostlist_anchor, name)))
4394 t = tree_search(localpartlist_anchor, name);
4396 else switch(*listtype) /* specific list-type version */
4398 case 'a': t = tree_search(addresslist_anchor, name); break;
4399 case 'd': t = tree_search(domainlist_anchor, name); break;
4400 case 'h': t = tree_search(hostlist_anchor, name); break;
4401 case 'l': t = tree_search(localpartlist_anchor, name); break;
4403 expand_string_message = US"bad suffix on \"list\" operator";
4409 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4411 : *listtype=='a'?"address "
4412 : *listtype=='d'?"domain "
4413 : *listtype=='h'?"host "
4414 : *listtype=='l'?"localpart "
4419 list = ((namedlist_block *)(t->data.ptr))->string;
4421 /* The list could be quite long so we (re)use a buffer for each element
4422 rather than getting each in new memory */
4424 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, GET_TAINTED);
4425 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4427 uschar * buf = US" : ";
4429 yield = string_catn(yield, buf, 3);
4433 if (*item == '+') /* list item is itself a named list */
4435 yield = expand_listnamed(yield, item, listtype);
4436 if (expand_string_message)
4440 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
4443 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4445 for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4447 yield = string_catn(yield, item, cp - CS item);
4448 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4449 yield = string_catn(yield, US"::", 2);
4450 else /* sep in item; should already be doubled; emit once */
4452 yield = string_catn(yield, US tok, 1);
4453 if (*cp == sep) cp++;
4456 yield = string_cat(yield, item);
4459 yield = string_cat(yield, item);
4466 /************************************************/
4468 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4472 debug_printf_indent("|");
4474 debug_printf_indent(UTF8_VERT_RIGHT);
4476 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4480 debug_printf(UTF8_HORIZ);
4482 debug_printf("%s: %.*s\n", what, nchar, value);
4483 if (is_tainted(value))
4486 debug_printf_indent("%s \\__", skipping ? "| " : " ");
4488 debug_printf_indent("%s",
4490 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
4491 debug_printf("(tainted)\n");
4496 /*************************************************
4498 *************************************************/
4500 /* Returns either an unchanged string, or the expanded string in stacking pool
4501 store. Interpreted sequences are:
4503 \... normal escaping rules
4504 $name substitutes the variable
4506 ${op:string} operates on the expanded string value
4507 ${item{arg1}{arg2}...} expands the args and then does the business
4508 some literal args are not enclosed in {}
4510 There are now far too many operators and item types to make it worth listing
4511 them here in detail any more.
4513 We use an internal routine recursively to handle embedded substrings. The
4514 external function follows. The yield is NULL if the expansion failed, and there
4515 are two cases: if something collapsed syntactically, or if "fail" was given
4516 as the action on a lookup failure. These can be distinguished by looking at the
4517 variable expand_string_forcedfail, which is TRUE in the latter case.
4519 The skipping flag is set true when expanding a substring that isn't actually
4520 going to be used (after "if" or "lookup") and it prevents lookups from
4521 happening lower down.
4523 Store usage: At start, a store block of the length of the input plus 64
4524 is obtained. This is expanded as necessary by string_cat(), which might have to
4525 get a new block, or might be able to expand the original. At the end of the
4526 function we can release any store above that portion of the yield block that
4527 was actually used. In many cases this will be optimal.
4529 However: if the first item in the expansion is a variable name or header name,
4530 we reset the store before processing it; if the result is in fresh store, we
4531 use that without copying. This is helpful for expanding strings like
4532 $message_headers which can get very long.
4534 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4535 since resetting the store at the end of the expansion will free store that was
4536 allocated by the plugin code as well as the slop after the expanded string. So
4537 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4538 and, given the acl condition, ${if }. This is an unfortunate consequence of
4539 string expansion becoming too powerful.
4542 string the string to be expanded
4544 brace_ends expansion is to stop at }
4545 honour_dollar TRUE if $ is to be expanded,
4546 FALSE if it's just another character
4547 skipping TRUE for recursive calls when the value isn't actually going
4548 to be used (to allow for optimisation)
4549 left if not NULL, a pointer to the first character after the
4550 expansion is placed here (typically used with brace_ends)
4551 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4553 textonly_p if not NULL, pointer to flag - write bool for only-met-text
4555 Returns: NULL if expansion fails:
4556 expand_string_forcedfail is set TRUE if failure was forced
4557 expand_string_message contains a textual error message
4558 a pointer to the expanded string on success
4562 expand_string_internal(const uschar * string, esi_flags flags, const uschar ** left,
4563 BOOL *resetok_p, BOOL * textonly_p)
4565 rmark reset_point = store_mark();
4566 gstring * yield = string_get(Ustrlen(string) + 64);
4568 const uschar * s = string;
4569 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4570 int save_expand_nlength[EXPAND_MAXN+1];
4571 BOOL resetok = TRUE, first = TRUE, textonly = TRUE;
4574 f.expand_string_forcedfail = FALSE;
4575 expand_string_message = US"";
4577 if (is_tainted(string))
4579 expand_string_message =
4580 string_sprintf("attempt to expand tainted string '%s'", s);
4581 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4592 debug_printf_indent("%c%s: %s\n",
4594 flags & ESI_SKIPPING ? "---scanning" : "considering", s);
4596 debug_printf_indent("%s%s: %s\n",
4597 first ? UTF8_DOWN_RIGHT : UTF8_VERT_RIGHT,
4598 flags & ESI_SKIPPING
4599 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4605 /* \ escapes the next character, which must exist, or else
4606 the expansion fails. There's a special escape, \N, which causes
4607 copying of the subject verbatim up to the next \N. Otherwise,
4608 the escapes are the standard set. */
4614 expand_string_message = US"\\ at end of string";
4620 const uschar * t = s + 2;
4621 for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4624 debug_expansion_interim(US"protected", t, (int)(s - t), !!(flags & ESI_SKIPPING));
4625 yield = string_catn(yield, t, s - t);
4633 debug_printf_indent("|backslashed: '\\%c'\n", s[1]);
4635 debug_printf_indent(UTF8_VERT_RIGHT "backslashed: '\\%c'\n", s[1]);
4636 ch[0] = string_interpret_escape(&s);
4638 yield = string_catn(yield, ch, 1);
4644 /* Anything other than $ is just copied verbatim, unless we are
4645 looking for a terminating } character. */
4647 if (flags & ESI_BRACE_ENDS && *s == '}') break;
4649 if (*s != '$' || !(flags & ESI_HONOR_DOLLAR))
4652 for (const uschar * t = s+1;
4653 *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4655 DEBUG(D_expand) debug_expansion_interim(US"text", s, i, !!(flags & ESI_SKIPPING));
4657 yield = string_catn(yield, s, i);
4663 /* No { after the $ - must be a plain name or a number for string
4664 match variable. There has to be a fudge for variables that are the
4665 names of header fields preceded by "$header_" because header field
4666 names can contain any printing characters except space and colon.
4667 For those that don't like typing this much, "$h_" is a synonym for
4668 "$header_". A non-existent header yields a NULL value; nothing is
4673 const uschar * value;
4674 int newsize = 0, len;
4678 s = read_name(name, sizeof(name), s, US"_");
4680 /* If this is the first thing to be expanded, release the pre-allocated
4684 g = store_get(sizeof(gstring), GET_UNTAINTED);
4685 else if (yield->ptr == 0)
4687 if (resetok) reset_point = store_reset(reset_point);
4689 reset_point = store_mark();
4690 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
4695 if ( ( *(t = name) == 'h'
4696 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4698 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4701 unsigned flags = *name == 'r' ? FH_WANT_RAW
4702 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4704 const uschar * charset = *name == 'b' ? NULL : headers_charset;
4706 s = read_header_name(name, sizeof(name), s);
4707 value = find_header(name, &newsize, flags, charset);
4709 /* If we didn't find the header, and the header contains a closing brace
4710 character, this may be a user error where the terminating colon
4711 has been omitted. Set a flag to adjust the error message in this case.
4712 But there is no error here - nothing gets inserted. */
4716 if (Ustrchr(name, '}')) malformed_header = TRUE;
4723 else if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
4725 expand_string_message =
4726 string_sprintf("unknown variable name \"%s\"", name);
4727 check_variable_error_message(name);
4731 /* If the data is known to be in a new buffer, newsize will be set to the
4732 size of that buffer. If this is the first thing in an expansion string,
4733 yield will be NULL; just point it at the new store instead of copying. Many
4734 expansion strings contain just one reference, so this is a useful
4735 optimization, especially for humungous headers. We need to use a gstring
4736 structure that is not allocated after that new-buffer, else a later store
4737 reset in the middle of the buffer will make it inaccessible. */
4739 len = Ustrlen(value);
4740 DEBUG(D_expand) debug_expansion_interim(US"value", value, len, !!(flags & ESI_SKIPPING));
4741 if (!yield && newsize != 0)
4744 yield->size = newsize;
4746 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4749 yield = string_catn(yield, value, len);
4754 if (isdigit(*s)) /* A $<n> variable */
4757 s = read_cnumber(&n, s);
4758 if (n >= 0 && n <= expand_nmax)
4760 DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], !!(flags & ESI_SKIPPING));
4761 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4766 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4768 if (*s != '{') /*}*/
4770 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4774 /* After { there can be various things, but they all start with
4775 an initial word, except for a number for a string match variable. */ /*}*/
4780 s = read_cnumber(&n, s); /*{{*/
4783 expand_string_message = US"} expected after number";
4786 if (n >= 0 && n <= expand_nmax)
4788 DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], !!(flags & ESI_SKIPPING));
4789 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4796 expand_string_message = US"letter or digit expected after ${"; /*}*/
4800 /* Allow "-" in names to cater for substrings with negative
4801 arguments. Since we are checking for known names after { this is
4804 s = read_name(name, sizeof(name), s, US"_-");
4805 item_type = chop_match(name, item_table, nelem(item_table));
4807 /* Switch on item type. All nondefault choices should "continue* when
4808 skipping, but "break" otherwise so we get debug output for the item
4811 int expansion_start = gstring_length(yield);
4814 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4815 If the ACL returns accept or reject we return content set by "message ="
4816 There is currently no limit on recursion; this would have us call
4817 acl_check_internal() directly and get a current level from somewhere.
4818 See also the acl expansion condition ECOND_ACL and the traditional
4819 acl modifier ACLC_ACL.
4820 Assume that the function has side-effects on the store that must be preserved.
4824 /* ${acl {name} {arg1}{arg2}...} */
4826 uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4830 switch(read_subs(sub, nelem(sub), 1, &s, flags, TRUE, name, &resetok, NULL))
4832 case -1: continue; /* skipping */
4833 case 1: goto EXPAND_FAILED_CURLY;
4835 case 3: goto EXPAND_FAILED;
4839 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4844 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4846 yield = string_cat(yield, user_msg);
4850 f.expand_string_forcedfail = TRUE;
4853 expand_string_message = string_sprintf("%s from acl \"%s\"",
4854 rc_names[rc], sub[0]);
4860 case EITEM_AUTHRESULTS:
4861 /* ${authresults {mysystemname}} */
4863 uschar * sub_arg[1];
4865 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4867 case -1: continue; /* If skipping, we don't actually do anything */
4868 case 1: goto EXPAND_FAILED_CURLY;
4870 case 3: goto EXPAND_FAILED;
4873 yield = string_append(yield, 3,
4874 US"Authentication-Results: ", sub_arg[0], US"; none");
4875 yield->ptr -= 6; /* ignore tha ": none" for now */
4877 yield = authres_local(yield, sub_arg[0]);
4878 yield = authres_iprev(yield);
4879 yield = authres_smtpauth(yield);
4881 yield = authres_spf(yield);
4883 #ifndef DISABLE_DKIM
4884 yield = authres_dkim(yield);
4886 #ifdef SUPPORT_DMARC
4887 yield = authres_dmarc(yield);
4889 #ifdef EXPERIMENTAL_ARC
4890 yield = authres_arc(yield);
4895 /* Handle conditionals - preserve the values of the numerical expansion
4896 variables in case they get changed by a regular expression match in the
4897 condition. If not, they retain their external settings. At the end
4898 of this "if" section, they get restored to their previous values. */
4903 const uschar *next_s;
4904 int save_expand_nmax =
4905 save_expand_strings(save_expand_nstring, save_expand_nlength);
4906 uschar * save_lookup_value = lookup_value;
4908 Uskip_whitespace(&s);
4909 if (!(next_s = eval_condition(s, &resetok, flags & ESI_SKIPPING ? NULL : &cond)))
4910 goto EXPAND_FAILED; /* message already set */
4914 debug_expansion_interim(US"condition", s, (int)(next_s - s), !!(flags & ESI_SKIPPING));
4915 debug_expansion_interim(US"result",
4916 cond ? US"true" : US"false", cond ? 4 : 5, !!(flags & ESI_SKIPPING));
4921 /* The handling of "yes" and "no" result strings is now in a separate
4922 function that is also used by ${lookup} and ${extract} and ${run}. */
4924 switch(process_yesno(
4925 flags, /* were previously skipping */
4926 cond, /* success/failure indicator */
4927 lookup_value, /* value to reset for string2 */
4928 &s, /* input pointer */
4929 &yield, /* output pointer */
4930 US"if", /* condition type */
4933 case 1: goto EXPAND_FAILED; /* when all is well, the */
4934 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4937 /* Restore external setting of expansion variables for continuation
4940 lookup_value = save_lookup_value;
4941 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4942 save_expand_nlength);
4947 case EITEM_IMAPFOLDER:
4948 { /* ${imapfolder {name}{sep}{specials}} */
4952 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4954 case 1: goto EXPAND_FAILED_CURLY;
4956 case 3: goto EXPAND_FAILED;
4959 if (!sub_arg[1]) /* One argument */
4961 sub_arg[1] = US"/"; /* default separator */
4964 else if (Ustrlen(sub_arg[1]) != 1)
4966 expand_string_message =
4968 "IMAP folder separator must be one character, found \"%s\"",
4973 if (flags & ESI_SKIPPING) continue;
4975 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4976 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4978 yield = string_cat(yield, encoded);
4983 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4984 expanding an internal string that isn't actually going to be used. All we
4985 need to do is check the syntax, so don't do a lookup at all. Preserve the
4986 values of the numerical expansion variables in case they get changed by a
4987 partial lookup. If not, they retain their external settings. At the end
4988 of this "lookup" section, they get restored to their previous values. */
4992 int stype, partial, affixlen, starflags;
4993 int expand_setup = 0;
4995 uschar * key, * filename;
4996 const uschar * affix, * opts;
4997 uschar * save_lookup_value = lookup_value;
4998 int save_expand_nmax =
4999 save_expand_strings(save_expand_nstring, save_expand_nlength);
5001 if (expand_forbid & RDO_LOOKUP)
5003 expand_string_message = US"lookup expansions are not permitted";
5007 /* Get the key we are to look up for single-key+file style lookups.
5008 Otherwise set the key NULL pro-tem. */
5010 if (Uskip_whitespace(&s) == '{') /*}*/
5012 key = expand_string_internal(s+1,
5013 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
5014 if (!key) goto EXPAND_FAILED; /*{{*/
5017 expand_string_message = US"missing '}' after lookup key";
5018 goto EXPAND_FAILED_CURLY;
5020 Uskip_whitespace(&s);
5024 /* Find out the type of database */
5028 expand_string_message = US"missing lookup type";
5032 /* The type is a string that may contain special characters of various
5033 kinds. Allow everything except space or { to appear; the actual content
5034 is checked by search_findtype_partial. */ /*}*/
5036 while (*s && *s != '{' && !isspace(*s)) /*}*/
5038 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
5041 name[nameptr] = '\0';
5042 Uskip_whitespace(&s);
5044 /* Now check for the individual search type and any partial or default
5045 options. Only those types that are actually in the binary are valid. */
5047 if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
5048 &starflags, &opts)) < 0)
5050 expand_string_message = search_error_message;
5054 /* Check that a key was provided for those lookup types that need it,
5055 and was not supplied for those that use the query style. */
5057 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
5061 expand_string_message = string_sprintf("missing {key} for single-"
5062 "key \"%s\" lookup", name);
5068 expand_string_message = string_sprintf("a single key was given for "
5069 "lookup type \"%s\", which is not a single-key lookup type", name);
5073 /* Get the next string in brackets and expand it. It is the file name for
5074 single-key+file lookups, and the whole query otherwise. In the case of
5075 queries that also require a file name (e.g. sqlite), the file name comes
5080 expand_string_message = US"missing '{' for lookup file-or-query arg";
5081 goto EXPAND_FAILED_CURLY; /*}}*/
5083 if (!(filename = expand_string_internal(s+1,
5084 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5089 expand_string_message = US"missing '}' closing lookup file-or-query arg";
5090 goto EXPAND_FAILED_CURLY;
5092 Uskip_whitespace(&s);
5094 /* If this isn't a single-key+file lookup, re-arrange the variables
5095 to be appropriate for the search_ functions. For query-style lookups,
5096 there is just a "key", and no file name. For the special query-style +
5097 file types, the query (i.e. "key") starts with a file name. */
5100 key = search_args(stype, name, filename, &filename, opts);
5102 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5103 the entry was not found. Note that there is no search_close() function.
5104 Files are left open in case of re-use. At suitable places in higher logic,
5105 search_tidyup() is called to tidy all open files. This can save opening
5106 the same file several times. However, files may also get closed when
5107 others are opened, if too many are open at once. The rule is that a
5108 handle should not be used after a second search_open().
5110 Request that a partial search sets up $1 and maybe $2 by passing
5111 expand_setup containing zero. If its value changes, reset expand_nmax,
5112 since new variables will have been set. Note that at the end of this
5113 "lookup" section, the old numeric variables are restored. */
5115 if (flags & ESI_SKIPPING)
5116 lookup_value = NULL;
5119 void * handle = search_open(filename, stype, 0, NULL, NULL);
5122 expand_string_message = search_error_message;
5125 lookup_value = search_find(handle, filename, key, partial, affix,
5126 affixlen, starflags, &expand_setup, opts);
5127 if (f.search_find_defer)
5129 expand_string_message =
5130 string_sprintf("lookup of \"%s\" gave DEFER: %s",
5131 string_printing2(key, SP_TAB), search_error_message);
5134 if (expand_setup > 0) expand_nmax = expand_setup;
5137 /* The handling of "yes" and "no" result strings is now in a separate
5138 function that is also used by ${if} and ${extract}. */
5140 switch(process_yesno(
5141 flags, /* were previously skipping */
5142 lookup_value != NULL, /* success/failure indicator */
5143 save_lookup_value, /* value to reset for string2 */
5144 &s, /* input pointer */
5145 &yield, /* output pointer */
5146 US"lookup", /* condition type */
5149 case 1: goto EXPAND_FAILED; /* when all is well, the */
5150 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5153 /* Restore external setting of expansion variables for carrying on
5154 at this level, and continue. */
5156 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5157 save_expand_nlength);
5159 if (flags & ESI_SKIPPING) continue;
5163 /* If Perl support is configured, handle calling embedded perl subroutines,
5164 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5165 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5166 arguments (defined below). */
5168 #define EXIM_PERL_MAX_ARGS 8
5172 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
5173 "is not included in this binary";
5176 #else /* EXIM_PERL */
5178 uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5179 gstring * new_yield;
5181 if (expand_forbid & RDO_PERL)
5183 expand_string_message = US"Perl calls are not permitted";
5187 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, flags, TRUE,
5188 name, &resetok, NULL))
5190 case -1: continue; /* If skipping, we don't actually do anything */
5191 case 1: goto EXPAND_FAILED_CURLY;
5193 case 3: goto EXPAND_FAILED;
5196 /* Start the interpreter if necessary */
5198 if (!opt_perl_started)
5201 if (!opt_perl_startup)
5203 expand_string_message = US"A setting of perl_startup is needed when "
5204 "using the Perl interpreter";
5207 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5208 if ((initerror = init_perl(opt_perl_startup)))
5210 expand_string_message =
5211 string_sprintf("error in perl_startup code: %s\n", initerror);
5214 opt_perl_started = TRUE;
5217 /* Call the function */
5219 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5220 new_yield = call_perl_cat(yield, &expand_string_message,
5221 sub_arg[0], sub_arg + 1);
5223 /* NULL yield indicates failure; if the message pointer has been set to
5224 NULL, the yield was undef, indicating a forced failure. Otherwise the
5225 message will indicate some kind of Perl error. */
5229 if (!expand_string_message)
5231 expand_string_message =
5232 string_sprintf("Perl subroutine \"%s\" returned undef to force "
5233 "failure", sub_arg[0]);
5234 f.expand_string_forcedfail = TRUE;
5239 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5240 set during a callback from Perl. */
5242 f.expand_string_forcedfail = FALSE;
5246 #endif /* EXIM_PERL */
5248 /* Transform email address to "prvs" scheme to use
5249 as BATV-signed return path */
5253 uschar * sub_arg[3], * p, * domain;
5255 switch(read_subs(sub_arg, 3, 2, &s, flags, TRUE, name, &resetok, NULL))
5257 case -1: continue; /* If skipping, we don't actually do anything */
5258 case 1: goto EXPAND_FAILED_CURLY;
5260 case 3: goto EXPAND_FAILED;
5263 /* sub_arg[0] is the address */
5264 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
5265 || domain == sub_arg[0] || Ustrlen(domain) == 1)
5267 expand_string_message = US"prvs first argument must be a qualified email address";
5271 /* Calculate the hash. The third argument must be a single-digit
5272 key number, or unset. */
5275 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5277 expand_string_message = US"prvs third argument must be a single digit";
5281 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5284 expand_string_message = US"prvs hmac-sha1 conversion failed";
5288 /* Now separate the domain from the local part */
5291 yield = string_catn(yield, US"prvs=", 5);
5292 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5293 yield = string_catn(yield, prvs_daystamp(7), 3);
5294 yield = string_catn(yield, p, 6);
5295 yield = string_catn(yield, US"=", 1);
5296 yield = string_cat (yield, sub_arg[0]);
5297 yield = string_catn(yield, US"@", 1);
5298 yield = string_cat (yield, domain);
5303 /* Check a prvs-encoded address for validity */
5305 case EITEM_PRVSCHECK:
5307 uschar * sub_arg[3], * p;
5309 const pcre2_code * re;
5311 /* Reset expansion variables */
5312 prvscheck_result = NULL;
5313 prvscheck_address = NULL;
5314 prvscheck_keynum = NULL;
5316 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5318 case 1: goto EXPAND_FAILED_CURLY;
5320 case 3: goto EXPAND_FAILED;
5323 re = regex_must_compile(
5324 US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5325 MCS_CASELESS | MCS_CACHEABLE, FALSE);
5327 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5329 uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5330 uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5331 uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5332 uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5333 uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5337 debug_printf_indent("prvscheck localpart: %s\n", local_part);
5338 debug_printf_indent("prvscheck key number: %s\n", key_num);
5339 debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5340 debug_printf_indent("prvscheck hash: %s\n", hash);
5341 debug_printf_indent("prvscheck domain: %s\n", domain);
5344 /* Set up expansion variables */
5345 g = string_cat (NULL, local_part);
5346 g = string_catn(g, US"@", 1);
5347 g = string_cat (g, domain);
5348 prvscheck_address = string_from_gstring(g);
5349 prvscheck_keynum = string_copy(key_num);
5351 /* Now expand the second argument */
5352 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5354 case 1: goto EXPAND_FAILED_CURLY;
5356 case 3: goto EXPAND_FAILED;
5359 /* Now we have the key and can check the address. */
5361 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5365 expand_string_message = US"hmac-sha1 conversion failed";
5369 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5370 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
5372 if (Ustrcmp(p,hash) == 0)
5374 /* Success, valid BATV address. Now check the expiry date. */
5375 uschar *now = prvs_daystamp(0);
5376 unsigned int inow = 0,iexpire = 1;
5378 (void)sscanf(CS now,"%u",&inow);
5379 (void)sscanf(CS daystamp,"%u",&iexpire);
5381 /* When "iexpire" is < 7, a "flip" has occurred.
5382 Adjust "inow" accordingly. */
5383 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5385 if (iexpire >= inow)
5387 prvscheck_result = US"1";
5388 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
5392 prvscheck_result = NULL;
5393 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
5398 prvscheck_result = NULL;
5399 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
5402 /* Now expand the final argument. We leave this till now so that
5403 it can include $prvscheck_result. */
5405 switch(read_subs(sub_arg, 1, 0, &s, flags, TRUE, name, &resetok, NULL))
5407 case 1: goto EXPAND_FAILED_CURLY;
5409 case 3: goto EXPAND_FAILED;
5412 yield = string_cat(yield,
5413 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5415 /* Reset the "internal" variables afterwards, because they are in
5416 dynamic store that will be reclaimed if the expansion succeeded. */
5418 prvscheck_address = NULL;
5419 prvscheck_keynum = NULL;
5422 /* Does not look like a prvs encoded address, return the empty string.
5423 We need to make sure all subs are expanded first, so as to skip over
5426 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5428 case 1: goto EXPAND_FAILED_CURLY;
5430 case 3: goto EXPAND_FAILED;
5433 if (flags & ESI_SKIPPING) continue;
5437 /* Handle "readfile" to insert an entire file */
5439 case EITEM_READFILE:
5442 uschar * sub_arg[2];
5444 if ((expand_forbid & RDO_READFILE) != 0)
5446 expand_string_message = US"file insertions are not permitted";
5450 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5452 case -1: continue; /* If skipping, we don't actually do anything */
5453 case 1: goto EXPAND_FAILED_CURLY;
5455 case 3: goto EXPAND_FAILED;
5458 /* Open the file and read it */
5460 if (!(f = Ufopen(sub_arg[0], "rb")))
5462 expand_string_message = string_open_failed("%s", sub_arg[0]);
5466 yield = cat_file(f, yield, sub_arg[1]);
5471 /* Handle "readsocket" to insert data from a socket, either
5472 Inet or Unix domain */
5474 case EITEM_READSOCK:
5477 uschar * sub_arg[4];
5479 if (expand_forbid & RDO_READSOCK)
5481 expand_string_message = US"socket insertions are not permitted";
5485 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5486 because there may be a string for expansion on failure. */
5488 switch(read_subs(sub_arg, 4, 2, &s, flags, FALSE, name, &resetok, NULL))
5490 case 1: goto EXPAND_FAILED_CURLY;
5491 case 2: /* Won't occur: no end check */
5492 case 3: goto EXPAND_FAILED;
5495 /* If skipping, we don't actually do anything. Otherwise, arrange to
5496 connect to either an IP or a Unix socket. */
5498 if (!(flags & ESI_SKIPPING))
5500 int stype = search_findtype(US"readsock", 8);
5503 int expand_setup = -1;
5506 /* If the reqstr is empty, flag that and set a dummy */
5510 g = string_append_listele(g, ',', US"send=no");
5511 sub_arg[1] = US"DUMMY";
5514 /* Re-marshall the options */
5518 const uschar * list = sub_arg[2];
5522 /* First option has no tag and is timeout */
5523 if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5524 g = string_append_listele(g, ',',
5525 string_sprintf("timeout=%s", item));
5527 /* The rest of the options from the expansion */
5528 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5529 g = string_append_listele(g, ',', item);
5531 /* possibly plus an EOL string. Process with escapes, to protect
5532 from list-processing. The only current user of eol= in search
5533 options is the readsock expansion. */
5535 if (sub_arg[3] && *sub_arg[3])
5536 g = string_append_listele(g, ',',
5537 string_sprintf("eol=%s",
5538 string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5541 /* Gat a (possibly cached) handle for the connection */
5543 if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5545 if (*expand_string_message) goto EXPAND_FAILED;
5546 expand_string_message = search_error_message;
5547 search_error_message = NULL;
5551 /* Get (possibly cached) results for the lookup */
5552 /* sspec: sub_arg[0] req: sub_arg[1] opts: g */
5554 if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5555 &expand_setup, string_from_gstring(g))))
5556 yield = string_cat(yield, s);
5557 else if (f.search_find_defer)
5559 expand_string_message = search_error_message;
5560 search_error_message = NULL;
5564 { /* should not happen, at present */
5565 expand_string_message = search_error_message;
5566 search_error_message = NULL;
5571 /* The whole thing has worked (or we were skipping). If there is a
5572 failure string following, we need to skip it. */
5574 if (*s == '{') /*}*/
5576 if (!expand_string_internal(s+1,
5577 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL))
5578 goto EXPAND_FAILED; /*{*/
5581 expand_string_message = US"missing '}' closing failstring for readsocket";
5582 goto EXPAND_FAILED_CURLY;
5584 Uskip_whitespace(&s);
5587 READSOCK_DONE: /*{*/
5590 expand_string_message = US"missing '}' closing readsocket";
5591 goto EXPAND_FAILED_CURLY;
5593 if (flags & ESI_SKIPPING) continue;
5596 /* Come here on failure to create socket, connect socket, write to the
5597 socket, or timeout on reading. If another substring follows, expand and
5598 use it. Otherwise, those conditions give expand errors. */
5601 if (*s != '{') goto EXPAND_FAILED; /*}*/
5602 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5603 if (!(arg = expand_string_internal(s+1,
5604 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR, &s, &resetok, NULL)))
5606 yield = string_cat(yield, arg); /*{*/
5609 expand_string_message = US"missing '}' closing failstring for readsocket";
5610 goto EXPAND_FAILED_CURLY;
5612 Uskip_whitespace(&s);
5616 /* Handle "run" to execute a program. */
5621 const uschar * arg, ** argv;
5622 BOOL late_expand = TRUE;
5624 if (expand_forbid & RDO_RUN)
5626 expand_string_message = US"running a command is not permitted";
5630 /* Handle options to the "run" */
5633 if (Ustrncmp(++s, "preexpand", 9) == 0)
5634 { late_expand = FALSE; s += 9; }
5637 const uschar * t = s;
5638 while (isalpha(*++t)) ;
5639 expand_string_message = string_sprintf("bad option '%.*s' for run",
5643 Uskip_whitespace(&s);
5645 if (*s != '{') /*}*/
5647 expand_string_message = US"missing '{' for command arg of run";
5648 goto EXPAND_FAILED_CURLY; /*"}*/
5652 if (late_expand) /* this is the default case */
5656 /* Locate the end of the args */
5657 (void) expand_string_internal(s,
5658 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &t, NULL, NULL);
5660 arg = flags & ESI_SKIPPING ? NULL : string_copyn(s, n);
5666 debug_printf_indent("args string for ${run} expand before split\n");
5667 if (!(arg = expand_string_internal(s,
5668 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5670 Uskip_whitespace(&s);
5675 expand_string_message = US"missing '}' closing command arg of run";
5676 goto EXPAND_FAILED_CURLY;
5679 if (flags & ESI_SKIPPING) /* Just pretend it worked when we're skipping */
5682 lookup_value = NULL;
5689 if (!transport_set_up_command(&argv, /* anchor for arg list */
5690 arg, /* raw command */
5691 late_expand, /* expand args if not already done */
5692 0, /* not relevant when... */
5693 NULL, /* no transporting address */
5694 late_expand, /* allow tainted args, when expand-after-split */
5695 US"${run} expansion", /* for error messages */
5696 &expand_string_message)) /* where to put error message */
5699 /* Create the child process, making it a group leader. */
5701 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5702 US"expand-run")) < 0)
5704 expand_string_message =
5705 string_sprintf("couldn't create child process: %s", strerror(errno));
5709 /* Nothing is written to the standard input. */
5713 /* Read the pipe to get the command's output into $value (which is kept
5714 in lookup_value). Read during execution, so that if the output exceeds
5715 the OS pipe buffer limit, we don't block forever. Remember to not release
5716 memory just allocated for $value. */
5719 f = fdopen(fd_out, "rb");
5720 sigalrm_seen = FALSE;
5722 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5726 /* Wait for the process to finish, applying the timeout, and inspect its
5727 return code for serious disasters. Simple non-zero returns are passed on.
5730 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5732 if (sigalrm_seen || runrc == -256)
5734 expand_string_message = US"command timed out";
5735 killpg(pid, SIGKILL); /* Kill the whole process group */
5738 else if (runrc == -257)
5739 expand_string_message = string_sprintf("wait() failed: %s",
5743 expand_string_message = string_sprintf("command killed by signal %d",
5750 /* Process the yes/no strings; $value may be useful in both cases */
5752 switch(process_yesno(
5753 flags, /* were previously skipping */
5754 runrc == 0, /* success/failure indicator */
5755 lookup_value, /* value to reset for string2 */
5756 &s, /* input pointer */
5757 &yield, /* output pointer */
5758 US"run", /* condition type */
5761 case 1: goto EXPAND_FAILED; /* when all is well, the */
5762 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5765 if (flags & ESI_SKIPPING) continue;
5769 /* Handle character translation for "tr" */
5773 int oldptr = gstring_length(yield);
5777 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5779 case -1: continue; /* skipping */
5780 case 1: goto EXPAND_FAILED_CURLY;
5782 case 3: goto EXPAND_FAILED;
5785 yield = string_cat(yield, sub[0]);
5786 o2m = Ustrlen(sub[2]) - 1;
5788 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5790 uschar * m = Ustrrchr(sub[1], yield->s[oldptr]);
5794 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5801 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5802 expanded arguments. */
5811 int val[2] = { 0, -1 };
5814 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5815 Ensure that sub[2] is set in the ${length } case. */
5818 switch(read_subs(sub, item_type == EITEM_LENGTH ? 2:3, 2, &s, flags,
5819 TRUE, name, &resetok, NULL))
5821 case -1: continue; /* skipping */
5822 case 1: goto EXPAND_FAILED_CURLY;
5824 case 3: goto EXPAND_FAILED;
5827 /* Juggle the arguments if there are only two of them: always move the
5828 string to the last position and make ${length{n}{str}} equivalent to
5829 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5835 if (item_type == EITEM_LENGTH)
5842 for (int i = 0; i < 2; i++) if (sub[i])
5844 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5845 if (*ret != 0 || (i != 0 && val[i] < 0))
5847 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5848 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5854 item_type == EITEM_HASH
5855 ? compute_hash(sub[2], val[0], val[1], &len)
5856 : item_type == EITEM_NHASH
5857 ? compute_nhash(sub[2], val[0], val[1], &len)
5858 : extract_substr(sub[2], val[0], val[1], &len);
5861 yield = string_catn(yield, ret, len);
5865 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5866 This code originally contributed by Steve Haslam. It currently supports
5867 the use of MD5 and SHA-1 hashes.
5869 We need some workspace that is large enough to handle all the supported
5870 hash types. Use macros to set the sizes rather than be too elaborate. */
5872 #define MAX_HASHLEN 20
5873 #define MAX_HASHBLOCKLEN 64
5882 int hashlen; /* Number of octets for the hash algorithm's output */
5883 int hashblocklen; /* Number of octets the hash algorithm processes */
5884 uschar * keyptr, * p;
5885 unsigned int keylen;
5887 uschar keyhash[MAX_HASHLEN];
5888 uschar innerhash[MAX_HASHLEN];
5889 uschar finalhash[MAX_HASHLEN];
5890 uschar finalhash_hex[2*MAX_HASHLEN];
5891 uschar innerkey[MAX_HASHBLOCKLEN];
5892 uschar outerkey[MAX_HASHBLOCKLEN];
5894 switch (read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5896 case -1: continue; /* skipping */
5897 case 1: goto EXPAND_FAILED_CURLY;
5899 case 3: goto EXPAND_FAILED;
5902 if (Ustrcmp(sub[0], "md5") == 0)
5905 use_base = &md5_base;
5909 else if (Ustrcmp(sub[0], "sha1") == 0)
5912 use_base = &sha1_ctx;
5918 expand_string_message =
5919 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5924 keylen = Ustrlen(keyptr);
5926 /* If the key is longer than the hash block length, then hash the key
5929 if (keylen > hashblocklen)
5931 chash_start(type, use_base);
5932 chash_end(type, use_base, keyptr, keylen, keyhash);
5937 /* Now make the inner and outer key values */
5939 memset(innerkey, 0x36, hashblocklen);
5940 memset(outerkey, 0x5c, hashblocklen);
5942 for (int i = 0; i < keylen; i++)
5944 innerkey[i] ^= keyptr[i];
5945 outerkey[i] ^= keyptr[i];
5948 /* Now do the hashes */
5950 chash_start(type, use_base);
5951 chash_mid(type, use_base, innerkey);
5952 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5954 chash_start(type, use_base);
5955 chash_mid(type, use_base, outerkey);
5956 chash_end(type, use_base, innerhash, hashlen, finalhash);
5958 /* Encode the final hash as a hex string */
5961 for (int i = 0; i < hashlen; i++)
5963 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5964 *p++ = hex_digits[finalhash[i] & 0x0f];
5967 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5968 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5970 yield = string_catn(yield, finalhash_hex, hashlen*2);
5974 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5975 We have to save the numerical variables and restore them afterwards. */
5979 const pcre2_code * re;
5980 int moffset, moffsetextra, slen;
5981 pcre2_match_data * md;
5983 uschar * subject, * sub[3];
5984 int save_expand_nmax =
5985 save_expand_strings(save_expand_nstring, save_expand_nlength);
5986 unsigned sub_textonly = 0;
5988 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, &sub_textonly))
5990 case -1: continue; /* skipping */
5991 case 1: goto EXPAND_FAILED_CURLY;
5993 case 3: goto EXPAND_FAILED;
5996 /* Compile the regular expression */
5998 re = regex_compile(sub[1],
5999 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
6000 &expand_string_message, pcre_gen_cmp_ctx);
6004 md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
6006 /* Now run a loop to do the substitutions as often as necessary. It ends
6007 when there are no more matches. Take care over matches of the null string;
6008 do the same thing as Perl does. */
6011 slen = Ustrlen(sub[0]);
6012 moffset = moffsetextra = 0;
6017 PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
6018 int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
6019 PCRE_EOPT | emptyopt, md, pcre_gen_mtc_ctx);
6022 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
6023 is not necessarily the end. We want to repeat the match from one
6024 character further along, but leaving the basic offset the same (for
6025 copying below). We can't be at the end of the string - that was checked
6026 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
6027 finished; copy the remaining string and end the loop. */
6037 yield = string_catn(yield, subject+moffset, slen-moffset);
6041 /* Match - set up for expanding the replacement. */
6042 DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
6044 if (n == 0) n = EXPAND_MAXN + 1;
6046 for (int nn = 0; nn < n*2; nn += 2)
6048 expand_nstring[expand_nmax] = subject + ovec[nn];
6049 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
6053 /* Copy the characters before the match, plus the expanded insertion. */
6055 yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
6057 if (!(insert = expand_string(sub[2])))
6059 yield = string_cat(yield, insert);
6065 /* If we have matched an empty string, first check to see if we are at
6066 the end of the subject. If so, the loop is over. Otherwise, mimic
6067 what Perl's /g options does. This turns out to be rather cunning. First
6068 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
6069 string at the same point. If this fails (picked up above) we advance to
6070 the next character. */
6072 if (ovec[0] == ovec[1])
6074 if (ovec[0] == slen) break;
6075 emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
6079 /* All done - restore numerical variables. */
6081 /* pcre2_match_data_free(md); gen ctx needs no free */
6082 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6083 save_expand_nlength);
6087 /* Handle keyed and numbered substring extraction. If the first argument
6088 consists entirely of digits, then a numerical extraction is assumed. */
6092 int field_number = 1;
6093 BOOL field_number_set = FALSE;
6094 uschar * save_lookup_value = lookup_value, * sub[3];
6095 int save_expand_nmax =
6096 save_expand_strings(save_expand_nstring, save_expand_nlength);
6098 /* On reflection the original behaviour of extract-json for a string
6099 result, leaving it quoted, was a mistake. But it was already published,
6100 hence the addition of jsons. In a future major version, make json
6101 work like josons, and withdraw jsons. */
6103 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
6105 /* Check for a format-variant specifier */
6107 if (Uskip_whitespace(&s) != '{') /*}*/
6108 if (Ustrncmp(s, "json", 4) == 0)
6109 if (*(s += 4) == 's')
6110 {fmt = extract_jsons; s++;}
6114 /* While skipping we cannot rely on the data for expansions being
6115 available (eg. $item) hence cannot decide on numeric vs. keyed.
6116 Read a maximum of 5 arguments (including the yes/no) */
6118 if (flags & ESI_SKIPPING)
6120 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
6122 if (!expand_string_internal(s+1,
6123 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL))
6124 goto EXPAND_FAILED; /*'{'*/
6127 expand_string_message = US"missing '{' for arg of extract";
6128 goto EXPAND_FAILED_CURLY;
6130 Uskip_whitespace(&s);
6132 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
6133 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
6137 Uskip_whitespace(&s);
6141 expand_string_message = US"missing '}' closing extract";
6142 goto EXPAND_FAILED_CURLY;
6146 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
6148 if (Uskip_whitespace(&s) == '{') /*'}'*/
6150 if (!(sub[i] = expand_string_internal(s+1,
6151 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6152 goto EXPAND_FAILED; /*'{'*/
6155 expand_string_message = string_sprintf(
6156 "missing '}' closing arg %d of extract", i+1);
6157 goto EXPAND_FAILED_CURLY;
6160 /* After removal of leading and trailing white space, the first
6161 argument must not be empty; if it consists entirely of digits
6162 (optionally preceded by a minus sign), this is a numerical
6163 extraction, and we expect 3 arguments (normal) or 2 (json). */
6169 uschar * p = sub[0];
6171 Uskip_whitespace(&p);
6175 while (len > 0 && isspace(p[len-1])) len--;
6180 expand_string_message = US"first argument of \"extract\" must "
6190 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6194 if (fmt == extract_basic) j = 3; /* Need 3 args */
6195 field_number_set = TRUE;
6201 expand_string_message = string_sprintf(
6202 "missing '{' for arg %d of extract", i+1);
6203 goto EXPAND_FAILED_CURLY;
6207 /* Extract either the numbered or the keyed substring into $value. If
6208 skipping, just pretend the extraction failed. */
6210 if (flags & ESI_SKIPPING)
6211 lookup_value = NULL;
6215 lookup_value = field_number_set
6216 ? expand_gettokened(field_number, sub[1], sub[2])
6217 : expand_getkeyed(sub[0], sub[1]);
6224 const uschar * list;
6226 /* Array: Bracket-enclosed and comma-separated.
6227 Object: Brace-enclosed, comma-sep list of name:value pairs */
6229 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6231 expand_string_message =
6232 string_sprintf("%s wrapping %s for extract json",
6233 expand_string_message,
6234 field_number_set ? "array" : "object");
6235 goto EXPAND_FAILED_CURLY;
6239 if (field_number_set)
6241 if (field_number <= 0)
6243 expand_string_message = US"first argument of \"extract\" must "
6244 "be greater than zero";
6247 while (field_number > 0 && (item = json_nextinlist(&list)))
6249 if ((lookup_value = s = item))
6252 while (--s >= lookup_value && isspace(*s)) *s = '\0';
6257 lookup_value = NULL;
6258 while ((item = json_nextinlist(&list)))
6260 /* Item is: string name-sep value. string is quoted.
6261 Dequote the string and compare with the search key. */
6263 if (!(item = dewrap(item, US"\"\"")))
6265 expand_string_message =
6266 string_sprintf("%s wrapping string key for extract json",
6267 expand_string_message);
6268 goto EXPAND_FAILED_CURLY;
6270 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
6272 s = item + Ustrlen(item) + 1;
6273 if (Uskip_whitespace(&s) != ':')
6275 expand_string_message =
6276 US"missing object value-separator for extract json";
6277 goto EXPAND_FAILED_CURLY;
6280 Uskip_whitespace(&s);
6288 if ( fmt == extract_jsons
6290 && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6292 expand_string_message =
6293 string_sprintf("%s wrapping string result for extract jsons",
6294 expand_string_message);
6295 goto EXPAND_FAILED_CURLY;
6300 /* If no string follows, $value gets substituted; otherwise there can
6301 be yes/no strings, as for lookup or if. */
6303 switch(process_yesno(
6304 flags, /* were previously skipping */
6305 lookup_value != NULL, /* success/failure indicator */
6306 save_lookup_value, /* value to reset for string2 */
6307 &s, /* input pointer */
6308 &yield, /* output pointer */
6309 US"extract", /* condition type */
6312 case 1: goto EXPAND_FAILED; /* when all is well, the */
6313 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6316 /* All done - restore numerical variables. */
6318 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6319 save_expand_nlength);
6321 if (flags & ESI_SKIPPING) continue;
6325 /* return the Nth item from a list */
6327 case EITEM_LISTEXTRACT:
6329 int field_number = 1;
6330 uschar * save_lookup_value = lookup_value, * sub[2];
6331 int save_expand_nmax =
6332 save_expand_strings(save_expand_nstring, save_expand_nlength);
6334 /* Read the field & list arguments */
6335 /*XXX Could we use read_subs here (and get better efficiency for skipping)? */
6337 for (int i = 0; i < 2; i++)
6339 if (Uskip_whitespace(&s) != '{') /*}*/
6341 expand_string_message = string_sprintf(
6342 "missing '{' for arg %d of listextract", i+1); /*}*/
6343 goto EXPAND_FAILED_CURLY;
6346 sub[i] = expand_string_internal(s+1,
6347 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6348 if (!sub[i]) goto EXPAND_FAILED; /*{{*/
6351 expand_string_message = string_sprintf(
6352 "missing '}' closing arg %d of listextract", i+1);
6353 goto EXPAND_FAILED_CURLY;
6356 /* After removal of leading and trailing white space, the first
6357 argument must be numeric and nonempty. */
6365 Uskip_whitespace(&p);
6369 while (len > 0 && isspace(p[len-1])) len--;
6372 if (!*p && !(flags & ESI_SKIPPING))
6374 expand_string_message = US"first argument of \"listextract\" must "
6384 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6387 expand_string_message = US"first argument of \"listextract\" must "
6395 /* Extract the numbered element into $value. If
6396 skipping, just pretend the extraction failed. */
6398 lookup_value = flags & ESI_SKIPPING ? NULL : expand_getlistele(field_number, sub[1]);
6400 /* If no string follows, $value gets substituted; otherwise there can
6401 be yes/no strings, as for lookup or if. */
6403 switch(process_yesno(
6404 flags, /* were previously skipping */
6405 lookup_value != NULL, /* success/failure indicator */
6406 save_lookup_value, /* value to reset for string2 */
6407 &s, /* input pointer */
6408 &yield, /* output pointer */
6409 US"listextract", /* condition type */
6412 case 1: goto EXPAND_FAILED; /* when all is well, the */
6413 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6416 /* All done - restore numerical variables. */
6418 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6419 save_expand_nlength);
6421 if (flags & ESI_SKIPPING) continue;
6425 case EITEM_LISTQUOTE:
6428 switch(read_subs(sub, 2, 2, &s, flags, TRUE, name, &resetok, NULL))
6430 case -1: continue; /* skipping */
6431 case 1: goto EXPAND_FAILED_CURLY;
6433 case 3: goto EXPAND_FAILED;
6435 if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6437 if (c == sep) yield = string_catn(yield, sub[1], 1);
6438 yield = string_catn(yield, sub[1], 1);
6440 else yield = string_catn(yield, US" ", 1);
6445 case EITEM_CERTEXTRACT:
6447 uschar * save_lookup_value = lookup_value, * sub[2];
6448 int save_expand_nmax =
6449 save_expand_strings(save_expand_nstring, save_expand_nlength);
6451 /* Read the field argument */
6452 if (Uskip_whitespace(&s) != '{') /*}*/
6454 expand_string_message = US"missing '{' for field arg of certextract";
6455 goto EXPAND_FAILED_CURLY; /*}*/
6457 sub[0] = expand_string_internal(s+1,
6458 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6459 if (!sub[0]) goto EXPAND_FAILED; /*{{*/
6462 expand_string_message = US"missing '}' closing field arg of certextract";
6463 goto EXPAND_FAILED_CURLY;
6465 /* strip spaces fore & aft */
6470 Uskip_whitespace(&p);
6474 while (len > 0 && isspace(p[len-1])) len--;
6478 /* inspect the cert argument */
6479 if (Uskip_whitespace(&s) != '{') /*}*/
6481 expand_string_message = US"missing '{' for cert variable arg of certextract";
6482 goto EXPAND_FAILED_CURLY; /*}*/
6486 expand_string_message = US"second argument of \"certextract\" must "
6487 "be a certificate variable";
6490 sub[1] = expand_string_internal(s+1,
6491 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6492 if (!sub[1]) goto EXPAND_FAILED; /*{{*/
6495 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6496 goto EXPAND_FAILED_CURLY;
6499 if (flags & ESI_SKIPPING)
6500 lookup_value = NULL;
6503 lookup_value = expand_getcertele(sub[0], sub[1]);
6504 if (*expand_string_message) goto EXPAND_FAILED;
6506 switch(process_yesno(
6507 flags, /* were previously skipping */
6508 lookup_value != NULL, /* success/failure indicator */
6509 save_lookup_value, /* value to reset for string2 */
6510 &s, /* input pointer */
6511 &yield, /* output pointer */
6512 US"certextract", /* condition type */
6515 case 1: goto EXPAND_FAILED; /* when all is well, the */
6516 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6519 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6520 save_expand_nlength);
6521 if (flags & ESI_SKIPPING) continue;
6524 #endif /*DISABLE_TLS*/
6526 /* Handle list operations */
6532 int sep = 0, save_ptr = gstring_length(yield);
6533 uschar outsep[2] = { '\0', '\0' };
6534 const uschar *list, *expr, *temp;
6535 uschar * save_iterate_item = iterate_item;
6536 uschar * save_lookup_value = lookup_value;
6538 Uskip_whitespace(&s);
6539 if (*s++ != '{') /*}*/
6541 expand_string_message =
6542 string_sprintf("missing '{' for first arg of %s", name);
6543 goto EXPAND_FAILED_CURLY; /*}*/
6546 if (!(list = expand_string_internal(s,
6547 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6548 goto EXPAND_FAILED; /*{{*/
6551 expand_string_message =
6552 string_sprintf("missing '}' closing first arg of %s", name);
6553 goto EXPAND_FAILED_CURLY;
6556 if (item_type == EITEM_REDUCE)
6559 Uskip_whitespace(&s);
6560 if (*s++ != '{') /*}*/
6562 expand_string_message = US"missing '{' for second arg of reduce";
6563 goto EXPAND_FAILED_CURLY; /*}*/
6565 t = expand_string_internal(s,
6566 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6567 if (!t) goto EXPAND_FAILED;
6568 lookup_value = t; /*{{*/
6571 expand_string_message = US"missing '}' closing second arg of reduce";
6572 goto EXPAND_FAILED_CURLY;
6576 Uskip_whitespace(&s);
6577 if (*s++ != '{') /*}*/
6579 expand_string_message =
6580 string_sprintf("missing '{' for last arg of %s", name); /*}*/
6581 goto EXPAND_FAILED_CURLY;
6586 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6587 if scanning a "false" part). This allows us to find the end of the
6588 condition, because if the list is empty, we won't actually evaluate the
6589 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6590 the normal internal expansion function. */
6592 if (item_type != EITEM_FILTER)
6593 temp = expand_string_internal(s,
6594 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL);
6596 if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6600 expand_string_message = string_sprintf("%s inside \"%s\" item",
6601 expand_string_message, name);
6605 Uskip_whitespace(&s); /*{{{*/
6608 expand_string_message = string_sprintf("missing } at end of condition "
6609 "or expression inside \"%s\"; could be an unquoted } in the content",
6614 Uskip_whitespace(&s); /*{{*/
6617 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6622 /* If we are skipping, we can now just move on to the next item. When
6623 processing for real, we perform the iteration. */
6625 if (flags & ESI_SKIPPING) continue;
6626 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6628 *outsep = (uschar)sep; /* Separator as a string */
6630 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6631 name, iterate_item, lookup_value);
6633 if (item_type == EITEM_FILTER)
6636 /* the condition could modify $value, as a side-effect */
6637 uschar * save_value = lookup_value;
6639 if (!eval_condition(expr, &resetok, &condresult))
6641 iterate_item = save_iterate_item;
6642 lookup_value = save_lookup_value;
6643 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6644 expand_string_message, name);
6647 lookup_value = save_value;
6648 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6649 condresult? "true":"false");
6651 temp = iterate_item; /* TRUE => include this item */
6653 continue; /* FALSE => skip this item */
6656 else /* EITEM_MAP and EITEM_REDUCE */
6658 /* the expansion could modify $value, as a side-effect */
6659 uschar * t = expand_string_internal(expr,
6660 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, NULL, &resetok, NULL);
6663 iterate_item = save_iterate_item;
6664 expand_string_message = string_sprintf("%s inside \"%s\" item",
6665 expand_string_message, name);
6668 if (item_type == EITEM_REDUCE)
6670 lookup_value = t; /* Update the value of $value */
6671 continue; /* and continue the iteration */
6675 /* We reach here for FILTER if the condition is true, always for MAP,
6676 and never for REDUCE. The value in "temp" is to be added to the output
6677 list that is being created, ensuring that any occurrences of the
6678 separator character are doubled. Unless we are dealing with the first
6679 item of the output list, add in a space if the new item begins with the
6680 separator character, or is an empty string. */
6682 /*XXX is there not a standard support function for this, appending to a list? */
6683 /* yes, string_append_listele(), but it depends on lack of text before the list */
6685 if ( yield && yield->ptr != save_ptr
6686 && (temp[0] == *outsep || temp[0] == 0))
6687 yield = string_catn(yield, US" ", 1);
6689 /* Add the string in "temp" to the output list that we are building,
6690 This is done in chunks by searching for the separator character. */
6694 size_t seglen = Ustrcspn(temp, outsep);
6696 yield = string_catn(yield, temp, seglen + 1);
6698 /* If we got to the end of the string we output one character
6699 too many; backup and end the loop. Otherwise arrange to double the
6702 if (!temp[seglen]) { yield->ptr--; break; }
6703 yield = string_catn(yield, outsep, 1);
6707 /* Output a separator after the string: we will remove the redundant
6708 final one at the end. */
6710 yield = string_catn(yield, outsep, 1);
6711 } /* End of iteration over the list loop */
6713 /* REDUCE has generated no output above: output the final value of
6716 if (item_type == EITEM_REDUCE)
6718 yield = string_cat(yield, lookup_value);
6719 lookup_value = save_lookup_value; /* Restore $value */
6722 /* FILTER and MAP generate lists: if they have generated anything, remove
6723 the redundant final separator. Even though an empty item at the end of a
6724 list does not count, this is tidier. */
6726 else if (yield && yield->ptr != save_ptr) yield->ptr--;
6728 /* Restore preserved $item */
6730 iterate_item = save_iterate_item;
6731 if (flags & ESI_SKIPPING) continue;
6737 int sep = 0, cond_type;
6738 const uschar * srclist, * cmp, * xtract;
6739 uschar * opname, * srcitem;
6740 const uschar * dstlist = NULL, * dstkeylist = NULL;
6741 uschar * tmp, * save_iterate_item = iterate_item;
6743 Uskip_whitespace(&s);
6744 if (*s++ != '{') /*}*/
6746 expand_string_message = US"missing '{' for list arg of sort";
6747 goto EXPAND_FAILED_CURLY; /*}*/
6750 srclist = expand_string_internal(s,
6751 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6752 if (!srclist) goto EXPAND_FAILED; /*{{*/
6755 expand_string_message = US"missing '}' closing list arg of sort";
6756 goto EXPAND_FAILED_CURLY;
6759 Uskip_whitespace(&s);
6760 if (*s++ != '{') /*}*/
6762 expand_string_message = US"missing '{' for comparator arg of sort";
6763 goto EXPAND_FAILED_CURLY; /*}*/
6766 cmp = expand_string_internal(s,
6767 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6768 if (!cmp) goto EXPAND_FAILED; /*{{*/
6771 expand_string_message = US"missing '}' closing comparator arg of sort";
6772 goto EXPAND_FAILED_CURLY;
6775 if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6777 if (!expand_string_message)
6778 expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6783 case ECOND_NUM_L: case ECOND_NUM_LE:
6784 case ECOND_NUM_G: case ECOND_NUM_GE:
6785 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6786 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6790 expand_string_message = US"comparator not handled for sort";
6794 Uskip_whitespace(&s);
6795 if (*s++ != '{') /*}*/
6797 expand_string_message = US"missing '{' for extractor arg of sort";
6798 goto EXPAND_FAILED_CURLY; /*}*/
6802 if (!(tmp = expand_string_internal(s,
6803 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL)))
6805 xtract = string_copyn(xtract, s - xtract);
6809 expand_string_message = US"missing '}' closing extractor arg of sort";
6810 goto EXPAND_FAILED_CURLY;
6815 expand_string_message = US"missing } at end of \"sort\"";
6819 if (flags & ESI_SKIPPING) continue;
6821 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6823 uschar * srcfield, * dstitem;
6824 gstring * newlist = NULL, * newkeylist = NULL;
6826 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6828 /* extract field for comparisons */
6829 iterate_item = srcitem;
6830 if ( !(srcfield = expand_string_internal(xtract,
6831 ESI_HONOR_DOLLAR, NULL, &resetok, NULL))
6834 expand_string_message = string_sprintf(
6835 "field-extract in sort: \"%s\"", xtract);
6839 /* Insertion sort */
6841 /* copy output list until new-item < list-item */
6842 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6846 /* field for comparison */
6847 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6850 /* String-comparator names start with a letter; numeric names do not */
6852 if (sortsbefore(cond_type, isalpha(opname[0]),
6853 srcfield, dstfield))
6855 /* New-item sorts before this dst-item. Append new-item,
6856 then dst-item, then remainder of dst list. */
6858 newlist = string_append_listele(newlist, sep, srcitem);
6859 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6862 newlist = string_append_listele(newlist, sep, dstitem);
6863 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6865 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */
6866 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6868 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6870 newlist = string_append_listele(newlist, sep, dstitem);
6871 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6877 newlist = string_append_listele(newlist, sep, dstitem);
6878 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6881 /* If we ran out of dstlist without consuming srcitem, append it */
6884 newlist = string_append_listele(newlist, sep, srcitem);
6885 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6888 dstlist = newlist->s;
6889 dstkeylist = newkeylist->s;
6891 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6892 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6896 yield = string_cat(yield, dstlist);
6898 /* Restore preserved $item */
6899 iterate_item = save_iterate_item;
6903 expand_string_message = US"Internal error in sort (list mismatch)";
6908 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6909 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6910 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6911 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6913 #define EXPAND_DLFUNC_MAX_ARGS 8
6916 #ifndef EXPAND_DLFUNC
6917 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6918 "is not included in this binary";
6921 #else /* EXPAND_DLFUNC */
6924 exim_dlfunc_t * func;
6927 uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6929 if (expand_forbid & RDO_DLFUNC)
6931 expand_string_message =
6932 US"dynamically-loaded functions are not permitted";
6936 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, flags,
6937 TRUE, name, &resetok, NULL))
6939 case -1: continue; /* skipping */
6940 case 1: goto EXPAND_FAILED_CURLY;
6942 case 3: goto EXPAND_FAILED;
6945 /* Look up the dynamically loaded object handle in the tree. If it isn't
6946 found, dlopen() the file and put the handle in the tree for next time. */
6948 if (!(t = tree_search(dlobj_anchor, argv[0])))
6950 void * handle = dlopen(CS argv[0], RTLD_LAZY);
6953 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6954 argv[0], dlerror());
6955 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6958 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), argv[0]);
6959 Ustrcpy(t->name, argv[0]);
6960 t->data.ptr = handle;
6961 (void)tree_insertnode(&dlobj_anchor, t);
6964 /* Having obtained the dynamically loaded object handle, look up the
6965 function pointer. */
6967 if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6969 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6970 "%s", argv[1], argv[0], dlerror());
6971 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6975 /* Call the function and work out what to do with the result. If it
6976 returns OK, we have a replacement string; if it returns DEFER then
6977 expansion has failed in a non-forced manner; if it returns FAIL then
6978 failure was forced; if it returns ERROR or any other value there's a
6979 problem, so panic slightly. In any case, assume that the function has
6980 side-effects on the store that must be preserved. */
6984 for (argc = 0; argv[argc]; argc++) ;
6986 if ((status = func(&result, argc - 2, &argv[2])) != OK)
6988 expand_string_message = result ? result : US"(no message)";
6989 if (status == FAIL_FORCED)
6990 f.expand_string_forcedfail = TRUE;
6991 else if (status != FAIL)
6992 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6993 argv[0], argv[1], status, expand_string_message);
6997 if (result) yield = string_cat(yield, result);
7000 #endif /* EXPAND_DLFUNC */
7002 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
7005 uschar *save_lookup_value = lookup_value;
7007 if (Uskip_whitespace(&s) != '{') /*}*/
7010 key = expand_string_internal(s+1,
7011 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7012 if (!key) goto EXPAND_FAILED; /*{{*/
7015 expand_string_message = US"missing '}' for name arg of env";
7016 goto EXPAND_FAILED_CURLY;
7019 lookup_value = US getenv(CS key);
7021 switch(process_yesno(
7022 flags, /* were previously skipping */
7023 lookup_value != NULL, /* success/failure indicator */
7024 save_lookup_value, /* value to reset for string2 */
7025 &s, /* input pointer */
7026 &yield, /* output pointer */
7027 US"env", /* condition type */
7030 case 1: goto EXPAND_FAILED; /* when all is well, the */
7031 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
7033 if (flags & ESI_SKIPPING) continue;
7038 case EITEM_SRS_ENCODE:
7039 /* ${srs_encode {secret} {return_path} {orig_domain}} */
7044 BOOL quoted = FALSE;
7046 switch (read_subs(sub, 3, 3, CUSS &s, flags, TRUE, name, &resetok, NULL))
7048 case -1: continue; /* skipping */
7049 case 1: goto EXPAND_FAILED_CURLY;
7051 case 3: goto EXPAND_FAILED;
7054 if (sub[1] && *(sub[1]))
7056 g = string_catn(g, US"SRS0=", 5);
7058 /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
7059 hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
7060 g = string_catn(g, cksum, sizeof(cksum));
7061 g = string_catn(g, US"=", 1);
7063 /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
7069 gettimeofday(&now, NULL);
7070 for (unsigned long i = (now.tv_sec / 86400) & 0x3ff; i; i >>= 5)
7071 h = string_catn(h, &base32_chars[i & 0x1f], 1);
7072 if (h) while (h->ptr > 0)
7073 g = string_catn(g, &h->s[--h->ptr], 1);
7075 g = string_catn(g, US"=", 1);
7077 /* ${domain:$return_path}=${local_part:$return_path} */
7079 int start, end, domain;
7080 uschar * t = parse_extract_address(sub[1], &expand_string_message,
7081 &start, &end, &domain, FALSE);
7087 if (domain > 0) g = string_cat(g, t + domain);
7088 g = string_catn(g, US"=", 1);
7090 s = domain > 0 ? string_copyn(t, domain - 1) : t;
7091 if ((quoted = Ustrchr(s, '"') != NULL))
7094 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
7095 while (*s) /* de-quote */
7097 while (*s && *s != '"') h = string_catn(h, s++, 1);
7099 while (*s && *s != '"') h = string_catn(h, s++, 1);
7102 gstring_release_unused(h);
7103 s = string_from_gstring(h);
7105 g = string_cat(g, s);
7108 /* Assume that if the original local_part had quotes
7109 it was for good reason */
7111 if (quoted) yield = string_catn(yield, US"\"", 1);
7112 yield = gstring_append(yield, g);
7113 if (quoted) yield = string_catn(yield, US"\"", 1);
7115 /* @$original_domain */
7116 yield = string_catn(yield, US"@", 1);
7117 yield = string_cat(yield, sub[2]);
7120 DEBUG(D_expand) debug_printf_indent("null return_path for srs-encode\n");
7124 #endif /*SUPPORT_SRS*/
7128 } /* EITEM_* switch */
7131 DEBUG(D_expand) /* only if not the sole expansion of the line */
7132 if (yield && (expansion_start > 0 || *s))
7133 debug_expansion_interim(US"item-res",
7134 yield->s + expansion_start, yield->ptr - expansion_start,
7135 !!(flags & ESI_SKIPPING));
7141 /* Control reaches here if the name is not recognized as one of the more
7142 complicated expansion items. Check for the "operator" syntax (name terminated
7143 by a colon). Some of the operators have arguments, separated by _ from the
7149 uschar * arg = NULL, * sub;
7151 var_entry * vp = NULL;
7154 /* Owing to an historical mis-design, an underscore may be part of the
7155 operator name, or it may introduce arguments. We therefore first scan the
7156 table of names that contain underscores. If there is no match, we cut off
7157 the arguments and then scan the main table. */
7159 if ((c = chop_match(name, op_table_underscore,
7160 nelem(op_table_underscore))) < 0)
7162 if ((arg = Ustrchr(name, '_')))
7164 if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
7165 c += nelem(op_table_underscore);
7166 if (arg) *arg++ = '_'; /* Put back for error messages */
7169 /* Deal specially with operators that might take a certificate variable
7170 as we do not want to do the usual expansion. For most, expand the string.*/
7181 const uschar * s1 = s;
7182 sub = expand_string_internal(s+2,
7183 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s1, &resetok, NULL);
7184 if (!sub) goto EXPAND_FAILED; /*{*/
7187 expand_string_message =
7188 string_sprintf("missing '}' closing cert arg of %s", name);
7189 goto EXPAND_FAILED_CURLY;
7191 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
7201 sub = expand_string_internal(s+1,
7202 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7203 if (!sub) goto EXPAND_FAILED;
7208 /* If we are skipping, we don't need to perform the operation at all.
7209 This matters for operations like "mask", because the data may not be
7210 in the correct format when skipping. For example, the expression may test
7211 for the existence of $sender_host_address before trying to mask it. For
7212 other operations, doing them may not fail, but it is a waste of time. */
7214 if (flags & ESI_SKIPPING && c >= 0) continue;
7216 /* Otherwise, switch on the operator type. After handling go back
7217 to the main loop top. */
7220 unsigned expansion_start = gstring_length(yield);
7226 unsigned long int n = Ustrtoul(sub, &t, 10);
7231 expand_string_message = string_sprintf("argument for base32 "
7232 "operator is \"%s\", which is not a decimal number", sub);
7236 g = string_catn(g, &base32_chars[n & 0x1f], 1);
7238 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7245 unsigned long int n = 0;
7248 uschar * t = Ustrchr(base32_chars, *tt++);
7251 expand_string_message = string_sprintf("argument for base32d "
7252 "operator is \"%s\", which is not a base 32 number", sub);
7255 n = n * 32 + (t - base32_chars);
7257 yield = string_fmt_append(yield, "%ld", n);
7264 unsigned long int n = Ustrtoul(sub, &t, 10);
7267 expand_string_message = string_sprintf("argument for base62 "
7268 "operator is \"%s\", which is not a decimal number", sub);
7271 yield = string_cat(yield, string_base62(n));
7275 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7280 unsigned long int n = 0;
7283 uschar *t = Ustrchr(base62_chars, *tt++);
7286 expand_string_message = string_sprintf("argument for base62d "
7287 "operator is \"%s\", which is not a base %d number", sub,
7291 n = n * BASE_62 + (t - base62_chars);
7293 yield = string_fmt_append(yield, "%ld", n);
7299 uschar *expanded = expand_string_internal(sub,
7300 ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, NULL, &resetok, NULL);
7303 expand_string_message =
7304 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7305 expand_string_message);
7308 yield = string_cat(yield, expanded);
7315 uschar *t = sub - 1;
7316 while (*(++t) != 0) { *t = tolower(*t); count++; }
7317 yield = string_catn(yield, sub, count);
7324 uschar *t = sub - 1;
7325 while (*(++t) != 0) { *t = toupper(*t); count++; }
7326 yield = string_catn(yield, sub, count);
7332 if (vp && *(void **)vp->value)
7334 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7335 yield = string_cat(yield, cp);
7343 md5_end(&base, sub, Ustrlen(sub), digest);
7344 for (int j = 0; j < 16; j++)
7345 yield = string_fmt_append(yield, "%02x", digest[j]);
7351 if (vp && *(void **)vp->value)
7353 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7354 yield = string_cat(yield, cp);
7362 sha1_end(&h, sub, Ustrlen(sub), digest);
7363 for (int j = 0; j < 20; j++)
7364 yield = string_fmt_append(yield, "%02X", digest[j]);
7370 #ifdef EXIM_HAVE_SHA2
7371 if (vp && *(void **)vp->value)
7372 if (c == EOP_SHA256)
7373 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7375 expand_string_message = US"sha2_N not supported with certificates";
7380 hashmethod m = !arg ? HASH_SHA2_256
7381 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7382 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7383 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7386 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7388 expand_string_message = US"unrecognised sha2 variant";
7392 exim_sha_update_string(&h, sub);
7393 exim_sha_finish(&h, &b);
7395 yield = string_fmt_append(yield, "%02X", *b.data++);
7398 expand_string_message = US"sha256 only supported with TLS";
7403 #ifdef EXIM_HAVE_SHA3
7407 hashmethod m = !arg ? HASH_SHA3_256
7408 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7409 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7410 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7411 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7414 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7416 expand_string_message = US"unrecognised sha3 variant";
7420 exim_sha_update_string(&h, sub);
7421 exim_sha_finish(&h, &b);
7423 yield = string_fmt_append(yield, "%02X", *b.data++);
7427 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7431 /* Line-wrap a string as if it is a header line */
7433 case EOP_HEADERWRAP:
7435 unsigned col = 80, lim = 998;
7440 const uschar * list = arg;
7442 if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7445 if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7449 if ((s = wrap_header(sub, col, lim, US"\t", 8)))
7450 yield = string_cat(yield, s);
7454 /* Convert hex encoding to base64 encoding */
7464 for (enc = sub; *enc; enc++)
7466 if (!isxdigit(*enc))
7468 expand_string_message = string_sprintf("\"%s\" is not a hex "
7477 expand_string_message = string_sprintf("\"%s\" contains an odd "
7478 "number of characters", sub);
7482 while ((c = *in++) != 0)
7484 if (isdigit(c)) c -= '0';
7485 else c = toupper(c) - 'A' + 10;
7495 enc = b64encode(CUS sub, out - sub);
7496 yield = string_cat(yield, enc);
7500 /* Convert octets outside 0x21..0x7E to \xXX form */
7504 uschar *t = sub - 1;
7507 if (*t < 0x21 || 0x7E < *t)
7508 yield = string_fmt_append(yield, "\\x%02x", *t);
7510 yield = string_catn(yield, t, 1);
7515 /* count the number of list elements */
7519 int cnt = 0, sep = 0;
7520 uschar * buf = store_get(2, sub);
7522 while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7523 yield = string_fmt_append(yield, "%d", cnt);
7527 /* expand a named list given the name */
7528 /* handles nested named lists; requotes as colon-sep list */
7531 expand_string_message = NULL;
7532 yield = expand_listnamed(yield, sub, arg);
7533 if (expand_string_message)
7537 /* quote a list-item for the given list-separator */
7539 /* mask applies a mask to an IP address; for example the result of
7540 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7547 int type, mask, maskoffset;
7551 if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7553 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7558 if (maskoffset == 0)
7560 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7565 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7567 if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7569 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7574 /* If an optional 'n' was given, ipv6 gets normalised output:
7575 colons rather than dots, and zero-compressed. */
7577 normalised = arg && *arg == 'n';
7579 /* Convert the address to binary integer(s) and apply the mask */
7581 sub[maskoffset] = 0;
7582 count = host_aton(sub, binary);
7583 host_mask(count, binary, mask);
7585 /* Convert to masked textual format and add to output. */
7587 if (type == 4 || !normalised)
7588 yield = string_catn(yield, buffer,
7589 host_nmtoa(count, binary, mask, buffer, '.'));
7592 ipv6_nmtoa(binary, buffer);
7593 yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7599 case EOP_IPV6DENORM:
7601 int type = string_is_ip_address(sub, NULL);
7608 (void) host_aton(sub, binary);
7611 case 4: /* convert to IPv4-mapped IPv6 */
7612 binary[0] = binary[1] = 0;
7613 binary[2] = 0x0000ffff;
7614 (void) host_aton(sub, binary+3);
7618 expand_string_message =
7619 string_sprintf("\"%s\" is not an IP address", sub);
7623 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7624 ? ipv6_nmtoa(binary, buffer)
7625 : host_nmtoa(4, binary, -1, buffer, ':')
7631 case EOP_LOCAL_PART:
7635 int start, end, domain;
7636 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7639 if (c != EOP_DOMAIN)
7640 yield = c == EOP_LOCAL_PART && domain > 0
7641 ? string_catn(yield, t, domain - 1)
7642 : string_cat(yield, t);
7643 else if (domain > 0)
7644 yield = string_cat(yield, t + domain);
7650 uschar outsep[2] = { ':', '\0' };
7651 uschar *address, *error;
7652 int save_ptr = gstring_length(yield);
7653 int start, end, domain; /* Not really used */
7655 if (Uskip_whitespace(&sub) == '>')
7656 if (*outsep = *++sub) ++sub;
7659 expand_string_message = string_sprintf("output separator "
7660 "missing in expanding ${addresses:%s}", --sub);
7663 f.parse_allow_group = TRUE;
7667 uschar * p = parse_find_address_end(sub, FALSE);
7668 uschar saveend = *p;
7670 address = parse_extract_address(sub, &error, &start, &end, &domain,
7674 /* Add the address to the output list that we are building. This is
7675 done in chunks by searching for the separator character. At the
7676 start, unless we are dealing with the first address of the output
7677 list, add in a space if the new address begins with the separator
7678 character, or is an empty string. */
7682 if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7683 yield = string_catn(yield, US" ", 1);
7687 size_t seglen = Ustrcspn(address, outsep);
7688 yield = string_catn(yield, address, seglen + 1);
7690 /* If we got to the end of the string we output one character
7693 if (address[seglen] == '\0') { yield->ptr--; break; }
7694 yield = string_catn(yield, outsep, 1);
7695 address += seglen + 1;
7698 /* Output a separator after the string: we will remove the
7699 redundant final one at the end. */
7701 yield = string_catn(yield, outsep, 1);
7704 if (saveend == '\0') break;
7708 /* If we have generated anything, remove the redundant final
7711 if (yield && yield->ptr != save_ptr) yield->ptr--;
7712 f.parse_allow_group = FALSE;
7717 /* quote puts a string in quotes if it is empty or contains anything
7718 other than alphamerics, underscore, dot, or hyphen.
7720 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7721 be quoted in order to be a valid local part.
7723 In both cases, newlines and carriage returns are converted into \n and \r
7727 case EOP_QUOTE_LOCAL_PART:
7730 BOOL needs_quote = (!*sub); /* TRUE for empty string */
7731 uschar *t = sub - 1;
7734 while (!needs_quote && *++t)
7735 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7737 else /* EOP_QUOTE_LOCAL_PART */
7738 while (!needs_quote && *++t)
7739 needs_quote = !isalnum(*t)
7740 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7741 && (*t != '.' || t == sub || !t[1]);
7745 yield = string_catn(yield, US"\"", 1);
7749 yield = string_catn(yield, US"\\n", 2);
7750 else if (*t == '\r')
7751 yield = string_catn(yield, US"\\r", 2);
7754 if (*t == '\\' || *t == '"')
7755 yield = string_catn(yield, US"\\", 1);
7756 yield = string_catn(yield, t, 1);
7758 yield = string_catn(yield, US"\"", 1);
7761 yield = string_cat(yield, sub);
7765 /* quote_lookuptype does lookup-specific quoting */
7770 uschar * opt = Ustrchr(arg, '_');
7772 if (opt) *opt++ = 0;
7774 if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7776 expand_string_message = search_error_message;
7780 if (lookup_list[n]->quote)
7781 sub = (lookup_list[n]->quote)(sub, opt, (unsigned)n);
7787 expand_string_message = string_sprintf(
7788 "\"%s\" unrecognized after \"${quote_%s\"", /*}*/
7793 yield = string_cat(yield, sub);
7797 /* rx quote sticks in \ before any non-alphameric character so that
7798 the insertion works in a regular expression. */
7802 uschar *t = sub - 1;
7806 yield = string_catn(yield, US"\\", 1);
7807 yield = string_catn(yield, t, 1);
7812 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7813 prescribed by the RFC, if there are characters that need to be encoded */
7816 yield = string_cat(yield,
7817 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7821 /* RFC 2047 decode */
7827 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7828 headers_charset, '?', &len, &error);
7831 expand_string_message = error;
7834 yield = string_catn(yield, decoded, len);
7838 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7843 uschar * buff = store_get(4, sub);
7848 if (c > 255) c = '_';
7850 yield = string_catn(yield, buff, 1);
7855 /* replace illegal UTF-8 sequences by replacement character */
7857 #define UTF8_REPLACEMENT_CHAR US"?"
7861 int seq_len = 0, index = 0, bytes_left = 0, complete;
7862 long codepoint = -1;
7863 uschar seq_buff[4]; /* accumulate utf-8 here */
7865 /* Manually track tainting, as we deal in individual chars below */
7868 yield = string_get_tainted(Ustrlen(sub), sub);
7869 else if (!yield->s || !yield->ptr)
7871 yield->s = store_get(yield->size = Ustrlen(sub), sub);
7872 gstring_reset(yield);
7874 else if (is_incompatible(yield->s, sub))
7875 gstring_rebuffer(yield, sub);
7877 /* Check the UTF-8, byte-by-byte */
7886 if ((c & 0xc0) != 0x80)
7887 /* wrong continuation byte; invalidate all bytes */
7888 complete = 1; /* error */
7891 codepoint = (codepoint << 6) | (c & 0x3f);
7892 seq_buff[index++] = c;
7893 if (--bytes_left == 0) /* codepoint complete */
7894 if(codepoint > 0x10FFFF) /* is it too large? */
7895 complete = -1; /* error (RFC3629 limit) */
7897 { /* finished; output utf-8 sequence */
7898 yield = string_catn(yield, seq_buff, seq_len);
7903 else /* no bytes left: new sequence */
7905 if(!(c & 0x80)) /* 1-byte sequence, US-ASCII, keep it */
7907 yield = string_catn(yield, &c, 1);
7910 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7912 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7917 codepoint = c & 0x1f;
7920 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7923 codepoint = c & 0x0f;
7925 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7928 codepoint = c & 0x07;
7930 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7933 seq_buff[index++] = c;
7934 seq_len = bytes_left + 1;
7935 } /* if(bytes_left) */
7939 bytes_left = index = 0;
7940 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7942 if ((complete == 1) && ((c & 0x80) == 0))
7943 /* ASCII character follows incomplete sequence */
7944 yield = string_catn(yield, &c, 1);
7946 /* If given a sequence truncated mid-character, we also want to report ?
7947 Eg, ${length_1:フィル} is one byte, not one character, so we expect
7948 ${utf8clean:${length_1:フィル}} to yield '?' */
7950 if (bytes_left != 0)
7951 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7957 case EOP_UTF8_DOMAIN_TO_ALABEL:
7959 uschar * error = NULL;
7960 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7963 expand_string_message = string_sprintf(
7964 "error converting utf8 (%s) to alabel: %s",
7965 string_printing(sub), error);
7968 yield = string_cat(yield, s);
7972 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7974 uschar * error = NULL;
7975 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7978 expand_string_message = string_sprintf(
7979 "error converting alabel (%s) to utf8: %s",
7980 string_printing(sub), error);
7983 yield = string_cat(yield, s);
7987 case EOP_UTF8_LOCALPART_TO_ALABEL:
7989 uschar * error = NULL;
7990 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7993 expand_string_message = string_sprintf(
7994 "error converting utf8 (%s) to alabel: %s",
7995 string_printing(sub), error);
7998 yield = string_cat(yield, s);
7999 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", string_from_gstring(yield));
8003 case EOP_UTF8_LOCALPART_FROM_ALABEL:
8005 uschar * error = NULL;
8006 uschar * s = string_localpart_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);
8017 #endif /* EXPERIMENTAL_INTERNATIONAL */
8019 /* escape turns all non-printing characters into escape sequences. */
8023 const uschar * t = string_printing(sub);
8024 yield = string_cat(yield, t);
8028 case EOP_ESCAPE8BIT:
8032 for (const uschar * s = sub; (c = *s); s++)
8033 yield = c < 127 && c != '\\'
8034 ? string_catn(yield, s, 1)
8035 : string_fmt_append(yield, "\\%03o", c);
8039 /* Handle numeric expression evaluation */
8044 uschar *save_sub = sub;
8045 uschar *error = NULL;
8046 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
8049 expand_string_message = string_sprintf("error in expression "
8050 "evaluation: %s (after processing \"%.*s\")", error,
8051 (int)(sub-save_sub), save_sub);
8054 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
8058 /* Handle time period formatting */
8062 int n = readconf_readtime(sub, 0, FALSE);
8065 expand_string_message = string_sprintf("string \"%s\" is not an "
8066 "Exim time interval in \"%s\" operator", sub, name);
8069 yield = string_fmt_append(yield, "%d", n);
8073 case EOP_TIME_INTERVAL:
8076 uschar *t = read_number(&n, sub);
8077 if (*t != 0) /* Not A Number*/
8079 expand_string_message = string_sprintf("string \"%s\" is not a "
8080 "positive number in \"%s\" operator", sub, name);
8083 t = readconf_printtime(n);
8084 yield = string_cat(yield, t);
8088 /* Convert string to base64 encoding */
8094 uschar * s = vp && *(void **)vp->value
8095 ? tls_cert_der_b64(*(void **)vp->value)
8096 : b64encode(CUS sub, Ustrlen(sub));
8098 uschar * s = b64encode(CUS sub, Ustrlen(sub));
8100 yield = string_cat(yield, s);
8107 int len = b64decode(sub, &s);
8110 expand_string_message = string_sprintf("string \"%s\" is not "
8111 "well-formed for \"%s\" operator", sub, name);
8114 yield = string_cat(yield, s);
8118 /* strlen returns the length of the string */
8121 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
8124 /* length_n or l_n takes just the first n characters or the whole string,
8125 whichever is the shorter;
8127 substr_m_n, and s_m_n take n characters from offset m; negative m take
8128 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
8129 takes the rest, either to the right or to the left.
8131 hash_n or h_n makes a hash of length n from the string, yielding n
8132 characters from the set a-z; hash_n_m makes a hash of length n, but
8133 uses m characters from the set a-zA-Z0-9.
8135 nhash_n returns a single number between 0 and n-1 (in text form), while
8136 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
8137 between 0 and n-1 and the second between 0 and m-1. */
8157 expand_string_message = string_sprintf("missing values after %s",
8162 /* "length" has only one argument, effectively being synonymous with
8165 if (c == EOP_LENGTH || c == EOP_L)
8171 /* The others have one or two arguments; for "substr" the first may be
8172 negative. The second being negative means "not supplied". */
8177 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8180 /* Read up to two numbers, separated by underscores */
8185 if (arg != ret && *arg == '_' && pn == &value1)
8189 if (arg[1] != 0) arg++;
8191 else if (!isdigit(*arg))
8193 expand_string_message =
8194 string_sprintf("non-digit after underscore in \"%s\"", name);
8197 else *pn = (*pn)*10 + *arg++ - '0';
8201 /* Perform the required operation */
8203 ret = c == EOP_HASH || c == EOP_H
8204 ? compute_hash(sub, value1, value2, &len)
8205 : c == EOP_NHASH || c == EOP_NH
8206 ? compute_nhash(sub, value1, value2, &len)
8207 : extract_substr(sub, value1, value2, &len);
8208 if (!ret) goto EXPAND_FAILED;
8210 yield = string_catn(yield, ret, len);
8219 uschar **modetable[3];
8223 if (expand_forbid & RDO_EXISTS)
8225 expand_string_message = US"Use of the stat() expansion is not permitted";
8229 if (stat(CS sub, &st) < 0)
8231 expand_string_message = string_sprintf("stat(%s) failed: %s",
8232 sub, strerror(errno));
8236 switch (mode & S_IFMT)
8238 case S_IFIFO: smode[0] = 'p'; break;
8239 case S_IFCHR: smode[0] = 'c'; break;
8240 case S_IFDIR: smode[0] = 'd'; break;
8241 case S_IFBLK: smode[0] = 'b'; break;
8242 case S_IFREG: smode[0] = '-'; break;
8243 default: smode[0] = '?'; break;
8246 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8247 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8248 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8250 for (int i = 0; i < 3; i++)
8252 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8257 yield = string_fmt_append(yield,
8258 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8259 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8260 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8261 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8262 (long)st.st_gid, st.st_size, (long)st.st_atime,
8263 (long)st.st_mtime, (long)st.st_ctime);
8267 /* vaguely random number less than N */
8271 int_eximarith_t max = expanded_string_integer(sub, TRUE);
8273 if (expand_string_message)
8275 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8279 /* Reverse IP, including IPv6 to dotted-nibble */
8281 case EOP_REVERSE_IP:
8283 int family, maskptr;
8284 uschar reversed[128];
8286 family = string_is_ip_address(sub, &maskptr);
8289 expand_string_message = string_sprintf(
8290 "reverse_ip() not given an IP address [%s]", sub);
8293 invert_address(reversed, sub);
8294 yield = string_cat(yield, reversed);
8298 /* Unknown operator */
8301 expand_string_message =
8302 string_sprintf("unknown expansion operator \"%s\"", name);
8304 } /* EOP_* switch */
8308 const uschar * res = string_from_gstring(yield);
8309 const uschar * s = res + expansion_start;
8310 int i = gstring_length(yield) - expansion_start;
8311 BOOL tainted = is_tainted(s);
8315 debug_printf_indent("|-----op-res: %.*s\n", i, s);
8318 debug_printf_indent("%s \\__", flags & ESI_SKIPPING ? "| " : " ");
8319 debug_print_taint(res);
8324 debug_printf_indent(UTF8_VERT_RIGHT
8325 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8326 "op-res: %.*s\n", i, s);
8329 debug_printf_indent("%s",
8330 flags & ESI_SKIPPING
8331 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8332 debug_print_taint(res);
8340 /* Not an item or an operator */
8341 /* Handle a plain name. If this is the first thing in the expansion, release
8342 the pre-allocated buffer. If the result data is known to be in a new buffer,
8343 newsize will be set to the size of that buffer, and we can just point at that
8344 store instead of copying. Many expansion strings contain just one reference,
8345 so this is a useful optimization, especially for humungous headers
8346 ($message_headers). */
8350 const uschar * value;
8356 g = store_get(sizeof(gstring), GET_UNTAINTED);
8357 else if (yield->ptr == 0)
8359 if (resetok) reset_point = store_reset(reset_point);
8361 reset_point = store_mark();
8362 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
8364 if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
8366 expand_string_message =
8367 string_sprintf("unknown variable in \"${%s}\"", name);
8368 check_variable_error_message(name);
8371 len = Ustrlen(value);
8372 if (!yield && newsize)
8375 yield->size = newsize;
8377 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8380 yield = string_catn(yield, value, len);
8384 /* Else there's something wrong */
8386 expand_string_message =
8387 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8388 "in a variable reference)", name);
8392 /* If we hit the end of the string when brace_ends is set, there is a missing
8393 terminating brace. */
8395 if (flags & ESI_BRACE_ENDS && !*s)
8397 expand_string_message = malformed_header
8398 ? US"missing } at end of string - could be header name not terminated by colon"
8399 : US"missing } at end of string";
8403 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8404 added to the string. If so, set up an empty string. Add a terminating zero. If
8405 left != NULL, return a pointer to the terminator. */
8411 yield = string_get(1);
8412 res = string_from_gstring(yield);
8413 if (left) *left = s;
8415 /* Any stacking store that was used above the final string is no longer needed.
8416 In many cases the final string will be the first one that was got and so there
8417 will be optimal store usage. */
8419 if (resetok) gstring_release_unused(yield);
8420 else if (resetok_p) *resetok_p = FALSE;
8424 BOOL tainted = is_tainted(res);
8427 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8428 debug_printf_indent("%sresult: %s\n",
8429 flags & ESI_SKIPPING ? "|-----" : "\\_____", res);
8432 debug_printf_indent("%s \\__", flags & ESI_SKIPPING ? "| " : " ");
8433 debug_print_taint(res);
8435 if (flags & ESI_SKIPPING)
8436 debug_printf_indent("\\___skipping: result is not used\n");
8440 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8441 "expanding: %.*s\n",
8442 (int)(s - string), string);
8443 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8445 flags & ESI_SKIPPING ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8449 debug_printf_indent("%s",
8450 flags & ESI_SKIPPING
8451 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8452 debug_print_taint(res);
8454 if (flags & ESI_SKIPPING)
8455 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8456 "skipping: result is not used\n");
8459 if (textonly_p) *textonly_p = textonly;
8464 /* This is the failure exit: easiest to program with a goto. We still need
8465 to update the pointer to the terminator, for cases of nested calls with "fail".
8468 EXPAND_FAILED_CURLY:
8469 if (malformed_header)
8470 expand_string_message =
8471 US"missing or misplaced { or } - could be header name not terminated by colon";
8473 else if (!expand_string_message || !*expand_string_message)
8474 expand_string_message = US"missing or misplaced { or }";
8476 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8477 that is a bad idea, because expand_string_message is in dynamic store. */
8480 if (left) *left = s;
8485 debug_printf_indent("|failed to expand: %s\n", string);
8486 debug_printf_indent("%serror message: %s\n",
8487 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8488 if (f.expand_string_forcedfail)
8489 debug_printf_indent("\\failure was forced\n");
8493 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8495 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8496 "error message: %s\n",
8497 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8498 expand_string_message);
8499 if (f.expand_string_forcedfail)
8500 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8503 if (resetok_p && !resetok) *resetok_p = FALSE;
8510 /* This is the external function call. Do a quick check for any expansion
8511 metacharacters, and if there are none, just return the input string.
8514 the string to be expanded
8515 optional pointer for return boolean indicating no-dynamic-expansions
8517 Returns: the expanded string, or NULL if expansion failed; if failure was
8518 due to a lookup deferring, search_find_defer will be TRUE
8522 expand_string_2(const uschar * string, BOOL * textonly_p)
8524 if (Ustrpbrk(string, "$\\") != NULL)
8526 int old_pool = store_pool;
8529 f.search_find_defer = FALSE;
8530 malformed_header = FALSE;
8531 store_pool = POOL_MAIN;
8532 s = expand_string_internal(string, ESI_HONOR_DOLLAR, NULL, NULL, textonly_p);
8533 store_pool = old_pool;
8536 if (textonly_p) *textonly_p = TRUE;
8541 expand_cstring(const uschar * string)
8542 { return expand_string_2(string, NULL); }
8545 expand_string(uschar * string)
8546 { return US expand_string_2(CUS string, NULL); }
8553 /*************************************************
8555 *************************************************/
8557 /* Now and again we want to expand a string and be sure that the result is in a
8558 new bit of store. This function does that.
8559 Since we know it has been copied, the de-const cast is safe.
8561 Argument: the string to be expanded
8562 Returns: the expanded string, always in a new bit of store, or NULL
8566 expand_string_copy(const uschar *string)
8568 const uschar *yield = expand_cstring(string);
8569 if (yield == string) yield = string_copy(string);
8575 /*************************************************
8576 * Expand and interpret as an integer *
8577 *************************************************/
8579 /* Expand a string, and convert the result into an integer.
8582 string the string to be expanded
8583 isplus TRUE if a non-negative number is expected
8585 Returns: the integer value, or
8586 -1 for an expansion error ) in both cases, message in
8587 -2 for an integer interpretation error ) expand_string_message
8588 expand_string_message is set NULL for an OK integer
8592 expand_string_integer(uschar *string, BOOL isplus)
8594 return expanded_string_integer(expand_string(string), isplus);
8598 /*************************************************
8599 * Interpret string as an integer *
8600 *************************************************/
8602 /* Convert a string (that has already been expanded) into an integer.
8604 This function is used inside the expansion code.
8607 s the string to be expanded
8608 isplus TRUE if a non-negative number is expected
8610 Returns: the integer value, or
8611 -1 if string is NULL (which implies an expansion error)
8612 -2 for an integer interpretation error
8613 expand_string_message is set NULL for an OK integer
8616 static int_eximarith_t
8617 expanded_string_integer(const uschar *s, BOOL isplus)
8619 int_eximarith_t value;
8620 uschar *msg = US"invalid integer \"%s\"";
8623 /* If expansion failed, expand_string_message will be set. */
8627 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8628 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8629 systems, so we set it zero ourselves. */
8632 expand_string_message = NULL; /* Indicates no error */
8634 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8635 equal to 0. Unfortunately, people actually relied upon that, so preserve
8636 the behaviour explicitly. Stripping leading whitespace is a harmless
8637 noop change since strtol skips it anyway (provided that there is a number
8640 if (Uskip_whitespace(&s) == '\0')
8643 debug_printf_indent("treating blank string as number 0\n");
8647 value = strtoll(CS s, CSS &endptr, 10);
8650 msg = US"integer expected but \"%s\" found";
8651 else if (value < 0 && isplus)
8652 msg = US"non-negative integer expected but \"%s\" found";
8655 switch (tolower(*endptr))
8660 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8665 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8666 else value *= 1024*1024;
8670 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8671 else value *= 1024*1024*1024;
8675 if (errno == ERANGE)
8676 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8678 if (Uskip_whitespace(&endptr) == 0) return value;
8681 expand_string_message = string_sprintf(CS msg, s);
8686 /* These values are usually fixed boolean values, but they are permitted to be
8690 addr address being routed
8691 mtype the module type
8692 mname the module name
8693 dbg_opt debug selectors
8694 oname the option name
8695 bvalue the router's boolean value
8696 svalue the router's string value
8697 rvalue where to put the returned value
8699 Returns: OK value placed in rvalue
8700 DEFER expansion failed
8704 exp_bool(address_item *addr,
8705 uschar *mtype, uschar *mname, unsigned dbg_opt,
8706 uschar *oname, BOOL bvalue,
8707 uschar *svalue, BOOL *rvalue)
8710 if (!svalue) { *rvalue = bvalue; return OK; }
8712 if (!(expanded = expand_string(svalue)))
8714 if (f.expand_string_forcedfail)
8716 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8720 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8721 oname, mname, mtype, expand_string_message);
8722 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8726 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8729 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8731 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8735 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8736 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8745 /* Avoid potentially exposing a password in a string about to be logged */
8748 expand_hide_passwords(uschar * s)
8750 return ( ( Ustrstr(s, "failed to expand") != NULL
8751 || Ustrstr(s, "expansion of ") != NULL
8753 && ( Ustrstr(s, "mysql") != NULL
8754 || Ustrstr(s, "pgsql") != NULL
8755 || Ustrstr(s, "redis") != NULL
8756 || Ustrstr(s, "sqlite") != NULL
8757 || Ustrstr(s, "ldap:") != NULL
8758 || Ustrstr(s, "ldaps:") != NULL
8759 || Ustrstr(s, "ldapi:") != NULL
8760 || Ustrstr(s, "ldapdn:") != NULL
8761 || Ustrstr(s, "ldapm:") != NULL
8763 ? US"Temporary internal error" : s;
8767 /* Read given named file into big_buffer. Use for keying material etc.
8768 The content will have an ascii NUL appended.
8773 Return: pointer to buffer, or NULL on error.
8777 expand_file_big_buffer(const uschar * filename)
8779 int fd, off = 0, len;
8781 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8783 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8790 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8793 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8801 big_buffer[off] = '\0';
8807 /*************************************************
8808 * Error-checking for testsuite *
8809 *************************************************/
8811 uschar * region_start;
8812 uschar * region_end;
8813 const uschar *var_name;
8814 const uschar *var_data;
8817 /* Called via tree_walk, which allows nonconst name/data. Our usage is const. */
8819 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8822 if (var_data >= e->region_start && var_data < e->region_end)
8824 e->var_name = CUS var_name;
8825 e->var_data = CUS var_data;
8830 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8832 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8833 .var_name = NULL, .var_data = NULL };
8835 /* check acl_ variables */
8836 tree_walk(acl_var_c, assert_variable_notin, &e);
8837 tree_walk(acl_var_m, assert_variable_notin, &e);
8839 /* check auth<n> variables.
8840 assert_variable_notin() treats as const, so deconst is safe. */
8841 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8842 assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8844 #ifdef WITH_CONTENT_SCAN
8845 /* check regex<n> variables. assert_variable_notin() treats as const. */
8846 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8847 assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8850 /* check known-name variables */
8851 for (var_entry * v = var_table; v < var_table + nelem(var_table); v++)
8852 if (v->type == vtype_stringptr)
8853 assert_variable_notin(US v->name, *(USS v->value), &e);
8855 /* check dns and address trees */
8856 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8857 tree_walk(tree_duplicates, assert_variable_notin, &e);
8858 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8859 tree_walk(tree_unusable, assert_variable_notin, &e);
8862 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8863 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8864 e.var_name, filename, linenumber, e.var_data);
8869 /*************************************************
8870 **************************************************
8871 * Stand-alone test program *
8872 **************************************************
8873 *************************************************/
8879 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8881 int ovec[3*(EXPAND_MAXN+1)];
8882 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8884 BOOL yield = n >= 0;
8885 if (n == 0) n = EXPAND_MAXN + 1;
8888 expand_nmax = setup < 0 ? 0 : setup + 1;
8889 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8891 expand_nstring[expand_nmax] = subject + ovec[nn];
8892 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8900 int main(int argc, uschar **argv)
8902 uschar buffer[1024];
8904 debug_selector = D_v;
8905 debug_file = stderr;
8906 debug_fd = fileno(debug_file);
8907 big_buffer = malloc(big_buffer_size);
8910 for (int i = 1; i < argc; i++)
8912 if (argv[i][0] == '+')
8914 debug_trace_memory = 2;
8917 if (isdigit(argv[i][0]))
8918 debug_selector = Ustrtol(argv[i], NULL, 0);
8920 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8924 eldap_default_servers = argv[i];
8927 mysql_servers = argv[i];
8930 pgsql_servers = argv[i];
8933 redis_servers = argv[i];
8937 else opt_perl_startup = argv[i];
8941 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8943 expand_nstring[1] = US"string 1....";
8944 expand_nlength[1] = 8;
8948 if (opt_perl_startup != NULL)
8951 printf("Starting Perl interpreter\n");
8952 errstr = init_perl(opt_perl_startup);
8955 printf("** error in perl_startup code: %s\n", errstr);
8956 return EXIT_FAILURE;
8959 #endif /* EXIM_PERL */
8961 /* Thie deliberately regards the input as untainted, so that it can be
8962 expanded; only reasonable since this is a test for string-expansions. */
8964 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8966 rmark reset_point = store_mark();
8967 uschar *yield = expand_string(buffer);
8969 printf("%s\n", yield);
8972 if (f.search_find_defer) printf("search_find deferred\n");
8973 printf("Failed: %s\n", expand_string_message);
8974 if (f.expand_string_forcedfail) printf("Forced failure\n");
8977 store_reset(reset_point);
8985 #endif /*STAND_ALONE*/
8987 #endif /*!MACRO_PREDEF*/
8990 /* End of expand.c */