1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *);
17 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
20 # ifndef SUPPORT_CRYPTEQ
21 # define SUPPORT_CRYPTEQ
26 # include "lookups/ldap.h"
29 #ifdef SUPPORT_CRYPTEQ
34 extern char* crypt16(char*, char*);
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. Characters after the first 16 are ignored. It always generates
50 a 16-byte hash, which is expressed together with the salt as a string
51 of 24 base 64 digits. Here are some links to peruse:
53 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
54 http://seclists.org/bugtraq/1999/Mar/0076.html
56 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
57 and OSF/1. This is the same as the standard crypt if given a password
58 of 8 characters or less. If given more, it first does the same as crypt
59 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
60 using as salt the first two base 64 digits from the first hash block.
61 If the password is more than 16 characters then it crypts the 17th to 24th
62 characters using as salt the first two base 64 digits from the second hash
63 block. And so on: I've seen references to it cutting off the password at
64 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
66 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
67 http://seclists.org/bugtraq/1999/Mar/0109.html
68 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
69 TET1_html/sec.c222.html#no_id_208
71 Exim has something it calls "crypt16". It will either use a native
72 crypt16 or its own implementation. A native crypt16 will presumably
73 be the one that I called "crypt16" above. The internal "crypt16"
74 function, however, is a two-block-maximum implementation of what I called
75 "bigcrypt". The documentation matches the internal code.
77 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
78 that crypt16 and bigcrypt were different things.
80 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
81 to whatever it is using under that name. This unfortunately sets a
82 precedent for using "{crypt16}" to identify two incompatible algorithms
83 whose output can't be distinguished. With "{crypt16}" thus rendered
84 ambiguous, I suggest you deprecate it and invent two new identifiers
85 for the two algorithms.
87 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
88 of the password separately means they can be cracked separately, so
89 the double-length hash only doubles the cracking effort instead of
90 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
166 /* Tables of operator names, and corresponding switch numbers. The names must be
167 in alphabetical order. There are two tables, because underscore is used in some
168 cases to introduce arguments, whereas for other it is part of the name. This is
169 an historical mis-design. */
171 static uschar *op_table_underscore[] = {
174 US"quote_local_part",
179 ,US"utf8_domain_from_alabel",
180 US"utf8_domain_to_alabel",
181 US"utf8_localpart_from_alabel",
182 US"utf8_localpart_to_alabel"
189 EOP_QUOTE_LOCAL_PART,
194 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
195 EOP_UTF8_DOMAIN_TO_ALABEL,
196 EOP_UTF8_LOCALPART_FROM_ALABEL,
197 EOP_UTF8_LOCALPART_TO_ALABEL
201 static uschar *op_table_main[] = {
249 EOP_ADDRESS = nelem(op_table_underscore),
296 /* Table of condition names, and corresponding switch numbers. The names must
297 be in alphabetical order. */
299 static uschar *cond_table[] = {
303 US"==", /* Backward compatibility */
340 US"match_local_part",
365 ECOND_FIRST_DELIVERY,
390 ECOND_MATCH_LOCAL_PART,
400 /* Types of table entry */
403 vtype_int, /* value is address of int */
404 vtype_filter_int, /* ditto, but recognized only when filtering */
405 vtype_ino, /* value is address of ino_t (not always an int) */
406 vtype_uid, /* value is address of uid_t (not always an int) */
407 vtype_gid, /* value is address of gid_t (not always an int) */
408 vtype_bool, /* value is address of bool */
409 vtype_stringptr, /* value is address of pointer to string */
410 vtype_msgbody, /* as stringptr, but read when first required */
411 vtype_msgbody_end, /* ditto, the end of the message */
412 vtype_msgheaders, /* the message's headers, processed */
413 vtype_msgheaders_raw, /* the message's headers, unprocessed */
414 vtype_localpart, /* extract local part from string */
415 vtype_domain, /* extract domain from string */
416 vtype_string_func, /* value is string returned by given function */
417 vtype_todbsdin, /* value not used; generate BSD inbox tod */
418 vtype_tode, /* value not used; generate tod in epoch format */
419 vtype_todel, /* value not used; generate tod in epoch/usec format */
420 vtype_todf, /* value not used; generate full tod */
421 vtype_todl, /* value not used; generate log tod */
422 vtype_todlf, /* value not used; generate log file datestamp tod */
423 vtype_todzone, /* value not used; generate time zone only */
424 vtype_todzulu, /* value not used; generate zulu tod */
425 vtype_reply, /* value not used; get reply from headers */
426 vtype_pid, /* value not used; result is pid */
427 vtype_host_lookup, /* value not used; get host name */
428 vtype_load_avg, /* value not used; result is int from os_getloadavg */
429 vtype_pspace, /* partition space; value is T/F for spool/log */
430 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
431 vtype_cert /* SSL certificate */
433 ,vtype_dkim /* Lookup of value in DKIM signature */
437 /* Type for main variable table */
445 /* Type for entries pointing to address/length pairs. Not currently
453 static uschar * fn_recipients(void);
455 /* This table must be kept in alphabetical order. */
457 static var_entry var_table[] = {
458 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
459 they will be confused with user-creatable ACL variables. */
460 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
461 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
462 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
463 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
464 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
465 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
466 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
467 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
468 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
469 { "acl_narg", vtype_int, &acl_narg },
470 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
471 { "address_data", vtype_stringptr, &deliver_address_data },
472 { "address_file", vtype_stringptr, &address_file },
473 { "address_pipe", vtype_stringptr, &address_pipe },
474 #ifdef EXPERIMENTAL_ARC
475 { "arc_domains", vtype_string_func, &fn_arc_domains },
476 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
477 { "arc_state", vtype_stringptr, &arc_state },
478 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
480 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
481 { "authenticated_id", vtype_stringptr, &authenticated_id },
482 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
483 { "authentication_failed",vtype_int, &authentication_failed },
484 #ifdef WITH_CONTENT_SCAN
485 { "av_failed", vtype_int, &av_failed },
487 #ifdef EXPERIMENTAL_BRIGHTMAIL
488 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
489 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
490 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
491 { "bmi_deliver", vtype_int, &bmi_deliver },
493 { "body_linecount", vtype_int, &body_linecount },
494 { "body_zerocount", vtype_int, &body_zerocount },
495 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
496 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
497 { "caller_gid", vtype_gid, &real_gid },
498 { "caller_uid", vtype_uid, &real_uid },
499 { "callout_address", vtype_stringptr, &callout_address },
500 { "compile_date", vtype_stringptr, &version_date },
501 { "compile_number", vtype_stringptr, &version_cnumber },
502 { "config_dir", vtype_stringptr, &config_main_directory },
503 { "config_file", vtype_stringptr, &config_main_filename },
504 { "csa_status", vtype_stringptr, &csa_status },
505 #ifdef EXPERIMENTAL_DCC
506 { "dcc_header", vtype_stringptr, &dcc_header },
507 { "dcc_result", vtype_stringptr, &dcc_result },
510 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
511 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
512 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
513 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
514 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
515 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
516 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
517 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
518 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
519 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
520 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
521 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
522 { "dkim_key_length", vtype_int, &dkim_key_length },
523 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
524 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
525 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
526 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
527 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
528 { "dkim_signers", vtype_stringptr, &dkim_signers },
529 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
530 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
532 #ifdef EXPERIMENTAL_DMARC
533 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
534 { "dmarc_status", vtype_stringptr, &dmarc_status },
535 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
536 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
538 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
539 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
540 { "dnslist_text", vtype_stringptr, &dnslist_text },
541 { "dnslist_value", vtype_stringptr, &dnslist_value },
542 { "domain", vtype_stringptr, &deliver_domain },
543 { "domain_data", vtype_stringptr, &deliver_domain_data },
544 #ifndef DISABLE_EVENT
545 { "event_data", vtype_stringptr, &event_data },
547 /*XXX want to use generic vars for as many of these as possible*/
548 { "event_defer_errno", vtype_int, &event_defer_errno },
550 { "event_name", vtype_stringptr, &event_name },
552 { "exim_gid", vtype_gid, &exim_gid },
553 { "exim_path", vtype_stringptr, &exim_path },
554 { "exim_uid", vtype_uid, &exim_uid },
555 { "exim_version", vtype_stringptr, &version_string },
556 { "headers_added", vtype_string_func, &fn_hdrs_added },
557 { "home", vtype_stringptr, &deliver_home },
558 { "host", vtype_stringptr, &deliver_host },
559 { "host_address", vtype_stringptr, &deliver_host_address },
560 { "host_data", vtype_stringptr, &host_data },
561 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
562 { "host_lookup_failed", vtype_int, &host_lookup_failed },
563 { "host_port", vtype_int, &deliver_host_port },
564 { "initial_cwd", vtype_stringptr, &initial_cwd },
565 { "inode", vtype_ino, &deliver_inode },
566 { "interface_address", vtype_stringptr, &interface_address },
567 { "interface_port", vtype_int, &interface_port },
568 { "item", vtype_stringptr, &iterate_item },
570 { "ldap_dn", vtype_stringptr, &eldap_dn },
572 { "load_average", vtype_load_avg, NULL },
573 { "local_part", vtype_stringptr, &deliver_localpart },
574 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
575 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
576 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
577 #ifdef HAVE_LOCAL_SCAN
578 { "local_scan_data", vtype_stringptr, &local_scan_data },
580 { "local_user_gid", vtype_gid, &local_user_gid },
581 { "local_user_uid", vtype_uid, &local_user_uid },
582 { "localhost_number", vtype_int, &host_number },
583 { "log_inodes", vtype_pinodes, (void *)FALSE },
584 { "log_space", vtype_pspace, (void *)FALSE },
585 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
586 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
587 #ifdef WITH_CONTENT_SCAN
588 { "malware_name", vtype_stringptr, &malware_name },
590 { "max_received_linelength", vtype_int, &max_received_linelength },
591 { "message_age", vtype_int, &message_age },
592 { "message_body", vtype_msgbody, &message_body },
593 { "message_body_end", vtype_msgbody_end, &message_body_end },
594 { "message_body_size", vtype_int, &message_body_size },
595 { "message_exim_id", vtype_stringptr, &message_id },
596 { "message_headers", vtype_msgheaders, NULL },
597 { "message_headers_raw", vtype_msgheaders_raw, NULL },
598 { "message_id", vtype_stringptr, &message_id },
599 { "message_linecount", vtype_int, &message_linecount },
600 { "message_size", vtype_int, &message_size },
602 { "message_smtputf8", vtype_bool, &message_smtputf8 },
604 #ifdef WITH_CONTENT_SCAN
605 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
606 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
607 { "mime_boundary", vtype_stringptr, &mime_boundary },
608 { "mime_charset", vtype_stringptr, &mime_charset },
609 { "mime_content_description", vtype_stringptr, &mime_content_description },
610 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
611 { "mime_content_id", vtype_stringptr, &mime_content_id },
612 { "mime_content_size", vtype_int, &mime_content_size },
613 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
614 { "mime_content_type", vtype_stringptr, &mime_content_type },
615 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
616 { "mime_filename", vtype_stringptr, &mime_filename },
617 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
618 { "mime_is_multipart", vtype_int, &mime_is_multipart },
619 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
620 { "mime_part_count", vtype_int, &mime_part_count },
622 { "n0", vtype_filter_int, &filter_n[0] },
623 { "n1", vtype_filter_int, &filter_n[1] },
624 { "n2", vtype_filter_int, &filter_n[2] },
625 { "n3", vtype_filter_int, &filter_n[3] },
626 { "n4", vtype_filter_int, &filter_n[4] },
627 { "n5", vtype_filter_int, &filter_n[5] },
628 { "n6", vtype_filter_int, &filter_n[6] },
629 { "n7", vtype_filter_int, &filter_n[7] },
630 { "n8", vtype_filter_int, &filter_n[8] },
631 { "n9", vtype_filter_int, &filter_n[9] },
632 { "original_domain", vtype_stringptr, &deliver_domain_orig },
633 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
634 { "originator_gid", vtype_gid, &originator_gid },
635 { "originator_uid", vtype_uid, &originator_uid },
636 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
637 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
638 { "pid", vtype_pid, NULL },
640 { "prdr_requested", vtype_bool, &prdr_requested },
642 { "primary_hostname", vtype_stringptr, &primary_hostname },
643 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
644 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
645 { "proxy_external_port", vtype_int, &proxy_external_port },
646 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
647 { "proxy_local_port", vtype_int, &proxy_local_port },
648 { "proxy_session", vtype_bool, &proxy_session },
650 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
651 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
652 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
653 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
654 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
655 { "queue_name", vtype_stringptr, &queue_name },
656 { "rcpt_count", vtype_int, &rcpt_count },
657 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
658 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
659 { "received_count", vtype_int, &received_count },
660 { "received_for", vtype_stringptr, &received_for },
661 { "received_ip_address", vtype_stringptr, &interface_address },
662 { "received_port", vtype_int, &interface_port },
663 { "received_protocol", vtype_stringptr, &received_protocol },
664 { "received_time", vtype_int, &received_time.tv_sec },
665 { "recipient_data", vtype_stringptr, &recipient_data },
666 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
667 { "recipients", vtype_string_func, &fn_recipients },
668 { "recipients_count", vtype_int, &recipients_count },
669 #ifdef WITH_CONTENT_SCAN
670 { "regex_match_string", vtype_stringptr, ®ex_match_string },
672 { "reply_address", vtype_reply, NULL },
673 { "return_path", vtype_stringptr, &return_path },
674 { "return_size_limit", vtype_int, &bounce_return_size_limit },
675 { "router_name", vtype_stringptr, &router_name },
676 { "runrc", vtype_int, &runrc },
677 { "self_hostname", vtype_stringptr, &self_hostname },
678 { "sender_address", vtype_stringptr, &sender_address },
679 { "sender_address_data", vtype_stringptr, &sender_address_data },
680 { "sender_address_domain", vtype_domain, &sender_address },
681 { "sender_address_local_part", vtype_localpart, &sender_address },
682 { "sender_data", vtype_stringptr, &sender_data },
683 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
684 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
685 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
686 { "sender_host_address", vtype_stringptr, &sender_host_address },
687 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
688 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
689 { "sender_host_name", vtype_host_lookup, NULL },
690 { "sender_host_port", vtype_int, &sender_host_port },
691 { "sender_ident", vtype_stringptr, &sender_ident },
692 { "sender_rate", vtype_stringptr, &sender_rate },
693 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
694 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
695 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
696 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
697 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
698 { "sending_port", vtype_int, &sending_port },
699 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
700 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
701 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
702 { "smtp_command_history", vtype_string_func, &smtp_cmd_hist },
703 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
704 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
705 { "sn0", vtype_filter_int, &filter_sn[0] },
706 { "sn1", vtype_filter_int, &filter_sn[1] },
707 { "sn2", vtype_filter_int, &filter_sn[2] },
708 { "sn3", vtype_filter_int, &filter_sn[3] },
709 { "sn4", vtype_filter_int, &filter_sn[4] },
710 { "sn5", vtype_filter_int, &filter_sn[5] },
711 { "sn6", vtype_filter_int, &filter_sn[6] },
712 { "sn7", vtype_filter_int, &filter_sn[7] },
713 { "sn8", vtype_filter_int, &filter_sn[8] },
714 { "sn9", vtype_filter_int, &filter_sn[9] },
715 #ifdef WITH_CONTENT_SCAN
716 { "spam_action", vtype_stringptr, &spam_action },
717 { "spam_bar", vtype_stringptr, &spam_bar },
718 { "spam_report", vtype_stringptr, &spam_report },
719 { "spam_score", vtype_stringptr, &spam_score },
720 { "spam_score_int", vtype_stringptr, &spam_score_int },
723 { "spf_guess", vtype_stringptr, &spf_guess },
724 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
725 { "spf_received", vtype_stringptr, &spf_received },
726 { "spf_result", vtype_stringptr, &spf_result },
727 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
728 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
730 { "spool_directory", vtype_stringptr, &spool_directory },
731 { "spool_inodes", vtype_pinodes, (void *)TRUE },
732 { "spool_space", vtype_pspace, (void *)TRUE },
733 #ifdef EXPERIMENTAL_SRS
734 { "srs_db_address", vtype_stringptr, &srs_db_address },
735 { "srs_db_key", vtype_stringptr, &srs_db_key },
736 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
737 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
738 { "srs_recipient", vtype_stringptr, &srs_recipient },
739 { "srs_status", vtype_stringptr, &srs_status },
741 { "thisaddress", vtype_stringptr, &filter_thisaddress },
743 /* The non-(in,out) variables are now deprecated */
744 { "tls_bits", vtype_int, &tls_in.bits },
745 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
746 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
748 { "tls_in_bits", vtype_int, &tls_in.bits },
749 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
750 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
751 { "tls_in_cipher_std", vtype_stringptr, &tls_in.cipher_stdname },
752 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
753 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
754 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
755 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
756 #ifdef EXPERIMENTAL_TLS_RESUME
757 { "tls_in_resumption", vtype_int, &tls_in.resumption },
759 #if defined(SUPPORT_TLS)
760 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
762 { "tls_out_bits", vtype_int, &tls_out.bits },
763 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
764 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
765 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },
767 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
769 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
770 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
771 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
772 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
773 #ifdef EXPERIMENTAL_TLS_RESUME
774 { "tls_out_resumption", vtype_int, &tls_out.resumption },
776 #if defined(SUPPORT_TLS)
777 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
780 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
783 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
784 #if defined(SUPPORT_TLS)
785 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
788 { "tod_bsdinbox", vtype_todbsdin, NULL },
789 { "tod_epoch", vtype_tode, NULL },
790 { "tod_epoch_l", vtype_todel, NULL },
791 { "tod_full", vtype_todf, NULL },
792 { "tod_log", vtype_todl, NULL },
793 { "tod_logfile", vtype_todlf, NULL },
794 { "tod_zone", vtype_todzone, NULL },
795 { "tod_zulu", vtype_todzulu, NULL },
796 { "transport_name", vtype_stringptr, &transport_name },
797 { "value", vtype_stringptr, &lookup_value },
798 { "verify_mode", vtype_stringptr, &verify_mode },
799 { "version_number", vtype_stringptr, &version_string },
800 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
801 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
802 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
803 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
804 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
805 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
808 static int var_table_size = nelem(var_table);
809 static uschar var_buffer[256];
810 static BOOL malformed_header;
812 /* For textual hashes */
814 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
815 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
818 enum { HMAC_MD5, HMAC_SHA1 };
820 /* For numeric hashes */
822 static unsigned int prime[] = {
823 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
824 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
825 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
827 /* For printing modes in symbolic form */
829 static uschar *mtable_normal[] =
830 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
832 static uschar *mtable_setid[] =
833 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
835 static uschar *mtable_sticky[] =
836 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
838 /* flags for find_header() */
839 #define FH_EXISTS_ONLY BIT(0)
840 #define FH_WANT_RAW BIT(1)
841 #define FH_WANT_LIST BIT(2)
844 /*************************************************
845 * Tables for UTF-8 support *
846 *************************************************/
848 /* Table of the number of extra characters, indexed by the first character
849 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
852 static uschar utf8_table1[] = {
853 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
854 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
855 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
856 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
858 /* These are the masks for the data bits in the first byte of a character,
859 indexed by the number of additional bytes. */
861 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
863 /* Get the next UTF-8 character, advancing the pointer. */
865 #define GETUTF8INC(c, ptr) \
867 if ((c & 0xc0) == 0xc0) \
869 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
871 c = (c & utf8_table2[a]) << s; \
875 c |= (*ptr++ & 0x3f) << s; \
881 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
883 /*************************************************
884 * Binary chop search on a table *
885 *************************************************/
887 /* This is used for matching expansion items and operators.
890 name the name that is being sought
891 table the table to search
892 table_size the number of items in the table
894 Returns: the offset in the table, or -1
898 chop_match(uschar *name, uschar **table, int table_size)
900 uschar **bot = table;
901 uschar **top = table + table_size;
905 uschar **mid = bot + (top - bot)/2;
906 int c = Ustrcmp(name, *mid);
907 if (c == 0) return mid - table;
908 if (c > 0) bot = mid + 1; else top = mid;
916 /*************************************************
917 * Check a condition string *
918 *************************************************/
920 /* This function is called to expand a string, and test the result for a "true"
921 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
922 forced fail or lookup defer.
924 We used to release all store used, but this is not not safe due
925 to ${dlfunc } and ${acl }. In any case expand_string_internal()
926 is reasonably careful to release what it can.
928 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
931 condition the condition string
932 m1 text to be incorporated in panic error
935 Returns: TRUE if condition is met, FALSE if not
939 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
942 uschar *ss = expand_string(condition);
945 if (!f.expand_string_forcedfail && !f.search_find_defer)
946 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
947 "for %s %s: %s", condition, m1, m2, expand_string_message);
950 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
951 strcmpic(ss, US"false") != 0;
958 /*************************************************
959 * Pseudo-random number generation *
960 *************************************************/
962 /* Pseudo-random number generation. The result is not "expected" to be
963 cryptographically strong but not so weak that someone will shoot themselves
964 in the foot using it as a nonce in some email header scheme or whatever
965 weirdness they'll twist this into. The result should ideally handle fork().
967 However, if we're stuck unable to provide this, then we'll fall back to
968 appallingly bad randomness.
970 If SUPPORT_TLS is defined then this will not be used except as an emergency
975 Returns a random number in range [0, max-1]
979 # define vaguely_random_number vaguely_random_number_fallback
982 vaguely_random_number(int max)
985 # undef vaguely_random_number
987 static pid_t pid = 0;
990 if ((p2 = getpid()) != pid)
995 #ifdef HAVE_ARC4RANDOM
996 /* cryptographically strong randomness, common on *BSD platforms, not
997 so much elsewhere. Alas. */
998 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1001 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1002 # ifdef HAVE_SRANDOMDEV
1003 /* uses random(4) for seeding */
1008 gettimeofday(&tv, NULL);
1009 srandom(tv.tv_sec | tv.tv_usec | getpid());
1013 /* Poor randomness and no seeding here */
1020 #ifdef HAVE_ARC4RANDOM
1021 return arc4random() % max;
1022 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1023 return random() % max;
1025 /* This one returns a 16-bit number, definitely not crypto-strong */
1026 return random_number(max);
1033 /*************************************************
1034 * Pick out a name from a string *
1035 *************************************************/
1037 /* If the name is too long, it is silently truncated.
1040 name points to a buffer into which to put the name
1041 max is the length of the buffer
1042 s points to the first alphabetic character of the name
1043 extras chars other than alphanumerics to permit
1045 Returns: pointer to the first character after the name
1047 Note: The test for *s != 0 in the while loop is necessary because
1048 Ustrchr() yields non-NULL if the character is zero (which is not something
1051 static const uschar *
1052 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1055 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1057 if (ptr < max-1) name[ptr++] = *s;
1066 /*************************************************
1067 * Pick out the rest of a header name *
1068 *************************************************/
1070 /* A variable name starting $header_ (or just $h_ for those who like
1071 abbreviations) might not be the complete header name because headers can
1072 contain any printing characters in their names, except ':'. This function is
1073 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1074 on the end, if the name was terminated by white space.
1077 name points to a buffer in which the name read so far exists
1078 max is the length of the buffer
1079 s points to the first character after the name so far, i.e. the
1080 first non-alphameric character after $header_xxxxx
1082 Returns: a pointer to the first character after the header name
1085 static const uschar *
1086 read_header_name(uschar *name, int max, const uschar *s)
1088 int prelen = Ustrchr(name, '_') - name + 1;
1089 int ptr = Ustrlen(name) - prelen;
1090 if (ptr > 0) memmove(name, name+prelen, ptr);
1091 while (mac_isgraph(*s) && *s != ':')
1093 if (ptr < max-1) name[ptr++] = *s;
1104 /*************************************************
1105 * Pick out a number from a string *
1106 *************************************************/
1109 n points to an integer into which to put the number
1110 s points to the first digit of the number
1112 Returns: a pointer to the character after the last digit
1114 /*XXX consider expanding to int_eximarith_t. But the test for
1115 "overbig numbers" in 0002 still needs to overflow it. */
1118 read_number(int *n, uschar *s)
1121 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1125 static const uschar *
1126 read_cnumber(int *n, const uschar *s)
1129 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1135 /*************************************************
1136 * Extract keyed subfield from a string *
1137 *************************************************/
1139 /* The yield is in dynamic store; NULL means that the key was not found.
1142 key points to the name of the key
1143 s points to the string from which to extract the subfield
1145 Returns: NULL if the subfield was not found, or
1146 a pointer to the subfield's data
1150 expand_getkeyed(uschar * key, const uschar * s)
1152 int length = Ustrlen(key);
1153 while (isspace(*s)) s++;
1155 /* Loop to search for the key */
1161 const uschar * dkey = s;
1163 while (*s && *s != '=' && !isspace(*s)) s++;
1164 dkeylength = s - dkey;
1165 while (isspace(*s)) s++;
1166 if (*s == '=') while (isspace((*(++s))));
1168 data = string_dequote(&s);
1169 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1172 while (isspace(*s)) s++;
1181 find_var_ent(uschar * name)
1184 int last = var_table_size;
1186 while (last > first)
1188 int middle = (first + last)/2;
1189 int c = Ustrcmp(name, var_table[middle].name);
1191 if (c > 0) { first = middle + 1; continue; }
1192 if (c < 0) { last = middle; continue; }
1193 return &var_table[middle];
1198 /*************************************************
1199 * Extract numbered subfield from string *
1200 *************************************************/
1202 /* Extracts a numbered field from a string that is divided by tokens - for
1203 example a line from /etc/passwd is divided by colon characters. First field is
1204 numbered one. Negative arguments count from the right. Zero returns the whole
1205 string. Returns NULL if there are insufficient tokens in the string
1208 Modifies final argument - this is a dynamically generated string, so that's OK.
1211 field number of field to be extracted,
1212 first field = 1, whole string = 0, last field = -1
1213 separators characters that are used to break string into tokens
1214 s points to the string from which to extract the subfield
1216 Returns: NULL if the field was not found,
1217 a pointer to the field's data inside s (modified to add 0)
1221 expand_gettokened (int field, uschar *separators, uschar *s)
1226 uschar *fieldtext = NULL;
1228 if (field == 0) return s;
1230 /* Break the line up into fields in place; for field > 0 we stop when we have
1231 done the number of fields we want. For field < 0 we continue till the end of
1232 the string, counting the number of fields. */
1234 count = (field > 0)? field : INT_MAX;
1240 /* Previous field was the last one in the string. For a positive field
1241 number, this means there are not enough fields. For a negative field number,
1242 check that there are enough, and scan back to find the one that is wanted. */
1246 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1247 if ((-field) == (INT_MAX - count - 1)) return s;
1251 while (ss[-1] != 0) ss--;
1257 /* Previous field was not last in the string; save its start and put a
1261 len = Ustrcspn(ss, separators);
1272 expand_getlistele(int field, const uschar * list)
1274 const uschar * tlist = list;
1280 for (field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1283 if (field == 0) return NULL;
1284 while (--field > 0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1285 return string_nextinlist(&list, &sep, NULL, 0);
1289 /* Certificate fields, by name. Worry about by-OID later */
1290 /* Names are chosen to not have common prefixes */
1297 uschar * (*getfn)(void * cert, uschar * mod);
1299 static certfield certfields[] =
1300 { /* linear search; no special order */
1301 { US"version", 7, &tls_cert_version },
1302 { US"serial_number", 13, &tls_cert_serial_number },
1303 { US"subject", 7, &tls_cert_subject },
1304 { US"notbefore", 9, &tls_cert_not_before },
1305 { US"notafter", 8, &tls_cert_not_after },
1306 { US"issuer", 6, &tls_cert_issuer },
1307 { US"signature", 9, &tls_cert_signature },
1308 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1309 { US"subj_altname", 12, &tls_cert_subject_altname },
1310 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1311 { US"crl_uri", 7, &tls_cert_crl_uri },
1315 expand_getcertele(uschar * field, uschar * certvar)
1319 if (!(vp = find_var_ent(certvar)))
1321 expand_string_message =
1322 string_sprintf("no variable named \"%s\"", certvar);
1323 return NULL; /* Unknown variable name */
1325 /* NB this stops us passing certs around in variable. Might
1326 want to do that in future */
1327 if (vp->type != vtype_cert)
1329 expand_string_message =
1330 string_sprintf("\"%s\" is not a certificate", certvar);
1331 return NULL; /* Unknown variable name */
1333 if (!*(void **)vp->value)
1336 if (*field >= '0' && *field <= '9')
1337 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1339 for (certfield * cp = certfields;
1340 cp < certfields + nelem(certfields);
1342 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1344 uschar * modifier = *(field += cp->namelen) == ','
1346 return (*cp->getfn)( *(void **)vp->value, modifier );
1349 expand_string_message =
1350 string_sprintf("bad field selector \"%s\" for certextract", field);
1353 #endif /*SUPPORT_TLS*/
1355 /*************************************************
1356 * Extract a substring from a string *
1357 *************************************************/
1359 /* Perform the ${substr or ${length expansion operations.
1362 subject the input string
1363 value1 the offset from the start of the input string to the start of
1364 the output string; if negative, count from the right.
1365 value2 the length of the output string, or negative (-1) for unset
1366 if value1 is positive, unset means "all after"
1367 if value1 is negative, unset means "all before"
1368 len set to the length of the returned string
1370 Returns: pointer to the output string, or NULL if there is an error
1374 extract_substr(uschar *subject, int value1, int value2, int *len)
1376 int sublen = Ustrlen(subject);
1378 if (value1 < 0) /* count from right */
1382 /* If the position is before the start, skip to the start, and adjust the
1383 length. If the length ends up negative, the substring is null because nothing
1384 can precede. This falls out naturally when the length is unset, meaning "all
1390 if (value2 < 0) value2 = 0;
1394 /* Otherwise an unset length => characters before value1 */
1396 else if (value2 < 0)
1403 /* For a non-negative offset, if the starting position is past the end of the
1404 string, the result will be the null string. Otherwise, an unset length means
1405 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1409 if (value1 > sublen)
1414 else if (value2 < 0) value2 = sublen;
1417 /* Cut the length down to the maximum possible for the offset value, and get
1418 the required characters. */
1420 if (value1 + value2 > sublen) value2 = sublen - value1;
1422 return subject + value1;
1428 /*************************************************
1429 * Old-style hash of a string *
1430 *************************************************/
1432 /* Perform the ${hash expansion operation.
1435 subject the input string (an expanded substring)
1436 value1 the length of the output string; if greater or equal to the
1437 length of the input string, the input string is returned
1438 value2 the number of hash characters to use, or 26 if negative
1439 len set to the length of the returned string
1441 Returns: pointer to the output string, or NULL if there is an error
1445 compute_hash(uschar *subject, int value1, int value2, int *len)
1447 int sublen = Ustrlen(subject);
1449 if (value2 < 0) value2 = 26;
1450 else if (value2 > Ustrlen(hashcodes))
1452 expand_string_message =
1453 string_sprintf("hash count \"%d\" too big", value2);
1457 /* Calculate the hash text. We know it is shorter than the original string, so
1458 can safely place it in subject[] (we know that subject is always itself an
1459 expanded substring). */
1461 if (value1 < sublen)
1466 while ((c = (subject[j])) != 0)
1468 int shift = (c + j++) & 7;
1469 subject[i] ^= (c << shift) | (c >> (8-shift));
1470 if (++i >= value1) i = 0;
1472 for (i = 0; i < value1; i++)
1473 subject[i] = hashcodes[(subject[i]) % value2];
1475 else value1 = sublen;
1484 /*************************************************
1485 * Numeric hash of a string *
1486 *************************************************/
1488 /* Perform the ${nhash expansion operation. The first characters of the
1489 string are treated as most important, and get the highest prime numbers.
1492 subject the input string
1493 value1 the maximum value of the first part of the result
1494 value2 the maximum value of the second part of the result,
1495 or negative to produce only a one-part result
1496 len set to the length of the returned string
1498 Returns: pointer to the output string, or NULL if there is an error.
1502 compute_nhash (uschar *subject, int value1, int value2, int *len)
1504 uschar *s = subject;
1506 unsigned long int total = 0; /* no overflow */
1510 if (i == 0) i = nelem(prime) - 1;
1511 total += prime[i--] * (unsigned int)(*s++);
1514 /* If value2 is unset, just compute one number */
1517 s = string_sprintf("%lu", total % value1);
1519 /* Otherwise do a div/mod hash */
1523 total = total % (value1 * value2);
1524 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1535 /*************************************************
1536 * Find the value of a header or headers *
1537 *************************************************/
1539 /* Multiple instances of the same header get concatenated, and this function
1540 can also return a concatenation of all the header lines. When concatenating
1541 specific headers that contain lists of addresses, a comma is inserted between
1542 them. Otherwise we use a straight concatenation. Because some messages can have
1543 pathologically large number of lines, there is a limit on the length that is
1547 name the name of the header, without the leading $header_ or $h_,
1548 or NULL if a concatenation of all headers is required
1549 newsize return the size of memory block that was obtained; may be NULL
1550 if exists_only is TRUE
1551 flags FH_EXISTS_ONLY
1552 set if called from a def: test; don't need to build a string;
1553 just return a string that is not "" and not "0" if the header
1556 set if called for $rh_ or $rheader_ items; no processing,
1557 other than concatenating, will be done on the header. Also used
1558 for $message_headers_raw.
1560 Double colon chars in the content, and replace newline with
1561 colon between each element when concatenating; returning a
1562 colon-sep list (elements might contain newlines)
1563 charset name of charset to translate MIME words to; used only if
1564 want_raw is false; if NULL, no translation is done (this is
1565 used for $bh_ and $bheader_)
1567 Returns: NULL if the header does not exist, else a pointer to a new
1572 find_header(uschar *name, int *newsize, unsigned flags, uschar *charset)
1575 int len = name ? Ustrlen(name) : 0;
1579 for (header_line * h = header_list; h; h = h->next)
1580 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1581 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1586 if (flags & FH_EXISTS_ONLY)
1587 return US"1"; /* don't need actual string */
1590 s = h->text + len; /* text to insert */
1591 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1592 while (isspace(*s)) s++; /* remove leading white space */
1593 t = h->text + h->slen; /* end-point */
1595 /* Unless wanted raw, remove trailing whitespace, including the
1598 if (flags & FH_WANT_LIST)
1599 while (t > s && t[-1] == '\n') t--;
1600 else if (!(flags & FH_WANT_RAW))
1602 while (t > s && isspace(t[-1])) t--;
1604 /* Set comma if handling a single header and it's one of those
1605 that contains an address list, except when asked for raw headers. Only
1606 need to do this once. */
1608 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1611 /* Trim the header roughly if we're approaching limits */
1613 if ((g ? g->ptr : 0) + inc > header_insert_maxlen)
1614 inc = header_insert_maxlen - (g ? g->ptr : 0);
1616 /* For raw just copy the data; for a list, add the data as a colon-sep
1617 list-element; for comma-list add as an unchecked comma,newline sep
1618 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1619 stripped trailing WS above including the newline). We ignore the potential
1620 expansion due to colon-doubling, just leaving the loop if the limit is met
1623 if (flags & FH_WANT_LIST)
1624 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1625 else if (flags & FH_WANT_RAW)
1627 g = string_catn(g, s, (unsigned)inc);
1628 (void) string_from_gstring(g);
1632 g = string_append2_listele_n(g, US",\n", s, (unsigned)inc);
1634 g = string_append2_listele_n(g, US"\n", s, (unsigned)inc);
1636 if (g && g->ptr >= header_insert_maxlen) break;
1639 if (!found) return NULL; /* No header found */
1640 if (!g) return US"";
1642 /* That's all we do for raw header expansion. */
1645 if (flags & FH_WANT_RAW)
1648 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1649 The rfc2047_decode2() function can return an error with decoded data if the
1650 charset translation fails. If decoding fails, it returns NULL. */
1654 uschar *decoded, *error;
1656 decoded = rfc2047_decode2(g->s, check_rfc2047_length, charset, '?', NULL,
1660 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1661 " input was: %s\n", error, g->s);
1663 return decoded ? decoded : g->s;
1670 /* Append a "local" element to an Authentication-Results: header
1671 if this was a non-smtp message.
1675 authres_local(gstring * g, const uschar * sysname)
1677 if (!f.authentication_local)
1679 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1680 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1685 /* Append an "iprev" element to an Authentication-Results: header
1686 if we have attempted to get the calling host's name.
1690 authres_iprev(gstring * g)
1692 if (sender_host_name)
1693 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1694 else if (host_lookup_deferred)
1695 g = string_catn(g, US";\n\tiprev=temperror", 19);
1696 else if (host_lookup_failed)
1697 g = string_catn(g, US";\n\tiprev=fail", 13);
1701 if (sender_host_address)
1702 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1708 /*************************************************
1709 * Return list of recipients *
1710 *************************************************/
1711 /* A recipients list is available only during system message filtering,
1712 during ACL processing after DATA, and while expanding pipe commands
1713 generated from a system filter, but not elsewhere. */
1721 if (!f.enable_dollar_recipients) return NULL;
1723 for (int i = 0; i < recipients_count; i++)
1725 s = recipients_list[i].address;
1726 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1728 return g ? g->s : NULL;
1732 /*************************************************
1733 * Find value of a variable *
1734 *************************************************/
1736 /* The table of variables is kept in alphabetic order, so we can search it
1737 using a binary chop. The "choplen" variable is nothing to do with the binary
1741 name the name of the variable being sought
1742 exists_only TRUE if this is a def: test; passed on to find_header()
1743 skipping TRUE => skip any processing evaluation; this is not the same as
1744 exists_only because def: may test for values that are first
1746 newsize pointer to an int which is initially zero; if the answer is in
1747 a new memory buffer, *newsize is set to its size
1749 Returns: NULL if the variable does not exist, or
1750 a pointer to the variable's contents, or
1751 something non-NULL if exists_only is TRUE
1755 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1762 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1763 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1764 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1765 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1766 (this gave backwards compatibility at the changeover). There may be built-in
1767 variables whose names start acl_ but they should never start in this way. This
1768 slightly messy specification is a consequence of the history, needless to say.
1770 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1771 set, in which case give an error. */
1773 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1777 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1778 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1781 /* Handle $auth<n> variables. */
1783 if (Ustrncmp(name, "auth", 4) == 0)
1786 int n = Ustrtoul(name + 4, &endptr, 10);
1787 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1788 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1790 else if (Ustrncmp(name, "regex", 5) == 0)
1793 int n = Ustrtoul(name + 5, &endptr, 10);
1794 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1795 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1798 /* For all other variables, search the table */
1800 if (!(vp = find_var_ent(name)))
1801 return NULL; /* Unknown variable name */
1803 /* Found an existing variable. If in skipping state, the value isn't needed,
1804 and we want to avoid processing (such as looking up the host name). */
1812 case vtype_filter_int:
1813 if (!f.filter_running) return NULL;
1817 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1821 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1825 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1829 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1833 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1836 case vtype_stringptr: /* Pointer to string */
1837 return (s = *((uschar **)(val))) ? s : US"";
1840 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1843 case vtype_load_avg:
1844 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1847 case vtype_host_lookup: /* Lookup if not done so */
1848 if ( !sender_host_name && sender_host_address
1849 && !host_lookup_failed && host_name_lookup() == OK)
1850 host_build_sender_fullhost();
1851 return sender_host_name ? sender_host_name : US"";
1853 case vtype_localpart: /* Get local part from address */
1854 s = *((uschar **)(val));
1855 if (s == NULL) return US"";
1856 domain = Ustrrchr(s, '@');
1857 if (domain == NULL) return s;
1858 if (domain - s > sizeof(var_buffer) - 1)
1859 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1860 " in string expansion", sizeof(var_buffer));
1861 Ustrncpy(var_buffer, s, domain - s);
1862 var_buffer[domain - s] = 0;
1865 case vtype_domain: /* Get domain from address */
1866 s = *((uschar **)(val));
1867 if (s == NULL) return US"";
1868 domain = Ustrrchr(s, '@');
1869 return (domain == NULL)? US"" : domain + 1;
1871 case vtype_msgheaders:
1872 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
1874 case vtype_msgheaders_raw:
1875 return find_header(NULL, newsize,
1876 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
1878 case vtype_msgbody: /* Pointer to msgbody string */
1879 case vtype_msgbody_end: /* Ditto, the end of the msg */
1880 ss = (uschar **)(val);
1881 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1884 off_t start_offset = SPOOL_DATA_START_OFFSET;
1885 int len = message_body_visible;
1886 if (len > message_size) len = message_size;
1887 *ss = body = store_malloc(len+1);
1889 if (vp->type == vtype_msgbody_end)
1891 struct stat statbuf;
1892 if (fstat(deliver_datafile, &statbuf) == 0)
1894 start_offset = statbuf.st_size - len;
1895 if (start_offset < SPOOL_DATA_START_OFFSET)
1896 start_offset = SPOOL_DATA_START_OFFSET;
1899 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1900 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1902 len = read(deliver_datafile, body, len);
1906 if (message_body_newlines) /* Separate loops for efficiency */
1908 { if (body[--len] == 0) body[len] = ' '; }
1911 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1914 return *ss ? *ss : US"";
1916 case vtype_todbsdin: /* BSD inbox time of day */
1917 return tod_stamp(tod_bsdin);
1919 case vtype_tode: /* Unix epoch time of day */
1920 return tod_stamp(tod_epoch);
1922 case vtype_todel: /* Unix epoch/usec time of day */
1923 return tod_stamp(tod_epoch_l);
1925 case vtype_todf: /* Full time of day */
1926 return tod_stamp(tod_full);
1928 case vtype_todl: /* Log format time of day */
1929 return tod_stamp(tod_log_bare); /* (without timezone) */
1931 case vtype_todzone: /* Time zone offset only */
1932 return tod_stamp(tod_zone);
1934 case vtype_todzulu: /* Zulu time */
1935 return tod_stamp(tod_zulu);
1937 case vtype_todlf: /* Log file datestamp tod */
1938 return tod_stamp(tod_log_datestamp_daily);
1940 case vtype_reply: /* Get reply address */
1941 s = find_header(US"reply-to:", newsize,
1942 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
1944 if (s) while (isspace(*s)) s++;
1947 *newsize = 0; /* For the *s==0 case */
1948 s = find_header(US"from:", newsize,
1949 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
1955 while (isspace(*s)) s++;
1956 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1957 while (t > s && isspace(t[-1])) t--;
1960 return s ? s : US"";
1962 case vtype_string_func:
1964 uschar * (*fn)() = val;
1971 sprintf(CS var_buffer, PR_EXIM_ARITH,
1972 receive_statvfs(val == (void *)TRUE, &inodes));
1979 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1980 sprintf(CS var_buffer, "%d", inodes);
1985 return *(void **)val ? US"<cert>" : US"";
1987 #ifndef DISABLE_DKIM
1989 return dkim_exim_expand_query((int)(long)val);
1994 return NULL; /* Unknown variable. Silences static checkers. */
2001 modify_variable(uschar *name, void * value)
2004 if ((vp = find_var_ent(name))) vp->value = value;
2005 return; /* Unknown variable name, fail silently */
2013 /*************************************************
2014 * Read and expand substrings *
2015 *************************************************/
2017 /* This function is called to read and expand argument substrings for various
2018 expansion items. Some have a minimum requirement that is less than the maximum;
2019 in these cases, the first non-present one is set to NULL.
2022 sub points to vector of pointers to set
2023 n maximum number of substrings
2025 sptr points to current string pointer
2026 skipping the skipping flag
2027 check_end if TRUE, check for final '}'
2028 name name of item, for error message
2029 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2032 Returns: 0 OK; string pointer updated
2033 1 curly bracketing error (too few arguments)
2034 2 too many arguments (only if check_end is set); message set
2035 3 other error (expansion failure)
2039 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
2040 BOOL check_end, uschar *name, BOOL *resetok)
2042 const uschar *s = *sptr;
2044 while (isspace(*s)) s++;
2045 for (int i = 0; i < n; i++)
2051 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2052 "(min is %d)", name, m);
2058 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2060 if (*s++ != '}') return 1;
2061 while (isspace(*s)) s++;
2063 if (check_end && *s++ != '}')
2067 expand_string_message = string_sprintf("Too many arguments for '%s' "
2068 "(max is %d)", name, n);
2071 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2082 /*************************************************
2083 * Elaborate message for bad variable *
2084 *************************************************/
2086 /* For the "unknown variable" message, take a look at the variable's name, and
2087 give additional information about possible ACL variables. The extra information
2088 is added on to expand_string_message.
2090 Argument: the name of the variable
2095 check_variable_error_message(uschar *name)
2097 if (Ustrncmp(name, "acl_", 4) == 0)
2098 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2099 (name[4] == 'c' || name[4] == 'm')?
2101 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2102 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2104 US"user-defined ACL variables must start acl_c or acl_m");
2110 Load args from sub array to globals, and call acl_check().
2111 Sub array will be corrupted on return.
2113 Returns: OK access is granted by an ACCEPT verb
2114 DISCARD access is (apparently) granted by a DISCARD verb
2115 FAIL access is denied
2116 FAIL_DROP access is denied; drop the connection
2117 DEFER can't tell at the moment
2121 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2124 int sav_narg = acl_narg;
2126 uschar * dummy_logmsg;
2127 extern int acl_where;
2129 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2130 for (i = 0; i < nsub && sub[i+1]; i++)
2132 uschar * tmp = acl_arg[i];
2133 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2134 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2139 sub[i+1] = acl_arg[i];
2140 acl_arg[i++] = NULL;
2144 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2146 acl_narg>0 ? acl_arg[0] : US"<none>",
2147 acl_narg>1 ? " +more" : "");
2149 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2151 for (i = 0; i < nsub; i++)
2152 acl_arg[i] = sub[i+1]; /* restore old args */
2153 acl_narg = sav_narg;
2161 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2162 The given string is modified on return. Leading whitespace is skipped while
2163 looking for the opening wrap character, then the rest is scanned for the trailing
2164 (non-escaped) wrap character. A backslash in the string will act as an escape.
2166 A nul is written over the trailing wrap, and a pointer to the char after the
2167 leading wrap is returned.
2170 s String for de-wrapping
2171 wrap Two-char string, the first being the opener, second the closer wrapping
2174 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2178 dewrap(uschar * s, const uschar * wrap)
2182 BOOL quotesmode = wrap[0] == wrap[1];
2184 while (isspace(*p)) p++;
2192 if (*p == '\\') p++;
2193 else if (!quotesmode && *p == wrap[-1]) depth++;
2194 else if (*p == *wrap)
2205 expand_string_message = string_sprintf("missing '%c'", *wrap);
2210 /* Pull off the leading array or object element, returning
2211 a copy in an allocated string. Update the list pointer.
2213 The element may itself be an abject or array.
2214 Return NULL when the list is empty.
2218 json_nextinlist(const uschar ** list)
2220 unsigned array_depth = 0, object_depth = 0;
2221 const uschar * s = *list, * item;
2223 while (isspace(*s)) s++;
2226 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2230 case '[': array_depth++; break;
2231 case ']': array_depth--; break;
2232 case '{': object_depth++; break;
2233 case '}': object_depth--; break;
2235 *list = *s ? s+1 : s;
2236 if (item == s) return NULL;
2237 item = string_copyn(item, s - item);
2238 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2244 /*************************************************
2245 * Read and evaluate a condition *
2246 *************************************************/
2250 s points to the start of the condition text
2251 resetok points to a BOOL which is written false if it is unsafe to
2252 free memory. Certain condition types (acl) may have side-effect
2253 allocation which must be preserved.
2254 yield points to a BOOL to hold the result of the condition test;
2255 if NULL, we are just reading through a condition that is
2256 part of an "or" combination to check syntax, or in a state
2257 where the answer isn't required
2259 Returns: a pointer to the first character after the condition, or
2263 static const uschar *
2264 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2266 BOOL testfor = TRUE;
2267 BOOL tempcond, combined_cond;
2269 BOOL sub2_honour_dollar = TRUE;
2270 BOOL is_forany, is_json, is_jsons;
2271 int rc, cond_type, roffset;
2272 int_eximarith_t num[2];
2273 struct stat statbuf;
2275 const uschar *sub[10];
2278 const uschar *rerror;
2282 while (isspace(*s)) s++;
2283 if (*s == '!') { testfor = !testfor; s++; } else break;
2286 /* Numeric comparisons are symbolic */
2288 if (*s == '=' || *s == '>' || *s == '<')
2300 /* All other conditions are named */
2302 else s = read_name(name, 256, s, US"_");
2304 /* If we haven't read a name, it means some non-alpha character is first. */
2308 expand_string_message = string_sprintf("condition name expected, "
2309 "but found \"%.16s\"", s);
2313 /* Find which condition we are dealing with, and switch on it */
2315 cond_type = chop_match(name, cond_table, nelem(cond_table));
2318 /* def: tests for a non-empty variable, or for the existence of a header. If
2319 yield == NULL we are in a skipping state, and don't care about the answer. */
2327 expand_string_message = US"\":\" expected after \"def\"";
2331 s = read_name(name, 256, s+1, US"_");
2333 /* Test for a header's existence. If the name contains a closing brace
2334 character, this may be a user error where the terminating colon has been
2335 omitted. Set a flag to adjust a subsequent error message in this case. */
2337 if ( ( *(t = name) == 'h'
2338 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2340 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2343 s = read_header_name(name, 256, s);
2344 /* {-for-text-editors */
2345 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2347 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2350 /* Test for a variable's having a non-empty value. A non-existent variable
2351 causes an expansion failure. */
2355 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2357 expand_string_message = (name[0] == 0)?
2358 string_sprintf("variable name omitted after \"def:\"") :
2359 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2360 check_variable_error_message(name);
2363 if (yield) *yield = (t[0] != 0) == testfor;
2370 /* first_delivery tests for first delivery attempt */
2372 case ECOND_FIRST_DELIVERY:
2373 if (yield != NULL) *yield = f.deliver_firsttime == testfor;
2377 /* queue_running tests for any process started by a queue runner */
2379 case ECOND_QUEUE_RUNNING:
2380 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2384 /* exists: tests for file existence
2385 isip: tests for any IP address
2386 isip4: tests for an IPv4 address
2387 isip6: tests for an IPv6 address
2388 pam: does PAM authentication
2389 radius: does RADIUS authentication
2390 ldapauth: does LDAP authentication
2391 pwcheck: does Cyrus SASL pwcheck authentication
2400 case ECOND_LDAPAUTH:
2403 while (isspace(*s)) s++;
2404 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2406 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2407 if (sub[0] == NULL) return NULL;
2408 /* {-for-text-editors */
2409 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2411 if (yield == NULL) return s; /* No need to run the test if skipping */
2416 if ((expand_forbid & RDO_EXISTS) != 0)
2418 expand_string_message = US"File existence tests are not permitted";
2421 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2427 rc = string_is_ip_address(sub[0], NULL);
2428 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2429 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2432 /* Various authentication tests - all optionally compiled */
2436 rc = auth_call_pam(sub[0], &expand_string_message);
2439 goto COND_FAILED_NOT_COMPILED;
2440 #endif /* SUPPORT_PAM */
2443 #ifdef RADIUS_CONFIG_FILE
2444 rc = auth_call_radius(sub[0], &expand_string_message);
2447 goto COND_FAILED_NOT_COMPILED;
2448 #endif /* RADIUS_CONFIG_FILE */
2450 case ECOND_LDAPAUTH:
2453 /* Just to keep the interface the same */
2455 int old_pool = store_pool;
2456 store_pool = POOL_SEARCH;
2457 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2458 &expand_string_message, &do_cache);
2459 store_pool = old_pool;
2463 goto COND_FAILED_NOT_COMPILED;
2464 #endif /* LOOKUP_LDAP */
2467 #ifdef CYRUS_PWCHECK_SOCKET
2468 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2471 goto COND_FAILED_NOT_COMPILED;
2472 #endif /* CYRUS_PWCHECK_SOCKET */
2474 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2475 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2477 if (rc == ERROR || rc == DEFER) return NULL;
2478 *yield = (rc == OK) == testfor;
2484 /* call ACL (in a conditional context). Accept true, deny false.
2485 Defer is a forced-fail. Anything set by message= goes to $value.
2486 Up to ten parameters are used; we use the braces round the name+args
2487 like the saslauthd condition does, to permit a variable number of args.
2488 See also the expansion-item version EITEM_ACL and the traditional
2489 acl modifier ACLC_ACL.
2490 Since the ACL may allocate new global variables, tell our caller to not
2495 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2501 while (isspace(*s)) s++;
2502 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2504 switch(read_subs(sub, nelem(sub), 1,
2505 &s, yield == NULL, TRUE, US"acl", resetok))
2507 case 1: expand_string_message = US"too few arguments or bracketing "
2510 case 3: return NULL;
2515 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2516 switch(eval_acl(sub, nelem(sub), &user_msg))
2521 lookup_value = NULL;
2523 lookup_value = string_copy(user_msg);
2524 *yield = cond == testfor;
2528 f.expand_string_forcedfail = TRUE;
2531 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2539 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2541 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2543 However, the last two are optional. That is why the whole set is enclosed
2544 in their own set of braces. */
2546 case ECOND_SASLAUTHD:
2547 #ifndef CYRUS_SASLAUTHD_SOCKET
2548 goto COND_FAILED_NOT_COMPILED;
2552 while (isspace(*s)) s++;
2553 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2554 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2557 case 1: expand_string_message = US"too few arguments or bracketing "
2558 "error for saslauthd";
2560 case 3: return NULL;
2562 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2565 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2566 &expand_string_message);
2567 if (rc == ERROR || rc == DEFER) return NULL;
2568 *yield = (rc == OK) == testfor;
2572 #endif /* CYRUS_SASLAUTHD_SOCKET */
2575 /* symbolic operators for numeric and string comparison, and a number of
2576 other operators, all requiring two arguments.
2578 crypteq: encrypts plaintext and compares against an encrypted text,
2579 using crypt(), crypt16(), MD5 or SHA-1
2580 inlist/inlisti: checks if first argument is in the list of the second
2581 match: does a regular expression match and sets up the numerical
2582 variables if it succeeds
2583 match_address: matches in an address list
2584 match_domain: matches in a domain list
2585 match_ip: matches a host list that is restricted to IP addresses
2586 match_local_part: matches in a local part list
2589 case ECOND_MATCH_ADDRESS:
2590 case ECOND_MATCH_DOMAIN:
2591 case ECOND_MATCH_IP:
2592 case ECOND_MATCH_LOCAL_PART:
2593 #ifndef EXPAND_LISTMATCH_RHS
2594 sub2_honour_dollar = FALSE;
2603 case ECOND_NUM_L: /* Numerical comparisons */
2610 case ECOND_STR_LT: /* String comparisons */
2621 for (int i = 0; i < 2; i++)
2623 /* Sometimes, we don't expand substrings; too many insecure configurations
2624 created using match_address{}{} and friends, where the second param
2625 includes information from untrustworthy sources. */
2626 BOOL honour_dollar = TRUE;
2627 if ((i > 0) && !sub2_honour_dollar)
2628 honour_dollar = FALSE;
2630 while (isspace(*s)) s++;
2633 if (i == 0) goto COND_FAILED_CURLY_START;
2634 expand_string_message = string_sprintf("missing 2nd string in {} "
2635 "after \"%s\"", name);
2638 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2639 honour_dollar, resetok)))
2641 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2642 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2643 " for security reasons\n");
2644 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2646 /* Convert to numerical if required; we know that the names of all the
2647 conditions that compare numbers do not start with a letter. This just saves
2648 checking for them individually. */
2650 if (!isalpha(name[0]) && yield != NULL)
2655 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2659 num[i] = expanded_string_integer(sub[i], FALSE);
2660 if (expand_string_message != NULL) return NULL;
2664 /* Result not required */
2666 if (yield == NULL) return s;
2668 /* Do an appropriate comparison */
2674 tempcond = (num[0] == num[1]);
2678 tempcond = (num[0] > num[1]);
2682 tempcond = (num[0] >= num[1]);
2686 tempcond = (num[0] < num[1]);
2690 tempcond = (num[0] <= num[1]);
2694 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2698 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2702 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2706 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2710 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2714 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2718 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2722 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2726 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2730 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2733 case ECOND_MATCH: /* Regular expression match */
2734 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2738 expand_string_message = string_sprintf("regular expression error in "
2739 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2742 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2745 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2746 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2747 goto MATCHED_SOMETHING;
2749 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2750 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2751 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2752 goto MATCHED_SOMETHING;
2754 case ECOND_MATCH_IP: /* Match IP address in a host list */
2755 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2757 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2763 unsigned int *nullcache = NULL;
2764 check_host_block cb;
2766 cb.host_name = US"";
2767 cb.host_address = sub[0];
2769 /* If the host address starts off ::ffff: it is an IPv6 address in
2770 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2773 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2774 cb.host_address + 7 : cb.host_address;
2776 rc = match_check_list(
2777 &sub[1], /* the list */
2778 0, /* separator character */
2779 &hostlist_anchor, /* anchor pointer */
2780 &nullcache, /* cache pointer */
2781 check_host, /* function for testing */
2782 &cb, /* argument for function */
2783 MCL_HOST, /* type of check */
2784 sub[0], /* text for debugging */
2785 NULL); /* where to pass back data */
2787 goto MATCHED_SOMETHING;
2789 case ECOND_MATCH_LOCAL_PART:
2790 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2791 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2806 expand_string_message = string_sprintf("unable to complete match "
2807 "against \"%s\": %s", sub[1], search_error_message);
2813 /* Various "encrypted" comparisons. If the second string starts with
2814 "{" then an encryption type is given. Default to crypt() or crypt16()
2815 (build-time choice). */
2816 /* }-for-text-editors */
2819 #ifndef SUPPORT_CRYPTEQ
2820 goto COND_FAILED_NOT_COMPILED;
2822 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2824 int sublen = Ustrlen(sub[1]+5);
2829 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2831 /* If the length that we are comparing against is 24, the MD5 digest
2832 is expressed as a base64 string. This is the way LDAP does it. However,
2833 some other software uses a straightforward hex representation. We assume
2834 this if the length is 32. Other lengths fail. */
2838 uschar *coded = b64encode(CUS digest, 16);
2839 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2840 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2841 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2843 else if (sublen == 32)
2846 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2848 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2849 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2850 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2854 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2855 "fail\n crypted=%s\n", sub[1]+5);
2860 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2862 int sublen = Ustrlen(sub[1]+6);
2867 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2869 /* If the length that we are comparing against is 28, assume the SHA1
2870 digest is expressed as a base64 string. If the length is 40, assume a
2871 straightforward hex representation. Other lengths fail. */
2875 uschar *coded = b64encode(CUS digest, 20);
2876 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2877 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2878 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2880 else if (sublen == 40)
2883 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2885 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2886 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2887 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2891 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2892 "fail\n crypted=%s\n", sub[1]+6);
2897 else /* {crypt} or {crypt16} and non-{ at start */
2898 /* }-for-text-editors */
2903 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2908 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2913 else if (sub[1][0] == '{') /* }-for-text-editors */
2915 expand_string_message = string_sprintf("unknown encryption mechanism "
2916 "in \"%s\"", sub[1]);
2922 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2923 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2924 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2928 #define XSTR(s) STR(s)
2929 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2930 " subject=%s\n crypted=%s\n",
2931 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2936 /* If the encrypted string contains fewer than two characters (for the
2937 salt), force failure. Otherwise we get false positives: with an empty
2938 string the yield of crypt() is an empty string! */
2941 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2942 else if (errno == EINVAL)
2946 expand_string_message = string_sprintf("crypt error: %s\n",
2947 US strerror(errno));
2952 #endif /* SUPPORT_CRYPTEQ */
2957 const uschar * list = sub[1];
2959 uschar *save_iterate_item = iterate_item;
2960 int (*compare)(const uschar *, const uschar *);
2962 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", name, sub[0]);
2965 compare = cond_type == ECOND_INLISTI
2966 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2968 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2970 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
2971 if (compare(sub[0], iterate_item) == 0)
2977 iterate_item = save_iterate_item;
2980 } /* Switch for comparison conditions */
2982 *yield = tempcond == testfor;
2983 return s; /* End of comparison conditions */
2986 /* and/or: computes logical and/or of several conditions */
2990 subcondptr = (yield == NULL)? NULL : &tempcond;
2991 combined_cond = (cond_type == ECOND_AND);
2993 while (isspace(*s)) s++;
2994 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2998 while (isspace(*s)) s++;
2999 /* {-for-text-editors */
3000 if (*s == '}') break;
3001 if (*s != '{') /* }-for-text-editors */
3003 expand_string_message = string_sprintf("each subcondition "
3004 "inside an \"%s{...}\" condition must be in its own {}", name);
3008 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3010 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3011 expand_string_message, name);
3014 while (isspace(*s)) s++;
3016 /* {-for-text-editors */
3019 /* {-for-text-editors */
3020 expand_string_message = string_sprintf("missing } at end of condition "
3021 "inside \"%s\" group", name);
3027 if (cond_type == ECOND_AND)
3029 combined_cond &= tempcond;
3030 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3031 } /* evaluate any more */
3034 combined_cond |= tempcond;
3035 if (combined_cond) subcondptr = NULL; /* once true, don't */
3036 } /* evaluate any more */
3040 if (yield != NULL) *yield = (combined_cond == testfor);
3044 /* forall/forany: iterates a condition with different values */
3046 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3047 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3048 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3049 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3050 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3051 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3055 const uschar * list;
3057 uschar *save_iterate_item = iterate_item;
3059 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
3061 while (isspace(*s)) s++;
3062 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3063 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
3064 if (sub[0] == NULL) return NULL;
3065 /* {-for-text-editors */
3066 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3068 while (isspace(*s)) s++;
3069 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3073 /* Call eval_condition once, with result discarded (as if scanning a
3074 "false" part). This allows us to find the end of the condition, because if
3075 the list it empty, we won't actually evaluate the condition for real. */
3077 if (!(s = eval_condition(sub[1], resetok, NULL)))
3079 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3080 expand_string_message, name);
3083 while (isspace(*s)) s++;
3085 /* {-for-text-editors */
3088 /* {-for-text-editors */
3089 expand_string_message = string_sprintf("missing } at end of condition "
3090 "inside \"%s\"", name);
3094 if (yield) *yield = !testfor;
3096 if (is_json) list = dewrap(string_copy(list), US"[]");
3097 while ((iterate_item = is_json
3098 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3101 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3103 expand_string_message =
3104 string_sprintf("%s wrapping string result for extract jsons",
3105 expand_string_message);
3106 iterate_item = save_iterate_item;
3110 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, iterate_item);
3111 if (!eval_condition(sub[1], resetok, &tempcond))
3113 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3114 expand_string_message, name);
3115 iterate_item = save_iterate_item;
3118 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", name,
3119 tempcond? "true":"false");
3121 if (yield) *yield = (tempcond == testfor);
3122 if (tempcond == is_forany) break;
3125 iterate_item = save_iterate_item;
3130 /* The bool{} expansion condition maps a string to boolean.
3131 The values supported should match those supported by the ACL condition
3132 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3133 of true/false. Note that Router "condition" rules have a different
3134 interpretation, where general data can be used and only a few values
3136 Note that readconf.c boolean matching, for boolean configuration options,
3137 only matches true/yes/false/no.
3138 The bool_lax{} condition matches the Router logic, which is much more
3141 case ECOND_BOOL_LAX:
3147 BOOL boolvalue = FALSE;
3148 while (isspace(*s)) s++;
3149 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3150 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3151 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3153 case 1: expand_string_message = string_sprintf(
3154 "too few arguments or bracketing error for %s",
3158 case 3: return NULL;
3161 while (isspace(*t)) t++;
3165 /* trailing whitespace: seems like a good idea to ignore it too */
3167 while (isspace(*t2)) t2--;
3168 if (t2 != (t + len))
3175 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3176 /* logic for the lax case from expand_check_condition(), which also does
3177 expands, and the logic is both short and stable enough that there should
3178 be no maintenance burden from replicating it. */
3182 ? Ustrspn(t+1, "0123456789") == len-1
3183 : Ustrspn(t, "0123456789") == len)
3185 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3186 /* expand_check_condition only does a literal string "0" check */
3187 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3190 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3192 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3194 else if (cond_type == ECOND_BOOL_LAX)
3198 expand_string_message = string_sprintf("unrecognised boolean "
3202 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3203 boolvalue? "true":"false");
3204 if (yield != NULL) *yield = (boolvalue == testfor);
3208 /* Unknown condition */
3211 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3213 } /* End switch on condition type */
3215 /* Missing braces at start and end of data */
3217 COND_FAILED_CURLY_START:
3218 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3221 COND_FAILED_CURLY_END:
3222 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3226 /* A condition requires code that is not compiled */
3228 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3229 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3230 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3231 COND_FAILED_NOT_COMPILED:
3232 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3241 /*************************************************
3242 * Save numerical variables *
3243 *************************************************/
3245 /* This function is called from items such as "if" that want to preserve and
3246 restore the numbered variables.
3249 save_expand_string points to an array of pointers to set
3250 save_expand_nlength points to an array of ints for the lengths
3252 Returns: the value of expand max to save
3256 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3258 for (int i = 0; i <= expand_nmax; i++)
3260 save_expand_nstring[i] = expand_nstring[i];
3261 save_expand_nlength[i] = expand_nlength[i];
3268 /*************************************************
3269 * Restore numerical variables *
3270 *************************************************/
3272 /* This function restored saved values of numerical strings.
3275 save_expand_nmax the number of strings to restore
3276 save_expand_string points to an array of pointers
3277 save_expand_nlength points to an array of ints
3283 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3284 int *save_expand_nlength)
3286 expand_nmax = save_expand_nmax;
3287 for (int i = 0; i <= expand_nmax; i++)
3289 expand_nstring[i] = save_expand_nstring[i];
3290 expand_nlength[i] = save_expand_nlength[i];
3298 /*************************************************
3299 * Handle yes/no substrings *
3300 *************************************************/
3302 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3303 alternative substrings that depend on whether or not the condition was true,
3304 or the lookup or extraction succeeded. The substrings always have to be
3305 expanded, to check their syntax, but "skipping" is set when the result is not
3306 needed - this avoids unnecessary nested lookups.
3309 skipping TRUE if we were skipping when this item was reached
3310 yes TRUE if the first string is to be used, else use the second
3311 save_lookup a value to put back into lookup_value before the 2nd expansion
3312 sptr points to the input string pointer
3313 yieldptr points to the output growable-string pointer
3314 type "lookup", "if", "extract", "run", "env", "listextract" or
3315 "certextract" for error message
3316 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3319 Returns: 0 OK; lookup_value has been reset to save_lookup
3321 2 expansion failed because of bracketing error
3325 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3326 gstring ** yieldptr, uschar *type, BOOL *resetok)
3329 const uschar *s = *sptr; /* Local value */
3330 uschar *sub1, *sub2;
3331 const uschar * errwhere;
3333 /* If there are no following strings, we substitute the contents of $value for
3334 lookups and for extractions in the success case. For the ${if item, the string
3335 "true" is substituted. In the fail case, nothing is substituted for all three
3338 while (isspace(*s)) s++;
3343 if (yes && !skipping)
3344 *yieldptr = string_catn(*yieldptr, US"true", 4);
3348 if (yes && lookup_value && !skipping)
3349 *yieldptr = string_cat(*yieldptr, lookup_value);
3350 lookup_value = save_lookup;
3356 /* The first following string must be braced. */
3360 errwhere = US"'yes' part did not start with '{'";
3364 /* Expand the first substring. Forced failures are noticed only if we actually
3365 want this string. Set skipping in the call in the fail case (this will always
3366 be the case if we were already skipping). */
3368 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3369 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3370 f.expand_string_forcedfail = FALSE;
3373 errwhere = US"'yes' part did not end with '}'";
3377 /* If we want the first string, add it to the output */
3380 *yieldptr = string_cat(*yieldptr, sub1);
3382 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3383 $value to what it was at the start of the item, so that it has this value
3384 during the second string expansion. For the call from "if" or "run" to this
3385 function, save_lookup is set to lookup_value, so that this statement does
3388 lookup_value = save_lookup;
3390 /* There now follows either another substring, or "fail", or nothing. This
3391 time, forced failures are noticed only if we want the second string. We must
3392 set skipping in the nested call if we don't want this string, or if we were
3393 already skipping. */
3395 while (isspace(*s)) s++;
3398 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3399 if (sub2 == NULL && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3400 f.expand_string_forcedfail = FALSE;
3403 errwhere = US"'no' part did not start with '{'";
3407 /* If we want the second string, add it to the output */
3410 *yieldptr = string_cat(*yieldptr, sub2);
3413 /* If there is no second string, but the word "fail" is present when the use of
3414 the second string is wanted, set a flag indicating it was a forced failure
3415 rather than a syntactic error. Swallow the terminating } in case this is nested
3416 inside another lookup or if or extract. */
3421 /* deconst cast ok here as source is s anyway */
3422 s = US read_name(name, sizeof(name), s, US"_");
3423 if (Ustrcmp(name, "fail") == 0)
3425 if (!yes && !skipping)
3427 while (isspace(*s)) s++;
3430 errwhere = US"did not close with '}' after forcedfail";
3433 expand_string_message =
3434 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3435 f.expand_string_forcedfail = TRUE;
3441 expand_string_message =
3442 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3447 /* All we have to do now is to check on the final closing brace. */
3449 while (isspace(*s)) s++;
3452 errwhere = US"did not close with '}'";
3458 /* Update the input pointer value before returning */
3463 /* Get here if there is a bracketing failure */
3464 expand_string_message = string_sprintf(
3465 "curly-bracket problem in conditional yes/no parsing: %s\n"
3466 " remaining string is '%s'", errwhere, --s);
3471 /* Get here for other failures */
3479 /*************************************************
3480 * Handle MD5 or SHA-1 computation for HMAC *
3481 *************************************************/
3483 /* These are some wrapping functions that enable the HMAC code to be a bit
3484 cleaner. A good compiler will spot the tail recursion.
3487 type HMAC_MD5 or HMAC_SHA1
3488 remaining are as for the cryptographic hash functions
3494 chash_start(int type, void *base)
3496 if (type == HMAC_MD5)
3497 md5_start((md5 *)base);
3499 sha1_start((hctx *)base);
3503 chash_mid(int type, void *base, uschar *string)
3505 if (type == HMAC_MD5)
3506 md5_mid((md5 *)base, string);
3508 sha1_mid((hctx *)base, string);
3512 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3514 if (type == HMAC_MD5)
3515 md5_end((md5 *)base, string, length, digest);
3517 sha1_end((hctx *)base, string, length, digest);
3524 /********************************************************
3525 * prvs: Get last three digits of days since Jan 1, 1970 *
3526 ********************************************************/
3528 /* This is needed to implement the "prvs" BATV reverse
3531 Argument: integer "days" offset to add or substract to
3532 or from the current number of days.
3534 Returns: pointer to string containing the last three
3535 digits of the number of days since Jan 1, 1970,
3536 modified by the offset argument, NULL if there
3537 was an error in the conversion.
3542 prvs_daystamp(int day_offset)
3544 uschar *days = store_get(32); /* Need at least 24 for cases */
3545 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3546 (time(NULL) + day_offset*86400)/86400);
3547 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3552 /********************************************************
3553 * prvs: perform HMAC-SHA1 computation of prvs bits *
3554 ********************************************************/
3556 /* This is needed to implement the "prvs" BATV reverse
3560 address RFC2821 Address to use
3561 key The key to use (must be less than 64 characters
3563 key_num Single-digit key number to use. Defaults to
3566 Returns: pointer to string containing the first three
3567 bytes of the final hash in hex format, NULL if
3568 there was an error in the process.
3572 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3574 gstring * hash_source;
3577 uschar innerhash[20];
3578 uschar finalhash[20];
3579 uschar innerkey[64];
3580 uschar outerkey[64];
3581 uschar *finalhash_hex = store_get(40);
3583 if (key_num == NULL)
3586 if (Ustrlen(key) > 64)
3589 hash_source = string_catn(NULL, key_num, 1);
3590 hash_source = string_catn(hash_source, daystamp, 3);
3591 hash_source = string_cat(hash_source, address);
3592 (void) string_from_gstring(hash_source);
3595 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3597 memset(innerkey, 0x36, 64);
3598 memset(outerkey, 0x5c, 64);
3600 for (int i = 0; i < Ustrlen(key); i++)
3602 innerkey[i] ^= key[i];
3603 outerkey[i] ^= key[i];
3606 chash_start(HMAC_SHA1, &h);
3607 chash_mid(HMAC_SHA1, &h, innerkey);
3608 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3610 chash_start(HMAC_SHA1, &h);
3611 chash_mid(HMAC_SHA1, &h, outerkey);
3612 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3615 for (int i = 0; i < 3; i++)
3617 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3618 *p++ = hex_digits[finalhash[i] & 0x0f];
3622 return finalhash_hex;
3628 /*************************************************
3629 * Join a file onto the output string *
3630 *************************************************/
3632 /* This is used for readfile/readsock and after a run expansion.
3633 It joins the contents of a file onto the output string, globally replacing
3634 newlines with a given string (optionally).
3638 yield pointer to the expandable string struct
3639 eol newline replacement string, or NULL
3641 Returns: new pointer for expandable string, terminated if non-null
3645 cat_file(FILE *f, gstring *yield, uschar *eol)
3647 uschar buffer[1024];
3649 while (Ufgets(buffer, sizeof(buffer), f))
3651 int len = Ustrlen(buffer);
3652 if (eol && buffer[len-1] == '\n') len--;
3653 yield = string_catn(yield, buffer, len);
3654 if (eol && buffer[len])
3655 yield = string_cat(yield, eol);
3658 (void) string_from_gstring(yield);
3665 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
3668 uschar buffer[1024];
3670 /*XXX could we read direct into a pre-grown string? */
3672 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
3673 for (uschar * s = buffer; rc--; s++)
3674 yield = eol && *s == '\n'
3675 ? string_cat(yield, eol) : string_catn(yield, s, 1);
3677 /* We assume that all errors, and any returns of zero bytes,
3678 are actually EOF. */
3680 (void) string_from_gstring(yield);
3686 /*************************************************
3687 * Evaluate numeric expression *
3688 *************************************************/
3690 /* This is a set of mutually recursive functions that evaluate an arithmetic
3691 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3692 these functions that is called from elsewhere is eval_expr, whose interface is:
3695 sptr pointer to the pointer to the string - gets updated
3696 decimal TRUE if numbers are to be assumed decimal
3697 error pointer to where to put an error message - must be NULL on input
3698 endket TRUE if ')' must terminate - FALSE for external call
3700 Returns: on success: the value of the expression, with *error still NULL
3701 on failure: an undefined value, with *error = a message
3704 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3707 static int_eximarith_t
3708 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3711 int_eximarith_t x = eval_op_or(&s, decimal, error);
3717 *error = US"expecting closing parenthesis";
3719 while (isspace(*(++s)));
3721 else if (*s != 0) *error = US"expecting operator";
3728 static int_eximarith_t
3729 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3734 while (isspace(*s)) s++;
3739 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3741 switch (tolower(*s))
3744 case 'k': n *= 1024; s++; break;
3745 case 'm': n *= 1024*1024; s++; break;
3746 case 'g': n *= 1024*1024*1024; s++; break;
3748 while (isspace (*s)) s++;
3753 n = eval_expr(&s, decimal, error, 1);
3757 *error = US"expecting number or opening parenthesis";
3765 static int_eximarith_t
3766 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3770 while (isspace(*s)) s++;
3771 if (*s == '+' || *s == '-' || *s == '~')
3774 x = eval_op_unary(&s, decimal, error);
3775 if (op == '-') x = -x;
3776 else if (op == '~') x = ~x;
3780 x = eval_number(&s, decimal, error);
3787 static int_eximarith_t
3788 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3791 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3794 while (*s == '*' || *s == '/' || *s == '%')
3797 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3798 if (*error != NULL) break;
3799 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3800 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3801 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3802 * -N*M is INT_MIN will yield INT_MIN.
3803 * Since we don't support floating point, this is somewhat simpler.
3804 * Ideally, we'd return an error, but since we overflow for all other
3805 * arithmetic, consistency suggests otherwise, but what's the correct value
3806 * to use? There is none.
3807 * The C standard guarantees overflow for unsigned arithmetic but signed
3808 * overflow invokes undefined behaviour; in practice, this is overflow
3809 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3810 * that long/longlong larger than int are available, or we could just work
3811 * with larger types. We should consider whether to guarantee 32bit eval
3812 * and 64-bit working variables, with errors returned. For now ...
3813 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3814 * can just let the other invalid results occur otherwise, as they have
3815 * until now. For this one case, we can coerce.
3817 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3820 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3821 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3831 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3847 static int_eximarith_t
3848 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3851 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3854 while (*s == '+' || *s == '-')
3857 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3859 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3860 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3861 { /* over-conservative check */
3863 ? US"overflow in sum" : US"overflow in difference";
3866 if (op == '+') x += y; else x -= y;
3874 static int_eximarith_t
3875 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3878 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3881 while ((*s == '<' || *s == '>') && s[1] == s[0])
3886 y = eval_op_sum(&s, decimal, error);
3887 if (*error != NULL) break;
3888 if (op == '<') x <<= y; else x >>= y;
3896 static int_eximarith_t
3897 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3900 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3907 y = eval_op_shift(&s, decimal, error);
3908 if (*error != NULL) break;
3917 static int_eximarith_t
3918 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3921 int_eximarith_t x = eval_op_and(&s, decimal, error);
3928 y = eval_op_and(&s, decimal, error);
3929 if (*error != NULL) break;
3938 static int_eximarith_t
3939 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3942 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3949 y = eval_op_xor(&s, decimal, error);
3950 if (*error != NULL) break;
3960 /*************************************************
3962 *************************************************/
3964 /* Returns either an unchanged string, or the expanded string in stacking pool
3965 store. Interpreted sequences are:
3967 \... normal escaping rules
3968 $name substitutes the variable
3970 ${op:string} operates on the expanded string value
3971 ${item{arg1}{arg2}...} expands the args and then does the business
3972 some literal args are not enclosed in {}
3974 There are now far too many operators and item types to make it worth listing
3975 them here in detail any more.
3977 We use an internal routine recursively to handle embedded substrings. The
3978 external function follows. The yield is NULL if the expansion failed, and there
3979 are two cases: if something collapsed syntactically, or if "fail" was given
3980 as the action on a lookup failure. These can be distinguished by looking at the
3981 variable expand_string_forcedfail, which is TRUE in the latter case.
3983 The skipping flag is set true when expanding a substring that isn't actually
3984 going to be used (after "if" or "lookup") and it prevents lookups from
3985 happening lower down.
3987 Store usage: At start, a store block of the length of the input plus 64
3988 is obtained. This is expanded as necessary by string_cat(), which might have to
3989 get a new block, or might be able to expand the original. At the end of the
3990 function we can release any store above that portion of the yield block that
3991 was actually used. In many cases this will be optimal.
3993 However: if the first item in the expansion is a variable name or header name,
3994 we reset the store before processing it; if the result is in fresh store, we
3995 use that without copying. This is helpful for expanding strings like
3996 $message_headers which can get very long.
3998 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3999 since resetting the store at the end of the expansion will free store that was
4000 allocated by the plugin code as well as the slop after the expanded string. So
4001 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4002 and, given the acl condition, ${if }. This is an unfortunate consequence of
4003 string expansion becoming too powerful.
4006 string the string to be expanded
4007 ket_ends true if expansion is to stop at }
4008 left if not NULL, a pointer to the first character after the
4009 expansion is placed here (typically used with ket_ends)
4010 skipping TRUE for recursive calls when the value isn't actually going
4011 to be used (to allow for optimisation)
4012 honour_dollar TRUE if $ is to be expanded,
4013 FALSE if it's just another character
4014 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4017 Returns: NULL if expansion fails:
4018 expand_string_forcedfail is set TRUE if failure was forced
4019 expand_string_message contains a textual error message
4020 a pointer to the expanded string on success
4024 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
4025 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
4027 gstring * yield = string_get(Ustrlen(string) + 64);
4029 const uschar *s = string;
4030 uschar *save_expand_nstring[EXPAND_MAXN+1];
4031 int save_expand_nlength[EXPAND_MAXN+1];
4032 BOOL resetok = TRUE;
4037 debug_printf_indent("/%s: %s\n",
4038 skipping ? "---scanning" : "considering", string);
4040 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
4042 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4046 f.expand_string_forcedfail = FALSE;
4047 expand_string_message = US"";
4054 /* \ escapes the next character, which must exist, or else
4055 the expansion fails. There's a special escape, \N, which causes
4056 copying of the subject verbatim up to the next \N. Otherwise,
4057 the escapes are the standard set. */
4063 expand_string_message = US"\\ at end of string";
4069 const uschar * t = s + 2;
4070 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
4071 yield = string_catn(yield, t, s - t);
4072 if (*s != 0) s += 2;
4078 ch[0] = string_interpret_escape(&s);
4080 yield = string_catn(yield, ch, 1);
4087 /* Anything other than $ is just copied verbatim, unless we are
4088 looking for a terminating } character. */
4091 if (ket_ends && *s == '}') break;
4093 if (*s != '$' || !honour_dollar)
4095 yield = string_catn(yield, s++, 1);
4099 /* No { after the $ - must be a plain name or a number for string
4100 match variable. There has to be a fudge for variables that are the
4101 names of header fields preceded by "$header_" because header field
4102 names can contain any printing characters except space and colon.
4103 For those that don't like typing this much, "$h_" is a synonym for
4104 "$header_". A non-existent header yields a NULL value; nothing is
4107 if (isalpha((*(++s))))
4114 s = read_name(name, sizeof(name), s, US"_");
4116 /* If this is the first thing to be expanded, release the pre-allocated
4120 g = store_get(sizeof(gstring));
4121 else if (yield->ptr == 0)
4123 if (resetok) store_reset(yield);
4125 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
4130 if ( ( *(t = name) == 'h'
4131 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4133 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4136 unsigned flags = *name == 'r' ? FH_WANT_RAW
4137 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4139 uschar * charset = *name == 'b' ? NULL : headers_charset;
4141 s = read_header_name(name, sizeof(name), s);
4142 value = find_header(name, &newsize, flags, charset);
4144 /* If we didn't find the header, and the header contains a closing brace
4145 character, this may be a user error where the terminating colon
4146 has been omitted. Set a flag to adjust the error message in this case.
4147 But there is no error here - nothing gets inserted. */
4151 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
4158 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4160 expand_string_message =
4161 string_sprintf("unknown variable name \"%s\"", name);
4162 check_variable_error_message(name);
4166 /* If the data is known to be in a new buffer, newsize will be set to the
4167 size of that buffer. If this is the first thing in an expansion string,
4168 yield will be NULL; just point it at the new store instead of copying. Many
4169 expansion strings contain just one reference, so this is a useful
4170 optimization, especially for humungous headers. We need to use a gstring
4171 structure that is not allocated after that new-buffer, else a later store
4172 reset in the middle of the buffer will make it inaccessible. */
4174 len = Ustrlen(value);
4175 if (!yield && newsize != 0)
4178 yield->size = newsize;
4183 yield = string_catn(yield, value, len);
4191 s = read_cnumber(&n, s);
4192 if (n >= 0 && n <= expand_nmax)
4193 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4197 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4199 if (*s != '{') /*}*/
4201 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4205 /* After { there can be various things, but they all start with
4206 an initial word, except for a number for a string match variable. */
4208 if (isdigit((*(++s))))
4211 s = read_cnumber(&n, s); /*{*/
4214 expand_string_message = US"} expected after number";
4217 if (n >= 0 && n <= expand_nmax)
4218 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4224 expand_string_message = US"letter or digit expected after ${"; /*}*/
4228 /* Allow "-" in names to cater for substrings with negative
4229 arguments. Since we are checking for known names after { this is
4232 s = read_name(name, sizeof(name), s, US"_-");
4233 item_type = chop_match(name, item_table, nelem(item_table));
4237 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4238 If the ACL returns accept or reject we return content set by "message ="
4239 There is currently no limit on recursion; this would have us call
4240 acl_check_internal() directly and get a current level from somewhere.
4241 See also the acl expansion condition ECOND_ACL and the traditional
4242 acl modifier ACLC_ACL.
4243 Assume that the function has side-effects on the store that must be preserved.
4247 /* ${acl {name} {arg1}{arg2}...} */
4249 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4252 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4255 case 1: goto EXPAND_FAILED_CURLY;
4257 case 3: goto EXPAND_FAILED;
4259 if (skipping) continue;
4262 switch(eval_acl(sub, nelem(sub), &user_msg))
4267 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4269 yield = string_cat(yield, user_msg);
4273 f.expand_string_forcedfail = TRUE;
4276 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4281 case EITEM_AUTHRESULTS:
4282 /* ${authresults {mysystemname}} */
4286 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4289 case 1: goto EXPAND_FAILED_CURLY;
4291 case 3: goto EXPAND_FAILED;
4294 yield = string_append(yield, 3,
4295 US"Authentication-Results: ", sub_arg[0], US"; none");
4298 yield = authres_local(yield, sub_arg[0]);
4299 yield = authres_iprev(yield);
4300 yield = authres_smtpauth(yield);
4302 yield = authres_spf(yield);
4304 #ifndef DISABLE_DKIM
4305 yield = authres_dkim(yield);
4307 #ifdef EXPERIMENTAL_DMARC
4308 yield = authres_dmarc(yield);
4310 #ifdef EXPERIMENTAL_ARC
4311 yield = authres_arc(yield);
4316 /* Handle conditionals - preserve the values of the numerical expansion
4317 variables in case they get changed by a regular expression match in the
4318 condition. If not, they retain their external settings. At the end
4319 of this "if" section, they get restored to their previous values. */
4324 const uschar *next_s;
4325 int save_expand_nmax =
4326 save_expand_strings(save_expand_nstring, save_expand_nlength);
4328 while (isspace(*s)) s++;
4329 next_s = eval_condition(s, &resetok, skipping ? NULL : &cond);
4330 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4335 debug_printf_indent("|--condition: %.*s\n", (int)(next_s - s), s);
4336 debug_printf_indent("|-----result: %s\n", cond ? "true" : "false");
4340 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4341 "condition: %.*s\n",
4342 (int)(next_s - s), s);
4343 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4344 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4346 cond ? "true" : "false");
4351 /* The handling of "yes" and "no" result strings is now in a separate
4352 function that is also used by ${lookup} and ${extract} and ${run}. */
4354 switch(process_yesno(
4355 skipping, /* were previously skipping */
4356 cond, /* success/failure indicator */
4357 lookup_value, /* value to reset for string2 */
4358 &s, /* input pointer */
4359 &yield, /* output pointer */
4360 US"if", /* condition type */
4363 case 1: goto EXPAND_FAILED; /* when all is well, the */
4364 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4367 /* Restore external setting of expansion variables for continuation
4370 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4371 save_expand_nlength);
4376 case EITEM_IMAPFOLDER:
4377 { /* ${imapfolder {name}{sep]{specials}} */
4381 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4384 case 1: goto EXPAND_FAILED_CURLY;
4386 case 3: goto EXPAND_FAILED;
4389 if (sub_arg[1] == NULL) /* One argument */
4391 sub_arg[1] = US"/"; /* default separator */
4394 else if (Ustrlen(sub_arg[1]) != 1)
4396 expand_string_message =
4398 "IMAP folder separator must be one character, found \"%s\"",
4405 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4406 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4408 yield = string_cat(yield, encoded);
4414 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4415 expanding an internal string that isn't actually going to be used. All we
4416 need to do is check the syntax, so don't do a lookup at all. Preserve the
4417 values of the numerical expansion variables in case they get changed by a
4418 partial lookup. If not, they retain their external settings. At the end
4419 of this "lookup" section, they get restored to their previous values. */
4423 int stype, partial, affixlen, starflags;
4424 int expand_setup = 0;
4426 uschar *key, *filename;
4427 const uschar *affix;
4428 uschar *save_lookup_value = lookup_value;
4429 int save_expand_nmax =
4430 save_expand_strings(save_expand_nstring, save_expand_nlength);
4432 if ((expand_forbid & RDO_LOOKUP) != 0)
4434 expand_string_message = US"lookup expansions are not permitted";
4438 /* Get the key we are to look up for single-key+file style lookups.
4439 Otherwise set the key NULL pro-tem. */
4441 while (isspace(*s)) s++;
4442 if (*s == '{') /*}*/
4444 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4445 if (!key) goto EXPAND_FAILED; /*{{*/
4448 expand_string_message = US"missing '}' after lookup key";
4449 goto EXPAND_FAILED_CURLY;
4451 while (isspace(*s)) s++;
4455 /* Find out the type of database */
4459 expand_string_message = US"missing lookup type";
4463 /* The type is a string that may contain special characters of various
4464 kinds. Allow everything except space or { to appear; the actual content
4465 is checked by search_findtype_partial. */ /*}*/
4467 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4469 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4473 while (isspace(*s)) s++;
4475 /* Now check for the individual search type and any partial or default
4476 options. Only those types that are actually in the binary are valid. */
4478 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4482 expand_string_message = search_error_message;
4486 /* Check that a key was provided for those lookup types that need it,
4487 and was not supplied for those that use the query style. */
4489 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4493 expand_string_message = string_sprintf("missing {key} for single-"
4494 "key \"%s\" lookup", name);
4502 expand_string_message = string_sprintf("a single key was given for "
4503 "lookup type \"%s\", which is not a single-key lookup type", name);
4508 /* Get the next string in brackets and expand it. It is the file name for
4509 single-key+file lookups, and the whole query otherwise. In the case of
4510 queries that also require a file name (e.g. sqlite), the file name comes
4515 expand_string_message = US"missing '{' for lookup file-or-query arg";
4516 goto EXPAND_FAILED_CURLY;
4518 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4519 if (filename == NULL) goto EXPAND_FAILED;
4522 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4523 goto EXPAND_FAILED_CURLY;
4525 while (isspace(*s)) s++;
4527 /* If this isn't a single-key+file lookup, re-arrange the variables
4528 to be appropriate for the search_ functions. For query-style lookups,
4529 there is just a "key", and no file name. For the special query-style +
4530 file types, the query (i.e. "key") starts with a file name. */
4534 while (isspace(*filename)) filename++;
4537 if (mac_islookup(stype, lookup_querystyle))
4541 if (*filename != '/')
4543 expand_string_message = string_sprintf(
4544 "absolute file name expected for \"%s\" lookup", name);
4547 while (*key != 0 && !isspace(*key)) key++;
4548 if (*key != 0) *key++ = 0;
4552 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4553 the entry was not found. Note that there is no search_close() function.
4554 Files are left open in case of re-use. At suitable places in higher logic,
4555 search_tidyup() is called to tidy all open files. This can save opening
4556 the same file several times. However, files may also get closed when
4557 others are opened, if too many are open at once. The rule is that a
4558 handle should not be used after a second search_open().
4560 Request that a partial search sets up $1 and maybe $2 by passing
4561 expand_setup containing zero. If its value changes, reset expand_nmax,
4562 since new variables will have been set. Note that at the end of this
4563 "lookup" section, the old numeric variables are restored. */
4566 lookup_value = NULL;
4569 void *handle = search_open(filename, stype, 0, NULL, NULL);
4572 expand_string_message = search_error_message;
4575 lookup_value = search_find(handle, filename, key, partial, affix,
4576 affixlen, starflags, &expand_setup);
4577 if (f.search_find_defer)
4579 expand_string_message =
4580 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4581 string_printing2(key, FALSE), search_error_message);
4584 if (expand_setup > 0) expand_nmax = expand_setup;
4587 /* The handling of "yes" and "no" result strings is now in a separate
4588 function that is also used by ${if} and ${extract}. */
4590 switch(process_yesno(
4591 skipping, /* were previously skipping */
4592 lookup_value != NULL, /* success/failure indicator */
4593 save_lookup_value, /* value to reset for string2 */
4594 &s, /* input pointer */
4595 &yield, /* output pointer */
4596 US"lookup", /* condition type */
4599 case 1: goto EXPAND_FAILED; /* when all is well, the */
4600 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4603 /* Restore external setting of expansion variables for carrying on
4604 at this level, and continue. */
4606 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4607 save_expand_nlength);
4611 /* If Perl support is configured, handle calling embedded perl subroutines,
4612 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4613 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4614 arguments (defined below). */
4616 #define EXIM_PERL_MAX_ARGS 8
4620 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4621 "is not included in this binary";
4624 #else /* EXIM_PERL */
4626 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4629 if ((expand_forbid & RDO_PERL) != 0)
4631 expand_string_message = US"Perl calls are not permitted";
4635 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4636 US"perl", &resetok))
4638 case 1: goto EXPAND_FAILED_CURLY;
4640 case 3: goto EXPAND_FAILED;
4643 /* If skipping, we don't actually do anything */
4645 if (skipping) continue;
4647 /* Start the interpreter if necessary */
4649 if (!opt_perl_started)
4652 if (opt_perl_startup == NULL)
4654 expand_string_message = US"A setting of perl_startup is needed when "
4655 "using the Perl interpreter";
4658 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4659 initerror = init_perl(opt_perl_startup);
4660 if (initerror != NULL)
4662 expand_string_message =
4663 string_sprintf("error in perl_startup code: %s\n", initerror);
4666 opt_perl_started = TRUE;
4669 /* Call the function */
4671 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4672 new_yield = call_perl_cat(yield, &expand_string_message,
4673 sub_arg[0], sub_arg + 1);
4675 /* NULL yield indicates failure; if the message pointer has been set to
4676 NULL, the yield was undef, indicating a forced failure. Otherwise the
4677 message will indicate some kind of Perl error. */
4679 if (new_yield == NULL)
4681 if (expand_string_message == NULL)
4683 expand_string_message =
4684 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4685 "failure", sub_arg[0]);
4686 f.expand_string_forcedfail = TRUE;
4691 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4692 set during a callback from Perl. */
4694 f.expand_string_forcedfail = FALSE;
4698 #endif /* EXIM_PERL */
4700 /* Transform email address to "prvs" scheme to use
4701 as BATV-signed return path */
4708 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4710 case 1: goto EXPAND_FAILED_CURLY;
4712 case 3: goto EXPAND_FAILED;
4715 /* If skipping, we don't actually do anything */
4716 if (skipping) continue;
4718 /* sub_arg[0] is the address */
4719 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
4720 || domain == sub_arg[0] || Ustrlen(domain) == 1)
4722 expand_string_message = US"prvs first argument must be a qualified email address";
4726 /* Calculate the hash. The third argument must be a single-digit
4727 key number, or unset. */
4730 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4732 expand_string_message = US"prvs third argument must be a single digit";
4736 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
4739 expand_string_message = US"prvs hmac-sha1 conversion failed";
4743 /* Now separate the domain from the local part */
4746 yield = string_catn(yield, US"prvs=", 5);
4747 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
4748 yield = string_catn(yield, prvs_daystamp(7), 3);
4749 yield = string_catn(yield, p, 6);
4750 yield = string_catn(yield, US"=", 1);
4751 yield = string_cat (yield, sub_arg[0]);
4752 yield = string_catn(yield, US"@", 1);
4753 yield = string_cat (yield, domain);
4758 /* Check a prvs-encoded address for validity */
4760 case EITEM_PRVSCHECK:
4767 /* TF: Ugliness: We want to expand parameter 1 first, then set
4768 up expansion variables that are used in the expansion of
4769 parameter 2. So we clone the string for the first
4770 expansion, where we only expand parameter 1.
4772 PH: Actually, that isn't necessary. The read_subs() function is
4773 designed to work this way for the ${if and ${lookup expansions. I've
4777 /* Reset expansion variables */
4778 prvscheck_result = NULL;
4779 prvscheck_address = NULL;
4780 prvscheck_keynum = NULL;
4782 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4784 case 1: goto EXPAND_FAILED_CURLY;
4786 case 3: goto EXPAND_FAILED;
4789 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4792 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4794 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4795 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4796 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4797 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4798 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4800 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
4801 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
4802 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
4803 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
4804 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
4806 /* Set up expansion variables */
4807 g = string_cat (NULL, local_part);
4808 g = string_catn(g, US"@", 1);
4809 g = string_cat (g, domain);
4810 prvscheck_address = string_from_gstring(g);
4811 prvscheck_keynum = string_copy(key_num);
4813 /* Now expand the second argument */
4814 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4816 case 1: goto EXPAND_FAILED_CURLY;
4818 case 3: goto EXPAND_FAILED;
4821 /* Now we have the key and can check the address. */
4823 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4828 expand_string_message = US"hmac-sha1 conversion failed";
4832 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
4833 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
4835 if (Ustrcmp(p,hash) == 0)
4837 /* Success, valid BATV address. Now check the expiry date. */
4838 uschar *now = prvs_daystamp(0);
4839 unsigned int inow = 0,iexpire = 1;
4841 (void)sscanf(CS now,"%u",&inow);
4842 (void)sscanf(CS daystamp,"%u",&iexpire);
4844 /* When "iexpire" is < 7, a "flip" has occurred.
4845 Adjust "inow" accordingly. */
4846 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4848 if (iexpire >= inow)
4850 prvscheck_result = US"1";
4851 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
4855 prvscheck_result = NULL;
4856 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
4861 prvscheck_result = NULL;
4862 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
4865 /* Now expand the final argument. We leave this till now so that
4866 it can include $prvscheck_result. */
4868 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4870 case 1: goto EXPAND_FAILED_CURLY;
4872 case 3: goto EXPAND_FAILED;
4875 yield = string_cat(yield,
4876 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4878 /* Reset the "internal" variables afterwards, because they are in
4879 dynamic store that will be reclaimed if the expansion succeeded. */
4881 prvscheck_address = NULL;
4882 prvscheck_keynum = NULL;
4885 /* Does not look like a prvs encoded address, return the empty string.
4886 We need to make sure all subs are expanded first, so as to skip over
4889 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4891 case 1: goto EXPAND_FAILED_CURLY;
4893 case 3: goto EXPAND_FAILED;
4899 /* Handle "readfile" to insert an entire file */
4901 case EITEM_READFILE:
4906 if ((expand_forbid & RDO_READFILE) != 0)
4908 expand_string_message = US"file insertions are not permitted";
4912 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4914 case 1: goto EXPAND_FAILED_CURLY;
4916 case 3: goto EXPAND_FAILED;
4919 /* If skipping, we don't actually do anything */
4921 if (skipping) continue;
4923 /* Open the file and read it */
4925 if (!(f = Ufopen(sub_arg[0], "rb")))
4927 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4931 yield = cat_file(f, yield, sub_arg[1]);
4936 /* Handle "readsocket" to insert data from a socket, either
4937 Inet or Unix domain */
4939 case EITEM_READSOCK:
4941 client_conn_ctx cctx;
4943 int save_ptr = yield->ptr;
4946 uschar * sub_arg[4];
4947 uschar * server_name = NULL;
4949 BOOL do_shutdown = TRUE;
4950 BOOL do_tls = FALSE; /* Only set under SUPPORT_TLS */
4953 if (expand_forbid & RDO_READSOCK)
4955 expand_string_message = US"socket insertions are not permitted";
4959 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4960 because there may be a string for expansion on failure. */
4962 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4964 case 1: goto EXPAND_FAILED_CURLY;
4965 case 2: /* Won't occur: no end check */
4966 case 3: goto EXPAND_FAILED;
4969 /* Grab the request string, if any */
4971 reqstr.data = sub_arg[1];
4972 reqstr.len = Ustrlen(sub_arg[1]);
4974 /* Sort out timeout, if given. The second arg is a list with the first element
4975 being a time value. Any more are options of form "name=value". Currently the
4976 only option recognised is "shutdown". */
4980 const uschar * list = sub_arg[2];
4984 item = string_nextinlist(&list, &sep, NULL, 0);
4985 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
4987 expand_string_message = string_sprintf("bad time value %s", item);
4991 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
4992 if (Ustrncmp(item, US"shutdown=", 9) == 0)
4993 { if (Ustrcmp(item + 9, US"no") == 0) do_shutdown = FALSE; }
4995 else if (Ustrncmp(item, US"tls=", 4) == 0)
4996 { if (Ustrcmp(item + 9, US"no") != 0) do_tls = TRUE; }
5000 sub_arg[3] = NULL; /* No eol if no timeout */
5002 /* If skipping, we don't actually do anything. Otherwise, arrange to
5003 connect to either an IP or a Unix socket. */
5007 /* Handle an IP (internet) domain */
5009 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
5014 server_name = sub_arg[0] + 5;
5015 port_name = Ustrrchr(server_name, ':');
5017 /* Sort out the port */
5021 expand_string_message =
5022 string_sprintf("missing port for readsocket %s", sub_arg[0]);
5025 *port_name++ = 0; /* Terminate server name */
5027 if (isdigit(*port_name))
5030 port = Ustrtol(port_name, &end, 0);
5031 if (end != port_name + Ustrlen(port_name))
5033 expand_string_message =
5034 string_sprintf("invalid port number %s", port_name);
5040 struct servent *service_info = getservbyname(CS port_name, "tcp");
5043 expand_string_message = string_sprintf("unknown port \"%s\"",
5047 port = ntohs(service_info->s_port);
5050 /*XXX we trust that the request is idempotent for TFO. Hmm. */
5051 cctx.sock = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
5052 timeout, &host, &expand_string_message,
5053 do_tls ? NULL : &reqstr);
5054 callout_address = NULL;
5061 /* Handle a Unix domain socket */
5065 struct sockaddr_un sockun; /* don't call this "sun" ! */
5068 if ((cctx.sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
5070 expand_string_message = string_sprintf("failed to create socket: %s",
5075 sockun.sun_family = AF_UNIX;
5076 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
5078 server_name = US sockun.sun_path;
5080 sigalrm_seen = FALSE;
5082 rc = connect(cctx.sock, (struct sockaddr *)(&sockun), sizeof(sockun));
5086 expand_string_message = US "socket connect timed out";
5091 expand_string_message = string_sprintf("failed to connect to socket "
5092 "%s: %s", sub_arg[0], strerror(errno));
5095 host.name = server_name;
5096 host.address = US"";
5099 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
5104 smtp_connect_args conn_args = {.host = &host };
5105 tls_support tls_dummy = {.sni=NULL};
5108 if (!tls_client_start(&cctx, &conn_args, NULL, &tls_dummy, &errstr))
5110 expand_string_message = string_sprintf("TLS connect failed: %s", errstr);
5116 /* Allow sequencing of test actions */
5117 if (f.running_in_test_harness) millisleep(100);
5119 /* Write the request string, if not empty or already done */
5123 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
5127 do_tls ? tls_write(cctx.tls_ctx, reqstr.data, reqstr.len, FALSE) :
5129 write(cctx.sock, reqstr.data, reqstr.len)) != reqstr.len)
5131 expand_string_message = string_sprintf("request write to socket "
5132 "failed: %s", strerror(errno));
5137 /* Shut down the sending side of the socket. This helps some servers to
5138 recognise that it is their turn to do some work. Just in case some
5139 system doesn't have this function, make it conditional. */
5142 if (!do_tls && do_shutdown) shutdown(cctx.sock, SHUT_WR);
5145 if (f.running_in_test_harness) millisleep(100);
5147 /* Now we need to read from the socket, under a timeout. The function
5148 that reads a file can be used. */
5151 fp = fdopen(cctx.sock, "rb");
5152 sigalrm_seen = FALSE;
5156 do_tls ? cat_file_tls(cctx.tls_ctx, yield, sub_arg[3]) :
5158 cat_file(fp, yield, sub_arg[3]);
5164 tls_close(cctx.tls_ctx, TRUE);
5171 /* After a timeout, we restore the pointer in the result, that is,
5172 make sure we add nothing from the socket. */
5176 yield->ptr = save_ptr;
5177 expand_string_message = US "socket read timed out";
5182 /* The whole thing has worked (or we were skipping). If there is a
5183 failure string following, we need to skip it. */
5187 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
5191 expand_string_message = US"missing '}' closing failstring for readsocket";
5192 goto EXPAND_FAILED_CURLY;
5194 while (isspace(*s)) s++;
5200 expand_string_message = US"missing '}' closing readsocket";
5201 goto EXPAND_FAILED_CURLY;
5205 /* Come here on failure to create socket, connect socket, write to the
5206 socket, or timeout on reading. If another substring follows, expand and
5207 use it. Otherwise, those conditions give expand errors. */
5210 if (*s != '{') goto EXPAND_FAILED;
5211 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5212 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5214 yield = string_cat(yield, arg);
5217 expand_string_message = US"missing '}' closing failstring for readsocket";
5218 goto EXPAND_FAILED_CURLY;
5220 while (isspace(*s)) s++;
5224 /* Handle "run" to execute a program. */
5230 const uschar **argv;
5234 if ((expand_forbid & RDO_RUN) != 0)
5236 expand_string_message = US"running a command is not permitted";
5240 while (isspace(*s)) s++;
5243 expand_string_message = US"missing '{' for command arg of run";
5244 goto EXPAND_FAILED_CURLY;
5246 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5247 if (arg == NULL) goto EXPAND_FAILED;
5248 while (isspace(*s)) s++;
5251 expand_string_message = US"missing '}' closing command arg of run";
5252 goto EXPAND_FAILED_CURLY;
5255 if (skipping) /* Just pretend it worked when we're skipping */
5258 lookup_value = NULL;
5262 if (!transport_set_up_command(&argv, /* anchor for arg list */
5263 arg, /* raw command */
5264 FALSE, /* don't expand the arguments */
5265 0, /* not relevant when... */
5266 NULL, /* no transporting address */
5267 US"${run} expansion", /* for error messages */
5268 &expand_string_message)) /* where to put error message */
5271 /* Create the child process, making it a group leader. */
5273 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
5275 expand_string_message =
5276 string_sprintf("couldn't create child process: %s", strerror(errno));
5280 /* Nothing is written to the standard input. */
5284 /* Read the pipe to get the command's output into $value (which is kept
5285 in lookup_value). Read during execution, so that if the output exceeds
5286 the OS pipe buffer limit, we don't block forever. Remember to not release
5287 memory just allocated for $value. */
5290 f = fdopen(fd_out, "rb");
5291 sigalrm_seen = FALSE;
5293 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5297 /* Wait for the process to finish, applying the timeout, and inspect its
5298 return code for serious disasters. Simple non-zero returns are passed on.
5301 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5303 if (sigalrm_seen || runrc == -256)
5305 expand_string_message = string_sprintf("command timed out");
5306 killpg(pid, SIGKILL); /* Kill the whole process group */
5309 else if (runrc == -257)
5310 expand_string_message = string_sprintf("wait() failed: %s",
5314 expand_string_message = string_sprintf("command killed by signal %d",
5321 /* Process the yes/no strings; $value may be useful in both cases */
5323 switch(process_yesno(
5324 skipping, /* were previously skipping */
5325 runrc == 0, /* success/failure indicator */
5326 lookup_value, /* value to reset for string2 */
5327 &s, /* input pointer */
5328 &yield, /* output pointer */
5329 US"run", /* condition type */
5332 case 1: goto EXPAND_FAILED; /* when all is well, the */
5333 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5339 /* Handle character translation for "tr" */
5343 int oldptr = yield->ptr;
5347 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5349 case 1: goto EXPAND_FAILED_CURLY;
5351 case 3: goto EXPAND_FAILED;
5354 yield = string_cat(yield, sub[0]);
5355 o2m = Ustrlen(sub[2]) - 1;
5357 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5359 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5363 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5370 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5371 expanded arguments. */
5380 int val[2] = { 0, -1 };
5383 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5384 Ensure that sub[2] is set in the ${length } case. */
5387 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5388 TRUE, name, &resetok))
5390 case 1: goto EXPAND_FAILED_CURLY;
5392 case 3: goto EXPAND_FAILED;
5395 /* Juggle the arguments if there are only two of them: always move the
5396 string to the last position and make ${length{n}{str}} equivalent to
5397 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5403 if (item_type == EITEM_LENGTH)
5410 for (int i = 0; i < 2; i++) if (sub[i])
5412 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5413 if (*ret != 0 || (i != 0 && val[i] < 0))
5415 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5416 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5422 (item_type == EITEM_HASH)?
5423 compute_hash(sub[2], val[0], val[1], &len) :
5424 (item_type == EITEM_NHASH)?
5425 compute_nhash(sub[2], val[0], val[1], &len) :
5426 extract_substr(sub[2], val[0], val[1], &len);
5428 if (ret == NULL) goto EXPAND_FAILED;
5429 yield = string_catn(yield, ret, len);
5433 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5434 This code originally contributed by Steve Haslam. It currently supports
5435 the use of MD5 and SHA-1 hashes.
5437 We need some workspace that is large enough to handle all the supported
5438 hash types. Use macros to set the sizes rather than be too elaborate. */
5440 #define MAX_HASHLEN 20
5441 #define MAX_HASHBLOCKLEN 64
5450 int hashlen; /* Number of octets for the hash algorithm's output */
5451 int hashblocklen; /* Number of octets the hash algorithm processes */
5453 unsigned int keylen;
5455 uschar keyhash[MAX_HASHLEN];
5456 uschar innerhash[MAX_HASHLEN];
5457 uschar finalhash[MAX_HASHLEN];
5458 uschar finalhash_hex[2*MAX_HASHLEN];
5459 uschar innerkey[MAX_HASHBLOCKLEN];
5460 uschar outerkey[MAX_HASHBLOCKLEN];
5462 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5464 case 1: goto EXPAND_FAILED_CURLY;
5466 case 3: goto EXPAND_FAILED;
5471 if (Ustrcmp(sub[0], "md5") == 0)
5474 use_base = &md5_base;
5478 else if (Ustrcmp(sub[0], "sha1") == 0)
5481 use_base = &sha1_ctx;
5487 expand_string_message =
5488 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5493 keylen = Ustrlen(keyptr);
5495 /* If the key is longer than the hash block length, then hash the key
5498 if (keylen > hashblocklen)
5500 chash_start(type, use_base);
5501 chash_end(type, use_base, keyptr, keylen, keyhash);
5506 /* Now make the inner and outer key values */
5508 memset(innerkey, 0x36, hashblocklen);
5509 memset(outerkey, 0x5c, hashblocklen);
5511 for (int i = 0; i < keylen; i++)
5513 innerkey[i] ^= keyptr[i];
5514 outerkey[i] ^= keyptr[i];
5517 /* Now do the hashes */
5519 chash_start(type, use_base);
5520 chash_mid(type, use_base, innerkey);
5521 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5523 chash_start(type, use_base);
5524 chash_mid(type, use_base, outerkey);
5525 chash_end(type, use_base, innerhash, hashlen, finalhash);
5527 /* Encode the final hash as a hex string */
5530 for (int i = 0; i < hashlen; i++)
5532 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5533 *p++ = hex_digits[finalhash[i] & 0x0f];
5536 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5537 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5539 yield = string_catn(yield, finalhash_hex, hashlen*2);
5544 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5545 We have to save the numerical variables and restore them afterwards. */
5550 int moffset, moffsetextra, slen;
5553 const uschar *rerror;
5556 int save_expand_nmax =
5557 save_expand_strings(save_expand_nstring, save_expand_nlength);
5559 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5561 case 1: goto EXPAND_FAILED_CURLY;
5563 case 3: goto EXPAND_FAILED;
5566 /* Compile the regular expression */
5568 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5573 expand_string_message = string_sprintf("regular expression error in "
5574 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5578 /* Now run a loop to do the substitutions as often as necessary. It ends
5579 when there are no more matches. Take care over matches of the null string;
5580 do the same thing as Perl does. */
5583 slen = Ustrlen(sub[0]);
5584 moffset = moffsetextra = 0;
5589 int ovector[3*(EXPAND_MAXN+1)];
5590 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5591 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5594 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5595 is not necessarily the end. We want to repeat the match from one
5596 character further along, but leaving the basic offset the same (for
5597 copying below). We can't be at the end of the string - that was checked
5598 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5599 finished; copy the remaining string and end the loop. */
5609 yield = string_catn(yield, subject+moffset, slen-moffset);
5613 /* Match - set up for expanding the replacement. */
5615 if (n == 0) n = EXPAND_MAXN + 1;
5617 for (int nn = 0; nn < n*2; nn += 2)
5619 expand_nstring[expand_nmax] = subject + ovector[nn];
5620 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5624 /* Copy the characters before the match, plus the expanded insertion. */
5626 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
5627 insert = expand_string(sub[2]);
5628 if (insert == NULL) goto EXPAND_FAILED;
5629 yield = string_cat(yield, insert);
5631 moffset = ovector[1];
5635 /* If we have matched an empty string, first check to see if we are at
5636 the end of the subject. If so, the loop is over. Otherwise, mimic
5637 what Perl's /g options does. This turns out to be rather cunning. First
5638 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5639 string at the same point. If this fails (picked up above) we advance to
5640 the next character. */
5642 if (ovector[0] == ovector[1])
5644 if (ovector[0] == slen) break;
5645 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5649 /* All done - restore numerical variables. */
5651 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5652 save_expand_nlength);
5656 /* Handle keyed and numbered substring extraction. If the first argument
5657 consists entirely of digits, then a numerical extraction is assumed. */
5661 int field_number = 1;
5662 BOOL field_number_set = FALSE;
5663 uschar *save_lookup_value = lookup_value;
5665 int save_expand_nmax =
5666 save_expand_strings(save_expand_nstring, save_expand_nlength);
5668 /* On reflection the original behaviour of extract-json for a string
5669 result, leaving it quoted, was a mistake. But it was already published,
5670 hence the addition of jsons. In a future major version, make json
5671 work like josons, and withdraw jsons. */
5673 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
5675 while (isspace(*s)) s++;
5677 /* Check for a format-variant specifier */
5679 if (*s != '{') /*}*/
5680 if (Ustrncmp(s, "json", 4) == 0)
5681 if (*(s += 4) == 's')
5682 {fmt = extract_jsons; s++;}
5686 /* While skipping we cannot rely on the data for expansions being
5687 available (eg. $item) hence cannot decide on numeric vs. keyed.
5688 Read a maximum of 5 arguments (including the yes/no) */
5692 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
5694 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5695 goto EXPAND_FAILED; /*'{'*/
5698 expand_string_message = US"missing '{' for arg of extract";
5699 goto EXPAND_FAILED_CURLY;
5701 while (isspace(*s)) s++;
5703 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
5704 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5708 while (isspace(*s)) s++;
5712 expand_string_message = US"missing '}' closing extract";
5713 goto EXPAND_FAILED_CURLY;
5717 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5719 while (isspace(*s)) s++;
5720 if (*s == '{') /*'}'*/
5722 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5723 if (sub[i] == NULL) goto EXPAND_FAILED; /*'{'*/
5726 expand_string_message = string_sprintf(
5727 "missing '}' closing arg %d of extract", i+1);
5728 goto EXPAND_FAILED_CURLY;
5731 /* After removal of leading and trailing white space, the first
5732 argument must not be empty; if it consists entirely of digits
5733 (optionally preceded by a minus sign), this is a numerical
5734 extraction, and we expect 3 arguments (normal) or 2 (json). */
5742 while (isspace(*p)) p++;
5746 while (len > 0 && isspace(p[len-1])) len--;
5751 expand_string_message = US"first argument of \"extract\" must "
5761 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5765 if (fmt == extract_basic) j = 3; /* Need 3 args */
5766 field_number_set = TRUE;
5772 expand_string_message = string_sprintf(
5773 "missing '{' for arg %d of extract", i+1);
5774 goto EXPAND_FAILED_CURLY;
5778 /* Extract either the numbered or the keyed substring into $value. If
5779 skipping, just pretend the extraction failed. */
5782 lookup_value = NULL;
5786 lookup_value = field_number_set
5787 ? expand_gettokened(field_number, sub[1], sub[2])
5788 : expand_getkeyed(sub[0], sub[1]);
5795 const uschar * list;
5797 /* Array: Bracket-enclosed and comma-separated.
5798 Object: Brace-enclosed, comma-sep list of name:value pairs */
5800 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
5802 expand_string_message =
5803 string_sprintf("%s wrapping %s for extract json",
5804 expand_string_message,
5805 field_number_set ? "array" : "object");
5806 goto EXPAND_FAILED_CURLY;
5810 if (field_number_set)
5812 if (field_number <= 0)
5814 expand_string_message = US"first argument of \"extract\" must "
5815 "be greater than zero";
5818 while (field_number > 0 && (item = json_nextinlist(&list)))
5820 if ((lookup_value = s = item))
5823 while (--s >= lookup_value && isspace(*s)) *s = '\0';
5828 lookup_value = NULL;
5829 while ((item = json_nextinlist(&list)))
5831 /* Item is: string name-sep value. string is quoted.
5832 Dequote the string and compare with the search key. */
5834 if (!(item = dewrap(item, US"\"\"")))
5836 expand_string_message =
5837 string_sprintf("%s wrapping string key for extract json",
5838 expand_string_message);
5839 goto EXPAND_FAILED_CURLY;
5841 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
5843 s = item + Ustrlen(item) + 1;
5844 while (isspace(*s)) s++;
5847 expand_string_message = string_sprintf(
5848 "missing object value-separator for extract json");
5849 goto EXPAND_FAILED_CURLY;
5852 while (isspace(*s)) s++;
5860 if ( fmt == extract_jsons
5862 && !(lookup_value = dewrap(lookup_value, US"\"\"")))
5864 expand_string_message =
5865 string_sprintf("%s wrapping string result for extract jsons",
5866 expand_string_message);
5867 goto EXPAND_FAILED_CURLY;
5872 /* If no string follows, $value gets substituted; otherwise there can
5873 be yes/no strings, as for lookup or if. */
5875 switch(process_yesno(
5876 skipping, /* were previously skipping */
5877 lookup_value != NULL, /* success/failure indicator */
5878 save_lookup_value, /* value to reset for string2 */
5879 &s, /* input pointer */
5880 &yield, /* output pointer */
5881 US"extract", /* condition type */
5884 case 1: goto EXPAND_FAILED; /* when all is well, the */
5885 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5888 /* All done - restore numerical variables. */
5890 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5891 save_expand_nlength);
5896 /* return the Nth item from a list */
5898 case EITEM_LISTEXTRACT:
5900 int field_number = 1;
5901 uschar *save_lookup_value = lookup_value;
5903 int save_expand_nmax =
5904 save_expand_strings(save_expand_nstring, save_expand_nlength);
5906 /* Read the field & list arguments */
5908 for (int i = 0; i < 2; i++)
5910 while (isspace(*s)) s++;
5911 if (*s != '{') /*'}'*/
5913 expand_string_message = string_sprintf(
5914 "missing '{' for arg %d of listextract", i+1);
5915 goto EXPAND_FAILED_CURLY;
5918 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5919 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5922 expand_string_message = string_sprintf(
5923 "missing '}' closing arg %d of listextract", i+1);
5924 goto EXPAND_FAILED_CURLY;
5927 /* After removal of leading and trailing white space, the first
5928 argument must be numeric and nonempty. */
5936 while (isspace(*p)) p++;
5940 while (len > 0 && isspace(p[len-1])) len--;
5943 if (!*p && !skipping)
5945 expand_string_message = US"first argument of \"listextract\" must "
5955 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5958 expand_string_message = US"first argument of \"listextract\" must "
5966 /* Extract the numbered element into $value. If
5967 skipping, just pretend the extraction failed. */
5969 lookup_value = skipping ? NULL : expand_getlistele(field_number, sub[1]);
5971 /* If no string follows, $value gets substituted; otherwise there can
5972 be yes/no strings, as for lookup or if. */
5974 switch(process_yesno(
5975 skipping, /* were previously skipping */
5976 lookup_value != NULL, /* success/failure indicator */
5977 save_lookup_value, /* value to reset for string2 */
5978 &s, /* input pointer */
5979 &yield, /* output pointer */
5980 US"listextract", /* condition type */
5983 case 1: goto EXPAND_FAILED; /* when all is well, the */
5984 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5987 /* All done - restore numerical variables. */
5989 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5990 save_expand_nlength);
5996 case EITEM_CERTEXTRACT:
5998 uschar *save_lookup_value = lookup_value;
6000 int save_expand_nmax =
6001 save_expand_strings(save_expand_nstring, save_expand_nlength);
6003 /* Read the field argument */
6004 while (isspace(*s)) s++;
6005 if (*s != '{') /*}*/
6007 expand_string_message = US"missing '{' for field arg of certextract";
6008 goto EXPAND_FAILED_CURLY;
6010 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6011 if (!sub[0]) goto EXPAND_FAILED; /*{*/
6014 expand_string_message = US"missing '}' closing field arg of certextract";
6015 goto EXPAND_FAILED_CURLY;
6017 /* strip spaces fore & aft */
6022 while (isspace(*p)) p++;
6026 while (len > 0 && isspace(p[len-1])) len--;
6030 /* inspect the cert argument */
6031 while (isspace(*s)) s++;
6032 if (*s != '{') /*}*/
6034 expand_string_message = US"missing '{' for cert variable arg of certextract";
6035 goto EXPAND_FAILED_CURLY;
6039 expand_string_message = US"second argument of \"certextract\" must "
6040 "be a certificate variable";
6043 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
6044 if (!sub[1]) goto EXPAND_FAILED; /*{*/
6047 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6048 goto EXPAND_FAILED_CURLY;
6052 lookup_value = NULL;
6055 lookup_value = expand_getcertele(sub[0], sub[1]);
6056 if (*expand_string_message) goto EXPAND_FAILED;
6058 switch(process_yesno(
6059 skipping, /* were previously skipping */
6060 lookup_value != NULL, /* success/failure indicator */
6061 save_lookup_value, /* value to reset for string2 */
6062 &s, /* input pointer */
6063 &yield, /* output pointer */
6064 US"certextract", /* condition type */
6067 case 1: goto EXPAND_FAILED; /* when all is well, the */
6068 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6071 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6072 save_expand_nlength);
6075 #endif /*SUPPORT_TLS*/
6077 /* Handle list operations */
6084 int save_ptr = yield->ptr;
6085 uschar outsep[2] = { '\0', '\0' };
6086 const uschar *list, *expr, *temp;
6087 uschar *save_iterate_item = iterate_item;
6088 uschar *save_lookup_value = lookup_value;
6090 while (isspace(*s)) s++;
6093 expand_string_message =
6094 string_sprintf("missing '{' for first arg of %s", name);
6095 goto EXPAND_FAILED_CURLY;
6098 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6099 if (list == NULL) goto EXPAND_FAILED;
6102 expand_string_message =
6103 string_sprintf("missing '}' closing first arg of %s", name);
6104 goto EXPAND_FAILED_CURLY;
6107 if (item_type == EITEM_REDUCE)
6110 while (isspace(*s)) s++;
6113 expand_string_message = US"missing '{' for second arg of reduce";
6114 goto EXPAND_FAILED_CURLY;
6116 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6117 if (!t) goto EXPAND_FAILED;
6121 expand_string_message = US"missing '}' closing second arg of reduce";
6122 goto EXPAND_FAILED_CURLY;
6126 while (isspace(*s)) s++;
6129 expand_string_message =
6130 string_sprintf("missing '{' for last arg of %s", name);
6131 goto EXPAND_FAILED_CURLY;
6136 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6137 if scanning a "false" part). This allows us to find the end of the
6138 condition, because if the list is empty, we won't actually evaluate the
6139 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6140 the normal internal expansion function. */
6142 if (item_type == EITEM_FILTER)
6144 temp = eval_condition(expr, &resetok, NULL);
6145 if (temp != NULL) s = temp;
6148 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6152 expand_string_message = string_sprintf("%s inside \"%s\" item",
6153 expand_string_message, name);
6157 while (isspace(*s)) s++;
6160 expand_string_message = string_sprintf("missing } at end of condition "
6161 "or expression inside \"%s\"; could be an unquoted } in the content",
6166 while (isspace(*s)) s++; /*{*/
6169 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6174 /* If we are skipping, we can now just move on to the next item. When
6175 processing for real, we perform the iteration. */
6177 if (skipping) continue;
6178 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6180 *outsep = (uschar)sep; /* Separator as a string */
6182 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6183 name, iterate_item, lookup_value);
6185 if (item_type == EITEM_FILTER)
6188 if (eval_condition(expr, &resetok, &condresult) == NULL)
6190 iterate_item = save_iterate_item;
6191 lookup_value = save_lookup_value;
6192 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6193 expand_string_message, name);
6196 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6197 condresult? "true":"false");
6199 temp = iterate_item; /* TRUE => include this item */
6201 continue; /* FALSE => skip this item */
6204 /* EITEM_MAP and EITEM_REDUCE */
6208 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
6212 iterate_item = save_iterate_item;
6213 expand_string_message = string_sprintf("%s inside \"%s\" item",
6214 expand_string_message, name);
6217 if (item_type == EITEM_REDUCE)
6219 lookup_value = t; /* Update the value of $value */
6220 continue; /* and continue the iteration */
6224 /* We reach here for FILTER if the condition is true, always for MAP,
6225 and never for REDUCE. The value in "temp" is to be added to the output
6226 list that is being created, ensuring that any occurrences of the
6227 separator character are doubled. Unless we are dealing with the first
6228 item of the output list, add in a space if the new item begins with the
6229 separator character, or is an empty string. */
6231 if (yield->ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
6232 yield = string_catn(yield, US" ", 1);
6234 /* Add the string in "temp" to the output list that we are building,
6235 This is done in chunks by searching for the separator character. */
6239 size_t seglen = Ustrcspn(temp, outsep);
6241 yield = string_catn(yield, temp, seglen + 1);
6243 /* If we got to the end of the string we output one character
6244 too many; backup and end the loop. Otherwise arrange to double the
6247 if (temp[seglen] == '\0') { yield->ptr--; break; }
6248 yield = string_catn(yield, outsep, 1);
6252 /* Output a separator after the string: we will remove the redundant
6253 final one at the end. */
6255 yield = string_catn(yield, outsep, 1);
6256 } /* End of iteration over the list loop */
6258 /* REDUCE has generated no output above: output the final value of
6261 if (item_type == EITEM_REDUCE)
6263 yield = string_cat(yield, lookup_value);
6264 lookup_value = save_lookup_value; /* Restore $value */
6267 /* FILTER and MAP generate lists: if they have generated anything, remove
6268 the redundant final separator. Even though an empty item at the end of a
6269 list does not count, this is tidier. */
6271 else if (yield->ptr != save_ptr) yield->ptr--;
6273 /* Restore preserved $item */
6275 iterate_item = save_iterate_item;
6282 const uschar *srclist, *cmp, *xtract;
6284 const uschar *dstlist = NULL, *dstkeylist = NULL;
6286 uschar *save_iterate_item = iterate_item;
6288 while (isspace(*s)) s++;
6291 expand_string_message = US"missing '{' for list arg of sort";
6292 goto EXPAND_FAILED_CURLY;
6295 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6296 if (!srclist) goto EXPAND_FAILED;
6299 expand_string_message = US"missing '}' closing list arg of sort";
6300 goto EXPAND_FAILED_CURLY;
6303 while (isspace(*s)) s++;
6306 expand_string_message = US"missing '{' for comparator arg of sort";
6307 goto EXPAND_FAILED_CURLY;
6310 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6311 if (!cmp) goto EXPAND_FAILED;
6314 expand_string_message = US"missing '}' closing comparator arg of sort";
6315 goto EXPAND_FAILED_CURLY;
6318 while (isspace(*s)) s++;
6321 expand_string_message = US"missing '{' for extractor arg of sort";
6322 goto EXPAND_FAILED_CURLY;
6326 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6327 if (!tmp) goto EXPAND_FAILED;
6328 xtract = string_copyn(xtract, s - xtract);
6332 expand_string_message = US"missing '}' closing extractor arg of sort";
6333 goto EXPAND_FAILED_CURLY;
6338 expand_string_message = US"missing } at end of \"sort\"";
6342 if (skipping) continue;
6344 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6347 gstring * newlist = NULL;
6348 gstring * newkeylist = NULL;
6351 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6353 /* extract field for comparisons */
6354 iterate_item = srcitem;
6355 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6359 expand_string_message = string_sprintf(
6360 "field-extract in sort: \"%s\"", xtract);
6364 /* Insertion sort */
6366 /* copy output list until new-item < list-item */
6367 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6373 /* field for comparison */
6374 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6377 /* build and run condition string */
6378 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
6380 DEBUG(D_expand) debug_printf_indent("%s: cond = \"%s\"\n", name, expr);
6381 if (!eval_condition(expr, &resetok, &before))
6383 expand_string_message = string_sprintf("comparison in sort: %s",
6390 /* New-item sorts before this dst-item. Append new-item,
6391 then dst-item, then remainder of dst list. */
6393 newlist = string_append_listele(newlist, sep, srcitem);
6394 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6397 newlist = string_append_listele(newlist, sep, dstitem);
6398 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6400 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6402 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6404 newlist = string_append_listele(newlist, sep, dstitem);
6405 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6411 newlist = string_append_listele(newlist, sep, dstitem);
6412 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6415 /* If we ran out of dstlist without consuming srcitem, append it */
6418 newlist = string_append_listele(newlist, sep, srcitem);
6419 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6422 dstlist = newlist->s;
6423 dstkeylist = newkeylist->s;
6425 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6426 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6430 yield = string_cat(yield, dstlist);
6432 /* Restore preserved $item */
6433 iterate_item = save_iterate_item;
6437 expand_string_message = US"Internal error in sort (list mismatch)";
6442 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6443 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6444 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6445 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6447 #define EXPAND_DLFUNC_MAX_ARGS 8
6450 #ifndef EXPAND_DLFUNC
6451 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6452 "is not included in this binary";
6455 #else /* EXPAND_DLFUNC */
6458 exim_dlfunc_t *func;
6461 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6463 if ((expand_forbid & RDO_DLFUNC) != 0)
6465 expand_string_message =
6466 US"dynamically-loaded functions are not permitted";
6470 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6471 TRUE, US"dlfunc", &resetok))
6473 case 1: goto EXPAND_FAILED_CURLY;
6475 case 3: goto EXPAND_FAILED;
6478 /* If skipping, we don't actually do anything */
6480 if (skipping) continue;
6482 /* Look up the dynamically loaded object handle in the tree. If it isn't
6483 found, dlopen() the file and put the handle in the tree for next time. */
6485 if (!(t = tree_search(dlobj_anchor, argv[0])))
6487 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6490 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6491 argv[0], dlerror());
6492 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6495 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6496 Ustrcpy(t->name, argv[0]);
6497 t->data.ptr = handle;
6498 (void)tree_insertnode(&dlobj_anchor, t);
6501 /* Having obtained the dynamically loaded object handle, look up the
6502 function pointer. */
6504 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6507 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6508 "%s", argv[1], argv[0], dlerror());
6509 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6513 /* Call the function and work out what to do with the result. If it
6514 returns OK, we have a replacement string; if it returns DEFER then
6515 expansion has failed in a non-forced manner; if it returns FAIL then
6516 failure was forced; if it returns ERROR or any other value there's a
6517 problem, so panic slightly. In any case, assume that the function has
6518 side-effects on the store that must be preserved. */
6522 for (argc = 0; argv[argc] != NULL; argc++);
6523 status = func(&result, argc - 2, &argv[2]);
6526 if (result == NULL) result = US"";
6527 yield = string_cat(yield, result);
6532 expand_string_message = result == NULL ? US"(no message)" : result;
6533 if(status == FAIL_FORCED) f.expand_string_forcedfail = TRUE;
6534 else if(status != FAIL)
6535 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6536 argv[0], argv[1], status, expand_string_message);
6540 #endif /* EXPAND_DLFUNC */
6542 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6545 uschar *save_lookup_value = lookup_value;
6547 while (isspace(*s)) s++;
6548 if (*s != '{') /*}*/
6551 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6552 if (!key) goto EXPAND_FAILED; /*{*/
6555 expand_string_message = US"missing '{' for name arg of env";
6556 goto EXPAND_FAILED_CURLY;
6559 lookup_value = US getenv(CS key);
6561 switch(process_yesno(
6562 skipping, /* were previously skipping */
6563 lookup_value != NULL, /* success/failure indicator */
6564 save_lookup_value, /* value to reset for string2 */
6565 &s, /* input pointer */
6566 &yield, /* output pointer */
6567 US"env", /* condition type */
6570 case 1: goto EXPAND_FAILED; /* when all is well, the */
6571 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6575 } /* EITEM_* switch */
6577 /* Control reaches here if the name is not recognized as one of the more
6578 complicated expansion items. Check for the "operator" syntax (name terminated
6579 by a colon). Some of the operators have arguments, separated by _ from the
6588 var_entry *vp = NULL;
6591 /* Owing to an historical mis-design, an underscore may be part of the
6592 operator name, or it may introduce arguments. We therefore first scan the
6593 table of names that contain underscores. If there is no match, we cut off
6594 the arguments and then scan the main table. */
6596 if ((c = chop_match(name, op_table_underscore,
6597 nelem(op_table_underscore))) < 0)
6599 arg = Ustrchr(name, '_');
6600 if (arg != NULL) *arg = 0;
6601 c = chop_match(name, op_table_main, nelem(op_table_main));
6602 if (c >= 0) c += nelem(op_table_underscore);
6603 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6606 /* Deal specially with operators that might take a certificate variable
6607 as we do not want to do the usual expansion. For most, expand the string.*/
6617 const uschar * s1 = s;
6618 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6620 if (!sub) goto EXPAND_FAILED; /*{*/
6623 expand_string_message =
6624 string_sprintf("missing '}' closing cert arg of %s", name);
6625 goto EXPAND_FAILED_CURLY;
6627 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6637 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6638 if (!sub) goto EXPAND_FAILED;
6643 /* If we are skipping, we don't need to perform the operation at all.
6644 This matters for operations like "mask", because the data may not be
6645 in the correct format when skipping. For example, the expression may test
6646 for the existence of $sender_host_address before trying to mask it. For
6647 other operations, doing them may not fail, but it is a waste of time. */
6649 if (skipping && c >= 0) continue;
6651 /* Otherwise, switch on the operator type */
6658 unsigned long int n = Ustrtoul(sub, &t, 10);
6663 expand_string_message = string_sprintf("argument for base32 "
6664 "operator is \"%s\", which is not a decimal number", sub);
6668 g = string_catn(g, &base32_chars[n & 0x1f], 1);
6670 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
6677 unsigned long int n = 0;
6681 uschar * t = Ustrchr(base32_chars, *tt++);
6684 expand_string_message = string_sprintf("argument for base32d "
6685 "operator is \"%s\", which is not a base 32 number", sub);
6688 n = n * 32 + (t - base32_chars);
6690 s = string_sprintf("%ld", n);
6691 yield = string_cat(yield, s);
6698 unsigned long int n = Ustrtoul(sub, &t, 10);
6701 expand_string_message = string_sprintf("argument for base62 "
6702 "operator is \"%s\", which is not a decimal number", sub);
6705 t = string_base62(n);
6706 yield = string_cat(yield, t);
6710 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6715 unsigned long int n = 0;
6718 uschar *t = Ustrchr(base62_chars, *tt++);
6721 expand_string_message = string_sprintf("argument for base62d "
6722 "operator is \"%s\", which is not a base %d number", sub,
6726 n = n * BASE_62 + (t - base62_chars);
6728 yield = string_fmt_append(yield, "%ld", n);
6734 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6735 if (expanded == NULL)
6737 expand_string_message =
6738 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6739 expand_string_message);
6742 yield = string_cat(yield, expanded);
6749 uschar *t = sub - 1;
6750 while (*(++t) != 0) { *t = tolower(*t); count++; }
6751 yield = string_catn(yield, sub, count);
6758 uschar *t = sub - 1;
6759 while (*(++t) != 0) { *t = toupper(*t); count++; }
6760 yield = string_catn(yield, sub, count);
6766 if (vp && *(void **)vp->value)
6768 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6769 yield = string_cat(yield, cp);
6777 md5_end(&base, sub, Ustrlen(sub), digest);
6778 for (int j = 0; j < 16; j++)
6779 yield = string_fmt_append(yield, "%02x", digest[j]);
6785 if (vp && *(void **)vp->value)
6787 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6788 yield = string_cat(yield, cp);
6796 sha1_end(&h, sub, Ustrlen(sub), digest);
6797 for (int j = 0; j < 20; j++)
6798 yield = string_fmt_append(yield, "%02X", digest[j]);
6804 #ifdef EXIM_HAVE_SHA2
6805 if (vp && *(void **)vp->value)
6807 if (c == EOP_SHA256)
6809 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6810 yield = string_cat(yield, cp);
6813 expand_string_message = US"sha2_N not supported with certificates";
6819 hashmethod m = !arg ? HASH_SHA2_256
6820 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
6821 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
6822 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
6825 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6827 expand_string_message = US"unrecognised sha2 variant";
6831 exim_sha_update(&h, sub, Ustrlen(sub));
6832 exim_sha_finish(&h, &b);
6834 yield = string_fmt_append(yield, "%02X", *b.data++);
6837 expand_string_message = US"sha256 only supported with TLS";
6842 #ifdef EXIM_HAVE_SHA3
6846 hashmethod m = !arg ? HASH_SHA3_256
6847 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6848 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6849 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6850 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6853 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6855 expand_string_message = US"unrecognised sha3 variant";
6859 exim_sha_update(&h, sub, Ustrlen(sub));
6860 exim_sha_finish(&h, &b);
6862 yield = string_fmt_append(yield, "%02X", *b.data++);
6866 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
6870 /* Convert hex encoding to base64 encoding */
6880 for (enc = sub; *enc; enc++)
6882 if (!isxdigit(*enc))
6884 expand_string_message = string_sprintf("\"%s\" is not a hex "
6893 expand_string_message = string_sprintf("\"%s\" contains an odd "
6894 "number of characters", sub);
6898 while ((c = *in++) != 0)
6900 if (isdigit(c)) c -= '0';
6901 else c = toupper(c) - 'A' + 10;
6911 enc = b64encode(CUS sub, out - sub);
6912 yield = string_cat(yield, enc);
6916 /* Convert octets outside 0x21..0x7E to \xXX form */
6920 uschar *t = sub - 1;
6923 if (*t < 0x21 || 0x7E < *t)
6924 yield = string_fmt_append(yield, "\\x%02x", *t);
6926 yield = string_catn(yield, t, 1);
6931 /* count the number of list elements */
6939 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6940 yield = string_fmt_append(yield, "%d", cnt);
6944 /* expand a named list given the name */
6945 /* handles nested named lists; requotes as colon-sep list */
6949 tree_node *t = NULL;
6950 const uschar * list;
6953 uschar * suffix = US"";
6954 BOOL needsep = FALSE;
6957 if (*sub == '+') sub++;
6958 if (arg == NULL) /* no-argument version */
6960 if (!(t = tree_search(addresslist_anchor, sub)) &&
6961 !(t = tree_search(domainlist_anchor, sub)) &&
6962 !(t = tree_search(hostlist_anchor, sub)))
6963 t = tree_search(localpartlist_anchor, sub);
6965 else switch(*arg) /* specific list-type version */
6967 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6968 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6969 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6970 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6972 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6978 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6980 : *arg=='a'?"address "
6981 : *arg=='d'?"domain "
6983 : *arg=='l'?"localpart "
6988 list = ((namedlist_block *)(t->data.ptr))->string;
6990 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
6992 uschar * buf = US" : ";
6994 yield = string_catn(yield, buf, 3);
6998 if (*item == '+') /* list item is itself a named list */
7000 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
7001 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
7003 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
7007 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
7008 while ((cp= strpbrk(CCS item, tok)))
7010 yield = string_catn(yield, item, cp - CS item);
7011 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
7013 yield = string_catn(yield, US"::", 2);
7016 else /* sep in item; should already be doubled; emit once */
7018 yield = string_catn(yield, US tok, 1);
7019 if (*cp == sep) cp++;
7024 yield = string_cat(yield, item);
7029 /* mask applies a mask to an IP address; for example the result of
7030 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7037 int mask, maskoffset;
7038 int type = string_is_ip_address(sub, &maskoffset);
7043 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7048 if (maskoffset == 0)
7050 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7055 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7057 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
7059 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7064 /* Convert the address to binary integer(s) and apply the mask */
7066 sub[maskoffset] = 0;
7067 count = host_aton(sub, binary);
7068 host_mask(count, binary, mask);
7070 /* Convert to masked textual format and add to output. */
7072 yield = string_catn(yield, buffer,
7073 host_nmtoa(count, binary, mask, buffer, '.'));
7078 case EOP_IPV6DENORM:
7080 int type = string_is_ip_address(sub, NULL);
7087 (void) host_aton(sub, binary);
7090 case 4: /* convert to IPv4-mapped IPv6 */
7091 binary[0] = binary[1] = 0;
7092 binary[2] = 0x0000ffff;
7093 (void) host_aton(sub, binary+3);
7097 expand_string_message =
7098 string_sprintf("\"%s\" is not an IP address", sub);
7102 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7103 ? ipv6_nmtoa(binary, buffer)
7104 : host_nmtoa(4, binary, -1, buffer, ':')
7110 case EOP_LOCAL_PART:
7114 int start, end, domain;
7115 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7118 yield = c == EOP_DOMAIN
7119 ? string_cat(yield, t + domain)
7120 : c == EOP_LOCAL_PART && domain > 0
7121 ? string_catn(yield, t, domain - 1 )
7122 : string_cat(yield, t);
7128 uschar outsep[2] = { ':', '\0' };
7129 uschar *address, *error;
7130 int save_ptr = yield->ptr;
7131 int start, end, domain; /* Not really used */
7133 while (isspace(*sub)) sub++;
7135 if (*outsep = *++sub) ++sub;
7138 expand_string_message = string_sprintf("output separator "
7139 "missing in expanding ${addresses:%s}", --sub);
7142 f.parse_allow_group = TRUE;
7146 uschar * p = parse_find_address_end(sub, FALSE);
7147 uschar saveend = *p;
7149 address = parse_extract_address(sub, &error, &start, &end, &domain,
7153 /* Add the address to the output list that we are building. This is
7154 done in chunks by searching for the separator character. At the
7155 start, unless we are dealing with the first address of the output
7156 list, add in a space if the new address begins with the separator
7157 character, or is an empty string. */
7161 if (yield->ptr != save_ptr && address[0] == *outsep)
7162 yield = string_catn(yield, US" ", 1);
7166 size_t seglen = Ustrcspn(address, outsep);
7167 yield = string_catn(yield, address, seglen + 1);
7169 /* If we got to the end of the string we output one character
7172 if (address[seglen] == '\0') { yield->ptr--; break; }
7173 yield = string_catn(yield, outsep, 1);
7174 address += seglen + 1;
7177 /* Output a separator after the string: we will remove the
7178 redundant final one at the end. */
7180 yield = string_catn(yield, outsep, 1);
7183 if (saveend == '\0') break;
7187 /* If we have generated anything, remove the redundant final
7190 if (yield->ptr != save_ptr) yield->ptr--;
7191 f.parse_allow_group = FALSE;
7196 /* quote puts a string in quotes if it is empty or contains anything
7197 other than alphamerics, underscore, dot, or hyphen.
7199 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7200 be quoted in order to be a valid local part.
7202 In both cases, newlines and carriage returns are converted into \n and \r
7206 case EOP_QUOTE_LOCAL_PART:
7209 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
7210 uschar *t = sub - 1;
7214 while (!needs_quote && *(++t) != 0)
7215 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7217 else /* EOP_QUOTE_LOCAL_PART */
7219 while (!needs_quote && *(++t) != 0)
7220 needs_quote = !isalnum(*t) &&
7221 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
7222 (*t != '.' || t == sub || t[1] == 0);
7227 yield = string_catn(yield, US"\"", 1);
7232 yield = string_catn(yield, US"\\n", 2);
7233 else if (*t == '\r')
7234 yield = string_catn(yield, US"\\r", 2);
7237 if (*t == '\\' || *t == '"')
7238 yield = string_catn(yield, US"\\", 1);
7239 yield = string_catn(yield, t, 1);
7242 yield = string_catn(yield, US"\"", 1);
7244 else yield = string_cat(yield, sub);
7248 /* quote_lookuptype does lookup-specific quoting */
7253 uschar *opt = Ustrchr(arg, '_');
7255 if (opt != NULL) *opt++ = 0;
7257 n = search_findtype(arg, Ustrlen(arg));
7260 expand_string_message = search_error_message;
7264 if (lookup_list[n]->quote != NULL)
7265 sub = (lookup_list[n]->quote)(sub, opt);
7266 else if (opt != NULL) sub = NULL;
7270 expand_string_message = string_sprintf(
7271 "\"%s\" unrecognized after \"${quote_%s\"",
7276 yield = string_cat(yield, sub);
7280 /* rx quote sticks in \ before any non-alphameric character so that
7281 the insertion works in a regular expression. */
7285 uschar *t = sub - 1;
7289 yield = string_catn(yield, US"\\", 1);
7290 yield = string_catn(yield, t, 1);
7295 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7296 prescribed by the RFC, if there are characters that need to be encoded */
7300 uschar buffer[2048];
7301 yield = string_cat(yield,
7302 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7303 buffer, sizeof(buffer), FALSE));
7307 /* RFC 2047 decode */
7313 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7314 headers_charset, '?', &len, &error);
7317 expand_string_message = error;
7320 yield = string_catn(yield, decoded, len);
7324 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7334 if (c > 255) c = '_';
7336 yield = string_catn(yield, buff, 1);
7341 /* replace illegal UTF-8 sequences by replacement character */
7343 #define UTF8_REPLACEMENT_CHAR US"?"
7347 int seq_len = 0, index = 0;
7349 long codepoint = -1;
7351 uschar seq_buff[4]; /* accumulate utf-8 here */
7360 if ((c & 0xc0) != 0x80)
7361 /* wrong continuation byte; invalidate all bytes */
7362 complete = 1; /* error */
7365 codepoint = (codepoint << 6) | (c & 0x3f);
7366 seq_buff[index++] = c;
7367 if (--bytes_left == 0) /* codepoint complete */
7368 if(codepoint > 0x10FFFF) /* is it too large? */
7369 complete = -1; /* error (RFC3629 limit) */
7371 { /* finished; output utf-8 sequence */
7372 yield = string_catn(yield, seq_buff, seq_len);
7377 else /* no bytes left: new sequence */
7379 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7381 yield = string_catn(yield, &c, 1);
7384 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7386 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7391 codepoint = c & 0x1f;
7394 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7397 codepoint = c & 0x0f;
7399 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7402 codepoint = c & 0x07;
7404 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7407 seq_buff[index++] = c;
7408 seq_len = bytes_left + 1;
7409 } /* if(bytes_left) */
7413 bytes_left = index = 0;
7414 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7416 if ((complete == 1) && ((c & 0x80) == 0))
7417 /* ASCII character follows incomplete sequence */
7418 yield = string_catn(yield, &c, 1);
7420 /* If given a sequence truncated mid-character, we also want to report ?
7421 * Eg, ${length_1:フィル} is one byte, not one character, so we expect
7422 * ${utf8clean:${length_1:フィル}} to yield '?' */
7423 if (bytes_left != 0)
7425 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7431 case EOP_UTF8_DOMAIN_TO_ALABEL:
7433 uschar * error = NULL;
7434 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7437 expand_string_message = string_sprintf(
7438 "error converting utf8 (%s) to alabel: %s",
7439 string_printing(sub), error);
7442 yield = string_cat(yield, s);
7446 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7448 uschar * error = NULL;
7449 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7452 expand_string_message = string_sprintf(
7453 "error converting alabel (%s) to utf8: %s",
7454 string_printing(sub), error);
7457 yield = string_cat(yield, s);
7461 case EOP_UTF8_LOCALPART_TO_ALABEL:
7463 uschar * error = NULL;
7464 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7467 expand_string_message = string_sprintf(
7468 "error converting utf8 (%s) to alabel: %s",
7469 string_printing(sub), error);
7472 yield = string_cat(yield, s);
7473 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7477 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7479 uschar * error = NULL;
7480 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7483 expand_string_message = string_sprintf(
7484 "error converting alabel (%s) to utf8: %s",
7485 string_printing(sub), error);
7488 yield = string_cat(yield, s);
7491 #endif /* EXPERIMENTAL_INTERNATIONAL */
7493 /* escape turns all non-printing characters into escape sequences. */
7497 const uschar * t = string_printing(sub);
7498 yield = string_cat(yield, t);
7502 case EOP_ESCAPE8BIT:
7506 for (const uschar * s = sub; (c = *s); s++)
7507 yield = c < 127 && c != '\\'
7508 ? string_catn(yield, s, 1)
7509 : string_fmt_append(yield, "\\%03o", c);
7513 /* Handle numeric expression evaluation */
7518 uschar *save_sub = sub;
7519 uschar *error = NULL;
7520 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7523 expand_string_message = string_sprintf("error in expression "
7524 "evaluation: %s (after processing \"%.*s\")", error,
7525 (int)(sub-save_sub), save_sub);
7528 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
7532 /* Handle time period formatting */
7536 int n = readconf_readtime(sub, 0, FALSE);
7539 expand_string_message = string_sprintf("string \"%s\" is not an "
7540 "Exim time interval in \"%s\" operator", sub, name);
7543 yield = string_fmt_append(yield, "%d", n);
7547 case EOP_TIME_INTERVAL:
7550 uschar *t = read_number(&n, sub);
7551 if (*t != 0) /* Not A Number*/
7553 expand_string_message = string_sprintf("string \"%s\" is not a "
7554 "positive number in \"%s\" operator", sub, name);
7557 t = readconf_printtime(n);
7558 yield = string_cat(yield, t);
7562 /* Convert string to base64 encoding */
7568 uschar * s = vp && *(void **)vp->value
7569 ? tls_cert_der_b64(*(void **)vp->value)
7570 : b64encode(CUS sub, Ustrlen(sub));
7572 uschar * s = b64encode(CUS sub, Ustrlen(sub));
7574 yield = string_cat(yield, s);
7581 int len = b64decode(sub, &s);
7584 expand_string_message = string_sprintf("string \"%s\" is not "
7585 "well-formed for \"%s\" operator", sub, name);
7588 yield = string_cat(yield, s);
7592 /* strlen returns the length of the string */
7595 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
7598 /* length_n or l_n takes just the first n characters or the whole string,
7599 whichever is the shorter;
7601 substr_m_n, and s_m_n take n characters from offset m; negative m take
7602 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7603 takes the rest, either to the right or to the left.
7605 hash_n or h_n makes a hash of length n from the string, yielding n
7606 characters from the set a-z; hash_n_m makes a hash of length n, but
7607 uses m characters from the set a-zA-Z0-9.
7609 nhash_n returns a single number between 0 and n-1 (in text form), while
7610 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7611 between 0 and n-1 and the second between 0 and m-1. */
7631 expand_string_message = string_sprintf("missing values after %s",
7636 /* "length" has only one argument, effectively being synonymous with
7639 if (c == EOP_LENGTH || c == EOP_L)
7645 /* The others have one or two arguments; for "substr" the first may be
7646 negative. The second being negative means "not supplied". */
7651 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7654 /* Read up to two numbers, separated by underscores */
7659 if (arg != ret && *arg == '_' && pn == &value1)
7663 if (arg[1] != 0) arg++;
7665 else if (!isdigit(*arg))
7667 expand_string_message =
7668 string_sprintf("non-digit after underscore in \"%s\"", name);
7671 else *pn = (*pn)*10 + *arg++ - '0';
7675 /* Perform the required operation */
7678 (c == EOP_HASH || c == EOP_H)?
7679 compute_hash(sub, value1, value2, &len) :
7680 (c == EOP_NHASH || c == EOP_NH)?
7681 compute_nhash(sub, value1, value2, &len) :
7682 extract_substr(sub, value1, value2, &len);
7684 if (ret == NULL) goto EXPAND_FAILED;
7685 yield = string_catn(yield, ret, len);
7694 uschar **modetable[3];
7698 if (expand_forbid & RDO_EXISTS)
7700 expand_string_message = US"Use of the stat() expansion is not permitted";
7704 if (stat(CS sub, &st) < 0)
7706 expand_string_message = string_sprintf("stat(%s) failed: %s",
7707 sub, strerror(errno));
7711 switch (mode & S_IFMT)
7713 case S_IFIFO: smode[0] = 'p'; break;
7714 case S_IFCHR: smode[0] = 'c'; break;
7715 case S_IFDIR: smode[0] = 'd'; break;
7716 case S_IFBLK: smode[0] = 'b'; break;
7717 case S_IFREG: smode[0] = '-'; break;
7718 default: smode[0] = '?'; break;
7721 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7722 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7723 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7725 for (int i = 0; i < 3; i++)
7727 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7732 yield = string_fmt_append(yield,
7733 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7734 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7735 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7736 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7737 (long)st.st_gid, st.st_size, (long)st.st_atime,
7738 (long)st.st_mtime, (long)st.st_ctime);
7742 /* vaguely random number less than N */
7746 int_eximarith_t max = expanded_string_integer(sub, TRUE);
7748 if (expand_string_message)
7750 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
7754 /* Reverse IP, including IPv6 to dotted-nibble */
7756 case EOP_REVERSE_IP:
7758 int family, maskptr;
7759 uschar reversed[128];
7761 family = string_is_ip_address(sub, &maskptr);
7764 expand_string_message = string_sprintf(
7765 "reverse_ip() not given an IP address [%s]", sub);
7768 invert_address(reversed, sub);
7769 yield = string_cat(yield, reversed);
7773 /* Unknown operator */
7776 expand_string_message =
7777 string_sprintf("unknown expansion operator \"%s\"", name);
7782 /* Handle a plain name. If this is the first thing in the expansion, release
7783 the pre-allocated buffer. If the result data is known to be in a new buffer,
7784 newsize will be set to the size of that buffer, and we can just point at that
7785 store instead of copying. Many expansion strings contain just one reference,
7786 so this is a useful optimization, especially for humungous headers
7787 ($message_headers). */
7796 g = store_get(sizeof(gstring));
7797 else if (yield->ptr == 0)
7799 if (resetok) store_reset(yield);
7801 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
7803 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
7805 expand_string_message =
7806 string_sprintf("unknown variable in \"${%s}\"", name);
7807 check_variable_error_message(name);
7810 len = Ustrlen(value);
7811 if (!yield && newsize)
7814 yield->size = newsize;
7819 yield = string_catn(yield, value, len);
7823 /* Else there's something wrong */
7825 expand_string_message =
7826 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7827 "in a variable reference)", name);
7831 /* If we hit the end of the string when ket_ends is set, there is a missing
7832 terminating brace. */
7834 if (ket_ends && *s == 0)
7836 expand_string_message = malformed_header
7837 ? US"missing } at end of string - could be header name not terminated by colon"
7838 : US"missing } at end of string";
7842 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7843 added to the string. If so, set up an empty string. Add a terminating zero. If
7844 left != NULL, return a pointer to the terminator. */
7847 yield = string_get(1);
7848 (void) string_from_gstring(yield);
7849 if (left) *left = s;
7851 /* Any stacking store that was used above the final string is no longer needed.
7852 In many cases the final string will be the first one that was got and so there
7853 will be optimal store usage. */
7855 if (resetok) store_reset(yield->s + (yield->size = yield->ptr + 1));
7856 else if (resetok_p) *resetok_p = FALSE;
7861 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
7862 debug_printf_indent("%sresult: %s\n",
7863 skipping ? "|-----" : "\\_____", yield->s);
7865 debug_printf_indent("\\___skipping: result is not used\n");
7869 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
7870 "expanding: %.*s\n",
7871 (int)(s - string), string);
7872 debug_printf_indent("%s"
7873 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7875 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7878 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7879 "skipping: result is not used\n");
7884 /* This is the failure exit: easiest to program with a goto. We still need
7885 to update the pointer to the terminator, for cases of nested calls with "fail".
7888 EXPAND_FAILED_CURLY:
7889 if (malformed_header)
7890 expand_string_message =
7891 US"missing or misplaced { or } - could be header name not terminated by colon";
7893 else if (!expand_string_message || !*expand_string_message)
7894 expand_string_message = US"missing or misplaced { or }";
7896 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7897 that is a bad idea, because expand_string_message is in dynamic store. */
7900 if (left) *left = s;
7904 debug_printf_indent("|failed to expand: %s\n", string);
7905 debug_printf_indent("%serror message: %s\n",
7906 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
7907 if (f.expand_string_forcedfail)
7908 debug_printf_indent("\\failure was forced\n");
7912 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
7914 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7915 "error message: %s\n",
7916 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7917 expand_string_message);
7918 if (f.expand_string_forcedfail)
7919 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
7921 if (resetok_p && !resetok) *resetok_p = FALSE;
7927 /* This is the external function call. Do a quick check for any expansion
7928 metacharacters, and if there are none, just return the input string.
7930 Argument: the string to be expanded
7931 Returns: the expanded string, or NULL if expansion failed; if failure was
7932 due to a lookup deferring, search_find_defer will be TRUE
7936 expand_cstring(const uschar * string)
7938 if (Ustrpbrk(string, "$\\") != NULL)
7940 int old_pool = store_pool;
7943 f.search_find_defer = FALSE;
7944 malformed_header = FALSE;
7945 store_pool = POOL_MAIN;
7946 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7947 store_pool = old_pool;
7955 expand_string(uschar * string)
7957 return US expand_cstring(CUS string);
7964 /*************************************************
7966 *************************************************/
7968 /* Now and again we want to expand a string and be sure that the result is in a
7969 new bit of store. This function does that.
7970 Since we know it has been copied, the de-const cast is safe.
7972 Argument: the string to be expanded
7973 Returns: the expanded string, always in a new bit of store, or NULL
7977 expand_string_copy(const uschar *string)
7979 const uschar *yield = expand_cstring(string);
7980 if (yield == string) yield = string_copy(string);
7986 /*************************************************
7987 * Expand and interpret as an integer *
7988 *************************************************/
7990 /* Expand a string, and convert the result into an integer.
7993 string the string to be expanded
7994 isplus TRUE if a non-negative number is expected
7996 Returns: the integer value, or
7997 -1 for an expansion error ) in both cases, message in
7998 -2 for an integer interpretation error ) expand_string_message
7999 expand_string_message is set NULL for an OK integer
8003 expand_string_integer(uschar *string, BOOL isplus)
8005 return expanded_string_integer(expand_string(string), isplus);
8009 /*************************************************
8010 * Interpret string as an integer *
8011 *************************************************/
8013 /* Convert a string (that has already been expanded) into an integer.
8015 This function is used inside the expansion code.
8018 s the string to be expanded
8019 isplus TRUE if a non-negative number is expected
8021 Returns: the integer value, or
8022 -1 if string is NULL (which implies an expansion error)
8023 -2 for an integer interpretation error
8024 expand_string_message is set NULL for an OK integer
8027 static int_eximarith_t
8028 expanded_string_integer(const uschar *s, BOOL isplus)
8030 int_eximarith_t value;
8031 uschar *msg = US"invalid integer \"%s\"";
8034 /* If expansion failed, expand_string_message will be set. */
8036 if (s == NULL) return -1;
8038 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8039 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8040 systems, so we set it zero ourselves. */
8043 expand_string_message = NULL; /* Indicates no error */
8045 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8046 equal to 0. Unfortunately, people actually relied upon that, so preserve
8047 the behaviour explicitly. Stripping leading whitespace is a harmless
8048 noop change since strtol skips it anyway (provided that there is a number
8052 while (isspace(*s)) ++s;
8056 debug_printf_indent("treating blank string as number 0\n");
8061 value = strtoll(CS s, CSS &endptr, 10);
8065 msg = US"integer expected but \"%s\" found";
8067 else if (value < 0 && isplus)
8069 msg = US"non-negative integer expected but \"%s\" found";
8073 switch (tolower(*endptr))
8078 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8083 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8084 else value *= 1024*1024;
8088 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8089 else value *= 1024*1024*1024;
8093 if (errno == ERANGE)
8094 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8097 while (isspace(*endptr)) endptr++;
8098 if (*endptr == 0) return value;
8102 expand_string_message = string_sprintf(CS msg, s);
8107 /* These values are usually fixed boolean values, but they are permitted to be
8111 addr address being routed
8112 mtype the module type
8113 mname the module name
8114 dbg_opt debug selectors
8115 oname the option name
8116 bvalue the router's boolean value
8117 svalue the router's string value
8118 rvalue where to put the returned value
8120 Returns: OK value placed in rvalue
8121 DEFER expansion failed
8125 exp_bool(address_item *addr,
8126 uschar *mtype, uschar *mname, unsigned dbg_opt,
8127 uschar *oname, BOOL bvalue,
8128 uschar *svalue, BOOL *rvalue)
8131 if (svalue == NULL) { *rvalue = bvalue; return OK; }
8133 expanded = expand_string(svalue);
8134 if (expanded == NULL)
8136 if (f.expand_string_forcedfail)
8138 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8142 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8143 oname, mname, mtype, expand_string_message);
8144 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8148 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8151 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8153 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8157 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8158 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8167 /* Avoid potentially exposing a password in a string about to be logged */
8170 expand_hide_passwords(uschar * s)
8172 return ( ( Ustrstr(s, "failed to expand") != NULL
8173 || Ustrstr(s, "expansion of ") != NULL
8175 && ( Ustrstr(s, "mysql") != NULL
8176 || Ustrstr(s, "pgsql") != NULL
8177 || Ustrstr(s, "redis") != NULL
8178 || Ustrstr(s, "sqlite") != NULL
8179 || Ustrstr(s, "ldap:") != NULL
8180 || Ustrstr(s, "ldaps:") != NULL
8181 || Ustrstr(s, "ldapi:") != NULL
8182 || Ustrstr(s, "ldapdn:") != NULL
8183 || Ustrstr(s, "ldapm:") != NULL
8185 ? US"Temporary internal error" : s;
8189 /* Read given named file into big_buffer. Use for keying material etc.
8190 The content will have an ascii NUL appended.
8195 Return: pointer to buffer, or NULL on error.
8199 expand_file_big_buffer(const uschar * filename)
8201 int fd, off = 0, len;
8203 if ((fd = open(CS filename, O_RDONLY)) < 0)
8205 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8212 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8215 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8223 big_buffer[off] = '\0';
8229 /*************************************************
8230 * Error-checking for testsuite *
8231 *************************************************/
8233 uschar * region_start;
8234 uschar * region_end;
8235 const uschar *var_name;
8236 const uschar *var_data;
8240 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8243 if (var_data >= e->region_start && var_data < e->region_end)
8245 e->var_name = CUS var_name;
8246 e->var_data = CUS var_data;
8251 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8253 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8254 .var_name = NULL, .var_data = NULL };
8256 /* check acl_ variables */
8257 tree_walk(acl_var_c, assert_variable_notin, &e);
8258 tree_walk(acl_var_m, assert_variable_notin, &e);
8260 /* check auth<n> variables */
8261 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8262 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
8264 /* check regex<n> variables */
8265 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8266 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
8268 /* check known-name variables */
8269 for (var_entry * v = var_table; v < var_table + var_table_size; v++)
8270 if (v->type == vtype_stringptr)
8271 assert_variable_notin(US v->name, *(USS v->value), &e);
8273 /* check dns and address trees */
8274 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8275 tree_walk(tree_duplicates, assert_variable_notin, &e);
8276 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8277 tree_walk(tree_unusable, assert_variable_notin, &e);
8280 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8281 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8282 e.var_name, filename, linenumber, e.var_data);
8287 /*************************************************
8288 **************************************************
8289 * Stand-alone test program *
8290 **************************************************
8291 *************************************************/
8297 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
8299 int ovector[3*(EXPAND_MAXN+1)];
8300 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8301 ovector, nelem(ovector));
8302 BOOL yield = n >= 0;
8303 if (n == 0) n = EXPAND_MAXN + 1;
8306 expand_nmax = setup < 0 ? 0 : setup + 1;
8307 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8309 expand_nstring[expand_nmax] = subject + ovector[nn];
8310 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8318 int main(int argc, uschar **argv)
8320 uschar buffer[1024];
8322 debug_selector = D_v;
8323 debug_file = stderr;
8324 debug_fd = fileno(debug_file);
8325 big_buffer = malloc(big_buffer_size);
8327 for (int i = 1; i < argc; i++)
8329 if (argv[i][0] == '+')
8331 debug_trace_memory = 2;
8334 if (isdigit(argv[i][0]))
8335 debug_selector = Ustrtol(argv[i], NULL, 0);
8337 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8341 eldap_default_servers = argv[i];
8344 mysql_servers = argv[i];
8347 pgsql_servers = argv[i];
8350 redis_servers = argv[i];
8354 else opt_perl_startup = argv[i];
8358 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8360 expand_nstring[1] = US"string 1....";
8361 expand_nlength[1] = 8;
8365 if (opt_perl_startup != NULL)
8368 printf("Starting Perl interpreter\n");
8369 errstr = init_perl(opt_perl_startup);
8372 printf("** error in perl_startup code: %s\n", errstr);
8373 return EXIT_FAILURE;
8376 #endif /* EXIM_PERL */
8378 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8380 void *reset_point = store_get(0);
8381 uschar *yield = expand_string(buffer);
8384 printf("%s\n", yield);
8385 store_reset(reset_point);
8389 if (f.search_find_defer) printf("search_find deferred\n");
8390 printf("Failed: %s\n", expand_string_message);
8391 if (f.expand_string_forcedfail) printf("Forced failure\n");
8405 /* End of expand.c */