1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 - 2021 */
7 /* See the file NOTICE for conditions of use and distribution. */
10 /* Functions for handling string expansion. */
15 /* Recursively called function */
17 static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *);
18 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
21 # ifndef SUPPORT_CRYPTEQ
22 # define SUPPORT_CRYPTEQ
27 # include "lookups/ldap.h"
30 #ifdef SUPPORT_CRYPTEQ
35 extern char* crypt16(char*, char*);
39 /* The handling of crypt16() is a mess. I will record below the analysis of the
40 mess that was sent to me. We decided, however, to make changing this very low
41 priority, because in practice people are moving away from the crypt()
42 algorithms nowadays, so it doesn't seem worth it.
45 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
46 the first 8 characters of the password using a 20-round version of crypt
47 (standard crypt does 25 rounds). It then crypts the next 8 characters,
48 or an empty block if the password is less than 9 characters, using a
49 20-round version of crypt and the same salt as was used for the first
50 block. Characters after the first 16 are ignored. It always generates
51 a 16-byte hash, which is expressed together with the salt as a string
52 of 24 base 64 digits. Here are some links to peruse:
54 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
55 http://seclists.org/bugtraq/1999/Mar/0076.html
57 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
58 and OSF/1. This is the same as the standard crypt if given a password
59 of 8 characters or less. If given more, it first does the same as crypt
60 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
61 using as salt the first two base 64 digits from the first hash block.
62 If the password is more than 16 characters then it crypts the 17th to 24th
63 characters using as salt the first two base 64 digits from the second hash
64 block. And so on: I've seen references to it cutting off the password at
65 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
67 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
68 http://seclists.org/bugtraq/1999/Mar/0109.html
69 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
70 TET1_html/sec.c222.html#no_id_208
72 Exim has something it calls "crypt16". It will either use a native
73 crypt16 or its own implementation. A native crypt16 will presumably
74 be the one that I called "crypt16" above. The internal "crypt16"
75 function, however, is a two-block-maximum implementation of what I called
76 "bigcrypt". The documentation matches the internal code.
78 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
79 that crypt16 and bigcrypt were different things.
81 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
82 to whatever it is using under that name. This unfortunately sets a
83 precedent for using "{crypt16}" to identify two incompatible algorithms
84 whose output can't be distinguished. With "{crypt16}" thus rendered
85 ambiguous, I suggest you deprecate it and invent two new identifiers
86 for the two algorithms.
88 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
89 of the password separately means they can be cracked separately, so
90 the double-length hash only doubles the cracking effort instead of
91 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
98 /*************************************************
99 * Local statics and tables *
100 *************************************************/
102 /* Table of item names, and corresponding switch numbers. The names must be in
103 alphabetical order. */
105 static uschar *item_table[] = {
175 /* Tables of operator names, and corresponding switch numbers. The names must be
176 in alphabetical order. There are two tables, because underscore is used in some
177 cases to introduce arguments, whereas for other it is part of the name. This is
178 an historical mis-design. */
180 static uschar * op_table_underscore[] = {
183 US"quote_local_part",
188 ,US"utf8_domain_from_alabel",
189 US"utf8_domain_to_alabel",
190 US"utf8_localpart_from_alabel",
191 US"utf8_localpart_to_alabel"
198 EOP_QUOTE_LOCAL_PART,
203 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
204 EOP_UTF8_DOMAIN_TO_ALABEL,
205 EOP_UTF8_LOCALPART_FROM_ALABEL,
206 EOP_UTF8_LOCALPART_TO_ALABEL
210 static uschar *op_table_main[] = {
258 EOP_ADDRESS = nelem(op_table_underscore),
305 /* Table of condition names, and corresponding switch numbers. The names must
306 be in alphabetical order. */
308 static uschar *cond_table[] = {
312 US"==", /* Backward compatibility */
352 US"match_local_part",
377 ECOND_FIRST_DELIVERY,
405 ECOND_MATCH_LOCAL_PART,
415 /* Types of table entry */
418 vtype_int, /* value is address of int */
419 vtype_filter_int, /* ditto, but recognized only when filtering */
420 vtype_ino, /* value is address of ino_t (not always an int) */
421 vtype_uid, /* value is address of uid_t (not always an int) */
422 vtype_gid, /* value is address of gid_t (not always an int) */
423 vtype_bool, /* value is address of bool */
424 vtype_stringptr, /* value is address of pointer to string */
425 vtype_msgbody, /* as stringptr, but read when first required */
426 vtype_msgbody_end, /* ditto, the end of the message */
427 vtype_msgheaders, /* the message's headers, processed */
428 vtype_msgheaders_raw, /* the message's headers, unprocessed */
429 vtype_localpart, /* extract local part from string */
430 vtype_domain, /* extract domain from string */
431 vtype_string_func, /* value is string returned by given function */
432 vtype_todbsdin, /* value not used; generate BSD inbox tod */
433 vtype_tode, /* value not used; generate tod in epoch format */
434 vtype_todel, /* value not used; generate tod in epoch/usec format */
435 vtype_todf, /* value not used; generate full tod */
436 vtype_todl, /* value not used; generate log tod */
437 vtype_todlf, /* value not used; generate log file datestamp tod */
438 vtype_todzone, /* value not used; generate time zone only */
439 vtype_todzulu, /* value not used; generate zulu tod */
440 vtype_reply, /* value not used; get reply from headers */
441 vtype_pid, /* value not used; result is pid */
442 vtype_host_lookup, /* value not used; get host name */
443 vtype_load_avg, /* value not used; result is int from os_getloadavg */
444 vtype_pspace, /* partition space; value is T/F for spool/log */
445 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
446 vtype_cert /* SSL certificate */
448 ,vtype_dkim /* Lookup of value in DKIM signature */
452 /* Type for main variable table */
460 /* Type for entries pointing to address/length pairs. Not currently
468 static uschar * fn_recipients(void);
469 typedef uschar * stringptr_fn_t(void);
470 static uschar * fn_queue_size(void);
472 /* This table must be kept in alphabetical order. */
474 static var_entry var_table[] = {
475 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
476 they will be confused with user-creatable ACL variables. */
477 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
478 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
479 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
480 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
481 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
482 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
483 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
484 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
485 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
486 { "acl_narg", vtype_int, &acl_narg },
487 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
488 { "address_data", vtype_stringptr, &deliver_address_data },
489 { "address_file", vtype_stringptr, &address_file },
490 { "address_pipe", vtype_stringptr, &address_pipe },
491 #ifdef EXPERIMENTAL_ARC
492 { "arc_domains", vtype_string_func, (void *) &fn_arc_domains },
493 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
494 { "arc_state", vtype_stringptr, &arc_state },
495 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
497 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
498 { "authenticated_id", vtype_stringptr, &authenticated_id },
499 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
500 { "authentication_failed",vtype_int, &authentication_failed },
501 #ifdef WITH_CONTENT_SCAN
502 { "av_failed", vtype_int, &av_failed },
504 #ifdef EXPERIMENTAL_BRIGHTMAIL
505 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
506 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
507 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
508 { "bmi_deliver", vtype_int, &bmi_deliver },
510 { "body_linecount", vtype_int, &body_linecount },
511 { "body_zerocount", vtype_int, &body_zerocount },
512 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
513 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
514 { "caller_gid", vtype_gid, &real_gid },
515 { "caller_uid", vtype_uid, &real_uid },
516 { "callout_address", vtype_stringptr, &callout_address },
517 { "compile_date", vtype_stringptr, &version_date },
518 { "compile_number", vtype_stringptr, &version_cnumber },
519 { "config_dir", vtype_stringptr, &config_main_directory },
520 { "config_file", vtype_stringptr, &config_main_filename },
521 { "csa_status", vtype_stringptr, &csa_status },
522 #ifdef EXPERIMENTAL_DCC
523 { "dcc_header", vtype_stringptr, &dcc_header },
524 { "dcc_result", vtype_stringptr, &dcc_result },
527 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
528 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
529 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
530 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
531 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
532 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
533 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
534 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
535 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
536 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
537 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
538 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
539 { "dkim_key_length", vtype_int, &dkim_key_length },
540 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
541 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
542 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
543 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
544 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
545 { "dkim_signers", vtype_stringptr, &dkim_signers },
546 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
547 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
550 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
551 { "dmarc_status", vtype_stringptr, &dmarc_status },
552 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
553 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
555 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
556 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
557 { "dnslist_text", vtype_stringptr, &dnslist_text },
558 { "dnslist_value", vtype_stringptr, &dnslist_value },
559 { "domain", vtype_stringptr, &deliver_domain },
560 { "domain_data", vtype_stringptr, &deliver_domain_data },
561 #ifndef DISABLE_EVENT
562 { "event_data", vtype_stringptr, &event_data },
564 /*XXX want to use generic vars for as many of these as possible*/
565 { "event_defer_errno", vtype_int, &event_defer_errno },
567 { "event_name", vtype_stringptr, &event_name },
569 { "exim_gid", vtype_gid, &exim_gid },
570 { "exim_path", vtype_stringptr, &exim_path },
571 { "exim_uid", vtype_uid, &exim_uid },
572 { "exim_version", vtype_stringptr, &version_string },
573 { "headers_added", vtype_string_func, (void *) &fn_hdrs_added },
574 { "home", vtype_stringptr, &deliver_home },
575 { "host", vtype_stringptr, &deliver_host },
576 { "host_address", vtype_stringptr, &deliver_host_address },
577 { "host_data", vtype_stringptr, &host_data },
578 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
579 { "host_lookup_failed", vtype_int, &host_lookup_failed },
580 { "host_port", vtype_int, &deliver_host_port },
581 { "initial_cwd", vtype_stringptr, &initial_cwd },
582 { "inode", vtype_ino, &deliver_inode },
583 { "interface_address", vtype_stringptr, &interface_address },
584 { "interface_port", vtype_int, &interface_port },
585 { "item", vtype_stringptr, &iterate_item },
587 { "ldap_dn", vtype_stringptr, &eldap_dn },
589 { "load_average", vtype_load_avg, NULL },
590 { "local_part", vtype_stringptr, &deliver_localpart },
591 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
592 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
593 { "local_part_prefix_v", vtype_stringptr, &deliver_localpart_prefix_v },
594 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
595 { "local_part_suffix_v", vtype_stringptr, &deliver_localpart_suffix_v },
596 #ifdef HAVE_LOCAL_SCAN
597 { "local_scan_data", vtype_stringptr, &local_scan_data },
599 { "local_user_gid", vtype_gid, &local_user_gid },
600 { "local_user_uid", vtype_uid, &local_user_uid },
601 { "localhost_number", vtype_int, &host_number },
602 { "log_inodes", vtype_pinodes, (void *)FALSE },
603 { "log_space", vtype_pspace, (void *)FALSE },
604 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
605 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
606 #ifdef WITH_CONTENT_SCAN
607 { "malware_name", vtype_stringptr, &malware_name },
609 { "max_received_linelength", vtype_int, &max_received_linelength },
610 { "message_age", vtype_int, &message_age },
611 { "message_body", vtype_msgbody, &message_body },
612 { "message_body_end", vtype_msgbody_end, &message_body_end },
613 { "message_body_size", vtype_int, &message_body_size },
614 { "message_exim_id", vtype_stringptr, &message_id },
615 { "message_headers", vtype_msgheaders, NULL },
616 { "message_headers_raw", vtype_msgheaders_raw, NULL },
617 { "message_id", vtype_stringptr, &message_id },
618 { "message_linecount", vtype_int, &message_linecount },
619 { "message_size", vtype_int, &message_size },
621 { "message_smtputf8", vtype_bool, &message_smtputf8 },
623 #ifdef WITH_CONTENT_SCAN
624 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
625 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
626 { "mime_boundary", vtype_stringptr, &mime_boundary },
627 { "mime_charset", vtype_stringptr, &mime_charset },
628 { "mime_content_description", vtype_stringptr, &mime_content_description },
629 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
630 { "mime_content_id", vtype_stringptr, &mime_content_id },
631 { "mime_content_size", vtype_int, &mime_content_size },
632 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
633 { "mime_content_type", vtype_stringptr, &mime_content_type },
634 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
635 { "mime_filename", vtype_stringptr, &mime_filename },
636 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
637 { "mime_is_multipart", vtype_int, &mime_is_multipart },
638 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
639 { "mime_part_count", vtype_int, &mime_part_count },
641 { "n0", vtype_filter_int, &filter_n[0] },
642 { "n1", vtype_filter_int, &filter_n[1] },
643 { "n2", vtype_filter_int, &filter_n[2] },
644 { "n3", vtype_filter_int, &filter_n[3] },
645 { "n4", vtype_filter_int, &filter_n[4] },
646 { "n5", vtype_filter_int, &filter_n[5] },
647 { "n6", vtype_filter_int, &filter_n[6] },
648 { "n7", vtype_filter_int, &filter_n[7] },
649 { "n8", vtype_filter_int, &filter_n[8] },
650 { "n9", vtype_filter_int, &filter_n[9] },
651 { "original_domain", vtype_stringptr, &deliver_domain_orig },
652 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
653 { "originator_gid", vtype_gid, &originator_gid },
654 { "originator_uid", vtype_uid, &originator_uid },
655 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
656 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
657 { "pid", vtype_pid, NULL },
659 { "prdr_requested", vtype_bool, &prdr_requested },
661 { "primary_hostname", vtype_stringptr, &primary_hostname },
662 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
663 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
664 { "proxy_external_port", vtype_int, &proxy_external_port },
665 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
666 { "proxy_local_port", vtype_int, &proxy_local_port },
667 { "proxy_session", vtype_bool, &proxy_session },
669 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
670 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
671 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
672 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
673 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
674 { "queue_name", vtype_stringptr, &queue_name },
675 { "queue_size", vtype_string_func, &fn_queue_size },
676 { "rcpt_count", vtype_int, &rcpt_count },
677 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
678 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
679 { "received_count", vtype_int, &received_count },
680 { "received_for", vtype_stringptr, &received_for },
681 { "received_ip_address", vtype_stringptr, &interface_address },
682 { "received_port", vtype_int, &interface_port },
683 { "received_protocol", vtype_stringptr, &received_protocol },
684 { "received_time", vtype_int, &received_time.tv_sec },
685 { "recipient_data", vtype_stringptr, &recipient_data },
686 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
687 { "recipients", vtype_string_func, (void *) &fn_recipients },
688 { "recipients_count", vtype_int, &recipients_count },
689 #ifdef WITH_CONTENT_SCAN
690 { "regex_match_string", vtype_stringptr, ®ex_match_string },
692 { "reply_address", vtype_reply, NULL },
693 { "return_path", vtype_stringptr, &return_path },
694 { "return_size_limit", vtype_int, &bounce_return_size_limit },
695 { "router_name", vtype_stringptr, &router_name },
696 { "runrc", vtype_int, &runrc },
697 { "self_hostname", vtype_stringptr, &self_hostname },
698 { "sender_address", vtype_stringptr, &sender_address },
699 { "sender_address_data", vtype_stringptr, &sender_address_data },
700 { "sender_address_domain", vtype_domain, &sender_address },
701 { "sender_address_local_part", vtype_localpart, &sender_address },
702 { "sender_data", vtype_stringptr, &sender_data },
703 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
704 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
705 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
706 { "sender_host_address", vtype_stringptr, &sender_host_address },
707 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
708 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
709 { "sender_host_name", vtype_host_lookup, NULL },
710 { "sender_host_port", vtype_int, &sender_host_port },
711 { "sender_ident", vtype_stringptr, &sender_ident },
712 { "sender_rate", vtype_stringptr, &sender_rate },
713 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
714 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
715 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
716 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
717 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
718 { "sending_port", vtype_int, &sending_port },
719 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
720 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
721 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
722 { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
723 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
724 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
725 { "sn0", vtype_filter_int, &filter_sn[0] },
726 { "sn1", vtype_filter_int, &filter_sn[1] },
727 { "sn2", vtype_filter_int, &filter_sn[2] },
728 { "sn3", vtype_filter_int, &filter_sn[3] },
729 { "sn4", vtype_filter_int, &filter_sn[4] },
730 { "sn5", vtype_filter_int, &filter_sn[5] },
731 { "sn6", vtype_filter_int, &filter_sn[6] },
732 { "sn7", vtype_filter_int, &filter_sn[7] },
733 { "sn8", vtype_filter_int, &filter_sn[8] },
734 { "sn9", vtype_filter_int, &filter_sn[9] },
735 #ifdef WITH_CONTENT_SCAN
736 { "spam_action", vtype_stringptr, &spam_action },
737 { "spam_bar", vtype_stringptr, &spam_bar },
738 { "spam_report", vtype_stringptr, &spam_report },
739 { "spam_score", vtype_stringptr, &spam_score },
740 { "spam_score_int", vtype_stringptr, &spam_score_int },
743 { "spf_guess", vtype_stringptr, &spf_guess },
744 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
745 { "spf_received", vtype_stringptr, &spf_received },
746 { "spf_result", vtype_stringptr, &spf_result },
747 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
748 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
750 { "spool_directory", vtype_stringptr, &spool_directory },
751 { "spool_inodes", vtype_pinodes, (void *)TRUE },
752 { "spool_space", vtype_pspace, (void *)TRUE },
753 #ifdef EXPERIMENTAL_SRS_ALT
754 { "srs_db_address", vtype_stringptr, &srs_db_address },
755 { "srs_db_key", vtype_stringptr, &srs_db_key },
756 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
757 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
759 #if defined(EXPERIMENTAL_SRS_ALT) || defined(SUPPORT_SRS)
760 { "srs_recipient", vtype_stringptr, &srs_recipient },
762 #ifdef EXPERIMENTAL_SRS_ALT
763 { "srs_status", vtype_stringptr, &srs_status },
765 { "thisaddress", vtype_stringptr, &filter_thisaddress },
767 /* The non-(in,out) variables are now deprecated */
768 { "tls_bits", vtype_int, &tls_in.bits },
769 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
770 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
772 { "tls_in_bits", vtype_int, &tls_in.bits },
773 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
774 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
775 { "tls_in_cipher_std", vtype_stringptr, &tls_in.cipher_stdname },
776 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
777 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
778 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
779 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
780 #ifndef DISABLE_TLS_RESUME
781 { "tls_in_resumption", vtype_int, &tls_in.resumption },
784 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
786 { "tls_in_ver", vtype_stringptr, &tls_in.ver },
787 { "tls_out_bits", vtype_int, &tls_out.bits },
788 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
789 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
790 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },
792 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
794 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
795 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
796 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
797 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
798 #ifndef DISABLE_TLS_RESUME
799 { "tls_out_resumption", vtype_int, &tls_out.resumption },
802 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
805 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
807 { "tls_out_ver", vtype_stringptr, &tls_out.ver },
809 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
811 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
814 { "tod_bsdinbox", vtype_todbsdin, NULL },
815 { "tod_epoch", vtype_tode, NULL },
816 { "tod_epoch_l", vtype_todel, NULL },
817 { "tod_full", vtype_todf, NULL },
818 { "tod_log", vtype_todl, NULL },
819 { "tod_logfile", vtype_todlf, NULL },
820 { "tod_zone", vtype_todzone, NULL },
821 { "tod_zulu", vtype_todzulu, NULL },
822 { "transport_name", vtype_stringptr, &transport_name },
823 { "value", vtype_stringptr, &lookup_value },
824 { "verify_mode", vtype_stringptr, &verify_mode },
825 { "version_number", vtype_stringptr, &version_string },
826 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
827 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
828 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
829 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
830 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
831 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
834 static int var_table_size = nelem(var_table);
835 static uschar var_buffer[256];
836 static BOOL malformed_header;
838 /* For textual hashes */
840 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
841 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
844 enum { HMAC_MD5, HMAC_SHA1 };
846 /* For numeric hashes */
848 static unsigned int prime[] = {
849 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
850 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
851 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
853 /* For printing modes in symbolic form */
855 static uschar *mtable_normal[] =
856 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
858 static uschar *mtable_setid[] =
859 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
861 static uschar *mtable_sticky[] =
862 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
864 /* flags for find_header() */
865 #define FH_EXISTS_ONLY BIT(0)
866 #define FH_WANT_RAW BIT(1)
867 #define FH_WANT_LIST BIT(2)
870 /*************************************************
871 * Tables for UTF-8 support *
872 *************************************************/
874 /* Table of the number of extra characters, indexed by the first character
875 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
878 static uschar utf8_table1[] = {
879 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
880 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
881 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
882 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
884 /* These are the masks for the data bits in the first byte of a character,
885 indexed by the number of additional bytes. */
887 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
889 /* Get the next UTF-8 character, advancing the pointer. */
891 #define GETUTF8INC(c, ptr) \
893 if ((c & 0xc0) == 0xc0) \
895 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
897 c = (c & utf8_table2[a]) << s; \
901 c |= (*ptr++ & 0x3f) << s; \
907 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
909 /*************************************************
910 * Binary chop search on a table *
911 *************************************************/
913 /* This is used for matching expansion items and operators.
916 name the name that is being sought
917 table the table to search
918 table_size the number of items in the table
920 Returns: the offset in the table, or -1
924 chop_match(uschar *name, uschar **table, int table_size)
926 uschar **bot = table;
927 uschar **top = table + table_size;
931 uschar **mid = bot + (top - bot)/2;
932 int c = Ustrcmp(name, *mid);
933 if (c == 0) return mid - table;
934 if (c > 0) bot = mid + 1; else top = mid;
942 /*************************************************
943 * Check a condition string *
944 *************************************************/
946 /* This function is called to expand a string, and test the result for a "true"
947 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
948 forced fail or lookup defer.
950 We used to release all store used, but this is not not safe due
951 to ${dlfunc } and ${acl }. In any case expand_string_internal()
952 is reasonably careful to release what it can.
954 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
957 condition the condition string
958 m1 text to be incorporated in panic error
961 Returns: TRUE if condition is met, FALSE if not
965 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
967 uschar * ss = expand_string(condition);
970 if (!f.expand_string_forcedfail && !f.search_find_defer)
971 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
972 "for %s %s: %s", condition, m1, m2, expand_string_message);
975 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
976 strcmpic(ss, US"false") != 0;
982 /*************************************************
983 * Pseudo-random number generation *
984 *************************************************/
986 /* Pseudo-random number generation. The result is not "expected" to be
987 cryptographically strong but not so weak that someone will shoot themselves
988 in the foot using it as a nonce in some email header scheme or whatever
989 weirdness they'll twist this into. The result should ideally handle fork().
991 However, if we're stuck unable to provide this, then we'll fall back to
992 appallingly bad randomness.
994 If DISABLE_TLS is not defined then this will not be used except as an emergency
999 Returns a random number in range [0, max-1]
1003 # define vaguely_random_number vaguely_random_number_fallback
1006 vaguely_random_number(int max)
1009 # undef vaguely_random_number
1011 static pid_t pid = 0;
1014 if ((p2 = getpid()) != pid)
1019 #ifdef HAVE_ARC4RANDOM
1020 /* cryptographically strong randomness, common on *BSD platforms, not
1021 so much elsewhere. Alas. */
1022 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1025 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1026 # ifdef HAVE_SRANDOMDEV
1027 /* uses random(4) for seeding */
1032 gettimeofday(&tv, NULL);
1033 srandom(tv.tv_sec | tv.tv_usec | getpid());
1037 /* Poor randomness and no seeding here */
1044 #ifdef HAVE_ARC4RANDOM
1045 return arc4random() % max;
1046 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1047 return random() % max;
1049 /* This one returns a 16-bit number, definitely not crypto-strong */
1050 return random_number(max);
1057 /*************************************************
1058 * Pick out a name from a string *
1059 *************************************************/
1061 /* If the name is too long, it is silently truncated.
1064 name points to a buffer into which to put the name
1065 max is the length of the buffer
1066 s points to the first alphabetic character of the name
1067 extras chars other than alphanumerics to permit
1069 Returns: pointer to the first character after the name
1071 Note: The test for *s != 0 in the while loop is necessary because
1072 Ustrchr() yields non-NULL if the character is zero (which is not something
1075 static const uschar *
1076 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1079 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1081 if (ptr < max-1) name[ptr++] = *s;
1090 /*************************************************
1091 * Pick out the rest of a header name *
1092 *************************************************/
1094 /* A variable name starting $header_ (or just $h_ for those who like
1095 abbreviations) might not be the complete header name because headers can
1096 contain any printing characters in their names, except ':'. This function is
1097 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1098 on the end, if the name was terminated by white space.
1101 name points to a buffer in which the name read so far exists
1102 max is the length of the buffer
1103 s points to the first character after the name so far, i.e. the
1104 first non-alphameric character after $header_xxxxx
1106 Returns: a pointer to the first character after the header name
1109 static const uschar *
1110 read_header_name(uschar *name, int max, const uschar *s)
1112 int prelen = Ustrchr(name, '_') - name + 1;
1113 int ptr = Ustrlen(name) - prelen;
1114 if (ptr > 0) memmove(name, name+prelen, ptr);
1115 while (mac_isgraph(*s) && *s != ':')
1117 if (ptr < max-1) name[ptr++] = *s;
1128 /*************************************************
1129 * Pick out a number from a string *
1130 *************************************************/
1133 n points to an integer into which to put the number
1134 s points to the first digit of the number
1136 Returns: a pointer to the character after the last digit
1138 /*XXX consider expanding to int_eximarith_t. But the test for
1139 "overbig numbers" in 0002 still needs to overflow it. */
1142 read_number(int *n, uschar *s)
1145 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1149 static const uschar *
1150 read_cnumber(int *n, const uschar *s)
1153 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1159 /*************************************************
1160 * Extract keyed subfield from a string *
1161 *************************************************/
1163 /* The yield is in dynamic store; NULL means that the key was not found.
1166 key points to the name of the key
1167 s points to the string from which to extract the subfield
1169 Returns: NULL if the subfield was not found, or
1170 a pointer to the subfield's data
1174 expand_getkeyed(const uschar * key, const uschar * s)
1176 int length = Ustrlen(key);
1177 Uskip_whitespace(&s);
1179 /* Loop to search for the key */
1185 const uschar * dkey = s;
1187 while (*s && *s != '=' && !isspace(*s)) s++;
1188 dkeylength = s - dkey;
1189 if (Uskip_whitespace(&s) == '=') while (isspace(*++s));
1191 data = string_dequote(&s);
1192 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1195 Uskip_whitespace(&s);
1204 find_var_ent(uschar * name)
1207 int last = var_table_size;
1209 while (last > first)
1211 int middle = (first + last)/2;
1212 int c = Ustrcmp(name, var_table[middle].name);
1214 if (c > 0) { first = middle + 1; continue; }
1215 if (c < 0) { last = middle; continue; }
1216 return &var_table[middle];
1221 /*************************************************
1222 * Extract numbered subfield from string *
1223 *************************************************/
1225 /* Extracts a numbered field from a string that is divided by tokens - for
1226 example a line from /etc/passwd is divided by colon characters. First field is
1227 numbered one. Negative arguments count from the right. Zero returns the whole
1228 string. Returns NULL if there are insufficient tokens in the string
1231 Modifies final argument - this is a dynamically generated string, so that's OK.
1234 field number of field to be extracted,
1235 first field = 1, whole string = 0, last field = -1
1236 separators characters that are used to break string into tokens
1237 s points to the string from which to extract the subfield
1239 Returns: NULL if the field was not found,
1240 a pointer to the field's data inside s (modified to add 0)
1244 expand_gettokened (int field, uschar *separators, uschar *s)
1249 uschar *fieldtext = NULL;
1251 if (field == 0) return s;
1253 /* Break the line up into fields in place; for field > 0 we stop when we have
1254 done the number of fields we want. For field < 0 we continue till the end of
1255 the string, counting the number of fields. */
1257 count = (field > 0)? field : INT_MAX;
1263 /* Previous field was the last one in the string. For a positive field
1264 number, this means there are not enough fields. For a negative field number,
1265 check that there are enough, and scan back to find the one that is wanted. */
1269 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1270 if ((-field) == (INT_MAX - count - 1)) return s;
1274 while (ss[-1] != 0) ss--;
1280 /* Previous field was not last in the string; save its start and put a
1284 len = Ustrcspn(ss, separators);
1295 expand_getlistele(int field, const uschar * list)
1297 const uschar * tlist = list;
1299 /* Tainted mem for the throwaway element copies */
1300 uschar * dummy = store_get(2, TRUE);
1304 for (field++; string_nextinlist(&tlist, &sep, dummy, 1); ) field++;
1307 if (field == 0) return NULL;
1308 while (--field > 0 && (string_nextinlist(&list, &sep, dummy, 1))) ;
1309 return string_nextinlist(&list, &sep, NULL, 0);
1313 /* Certificate fields, by name. Worry about by-OID later */
1314 /* Names are chosen to not have common prefixes */
1321 uschar * (*getfn)(void * cert, uschar * mod);
1323 static certfield certfields[] =
1324 { /* linear search; no special order */
1325 { US"version", 7, &tls_cert_version },
1326 { US"serial_number", 13, &tls_cert_serial_number },
1327 { US"subject", 7, &tls_cert_subject },
1328 { US"notbefore", 9, &tls_cert_not_before },
1329 { US"notafter", 8, &tls_cert_not_after },
1330 { US"issuer", 6, &tls_cert_issuer },
1331 { US"signature", 9, &tls_cert_signature },
1332 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1333 { US"subj_altname", 12, &tls_cert_subject_altname },
1334 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1335 { US"crl_uri", 7, &tls_cert_crl_uri },
1339 expand_getcertele(uschar * field, uschar * certvar)
1343 if (!(vp = find_var_ent(certvar)))
1345 expand_string_message =
1346 string_sprintf("no variable named \"%s\"", certvar);
1347 return NULL; /* Unknown variable name */
1349 /* NB this stops us passing certs around in variable. Might
1350 want to do that in future */
1351 if (vp->type != vtype_cert)
1353 expand_string_message =
1354 string_sprintf("\"%s\" is not a certificate", certvar);
1355 return NULL; /* Unknown variable name */
1357 if (!*(void **)vp->value)
1360 if (*field >= '0' && *field <= '9')
1361 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1363 for (certfield * cp = certfields;
1364 cp < certfields + nelem(certfields);
1366 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1368 uschar * modifier = *(field += cp->namelen) == ','
1370 return (*cp->getfn)( *(void **)vp->value, modifier );
1373 expand_string_message =
1374 string_sprintf("bad field selector \"%s\" for certextract", field);
1377 #endif /*DISABLE_TLS*/
1379 /*************************************************
1380 * Extract a substring from a string *
1381 *************************************************/
1383 /* Perform the ${substr or ${length expansion operations.
1386 subject the input string
1387 value1 the offset from the start of the input string to the start of
1388 the output string; if negative, count from the right.
1389 value2 the length of the output string, or negative (-1) for unset
1390 if value1 is positive, unset means "all after"
1391 if value1 is negative, unset means "all before"
1392 len set to the length of the returned string
1394 Returns: pointer to the output string, or NULL if there is an error
1398 extract_substr(uschar *subject, int value1, int value2, int *len)
1400 int sublen = Ustrlen(subject);
1402 if (value1 < 0) /* count from right */
1406 /* If the position is before the start, skip to the start, and adjust the
1407 length. If the length ends up negative, the substring is null because nothing
1408 can precede. This falls out naturally when the length is unset, meaning "all
1414 if (value2 < 0) value2 = 0;
1418 /* Otherwise an unset length => characters before value1 */
1420 else if (value2 < 0)
1427 /* For a non-negative offset, if the starting position is past the end of the
1428 string, the result will be the null string. Otherwise, an unset length means
1429 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1433 if (value1 > sublen)
1438 else if (value2 < 0) value2 = sublen;
1441 /* Cut the length down to the maximum possible for the offset value, and get
1442 the required characters. */
1444 if (value1 + value2 > sublen) value2 = sublen - value1;
1446 return subject + value1;
1452 /*************************************************
1453 * Old-style hash of a string *
1454 *************************************************/
1456 /* Perform the ${hash expansion operation.
1459 subject the input string (an expanded substring)
1460 value1 the length of the output string; if greater or equal to the
1461 length of the input string, the input string is returned
1462 value2 the number of hash characters to use, or 26 if negative
1463 len set to the length of the returned string
1465 Returns: pointer to the output string, or NULL if there is an error
1469 compute_hash(uschar *subject, int value1, int value2, int *len)
1471 int sublen = Ustrlen(subject);
1473 if (value2 < 0) value2 = 26;
1474 else if (value2 > Ustrlen(hashcodes))
1476 expand_string_message =
1477 string_sprintf("hash count \"%d\" too big", value2);
1481 /* Calculate the hash text. We know it is shorter than the original string, so
1482 can safely place it in subject[] (we know that subject is always itself an
1483 expanded substring). */
1485 if (value1 < sublen)
1490 while ((c = (subject[j])) != 0)
1492 int shift = (c + j++) & 7;
1493 subject[i] ^= (c << shift) | (c >> (8-shift));
1494 if (++i >= value1) i = 0;
1496 for (i = 0; i < value1; i++)
1497 subject[i] = hashcodes[(subject[i]) % value2];
1499 else value1 = sublen;
1508 /*************************************************
1509 * Numeric hash of a string *
1510 *************************************************/
1512 /* Perform the ${nhash expansion operation. The first characters of the
1513 string are treated as most important, and get the highest prime numbers.
1516 subject the input string
1517 value1 the maximum value of the first part of the result
1518 value2 the maximum value of the second part of the result,
1519 or negative to produce only a one-part result
1520 len set to the length of the returned string
1522 Returns: pointer to the output string, or NULL if there is an error.
1526 compute_nhash (uschar *subject, int value1, int value2, int *len)
1528 uschar *s = subject;
1530 unsigned long int total = 0; /* no overflow */
1534 if (i == 0) i = nelem(prime) - 1;
1535 total += prime[i--] * (unsigned int)(*s++);
1538 /* If value2 is unset, just compute one number */
1541 s = string_sprintf("%lu", total % value1);
1543 /* Otherwise do a div/mod hash */
1547 total = total % (value1 * value2);
1548 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1559 /*************************************************
1560 * Find the value of a header or headers *
1561 *************************************************/
1563 /* Multiple instances of the same header get concatenated, and this function
1564 can also return a concatenation of all the header lines. When concatenating
1565 specific headers that contain lists of addresses, a comma is inserted between
1566 them. Otherwise we use a straight concatenation. Because some messages can have
1567 pathologically large number of lines, there is a limit on the length that is
1571 name the name of the header, without the leading $header_ or $h_,
1572 or NULL if a concatenation of all headers is required
1573 newsize return the size of memory block that was obtained; may be NULL
1574 if exists_only is TRUE
1575 flags FH_EXISTS_ONLY
1576 set if called from a def: test; don't need to build a string;
1577 just return a string that is not "" and not "0" if the header
1580 set if called for $rh_ or $rheader_ items; no processing,
1581 other than concatenating, will be done on the header. Also used
1582 for $message_headers_raw.
1584 Double colon chars in the content, and replace newline with
1585 colon between each element when concatenating; returning a
1586 colon-sep list (elements might contain newlines)
1587 charset name of charset to translate MIME words to; used only if
1588 want_raw is false; if NULL, no translation is done (this is
1589 used for $bh_ and $bheader_)
1591 Returns: NULL if the header does not exist, else a pointer to a new
1596 find_header(uschar *name, int *newsize, unsigned flags, const uschar *charset)
1599 int len = name ? Ustrlen(name) : 0;
1603 for (header_line * h = header_list; h; h = h->next)
1604 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1605 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1610 if (flags & FH_EXISTS_ONLY)
1611 return US"1"; /* don't need actual string */
1614 s = h->text + len; /* text to insert */
1615 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1616 Uskip_whitespace(&s); /* remove leading white space */
1617 t = h->text + h->slen; /* end-point */
1619 /* Unless wanted raw, remove trailing whitespace, including the
1622 if (flags & FH_WANT_LIST)
1623 while (t > s && t[-1] == '\n') t--;
1624 else if (!(flags & FH_WANT_RAW))
1626 while (t > s && isspace(t[-1])) t--;
1628 /* Set comma if handling a single header and it's one of those
1629 that contains an address list, except when asked for raw headers. Only
1630 need to do this once. */
1632 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1635 /* Trim the header roughly if we're approaching limits */
1637 if (gstring_length(g) + inc > header_insert_maxlen)
1638 inc = header_insert_maxlen - gstring_length(g);
1640 /* For raw just copy the data; for a list, add the data as a colon-sep
1641 list-element; for comma-list add as an unchecked comma,newline sep
1642 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1643 stripped trailing WS above including the newline). We ignore the potential
1644 expansion due to colon-doubling, just leaving the loop if the limit is met
1647 if (flags & FH_WANT_LIST)
1648 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1649 else if (flags & FH_WANT_RAW)
1650 g = string_catn(g, s, (unsigned)inc);
1652 g = string_append2_listele_n(g, comma ? US",\n" : US"\n",
1655 if (gstring_length(g) >= header_insert_maxlen) break;
1658 if (!found) return NULL; /* No header found */
1659 if (!g) return US"";
1661 /* That's all we do for raw header expansion. */
1664 if (flags & FH_WANT_RAW)
1665 return string_from_gstring(g);
1667 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1668 The rfc2047_decode2() function can return an error with decoded data if the
1669 charset translation fails. If decoding fails, it returns NULL. */
1673 uschar * error, * decoded = rfc2047_decode2(string_from_gstring(g),
1674 check_rfc2047_length, charset, '?', NULL, newsize, &error);
1676 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1677 " input was: %s\n", error, g->s);
1678 return decoded ? decoded : string_from_gstring(g);
1685 /* Append a "local" element to an Authentication-Results: header
1686 if this was a non-smtp message.
1690 authres_local(gstring * g, const uschar * sysname)
1692 if (!f.authentication_local)
1694 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1695 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1700 /* Append an "iprev" element to an Authentication-Results: header
1701 if we have attempted to get the calling host's name.
1705 authres_iprev(gstring * g)
1707 if (sender_host_name)
1708 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1709 else if (host_lookup_deferred)
1710 g = string_cat(g, US";\n\tiprev=temperror");
1711 else if (host_lookup_failed)
1712 g = string_cat(g, US";\n\tiprev=fail");
1716 if (sender_host_address)
1717 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1723 /*************************************************
1724 * Return list of recipients *
1725 *************************************************/
1726 /* A recipients list is available only during system message filtering,
1727 during ACL processing after DATA, and while expanding pipe commands
1728 generated from a system filter, but not elsewhere. */
1736 if (!f.enable_dollar_recipients) return NULL;
1738 for (int i = 0; i < recipients_count; i++)
1740 s = recipients_list[i].address;
1741 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1743 return g ? g->s : NULL;
1747 /*************************************************
1748 * Return size of queue *
1749 *************************************************/
1750 /* Ask the daemon for the queue size */
1755 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1759 const uschar * where;
1760 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1764 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
1766 DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));
1770 #ifdef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1771 sa_un.sun_path[0] = 0; /* Abstract local socket addr - Linux-specific? */
1772 len = offsetof(struct sockaddr_un, sun_path) + 1
1773 + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "exim_%d", getpid());
1775 sname = string_sprintf("%s/p_%d", spool_directory, getpid());
1776 len = offsetof(struct sockaddr_un, sun_path)
1777 + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s", sname);
1780 if (bind(fd, (const struct sockaddr *)&sa_un, len) < 0)
1781 { where = US"bind"; goto bad; }
1784 debug_printf("local addr '%s%s'\n",
1785 *sa_un.sun_path ? "" : "@",
1786 sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1789 #ifdef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1790 sa_un.sun_path[0] = 0; /* Abstract local socket addr - Linux-specific? */
1791 len = offsetof(struct sockaddr_un, sun_path) + 1
1792 + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "%s",
1793 expand_string(notifier_socket));
1795 len = offsetof(struct sockaddr_un, sun_path)
1796 + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s",
1797 expand_string(notifier_socket));
1800 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
1801 { where = US"connect"; goto bad2; }
1803 buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1804 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1806 if (poll_one_fd(fd, POLLIN, 2 * 1000) != 1)
1808 DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1809 len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1811 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1812 { where = US"recv"; goto bad2; }
1815 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1818 return string_copyn(buf, len);
1821 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1826 DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1831 /*************************************************
1832 * Find value of a variable *
1833 *************************************************/
1835 /* The table of variables is kept in alphabetic order, so we can search it
1836 using a binary chop. The "choplen" variable is nothing to do with the binary
1840 name the name of the variable being sought
1841 exists_only TRUE if this is a def: test; passed on to find_header()
1842 skipping TRUE => skip any processing evaluation; this is not the same as
1843 exists_only because def: may test for values that are first
1845 newsize pointer to an int which is initially zero; if the answer is in
1846 a new memory buffer, *newsize is set to its size
1848 Returns: NULL if the variable does not exist, or
1849 a pointer to the variable's contents, or
1850 something non-NULL if exists_only is TRUE
1853 static const uschar *
1854 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1861 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1862 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1863 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1864 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1865 (this gave backwards compatibility at the changeover). There may be built-in
1866 variables whose names start acl_ but they should never start in this way. This
1867 slightly messy specification is a consequence of the history, needless to say.
1869 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1870 set, in which case give an error. */
1872 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1876 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1877 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1879 else if (Ustrncmp(name, "r_", 2) == 0)
1881 tree_node * node = tree_search(router_var, name + 2);
1882 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1885 /* Handle $auth<n> variables. */
1887 if (Ustrncmp(name, "auth", 4) == 0)
1890 int n = Ustrtoul(name + 4, &endptr, 10);
1891 if (!*endptr && n != 0 && n <= AUTH_VARS)
1892 return auth_vars[n-1] ? auth_vars[n-1] : US"";
1894 else if (Ustrncmp(name, "regex", 5) == 0)
1897 int n = Ustrtoul(name + 5, &endptr, 10);
1898 if (!*endptr && n != 0 && n <= REGEX_VARS)
1899 return regex_vars[n-1] ? regex_vars[n-1] : US"";
1902 /* For all other variables, search the table */
1904 if (!(vp = find_var_ent(name)))
1905 return NULL; /* Unknown variable name */
1907 /* Found an existing variable. If in skipping state, the value isn't needed,
1908 and we want to avoid processing (such as looking up the host name). */
1916 case vtype_filter_int:
1917 if (!f.filter_running) return NULL;
1921 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1925 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1929 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1933 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1937 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1940 case vtype_stringptr: /* Pointer to string */
1941 return (s = *((uschar **)(val))) ? s : US"";
1944 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1947 case vtype_load_avg:
1948 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1951 case vtype_host_lookup: /* Lookup if not done so */
1952 if ( !sender_host_name && sender_host_address
1953 && !host_lookup_failed && host_name_lookup() == OK)
1954 host_build_sender_fullhost();
1955 return sender_host_name ? sender_host_name : US"";
1957 case vtype_localpart: /* Get local part from address */
1958 if (!(s = *((uschar **)(val)))) return US"";
1959 if (!(domain = Ustrrchr(s, '@'))) return s;
1960 if (domain - s > sizeof(var_buffer) - 1)
1961 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1962 " in string expansion", sizeof(var_buffer));
1963 return string_copyn(s, domain - s);
1965 case vtype_domain: /* Get domain from address */
1966 if (!(s = *((uschar **)(val)))) return US"";
1967 domain = Ustrrchr(s, '@');
1968 return domain ? domain + 1 : US"";
1970 case vtype_msgheaders:
1971 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
1973 case vtype_msgheaders_raw:
1974 return find_header(NULL, newsize,
1975 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
1977 case vtype_msgbody: /* Pointer to msgbody string */
1978 case vtype_msgbody_end: /* Ditto, the end of the msg */
1979 ss = (uschar **)(val);
1980 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1983 off_t start_offset = SPOOL_DATA_START_OFFSET;
1984 int len = message_body_visible;
1986 if (len > message_size) len = message_size;
1987 *ss = body = store_get(len+1, TRUE);
1989 if (vp->type == vtype_msgbody_end)
1991 struct stat statbuf;
1992 if (fstat(deliver_datafile, &statbuf) == 0)
1994 start_offset = statbuf.st_size - len;
1995 if (start_offset < SPOOL_DATA_START_OFFSET)
1996 start_offset = SPOOL_DATA_START_OFFSET;
1999 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
2000 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
2002 if ((len = read(deliver_datafile, body, len)) > 0)
2005 if (message_body_newlines) /* Separate loops for efficiency */
2007 { if (body[--len] == 0) body[len] = ' '; }
2010 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
2013 return *ss ? *ss : US"";
2015 case vtype_todbsdin: /* BSD inbox time of day */
2016 return tod_stamp(tod_bsdin);
2018 case vtype_tode: /* Unix epoch time of day */
2019 return tod_stamp(tod_epoch);
2021 case vtype_todel: /* Unix epoch/usec time of day */
2022 return tod_stamp(tod_epoch_l);
2024 case vtype_todf: /* Full time of day */
2025 return tod_stamp(tod_full);
2027 case vtype_todl: /* Log format time of day */
2028 return tod_stamp(tod_log_bare); /* (without timezone) */
2030 case vtype_todzone: /* Time zone offset only */
2031 return tod_stamp(tod_zone);
2033 case vtype_todzulu: /* Zulu time */
2034 return tod_stamp(tod_zulu);
2036 case vtype_todlf: /* Log file datestamp tod */
2037 return tod_stamp(tod_log_datestamp_daily);
2039 case vtype_reply: /* Get reply address */
2040 s = find_header(US"reply-to:", newsize,
2041 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2043 if (s) Uskip_whitespace(&s);
2046 *newsize = 0; /* For the *s==0 case */
2047 s = find_header(US"from:", newsize,
2048 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2054 Uskip_whitespace(&s);
2055 for (t = s; *t; t++) if (*t == '\n') *t = ' ';
2056 while (t > s && isspace(t[-1])) t--;
2059 return s ? s : US"";
2061 case vtype_string_func:
2063 stringptr_fn_t * fn = (stringptr_fn_t *) val;
2065 return s ? s : US"";
2071 sprintf(CS var_buffer, PR_EXIM_ARITH,
2072 receive_statvfs(val == (void *)TRUE, &inodes));
2079 (void) receive_statvfs(val == (void *)TRUE, &inodes);
2080 sprintf(CS var_buffer, "%d", inodes);
2085 return *(void **)val ? US"<cert>" : US"";
2087 #ifndef DISABLE_DKIM
2089 return dkim_exim_expand_query((int)(long)val);
2094 return NULL; /* Unknown variable. Silences static checkers. */
2101 modify_variable(uschar *name, void * value)
2104 if ((vp = find_var_ent(name))) vp->value = value;
2105 return; /* Unknown variable name, fail silently */
2113 /*************************************************
2114 * Read and expand substrings *
2115 *************************************************/
2117 /* This function is called to read and expand argument substrings for various
2118 expansion items. Some have a minimum requirement that is less than the maximum;
2119 in these cases, the first non-present one is set to NULL.
2122 sub points to vector of pointers to set
2123 n maximum number of substrings
2125 sptr points to current string pointer
2126 skipping the skipping flag
2127 check_end if TRUE, check for final '}'
2128 name name of item, for error message
2129 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2132 Returns: 0 OK; string pointer updated
2133 1 curly bracketing error (too few arguments)
2134 2 too many arguments (only if check_end is set); message set
2135 3 other error (expansion failure)
2139 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
2140 BOOL check_end, uschar *name, BOOL *resetok)
2142 const uschar *s = *sptr;
2144 Uskip_whitespace(&s);
2145 for (int i = 0; i < n; i++)
2151 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2152 "(min is %d)", name, m);
2158 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2160 if (*s++ != '}') return 1;
2161 Uskip_whitespace(&s);
2163 if (check_end && *s++ != '}')
2167 expand_string_message = string_sprintf("Too many arguments for '%s' "
2168 "(max is %d)", name, n);
2171 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2182 /*************************************************
2183 * Elaborate message for bad variable *
2184 *************************************************/
2186 /* For the "unknown variable" message, take a look at the variable's name, and
2187 give additional information about possible ACL variables. The extra information
2188 is added on to expand_string_message.
2190 Argument: the name of the variable
2195 check_variable_error_message(uschar *name)
2197 if (Ustrncmp(name, "acl_", 4) == 0)
2198 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2199 (name[4] == 'c' || name[4] == 'm')?
2201 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2202 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2204 US"user-defined ACL variables must start acl_c or acl_m");
2210 Load args from sub array to globals, and call acl_check().
2211 Sub array will be corrupted on return.
2213 Returns: OK access is granted by an ACCEPT verb
2214 DISCARD access is (apparently) granted by a DISCARD verb
2215 FAIL access is denied
2216 FAIL_DROP access is denied; drop the connection
2217 DEFER can't tell at the moment
2221 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2224 int sav_narg = acl_narg;
2226 uschar * dummy_logmsg;
2227 extern int acl_where;
2229 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2230 for (i = 0; i < nsub && sub[i+1]; i++)
2232 uschar * tmp = acl_arg[i];
2233 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2234 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2239 sub[i+1] = acl_arg[i];
2240 acl_arg[i++] = NULL;
2244 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2246 acl_narg>0 ? acl_arg[0] : US"<none>",
2247 acl_narg>1 ? " +more" : "");
2249 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2251 for (i = 0; i < nsub; i++)
2252 acl_arg[i] = sub[i+1]; /* restore old args */
2253 acl_narg = sav_narg;
2261 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2262 The given string is modified on return. Leading whitespace is skipped while
2263 looking for the opening wrap character, then the rest is scanned for the trailing
2264 (non-escaped) wrap character. A backslash in the string will act as an escape.
2266 A nul is written over the trailing wrap, and a pointer to the char after the
2267 leading wrap is returned.
2270 s String for de-wrapping
2271 wrap Two-char string, the first being the opener, second the closer wrapping
2274 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2278 dewrap(uschar * s, const uschar * wrap)
2282 BOOL quotesmode = wrap[0] == wrap[1];
2284 if (Uskip_whitespace(&p) == *wrap)
2290 if (*p == '\\') p++;
2291 else if (!quotesmode && *p == wrap[-1]) depth++;
2292 else if (*p == *wrap)
2303 expand_string_message = string_sprintf("missing '%c'", *wrap);
2308 /* Pull off the leading array or object element, returning
2309 a copy in an allocated string. Update the list pointer.
2311 The element may itself be an abject or array.
2312 Return NULL when the list is empty.
2316 json_nextinlist(const uschar ** list)
2318 unsigned array_depth = 0, object_depth = 0;
2319 const uschar * s = *list, * item;
2321 skip_whitespace(&s);
2324 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2328 case '[': array_depth++; break;
2329 case ']': array_depth--; break;
2330 case '{': object_depth++; break;
2331 case '}': object_depth--; break;
2333 *list = *s ? s+1 : s;
2334 if (item == s) return NULL;
2335 item = string_copyn(item, s - item);
2336 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2342 /************************************************/
2343 /* Return offset in ops table, or -1 if not found.
2344 Repoint to just after the operator in the string.
2347 ss string representation of operator
2348 opname split-out operator name
2352 identify_operator(const uschar ** ss, uschar ** opname)
2354 const uschar * s = *ss;
2357 /* Numeric comparisons are symbolic */
2359 if (*s == '=' || *s == '>' || *s == '<')
2371 /* All other conditions are named */
2374 s = read_name(name, sizeof(name), s, US"_");
2377 /* If we haven't read a name, it means some non-alpha character is first. */
2381 expand_string_message = string_sprintf("condition name expected, "
2382 "but found \"%.16s\"", s);
2386 *opname = string_copy(name);
2388 return chop_match(name, cond_table, nelem(cond_table));
2392 /*************************************************
2393 * Handle MD5 or SHA-1 computation for HMAC *
2394 *************************************************/
2396 /* These are some wrapping functions that enable the HMAC code to be a bit
2397 cleaner. A good compiler will spot the tail recursion.
2400 type HMAC_MD5 or HMAC_SHA1
2401 remaining are as for the cryptographic hash functions
2407 chash_start(int type, void * base)
2409 if (type == HMAC_MD5)
2410 md5_start((md5 *)base);
2412 sha1_start((hctx *)base);
2416 chash_mid(int type, void * base, const uschar * string)
2418 if (type == HMAC_MD5)
2419 md5_mid((md5 *)base, string);
2421 sha1_mid((hctx *)base, string);
2425 chash_end(int type, void * base, const uschar * string, int length,
2428 if (type == HMAC_MD5)
2429 md5_end((md5 *)base, string, length, digest);
2431 sha1_end((hctx *)base, string, length, digest);
2438 /* Do an hmac_md5. The result is _not_ nul-terminated, and is sized as
2439 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2442 key encoding key, nul-terminated
2443 src data to be hashed, nul-terminated
2445 len size of output buffer
2449 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2452 const uschar * keyptr;
2454 unsigned int keylen;
2456 #define MD5_HASHLEN 16
2457 #define MD5_HASHBLOCKLEN 64
2459 uschar keyhash[MD5_HASHLEN];
2460 uschar innerhash[MD5_HASHLEN];
2461 uschar finalhash[MD5_HASHLEN];
2462 uschar innerkey[MD5_HASHBLOCKLEN];
2463 uschar outerkey[MD5_HASHBLOCKLEN];
2466 keylen = Ustrlen(keyptr);
2468 /* If the key is longer than the hash block length, then hash the key
2471 if (keylen > MD5_HASHBLOCKLEN)
2473 chash_start(HMAC_MD5, &md5_base);
2474 chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2476 keylen = MD5_HASHLEN;
2479 /* Now make the inner and outer key values */
2481 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2482 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2484 for (int i = 0; i < keylen; i++)
2486 innerkey[i] ^= keyptr[i];
2487 outerkey[i] ^= keyptr[i];
2490 /* Now do the hashes */
2492 chash_start(HMAC_MD5, &md5_base);
2493 chash_mid(HMAC_MD5, &md5_base, innerkey);
2494 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2496 chash_start(HMAC_MD5, &md5_base);
2497 chash_mid(HMAC_MD5, &md5_base, outerkey);
2498 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2500 /* Encode the final hash as a hex string, limited by output buffer size */
2503 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2505 if (j-- <= 0) break;
2506 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2507 if (j-- <= 0) break;
2508 *p++ = hex_digits[finalhash[i] & 0x0f];
2512 #endif /*SUPPORT_SRS*/
2515 /*************************************************
2516 * Read and evaluate a condition *
2517 *************************************************/
2521 s points to the start of the condition text
2522 resetok points to a BOOL which is written false if it is unsafe to
2523 free memory. Certain condition types (acl) may have side-effect
2524 allocation which must be preserved.
2525 yield points to a BOOL to hold the result of the condition test;
2526 if NULL, we are just reading through a condition that is
2527 part of an "or" combination to check syntax, or in a state
2528 where the answer isn't required
2530 Returns: a pointer to the first character after the condition, or
2534 static const uschar *
2535 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2537 BOOL testfor = TRUE;
2538 BOOL tempcond, combined_cond;
2540 BOOL sub2_honour_dollar = TRUE;
2541 BOOL is_forany, is_json, is_jsons;
2543 int_eximarith_t num[2];
2544 struct stat statbuf;
2547 const uschar *sub[10];
2550 if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;
2552 switch(cond_type = identify_operator(&s, &opname))
2554 /* def: tests for a non-empty variable, or for the existence of a header. If
2555 yield == NULL we are in a skipping state, and don't care about the answer. */
2563 expand_string_message = US"\":\" expected after \"def\"";
2567 s = read_name(name, sizeof(name), s+1, US"_");
2569 /* Test for a header's existence. If the name contains a closing brace
2570 character, this may be a user error where the terminating colon has been
2571 omitted. Set a flag to adjust a subsequent error message in this case. */
2573 if ( ( *(t = name) == 'h'
2574 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2576 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2579 s = read_header_name(name, sizeof(name), s);
2580 /* {-for-text-editors */
2581 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2583 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2586 /* Test for a variable's having a non-empty value. A non-existent variable
2587 causes an expansion failure. */
2591 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2593 expand_string_message = name[0]
2594 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2595 : US"variable name omitted after \"def:\"";
2596 check_variable_error_message(name);
2599 if (yield) *yield = (t[0] != 0) == testfor;
2606 /* first_delivery tests for first delivery attempt */
2608 case ECOND_FIRST_DELIVERY:
2609 if (yield) *yield = f.deliver_firsttime == testfor;
2613 /* queue_running tests for any process started by a queue runner */
2615 case ECOND_QUEUE_RUNNING:
2616 if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2620 /* exists: tests for file existence
2621 isip: tests for any IP address
2622 isip4: tests for an IPv4 address
2623 isip6: tests for an IPv6 address
2624 pam: does PAM authentication
2625 radius: does RADIUS authentication
2626 ldapauth: does LDAP authentication
2627 pwcheck: does Cyrus SASL pwcheck authentication
2636 case ECOND_LDAPAUTH:
2639 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2641 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2642 if (!sub[0]) return NULL;
2643 /* {-for-text-editors */
2644 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2646 if (!yield) return s; /* No need to run the test if skipping */
2651 if ((expand_forbid & RDO_EXISTS) != 0)
2653 expand_string_message = US"File existence tests are not permitted";
2656 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2662 rc = string_is_ip_address(sub[0], NULL);
2663 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2664 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2667 /* Various authentication tests - all optionally compiled */
2671 rc = auth_call_pam(sub[0], &expand_string_message);
2674 goto COND_FAILED_NOT_COMPILED;
2675 #endif /* SUPPORT_PAM */
2678 #ifdef RADIUS_CONFIG_FILE
2679 rc = auth_call_radius(sub[0], &expand_string_message);
2682 goto COND_FAILED_NOT_COMPILED;
2683 #endif /* RADIUS_CONFIG_FILE */
2685 case ECOND_LDAPAUTH:
2688 /* Just to keep the interface the same */
2690 int old_pool = store_pool;
2691 store_pool = POOL_SEARCH;
2692 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2693 &expand_string_message, &do_cache);
2694 store_pool = old_pool;
2698 goto COND_FAILED_NOT_COMPILED;
2699 #endif /* LOOKUP_LDAP */
2702 #ifdef CYRUS_PWCHECK_SOCKET
2703 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2706 goto COND_FAILED_NOT_COMPILED;
2707 #endif /* CYRUS_PWCHECK_SOCKET */
2709 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2710 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2712 if (rc == ERROR || rc == DEFER) return NULL;
2713 *yield = (rc == OK) == testfor;
2719 /* call ACL (in a conditional context). Accept true, deny false.
2720 Defer is a forced-fail. Anything set by message= goes to $value.
2721 Up to ten parameters are used; we use the braces round the name+args
2722 like the saslauthd condition does, to permit a variable number of args.
2723 See also the expansion-item version EITEM_ACL and the traditional
2724 acl modifier ACLC_ACL.
2725 Since the ACL may allocate new global variables, tell our caller to not
2730 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2736 Uskip_whitespace(&s);
2737 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2739 switch(read_subs(sub, nelem(sub), 1,
2740 &s, yield == NULL, TRUE, name, resetok))
2742 case 1: expand_string_message = US"too few arguments or bracketing "
2745 case 3: return NULL;
2751 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2752 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2757 lookup_value = NULL;
2759 lookup_value = string_copy(user_msg);
2760 *yield = cond == testfor;
2764 f.expand_string_forcedfail = TRUE;
2767 expand_string_message = string_sprintf("%s from acl \"%s\"",
2768 rc_names[rc], sub[0]);
2776 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2778 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2780 However, the last two are optional. That is why the whole set is enclosed
2781 in their own set of braces. */
2783 case ECOND_SASLAUTHD:
2784 #ifndef CYRUS_SASLAUTHD_SOCKET
2785 goto COND_FAILED_NOT_COMPILED;
2789 Uskip_whitespace(&s);
2790 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2791 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, name,
2794 case 1: expand_string_message = US"too few arguments or bracketing "
2795 "error for saslauthd";
2797 case 3: return NULL;
2799 if (!sub[2]) sub[3] = NULL; /* realm if no service */
2802 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2803 &expand_string_message);
2804 if (rc == ERROR || rc == DEFER) return NULL;
2805 *yield = (rc == OK) == testfor;
2809 #endif /* CYRUS_SASLAUTHD_SOCKET */
2812 /* symbolic operators for numeric and string comparison, and a number of
2813 other operators, all requiring two arguments.
2815 crypteq: encrypts plaintext and compares against an encrypted text,
2816 using crypt(), crypt16(), MD5 or SHA-1
2817 inlist/inlisti: checks if first argument is in the list of the second
2818 match: does a regular expression match and sets up the numerical
2819 variables if it succeeds
2820 match_address: matches in an address list
2821 match_domain: matches in a domain list
2822 match_ip: matches a host list that is restricted to IP addresses
2823 match_local_part: matches in a local part list
2826 case ECOND_MATCH_ADDRESS:
2827 case ECOND_MATCH_DOMAIN:
2828 case ECOND_MATCH_IP:
2829 case ECOND_MATCH_LOCAL_PART:
2830 #ifndef EXPAND_LISTMATCH_RHS
2831 sub2_honour_dollar = FALSE;
2840 case ECOND_NUM_L: /* Numerical comparisons */
2847 case ECOND_STR_LT: /* String comparisons */
2858 for (int i = 0; i < 2; i++)
2860 /* Sometimes, we don't expand substrings; too many insecure configurations
2861 created using match_address{}{} and friends, where the second param
2862 includes information from untrustworthy sources. */
2863 BOOL honour_dollar = TRUE;
2864 if ((i > 0) && !sub2_honour_dollar)
2865 honour_dollar = FALSE;
2867 if (Uskip_whitespace(&s) != '{')
2869 if (i == 0) goto COND_FAILED_CURLY_START;
2870 expand_string_message = string_sprintf("missing 2nd string in {} "
2871 "after \"%s\"", opname);
2874 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2875 honour_dollar, resetok)))
2877 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2878 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2879 " for security reasons\n");
2880 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2882 /* Convert to numerical if required; we know that the names of all the
2883 conditions that compare numbers do not start with a letter. This just saves
2884 checking for them individually. */
2886 if (!isalpha(opname[0]) && yield)
2891 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2895 num[i] = expanded_string_integer(sub[i], FALSE);
2896 if (expand_string_message) return NULL;
2900 /* Result not required */
2902 if (!yield) return s;
2904 /* Do an appropriate comparison */
2910 tempcond = (num[0] == num[1]);
2914 tempcond = (num[0] > num[1]);
2918 tempcond = (num[0] >= num[1]);
2922 tempcond = (num[0] < num[1]);
2926 tempcond = (num[0] <= num[1]);
2930 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2934 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2938 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2942 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2946 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2950 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2954 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2958 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2962 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2966 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2969 case ECOND_MATCH: /* Regular expression match */
2971 const pcre2_code * re;
2975 if (!(re = pcre2_compile((PCRE2_SPTR)sub[1], PCRE2_ZERO_TERMINATED,
2976 PCRE_COPT, &err, &offset, pcre_cmp_ctx)))
2979 pcre2_get_error_message(err, errbuf, sizeof(errbuf));
2980 expand_string_message = string_sprintf("regular expression error in "
2981 "\"%s\": %s at offset %ld", sub[1], errbuf, (long)offset);
2985 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2989 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2990 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2991 goto MATCHED_SOMETHING;
2993 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2994 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2995 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2996 goto MATCHED_SOMETHING;
2998 case ECOND_MATCH_IP: /* Match IP address in a host list */
2999 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
3001 expand_string_message = string_sprintf("\"%s\" is not an IP address",
3007 unsigned int *nullcache = NULL;
3008 check_host_block cb;
3010 cb.host_name = US"";
3011 cb.host_address = sub[0];
3013 /* If the host address starts off ::ffff: it is an IPv6 address in
3014 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3017 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3018 cb.host_address + 7 : cb.host_address;
3020 rc = match_check_list(
3021 &sub[1], /* the list */
3022 0, /* separator character */
3023 &hostlist_anchor, /* anchor pointer */
3024 &nullcache, /* cache pointer */
3025 check_host, /* function for testing */
3026 &cb, /* argument for function */
3027 MCL_HOST, /* type of check */
3028 sub[0], /* text for debugging */
3029 NULL); /* where to pass back data */
3031 goto MATCHED_SOMETHING;
3033 case ECOND_MATCH_LOCAL_PART:
3034 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3035 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
3050 expand_string_message = string_sprintf("unable to complete match "
3051 "against \"%s\": %s", sub[1], search_error_message);
3057 /* Various "encrypted" comparisons. If the second string starts with
3058 "{" then an encryption type is given. Default to crypt() or crypt16()
3059 (build-time choice). */
3060 /* }-for-text-editors */
3063 #ifndef SUPPORT_CRYPTEQ
3064 goto COND_FAILED_NOT_COMPILED;
3066 if (strncmpic(sub[1], US"{md5}", 5) == 0)
3068 int sublen = Ustrlen(sub[1]+5);
3073 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3075 /* If the length that we are comparing against is 24, the MD5 digest
3076 is expressed as a base64 string. This is the way LDAP does it. However,
3077 some other software uses a straightforward hex representation. We assume
3078 this if the length is 32. Other lengths fail. */
3082 uschar *coded = b64encode(CUS digest, 16);
3083 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3084 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3085 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3087 else if (sublen == 32)
3090 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3092 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3093 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3094 tempcond = (strcmpic(coded, sub[1]+5) == 0);
3098 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3099 "fail\n crypted=%s\n", sub[1]+5);
3104 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3106 int sublen = Ustrlen(sub[1]+6);
3111 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3113 /* If the length that we are comparing against is 28, assume the SHA1
3114 digest is expressed as a base64 string. If the length is 40, assume a
3115 straightforward hex representation. Other lengths fail. */
3119 uschar *coded = b64encode(CUS digest, 20);
3120 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3121 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3122 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3124 else if (sublen == 40)
3127 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3129 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3130 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3131 tempcond = (strcmpic(coded, sub[1]+6) == 0);
3135 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3136 "fail\n crypted=%s\n", sub[1]+6);
3141 else /* {crypt} or {crypt16} and non-{ at start */
3142 /* }-for-text-editors */
3147 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3152 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3157 else if (sub[1][0] == '{') /* }-for-text-editors */
3159 expand_string_message = string_sprintf("unknown encryption mechanism "
3160 "in \"%s\"", sub[1]);
3166 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3167 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
3168 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3172 #define XSTR(s) STR(s)
3173 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3174 " subject=%s\n crypted=%s\n",
3175 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3180 /* If the encrypted string contains fewer than two characters (for the
3181 salt), force failure. Otherwise we get false positives: with an empty
3182 string the yield of crypt() is an empty string! */
3185 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3186 else if (errno == EINVAL)
3190 expand_string_message = string_sprintf("crypt error: %s\n",
3191 US strerror(errno));
3196 #endif /* SUPPORT_CRYPTEQ */
3201 const uschar * list = sub[1];
3203 uschar *save_iterate_item = iterate_item;
3204 int (*compare)(const uschar *, const uschar *);
3206 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);
3209 compare = cond_type == ECOND_INLISTI
3210 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3212 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3214 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3215 if (compare(sub[0], iterate_item) == 0)
3221 iterate_item = save_iterate_item;
3224 } /* Switch for comparison conditions */
3226 *yield = tempcond == testfor;
3227 return s; /* End of comparison conditions */
3230 /* and/or: computes logical and/or of several conditions */
3234 subcondptr = (yield == NULL) ? NULL : &tempcond;
3235 combined_cond = (cond_type == ECOND_AND);
3237 Uskip_whitespace(&s);
3238 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3242 /* {-for-text-editors */
3243 if (Uskip_whitespace(&s) == '}') break;
3244 if (*s != '{') /* }-for-text-editors */
3246 expand_string_message = string_sprintf("each subcondition "
3247 "inside an \"%s{...}\" condition must be in its own {}", opname);
3251 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3253 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3254 expand_string_message, opname);
3257 Uskip_whitespace(&s);
3259 /* {-for-text-editors */
3262 /* {-for-text-editors */
3263 expand_string_message = string_sprintf("missing } at end of condition "
3264 "inside \"%s\" group", opname);
3269 if (cond_type == ECOND_AND)
3271 combined_cond &= tempcond;
3272 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3273 } /* evaluate any more */
3276 combined_cond |= tempcond;
3277 if (combined_cond) subcondptr = NULL; /* once true, don't */
3278 } /* evaluate any more */
3281 if (yield) *yield = (combined_cond == testfor);
3285 /* forall/forany: iterates a condition with different values */
3287 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3288 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3289 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3290 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3291 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3292 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3296 const uschar * list;
3298 uschar *save_iterate_item = iterate_item;
3300 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3302 Uskip_whitespace(&s);
3303 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3304 if (!(sub[0] = expand_string_internal(s, TRUE, &s, yield == NULL, TRUE, resetok)))
3306 /* {-for-text-editors */
3307 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3309 Uskip_whitespace(&s);
3310 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3314 /* Call eval_condition once, with result discarded (as if scanning a
3315 "false" part). This allows us to find the end of the condition, because if
3316 the list it empty, we won't actually evaluate the condition for real. */
3318 if (!(s = eval_condition(sub[1], resetok, NULL)))
3320 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3321 expand_string_message, opname);
3324 Uskip_whitespace(&s);
3326 /* {-for-text-editors */
3329 /* {-for-text-editors */
3330 expand_string_message = string_sprintf("missing } at end of condition "
3331 "inside \"%s\"", opname);
3335 if (yield) *yield = !testfor;
3337 if (is_json) list = dewrap(string_copy(list), US"[]");
3338 while ((iterate_item = is_json
3339 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3342 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3344 expand_string_message =
3345 string_sprintf("%s wrapping string result for extract jsons",
3346 expand_string_message);
3347 iterate_item = save_iterate_item;
3351 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3352 if (!eval_condition(sub[1], resetok, &tempcond))
3354 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3355 expand_string_message, opname);
3356 iterate_item = save_iterate_item;
3359 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3360 tempcond? "true":"false");
3362 if (yield) *yield = (tempcond == testfor);
3363 if (tempcond == is_forany) break;
3366 iterate_item = save_iterate_item;
3371 /* The bool{} expansion condition maps a string to boolean.
3372 The values supported should match those supported by the ACL condition
3373 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3374 of true/false. Note that Router "condition" rules have a different
3375 interpretation, where general data can be used and only a few values
3377 Note that readconf.c boolean matching, for boolean configuration options,
3378 only matches true/yes/false/no.
3379 The bool_lax{} condition matches the Router logic, which is much more
3382 case ECOND_BOOL_LAX:
3388 BOOL boolvalue = FALSE;
3390 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3391 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3392 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3394 case 1: expand_string_message = string_sprintf(
3395 "too few arguments or bracketing error for %s",
3399 case 3: return NULL;
3402 Uskip_whitespace(&t);
3403 if ((len = Ustrlen(t)))
3405 /* trailing whitespace: seems like a good idea to ignore it too */
3407 while (isspace(*t2)) t2--;
3408 if (t2 != (t + len))
3415 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3416 /* logic for the lax case from expand_check_condition(), which also does
3417 expands, and the logic is both short and stable enough that there should
3418 be no maintenance burden from replicating it. */
3422 ? Ustrspn(t+1, "0123456789") == len-1
3423 : Ustrspn(t, "0123456789") == len)
3425 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3426 /* expand_check_condition only does a literal string "0" check */
3427 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3430 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3432 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3434 else if (cond_type == ECOND_BOOL_LAX)
3438 expand_string_message = string_sprintf("unrecognised boolean "
3442 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3443 boolvalue? "true":"false");
3444 if (yield) *yield = (boolvalue == testfor);
3449 case ECOND_INBOUND_SRS:
3450 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */
3453 const pcre2_code * re;
3454 pcre2_match_data * md;
3458 BOOL boolvalue = FALSE;
3460 switch(read_subs(sub, 2, 2, CUSS &s, yield == NULL, FALSE, name, resetok))
3462 case 1: expand_string_message = US"too few arguments or bracketing "
3463 "error for inbound_srs";
3465 case 3: return NULL;
3468 /* Match the given local_part against the SRS-encoded pattern */
3470 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]+)=([^=]*)=(.*)$",
3472 md = pcre2_match_data_create(4+1, pcre_gen_ctx);
3473 if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,
3474 md, pcre_mtc_ctx) < 0)
3476 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3479 ovec = pcre2_get_ovector_pointer(md);
3481 if (sub[0][0] == '"')
3483 else for (uschar * s = sub[0]; *s; s++)
3484 if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3485 { quoting = 1; break; }
3487 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3489 /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3491 srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S", /* lowercased */
3493 (int) (ovec[9]-ovec[8]), sub[0] + ovec[8], /* substr 4 */
3495 (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */
3497 /* If a zero-length secret was given, we're done. Otherwise carry on
3498 and validate the given SRS local_part againt our secret. */
3506 /* check the timestamp */
3509 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3513 gettimeofday(&now, NULL);
3514 now.tv_sec /= 86400; /* days since epoch */
3516 /* Decode substring 2 from base32 to a number */
3518 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3520 uschar * t = Ustrchr(base32_chars, *ss++);
3521 d = d * 32 + (t - base32_chars);
3524 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3526 DEBUG(D_expand) debug_printf("SRS too old\n");
3531 /* check length of substring 1, the offered checksum */
3533 if (ovec[3]-ovec[2] != 4)
3535 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3539 /* Hash the address with our secret, and compare that computed checksum
3540 with the one extracted from the arg */
3542 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3543 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3545 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3551 if (yield) *yield = (boolvalue == testfor);
3554 #endif /*SUPPORT_SRS*/
3556 /* Unknown condition */
3559 if (!expand_string_message || !*expand_string_message)
3560 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3562 } /* End switch on condition type */
3564 /* Missing braces at start and end of data */
3566 COND_FAILED_CURLY_START:
3567 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3570 COND_FAILED_CURLY_END:
3571 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3575 /* A condition requires code that is not compiled */
3577 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3578 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3579 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3580 COND_FAILED_NOT_COMPILED:
3581 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3590 /*************************************************
3591 * Save numerical variables *
3592 *************************************************/
3594 /* This function is called from items such as "if" that want to preserve and
3595 restore the numbered variables.
3598 save_expand_string points to an array of pointers to set
3599 save_expand_nlength points to an array of ints for the lengths
3601 Returns: the value of expand max to save
3605 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3607 for (int i = 0; i <= expand_nmax; i++)
3609 save_expand_nstring[i] = expand_nstring[i];
3610 save_expand_nlength[i] = expand_nlength[i];
3617 /*************************************************
3618 * Restore numerical variables *
3619 *************************************************/
3621 /* This function restored saved values of numerical strings.
3624 save_expand_nmax the number of strings to restore
3625 save_expand_string points to an array of pointers
3626 save_expand_nlength points to an array of ints
3632 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3633 int *save_expand_nlength)
3635 expand_nmax = save_expand_nmax;
3636 for (int i = 0; i <= expand_nmax; i++)
3638 expand_nstring[i] = save_expand_nstring[i];
3639 expand_nlength[i] = save_expand_nlength[i];
3647 /*************************************************
3648 * Handle yes/no substrings *
3649 *************************************************/
3651 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3652 alternative substrings that depend on whether or not the condition was true,
3653 or the lookup or extraction succeeded. The substrings always have to be
3654 expanded, to check their syntax, but "skipping" is set when the result is not
3655 needed - this avoids unnecessary nested lookups.
3658 skipping TRUE if we were skipping when this item was reached
3659 yes TRUE if the first string is to be used, else use the second
3660 save_lookup a value to put back into lookup_value before the 2nd expansion
3661 sptr points to the input string pointer
3662 yieldptr points to the output growable-string pointer
3663 type "lookup", "if", "extract", "run", "env", "listextract" or
3664 "certextract" for error message
3665 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3668 Returns: 0 OK; lookup_value has been reset to save_lookup
3670 2 expansion failed because of bracketing error
3674 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3675 gstring ** yieldptr, uschar *type, BOOL *resetok)
3678 const uschar *s = *sptr; /* Local value */
3679 uschar *sub1, *sub2;
3680 const uschar * errwhere;
3682 /* If there are no following strings, we substitute the contents of $value for
3683 lookups and for extractions in the success case. For the ${if item, the string
3684 "true" is substituted. In the fail case, nothing is substituted for all three
3687 if (skip_whitespace(&s) == '}')
3691 if (yes && !skipping)
3692 *yieldptr = string_catn(*yieldptr, US"true", 4);
3696 if (yes && lookup_value && !skipping)
3697 *yieldptr = string_cat(*yieldptr, lookup_value);
3698 lookup_value = save_lookup;
3704 /* The first following string must be braced. */
3708 errwhere = US"'yes' part did not start with '{'";
3712 /* Expand the first substring. Forced failures are noticed only if we actually
3713 want this string. Set skipping in the call in the fail case (this will always
3714 be the case if we were already skipping). */
3716 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3717 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3718 f.expand_string_forcedfail = FALSE;
3721 errwhere = US"'yes' part did not end with '}'";
3725 /* If we want the first string, add it to the output */
3728 *yieldptr = string_cat(*yieldptr, sub1);
3730 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3731 $value to what it was at the start of the item, so that it has this value
3732 during the second string expansion. For the call from "if" or "run" to this
3733 function, save_lookup is set to lookup_value, so that this statement does
3736 lookup_value = save_lookup;
3738 /* There now follows either another substring, or "fail", or nothing. This
3739 time, forced failures are noticed only if we want the second string. We must
3740 set skipping in the nested call if we don't want this string, or if we were
3741 already skipping. */
3743 if (skip_whitespace(&s) == '{')
3745 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3746 if (sub2 == NULL && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3747 f.expand_string_forcedfail = FALSE;
3750 errwhere = US"'no' part did not start with '{'";
3754 /* If we want the second string, add it to the output */
3757 *yieldptr = string_cat(*yieldptr, sub2);
3760 /* If there is no second string, but the word "fail" is present when the use of
3761 the second string is wanted, set a flag indicating it was a forced failure
3762 rather than a syntactic error. Swallow the terminating } in case this is nested
3763 inside another lookup or if or extract. */
3768 /* deconst cast ok here as source is s anyway */
3769 s = US read_name(name, sizeof(name), s, US"_");
3770 if (Ustrcmp(name, "fail") == 0)
3772 if (!yes && !skipping)
3774 Uskip_whitespace(&s);
3777 errwhere = US"did not close with '}' after forcedfail";
3780 expand_string_message =
3781 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3782 f.expand_string_forcedfail = TRUE;
3788 expand_string_message =
3789 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3794 /* All we have to do now is to check on the final closing brace. */
3796 skip_whitespace(&s);
3799 errwhere = US"did not close with '}'";
3805 /* Update the input pointer value before returning */
3810 /* Get here if there is a bracketing failure */
3811 expand_string_message = string_sprintf(
3812 "curly-bracket problem in conditional yes/no parsing: %s\n"
3813 " remaining string is '%s'", errwhere, --s);
3818 /* Get here for other failures */
3826 /********************************************************
3827 * prvs: Get last three digits of days since Jan 1, 1970 *
3828 ********************************************************/
3830 /* This is needed to implement the "prvs" BATV reverse
3833 Argument: integer "days" offset to add or substract to
3834 or from the current number of days.
3836 Returns: pointer to string containing the last three
3837 digits of the number of days since Jan 1, 1970,
3838 modified by the offset argument, NULL if there
3839 was an error in the conversion.
3844 prvs_daystamp(int day_offset)
3846 uschar *days = store_get(32, FALSE); /* Need at least 24 for cases */
3847 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3848 (time(NULL) + day_offset*86400)/86400);
3849 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3854 /********************************************************
3855 * prvs: perform HMAC-SHA1 computation of prvs bits *
3856 ********************************************************/
3858 /* This is needed to implement the "prvs" BATV reverse
3862 address RFC2821 Address to use
3863 key The key to use (must be less than 64 characters
3865 key_num Single-digit key number to use. Defaults to
3868 Returns: pointer to string containing the first three
3869 bytes of the final hash in hex format, NULL if
3870 there was an error in the process.
3874 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3876 gstring * hash_source;
3879 uschar innerhash[20];
3880 uschar finalhash[20];
3881 uschar innerkey[64];
3882 uschar outerkey[64];
3883 uschar *finalhash_hex;
3888 if (Ustrlen(key) > 64)
3891 hash_source = string_catn(NULL, key_num, 1);
3892 hash_source = string_catn(hash_source, daystamp, 3);
3893 hash_source = string_cat(hash_source, address);
3894 (void) string_from_gstring(hash_source);
3897 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3899 memset(innerkey, 0x36, 64);
3900 memset(outerkey, 0x5c, 64);
3902 for (int i = 0; i < Ustrlen(key); i++)
3904 innerkey[i] ^= key[i];
3905 outerkey[i] ^= key[i];
3908 chash_start(HMAC_SHA1, &h);
3909 chash_mid(HMAC_SHA1, &h, innerkey);
3910 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3912 chash_start(HMAC_SHA1, &h);
3913 chash_mid(HMAC_SHA1, &h, outerkey);
3914 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3916 /* Hashing is deemed sufficient to de-taint any input data */
3918 p = finalhash_hex = store_get(40, FALSE);
3919 for (int i = 0; i < 3; i++)
3921 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3922 *p++ = hex_digits[finalhash[i] & 0x0f];
3926 return finalhash_hex;
3932 /*************************************************
3933 * Join a file onto the output string *
3934 *************************************************/
3936 /* This is used for readfile/readsock and after a run expansion.
3937 It joins the contents of a file onto the output string, globally replacing
3938 newlines with a given string (optionally).
3942 yield pointer to the expandable string struct
3943 eol newline replacement string, or NULL
3945 Returns: new pointer for expandable string, terminated if non-null
3949 cat_file(FILE *f, gstring *yield, uschar *eol)
3951 uschar buffer[1024];
3953 while (Ufgets(buffer, sizeof(buffer), f))
3955 int len = Ustrlen(buffer);
3956 if (eol && buffer[len-1] == '\n') len--;
3957 yield = string_catn(yield, buffer, len);
3958 if (eol && buffer[len])
3959 yield = string_cat(yield, eol);
3962 (void) string_from_gstring(yield);
3969 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
3972 uschar buffer[1024];
3974 /*XXX could we read direct into a pre-grown string? */
3976 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
3977 for (uschar * s = buffer; rc--; s++)
3978 yield = eol && *s == '\n'
3979 ? string_cat(yield, eol) : string_catn(yield, s, 1);
3981 /* We assume that all errors, and any returns of zero bytes,
3982 are actually EOF. */
3984 (void) string_from_gstring(yield);
3990 /*************************************************
3991 * Evaluate numeric expression *
3992 *************************************************/
3994 /* This is a set of mutually recursive functions that evaluate an arithmetic
3995 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3996 these functions that is called from elsewhere is eval_expr, whose interface is:
3999 sptr pointer to the pointer to the string - gets updated
4000 decimal TRUE if numbers are to be assumed decimal
4001 error pointer to where to put an error message - must be NULL on input
4002 endket TRUE if ')' must terminate - FALSE for external call
4004 Returns: on success: the value of the expression, with *error still NULL
4005 on failure: an undefined value, with *error = a message
4008 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4011 static int_eximarith_t
4012 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4015 int_eximarith_t x = eval_op_or(&s, decimal, error);
4020 *error = US"expecting closing parenthesis";
4022 while (isspace(*++s));
4024 *error = US"expecting operator";
4030 static int_eximarith_t
4031 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4037 if (isdigit((c = Uskip_whitespace(&s))))
4040 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4042 switch (tolower(*s))
4045 case 'k': n *= 1024; s++; break;
4046 case 'm': n *= 1024*1024; s++; break;
4047 case 'g': n *= 1024*1024*1024; s++; break;
4049 Uskip_whitespace(&s);
4054 n = eval_expr(&s, decimal, error, 1);
4058 *error = US"expecting number or opening parenthesis";
4066 static int_eximarith_t
4067 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4071 Uskip_whitespace(&s);
4072 if (*s == '+' || *s == '-' || *s == '~')
4075 x = eval_op_unary(&s, decimal, error);
4076 if (op == '-') x = -x;
4077 else if (op == '~') x = ~x;
4080 x = eval_number(&s, decimal, error);
4087 static int_eximarith_t
4088 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4091 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4094 while (*s == '*' || *s == '/' || *s == '%')
4097 int_eximarith_t y = eval_op_unary(&s, decimal, error);
4099 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4100 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4101 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4102 * -N*M is INT_MIN will yield INT_MIN.
4103 * Since we don't support floating point, this is somewhat simpler.
4104 * Ideally, we'd return an error, but since we overflow for all other
4105 * arithmetic, consistency suggests otherwise, but what's the correct value
4106 * to use? There is none.
4107 * The C standard guarantees overflow for unsigned arithmetic but signed
4108 * overflow invokes undefined behaviour; in practice, this is overflow
4109 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4110 * that long/longlong larger than int are available, or we could just work
4111 * with larger types. We should consider whether to guarantee 32bit eval
4112 * and 64-bit working variables, with errors returned. For now ...
4113 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4114 * can just let the other invalid results occur otherwise, as they have
4115 * until now. For this one case, we can coerce.
4117 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4120 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4121 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4131 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4147 static int_eximarith_t
4148 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4151 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4154 while (*s == '+' || *s == '-')
4157 int_eximarith_t y = eval_op_mult(&s, decimal, error);
4159 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4160 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4161 { /* over-conservative check */
4163 ? US"overflow in sum" : US"overflow in difference";
4166 if (op == '+') x += y; else x -= y;
4174 static int_eximarith_t
4175 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4178 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4181 while ((*s == '<' || *s == '>') && s[1] == s[0])
4186 y = eval_op_sum(&s, decimal, error);
4188 if (op == '<') x <<= y; else x >>= y;
4196 static int_eximarith_t
4197 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4200 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4207 y = eval_op_shift(&s, decimal, error);
4217 static int_eximarith_t
4218 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4221 int_eximarith_t x = eval_op_and(&s, decimal, error);
4228 y = eval_op_and(&s, decimal, error);
4238 static int_eximarith_t
4239 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4242 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4249 y = eval_op_xor(&s, decimal, error);
4260 /************************************************/
4261 /* Comparison operation for sort expansion. We need to avoid
4262 re-expanding the fields being compared, so need a custom routine.
4265 cond_type Comparison operator code
4266 leftarg, rightarg Arguments for comparison
4268 Return true iff (leftarg compare rightarg)
4272 sortsbefore(int cond_type, BOOL alpha_cond,
4273 const uschar * leftarg, const uschar * rightarg)
4275 int_eximarith_t l_num, r_num;
4279 l_num = expanded_string_integer(leftarg, FALSE);
4280 if (expand_string_message) return FALSE;
4281 r_num = expanded_string_integer(rightarg, FALSE);
4282 if (expand_string_message) return FALSE;
4286 case ECOND_NUM_G: return l_num > r_num;
4287 case ECOND_NUM_GE: return l_num >= r_num;
4288 case ECOND_NUM_L: return l_num < r_num;
4289 case ECOND_NUM_LE: return l_num <= r_num;
4296 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4297 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4298 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4299 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4300 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4301 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4302 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4303 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4306 return FALSE; /* should not happen */
4310 /* Expand a named list. Return false on failure. */
4312 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4314 tree_node *t = NULL;
4315 const uschar * list;
4318 BOOL needsep = FALSE;
4319 #define LISTNAMED_BUF_SIZE 256
4320 uschar b[LISTNAMED_BUF_SIZE];
4321 uschar * buffer = b;
4323 if (*name == '+') name++;
4324 if (!listtype) /* no-argument version */
4326 if ( !(t = tree_search(addresslist_anchor, name))
4327 && !(t = tree_search(domainlist_anchor, name))
4328 && !(t = tree_search(hostlist_anchor, name)))
4329 t = tree_search(localpartlist_anchor, name);
4331 else switch(*listtype) /* specific list-type version */
4333 case 'a': t = tree_search(addresslist_anchor, name); break;
4334 case 'd': t = tree_search(domainlist_anchor, name); break;
4335 case 'h': t = tree_search(hostlist_anchor, name); break;
4336 case 'l': t = tree_search(localpartlist_anchor, name); break;
4338 expand_string_message = US"bad suffix on \"list\" operator";
4344 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4346 : *listtype=='a'?"address "
4347 : *listtype=='d'?"domain "
4348 : *listtype=='h'?"host "
4349 : *listtype=='l'?"localpart "
4354 list = ((namedlist_block *)(t->data.ptr))->string;
4356 /* The list could be quite long so we (re)use a buffer for each element
4357 rather than getting each in new memory */
4359 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, TRUE);
4360 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4362 uschar * buf = US" : ";
4364 yield = string_catn(yield, buf, 3);
4368 if (*item == '+') /* list item is itself a named list */
4370 yield = expand_listnamed(yield, item, listtype);
4371 if (expand_string_message)
4375 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
4378 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4380 for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4382 yield = string_catn(yield, item, cp - CS item);
4383 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4384 yield = string_catn(yield, US"::", 2);
4385 else /* sep in item; should already be doubled; emit once */
4387 yield = string_catn(yield, US tok, 1);
4388 if (*cp == sep) cp++;
4391 yield = string_cat(yield, item);
4394 yield = string_cat(yield, item);
4401 /************************************************/
4403 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4407 debug_printf_indent("|");
4409 debug_printf_indent(UTF8_VERT_RIGHT);
4411 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4415 debug_printf(UTF8_HORIZ);
4417 debug_printf("%s: %.*s\n", what, nchar, value);
4418 if (is_tainted(value))
4421 debug_printf_indent("%s \\__", skipping ? "| " : " ");
4423 debug_printf_indent("%s",
4425 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
4426 debug_printf("(tainted)\n");
4431 /*************************************************
4433 *************************************************/
4435 /* Returns either an unchanged string, or the expanded string in stacking pool
4436 store. Interpreted sequences are:
4438 \... normal escaping rules
4439 $name substitutes the variable
4441 ${op:string} operates on the expanded string value
4442 ${item{arg1}{arg2}...} expands the args and then does the business
4443 some literal args are not enclosed in {}
4445 There are now far too many operators and item types to make it worth listing
4446 them here in detail any more.
4448 We use an internal routine recursively to handle embedded substrings. The
4449 external function follows. The yield is NULL if the expansion failed, and there
4450 are two cases: if something collapsed syntactically, or if "fail" was given
4451 as the action on a lookup failure. These can be distinguished by looking at the
4452 variable expand_string_forcedfail, which is TRUE in the latter case.
4454 The skipping flag is set true when expanding a substring that isn't actually
4455 going to be used (after "if" or "lookup") and it prevents lookups from
4456 happening lower down.
4458 Store usage: At start, a store block of the length of the input plus 64
4459 is obtained. This is expanded as necessary by string_cat(), which might have to
4460 get a new block, or might be able to expand the original. At the end of the
4461 function we can release any store above that portion of the yield block that
4462 was actually used. In many cases this will be optimal.
4464 However: if the first item in the expansion is a variable name or header name,
4465 we reset the store before processing it; if the result is in fresh store, we
4466 use that without copying. This is helpful for expanding strings like
4467 $message_headers which can get very long.
4469 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4470 since resetting the store at the end of the expansion will free store that was
4471 allocated by the plugin code as well as the slop after the expanded string. So
4472 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4473 and, given the acl condition, ${if }. This is an unfortunate consequence of
4474 string expansion becoming too powerful.
4477 string the string to be expanded
4478 ket_ends true if expansion is to stop at }
4479 left if not NULL, a pointer to the first character after the
4480 expansion is placed here (typically used with ket_ends)
4481 skipping TRUE for recursive calls when the value isn't actually going
4482 to be used (to allow for optimisation)
4483 honour_dollar TRUE if $ is to be expanded,
4484 FALSE if it's just another character
4485 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4488 Returns: NULL if expansion fails:
4489 expand_string_forcedfail is set TRUE if failure was forced
4490 expand_string_message contains a textual error message
4491 a pointer to the expanded string on success
4495 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
4496 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
4498 rmark reset_point = store_mark();
4499 gstring * yield = string_get(Ustrlen(string) + 64);
4501 const uschar * s = string;
4502 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4503 int save_expand_nlength[EXPAND_MAXN+1];
4504 BOOL resetok = TRUE, first = TRUE;
4507 f.expand_string_forcedfail = FALSE;
4508 expand_string_message = US"";
4511 if ((m = is_tainted2(string, LOG_MAIN|LOG_PANIC, "Tainted string '%s' in expansion", s)))
4513 expand_string_message = m;
4525 debug_printf_indent("%c%s: %s\n",
4527 skipping ? "---scanning" : "considering", s);
4529 debug_printf_indent("%s%s: %s\n",
4530 first ? UTF8_DOWN_RIGHT : UTF8_VERT_RIGHT,
4532 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4538 /* \ escapes the next character, which must exist, or else
4539 the expansion fails. There's a special escape, \N, which causes
4540 copying of the subject verbatim up to the next \N. Otherwise,
4541 the escapes are the standard set. */
4547 expand_string_message = US"\\ at end of string";
4553 const uschar * t = s + 2;
4554 for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4557 debug_expansion_interim(US"protected", t, (int)(s - t), skipping);
4558 yield = string_catn(yield, t, s - t);
4566 debug_printf_indent("|backslashed: '\\%c'\n", s[1]);
4568 debug_printf_indent(UTF8_VERT_RIGHT "backslashed: '\\%c'\n", s[1]);
4569 ch[0] = string_interpret_escape(&s);
4571 yield = string_catn(yield, ch, 1);
4577 /* Anything other than $ is just copied verbatim, unless we are
4578 looking for a terminating } character. */
4580 if (ket_ends && *s == '}') break;
4582 if (*s != '$' || !honour_dollar)
4585 for (const uschar * t = s+1;
4586 *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4588 DEBUG(D_expand) debug_expansion_interim(US"text", s, i, skipping);
4590 yield = string_catn(yield, s, i);
4595 /* No { after the $ - must be a plain name or a number for string
4596 match variable. There has to be a fudge for variables that are the
4597 names of header fields preceded by "$header_" because header field
4598 names can contain any printing characters except space and colon.
4599 For those that don't like typing this much, "$h_" is a synonym for
4600 "$header_". A non-existent header yields a NULL value; nothing is
4605 const uschar * value;
4606 int newsize = 0, len;
4610 s = read_name(name, sizeof(name), s, US"_");
4612 /* If this is the first thing to be expanded, release the pre-allocated
4616 g = store_get(sizeof(gstring), FALSE);
4617 else if (yield->ptr == 0)
4619 if (resetok) reset_point = store_reset(reset_point);
4621 reset_point = store_mark();
4622 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
4627 if ( ( *(t = name) == 'h'
4628 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4630 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4633 unsigned flags = *name == 'r' ? FH_WANT_RAW
4634 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4636 const uschar * charset = *name == 'b' ? NULL : headers_charset;
4638 s = read_header_name(name, sizeof(name), s);
4639 value = find_header(name, &newsize, flags, charset);
4641 /* If we didn't find the header, and the header contains a closing brace
4642 character, this may be a user error where the terminating colon
4643 has been omitted. Set a flag to adjust the error message in this case.
4644 But there is no error here - nothing gets inserted. */
4648 if (Ustrchr(name, '}')) malformed_header = TRUE;
4655 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4657 expand_string_message =
4658 string_sprintf("unknown variable name \"%s\"", name);
4659 check_variable_error_message(name);
4663 /* If the data is known to be in a new buffer, newsize will be set to the
4664 size of that buffer. If this is the first thing in an expansion string,
4665 yield will be NULL; just point it at the new store instead of copying. Many
4666 expansion strings contain just one reference, so this is a useful
4667 optimization, especially for humungous headers. We need to use a gstring
4668 structure that is not allocated after that new-buffer, else a later store
4669 reset in the middle of the buffer will make it inaccessible. */
4671 len = Ustrlen(value);
4672 if (!yield && newsize != 0)
4675 yield->size = newsize;
4677 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4680 yield = string_catn(yield, value, len);
4688 s = read_cnumber(&n, s);
4689 if (n >= 0 && n <= expand_nmax)
4690 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4694 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4696 if (*s != '{') /*}*/
4698 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4702 /* After { there can be various things, but they all start with
4703 an initial word, except for a number for a string match variable. */ /*}*/
4708 s = read_cnumber(&n, s); /*{{*/
4711 expand_string_message = US"} expected after number";
4714 if (n >= 0 && n <= expand_nmax)
4715 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4721 expand_string_message = US"letter or digit expected after ${"; /*}*/
4725 /* Allow "-" in names to cater for substrings with negative
4726 arguments. Since we are checking for known names after { this is
4729 s = read_name(name, sizeof(name), s, US"_-");
4730 item_type = chop_match(name, item_table, nelem(item_table));
4732 /* Switch on item type. All nondefault choices should "continue* when
4733 skipping, but "break" otherwise so we get debug output for the item
4736 int start = yield->ptr;
4739 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4740 If the ACL returns accept or reject we return content set by "message ="
4741 There is currently no limit on recursion; this would have us call
4742 acl_check_internal() directly and get a current level from somewhere.
4743 See also the acl expansion condition ECOND_ACL and the traditional
4744 acl modifier ACLC_ACL.
4745 Assume that the function has side-effects on the store that must be preserved.
4749 /* ${acl {name} {arg1}{arg2}...} */
4751 uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4755 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, name,
4758 case 1: goto EXPAND_FAILED_CURLY;
4760 case 3: goto EXPAND_FAILED;
4762 if (skipping) continue;
4765 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4770 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4772 yield = string_cat(yield, user_msg);
4776 f.expand_string_forcedfail = TRUE;
4779 expand_string_message = string_sprintf("%s from acl \"%s\"",
4780 rc_names[rc], sub[0]);
4786 case EITEM_AUTHRESULTS:
4787 /* ${authresults {mysystemname}} */
4789 uschar * sub_arg[1];
4791 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4794 case 1: goto EXPAND_FAILED_CURLY;
4796 case 3: goto EXPAND_FAILED;
4799 yield = string_append(yield, 3,
4800 US"Authentication-Results: ", sub_arg[0], US"; none");
4803 yield = authres_local(yield, sub_arg[0]);
4804 yield = authres_iprev(yield);
4805 yield = authres_smtpauth(yield);
4807 yield = authres_spf(yield);
4809 #ifndef DISABLE_DKIM
4810 yield = authres_dkim(yield);
4812 #ifdef SUPPORT_DMARC
4813 yield = authres_dmarc(yield);
4815 #ifdef EXPERIMENTAL_ARC
4816 yield = authres_arc(yield);
4821 /* Handle conditionals - preserve the values of the numerical expansion
4822 variables in case they get changed by a regular expression match in the
4823 condition. If not, they retain their external settings. At the end
4824 of this "if" section, they get restored to their previous values. */
4829 const uschar *next_s;
4830 int save_expand_nmax =
4831 save_expand_strings(save_expand_nstring, save_expand_nlength);
4833 Uskip_whitespace(&s);
4834 if (!(next_s = eval_condition(s, &resetok, skipping ? NULL : &cond)))
4835 goto EXPAND_FAILED; /* message already set */
4839 debug_expansion_interim(US"condition", s, (int)(next_s - s), skipping);
4840 debug_expansion_interim(US"result",
4841 cond ? US"true" : US"false", cond ? 4 : 5, skipping);
4846 /* The handling of "yes" and "no" result strings is now in a separate
4847 function that is also used by ${lookup} and ${extract} and ${run}. */
4849 switch(process_yesno(
4850 skipping, /* were previously skipping */
4851 cond, /* success/failure indicator */
4852 lookup_value, /* value to reset for string2 */
4853 &s, /* input pointer */
4854 &yield, /* output pointer */
4855 US"if", /* condition type */
4858 case 1: goto EXPAND_FAILED; /* when all is well, the */
4859 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4862 /* Restore external setting of expansion variables for continuation
4865 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4866 save_expand_nlength);
4871 case EITEM_IMAPFOLDER:
4872 { /* ${imapfolder {name}{sep}{specials}} */
4876 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4879 case 1: goto EXPAND_FAILED_CURLY;
4881 case 3: goto EXPAND_FAILED;
4884 if (!sub_arg[1]) /* One argument */
4886 sub_arg[1] = US"/"; /* default separator */
4889 else if (Ustrlen(sub_arg[1]) != 1)
4891 expand_string_message =
4893 "IMAP folder separator must be one character, found \"%s\"",
4898 if (skipping) continue;
4900 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4901 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4903 yield = string_cat(yield, encoded);
4908 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4909 expanding an internal string that isn't actually going to be used. All we
4910 need to do is check the syntax, so don't do a lookup at all. Preserve the
4911 values of the numerical expansion variables in case they get changed by a
4912 partial lookup. If not, they retain their external settings. At the end
4913 of this "lookup" section, they get restored to their previous values. */
4917 int stype, partial, affixlen, starflags;
4918 int expand_setup = 0;
4920 uschar * key, * filename;
4921 const uschar * affix, * opts;
4922 uschar * save_lookup_value = lookup_value;
4923 int save_expand_nmax =
4924 save_expand_strings(save_expand_nstring, save_expand_nlength);
4926 if (expand_forbid & RDO_LOOKUP)
4928 expand_string_message = US"lookup expansions are not permitted";
4932 /* Get the key we are to look up for single-key+file style lookups.
4933 Otherwise set the key NULL pro-tem. */
4935 if (Uskip_whitespace(&s) == '{') /*}*/
4937 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4938 if (!key) goto EXPAND_FAILED; /*{{*/
4941 expand_string_message = US"missing '}' after lookup key";
4942 goto EXPAND_FAILED_CURLY;
4944 Uskip_whitespace(&s);
4948 /* Find out the type of database */
4952 expand_string_message = US"missing lookup type";
4956 /* The type is a string that may contain special characters of various
4957 kinds. Allow everything except space or { to appear; the actual content
4958 is checked by search_findtype_partial. */ /*}*/
4960 while (*s && *s != '{' && !isspace(*s)) /*}*/
4962 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4965 name[nameptr] = '\0';
4966 Uskip_whitespace(&s);
4968 /* Now check for the individual search type and any partial or default
4969 options. Only those types that are actually in the binary are valid. */
4971 if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4972 &starflags, &opts)) < 0)
4974 expand_string_message = search_error_message;
4978 /* Check that a key was provided for those lookup types that need it,
4979 and was not supplied for those that use the query style. */
4981 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4985 expand_string_message = string_sprintf("missing {key} for single-"
4986 "key \"%s\" lookup", name);
4992 expand_string_message = string_sprintf("a single key was given for "
4993 "lookup type \"%s\", which is not a single-key lookup type", name);
4997 /* Get the next string in brackets and expand it. It is the file name for
4998 single-key+file lookups, and the whole query otherwise. In the case of
4999 queries that also require a file name (e.g. sqlite), the file name comes
5004 expand_string_message = US"missing '{' for lookup file-or-query arg";
5005 goto EXPAND_FAILED_CURLY; /*}}*/
5007 if (!(filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
5012 expand_string_message = US"missing '}' closing lookup file-or-query arg";
5013 goto EXPAND_FAILED_CURLY;
5015 Uskip_whitespace(&s);
5017 /* If this isn't a single-key+file lookup, re-arrange the variables
5018 to be appropriate for the search_ functions. For query-style lookups,
5019 there is just a "key", and no file name. For the special query-style +
5020 file types, the query (i.e. "key") starts with a file name. */
5023 key = search_args(stype, name, filename, &filename, opts);
5025 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5026 the entry was not found. Note that there is no search_close() function.
5027 Files are left open in case of re-use. At suitable places in higher logic,
5028 search_tidyup() is called to tidy all open files. This can save opening
5029 the same file several times. However, files may also get closed when
5030 others are opened, if too many are open at once. The rule is that a
5031 handle should not be used after a second search_open().
5033 Request that a partial search sets up $1 and maybe $2 by passing
5034 expand_setup containing zero. If its value changes, reset expand_nmax,
5035 since new variables will have been set. Note that at the end of this
5036 "lookup" section, the old numeric variables are restored. */
5039 lookup_value = NULL;
5042 void * handle = search_open(filename, stype, 0, NULL, NULL);
5045 expand_string_message = search_error_message;
5048 lookup_value = search_find(handle, filename, key, partial, affix,
5049 affixlen, starflags, &expand_setup, opts);
5050 if (f.search_find_defer)
5052 expand_string_message =
5053 string_sprintf("lookup of \"%s\" gave DEFER: %s",
5054 string_printing2(key, SP_TAB), search_error_message);
5057 if (expand_setup > 0) expand_nmax = expand_setup;
5060 /* The handling of "yes" and "no" result strings is now in a separate
5061 function that is also used by ${if} and ${extract}. */
5063 switch(process_yesno(
5064 skipping, /* were previously skipping */
5065 lookup_value != NULL, /* success/failure indicator */
5066 save_lookup_value, /* value to reset for string2 */
5067 &s, /* input pointer */
5068 &yield, /* output pointer */
5069 US"lookup", /* condition type */
5072 case 1: goto EXPAND_FAILED; /* when all is well, the */
5073 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5076 /* Restore external setting of expansion variables for carrying on
5077 at this level, and continue. */
5079 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5080 save_expand_nlength);
5082 if (skipping) continue;
5086 /* If Perl support is configured, handle calling embedded perl subroutines,
5087 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5088 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5089 arguments (defined below). */
5091 #define EXIM_PERL_MAX_ARGS 8
5095 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
5096 "is not included in this binary";
5099 #else /* EXIM_PERL */
5101 uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5102 gstring * new_yield;
5104 if (expand_forbid & RDO_PERL)
5106 expand_string_message = US"Perl calls are not permitted";
5110 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
5113 case 1: goto EXPAND_FAILED_CURLY;
5115 case 3: goto EXPAND_FAILED;
5118 /* If skipping, we don't actually do anything */
5120 if (skipping) continue;
5122 /* Start the interpreter if necessary */
5124 if (!opt_perl_started)
5127 if (!opt_perl_startup)
5129 expand_string_message = US"A setting of perl_startup is needed when "
5130 "using the Perl interpreter";
5133 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5134 if ((initerror = init_perl(opt_perl_startup)))
5136 expand_string_message =
5137 string_sprintf("error in perl_startup code: %s\n", initerror);
5140 opt_perl_started = TRUE;
5143 /* Call the function */
5145 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5146 new_yield = call_perl_cat(yield, &expand_string_message,
5147 sub_arg[0], sub_arg + 1);
5149 /* NULL yield indicates failure; if the message pointer has been set to
5150 NULL, the yield was undef, indicating a forced failure. Otherwise the
5151 message will indicate some kind of Perl error. */
5155 if (!expand_string_message)
5157 expand_string_message =
5158 string_sprintf("Perl subroutine \"%s\" returned undef to force "
5159 "failure", sub_arg[0]);
5160 f.expand_string_forcedfail = TRUE;
5165 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5166 set during a callback from Perl. */
5168 f.expand_string_forcedfail = FALSE;
5172 #endif /* EXIM_PERL */
5174 /* Transform email address to "prvs" scheme to use
5175 as BATV-signed return path */
5179 uschar * sub_arg[3], * p, * domain;
5181 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, name, &resetok))
5183 case 1: goto EXPAND_FAILED_CURLY;
5185 case 3: goto EXPAND_FAILED;
5188 /* If skipping, we don't actually do anything */
5189 if (skipping) continue;
5191 /* sub_arg[0] is the address */
5192 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
5193 || domain == sub_arg[0] || Ustrlen(domain) == 1)
5195 expand_string_message = US"prvs first argument must be a qualified email address";
5199 /* Calculate the hash. The third argument must be a single-digit
5200 key number, or unset. */
5203 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5205 expand_string_message = US"prvs third argument must be a single digit";
5209 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5212 expand_string_message = US"prvs hmac-sha1 conversion failed";
5216 /* Now separate the domain from the local part */
5219 yield = string_catn(yield, US"prvs=", 5);
5220 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5221 yield = string_catn(yield, prvs_daystamp(7), 3);
5222 yield = string_catn(yield, p, 6);
5223 yield = string_catn(yield, US"=", 1);
5224 yield = string_cat (yield, sub_arg[0]);
5225 yield = string_catn(yield, US"@", 1);
5226 yield = string_cat (yield, domain);
5231 /* Check a prvs-encoded address for validity */
5233 case EITEM_PRVSCHECK:
5235 uschar * sub_arg[3], * p;
5237 const pcre2_code * re;
5239 /* TF: Ugliness: We want to expand parameter 1 first, then set
5240 up expansion variables that are used in the expansion of
5241 parameter 2. So we clone the string for the first
5242 expansion, where we only expand parameter 1.
5244 PH: Actually, that isn't necessary. The read_subs() function is
5245 designed to work this way for the ${if and ${lookup expansions. I've
5249 /* Reset expansion variables */
5250 prvscheck_result = NULL;
5251 prvscheck_address = NULL;
5252 prvscheck_keynum = NULL;
5254 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, name, &resetok))
5256 case 1: goto EXPAND_FAILED_CURLY;
5258 case 3: goto EXPAND_FAILED;
5261 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5264 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5266 uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5267 uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5268 uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5269 uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5270 uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5272 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
5273 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
5274 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5275 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
5276 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
5278 /* Set up expansion variables */
5279 g = string_cat (NULL, local_part);
5280 g = string_catn(g, US"@", 1);
5281 g = string_cat (g, domain);
5282 prvscheck_address = string_from_gstring(g);
5283 prvscheck_keynum = string_copy(key_num);
5285 /* Now expand the second argument */
5286 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, name, &resetok))
5288 case 1: goto EXPAND_FAILED_CURLY;
5290 case 3: goto EXPAND_FAILED;
5293 /* Now we have the key and can check the address. */
5295 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5300 expand_string_message = US"hmac-sha1 conversion failed";
5304 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5305 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
5307 if (Ustrcmp(p,hash) == 0)
5309 /* Success, valid BATV address. Now check the expiry date. */
5310 uschar *now = prvs_daystamp(0);
5311 unsigned int inow = 0,iexpire = 1;
5313 (void)sscanf(CS now,"%u",&inow);
5314 (void)sscanf(CS daystamp,"%u",&iexpire);
5316 /* When "iexpire" is < 7, a "flip" has occurred.
5317 Adjust "inow" accordingly. */
5318 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5320 if (iexpire >= inow)
5322 prvscheck_result = US"1";
5323 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
5327 prvscheck_result = NULL;
5328 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
5333 prvscheck_result = NULL;
5334 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
5337 /* Now expand the final argument. We leave this till now so that
5338 it can include $prvscheck_result. */
5340 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, name, &resetok))
5342 case 1: goto EXPAND_FAILED_CURLY;
5344 case 3: goto EXPAND_FAILED;
5347 yield = string_cat(yield,
5348 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5350 /* Reset the "internal" variables afterwards, because they are in
5351 dynamic store that will be reclaimed if the expansion succeeded. */
5353 prvscheck_address = NULL;
5354 prvscheck_keynum = NULL;
5357 /* Does not look like a prvs encoded address, return the empty string.
5358 We need to make sure all subs are expanded first, so as to skip over
5361 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, name, &resetok))
5363 case 1: goto EXPAND_FAILED_CURLY;
5365 case 3: goto EXPAND_FAILED;
5368 if (skipping) continue;
5372 /* Handle "readfile" to insert an entire file */
5374 case EITEM_READFILE:
5377 uschar * sub_arg[2];
5379 if ((expand_forbid & RDO_READFILE) != 0)
5381 expand_string_message = US"file insertions are not permitted";
5385 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, name, &resetok))
5387 case 1: goto EXPAND_FAILED_CURLY;
5389 case 3: goto EXPAND_FAILED;
5392 /* If skipping, we don't actually do anything */
5394 if (skipping) continue;
5396 /* Open the file and read it */
5398 if (!(f = Ufopen(sub_arg[0], "rb")))
5400 expand_string_message = string_open_failed("%s", sub_arg[0]);
5404 yield = cat_file(f, yield, sub_arg[1]);
5409 /* Handle "readsocket" to insert data from a socket, either
5410 Inet or Unix domain */
5412 case EITEM_READSOCK:
5415 uschar * sub_arg[4];
5417 if (expand_forbid & RDO_READSOCK)
5419 expand_string_message = US"socket insertions are not permitted";
5423 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5424 because there may be a string for expansion on failure. */
5426 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, name, &resetok))
5428 case 1: goto EXPAND_FAILED_CURLY;
5429 case 2: /* Won't occur: no end check */
5430 case 3: goto EXPAND_FAILED;
5433 /* If skipping, we don't actually do anything. Otherwise, arrange to
5434 connect to either an IP or a Unix socket. */
5438 int stype = search_findtype(US"readsock", 8);
5441 int expand_setup = -1;
5444 /* If the reqstr is empty, flag that and set a dummy */
5448 g = string_append_listele(g, ',', US"send=no");
5449 sub_arg[1] = US"DUMMY";
5452 /* Re-marshall the options */
5456 const uschar * list = sub_arg[2];
5460 /* First option has no tag and is timeout */
5461 if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5462 g = string_append_listele(g, ',',
5463 string_sprintf("timeout=%s", item));
5465 /* The rest of the options from the expansion */
5466 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5467 g = string_append_listele(g, ',', item);
5469 /* possibly plus an EOL string. Process with escapes, to protect
5470 from list-processing. The only current user of eol= in search
5471 options is the readsock expansion. */
5473 if (sub_arg[3] && *sub_arg[3])
5474 g = string_append_listele(g, ',',
5475 string_sprintf("eol=%s",
5476 string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5479 /* Gat a (possibly cached) handle for the connection */
5481 if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5483 if (*expand_string_message) goto EXPAND_FAILED;
5484 expand_string_message = search_error_message;
5485 search_error_message = NULL;
5489 /* Get (possibly cached) results for the lookup */
5490 /* sspec: sub_arg[0] req: sub_arg[1] opts: g */
5492 if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5493 &expand_setup, string_from_gstring(g))))
5494 yield = string_cat(yield, s);
5495 else if (f.search_find_defer)
5497 expand_string_message = search_error_message;
5498 search_error_message = NULL;
5502 { /* should not happen, at present */
5503 expand_string_message = search_error_message;
5504 search_error_message = NULL;
5509 /* The whole thing has worked (or we were skipping). If there is a
5510 failure string following, we need to skip it. */
5512 if (*s == '{') /*}*/
5514 if (!expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok))
5515 goto EXPAND_FAILED; /*{*/
5518 expand_string_message = US"missing '}' closing failstring for readsocket";
5519 goto EXPAND_FAILED_CURLY;
5521 Uskip_whitespace(&s);
5524 READSOCK_DONE: /*{*/
5527 expand_string_message = US"missing '}' closing readsocket";
5528 goto EXPAND_FAILED_CURLY;
5530 if (skipping) continue;
5533 /* Come here on failure to create socket, connect socket, write to the
5534 socket, or timeout on reading. If another substring follows, expand and
5535 use it. Otherwise, those conditions give expand errors. */
5538 if (*s != '{') goto EXPAND_FAILED; /*}*/
5539 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5540 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5542 yield = string_cat(yield, arg); /*{*/
5545 expand_string_message = US"missing '}' closing failstring for readsocket";
5546 goto EXPAND_FAILED_CURLY;
5548 Uskip_whitespace(&s);
5552 /* Handle "run" to execute a program. */
5558 const uschar ** argv;
5562 if ((expand_forbid & RDO_RUN) != 0)
5564 expand_string_message = US"running a command is not permitted";
5568 Uskip_whitespace(&s);
5571 expand_string_message = US"missing '{' for command arg of run";
5572 goto EXPAND_FAILED_CURLY;
5574 if (!(arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
5576 Uskip_whitespace(&s);
5579 expand_string_message = US"missing '}' closing command arg of run";
5580 goto EXPAND_FAILED_CURLY;
5583 if (skipping) /* Just pretend it worked when we're skipping */
5586 lookup_value = NULL;
5590 if (!transport_set_up_command(&argv, /* anchor for arg list */
5591 arg, /* raw command */
5592 FALSE, /* don't expand the arguments */
5593 0, /* not relevant when... */
5594 NULL, /* no transporting address */
5595 US"${run} expansion", /* for error messages */
5596 &expand_string_message)) /* where to put error message */
5599 /* Create the child process, making it a group leader. */
5601 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5602 US"expand-run")) < 0)
5604 expand_string_message =
5605 string_sprintf("couldn't create child process: %s", strerror(errno));
5609 /* Nothing is written to the standard input. */
5613 /* Read the pipe to get the command's output into $value (which is kept
5614 in lookup_value). Read during execution, so that if the output exceeds
5615 the OS pipe buffer limit, we don't block forever. Remember to not release
5616 memory just allocated for $value. */
5619 f = fdopen(fd_out, "rb");
5620 sigalrm_seen = FALSE;
5622 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5626 /* Wait for the process to finish, applying the timeout, and inspect its
5627 return code for serious disasters. Simple non-zero returns are passed on.
5630 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5632 if (sigalrm_seen || runrc == -256)
5634 expand_string_message = US"command timed out";
5635 killpg(pid, SIGKILL); /* Kill the whole process group */
5638 else if (runrc == -257)
5639 expand_string_message = string_sprintf("wait() failed: %s",
5643 expand_string_message = string_sprintf("command killed by signal %d",
5650 /* Process the yes/no strings; $value may be useful in both cases */
5652 switch(process_yesno(
5653 skipping, /* were previously skipping */
5654 runrc == 0, /* success/failure indicator */
5655 lookup_value, /* value to reset for string2 */
5656 &s, /* input pointer */
5657 &yield, /* output pointer */
5658 US"run", /* condition type */
5661 case 1: goto EXPAND_FAILED; /* when all is well, the */
5662 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5665 if (skipping) continue;
5669 /* Handle character translation for "tr" */
5673 int oldptr = gstring_length(yield);
5677 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5679 case 1: goto EXPAND_FAILED_CURLY;
5681 case 3: goto EXPAND_FAILED;
5684 yield = string_cat(yield, sub[0]);
5685 o2m = Ustrlen(sub[2]) - 1;
5687 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5689 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5693 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5697 if (skipping) continue;
5701 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5702 expanded arguments. */
5711 int val[2] = { 0, -1 };
5714 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5715 Ensure that sub[2] is set in the ${length } case. */
5718 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5719 TRUE, name, &resetok))
5721 case 1: goto EXPAND_FAILED_CURLY;
5723 case 3: goto EXPAND_FAILED;
5726 /* Juggle the arguments if there are only two of them: always move the
5727 string to the last position and make ${length{n}{str}} equivalent to
5728 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5734 if (item_type == EITEM_LENGTH)
5741 for (int i = 0; i < 2; i++) if (sub[i])
5743 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5744 if (*ret != 0 || (i != 0 && val[i] < 0))
5746 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5747 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5753 item_type == EITEM_HASH
5754 ? compute_hash(sub[2], val[0], val[1], &len)
5755 : item_type == EITEM_NHASH
5756 ? compute_nhash(sub[2], val[0], val[1], &len)
5757 : extract_substr(sub[2], val[0], val[1], &len);
5760 yield = string_catn(yield, ret, len);
5761 if (skipping) continue;
5765 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5766 This code originally contributed by Steve Haslam. It currently supports
5767 the use of MD5 and SHA-1 hashes.
5769 We need some workspace that is large enough to handle all the supported
5770 hash types. Use macros to set the sizes rather than be too elaborate. */
5772 #define MAX_HASHLEN 20
5773 #define MAX_HASHBLOCKLEN 64
5782 int hashlen; /* Number of octets for the hash algorithm's output */
5783 int hashblocklen; /* Number of octets the hash algorithm processes */
5784 uschar * keyptr, * p;
5785 unsigned int keylen;
5787 uschar keyhash[MAX_HASHLEN];
5788 uschar innerhash[MAX_HASHLEN];
5789 uschar finalhash[MAX_HASHLEN];
5790 uschar finalhash_hex[2*MAX_HASHLEN];
5791 uschar innerkey[MAX_HASHBLOCKLEN];
5792 uschar outerkey[MAX_HASHBLOCKLEN];
5794 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5796 case 1: goto EXPAND_FAILED_CURLY;
5798 case 3: goto EXPAND_FAILED;
5801 if (skipping) continue;
5803 if (Ustrcmp(sub[0], "md5") == 0)
5806 use_base = &md5_base;
5810 else if (Ustrcmp(sub[0], "sha1") == 0)
5813 use_base = &sha1_ctx;
5819 expand_string_message =
5820 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5825 keylen = Ustrlen(keyptr);
5827 /* If the key is longer than the hash block length, then hash the key
5830 if (keylen > hashblocklen)
5832 chash_start(type, use_base);
5833 chash_end(type, use_base, keyptr, keylen, keyhash);
5838 /* Now make the inner and outer key values */
5840 memset(innerkey, 0x36, hashblocklen);
5841 memset(outerkey, 0x5c, hashblocklen);
5843 for (int i = 0; i < keylen; i++)
5845 innerkey[i] ^= keyptr[i];
5846 outerkey[i] ^= keyptr[i];
5849 /* Now do the hashes */
5851 chash_start(type, use_base);
5852 chash_mid(type, use_base, innerkey);
5853 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5855 chash_start(type, use_base);
5856 chash_mid(type, use_base, outerkey);
5857 chash_end(type, use_base, innerhash, hashlen, finalhash);
5859 /* Encode the final hash as a hex string */
5862 for (int i = 0; i < hashlen; i++)
5864 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5865 *p++ = hex_digits[finalhash[i] & 0x0f];
5868 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5869 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5871 yield = string_catn(yield, finalhash_hex, hashlen*2);
5875 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5876 We have to save the numerical variables and restore them afterwards. */
5880 const pcre2_code * re;
5881 int moffset, moffsetextra, slen;
5883 pcre2_match_data * md;
5885 uschar * subject, * sub[3];
5886 int save_expand_nmax =
5887 save_expand_strings(save_expand_nstring, save_expand_nlength);
5889 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5891 case 1: goto EXPAND_FAILED_CURLY;
5893 case 3: goto EXPAND_FAILED;
5896 /*XXX no handling of skipping? */
5897 /* Compile the regular expression */
5899 if (!(re = pcre2_compile((PCRE2_SPTR)sub[1], PCRE2_ZERO_TERMINATED,
5900 PCRE_COPT, &err, &roffset, pcre_cmp_ctx)))
5903 pcre2_get_error_message(err, errbuf, sizeof(errbuf));
5904 expand_string_message = string_sprintf("regular expression error in "
5905 "\"%s\": %s at offset %ld", sub[1], errbuf, (long)roffset);
5908 md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
5910 /* Now run a loop to do the substitutions as often as necessary. It ends
5911 when there are no more matches. Take care over matches of the null string;
5912 do the same thing as Perl does. */
5915 slen = Ustrlen(sub[0]);
5916 moffset = moffsetextra = 0;
5921 PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
5922 int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
5923 PCRE_EOPT | emptyopt, md, pcre_mtc_ctx);
5926 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5927 is not necessarily the end. We want to repeat the match from one
5928 character further along, but leaving the basic offset the same (for
5929 copying below). We can't be at the end of the string - that was checked
5930 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5931 finished; copy the remaining string and end the loop. */
5941 yield = string_catn(yield, subject+moffset, slen-moffset);
5945 /* Match - set up for expanding the replacement. */
5946 DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
5948 if (n == 0) n = EXPAND_MAXN + 1;
5950 for (int nn = 0; nn < n*2; nn += 2)
5952 expand_nstring[expand_nmax] = subject + ovec[nn];
5953 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
5957 /* Copy the characters before the match, plus the expanded insertion. */
5959 if (ovec[0] > moffset)
5960 yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
5962 if (!(insert = expand_string(sub[2])))
5964 yield = string_cat(yield, insert);
5970 /* If we have matched an empty string, first check to see if we are at
5971 the end of the subject. If so, the loop is over. Otherwise, mimic
5972 what Perl's /g options does. This turns out to be rather cunning. First
5973 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5974 string at the same point. If this fails (picked up above) we advance to
5975 the next character. */
5977 if (ovec[0] == ovec[1])
5979 if (ovec[0] == slen) break;
5980 emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
5984 /* All done - restore numerical variables. */
5986 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5987 save_expand_nlength);
5988 if (skipping) continue;
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 if ( yield && yield->ptr != save_ptr
6576 && (temp[0] == *outsep || temp[0] == 0))
6577 yield = string_catn(yield, US" ", 1);
6579 /* Add the string in "temp" to the output list that we are building,
6580 This is done in chunks by searching for the separator character. */
6584 size_t seglen = Ustrcspn(temp, outsep);
6586 yield = string_catn(yield, temp, seglen + 1);
6588 /* If we got to the end of the string we output one character
6589 too many; backup and end the loop. Otherwise arrange to double the
6592 if (!temp[seglen]) { yield->ptr--; break; }
6593 yield = string_catn(yield, outsep, 1);
6597 /* Output a separator after the string: we will remove the redundant
6598 final one at the end. */
6600 yield = string_catn(yield, outsep, 1);
6601 } /* End of iteration over the list loop */
6603 /* REDUCE has generated no output above: output the final value of
6606 if (item_type == EITEM_REDUCE)
6608 yield = string_cat(yield, lookup_value);
6609 lookup_value = save_lookup_value; /* Restore $value */
6612 /* FILTER and MAP generate lists: if they have generated anything, remove
6613 the redundant final separator. Even though an empty item at the end of a
6614 list does not count, this is tidier. */
6616 else if (yield && yield->ptr != save_ptr) yield->ptr--;
6618 /* Restore preserved $item */
6620 iterate_item = save_iterate_item;
6621 if (skipping) continue;
6627 int sep = 0, cond_type;
6628 const uschar * srclist, * cmp, * xtract;
6629 uschar * opname, * srcitem;
6630 const uschar * dstlist = NULL, * dstkeylist = NULL;
6631 uschar * tmp, * save_iterate_item = iterate_item;
6633 Uskip_whitespace(&s);
6634 if (*s++ != '{') /*}*/
6636 expand_string_message = US"missing '{' for list arg of sort";
6637 goto EXPAND_FAILED_CURLY; /*}*/
6640 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6641 if (!srclist) goto EXPAND_FAILED; /*{{*/
6644 expand_string_message = US"missing '}' closing list arg of sort";
6645 goto EXPAND_FAILED_CURLY;
6648 Uskip_whitespace(&s);
6649 if (*s++ != '{') /*}*/
6651 expand_string_message = US"missing '{' for comparator arg of sort";
6652 goto EXPAND_FAILED_CURLY; /*}*/
6655 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6656 if (!cmp) goto EXPAND_FAILED; /*{{*/
6659 expand_string_message = US"missing '}' closing comparator arg of sort";
6660 goto EXPAND_FAILED_CURLY;
6663 if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6665 if (!expand_string_message)
6666 expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6671 case ECOND_NUM_L: case ECOND_NUM_LE:
6672 case ECOND_NUM_G: case ECOND_NUM_GE:
6673 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6674 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6678 expand_string_message = US"comparator not handled for sort";
6682 Uskip_whitespace(&s);
6683 if (*s++ != '{') /*}*/
6685 expand_string_message = US"missing '{' for extractor arg of sort";
6686 goto EXPAND_FAILED_CURLY; /*}*/
6690 if (!(tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok)))
6692 xtract = string_copyn(xtract, s - xtract);
6696 expand_string_message = US"missing '}' closing extractor arg of sort";
6697 goto EXPAND_FAILED_CURLY;
6702 expand_string_message = US"missing } at end of \"sort\"";
6706 if (skipping) continue;
6708 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6710 uschar * srcfield, * dstitem;
6711 gstring * newlist = NULL, * newkeylist = NULL;
6713 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6715 /* extract field for comparisons */
6716 iterate_item = srcitem;
6717 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6721 expand_string_message = string_sprintf(
6722 "field-extract in sort: \"%s\"", xtract);
6726 /* Insertion sort */
6728 /* copy output list until new-item < list-item */
6729 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6733 /* field for comparison */
6734 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6737 /* String-comparator names start with a letter; numeric names do not */
6739 if (sortsbefore(cond_type, isalpha(opname[0]),
6740 srcfield, dstfield))
6742 /* New-item sorts before this dst-item. Append new-item,
6743 then dst-item, then remainder of dst list. */
6745 newlist = string_append_listele(newlist, sep, srcitem);
6746 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6749 newlist = string_append_listele(newlist, sep, dstitem);
6750 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6752 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */
6753 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6755 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6757 newlist = string_append_listele(newlist, sep, dstitem);
6758 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6764 newlist = string_append_listele(newlist, sep, dstitem);
6765 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6768 /* If we ran out of dstlist without consuming srcitem, append it */
6771 newlist = string_append_listele(newlist, sep, srcitem);
6772 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6775 dstlist = newlist->s;
6776 dstkeylist = newkeylist->s;
6778 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6779 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6783 yield = string_cat(yield, dstlist);
6785 /* Restore preserved $item */
6786 iterate_item = save_iterate_item;
6790 expand_string_message = US"Internal error in sort (list mismatch)";
6795 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6796 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6797 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6798 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6800 #define EXPAND_DLFUNC_MAX_ARGS 8
6803 #ifndef EXPAND_DLFUNC
6804 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6805 "is not included in this binary";
6808 #else /* EXPAND_DLFUNC */
6811 exim_dlfunc_t * func;
6814 uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6816 if (expand_forbid & RDO_DLFUNC)
6818 expand_string_message =
6819 US"dynamically-loaded functions are not permitted";
6823 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6824 TRUE, name, &resetok))
6826 case 1: goto EXPAND_FAILED_CURLY;
6828 case 3: goto EXPAND_FAILED;
6831 /* If skipping, we don't actually do anything */
6833 if (skipping) continue;
6835 /* Look up the dynamically loaded object handle in the tree. If it isn't
6836 found, dlopen() the file and put the handle in the tree for next time. */
6838 if (!(t = tree_search(dlobj_anchor, argv[0])))
6840 void * handle = dlopen(CS argv[0], RTLD_LAZY);
6843 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6844 argv[0], dlerror());
6845 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6848 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), is_tainted(argv[0]));
6849 Ustrcpy(t->name, argv[0]);
6850 t->data.ptr = handle;
6851 (void)tree_insertnode(&dlobj_anchor, t);
6854 /* Having obtained the dynamically loaded object handle, look up the
6855 function pointer. */
6857 if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6859 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6860 "%s", argv[1], argv[0], dlerror());
6861 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6865 /* Call the function and work out what to do with the result. If it
6866 returns OK, we have a replacement string; if it returns DEFER then
6867 expansion has failed in a non-forced manner; if it returns FAIL then
6868 failure was forced; if it returns ERROR or any other value there's a
6869 problem, so panic slightly. In any case, assume that the function has
6870 side-effects on the store that must be preserved. */
6874 for (argc = 0; argv[argc]; argc++) ;
6876 if ((status = func(&result, argc - 2, &argv[2])) != OK)
6878 expand_string_message = result ? result : US"(no message)";
6879 if (status == FAIL_FORCED)
6880 f.expand_string_forcedfail = TRUE;
6881 else if (status != FAIL)
6882 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6883 argv[0], argv[1], status, expand_string_message);
6887 if (result) yield = string_cat(yield, result);
6890 #endif /* EXPAND_DLFUNC */
6892 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6895 uschar *save_lookup_value = lookup_value;
6897 if (Uskip_whitespace(&s) != '{') /*}*/
6900 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6901 if (!key) goto EXPAND_FAILED; /*{{*/
6904 expand_string_message = US"missing '}' for name arg of env";
6905 goto EXPAND_FAILED_CURLY;
6908 lookup_value = US getenv(CS key);
6910 switch(process_yesno(
6911 skipping, /* were previously skipping */
6912 lookup_value != NULL, /* success/failure indicator */
6913 save_lookup_value, /* value to reset for string2 */
6914 &s, /* input pointer */
6915 &yield, /* output pointer */
6916 US"env", /* condition type */
6919 case 1: goto EXPAND_FAILED; /* when all is well, the */
6920 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6922 if (skipping) continue;
6927 case EITEM_SRS_ENCODE:
6928 /* ${srs_encode {secret} {return_path} {orig_domain}} */
6933 BOOL quoted = FALSE;
6935 switch (read_subs(sub, 3, 3, CUSS &s, skipping, TRUE, name, &resetok))
6937 case 1: goto EXPAND_FAILED_CURLY;
6939 case 3: goto EXPAND_FAILED;
6942 g = string_catn(g, US"SRS0=", 5);
6944 /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
6945 hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
6946 g = string_catn(g, cksum, sizeof(cksum));
6947 g = string_catn(g, US"=", 1);
6949 /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
6955 gettimeofday(&now, NULL);
6956 for (unsigned long i = (now.tv_sec / 86400) & 0x3ff; i; i >>= 5)
6957 h = string_catn(h, &base32_chars[i & 0x1f], 1);
6958 if (h) while (h->ptr > 0)
6959 g = string_catn(g, &h->s[--h->ptr], 1);
6961 g = string_catn(g, US"=", 1);
6963 /* ${domain:$return_path}=${local_part:$return_path} */
6965 int start, end, domain;
6966 uschar * t = parse_extract_address(sub[1], &expand_string_message,
6967 &start, &end, &domain, FALSE);
6973 if (domain > 0) g = string_cat(g, t + domain);
6974 g = string_catn(g, US"=", 1);
6976 s = domain > 0 ? string_copyn(t, domain - 1) : t;
6977 if ((quoted = Ustrchr(s, '"') != NULL))
6980 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
6981 while (*s) /* de-quote */
6983 while (*s && *s != '"') h = string_catn(h, s++, 1);
6985 while (*s && *s != '"') h = string_catn(h, s++, 1);
6988 gstring_release_unused(h);
6989 s = string_from_gstring(h);
6991 g = string_cat(g, s);
6994 /* Assume that if the original local_part had quotes
6995 it was for good reason */
6997 if (quoted) yield = string_catn(yield, US"\"", 1);
6998 yield = string_catn(yield, g->s, g->ptr);
6999 if (quoted) yield = string_catn(yield, US"\"", 1);
7001 /* @$original_domain */
7002 yield = string_catn(yield, US"@", 1);
7003 yield = string_cat(yield, sub[2]);
7005 if (skipping) continue;
7008 #endif /*SUPPORT_SRS*/
7012 } /* EITEM_* switch */
7016 if (start > 0 || *s) /* only if not the sole expansion of the line */
7017 debug_expansion_interim(US"item-res",
7018 yield->s + start, yield->ptr - start, skipping);
7024 /* Control reaches here if the name is not recognized as one of the more
7025 complicated expansion items. Check for the "operator" syntax (name terminated
7026 by a colon). Some of the operators have arguments, separated by _ from the
7032 uschar * arg = NULL, * sub;
7034 var_entry * vp = NULL;
7037 /* Owing to an historical mis-design, an underscore may be part of the
7038 operator name, or it may introduce arguments. We therefore first scan the
7039 table of names that contain underscores. If there is no match, we cut off
7040 the arguments and then scan the main table. */
7042 if ((c = chop_match(name, op_table_underscore,
7043 nelem(op_table_underscore))) < 0)
7045 if ((arg = Ustrchr(name, '_')))
7047 if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
7048 c += nelem(op_table_underscore);
7049 if (arg) *arg++ = '_'; /* Put back for error messages */
7052 /* Deal specially with operators that might take a certificate variable
7053 as we do not want to do the usual expansion. For most, expand the string.*/
7063 const uschar * s1 = s;
7064 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
7066 if (!sub) goto EXPAND_FAILED; /*{*/
7069 expand_string_message =
7070 string_sprintf("missing '}' closing cert arg of %s", name);
7071 goto EXPAND_FAILED_CURLY;
7073 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
7083 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
7084 if (!sub) goto EXPAND_FAILED;
7089 /* If we are skipping, we don't need to perform the operation at all.
7090 This matters for operations like "mask", because the data may not be
7091 in the correct format when skipping. For example, the expression may test
7092 for the existence of $sender_host_address before trying to mask it. For
7093 other operations, doing them may not fail, but it is a waste of time. */
7095 if (skipping && c >= 0) continue;
7097 /* Otherwise, switch on the operator type. After handling go back
7098 to the main loop top. */
7101 int start = yield->ptr;
7107 unsigned long int n = Ustrtoul(sub, &t, 10);
7112 expand_string_message = string_sprintf("argument for base32 "
7113 "operator is \"%s\", which is not a decimal number", sub);
7117 g = string_catn(g, &base32_chars[n & 0x1f], 1);
7119 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7126 unsigned long int n = 0;
7129 uschar * t = Ustrchr(base32_chars, *tt++);
7132 expand_string_message = string_sprintf("argument for base32d "
7133 "operator is \"%s\", which is not a base 32 number", sub);
7136 n = n * 32 + (t - base32_chars);
7138 yield = string_fmt_append(yield, "%ld", n);
7145 unsigned long int n = Ustrtoul(sub, &t, 10);
7148 expand_string_message = string_sprintf("argument for base62 "
7149 "operator is \"%s\", which is not a decimal number", sub);
7152 yield = string_cat(yield, string_base62(n));
7156 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7161 unsigned long int n = 0;
7164 uschar *t = Ustrchr(base62_chars, *tt++);
7167 expand_string_message = string_sprintf("argument for base62d "
7168 "operator is \"%s\", which is not a base %d number", sub,
7172 n = n * BASE_62 + (t - base62_chars);
7174 yield = string_fmt_append(yield, "%ld", n);
7180 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
7183 expand_string_message =
7184 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7185 expand_string_message);
7188 yield = string_cat(yield, expanded);
7195 uschar *t = sub - 1;
7196 while (*(++t) != 0) { *t = tolower(*t); count++; }
7197 yield = string_catn(yield, sub, count);
7204 uschar *t = sub - 1;
7205 while (*(++t) != 0) { *t = toupper(*t); count++; }
7206 yield = string_catn(yield, sub, count);
7212 if (vp && *(void **)vp->value)
7214 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7215 yield = string_cat(yield, cp);
7223 md5_end(&base, sub, Ustrlen(sub), digest);
7224 for (int j = 0; j < 16; j++)
7225 yield = string_fmt_append(yield, "%02x", digest[j]);
7231 if (vp && *(void **)vp->value)
7233 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7234 yield = string_cat(yield, cp);
7242 sha1_end(&h, sub, Ustrlen(sub), digest);
7243 for (int j = 0; j < 20; j++)
7244 yield = string_fmt_append(yield, "%02X", digest[j]);
7250 #ifdef EXIM_HAVE_SHA2
7251 if (vp && *(void **)vp->value)
7252 if (c == EOP_SHA256)
7253 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7255 expand_string_message = US"sha2_N not supported with certificates";
7260 hashmethod m = !arg ? HASH_SHA2_256
7261 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7262 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7263 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7266 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7268 expand_string_message = US"unrecognised sha2 variant";
7272 exim_sha_update(&h, sub, Ustrlen(sub));
7273 exim_sha_finish(&h, &b);
7275 yield = string_fmt_append(yield, "%02X", *b.data++);
7278 expand_string_message = US"sha256 only supported with TLS";
7283 #ifdef EXIM_HAVE_SHA3
7287 hashmethod m = !arg ? HASH_SHA3_256
7288 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7289 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7290 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7291 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7294 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7296 expand_string_message = US"unrecognised sha3 variant";
7300 exim_sha_update(&h, sub, Ustrlen(sub));
7301 exim_sha_finish(&h, &b);
7303 yield = string_fmt_append(yield, "%02X", *b.data++);
7307 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7311 /* Convert hex encoding to base64 encoding */
7321 for (enc = sub; *enc; enc++)
7323 if (!isxdigit(*enc))
7325 expand_string_message = string_sprintf("\"%s\" is not a hex "
7334 expand_string_message = string_sprintf("\"%s\" contains an odd "
7335 "number of characters", sub);
7339 while ((c = *in++) != 0)
7341 if (isdigit(c)) c -= '0';
7342 else c = toupper(c) - 'A' + 10;
7352 enc = b64encode(CUS sub, out - sub);
7353 yield = string_cat(yield, enc);
7357 /* Convert octets outside 0x21..0x7E to \xXX form */
7361 uschar *t = sub - 1;
7364 if (*t < 0x21 || 0x7E < *t)
7365 yield = string_fmt_append(yield, "\\x%02x", *t);
7367 yield = string_catn(yield, t, 1);
7372 /* count the number of list elements */
7376 int cnt = 0, sep = 0;
7377 uschar * buf = store_get(2, is_tainted(sub));
7379 while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7380 yield = string_fmt_append(yield, "%d", cnt);
7384 /* expand a named list given the name */
7385 /* handles nested named lists; requotes as colon-sep list */
7388 expand_string_message = NULL;
7389 yield = expand_listnamed(yield, sub, arg);
7390 if (expand_string_message)
7394 /* quote a list-item for the given list-separator */
7396 /* mask applies a mask to an IP address; for example the result of
7397 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7404 int type, mask, maskoffset;
7408 if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7410 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7415 if (maskoffset == 0)
7417 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7422 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7424 if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7426 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7431 /* If an optional 'n' was given, ipv6 gets normalised output:
7432 colons rather than dots, and zero-compressed. */
7434 normalised = arg && *arg == 'n';
7436 /* Convert the address to binary integer(s) and apply the mask */
7438 sub[maskoffset] = 0;
7439 count = host_aton(sub, binary);
7440 host_mask(count, binary, mask);
7442 /* Convert to masked textual format and add to output. */
7444 if (type == 4 || !normalised)
7445 yield = string_catn(yield, buffer,
7446 host_nmtoa(count, binary, mask, buffer, '.'));
7449 ipv6_nmtoa(binary, buffer);
7450 yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7456 case EOP_IPV6DENORM:
7458 int type = string_is_ip_address(sub, NULL);
7465 (void) host_aton(sub, binary);
7468 case 4: /* convert to IPv4-mapped IPv6 */
7469 binary[0] = binary[1] = 0;
7470 binary[2] = 0x0000ffff;
7471 (void) host_aton(sub, binary+3);
7475 expand_string_message =
7476 string_sprintf("\"%s\" is not an IP address", sub);
7480 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7481 ? ipv6_nmtoa(binary, buffer)
7482 : host_nmtoa(4, binary, -1, buffer, ':')
7488 case EOP_LOCAL_PART:
7492 int start, end, domain;
7493 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7496 if (c != EOP_DOMAIN)
7497 yield = c == EOP_LOCAL_PART && domain > 0
7498 ? string_catn(yield, t, domain - 1)
7499 : string_cat(yield, t);
7500 else if (domain > 0)
7501 yield = string_cat(yield, t + domain);
7507 uschar outsep[2] = { ':', '\0' };
7508 uschar *address, *error;
7509 int save_ptr = gstring_length(yield);
7510 int start, end, domain; /* Not really used */
7512 if (Uskip_whitespace(&sub) == '>')
7513 if (*outsep = *++sub) ++sub;
7516 expand_string_message = string_sprintf("output separator "
7517 "missing in expanding ${addresses:%s}", --sub);
7520 f.parse_allow_group = TRUE;
7524 uschar * p = parse_find_address_end(sub, FALSE);
7525 uschar saveend = *p;
7527 address = parse_extract_address(sub, &error, &start, &end, &domain,
7531 /* Add the address to the output list that we are building. This is
7532 done in chunks by searching for the separator character. At the
7533 start, unless we are dealing with the first address of the output
7534 list, add in a space if the new address begins with the separator
7535 character, or is an empty string. */
7539 if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7540 yield = string_catn(yield, US" ", 1);
7544 size_t seglen = Ustrcspn(address, outsep);
7545 yield = string_catn(yield, address, seglen + 1);
7547 /* If we got to the end of the string we output one character
7550 if (address[seglen] == '\0') { yield->ptr--; break; }
7551 yield = string_catn(yield, outsep, 1);
7552 address += seglen + 1;
7555 /* Output a separator after the string: we will remove the
7556 redundant final one at the end. */
7558 yield = string_catn(yield, outsep, 1);
7561 if (saveend == '\0') break;
7565 /* If we have generated anything, remove the redundant final
7568 if (yield && yield->ptr != save_ptr) yield->ptr--;
7569 f.parse_allow_group = FALSE;
7574 /* quote puts a string in quotes if it is empty or contains anything
7575 other than alphamerics, underscore, dot, or hyphen.
7577 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7578 be quoted in order to be a valid local part.
7580 In both cases, newlines and carriage returns are converted into \n and \r
7584 case EOP_QUOTE_LOCAL_PART:
7587 BOOL needs_quote = (!*sub); /* TRUE for empty string */
7588 uschar *t = sub - 1;
7591 while (!needs_quote && *++t)
7592 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7594 else /* EOP_QUOTE_LOCAL_PART */
7595 while (!needs_quote && *++t)
7596 needs_quote = !isalnum(*t)
7597 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7598 && (*t != '.' || t == sub || !t[1]);
7602 yield = string_catn(yield, US"\"", 1);
7606 yield = string_catn(yield, US"\\n", 2);
7607 else if (*t == '\r')
7608 yield = string_catn(yield, US"\\r", 2);
7611 if (*t == '\\' || *t == '"')
7612 yield = string_catn(yield, US"\\", 1);
7613 yield = string_catn(yield, t, 1);
7615 yield = string_catn(yield, US"\"", 1);
7618 yield = string_cat(yield, sub);
7622 /* quote_lookuptype does lookup-specific quoting */
7627 uschar * opt = Ustrchr(arg, '_');
7629 if (opt) *opt++ = 0;
7631 if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7633 expand_string_message = search_error_message;
7637 if (lookup_list[n]->quote)
7638 sub = (lookup_list[n]->quote)(sub, opt);
7644 expand_string_message = string_sprintf(
7645 "\"%s\" unrecognized after \"${quote_%s\"", /*}*/
7650 yield = string_cat(yield, sub);
7654 /* rx quote sticks in \ before any non-alphameric character so that
7655 the insertion works in a regular expression. */
7659 uschar *t = sub - 1;
7663 yield = string_catn(yield, US"\\", 1);
7664 yield = string_catn(yield, t, 1);
7669 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7670 prescribed by the RFC, if there are characters that need to be encoded */
7673 yield = string_cat(yield,
7674 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7678 /* RFC 2047 decode */
7684 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7685 headers_charset, '?', &len, &error);
7688 expand_string_message = error;
7691 yield = string_catn(yield, decoded, len);
7695 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7700 uschar * buff = store_get(4, is_tainted(sub));
7705 if (c > 255) c = '_';
7707 yield = string_catn(yield, buff, 1);
7712 /* replace illegal UTF-8 sequences by replacement character */
7714 #define UTF8_REPLACEMENT_CHAR US"?"
7718 int seq_len = 0, index = 0;
7720 long codepoint = -1;
7722 uschar seq_buff[4]; /* accumulate utf-8 here */
7724 /* Manually track tainting, as we deal in individual chars below */
7726 if (is_tainted(sub))
7728 if (yield->s && yield->ptr)
7729 gstring_rebuffer(yield);
7731 yield->s = store_get(yield->size = Ustrlen(sub), is_tainted(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 */
8164 if (start > 0 || *s) /* only if not the sole expansion of the line */
8165 debug_expansion_interim(US"op-res",
8166 yield->s + start, yield->ptr - start, skipping);
8171 /* Not an item or an operator */
8172 /* Handle a plain name. If this is the first thing in the expansion, release
8173 the pre-allocated buffer. If the result data is known to be in a new buffer,
8174 newsize will be set to the size of that buffer, and we can just point at that
8175 store instead of copying. Many expansion strings contain just one reference,
8176 so this is a useful optimization, especially for humungous headers
8177 ($message_headers). */
8181 const uschar * value;
8187 g = store_get(sizeof(gstring), FALSE);
8188 else if (yield->ptr == 0)
8190 if (resetok) reset_point = store_reset(reset_point);
8192 reset_point = store_mark();
8193 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
8195 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
8197 expand_string_message =
8198 string_sprintf("unknown variable in \"${%s}\"", name);
8199 check_variable_error_message(name);
8202 len = Ustrlen(value);
8203 if (!yield && newsize)
8206 yield->size = newsize;
8208 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8211 yield = string_catn(yield, value, len);
8215 /* Else there's something wrong */
8217 expand_string_message =
8218 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8219 "in a variable reference)", name);
8223 /* If we hit the end of the string when ket_ends is set, there is a missing
8224 terminating brace. */
8226 if (ket_ends && !*s)
8228 expand_string_message = malformed_header
8229 ? US"missing } at end of string - could be header name not terminated by colon"
8230 : US"missing } at end of string";
8234 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8235 added to the string. If so, set up an empty string. Add a terminating zero. If
8236 left != NULL, return a pointer to the terminator. */
8239 yield = string_get(1);
8240 (void) string_from_gstring(yield);
8241 if (left) *left = s;
8243 /* Any stacking store that was used above the final string is no longer needed.
8244 In many cases the final string will be the first one that was got and so there
8245 will be optimal store usage. */
8247 if (resetok) gstring_release_unused(yield);
8248 else if (resetok_p) *resetok_p = FALSE;
8252 BOOL tainted = is_tainted(yield->s);
8255 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8256 debug_printf_indent("%sresult: %s\n",
8257 skipping ? "|-----" : "\\_____", yield->s);
8259 debug_printf_indent("%s \\__(tainted)\n",
8260 skipping ? "| " : " ");
8262 debug_printf_indent("\\___skipping: result is not used\n");
8266 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8267 "expanding: %.*s\n",
8268 (int)(s - string), string);
8269 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8271 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8274 debug_printf_indent("%s(tainted)\n",
8276 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8278 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8279 "skipping: result is not used\n");
8285 /* This is the failure exit: easiest to program with a goto. We still need
8286 to update the pointer to the terminator, for cases of nested calls with "fail".
8289 EXPAND_FAILED_CURLY:
8290 if (malformed_header)
8291 expand_string_message =
8292 US"missing or misplaced { or } - could be header name not terminated by colon";
8294 else if (!expand_string_message || !*expand_string_message)
8295 expand_string_message = US"missing or misplaced { or }";
8297 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8298 that is a bad idea, because expand_string_message is in dynamic store. */
8301 if (left) *left = s;
8306 debug_printf_indent("|failed to expand: %s\n", string);
8307 debug_printf_indent("%serror message: %s\n",
8308 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8309 if (f.expand_string_forcedfail)
8310 debug_printf_indent("\\failure was forced\n");
8314 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8316 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8317 "error message: %s\n",
8318 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8319 expand_string_message);
8320 if (f.expand_string_forcedfail)
8321 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8324 if (resetok_p && !resetok) *resetok_p = FALSE;
8330 /* This is the external function call. Do a quick check for any expansion
8331 metacharacters, and if there are none, just return the input string.
8333 Argument: the string to be expanded
8334 Returns: the expanded string, or NULL if expansion failed; if failure was
8335 due to a lookup deferring, search_find_defer will be TRUE
8339 expand_cstring(const uschar * string)
8341 if (Ustrpbrk(string, "$\\") != NULL)
8343 int old_pool = store_pool;
8346 f.search_find_defer = FALSE;
8347 malformed_header = FALSE;
8348 store_pool = POOL_MAIN;
8349 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
8350 store_pool = old_pool;
8358 expand_string(uschar * string)
8360 return US expand_cstring(CUS string);
8367 /*************************************************
8369 *************************************************/
8371 /* Now and again we want to expand a string and be sure that the result is in a
8372 new bit of store. This function does that.
8373 Since we know it has been copied, the de-const cast is safe.
8375 Argument: the string to be expanded
8376 Returns: the expanded string, always in a new bit of store, or NULL
8380 expand_string_copy(const uschar *string)
8382 const uschar *yield = expand_cstring(string);
8383 if (yield == string) yield = string_copy(string);
8389 /*************************************************
8390 * Expand and interpret as an integer *
8391 *************************************************/
8393 /* Expand a string, and convert the result into an integer.
8396 string the string to be expanded
8397 isplus TRUE if a non-negative number is expected
8399 Returns: the integer value, or
8400 -1 for an expansion error ) in both cases, message in
8401 -2 for an integer interpretation error ) expand_string_message
8402 expand_string_message is set NULL for an OK integer
8406 expand_string_integer(uschar *string, BOOL isplus)
8408 return expanded_string_integer(expand_string(string), isplus);
8412 /*************************************************
8413 * Interpret string as an integer *
8414 *************************************************/
8416 /* Convert a string (that has already been expanded) into an integer.
8418 This function is used inside the expansion code.
8421 s the string to be expanded
8422 isplus TRUE if a non-negative number is expected
8424 Returns: the integer value, or
8425 -1 if string is NULL (which implies an expansion error)
8426 -2 for an integer interpretation error
8427 expand_string_message is set NULL for an OK integer
8430 static int_eximarith_t
8431 expanded_string_integer(const uschar *s, BOOL isplus)
8433 int_eximarith_t value;
8434 uschar *msg = US"invalid integer \"%s\"";
8437 /* If expansion failed, expand_string_message will be set. */
8441 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8442 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8443 systems, so we set it zero ourselves. */
8446 expand_string_message = NULL; /* Indicates no error */
8448 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8449 equal to 0. Unfortunately, people actually relied upon that, so preserve
8450 the behaviour explicitly. Stripping leading whitespace is a harmless
8451 noop change since strtol skips it anyway (provided that there is a number
8454 if (Uskip_whitespace(&s) == '\0')
8457 debug_printf_indent("treating blank string as number 0\n");
8461 value = strtoll(CS s, CSS &endptr, 10);
8464 msg = US"integer expected but \"%s\" found";
8465 else if (value < 0 && isplus)
8466 msg = US"non-negative integer expected but \"%s\" found";
8469 switch (tolower(*endptr))
8474 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8479 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8480 else value *= 1024*1024;
8484 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8485 else value *= 1024*1024*1024;
8489 if (errno == ERANGE)
8490 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8492 if (Uskip_whitespace(&endptr) == 0) return value;
8495 expand_string_message = string_sprintf(CS msg, s);
8500 /* These values are usually fixed boolean values, but they are permitted to be
8504 addr address being routed
8505 mtype the module type
8506 mname the module name
8507 dbg_opt debug selectors
8508 oname the option name
8509 bvalue the router's boolean value
8510 svalue the router's string value
8511 rvalue where to put the returned value
8513 Returns: OK value placed in rvalue
8514 DEFER expansion failed
8518 exp_bool(address_item *addr,
8519 uschar *mtype, uschar *mname, unsigned dbg_opt,
8520 uschar *oname, BOOL bvalue,
8521 uschar *svalue, BOOL *rvalue)
8524 if (!svalue) { *rvalue = bvalue; return OK; }
8526 if (!(expanded = expand_string(svalue)))
8528 if (f.expand_string_forcedfail)
8530 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8534 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8535 oname, mname, mtype, expand_string_message);
8536 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8540 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8543 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8545 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8549 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8550 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8559 /* Avoid potentially exposing a password in a string about to be logged */
8562 expand_hide_passwords(uschar * s)
8564 return ( ( Ustrstr(s, "failed to expand") != NULL
8565 || Ustrstr(s, "expansion of ") != NULL
8567 && ( Ustrstr(s, "mysql") != NULL
8568 || Ustrstr(s, "pgsql") != NULL
8569 || Ustrstr(s, "redis") != NULL
8570 || Ustrstr(s, "sqlite") != NULL
8571 || Ustrstr(s, "ldap:") != NULL
8572 || Ustrstr(s, "ldaps:") != NULL
8573 || Ustrstr(s, "ldapi:") != NULL
8574 || Ustrstr(s, "ldapdn:") != NULL
8575 || Ustrstr(s, "ldapm:") != NULL
8577 ? US"Temporary internal error" : s;
8581 /* Read given named file into big_buffer. Use for keying material etc.
8582 The content will have an ascii NUL appended.
8587 Return: pointer to buffer, or NULL on error.
8591 expand_file_big_buffer(const uschar * filename)
8593 int fd, off = 0, len;
8595 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8597 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8604 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8607 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8615 big_buffer[off] = '\0';
8621 /*************************************************
8622 * Error-checking for testsuite *
8623 *************************************************/
8625 uschar * region_start;
8626 uschar * region_end;
8627 const uschar *var_name;
8628 const uschar *var_data;
8631 /* Called via tree_walk, which allows nonconst name/data. Our usage is const. */
8633 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8636 if (var_data >= e->region_start && var_data < e->region_end)
8638 e->var_name = CUS var_name;
8639 e->var_data = CUS var_data;
8644 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8646 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8647 .var_name = NULL, .var_data = NULL };
8649 /* check acl_ variables */
8650 tree_walk(acl_var_c, assert_variable_notin, &e);
8651 tree_walk(acl_var_m, assert_variable_notin, &e);
8653 /* check auth<n> variables.
8654 assert_variable_notin() treats as const, so deconst is safe. */
8655 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8656 assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8658 /* check regex<n> variables. assert_variable_notin() treats as const. */
8659 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8660 assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8662 /* check known-name variables */
8663 for (var_entry * v = var_table; v < var_table + var_table_size; v++)
8664 if (v->type == vtype_stringptr)
8665 assert_variable_notin(US v->name, *(USS v->value), &e);
8667 /* check dns and address trees */
8668 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8669 tree_walk(tree_duplicates, assert_variable_notin, &e);
8670 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8671 tree_walk(tree_unusable, assert_variable_notin, &e);
8674 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8675 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8676 e.var_name, filename, linenumber, e.var_data);
8681 /*************************************************
8682 **************************************************
8683 * Stand-alone test program *
8684 **************************************************
8685 *************************************************/
8691 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8693 int ovec[3*(EXPAND_MAXN+1)];
8694 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8696 BOOL yield = n >= 0;
8697 if (n == 0) n = EXPAND_MAXN + 1;
8700 expand_nmax = setup < 0 ? 0 : setup + 1;
8701 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8703 expand_nstring[expand_nmax] = subject + ovec[nn];
8704 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8712 int main(int argc, uschar **argv)
8714 uschar buffer[1024];
8716 debug_selector = D_v;
8717 debug_file = stderr;
8718 debug_fd = fileno(debug_file);
8719 big_buffer = malloc(big_buffer_size);
8722 for (int i = 1; i < argc; i++)
8724 if (argv[i][0] == '+')
8726 debug_trace_memory = 2;
8729 if (isdigit(argv[i][0]))
8730 debug_selector = Ustrtol(argv[i], NULL, 0);
8732 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8736 eldap_default_servers = argv[i];
8739 mysql_servers = argv[i];
8742 pgsql_servers = argv[i];
8745 redis_servers = argv[i];
8749 else opt_perl_startup = argv[i];
8753 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8755 expand_nstring[1] = US"string 1....";
8756 expand_nlength[1] = 8;
8760 if (opt_perl_startup != NULL)
8763 printf("Starting Perl interpreter\n");
8764 errstr = init_perl(opt_perl_startup);
8767 printf("** error in perl_startup code: %s\n", errstr);
8768 return EXIT_FAILURE;
8771 #endif /* EXIM_PERL */
8773 /* Thie deliberately regards the input as untainted, so that it can be
8774 expanded; only reasonable since this is a test for string-expansions. */
8776 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8778 rmark reset_point = store_mark();
8779 uschar *yield = expand_string(buffer);
8781 printf("%s\n", yield);
8784 if (f.search_find_defer) printf("search_find deferred\n");
8785 printf("Failed: %s\n", expand_string_message);
8786 if (f.expand_string_forcedfail) printf("Forced failure\n");
8789 store_reset(reset_point);
8801 /* End of expand.c */