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[] = {
175 /* Tables of operator names, and corresponding switch numbers. The names must be
176 in alphabetical order. There are two tables, because underscore is used in some
177 cases to introduce arguments, whereas for other it is part of the name. This is
178 an historical mis-design. */
180 static uschar *op_table_underscore[] = {
183 US"quote_local_part",
188 ,US"utf8_domain_from_alabel",
189 US"utf8_domain_to_alabel",
190 US"utf8_localpart_from_alabel",
191 US"utf8_localpart_to_alabel"
198 EOP_QUOTE_LOCAL_PART,
203 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
204 EOP_UTF8_DOMAIN_TO_ALABEL,
205 EOP_UTF8_LOCALPART_FROM_ALABEL,
206 EOP_UTF8_LOCALPART_TO_ALABEL
210 static uschar *op_table_main[] = {
258 EOP_ADDRESS = nelem(op_table_underscore),
305 /* Table of condition names, and corresponding switch numbers. The names must
306 be in alphabetical order. */
308 static uschar *cond_table[] = {
312 US"==", /* Backward compatibility */
352 US"match_local_part",
377 ECOND_FIRST_DELIVERY,
405 ECOND_MATCH_LOCAL_PART,
415 /* Types of table entry */
418 vtype_int, /* value is address of int */
419 vtype_filter_int, /* ditto, but recognized only when filtering */
420 vtype_ino, /* value is address of ino_t (not always an int) */
421 vtype_uid, /* value is address of uid_t (not always an int) */
422 vtype_gid, /* value is address of gid_t (not always an int) */
423 vtype_bool, /* value is address of bool */
424 vtype_stringptr, /* value is address of pointer to string */
425 vtype_msgbody, /* as stringptr, but read when first required */
426 vtype_msgbody_end, /* ditto, the end of the message */
427 vtype_msgheaders, /* the message's headers, processed */
428 vtype_msgheaders_raw, /* the message's headers, unprocessed */
429 vtype_localpart, /* extract local part from string */
430 vtype_domain, /* extract domain from string */
431 vtype_string_func, /* value is string returned by given function */
432 vtype_todbsdin, /* value not used; generate BSD inbox tod */
433 vtype_tode, /* value not used; generate tod in epoch format */
434 vtype_todel, /* value not used; generate tod in epoch/usec format */
435 vtype_todf, /* value not used; generate full tod */
436 vtype_todl, /* value not used; generate log tod */
437 vtype_todlf, /* value not used; generate log file datestamp tod */
438 vtype_todzone, /* value not used; generate time zone only */
439 vtype_todzulu, /* value not used; generate zulu tod */
440 vtype_reply, /* value not used; get reply from headers */
441 vtype_pid, /* value not used; result is pid */
442 vtype_host_lookup, /* value not used; get host name */
443 vtype_load_avg, /* value not used; result is int from os_getloadavg */
444 vtype_pspace, /* partition space; value is T/F for spool/log */
445 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
446 vtype_cert /* SSL certificate */
448 ,vtype_dkim /* Lookup of value in DKIM signature */
452 /* Type for main variable table */
460 /* Type for entries pointing to address/length pairs. Not currently
468 static uschar * fn_recipients(void);
469 typedef uschar * stringptr_fn_t(void);
470 static uschar * fn_queue_size(void);
472 /* This table must be kept in alphabetical order. */
474 static var_entry var_table[] = {
475 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
476 they will be confused with user-creatable ACL variables. */
477 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
478 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
479 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
480 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
481 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
482 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
483 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
484 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
485 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
486 { "acl_narg", vtype_int, &acl_narg },
487 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
488 { "address_data", vtype_stringptr, &deliver_address_data },
489 { "address_file", vtype_stringptr, &address_file },
490 { "address_pipe", vtype_stringptr, &address_pipe },
491 #ifdef EXPERIMENTAL_ARC
492 { "arc_domains", vtype_string_func, (void *) &fn_arc_domains },
493 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
494 { "arc_state", vtype_stringptr, &arc_state },
495 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
497 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
498 { "authenticated_id", vtype_stringptr, &authenticated_id },
499 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
500 { "authentication_failed",vtype_int, &authentication_failed },
501 #ifdef WITH_CONTENT_SCAN
502 { "av_failed", vtype_int, &av_failed },
504 #ifdef EXPERIMENTAL_BRIGHTMAIL
505 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
506 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
507 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
508 { "bmi_deliver", vtype_int, &bmi_deliver },
510 { "body_linecount", vtype_int, &body_linecount },
511 { "body_zerocount", vtype_int, &body_zerocount },
512 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
513 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
514 { "caller_gid", vtype_gid, &real_gid },
515 { "caller_uid", vtype_uid, &real_uid },
516 { "callout_address", vtype_stringptr, &callout_address },
517 { "compile_date", vtype_stringptr, &version_date },
518 { "compile_number", vtype_stringptr, &version_cnumber },
519 { "config_dir", vtype_stringptr, &config_main_directory },
520 { "config_file", vtype_stringptr, &config_main_filename },
521 { "csa_status", vtype_stringptr, &csa_status },
522 #ifdef EXPERIMENTAL_DCC
523 { "dcc_header", vtype_stringptr, &dcc_header },
524 { "dcc_result", vtype_stringptr, &dcc_result },
527 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
528 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
529 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
530 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
531 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
532 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
533 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
534 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
535 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
536 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
537 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
538 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
539 { "dkim_key_length", vtype_int, &dkim_key_length },
540 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
541 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
542 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
543 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
544 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
545 { "dkim_signers", vtype_stringptr, &dkim_signers },
546 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
547 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
550 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
551 { "dmarc_status", vtype_stringptr, &dmarc_status },
552 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
553 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
555 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
556 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
557 { "dnslist_text", vtype_stringptr, &dnslist_text },
558 { "dnslist_value", vtype_stringptr, &dnslist_value },
559 { "domain", vtype_stringptr, &deliver_domain },
560 { "domain_data", vtype_stringptr, &deliver_domain_data },
561 #ifndef DISABLE_EVENT
562 { "event_data", vtype_stringptr, &event_data },
564 /*XXX want to use generic vars for as many of these as possible*/
565 { "event_defer_errno", vtype_int, &event_defer_errno },
567 { "event_name", vtype_stringptr, &event_name },
569 { "exim_gid", vtype_gid, &exim_gid },
570 { "exim_path", vtype_stringptr, &exim_path },
571 { "exim_uid", vtype_uid, &exim_uid },
572 { "exim_version", vtype_stringptr, &version_string },
573 { "headers_added", vtype_string_func, (void *) &fn_hdrs_added },
574 { "home", vtype_stringptr, &deliver_home },
575 { "host", vtype_stringptr, &deliver_host },
576 { "host_address", vtype_stringptr, &deliver_host_address },
577 { "host_data", vtype_stringptr, &host_data },
578 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
579 { "host_lookup_failed", vtype_int, &host_lookup_failed },
580 { "host_port", vtype_int, &deliver_host_port },
581 { "initial_cwd", vtype_stringptr, &initial_cwd },
582 { "inode", vtype_ino, &deliver_inode },
583 { "interface_address", vtype_stringptr, &interface_address },
584 { "interface_port", vtype_int, &interface_port },
585 { "item", vtype_stringptr, &iterate_item },
587 { "ldap_dn", vtype_stringptr, &eldap_dn },
589 { "load_average", vtype_load_avg, NULL },
590 { "local_part", vtype_stringptr, &deliver_localpart },
591 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
592 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
593 { "local_part_prefix_v", vtype_stringptr, &deliver_localpart_prefix_v },
594 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
595 { "local_part_suffix_v", vtype_stringptr, &deliver_localpart_suffix_v },
596 #ifdef HAVE_LOCAL_SCAN
597 { "local_scan_data", vtype_stringptr, &local_scan_data },
599 { "local_user_gid", vtype_gid, &local_user_gid },
600 { "local_user_uid", vtype_uid, &local_user_uid },
601 { "localhost_number", vtype_int, &host_number },
602 { "log_inodes", vtype_pinodes, (void *)FALSE },
603 { "log_space", vtype_pspace, (void *)FALSE },
604 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
605 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
606 #ifdef WITH_CONTENT_SCAN
607 { "malware_name", vtype_stringptr, &malware_name },
609 { "max_received_linelength", vtype_int, &max_received_linelength },
610 { "message_age", vtype_int, &message_age },
611 { "message_body", vtype_msgbody, &message_body },
612 { "message_body_end", vtype_msgbody_end, &message_body_end },
613 { "message_body_size", vtype_int, &message_body_size },
614 { "message_exim_id", vtype_stringptr, &message_id },
615 { "message_headers", vtype_msgheaders, NULL },
616 { "message_headers_raw", vtype_msgheaders_raw, NULL },
617 { "message_id", vtype_stringptr, &message_id },
618 { "message_linecount", vtype_int, &message_linecount },
619 { "message_size", vtype_int, &message_size },
621 { "message_smtputf8", vtype_bool, &message_smtputf8 },
623 #ifdef WITH_CONTENT_SCAN
624 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
625 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
626 { "mime_boundary", vtype_stringptr, &mime_boundary },
627 { "mime_charset", vtype_stringptr, &mime_charset },
628 { "mime_content_description", vtype_stringptr, &mime_content_description },
629 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
630 { "mime_content_id", vtype_stringptr, &mime_content_id },
631 { "mime_content_size", vtype_int, &mime_content_size },
632 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
633 { "mime_content_type", vtype_stringptr, &mime_content_type },
634 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
635 { "mime_filename", vtype_stringptr, &mime_filename },
636 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
637 { "mime_is_multipart", vtype_int, &mime_is_multipart },
638 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
639 { "mime_part_count", vtype_int, &mime_part_count },
641 { "n0", vtype_filter_int, &filter_n[0] },
642 { "n1", vtype_filter_int, &filter_n[1] },
643 { "n2", vtype_filter_int, &filter_n[2] },
644 { "n3", vtype_filter_int, &filter_n[3] },
645 { "n4", vtype_filter_int, &filter_n[4] },
646 { "n5", vtype_filter_int, &filter_n[5] },
647 { "n6", vtype_filter_int, &filter_n[6] },
648 { "n7", vtype_filter_int, &filter_n[7] },
649 { "n8", vtype_filter_int, &filter_n[8] },
650 { "n9", vtype_filter_int, &filter_n[9] },
651 { "original_domain", vtype_stringptr, &deliver_domain_orig },
652 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
653 { "originator_gid", vtype_gid, &originator_gid },
654 { "originator_uid", vtype_uid, &originator_uid },
655 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
656 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
657 { "pid", vtype_pid, NULL },
659 { "prdr_requested", vtype_bool, &prdr_requested },
661 { "primary_hostname", vtype_stringptr, &primary_hostname },
662 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
663 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
664 { "proxy_external_port", vtype_int, &proxy_external_port },
665 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
666 { "proxy_local_port", vtype_int, &proxy_local_port },
667 { "proxy_session", vtype_bool, &proxy_session },
669 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
670 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
671 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
672 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
673 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
674 { "queue_name", vtype_stringptr, &queue_name },
675 { "queue_size", vtype_string_func, &fn_queue_size },
676 { "rcpt_count", vtype_int, &rcpt_count },
677 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
678 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
679 { "received_count", vtype_int, &received_count },
680 { "received_for", vtype_stringptr, &received_for },
681 { "received_ip_address", vtype_stringptr, &interface_address },
682 { "received_port", vtype_int, &interface_port },
683 { "received_protocol", vtype_stringptr, &received_protocol },
684 { "received_time", vtype_int, &received_time.tv_sec },
685 { "recipient_data", vtype_stringptr, &recipient_data },
686 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
687 { "recipients", vtype_string_func, (void *) &fn_recipients },
688 { "recipients_count", vtype_int, &recipients_count },
689 #ifdef WITH_CONTENT_SCAN
690 { "regex_match_string", vtype_stringptr, ®ex_match_string },
692 { "reply_address", vtype_reply, NULL },
693 { "return_path", vtype_stringptr, &return_path },
694 { "return_size_limit", vtype_int, &bounce_return_size_limit },
695 { "router_name", vtype_stringptr, &router_name },
696 { "runrc", vtype_int, &runrc },
697 { "self_hostname", vtype_stringptr, &self_hostname },
698 { "sender_address", vtype_stringptr, &sender_address },
699 { "sender_address_data", vtype_stringptr, &sender_address_data },
700 { "sender_address_domain", vtype_domain, &sender_address },
701 { "sender_address_local_part", vtype_localpart, &sender_address },
702 { "sender_data", vtype_stringptr, &sender_data },
703 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
704 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
705 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
706 { "sender_host_address", vtype_stringptr, &sender_host_address },
707 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
708 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
709 { "sender_host_name", vtype_host_lookup, NULL },
710 { "sender_host_port", vtype_int, &sender_host_port },
711 { "sender_ident", vtype_stringptr, &sender_ident },
712 { "sender_rate", vtype_stringptr, &sender_rate },
713 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
714 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
715 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
716 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
717 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
718 { "sending_port", vtype_int, &sending_port },
719 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
720 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
721 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
722 { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
723 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
724 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
725 { "sn0", vtype_filter_int, &filter_sn[0] },
726 { "sn1", vtype_filter_int, &filter_sn[1] },
727 { "sn2", vtype_filter_int, &filter_sn[2] },
728 { "sn3", vtype_filter_int, &filter_sn[3] },
729 { "sn4", vtype_filter_int, &filter_sn[4] },
730 { "sn5", vtype_filter_int, &filter_sn[5] },
731 { "sn6", vtype_filter_int, &filter_sn[6] },
732 { "sn7", vtype_filter_int, &filter_sn[7] },
733 { "sn8", vtype_filter_int, &filter_sn[8] },
734 { "sn9", vtype_filter_int, &filter_sn[9] },
735 #ifdef WITH_CONTENT_SCAN
736 { "spam_action", vtype_stringptr, &spam_action },
737 { "spam_bar", vtype_stringptr, &spam_bar },
738 { "spam_report", vtype_stringptr, &spam_report },
739 { "spam_score", vtype_stringptr, &spam_score },
740 { "spam_score_int", vtype_stringptr, &spam_score_int },
743 { "spf_guess", vtype_stringptr, &spf_guess },
744 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
745 { "spf_received", vtype_stringptr, &spf_received },
746 { "spf_result", vtype_stringptr, &spf_result },
747 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
748 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
750 { "spool_directory", vtype_stringptr, &spool_directory },
751 { "spool_inodes", vtype_pinodes, (void *)TRUE },
752 { "spool_space", vtype_pspace, (void *)TRUE },
753 #ifdef EXPERIMENTAL_SRS_ALT
754 { "srs_db_address", vtype_stringptr, &srs_db_address },
755 { "srs_db_key", vtype_stringptr, &srs_db_key },
756 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
757 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
759 #if defined(EXPERIMENTAL_SRS_ALT) || defined(SUPPORT_SRS)
760 { "srs_recipient", vtype_stringptr, &srs_recipient },
762 #ifdef EXPERIMENTAL_SRS_ALT
763 { "srs_status", vtype_stringptr, &srs_status },
765 { "thisaddress", vtype_stringptr, &filter_thisaddress },
767 /* The non-(in,out) variables are now deprecated */
768 { "tls_bits", vtype_int, &tls_in.bits },
769 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
770 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
772 { "tls_in_bits", vtype_int, &tls_in.bits },
773 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
774 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
775 { "tls_in_cipher_std", vtype_stringptr, &tls_in.cipher_stdname },
776 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
777 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
778 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
779 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
780 #ifndef DISABLE_TLS_RESUME
781 { "tls_in_resumption", vtype_int, &tls_in.resumption },
784 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
786 { "tls_in_ver", vtype_stringptr, &tls_in.ver },
787 { "tls_out_bits", vtype_int, &tls_out.bits },
788 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
789 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
790 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },
792 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
794 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
795 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
796 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
797 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
798 #ifndef DISABLE_TLS_RESUME
799 { "tls_out_resumption", vtype_int, &tls_out.resumption },
802 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
805 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
807 { "tls_out_ver", vtype_stringptr, &tls_out.ver },
809 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
811 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
814 { "tod_bsdinbox", vtype_todbsdin, NULL },
815 { "tod_epoch", vtype_tode, NULL },
816 { "tod_epoch_l", vtype_todel, NULL },
817 { "tod_full", vtype_todf, NULL },
818 { "tod_log", vtype_todl, NULL },
819 { "tod_logfile", vtype_todlf, NULL },
820 { "tod_zone", vtype_todzone, NULL },
821 { "tod_zulu", vtype_todzulu, NULL },
822 { "transport_name", vtype_stringptr, &transport_name },
823 { "value", vtype_stringptr, &lookup_value },
824 { "verify_mode", vtype_stringptr, &verify_mode },
825 { "version_number", vtype_stringptr, &version_string },
826 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
827 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
828 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
829 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
830 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
831 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
834 static int var_table_size = nelem(var_table);
835 static uschar var_buffer[256];
836 static BOOL malformed_header;
838 /* For textual hashes */
840 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
841 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
844 enum { HMAC_MD5, HMAC_SHA1 };
846 /* For numeric hashes */
848 static unsigned int prime[] = {
849 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
850 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
851 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
853 /* For printing modes in symbolic form */
855 static uschar *mtable_normal[] =
856 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
858 static uschar *mtable_setid[] =
859 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
861 static uschar *mtable_sticky[] =
862 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
864 /* flags for find_header() */
865 #define FH_EXISTS_ONLY BIT(0)
866 #define FH_WANT_RAW BIT(1)
867 #define FH_WANT_LIST BIT(2)
870 /*************************************************
871 * Tables for UTF-8 support *
872 *************************************************/
874 /* Table of the number of extra characters, indexed by the first character
875 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
878 static uschar utf8_table1[] = {
879 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
880 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
881 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
882 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
884 /* These are the masks for the data bits in the first byte of a character,
885 indexed by the number of additional bytes. */
887 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
889 /* Get the next UTF-8 character, advancing the pointer. */
891 #define GETUTF8INC(c, ptr) \
893 if ((c & 0xc0) == 0xc0) \
895 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
897 c = (c & utf8_table2[a]) << s; \
901 c |= (*ptr++ & 0x3f) << s; \
907 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
909 /*************************************************
910 * Binary chop search on a table *
911 *************************************************/
913 /* This is used for matching expansion items and operators.
916 name the name that is being sought
917 table the table to search
918 table_size the number of items in the table
920 Returns: the offset in the table, or -1
924 chop_match(uschar *name, uschar **table, int table_size)
926 uschar **bot = table;
927 uschar **top = table + table_size;
931 uschar **mid = bot + (top - bot)/2;
932 int c = Ustrcmp(name, *mid);
933 if (c == 0) return mid - table;
934 if (c > 0) bot = mid + 1; else top = mid;
942 /*************************************************
943 * Check a condition string *
944 *************************************************/
946 /* This function is called to expand a string, and test the result for a "true"
947 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
948 forced fail or lookup defer.
950 We used to release all store used, but this is not not safe due
951 to ${dlfunc } and ${acl }. In any case expand_string_internal()
952 is reasonably careful to release what it can.
954 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
957 condition the condition string
958 m1 text to be incorporated in panic error
961 Returns: TRUE if condition is met, FALSE if not
965 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
967 uschar * ss = expand_string(condition);
970 if (!f.expand_string_forcedfail && !f.search_find_defer)
971 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
972 "for %s %s: %s", condition, m1, m2, expand_string_message);
975 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
976 strcmpic(ss, US"false") != 0;
982 /*************************************************
983 * Pseudo-random number generation *
984 *************************************************/
986 /* Pseudo-random number generation. The result is not "expected" to be
987 cryptographically strong but not so weak that someone will shoot themselves
988 in the foot using it as a nonce in some email header scheme or whatever
989 weirdness they'll twist this into. The result should ideally handle fork().
991 However, if we're stuck unable to provide this, then we'll fall back to
992 appallingly bad randomness.
994 If DISABLE_TLS is not defined then this will not be used except as an emergency
999 Returns a random number in range [0, max-1]
1003 # define vaguely_random_number vaguely_random_number_fallback
1006 vaguely_random_number(int max)
1009 # undef vaguely_random_number
1011 static pid_t pid = 0;
1014 if ((p2 = getpid()) != pid)
1019 #ifdef HAVE_ARC4RANDOM
1020 /* cryptographically strong randomness, common on *BSD platforms, not
1021 so much elsewhere. Alas. */
1022 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1025 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1026 # ifdef HAVE_SRANDOMDEV
1027 /* uses random(4) for seeding */
1032 gettimeofday(&tv, NULL);
1033 srandom(tv.tv_sec | tv.tv_usec | getpid());
1037 /* Poor randomness and no seeding here */
1044 #ifdef HAVE_ARC4RANDOM
1045 return arc4random() % max;
1046 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1047 return random() % max;
1049 /* This one returns a 16-bit number, definitely not crypto-strong */
1050 return random_number(max);
1057 /*************************************************
1058 * Pick out a name from a string *
1059 *************************************************/
1061 /* If the name is too long, it is silently truncated.
1064 name points to a buffer into which to put the name
1065 max is the length of the buffer
1066 s points to the first alphabetic character of the name
1067 extras chars other than alphanumerics to permit
1069 Returns: pointer to the first character after the name
1071 Note: The test for *s != 0 in the while loop is necessary because
1072 Ustrchr() yields non-NULL if the character is zero (which is not something
1075 static const uschar *
1076 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1079 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1081 if (ptr < max-1) name[ptr++] = *s;
1090 /*************************************************
1091 * Pick out the rest of a header name *
1092 *************************************************/
1094 /* A variable name starting $header_ (or just $h_ for those who like
1095 abbreviations) might not be the complete header name because headers can
1096 contain any printing characters in their names, except ':'. This function is
1097 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1098 on the end, if the name was terminated by white space.
1101 name points to a buffer in which the name read so far exists
1102 max is the length of the buffer
1103 s points to the first character after the name so far, i.e. the
1104 first non-alphameric character after $header_xxxxx
1106 Returns: a pointer to the first character after the header name
1109 static const uschar *
1110 read_header_name(uschar *name, int max, const uschar *s)
1112 int prelen = Ustrchr(name, '_') - name + 1;
1113 int ptr = Ustrlen(name) - prelen;
1114 if (ptr > 0) memmove(name, name+prelen, ptr);
1115 while (mac_isgraph(*s) && *s != ':')
1117 if (ptr < max-1) name[ptr++] = *s;
1128 /*************************************************
1129 * Pick out a number from a string *
1130 *************************************************/
1133 n points to an integer into which to put the number
1134 s points to the first digit of the number
1136 Returns: a pointer to the character after the last digit
1138 /*XXX consider expanding to int_eximarith_t. But the test for
1139 "overbig numbers" in 0002 still needs to overflow it. */
1142 read_number(int *n, uschar *s)
1145 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1149 static const uschar *
1150 read_cnumber(int *n, const uschar *s)
1153 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1159 /*************************************************
1160 * Extract keyed subfield from a string *
1161 *************************************************/
1163 /* The yield is in dynamic store; NULL means that the key was not found.
1166 key points to the name of the key
1167 s points to the string from which to extract the subfield
1169 Returns: NULL if the subfield was not found, or
1170 a pointer to the subfield's data
1174 expand_getkeyed(const uschar * key, const uschar * s)
1176 int length = Ustrlen(key);
1177 Uskip_whitespace(&s);
1179 /* Loop to search for the key */
1185 const uschar * dkey = s;
1187 while (*s && *s != '=' && !isspace(*s)) s++;
1188 dkeylength = s - dkey;
1189 if (Uskip_whitespace(&s) == '=') while (isspace(*++s));
1191 data = string_dequote(&s);
1192 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1195 Uskip_whitespace(&s);
1204 find_var_ent(uschar * name)
1207 int last = var_table_size;
1209 while (last > first)
1211 int middle = (first + last)/2;
1212 int c = Ustrcmp(name, var_table[middle].name);
1214 if (c > 0) { first = middle + 1; continue; }
1215 if (c < 0) { last = middle; continue; }
1216 return &var_table[middle];
1221 /*************************************************
1222 * Extract numbered subfield from string *
1223 *************************************************/
1225 /* Extracts a numbered field from a string that is divided by tokens - for
1226 example a line from /etc/passwd is divided by colon characters. First field is
1227 numbered one. Negative arguments count from the right. Zero returns the whole
1228 string. Returns NULL if there are insufficient tokens in the string
1231 Modifies final argument - this is a dynamically generated string, so that's OK.
1234 field number of field to be extracted,
1235 first field = 1, whole string = 0, last field = -1
1236 separators characters that are used to break string into tokens
1237 s points to the string from which to extract the subfield
1239 Returns: NULL if the field was not found,
1240 a pointer to the field's data inside s (modified to add 0)
1244 expand_gettokened (int field, uschar *separators, uschar *s)
1249 uschar *fieldtext = NULL;
1251 if (field == 0) return s;
1253 /* Break the line up into fields in place; for field > 0 we stop when we have
1254 done the number of fields we want. For field < 0 we continue till the end of
1255 the string, counting the number of fields. */
1257 count = (field > 0)? field : INT_MAX;
1263 /* Previous field was the last one in the string. For a positive field
1264 number, this means there are not enough fields. For a negative field number,
1265 check that there are enough, and scan back to find the one that is wanted. */
1269 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1270 if ((-field) == (INT_MAX - count - 1)) return s;
1274 while (ss[-1] != 0) ss--;
1280 /* Previous field was not last in the string; save its start and put a
1284 len = Ustrcspn(ss, separators);
1295 expand_getlistele(int field, const uschar * list)
1297 const uschar * tlist = list;
1299 /* Tainted mem for the throwaway element copies */
1300 uschar * dummy = store_get(2, TRUE);
1304 for (field++; string_nextinlist(&tlist, &sep, dummy, 1); ) field++;
1307 if (field == 0) return NULL;
1308 while (--field > 0 && (string_nextinlist(&list, &sep, dummy, 1))) ;
1309 return string_nextinlist(&list, &sep, NULL, 0);
1313 /* Certificate fields, by name. Worry about by-OID later */
1314 /* Names are chosen to not have common prefixes */
1321 uschar * (*getfn)(void * cert, uschar * mod);
1323 static certfield certfields[] =
1324 { /* linear search; no special order */
1325 { US"version", 7, &tls_cert_version },
1326 { US"serial_number", 13, &tls_cert_serial_number },
1327 { US"subject", 7, &tls_cert_subject },
1328 { US"notbefore", 9, &tls_cert_not_before },
1329 { US"notafter", 8, &tls_cert_not_after },
1330 { US"issuer", 6, &tls_cert_issuer },
1331 { US"signature", 9, &tls_cert_signature },
1332 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1333 { US"subj_altname", 12, &tls_cert_subject_altname },
1334 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1335 { US"crl_uri", 7, &tls_cert_crl_uri },
1339 expand_getcertele(uschar * field, uschar * certvar)
1343 if (!(vp = find_var_ent(certvar)))
1345 expand_string_message =
1346 string_sprintf("no variable named \"%s\"", certvar);
1347 return NULL; /* Unknown variable name */
1349 /* NB this stops us passing certs around in variable. Might
1350 want to do that in future */
1351 if (vp->type != vtype_cert)
1353 expand_string_message =
1354 string_sprintf("\"%s\" is not a certificate", certvar);
1355 return NULL; /* Unknown variable name */
1357 if (!*(void **)vp->value)
1360 if (*field >= '0' && *field <= '9')
1361 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1363 for (certfield * cp = certfields;
1364 cp < certfields + nelem(certfields);
1366 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1368 uschar * modifier = *(field += cp->namelen) == ','
1370 return (*cp->getfn)( *(void **)vp->value, modifier );
1373 expand_string_message =
1374 string_sprintf("bad field selector \"%s\" for certextract", field);
1377 #endif /*DISABLE_TLS*/
1379 /*************************************************
1380 * Extract a substring from a string *
1381 *************************************************/
1383 /* Perform the ${substr or ${length expansion operations.
1386 subject the input string
1387 value1 the offset from the start of the input string to the start of
1388 the output string; if negative, count from the right.
1389 value2 the length of the output string, or negative (-1) for unset
1390 if value1 is positive, unset means "all after"
1391 if value1 is negative, unset means "all before"
1392 len set to the length of the returned string
1394 Returns: pointer to the output string, or NULL if there is an error
1398 extract_substr(uschar *subject, int value1, int value2, int *len)
1400 int sublen = Ustrlen(subject);
1402 if (value1 < 0) /* count from right */
1406 /* If the position is before the start, skip to the start, and adjust the
1407 length. If the length ends up negative, the substring is null because nothing
1408 can precede. This falls out naturally when the length is unset, meaning "all
1414 if (value2 < 0) value2 = 0;
1418 /* Otherwise an unset length => characters before value1 */
1420 else if (value2 < 0)
1427 /* For a non-negative offset, if the starting position is past the end of the
1428 string, the result will be the null string. Otherwise, an unset length means
1429 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1433 if (value1 > sublen)
1438 else if (value2 < 0) value2 = sublen;
1441 /* Cut the length down to the maximum possible for the offset value, and get
1442 the required characters. */
1444 if (value1 + value2 > sublen) value2 = sublen - value1;
1446 return subject + value1;
1452 /*************************************************
1453 * Old-style hash of a string *
1454 *************************************************/
1456 /* Perform the ${hash expansion operation.
1459 subject the input string (an expanded substring)
1460 value1 the length of the output string; if greater or equal to the
1461 length of the input string, the input string is returned
1462 value2 the number of hash characters to use, or 26 if negative
1463 len set to the length of the returned string
1465 Returns: pointer to the output string, or NULL if there is an error
1469 compute_hash(uschar *subject, int value1, int value2, int *len)
1471 int sublen = Ustrlen(subject);
1473 if (value2 < 0) value2 = 26;
1474 else if (value2 > Ustrlen(hashcodes))
1476 expand_string_message =
1477 string_sprintf("hash count \"%d\" too big", value2);
1481 /* Calculate the hash text. We know it is shorter than the original string, so
1482 can safely place it in subject[] (we know that subject is always itself an
1483 expanded substring). */
1485 if (value1 < sublen)
1490 while ((c = (subject[j])) != 0)
1492 int shift = (c + j++) & 7;
1493 subject[i] ^= (c << shift) | (c >> (8-shift));
1494 if (++i >= value1) i = 0;
1496 for (i = 0; i < value1; i++)
1497 subject[i] = hashcodes[(subject[i]) % value2];
1499 else value1 = sublen;
1508 /*************************************************
1509 * Numeric hash of a string *
1510 *************************************************/
1512 /* Perform the ${nhash expansion operation. The first characters of the
1513 string are treated as most important, and get the highest prime numbers.
1516 subject the input string
1517 value1 the maximum value of the first part of the result
1518 value2 the maximum value of the second part of the result,
1519 or negative to produce only a one-part result
1520 len set to the length of the returned string
1522 Returns: pointer to the output string, or NULL if there is an error.
1526 compute_nhash (uschar *subject, int value1, int value2, int *len)
1528 uschar *s = subject;
1530 unsigned long int total = 0; /* no overflow */
1534 if (i == 0) i = nelem(prime) - 1;
1535 total += prime[i--] * (unsigned int)(*s++);
1538 /* If value2 is unset, just compute one number */
1541 s = string_sprintf("%lu", total % value1);
1543 /* Otherwise do a div/mod hash */
1547 total = total % (value1 * value2);
1548 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1559 /*************************************************
1560 * Find the value of a header or headers *
1561 *************************************************/
1563 /* Multiple instances of the same header get concatenated, and this function
1564 can also return a concatenation of all the header lines. When concatenating
1565 specific headers that contain lists of addresses, a comma is inserted between
1566 them. Otherwise we use a straight concatenation. Because some messages can have
1567 pathologically large number of lines, there is a limit on the length that is
1571 name the name of the header, without the leading $header_ or $h_,
1572 or NULL if a concatenation of all headers is required
1573 newsize return the size of memory block that was obtained; may be NULL
1574 if exists_only is TRUE
1575 flags FH_EXISTS_ONLY
1576 set if called from a def: test; don't need to build a string;
1577 just return a string that is not "" and not "0" if the header
1580 set if called for $rh_ or $rheader_ items; no processing,
1581 other than concatenating, will be done on the header. Also used
1582 for $message_headers_raw.
1584 Double colon chars in the content, and replace newline with
1585 colon between each element when concatenating; returning a
1586 colon-sep list (elements might contain newlines)
1587 charset name of charset to translate MIME words to; used only if
1588 want_raw is false; if NULL, no translation is done (this is
1589 used for $bh_ and $bheader_)
1591 Returns: NULL if the header does not exist, else a pointer to a new
1596 find_header(uschar *name, int *newsize, unsigned flags, uschar *charset)
1599 int len = name ? Ustrlen(name) : 0;
1603 for (header_line * h = header_list; h; h = h->next)
1604 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1605 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1610 if (flags & FH_EXISTS_ONLY)
1611 return US"1"; /* don't need actual string */
1614 s = h->text + len; /* text to insert */
1615 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1616 Uskip_whitespace(&s); /* remove leading white space */
1617 t = h->text + h->slen; /* end-point */
1619 /* Unless wanted raw, remove trailing whitespace, including the
1622 if (flags & FH_WANT_LIST)
1623 while (t > s && t[-1] == '\n') t--;
1624 else if (!(flags & FH_WANT_RAW))
1626 while (t > s && isspace(t[-1])) t--;
1628 /* Set comma if handling a single header and it's one of those
1629 that contains an address list, except when asked for raw headers. Only
1630 need to do this once. */
1632 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1635 /* Trim the header roughly if we're approaching limits */
1637 if (gstring_length(g) + inc > header_insert_maxlen)
1638 inc = header_insert_maxlen - gstring_length(g);
1640 /* For raw just copy the data; for a list, add the data as a colon-sep
1641 list-element; for comma-list add as an unchecked comma,newline sep
1642 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1643 stripped trailing WS above including the newline). We ignore the potential
1644 expansion due to colon-doubling, just leaving the loop if the limit is met
1647 if (flags & FH_WANT_LIST)
1648 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1649 else if (flags & FH_WANT_RAW)
1650 g = string_catn(g, s, (unsigned)inc);
1652 g = string_append2_listele_n(g, comma ? US",\n" : US"\n",
1655 if (gstring_length(g) >= header_insert_maxlen) break;
1658 if (!found) return NULL; /* No header found */
1659 if (!g) return US"";
1661 /* That's all we do for raw header expansion. */
1664 if (flags & FH_WANT_RAW)
1665 return string_from_gstring(g);
1667 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1668 The rfc2047_decode2() function can return an error with decoded data if the
1669 charset translation fails. If decoding fails, it returns NULL. */
1673 uschar * error, * decoded = rfc2047_decode2(string_from_gstring(g),
1674 check_rfc2047_length, charset, '?', NULL, newsize, &error);
1676 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1677 " input was: %s\n", error, g->s);
1678 return decoded ? decoded : string_from_gstring(g);
1685 /* Append a "local" element to an Authentication-Results: header
1686 if this was a non-smtp message.
1690 authres_local(gstring * g, const uschar * sysname)
1692 if (!f.authentication_local)
1694 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1695 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1700 /* Append an "iprev" element to an Authentication-Results: header
1701 if we have attempted to get the calling host's name.
1705 authres_iprev(gstring * g)
1707 if (sender_host_name)
1708 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1709 else if (host_lookup_deferred)
1710 g = string_cat(g, US";\n\tiprev=temperror");
1711 else if (host_lookup_failed)
1712 g = string_cat(g, US";\n\tiprev=fail");
1716 if (sender_host_address)
1717 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1723 /*************************************************
1724 * Return list of recipients *
1725 *************************************************/
1726 /* A recipients list is available only during system message filtering,
1727 during ACL processing after DATA, and while expanding pipe commands
1728 generated from a system filter, but not elsewhere. */
1736 if (!f.enable_dollar_recipients) return NULL;
1738 for (int i = 0; i < recipients_count; i++)
1740 s = recipients_list[i].address;
1741 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1743 return g ? g->s : NULL;
1747 /*************************************************
1748 * Return size of queue *
1749 *************************************************/
1750 /* Ask the daemon for the queue size */
1755 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1759 const uschar * where;
1760 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1766 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
1768 DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));
1772 #ifdef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1773 sa_un.sun_path[0] = 0; /* Abstract local socket addr - Linux-specific? */
1774 len = offsetof(struct sockaddr_un, sun_path) + 1
1775 + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "exim_%d", getpid());
1777 sname = string_sprintf("%s/p_%d", spool_directory, getpid());
1778 len = offsetof(struct sockaddr_un, sun_path)
1779 + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s", sname);
1782 if (bind(fd, (const struct sockaddr *)&sa_un, len) < 0)
1783 { where = US"bind"; goto bad; }
1786 debug_printf("local addr '%s%s'\n",
1787 *sa_un.sun_path ? "" : "@",
1788 sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1791 #ifdef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1792 sa_un.sun_path[0] = 0; /* Abstract local socket addr - Linux-specific? */
1793 len = offsetof(struct sockaddr_un, sun_path) + 1
1794 + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "%s",
1795 expand_string(notifier_socket));
1797 len = offsetof(struct sockaddr_un, sun_path)
1798 + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s",
1799 expand_string(notifier_socket));
1802 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
1803 { where = US"connect"; goto bad2; }
1805 buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1806 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1808 FD_ZERO(&fds); FD_SET(fd, &fds);
1809 tv.tv_sec = 2; tv.tv_usec = 0;
1810 if (select(fd + 1, (SELECT_ARG2_TYPE *)&fds, NULL, NULL, &tv) != 1)
1812 DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1813 len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1815 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1816 { where = US"recv"; goto bad2; }
1819 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1822 return string_copyn(buf, len);
1825 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1830 DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1835 /*************************************************
1836 * Find value of a variable *
1837 *************************************************/
1839 /* The table of variables is kept in alphabetic order, so we can search it
1840 using a binary chop. The "choplen" variable is nothing to do with the binary
1844 name the name of the variable being sought
1845 exists_only TRUE if this is a def: test; passed on to find_header()
1846 skipping TRUE => skip any processing evaluation; this is not the same as
1847 exists_only because def: may test for values that are first
1849 newsize pointer to an int which is initially zero; if the answer is in
1850 a new memory buffer, *newsize is set to its size
1852 Returns: NULL if the variable does not exist, or
1853 a pointer to the variable's contents, or
1854 something non-NULL if exists_only is TRUE
1858 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1865 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1866 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1867 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1868 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1869 (this gave backwards compatibility at the changeover). There may be built-in
1870 variables whose names start acl_ but they should never start in this way. This
1871 slightly messy specification is a consequence of the history, needless to say.
1873 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1874 set, in which case give an error. */
1876 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1880 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1881 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1883 else if (Ustrncmp(name, "r_", 2) == 0)
1885 tree_node * node = tree_search(router_var, name + 2);
1886 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1889 /* Handle $auth<n> variables. */
1891 if (Ustrncmp(name, "auth", 4) == 0)
1894 int n = Ustrtoul(name + 4, &endptr, 10);
1895 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1896 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1898 else if (Ustrncmp(name, "regex", 5) == 0)
1901 int n = Ustrtoul(name + 5, &endptr, 10);
1902 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1903 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1906 /* For all other variables, search the table */
1908 if (!(vp = find_var_ent(name)))
1909 return NULL; /* Unknown variable name */
1911 /* Found an existing variable. If in skipping state, the value isn't needed,
1912 and we want to avoid processing (such as looking up the host name). */
1920 case vtype_filter_int:
1921 if (!f.filter_running) return NULL;
1925 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1929 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1933 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1937 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1941 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1944 case vtype_stringptr: /* Pointer to string */
1945 return (s = *((uschar **)(val))) ? s : US"";
1948 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1951 case vtype_load_avg:
1952 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1955 case vtype_host_lookup: /* Lookup if not done so */
1956 if ( !sender_host_name && sender_host_address
1957 && !host_lookup_failed && host_name_lookup() == OK)
1958 host_build_sender_fullhost();
1959 return sender_host_name ? sender_host_name : US"";
1961 case vtype_localpart: /* Get local part from address */
1962 if (!(s = *((uschar **)(val)))) return US"";
1963 if (!(domain = Ustrrchr(s, '@'))) return s;
1964 if (domain - s > sizeof(var_buffer) - 1)
1965 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1966 " in string expansion", sizeof(var_buffer));
1967 return string_copyn(s, domain - s);
1969 case vtype_domain: /* Get domain from address */
1970 if (!(s = *((uschar **)(val)))) return US"";
1971 domain = Ustrrchr(s, '@');
1972 return domain ? domain + 1 : US"";
1974 case vtype_msgheaders:
1975 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
1977 case vtype_msgheaders_raw:
1978 return find_header(NULL, newsize,
1979 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
1981 case vtype_msgbody: /* Pointer to msgbody string */
1982 case vtype_msgbody_end: /* Ditto, the end of the msg */
1983 ss = (uschar **)(val);
1984 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1987 off_t start_offset = SPOOL_DATA_START_OFFSET;
1988 int len = message_body_visible;
1990 if (len > message_size) len = message_size;
1991 *ss = body = store_get(len+1, TRUE);
1993 if (vp->type == vtype_msgbody_end)
1995 struct stat statbuf;
1996 if (fstat(deliver_datafile, &statbuf) == 0)
1998 start_offset = statbuf.st_size - len;
1999 if (start_offset < SPOOL_DATA_START_OFFSET)
2000 start_offset = SPOOL_DATA_START_OFFSET;
2003 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
2004 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
2006 if ((len = read(deliver_datafile, body, len)) > 0)
2009 if (message_body_newlines) /* Separate loops for efficiency */
2011 { if (body[--len] == 0) body[len] = ' '; }
2014 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
2017 return *ss ? *ss : US"";
2019 case vtype_todbsdin: /* BSD inbox time of day */
2020 return tod_stamp(tod_bsdin);
2022 case vtype_tode: /* Unix epoch time of day */
2023 return tod_stamp(tod_epoch);
2025 case vtype_todel: /* Unix epoch/usec time of day */
2026 return tod_stamp(tod_epoch_l);
2028 case vtype_todf: /* Full time of day */
2029 return tod_stamp(tod_full);
2031 case vtype_todl: /* Log format time of day */
2032 return tod_stamp(tod_log_bare); /* (without timezone) */
2034 case vtype_todzone: /* Time zone offset only */
2035 return tod_stamp(tod_zone);
2037 case vtype_todzulu: /* Zulu time */
2038 return tod_stamp(tod_zulu);
2040 case vtype_todlf: /* Log file datestamp tod */
2041 return tod_stamp(tod_log_datestamp_daily);
2043 case vtype_reply: /* Get reply address */
2044 s = find_header(US"reply-to:", newsize,
2045 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2047 if (s) Uskip_whitespace(&s);
2050 *newsize = 0; /* For the *s==0 case */
2051 s = find_header(US"from:", newsize,
2052 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2058 Uskip_whitespace(&s);
2059 for (t = s; *t; t++) if (*t == '\n') *t = ' ';
2060 while (t > s && isspace(t[-1])) t--;
2063 return s ? s : US"";
2065 case vtype_string_func:
2067 stringptr_fn_t * fn = (stringptr_fn_t *) val;
2069 return s ? s : US"";
2075 sprintf(CS var_buffer, PR_EXIM_ARITH,
2076 receive_statvfs(val == (void *)TRUE, &inodes));
2083 (void) receive_statvfs(val == (void *)TRUE, &inodes);
2084 sprintf(CS var_buffer, "%d", inodes);
2089 return *(void **)val ? US"<cert>" : US"";
2091 #ifndef DISABLE_DKIM
2093 return dkim_exim_expand_query((int)(long)val);
2098 return NULL; /* Unknown variable. Silences static checkers. */
2105 modify_variable(uschar *name, void * value)
2108 if ((vp = find_var_ent(name))) vp->value = value;
2109 return; /* Unknown variable name, fail silently */
2117 /*************************************************
2118 * Read and expand substrings *
2119 *************************************************/
2121 /* This function is called to read and expand argument substrings for various
2122 expansion items. Some have a minimum requirement that is less than the maximum;
2123 in these cases, the first non-present one is set to NULL.
2126 sub points to vector of pointers to set
2127 n maximum number of substrings
2129 sptr points to current string pointer
2130 skipping the skipping flag
2131 check_end if TRUE, check for final '}'
2132 name name of item, for error message
2133 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2136 Returns: 0 OK; string pointer updated
2137 1 curly bracketing error (too few arguments)
2138 2 too many arguments (only if check_end is set); message set
2139 3 other error (expansion failure)
2143 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
2144 BOOL check_end, uschar *name, BOOL *resetok)
2146 const uschar *s = *sptr;
2148 Uskip_whitespace(&s);
2149 for (int i = 0; i < n; i++)
2155 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2156 "(min is %d)", name, m);
2162 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2164 if (*s++ != '}') return 1;
2165 Uskip_whitespace(&s);
2167 if (check_end && *s++ != '}')
2171 expand_string_message = string_sprintf("Too many arguments for '%s' "
2172 "(max is %d)", name, n);
2175 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2186 /*************************************************
2187 * Elaborate message for bad variable *
2188 *************************************************/
2190 /* For the "unknown variable" message, take a look at the variable's name, and
2191 give additional information about possible ACL variables. The extra information
2192 is added on to expand_string_message.
2194 Argument: the name of the variable
2199 check_variable_error_message(uschar *name)
2201 if (Ustrncmp(name, "acl_", 4) == 0)
2202 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2203 (name[4] == 'c' || name[4] == 'm')?
2205 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2206 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2208 US"user-defined ACL variables must start acl_c or acl_m");
2214 Load args from sub array to globals, and call acl_check().
2215 Sub array will be corrupted on return.
2217 Returns: OK access is granted by an ACCEPT verb
2218 DISCARD access is (apparently) granted by a DISCARD verb
2219 FAIL access is denied
2220 FAIL_DROP access is denied; drop the connection
2221 DEFER can't tell at the moment
2225 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2228 int sav_narg = acl_narg;
2230 uschar * dummy_logmsg;
2231 extern int acl_where;
2233 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2234 for (i = 0; i < nsub && sub[i+1]; i++)
2236 uschar * tmp = acl_arg[i];
2237 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2238 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2243 sub[i+1] = acl_arg[i];
2244 acl_arg[i++] = NULL;
2248 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2250 acl_narg>0 ? acl_arg[0] : US"<none>",
2251 acl_narg>1 ? " +more" : "");
2253 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2255 for (i = 0; i < nsub; i++)
2256 acl_arg[i] = sub[i+1]; /* restore old args */
2257 acl_narg = sav_narg;
2265 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2266 The given string is modified on return. Leading whitespace is skipped while
2267 looking for the opening wrap character, then the rest is scanned for the trailing
2268 (non-escaped) wrap character. A backslash in the string will act as an escape.
2270 A nul is written over the trailing wrap, and a pointer to the char after the
2271 leading wrap is returned.
2274 s String for de-wrapping
2275 wrap Two-char string, the first being the opener, second the closer wrapping
2278 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2282 dewrap(uschar * s, const uschar * wrap)
2286 BOOL quotesmode = wrap[0] == wrap[1];
2288 if (Uskip_whitespace(&p) == *wrap)
2294 if (*p == '\\') p++;
2295 else if (!quotesmode && *p == wrap[-1]) depth++;
2296 else if (*p == *wrap)
2307 expand_string_message = string_sprintf("missing '%c'", *wrap);
2312 /* Pull off the leading array or object element, returning
2313 a copy in an allocated string. Update the list pointer.
2315 The element may itself be an abject or array.
2316 Return NULL when the list is empty.
2320 json_nextinlist(const uschar ** list)
2322 unsigned array_depth = 0, object_depth = 0;
2323 const uschar * s = *list, * item;
2325 skip_whitespace(&s);
2328 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2332 case '[': array_depth++; break;
2333 case ']': array_depth--; break;
2334 case '{': object_depth++; break;
2335 case '}': object_depth--; break;
2337 *list = *s ? s+1 : s;
2338 if (item == s) return NULL;
2339 item = string_copyn(item, s - item);
2340 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2346 /************************************************/
2347 /* Return offset in ops table, or -1 if not found.
2348 Repoint to just after the operator in the string.
2351 ss string representation of operator
2352 opname split-out operator name
2356 identify_operator(const uschar ** ss, uschar ** opname)
2358 const uschar * s = *ss;
2361 /* Numeric comparisons are symbolic */
2363 if (*s == '=' || *s == '>' || *s == '<')
2375 /* All other conditions are named */
2378 s = read_name(name, sizeof(name), s, US"_");
2381 /* If we haven't read a name, it means some non-alpha character is first. */
2385 expand_string_message = string_sprintf("condition name expected, "
2386 "but found \"%.16s\"", s);
2390 *opname = string_copy(name);
2392 return chop_match(name, cond_table, nelem(cond_table));
2396 /*************************************************
2397 * Handle MD5 or SHA-1 computation for HMAC *
2398 *************************************************/
2400 /* These are some wrapping functions that enable the HMAC code to be a bit
2401 cleaner. A good compiler will spot the tail recursion.
2404 type HMAC_MD5 or HMAC_SHA1
2405 remaining are as for the cryptographic hash functions
2411 chash_start(int type, void * base)
2413 if (type == HMAC_MD5)
2414 md5_start((md5 *)base);
2416 sha1_start((hctx *)base);
2420 chash_mid(int type, void * base, const uschar * string)
2422 if (type == HMAC_MD5)
2423 md5_mid((md5 *)base, string);
2425 sha1_mid((hctx *)base, string);
2429 chash_end(int type, void * base, const uschar * string, int length,
2432 if (type == HMAC_MD5)
2433 md5_end((md5 *)base, string, length, digest);
2435 sha1_end((hctx *)base, string, length, digest);
2442 /* Do an hmac_md5. The result is _not_ nul-terminated, and is sized as
2443 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2446 key encoding key, nul-terminated
2447 src data to be hashed, nul-terminated
2449 len size of output buffer
2453 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2456 const uschar * keyptr;
2458 unsigned int keylen;
2460 #define MD5_HASHLEN 16
2461 #define MD5_HASHBLOCKLEN 64
2463 uschar keyhash[MD5_HASHLEN];
2464 uschar innerhash[MD5_HASHLEN];
2465 uschar finalhash[MD5_HASHLEN];
2466 uschar innerkey[MD5_HASHBLOCKLEN];
2467 uschar outerkey[MD5_HASHBLOCKLEN];
2470 keylen = Ustrlen(keyptr);
2472 /* If the key is longer than the hash block length, then hash the key
2475 if (keylen > MD5_HASHBLOCKLEN)
2477 chash_start(HMAC_MD5, &md5_base);
2478 chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2480 keylen = MD5_HASHLEN;
2483 /* Now make the inner and outer key values */
2485 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2486 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2488 for (int i = 0; i < keylen; i++)
2490 innerkey[i] ^= keyptr[i];
2491 outerkey[i] ^= keyptr[i];
2494 /* Now do the hashes */
2496 chash_start(HMAC_MD5, &md5_base);
2497 chash_mid(HMAC_MD5, &md5_base, innerkey);
2498 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2500 chash_start(HMAC_MD5, &md5_base);
2501 chash_mid(HMAC_MD5, &md5_base, outerkey);
2502 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2504 /* Encode the final hash as a hex string, limited by output buffer size */
2507 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2509 if (j-- <= 0) break;
2510 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2511 if (j-- <= 0) break;
2512 *p++ = hex_digits[finalhash[i] & 0x0f];
2516 #endif /*SUPPORT_SRS*/
2519 /*************************************************
2520 * Read and evaluate a condition *
2521 *************************************************/
2525 s points to the start of the condition text
2526 resetok points to a BOOL which is written false if it is unsafe to
2527 free memory. Certain condition types (acl) may have side-effect
2528 allocation which must be preserved.
2529 yield points to a BOOL to hold the result of the condition test;
2530 if NULL, we are just reading through a condition that is
2531 part of an "or" combination to check syntax, or in a state
2532 where the answer isn't required
2534 Returns: a pointer to the first character after the condition, or
2538 static const uschar *
2539 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2541 BOOL testfor = TRUE;
2542 BOOL tempcond, combined_cond;
2544 BOOL sub2_honour_dollar = TRUE;
2545 BOOL is_forany, is_json, is_jsons;
2546 int rc, cond_type, roffset;
2547 int_eximarith_t num[2];
2548 struct stat statbuf;
2551 const uschar *sub[10];
2554 const uschar *rerror;
2557 if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;
2559 switch(cond_type = identify_operator(&s, &opname))
2561 /* def: tests for a non-empty variable, or for the existence of a header. If
2562 yield == NULL we are in a skipping state, and don't care about the answer. */
2570 expand_string_message = US"\":\" expected after \"def\"";
2574 s = read_name(name, sizeof(name), s+1, US"_");
2576 /* Test for a header's existence. If the name contains a closing brace
2577 character, this may be a user error where the terminating colon has been
2578 omitted. Set a flag to adjust a subsequent error message in this case. */
2580 if ( ( *(t = name) == 'h'
2581 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2583 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2586 s = read_header_name(name, sizeof(name), s);
2587 /* {-for-text-editors */
2588 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2590 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2593 /* Test for a variable's having a non-empty value. A non-existent variable
2594 causes an expansion failure. */
2598 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2600 expand_string_message = name[0]
2601 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2602 : US"variable name omitted after \"def:\"";
2603 check_variable_error_message(name);
2606 if (yield) *yield = (t[0] != 0) == testfor;
2613 /* first_delivery tests for first delivery attempt */
2615 case ECOND_FIRST_DELIVERY:
2616 if (yield) *yield = f.deliver_firsttime == testfor;
2620 /* queue_running tests for any process started by a queue runner */
2622 case ECOND_QUEUE_RUNNING:
2623 if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2627 /* exists: tests for file existence
2628 isip: tests for any IP address
2629 isip4: tests for an IPv4 address
2630 isip6: tests for an IPv6 address
2631 pam: does PAM authentication
2632 radius: does RADIUS authentication
2633 ldapauth: does LDAP authentication
2634 pwcheck: does Cyrus SASL pwcheck authentication
2643 case ECOND_LDAPAUTH:
2646 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2648 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2649 if (!sub[0]) return NULL;
2650 /* {-for-text-editors */
2651 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2653 if (!yield) return s; /* No need to run the test if skipping */
2658 if ((expand_forbid & RDO_EXISTS) != 0)
2660 expand_string_message = US"File existence tests are not permitted";
2663 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2669 rc = string_is_ip_address(sub[0], NULL);
2670 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2671 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2674 /* Various authentication tests - all optionally compiled */
2678 rc = auth_call_pam(sub[0], &expand_string_message);
2681 goto COND_FAILED_NOT_COMPILED;
2682 #endif /* SUPPORT_PAM */
2685 #ifdef RADIUS_CONFIG_FILE
2686 rc = auth_call_radius(sub[0], &expand_string_message);
2689 goto COND_FAILED_NOT_COMPILED;
2690 #endif /* RADIUS_CONFIG_FILE */
2692 case ECOND_LDAPAUTH:
2695 /* Just to keep the interface the same */
2697 int old_pool = store_pool;
2698 store_pool = POOL_SEARCH;
2699 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2700 &expand_string_message, &do_cache);
2701 store_pool = old_pool;
2705 goto COND_FAILED_NOT_COMPILED;
2706 #endif /* LOOKUP_LDAP */
2709 #ifdef CYRUS_PWCHECK_SOCKET
2710 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2713 goto COND_FAILED_NOT_COMPILED;
2714 #endif /* CYRUS_PWCHECK_SOCKET */
2716 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2717 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2719 if (rc == ERROR || rc == DEFER) return NULL;
2720 *yield = (rc == OK) == testfor;
2726 /* call ACL (in a conditional context). Accept true, deny false.
2727 Defer is a forced-fail. Anything set by message= goes to $value.
2728 Up to ten parameters are used; we use the braces round the name+args
2729 like the saslauthd condition does, to permit a variable number of args.
2730 See also the expansion-item version EITEM_ACL and the traditional
2731 acl modifier ACLC_ACL.
2732 Since the ACL may allocate new global variables, tell our caller to not
2737 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2743 Uskip_whitespace(&s);
2744 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2746 switch(read_subs(sub, nelem(sub), 1,
2747 &s, yield == NULL, TRUE, name, resetok))
2749 case 1: expand_string_message = US"too few arguments or bracketing "
2752 case 3: return NULL;
2758 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2759 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2764 lookup_value = NULL;
2766 lookup_value = string_copy(user_msg);
2767 *yield = cond == testfor;
2771 f.expand_string_forcedfail = TRUE;
2774 expand_string_message = string_sprintf("%s from acl \"%s\"",
2775 rc_names[rc], sub[0]);
2783 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2785 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2787 However, the last two are optional. That is why the whole set is enclosed
2788 in their own set of braces. */
2790 case ECOND_SASLAUTHD:
2791 #ifndef CYRUS_SASLAUTHD_SOCKET
2792 goto COND_FAILED_NOT_COMPILED;
2796 Uskip_whitespace(&s);
2797 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2798 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, name,
2801 case 1: expand_string_message = US"too few arguments or bracketing "
2802 "error for saslauthd";
2804 case 3: return NULL;
2806 if (!sub[2]) sub[3] = NULL; /* realm if no service */
2809 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2810 &expand_string_message);
2811 if (rc == ERROR || rc == DEFER) return NULL;
2812 *yield = (rc == OK) == testfor;
2816 #endif /* CYRUS_SASLAUTHD_SOCKET */
2819 /* symbolic operators for numeric and string comparison, and a number of
2820 other operators, all requiring two arguments.
2822 crypteq: encrypts plaintext and compares against an encrypted text,
2823 using crypt(), crypt16(), MD5 or SHA-1
2824 inlist/inlisti: checks if first argument is in the list of the second
2825 match: does a regular expression match and sets up the numerical
2826 variables if it succeeds
2827 match_address: matches in an address list
2828 match_domain: matches in a domain list
2829 match_ip: matches a host list that is restricted to IP addresses
2830 match_local_part: matches in a local part list
2833 case ECOND_MATCH_ADDRESS:
2834 case ECOND_MATCH_DOMAIN:
2835 case ECOND_MATCH_IP:
2836 case ECOND_MATCH_LOCAL_PART:
2837 #ifndef EXPAND_LISTMATCH_RHS
2838 sub2_honour_dollar = FALSE;
2847 case ECOND_NUM_L: /* Numerical comparisons */
2854 case ECOND_STR_LT: /* String comparisons */
2865 for (int i = 0; i < 2; i++)
2867 /* Sometimes, we don't expand substrings; too many insecure configurations
2868 created using match_address{}{} and friends, where the second param
2869 includes information from untrustworthy sources. */
2870 BOOL honour_dollar = TRUE;
2871 if ((i > 0) && !sub2_honour_dollar)
2872 honour_dollar = FALSE;
2874 if (Uskip_whitespace(&s) != '{')
2876 if (i == 0) goto COND_FAILED_CURLY_START;
2877 expand_string_message = string_sprintf("missing 2nd string in {} "
2878 "after \"%s\"", opname);
2881 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2882 honour_dollar, resetok)))
2884 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2885 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2886 " for security reasons\n");
2887 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2889 /* Convert to numerical if required; we know that the names of all the
2890 conditions that compare numbers do not start with a letter. This just saves
2891 checking for them individually. */
2893 if (!isalpha(opname[0]) && yield)
2898 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2902 num[i] = expanded_string_integer(sub[i], FALSE);
2903 if (expand_string_message) return NULL;
2907 /* Result not required */
2909 if (!yield) return s;
2911 /* Do an appropriate comparison */
2917 tempcond = (num[0] == num[1]);
2921 tempcond = (num[0] > num[1]);
2925 tempcond = (num[0] >= num[1]);
2929 tempcond = (num[0] < num[1]);
2933 tempcond = (num[0] <= num[1]);
2937 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2941 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2945 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2949 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2953 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2957 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2961 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2965 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2969 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2973 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2976 case ECOND_MATCH: /* Regular expression match */
2977 if (!(re = pcre_compile(CS sub[1], PCRE_COPT, CCSS &rerror,
2980 expand_string_message = string_sprintf("regular expression error in "
2981 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2984 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2987 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2988 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2989 goto MATCHED_SOMETHING;
2991 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2992 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2993 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2994 goto MATCHED_SOMETHING;
2996 case ECOND_MATCH_IP: /* Match IP address in a host list */
2997 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2999 expand_string_message = string_sprintf("\"%s\" is not an IP address",
3005 unsigned int *nullcache = NULL;
3006 check_host_block cb;
3008 cb.host_name = US"";
3009 cb.host_address = sub[0];
3011 /* If the host address starts off ::ffff: it is an IPv6 address in
3012 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3015 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3016 cb.host_address + 7 : cb.host_address;
3018 rc = match_check_list(
3019 &sub[1], /* the list */
3020 0, /* separator character */
3021 &hostlist_anchor, /* anchor pointer */
3022 &nullcache, /* cache pointer */
3023 check_host, /* function for testing */
3024 &cb, /* argument for function */
3025 MCL_HOST, /* type of check */
3026 sub[0], /* text for debugging */
3027 NULL); /* where to pass back data */
3029 goto MATCHED_SOMETHING;
3031 case ECOND_MATCH_LOCAL_PART:
3032 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3033 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
3048 expand_string_message = string_sprintf("unable to complete match "
3049 "against \"%s\": %s", sub[1], search_error_message);
3055 /* Various "encrypted" comparisons. If the second string starts with
3056 "{" then an encryption type is given. Default to crypt() or crypt16()
3057 (build-time choice). */
3058 /* }-for-text-editors */
3061 #ifndef SUPPORT_CRYPTEQ
3062 goto COND_FAILED_NOT_COMPILED;
3064 if (strncmpic(sub[1], US"{md5}", 5) == 0)
3066 int sublen = Ustrlen(sub[1]+5);
3071 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3073 /* If the length that we are comparing against is 24, the MD5 digest
3074 is expressed as a base64 string. This is the way LDAP does it. However,
3075 some other software uses a straightforward hex representation. We assume
3076 this if the length is 32. Other lengths fail. */
3080 uschar *coded = b64encode(CUS digest, 16);
3081 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3082 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3083 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3085 else if (sublen == 32)
3088 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3090 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3091 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3092 tempcond = (strcmpic(coded, sub[1]+5) == 0);
3096 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3097 "fail\n crypted=%s\n", sub[1]+5);
3102 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3104 int sublen = Ustrlen(sub[1]+6);
3109 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3111 /* If the length that we are comparing against is 28, assume the SHA1
3112 digest is expressed as a base64 string. If the length is 40, assume a
3113 straightforward hex representation. Other lengths fail. */
3117 uschar *coded = b64encode(CUS digest, 20);
3118 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3119 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3120 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3122 else if (sublen == 40)
3125 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3127 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3128 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3129 tempcond = (strcmpic(coded, sub[1]+6) == 0);
3133 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3134 "fail\n crypted=%s\n", sub[1]+6);
3139 else /* {crypt} or {crypt16} and non-{ at start */
3140 /* }-for-text-editors */
3145 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3150 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3155 else if (sub[1][0] == '{') /* }-for-text-editors */
3157 expand_string_message = string_sprintf("unknown encryption mechanism "
3158 "in \"%s\"", sub[1]);
3164 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3165 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
3166 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3170 #define XSTR(s) STR(s)
3171 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3172 " subject=%s\n crypted=%s\n",
3173 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3178 /* If the encrypted string contains fewer than two characters (for the
3179 salt), force failure. Otherwise we get false positives: with an empty
3180 string the yield of crypt() is an empty string! */
3183 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3184 else if (errno == EINVAL)
3188 expand_string_message = string_sprintf("crypt error: %s\n",
3189 US strerror(errno));
3194 #endif /* SUPPORT_CRYPTEQ */
3199 const uschar * list = sub[1];
3201 uschar *save_iterate_item = iterate_item;
3202 int (*compare)(const uschar *, const uschar *);
3204 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);
3207 compare = cond_type == ECOND_INLISTI
3208 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3210 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3212 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3213 if (compare(sub[0], iterate_item) == 0)
3219 iterate_item = save_iterate_item;
3222 } /* Switch for comparison conditions */
3224 *yield = tempcond == testfor;
3225 return s; /* End of comparison conditions */
3228 /* and/or: computes logical and/or of several conditions */
3232 subcondptr = (yield == NULL) ? NULL : &tempcond;
3233 combined_cond = (cond_type == ECOND_AND);
3235 Uskip_whitespace(&s);
3236 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3240 /* {-for-text-editors */
3241 if (Uskip_whitespace(&s) == '}') break;
3242 if (*s != '{') /* }-for-text-editors */
3244 expand_string_message = string_sprintf("each subcondition "
3245 "inside an \"%s{...}\" condition must be in its own {}", opname);
3249 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3251 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3252 expand_string_message, opname);
3255 Uskip_whitespace(&s);
3257 /* {-for-text-editors */
3260 /* {-for-text-editors */
3261 expand_string_message = string_sprintf("missing } at end of condition "
3262 "inside \"%s\" group", opname);
3267 if (cond_type == ECOND_AND)
3269 combined_cond &= tempcond;
3270 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3271 } /* evaluate any more */
3274 combined_cond |= tempcond;
3275 if (combined_cond) subcondptr = NULL; /* once true, don't */
3276 } /* evaluate any more */
3279 if (yield) *yield = (combined_cond == testfor);
3283 /* forall/forany: iterates a condition with different values */
3285 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3286 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3287 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3288 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3289 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3290 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3294 const uschar * list;
3296 uschar *save_iterate_item = iterate_item;
3298 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3300 Uskip_whitespace(&s);
3301 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3302 if (!(sub[0] = expand_string_internal(s, TRUE, &s, yield == NULL, TRUE, resetok)))
3304 /* {-for-text-editors */
3305 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3307 Uskip_whitespace(&s);
3308 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3312 /* Call eval_condition once, with result discarded (as if scanning a
3313 "false" part). This allows us to find the end of the condition, because if
3314 the list it empty, we won't actually evaluate the condition for real. */
3316 if (!(s = eval_condition(sub[1], resetok, NULL)))
3318 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3319 expand_string_message, opname);
3322 Uskip_whitespace(&s);
3324 /* {-for-text-editors */
3327 /* {-for-text-editors */
3328 expand_string_message = string_sprintf("missing } at end of condition "
3329 "inside \"%s\"", opname);
3333 if (yield) *yield = !testfor;
3335 if (is_json) list = dewrap(string_copy(list), US"[]");
3336 while ((iterate_item = is_json
3337 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3340 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3342 expand_string_message =
3343 string_sprintf("%s wrapping string result for extract jsons",
3344 expand_string_message);
3345 iterate_item = save_iterate_item;
3349 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3350 if (!eval_condition(sub[1], resetok, &tempcond))
3352 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3353 expand_string_message, opname);
3354 iterate_item = save_iterate_item;
3357 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3358 tempcond? "true":"false");
3360 if (yield) *yield = (tempcond == testfor);
3361 if (tempcond == is_forany) break;
3364 iterate_item = save_iterate_item;
3369 /* The bool{} expansion condition maps a string to boolean.
3370 The values supported should match those supported by the ACL condition
3371 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3372 of true/false. Note that Router "condition" rules have a different
3373 interpretation, where general data can be used and only a few values
3375 Note that readconf.c boolean matching, for boolean configuration options,
3376 only matches true/yes/false/no.
3377 The bool_lax{} condition matches the Router logic, which is much more
3380 case ECOND_BOOL_LAX:
3386 BOOL boolvalue = FALSE;
3388 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3389 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3390 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3392 case 1: expand_string_message = string_sprintf(
3393 "too few arguments or bracketing error for %s",
3397 case 3: return NULL;
3400 Uskip_whitespace(&t);
3401 if ((len = Ustrlen(t)))
3403 /* trailing whitespace: seems like a good idea to ignore it too */
3405 while (isspace(*t2)) t2--;
3406 if (t2 != (t + len))
3413 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3414 /* logic for the lax case from expand_check_condition(), which also does
3415 expands, and the logic is both short and stable enough that there should
3416 be no maintenance burden from replicating it. */
3420 ? Ustrspn(t+1, "0123456789") == len-1
3421 : Ustrspn(t, "0123456789") == len)
3423 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3424 /* expand_check_condition only does a literal string "0" check */
3425 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3428 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3430 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3432 else if (cond_type == ECOND_BOOL_LAX)
3436 expand_string_message = string_sprintf("unrecognised boolean "
3440 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3441 boolvalue? "true":"false");
3442 if (yield) *yield = (boolvalue == testfor);
3447 case ECOND_INBOUND_SRS:
3448 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */
3455 BOOL boolvalue = FALSE;
3457 switch(read_subs(sub, 2, 2, CUSS &s, yield == NULL, FALSE, name, resetok))
3459 case 1: expand_string_message = US"too few arguments or bracketing "
3460 "error for inbound_srs";
3462 case 3: return NULL;
3465 /* Match the given local_part against the SRS-encoded pattern */
3467 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]+)=([^=]*)=(.*)$",
3469 if (pcre_exec(re, NULL, CS sub[0], Ustrlen(sub[0]), 0, PCRE_EOPT,
3470 ovec, nelem(ovec)) < 0)
3472 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3476 if (sub[0][0] == '"')
3478 else for (uschar * s = sub[0]; *s; s++)
3479 if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3480 { quoting = 1; break; }
3482 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3484 /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3486 srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S", /* lowercased */
3488 ovec[9]-ovec[8], sub[0] + ovec[8], /* substring 4 */
3490 ovec[7]-ovec[6], sub[0] + ovec[6]); /* substring 3 */
3492 /* If a zero-length secret was given, we're done. Otherwise carry on
3493 and validate the given SRS local_part againt our secret. */
3501 /* check the timestamp */
3504 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3507 gettimeofday(&now, NULL);
3508 now.tv_sec /= 86400; /* days since epoch */
3510 /* Decode substring 2 from base32 to a number */
3512 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3514 uschar * t = Ustrchr(base32_chars, *ss++);
3515 d = d * 32 + (t - base32_chars);
3518 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3520 DEBUG(D_expand) debug_printf("SRS too old\n");
3525 /* check length of substring 1, the offered checksum */
3527 if (ovec[3]-ovec[2] != 4)
3529 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3533 /* Hash the address with our secret, and compare that computed checksum
3534 with the one extracted from the arg */
3536 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3537 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3539 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3545 if (yield) *yield = (boolvalue == testfor);
3548 #endif /*SUPPORT_SRS*/
3550 /* Unknown condition */
3553 if (!expand_string_message || !*expand_string_message)
3554 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3556 } /* End switch on condition type */
3558 /* Missing braces at start and end of data */
3560 COND_FAILED_CURLY_START:
3561 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3564 COND_FAILED_CURLY_END:
3565 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3569 /* A condition requires code that is not compiled */
3571 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3572 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3573 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3574 COND_FAILED_NOT_COMPILED:
3575 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3584 /*************************************************
3585 * Save numerical variables *
3586 *************************************************/
3588 /* This function is called from items such as "if" that want to preserve and
3589 restore the numbered variables.
3592 save_expand_string points to an array of pointers to set
3593 save_expand_nlength points to an array of ints for the lengths
3595 Returns: the value of expand max to save
3599 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3601 for (int i = 0; i <= expand_nmax; i++)
3603 save_expand_nstring[i] = expand_nstring[i];
3604 save_expand_nlength[i] = expand_nlength[i];
3611 /*************************************************
3612 * Restore numerical variables *
3613 *************************************************/
3615 /* This function restored saved values of numerical strings.
3618 save_expand_nmax the number of strings to restore
3619 save_expand_string points to an array of pointers
3620 save_expand_nlength points to an array of ints
3626 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3627 int *save_expand_nlength)
3629 expand_nmax = save_expand_nmax;
3630 for (int i = 0; i <= expand_nmax; i++)
3632 expand_nstring[i] = save_expand_nstring[i];
3633 expand_nlength[i] = save_expand_nlength[i];
3641 /*************************************************
3642 * Handle yes/no substrings *
3643 *************************************************/
3645 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3646 alternative substrings that depend on whether or not the condition was true,
3647 or the lookup or extraction succeeded. The substrings always have to be
3648 expanded, to check their syntax, but "skipping" is set when the result is not
3649 needed - this avoids unnecessary nested lookups.
3652 skipping TRUE if we were skipping when this item was reached
3653 yes TRUE if the first string is to be used, else use the second
3654 save_lookup a value to put back into lookup_value before the 2nd expansion
3655 sptr points to the input string pointer
3656 yieldptr points to the output growable-string pointer
3657 type "lookup", "if", "extract", "run", "env", "listextract" or
3658 "certextract" for error message
3659 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3662 Returns: 0 OK; lookup_value has been reset to save_lookup
3664 2 expansion failed because of bracketing error
3668 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3669 gstring ** yieldptr, uschar *type, BOOL *resetok)
3672 const uschar *s = *sptr; /* Local value */
3673 uschar *sub1, *sub2;
3674 const uschar * errwhere;
3676 /* If there are no following strings, we substitute the contents of $value for
3677 lookups and for extractions in the success case. For the ${if item, the string
3678 "true" is substituted. In the fail case, nothing is substituted for all three
3681 if (skip_whitespace(&s) == '}')
3685 if (yes && !skipping)
3686 *yieldptr = string_catn(*yieldptr, US"true", 4);
3690 if (yes && lookup_value && !skipping)
3691 *yieldptr = string_cat(*yieldptr, lookup_value);
3692 lookup_value = save_lookup;
3698 /* The first following string must be braced. */
3702 errwhere = US"'yes' part did not start with '{'";
3706 /* Expand the first substring. Forced failures are noticed only if we actually
3707 want this string. Set skipping in the call in the fail case (this will always
3708 be the case if we were already skipping). */
3710 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3711 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3712 f.expand_string_forcedfail = FALSE;
3715 errwhere = US"'yes' part did not end with '}'";
3719 /* If we want the first string, add it to the output */
3722 *yieldptr = string_cat(*yieldptr, sub1);
3724 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3725 $value to what it was at the start of the item, so that it has this value
3726 during the second string expansion. For the call from "if" or "run" to this
3727 function, save_lookup is set to lookup_value, so that this statement does
3730 lookup_value = save_lookup;
3732 /* There now follows either another substring, or "fail", or nothing. This
3733 time, forced failures are noticed only if we want the second string. We must
3734 set skipping in the nested call if we don't want this string, or if we were
3735 already skipping. */
3737 if (skip_whitespace(&s) == '{')
3739 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3740 if (sub2 == NULL && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3741 f.expand_string_forcedfail = FALSE;
3744 errwhere = US"'no' part did not start with '{'";
3748 /* If we want the second string, add it to the output */
3751 *yieldptr = string_cat(*yieldptr, sub2);
3754 /* If there is no second string, but the word "fail" is present when the use of
3755 the second string is wanted, set a flag indicating it was a forced failure
3756 rather than a syntactic error. Swallow the terminating } in case this is nested
3757 inside another lookup or if or extract. */
3762 /* deconst cast ok here as source is s anyway */
3763 s = US read_name(name, sizeof(name), s, US"_");
3764 if (Ustrcmp(name, "fail") == 0)
3766 if (!yes && !skipping)
3768 Uskip_whitespace(&s);
3771 errwhere = US"did not close with '}' after forcedfail";
3774 expand_string_message =
3775 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3776 f.expand_string_forcedfail = TRUE;
3782 expand_string_message =
3783 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3788 /* All we have to do now is to check on the final closing brace. */
3790 skip_whitespace(&s);
3793 errwhere = US"did not close with '}'";
3799 /* Update the input pointer value before returning */
3804 /* Get here if there is a bracketing failure */
3805 expand_string_message = string_sprintf(
3806 "curly-bracket problem in conditional yes/no parsing: %s\n"
3807 " remaining string is '%s'", errwhere, --s);
3812 /* Get here for other failures */
3820 /********************************************************
3821 * prvs: Get last three digits of days since Jan 1, 1970 *
3822 ********************************************************/
3824 /* This is needed to implement the "prvs" BATV reverse
3827 Argument: integer "days" offset to add or substract to
3828 or from the current number of days.
3830 Returns: pointer to string containing the last three
3831 digits of the number of days since Jan 1, 1970,
3832 modified by the offset argument, NULL if there
3833 was an error in the conversion.
3838 prvs_daystamp(int day_offset)
3840 uschar *days = store_get(32, FALSE); /* Need at least 24 for cases */
3841 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3842 (time(NULL) + day_offset*86400)/86400);
3843 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3848 /********************************************************
3849 * prvs: perform HMAC-SHA1 computation of prvs bits *
3850 ********************************************************/
3852 /* This is needed to implement the "prvs" BATV reverse
3856 address RFC2821 Address to use
3857 key The key to use (must be less than 64 characters
3859 key_num Single-digit key number to use. Defaults to
3862 Returns: pointer to string containing the first three
3863 bytes of the final hash in hex format, NULL if
3864 there was an error in the process.
3868 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3870 gstring * hash_source;
3873 uschar innerhash[20];
3874 uschar finalhash[20];
3875 uschar innerkey[64];
3876 uschar outerkey[64];
3877 uschar *finalhash_hex;
3882 if (Ustrlen(key) > 64)
3885 hash_source = string_catn(NULL, key_num, 1);
3886 hash_source = string_catn(hash_source, daystamp, 3);
3887 hash_source = string_cat(hash_source, address);
3888 (void) string_from_gstring(hash_source);
3891 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3893 memset(innerkey, 0x36, 64);
3894 memset(outerkey, 0x5c, 64);
3896 for (int i = 0; i < Ustrlen(key); i++)
3898 innerkey[i] ^= key[i];
3899 outerkey[i] ^= key[i];
3902 chash_start(HMAC_SHA1, &h);
3903 chash_mid(HMAC_SHA1, &h, innerkey);
3904 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3906 chash_start(HMAC_SHA1, &h);
3907 chash_mid(HMAC_SHA1, &h, outerkey);
3908 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3910 /* Hashing is deemed sufficient to de-taint any input data */
3912 p = finalhash_hex = store_get(40, FALSE);
3913 for (int i = 0; i < 3; i++)
3915 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3916 *p++ = hex_digits[finalhash[i] & 0x0f];
3920 return finalhash_hex;
3926 /*************************************************
3927 * Join a file onto the output string *
3928 *************************************************/
3930 /* This is used for readfile/readsock and after a run expansion.
3931 It joins the contents of a file onto the output string, globally replacing
3932 newlines with a given string (optionally).
3936 yield pointer to the expandable string struct
3937 eol newline replacement string, or NULL
3939 Returns: new pointer for expandable string, terminated if non-null
3943 cat_file(FILE *f, gstring *yield, uschar *eol)
3945 uschar buffer[1024];
3947 while (Ufgets(buffer, sizeof(buffer), f))
3949 int len = Ustrlen(buffer);
3950 if (eol && buffer[len-1] == '\n') len--;
3951 yield = string_catn(yield, buffer, len);
3952 if (eol && buffer[len])
3953 yield = string_cat(yield, eol);
3956 (void) string_from_gstring(yield);
3963 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
3966 uschar buffer[1024];
3968 /*XXX could we read direct into a pre-grown string? */
3970 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
3971 for (uschar * s = buffer; rc--; s++)
3972 yield = eol && *s == '\n'
3973 ? string_cat(yield, eol) : string_catn(yield, s, 1);
3975 /* We assume that all errors, and any returns of zero bytes,
3976 are actually EOF. */
3978 (void) string_from_gstring(yield);
3984 /*************************************************
3985 * Evaluate numeric expression *
3986 *************************************************/
3988 /* This is a set of mutually recursive functions that evaluate an arithmetic
3989 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3990 these functions that is called from elsewhere is eval_expr, whose interface is:
3993 sptr pointer to the pointer to the string - gets updated
3994 decimal TRUE if numbers are to be assumed decimal
3995 error pointer to where to put an error message - must be NULL on input
3996 endket TRUE if ')' must terminate - FALSE for external call
3998 Returns: on success: the value of the expression, with *error still NULL
3999 on failure: an undefined value, with *error = a message
4002 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4005 static int_eximarith_t
4006 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4009 int_eximarith_t x = eval_op_or(&s, decimal, error);
4014 *error = US"expecting closing parenthesis";
4016 while (isspace(*++s));
4018 *error = US"expecting operator";
4024 static int_eximarith_t
4025 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4031 if (isdigit((c = Uskip_whitespace(&s))))
4034 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4036 switch (tolower(*s))
4039 case 'k': n *= 1024; s++; break;
4040 case 'm': n *= 1024*1024; s++; break;
4041 case 'g': n *= 1024*1024*1024; s++; break;
4043 Uskip_whitespace(&s);
4048 n = eval_expr(&s, decimal, error, 1);
4052 *error = US"expecting number or opening parenthesis";
4060 static int_eximarith_t
4061 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4065 Uskip_whitespace(&s);
4066 if (*s == '+' || *s == '-' || *s == '~')
4069 x = eval_op_unary(&s, decimal, error);
4070 if (op == '-') x = -x;
4071 else if (op == '~') x = ~x;
4074 x = eval_number(&s, decimal, error);
4081 static int_eximarith_t
4082 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4085 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4088 while (*s == '*' || *s == '/' || *s == '%')
4091 int_eximarith_t y = eval_op_unary(&s, decimal, error);
4093 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4094 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4095 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4096 * -N*M is INT_MIN will yield INT_MIN.
4097 * Since we don't support floating point, this is somewhat simpler.
4098 * Ideally, we'd return an error, but since we overflow for all other
4099 * arithmetic, consistency suggests otherwise, but what's the correct value
4100 * to use? There is none.
4101 * The C standard guarantees overflow for unsigned arithmetic but signed
4102 * overflow invokes undefined behaviour; in practice, this is overflow
4103 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4104 * that long/longlong larger than int are available, or we could just work
4105 * with larger types. We should consider whether to guarantee 32bit eval
4106 * and 64-bit working variables, with errors returned. For now ...
4107 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4108 * can just let the other invalid results occur otherwise, as they have
4109 * until now. For this one case, we can coerce.
4111 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4114 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4115 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4125 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4141 static int_eximarith_t
4142 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4145 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4148 while (*s == '+' || *s == '-')
4151 int_eximarith_t y = eval_op_mult(&s, decimal, error);
4153 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4154 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4155 { /* over-conservative check */
4157 ? US"overflow in sum" : US"overflow in difference";
4160 if (op == '+') x += y; else x -= y;
4168 static int_eximarith_t
4169 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4172 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4175 while ((*s == '<' || *s == '>') && s[1] == s[0])
4180 y = eval_op_sum(&s, decimal, error);
4182 if (op == '<') x <<= y; else x >>= y;
4190 static int_eximarith_t
4191 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4194 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4201 y = eval_op_shift(&s, decimal, error);
4211 static int_eximarith_t
4212 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4215 int_eximarith_t x = eval_op_and(&s, decimal, error);
4222 y = eval_op_and(&s, decimal, error);
4232 static int_eximarith_t
4233 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4236 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4243 y = eval_op_xor(&s, decimal, error);
4254 /************************************************/
4255 /* Comparison operation for sort expansion. We need to avoid
4256 re-expanding the fields being compared, so need a custom routine.
4259 cond_type Comparison operator code
4260 leftarg, rightarg Arguments for comparison
4262 Return true iff (leftarg compare rightarg)
4266 sortsbefore(int cond_type, BOOL alpha_cond,
4267 const uschar * leftarg, const uschar * rightarg)
4269 int_eximarith_t l_num, r_num;
4273 l_num = expanded_string_integer(leftarg, FALSE);
4274 if (expand_string_message) return FALSE;
4275 r_num = expanded_string_integer(rightarg, FALSE);
4276 if (expand_string_message) return FALSE;
4280 case ECOND_NUM_G: return l_num > r_num;
4281 case ECOND_NUM_GE: return l_num >= r_num;
4282 case ECOND_NUM_L: return l_num < r_num;
4283 case ECOND_NUM_LE: return l_num <= r_num;
4290 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4291 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4292 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4293 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4294 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4295 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4296 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4297 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4300 return FALSE; /* should not happen */
4304 /* Expand a named list. Return false on failure. */
4306 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4308 tree_node *t = NULL;
4309 const uschar * list;
4312 uschar * suffix = US"";
4313 BOOL needsep = FALSE;
4314 #define LISTNAMED_BUF_SIZE 256
4315 uschar b[LISTNAMED_BUF_SIZE];
4316 uschar * buffer = b;
4318 if (*name == '+') name++;
4319 if (!listtype) /* no-argument version */
4321 if ( !(t = tree_search(addresslist_anchor, name))
4322 && !(t = tree_search(domainlist_anchor, name))
4323 && !(t = tree_search(hostlist_anchor, name)))
4324 t = tree_search(localpartlist_anchor, name);
4326 else switch(*listtype) /* specific list-type version */
4328 case 'a': t = tree_search(addresslist_anchor, name); suffix = US"_a"; break;
4329 case 'd': t = tree_search(domainlist_anchor, name); suffix = US"_d"; break;
4330 case 'h': t = tree_search(hostlist_anchor, name); suffix = US"_h"; break;
4331 case 'l': t = tree_search(localpartlist_anchor, name); suffix = US"_l"; break;
4333 expand_string_message = US"bad suffix on \"list\" operator";
4339 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4341 : *listtype=='a'?"address "
4342 : *listtype=='d'?"domain "
4343 : *listtype=='h'?"host "
4344 : *listtype=='l'?"localpart "
4349 list = ((namedlist_block *)(t->data.ptr))->string;
4351 /* The list could be quite long so we (re)use a buffer for each element
4352 rather than getting each in new memory */
4354 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, TRUE);
4355 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4357 uschar * buf = US" : ";
4359 yield = string_catn(yield, buf, 3);
4363 if (*item == '+') /* list item is itself a named list */
4365 yield = expand_listnamed(yield, item, listtype);
4366 if (expand_string_message)
4370 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
4373 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4375 for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4377 yield = string_catn(yield, item, cp - CS item);
4378 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4379 yield = string_catn(yield, US"::", 2);
4380 else /* sep in item; should already be doubled; emit once */
4382 yield = string_catn(yield, US tok, 1);
4383 if (*cp == sep) cp++;
4386 yield = string_cat(yield, item);
4389 yield = string_cat(yield, item);
4396 /*************************************************
4398 *************************************************/
4400 /* Returns either an unchanged string, or the expanded string in stacking pool
4401 store. Interpreted sequences are:
4403 \... normal escaping rules
4404 $name substitutes the variable
4406 ${op:string} operates on the expanded string value
4407 ${item{arg1}{arg2}...} expands the args and then does the business
4408 some literal args are not enclosed in {}
4410 There are now far too many operators and item types to make it worth listing
4411 them here in detail any more.
4413 We use an internal routine recursively to handle embedded substrings. The
4414 external function follows. The yield is NULL if the expansion failed, and there
4415 are two cases: if something collapsed syntactically, or if "fail" was given
4416 as the action on a lookup failure. These can be distinguished by looking at the
4417 variable expand_string_forcedfail, which is TRUE in the latter case.
4419 The skipping flag is set true when expanding a substring that isn't actually
4420 going to be used (after "if" or "lookup") and it prevents lookups from
4421 happening lower down.
4423 Store usage: At start, a store block of the length of the input plus 64
4424 is obtained. This is expanded as necessary by string_cat(), which might have to
4425 get a new block, or might be able to expand the original. At the end of the
4426 function we can release any store above that portion of the yield block that
4427 was actually used. In many cases this will be optimal.
4429 However: if the first item in the expansion is a variable name or header name,
4430 we reset the store before processing it; if the result is in fresh store, we
4431 use that without copying. This is helpful for expanding strings like
4432 $message_headers which can get very long.
4434 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4435 since resetting the store at the end of the expansion will free store that was
4436 allocated by the plugin code as well as the slop after the expanded string. So
4437 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4438 and, given the acl condition, ${if }. This is an unfortunate consequence of
4439 string expansion becoming too powerful.
4442 string the string to be expanded
4443 ket_ends true if expansion is to stop at }
4444 left if not NULL, a pointer to the first character after the
4445 expansion is placed here (typically used with ket_ends)
4446 skipping TRUE for recursive calls when the value isn't actually going
4447 to be used (to allow for optimisation)
4448 honour_dollar TRUE if $ is to be expanded,
4449 FALSE if it's just another character
4450 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4453 Returns: NULL if expansion fails:
4454 expand_string_forcedfail is set TRUE if failure was forced
4455 expand_string_message contains a textual error message
4456 a pointer to the expanded string on success
4460 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
4461 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
4463 rmark reset_point = store_mark();
4464 gstring * yield = string_get(Ustrlen(string) + 64);
4466 const uschar *s = string;
4467 uschar *save_expand_nstring[EXPAND_MAXN+1];
4468 int save_expand_nlength[EXPAND_MAXN+1];
4469 BOOL resetok = TRUE;
4474 debug_printf_indent("/%s: %s\n",
4475 skipping ? "---scanning" : "considering", string);
4477 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
4479 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4483 f.expand_string_forcedfail = FALSE;
4484 expand_string_message = US"";
4486 if (is_tainted(string))
4488 expand_string_message =
4489 string_sprintf("attempt to expand tainted string '%s'", s);
4490 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4499 /* \ escapes the next character, which must exist, or else
4500 the expansion fails. There's a special escape, \N, which causes
4501 copying of the subject verbatim up to the next \N. Otherwise,
4502 the escapes are the standard set. */
4508 expand_string_message = US"\\ at end of string";
4514 const uschar * t = s + 2;
4515 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
4516 yield = string_catn(yield, t, s - t);
4517 if (*s != 0) s += 2;
4523 ch[0] = string_interpret_escape(&s);
4525 yield = string_catn(yield, ch, 1);
4532 /* Anything other than $ is just copied verbatim, unless we are
4533 looking for a terminating } character. */
4536 if (ket_ends && *s == '}') break;
4538 if (*s != '$' || !honour_dollar)
4540 yield = string_catn(yield, s++, 1);
4544 /* No { after the $ - must be a plain name or a number for string
4545 match variable. There has to be a fudge for variables that are the
4546 names of header fields preceded by "$header_" because header field
4547 names can contain any printing characters except space and colon.
4548 For those that don't like typing this much, "$h_" is a synonym for
4549 "$header_". A non-existent header yields a NULL value; nothing is
4552 if (isalpha((*(++s))))
4559 s = read_name(name, sizeof(name), s, US"_");
4561 /* If this is the first thing to be expanded, release the pre-allocated
4565 g = store_get(sizeof(gstring), FALSE);
4566 else if (yield->ptr == 0)
4568 if (resetok) reset_point = store_reset(reset_point);
4570 reset_point = store_mark();
4571 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
4576 if ( ( *(t = name) == 'h'
4577 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4579 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4582 unsigned flags = *name == 'r' ? FH_WANT_RAW
4583 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4585 uschar * charset = *name == 'b' ? NULL : headers_charset;
4587 s = read_header_name(name, sizeof(name), s);
4588 value = find_header(name, &newsize, flags, charset);
4590 /* If we didn't find the header, and the header contains a closing brace
4591 character, this may be a user error where the terminating colon
4592 has been omitted. Set a flag to adjust the error message in this case.
4593 But there is no error here - nothing gets inserted. */
4597 if (Ustrchr(name, '}')) malformed_header = TRUE;
4604 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4606 expand_string_message =
4607 string_sprintf("unknown variable name \"%s\"", name);
4608 check_variable_error_message(name);
4612 /* If the data is known to be in a new buffer, newsize will be set to the
4613 size of that buffer. If this is the first thing in an expansion string,
4614 yield will be NULL; just point it at the new store instead of copying. Many
4615 expansion strings contain just one reference, so this is a useful
4616 optimization, especially for humungous headers. We need to use a gstring
4617 structure that is not allocated after that new-buffer, else a later store
4618 reset in the middle of the buffer will make it inaccessible. */
4620 len = Ustrlen(value);
4621 if (!yield && newsize != 0)
4624 yield->size = newsize;
4629 yield = string_catn(yield, value, len);
4637 s = read_cnumber(&n, s);
4638 if (n >= 0 && n <= expand_nmax)
4639 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4643 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4645 if (*s != '{') /*}*/
4647 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4651 /* After { there can be various things, but they all start with
4652 an initial word, except for a number for a string match variable. */
4654 if (isdigit((*(++s))))
4657 s = read_cnumber(&n, s); /*{*/
4660 expand_string_message = US"} expected after number";
4663 if (n >= 0 && n <= expand_nmax)
4664 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4670 expand_string_message = US"letter or digit expected after ${"; /*}*/
4674 /* Allow "-" in names to cater for substrings with negative
4675 arguments. Since we are checking for known names after { this is
4678 s = read_name(name, sizeof(name), s, US"_-");
4679 item_type = chop_match(name, item_table, nelem(item_table));
4683 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4684 If the ACL returns accept or reject we return content set by "message ="
4685 There is currently no limit on recursion; this would have us call
4686 acl_check_internal() directly and get a current level from somewhere.
4687 See also the acl expansion condition ECOND_ACL and the traditional
4688 acl modifier ACLC_ACL.
4689 Assume that the function has side-effects on the store that must be preserved.
4693 /* ${acl {name} {arg1}{arg2}...} */
4695 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4699 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, name,
4702 case 1: goto EXPAND_FAILED_CURLY;
4704 case 3: goto EXPAND_FAILED;
4706 if (skipping) continue;
4709 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4714 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4716 yield = string_cat(yield, user_msg);
4720 f.expand_string_forcedfail = TRUE;
4723 expand_string_message = string_sprintf("%s from acl \"%s\"",
4724 rc_names[rc], sub[0]);
4729 case EITEM_AUTHRESULTS:
4730 /* ${authresults {mysystemname}} */
4734 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4737 case 1: goto EXPAND_FAILED_CURLY;
4739 case 3: goto EXPAND_FAILED;
4742 yield = string_append(yield, 3,
4743 US"Authentication-Results: ", sub_arg[0], US"; none");
4746 yield = authres_local(yield, sub_arg[0]);
4747 yield = authres_iprev(yield);
4748 yield = authres_smtpauth(yield);
4750 yield = authres_spf(yield);
4752 #ifndef DISABLE_DKIM
4753 yield = authres_dkim(yield);
4755 #ifdef SUPPORT_DMARC
4756 yield = authres_dmarc(yield);
4758 #ifdef EXPERIMENTAL_ARC
4759 yield = authres_arc(yield);
4764 /* Handle conditionals - preserve the values of the numerical expansion
4765 variables in case they get changed by a regular expression match in the
4766 condition. If not, they retain their external settings. At the end
4767 of this "if" section, they get restored to their previous values. */
4772 const uschar *next_s;
4773 int save_expand_nmax =
4774 save_expand_strings(save_expand_nstring, save_expand_nlength);
4776 Uskip_whitespace(&s);
4777 if (!(next_s = eval_condition(s, &resetok, skipping ? NULL : &cond)))
4778 goto EXPAND_FAILED; /* message already set */
4783 debug_printf_indent("|--condition: %.*s\n", (int)(next_s - s), s);
4784 debug_printf_indent("|-----result: %s\n", cond ? "true" : "false");
4788 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4789 "condition: %.*s\n",
4790 (int)(next_s - s), s);
4791 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4792 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4794 cond ? "true" : "false");
4799 /* The handling of "yes" and "no" result strings is now in a separate
4800 function that is also used by ${lookup} and ${extract} and ${run}. */
4802 switch(process_yesno(
4803 skipping, /* were previously skipping */
4804 cond, /* success/failure indicator */
4805 lookup_value, /* value to reset for string2 */
4806 &s, /* input pointer */
4807 &yield, /* output pointer */
4808 US"if", /* condition type */
4811 case 1: goto EXPAND_FAILED; /* when all is well, the */
4812 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4815 /* Restore external setting of expansion variables for continuation
4818 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4819 save_expand_nlength);
4824 case EITEM_IMAPFOLDER:
4825 { /* ${imapfolder {name}{sep]{specials}} */
4829 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4832 case 1: goto EXPAND_FAILED_CURLY;
4834 case 3: goto EXPAND_FAILED;
4837 if (!sub_arg[1]) /* One argument */
4839 sub_arg[1] = US"/"; /* default separator */
4842 else if (Ustrlen(sub_arg[1]) != 1)
4844 expand_string_message =
4846 "IMAP folder separator must be one character, found \"%s\"",
4853 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4854 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4856 yield = string_cat(yield, encoded);
4862 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4863 expanding an internal string that isn't actually going to be used. All we
4864 need to do is check the syntax, so don't do a lookup at all. Preserve the
4865 values of the numerical expansion variables in case they get changed by a
4866 partial lookup. If not, they retain their external settings. At the end
4867 of this "lookup" section, they get restored to their previous values. */
4871 int stype, partial, affixlen, starflags;
4872 int expand_setup = 0;
4874 uschar *key, *filename;
4875 const uschar * affix, * opts;
4876 uschar *save_lookup_value = lookup_value;
4877 int save_expand_nmax =
4878 save_expand_strings(save_expand_nstring, save_expand_nlength);
4880 if (expand_forbid & RDO_LOOKUP)
4882 expand_string_message = US"lookup expansions are not permitted";
4886 /* Get the key we are to look up for single-key+file style lookups.
4887 Otherwise set the key NULL pro-tem. */
4889 if (Uskip_whitespace(&s) == '{') /*}*/
4891 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4892 if (!key) goto EXPAND_FAILED; /*{{*/
4895 expand_string_message = US"missing '}' after lookup key";
4896 goto EXPAND_FAILED_CURLY;
4898 Uskip_whitespace(&s);
4902 /* Find out the type of database */
4906 expand_string_message = US"missing lookup type";
4910 /* The type is a string that may contain special characters of various
4911 kinds. Allow everything except space or { to appear; the actual content
4912 is checked by search_findtype_partial. */ /*}*/
4914 while (*s && *s != '{' && !isspace(*s)) /*}*/
4916 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4919 name[nameptr] = '\0';
4920 Uskip_whitespace(&s);
4922 /* Now check for the individual search type and any partial or default
4923 options. Only those types that are actually in the binary are valid. */
4925 if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4926 &starflags, &opts)) < 0)
4928 expand_string_message = search_error_message;
4932 /* Check that a key was provided for those lookup types that need it,
4933 and was not supplied for those that use the query style. */
4935 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4939 expand_string_message = string_sprintf("missing {key} for single-"
4940 "key \"%s\" lookup", name);
4948 expand_string_message = string_sprintf("a single key was given for "
4949 "lookup type \"%s\", which is not a single-key lookup type", name);
4954 /* Get the next string in brackets and expand it. It is the file name for
4955 single-key+file lookups, and the whole query otherwise. In the case of
4956 queries that also require a file name (e.g. sqlite), the file name comes
4961 expand_string_message = US"missing '{' for lookup file-or-query arg";
4962 goto EXPAND_FAILED_CURLY;
4964 if (!(filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
4968 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4969 goto EXPAND_FAILED_CURLY;
4971 Uskip_whitespace(&s);
4973 /* If this isn't a single-key+file lookup, re-arrange the variables
4974 to be appropriate for the search_ functions. For query-style lookups,
4975 there is just a "key", and no file name. For the special query-style +
4976 file types, the query (i.e. "key") starts with a file name. */
4979 key = search_args(stype, name, filename, &filename, opts);
4981 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4982 the entry was not found. Note that there is no search_close() function.
4983 Files are left open in case of re-use. At suitable places in higher logic,
4984 search_tidyup() is called to tidy all open files. This can save opening
4985 the same file several times. However, files may also get closed when
4986 others are opened, if too many are open at once. The rule is that a
4987 handle should not be used after a second search_open().
4989 Request that a partial search sets up $1 and maybe $2 by passing
4990 expand_setup containing zero. If its value changes, reset expand_nmax,
4991 since new variables will have been set. Note that at the end of this
4992 "lookup" section, the old numeric variables are restored. */
4995 lookup_value = NULL;
4998 void *handle = search_open(filename, stype, 0, NULL, NULL);
5001 expand_string_message = search_error_message;
5004 lookup_value = search_find(handle, filename, key, partial, affix,
5005 affixlen, starflags, &expand_setup, opts);
5006 if (f.search_find_defer)
5008 expand_string_message =
5009 string_sprintf("lookup of \"%s\" gave DEFER: %s",
5010 string_printing2(key, SP_TAB), search_error_message);
5013 if (expand_setup > 0) expand_nmax = expand_setup;
5016 /* The handling of "yes" and "no" result strings is now in a separate
5017 function that is also used by ${if} and ${extract}. */
5019 switch(process_yesno(
5020 skipping, /* were previously skipping */
5021 lookup_value != NULL, /* success/failure indicator */
5022 save_lookup_value, /* value to reset for string2 */
5023 &s, /* input pointer */
5024 &yield, /* output pointer */
5025 US"lookup", /* condition type */
5028 case 1: goto EXPAND_FAILED; /* when all is well, the */
5029 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5032 /* Restore external setting of expansion variables for carrying on
5033 at this level, and continue. */
5035 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5036 save_expand_nlength);
5040 /* If Perl support is configured, handle calling embedded perl subroutines,
5041 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5042 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5043 arguments (defined below). */
5045 #define EXIM_PERL_MAX_ARGS 8
5049 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
5050 "is not included in this binary";
5053 #else /* EXIM_PERL */
5055 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
5058 if ((expand_forbid & RDO_PERL) != 0)
5060 expand_string_message = US"Perl calls are not permitted";
5064 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
5067 case 1: goto EXPAND_FAILED_CURLY;
5069 case 3: goto EXPAND_FAILED;
5072 /* If skipping, we don't actually do anything */
5074 if (skipping) continue;
5076 /* Start the interpreter if necessary */
5078 if (!opt_perl_started)
5081 if (!opt_perl_startup)
5083 expand_string_message = US"A setting of perl_startup is needed when "
5084 "using the Perl interpreter";
5087 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5088 if ((initerror = init_perl(opt_perl_startup)))
5090 expand_string_message =
5091 string_sprintf("error in perl_startup code: %s\n", initerror);
5094 opt_perl_started = TRUE;
5097 /* Call the function */
5099 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5100 new_yield = call_perl_cat(yield, &expand_string_message,
5101 sub_arg[0], sub_arg + 1);
5103 /* NULL yield indicates failure; if the message pointer has been set to
5104 NULL, the yield was undef, indicating a forced failure. Otherwise the
5105 message will indicate some kind of Perl error. */
5109 if (!expand_string_message)
5111 expand_string_message =
5112 string_sprintf("Perl subroutine \"%s\" returned undef to force "
5113 "failure", sub_arg[0]);
5114 f.expand_string_forcedfail = TRUE;
5119 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5120 set during a callback from Perl. */
5122 f.expand_string_forcedfail = FALSE;
5126 #endif /* EXIM_PERL */
5128 /* Transform email address to "prvs" scheme to use
5129 as BATV-signed return path */
5136 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, name, &resetok))
5138 case 1: goto EXPAND_FAILED_CURLY;
5140 case 3: goto EXPAND_FAILED;
5143 /* If skipping, we don't actually do anything */
5144 if (skipping) continue;
5146 /* sub_arg[0] is the address */
5147 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
5148 || domain == sub_arg[0] || Ustrlen(domain) == 1)
5150 expand_string_message = US"prvs first argument must be a qualified email address";
5154 /* Calculate the hash. The third argument must be a single-digit
5155 key number, or unset. */
5158 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5160 expand_string_message = US"prvs third argument must be a single digit";
5164 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5167 expand_string_message = US"prvs hmac-sha1 conversion failed";
5171 /* Now separate the domain from the local part */
5174 yield = string_catn(yield, US"prvs=", 5);
5175 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5176 yield = string_catn(yield, prvs_daystamp(7), 3);
5177 yield = string_catn(yield, p, 6);
5178 yield = string_catn(yield, US"=", 1);
5179 yield = string_cat (yield, sub_arg[0]);
5180 yield = string_catn(yield, US"@", 1);
5181 yield = string_cat (yield, domain);
5186 /* Check a prvs-encoded address for validity */
5188 case EITEM_PRVSCHECK:
5195 /* TF: Ugliness: We want to expand parameter 1 first, then set
5196 up expansion variables that are used in the expansion of
5197 parameter 2. So we clone the string for the first
5198 expansion, where we only expand parameter 1.
5200 PH: Actually, that isn't necessary. The read_subs() function is
5201 designed to work this way for the ${if and ${lookup expansions. I've
5205 /* Reset expansion variables */
5206 prvscheck_result = NULL;
5207 prvscheck_address = NULL;
5208 prvscheck_keynum = NULL;
5210 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, name, &resetok))
5212 case 1: goto EXPAND_FAILED_CURLY;
5214 case 3: goto EXPAND_FAILED;
5217 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5220 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5222 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5223 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5224 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5225 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5226 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5228 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
5229 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
5230 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5231 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
5232 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
5234 /* Set up expansion variables */
5235 g = string_cat (NULL, local_part);
5236 g = string_catn(g, US"@", 1);
5237 g = string_cat (g, domain);
5238 prvscheck_address = string_from_gstring(g);
5239 prvscheck_keynum = string_copy(key_num);
5241 /* Now expand the second argument */
5242 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, name, &resetok))
5244 case 1: goto EXPAND_FAILED_CURLY;
5246 case 3: goto EXPAND_FAILED;
5249 /* Now we have the key and can check the address. */
5251 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5256 expand_string_message = US"hmac-sha1 conversion failed";
5260 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5261 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
5263 if (Ustrcmp(p,hash) == 0)
5265 /* Success, valid BATV address. Now check the expiry date. */
5266 uschar *now = prvs_daystamp(0);
5267 unsigned int inow = 0,iexpire = 1;
5269 (void)sscanf(CS now,"%u",&inow);
5270 (void)sscanf(CS daystamp,"%u",&iexpire);
5272 /* When "iexpire" is < 7, a "flip" has occurred.
5273 Adjust "inow" accordingly. */
5274 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5276 if (iexpire >= inow)
5278 prvscheck_result = US"1";
5279 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
5283 prvscheck_result = NULL;
5284 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
5289 prvscheck_result = NULL;
5290 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
5293 /* Now expand the final argument. We leave this till now so that
5294 it can include $prvscheck_result. */
5296 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, name, &resetok))
5298 case 1: goto EXPAND_FAILED_CURLY;
5300 case 3: goto EXPAND_FAILED;
5303 yield = string_cat(yield,
5304 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5306 /* Reset the "internal" variables afterwards, because they are in
5307 dynamic store that will be reclaimed if the expansion succeeded. */
5309 prvscheck_address = NULL;
5310 prvscheck_keynum = NULL;
5313 /* Does not look like a prvs encoded address, return the empty string.
5314 We need to make sure all subs are expanded first, so as to skip over
5317 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, name, &resetok))
5319 case 1: goto EXPAND_FAILED_CURLY;
5321 case 3: goto EXPAND_FAILED;
5327 /* Handle "readfile" to insert an entire file */
5329 case EITEM_READFILE:
5334 if ((expand_forbid & RDO_READFILE) != 0)
5336 expand_string_message = US"file insertions are not permitted";
5340 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, name, &resetok))
5342 case 1: goto EXPAND_FAILED_CURLY;
5344 case 3: goto EXPAND_FAILED;
5347 /* If skipping, we don't actually do anything */
5349 if (skipping) continue;
5351 /* Open the file and read it */
5353 if (!(f = Ufopen(sub_arg[0], "rb")))
5355 expand_string_message = string_open_failed("%s", sub_arg[0]);
5359 yield = cat_file(f, yield, sub_arg[1]);
5364 /* Handle "readsocket" to insert data from a socket, either
5365 Inet or Unix domain */
5367 case EITEM_READSOCK:
5370 uschar * sub_arg[4];
5372 if (expand_forbid & RDO_READSOCK)
5374 expand_string_message = US"socket insertions are not permitted";
5378 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5379 because there may be a string for expansion on failure. */
5381 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, name, &resetok))
5383 case 1: goto EXPAND_FAILED_CURLY;
5384 case 2: /* Won't occur: no end check */
5385 case 3: goto EXPAND_FAILED;
5388 /* If skipping, we don't actually do anything. Otherwise, arrange to
5389 connect to either an IP or a Unix socket. */
5393 int stype = search_findtype(US"readsock", 8);
5396 int expand_setup = -1;
5399 /* If the reqstr is empty, flag that and set a dummy */
5403 g = string_append_listele(g, ',', US"send=no");
5404 sub_arg[1] = US"DUMMY";
5407 /* Re-marshall the options */
5411 const uschar * list = sub_arg[2];
5415 /* First option has no tag and is timeout */
5416 if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5417 g = string_append_listele(g, ',',
5418 string_sprintf("timeout=%s", item));
5420 /* The rest of the options from the expansion */
5421 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5422 g = string_append_listele(g, ',', item);
5424 /* possibly plus an EOL string. Process with escapes, to protect
5425 from list-processing. The only current user of eol= in search
5426 options is the readsock expansion. */
5428 if (sub_arg[3] && *sub_arg[3])
5429 g = string_append_listele(g, ',',
5430 string_sprintf("eol=%s",
5431 string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5434 /* Gat a (possibly cached) handle for the connection */
5436 if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5438 if (*expand_string_message) goto EXPAND_FAILED;
5439 expand_string_message = search_error_message;
5440 search_error_message = NULL;
5444 /* Get (possibly cached) results for the lookup */
5445 /* sspec: sub_arg[0] req: sub_arg[1] opts: g */
5447 if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5448 &expand_setup, string_from_gstring(g))))
5449 yield = string_cat(yield, s);
5450 else if (f.search_find_defer)
5452 expand_string_message = search_error_message;
5453 search_error_message = NULL;
5457 { /* should not happen, at present */
5458 expand_string_message = search_error_message;
5459 search_error_message = NULL;
5464 /* The whole thing has worked (or we were skipping). If there is a
5465 failure string following, we need to skip it. */
5469 if (!expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok))
5473 expand_string_message = US"missing '}' closing failstring for readsocket";
5474 goto EXPAND_FAILED_CURLY;
5476 Uskip_whitespace(&s);
5482 expand_string_message = US"missing '}' closing readsocket";
5483 goto EXPAND_FAILED_CURLY;
5487 /* Come here on failure to create socket, connect socket, write to the
5488 socket, or timeout on reading. If another substring follows, expand and
5489 use it. Otherwise, those conditions give expand errors. */
5492 if (*s != '{') goto EXPAND_FAILED;
5493 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5494 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5496 yield = string_cat(yield, arg);
5499 expand_string_message = US"missing '}' closing failstring for readsocket";
5500 goto EXPAND_FAILED_CURLY;
5502 Uskip_whitespace(&s);
5506 /* Handle "run" to execute a program. */
5512 const uschar **argv;
5516 if ((expand_forbid & RDO_RUN) != 0)
5518 expand_string_message = US"running a command is not permitted";
5522 Uskip_whitespace(&s);
5525 expand_string_message = US"missing '{' for command arg of run";
5526 goto EXPAND_FAILED_CURLY;
5528 if (!(arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
5530 Uskip_whitespace(&s);
5533 expand_string_message = US"missing '}' closing command arg of run";
5534 goto EXPAND_FAILED_CURLY;
5537 if (skipping) /* Just pretend it worked when we're skipping */
5540 lookup_value = NULL;
5544 if (!transport_set_up_command(&argv, /* anchor for arg list */
5545 arg, /* raw command */
5546 FALSE, /* don't expand the arguments */
5547 0, /* not relevant when... */
5548 NULL, /* no transporting address */
5549 US"${run} expansion", /* for error messages */
5550 &expand_string_message)) /* where to put error message */
5553 /* Create the child process, making it a group leader. */
5555 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5556 US"expand-run")) < 0)
5558 expand_string_message =
5559 string_sprintf("couldn't create child process: %s", strerror(errno));
5563 /* Nothing is written to the standard input. */
5567 /* Read the pipe to get the command's output into $value (which is kept
5568 in lookup_value). Read during execution, so that if the output exceeds
5569 the OS pipe buffer limit, we don't block forever. Remember to not release
5570 memory just allocated for $value. */
5573 f = fdopen(fd_out, "rb");
5574 sigalrm_seen = FALSE;
5576 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5580 /* Wait for the process to finish, applying the timeout, and inspect its
5581 return code for serious disasters. Simple non-zero returns are passed on.
5584 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5586 if (sigalrm_seen || runrc == -256)
5588 expand_string_message = US"command timed out";
5589 killpg(pid, SIGKILL); /* Kill the whole process group */
5592 else if (runrc == -257)
5593 expand_string_message = string_sprintf("wait() failed: %s",
5597 expand_string_message = string_sprintf("command killed by signal %d",
5604 /* Process the yes/no strings; $value may be useful in both cases */
5606 switch(process_yesno(
5607 skipping, /* were previously skipping */
5608 runrc == 0, /* success/failure indicator */
5609 lookup_value, /* value to reset for string2 */
5610 &s, /* input pointer */
5611 &yield, /* output pointer */
5612 US"run", /* condition type */
5615 case 1: goto EXPAND_FAILED; /* when all is well, the */
5616 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5622 /* Handle character translation for "tr" */
5626 int oldptr = gstring_length(yield);
5630 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5632 case 1: goto EXPAND_FAILED_CURLY;
5634 case 3: goto EXPAND_FAILED;
5637 yield = string_cat(yield, sub[0]);
5638 o2m = Ustrlen(sub[2]) - 1;
5640 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5642 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5646 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5653 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5654 expanded arguments. */
5663 int val[2] = { 0, -1 };
5666 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5667 Ensure that sub[2] is set in the ${length } case. */
5670 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5671 TRUE, name, &resetok))
5673 case 1: goto EXPAND_FAILED_CURLY;
5675 case 3: goto EXPAND_FAILED;
5678 /* Juggle the arguments if there are only two of them: always move the
5679 string to the last position and make ${length{n}{str}} equivalent to
5680 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5686 if (item_type == EITEM_LENGTH)
5693 for (int i = 0; i < 2; i++) if (sub[i])
5695 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5696 if (*ret != 0 || (i != 0 && val[i] < 0))
5698 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5699 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5705 item_type == EITEM_HASH
5706 ? compute_hash(sub[2], val[0], val[1], &len)
5707 : item_type == EITEM_NHASH
5708 ? compute_nhash(sub[2], val[0], val[1], &len)
5709 : extract_substr(sub[2], val[0], val[1], &len);
5712 yield = string_catn(yield, ret, len);
5716 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5717 This code originally contributed by Steve Haslam. It currently supports
5718 the use of MD5 and SHA-1 hashes.
5720 We need some workspace that is large enough to handle all the supported
5721 hash types. Use macros to set the sizes rather than be too elaborate. */
5723 #define MAX_HASHLEN 20
5724 #define MAX_HASHBLOCKLEN 64
5733 int hashlen; /* Number of octets for the hash algorithm's output */
5734 int hashblocklen; /* Number of octets the hash algorithm processes */
5736 unsigned int keylen;
5738 uschar keyhash[MAX_HASHLEN];
5739 uschar innerhash[MAX_HASHLEN];
5740 uschar finalhash[MAX_HASHLEN];
5741 uschar finalhash_hex[2*MAX_HASHLEN];
5742 uschar innerkey[MAX_HASHBLOCKLEN];
5743 uschar outerkey[MAX_HASHBLOCKLEN];
5745 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5747 case 1: goto EXPAND_FAILED_CURLY;
5749 case 3: goto EXPAND_FAILED;
5754 if (Ustrcmp(sub[0], "md5") == 0)
5757 use_base = &md5_base;
5761 else if (Ustrcmp(sub[0], "sha1") == 0)
5764 use_base = &sha1_ctx;
5770 expand_string_message =
5771 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5776 keylen = Ustrlen(keyptr);
5778 /* If the key is longer than the hash block length, then hash the key
5781 if (keylen > hashblocklen)
5783 chash_start(type, use_base);
5784 chash_end(type, use_base, keyptr, keylen, keyhash);
5789 /* Now make the inner and outer key values */
5791 memset(innerkey, 0x36, hashblocklen);
5792 memset(outerkey, 0x5c, hashblocklen);
5794 for (int i = 0; i < keylen; i++)
5796 innerkey[i] ^= keyptr[i];
5797 outerkey[i] ^= keyptr[i];
5800 /* Now do the hashes */
5802 chash_start(type, use_base);
5803 chash_mid(type, use_base, innerkey);
5804 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5806 chash_start(type, use_base);
5807 chash_mid(type, use_base, outerkey);
5808 chash_end(type, use_base, innerhash, hashlen, finalhash);
5810 /* Encode the final hash as a hex string */
5813 for (int i = 0; i < hashlen; i++)
5815 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5816 *p++ = hex_digits[finalhash[i] & 0x0f];
5819 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5820 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5822 yield = string_catn(yield, finalhash_hex, hashlen*2);
5827 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5828 We have to save the numerical variables and restore them afterwards. */
5833 int moffset, moffsetextra, slen;
5836 const uschar *rerror;
5839 int save_expand_nmax =
5840 save_expand_strings(save_expand_nstring, save_expand_nlength);
5842 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5844 case 1: goto EXPAND_FAILED_CURLY;
5846 case 3: goto EXPAND_FAILED;
5849 /* Compile the regular expression */
5851 if (!(re = pcre_compile(CS sub[1], PCRE_COPT, CCSS &rerror,
5854 expand_string_message = string_sprintf("regular expression error in "
5855 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5859 /* Now run a loop to do the substitutions as often as necessary. It ends
5860 when there are no more matches. Take care over matches of the null string;
5861 do the same thing as Perl does. */
5864 slen = Ustrlen(sub[0]);
5865 moffset = moffsetextra = 0;
5870 int ovector[3*(EXPAND_MAXN+1)];
5871 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5872 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5875 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5876 is not necessarily the end. We want to repeat the match from one
5877 character further along, but leaving the basic offset the same (for
5878 copying below). We can't be at the end of the string - that was checked
5879 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5880 finished; copy the remaining string and end the loop. */
5890 yield = string_catn(yield, subject+moffset, slen-moffset);
5894 /* Match - set up for expanding the replacement. */
5896 if (n == 0) n = EXPAND_MAXN + 1;
5898 for (int nn = 0; nn < n*2; nn += 2)
5900 expand_nstring[expand_nmax] = subject + ovector[nn];
5901 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5905 /* Copy the characters before the match, plus the expanded insertion. */
5907 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
5908 if (!(insert = expand_string(sub[2])))
5910 yield = string_cat(yield, insert);
5912 moffset = ovector[1];
5916 /* If we have matched an empty string, first check to see if we are at
5917 the end of the subject. If so, the loop is over. Otherwise, mimic
5918 what Perl's /g options does. This turns out to be rather cunning. First
5919 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5920 string at the same point. If this fails (picked up above) we advance to
5921 the next character. */
5923 if (ovector[0] == ovector[1])
5925 if (ovector[0] == slen) break;
5926 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5930 /* All done - restore numerical variables. */
5932 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5933 save_expand_nlength);
5937 /* Handle keyed and numbered substring extraction. If the first argument
5938 consists entirely of digits, then a numerical extraction is assumed. */
5942 int field_number = 1;
5943 BOOL field_number_set = FALSE;
5944 uschar *save_lookup_value = lookup_value;
5946 int save_expand_nmax =
5947 save_expand_strings(save_expand_nstring, save_expand_nlength);
5949 /* On reflection the original behaviour of extract-json for a string
5950 result, leaving it quoted, was a mistake. But it was already published,
5951 hence the addition of jsons. In a future major version, make json
5952 work like josons, and withdraw jsons. */
5954 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
5956 /* Check for a format-variant specifier */
5958 if (Uskip_whitespace(&s) != '{') /*}*/
5959 if (Ustrncmp(s, "json", 4) == 0)
5960 if (*(s += 4) == 's')
5961 {fmt = extract_jsons; s++;}
5965 /* While skipping we cannot rely on the data for expansions being
5966 available (eg. $item) hence cannot decide on numeric vs. keyed.
5967 Read a maximum of 5 arguments (including the yes/no) */
5971 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
5973 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5974 goto EXPAND_FAILED; /*'{'*/
5977 expand_string_message = US"missing '{' for arg of extract";
5978 goto EXPAND_FAILED_CURLY;
5980 Uskip_whitespace(&s);
5982 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
5983 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5987 Uskip_whitespace(&s);
5991 expand_string_message = US"missing '}' closing extract";
5992 goto EXPAND_FAILED_CURLY;
5996 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5998 if (Uskip_whitespace(&s) == '{') /*'}'*/
6000 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
6001 goto EXPAND_FAILED; /*'{'*/
6004 expand_string_message = string_sprintf(
6005 "missing '}' closing arg %d of extract", i+1);
6006 goto EXPAND_FAILED_CURLY;
6009 /* After removal of leading and trailing white space, the first
6010 argument must not be empty; if it consists entirely of digits
6011 (optionally preceded by a minus sign), this is a numerical
6012 extraction, and we expect 3 arguments (normal) or 2 (json). */
6020 Uskip_whitespace(&p);
6024 while (len > 0 && isspace(p[len-1])) len--;
6029 expand_string_message = US"first argument of \"extract\" must "
6039 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
6043 if (fmt == extract_basic) j = 3; /* Need 3 args */
6044 field_number_set = TRUE;
6050 expand_string_message = string_sprintf(
6051 "missing '{' for arg %d of extract", i+1);
6052 goto EXPAND_FAILED_CURLY;
6056 /* Extract either the numbered or the keyed substring into $value. If
6057 skipping, just pretend the extraction failed. */
6060 lookup_value = NULL;
6064 lookup_value = field_number_set
6065 ? expand_gettokened(field_number, sub[1], sub[2])
6066 : expand_getkeyed(sub[0], sub[1]);
6073 const uschar * list;
6075 /* Array: Bracket-enclosed and comma-separated.
6076 Object: Brace-enclosed, comma-sep list of name:value pairs */
6078 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6080 expand_string_message =
6081 string_sprintf("%s wrapping %s for extract json",
6082 expand_string_message,
6083 field_number_set ? "array" : "object");
6084 goto EXPAND_FAILED_CURLY;
6088 if (field_number_set)
6090 if (field_number <= 0)
6092 expand_string_message = US"first argument of \"extract\" must "
6093 "be greater than zero";
6096 while (field_number > 0 && (item = json_nextinlist(&list)))
6098 if ((lookup_value = s = item))
6101 while (--s >= lookup_value && isspace(*s)) *s = '\0';
6106 lookup_value = NULL;
6107 while ((item = json_nextinlist(&list)))
6109 /* Item is: string name-sep value. string is quoted.
6110 Dequote the string and compare with the search key. */
6112 if (!(item = dewrap(item, US"\"\"")))
6114 expand_string_message =
6115 string_sprintf("%s wrapping string key for extract json",
6116 expand_string_message);
6117 goto EXPAND_FAILED_CURLY;
6119 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
6121 s = item + Ustrlen(item) + 1;
6122 if (Uskip_whitespace(&s) != ':')
6124 expand_string_message =
6125 US"missing object value-separator for extract json";
6126 goto EXPAND_FAILED_CURLY;
6129 Uskip_whitespace(&s);
6137 if ( fmt == extract_jsons
6139 && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6141 expand_string_message =
6142 string_sprintf("%s wrapping string result for extract jsons",
6143 expand_string_message);
6144 goto EXPAND_FAILED_CURLY;
6149 /* If no string follows, $value gets substituted; otherwise there can
6150 be yes/no strings, as for lookup or if. */
6152 switch(process_yesno(
6153 skipping, /* were previously skipping */
6154 lookup_value != NULL, /* success/failure indicator */
6155 save_lookup_value, /* value to reset for string2 */
6156 &s, /* input pointer */
6157 &yield, /* output pointer */
6158 US"extract", /* condition type */
6161 case 1: goto EXPAND_FAILED; /* when all is well, the */
6162 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6165 /* All done - restore numerical variables. */
6167 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6168 save_expand_nlength);
6173 /* return the Nth item from a list */
6175 case EITEM_LISTEXTRACT:
6177 int field_number = 1;
6178 uschar *save_lookup_value = lookup_value;
6180 int save_expand_nmax =
6181 save_expand_strings(save_expand_nstring, save_expand_nlength);
6183 /* Read the field & list arguments */
6185 for (int i = 0; i < 2; i++)
6187 if (Uskip_whitespace(&s) != '{') /*'}'*/
6189 expand_string_message = string_sprintf(
6190 "missing '{' for arg %d of listextract", i+1);
6191 goto EXPAND_FAILED_CURLY;
6194 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6195 if (!sub[i]) goto EXPAND_FAILED; /*{*/
6198 expand_string_message = string_sprintf(
6199 "missing '}' closing arg %d of listextract", i+1);
6200 goto EXPAND_FAILED_CURLY;
6203 /* After removal of leading and trailing white space, the first
6204 argument must be numeric and nonempty. */
6212 Uskip_whitespace(&p);
6216 while (len > 0 && isspace(p[len-1])) len--;
6219 if (!*p && !skipping)
6221 expand_string_message = US"first argument of \"listextract\" must "
6231 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6234 expand_string_message = US"first argument of \"listextract\" must "
6242 /* Extract the numbered element into $value. If
6243 skipping, just pretend the extraction failed. */
6245 lookup_value = skipping ? NULL : expand_getlistele(field_number, sub[1]);
6247 /* If no string follows, $value gets substituted; otherwise there can
6248 be yes/no strings, as for lookup or if. */
6250 switch(process_yesno(
6251 skipping, /* were previously skipping */
6252 lookup_value != NULL, /* success/failure indicator */
6253 save_lookup_value, /* value to reset for string2 */
6254 &s, /* input pointer */
6255 &yield, /* output pointer */
6256 US"listextract", /* condition type */
6259 case 1: goto EXPAND_FAILED; /* when all is well, the */
6260 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6263 /* All done - restore numerical variables. */
6265 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6266 save_expand_nlength);
6271 case EITEM_LISTQUOTE:
6274 switch(read_subs(sub, 2, 2, &s, skipping, TRUE, name, &resetok))
6276 case 1: goto EXPAND_FAILED_CURLY;
6278 case 3: goto EXPAND_FAILED;
6280 if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6282 if (c == sep) yield = string_catn(yield, sub[1], 1);
6283 yield = string_catn(yield, sub[1], 1);
6285 else yield = string_catn(yield, US" ", 1);
6290 case EITEM_CERTEXTRACT:
6292 uschar *save_lookup_value = lookup_value;
6294 int save_expand_nmax =
6295 save_expand_strings(save_expand_nstring, save_expand_nlength);
6297 /* Read the field argument */
6298 if (Uskip_whitespace(&s) != '{') /*}*/
6300 expand_string_message = US"missing '{' for field arg of certextract";
6301 goto EXPAND_FAILED_CURLY;
6303 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6304 if (!sub[0]) goto EXPAND_FAILED; /*{*/
6307 expand_string_message = US"missing '}' closing field arg of certextract";
6308 goto EXPAND_FAILED_CURLY;
6310 /* strip spaces fore & aft */
6315 Uskip_whitespace(&p);
6319 while (len > 0 && isspace(p[len-1])) len--;
6323 /* inspect the cert argument */
6324 if (Uskip_whitespace(&s) != '{') /*}*/
6326 expand_string_message = US"missing '{' for cert variable arg of certextract";
6327 goto EXPAND_FAILED_CURLY;
6331 expand_string_message = US"second argument of \"certextract\" must "
6332 "be a certificate variable";
6335 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
6336 if (!sub[1]) goto EXPAND_FAILED; /*{*/
6339 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6340 goto EXPAND_FAILED_CURLY;
6344 lookup_value = NULL;
6347 lookup_value = expand_getcertele(sub[0], sub[1]);
6348 if (*expand_string_message) goto EXPAND_FAILED;
6350 switch(process_yesno(
6351 skipping, /* were previously skipping */
6352 lookup_value != NULL, /* success/failure indicator */
6353 save_lookup_value, /* value to reset for string2 */
6354 &s, /* input pointer */
6355 &yield, /* output pointer */
6356 US"certextract", /* condition type */
6359 case 1: goto EXPAND_FAILED; /* when all is well, the */
6360 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6363 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6364 save_expand_nlength);
6367 #endif /*DISABLE_TLS*/
6369 /* Handle list operations */
6376 int save_ptr = gstring_length(yield);
6377 uschar outsep[2] = { '\0', '\0' };
6378 const uschar *list, *expr, *temp;
6379 uschar *save_iterate_item = iterate_item;
6380 uschar *save_lookup_value = lookup_value;
6382 Uskip_whitespace(&s);
6385 expand_string_message =
6386 string_sprintf("missing '{' for first arg of %s", name);
6387 goto EXPAND_FAILED_CURLY;
6390 if (!(list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok)))
6394 expand_string_message =
6395 string_sprintf("missing '}' closing first arg of %s", name);
6396 goto EXPAND_FAILED_CURLY;
6399 if (item_type == EITEM_REDUCE)
6402 Uskip_whitespace(&s);
6405 expand_string_message = US"missing '{' for second arg of reduce";
6406 goto EXPAND_FAILED_CURLY;
6408 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6409 if (!t) goto EXPAND_FAILED;
6413 expand_string_message = US"missing '}' closing second arg of reduce";
6414 goto EXPAND_FAILED_CURLY;
6418 Uskip_whitespace(&s);
6421 expand_string_message =
6422 string_sprintf("missing '{' for last arg of %s", name);
6423 goto EXPAND_FAILED_CURLY;
6428 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6429 if scanning a "false" part). This allows us to find the end of the
6430 condition, because if the list is empty, we won't actually evaluate the
6431 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6432 the normal internal expansion function. */
6434 if (item_type != EITEM_FILTER)
6435 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6437 if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6441 expand_string_message = string_sprintf("%s inside \"%s\" item",
6442 expand_string_message, name);
6446 Uskip_whitespace(&s); /*{*/
6449 expand_string_message = string_sprintf("missing } at end of condition "
6450 "or expression inside \"%s\"; could be an unquoted } in the content",
6455 Uskip_whitespace(&s); /*{*/
6458 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6463 /* If we are skipping, we can now just move on to the next item. When
6464 processing for real, we perform the iteration. */
6466 if (skipping) continue;
6467 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6469 *outsep = (uschar)sep; /* Separator as a string */
6471 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6472 name, iterate_item, lookup_value);
6474 if (item_type == EITEM_FILTER)
6477 if (!eval_condition(expr, &resetok, &condresult))
6479 iterate_item = save_iterate_item;
6480 lookup_value = save_lookup_value;
6481 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6482 expand_string_message, name);
6485 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6486 condresult? "true":"false");
6488 temp = iterate_item; /* TRUE => include this item */
6490 continue; /* FALSE => skip this item */
6493 /* EITEM_MAP and EITEM_REDUCE */
6497 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
6501 iterate_item = save_iterate_item;
6502 expand_string_message = string_sprintf("%s inside \"%s\" item",
6503 expand_string_message, name);
6506 if (item_type == EITEM_REDUCE)
6508 lookup_value = t; /* Update the value of $value */
6509 continue; /* and continue the iteration */
6513 /* We reach here for FILTER if the condition is true, always for MAP,
6514 and never for REDUCE. The value in "temp" is to be added to the output
6515 list that is being created, ensuring that any occurrences of the
6516 separator character are doubled. Unless we are dealing with the first
6517 item of the output list, add in a space if the new item begins with the
6518 separator character, or is an empty string. */
6520 if ( yield && yield->ptr != save_ptr
6521 && (temp[0] == *outsep || temp[0] == 0))
6522 yield = string_catn(yield, US" ", 1);
6524 /* Add the string in "temp" to the output list that we are building,
6525 This is done in chunks by searching for the separator character. */
6529 size_t seglen = Ustrcspn(temp, outsep);
6531 yield = string_catn(yield, temp, seglen + 1);
6533 /* If we got to the end of the string we output one character
6534 too many; backup and end the loop. Otherwise arrange to double the
6537 if (temp[seglen] == '\0') { yield->ptr--; break; }
6538 yield = string_catn(yield, outsep, 1);
6542 /* Output a separator after the string: we will remove the redundant
6543 final one at the end. */
6545 yield = string_catn(yield, outsep, 1);
6546 } /* End of iteration over the list loop */
6548 /* REDUCE has generated no output above: output the final value of
6551 if (item_type == EITEM_REDUCE)
6553 yield = string_cat(yield, lookup_value);
6554 lookup_value = save_lookup_value; /* Restore $value */
6557 /* FILTER and MAP generate lists: if they have generated anything, remove
6558 the redundant final separator. Even though an empty item at the end of a
6559 list does not count, this is tidier. */
6561 else if (yield && yield->ptr != save_ptr) yield->ptr--;
6563 /* Restore preserved $item */
6565 iterate_item = save_iterate_item;
6573 const uschar *srclist, *cmp, *xtract;
6574 uschar * opname, * srcitem;
6575 const uschar *dstlist = NULL, *dstkeylist = NULL;
6577 uschar *save_iterate_item = iterate_item;
6579 Uskip_whitespace(&s);
6582 expand_string_message = US"missing '{' for list arg of sort";
6583 goto EXPAND_FAILED_CURLY;
6586 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6587 if (!srclist) goto EXPAND_FAILED;
6590 expand_string_message = US"missing '}' closing list arg of sort";
6591 goto EXPAND_FAILED_CURLY;
6594 Uskip_whitespace(&s);
6597 expand_string_message = US"missing '{' for comparator arg of sort";
6598 goto EXPAND_FAILED_CURLY;
6601 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6602 if (!cmp) goto EXPAND_FAILED;
6605 expand_string_message = US"missing '}' closing comparator arg of sort";
6606 goto EXPAND_FAILED_CURLY;
6609 if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6611 if (!expand_string_message)
6612 expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6617 case ECOND_NUM_L: case ECOND_NUM_LE:
6618 case ECOND_NUM_G: case ECOND_NUM_GE:
6619 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6620 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6624 expand_string_message = US"comparator not handled for sort";
6628 Uskip_whitespace(&s);
6631 expand_string_message = US"missing '{' for extractor arg of sort";
6632 goto EXPAND_FAILED_CURLY;
6636 if (!(tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok)))
6638 xtract = string_copyn(xtract, s - xtract);
6642 expand_string_message = US"missing '}' closing extractor arg of sort";
6643 goto EXPAND_FAILED_CURLY;
6648 expand_string_message = US"missing } at end of \"sort\"";
6652 if (skipping) continue;
6654 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6656 uschar * srcfield, * dstitem;
6657 gstring * newlist = NULL;
6658 gstring * newkeylist = NULL;
6660 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6662 /* extract field for comparisons */
6663 iterate_item = srcitem;
6664 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6668 expand_string_message = string_sprintf(
6669 "field-extract in sort: \"%s\"", xtract);
6673 /* Insertion sort */
6675 /* copy output list until new-item < list-item */
6676 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6680 /* field for comparison */
6681 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6684 /* String-comparator names start with a letter; numeric names do not */
6686 if (sortsbefore(cond_type, isalpha(opname[0]),
6687 srcfield, dstfield))
6689 /* New-item sorts before this dst-item. Append new-item,
6690 then dst-item, then remainder of dst list. */
6692 newlist = string_append_listele(newlist, sep, srcitem);
6693 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6696 newlist = string_append_listele(newlist, sep, dstitem);
6697 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6699 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */
6700 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6702 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6704 newlist = string_append_listele(newlist, sep, dstitem);
6705 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6711 newlist = string_append_listele(newlist, sep, dstitem);
6712 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6715 /* If we ran out of dstlist without consuming srcitem, append it */
6718 newlist = string_append_listele(newlist, sep, srcitem);
6719 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6722 dstlist = newlist->s;
6723 dstkeylist = newkeylist->s;
6725 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6726 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6730 yield = string_cat(yield, dstlist);
6732 /* Restore preserved $item */
6733 iterate_item = save_iterate_item;
6737 expand_string_message = US"Internal error in sort (list mismatch)";
6742 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6743 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6744 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6745 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6747 #define EXPAND_DLFUNC_MAX_ARGS 8
6750 #ifndef EXPAND_DLFUNC
6751 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6752 "is not included in this binary";
6755 #else /* EXPAND_DLFUNC */
6758 exim_dlfunc_t *func;
6761 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6763 if ((expand_forbid & RDO_DLFUNC) != 0)
6765 expand_string_message =
6766 US"dynamically-loaded functions are not permitted";
6770 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6771 TRUE, name, &resetok))
6773 case 1: goto EXPAND_FAILED_CURLY;
6775 case 3: goto EXPAND_FAILED;
6778 /* If skipping, we don't actually do anything */
6780 if (skipping) continue;
6782 /* Look up the dynamically loaded object handle in the tree. If it isn't
6783 found, dlopen() the file and put the handle in the tree for next time. */
6785 if (!(t = tree_search(dlobj_anchor, argv[0])))
6787 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6790 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6791 argv[0], dlerror());
6792 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6795 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), is_tainted(argv[0]));
6796 Ustrcpy(t->name, argv[0]);
6797 t->data.ptr = handle;
6798 (void)tree_insertnode(&dlobj_anchor, t);
6801 /* Having obtained the dynamically loaded object handle, look up the
6802 function pointer. */
6804 if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6806 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6807 "%s", argv[1], argv[0], dlerror());
6808 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6812 /* Call the function and work out what to do with the result. If it
6813 returns OK, we have a replacement string; if it returns DEFER then
6814 expansion has failed in a non-forced manner; if it returns FAIL then
6815 failure was forced; if it returns ERROR or any other value there's a
6816 problem, so panic slightly. In any case, assume that the function has
6817 side-effects on the store that must be preserved. */
6821 for (argc = 0; argv[argc]; argc++);
6822 status = func(&result, argc - 2, &argv[2]);
6825 if (!result) result = US"";
6826 yield = string_cat(yield, result);
6831 expand_string_message = result ? result : US"(no message)";
6832 if (status == FAIL_FORCED)
6833 f.expand_string_forcedfail = TRUE;
6834 else if (status != FAIL)
6835 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6836 argv[0], argv[1], status, expand_string_message);
6840 #endif /* EXPAND_DLFUNC */
6842 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6845 uschar *save_lookup_value = lookup_value;
6847 if (Uskip_whitespace(&s) != '{') /*}*/
6850 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6851 if (!key) goto EXPAND_FAILED; /*{*/
6854 expand_string_message = US"missing '{' for name arg of env";
6855 goto EXPAND_FAILED_CURLY;
6858 lookup_value = US getenv(CS key);
6860 switch(process_yesno(
6861 skipping, /* were previously skipping */
6862 lookup_value != NULL, /* success/failure indicator */
6863 save_lookup_value, /* value to reset for string2 */
6864 &s, /* input pointer */
6865 &yield, /* output pointer */
6866 US"env", /* condition type */
6869 case 1: goto EXPAND_FAILED; /* when all is well, the */
6870 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6876 case EITEM_SRS_ENCODE:
6877 /* ${srs_encode {secret} {return_path} {orig_domain}} */
6882 BOOL quoted = FALSE;
6884 switch (read_subs(sub, 3, 3, CUSS &s, skipping, TRUE, name, &resetok))
6886 case 1: goto EXPAND_FAILED_CURLY;
6888 case 3: goto EXPAND_FAILED;
6891 g = string_catn(g, US"SRS0=", 5);
6893 /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
6894 hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
6895 g = string_catn(g, cksum, sizeof(cksum));
6896 g = string_catn(g, US"=", 1);
6898 /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
6904 gettimeofday(&now, NULL);
6905 for (unsigned long i = (now.tv_sec / 86400) & 0x3ff; i; i >>= 5)
6906 h = string_catn(h, &base32_chars[i & 0x1f], 1);
6907 if (h) while (h->ptr > 0)
6908 g = string_catn(g, &h->s[--h->ptr], 1);
6910 g = string_catn(g, US"=", 1);
6912 /* ${domain:$return_path}=${local_part:$return_path} */
6914 int start, end, domain;
6915 uschar * t = parse_extract_address(sub[1], &expand_string_message,
6916 &start, &end, &domain, FALSE);
6922 if (domain > 0) g = string_cat(g, t + domain);
6923 g = string_catn(g, US"=", 1);
6925 s = domain > 0 ? string_copyn(t, domain - 1) : t;
6926 if ((quoted = Ustrchr(s, '"') != NULL))
6929 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
6930 while (*s) /* de-quote */
6932 while (*s && *s != '"') h = string_catn(h, s++, 1);
6934 while (*s && *s != '"') h = string_catn(h, s++, 1);
6937 gstring_release_unused(h);
6938 s = string_from_gstring(h);
6940 g = string_cat(g, s);
6943 /* Assume that if the original local_part had quotes
6944 it was for good reason */
6946 if (quoted) yield = string_catn(yield, US"\"", 1);
6947 yield = string_catn(yield, g->s, g->ptr);
6948 if (quoted) yield = string_catn(yield, US"\"", 1);
6950 /* @$original_domain */
6951 yield = string_catn(yield, US"@", 1);
6952 yield = string_cat(yield, sub[2]);
6955 #endif /*SUPPORT_SRS*/
6956 } /* EITEM_* switch */
6958 /* Control reaches here if the name is not recognized as one of the more
6959 complicated expansion items. Check for the "operator" syntax (name terminated
6960 by a colon). Some of the operators have arguments, separated by _ from the
6969 var_entry *vp = NULL;
6972 /* Owing to an historical mis-design, an underscore may be part of the
6973 operator name, or it may introduce arguments. We therefore first scan the
6974 table of names that contain underscores. If there is no match, we cut off
6975 the arguments and then scan the main table. */
6977 if ((c = chop_match(name, op_table_underscore,
6978 nelem(op_table_underscore))) < 0)
6980 if ((arg = Ustrchr(name, '_')))
6982 if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
6983 c += nelem(op_table_underscore);
6984 if (arg) *arg++ = '_'; /* Put back for error messages */
6987 /* Deal specially with operators that might take a certificate variable
6988 as we do not want to do the usual expansion. For most, expand the string.*/
6998 const uschar * s1 = s;
6999 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
7001 if (!sub) goto EXPAND_FAILED; /*{*/
7004 expand_string_message =
7005 string_sprintf("missing '}' closing cert arg of %s", name);
7006 goto EXPAND_FAILED_CURLY;
7008 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
7018 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
7019 if (!sub) goto EXPAND_FAILED;
7024 /* If we are skipping, we don't need to perform the operation at all.
7025 This matters for operations like "mask", because the data may not be
7026 in the correct format when skipping. For example, the expression may test
7027 for the existence of $sender_host_address before trying to mask it. For
7028 other operations, doing them may not fail, but it is a waste of time. */
7030 if (skipping && c >= 0) continue;
7032 /* Otherwise, switch on the operator type */
7039 unsigned long int n = Ustrtoul(sub, &t, 10);
7044 expand_string_message = string_sprintf("argument for base32 "
7045 "operator is \"%s\", which is not a decimal number", sub);
7049 g = string_catn(g, &base32_chars[n & 0x1f], 1);
7051 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7058 unsigned long int n = 0;
7061 uschar * t = Ustrchr(base32_chars, *tt++);
7064 expand_string_message = string_sprintf("argument for base32d "
7065 "operator is \"%s\", which is not a base 32 number", sub);
7068 n = n * 32 + (t - base32_chars);
7070 yield = string_fmt_append(yield, "%ld", n);
7077 unsigned long int n = Ustrtoul(sub, &t, 10);
7080 expand_string_message = string_sprintf("argument for base62 "
7081 "operator is \"%s\", which is not a decimal number", sub);
7084 yield = string_cat(yield, string_base62(n));
7088 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7093 unsigned long int n = 0;
7096 uschar *t = Ustrchr(base62_chars, *tt++);
7099 expand_string_message = string_sprintf("argument for base62d "
7100 "operator is \"%s\", which is not a base %d number", sub,
7104 n = n * BASE_62 + (t - base62_chars);
7106 yield = string_fmt_append(yield, "%ld", n);
7112 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
7115 expand_string_message =
7116 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7117 expand_string_message);
7120 yield = string_cat(yield, expanded);
7127 uschar *t = sub - 1;
7128 while (*(++t) != 0) { *t = tolower(*t); count++; }
7129 yield = string_catn(yield, sub, count);
7136 uschar *t = sub - 1;
7137 while (*(++t) != 0) { *t = toupper(*t); count++; }
7138 yield = string_catn(yield, sub, count);
7144 if (vp && *(void **)vp->value)
7146 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7147 yield = string_cat(yield, cp);
7155 md5_end(&base, sub, Ustrlen(sub), digest);
7156 for (int j = 0; j < 16; j++)
7157 yield = string_fmt_append(yield, "%02x", digest[j]);
7163 if (vp && *(void **)vp->value)
7165 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7166 yield = string_cat(yield, cp);
7174 sha1_end(&h, sub, Ustrlen(sub), digest);
7175 for (int j = 0; j < 20; j++)
7176 yield = string_fmt_append(yield, "%02X", digest[j]);
7182 #ifdef EXIM_HAVE_SHA2
7183 if (vp && *(void **)vp->value)
7184 if (c == EOP_SHA256)
7185 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7187 expand_string_message = US"sha2_N not supported with certificates";
7192 hashmethod m = !arg ? HASH_SHA2_256
7193 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7194 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7195 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7198 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7200 expand_string_message = US"unrecognised sha2 variant";
7204 exim_sha_update(&h, sub, Ustrlen(sub));
7205 exim_sha_finish(&h, &b);
7207 yield = string_fmt_append(yield, "%02X", *b.data++);
7210 expand_string_message = US"sha256 only supported with TLS";
7215 #ifdef EXIM_HAVE_SHA3
7219 hashmethod m = !arg ? HASH_SHA3_256
7220 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7221 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7222 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7223 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7226 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7228 expand_string_message = US"unrecognised sha3 variant";
7232 exim_sha_update(&h, sub, Ustrlen(sub));
7233 exim_sha_finish(&h, &b);
7235 yield = string_fmt_append(yield, "%02X", *b.data++);
7239 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7243 /* Convert hex encoding to base64 encoding */
7253 for (enc = sub; *enc; enc++)
7255 if (!isxdigit(*enc))
7257 expand_string_message = string_sprintf("\"%s\" is not a hex "
7266 expand_string_message = string_sprintf("\"%s\" contains an odd "
7267 "number of characters", sub);
7271 while ((c = *in++) != 0)
7273 if (isdigit(c)) c -= '0';
7274 else c = toupper(c) - 'A' + 10;
7284 enc = b64encode(CUS sub, out - sub);
7285 yield = string_cat(yield, enc);
7289 /* Convert octets outside 0x21..0x7E to \xXX form */
7293 uschar *t = sub - 1;
7296 if (*t < 0x21 || 0x7E < *t)
7297 yield = string_fmt_append(yield, "\\x%02x", *t);
7299 yield = string_catn(yield, t, 1);
7304 /* count the number of list elements */
7308 int cnt = 0, sep = 0;
7309 uschar * buf = store_get(2, is_tainted(sub));
7311 while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7312 yield = string_fmt_append(yield, "%d", cnt);
7316 /* expand a named list given the name */
7317 /* handles nested named lists; requotes as colon-sep list */
7320 expand_string_message = NULL;
7321 yield = expand_listnamed(yield, sub, arg);
7322 if (expand_string_message)
7326 /* quote a list-item for the given list-separator */
7328 /* mask applies a mask to an IP address; for example the result of
7329 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7336 int mask, maskoffset;
7337 int type = string_is_ip_address(sub, &maskoffset);
7342 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7347 if (maskoffset == 0)
7349 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7354 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7356 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
7358 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7363 /* Convert the address to binary integer(s) and apply the mask */
7365 sub[maskoffset] = 0;
7366 count = host_aton(sub, binary);
7367 host_mask(count, binary, mask);
7369 /* Convert to masked textual format and add to output. */
7371 yield = string_catn(yield, buffer,
7372 host_nmtoa(count, binary, mask, buffer, '.'));
7377 case EOP_IPV6DENORM:
7379 int type = string_is_ip_address(sub, NULL);
7386 (void) host_aton(sub, binary);
7389 case 4: /* convert to IPv4-mapped IPv6 */
7390 binary[0] = binary[1] = 0;
7391 binary[2] = 0x0000ffff;
7392 (void) host_aton(sub, binary+3);
7396 expand_string_message =
7397 string_sprintf("\"%s\" is not an IP address", sub);
7401 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7402 ? ipv6_nmtoa(binary, buffer)
7403 : host_nmtoa(4, binary, -1, buffer, ':')
7409 case EOP_LOCAL_PART:
7413 int start, end, domain;
7414 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7417 if (c != EOP_DOMAIN)
7418 yield = c == EOP_LOCAL_PART && domain > 0
7419 ? string_catn(yield, t, domain - 1)
7420 : string_cat(yield, t);
7421 else if (domain > 0)
7422 yield = string_cat(yield, t + domain);
7428 uschar outsep[2] = { ':', '\0' };
7429 uschar *address, *error;
7430 int save_ptr = gstring_length(yield);
7431 int start, end, domain; /* Not really used */
7433 if (Uskip_whitespace(&sub) == '>')
7434 if (*outsep = *++sub) ++sub;
7437 expand_string_message = string_sprintf("output separator "
7438 "missing in expanding ${addresses:%s}", --sub);
7441 f.parse_allow_group = TRUE;
7445 uschar * p = parse_find_address_end(sub, FALSE);
7446 uschar saveend = *p;
7448 address = parse_extract_address(sub, &error, &start, &end, &domain,
7452 /* Add the address to the output list that we are building. This is
7453 done in chunks by searching for the separator character. At the
7454 start, unless we are dealing with the first address of the output
7455 list, add in a space if the new address begins with the separator
7456 character, or is an empty string. */
7460 if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7461 yield = string_catn(yield, US" ", 1);
7465 size_t seglen = Ustrcspn(address, outsep);
7466 yield = string_catn(yield, address, seglen + 1);
7468 /* If we got to the end of the string we output one character
7471 if (address[seglen] == '\0') { yield->ptr--; break; }
7472 yield = string_catn(yield, outsep, 1);
7473 address += seglen + 1;
7476 /* Output a separator after the string: we will remove the
7477 redundant final one at the end. */
7479 yield = string_catn(yield, outsep, 1);
7482 if (saveend == '\0') break;
7486 /* If we have generated anything, remove the redundant final
7489 if (yield && yield->ptr != save_ptr) yield->ptr--;
7490 f.parse_allow_group = FALSE;
7495 /* quote puts a string in quotes if it is empty or contains anything
7496 other than alphamerics, underscore, dot, or hyphen.
7498 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7499 be quoted in order to be a valid local part.
7501 In both cases, newlines and carriage returns are converted into \n and \r
7505 case EOP_QUOTE_LOCAL_PART:
7508 BOOL needs_quote = (!*sub); /* TRUE for empty string */
7509 uschar *t = sub - 1;
7512 while (!needs_quote && *++t)
7513 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7515 else /* EOP_QUOTE_LOCAL_PART */
7516 while (!needs_quote && *++t)
7517 needs_quote = !isalnum(*t)
7518 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7519 && (*t != '.' || t == sub || !t[1]);
7523 yield = string_catn(yield, US"\"", 1);
7527 yield = string_catn(yield, US"\\n", 2);
7528 else if (*t == '\r')
7529 yield = string_catn(yield, US"\\r", 2);
7532 if (*t == '\\' || *t == '"')
7533 yield = string_catn(yield, US"\\", 1);
7534 yield = string_catn(yield, t, 1);
7536 yield = string_catn(yield, US"\"", 1);
7539 yield = string_cat(yield, sub);
7543 /* quote_lookuptype does lookup-specific quoting */
7548 uschar *opt = Ustrchr(arg, '_');
7550 if (opt) *opt++ = 0;
7552 if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7554 expand_string_message = search_error_message;
7558 if (lookup_list[n]->quote)
7559 sub = (lookup_list[n]->quote)(sub, opt);
7565 expand_string_message = string_sprintf(
7566 "\"%s\" unrecognized after \"${quote_%s\"",
7571 yield = string_cat(yield, sub);
7575 /* rx quote sticks in \ before any non-alphameric character so that
7576 the insertion works in a regular expression. */
7580 uschar *t = sub - 1;
7584 yield = string_catn(yield, US"\\", 1);
7585 yield = string_catn(yield, t, 1);
7590 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7591 prescribed by the RFC, if there are characters that need to be encoded */
7594 yield = string_cat(yield,
7595 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7599 /* RFC 2047 decode */
7605 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7606 headers_charset, '?', &len, &error);
7609 expand_string_message = error;
7612 yield = string_catn(yield, decoded, len);
7616 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7621 uschar * buff = store_get(4, is_tainted(sub));
7626 if (c > 255) c = '_';
7628 yield = string_catn(yield, buff, 1);
7633 /* replace illegal UTF-8 sequences by replacement character */
7635 #define UTF8_REPLACEMENT_CHAR US"?"
7639 int seq_len = 0, index = 0;
7641 long codepoint = -1;
7643 uschar seq_buff[4]; /* accumulate utf-8 here */
7645 /* Manually track tainting, as we deal in individual chars below */
7647 if (is_tainted(sub))
7648 if (yield->s && yield->ptr)
7649 gstring_rebuffer(yield);
7651 yield->s = store_get(yield->size = Ustrlen(sub), TRUE);
7653 /* Check the UTF-8, byte-by-byte */
7662 if ((c & 0xc0) != 0x80)
7663 /* wrong continuation byte; invalidate all bytes */
7664 complete = 1; /* error */
7667 codepoint = (codepoint << 6) | (c & 0x3f);
7668 seq_buff[index++] = c;
7669 if (--bytes_left == 0) /* codepoint complete */
7670 if(codepoint > 0x10FFFF) /* is it too large? */
7671 complete = -1; /* error (RFC3629 limit) */
7673 { /* finished; output utf-8 sequence */
7674 yield = string_catn(yield, seq_buff, seq_len);
7679 else /* no bytes left: new sequence */
7681 if(!(c & 0x80)) /* 1-byte sequence, US-ASCII, keep it */
7683 yield = string_catn(yield, &c, 1);
7686 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7688 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7693 codepoint = c & 0x1f;
7696 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7699 codepoint = c & 0x0f;
7701 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7704 codepoint = c & 0x07;
7706 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7709 seq_buff[index++] = c;
7710 seq_len = bytes_left + 1;
7711 } /* if(bytes_left) */
7715 bytes_left = index = 0;
7716 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7718 if ((complete == 1) && ((c & 0x80) == 0))
7719 /* ASCII character follows incomplete sequence */
7720 yield = string_catn(yield, &c, 1);
7722 /* If given a sequence truncated mid-character, we also want to report ?
7723 * Eg, ${length_1:フィル} is one byte, not one character, so we expect
7724 * ${utf8clean:${length_1:フィル}} to yield '?' */
7725 if (bytes_left != 0)
7726 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7732 case EOP_UTF8_DOMAIN_TO_ALABEL:
7734 uschar * error = NULL;
7735 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7738 expand_string_message = string_sprintf(
7739 "error converting utf8 (%s) to alabel: %s",
7740 string_printing(sub), error);
7743 yield = string_cat(yield, s);
7747 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7749 uschar * error = NULL;
7750 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7753 expand_string_message = string_sprintf(
7754 "error converting alabel (%s) to utf8: %s",
7755 string_printing(sub), error);
7758 yield = string_cat(yield, s);
7762 case EOP_UTF8_LOCALPART_TO_ALABEL:
7764 uschar * error = NULL;
7765 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7768 expand_string_message = string_sprintf(
7769 "error converting utf8 (%s) to alabel: %s",
7770 string_printing(sub), error);
7773 yield = string_cat(yield, s);
7774 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7778 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7780 uschar * error = NULL;
7781 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7784 expand_string_message = string_sprintf(
7785 "error converting alabel (%s) to utf8: %s",
7786 string_printing(sub), error);
7789 yield = string_cat(yield, s);
7792 #endif /* EXPERIMENTAL_INTERNATIONAL */
7794 /* escape turns all non-printing characters into escape sequences. */
7798 const uschar * t = string_printing(sub);
7799 yield = string_cat(yield, t);
7803 case EOP_ESCAPE8BIT:
7807 for (const uschar * s = sub; (c = *s); s++)
7808 yield = c < 127 && c != '\\'
7809 ? string_catn(yield, s, 1)
7810 : string_fmt_append(yield, "\\%03o", c);
7814 /* Handle numeric expression evaluation */
7819 uschar *save_sub = sub;
7820 uschar *error = NULL;
7821 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7824 expand_string_message = string_sprintf("error in expression "
7825 "evaluation: %s (after processing \"%.*s\")", error,
7826 (int)(sub-save_sub), save_sub);
7829 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
7833 /* Handle time period formatting */
7837 int n = readconf_readtime(sub, 0, FALSE);
7840 expand_string_message = string_sprintf("string \"%s\" is not an "
7841 "Exim time interval in \"%s\" operator", sub, name);
7844 yield = string_fmt_append(yield, "%d", n);
7848 case EOP_TIME_INTERVAL:
7851 uschar *t = read_number(&n, sub);
7852 if (*t != 0) /* Not A Number*/
7854 expand_string_message = string_sprintf("string \"%s\" is not a "
7855 "positive number in \"%s\" operator", sub, name);
7858 t = readconf_printtime(n);
7859 yield = string_cat(yield, t);
7863 /* Convert string to base64 encoding */
7869 uschar * s = vp && *(void **)vp->value
7870 ? tls_cert_der_b64(*(void **)vp->value)
7871 : b64encode(CUS sub, Ustrlen(sub));
7873 uschar * s = b64encode(CUS sub, Ustrlen(sub));
7875 yield = string_cat(yield, s);
7882 int len = b64decode(sub, &s);
7885 expand_string_message = string_sprintf("string \"%s\" is not "
7886 "well-formed for \"%s\" operator", sub, name);
7889 yield = string_cat(yield, s);
7893 /* strlen returns the length of the string */
7896 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
7899 /* length_n or l_n takes just the first n characters or the whole string,
7900 whichever is the shorter;
7902 substr_m_n, and s_m_n take n characters from offset m; negative m take
7903 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7904 takes the rest, either to the right or to the left.
7906 hash_n or h_n makes a hash of length n from the string, yielding n
7907 characters from the set a-z; hash_n_m makes a hash of length n, but
7908 uses m characters from the set a-zA-Z0-9.
7910 nhash_n returns a single number between 0 and n-1 (in text form), while
7911 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7912 between 0 and n-1 and the second between 0 and m-1. */
7932 expand_string_message = string_sprintf("missing values after %s",
7937 /* "length" has only one argument, effectively being synonymous with
7940 if (c == EOP_LENGTH || c == EOP_L)
7946 /* The others have one or two arguments; for "substr" the first may be
7947 negative. The second being negative means "not supplied". */
7952 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7955 /* Read up to two numbers, separated by underscores */
7960 if (arg != ret && *arg == '_' && pn == &value1)
7964 if (arg[1] != 0) arg++;
7966 else if (!isdigit(*arg))
7968 expand_string_message =
7969 string_sprintf("non-digit after underscore in \"%s\"", name);
7972 else *pn = (*pn)*10 + *arg++ - '0';
7976 /* Perform the required operation */
7978 ret = c == EOP_HASH || c == EOP_H
7979 ? compute_hash(sub, value1, value2, &len)
7980 : c == EOP_NHASH || c == EOP_NH
7981 ? compute_nhash(sub, value1, value2, &len)
7982 : extract_substr(sub, value1, value2, &len);
7983 if (!ret) goto EXPAND_FAILED;
7985 yield = string_catn(yield, ret, len);
7994 uschar **modetable[3];
7998 if (expand_forbid & RDO_EXISTS)
8000 expand_string_message = US"Use of the stat() expansion is not permitted";
8004 if (stat(CS sub, &st) < 0)
8006 expand_string_message = string_sprintf("stat(%s) failed: %s",
8007 sub, strerror(errno));
8011 switch (mode & S_IFMT)
8013 case S_IFIFO: smode[0] = 'p'; break;
8014 case S_IFCHR: smode[0] = 'c'; break;
8015 case S_IFDIR: smode[0] = 'd'; break;
8016 case S_IFBLK: smode[0] = 'b'; break;
8017 case S_IFREG: smode[0] = '-'; break;
8018 default: smode[0] = '?'; break;
8021 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8022 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8023 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8025 for (int i = 0; i < 3; i++)
8027 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8032 yield = string_fmt_append(yield,
8033 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8034 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8035 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8036 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8037 (long)st.st_gid, st.st_size, (long)st.st_atime,
8038 (long)st.st_mtime, (long)st.st_ctime);
8042 /* vaguely random number less than N */
8046 int_eximarith_t max = expanded_string_integer(sub, TRUE);
8048 if (expand_string_message)
8050 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8054 /* Reverse IP, including IPv6 to dotted-nibble */
8056 case EOP_REVERSE_IP:
8058 int family, maskptr;
8059 uschar reversed[128];
8061 family = string_is_ip_address(sub, &maskptr);
8064 expand_string_message = string_sprintf(
8065 "reverse_ip() not given an IP address [%s]", sub);
8068 invert_address(reversed, sub);
8069 yield = string_cat(yield, reversed);
8073 /* Unknown operator */
8076 expand_string_message =
8077 string_sprintf("unknown expansion operator \"%s\"", name);
8082 /* Handle a plain name. If this is the first thing in the expansion, release
8083 the pre-allocated buffer. If the result data is known to be in a new buffer,
8084 newsize will be set to the size of that buffer, and we can just point at that
8085 store instead of copying. Many expansion strings contain just one reference,
8086 so this is a useful optimization, especially for humungous headers
8087 ($message_headers). */
8096 g = store_get(sizeof(gstring), FALSE);
8097 else if (yield->ptr == 0)
8099 if (resetok) reset_point = store_reset(reset_point);
8101 reset_point = store_mark();
8102 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
8104 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
8106 expand_string_message =
8107 string_sprintf("unknown variable in \"${%s}\"", name);
8108 check_variable_error_message(name);
8111 len = Ustrlen(value);
8112 if (!yield && newsize)
8115 yield->size = newsize;
8120 yield = string_catn(yield, value, len);
8124 /* Else there's something wrong */
8126 expand_string_message =
8127 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8128 "in a variable reference)", name);
8132 /* If we hit the end of the string when ket_ends is set, there is a missing
8133 terminating brace. */
8135 if (ket_ends && *s == 0)
8137 expand_string_message = malformed_header
8138 ? US"missing } at end of string - could be header name not terminated by colon"
8139 : US"missing } at end of string";
8143 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8144 added to the string. If so, set up an empty string. Add a terminating zero. If
8145 left != NULL, return a pointer to the terminator. */
8148 yield = string_get(1);
8149 (void) string_from_gstring(yield);
8150 if (left) *left = s;
8152 /* Any stacking store that was used above the final string is no longer needed.
8153 In many cases the final string will be the first one that was got and so there
8154 will be optimal store usage. */
8156 if (resetok) gstring_release_unused(yield);
8157 else if (resetok_p) *resetok_p = FALSE;
8161 BOOL tainted = is_tainted(yield->s);
8164 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8165 debug_printf_indent("%sresult: %s\n",
8166 skipping ? "|-----" : "\\_____", yield->s);
8168 debug_printf_indent("%s \\__(tainted)\n",
8169 skipping ? "| " : " ");
8171 debug_printf_indent("\\___skipping: result is not used\n");
8175 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8176 "expanding: %.*s\n",
8177 (int)(s - string), string);
8178 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8180 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8183 debug_printf_indent("%s(tainted)\n",
8185 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8187 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8188 "skipping: result is not used\n");
8194 /* This is the failure exit: easiest to program with a goto. We still need
8195 to update the pointer to the terminator, for cases of nested calls with "fail".
8198 EXPAND_FAILED_CURLY:
8199 if (malformed_header)
8200 expand_string_message =
8201 US"missing or misplaced { or } - could be header name not terminated by colon";
8203 else if (!expand_string_message || !*expand_string_message)
8204 expand_string_message = US"missing or misplaced { or }";
8206 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8207 that is a bad idea, because expand_string_message is in dynamic store. */
8210 if (left) *left = s;
8214 debug_printf_indent("|failed to expand: %s\n", string);
8215 debug_printf_indent("%serror message: %s\n",
8216 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8217 if (f.expand_string_forcedfail)
8218 debug_printf_indent("\\failure was forced\n");
8222 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8224 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8225 "error message: %s\n",
8226 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8227 expand_string_message);
8228 if (f.expand_string_forcedfail)
8229 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8231 if (resetok_p && !resetok) *resetok_p = FALSE;
8237 /* This is the external function call. Do a quick check for any expansion
8238 metacharacters, and if there are none, just return the input string.
8240 Argument: the string to be expanded
8241 Returns: the expanded string, or NULL if expansion failed; if failure was
8242 due to a lookup deferring, search_find_defer will be TRUE
8246 expand_cstring(const uschar * string)
8248 if (Ustrpbrk(string, "$\\") != NULL)
8250 int old_pool = store_pool;
8253 f.search_find_defer = FALSE;
8254 malformed_header = FALSE;
8255 store_pool = POOL_MAIN;
8256 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
8257 store_pool = old_pool;
8265 expand_string(uschar * string)
8267 return US expand_cstring(CUS string);
8274 /*************************************************
8276 *************************************************/
8278 /* Now and again we want to expand a string and be sure that the result is in a
8279 new bit of store. This function does that.
8280 Since we know it has been copied, the de-const cast is safe.
8282 Argument: the string to be expanded
8283 Returns: the expanded string, always in a new bit of store, or NULL
8287 expand_string_copy(const uschar *string)
8289 const uschar *yield = expand_cstring(string);
8290 if (yield == string) yield = string_copy(string);
8296 /*************************************************
8297 * Expand and interpret as an integer *
8298 *************************************************/
8300 /* Expand a string, and convert the result into an integer.
8303 string the string to be expanded
8304 isplus TRUE if a non-negative number is expected
8306 Returns: the integer value, or
8307 -1 for an expansion error ) in both cases, message in
8308 -2 for an integer interpretation error ) expand_string_message
8309 expand_string_message is set NULL for an OK integer
8313 expand_string_integer(uschar *string, BOOL isplus)
8315 return expanded_string_integer(expand_string(string), isplus);
8319 /*************************************************
8320 * Interpret string as an integer *
8321 *************************************************/
8323 /* Convert a string (that has already been expanded) into an integer.
8325 This function is used inside the expansion code.
8328 s the string to be expanded
8329 isplus TRUE if a non-negative number is expected
8331 Returns: the integer value, or
8332 -1 if string is NULL (which implies an expansion error)
8333 -2 for an integer interpretation error
8334 expand_string_message is set NULL for an OK integer
8337 static int_eximarith_t
8338 expanded_string_integer(const uschar *s, BOOL isplus)
8340 int_eximarith_t value;
8341 uschar *msg = US"invalid integer \"%s\"";
8344 /* If expansion failed, expand_string_message will be set. */
8348 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8349 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8350 systems, so we set it zero ourselves. */
8353 expand_string_message = NULL; /* Indicates no error */
8355 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8356 equal to 0. Unfortunately, people actually relied upon that, so preserve
8357 the behaviour explicitly. Stripping leading whitespace is a harmless
8358 noop change since strtol skips it anyway (provided that there is a number
8361 if (Uskip_whitespace(&s) == '\0')
8364 debug_printf_indent("treating blank string as number 0\n");
8368 value = strtoll(CS s, CSS &endptr, 10);
8371 msg = US"integer expected but \"%s\" found";
8372 else if (value < 0 && isplus)
8373 msg = US"non-negative integer expected but \"%s\" found";
8376 switch (tolower(*endptr))
8381 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8386 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8387 else value *= 1024*1024;
8391 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8392 else value *= 1024*1024*1024;
8396 if (errno == ERANGE)
8397 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8399 if (Uskip_whitespace(&endptr) == 0) return value;
8402 expand_string_message = string_sprintf(CS msg, s);
8407 /* These values are usually fixed boolean values, but they are permitted to be
8411 addr address being routed
8412 mtype the module type
8413 mname the module name
8414 dbg_opt debug selectors
8415 oname the option name
8416 bvalue the router's boolean value
8417 svalue the router's string value
8418 rvalue where to put the returned value
8420 Returns: OK value placed in rvalue
8421 DEFER expansion failed
8425 exp_bool(address_item *addr,
8426 uschar *mtype, uschar *mname, unsigned dbg_opt,
8427 uschar *oname, BOOL bvalue,
8428 uschar *svalue, BOOL *rvalue)
8431 if (!svalue) { *rvalue = bvalue; return OK; }
8433 if (!(expanded = expand_string(svalue)))
8435 if (f.expand_string_forcedfail)
8437 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8441 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8442 oname, mname, mtype, expand_string_message);
8443 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8447 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8450 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8452 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8456 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8457 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8466 /* Avoid potentially exposing a password in a string about to be logged */
8469 expand_hide_passwords(uschar * s)
8471 return ( ( Ustrstr(s, "failed to expand") != NULL
8472 || Ustrstr(s, "expansion of ") != NULL
8474 && ( Ustrstr(s, "mysql") != NULL
8475 || Ustrstr(s, "pgsql") != NULL
8476 || Ustrstr(s, "redis") != NULL
8477 || Ustrstr(s, "sqlite") != NULL
8478 || Ustrstr(s, "ldap:") != NULL
8479 || Ustrstr(s, "ldaps:") != NULL
8480 || Ustrstr(s, "ldapi:") != NULL
8481 || Ustrstr(s, "ldapdn:") != NULL
8482 || Ustrstr(s, "ldapm:") != NULL
8484 ? US"Temporary internal error" : s;
8488 /* Read given named file into big_buffer. Use for keying material etc.
8489 The content will have an ascii NUL appended.
8494 Return: pointer to buffer, or NULL on error.
8498 expand_file_big_buffer(const uschar * filename)
8500 int fd, off = 0, len;
8502 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8504 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8511 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8514 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8522 big_buffer[off] = '\0';
8528 /*************************************************
8529 * Error-checking for testsuite *
8530 *************************************************/
8532 uschar * region_start;
8533 uschar * region_end;
8534 const uschar *var_name;
8535 const uschar *var_data;
8539 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8542 if (var_data >= e->region_start && var_data < e->region_end)
8544 e->var_name = CUS var_name;
8545 e->var_data = CUS var_data;
8550 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8552 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8553 .var_name = NULL, .var_data = NULL };
8555 /* check acl_ variables */
8556 tree_walk(acl_var_c, assert_variable_notin, &e);
8557 tree_walk(acl_var_m, assert_variable_notin, &e);
8559 /* check auth<n> variables */
8560 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8561 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
8563 /* check regex<n> variables */
8564 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8565 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
8567 /* check known-name variables */
8568 for (var_entry * v = var_table; v < var_table + var_table_size; v++)
8569 if (v->type == vtype_stringptr)
8570 assert_variable_notin(US v->name, *(USS v->value), &e);
8572 /* check dns and address trees */
8573 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8574 tree_walk(tree_duplicates, assert_variable_notin, &e);
8575 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8576 tree_walk(tree_unusable, assert_variable_notin, &e);
8579 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8580 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8581 e.var_name, filename, linenumber, e.var_data);
8586 /*************************************************
8587 **************************************************
8588 * Stand-alone test program *
8589 **************************************************
8590 *************************************************/
8596 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
8598 int ovector[3*(EXPAND_MAXN+1)];
8599 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8600 ovector, nelem(ovector));
8601 BOOL yield = n >= 0;
8602 if (n == 0) n = EXPAND_MAXN + 1;
8605 expand_nmax = setup < 0 ? 0 : setup + 1;
8606 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8608 expand_nstring[expand_nmax] = subject + ovector[nn];
8609 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8617 int main(int argc, uschar **argv)
8619 uschar buffer[1024];
8621 debug_selector = D_v;
8622 debug_file = stderr;
8623 debug_fd = fileno(debug_file);
8624 big_buffer = malloc(big_buffer_size);
8627 for (int i = 1; i < argc; i++)
8629 if (argv[i][0] == '+')
8631 debug_trace_memory = 2;
8634 if (isdigit(argv[i][0]))
8635 debug_selector = Ustrtol(argv[i], NULL, 0);
8637 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8641 eldap_default_servers = argv[i];
8644 mysql_servers = argv[i];
8647 pgsql_servers = argv[i];
8650 redis_servers = argv[i];
8654 else opt_perl_startup = argv[i];
8658 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8660 expand_nstring[1] = US"string 1....";
8661 expand_nlength[1] = 8;
8665 if (opt_perl_startup != NULL)
8668 printf("Starting Perl interpreter\n");
8669 errstr = init_perl(opt_perl_startup);
8672 printf("** error in perl_startup code: %s\n", errstr);
8673 return EXIT_FAILURE;
8676 #endif /* EXIM_PERL */
8678 /* Thie deliberately regards the input as untainted, so that it can be
8679 expanded; only reasonable since this is a test for string-expansions. */
8681 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8683 rmark reset_point = store_mark();
8684 uschar *yield = expand_string(buffer);
8686 printf("%s\n", yield);
8689 if (f.search_find_defer) printf("search_find deferred\n");
8690 printf("Failed: %s\n", expand_string_message);
8691 if (f.expand_string_forcedfail) printf("Forced failure\n");
8694 store_reset(reset_point);
8706 /* End of expand.c */