1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 */
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[] = {
134 #ifdef EXPERIMENTAL_SRS_NATIVE
169 #ifdef EXPERIMENTAL_SRS_NATIVE
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[] = {
259 EOP_ADDRESS = nelem(op_table_underscore),
307 /* Table of condition names, and corresponding switch numbers. The names must
308 be in alphabetical order. */
310 static uschar *cond_table[] = {
314 US"==", /* Backward compatibility */
337 #ifdef EXPERIMENTAL_SRS_NATIVE
354 US"match_local_part",
379 ECOND_FIRST_DELIVERY,
390 #ifdef EXPERIMENTAL_SRS_NATIVE
407 ECOND_MATCH_LOCAL_PART,
417 /* Types of table entry */
420 vtype_int, /* value is address of int */
421 vtype_filter_int, /* ditto, but recognized only when filtering */
422 vtype_ino, /* value is address of ino_t (not always an int) */
423 vtype_uid, /* value is address of uid_t (not always an int) */
424 vtype_gid, /* value is address of gid_t (not always an int) */
425 vtype_bool, /* value is address of bool */
426 vtype_stringptr, /* value is address of pointer to string */
427 vtype_msgbody, /* as stringptr, but read when first required */
428 vtype_msgbody_end, /* ditto, the end of the message */
429 vtype_msgheaders, /* the message's headers, processed */
430 vtype_msgheaders_raw, /* the message's headers, unprocessed */
431 vtype_localpart, /* extract local part from string */
432 vtype_domain, /* extract domain from string */
433 vtype_string_func, /* value is string returned by given function */
434 vtype_todbsdin, /* value not used; generate BSD inbox tod */
435 vtype_tode, /* value not used; generate tod in epoch format */
436 vtype_todel, /* value not used; generate tod in epoch/usec format */
437 vtype_todf, /* value not used; generate full tod */
438 vtype_todl, /* value not used; generate log tod */
439 vtype_todlf, /* value not used; generate log file datestamp tod */
440 vtype_todzone, /* value not used; generate time zone only */
441 vtype_todzulu, /* value not used; generate zulu tod */
442 vtype_reply, /* value not used; get reply from headers */
443 vtype_pid, /* value not used; result is pid */
444 vtype_host_lookup, /* value not used; get host name */
445 vtype_load_avg, /* value not used; result is int from os_getloadavg */
446 vtype_pspace, /* partition space; value is T/F for spool/log */
447 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
448 vtype_cert /* SSL certificate */
450 ,vtype_dkim /* Lookup of value in DKIM signature */
454 /* Type for main variable table */
462 /* Type for entries pointing to address/length pairs. Not currently
470 static uschar * fn_recipients(void);
471 typedef uschar * stringptr_fn_t(void);
472 static uschar * fn_queue_size(void);
474 /* This table must be kept in alphabetical order. */
476 static var_entry var_table[] = {
477 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
478 they will be confused with user-creatable ACL variables. */
479 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
480 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
481 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
482 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
483 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
484 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
485 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
486 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
487 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
488 { "acl_narg", vtype_int, &acl_narg },
489 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
490 { "address_data", vtype_stringptr, &deliver_address_data },
491 { "address_file", vtype_stringptr, &address_file },
492 { "address_pipe", vtype_stringptr, &address_pipe },
493 #ifdef EXPERIMENTAL_ARC
494 { "arc_domains", vtype_string_func, (void *) &fn_arc_domains },
495 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
496 { "arc_state", vtype_stringptr, &arc_state },
497 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
499 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
500 { "authenticated_id", vtype_stringptr, &authenticated_id },
501 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
502 { "authentication_failed",vtype_int, &authentication_failed },
503 #ifdef WITH_CONTENT_SCAN
504 { "av_failed", vtype_int, &av_failed },
506 #ifdef EXPERIMENTAL_BRIGHTMAIL
507 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
508 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
509 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
510 { "bmi_deliver", vtype_int, &bmi_deliver },
512 { "body_linecount", vtype_int, &body_linecount },
513 { "body_zerocount", vtype_int, &body_zerocount },
514 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
515 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
516 { "caller_gid", vtype_gid, &real_gid },
517 { "caller_uid", vtype_uid, &real_uid },
518 { "callout_address", vtype_stringptr, &callout_address },
519 { "compile_date", vtype_stringptr, &version_date },
520 { "compile_number", vtype_stringptr, &version_cnumber },
521 { "config_dir", vtype_stringptr, &config_main_directory },
522 { "config_file", vtype_stringptr, &config_main_filename },
523 { "csa_status", vtype_stringptr, &csa_status },
524 #ifdef EXPERIMENTAL_DCC
525 { "dcc_header", vtype_stringptr, &dcc_header },
526 { "dcc_result", vtype_stringptr, &dcc_result },
529 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
530 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
531 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
532 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
533 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
534 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
535 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
536 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
537 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
538 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
539 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
540 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
541 { "dkim_key_length", vtype_int, &dkim_key_length },
542 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
543 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
544 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
545 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
546 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
547 { "dkim_signers", vtype_stringptr, &dkim_signers },
548 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
549 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
552 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
553 { "dmarc_status", vtype_stringptr, &dmarc_status },
554 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
555 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
557 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
558 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
559 { "dnslist_text", vtype_stringptr, &dnslist_text },
560 { "dnslist_value", vtype_stringptr, &dnslist_value },
561 { "domain", vtype_stringptr, &deliver_domain },
562 { "domain_data", vtype_stringptr, &deliver_domain_data },
563 #ifndef DISABLE_EVENT
564 { "event_data", vtype_stringptr, &event_data },
566 /*XXX want to use generic vars for as many of these as possible*/
567 { "event_defer_errno", vtype_int, &event_defer_errno },
569 { "event_name", vtype_stringptr, &event_name },
571 { "exim_gid", vtype_gid, &exim_gid },
572 { "exim_path", vtype_stringptr, &exim_path },
573 { "exim_uid", vtype_uid, &exim_uid },
574 { "exim_version", vtype_stringptr, &version_string },
575 { "headers_added", vtype_string_func, (void *) &fn_hdrs_added },
576 { "home", vtype_stringptr, &deliver_home },
577 { "host", vtype_stringptr, &deliver_host },
578 { "host_address", vtype_stringptr, &deliver_host_address },
579 { "host_data", vtype_stringptr, &host_data },
580 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
581 { "host_lookup_failed", vtype_int, &host_lookup_failed },
582 { "host_port", vtype_int, &deliver_host_port },
583 { "initial_cwd", vtype_stringptr, &initial_cwd },
584 { "inode", vtype_ino, &deliver_inode },
585 { "interface_address", vtype_stringptr, &interface_address },
586 { "interface_port", vtype_int, &interface_port },
587 { "item", vtype_stringptr, &iterate_item },
589 { "ldap_dn", vtype_stringptr, &eldap_dn },
591 { "load_average", vtype_load_avg, NULL },
592 { "local_part", vtype_stringptr, &deliver_localpart },
593 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
594 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
595 { "local_part_prefix_v", vtype_stringptr, &deliver_localpart_prefix_v },
596 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
597 { "local_part_suffix_v", vtype_stringptr, &deliver_localpart_suffix_v },
598 #ifdef HAVE_LOCAL_SCAN
599 { "local_scan_data", vtype_stringptr, &local_scan_data },
601 { "local_user_gid", vtype_gid, &local_user_gid },
602 { "local_user_uid", vtype_uid, &local_user_uid },
603 { "localhost_number", vtype_int, &host_number },
604 { "log_inodes", vtype_pinodes, (void *)FALSE },
605 { "log_space", vtype_pspace, (void *)FALSE },
606 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
607 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
608 #ifdef WITH_CONTENT_SCAN
609 { "malware_name", vtype_stringptr, &malware_name },
611 { "max_received_linelength", vtype_int, &max_received_linelength },
612 { "message_age", vtype_int, &message_age },
613 { "message_body", vtype_msgbody, &message_body },
614 { "message_body_end", vtype_msgbody_end, &message_body_end },
615 { "message_body_size", vtype_int, &message_body_size },
616 { "message_exim_id", vtype_stringptr, &message_id },
617 { "message_headers", vtype_msgheaders, NULL },
618 { "message_headers_raw", vtype_msgheaders_raw, NULL },
619 { "message_id", vtype_stringptr, &message_id },
620 { "message_linecount", vtype_int, &message_linecount },
621 { "message_size", vtype_int, &message_size },
623 { "message_smtputf8", vtype_bool, &message_smtputf8 },
625 #ifdef WITH_CONTENT_SCAN
626 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
627 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
628 { "mime_boundary", vtype_stringptr, &mime_boundary },
629 { "mime_charset", vtype_stringptr, &mime_charset },
630 { "mime_content_description", vtype_stringptr, &mime_content_description },
631 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
632 { "mime_content_id", vtype_stringptr, &mime_content_id },
633 { "mime_content_size", vtype_int, &mime_content_size },
634 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
635 { "mime_content_type", vtype_stringptr, &mime_content_type },
636 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
637 { "mime_filename", vtype_stringptr, &mime_filename },
638 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
639 { "mime_is_multipart", vtype_int, &mime_is_multipart },
640 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
641 { "mime_part_count", vtype_int, &mime_part_count },
643 { "n0", vtype_filter_int, &filter_n[0] },
644 { "n1", vtype_filter_int, &filter_n[1] },
645 { "n2", vtype_filter_int, &filter_n[2] },
646 { "n3", vtype_filter_int, &filter_n[3] },
647 { "n4", vtype_filter_int, &filter_n[4] },
648 { "n5", vtype_filter_int, &filter_n[5] },
649 { "n6", vtype_filter_int, &filter_n[6] },
650 { "n7", vtype_filter_int, &filter_n[7] },
651 { "n8", vtype_filter_int, &filter_n[8] },
652 { "n9", vtype_filter_int, &filter_n[9] },
653 { "original_domain", vtype_stringptr, &deliver_domain_orig },
654 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
655 { "originator_gid", vtype_gid, &originator_gid },
656 { "originator_uid", vtype_uid, &originator_uid },
657 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
658 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
659 { "pid", vtype_pid, NULL },
661 { "prdr_requested", vtype_bool, &prdr_requested },
663 { "primary_hostname", vtype_stringptr, &primary_hostname },
664 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
665 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
666 { "proxy_external_port", vtype_int, &proxy_external_port },
667 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
668 { "proxy_local_port", vtype_int, &proxy_local_port },
669 { "proxy_session", vtype_bool, &proxy_session },
671 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
672 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
673 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
674 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
675 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
676 { "queue_name", vtype_stringptr, &queue_name },
677 { "queue_size", vtype_string_func, &fn_queue_size },
678 { "rcpt_count", vtype_int, &rcpt_count },
679 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
680 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
681 { "received_count", vtype_int, &received_count },
682 { "received_for", vtype_stringptr, &received_for },
683 { "received_ip_address", vtype_stringptr, &interface_address },
684 { "received_port", vtype_int, &interface_port },
685 { "received_protocol", vtype_stringptr, &received_protocol },
686 { "received_time", vtype_int, &received_time.tv_sec },
687 { "recipient_data", vtype_stringptr, &recipient_data },
688 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
689 { "recipients", vtype_string_func, (void *) &fn_recipients },
690 { "recipients_count", vtype_int, &recipients_count },
691 #ifdef WITH_CONTENT_SCAN
692 { "regex_match_string", vtype_stringptr, ®ex_match_string },
694 { "reply_address", vtype_reply, NULL },
695 { "return_path", vtype_stringptr, &return_path },
696 { "return_size_limit", vtype_int, &bounce_return_size_limit },
697 { "router_name", vtype_stringptr, &router_name },
698 { "runrc", vtype_int, &runrc },
699 { "self_hostname", vtype_stringptr, &self_hostname },
700 { "sender_address", vtype_stringptr, &sender_address },
701 { "sender_address_data", vtype_stringptr, &sender_address_data },
702 { "sender_address_domain", vtype_domain, &sender_address },
703 { "sender_address_local_part", vtype_localpart, &sender_address },
704 { "sender_data", vtype_stringptr, &sender_data },
705 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
706 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
707 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
708 { "sender_host_address", vtype_stringptr, &sender_host_address },
709 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
710 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
711 { "sender_host_name", vtype_host_lookup, NULL },
712 { "sender_host_port", vtype_int, &sender_host_port },
713 { "sender_ident", vtype_stringptr, &sender_ident },
714 { "sender_rate", vtype_stringptr, &sender_rate },
715 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
716 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
717 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
718 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
719 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
720 { "sending_port", vtype_int, &sending_port },
721 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
722 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
723 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
724 { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
725 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
726 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
727 { "sn0", vtype_filter_int, &filter_sn[0] },
728 { "sn1", vtype_filter_int, &filter_sn[1] },
729 { "sn2", vtype_filter_int, &filter_sn[2] },
730 { "sn3", vtype_filter_int, &filter_sn[3] },
731 { "sn4", vtype_filter_int, &filter_sn[4] },
732 { "sn5", vtype_filter_int, &filter_sn[5] },
733 { "sn6", vtype_filter_int, &filter_sn[6] },
734 { "sn7", vtype_filter_int, &filter_sn[7] },
735 { "sn8", vtype_filter_int, &filter_sn[8] },
736 { "sn9", vtype_filter_int, &filter_sn[9] },
737 #ifdef WITH_CONTENT_SCAN
738 { "spam_action", vtype_stringptr, &spam_action },
739 { "spam_bar", vtype_stringptr, &spam_bar },
740 { "spam_report", vtype_stringptr, &spam_report },
741 { "spam_score", vtype_stringptr, &spam_score },
742 { "spam_score_int", vtype_stringptr, &spam_score_int },
745 { "spf_guess", vtype_stringptr, &spf_guess },
746 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
747 { "spf_received", vtype_stringptr, &spf_received },
748 { "spf_result", vtype_stringptr, &spf_result },
749 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
750 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
752 { "spool_directory", vtype_stringptr, &spool_directory },
753 { "spool_inodes", vtype_pinodes, (void *)TRUE },
754 { "spool_space", vtype_pspace, (void *)TRUE },
755 #ifdef EXPERIMENTAL_SRS
756 { "srs_db_address", vtype_stringptr, &srs_db_address },
757 { "srs_db_key", vtype_stringptr, &srs_db_key },
758 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
759 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
761 #if defined(EXPERIMENTAL_SRS) || defined(EXPERIMENTAL_SRS_NATIVE)
762 { "srs_recipient", vtype_stringptr, &srs_recipient },
764 #ifdef EXPERIMENTAL_SRS
765 { "srs_status", vtype_stringptr, &srs_status },
767 { "thisaddress", vtype_stringptr, &filter_thisaddress },
769 /* The non-(in,out) variables are now deprecated */
770 { "tls_bits", vtype_int, &tls_in.bits },
771 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
772 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
774 { "tls_in_bits", vtype_int, &tls_in.bits },
775 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
776 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
777 { "tls_in_cipher_std", vtype_stringptr, &tls_in.cipher_stdname },
778 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
779 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
780 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
781 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
782 #ifdef EXPERIMENTAL_TLS_RESUME
783 { "tls_in_resumption", vtype_int, &tls_in.resumption },
786 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
788 { "tls_in_ver", vtype_stringptr, &tls_in.ver },
789 { "tls_out_bits", vtype_int, &tls_out.bits },
790 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
791 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
792 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },
794 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
796 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
797 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
798 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
799 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
800 #ifdef EXPERIMENTAL_TLS_RESUME
801 { "tls_out_resumption", vtype_int, &tls_out.resumption },
804 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
807 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
809 { "tls_out_ver", vtype_stringptr, &tls_out.ver },
811 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
813 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
816 { "tod_bsdinbox", vtype_todbsdin, NULL },
817 { "tod_epoch", vtype_tode, NULL },
818 { "tod_epoch_l", vtype_todel, NULL },
819 { "tod_full", vtype_todf, NULL },
820 { "tod_log", vtype_todl, NULL },
821 { "tod_logfile", vtype_todlf, NULL },
822 { "tod_zone", vtype_todzone, NULL },
823 { "tod_zulu", vtype_todzulu, NULL },
824 { "transport_name", vtype_stringptr, &transport_name },
825 { "value", vtype_stringptr, &lookup_value },
826 { "verify_mode", vtype_stringptr, &verify_mode },
827 { "version_number", vtype_stringptr, &version_string },
828 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
829 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
830 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
831 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
832 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
833 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
836 static int var_table_size = nelem(var_table);
837 static uschar var_buffer[256];
838 static BOOL malformed_header;
840 /* For textual hashes */
842 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
843 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
846 enum { HMAC_MD5, HMAC_SHA1 };
848 /* For numeric hashes */
850 static unsigned int prime[] = {
851 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
852 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
853 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
855 /* For printing modes in symbolic form */
857 static uschar *mtable_normal[] =
858 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
860 static uschar *mtable_setid[] =
861 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
863 static uschar *mtable_sticky[] =
864 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
866 /* flags for find_header() */
867 #define FH_EXISTS_ONLY BIT(0)
868 #define FH_WANT_RAW BIT(1)
869 #define FH_WANT_LIST BIT(2)
872 /*************************************************
873 * Tables for UTF-8 support *
874 *************************************************/
876 /* Table of the number of extra characters, indexed by the first character
877 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
880 static uschar utf8_table1[] = {
881 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
882 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
883 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
884 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
886 /* These are the masks for the data bits in the first byte of a character,
887 indexed by the number of additional bytes. */
889 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
891 /* Get the next UTF-8 character, advancing the pointer. */
893 #define GETUTF8INC(c, ptr) \
895 if ((c & 0xc0) == 0xc0) \
897 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
899 c = (c & utf8_table2[a]) << s; \
903 c |= (*ptr++ & 0x3f) << s; \
909 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
911 /*************************************************
912 * Binary chop search on a table *
913 *************************************************/
915 /* This is used for matching expansion items and operators.
918 name the name that is being sought
919 table the table to search
920 table_size the number of items in the table
922 Returns: the offset in the table, or -1
926 chop_match(uschar *name, uschar **table, int table_size)
928 uschar **bot = table;
929 uschar **top = table + table_size;
933 uschar **mid = bot + (top - bot)/2;
934 int c = Ustrcmp(name, *mid);
935 if (c == 0) return mid - table;
936 if (c > 0) bot = mid + 1; else top = mid;
944 /*************************************************
945 * Check a condition string *
946 *************************************************/
948 /* This function is called to expand a string, and test the result for a "true"
949 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
950 forced fail or lookup defer.
952 We used to release all store used, but this is not not safe due
953 to ${dlfunc } and ${acl }. In any case expand_string_internal()
954 is reasonably careful to release what it can.
956 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
959 condition the condition string
960 m1 text to be incorporated in panic error
963 Returns: TRUE if condition is met, FALSE if not
967 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
969 uschar * ss = expand_string(condition);
972 if (!f.expand_string_forcedfail && !f.search_find_defer)
973 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
974 "for %s %s: %s", condition, m1, m2, expand_string_message);
977 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
978 strcmpic(ss, US"false") != 0;
984 /*************************************************
985 * Pseudo-random number generation *
986 *************************************************/
988 /* Pseudo-random number generation. The result is not "expected" to be
989 cryptographically strong but not so weak that someone will shoot themselves
990 in the foot using it as a nonce in some email header scheme or whatever
991 weirdness they'll twist this into. The result should ideally handle fork().
993 However, if we're stuck unable to provide this, then we'll fall back to
994 appallingly bad randomness.
996 If DISABLE_TLS is not defined then this will not be used except as an emergency
1001 Returns a random number in range [0, max-1]
1005 # define vaguely_random_number vaguely_random_number_fallback
1008 vaguely_random_number(int max)
1011 # undef vaguely_random_number
1013 static pid_t pid = 0;
1016 if ((p2 = getpid()) != pid)
1021 #ifdef HAVE_ARC4RANDOM
1022 /* cryptographically strong randomness, common on *BSD platforms, not
1023 so much elsewhere. Alas. */
1024 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1027 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1028 # ifdef HAVE_SRANDOMDEV
1029 /* uses random(4) for seeding */
1034 gettimeofday(&tv, NULL);
1035 srandom(tv.tv_sec | tv.tv_usec | getpid());
1039 /* Poor randomness and no seeding here */
1046 #ifdef HAVE_ARC4RANDOM
1047 return arc4random() % max;
1048 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1049 return random() % max;
1051 /* This one returns a 16-bit number, definitely not crypto-strong */
1052 return random_number(max);
1059 /*************************************************
1060 * Pick out a name from a string *
1061 *************************************************/
1063 /* If the name is too long, it is silently truncated.
1066 name points to a buffer into which to put the name
1067 max is the length of the buffer
1068 s points to the first alphabetic character of the name
1069 extras chars other than alphanumerics to permit
1071 Returns: pointer to the first character after the name
1073 Note: The test for *s != 0 in the while loop is necessary because
1074 Ustrchr() yields non-NULL if the character is zero (which is not something
1077 static const uschar *
1078 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1081 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1083 if (ptr < max-1) name[ptr++] = *s;
1092 /*************************************************
1093 * Pick out the rest of a header name *
1094 *************************************************/
1096 /* A variable name starting $header_ (or just $h_ for those who like
1097 abbreviations) might not be the complete header name because headers can
1098 contain any printing characters in their names, except ':'. This function is
1099 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1100 on the end, if the name was terminated by white space.
1103 name points to a buffer in which the name read so far exists
1104 max is the length of the buffer
1105 s points to the first character after the name so far, i.e. the
1106 first non-alphameric character after $header_xxxxx
1108 Returns: a pointer to the first character after the header name
1111 static const uschar *
1112 read_header_name(uschar *name, int max, const uschar *s)
1114 int prelen = Ustrchr(name, '_') - name + 1;
1115 int ptr = Ustrlen(name) - prelen;
1116 if (ptr > 0) memmove(name, name+prelen, ptr);
1117 while (mac_isgraph(*s) && *s != ':')
1119 if (ptr < max-1) name[ptr++] = *s;
1130 /*************************************************
1131 * Pick out a number from a string *
1132 *************************************************/
1135 n points to an integer into which to put the number
1136 s points to the first digit of the number
1138 Returns: a pointer to the character after the last digit
1140 /*XXX consider expanding to int_eximarith_t. But the test for
1141 "overbig numbers" in 0002 still needs to overflow it. */
1144 read_number(int *n, uschar *s)
1147 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1151 static const uschar *
1152 read_cnumber(int *n, const uschar *s)
1155 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1161 /*************************************************
1162 * Extract keyed subfield from a string *
1163 *************************************************/
1165 /* The yield is in dynamic store; NULL means that the key was not found.
1168 key points to the name of the key
1169 s points to the string from which to extract the subfield
1171 Returns: NULL if the subfield was not found, or
1172 a pointer to the subfield's data
1176 expand_getkeyed(const uschar * key, const uschar * s)
1178 int length = Ustrlen(key);
1179 Uskip_whitespace(&s);
1181 /* Loop to search for the key */
1187 const uschar * dkey = s;
1189 while (*s && *s != '=' && !isspace(*s)) s++;
1190 dkeylength = s - dkey;
1191 if (Uskip_whitespace(&s) == '=') while (isspace(*++s));
1193 data = string_dequote(&s);
1194 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1197 Uskip_whitespace(&s);
1206 find_var_ent(uschar * name)
1209 int last = var_table_size;
1211 while (last > first)
1213 int middle = (first + last)/2;
1214 int c = Ustrcmp(name, var_table[middle].name);
1216 if (c > 0) { first = middle + 1; continue; }
1217 if (c < 0) { last = middle; continue; }
1218 return &var_table[middle];
1223 /*************************************************
1224 * Extract numbered subfield from string *
1225 *************************************************/
1227 /* Extracts a numbered field from a string that is divided by tokens - for
1228 example a line from /etc/passwd is divided by colon characters. First field is
1229 numbered one. Negative arguments count from the right. Zero returns the whole
1230 string. Returns NULL if there are insufficient tokens in the string
1233 Modifies final argument - this is a dynamically generated string, so that's OK.
1236 field number of field to be extracted,
1237 first field = 1, whole string = 0, last field = -1
1238 separators characters that are used to break string into tokens
1239 s points to the string from which to extract the subfield
1241 Returns: NULL if the field was not found,
1242 a pointer to the field's data inside s (modified to add 0)
1246 expand_gettokened (int field, uschar *separators, uschar *s)
1251 uschar *fieldtext = NULL;
1253 if (field == 0) return s;
1255 /* Break the line up into fields in place; for field > 0 we stop when we have
1256 done the number of fields we want. For field < 0 we continue till the end of
1257 the string, counting the number of fields. */
1259 count = (field > 0)? field : INT_MAX;
1265 /* Previous field was the last one in the string. For a positive field
1266 number, this means there are not enough fields. For a negative field number,
1267 check that there are enough, and scan back to find the one that is wanted. */
1271 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1272 if ((-field) == (INT_MAX - count - 1)) return s;
1276 while (ss[-1] != 0) ss--;
1282 /* Previous field was not last in the string; save its start and put a
1286 len = Ustrcspn(ss, separators);
1297 expand_getlistele(int field, const uschar * list)
1299 const uschar * tlist = list;
1301 /* Tainted mem for the throwaway element copies */
1302 uschar * dummy = store_get(2, TRUE);
1306 for (field++; string_nextinlist(&tlist, &sep, dummy, 1); ) field++;
1309 if (field == 0) return NULL;
1310 while (--field > 0 && (string_nextinlist(&list, &sep, dummy, 1))) ;
1311 return string_nextinlist(&list, &sep, NULL, 0);
1315 /* Certificate fields, by name. Worry about by-OID later */
1316 /* Names are chosen to not have common prefixes */
1323 uschar * (*getfn)(void * cert, uschar * mod);
1325 static certfield certfields[] =
1326 { /* linear search; no special order */
1327 { US"version", 7, &tls_cert_version },
1328 { US"serial_number", 13, &tls_cert_serial_number },
1329 { US"subject", 7, &tls_cert_subject },
1330 { US"notbefore", 9, &tls_cert_not_before },
1331 { US"notafter", 8, &tls_cert_not_after },
1332 { US"issuer", 6, &tls_cert_issuer },
1333 { US"signature", 9, &tls_cert_signature },
1334 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1335 { US"subj_altname", 12, &tls_cert_subject_altname },
1336 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1337 { US"crl_uri", 7, &tls_cert_crl_uri },
1341 expand_getcertele(uschar * field, uschar * certvar)
1345 if (!(vp = find_var_ent(certvar)))
1347 expand_string_message =
1348 string_sprintf("no variable named \"%s\"", certvar);
1349 return NULL; /* Unknown variable name */
1351 /* NB this stops us passing certs around in variable. Might
1352 want to do that in future */
1353 if (vp->type != vtype_cert)
1355 expand_string_message =
1356 string_sprintf("\"%s\" is not a certificate", certvar);
1357 return NULL; /* Unknown variable name */
1359 if (!*(void **)vp->value)
1362 if (*field >= '0' && *field <= '9')
1363 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1365 for (certfield * cp = certfields;
1366 cp < certfields + nelem(certfields);
1368 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1370 uschar * modifier = *(field += cp->namelen) == ','
1372 return (*cp->getfn)( *(void **)vp->value, modifier );
1375 expand_string_message =
1376 string_sprintf("bad field selector \"%s\" for certextract", field);
1379 #endif /*DISABLE_TLS*/
1381 /*************************************************
1382 * Extract a substring from a string *
1383 *************************************************/
1385 /* Perform the ${substr or ${length expansion operations.
1388 subject the input string
1389 value1 the offset from the start of the input string to the start of
1390 the output string; if negative, count from the right.
1391 value2 the length of the output string, or negative (-1) for unset
1392 if value1 is positive, unset means "all after"
1393 if value1 is negative, unset means "all before"
1394 len set to the length of the returned string
1396 Returns: pointer to the output string, or NULL if there is an error
1400 extract_substr(uschar *subject, int value1, int value2, int *len)
1402 int sublen = Ustrlen(subject);
1404 if (value1 < 0) /* count from right */
1408 /* If the position is before the start, skip to the start, and adjust the
1409 length. If the length ends up negative, the substring is null because nothing
1410 can precede. This falls out naturally when the length is unset, meaning "all
1416 if (value2 < 0) value2 = 0;
1420 /* Otherwise an unset length => characters before value1 */
1422 else if (value2 < 0)
1429 /* For a non-negative offset, if the starting position is past the end of the
1430 string, the result will be the null string. Otherwise, an unset length means
1431 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1435 if (value1 > sublen)
1440 else if (value2 < 0) value2 = sublen;
1443 /* Cut the length down to the maximum possible for the offset value, and get
1444 the required characters. */
1446 if (value1 + value2 > sublen) value2 = sublen - value1;
1448 return subject + value1;
1454 /*************************************************
1455 * Old-style hash of a string *
1456 *************************************************/
1458 /* Perform the ${hash expansion operation.
1461 subject the input string (an expanded substring)
1462 value1 the length of the output string; if greater or equal to the
1463 length of the input string, the input string is returned
1464 value2 the number of hash characters to use, or 26 if negative
1465 len set to the length of the returned string
1467 Returns: pointer to the output string, or NULL if there is an error
1471 compute_hash(uschar *subject, int value1, int value2, int *len)
1473 int sublen = Ustrlen(subject);
1475 if (value2 < 0) value2 = 26;
1476 else if (value2 > Ustrlen(hashcodes))
1478 expand_string_message =
1479 string_sprintf("hash count \"%d\" too big", value2);
1483 /* Calculate the hash text. We know it is shorter than the original string, so
1484 can safely place it in subject[] (we know that subject is always itself an
1485 expanded substring). */
1487 if (value1 < sublen)
1492 while ((c = (subject[j])) != 0)
1494 int shift = (c + j++) & 7;
1495 subject[i] ^= (c << shift) | (c >> (8-shift));
1496 if (++i >= value1) i = 0;
1498 for (i = 0; i < value1; i++)
1499 subject[i] = hashcodes[(subject[i]) % value2];
1501 else value1 = sublen;
1510 /*************************************************
1511 * Numeric hash of a string *
1512 *************************************************/
1514 /* Perform the ${nhash expansion operation. The first characters of the
1515 string are treated as most important, and get the highest prime numbers.
1518 subject the input string
1519 value1 the maximum value of the first part of the result
1520 value2 the maximum value of the second part of the result,
1521 or negative to produce only a one-part result
1522 len set to the length of the returned string
1524 Returns: pointer to the output string, or NULL if there is an error.
1528 compute_nhash (uschar *subject, int value1, int value2, int *len)
1530 uschar *s = subject;
1532 unsigned long int total = 0; /* no overflow */
1536 if (i == 0) i = nelem(prime) - 1;
1537 total += prime[i--] * (unsigned int)(*s++);
1540 /* If value2 is unset, just compute one number */
1543 s = string_sprintf("%lu", total % value1);
1545 /* Otherwise do a div/mod hash */
1549 total = total % (value1 * value2);
1550 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1561 /*************************************************
1562 * Find the value of a header or headers *
1563 *************************************************/
1565 /* Multiple instances of the same header get concatenated, and this function
1566 can also return a concatenation of all the header lines. When concatenating
1567 specific headers that contain lists of addresses, a comma is inserted between
1568 them. Otherwise we use a straight concatenation. Because some messages can have
1569 pathologically large number of lines, there is a limit on the length that is
1573 name the name of the header, without the leading $header_ or $h_,
1574 or NULL if a concatenation of all headers is required
1575 newsize return the size of memory block that was obtained; may be NULL
1576 if exists_only is TRUE
1577 flags FH_EXISTS_ONLY
1578 set if called from a def: test; don't need to build a string;
1579 just return a string that is not "" and not "0" if the header
1582 set if called for $rh_ or $rheader_ items; no processing,
1583 other than concatenating, will be done on the header. Also used
1584 for $message_headers_raw.
1586 Double colon chars in the content, and replace newline with
1587 colon between each element when concatenating; returning a
1588 colon-sep list (elements might contain newlines)
1589 charset name of charset to translate MIME words to; used only if
1590 want_raw is false; if NULL, no translation is done (this is
1591 used for $bh_ and $bheader_)
1593 Returns: NULL if the header does not exist, else a pointer to a new
1598 find_header(uschar *name, int *newsize, unsigned flags, uschar *charset)
1601 int len = name ? Ustrlen(name) : 0;
1605 for (header_line * h = header_list; h; h = h->next)
1606 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1607 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1612 if (flags & FH_EXISTS_ONLY)
1613 return US"1"; /* don't need actual string */
1616 s = h->text + len; /* text to insert */
1617 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1618 Uskip_whitespace(&s); /* remove leading white space */
1619 t = h->text + h->slen; /* end-point */
1621 /* Unless wanted raw, remove trailing whitespace, including the
1624 if (flags & FH_WANT_LIST)
1625 while (t > s && t[-1] == '\n') t--;
1626 else if (!(flags & FH_WANT_RAW))
1628 while (t > s && isspace(t[-1])) t--;
1630 /* Set comma if handling a single header and it's one of those
1631 that contains an address list, except when asked for raw headers. Only
1632 need to do this once. */
1634 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1637 /* Trim the header roughly if we're approaching limits */
1639 if (gstring_length(g) + inc > header_insert_maxlen)
1640 inc = header_insert_maxlen - gstring_length(g);
1642 /* For raw just copy the data; for a list, add the data as a colon-sep
1643 list-element; for comma-list add as an unchecked comma,newline sep
1644 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1645 stripped trailing WS above including the newline). We ignore the potential
1646 expansion due to colon-doubling, just leaving the loop if the limit is met
1649 if (flags & FH_WANT_LIST)
1650 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1651 else if (flags & FH_WANT_RAW)
1652 g = string_catn(g, s, (unsigned)inc);
1654 g = string_append2_listele_n(g, comma ? US",\n" : US"\n",
1657 if (gstring_length(g) >= header_insert_maxlen) break;
1660 if (!found) return NULL; /* No header found */
1661 if (!g) return US"";
1663 /* That's all we do for raw header expansion. */
1666 if (flags & FH_WANT_RAW)
1667 return string_from_gstring(g);
1669 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1670 The rfc2047_decode2() function can return an error with decoded data if the
1671 charset translation fails. If decoding fails, it returns NULL. */
1675 uschar * error, * decoded = rfc2047_decode2(string_from_gstring(g),
1676 check_rfc2047_length, charset, '?', NULL, newsize, &error);
1678 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1679 " input was: %s\n", error, g->s);
1680 return decoded ? decoded : string_from_gstring(g);
1687 /* Append a "local" element to an Authentication-Results: header
1688 if this was a non-smtp message.
1692 authres_local(gstring * g, const uschar * sysname)
1694 if (!f.authentication_local)
1696 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1697 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1702 /* Append an "iprev" element to an Authentication-Results: header
1703 if we have attempted to get the calling host's name.
1707 authres_iprev(gstring * g)
1709 if (sender_host_name)
1710 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1711 else if (host_lookup_deferred)
1712 g = string_catn(g, US";\n\tiprev=temperror", 19);
1713 else if (host_lookup_failed)
1714 g = string_catn(g, US";\n\tiprev=fail", 13);
1718 if (sender_host_address)
1719 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1725 /*************************************************
1726 * Return list of recipients *
1727 *************************************************/
1728 /* A recipients list is available only during system message filtering,
1729 during ACL processing after DATA, and while expanding pipe commands
1730 generated from a system filter, but not elsewhere. */
1738 if (!f.enable_dollar_recipients) return NULL;
1740 for (int i = 0; i < recipients_count; i++)
1742 s = recipients_list[i].address;
1743 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1745 return g ? g->s : NULL;
1749 /*************************************************
1750 * Return size of queue *
1751 *************************************************/
1752 /* Ask the daemon for the queue size */
1757 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1761 const uschar * where;
1762 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1768 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
1770 DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));
1774 #ifdef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1775 sa_un.sun_path[0] = 0; /* Abstract local socket addr - Linux-specific? */
1776 len = offsetof(struct sockaddr_un, sun_path) + 1
1777 + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "exim_%d", getpid());
1779 sname = string_sprintf("%s/p_%d", spool_directory, getpid());
1780 len = offsetof(struct sockaddr_un, sun_path)
1781 + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s", sname);
1784 if (bind(fd, (const struct sockaddr *)&sa_un, len) < 0)
1785 { where = US"bind"; goto bad; }
1788 debug_printf("local addr '%s%s'\n",
1789 *sa_un.sun_path ? "" : "@",
1790 sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1793 #ifdef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1794 sa_un.sun_path[0] = 0; /* Abstract local socket addr - Linux-specific? */
1795 len = offsetof(struct sockaddr_un, sun_path) + 1
1796 + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "%s",
1797 expand_string(notifier_socket));
1799 len = offsetof(struct sockaddr_un, sun_path)
1800 + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s",
1801 expand_string(notifier_socket));
1804 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
1805 { where = US"connect"; goto bad2; }
1807 buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1808 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1810 FD_ZERO(&fds); FD_SET(fd, &fds);
1811 tv.tv_sec = 2; tv.tv_usec = 0;
1812 if (select(fd + 1, (SELECT_ARG2_TYPE *)&fds, NULL, NULL, &tv) != 1)
1814 DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1815 len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1817 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1818 { where = US"recv"; goto bad2; }
1821 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1824 return string_copyn(buf, len);
1827 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1832 DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1837 /*************************************************
1838 * Find value of a variable *
1839 *************************************************/
1841 /* The table of variables is kept in alphabetic order, so we can search it
1842 using a binary chop. The "choplen" variable is nothing to do with the binary
1846 name the name of the variable being sought
1847 exists_only TRUE if this is a def: test; passed on to find_header()
1848 skipping TRUE => skip any processing evaluation; this is not the same as
1849 exists_only because def: may test for values that are first
1851 newsize pointer to an int which is initially zero; if the answer is in
1852 a new memory buffer, *newsize is set to its size
1854 Returns: NULL if the variable does not exist, or
1855 a pointer to the variable's contents, or
1856 something non-NULL if exists_only is TRUE
1860 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1867 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1868 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1869 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1870 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1871 (this gave backwards compatibility at the changeover). There may be built-in
1872 variables whose names start acl_ but they should never start in this way. This
1873 slightly messy specification is a consequence of the history, needless to say.
1875 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1876 set, in which case give an error. */
1878 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1882 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1883 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1885 else if (Ustrncmp(name, "r_", 2) == 0)
1887 tree_node * node = tree_search(router_var, name + 2);
1888 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1891 /* Handle $auth<n> variables. */
1893 if (Ustrncmp(name, "auth", 4) == 0)
1896 int n = Ustrtoul(name + 4, &endptr, 10);
1897 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1898 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1900 else if (Ustrncmp(name, "regex", 5) == 0)
1903 int n = Ustrtoul(name + 5, &endptr, 10);
1904 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1905 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1908 /* For all other variables, search the table */
1910 if (!(vp = find_var_ent(name)))
1911 return NULL; /* Unknown variable name */
1913 /* Found an existing variable. If in skipping state, the value isn't needed,
1914 and we want to avoid processing (such as looking up the host name). */
1922 case vtype_filter_int:
1923 if (!f.filter_running) return NULL;
1927 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1931 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1935 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1939 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1943 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1946 case vtype_stringptr: /* Pointer to string */
1947 return (s = *((uschar **)(val))) ? s : US"";
1950 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1953 case vtype_load_avg:
1954 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1957 case vtype_host_lookup: /* Lookup if not done so */
1958 if ( !sender_host_name && sender_host_address
1959 && !host_lookup_failed && host_name_lookup() == OK)
1960 host_build_sender_fullhost();
1961 return sender_host_name ? sender_host_name : US"";
1963 case vtype_localpart: /* Get local part from address */
1964 if (!(s = *((uschar **)(val)))) return US"";
1965 if (!(domain = Ustrrchr(s, '@'))) return s;
1966 if (domain - s > sizeof(var_buffer) - 1)
1967 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1968 " in string expansion", sizeof(var_buffer));
1969 return string_copyn(s, domain - s);
1971 case vtype_domain: /* Get domain from address */
1972 if (!(s = *((uschar **)(val)))) return US"";
1973 domain = Ustrrchr(s, '@');
1974 return domain ? domain + 1 : US"";
1976 case vtype_msgheaders:
1977 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
1979 case vtype_msgheaders_raw:
1980 return find_header(NULL, newsize,
1981 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
1983 case vtype_msgbody: /* Pointer to msgbody string */
1984 case vtype_msgbody_end: /* Ditto, the end of the msg */
1985 ss = (uschar **)(val);
1986 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1989 off_t start_offset = SPOOL_DATA_START_OFFSET;
1990 int len = message_body_visible;
1991 if (len > message_size) len = message_size;
1992 *ss = body = store_malloc(len+1);
1994 if (vp->type == vtype_msgbody_end)
1996 struct stat statbuf;
1997 if (fstat(deliver_datafile, &statbuf) == 0)
1999 start_offset = statbuf.st_size - len;
2000 if (start_offset < SPOOL_DATA_START_OFFSET)
2001 start_offset = SPOOL_DATA_START_OFFSET;
2004 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
2005 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
2007 len = read(deliver_datafile, body, len);
2011 if (message_body_newlines) /* Separate loops for efficiency */
2013 { if (body[--len] == 0) body[len] = ' '; }
2016 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
2019 return *ss ? *ss : US"";
2021 case vtype_todbsdin: /* BSD inbox time of day */
2022 return tod_stamp(tod_bsdin);
2024 case vtype_tode: /* Unix epoch time of day */
2025 return tod_stamp(tod_epoch);
2027 case vtype_todel: /* Unix epoch/usec time of day */
2028 return tod_stamp(tod_epoch_l);
2030 case vtype_todf: /* Full time of day */
2031 return tod_stamp(tod_full);
2033 case vtype_todl: /* Log format time of day */
2034 return tod_stamp(tod_log_bare); /* (without timezone) */
2036 case vtype_todzone: /* Time zone offset only */
2037 return tod_stamp(tod_zone);
2039 case vtype_todzulu: /* Zulu time */
2040 return tod_stamp(tod_zulu);
2042 case vtype_todlf: /* Log file datestamp tod */
2043 return tod_stamp(tod_log_datestamp_daily);
2045 case vtype_reply: /* Get reply address */
2046 s = find_header(US"reply-to:", newsize,
2047 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2049 if (s) Uskip_whitespace(&s);
2052 *newsize = 0; /* For the *s==0 case */
2053 s = find_header(US"from:", newsize,
2054 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2060 Uskip_whitespace(&s);
2061 for (t = s; *t; t++) if (*t == '\n') *t = ' ';
2062 while (t > s && isspace(t[-1])) t--;
2065 return s ? s : US"";
2067 case vtype_string_func:
2069 stringptr_fn_t * fn = (stringptr_fn_t *) val;
2071 return s ? s : US"";
2077 sprintf(CS var_buffer, PR_EXIM_ARITH,
2078 receive_statvfs(val == (void *)TRUE, &inodes));
2085 (void) receive_statvfs(val == (void *)TRUE, &inodes);
2086 sprintf(CS var_buffer, "%d", inodes);
2091 return *(void **)val ? US"<cert>" : US"";
2093 #ifndef DISABLE_DKIM
2095 return dkim_exim_expand_query((int)(long)val);
2100 return NULL; /* Unknown variable. Silences static checkers. */
2107 modify_variable(uschar *name, void * value)
2110 if ((vp = find_var_ent(name))) vp->value = value;
2111 return; /* Unknown variable name, fail silently */
2119 /*************************************************
2120 * Read and expand substrings *
2121 *************************************************/
2123 /* This function is called to read and expand argument substrings for various
2124 expansion items. Some have a minimum requirement that is less than the maximum;
2125 in these cases, the first non-present one is set to NULL.
2128 sub points to vector of pointers to set
2129 n maximum number of substrings
2131 sptr points to current string pointer
2132 skipping the skipping flag
2133 check_end if TRUE, check for final '}'
2134 name name of item, for error message
2135 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2138 Returns: 0 OK; string pointer updated
2139 1 curly bracketing error (too few arguments)
2140 2 too many arguments (only if check_end is set); message set
2141 3 other error (expansion failure)
2145 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
2146 BOOL check_end, uschar *name, BOOL *resetok)
2148 const uschar *s = *sptr;
2150 Uskip_whitespace(&s);
2151 for (int i = 0; i < n; i++)
2157 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2158 "(min is %d)", name, m);
2164 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2166 if (*s++ != '}') return 1;
2167 Uskip_whitespace(&s);
2169 if (check_end && *s++ != '}')
2173 expand_string_message = string_sprintf("Too many arguments for '%s' "
2174 "(max is %d)", name, n);
2177 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2188 /*************************************************
2189 * Elaborate message for bad variable *
2190 *************************************************/
2192 /* For the "unknown variable" message, take a look at the variable's name, and
2193 give additional information about possible ACL variables. The extra information
2194 is added on to expand_string_message.
2196 Argument: the name of the variable
2201 check_variable_error_message(uschar *name)
2203 if (Ustrncmp(name, "acl_", 4) == 0)
2204 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2205 (name[4] == 'c' || name[4] == 'm')?
2207 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2208 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2210 US"user-defined ACL variables must start acl_c or acl_m");
2216 Load args from sub array to globals, and call acl_check().
2217 Sub array will be corrupted on return.
2219 Returns: OK access is granted by an ACCEPT verb
2220 DISCARD access is (apparently) granted by a DISCARD verb
2221 FAIL access is denied
2222 FAIL_DROP access is denied; drop the connection
2223 DEFER can't tell at the moment
2227 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2230 int sav_narg = acl_narg;
2232 uschar * dummy_logmsg;
2233 extern int acl_where;
2235 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2236 for (i = 0; i < nsub && sub[i+1]; i++)
2238 uschar * tmp = acl_arg[i];
2239 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2240 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2245 sub[i+1] = acl_arg[i];
2246 acl_arg[i++] = NULL;
2250 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2252 acl_narg>0 ? acl_arg[0] : US"<none>",
2253 acl_narg>1 ? " +more" : "");
2255 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2257 for (i = 0; i < nsub; i++)
2258 acl_arg[i] = sub[i+1]; /* restore old args */
2259 acl_narg = sav_narg;
2267 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2268 The given string is modified on return. Leading whitespace is skipped while
2269 looking for the opening wrap character, then the rest is scanned for the trailing
2270 (non-escaped) wrap character. A backslash in the string will act as an escape.
2272 A nul is written over the trailing wrap, and a pointer to the char after the
2273 leading wrap is returned.
2276 s String for de-wrapping
2277 wrap Two-char string, the first being the opener, second the closer wrapping
2280 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2284 dewrap(uschar * s, const uschar * wrap)
2288 BOOL quotesmode = wrap[0] == wrap[1];
2290 if (Uskip_whitespace(&p) == *wrap)
2296 if (*p == '\\') p++;
2297 else if (!quotesmode && *p == wrap[-1]) depth++;
2298 else if (*p == *wrap)
2309 expand_string_message = string_sprintf("missing '%c'", *wrap);
2314 /* Pull off the leading array or object element, returning
2315 a copy in an allocated string. Update the list pointer.
2317 The element may itself be an abject or array.
2318 Return NULL when the list is empty.
2322 json_nextinlist(const uschar ** list)
2324 unsigned array_depth = 0, object_depth = 0;
2325 const uschar * s = *list, * item;
2327 skip_whitespace(&s);
2330 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2334 case '[': array_depth++; break;
2335 case ']': array_depth--; break;
2336 case '{': object_depth++; break;
2337 case '}': object_depth--; break;
2339 *list = *s ? s+1 : s;
2340 if (item == s) return NULL;
2341 item = string_copyn(item, s - item);
2342 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2348 /************************************************/
2349 /* Return offset in ops table, or -1 if not found.
2350 Repoint to just after the operator in the string.
2353 ss string representation of operator
2354 opname split-out operator name
2358 identify_operator(const uschar ** ss, uschar ** opname)
2360 const uschar * s = *ss;
2363 /* Numeric comparisons are symbolic */
2365 if (*s == '=' || *s == '>' || *s == '<')
2377 /* All other conditions are named */
2380 s = read_name(name, sizeof(name), s, US"_");
2383 /* If we haven't read a name, it means some non-alpha character is first. */
2387 expand_string_message = string_sprintf("condition name expected, "
2388 "but found \"%.16s\"", s);
2392 *opname = string_copy(name);
2394 return chop_match(name, cond_table, nelem(cond_table));
2398 /*************************************************
2399 * Handle MD5 or SHA-1 computation for HMAC *
2400 *************************************************/
2402 /* These are some wrapping functions that enable the HMAC code to be a bit
2403 cleaner. A good compiler will spot the tail recursion.
2406 type HMAC_MD5 or HMAC_SHA1
2407 remaining are as for the cryptographic hash functions
2413 chash_start(int type, void * base)
2415 if (type == HMAC_MD5)
2416 md5_start((md5 *)base);
2418 sha1_start((hctx *)base);
2422 chash_mid(int type, void * base, const uschar * string)
2424 if (type == HMAC_MD5)
2425 md5_mid((md5 *)base, string);
2427 sha1_mid((hctx *)base, string);
2431 chash_end(int type, void * base, const uschar * string, int length,
2434 if (type == HMAC_MD5)
2435 md5_end((md5 *)base, string, length, digest);
2437 sha1_end((hctx *)base, string, length, digest);
2443 #ifdef EXPERIMENTAL_SRS_NATIVE
2444 /* Do an hmac_md5. The result is _not_ nul-terminated, and is sized as
2445 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2448 key encoding key, nul-terminated
2449 src data to be hashed, nul-terminated
2451 len size of output buffer
2455 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2458 const uschar * keyptr;
2460 unsigned int keylen;
2462 #define MD5_HASHLEN 16
2463 #define MD5_HASHBLOCKLEN 64
2465 uschar keyhash[MD5_HASHLEN];
2466 uschar innerhash[MD5_HASHLEN];
2467 uschar finalhash[MD5_HASHLEN];
2468 uschar innerkey[MD5_HASHBLOCKLEN];
2469 uschar outerkey[MD5_HASHBLOCKLEN];
2472 keylen = Ustrlen(keyptr);
2474 /* If the key is longer than the hash block length, then hash the key
2477 if (keylen > MD5_HASHBLOCKLEN)
2479 chash_start(HMAC_MD5, &md5_base);
2480 chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2482 keylen = MD5_HASHLEN;
2485 /* Now make the inner and outer key values */
2487 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2488 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2490 for (int i = 0; i < keylen; i++)
2492 innerkey[i] ^= keyptr[i];
2493 outerkey[i] ^= keyptr[i];
2496 /* Now do the hashes */
2498 chash_start(HMAC_MD5, &md5_base);
2499 chash_mid(HMAC_MD5, &md5_base, innerkey);
2500 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2502 chash_start(HMAC_MD5, &md5_base);
2503 chash_mid(HMAC_MD5, &md5_base, outerkey);
2504 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2506 /* Encode the final hash as a hex string, limited by output buffer size */
2509 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2511 if (j-- <= 0) break;
2512 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2513 if (j-- <= 0) break;
2514 *p++ = hex_digits[finalhash[i] & 0x0f];
2518 #endif /*EXPERIMENTAL_SRS_NATIVE*/
2521 /*************************************************
2522 * Read and evaluate a condition *
2523 *************************************************/
2527 s points to the start of the condition text
2528 resetok points to a BOOL which is written false if it is unsafe to
2529 free memory. Certain condition types (acl) may have side-effect
2530 allocation which must be preserved.
2531 yield points to a BOOL to hold the result of the condition test;
2532 if NULL, we are just reading through a condition that is
2533 part of an "or" combination to check syntax, or in a state
2534 where the answer isn't required
2536 Returns: a pointer to the first character after the condition, or
2540 static const uschar *
2541 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2543 BOOL testfor = TRUE;
2544 BOOL tempcond, combined_cond;
2546 BOOL sub2_honour_dollar = TRUE;
2547 BOOL is_forany, is_json, is_jsons;
2548 int rc, cond_type, roffset;
2549 int_eximarith_t num[2];
2550 struct stat statbuf;
2553 const uschar *sub[10];
2556 const uschar *rerror;
2559 if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;
2561 switch(cond_type = identify_operator(&s, &opname))
2563 /* def: tests for a non-empty variable, or for the existence of a header. If
2564 yield == NULL we are in a skipping state, and don't care about the answer. */
2572 expand_string_message = US"\":\" expected after \"def\"";
2576 s = read_name(name, sizeof(name), s+1, US"_");
2578 /* Test for a header's existence. If the name contains a closing brace
2579 character, this may be a user error where the terminating colon has been
2580 omitted. Set a flag to adjust a subsequent error message in this case. */
2582 if ( ( *(t = name) == 'h'
2583 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2585 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2588 s = read_header_name(name, sizeof(name), s);
2589 /* {-for-text-editors */
2590 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2592 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2595 /* Test for a variable's having a non-empty value. A non-existent variable
2596 causes an expansion failure. */
2600 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2602 expand_string_message = name[0]
2603 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2604 : US"variable name omitted after \"def:\"";
2605 check_variable_error_message(name);
2608 if (yield) *yield = (t[0] != 0) == testfor;
2615 /* first_delivery tests for first delivery attempt */
2617 case ECOND_FIRST_DELIVERY:
2618 if (yield) *yield = f.deliver_firsttime == testfor;
2622 /* queue_running tests for any process started by a queue runner */
2624 case ECOND_QUEUE_RUNNING:
2625 if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2629 /* exists: tests for file existence
2630 isip: tests for any IP address
2631 isip4: tests for an IPv4 address
2632 isip6: tests for an IPv6 address
2633 pam: does PAM authentication
2634 radius: does RADIUS authentication
2635 ldapauth: does LDAP authentication
2636 pwcheck: does Cyrus SASL pwcheck authentication
2645 case ECOND_LDAPAUTH:
2648 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2650 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2651 if (!sub[0]) return NULL;
2652 /* {-for-text-editors */
2653 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2655 if (!yield) return s; /* No need to run the test if skipping */
2660 if ((expand_forbid & RDO_EXISTS) != 0)
2662 expand_string_message = US"File existence tests are not permitted";
2665 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2671 rc = string_is_ip_address(sub[0], NULL);
2672 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2673 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2676 /* Various authentication tests - all optionally compiled */
2680 rc = auth_call_pam(sub[0], &expand_string_message);
2683 goto COND_FAILED_NOT_COMPILED;
2684 #endif /* SUPPORT_PAM */
2687 #ifdef RADIUS_CONFIG_FILE
2688 rc = auth_call_radius(sub[0], &expand_string_message);
2691 goto COND_FAILED_NOT_COMPILED;
2692 #endif /* RADIUS_CONFIG_FILE */
2694 case ECOND_LDAPAUTH:
2697 /* Just to keep the interface the same */
2699 int old_pool = store_pool;
2700 store_pool = POOL_SEARCH;
2701 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2702 &expand_string_message, &do_cache);
2703 store_pool = old_pool;
2707 goto COND_FAILED_NOT_COMPILED;
2708 #endif /* LOOKUP_LDAP */
2711 #ifdef CYRUS_PWCHECK_SOCKET
2712 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2715 goto COND_FAILED_NOT_COMPILED;
2716 #endif /* CYRUS_PWCHECK_SOCKET */
2718 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2719 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2721 if (rc == ERROR || rc == DEFER) return NULL;
2722 *yield = (rc == OK) == testfor;
2728 /* call ACL (in a conditional context). Accept true, deny false.
2729 Defer is a forced-fail. Anything set by message= goes to $value.
2730 Up to ten parameters are used; we use the braces round the name+args
2731 like the saslauthd condition does, to permit a variable number of args.
2732 See also the expansion-item version EITEM_ACL and the traditional
2733 acl modifier ACLC_ACL.
2734 Since the ACL may allocate new global variables, tell our caller to not
2739 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2745 Uskip_whitespace(&s);
2746 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2748 switch(read_subs(sub, nelem(sub), 1,
2749 &s, yield == NULL, TRUE, name, resetok))
2751 case 1: expand_string_message = US"too few arguments or bracketing "
2754 case 3: return NULL;
2760 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2761 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2766 lookup_value = NULL;
2768 lookup_value = string_copy(user_msg);
2769 *yield = cond == testfor;
2773 f.expand_string_forcedfail = TRUE;
2776 expand_string_message = string_sprintf("%s from acl \"%s\"",
2777 rc_names[rc], sub[0]);
2785 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2787 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2789 However, the last two are optional. That is why the whole set is enclosed
2790 in their own set of braces. */
2792 case ECOND_SASLAUTHD:
2793 #ifndef CYRUS_SASLAUTHD_SOCKET
2794 goto COND_FAILED_NOT_COMPILED;
2798 Uskip_whitespace(&s);
2799 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2800 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, name,
2803 case 1: expand_string_message = US"too few arguments or bracketing "
2804 "error for saslauthd";
2806 case 3: return NULL;
2808 if (!sub[2]) sub[3] = NULL; /* realm if no service */
2811 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2812 &expand_string_message);
2813 if (rc == ERROR || rc == DEFER) return NULL;
2814 *yield = (rc == OK) == testfor;
2818 #endif /* CYRUS_SASLAUTHD_SOCKET */
2821 /* symbolic operators for numeric and string comparison, and a number of
2822 other operators, all requiring two arguments.
2824 crypteq: encrypts plaintext and compares against an encrypted text,
2825 using crypt(), crypt16(), MD5 or SHA-1
2826 inlist/inlisti: checks if first argument is in the list of the second
2827 match: does a regular expression match and sets up the numerical
2828 variables if it succeeds
2829 match_address: matches in an address list
2830 match_domain: matches in a domain list
2831 match_ip: matches a host list that is restricted to IP addresses
2832 match_local_part: matches in a local part list
2835 case ECOND_MATCH_ADDRESS:
2836 case ECOND_MATCH_DOMAIN:
2837 case ECOND_MATCH_IP:
2838 case ECOND_MATCH_LOCAL_PART:
2839 #ifndef EXPAND_LISTMATCH_RHS
2840 sub2_honour_dollar = FALSE;
2849 case ECOND_NUM_L: /* Numerical comparisons */
2856 case ECOND_STR_LT: /* String comparisons */
2867 for (int i = 0; i < 2; i++)
2869 /* Sometimes, we don't expand substrings; too many insecure configurations
2870 created using match_address{}{} and friends, where the second param
2871 includes information from untrustworthy sources. */
2872 BOOL honour_dollar = TRUE;
2873 if ((i > 0) && !sub2_honour_dollar)
2874 honour_dollar = FALSE;
2876 if (Uskip_whitespace(&s) != '{')
2878 if (i == 0) goto COND_FAILED_CURLY_START;
2879 expand_string_message = string_sprintf("missing 2nd string in {} "
2880 "after \"%s\"", opname);
2883 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2884 honour_dollar, resetok)))
2886 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2887 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2888 " for security reasons\n");
2889 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2891 /* Convert to numerical if required; we know that the names of all the
2892 conditions that compare numbers do not start with a letter. This just saves
2893 checking for them individually. */
2895 if (!isalpha(opname[0]) && yield)
2900 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2904 num[i] = expanded_string_integer(sub[i], FALSE);
2905 if (expand_string_message) return NULL;
2909 /* Result not required */
2911 if (!yield) return s;
2913 /* Do an appropriate comparison */
2919 tempcond = (num[0] == num[1]);
2923 tempcond = (num[0] > num[1]);
2927 tempcond = (num[0] >= num[1]);
2931 tempcond = (num[0] < num[1]);
2935 tempcond = (num[0] <= num[1]);
2939 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2943 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2947 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2951 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2955 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2959 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2963 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2967 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2971 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2975 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2978 case ECOND_MATCH: /* Regular expression match */
2979 if (!(re = pcre_compile(CS sub[1], PCRE_COPT, CCSS &rerror,
2982 expand_string_message = string_sprintf("regular expression error in "
2983 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2986 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);
3448 #ifdef EXPERIMENTAL_SRS_NATIVE
3449 case ECOND_INBOUND_SRS:
3450 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */
3457 BOOL boolvalue = FALSE;
3459 switch(read_subs(sub, 2, 2, CUSS &s, yield == NULL, FALSE, name, resetok))
3461 case 1: expand_string_message = US"too few arguments or bracketing "
3462 "error for inbound_srs";
3464 case 3: return NULL;
3467 /* Match the given local_part against the SRS-encoded pattern */
3469 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]+)=([^=]*)=(.*)$",
3471 if (pcre_exec(re, NULL, CS sub[0], Ustrlen(sub[0]), 0, PCRE_EOPT,
3472 ovec, nelem(ovec)) < 0)
3474 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3478 /* Side-effect: record the decoded recipient */
3480 srs_recipient = string_sprintf("%.*S@%.*S", /* lowercased */
3481 ovec[9]-ovec[8], sub[0] + ovec[8], /* substring 4 */
3482 ovec[7]-ovec[6], sub[0] + ovec[6]); /* substring 3 */
3484 /* If a zero-length secret was given, we're done. Otherwise carry on
3485 and validate the given SRS local_part againt our secret. */
3493 /* check the timestamp */
3496 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3499 gettimeofday(&now, NULL);
3500 now.tv_sec /= 86400; /* days since epoch */
3502 /* Decode substring 2 from base32 to a number */
3504 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3506 uschar * t = Ustrchr(base32_chars, *ss++);
3507 d = d * 32 + (t - base32_chars);
3510 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3512 DEBUG(D_expand) debug_printf("SRS too old\n");
3517 /* check length of substring 1, the offered checksum */
3519 if (ovec[3]-ovec[2] != 4)
3521 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3525 /* Hash the address with our secret, and compare that computed checksum
3526 with the one extracted from the arg */
3528 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3529 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3531 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3537 if (yield) *yield = (boolvalue == testfor);
3540 #endif /*EXPERIMENTAL_SRS_NATIVE*/
3542 /* Unknown condition */
3545 if (!expand_string_message || !*expand_string_message)
3546 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3548 } /* End switch on condition type */
3550 /* Missing braces at start and end of data */
3552 COND_FAILED_CURLY_START:
3553 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3556 COND_FAILED_CURLY_END:
3557 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3561 /* A condition requires code that is not compiled */
3563 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3564 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3565 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3566 COND_FAILED_NOT_COMPILED:
3567 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3576 /*************************************************
3577 * Save numerical variables *
3578 *************************************************/
3580 /* This function is called from items such as "if" that want to preserve and
3581 restore the numbered variables.
3584 save_expand_string points to an array of pointers to set
3585 save_expand_nlength points to an array of ints for the lengths
3587 Returns: the value of expand max to save
3591 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3593 for (int i = 0; i <= expand_nmax; i++)
3595 save_expand_nstring[i] = expand_nstring[i];
3596 save_expand_nlength[i] = expand_nlength[i];
3603 /*************************************************
3604 * Restore numerical variables *
3605 *************************************************/
3607 /* This function restored saved values of numerical strings.
3610 save_expand_nmax the number of strings to restore
3611 save_expand_string points to an array of pointers
3612 save_expand_nlength points to an array of ints
3618 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3619 int *save_expand_nlength)
3621 expand_nmax = save_expand_nmax;
3622 for (int i = 0; i <= expand_nmax; i++)
3624 expand_nstring[i] = save_expand_nstring[i];
3625 expand_nlength[i] = save_expand_nlength[i];
3633 /*************************************************
3634 * Handle yes/no substrings *
3635 *************************************************/
3637 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3638 alternative substrings that depend on whether or not the condition was true,
3639 or the lookup or extraction succeeded. The substrings always have to be
3640 expanded, to check their syntax, but "skipping" is set when the result is not
3641 needed - this avoids unnecessary nested lookups.
3644 skipping TRUE if we were skipping when this item was reached
3645 yes TRUE if the first string is to be used, else use the second
3646 save_lookup a value to put back into lookup_value before the 2nd expansion
3647 sptr points to the input string pointer
3648 yieldptr points to the output growable-string pointer
3649 type "lookup", "if", "extract", "run", "env", "listextract" or
3650 "certextract" for error message
3651 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3654 Returns: 0 OK; lookup_value has been reset to save_lookup
3656 2 expansion failed because of bracketing error
3660 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3661 gstring ** yieldptr, uschar *type, BOOL *resetok)
3664 const uschar *s = *sptr; /* Local value */
3665 uschar *sub1, *sub2;
3666 const uschar * errwhere;
3668 /* If there are no following strings, we substitute the contents of $value for
3669 lookups and for extractions in the success case. For the ${if item, the string
3670 "true" is substituted. In the fail case, nothing is substituted for all three
3673 if (skip_whitespace(&s) == '}')
3677 if (yes && !skipping)
3678 *yieldptr = string_catn(*yieldptr, US"true", 4);
3682 if (yes && lookup_value && !skipping)
3683 *yieldptr = string_cat(*yieldptr, lookup_value);
3684 lookup_value = save_lookup;
3690 /* The first following string must be braced. */
3694 errwhere = US"'yes' part did not start with '{'";
3698 /* Expand the first substring. Forced failures are noticed only if we actually
3699 want this string. Set skipping in the call in the fail case (this will always
3700 be the case if we were already skipping). */
3702 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3703 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3704 f.expand_string_forcedfail = FALSE;
3707 errwhere = US"'yes' part did not end with '}'";
3711 /* If we want the first string, add it to the output */
3714 *yieldptr = string_cat(*yieldptr, sub1);
3716 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3717 $value to what it was at the start of the item, so that it has this value
3718 during the second string expansion. For the call from "if" or "run" to this
3719 function, save_lookup is set to lookup_value, so that this statement does
3722 lookup_value = save_lookup;
3724 /* There now follows either another substring, or "fail", or nothing. This
3725 time, forced failures are noticed only if we want the second string. We must
3726 set skipping in the nested call if we don't want this string, or if we were
3727 already skipping. */
3729 if (skip_whitespace(&s) == '{')
3731 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3732 if (sub2 == NULL && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3733 f.expand_string_forcedfail = FALSE;
3736 errwhere = US"'no' part did not start with '{'";
3740 /* If we want the second string, add it to the output */
3743 *yieldptr = string_cat(*yieldptr, sub2);
3746 /* If there is no second string, but the word "fail" is present when the use of
3747 the second string is wanted, set a flag indicating it was a forced failure
3748 rather than a syntactic error. Swallow the terminating } in case this is nested
3749 inside another lookup or if or extract. */
3754 /* deconst cast ok here as source is s anyway */
3755 s = US read_name(name, sizeof(name), s, US"_");
3756 if (Ustrcmp(name, "fail") == 0)
3758 if (!yes && !skipping)
3760 Uskip_whitespace(&s);
3763 errwhere = US"did not close with '}' after forcedfail";
3766 expand_string_message =
3767 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3768 f.expand_string_forcedfail = TRUE;
3774 expand_string_message =
3775 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3780 /* All we have to do now is to check on the final closing brace. */
3782 skip_whitespace(&s);
3785 errwhere = US"did not close with '}'";
3791 /* Update the input pointer value before returning */
3796 /* Get here if there is a bracketing failure */
3797 expand_string_message = string_sprintf(
3798 "curly-bracket problem in conditional yes/no parsing: %s\n"
3799 " remaining string is '%s'", errwhere, --s);
3804 /* Get here for other failures */
3812 /********************************************************
3813 * prvs: Get last three digits of days since Jan 1, 1970 *
3814 ********************************************************/
3816 /* This is needed to implement the "prvs" BATV reverse
3819 Argument: integer "days" offset to add or substract to
3820 or from the current number of days.
3822 Returns: pointer to string containing the last three
3823 digits of the number of days since Jan 1, 1970,
3824 modified by the offset argument, NULL if there
3825 was an error in the conversion.
3830 prvs_daystamp(int day_offset)
3832 uschar *days = store_get(32, FALSE); /* Need at least 24 for cases */
3833 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3834 (time(NULL) + day_offset*86400)/86400);
3835 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3840 /********************************************************
3841 * prvs: perform HMAC-SHA1 computation of prvs bits *
3842 ********************************************************/
3844 /* This is needed to implement the "prvs" BATV reverse
3848 address RFC2821 Address to use
3849 key The key to use (must be less than 64 characters
3851 key_num Single-digit key number to use. Defaults to
3854 Returns: pointer to string containing the first three
3855 bytes of the final hash in hex format, NULL if
3856 there was an error in the process.
3860 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3862 gstring * hash_source;
3865 uschar innerhash[20];
3866 uschar finalhash[20];
3867 uschar innerkey[64];
3868 uschar outerkey[64];
3869 uschar *finalhash_hex;
3874 if (Ustrlen(key) > 64)
3877 hash_source = string_catn(NULL, key_num, 1);
3878 hash_source = string_catn(hash_source, daystamp, 3);
3879 hash_source = string_cat(hash_source, address);
3880 (void) string_from_gstring(hash_source);
3883 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3885 memset(innerkey, 0x36, 64);
3886 memset(outerkey, 0x5c, 64);
3888 for (int i = 0; i < Ustrlen(key); i++)
3890 innerkey[i] ^= key[i];
3891 outerkey[i] ^= key[i];
3894 chash_start(HMAC_SHA1, &h);
3895 chash_mid(HMAC_SHA1, &h, innerkey);
3896 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3898 chash_start(HMAC_SHA1, &h);
3899 chash_mid(HMAC_SHA1, &h, outerkey);
3900 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3902 /* Hashing is deemed sufficient to de-taint any input data */
3904 p = finalhash_hex = store_get(40, FALSE);
3905 for (int i = 0; i < 3; i++)
3907 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3908 *p++ = hex_digits[finalhash[i] & 0x0f];
3912 return finalhash_hex;
3918 /*************************************************
3919 * Join a file onto the output string *
3920 *************************************************/
3922 /* This is used for readfile/readsock and after a run expansion.
3923 It joins the contents of a file onto the output string, globally replacing
3924 newlines with a given string (optionally).
3928 yield pointer to the expandable string struct
3929 eol newline replacement string, or NULL
3931 Returns: new pointer for expandable string, terminated if non-null
3935 cat_file(FILE *f, gstring *yield, uschar *eol)
3937 uschar buffer[1024];
3939 while (Ufgets(buffer, sizeof(buffer), f))
3941 int len = Ustrlen(buffer);
3942 if (eol && buffer[len-1] == '\n') len--;
3943 yield = string_catn(yield, buffer, len);
3944 if (eol && buffer[len])
3945 yield = string_cat(yield, eol);
3948 (void) string_from_gstring(yield);
3955 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
3958 uschar buffer[1024];
3960 /*XXX could we read direct into a pre-grown string? */
3962 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
3963 for (uschar * s = buffer; rc--; s++)
3964 yield = eol && *s == '\n'
3965 ? string_cat(yield, eol) : string_catn(yield, s, 1);
3967 /* We assume that all errors, and any returns of zero bytes,
3968 are actually EOF. */
3970 (void) string_from_gstring(yield);
3976 /*************************************************
3977 * Evaluate numeric expression *
3978 *************************************************/
3980 /* This is a set of mutually recursive functions that evaluate an arithmetic
3981 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3982 these functions that is called from elsewhere is eval_expr, whose interface is:
3985 sptr pointer to the pointer to the string - gets updated
3986 decimal TRUE if numbers are to be assumed decimal
3987 error pointer to where to put an error message - must be NULL on input
3988 endket TRUE if ')' must terminate - FALSE for external call
3990 Returns: on success: the value of the expression, with *error still NULL
3991 on failure: an undefined value, with *error = a message
3994 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3997 static int_eximarith_t
3998 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4001 int_eximarith_t x = eval_op_or(&s, decimal, error);
4006 *error = US"expecting closing parenthesis";
4008 while (isspace(*++s));
4010 *error = US"expecting operator";
4016 static int_eximarith_t
4017 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4023 if (isdigit((c = Uskip_whitespace(&s))))
4026 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4028 switch (tolower(*s))
4031 case 'k': n *= 1024; s++; break;
4032 case 'm': n *= 1024*1024; s++; break;
4033 case 'g': n *= 1024*1024*1024; s++; break;
4035 Uskip_whitespace(&s);
4040 n = eval_expr(&s, decimal, error, 1);
4044 *error = US"expecting number or opening parenthesis";
4052 static int_eximarith_t
4053 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4057 Uskip_whitespace(&s);
4058 if (*s == '+' || *s == '-' || *s == '~')
4061 x = eval_op_unary(&s, decimal, error);
4062 if (op == '-') x = -x;
4063 else if (op == '~') x = ~x;
4066 x = eval_number(&s, decimal, error);
4073 static int_eximarith_t
4074 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4077 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4080 while (*s == '*' || *s == '/' || *s == '%')
4083 int_eximarith_t y = eval_op_unary(&s, decimal, error);
4085 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4086 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4087 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4088 * -N*M is INT_MIN will yield INT_MIN.
4089 * Since we don't support floating point, this is somewhat simpler.
4090 * Ideally, we'd return an error, but since we overflow for all other
4091 * arithmetic, consistency suggests otherwise, but what's the correct value
4092 * to use? There is none.
4093 * The C standard guarantees overflow for unsigned arithmetic but signed
4094 * overflow invokes undefined behaviour; in practice, this is overflow
4095 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4096 * that long/longlong larger than int are available, or we could just work
4097 * with larger types. We should consider whether to guarantee 32bit eval
4098 * and 64-bit working variables, with errors returned. For now ...
4099 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4100 * can just let the other invalid results occur otherwise, as they have
4101 * until now. For this one case, we can coerce.
4103 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4106 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4107 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4117 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4133 static int_eximarith_t
4134 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4137 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4140 while (*s == '+' || *s == '-')
4143 int_eximarith_t y = eval_op_mult(&s, decimal, error);
4145 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4146 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4147 { /* over-conservative check */
4149 ? US"overflow in sum" : US"overflow in difference";
4152 if (op == '+') x += y; else x -= y;
4160 static int_eximarith_t
4161 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4164 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4167 while ((*s == '<' || *s == '>') && s[1] == s[0])
4172 y = eval_op_sum(&s, decimal, error);
4174 if (op == '<') x <<= y; else x >>= y;
4182 static int_eximarith_t
4183 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4186 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4193 y = eval_op_shift(&s, decimal, error);
4203 static int_eximarith_t
4204 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4207 int_eximarith_t x = eval_op_and(&s, decimal, error);
4214 y = eval_op_and(&s, decimal, error);
4224 static int_eximarith_t
4225 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4228 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4235 y = eval_op_xor(&s, decimal, error);
4246 /************************************************/
4247 /* Comparison operation for sort expansion. We need to avoid
4248 re-expanding the fields being compared, so need a custom routine.
4251 cond_type Comparison operator code
4252 leftarg, rightarg Arguments for comparison
4254 Return true iff (leftarg compare rightarg)
4258 sortsbefore(int cond_type, BOOL alpha_cond,
4259 const uschar * leftarg, const uschar * rightarg)
4261 int_eximarith_t l_num, r_num;
4265 l_num = expanded_string_integer(leftarg, FALSE);
4266 if (expand_string_message) return FALSE;
4267 r_num = expanded_string_integer(rightarg, FALSE);
4268 if (expand_string_message) return FALSE;
4272 case ECOND_NUM_G: return l_num > r_num;
4273 case ECOND_NUM_GE: return l_num >= r_num;
4274 case ECOND_NUM_L: return l_num < r_num;
4275 case ECOND_NUM_LE: return l_num <= r_num;
4282 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4283 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4284 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4285 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4286 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4287 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4288 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4289 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4292 return FALSE; /* should not happen */
4296 /*************************************************
4298 *************************************************/
4300 /* Returns either an unchanged string, or the expanded string in stacking pool
4301 store. Interpreted sequences are:
4303 \... normal escaping rules
4304 $name substitutes the variable
4306 ${op:string} operates on the expanded string value
4307 ${item{arg1}{arg2}...} expands the args and then does the business
4308 some literal args are not enclosed in {}
4310 There are now far too many operators and item types to make it worth listing
4311 them here in detail any more.
4313 We use an internal routine recursively to handle embedded substrings. The
4314 external function follows. The yield is NULL if the expansion failed, and there
4315 are two cases: if something collapsed syntactically, or if "fail" was given
4316 as the action on a lookup failure. These can be distinguished by looking at the
4317 variable expand_string_forcedfail, which is TRUE in the latter case.
4319 The skipping flag is set true when expanding a substring that isn't actually
4320 going to be used (after "if" or "lookup") and it prevents lookups from
4321 happening lower down.
4323 Store usage: At start, a store block of the length of the input plus 64
4324 is obtained. This is expanded as necessary by string_cat(), which might have to
4325 get a new block, or might be able to expand the original. At the end of the
4326 function we can release any store above that portion of the yield block that
4327 was actually used. In many cases this will be optimal.
4329 However: if the first item in the expansion is a variable name or header name,
4330 we reset the store before processing it; if the result is in fresh store, we
4331 use that without copying. This is helpful for expanding strings like
4332 $message_headers which can get very long.
4334 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4335 since resetting the store at the end of the expansion will free store that was
4336 allocated by the plugin code as well as the slop after the expanded string. So
4337 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4338 and, given the acl condition, ${if }. This is an unfortunate consequence of
4339 string expansion becoming too powerful.
4342 string the string to be expanded
4343 ket_ends true if expansion is to stop at }
4344 left if not NULL, a pointer to the first character after the
4345 expansion is placed here (typically used with ket_ends)
4346 skipping TRUE for recursive calls when the value isn't actually going
4347 to be used (to allow for optimisation)
4348 honour_dollar TRUE if $ is to be expanded,
4349 FALSE if it's just another character
4350 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4353 Returns: NULL if expansion fails:
4354 expand_string_forcedfail is set TRUE if failure was forced
4355 expand_string_message contains a textual error message
4356 a pointer to the expanded string on success
4360 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
4361 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
4363 rmark reset_point = store_mark();
4364 gstring * yield = string_get(Ustrlen(string) + 64);
4366 const uschar *s = string;
4367 uschar *save_expand_nstring[EXPAND_MAXN+1];
4368 int save_expand_nlength[EXPAND_MAXN+1];
4369 BOOL resetok = TRUE;
4374 debug_printf_indent("/%s: %s\n",
4375 skipping ? "---scanning" : "considering", string);
4377 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
4379 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4383 f.expand_string_forcedfail = FALSE;
4384 expand_string_message = US"";
4386 if (is_tainted(string))
4388 expand_string_message =
4389 string_sprintf("attempt to expand tainted string '%s'", s);
4390 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4399 /* \ escapes the next character, which must exist, or else
4400 the expansion fails. There's a special escape, \N, which causes
4401 copying of the subject verbatim up to the next \N. Otherwise,
4402 the escapes are the standard set. */
4408 expand_string_message = US"\\ at end of string";
4414 const uschar * t = s + 2;
4415 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
4416 yield = string_catn(yield, t, s - t);
4417 if (*s != 0) s += 2;
4423 ch[0] = string_interpret_escape(&s);
4425 yield = string_catn(yield, ch, 1);
4432 /* Anything other than $ is just copied verbatim, unless we are
4433 looking for a terminating } character. */
4436 if (ket_ends && *s == '}') break;
4438 if (*s != '$' || !honour_dollar)
4440 yield = string_catn(yield, s++, 1);
4444 /* No { after the $ - must be a plain name or a number for string
4445 match variable. There has to be a fudge for variables that are the
4446 names of header fields preceded by "$header_" because header field
4447 names can contain any printing characters except space and colon.
4448 For those that don't like typing this much, "$h_" is a synonym for
4449 "$header_". A non-existent header yields a NULL value; nothing is
4452 if (isalpha((*(++s))))
4459 s = read_name(name, sizeof(name), s, US"_");
4461 /* If this is the first thing to be expanded, release the pre-allocated
4465 g = store_get(sizeof(gstring), FALSE);
4466 else if (yield->ptr == 0)
4468 if (resetok) reset_point = store_reset(reset_point);
4470 reset_point = store_mark();
4471 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
4476 if ( ( *(t = name) == 'h'
4477 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4479 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4482 unsigned flags = *name == 'r' ? FH_WANT_RAW
4483 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4485 uschar * charset = *name == 'b' ? NULL : headers_charset;
4487 s = read_header_name(name, sizeof(name), s);
4488 value = find_header(name, &newsize, flags, charset);
4490 /* If we didn't find the header, and the header contains a closing brace
4491 character, this may be a user error where the terminating colon
4492 has been omitted. Set a flag to adjust the error message in this case.
4493 But there is no error here - nothing gets inserted. */
4497 if (Ustrchr(name, '}')) malformed_header = TRUE;
4504 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4506 expand_string_message =
4507 string_sprintf("unknown variable name \"%s\"", name);
4508 check_variable_error_message(name);
4512 /* If the data is known to be in a new buffer, newsize will be set to the
4513 size of that buffer. If this is the first thing in an expansion string,
4514 yield will be NULL; just point it at the new store instead of copying. Many
4515 expansion strings contain just one reference, so this is a useful
4516 optimization, especially for humungous headers. We need to use a gstring
4517 structure that is not allocated after that new-buffer, else a later store
4518 reset in the middle of the buffer will make it inaccessible. */
4520 len = Ustrlen(value);
4521 if (!yield && newsize != 0)
4524 yield->size = newsize;
4529 yield = string_catn(yield, value, len);
4537 s = read_cnumber(&n, s);
4538 if (n >= 0 && n <= expand_nmax)
4539 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4543 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4545 if (*s != '{') /*}*/
4547 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4551 /* After { there can be various things, but they all start with
4552 an initial word, except for a number for a string match variable. */
4554 if (isdigit((*(++s))))
4557 s = read_cnumber(&n, s); /*{*/
4560 expand_string_message = US"} expected after number";
4563 if (n >= 0 && n <= expand_nmax)
4564 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4570 expand_string_message = US"letter or digit expected after ${"; /*}*/
4574 /* Allow "-" in names to cater for substrings with negative
4575 arguments. Since we are checking for known names after { this is
4578 s = read_name(name, sizeof(name), s, US"_-");
4579 item_type = chop_match(name, item_table, nelem(item_table));
4583 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4584 If the ACL returns accept or reject we return content set by "message ="
4585 There is currently no limit on recursion; this would have us call
4586 acl_check_internal() directly and get a current level from somewhere.
4587 See also the acl expansion condition ECOND_ACL and the traditional
4588 acl modifier ACLC_ACL.
4589 Assume that the function has side-effects on the store that must be preserved.
4593 /* ${acl {name} {arg1}{arg2}...} */
4595 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4599 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, name,
4602 case 1: goto EXPAND_FAILED_CURLY;
4604 case 3: goto EXPAND_FAILED;
4606 if (skipping) continue;
4609 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4614 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4616 yield = string_cat(yield, user_msg);
4620 f.expand_string_forcedfail = TRUE;
4623 expand_string_message = string_sprintf("%s from acl \"%s\"",
4624 rc_names[rc], sub[0]);
4629 case EITEM_AUTHRESULTS:
4630 /* ${authresults {mysystemname}} */
4634 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4637 case 1: goto EXPAND_FAILED_CURLY;
4639 case 3: goto EXPAND_FAILED;
4642 yield = string_append(yield, 3,
4643 US"Authentication-Results: ", sub_arg[0], US"; none");
4646 yield = authres_local(yield, sub_arg[0]);
4647 yield = authres_iprev(yield);
4648 yield = authres_smtpauth(yield);
4650 yield = authres_spf(yield);
4652 #ifndef DISABLE_DKIM
4653 yield = authres_dkim(yield);
4655 #ifdef SUPPORT_DMARC
4656 yield = authres_dmarc(yield);
4658 #ifdef EXPERIMENTAL_ARC
4659 yield = authres_arc(yield);
4664 /* Handle conditionals - preserve the values of the numerical expansion
4665 variables in case they get changed by a regular expression match in the
4666 condition. If not, they retain their external settings. At the end
4667 of this "if" section, they get restored to their previous values. */
4672 const uschar *next_s;
4673 int save_expand_nmax =
4674 save_expand_strings(save_expand_nstring, save_expand_nlength);
4676 Uskip_whitespace(&s);
4677 if (!(next_s = eval_condition(s, &resetok, skipping ? NULL : &cond)))
4678 goto EXPAND_FAILED; /* message already set */
4683 debug_printf_indent("|--condition: %.*s\n", (int)(next_s - s), s);
4684 debug_printf_indent("|-----result: %s\n", cond ? "true" : "false");
4688 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4689 "condition: %.*s\n",
4690 (int)(next_s - s), s);
4691 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4692 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4694 cond ? "true" : "false");
4699 /* The handling of "yes" and "no" result strings is now in a separate
4700 function that is also used by ${lookup} and ${extract} and ${run}. */
4702 switch(process_yesno(
4703 skipping, /* were previously skipping */
4704 cond, /* success/failure indicator */
4705 lookup_value, /* value to reset for string2 */
4706 &s, /* input pointer */
4707 &yield, /* output pointer */
4708 US"if", /* condition type */
4711 case 1: goto EXPAND_FAILED; /* when all is well, the */
4712 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4715 /* Restore external setting of expansion variables for continuation
4718 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4719 save_expand_nlength);
4724 case EITEM_IMAPFOLDER:
4725 { /* ${imapfolder {name}{sep]{specials}} */
4729 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4732 case 1: goto EXPAND_FAILED_CURLY;
4734 case 3: goto EXPAND_FAILED;
4737 if (!sub_arg[1]) /* One argument */
4739 sub_arg[1] = US"/"; /* default separator */
4742 else if (Ustrlen(sub_arg[1]) != 1)
4744 expand_string_message =
4746 "IMAP folder separator must be one character, found \"%s\"",
4753 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4754 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4756 yield = string_cat(yield, encoded);
4762 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4763 expanding an internal string that isn't actually going to be used. All we
4764 need to do is check the syntax, so don't do a lookup at all. Preserve the
4765 values of the numerical expansion variables in case they get changed by a
4766 partial lookup. If not, they retain their external settings. At the end
4767 of this "lookup" section, they get restored to their previous values. */
4771 int stype, partial, affixlen, starflags;
4772 int expand_setup = 0;
4774 uschar *key, *filename;
4775 const uschar * affix, * opts;
4776 uschar *save_lookup_value = lookup_value;
4777 int save_expand_nmax =
4778 save_expand_strings(save_expand_nstring, save_expand_nlength);
4780 if ((expand_forbid & RDO_LOOKUP) != 0)
4782 expand_string_message = US"lookup expansions are not permitted";
4786 /* Get the key we are to look up for single-key+file style lookups.
4787 Otherwise set the key NULL pro-tem. */
4789 if (Uskip_whitespace(&s) == '{') /*}*/
4791 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4792 if (!key) goto EXPAND_FAILED; /*{{*/
4795 expand_string_message = US"missing '}' after lookup key";
4796 goto EXPAND_FAILED_CURLY;
4798 Uskip_whitespace(&s);
4802 /* Find out the type of database */
4806 expand_string_message = US"missing lookup type";
4810 /* The type is a string that may contain special characters of various
4811 kinds. Allow everything except space or { to appear; the actual content
4812 is checked by search_findtype_partial. */ /*}*/
4814 while (*s && *s != '{' && !isspace(*s)) /*}*/
4816 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4819 name[nameptr] = '\0';
4820 Uskip_whitespace(&s);
4822 /* Now check for the individual search type and any partial or default
4823 options. Only those types that are actually in the binary are valid. */
4825 if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4826 &starflags, &opts)) < 0)
4828 expand_string_message = search_error_message;
4832 /* Check that a key was provided for those lookup types that need it,
4833 and was not supplied for those that use the query style. */
4835 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4839 expand_string_message = string_sprintf("missing {key} for single-"
4840 "key \"%s\" lookup", name);
4848 expand_string_message = string_sprintf("a single key was given for "
4849 "lookup type \"%s\", which is not a single-key lookup type", name);
4854 /* Get the next string in brackets and expand it. It is the file name for
4855 single-key+file lookups, and the whole query otherwise. In the case of
4856 queries that also require a file name (e.g. sqlite), the file name comes
4861 expand_string_message = US"missing '{' for lookup file-or-query arg";
4862 goto EXPAND_FAILED_CURLY;
4864 if (!(filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
4868 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4869 goto EXPAND_FAILED_CURLY;
4871 Uskip_whitespace(&s);
4873 /* If this isn't a single-key+file lookup, re-arrange the variables
4874 to be appropriate for the search_ functions. For query-style lookups,
4875 there is just a "key", and no file name. For the special query-style +
4876 file types, the query (i.e. "key") starts with a file name. */
4880 Uskip_whitespace(&filename);
4883 if (mac_islookup(stype, lookup_querystyle))
4886 if (*filename == '/')
4888 while (*key && !isspace(*key)) key++;
4889 if (*key) *key++ = '\0';
4895 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4896 the entry was not found. Note that there is no search_close() function.
4897 Files are left open in case of re-use. At suitable places in higher logic,
4898 search_tidyup() is called to tidy all open files. This can save opening
4899 the same file several times. However, files may also get closed when
4900 others are opened, if too many are open at once. The rule is that a
4901 handle should not be used after a second search_open().
4903 Request that a partial search sets up $1 and maybe $2 by passing
4904 expand_setup containing zero. If its value changes, reset expand_nmax,
4905 since new variables will have been set. Note that at the end of this
4906 "lookup" section, the old numeric variables are restored. */
4909 lookup_value = NULL;
4912 void *handle = search_open(filename, stype, 0, NULL, NULL);
4915 expand_string_message = search_error_message;
4918 lookup_value = search_find(handle, filename, key, partial, affix,
4919 affixlen, starflags, &expand_setup, opts);
4920 if (f.search_find_defer)
4922 expand_string_message =
4923 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4924 string_printing2(key, SP_TAB), search_error_message);
4927 if (expand_setup > 0) expand_nmax = expand_setup;
4930 /* The handling of "yes" and "no" result strings is now in a separate
4931 function that is also used by ${if} and ${extract}. */
4933 switch(process_yesno(
4934 skipping, /* were previously skipping */
4935 lookup_value != NULL, /* success/failure indicator */
4936 save_lookup_value, /* value to reset for string2 */
4937 &s, /* input pointer */
4938 &yield, /* output pointer */
4939 US"lookup", /* condition type */
4942 case 1: goto EXPAND_FAILED; /* when all is well, the */
4943 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4946 /* Restore external setting of expansion variables for carrying on
4947 at this level, and continue. */
4949 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4950 save_expand_nlength);
4954 /* If Perl support is configured, handle calling embedded perl subroutines,
4955 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4956 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4957 arguments (defined below). */
4959 #define EXIM_PERL_MAX_ARGS 8
4963 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4964 "is not included in this binary";
4967 #else /* EXIM_PERL */
4969 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4972 if ((expand_forbid & RDO_PERL) != 0)
4974 expand_string_message = US"Perl calls are not permitted";
4978 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4981 case 1: goto EXPAND_FAILED_CURLY;
4983 case 3: goto EXPAND_FAILED;
4986 /* If skipping, we don't actually do anything */
4988 if (skipping) continue;
4990 /* Start the interpreter if necessary */
4992 if (!opt_perl_started)
4995 if (!opt_perl_startup)
4997 expand_string_message = US"A setting of perl_startup is needed when "
4998 "using the Perl interpreter";
5001 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5002 if ((initerror = init_perl(opt_perl_startup)))
5004 expand_string_message =
5005 string_sprintf("error in perl_startup code: %s\n", initerror);
5008 opt_perl_started = TRUE;
5011 /* Call the function */
5013 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5014 new_yield = call_perl_cat(yield, &expand_string_message,
5015 sub_arg[0], sub_arg + 1);
5017 /* NULL yield indicates failure; if the message pointer has been set to
5018 NULL, the yield was undef, indicating a forced failure. Otherwise the
5019 message will indicate some kind of Perl error. */
5023 if (!expand_string_message)
5025 expand_string_message =
5026 string_sprintf("Perl subroutine \"%s\" returned undef to force "
5027 "failure", sub_arg[0]);
5028 f.expand_string_forcedfail = TRUE;
5033 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5034 set during a callback from Perl. */
5036 f.expand_string_forcedfail = FALSE;
5040 #endif /* EXIM_PERL */
5042 /* Transform email address to "prvs" scheme to use
5043 as BATV-signed return path */
5050 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, name, &resetok))
5052 case 1: goto EXPAND_FAILED_CURLY;
5054 case 3: goto EXPAND_FAILED;
5057 /* If skipping, we don't actually do anything */
5058 if (skipping) continue;
5060 /* sub_arg[0] is the address */
5061 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
5062 || domain == sub_arg[0] || Ustrlen(domain) == 1)
5064 expand_string_message = US"prvs first argument must be a qualified email address";
5068 /* Calculate the hash. The third argument must be a single-digit
5069 key number, or unset. */
5072 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5074 expand_string_message = US"prvs third argument must be a single digit";
5078 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5081 expand_string_message = US"prvs hmac-sha1 conversion failed";
5085 /* Now separate the domain from the local part */
5088 yield = string_catn(yield, US"prvs=", 5);
5089 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5090 yield = string_catn(yield, prvs_daystamp(7), 3);
5091 yield = string_catn(yield, p, 6);
5092 yield = string_catn(yield, US"=", 1);
5093 yield = string_cat (yield, sub_arg[0]);
5094 yield = string_catn(yield, US"@", 1);
5095 yield = string_cat (yield, domain);
5100 /* Check a prvs-encoded address for validity */
5102 case EITEM_PRVSCHECK:
5109 /* TF: Ugliness: We want to expand parameter 1 first, then set
5110 up expansion variables that are used in the expansion of
5111 parameter 2. So we clone the string for the first
5112 expansion, where we only expand parameter 1.
5114 PH: Actually, that isn't necessary. The read_subs() function is
5115 designed to work this way for the ${if and ${lookup expansions. I've
5119 /* Reset expansion variables */
5120 prvscheck_result = NULL;
5121 prvscheck_address = NULL;
5122 prvscheck_keynum = NULL;
5124 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, name, &resetok))
5126 case 1: goto EXPAND_FAILED_CURLY;
5128 case 3: goto EXPAND_FAILED;
5131 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5134 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5136 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5137 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5138 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5139 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5140 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5142 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
5143 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
5144 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5145 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
5146 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
5148 /* Set up expansion variables */
5149 g = string_cat (NULL, local_part);
5150 g = string_catn(g, US"@", 1);
5151 g = string_cat (g, domain);
5152 prvscheck_address = string_from_gstring(g);
5153 prvscheck_keynum = string_copy(key_num);
5155 /* Now expand the second argument */
5156 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, name, &resetok))
5158 case 1: goto EXPAND_FAILED_CURLY;
5160 case 3: goto EXPAND_FAILED;
5163 /* Now we have the key and can check the address. */
5165 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5170 expand_string_message = US"hmac-sha1 conversion failed";
5174 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5175 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
5177 if (Ustrcmp(p,hash) == 0)
5179 /* Success, valid BATV address. Now check the expiry date. */
5180 uschar *now = prvs_daystamp(0);
5181 unsigned int inow = 0,iexpire = 1;
5183 (void)sscanf(CS now,"%u",&inow);
5184 (void)sscanf(CS daystamp,"%u",&iexpire);
5186 /* When "iexpire" is < 7, a "flip" has occurred.
5187 Adjust "inow" accordingly. */
5188 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5190 if (iexpire >= inow)
5192 prvscheck_result = US"1";
5193 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
5197 prvscheck_result = NULL;
5198 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
5203 prvscheck_result = NULL;
5204 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
5207 /* Now expand the final argument. We leave this till now so that
5208 it can include $prvscheck_result. */
5210 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, name, &resetok))
5212 case 1: goto EXPAND_FAILED_CURLY;
5214 case 3: goto EXPAND_FAILED;
5217 yield = string_cat(yield,
5218 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5220 /* Reset the "internal" variables afterwards, because they are in
5221 dynamic store that will be reclaimed if the expansion succeeded. */
5223 prvscheck_address = NULL;
5224 prvscheck_keynum = NULL;
5227 /* Does not look like a prvs encoded address, return the empty string.
5228 We need to make sure all subs are expanded first, so as to skip over
5231 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, name, &resetok))
5233 case 1: goto EXPAND_FAILED_CURLY;
5235 case 3: goto EXPAND_FAILED;
5241 /* Handle "readfile" to insert an entire file */
5243 case EITEM_READFILE:
5248 if ((expand_forbid & RDO_READFILE) != 0)
5250 expand_string_message = US"file insertions are not permitted";
5254 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, name, &resetok))
5256 case 1: goto EXPAND_FAILED_CURLY;
5258 case 3: goto EXPAND_FAILED;
5261 /* If skipping, we don't actually do anything */
5263 if (skipping) continue;
5265 /* Open the file and read it */
5267 if (!(f = Ufopen(sub_arg[0], "rb")))
5269 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
5273 yield = cat_file(f, yield, sub_arg[1]);
5278 /* Handle "readsocket" to insert data from a socket, either
5279 Inet or Unix domain */
5281 case EITEM_READSOCK:
5284 uschar * sub_arg[4];
5286 if (expand_forbid & RDO_READSOCK)
5288 expand_string_message = US"socket insertions are not permitted";
5292 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5293 because there may be a string for expansion on failure. */
5295 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, name, &resetok))
5297 case 1: goto EXPAND_FAILED_CURLY;
5298 case 2: /* Won't occur: no end check */
5299 case 3: goto EXPAND_FAILED;
5302 /* If skipping, we don't actually do anything. Otherwise, arrange to
5303 connect to either an IP or a Unix socket. */
5307 int stype = search_findtype(US"readsock", 8);
5310 int expand_setup = -1;
5313 /* If the reqstr is empty, flag that and set a dummy */
5317 g = string_append_listele(g, ',', US"send=no");
5318 sub_arg[1] = US"DUMMY";
5321 /* Re-marshall the options */
5325 const uschar * list = sub_arg[2];
5329 /* First option has no tag and is timeout */
5330 if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5331 g = string_append_listele(g, ',',
5332 string_sprintf("timeout=%s", item));
5334 /* The rest of the options from the expansion */
5335 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5336 g = string_append_listele(g, ',', item);
5338 /* possibly plus an EOL string. Process with escapes, to protect
5339 from list-processing. The only current user of eol= in search
5340 options is the readsock expansion. */
5342 if (sub_arg[3] && *sub_arg[3])
5343 g = string_append_listele(g, ',',
5344 string_sprintf("eol=%s",
5345 string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5348 /* Gat a (possibly cached) handle for the connection */
5350 if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5352 if (*expand_string_message) goto EXPAND_FAILED;
5353 expand_string_message = search_error_message;
5354 search_error_message = NULL;
5358 /* Get (possibly cached) results for the lookup */
5359 /* sspec: sub_arg[0] req: sub_arg[1] opts: g */
5361 if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5362 &expand_setup, string_from_gstring(g))))
5363 yield = string_cat(yield, s);
5364 else if (f.search_find_defer)
5366 expand_string_message = search_error_message;
5367 search_error_message = NULL;
5371 { /* should not happen, at present */
5372 expand_string_message = search_error_message;
5373 search_error_message = NULL;
5378 /* The whole thing has worked (or we were skipping). If there is a
5379 failure string following, we need to skip it. */
5383 if (!expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok))
5387 expand_string_message = US"missing '}' closing failstring for readsocket";
5388 goto EXPAND_FAILED_CURLY;
5390 Uskip_whitespace(&s);
5396 expand_string_message = US"missing '}' closing readsocket";
5397 goto EXPAND_FAILED_CURLY;
5401 /* Come here on failure to create socket, connect socket, write to the
5402 socket, or timeout on reading. If another substring follows, expand and
5403 use it. Otherwise, those conditions give expand errors. */
5406 if (*s != '{') goto EXPAND_FAILED;
5407 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5408 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5410 yield = string_cat(yield, arg);
5413 expand_string_message = US"missing '}' closing failstring for readsocket";
5414 goto EXPAND_FAILED_CURLY;
5416 Uskip_whitespace(&s);
5420 /* Handle "run" to execute a program. */
5426 const uschar **argv;
5430 if ((expand_forbid & RDO_RUN) != 0)
5432 expand_string_message = US"running a command is not permitted";
5436 Uskip_whitespace(&s);
5439 expand_string_message = US"missing '{' for command arg of run";
5440 goto EXPAND_FAILED_CURLY;
5442 if (!(arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
5444 Uskip_whitespace(&s);
5447 expand_string_message = US"missing '}' closing command arg of run";
5448 goto EXPAND_FAILED_CURLY;
5451 if (skipping) /* Just pretend it worked when we're skipping */
5454 lookup_value = NULL;
5458 if (!transport_set_up_command(&argv, /* anchor for arg list */
5459 arg, /* raw command */
5460 FALSE, /* don't expand the arguments */
5461 0, /* not relevant when... */
5462 NULL, /* no transporting address */
5463 US"${run} expansion", /* for error messages */
5464 &expand_string_message)) /* where to put error message */
5467 /* Create the child process, making it a group leader. */
5469 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5470 US"expand-run")) < 0)
5472 expand_string_message =
5473 string_sprintf("couldn't create child process: %s", strerror(errno));
5477 /* Nothing is written to the standard input. */
5481 /* Read the pipe to get the command's output into $value (which is kept
5482 in lookup_value). Read during execution, so that if the output exceeds
5483 the OS pipe buffer limit, we don't block forever. Remember to not release
5484 memory just allocated for $value. */
5487 f = fdopen(fd_out, "rb");
5488 sigalrm_seen = FALSE;
5490 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5494 /* Wait for the process to finish, applying the timeout, and inspect its
5495 return code for serious disasters. Simple non-zero returns are passed on.
5498 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5500 if (sigalrm_seen || runrc == -256)
5502 expand_string_message = US"command timed out";
5503 killpg(pid, SIGKILL); /* Kill the whole process group */
5506 else if (runrc == -257)
5507 expand_string_message = string_sprintf("wait() failed: %s",
5511 expand_string_message = string_sprintf("command killed by signal %d",
5518 /* Process the yes/no strings; $value may be useful in both cases */
5520 switch(process_yesno(
5521 skipping, /* were previously skipping */
5522 runrc == 0, /* success/failure indicator */
5523 lookup_value, /* value to reset for string2 */
5524 &s, /* input pointer */
5525 &yield, /* output pointer */
5526 US"run", /* condition type */
5529 case 1: goto EXPAND_FAILED; /* when all is well, the */
5530 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5536 /* Handle character translation for "tr" */
5540 int oldptr = gstring_length(yield);
5544 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5546 case 1: goto EXPAND_FAILED_CURLY;
5548 case 3: goto EXPAND_FAILED;
5551 yield = string_cat(yield, sub[0]);
5552 o2m = Ustrlen(sub[2]) - 1;
5554 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5556 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5560 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5567 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5568 expanded arguments. */
5577 int val[2] = { 0, -1 };
5580 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5581 Ensure that sub[2] is set in the ${length } case. */
5584 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5585 TRUE, name, &resetok))
5587 case 1: goto EXPAND_FAILED_CURLY;
5589 case 3: goto EXPAND_FAILED;
5592 /* Juggle the arguments if there are only two of them: always move the
5593 string to the last position and make ${length{n}{str}} equivalent to
5594 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5600 if (item_type == EITEM_LENGTH)
5607 for (int i = 0; i < 2; i++) if (sub[i])
5609 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5610 if (*ret != 0 || (i != 0 && val[i] < 0))
5612 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5613 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5619 item_type == EITEM_HASH
5620 ? compute_hash(sub[2], val[0], val[1], &len)
5621 : item_type == EITEM_NHASH
5622 ? compute_nhash(sub[2], val[0], val[1], &len)
5623 : extract_substr(sub[2], val[0], val[1], &len);
5626 yield = string_catn(yield, ret, len);
5630 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5631 This code originally contributed by Steve Haslam. It currently supports
5632 the use of MD5 and SHA-1 hashes.
5634 We need some workspace that is large enough to handle all the supported
5635 hash types. Use macros to set the sizes rather than be too elaborate. */
5637 #define MAX_HASHLEN 20
5638 #define MAX_HASHBLOCKLEN 64
5647 int hashlen; /* Number of octets for the hash algorithm's output */
5648 int hashblocklen; /* Number of octets the hash algorithm processes */
5650 unsigned int keylen;
5652 uschar keyhash[MAX_HASHLEN];
5653 uschar innerhash[MAX_HASHLEN];
5654 uschar finalhash[MAX_HASHLEN];
5655 uschar finalhash_hex[2*MAX_HASHLEN];
5656 uschar innerkey[MAX_HASHBLOCKLEN];
5657 uschar outerkey[MAX_HASHBLOCKLEN];
5659 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5661 case 1: goto EXPAND_FAILED_CURLY;
5663 case 3: goto EXPAND_FAILED;
5668 if (Ustrcmp(sub[0], "md5") == 0)
5671 use_base = &md5_base;
5675 else if (Ustrcmp(sub[0], "sha1") == 0)
5678 use_base = &sha1_ctx;
5684 expand_string_message =
5685 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5690 keylen = Ustrlen(keyptr);
5692 /* If the key is longer than the hash block length, then hash the key
5695 if (keylen > hashblocklen)
5697 chash_start(type, use_base);
5698 chash_end(type, use_base, keyptr, keylen, keyhash);
5703 /* Now make the inner and outer key values */
5705 memset(innerkey, 0x36, hashblocklen);
5706 memset(outerkey, 0x5c, hashblocklen);
5708 for (int i = 0; i < keylen; i++)
5710 innerkey[i] ^= keyptr[i];
5711 outerkey[i] ^= keyptr[i];
5714 /* Now do the hashes */
5716 chash_start(type, use_base);
5717 chash_mid(type, use_base, innerkey);
5718 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5720 chash_start(type, use_base);
5721 chash_mid(type, use_base, outerkey);
5722 chash_end(type, use_base, innerhash, hashlen, finalhash);
5724 /* Encode the final hash as a hex string */
5727 for (int i = 0; i < hashlen; i++)
5729 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5730 *p++ = hex_digits[finalhash[i] & 0x0f];
5733 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5734 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5736 yield = string_catn(yield, finalhash_hex, hashlen*2);
5741 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5742 We have to save the numerical variables and restore them afterwards. */
5747 int moffset, moffsetextra, slen;
5750 const uschar *rerror;
5753 int save_expand_nmax =
5754 save_expand_strings(save_expand_nstring, save_expand_nlength);
5756 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5758 case 1: goto EXPAND_FAILED_CURLY;
5760 case 3: goto EXPAND_FAILED;
5763 /* Compile the regular expression */
5765 if (!(re = pcre_compile(CS sub[1], PCRE_COPT, CCSS &rerror,
5768 expand_string_message = string_sprintf("regular expression error in "
5769 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5773 /* Now run a loop to do the substitutions as often as necessary. It ends
5774 when there are no more matches. Take care over matches of the null string;
5775 do the same thing as Perl does. */
5778 slen = Ustrlen(sub[0]);
5779 moffset = moffsetextra = 0;
5784 int ovector[3*(EXPAND_MAXN+1)];
5785 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5786 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5789 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5790 is not necessarily the end. We want to repeat the match from one
5791 character further along, but leaving the basic offset the same (for
5792 copying below). We can't be at the end of the string - that was checked
5793 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5794 finished; copy the remaining string and end the loop. */
5804 yield = string_catn(yield, subject+moffset, slen-moffset);
5808 /* Match - set up for expanding the replacement. */
5810 if (n == 0) n = EXPAND_MAXN + 1;
5812 for (int nn = 0; nn < n*2; nn += 2)
5814 expand_nstring[expand_nmax] = subject + ovector[nn];
5815 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5819 /* Copy the characters before the match, plus the expanded insertion. */
5821 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
5822 if (!(insert = expand_string(sub[2])))
5824 yield = string_cat(yield, insert);
5826 moffset = ovector[1];
5830 /* If we have matched an empty string, first check to see if we are at
5831 the end of the subject. If so, the loop is over. Otherwise, mimic
5832 what Perl's /g options does. This turns out to be rather cunning. First
5833 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5834 string at the same point. If this fails (picked up above) we advance to
5835 the next character. */
5837 if (ovector[0] == ovector[1])
5839 if (ovector[0] == slen) break;
5840 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5844 /* All done - restore numerical variables. */
5846 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5847 save_expand_nlength);
5851 /* Handle keyed and numbered substring extraction. If the first argument
5852 consists entirely of digits, then a numerical extraction is assumed. */
5856 int field_number = 1;
5857 BOOL field_number_set = FALSE;
5858 uschar *save_lookup_value = lookup_value;
5860 int save_expand_nmax =
5861 save_expand_strings(save_expand_nstring, save_expand_nlength);
5863 /* On reflection the original behaviour of extract-json for a string
5864 result, leaving it quoted, was a mistake. But it was already published,
5865 hence the addition of jsons. In a future major version, make json
5866 work like josons, and withdraw jsons. */
5868 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
5870 /* Check for a format-variant specifier */
5872 if (Uskip_whitespace(&s) != '{') /*}*/
5873 if (Ustrncmp(s, "json", 4) == 0)
5874 if (*(s += 4) == 's')
5875 {fmt = extract_jsons; s++;}
5879 /* While skipping we cannot rely on the data for expansions being
5880 available (eg. $item) hence cannot decide on numeric vs. keyed.
5881 Read a maximum of 5 arguments (including the yes/no) */
5885 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
5887 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5888 goto EXPAND_FAILED; /*'{'*/
5891 expand_string_message = US"missing '{' for arg of extract";
5892 goto EXPAND_FAILED_CURLY;
5894 Uskip_whitespace(&s);
5896 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
5897 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5901 Uskip_whitespace(&s);
5905 expand_string_message = US"missing '}' closing extract";
5906 goto EXPAND_FAILED_CURLY;
5910 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5912 if (Uskip_whitespace(&s) == '{') /*'}'*/
5914 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
5915 goto EXPAND_FAILED; /*'{'*/
5918 expand_string_message = string_sprintf(
5919 "missing '}' closing arg %d of extract", i+1);
5920 goto EXPAND_FAILED_CURLY;
5923 /* After removal of leading and trailing white space, the first
5924 argument must not be empty; if it consists entirely of digits
5925 (optionally preceded by a minus sign), this is a numerical
5926 extraction, and we expect 3 arguments (normal) or 2 (json). */
5934 Uskip_whitespace(&p);
5938 while (len > 0 && isspace(p[len-1])) len--;
5943 expand_string_message = US"first argument of \"extract\" must "
5953 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5957 if (fmt == extract_basic) j = 3; /* Need 3 args */
5958 field_number_set = TRUE;
5964 expand_string_message = string_sprintf(
5965 "missing '{' for arg %d of extract", i+1);
5966 goto EXPAND_FAILED_CURLY;
5970 /* Extract either the numbered or the keyed substring into $value. If
5971 skipping, just pretend the extraction failed. */
5974 lookup_value = NULL;
5978 lookup_value = field_number_set
5979 ? expand_gettokened(field_number, sub[1], sub[2])
5980 : expand_getkeyed(sub[0], sub[1]);
5987 const uschar * list;
5989 /* Array: Bracket-enclosed and comma-separated.
5990 Object: Brace-enclosed, comma-sep list of name:value pairs */
5992 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
5994 expand_string_message =
5995 string_sprintf("%s wrapping %s for extract json",
5996 expand_string_message,
5997 field_number_set ? "array" : "object");
5998 goto EXPAND_FAILED_CURLY;
6002 if (field_number_set)
6004 if (field_number <= 0)
6006 expand_string_message = US"first argument of \"extract\" must "
6007 "be greater than zero";
6010 while (field_number > 0 && (item = json_nextinlist(&list)))
6012 if ((lookup_value = s = item))
6015 while (--s >= lookup_value && isspace(*s)) *s = '\0';
6020 lookup_value = NULL;
6021 while ((item = json_nextinlist(&list)))
6023 /* Item is: string name-sep value. string is quoted.
6024 Dequote the string and compare with the search key. */
6026 if (!(item = dewrap(item, US"\"\"")))
6028 expand_string_message =
6029 string_sprintf("%s wrapping string key for extract json",
6030 expand_string_message);
6031 goto EXPAND_FAILED_CURLY;
6033 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
6035 s = item + Ustrlen(item) + 1;
6036 if (Uskip_whitespace(&s) != ':')
6038 expand_string_message =
6039 US"missing object value-separator for extract json";
6040 goto EXPAND_FAILED_CURLY;
6043 Uskip_whitespace(&s);
6051 if ( fmt == extract_jsons
6053 && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6055 expand_string_message =
6056 string_sprintf("%s wrapping string result for extract jsons",
6057 expand_string_message);
6058 goto EXPAND_FAILED_CURLY;
6063 /* If no string follows, $value gets substituted; otherwise there can
6064 be yes/no strings, as for lookup or if. */
6066 switch(process_yesno(
6067 skipping, /* were previously skipping */
6068 lookup_value != NULL, /* success/failure indicator */
6069 save_lookup_value, /* value to reset for string2 */
6070 &s, /* input pointer */
6071 &yield, /* output pointer */
6072 US"extract", /* condition type */
6075 case 1: goto EXPAND_FAILED; /* when all is well, the */
6076 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6079 /* All done - restore numerical variables. */
6081 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6082 save_expand_nlength);
6087 /* return the Nth item from a list */
6089 case EITEM_LISTEXTRACT:
6091 int field_number = 1;
6092 uschar *save_lookup_value = lookup_value;
6094 int save_expand_nmax =
6095 save_expand_strings(save_expand_nstring, save_expand_nlength);
6097 /* Read the field & list arguments */
6099 for (int i = 0; i < 2; i++)
6101 if (Uskip_whitespace(&s) != '{') /*'}'*/
6103 expand_string_message = string_sprintf(
6104 "missing '{' for arg %d of listextract", i+1);
6105 goto EXPAND_FAILED_CURLY;
6108 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6109 if (!sub[i]) goto EXPAND_FAILED; /*{*/
6112 expand_string_message = string_sprintf(
6113 "missing '}' closing arg %d of listextract", i+1);
6114 goto EXPAND_FAILED_CURLY;
6117 /* After removal of leading and trailing white space, the first
6118 argument must be numeric and nonempty. */
6126 Uskip_whitespace(&p);
6130 while (len > 0 && isspace(p[len-1])) len--;
6133 if (!*p && !skipping)
6135 expand_string_message = US"first argument of \"listextract\" must "
6145 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6148 expand_string_message = US"first argument of \"listextract\" must "
6156 /* Extract the numbered element into $value. If
6157 skipping, just pretend the extraction failed. */
6159 lookup_value = skipping ? NULL : expand_getlistele(field_number, sub[1]);
6161 /* If no string follows, $value gets substituted; otherwise there can
6162 be yes/no strings, as for lookup or if. */
6164 switch(process_yesno(
6165 skipping, /* were previously skipping */
6166 lookup_value != NULL, /* success/failure indicator */
6167 save_lookup_value, /* value to reset for string2 */
6168 &s, /* input pointer */
6169 &yield, /* output pointer */
6170 US"listextract", /* condition type */
6173 case 1: goto EXPAND_FAILED; /* when all is well, the */
6174 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6177 /* All done - restore numerical variables. */
6179 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6180 save_expand_nlength);
6185 case EITEM_LISTQUOTE:
6188 switch(read_subs(sub, 2, 2, &s, skipping, TRUE, name, &resetok))
6190 case 1: goto EXPAND_FAILED_CURLY;
6192 case 3: goto EXPAND_FAILED;
6194 if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6196 if (c == sep) yield = string_catn(yield, sub[1], 1);
6197 yield = string_catn(yield, sub[1], 1);
6199 else yield = string_catn(yield, US" ", 1);
6204 case EITEM_CERTEXTRACT:
6206 uschar *save_lookup_value = lookup_value;
6208 int save_expand_nmax =
6209 save_expand_strings(save_expand_nstring, save_expand_nlength);
6211 /* Read the field argument */
6212 if (Uskip_whitespace(&s) != '{') /*}*/
6214 expand_string_message = US"missing '{' for field arg of certextract";
6215 goto EXPAND_FAILED_CURLY;
6217 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6218 if (!sub[0]) goto EXPAND_FAILED; /*{*/
6221 expand_string_message = US"missing '}' closing field arg of certextract";
6222 goto EXPAND_FAILED_CURLY;
6224 /* strip spaces fore & aft */
6229 Uskip_whitespace(&p);
6233 while (len > 0 && isspace(p[len-1])) len--;
6237 /* inspect the cert argument */
6238 if (Uskip_whitespace(&s) != '{') /*}*/
6240 expand_string_message = US"missing '{' for cert variable arg of certextract";
6241 goto EXPAND_FAILED_CURLY;
6245 expand_string_message = US"second argument of \"certextract\" must "
6246 "be a certificate variable";
6249 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
6250 if (!sub[1]) goto EXPAND_FAILED; /*{*/
6253 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6254 goto EXPAND_FAILED_CURLY;
6258 lookup_value = NULL;
6261 lookup_value = expand_getcertele(sub[0], sub[1]);
6262 if (*expand_string_message) goto EXPAND_FAILED;
6264 switch(process_yesno(
6265 skipping, /* were previously skipping */
6266 lookup_value != NULL, /* success/failure indicator */
6267 save_lookup_value, /* value to reset for string2 */
6268 &s, /* input pointer */
6269 &yield, /* output pointer */
6270 US"certextract", /* condition type */
6273 case 1: goto EXPAND_FAILED; /* when all is well, the */
6274 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6277 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6278 save_expand_nlength);
6281 #endif /*DISABLE_TLS*/
6283 /* Handle list operations */
6290 int save_ptr = gstring_length(yield);
6291 uschar outsep[2] = { '\0', '\0' };
6292 const uschar *list, *expr, *temp;
6293 uschar *save_iterate_item = iterate_item;
6294 uschar *save_lookup_value = lookup_value;
6296 Uskip_whitespace(&s);
6299 expand_string_message =
6300 string_sprintf("missing '{' for first arg of %s", name);
6301 goto EXPAND_FAILED_CURLY;
6304 if (!(list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok)))
6308 expand_string_message =
6309 string_sprintf("missing '}' closing first arg of %s", name);
6310 goto EXPAND_FAILED_CURLY;
6313 if (item_type == EITEM_REDUCE)
6316 Uskip_whitespace(&s);
6319 expand_string_message = US"missing '{' for second arg of reduce";
6320 goto EXPAND_FAILED_CURLY;
6322 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6323 if (!t) goto EXPAND_FAILED;
6327 expand_string_message = US"missing '}' closing second arg of reduce";
6328 goto EXPAND_FAILED_CURLY;
6332 Uskip_whitespace(&s);
6335 expand_string_message =
6336 string_sprintf("missing '{' for last arg of %s", name);
6337 goto EXPAND_FAILED_CURLY;
6342 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6343 if scanning a "false" part). This allows us to find the end of the
6344 condition, because if the list is empty, we won't actually evaluate the
6345 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6346 the normal internal expansion function. */
6348 if (item_type == EITEM_FILTER)
6350 if ((temp = eval_condition(expr, &resetok, NULL)))
6354 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6358 expand_string_message = string_sprintf("%s inside \"%s\" item",
6359 expand_string_message, name);
6363 Uskip_whitespace(&s);
6366 expand_string_message = string_sprintf("missing } at end of condition "
6367 "or expression inside \"%s\"; could be an unquoted } in the content",
6372 Uskip_whitespace(&s); /*{*/
6375 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6380 /* If we are skipping, we can now just move on to the next item. When
6381 processing for real, we perform the iteration. */
6383 if (skipping) continue;
6384 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6386 *outsep = (uschar)sep; /* Separator as a string */
6388 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6389 name, iterate_item, lookup_value);
6391 if (item_type == EITEM_FILTER)
6394 if (!eval_condition(expr, &resetok, &condresult))
6396 iterate_item = save_iterate_item;
6397 lookup_value = save_lookup_value;
6398 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6399 expand_string_message, name);
6402 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6403 condresult? "true":"false");
6405 temp = iterate_item; /* TRUE => include this item */
6407 continue; /* FALSE => skip this item */
6410 /* EITEM_MAP and EITEM_REDUCE */
6414 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
6418 iterate_item = save_iterate_item;
6419 expand_string_message = string_sprintf("%s inside \"%s\" item",
6420 expand_string_message, name);
6423 if (item_type == EITEM_REDUCE)
6425 lookup_value = t; /* Update the value of $value */
6426 continue; /* and continue the iteration */
6430 /* We reach here for FILTER if the condition is true, always for MAP,
6431 and never for REDUCE. The value in "temp" is to be added to the output
6432 list that is being created, ensuring that any occurrences of the
6433 separator character are doubled. Unless we are dealing with the first
6434 item of the output list, add in a space if the new item begins with the
6435 separator character, or is an empty string. */
6437 if ( yield && yield->ptr != save_ptr
6438 && (temp[0] == *outsep || temp[0] == 0))
6439 yield = string_catn(yield, US" ", 1);
6441 /* Add the string in "temp" to the output list that we are building,
6442 This is done in chunks by searching for the separator character. */
6446 size_t seglen = Ustrcspn(temp, outsep);
6448 yield = string_catn(yield, temp, seglen + 1);
6450 /* If we got to the end of the string we output one character
6451 too many; backup and end the loop. Otherwise arrange to double the
6454 if (temp[seglen] == '\0') { yield->ptr--; break; }
6455 yield = string_catn(yield, outsep, 1);
6459 /* Output a separator after the string: we will remove the redundant
6460 final one at the end. */
6462 yield = string_catn(yield, outsep, 1);
6463 } /* End of iteration over the list loop */
6465 /* REDUCE has generated no output above: output the final value of
6468 if (item_type == EITEM_REDUCE)
6470 yield = string_cat(yield, lookup_value);
6471 lookup_value = save_lookup_value; /* Restore $value */
6474 /* FILTER and MAP generate lists: if they have generated anything, remove
6475 the redundant final separator. Even though an empty item at the end of a
6476 list does not count, this is tidier. */
6478 else if (yield && yield->ptr != save_ptr) yield->ptr--;
6480 /* Restore preserved $item */
6482 iterate_item = save_iterate_item;
6490 const uschar *srclist, *cmp, *xtract;
6491 uschar * opname, * srcitem;
6492 const uschar *dstlist = NULL, *dstkeylist = NULL;
6494 uschar *save_iterate_item = iterate_item;
6496 Uskip_whitespace(&s);
6499 expand_string_message = US"missing '{' for list arg of sort";
6500 goto EXPAND_FAILED_CURLY;
6503 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6504 if (!srclist) goto EXPAND_FAILED;
6507 expand_string_message = US"missing '}' closing list arg of sort";
6508 goto EXPAND_FAILED_CURLY;
6511 Uskip_whitespace(&s);
6514 expand_string_message = US"missing '{' for comparator arg of sort";
6515 goto EXPAND_FAILED_CURLY;
6518 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6519 if (!cmp) goto EXPAND_FAILED;
6522 expand_string_message = US"missing '}' closing comparator arg of sort";
6523 goto EXPAND_FAILED_CURLY;
6526 if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6528 if (!expand_string_message)
6529 expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6534 case ECOND_NUM_L: case ECOND_NUM_LE:
6535 case ECOND_NUM_G: case ECOND_NUM_GE:
6536 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6537 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6541 expand_string_message = US"comparator not handled for sort";
6545 Uskip_whitespace(&s);
6548 expand_string_message = US"missing '{' for extractor arg of sort";
6549 goto EXPAND_FAILED_CURLY;
6553 if (!(tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok)))
6555 xtract = string_copyn(xtract, s - xtract);
6559 expand_string_message = US"missing '}' closing extractor arg of sort";
6560 goto EXPAND_FAILED_CURLY;
6565 expand_string_message = US"missing } at end of \"sort\"";
6569 if (skipping) continue;
6571 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6573 uschar * srcfield, * dstitem;
6574 gstring * newlist = NULL;
6575 gstring * newkeylist = NULL;
6577 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6579 /* extract field for comparisons */
6580 iterate_item = srcitem;
6581 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6585 expand_string_message = string_sprintf(
6586 "field-extract in sort: \"%s\"", xtract);
6590 /* Insertion sort */
6592 /* copy output list until new-item < list-item */
6593 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6597 /* field for comparison */
6598 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6601 /* String-comparator names start with a letter; numeric names do not */
6603 if (sortsbefore(cond_type, isalpha(opname[0]),
6604 srcfield, dstfield))
6606 /* New-item sorts before this dst-item. Append new-item,
6607 then dst-item, then remainder of dst list. */
6609 newlist = string_append_listele(newlist, sep, srcitem);
6610 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6613 newlist = string_append_listele(newlist, sep, dstitem);
6614 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6616 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */
6617 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6619 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6621 newlist = string_append_listele(newlist, sep, dstitem);
6622 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6628 newlist = string_append_listele(newlist, sep, dstitem);
6629 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6632 /* If we ran out of dstlist without consuming srcitem, append it */
6635 newlist = string_append_listele(newlist, sep, srcitem);
6636 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6639 dstlist = newlist->s;
6640 dstkeylist = newkeylist->s;
6642 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6643 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6647 yield = string_cat(yield, dstlist);
6649 /* Restore preserved $item */
6650 iterate_item = save_iterate_item;
6654 expand_string_message = US"Internal error in sort (list mismatch)";
6659 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6660 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6661 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6662 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6664 #define EXPAND_DLFUNC_MAX_ARGS 8
6667 #ifndef EXPAND_DLFUNC
6668 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6669 "is not included in this binary";
6672 #else /* EXPAND_DLFUNC */
6675 exim_dlfunc_t *func;
6678 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6680 if ((expand_forbid & RDO_DLFUNC) != 0)
6682 expand_string_message =
6683 US"dynamically-loaded functions are not permitted";
6687 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6688 TRUE, name, &resetok))
6690 case 1: goto EXPAND_FAILED_CURLY;
6692 case 3: goto EXPAND_FAILED;
6695 /* If skipping, we don't actually do anything */
6697 if (skipping) continue;
6699 /* Look up the dynamically loaded object handle in the tree. If it isn't
6700 found, dlopen() the file and put the handle in the tree for next time. */
6702 if (!(t = tree_search(dlobj_anchor, argv[0])))
6704 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6707 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6708 argv[0], dlerror());
6709 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6712 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), is_tainted(argv[0]));
6713 Ustrcpy(t->name, argv[0]);
6714 t->data.ptr = handle;
6715 (void)tree_insertnode(&dlobj_anchor, t);
6718 /* Having obtained the dynamically loaded object handle, look up the
6719 function pointer. */
6721 if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6723 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6724 "%s", argv[1], argv[0], dlerror());
6725 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6729 /* Call the function and work out what to do with the result. If it
6730 returns OK, we have a replacement string; if it returns DEFER then
6731 expansion has failed in a non-forced manner; if it returns FAIL then
6732 failure was forced; if it returns ERROR or any other value there's a
6733 problem, so panic slightly. In any case, assume that the function has
6734 side-effects on the store that must be preserved. */
6738 for (argc = 0; argv[argc]; argc++);
6739 status = func(&result, argc - 2, &argv[2]);
6742 if (!result) result = US"";
6743 yield = string_cat(yield, result);
6748 expand_string_message = result ? result : US"(no message)";
6749 if (status == FAIL_FORCED)
6750 f.expand_string_forcedfail = TRUE;
6751 else if (status != FAIL)
6752 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6753 argv[0], argv[1], status, expand_string_message);
6757 #endif /* EXPAND_DLFUNC */
6759 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6762 uschar *save_lookup_value = lookup_value;
6764 if (Uskip_whitespace(&s) != '{') /*}*/
6767 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6768 if (!key) goto EXPAND_FAILED; /*{*/
6771 expand_string_message = US"missing '{' for name arg of env";
6772 goto EXPAND_FAILED_CURLY;
6775 lookup_value = US getenv(CS key);
6777 switch(process_yesno(
6778 skipping, /* were previously skipping */
6779 lookup_value != NULL, /* success/failure indicator */
6780 save_lookup_value, /* value to reset for string2 */
6781 &s, /* input pointer */
6782 &yield, /* output pointer */
6783 US"env", /* condition type */
6786 case 1: goto EXPAND_FAILED; /* when all is well, the */
6787 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6792 #ifdef EXPERIMENTAL_SRS_NATIVE
6793 case EITEM_SRS_ENCODE:
6794 /* ${srs_encode {secret} {return_path} {orig_domain}} */
6799 switch (read_subs(sub, 3, 3, CUSS &s, skipping, TRUE, name, &resetok))
6801 case 1: goto EXPAND_FAILED_CURLY;
6803 case 3: goto EXPAND_FAILED;
6806 yield = string_catn(yield, US"SRS0=", 5);
6808 /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
6809 hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
6810 yield = string_catn(yield, cksum, sizeof(cksum));
6811 yield = string_catn(yield, US"=", 1);
6813 /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
6819 gettimeofday(&now, NULL);
6820 for (unsigned long i = (now.tv_sec / 86400) & 0x3ff; i; i >>= 5)
6821 g = string_catn(g, &base32_chars[i & 0x1f], 1);
6822 if (g) while (g->ptr > 0)
6823 yield = string_catn(yield, &g->s[--g->ptr], 1);
6825 yield = string_catn(yield, US"=", 1);
6827 /* ${domain:$return_path}=${local_part:$return_path} */
6829 int start, end, domain;
6830 uschar * t = parse_extract_address(sub[1], &expand_string_message,
6831 &start, &end, &domain, FALSE);
6835 if (domain > 0) yield = string_cat(yield, t + domain);
6836 yield = string_catn(yield, US"=", 1);
6838 ? string_catn(yield, t, domain - 1) : string_cat(yield, t);
6841 /* @$original_domain */
6842 yield = string_catn(yield, US"@", 1);
6843 yield = string_cat(yield, sub[2]);
6846 #endif /*EXPERIMENTAL_SRS_NATIVE*/
6847 } /* EITEM_* switch */
6849 /* Control reaches here if the name is not recognized as one of the more
6850 complicated expansion items. Check for the "operator" syntax (name terminated
6851 by a colon). Some of the operators have arguments, separated by _ from the
6860 var_entry *vp = NULL;
6863 /* Owing to an historical mis-design, an underscore may be part of the
6864 operator name, or it may introduce arguments. We therefore first scan the
6865 table of names that contain underscores. If there is no match, we cut off
6866 the arguments and then scan the main table. */
6868 if ((c = chop_match(name, op_table_underscore,
6869 nelem(op_table_underscore))) < 0)
6871 if ((arg = Ustrchr(name, '_')))
6873 if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
6874 c += nelem(op_table_underscore);
6875 if (arg) *arg++ = '_'; /* Put back for error messages */
6878 /* Deal specially with operators that might take a certificate variable
6879 as we do not want to do the usual expansion. For most, expand the string.*/
6889 const uschar * s1 = s;
6890 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6892 if (!sub) goto EXPAND_FAILED; /*{*/
6895 expand_string_message =
6896 string_sprintf("missing '}' closing cert arg of %s", name);
6897 goto EXPAND_FAILED_CURLY;
6899 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6909 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6910 if (!sub) goto EXPAND_FAILED;
6915 /* If we are skipping, we don't need to perform the operation at all.
6916 This matters for operations like "mask", because the data may not be
6917 in the correct format when skipping. For example, the expression may test
6918 for the existence of $sender_host_address before trying to mask it. For
6919 other operations, doing them may not fail, but it is a waste of time. */
6921 if (skipping && c >= 0) continue;
6923 /* Otherwise, switch on the operator type */
6930 unsigned long int n = Ustrtoul(sub, &t, 10);
6935 expand_string_message = string_sprintf("argument for base32 "
6936 "operator is \"%s\", which is not a decimal number", sub);
6940 g = string_catn(g, &base32_chars[n & 0x1f], 1);
6942 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
6949 unsigned long int n = 0;
6952 uschar * t = Ustrchr(base32_chars, *tt++);
6955 expand_string_message = string_sprintf("argument for base32d "
6956 "operator is \"%s\", which is not a base 32 number", sub);
6959 n = n * 32 + (t - base32_chars);
6961 yield = string_fmt_append(yield, "%ld", n);
6968 unsigned long int n = Ustrtoul(sub, &t, 10);
6971 expand_string_message = string_sprintf("argument for base62 "
6972 "operator is \"%s\", which is not a decimal number", sub);
6975 yield = string_cat(yield, string_base62(n));
6979 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6984 unsigned long int n = 0;
6987 uschar *t = Ustrchr(base62_chars, *tt++);
6990 expand_string_message = string_sprintf("argument for base62d "
6991 "operator is \"%s\", which is not a base %d number", sub,
6995 n = n * BASE_62 + (t - base62_chars);
6997 yield = string_fmt_append(yield, "%ld", n);
7002 /* This is purely for the convenience of the test harness. Do not enable
7003 it otherwise as it defeats the taint-checking security. */
7005 if (f.running_in_test_harness)
7006 yield = string_cat(yield, is_tainted(sub)
7007 ? string_copy_taint(sub, FALSE) : sub);
7010 DEBUG(D_expand) debug_printf_indent("bless operator not supported\n");
7011 yield = string_cat(yield, sub);
7017 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
7020 expand_string_message =
7021 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7022 expand_string_message);
7025 yield = string_cat(yield, expanded);
7032 uschar *t = sub - 1;
7033 while (*(++t) != 0) { *t = tolower(*t); count++; }
7034 yield = string_catn(yield, sub, count);
7041 uschar *t = sub - 1;
7042 while (*(++t) != 0) { *t = toupper(*t); count++; }
7043 yield = string_catn(yield, sub, count);
7049 if (vp && *(void **)vp->value)
7051 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7052 yield = string_cat(yield, cp);
7060 md5_end(&base, sub, Ustrlen(sub), digest);
7061 for (int j = 0; j < 16; j++)
7062 yield = string_fmt_append(yield, "%02x", digest[j]);
7068 if (vp && *(void **)vp->value)
7070 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7071 yield = string_cat(yield, cp);
7079 sha1_end(&h, sub, Ustrlen(sub), digest);
7080 for (int j = 0; j < 20; j++)
7081 yield = string_fmt_append(yield, "%02X", digest[j]);
7087 #ifdef EXIM_HAVE_SHA2
7088 if (vp && *(void **)vp->value)
7089 if (c == EOP_SHA256)
7090 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7092 expand_string_message = US"sha2_N not supported with certificates";
7097 hashmethod m = !arg ? HASH_SHA2_256
7098 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7099 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7100 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7103 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7105 expand_string_message = US"unrecognised sha2 variant";
7109 exim_sha_update(&h, sub, Ustrlen(sub));
7110 exim_sha_finish(&h, &b);
7112 yield = string_fmt_append(yield, "%02X", *b.data++);
7115 expand_string_message = US"sha256 only supported with TLS";
7120 #ifdef EXIM_HAVE_SHA3
7124 hashmethod m = !arg ? HASH_SHA3_256
7125 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7126 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7127 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7128 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7131 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7133 expand_string_message = US"unrecognised sha3 variant";
7137 exim_sha_update(&h, sub, Ustrlen(sub));
7138 exim_sha_finish(&h, &b);
7140 yield = string_fmt_append(yield, "%02X", *b.data++);
7144 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7148 /* Convert hex encoding to base64 encoding */
7158 for (enc = sub; *enc; enc++)
7160 if (!isxdigit(*enc))
7162 expand_string_message = string_sprintf("\"%s\" is not a hex "
7171 expand_string_message = string_sprintf("\"%s\" contains an odd "
7172 "number of characters", sub);
7176 while ((c = *in++) != 0)
7178 if (isdigit(c)) c -= '0';
7179 else c = toupper(c) - 'A' + 10;
7189 enc = b64encode(CUS sub, out - sub);
7190 yield = string_cat(yield, enc);
7194 /* Convert octets outside 0x21..0x7E to \xXX form */
7198 uschar *t = sub - 1;
7201 if (*t < 0x21 || 0x7E < *t)
7202 yield = string_fmt_append(yield, "\\x%02x", *t);
7204 yield = string_catn(yield, t, 1);
7209 /* count the number of list elements */
7216 while (string_nextinlist(CUSS &sub, &sep, NULL, 0)) cnt++;
7217 yield = string_fmt_append(yield, "%d", cnt);
7221 /* expand a named list given the name */
7222 /* handles nested named lists; requotes as colon-sep list */
7226 tree_node *t = NULL;
7227 const uschar * list;
7230 uschar * suffix = US"";
7231 BOOL needsep = FALSE;
7234 if (*sub == '+') sub++;
7235 if (!arg) /* no-argument version */
7237 if (!(t = tree_search(addresslist_anchor, sub)) &&
7238 !(t = tree_search(domainlist_anchor, sub)) &&
7239 !(t = tree_search(hostlist_anchor, sub)))
7240 t = tree_search(localpartlist_anchor, sub);
7242 else switch(*arg) /* specific list-type version */
7244 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
7245 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
7246 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
7247 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
7249 expand_string_message = US"bad suffix on \"list\" operator";
7255 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
7257 : *arg=='a'?"address "
7258 : *arg=='d'?"domain "
7260 : *arg=='l'?"localpart "
7265 list = ((namedlist_block *)(t->data.ptr))->string;
7267 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
7269 uschar * buf = US" : ";
7271 yield = string_catn(yield, buf, 3);
7275 if (*item == '+') /* list item is itself a named list */
7277 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
7278 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
7280 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
7284 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
7285 while ((cp= strpbrk(CCS item, tok)))
7287 yield = string_catn(yield, item, cp - CS item);
7288 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
7290 yield = string_catn(yield, US"::", 2);
7293 else /* sep in item; should already be doubled; emit once */
7295 yield = string_catn(yield, US tok, 1);
7296 if (*cp == sep) cp++;
7301 yield = string_cat(yield, item);
7306 /* quote a list-item for the given list-separator */
7308 /* mask applies a mask to an IP address; for example the result of
7309 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7316 int mask, maskoffset;
7317 int type = string_is_ip_address(sub, &maskoffset);
7322 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7327 if (maskoffset == 0)
7329 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7334 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7336 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
7338 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7343 /* Convert the address to binary integer(s) and apply the mask */
7345 sub[maskoffset] = 0;
7346 count = host_aton(sub, binary);
7347 host_mask(count, binary, mask);
7349 /* Convert to masked textual format and add to output. */
7351 yield = string_catn(yield, buffer,
7352 host_nmtoa(count, binary, mask, buffer, '.'));
7357 case EOP_IPV6DENORM:
7359 int type = string_is_ip_address(sub, NULL);
7366 (void) host_aton(sub, binary);
7369 case 4: /* convert to IPv4-mapped IPv6 */
7370 binary[0] = binary[1] = 0;
7371 binary[2] = 0x0000ffff;
7372 (void) host_aton(sub, binary+3);
7376 expand_string_message =
7377 string_sprintf("\"%s\" is not an IP address", sub);
7381 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7382 ? ipv6_nmtoa(binary, buffer)
7383 : host_nmtoa(4, binary, -1, buffer, ':')
7389 case EOP_LOCAL_PART:
7393 int start, end, domain;
7394 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7397 if (c != EOP_DOMAIN)
7398 yield = c == EOP_LOCAL_PART && domain > 0
7399 ? string_catn(yield, t, domain - 1)
7400 : string_cat(yield, t);
7401 else if (domain > 0)
7402 yield = string_cat(yield, t + domain);
7408 uschar outsep[2] = { ':', '\0' };
7409 uschar *address, *error;
7410 int save_ptr = gstring_length(yield);
7411 int start, end, domain; /* Not really used */
7413 if (Uskip_whitespace(&sub) == '>')
7414 if (*outsep = *++sub) ++sub;
7417 expand_string_message = string_sprintf("output separator "
7418 "missing in expanding ${addresses:%s}", --sub);
7421 f.parse_allow_group = TRUE;
7425 uschar * p = parse_find_address_end(sub, FALSE);
7426 uschar saveend = *p;
7428 address = parse_extract_address(sub, &error, &start, &end, &domain,
7432 /* Add the address to the output list that we are building. This is
7433 done in chunks by searching for the separator character. At the
7434 start, unless we are dealing with the first address of the output
7435 list, add in a space if the new address begins with the separator
7436 character, or is an empty string. */
7440 if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7441 yield = string_catn(yield, US" ", 1);
7445 size_t seglen = Ustrcspn(address, outsep);
7446 yield = string_catn(yield, address, seglen + 1);
7448 /* If we got to the end of the string we output one character
7451 if (address[seglen] == '\0') { yield->ptr--; break; }
7452 yield = string_catn(yield, outsep, 1);
7453 address += seglen + 1;
7456 /* Output a separator after the string: we will remove the
7457 redundant final one at the end. */
7459 yield = string_catn(yield, outsep, 1);
7462 if (saveend == '\0') break;
7466 /* If we have generated anything, remove the redundant final
7469 if (yield && yield->ptr != save_ptr) yield->ptr--;
7470 f.parse_allow_group = FALSE;
7475 /* quote puts a string in quotes if it is empty or contains anything
7476 other than alphamerics, underscore, dot, or hyphen.
7478 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7479 be quoted in order to be a valid local part.
7481 In both cases, newlines and carriage returns are converted into \n and \r
7485 case EOP_QUOTE_LOCAL_PART:
7488 BOOL needs_quote = (!*sub); /* TRUE for empty string */
7489 uschar *t = sub - 1;
7493 while (!needs_quote && *(++t) != 0)
7494 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7496 else /* EOP_QUOTE_LOCAL_PART */
7498 while (!needs_quote && *(++t) != 0)
7499 needs_quote = !isalnum(*t) &&
7500 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
7501 (*t != '.' || t == sub || t[1] == 0);
7506 yield = string_catn(yield, US"\"", 1);
7511 yield = string_catn(yield, US"\\n", 2);
7512 else if (*t == '\r')
7513 yield = string_catn(yield, US"\\r", 2);
7516 if (*t == '\\' || *t == '"')
7517 yield = string_catn(yield, US"\\", 1);
7518 yield = string_catn(yield, t, 1);
7521 yield = string_catn(yield, US"\"", 1);
7523 else yield = string_cat(yield, sub);
7527 /* quote_lookuptype does lookup-specific quoting */
7532 uschar *opt = Ustrchr(arg, '_');
7534 if (opt) *opt++ = 0;
7536 if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7538 expand_string_message = search_error_message;
7542 if (lookup_list[n]->quote)
7543 sub = (lookup_list[n]->quote)(sub, opt);
7549 expand_string_message = string_sprintf(
7550 "\"%s\" unrecognized after \"${quote_%s\"",
7555 yield = string_cat(yield, sub);
7559 /* rx quote sticks in \ before any non-alphameric character so that
7560 the insertion works in a regular expression. */
7564 uschar *t = sub - 1;
7568 yield = string_catn(yield, US"\\", 1);
7569 yield = string_catn(yield, t, 1);
7574 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7575 prescribed by the RFC, if there are characters that need to be encoded */
7578 yield = string_cat(yield,
7579 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7583 /* RFC 2047 decode */
7589 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7590 headers_charset, '?', &len, &error);
7593 expand_string_message = error;
7596 yield = string_catn(yield, decoded, len);
7600 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7605 uschar * buff = store_get(4, is_tainted(sub));
7610 if (c > 255) c = '_';
7612 yield = string_catn(yield, buff, 1);
7617 /* replace illegal UTF-8 sequences by replacement character */
7619 #define UTF8_REPLACEMENT_CHAR US"?"
7623 int seq_len = 0, index = 0;
7625 long codepoint = -1;
7627 uschar seq_buff[4]; /* accumulate utf-8 here */
7629 /* Manually track tainting, as we deal in individual chars below */
7631 if (is_tainted(sub))
7632 if (yield->s && yield->ptr)
7633 gstring_rebuffer(yield);
7635 yield->s = store_get(yield->size = Ustrlen(sub), TRUE);
7637 /* Check the UTF-8, byte-by-byte */
7646 if ((c & 0xc0) != 0x80)
7647 /* wrong continuation byte; invalidate all bytes */
7648 complete = 1; /* error */
7651 codepoint = (codepoint << 6) | (c & 0x3f);
7652 seq_buff[index++] = c;
7653 if (--bytes_left == 0) /* codepoint complete */
7654 if(codepoint > 0x10FFFF) /* is it too large? */
7655 complete = -1; /* error (RFC3629 limit) */
7657 { /* finished; output utf-8 sequence */
7658 yield = string_catn(yield, seq_buff, seq_len);
7663 else /* no bytes left: new sequence */
7665 if(!(c & 0x80)) /* 1-byte sequence, US-ASCII, keep it */
7667 yield = string_catn(yield, &c, 1);
7670 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7672 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7677 codepoint = c & 0x1f;
7680 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7683 codepoint = c & 0x0f;
7685 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7688 codepoint = c & 0x07;
7690 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7693 seq_buff[index++] = c;
7694 seq_len = bytes_left + 1;
7695 } /* if(bytes_left) */
7699 bytes_left = index = 0;
7700 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7702 if ((complete == 1) && ((c & 0x80) == 0))
7703 /* ASCII character follows incomplete sequence */
7704 yield = string_catn(yield, &c, 1);
7706 /* If given a sequence truncated mid-character, we also want to report ?
7707 * Eg, ${length_1:フィル} is one byte, not one character, so we expect
7708 * ${utf8clean:${length_1:フィル}} to yield '?' */
7709 if (bytes_left != 0)
7710 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7716 case EOP_UTF8_DOMAIN_TO_ALABEL:
7718 uschar * error = NULL;
7719 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7722 expand_string_message = string_sprintf(
7723 "error converting utf8 (%s) to alabel: %s",
7724 string_printing(sub), error);
7727 yield = string_cat(yield, s);
7731 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7733 uschar * error = NULL;
7734 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7737 expand_string_message = string_sprintf(
7738 "error converting alabel (%s) to utf8: %s",
7739 string_printing(sub), error);
7742 yield = string_cat(yield, s);
7746 case EOP_UTF8_LOCALPART_TO_ALABEL:
7748 uschar * error = NULL;
7749 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7752 expand_string_message = string_sprintf(
7753 "error converting utf8 (%s) to alabel: %s",
7754 string_printing(sub), error);
7757 yield = string_cat(yield, s);
7758 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7762 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7764 uschar * error = NULL;
7765 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7768 expand_string_message = string_sprintf(
7769 "error converting alabel (%s) to utf8: %s",
7770 string_printing(sub), error);
7773 yield = string_cat(yield, s);
7776 #endif /* EXPERIMENTAL_INTERNATIONAL */
7778 /* escape turns all non-printing characters into escape sequences. */
7782 const uschar * t = string_printing(sub);
7783 yield = string_cat(yield, t);
7787 case EOP_ESCAPE8BIT:
7791 for (const uschar * s = sub; (c = *s); s++)
7792 yield = c < 127 && c != '\\'
7793 ? string_catn(yield, s, 1)
7794 : string_fmt_append(yield, "\\%03o", c);
7798 /* Handle numeric expression evaluation */
7803 uschar *save_sub = sub;
7804 uschar *error = NULL;
7805 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7808 expand_string_message = string_sprintf("error in expression "
7809 "evaluation: %s (after processing \"%.*s\")", error,
7810 (int)(sub-save_sub), save_sub);
7813 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
7817 /* Handle time period formatting */
7821 int n = readconf_readtime(sub, 0, FALSE);
7824 expand_string_message = string_sprintf("string \"%s\" is not an "
7825 "Exim time interval in \"%s\" operator", sub, name);
7828 yield = string_fmt_append(yield, "%d", n);
7832 case EOP_TIME_INTERVAL:
7835 uschar *t = read_number(&n, sub);
7836 if (*t != 0) /* Not A Number*/
7838 expand_string_message = string_sprintf("string \"%s\" is not a "
7839 "positive number in \"%s\" operator", sub, name);
7842 t = readconf_printtime(n);
7843 yield = string_cat(yield, t);
7847 /* Convert string to base64 encoding */
7853 uschar * s = vp && *(void **)vp->value
7854 ? tls_cert_der_b64(*(void **)vp->value)
7855 : b64encode(CUS sub, Ustrlen(sub));
7857 uschar * s = b64encode(CUS sub, Ustrlen(sub));
7859 yield = string_cat(yield, s);
7866 int len = b64decode(sub, &s);
7869 expand_string_message = string_sprintf("string \"%s\" is not "
7870 "well-formed for \"%s\" operator", sub, name);
7873 yield = string_cat(yield, s);
7877 /* strlen returns the length of the string */
7880 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
7883 /* length_n or l_n takes just the first n characters or the whole string,
7884 whichever is the shorter;
7886 substr_m_n, and s_m_n take n characters from offset m; negative m take
7887 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7888 takes the rest, either to the right or to the left.
7890 hash_n or h_n makes a hash of length n from the string, yielding n
7891 characters from the set a-z; hash_n_m makes a hash of length n, but
7892 uses m characters from the set a-zA-Z0-9.
7894 nhash_n returns a single number between 0 and n-1 (in text form), while
7895 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7896 between 0 and n-1 and the second between 0 and m-1. */
7916 expand_string_message = string_sprintf("missing values after %s",
7921 /* "length" has only one argument, effectively being synonymous with
7924 if (c == EOP_LENGTH || c == EOP_L)
7930 /* The others have one or two arguments; for "substr" the first may be
7931 negative. The second being negative means "not supplied". */
7936 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7939 /* Read up to two numbers, separated by underscores */
7944 if (arg != ret && *arg == '_' && pn == &value1)
7948 if (arg[1] != 0) arg++;
7950 else if (!isdigit(*arg))
7952 expand_string_message =
7953 string_sprintf("non-digit after underscore in \"%s\"", name);
7956 else *pn = (*pn)*10 + *arg++ - '0';
7960 /* Perform the required operation */
7962 ret = c == EOP_HASH || c == EOP_H
7963 ? compute_hash(sub, value1, value2, &len)
7964 : c == EOP_NHASH || c == EOP_NH
7965 ? compute_nhash(sub, value1, value2, &len)
7966 : extract_substr(sub, value1, value2, &len);
7967 if (!ret) goto EXPAND_FAILED;
7969 yield = string_catn(yield, ret, len);
7978 uschar **modetable[3];
7982 if (expand_forbid & RDO_EXISTS)
7984 expand_string_message = US"Use of the stat() expansion is not permitted";
7988 if (stat(CS sub, &st) < 0)
7990 expand_string_message = string_sprintf("stat(%s) failed: %s",
7991 sub, strerror(errno));
7995 switch (mode & S_IFMT)
7997 case S_IFIFO: smode[0] = 'p'; break;
7998 case S_IFCHR: smode[0] = 'c'; break;
7999 case S_IFDIR: smode[0] = 'd'; break;
8000 case S_IFBLK: smode[0] = 'b'; break;
8001 case S_IFREG: smode[0] = '-'; break;
8002 default: smode[0] = '?'; break;
8005 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8006 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8007 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8009 for (int i = 0; i < 3; i++)
8011 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8016 yield = string_fmt_append(yield,
8017 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8018 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8019 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8020 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8021 (long)st.st_gid, st.st_size, (long)st.st_atime,
8022 (long)st.st_mtime, (long)st.st_ctime);
8026 /* vaguely random number less than N */
8030 int_eximarith_t max = expanded_string_integer(sub, TRUE);
8032 if (expand_string_message)
8034 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8038 /* Reverse IP, including IPv6 to dotted-nibble */
8040 case EOP_REVERSE_IP:
8042 int family, maskptr;
8043 uschar reversed[128];
8045 family = string_is_ip_address(sub, &maskptr);
8048 expand_string_message = string_sprintf(
8049 "reverse_ip() not given an IP address [%s]", sub);
8052 invert_address(reversed, sub);
8053 yield = string_cat(yield, reversed);
8057 /* Unknown operator */
8060 expand_string_message =
8061 string_sprintf("unknown expansion operator \"%s\"", name);
8066 /* Handle a plain name. If this is the first thing in the expansion, release
8067 the pre-allocated buffer. If the result data is known to be in a new buffer,
8068 newsize will be set to the size of that buffer, and we can just point at that
8069 store instead of copying. Many expansion strings contain just one reference,
8070 so this is a useful optimization, especially for humungous headers
8071 ($message_headers). */
8080 g = store_get(sizeof(gstring), FALSE);
8081 else if (yield->ptr == 0)
8083 if (resetok) reset_point = store_reset(reset_point);
8085 reset_point = store_mark();
8086 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
8088 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
8090 expand_string_message =
8091 string_sprintf("unknown variable in \"${%s}\"", name);
8092 check_variable_error_message(name);
8095 len = Ustrlen(value);
8096 if (!yield && newsize)
8099 yield->size = newsize;
8104 yield = string_catn(yield, value, len);
8108 /* Else there's something wrong */
8110 expand_string_message =
8111 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8112 "in a variable reference)", name);
8116 /* If we hit the end of the string when ket_ends is set, there is a missing
8117 terminating brace. */
8119 if (ket_ends && *s == 0)
8121 expand_string_message = malformed_header
8122 ? US"missing } at end of string - could be header name not terminated by colon"
8123 : US"missing } at end of string";
8127 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8128 added to the string. If so, set up an empty string. Add a terminating zero. If
8129 left != NULL, return a pointer to the terminator. */
8132 yield = string_get(1);
8133 (void) string_from_gstring(yield);
8134 if (left) *left = s;
8136 /* Any stacking store that was used above the final string is no longer needed.
8137 In many cases the final string will be the first one that was got and so there
8138 will be optimal store usage. */
8140 if (resetok) gstring_release_unused(yield);
8141 else if (resetok_p) *resetok_p = FALSE;
8145 BOOL tainted = is_tainted(yield->s);
8148 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8149 debug_printf_indent("%sresult: %s\n",
8150 skipping ? "|-----" : "\\_____", yield->s);
8152 debug_printf_indent("%s \\__(tainted)\n",
8153 skipping ? "| " : " ");
8155 debug_printf_indent("\\___skipping: result is not used\n");
8159 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8160 "expanding: %.*s\n",
8161 (int)(s - string), string);
8162 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8164 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8167 debug_printf_indent("%s(tainted)\n",
8169 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8171 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8172 "skipping: result is not used\n");
8178 /* This is the failure exit: easiest to program with a goto. We still need
8179 to update the pointer to the terminator, for cases of nested calls with "fail".
8182 EXPAND_FAILED_CURLY:
8183 if (malformed_header)
8184 expand_string_message =
8185 US"missing or misplaced { or } - could be header name not terminated by colon";
8187 else if (!expand_string_message || !*expand_string_message)
8188 expand_string_message = US"missing or misplaced { or }";
8190 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8191 that is a bad idea, because expand_string_message is in dynamic store. */
8194 if (left) *left = s;
8198 debug_printf_indent("|failed to expand: %s\n", string);
8199 debug_printf_indent("%serror message: %s\n",
8200 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8201 if (f.expand_string_forcedfail)
8202 debug_printf_indent("\\failure was forced\n");
8206 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8208 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8209 "error message: %s\n",
8210 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8211 expand_string_message);
8212 if (f.expand_string_forcedfail)
8213 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8215 if (resetok_p && !resetok) *resetok_p = FALSE;
8221 /* This is the external function call. Do a quick check for any expansion
8222 metacharacters, and if there are none, just return the input string.
8224 Argument: the string to be expanded
8225 Returns: the expanded string, or NULL if expansion failed; if failure was
8226 due to a lookup deferring, search_find_defer will be TRUE
8230 expand_cstring(const uschar * string)
8232 if (Ustrpbrk(string, "$\\") != NULL)
8234 int old_pool = store_pool;
8237 f.search_find_defer = FALSE;
8238 malformed_header = FALSE;
8239 store_pool = POOL_MAIN;
8240 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
8241 store_pool = old_pool;
8249 expand_string(uschar * string)
8251 return US expand_cstring(CUS string);
8258 /*************************************************
8260 *************************************************/
8262 /* Now and again we want to expand a string and be sure that the result is in a
8263 new bit of store. This function does that.
8264 Since we know it has been copied, the de-const cast is safe.
8266 Argument: the string to be expanded
8267 Returns: the expanded string, always in a new bit of store, or NULL
8271 expand_string_copy(const uschar *string)
8273 const uschar *yield = expand_cstring(string);
8274 if (yield == string) yield = string_copy(string);
8280 /*************************************************
8281 * Expand and interpret as an integer *
8282 *************************************************/
8284 /* Expand a string, and convert the result into an integer.
8287 string the string to be expanded
8288 isplus TRUE if a non-negative number is expected
8290 Returns: the integer value, or
8291 -1 for an expansion error ) in both cases, message in
8292 -2 for an integer interpretation error ) expand_string_message
8293 expand_string_message is set NULL for an OK integer
8297 expand_string_integer(uschar *string, BOOL isplus)
8299 return expanded_string_integer(expand_string(string), isplus);
8303 /*************************************************
8304 * Interpret string as an integer *
8305 *************************************************/
8307 /* Convert a string (that has already been expanded) into an integer.
8309 This function is used inside the expansion code.
8312 s the string to be expanded
8313 isplus TRUE if a non-negative number is expected
8315 Returns: the integer value, or
8316 -1 if string is NULL (which implies an expansion error)
8317 -2 for an integer interpretation error
8318 expand_string_message is set NULL for an OK integer
8321 static int_eximarith_t
8322 expanded_string_integer(const uschar *s, BOOL isplus)
8324 int_eximarith_t value;
8325 uschar *msg = US"invalid integer \"%s\"";
8328 /* If expansion failed, expand_string_message will be set. */
8332 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8333 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8334 systems, so we set it zero ourselves. */
8337 expand_string_message = NULL; /* Indicates no error */
8339 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8340 equal to 0. Unfortunately, people actually relied upon that, so preserve
8341 the behaviour explicitly. Stripping leading whitespace is a harmless
8342 noop change since strtol skips it anyway (provided that there is a number
8345 if (Uskip_whitespace(&s) == '\0')
8348 debug_printf_indent("treating blank string as number 0\n");
8352 value = strtoll(CS s, CSS &endptr, 10);
8355 msg = US"integer expected but \"%s\" found";
8356 else if (value < 0 && isplus)
8357 msg = US"non-negative integer expected but \"%s\" found";
8360 switch (tolower(*endptr))
8365 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8370 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8371 else value *= 1024*1024;
8375 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8376 else value *= 1024*1024*1024;
8380 if (errno == ERANGE)
8381 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8383 if (Uskip_whitespace(&endptr) == 0) return value;
8386 expand_string_message = string_sprintf(CS msg, s);
8391 /* These values are usually fixed boolean values, but they are permitted to be
8395 addr address being routed
8396 mtype the module type
8397 mname the module name
8398 dbg_opt debug selectors
8399 oname the option name
8400 bvalue the router's boolean value
8401 svalue the router's string value
8402 rvalue where to put the returned value
8404 Returns: OK value placed in rvalue
8405 DEFER expansion failed
8409 exp_bool(address_item *addr,
8410 uschar *mtype, uschar *mname, unsigned dbg_opt,
8411 uschar *oname, BOOL bvalue,
8412 uschar *svalue, BOOL *rvalue)
8415 if (!svalue) { *rvalue = bvalue; return OK; }
8417 if (!(expanded = expand_string(svalue)))
8419 if (f.expand_string_forcedfail)
8421 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8425 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8426 oname, mname, mtype, expand_string_message);
8427 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8431 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8434 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8436 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8440 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8441 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8450 /* Avoid potentially exposing a password in a string about to be logged */
8453 expand_hide_passwords(uschar * s)
8455 return ( ( Ustrstr(s, "failed to expand") != NULL
8456 || Ustrstr(s, "expansion of ") != NULL
8458 && ( Ustrstr(s, "mysql") != NULL
8459 || Ustrstr(s, "pgsql") != NULL
8460 || Ustrstr(s, "redis") != NULL
8461 || Ustrstr(s, "sqlite") != NULL
8462 || Ustrstr(s, "ldap:") != NULL
8463 || Ustrstr(s, "ldaps:") != NULL
8464 || Ustrstr(s, "ldapi:") != NULL
8465 || Ustrstr(s, "ldapdn:") != NULL
8466 || Ustrstr(s, "ldapm:") != NULL
8468 ? US"Temporary internal error" : s;
8472 /* Read given named file into big_buffer. Use for keying material etc.
8473 The content will have an ascii NUL appended.
8478 Return: pointer to buffer, or NULL on error.
8482 expand_file_big_buffer(const uschar * filename)
8484 int fd, off = 0, len;
8486 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8488 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8495 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8498 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8506 big_buffer[off] = '\0';
8512 /*************************************************
8513 * Error-checking for testsuite *
8514 *************************************************/
8516 uschar * region_start;
8517 uschar * region_end;
8518 const uschar *var_name;
8519 const uschar *var_data;
8523 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8526 if (var_data >= e->region_start && var_data < e->region_end)
8528 e->var_name = CUS var_name;
8529 e->var_data = CUS var_data;
8534 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8536 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8537 .var_name = NULL, .var_data = NULL };
8539 /* check acl_ variables */
8540 tree_walk(acl_var_c, assert_variable_notin, &e);
8541 tree_walk(acl_var_m, assert_variable_notin, &e);
8543 /* check auth<n> variables */
8544 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8545 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
8547 /* check regex<n> variables */
8548 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8549 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
8551 /* check known-name variables */
8552 for (var_entry * v = var_table; v < var_table + var_table_size; v++)
8553 if (v->type == vtype_stringptr)
8554 assert_variable_notin(US v->name, *(USS v->value), &e);
8556 /* check dns and address trees */
8557 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8558 tree_walk(tree_duplicates, assert_variable_notin, &e);
8559 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8560 tree_walk(tree_unusable, assert_variable_notin, &e);
8563 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8564 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8565 e.var_name, filename, linenumber, e.var_data);
8570 /*************************************************
8571 **************************************************
8572 * Stand-alone test program *
8573 **************************************************
8574 *************************************************/
8580 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
8582 int ovector[3*(EXPAND_MAXN+1)];
8583 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8584 ovector, nelem(ovector));
8585 BOOL yield = n >= 0;
8586 if (n == 0) n = EXPAND_MAXN + 1;
8589 expand_nmax = setup < 0 ? 0 : setup + 1;
8590 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8592 expand_nstring[expand_nmax] = subject + ovector[nn];
8593 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8601 int main(int argc, uschar **argv)
8603 uschar buffer[1024];
8605 debug_selector = D_v;
8606 debug_file = stderr;
8607 debug_fd = fileno(debug_file);
8608 big_buffer = malloc(big_buffer_size);
8610 for (int i = 1; i < argc; i++)
8612 if (argv[i][0] == '+')
8614 debug_trace_memory = 2;
8617 if (isdigit(argv[i][0]))
8618 debug_selector = Ustrtol(argv[i], NULL, 0);
8620 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8624 eldap_default_servers = argv[i];
8627 mysql_servers = argv[i];
8630 pgsql_servers = argv[i];
8633 redis_servers = argv[i];
8637 else opt_perl_startup = argv[i];
8641 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8643 expand_nstring[1] = US"string 1....";
8644 expand_nlength[1] = 8;
8648 if (opt_perl_startup != NULL)
8651 printf("Starting Perl interpreter\n");
8652 errstr = init_perl(opt_perl_startup);
8655 printf("** error in perl_startup code: %s\n", errstr);
8656 return EXIT_FAILURE;
8659 #endif /* EXIM_PERL */
8661 /* Thie deliberately regards the input as untainted, so that it can be
8662 expanded; only reasonable since this is a test for string-expansions. */
8664 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8666 rmark reset_point = store_mark();
8667 uschar *yield = expand_string(buffer);
8669 printf("%s\n", yield);
8672 if (f.search_find_defer) printf("search_find deferred\n");
8673 printf("Failed: %s\n", expand_string_message);
8674 if (f.expand_string_forcedfail) printf("Forced failure\n");
8677 store_reset(reset_point);
8689 /* End of expand.c */