1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2024 */
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 */
25 #define ESI_EXISTS_ONLY BIT(3) /* actual value not needed */
28 # ifndef SUPPORT_CRYPTEQ
29 # define SUPPORT_CRYPTEQ
31 #endif /*!STAND_ALONE*/
33 #ifdef SUPPORT_CRYPTEQ
38 extern char* crypt16(char*, char*);
42 /* The handling of crypt16() is a mess. I will record below the analysis of the
43 mess that was sent to me. We decided, however, to make changing this very low
44 priority, because in practice people are moving away from the crypt()
45 algorithms nowadays, so it doesn't seem worth it.
48 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
49 the first 8 characters of the password using a 20-round version of crypt
50 (standard crypt does 25 rounds). It then crypts the next 8 characters,
51 or an empty block if the password is less than 9 characters, using a
52 20-round version of crypt and the same salt as was used for the first
53 block. Characters after the first 16 are ignored. It always generates
54 a 16-byte hash, which is expressed together with the salt as a string
55 of 24 base 64 digits. Here are some links to peruse:
57 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
58 http://seclists.org/bugtraq/1999/Mar/0076.html
60 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
61 and OSF/1. This is the same as the standard crypt if given a password
62 of 8 characters or less. If given more, it first does the same as crypt
63 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
64 using as salt the first two base 64 digits from the first hash block.
65 If the password is more than 16 characters then it crypts the 17th to 24th
66 characters using as salt the first two base 64 digits from the second hash
67 block. And so on: I've seen references to it cutting off the password at
68 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
70 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
71 http://seclists.org/bugtraq/1999/Mar/0109.html
72 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
73 TET1_html/sec.c222.html#no_id_208
75 Exim has something it calls "crypt16". It will either use a native
76 crypt16 or its own implementation. A native crypt16 will presumably
77 be the one that I called "crypt16" above. The internal "crypt16"
78 function, however, is a two-block-maximum implementation of what I called
79 "bigcrypt". The documentation matches the internal code.
81 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
82 that crypt16 and bigcrypt were different things.
84 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
85 to whatever it is using under that name. This unfortunately sets a
86 precedent for using "{crypt16}" to identify two incompatible algorithms
87 whose output can't be distinguished. With "{crypt16}" thus rendered
88 ambiguous, I suggest you deprecate it and invent two new identifiers
89 for the two algorithms.
91 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
92 of the password separately means they can be cracked separately, so
93 the double-length hash only doubles the cracking effort instead of
94 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
101 /*************************************************
102 * Local statics and tables *
103 *************************************************/
105 /* Table of item names, and corresponding switch numbers. The names must be in
106 alphabetical order. */
108 static uschar *item_table[] = {
178 /* Tables of operator names, and corresponding switch numbers. The names must be
179 in alphabetical order. There are two tables, because underscore is used in some
180 cases to introduce arguments, whereas for other it is part of the name. This is
181 an historical mis-design. */
183 static uschar * op_table_underscore[] = {
186 US"quote_local_part",
191 ,US"utf8_domain_from_alabel",
192 US"utf8_domain_to_alabel",
193 US"utf8_localpart_from_alabel",
194 US"utf8_localpart_to_alabel"
201 EOP_QUOTE_LOCAL_PART,
206 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
207 EOP_UTF8_DOMAIN_TO_ALABEL,
208 EOP_UTF8_LOCALPART_FROM_ALABEL,
209 EOP_UTF8_LOCALPART_TO_ALABEL
213 static uschar *op_table_main[] = {
264 EOP_ADDRESS = nelem(op_table_underscore),
314 /* Table of condition names, and corresponding switch numbers. The names must
315 be in alphabetical order. */
317 static uschar *cond_table[] = {
321 US"==", /* Backward compatibility */
361 US"match_local_part",
386 ECOND_FIRST_DELIVERY,
414 ECOND_MATCH_LOCAL_PART,
424 /* Type for entries pointing to address/length pairs. Not currently
432 typedef uschar * stringptr_fn_t(void);
433 static uschar * fn_recipients(void);
434 static uschar * fn_recipients_list(void);
435 static uschar * fn_queue_size(void);
437 /* This table must be kept in alphabetical order. */
439 static var_entry var_table[] = {
440 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
441 they will be confused with user-creatable ACL variables. */
442 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
443 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
444 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
445 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
446 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
447 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
448 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
449 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
450 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
451 { "acl_narg", vtype_int, &acl_narg },
452 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
453 { "address_data", vtype_stringptr, &deliver_address_data },
454 { "address_file", vtype_stringptr, &address_file },
455 { "address_pipe", vtype_stringptr, &address_pipe },
456 #ifdef EXPERIMENTAL_ARC
457 { "arc_domains", vtype_module, US"arc" },
458 { "arc_oldest_pass", vtype_module, US"arc" },
459 { "arc_state", vtype_module, US"arc" },
460 { "arc_state_reason", vtype_module, US"arc" },
462 { "atrn_host", vtype_stringptr, &atrn_host },
463 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
464 { "authenticated_id", vtype_stringptr, &authenticated_id },
465 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
466 { "authentication_failed",vtype_int, &authentication_failed },
467 #ifdef WITH_CONTENT_SCAN
468 { "av_failed", vtype_int, &av_failed },
470 #ifdef EXPERIMENTAL_BRIGHTMAIL
471 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
472 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
473 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
474 { "bmi_deliver", vtype_int, &bmi_deliver },
476 { "body_linecount", vtype_int, &body_linecount },
477 { "body_zerocount", vtype_int, &body_zerocount },
478 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
479 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
480 { "caller_gid", vtype_gid, &real_gid },
481 { "caller_uid", vtype_uid, &real_uid },
482 { "callout_address", vtype_stringptr, &callout_address },
483 { "compile_date", vtype_stringptr, &version_date },
484 { "compile_number", vtype_stringptr, &version_cnumber },
485 { "config_dir", vtype_stringptr, &config_main_directory },
486 { "config_file", vtype_stringptr, &config_main_filename },
487 { "connection_id", vtype_stringptr, &connection_id },
488 { "csa_status", vtype_stringptr, &csa_status },
489 #ifdef EXPERIMENTAL_DCC
490 { "dcc_header", vtype_stringptr, &dcc_header },
491 { "dcc_result", vtype_stringptr, &dcc_result },
494 { "dkim_algo", vtype_module, US"dkim" },
495 { "dkim_bodylength", vtype_module, US"dkim" },
496 { "dkim_canon_body", vtype_module, US"dkim" },
497 { "dkim_canon_headers", vtype_module, US"dkim" },
498 { "dkim_copiedheaders", vtype_module, US"dkim" },
499 { "dkim_created", vtype_module, US"dkim" },
500 { "dkim_cur_signer", vtype_module, US"dkim" },
501 { "dkim_domain", vtype_module, US"dkim" },
502 { "dkim_expires", vtype_module, US"dkim" },
503 { "dkim_headernames", vtype_module, US"dkim" },
504 { "dkim_identity", vtype_module, US"dkim" },
505 { "dkim_key_granularity",vtype_module, US"dkim" },
506 { "dkim_key_length", vtype_module, US"dkim" },
507 { "dkim_key_nosubdomains",vtype_module, US"dkim" },
508 { "dkim_key_notes", vtype_module, US"dkim" },
509 { "dkim_key_srvtype", vtype_module, US"dkim" },
510 { "dkim_key_testing", vtype_module, US"dkim" },
511 { "dkim_selector", vtype_module, US"dkim" },
512 { "dkim_signers", vtype_module, US"dkim" },
513 { "dkim_verify_reason", vtype_module, US"dkim" },
514 { "dkim_verify_signers", vtype_module, US"dkim" },
515 { "dkim_verify_status", vtype_module, US"dkim" },
518 { "dmarc_alignment_dkim",vtype_module, US"dmarc" },
519 { "dmarc_alignment_spf", vtype_module, US"dmarc" },
520 { "dmarc_domain_policy", vtype_module, US"dmarc" },
521 { "dmarc_status", vtype_module, US"dmarc" },
522 { "dmarc_status_text", vtype_module, US"dmarc" },
523 { "dmarc_used_domain", vtype_module, US"dmarc" },
525 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
526 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
527 { "dnslist_text", vtype_stringptr, &dnslist_text },
528 { "dnslist_value", vtype_stringptr, &dnslist_value },
529 { "domain", vtype_stringptr, &deliver_domain },
530 { "domain_data", vtype_stringptr, &deliver_domain_data },
531 #ifndef DISABLE_EVENT
532 { "event_data", vtype_stringptr, &event_data },
534 /*XXX want to use generic vars for as many of these as possible*/
535 { "event_defer_errno", vtype_int, &event_defer_errno },
537 { "event_name", vtype_stringptr, &event_name },
539 { "exim_gid", vtype_gid, &exim_gid },
540 { "exim_path", vtype_stringptr, &exim_path },
541 { "exim_uid", vtype_uid, &exim_uid },
542 { "exim_version", vtype_stringptr, &version_string },
543 { "headers_added", vtype_string_func, (void *) &fn_hdrs_added },
544 { "home", vtype_stringptr, &deliver_home },
545 { "host", vtype_stringptr, &deliver_host },
546 { "host_address", vtype_stringptr, &deliver_host_address },
547 { "host_data", vtype_stringptr, &host_data },
548 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
549 { "host_lookup_failed", vtype_int, &host_lookup_failed },
550 { "host_port", vtype_int, &deliver_host_port },
551 { "initial_cwd", vtype_stringptr, &initial_cwd },
552 { "inode", vtype_ino, &deliver_inode },
553 { "interface_address", vtype_stringptr, &interface_address },
554 { "interface_port", vtype_int, &interface_port },
555 { "item", vtype_stringptr, &iterate_item },
557 { "ldap_dn", vtype_stringptr, &eldap_dn },
559 { "load_average", vtype_load_avg, NULL },
560 { "local_part", vtype_stringptr, &deliver_localpart },
561 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
562 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
563 { "local_part_prefix_v", vtype_stringptr, &deliver_localpart_prefix_v },
564 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
565 { "local_part_suffix_v", vtype_stringptr, &deliver_localpart_suffix_v },
566 #ifdef HAVE_LOCAL_SCAN
567 { "local_scan_data", vtype_stringptr, &local_scan_data },
569 { "local_user_gid", vtype_gid, &local_user_gid },
570 { "local_user_uid", vtype_uid, &local_user_uid },
571 { "localhost_number", vtype_int, &host_number },
572 { "log_inodes", vtype_pinodes, (void *)FALSE },
573 { "log_space", vtype_pspace, (void *)FALSE },
574 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
575 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
576 #ifdef WITH_CONTENT_SCAN
577 { "malware_name", vtype_stringptr, &malware_name },
579 { "max_received_linelength", vtype_int, &max_received_linelength },
580 { "message_age", vtype_int, &message_age },
581 { "message_body", vtype_msgbody, &message_body },
582 { "message_body_end", vtype_msgbody_end, &message_body_end },
583 { "message_body_size", vtype_int, &message_body_size },
584 { "message_exim_id", vtype_stringptr, &message_id },
585 { "message_headers", vtype_msgheaders, NULL },
586 { "message_headers_raw", vtype_msgheaders_raw, NULL },
587 { "message_id", vtype_stringptr, &message_id },
588 { "message_linecount", vtype_int, &message_linecount },
589 { "message_size", vtype_int, &message_size },
591 { "message_smtputf8", vtype_bool, &message_smtputf8 },
593 #ifdef WITH_CONTENT_SCAN
594 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
595 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
596 { "mime_boundary", vtype_stringptr, &mime_boundary },
597 { "mime_charset", vtype_stringptr, &mime_charset },
598 { "mime_content_description", vtype_stringptr, &mime_content_description },
599 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
600 { "mime_content_id", vtype_stringptr, &mime_content_id },
601 { "mime_content_size", vtype_int, &mime_content_size },
602 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
603 { "mime_content_type", vtype_stringptr, &mime_content_type },
604 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
605 { "mime_filename", vtype_stringptr, &mime_filename },
606 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
607 { "mime_is_multipart", vtype_int, &mime_is_multipart },
608 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
609 { "mime_part_count", vtype_int, &mime_part_count },
611 { "n0", vtype_filter_int, &filter_n[0] },
612 { "n1", vtype_filter_int, &filter_n[1] },
613 { "n2", vtype_filter_int, &filter_n[2] },
614 { "n3", vtype_filter_int, &filter_n[3] },
615 { "n4", vtype_filter_int, &filter_n[4] },
616 { "n5", vtype_filter_int, &filter_n[5] },
617 { "n6", vtype_filter_int, &filter_n[6] },
618 { "n7", vtype_filter_int, &filter_n[7] },
619 { "n8", vtype_filter_int, &filter_n[8] },
620 { "n9", vtype_filter_int, &filter_n[9] },
621 { "original_domain", vtype_stringptr, &deliver_domain_orig },
622 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
623 { "originator_gid", vtype_gid, &originator_gid },
624 { "originator_uid", vtype_uid, &originator_uid },
625 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
626 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
627 { "pid", vtype_pid, NULL },
629 { "prdr_requested", vtype_bool, &prdr_requested },
631 { "primary_hostname", vtype_stringptr, &primary_hostname },
632 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
633 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
634 { "proxy_external_port", vtype_int, &proxy_external_port },
635 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
636 { "proxy_local_port", vtype_int, &proxy_local_port },
637 { "proxy_session", vtype_bool, &proxy_session },
639 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
640 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
641 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
642 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
643 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
644 { "queue_name", vtype_stringptr, &queue_name },
645 { "queue_size", vtype_string_func, (void *) &fn_queue_size },
646 { "rcpt_count", vtype_int, &rcpt_count },
647 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
648 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
649 { "received_count", vtype_int, &received_count },
650 { "received_for", vtype_stringptr, &received_for },
651 { "received_ip_address", vtype_stringptr, &interface_address },
652 { "received_port", vtype_int, &interface_port },
653 { "received_protocol", vtype_stringptr, &received_protocol },
654 { "received_time", vtype_int, &received_time.tv_sec },
655 { "recipient_data", vtype_stringptr, &recipient_data },
656 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
657 { "recipients", vtype_string_func, (void *) &fn_recipients },
658 { "recipients_count", vtype_int, &recipients_count },
659 { "recipients_list", vtype_string_func, (void *) &fn_recipients_list },
660 { "regex_cachesize", vtype_int, ®ex_cachesize },/* undocumented; devel observability */
661 #ifdef WITH_CONTENT_SCAN
662 { "regex_match_string", vtype_stringptr, ®ex_match_string },
664 { "reply_address", vtype_reply, NULL },
665 { "return_path", vtype_stringptr, &return_path },
666 { "return_size_limit", vtype_int, &bounce_return_size_limit },
667 { "router_name", vtype_stringptr, &router_name },
668 { "runrc", vtype_int, &runrc },
669 { "self_hostname", vtype_stringptr, &self_hostname },
670 { "sender_address", vtype_stringptr, &sender_address },
671 { "sender_address_data", vtype_stringptr, &sender_address_data },
672 { "sender_address_domain", vtype_domain, &sender_address },
673 { "sender_address_local_part", vtype_localpart, &sender_address },
674 { "sender_data", vtype_stringptr, &sender_data },
675 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
676 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
677 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
678 { "sender_helo_verified",vtype_string_func, (void *) &sender_helo_verified_boolstr },
679 { "sender_host_address", vtype_stringptr, &sender_host_address },
680 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
681 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
682 { "sender_host_name", vtype_host_lookup, NULL },
683 { "sender_host_port", vtype_int, &sender_host_port },
684 { "sender_ident", vtype_stringptr, &sender_ident },
685 { "sender_rate", vtype_stringptr, &sender_rate },
686 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
687 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
688 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
689 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
690 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
691 { "sending_port", vtype_int, &sending_port },
692 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
693 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
694 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
695 { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
696 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
697 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
698 { "sn0", vtype_filter_int, &filter_sn[0] },
699 { "sn1", vtype_filter_int, &filter_sn[1] },
700 { "sn2", vtype_filter_int, &filter_sn[2] },
701 { "sn3", vtype_filter_int, &filter_sn[3] },
702 { "sn4", vtype_filter_int, &filter_sn[4] },
703 { "sn5", vtype_filter_int, &filter_sn[5] },
704 { "sn6", vtype_filter_int, &filter_sn[6] },
705 { "sn7", vtype_filter_int, &filter_sn[7] },
706 { "sn8", vtype_filter_int, &filter_sn[8] },
707 { "sn9", vtype_filter_int, &filter_sn[9] },
708 #ifdef WITH_CONTENT_SCAN
709 { "spam_action", vtype_stringptr, &spam_action },
710 { "spam_bar", vtype_stringptr, &spam_bar },
711 { "spam_report", vtype_stringptr, &spam_report },
712 { "spam_score", vtype_stringptr, &spam_score },
713 { "spam_score_int", vtype_stringptr, &spam_score_int },
716 { "spf_guess", vtype_module, US"spf" },
717 { "spf_header_comment", vtype_module, US"spf" },
718 { "spf_received", vtype_module, US"spf" },
719 { "spf_result", vtype_module, US"spf" },
720 { "spf_result_guessed", vtype_module, US"spf" },
721 { "spf_smtp_comment", vtype_module, US"spf" },
723 { "spool_directory", vtype_stringptr, &spool_directory },
724 { "spool_inodes", vtype_pinodes, (void *)TRUE },
725 { "spool_space", vtype_pspace, (void *)TRUE },
727 { "srs_recipient", vtype_stringptr, &srs_recipient },
729 { "thisaddress", vtype_stringptr, &filter_thisaddress },
731 /* The non-(in,out) variables are now deprecated */
732 { "tls_bits", vtype_int, &tls_in.bits },
733 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
734 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
736 { "tls_in_bits", vtype_int, &tls_in.bits },
737 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
738 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
739 { "tls_in_cipher_std", vtype_stringptr, &tls_in.cipher_stdname },
740 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
741 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
742 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
743 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
744 #ifndef DISABLE_TLS_RESUME
745 { "tls_in_resumption", vtype_int, &tls_in.resumption },
748 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
750 { "tls_in_ver", vtype_stringptr, &tls_in.ver },
751 { "tls_out_bits", vtype_int, &tls_out.bits },
752 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
753 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
754 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },
756 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
758 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
759 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
760 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
761 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
762 #ifndef DISABLE_TLS_RESUME
763 { "tls_out_resumption", vtype_int, &tls_out.resumption },
766 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
769 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
771 { "tls_out_ver", vtype_stringptr, &tls_out.ver },
773 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
775 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
778 { "tod_bsdinbox", vtype_todbsdin, NULL },
779 { "tod_epoch", vtype_tode, NULL },
780 { "tod_epoch_l", vtype_todel, NULL },
781 { "tod_full", vtype_todf, NULL },
782 { "tod_log", vtype_todl, NULL },
783 { "tod_logfile", vtype_todlf, NULL },
784 { "tod_zone", vtype_todzone, NULL },
785 { "tod_zulu", vtype_todzulu, NULL },
786 { "transport_name", vtype_stringptr, &transport_name },
787 { "value", vtype_stringptr, &lookup_value },
788 { "verify_mode", vtype_stringptr, &verify_mode },
789 { "version_number", vtype_stringptr, &version_string },
790 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
791 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
792 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
793 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
794 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
795 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
801 uschar * fn_arc_domains(void) {return NULL;}
802 uschar * fn_hdrs_added(void) {return NULL;}
803 uschar * fn_queue_size(void) {return NULL;}
804 uschar * fn_recipients(void) {return NULL;}
805 uschar * fn_recipients_list(void) {return NULL;}
806 uschar * sender_helo_verified_boolstr(void) {return NULL;}
807 uschar * smtp_cmd_hist(void) {return NULL;}
812 expansion_items(void)
815 for (int i = 0; i < nelem(item_table); i++)
817 spf(buf, sizeof(buf), CUS"_EXP_ITEM_%T", item_table[i]);
818 builtin_macro_create(buf);
822 expansion_operators(void)
825 for (int i = 0; i < nelem(op_table_underscore); i++)
827 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_underscore[i]);
828 builtin_macro_create(buf);
830 for (int i = 0; i < nelem(op_table_main); i++)
832 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_main[i]);
833 builtin_macro_create(buf);
837 expansion_conditions(void)
840 for (int i = 0; i < nelem(cond_table); i++)
842 spf(buf, sizeof(buf), CUS"_EXP_COND_%T", cond_table[i]);
843 builtin_macro_create(buf);
847 expansion_variables(void)
850 for (int i = 0; i < nelem(var_table); i++)
852 spf(buf, sizeof(buf), CUS"_EXP_VAR_%T", var_table[i].name);
853 builtin_macro_create(buf);
861 expansion_operators();
862 expansion_conditions();
863 expansion_variables();
866 #else /*!MACRO_PREDEF*/
868 static uschar var_buffer[256];
869 static BOOL malformed_header;
871 /* For textual hashes */
873 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
874 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
877 enum { HMAC_MD5, HMAC_SHA1 };
879 /* For numeric hashes */
881 static unsigned int prime[] = {
882 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
883 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
884 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
886 /* For printing modes in symbolic form */
888 static uschar *mtable_normal[] =
889 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
891 static uschar *mtable_setid[] =
892 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
894 static uschar *mtable_sticky[] =
895 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
897 /* flags for find_header() */
898 #define FH_EXISTS_ONLY BIT(0)
899 #define FH_WANT_RAW BIT(1)
900 #define FH_WANT_LIST BIT(2)
902 /* Recursively called function */
903 static uschar *expand_string_internal(const uschar *, esi_flags, const uschar **, BOOL *, BOOL *);
904 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
907 /*************************************************
908 * Tables for UTF-8 support *
909 *************************************************/
911 /* Table of the number of extra characters, indexed by the first character
912 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
915 static uschar utf8_table1[] = {
916 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
917 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
918 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
919 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
921 /* These are the masks for the data bits in the first byte of a character,
922 indexed by the number of additional bytes. */
924 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
926 /* Get the next UTF-8 character, advancing the pointer. */
928 #define GETUTF8INC(c, ptr) \
930 if ((c & 0xc0) == 0xc0) \
932 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
934 c = (c & utf8_table2[a]) << s; \
938 c |= (*ptr++ & 0x3f) << s; \
944 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
946 /*************************************************
947 * Binary chop search on a table *
948 *************************************************/
950 /* This is used for matching expansion items and operators.
953 name the name that is being sought
954 table the table to search
955 table_size the number of items in the table
957 Returns: the offset in the table, or -1
961 chop_match(uschar *name, uschar **table, int table_size)
963 uschar **bot = table;
964 uschar **top = table + table_size;
968 uschar **mid = bot + (top - bot)/2;
969 int c = Ustrcmp(name, *mid);
970 if (c == 0) return mid - table;
971 if (c > 0) bot = mid + 1; else top = mid;
979 /*************************************************
980 * Check a condition string *
981 *************************************************/
983 /* This function is called to expand a string, and test the result for a "true"
984 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
985 forced fail or lookup defer.
987 We used to release all store used, but this is not not safe due
988 to ${dlfunc } and ${acl }. In any case expand_string_internal()
989 is reasonably careful to release what it can.
991 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
994 condition the condition string
995 m1 text to be incorporated in panic error
998 Returns: TRUE if condition is met, FALSE if not
1002 expand_check_condition(const uschar * condition,
1003 const uschar * m1, const uschar * m2)
1005 const uschar * ss = expand_cstring(condition);
1008 if (!f.expand_string_forcedfail && !f.search_find_defer)
1009 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
1010 "for %s %s: %s", condition, m1, m2, expand_string_message);
1013 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
1014 strcmpic(ss, US"false") != 0;
1020 /*************************************************
1021 * Pseudo-random number generation *
1022 *************************************************/
1024 /* Pseudo-random number generation. The result is not "expected" to be
1025 cryptographically strong but not so weak that someone will shoot themselves
1026 in the foot using it as a nonce in some email header scheme or whatever
1027 weirdness they'll twist this into. The result should ideally handle fork().
1029 However, if we're stuck unable to provide this, then we'll fall back to
1030 appallingly bad randomness.
1032 If DISABLE_TLS is not defined then this will not be used except as an emergency
1037 Returns a random number in range [0, max-1]
1041 # define vaguely_random_number vaguely_random_number_fallback
1044 vaguely_random_number(int max)
1047 # undef vaguely_random_number
1049 static pid_t pid = 0;
1052 if ((p2 = getpid()) != pid)
1057 #ifdef HAVE_ARC4RANDOM
1058 /* cryptographically strong randomness, common on *BSD platforms, not
1059 so much elsewhere. Alas. */
1060 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1063 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1064 # ifdef HAVE_SRANDOMDEV
1065 /* uses random(4) for seeding */
1070 gettimeofday(&tv, NULL);
1071 srandom(tv.tv_sec | tv.tv_usec | getpid());
1075 /* Poor randomness and no seeding here */
1082 #ifdef HAVE_ARC4RANDOM
1083 return arc4random() % max;
1084 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1085 return random() % max;
1087 /* This one returns a 16-bit number, definitely not crypto-strong */
1088 return random_number(max);
1095 /*************************************************
1096 * Pick out a name from a string *
1097 *************************************************/
1099 /* If the name is too long, it is silently truncated.
1102 name points to a buffer into which to put the name
1103 max is the length of the buffer
1104 s points to the first alphabetic character of the name
1105 extras chars other than alphanumerics to permit
1107 Returns: pointer to the first character after the name
1109 Note: The test for *s != 0 in the while loop is necessary because
1110 Ustrchr() yields non-NULL if the character is zero (which is not something
1113 static const uschar *
1114 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1117 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1119 if (ptr < max-1) name[ptr++] = *s;
1128 /*************************************************
1129 * Pick out the rest of a header name *
1130 *************************************************/
1132 /* A variable name starting $header_ (or just $h_ for those who like
1133 abbreviations) might not be the complete header name because headers can
1134 contain any printing characters in their names, except ':'. This function is
1135 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1136 on the end, if the name was terminated by white space.
1139 name points to a buffer in which the name read so far exists
1140 max is the length of the buffer
1141 s points to the first character after the name so far, i.e. the
1142 first non-alphameric character after $header_xxxxx
1144 Returns: a pointer to the first character after the header name
1147 static const uschar *
1148 read_header_name(uschar *name, int max, const uschar *s)
1150 int prelen = Ustrchr(name, '_') - name + 1;
1151 int ptr = Ustrlen(name) - prelen;
1152 if (ptr > 0) memmove(name, name+prelen, ptr);
1153 while (mac_isgraph(*s) && *s != ':')
1155 if (ptr < max-1) name[ptr++] = *s;
1166 /*************************************************
1167 * Pick out a number from a string *
1168 *************************************************/
1171 n points to an integer into which to put the number
1172 s points to the first digit of the number
1174 Returns: a pointer to the character after the last digit
1176 /*XXX consider expanding to int_eximarith_t. But the test for
1177 "overbig numbers" in 0002 still needs to overflow it. */
1180 read_number(int *n, uschar *s)
1183 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1187 static const uschar *
1188 read_cnumber(int *n, const uschar *s)
1191 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1197 /*************************************************
1198 * Extract keyed subfield from a string *
1199 *************************************************/
1201 /* The yield is in dynamic store; NULL means that the key was not found.
1204 key points to the name of the key
1205 s points to the string from which to extract the subfield
1207 Returns: NULL if the subfield was not found, or
1208 a pointer to the subfield's data
1212 expand_getkeyed(const uschar * key, const uschar * s)
1214 int length = Ustrlen(key);
1215 Uskip_whitespace(&s);
1217 /* Loop to search for the key */
1223 const uschar * dkey = s;
1225 while (*s && *s != '=' && !isspace(*s)) s++;
1226 dkeylength = s - dkey;
1227 if (Uskip_whitespace(&s) == '=')
1228 while (isspace(*++s)) ;
1230 data = string_dequote(&s);
1231 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1234 Uskip_whitespace(&s);
1243 find_var_ent(uschar * name, var_entry * table, unsigned nent)
1248 while (last > first)
1250 int middle = (first + last)/2;
1251 int c = Ustrcmp(name, table[middle].name);
1253 if (c > 0) { first = middle + 1; continue; }
1254 if (c < 0) { last = middle; continue; }
1255 return &table[middle];
1260 /*************************************************
1261 * Extract numbered subfield from string *
1262 *************************************************/
1264 /* Extracts a numbered field from a string that is divided by tokens - for
1265 example a line from /etc/passwd is divided by colon characters. First field is
1266 numbered one. Negative arguments count from the right. Zero returns the whole
1267 string. Returns NULL if there are insufficient tokens in the string
1270 Modifies final argument - this is a dynamically generated string, so that's OK.
1273 field number of field to be extracted,
1274 first field = 1, whole string = 0, last field = -1
1275 separators characters that are used to break string into tokens
1276 s points to the string from which to extract the subfield
1278 Returns: NULL if the field was not found,
1279 a pointer to the field's data inside s (modified to add 0)
1283 expand_gettokened (int field, uschar *separators, uschar *s)
1288 uschar *fieldtext = NULL;
1290 if (field == 0) return s;
1292 /* Break the line up into fields in place; for field > 0 we stop when we have
1293 done the number of fields we want. For field < 0 we continue till the end of
1294 the string, counting the number of fields. */
1296 count = (field > 0)? field : INT_MAX;
1302 /* Previous field was the last one in the string. For a positive field
1303 number, this means there are not enough fields. For a negative field number,
1304 check that there are enough, and scan back to find the one that is wanted. */
1308 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1309 if ((-field) == (INT_MAX - count - 1)) return s;
1313 while (ss[-1] != 0) ss--;
1319 /* Previous field was not last in the string; save its start and put a
1323 len = Ustrcspn(ss, separators);
1334 expand_getlistele(int field, const uschar * list, int sep)
1336 const uschar * tlist = list;
1338 /* Tainted mem for the throwaway element copies */
1339 uschar * dummy = store_get(2, GET_TAINTED);
1342 for (field++; string_nextinlist(&tlist, &sep_l, dummy, 1); ) field++;
1343 if (field == 0) return NULL;
1344 while (--field > 0 && (string_nextinlist(&list, &sep, dummy, 1))) ;
1345 return string_nextinlist(&list, &sep, NULL, 0);
1349 /* Certificate fields, by name. Worry about by-OID later */
1350 /* Names are chosen to not have common prefixes */
1357 uschar * (*getfn)(void * cert, uschar * mod);
1359 static certfield certfields[] =
1360 { /* linear search; no special order */
1361 { US"version", 7, &tls_cert_version },
1362 { US"serial_number", 13, &tls_cert_serial_number },
1363 { US"subject", 7, &tls_cert_subject },
1364 { US"notbefore", 9, &tls_cert_not_before },
1365 { US"notafter", 8, &tls_cert_not_after },
1366 { US"issuer", 6, &tls_cert_issuer },
1367 { US"signature", 9, &tls_cert_signature },
1368 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1369 { US"subj_altname", 12, &tls_cert_subject_altname },
1370 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1371 { US"crl_uri", 7, &tls_cert_crl_uri },
1375 expand_getcertele(uschar * field, uschar * certvar)
1379 if (!(vp = find_var_ent(certvar, var_table, nelem(var_table))))
1381 expand_string_message =
1382 string_sprintf("no variable named \"%s\"", certvar);
1383 return NULL; /* Unknown variable name */
1385 /* NB this stops us passing certs around in variable. Might
1386 want to do that in future */
1387 if (vp->type != vtype_cert)
1389 expand_string_message =
1390 string_sprintf("\"%s\" is not a certificate", certvar);
1391 return NULL; /* Unknown variable name */
1393 if (!*(void **)vp->value)
1396 if (*field >= '0' && *field <= '9')
1397 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1399 for (certfield * cp = certfields;
1400 cp < certfields + nelem(certfields);
1402 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1404 uschar * modifier = *(field += cp->namelen) == ','
1406 return (*cp->getfn)( *(void **)vp->value, modifier );
1409 expand_string_message =
1410 string_sprintf("bad field selector \"%s\" for certextract", field);
1413 #endif /*DISABLE_TLS*/
1415 /*************************************************
1416 * Extract a substring from a string *
1417 *************************************************/
1419 /* Perform the ${substr or ${length expansion operations.
1422 subject the input string
1423 value1 the offset from the start of the input string to the start of
1424 the output string; if negative, count from the right.
1425 value2 the length of the output string, or negative (-1) for unset
1426 if value1 is positive, unset means "all after"
1427 if value1 is negative, unset means "all before"
1428 len set to the length of the returned string
1430 Returns: pointer to the output string, or NULL if there is an error
1434 extract_substr(uschar *subject, int value1, int value2, int *len)
1436 int sublen = Ustrlen(subject);
1438 if (value1 < 0) /* count from right */
1442 /* If the position is before the start, skip to the start, and adjust the
1443 length. If the length ends up negative, the substring is null because nothing
1444 can precede. This falls out naturally when the length is unset, meaning "all
1450 if (value2 < 0) value2 = 0;
1454 /* Otherwise an unset length => characters before value1 */
1456 else if (value2 < 0)
1463 /* For a non-negative offset, if the starting position is past the end of the
1464 string, the result will be the null string. Otherwise, an unset length means
1465 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1469 if (value1 > sublen)
1474 else if (value2 < 0) value2 = sublen;
1477 /* Cut the length down to the maximum possible for the offset value, and get
1478 the required characters. */
1480 if (value1 + value2 > sublen) value2 = sublen - value1;
1482 return subject + value1;
1488 /*************************************************
1489 * Old-style hash of a string *
1490 *************************************************/
1492 /* Perform the ${hash expansion operation.
1495 subject the input string (an expanded substring)
1496 value1 the length of the output string; if greater or equal to the
1497 length of the input string, the input string is returned
1498 value2 the number of hash characters to use, or 26 if negative
1499 len set to the length of the returned string
1501 Returns: pointer to the output string, or NULL if there is an error
1505 compute_hash(uschar *subject, int value1, int value2, int *len)
1507 int sublen = Ustrlen(subject);
1509 if (value2 < 0) value2 = 26;
1510 else if (value2 > Ustrlen(hashcodes))
1512 expand_string_message =
1513 string_sprintf("hash count \"%d\" too big", value2);
1517 /* Calculate the hash text. We know it is shorter than the original string, so
1518 can safely place it in subject[] (we know that subject is always itself an
1519 expanded substring). */
1521 if (value1 < sublen)
1526 while ((c = (subject[j])) != 0)
1528 int shift = (c + j++) & 7;
1529 subject[i] ^= (c << shift) | (c >> (8-shift));
1530 if (++i >= value1) i = 0;
1532 for (i = 0; i < value1; i++)
1533 subject[i] = hashcodes[(subject[i]) % value2];
1535 else value1 = sublen;
1544 /*************************************************
1545 * Numeric hash of a string *
1546 *************************************************/
1548 /* Perform the ${nhash expansion operation. The first characters of the
1549 string are treated as most important, and get the highest prime numbers.
1552 subject the input string
1553 value1 the maximum value of the first part of the result
1554 value2 the maximum value of the second part of the result,
1555 or negative to produce only a one-part result
1556 len set to the length of the returned string
1558 Returns: pointer to the output string, or NULL if there is an error.
1562 compute_nhash (uschar *subject, int value1, int value2, int *len)
1564 uschar *s = subject;
1566 unsigned long int total = 0; /* no overflow */
1570 if (i == 0) i = nelem(prime) - 1;
1571 total += prime[i--] * (unsigned int)(*s++);
1574 /* If value2 is unset, just compute one number */
1577 s = string_sprintf("%lu", total % value1);
1579 /* Otherwise do a div/mod hash */
1583 total = total % (value1 * value2);
1584 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1595 /*************************************************
1596 * Find the value of a header or headers *
1597 *************************************************/
1599 /* Multiple instances of the same header get concatenated, and this function
1600 can also return a concatenation of all the header lines. When concatenating
1601 specific headers that contain lists of addresses, a comma is inserted between
1602 them. Otherwise we use a straight concatenation. Because some messages can have
1603 pathologically large number of lines, there is a limit on the length that is
1607 name the name of the header, without the leading $header_ or $h_,
1608 or NULL if a concatenation of all headers is required
1609 newsize return the size of memory block that was obtained; may be NULL
1610 if exists_only is TRUE
1611 flags FH_EXISTS_ONLY
1612 set if called from a def: test; don't need to build a string;
1613 just return a string that is not "" and not "0" if the header
1616 set if called for $rh_ or $rheader_ items; no processing,
1617 other than concatenating, will be done on the header. Also used
1618 for $message_headers_raw.
1620 Double colon chars in the content, and replace newline with
1621 colon between each element when concatenating; returning a
1622 colon-sep list (elements might contain newlines)
1623 charset name of charset to translate MIME words to; used only if
1624 want_raw is false; if NULL, no translation is done (this is
1625 used for $bh_ and $bheader_)
1627 Returns: NULL if the header does not exist, else a pointer to a new
1632 find_header(uschar * name, int * newsize, unsigned flags, const uschar * charset)
1635 int len = name ? Ustrlen(name) : 0;
1640 for (header_line * h = header_list; h; h = h->next)
1641 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1642 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1647 if (flags & FH_EXISTS_ONLY)
1648 return US"1"; /* don't need actual string */
1651 s = h->text + len; /* text to insert */
1652 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1653 Uskip_whitespace(&s); /* remove leading white space */
1654 t = h->text + h->slen; /* end-point */
1656 /* Unless wanted raw, remove trailing whitespace, including the
1659 if (flags & FH_WANT_LIST)
1660 while (t > s && t[-1] == '\n') t--;
1661 else if (!(flags & FH_WANT_RAW))
1663 while (t > s && isspace(t[-1])) t--;
1665 /* Set comma if handling a single header and it's one of those
1666 that contains an address list, except when asked for raw headers. Only
1667 need to do this once. */
1669 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1672 /* Trim the header roughly if we're approaching limits */
1674 if (gstring_length(g) + inc > header_insert_maxlen)
1675 inc = header_insert_maxlen - gstring_length(g);
1677 /* For raw just copy the data; for a list, add the data as a colon-sep
1678 list-element; for comma-list add as an unchecked comma,newline sep
1679 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1680 stripped trailing WS above including the newline). We ignore the potential
1681 expansion due to colon-doubling, just leaving the loop if the limit is met
1684 if (flags & FH_WANT_LIST)
1685 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1686 else if (flags & FH_WANT_RAW)
1687 g = string_catn(g, s, (unsigned)inc);
1689 g = string_append2_listele_n(g, comma ? US",\n" : US"\n",
1692 if (gstring_length(g) >= header_insert_maxlen) break;
1695 if (!found) return NULL; /* No header found */
1696 if (!g) return US"";
1698 /* That's all we do for raw header expansion. */
1701 rawhdr = string_from_gstring(g);
1702 if (flags & FH_WANT_RAW)
1705 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1706 The rfc2047_decode2() function can return an error with decoded data if the
1707 charset translation fails. If decoding fails, it returns NULL. */
1711 uschar * error, * decoded = rfc2047_decode2(rawhdr,
1712 check_rfc2047_length, charset, '?', NULL, newsize, &error);
1714 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1715 " input was: %s\n", error, rawhdr);
1716 return decoded ? decoded : rawhdr;
1723 /* Append a "local" element to an Authentication-Results: header
1724 if this was a non-smtp message.
1728 authres_local(gstring * g, const uschar * sysname)
1730 if (!f.authentication_local)
1732 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1733 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1738 /* Append an "iprev" element to an Authentication-Results: header
1739 if we have attempted to get the calling host's name.
1743 authres_iprev(gstring * g)
1745 if (sender_host_name)
1746 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1747 else if (host_lookup_deferred)
1748 g = string_cat(g, US";\n\tiprev=temperror");
1749 else if (host_lookup_failed)
1750 g = string_cat(g, US";\n\tiprev=fail");
1754 if (sender_host_address)
1755 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1761 /*************************************************
1762 * Return list of recipients *
1763 *************************************************/
1764 /* A recipients list is available only during system message filtering,
1765 during ACL processing after DATA, and while expanding pipe commands
1766 generated from a system filter, but not elsewhere. Note that this does
1767 not check for commas in the elements, and uses comma-space as seperator -
1768 so cannot be used as an exim list as-is. */
1775 if (!f.enable_dollar_recipients) return NULL;
1777 for (int i = 0; i < recipients_count; i++)
1779 const uschar * s = recipients_list[i].address;
1780 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1782 gstring_release_unused(g);
1783 return string_from_gstring(g);
1786 /* Similar, but as a properly-quoted exim list */
1790 fn_recipients_list(void)
1794 if (!f.enable_dollar_recipients) return NULL;
1796 for (int i = 0; i < recipients_count; i++)
1797 g = string_append_listele(g, ':', recipients_list[i].address);
1798 gstring_release_unused(g);
1799 return string_from_gstring(g);
1803 /*************************************************
1804 * Return size of queue *
1805 *************************************************/
1806 /* Ask the daemon for the queue size */
1811 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1815 const uschar * where;
1818 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
1820 DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));
1824 len = daemon_client_sockname(&sa_un, &sname);
1826 if (bind(fd, (const struct sockaddr *)&sa_un, (socklen_t)len) < 0)
1827 { where = US"bind"; goto bad; }
1830 debug_printf("local addr '%s%s'\n",
1831 *sa_un.sun_path ? "" : "@",
1832 sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1835 len = daemon_notifier_sockname(&sa_un);
1836 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
1837 { where = US"connect"; goto bad2; }
1839 buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1840 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1842 if (poll_one_fd(fd, POLLIN, 2 * 1000) != 1)
1844 DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1845 len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1847 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1848 { where = US"recv"; goto bad2; }
1851 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1854 return string_copyn(buf, len);
1857 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1862 DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1867 /*************************************************
1868 * Find value of a variable *
1869 *************************************************/
1871 /* The table of variables is kept in alphabetic order, so we can search it
1872 using a binary chop. The "choplen" variable is nothing to do with the binary
1876 name the name of the variable being sought
1878 exists_only TRUE if this is a def: test; passed on to find_header()
1879 skipping TRUE => skip any processing evaluation; this is not the same as
1880 exists_only because def: may test for values that are first
1882 newsize pointer to an int which is initially zero; if the answer is in
1883 a new memory buffer, *newsize is set to its size
1885 Returns: NULL if the variable does not exist, or
1886 a pointer to the variable's contents, or
1887 something non-NULL if exists_only is TRUE
1890 static const uschar *
1891 find_variable(uschar * name, esi_flags flags, int * newsize)
1894 uschar * s, * domain;
1897 var_entry * table = var_table;
1898 unsigned table_count = nelem(var_table);
1900 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1901 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1902 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1903 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1904 (this gave backwards compatibility at the changeover). There may be built-in
1905 variables whose names start acl_ but they should never start in this way. This
1906 slightly messy specification is a consequence of the history, needless to say.
1908 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1909 set, in which case give an error. */
1911 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1915 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1916 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1918 else if (Ustrncmp(name, "r_", 2) == 0)
1920 tree_node * node = tree_search(router_var, name + 2);
1921 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1924 /* Handle $auth<n>, $regex<n> variables. */
1926 if (Ustrncmp(name, "auth", 4) == 0)
1929 int n = Ustrtoul(name + 4, &endptr, 10);
1930 if (!*endptr && n != 0 && n <= AUTH_VARS)
1931 return auth_vars[n-1] ? auth_vars[n-1] : US"";
1933 #ifdef WITH_CONTENT_SCAN
1934 else if (Ustrncmp(name, "regex", 5) == 0)
1937 int n = Ustrtoul(name + 5, &endptr, 10);
1938 if (!*endptr && n != 0 && n <= REGEX_VARS)
1939 return regex_vars[n-1] ? regex_vars[n-1] : US"";
1945 /* For all other variables, search the table */
1947 if (!(vp = find_var_ent(name, table, table_count)))
1948 return NULL; /* Unknown variable name */
1950 /* Found an existing variable. If in skipping state, the value isn't needed,
1951 and we want to avoid processing (such as looking up the host name). */
1953 if (flags & ESI_SKIPPING)
1959 case vtype_filter_int:
1960 if (!f.filter_running) return NULL;
1964 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1968 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1972 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1976 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1980 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1983 case vtype_stringptr: /* Pointer to string */
1984 return (s = *((uschar **)(val))) ? s : US"";
1987 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1990 case vtype_load_avg:
1991 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1994 case vtype_host_lookup: /* Lookup if not done so */
1995 if ( !sender_host_name && sender_host_address
1996 && !host_lookup_failed && host_name_lookup() == OK)
1997 host_build_sender_fullhost();
1998 return sender_host_name ? sender_host_name : US"";
2000 case vtype_localpart: /* Get local part from address */
2001 if (!(s = *((uschar **)(val)))) return US"";
2002 if (!(domain = Ustrrchr(s, '@'))) return s;
2003 if (domain - s > sizeof(var_buffer) - 1)
2004 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
2005 " in string expansion", sizeof(var_buffer));
2006 return string_copyn(s, domain - s);
2008 case vtype_domain: /* Get domain from address */
2009 if (!(s = *((uschar **)(val)))) return US"";
2010 domain = Ustrrchr(s, '@');
2011 return domain ? domain + 1 : US"";
2013 case vtype_msgheaders:
2014 return find_header(NULL, newsize,
2015 flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY : 0, NULL);
2017 case vtype_msgheaders_raw:
2018 return find_header(NULL, newsize,
2019 flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2022 case vtype_msgbody: /* Pointer to msgbody string */
2023 case vtype_msgbody_end: /* Ditto, the end of the msg */
2024 ss = (uschar **)(val);
2025 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
2028 off_t start_offset_o = spool_data_start_offset(message_id);
2029 off_t start_offset = start_offset_o;
2030 int len = message_body_visible;
2032 if (len > message_size) len = message_size;
2033 *ss = body = store_get(len+1, GET_TAINTED);
2035 if (vp->type == vtype_msgbody_end)
2037 struct stat statbuf;
2038 if (fstat(deliver_datafile, &statbuf) == 0)
2040 start_offset = statbuf.st_size - len;
2041 if (start_offset < start_offset_o)
2042 start_offset = start_offset_o;
2045 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
2046 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
2048 if ((len = read(deliver_datafile, body, len)) > 0)
2051 if (message_body_newlines) /* Separate loops for efficiency */
2053 { if (body[--len] == 0) body[len] = ' '; }
2056 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
2059 return *ss ? *ss : US"";
2061 case vtype_todbsdin: /* BSD inbox time of day */
2062 return tod_stamp(tod_bsdin);
2064 case vtype_tode: /* Unix epoch time of day */
2065 return tod_stamp(tod_epoch);
2067 case vtype_todel: /* Unix epoch/usec time of day */
2068 return tod_stamp(tod_epoch_l);
2070 case vtype_todf: /* Full time of day */
2071 return tod_stamp(tod_full);
2073 case vtype_todl: /* Log format time of day */
2074 return tod_stamp(tod_log_bare); /* (without timezone) */
2076 case vtype_todzone: /* Time zone offset only */
2077 return tod_stamp(tod_zone);
2079 case vtype_todzulu: /* Zulu time */
2080 return tod_stamp(tod_zulu);
2082 case vtype_todlf: /* Log file datestamp tod */
2083 return tod_stamp(tod_log_datestamp_daily);
2085 case vtype_reply: /* Get reply address */
2086 s = find_header(US"reply-to:", newsize,
2087 flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2089 if (s) Uskip_whitespace(&s);
2092 *newsize = 0; /* For the *s==0 case */
2093 s = find_header(US"from:", newsize,
2094 flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2100 Uskip_whitespace(&s);
2101 for (t = s; *t; t++) if (*t == '\n') *t = ' ';
2102 while (t > s && isspace(t[-1])) t--;
2105 return s ? s : US"";
2107 case vtype_string_func:
2109 stringptr_fn_t * fn = (stringptr_fn_t *) val;
2111 return s ? s : US"";
2117 sprintf(CS var_buffer, PR_EXIM_ARITH,
2118 receive_statvfs(val == (void *)TRUE, &inodes));
2125 (void) receive_statvfs(val == (void *)TRUE, &inodes);
2126 sprintf(CS var_buffer, "%d", inodes);
2131 return *(void **)val ? US"<cert>" : US"";
2133 #ifndef DISABLE_DKIM
2136 misc_module_info * mi = misc_mod_findonly(US"dkim");
2137 typedef uschar * (*fn_t)(int);
2139 ? (((fn_t *) mi->functions)[DKIM_EXPAND_QUERY]) ((int)(long)val)
2147 misc_module_info * mi = misc_mod_find(val, &errstr);
2150 table = mi->variables;
2151 table_count = mi->variables_count;
2154 log_write(0, LOG_MAIN|LOG_PANIC,
2155 "failed to find %s module for %s: %s", US val, name, errstr);
2160 return NULL; /* Unknown variable. Silences static checkers. */
2167 modify_variable(uschar *name, void * value)
2170 if ((vp = find_var_ent(name, var_table, nelem(var_table))))
2172 return; /* Unknown variable name, fail silently */
2180 /*************************************************
2181 * Read and expand substrings *
2182 *************************************************/
2184 /* This function is called to read and expand argument substrings for various
2185 expansion items. Some have a minimum requirement that is less than the maximum;
2186 in these cases, the first non-present one is set to NULL.
2189 sub points to vector of pointers to set
2190 n maximum number of substrings
2192 sptr points to current string pointer
2194 skipping the skipping flag
2195 check_end if TRUE, check for final '}'
2196 name name of item, for error message
2197 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2199 textonly_p if not NULL, pointer to bitmask of which subs were text-only
2200 (did not change when expended)
2202 Returns: -1 OK; string pointer updated, but in "skipping" mode
2203 0 OK; string pointer updated
2204 1 curly bracketing error (too few arguments)
2205 2 too many arguments (only if check_end is set); message set
2206 3 other error (expansion failure)
2210 read_subs(uschar ** sub, int n, int m, const uschar ** sptr, esi_flags flags,
2211 BOOL check_end, uschar * name, BOOL * resetok, unsigned * textonly_p)
2213 const uschar * s = *sptr;
2214 unsigned textonly_l = 0;
2216 Uskip_whitespace(&s);
2217 for (int i = 0; i < n; i++)
2224 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2225 "(min is %d)", name, m);
2231 if (!(sub[i] = expand_string_internal(s+1,
2232 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, &s, resetok,
2233 textonly_p ? &textonly : NULL)))
2235 if (*s++ != '}') return 1;
2236 if (textonly_p && textonly) textonly_l |= BIT(i);
2237 Uskip_whitespace(&s);
2239 if (check_end && *s++ != '}')
2243 expand_string_message = string_sprintf("Too many arguments for '%s' "
2244 "(max is %d)", name, n);
2247 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2251 if (textonly_p) *textonly_p = textonly_l;
2253 return flags & ESI_SKIPPING ? -1 : 0;
2259 /*************************************************
2260 * Elaborate message for bad variable *
2261 *************************************************/
2263 /* For the "unknown variable" message, take a look at the variable's name, and
2264 give additional information about possible ACL variables. The extra information
2265 is added on to expand_string_message.
2267 Argument: the name of the variable
2272 check_variable_error_message(uschar *name)
2274 if (Ustrncmp(name, "acl_", 4) == 0)
2275 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2276 (name[4] == 'c' || name[4] == 'm')?
2278 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2279 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2281 US"user-defined ACL variables must start acl_c or acl_m");
2287 Load args from sub array to globals, and call acl_check().
2288 Sub array will be corrupted on return.
2290 Returns: OK access is granted by an ACCEPT verb
2291 DISCARD access is (apparently) granted by a DISCARD verb
2292 FAIL access is denied
2293 FAIL_DROP access is denied; drop the connection
2294 DEFER can't tell at the moment
2298 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2301 int sav_narg = acl_narg;
2303 uschar * dummy_logmsg;
2304 extern int acl_where;
2306 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2307 for (i = 0; i < nsub && sub[i+1]; i++)
2309 uschar * tmp = acl_arg[i];
2310 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2311 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2316 sub[i+1] = acl_arg[i];
2317 acl_arg[i++] = NULL;
2321 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2323 acl_narg>0 ? acl_arg[0] : US"<none>",
2324 acl_narg>1 ? " +more" : "");
2326 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2328 for (i = 0; i < nsub; i++)
2329 acl_arg[i] = sub[i+1]; /* restore old args */
2330 acl_narg = sav_narg;
2338 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2339 The given string is modified on return. Leading whitespace is skipped while
2340 looking for the opening wrap character, then the rest is scanned for the trailing
2341 (non-escaped) wrap character. A backslash in the string will act as an escape.
2343 A nul is written over the trailing wrap, and a pointer to the char after the
2344 leading wrap is returned.
2347 s String for de-wrapping
2348 wrap Two-char string, the first being the opener, second the closer wrapping
2351 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2355 dewrap(uschar * s, const uschar * wrap)
2359 BOOL quotesmode = wrap[0] == wrap[1];
2361 if (Uskip_whitespace(&p) == *wrap)
2367 if (*p == '\\') p++;
2368 else if (!quotesmode && *p == wrap[-1]) depth++;
2369 else if (*p == *wrap)
2380 expand_string_message = string_sprintf("missing '%c'", *wrap);
2385 /* Pull off the leading array or object element, returning
2386 a copy in an allocated string. Update the list pointer.
2388 The element may itself be an abject or array.
2389 Return NULL when the list is empty.
2393 json_nextinlist(const uschar ** list)
2395 unsigned array_depth = 0, object_depth = 0;
2396 BOOL quoted = FALSE;
2397 const uschar * s = *list, * item;
2399 skip_whitespace(&s);
2402 *s && (*s != ',' || array_depth != 0 || object_depth != 0 || quoted);
2404 if (!quoted) switch (*s)
2406 case '[': array_depth++; break;
2407 case ']': array_depth--; break;
2408 case '{': object_depth++; break;
2409 case '}': object_depth--; break;
2410 case '"': quoted = TRUE;
2414 case '\\': s++; break; /* backslash protects one char */
2415 case '"': quoted = FALSE; break;
2417 *list = *s ? s+1 : s;
2418 if (item == s) return NULL;
2419 item = string_copyn(item, s - item);
2420 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2426 /************************************************/
2427 /* Return offset in ops table, or -1 if not found.
2428 Repoint to just after the operator in the string.
2431 ss string representation of operator
2432 opname split-out operator name
2436 identify_operator(const uschar ** ss, uschar ** opname)
2438 const uschar * s = *ss;
2441 /* Numeric comparisons are symbolic */
2443 if (*s == '=' || *s == '>' || *s == '<')
2455 /* All other conditions are named */
2458 s = read_name(name, sizeof(name), s, US"_");
2461 /* If we haven't read a name, it means some non-alpha character is first. */
2465 expand_string_message = string_sprintf("condition name expected, "
2466 "but found \"%.16s\"", s);
2469 DEBUG(D_expand) debug_printf_indent("cond: %s\n", name);
2471 *opname = string_copy(name);
2473 return chop_match(name, cond_table, nelem(cond_table));
2477 /*************************************************
2478 * Handle MD5 or SHA-1 computation for HMAC *
2479 *************************************************/
2481 /* These are some wrapping functions that enable the HMAC code to be a bit
2482 cleaner. A good compiler will spot the tail recursion.
2485 type HMAC_MD5 or HMAC_SHA1
2486 remaining are as for the cryptographic hash functions
2492 chash_start(int type, void * base)
2494 if (type == HMAC_MD5)
2495 md5_start((md5 *)base);
2497 sha1_start((hctx *)base);
2501 chash_mid(int type, void * base, const uschar * string)
2503 if (type == HMAC_MD5)
2504 md5_mid((md5 *)base, string);
2506 sha1_mid((hctx *)base, string);
2510 chash_end(int type, void * base, const uschar * string, int length,
2513 if (type == HMAC_MD5)
2514 md5_end((md5 *)base, string, length, digest);
2516 sha1_end((hctx *)base, string, length, digest);
2523 /* Do an hmac_md5. The result is _not_ nul-terminated, and is sized as
2524 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2527 key encoding key, nul-terminated
2528 src data to be hashed, nul-terminated
2530 len size of output buffer
2534 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2537 const uschar * keyptr;
2539 unsigned int keylen;
2541 #define MD5_HASHLEN 16
2542 #define MD5_HASHBLOCKLEN 64
2544 uschar keyhash[MD5_HASHLEN];
2545 uschar innerhash[MD5_HASHLEN];
2546 uschar finalhash[MD5_HASHLEN];
2547 uschar innerkey[MD5_HASHBLOCKLEN];
2548 uschar outerkey[MD5_HASHBLOCKLEN];
2551 keylen = Ustrlen(keyptr);
2553 /* If the key is longer than the hash block length, then hash the key
2556 if (keylen > MD5_HASHBLOCKLEN)
2558 chash_start(HMAC_MD5, &md5_base);
2559 chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2561 keylen = MD5_HASHLEN;
2564 /* Now make the inner and outer key values */
2566 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2567 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2569 for (int i = 0; i < keylen; i++)
2571 innerkey[i] ^= keyptr[i];
2572 outerkey[i] ^= keyptr[i];
2575 /* Now do the hashes */
2577 chash_start(HMAC_MD5, &md5_base);
2578 chash_mid(HMAC_MD5, &md5_base, innerkey);
2579 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2581 chash_start(HMAC_MD5, &md5_base);
2582 chash_mid(HMAC_MD5, &md5_base, outerkey);
2583 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2585 /* Encode the final hash as a hex string, limited by output buffer size */
2588 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2590 if (j-- <= 0) break;
2591 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2592 if (j-- <= 0) break;
2593 *p++ = hex_digits[finalhash[i] & 0x0f];
2597 #endif /*SUPPORT_SRS*/
2600 /*************************************************
2601 * Read and evaluate a condition *
2602 *************************************************/
2606 s points to the start of the condition text
2607 resetok points to a BOOL which is written false if it is unsafe to
2608 free memory. Certain condition types (acl) may have side-effect
2609 allocation which must be preserved.
2610 yield points to a BOOL to hold the result of the condition test;
2611 if NULL, we are just reading through a condition that is
2612 part of an "or" combination to check syntax, or in a state
2613 where the answer isn't required
2615 Returns: a pointer to the first character after the condition, or
2619 static const uschar *
2620 eval_condition(const uschar * s, BOOL * resetok, BOOL * yield)
2622 BOOL testfor = TRUE, tempcond, combined_cond;
2624 BOOL sub2_honour_dollar = TRUE, is_forany, is_json, is_jsons;
2626 int_eximarith_t num[2];
2627 struct stat statbuf;
2630 const uschar * sub[10], * next;
2631 unsigned sub_textonly = 0;
2635 if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;
2637 switch(cond_type = identify_operator(&s, &opname))
2639 /* def: tests for a non-empty variable, or for the existence of a header. If
2640 yield == NULL we are in a skipping state, and don't care about the answer. */
2648 expand_string_message = US"\":\" expected after \"def\"";
2652 s = read_name(name, sizeof(name), s+1, US"_");
2654 /* Test for a header's existence. If the name contains a closing brace
2655 character, this may be a user error where the terminating colon has been
2656 omitted. Set a flag to adjust a subsequent error message in this case. */
2658 if ( ( *(t = name) == 'h'
2659 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2661 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2664 s = read_header_name(name, sizeof(name), s);
2665 /* {-for-text-editors */
2666 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2668 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2671 /* Test for a variable's having a non-empty value. A non-existent variable
2672 causes an expansion failure. */
2676 if (!(t = find_variable(name,
2677 yield ? ESI_EXISTS_ONLY : ESI_EXISTS_ONLY | ESI_SKIPPING, NULL)))
2679 expand_string_message = name[0]
2680 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2681 : US"variable name omitted after \"def:\"";
2682 check_variable_error_message(name);
2685 if (yield) *yield = (t[0] != 0) == testfor;
2692 /* first_delivery tests for first delivery attempt */
2694 case ECOND_FIRST_DELIVERY:
2695 if (yield) *yield = f.deliver_firsttime == testfor;
2699 /* queue_running tests for any process started by a queue runner */
2701 case ECOND_QUEUE_RUNNING:
2702 if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2706 /* exists: tests for file existence
2707 isip: tests for any IP address
2708 isip4: tests for an IPv4 address
2709 isip6: tests for an IPv6 address
2710 pam: does PAM authentication
2711 radius: does RADIUS authentication
2712 ldapauth: does LDAP authentication
2713 pwcheck: does Cyrus SASL pwcheck authentication
2722 case ECOND_LDAPAUTH:
2725 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2729 sub[0] = expand_string_internal(s+1,
2730 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
2731 &s, resetok, &textonly);
2732 if (!sub[0]) goto failout;
2733 if (textonly) sub_textonly |= BIT(0);
2735 /* {-for-text-editors */
2736 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2738 if (!yield) { next = s; goto out; } /* No need to run the test if skipping */
2743 if ((expand_forbid & RDO_EXISTS) != 0)
2745 expand_string_message = US"File existence tests are not permitted";
2748 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2756 const uschar **errpp;
2757 DEBUG(D_expand) errpp = &errp; else errpp = 0;
2758 if (0 == (rc = string_is_ip_addressX(sub[0], NULL, errpp)))
2759 DEBUG(D_expand) debug_printf("failed: %s\n", errp);
2761 *yield = ( cond_type == ECOND_ISIP ? rc != 0 :
2762 cond_type == ECOND_ISIP4 ? rc == 4 : rc == 6) == testfor;
2767 /* Various authentication tests - all optionally compiled */
2772 const misc_module_info * mi = misc_mod_find(US"pam", NULL);
2773 typedef int (*fn_t)(const uschar *, uschar **);
2775 goto COND_FAILED_NOT_COMPILED;
2776 rc = (((fn_t *) mi->functions)[PAM_AUTH_CALL])
2777 (sub[0], &expand_string_message);
2781 goto COND_FAILED_NOT_COMPILED;
2782 #endif /* SUPPORT_PAM */
2785 #ifdef RADIUS_CONFIG_FILE
2787 const misc_module_info * mi = misc_mod_find(US"radius", NULL);
2788 typedef int (*fn_t)(const uschar *, uschar **);
2790 goto COND_FAILED_NOT_COMPILED;
2791 rc = (((fn_t *) mi->functions)[RADIUS_AUTH_CALL])
2792 (sub[0], &expand_string_message);
2796 goto COND_FAILED_NOT_COMPILED;
2797 #endif /* RADIUS_CONFIG_FILE */
2799 case ECOND_LDAPAUTH:
2802 int expand_setup = -1;
2803 const lookup_info * li = search_findtype(US"ldapauth", 8);
2806 if (li && (handle = search_open(NULL, li, 0, NULL, NULL)))
2807 rc = search_find(handle, NULL, sub[0],
2808 -1, NULL, 0, 0, &expand_setup, NULL)
2809 ? OK : f.search_find_defer ? DEFER : FAIL;
2811 { expand_string_message = search_error_message; rc = FAIL; }
2815 goto COND_FAILED_NOT_COMPILED;
2816 #endif /* LOOKUP_LDAP */
2819 #ifdef CYRUS_PWCHECK_SOCKET
2820 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2823 goto COND_FAILED_NOT_COMPILED;
2824 #endif /* CYRUS_PWCHECK_SOCKET */
2826 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2827 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2829 if (rc == ERROR || rc == DEFER) goto failout;
2830 *yield = (rc == OK) == testfor;
2836 /* call ACL (in a conditional context). Accept true, deny false.
2837 Defer is a forced-fail. Anything set by message= goes to $value.
2838 Up to ten parameters are used; we use the braces round the name+args
2839 like the saslauthd condition does, to permit a variable number of args.
2840 See also the expansion-item version EITEM_ACL and the traditional
2841 acl modifier ACLC_ACL.
2842 Since the ACL may allocate new global variables, tell our caller to not
2847 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2853 Uskip_whitespace(&s);
2854 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2856 switch(read_subs(sub, nelem(sub), 1, &s,
2857 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2859 case 1: expand_string_message = US"too few arguments or bracketing "
2862 case 3: goto failout;
2868 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2869 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2874 lookup_value = NULL;
2876 lookup_value = string_copy(user_msg);
2877 *yield = cond == testfor;
2881 f.expand_string_forcedfail = TRUE;
2884 expand_string_message = string_sprintf("%s from acl \"%s\"",
2885 rc_names[rc], sub[0]);
2893 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2895 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2897 However, the last two are optional. That is why the whole set is enclosed
2898 in their own set of braces. */
2900 case ECOND_SASLAUTHD:
2901 #ifndef CYRUS_SASLAUTHD_SOCKET
2902 goto COND_FAILED_NOT_COMPILED;
2906 Uskip_whitespace(&s);
2907 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2908 switch(read_subs(sub, nelem(sub), 2, &s,
2909 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2911 case 1: expand_string_message = US"too few arguments or bracketing "
2912 "error for saslauthd";
2914 case 3: goto failout;
2916 if (!sub[2]) sub[3] = NULL; /* realm if no service */
2919 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2920 &expand_string_message);
2921 if (rc == ERROR || rc == DEFER) goto failout;
2922 *yield = (rc == OK) == testfor;
2926 #endif /* CYRUS_SASLAUTHD_SOCKET */
2929 /* symbolic operators for numeric and string comparison, and a number of
2930 other operators, all requiring two arguments.
2932 crypteq: encrypts plaintext and compares against an encrypted text,
2933 using crypt(), crypt16(), MD5 or SHA-1
2934 inlist/inlisti: checks if first argument is in the list of the second
2935 match: does a regular expression match and sets up the numerical
2936 variables if it succeeds
2937 match_address: matches in an address list
2938 match_domain: matches in a domain list
2939 match_ip: matches a host list that is restricted to IP addresses
2940 match_local_part: matches in a local part list
2943 case ECOND_MATCH_ADDRESS:
2944 case ECOND_MATCH_DOMAIN:
2945 case ECOND_MATCH_IP:
2946 case ECOND_MATCH_LOCAL_PART:
2949 sub2_honour_dollar = FALSE;
2955 case ECOND_NUM_L: /* Numerical comparisons */
2962 case ECOND_STR_LT: /* String comparisons */
2973 for (int i = 0; i < 2; i++)
2976 /* Sometimes, we don't expand substrings; too many insecure configurations
2977 created using match_address{}{} and friends, where the second param
2978 includes information from untrustworthy sources. */
2979 /*XXX is this moot given taint-tracking? */
2981 esi_flags flags = ESI_BRACE_ENDS;
2983 if (!(i > 0 && !sub2_honour_dollar)) flags |= ESI_HONOR_DOLLAR;
2984 if (!yield) flags |= ESI_SKIPPING;
2986 if (Uskip_whitespace(&s) != '{')
2988 if (i == 0) goto COND_FAILED_CURLY_START;
2989 expand_string_message = string_sprintf("missing 2nd string in {} "
2990 "after \"%s\"", opname);
2993 if (!(sub[i] = expand_string_internal(s+1, flags, &s, resetok, &textonly)))
2995 if (textonly) sub_textonly |= BIT(i);
2996 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2997 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2998 " for security reasons\n");
2999 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3001 /* Convert to numerical if required; we know that the names of all the
3002 conditions that compare numbers do not start with a letter. This just saves
3003 checking for them individually. */
3005 if (!isalpha(opname[0]) && yield)
3010 debug_printf_indent("empty string cast to zero for numerical comparison\n");
3014 num[i] = expanded_string_integer(sub[i], FALSE);
3015 if (expand_string_message) goto failout;
3019 /* Result not required */
3021 if (!yield) { next = s; goto out; }
3023 /* Do an appropriate comparison */
3029 tempcond = (num[0] == num[1]); break;
3032 tempcond = (num[0] > num[1]); break;
3035 tempcond = (num[0] >= num[1]); break;
3038 tempcond = (num[0] < num[1]); break;
3041 tempcond = (num[0] <= num[1]); break;
3044 tempcond = (Ustrcmp(sub[0], sub[1]) < 0); break;
3047 tempcond = (strcmpic(sub[0], sub[1]) < 0); break;
3050 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0); break;
3053 tempcond = (strcmpic(sub[0], sub[1]) <= 0); break;
3056 tempcond = (Ustrcmp(sub[0], sub[1]) == 0); break;
3059 tempcond = (strcmpic(sub[0], sub[1]) == 0); break;
3062 tempcond = (Ustrcmp(sub[0], sub[1]) > 0); break;
3065 tempcond = (strcmpic(sub[0], sub[1]) > 0); break;
3068 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0); break;
3071 tempcond = (strcmpic(sub[0], sub[1]) >= 0); break;
3073 case ECOND_MATCH: /* Regular expression match */
3075 const pcre2_code * re = regex_compile(sub[1],
3076 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
3077 &expand_string_message, pcre_gen_cmp_ctx);
3081 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
3085 case ECOND_MATCH_ADDRESS: /* Match in an address list */
3086 rc = match_address_list(sub[0], TRUE,
3087 #ifdef EXPAND_LISTMATCH_RHS
3092 &(sub[1]), NULL, -1, 0,
3093 CUSS &lookup_value);
3094 goto MATCHED_SOMETHING;
3096 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
3097 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
3098 #ifdef EXPAND_LISTMATCH_RHS
3101 MCL_DOMAIN + MCL_NOEXPAND,
3103 TRUE, CUSS &lookup_value);
3104 goto MATCHED_SOMETHING;
3106 case ECOND_MATCH_IP: /* Match IP address in a host list */
3107 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
3109 expand_string_message = string_sprintf("\"%s\" is not an IP address",
3115 unsigned int *nullcache = NULL;
3116 check_host_block cb;
3118 cb.host_name = US"";
3119 cb.host_address = sub[0];
3121 /* If the host address starts off ::ffff: it is an IPv6 address in
3122 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3125 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3126 cb.host_address + 7 : cb.host_address;
3128 rc = match_check_list(
3129 &sub[1], /* the list */
3130 0, /* separator character */
3131 &hostlist_anchor, /* anchor pointer */
3132 &nullcache, /* cache pointer */
3133 check_host, /* function for testing */
3134 &cb, /* argument for function */
3135 #ifdef EXPAND_LISTMATCH_RHS
3138 MCL_HOST + MCL_NOEXPAND,/* type of check */
3140 sub[0], /* text for debugging */
3141 CUSS &lookup_value); /* where to pass back data */
3143 goto MATCHED_SOMETHING;
3145 case ECOND_MATCH_LOCAL_PART:
3146 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3147 #ifdef EXPAND_LISTMATCH_RHS
3150 MCL_LOCALPART+ MCL_NOEXPAND,
3152 TRUE, CUSS &lookup_value);
3158 case OK: tempcond = TRUE; break;
3159 case FAIL: tempcond = FALSE; break;
3162 expand_string_message = string_sprintf("unable to complete match "
3163 "against \"%s\": %s", sub[1], search_error_message);
3169 /* Various "encrypted" comparisons. If the second string starts with
3170 "{" then an encryption type is given. Default to crypt() or crypt16()
3171 (build-time choice). */
3172 /* }-for-text-editors */
3175 #ifndef SUPPORT_CRYPTEQ
3176 goto COND_FAILED_NOT_COMPILED;
3178 if (strncmpic(sub[1], US"{md5}", 5) == 0)
3180 int sublen = Ustrlen(sub[1]+5);
3185 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3187 /* If the length that we are comparing against is 24, the MD5 digest
3188 is expressed as a base64 string. This is the way LDAP does it. However,
3189 some other software uses a straightforward hex representation. We assume
3190 this if the length is 32. Other lengths fail. */
3194 uschar *coded = b64encode(CUS digest, 16);
3195 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3196 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3197 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3199 else if (sublen == 32)
3202 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3204 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3205 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3206 tempcond = (strcmpic(coded, sub[1]+5) == 0);
3210 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3211 "fail\n crypted=%s\n", sub[1]+5);
3216 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3218 int sublen = Ustrlen(sub[1]+6);
3223 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3225 /* If the length that we are comparing against is 28, assume the SHA1
3226 digest is expressed as a base64 string. If the length is 40, assume a
3227 straightforward hex representation. Other lengths fail. */
3231 uschar *coded = b64encode(CUS digest, 20);
3232 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3233 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3234 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3236 else if (sublen == 40)
3239 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3241 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3242 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3243 tempcond = (strcmpic(coded, sub[1]+6) == 0);
3247 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3248 "fail\n crypted=%s\n", sub[1]+6);
3253 else /* {crypt} or {crypt16} and non-{ at start */
3254 /* }-for-text-editors */
3259 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3264 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3269 else if (sub[1][0] == '{') /* }-for-text-editors */
3271 expand_string_message = string_sprintf("unknown encryption mechanism "
3272 "in \"%s\"", sub[1]);
3278 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3279 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
3280 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3284 #define XSTR(s) STR(s)
3285 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3286 " subject=%s\n crypted=%s\n",
3287 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3292 /* If the encrypted string contains fewer than two characters (for the
3293 salt), force failure. Otherwise we get false positives: with an empty
3294 string the yield of crypt() is an empty string! */
3297 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3298 else if (errno == EINVAL)
3302 expand_string_message = string_sprintf("crypt error: %s\n",
3303 US strerror(errno));
3308 #endif /* SUPPORT_CRYPTEQ */
3313 const uschar * list = sub[1];
3315 uschar *save_iterate_item = iterate_item;
3316 int (*compare)(const uschar *, const uschar *);
3318 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);
3320 /* grab any listsep spec, then expand the list */
3322 sep = matchlist_parse_sep(&list);
3323 if (!(list = expand_cstring(list)))
3327 compare = cond_type == ECOND_INLISTI
3328 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3330 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3332 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3333 if (compare(sub[0], iterate_item) == 0)
3336 lookup_value = iterate_item;
3340 iterate_item = save_iterate_item;
3343 } /* Switch for comparison conditions */
3345 *yield = tempcond == testfor;
3346 next = s; goto out; /* End of comparison conditions */
3349 /* and/or: computes logical and/or of several conditions */
3353 subcondptr = (yield == NULL) ? NULL : &tempcond;
3354 combined_cond = (cond_type == ECOND_AND);
3356 Uskip_whitespace(&s);
3357 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3361 /* {-for-text-editors */
3362 if (Uskip_whitespace(&s) == '}') break;
3363 if (*s != '{') /* }-for-text-editors */
3365 expand_string_message = string_sprintf("each subcondition "
3366 "inside an \"%s{...}\" condition must be in its own {}", opname);
3370 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3372 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3373 expand_string_message, opname);
3376 Uskip_whitespace(&s);
3378 /* {-for-text-editors */
3381 /* {-for-text-editors */
3382 expand_string_message = string_sprintf("missing } at end of condition "
3383 "inside \"%s\" group", opname);
3388 if (cond_type == ECOND_AND)
3390 combined_cond &= tempcond;
3391 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3392 } /* evaluate any more */
3395 combined_cond |= tempcond;
3396 if (combined_cond) subcondptr = NULL; /* once true, don't */
3397 } /* evaluate any more */
3400 if (yield) *yield = (combined_cond == testfor);
3401 next = ++s; goto out;
3404 /* forall/forany: iterates a condition with different values */
3406 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3407 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3408 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3409 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3410 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3411 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3415 const uschar * list;
3417 uschar *save_iterate_item = iterate_item;
3419 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3421 /* First expand the list, apart from a leading change-of-separator
3422 on non-json lists */
3424 Uskip_whitespace(&s);
3425 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3427 sep = is_json ? 0 : matchlist_parse_sep(&s);
3429 if (!(sub[0] = expand_string_internal(s,
3430 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
3431 &s, resetok, NULL)))
3433 /* {-for-text-editors */
3434 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3436 Uskip_whitespace(&s);
3437 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3441 /* Call eval_condition once, with result discarded (as if scanning a
3442 "false" part). This allows us to find the end of the condition, because if
3443 the list is empty, we won't actually evaluate the condition for real. */
3445 if (!(s = eval_condition(sub[1], resetok, NULL)))
3447 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3448 expand_string_message, opname);
3451 Uskip_whitespace(&s);
3453 /* {-for-text-editors */
3456 /* {-for-text-editors */
3457 expand_string_message = string_sprintf("missing } at end of condition "
3458 "inside \"%s\"", opname);
3462 /* Now scan the list, checking the condition for each item */
3464 if (yield) *yield = !testfor;
3466 if (is_json) list = dewrap(string_copy(list), US"[]");
3467 while ((iterate_item = is_json
3468 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3471 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3473 expand_string_message =
3474 string_sprintf("%s wrapping string result for extract jsons",
3475 expand_string_message);
3476 iterate_item = save_iterate_item;
3480 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3481 if (!eval_condition(sub[1], resetok, &tempcond))
3483 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3484 expand_string_message, opname);
3485 iterate_item = save_iterate_item;
3488 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3489 tempcond? "true":"false");
3491 if (yield) *yield = (tempcond == testfor);
3492 if (tempcond == is_forany) break;
3495 iterate_item = save_iterate_item;
3500 /* The bool{} expansion condition maps a string to boolean.
3501 The values supported should match those supported by the ACL condition
3502 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3503 of true/false. Note that Router "condition" rules have a different
3504 interpretation, where general data can be used and only a few values
3506 Note that readconf.c boolean matching, for boolean configuration options,
3507 only matches true/yes/false/no.
3508 The bool_lax{} condition matches the Router logic, which is much more
3511 case ECOND_BOOL_LAX:
3517 BOOL boolvalue = FALSE;
3519 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3520 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3521 switch(read_subs(sub_arg, 1, 1, &s,
3522 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, ourname, resetok, NULL))
3524 case 1: expand_string_message = string_sprintf(
3525 "too few arguments or bracketing error for %s",
3529 case 3: goto failout;
3532 Uskip_whitespace(&t);
3533 if ((len = Ustrlen(t)))
3535 /* trailing whitespace: seems like a good idea to ignore it too */
3537 while (isspace(*t2)) t2--;
3538 if (t2 != (t + len))
3545 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3546 /* logic for the lax case from expand_check_condition(), which also does
3547 expands, and the logic is both short and stable enough that there should
3548 be no maintenance burden from replicating it. */
3552 ? Ustrspn(t+1, "0123456789") == len-1
3553 : Ustrspn(t, "0123456789") == len)
3555 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3556 /* expand_check_condition only does a literal string "0" check */
3557 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3560 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3562 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3564 else if (cond_type == ECOND_BOOL_LAX)
3568 expand_string_message = string_sprintf("unrecognised boolean "
3572 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3573 boolvalue? "true":"false");
3574 if (yield) *yield = (boolvalue == testfor);
3579 case ECOND_INBOUND_SRS:
3580 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */
3583 const pcre2_code * re;
3584 pcre2_match_data * md;
3588 BOOL boolvalue = FALSE;
3590 switch(read_subs(sub, 2, 2, CUSS &s,
3591 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, name, resetok, NULL))
3593 case 1: expand_string_message = US"too few arguments or bracketing "
3594 "error for inbound_srs";
3596 case 3: goto failout;
3599 /* Match the given local_part against the SRS-encoded pattern */
3601 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]{2})=([^=]*)=(.*)$",
3602 MCS_CASELESS | MCS_CACHEABLE, FALSE);
3603 md = pcre2_match_data_create(4+1, pcre_gen_ctx);
3604 if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,
3605 md, pcre_gen_mtc_ctx) < 0)
3607 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3610 ovec = pcre2_get_ovector_pointer(md);
3612 if (sub[0][0] == '"')
3614 else for (uschar * s = sub[0]; *s; s++)
3615 if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3616 { quoting = 1; break; }
3618 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3620 /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3622 srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S", /* lowercased */
3624 (int) (ovec[9]-ovec[8]), sub[0] + ovec[8], /* substr 4 */
3626 (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */
3628 /* If a zero-length secret was given, we're done. Otherwise carry on
3629 and validate the given SRS local_part againt our secret. */
3633 /* check the timestamp */
3636 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3640 gettimeofday(&now, NULL);
3641 now.tv_sec /= 86400; /* days since epoch */
3643 /* Decode substring 2 from base32 to a number */
3645 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3647 uschar * t = Ustrchr(base32_chars, *ss++);
3648 d = d * 32 + (t - base32_chars);
3651 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3653 DEBUG(D_expand) debug_printf("SRS too old\n");
3658 /* check length of substring 1, the offered checksum */
3660 if (ovec[3]-ovec[2] != 4)
3662 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3666 /* Hash the address with our secret, and compare that computed checksum
3667 with the one extracted from the arg */
3669 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3670 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3672 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3679 /* pcre2_match_data_free(md); gen ctx needs no free */
3680 if (yield) *yield = (boolvalue == testfor);
3683 #endif /*SUPPORT_SRS*/
3685 /* Unknown condition */
3688 if (!expand_string_message || !*expand_string_message)
3689 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3691 } /* End switch on condition type */
3693 /* Missing braces at start and end of data */
3695 COND_FAILED_CURLY_START:
3696 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3699 COND_FAILED_CURLY_END:
3700 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3704 /* A condition requires code that is not compiled */
3706 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3707 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3708 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3709 COND_FAILED_NOT_COMPILED:
3710 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3725 /*************************************************
3726 * Save numerical variables *
3727 *************************************************/
3729 /* This function is called from items such as "if" that want to preserve and
3730 restore the numbered variables.
3733 save_expand_string points to an array of pointers to set
3734 save_expand_nlength points to an array of ints for the lengths
3736 Returns: the value of expand max to save
3740 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3742 for (int i = 0; i <= expand_nmax; i++)
3744 save_expand_nstring[i] = expand_nstring[i];
3745 save_expand_nlength[i] = expand_nlength[i];
3752 /*************************************************
3753 * Restore numerical variables *
3754 *************************************************/
3756 /* This function restored saved values of numerical strings.
3759 save_expand_nmax the number of strings to restore
3760 save_expand_string points to an array of pointers
3761 save_expand_nlength points to an array of ints
3767 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3768 int *save_expand_nlength)
3770 expand_nmax = save_expand_nmax;
3771 for (int i = 0; i <= expand_nmax; i++)
3773 expand_nstring[i] = save_expand_nstring[i];
3774 expand_nlength[i] = save_expand_nlength[i];
3782 /*************************************************
3783 * Handle yes/no substrings *
3784 *************************************************/
3786 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3787 alternative substrings that depend on whether or not the condition was true,
3788 or the lookup or extraction succeeded. The substrings always have to be
3789 expanded, to check their syntax, but "skipping" is set when the result is not
3790 needed - this avoids unnecessary nested lookups.
3794 skipping TRUE if we were skipping when this item was reached
3795 yes TRUE if the first string is to be used, else use the second
3796 save_lookup a value to put back into lookup_value before the 2nd expansion
3797 sptr points to the input string pointer
3798 yieldptr points to the output growable-string pointer
3799 type "lookup", "if", "extract", "run", "env", "listextract" or
3800 "certextract" for error message
3801 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3804 Returns: 0 OK; lookup_value has been reset to save_lookup
3806 2 expansion failed because of bracketing error
3810 process_yesno(esi_flags flags, BOOL yes, uschar *save_lookup, const uschar **sptr,
3811 gstring ** yieldptr, uschar *type, BOOL *resetok)
3814 const uschar *s = *sptr; /* Local value */
3815 uschar *sub1, *sub2;
3816 const uschar * errwhere;
3818 flags &= ESI_SKIPPING; /* Ignore all buf the skipping flag */
3820 /* If there are no following strings, we substitute the contents of $value for
3821 lookups and for extractions in the success case. For the ${if item, the string
3822 "true" is substituted. In the fail case, nothing is substituted for all three
3825 if (skip_whitespace(&s) == '}')
3829 if (yes && !(flags & ESI_SKIPPING))
3830 *yieldptr = string_catn(*yieldptr, US"true", 4);
3834 if (yes && lookup_value && !(flags & ESI_SKIPPING))
3835 *yieldptr = string_cat(*yieldptr, lookup_value);
3836 lookup_value = save_lookup;
3842 /* The first following string must be braced. */
3846 errwhere = US"'yes' part did not start with '{'"; /*}}*/
3850 /* Expand the first substring. Forced failures are noticed only if we actually
3851 want this string. Set skipping in the call in the fail case (this will always
3852 be the case if we were already skipping). */
3854 sub1 = expand_string_internal(s,
3855 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yes ? ESI_NOFLAGS : ESI_SKIPPING),
3857 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3858 f.expand_string_forcedfail = FALSE;
3862 errwhere = US"'yes' part did not end with '}'";
3866 /* If we want the first string, add it to the output */
3869 *yieldptr = string_cat(*yieldptr, sub1);
3871 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3872 $value to what it was at the start of the item, so that it has this value
3873 during the second string expansion. For the call from "if" or "run" to this
3874 function, save_lookup is set to lookup_value, so that this statement does
3877 lookup_value = save_lookup;
3879 /* There now follows either another substring, or "fail", or nothing. This
3880 time, forced failures are noticed only if we want the second string. We must
3881 set skipping in the nested call if we don't want this string, or if we were
3882 already skipping. */
3884 if (skip_whitespace(&s) == '{') /*}*/
3886 esi_flags s_flags = ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags;
3887 if (yes) s_flags |= ESI_SKIPPING;
3888 sub2 = expand_string_internal(s+1, s_flags, &s, resetok, NULL);
3889 if (!sub2 && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3890 f.expand_string_forcedfail = FALSE; /*{*/
3893 errwhere = US"'no' part did not start with '{'"; /*}*/
3897 /* If we want the second string, add it to the output */
3900 *yieldptr = string_cat(*yieldptr, sub2);
3903 /* If there is no second string, but the word "fail" is present when the use of
3904 the second string is wanted, set a flag indicating it was a forced failure
3905 rather than a syntactic error. Swallow the terminating } in case this is nested
3906 inside another lookup or if or extract. */
3911 /* deconst cast ok here as source is s anyway */
3912 s = US read_name(name, sizeof(name), s, US"_");
3913 if (Ustrcmp(name, "fail") == 0)
3915 if (!yes && !(flags & ESI_SKIPPING))
3917 Uskip_whitespace(&s); /*{{*/
3920 errwhere = US"did not close with '}' after forcedfail";
3923 expand_string_message =
3924 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3925 f.expand_string_forcedfail = TRUE;
3931 expand_string_message =
3932 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3937 /* All we have to do now is to check on the final closing brace. */
3939 skip_whitespace(&s); /*{{*/
3942 errwhere = US"did not close with '}'";
3948 /* Update the input pointer value before returning */
3953 /* Get here if there is a bracketing failure */
3954 expand_string_message = string_sprintf(
3955 "curly-bracket problem in conditional yes/no parsing: %s\n"
3956 " remaining string is '%s'", errwhere, --s);
3961 /* Get here for other failures */
3969 /********************************************************
3970 * prvs: Get last three digits of days since Jan 1, 1970 *
3971 ********************************************************/
3973 /* This is needed to implement the "prvs" BATV reverse
3976 Argument: integer "days" offset to add or substract to
3977 or from the current number of days.
3979 Returns: pointer to string containing the last three
3980 digits of the number of days since Jan 1, 1970,
3981 modified by the offset argument, NULL if there
3982 was an error in the conversion.
3987 prvs_daystamp(int day_offset)
3989 uschar * days = store_get(32, GET_UNTAINTED); /* Need at least 24 for cases */
3990 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3991 (time(NULL) + day_offset*86400)/86400);
3992 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3997 /********************************************************
3998 * prvs: perform HMAC-SHA1 computation of prvs bits *
3999 ********************************************************/
4001 /* This is needed to implement the "prvs" BATV reverse
4005 address RFC2821 Address to use
4006 key The key to use (must be less than 64 characters
4008 key_num Single-digit key number to use. Defaults to
4011 Returns: pointer to string containing the first three
4012 bytes of the final hash in hex format, NULL if
4013 there was an error in the process.
4017 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
4019 gstring * hash_source;
4022 uschar innerhash[20];
4023 uschar finalhash[20];
4024 uschar innerkey[64];
4025 uschar outerkey[64];
4026 uschar *finalhash_hex;
4031 if (Ustrlen(key) > 64)
4034 hash_source = string_catn(NULL, key_num, 1);
4035 hash_source = string_catn(hash_source, daystamp, 3);
4036 hash_source = string_cat(hash_source, address);
4039 debug_printf_indent("prvs: hash source is '%Y'\n", hash_source);
4041 memset(innerkey, 0x36, 64);
4042 memset(outerkey, 0x5c, 64);
4044 for (int i = 0; i < Ustrlen(key); i++)
4046 innerkey[i] ^= key[i];
4047 outerkey[i] ^= key[i];
4050 chash_start(HMAC_SHA1, &h);
4051 chash_mid(HMAC_SHA1, &h, innerkey);
4052 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
4054 chash_start(HMAC_SHA1, &h);
4055 chash_mid(HMAC_SHA1, &h, outerkey);
4056 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
4058 /* Hashing is deemed sufficient to de-taint any input data */
4060 p = finalhash_hex = store_get(40, GET_UNTAINTED);
4061 for (int i = 0; i < 3; i++)
4063 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4064 *p++ = hex_digits[finalhash[i] & 0x0f];
4068 return finalhash_hex;
4074 /*************************************************
4075 * Join a file onto the output string *
4076 *************************************************/
4078 /* This is used for readfile/readsock and after a run expansion.
4079 It joins the contents of a file onto the output string, globally replacing
4080 newlines with a given string (optionally).
4084 yield pointer to the expandable string struct
4085 eol newline replacement string, or NULL
4087 Returns: new pointer for expandable string, terminated if non-null
4091 cat_file(FILE * f, gstring * yield, uschar * eol)
4093 uschar buffer[1024];
4095 while (Ufgets(buffer, sizeof(buffer), f))
4097 int len = Ustrlen(buffer);
4098 if (eol && buffer[len-1] == '\n') len--;
4099 yield = string_catn(yield, buffer, len);
4100 if (eol && buffer[len])
4101 yield = string_cat(yield, eol);
4109 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
4112 uschar buffer[1024];
4114 /*XXX could we read direct into a pre-grown string? */
4116 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
4117 for (uschar * s = buffer; rc--; s++)
4118 yield = eol && *s == '\n'
4119 ? string_cat(yield, eol) : string_catn(yield, s, 1);
4121 /* We assume that all errors, and any returns of zero bytes,
4122 are actually EOF. */
4129 /*************************************************
4130 * Evaluate numeric expression *
4131 *************************************************/
4133 /* This is a set of mutually recursive functions that evaluate an arithmetic
4134 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
4135 these functions that is called from elsewhere is eval_expr, whose interface is:
4138 sptr pointer to the pointer to the string - gets updated
4139 decimal TRUE if numbers are to be assumed decimal
4140 error pointer to where to put an error message - must be NULL on input
4141 endket TRUE if ')' must terminate - FALSE for external call
4143 Returns: on success: the value of the expression, with *error still NULL
4144 on failure: an undefined value, with *error = a message
4147 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4150 static int_eximarith_t
4151 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4154 int_eximarith_t x = eval_op_or(&s, decimal, error);
4159 *error = US"expecting closing parenthesis";
4161 while (isspace(*++s)) ;
4163 *error = US"expecting operator";
4169 static int_eximarith_t
4170 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4176 if (isdigit((c = Uskip_whitespace(&s))))
4179 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4181 switch (tolower(*s))
4184 case 'k': n *= 1024; s++; break;
4185 case 'm': n *= 1024*1024; s++; break;
4186 case 'g': n *= 1024*1024*1024; s++; break;
4188 Uskip_whitespace(&s);
4193 n = eval_expr(&s, decimal, error, 1);
4197 *error = US"expecting number or opening parenthesis";
4205 static int_eximarith_t
4206 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4210 Uskip_whitespace(&s);
4211 if (*s == '+' || *s == '-' || *s == '~')
4214 x = eval_op_unary(&s, decimal, error);
4215 if (op == '-') x = -x;
4216 else if (op == '~') x = ~x;
4219 x = eval_number(&s, decimal, error);
4226 static int_eximarith_t
4227 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4230 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4233 while (*s == '*' || *s == '/' || *s == '%')
4236 int_eximarith_t y = eval_op_unary(&s, decimal, error);
4238 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4239 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4240 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4241 * -N*M is INT_MIN will yield INT_MIN.
4242 * Since we don't support floating point, this is somewhat simpler.
4243 * Ideally, we'd return an error, but since we overflow for all other
4244 * arithmetic, consistency suggests otherwise, but what's the correct value
4245 * to use? There is none.
4246 * The C standard guarantees overflow for unsigned arithmetic but signed
4247 * overflow invokes undefined behaviour; in practice, this is overflow
4248 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4249 * that long/longlong larger than int are available, or we could just work
4250 * with larger types. We should consider whether to guarantee 32bit eval
4251 * and 64-bit working variables, with errors returned. For now ...
4252 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4253 * can just let the other invalid results occur otherwise, as they have
4254 * until now. For this one case, we can coerce.
4256 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4259 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4260 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4270 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4286 static int_eximarith_t
4287 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4290 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4293 while (*s == '+' || *s == '-')
4296 int_eximarith_t y = eval_op_mult(&s, decimal, error);
4298 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4299 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4300 { /* over-conservative check */
4302 ? US"overflow in sum" : US"overflow in difference";
4305 if (op == '+') x += y; else x -= y;
4313 static int_eximarith_t
4314 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4317 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4320 while ((*s == '<' || *s == '>') && s[1] == s[0])
4325 y = eval_op_sum(&s, decimal, error);
4327 if (op == '<') x <<= y; else x >>= y;
4335 static int_eximarith_t
4336 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4339 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4346 y = eval_op_shift(&s, decimal, error);
4356 static int_eximarith_t
4357 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4360 int_eximarith_t x = eval_op_and(&s, decimal, error);
4367 y = eval_op_and(&s, decimal, error);
4377 static int_eximarith_t
4378 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4381 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4388 y = eval_op_xor(&s, decimal, error);
4399 /************************************************/
4400 /* Comparison operation for sort expansion. We need to avoid
4401 re-expanding the fields being compared, so need a custom routine.
4404 cond_type Comparison operator code
4405 leftarg, rightarg Arguments for comparison
4407 Return true iff (leftarg compare rightarg)
4411 sortsbefore(int cond_type, BOOL alpha_cond,
4412 const uschar * leftarg, const uschar * rightarg)
4414 int_eximarith_t l_num, r_num;
4418 l_num = expanded_string_integer(leftarg, FALSE);
4419 if (expand_string_message) return FALSE;
4420 r_num = expanded_string_integer(rightarg, FALSE);
4421 if (expand_string_message) return FALSE;
4425 case ECOND_NUM_G: return l_num > r_num;
4426 case ECOND_NUM_GE: return l_num >= r_num;
4427 case ECOND_NUM_L: return l_num < r_num;
4428 case ECOND_NUM_LE: return l_num <= r_num;
4435 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4436 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4437 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4438 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4439 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4440 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4441 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4442 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4445 return FALSE; /* should not happen */
4449 /* Expand a named list. Return false on failure. */
4451 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4453 tree_node *t = NULL;
4454 const uschar * list;
4457 BOOL needsep = FALSE;
4458 #define LISTNAMED_BUF_SIZE 256
4459 uschar b[LISTNAMED_BUF_SIZE];
4460 uschar * buffer = b;
4462 if (*name == '+') name++;
4463 if (!listtype) /* no-argument version */
4465 if ( !(t = tree_search(addresslist_anchor, name))
4466 && !(t = tree_search(domainlist_anchor, name))
4467 && !(t = tree_search(hostlist_anchor, name)))
4468 t = tree_search(localpartlist_anchor, name);
4470 else switch(*listtype) /* specific list-type version */
4472 case 'a': t = tree_search(addresslist_anchor, name); break;
4473 case 'd': t = tree_search(domainlist_anchor, name); break;
4474 case 'h': t = tree_search(hostlist_anchor, name); break;
4475 case 'l': t = tree_search(localpartlist_anchor, name); break;
4477 expand_string_message = US"bad suffix on \"list\" operator";
4483 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4485 : *listtype=='a'?"address "
4486 : *listtype=='d'?"domain "
4487 : *listtype=='h'?"host "
4488 : *listtype=='l'?"localpart "
4493 list = ((namedlist_block *)(t->data.ptr))->string;
4495 /* The list could be quite long so we (re)use a buffer for each element
4496 rather than getting each in new memory */
4498 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, GET_TAINTED);
4499 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4501 uschar * buf = US" : ";
4503 yield = string_catn(yield, buf, 3);
4507 if (*item == '+') /* list item is itself a named list */
4509 yield = expand_listnamed(yield, item, listtype);
4510 if (expand_string_message)
4514 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
4517 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4519 for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4521 yield = string_catn(yield, item, cp - CS item);
4522 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4523 yield = string_catn(yield, US"::", 2);
4524 else /* sep in item; should already be doubled; emit once */
4526 yield = string_catn(yield, US tok, 1);
4527 if (*cp == sep) cp++;
4530 yield = string_cat(yield, item);
4533 yield = string_cat(yield, item);
4540 /************************************************/
4542 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4545 debug_printf_indent("%V", "K");
4547 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4548 debug_printf("%V", "-");
4550 debug_printf("%s: %.*W\n", what, nchar, value);
4551 if (is_tainted(value))
4552 debug_printf_indent("%V %V(tainted)\n",
4553 flags & ESI_SKIPPING ? "|" : " ", "\\__");
4557 /*************************************************
4559 *************************************************/
4561 /* Returns either an unchanged string, or the expanded string in stacking pool
4562 store. Interpreted sequences are:
4564 \... normal escaping rules
4565 $name substitutes the variable
4567 ${op:string} operates on the expanded string value
4568 ${item{arg1}{arg2}...} expands the args and then does the business
4569 some literal args are not enclosed in {}
4571 There are now far too many operators and item types to make it worth listing
4572 them here in detail any more.
4574 We use an internal routine recursively to handle embedded substrings. The
4575 external function follows. The yield is NULL if the expansion failed, and there
4576 are two cases: if something collapsed syntactically, or if "fail" was given
4577 as the action on a lookup failure. These can be distinguished by looking at the
4578 variable expand_string_forcedfail, which is TRUE in the latter case.
4580 The skipping flag is set true when expanding a substring that isn't actually
4581 going to be used (after "if" or "lookup") and it prevents lookups from
4582 happening lower down.
4584 Store usage: At start, a store block of the length of the input plus 64
4585 is obtained. This is expanded as necessary by string_cat(), which might have to
4586 get a new block, or might be able to expand the original. At the end of the
4587 function we can release any store above that portion of the yield block that
4588 was actually used. In many cases this will be optimal.
4590 However: if the first item in the expansion is a variable name or header name,
4591 we reset the store before processing it; if the result is in fresh store, we
4592 use that without copying. This is helpful for expanding strings like
4593 $message_headers which can get very long.
4595 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4596 since resetting the store at the end of the expansion will free store that was
4597 allocated by the plugin code as well as the slop after the expanded string. So
4598 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4599 and, given the acl condition, ${if }. This is an unfortunate consequence of
4600 string expansion becoming too powerful.
4603 string the string to be expanded
4605 brace_ends expansion is to stop at }
4606 honour_dollar TRUE if $ is to be expanded,
4607 FALSE if it's just another character
4608 skipping TRUE for recursive calls when the value isn't actually going
4609 to be used (to allow for optimisation)
4610 left if not NULL, a pointer to the first character after the
4611 expansion is placed here (typically used with brace_ends)
4612 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4614 textonly_p if not NULL, pointer to flag - write bool for only-met-text
4616 Returns: NULL if expansion fails:
4617 expand_string_forcedfail is set TRUE if failure was forced
4618 expand_string_message contains a textual error message
4619 a pointer to the expanded string on success
4623 expand_string_internal(const uschar * string, esi_flags flags, const uschar ** left,
4624 BOOL *resetok_p, BOOL * textonly_p)
4626 rmark reset_point = store_mark();
4627 gstring * yield = string_get(Ustrlen(string) + 64);
4629 const uschar * s = string;
4630 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4631 int save_expand_nlength[EXPAND_MAXN+1];
4632 BOOL resetok = TRUE, first = TRUE, textonly = TRUE;
4635 f.expand_string_forcedfail = FALSE;
4636 expand_string_message = US"";
4638 if (is_tainted(string))
4640 expand_string_message =
4641 string_sprintf("attempt to expand tainted string '%s'", s);
4642 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4652 debug_printf_indent("%V%V%s: %W\n",
4654 flags & ESI_SKIPPING ? "---" : "",
4655 flags & ESI_SKIPPING ? "scanning" : "considering", s);
4659 /* \ escapes the next character, which must exist, or else
4660 the expansion fails. There's a special escape, \N, which causes
4661 copying of the subject verbatim up to the next \N. Otherwise,
4662 the escapes are the standard set. */
4668 expand_string_message = US"\\ at end of string";
4674 const uschar * t = s + 2;
4675 for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4678 debug_expansion_interim(US"protected", t, (int)(s - t), flags);
4679 if (!(flags & ESI_SKIPPING))
4680 yield = string_catn(yield, t, s - t);
4687 debug_printf_indent("%Vbackslashed: '\\%c'\n", "K", s[1]);
4688 ch[0] = string_interpret_escape(&s);
4689 if (!(flags & ESI_SKIPPING))
4690 yield = string_catn(yield, ch, 1);
4697 /* Anything other than $ is just copied verbatim, unless we are
4698 looking for a terminating } character. */
4700 if (flags & ESI_BRACE_ENDS && *s == '}') break;
4702 if (*s != '$' || !(flags & ESI_HONOR_DOLLAR))
4705 for (const uschar * t = s+1;
4706 *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4708 DEBUG(D_expand) debug_expansion_interim(US"text", s, i, flags);
4710 if (!(flags & ESI_SKIPPING))
4711 yield = string_catn(yield, s, i);
4717 /* No { after the $ - must be a plain name or a number for string
4718 match variable. There has to be a fudge for variables that are the
4719 names of header fields preceded by "$header_" because header field
4720 names can contain any printing characters except space and colon.
4721 For those that don't like typing this much, "$h_" is a synonym for
4722 "$header_". A non-existent header yields a NULL value; nothing is
4727 const uschar * value;
4728 int newsize = 0, len;
4732 s = read_name(name, sizeof(name), s, US"_");
4734 /* If this is the first thing to be expanded, release the pre-allocated
4737 if (!(flags & ESI_SKIPPING))
4739 g = store_get(sizeof(gstring), GET_UNTAINTED);
4740 else if (yield->ptr == 0)
4742 if (resetok) reset_point = store_reset(reset_point);
4744 reset_point = store_mark();
4745 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
4750 if ( ( *(t = name) == 'h'
4751 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4753 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4756 unsigned flags = *name == 'r' ? FH_WANT_RAW
4757 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4759 const uschar * charset = *name == 'b' ? NULL : headers_charset;
4761 s = read_header_name(name, sizeof(name), s);
4762 value = find_header(name, &newsize, flags, charset);
4764 /* If we didn't find the header, and the header contains a closing brace
4765 character, this may be a user error where the terminating colon
4766 has been omitted. Set a flag to adjust the error message in this case.
4767 But there is no error here - nothing gets inserted. */
4771 if (Ustrchr(name, '}')) malformed_header = TRUE;
4778 else if (!(value = find_variable(name, flags, &newsize)))
4780 expand_string_message =
4781 string_sprintf("unknown variable name \"%s\"", name);
4782 check_variable_error_message(name);
4786 /* If the data is known to be in a new buffer, newsize will be set to the
4787 size of that buffer. If this is the first thing in an expansion string,
4788 yield will be NULL; just point it at the new store instead of copying. Many
4789 expansion strings contain just one reference, so this is a useful
4790 optimization, especially for humungous headers. We need to use a gstring
4791 structure that is not allocated after that new-buffer, else a later store
4792 reset in the middle of the buffer will make it inaccessible. */
4794 len = Ustrlen(value);
4795 DEBUG(D_expand) debug_expansion_interim(US"value", value, len, flags);
4796 if (!(flags & ESI_SKIPPING))
4797 if (!yield && newsize != 0)
4800 yield->size = newsize;
4802 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4805 yield = string_catn(yield, value, len);
4810 if (isdigit(*s)) /* A $<n> variable */
4813 s = read_cnumber(&n, s);
4814 if (n >= 0 && n <= expand_nmax)
4816 DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], flags);
4817 if (!(flags & ESI_SKIPPING))
4818 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4823 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4825 if (*s != '{') /*}*/
4827 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4831 /* After { there can be various things, but they all start with
4832 an initial word, except for a number for a string match variable. */ /*}*/
4837 s = read_cnumber(&n, s); /*{{*/
4840 expand_string_message = US"} expected after number";
4843 if (n >= 0 && n <= expand_nmax)
4845 DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], flags);
4846 if (!(flags & ESI_SKIPPING))
4847 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4854 expand_string_message = US"letter or digit expected after ${"; /*}*/
4858 /* Allow "-" in names to cater for substrings with negative
4859 arguments. Since we are checking for known names after { this is
4862 s = read_name(name, sizeof(name), s, US"_-");
4863 item_type = chop_match(name, item_table, nelem(item_table));
4865 /* Switch on item type. All nondefault choices should "continue* when
4866 skipping, but "break" otherwise so we get debug output for the item
4869 int expansion_start = gstring_length(yield);
4872 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4873 If the ACL returns accept or reject we return content set by "message ="
4874 There is currently no limit on recursion; this would have us call
4875 acl_check_internal() directly and get a current level from somewhere.
4876 See also the acl expansion condition ECOND_ACL and the traditional
4877 acl modifier ACLC_ACL.
4878 Assume that the function has side-effects on the store that must be preserved.
4882 /* ${acl {name} {arg1}{arg2}...} */
4884 uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4888 switch(read_subs(sub, nelem(sub), 1, &s, flags, TRUE, name, &resetok, NULL))
4890 case -1: continue; /* skipping */
4891 case 1: goto EXPAND_FAILED_CURLY;
4893 case 3: goto EXPAND_FAILED;
4897 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4902 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4904 yield = string_cat(yield, user_msg);
4908 f.expand_string_forcedfail = TRUE;
4911 expand_string_message = string_sprintf("%s from acl \"%s\"",
4912 rc_names[rc], sub[0]);
4918 case EITEM_AUTHRESULTS:
4919 /* ${authresults {mysystemname}} */
4921 uschar * sub_arg[1];
4923 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4925 case -1: continue; /* If skipping, we don't actually do anything */
4926 case 1: goto EXPAND_FAILED_CURLY;
4928 case 3: goto EXPAND_FAILED;
4931 yield = string_append(yield, 3,
4932 US"Authentication-Results: ", sub_arg[0], US"; none");
4933 yield->ptr -= 6; /* ignore tha ": none" for now */
4935 yield = authres_local(yield, sub_arg[0]);
4936 yield = authres_iprev(yield);
4937 yield = authres_smtpauth(yield);
4938 yield = misc_mod_authres(yield);
4942 /* Handle conditionals - preserve the values of the numerical expansion
4943 variables in case they get changed by a regular expression match in the
4944 condition. If not, they retain their external settings. At the end
4945 of this "if" section, they get restored to their previous values. */
4950 const uschar *next_s;
4951 int save_expand_nmax =
4952 save_expand_strings(save_expand_nstring, save_expand_nlength);
4953 uschar * save_lookup_value = lookup_value;
4955 Uskip_whitespace(&s);
4956 if (!(next_s = eval_condition(s, &resetok, flags & ESI_SKIPPING ? NULL : &cond)))
4957 goto EXPAND_FAILED; /* message already set */
4961 debug_expansion_interim(US"condition", s, (int)(next_s - s), flags);
4962 debug_expansion_interim(US"result",
4963 cond ? US"true" : US"false", cond ? 4 : 5, flags);
4968 /* The handling of "yes" and "no" result strings is now in a separate
4969 function that is also used by ${lookup} and ${extract} and ${run}. */
4971 switch(process_yesno(
4972 flags, /* were previously skipping */
4973 cond, /* success/failure indicator */
4974 lookup_value, /* value to reset for string2 */
4975 &s, /* input pointer */
4976 &yield, /* output pointer */
4977 US"if", /* condition type */
4980 case 1: goto EXPAND_FAILED; /* when all is well, the */
4981 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4984 /* Restore external setting of expansion variables for continuation
4987 lookup_value = save_lookup_value;
4988 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4989 save_expand_nlength);
4994 case EITEM_IMAPFOLDER:
4995 { /* ${imapfolder {name}{sep}{specials}} */
4999 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
5001 case 1: goto EXPAND_FAILED_CURLY;
5003 case 3: goto EXPAND_FAILED;
5006 if (!sub_arg[1]) /* One argument */
5008 sub_arg[1] = US"/"; /* default separator */
5011 else if (Ustrlen(sub_arg[1]) != 1)
5013 expand_string_message =
5015 "IMAP folder separator must be one character, found \"%s\"",
5020 if (flags & ESI_SKIPPING) continue;
5022 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
5023 sub_arg[1][0], sub_arg[2], &expand_string_message)))
5025 yield = string_cat(yield, encoded);
5030 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
5031 expanding an internal string that isn't actually going to be used. All we
5032 need to do is check the syntax, so don't do a lookup at all. Preserve the
5033 values of the numerical expansion variables in case they get changed by a
5034 partial lookup. If not, they retain their external settings. At the end
5035 of this "lookup" section, they get restored to their previous values. */
5039 int expand_setup = 0, nameptr = 0;
5040 int partial, affixlen, starflags;
5041 const lookup_info * li;
5042 uschar * key, * filename;
5043 const uschar * affix, * opts;
5044 uschar * save_lookup_value = lookup_value;
5045 int save_expand_nmax =
5046 save_expand_strings(save_expand_nstring, save_expand_nlength);
5048 if (expand_forbid & RDO_LOOKUP)
5050 expand_string_message = US"lookup expansions are not permitted";
5054 /* Get the key we are to look up for single-key+file style lookups.
5055 Otherwise set the key NULL pro-tem. */
5057 if (Uskip_whitespace(&s) == '{') /*}*/
5059 key = expand_string_internal(s+1,
5060 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
5061 if (!key) goto EXPAND_FAILED; /*{{*/
5064 expand_string_message = US"missing '}' after lookup key";
5065 goto EXPAND_FAILED_CURLY;
5067 Uskip_whitespace(&s);
5071 /* Find out the type of database */
5075 expand_string_message = US"missing lookup type";
5079 /* The type is a string that may contain special characters of various
5080 kinds. Allow everything except space or { to appear; the actual content
5081 is checked by search_findtype_partial. */ /*}*/
5083 while (*s && *s != '{' && !isspace(*s)) /*}*/
5085 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
5088 name[nameptr] = '\0';
5089 Uskip_whitespace(&s);
5091 /* Now check for the individual search type and any partial or default
5092 options. Only those types that are actually in the binary are valid. */
5094 if (!(li = search_findtype_partial(name, &partial, &affix, &affixlen,
5095 &starflags, &opts)))
5097 expand_string_message = search_error_message;
5101 /* Check that a key was provided for those lookup types that need it,
5102 and was not supplied for those that use the query style. */
5104 if (!mac_islookup(li, lookup_querystyle|lookup_absfilequery))
5108 expand_string_message = string_sprintf("missing {key} for single-"
5109 "key \"%s\" lookup", name);
5115 expand_string_message = string_sprintf("a single key was given for "
5116 "lookup type \"%s\", which is not a single-key lookup type", name);
5120 /* Get the next string in brackets and expand it. It is the file name for
5121 single-key+file lookups, and the whole query otherwise. In the case of
5122 queries that also require a file name (e.g. sqlite), the file name comes
5127 expand_string_message = US"missing '{' for lookup file-or-query arg";
5128 goto EXPAND_FAILED_CURLY; /*}}*/
5130 if (!(filename = expand_string_internal(s+1,
5131 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5136 expand_string_message = US"missing '}' closing lookup file-or-query arg";
5137 goto EXPAND_FAILED_CURLY;
5139 Uskip_whitespace(&s);
5141 /* If this isn't a single-key+file lookup, re-arrange the variables
5142 to be appropriate for the search_ functions. For query-style lookups,
5143 there is just a "key", and no file name. For the special query-style +
5144 file types, the query (i.e. "key") starts with a file name. */
5147 key = search_args(li, name, filename, &filename, opts);
5149 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5150 the entry was not found. Note that there is no search_close() function.
5151 Files are left open in case of re-use. At suitable places in higher logic,
5152 search_tidyup() is called to tidy all open files. This can save opening
5153 the same file several times. However, files may also get closed when
5154 others are opened, if too many are open at once. The rule is that a
5155 handle should not be used after a second search_open().
5157 Request that a partial search sets up $1 and maybe $2 by passing
5158 expand_setup containing zero. If its value changes, reset expand_nmax,
5159 since new variables will have been set. Note that at the end of this
5160 "lookup" section, the old numeric variables are restored. */
5162 if (flags & ESI_SKIPPING)
5163 lookup_value = NULL;
5166 void * handle = search_open(filename, li, 0, NULL, NULL);
5169 expand_string_message = search_error_message;
5172 lookup_value = search_find(handle, filename, key, partial, affix,
5173 affixlen, starflags, &expand_setup, opts);
5174 if (f.search_find_defer)
5176 expand_string_message =
5177 string_sprintf("lookup of \"%s\" gave DEFER: %s",
5178 string_printing2(key, SP_TAB), search_error_message);
5181 if (expand_setup > 0) expand_nmax = expand_setup;
5184 /* The handling of "yes" and "no" result strings is now in a separate
5185 function that is also used by ${if} and ${extract}. */
5187 switch(process_yesno(
5188 flags, /* were previously skipping */
5189 lookup_value != NULL, /* success/failure indicator */
5190 save_lookup_value, /* value to reset for string2 */
5191 &s, /* input pointer */
5192 &yield, /* output pointer */
5193 US"lookup", /* condition type */
5196 case 1: goto EXPAND_FAILED; /* when all is well, the */
5197 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5200 /* Restore external setting of expansion variables for carrying on
5201 at this level, and continue. */
5203 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5204 save_expand_nlength);
5206 if (flags & ESI_SKIPPING) continue; else break;
5209 /* If Perl support is configured, handle calling embedded perl subroutines,
5210 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5211 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5212 arguments (defined below). */
5214 #define EXIM_PERL_MAX_ARGS 8
5218 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
5219 "is not included in this binary";
5222 #else /* EXIM_PERL */
5224 uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5225 gstring * new_yield;
5226 const misc_module_info * mi;
5229 if (expand_forbid & RDO_PERL)
5231 expand_string_message = US"Perl calls are not permitted";
5235 if (!(mi = misc_mod_find(US"perl", &errstr)))
5237 expand_string_message =
5238 string_sprintf("failed to locate perl module: %s", errstr);
5242 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, flags, TRUE,
5243 name, &resetok, NULL))
5245 case -1: continue; /* If skipping, we don't actually do anything */
5246 case 1: goto EXPAND_FAILED_CURLY;
5248 case 3: goto EXPAND_FAILED;
5251 /* Start the interpreter if necessary */
5253 if (!opt_perl_started)
5256 typedef uschar * (*fn_t)(uschar *);
5258 if (!opt_perl_startup)
5260 expand_string_message = US"A setting of perl_startup is needed when "
5261 "using the Perl interpreter";
5264 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5265 initerror = (((fn_t *) mi->functions)[PERL_STARTUP]) (opt_perl_startup);
5268 expand_string_message =
5269 string_sprintf("error in perl_startup code: %s\n", initerror);
5272 opt_perl_started = TRUE;
5275 /* Call the function */
5277 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5279 typedef gstring * (*fn_t)(gstring *, uschar **, uschar *, uschar **);
5280 new_yield = (((fn_t *) mi->functions)[PERL_CAT])
5281 (yield, &expand_string_message,
5282 sub_arg[0], sub_arg + 1);
5285 /* NULL yield indicates failure; if the message pointer has been set to
5286 NULL, the yield was undef, indicating a forced failure. Otherwise the
5287 message will indicate some kind of Perl error. */
5291 if (!expand_string_message)
5293 expand_string_message =
5294 string_sprintf("Perl subroutine \"%s\" returned undef to force "
5295 "failure", sub_arg[0]);
5296 f.expand_string_forcedfail = TRUE;
5301 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5302 set during a callback from Perl. */
5304 f.expand_string_forcedfail = FALSE;
5308 #endif /* EXIM_PERL */
5310 /* Transform email address to "prvs" scheme to use
5311 as BATV-signed return path */
5315 uschar * sub_arg[3], * p, * domain;
5317 switch(read_subs(sub_arg, 3, 2, &s, flags, TRUE, name, &resetok, NULL))
5319 case -1: continue; /* If skipping, we don't actually do anything */
5320 case 1: goto EXPAND_FAILED_CURLY;
5322 case 3: goto EXPAND_FAILED;
5325 /* sub_arg[0] is the address */
5326 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
5327 || domain == sub_arg[0] || Ustrlen(domain) == 1)
5329 expand_string_message = US"prvs first argument must be a qualified email address";
5333 /* Calculate the hash. The third argument must be a single-digit
5334 key number, or unset. */
5337 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5339 expand_string_message = US"prvs third argument must be a single digit";
5343 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5346 expand_string_message = US"prvs hmac-sha1 conversion failed";
5350 /* Now separate the domain from the local part */
5353 yield = string_catn(yield, US"prvs=", 5);
5354 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5355 yield = string_catn(yield, prvs_daystamp(7), 3);
5356 yield = string_catn(yield, p, 6);
5357 yield = string_catn(yield, US"=", 1);
5358 yield = string_cat (yield, sub_arg[0]);
5359 yield = string_catn(yield, US"@", 1);
5360 yield = string_cat (yield, domain);
5365 /* Check a prvs-encoded address for validity */
5367 case EITEM_PRVSCHECK:
5369 uschar * sub_arg[3], * p;
5371 const pcre2_code * re;
5373 /* Reset expansion variables */
5374 prvscheck_result = NULL;
5375 prvscheck_address = NULL;
5376 prvscheck_keynum = NULL;
5378 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5380 case 1: goto EXPAND_FAILED_CURLY;
5382 case 3: goto EXPAND_FAILED;
5385 re = regex_must_compile(
5386 US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5387 MCS_CASELESS | MCS_CACHEABLE, FALSE);
5389 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5391 uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5392 uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5393 uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5394 uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5395 uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5399 debug_printf_indent("prvscheck localpart: %s\n", local_part);
5400 debug_printf_indent("prvscheck key number: %s\n", key_num);
5401 debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5402 debug_printf_indent("prvscheck hash: %s\n", hash);
5403 debug_printf_indent("prvscheck domain: %s\n", domain);
5406 /* Set up expansion variables */
5407 g = string_cat (NULL, local_part);
5408 g = string_catn(g, US"@", 1);
5409 g = string_cat (g, domain);
5410 prvscheck_address = string_from_gstring(g);
5411 prvscheck_keynum = string_copy(key_num);
5413 /* Now expand the second argument */
5414 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5416 case 1: goto EXPAND_FAILED_CURLY;
5418 case 3: goto EXPAND_FAILED;
5421 /* Now we have the key and can check the address. */
5423 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5427 expand_string_message = US"hmac-sha1 conversion failed";
5431 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5432 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
5434 if (Ustrcmp(p,hash) == 0)
5436 /* Success, valid BATV address. Now check the expiry date. */
5437 uschar *now = prvs_daystamp(0);
5438 unsigned int inow = 0,iexpire = 1;
5440 (void)sscanf(CS now,"%u",&inow);
5441 (void)sscanf(CS daystamp,"%u",&iexpire);
5443 /* When "iexpire" is < 7, a "flip" has occurred.
5444 Adjust "inow" accordingly. */
5445 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5447 if (iexpire >= inow)
5449 prvscheck_result = US"1";
5450 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $prvscheck_result set to 1\n");
5454 prvscheck_result = NULL;
5455 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $prvscheck_result unset\n");
5460 prvscheck_result = NULL;
5461 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $prvscheck_result unset\n");
5464 /* Now expand the final argument. We leave this till now so that
5465 it can include $prvscheck_result. */
5467 switch(read_subs(sub_arg, 1, 0, &s, flags, TRUE, name, &resetok, NULL))
5469 case 1: goto EXPAND_FAILED_CURLY;
5471 case 3: goto EXPAND_FAILED;
5474 yield = string_cat(yield,
5475 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5477 /* Reset the "internal" variables afterwards, because they are in
5478 dynamic store that will be reclaimed if the expansion succeeded. */
5480 prvscheck_address = NULL;
5481 prvscheck_keynum = NULL;
5484 /* Does not look like a prvs encoded address, return the empty string.
5485 We need to make sure all subs are expanded first, so as to skip over
5488 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5490 case 1: goto EXPAND_FAILED_CURLY;
5492 case 3: goto EXPAND_FAILED;
5495 if (flags & ESI_SKIPPING) continue;
5499 /* Handle "readfile" to insert an entire file */
5501 case EITEM_READFILE:
5504 uschar * sub_arg[2];
5506 if (expand_forbid & RDO_READFILE)
5508 expand_string_message = US"file insertions are not permitted";
5512 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5514 case -1: continue; /* If skipping, we don't actually do anything */
5515 case 1: goto EXPAND_FAILED_CURLY;
5517 case 3: goto EXPAND_FAILED;
5520 /* Open the file and read it */
5522 if (!(f = Ufopen(sub_arg[0], "rb")))
5524 expand_string_message = string_open_failed("%s", sub_arg[0]);
5528 yield = cat_file(f, yield, sub_arg[1]);
5533 /* Handle "readsocket" to insert data from a socket, either
5534 Inet or Unix domain */
5536 case EITEM_READSOCK:
5539 uschar * sub_arg[4];
5541 if (expand_forbid & RDO_READSOCK)
5543 expand_string_message = US"socket insertions are not permitted";
5547 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5548 because there may be a string for expansion on failure. */
5550 switch(read_subs(sub_arg, 4, 2, &s, flags, FALSE, name, &resetok, NULL))
5552 case 1: goto EXPAND_FAILED_CURLY;
5553 case 2: /* Won't occur: no end check */
5554 case 3: goto EXPAND_FAILED;
5557 /* If skipping, we don't actually do anything. Otherwise, arrange to
5558 connect to either an IP or a Unix socket. */
5560 if (!(flags & ESI_SKIPPING))
5562 const lookup_info * li = search_findtype(US"readsock", 8);
5565 int expand_setup = -1;
5570 expand_string_message = search_error_message;
5574 /* If the reqstr is empty, flag that and set a dummy */
5578 g = string_append_listele(g, ',', US"send=no");
5579 sub_arg[1] = US"DUMMY";
5582 /* Re-marshall the options */
5586 const uschar * list = sub_arg[2];
5590 /* First option has no tag and is timeout */
5591 if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5592 g = string_append_listele_fmt(g, ',', TRUE, "timeout=%s", item);
5594 /* The rest of the options from the expansion */
5595 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5596 g = string_append_listele(g, ',', item);
5598 /* possibly plus an EOL string. Process with escapes, to protect
5599 from list-processing. The only current user of eol= in search
5600 options is the readsock expansion. */
5602 if (sub_arg[3] && *sub_arg[3])
5603 g = string_append_listele_fmt(g, ',', TRUE,
5604 "eol=%s", string_printing2(sub_arg[3], SP_TAB|SP_SPACE));
5607 /* Gat a (possibly cached) handle for the connection */
5609 if (!(handle = search_open(sub_arg[0], li, 0, NULL, NULL)))
5611 if (*expand_string_message) goto EXPAND_FAILED;
5612 expand_string_message = search_error_message;
5613 search_error_message = NULL;
5617 /* Get (possibly cached) results for the lookup */
5618 /* sspec: sub_arg[0] req: sub_arg[1] opts: g */
5620 if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5621 &expand_setup, string_from_gstring(g))))
5622 yield = string_cat(yield, s);
5623 else if (f.search_find_defer)
5625 expand_string_message = search_error_message;
5626 search_error_message = NULL;
5630 { /* should not happen, at present */
5631 expand_string_message = search_error_message;
5632 search_error_message = NULL;
5637 /* The whole thing has worked (or we were skipping). If there is a
5638 failure string following, we need to skip it. */
5640 if (*s == '{') /*}*/
5642 if (!expand_string_internal(s+1,
5643 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL))
5644 goto EXPAND_FAILED; /*{*/
5647 expand_string_message = US"missing '}' closing failstring for readsocket";
5648 goto EXPAND_FAILED_CURLY;
5650 Uskip_whitespace(&s);
5653 READSOCK_DONE: /*{*/
5656 expand_string_message = US"missing '}' closing readsocket";
5657 goto EXPAND_FAILED_CURLY;
5659 if (flags & ESI_SKIPPING) continue; else break;
5661 /* Come here on failure to create socket, connect socket, write to the
5662 socket, or timeout on reading. If another substring follows, expand and
5663 use it. Otherwise, those conditions give expand errors. */
5666 if (*s != '{') goto EXPAND_FAILED; /*}*/
5667 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5668 if (!(arg = expand_string_internal(s+1,
5669 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR, &s, &resetok, NULL)))
5671 yield = string_cat(yield, arg); /*{*/
5674 expand_string_message = US"missing '}' closing failstring for readsocket";
5675 goto EXPAND_FAILED_CURLY;
5677 Uskip_whitespace(&s);
5681 /* Handle "run" to execute a program. */
5686 const uschar * arg, ** argv;
5687 unsigned late_expand = TSUC_EXPAND_ARGS | TSUC_ALLOW_TAINTED_ARGS | TSUC_ALLOW_RECIPIENTS;
5689 if (expand_forbid & RDO_RUN)
5691 expand_string_message = US"running a command is not permitted";
5695 /* Handle options to the "run" */
5698 if (Ustrncmp(++s, "preexpand", 9) == 0)
5699 { late_expand = 0; s += 9; }
5702 const uschar * t = s;
5703 while (isalpha(*++t)) ;
5704 expand_string_message = string_sprintf("bad option '%.*s' for run",
5708 Uskip_whitespace(&s);
5710 if (*s != '{') /*}*/
5712 expand_string_message = US"missing '{' for command arg of run";
5713 goto EXPAND_FAILED_CURLY; /*"}*/
5717 if (late_expand) /* this is the default case */
5721 /* Locate the end of the args */
5722 (void) expand_string_internal(s,
5723 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &t, NULL, NULL);
5725 arg = flags & ESI_SKIPPING ? NULL : string_copyn(s, n);
5731 debug_printf_indent("args string for ${run} expand before split\n");
5732 if (!(arg = expand_string_internal(s,
5733 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5735 Uskip_whitespace(&s);
5740 expand_string_message = US"missing '}' closing command arg of run";
5741 goto EXPAND_FAILED_CURLY;
5744 if (flags & ESI_SKIPPING) /* Just pretend it worked when we're skipping */
5747 lookup_value = NULL;
5754 if (!transport_set_up_command(&argv, /* anchor for arg list */
5755 arg, /* raw command */
5756 late_expand, /* expand args if not already done */
5757 0, /* not relevant when... */
5758 NULL, /* no transporting address */
5759 US"${run} expansion", /* for error messages */
5760 &expand_string_message)) /* where to put error message */
5763 /* Create the child process, making it a group leader. */
5765 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5766 US"expand-run")) < 0)
5768 expand_string_message =
5769 string_sprintf("couldn't create child process: %s", strerror(errno));
5773 /* Nothing is written to the standard input. */
5777 /* Read the pipe to get the command's output into $value (which is kept
5778 in lookup_value). Read during execution, so that if the output exceeds
5779 the OS pipe buffer limit, we don't block forever. Remember to not release
5780 memory just allocated for $value. */
5783 f = fdopen(fd_out, "rb");
5784 sigalrm_seen = FALSE;
5786 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5790 /* Wait for the process to finish, applying the timeout, and inspect its
5791 return code for serious disasters. Simple non-zero returns are passed on.
5794 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5796 if (sigalrm_seen || runrc == -256)
5798 expand_string_message = US"command timed out";
5799 killpg(pid, SIGKILL); /* Kill the whole process group */
5802 else if (runrc == -257)
5803 expand_string_message = string_sprintf("wait() failed: %s",
5807 expand_string_message = string_sprintf("command killed by signal %d",
5814 /* Process the yes/no strings; $value may be useful in both cases */
5816 switch(process_yesno(
5817 flags, /* were previously skipping */
5818 runrc == 0, /* success/failure indicator */
5819 lookup_value, /* value to reset for string2 */
5820 &s, /* input pointer */
5821 &yield, /* output pointer */
5822 US"run", /* condition type */
5825 case 1: goto EXPAND_FAILED; /* when all is well, the */
5826 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5829 if (flags & ESI_SKIPPING) continue; else break;
5832 /* Handle character translation for "tr" */
5836 int oldptr = gstring_length(yield);
5840 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5842 case -1: continue; /* skipping */
5843 case 1: goto EXPAND_FAILED_CURLY;
5845 case 3: goto EXPAND_FAILED;
5848 if ( (yield = string_cat(yield, sub[0]))
5849 && (o2m = Ustrlen(sub[2]) - 1) >= 0)
5850 for (; oldptr < yield->ptr; oldptr++)
5852 uschar * m = Ustrrchr(sub[1], yield->s[oldptr]);
5856 yield->s[oldptr] = sub[2][o < o2m ? o : o2m];
5863 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5864 expanded arguments. */
5873 int val[2] = { 0, -1 };
5876 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5877 Ensure that sub[2] is set in the ${length } case. */
5880 switch(read_subs(sub, item_type == EITEM_LENGTH ? 2:3, 2, &s, flags,
5881 TRUE, name, &resetok, NULL))
5883 case -1: continue; /* skipping */
5884 case 1: goto EXPAND_FAILED_CURLY;
5886 case 3: goto EXPAND_FAILED;
5889 /* Juggle the arguments if there are only two of them: always move the
5890 string to the last position and make ${length{n}{str}} equivalent to
5891 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5897 if (item_type == EITEM_LENGTH)
5904 for (int i = 0; i < 2; i++) if (sub[i])
5906 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5907 if (*ret != 0 || (i != 0 && val[i] < 0))
5909 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5910 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5916 item_type == EITEM_HASH
5917 ? compute_hash(sub[2], val[0], val[1], &len)
5918 : item_type == EITEM_NHASH
5919 ? compute_nhash(sub[2], val[0], val[1], &len)
5920 : extract_substr(sub[2], val[0], val[1], &len);
5923 yield = string_catn(yield, ret, len);
5927 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5928 This code originally contributed by Steve Haslam. It currently supports
5929 the use of MD5 and SHA-1 hashes.
5931 We need some workspace that is large enough to handle all the supported
5932 hash types. Use macros to set the sizes rather than be too elaborate. */
5934 #define MAX_HASHLEN 20
5935 #define MAX_HASHBLOCKLEN 64
5944 int hashlen; /* Number of octets for the hash algorithm's output */
5945 int hashblocklen; /* Number of octets the hash algorithm processes */
5946 uschar * keyptr, * p;
5947 unsigned int keylen;
5949 uschar keyhash[MAX_HASHLEN];
5950 uschar innerhash[MAX_HASHLEN];
5951 uschar finalhash[MAX_HASHLEN];
5952 uschar finalhash_hex[2*MAX_HASHLEN];
5953 uschar innerkey[MAX_HASHBLOCKLEN];
5954 uschar outerkey[MAX_HASHBLOCKLEN];
5956 switch (read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5958 case -1: continue; /* skipping */
5959 case 1: goto EXPAND_FAILED_CURLY;
5961 case 3: goto EXPAND_FAILED;
5964 if (Ustrcmp(sub[0], "md5") == 0)
5967 use_base = &md5_base;
5971 else if (Ustrcmp(sub[0], "sha1") == 0)
5974 use_base = &sha1_ctx;
5980 expand_string_message =
5981 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5986 keylen = Ustrlen(keyptr);
5988 /* If the key is longer than the hash block length, then hash the key
5991 if (keylen > hashblocklen)
5993 chash_start(type, use_base);
5994 chash_end(type, use_base, keyptr, keylen, keyhash);
5999 /* Now make the inner and outer key values */
6001 memset(innerkey, 0x36, hashblocklen);
6002 memset(outerkey, 0x5c, hashblocklen);
6004 for (int i = 0; i < keylen; i++)
6006 innerkey[i] ^= keyptr[i];
6007 outerkey[i] ^= keyptr[i];
6010 /* Now do the hashes */
6012 chash_start(type, use_base);
6013 chash_mid(type, use_base, innerkey);
6014 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
6016 chash_start(type, use_base);
6017 chash_mid(type, use_base, outerkey);
6018 chash_end(type, use_base, innerhash, hashlen, finalhash);
6020 /* Encode the final hash as a hex string */
6023 for (int i = 0; i < hashlen; i++)
6025 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
6026 *p++ = hex_digits[finalhash[i] & 0x0f];
6029 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
6030 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
6032 yield = string_catn(yield, finalhash_hex, hashlen*2);
6036 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
6037 We have to save the numerical variables and restore them afterwards. */
6041 const pcre2_code * re;
6042 int moffset, moffsetextra, slen;
6043 pcre2_match_data * md;
6045 uschar * subject, * sub[3];
6046 int save_expand_nmax =
6047 save_expand_strings(save_expand_nstring, save_expand_nlength);
6048 unsigned sub_textonly = 0;
6050 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, &sub_textonly))
6052 case -1: continue; /* skipping */
6053 case 1: goto EXPAND_FAILED_CURLY;
6055 case 3: goto EXPAND_FAILED;
6058 /* Compile the regular expression */
6060 re = regex_compile(sub[1],
6061 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
6062 &expand_string_message, pcre_gen_cmp_ctx);
6066 md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
6068 /* Now run a loop to do the substitutions as often as necessary. It ends
6069 when there are no more matches. Take care over matches of the null string;
6070 do the same thing as Perl does. */
6073 slen = Ustrlen(sub[0]);
6074 moffset = moffsetextra = 0;
6079 PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
6080 int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
6081 PCRE_EOPT | emptyopt, md, pcre_gen_mtc_ctx);
6084 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
6085 is not necessarily the end. We want to repeat the match from one
6086 character further along, but leaving the basic offset the same (for
6087 copying below). We can't be at the end of the string - that was checked
6088 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
6089 finished; copy the remaining string and end the loop. */
6099 yield = string_catn(yield, subject+moffset, slen-moffset);
6103 /* Match - set up for expanding the replacement. */
6104 DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
6106 if (n == 0) n = EXPAND_MAXN + 1;
6108 for (int nn = 0; nn < n*2; nn += 2)
6110 expand_nstring[expand_nmax] = subject + ovec[nn];
6111 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
6115 /* Copy the characters before the match, plus the expanded insertion. */
6117 yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
6119 if (!(insert = expand_string(sub[2])))
6121 yield = string_cat(yield, insert);
6127 /* If we have matched an empty string, first check to see if we are at
6128 the end of the subject. If so, the loop is over. Otherwise, mimic
6129 what Perl's /g options does. This turns out to be rather cunning. First
6130 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
6131 string at the same point. If this fails (picked up above) we advance to
6132 the next character. */
6134 if (ovec[0] == ovec[1])
6136 if (ovec[0] == slen) break;
6137 emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
6141 /* All done - restore numerical variables. */
6143 /* pcre2_match_data_free(md); gen ctx needs no free */
6144 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6145 save_expand_nlength);
6149 /* Handle keyed and numbered substring extraction. If the first argument
6150 consists entirely of digits, then a numerical extraction is assumed. */
6154 int field_number = 1;
6155 BOOL field_number_set = FALSE;
6156 uschar * save_lookup_value = lookup_value, * sub[3];
6157 int save_expand_nmax =
6158 save_expand_strings(save_expand_nstring, save_expand_nlength);
6160 /* On reflection the original behaviour of extract-json for a string
6161 result, leaving it quoted, was a mistake. But it was already published,
6162 hence the addition of jsons. In a future major version, make json
6163 work like josons, and withdraw jsons. */
6165 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
6167 /* Check for a format-variant specifier */
6169 if (Uskip_whitespace(&s) != '{') /*}*/
6170 if (Ustrncmp(s, "json", 4) == 0)
6171 if (*(s += 4) == 's')
6172 {fmt = extract_jsons; s++;}
6176 /* While skipping we cannot rely on the data for expansions being
6177 available (eg. $item) hence cannot decide on numeric vs. keyed.
6178 Read a maximum of 5 arguments (including the yes/no) */
6180 if (flags & ESI_SKIPPING)
6182 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
6184 if (!expand_string_internal(s+1,
6185 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL))
6186 goto EXPAND_FAILED; /*'{'*/
6189 expand_string_message = US"missing '{' for arg of extract";
6190 goto EXPAND_FAILED_CURLY;
6192 Uskip_whitespace(&s);
6194 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
6195 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
6199 Uskip_whitespace(&s);
6203 expand_string_message = US"missing '}' closing extract";
6204 goto EXPAND_FAILED_CURLY;
6208 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
6210 if (Uskip_whitespace(&s) == '{') /*'}'*/
6212 if (!(sub[i] = expand_string_internal(s+1,
6213 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6214 goto EXPAND_FAILED; /*'{'*/
6217 expand_string_message = string_sprintf(
6218 "missing '}' closing arg %d of extract", i+1);
6219 goto EXPAND_FAILED_CURLY;
6222 /* After removal of leading and trailing white space, the first
6223 argument must not be empty; if it consists entirely of digits
6224 (optionally preceded by a minus sign), this is a numerical
6225 extraction, and we expect 3 arguments (normal) or 2 (json). */
6231 uschar * p = sub[0];
6233 Uskip_whitespace(&p);
6237 while (len > 0 && isspace(p[len-1])) len--;
6242 expand_string_message = US"first argument of \"extract\" must "
6252 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6256 if (fmt == extract_basic) j = 3; /* Need 3 args */
6257 field_number_set = TRUE;
6263 expand_string_message = string_sprintf(
6264 "missing '{' for arg %d of extract", i+1);
6265 goto EXPAND_FAILED_CURLY;
6269 /* Extract either the numbered or the keyed substring into $value. If
6270 skipping, just pretend the extraction failed. */
6272 if (flags & ESI_SKIPPING)
6273 lookup_value = NULL;
6277 lookup_value = field_number_set
6278 ? expand_gettokened(field_number, sub[1], sub[2])
6279 : expand_getkeyed(sub[0], sub[1]);
6286 const uschar * list;
6288 /* Array: Bracket-enclosed and comma-separated.
6289 Object: Brace-enclosed, comma-sep list of name:value pairs */
6291 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6293 expand_string_message =
6294 string_sprintf("%s wrapping %s for extract json",
6295 expand_string_message,
6296 field_number_set ? "array" : "object");
6297 goto EXPAND_FAILED_CURLY;
6301 if (field_number_set)
6303 if (field_number <= 0)
6305 expand_string_message = US"first argument of \"extract\" must "
6306 "be greater than zero";
6309 while (field_number > 0 && (item = json_nextinlist(&list)))
6311 if ((lookup_value = s = item))
6314 while (--s >= lookup_value && isspace(*s)) *s = '\0';
6319 lookup_value = NULL;
6320 while ((item = json_nextinlist(&list)))
6322 /* Item is: string name-sep value. string is quoted.
6323 Dequote the string and compare with the search key. */
6325 if (!(item = dewrap(item, US"\"\"")))
6327 expand_string_message =
6328 string_sprintf("%s wrapping string key for extract json",
6329 expand_string_message);
6330 goto EXPAND_FAILED_CURLY;
6332 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
6334 s = item + Ustrlen(item) + 1;
6335 if (Uskip_whitespace(&s) != ':')
6337 expand_string_message =
6338 US"missing object value-separator for extract json";
6339 goto EXPAND_FAILED_CURLY;
6342 Uskip_whitespace(&s);
6350 if ( fmt == extract_jsons
6352 && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6354 expand_string_message =
6355 string_sprintf("%s wrapping string result for extract jsons",
6356 expand_string_message);
6357 goto EXPAND_FAILED_CURLY;
6362 /* If no string follows, $value gets substituted; otherwise there can
6363 be yes/no strings, as for lookup or if. */
6365 switch(process_yesno(
6366 flags, /* were previously skipping */
6367 lookup_value != NULL, /* success/failure indicator */
6368 save_lookup_value, /* value to reset for string2 */
6369 &s, /* input pointer */
6370 &yield, /* output pointer */
6371 US"extract", /* condition type */
6374 case 1: goto EXPAND_FAILED; /* when all is well, the */
6375 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6378 /* All done - restore numerical variables. */
6380 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6381 save_expand_nlength);
6383 if (flags & ESI_SKIPPING) continue; else break;
6386 /* return the Nth item from a list */
6388 case EITEM_LISTEXTRACT:
6390 int field_number = 1, sep = 0;
6391 uschar * save_lookup_value = lookup_value, * sub[2];
6392 int save_expand_nmax =
6393 save_expand_strings(save_expand_nstring, save_expand_nlength);
6395 /* Read the field & list arguments */
6396 /*XXX Could we use read_subs here (and get better efficiency for skipping)? */
6398 for (int i = 0; i < 2; i++)
6400 if (Uskip_whitespace(&s) != '{') /*}*/
6402 expand_string_message = string_sprintf(
6403 "missing '{' for arg %d of listextract", i+1); /*}*/
6404 goto EXPAND_FAILED_CURLY;
6408 if (i == 1) sep = matchlist_parse_sep(&s);
6410 sub[i] = expand_string_internal(s,
6411 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6412 if (!sub[i]) goto EXPAND_FAILED; /*{{*/
6415 expand_string_message = string_sprintf(
6416 "missing '}' closing arg %d of listextract", i+1);
6417 goto EXPAND_FAILED_CURLY;
6420 /* After removal of leading and trailing white space, the first
6421 argument must be numeric and nonempty. */
6429 Uskip_whitespace(&p);
6433 while (len > 0 && isspace(p[len-1])) len--;
6436 if (!*p && !(flags & ESI_SKIPPING))
6438 expand_string_message = US"first argument of \"listextract\" must "
6448 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6451 expand_string_message = US"first argument of \"listextract\" must "
6459 /* Extract the numbered element into $value. If
6460 skipping, just pretend the extraction failed. */
6462 lookup_value = flags & ESI_SKIPPING
6463 ? NULL : expand_getlistele(field_number, sub[1], sep);
6465 /* If no string follows, $value gets substituted; otherwise there can
6466 be yes/no strings, as for lookup or if. */
6468 switch(process_yesno(
6469 flags, /* were previously skipping */
6470 lookup_value != NULL, /* success/failure indicator */
6471 save_lookup_value, /* value to reset for string2 */
6472 &s, /* input pointer */
6473 &yield, /* output pointer */
6474 US"listextract", /* condition type */
6477 case 1: goto EXPAND_FAILED; /* when all is well, the */
6478 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6481 /* All done - restore numerical variables. */
6483 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6484 save_expand_nlength);
6486 if (flags & ESI_SKIPPING) continue; else break;
6489 case EITEM_LISTQUOTE:
6492 switch(read_subs(sub, 2, 2, &s, flags, TRUE, name, &resetok, NULL))
6494 case -1: continue; /* skipping */
6495 case 1: goto EXPAND_FAILED_CURLY;
6497 case 3: goto EXPAND_FAILED;
6499 if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6501 if (c == sep) yield = string_catn(yield, sub[1], 1);
6502 yield = string_catn(yield, sub[1], 1);
6504 else yield = string_catn(yield, US" ", 1);
6509 case EITEM_CERTEXTRACT:
6511 uschar * save_lookup_value = lookup_value, * sub[2];
6512 int save_expand_nmax =
6513 save_expand_strings(save_expand_nstring, save_expand_nlength);
6515 /* Read the field argument */
6516 if (Uskip_whitespace(&s) != '{') /*}*/
6518 expand_string_message = US"missing '{' for field arg of certextract";
6519 goto EXPAND_FAILED_CURLY; /*}*/
6521 sub[0] = expand_string_internal(s+1,
6522 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6523 if (!sub[0]) goto EXPAND_FAILED; /*{{*/
6526 expand_string_message = US"missing '}' closing field arg of certextract";
6527 goto EXPAND_FAILED_CURLY;
6529 /* strip spaces fore & aft */
6534 Uskip_whitespace(&p);
6538 while (len > 0 && isspace(p[len-1])) len--;
6542 /* inspect the cert argument */
6543 if (Uskip_whitespace(&s) != '{') /*}*/
6545 expand_string_message = US"missing '{' for cert variable arg of certextract";
6546 goto EXPAND_FAILED_CURLY; /*}*/
6550 expand_string_message = US"second argument of \"certextract\" must "
6551 "be a certificate variable";
6554 sub[1] = expand_string_internal(s+1,
6555 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6556 if (!sub[1]) goto EXPAND_FAILED; /*{{*/
6559 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6560 goto EXPAND_FAILED_CURLY;
6563 if (flags & ESI_SKIPPING)
6564 lookup_value = NULL;
6567 lookup_value = expand_getcertele(sub[0], sub[1]);
6568 if (*expand_string_message) goto EXPAND_FAILED;
6570 switch(process_yesno(
6571 flags, /* were previously skipping */
6572 lookup_value != NULL, /* success/failure indicator */
6573 save_lookup_value, /* value to reset for string2 */
6574 &s, /* input pointer */
6575 &yield, /* output pointer */
6576 US"certextract", /* condition type */
6579 case 1: goto EXPAND_FAILED; /* when all is well, the */
6580 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6583 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6584 save_expand_nlength);
6585 if (flags & ESI_SKIPPING) continue; else break;
6587 #endif /*DISABLE_TLS*/
6589 /* Handle list operations */
6595 int sep, save_ptr = gstring_length(yield);
6596 uschar outsep[2] = { '\0', '\0' };
6597 const uschar *list, *expr, *temp;
6598 uschar * save_iterate_item = iterate_item;
6599 uschar * save_lookup_value = lookup_value;
6601 Uskip_whitespace(&s);
6602 if (*s++ != '{') /*}*/
6604 expand_string_message =
6605 string_sprintf("missing '{' for first arg of %s", name);
6606 goto EXPAND_FAILED_CURLY; /*}*/
6609 DEBUG(D_expand) debug_printf_indent("%s: evaluate input list list\n", name);
6610 /* Check for a list-sep spec before expansion */
6611 sep = matchlist_parse_sep(&s);
6613 if (!(list = expand_string_internal(s,
6614 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6615 goto EXPAND_FAILED; /*{{*/
6618 expand_string_message =
6619 string_sprintf("missing '}' closing first arg of %s", name);
6620 goto EXPAND_FAILED_CURLY;
6623 if (item_type == EITEM_REDUCE)
6626 Uskip_whitespace(&s);
6627 if (*s++ != '{') /*}*/
6629 expand_string_message = US"missing '{' for second arg of reduce";
6630 goto EXPAND_FAILED_CURLY; /*}*/
6632 DEBUG(D_expand) debug_printf_indent("reduce: initial result list\n");
6633 t = expand_string_internal(s,
6634 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6635 if (!t) goto EXPAND_FAILED;
6636 lookup_value = t; /*{{*/
6639 expand_string_message = US"missing '}' closing second arg of reduce";
6640 goto EXPAND_FAILED_CURLY;
6644 Uskip_whitespace(&s);
6645 if (*s++ != '{') /*}*/
6647 expand_string_message =
6648 string_sprintf("missing '{' for last arg of %s", name); /*}*/
6649 goto EXPAND_FAILED_CURLY;
6654 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6655 if scanning a "false" part). This allows us to find the end of the
6656 condition, because if the list is empty, we won't actually evaluate the
6657 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6658 the normal internal expansion function. */
6660 DEBUG(D_expand) debug_printf_indent("%s: find end of conditionn\n", name);
6661 if (item_type != EITEM_FILTER)
6662 temp = expand_string_internal(s,
6663 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL);
6665 if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6669 expand_string_message = string_sprintf("%s inside \"%s\" item",
6670 expand_string_message, name);
6674 Uskip_whitespace(&s); /*{{{*/
6677 expand_string_message = string_sprintf("missing } at end of condition "
6678 "or expression inside \"%s\"; could be an unquoted } in the content",
6683 Uskip_whitespace(&s); /*{{*/
6686 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6691 /* If we are skipping, we can now just move on to the next item. When
6692 processing for real, we perform the iteration. */
6694 if (flags & ESI_SKIPPING) continue;
6695 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6697 *outsep = (uschar)sep; /* Separator as a string */
6699 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6700 name, iterate_item, lookup_value);
6702 if (item_type == EITEM_FILTER)
6705 /* the condition could modify $value, as a side-effect */
6706 uschar * save_value = lookup_value;
6708 if (!eval_condition(expr, &resetok, &condresult))
6710 iterate_item = save_iterate_item;
6711 lookup_value = save_lookup_value;
6712 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6713 expand_string_message, name);
6716 lookup_value = save_value;
6717 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6718 condresult? "true":"false");
6720 temp = iterate_item; /* TRUE => include this item */
6722 continue; /* FALSE => skip this item */
6725 else /* EITEM_MAP and EITEM_REDUCE */
6727 /* the expansion could modify $value, as a side-effect */
6728 uschar * t = expand_string_internal(expr,
6729 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, NULL, &resetok, NULL);
6732 iterate_item = save_iterate_item;
6733 expand_string_message = string_sprintf("%s inside \"%s\" item",
6734 expand_string_message, name);
6737 if (item_type == EITEM_REDUCE)
6739 lookup_value = t; /* Update the value of $value */
6740 continue; /* and continue the iteration */
6744 /* We reach here for FILTER if the condition is true, always for MAP,
6745 and never for REDUCE. The value in "temp" is to be added to the output
6746 list that is being created, ensuring that any occurrences of the
6747 separator character are doubled. Unless we are dealing with the first
6748 item of the output list, add in a space if the new item begins with the
6749 separator character, or is an empty string. */
6751 /*XXX is there not a standard support function for this, appending to a list? */
6752 /* yes, string_append_listele(), but it depends on lack of text before the list */
6754 if ( yield && yield->ptr != save_ptr
6755 && (temp[0] == *outsep || temp[0] == 0))
6756 yield = string_catn(yield, US" ", 1);
6758 /* Add the string in "temp" to the output list that we are building,
6759 This is done in chunks by searching for the separator character. */
6763 size_t seglen = Ustrcspn(temp, outsep);
6765 yield = string_catn(yield, temp, seglen + 1);
6767 /* If we got to the end of the string we output one character
6768 too many; backup and end the loop. Otherwise arrange to double the
6771 if (!temp[seglen]) { yield->ptr--; break; }
6772 yield = string_catn(yield, outsep, 1);
6776 /* Output a separator after the string: we will remove the redundant
6777 final one at the end. */
6779 yield = string_catn(yield, outsep, 1);
6780 } /* End of iteration over the list loop */
6782 /* REDUCE has generated no output above: output the final value of
6785 if (item_type == EITEM_REDUCE)
6787 yield = string_cat(yield, lookup_value);
6788 lookup_value = save_lookup_value; /* Restore $value */
6791 /* FILTER and MAP generate lists: if they have generated anything, remove
6792 the redundant final separator. Even though an empty item at the end of a
6793 list does not count, this is tidier. */
6795 else if (yield && yield->ptr != save_ptr) yield->ptr--;
6797 /* Restore preserved $item */
6799 iterate_item = save_iterate_item;
6800 if (flags & ESI_SKIPPING) continue; else break;
6806 const uschar * srclist, * cmp, * xtract;
6807 uschar * opname, * srcitem;
6808 const uschar * dstlist = NULL, * dstkeylist = NULL;
6809 uschar * tmp, * save_iterate_item = iterate_item;
6811 Uskip_whitespace(&s);
6812 if (*s++ != '{') /*}*/
6814 expand_string_message = US"missing '{' for list arg of sort";
6815 goto EXPAND_FAILED_CURLY; /*}*/
6818 sep = matchlist_parse_sep(&s);
6819 srclist = expand_string_internal(s,
6820 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6821 if (!srclist) goto EXPAND_FAILED; /*{{*/
6824 expand_string_message = US"missing '}' closing list arg of sort";
6825 goto EXPAND_FAILED_CURLY;
6828 Uskip_whitespace(&s);
6829 if (*s++ != '{') /*}*/
6831 expand_string_message = US"missing '{' for comparator arg of sort";
6832 goto EXPAND_FAILED_CURLY; /*}*/
6835 cmp = expand_string_internal(s,
6836 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6837 if (!cmp) goto EXPAND_FAILED; /*{{*/
6840 expand_string_message = US"missing '}' closing comparator arg of sort";
6841 goto EXPAND_FAILED_CURLY;
6844 if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6846 if (!expand_string_message)
6847 expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6852 case ECOND_NUM_L: case ECOND_NUM_LE:
6853 case ECOND_NUM_G: case ECOND_NUM_GE:
6854 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6855 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6859 expand_string_message = US"comparator not handled for sort";
6863 Uskip_whitespace(&s);
6864 if (*s++ != '{') /*}*/
6866 expand_string_message = US"missing '{' for extractor arg of sort";
6867 goto EXPAND_FAILED_CURLY; /*}*/
6871 if (!(tmp = expand_string_internal(s,
6872 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL)))
6874 xtract = string_copyn(xtract, s - xtract);
6878 expand_string_message = US"missing '}' closing extractor arg of sort";
6879 goto EXPAND_FAILED_CURLY;
6884 expand_string_message = US"missing } at end of \"sort\"";
6888 if (flags & ESI_SKIPPING) continue;
6890 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6892 uschar * srcfield, * dstitem;
6893 gstring * newlist = NULL, * newkeylist = NULL;
6895 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6897 /* extract field for comparisons */
6898 iterate_item = srcitem;
6899 if ( !(srcfield = expand_string_internal(xtract,
6900 ESI_HONOR_DOLLAR, NULL, &resetok, NULL))
6903 expand_string_message = string_sprintf(
6904 "field-extract in sort: \"%s\"", xtract);
6908 /* Insertion sort */
6910 /* copy output list until new-item < list-item */
6911 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6915 /* field for comparison */
6916 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6919 /* String-comparator names start with a letter; numeric names do not */
6921 if (sortsbefore(cond_type, isalpha(opname[0]),
6922 srcfield, dstfield))
6924 /* New-item sorts before this dst-item. Append new-item,
6925 then dst-item, then remainder of dst list. */
6927 newlist = string_append_listele(newlist, sep, srcitem);
6928 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6931 newlist = string_append_listele(newlist, sep, dstitem);
6932 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6934 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */
6935 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6937 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6939 newlist = string_append_listele(newlist, sep, dstitem);
6940 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6946 newlist = string_append_listele(newlist, sep, dstitem);
6947 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6950 /* If we ran out of dstlist without consuming srcitem, append it */
6953 newlist = string_append_listele(newlist, sep, srcitem);
6954 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6957 dstlist = newlist->s;
6958 dstkeylist = newkeylist->s;
6960 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6961 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6965 yield = string_cat(yield, dstlist);
6967 /* Restore preserved $item */
6968 iterate_item = save_iterate_item;
6972 expand_string_message = US"Internal error in sort (list mismatch)";
6977 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6978 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6979 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6980 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6982 #define EXPAND_DLFUNC_MAX_ARGS 8
6985 #ifndef EXPAND_DLFUNC
6986 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6987 "is not included in this binary";
6990 #else /* EXPAND_DLFUNC */
6993 exim_dlfunc_t * func;
6996 uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6998 if (expand_forbid & RDO_DLFUNC)
7000 expand_string_message =
7001 US"dynamically-loaded functions are not permitted";
7005 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, flags,
7006 TRUE, name, &resetok, NULL))
7008 case -1: continue; /* skipping */
7009 case 1: goto EXPAND_FAILED_CURLY;
7011 case 3: goto EXPAND_FAILED;
7014 /* Look up the dynamically loaded object handle in the tree. If it isn't
7015 found, dlopen() the file and put the handle in the tree for next time. */
7017 if (!(t = tree_search(dlobj_anchor, argv[0])))
7019 void * handle = dlopen(CS argv[0], RTLD_LAZY);
7022 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
7023 argv[0], dlerror());
7024 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
7027 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), argv[0]);
7028 Ustrcpy(t->name, argv[0]);
7029 t->data.ptr = handle;
7030 (void)tree_insertnode(&dlobj_anchor, t);
7033 /* Having obtained the dynamically loaded object handle, look up the
7034 function pointer. */
7036 if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
7038 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
7039 "%s", argv[1], argv[0], dlerror());
7040 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
7044 /* Call the function and work out what to do with the result. If it
7045 returns OK, we have a replacement string; if it returns DEFER then
7046 expansion has failed in a non-forced manner; if it returns FAIL then
7047 failure was forced; if it returns ERROR or any other value there's a
7048 problem, so panic slightly. In any case, assume that the function has
7049 side-effects on the store that must be preserved. */
7053 for (argc = 0; argv[argc]; argc++) ;
7055 if ((status = func(&result, argc - 2, &argv[2])) != OK)
7057 expand_string_message = result ? result : US"(no message)";
7058 if (status == FAIL_FORCED)
7059 f.expand_string_forcedfail = TRUE;
7060 else if (status != FAIL)
7061 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
7062 argv[0], argv[1], status, expand_string_message);
7066 if (result) yield = string_cat(yield, result);
7069 #endif /* EXPAND_DLFUNC */
7071 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
7074 uschar *save_lookup_value = lookup_value;
7076 if (Uskip_whitespace(&s) != '{') /*}*/
7079 key = expand_string_internal(s+1,
7080 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7081 if (!key) goto EXPAND_FAILED; /*{{*/
7084 expand_string_message = US"missing '}' for name arg of env";
7085 goto EXPAND_FAILED_CURLY;
7088 lookup_value = US getenv(CS key);
7090 switch(process_yesno(
7091 flags, /* were previously skipping */
7092 lookup_value != NULL, /* success/failure indicator */
7093 save_lookup_value, /* value to reset for string2 */
7094 &s, /* input pointer */
7095 &yield, /* output pointer */
7096 US"env", /* condition type */
7099 case 1: goto EXPAND_FAILED; /* when all is well, the */
7100 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
7102 if (flags & ESI_SKIPPING) continue; else break;
7106 case EITEM_SRS_ENCODE:
7107 /* ${srs_encode {secret} {return_path} {orig_domain}} */
7112 BOOL quoted = FALSE;
7114 switch (read_subs(sub, 3, 3, CUSS &s, flags, TRUE, name, &resetok, NULL))
7116 case -1: continue; /* skipping */
7117 case 1: goto EXPAND_FAILED_CURLY;
7119 case 3: goto EXPAND_FAILED;
7121 if (flags & ESI_SKIPPING) continue;
7123 if (sub[1] && *(sub[1]))
7125 g = string_catn(g, US"SRS0=", 5);
7127 /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
7128 hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
7129 g = string_catn(g, cksum, sizeof(cksum));
7130 g = string_catn(g, US"=", 1);
7132 /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
7137 gettimeofday(&now, NULL);
7138 i = (now.tv_sec / 86400) & 0x3ff;
7139 g = string_catn(g, &base32_chars[i >> 5], 1);
7140 g = string_catn(g, &base32_chars[i & 0x1f], 1);
7142 g = string_catn(g, US"=", 1);
7144 /* ${domain:$return_path}=${local_part:$return_path} */
7146 int start, end, domain;
7147 uschar * t = parse_extract_address(sub[1], &expand_string_message,
7148 &start, &end, &domain, FALSE);
7154 if (domain > 0) g = string_cat(g, t + domain);
7155 g = string_catn(g, US"=", 1);
7157 s = domain > 0 ? string_copyn(t, domain - 1) : t;
7158 if ((quoted = Ustrchr(s, '"') != NULL))
7161 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
7162 while (*s) /* de-quote */
7164 while (*s && *s != '"') h = string_catn(h, s++, 1);
7166 while (*s && *s != '"') h = string_catn(h, s++, 1);
7169 gstring_release_unused(h);
7170 s = string_from_gstring(h);
7172 if (s) g = string_cat(g, s);
7175 /* Assume that if the original local_part had quotes
7176 it was for good reason */
7178 if (quoted) yield = string_catn(yield, US"\"", 1);
7179 yield = gstring_append(yield, g);
7180 if (quoted) yield = string_catn(yield, US"\"", 1);
7182 /* @$original_domain */
7183 yield = string_catn(yield, US"@", 1);
7184 yield = string_cat(yield, sub[2]);
7187 DEBUG(D_expand) debug_printf_indent("null return_path for srs-encode\n");
7191 #endif /*SUPPORT_SRS*/
7195 } /* EITEM_* switch */
7198 DEBUG(D_expand) /* only if not the sole expansion of the line */
7199 if (yield && (expansion_start > 0 || *s))
7200 debug_expansion_interim(US"item-res",
7201 yield->s + expansion_start, yield->ptr - expansion_start,
7208 /* Control reaches here if the name is not recognized as one of the more
7209 complicated expansion items. Check for the "operator" syntax (name terminated
7210 by a colon). Some of the operators have arguments, separated by _ from the
7216 uschar * arg = NULL, * sub;
7218 var_entry * vp = NULL;
7221 /* Owing to an historical mis-design, an underscore may be part of the
7222 operator name, or it may introduce arguments. We therefore first scan the
7223 table of names that contain underscores. If there is no match, we cut off
7224 the arguments and then scan the main table. */
7226 if ((c = chop_match(name, op_table_underscore,
7227 nelem(op_table_underscore))) < 0)
7229 if ((arg = Ustrchr(name, '_')))
7231 if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
7232 c += nelem(op_table_underscore);
7233 if (arg) *arg++ = '_'; /* Put back for error messages */
7236 /* Deal specially with operators that might take a certificate variable
7237 as we do not want to do the usual expansion. For most, expand the string.*/
7248 const uschar * s1 = s;
7249 sub = expand_string_internal(s+2,
7250 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s1, &resetok, NULL);
7251 if (!sub) goto EXPAND_FAILED; /*{*/
7254 expand_string_message =
7255 string_sprintf("missing '}' closing cert arg of %s", name);
7256 goto EXPAND_FAILED_CURLY;
7258 if ( (vp = find_var_ent(sub, var_table, nelem(var_table)))
7259 && vp->type == vtype_cert)
7269 sub = expand_string_internal(s+1,
7270 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7271 if (!sub) goto EXPAND_FAILED;
7276 /* If we are skipping, we don't need to perform the operation at all.
7277 This matters for operations like "mask", because the data may not be
7278 in the correct format when skipping. For example, the expression may test
7279 for the existence of $sender_host_address before trying to mask it. For
7280 other operations, doing them may not fail, but it is a waste of time. */
7282 if (flags & ESI_SKIPPING && c >= 0) continue;
7284 /* Otherwise, switch on the operator type. After handling go back
7285 to the main loop top. */
7288 unsigned expansion_start = gstring_length(yield);
7294 unsigned long int n = Ustrtoul(sub, &t, 10);
7299 expand_string_message = string_sprintf("argument for base32 "
7300 "operator is \"%s\", which is not a decimal number", sub);
7304 g = string_catn(g, &base32_chars[n & 0x1f], 1);
7306 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7313 unsigned long int n = 0;
7316 uschar * t = Ustrchr(base32_chars, *tt++);
7319 expand_string_message = string_sprintf("argument for base32d "
7320 "operator is \"%s\", which is not a base 32 number", sub);
7323 n = n * 32 + (t - base32_chars);
7325 yield = string_fmt_append(yield, "%ld", n);
7332 unsigned long int n = Ustrtoul(sub, &t, 10);
7335 expand_string_message = string_sprintf("argument for base62 "
7336 "operator is \"%s\", which is not a decimal number", sub);
7339 yield = string_cat(yield, string_base62_32(n)); /*XXX only handles 32b input range. Need variants? */
7343 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7348 unsigned long int n = 0;
7351 uschar *t = Ustrchr(base62_chars, *tt++);
7354 expand_string_message = string_sprintf("argument for base62d "
7355 "operator is \"%s\", which is not a base %d number", sub,
7359 n = n * BASE_62 + (t - base62_chars);
7361 yield = string_fmt_append(yield, "%ld", n);
7367 uschar *expanded = expand_string_internal(sub,
7368 ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, NULL, &resetok, NULL);
7371 expand_string_message =
7372 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7373 expand_string_message);
7376 yield = string_cat(yield, expanded);
7382 uschar * t = sub - 1;
7383 while (*++t) *t = tolower(*t);
7384 yield = string_catn(yield, sub, t-sub);
7390 uschar * t = sub - 1;
7391 while (*++t) *t = toupper(*t);
7392 yield = string_catn(yield, sub, t-sub);
7398 if (vp && *(void **)vp->value)
7400 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7401 yield = string_cat(yield, cp);
7409 md5_end(&base, sub, Ustrlen(sub), digest);
7410 for (int j = 0; j < 16; j++)
7411 yield = string_fmt_append(yield, "%02x", digest[j]);
7417 if (vp && *(void **)vp->value)
7419 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7420 yield = string_cat(yield, cp);
7428 sha1_end(&h, sub, Ustrlen(sub), digest);
7429 for (int j = 0; j < 20; j++)
7430 yield = string_fmt_append(yield, "%02X", digest[j]);
7436 #ifdef EXIM_HAVE_SHA2
7437 if (vp && *(void **)vp->value)
7438 if (c == EOP_SHA256)
7439 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7441 expand_string_message = US"sha2_N not supported with certificates";
7446 hashmethod m = !arg ? HASH_SHA2_256
7447 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7448 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7449 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7452 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7454 expand_string_message = US"unrecognised sha2 variant";
7458 exim_sha_update_string(&h, sub);
7459 exim_sha_finish(&h, &b);
7461 yield = string_fmt_append(yield, "%02X", *b.data++);
7464 expand_string_message = US"sha256 only supported with TLS";
7469 #ifdef EXIM_HAVE_SHA3
7473 hashmethod m = !arg ? HASH_SHA3_256
7474 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7475 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7476 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7477 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7480 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7482 expand_string_message = US"unrecognised sha3 variant";
7486 exim_sha_update_string(&h, sub);
7487 exim_sha_finish(&h, &b);
7489 yield = string_fmt_append(yield, "%02X", *b.data++);
7493 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7497 /* Line-wrap a string as if it is a header line */
7499 case EOP_HEADERWRAP:
7501 unsigned col = 80, lim = 998;
7506 const uschar * list = arg;
7508 if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7511 if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7515 if ((s = wrap_header(sub, col, lim, US"\t", 8)))
7516 yield = string_cat(yield, s);
7520 /* Convert hex encoding to base64 encoding */
7530 for (enc = sub; *enc; enc++)
7532 if (!isxdigit(*enc))
7534 expand_string_message = string_sprintf("\"%s\" is not a hex "
7543 expand_string_message = string_sprintf("\"%s\" contains an odd "
7544 "number of characters", sub);
7548 while ((c = *in++) != 0)
7550 if (isdigit(c)) c -= '0';
7551 else c = toupper(c) - 'A' + 10;
7561 enc = b64encode(CUS sub, out - sub);
7562 yield = string_cat(yield, enc);
7566 /* Convert octets outside 0x21..0x7E to \xXX form */
7570 uschar *t = sub - 1;
7573 if (*t < 0x21 || 0x7E < *t)
7574 yield = string_fmt_append(yield, "\\x%02x", *t);
7576 yield = string_catn(yield, t, 1);
7581 /* count the number of list elements */
7586 uschar * buf = store_get(2, sub);
7588 sep = matchlist_parse_sep(CUSS &sub);
7589 while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7590 yield = string_fmt_append(yield, "%d", cnt);
7594 /* expand a named list given the name */
7595 /* handles nested named lists; requotes as colon-sep list */
7598 expand_string_message = NULL;
7599 yield = expand_listnamed(yield, sub, arg);
7600 if (expand_string_message)
7604 /* quote a list-item for the given list-separator */
7606 /* mask applies a mask to an IP address; for example the result of
7607 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7614 int type, mask, maskoffset;
7618 if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7620 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7625 if (maskoffset == 0)
7627 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7632 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7634 if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7636 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7641 /* If an optional 'n' was given, ipv6 gets normalised output:
7642 colons rather than dots, and zero-compressed. */
7644 normalised = arg && *arg == 'n';
7646 /* Convert the address to binary integer(s) and apply the mask */
7648 sub[maskoffset] = 0;
7649 count = host_aton(sub, binary);
7650 host_mask(count, binary, mask);
7652 /* Convert to masked textual format and add to output. */
7654 if (type == 4 || !normalised)
7655 yield = string_catn(yield, buffer,
7656 host_nmtoa(count, binary, mask, buffer, '.'));
7659 ipv6_nmtoa(binary, buffer);
7660 yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7666 case EOP_IPV6DENORM:
7668 int type = string_is_ip_address(sub, NULL);
7675 (void) host_aton(sub, binary);
7678 case 4: /* convert to IPv4-mapped IPv6 */
7679 binary[0] = binary[1] = 0;
7680 binary[2] = 0x0000ffff;
7681 (void) host_aton(sub, binary+3);
7685 expand_string_message =
7686 string_sprintf("\"%s\" is not an IP address", sub);
7690 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7691 ? ipv6_nmtoa(binary, buffer)
7692 : host_nmtoa(4, binary, -1, buffer, ':')
7698 case EOP_LOCAL_PART:
7702 int start, end, domain;
7703 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7706 if (c != EOP_DOMAIN)
7707 yield = c == EOP_LOCAL_PART && domain > 0
7708 ? string_catn(yield, t, domain - 1)
7709 : string_cat(yield, t);
7710 else if (domain > 0)
7711 yield = string_cat(yield, t + domain);
7717 uschar outsep[2] = { ':', '\0' };
7718 uschar *address, *error;
7719 int save_ptr = gstring_length(yield);
7720 int start, end, domain; /* Not really used */
7722 if (Uskip_whitespace(&sub) == '>')
7723 if (*outsep = *++sub) ++sub;
7726 expand_string_message = string_sprintf("output separator "
7727 "missing in expanding ${addresses:%s}", --sub);
7730 f.parse_allow_group = TRUE;
7734 uschar * p = parse_find_address_end(sub, FALSE);
7735 uschar saveend = *p;
7737 address = parse_extract_address(sub, &error, &start, &end, &domain,
7741 /* Add the address to the output list that we are building. This is
7742 done in chunks by searching for the separator character. At the
7743 start, unless we are dealing with the first address of the output
7744 list, add in a space if the new address begins with the separator
7745 character, or is an empty string. */
7749 if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7750 yield = string_catn(yield, US" ", 1);
7754 size_t seglen = Ustrcspn(address, outsep);
7755 yield = string_catn(yield, address, seglen + 1);
7757 /* If we got to the end of the string we output one character
7760 if (address[seglen] == '\0') { yield->ptr--; break; }
7761 yield = string_catn(yield, outsep, 1);
7762 address += seglen + 1;
7765 /* Output a separator after the string: we will remove the
7766 redundant final one at the end. */
7768 yield = string_catn(yield, outsep, 1);
7771 if (saveend == '\0') break;
7775 /* If we have generated anything, remove the redundant final
7778 if (yield && yield->ptr != save_ptr) yield->ptr--;
7779 f.parse_allow_group = FALSE;
7784 /* quote puts a string in quotes if it is empty or contains anything
7785 other than alphamerics, underscore, dot, or hyphen.
7787 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7788 be quoted in order to be a valid local part.
7790 In both cases, newlines and carriage returns are converted into \n and \r
7794 case EOP_QUOTE_LOCAL_PART:
7797 BOOL needs_quote = (!*sub); /* TRUE for empty string */
7798 uschar *t = sub - 1;
7801 while (!needs_quote && *++t)
7802 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7804 else /* EOP_QUOTE_LOCAL_PART */
7805 while (!needs_quote && *++t)
7806 needs_quote = !isalnum(*t)
7807 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7808 && (*t != '.' || t == sub || !t[1]);
7812 yield = string_catn(yield, US"\"", 1);
7816 yield = string_catn(yield, US"\\n", 2);
7817 else if (*t == '\r')
7818 yield = string_catn(yield, US"\\r", 2);
7821 if (*t == '\\' || *t == '"')
7822 yield = string_catn(yield, US"\\", 1);
7823 yield = string_catn(yield, t, 1);
7825 yield = string_catn(yield, US"\"", 1);
7828 yield = string_cat(yield, sub);
7831 /* quote_lookuptype does lookup-specific quoting */
7835 const lookup_info * li;
7836 uschar * opt = Ustrchr(arg, '_');
7838 if (opt) *opt++ = 0;
7840 if (!(li = search_findtype(arg, Ustrlen(arg))))
7842 expand_string_message = search_error_message;
7847 sub = (li->quote)(sub, opt, li->acq_num);
7853 expand_string_message = string_sprintf(
7854 "\"%s\" unrecognized after \"${quote_%s\"", /*}*/
7859 yield = string_cat(yield, sub);
7863 /* rx quote sticks in \ before any non-alphameric character so that
7864 the insertion works in a regular expression. */
7868 uschar *t = sub - 1;
7872 yield = string_catn(yield, US"\\", 1);
7873 yield = string_catn(yield, t, 1);
7878 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7879 prescribed by the RFC, if there are characters that need to be encoded */
7882 yield = string_cat(yield,
7883 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7887 /* RFC 2047 decode */
7893 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7894 headers_charset, '?', &len, &error);
7897 expand_string_message = error;
7900 yield = string_catn(yield, decoded, len);
7904 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7909 uschar * buff = store_get(4, sub);
7914 if (c > 255) c = '_';
7916 yield = string_catn(yield, buff, 1);
7921 /* replace illegal UTF-8 sequences by replacement character */
7923 #define UTF8_REPLACEMENT_CHAR US"?"
7927 int seq_len = 0, index = 0, bytes_left = 0, complete;
7928 u_long codepoint = (u_long)-1;
7929 uschar seq_buff[4]; /* accumulate utf-8 here */
7931 /* Manually track tainting, as we deal in individual chars below */
7934 yield = string_get_tainted(Ustrlen(sub), sub);
7935 else if (!yield->s || !yield->ptr)
7937 yield->s = store_get(yield->size = Ustrlen(sub), sub);
7938 gstring_reset(yield);
7940 else if (is_incompatible(yield->s, sub))
7941 gstring_rebuffer(yield, sub);
7943 /* Check the UTF-8, byte-by-byte */
7952 if ((c & 0xc0) != 0x80)
7953 /* wrong continuation byte; invalidate all bytes */
7954 complete = 1; /* error */
7957 codepoint = (codepoint << 6) | (c & 0x3f);
7958 seq_buff[index++] = c;
7959 if (--bytes_left == 0) /* codepoint complete */
7960 if(codepoint > 0x10FFFF) /* is it too large? */
7961 complete = -1; /* error (RFC3629 limit) */
7962 else if ( (codepoint & 0x1FF800 ) == 0xD800 ) /* surrogate */
7963 /* A UTF-16 surrogate (which should be one of a pair that
7964 encode a Unicode codepoint that is outside the Basic
7965 Multilingual Plane). Error, not UTF8.
7966 RFC2279.2 is slightly unclear on this, but
7967 https://unicodebook.readthedocs.io/issues.html#strict-utf8-decoder
7968 says "Surrogates characters are also invalid in UTF-8:
7969 characters in U+D800—U+DFFF have to be rejected." */
7972 { /* finished; output utf-8 sequence */
7973 yield = string_catn(yield, seq_buff, seq_len);
7978 else /* no bytes left: new sequence */
7980 if (!(c & 0x80)) /* 1-byte sequence, US-ASCII, keep it */
7982 yield = string_catn(yield, &c, 1);
7985 if ((c & 0xe0) == 0xc0) /* 2-byte sequence */
7986 if (c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7991 codepoint = c & 0x1f;
7993 else if ((c & 0xf0) == 0xe0) /* 3-byte sequence */
7996 codepoint = c & 0x0f;
7998 else if ((c & 0xf8) == 0xf0) /* 4-byte sequence */
8001 codepoint = c & 0x07;
8003 else /* invalid or too long (RFC3629 allows only 4 bytes) */
8006 seq_buff[index++] = c;
8007 seq_len = bytes_left + 1;
8008 } /* if(bytes_left) */
8012 bytes_left = index = 0;
8013 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
8015 if ((complete == 1) && ((c & 0x80) == 0))
8016 /* ASCII character follows incomplete sequence */
8017 yield = string_catn(yield, &c, 1);
8019 /* If given a sequence truncated mid-character, we also want to report ?
8020 Eg, ${length_1:フィル} is one byte, not one character, so we expect
8021 ${utf8clean:${length_1:フィル}} to yield '?' */
8023 if (bytes_left != 0)
8024 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
8030 case EOP_UTF8_DOMAIN_TO_ALABEL:
8032 uschar * error = NULL;
8033 uschar * s = string_domain_utf8_to_alabel(sub, &error);
8036 expand_string_message = string_sprintf(
8037 "error converting utf8 (%s) to alabel: %s",
8038 string_printing(sub), error);
8041 yield = string_cat(yield, s);
8045 case EOP_UTF8_DOMAIN_FROM_ALABEL:
8047 uschar * error = NULL;
8048 uschar * s = string_domain_alabel_to_utf8(sub, &error);
8051 expand_string_message = string_sprintf(
8052 "error converting alabel (%s) to utf8: %s",
8053 string_printing(sub), error);
8056 yield = string_cat(yield, s);
8060 case EOP_UTF8_LOCALPART_TO_ALABEL:
8062 uschar * error = NULL;
8063 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
8066 expand_string_message = string_sprintf(
8067 "error converting utf8 (%s) to alabel: %s",
8068 string_printing(sub), error);
8071 yield = string_cat(yield, s);
8072 DEBUG(D_expand) debug_printf_indent("yield: '%Y'\n", yield);
8076 case EOP_UTF8_LOCALPART_FROM_ALABEL:
8078 uschar * error = NULL;
8079 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
8082 expand_string_message = string_sprintf(
8083 "error converting alabel (%s) to utf8: %s",
8084 string_printing(sub), error);
8087 yield = string_cat(yield, s);
8090 #endif /* EXPERIMENTAL_INTERNATIONAL */
8092 /* escape turns all non-printing characters into escape sequences. */
8096 const uschar * t = string_printing(sub);
8097 yield = string_cat(yield, t);
8101 case EOP_ESCAPE8BIT:
8105 for (const uschar * s = sub; (c = *s); s++)
8106 yield = c < 127 && c != '\\'
8107 ? string_catn(yield, s, 1)
8108 : string_fmt_append(yield, "\\%03o", c);
8112 /* Handle numeric expression evaluation */
8117 uschar *save_sub = sub;
8118 uschar *error = NULL;
8119 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
8122 expand_string_message = string_sprintf("error in expression "
8123 "evaluation: %s (after processing \"%.*s\")", error,
8124 (int)(sub-save_sub), save_sub);
8127 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
8131 /* Handle time period formatting */
8135 int n = readconf_readtime(sub, 0, FALSE);
8138 expand_string_message = string_sprintf("string \"%s\" is not an "
8139 "Exim time interval in \"%s\" operator", sub, name);
8142 yield = string_fmt_append(yield, "%d", n);
8146 case EOP_TIME_INTERVAL:
8149 uschar *t = read_number(&n, sub);
8150 if (*t != 0) /* Not A Number*/
8152 expand_string_message = string_sprintf("string \"%s\" is not a "
8153 "positive number in \"%s\" operator", sub, name);
8156 t = readconf_printtime(n);
8157 yield = string_cat(yield, t);
8161 /* Convert string to base64 encoding */
8167 uschar * s = vp && *(void **)vp->value
8168 ? tls_cert_der_b64(*(void **)vp->value)
8169 : b64encode(CUS sub, Ustrlen(sub));
8171 uschar * s = b64encode(CUS sub, Ustrlen(sub));
8173 yield = string_cat(yield, s);
8180 int len = b64decode(sub, &s, sub);
8183 expand_string_message = string_sprintf("string \"%s\" is not "
8184 "well-formed for \"%s\" operator", sub, name);
8187 yield = string_cat(yield, s);
8191 /* strlen returns the length of the string */
8194 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
8197 /* length_n or l_n takes just the first n characters or the whole string,
8198 whichever is the shorter;
8200 substr_m_n, and s_m_n take n characters from offset m; negative m take
8201 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
8202 takes the rest, either to the right or to the left.
8204 hash_n or h_n makes a hash of length n from the string, yielding n
8205 characters from the set a-z; hash_n_m makes a hash of length n, but
8206 uses m characters from the set a-zA-Z0-9.
8208 nhash_n returns a single number between 0 and n-1 (in text form), while
8209 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
8210 between 0 and n-1 and the second between 0 and m-1. */
8230 expand_string_message = string_sprintf("missing values after %s",
8235 /* "length" has only one argument, effectively being synonymous with
8238 if (c == EOP_LENGTH || c == EOP_L)
8244 /* The others have one or two arguments; for "substr" the first may be
8245 negative. The second being negative means "not supplied". */
8250 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8253 /* Read up to two numbers, separated by underscores */
8258 if (arg != ret && *arg == '_' && pn == &value1)
8262 if (arg[1] != 0) arg++;
8264 else if (!isdigit(*arg))
8266 expand_string_message =
8267 string_sprintf("non-digit after underscore in \"%s\"", name);
8270 else *pn = (*pn)*10 + *arg++ - '0';
8274 /* Perform the required operation */
8276 ret = c == EOP_HASH || c == EOP_H
8277 ? compute_hash(sub, value1, value2, &len)
8278 : c == EOP_NHASH || c == EOP_NH
8279 ? compute_nhash(sub, value1, value2, &len)
8280 : extract_substr(sub, value1, value2, &len);
8281 if (!ret) goto EXPAND_FAILED;
8283 yield = string_catn(yield, ret, len);
8292 uschar **modetable[3];
8296 if (expand_forbid & RDO_EXISTS)
8298 expand_string_message = US"Use of the stat() expansion is not permitted";
8302 if (stat(CS sub, &st) < 0)
8304 expand_string_message = string_sprintf("stat(%s) failed: %s",
8305 sub, strerror(errno));
8309 switch (mode & S_IFMT)
8311 case S_IFIFO: smode[0] = 'p'; break;
8312 case S_IFCHR: smode[0] = 'c'; break;
8313 case S_IFDIR: smode[0] = 'd'; break;
8314 case S_IFBLK: smode[0] = 'b'; break;
8315 case S_IFREG: smode[0] = '-'; break;
8316 default: smode[0] = '?'; break;
8319 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8320 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8321 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8323 for (int i = 0; i < 3; i++)
8325 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8330 yield = string_fmt_append(yield,
8331 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8332 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8333 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8334 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8335 (long)st.st_gid, st.st_size, (long)st.st_atime,
8336 (long)st.st_mtime, (long)st.st_ctime);
8340 /* vaguely random number less than N */
8344 int_eximarith_t max = expanded_string_integer(sub, TRUE);
8346 if (expand_string_message)
8348 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8352 /* Reverse IP, including IPv6 to dotted-nibble */
8354 case EOP_REVERSE_IP:
8356 int family, maskptr;
8357 uschar reversed[128];
8359 family = string_is_ip_address(sub, &maskptr);
8362 expand_string_message = string_sprintf(
8363 "reverse_ip() not given an IP address [%s]", sub);
8366 invert_address(reversed, sub);
8367 yield = string_cat(yield, reversed);
8374 int len = xtextdecode(sub, &s);
8375 yield = string_catn(yield, s, len);
8379 /* Unknown operator */
8381 expand_string_message =
8382 string_sprintf("unknown expansion operator \"%s\"", name);
8384 } /* EOP_* switch */
8388 const uschar * res = string_from_gstring(yield);
8389 const uschar * s = res + expansion_start;
8390 int i = gstring_length(yield) - expansion_start;
8391 BOOL tainted = is_tainted(s);
8393 debug_printf_indent("%Vop-res: %.*s\n", "K-----", i, s);
8396 debug_printf_indent("%V %V",
8397 flags & ESI_SKIPPING ? "|" : " ",
8399 debug_print_taint(res);
8406 /* Not an item or an operator */
8407 /* Handle a plain name. If this is the first thing in the expansion, release
8408 the pre-allocated buffer. If the result data is known to be in a new buffer,
8409 newsize will be set to the size of that buffer, and we can just point at that
8410 store instead of copying. Many expansion strings contain just one reference,
8411 so this is a useful optimization, especially for humungous headers
8412 ($message_headers). */
8416 const uschar * value;
8422 g = store_get(sizeof(gstring), GET_UNTAINTED);
8423 else if (yield->ptr == 0)
8425 if (resetok) reset_point = store_reset(reset_point);
8427 reset_point = store_mark();
8428 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
8430 if (!(value = find_variable(name, flags, &newsize)))
8432 expand_string_message =
8433 string_sprintf("unknown variable in \"${%s}\"", name);
8434 check_variable_error_message(name);
8437 len = Ustrlen(value);
8438 if (!yield && newsize)
8441 yield->size = newsize;
8443 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8446 yield = string_catn(yield, value, len);
8450 /* Else there's something wrong */
8452 expand_string_message =
8453 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8454 "in a variable reference)", name);
8458 /* If we hit the end of the string when brace_ends is set, there is a missing
8459 terminating brace. */
8461 if (flags & ESI_BRACE_ENDS && !*s)
8463 expand_string_message = malformed_header
8464 ? US"missing } at end of string - could be header name not terminated by colon"
8465 : US"missing } at end of string";
8469 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8470 added to the string. If so, set up an empty string. Add a terminating zero. If
8471 left != NULL, return a pointer to the terminator. */
8477 yield = string_get(1);
8478 res = string_from_gstring(yield);
8479 if (left) *left = s;
8481 /* Any stacking store that was used above the final string is no longer needed.
8482 In many cases the final string will be the first one that was got and so there
8483 will be optimal store usage. */
8485 if (resetok) gstring_release_unused(yield);
8486 else if (resetok_p) *resetok_p = FALSE;
8490 BOOL tainted = is_tainted(res);
8491 debug_printf_indent("%Vexpanded: %.*W\n",
8493 (int)(s - string), string);
8494 debug_printf_indent("%Vresult: ",
8495 flags & ESI_SKIPPING ? "K-----" : "\\_____");
8496 if (*res || !(flags & ESI_SKIPPING))
8497 debug_printf("%W\n", res);
8499 debug_printf(" %Vskipped%V\n", "<", ">");
8502 debug_printf_indent("%V %V",
8503 flags & ESI_SKIPPING ? "|" : " ",
8506 debug_print_taint(res);
8508 if (flags & ESI_SKIPPING)
8509 debug_printf_indent("%Vskipping: result is not used\n", "\\___");
8511 if (textonly_p) *textonly_p = textonly;
8516 /* This is the failure exit: easiest to program with a goto. We still need
8517 to update the pointer to the terminator, for cases of nested calls with "fail".
8520 EXPAND_FAILED_CURLY:
8521 if (malformed_header)
8522 expand_string_message =
8523 US"missing or misplaced { or } - could be header name not terminated by colon";
8525 else if (!expand_string_message || !*expand_string_message)
8526 expand_string_message = US"missing or misplaced { or }";
8528 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8529 that is a bad idea, because expand_string_message is in dynamic store. */
8532 if (left) *left = s;
8535 debug_printf_indent("%Vfailed to expand: %s\n", "K", string);
8536 debug_printf_indent("%Verror message: %s\n",
8537 f.expand_string_forcedfail ? "K---" : "\\___", expand_string_message);
8538 if (f.expand_string_forcedfail)
8539 debug_printf_indent("%Vfailure was forced\n", "\\");
8541 if (resetok_p && !resetok) *resetok_p = FALSE;
8548 /* This is the external function call. Do a quick check for any expansion
8549 metacharacters, and if there are none, just return the input string.
8552 the string to be expanded
8553 optional pointer for return boolean indicating no-dynamic-expansions
8555 Returns: the expanded string, or NULL if expansion failed; if failure was
8556 due to a lookup deferring, search_find_defer will be TRUE
8560 expand_string_2(const uschar * string, BOOL * textonly_p)
8562 f.expand_string_forcedfail = f.search_find_defer = malformed_header = FALSE;
8563 if (Ustrpbrk(string, "$\\") != NULL)
8565 int old_pool = store_pool;
8568 store_pool = POOL_MAIN;
8569 s = expand_string_internal(string, ESI_HONOR_DOLLAR, NULL, NULL, textonly_p);
8570 store_pool = old_pool;
8573 if (textonly_p) *textonly_p = TRUE;
8578 expand_cstring(const uschar * string)
8579 { return expand_string_2(string, NULL); }
8582 expand_string(uschar * string)
8583 { return US expand_string_2(CUS string, NULL); }
8590 /*************************************************
8592 *************************************************/
8594 /* Now and again we want to expand a string and be sure that the result is in a
8595 new bit of store. This function does that.
8596 Since we know it has been copied, the de-const cast is safe.
8598 Argument: the string to be expanded
8599 Returns: the expanded string, always in a new bit of store, or NULL
8603 expand_string_copy(const uschar *string)
8605 const uschar *yield = expand_cstring(string);
8606 if (yield == string) yield = string_copy(string);
8612 /*************************************************
8613 * Expand and interpret as an integer *
8614 *************************************************/
8616 /* Expand a string, and convert the result into an integer.
8619 string the string to be expanded
8620 isplus TRUE if a non-negative number is expected
8622 Returns: the integer value, or
8623 -1 for an expansion error ) in both cases, message in
8624 -2 for an integer interpretation error ) expand_string_message
8625 expand_string_message is set NULL for an OK integer
8629 expand_string_integer(uschar *string, BOOL isplus)
8631 return expanded_string_integer(expand_string(string), isplus);
8635 /*************************************************
8636 * Interpret string as an integer *
8637 *************************************************/
8639 /* Convert a string (that has already been expanded) into an integer.
8641 This function is used inside the expansion code.
8644 s the string to be expanded
8645 isplus TRUE if a non-negative number is expected
8647 Returns: the integer value, or
8648 -1 if string is NULL (which implies an expansion error)
8649 -2 for an integer interpretation error
8650 expand_string_message is set NULL for an OK integer
8653 static int_eximarith_t
8654 expanded_string_integer(const uschar *s, BOOL isplus)
8656 int_eximarith_t value;
8657 uschar *msg = US"invalid integer \"%s\"";
8660 /* If expansion failed, expand_string_message will be set. */
8664 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8665 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8666 systems, so we set it zero ourselves. */
8669 expand_string_message = NULL; /* Indicates no error */
8671 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8672 equal to 0. Unfortunately, people actually relied upon that, so preserve
8673 the behaviour explicitly. Stripping leading whitespace is a harmless
8674 noop change since strtol skips it anyway (provided that there is a number
8677 if (Uskip_whitespace(&s) == '\0')
8680 debug_printf_indent("treating blank string as number 0\n");
8684 value = strtoll(CS s, CSS &endptr, 10);
8687 msg = US"integer expected but \"%s\" found";
8688 else if (value < 0 && isplus)
8689 msg = US"non-negative integer expected but \"%s\" found";
8692 switch (tolower(*endptr))
8697 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8702 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8703 else value *= 1024*1024;
8707 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8708 else value *= 1024*1024*1024;
8712 if (errno == ERANGE)
8713 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8715 if (Uskip_whitespace(&endptr) == 0) return value;
8718 expand_string_message = string_sprintf(CS msg, s);
8723 /* These values are usually fixed boolean values, but they are permitted to be
8727 addr address being routed
8728 mtype the module type
8729 mname the module name
8730 dbg_opt debug selectors
8731 oname the option name
8732 bvalue the router's boolean value
8733 svalue the router's string value
8734 rvalue where to put the returned value
8736 Returns: OK value placed in rvalue
8737 DEFER expansion failed
8741 exp_bool(address_item * addr,
8742 const uschar * mtype, const uschar * mname, unsigned dbg_opt,
8743 uschar * oname, BOOL bvalue,
8744 const uschar * svalue, BOOL * rvalue)
8746 const uschar * expanded;
8748 DEBUG(D_expand) debug_printf("try option %s\n", oname);
8749 if (!svalue) { *rvalue = bvalue; return OK; }
8751 if (!(expanded = expand_cstring(svalue)))
8753 if (f.expand_string_forcedfail)
8755 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8759 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8760 oname, mname, mtype, expand_string_message);
8761 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8765 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8768 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8770 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8774 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8775 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8784 /* Avoid potentially exposing a password in a string about to be logged */
8787 expand_hide_passwords(uschar * s)
8789 return ( ( Ustrstr(s, "failed to expand") != NULL
8790 || Ustrstr(s, "expansion of ") != NULL
8792 && ( Ustrstr(s, "mysql") != NULL
8793 || Ustrstr(s, "pgsql") != NULL
8794 || Ustrstr(s, "redis") != NULL
8795 || Ustrstr(s, "sqlite") != NULL
8796 || Ustrstr(s, "ldap:") != NULL
8797 || Ustrstr(s, "ldaps:") != NULL
8798 || Ustrstr(s, "ldapi:") != NULL
8799 || Ustrstr(s, "ldapdn:") != NULL
8800 || Ustrstr(s, "ldapm:") != NULL
8802 ? US"Temporary internal error" : s;
8806 /* Read given named file into big_buffer. Use for keying material etc.
8807 The content will have an ascii NUL appended.
8812 Return: pointer to buffer, or NULL on error.
8816 expand_file_big_buffer(const uschar * filename)
8818 int fd, off = 0, len;
8820 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8822 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file '%s' for reading: %s",
8823 filename, strerror(errno));
8829 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8832 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8840 big_buffer[off] = '\0';
8846 /*************************************************
8847 * Error-checking for testsuite *
8848 *************************************************/
8850 uschar * region_start;
8851 uschar * region_end;
8852 const uschar *var_name;
8853 const uschar *var_data;
8856 /* Called via tree_walk, which allows nonconst name/data. Our usage is const. */
8858 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8861 if (var_data >= e->region_start && var_data < e->region_end)
8863 e->var_name = CUS var_name;
8864 e->var_data = CUS var_data;
8869 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8871 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8872 .var_name = NULL, .var_data = NULL };
8874 /* check acl_ variables */
8875 tree_walk(acl_var_c, assert_variable_notin, &e);
8876 tree_walk(acl_var_m, assert_variable_notin, &e);
8878 /* check auth<n> variables.
8879 assert_variable_notin() treats as const, so deconst is safe. */
8880 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8881 assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8883 #ifdef WITH_CONTENT_SCAN
8884 /* check regex<n> variables. assert_variable_notin() treats as const. */
8885 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8886 assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8889 /* check known-name variables */
8890 for (var_entry * v = var_table; v < var_table + nelem(var_table); v++)
8891 if (v->type == vtype_stringptr)
8892 assert_variable_notin(US v->name, *(USS v->value), &e);
8894 /* check dns and address trees */
8895 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8896 tree_walk(tree_duplicates, assert_variable_notin, &e);
8897 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8898 tree_walk(tree_unusable, assert_variable_notin, &e);
8901 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8902 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8903 e.var_name, filename, linenumber, e.var_data);
8908 /*************************************************
8909 **************************************************
8910 * Stand-alone test program *
8911 **************************************************
8912 *************************************************/
8918 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8920 int ovec[3*(EXPAND_MAXN+1)];
8921 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8923 BOOL yield = n >= 0;
8924 if (n == 0) n = EXPAND_MAXN + 1;
8927 expand_nmax = setup < 0 ? 0 : setup + 1;
8928 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8930 expand_nstring[expand_nmax] = subject + ovec[nn];
8931 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8939 int main(int argc, uschar **argv)
8941 uschar buffer[1024];
8943 debug_selector = D_v;
8944 debug_file = stderr;
8945 debug_fd = fileno(debug_file);
8946 big_buffer = malloc(big_buffer_size);
8949 for (int i = 1; i < argc; i++)
8951 if (argv[i][0] == '+')
8953 debug_trace_memory = 2;
8956 if (isdigit(argv[i][0]))
8957 debug_selector = Ustrtol(argv[i], NULL, 0);
8959 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8963 eldap_default_servers = argv[i];
8966 mysql_servers = argv[i];
8969 pgsql_servers = argv[i];
8972 redis_servers = argv[i];
8976 else opt_perl_startup = argv[i];
8980 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8982 expand_nstring[1] = US"string 1....";
8983 expand_nlength[1] = 8;
8987 if (opt_perl_startup != NULL)
8990 printf("Starting Perl interpreter\n");
8991 errstr = init_perl(opt_perl_startup);
8994 printf("** error in perl_startup code: %s\n", errstr);
8995 return EXIT_FAILURE;
8998 #endif /* EXIM_PERL */
9000 /* Thie deliberately regards the input as untainted, so that it can be
9001 expanded; only reasonable since this is a test for string-expansions. */
9003 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
9005 rmark reset_point = store_mark();
9006 uschar *yield = expand_string(buffer);
9008 printf("%s\n", yield);
9011 if (f.search_find_defer) printf("search_find deferred\n");
9012 printf("Failed: %s\n", expand_string_message);
9013 if (f.expand_string_forcedfail) printf("Forced failure\n");
9016 store_reset(reset_point);
9024 #endif /*STAND_ALONE*/
9026 #endif /*!MACRO_PREDEF*/
9029 /* End of expand.c */
git://git.exim.org / exim.git / blob