1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2022 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
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, GET_TAINTED);
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, GET_TAINTED);
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]); break;
2904 tempcond = (num[0] > num[1]); break;
2907 tempcond = (num[0] >= num[1]); break;
2910 tempcond = (num[0] < num[1]); break;
2913 tempcond = (num[0] <= num[1]); break;
2916 tempcond = (Ustrcmp(sub[0], sub[1]) < 0); break;
2919 tempcond = (strcmpic(sub[0], sub[1]) < 0); break;
2922 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0); break;
2925 tempcond = (strcmpic(sub[0], sub[1]) <= 0); break;
2928 tempcond = (Ustrcmp(sub[0], sub[1]) == 0); break;
2931 tempcond = (strcmpic(sub[0], sub[1]) == 0); break;
2934 tempcond = (Ustrcmp(sub[0], sub[1]) > 0); break;
2937 tempcond = (strcmpic(sub[0], sub[1]) > 0); break;
2940 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0); break;
2943 tempcond = (strcmpic(sub[0], sub[1]) >= 0); break;
2945 case ECOND_MATCH: /* Regular expression match */
2947 const pcre2_code * re;
2951 if (!(re = pcre2_compile((PCRE2_SPTR)sub[1], PCRE2_ZERO_TERMINATED,
2952 PCRE_COPT, &err, &offset, pcre_cmp_ctx)))
2955 pcre2_get_error_message(err, errbuf, sizeof(errbuf));
2956 expand_string_message = string_sprintf("regular expression error in "
2957 "\"%s\": %s at offset %ld", sub[1], errbuf, (long)offset);
2961 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2965 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2966 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0,
2967 CUSS &lookup_value);
2968 goto MATCHED_SOMETHING;
2970 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2971 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2972 MCL_DOMAIN + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
2973 goto MATCHED_SOMETHING;
2975 case ECOND_MATCH_IP: /* Match IP address in a host list */
2976 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2978 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2984 unsigned int *nullcache = NULL;
2985 check_host_block cb;
2987 cb.host_name = US"";
2988 cb.host_address = sub[0];
2990 /* If the host address starts off ::ffff: it is an IPv6 address in
2991 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2994 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2995 cb.host_address + 7 : cb.host_address;
2997 rc = match_check_list(
2998 &sub[1], /* the list */
2999 0, /* separator character */
3000 &hostlist_anchor, /* anchor pointer */
3001 &nullcache, /* cache pointer */
3002 check_host, /* function for testing */
3003 &cb, /* argument for function */
3004 MCL_HOST, /* type of check */
3005 sub[0], /* text for debugging */
3006 CUSS &lookup_value); /* where to pass back data */
3008 goto MATCHED_SOMETHING;
3010 case ECOND_MATCH_LOCAL_PART:
3011 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3012 MCL_LOCALPART + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3018 case OK: tempcond = TRUE; break;
3019 case FAIL: tempcond = FALSE; break;
3022 expand_string_message = string_sprintf("unable to complete match "
3023 "against \"%s\": %s", sub[1], search_error_message);
3029 /* Various "encrypted" comparisons. If the second string starts with
3030 "{" then an encryption type is given. Default to crypt() or crypt16()
3031 (build-time choice). */
3032 /* }-for-text-editors */
3035 #ifndef SUPPORT_CRYPTEQ
3036 goto COND_FAILED_NOT_COMPILED;
3038 if (strncmpic(sub[1], US"{md5}", 5) == 0)
3040 int sublen = Ustrlen(sub[1]+5);
3045 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3047 /* If the length that we are comparing against is 24, the MD5 digest
3048 is expressed as a base64 string. This is the way LDAP does it. However,
3049 some other software uses a straightforward hex representation. We assume
3050 this if the length is 32. Other lengths fail. */
3054 uschar *coded = b64encode(CUS digest, 16);
3055 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3056 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3057 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3059 else if (sublen == 32)
3062 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3064 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3065 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3066 tempcond = (strcmpic(coded, sub[1]+5) == 0);
3070 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3071 "fail\n crypted=%s\n", sub[1]+5);
3076 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3078 int sublen = Ustrlen(sub[1]+6);
3083 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3085 /* If the length that we are comparing against is 28, assume the SHA1
3086 digest is expressed as a base64 string. If the length is 40, assume a
3087 straightforward hex representation. Other lengths fail. */
3091 uschar *coded = b64encode(CUS digest, 20);
3092 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3093 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3094 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3096 else if (sublen == 40)
3099 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3101 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3102 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3103 tempcond = (strcmpic(coded, sub[1]+6) == 0);
3107 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3108 "fail\n crypted=%s\n", sub[1]+6);
3113 else /* {crypt} or {crypt16} and non-{ at start */
3114 /* }-for-text-editors */
3119 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3124 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3129 else if (sub[1][0] == '{') /* }-for-text-editors */
3131 expand_string_message = string_sprintf("unknown encryption mechanism "
3132 "in \"%s\"", sub[1]);
3138 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3139 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
3140 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3144 #define XSTR(s) STR(s)
3145 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3146 " subject=%s\n crypted=%s\n",
3147 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3152 /* If the encrypted string contains fewer than two characters (for the
3153 salt), force failure. Otherwise we get false positives: with an empty
3154 string the yield of crypt() is an empty string! */
3157 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3158 else if (errno == EINVAL)
3162 expand_string_message = string_sprintf("crypt error: %s\n",
3163 US strerror(errno));
3168 #endif /* SUPPORT_CRYPTEQ */
3173 const uschar * list = sub[1];
3175 uschar *save_iterate_item = iterate_item;
3176 int (*compare)(const uschar *, const uschar *);
3178 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);
3181 compare = cond_type == ECOND_INLISTI
3182 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3184 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3186 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3187 if (compare(sub[0], iterate_item) == 0)
3190 lookup_value = iterate_item;
3194 iterate_item = save_iterate_item;
3197 } /* Switch for comparison conditions */
3199 *yield = tempcond == testfor;
3200 return s; /* End of comparison conditions */
3203 /* and/or: computes logical and/or of several conditions */
3207 subcondptr = (yield == NULL) ? NULL : &tempcond;
3208 combined_cond = (cond_type == ECOND_AND);
3210 Uskip_whitespace(&s);
3211 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3215 /* {-for-text-editors */
3216 if (Uskip_whitespace(&s) == '}') break;
3217 if (*s != '{') /* }-for-text-editors */
3219 expand_string_message = string_sprintf("each subcondition "
3220 "inside an \"%s{...}\" condition must be in its own {}", opname);
3224 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3226 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3227 expand_string_message, opname);
3230 Uskip_whitespace(&s);
3232 /* {-for-text-editors */
3235 /* {-for-text-editors */
3236 expand_string_message = string_sprintf("missing } at end of condition "
3237 "inside \"%s\" group", opname);
3242 if (cond_type == ECOND_AND)
3244 combined_cond &= tempcond;
3245 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3246 } /* evaluate any more */
3249 combined_cond |= tempcond;
3250 if (combined_cond) subcondptr = NULL; /* once true, don't */
3251 } /* evaluate any more */
3254 if (yield) *yield = (combined_cond == testfor);
3258 /* forall/forany: iterates a condition with different values */
3260 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3261 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3262 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3263 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3264 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3265 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3269 const uschar * list;
3271 uschar *save_iterate_item = iterate_item;
3273 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3275 Uskip_whitespace(&s);
3276 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3277 if (!(sub[0] = expand_string_internal(s, TRUE, &s, yield == NULL, TRUE, resetok)))
3279 /* {-for-text-editors */
3280 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3282 Uskip_whitespace(&s);
3283 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3287 /* Call eval_condition once, with result discarded (as if scanning a
3288 "false" part). This allows us to find the end of the condition, because if
3289 the list it empty, we won't actually evaluate the condition for real. */
3291 if (!(s = eval_condition(sub[1], resetok, NULL)))
3293 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3294 expand_string_message, opname);
3297 Uskip_whitespace(&s);
3299 /* {-for-text-editors */
3302 /* {-for-text-editors */
3303 expand_string_message = string_sprintf("missing } at end of condition "
3304 "inside \"%s\"", opname);
3308 if (yield) *yield = !testfor;
3310 if (is_json) list = dewrap(string_copy(list), US"[]");
3311 while ((iterate_item = is_json
3312 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3315 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3317 expand_string_message =
3318 string_sprintf("%s wrapping string result for extract jsons",
3319 expand_string_message);
3320 iterate_item = save_iterate_item;
3324 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3325 if (!eval_condition(sub[1], resetok, &tempcond))
3327 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3328 expand_string_message, opname);
3329 iterate_item = save_iterate_item;
3332 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3333 tempcond? "true":"false");
3335 if (yield) *yield = (tempcond == testfor);
3336 if (tempcond == is_forany) break;
3339 iterate_item = save_iterate_item;
3344 /* The bool{} expansion condition maps a string to boolean.
3345 The values supported should match those supported by the ACL condition
3346 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3347 of true/false. Note that Router "condition" rules have a different
3348 interpretation, where general data can be used and only a few values
3350 Note that readconf.c boolean matching, for boolean configuration options,
3351 only matches true/yes/false/no.
3352 The bool_lax{} condition matches the Router logic, which is much more
3355 case ECOND_BOOL_LAX:
3361 BOOL boolvalue = FALSE;
3363 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3364 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3365 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3367 case 1: expand_string_message = string_sprintf(
3368 "too few arguments or bracketing error for %s",
3372 case 3: return NULL;
3375 Uskip_whitespace(&t);
3376 if ((len = Ustrlen(t)))
3378 /* trailing whitespace: seems like a good idea to ignore it too */
3380 while (isspace(*t2)) t2--;
3381 if (t2 != (t + len))
3388 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3389 /* logic for the lax case from expand_check_condition(), which also does
3390 expands, and the logic is both short and stable enough that there should
3391 be no maintenance burden from replicating it. */
3395 ? Ustrspn(t+1, "0123456789") == len-1
3396 : Ustrspn(t, "0123456789") == len)
3398 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3399 /* expand_check_condition only does a literal string "0" check */
3400 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3403 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3405 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3407 else if (cond_type == ECOND_BOOL_LAX)
3411 expand_string_message = string_sprintf("unrecognised boolean "
3415 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3416 boolvalue? "true":"false");
3417 if (yield) *yield = (boolvalue == testfor);
3422 case ECOND_INBOUND_SRS:
3423 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */
3426 const pcre2_code * re;
3427 pcre2_match_data * md;
3431 BOOL boolvalue = FALSE;
3433 switch(read_subs(sub, 2, 2, CUSS &s, yield == NULL, FALSE, name, resetok))
3435 case 1: expand_string_message = US"too few arguments or bracketing "
3436 "error for inbound_srs";
3438 case 3: return NULL;
3441 /* Match the given local_part against the SRS-encoded pattern */
3443 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]+)=([^=]*)=(.*)$",
3445 md = pcre2_match_data_create(4+1, pcre_gen_ctx);
3446 if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,
3447 md, pcre_mtc_ctx) < 0)
3449 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3452 ovec = pcre2_get_ovector_pointer(md);
3454 if (sub[0][0] == '"')
3456 else for (uschar * s = sub[0]; *s; s++)
3457 if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3458 { quoting = 1; break; }
3460 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3462 /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3464 srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S", /* lowercased */
3466 (int) (ovec[9]-ovec[8]), sub[0] + ovec[8], /* substr 4 */
3468 (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */
3470 /* If a zero-length secret was given, we're done. Otherwise carry on
3471 and validate the given SRS local_part againt our secret. */
3479 /* check the timestamp */
3482 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3486 gettimeofday(&now, NULL);
3487 now.tv_sec /= 86400; /* days since epoch */
3489 /* Decode substring 2 from base32 to a number */
3491 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3493 uschar * t = Ustrchr(base32_chars, *ss++);
3494 d = d * 32 + (t - base32_chars);
3497 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3499 DEBUG(D_expand) debug_printf("SRS too old\n");
3504 /* check length of substring 1, the offered checksum */
3506 if (ovec[3]-ovec[2] != 4)
3508 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3512 /* Hash the address with our secret, and compare that computed checksum
3513 with the one extracted from the arg */
3515 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3516 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3518 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3524 if (yield) *yield = (boolvalue == testfor);
3527 #endif /*SUPPORT_SRS*/
3529 /* Unknown condition */
3532 if (!expand_string_message || !*expand_string_message)
3533 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3535 } /* End switch on condition type */
3537 /* Missing braces at start and end of data */
3539 COND_FAILED_CURLY_START:
3540 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3543 COND_FAILED_CURLY_END:
3544 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3548 /* A condition requires code that is not compiled */
3550 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3551 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3552 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3553 COND_FAILED_NOT_COMPILED:
3554 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3563 /*************************************************
3564 * Save numerical variables *
3565 *************************************************/
3567 /* This function is called from items such as "if" that want to preserve and
3568 restore the numbered variables.
3571 save_expand_string points to an array of pointers to set
3572 save_expand_nlength points to an array of ints for the lengths
3574 Returns: the value of expand max to save
3578 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3580 for (int i = 0; i <= expand_nmax; i++)
3582 save_expand_nstring[i] = expand_nstring[i];
3583 save_expand_nlength[i] = expand_nlength[i];
3590 /*************************************************
3591 * Restore numerical variables *
3592 *************************************************/
3594 /* This function restored saved values of numerical strings.
3597 save_expand_nmax the number of strings to restore
3598 save_expand_string points to an array of pointers
3599 save_expand_nlength points to an array of ints
3605 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3606 int *save_expand_nlength)
3608 expand_nmax = save_expand_nmax;
3609 for (int i = 0; i <= expand_nmax; i++)
3611 expand_nstring[i] = save_expand_nstring[i];
3612 expand_nlength[i] = save_expand_nlength[i];
3620 /*************************************************
3621 * Handle yes/no substrings *
3622 *************************************************/
3624 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3625 alternative substrings that depend on whether or not the condition was true,
3626 or the lookup or extraction succeeded. The substrings always have to be
3627 expanded, to check their syntax, but "skipping" is set when the result is not
3628 needed - this avoids unnecessary nested lookups.
3631 skipping TRUE if we were skipping when this item was reached
3632 yes TRUE if the first string is to be used, else use the second
3633 save_lookup a value to put back into lookup_value before the 2nd expansion
3634 sptr points to the input string pointer
3635 yieldptr points to the output growable-string pointer
3636 type "lookup", "if", "extract", "run", "env", "listextract" or
3637 "certextract" for error message
3638 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3641 Returns: 0 OK; lookup_value has been reset to save_lookup
3643 2 expansion failed because of bracketing error
3647 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3648 gstring ** yieldptr, uschar *type, BOOL *resetok)
3651 const uschar *s = *sptr; /* Local value */
3652 uschar *sub1, *sub2;
3653 const uschar * errwhere;
3655 /* If there are no following strings, we substitute the contents of $value for
3656 lookups and for extractions in the success case. For the ${if item, the string
3657 "true" is substituted. In the fail case, nothing is substituted for all three
3660 if (skip_whitespace(&s) == '}')
3664 if (yes && !skipping)
3665 *yieldptr = string_catn(*yieldptr, US"true", 4);
3669 if (yes && lookup_value && !skipping)
3670 *yieldptr = string_cat(*yieldptr, lookup_value);
3671 lookup_value = save_lookup;
3677 /* The first following string must be braced. */
3681 errwhere = US"'yes' part did not start with '{'";
3685 /* Expand the first substring. Forced failures are noticed only if we actually
3686 want this string. Set skipping in the call in the fail case (this will always
3687 be the case if we were already skipping). */
3689 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3690 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3691 f.expand_string_forcedfail = FALSE;
3694 errwhere = US"'yes' part did not end with '}'";
3698 /* If we want the first string, add it to the output */
3701 *yieldptr = string_cat(*yieldptr, sub1);
3703 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3704 $value to what it was at the start of the item, so that it has this value
3705 during the second string expansion. For the call from "if" or "run" to this
3706 function, save_lookup is set to lookup_value, so that this statement does
3709 lookup_value = save_lookup;
3711 /* There now follows either another substring, or "fail", or nothing. This
3712 time, forced failures are noticed only if we want the second string. We must
3713 set skipping in the nested call if we don't want this string, or if we were
3714 already skipping. */
3716 if (skip_whitespace(&s) == '{')
3718 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3719 if (sub2 == NULL && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3720 f.expand_string_forcedfail = FALSE;
3723 errwhere = US"'no' part did not start with '{'";
3727 /* If we want the second string, add it to the output */
3730 *yieldptr = string_cat(*yieldptr, sub2);
3733 /* If there is no second string, but the word "fail" is present when the use of
3734 the second string is wanted, set a flag indicating it was a forced failure
3735 rather than a syntactic error. Swallow the terminating } in case this is nested
3736 inside another lookup or if or extract. */
3741 /* deconst cast ok here as source is s anyway */
3742 s = US read_name(name, sizeof(name), s, US"_");
3743 if (Ustrcmp(name, "fail") == 0)
3745 if (!yes && !skipping)
3747 Uskip_whitespace(&s);
3750 errwhere = US"did not close with '}' after forcedfail";
3753 expand_string_message =
3754 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3755 f.expand_string_forcedfail = TRUE;
3761 expand_string_message =
3762 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3767 /* All we have to do now is to check on the final closing brace. */
3769 skip_whitespace(&s);
3772 errwhere = US"did not close with '}'";
3778 /* Update the input pointer value before returning */
3783 /* Get here if there is a bracketing failure */
3784 expand_string_message = string_sprintf(
3785 "curly-bracket problem in conditional yes/no parsing: %s\n"
3786 " remaining string is '%s'", errwhere, --s);
3791 /* Get here for other failures */
3799 /********************************************************
3800 * prvs: Get last three digits of days since Jan 1, 1970 *
3801 ********************************************************/
3803 /* This is needed to implement the "prvs" BATV reverse
3806 Argument: integer "days" offset to add or substract to
3807 or from the current number of days.
3809 Returns: pointer to string containing the last three
3810 digits of the number of days since Jan 1, 1970,
3811 modified by the offset argument, NULL if there
3812 was an error in the conversion.
3817 prvs_daystamp(int day_offset)
3819 uschar * days = store_get(32, GET_UNTAINTED); /* Need at least 24 for cases */
3820 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3821 (time(NULL) + day_offset*86400)/86400);
3822 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3827 /********************************************************
3828 * prvs: perform HMAC-SHA1 computation of prvs bits *
3829 ********************************************************/
3831 /* This is needed to implement the "prvs" BATV reverse
3835 address RFC2821 Address to use
3836 key The key to use (must be less than 64 characters
3838 key_num Single-digit key number to use. Defaults to
3841 Returns: pointer to string containing the first three
3842 bytes of the final hash in hex format, NULL if
3843 there was an error in the process.
3847 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3849 gstring * hash_source;
3852 uschar innerhash[20];
3853 uschar finalhash[20];
3854 uschar innerkey[64];
3855 uschar outerkey[64];
3856 uschar *finalhash_hex;
3861 if (Ustrlen(key) > 64)
3864 hash_source = string_catn(NULL, key_num, 1);
3865 hash_source = string_catn(hash_source, daystamp, 3);
3866 hash_source = string_cat(hash_source, address);
3867 (void) string_from_gstring(hash_source);
3870 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3872 memset(innerkey, 0x36, 64);
3873 memset(outerkey, 0x5c, 64);
3875 for (int i = 0; i < Ustrlen(key); i++)
3877 innerkey[i] ^= key[i];
3878 outerkey[i] ^= key[i];
3881 chash_start(HMAC_SHA1, &h);
3882 chash_mid(HMAC_SHA1, &h, innerkey);
3883 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3885 chash_start(HMAC_SHA1, &h);
3886 chash_mid(HMAC_SHA1, &h, outerkey);
3887 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3889 /* Hashing is deemed sufficient to de-taint any input data */
3891 p = finalhash_hex = store_get(40, GET_UNTAINTED);
3892 for (int i = 0; i < 3; i++)
3894 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3895 *p++ = hex_digits[finalhash[i] & 0x0f];
3899 return finalhash_hex;
3905 /*************************************************
3906 * Join a file onto the output string *
3907 *************************************************/
3909 /* This is used for readfile/readsock and after a run expansion.
3910 It joins the contents of a file onto the output string, globally replacing
3911 newlines with a given string (optionally).
3915 yield pointer to the expandable string struct
3916 eol newline replacement string, or NULL
3918 Returns: new pointer for expandable string, terminated if non-null
3922 cat_file(FILE * f, gstring * yield, uschar * eol)
3924 uschar buffer[1024];
3926 while (Ufgets(buffer, sizeof(buffer), f))
3928 int len = Ustrlen(buffer);
3929 if (eol && buffer[len-1] == '\n') len--;
3930 yield = string_catn(yield, buffer, len);
3931 if (eol && buffer[len])
3932 yield = string_cat(yield, eol);
3940 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
3943 uschar buffer[1024];
3945 /*XXX could we read direct into a pre-grown string? */
3947 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
3948 for (uschar * s = buffer; rc--; s++)
3949 yield = eol && *s == '\n'
3950 ? string_cat(yield, eol) : string_catn(yield, s, 1);
3952 /* We assume that all errors, and any returns of zero bytes,
3953 are actually EOF. */
3960 /*************************************************
3961 * Evaluate numeric expression *
3962 *************************************************/
3964 /* This is a set of mutually recursive functions that evaluate an arithmetic
3965 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3966 these functions that is called from elsewhere is eval_expr, whose interface is:
3969 sptr pointer to the pointer to the string - gets updated
3970 decimal TRUE if numbers are to be assumed decimal
3971 error pointer to where to put an error message - must be NULL on input
3972 endket TRUE if ')' must terminate - FALSE for external call
3974 Returns: on success: the value of the expression, with *error still NULL
3975 on failure: an undefined value, with *error = a message
3978 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3981 static int_eximarith_t
3982 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3985 int_eximarith_t x = eval_op_or(&s, decimal, error);
3990 *error = US"expecting closing parenthesis";
3992 while (isspace(*++s));
3994 *error = US"expecting operator";
4000 static int_eximarith_t
4001 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4007 if (isdigit((c = Uskip_whitespace(&s))))
4010 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4012 switch (tolower(*s))
4015 case 'k': n *= 1024; s++; break;
4016 case 'm': n *= 1024*1024; s++; break;
4017 case 'g': n *= 1024*1024*1024; s++; break;
4019 Uskip_whitespace(&s);
4024 n = eval_expr(&s, decimal, error, 1);
4028 *error = US"expecting number or opening parenthesis";
4036 static int_eximarith_t
4037 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4041 Uskip_whitespace(&s);
4042 if (*s == '+' || *s == '-' || *s == '~')
4045 x = eval_op_unary(&s, decimal, error);
4046 if (op == '-') x = -x;
4047 else if (op == '~') x = ~x;
4050 x = eval_number(&s, decimal, error);
4057 static int_eximarith_t
4058 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4061 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4064 while (*s == '*' || *s == '/' || *s == '%')
4067 int_eximarith_t y = eval_op_unary(&s, decimal, error);
4069 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4070 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4071 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4072 * -N*M is INT_MIN will yield INT_MIN.
4073 * Since we don't support floating point, this is somewhat simpler.
4074 * Ideally, we'd return an error, but since we overflow for all other
4075 * arithmetic, consistency suggests otherwise, but what's the correct value
4076 * to use? There is none.
4077 * The C standard guarantees overflow for unsigned arithmetic but signed
4078 * overflow invokes undefined behaviour; in practice, this is overflow
4079 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4080 * that long/longlong larger than int are available, or we could just work
4081 * with larger types. We should consider whether to guarantee 32bit eval
4082 * and 64-bit working variables, with errors returned. For now ...
4083 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4084 * can just let the other invalid results occur otherwise, as they have
4085 * until now. For this one case, we can coerce.
4087 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4090 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4091 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4101 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4117 static int_eximarith_t
4118 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4121 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4124 while (*s == '+' || *s == '-')
4127 int_eximarith_t y = eval_op_mult(&s, decimal, error);
4129 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4130 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4131 { /* over-conservative check */
4133 ? US"overflow in sum" : US"overflow in difference";
4136 if (op == '+') x += y; else x -= y;
4144 static int_eximarith_t
4145 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4148 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4151 while ((*s == '<' || *s == '>') && s[1] == s[0])
4156 y = eval_op_sum(&s, decimal, error);
4158 if (op == '<') x <<= y; else x >>= y;
4166 static int_eximarith_t
4167 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4170 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4177 y = eval_op_shift(&s, decimal, error);
4187 static int_eximarith_t
4188 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4191 int_eximarith_t x = eval_op_and(&s, decimal, error);
4198 y = eval_op_and(&s, decimal, error);
4208 static int_eximarith_t
4209 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4212 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4219 y = eval_op_xor(&s, decimal, error);
4230 /************************************************/
4231 /* Comparison operation for sort expansion. We need to avoid
4232 re-expanding the fields being compared, so need a custom routine.
4235 cond_type Comparison operator code
4236 leftarg, rightarg Arguments for comparison
4238 Return true iff (leftarg compare rightarg)
4242 sortsbefore(int cond_type, BOOL alpha_cond,
4243 const uschar * leftarg, const uschar * rightarg)
4245 int_eximarith_t l_num, r_num;
4249 l_num = expanded_string_integer(leftarg, FALSE);
4250 if (expand_string_message) return FALSE;
4251 r_num = expanded_string_integer(rightarg, FALSE);
4252 if (expand_string_message) return FALSE;
4256 case ECOND_NUM_G: return l_num > r_num;
4257 case ECOND_NUM_GE: return l_num >= r_num;
4258 case ECOND_NUM_L: return l_num < r_num;
4259 case ECOND_NUM_LE: return l_num <= r_num;
4266 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4267 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4268 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4269 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4270 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4271 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4272 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4273 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4276 return FALSE; /* should not happen */
4280 /* Expand a named list. Return false on failure. */
4282 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4284 tree_node *t = NULL;
4285 const uschar * list;
4288 BOOL needsep = FALSE;
4289 #define LISTNAMED_BUF_SIZE 256
4290 uschar b[LISTNAMED_BUF_SIZE];
4291 uschar * buffer = b;
4293 if (*name == '+') name++;
4294 if (!listtype) /* no-argument version */
4296 if ( !(t = tree_search(addresslist_anchor, name))
4297 && !(t = tree_search(domainlist_anchor, name))
4298 && !(t = tree_search(hostlist_anchor, name)))
4299 t = tree_search(localpartlist_anchor, name);
4301 else switch(*listtype) /* specific list-type version */
4303 case 'a': t = tree_search(addresslist_anchor, name); break;
4304 case 'd': t = tree_search(domainlist_anchor, name); break;
4305 case 'h': t = tree_search(hostlist_anchor, name); break;
4306 case 'l': t = tree_search(localpartlist_anchor, name); break;
4308 expand_string_message = US"bad suffix on \"list\" operator";
4314 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4316 : *listtype=='a'?"address "
4317 : *listtype=='d'?"domain "
4318 : *listtype=='h'?"host "
4319 : *listtype=='l'?"localpart "
4324 list = ((namedlist_block *)(t->data.ptr))->string;
4326 /* The list could be quite long so we (re)use a buffer for each element
4327 rather than getting each in new memory */
4329 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, GET_TAINTED);
4330 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4332 uschar * buf = US" : ";
4334 yield = string_catn(yield, buf, 3);
4338 if (*item == '+') /* list item is itself a named list */
4340 yield = expand_listnamed(yield, item, listtype);
4341 if (expand_string_message)
4345 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
4348 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4350 for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4352 yield = string_catn(yield, item, cp - CS item);
4353 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4354 yield = string_catn(yield, US"::", 2);
4355 else /* sep in item; should already be doubled; emit once */
4357 yield = string_catn(yield, US tok, 1);
4358 if (*cp == sep) cp++;
4361 yield = string_cat(yield, item);
4364 yield = string_cat(yield, item);
4371 /************************************************/
4373 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4377 debug_printf_indent("|");
4379 debug_printf_indent(UTF8_VERT_RIGHT);
4381 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4385 debug_printf(UTF8_HORIZ);
4387 debug_printf("%s: %.*s\n", what, nchar, value);
4388 if (is_tainted(value))
4391 debug_printf_indent("%s \\__", skipping ? "| " : " ");
4393 debug_printf_indent("%s",
4395 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
4396 debug_printf("(tainted)\n");
4401 /*************************************************
4403 *************************************************/
4405 /* Returns either an unchanged string, or the expanded string in stacking pool
4406 store. Interpreted sequences are:
4408 \... normal escaping rules
4409 $name substitutes the variable
4411 ${op:string} operates on the expanded string value
4412 ${item{arg1}{arg2}...} expands the args and then does the business
4413 some literal args are not enclosed in {}
4415 There are now far too many operators and item types to make it worth listing
4416 them here in detail any more.
4418 We use an internal routine recursively to handle embedded substrings. The
4419 external function follows. The yield is NULL if the expansion failed, and there
4420 are two cases: if something collapsed syntactically, or if "fail" was given
4421 as the action on a lookup failure. These can be distinguished by looking at the
4422 variable expand_string_forcedfail, which is TRUE in the latter case.
4424 The skipping flag is set true when expanding a substring that isn't actually
4425 going to be used (after "if" or "lookup") and it prevents lookups from
4426 happening lower down.
4428 Store usage: At start, a store block of the length of the input plus 64
4429 is obtained. This is expanded as necessary by string_cat(), which might have to
4430 get a new block, or might be able to expand the original. At the end of the
4431 function we can release any store above that portion of the yield block that
4432 was actually used. In many cases this will be optimal.
4434 However: if the first item in the expansion is a variable name or header name,
4435 we reset the store before processing it; if the result is in fresh store, we
4436 use that without copying. This is helpful for expanding strings like
4437 $message_headers which can get very long.
4439 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4440 since resetting the store at the end of the expansion will free store that was
4441 allocated by the plugin code as well as the slop after the expanded string. So
4442 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4443 and, given the acl condition, ${if }. This is an unfortunate consequence of
4444 string expansion becoming too powerful.
4447 string the string to be expanded
4448 ket_ends true if expansion is to stop at }
4449 left if not NULL, a pointer to the first character after the
4450 expansion is placed here (typically used with ket_ends)
4451 skipping TRUE for recursive calls when the value isn't actually going
4452 to be used (to allow for optimisation)
4453 honour_dollar TRUE if $ is to be expanded,
4454 FALSE if it's just another character
4455 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4458 Returns: NULL if expansion fails:
4459 expand_string_forcedfail is set TRUE if failure was forced
4460 expand_string_message contains a textual error message
4461 a pointer to the expanded string on success
4465 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
4466 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
4468 rmark reset_point = store_mark();
4469 gstring * yield = string_get(Ustrlen(string) + 64);
4471 const uschar * s = string;
4472 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4473 int save_expand_nlength[EXPAND_MAXN+1];
4474 BOOL resetok = TRUE, first = TRUE;
4477 f.expand_string_forcedfail = FALSE;
4478 expand_string_message = US"";
4480 if (is_tainted(string))
4482 expand_string_message =
4483 string_sprintf("attempt to expand tainted string '%s'", s);
4484 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4495 debug_printf_indent("%c%s: %s\n",
4497 skipping ? "---scanning" : "considering", s);
4499 debug_printf_indent("%s%s: %s\n",
4500 first ? UTF8_DOWN_RIGHT : UTF8_VERT_RIGHT,
4502 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4508 /* \ escapes the next character, which must exist, or else
4509 the expansion fails. There's a special escape, \N, which causes
4510 copying of the subject verbatim up to the next \N. Otherwise,
4511 the escapes are the standard set. */
4517 expand_string_message = US"\\ at end of string";
4523 const uschar * t = s + 2;
4524 for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4527 debug_expansion_interim(US"protected", t, (int)(s - t), skipping);
4528 yield = string_catn(yield, t, s - t);
4536 debug_printf_indent("|backslashed: '\\%c'\n", s[1]);
4538 debug_printf_indent(UTF8_VERT_RIGHT "backslashed: '\\%c'\n", s[1]);
4539 ch[0] = string_interpret_escape(&s);
4541 yield = string_catn(yield, ch, 1);
4547 /* Anything other than $ is just copied verbatim, unless we are
4548 looking for a terminating } character. */
4550 if (ket_ends && *s == '}') break;
4552 if (*s != '$' || !honour_dollar)
4555 for (const uschar * t = s+1;
4556 *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4558 DEBUG(D_expand) debug_expansion_interim(US"text", s, i, skipping);
4560 yield = string_catn(yield, s, i);
4565 /* No { after the $ - must be a plain name or a number for string
4566 match variable. There has to be a fudge for variables that are the
4567 names of header fields preceded by "$header_" because header field
4568 names can contain any printing characters except space and colon.
4569 For those that don't like typing this much, "$h_" is a synonym for
4570 "$header_". A non-existent header yields a NULL value; nothing is
4575 const uschar * value;
4576 int newsize = 0, len;
4580 s = read_name(name, sizeof(name), s, US"_");
4582 /* If this is the first thing to be expanded, release the pre-allocated
4586 g = store_get(sizeof(gstring), GET_UNTAINTED);
4587 else if (yield->ptr == 0)
4589 if (resetok) reset_point = store_reset(reset_point);
4591 reset_point = store_mark();
4592 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
4597 if ( ( *(t = name) == 'h'
4598 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4600 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4603 unsigned flags = *name == 'r' ? FH_WANT_RAW
4604 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4606 const uschar * charset = *name == 'b' ? NULL : headers_charset;
4608 s = read_header_name(name, sizeof(name), s);
4609 value = find_header(name, &newsize, flags, charset);
4611 /* If we didn't find the header, and the header contains a closing brace
4612 character, this may be a user error where the terminating colon
4613 has been omitted. Set a flag to adjust the error message in this case.
4614 But there is no error here - nothing gets inserted. */
4618 if (Ustrchr(name, '}')) malformed_header = TRUE;
4625 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4627 expand_string_message =
4628 string_sprintf("unknown variable name \"%s\"", name);
4629 check_variable_error_message(name);
4633 /* If the data is known to be in a new buffer, newsize will be set to the
4634 size of that buffer. If this is the first thing in an expansion string,
4635 yield will be NULL; just point it at the new store instead of copying. Many
4636 expansion strings contain just one reference, so this is a useful
4637 optimization, especially for humungous headers. We need to use a gstring
4638 structure that is not allocated after that new-buffer, else a later store
4639 reset in the middle of the buffer will make it inaccessible. */
4641 len = Ustrlen(value);
4642 if (!yield && newsize != 0)
4645 yield->size = newsize;
4647 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4650 yield = string_catn(yield, value, len);
4658 s = read_cnumber(&n, s);
4659 if (n >= 0 && n <= expand_nmax)
4660 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4664 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4666 if (*s != '{') /*}*/
4668 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4672 /* After { there can be various things, but they all start with
4673 an initial word, except for a number for a string match variable. */ /*}*/
4678 s = read_cnumber(&n, s); /*{{*/
4681 expand_string_message = US"} expected after number";
4684 if (n >= 0 && n <= expand_nmax)
4685 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4691 expand_string_message = US"letter or digit expected after ${"; /*}*/
4695 /* Allow "-" in names to cater for substrings with negative
4696 arguments. Since we are checking for known names after { this is
4699 s = read_name(name, sizeof(name), s, US"_-");
4700 item_type = chop_match(name, item_table, nelem(item_table));
4702 /* Switch on item type. All nondefault choices should "continue* when
4703 skipping, but "break" otherwise so we get debug output for the item
4706 int start = gstring_length(yield);
4709 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4710 If the ACL returns accept or reject we return content set by "message ="
4711 There is currently no limit on recursion; this would have us call
4712 acl_check_internal() directly and get a current level from somewhere.
4713 See also the acl expansion condition ECOND_ACL and the traditional
4714 acl modifier ACLC_ACL.
4715 Assume that the function has side-effects on the store that must be preserved.
4719 /* ${acl {name} {arg1}{arg2}...} */
4721 uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4725 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, name,
4728 case 1: goto EXPAND_FAILED_CURLY;
4730 case 3: goto EXPAND_FAILED;
4732 if (skipping) continue;
4735 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4740 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4742 yield = string_cat(yield, user_msg);
4746 f.expand_string_forcedfail = TRUE;
4749 expand_string_message = string_sprintf("%s from acl \"%s\"",
4750 rc_names[rc], sub[0]);
4756 case EITEM_AUTHRESULTS:
4757 /* ${authresults {mysystemname}} */
4759 uschar * sub_arg[1];
4761 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4764 case 1: goto EXPAND_FAILED_CURLY;
4766 case 3: goto EXPAND_FAILED;
4769 yield = string_append(yield, 3,
4770 US"Authentication-Results: ", sub_arg[0], US"; none");
4773 yield = authres_local(yield, sub_arg[0]);
4774 yield = authres_iprev(yield);
4775 yield = authres_smtpauth(yield);
4777 yield = authres_spf(yield);
4779 #ifndef DISABLE_DKIM
4780 yield = authres_dkim(yield);
4782 #ifdef SUPPORT_DMARC
4783 yield = authres_dmarc(yield);
4785 #ifdef EXPERIMENTAL_ARC
4786 yield = authres_arc(yield);
4791 /* Handle conditionals - preserve the values of the numerical expansion
4792 variables in case they get changed by a regular expression match in the
4793 condition. If not, they retain their external settings. At the end
4794 of this "if" section, they get restored to their previous values. */
4799 const uschar *next_s;
4800 int save_expand_nmax =
4801 save_expand_strings(save_expand_nstring, save_expand_nlength);
4802 uschar * save_lookup_value = lookup_value;
4804 Uskip_whitespace(&s);
4805 if (!(next_s = eval_condition(s, &resetok, skipping ? NULL : &cond)))
4806 goto EXPAND_FAILED; /* message already set */
4810 debug_expansion_interim(US"condition", s, (int)(next_s - s), skipping);
4811 debug_expansion_interim(US"result",
4812 cond ? US"true" : US"false", cond ? 4 : 5, skipping);
4817 /* The handling of "yes" and "no" result strings is now in a separate
4818 function that is also used by ${lookup} and ${extract} and ${run}. */
4820 switch(process_yesno(
4821 skipping, /* were previously skipping */
4822 cond, /* success/failure indicator */
4823 lookup_value, /* value to reset for string2 */
4824 &s, /* input pointer */
4825 &yield, /* output pointer */
4826 US"if", /* condition type */
4829 case 1: goto EXPAND_FAILED; /* when all is well, the */
4830 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4833 /* Restore external setting of expansion variables for continuation
4836 lookup_value = save_lookup_value;
4837 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4838 save_expand_nlength);
4843 case EITEM_IMAPFOLDER:
4844 { /* ${imapfolder {name}{sep}{specials}} */
4848 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4851 case 1: goto EXPAND_FAILED_CURLY;
4853 case 3: goto EXPAND_FAILED;
4856 if (!sub_arg[1]) /* One argument */
4858 sub_arg[1] = US"/"; /* default separator */
4861 else if (Ustrlen(sub_arg[1]) != 1)
4863 expand_string_message =
4865 "IMAP folder separator must be one character, found \"%s\"",
4870 if (skipping) continue;
4872 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4873 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4875 yield = string_cat(yield, encoded);
4880 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4881 expanding an internal string that isn't actually going to be used. All we
4882 need to do is check the syntax, so don't do a lookup at all. Preserve the
4883 values of the numerical expansion variables in case they get changed by a
4884 partial lookup. If not, they retain their external settings. At the end
4885 of this "lookup" section, they get restored to their previous values. */
4889 int stype, partial, affixlen, starflags;
4890 int expand_setup = 0;
4892 uschar * key, * filename;
4893 const uschar * affix, * opts;
4894 uschar * save_lookup_value = lookup_value;
4895 int save_expand_nmax =
4896 save_expand_strings(save_expand_nstring, save_expand_nlength);
4898 if (expand_forbid & RDO_LOOKUP)
4900 expand_string_message = US"lookup expansions are not permitted";
4904 /* Get the key we are to look up for single-key+file style lookups.
4905 Otherwise set the key NULL pro-tem. */
4907 if (Uskip_whitespace(&s) == '{') /*}*/
4909 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4910 if (!key) goto EXPAND_FAILED; /*{{*/
4913 expand_string_message = US"missing '}' after lookup key";
4914 goto EXPAND_FAILED_CURLY;
4916 Uskip_whitespace(&s);
4920 /* Find out the type of database */
4924 expand_string_message = US"missing lookup type";
4928 /* The type is a string that may contain special characters of various
4929 kinds. Allow everything except space or { to appear; the actual content
4930 is checked by search_findtype_partial. */ /*}*/
4932 while (*s && *s != '{' && !isspace(*s)) /*}*/
4934 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4937 name[nameptr] = '\0';
4938 Uskip_whitespace(&s);
4940 /* Now check for the individual search type and any partial or default
4941 options. Only those types that are actually in the binary are valid. */
4943 if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4944 &starflags, &opts)) < 0)
4946 expand_string_message = search_error_message;
4950 /* Check that a key was provided for those lookup types that need it,
4951 and was not supplied for those that use the query style. */
4953 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4957 expand_string_message = string_sprintf("missing {key} for single-"
4958 "key \"%s\" lookup", name);
4964 expand_string_message = string_sprintf("a single key was given for "
4965 "lookup type \"%s\", which is not a single-key lookup type", name);
4969 /* Get the next string in brackets and expand it. It is the file name for
4970 single-key+file lookups, and the whole query otherwise. In the case of
4971 queries that also require a file name (e.g. sqlite), the file name comes
4976 expand_string_message = US"missing '{' for lookup file-or-query arg";
4977 goto EXPAND_FAILED_CURLY; /*}}*/
4979 if (!(filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
4984 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4985 goto EXPAND_FAILED_CURLY;
4987 Uskip_whitespace(&s);
4989 /* If this isn't a single-key+file lookup, re-arrange the variables
4990 to be appropriate for the search_ functions. For query-style lookups,
4991 there is just a "key", and no file name. For the special query-style +
4992 file types, the query (i.e. "key") starts with a file name. */
4995 key = search_args(stype, name, filename, &filename, opts);
4997 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4998 the entry was not found. Note that there is no search_close() function.
4999 Files are left open in case of re-use. At suitable places in higher logic,
5000 search_tidyup() is called to tidy all open files. This can save opening
5001 the same file several times. However, files may also get closed when
5002 others are opened, if too many are open at once. The rule is that a
5003 handle should not be used after a second search_open().
5005 Request that a partial search sets up $1 and maybe $2 by passing
5006 expand_setup containing zero. If its value changes, reset expand_nmax,
5007 since new variables will have been set. Note that at the end of this
5008 "lookup" section, the old numeric variables are restored. */
5011 lookup_value = NULL;
5014 void * handle = search_open(filename, stype, 0, NULL, NULL);
5017 expand_string_message = search_error_message;
5020 lookup_value = search_find(handle, filename, key, partial, affix,
5021 affixlen, starflags, &expand_setup, opts);
5022 if (f.search_find_defer)
5024 expand_string_message =
5025 string_sprintf("lookup of \"%s\" gave DEFER: %s",
5026 string_printing2(key, SP_TAB), search_error_message);
5029 if (expand_setup > 0) expand_nmax = expand_setup;
5032 /* The handling of "yes" and "no" result strings is now in a separate
5033 function that is also used by ${if} and ${extract}. */
5035 switch(process_yesno(
5036 skipping, /* were previously skipping */
5037 lookup_value != NULL, /* success/failure indicator */
5038 save_lookup_value, /* value to reset for string2 */
5039 &s, /* input pointer */
5040 &yield, /* output pointer */
5041 US"lookup", /* condition type */
5044 case 1: goto EXPAND_FAILED; /* when all is well, the */
5045 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5048 /* Restore external setting of expansion variables for carrying on
5049 at this level, and continue. */
5051 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5052 save_expand_nlength);
5054 if (skipping) continue;
5058 /* If Perl support is configured, handle calling embedded perl subroutines,
5059 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5060 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5061 arguments (defined below). */
5063 #define EXIM_PERL_MAX_ARGS 8
5067 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
5068 "is not included in this binary";
5071 #else /* EXIM_PERL */
5073 uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5074 gstring * new_yield;
5076 if (expand_forbid & RDO_PERL)
5078 expand_string_message = US"Perl calls are not permitted";
5082 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
5085 case 1: goto EXPAND_FAILED_CURLY;
5087 case 3: goto EXPAND_FAILED;
5090 /* If skipping, we don't actually do anything */
5092 if (skipping) continue;
5094 /* Start the interpreter if necessary */
5096 if (!opt_perl_started)
5099 if (!opt_perl_startup)
5101 expand_string_message = US"A setting of perl_startup is needed when "
5102 "using the Perl interpreter";
5105 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5106 if ((initerror = init_perl(opt_perl_startup)))
5108 expand_string_message =
5109 string_sprintf("error in perl_startup code: %s\n", initerror);
5112 opt_perl_started = TRUE;
5115 /* Call the function */
5117 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5118 new_yield = call_perl_cat(yield, &expand_string_message,
5119 sub_arg[0], sub_arg + 1);
5121 /* NULL yield indicates failure; if the message pointer has been set to
5122 NULL, the yield was undef, indicating a forced failure. Otherwise the
5123 message will indicate some kind of Perl error. */
5127 if (!expand_string_message)
5129 expand_string_message =
5130 string_sprintf("Perl subroutine \"%s\" returned undef to force "
5131 "failure", sub_arg[0]);
5132 f.expand_string_forcedfail = TRUE;
5137 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5138 set during a callback from Perl. */
5140 f.expand_string_forcedfail = FALSE;
5144 #endif /* EXIM_PERL */
5146 /* Transform email address to "prvs" scheme to use
5147 as BATV-signed return path */
5151 uschar * sub_arg[3], * p, * domain;
5153 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, name, &resetok))
5155 case 1: goto EXPAND_FAILED_CURLY;
5157 case 3: goto EXPAND_FAILED;
5160 /* If skipping, we don't actually do anything */
5161 if (skipping) continue;
5163 /* sub_arg[0] is the address */
5164 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
5165 || domain == sub_arg[0] || Ustrlen(domain) == 1)
5167 expand_string_message = US"prvs first argument must be a qualified email address";
5171 /* Calculate the hash. The third argument must be a single-digit
5172 key number, or unset. */
5175 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5177 expand_string_message = US"prvs third argument must be a single digit";
5181 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5184 expand_string_message = US"prvs hmac-sha1 conversion failed";
5188 /* Now separate the domain from the local part */
5191 yield = string_catn(yield, US"prvs=", 5);
5192 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5193 yield = string_catn(yield, prvs_daystamp(7), 3);
5194 yield = string_catn(yield, p, 6);
5195 yield = string_catn(yield, US"=", 1);
5196 yield = string_cat (yield, sub_arg[0]);
5197 yield = string_catn(yield, US"@", 1);
5198 yield = string_cat (yield, domain);
5203 /* Check a prvs-encoded address for validity */
5205 case EITEM_PRVSCHECK:
5207 uschar * sub_arg[3], * p;
5209 const pcre2_code * re;
5211 /* TF: Ugliness: We want to expand parameter 1 first, then set
5212 up expansion variables that are used in the expansion of
5213 parameter 2. So we clone the string for the first
5214 expansion, where we only expand parameter 1.
5216 PH: Actually, that isn't necessary. The read_subs() function is
5217 designed to work this way for the ${if and ${lookup expansions. I've
5221 /* Reset expansion variables */
5222 prvscheck_result = NULL;
5223 prvscheck_address = NULL;
5224 prvscheck_keynum = NULL;
5226 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, name, &resetok))
5228 case 1: goto EXPAND_FAILED_CURLY;
5230 case 3: goto EXPAND_FAILED;
5233 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5236 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5238 uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5239 uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5240 uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5241 uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5242 uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5244 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
5245 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
5246 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5247 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
5248 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
5250 /* Set up expansion variables */
5251 g = string_cat (NULL, local_part);
5252 g = string_catn(g, US"@", 1);
5253 g = string_cat (g, domain);
5254 prvscheck_address = string_from_gstring(g);
5255 prvscheck_keynum = string_copy(key_num);
5257 /* Now expand the second argument */
5258 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, name, &resetok))
5260 case 1: goto EXPAND_FAILED_CURLY;
5262 case 3: goto EXPAND_FAILED;
5265 /* Now we have the key and can check the address. */
5267 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5272 expand_string_message = US"hmac-sha1 conversion failed";
5276 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5277 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
5279 if (Ustrcmp(p,hash) == 0)
5281 /* Success, valid BATV address. Now check the expiry date. */
5282 uschar *now = prvs_daystamp(0);
5283 unsigned int inow = 0,iexpire = 1;
5285 (void)sscanf(CS now,"%u",&inow);
5286 (void)sscanf(CS daystamp,"%u",&iexpire);
5288 /* When "iexpire" is < 7, a "flip" has occurred.
5289 Adjust "inow" accordingly. */
5290 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5292 if (iexpire >= inow)
5294 prvscheck_result = US"1";
5295 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
5299 prvscheck_result = NULL;
5300 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
5305 prvscheck_result = NULL;
5306 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
5309 /* Now expand the final argument. We leave this till now so that
5310 it can include $prvscheck_result. */
5312 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, name, &resetok))
5314 case 1: goto EXPAND_FAILED_CURLY;
5316 case 3: goto EXPAND_FAILED;
5319 yield = string_cat(yield,
5320 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5322 /* Reset the "internal" variables afterwards, because they are in
5323 dynamic store that will be reclaimed if the expansion succeeded. */
5325 prvscheck_address = NULL;
5326 prvscheck_keynum = NULL;
5329 /* Does not look like a prvs encoded address, return the empty string.
5330 We need to make sure all subs are expanded first, so as to skip over
5333 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, name, &resetok))
5335 case 1: goto EXPAND_FAILED_CURLY;
5337 case 3: goto EXPAND_FAILED;
5340 if (skipping) continue;
5344 /* Handle "readfile" to insert an entire file */
5346 case EITEM_READFILE:
5349 uschar * sub_arg[2];
5351 if ((expand_forbid & RDO_READFILE) != 0)
5353 expand_string_message = US"file insertions are not permitted";
5357 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, name, &resetok))
5359 case 1: goto EXPAND_FAILED_CURLY;
5361 case 3: goto EXPAND_FAILED;
5364 /* If skipping, we don't actually do anything */
5366 if (skipping) continue;
5368 /* Open the file and read it */
5370 if (!(f = Ufopen(sub_arg[0], "rb")))
5372 expand_string_message = string_open_failed("%s", sub_arg[0]);
5376 yield = cat_file(f, yield, sub_arg[1]);
5381 /* Handle "readsocket" to insert data from a socket, either
5382 Inet or Unix domain */
5384 case EITEM_READSOCK:
5387 uschar * sub_arg[4];
5389 if (expand_forbid & RDO_READSOCK)
5391 expand_string_message = US"socket insertions are not permitted";
5395 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5396 because there may be a string for expansion on failure. */
5398 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, name, &resetok))
5400 case 1: goto EXPAND_FAILED_CURLY;
5401 case 2: /* Won't occur: no end check */
5402 case 3: goto EXPAND_FAILED;
5405 /* If skipping, we don't actually do anything. Otherwise, arrange to
5406 connect to either an IP or a Unix socket. */
5410 int stype = search_findtype(US"readsock", 8);
5413 int expand_setup = -1;
5416 /* If the reqstr is empty, flag that and set a dummy */
5420 g = string_append_listele(g, ',', US"send=no");
5421 sub_arg[1] = US"DUMMY";
5424 /* Re-marshall the options */
5428 const uschar * list = sub_arg[2];
5432 /* First option has no tag and is timeout */
5433 if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5434 g = string_append_listele(g, ',',
5435 string_sprintf("timeout=%s", item));
5437 /* The rest of the options from the expansion */
5438 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5439 g = string_append_listele(g, ',', item);
5441 /* possibly plus an EOL string. Process with escapes, to protect
5442 from list-processing. The only current user of eol= in search
5443 options is the readsock expansion. */
5445 if (sub_arg[3] && *sub_arg[3])
5446 g = string_append_listele(g, ',',
5447 string_sprintf("eol=%s",
5448 string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5451 /* Gat a (possibly cached) handle for the connection */
5453 if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5455 if (*expand_string_message) goto EXPAND_FAILED;
5456 expand_string_message = search_error_message;
5457 search_error_message = NULL;
5461 /* Get (possibly cached) results for the lookup */
5462 /* sspec: sub_arg[0] req: sub_arg[1] opts: g */
5464 if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5465 &expand_setup, string_from_gstring(g))))
5466 yield = string_cat(yield, s);
5467 else if (f.search_find_defer)
5469 expand_string_message = search_error_message;
5470 search_error_message = NULL;
5474 { /* should not happen, at present */
5475 expand_string_message = search_error_message;
5476 search_error_message = NULL;
5481 /* The whole thing has worked (or we were skipping). If there is a
5482 failure string following, we need to skip it. */
5484 if (*s == '{') /*}*/
5486 if (!expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok))
5487 goto EXPAND_FAILED; /*{*/
5490 expand_string_message = US"missing '}' closing failstring for readsocket";
5491 goto EXPAND_FAILED_CURLY;
5493 Uskip_whitespace(&s);
5496 READSOCK_DONE: /*{*/
5499 expand_string_message = US"missing '}' closing readsocket";
5500 goto EXPAND_FAILED_CURLY;
5502 if (skipping) continue;
5505 /* Come here on failure to create socket, connect socket, write to the
5506 socket, or timeout on reading. If another substring follows, expand and
5507 use it. Otherwise, those conditions give expand errors. */
5510 if (*s != '{') goto EXPAND_FAILED; /*}*/
5511 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5512 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5514 yield = string_cat(yield, arg); /*{*/
5517 expand_string_message = US"missing '}' closing failstring for readsocket";
5518 goto EXPAND_FAILED_CURLY;
5520 Uskip_whitespace(&s);
5524 /* Handle "run" to execute a program. */
5529 const uschar * arg, ** argv;
5530 BOOL late_expand = TRUE;
5532 if ((expand_forbid & RDO_RUN) != 0)
5534 expand_string_message = US"running a command is not permitted";
5538 /* Handle options to the "run" */
5542 if (Ustrncmp(++s, "preexpand", 9) == 0)
5543 { late_expand = FALSE; s += 9; }
5546 const uschar * t = s;
5547 while (isalpha(*++t)) ;
5548 expand_string_message = string_sprintf("bad option '%.*s' for run",
5553 Uskip_whitespace(&s);
5555 if (*s != '{') /*}*/
5557 expand_string_message = US"missing '{' for command arg of run";
5558 goto EXPAND_FAILED_CURLY; /*"}*/
5562 if (late_expand) /* this is the default case */
5564 int n = Ustrcspn(s, "}");
5565 arg = skipping ? NULL : string_copyn(s, n);
5570 if (!(arg = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok)))
5572 Uskip_whitespace(&s);
5577 expand_string_message = US"missing '}' closing command arg of run";
5578 goto EXPAND_FAILED_CURLY;
5581 if (skipping) /* Just pretend it worked when we're skipping */
5584 lookup_value = NULL;
5591 if (!transport_set_up_command(&argv, /* anchor for arg list */
5592 arg, /* raw command */
5593 late_expand, /* expand args if not already done */
5594 0, /* not relevant when... */
5595 NULL, /* no transporting address */
5596 late_expand, /* allow tainted args, when expand-after-split */
5597 US"${run} expansion", /* for error messages */
5598 &expand_string_message)) /* where to put error message */
5601 /* Create the child process, making it a group leader. */
5603 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5604 US"expand-run")) < 0)
5606 expand_string_message =
5607 string_sprintf("couldn't create child process: %s", strerror(errno));
5611 /* Nothing is written to the standard input. */
5615 /* Read the pipe to get the command's output into $value (which is kept
5616 in lookup_value). Read during execution, so that if the output exceeds
5617 the OS pipe buffer limit, we don't block forever. Remember to not release
5618 memory just allocated for $value. */
5621 f = fdopen(fd_out, "rb");
5622 sigalrm_seen = FALSE;
5624 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5628 /* Wait for the process to finish, applying the timeout, and inspect its
5629 return code for serious disasters. Simple non-zero returns are passed on.
5632 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5634 if (sigalrm_seen || runrc == -256)
5636 expand_string_message = US"command timed out";
5637 killpg(pid, SIGKILL); /* Kill the whole process group */
5640 else if (runrc == -257)
5641 expand_string_message = string_sprintf("wait() failed: %s",
5645 expand_string_message = string_sprintf("command killed by signal %d",
5652 /* Process the yes/no strings; $value may be useful in both cases */
5654 switch(process_yesno(
5655 skipping, /* were previously skipping */
5656 runrc == 0, /* success/failure indicator */
5657 lookup_value, /* value to reset for string2 */
5658 &s, /* input pointer */
5659 &yield, /* output pointer */
5660 US"run", /* condition type */
5663 case 1: goto EXPAND_FAILED; /* when all is well, the */
5664 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5667 if (skipping) continue;
5671 /* Handle character translation for "tr" */
5675 int oldptr = gstring_length(yield);
5679 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5681 case 1: goto EXPAND_FAILED_CURLY;
5683 case 3: goto EXPAND_FAILED;
5686 yield = string_cat(yield, sub[0]);
5687 o2m = Ustrlen(sub[2]) - 1;
5689 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5691 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5695 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5699 if (skipping) continue;
5703 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5704 expanded arguments. */
5713 int val[2] = { 0, -1 };
5716 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5717 Ensure that sub[2] is set in the ${length } case. */
5720 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5721 TRUE, name, &resetok))
5723 case 1: goto EXPAND_FAILED_CURLY;
5725 case 3: goto EXPAND_FAILED;
5728 /* Juggle the arguments if there are only two of them: always move the
5729 string to the last position and make ${length{n}{str}} equivalent to
5730 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5736 if (item_type == EITEM_LENGTH)
5743 for (int i = 0; i < 2; i++) if (sub[i])
5745 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5746 if (*ret != 0 || (i != 0 && val[i] < 0))
5748 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5749 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5755 item_type == EITEM_HASH
5756 ? compute_hash(sub[2], val[0], val[1], &len)
5757 : item_type == EITEM_NHASH
5758 ? compute_nhash(sub[2], val[0], val[1], &len)
5759 : extract_substr(sub[2], val[0], val[1], &len);
5762 yield = string_catn(yield, ret, len);
5763 if (skipping) continue;
5767 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5768 This code originally contributed by Steve Haslam. It currently supports
5769 the use of MD5 and SHA-1 hashes.
5771 We need some workspace that is large enough to handle all the supported
5772 hash types. Use macros to set the sizes rather than be too elaborate. */
5774 #define MAX_HASHLEN 20
5775 #define MAX_HASHBLOCKLEN 64
5784 int hashlen; /* Number of octets for the hash algorithm's output */
5785 int hashblocklen; /* Number of octets the hash algorithm processes */
5786 uschar * keyptr, * p;
5787 unsigned int keylen;
5789 uschar keyhash[MAX_HASHLEN];
5790 uschar innerhash[MAX_HASHLEN];
5791 uschar finalhash[MAX_HASHLEN];
5792 uschar finalhash_hex[2*MAX_HASHLEN];
5793 uschar innerkey[MAX_HASHBLOCKLEN];
5794 uschar outerkey[MAX_HASHBLOCKLEN];
5796 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5798 case 1: goto EXPAND_FAILED_CURLY;
5800 case 3: goto EXPAND_FAILED;
5803 if (skipping) continue;
5805 if (Ustrcmp(sub[0], "md5") == 0)
5808 use_base = &md5_base;
5812 else if (Ustrcmp(sub[0], "sha1") == 0)
5815 use_base = &sha1_ctx;
5821 expand_string_message =
5822 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5827 keylen = Ustrlen(keyptr);
5829 /* If the key is longer than the hash block length, then hash the key
5832 if (keylen > hashblocklen)
5834 chash_start(type, use_base);
5835 chash_end(type, use_base, keyptr, keylen, keyhash);
5840 /* Now make the inner and outer key values */
5842 memset(innerkey, 0x36, hashblocklen);
5843 memset(outerkey, 0x5c, hashblocklen);
5845 for (int i = 0; i < keylen; i++)
5847 innerkey[i] ^= keyptr[i];
5848 outerkey[i] ^= keyptr[i];
5851 /* Now do the hashes */
5853 chash_start(type, use_base);
5854 chash_mid(type, use_base, innerkey);
5855 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5857 chash_start(type, use_base);
5858 chash_mid(type, use_base, outerkey);
5859 chash_end(type, use_base, innerhash, hashlen, finalhash);
5861 /* Encode the final hash as a hex string */
5864 for (int i = 0; i < hashlen; i++)
5866 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5867 *p++ = hex_digits[finalhash[i] & 0x0f];
5870 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5871 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5873 yield = string_catn(yield, finalhash_hex, hashlen*2);
5877 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5878 We have to save the numerical variables and restore them afterwards. */
5882 const pcre2_code * re;
5883 int moffset, moffsetextra, slen;
5885 pcre2_match_data * md;
5887 uschar * subject, * sub[3];
5888 int save_expand_nmax =
5889 save_expand_strings(save_expand_nstring, save_expand_nlength);
5891 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5893 case 1: goto EXPAND_FAILED_CURLY;
5895 case 3: goto EXPAND_FAILED;
5897 if (skipping) continue;
5899 /* Compile the regular expression */
5901 if (!(re = pcre2_compile((PCRE2_SPTR)sub[1], PCRE2_ZERO_TERMINATED,
5902 PCRE_COPT, &err, &roffset, pcre_cmp_ctx)))
5905 pcre2_get_error_message(err, errbuf, sizeof(errbuf));
5906 expand_string_message = string_sprintf("regular expression error in "
5907 "\"%s\": %s at offset %ld", sub[1], errbuf, (long)roffset);
5910 md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
5912 /* Now run a loop to do the substitutions as often as necessary. It ends
5913 when there are no more matches. Take care over matches of the null string;
5914 do the same thing as Perl does. */
5917 slen = Ustrlen(sub[0]);
5918 moffset = moffsetextra = 0;
5923 PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
5924 int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
5925 PCRE_EOPT | emptyopt, md, pcre_mtc_ctx);
5928 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5929 is not necessarily the end. We want to repeat the match from one
5930 character further along, but leaving the basic offset the same (for
5931 copying below). We can't be at the end of the string - that was checked
5932 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5933 finished; copy the remaining string and end the loop. */
5943 yield = string_catn(yield, subject+moffset, slen-moffset);
5947 /* Match - set up for expanding the replacement. */
5948 DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
5950 if (n == 0) n = EXPAND_MAXN + 1;
5952 for (int nn = 0; nn < n*2; nn += 2)
5954 expand_nstring[expand_nmax] = subject + ovec[nn];
5955 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
5959 /* Copy the characters before the match, plus the expanded insertion. */
5961 yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
5963 if (!(insert = expand_string(sub[2])))
5965 yield = string_cat(yield, insert);
5971 /* If we have matched an empty string, first check to see if we are at
5972 the end of the subject. If so, the loop is over. Otherwise, mimic
5973 what Perl's /g options does. This turns out to be rather cunning. First
5974 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5975 string at the same point. If this fails (picked up above) we advance to
5976 the next character. */
5978 if (ovec[0] == ovec[1])
5980 if (ovec[0] == slen) break;
5981 emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
5985 /* All done - restore numerical variables. */
5987 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5988 save_expand_nlength);
5992 /* Handle keyed and numbered substring extraction. If the first argument
5993 consists entirely of digits, then a numerical extraction is assumed. */
5997 int field_number = 1;
5998 BOOL field_number_set = FALSE;
5999 uschar * save_lookup_value = lookup_value, * sub[3];
6000 int save_expand_nmax =
6001 save_expand_strings(save_expand_nstring, save_expand_nlength);
6003 /* On reflection the original behaviour of extract-json for a string
6004 result, leaving it quoted, was a mistake. But it was already published,
6005 hence the addition of jsons. In a future major version, make json
6006 work like josons, and withdraw jsons. */
6008 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
6010 /* Check for a format-variant specifier */
6012 if (Uskip_whitespace(&s) != '{') /*}*/
6013 if (Ustrncmp(s, "json", 4) == 0)
6014 if (*(s += 4) == 's')
6015 {fmt = extract_jsons; s++;}
6019 /* While skipping we cannot rely on the data for expansions being
6020 available (eg. $item) hence cannot decide on numeric vs. keyed.
6021 Read a maximum of 5 arguments (including the yes/no) */
6025 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
6027 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
6028 goto EXPAND_FAILED; /*'{'*/
6031 expand_string_message = US"missing '{' for arg of extract";
6032 goto EXPAND_FAILED_CURLY;
6034 Uskip_whitespace(&s);
6036 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
6037 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
6041 Uskip_whitespace(&s);
6045 expand_string_message = US"missing '}' closing extract";
6046 goto EXPAND_FAILED_CURLY;
6050 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
6052 if (Uskip_whitespace(&s) == '{') /*'}'*/
6054 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
6055 goto EXPAND_FAILED; /*'{'*/
6058 expand_string_message = string_sprintf(
6059 "missing '}' closing arg %d of extract", i+1);
6060 goto EXPAND_FAILED_CURLY;
6063 /* After removal of leading and trailing white space, the first
6064 argument must not be empty; if it consists entirely of digits
6065 (optionally preceded by a minus sign), this is a numerical
6066 extraction, and we expect 3 arguments (normal) or 2 (json). */
6072 uschar * p = sub[0];
6074 Uskip_whitespace(&p);
6078 while (len > 0 && isspace(p[len-1])) len--;
6083 expand_string_message = US"first argument of \"extract\" must "
6093 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6097 if (fmt == extract_basic) j = 3; /* Need 3 args */
6098 field_number_set = TRUE;
6104 expand_string_message = string_sprintf(
6105 "missing '{' for arg %d of extract", i+1);
6106 goto EXPAND_FAILED_CURLY;
6110 /* Extract either the numbered or the keyed substring into $value. If
6111 skipping, just pretend the extraction failed. */
6114 lookup_value = NULL;
6118 lookup_value = field_number_set
6119 ? expand_gettokened(field_number, sub[1], sub[2])
6120 : expand_getkeyed(sub[0], sub[1]);
6127 const uschar * list;
6129 /* Array: Bracket-enclosed and comma-separated.
6130 Object: Brace-enclosed, comma-sep list of name:value pairs */
6132 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6134 expand_string_message =
6135 string_sprintf("%s wrapping %s for extract json",
6136 expand_string_message,
6137 field_number_set ? "array" : "object");
6138 goto EXPAND_FAILED_CURLY;
6142 if (field_number_set)
6144 if (field_number <= 0)
6146 expand_string_message = US"first argument of \"extract\" must "
6147 "be greater than zero";
6150 while (field_number > 0 && (item = json_nextinlist(&list)))
6152 if ((lookup_value = s = item))
6155 while (--s >= lookup_value && isspace(*s)) *s = '\0';
6160 lookup_value = NULL;
6161 while ((item = json_nextinlist(&list)))
6163 /* Item is: string name-sep value. string is quoted.
6164 Dequote the string and compare with the search key. */
6166 if (!(item = dewrap(item, US"\"\"")))
6168 expand_string_message =
6169 string_sprintf("%s wrapping string key for extract json",
6170 expand_string_message);
6171 goto EXPAND_FAILED_CURLY;
6173 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
6175 s = item + Ustrlen(item) + 1;
6176 if (Uskip_whitespace(&s) != ':')
6178 expand_string_message =
6179 US"missing object value-separator for extract json";
6180 goto EXPAND_FAILED_CURLY;
6183 Uskip_whitespace(&s);
6191 if ( fmt == extract_jsons
6193 && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6195 expand_string_message =
6196 string_sprintf("%s wrapping string result for extract jsons",
6197 expand_string_message);
6198 goto EXPAND_FAILED_CURLY;
6203 /* If no string follows, $value gets substituted; otherwise there can
6204 be yes/no strings, as for lookup or if. */
6206 switch(process_yesno(
6207 skipping, /* were previously skipping */
6208 lookup_value != NULL, /* success/failure indicator */
6209 save_lookup_value, /* value to reset for string2 */
6210 &s, /* input pointer */
6211 &yield, /* output pointer */
6212 US"extract", /* condition type */
6215 case 1: goto EXPAND_FAILED; /* when all is well, the */
6216 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6219 /* All done - restore numerical variables. */
6221 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6222 save_expand_nlength);
6224 if (skipping) continue;
6228 /* return the Nth item from a list */
6230 case EITEM_LISTEXTRACT:
6232 int field_number = 1;
6233 uschar * save_lookup_value = lookup_value, * sub[2];
6234 int save_expand_nmax =
6235 save_expand_strings(save_expand_nstring, save_expand_nlength);
6237 /* Read the field & list arguments */
6239 for (int i = 0; i < 2; i++)
6241 if (Uskip_whitespace(&s) != '{') /*}*/
6243 expand_string_message = string_sprintf(
6244 "missing '{' for arg %d of listextract", i+1); /*}*/
6245 goto EXPAND_FAILED_CURLY;
6248 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6249 if (!sub[i]) goto EXPAND_FAILED; /*{{*/
6252 expand_string_message = string_sprintf(
6253 "missing '}' closing arg %d of listextract", i+1);
6254 goto EXPAND_FAILED_CURLY;
6257 /* After removal of leading and trailing white space, the first
6258 argument must be numeric and nonempty. */
6266 Uskip_whitespace(&p);
6270 while (len > 0 && isspace(p[len-1])) len--;
6273 if (!*p && !skipping)
6275 expand_string_message = US"first argument of \"listextract\" must "
6285 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6288 expand_string_message = US"first argument of \"listextract\" must "
6296 /* Extract the numbered element into $value. If
6297 skipping, just pretend the extraction failed. */
6299 lookup_value = skipping ? NULL : expand_getlistele(field_number, sub[1]);
6301 /* If no string follows, $value gets substituted; otherwise there can
6302 be yes/no strings, as for lookup or if. */
6304 switch(process_yesno(
6305 skipping, /* were previously skipping */
6306 lookup_value != NULL, /* success/failure indicator */
6307 save_lookup_value, /* value to reset for string2 */
6308 &s, /* input pointer */
6309 &yield, /* output pointer */
6310 US"listextract", /* condition type */
6313 case 1: goto EXPAND_FAILED; /* when all is well, the */
6314 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6317 /* All done - restore numerical variables. */
6319 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6320 save_expand_nlength);
6322 if (skipping) continue;
6326 case EITEM_LISTQUOTE:
6329 switch(read_subs(sub, 2, 2, &s, skipping, TRUE, name, &resetok))
6331 case 1: goto EXPAND_FAILED_CURLY;
6333 case 3: goto EXPAND_FAILED;
6335 if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6337 if (c == sep) yield = string_catn(yield, sub[1], 1);
6338 yield = string_catn(yield, sub[1], 1);
6340 else yield = string_catn(yield, US" ", 1);
6341 if (skipping) continue;
6346 case EITEM_CERTEXTRACT:
6348 uschar * save_lookup_value = lookup_value, * sub[2];
6349 int save_expand_nmax =
6350 save_expand_strings(save_expand_nstring, save_expand_nlength);
6352 /* Read the field argument */
6353 if (Uskip_whitespace(&s) != '{') /*}*/
6355 expand_string_message = US"missing '{' for field arg of certextract";
6356 goto EXPAND_FAILED_CURLY; /*}*/
6358 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6359 if (!sub[0]) goto EXPAND_FAILED; /*{{*/
6362 expand_string_message = US"missing '}' closing field arg of certextract";
6363 goto EXPAND_FAILED_CURLY;
6365 /* strip spaces fore & aft */
6370 Uskip_whitespace(&p);
6374 while (len > 0 && isspace(p[len-1])) len--;
6378 /* inspect the cert argument */
6379 if (Uskip_whitespace(&s) != '{') /*}*/
6381 expand_string_message = US"missing '{' for cert variable arg of certextract";
6382 goto EXPAND_FAILED_CURLY; /*}*/
6386 expand_string_message = US"second argument of \"certextract\" must "
6387 "be a certificate variable";
6390 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
6391 if (!sub[1]) goto EXPAND_FAILED; /*{{*/
6394 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6395 goto EXPAND_FAILED_CURLY;
6399 lookup_value = NULL;
6402 lookup_value = expand_getcertele(sub[0], sub[1]);
6403 if (*expand_string_message) goto EXPAND_FAILED;
6405 switch(process_yesno(
6406 skipping, /* were previously skipping */
6407 lookup_value != NULL, /* success/failure indicator */
6408 save_lookup_value, /* value to reset for string2 */
6409 &s, /* input pointer */
6410 &yield, /* output pointer */
6411 US"certextract", /* condition type */
6414 case 1: goto EXPAND_FAILED; /* when all is well, the */
6415 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6418 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6419 save_expand_nlength);
6420 if (skipping) continue;
6423 #endif /*DISABLE_TLS*/
6425 /* Handle list operations */
6431 int sep = 0, save_ptr = gstring_length(yield);
6432 uschar outsep[2] = { '\0', '\0' };
6433 const uschar *list, *expr, *temp;
6434 uschar * save_iterate_item = iterate_item;
6435 uschar * save_lookup_value = lookup_value;
6437 Uskip_whitespace(&s);
6438 if (*s++ != '{') /*}*/
6440 expand_string_message =
6441 string_sprintf("missing '{' for first arg of %s", name);
6442 goto EXPAND_FAILED_CURLY; /*}*/
6445 if (!(list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok)))
6446 goto EXPAND_FAILED; /*{{*/
6449 expand_string_message =
6450 string_sprintf("missing '}' closing first arg of %s", name);
6451 goto EXPAND_FAILED_CURLY;
6454 if (item_type == EITEM_REDUCE)
6457 Uskip_whitespace(&s);
6458 if (*s++ != '{') /*}*/
6460 expand_string_message = US"missing '{' for second arg of reduce";
6461 goto EXPAND_FAILED_CURLY; /*}*/
6463 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6464 if (!t) goto EXPAND_FAILED;
6465 lookup_value = t; /*{{*/
6468 expand_string_message = US"missing '}' closing second arg of reduce";
6469 goto EXPAND_FAILED_CURLY;
6473 Uskip_whitespace(&s);
6474 if (*s++ != '{') /*}*/
6476 expand_string_message =
6477 string_sprintf("missing '{' for last arg of %s", name); /*}*/
6478 goto EXPAND_FAILED_CURLY;
6483 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6484 if scanning a "false" part). This allows us to find the end of the
6485 condition, because if the list is empty, we won't actually evaluate the
6486 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6487 the normal internal expansion function. */
6489 if (item_type != EITEM_FILTER)
6490 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6492 if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6496 expand_string_message = string_sprintf("%s inside \"%s\" item",
6497 expand_string_message, name);
6501 Uskip_whitespace(&s); /*{{{*/
6504 expand_string_message = string_sprintf("missing } at end of condition "
6505 "or expression inside \"%s\"; could be an unquoted } in the content",
6510 Uskip_whitespace(&s); /*{{*/
6513 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6518 /* If we are skipping, we can now just move on to the next item. When
6519 processing for real, we perform the iteration. */
6521 if (skipping) continue;
6522 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6524 *outsep = (uschar)sep; /* Separator as a string */
6526 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6527 name, iterate_item, lookup_value);
6529 if (item_type == EITEM_FILTER)
6532 if (!eval_condition(expr, &resetok, &condresult))
6534 iterate_item = save_iterate_item;
6535 lookup_value = save_lookup_value;
6536 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6537 expand_string_message, name);
6540 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6541 condresult? "true":"false");
6543 temp = iterate_item; /* TRUE => include this item */
6545 continue; /* FALSE => skip this item */
6548 /* EITEM_MAP and EITEM_REDUCE */
6552 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
6556 iterate_item = save_iterate_item;
6557 expand_string_message = string_sprintf("%s inside \"%s\" item",
6558 expand_string_message, name);
6561 if (item_type == EITEM_REDUCE)
6563 lookup_value = t; /* Update the value of $value */
6564 continue; /* and continue the iteration */
6568 /* We reach here for FILTER if the condition is true, always for MAP,
6569 and never for REDUCE. The value in "temp" is to be added to the output
6570 list that is being created, ensuring that any occurrences of the
6571 separator character are doubled. Unless we are dealing with the first
6572 item of the output list, add in a space if the new item begins with the
6573 separator character, or is an empty string. */
6575 /*XXX is there not a standard support function for this, appending to a list? */
6576 /* yes, string_append_listele(), but it depends on lack of text before the list */
6578 if ( yield && yield->ptr != save_ptr
6579 && (temp[0] == *outsep || temp[0] == 0))
6580 yield = string_catn(yield, US" ", 1);
6582 /* Add the string in "temp" to the output list that we are building,
6583 This is done in chunks by searching for the separator character. */
6587 size_t seglen = Ustrcspn(temp, outsep);
6589 yield = string_catn(yield, temp, seglen + 1);
6591 /* If we got to the end of the string we output one character
6592 too many; backup and end the loop. Otherwise arrange to double the
6595 if (!temp[seglen]) { yield->ptr--; break; }
6596 yield = string_catn(yield, outsep, 1);
6600 /* Output a separator after the string: we will remove the redundant
6601 final one at the end. */
6603 yield = string_catn(yield, outsep, 1);
6604 } /* End of iteration over the list loop */
6606 /* REDUCE has generated no output above: output the final value of
6609 if (item_type == EITEM_REDUCE)
6611 yield = string_cat(yield, lookup_value);
6612 lookup_value = save_lookup_value; /* Restore $value */
6615 /* FILTER and MAP generate lists: if they have generated anything, remove
6616 the redundant final separator. Even though an empty item at the end of a
6617 list does not count, this is tidier. */
6619 else if (yield && yield->ptr != save_ptr) yield->ptr--;
6621 /* Restore preserved $item */
6623 iterate_item = save_iterate_item;
6624 if (skipping) continue;
6630 int sep = 0, cond_type;
6631 const uschar * srclist, * cmp, * xtract;
6632 uschar * opname, * srcitem;
6633 const uschar * dstlist = NULL, * dstkeylist = NULL;
6634 uschar * tmp, * save_iterate_item = iterate_item;
6636 Uskip_whitespace(&s);
6637 if (*s++ != '{') /*}*/
6639 expand_string_message = US"missing '{' for list arg of sort";
6640 goto EXPAND_FAILED_CURLY; /*}*/
6643 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6644 if (!srclist) goto EXPAND_FAILED; /*{{*/
6647 expand_string_message = US"missing '}' closing list arg of sort";
6648 goto EXPAND_FAILED_CURLY;
6651 Uskip_whitespace(&s);
6652 if (*s++ != '{') /*}*/
6654 expand_string_message = US"missing '{' for comparator arg of sort";
6655 goto EXPAND_FAILED_CURLY; /*}*/
6658 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6659 if (!cmp) goto EXPAND_FAILED; /*{{*/
6662 expand_string_message = US"missing '}' closing comparator arg of sort";
6663 goto EXPAND_FAILED_CURLY;
6666 if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6668 if (!expand_string_message)
6669 expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6674 case ECOND_NUM_L: case ECOND_NUM_LE:
6675 case ECOND_NUM_G: case ECOND_NUM_GE:
6676 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6677 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6681 expand_string_message = US"comparator not handled for sort";
6685 Uskip_whitespace(&s);
6686 if (*s++ != '{') /*}*/
6688 expand_string_message = US"missing '{' for extractor arg of sort";
6689 goto EXPAND_FAILED_CURLY; /*}*/
6693 if (!(tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok)))
6695 xtract = string_copyn(xtract, s - xtract);
6699 expand_string_message = US"missing '}' closing extractor arg of sort";
6700 goto EXPAND_FAILED_CURLY;
6705 expand_string_message = US"missing } at end of \"sort\"";
6709 if (skipping) continue;
6711 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6713 uschar * srcfield, * dstitem;
6714 gstring * newlist = NULL, * newkeylist = NULL;
6716 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6718 /* extract field for comparisons */
6719 iterate_item = srcitem;
6720 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6724 expand_string_message = string_sprintf(
6725 "field-extract in sort: \"%s\"", xtract);
6729 /* Insertion sort */
6731 /* copy output list until new-item < list-item */
6732 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6736 /* field for comparison */
6737 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6740 /* String-comparator names start with a letter; numeric names do not */
6742 if (sortsbefore(cond_type, isalpha(opname[0]),
6743 srcfield, dstfield))
6745 /* New-item sorts before this dst-item. Append new-item,
6746 then dst-item, then remainder of dst list. */
6748 newlist = string_append_listele(newlist, sep, srcitem);
6749 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6752 newlist = string_append_listele(newlist, sep, dstitem);
6753 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6755 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */
6756 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6758 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6760 newlist = string_append_listele(newlist, sep, dstitem);
6761 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6767 newlist = string_append_listele(newlist, sep, dstitem);
6768 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6771 /* If we ran out of dstlist without consuming srcitem, append it */
6774 newlist = string_append_listele(newlist, sep, srcitem);
6775 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6778 dstlist = newlist->s;
6779 dstkeylist = newkeylist->s;
6781 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6782 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6786 yield = string_cat(yield, dstlist);
6788 /* Restore preserved $item */
6789 iterate_item = save_iterate_item;
6793 expand_string_message = US"Internal error in sort (list mismatch)";
6798 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6799 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6800 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6801 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6803 #define EXPAND_DLFUNC_MAX_ARGS 8
6806 #ifndef EXPAND_DLFUNC
6807 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6808 "is not included in this binary";
6811 #else /* EXPAND_DLFUNC */
6814 exim_dlfunc_t * func;
6817 uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6819 if (expand_forbid & RDO_DLFUNC)
6821 expand_string_message =
6822 US"dynamically-loaded functions are not permitted";
6826 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6827 TRUE, name, &resetok))
6829 case 1: goto EXPAND_FAILED_CURLY;
6831 case 3: goto EXPAND_FAILED;
6834 /* If skipping, we don't actually do anything */
6836 if (skipping) continue;
6838 /* Look up the dynamically loaded object handle in the tree. If it isn't
6839 found, dlopen() the file and put the handle in the tree for next time. */
6841 if (!(t = tree_search(dlobj_anchor, argv[0])))
6843 void * handle = dlopen(CS argv[0], RTLD_LAZY);
6846 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6847 argv[0], dlerror());
6848 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6851 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), argv[0]);
6852 Ustrcpy(t->name, argv[0]);
6853 t->data.ptr = handle;
6854 (void)tree_insertnode(&dlobj_anchor, t);
6857 /* Having obtained the dynamically loaded object handle, look up the
6858 function pointer. */
6860 if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6862 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6863 "%s", argv[1], argv[0], dlerror());
6864 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6868 /* Call the function and work out what to do with the result. If it
6869 returns OK, we have a replacement string; if it returns DEFER then
6870 expansion has failed in a non-forced manner; if it returns FAIL then
6871 failure was forced; if it returns ERROR or any other value there's a
6872 problem, so panic slightly. In any case, assume that the function has
6873 side-effects on the store that must be preserved. */
6877 for (argc = 0; argv[argc]; argc++) ;
6879 if ((status = func(&result, argc - 2, &argv[2])) != OK)
6881 expand_string_message = result ? result : US"(no message)";
6882 if (status == FAIL_FORCED)
6883 f.expand_string_forcedfail = TRUE;
6884 else if (status != FAIL)
6885 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6886 argv[0], argv[1], status, expand_string_message);
6890 if (result) yield = string_cat(yield, result);
6893 #endif /* EXPAND_DLFUNC */
6895 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6898 uschar *save_lookup_value = lookup_value;
6900 if (Uskip_whitespace(&s) != '{') /*}*/
6903 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6904 if (!key) goto EXPAND_FAILED; /*{{*/
6907 expand_string_message = US"missing '}' for name arg of env";
6908 goto EXPAND_FAILED_CURLY;
6911 lookup_value = US getenv(CS key);
6913 switch(process_yesno(
6914 skipping, /* were previously skipping */
6915 lookup_value != NULL, /* success/failure indicator */
6916 save_lookup_value, /* value to reset for string2 */
6917 &s, /* input pointer */
6918 &yield, /* output pointer */
6919 US"env", /* condition type */
6922 case 1: goto EXPAND_FAILED; /* when all is well, the */
6923 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6925 if (skipping) continue;
6930 case EITEM_SRS_ENCODE:
6931 /* ${srs_encode {secret} {return_path} {orig_domain}} */
6936 BOOL quoted = FALSE;
6938 switch (read_subs(sub, 3, 3, CUSS &s, skipping, TRUE, name, &resetok))
6940 case 1: goto EXPAND_FAILED_CURLY;
6942 case 3: goto EXPAND_FAILED;
6945 g = string_catn(g, US"SRS0=", 5);
6947 /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
6948 hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
6949 g = string_catn(g, cksum, sizeof(cksum));
6950 g = string_catn(g, US"=", 1);
6952 /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
6958 gettimeofday(&now, NULL);
6959 for (unsigned long i = (now.tv_sec / 86400) & 0x3ff; i; i >>= 5)
6960 h = string_catn(h, &base32_chars[i & 0x1f], 1);
6961 if (h) while (h->ptr > 0)
6962 g = string_catn(g, &h->s[--h->ptr], 1);
6964 g = string_catn(g, US"=", 1);
6966 /* ${domain:$return_path}=${local_part:$return_path} */
6968 int start, end, domain;
6969 uschar * t = parse_extract_address(sub[1], &expand_string_message,
6970 &start, &end, &domain, FALSE);
6976 if (domain > 0) g = string_cat(g, t + domain);
6977 g = string_catn(g, US"=", 1);
6979 s = domain > 0 ? string_copyn(t, domain - 1) : t;
6980 if ((quoted = Ustrchr(s, '"') != NULL))
6983 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
6984 while (*s) /* de-quote */
6986 while (*s && *s != '"') h = string_catn(h, s++, 1);
6988 while (*s && *s != '"') h = string_catn(h, s++, 1);
6991 gstring_release_unused(h);
6992 s = string_from_gstring(h);
6994 g = string_cat(g, s);
6997 /* Assume that if the original local_part had quotes
6998 it was for good reason */
7000 if (quoted) yield = string_catn(yield, US"\"", 1);
7001 yield = string_catn(yield, g->s, g->ptr);
7002 if (quoted) yield = string_catn(yield, US"\"", 1);
7004 /* @$original_domain */
7005 yield = string_catn(yield, US"@", 1);
7006 yield = string_cat(yield, sub[2]);
7008 if (skipping) continue;
7011 #endif /*SUPPORT_SRS*/
7015 } /* EITEM_* switch */
7019 if (yield && (start > 0 || *s)) /* only if not the sole expansion of the line */
7020 debug_expansion_interim(US"item-res",
7021 yield->s + start, yield->ptr - start, skipping);
7027 /* Control reaches here if the name is not recognized as one of the more
7028 complicated expansion items. Check for the "operator" syntax (name terminated
7029 by a colon). Some of the operators have arguments, separated by _ from the
7035 uschar * arg = NULL, * sub;
7037 var_entry * vp = NULL;
7040 /* Owing to an historical mis-design, an underscore may be part of the
7041 operator name, or it may introduce arguments. We therefore first scan the
7042 table of names that contain underscores. If there is no match, we cut off
7043 the arguments and then scan the main table. */
7045 if ((c = chop_match(name, op_table_underscore,
7046 nelem(op_table_underscore))) < 0)
7048 if ((arg = Ustrchr(name, '_')))
7050 if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
7051 c += nelem(op_table_underscore);
7052 if (arg) *arg++ = '_'; /* Put back for error messages */
7055 /* Deal specially with operators that might take a certificate variable
7056 as we do not want to do the usual expansion. For most, expand the string.*/
7066 const uschar * s1 = s;
7067 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
7069 if (!sub) goto EXPAND_FAILED; /*{*/
7072 expand_string_message =
7073 string_sprintf("missing '}' closing cert arg of %s", name);
7074 goto EXPAND_FAILED_CURLY;
7076 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
7086 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
7087 if (!sub) goto EXPAND_FAILED;
7092 /* If we are skipping, we don't need to perform the operation at all.
7093 This matters for operations like "mask", because the data may not be
7094 in the correct format when skipping. For example, the expression may test
7095 for the existence of $sender_host_address before trying to mask it. For
7096 other operations, doing them may not fail, but it is a waste of time. */
7098 if (skipping && c >= 0) continue;
7100 /* Otherwise, switch on the operator type. After handling go back
7101 to the main loop top. */
7104 int start = yield->ptr;
7110 unsigned long int n = Ustrtoul(sub, &t, 10);
7115 expand_string_message = string_sprintf("argument for base32 "
7116 "operator is \"%s\", which is not a decimal number", sub);
7120 g = string_catn(g, &base32_chars[n & 0x1f], 1);
7122 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7129 unsigned long int n = 0;
7132 uschar * t = Ustrchr(base32_chars, *tt++);
7135 expand_string_message = string_sprintf("argument for base32d "
7136 "operator is \"%s\", which is not a base 32 number", sub);
7139 n = n * 32 + (t - base32_chars);
7141 yield = string_fmt_append(yield, "%ld", n);
7148 unsigned long int n = Ustrtoul(sub, &t, 10);
7151 expand_string_message = string_sprintf("argument for base62 "
7152 "operator is \"%s\", which is not a decimal number", sub);
7155 yield = string_cat(yield, string_base62(n));
7159 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7164 unsigned long int n = 0;
7167 uschar *t = Ustrchr(base62_chars, *tt++);
7170 expand_string_message = string_sprintf("argument for base62d "
7171 "operator is \"%s\", which is not a base %d number", sub,
7175 n = n * BASE_62 + (t - base62_chars);
7177 yield = string_fmt_append(yield, "%ld", n);
7183 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
7186 expand_string_message =
7187 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7188 expand_string_message);
7191 yield = string_cat(yield, expanded);
7198 uschar *t = sub - 1;
7199 while (*(++t) != 0) { *t = tolower(*t); count++; }
7200 yield = string_catn(yield, sub, count);
7207 uschar *t = sub - 1;
7208 while (*(++t) != 0) { *t = toupper(*t); count++; }
7209 yield = string_catn(yield, sub, count);
7215 if (vp && *(void **)vp->value)
7217 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7218 yield = string_cat(yield, cp);
7226 md5_end(&base, sub, Ustrlen(sub), digest);
7227 for (int j = 0; j < 16; j++)
7228 yield = string_fmt_append(yield, "%02x", digest[j]);
7234 if (vp && *(void **)vp->value)
7236 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7237 yield = string_cat(yield, cp);
7245 sha1_end(&h, sub, Ustrlen(sub), digest);
7246 for (int j = 0; j < 20; j++)
7247 yield = string_fmt_append(yield, "%02X", digest[j]);
7253 #ifdef EXIM_HAVE_SHA2
7254 if (vp && *(void **)vp->value)
7255 if (c == EOP_SHA256)
7256 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7258 expand_string_message = US"sha2_N not supported with certificates";
7263 hashmethod m = !arg ? HASH_SHA2_256
7264 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7265 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7266 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7269 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7271 expand_string_message = US"unrecognised sha2 variant";
7275 exim_sha_update_string(&h, sub);
7276 exim_sha_finish(&h, &b);
7278 yield = string_fmt_append(yield, "%02X", *b.data++);
7281 expand_string_message = US"sha256 only supported with TLS";
7286 #ifdef EXIM_HAVE_SHA3
7290 hashmethod m = !arg ? HASH_SHA3_256
7291 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7292 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7293 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7294 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7297 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7299 expand_string_message = US"unrecognised sha3 variant";
7303 exim_sha_update_string(&h, sub);
7304 exim_sha_finish(&h, &b);
7306 yield = string_fmt_append(yield, "%02X", *b.data++);
7310 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7314 /* Convert hex encoding to base64 encoding */
7324 for (enc = sub; *enc; enc++)
7326 if (!isxdigit(*enc))
7328 expand_string_message = string_sprintf("\"%s\" is not a hex "
7337 expand_string_message = string_sprintf("\"%s\" contains an odd "
7338 "number of characters", sub);
7342 while ((c = *in++) != 0)
7344 if (isdigit(c)) c -= '0';
7345 else c = toupper(c) - 'A' + 10;
7355 enc = b64encode(CUS sub, out - sub);
7356 yield = string_cat(yield, enc);
7360 /* Convert octets outside 0x21..0x7E to \xXX form */
7364 uschar *t = sub - 1;
7367 if (*t < 0x21 || 0x7E < *t)
7368 yield = string_fmt_append(yield, "\\x%02x", *t);
7370 yield = string_catn(yield, t, 1);
7375 /* count the number of list elements */
7379 int cnt = 0, sep = 0;
7380 uschar * buf = store_get(2, sub);
7382 while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7383 yield = string_fmt_append(yield, "%d", cnt);
7387 /* expand a named list given the name */
7388 /* handles nested named lists; requotes as colon-sep list */
7391 expand_string_message = NULL;
7392 yield = expand_listnamed(yield, sub, arg);
7393 if (expand_string_message)
7397 /* quote a list-item for the given list-separator */
7399 /* mask applies a mask to an IP address; for example the result of
7400 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7407 int type, mask, maskoffset;
7411 if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7413 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7418 if (maskoffset == 0)
7420 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7425 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7427 if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7429 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7434 /* If an optional 'n' was given, ipv6 gets normalised output:
7435 colons rather than dots, and zero-compressed. */
7437 normalised = arg && *arg == 'n';
7439 /* Convert the address to binary integer(s) and apply the mask */
7441 sub[maskoffset] = 0;
7442 count = host_aton(sub, binary);
7443 host_mask(count, binary, mask);
7445 /* Convert to masked textual format and add to output. */
7447 if (type == 4 || !normalised)
7448 yield = string_catn(yield, buffer,
7449 host_nmtoa(count, binary, mask, buffer, '.'));
7452 ipv6_nmtoa(binary, buffer);
7453 yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7459 case EOP_IPV6DENORM:
7461 int type = string_is_ip_address(sub, NULL);
7468 (void) host_aton(sub, binary);
7471 case 4: /* convert to IPv4-mapped IPv6 */
7472 binary[0] = binary[1] = 0;
7473 binary[2] = 0x0000ffff;
7474 (void) host_aton(sub, binary+3);
7478 expand_string_message =
7479 string_sprintf("\"%s\" is not an IP address", sub);
7483 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7484 ? ipv6_nmtoa(binary, buffer)
7485 : host_nmtoa(4, binary, -1, buffer, ':')
7491 case EOP_LOCAL_PART:
7495 int start, end, domain;
7496 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7499 if (c != EOP_DOMAIN)
7500 yield = c == EOP_LOCAL_PART && domain > 0
7501 ? string_catn(yield, t, domain - 1)
7502 : string_cat(yield, t);
7503 else if (domain > 0)
7504 yield = string_cat(yield, t + domain);
7510 uschar outsep[2] = { ':', '\0' };
7511 uschar *address, *error;
7512 int save_ptr = gstring_length(yield);
7513 int start, end, domain; /* Not really used */
7515 if (Uskip_whitespace(&sub) == '>')
7516 if (*outsep = *++sub) ++sub;
7519 expand_string_message = string_sprintf("output separator "
7520 "missing in expanding ${addresses:%s}", --sub);
7523 f.parse_allow_group = TRUE;
7527 uschar * p = parse_find_address_end(sub, FALSE);
7528 uschar saveend = *p;
7530 address = parse_extract_address(sub, &error, &start, &end, &domain,
7534 /* Add the address to the output list that we are building. This is
7535 done in chunks by searching for the separator character. At the
7536 start, unless we are dealing with the first address of the output
7537 list, add in a space if the new address begins with the separator
7538 character, or is an empty string. */
7542 if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7543 yield = string_catn(yield, US" ", 1);
7547 size_t seglen = Ustrcspn(address, outsep);
7548 yield = string_catn(yield, address, seglen + 1);
7550 /* If we got to the end of the string we output one character
7553 if (address[seglen] == '\0') { yield->ptr--; break; }
7554 yield = string_catn(yield, outsep, 1);
7555 address += seglen + 1;
7558 /* Output a separator after the string: we will remove the
7559 redundant final one at the end. */
7561 yield = string_catn(yield, outsep, 1);
7564 if (saveend == '\0') break;
7568 /* If we have generated anything, remove the redundant final
7571 if (yield && yield->ptr != save_ptr) yield->ptr--;
7572 f.parse_allow_group = FALSE;
7577 /* quote puts a string in quotes if it is empty or contains anything
7578 other than alphamerics, underscore, dot, or hyphen.
7580 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7581 be quoted in order to be a valid local part.
7583 In both cases, newlines and carriage returns are converted into \n and \r
7587 case EOP_QUOTE_LOCAL_PART:
7590 BOOL needs_quote = (!*sub); /* TRUE for empty string */
7591 uschar *t = sub - 1;
7594 while (!needs_quote && *++t)
7595 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7597 else /* EOP_QUOTE_LOCAL_PART */
7598 while (!needs_quote && *++t)
7599 needs_quote = !isalnum(*t)
7600 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7601 && (*t != '.' || t == sub || !t[1]);
7605 yield = string_catn(yield, US"\"", 1);
7609 yield = string_catn(yield, US"\\n", 2);
7610 else if (*t == '\r')
7611 yield = string_catn(yield, US"\\r", 2);
7614 if (*t == '\\' || *t == '"')
7615 yield = string_catn(yield, US"\\", 1);
7616 yield = string_catn(yield, t, 1);
7618 yield = string_catn(yield, US"\"", 1);
7621 yield = string_cat(yield, sub);
7625 /* quote_lookuptype does lookup-specific quoting */
7630 uschar * opt = Ustrchr(arg, '_');
7632 if (opt) *opt++ = 0;
7634 if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7636 expand_string_message = search_error_message;
7640 if (lookup_list[n]->quote)
7641 sub = (lookup_list[n]->quote)(sub, opt, (unsigned)n);
7647 expand_string_message = string_sprintf(
7648 "\"%s\" unrecognized after \"${quote_%s\"", /*}*/
7653 yield = string_cat(yield, sub);
7657 /* rx quote sticks in \ before any non-alphameric character so that
7658 the insertion works in a regular expression. */
7662 uschar *t = sub - 1;
7666 yield = string_catn(yield, US"\\", 1);
7667 yield = string_catn(yield, t, 1);
7672 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7673 prescribed by the RFC, if there are characters that need to be encoded */
7676 yield = string_cat(yield,
7677 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7681 /* RFC 2047 decode */
7687 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7688 headers_charset, '?', &len, &error);
7691 expand_string_message = error;
7694 yield = string_catn(yield, decoded, len);
7698 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7703 uschar * buff = store_get(4, sub);
7708 if (c > 255) c = '_';
7710 yield = string_catn(yield, buff, 1);
7715 /* replace illegal UTF-8 sequences by replacement character */
7717 #define UTF8_REPLACEMENT_CHAR US"?"
7721 int seq_len = 0, index = 0;
7723 long codepoint = -1;
7725 uschar seq_buff[4]; /* accumulate utf-8 here */
7727 /* Manually track tainting, as we deal in individual chars below */
7729 if (!yield->s || !yield->ptr)
7730 yield->s = store_get(yield->size = Ustrlen(sub), sub);
7731 else if (is_incompatible(yield->s, sub))
7732 gstring_rebuffer(yield, sub);
7734 /* Check the UTF-8, byte-by-byte */
7743 if ((c & 0xc0) != 0x80)
7744 /* wrong continuation byte; invalidate all bytes */
7745 complete = 1; /* error */
7748 codepoint = (codepoint << 6) | (c & 0x3f);
7749 seq_buff[index++] = c;
7750 if (--bytes_left == 0) /* codepoint complete */
7751 if(codepoint > 0x10FFFF) /* is it too large? */
7752 complete = -1; /* error (RFC3629 limit) */
7754 { /* finished; output utf-8 sequence */
7755 yield = string_catn(yield, seq_buff, seq_len);
7760 else /* no bytes left: new sequence */
7762 if(!(c & 0x80)) /* 1-byte sequence, US-ASCII, keep it */
7764 yield = string_catn(yield, &c, 1);
7767 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7769 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7774 codepoint = c & 0x1f;
7777 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7780 codepoint = c & 0x0f;
7782 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7785 codepoint = c & 0x07;
7787 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7790 seq_buff[index++] = c;
7791 seq_len = bytes_left + 1;
7792 } /* if(bytes_left) */
7796 bytes_left = index = 0;
7797 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7799 if ((complete == 1) && ((c & 0x80) == 0))
7800 /* ASCII character follows incomplete sequence */
7801 yield = string_catn(yield, &c, 1);
7803 /* If given a sequence truncated mid-character, we also want to report ?
7804 Eg, ${length_1:フィル} is one byte, not one character, so we expect
7805 ${utf8clean:${length_1:フィル}} to yield '?' */
7807 if (bytes_left != 0)
7808 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7814 case EOP_UTF8_DOMAIN_TO_ALABEL:
7816 uschar * error = NULL;
7817 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7820 expand_string_message = string_sprintf(
7821 "error converting utf8 (%s) to alabel: %s",
7822 string_printing(sub), error);
7825 yield = string_cat(yield, s);
7829 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7831 uschar * error = NULL;
7832 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7835 expand_string_message = string_sprintf(
7836 "error converting alabel (%s) to utf8: %s",
7837 string_printing(sub), error);
7840 yield = string_cat(yield, s);
7844 case EOP_UTF8_LOCALPART_TO_ALABEL:
7846 uschar * error = NULL;
7847 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7850 expand_string_message = string_sprintf(
7851 "error converting utf8 (%s) to alabel: %s",
7852 string_printing(sub), error);
7855 yield = string_cat(yield, s);
7856 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7860 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7862 uschar * error = NULL;
7863 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7866 expand_string_message = string_sprintf(
7867 "error converting alabel (%s) to utf8: %s",
7868 string_printing(sub), error);
7871 yield = string_cat(yield, s);
7874 #endif /* EXPERIMENTAL_INTERNATIONAL */
7876 /* escape turns all non-printing characters into escape sequences. */
7880 const uschar * t = string_printing(sub);
7881 yield = string_cat(yield, t);
7885 case EOP_ESCAPE8BIT:
7889 for (const uschar * s = sub; (c = *s); s++)
7890 yield = c < 127 && c != '\\'
7891 ? string_catn(yield, s, 1)
7892 : string_fmt_append(yield, "\\%03o", c);
7896 /* Handle numeric expression evaluation */
7901 uschar *save_sub = sub;
7902 uschar *error = NULL;
7903 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7906 expand_string_message = string_sprintf("error in expression "
7907 "evaluation: %s (after processing \"%.*s\")", error,
7908 (int)(sub-save_sub), save_sub);
7911 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
7915 /* Handle time period formatting */
7919 int n = readconf_readtime(sub, 0, FALSE);
7922 expand_string_message = string_sprintf("string \"%s\" is not an "
7923 "Exim time interval in \"%s\" operator", sub, name);
7926 yield = string_fmt_append(yield, "%d", n);
7930 case EOP_TIME_INTERVAL:
7933 uschar *t = read_number(&n, sub);
7934 if (*t != 0) /* Not A Number*/
7936 expand_string_message = string_sprintf("string \"%s\" is not a "
7937 "positive number in \"%s\" operator", sub, name);
7940 t = readconf_printtime(n);
7941 yield = string_cat(yield, t);
7945 /* Convert string to base64 encoding */
7951 uschar * s = vp && *(void **)vp->value
7952 ? tls_cert_der_b64(*(void **)vp->value)
7953 : b64encode(CUS sub, Ustrlen(sub));
7955 uschar * s = b64encode(CUS sub, Ustrlen(sub));
7957 yield = string_cat(yield, s);
7964 int len = b64decode(sub, &s);
7967 expand_string_message = string_sprintf("string \"%s\" is not "
7968 "well-formed for \"%s\" operator", sub, name);
7971 yield = string_cat(yield, s);
7975 /* strlen returns the length of the string */
7978 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
7981 /* length_n or l_n takes just the first n characters or the whole string,
7982 whichever is the shorter;
7984 substr_m_n, and s_m_n take n characters from offset m; negative m take
7985 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7986 takes the rest, either to the right or to the left.
7988 hash_n or h_n makes a hash of length n from the string, yielding n
7989 characters from the set a-z; hash_n_m makes a hash of length n, but
7990 uses m characters from the set a-zA-Z0-9.
7992 nhash_n returns a single number between 0 and n-1 (in text form), while
7993 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7994 between 0 and n-1 and the second between 0 and m-1. */
8014 expand_string_message = string_sprintf("missing values after %s",
8019 /* "length" has only one argument, effectively being synonymous with
8022 if (c == EOP_LENGTH || c == EOP_L)
8028 /* The others have one or two arguments; for "substr" the first may be
8029 negative. The second being negative means "not supplied". */
8034 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8037 /* Read up to two numbers, separated by underscores */
8042 if (arg != ret && *arg == '_' && pn == &value1)
8046 if (arg[1] != 0) arg++;
8048 else if (!isdigit(*arg))
8050 expand_string_message =
8051 string_sprintf("non-digit after underscore in \"%s\"", name);
8054 else *pn = (*pn)*10 + *arg++ - '0';
8058 /* Perform the required operation */
8060 ret = c == EOP_HASH || c == EOP_H
8061 ? compute_hash(sub, value1, value2, &len)
8062 : c == EOP_NHASH || c == EOP_NH
8063 ? compute_nhash(sub, value1, value2, &len)
8064 : extract_substr(sub, value1, value2, &len);
8065 if (!ret) goto EXPAND_FAILED;
8067 yield = string_catn(yield, ret, len);
8076 uschar **modetable[3];
8080 if (expand_forbid & RDO_EXISTS)
8082 expand_string_message = US"Use of the stat() expansion is not permitted";
8086 if (stat(CS sub, &st) < 0)
8088 expand_string_message = string_sprintf("stat(%s) failed: %s",
8089 sub, strerror(errno));
8093 switch (mode & S_IFMT)
8095 case S_IFIFO: smode[0] = 'p'; break;
8096 case S_IFCHR: smode[0] = 'c'; break;
8097 case S_IFDIR: smode[0] = 'd'; break;
8098 case S_IFBLK: smode[0] = 'b'; break;
8099 case S_IFREG: smode[0] = '-'; break;
8100 default: smode[0] = '?'; break;
8103 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8104 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8105 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8107 for (int i = 0; i < 3; i++)
8109 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8114 yield = string_fmt_append(yield,
8115 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8116 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8117 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8118 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8119 (long)st.st_gid, st.st_size, (long)st.st_atime,
8120 (long)st.st_mtime, (long)st.st_ctime);
8124 /* vaguely random number less than N */
8128 int_eximarith_t max = expanded_string_integer(sub, TRUE);
8130 if (expand_string_message)
8132 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8136 /* Reverse IP, including IPv6 to dotted-nibble */
8138 case EOP_REVERSE_IP:
8140 int family, maskptr;
8141 uschar reversed[128];
8143 family = string_is_ip_address(sub, &maskptr);
8146 expand_string_message = string_sprintf(
8147 "reverse_ip() not given an IP address [%s]", sub);
8150 invert_address(reversed, sub);
8151 yield = string_cat(yield, reversed);
8155 /* Unknown operator */
8158 expand_string_message =
8159 string_sprintf("unknown expansion operator \"%s\"", name);
8161 } /* EOP_* switch */
8165 const uschar * s = yield->s + start;
8166 int i = yield->ptr - start;
8167 BOOL tainted = is_tainted(s);
8171 debug_printf_indent("|-----op-res: %.*s\n", i, s);
8174 debug_printf_indent("%s \\__", skipping ? "| " : " ");
8175 debug_print_taint(yield->s);
8180 debug_printf_indent(UTF8_VERT_RIGHT
8181 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8182 "op-res: %.*s\n", i, s);
8185 debug_printf_indent("%s",
8187 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8188 debug_print_taint(yield->s);
8196 /* Not an item or an operator */
8197 /* Handle a plain name. If this is the first thing in the expansion, release
8198 the pre-allocated buffer. If the result data is known to be in a new buffer,
8199 newsize will be set to the size of that buffer, and we can just point at that
8200 store instead of copying. Many expansion strings contain just one reference,
8201 so this is a useful optimization, especially for humungous headers
8202 ($message_headers). */
8206 const uschar * value;
8212 g = store_get(sizeof(gstring), GET_UNTAINTED);
8213 else if (yield->ptr == 0)
8215 if (resetok) reset_point = store_reset(reset_point);
8217 reset_point = store_mark();
8218 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */
8220 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
8222 expand_string_message =
8223 string_sprintf("unknown variable in \"${%s}\"", name);
8224 check_variable_error_message(name);
8227 len = Ustrlen(value);
8228 if (!yield && newsize)
8231 yield->size = newsize;
8233 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8236 yield = string_catn(yield, value, len);
8240 /* Else there's something wrong */
8242 expand_string_message =
8243 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8244 "in a variable reference)", name);
8248 /* If we hit the end of the string when ket_ends is set, there is a missing
8249 terminating brace. */
8251 if (ket_ends && !*s)
8253 expand_string_message = malformed_header
8254 ? US"missing } at end of string - could be header name not terminated by colon"
8255 : US"missing } at end of string";
8259 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8260 added to the string. If so, set up an empty string. Add a terminating zero. If
8261 left != NULL, return a pointer to the terminator. */
8264 yield = string_get(1);
8265 (void) string_from_gstring(yield);
8266 if (left) *left = s;
8268 /* Any stacking store that was used above the final string is no longer needed.
8269 In many cases the final string will be the first one that was got and so there
8270 will be optimal store usage. */
8272 if (resetok) gstring_release_unused(yield);
8273 else if (resetok_p) *resetok_p = FALSE;
8277 BOOL tainted = is_tainted(yield->s);
8280 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8281 debug_printf_indent("%sresult: %s\n",
8282 skipping ? "|-----" : "\\_____", yield->s);
8285 debug_printf_indent("%s \\__", skipping ? "| " : " ");
8286 debug_print_taint(yield->s);
8289 debug_printf_indent("\\___skipping: result is not used\n");
8293 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8294 "expanding: %.*s\n",
8295 (int)(s - string), string);
8296 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8298 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8302 debug_printf_indent("%s",
8304 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8305 debug_print_taint(yield->s);
8308 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8309 "skipping: result is not used\n");
8315 /* This is the failure exit: easiest to program with a goto. We still need
8316 to update the pointer to the terminator, for cases of nested calls with "fail".
8319 EXPAND_FAILED_CURLY:
8320 if (malformed_header)
8321 expand_string_message =
8322 US"missing or misplaced { or } - could be header name not terminated by colon";
8324 else if (!expand_string_message || !*expand_string_message)
8325 expand_string_message = US"missing or misplaced { or }";
8327 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8328 that is a bad idea, because expand_string_message is in dynamic store. */
8331 if (left) *left = s;
8336 debug_printf_indent("|failed to expand: %s\n", string);
8337 debug_printf_indent("%serror message: %s\n",
8338 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8339 if (f.expand_string_forcedfail)
8340 debug_printf_indent("\\failure was forced\n");
8344 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8346 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8347 "error message: %s\n",
8348 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8349 expand_string_message);
8350 if (f.expand_string_forcedfail)
8351 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8354 if (resetok_p && !resetok) *resetok_p = FALSE;
8360 /* This is the external function call. Do a quick check for any expansion
8361 metacharacters, and if there are none, just return the input string.
8363 Argument: the string to be expanded
8364 Returns: the expanded string, or NULL if expansion failed; if failure was
8365 due to a lookup deferring, search_find_defer will be TRUE
8369 expand_cstring(const uschar * string)
8371 if (Ustrpbrk(string, "$\\") != NULL)
8373 int old_pool = store_pool;
8376 f.search_find_defer = FALSE;
8377 malformed_header = FALSE;
8378 store_pool = POOL_MAIN;
8379 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
8380 store_pool = old_pool;
8388 expand_string(uschar * string)
8390 return US expand_cstring(CUS string);
8397 /*************************************************
8399 *************************************************/
8401 /* Now and again we want to expand a string and be sure that the result is in a
8402 new bit of store. This function does that.
8403 Since we know it has been copied, the de-const cast is safe.
8405 Argument: the string to be expanded
8406 Returns: the expanded string, always in a new bit of store, or NULL
8410 expand_string_copy(const uschar *string)
8412 const uschar *yield = expand_cstring(string);
8413 if (yield == string) yield = string_copy(string);
8419 /*************************************************
8420 * Expand and interpret as an integer *
8421 *************************************************/
8423 /* Expand a string, and convert the result into an integer.
8426 string the string to be expanded
8427 isplus TRUE if a non-negative number is expected
8429 Returns: the integer value, or
8430 -1 for an expansion error ) in both cases, message in
8431 -2 for an integer interpretation error ) expand_string_message
8432 expand_string_message is set NULL for an OK integer
8436 expand_string_integer(uschar *string, BOOL isplus)
8438 return expanded_string_integer(expand_string(string), isplus);
8442 /*************************************************
8443 * Interpret string as an integer *
8444 *************************************************/
8446 /* Convert a string (that has already been expanded) into an integer.
8448 This function is used inside the expansion code.
8451 s the string to be expanded
8452 isplus TRUE if a non-negative number is expected
8454 Returns: the integer value, or
8455 -1 if string is NULL (which implies an expansion error)
8456 -2 for an integer interpretation error
8457 expand_string_message is set NULL for an OK integer
8460 static int_eximarith_t
8461 expanded_string_integer(const uschar *s, BOOL isplus)
8463 int_eximarith_t value;
8464 uschar *msg = US"invalid integer \"%s\"";
8467 /* If expansion failed, expand_string_message will be set. */
8471 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8472 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8473 systems, so we set it zero ourselves. */
8476 expand_string_message = NULL; /* Indicates no error */
8478 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8479 equal to 0. Unfortunately, people actually relied upon that, so preserve
8480 the behaviour explicitly. Stripping leading whitespace is a harmless
8481 noop change since strtol skips it anyway (provided that there is a number
8484 if (Uskip_whitespace(&s) == '\0')
8487 debug_printf_indent("treating blank string as number 0\n");
8491 value = strtoll(CS s, CSS &endptr, 10);
8494 msg = US"integer expected but \"%s\" found";
8495 else if (value < 0 && isplus)
8496 msg = US"non-negative integer expected but \"%s\" found";
8499 switch (tolower(*endptr))
8504 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8509 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8510 else value *= 1024*1024;
8514 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8515 else value *= 1024*1024*1024;
8519 if (errno == ERANGE)
8520 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8522 if (Uskip_whitespace(&endptr) == 0) return value;
8525 expand_string_message = string_sprintf(CS msg, s);
8530 /* These values are usually fixed boolean values, but they are permitted to be
8534 addr address being routed
8535 mtype the module type
8536 mname the module name
8537 dbg_opt debug selectors
8538 oname the option name
8539 bvalue the router's boolean value
8540 svalue the router's string value
8541 rvalue where to put the returned value
8543 Returns: OK value placed in rvalue
8544 DEFER expansion failed
8548 exp_bool(address_item *addr,
8549 uschar *mtype, uschar *mname, unsigned dbg_opt,
8550 uschar *oname, BOOL bvalue,
8551 uschar *svalue, BOOL *rvalue)
8554 if (!svalue) { *rvalue = bvalue; return OK; }
8556 if (!(expanded = expand_string(svalue)))
8558 if (f.expand_string_forcedfail)
8560 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8564 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8565 oname, mname, mtype, expand_string_message);
8566 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8570 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8573 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8575 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8579 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8580 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8589 /* Avoid potentially exposing a password in a string about to be logged */
8592 expand_hide_passwords(uschar * s)
8594 return ( ( Ustrstr(s, "failed to expand") != NULL
8595 || Ustrstr(s, "expansion of ") != NULL
8597 && ( Ustrstr(s, "mysql") != NULL
8598 || Ustrstr(s, "pgsql") != NULL
8599 || Ustrstr(s, "redis") != NULL
8600 || Ustrstr(s, "sqlite") != NULL
8601 || Ustrstr(s, "ldap:") != NULL
8602 || Ustrstr(s, "ldaps:") != NULL
8603 || Ustrstr(s, "ldapi:") != NULL
8604 || Ustrstr(s, "ldapdn:") != NULL
8605 || Ustrstr(s, "ldapm:") != NULL
8607 ? US"Temporary internal error" : s;
8611 /* Read given named file into big_buffer. Use for keying material etc.
8612 The content will have an ascii NUL appended.
8617 Return: pointer to buffer, or NULL on error.
8621 expand_file_big_buffer(const uschar * filename)
8623 int fd, off = 0, len;
8625 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8627 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8634 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8637 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8645 big_buffer[off] = '\0';
8651 /*************************************************
8652 * Error-checking for testsuite *
8653 *************************************************/
8655 uschar * region_start;
8656 uschar * region_end;
8657 const uschar *var_name;
8658 const uschar *var_data;
8661 /* Called via tree_walk, which allows nonconst name/data. Our usage is const. */
8663 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8666 if (var_data >= e->region_start && var_data < e->region_end)
8668 e->var_name = CUS var_name;
8669 e->var_data = CUS var_data;
8674 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8676 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8677 .var_name = NULL, .var_data = NULL };
8679 /* check acl_ variables */
8680 tree_walk(acl_var_c, assert_variable_notin, &e);
8681 tree_walk(acl_var_m, assert_variable_notin, &e);
8683 /* check auth<n> variables.
8684 assert_variable_notin() treats as const, so deconst is safe. */
8685 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8686 assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8688 /* check regex<n> variables. assert_variable_notin() treats as const. */
8689 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8690 assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8692 /* check known-name variables */
8693 for (var_entry * v = var_table; v < var_table + var_table_size; v++)
8694 if (v->type == vtype_stringptr)
8695 assert_variable_notin(US v->name, *(USS v->value), &e);
8697 /* check dns and address trees */
8698 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8699 tree_walk(tree_duplicates, assert_variable_notin, &e);
8700 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8701 tree_walk(tree_unusable, assert_variable_notin, &e);
8704 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8705 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8706 e.var_name, filename, linenumber, e.var_data);
8711 /*************************************************
8712 **************************************************
8713 * Stand-alone test program *
8714 **************************************************
8715 *************************************************/
8721 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8723 int ovec[3*(EXPAND_MAXN+1)];
8724 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8726 BOOL yield = n >= 0;
8727 if (n == 0) n = EXPAND_MAXN + 1;
8730 expand_nmax = setup < 0 ? 0 : setup + 1;
8731 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8733 expand_nstring[expand_nmax] = subject + ovec[nn];
8734 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8742 int main(int argc, uschar **argv)
8744 uschar buffer[1024];
8746 debug_selector = D_v;
8747 debug_file = stderr;
8748 debug_fd = fileno(debug_file);
8749 big_buffer = malloc(big_buffer_size);
8752 for (int i = 1; i < argc; i++)
8754 if (argv[i][0] == '+')
8756 debug_trace_memory = 2;
8759 if (isdigit(argv[i][0]))
8760 debug_selector = Ustrtol(argv[i], NULL, 0);
8762 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8766 eldap_default_servers = argv[i];
8769 mysql_servers = argv[i];
8772 pgsql_servers = argv[i];
8775 redis_servers = argv[i];
8779 else opt_perl_startup = argv[i];
8783 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8785 expand_nstring[1] = US"string 1....";
8786 expand_nlength[1] = 8;
8790 if (opt_perl_startup != NULL)
8793 printf("Starting Perl interpreter\n");
8794 errstr = init_perl(opt_perl_startup);
8797 printf("** error in perl_startup code: %s\n", errstr);
8798 return EXIT_FAILURE;
8801 #endif /* EXIM_PERL */
8803 /* Thie deliberately regards the input as untainted, so that it can be
8804 expanded; only reasonable since this is a test for string-expansions. */
8806 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8808 rmark reset_point = store_mark();
8809 uschar *yield = expand_string(buffer);
8811 printf("%s\n", yield);
8814 if (f.search_find_defer) printf("search_find deferred\n");
8815 printf("Failed: %s\n", expand_string_message);
8816 if (f.expand_string_forcedfail) printf("Forced failure\n");
8819 store_reset(reset_point);
8831 /* End of expand.c */