1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2022 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
11 /* Functions for handling string expansion. */
17 # include "macro_predef.h"
20 typedef unsigned esi_flags;
22 #define ESI_BRACE_ENDS BIT(0) /* expansion should stop at } */
23 #define ESI_HONOR_DOLLAR BIT(1) /* $ is meaningfull */
24 #define ESI_SKIPPING BIT(2) /* value will not be needed */
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[] = {
271 EOP_ADDRESS = nelem(op_table_underscore),
318 /* Table of condition names, and corresponding switch numbers. The names must
319 be in alphabetical order. */
321 static uschar *cond_table[] = {
325 US"==", /* Backward compatibility */
365 US"match_local_part",
390 ECOND_FIRST_DELIVERY,
418 ECOND_MATCH_LOCAL_PART,
428 /* Types of table entry */
431 vtype_int, /* value is address of int */
432 vtype_filter_int, /* ditto, but recognized only when filtering */
433 vtype_ino, /* value is address of ino_t (not always an int) */
434 vtype_uid, /* value is address of uid_t (not always an int) */
435 vtype_gid, /* value is address of gid_t (not always an int) */
436 vtype_bool, /* value is address of bool */
437 vtype_stringptr, /* value is address of pointer to string */
438 vtype_msgbody, /* as stringptr, but read when first required */
439 vtype_msgbody_end, /* ditto, the end of the message */
440 vtype_msgheaders, /* the message's headers, processed */
441 vtype_msgheaders_raw, /* the message's headers, unprocessed */
442 vtype_localpart, /* extract local part from string */
443 vtype_domain, /* extract domain from string */
444 vtype_string_func, /* value is string returned by given function */
445 vtype_todbsdin, /* value not used; generate BSD inbox tod */
446 vtype_tode, /* value not used; generate tod in epoch format */
447 vtype_todel, /* value not used; generate tod in epoch/usec format */
448 vtype_todf, /* value not used; generate full tod */
449 vtype_todl, /* value not used; generate log tod */
450 vtype_todlf, /* value not used; generate log file datestamp tod */
451 vtype_todzone, /* value not used; generate time zone only */
452 vtype_todzulu, /* value not used; generate zulu tod */
453 vtype_reply, /* value not used; get reply from headers */
454 vtype_pid, /* value not used; result is pid */
455 vtype_host_lookup, /* value not used; get host name */
456 vtype_load_avg, /* value not used; result is int from os_getloadavg */
457 vtype_pspace, /* partition space; value is T/F for spool/log */
458 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
459 vtype_cert /* SSL certificate */
461 ,vtype_dkim /* Lookup of value in DKIM signature */
465 /* Type for main variable table */
473 /* Type for entries pointing to address/length pairs. Not currently
481 typedef uschar * stringptr_fn_t(void);
482 static uschar * fn_recipients(void);
483 static uschar * fn_queue_size(void);
485 /* This table must be kept in alphabetical order. */
487 static var_entry var_table[] = {
488 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
489 they will be confused with user-creatable ACL variables. */
490 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
491 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
492 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
493 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
494 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
495 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
496 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
497 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
498 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
499 { "acl_narg", vtype_int, &acl_narg },
500 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
501 { "address_data", vtype_stringptr, &deliver_address_data },
502 { "address_file", vtype_stringptr, &address_file },
503 { "address_pipe", vtype_stringptr, &address_pipe },
504 #ifdef EXPERIMENTAL_ARC
505 { "arc_domains", vtype_string_func, (void *) &fn_arc_domains },
506 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
507 { "arc_state", vtype_stringptr, &arc_state },
508 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
510 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
511 { "authenticated_id", vtype_stringptr, &authenticated_id },
512 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
513 { "authentication_failed",vtype_int, &authentication_failed },
514 #ifdef WITH_CONTENT_SCAN
515 { "av_failed", vtype_int, &av_failed },
517 #ifdef EXPERIMENTAL_BRIGHTMAIL
518 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
519 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
520 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
521 { "bmi_deliver", vtype_int, &bmi_deliver },
523 { "body_linecount", vtype_int, &body_linecount },
524 { "body_zerocount", vtype_int, &body_zerocount },
525 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
526 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
527 { "caller_gid", vtype_gid, &real_gid },
528 { "caller_uid", vtype_uid, &real_uid },
529 { "callout_address", vtype_stringptr, &callout_address },
530 { "compile_date", vtype_stringptr, &version_date },
531 { "compile_number", vtype_stringptr, &version_cnumber },
532 { "config_dir", vtype_stringptr, &config_main_directory },
533 { "config_file", vtype_stringptr, &config_main_filename },
534 { "csa_status", vtype_stringptr, &csa_status },
535 #ifdef EXPERIMENTAL_DCC
536 { "dcc_header", vtype_stringptr, &dcc_header },
537 { "dcc_result", vtype_stringptr, &dcc_result },
540 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
541 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
542 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
543 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
544 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
545 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
546 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
547 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
548 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
549 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
550 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
551 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
552 { "dkim_key_length", vtype_int, &dkim_key_length },
553 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
554 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
555 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
556 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
557 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
558 { "dkim_signers", vtype_stringptr, &dkim_signers },
559 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
560 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
563 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
564 { "dmarc_status", vtype_stringptr, &dmarc_status },
565 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
566 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
568 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
569 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
570 { "dnslist_text", vtype_stringptr, &dnslist_text },
571 { "dnslist_value", vtype_stringptr, &dnslist_value },
572 { "domain", vtype_stringptr, &deliver_domain },
573 { "domain_data", vtype_stringptr, &deliver_domain_data },
574 #ifndef DISABLE_EVENT
575 { "event_data", vtype_stringptr, &event_data },
577 /*XXX want to use generic vars for as many of these as possible*/
578 { "event_defer_errno", vtype_int, &event_defer_errno },
580 { "event_name", vtype_stringptr, &event_name },
582 { "exim_gid", vtype_gid, &exim_gid },
583 { "exim_path", vtype_stringptr, &exim_path },
584 { "exim_uid", vtype_uid, &exim_uid },
585 { "exim_version", vtype_stringptr, &version_string },
586 { "headers_added", vtype_string_func, (void *) &fn_hdrs_added },
587 { "home", vtype_stringptr, &deliver_home },
588 { "host", vtype_stringptr, &deliver_host },
589 { "host_address", vtype_stringptr, &deliver_host_address },
590 { "host_data", vtype_stringptr, &host_data },
591 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
592 { "host_lookup_failed", vtype_int, &host_lookup_failed },
593 { "host_port", vtype_int, &deliver_host_port },
594 { "initial_cwd", vtype_stringptr, &initial_cwd },
595 { "inode", vtype_ino, &deliver_inode },
596 { "interface_address", vtype_stringptr, &interface_address },
597 { "interface_port", vtype_int, &interface_port },
598 { "item", vtype_stringptr, &iterate_item },
600 { "ldap_dn", vtype_stringptr, &eldap_dn },
602 { "load_average", vtype_load_avg, NULL },
603 { "local_part", vtype_stringptr, &deliver_localpart },
604 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
605 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
606 { "local_part_prefix_v", vtype_stringptr, &deliver_localpart_prefix_v },
607 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
608 { "local_part_suffix_v", vtype_stringptr, &deliver_localpart_suffix_v },
609 #ifdef HAVE_LOCAL_SCAN
610 { "local_scan_data", vtype_stringptr, &local_scan_data },
612 { "local_user_gid", vtype_gid, &local_user_gid },
613 { "local_user_uid", vtype_uid, &local_user_uid },
614 { "localhost_number", vtype_int, &host_number },
615 { "log_inodes", vtype_pinodes, (void *)FALSE },
616 { "log_space", vtype_pspace, (void *)FALSE },
617 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
618 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
619 #ifdef WITH_CONTENT_SCAN
620 { "malware_name", vtype_stringptr, &malware_name },
622 { "max_received_linelength", vtype_int, &max_received_linelength },
623 { "message_age", vtype_int, &message_age },
624 { "message_body", vtype_msgbody, &message_body },
625 { "message_body_end", vtype_msgbody_end, &message_body_end },
626 { "message_body_size", vtype_int, &message_body_size },
627 { "message_exim_id", vtype_stringptr, &message_id },
628 { "message_headers", vtype_msgheaders, NULL },
629 { "message_headers_raw", vtype_msgheaders_raw, NULL },
630 { "message_id", vtype_stringptr, &message_id },
631 { "message_linecount", vtype_int, &message_linecount },
632 { "message_size", vtype_int, &message_size },
634 { "message_smtputf8", vtype_bool, &message_smtputf8 },
636 #ifdef WITH_CONTENT_SCAN
637 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
638 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
639 { "mime_boundary", vtype_stringptr, &mime_boundary },
640 { "mime_charset", vtype_stringptr, &mime_charset },
641 { "mime_content_description", vtype_stringptr, &mime_content_description },
642 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
643 { "mime_content_id", vtype_stringptr, &mime_content_id },
644 { "mime_content_size", vtype_int, &mime_content_size },
645 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
646 { "mime_content_type", vtype_stringptr, &mime_content_type },
647 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
648 { "mime_filename", vtype_stringptr, &mime_filename },
649 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
650 { "mime_is_multipart", vtype_int, &mime_is_multipart },
651 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
652 { "mime_part_count", vtype_int, &mime_part_count },
654 { "n0", vtype_filter_int, &filter_n[0] },
655 { "n1", vtype_filter_int, &filter_n[1] },
656 { "n2", vtype_filter_int, &filter_n[2] },
657 { "n3", vtype_filter_int, &filter_n[3] },
658 { "n4", vtype_filter_int, &filter_n[4] },
659 { "n5", vtype_filter_int, &filter_n[5] },
660 { "n6", vtype_filter_int, &filter_n[6] },
661 { "n7", vtype_filter_int, &filter_n[7] },
662 { "n8", vtype_filter_int, &filter_n[8] },
663 { "n9", vtype_filter_int, &filter_n[9] },
664 { "original_domain", vtype_stringptr, &deliver_domain_orig },
665 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
666 { "originator_gid", vtype_gid, &originator_gid },
667 { "originator_uid", vtype_uid, &originator_uid },
668 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
669 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
670 { "pid", vtype_pid, NULL },
672 { "prdr_requested", vtype_bool, &prdr_requested },
674 { "primary_hostname", vtype_stringptr, &primary_hostname },
675 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
676 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
677 { "proxy_external_port", vtype_int, &proxy_external_port },
678 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
679 { "proxy_local_port", vtype_int, &proxy_local_port },
680 { "proxy_session", vtype_bool, &proxy_session },
682 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
683 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
684 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
685 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
686 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
687 { "queue_name", vtype_stringptr, &queue_name },
688 { "queue_size", vtype_string_func, (void *) &fn_queue_size },
689 { "rcpt_count", vtype_int, &rcpt_count },
690 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
691 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
692 { "received_count", vtype_int, &received_count },
693 { "received_for", vtype_stringptr, &received_for },
694 { "received_ip_address", vtype_stringptr, &interface_address },
695 { "received_port", vtype_int, &interface_port },
696 { "received_protocol", vtype_stringptr, &received_protocol },
697 { "received_time", vtype_int, &received_time.tv_sec },
698 { "recipient_data", vtype_stringptr, &recipient_data },
699 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
700 { "recipients", vtype_string_func, (void *) &fn_recipients },
701 { "recipients_count", vtype_int, &recipients_count },
702 { "regex_cachesize", vtype_int, ®ex_cachesize },/* undocumented; devel observability */
703 #ifdef WITH_CONTENT_SCAN
704 { "regex_match_string", vtype_stringptr, ®ex_match_string },
706 { "reply_address", vtype_reply, NULL },
707 { "return_path", vtype_stringptr, &return_path },
708 { "return_size_limit", vtype_int, &bounce_return_size_limit },
709 { "router_name", vtype_stringptr, &router_name },
710 { "runrc", vtype_int, &runrc },
711 { "self_hostname", vtype_stringptr, &self_hostname },
712 { "sender_address", vtype_stringptr, &sender_address },
713 { "sender_address_data", vtype_stringptr, &sender_address_data },
714 { "sender_address_domain", vtype_domain, &sender_address },
715 { "sender_address_local_part", vtype_localpart, &sender_address },
716 { "sender_data", vtype_stringptr, &sender_data },
717 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
718 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
719 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
720 { "sender_helo_verified",vtype_string_func, (void *) &sender_helo_verified_boolstr },
721 { "sender_host_address", vtype_stringptr, &sender_host_address },
722 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
723 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
724 { "sender_host_name", vtype_host_lookup, NULL },
725 { "sender_host_port", vtype_int, &sender_host_port },
726 { "sender_ident", vtype_stringptr, &sender_ident },
727 { "sender_rate", vtype_stringptr, &sender_rate },
728 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
729 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
730 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
731 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
732 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
733 { "sending_port", vtype_int, &sending_port },
734 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
735 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
736 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
737 { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
738 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
739 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
740 { "sn0", vtype_filter_int, &filter_sn[0] },
741 { "sn1", vtype_filter_int, &filter_sn[1] },
742 { "sn2", vtype_filter_int, &filter_sn[2] },
743 { "sn3", vtype_filter_int, &filter_sn[3] },
744 { "sn4", vtype_filter_int, &filter_sn[4] },
745 { "sn5", vtype_filter_int, &filter_sn[5] },
746 { "sn6", vtype_filter_int, &filter_sn[6] },
747 { "sn7", vtype_filter_int, &filter_sn[7] },
748 { "sn8", vtype_filter_int, &filter_sn[8] },
749 { "sn9", vtype_filter_int, &filter_sn[9] },
750 #ifdef WITH_CONTENT_SCAN
751 { "spam_action", vtype_stringptr, &spam_action },
752 { "spam_bar", vtype_stringptr, &spam_bar },
753 { "spam_report", vtype_stringptr, &spam_report },
754 { "spam_score", vtype_stringptr, &spam_score },
755 { "spam_score_int", vtype_stringptr, &spam_score_int },
758 { "spf_guess", vtype_stringptr, &spf_guess },
759 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
760 { "spf_received", vtype_stringptr, &spf_received },
761 { "spf_result", vtype_stringptr, &spf_result },
762 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
763 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
765 { "spool_directory", vtype_stringptr, &spool_directory },
766 { "spool_inodes", vtype_pinodes, (void *)TRUE },
767 { "spool_space", vtype_pspace, (void *)TRUE },
769 { "srs_recipient", vtype_stringptr, &srs_recipient },
771 { "thisaddress", vtype_stringptr, &filter_thisaddress },
773 /* The non-(in,out) variables are now deprecated */
774 { "tls_bits", vtype_int, &tls_in.bits },
775 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
776 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
778 { "tls_in_bits", vtype_int, &tls_in.bits },
779 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
780 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
781 { "tls_in_cipher_std", vtype_stringptr, &tls_in.cipher_stdname },
782 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
783 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
784 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
785 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
786 #ifndef DISABLE_TLS_RESUME
787 { "tls_in_resumption", vtype_int, &tls_in.resumption },
790 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
792 { "tls_in_ver", vtype_stringptr, &tls_in.ver },
793 { "tls_out_bits", vtype_int, &tls_out.bits },
794 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
795 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
796 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },
798 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
800 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
801 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
802 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
803 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
804 #ifndef DISABLE_TLS_RESUME
805 { "tls_out_resumption", vtype_int, &tls_out.resumption },
808 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
811 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
813 { "tls_out_ver", vtype_stringptr, &tls_out.ver },
815 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
817 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
820 { "tod_bsdinbox", vtype_todbsdin, NULL },
821 { "tod_epoch", vtype_tode, NULL },
822 { "tod_epoch_l", vtype_todel, NULL },
823 { "tod_full", vtype_todf, NULL },
824 { "tod_log", vtype_todl, NULL },
825 { "tod_logfile", vtype_todlf, NULL },
826 { "tod_zone", vtype_todzone, NULL },
827 { "tod_zulu", vtype_todzulu, NULL },
828 { "transport_name", vtype_stringptr, &transport_name },
829 { "value", vtype_stringptr, &lookup_value },
830 { "verify_mode", vtype_stringptr, &verify_mode },
831 { "version_number", vtype_stringptr, &version_string },
832 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
833 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
834 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
835 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
836 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
837 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
843 uschar * fn_arc_domains(void) {return NULL;}
844 uschar * fn_hdrs_added(void) {return NULL;}
845 uschar * fn_queue_size(void) {return NULL;}
846 uschar * fn_recipients(void) {return NULL;}
847 uschar * sender_helo_verified_boolstr(void) {return NULL;}
848 uschar * smtp_cmd_hist(void) {return NULL;}
853 expansion_items(void)
856 for (int i = 0; i < nelem(item_table); i++)
858 spf(buf, sizeof(buf), CUS"_EXP_ITEM_%T", item_table[i]);
859 builtin_macro_create(buf);
863 expansion_operators(void)
866 for (int i = 0; i < nelem(op_table_underscore); i++)
868 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_underscore[i]);
869 builtin_macro_create(buf);
871 for (int i = 0; i < nelem(op_table_main); i++)
873 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_main[i]);
874 builtin_macro_create(buf);
878 expansion_conditions(void)
881 for (int i = 0; i < nelem(cond_table); i++)
883 spf(buf, sizeof(buf), CUS"_EXP_COND_%T", cond_table[i]);
884 builtin_macro_create(buf);
888 expansion_variables(void)
891 for (int i = 0; i < nelem(var_table); i++)
893 spf(buf, sizeof(buf), CUS"_EXP_VAR_%T", var_table[i].name);
894 builtin_macro_create(buf);
902 expansion_operators();
903 expansion_conditions();
904 expansion_variables();
907 #else /*!MACRO_PREDEF*/
909 static uschar var_buffer[256];
910 static BOOL malformed_header;
912 /* For textual hashes */
914 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
915 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
918 enum { HMAC_MD5, HMAC_SHA1 };
920 /* For numeric hashes */
922 static unsigned int prime[] = {
923 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
924 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
925 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
927 /* For printing modes in symbolic form */
929 static uschar *mtable_normal[] =
930 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
932 static uschar *mtable_setid[] =
933 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
935 static uschar *mtable_sticky[] =
936 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
938 /* flags for find_header() */
939 #define FH_EXISTS_ONLY BIT(0)
940 #define FH_WANT_RAW BIT(1)
941 #define FH_WANT_LIST BIT(2)
944 /*************************************************
945 * Tables for UTF-8 support *
946 *************************************************/
948 /* Table of the number of extra characters, indexed by the first character
949 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
952 static uschar utf8_table1[] = {
953 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
954 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
955 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
956 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
958 /* These are the masks for the data bits in the first byte of a character,
959 indexed by the number of additional bytes. */
961 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
963 /* Get the next UTF-8 character, advancing the pointer. */
965 #define GETUTF8INC(c, ptr) \
967 if ((c & 0xc0) == 0xc0) \
969 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
971 c = (c & utf8_table2[a]) << s; \
975 c |= (*ptr++ & 0x3f) << s; \
981 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
983 /*************************************************
984 * Binary chop search on a table *
985 *************************************************/
987 /* This is used for matching expansion items and operators.
990 name the name that is being sought
991 table the table to search
992 table_size the number of items in the table
994 Returns: the offset in the table, or -1
998 chop_match(uschar *name, uschar **table, int table_size)
1000 uschar **bot = table;
1001 uschar **top = table + table_size;
1005 uschar **mid = bot + (top - bot)/2;
1006 int c = Ustrcmp(name, *mid);
1007 if (c == 0) return mid - table;
1008 if (c > 0) bot = mid + 1; else top = mid;
1016 /*************************************************
1017 * Check a condition string *
1018 *************************************************/
1020 /* This function is called to expand a string, and test the result for a "true"
1021 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
1022 forced fail or lookup defer.
1024 We used to release all store used, but this is not not safe due
1025 to ${dlfunc } and ${acl }. In any case expand_string_internal()
1026 is reasonably careful to release what it can.
1028 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
1031 condition the condition string
1032 m1 text to be incorporated in panic error
1035 Returns: TRUE if condition is met, FALSE if not
1039 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
1041 uschar * ss = expand_string(condition);
1044 if (!f.expand_string_forcedfail && !f.search_find_defer)
1045 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
1046 "for %s %s: %s", condition, m1, m2, expand_string_message);
1049 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
1050 strcmpic(ss, US"false") != 0;
1056 /*************************************************
1057 * Pseudo-random number generation *
1058 *************************************************/
1060 /* Pseudo-random number generation. The result is not "expected" to be
1061 cryptographically strong but not so weak that someone will shoot themselves
1062 in the foot using it as a nonce in some email header scheme or whatever
1063 weirdness they'll twist this into. The result should ideally handle fork().
1065 However, if we're stuck unable to provide this, then we'll fall back to
1066 appallingly bad randomness.
1068 If DISABLE_TLS is not defined then this will not be used except as an emergency
1073 Returns a random number in range [0, max-1]
1077 # define vaguely_random_number vaguely_random_number_fallback
1080 vaguely_random_number(int max)
1083 # undef vaguely_random_number
1085 static pid_t pid = 0;
1088 if ((p2 = getpid()) != pid)
1093 #ifdef HAVE_ARC4RANDOM
1094 /* cryptographically strong randomness, common on *BSD platforms, not
1095 so much elsewhere. Alas. */
1096 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1099 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1100 # ifdef HAVE_SRANDOMDEV
1101 /* uses random(4) for seeding */
1106 gettimeofday(&tv, NULL);
1107 srandom(tv.tv_sec | tv.tv_usec | getpid());
1111 /* Poor randomness and no seeding here */
1118 #ifdef HAVE_ARC4RANDOM
1119 return arc4random() % max;
1120 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1121 return random() % max;
1123 /* This one returns a 16-bit number, definitely not crypto-strong */
1124 return random_number(max);
1131 /*************************************************
1132 * Pick out a name from a string *
1133 *************************************************/
1135 /* If the name is too long, it is silently truncated.
1138 name points to a buffer into which to put the name
1139 max is the length of the buffer
1140 s points to the first alphabetic character of the name
1141 extras chars other than alphanumerics to permit
1143 Returns: pointer to the first character after the name
1145 Note: The test for *s != 0 in the while loop is necessary because
1146 Ustrchr() yields non-NULL if the character is zero (which is not something
1149 static const uschar *
1150 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1153 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1155 if (ptr < max-1) name[ptr++] = *s;
1164 /*************************************************
1165 * Pick out the rest of a header name *
1166 *************************************************/
1168 /* A variable name starting $header_ (or just $h_ for those who like
1169 abbreviations) might not be the complete header name because headers can
1170 contain any printing characters in their names, except ':'. This function is
1171 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1172 on the end, if the name was terminated by white space.
1175 name points to a buffer in which the name read so far exists
1176 max is the length of the buffer
1177 s points to the first character after the name so far, i.e. the
1178 first non-alphameric character after $header_xxxxx
1180 Returns: a pointer to the first character after the header name
1183 static const uschar *
1184 read_header_name(uschar *name, int max, const uschar *s)
1186 int prelen = Ustrchr(name, '_') - name + 1;
1187 int ptr = Ustrlen(name) - prelen;
1188 if (ptr > 0) memmove(name, name+prelen, ptr);
1189 while (mac_isgraph(*s) && *s != ':')
1191 if (ptr < max-1) name[ptr++] = *s;
1202 /*************************************************
1203 * Pick out a number from a string *
1204 *************************************************/
1207 n points to an integer into which to put the number
1208 s points to the first digit of the number
1210 Returns: a pointer to the character after the last digit
1212 /*XXX consider expanding to int_eximarith_t. But the test for
1213 "overbig numbers" in 0002 still needs to overflow it. */
1216 read_number(int *n, uschar *s)
1219 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1223 static const uschar *
1224 read_cnumber(int *n, const uschar *s)
1227 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1233 /*************************************************
1234 * Extract keyed subfield from a string *
1235 *************************************************/
1237 /* The yield is in dynamic store; NULL means that the key was not found.
1240 key points to the name of the key
1241 s points to the string from which to extract the subfield
1243 Returns: NULL if the subfield was not found, or
1244 a pointer to the subfield's data
1248 expand_getkeyed(const uschar * key, const uschar * s)
1250 int length = Ustrlen(key);
1251 Uskip_whitespace(&s);
1253 /* Loop to search for the key */
1259 const uschar * dkey = s;
1261 while (*s && *s != '=' && !isspace(*s)) s++;
1262 dkeylength = s - dkey;
1263 if (Uskip_whitespace(&s) == '=') while (isspace(*++s));
1265 data = string_dequote(&s);
1266 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1269 Uskip_whitespace(&s);
1278 find_var_ent(uschar * name)
1281 int last = nelem(var_table);
1283 while (last > first)
1285 int middle = (first + last)/2;
1286 int c = Ustrcmp(name, var_table[middle].name);
1288 if (c > 0) { first = middle + 1; continue; }
1289 if (c < 0) { last = middle; continue; }
1290 return &var_table[middle];
1295 /*************************************************
1296 * Extract numbered subfield from string *
1297 *************************************************/
1299 /* Extracts a numbered field from a string that is divided by tokens - for
1300 example a line from /etc/passwd is divided by colon characters. First field is
1301 numbered one. Negative arguments count from the right. Zero returns the whole
1302 string. Returns NULL if there are insufficient tokens in the string
1305 Modifies final argument - this is a dynamically generated string, so that's OK.
1308 field number of field to be extracted,
1309 first field = 1, whole string = 0, last field = -1
1310 separators characters that are used to break string into tokens
1311 s points to the string from which to extract the subfield
1313 Returns: NULL if the field was not found,
1314 a pointer to the field's data inside s (modified to add 0)
1318 expand_gettokened (int field, uschar *separators, uschar *s)
1323 uschar *fieldtext = NULL;
1325 if (field == 0) return s;
1327 /* Break the line up into fields in place; for field > 0 we stop when we have
1328 done the number of fields we want. For field < 0 we continue till the end of
1329 the string, counting the number of fields. */
1331 count = (field > 0)? field : INT_MAX;
1337 /* Previous field was the last one in the string. For a positive field
1338 number, this means there are not enough fields. For a negative field number,
1339 check that there are enough, and scan back to find the one that is wanted. */
1343 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1344 if ((-field) == (INT_MAX - count - 1)) return s;
1348 while (ss[-1] != 0) ss--;
1354 /* Previous field was not last in the string; save its start and put a
1358 len = Ustrcspn(ss, separators);
1369 expand_getlistele(int field, const uschar * list)
1371 const uschar * tlist = list;
1373 /* Tainted mem for the throwaway element copies */
1374 uschar * dummy = store_get(2, GET_TAINTED);
1378 for (field++; string_nextinlist(&tlist, &sep, dummy, 1); ) field++;
1381 if (field == 0) return NULL;
1382 while (--field > 0 && (string_nextinlist(&list, &sep, dummy, 1))) ;
1383 return string_nextinlist(&list, &sep, NULL, 0);
1387 /* Certificate fields, by name. Worry about by-OID later */
1388 /* Names are chosen to not have common prefixes */
1395 uschar * (*getfn)(void * cert, uschar * mod);
1397 static certfield certfields[] =
1398 { /* linear search; no special order */
1399 { US"version", 7, &tls_cert_version },
1400 { US"serial_number", 13, &tls_cert_serial_number },
1401 { US"subject", 7, &tls_cert_subject },
1402 { US"notbefore", 9, &tls_cert_not_before },
1403 { US"notafter", 8, &tls_cert_not_after },
1404 { US"issuer", 6, &tls_cert_issuer },
1405 { US"signature", 9, &tls_cert_signature },
1406 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1407 { US"subj_altname", 12, &tls_cert_subject_altname },
1408 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1409 { US"crl_uri", 7, &tls_cert_crl_uri },
1413 expand_getcertele(uschar * field, uschar * certvar)
1417 if (!(vp = find_var_ent(certvar)))
1419 expand_string_message =
1420 string_sprintf("no variable named \"%s\"", certvar);
1421 return NULL; /* Unknown variable name */
1423 /* NB this stops us passing certs around in variable. Might
1424 want to do that in future */
1425 if (vp->type != vtype_cert)
1427 expand_string_message =
1428 string_sprintf("\"%s\" is not a certificate", certvar);
1429 return NULL; /* Unknown variable name */
1431 if (!*(void **)vp->value)
1434 if (*field >= '0' && *field <= '9')
1435 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1437 for (certfield * cp = certfields;
1438 cp < certfields + nelem(certfields);
1440 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1442 uschar * modifier = *(field += cp->namelen) == ','
1444 return (*cp->getfn)( *(void **)vp->value, modifier );
1447 expand_string_message =
1448 string_sprintf("bad field selector \"%s\" for certextract", field);
1451 #endif /*DISABLE_TLS*/
1453 /*************************************************
1454 * Extract a substring from a string *
1455 *************************************************/
1457 /* Perform the ${substr or ${length expansion operations.
1460 subject the input string
1461 value1 the offset from the start of the input string to the start of
1462 the output string; if negative, count from the right.
1463 value2 the length of the output string, or negative (-1) for unset
1464 if value1 is positive, unset means "all after"
1465 if value1 is negative, unset means "all before"
1466 len set to the length of the returned string
1468 Returns: pointer to the output string, or NULL if there is an error
1472 extract_substr(uschar *subject, int value1, int value2, int *len)
1474 int sublen = Ustrlen(subject);
1476 if (value1 < 0) /* count from right */
1480 /* If the position is before the start, skip to the start, and adjust the
1481 length. If the length ends up negative, the substring is null because nothing
1482 can precede. This falls out naturally when the length is unset, meaning "all
1488 if (value2 < 0) value2 = 0;
1492 /* Otherwise an unset length => characters before value1 */
1494 else if (value2 < 0)
1501 /* For a non-negative offset, if the starting position is past the end of the
1502 string, the result will be the null string. Otherwise, an unset length means
1503 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1507 if (value1 > sublen)
1512 else if (value2 < 0) value2 = sublen;
1515 /* Cut the length down to the maximum possible for the offset value, and get
1516 the required characters. */
1518 if (value1 + value2 > sublen) value2 = sublen - value1;
1520 return subject + value1;
1526 /*************************************************
1527 * Old-style hash of a string *
1528 *************************************************/
1530 /* Perform the ${hash expansion operation.
1533 subject the input string (an expanded substring)
1534 value1 the length of the output string; if greater or equal to the
1535 length of the input string, the input string is returned
1536 value2 the number of hash characters to use, or 26 if negative
1537 len set to the length of the returned string
1539 Returns: pointer to the output string, or NULL if there is an error
1543 compute_hash(uschar *subject, int value1, int value2, int *len)
1545 int sublen = Ustrlen(subject);
1547 if (value2 < 0) value2 = 26;
1548 else if (value2 > Ustrlen(hashcodes))
1550 expand_string_message =
1551 string_sprintf("hash count \"%d\" too big", value2);
1555 /* Calculate the hash text. We know it is shorter than the original string, so
1556 can safely place it in subject[] (we know that subject is always itself an
1557 expanded substring). */
1559 if (value1 < sublen)
1564 while ((c = (subject[j])) != 0)
1566 int shift = (c + j++) & 7;
1567 subject[i] ^= (c << shift) | (c >> (8-shift));
1568 if (++i >= value1) i = 0;
1570 for (i = 0; i < value1; i++)
1571 subject[i] = hashcodes[(subject[i]) % value2];
1573 else value1 = sublen;
1582 /*************************************************
1583 * Numeric hash of a string *
1584 *************************************************/
1586 /* Perform the ${nhash expansion operation. The first characters of the
1587 string are treated as most important, and get the highest prime numbers.
1590 subject the input string
1591 value1 the maximum value of the first part of the result
1592 value2 the maximum value of the second part of the result,
1593 or negative to produce only a one-part result
1594 len set to the length of the returned string
1596 Returns: pointer to the output string, or NULL if there is an error.
1600 compute_nhash (uschar *subject, int value1, int value2, int *len)
1602 uschar *s = subject;
1604 unsigned long int total = 0; /* no overflow */
1608 if (i == 0) i = nelem(prime) - 1;
1609 total += prime[i--] * (unsigned int)(*s++);
1612 /* If value2 is unset, just compute one number */
1615 s = string_sprintf("%lu", total % value1);
1617 /* Otherwise do a div/mod hash */
1621 total = total % (value1 * value2);
1622 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1633 /*************************************************
1634 * Find the value of a header or headers *
1635 *************************************************/
1637 /* Multiple instances of the same header get concatenated, and this function
1638 can also return a concatenation of all the header lines. When concatenating
1639 specific headers that contain lists of addresses, a comma is inserted between
1640 them. Otherwise we use a straight concatenation. Because some messages can have
1641 pathologically large number of lines, there is a limit on the length that is
1645 name the name of the header, without the leading $header_ or $h_,
1646 or NULL if a concatenation of all headers is required
1647 newsize return the size of memory block that was obtained; may be NULL
1648 if exists_only is TRUE
1649 flags FH_EXISTS_ONLY
1650 set if called from a def: test; don't need to build a string;
1651 just return a string that is not "" and not "0" if the header
1654 set if called for $rh_ or $rheader_ items; no processing,
1655 other than concatenating, will be done on the header. Also used
1656 for $message_headers_raw.
1658 Double colon chars in the content, and replace newline with
1659 colon between each element when concatenating; returning a
1660 colon-sep list (elements might contain newlines)
1661 charset name of charset to translate MIME words to; used only if
1662 want_raw is false; if NULL, no translation is done (this is
1663 used for $bh_ and $bheader_)
1665 Returns: NULL if the header does not exist, else a pointer to a new
1670 find_header(uschar * name, int * newsize, unsigned flags, const uschar * charset)
1673 int len = name ? Ustrlen(name) : 0;
1678 for (header_line * h = header_list; h; h = h->next)
1679 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1680 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1685 if (flags & FH_EXISTS_ONLY)
1686 return US"1"; /* don't need actual string */
1689 s = h->text + len; /* text to insert */
1690 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1691 Uskip_whitespace(&s); /* remove leading white space */
1692 t = h->text + h->slen; /* end-point */
1694 /* Unless wanted raw, remove trailing whitespace, including the
1697 if (flags & FH_WANT_LIST)
1698 while (t > s && t[-1] == '\n') t--;
1699 else if (!(flags & FH_WANT_RAW))
1701 while (t > s && isspace(t[-1])) t--;
1703 /* Set comma if handling a single header and it's one of those
1704 that contains an address list, except when asked for raw headers. Only
1705 need to do this once. */
1707 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1710 /* Trim the header roughly if we're approaching limits */
1712 if (gstring_length(g) + inc > header_insert_maxlen)
1713 inc = header_insert_maxlen - gstring_length(g);
1715 /* For raw just copy the data; for a list, add the data as a colon-sep
1716 list-element; for comma-list add as an unchecked comma,newline sep
1717 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1718 stripped trailing WS above including the newline). We ignore the potential
1719 expansion due to colon-doubling, just leaving the loop if the limit is met
1722 if (flags & FH_WANT_LIST)
1723 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1724 else if (flags & FH_WANT_RAW)
1725 g = string_catn(g, s, (unsigned)inc);
1727 g = string_append2_listele_n(g, comma ? US",\n" : US"\n",
1730 if (gstring_length(g) >= header_insert_maxlen) break;
1733 if (!found) return NULL; /* No header found */
1734 if (!g) return US"";
1736 /* That's all we do for raw header expansion. */
1739 rawhdr = string_from_gstring(g);
1740 if (flags & FH_WANT_RAW)
1743 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1744 The rfc2047_decode2() function can return an error with decoded data if the
1745 charset translation fails. If decoding fails, it returns NULL. */
1749 uschar * error, * decoded = rfc2047_decode2(rawhdr,
1750 check_rfc2047_length, charset, '?', NULL, newsize, &error);
1752 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1753 " input was: %s\n", error, rawhdr);
1754 return decoded ? decoded : rawhdr;
1761 /* Append a "local" element to an Authentication-Results: header
1762 if this was a non-smtp message.
1766 authres_local(gstring * g, const uschar * sysname)
1768 if (!f.authentication_local)
1770 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1771 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1776 /* Append an "iprev" element to an Authentication-Results: header
1777 if we have attempted to get the calling host's name.
1781 authres_iprev(gstring * g)
1783 if (sender_host_name)
1784 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1785 else if (host_lookup_deferred)
1786 g = string_cat(g, US";\n\tiprev=temperror");
1787 else if (host_lookup_failed)
1788 g = string_cat(g, US";\n\tiprev=fail");
1792 if (sender_host_address)
1793 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1799 /*************************************************
1800 * Return list of recipients *
1801 *************************************************/
1802 /* A recipients list is available only during system message filtering,
1803 during ACL processing after DATA, and while expanding pipe commands
1804 generated from a system filter, but not elsewhere. */
1812 if (!f.enable_dollar_recipients) return NULL;
1814 for (int i = 0; i < recipients_count; i++)
1816 s = recipients_list[i].address;
1817 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1819 return string_from_gstring(g);
1823 /*************************************************
1824 * Return size of queue *
1825 *************************************************/
1826 /* Ask the daemon for the queue size */
1831 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1835 const uschar * where;
1838 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
1840 DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));
1844 len = daemon_client_sockname(&sa_un, &sname);
1846 if (bind(fd, (const struct sockaddr *)&sa_un, (socklen_t)len) < 0)
1847 { where = US"bind"; goto bad; }
1850 debug_printf("local addr '%s%s'\n",
1851 *sa_un.sun_path ? "" : "@",
1852 sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1855 len = daemon_notifier_sockname(&sa_un);
1856 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
1857 { where = US"connect"; goto bad2; }
1859 buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1860 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1862 if (poll_one_fd(fd, POLLIN, 2 * 1000) != 1)
1864 DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1865 len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1867 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1868 { where = US"recv"; goto bad2; }
1871 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1874 return string_copyn(buf, len);
1877 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1882 DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1887 /*************************************************
1888 * Find value of a variable *
1889 *************************************************/
1891 /* The table of variables is kept in alphabetic order, so we can search it
1892 using a binary chop. The "choplen" variable is nothing to do with the binary
1896 name the name of the variable being sought
1897 exists_only TRUE if this is a def: test; passed on to find_header()
1898 skipping TRUE => skip any processing evaluation; this is not the same as
1899 exists_only because def: may test for values that are first
1901 newsize pointer to an int which is initially zero; if the answer is in
1902 a new memory buffer, *newsize is set to its size
1904 Returns: NULL if the variable does not exist, or
1905 a pointer to the variable's contents, or
1906 something non-NULL if exists_only is TRUE
1909 static const uschar *
1910 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1917 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1918 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1919 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1920 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1921 (this gave backwards compatibility at the changeover). There may be built-in
1922 variables whose names start acl_ but they should never start in this way. This
1923 slightly messy specification is a consequence of the history, needless to say.
1925 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1926 set, in which case give an error. */
1928 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1932 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1933 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1935 else if (Ustrncmp(name, "r_", 2) == 0)
1937 tree_node * node = tree_search(router_var, name + 2);
1938 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1941 /* Handle $auth<n>, $regex<n> variables. */
1943 if (Ustrncmp(name, "auth", 4) == 0)
1946 int n = Ustrtoul(name + 4, &endptr, 10);
1947 if (!*endptr && n != 0 && n <= AUTH_VARS)
1948 return auth_vars[n-1] ? auth_vars[n-1] : US"";
1950 #ifdef WITH_CONTENT_SCAN
1951 else if (Ustrncmp(name, "regex", 5) == 0)
1954 int n = Ustrtoul(name + 5, &endptr, 10);
1955 if (!*endptr && n != 0 && n <= REGEX_VARS)
1956 return regex_vars[n-1] ? regex_vars[n-1] : US"";
1960 /* For all other variables, search the table */
1962 if (!(vp = find_var_ent(name)))
1963 return NULL; /* Unknown variable name */
1965 /* Found an existing variable. If in skipping state, the value isn't needed,
1966 and we want to avoid processing (such as looking up the host name). */
1974 case vtype_filter_int:
1975 if (!f.filter_running) return NULL;
1979 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1983 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1987 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1991 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1995 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1998 case vtype_stringptr: /* Pointer to string */
1999 return (s = *((uschar **)(val))) ? s : US"";
2002 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
2005 case vtype_load_avg:
2006 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
2009 case vtype_host_lookup: /* Lookup if not done so */
2010 if ( !sender_host_name && sender_host_address
2011 && !host_lookup_failed && host_name_lookup() == OK)
2012 host_build_sender_fullhost();
2013 return sender_host_name ? sender_host_name : US"";
2015 case vtype_localpart: /* Get local part from address */
2016 if (!(s = *((uschar **)(val)))) return US"";
2017 if (!(domain = Ustrrchr(s, '@'))) return s;
2018 if (domain - s > sizeof(var_buffer) - 1)
2019 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
2020 " in string expansion", sizeof(var_buffer));
2021 return string_copyn(s, domain - s);
2023 case vtype_domain: /* Get domain from address */
2024 if (!(s = *((uschar **)(val)))) return US"";
2025 domain = Ustrrchr(s, '@');
2026 return domain ? domain + 1 : US"";
2028 case vtype_msgheaders:
2029 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
2031 case vtype_msgheaders_raw:
2032 return find_header(NULL, newsize,
2033 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
2035 case vtype_msgbody: /* Pointer to msgbody string */
2036 case vtype_msgbody_end: /* Ditto, the end of the msg */
2037 ss = (uschar **)(val);
2038 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
2041 off_t start_offset = SPOOL_DATA_START_OFFSET;
2042 int len = message_body_visible;
2044 if (len > message_size) len = message_size;
2045 *ss = body = store_get(len+1, GET_TAINTED);
2047 if (vp->type == vtype_msgbody_end)
2049 struct stat statbuf;
2050 if (fstat(deliver_datafile, &statbuf) == 0)
2052 start_offset = statbuf.st_size - len;
2053 if (start_offset < SPOOL_DATA_START_OFFSET)
2054 start_offset = SPOOL_DATA_START_OFFSET;
2057 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
2058 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
2060 if ((len = read(deliver_datafile, body, len)) > 0)
2063 if (message_body_newlines) /* Separate loops for efficiency */
2065 { if (body[--len] == 0) body[len] = ' '; }
2068 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
2071 return *ss ? *ss : US"";
2073 case vtype_todbsdin: /* BSD inbox time of day */
2074 return tod_stamp(tod_bsdin);
2076 case vtype_tode: /* Unix epoch time of day */
2077 return tod_stamp(tod_epoch);
2079 case vtype_todel: /* Unix epoch/usec time of day */
2080 return tod_stamp(tod_epoch_l);
2082 case vtype_todf: /* Full time of day */
2083 return tod_stamp(tod_full);
2085 case vtype_todl: /* Log format time of day */
2086 return tod_stamp(tod_log_bare); /* (without timezone) */
2088 case vtype_todzone: /* Time zone offset only */
2089 return tod_stamp(tod_zone);
2091 case vtype_todzulu: /* Zulu time */
2092 return tod_stamp(tod_zulu);
2094 case vtype_todlf: /* Log file datestamp tod */
2095 return tod_stamp(tod_log_datestamp_daily);
2097 case vtype_reply: /* Get reply address */
2098 s = find_header(US"reply-to:", newsize,
2099 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2101 if (s) Uskip_whitespace(&s);
2104 *newsize = 0; /* For the *s==0 case */
2105 s = find_header(US"from:", newsize,
2106 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2112 Uskip_whitespace(&s);
2113 for (t = s; *t; t++) if (*t == '\n') *t = ' ';
2114 while (t > s && isspace(t[-1])) t--;
2117 return s ? s : US"";
2119 case vtype_string_func:
2121 stringptr_fn_t * fn = (stringptr_fn_t *) val;
2123 return s ? s : US"";
2129 sprintf(CS var_buffer, PR_EXIM_ARITH,
2130 receive_statvfs(val == (void *)TRUE, &inodes));
2137 (void) receive_statvfs(val == (void *)TRUE, &inodes);
2138 sprintf(CS var_buffer, "%d", inodes);
2143 return *(void **)val ? US"<cert>" : US"";
2145 #ifndef DISABLE_DKIM
2147 return dkim_exim_expand_query((int)(long)val);
2152 return NULL; /* Unknown variable. Silences static checkers. */
2159 modify_variable(uschar *name, void * value)
2162 if ((vp = find_var_ent(name))) vp->value = value;
2163 return; /* Unknown variable name, fail silently */
2171 /*************************************************
2172 * Read and expand substrings *
2173 *************************************************/
2175 /* This function is called to read and expand argument substrings for various
2176 expansion items. Some have a minimum requirement that is less than the maximum;
2177 in these cases, the first non-present one is set to NULL.
2180 sub points to vector of pointers to set
2181 n maximum number of substrings
2183 sptr points to current string pointer
2185 skipping the skipping flag
2186 check_end if TRUE, check for final '}'
2187 name name of item, for error message
2188 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2190 textonly_p if not NULL, pointer to bitmask of which subs were text-only
2191 (did not change when expended)
2193 Returns: -1 OK; string pointer updated, but in "skipping" mode
2194 0 OK; string pointer updated
2195 1 curly bracketing error (too few arguments)
2196 2 too many arguments (only if check_end is set); message set
2197 3 other error (expansion failure)
2201 read_subs(uschar ** sub, int n, int m, const uschar ** sptr, esi_flags flags,
2202 BOOL check_end, uschar * name, BOOL * resetok, unsigned * textonly_p)
2204 const uschar * s = *sptr;
2205 unsigned textonly_l = 0;
2207 Uskip_whitespace(&s);
2208 for (int i = 0; i < n; i++)
2215 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2216 "(min is %d)", name, m);
2222 if (!(sub[i] = expand_string_internal(s+1,
2223 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, &s, resetok,
2224 textonly_p ? &textonly : NULL)))
2226 if (*s++ != '}') return 1;
2227 if (textonly_p && textonly) textonly_l |= BIT(i);
2228 Uskip_whitespace(&s);
2230 if (check_end && *s++ != '}')
2234 expand_string_message = string_sprintf("Too many arguments for '%s' "
2235 "(max is %d)", name, n);
2238 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2242 if (textonly_p) *textonly_p = textonly_l;
2244 return flags & ESI_SKIPPING ? -1 : 0;
2250 /*************************************************
2251 * Elaborate message for bad variable *
2252 *************************************************/
2254 /* For the "unknown variable" message, take a look at the variable's name, and
2255 give additional information about possible ACL variables. The extra information
2256 is added on to expand_string_message.
2258 Argument: the name of the variable
2263 check_variable_error_message(uschar *name)
2265 if (Ustrncmp(name, "acl_", 4) == 0)
2266 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2267 (name[4] == 'c' || name[4] == 'm')?
2269 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2270 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2272 US"user-defined ACL variables must start acl_c or acl_m");
2278 Load args from sub array to globals, and call acl_check().
2279 Sub array will be corrupted on return.
2281 Returns: OK access is granted by an ACCEPT verb
2282 DISCARD access is (apparently) granted by a DISCARD verb
2283 FAIL access is denied
2284 FAIL_DROP access is denied; drop the connection
2285 DEFER can't tell at the moment
2289 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2292 int sav_narg = acl_narg;
2294 uschar * dummy_logmsg;
2295 extern int acl_where;
2297 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2298 for (i = 0; i < nsub && sub[i+1]; i++)
2300 uschar * tmp = acl_arg[i];
2301 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2302 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2307 sub[i+1] = acl_arg[i];
2308 acl_arg[i++] = NULL;
2312 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2314 acl_narg>0 ? acl_arg[0] : US"<none>",
2315 acl_narg>1 ? " +more" : "");
2317 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2319 for (i = 0; i < nsub; i++)
2320 acl_arg[i] = sub[i+1]; /* restore old args */
2321 acl_narg = sav_narg;
2329 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2330 The given string is modified on return. Leading whitespace is skipped while
2331 looking for the opening wrap character, then the rest is scanned for the trailing
2332 (non-escaped) wrap character. A backslash in the string will act as an escape.
2334 A nul is written over the trailing wrap, and a pointer to the char after the
2335 leading wrap is returned.
2338 s String for de-wrapping
2339 wrap Two-char string, the first being the opener, second the closer wrapping
2342 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2346 dewrap(uschar * s, const uschar * wrap)
2350 BOOL quotesmode = wrap[0] == wrap[1];
2352 if (Uskip_whitespace(&p) == *wrap)
2358 if (*p == '\\') p++;
2359 else if (!quotesmode && *p == wrap[-1]) depth++;
2360 else if (*p == *wrap)
2371 expand_string_message = string_sprintf("missing '%c'", *wrap);
2376 /* Pull off the leading array or object element, returning
2377 a copy in an allocated string. Update the list pointer.
2379 The element may itself be an abject or array.
2380 Return NULL when the list is empty.
2384 json_nextinlist(const uschar ** list)
2386 unsigned array_depth = 0, object_depth = 0;
2387 const uschar * s = *list, * item;
2389 skip_whitespace(&s);
2392 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2396 case '[': array_depth++; break;
2397 case ']': array_depth--; break;
2398 case '{': object_depth++; break;
2399 case '}': object_depth--; break;
2401 *list = *s ? s+1 : s;
2402 if (item == s) return NULL;
2403 item = string_copyn(item, s - item);
2404 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2410 /************************************************/
2411 /* Return offset in ops table, or -1 if not found.
2412 Repoint to just after the operator in the string.
2415 ss string representation of operator
2416 opname split-out operator name
2420 identify_operator(const uschar ** ss, uschar ** opname)
2422 const uschar * s = *ss;
2425 /* Numeric comparisons are symbolic */
2427 if (*s == '=' || *s == '>' || *s == '<')
2439 /* All other conditions are named */
2442 s = read_name(name, sizeof(name), s, US"_");
2445 /* If we haven't read a name, it means some non-alpha character is first. */
2449 expand_string_message = string_sprintf("condition name expected, "
2450 "but found \"%.16s\"", s);
2454 *opname = string_copy(name);
2456 return chop_match(name, cond_table, nelem(cond_table));
2460 /*************************************************
2461 * Handle MD5 or SHA-1 computation for HMAC *
2462 *************************************************/
2464 /* These are some wrapping functions that enable the HMAC code to be a bit
2465 cleaner. A good compiler will spot the tail recursion.
2468 type HMAC_MD5 or HMAC_SHA1
2469 remaining are as for the cryptographic hash functions
2475 chash_start(int type, void * base)
2477 if (type == HMAC_MD5)
2478 md5_start((md5 *)base);
2480 sha1_start((hctx *)base);
2484 chash_mid(int type, void * base, const uschar * string)
2486 if (type == HMAC_MD5)
2487 md5_mid((md5 *)base, string);
2489 sha1_mid((hctx *)base, string);
2493 chash_end(int type, void * base, const uschar * string, int length,
2496 if (type == HMAC_MD5)
2497 md5_end((md5 *)base, string, length, digest);
2499 sha1_end((hctx *)base, string, length, digest);
2506 /* Do an hmac_md5. The result is _not_ nul-terminated, and is sized as
2507 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2510 key encoding key, nul-terminated
2511 src data to be hashed, nul-terminated
2513 len size of output buffer
2517 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2520 const uschar * keyptr;
2522 unsigned int keylen;
2524 #define MD5_HASHLEN 16
2525 #define MD5_HASHBLOCKLEN 64
2527 uschar keyhash[MD5_HASHLEN];
2528 uschar innerhash[MD5_HASHLEN];
2529 uschar finalhash[MD5_HASHLEN];
2530 uschar innerkey[MD5_HASHBLOCKLEN];
2531 uschar outerkey[MD5_HASHBLOCKLEN];
2534 keylen = Ustrlen(keyptr);
2536 /* If the key is longer than the hash block length, then hash the key
2539 if (keylen > MD5_HASHBLOCKLEN)
2541 chash_start(HMAC_MD5, &md5_base);
2542 chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2544 keylen = MD5_HASHLEN;
2547 /* Now make the inner and outer key values */
2549 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2550 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2552 for (int i = 0; i < keylen; i++)
2554 innerkey[i] ^= keyptr[i];
2555 outerkey[i] ^= keyptr[i];
2558 /* Now do the hashes */
2560 chash_start(HMAC_MD5, &md5_base);
2561 chash_mid(HMAC_MD5, &md5_base, innerkey);
2562 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2564 chash_start(HMAC_MD5, &md5_base);
2565 chash_mid(HMAC_MD5, &md5_base, outerkey);
2566 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2568 /* Encode the final hash as a hex string, limited by output buffer size */
2571 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2573 if (j-- <= 0) break;
2574 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2575 if (j-- <= 0) break;
2576 *p++ = hex_digits[finalhash[i] & 0x0f];
2580 #endif /*SUPPORT_SRS*/
2583 /*************************************************
2584 * Read and evaluate a condition *
2585 *************************************************/
2589 s points to the start of the condition text
2590 resetok points to a BOOL which is written false if it is unsafe to
2591 free memory. Certain condition types (acl) may have side-effect
2592 allocation which must be preserved.
2593 yield points to a BOOL to hold the result of the condition test;
2594 if NULL, we are just reading through a condition that is
2595 part of an "or" combination to check syntax, or in a state
2596 where the answer isn't required
2598 Returns: a pointer to the first character after the condition, or
2602 static const uschar *
2603 eval_condition(const uschar * s, BOOL * resetok, BOOL * yield)
2605 BOOL testfor = TRUE;
2606 BOOL tempcond, combined_cond;
2608 BOOL sub2_honour_dollar = TRUE;
2609 BOOL is_forany, is_json, is_jsons;
2611 int_eximarith_t num[2];
2612 struct stat statbuf;
2615 const uschar * sub[10];
2616 unsigned sub_textonly = 0;
2619 if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;
2621 switch(cond_type = identify_operator(&s, &opname))
2623 /* def: tests for a non-empty variable, or for the existence of a header. If
2624 yield == NULL we are in a skipping state, and don't care about the answer. */
2632 expand_string_message = US"\":\" expected after \"def\"";
2636 s = read_name(name, sizeof(name), s+1, US"_");
2638 /* Test for a header's existence. If the name contains a closing brace
2639 character, this may be a user error where the terminating colon has been
2640 omitted. Set a flag to adjust a subsequent error message in this case. */
2642 if ( ( *(t = name) == 'h'
2643 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2645 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2648 s = read_header_name(name, sizeof(name), s);
2649 /* {-for-text-editors */
2650 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2652 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2655 /* Test for a variable's having a non-empty value. A non-existent variable
2656 causes an expansion failure. */
2660 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2662 expand_string_message = name[0]
2663 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2664 : US"variable name omitted after \"def:\"";
2665 check_variable_error_message(name);
2668 if (yield) *yield = (t[0] != 0) == testfor;
2675 /* first_delivery tests for first delivery attempt */
2677 case ECOND_FIRST_DELIVERY:
2678 if (yield) *yield = f.deliver_firsttime == testfor;
2682 /* queue_running tests for any process started by a queue runner */
2684 case ECOND_QUEUE_RUNNING:
2685 if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2689 /* exists: tests for file existence
2690 isip: tests for any IP address
2691 isip4: tests for an IPv4 address
2692 isip6: tests for an IPv6 address
2693 pam: does PAM authentication
2694 radius: does RADIUS authentication
2695 ldapauth: does LDAP authentication
2696 pwcheck: does Cyrus SASL pwcheck authentication
2705 case ECOND_LDAPAUTH:
2708 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2712 sub[0] = expand_string_internal(s+1,
2713 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
2714 &s, resetok, &textonly);
2715 if (!sub[0]) return NULL;
2716 if (textonly) sub_textonly |= BIT(0);
2718 /* {-for-text-editors */
2719 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2721 if (!yield) return s; /* No need to run the test if skipping */
2726 if ((expand_forbid & RDO_EXISTS) != 0)
2728 expand_string_message = US"File existence tests are not permitted";
2731 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2737 rc = string_is_ip_address(sub[0], NULL);
2738 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2739 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2742 /* Various authentication tests - all optionally compiled */
2746 rc = auth_call_pam(sub[0], &expand_string_message);
2749 goto COND_FAILED_NOT_COMPILED;
2750 #endif /* SUPPORT_PAM */
2753 #ifdef RADIUS_CONFIG_FILE
2754 rc = auth_call_radius(sub[0], &expand_string_message);
2757 goto COND_FAILED_NOT_COMPILED;
2758 #endif /* RADIUS_CONFIG_FILE */
2760 case ECOND_LDAPAUTH:
2763 /* Just to keep the interface the same */
2765 int old_pool = store_pool;
2766 store_pool = POOL_SEARCH;
2767 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2768 &expand_string_message, &do_cache);
2769 store_pool = old_pool;
2773 goto COND_FAILED_NOT_COMPILED;
2774 #endif /* LOOKUP_LDAP */
2777 #ifdef CYRUS_PWCHECK_SOCKET
2778 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2781 goto COND_FAILED_NOT_COMPILED;
2782 #endif /* CYRUS_PWCHECK_SOCKET */
2784 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2785 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2787 if (rc == ERROR || rc == DEFER) return NULL;
2788 *yield = (rc == OK) == testfor;
2794 /* call ACL (in a conditional context). Accept true, deny false.
2795 Defer is a forced-fail. Anything set by message= goes to $value.
2796 Up to ten parameters are used; we use the braces round the name+args
2797 like the saslauthd condition does, to permit a variable number of args.
2798 See also the expansion-item version EITEM_ACL and the traditional
2799 acl modifier ACLC_ACL.
2800 Since the ACL may allocate new global variables, tell our caller to not
2805 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2811 Uskip_whitespace(&s);
2812 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2814 switch(read_subs(sub, nelem(sub), 1, &s,
2815 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2817 case 1: expand_string_message = US"too few arguments or bracketing "
2820 case 3: return NULL;
2826 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2827 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2832 lookup_value = NULL;
2834 lookup_value = string_copy(user_msg);
2835 *yield = cond == testfor;
2839 f.expand_string_forcedfail = TRUE;
2842 expand_string_message = string_sprintf("%s from acl \"%s\"",
2843 rc_names[rc], sub[0]);
2851 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2853 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2855 However, the last two are optional. That is why the whole set is enclosed
2856 in their own set of braces. */
2858 case ECOND_SASLAUTHD:
2859 #ifndef CYRUS_SASLAUTHD_SOCKET
2860 goto COND_FAILED_NOT_COMPILED;
2864 Uskip_whitespace(&s);
2865 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2866 switch(read_subs(sub, nelem(sub), 2, &s,
2867 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2869 case 1: expand_string_message = US"too few arguments or bracketing "
2870 "error for saslauthd";
2872 case 3: return NULL;
2874 if (!sub[2]) sub[3] = NULL; /* realm if no service */
2877 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2878 &expand_string_message);
2879 if (rc == ERROR || rc == DEFER) return NULL;
2880 *yield = (rc == OK) == testfor;
2884 #endif /* CYRUS_SASLAUTHD_SOCKET */
2887 /* symbolic operators for numeric and string comparison, and a number of
2888 other operators, all requiring two arguments.
2890 crypteq: encrypts plaintext and compares against an encrypted text,
2891 using crypt(), crypt16(), MD5 or SHA-1
2892 inlist/inlisti: checks if first argument is in the list of the second
2893 match: does a regular expression match and sets up the numerical
2894 variables if it succeeds
2895 match_address: matches in an address list
2896 match_domain: matches in a domain list
2897 match_ip: matches a host list that is restricted to IP addresses
2898 match_local_part: matches in a local part list
2901 case ECOND_MATCH_ADDRESS:
2902 case ECOND_MATCH_DOMAIN:
2903 case ECOND_MATCH_IP:
2904 case ECOND_MATCH_LOCAL_PART:
2905 #ifndef EXPAND_LISTMATCH_RHS
2906 sub2_honour_dollar = FALSE;
2915 case ECOND_NUM_L: /* Numerical comparisons */
2922 case ECOND_STR_LT: /* String comparisons */
2933 for (int i = 0; i < 2; i++)
2936 /* Sometimes, we don't expand substrings; too many insecure configurations
2937 created using match_address{}{} and friends, where the second param
2938 includes information from untrustworthy sources. */
2939 /*XXX is this moot given taint-tracking? */
2941 esi_flags flags = ESI_BRACE_ENDS;
2943 if (!(i > 0 && !sub2_honour_dollar)) flags |= ESI_HONOR_DOLLAR;
2944 if (!yield) flags |= ESI_SKIPPING;
2946 if (Uskip_whitespace(&s) != '{')
2948 if (i == 0) goto COND_FAILED_CURLY_START;
2949 expand_string_message = string_sprintf("missing 2nd string in {} "
2950 "after \"%s\"", opname);
2953 if (!(sub[i] = expand_string_internal(s+1, flags, &s, resetok, &textonly)))
2955 if (textonly) sub_textonly |= BIT(i);
2956 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2957 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2958 " for security reasons\n");
2959 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2961 /* Convert to numerical if required; we know that the names of all the
2962 conditions that compare numbers do not start with a letter. This just saves
2963 checking for them individually. */
2965 if (!isalpha(opname[0]) && yield)
2970 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2974 num[i] = expanded_string_integer(sub[i], FALSE);
2975 if (expand_string_message) return NULL;
2979 /* Result not required */
2981 if (!yield) return s;
2983 /* Do an appropriate comparison */
2989 tempcond = (num[0] == num[1]); break;
2992 tempcond = (num[0] > num[1]); break;
2995 tempcond = (num[0] >= num[1]); break;
2998 tempcond = (num[0] < num[1]); break;
3001 tempcond = (num[0] <= num[1]); break;
3004 tempcond = (Ustrcmp(sub[0], sub[1]) < 0); break;
3007 tempcond = (strcmpic(sub[0], sub[1]) < 0); break;
3010 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0); break;
3013 tempcond = (strcmpic(sub[0], sub[1]) <= 0); break;
3016 tempcond = (Ustrcmp(sub[0], sub[1]) == 0); break;
3019 tempcond = (strcmpic(sub[0], sub[1]) == 0); break;
3022 tempcond = (Ustrcmp(sub[0], sub[1]) > 0); break;
3025 tempcond = (strcmpic(sub[0], sub[1]) > 0); break;
3028 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0); break;
3031 tempcond = (strcmpic(sub[0], sub[1]) >= 0); break;
3033 case ECOND_MATCH: /* Regular expression match */
3035 const pcre2_code * re = regex_compile(sub[1],
3036 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
3037 &expand_string_message, pcre_gen_cmp_ctx);
3041 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
3045 case ECOND_MATCH_ADDRESS: /* Match in an address list */
3046 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0,
3047 CUSS &lookup_value);
3048 goto MATCHED_SOMETHING;
3050 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
3051 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
3052 MCL_DOMAIN + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3053 goto MATCHED_SOMETHING;
3055 case ECOND_MATCH_IP: /* Match IP address in a host list */
3056 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
3058 expand_string_message = string_sprintf("\"%s\" is not an IP address",
3064 unsigned int *nullcache = NULL;
3065 check_host_block cb;
3067 cb.host_name = US"";
3068 cb.host_address = sub[0];
3070 /* If the host address starts off ::ffff: it is an IPv6 address in
3071 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3074 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3075 cb.host_address + 7 : cb.host_address;
3077 rc = match_check_list(
3078 &sub[1], /* the list */
3079 0, /* separator character */
3080 &hostlist_anchor, /* anchor pointer */
3081 &nullcache, /* cache pointer */
3082 check_host, /* function for testing */
3083 &cb, /* argument for function */
3084 MCL_HOST, /* type of check */
3085 sub[0], /* text for debugging */
3086 CUSS &lookup_value); /* where to pass back data */
3088 goto MATCHED_SOMETHING;
3090 case ECOND_MATCH_LOCAL_PART:
3091 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3092 MCL_LOCALPART + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3098 case OK: tempcond = TRUE; break;
3099 case FAIL: tempcond = FALSE; break;
3102 expand_string_message = string_sprintf("unable to complete match "
3103 "against \"%s\": %s", sub[1], search_error_message);
3109 /* Various "encrypted" comparisons. If the second string starts with
3110 "{" then an encryption type is given. Default to crypt() or crypt16()
3111 (build-time choice). */
3112 /* }-for-text-editors */
3115 #ifndef SUPPORT_CRYPTEQ
3116 goto COND_FAILED_NOT_COMPILED;
3118 if (strncmpic(sub[1], US"{md5}", 5) == 0)
3120 int sublen = Ustrlen(sub[1]+5);
3125 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3127 /* If the length that we are comparing against is 24, the MD5 digest
3128 is expressed as a base64 string. This is the way LDAP does it. However,
3129 some other software uses a straightforward hex representation. We assume
3130 this if the length is 32. Other lengths fail. */
3134 uschar *coded = b64encode(CUS digest, 16);
3135 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3136 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3137 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3139 else if (sublen == 32)
3142 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3144 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3145 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3146 tempcond = (strcmpic(coded, sub[1]+5) == 0);
3150 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3151 "fail\n crypted=%s\n", sub[1]+5);
3156 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3158 int sublen = Ustrlen(sub[1]+6);
3163 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3165 /* If the length that we are comparing against is 28, assume the SHA1
3166 digest is expressed as a base64 string. If the length is 40, assume a
3167 straightforward hex representation. Other lengths fail. */
3171 uschar *coded = b64encode(CUS digest, 20);
3172 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3173 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3174 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3176 else if (sublen == 40)
3179 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3181 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3182 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3183 tempcond = (strcmpic(coded, sub[1]+6) == 0);
3187 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3188 "fail\n crypted=%s\n", sub[1]+6);
3193 else /* {crypt} or {crypt16} and non-{ at start */
3194 /* }-for-text-editors */
3199 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3204 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3209 else if (sub[1][0] == '{') /* }-for-text-editors */
3211 expand_string_message = string_sprintf("unknown encryption mechanism "
3212 "in \"%s\"", sub[1]);
3218 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3219 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
3220 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3224 #define XSTR(s) STR(s)
3225 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3226 " subject=%s\n crypted=%s\n",
3227 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3232 /* If the encrypted string contains fewer than two characters (for the
3233 salt), force failure. Otherwise we get false positives: with an empty
3234 string the yield of crypt() is an empty string! */
3237 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3238 else if (errno == EINVAL)
3242 expand_string_message = string_sprintf("crypt error: %s\n",
3243 US strerror(errno));
3248 #endif /* SUPPORT_CRYPTEQ */
3253 const uschar * list = sub[1];
3255 uschar *save_iterate_item = iterate_item;
3256 int (*compare)(const uschar *, const uschar *);
3258 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);
3261 compare = cond_type == ECOND_INLISTI
3262 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3264 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3266 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3267 if (compare(sub[0], iterate_item) == 0)
3270 lookup_value = iterate_item;
3274 iterate_item = save_iterate_item;
3277 } /* Switch for comparison conditions */
3279 *yield = tempcond == testfor;
3280 return s; /* End of comparison conditions */
3283 /* and/or: computes logical and/or of several conditions */
3287 subcondptr = (yield == NULL) ? NULL : &tempcond;
3288 combined_cond = (cond_type == ECOND_AND);
3290 Uskip_whitespace(&s);
3291 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3295 /* {-for-text-editors */
3296 if (Uskip_whitespace(&s) == '}') break;
3297 if (*s != '{') /* }-for-text-editors */
3299 expand_string_message = string_sprintf("each subcondition "
3300 "inside an \"%s{...}\" condition must be in its own {}", opname);
3304 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3306 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3307 expand_string_message, opname);
3310 Uskip_whitespace(&s);
3312 /* {-for-text-editors */
3315 /* {-for-text-editors */
3316 expand_string_message = string_sprintf("missing } at end of condition "
3317 "inside \"%s\" group", opname);
3322 if (cond_type == ECOND_AND)
3324 combined_cond &= tempcond;
3325 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3326 } /* evaluate any more */
3329 combined_cond |= tempcond;
3330 if (combined_cond) subcondptr = NULL; /* once true, don't */
3331 } /* evaluate any more */
3334 if (yield) *yield = (combined_cond == testfor);
3338 /* forall/forany: iterates a condition with different values */
3340 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3341 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3342 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3343 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3344 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3345 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3349 const uschar * list;
3351 uschar *save_iterate_item = iterate_item;
3353 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3355 Uskip_whitespace(&s);
3356 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3357 if (!(sub[0] = expand_string_internal(s,
3358 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
3359 &s, resetok, NULL)))
3361 /* {-for-text-editors */
3362 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3364 Uskip_whitespace(&s);
3365 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3369 /* Call eval_condition once, with result discarded (as if scanning a
3370 "false" part). This allows us to find the end of the condition, because if
3371 the list it empty, we won't actually evaluate the condition for real. */
3373 if (!(s = eval_condition(sub[1], resetok, NULL)))
3375 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3376 expand_string_message, opname);
3379 Uskip_whitespace(&s);
3381 /* {-for-text-editors */
3384 /* {-for-text-editors */
3385 expand_string_message = string_sprintf("missing } at end of condition "
3386 "inside \"%s\"", opname);
3390 if (yield) *yield = !testfor;
3392 if (is_json) list = dewrap(string_copy(list), US"[]");
3393 while ((iterate_item = is_json
3394 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3397 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3399 expand_string_message =
3400 string_sprintf("%s wrapping string result for extract jsons",
3401 expand_string_message);
3402 iterate_item = save_iterate_item;
3406 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3407 if (!eval_condition(sub[1], resetok, &tempcond))
3409 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3410 expand_string_message, opname);
3411 iterate_item = save_iterate_item;
3414 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3415 tempcond? "true":"false");
3417 if (yield) *yield = (tempcond == testfor);
3418 if (tempcond == is_forany) break;
3421 iterate_item = save_iterate_item;
3426 /* The bool{} expansion condition maps a string to boolean.
3427 The values supported should match those supported by the ACL condition
3428 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3429 of true/false. Note that Router "condition" rules have a different
3430 interpretation, where general data can be used and only a few values
3432 Note that readconf.c boolean matching, for boolean configuration options,
3433 only matches true/yes/false/no.
3434 The bool_lax{} condition matches the Router logic, which is much more
3437 case ECOND_BOOL_LAX:
3443 BOOL boolvalue = FALSE;
3445 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3446 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3447 switch(read_subs(sub_arg, 1, 1, &s,
3448 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, ourname, resetok, NULL))
3450 case 1: expand_string_message = string_sprintf(
3451 "too few arguments or bracketing error for %s",
3455 case 3: return NULL;
3458 Uskip_whitespace(&t);
3459 if ((len = Ustrlen(t)))
3461 /* trailing whitespace: seems like a good idea to ignore it too */
3463 while (isspace(*t2)) t2--;
3464 if (t2 != (t + len))
3471 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3472 /* logic for the lax case from expand_check_condition(), which also does
3473 expands, and the logic is both short and stable enough that there should
3474 be no maintenance burden from replicating it. */
3478 ? Ustrspn(t+1, "0123456789") == len-1
3479 : Ustrspn(t, "0123456789") == len)
3481 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3482 /* expand_check_condition only does a literal string "0" check */
3483 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3486 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3488 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3490 else if (cond_type == ECOND_BOOL_LAX)
3494 expand_string_message = string_sprintf("unrecognised boolean "
3498 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3499 boolvalue? "true":"false");
3500 if (yield) *yield = (boolvalue == testfor);
3505 case ECOND_INBOUND_SRS:
3506 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */
3509 const pcre2_code * re;
3510 pcre2_match_data * md;
3514 BOOL boolvalue = FALSE;
3516 switch(read_subs(sub, 2, 2, CUSS &s,
3517 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, name, resetok, NULL))
3519 case 1: expand_string_message = US"too few arguments or bracketing "
3520 "error for inbound_srs";
3522 case 3: return NULL;
3525 /* Match the given local_part against the SRS-encoded pattern */
3527 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]+)=([^=]*)=(.*)$",
3528 MCS_CASELESS | MCS_CACHEABLE, FALSE);
3529 md = pcre2_match_data_create(4+1, pcre_gen_ctx);
3530 if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,
3531 md, pcre_gen_mtc_ctx) < 0)
3533 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3536 ovec = pcre2_get_ovector_pointer(md);
3538 if (sub[0][0] == '"')
3540 else for (uschar * s = sub[0]; *s; s++)
3541 if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3542 { quoting = 1; break; }
3544 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3546 /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3548 srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S", /* lowercased */
3550 (int) (ovec[9]-ovec[8]), sub[0] + ovec[8], /* substr 4 */
3552 (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */
3554 /* If a zero-length secret was given, we're done. Otherwise carry on
3555 and validate the given SRS local_part againt our secret. */
3563 /* check the timestamp */
3566 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3570 gettimeofday(&now, NULL);
3571 now.tv_sec /= 86400; /* days since epoch */
3573 /* Decode substring 2 from base32 to a number */
3575 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3577 uschar * t = Ustrchr(base32_chars, *ss++);
3578 d = d * 32 + (t - base32_chars);
3581 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3583 DEBUG(D_expand) debug_printf("SRS too old\n");
3588 /* check length of substring 1, the offered checksum */
3590 if (ovec[3]-ovec[2] != 4)
3592 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3596 /* Hash the address with our secret, and compare that computed checksum
3597 with the one extracted from the arg */
3599 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3600 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3602 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3608 /* pcre2_match_data_free(md); gen ctx needs no free */
3609 if (yield) *yield = (boolvalue == testfor);
3612 #endif /*SUPPORT_SRS*/
3614 /* Unknown condition */
3617 if (!expand_string_message || !*expand_string_message)
3618 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3620 } /* End switch on condition type */
3622 /* Missing braces at start and end of data */
3624 COND_FAILED_CURLY_START:
3625 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3628 COND_FAILED_CURLY_END:
3629 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3633 /* A condition requires code that is not compiled */
3635 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3636 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3637 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3638 COND_FAILED_NOT_COMPILED:
3639 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3648 /*************************************************
3649 * Save numerical variables *
3650 *************************************************/
3652 /* This function is called from items such as "if" that want to preserve and
3653 restore the numbered variables.
3656 save_expand_string points to an array of pointers to set
3657 save_expand_nlength points to an array of ints for the lengths
3659 Returns: the value of expand max to save
3663 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3665 for (int i = 0; i <= expand_nmax; i++)
3667 save_expand_nstring[i] = expand_nstring[i];
3668 save_expand_nlength[i] = expand_nlength[i];
3675 /*************************************************
3676 * Restore numerical variables *
3677 *************************************************/
3679 /* This function restored saved values of numerical strings.
3682 save_expand_nmax the number of strings to restore
3683 save_expand_string points to an array of pointers
3684 save_expand_nlength points to an array of ints
3690 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3691 int *save_expand_nlength)
3693 expand_nmax = save_expand_nmax;
3694 for (int i = 0; i <= expand_nmax; i++)
3696 expand_nstring[i] = save_expand_nstring[i];
3697 expand_nlength[i] = save_expand_nlength[i];
3705 /*************************************************
3706 * Handle yes/no substrings *
3707 *************************************************/
3709 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3710 alternative substrings that depend on whether or not the condition was true,
3711 or the lookup or extraction succeeded. The substrings always have to be
3712 expanded, to check their syntax, but "skipping" is set when the result is not
3713 needed - this avoids unnecessary nested lookups.
3717 skipping TRUE if we were skipping when this item was reached
3718 yes TRUE if the first string is to be used, else use the second
3719 save_lookup a value to put back into lookup_value before the 2nd expansion
3720 sptr points to the input string pointer
3721 yieldptr points to the output growable-string pointer
3722 type "lookup", "if", "extract", "run", "env", "listextract" or
3723 "certextract" for error message
3724 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3727 Returns: 0 OK; lookup_value has been reset to save_lookup
3729 2 expansion failed because of bracketing error
3733 process_yesno(esi_flags flags, BOOL yes, uschar *save_lookup, const uschar **sptr,
3734 gstring ** yieldptr, uschar *type, BOOL *resetok)
3737 const uschar *s = *sptr; /* Local value */
3738 uschar *sub1, *sub2;
3739 const uschar * errwhere;
3741 flags &= ESI_SKIPPING; /* Ignore all buf the skipping flag */
3743 /* If there are no following strings, we substitute the contents of $value for
3744 lookups and for extractions in the success case. For the ${if item, the string
3745 "true" is substituted. In the fail case, nothing is substituted for all three
3748 if (skip_whitespace(&s) == '}')
3752 if (yes && !(flags & ESI_SKIPPING))
3753 *yieldptr = string_catn(*yieldptr, US"true", 4);
3757 if (yes && lookup_value && !(flags & ESI_SKIPPING))
3758 *yieldptr = string_cat(*yieldptr, lookup_value);
3759 lookup_value = save_lookup;
3765 /* The first following string must be braced. */
3769 errwhere = US"'yes' part did not start with '{'"; /*}}*/
3773 /* Expand the first substring. Forced failures are noticed only if we actually
3774 want this string. Set skipping in the call in the fail case (this will always
3775 be the case if we were already skipping). */
3777 sub1 = expand_string_internal(s,
3778 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yes ? ESI_NOFLAGS : ESI_SKIPPING),
3780 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3781 f.expand_string_forcedfail = FALSE;
3785 errwhere = US"'yes' part did not end with '}'";
3789 /* If we want the first string, add it to the output */
3792 *yieldptr = string_cat(*yieldptr, sub1);
3794 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3795 $value to what it was at the start of the item, so that it has this value
3796 during the second string expansion. For the call from "if" or "run" to this
3797 function, save_lookup is set to lookup_value, so that this statement does
3800 lookup_value = save_lookup;
3802 /* There now follows either another substring, or "fail", or nothing. This
3803 time, forced failures are noticed only if we want the second string. We must
3804 set skipping in the nested call if we don't want this string, or if we were
3805 already skipping. */
3807 if (skip_whitespace(&s) == '{') /*}*/
3809 esi_flags s_flags = ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags;
3810 if (yes) s_flags |= ESI_SKIPPING;
3811 sub2 = expand_string_internal(s+1, s_flags, &s, resetok, NULL);
3812 if (!sub2 && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3813 f.expand_string_forcedfail = FALSE; /*{*/
3816 errwhere = US"'no' part did not start with '{'"; /*}*/
3820 /* If we want the second string, add it to the output */
3823 *yieldptr = string_cat(*yieldptr, sub2);
3826 /* If there is no second string, but the word "fail" is present when the use of
3827 the second string is wanted, set a flag indicating it was a forced failure
3828 rather than a syntactic error. Swallow the terminating } in case this is nested
3829 inside another lookup or if or extract. */
3834 /* deconst cast ok here as source is s anyway */
3835 s = US read_name(name, sizeof(name), s, US"_");
3836 if (Ustrcmp(name, "fail") == 0)
3838 if (!yes && !(flags & ESI_SKIPPING))
3840 Uskip_whitespace(&s); /*{{*/
3843 errwhere = US"did not close with '}' after forcedfail";
3846 expand_string_message =
3847 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3848 f.expand_string_forcedfail = TRUE;
3854 expand_string_message =
3855 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3860 /* All we have to do now is to check on the final closing brace. */
3862 skip_whitespace(&s); /*{{*/
3865 errwhere = US"did not close with '}'";
3871 /* Update the input pointer value before returning */
3876 /* Get here if there is a bracketing failure */
3877 expand_string_message = string_sprintf(
3878 "curly-bracket problem in conditional yes/no parsing: %s\n"
3879 " remaining string is '%s'", errwhere, --s);
3884 /* Get here for other failures */
3892 /********************************************************
3893 * prvs: Get last three digits of days since Jan 1, 1970 *
3894 ********************************************************/
3896 /* This is needed to implement the "prvs" BATV reverse
3899 Argument: integer "days" offset to add or substract to
3900 or from the current number of days.
3902 Returns: pointer to string containing the last three
3903 digits of the number of days since Jan 1, 1970,
3904 modified by the offset argument, NULL if there
3905 was an error in the conversion.
3910 prvs_daystamp(int day_offset)
3912 uschar * days = store_get(32, GET_UNTAINTED); /* Need at least 24 for cases */
3913 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3914 (time(NULL) + day_offset*86400)/86400);
3915 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3920 /********************************************************
3921 * prvs: perform HMAC-SHA1 computation of prvs bits *
3922 ********************************************************/
3924 /* This is needed to implement the "prvs" BATV reverse
3928 address RFC2821 Address to use
3929 key The key to use (must be less than 64 characters
3931 key_num Single-digit key number to use. Defaults to
3934 Returns: pointer to string containing the first three
3935 bytes of the final hash in hex format, NULL if
3936 there was an error in the process.
3940 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3942 gstring * hash_source;
3945 uschar innerhash[20];
3946 uschar finalhash[20];
3947 uschar innerkey[64];
3948 uschar outerkey[64];
3949 uschar *finalhash_hex;
3954 if (Ustrlen(key) > 64)
3957 hash_source = string_catn(NULL, key_num, 1);
3958 hash_source = string_catn(hash_source, daystamp, 3);
3959 hash_source = string_cat(hash_source, address);
3960 (void) string_from_gstring(hash_source);
3963 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3965 memset(innerkey, 0x36, 64);
3966 memset(outerkey, 0x5c, 64);
3968 for (int i = 0; i < Ustrlen(key); i++)
3970 innerkey[i] ^= key[i];
3971 outerkey[i] ^= key[i];
3974 chash_start(HMAC_SHA1, &h);
3975 chash_mid(HMAC_SHA1, &h, innerkey);
3976 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3978 chash_start(HMAC_SHA1, &h);
3979 chash_mid(HMAC_SHA1, &h, outerkey);
3980 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3982 /* Hashing is deemed sufficient to de-taint any input data */
3984 p = finalhash_hex = store_get(40, GET_UNTAINTED);
3985 for (int i = 0; i < 3; i++)
3987 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3988 *p++ = hex_digits[finalhash[i] & 0x0f];
3992 return finalhash_hex;
3998 /*************************************************
3999 * Join a file onto the output string *
4000 *************************************************/
4002 /* This is used for readfile/readsock and after a run expansion.
4003 It joins the contents of a file onto the output string, globally replacing
4004 newlines with a given string (optionally).
4008 yield pointer to the expandable string struct
4009 eol newline replacement string, or NULL
4011 Returns: new pointer for expandable string, terminated if non-null
4015 cat_file(FILE * f, gstring * yield, uschar * eol)
4017 uschar buffer[1024];
4019 while (Ufgets(buffer, sizeof(buffer), f))
4021 int len = Ustrlen(buffer);
4022 if (eol && buffer[len-1] == '\n') len--;
4023 yield = string_catn(yield, buffer, len);
4024 if (eol && buffer[len])
4025 yield = string_cat(yield, eol);
4033 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
4036 uschar buffer[1024];
4038 /*XXX could we read direct into a pre-grown string? */
4040 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
4041 for (uschar * s = buffer; rc--; s++)
4042 yield = eol && *s == '\n'
4043 ? string_cat(yield, eol) : string_catn(yield, s, 1);
4045 /* We assume that all errors, and any returns of zero bytes,
4046 are actually EOF. */
4053 /*************************************************
4054 * Evaluate numeric expression *
4055 *************************************************/
4057 /* This is a set of mutually recursive functions that evaluate an arithmetic
4058 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
4059 these functions that is called from elsewhere is eval_expr, whose interface is:
4062 sptr pointer to the pointer to the string - gets updated
4063 decimal TRUE if numbers are to be assumed decimal
4064 error pointer to where to put an error message - must be NULL on input
4065 endket TRUE if ')' must terminate - FALSE for external call
4067 Returns: on success: the value of the expression, with *error still NULL
4068 on failure: an undefined value, with *error = a message
4071 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4074 static int_eximarith_t
4075 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4078 int_eximarith_t x = eval_op_or(&s, decimal, error);
4083 *error = US"expecting closing parenthesis";
4085 while (isspace(*++s));
4087 *error = US"expecting operator";
4093 static int_eximarith_t
4094 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4100 if (isdigit((c = Uskip_whitespace(&s))))
4103 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4105 switch (tolower(*s))
4108 case 'k': n *= 1024; s++; break;
4109 case 'm': n *= 1024*1024; s++; break;
4110 case 'g': n *= 1024*1024*1024; s++; break;
4112 Uskip_whitespace(&s);
4117 n = eval_expr(&s, decimal, error, 1);
4121 *error = US"expecting number or opening parenthesis";
4129 static int_eximarith_t
4130 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4134 Uskip_whitespace(&s);
4135 if (*s == '+' || *s == '-' || *s == '~')
4138 x = eval_op_unary(&s, decimal, error);
4139 if (op == '-') x = -x;
4140 else if (op == '~') x = ~x;
4143 x = eval_number(&s, decimal, error);
4150 static int_eximarith_t
4151 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4154 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4157 while (*s == '*' || *s == '/' || *s == '%')
4160 int_eximarith_t y = eval_op_unary(&s, decimal, error);
4162 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4163 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4164 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4165 * -N*M is INT_MIN will yield INT_MIN.
4166 * Since we don't support floating point, this is somewhat simpler.
4167 * Ideally, we'd return an error, but since we overflow for all other
4168 * arithmetic, consistency suggests otherwise, but what's the correct value
4169 * to use? There is none.
4170 * The C standard guarantees overflow for unsigned arithmetic but signed
4171 * overflow invokes undefined behaviour; in practice, this is overflow
4172 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4173 * that long/longlong larger than int are available, or we could just work
4174 * with larger types. We should consider whether to guarantee 32bit eval
4175 * and 64-bit working variables, with errors returned. For now ...
4176 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4177 * can just let the other invalid results occur otherwise, as they have
4178 * until now. For this one case, we can coerce.
4180 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4183 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4184 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4194 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4210 static int_eximarith_t
4211 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4214 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4217 while (*s == '+' || *s == '-')
4220 int_eximarith_t y = eval_op_mult(&s, decimal, error);
4222 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4223 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4224 { /* over-conservative check */
4226 ? US"overflow in sum" : US"overflow in difference";
4229 if (op == '+') x += y; else x -= y;
4237 static int_eximarith_t
4238 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4241 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4244 while ((*s == '<' || *s == '>') && s[1] == s[0])
4249 y = eval_op_sum(&s, decimal, error);
4251 if (op == '<') x <<= y; else x >>= y;
4259 static int_eximarith_t
4260 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4263 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4270 y = eval_op_shift(&s, decimal, error);
4280 static int_eximarith_t
4281 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4284 int_eximarith_t x = eval_op_and(&s, decimal, error);
4291 y = eval_op_and(&s, decimal, error);
4301 static int_eximarith_t
4302 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4305 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4312 y = eval_op_xor(&s, decimal, error);
4323 /************************************************/
4324 /* Comparison operation for sort expansion. We need to avoid
4325 re-expanding the fields being compared, so need a custom routine.
4328 cond_type Comparison operator code
4329 leftarg, rightarg Arguments for comparison
4331 Return true iff (leftarg compare rightarg)
4335 sortsbefore(int cond_type, BOOL alpha_cond,
4336 const uschar * leftarg, const uschar * rightarg)
4338 int_eximarith_t l_num, r_num;
4342 l_num = expanded_string_integer(leftarg, FALSE);
4343 if (expand_string_message) return FALSE;
4344 r_num = expanded_string_integer(rightarg, FALSE);
4345 if (expand_string_message) return FALSE;
4349 case ECOND_NUM_G: return l_num > r_num;
4350 case ECOND_NUM_GE: return l_num >= r_num;
4351 case ECOND_NUM_L: return l_num < r_num;
4352 case ECOND_NUM_LE: return l_num <= r_num;
4359 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4360 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4361 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4362 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4363 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4364 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4365 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4366 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4369 return FALSE; /* should not happen */
4373 /* Expand a named list. Return false on failure. */
4375 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4377 tree_node *t = NULL;
4378 const uschar * list;
4381 BOOL needsep = FALSE;
4382 #define LISTNAMED_BUF_SIZE 256
4383 uschar b[LISTNAMED_BUF_SIZE];
4384 uschar * buffer = b;
4386 if (*name == '+') name++;
4387 if (!listtype) /* no-argument version */
4389 if ( !(t = tree_search(addresslist_anchor, name))
4390 && !(t = tree_search(domainlist_anchor, name))
4391 && !(t = tree_search(hostlist_anchor, name)))
4392 t = tree_search(localpartlist_anchor, name);
4394 else switch(*listtype) /* specific list-type version */
4396 case 'a': t = tree_search(addresslist_anchor, name); break;
4397 case 'd': t = tree_search(domainlist_anchor, name); break;
4398 case 'h': t = tree_search(hostlist_anchor, name); break;
4399 case 'l': t = tree_search(localpartlist_anchor, name); break;
4401 expand_string_message = US"bad suffix on \"list\" operator";
4407 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4409 : *listtype=='a'?"address "
4410 : *listtype=='d'?"domain "
4411 : *listtype=='h'?"host "
4412 : *listtype=='l'?"localpart "
4417 list = ((namedlist_block *)(t->data.ptr))->string;
4419 /* The list could be quite long so we (re)use a buffer for each element
4420 rather than getting each in new memory */
4422 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, GET_TAINTED);
4423 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4425 uschar * buf = US" : ";
4427 yield = string_catn(yield, buf, 3);
4431 if (*item == '+') /* list item is itself a named list */
4433 yield = expand_listnamed(yield, item, listtype);
4434 if (expand_string_message)
4438 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
4441 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4443 for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4445 yield = string_catn(yield, item, cp - CS item);
4446 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4447 yield = string_catn(yield, US"::", 2);
4448 else /* sep in item; should already be doubled; emit once */
4450 yield = string_catn(yield, US tok, 1);
4451 if (*cp == sep) cp++;
4454 yield = string_cat(yield, item);
4457 yield = string_cat(yield, item);
4464 /************************************************/
4466 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4470 debug_printf_indent("|");
4472 debug_printf_indent(UTF8_VERT_RIGHT);
4474 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4478 debug_printf(UTF8_HORIZ);
4480 debug_printf("%s: %.*s\n", what, nchar, value);
4481 if (is_tainted(value))
4484 debug_printf_indent("%s \\__", skipping ? "| " : " ");
4486 debug_printf_indent("%s",
4488 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
4489 debug_printf("(tainted)\n");
4494 /*************************************************
4496 *************************************************/
4498 /* Returns either an unchanged string, or the expanded string in stacking pool
4499 store. Interpreted sequences are:
4501 \... normal escaping rules
4502 $name substitutes the variable
4504 ${op:string} operates on the expanded string value
4505 ${item{arg1}{arg2}...} expands the args and then does the business
4506 some literal args are not enclosed in {}
4508 There are now far too many operators and item types to make it worth listing
4509 them here in detail any more.
4511 We use an internal routine recursively to handle embedded substrings. The
4512 external function follows. The yield is NULL if the expansion failed, and there
4513 are two cases: if something collapsed syntactically, or if "fail" was given
4514 as the action on a lookup failure. These can be distinguished by looking at the
4515 variable expand_string_forcedfail, which is TRUE in the latter case.
4517 The skipping flag is set true when expanding a substring that isn't actually
4518 going to be used (after "if" or "lookup") and it prevents lookups from
4519 happening lower down.
4521 Store usage: At start, a store block of the length of the input plus 64
4522 is obtained. This is expanded as necessary by string_cat(), which might have to
4523 get a new block, or might be able to expand the original. At the end of the
4524 function we can release any store above that portion of the yield block that
4525 was actually used. In many cases this will be optimal.
4527 However: if the first item in the expansion is a variable name or header name,
4528 we reset the store before processing it; if the result is in fresh store, we
4529 use that without copying. This is helpful for expanding strings like
4530 $message_headers which can get very long.
4532 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4533 since resetting the store at the end of the expansion will free store that was
4534 allocated by the plugin code as well as the slop after the expanded string. So
4535 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4536 and, given the acl condition, ${if }. This is an unfortunate consequence of
4537 string expansion becoming too powerful.
4540 string the string to be expanded
4542 brace_ends expansion is to stop at }
4543 honour_dollar TRUE if $ is to be expanded,
4544 FALSE if it's just another character
4545 skipping TRUE for recursive calls when the value isn't actually going
4546 to be used (to allow for optimisation)
4547 left if not NULL, a pointer to the first character after the
4548 expansion is placed here (typically used with brace_ends)
4549 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4551 textonly_p if not NULL, pointer to flag - write bool for only-met-text
4553 Returns: NULL if expansion fails:
4554 expand_string_forcedfail is set TRUE if failure was forced
4555 expand_string_message contains a textual error message
4556 a pointer to the expanded string on success
4560 expand_string_internal(const uschar * string, esi_flags flags, const uschar ** left,
4561 BOOL *resetok_p, BOOL * textonly_p)
4563 rmark reset_point = store_mark();
4564 gstring * yield = string_get(Ustrlen(string) + 64);
4566 const uschar * s = string;
4567 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4568 int save_expand_nlength[EXPAND_MAXN+1];
4569 BOOL resetok = TRUE, first = TRUE, textonly = TRUE;
4572 f.expand_string_forcedfail = FALSE;
4573 expand_string_message = US"";
4575 if (is_tainted(string))
4577 expand_string_message =
4578 string_sprintf("attempt to expand tainted string '%s'", s);
4579 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4590 debug_printf_indent("%c%s: %s\n",
4592 flags & ESI_SKIPPING ? "---scanning" : "considering", s);
4594 debug_printf_indent("%s%s: %s\n",
4595 first ? UTF8_DOWN_RIGHT : UTF8_VERT_RIGHT,
4596 flags & ESI_SKIPPING
4597 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4603 /* \ escapes the next character, which must exist, or else
4604 the expansion fails. There's a special escape, \N, which causes
4605 copying of the subject verbatim up to the next \N. Otherwise,
4606 the escapes are the standard set. */
4612 expand_string_message = US"\\ at end of string";
4618 const uschar * t = s + 2;
4619 for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4622 debug_expansion_interim(US"protected", t, (int)(s - t), !!(flags & ESI_SKIPPING));
4623 yield = string_catn(yield, t, s - t);
4631 debug_printf_indent("|backslashed: '\\%c'\n", s[1]);
4633 debug_printf_indent(UTF8_VERT_RIGHT "backslashed: '\\%c'\n", s[1]);
4634 ch[0] = string_interpret_escape(&s);
4636 yield = string_catn(yield, ch, 1);
4642 /* Anything other than $ is just copied verbatim, unless we are
4643 looking for a terminating } character. */
4645 if (flags & ESI_BRACE_ENDS && *s == '}') break;
4647 if (*s != '$' || !(flags & ESI_HONOR_DOLLAR))
4650 for (const uschar * t = s+1;
4651 *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4653 DEBUG(D_expand) debug_expansion_interim(US"text", s, i, !!(flags & ESI_SKIPPING));
4655 yield = string_catn(yield, s, i);
4661 /* No { after the $ - must be a plain name or a number for string
4662 match variable. There has to be a fudge for variables that are the
4663 names of header fields preceded by "$header_" because header field
4664 names can contain any printing characters except space and colon.
4665 For those that don't like typing this much, "$h_" is a synonym for
4666 "$header_". A non-existent header yields a NULL value; nothing is
4671 const uschar * value;
4672 int newsize = 0, len;
4676 s = read_name(name, sizeof(name), s, US"_");
4678 /* If this is the first thing to be expanded, release the pre-allocated
4682 g = store_get(sizeof(gstring), GET_UNTAINTED);
4683 else if (yield->ptr == 0)
4685 if (resetok) reset_point = store_reset(reset_point);
4687 reset_point = store_mark();
4688 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
4693 if ( ( *(t = name) == 'h'
4694 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4696 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4699 unsigned flags = *name == 'r' ? FH_WANT_RAW
4700 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4702 const uschar * charset = *name == 'b' ? NULL : headers_charset;
4704 s = read_header_name(name, sizeof(name), s);
4705 value = find_header(name, &newsize, flags, charset);
4707 /* If we didn't find the header, and the header contains a closing brace
4708 character, this may be a user error where the terminating colon
4709 has been omitted. Set a flag to adjust the error message in this case.
4710 But there is no error here - nothing gets inserted. */
4714 if (Ustrchr(name, '}')) malformed_header = TRUE;
4721 else if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
4723 expand_string_message =
4724 string_sprintf("unknown variable name \"%s\"", name);
4725 check_variable_error_message(name);
4729 /* If the data is known to be in a new buffer, newsize will be set to the
4730 size of that buffer. If this is the first thing in an expansion string,
4731 yield will be NULL; just point it at the new store instead of copying. Many
4732 expansion strings contain just one reference, so this is a useful
4733 optimization, especially for humungous headers. We need to use a gstring
4734 structure that is not allocated after that new-buffer, else a later store
4735 reset in the middle of the buffer will make it inaccessible. */
4737 len = Ustrlen(value);
4738 DEBUG(D_expand) debug_expansion_interim(US"value", value, len, !!(flags & ESI_SKIPPING));
4739 if (!yield && newsize != 0)
4742 yield->size = newsize;
4744 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4747 yield = string_catn(yield, value, len);
4752 if (isdigit(*s)) /* A $<n> variable */
4755 s = read_cnumber(&n, s);
4756 if (n >= 0 && n <= expand_nmax)
4758 DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], !!(flags & ESI_SKIPPING));
4759 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4764 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4766 if (*s != '{') /*}*/
4768 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4772 /* After { there can be various things, but they all start with
4773 an initial word, except for a number for a string match variable. */ /*}*/
4778 s = read_cnumber(&n, s); /*{{*/
4781 expand_string_message = US"} expected after number";
4784 if (n >= 0 && n <= expand_nmax)
4786 DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], !!(flags & ESI_SKIPPING));
4787 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4794 expand_string_message = US"letter or digit expected after ${"; /*}*/
4798 /* Allow "-" in names to cater for substrings with negative
4799 arguments. Since we are checking for known names after { this is
4802 s = read_name(name, sizeof(name), s, US"_-");
4803 item_type = chop_match(name, item_table, nelem(item_table));
4805 /* Switch on item type. All nondefault choices should "continue* when
4806 skipping, but "break" otherwise so we get debug output for the item
4809 int expansion_start = gstring_length(yield);
4812 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4813 If the ACL returns accept or reject we return content set by "message ="
4814 There is currently no limit on recursion; this would have us call
4815 acl_check_internal() directly and get a current level from somewhere.
4816 See also the acl expansion condition ECOND_ACL and the traditional
4817 acl modifier ACLC_ACL.
4818 Assume that the function has side-effects on the store that must be preserved.
4822 /* ${acl {name} {arg1}{arg2}...} */
4824 uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4828 switch(read_subs(sub, nelem(sub), 1, &s, flags, TRUE, name, &resetok, NULL))
4830 case -1: continue; /* skipping */
4831 case 1: goto EXPAND_FAILED_CURLY;
4833 case 3: goto EXPAND_FAILED;
4837 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4842 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4844 yield = string_cat(yield, user_msg);
4848 f.expand_string_forcedfail = TRUE;
4851 expand_string_message = string_sprintf("%s from acl \"%s\"",
4852 rc_names[rc], sub[0]);
4858 case EITEM_AUTHRESULTS:
4859 /* ${authresults {mysystemname}} */
4861 uschar * sub_arg[1];
4863 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4865 case -1: continue; /* If skipping, we don't actually do anything */
4866 case 1: goto EXPAND_FAILED_CURLY;
4868 case 3: goto EXPAND_FAILED;
4871 yield = string_append(yield, 3,
4872 US"Authentication-Results: ", sub_arg[0], US"; none");
4873 yield->ptr -= 6; /* ignore tha ": none" for now */
4875 yield = authres_local(yield, sub_arg[0]);
4876 yield = authres_iprev(yield);
4877 yield = authres_smtpauth(yield);
4879 yield = authres_spf(yield);
4881 #ifndef DISABLE_DKIM
4882 yield = authres_dkim(yield);
4884 #ifdef SUPPORT_DMARC
4885 yield = authres_dmarc(yield);
4887 #ifdef EXPERIMENTAL_ARC
4888 yield = authres_arc(yield);
4893 /* Handle conditionals - preserve the values of the numerical expansion
4894 variables in case they get changed by a regular expression match in the
4895 condition. If not, they retain their external settings. At the end
4896 of this "if" section, they get restored to their previous values. */
4901 const uschar *next_s;
4902 int save_expand_nmax =
4903 save_expand_strings(save_expand_nstring, save_expand_nlength);
4904 uschar * save_lookup_value = lookup_value;
4906 Uskip_whitespace(&s);
4907 if (!(next_s = eval_condition(s, &resetok, flags & ESI_SKIPPING ? NULL : &cond)))
4908 goto EXPAND_FAILED; /* message already set */
4912 debug_expansion_interim(US"condition", s, (int)(next_s - s), !!(flags & ESI_SKIPPING));
4913 debug_expansion_interim(US"result",
4914 cond ? US"true" : US"false", cond ? 4 : 5, !!(flags & ESI_SKIPPING));
4919 /* The handling of "yes" and "no" result strings is now in a separate
4920 function that is also used by ${lookup} and ${extract} and ${run}. */
4922 switch(process_yesno(
4923 flags, /* were previously skipping */
4924 cond, /* success/failure indicator */
4925 lookup_value, /* value to reset for string2 */
4926 &s, /* input pointer */
4927 &yield, /* output pointer */
4928 US"if", /* condition type */
4931 case 1: goto EXPAND_FAILED; /* when all is well, the */
4932 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4935 /* Restore external setting of expansion variables for continuation
4938 lookup_value = save_lookup_value;
4939 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4940 save_expand_nlength);
4945 case EITEM_IMAPFOLDER:
4946 { /* ${imapfolder {name}{sep}{specials}} */
4950 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4952 case 1: goto EXPAND_FAILED_CURLY;
4954 case 3: goto EXPAND_FAILED;
4957 if (!sub_arg[1]) /* One argument */
4959 sub_arg[1] = US"/"; /* default separator */
4962 else if (Ustrlen(sub_arg[1]) != 1)
4964 expand_string_message =
4966 "IMAP folder separator must be one character, found \"%s\"",
4971 if (flags & ESI_SKIPPING) continue;
4973 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4974 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4976 yield = string_cat(yield, encoded);
4981 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4982 expanding an internal string that isn't actually going to be used. All we
4983 need to do is check the syntax, so don't do a lookup at all. Preserve the
4984 values of the numerical expansion variables in case they get changed by a
4985 partial lookup. If not, they retain their external settings. At the end
4986 of this "lookup" section, they get restored to their previous values. */
4990 int stype, partial, affixlen, starflags;
4991 int expand_setup = 0;
4993 uschar * key, * filename;
4994 const uschar * affix, * opts;
4995 uschar * save_lookup_value = lookup_value;
4996 int save_expand_nmax =
4997 save_expand_strings(save_expand_nstring, save_expand_nlength);
4999 if (expand_forbid & RDO_LOOKUP)
5001 expand_string_message = US"lookup expansions are not permitted";
5005 /* Get the key we are to look up for single-key+file style lookups.
5006 Otherwise set the key NULL pro-tem. */
5008 if (Uskip_whitespace(&s) == '{') /*}*/
5010 key = expand_string_internal(s+1,
5011 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
5012 if (!key) goto EXPAND_FAILED; /*{{*/
5015 expand_string_message = US"missing '}' after lookup key";
5016 goto EXPAND_FAILED_CURLY;
5018 Uskip_whitespace(&s);
5022 /* Find out the type of database */
5026 expand_string_message = US"missing lookup type";
5030 /* The type is a string that may contain special characters of various
5031 kinds. Allow everything except space or { to appear; the actual content
5032 is checked by search_findtype_partial. */ /*}*/
5034 while (*s && *s != '{' && !isspace(*s)) /*}*/
5036 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
5039 name[nameptr] = '\0';
5040 Uskip_whitespace(&s);
5042 /* Now check for the individual search type and any partial or default
5043 options. Only those types that are actually in the binary are valid. */
5045 if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
5046 &starflags, &opts)) < 0)
5048 expand_string_message = search_error_message;
5052 /* Check that a key was provided for those lookup types that need it,
5053 and was not supplied for those that use the query style. */
5055 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
5059 expand_string_message = string_sprintf("missing {key} for single-"
5060 "key \"%s\" lookup", name);
5066 expand_string_message = string_sprintf("a single key was given for "
5067 "lookup type \"%s\", which is not a single-key lookup type", name);
5071 /* Get the next string in brackets and expand it. It is the file name for
5072 single-key+file lookups, and the whole query otherwise. In the case of
5073 queries that also require a file name (e.g. sqlite), the file name comes
5078 expand_string_message = US"missing '{' for lookup file-or-query arg";
5079 goto EXPAND_FAILED_CURLY; /*}}*/
5081 if (!(filename = expand_string_internal(s+1,
5082 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5087 expand_string_message = US"missing '}' closing lookup file-or-query arg";
5088 goto EXPAND_FAILED_CURLY;
5090 Uskip_whitespace(&s);
5092 /* If this isn't a single-key+file lookup, re-arrange the variables
5093 to be appropriate for the search_ functions. For query-style lookups,
5094 there is just a "key", and no file name. For the special query-style +
5095 file types, the query (i.e. "key") starts with a file name. */
5098 key = search_args(stype, name, filename, &filename, opts);
5100 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5101 the entry was not found. Note that there is no search_close() function.
5102 Files are left open in case of re-use. At suitable places in higher logic,
5103 search_tidyup() is called to tidy all open files. This can save opening
5104 the same file several times. However, files may also get closed when
5105 others are opened, if too many are open at once. The rule is that a
5106 handle should not be used after a second search_open().
5108 Request that a partial search sets up $1 and maybe $2 by passing
5109 expand_setup containing zero. If its value changes, reset expand_nmax,
5110 since new variables will have been set. Note that at the end of this
5111 "lookup" section, the old numeric variables are restored. */
5113 if (flags & ESI_SKIPPING)
5114 lookup_value = NULL;
5117 void * handle = search_open(filename, stype, 0, NULL, NULL);
5120 expand_string_message = search_error_message;
5123 lookup_value = search_find(handle, filename, key, partial, affix,
5124 affixlen, starflags, &expand_setup, opts);
5125 if (f.search_find_defer)
5127 expand_string_message =
5128 string_sprintf("lookup of \"%s\" gave DEFER: %s",
5129 string_printing2(key, SP_TAB), search_error_message);
5132 if (expand_setup > 0) expand_nmax = expand_setup;
5135 /* The handling of "yes" and "no" result strings is now in a separate
5136 function that is also used by ${if} and ${extract}. */
5138 switch(process_yesno(
5139 flags, /* were previously skipping */
5140 lookup_value != NULL, /* success/failure indicator */
5141 save_lookup_value, /* value to reset for string2 */
5142 &s, /* input pointer */
5143 &yield, /* output pointer */
5144 US"lookup", /* condition type */
5147 case 1: goto EXPAND_FAILED; /* when all is well, the */
5148 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5151 /* Restore external setting of expansion variables for carrying on
5152 at this level, and continue. */
5154 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5155 save_expand_nlength);
5157 if (flags & ESI_SKIPPING) continue;
5161 /* If Perl support is configured, handle calling embedded perl subroutines,
5162 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5163 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5164 arguments (defined below). */
5166 #define EXIM_PERL_MAX_ARGS 8
5170 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
5171 "is not included in this binary";
5174 #else /* EXIM_PERL */
5176 uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5177 gstring * new_yield;
5179 if (expand_forbid & RDO_PERL)
5181 expand_string_message = US"Perl calls are not permitted";
5185 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, flags, TRUE,
5186 name, &resetok, NULL))
5188 case -1: continue; /* If skipping, we don't actually do anything */
5189 case 1: goto EXPAND_FAILED_CURLY;
5191 case 3: goto EXPAND_FAILED;
5194 /* Start the interpreter if necessary */
5196 if (!opt_perl_started)
5199 if (!opt_perl_startup)
5201 expand_string_message = US"A setting of perl_startup is needed when "
5202 "using the Perl interpreter";
5205 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5206 if ((initerror = init_perl(opt_perl_startup)))
5208 expand_string_message =
5209 string_sprintf("error in perl_startup code: %s\n", initerror);
5212 opt_perl_started = TRUE;
5215 /* Call the function */
5217 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5218 new_yield = call_perl_cat(yield, &expand_string_message,
5219 sub_arg[0], sub_arg + 1);
5221 /* NULL yield indicates failure; if the message pointer has been set to
5222 NULL, the yield was undef, indicating a forced failure. Otherwise the
5223 message will indicate some kind of Perl error. */
5227 if (!expand_string_message)
5229 expand_string_message =
5230 string_sprintf("Perl subroutine \"%s\" returned undef to force "
5231 "failure", sub_arg[0]);
5232 f.expand_string_forcedfail = TRUE;
5237 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5238 set during a callback from Perl. */
5240 f.expand_string_forcedfail = FALSE;
5244 #endif /* EXIM_PERL */
5246 /* Transform email address to "prvs" scheme to use
5247 as BATV-signed return path */
5251 uschar * sub_arg[3], * p, * domain;
5253 switch(read_subs(sub_arg, 3, 2, &s, flags, TRUE, name, &resetok, NULL))
5255 case -1: continue; /* If skipping, we don't actually do anything */
5256 case 1: goto EXPAND_FAILED_CURLY;
5258 case 3: goto EXPAND_FAILED;
5261 /* sub_arg[0] is the address */
5262 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
5263 || domain == sub_arg[0] || Ustrlen(domain) == 1)
5265 expand_string_message = US"prvs first argument must be a qualified email address";
5269 /* Calculate the hash. The third argument must be a single-digit
5270 key number, or unset. */
5273 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5275 expand_string_message = US"prvs third argument must be a single digit";
5279 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5282 expand_string_message = US"prvs hmac-sha1 conversion failed";
5286 /* Now separate the domain from the local part */
5289 yield = string_catn(yield, US"prvs=", 5);
5290 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5291 yield = string_catn(yield, prvs_daystamp(7), 3);
5292 yield = string_catn(yield, p, 6);
5293 yield = string_catn(yield, US"=", 1);
5294 yield = string_cat (yield, sub_arg[0]);
5295 yield = string_catn(yield, US"@", 1);
5296 yield = string_cat (yield, domain);
5301 /* Check a prvs-encoded address for validity */
5303 case EITEM_PRVSCHECK:
5305 uschar * sub_arg[3], * p;
5307 const pcre2_code * re;
5309 /* Reset expansion variables */
5310 prvscheck_result = NULL;
5311 prvscheck_address = NULL;
5312 prvscheck_keynum = NULL;
5314 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5316 case 1: goto EXPAND_FAILED_CURLY;
5318 case 3: goto EXPAND_FAILED;
5321 re = regex_must_compile(
5322 US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5323 MCS_CASELESS | MCS_CACHEABLE, FALSE);
5325 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5327 uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5328 uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5329 uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5330 uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5331 uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5335 debug_printf_indent("prvscheck localpart: %s\n", local_part);
5336 debug_printf_indent("prvscheck key number: %s\n", key_num);
5337 debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5338 debug_printf_indent("prvscheck hash: %s\n", hash);
5339 debug_printf_indent("prvscheck domain: %s\n", domain);
5342 /* Set up expansion variables */
5343 g = string_cat (NULL, local_part);
5344 g = string_catn(g, US"@", 1);
5345 g = string_cat (g, domain);
5346 prvscheck_address = string_from_gstring(g);
5347 prvscheck_keynum = string_copy(key_num);
5349 /* Now expand the second argument */
5350 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5352 case 1: goto EXPAND_FAILED_CURLY;
5354 case 3: goto EXPAND_FAILED;
5357 /* Now we have the key and can check the address. */
5359 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5363 expand_string_message = US"hmac-sha1 conversion failed";
5367 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5368 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
5370 if (Ustrcmp(p,hash) == 0)
5372 /* Success, valid BATV address. Now check the expiry date. */
5373 uschar *now = prvs_daystamp(0);
5374 unsigned int inow = 0,iexpire = 1;
5376 (void)sscanf(CS now,"%u",&inow);
5377 (void)sscanf(CS daystamp,"%u",&iexpire);
5379 /* When "iexpire" is < 7, a "flip" has occurred.
5380 Adjust "inow" accordingly. */
5381 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5383 if (iexpire >= inow)
5385 prvscheck_result = US"1";
5386 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
5390 prvscheck_result = NULL;
5391 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
5396 prvscheck_result = NULL;
5397 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
5400 /* Now expand the final argument. We leave this till now so that
5401 it can include $prvscheck_result. */
5403 switch(read_subs(sub_arg, 1, 0, &s, flags, TRUE, name, &resetok, NULL))
5405 case 1: goto EXPAND_FAILED_CURLY;
5407 case 3: goto EXPAND_FAILED;
5410 yield = string_cat(yield,
5411 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5413 /* Reset the "internal" variables afterwards, because they are in
5414 dynamic store that will be reclaimed if the expansion succeeded. */
5416 prvscheck_address = NULL;
5417 prvscheck_keynum = NULL;
5420 /* Does not look like a prvs encoded address, return the empty string.
5421 We need to make sure all subs are expanded first, so as to skip over
5424 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5426 case 1: goto EXPAND_FAILED_CURLY;
5428 case 3: goto EXPAND_FAILED;
5431 if (flags & ESI_SKIPPING) continue;
5435 /* Handle "readfile" to insert an entire file */
5437 case EITEM_READFILE:
5440 uschar * sub_arg[2];
5442 if ((expand_forbid & RDO_READFILE) != 0)
5444 expand_string_message = US"file insertions are not permitted";
5448 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5450 case -1: continue; /* If skipping, we don't actually do anything */
5451 case 1: goto EXPAND_FAILED_CURLY;
5453 case 3: goto EXPAND_FAILED;
5456 /* Open the file and read it */
5458 if (!(f = Ufopen(sub_arg[0], "rb")))
5460 expand_string_message = string_open_failed("%s", sub_arg[0]);
5464 yield = cat_file(f, yield, sub_arg[1]);
5469 /* Handle "readsocket" to insert data from a socket, either
5470 Inet or Unix domain */
5472 case EITEM_READSOCK:
5475 uschar * sub_arg[4];
5477 if (expand_forbid & RDO_READSOCK)
5479 expand_string_message = US"socket insertions are not permitted";
5483 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5484 because there may be a string for expansion on failure. */
5486 switch(read_subs(sub_arg, 4, 2, &s, flags, FALSE, name, &resetok, NULL))
5488 case 1: goto EXPAND_FAILED_CURLY;
5489 case 2: /* Won't occur: no end check */
5490 case 3: goto EXPAND_FAILED;
5493 /* If skipping, we don't actually do anything. Otherwise, arrange to
5494 connect to either an IP or a Unix socket. */
5496 if (!(flags & ESI_SKIPPING))
5498 int stype = search_findtype(US"readsock", 8);
5501 int expand_setup = -1;
5504 /* If the reqstr is empty, flag that and set a dummy */
5508 g = string_append_listele(g, ',', US"send=no");
5509 sub_arg[1] = US"DUMMY";
5512 /* Re-marshall the options */
5516 const uschar * list = sub_arg[2];
5520 /* First option has no tag and is timeout */
5521 if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5522 g = string_append_listele(g, ',',
5523 string_sprintf("timeout=%s", item));
5525 /* The rest of the options from the expansion */
5526 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5527 g = string_append_listele(g, ',', item);
5529 /* possibly plus an EOL string. Process with escapes, to protect
5530 from list-processing. The only current user of eol= in search
5531 options is the readsock expansion. */
5533 if (sub_arg[3] && *sub_arg[3])
5534 g = string_append_listele(g, ',',
5535 string_sprintf("eol=%s",
5536 string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5539 /* Gat a (possibly cached) handle for the connection */
5541 if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5543 if (*expand_string_message) goto EXPAND_FAILED;
5544 expand_string_message = search_error_message;
5545 search_error_message = NULL;
5549 /* Get (possibly cached) results for the lookup */
5550 /* sspec: sub_arg[0] req: sub_arg[1] opts: g */
5552 if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5553 &expand_setup, string_from_gstring(g))))
5554 yield = string_cat(yield, s);
5555 else if (f.search_find_defer)
5557 expand_string_message = search_error_message;
5558 search_error_message = NULL;
5562 { /* should not happen, at present */
5563 expand_string_message = search_error_message;
5564 search_error_message = NULL;
5569 /* The whole thing has worked (or we were skipping). If there is a
5570 failure string following, we need to skip it. */
5572 if (*s == '{') /*}*/
5574 if (!expand_string_internal(s+1,
5575 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL))
5576 goto EXPAND_FAILED; /*{*/
5579 expand_string_message = US"missing '}' closing failstring for readsocket";
5580 goto EXPAND_FAILED_CURLY;
5582 Uskip_whitespace(&s);
5585 READSOCK_DONE: /*{*/
5588 expand_string_message = US"missing '}' closing readsocket";
5589 goto EXPAND_FAILED_CURLY;
5591 if (flags & ESI_SKIPPING) continue;
5594 /* Come here on failure to create socket, connect socket, write to the
5595 socket, or timeout on reading. If another substring follows, expand and
5596 use it. Otherwise, those conditions give expand errors. */
5599 if (*s != '{') goto EXPAND_FAILED; /*}*/
5600 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5601 if (!(arg = expand_string_internal(s+1,
5602 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR, &s, &resetok, NULL)))
5604 yield = string_cat(yield, arg); /*{*/
5607 expand_string_message = US"missing '}' closing failstring for readsocket";
5608 goto EXPAND_FAILED_CURLY;
5610 Uskip_whitespace(&s);
5614 /* Handle "run" to execute a program. */
5619 const uschar * arg, ** argv;
5620 BOOL late_expand = TRUE;
5622 if (expand_forbid & RDO_RUN)
5624 expand_string_message = US"running a command is not permitted";
5628 /* Handle options to the "run" */
5632 if (Ustrncmp(++s, "preexpand", 9) == 0)
5633 { late_expand = FALSE; s += 9; }
5636 const uschar * t = s;
5637 while (isalpha(*++t)) ;
5638 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 /* Convert hex encoding to base64 encoding */
7441 for (enc = sub; *enc; enc++)
7443 if (!isxdigit(*enc))
7445 expand_string_message = string_sprintf("\"%s\" is not a hex "
7454 expand_string_message = string_sprintf("\"%s\" contains an odd "
7455 "number of characters", sub);
7459 while ((c = *in++) != 0)
7461 if (isdigit(c)) c -= '0';
7462 else c = toupper(c) - 'A' + 10;
7472 enc = b64encode(CUS sub, out - sub);
7473 yield = string_cat(yield, enc);
7477 /* Convert octets outside 0x21..0x7E to \xXX form */
7481 uschar *t = sub - 1;
7484 if (*t < 0x21 || 0x7E < *t)
7485 yield = string_fmt_append(yield, "\\x%02x", *t);
7487 yield = string_catn(yield, t, 1);
7492 /* count the number of list elements */
7496 int cnt = 0, sep = 0;
7497 uschar * buf = store_get(2, sub);
7499 while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7500 yield = string_fmt_append(yield, "%d", cnt);
7504 /* expand a named list given the name */
7505 /* handles nested named lists; requotes as colon-sep list */
7508 expand_string_message = NULL;
7509 yield = expand_listnamed(yield, sub, arg);
7510 if (expand_string_message)
7514 /* quote a list-item for the given list-separator */
7516 /* mask applies a mask to an IP address; for example the result of
7517 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7524 int type, mask, maskoffset;
7528 if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7530 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7535 if (maskoffset == 0)
7537 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7542 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7544 if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7546 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7551 /* If an optional 'n' was given, ipv6 gets normalised output:
7552 colons rather than dots, and zero-compressed. */
7554 normalised = arg && *arg == 'n';
7556 /* Convert the address to binary integer(s) and apply the mask */
7558 sub[maskoffset] = 0;
7559 count = host_aton(sub, binary);
7560 host_mask(count, binary, mask);
7562 /* Convert to masked textual format and add to output. */
7564 if (type == 4 || !normalised)
7565 yield = string_catn(yield, buffer,
7566 host_nmtoa(count, binary, mask, buffer, '.'));
7569 ipv6_nmtoa(binary, buffer);
7570 yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7576 case EOP_IPV6DENORM:
7578 int type = string_is_ip_address(sub, NULL);
7585 (void) host_aton(sub, binary);
7588 case 4: /* convert to IPv4-mapped IPv6 */
7589 binary[0] = binary[1] = 0;
7590 binary[2] = 0x0000ffff;
7591 (void) host_aton(sub, binary+3);
7595 expand_string_message =
7596 string_sprintf("\"%s\" is not an IP address", sub);
7600 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7601 ? ipv6_nmtoa(binary, buffer)
7602 : host_nmtoa(4, binary, -1, buffer, ':')
7608 case EOP_LOCAL_PART:
7612 int start, end, domain;
7613 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7616 if (c != EOP_DOMAIN)
7617 yield = c == EOP_LOCAL_PART && domain > 0
7618 ? string_catn(yield, t, domain - 1)
7619 : string_cat(yield, t);
7620 else if (domain > 0)
7621 yield = string_cat(yield, t + domain);
7627 uschar outsep[2] = { ':', '\0' };
7628 uschar *address, *error;
7629 int save_ptr = gstring_length(yield);
7630 int start, end, domain; /* Not really used */
7632 if (Uskip_whitespace(&sub) == '>')
7633 if (*outsep = *++sub) ++sub;
7636 expand_string_message = string_sprintf("output separator "
7637 "missing in expanding ${addresses:%s}", --sub);
7640 f.parse_allow_group = TRUE;
7644 uschar * p = parse_find_address_end(sub, FALSE);
7645 uschar saveend = *p;
7647 address = parse_extract_address(sub, &error, &start, &end, &domain,
7651 /* Add the address to the output list that we are building. This is
7652 done in chunks by searching for the separator character. At the
7653 start, unless we are dealing with the first address of the output
7654 list, add in a space if the new address begins with the separator
7655 character, or is an empty string. */
7659 if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7660 yield = string_catn(yield, US" ", 1);
7664 size_t seglen = Ustrcspn(address, outsep);
7665 yield = string_catn(yield, address, seglen + 1);
7667 /* If we got to the end of the string we output one character
7670 if (address[seglen] == '\0') { yield->ptr--; break; }
7671 yield = string_catn(yield, outsep, 1);
7672 address += seglen + 1;
7675 /* Output a separator after the string: we will remove the
7676 redundant final one at the end. */
7678 yield = string_catn(yield, outsep, 1);
7681 if (saveend == '\0') break;
7685 /* If we have generated anything, remove the redundant final
7688 if (yield && yield->ptr != save_ptr) yield->ptr--;
7689 f.parse_allow_group = FALSE;
7694 /* quote puts a string in quotes if it is empty or contains anything
7695 other than alphamerics, underscore, dot, or hyphen.
7697 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7698 be quoted in order to be a valid local part.
7700 In both cases, newlines and carriage returns are converted into \n and \r
7704 case EOP_QUOTE_LOCAL_PART:
7707 BOOL needs_quote = (!*sub); /* TRUE for empty string */
7708 uschar *t = sub - 1;
7711 while (!needs_quote && *++t)
7712 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7714 else /* EOP_QUOTE_LOCAL_PART */
7715 while (!needs_quote && *++t)
7716 needs_quote = !isalnum(*t)
7717 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7718 && (*t != '.' || t == sub || !t[1]);
7722 yield = string_catn(yield, US"\"", 1);
7726 yield = string_catn(yield, US"\\n", 2);
7727 else if (*t == '\r')
7728 yield = string_catn(yield, US"\\r", 2);
7731 if (*t == '\\' || *t == '"')
7732 yield = string_catn(yield, US"\\", 1);
7733 yield = string_catn(yield, t, 1);
7735 yield = string_catn(yield, US"\"", 1);
7738 yield = string_cat(yield, sub);
7742 /* quote_lookuptype does lookup-specific quoting */
7747 uschar * opt = Ustrchr(arg, '_');
7749 if (opt) *opt++ = 0;
7751 if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7753 expand_string_message = search_error_message;
7757 if (lookup_list[n]->quote)
7758 sub = (lookup_list[n]->quote)(sub, opt, (unsigned)n);
7764 expand_string_message = string_sprintf(
7765 "\"%s\" unrecognized after \"${quote_%s\"", /*}*/
7770 yield = string_cat(yield, sub);
7774 /* rx quote sticks in \ before any non-alphameric character so that
7775 the insertion works in a regular expression. */
7779 uschar *t = sub - 1;
7783 yield = string_catn(yield, US"\\", 1);
7784 yield = string_catn(yield, t, 1);
7789 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7790 prescribed by the RFC, if there are characters that need to be encoded */
7793 yield = string_cat(yield,
7794 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7798 /* RFC 2047 decode */
7804 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7805 headers_charset, '?', &len, &error);
7808 expand_string_message = error;
7811 yield = string_catn(yield, decoded, len);
7815 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7820 uschar * buff = store_get(4, sub);
7825 if (c > 255) c = '_';
7827 yield = string_catn(yield, buff, 1);
7832 /* replace illegal UTF-8 sequences by replacement character */
7834 #define UTF8_REPLACEMENT_CHAR US"?"
7838 int seq_len = 0, index = 0, bytes_left = 0, complete;
7839 long codepoint = -1;
7840 uschar seq_buff[4]; /* accumulate utf-8 here */
7842 /* Manually track tainting, as we deal in individual chars below */
7845 yield = string_get_tainted(Ustrlen(sub), sub);
7846 else if (!yield->s || !yield->ptr)
7848 yield->s = store_get(yield->size = Ustrlen(sub), sub);
7849 gstring_reset(yield);
7851 else if (is_incompatible(yield->s, sub))
7852 gstring_rebuffer(yield, sub);
7854 /* Check the UTF-8, byte-by-byte */
7863 if ((c & 0xc0) != 0x80)
7864 /* wrong continuation byte; invalidate all bytes */
7865 complete = 1; /* error */
7868 codepoint = (codepoint << 6) | (c & 0x3f);
7869 seq_buff[index++] = c;
7870 if (--bytes_left == 0) /* codepoint complete */
7871 if(codepoint > 0x10FFFF) /* is it too large? */
7872 complete = -1; /* error (RFC3629 limit) */
7874 { /* finished; output utf-8 sequence */
7875 yield = string_catn(yield, seq_buff, seq_len);
7880 else /* no bytes left: new sequence */
7882 if(!(c & 0x80)) /* 1-byte sequence, US-ASCII, keep it */
7884 yield = string_catn(yield, &c, 1);
7887 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7889 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7894 codepoint = c & 0x1f;
7897 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7900 codepoint = c & 0x0f;
7902 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7905 codepoint = c & 0x07;
7907 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7910 seq_buff[index++] = c;
7911 seq_len = bytes_left + 1;
7912 } /* if(bytes_left) */
7916 bytes_left = index = 0;
7917 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7919 if ((complete == 1) && ((c & 0x80) == 0))
7920 /* ASCII character follows incomplete sequence */
7921 yield = string_catn(yield, &c, 1);
7923 /* If given a sequence truncated mid-character, we also want to report ?
7924 Eg, ${length_1:フィル} is one byte, not one character, so we expect
7925 ${utf8clean:${length_1:フィル}} to yield '?' */
7927 if (bytes_left != 0)
7928 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7934 case EOP_UTF8_DOMAIN_TO_ALABEL:
7936 uschar * error = NULL;
7937 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7940 expand_string_message = string_sprintf(
7941 "error converting utf8 (%s) to alabel: %s",
7942 string_printing(sub), error);
7945 yield = string_cat(yield, s);
7949 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7951 uschar * error = NULL;
7952 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7955 expand_string_message = string_sprintf(
7956 "error converting alabel (%s) to utf8: %s",
7957 string_printing(sub), error);
7960 yield = string_cat(yield, s);
7964 case EOP_UTF8_LOCALPART_TO_ALABEL:
7966 uschar * error = NULL;
7967 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7970 expand_string_message = string_sprintf(
7971 "error converting utf8 (%s) to alabel: %s",
7972 string_printing(sub), error);
7975 yield = string_cat(yield, s);
7976 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", string_from_gstring(yield));
7980 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7982 uschar * error = NULL;
7983 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7986 expand_string_message = string_sprintf(
7987 "error converting alabel (%s) to utf8: %s",
7988 string_printing(sub), error);
7991 yield = string_cat(yield, s);
7994 #endif /* EXPERIMENTAL_INTERNATIONAL */
7996 /* escape turns all non-printing characters into escape sequences. */
8000 const uschar * t = string_printing(sub);
8001 yield = string_cat(yield, t);
8005 case EOP_ESCAPE8BIT:
8009 for (const uschar * s = sub; (c = *s); s++)
8010 yield = c < 127 && c != '\\'
8011 ? string_catn(yield, s, 1)
8012 : string_fmt_append(yield, "\\%03o", c);
8016 /* Handle numeric expression evaluation */
8021 uschar *save_sub = sub;
8022 uschar *error = NULL;
8023 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
8026 expand_string_message = string_sprintf("error in expression "
8027 "evaluation: %s (after processing \"%.*s\")", error,
8028 (int)(sub-save_sub), save_sub);
8031 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
8035 /* Handle time period formatting */
8039 int n = readconf_readtime(sub, 0, FALSE);
8042 expand_string_message = string_sprintf("string \"%s\" is not an "
8043 "Exim time interval in \"%s\" operator", sub, name);
8046 yield = string_fmt_append(yield, "%d", n);
8050 case EOP_TIME_INTERVAL:
8053 uschar *t = read_number(&n, sub);
8054 if (*t != 0) /* Not A Number*/
8056 expand_string_message = string_sprintf("string \"%s\" is not a "
8057 "positive number in \"%s\" operator", sub, name);
8060 t = readconf_printtime(n);
8061 yield = string_cat(yield, t);
8065 /* Convert string to base64 encoding */
8071 uschar * s = vp && *(void **)vp->value
8072 ? tls_cert_der_b64(*(void **)vp->value)
8073 : b64encode(CUS sub, Ustrlen(sub));
8075 uschar * s = b64encode(CUS sub, Ustrlen(sub));
8077 yield = string_cat(yield, s);
8084 int len = b64decode(sub, &s);
8087 expand_string_message = string_sprintf("string \"%s\" is not "
8088 "well-formed for \"%s\" operator", sub, name);
8091 yield = string_cat(yield, s);
8095 /* strlen returns the length of the string */
8098 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
8101 /* length_n or l_n takes just the first n characters or the whole string,
8102 whichever is the shorter;
8104 substr_m_n, and s_m_n take n characters from offset m; negative m take
8105 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
8106 takes the rest, either to the right or to the left.
8108 hash_n or h_n makes a hash of length n from the string, yielding n
8109 characters from the set a-z; hash_n_m makes a hash of length n, but
8110 uses m characters from the set a-zA-Z0-9.
8112 nhash_n returns a single number between 0 and n-1 (in text form), while
8113 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
8114 between 0 and n-1 and the second between 0 and m-1. */
8134 expand_string_message = string_sprintf("missing values after %s",
8139 /* "length" has only one argument, effectively being synonymous with
8142 if (c == EOP_LENGTH || c == EOP_L)
8148 /* The others have one or two arguments; for "substr" the first may be
8149 negative. The second being negative means "not supplied". */
8154 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8157 /* Read up to two numbers, separated by underscores */
8162 if (arg != ret && *arg == '_' && pn == &value1)
8166 if (arg[1] != 0) arg++;
8168 else if (!isdigit(*arg))
8170 expand_string_message =
8171 string_sprintf("non-digit after underscore in \"%s\"", name);
8174 else *pn = (*pn)*10 + *arg++ - '0';
8178 /* Perform the required operation */
8180 ret = c == EOP_HASH || c == EOP_H
8181 ? compute_hash(sub, value1, value2, &len)
8182 : c == EOP_NHASH || c == EOP_NH
8183 ? compute_nhash(sub, value1, value2, &len)
8184 : extract_substr(sub, value1, value2, &len);
8185 if (!ret) goto EXPAND_FAILED;
8187 yield = string_catn(yield, ret, len);
8196 uschar **modetable[3];
8200 if (expand_forbid & RDO_EXISTS)
8202 expand_string_message = US"Use of the stat() expansion is not permitted";
8206 if (stat(CS sub, &st) < 0)
8208 expand_string_message = string_sprintf("stat(%s) failed: %s",
8209 sub, strerror(errno));
8213 switch (mode & S_IFMT)
8215 case S_IFIFO: smode[0] = 'p'; break;
8216 case S_IFCHR: smode[0] = 'c'; break;
8217 case S_IFDIR: smode[0] = 'd'; break;
8218 case S_IFBLK: smode[0] = 'b'; break;
8219 case S_IFREG: smode[0] = '-'; break;
8220 default: smode[0] = '?'; break;
8223 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8224 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8225 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8227 for (int i = 0; i < 3; i++)
8229 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8234 yield = string_fmt_append(yield,
8235 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8236 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8237 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8238 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8239 (long)st.st_gid, st.st_size, (long)st.st_atime,
8240 (long)st.st_mtime, (long)st.st_ctime);
8244 /* vaguely random number less than N */
8248 int_eximarith_t max = expanded_string_integer(sub, TRUE);
8250 if (expand_string_message)
8252 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8256 /* Reverse IP, including IPv6 to dotted-nibble */
8258 case EOP_REVERSE_IP:
8260 int family, maskptr;
8261 uschar reversed[128];
8263 family = string_is_ip_address(sub, &maskptr);
8266 expand_string_message = string_sprintf(
8267 "reverse_ip() not given an IP address [%s]", sub);
8270 invert_address(reversed, sub);
8271 yield = string_cat(yield, reversed);
8275 /* Unknown operator */
8278 expand_string_message =
8279 string_sprintf("unknown expansion operator \"%s\"", name);
8281 } /* EOP_* switch */
8285 const uschar * res = string_from_gstring(yield);
8286 const uschar * s = res + expansion_start;
8287 int i = gstring_length(yield) - expansion_start;
8288 BOOL tainted = is_tainted(s);
8292 debug_printf_indent("|-----op-res: %.*s\n", i, s);
8295 debug_printf_indent("%s \\__", flags & ESI_SKIPPING ? "| " : " ");
8296 debug_print_taint(res);
8301 debug_printf_indent(UTF8_VERT_RIGHT
8302 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8303 "op-res: %.*s\n", i, s);
8306 debug_printf_indent("%s",
8307 flags & ESI_SKIPPING
8308 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8309 debug_print_taint(res);
8317 /* Not an item or an operator */
8318 /* Handle a plain name. If this is the first thing in the expansion, release
8319 the pre-allocated buffer. If the result data is known to be in a new buffer,
8320 newsize will be set to the size of that buffer, and we can just point at that
8321 store instead of copying. Many expansion strings contain just one reference,
8322 so this is a useful optimization, especially for humungous headers
8323 ($message_headers). */
8327 const uschar * value;
8333 g = store_get(sizeof(gstring), GET_UNTAINTED);
8334 else if (yield->ptr == 0)
8336 if (resetok) reset_point = store_reset(reset_point);
8338 reset_point = store_mark();
8339 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
8341 if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
8343 expand_string_message =
8344 string_sprintf("unknown variable in \"${%s}\"", name);
8345 check_variable_error_message(name);
8348 len = Ustrlen(value);
8349 if (!yield && newsize)
8352 yield->size = newsize;
8354 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8357 yield = string_catn(yield, value, len);
8361 /* Else there's something wrong */
8363 expand_string_message =
8364 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8365 "in a variable reference)", name);
8369 /* If we hit the end of the string when brace_ends is set, there is a missing
8370 terminating brace. */
8372 if (flags & ESI_BRACE_ENDS && !*s)
8374 expand_string_message = malformed_header
8375 ? US"missing } at end of string - could be header name not terminated by colon"
8376 : US"missing } at end of string";
8380 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8381 added to the string. If so, set up an empty string. Add a terminating zero. If
8382 left != NULL, return a pointer to the terminator. */
8388 yield = string_get(1);
8389 res = string_from_gstring(yield);
8390 if (left) *left = s;
8392 /* Any stacking store that was used above the final string is no longer needed.
8393 In many cases the final string will be the first one that was got and so there
8394 will be optimal store usage. */
8396 if (resetok) gstring_release_unused(yield);
8397 else if (resetok_p) *resetok_p = FALSE;
8401 BOOL tainted = is_tainted(res);
8404 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8405 debug_printf_indent("%sresult: %s\n",
8406 flags & ESI_SKIPPING ? "|-----" : "\\_____", res);
8409 debug_printf_indent("%s \\__", flags & ESI_SKIPPING ? "| " : " ");
8410 debug_print_taint(res);
8412 if (flags & ESI_SKIPPING)
8413 debug_printf_indent("\\___skipping: result is not used\n");
8417 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8418 "expanding: %.*s\n",
8419 (int)(s - string), string);
8420 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8422 flags & ESI_SKIPPING ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8426 debug_printf_indent("%s",
8427 flags & ESI_SKIPPING
8428 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8429 debug_print_taint(res);
8431 if (flags & ESI_SKIPPING)
8432 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8433 "skipping: result is not used\n");
8436 if (textonly_p) *textonly_p = textonly;
8441 /* This is the failure exit: easiest to program with a goto. We still need
8442 to update the pointer to the terminator, for cases of nested calls with "fail".
8445 EXPAND_FAILED_CURLY:
8446 if (malformed_header)
8447 expand_string_message =
8448 US"missing or misplaced { or } - could be header name not terminated by colon";
8450 else if (!expand_string_message || !*expand_string_message)
8451 expand_string_message = US"missing or misplaced { or }";
8453 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8454 that is a bad idea, because expand_string_message is in dynamic store. */
8457 if (left) *left = s;
8462 debug_printf_indent("|failed to expand: %s\n", string);
8463 debug_printf_indent("%serror message: %s\n",
8464 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8465 if (f.expand_string_forcedfail)
8466 debug_printf_indent("\\failure was forced\n");
8470 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8472 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8473 "error message: %s\n",
8474 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8475 expand_string_message);
8476 if (f.expand_string_forcedfail)
8477 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8480 if (resetok_p && !resetok) *resetok_p = FALSE;
8487 /* This is the external function call. Do a quick check for any expansion
8488 metacharacters, and if there are none, just return the input string.
8491 the string to be expanded
8492 optional pointer for return boolean indicating no-dynamic-expansions
8494 Returns: the expanded string, or NULL if expansion failed; if failure was
8495 due to a lookup deferring, search_find_defer will be TRUE
8499 expand_string_2(const uschar * string, BOOL * textonly_p)
8501 if (Ustrpbrk(string, "$\\") != NULL)
8503 int old_pool = store_pool;
8506 f.search_find_defer = FALSE;
8507 malformed_header = FALSE;
8508 store_pool = POOL_MAIN;
8509 s = expand_string_internal(string, ESI_HONOR_DOLLAR, NULL, NULL, textonly_p);
8510 store_pool = old_pool;
8513 if (textonly_p) *textonly_p = TRUE;
8518 expand_cstring(const uschar * string)
8519 { return expand_string_2(string, NULL); }
8522 expand_string(uschar * string)
8523 { return US expand_string_2(CUS string, NULL); }
8530 /*************************************************
8532 *************************************************/
8534 /* Now and again we want to expand a string and be sure that the result is in a
8535 new bit of store. This function does that.
8536 Since we know it has been copied, the de-const cast is safe.
8538 Argument: the string to be expanded
8539 Returns: the expanded string, always in a new bit of store, or NULL
8543 expand_string_copy(const uschar *string)
8545 const uschar *yield = expand_cstring(string);
8546 if (yield == string) yield = string_copy(string);
8552 /*************************************************
8553 * Expand and interpret as an integer *
8554 *************************************************/
8556 /* Expand a string, and convert the result into an integer.
8559 string the string to be expanded
8560 isplus TRUE if a non-negative number is expected
8562 Returns: the integer value, or
8563 -1 for an expansion error ) in both cases, message in
8564 -2 for an integer interpretation error ) expand_string_message
8565 expand_string_message is set NULL for an OK integer
8569 expand_string_integer(uschar *string, BOOL isplus)
8571 return expanded_string_integer(expand_string(string), isplus);
8575 /*************************************************
8576 * Interpret string as an integer *
8577 *************************************************/
8579 /* Convert a string (that has already been expanded) into an integer.
8581 This function is used inside the expansion code.
8584 s the string to be expanded
8585 isplus TRUE if a non-negative number is expected
8587 Returns: the integer value, or
8588 -1 if string is NULL (which implies an expansion error)
8589 -2 for an integer interpretation error
8590 expand_string_message is set NULL for an OK integer
8593 static int_eximarith_t
8594 expanded_string_integer(const uschar *s, BOOL isplus)
8596 int_eximarith_t value;
8597 uschar *msg = US"invalid integer \"%s\"";
8600 /* If expansion failed, expand_string_message will be set. */
8604 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8605 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8606 systems, so we set it zero ourselves. */
8609 expand_string_message = NULL; /* Indicates no error */
8611 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8612 equal to 0. Unfortunately, people actually relied upon that, so preserve
8613 the behaviour explicitly. Stripping leading whitespace is a harmless
8614 noop change since strtol skips it anyway (provided that there is a number
8617 if (Uskip_whitespace(&s) == '\0')
8620 debug_printf_indent("treating blank string as number 0\n");
8624 value = strtoll(CS s, CSS &endptr, 10);
8627 msg = US"integer expected but \"%s\" found";
8628 else if (value < 0 && isplus)
8629 msg = US"non-negative integer expected but \"%s\" found";
8632 switch (tolower(*endptr))
8637 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8642 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8643 else value *= 1024*1024;
8647 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8648 else value *= 1024*1024*1024;
8652 if (errno == ERANGE)
8653 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8655 if (Uskip_whitespace(&endptr) == 0) return value;
8658 expand_string_message = string_sprintf(CS msg, s);
8663 /* These values are usually fixed boolean values, but they are permitted to be
8667 addr address being routed
8668 mtype the module type
8669 mname the module name
8670 dbg_opt debug selectors
8671 oname the option name
8672 bvalue the router's boolean value
8673 svalue the router's string value
8674 rvalue where to put the returned value
8676 Returns: OK value placed in rvalue
8677 DEFER expansion failed
8681 exp_bool(address_item *addr,
8682 uschar *mtype, uschar *mname, unsigned dbg_opt,
8683 uschar *oname, BOOL bvalue,
8684 uschar *svalue, BOOL *rvalue)
8687 if (!svalue) { *rvalue = bvalue; return OK; }
8689 if (!(expanded = expand_string(svalue)))
8691 if (f.expand_string_forcedfail)
8693 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8697 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8698 oname, mname, mtype, expand_string_message);
8699 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8703 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8706 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8708 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8712 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8713 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8722 /* Avoid potentially exposing a password in a string about to be logged */
8725 expand_hide_passwords(uschar * s)
8727 return ( ( Ustrstr(s, "failed to expand") != NULL
8728 || Ustrstr(s, "expansion of ") != NULL
8730 && ( Ustrstr(s, "mysql") != NULL
8731 || Ustrstr(s, "pgsql") != NULL
8732 || Ustrstr(s, "redis") != NULL
8733 || Ustrstr(s, "sqlite") != NULL
8734 || Ustrstr(s, "ldap:") != NULL
8735 || Ustrstr(s, "ldaps:") != NULL
8736 || Ustrstr(s, "ldapi:") != NULL
8737 || Ustrstr(s, "ldapdn:") != NULL
8738 || Ustrstr(s, "ldapm:") != NULL
8740 ? US"Temporary internal error" : s;
8744 /* Read given named file into big_buffer. Use for keying material etc.
8745 The content will have an ascii NUL appended.
8750 Return: pointer to buffer, or NULL on error.
8754 expand_file_big_buffer(const uschar * filename)
8756 int fd, off = 0, len;
8758 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8760 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8767 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8770 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8778 big_buffer[off] = '\0';
8784 /*************************************************
8785 * Error-checking for testsuite *
8786 *************************************************/
8788 uschar * region_start;
8789 uschar * region_end;
8790 const uschar *var_name;
8791 const uschar *var_data;
8794 /* Called via tree_walk, which allows nonconst name/data. Our usage is const. */
8796 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8799 if (var_data >= e->region_start && var_data < e->region_end)
8801 e->var_name = CUS var_name;
8802 e->var_data = CUS var_data;
8807 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8809 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8810 .var_name = NULL, .var_data = NULL };
8812 /* check acl_ variables */
8813 tree_walk(acl_var_c, assert_variable_notin, &e);
8814 tree_walk(acl_var_m, assert_variable_notin, &e);
8816 /* check auth<n> variables.
8817 assert_variable_notin() treats as const, so deconst is safe. */
8818 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8819 assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8821 #ifdef WITH_CONTENT_SCAN
8822 /* check regex<n> variables. assert_variable_notin() treats as const. */
8823 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8824 assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8827 /* check known-name variables */
8828 for (var_entry * v = var_table; v < var_table + nelem(var_table); v++)
8829 if (v->type == vtype_stringptr)
8830 assert_variable_notin(US v->name, *(USS v->value), &e);
8832 /* check dns and address trees */
8833 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8834 tree_walk(tree_duplicates, assert_variable_notin, &e);
8835 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8836 tree_walk(tree_unusable, assert_variable_notin, &e);
8839 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8840 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8841 e.var_name, filename, linenumber, e.var_data);
8846 /*************************************************
8847 **************************************************
8848 * Stand-alone test program *
8849 **************************************************
8850 *************************************************/
8856 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8858 int ovec[3*(EXPAND_MAXN+1)];
8859 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8861 BOOL yield = n >= 0;
8862 if (n == 0) n = EXPAND_MAXN + 1;
8865 expand_nmax = setup < 0 ? 0 : setup + 1;
8866 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8868 expand_nstring[expand_nmax] = subject + ovec[nn];
8869 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8877 int main(int argc, uschar **argv)
8879 uschar buffer[1024];
8881 debug_selector = D_v;
8882 debug_file = stderr;
8883 debug_fd = fileno(debug_file);
8884 big_buffer = malloc(big_buffer_size);
8887 for (int i = 1; i < argc; i++)
8889 if (argv[i][0] == '+')
8891 debug_trace_memory = 2;
8894 if (isdigit(argv[i][0]))
8895 debug_selector = Ustrtol(argv[i], NULL, 0);
8897 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8901 eldap_default_servers = argv[i];
8904 mysql_servers = argv[i];
8907 pgsql_servers = argv[i];
8910 redis_servers = argv[i];
8914 else opt_perl_startup = argv[i];
8918 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8920 expand_nstring[1] = US"string 1....";
8921 expand_nlength[1] = 8;
8925 if (opt_perl_startup != NULL)
8928 printf("Starting Perl interpreter\n");
8929 errstr = init_perl(opt_perl_startup);
8932 printf("** error in perl_startup code: %s\n", errstr);
8933 return EXIT_FAILURE;
8936 #endif /* EXIM_PERL */
8938 /* Thie deliberately regards the input as untainted, so that it can be
8939 expanded; only reasonable since this is a test for string-expansions. */
8941 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8943 rmark reset_point = store_mark();
8944 uschar *yield = expand_string(buffer);
8946 printf("%s\n", yield);
8949 if (f.search_find_defer) printf("search_find deferred\n");
8950 printf("Failed: %s\n", expand_string_message);
8951 if (f.expand_string_forcedfail) printf("Forced failure\n");
8954 store_reset(reset_point);
8962 #endif /*STAND_ALONE*/
8964 #endif /*!MACRO_PREDEF*/
8967 /* End of expand.c */