1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 - 2021 */
7 /* See the file NOTICE for conditions of use and distribution. */
10 /* Functions for handling string expansion. */
15 /* Recursively called function */
17 static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *);
18 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
21 # ifndef SUPPORT_CRYPTEQ
22 # define SUPPORT_CRYPTEQ
27 # include "lookups/ldap.h"
30 #ifdef SUPPORT_CRYPTEQ
35 extern char* crypt16(char*, char*);
39 /* The handling of crypt16() is a mess. I will record below the analysis of the
40 mess that was sent to me. We decided, however, to make changing this very low
41 priority, because in practice people are moving away from the crypt()
42 algorithms nowadays, so it doesn't seem worth it.
45 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
46 the first 8 characters of the password using a 20-round version of crypt
47 (standard crypt does 25 rounds). It then crypts the next 8 characters,
48 or an empty block if the password is less than 9 characters, using a
49 20-round version of crypt and the same salt as was used for the first
50 block. Characters after the first 16 are ignored. It always generates
51 a 16-byte hash, which is expressed together with the salt as a string
52 of 24 base 64 digits. Here are some links to peruse:
54 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
55 http://seclists.org/bugtraq/1999/Mar/0076.html
57 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
58 and OSF/1. This is the same as the standard crypt if given a password
59 of 8 characters or less. If given more, it first does the same as crypt
60 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
61 using as salt the first two base 64 digits from the first hash block.
62 If the password is more than 16 characters then it crypts the 17th to 24th
63 characters using as salt the first two base 64 digits from the second hash
64 block. And so on: I've seen references to it cutting off the password at
65 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
67 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
68 http://seclists.org/bugtraq/1999/Mar/0109.html
69 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
70 TET1_html/sec.c222.html#no_id_208
72 Exim has something it calls "crypt16". It will either use a native
73 crypt16 or its own implementation. A native crypt16 will presumably
74 be the one that I called "crypt16" above. The internal "crypt16"
75 function, however, is a two-block-maximum implementation of what I called
76 "bigcrypt". The documentation matches the internal code.
78 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
79 that crypt16 and bigcrypt were different things.
81 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
82 to whatever it is using under that name. This unfortunately sets a
83 precedent for using "{crypt16}" to identify two incompatible algorithms
84 whose output can't be distinguished. With "{crypt16}" thus rendered
85 ambiguous, I suggest you deprecate it and invent two new identifiers
86 for the two algorithms.
88 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
89 of the password separately means they can be cracked separately, so
90 the double-length hash only doubles the cracking effort instead of
91 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
98 /*************************************************
99 * Local statics and tables *
100 *************************************************/
102 /* Table of item names, and corresponding switch numbers. The names must be in
103 alphabetical order. */
105 static uschar *item_table[] = {
175 /* Tables of operator names, and corresponding switch numbers. The names must be
176 in alphabetical order. There are two tables, because underscore is used in some
177 cases to introduce arguments, whereas for other it is part of the name. This is
178 an historical mis-design. */
180 static uschar * op_table_underscore[] = {
183 US"quote_local_part",
188 ,US"utf8_domain_from_alabel",
189 US"utf8_domain_to_alabel",
190 US"utf8_localpart_from_alabel",
191 US"utf8_localpart_to_alabel"
198 EOP_QUOTE_LOCAL_PART,
203 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
204 EOP_UTF8_DOMAIN_TO_ALABEL,
205 EOP_UTF8_LOCALPART_FROM_ALABEL,
206 EOP_UTF8_LOCALPART_TO_ALABEL
210 static uschar *op_table_main[] = {
258 EOP_ADDRESS = nelem(op_table_underscore),
305 /* Table of condition names, and corresponding switch numbers. The names must
306 be in alphabetical order. */
308 static uschar *cond_table[] = {
312 US"==", /* Backward compatibility */
352 US"match_local_part",
377 ECOND_FIRST_DELIVERY,
405 ECOND_MATCH_LOCAL_PART,
415 /* Types of table entry */
418 vtype_int, /* value is address of int */
419 vtype_filter_int, /* ditto, but recognized only when filtering */
420 vtype_ino, /* value is address of ino_t (not always an int) */
421 vtype_uid, /* value is address of uid_t (not always an int) */
422 vtype_gid, /* value is address of gid_t (not always an int) */
423 vtype_bool, /* value is address of bool */
424 vtype_stringptr, /* value is address of pointer to string */
425 vtype_msgbody, /* as stringptr, but read when first required */
426 vtype_msgbody_end, /* ditto, the end of the message */
427 vtype_msgheaders, /* the message's headers, processed */
428 vtype_msgheaders_raw, /* the message's headers, unprocessed */
429 vtype_localpart, /* extract local part from string */
430 vtype_domain, /* extract domain from string */
431 vtype_string_func, /* value is string returned by given function */
432 vtype_todbsdin, /* value not used; generate BSD inbox tod */
433 vtype_tode, /* value not used; generate tod in epoch format */
434 vtype_todel, /* value not used; generate tod in epoch/usec format */
435 vtype_todf, /* value not used; generate full tod */
436 vtype_todl, /* value not used; generate log tod */
437 vtype_todlf, /* value not used; generate log file datestamp tod */
438 vtype_todzone, /* value not used; generate time zone only */
439 vtype_todzulu, /* value not used; generate zulu tod */
440 vtype_reply, /* value not used; get reply from headers */
441 vtype_pid, /* value not used; result is pid */
442 vtype_host_lookup, /* value not used; get host name */
443 vtype_load_avg, /* value not used; result is int from os_getloadavg */
444 vtype_pspace, /* partition space; value is T/F for spool/log */
445 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
446 vtype_cert /* SSL certificate */
448 ,vtype_dkim /* Lookup of value in DKIM signature */
452 /* Type for main variable table */
460 /* Type for entries pointing to address/length pairs. Not currently
468 static uschar * fn_recipients(void);
469 typedef uschar * stringptr_fn_t(void);
470 static uschar * fn_queue_size(void);
472 /* This table must be kept in alphabetical order. */
474 static var_entry var_table[] = {
475 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
476 they will be confused with user-creatable ACL variables. */
477 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
478 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
479 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
480 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
481 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
482 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
483 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
484 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
485 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
486 { "acl_narg", vtype_int, &acl_narg },
487 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
488 { "address_data", vtype_stringptr, &deliver_address_data },
489 { "address_file", vtype_stringptr, &address_file },
490 { "address_pipe", vtype_stringptr, &address_pipe },
491 #ifdef EXPERIMENTAL_ARC
492 { "arc_domains", vtype_string_func, (void *) &fn_arc_domains },
493 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
494 { "arc_state", vtype_stringptr, &arc_state },
495 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
497 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
498 { "authenticated_id", vtype_stringptr, &authenticated_id },
499 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
500 { "authentication_failed",vtype_int, &authentication_failed },
501 #ifdef WITH_CONTENT_SCAN
502 { "av_failed", vtype_int, &av_failed },
504 #ifdef EXPERIMENTAL_BRIGHTMAIL
505 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
506 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
507 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
508 { "bmi_deliver", vtype_int, &bmi_deliver },
510 { "body_linecount", vtype_int, &body_linecount },
511 { "body_zerocount", vtype_int, &body_zerocount },
512 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
513 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
514 { "caller_gid", vtype_gid, &real_gid },
515 { "caller_uid", vtype_uid, &real_uid },
516 { "callout_address", vtype_stringptr, &callout_address },
517 { "compile_date", vtype_stringptr, &version_date },
518 { "compile_number", vtype_stringptr, &version_cnumber },
519 { "config_dir", vtype_stringptr, &config_main_directory },
520 { "config_file", vtype_stringptr, &config_main_filename },
521 { "csa_status", vtype_stringptr, &csa_status },
522 #ifdef EXPERIMENTAL_DCC
523 { "dcc_header", vtype_stringptr, &dcc_header },
524 { "dcc_result", vtype_stringptr, &dcc_result },
527 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
528 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
529 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
530 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
531 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
532 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
533 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
534 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
535 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
536 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
537 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
538 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
539 { "dkim_key_length", vtype_int, &dkim_key_length },
540 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
541 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
542 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
543 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
544 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
545 { "dkim_signers", vtype_stringptr, &dkim_signers },
546 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
547 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
550 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
551 { "dmarc_status", vtype_stringptr, &dmarc_status },
552 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
553 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
555 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
556 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
557 { "dnslist_text", vtype_stringptr, &dnslist_text },
558 { "dnslist_value", vtype_stringptr, &dnslist_value },
559 { "domain", vtype_stringptr, &deliver_domain },
560 { "domain_data", vtype_stringptr, &deliver_domain_data },
561 #ifndef DISABLE_EVENT
562 { "event_data", vtype_stringptr, &event_data },
564 /*XXX want to use generic vars for as many of these as possible*/
565 { "event_defer_errno", vtype_int, &event_defer_errno },
567 { "event_name", vtype_stringptr, &event_name },
569 { "exim_gid", vtype_gid, &exim_gid },
570 { "exim_path", vtype_stringptr, &exim_path },
571 { "exim_uid", vtype_uid, &exim_uid },
572 { "exim_version", vtype_stringptr, &version_string },
573 { "headers_added", vtype_string_func, (void *) &fn_hdrs_added },
574 { "home", vtype_stringptr, &deliver_home },
575 { "host", vtype_stringptr, &deliver_host },
576 { "host_address", vtype_stringptr, &deliver_host_address },
577 { "host_data", vtype_stringptr, &host_data },
578 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
579 { "host_lookup_failed", vtype_int, &host_lookup_failed },
580 { "host_port", vtype_int, &deliver_host_port },
581 { "initial_cwd", vtype_stringptr, &initial_cwd },
582 { "inode", vtype_ino, &deliver_inode },
583 { "interface_address", vtype_stringptr, &interface_address },
584 { "interface_port", vtype_int, &interface_port },
585 { "item", vtype_stringptr, &iterate_item },
587 { "ldap_dn", vtype_stringptr, &eldap_dn },
589 { "load_average", vtype_load_avg, NULL },
590 { "local_part", vtype_stringptr, &deliver_localpart },
591 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
592 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
593 { "local_part_prefix_v", vtype_stringptr, &deliver_localpart_prefix_v },
594 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
595 { "local_part_suffix_v", vtype_stringptr, &deliver_localpart_suffix_v },
596 #ifdef HAVE_LOCAL_SCAN
597 { "local_scan_data", vtype_stringptr, &local_scan_data },
599 { "local_user_gid", vtype_gid, &local_user_gid },
600 { "local_user_uid", vtype_uid, &local_user_uid },
601 { "localhost_number", vtype_int, &host_number },
602 { "log_inodes", vtype_pinodes, (void *)FALSE },
603 { "log_space", vtype_pspace, (void *)FALSE },
604 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
605 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
606 #ifdef WITH_CONTENT_SCAN
607 { "malware_name", vtype_stringptr, &malware_name },
609 { "max_received_linelength", vtype_int, &max_received_linelength },
610 { "message_age", vtype_int, &message_age },
611 { "message_body", vtype_msgbody, &message_body },
612 { "message_body_end", vtype_msgbody_end, &message_body_end },
613 { "message_body_size", vtype_int, &message_body_size },
614 { "message_exim_id", vtype_stringptr, &message_id },
615 { "message_headers", vtype_msgheaders, NULL },
616 { "message_headers_raw", vtype_msgheaders_raw, NULL },
617 { "message_id", vtype_stringptr, &message_id },
618 { "message_linecount", vtype_int, &message_linecount },
619 { "message_size", vtype_int, &message_size },
621 { "message_smtputf8", vtype_bool, &message_smtputf8 },
623 #ifdef WITH_CONTENT_SCAN
624 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
625 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
626 { "mime_boundary", vtype_stringptr, &mime_boundary },
627 { "mime_charset", vtype_stringptr, &mime_charset },
628 { "mime_content_description", vtype_stringptr, &mime_content_description },
629 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
630 { "mime_content_id", vtype_stringptr, &mime_content_id },
631 { "mime_content_size", vtype_int, &mime_content_size },
632 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
633 { "mime_content_type", vtype_stringptr, &mime_content_type },
634 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
635 { "mime_filename", vtype_stringptr, &mime_filename },
636 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
637 { "mime_is_multipart", vtype_int, &mime_is_multipart },
638 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
639 { "mime_part_count", vtype_int, &mime_part_count },
641 { "n0", vtype_filter_int, &filter_n[0] },
642 { "n1", vtype_filter_int, &filter_n[1] },
643 { "n2", vtype_filter_int, &filter_n[2] },
644 { "n3", vtype_filter_int, &filter_n[3] },
645 { "n4", vtype_filter_int, &filter_n[4] },
646 { "n5", vtype_filter_int, &filter_n[5] },
647 { "n6", vtype_filter_int, &filter_n[6] },
648 { "n7", vtype_filter_int, &filter_n[7] },
649 { "n8", vtype_filter_int, &filter_n[8] },
650 { "n9", vtype_filter_int, &filter_n[9] },
651 { "original_domain", vtype_stringptr, &deliver_domain_orig },
652 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
653 { "originator_gid", vtype_gid, &originator_gid },
654 { "originator_uid", vtype_uid, &originator_uid },
655 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
656 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
657 { "pid", vtype_pid, NULL },
659 { "prdr_requested", vtype_bool, &prdr_requested },
661 { "primary_hostname", vtype_stringptr, &primary_hostname },
662 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
663 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
664 { "proxy_external_port", vtype_int, &proxy_external_port },
665 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
666 { "proxy_local_port", vtype_int, &proxy_local_port },
667 { "proxy_session", vtype_bool, &proxy_session },
669 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
670 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
671 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
672 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
673 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
674 { "queue_name", vtype_stringptr, &queue_name },
675 { "queue_size", vtype_string_func, &fn_queue_size },
676 { "rcpt_count", vtype_int, &rcpt_count },
677 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
678 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
679 { "received_count", vtype_int, &received_count },
680 { "received_for", vtype_stringptr, &received_for },
681 { "received_ip_address", vtype_stringptr, &interface_address },
682 { "received_port", vtype_int, &interface_port },
683 { "received_protocol", vtype_stringptr, &received_protocol },
684 { "received_time", vtype_int, &received_time.tv_sec },
685 { "recipient_data", vtype_stringptr, &recipient_data },
686 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
687 { "recipients", vtype_string_func, (void *) &fn_recipients },
688 { "recipients_count", vtype_int, &recipients_count },
689 #ifdef WITH_CONTENT_SCAN
690 { "regex_match_string", vtype_stringptr, ®ex_match_string },
692 { "reply_address", vtype_reply, NULL },
693 { "return_path", vtype_stringptr, &return_path },
694 { "return_size_limit", vtype_int, &bounce_return_size_limit },
695 { "router_name", vtype_stringptr, &router_name },
696 { "runrc", vtype_int, &runrc },
697 { "self_hostname", vtype_stringptr, &self_hostname },
698 { "sender_address", vtype_stringptr, &sender_address },
699 { "sender_address_data", vtype_stringptr, &sender_address_data },
700 { "sender_address_domain", vtype_domain, &sender_address },
701 { "sender_address_local_part", vtype_localpart, &sender_address },
702 { "sender_data", vtype_stringptr, &sender_data },
703 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
704 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
705 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
706 { "sender_host_address", vtype_stringptr, &sender_host_address },
707 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
708 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
709 { "sender_host_name", vtype_host_lookup, NULL },
710 { "sender_host_port", vtype_int, &sender_host_port },
711 { "sender_ident", vtype_stringptr, &sender_ident },
712 { "sender_rate", vtype_stringptr, &sender_rate },
713 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
714 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
715 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
716 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
717 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
718 { "sending_port", vtype_int, &sending_port },
719 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
720 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
721 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
722 { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
723 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
724 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
725 { "sn0", vtype_filter_int, &filter_sn[0] },
726 { "sn1", vtype_filter_int, &filter_sn[1] },
727 { "sn2", vtype_filter_int, &filter_sn[2] },
728 { "sn3", vtype_filter_int, &filter_sn[3] },
729 { "sn4", vtype_filter_int, &filter_sn[4] },
730 { "sn5", vtype_filter_int, &filter_sn[5] },
731 { "sn6", vtype_filter_int, &filter_sn[6] },
732 { "sn7", vtype_filter_int, &filter_sn[7] },
733 { "sn8", vtype_filter_int, &filter_sn[8] },
734 { "sn9", vtype_filter_int, &filter_sn[9] },
735 #ifdef WITH_CONTENT_SCAN
736 { "spam_action", vtype_stringptr, &spam_action },
737 { "spam_bar", vtype_stringptr, &spam_bar },
738 { "spam_report", vtype_stringptr, &spam_report },
739 { "spam_score", vtype_stringptr, &spam_score },
740 { "spam_score_int", vtype_stringptr, &spam_score_int },
743 { "spf_guess", vtype_stringptr, &spf_guess },
744 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
745 { "spf_received", vtype_stringptr, &spf_received },
746 { "spf_result", vtype_stringptr, &spf_result },
747 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
748 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
750 { "spool_directory", vtype_stringptr, &spool_directory },
751 { "spool_inodes", vtype_pinodes, (void *)TRUE },
752 { "spool_space", vtype_pspace, (void *)TRUE },
754 { "srs_recipient", vtype_stringptr, &srs_recipient },
756 { "thisaddress", vtype_stringptr, &filter_thisaddress },
758 /* The non-(in,out) variables are now deprecated */
759 { "tls_bits", vtype_int, &tls_in.bits },
760 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
761 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
763 { "tls_in_bits", vtype_int, &tls_in.bits },
764 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
765 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
766 { "tls_in_cipher_std", vtype_stringptr, &tls_in.cipher_stdname },
767 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
768 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
769 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
770 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
771 #ifndef DISABLE_TLS_RESUME
772 { "tls_in_resumption", vtype_int, &tls_in.resumption },
775 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
777 { "tls_in_ver", vtype_stringptr, &tls_in.ver },
778 { "tls_out_bits", vtype_int, &tls_out.bits },
779 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
780 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
781 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },
783 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
785 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
786 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
787 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
788 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
789 #ifndef DISABLE_TLS_RESUME
790 { "tls_out_resumption", vtype_int, &tls_out.resumption },
793 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
796 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
798 { "tls_out_ver", vtype_stringptr, &tls_out.ver },
800 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
802 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
805 { "tod_bsdinbox", vtype_todbsdin, NULL },
806 { "tod_epoch", vtype_tode, NULL },
807 { "tod_epoch_l", vtype_todel, NULL },
808 { "tod_full", vtype_todf, NULL },
809 { "tod_log", vtype_todl, NULL },
810 { "tod_logfile", vtype_todlf, NULL },
811 { "tod_zone", vtype_todzone, NULL },
812 { "tod_zulu", vtype_todzulu, NULL },
813 { "transport_name", vtype_stringptr, &transport_name },
814 { "value", vtype_stringptr, &lookup_value },
815 { "verify_mode", vtype_stringptr, &verify_mode },
816 { "version_number", vtype_stringptr, &version_string },
817 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
818 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
819 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
820 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
821 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
822 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
825 static int var_table_size = nelem(var_table);
826 static uschar var_buffer[256];
827 static BOOL malformed_header;
829 /* For textual hashes */
831 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
832 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
835 enum { HMAC_MD5, HMAC_SHA1 };
837 /* For numeric hashes */
839 static unsigned int prime[] = {
840 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
841 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
842 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
844 /* For printing modes in symbolic form */
846 static uschar *mtable_normal[] =
847 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
849 static uschar *mtable_setid[] =
850 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
852 static uschar *mtable_sticky[] =
853 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
855 /* flags for find_header() */
856 #define FH_EXISTS_ONLY BIT(0)
857 #define FH_WANT_RAW BIT(1)
858 #define FH_WANT_LIST BIT(2)
861 /*************************************************
862 * Tables for UTF-8 support *
863 *************************************************/
865 /* Table of the number of extra characters, indexed by the first character
866 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
869 static uschar utf8_table1[] = {
870 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
871 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
872 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
873 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
875 /* These are the masks for the data bits in the first byte of a character,
876 indexed by the number of additional bytes. */
878 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
880 /* Get the next UTF-8 character, advancing the pointer. */
882 #define GETUTF8INC(c, ptr) \
884 if ((c & 0xc0) == 0xc0) \
886 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
888 c = (c & utf8_table2[a]) << s; \
892 c |= (*ptr++ & 0x3f) << s; \
898 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
900 /*************************************************
901 * Binary chop search on a table *
902 *************************************************/
904 /* This is used for matching expansion items and operators.
907 name the name that is being sought
908 table the table to search
909 table_size the number of items in the table
911 Returns: the offset in the table, or -1
915 chop_match(uschar *name, uschar **table, int table_size)
917 uschar **bot = table;
918 uschar **top = table + table_size;
922 uschar **mid = bot + (top - bot)/2;
923 int c = Ustrcmp(name, *mid);
924 if (c == 0) return mid - table;
925 if (c > 0) bot = mid + 1; else top = mid;
933 /*************************************************
934 * Check a condition string *
935 *************************************************/
937 /* This function is called to expand a string, and test the result for a "true"
938 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
939 forced fail or lookup defer.
941 We used to release all store used, but this is not not safe due
942 to ${dlfunc } and ${acl }. In any case expand_string_internal()
943 is reasonably careful to release what it can.
945 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
948 condition the condition string
949 m1 text to be incorporated in panic error
952 Returns: TRUE if condition is met, FALSE if not
956 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
958 uschar * ss = expand_string(condition);
961 if (!f.expand_string_forcedfail && !f.search_find_defer)
962 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
963 "for %s %s: %s", condition, m1, m2, expand_string_message);
966 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
967 strcmpic(ss, US"false") != 0;
973 /*************************************************
974 * Pseudo-random number generation *
975 *************************************************/
977 /* Pseudo-random number generation. The result is not "expected" to be
978 cryptographically strong but not so weak that someone will shoot themselves
979 in the foot using it as a nonce in some email header scheme or whatever
980 weirdness they'll twist this into. The result should ideally handle fork().
982 However, if we're stuck unable to provide this, then we'll fall back to
983 appallingly bad randomness.
985 If DISABLE_TLS is not defined then this will not be used except as an emergency
990 Returns a random number in range [0, max-1]
994 # define vaguely_random_number vaguely_random_number_fallback
997 vaguely_random_number(int max)
1000 # undef vaguely_random_number
1002 static pid_t pid = 0;
1005 if ((p2 = getpid()) != pid)
1010 #ifdef HAVE_ARC4RANDOM
1011 /* cryptographically strong randomness, common on *BSD platforms, not
1012 so much elsewhere. Alas. */
1013 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1016 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1017 # ifdef HAVE_SRANDOMDEV
1018 /* uses random(4) for seeding */
1023 gettimeofday(&tv, NULL);
1024 srandom(tv.tv_sec | tv.tv_usec | getpid());
1028 /* Poor randomness and no seeding here */
1035 #ifdef HAVE_ARC4RANDOM
1036 return arc4random() % max;
1037 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1038 return random() % max;
1040 /* This one returns a 16-bit number, definitely not crypto-strong */
1041 return random_number(max);
1048 /*************************************************
1049 * Pick out a name from a string *
1050 *************************************************/
1052 /* If the name is too long, it is silently truncated.
1055 name points to a buffer into which to put the name
1056 max is the length of the buffer
1057 s points to the first alphabetic character of the name
1058 extras chars other than alphanumerics to permit
1060 Returns: pointer to the first character after the name
1062 Note: The test for *s != 0 in the while loop is necessary because
1063 Ustrchr() yields non-NULL if the character is zero (which is not something
1066 static const uschar *
1067 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1070 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1072 if (ptr < max-1) name[ptr++] = *s;
1081 /*************************************************
1082 * Pick out the rest of a header name *
1083 *************************************************/
1085 /* A variable name starting $header_ (or just $h_ for those who like
1086 abbreviations) might not be the complete header name because headers can
1087 contain any printing characters in their names, except ':'. This function is
1088 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1089 on the end, if the name was terminated by white space.
1092 name points to a buffer in which the name read so far exists
1093 max is the length of the buffer
1094 s points to the first character after the name so far, i.e. the
1095 first non-alphameric character after $header_xxxxx
1097 Returns: a pointer to the first character after the header name
1100 static const uschar *
1101 read_header_name(uschar *name, int max, const uschar *s)
1103 int prelen = Ustrchr(name, '_') - name + 1;
1104 int ptr = Ustrlen(name) - prelen;
1105 if (ptr > 0) memmove(name, name+prelen, ptr);
1106 while (mac_isgraph(*s) && *s != ':')
1108 if (ptr < max-1) name[ptr++] = *s;
1119 /*************************************************
1120 * Pick out a number from a string *
1121 *************************************************/
1124 n points to an integer into which to put the number
1125 s points to the first digit of the number
1127 Returns: a pointer to the character after the last digit
1129 /*XXX consider expanding to int_eximarith_t. But the test for
1130 "overbig numbers" in 0002 still needs to overflow it. */
1133 read_number(int *n, uschar *s)
1136 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1140 static const uschar *
1141 read_cnumber(int *n, const uschar *s)
1144 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1150 /*************************************************
1151 * Extract keyed subfield from a string *
1152 *************************************************/
1154 /* The yield is in dynamic store; NULL means that the key was not found.
1157 key points to the name of the key
1158 s points to the string from which to extract the subfield
1160 Returns: NULL if the subfield was not found, or
1161 a pointer to the subfield's data
1165 expand_getkeyed(const uschar * key, const uschar * s)
1167 int length = Ustrlen(key);
1168 Uskip_whitespace(&s);
1170 /* Loop to search for the key */
1176 const uschar * dkey = s;
1178 while (*s && *s != '=' && !isspace(*s)) s++;
1179 dkeylength = s - dkey;
1180 if (Uskip_whitespace(&s) == '=') while (isspace(*++s));
1182 data = string_dequote(&s);
1183 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1186 Uskip_whitespace(&s);
1195 find_var_ent(uschar * name)
1198 int last = var_table_size;
1200 while (last > first)
1202 int middle = (first + last)/2;
1203 int c = Ustrcmp(name, var_table[middle].name);
1205 if (c > 0) { first = middle + 1; continue; }
1206 if (c < 0) { last = middle; continue; }
1207 return &var_table[middle];
1212 /*************************************************
1213 * Extract numbered subfield from string *
1214 *************************************************/
1216 /* Extracts a numbered field from a string that is divided by tokens - for
1217 example a line from /etc/passwd is divided by colon characters. First field is
1218 numbered one. Negative arguments count from the right. Zero returns the whole
1219 string. Returns NULL if there are insufficient tokens in the string
1222 Modifies final argument - this is a dynamically generated string, so that's OK.
1225 field number of field to be extracted,
1226 first field = 1, whole string = 0, last field = -1
1227 separators characters that are used to break string into tokens
1228 s points to the string from which to extract the subfield
1230 Returns: NULL if the field was not found,
1231 a pointer to the field's data inside s (modified to add 0)
1235 expand_gettokened (int field, uschar *separators, uschar *s)
1240 uschar *fieldtext = NULL;
1242 if (field == 0) return s;
1244 /* Break the line up into fields in place; for field > 0 we stop when we have
1245 done the number of fields we want. For field < 0 we continue till the end of
1246 the string, counting the number of fields. */
1248 count = (field > 0)? field : INT_MAX;
1254 /* Previous field was the last one in the string. For a positive field
1255 number, this means there are not enough fields. For a negative field number,
1256 check that there are enough, and scan back to find the one that is wanted. */
1260 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1261 if ((-field) == (INT_MAX - count - 1)) return s;
1265 while (ss[-1] != 0) ss--;
1271 /* Previous field was not last in the string; save its start and put a
1275 len = Ustrcspn(ss, separators);
1286 expand_getlistele(int field, const uschar * list)
1288 const uschar * tlist = list;
1290 /* Tainted mem for the throwaway element copies */
1291 uschar * dummy = store_get(2, TRUE);
1295 for (field++; string_nextinlist(&tlist, &sep, dummy, 1); ) field++;
1298 if (field == 0) return NULL;
1299 while (--field > 0 && (string_nextinlist(&list, &sep, dummy, 1))) ;
1300 return string_nextinlist(&list, &sep, NULL, 0);
1304 /* Certificate fields, by name. Worry about by-OID later */
1305 /* Names are chosen to not have common prefixes */
1312 uschar * (*getfn)(void * cert, uschar * mod);
1314 static certfield certfields[] =
1315 { /* linear search; no special order */
1316 { US"version", 7, &tls_cert_version },
1317 { US"serial_number", 13, &tls_cert_serial_number },
1318 { US"subject", 7, &tls_cert_subject },
1319 { US"notbefore", 9, &tls_cert_not_before },
1320 { US"notafter", 8, &tls_cert_not_after },
1321 { US"issuer", 6, &tls_cert_issuer },
1322 { US"signature", 9, &tls_cert_signature },
1323 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1324 { US"subj_altname", 12, &tls_cert_subject_altname },
1325 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1326 { US"crl_uri", 7, &tls_cert_crl_uri },
1330 expand_getcertele(uschar * field, uschar * certvar)
1334 if (!(vp = find_var_ent(certvar)))
1336 expand_string_message =
1337 string_sprintf("no variable named \"%s\"", certvar);
1338 return NULL; /* Unknown variable name */
1340 /* NB this stops us passing certs around in variable. Might
1341 want to do that in future */
1342 if (vp->type != vtype_cert)
1344 expand_string_message =
1345 string_sprintf("\"%s\" is not a certificate", certvar);
1346 return NULL; /* Unknown variable name */
1348 if (!*(void **)vp->value)
1351 if (*field >= '0' && *field <= '9')
1352 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1354 for (certfield * cp = certfields;
1355 cp < certfields + nelem(certfields);
1357 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1359 uschar * modifier = *(field += cp->namelen) == ','
1361 return (*cp->getfn)( *(void **)vp->value, modifier );
1364 expand_string_message =
1365 string_sprintf("bad field selector \"%s\" for certextract", field);
1368 #endif /*DISABLE_TLS*/
1370 /*************************************************
1371 * Extract a substring from a string *
1372 *************************************************/
1374 /* Perform the ${substr or ${length expansion operations.
1377 subject the input string
1378 value1 the offset from the start of the input string to the start of
1379 the output string; if negative, count from the right.
1380 value2 the length of the output string, or negative (-1) for unset
1381 if value1 is positive, unset means "all after"
1382 if value1 is negative, unset means "all before"
1383 len set to the length of the returned string
1385 Returns: pointer to the output string, or NULL if there is an error
1389 extract_substr(uschar *subject, int value1, int value2, int *len)
1391 int sublen = Ustrlen(subject);
1393 if (value1 < 0) /* count from right */
1397 /* If the position is before the start, skip to the start, and adjust the
1398 length. If the length ends up negative, the substring is null because nothing
1399 can precede. This falls out naturally when the length is unset, meaning "all
1405 if (value2 < 0) value2 = 0;
1409 /* Otherwise an unset length => characters before value1 */
1411 else if (value2 < 0)
1418 /* For a non-negative offset, if the starting position is past the end of the
1419 string, the result will be the null string. Otherwise, an unset length means
1420 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1424 if (value1 > sublen)
1429 else if (value2 < 0) value2 = sublen;
1432 /* Cut the length down to the maximum possible for the offset value, and get
1433 the required characters. */
1435 if (value1 + value2 > sublen) value2 = sublen - value1;
1437 return subject + value1;
1443 /*************************************************
1444 * Old-style hash of a string *
1445 *************************************************/
1447 /* Perform the ${hash expansion operation.
1450 subject the input string (an expanded substring)
1451 value1 the length of the output string; if greater or equal to the
1452 length of the input string, the input string is returned
1453 value2 the number of hash characters to use, or 26 if negative
1454 len set to the length of the returned string
1456 Returns: pointer to the output string, or NULL if there is an error
1460 compute_hash(uschar *subject, int value1, int value2, int *len)
1462 int sublen = Ustrlen(subject);
1464 if (value2 < 0) value2 = 26;
1465 else if (value2 > Ustrlen(hashcodes))
1467 expand_string_message =
1468 string_sprintf("hash count \"%d\" too big", value2);
1472 /* Calculate the hash text. We know it is shorter than the original string, so
1473 can safely place it in subject[] (we know that subject is always itself an
1474 expanded substring). */
1476 if (value1 < sublen)
1481 while ((c = (subject[j])) != 0)
1483 int shift = (c + j++) & 7;
1484 subject[i] ^= (c << shift) | (c >> (8-shift));
1485 if (++i >= value1) i = 0;
1487 for (i = 0; i < value1; i++)
1488 subject[i] = hashcodes[(subject[i]) % value2];
1490 else value1 = sublen;
1499 /*************************************************
1500 * Numeric hash of a string *
1501 *************************************************/
1503 /* Perform the ${nhash expansion operation. The first characters of the
1504 string are treated as most important, and get the highest prime numbers.
1507 subject the input string
1508 value1 the maximum value of the first part of the result
1509 value2 the maximum value of the second part of the result,
1510 or negative to produce only a one-part result
1511 len set to the length of the returned string
1513 Returns: pointer to the output string, or NULL if there is an error.
1517 compute_nhash (uschar *subject, int value1, int value2, int *len)
1519 uschar *s = subject;
1521 unsigned long int total = 0; /* no overflow */
1525 if (i == 0) i = nelem(prime) - 1;
1526 total += prime[i--] * (unsigned int)(*s++);
1529 /* If value2 is unset, just compute one number */
1532 s = string_sprintf("%lu", total % value1);
1534 /* Otherwise do a div/mod hash */
1538 total = total % (value1 * value2);
1539 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1550 /*************************************************
1551 * Find the value of a header or headers *
1552 *************************************************/
1554 /* Multiple instances of the same header get concatenated, and this function
1555 can also return a concatenation of all the header lines. When concatenating
1556 specific headers that contain lists of addresses, a comma is inserted between
1557 them. Otherwise we use a straight concatenation. Because some messages can have
1558 pathologically large number of lines, there is a limit on the length that is
1562 name the name of the header, without the leading $header_ or $h_,
1563 or NULL if a concatenation of all headers is required
1564 newsize return the size of memory block that was obtained; may be NULL
1565 if exists_only is TRUE
1566 flags FH_EXISTS_ONLY
1567 set if called from a def: test; don't need to build a string;
1568 just return a string that is not "" and not "0" if the header
1571 set if called for $rh_ or $rheader_ items; no processing,
1572 other than concatenating, will be done on the header. Also used
1573 for $message_headers_raw.
1575 Double colon chars in the content, and replace newline with
1576 colon between each element when concatenating; returning a
1577 colon-sep list (elements might contain newlines)
1578 charset name of charset to translate MIME words to; used only if
1579 want_raw is false; if NULL, no translation is done (this is
1580 used for $bh_ and $bheader_)
1582 Returns: NULL if the header does not exist, else a pointer to a new
1587 find_header(uschar *name, int *newsize, unsigned flags, const uschar *charset)
1590 int len = name ? Ustrlen(name) : 0;
1594 for (header_line * h = header_list; h; h = h->next)
1595 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1596 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1601 if (flags & FH_EXISTS_ONLY)
1602 return US"1"; /* don't need actual string */
1605 s = h->text + len; /* text to insert */
1606 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1607 Uskip_whitespace(&s); /* remove leading white space */
1608 t = h->text + h->slen; /* end-point */
1610 /* Unless wanted raw, remove trailing whitespace, including the
1613 if (flags & FH_WANT_LIST)
1614 while (t > s && t[-1] == '\n') t--;
1615 else if (!(flags & FH_WANT_RAW))
1617 while (t > s && isspace(t[-1])) t--;
1619 /* Set comma if handling a single header and it's one of those
1620 that contains an address list, except when asked for raw headers. Only
1621 need to do this once. */
1623 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1626 /* Trim the header roughly if we're approaching limits */
1628 if (gstring_length(g) + inc > header_insert_maxlen)
1629 inc = header_insert_maxlen - gstring_length(g);
1631 /* For raw just copy the data; for a list, add the data as a colon-sep
1632 list-element; for comma-list add as an unchecked comma,newline sep
1633 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1634 stripped trailing WS above including the newline). We ignore the potential
1635 expansion due to colon-doubling, just leaving the loop if the limit is met
1638 if (flags & FH_WANT_LIST)
1639 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1640 else if (flags & FH_WANT_RAW)
1641 g = string_catn(g, s, (unsigned)inc);
1643 g = string_append2_listele_n(g, comma ? US",\n" : US"\n",
1646 if (gstring_length(g) >= header_insert_maxlen) break;
1649 if (!found) return NULL; /* No header found */
1650 if (!g) return US"";
1652 /* That's all we do for raw header expansion. */
1655 if (flags & FH_WANT_RAW)
1656 return string_from_gstring(g);
1658 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1659 The rfc2047_decode2() function can return an error with decoded data if the
1660 charset translation fails. If decoding fails, it returns NULL. */
1664 uschar * error, * decoded = rfc2047_decode2(string_from_gstring(g),
1665 check_rfc2047_length, charset, '?', NULL, newsize, &error);
1667 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1668 " input was: %s\n", error, g->s);
1669 return decoded ? decoded : string_from_gstring(g);
1676 /* Append a "local" element to an Authentication-Results: header
1677 if this was a non-smtp message.
1681 authres_local(gstring * g, const uschar * sysname)
1683 if (!f.authentication_local)
1685 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1686 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1691 /* Append an "iprev" element to an Authentication-Results: header
1692 if we have attempted to get the calling host's name.
1696 authres_iprev(gstring * g)
1698 if (sender_host_name)
1699 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1700 else if (host_lookup_deferred)
1701 g = string_cat(g, US";\n\tiprev=temperror");
1702 else if (host_lookup_failed)
1703 g = string_cat(g, US";\n\tiprev=fail");
1707 if (sender_host_address)
1708 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1714 /*************************************************
1715 * Return list of recipients *
1716 *************************************************/
1717 /* A recipients list is available only during system message filtering,
1718 during ACL processing after DATA, and while expanding pipe commands
1719 generated from a system filter, but not elsewhere. */
1727 if (!f.enable_dollar_recipients) return NULL;
1729 for (int i = 0; i < recipients_count; i++)
1731 s = recipients_list[i].address;
1732 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1734 return g ? g->s : NULL;
1738 /*************************************************
1739 * Return size of queue *
1740 *************************************************/
1741 /* Ask the daemon for the queue size */
1746 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1750 const uschar * where;
1751 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1755 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
1757 DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));
1761 #ifdef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1762 sa_un.sun_path[0] = 0; /* Abstract local socket addr - Linux-specific? */
1763 len = offsetof(struct sockaddr_un, sun_path) + 1
1764 + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "exim_%d", getpid());
1766 sname = string_sprintf("%s/p_%d", spool_directory, getpid());
1767 len = offsetof(struct sockaddr_un, sun_path)
1768 + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s", sname);
1771 if (bind(fd, (const struct sockaddr *)&sa_un, len) < 0)
1772 { where = US"bind"; goto bad; }
1775 debug_printf("local addr '%s%s'\n",
1776 *sa_un.sun_path ? "" : "@",
1777 sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1780 #ifdef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1781 sa_un.sun_path[0] = 0; /* Abstract local socket addr - Linux-specific? */
1782 len = offsetof(struct sockaddr_un, sun_path) + 1
1783 + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "%s",
1784 expand_string(notifier_socket));
1786 len = offsetof(struct sockaddr_un, sun_path)
1787 + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s",
1788 expand_string(notifier_socket));
1791 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
1792 { where = US"connect"; goto bad2; }
1794 buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1795 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1797 if (poll_one_fd(fd, POLLIN, 2 * 1000) != 1)
1799 DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1800 len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1802 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1803 { where = US"recv"; goto bad2; }
1806 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1809 return string_copyn(buf, len);
1812 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1817 DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1822 /*************************************************
1823 * Find value of a variable *
1824 *************************************************/
1826 /* The table of variables is kept in alphabetic order, so we can search it
1827 using a binary chop. The "choplen" variable is nothing to do with the binary
1831 name the name of the variable being sought
1832 exists_only TRUE if this is a def: test; passed on to find_header()
1833 skipping TRUE => skip any processing evaluation; this is not the same as
1834 exists_only because def: may test for values that are first
1836 newsize pointer to an int which is initially zero; if the answer is in
1837 a new memory buffer, *newsize is set to its size
1839 Returns: NULL if the variable does not exist, or
1840 a pointer to the variable's contents, or
1841 something non-NULL if exists_only is TRUE
1844 static const uschar *
1845 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1852 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1853 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1854 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1855 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1856 (this gave backwards compatibility at the changeover). There may be built-in
1857 variables whose names start acl_ but they should never start in this way. This
1858 slightly messy specification is a consequence of the history, needless to say.
1860 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1861 set, in which case give an error. */
1863 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1867 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1868 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1870 else if (Ustrncmp(name, "r_", 2) == 0)
1872 tree_node * node = tree_search(router_var, name + 2);
1873 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1876 /* Handle $auth<n> variables. */
1878 if (Ustrncmp(name, "auth", 4) == 0)
1881 int n = Ustrtoul(name + 4, &endptr, 10);
1882 if (!*endptr && n != 0 && n <= AUTH_VARS)
1883 return auth_vars[n-1] ? auth_vars[n-1] : US"";
1885 else if (Ustrncmp(name, "regex", 5) == 0)
1888 int n = Ustrtoul(name + 5, &endptr, 10);
1889 if (!*endptr && n != 0 && n <= REGEX_VARS)
1890 return regex_vars[n-1] ? regex_vars[n-1] : US"";
1893 /* For all other variables, search the table */
1895 if (!(vp = find_var_ent(name)))
1896 return NULL; /* Unknown variable name */
1898 /* Found an existing variable. If in skipping state, the value isn't needed,
1899 and we want to avoid processing (such as looking up the host name). */
1907 case vtype_filter_int:
1908 if (!f.filter_running) return NULL;
1912 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1916 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1920 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1924 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1928 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1931 case vtype_stringptr: /* Pointer to string */
1932 return (s = *((uschar **)(val))) ? s : US"";
1935 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1938 case vtype_load_avg:
1939 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1942 case vtype_host_lookup: /* Lookup if not done so */
1943 if ( !sender_host_name && sender_host_address
1944 && !host_lookup_failed && host_name_lookup() == OK)
1945 host_build_sender_fullhost();
1946 return sender_host_name ? sender_host_name : US"";
1948 case vtype_localpart: /* Get local part from address */
1949 if (!(s = *((uschar **)(val)))) return US"";
1950 if (!(domain = Ustrrchr(s, '@'))) return s;
1951 if (domain - s > sizeof(var_buffer) - 1)
1952 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1953 " in string expansion", sizeof(var_buffer));
1954 return string_copyn(s, domain - s);
1956 case vtype_domain: /* Get domain from address */
1957 if (!(s = *((uschar **)(val)))) return US"";
1958 domain = Ustrrchr(s, '@');
1959 return domain ? domain + 1 : US"";
1961 case vtype_msgheaders:
1962 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
1964 case vtype_msgheaders_raw:
1965 return find_header(NULL, newsize,
1966 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
1968 case vtype_msgbody: /* Pointer to msgbody string */
1969 case vtype_msgbody_end: /* Ditto, the end of the msg */
1970 ss = (uschar **)(val);
1971 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1974 off_t start_offset = SPOOL_DATA_START_OFFSET;
1975 int len = message_body_visible;
1977 if (len > message_size) len = message_size;
1978 *ss = body = store_get(len+1, TRUE);
1980 if (vp->type == vtype_msgbody_end)
1982 struct stat statbuf;
1983 if (fstat(deliver_datafile, &statbuf) == 0)
1985 start_offset = statbuf.st_size - len;
1986 if (start_offset < SPOOL_DATA_START_OFFSET)
1987 start_offset = SPOOL_DATA_START_OFFSET;
1990 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1991 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1993 if ((len = read(deliver_datafile, body, len)) > 0)
1996 if (message_body_newlines) /* Separate loops for efficiency */
1998 { if (body[--len] == 0) body[len] = ' '; }
2001 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
2004 return *ss ? *ss : US"";
2006 case vtype_todbsdin: /* BSD inbox time of day */
2007 return tod_stamp(tod_bsdin);
2009 case vtype_tode: /* Unix epoch time of day */
2010 return tod_stamp(tod_epoch);
2012 case vtype_todel: /* Unix epoch/usec time of day */
2013 return tod_stamp(tod_epoch_l);
2015 case vtype_todf: /* Full time of day */
2016 return tod_stamp(tod_full);
2018 case vtype_todl: /* Log format time of day */
2019 return tod_stamp(tod_log_bare); /* (without timezone) */
2021 case vtype_todzone: /* Time zone offset only */
2022 return tod_stamp(tod_zone);
2024 case vtype_todzulu: /* Zulu time */
2025 return tod_stamp(tod_zulu);
2027 case vtype_todlf: /* Log file datestamp tod */
2028 return tod_stamp(tod_log_datestamp_daily);
2030 case vtype_reply: /* Get reply address */
2031 s = find_header(US"reply-to:", newsize,
2032 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2034 if (s) Uskip_whitespace(&s);
2037 *newsize = 0; /* For the *s==0 case */
2038 s = find_header(US"from:", newsize,
2039 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2045 Uskip_whitespace(&s);
2046 for (t = s; *t; t++) if (*t == '\n') *t = ' ';
2047 while (t > s && isspace(t[-1])) t--;
2050 return s ? s : US"";
2052 case vtype_string_func:
2054 stringptr_fn_t * fn = (stringptr_fn_t *) val;
2056 return s ? s : US"";
2062 sprintf(CS var_buffer, PR_EXIM_ARITH,
2063 receive_statvfs(val == (void *)TRUE, &inodes));
2070 (void) receive_statvfs(val == (void *)TRUE, &inodes);
2071 sprintf(CS var_buffer, "%d", inodes);
2076 return *(void **)val ? US"<cert>" : US"";
2078 #ifndef DISABLE_DKIM
2080 return dkim_exim_expand_query((int)(long)val);
2085 return NULL; /* Unknown variable. Silences static checkers. */
2092 modify_variable(uschar *name, void * value)
2095 if ((vp = find_var_ent(name))) vp->value = value;
2096 return; /* Unknown variable name, fail silently */
2104 /*************************************************
2105 * Read and expand substrings *
2106 *************************************************/
2108 /* This function is called to read and expand argument substrings for various
2109 expansion items. Some have a minimum requirement that is less than the maximum;
2110 in these cases, the first non-present one is set to NULL.
2113 sub points to vector of pointers to set
2114 n maximum number of substrings
2116 sptr points to current string pointer
2117 skipping the skipping flag
2118 check_end if TRUE, check for final '}'
2119 name name of item, for error message
2120 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2123 Returns: 0 OK; string pointer updated
2124 1 curly bracketing error (too few arguments)
2125 2 too many arguments (only if check_end is set); message set
2126 3 other error (expansion failure)
2130 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
2131 BOOL check_end, uschar *name, BOOL *resetok)
2133 const uschar *s = *sptr;
2135 Uskip_whitespace(&s);
2136 for (int i = 0; i < n; i++)
2142 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2143 "(min is %d)", name, m);
2149 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2151 if (*s++ != '}') return 1;
2152 Uskip_whitespace(&s);
2154 if (check_end && *s++ != '}')
2158 expand_string_message = string_sprintf("Too many arguments for '%s' "
2159 "(max is %d)", name, n);
2162 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2173 /*************************************************
2174 * Elaborate message for bad variable *
2175 *************************************************/
2177 /* For the "unknown variable" message, take a look at the variable's name, and
2178 give additional information about possible ACL variables. The extra information
2179 is added on to expand_string_message.
2181 Argument: the name of the variable
2186 check_variable_error_message(uschar *name)
2188 if (Ustrncmp(name, "acl_", 4) == 0)
2189 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2190 (name[4] == 'c' || name[4] == 'm')?
2192 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2193 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2195 US"user-defined ACL variables must start acl_c or acl_m");
2201 Load args from sub array to globals, and call acl_check().
2202 Sub array will be corrupted on return.
2204 Returns: OK access is granted by an ACCEPT verb
2205 DISCARD access is (apparently) granted by a DISCARD verb
2206 FAIL access is denied
2207 FAIL_DROP access is denied; drop the connection
2208 DEFER can't tell at the moment
2212 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2215 int sav_narg = acl_narg;
2217 uschar * dummy_logmsg;
2218 extern int acl_where;
2220 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2221 for (i = 0; i < nsub && sub[i+1]; i++)
2223 uschar * tmp = acl_arg[i];
2224 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2225 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2230 sub[i+1] = acl_arg[i];
2231 acl_arg[i++] = NULL;
2235 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2237 acl_narg>0 ? acl_arg[0] : US"<none>",
2238 acl_narg>1 ? " +more" : "");
2240 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2242 for (i = 0; i < nsub; i++)
2243 acl_arg[i] = sub[i+1]; /* restore old args */
2244 acl_narg = sav_narg;
2252 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2253 The given string is modified on return. Leading whitespace is skipped while
2254 looking for the opening wrap character, then the rest is scanned for the trailing
2255 (non-escaped) wrap character. A backslash in the string will act as an escape.
2257 A nul is written over the trailing wrap, and a pointer to the char after the
2258 leading wrap is returned.
2261 s String for de-wrapping
2262 wrap Two-char string, the first being the opener, second the closer wrapping
2265 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2269 dewrap(uschar * s, const uschar * wrap)
2273 BOOL quotesmode = wrap[0] == wrap[1];
2275 if (Uskip_whitespace(&p) == *wrap)
2281 if (*p == '\\') p++;
2282 else if (!quotesmode && *p == wrap[-1]) depth++;
2283 else if (*p == *wrap)
2294 expand_string_message = string_sprintf("missing '%c'", *wrap);
2299 /* Pull off the leading array or object element, returning
2300 a copy in an allocated string. Update the list pointer.
2302 The element may itself be an abject or array.
2303 Return NULL when the list is empty.
2307 json_nextinlist(const uschar ** list)
2309 unsigned array_depth = 0, object_depth = 0;
2310 const uschar * s = *list, * item;
2312 skip_whitespace(&s);
2315 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2319 case '[': array_depth++; break;
2320 case ']': array_depth--; break;
2321 case '{': object_depth++; break;
2322 case '}': object_depth--; break;
2324 *list = *s ? s+1 : s;
2325 if (item == s) return NULL;
2326 item = string_copyn(item, s - item);
2327 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2333 /************************************************/
2334 /* Return offset in ops table, or -1 if not found.
2335 Repoint to just after the operator in the string.
2338 ss string representation of operator
2339 opname split-out operator name
2343 identify_operator(const uschar ** ss, uschar ** opname)
2345 const uschar * s = *ss;
2348 /* Numeric comparisons are symbolic */
2350 if (*s == '=' || *s == '>' || *s == '<')
2362 /* All other conditions are named */
2365 s = read_name(name, sizeof(name), s, US"_");
2368 /* If we haven't read a name, it means some non-alpha character is first. */
2372 expand_string_message = string_sprintf("condition name expected, "
2373 "but found \"%.16s\"", s);
2377 *opname = string_copy(name);
2379 return chop_match(name, cond_table, nelem(cond_table));
2383 /*************************************************
2384 * Handle MD5 or SHA-1 computation for HMAC *
2385 *************************************************/
2387 /* These are some wrapping functions that enable the HMAC code to be a bit
2388 cleaner. A good compiler will spot the tail recursion.
2391 type HMAC_MD5 or HMAC_SHA1
2392 remaining are as for the cryptographic hash functions
2398 chash_start(int type, void * base)
2400 if (type == HMAC_MD5)
2401 md5_start((md5 *)base);
2403 sha1_start((hctx *)base);
2407 chash_mid(int type, void * base, const uschar * string)
2409 if (type == HMAC_MD5)
2410 md5_mid((md5 *)base, string);
2412 sha1_mid((hctx *)base, string);
2416 chash_end(int type, void * base, const uschar * string, int length,
2419 if (type == HMAC_MD5)
2420 md5_end((md5 *)base, string, length, digest);
2422 sha1_end((hctx *)base, string, length, digest);
2429 /* Do an hmac_md5. The result is _not_ nul-terminated, and is sized as
2430 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2433 key encoding key, nul-terminated
2434 src data to be hashed, nul-terminated
2436 len size of output buffer
2440 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2443 const uschar * keyptr;
2445 unsigned int keylen;
2447 #define MD5_HASHLEN 16
2448 #define MD5_HASHBLOCKLEN 64
2450 uschar keyhash[MD5_HASHLEN];
2451 uschar innerhash[MD5_HASHLEN];
2452 uschar finalhash[MD5_HASHLEN];
2453 uschar innerkey[MD5_HASHBLOCKLEN];
2454 uschar outerkey[MD5_HASHBLOCKLEN];
2457 keylen = Ustrlen(keyptr);
2459 /* If the key is longer than the hash block length, then hash the key
2462 if (keylen > MD5_HASHBLOCKLEN)
2464 chash_start(HMAC_MD5, &md5_base);
2465 chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2467 keylen = MD5_HASHLEN;
2470 /* Now make the inner and outer key values */
2472 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2473 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2475 for (int i = 0; i < keylen; i++)
2477 innerkey[i] ^= keyptr[i];
2478 outerkey[i] ^= keyptr[i];
2481 /* Now do the hashes */
2483 chash_start(HMAC_MD5, &md5_base);
2484 chash_mid(HMAC_MD5, &md5_base, innerkey);
2485 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2487 chash_start(HMAC_MD5, &md5_base);
2488 chash_mid(HMAC_MD5, &md5_base, outerkey);
2489 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2491 /* Encode the final hash as a hex string, limited by output buffer size */
2494 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2496 if (j-- <= 0) break;
2497 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2498 if (j-- <= 0) break;
2499 *p++ = hex_digits[finalhash[i] & 0x0f];
2503 #endif /*SUPPORT_SRS*/
2506 /*************************************************
2507 * Read and evaluate a condition *
2508 *************************************************/
2512 s points to the start of the condition text
2513 resetok points to a BOOL which is written false if it is unsafe to
2514 free memory. Certain condition types (acl) may have side-effect
2515 allocation which must be preserved.
2516 yield points to a BOOL to hold the result of the condition test;
2517 if NULL, we are just reading through a condition that is
2518 part of an "or" combination to check syntax, or in a state
2519 where the answer isn't required
2521 Returns: a pointer to the first character after the condition, or
2525 static const uschar *
2526 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2528 BOOL testfor = TRUE;
2529 BOOL tempcond, combined_cond;
2531 BOOL sub2_honour_dollar = TRUE;
2532 BOOL is_forany, is_json, is_jsons;
2534 int_eximarith_t num[2];
2535 struct stat statbuf;
2538 const uschar *sub[10];
2541 if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;
2543 switch(cond_type = identify_operator(&s, &opname))
2545 /* def: tests for a non-empty variable, or for the existence of a header. If
2546 yield == NULL we are in a skipping state, and don't care about the answer. */
2554 expand_string_message = US"\":\" expected after \"def\"";
2558 s = read_name(name, sizeof(name), s+1, US"_");
2560 /* Test for a header's existence. If the name contains a closing brace
2561 character, this may be a user error where the terminating colon has been
2562 omitted. Set a flag to adjust a subsequent error message in this case. */
2564 if ( ( *(t = name) == 'h'
2565 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2567 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2570 s = read_header_name(name, sizeof(name), s);
2571 /* {-for-text-editors */
2572 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2574 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2577 /* Test for a variable's having a non-empty value. A non-existent variable
2578 causes an expansion failure. */
2582 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2584 expand_string_message = name[0]
2585 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2586 : US"variable name omitted after \"def:\"";
2587 check_variable_error_message(name);
2590 if (yield) *yield = (t[0] != 0) == testfor;
2597 /* first_delivery tests for first delivery attempt */
2599 case ECOND_FIRST_DELIVERY:
2600 if (yield) *yield = f.deliver_firsttime == testfor;
2604 /* queue_running tests for any process started by a queue runner */
2606 case ECOND_QUEUE_RUNNING:
2607 if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2611 /* exists: tests for file existence
2612 isip: tests for any IP address
2613 isip4: tests for an IPv4 address
2614 isip6: tests for an IPv6 address
2615 pam: does PAM authentication
2616 radius: does RADIUS authentication
2617 ldapauth: does LDAP authentication
2618 pwcheck: does Cyrus SASL pwcheck authentication
2627 case ECOND_LDAPAUTH:
2630 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2632 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2633 if (!sub[0]) return NULL;
2634 /* {-for-text-editors */
2635 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2637 if (!yield) return s; /* No need to run the test if skipping */
2642 if ((expand_forbid & RDO_EXISTS) != 0)
2644 expand_string_message = US"File existence tests are not permitted";
2647 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2653 rc = string_is_ip_address(sub[0], NULL);
2654 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2655 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2658 /* Various authentication tests - all optionally compiled */
2662 rc = auth_call_pam(sub[0], &expand_string_message);
2665 goto COND_FAILED_NOT_COMPILED;
2666 #endif /* SUPPORT_PAM */
2669 #ifdef RADIUS_CONFIG_FILE
2670 rc = auth_call_radius(sub[0], &expand_string_message);
2673 goto COND_FAILED_NOT_COMPILED;
2674 #endif /* RADIUS_CONFIG_FILE */
2676 case ECOND_LDAPAUTH:
2679 /* Just to keep the interface the same */
2681 int old_pool = store_pool;
2682 store_pool = POOL_SEARCH;
2683 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2684 &expand_string_message, &do_cache);
2685 store_pool = old_pool;
2689 goto COND_FAILED_NOT_COMPILED;
2690 #endif /* LOOKUP_LDAP */
2693 #ifdef CYRUS_PWCHECK_SOCKET
2694 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2697 goto COND_FAILED_NOT_COMPILED;
2698 #endif /* CYRUS_PWCHECK_SOCKET */
2700 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2701 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2703 if (rc == ERROR || rc == DEFER) return NULL;
2704 *yield = (rc == OK) == testfor;
2710 /* call ACL (in a conditional context). Accept true, deny false.
2711 Defer is a forced-fail. Anything set by message= goes to $value.
2712 Up to ten parameters are used; we use the braces round the name+args
2713 like the saslauthd condition does, to permit a variable number of args.
2714 See also the expansion-item version EITEM_ACL and the traditional
2715 acl modifier ACLC_ACL.
2716 Since the ACL may allocate new global variables, tell our caller to not
2721 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2727 Uskip_whitespace(&s);
2728 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2730 switch(read_subs(sub, nelem(sub), 1,
2731 &s, yield == NULL, TRUE, name, resetok))
2733 case 1: expand_string_message = US"too few arguments or bracketing "
2736 case 3: return NULL;
2742 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2743 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2748 lookup_value = NULL;
2750 lookup_value = string_copy(user_msg);
2751 *yield = cond == testfor;
2755 f.expand_string_forcedfail = TRUE;
2758 expand_string_message = string_sprintf("%s from acl \"%s\"",
2759 rc_names[rc], sub[0]);
2767 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2769 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2771 However, the last two are optional. That is why the whole set is enclosed
2772 in their own set of braces. */
2774 case ECOND_SASLAUTHD:
2775 #ifndef CYRUS_SASLAUTHD_SOCKET
2776 goto COND_FAILED_NOT_COMPILED;
2780 Uskip_whitespace(&s);
2781 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2782 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, name,
2785 case 1: expand_string_message = US"too few arguments or bracketing "
2786 "error for saslauthd";
2788 case 3: return NULL;
2790 if (!sub[2]) sub[3] = NULL; /* realm if no service */
2793 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2794 &expand_string_message);
2795 if (rc == ERROR || rc == DEFER) return NULL;
2796 *yield = (rc == OK) == testfor;
2800 #endif /* CYRUS_SASLAUTHD_SOCKET */
2803 /* symbolic operators for numeric and string comparison, and a number of
2804 other operators, all requiring two arguments.
2806 crypteq: encrypts plaintext and compares against an encrypted text,
2807 using crypt(), crypt16(), MD5 or SHA-1
2808 inlist/inlisti: checks if first argument is in the list of the second
2809 match: does a regular expression match and sets up the numerical
2810 variables if it succeeds
2811 match_address: matches in an address list
2812 match_domain: matches in a domain list
2813 match_ip: matches a host list that is restricted to IP addresses
2814 match_local_part: matches in a local part list
2817 case ECOND_MATCH_ADDRESS:
2818 case ECOND_MATCH_DOMAIN:
2819 case ECOND_MATCH_IP:
2820 case ECOND_MATCH_LOCAL_PART:
2821 #ifndef EXPAND_LISTMATCH_RHS
2822 sub2_honour_dollar = FALSE;
2831 case ECOND_NUM_L: /* Numerical comparisons */
2838 case ECOND_STR_LT: /* String comparisons */
2849 for (int i = 0; i < 2; i++)
2851 /* Sometimes, we don't expand substrings; too many insecure configurations
2852 created using match_address{}{} and friends, where the second param
2853 includes information from untrustworthy sources. */
2854 BOOL honour_dollar = TRUE;
2855 if ((i > 0) && !sub2_honour_dollar)
2856 honour_dollar = FALSE;
2858 if (Uskip_whitespace(&s) != '{')
2860 if (i == 0) goto COND_FAILED_CURLY_START;
2861 expand_string_message = string_sprintf("missing 2nd string in {} "
2862 "after \"%s\"", opname);
2865 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2866 honour_dollar, resetok)))
2868 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2869 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2870 " for security reasons\n");
2871 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2873 /* Convert to numerical if required; we know that the names of all the
2874 conditions that compare numbers do not start with a letter. This just saves
2875 checking for them individually. */
2877 if (!isalpha(opname[0]) && yield)
2882 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2886 num[i] = expanded_string_integer(sub[i], FALSE);
2887 if (expand_string_message) return NULL;
2891 /* Result not required */
2893 if (!yield) return s;
2895 /* Do an appropriate comparison */
2901 tempcond = (num[0] == num[1]);
2905 tempcond = (num[0] > num[1]);
2909 tempcond = (num[0] >= num[1]);
2913 tempcond = (num[0] < num[1]);
2917 tempcond = (num[0] <= num[1]);
2921 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2925 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2929 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2933 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2937 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2941 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2945 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2949 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2953 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2957 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2960 case ECOND_MATCH: /* Regular expression match */
2962 const pcre2_code * re;
2966 if (!(re = pcre2_compile((PCRE2_SPTR)sub[1], PCRE2_ZERO_TERMINATED,
2967 PCRE_COPT, &err, &offset, pcre_cmp_ctx)))
2970 pcre2_get_error_message(err, errbuf, sizeof(errbuf));
2971 expand_string_message = string_sprintf("regular expression error in "
2972 "\"%s\": %s at offset %ld", sub[1], errbuf, (long)offset);
2976 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2980 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2981 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2982 goto MATCHED_SOMETHING;
2984 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2985 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2986 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2987 goto MATCHED_SOMETHING;
2989 case ECOND_MATCH_IP: /* Match IP address in a host list */
2990 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2992 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2998 unsigned int *nullcache = NULL;
2999 check_host_block cb;
3001 cb.host_name = US"";
3002 cb.host_address = sub[0];
3004 /* If the host address starts off ::ffff: it is an IPv6 address in
3005 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3008 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3009 cb.host_address + 7 : cb.host_address;
3011 rc = match_check_list(
3012 &sub[1], /* the list */
3013 0, /* separator character */
3014 &hostlist_anchor, /* anchor pointer */
3015 &nullcache, /* cache pointer */
3016 check_host, /* function for testing */
3017 &cb, /* argument for function */
3018 MCL_HOST, /* type of check */
3019 sub[0], /* text for debugging */
3020 NULL); /* where to pass back data */
3022 goto MATCHED_SOMETHING;
3024 case ECOND_MATCH_LOCAL_PART:
3025 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3026 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
3041 expand_string_message = string_sprintf("unable to complete match "
3042 "against \"%s\": %s", sub[1], search_error_message);
3048 /* Various "encrypted" comparisons. If the second string starts with
3049 "{" then an encryption type is given. Default to crypt() or crypt16()
3050 (build-time choice). */
3051 /* }-for-text-editors */
3054 #ifndef SUPPORT_CRYPTEQ
3055 goto COND_FAILED_NOT_COMPILED;
3057 if (strncmpic(sub[1], US"{md5}", 5) == 0)
3059 int sublen = Ustrlen(sub[1]+5);
3064 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3066 /* If the length that we are comparing against is 24, the MD5 digest
3067 is expressed as a base64 string. This is the way LDAP does it. However,
3068 some other software uses a straightforward hex representation. We assume
3069 this if the length is 32. Other lengths fail. */
3073 uschar *coded = b64encode(CUS digest, 16);
3074 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3075 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3076 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3078 else if (sublen == 32)
3081 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3083 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3084 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3085 tempcond = (strcmpic(coded, sub[1]+5) == 0);
3089 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3090 "fail\n crypted=%s\n", sub[1]+5);
3095 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3097 int sublen = Ustrlen(sub[1]+6);
3102 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3104 /* If the length that we are comparing against is 28, assume the SHA1
3105 digest is expressed as a base64 string. If the length is 40, assume a
3106 straightforward hex representation. Other lengths fail. */
3110 uschar *coded = b64encode(CUS digest, 20);
3111 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3112 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3113 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3115 else if (sublen == 40)
3118 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3120 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3121 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3122 tempcond = (strcmpic(coded, sub[1]+6) == 0);
3126 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3127 "fail\n crypted=%s\n", sub[1]+6);
3132 else /* {crypt} or {crypt16} and non-{ at start */
3133 /* }-for-text-editors */
3138 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3143 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3148 else if (sub[1][0] == '{') /* }-for-text-editors */
3150 expand_string_message = string_sprintf("unknown encryption mechanism "
3151 "in \"%s\"", sub[1]);
3157 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3158 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
3159 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3163 #define XSTR(s) STR(s)
3164 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3165 " subject=%s\n crypted=%s\n",
3166 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3171 /* If the encrypted string contains fewer than two characters (for the
3172 salt), force failure. Otherwise we get false positives: with an empty
3173 string the yield of crypt() is an empty string! */
3176 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3177 else if (errno == EINVAL)
3181 expand_string_message = string_sprintf("crypt error: %s\n",
3182 US strerror(errno));
3187 #endif /* SUPPORT_CRYPTEQ */
3192 const uschar * list = sub[1];
3194 uschar *save_iterate_item = iterate_item;
3195 int (*compare)(const uschar *, const uschar *);
3197 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);
3200 compare = cond_type == ECOND_INLISTI
3201 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3203 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3205 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3206 if (compare(sub[0], iterate_item) == 0)
3212 iterate_item = save_iterate_item;
3215 } /* Switch for comparison conditions */
3217 *yield = tempcond == testfor;
3218 return s; /* End of comparison conditions */
3221 /* and/or: computes logical and/or of several conditions */
3225 subcondptr = (yield == NULL) ? NULL : &tempcond;
3226 combined_cond = (cond_type == ECOND_AND);
3228 Uskip_whitespace(&s);
3229 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3233 /* {-for-text-editors */
3234 if (Uskip_whitespace(&s) == '}') break;
3235 if (*s != '{') /* }-for-text-editors */
3237 expand_string_message = string_sprintf("each subcondition "
3238 "inside an \"%s{...}\" condition must be in its own {}", opname);
3242 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3244 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3245 expand_string_message, opname);
3248 Uskip_whitespace(&s);
3250 /* {-for-text-editors */
3253 /* {-for-text-editors */
3254 expand_string_message = string_sprintf("missing } at end of condition "
3255 "inside \"%s\" group", opname);
3260 if (cond_type == ECOND_AND)
3262 combined_cond &= tempcond;
3263 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3264 } /* evaluate any more */
3267 combined_cond |= tempcond;
3268 if (combined_cond) subcondptr = NULL; /* once true, don't */
3269 } /* evaluate any more */
3272 if (yield) *yield = (combined_cond == testfor);
3276 /* forall/forany: iterates a condition with different values */
3278 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3279 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3280 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3281 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3282 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3283 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3287 const uschar * list;
3289 uschar *save_iterate_item = iterate_item;
3291 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3293 Uskip_whitespace(&s);
3294 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3295 if (!(sub[0] = expand_string_internal(s, TRUE, &s, yield == NULL, TRUE, resetok)))
3297 /* {-for-text-editors */
3298 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3300 Uskip_whitespace(&s);
3301 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3305 /* Call eval_condition once, with result discarded (as if scanning a
3306 "false" part). This allows us to find the end of the condition, because if
3307 the list it empty, we won't actually evaluate the condition for real. */
3309 if (!(s = eval_condition(sub[1], resetok, NULL)))
3311 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3312 expand_string_message, opname);
3315 Uskip_whitespace(&s);
3317 /* {-for-text-editors */
3320 /* {-for-text-editors */
3321 expand_string_message = string_sprintf("missing } at end of condition "
3322 "inside \"%s\"", opname);
3326 if (yield) *yield = !testfor;
3328 if (is_json) list = dewrap(string_copy(list), US"[]");
3329 while ((iterate_item = is_json
3330 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3333 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3335 expand_string_message =
3336 string_sprintf("%s wrapping string result for extract jsons",
3337 expand_string_message);
3338 iterate_item = save_iterate_item;
3342 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3343 if (!eval_condition(sub[1], resetok, &tempcond))
3345 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3346 expand_string_message, opname);
3347 iterate_item = save_iterate_item;
3350 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3351 tempcond? "true":"false");
3353 if (yield) *yield = (tempcond == testfor);
3354 if (tempcond == is_forany) break;
3357 iterate_item = save_iterate_item;
3362 /* The bool{} expansion condition maps a string to boolean.
3363 The values supported should match those supported by the ACL condition
3364 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3365 of true/false. Note that Router "condition" rules have a different
3366 interpretation, where general data can be used and only a few values
3368 Note that readconf.c boolean matching, for boolean configuration options,
3369 only matches true/yes/false/no.
3370 The bool_lax{} condition matches the Router logic, which is much more
3373 case ECOND_BOOL_LAX:
3379 BOOL boolvalue = FALSE;
3381 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3382 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3383 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3385 case 1: expand_string_message = string_sprintf(
3386 "too few arguments or bracketing error for %s",
3390 case 3: return NULL;
3393 Uskip_whitespace(&t);
3394 if ((len = Ustrlen(t)))
3396 /* trailing whitespace: seems like a good idea to ignore it too */
3398 while (isspace(*t2)) t2--;
3399 if (t2 != (t + len))
3406 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3407 /* logic for the lax case from expand_check_condition(), which also does
3408 expands, and the logic is both short and stable enough that there should
3409 be no maintenance burden from replicating it. */
3413 ? Ustrspn(t+1, "0123456789") == len-1
3414 : Ustrspn(t, "0123456789") == len)
3416 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3417 /* expand_check_condition only does a literal string "0" check */
3418 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3421 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3423 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3425 else if (cond_type == ECOND_BOOL_LAX)
3429 expand_string_message = string_sprintf("unrecognised boolean "
3433 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3434 boolvalue? "true":"false");
3435 if (yield) *yield = (boolvalue == testfor);
3440 case ECOND_INBOUND_SRS:
3441 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */
3444 const pcre2_code * re;
3445 pcre2_match_data * md;
3449 BOOL boolvalue = FALSE;
3451 switch(read_subs(sub, 2, 2, CUSS &s, yield == NULL, FALSE, name, resetok))
3453 case 1: expand_string_message = US"too few arguments or bracketing "
3454 "error for inbound_srs";
3456 case 3: return NULL;
3459 /* Match the given local_part against the SRS-encoded pattern */
3461 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]+)=([^=]*)=(.*)$",
3463 md = pcre2_match_data_create(4+1, pcre_gen_ctx);
3464 if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,
3465 md, pcre_mtc_ctx) < 0)
3467 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3470 ovec = pcre2_get_ovector_pointer(md);
3472 if (sub[0][0] == '"')
3474 else for (uschar * s = sub[0]; *s; s++)
3475 if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3476 { quoting = 1; break; }
3478 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3480 /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3482 srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S", /* lowercased */
3484 (int) (ovec[9]-ovec[8]), sub[0] + ovec[8], /* substr 4 */
3486 (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */
3488 /* If a zero-length secret was given, we're done. Otherwise carry on
3489 and validate the given SRS local_part againt our secret. */
3497 /* check the timestamp */
3500 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3504 gettimeofday(&now, NULL);
3505 now.tv_sec /= 86400; /* days since epoch */
3507 /* Decode substring 2 from base32 to a number */
3509 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3511 uschar * t = Ustrchr(base32_chars, *ss++);
3512 d = d * 32 + (t - base32_chars);
3515 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3517 DEBUG(D_expand) debug_printf("SRS too old\n");
3522 /* check length of substring 1, the offered checksum */
3524 if (ovec[3]-ovec[2] != 4)
3526 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3530 /* Hash the address with our secret, and compare that computed checksum
3531 with the one extracted from the arg */
3533 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3534 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3536 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3542 if (yield) *yield = (boolvalue == testfor);
3545 #endif /*SUPPORT_SRS*/
3547 /* Unknown condition */
3550 if (!expand_string_message || !*expand_string_message)
3551 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3553 } /* End switch on condition type */
3555 /* Missing braces at start and end of data */
3557 COND_FAILED_CURLY_START:
3558 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3561 COND_FAILED_CURLY_END:
3562 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3566 /* A condition requires code that is not compiled */
3568 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3569 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3570 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3571 COND_FAILED_NOT_COMPILED:
3572 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3581 /*************************************************
3582 * Save numerical variables *
3583 *************************************************/
3585 /* This function is called from items such as "if" that want to preserve and
3586 restore the numbered variables.
3589 save_expand_string points to an array of pointers to set
3590 save_expand_nlength points to an array of ints for the lengths
3592 Returns: the value of expand max to save
3596 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3598 for (int i = 0; i <= expand_nmax; i++)
3600 save_expand_nstring[i] = expand_nstring[i];
3601 save_expand_nlength[i] = expand_nlength[i];
3608 /*************************************************
3609 * Restore numerical variables *
3610 *************************************************/
3612 /* This function restored saved values of numerical strings.
3615 save_expand_nmax the number of strings to restore
3616 save_expand_string points to an array of pointers
3617 save_expand_nlength points to an array of ints
3623 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3624 int *save_expand_nlength)
3626 expand_nmax = save_expand_nmax;
3627 for (int i = 0; i <= expand_nmax; i++)
3629 expand_nstring[i] = save_expand_nstring[i];
3630 expand_nlength[i] = save_expand_nlength[i];
3638 /*************************************************
3639 * Handle yes/no substrings *
3640 *************************************************/
3642 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3643 alternative substrings that depend on whether or not the condition was true,
3644 or the lookup or extraction succeeded. The substrings always have to be
3645 expanded, to check their syntax, but "skipping" is set when the result is not
3646 needed - this avoids unnecessary nested lookups.
3649 skipping TRUE if we were skipping when this item was reached
3650 yes TRUE if the first string is to be used, else use the second
3651 save_lookup a value to put back into lookup_value before the 2nd expansion
3652 sptr points to the input string pointer
3653 yieldptr points to the output growable-string pointer
3654 type "lookup", "if", "extract", "run", "env", "listextract" or
3655 "certextract" for error message
3656 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3659 Returns: 0 OK; lookup_value has been reset to save_lookup
3661 2 expansion failed because of bracketing error
3665 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3666 gstring ** yieldptr, uschar *type, BOOL *resetok)
3669 const uschar *s = *sptr; /* Local value */
3670 uschar *sub1, *sub2;
3671 const uschar * errwhere;
3673 /* If there are no following strings, we substitute the contents of $value for
3674 lookups and for extractions in the success case. For the ${if item, the string
3675 "true" is substituted. In the fail case, nothing is substituted for all three
3678 if (skip_whitespace(&s) == '}')
3682 if (yes && !skipping)
3683 *yieldptr = string_catn(*yieldptr, US"true", 4);
3687 if (yes && lookup_value && !skipping)
3688 *yieldptr = string_cat(*yieldptr, lookup_value);
3689 lookup_value = save_lookup;
3695 /* The first following string must be braced. */
3699 errwhere = US"'yes' part did not start with '{'";
3703 /* Expand the first substring. Forced failures are noticed only if we actually
3704 want this string. Set skipping in the call in the fail case (this will always
3705 be the case if we were already skipping). */
3707 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3708 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3709 f.expand_string_forcedfail = FALSE;
3712 errwhere = US"'yes' part did not end with '}'";
3716 /* If we want the first string, add it to the output */
3719 *yieldptr = string_cat(*yieldptr, sub1);
3721 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3722 $value to what it was at the start of the item, so that it has this value
3723 during the second string expansion. For the call from "if" or "run" to this
3724 function, save_lookup is set to lookup_value, so that this statement does
3727 lookup_value = save_lookup;
3729 /* There now follows either another substring, or "fail", or nothing. This
3730 time, forced failures are noticed only if we want the second string. We must
3731 set skipping in the nested call if we don't want this string, or if we were
3732 already skipping. */
3734 if (skip_whitespace(&s) == '{')
3736 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3737 if (sub2 == NULL && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3738 f.expand_string_forcedfail = FALSE;
3741 errwhere = US"'no' part did not start with '{'";
3745 /* If we want the second string, add it to the output */
3748 *yieldptr = string_cat(*yieldptr, sub2);
3751 /* If there is no second string, but the word "fail" is present when the use of
3752 the second string is wanted, set a flag indicating it was a forced failure
3753 rather than a syntactic error. Swallow the terminating } in case this is nested
3754 inside another lookup or if or extract. */
3759 /* deconst cast ok here as source is s anyway */
3760 s = US read_name(name, sizeof(name), s, US"_");
3761 if (Ustrcmp(name, "fail") == 0)
3763 if (!yes && !skipping)
3765 Uskip_whitespace(&s);
3768 errwhere = US"did not close with '}' after forcedfail";
3771 expand_string_message =
3772 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3773 f.expand_string_forcedfail = TRUE;
3779 expand_string_message =
3780 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3785 /* All we have to do now is to check on the final closing brace. */
3787 skip_whitespace(&s);
3790 errwhere = US"did not close with '}'";
3796 /* Update the input pointer value before returning */
3801 /* Get here if there is a bracketing failure */
3802 expand_string_message = string_sprintf(
3803 "curly-bracket problem in conditional yes/no parsing: %s\n"
3804 " remaining string is '%s'", errwhere, --s);
3809 /* Get here for other failures */
3817 /********************************************************
3818 * prvs: Get last three digits of days since Jan 1, 1970 *
3819 ********************************************************/
3821 /* This is needed to implement the "prvs" BATV reverse
3824 Argument: integer "days" offset to add or substract to
3825 or from the current number of days.
3827 Returns: pointer to string containing the last three
3828 digits of the number of days since Jan 1, 1970,
3829 modified by the offset argument, NULL if there
3830 was an error in the conversion.
3835 prvs_daystamp(int day_offset)
3837 uschar *days = store_get(32, FALSE); /* Need at least 24 for cases */
3838 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3839 (time(NULL) + day_offset*86400)/86400);
3840 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3845 /********************************************************
3846 * prvs: perform HMAC-SHA1 computation of prvs bits *
3847 ********************************************************/
3849 /* This is needed to implement the "prvs" BATV reverse
3853 address RFC2821 Address to use
3854 key The key to use (must be less than 64 characters
3856 key_num Single-digit key number to use. Defaults to
3859 Returns: pointer to string containing the first three
3860 bytes of the final hash in hex format, NULL if
3861 there was an error in the process.
3865 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3867 gstring * hash_source;
3870 uschar innerhash[20];
3871 uschar finalhash[20];
3872 uschar innerkey[64];
3873 uschar outerkey[64];
3874 uschar *finalhash_hex;
3879 if (Ustrlen(key) > 64)
3882 hash_source = string_catn(NULL, key_num, 1);
3883 hash_source = string_catn(hash_source, daystamp, 3);
3884 hash_source = string_cat(hash_source, address);
3885 (void) string_from_gstring(hash_source);
3888 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3890 memset(innerkey, 0x36, 64);
3891 memset(outerkey, 0x5c, 64);
3893 for (int i = 0; i < Ustrlen(key); i++)
3895 innerkey[i] ^= key[i];
3896 outerkey[i] ^= key[i];
3899 chash_start(HMAC_SHA1, &h);
3900 chash_mid(HMAC_SHA1, &h, innerkey);
3901 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3903 chash_start(HMAC_SHA1, &h);
3904 chash_mid(HMAC_SHA1, &h, outerkey);
3905 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3907 /* Hashing is deemed sufficient to de-taint any input data */
3909 p = finalhash_hex = store_get(40, FALSE);
3910 for (int i = 0; i < 3; i++)
3912 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3913 *p++ = hex_digits[finalhash[i] & 0x0f];
3917 return finalhash_hex;
3923 /*************************************************
3924 * Join a file onto the output string *
3925 *************************************************/
3927 /* This is used for readfile/readsock and after a run expansion.
3928 It joins the contents of a file onto the output string, globally replacing
3929 newlines with a given string (optionally).
3933 yield pointer to the expandable string struct
3934 eol newline replacement string, or NULL
3936 Returns: new pointer for expandable string, terminated if non-null
3940 cat_file(FILE *f, gstring *yield, uschar *eol)
3942 uschar buffer[1024];
3944 while (Ufgets(buffer, sizeof(buffer), f))
3946 int len = Ustrlen(buffer);
3947 if (eol && buffer[len-1] == '\n') len--;
3948 yield = string_catn(yield, buffer, len);
3949 if (eol && buffer[len])
3950 yield = string_cat(yield, eol);
3953 (void) string_from_gstring(yield);
3960 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
3963 uschar buffer[1024];
3965 /*XXX could we read direct into a pre-grown string? */
3967 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
3968 for (uschar * s = buffer; rc--; s++)
3969 yield = eol && *s == '\n'
3970 ? string_cat(yield, eol) : string_catn(yield, s, 1);
3972 /* We assume that all errors, and any returns of zero bytes,
3973 are actually EOF. */
3975 (void) string_from_gstring(yield);
3981 /*************************************************
3982 * Evaluate numeric expression *
3983 *************************************************/
3985 /* This is a set of mutually recursive functions that evaluate an arithmetic
3986 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3987 these functions that is called from elsewhere is eval_expr, whose interface is:
3990 sptr pointer to the pointer to the string - gets updated
3991 decimal TRUE if numbers are to be assumed decimal
3992 error pointer to where to put an error message - must be NULL on input
3993 endket TRUE if ')' must terminate - FALSE for external call
3995 Returns: on success: the value of the expression, with *error still NULL
3996 on failure: an undefined value, with *error = a message
3999 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4002 static int_eximarith_t
4003 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4006 int_eximarith_t x = eval_op_or(&s, decimal, error);
4011 *error = US"expecting closing parenthesis";
4013 while (isspace(*++s));
4015 *error = US"expecting operator";
4021 static int_eximarith_t
4022 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4028 if (isdigit((c = Uskip_whitespace(&s))))
4031 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4033 switch (tolower(*s))
4036 case 'k': n *= 1024; s++; break;
4037 case 'm': n *= 1024*1024; s++; break;
4038 case 'g': n *= 1024*1024*1024; s++; break;
4040 Uskip_whitespace(&s);
4045 n = eval_expr(&s, decimal, error, 1);
4049 *error = US"expecting number or opening parenthesis";
4057 static int_eximarith_t
4058 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4062 Uskip_whitespace(&s);
4063 if (*s == '+' || *s == '-' || *s == '~')
4066 x = eval_op_unary(&s, decimal, error);
4067 if (op == '-') x = -x;
4068 else if (op == '~') x = ~x;
4071 x = eval_number(&s, decimal, error);
4078 static int_eximarith_t
4079 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4082 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4085 while (*s == '*' || *s == '/' || *s == '%')
4088 int_eximarith_t y = eval_op_unary(&s, decimal, error);
4090 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4091 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4092 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4093 * -N*M is INT_MIN will yield INT_MIN.
4094 * Since we don't support floating point, this is somewhat simpler.
4095 * Ideally, we'd return an error, but since we overflow for all other
4096 * arithmetic, consistency suggests otherwise, but what's the correct value
4097 * to use? There is none.
4098 * The C standard guarantees overflow for unsigned arithmetic but signed
4099 * overflow invokes undefined behaviour; in practice, this is overflow
4100 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4101 * that long/longlong larger than int are available, or we could just work
4102 * with larger types. We should consider whether to guarantee 32bit eval
4103 * and 64-bit working variables, with errors returned. For now ...
4104 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4105 * can just let the other invalid results occur otherwise, as they have
4106 * until now. For this one case, we can coerce.
4108 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4111 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4112 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4122 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4138 static int_eximarith_t
4139 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4142 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4145 while (*s == '+' || *s == '-')
4148 int_eximarith_t y = eval_op_mult(&s, decimal, error);
4150 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4151 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4152 { /* over-conservative check */
4154 ? US"overflow in sum" : US"overflow in difference";
4157 if (op == '+') x += y; else x -= y;
4165 static int_eximarith_t
4166 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4169 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4172 while ((*s == '<' || *s == '>') && s[1] == s[0])
4177 y = eval_op_sum(&s, decimal, error);
4179 if (op == '<') x <<= y; else x >>= y;
4187 static int_eximarith_t
4188 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4191 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4198 y = eval_op_shift(&s, decimal, error);
4208 static int_eximarith_t
4209 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4212 int_eximarith_t x = eval_op_and(&s, decimal, error);
4219 y = eval_op_and(&s, decimal, error);
4229 static int_eximarith_t
4230 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4233 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4240 y = eval_op_xor(&s, decimal, error);
4251 /************************************************/
4252 /* Comparison operation for sort expansion. We need to avoid
4253 re-expanding the fields being compared, so need a custom routine.
4256 cond_type Comparison operator code
4257 leftarg, rightarg Arguments for comparison
4259 Return true iff (leftarg compare rightarg)
4263 sortsbefore(int cond_type, BOOL alpha_cond,
4264 const uschar * leftarg, const uschar * rightarg)
4266 int_eximarith_t l_num, r_num;
4270 l_num = expanded_string_integer(leftarg, FALSE);
4271 if (expand_string_message) return FALSE;
4272 r_num = expanded_string_integer(rightarg, FALSE);
4273 if (expand_string_message) return FALSE;
4277 case ECOND_NUM_G: return l_num > r_num;
4278 case ECOND_NUM_GE: return l_num >= r_num;
4279 case ECOND_NUM_L: return l_num < r_num;
4280 case ECOND_NUM_LE: return l_num <= r_num;
4287 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4288 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4289 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4290 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4291 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4292 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4293 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4294 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4297 return FALSE; /* should not happen */
4301 /* Expand a named list. Return false on failure. */
4303 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4305 tree_node *t = NULL;
4306 const uschar * list;
4309 BOOL needsep = FALSE;
4310 #define LISTNAMED_BUF_SIZE 256
4311 uschar b[LISTNAMED_BUF_SIZE];
4312 uschar * buffer = b;
4314 if (*name == '+') name++;
4315 if (!listtype) /* no-argument version */
4317 if ( !(t = tree_search(addresslist_anchor, name))
4318 && !(t = tree_search(domainlist_anchor, name))
4319 && !(t = tree_search(hostlist_anchor, name)))
4320 t = tree_search(localpartlist_anchor, name);
4322 else switch(*listtype) /* specific list-type version */
4324 case 'a': t = tree_search(addresslist_anchor, name); break;
4325 case 'd': t = tree_search(domainlist_anchor, name); break;
4326 case 'h': t = tree_search(hostlist_anchor, name); break;
4327 case 'l': t = tree_search(localpartlist_anchor, name); break;
4329 expand_string_message = US"bad suffix on \"list\" operator";
4335 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4337 : *listtype=='a'?"address "
4338 : *listtype=='d'?"domain "
4339 : *listtype=='h'?"host "
4340 : *listtype=='l'?"localpart "
4345 list = ((namedlist_block *)(t->data.ptr))->string;
4347 /* The list could be quite long so we (re)use a buffer for each element
4348 rather than getting each in new memory */
4350 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, TRUE);
4351 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4353 uschar * buf = US" : ";
4355 yield = string_catn(yield, buf, 3);
4359 if (*item == '+') /* list item is itself a named list */
4361 yield = expand_listnamed(yield, item, listtype);
4362 if (expand_string_message)
4366 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
4369 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4371 for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4373 yield = string_catn(yield, item, cp - CS item);
4374 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4375 yield = string_catn(yield, US"::", 2);
4376 else /* sep in item; should already be doubled; emit once */
4378 yield = string_catn(yield, US tok, 1);
4379 if (*cp == sep) cp++;
4382 yield = string_cat(yield, item);
4385 yield = string_cat(yield, item);
4392 /************************************************/
4394 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4398 debug_printf_indent("|");
4400 debug_printf_indent(UTF8_VERT_RIGHT);
4402 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4406 debug_printf(UTF8_HORIZ);
4408 debug_printf("%s: %.*s\n", what, nchar, value);
4409 if (is_tainted(value))
4412 debug_printf_indent("%s \\__", skipping ? "| " : " ");
4414 debug_printf_indent("%s",
4416 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
4417 debug_printf("(tainted)\n");
4422 /*************************************************
4424 *************************************************/
4426 /* Returns either an unchanged string, or the expanded string in stacking pool
4427 store. Interpreted sequences are:
4429 \... normal escaping rules
4430 $name substitutes the variable
4432 ${op:string} operates on the expanded string value
4433 ${item{arg1}{arg2}...} expands the args and then does the business
4434 some literal args are not enclosed in {}
4436 There are now far too many operators and item types to make it worth listing
4437 them here in detail any more.
4439 We use an internal routine recursively to handle embedded substrings. The
4440 external function follows. The yield is NULL if the expansion failed, and there
4441 are two cases: if something collapsed syntactically, or if "fail" was given
4442 as the action on a lookup failure. These can be distinguished by looking at the
4443 variable expand_string_forcedfail, which is TRUE in the latter case.
4445 The skipping flag is set true when expanding a substring that isn't actually
4446 going to be used (after "if" or "lookup") and it prevents lookups from
4447 happening lower down.
4449 Store usage: At start, a store block of the length of the input plus 64
4450 is obtained. This is expanded as necessary by string_cat(), which might have to
4451 get a new block, or might be able to expand the original. At the end of the
4452 function we can release any store above that portion of the yield block that
4453 was actually used. In many cases this will be optimal.
4455 However: if the first item in the expansion is a variable name or header name,
4456 we reset the store before processing it; if the result is in fresh store, we
4457 use that without copying. This is helpful for expanding strings like
4458 $message_headers which can get very long.
4460 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4461 since resetting the store at the end of the expansion will free store that was
4462 allocated by the plugin code as well as the slop after the expanded string. So
4463 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4464 and, given the acl condition, ${if }. This is an unfortunate consequence of
4465 string expansion becoming too powerful.
4468 string the string to be expanded
4469 ket_ends true if expansion is to stop at }
4470 left if not NULL, a pointer to the first character after the
4471 expansion is placed here (typically used with ket_ends)
4472 skipping TRUE for recursive calls when the value isn't actually going
4473 to be used (to allow for optimisation)
4474 honour_dollar TRUE if $ is to be expanded,
4475 FALSE if it's just another character
4476 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4479 Returns: NULL if expansion fails:
4480 expand_string_forcedfail is set TRUE if failure was forced
4481 expand_string_message contains a textual error message
4482 a pointer to the expanded string on success
4486 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
4487 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
4489 rmark reset_point = store_mark();
4490 gstring * yield = string_get(Ustrlen(string) + 64);
4492 const uschar * s = string;
4493 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4494 int save_expand_nlength[EXPAND_MAXN+1];
4495 BOOL resetok = TRUE, first = TRUE;
4498 f.expand_string_forcedfail = FALSE;
4499 expand_string_message = US"";
4502 if ((m = is_tainted2(string, LOG_MAIN|LOG_PANIC, "Tainted string '%s' in expansion", s)))
4504 expand_string_message = m;
4516 debug_printf_indent("%c%s: %s\n",
4518 skipping ? "---scanning" : "considering", s);
4520 debug_printf_indent("%s%s: %s\n",
4521 first ? UTF8_DOWN_RIGHT : UTF8_VERT_RIGHT,
4523 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4529 /* \ escapes the next character, which must exist, or else
4530 the expansion fails. There's a special escape, \N, which causes
4531 copying of the subject verbatim up to the next \N. Otherwise,
4532 the escapes are the standard set. */
4538 expand_string_message = US"\\ at end of string";
4544 const uschar * t = s + 2;
4545 for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4548 debug_expansion_interim(US"protected", t, (int)(s - t), skipping);
4549 yield = string_catn(yield, t, s - t);
4557 debug_printf_indent("|backslashed: '\\%c'\n", s[1]);
4559 debug_printf_indent(UTF8_VERT_RIGHT "backslashed: '\\%c'\n", s[1]);
4560 ch[0] = string_interpret_escape(&s);
4562 yield = string_catn(yield, ch, 1);
4568 /* Anything other than $ is just copied verbatim, unless we are
4569 looking for a terminating } character. */
4571 if (ket_ends && *s == '}') break;
4573 if (*s != '$' || !honour_dollar)
4576 for (const uschar * t = s+1;
4577 *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4579 DEBUG(D_expand) debug_expansion_interim(US"text", s, i, skipping);
4581 yield = string_catn(yield, s, i);
4586 /* No { after the $ - must be a plain name or a number for string
4587 match variable. There has to be a fudge for variables that are the
4588 names of header fields preceded by "$header_" because header field
4589 names can contain any printing characters except space and colon.
4590 For those that don't like typing this much, "$h_" is a synonym for
4591 "$header_". A non-existent header yields a NULL value; nothing is
4596 const uschar * value;
4597 int newsize = 0, len;
4601 s = read_name(name, sizeof(name), s, US"_");
4603 /* If this is the first thing to be expanded, release the pre-allocated
4607 g = store_get(sizeof(gstring), FALSE);
4608 else if (yield->ptr == 0)
4610 if (resetok) reset_point = store_reset(reset_point);
4612 reset_point = store_mark();
4613 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
4618 if ( ( *(t = name) == 'h'
4619 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4621 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4624 unsigned flags = *name == 'r' ? FH_WANT_RAW
4625 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4627 const uschar * charset = *name == 'b' ? NULL : headers_charset;
4629 s = read_header_name(name, sizeof(name), s);
4630 value = find_header(name, &newsize, flags, charset);
4632 /* If we didn't find the header, and the header contains a closing brace
4633 character, this may be a user error where the terminating colon
4634 has been omitted. Set a flag to adjust the error message in this case.
4635 But there is no error here - nothing gets inserted. */
4639 if (Ustrchr(name, '}')) malformed_header = TRUE;
4646 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4648 expand_string_message =
4649 string_sprintf("unknown variable name \"%s\"", name);
4650 check_variable_error_message(name);
4654 /* If the data is known to be in a new buffer, newsize will be set to the
4655 size of that buffer. If this is the first thing in an expansion string,
4656 yield will be NULL; just point it at the new store instead of copying. Many
4657 expansion strings contain just one reference, so this is a useful
4658 optimization, especially for humungous headers. We need to use a gstring
4659 structure that is not allocated after that new-buffer, else a later store
4660 reset in the middle of the buffer will make it inaccessible. */
4662 len = Ustrlen(value);
4663 if (!yield && newsize != 0)
4666 yield->size = newsize;
4668 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4671 yield = string_catn(yield, value, len);
4679 s = read_cnumber(&n, s);
4680 if (n >= 0 && n <= expand_nmax)
4681 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4685 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4687 if (*s != '{') /*}*/
4689 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4693 /* After { there can be various things, but they all start with
4694 an initial word, except for a number for a string match variable. */ /*}*/
4699 s = read_cnumber(&n, s); /*{{*/
4702 expand_string_message = US"} expected after number";
4705 if (n >= 0 && n <= expand_nmax)
4706 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4712 expand_string_message = US"letter or digit expected after ${"; /*}*/
4716 /* Allow "-" in names to cater for substrings with negative
4717 arguments. Since we are checking for known names after { this is
4720 s = read_name(name, sizeof(name), s, US"_-");
4721 item_type = chop_match(name, item_table, nelem(item_table));
4723 /* Switch on item type. All nondefault choices should "continue* when
4724 skipping, but "break" otherwise so we get debug output for the item
4727 int start = gstring_length(yield);
4730 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4731 If the ACL returns accept or reject we return content set by "message ="
4732 There is currently no limit on recursion; this would have us call
4733 acl_check_internal() directly and get a current level from somewhere.
4734 See also the acl expansion condition ECOND_ACL and the traditional
4735 acl modifier ACLC_ACL.
4736 Assume that the function has side-effects on the store that must be preserved.
4740 /* ${acl {name} {arg1}{arg2}...} */
4742 uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4746 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, name,
4749 case 1: goto EXPAND_FAILED_CURLY;
4751 case 3: goto EXPAND_FAILED;
4753 if (skipping) continue;
4756 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4761 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4763 yield = string_cat(yield, user_msg);
4767 f.expand_string_forcedfail = TRUE;
4770 expand_string_message = string_sprintf("%s from acl \"%s\"",
4771 rc_names[rc], sub[0]);
4777 case EITEM_AUTHRESULTS:
4778 /* ${authresults {mysystemname}} */
4780 uschar * sub_arg[1];
4782 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4785 case 1: goto EXPAND_FAILED_CURLY;
4787 case 3: goto EXPAND_FAILED;
4790 yield = string_append(yield, 3,
4791 US"Authentication-Results: ", sub_arg[0], US"; none");
4794 yield = authres_local(yield, sub_arg[0]);
4795 yield = authres_iprev(yield);
4796 yield = authres_smtpauth(yield);
4798 yield = authres_spf(yield);
4800 #ifndef DISABLE_DKIM
4801 yield = authres_dkim(yield);
4803 #ifdef SUPPORT_DMARC
4804 yield = authres_dmarc(yield);
4806 #ifdef EXPERIMENTAL_ARC
4807 yield = authres_arc(yield);
4812 /* Handle conditionals - preserve the values of the numerical expansion
4813 variables in case they get changed by a regular expression match in the
4814 condition. If not, they retain their external settings. At the end
4815 of this "if" section, they get restored to their previous values. */
4820 const uschar *next_s;
4821 int save_expand_nmax =
4822 save_expand_strings(save_expand_nstring, save_expand_nlength);
4824 Uskip_whitespace(&s);
4825 if (!(next_s = eval_condition(s, &resetok, skipping ? NULL : &cond)))
4826 goto EXPAND_FAILED; /* message already set */
4830 debug_expansion_interim(US"condition", s, (int)(next_s - s), skipping);
4831 debug_expansion_interim(US"result",
4832 cond ? US"true" : US"false", cond ? 4 : 5, skipping);
4837 /* The handling of "yes" and "no" result strings is now in a separate
4838 function that is also used by ${lookup} and ${extract} and ${run}. */
4840 switch(process_yesno(
4841 skipping, /* were previously skipping */
4842 cond, /* success/failure indicator */
4843 lookup_value, /* value to reset for string2 */
4844 &s, /* input pointer */
4845 &yield, /* output pointer */
4846 US"if", /* condition type */
4849 case 1: goto EXPAND_FAILED; /* when all is well, the */
4850 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4853 /* Restore external setting of expansion variables for continuation
4856 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4857 save_expand_nlength);
4862 case EITEM_IMAPFOLDER:
4863 { /* ${imapfolder {name}{sep}{specials}} */
4867 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4870 case 1: goto EXPAND_FAILED_CURLY;
4872 case 3: goto EXPAND_FAILED;
4875 if (!sub_arg[1]) /* One argument */
4877 sub_arg[1] = US"/"; /* default separator */
4880 else if (Ustrlen(sub_arg[1]) != 1)
4882 expand_string_message =
4884 "IMAP folder separator must be one character, found \"%s\"",
4889 if (skipping) continue;
4891 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4892 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4894 yield = string_cat(yield, encoded);
4899 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4900 expanding an internal string that isn't actually going to be used. All we
4901 need to do is check the syntax, so don't do a lookup at all. Preserve the
4902 values of the numerical expansion variables in case they get changed by a
4903 partial lookup. If not, they retain their external settings. At the end
4904 of this "lookup" section, they get restored to their previous values. */
4908 int stype, partial, affixlen, starflags;
4909 int expand_setup = 0;
4911 uschar * key, * filename;
4912 const uschar * affix, * opts;
4913 uschar * save_lookup_value = lookup_value;
4914 int save_expand_nmax =
4915 save_expand_strings(save_expand_nstring, save_expand_nlength);
4917 if (expand_forbid & RDO_LOOKUP)
4919 expand_string_message = US"lookup expansions are not permitted";
4923 /* Get the key we are to look up for single-key+file style lookups.
4924 Otherwise set the key NULL pro-tem. */
4926 if (Uskip_whitespace(&s) == '{') /*}*/
4928 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4929 if (!key) goto EXPAND_FAILED; /*{{*/
4932 expand_string_message = US"missing '}' after lookup key";
4933 goto EXPAND_FAILED_CURLY;
4935 Uskip_whitespace(&s);
4939 /* Find out the type of database */
4943 expand_string_message = US"missing lookup type";
4947 /* The type is a string that may contain special characters of various
4948 kinds. Allow everything except space or { to appear; the actual content
4949 is checked by search_findtype_partial. */ /*}*/
4951 while (*s && *s != '{' && !isspace(*s)) /*}*/
4953 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4956 name[nameptr] = '\0';
4957 Uskip_whitespace(&s);
4959 /* Now check for the individual search type and any partial or default
4960 options. Only those types that are actually in the binary are valid. */
4962 if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4963 &starflags, &opts)) < 0)
4965 expand_string_message = search_error_message;
4969 /* Check that a key was provided for those lookup types that need it,
4970 and was not supplied for those that use the query style. */
4972 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4976 expand_string_message = string_sprintf("missing {key} for single-"
4977 "key \"%s\" lookup", name);
4983 expand_string_message = string_sprintf("a single key was given for "
4984 "lookup type \"%s\", which is not a single-key lookup type", name);
4988 /* Get the next string in brackets and expand it. It is the file name for
4989 single-key+file lookups, and the whole query otherwise. In the case of
4990 queries that also require a file name (e.g. sqlite), the file name comes
4995 expand_string_message = US"missing '{' for lookup file-or-query arg";
4996 goto EXPAND_FAILED_CURLY; /*}}*/
4998 if (!(filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
5003 expand_string_message = US"missing '}' closing lookup file-or-query arg";
5004 goto EXPAND_FAILED_CURLY;
5006 Uskip_whitespace(&s);
5008 /* If this isn't a single-key+file lookup, re-arrange the variables
5009 to be appropriate for the search_ functions. For query-style lookups,
5010 there is just a "key", and no file name. For the special query-style +
5011 file types, the query (i.e. "key") starts with a file name. */
5014 key = search_args(stype, name, filename, &filename, opts);
5016 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5017 the entry was not found. Note that there is no search_close() function.
5018 Files are left open in case of re-use. At suitable places in higher logic,
5019 search_tidyup() is called to tidy all open files. This can save opening
5020 the same file several times. However, files may also get closed when
5021 others are opened, if too many are open at once. The rule is that a
5022 handle should not be used after a second search_open().
5024 Request that a partial search sets up $1 and maybe $2 by passing
5025 expand_setup containing zero. If its value changes, reset expand_nmax,
5026 since new variables will have been set. Note that at the end of this
5027 "lookup" section, the old numeric variables are restored. */
5030 lookup_value = NULL;
5033 void * handle = search_open(filename, stype, 0, NULL, NULL);
5036 expand_string_message = search_error_message;
5039 lookup_value = search_find(handle, filename, key, partial, affix,
5040 affixlen, starflags, &expand_setup, opts);
5041 if (f.search_find_defer)
5043 expand_string_message =
5044 string_sprintf("lookup of \"%s\" gave DEFER: %s",
5045 string_printing2(key, SP_TAB), search_error_message);
5048 if (expand_setup > 0) expand_nmax = expand_setup;
5051 /* The handling of "yes" and "no" result strings is now in a separate
5052 function that is also used by ${if} and ${extract}. */
5054 switch(process_yesno(
5055 skipping, /* were previously skipping */
5056 lookup_value != NULL, /* success/failure indicator */
5057 save_lookup_value, /* value to reset for string2 */
5058 &s, /* input pointer */
5059 &yield, /* output pointer */
5060 US"lookup", /* condition type */
5063 case 1: goto EXPAND_FAILED; /* when all is well, the */
5064 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5067 /* Restore external setting of expansion variables for carrying on
5068 at this level, and continue. */
5070 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5071 save_expand_nlength);
5073 if (skipping) continue;
5077 /* If Perl support is configured, handle calling embedded perl subroutines,
5078 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5079 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5080 arguments (defined below). */
5082 #define EXIM_PERL_MAX_ARGS 8
5086 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
5087 "is not included in this binary";
5090 #else /* EXIM_PERL */
5092 uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5093 gstring * new_yield;
5095 if (expand_forbid & RDO_PERL)
5097 expand_string_message = US"Perl calls are not permitted";
5101 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
5104 case 1: goto EXPAND_FAILED_CURLY;
5106 case 3: goto EXPAND_FAILED;
5109 /* If skipping, we don't actually do anything */
5111 if (skipping) continue;
5113 /* Start the interpreter if necessary */
5115 if (!opt_perl_started)
5118 if (!opt_perl_startup)
5120 expand_string_message = US"A setting of perl_startup is needed when "
5121 "using the Perl interpreter";
5124 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5125 if ((initerror = init_perl(opt_perl_startup)))
5127 expand_string_message =
5128 string_sprintf("error in perl_startup code: %s\n", initerror);
5131 opt_perl_started = TRUE;
5134 /* Call the function */
5136 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5137 new_yield = call_perl_cat(yield, &expand_string_message,
5138 sub_arg[0], sub_arg + 1);
5140 /* NULL yield indicates failure; if the message pointer has been set to
5141 NULL, the yield was undef, indicating a forced failure. Otherwise the
5142 message will indicate some kind of Perl error. */
5146 if (!expand_string_message)
5148 expand_string_message =
5149 string_sprintf("Perl subroutine \"%s\" returned undef to force "
5150 "failure", sub_arg[0]);
5151 f.expand_string_forcedfail = TRUE;
5156 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5157 set during a callback from Perl. */
5159 f.expand_string_forcedfail = FALSE;
5163 #endif /* EXIM_PERL */
5165 /* Transform email address to "prvs" scheme to use
5166 as BATV-signed return path */
5170 uschar * sub_arg[3], * p, * domain;
5172 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, name, &resetok))
5174 case 1: goto EXPAND_FAILED_CURLY;
5176 case 3: goto EXPAND_FAILED;
5179 /* If skipping, we don't actually do anything */
5180 if (skipping) continue;
5182 /* sub_arg[0] is the address */
5183 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
5184 || domain == sub_arg[0] || Ustrlen(domain) == 1)
5186 expand_string_message = US"prvs first argument must be a qualified email address";
5190 /* Calculate the hash. The third argument must be a single-digit
5191 key number, or unset. */
5194 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5196 expand_string_message = US"prvs third argument must be a single digit";
5200 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5203 expand_string_message = US"prvs hmac-sha1 conversion failed";
5207 /* Now separate the domain from the local part */
5210 yield = string_catn(yield, US"prvs=", 5);
5211 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5212 yield = string_catn(yield, prvs_daystamp(7), 3);
5213 yield = string_catn(yield, p, 6);
5214 yield = string_catn(yield, US"=", 1);
5215 yield = string_cat (yield, sub_arg[0]);
5216 yield = string_catn(yield, US"@", 1);
5217 yield = string_cat (yield, domain);
5222 /* Check a prvs-encoded address for validity */
5224 case EITEM_PRVSCHECK:
5226 uschar * sub_arg[3], * p;
5228 const pcre2_code * re;
5230 /* TF: Ugliness: We want to expand parameter 1 first, then set
5231 up expansion variables that are used in the expansion of
5232 parameter 2. So we clone the string for the first
5233 expansion, where we only expand parameter 1.
5235 PH: Actually, that isn't necessary. The read_subs() function is
5236 designed to work this way for the ${if and ${lookup expansions. I've
5240 /* Reset expansion variables */
5241 prvscheck_result = NULL;
5242 prvscheck_address = NULL;
5243 prvscheck_keynum = NULL;
5245 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, name, &resetok))
5247 case 1: goto EXPAND_FAILED_CURLY;
5249 case 3: goto EXPAND_FAILED;
5252 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5255 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5257 uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5258 uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5259 uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5260 uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5261 uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5263 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
5264 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
5265 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5266 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
5267 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
5269 /* Set up expansion variables */
5270 g = string_cat (NULL, local_part);
5271 g = string_catn(g, US"@", 1);
5272 g = string_cat (g, domain);
5273 prvscheck_address = string_from_gstring(g);
5274 prvscheck_keynum = string_copy(key_num);
5276 /* Now expand the second argument */
5277 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, name, &resetok))
5279 case 1: goto EXPAND_FAILED_CURLY;
5281 case 3: goto EXPAND_FAILED;
5284 /* Now we have the key and can check the address. */
5286 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5291 expand_string_message = US"hmac-sha1 conversion failed";
5295 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5296 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
5298 if (Ustrcmp(p,hash) == 0)
5300 /* Success, valid BATV address. Now check the expiry date. */
5301 uschar *now = prvs_daystamp(0);
5302 unsigned int inow = 0,iexpire = 1;
5304 (void)sscanf(CS now,"%u",&inow);
5305 (void)sscanf(CS daystamp,"%u",&iexpire);
5307 /* When "iexpire" is < 7, a "flip" has occurred.
5308 Adjust "inow" accordingly. */
5309 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5311 if (iexpire >= inow)
5313 prvscheck_result = US"1";
5314 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
5318 prvscheck_result = NULL;
5319 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
5324 prvscheck_result = NULL;
5325 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
5328 /* Now expand the final argument. We leave this till now so that
5329 it can include $prvscheck_result. */
5331 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, name, &resetok))
5333 case 1: goto EXPAND_FAILED_CURLY;
5335 case 3: goto EXPAND_FAILED;
5338 yield = string_cat(yield,
5339 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5341 /* Reset the "internal" variables afterwards, because they are in
5342 dynamic store that will be reclaimed if the expansion succeeded. */
5344 prvscheck_address = NULL;
5345 prvscheck_keynum = NULL;
5348 /* Does not look like a prvs encoded address, return the empty string.
5349 We need to make sure all subs are expanded first, so as to skip over
5352 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, name, &resetok))
5354 case 1: goto EXPAND_FAILED_CURLY;
5356 case 3: goto EXPAND_FAILED;
5359 if (skipping) continue;
5363 /* Handle "readfile" to insert an entire file */
5365 case EITEM_READFILE:
5368 uschar * sub_arg[2];
5370 if ((expand_forbid & RDO_READFILE) != 0)
5372 expand_string_message = US"file insertions are not permitted";
5376 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, name, &resetok))
5378 case 1: goto EXPAND_FAILED_CURLY;
5380 case 3: goto EXPAND_FAILED;
5383 /* If skipping, we don't actually do anything */
5385 if (skipping) continue;
5387 /* Open the file and read it */
5389 if (!(f = Ufopen(sub_arg[0], "rb")))
5391 expand_string_message = string_open_failed("%s", sub_arg[0]);
5395 yield = cat_file(f, yield, sub_arg[1]);
5400 /* Handle "readsocket" to insert data from a socket, either
5401 Inet or Unix domain */
5403 case EITEM_READSOCK:
5406 uschar * sub_arg[4];
5408 if (expand_forbid & RDO_READSOCK)
5410 expand_string_message = US"socket insertions are not permitted";
5414 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5415 because there may be a string for expansion on failure. */
5417 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, name, &resetok))
5419 case 1: goto EXPAND_FAILED_CURLY;
5420 case 2: /* Won't occur: no end check */
5421 case 3: goto EXPAND_FAILED;
5424 /* If skipping, we don't actually do anything. Otherwise, arrange to
5425 connect to either an IP or a Unix socket. */
5429 int stype = search_findtype(US"readsock", 8);
5432 int expand_setup = -1;
5435 /* If the reqstr is empty, flag that and set a dummy */
5439 g = string_append_listele(g, ',', US"send=no");
5440 sub_arg[1] = US"DUMMY";
5443 /* Re-marshall the options */
5447 const uschar * list = sub_arg[2];
5451 /* First option has no tag and is timeout */
5452 if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5453 g = string_append_listele(g, ',',
5454 string_sprintf("timeout=%s", item));
5456 /* The rest of the options from the expansion */
5457 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5458 g = string_append_listele(g, ',', item);
5460 /* possibly plus an EOL string. Process with escapes, to protect
5461 from list-processing. The only current user of eol= in search
5462 options is the readsock expansion. */
5464 if (sub_arg[3] && *sub_arg[3])
5465 g = string_append_listele(g, ',',
5466 string_sprintf("eol=%s",
5467 string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5470 /* Gat a (possibly cached) handle for the connection */
5472 if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5474 if (*expand_string_message) goto EXPAND_FAILED;
5475 expand_string_message = search_error_message;
5476 search_error_message = NULL;
5480 /* Get (possibly cached) results for the lookup */
5481 /* sspec: sub_arg[0] req: sub_arg[1] opts: g */
5483 if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5484 &expand_setup, string_from_gstring(g))))
5485 yield = string_cat(yield, s);
5486 else if (f.search_find_defer)
5488 expand_string_message = search_error_message;
5489 search_error_message = NULL;
5493 { /* should not happen, at present */
5494 expand_string_message = search_error_message;
5495 search_error_message = NULL;
5500 /* The whole thing has worked (or we were skipping). If there is a
5501 failure string following, we need to skip it. */
5503 if (*s == '{') /*}*/
5505 if (!expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok))
5506 goto EXPAND_FAILED; /*{*/
5509 expand_string_message = US"missing '}' closing failstring for readsocket";
5510 goto EXPAND_FAILED_CURLY;
5512 Uskip_whitespace(&s);
5515 READSOCK_DONE: /*{*/
5518 expand_string_message = US"missing '}' closing readsocket";
5519 goto EXPAND_FAILED_CURLY;
5521 if (skipping) continue;
5524 /* Come here on failure to create socket, connect socket, write to the
5525 socket, or timeout on reading. If another substring follows, expand and
5526 use it. Otherwise, those conditions give expand errors. */
5529 if (*s != '{') goto EXPAND_FAILED; /*}*/
5530 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5531 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5533 yield = string_cat(yield, arg); /*{*/
5536 expand_string_message = US"missing '}' closing failstring for readsocket";
5537 goto EXPAND_FAILED_CURLY;
5539 Uskip_whitespace(&s);
5543 /* Handle "run" to execute a program. */
5549 const uschar ** argv;
5553 if ((expand_forbid & RDO_RUN) != 0)
5555 expand_string_message = US"running a command is not permitted";
5559 Uskip_whitespace(&s);
5562 expand_string_message = US"missing '{' for command arg of run";
5563 goto EXPAND_FAILED_CURLY;
5565 if (!(arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
5567 Uskip_whitespace(&s);
5570 expand_string_message = US"missing '}' closing command arg of run";
5571 goto EXPAND_FAILED_CURLY;
5574 if (skipping) /* Just pretend it worked when we're skipping */
5577 lookup_value = NULL;
5581 if (!transport_set_up_command(&argv, /* anchor for arg list */
5582 arg, /* raw command */
5583 FALSE, /* don't expand the arguments */
5584 0, /* not relevant when... */
5585 NULL, /* no transporting address */
5586 US"${run} expansion", /* for error messages */
5587 &expand_string_message)) /* where to put error message */
5590 /* Create the child process, making it a group leader. */
5592 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5593 US"expand-run")) < 0)
5595 expand_string_message =
5596 string_sprintf("couldn't create child process: %s", strerror(errno));
5600 /* Nothing is written to the standard input. */
5604 /* Read the pipe to get the command's output into $value (which is kept
5605 in lookup_value). Read during execution, so that if the output exceeds
5606 the OS pipe buffer limit, we don't block forever. Remember to not release
5607 memory just allocated for $value. */
5610 f = fdopen(fd_out, "rb");
5611 sigalrm_seen = FALSE;
5613 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5617 /* Wait for the process to finish, applying the timeout, and inspect its
5618 return code for serious disasters. Simple non-zero returns are passed on.
5621 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5623 if (sigalrm_seen || runrc == -256)
5625 expand_string_message = US"command timed out";
5626 killpg(pid, SIGKILL); /* Kill the whole process group */
5629 else if (runrc == -257)
5630 expand_string_message = string_sprintf("wait() failed: %s",
5634 expand_string_message = string_sprintf("command killed by signal %d",
5641 /* Process the yes/no strings; $value may be useful in both cases */
5643 switch(process_yesno(
5644 skipping, /* were previously skipping */
5645 runrc == 0, /* success/failure indicator */
5646 lookup_value, /* value to reset for string2 */
5647 &s, /* input pointer */
5648 &yield, /* output pointer */
5649 US"run", /* condition type */
5652 case 1: goto EXPAND_FAILED; /* when all is well, the */
5653 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5656 if (skipping) continue;
5660 /* Handle character translation for "tr" */
5664 int oldptr = gstring_length(yield);
5668 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5670 case 1: goto EXPAND_FAILED_CURLY;
5672 case 3: goto EXPAND_FAILED;
5675 yield = string_cat(yield, sub[0]);
5676 o2m = Ustrlen(sub[2]) - 1;
5678 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5680 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5684 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5688 if (skipping) continue;
5692 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5693 expanded arguments. */
5702 int val[2] = { 0, -1 };
5705 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5706 Ensure that sub[2] is set in the ${length } case. */
5709 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5710 TRUE, name, &resetok))
5712 case 1: goto EXPAND_FAILED_CURLY;
5714 case 3: goto EXPAND_FAILED;
5717 /* Juggle the arguments if there are only two of them: always move the
5718 string to the last position and make ${length{n}{str}} equivalent to
5719 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5725 if (item_type == EITEM_LENGTH)
5732 for (int i = 0; i < 2; i++) if (sub[i])
5734 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5735 if (*ret != 0 || (i != 0 && val[i] < 0))
5737 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5738 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5744 item_type == EITEM_HASH
5745 ? compute_hash(sub[2], val[0], val[1], &len)
5746 : item_type == EITEM_NHASH
5747 ? compute_nhash(sub[2], val[0], val[1], &len)
5748 : extract_substr(sub[2], val[0], val[1], &len);
5751 yield = string_catn(yield, ret, len);
5752 if (skipping) continue;
5756 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5757 This code originally contributed by Steve Haslam. It currently supports
5758 the use of MD5 and SHA-1 hashes.
5760 We need some workspace that is large enough to handle all the supported
5761 hash types. Use macros to set the sizes rather than be too elaborate. */
5763 #define MAX_HASHLEN 20
5764 #define MAX_HASHBLOCKLEN 64
5773 int hashlen; /* Number of octets for the hash algorithm's output */
5774 int hashblocklen; /* Number of octets the hash algorithm processes */
5775 uschar * keyptr, * p;
5776 unsigned int keylen;
5778 uschar keyhash[MAX_HASHLEN];
5779 uschar innerhash[MAX_HASHLEN];
5780 uschar finalhash[MAX_HASHLEN];
5781 uschar finalhash_hex[2*MAX_HASHLEN];
5782 uschar innerkey[MAX_HASHBLOCKLEN];
5783 uschar outerkey[MAX_HASHBLOCKLEN];
5785 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5787 case 1: goto EXPAND_FAILED_CURLY;
5789 case 3: goto EXPAND_FAILED;
5792 if (skipping) continue;
5794 if (Ustrcmp(sub[0], "md5") == 0)
5797 use_base = &md5_base;
5801 else if (Ustrcmp(sub[0], "sha1") == 0)
5804 use_base = &sha1_ctx;
5810 expand_string_message =
5811 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5816 keylen = Ustrlen(keyptr);
5818 /* If the key is longer than the hash block length, then hash the key
5821 if (keylen > hashblocklen)
5823 chash_start(type, use_base);
5824 chash_end(type, use_base, keyptr, keylen, keyhash);
5829 /* Now make the inner and outer key values */
5831 memset(innerkey, 0x36, hashblocklen);
5832 memset(outerkey, 0x5c, hashblocklen);
5834 for (int i = 0; i < keylen; i++)
5836 innerkey[i] ^= keyptr[i];
5837 outerkey[i] ^= keyptr[i];
5840 /* Now do the hashes */
5842 chash_start(type, use_base);
5843 chash_mid(type, use_base, innerkey);
5844 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5846 chash_start(type, use_base);
5847 chash_mid(type, use_base, outerkey);
5848 chash_end(type, use_base, innerhash, hashlen, finalhash);
5850 /* Encode the final hash as a hex string */
5853 for (int i = 0; i < hashlen; i++)
5855 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5856 *p++ = hex_digits[finalhash[i] & 0x0f];
5859 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5860 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5862 yield = string_catn(yield, finalhash_hex, hashlen*2);
5866 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5867 We have to save the numerical variables and restore them afterwards. */
5871 const pcre2_code * re;
5872 int moffset, moffsetextra, slen;
5874 pcre2_match_data * md;
5876 uschar * subject, * sub[3];
5877 int save_expand_nmax =
5878 save_expand_strings(save_expand_nstring, save_expand_nlength);
5880 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5882 case 1: goto EXPAND_FAILED_CURLY;
5884 case 3: goto EXPAND_FAILED;
5887 /*XXX no handling of skipping? */
5888 /* Compile the regular expression */
5890 if (!(re = pcre2_compile((PCRE2_SPTR)sub[1], PCRE2_ZERO_TERMINATED,
5891 PCRE_COPT, &err, &roffset, pcre_cmp_ctx)))
5894 pcre2_get_error_message(err, errbuf, sizeof(errbuf));
5895 expand_string_message = string_sprintf("regular expression error in "
5896 "\"%s\": %s at offset %ld", sub[1], errbuf, (long)roffset);
5899 md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
5901 /* Now run a loop to do the substitutions as often as necessary. It ends
5902 when there are no more matches. Take care over matches of the null string;
5903 do the same thing as Perl does. */
5906 slen = Ustrlen(sub[0]);
5907 moffset = moffsetextra = 0;
5912 PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
5913 int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
5914 PCRE_EOPT | emptyopt, md, pcre_mtc_ctx);
5917 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5918 is not necessarily the end. We want to repeat the match from one
5919 character further along, but leaving the basic offset the same (for
5920 copying below). We can't be at the end of the string - that was checked
5921 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5922 finished; copy the remaining string and end the loop. */
5932 yield = string_catn(yield, subject+moffset, slen-moffset);
5936 /* Match - set up for expanding the replacement. */
5937 DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
5939 if (n == 0) n = EXPAND_MAXN + 1;
5941 for (int nn = 0; nn < n*2; nn += 2)
5943 expand_nstring[expand_nmax] = subject + ovec[nn];
5944 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
5948 /* Copy the characters before the match, plus the expanded insertion. */
5950 yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
5952 if (!(insert = expand_string(sub[2])))
5954 yield = string_cat(yield, insert);
5960 /* If we have matched an empty string, first check to see if we are at
5961 the end of the subject. If so, the loop is over. Otherwise, mimic
5962 what Perl's /g options does. This turns out to be rather cunning. First
5963 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5964 string at the same point. If this fails (picked up above) we advance to
5965 the next character. */
5967 if (ovec[0] == ovec[1])
5969 if (ovec[0] == slen) break;
5970 emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
5974 /* All done - restore numerical variables. */
5976 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5977 save_expand_nlength);
5978 if (skipping) continue;
5982 /* Handle keyed and numbered substring extraction. If the first argument
5983 consists entirely of digits, then a numerical extraction is assumed. */
5987 int field_number = 1;
5988 BOOL field_number_set = FALSE;
5989 uschar * save_lookup_value = lookup_value, * sub[3];
5990 int save_expand_nmax =
5991 save_expand_strings(save_expand_nstring, save_expand_nlength);
5993 /* On reflection the original behaviour of extract-json for a string
5994 result, leaving it quoted, was a mistake. But it was already published,
5995 hence the addition of jsons. In a future major version, make json
5996 work like josons, and withdraw jsons. */
5998 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
6000 /* Check for a format-variant specifier */
6002 if (Uskip_whitespace(&s) != '{') /*}*/
6003 if (Ustrncmp(s, "json", 4) == 0)
6004 if (*(s += 4) == 's')
6005 {fmt = extract_jsons; s++;}
6009 /* While skipping we cannot rely on the data for expansions being
6010 available (eg. $item) hence cannot decide on numeric vs. keyed.
6011 Read a maximum of 5 arguments (including the yes/no) */
6015 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
6017 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
6018 goto EXPAND_FAILED; /*'{'*/
6021 expand_string_message = US"missing '{' for arg of extract";
6022 goto EXPAND_FAILED_CURLY;
6024 Uskip_whitespace(&s);
6026 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
6027 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
6031 Uskip_whitespace(&s);
6035 expand_string_message = US"missing '}' closing extract";
6036 goto EXPAND_FAILED_CURLY;
6040 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
6042 if (Uskip_whitespace(&s) == '{') /*'}'*/
6044 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
6045 goto EXPAND_FAILED; /*'{'*/
6048 expand_string_message = string_sprintf(
6049 "missing '}' closing arg %d of extract", i+1);
6050 goto EXPAND_FAILED_CURLY;
6053 /* After removal of leading and trailing white space, the first
6054 argument must not be empty; if it consists entirely of digits
6055 (optionally preceded by a minus sign), this is a numerical
6056 extraction, and we expect 3 arguments (normal) or 2 (json). */
6062 uschar * p = sub[0];
6064 Uskip_whitespace(&p);
6068 while (len > 0 && isspace(p[len-1])) len--;
6073 expand_string_message = US"first argument of \"extract\" must "
6083 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6087 if (fmt == extract_basic) j = 3; /* Need 3 args */
6088 field_number_set = TRUE;
6094 expand_string_message = string_sprintf(
6095 "missing '{' for arg %d of extract", i+1);
6096 goto EXPAND_FAILED_CURLY;
6100 /* Extract either the numbered or the keyed substring into $value. If
6101 skipping, just pretend the extraction failed. */
6104 lookup_value = NULL;
6108 lookup_value = field_number_set
6109 ? expand_gettokened(field_number, sub[1], sub[2])
6110 : expand_getkeyed(sub[0], sub[1]);
6117 const uschar * list;
6119 /* Array: Bracket-enclosed and comma-separated.
6120 Object: Brace-enclosed, comma-sep list of name:value pairs */
6122 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6124 expand_string_message =
6125 string_sprintf("%s wrapping %s for extract json",
6126 expand_string_message,
6127 field_number_set ? "array" : "object");
6128 goto EXPAND_FAILED_CURLY;
6132 if (field_number_set)
6134 if (field_number <= 0)
6136 expand_string_message = US"first argument of \"extract\" must "
6137 "be greater than zero";
6140 while (field_number > 0 && (item = json_nextinlist(&list)))
6142 if ((lookup_value = s = item))
6145 while (--s >= lookup_value && isspace(*s)) *s = '\0';
6150 lookup_value = NULL;
6151 while ((item = json_nextinlist(&list)))
6153 /* Item is: string name-sep value. string is quoted.
6154 Dequote the string and compare with the search key. */
6156 if (!(item = dewrap(item, US"\"\"")))
6158 expand_string_message =
6159 string_sprintf("%s wrapping string key for extract json",
6160 expand_string_message);
6161 goto EXPAND_FAILED_CURLY;
6163 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
6165 s = item + Ustrlen(item) + 1;
6166 if (Uskip_whitespace(&s) != ':')
6168 expand_string_message =
6169 US"missing object value-separator for extract json";
6170 goto EXPAND_FAILED_CURLY;
6173 Uskip_whitespace(&s);
6181 if ( fmt == extract_jsons
6183 && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6185 expand_string_message =
6186 string_sprintf("%s wrapping string result for extract jsons",
6187 expand_string_message);
6188 goto EXPAND_FAILED_CURLY;
6193 /* If no string follows, $value gets substituted; otherwise there can
6194 be yes/no strings, as for lookup or if. */
6196 switch(process_yesno(
6197 skipping, /* were previously skipping */
6198 lookup_value != NULL, /* success/failure indicator */
6199 save_lookup_value, /* value to reset for string2 */
6200 &s, /* input pointer */
6201 &yield, /* output pointer */
6202 US"extract", /* condition type */
6205 case 1: goto EXPAND_FAILED; /* when all is well, the */
6206 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6209 /* All done - restore numerical variables. */
6211 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6212 save_expand_nlength);
6214 if (skipping) continue;
6218 /* return the Nth item from a list */
6220 case EITEM_LISTEXTRACT:
6222 int field_number = 1;
6223 uschar * save_lookup_value = lookup_value, * sub[2];
6224 int save_expand_nmax =
6225 save_expand_strings(save_expand_nstring, save_expand_nlength);
6227 /* Read the field & list arguments */
6229 for (int i = 0; i < 2; i++)
6231 if (Uskip_whitespace(&s) != '{') /*}*/
6233 expand_string_message = string_sprintf(
6234 "missing '{' for arg %d of listextract", i+1); /*}*/
6235 goto EXPAND_FAILED_CURLY;
6238 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6239 if (!sub[i]) goto EXPAND_FAILED; /*{{*/
6242 expand_string_message = string_sprintf(
6243 "missing '}' closing arg %d of listextract", i+1);
6244 goto EXPAND_FAILED_CURLY;
6247 /* After removal of leading and trailing white space, the first
6248 argument must be numeric and nonempty. */
6256 Uskip_whitespace(&p);
6260 while (len > 0 && isspace(p[len-1])) len--;
6263 if (!*p && !skipping)
6265 expand_string_message = US"first argument of \"listextract\" must "
6275 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6278 expand_string_message = US"first argument of \"listextract\" must "
6286 /* Extract the numbered element into $value. If
6287 skipping, just pretend the extraction failed. */
6289 lookup_value = skipping ? NULL : expand_getlistele(field_number, sub[1]);
6291 /* If no string follows, $value gets substituted; otherwise there can
6292 be yes/no strings, as for lookup or if. */
6294 switch(process_yesno(
6295 skipping, /* were previously skipping */
6296 lookup_value != NULL, /* success/failure indicator */
6297 save_lookup_value, /* value to reset for string2 */
6298 &s, /* input pointer */
6299 &yield, /* output pointer */
6300 US"listextract", /* condition type */
6303 case 1: goto EXPAND_FAILED; /* when all is well, the */
6304 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6307 /* All done - restore numerical variables. */
6309 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6310 save_expand_nlength);
6312 if (skipping) continue;
6316 case EITEM_LISTQUOTE:
6319 switch(read_subs(sub, 2, 2, &s, skipping, TRUE, name, &resetok))
6321 case 1: goto EXPAND_FAILED_CURLY;
6323 case 3: goto EXPAND_FAILED;
6325 if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6327 if (c == sep) yield = string_catn(yield, sub[1], 1);
6328 yield = string_catn(yield, sub[1], 1);
6330 else yield = string_catn(yield, US" ", 1);
6331 if (skipping) continue;
6336 case EITEM_CERTEXTRACT:
6338 uschar * save_lookup_value = lookup_value, * sub[2];
6339 int save_expand_nmax =
6340 save_expand_strings(save_expand_nstring, save_expand_nlength);
6342 /* Read the field argument */
6343 if (Uskip_whitespace(&s) != '{') /*}*/
6345 expand_string_message = US"missing '{' for field arg of certextract";
6346 goto EXPAND_FAILED_CURLY; /*}*/
6348 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6349 if (!sub[0]) goto EXPAND_FAILED; /*{{*/
6352 expand_string_message = US"missing '}' closing field arg of certextract";
6353 goto EXPAND_FAILED_CURLY;
6355 /* strip spaces fore & aft */
6360 Uskip_whitespace(&p);
6364 while (len > 0 && isspace(p[len-1])) len--;
6368 /* inspect the cert argument */
6369 if (Uskip_whitespace(&s) != '{') /*}*/
6371 expand_string_message = US"missing '{' for cert variable arg of certextract";
6372 goto EXPAND_FAILED_CURLY; /*}*/
6376 expand_string_message = US"second argument of \"certextract\" must "
6377 "be a certificate variable";
6380 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
6381 if (!sub[1]) goto EXPAND_FAILED; /*{{*/
6384 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6385 goto EXPAND_FAILED_CURLY;
6389 lookup_value = NULL;
6392 lookup_value = expand_getcertele(sub[0], sub[1]);
6393 if (*expand_string_message) goto EXPAND_FAILED;
6395 switch(process_yesno(
6396 skipping, /* were previously skipping */
6397 lookup_value != NULL, /* success/failure indicator */
6398 save_lookup_value, /* value to reset for string2 */
6399 &s, /* input pointer */
6400 &yield, /* output pointer */
6401 US"certextract", /* condition type */
6404 case 1: goto EXPAND_FAILED; /* when all is well, the */
6405 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6408 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6409 save_expand_nlength);
6410 if (skipping) continue;
6413 #endif /*DISABLE_TLS*/
6415 /* Handle list operations */
6421 int sep = 0, save_ptr = gstring_length(yield);
6422 uschar outsep[2] = { '\0', '\0' };
6423 const uschar *list, *expr, *temp;
6424 uschar * save_iterate_item = iterate_item;
6425 uschar * save_lookup_value = lookup_value;
6427 Uskip_whitespace(&s);
6428 if (*s++ != '{') /*}*/
6430 expand_string_message =
6431 string_sprintf("missing '{' for first arg of %s", name);
6432 goto EXPAND_FAILED_CURLY; /*}*/
6435 if (!(list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok)))
6436 goto EXPAND_FAILED; /*{{*/
6439 expand_string_message =
6440 string_sprintf("missing '}' closing first arg of %s", name);
6441 goto EXPAND_FAILED_CURLY;
6444 if (item_type == EITEM_REDUCE)
6447 Uskip_whitespace(&s);
6448 if (*s++ != '{') /*}*/
6450 expand_string_message = US"missing '{' for second arg of reduce";
6451 goto EXPAND_FAILED_CURLY; /*}*/
6453 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6454 if (!t) goto EXPAND_FAILED;
6455 lookup_value = t; /*{{*/
6458 expand_string_message = US"missing '}' closing second arg of reduce";
6459 goto EXPAND_FAILED_CURLY;
6463 Uskip_whitespace(&s);
6464 if (*s++ != '{') /*}*/
6466 expand_string_message =
6467 string_sprintf("missing '{' for last arg of %s", name); /*}*/
6468 goto EXPAND_FAILED_CURLY;
6473 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6474 if scanning a "false" part). This allows us to find the end of the
6475 condition, because if the list is empty, we won't actually evaluate the
6476 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6477 the normal internal expansion function. */
6479 if (item_type != EITEM_FILTER)
6480 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6482 if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6486 expand_string_message = string_sprintf("%s inside \"%s\" item",
6487 expand_string_message, name);
6491 Uskip_whitespace(&s); /*{{{*/
6494 expand_string_message = string_sprintf("missing } at end of condition "
6495 "or expression inside \"%s\"; could be an unquoted } in the content",
6500 Uskip_whitespace(&s); /*{{*/
6503 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6508 /* If we are skipping, we can now just move on to the next item. When
6509 processing for real, we perform the iteration. */
6511 if (skipping) continue;
6512 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6514 *outsep = (uschar)sep; /* Separator as a string */
6516 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6517 name, iterate_item, lookup_value);
6519 if (item_type == EITEM_FILTER)
6522 if (!eval_condition(expr, &resetok, &condresult))
6524 iterate_item = save_iterate_item;
6525 lookup_value = save_lookup_value;
6526 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6527 expand_string_message, name);
6530 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6531 condresult? "true":"false");
6533 temp = iterate_item; /* TRUE => include this item */
6535 continue; /* FALSE => skip this item */
6538 /* EITEM_MAP and EITEM_REDUCE */
6542 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
6546 iterate_item = save_iterate_item;
6547 expand_string_message = string_sprintf("%s inside \"%s\" item",
6548 expand_string_message, name);
6551 if (item_type == EITEM_REDUCE)
6553 lookup_value = t; /* Update the value of $value */
6554 continue; /* and continue the iteration */
6558 /* We reach here for FILTER if the condition is true, always for MAP,
6559 and never for REDUCE. The value in "temp" is to be added to the output
6560 list that is being created, ensuring that any occurrences of the
6561 separator character are doubled. Unless we are dealing with the first
6562 item of the output list, add in a space if the new item begins with the
6563 separator character, or is an empty string. */
6565 if ( yield && yield->ptr != save_ptr
6566 && (temp[0] == *outsep || temp[0] == 0))
6567 yield = string_catn(yield, US" ", 1);
6569 /* Add the string in "temp" to the output list that we are building,
6570 This is done in chunks by searching for the separator character. */
6574 size_t seglen = Ustrcspn(temp, outsep);
6576 yield = string_catn(yield, temp, seglen + 1);
6578 /* If we got to the end of the string we output one character
6579 too many; backup and end the loop. Otherwise arrange to double the
6582 if (!temp[seglen]) { yield->ptr--; break; }
6583 yield = string_catn(yield, outsep, 1);
6587 /* Output a separator after the string: we will remove the redundant
6588 final one at the end. */
6590 yield = string_catn(yield, outsep, 1);
6591 } /* End of iteration over the list loop */
6593 /* REDUCE has generated no output above: output the final value of
6596 if (item_type == EITEM_REDUCE)
6598 yield = string_cat(yield, lookup_value);
6599 lookup_value = save_lookup_value; /* Restore $value */
6602 /* FILTER and MAP generate lists: if they have generated anything, remove
6603 the redundant final separator. Even though an empty item at the end of a
6604 list does not count, this is tidier. */
6606 else if (yield && yield->ptr != save_ptr) yield->ptr--;
6608 /* Restore preserved $item */
6610 iterate_item = save_iterate_item;
6611 if (skipping) continue;
6617 int sep = 0, cond_type;
6618 const uschar * srclist, * cmp, * xtract;
6619 uschar * opname, * srcitem;
6620 const uschar * dstlist = NULL, * dstkeylist = NULL;
6621 uschar * tmp, * save_iterate_item = iterate_item;
6623 Uskip_whitespace(&s);
6624 if (*s++ != '{') /*}*/
6626 expand_string_message = US"missing '{' for list arg of sort";
6627 goto EXPAND_FAILED_CURLY; /*}*/
6630 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6631 if (!srclist) goto EXPAND_FAILED; /*{{*/
6634 expand_string_message = US"missing '}' closing list arg of sort";
6635 goto EXPAND_FAILED_CURLY;
6638 Uskip_whitespace(&s);
6639 if (*s++ != '{') /*}*/
6641 expand_string_message = US"missing '{' for comparator arg of sort";
6642 goto EXPAND_FAILED_CURLY; /*}*/
6645 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6646 if (!cmp) goto EXPAND_FAILED; /*{{*/
6649 expand_string_message = US"missing '}' closing comparator arg of sort";
6650 goto EXPAND_FAILED_CURLY;
6653 if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6655 if (!expand_string_message)
6656 expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6661 case ECOND_NUM_L: case ECOND_NUM_LE:
6662 case ECOND_NUM_G: case ECOND_NUM_GE:
6663 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6664 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6668 expand_string_message = US"comparator not handled for sort";
6672 Uskip_whitespace(&s);
6673 if (*s++ != '{') /*}*/
6675 expand_string_message = US"missing '{' for extractor arg of sort";
6676 goto EXPAND_FAILED_CURLY; /*}*/
6680 if (!(tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok)))
6682 xtract = string_copyn(xtract, s - xtract);
6686 expand_string_message = US"missing '}' closing extractor arg of sort";
6687 goto EXPAND_FAILED_CURLY;
6692 expand_string_message = US"missing } at end of \"sort\"";
6696 if (skipping) continue;
6698 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6700 uschar * srcfield, * dstitem;
6701 gstring * newlist = NULL, * newkeylist = NULL;
6703 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6705 /* extract field for comparisons */
6706 iterate_item = srcitem;
6707 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6711 expand_string_message = string_sprintf(
6712 "field-extract in sort: \"%s\"", xtract);
6716 /* Insertion sort */
6718 /* copy output list until new-item < list-item */
6719 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6723 /* field for comparison */
6724 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6727 /* String-comparator names start with a letter; numeric names do not */
6729 if (sortsbefore(cond_type, isalpha(opname[0]),
6730 srcfield, dstfield))
6732 /* New-item sorts before this dst-item. Append new-item,
6733 then dst-item, then remainder of dst list. */
6735 newlist = string_append_listele(newlist, sep, srcitem);
6736 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6739 newlist = string_append_listele(newlist, sep, dstitem);
6740 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6742 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */
6743 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6745 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6747 newlist = string_append_listele(newlist, sep, dstitem);
6748 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6754 newlist = string_append_listele(newlist, sep, dstitem);
6755 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6758 /* If we ran out of dstlist without consuming srcitem, append it */
6761 newlist = string_append_listele(newlist, sep, srcitem);
6762 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6765 dstlist = newlist->s;
6766 dstkeylist = newkeylist->s;
6768 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6769 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6773 yield = string_cat(yield, dstlist);
6775 /* Restore preserved $item */
6776 iterate_item = save_iterate_item;
6780 expand_string_message = US"Internal error in sort (list mismatch)";
6785 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6786 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6787 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6788 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6790 #define EXPAND_DLFUNC_MAX_ARGS 8
6793 #ifndef EXPAND_DLFUNC
6794 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6795 "is not included in this binary";
6798 #else /* EXPAND_DLFUNC */
6801 exim_dlfunc_t * func;
6804 uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6806 if (expand_forbid & RDO_DLFUNC)
6808 expand_string_message =
6809 US"dynamically-loaded functions are not permitted";
6813 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6814 TRUE, name, &resetok))
6816 case 1: goto EXPAND_FAILED_CURLY;
6818 case 3: goto EXPAND_FAILED;
6821 /* If skipping, we don't actually do anything */
6823 if (skipping) continue;
6825 /* Look up the dynamically loaded object handle in the tree. If it isn't
6826 found, dlopen() the file and put the handle in the tree for next time. */
6828 if (!(t = tree_search(dlobj_anchor, argv[0])))
6830 void * handle = dlopen(CS argv[0], RTLD_LAZY);
6833 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6834 argv[0], dlerror());
6835 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6838 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), is_tainted(argv[0]));
6839 Ustrcpy(t->name, argv[0]);
6840 t->data.ptr = handle;
6841 (void)tree_insertnode(&dlobj_anchor, t);
6844 /* Having obtained the dynamically loaded object handle, look up the
6845 function pointer. */
6847 if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6849 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6850 "%s", argv[1], argv[0], dlerror());
6851 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6855 /* Call the function and work out what to do with the result. If it
6856 returns OK, we have a replacement string; if it returns DEFER then
6857 expansion has failed in a non-forced manner; if it returns FAIL then
6858 failure was forced; if it returns ERROR or any other value there's a
6859 problem, so panic slightly. In any case, assume that the function has
6860 side-effects on the store that must be preserved. */
6864 for (argc = 0; argv[argc]; argc++) ;
6866 if ((status = func(&result, argc - 2, &argv[2])) != OK)
6868 expand_string_message = result ? result : US"(no message)";
6869 if (status == FAIL_FORCED)
6870 f.expand_string_forcedfail = TRUE;
6871 else if (status != FAIL)
6872 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6873 argv[0], argv[1], status, expand_string_message);
6877 if (result) yield = string_cat(yield, result);
6880 #endif /* EXPAND_DLFUNC */
6882 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6885 uschar *save_lookup_value = lookup_value;
6887 if (Uskip_whitespace(&s) != '{') /*}*/
6890 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6891 if (!key) goto EXPAND_FAILED; /*{{*/
6894 expand_string_message = US"missing '}' for name arg of env";
6895 goto EXPAND_FAILED_CURLY;
6898 lookup_value = US getenv(CS key);
6900 switch(process_yesno(
6901 skipping, /* were previously skipping */
6902 lookup_value != NULL, /* success/failure indicator */
6903 save_lookup_value, /* value to reset for string2 */
6904 &s, /* input pointer */
6905 &yield, /* output pointer */
6906 US"env", /* condition type */
6909 case 1: goto EXPAND_FAILED; /* when all is well, the */
6910 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6912 if (skipping) continue;
6917 case EITEM_SRS_ENCODE:
6918 /* ${srs_encode {secret} {return_path} {orig_domain}} */
6923 BOOL quoted = FALSE;
6925 switch (read_subs(sub, 3, 3, CUSS &s, skipping, TRUE, name, &resetok))
6927 case 1: goto EXPAND_FAILED_CURLY;
6929 case 3: goto EXPAND_FAILED;
6932 g = string_catn(g, US"SRS0=", 5);
6934 /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
6935 hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
6936 g = string_catn(g, cksum, sizeof(cksum));
6937 g = string_catn(g, US"=", 1);
6939 /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
6945 gettimeofday(&now, NULL);
6946 for (unsigned long i = (now.tv_sec / 86400) & 0x3ff; i; i >>= 5)
6947 h = string_catn(h, &base32_chars[i & 0x1f], 1);
6948 if (h) while (h->ptr > 0)
6949 g = string_catn(g, &h->s[--h->ptr], 1);
6951 g = string_catn(g, US"=", 1);
6953 /* ${domain:$return_path}=${local_part:$return_path} */
6955 int start, end, domain;
6956 uschar * t = parse_extract_address(sub[1], &expand_string_message,
6957 &start, &end, &domain, FALSE);
6963 if (domain > 0) g = string_cat(g, t + domain);
6964 g = string_catn(g, US"=", 1);
6966 s = domain > 0 ? string_copyn(t, domain - 1) : t;
6967 if ((quoted = Ustrchr(s, '"') != NULL))
6970 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
6971 while (*s) /* de-quote */
6973 while (*s && *s != '"') h = string_catn(h, s++, 1);
6975 while (*s && *s != '"') h = string_catn(h, s++, 1);
6978 gstring_release_unused(h);
6979 s = string_from_gstring(h);
6981 g = string_cat(g, s);
6984 /* Assume that if the original local_part had quotes
6985 it was for good reason */
6987 if (quoted) yield = string_catn(yield, US"\"", 1);
6988 yield = string_catn(yield, g->s, g->ptr);
6989 if (quoted) yield = string_catn(yield, US"\"", 1);
6991 /* @$original_domain */
6992 yield = string_catn(yield, US"@", 1);
6993 yield = string_cat(yield, sub[2]);
6995 if (skipping) continue;
6998 #endif /*SUPPORT_SRS*/
7002 } /* EITEM_* switch */
7006 if (yield && (start > 0 || *s)) /* only if not the sole expansion of the line */
7007 debug_expansion_interim(US"item-res",
7008 yield->s + start, yield->ptr - start, skipping);
7014 /* Control reaches here if the name is not recognized as one of the more
7015 complicated expansion items. Check for the "operator" syntax (name terminated
7016 by a colon). Some of the operators have arguments, separated by _ from the
7022 uschar * arg = NULL, * sub;
7024 var_entry * vp = NULL;
7027 /* Owing to an historical mis-design, an underscore may be part of the
7028 operator name, or it may introduce arguments. We therefore first scan the
7029 table of names that contain underscores. If there is no match, we cut off
7030 the arguments and then scan the main table. */
7032 if ((c = chop_match(name, op_table_underscore,
7033 nelem(op_table_underscore))) < 0)
7035 if ((arg = Ustrchr(name, '_')))
7037 if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
7038 c += nelem(op_table_underscore);
7039 if (arg) *arg++ = '_'; /* Put back for error messages */
7042 /* Deal specially with operators that might take a certificate variable
7043 as we do not want to do the usual expansion. For most, expand the string.*/
7053 const uschar * s1 = s;
7054 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
7056 if (!sub) goto EXPAND_FAILED; /*{*/
7059 expand_string_message =
7060 string_sprintf("missing '}' closing cert arg of %s", name);
7061 goto EXPAND_FAILED_CURLY;
7063 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
7073 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
7074 if (!sub) goto EXPAND_FAILED;
7079 /* If we are skipping, we don't need to perform the operation at all.
7080 This matters for operations like "mask", because the data may not be
7081 in the correct format when skipping. For example, the expression may test
7082 for the existence of $sender_host_address before trying to mask it. For
7083 other operations, doing them may not fail, but it is a waste of time. */
7085 if (skipping && c >= 0) continue;
7087 /* Otherwise, switch on the operator type. After handling go back
7088 to the main loop top. */
7091 int start = yield->ptr;
7097 unsigned long int n = Ustrtoul(sub, &t, 10);
7102 expand_string_message = string_sprintf("argument for base32 "
7103 "operator is \"%s\", which is not a decimal number", sub);
7107 g = string_catn(g, &base32_chars[n & 0x1f], 1);
7109 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7116 unsigned long int n = 0;
7119 uschar * t = Ustrchr(base32_chars, *tt++);
7122 expand_string_message = string_sprintf("argument for base32d "
7123 "operator is \"%s\", which is not a base 32 number", sub);
7126 n = n * 32 + (t - base32_chars);
7128 yield = string_fmt_append(yield, "%ld", n);
7135 unsigned long int n = Ustrtoul(sub, &t, 10);
7138 expand_string_message = string_sprintf("argument for base62 "
7139 "operator is \"%s\", which is not a decimal number", sub);
7142 yield = string_cat(yield, string_base62(n));
7146 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7151 unsigned long int n = 0;
7154 uschar *t = Ustrchr(base62_chars, *tt++);
7157 expand_string_message = string_sprintf("argument for base62d "
7158 "operator is \"%s\", which is not a base %d number", sub,
7162 n = n * BASE_62 + (t - base62_chars);
7164 yield = string_fmt_append(yield, "%ld", n);
7170 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
7173 expand_string_message =
7174 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7175 expand_string_message);
7178 yield = string_cat(yield, expanded);
7185 uschar *t = sub - 1;
7186 while (*(++t) != 0) { *t = tolower(*t); count++; }
7187 yield = string_catn(yield, sub, count);
7194 uschar *t = sub - 1;
7195 while (*(++t) != 0) { *t = toupper(*t); count++; }
7196 yield = string_catn(yield, sub, count);
7202 if (vp && *(void **)vp->value)
7204 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7205 yield = string_cat(yield, cp);
7213 md5_end(&base, sub, Ustrlen(sub), digest);
7214 for (int j = 0; j < 16; j++)
7215 yield = string_fmt_append(yield, "%02x", digest[j]);
7221 if (vp && *(void **)vp->value)
7223 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7224 yield = string_cat(yield, cp);
7232 sha1_end(&h, sub, Ustrlen(sub), digest);
7233 for (int j = 0; j < 20; j++)
7234 yield = string_fmt_append(yield, "%02X", digest[j]);
7240 #ifdef EXIM_HAVE_SHA2
7241 if (vp && *(void **)vp->value)
7242 if (c == EOP_SHA256)
7243 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7245 expand_string_message = US"sha2_N not supported with certificates";
7250 hashmethod m = !arg ? HASH_SHA2_256
7251 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7252 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7253 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7256 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7258 expand_string_message = US"unrecognised sha2 variant";
7262 exim_sha_update(&h, sub, Ustrlen(sub));
7263 exim_sha_finish(&h, &b);
7265 yield = string_fmt_append(yield, "%02X", *b.data++);
7268 expand_string_message = US"sha256 only supported with TLS";
7273 #ifdef EXIM_HAVE_SHA3
7277 hashmethod m = !arg ? HASH_SHA3_256
7278 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7279 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7280 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7281 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7284 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7286 expand_string_message = US"unrecognised sha3 variant";
7290 exim_sha_update(&h, sub, Ustrlen(sub));
7291 exim_sha_finish(&h, &b);
7293 yield = string_fmt_append(yield, "%02X", *b.data++);
7297 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7301 /* Convert hex encoding to base64 encoding */
7311 for (enc = sub; *enc; enc++)
7313 if (!isxdigit(*enc))
7315 expand_string_message = string_sprintf("\"%s\" is not a hex "
7324 expand_string_message = string_sprintf("\"%s\" contains an odd "
7325 "number of characters", sub);
7329 while ((c = *in++) != 0)
7331 if (isdigit(c)) c -= '0';
7332 else c = toupper(c) - 'A' + 10;
7342 enc = b64encode(CUS sub, out - sub);
7343 yield = string_cat(yield, enc);
7347 /* Convert octets outside 0x21..0x7E to \xXX form */
7351 uschar *t = sub - 1;
7354 if (*t < 0x21 || 0x7E < *t)
7355 yield = string_fmt_append(yield, "\\x%02x", *t);
7357 yield = string_catn(yield, t, 1);
7362 /* count the number of list elements */
7366 int cnt = 0, sep = 0;
7367 uschar * buf = store_get(2, is_tainted(sub));
7369 while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7370 yield = string_fmt_append(yield, "%d", cnt);
7374 /* expand a named list given the name */
7375 /* handles nested named lists; requotes as colon-sep list */
7378 expand_string_message = NULL;
7379 yield = expand_listnamed(yield, sub, arg);
7380 if (expand_string_message)
7384 /* quote a list-item for the given list-separator */
7386 /* mask applies a mask to an IP address; for example the result of
7387 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7394 int type, mask, maskoffset;
7398 if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7400 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7405 if (maskoffset == 0)
7407 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7412 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7414 if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7416 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7421 /* If an optional 'n' was given, ipv6 gets normalised output:
7422 colons rather than dots, and zero-compressed. */
7424 normalised = arg && *arg == 'n';
7426 /* Convert the address to binary integer(s) and apply the mask */
7428 sub[maskoffset] = 0;
7429 count = host_aton(sub, binary);
7430 host_mask(count, binary, mask);
7432 /* Convert to masked textual format and add to output. */
7434 if (type == 4 || !normalised)
7435 yield = string_catn(yield, buffer,
7436 host_nmtoa(count, binary, mask, buffer, '.'));
7439 ipv6_nmtoa(binary, buffer);
7440 yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7446 case EOP_IPV6DENORM:
7448 int type = string_is_ip_address(sub, NULL);
7455 (void) host_aton(sub, binary);
7458 case 4: /* convert to IPv4-mapped IPv6 */
7459 binary[0] = binary[1] = 0;
7460 binary[2] = 0x0000ffff;
7461 (void) host_aton(sub, binary+3);
7465 expand_string_message =
7466 string_sprintf("\"%s\" is not an IP address", sub);
7470 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7471 ? ipv6_nmtoa(binary, buffer)
7472 : host_nmtoa(4, binary, -1, buffer, ':')
7478 case EOP_LOCAL_PART:
7482 int start, end, domain;
7483 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7486 if (c != EOP_DOMAIN)
7487 yield = c == EOP_LOCAL_PART && domain > 0
7488 ? string_catn(yield, t, domain - 1)
7489 : string_cat(yield, t);
7490 else if (domain > 0)
7491 yield = string_cat(yield, t + domain);
7497 uschar outsep[2] = { ':', '\0' };
7498 uschar *address, *error;
7499 int save_ptr = gstring_length(yield);
7500 int start, end, domain; /* Not really used */
7502 if (Uskip_whitespace(&sub) == '>')
7503 if (*outsep = *++sub) ++sub;
7506 expand_string_message = string_sprintf("output separator "
7507 "missing in expanding ${addresses:%s}", --sub);
7510 f.parse_allow_group = TRUE;
7514 uschar * p = parse_find_address_end(sub, FALSE);
7515 uschar saveend = *p;
7517 address = parse_extract_address(sub, &error, &start, &end, &domain,
7521 /* Add the address to the output list that we are building. This is
7522 done in chunks by searching for the separator character. At the
7523 start, unless we are dealing with the first address of the output
7524 list, add in a space if the new address begins with the separator
7525 character, or is an empty string. */
7529 if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7530 yield = string_catn(yield, US" ", 1);
7534 size_t seglen = Ustrcspn(address, outsep);
7535 yield = string_catn(yield, address, seglen + 1);
7537 /* If we got to the end of the string we output one character
7540 if (address[seglen] == '\0') { yield->ptr--; break; }
7541 yield = string_catn(yield, outsep, 1);
7542 address += seglen + 1;
7545 /* Output a separator after the string: we will remove the
7546 redundant final one at the end. */
7548 yield = string_catn(yield, outsep, 1);
7551 if (saveend == '\0') break;
7555 /* If we have generated anything, remove the redundant final
7558 if (yield && yield->ptr != save_ptr) yield->ptr--;
7559 f.parse_allow_group = FALSE;
7564 /* quote puts a string in quotes if it is empty or contains anything
7565 other than alphamerics, underscore, dot, or hyphen.
7567 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7568 be quoted in order to be a valid local part.
7570 In both cases, newlines and carriage returns are converted into \n and \r
7574 case EOP_QUOTE_LOCAL_PART:
7577 BOOL needs_quote = (!*sub); /* TRUE for empty string */
7578 uschar *t = sub - 1;
7581 while (!needs_quote && *++t)
7582 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7584 else /* EOP_QUOTE_LOCAL_PART */
7585 while (!needs_quote && *++t)
7586 needs_quote = !isalnum(*t)
7587 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7588 && (*t != '.' || t == sub || !t[1]);
7592 yield = string_catn(yield, US"\"", 1);
7596 yield = string_catn(yield, US"\\n", 2);
7597 else if (*t == '\r')
7598 yield = string_catn(yield, US"\\r", 2);
7601 if (*t == '\\' || *t == '"')
7602 yield = string_catn(yield, US"\\", 1);
7603 yield = string_catn(yield, t, 1);
7605 yield = string_catn(yield, US"\"", 1);
7608 yield = string_cat(yield, sub);
7612 /* quote_lookuptype does lookup-specific quoting */
7617 uschar * opt = Ustrchr(arg, '_');
7619 if (opt) *opt++ = 0;
7621 if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7623 expand_string_message = search_error_message;
7627 if (lookup_list[n]->quote)
7628 sub = (lookup_list[n]->quote)(sub, opt);
7634 expand_string_message = string_sprintf(
7635 "\"%s\" unrecognized after \"${quote_%s\"", /*}*/
7640 yield = string_cat(yield, sub);
7644 /* rx quote sticks in \ before any non-alphameric character so that
7645 the insertion works in a regular expression. */
7649 uschar *t = sub - 1;
7653 yield = string_catn(yield, US"\\", 1);
7654 yield = string_catn(yield, t, 1);
7659 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7660 prescribed by the RFC, if there are characters that need to be encoded */
7663 yield = string_cat(yield,
7664 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7668 /* RFC 2047 decode */
7674 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7675 headers_charset, '?', &len, &error);
7678 expand_string_message = error;
7681 yield = string_catn(yield, decoded, len);
7685 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7690 uschar * buff = store_get(4, is_tainted(sub));
7695 if (c > 255) c = '_';
7697 yield = string_catn(yield, buff, 1);
7702 /* replace illegal UTF-8 sequences by replacement character */
7704 #define UTF8_REPLACEMENT_CHAR US"?"
7708 int seq_len = 0, index = 0;
7710 long codepoint = -1;
7712 uschar seq_buff[4]; /* accumulate utf-8 here */
7714 /* Manually track tainting, as we deal in individual chars below */
7716 if (is_tainted(sub))
7718 if (yield->s && yield->ptr)
7719 gstring_rebuffer(yield);
7721 yield->s = store_get(yield->size = Ustrlen(sub), is_tainted(sub));
7724 /* Check the UTF-8, byte-by-byte */
7733 if ((c & 0xc0) != 0x80)
7734 /* wrong continuation byte; invalidate all bytes */
7735 complete = 1; /* error */
7738 codepoint = (codepoint << 6) | (c & 0x3f);
7739 seq_buff[index++] = c;
7740 if (--bytes_left == 0) /* codepoint complete */
7741 if(codepoint > 0x10FFFF) /* is it too large? */
7742 complete = -1; /* error (RFC3629 limit) */
7744 { /* finished; output utf-8 sequence */
7745 yield = string_catn(yield, seq_buff, seq_len);
7750 else /* no bytes left: new sequence */
7752 if(!(c & 0x80)) /* 1-byte sequence, US-ASCII, keep it */
7754 yield = string_catn(yield, &c, 1);
7757 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7759 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7764 codepoint = c & 0x1f;
7767 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7770 codepoint = c & 0x0f;
7772 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7775 codepoint = c & 0x07;
7777 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7780 seq_buff[index++] = c;
7781 seq_len = bytes_left + 1;
7782 } /* if(bytes_left) */
7786 bytes_left = index = 0;
7787 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7789 if ((complete == 1) && ((c & 0x80) == 0))
7790 /* ASCII character follows incomplete sequence */
7791 yield = string_catn(yield, &c, 1);
7793 /* If given a sequence truncated mid-character, we also want to report ?
7794 Eg, ${length_1:フィル} is one byte, not one character, so we expect
7795 ${utf8clean:${length_1:フィル}} to yield '?' */
7797 if (bytes_left != 0)
7798 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7804 case EOP_UTF8_DOMAIN_TO_ALABEL:
7806 uschar * error = NULL;
7807 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7810 expand_string_message = string_sprintf(
7811 "error converting utf8 (%s) to alabel: %s",
7812 string_printing(sub), error);
7815 yield = string_cat(yield, s);
7819 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7821 uschar * error = NULL;
7822 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7825 expand_string_message = string_sprintf(
7826 "error converting alabel (%s) to utf8: %s",
7827 string_printing(sub), error);
7830 yield = string_cat(yield, s);
7834 case EOP_UTF8_LOCALPART_TO_ALABEL:
7836 uschar * error = NULL;
7837 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7840 expand_string_message = string_sprintf(
7841 "error converting utf8 (%s) to alabel: %s",
7842 string_printing(sub), error);
7845 yield = string_cat(yield, s);
7846 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7850 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7852 uschar * error = NULL;
7853 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7856 expand_string_message = string_sprintf(
7857 "error converting alabel (%s) to utf8: %s",
7858 string_printing(sub), error);
7861 yield = string_cat(yield, s);
7864 #endif /* EXPERIMENTAL_INTERNATIONAL */
7866 /* escape turns all non-printing characters into escape sequences. */
7870 const uschar * t = string_printing(sub);
7871 yield = string_cat(yield, t);
7875 case EOP_ESCAPE8BIT:
7879 for (const uschar * s = sub; (c = *s); s++)
7880 yield = c < 127 && c != '\\'
7881 ? string_catn(yield, s, 1)
7882 : string_fmt_append(yield, "\\%03o", c);
7886 /* Handle numeric expression evaluation */
7891 uschar *save_sub = sub;
7892 uschar *error = NULL;
7893 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7896 expand_string_message = string_sprintf("error in expression "
7897 "evaluation: %s (after processing \"%.*s\")", error,
7898 (int)(sub-save_sub), save_sub);
7901 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
7905 /* Handle time period formatting */
7909 int n = readconf_readtime(sub, 0, FALSE);
7912 expand_string_message = string_sprintf("string \"%s\" is not an "
7913 "Exim time interval in \"%s\" operator", sub, name);
7916 yield = string_fmt_append(yield, "%d", n);
7920 case EOP_TIME_INTERVAL:
7923 uschar *t = read_number(&n, sub);
7924 if (*t != 0) /* Not A Number*/
7926 expand_string_message = string_sprintf("string \"%s\" is not a "
7927 "positive number in \"%s\" operator", sub, name);
7930 t = readconf_printtime(n);
7931 yield = string_cat(yield, t);
7935 /* Convert string to base64 encoding */
7941 uschar * s = vp && *(void **)vp->value
7942 ? tls_cert_der_b64(*(void **)vp->value)
7943 : b64encode(CUS sub, Ustrlen(sub));
7945 uschar * s = b64encode(CUS sub, Ustrlen(sub));
7947 yield = string_cat(yield, s);
7954 int len = b64decode(sub, &s);
7957 expand_string_message = string_sprintf("string \"%s\" is not "
7958 "well-formed for \"%s\" operator", sub, name);
7961 yield = string_cat(yield, s);
7965 /* strlen returns the length of the string */
7968 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
7971 /* length_n or l_n takes just the first n characters or the whole string,
7972 whichever is the shorter;
7974 substr_m_n, and s_m_n take n characters from offset m; negative m take
7975 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7976 takes the rest, either to the right or to the left.
7978 hash_n or h_n makes a hash of length n from the string, yielding n
7979 characters from the set a-z; hash_n_m makes a hash of length n, but
7980 uses m characters from the set a-zA-Z0-9.
7982 nhash_n returns a single number between 0 and n-1 (in text form), while
7983 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7984 between 0 and n-1 and the second between 0 and m-1. */
8004 expand_string_message = string_sprintf("missing values after %s",
8009 /* "length" has only one argument, effectively being synonymous with
8012 if (c == EOP_LENGTH || c == EOP_L)
8018 /* The others have one or two arguments; for "substr" the first may be
8019 negative. The second being negative means "not supplied". */
8024 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8027 /* Read up to two numbers, separated by underscores */
8032 if (arg != ret && *arg == '_' && pn == &value1)
8036 if (arg[1] != 0) arg++;
8038 else if (!isdigit(*arg))
8040 expand_string_message =
8041 string_sprintf("non-digit after underscore in \"%s\"", name);
8044 else *pn = (*pn)*10 + *arg++ - '0';
8048 /* Perform the required operation */
8050 ret = c == EOP_HASH || c == EOP_H
8051 ? compute_hash(sub, value1, value2, &len)
8052 : c == EOP_NHASH || c == EOP_NH
8053 ? compute_nhash(sub, value1, value2, &len)
8054 : extract_substr(sub, value1, value2, &len);
8055 if (!ret) goto EXPAND_FAILED;
8057 yield = string_catn(yield, ret, len);
8066 uschar **modetable[3];
8070 if (expand_forbid & RDO_EXISTS)
8072 expand_string_message = US"Use of the stat() expansion is not permitted";
8076 if (stat(CS sub, &st) < 0)
8078 expand_string_message = string_sprintf("stat(%s) failed: %s",
8079 sub, strerror(errno));
8083 switch (mode & S_IFMT)
8085 case S_IFIFO: smode[0] = 'p'; break;
8086 case S_IFCHR: smode[0] = 'c'; break;
8087 case S_IFDIR: smode[0] = 'd'; break;
8088 case S_IFBLK: smode[0] = 'b'; break;
8089 case S_IFREG: smode[0] = '-'; break;
8090 default: smode[0] = '?'; break;
8093 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8094 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8095 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8097 for (int i = 0; i < 3; i++)
8099 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8104 yield = string_fmt_append(yield,
8105 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8106 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8107 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8108 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8109 (long)st.st_gid, st.st_size, (long)st.st_atime,
8110 (long)st.st_mtime, (long)st.st_ctime);
8114 /* vaguely random number less than N */
8118 int_eximarith_t max = expanded_string_integer(sub, TRUE);
8120 if (expand_string_message)
8122 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8126 /* Reverse IP, including IPv6 to dotted-nibble */
8128 case EOP_REVERSE_IP:
8130 int family, maskptr;
8131 uschar reversed[128];
8133 family = string_is_ip_address(sub, &maskptr);
8136 expand_string_message = string_sprintf(
8137 "reverse_ip() not given an IP address [%s]", sub);
8140 invert_address(reversed, sub);
8141 yield = string_cat(yield, reversed);
8145 /* Unknown operator */
8148 expand_string_message =
8149 string_sprintf("unknown expansion operator \"%s\"", name);
8151 } /* EOP_* switch */
8154 if (start > 0 || *s) /* only if not the sole expansion of the line */
8155 debug_expansion_interim(US"op-res",
8156 yield->s + start, yield->ptr - start, skipping);
8161 /* Not an item or an operator */
8162 /* Handle a plain name. If this is the first thing in the expansion, release
8163 the pre-allocated buffer. If the result data is known to be in a new buffer,
8164 newsize will be set to the size of that buffer, and we can just point at that
8165 store instead of copying. Many expansion strings contain just one reference,
8166 so this is a useful optimization, especially for humungous headers
8167 ($message_headers). */
8171 const uschar * value;
8177 g = store_get(sizeof(gstring), FALSE);
8178 else if (yield->ptr == 0)
8180 if (resetok) reset_point = store_reset(reset_point);
8182 reset_point = store_mark();
8183 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
8185 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
8187 expand_string_message =
8188 string_sprintf("unknown variable in \"${%s}\"", name);
8189 check_variable_error_message(name);
8192 len = Ustrlen(value);
8193 if (!yield && newsize)
8196 yield->size = newsize;
8198 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8201 yield = string_catn(yield, value, len);
8205 /* Else there's something wrong */
8207 expand_string_message =
8208 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8209 "in a variable reference)", name);
8213 /* If we hit the end of the string when ket_ends is set, there is a missing
8214 terminating brace. */
8216 if (ket_ends && !*s)
8218 expand_string_message = malformed_header
8219 ? US"missing } at end of string - could be header name not terminated by colon"
8220 : US"missing } at end of string";
8224 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8225 added to the string. If so, set up an empty string. Add a terminating zero. If
8226 left != NULL, return a pointer to the terminator. */
8229 yield = string_get(1);
8230 (void) string_from_gstring(yield);
8231 if (left) *left = s;
8233 /* Any stacking store that was used above the final string is no longer needed.
8234 In many cases the final string will be the first one that was got and so there
8235 will be optimal store usage. */
8237 if (resetok) gstring_release_unused(yield);
8238 else if (resetok_p) *resetok_p = FALSE;
8242 BOOL tainted = is_tainted(yield->s);
8245 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8246 debug_printf_indent("%sresult: %s\n",
8247 skipping ? "|-----" : "\\_____", yield->s);
8249 debug_printf_indent("%s \\__(tainted)\n",
8250 skipping ? "| " : " ");
8252 debug_printf_indent("\\___skipping: result is not used\n");
8256 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8257 "expanding: %.*s\n",
8258 (int)(s - string), string);
8259 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8261 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8264 debug_printf_indent("%s(tainted)\n",
8266 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8268 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8269 "skipping: result is not used\n");
8275 /* This is the failure exit: easiest to program with a goto. We still need
8276 to update the pointer to the terminator, for cases of nested calls with "fail".
8279 EXPAND_FAILED_CURLY:
8280 if (malformed_header)
8281 expand_string_message =
8282 US"missing or misplaced { or } - could be header name not terminated by colon";
8284 else if (!expand_string_message || !*expand_string_message)
8285 expand_string_message = US"missing or misplaced { or }";
8287 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8288 that is a bad idea, because expand_string_message is in dynamic store. */
8291 if (left) *left = s;
8296 debug_printf_indent("|failed to expand: %s\n", string);
8297 debug_printf_indent("%serror message: %s\n",
8298 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8299 if (f.expand_string_forcedfail)
8300 debug_printf_indent("\\failure was forced\n");
8304 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8306 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8307 "error message: %s\n",
8308 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8309 expand_string_message);
8310 if (f.expand_string_forcedfail)
8311 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8314 if (resetok_p && !resetok) *resetok_p = FALSE;
8320 /* This is the external function call. Do a quick check for any expansion
8321 metacharacters, and if there are none, just return the input string.
8323 Argument: the string to be expanded
8324 Returns: the expanded string, or NULL if expansion failed; if failure was
8325 due to a lookup deferring, search_find_defer will be TRUE
8329 expand_cstring(const uschar * string)
8331 if (Ustrpbrk(string, "$\\") != NULL)
8333 int old_pool = store_pool;
8336 f.search_find_defer = FALSE;
8337 malformed_header = FALSE;
8338 store_pool = POOL_MAIN;
8339 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
8340 store_pool = old_pool;
8348 expand_string(uschar * string)
8350 return US expand_cstring(CUS string);
8357 /*************************************************
8359 *************************************************/
8361 /* Now and again we want to expand a string and be sure that the result is in a
8362 new bit of store. This function does that.
8363 Since we know it has been copied, the de-const cast is safe.
8365 Argument: the string to be expanded
8366 Returns: the expanded string, always in a new bit of store, or NULL
8370 expand_string_copy(const uschar *string)
8372 const uschar *yield = expand_cstring(string);
8373 if (yield == string) yield = string_copy(string);
8379 /*************************************************
8380 * Expand and interpret as an integer *
8381 *************************************************/
8383 /* Expand a string, and convert the result into an integer.
8386 string the string to be expanded
8387 isplus TRUE if a non-negative number is expected
8389 Returns: the integer value, or
8390 -1 for an expansion error ) in both cases, message in
8391 -2 for an integer interpretation error ) expand_string_message
8392 expand_string_message is set NULL for an OK integer
8396 expand_string_integer(uschar *string, BOOL isplus)
8398 return expanded_string_integer(expand_string(string), isplus);
8402 /*************************************************
8403 * Interpret string as an integer *
8404 *************************************************/
8406 /* Convert a string (that has already been expanded) into an integer.
8408 This function is used inside the expansion code.
8411 s the string to be expanded
8412 isplus TRUE if a non-negative number is expected
8414 Returns: the integer value, or
8415 -1 if string is NULL (which implies an expansion error)
8416 -2 for an integer interpretation error
8417 expand_string_message is set NULL for an OK integer
8420 static int_eximarith_t
8421 expanded_string_integer(const uschar *s, BOOL isplus)
8423 int_eximarith_t value;
8424 uschar *msg = US"invalid integer \"%s\"";
8427 /* If expansion failed, expand_string_message will be set. */
8431 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8432 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8433 systems, so we set it zero ourselves. */
8436 expand_string_message = NULL; /* Indicates no error */
8438 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8439 equal to 0. Unfortunately, people actually relied upon that, so preserve
8440 the behaviour explicitly. Stripping leading whitespace is a harmless
8441 noop change since strtol skips it anyway (provided that there is a number
8444 if (Uskip_whitespace(&s) == '\0')
8447 debug_printf_indent("treating blank string as number 0\n");
8451 value = strtoll(CS s, CSS &endptr, 10);
8454 msg = US"integer expected but \"%s\" found";
8455 else if (value < 0 && isplus)
8456 msg = US"non-negative integer expected but \"%s\" found";
8459 switch (tolower(*endptr))
8464 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8469 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8470 else value *= 1024*1024;
8474 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8475 else value *= 1024*1024*1024;
8479 if (errno == ERANGE)
8480 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8482 if (Uskip_whitespace(&endptr) == 0) return value;
8485 expand_string_message = string_sprintf(CS msg, s);
8490 /* These values are usually fixed boolean values, but they are permitted to be
8494 addr address being routed
8495 mtype the module type
8496 mname the module name
8497 dbg_opt debug selectors
8498 oname the option name
8499 bvalue the router's boolean value
8500 svalue the router's string value
8501 rvalue where to put the returned value
8503 Returns: OK value placed in rvalue
8504 DEFER expansion failed
8508 exp_bool(address_item *addr,
8509 uschar *mtype, uschar *mname, unsigned dbg_opt,
8510 uschar *oname, BOOL bvalue,
8511 uschar *svalue, BOOL *rvalue)
8514 if (!svalue) { *rvalue = bvalue; return OK; }
8516 if (!(expanded = expand_string(svalue)))
8518 if (f.expand_string_forcedfail)
8520 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8524 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8525 oname, mname, mtype, expand_string_message);
8526 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8530 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8533 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8535 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8539 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8540 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8549 /* Avoid potentially exposing a password in a string about to be logged */
8552 expand_hide_passwords(uschar * s)
8554 return ( ( Ustrstr(s, "failed to expand") != NULL
8555 || Ustrstr(s, "expansion of ") != NULL
8557 && ( Ustrstr(s, "mysql") != NULL
8558 || Ustrstr(s, "pgsql") != NULL
8559 || Ustrstr(s, "redis") != NULL
8560 || Ustrstr(s, "sqlite") != NULL
8561 || Ustrstr(s, "ldap:") != NULL
8562 || Ustrstr(s, "ldaps:") != NULL
8563 || Ustrstr(s, "ldapi:") != NULL
8564 || Ustrstr(s, "ldapdn:") != NULL
8565 || Ustrstr(s, "ldapm:") != NULL
8567 ? US"Temporary internal error" : s;
8571 /* Read given named file into big_buffer. Use for keying material etc.
8572 The content will have an ascii NUL appended.
8577 Return: pointer to buffer, or NULL on error.
8581 expand_file_big_buffer(const uschar * filename)
8583 int fd, off = 0, len;
8585 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8587 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8594 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8597 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8605 big_buffer[off] = '\0';
8611 /*************************************************
8612 * Error-checking for testsuite *
8613 *************************************************/
8615 uschar * region_start;
8616 uschar * region_end;
8617 const uschar *var_name;
8618 const uschar *var_data;
8621 /* Called via tree_walk, which allows nonconst name/data. Our usage is const. */
8623 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8626 if (var_data >= e->region_start && var_data < e->region_end)
8628 e->var_name = CUS var_name;
8629 e->var_data = CUS var_data;
8634 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8636 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8637 .var_name = NULL, .var_data = NULL };
8639 /* check acl_ variables */
8640 tree_walk(acl_var_c, assert_variable_notin, &e);
8641 tree_walk(acl_var_m, assert_variable_notin, &e);
8643 /* check auth<n> variables.
8644 assert_variable_notin() treats as const, so deconst is safe. */
8645 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8646 assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8648 /* check regex<n> variables. assert_variable_notin() treats as const. */
8649 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8650 assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8652 /* check known-name variables */
8653 for (var_entry * v = var_table; v < var_table + var_table_size; v++)
8654 if (v->type == vtype_stringptr)
8655 assert_variable_notin(US v->name, *(USS v->value), &e);
8657 /* check dns and address trees */
8658 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8659 tree_walk(tree_duplicates, assert_variable_notin, &e);
8660 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8661 tree_walk(tree_unusable, assert_variable_notin, &e);
8664 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8665 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8666 e.var_name, filename, linenumber, e.var_data);
8671 /*************************************************
8672 **************************************************
8673 * Stand-alone test program *
8674 **************************************************
8675 *************************************************/
8681 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8683 int ovec[3*(EXPAND_MAXN+1)];
8684 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8686 BOOL yield = n >= 0;
8687 if (n == 0) n = EXPAND_MAXN + 1;
8690 expand_nmax = setup < 0 ? 0 : setup + 1;
8691 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8693 expand_nstring[expand_nmax] = subject + ovec[nn];
8694 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8702 int main(int argc, uschar **argv)
8704 uschar buffer[1024];
8706 debug_selector = D_v;
8707 debug_file = stderr;
8708 debug_fd = fileno(debug_file);
8709 big_buffer = malloc(big_buffer_size);
8712 for (int i = 1; i < argc; i++)
8714 if (argv[i][0] == '+')
8716 debug_trace_memory = 2;
8719 if (isdigit(argv[i][0]))
8720 debug_selector = Ustrtol(argv[i], NULL, 0);
8722 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8726 eldap_default_servers = argv[i];
8729 mysql_servers = argv[i];
8732 pgsql_servers = argv[i];
8735 redis_servers = argv[i];
8739 else opt_perl_startup = argv[i];
8743 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8745 expand_nstring[1] = US"string 1....";
8746 expand_nlength[1] = 8;
8750 if (opt_perl_startup != NULL)
8753 printf("Starting Perl interpreter\n");
8754 errstr = init_perl(opt_perl_startup);
8757 printf("** error in perl_startup code: %s\n", errstr);
8758 return EXIT_FAILURE;
8761 #endif /* EXIM_PERL */
8763 /* Thie deliberately regards the input as untainted, so that it can be
8764 expanded; only reasonable since this is a test for string-expansions. */
8766 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8768 rmark reset_point = store_mark();
8769 uschar *yield = expand_string(buffer);
8771 printf("%s\n", yield);
8774 if (f.search_find_defer) printf("search_find deferred\n");
8775 printf("Failed: %s\n", expand_string_message);
8776 if (f.expand_string_forcedfail) printf("Forced failure\n");
8779 store_reset(reset_point);
8791 /* End of expand.c */