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[] = {
132 #ifdef EXPERIMENTAL_SRS_NATIVE
166 #ifdef EXPERIMENTAL_SRS_NATIVE
172 /* Tables of operator names, and corresponding switch numbers. The names must be
173 in alphabetical order. There are two tables, because underscore is used in some
174 cases to introduce arguments, whereas for other it is part of the name. This is
175 an historical mis-design. */
177 static uschar *op_table_underscore[] = {
180 US"quote_local_part",
185 ,US"utf8_domain_from_alabel",
186 US"utf8_domain_to_alabel",
187 US"utf8_localpart_from_alabel",
188 US"utf8_localpart_to_alabel"
195 EOP_QUOTE_LOCAL_PART,
200 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
201 EOP_UTF8_DOMAIN_TO_ALABEL,
202 EOP_UTF8_LOCALPART_FROM_ALABEL,
203 EOP_UTF8_LOCALPART_TO_ALABEL
207 static uschar *op_table_main[] = {
255 EOP_ADDRESS = nelem(op_table_underscore),
302 /* Table of condition names, and corresponding switch numbers. The names must
303 be in alphabetical order. */
305 static uschar *cond_table[] = {
309 US"==", /* Backward compatibility */
332 #ifdef EXPERIMENTAL_SRS_NATIVE
349 US"match_local_part",
374 ECOND_FIRST_DELIVERY,
385 #ifdef EXPERIMENTAL_SRS_NATIVE
402 ECOND_MATCH_LOCAL_PART,
412 /* Types of table entry */
415 vtype_int, /* value is address of int */
416 vtype_filter_int, /* ditto, but recognized only when filtering */
417 vtype_ino, /* value is address of ino_t (not always an int) */
418 vtype_uid, /* value is address of uid_t (not always an int) */
419 vtype_gid, /* value is address of gid_t (not always an int) */
420 vtype_bool, /* value is address of bool */
421 vtype_stringptr, /* value is address of pointer to string */
422 vtype_msgbody, /* as stringptr, but read when first required */
423 vtype_msgbody_end, /* ditto, the end of the message */
424 vtype_msgheaders, /* the message's headers, processed */
425 vtype_msgheaders_raw, /* the message's headers, unprocessed */
426 vtype_localpart, /* extract local part from string */
427 vtype_domain, /* extract domain from string */
428 vtype_string_func, /* value is string returned by given function */
429 vtype_todbsdin, /* value not used; generate BSD inbox tod */
430 vtype_tode, /* value not used; generate tod in epoch format */
431 vtype_todel, /* value not used; generate tod in epoch/usec format */
432 vtype_todf, /* value not used; generate full tod */
433 vtype_todl, /* value not used; generate log tod */
434 vtype_todlf, /* value not used; generate log file datestamp tod */
435 vtype_todzone, /* value not used; generate time zone only */
436 vtype_todzulu, /* value not used; generate zulu tod */
437 vtype_reply, /* value not used; get reply from headers */
438 vtype_pid, /* value not used; result is pid */
439 vtype_host_lookup, /* value not used; get host name */
440 vtype_load_avg, /* value not used; result is int from os_getloadavg */
441 vtype_pspace, /* partition space; value is T/F for spool/log */
442 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
443 vtype_cert /* SSL certificate */
445 ,vtype_dkim /* Lookup of value in DKIM signature */
449 /* Type for main variable table */
457 /* Type for entries pointing to address/length pairs. Not currently
465 static uschar * fn_recipients(void);
466 typedef uschar * stringptr_fn_t(void);
468 /* This table must be kept in alphabetical order. */
470 static var_entry var_table[] = {
471 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
472 they will be confused with user-creatable ACL variables. */
473 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
474 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
475 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
476 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
477 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
478 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
479 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
480 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
481 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
482 { "acl_narg", vtype_int, &acl_narg },
483 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
484 { "address_data", vtype_stringptr, &deliver_address_data },
485 { "address_file", vtype_stringptr, &address_file },
486 { "address_pipe", vtype_stringptr, &address_pipe },
487 #ifdef EXPERIMENTAL_ARC
488 { "arc_domains", vtype_string_func, (void *) &fn_arc_domains },
489 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
490 { "arc_state", vtype_stringptr, &arc_state },
491 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
493 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
494 { "authenticated_id", vtype_stringptr, &authenticated_id },
495 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
496 { "authentication_failed",vtype_int, &authentication_failed },
497 #ifdef WITH_CONTENT_SCAN
498 { "av_failed", vtype_int, &av_failed },
500 #ifdef EXPERIMENTAL_BRIGHTMAIL
501 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
502 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
503 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
504 { "bmi_deliver", vtype_int, &bmi_deliver },
506 { "body_linecount", vtype_int, &body_linecount },
507 { "body_zerocount", vtype_int, &body_zerocount },
508 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
509 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
510 { "caller_gid", vtype_gid, &real_gid },
511 { "caller_uid", vtype_uid, &real_uid },
512 { "callout_address", vtype_stringptr, &callout_address },
513 { "compile_date", vtype_stringptr, &version_date },
514 { "compile_number", vtype_stringptr, &version_cnumber },
515 { "config_dir", vtype_stringptr, &config_main_directory },
516 { "config_file", vtype_stringptr, &config_main_filename },
517 { "csa_status", vtype_stringptr, &csa_status },
518 #ifdef EXPERIMENTAL_DCC
519 { "dcc_header", vtype_stringptr, &dcc_header },
520 { "dcc_result", vtype_stringptr, &dcc_result },
523 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
524 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
525 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
526 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
527 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
528 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
529 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
530 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
531 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
532 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
533 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
534 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
535 { "dkim_key_length", vtype_int, &dkim_key_length },
536 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
537 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
538 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
539 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
540 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
541 { "dkim_signers", vtype_stringptr, &dkim_signers },
542 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
543 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
546 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
547 { "dmarc_status", vtype_stringptr, &dmarc_status },
548 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
549 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
551 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
552 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
553 { "dnslist_text", vtype_stringptr, &dnslist_text },
554 { "dnslist_value", vtype_stringptr, &dnslist_value },
555 { "domain", vtype_stringptr, &deliver_domain },
556 { "domain_data", vtype_stringptr, &deliver_domain_data },
557 #ifndef DISABLE_EVENT
558 { "event_data", vtype_stringptr, &event_data },
560 /*XXX want to use generic vars for as many of these as possible*/
561 { "event_defer_errno", vtype_int, &event_defer_errno },
563 { "event_name", vtype_stringptr, &event_name },
565 { "exim_gid", vtype_gid, &exim_gid },
566 { "exim_path", vtype_stringptr, &exim_path },
567 { "exim_uid", vtype_uid, &exim_uid },
568 { "exim_version", vtype_stringptr, &version_string },
569 { "headers_added", vtype_string_func, (void *) &fn_hdrs_added },
570 { "home", vtype_stringptr, &deliver_home },
571 { "host", vtype_stringptr, &deliver_host },
572 { "host_address", vtype_stringptr, &deliver_host_address },
573 { "host_data", vtype_stringptr, &host_data },
574 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
575 { "host_lookup_failed", vtype_int, &host_lookup_failed },
576 { "host_port", vtype_int, &deliver_host_port },
577 { "initial_cwd", vtype_stringptr, &initial_cwd },
578 { "inode", vtype_ino, &deliver_inode },
579 { "interface_address", vtype_stringptr, &interface_address },
580 { "interface_port", vtype_int, &interface_port },
581 { "item", vtype_stringptr, &iterate_item },
583 { "ldap_dn", vtype_stringptr, &eldap_dn },
585 { "load_average", vtype_load_avg, NULL },
586 { "local_part", vtype_stringptr, &deliver_localpart },
587 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
588 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
589 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
590 #ifdef HAVE_LOCAL_SCAN
591 { "local_scan_data", vtype_stringptr, &local_scan_data },
593 { "local_user_gid", vtype_gid, &local_user_gid },
594 { "local_user_uid", vtype_uid, &local_user_uid },
595 { "localhost_number", vtype_int, &host_number },
596 { "log_inodes", vtype_pinodes, (void *)FALSE },
597 { "log_space", vtype_pspace, (void *)FALSE },
598 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
599 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
600 #ifdef WITH_CONTENT_SCAN
601 { "malware_name", vtype_stringptr, &malware_name },
603 { "max_received_linelength", vtype_int, &max_received_linelength },
604 { "message_age", vtype_int, &message_age },
605 { "message_body", vtype_msgbody, &message_body },
606 { "message_body_end", vtype_msgbody_end, &message_body_end },
607 { "message_body_size", vtype_int, &message_body_size },
608 { "message_exim_id", vtype_stringptr, &message_id },
609 { "message_headers", vtype_msgheaders, NULL },
610 { "message_headers_raw", vtype_msgheaders_raw, NULL },
611 { "message_id", vtype_stringptr, &message_id },
612 { "message_linecount", vtype_int, &message_linecount },
613 { "message_size", vtype_int, &message_size },
615 { "message_smtputf8", vtype_bool, &message_smtputf8 },
617 #ifdef WITH_CONTENT_SCAN
618 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
619 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
620 { "mime_boundary", vtype_stringptr, &mime_boundary },
621 { "mime_charset", vtype_stringptr, &mime_charset },
622 { "mime_content_description", vtype_stringptr, &mime_content_description },
623 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
624 { "mime_content_id", vtype_stringptr, &mime_content_id },
625 { "mime_content_size", vtype_int, &mime_content_size },
626 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
627 { "mime_content_type", vtype_stringptr, &mime_content_type },
628 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
629 { "mime_filename", vtype_stringptr, &mime_filename },
630 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
631 { "mime_is_multipart", vtype_int, &mime_is_multipart },
632 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
633 { "mime_part_count", vtype_int, &mime_part_count },
635 { "n0", vtype_filter_int, &filter_n[0] },
636 { "n1", vtype_filter_int, &filter_n[1] },
637 { "n2", vtype_filter_int, &filter_n[2] },
638 { "n3", vtype_filter_int, &filter_n[3] },
639 { "n4", vtype_filter_int, &filter_n[4] },
640 { "n5", vtype_filter_int, &filter_n[5] },
641 { "n6", vtype_filter_int, &filter_n[6] },
642 { "n7", vtype_filter_int, &filter_n[7] },
643 { "n8", vtype_filter_int, &filter_n[8] },
644 { "n9", vtype_filter_int, &filter_n[9] },
645 { "original_domain", vtype_stringptr, &deliver_domain_orig },
646 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
647 { "originator_gid", vtype_gid, &originator_gid },
648 { "originator_uid", vtype_uid, &originator_uid },
649 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
650 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
651 { "pid", vtype_pid, NULL },
653 { "prdr_requested", vtype_bool, &prdr_requested },
655 { "primary_hostname", vtype_stringptr, &primary_hostname },
656 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
657 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
658 { "proxy_external_port", vtype_int, &proxy_external_port },
659 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
660 { "proxy_local_port", vtype_int, &proxy_local_port },
661 { "proxy_session", vtype_bool, &proxy_session },
663 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
664 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
665 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
666 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
667 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
668 { "queue_name", vtype_stringptr, &queue_name },
669 { "rcpt_count", vtype_int, &rcpt_count },
670 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
671 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
672 { "received_count", vtype_int, &received_count },
673 { "received_for", vtype_stringptr, &received_for },
674 { "received_ip_address", vtype_stringptr, &interface_address },
675 { "received_port", vtype_int, &interface_port },
676 { "received_protocol", vtype_stringptr, &received_protocol },
677 { "received_time", vtype_int, &received_time.tv_sec },
678 { "recipient_data", vtype_stringptr, &recipient_data },
679 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
680 { "recipients", vtype_string_func, (void *) &fn_recipients },
681 { "recipients_count", vtype_int, &recipients_count },
682 #ifdef WITH_CONTENT_SCAN
683 { "regex_match_string", vtype_stringptr, ®ex_match_string },
685 { "reply_address", vtype_reply, NULL },
686 { "return_path", vtype_stringptr, &return_path },
687 { "return_size_limit", vtype_int, &bounce_return_size_limit },
688 { "router_name", vtype_stringptr, &router_name },
689 { "runrc", vtype_int, &runrc },
690 { "self_hostname", vtype_stringptr, &self_hostname },
691 { "sender_address", vtype_stringptr, &sender_address },
692 { "sender_address_data", vtype_stringptr, &sender_address_data },
693 { "sender_address_domain", vtype_domain, &sender_address },
694 { "sender_address_local_part", vtype_localpart, &sender_address },
695 { "sender_data", vtype_stringptr, &sender_data },
696 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
697 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
698 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
699 { "sender_host_address", vtype_stringptr, &sender_host_address },
700 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
701 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
702 { "sender_host_name", vtype_host_lookup, NULL },
703 { "sender_host_port", vtype_int, &sender_host_port },
704 { "sender_ident", vtype_stringptr, &sender_ident },
705 { "sender_rate", vtype_stringptr, &sender_rate },
706 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
707 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
708 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
709 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
710 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
711 { "sending_port", vtype_int, &sending_port },
712 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
713 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
714 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
715 { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
716 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
717 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
718 { "sn0", vtype_filter_int, &filter_sn[0] },
719 { "sn1", vtype_filter_int, &filter_sn[1] },
720 { "sn2", vtype_filter_int, &filter_sn[2] },
721 { "sn3", vtype_filter_int, &filter_sn[3] },
722 { "sn4", vtype_filter_int, &filter_sn[4] },
723 { "sn5", vtype_filter_int, &filter_sn[5] },
724 { "sn6", vtype_filter_int, &filter_sn[6] },
725 { "sn7", vtype_filter_int, &filter_sn[7] },
726 { "sn8", vtype_filter_int, &filter_sn[8] },
727 { "sn9", vtype_filter_int, &filter_sn[9] },
728 #ifdef WITH_CONTENT_SCAN
729 { "spam_action", vtype_stringptr, &spam_action },
730 { "spam_bar", vtype_stringptr, &spam_bar },
731 { "spam_report", vtype_stringptr, &spam_report },
732 { "spam_score", vtype_stringptr, &spam_score },
733 { "spam_score_int", vtype_stringptr, &spam_score_int },
736 { "spf_guess", vtype_stringptr, &spf_guess },
737 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
738 { "spf_received", vtype_stringptr, &spf_received },
739 { "spf_result", vtype_stringptr, &spf_result },
740 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
741 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
743 { "spool_directory", vtype_stringptr, &spool_directory },
744 { "spool_inodes", vtype_pinodes, (void *)TRUE },
745 { "spool_space", vtype_pspace, (void *)TRUE },
746 #ifdef EXPERIMENTAL_SRS
747 { "srs_db_address", vtype_stringptr, &srs_db_address },
748 { "srs_db_key", vtype_stringptr, &srs_db_key },
749 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
750 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
752 #if defined(EXPERIMENTAL_SRS) || defined(EXPERIMENTAL_SRS_NATIVE)
753 { "srs_recipient", vtype_stringptr, &srs_recipient },
755 #ifdef EXPERIMENTAL_SRS
756 { "srs_status", vtype_stringptr, &srs_status },
758 { "thisaddress", vtype_stringptr, &filter_thisaddress },
760 /* The non-(in,out) variables are now deprecated */
761 { "tls_bits", vtype_int, &tls_in.bits },
762 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
763 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
765 { "tls_in_bits", vtype_int, &tls_in.bits },
766 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
767 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
768 { "tls_in_cipher_std", vtype_stringptr, &tls_in.cipher_stdname },
769 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
770 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
771 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
772 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
773 #ifdef EXPERIMENTAL_TLS_RESUME
774 { "tls_in_resumption", vtype_int, &tls_in.resumption },
777 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
779 { "tls_out_bits", vtype_int, &tls_out.bits },
780 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
781 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
782 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },
784 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
786 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
787 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
788 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
789 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
790 #ifdef EXPERIMENTAL_TLS_RESUME
791 { "tls_out_resumption", vtype_int, &tls_out.resumption },
794 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
797 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
800 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
802 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
805 { "tod_bsdinbox", vtype_todbsdin, NULL },
806 { "tod_epoch", vtype_tode, NULL },
807 { "tod_epoch_l", vtype_todel, NULL },
808 { "tod_full", vtype_todf, NULL },
809 { "tod_log", vtype_todl, NULL },
810 { "tod_logfile", vtype_todlf, NULL },
811 { "tod_zone", vtype_todzone, NULL },
812 { "tod_zulu", vtype_todzulu, NULL },
813 { "transport_name", vtype_stringptr, &transport_name },
814 { "value", vtype_stringptr, &lookup_value },
815 { "verify_mode", vtype_stringptr, &verify_mode },
816 { "version_number", vtype_stringptr, &version_string },
817 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
818 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
819 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
820 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
821 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
822 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
825 static int var_table_size = nelem(var_table);
826 static uschar var_buffer[256];
827 static BOOL malformed_header;
829 /* For textual hashes */
831 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
832 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
835 enum { HMAC_MD5, HMAC_SHA1 };
837 /* For numeric hashes */
839 static unsigned int prime[] = {
840 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
841 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
842 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
844 /* For printing modes in symbolic form */
846 static uschar *mtable_normal[] =
847 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
849 static uschar *mtable_setid[] =
850 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
852 static uschar *mtable_sticky[] =
853 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
855 /* flags for find_header() */
856 #define FH_EXISTS_ONLY BIT(0)
857 #define FH_WANT_RAW BIT(1)
858 #define FH_WANT_LIST BIT(2)
861 /*************************************************
862 * Tables for UTF-8 support *
863 *************************************************/
865 /* Table of the number of extra characters, indexed by the first character
866 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
869 static uschar utf8_table1[] = {
870 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
871 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
872 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
873 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
875 /* These are the masks for the data bits in the first byte of a character,
876 indexed by the number of additional bytes. */
878 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
880 /* Get the next UTF-8 character, advancing the pointer. */
882 #define GETUTF8INC(c, ptr) \
884 if ((c & 0xc0) == 0xc0) \
886 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
888 c = (c & utf8_table2[a]) << s; \
892 c |= (*ptr++ & 0x3f) << s; \
898 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
900 /*************************************************
901 * Binary chop search on a table *
902 *************************************************/
904 /* This is used for matching expansion items and operators.
907 name the name that is being sought
908 table the table to search
909 table_size the number of items in the table
911 Returns: the offset in the table, or -1
915 chop_match(uschar *name, uschar **table, int table_size)
917 uschar **bot = table;
918 uschar **top = table + table_size;
922 uschar **mid = bot + (top - bot)/2;
923 int c = Ustrcmp(name, *mid);
924 if (c == 0) return mid - table;
925 if (c > 0) bot = mid + 1; else top = mid;
933 /*************************************************
934 * Check a condition string *
935 *************************************************/
937 /* This function is called to expand a string, and test the result for a "true"
938 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
939 forced fail or lookup defer.
941 We used to release all store used, but this is not not safe due
942 to ${dlfunc } and ${acl }. In any case expand_string_internal()
943 is reasonably careful to release what it can.
945 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
948 condition the condition string
949 m1 text to be incorporated in panic error
952 Returns: TRUE if condition is met, FALSE if not
956 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
958 uschar * ss = expand_string(condition);
961 if (!f.expand_string_forcedfail && !f.search_find_defer)
962 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
963 "for %s %s: %s", condition, m1, m2, expand_string_message);
966 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
967 strcmpic(ss, US"false") != 0;
973 /*************************************************
974 * Pseudo-random number generation *
975 *************************************************/
977 /* Pseudo-random number generation. The result is not "expected" to be
978 cryptographically strong but not so weak that someone will shoot themselves
979 in the foot using it as a nonce in some email header scheme or whatever
980 weirdness they'll twist this into. The result should ideally handle fork().
982 However, if we're stuck unable to provide this, then we'll fall back to
983 appallingly bad randomness.
985 If DISABLE_TLS is not defined then this will not be used except as an emergency
990 Returns a random number in range [0, max-1]
994 # define vaguely_random_number vaguely_random_number_fallback
997 vaguely_random_number(int max)
1000 # undef vaguely_random_number
1002 static pid_t pid = 0;
1005 if ((p2 = getpid()) != pid)
1010 #ifdef HAVE_ARC4RANDOM
1011 /* cryptographically strong randomness, common on *BSD platforms, not
1012 so much elsewhere. Alas. */
1013 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1016 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1017 # ifdef HAVE_SRANDOMDEV
1018 /* uses random(4) for seeding */
1023 gettimeofday(&tv, NULL);
1024 srandom(tv.tv_sec | tv.tv_usec | getpid());
1028 /* Poor randomness and no seeding here */
1035 #ifdef HAVE_ARC4RANDOM
1036 return arc4random() % max;
1037 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1038 return random() % max;
1040 /* This one returns a 16-bit number, definitely not crypto-strong */
1041 return random_number(max);
1048 /*************************************************
1049 * Pick out a name from a string *
1050 *************************************************/
1052 /* If the name is too long, it is silently truncated.
1055 name points to a buffer into which to put the name
1056 max is the length of the buffer
1057 s points to the first alphabetic character of the name
1058 extras chars other than alphanumerics to permit
1060 Returns: pointer to the first character after the name
1062 Note: The test for *s != 0 in the while loop is necessary because
1063 Ustrchr() yields non-NULL if the character is zero (which is not something
1066 static const uschar *
1067 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1070 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1072 if (ptr < max-1) name[ptr++] = *s;
1081 /*************************************************
1082 * Pick out the rest of a header name *
1083 *************************************************/
1085 /* A variable name starting $header_ (or just $h_ for those who like
1086 abbreviations) might not be the complete header name because headers can
1087 contain any printing characters in their names, except ':'. This function is
1088 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1089 on the end, if the name was terminated by white space.
1092 name points to a buffer in which the name read so far exists
1093 max is the length of the buffer
1094 s points to the first character after the name so far, i.e. the
1095 first non-alphameric character after $header_xxxxx
1097 Returns: a pointer to the first character after the header name
1100 static const uschar *
1101 read_header_name(uschar *name, int max, const uschar *s)
1103 int prelen = Ustrchr(name, '_') - name + 1;
1104 int ptr = Ustrlen(name) - prelen;
1105 if (ptr > 0) memmove(name, name+prelen, ptr);
1106 while (mac_isgraph(*s) && *s != ':')
1108 if (ptr < max-1) name[ptr++] = *s;
1119 /*************************************************
1120 * Pick out a number from a string *
1121 *************************************************/
1124 n points to an integer into which to put the number
1125 s points to the first digit of the number
1127 Returns: a pointer to the character after the last digit
1129 /*XXX consider expanding to int_eximarith_t. But the test for
1130 "overbig numbers" in 0002 still needs to overflow it. */
1133 read_number(int *n, uschar *s)
1136 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1140 static const uschar *
1141 read_cnumber(int *n, const uschar *s)
1144 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1150 /*************************************************
1151 * Extract keyed subfield from a string *
1152 *************************************************/
1154 /* The yield is in dynamic store; NULL means that the key was not found.
1157 key points to the name of the key
1158 s points to the string from which to extract the subfield
1160 Returns: NULL if the subfield was not found, or
1161 a pointer to the subfield's data
1165 expand_getkeyed(uschar * key, const uschar * s)
1167 int length = Ustrlen(key);
1168 while (isspace(*s)) s++;
1170 /* Loop to search for the key */
1176 const uschar * dkey = s;
1178 while (*s && *s != '=' && !isspace(*s)) s++;
1179 dkeylength = s - dkey;
1180 while (isspace(*s)) s++;
1181 if (*s == '=') while (isspace((*(++s))));
1183 data = string_dequote(&s);
1184 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1187 while (isspace(*s)) s++;
1196 find_var_ent(uschar * name)
1199 int last = var_table_size;
1201 while (last > first)
1203 int middle = (first + last)/2;
1204 int c = Ustrcmp(name, var_table[middle].name);
1206 if (c > 0) { first = middle + 1; continue; }
1207 if (c < 0) { last = middle; continue; }
1208 return &var_table[middle];
1213 /*************************************************
1214 * Extract numbered subfield from string *
1215 *************************************************/
1217 /* Extracts a numbered field from a string that is divided by tokens - for
1218 example a line from /etc/passwd is divided by colon characters. First field is
1219 numbered one. Negative arguments count from the right. Zero returns the whole
1220 string. Returns NULL if there are insufficient tokens in the string
1223 Modifies final argument - this is a dynamically generated string, so that's OK.
1226 field number of field to be extracted,
1227 first field = 1, whole string = 0, last field = -1
1228 separators characters that are used to break string into tokens
1229 s points to the string from which to extract the subfield
1231 Returns: NULL if the field was not found,
1232 a pointer to the field's data inside s (modified to add 0)
1236 expand_gettokened (int field, uschar *separators, uschar *s)
1241 uschar *fieldtext = NULL;
1243 if (field == 0) return s;
1245 /* Break the line up into fields in place; for field > 0 we stop when we have
1246 done the number of fields we want. For field < 0 we continue till the end of
1247 the string, counting the number of fields. */
1249 count = (field > 0)? field : INT_MAX;
1255 /* Previous field was the last one in the string. For a positive field
1256 number, this means there are not enough fields. For a negative field number,
1257 check that there are enough, and scan back to find the one that is wanted. */
1261 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1262 if ((-field) == (INT_MAX - count - 1)) return s;
1266 while (ss[-1] != 0) ss--;
1272 /* Previous field was not last in the string; save its start and put a
1276 len = Ustrcspn(ss, separators);
1287 expand_getlistele(int field, const uschar * list)
1289 const uschar * tlist = list;
1295 for (field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1298 if (field == 0) return NULL;
1299 while (--field > 0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1300 return string_nextinlist(&list, &sep, NULL, 0);
1304 /* Certificate fields, by name. Worry about by-OID later */
1305 /* Names are chosen to not have common prefixes */
1312 uschar * (*getfn)(void * cert, uschar * mod);
1314 static certfield certfields[] =
1315 { /* linear search; no special order */
1316 { US"version", 7, &tls_cert_version },
1317 { US"serial_number", 13, &tls_cert_serial_number },
1318 { US"subject", 7, &tls_cert_subject },
1319 { US"notbefore", 9, &tls_cert_not_before },
1320 { US"notafter", 8, &tls_cert_not_after },
1321 { US"issuer", 6, &tls_cert_issuer },
1322 { US"signature", 9, &tls_cert_signature },
1323 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1324 { US"subj_altname", 12, &tls_cert_subject_altname },
1325 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1326 { US"crl_uri", 7, &tls_cert_crl_uri },
1330 expand_getcertele(uschar * field, uschar * certvar)
1334 if (!(vp = find_var_ent(certvar)))
1336 expand_string_message =
1337 string_sprintf("no variable named \"%s\"", certvar);
1338 return NULL; /* Unknown variable name */
1340 /* NB this stops us passing certs around in variable. Might
1341 want to do that in future */
1342 if (vp->type != vtype_cert)
1344 expand_string_message =
1345 string_sprintf("\"%s\" is not a certificate", certvar);
1346 return NULL; /* Unknown variable name */
1348 if (!*(void **)vp->value)
1351 if (*field >= '0' && *field <= '9')
1352 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1354 for (certfield * cp = certfields;
1355 cp < certfields + nelem(certfields);
1357 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1359 uschar * modifier = *(field += cp->namelen) == ','
1361 return (*cp->getfn)( *(void **)vp->value, modifier );
1364 expand_string_message =
1365 string_sprintf("bad field selector \"%s\" for certextract", field);
1368 #endif /*DISABLE_TLS*/
1370 /*************************************************
1371 * Extract a substring from a string *
1372 *************************************************/
1374 /* Perform the ${substr or ${length expansion operations.
1377 subject the input string
1378 value1 the offset from the start of the input string to the start of
1379 the output string; if negative, count from the right.
1380 value2 the length of the output string, or negative (-1) for unset
1381 if value1 is positive, unset means "all after"
1382 if value1 is negative, unset means "all before"
1383 len set to the length of the returned string
1385 Returns: pointer to the output string, or NULL if there is an error
1389 extract_substr(uschar *subject, int value1, int value2, int *len)
1391 int sublen = Ustrlen(subject);
1393 if (value1 < 0) /* count from right */
1397 /* If the position is before the start, skip to the start, and adjust the
1398 length. If the length ends up negative, the substring is null because nothing
1399 can precede. This falls out naturally when the length is unset, meaning "all
1405 if (value2 < 0) value2 = 0;
1409 /* Otherwise an unset length => characters before value1 */
1411 else if (value2 < 0)
1418 /* For a non-negative offset, if the starting position is past the end of the
1419 string, the result will be the null string. Otherwise, an unset length means
1420 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1424 if (value1 > sublen)
1429 else if (value2 < 0) value2 = sublen;
1432 /* Cut the length down to the maximum possible for the offset value, and get
1433 the required characters. */
1435 if (value1 + value2 > sublen) value2 = sublen - value1;
1437 return subject + value1;
1443 /*************************************************
1444 * Old-style hash of a string *
1445 *************************************************/
1447 /* Perform the ${hash expansion operation.
1450 subject the input string (an expanded substring)
1451 value1 the length of the output string; if greater or equal to the
1452 length of the input string, the input string is returned
1453 value2 the number of hash characters to use, or 26 if negative
1454 len set to the length of the returned string
1456 Returns: pointer to the output string, or NULL if there is an error
1460 compute_hash(uschar *subject, int value1, int value2, int *len)
1462 int sublen = Ustrlen(subject);
1464 if (value2 < 0) value2 = 26;
1465 else if (value2 > Ustrlen(hashcodes))
1467 expand_string_message =
1468 string_sprintf("hash count \"%d\" too big", value2);
1472 /* Calculate the hash text. We know it is shorter than the original string, so
1473 can safely place it in subject[] (we know that subject is always itself an
1474 expanded substring). */
1476 if (value1 < sublen)
1481 while ((c = (subject[j])) != 0)
1483 int shift = (c + j++) & 7;
1484 subject[i] ^= (c << shift) | (c >> (8-shift));
1485 if (++i >= value1) i = 0;
1487 for (i = 0; i < value1; i++)
1488 subject[i] = hashcodes[(subject[i]) % value2];
1490 else value1 = sublen;
1499 /*************************************************
1500 * Numeric hash of a string *
1501 *************************************************/
1503 /* Perform the ${nhash expansion operation. The first characters of the
1504 string are treated as most important, and get the highest prime numbers.
1507 subject the input string
1508 value1 the maximum value of the first part of the result
1509 value2 the maximum value of the second part of the result,
1510 or negative to produce only a one-part result
1511 len set to the length of the returned string
1513 Returns: pointer to the output string, or NULL if there is an error.
1517 compute_nhash (uschar *subject, int value1, int value2, int *len)
1519 uschar *s = subject;
1521 unsigned long int total = 0; /* no overflow */
1525 if (i == 0) i = nelem(prime) - 1;
1526 total += prime[i--] * (unsigned int)(*s++);
1529 /* If value2 is unset, just compute one number */
1532 s = string_sprintf("%lu", total % value1);
1534 /* Otherwise do a div/mod hash */
1538 total = total % (value1 * value2);
1539 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1550 /*************************************************
1551 * Find the value of a header or headers *
1552 *************************************************/
1554 /* Multiple instances of the same header get concatenated, and this function
1555 can also return a concatenation of all the header lines. When concatenating
1556 specific headers that contain lists of addresses, a comma is inserted between
1557 them. Otherwise we use a straight concatenation. Because some messages can have
1558 pathologically large number of lines, there is a limit on the length that is
1562 name the name of the header, without the leading $header_ or $h_,
1563 or NULL if a concatenation of all headers is required
1564 newsize return the size of memory block that was obtained; may be NULL
1565 if exists_only is TRUE
1566 flags FH_EXISTS_ONLY
1567 set if called from a def: test; don't need to build a string;
1568 just return a string that is not "" and not "0" if the header
1571 set if called for $rh_ or $rheader_ items; no processing,
1572 other than concatenating, will be done on the header. Also used
1573 for $message_headers_raw.
1575 Double colon chars in the content, and replace newline with
1576 colon between each element when concatenating; returning a
1577 colon-sep list (elements might contain newlines)
1578 charset name of charset to translate MIME words to; used only if
1579 want_raw is false; if NULL, no translation is done (this is
1580 used for $bh_ and $bheader_)
1582 Returns: NULL if the header does not exist, else a pointer to a new
1587 find_header(uschar *name, int *newsize, unsigned flags, uschar *charset)
1590 int len = name ? Ustrlen(name) : 0;
1594 for (header_line * h = header_list; h; h = h->next)
1595 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1596 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1601 if (flags & FH_EXISTS_ONLY)
1602 return US"1"; /* don't need actual string */
1605 s = h->text + len; /* text to insert */
1606 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1607 while (isspace(*s)) s++; /* remove leading white space */
1608 t = h->text + h->slen; /* end-point */
1610 /* Unless wanted raw, remove trailing whitespace, including the
1613 if (flags & FH_WANT_LIST)
1614 while (t > s && t[-1] == '\n') t--;
1615 else if (!(flags & FH_WANT_RAW))
1617 while (t > s && isspace(t[-1])) t--;
1619 /* Set comma if handling a single header and it's one of those
1620 that contains an address list, except when asked for raw headers. Only
1621 need to do this once. */
1623 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1626 /* Trim the header roughly if we're approaching limits */
1628 if ((g ? g->ptr : 0) + inc > header_insert_maxlen)
1629 inc = header_insert_maxlen - (g ? g->ptr : 0);
1631 /* For raw just copy the data; for a list, add the data as a colon-sep
1632 list-element; for comma-list add as an unchecked comma,newline sep
1633 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1634 stripped trailing WS above including the newline). We ignore the potential
1635 expansion due to colon-doubling, just leaving the loop if the limit is met
1638 if (flags & FH_WANT_LIST)
1639 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1640 else if (flags & FH_WANT_RAW)
1642 g = string_catn(g, s, (unsigned)inc);
1643 (void) string_from_gstring(g);
1647 g = string_append2_listele_n(g, US",\n", s, (unsigned)inc);
1649 g = string_append2_listele_n(g, US"\n", s, (unsigned)inc);
1651 if (g && g->ptr >= header_insert_maxlen) break;
1654 if (!found) return NULL; /* No header found */
1655 if (!g) return US"";
1657 /* That's all we do for raw header expansion. */
1660 if (flags & FH_WANT_RAW)
1663 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1664 The rfc2047_decode2() function can return an error with decoded data if the
1665 charset translation fails. If decoding fails, it returns NULL. */
1669 uschar *decoded, *error;
1671 decoded = rfc2047_decode2(g->s, check_rfc2047_length, charset, '?', NULL,
1675 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1676 " input was: %s\n", error, g->s);
1678 return decoded ? decoded : g->s;
1685 /* Append a "local" element to an Authentication-Results: header
1686 if this was a non-smtp message.
1690 authres_local(gstring * g, const uschar * sysname)
1692 if (!f.authentication_local)
1694 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1695 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1700 /* Append an "iprev" element to an Authentication-Results: header
1701 if we have attempted to get the calling host's name.
1705 authres_iprev(gstring * g)
1707 if (sender_host_name)
1708 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1709 else if (host_lookup_deferred)
1710 g = string_catn(g, US";\n\tiprev=temperror", 19);
1711 else if (host_lookup_failed)
1712 g = string_catn(g, US";\n\tiprev=fail", 13);
1716 if (sender_host_address)
1717 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1723 /*************************************************
1724 * Return list of recipients *
1725 *************************************************/
1726 /* A recipients list is available only during system message filtering,
1727 during ACL processing after DATA, and while expanding pipe commands
1728 generated from a system filter, but not elsewhere. */
1736 if (!f.enable_dollar_recipients) return NULL;
1738 for (int i = 0; i < recipients_count; i++)
1740 s = recipients_list[i].address;
1741 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1743 return g ? g->s : NULL;
1747 /*************************************************
1748 * Find value of a variable *
1749 *************************************************/
1751 /* The table of variables is kept in alphabetic order, so we can search it
1752 using a binary chop. The "choplen" variable is nothing to do with the binary
1756 name the name of the variable being sought
1757 exists_only TRUE if this is a def: test; passed on to find_header()
1758 skipping TRUE => skip any processing evaluation; this is not the same as
1759 exists_only because def: may test for values that are first
1761 newsize pointer to an int which is initially zero; if the answer is in
1762 a new memory buffer, *newsize is set to its size
1764 Returns: NULL if the variable does not exist, or
1765 a pointer to the variable's contents, or
1766 something non-NULL if exists_only is TRUE
1770 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1777 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1778 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1779 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1780 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1781 (this gave backwards compatibility at the changeover). There may be built-in
1782 variables whose names start acl_ but they should never start in this way. This
1783 slightly messy specification is a consequence of the history, needless to say.
1785 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1786 set, in which case give an error. */
1788 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1792 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1793 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1795 else if (Ustrncmp(name, "r_", 2) == 0)
1797 tree_node * node = tree_search(router_var, name + 2);
1798 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1801 /* Handle $auth<n> variables. */
1803 if (Ustrncmp(name, "auth", 4) == 0)
1806 int n = Ustrtoul(name + 4, &endptr, 10);
1807 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1808 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1810 else if (Ustrncmp(name, "regex", 5) == 0)
1813 int n = Ustrtoul(name + 5, &endptr, 10);
1814 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1815 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1818 /* For all other variables, search the table */
1820 if (!(vp = find_var_ent(name)))
1821 return NULL; /* Unknown variable name */
1823 /* Found an existing variable. If in skipping state, the value isn't needed,
1824 and we want to avoid processing (such as looking up the host name). */
1832 case vtype_filter_int:
1833 if (!f.filter_running) return NULL;
1837 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1841 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1845 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1849 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1853 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1856 case vtype_stringptr: /* Pointer to string */
1857 return (s = *((uschar **)(val))) ? s : US"";
1860 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1863 case vtype_load_avg:
1864 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1867 case vtype_host_lookup: /* Lookup if not done so */
1868 if ( !sender_host_name && sender_host_address
1869 && !host_lookup_failed && host_name_lookup() == OK)
1870 host_build_sender_fullhost();
1871 return sender_host_name ? sender_host_name : US"";
1873 case vtype_localpart: /* Get local part from address */
1874 if (!(s = *((uschar **)(val)))) return US"";
1875 if (!(domain = Ustrrchr(s, '@'))) return s;
1876 if (domain - s > sizeof(var_buffer) - 1)
1877 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1878 " in string expansion", sizeof(var_buffer));
1879 return string_copyn(s, domain - s);
1881 case vtype_domain: /* Get domain from address */
1882 if (!(s = *((uschar **)(val)))) return US"";
1883 domain = Ustrrchr(s, '@');
1884 return domain ? domain + 1 : US"";
1886 case vtype_msgheaders:
1887 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
1889 case vtype_msgheaders_raw:
1890 return find_header(NULL, newsize,
1891 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
1893 case vtype_msgbody: /* Pointer to msgbody string */
1894 case vtype_msgbody_end: /* Ditto, the end of the msg */
1895 ss = (uschar **)(val);
1896 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1899 off_t start_offset = SPOOL_DATA_START_OFFSET;
1900 int len = message_body_visible;
1901 if (len > message_size) len = message_size;
1902 *ss = body = store_malloc(len+1);
1904 if (vp->type == vtype_msgbody_end)
1906 struct stat statbuf;
1907 if (fstat(deliver_datafile, &statbuf) == 0)
1909 start_offset = statbuf.st_size - len;
1910 if (start_offset < SPOOL_DATA_START_OFFSET)
1911 start_offset = SPOOL_DATA_START_OFFSET;
1914 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1915 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1917 len = read(deliver_datafile, body, len);
1921 if (message_body_newlines) /* Separate loops for efficiency */
1923 { if (body[--len] == 0) body[len] = ' '; }
1926 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1929 return *ss ? *ss : US"";
1931 case vtype_todbsdin: /* BSD inbox time of day */
1932 return tod_stamp(tod_bsdin);
1934 case vtype_tode: /* Unix epoch time of day */
1935 return tod_stamp(tod_epoch);
1937 case vtype_todel: /* Unix epoch/usec time of day */
1938 return tod_stamp(tod_epoch_l);
1940 case vtype_todf: /* Full time of day */
1941 return tod_stamp(tod_full);
1943 case vtype_todl: /* Log format time of day */
1944 return tod_stamp(tod_log_bare); /* (without timezone) */
1946 case vtype_todzone: /* Time zone offset only */
1947 return tod_stamp(tod_zone);
1949 case vtype_todzulu: /* Zulu time */
1950 return tod_stamp(tod_zulu);
1952 case vtype_todlf: /* Log file datestamp tod */
1953 return tod_stamp(tod_log_datestamp_daily);
1955 case vtype_reply: /* Get reply address */
1956 s = find_header(US"reply-to:", newsize,
1957 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
1959 if (s) while (isspace(*s)) s++;
1962 *newsize = 0; /* For the *s==0 case */
1963 s = find_header(US"from:", newsize,
1964 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
1970 while (isspace(*s)) s++;
1971 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1972 while (t > s && isspace(t[-1])) t--;
1975 return s ? s : US"";
1977 case vtype_string_func:
1979 stringptr_fn_t * fn = (stringptr_fn_t *) val;
1986 sprintf(CS var_buffer, PR_EXIM_ARITH,
1987 receive_statvfs(val == (void *)TRUE, &inodes));
1994 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1995 sprintf(CS var_buffer, "%d", inodes);
2000 return *(void **)val ? US"<cert>" : US"";
2002 #ifndef DISABLE_DKIM
2004 return dkim_exim_expand_query((int)(long)val);
2009 return NULL; /* Unknown variable. Silences static checkers. */
2016 modify_variable(uschar *name, void * value)
2019 if ((vp = find_var_ent(name))) vp->value = value;
2020 return; /* Unknown variable name, fail silently */
2028 /*************************************************
2029 * Read and expand substrings *
2030 *************************************************/
2032 /* This function is called to read and expand argument substrings for various
2033 expansion items. Some have a minimum requirement that is less than the maximum;
2034 in these cases, the first non-present one is set to NULL.
2037 sub points to vector of pointers to set
2038 n maximum number of substrings
2040 sptr points to current string pointer
2041 skipping the skipping flag
2042 check_end if TRUE, check for final '}'
2043 name name of item, for error message
2044 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2047 Returns: 0 OK; string pointer updated
2048 1 curly bracketing error (too few arguments)
2049 2 too many arguments (only if check_end is set); message set
2050 3 other error (expansion failure)
2054 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
2055 BOOL check_end, uschar *name, BOOL *resetok)
2057 const uschar *s = *sptr;
2059 while (isspace(*s)) s++;
2060 for (int i = 0; i < n; i++)
2066 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2067 "(min is %d)", name, m);
2073 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2075 if (*s++ != '}') return 1;
2076 while (isspace(*s)) s++;
2078 if (check_end && *s++ != '}')
2082 expand_string_message = string_sprintf("Too many arguments for '%s' "
2083 "(max is %d)", name, n);
2086 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2097 /*************************************************
2098 * Elaborate message for bad variable *
2099 *************************************************/
2101 /* For the "unknown variable" message, take a look at the variable's name, and
2102 give additional information about possible ACL variables. The extra information
2103 is added on to expand_string_message.
2105 Argument: the name of the variable
2110 check_variable_error_message(uschar *name)
2112 if (Ustrncmp(name, "acl_", 4) == 0)
2113 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2114 (name[4] == 'c' || name[4] == 'm')?
2116 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2117 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2119 US"user-defined ACL variables must start acl_c or acl_m");
2125 Load args from sub array to globals, and call acl_check().
2126 Sub array will be corrupted on return.
2128 Returns: OK access is granted by an ACCEPT verb
2129 DISCARD access is (apparently) granted by a DISCARD verb
2130 FAIL access is denied
2131 FAIL_DROP access is denied; drop the connection
2132 DEFER can't tell at the moment
2136 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2139 int sav_narg = acl_narg;
2141 uschar * dummy_logmsg;
2142 extern int acl_where;
2144 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2145 for (i = 0; i < nsub && sub[i+1]; i++)
2147 uschar * tmp = acl_arg[i];
2148 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2149 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2154 sub[i+1] = acl_arg[i];
2155 acl_arg[i++] = NULL;
2159 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2161 acl_narg>0 ? acl_arg[0] : US"<none>",
2162 acl_narg>1 ? " +more" : "");
2164 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2166 for (i = 0; i < nsub; i++)
2167 acl_arg[i] = sub[i+1]; /* restore old args */
2168 acl_narg = sav_narg;
2176 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2177 The given string is modified on return. Leading whitespace is skipped while
2178 looking for the opening wrap character, then the rest is scanned for the trailing
2179 (non-escaped) wrap character. A backslash in the string will act as an escape.
2181 A nul is written over the trailing wrap, and a pointer to the char after the
2182 leading wrap is returned.
2185 s String for de-wrapping
2186 wrap Two-char string, the first being the opener, second the closer wrapping
2189 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2193 dewrap(uschar * s, const uschar * wrap)
2197 BOOL quotesmode = wrap[0] == wrap[1];
2199 while (isspace(*p)) p++;
2207 if (*p == '\\') p++;
2208 else if (!quotesmode && *p == wrap[-1]) depth++;
2209 else if (*p == *wrap)
2220 expand_string_message = string_sprintf("missing '%c'", *wrap);
2225 /* Pull off the leading array or object element, returning
2226 a copy in an allocated string. Update the list pointer.
2228 The element may itself be an abject or array.
2229 Return NULL when the list is empty.
2233 json_nextinlist(const uschar ** list)
2235 unsigned array_depth = 0, object_depth = 0;
2236 const uschar * s = *list, * item;
2238 while (isspace(*s)) s++;
2241 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2245 case '[': array_depth++; break;
2246 case ']': array_depth--; break;
2247 case '{': object_depth++; break;
2248 case '}': object_depth--; break;
2250 *list = *s ? s+1 : s;
2251 if (item == s) return NULL;
2252 item = string_copyn(item, s - item);
2253 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2259 /************************************************/
2260 /* Return offset in ops table, or -1 if not found.
2261 Repoint to just after the operator in the string.
2264 ss string representation of operator
2265 opname split-out operator name
2269 identify_operator(const uschar ** ss, uschar ** opname)
2271 const uschar * s = *ss;
2274 /* Numeric comparisons are symbolic */
2276 if (*s == '=' || *s == '>' || *s == '<')
2288 /* All other conditions are named */
2291 s = read_name(name, sizeof(name), s, US"_");
2294 /* If we haven't read a name, it means some non-alpha character is first. */
2298 expand_string_message = string_sprintf("condition name expected, "
2299 "but found \"%.16s\"", s);
2303 *opname = string_copy(name);
2305 return chop_match(name, cond_table, nelem(cond_table));
2309 /*************************************************
2310 * Handle MD5 or SHA-1 computation for HMAC *
2311 *************************************************/
2313 /* These are some wrapping functions that enable the HMAC code to be a bit
2314 cleaner. A good compiler will spot the tail recursion.
2317 type HMAC_MD5 or HMAC_SHA1
2318 remaining are as for the cryptographic hash functions
2324 chash_start(int type, void * base)
2326 if (type == HMAC_MD5)
2327 md5_start((md5 *)base);
2329 sha1_start((hctx *)base);
2333 chash_mid(int type, void * base, const uschar * string)
2335 if (type == HMAC_MD5)
2336 md5_mid((md5 *)base, string);
2338 sha1_mid((hctx *)base, string);
2342 chash_end(int type, void * base, const uschar * string, int length,
2345 if (type == HMAC_MD5)
2346 md5_end((md5 *)base, string, length, digest);
2348 sha1_end((hctx *)base, string, length, digest);
2354 /* Do an hmac_md5. The result is _not_ nul-terminated, and is sized as
2355 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2358 key encoding key, nul-terminated
2359 src data to be hashed, nul-terminated
2361 len size of output buffer
2365 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2368 const uschar * keyptr;
2370 unsigned int keylen;
2372 #define MD5_HASHLEN 16
2373 #define MD5_HASHBLOCKLEN 64
2375 uschar keyhash[MD5_HASHLEN];
2376 uschar innerhash[MD5_HASHLEN];
2377 uschar finalhash[MD5_HASHLEN];
2378 uschar innerkey[MD5_HASHBLOCKLEN];
2379 uschar outerkey[MD5_HASHBLOCKLEN];
2382 keylen = Ustrlen(keyptr);
2384 /* If the key is longer than the hash block length, then hash the key
2387 if (keylen > MD5_HASHBLOCKLEN)
2389 chash_start(HMAC_MD5, &md5_base);
2390 chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2392 keylen = MD5_HASHLEN;
2395 /* Now make the inner and outer key values */
2397 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2398 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2400 for (int i = 0; i < keylen; i++)
2402 innerkey[i] ^= keyptr[i];
2403 outerkey[i] ^= keyptr[i];
2406 /* Now do the hashes */
2408 chash_start(HMAC_MD5, &md5_base);
2409 chash_mid(HMAC_MD5, &md5_base, innerkey);
2410 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2412 chash_start(HMAC_MD5, &md5_base);
2413 chash_mid(HMAC_MD5, &md5_base, outerkey);
2414 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2416 /* Encode the final hash as a hex string, limited by output buffer size */
2419 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2421 if (j-- <= 0) break;
2422 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2423 if (j-- <= 0) break;
2424 *p++ = hex_digits[finalhash[i] & 0x0f];
2430 /*************************************************
2431 * Read and evaluate a condition *
2432 *************************************************/
2436 s points to the start of the condition text
2437 resetok points to a BOOL which is written false if it is unsafe to
2438 free memory. Certain condition types (acl) may have side-effect
2439 allocation which must be preserved.
2440 yield points to a BOOL to hold the result of the condition test;
2441 if NULL, we are just reading through a condition that is
2442 part of an "or" combination to check syntax, or in a state
2443 where the answer isn't required
2445 Returns: a pointer to the first character after the condition, or
2449 static const uschar *
2450 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2452 BOOL testfor = TRUE;
2453 BOOL tempcond, combined_cond;
2455 BOOL sub2_honour_dollar = TRUE;
2456 BOOL is_forany, is_json, is_jsons;
2457 int rc, cond_type, roffset;
2458 int_eximarith_t num[2];
2459 struct stat statbuf;
2462 const uschar *sub[10];
2465 const uschar *rerror;
2469 while (isspace(*s)) s++;
2470 if (*s == '!') { testfor = !testfor; s++; } else break;
2473 switch(cond_type = identify_operator(&s, &opname))
2475 /* def: tests for a non-empty variable, or for the existence of a header. If
2476 yield == NULL we are in a skipping state, and don't care about the answer. */
2484 expand_string_message = US"\":\" expected after \"def\"";
2488 s = read_name(name, sizeof(name), s+1, US"_");
2490 /* Test for a header's existence. If the name contains a closing brace
2491 character, this may be a user error where the terminating colon has been
2492 omitted. Set a flag to adjust a subsequent error message in this case. */
2494 if ( ( *(t = name) == 'h'
2495 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2497 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2500 s = read_header_name(name, sizeof(name), s);
2501 /* {-for-text-editors */
2502 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2504 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2507 /* Test for a variable's having a non-empty value. A non-existent variable
2508 causes an expansion failure. */
2512 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2514 expand_string_message = name[0]
2515 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2516 : US"variable name omitted after \"def:\"";
2517 check_variable_error_message(name);
2520 if (yield) *yield = (t[0] != 0) == testfor;
2527 /* first_delivery tests for first delivery attempt */
2529 case ECOND_FIRST_DELIVERY:
2530 if (yield) *yield = f.deliver_firsttime == testfor;
2534 /* queue_running tests for any process started by a queue runner */
2536 case ECOND_QUEUE_RUNNING:
2537 if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2541 /* exists: tests for file existence
2542 isip: tests for any IP address
2543 isip4: tests for an IPv4 address
2544 isip6: tests for an IPv6 address
2545 pam: does PAM authentication
2546 radius: does RADIUS authentication
2547 ldapauth: does LDAP authentication
2548 pwcheck: does Cyrus SASL pwcheck authentication
2557 case ECOND_LDAPAUTH:
2560 while (isspace(*s)) s++;
2561 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2563 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2564 if (!sub[0]) return NULL;
2565 /* {-for-text-editors */
2566 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2568 if (!yield) return s; /* No need to run the test if skipping */
2573 if ((expand_forbid & RDO_EXISTS) != 0)
2575 expand_string_message = US"File existence tests are not permitted";
2578 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2584 rc = string_is_ip_address(sub[0], NULL);
2585 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2586 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2589 /* Various authentication tests - all optionally compiled */
2593 rc = auth_call_pam(sub[0], &expand_string_message);
2596 goto COND_FAILED_NOT_COMPILED;
2597 #endif /* SUPPORT_PAM */
2600 #ifdef RADIUS_CONFIG_FILE
2601 rc = auth_call_radius(sub[0], &expand_string_message);
2604 goto COND_FAILED_NOT_COMPILED;
2605 #endif /* RADIUS_CONFIG_FILE */
2607 case ECOND_LDAPAUTH:
2610 /* Just to keep the interface the same */
2612 int old_pool = store_pool;
2613 store_pool = POOL_SEARCH;
2614 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2615 &expand_string_message, &do_cache);
2616 store_pool = old_pool;
2620 goto COND_FAILED_NOT_COMPILED;
2621 #endif /* LOOKUP_LDAP */
2624 #ifdef CYRUS_PWCHECK_SOCKET
2625 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2628 goto COND_FAILED_NOT_COMPILED;
2629 #endif /* CYRUS_PWCHECK_SOCKET */
2631 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2632 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2634 if (rc == ERROR || rc == DEFER) return NULL;
2635 *yield = (rc == OK) == testfor;
2641 /* call ACL (in a conditional context). Accept true, deny false.
2642 Defer is a forced-fail. Anything set by message= goes to $value.
2643 Up to ten parameters are used; we use the braces round the name+args
2644 like the saslauthd condition does, to permit a variable number of args.
2645 See also the expansion-item version EITEM_ACL and the traditional
2646 acl modifier ACLC_ACL.
2647 Since the ACL may allocate new global variables, tell our caller to not
2652 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2658 while (isspace(*s)) s++;
2659 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2661 switch(read_subs(sub, nelem(sub), 1,
2662 &s, yield == NULL, TRUE, US"acl", resetok))
2664 case 1: expand_string_message = US"too few arguments or bracketing "
2667 case 3: return NULL;
2673 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2674 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2679 lookup_value = NULL;
2681 lookup_value = string_copy(user_msg);
2682 *yield = cond == testfor;
2686 f.expand_string_forcedfail = TRUE;
2689 expand_string_message = string_sprintf("%s from acl \"%s\"",
2690 rc_names[rc], sub[0]);
2698 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2700 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2702 However, the last two are optional. That is why the whole set is enclosed
2703 in their own set of braces. */
2705 case ECOND_SASLAUTHD:
2706 #ifndef CYRUS_SASLAUTHD_SOCKET
2707 goto COND_FAILED_NOT_COMPILED;
2711 while (isspace(*s)) s++;
2712 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2713 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2716 case 1: expand_string_message = US"too few arguments or bracketing "
2717 "error for saslauthd";
2719 case 3: return NULL;
2721 if (!sub[2]) sub[3] = NULL; /* realm if no service */
2724 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2725 &expand_string_message);
2726 if (rc == ERROR || rc == DEFER) return NULL;
2727 *yield = (rc == OK) == testfor;
2731 #endif /* CYRUS_SASLAUTHD_SOCKET */
2734 /* symbolic operators for numeric and string comparison, and a number of
2735 other operators, all requiring two arguments.
2737 crypteq: encrypts plaintext and compares against an encrypted text,
2738 using crypt(), crypt16(), MD5 or SHA-1
2739 inlist/inlisti: checks if first argument is in the list of the second
2740 match: does a regular expression match and sets up the numerical
2741 variables if it succeeds
2742 match_address: matches in an address list
2743 match_domain: matches in a domain list
2744 match_ip: matches a host list that is restricted to IP addresses
2745 match_local_part: matches in a local part list
2748 case ECOND_MATCH_ADDRESS:
2749 case ECOND_MATCH_DOMAIN:
2750 case ECOND_MATCH_IP:
2751 case ECOND_MATCH_LOCAL_PART:
2752 #ifndef EXPAND_LISTMATCH_RHS
2753 sub2_honour_dollar = FALSE;
2762 case ECOND_NUM_L: /* Numerical comparisons */
2769 case ECOND_STR_LT: /* String comparisons */
2780 for (int i = 0; i < 2; i++)
2782 /* Sometimes, we don't expand substrings; too many insecure configurations
2783 created using match_address{}{} and friends, where the second param
2784 includes information from untrustworthy sources. */
2785 BOOL honour_dollar = TRUE;
2786 if ((i > 0) && !sub2_honour_dollar)
2787 honour_dollar = FALSE;
2789 while (isspace(*s)) s++;
2792 if (i == 0) goto COND_FAILED_CURLY_START;
2793 expand_string_message = string_sprintf("missing 2nd string in {} "
2794 "after \"%s\"", opname);
2797 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2798 honour_dollar, resetok)))
2800 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2801 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2802 " for security reasons\n");
2803 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2805 /* Convert to numerical if required; we know that the names of all the
2806 conditions that compare numbers do not start with a letter. This just saves
2807 checking for them individually. */
2809 if (!isalpha(opname[0]) && yield)
2814 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2818 num[i] = expanded_string_integer(sub[i], FALSE);
2819 if (expand_string_message) return NULL;
2823 /* Result not required */
2825 if (!yield) return s;
2827 /* Do an appropriate comparison */
2833 tempcond = (num[0] == num[1]);
2837 tempcond = (num[0] > num[1]);
2841 tempcond = (num[0] >= num[1]);
2845 tempcond = (num[0] < num[1]);
2849 tempcond = (num[0] <= num[1]);
2853 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2857 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2861 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2865 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2869 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2873 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2877 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2881 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2885 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2889 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2892 case ECOND_MATCH: /* Regular expression match */
2893 if (!(re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror,
2896 expand_string_message = string_sprintf("regular expression error in "
2897 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2900 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2903 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2904 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2905 goto MATCHED_SOMETHING;
2907 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2908 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2909 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2910 goto MATCHED_SOMETHING;
2912 case ECOND_MATCH_IP: /* Match IP address in a host list */
2913 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2915 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2921 unsigned int *nullcache = NULL;
2922 check_host_block cb;
2924 cb.host_name = US"";
2925 cb.host_address = sub[0];
2927 /* If the host address starts off ::ffff: it is an IPv6 address in
2928 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2931 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2932 cb.host_address + 7 : cb.host_address;
2934 rc = match_check_list(
2935 &sub[1], /* the list */
2936 0, /* separator character */
2937 &hostlist_anchor, /* anchor pointer */
2938 &nullcache, /* cache pointer */
2939 check_host, /* function for testing */
2940 &cb, /* argument for function */
2941 MCL_HOST, /* type of check */
2942 sub[0], /* text for debugging */
2943 NULL); /* where to pass back data */
2945 goto MATCHED_SOMETHING;
2947 case ECOND_MATCH_LOCAL_PART:
2948 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2949 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2964 expand_string_message = string_sprintf("unable to complete match "
2965 "against \"%s\": %s", sub[1], search_error_message);
2971 /* Various "encrypted" comparisons. If the second string starts with
2972 "{" then an encryption type is given. Default to crypt() or crypt16()
2973 (build-time choice). */
2974 /* }-for-text-editors */
2977 #ifndef SUPPORT_CRYPTEQ
2978 goto COND_FAILED_NOT_COMPILED;
2980 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2982 int sublen = Ustrlen(sub[1]+5);
2987 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2989 /* If the length that we are comparing against is 24, the MD5 digest
2990 is expressed as a base64 string. This is the way LDAP does it. However,
2991 some other software uses a straightforward hex representation. We assume
2992 this if the length is 32. Other lengths fail. */
2996 uschar *coded = b64encode(CUS digest, 16);
2997 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2998 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2999 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3001 else if (sublen == 32)
3004 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3006 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3007 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
3008 tempcond = (strcmpic(coded, sub[1]+5) == 0);
3012 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3013 "fail\n crypted=%s\n", sub[1]+5);
3018 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3020 int sublen = Ustrlen(sub[1]+6);
3025 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3027 /* If the length that we are comparing against is 28, assume the SHA1
3028 digest is expressed as a base64 string. If the length is 40, assume a
3029 straightforward hex representation. Other lengths fail. */
3033 uschar *coded = b64encode(CUS digest, 20);
3034 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3035 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3036 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3038 else if (sublen == 40)
3041 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3043 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3044 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
3045 tempcond = (strcmpic(coded, sub[1]+6) == 0);
3049 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3050 "fail\n crypted=%s\n", sub[1]+6);
3055 else /* {crypt} or {crypt16} and non-{ at start */
3056 /* }-for-text-editors */
3061 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3066 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3071 else if (sub[1][0] == '{') /* }-for-text-editors */
3073 expand_string_message = string_sprintf("unknown encryption mechanism "
3074 "in \"%s\"", sub[1]);
3080 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3081 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
3082 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3086 #define XSTR(s) STR(s)
3087 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3088 " subject=%s\n crypted=%s\n",
3089 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3094 /* If the encrypted string contains fewer than two characters (for the
3095 salt), force failure. Otherwise we get false positives: with an empty
3096 string the yield of crypt() is an empty string! */
3099 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3100 else if (errno == EINVAL)
3104 expand_string_message = string_sprintf("crypt error: %s\n",
3105 US strerror(errno));
3110 #endif /* SUPPORT_CRYPTEQ */
3115 const uschar * list = sub[1];
3117 uschar *save_iterate_item = iterate_item;
3118 int (*compare)(const uschar *, const uschar *);
3120 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);
3123 compare = cond_type == ECOND_INLISTI
3124 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3126 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3128 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3129 if (compare(sub[0], iterate_item) == 0)
3135 iterate_item = save_iterate_item;
3138 } /* Switch for comparison conditions */
3140 *yield = tempcond == testfor;
3141 return s; /* End of comparison conditions */
3144 /* and/or: computes logical and/or of several conditions */
3148 subcondptr = (yield == NULL) ? NULL : &tempcond;
3149 combined_cond = (cond_type == ECOND_AND);
3151 while (isspace(*s)) s++;
3152 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3156 while (isspace(*s)) s++;
3157 /* {-for-text-editors */
3158 if (*s == '}') break;
3159 if (*s != '{') /* }-for-text-editors */
3161 expand_string_message = string_sprintf("each subcondition "
3162 "inside an \"%s{...}\" condition must be in its own {}", opname);
3166 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3168 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3169 expand_string_message, opname);
3172 while (isspace(*s)) s++;
3174 /* {-for-text-editors */
3177 /* {-for-text-editors */
3178 expand_string_message = string_sprintf("missing } at end of condition "
3179 "inside \"%s\" group", opname);
3184 if (cond_type == ECOND_AND)
3186 combined_cond &= tempcond;
3187 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3188 } /* evaluate any more */
3191 combined_cond |= tempcond;
3192 if (combined_cond) subcondptr = NULL; /* once true, don't */
3193 } /* evaluate any more */
3196 if (yield) *yield = (combined_cond == testfor);
3200 /* forall/forany: iterates a condition with different values */
3202 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3203 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3204 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3205 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3206 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3207 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3211 const uschar * list;
3213 uschar *save_iterate_item = iterate_item;
3215 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3217 while (isspace(*s)) s++;
3218 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3219 if (!(sub[0] = expand_string_internal(s, TRUE, &s, yield == NULL, TRUE, resetok)))
3221 /* {-for-text-editors */
3222 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3224 while (isspace(*s)) s++;
3225 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3229 /* Call eval_condition once, with result discarded (as if scanning a
3230 "false" part). This allows us to find the end of the condition, because if
3231 the list it empty, we won't actually evaluate the condition for real. */
3233 if (!(s = eval_condition(sub[1], resetok, NULL)))
3235 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3236 expand_string_message, opname);
3239 while (isspace(*s)) s++;
3241 /* {-for-text-editors */
3244 /* {-for-text-editors */
3245 expand_string_message = string_sprintf("missing } at end of condition "
3246 "inside \"%s\"", opname);
3250 if (yield) *yield = !testfor;
3252 if (is_json) list = dewrap(string_copy(list), US"[]");
3253 while ((iterate_item = is_json
3254 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3257 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3259 expand_string_message =
3260 string_sprintf("%s wrapping string result for extract jsons",
3261 expand_string_message);
3262 iterate_item = save_iterate_item;
3266 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3267 if (!eval_condition(sub[1], resetok, &tempcond))
3269 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3270 expand_string_message, opname);
3271 iterate_item = save_iterate_item;
3274 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3275 tempcond? "true":"false");
3277 if (yield) *yield = (tempcond == testfor);
3278 if (tempcond == is_forany) break;
3281 iterate_item = save_iterate_item;
3286 /* The bool{} expansion condition maps a string to boolean.
3287 The values supported should match those supported by the ACL condition
3288 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3289 of true/false. Note that Router "condition" rules have a different
3290 interpretation, where general data can be used and only a few values
3292 Note that readconf.c boolean matching, for boolean configuration options,
3293 only matches true/yes/false/no.
3294 The bool_lax{} condition matches the Router logic, which is much more
3297 case ECOND_BOOL_LAX:
3303 BOOL boolvalue = FALSE;
3304 while (isspace(*s)) s++;
3305 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3306 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3307 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3309 case 1: expand_string_message = string_sprintf(
3310 "too few arguments or bracketing error for %s",
3314 case 3: return NULL;
3317 while (isspace(*t)) t++;
3321 /* trailing whitespace: seems like a good idea to ignore it too */
3323 while (isspace(*t2)) t2--;
3324 if (t2 != (t + len))
3331 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3332 /* logic for the lax case from expand_check_condition(), which also does
3333 expands, and the logic is both short and stable enough that there should
3334 be no maintenance burden from replicating it. */
3338 ? Ustrspn(t+1, "0123456789") == len-1
3339 : Ustrspn(t, "0123456789") == len)
3341 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3342 /* expand_check_condition only does a literal string "0" check */
3343 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3346 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3348 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3350 else if (cond_type == ECOND_BOOL_LAX)
3354 expand_string_message = string_sprintf("unrecognised boolean "
3358 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3359 boolvalue? "true":"false");
3360 if (yield) *yield = (boolvalue == testfor);
3364 #ifdef EXPERIMENTAL_SRS_NATIVE
3365 case ECOND_INBOUND_SRS:
3366 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */
3373 BOOL boolvalue = FALSE;
3375 switch(read_subs(sub, 2, 2, CUSS &s, yield == NULL, FALSE, US"inbound_srs", resetok))
3377 case 1: expand_string_message = US"too few arguments or bracketing "
3378 "error for inbound_srs";
3380 case 3: return NULL;
3383 /* Match the given local_part against the SRS-encoded pattern */
3385 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]+)=([^=]*)=(.*)$",
3387 if (pcre_exec(re, NULL, CS sub[0], Ustrlen(sub[0]), 0, PCRE_EOPT,
3388 ovec, nelem(ovec)) < 0)
3390 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3394 /* Side-effect: record the decoded recipient */
3396 srs_recipient = string_sprintf("%.*S@%.*S", /* lowercased */
3397 ovec[9]-ovec[8], sub[0] + ovec[8], /* substring 4 */
3398 ovec[7]-ovec[6], sub[0] + ovec[6]); /* substring 3 */
3400 /* If a zero-length secret was given, we're done. Otherwise carry on
3401 and validate the given SRS local_part againt our secret. */
3409 /* check the timestamp */
3412 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3415 gettimeofday(&now, NULL);
3416 now.tv_sec /= 86400; /* days since epoch */
3418 /* Decode substring 2 from base32 to a number */
3420 for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3422 uschar * t = Ustrchr(base32_chars, *ss++);
3423 d = d * 32 + (t - base32_chars);
3426 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */
3428 DEBUG(D_expand) debug_printf("SRS too old\n");
3433 /* check length of substring 1, the offered checksum */
3435 if (ovec[3]-ovec[2] != 4)
3437 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3441 /* Hash the address with our secret, and compare that computed checksum
3442 with the one extracted from the arg */
3444 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3445 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3447 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3453 if (yield) *yield = (boolvalue == testfor);
3456 #endif /*EXPERIMENTAL_SRS_NATIVE*/
3458 /* Unknown condition */
3461 if (!expand_string_message || !*expand_string_message)
3462 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3464 } /* End switch on condition type */
3466 /* Missing braces at start and end of data */
3468 COND_FAILED_CURLY_START:
3469 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3472 COND_FAILED_CURLY_END:
3473 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3477 /* A condition requires code that is not compiled */
3479 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3480 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3481 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3482 COND_FAILED_NOT_COMPILED:
3483 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3492 /*************************************************
3493 * Save numerical variables *
3494 *************************************************/
3496 /* This function is called from items such as "if" that want to preserve and
3497 restore the numbered variables.
3500 save_expand_string points to an array of pointers to set
3501 save_expand_nlength points to an array of ints for the lengths
3503 Returns: the value of expand max to save
3507 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3509 for (int i = 0; i <= expand_nmax; i++)
3511 save_expand_nstring[i] = expand_nstring[i];
3512 save_expand_nlength[i] = expand_nlength[i];
3519 /*************************************************
3520 * Restore numerical variables *
3521 *************************************************/
3523 /* This function restored saved values of numerical strings.
3526 save_expand_nmax the number of strings to restore
3527 save_expand_string points to an array of pointers
3528 save_expand_nlength points to an array of ints
3534 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3535 int *save_expand_nlength)
3537 expand_nmax = save_expand_nmax;
3538 for (int i = 0; i <= expand_nmax; i++)
3540 expand_nstring[i] = save_expand_nstring[i];
3541 expand_nlength[i] = save_expand_nlength[i];
3549 /*************************************************
3550 * Handle yes/no substrings *
3551 *************************************************/
3553 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3554 alternative substrings that depend on whether or not the condition was true,
3555 or the lookup or extraction succeeded. The substrings always have to be
3556 expanded, to check their syntax, but "skipping" is set when the result is not
3557 needed - this avoids unnecessary nested lookups.
3560 skipping TRUE if we were skipping when this item was reached
3561 yes TRUE if the first string is to be used, else use the second
3562 save_lookup a value to put back into lookup_value before the 2nd expansion
3563 sptr points to the input string pointer
3564 yieldptr points to the output growable-string pointer
3565 type "lookup", "if", "extract", "run", "env", "listextract" or
3566 "certextract" for error message
3567 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3570 Returns: 0 OK; lookup_value has been reset to save_lookup
3572 2 expansion failed because of bracketing error
3576 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3577 gstring ** yieldptr, uschar *type, BOOL *resetok)
3580 const uschar *s = *sptr; /* Local value */
3581 uschar *sub1, *sub2;
3582 const uschar * errwhere;
3584 /* If there are no following strings, we substitute the contents of $value for
3585 lookups and for extractions in the success case. For the ${if item, the string
3586 "true" is substituted. In the fail case, nothing is substituted for all three
3589 while (isspace(*s)) s++;
3594 if (yes && !skipping)
3595 *yieldptr = string_catn(*yieldptr, US"true", 4);
3599 if (yes && lookup_value && !skipping)
3600 *yieldptr = string_cat(*yieldptr, lookup_value);
3601 lookup_value = save_lookup;
3607 /* The first following string must be braced. */
3611 errwhere = US"'yes' part did not start with '{'";
3615 /* Expand the first substring. Forced failures are noticed only if we actually
3616 want this string. Set skipping in the call in the fail case (this will always
3617 be the case if we were already skipping). */
3619 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3620 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3621 f.expand_string_forcedfail = FALSE;
3624 errwhere = US"'yes' part did not end with '}'";
3628 /* If we want the first string, add it to the output */
3631 *yieldptr = string_cat(*yieldptr, sub1);
3633 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3634 $value to what it was at the start of the item, so that it has this value
3635 during the second string expansion. For the call from "if" or "run" to this
3636 function, save_lookup is set to lookup_value, so that this statement does
3639 lookup_value = save_lookup;
3641 /* There now follows either another substring, or "fail", or nothing. This
3642 time, forced failures are noticed only if we want the second string. We must
3643 set skipping in the nested call if we don't want this string, or if we were
3644 already skipping. */
3646 while (isspace(*s)) s++;
3649 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3650 if (sub2 == NULL && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3651 f.expand_string_forcedfail = FALSE;
3654 errwhere = US"'no' part did not start with '{'";
3658 /* If we want the second string, add it to the output */
3661 *yieldptr = string_cat(*yieldptr, sub2);
3664 /* If there is no second string, but the word "fail" is present when the use of
3665 the second string is wanted, set a flag indicating it was a forced failure
3666 rather than a syntactic error. Swallow the terminating } in case this is nested
3667 inside another lookup or if or extract. */
3672 /* deconst cast ok here as source is s anyway */
3673 s = US read_name(name, sizeof(name), s, US"_");
3674 if (Ustrcmp(name, "fail") == 0)
3676 if (!yes && !skipping)
3678 while (isspace(*s)) s++;
3681 errwhere = US"did not close with '}' after forcedfail";
3684 expand_string_message =
3685 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3686 f.expand_string_forcedfail = TRUE;
3692 expand_string_message =
3693 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3698 /* All we have to do now is to check on the final closing brace. */
3700 while (isspace(*s)) s++;
3703 errwhere = US"did not close with '}'";
3709 /* Update the input pointer value before returning */
3714 /* Get here if there is a bracketing failure */
3715 expand_string_message = string_sprintf(
3716 "curly-bracket problem in conditional yes/no parsing: %s\n"
3717 " remaining string is '%s'", errwhere, --s);
3722 /* Get here for other failures */
3730 /********************************************************
3731 * prvs: Get last three digits of days since Jan 1, 1970 *
3732 ********************************************************/
3734 /* This is needed to implement the "prvs" BATV reverse
3737 Argument: integer "days" offset to add or substract to
3738 or from the current number of days.
3740 Returns: pointer to string containing the last three
3741 digits of the number of days since Jan 1, 1970,
3742 modified by the offset argument, NULL if there
3743 was an error in the conversion.
3748 prvs_daystamp(int day_offset)
3750 uschar *days = store_get(32, FALSE); /* Need at least 24 for cases */
3751 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3752 (time(NULL) + day_offset*86400)/86400);
3753 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3758 /********************************************************
3759 * prvs: perform HMAC-SHA1 computation of prvs bits *
3760 ********************************************************/
3762 /* This is needed to implement the "prvs" BATV reverse
3766 address RFC2821 Address to use
3767 key The key to use (must be less than 64 characters
3769 key_num Single-digit key number to use. Defaults to
3772 Returns: pointer to string containing the first three
3773 bytes of the final hash in hex format, NULL if
3774 there was an error in the process.
3778 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3780 gstring * hash_source;
3783 uschar innerhash[20];
3784 uschar finalhash[20];
3785 uschar innerkey[64];
3786 uschar outerkey[64];
3787 uschar *finalhash_hex;
3792 if (Ustrlen(key) > 64)
3795 hash_source = string_catn(NULL, key_num, 1);
3796 hash_source = string_catn(hash_source, daystamp, 3);
3797 hash_source = string_cat(hash_source, address);
3798 (void) string_from_gstring(hash_source);
3801 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3803 memset(innerkey, 0x36, 64);
3804 memset(outerkey, 0x5c, 64);
3806 for (int i = 0; i < Ustrlen(key); i++)
3808 innerkey[i] ^= key[i];
3809 outerkey[i] ^= key[i];
3812 chash_start(HMAC_SHA1, &h);
3813 chash_mid(HMAC_SHA1, &h, innerkey);
3814 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3816 chash_start(HMAC_SHA1, &h);
3817 chash_mid(HMAC_SHA1, &h, outerkey);
3818 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3820 /* Hashing is deemed sufficient to de-taint any input data */
3822 p = finalhash_hex = store_get(40, FALSE);
3823 for (int i = 0; i < 3; i++)
3825 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3826 *p++ = hex_digits[finalhash[i] & 0x0f];
3830 return finalhash_hex;
3836 /*************************************************
3837 * Join a file onto the output string *
3838 *************************************************/
3840 /* This is used for readfile/readsock and after a run expansion.
3841 It joins the contents of a file onto the output string, globally replacing
3842 newlines with a given string (optionally).
3846 yield pointer to the expandable string struct
3847 eol newline replacement string, or NULL
3849 Returns: new pointer for expandable string, terminated if non-null
3853 cat_file(FILE *f, gstring *yield, uschar *eol)
3855 uschar buffer[1024];
3857 while (Ufgets(buffer, sizeof(buffer), f))
3859 int len = Ustrlen(buffer);
3860 if (eol && buffer[len-1] == '\n') len--;
3861 yield = string_catn(yield, buffer, len);
3862 if (eol && buffer[len])
3863 yield = string_cat(yield, eol);
3866 (void) string_from_gstring(yield);
3873 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
3876 uschar buffer[1024];
3878 /*XXX could we read direct into a pre-grown string? */
3880 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
3881 for (uschar * s = buffer; rc--; s++)
3882 yield = eol && *s == '\n'
3883 ? string_cat(yield, eol) : string_catn(yield, s, 1);
3885 /* We assume that all errors, and any returns of zero bytes,
3886 are actually EOF. */
3888 (void) string_from_gstring(yield);
3894 /*************************************************
3895 * Evaluate numeric expression *
3896 *************************************************/
3898 /* This is a set of mutually recursive functions that evaluate an arithmetic
3899 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3900 these functions that is called from elsewhere is eval_expr, whose interface is:
3903 sptr pointer to the pointer to the string - gets updated
3904 decimal TRUE if numbers are to be assumed decimal
3905 error pointer to where to put an error message - must be NULL on input
3906 endket TRUE if ')' must terminate - FALSE for external call
3908 Returns: on success: the value of the expression, with *error still NULL
3909 on failure: an undefined value, with *error = a message
3912 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3915 static int_eximarith_t
3916 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3919 int_eximarith_t x = eval_op_or(&s, decimal, error);
3924 *error = US"expecting closing parenthesis";
3926 while (isspace(*(++s)));
3928 *error = US"expecting operator";
3934 static int_eximarith_t
3935 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3941 while (isspace(*s)) s++;
3942 if (isdigit((c = *s)))
3945 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3947 switch (tolower(*s))
3950 case 'k': n *= 1024; s++; break;
3951 case 'm': n *= 1024*1024; s++; break;
3952 case 'g': n *= 1024*1024*1024; s++; break;
3954 while (isspace (*s)) s++;
3959 n = eval_expr(&s, decimal, error, 1);
3963 *error = US"expecting number or opening parenthesis";
3971 static int_eximarith_t
3972 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3976 while (isspace(*s)) s++;
3977 if (*s == '+' || *s == '-' || *s == '~')
3980 x = eval_op_unary(&s, decimal, error);
3981 if (op == '-') x = -x;
3982 else if (op == '~') x = ~x;
3985 x = eval_number(&s, decimal, error);
3992 static int_eximarith_t
3993 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3996 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3999 while (*s == '*' || *s == '/' || *s == '%')
4002 int_eximarith_t y = eval_op_unary(&s, decimal, error);
4004 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4005 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4006 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
4007 * -N*M is INT_MIN will yield INT_MIN.
4008 * Since we don't support floating point, this is somewhat simpler.
4009 * Ideally, we'd return an error, but since we overflow for all other
4010 * arithmetic, consistency suggests otherwise, but what's the correct value
4011 * to use? There is none.
4012 * The C standard guarantees overflow for unsigned arithmetic but signed
4013 * overflow invokes undefined behaviour; in practice, this is overflow
4014 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
4015 * that long/longlong larger than int are available, or we could just work
4016 * with larger types. We should consider whether to guarantee 32bit eval
4017 * and 64-bit working variables, with errors returned. For now ...
4018 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4019 * can just let the other invalid results occur otherwise, as they have
4020 * until now. For this one case, we can coerce.
4022 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4025 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4026 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4036 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4052 static int_eximarith_t
4053 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4056 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4059 while (*s == '+' || *s == '-')
4062 int_eximarith_t y = eval_op_mult(&s, decimal, error);
4064 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
4065 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4066 { /* over-conservative check */
4068 ? US"overflow in sum" : US"overflow in difference";
4071 if (op == '+') x += y; else x -= y;
4079 static int_eximarith_t
4080 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4083 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4086 while ((*s == '<' || *s == '>') && s[1] == s[0])
4091 y = eval_op_sum(&s, decimal, error);
4093 if (op == '<') x <<= y; else x >>= y;
4101 static int_eximarith_t
4102 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4105 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4112 y = eval_op_shift(&s, decimal, error);
4122 static int_eximarith_t
4123 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4126 int_eximarith_t x = eval_op_and(&s, decimal, error);
4133 y = eval_op_and(&s, decimal, error);
4143 static int_eximarith_t
4144 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4147 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4154 y = eval_op_xor(&s, decimal, error);
4165 /************************************************/
4166 /* Comparison operation for sort expansion. We need to avoid
4167 re-expanding the fields being compared, so need a custom routine.
4170 cond_type Comparison operator code
4171 leftarg, rightarg Arguments for comparison
4173 Return true iff (leftarg compare rightarg)
4177 sortsbefore(int cond_type, BOOL alpha_cond,
4178 const uschar * leftarg, const uschar * rightarg)
4180 int_eximarith_t l_num, r_num;
4184 l_num = expanded_string_integer(leftarg, FALSE);
4185 if (expand_string_message) return FALSE;
4186 r_num = expanded_string_integer(rightarg, FALSE);
4187 if (expand_string_message) return FALSE;
4191 case ECOND_NUM_G: return l_num > r_num;
4192 case ECOND_NUM_GE: return l_num >= r_num;
4193 case ECOND_NUM_L: return l_num < r_num;
4194 case ECOND_NUM_LE: return l_num <= r_num;
4201 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4202 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4203 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4204 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4205 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4206 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4207 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4208 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4211 return FALSE; /* should not happen */
4215 /*************************************************
4217 *************************************************/
4219 /* Returns either an unchanged string, or the expanded string in stacking pool
4220 store. Interpreted sequences are:
4222 \... normal escaping rules
4223 $name substitutes the variable
4225 ${op:string} operates on the expanded string value
4226 ${item{arg1}{arg2}...} expands the args and then does the business
4227 some literal args are not enclosed in {}
4229 There are now far too many operators and item types to make it worth listing
4230 them here in detail any more.
4232 We use an internal routine recursively to handle embedded substrings. The
4233 external function follows. The yield is NULL if the expansion failed, and there
4234 are two cases: if something collapsed syntactically, or if "fail" was given
4235 as the action on a lookup failure. These can be distinguished by looking at the
4236 variable expand_string_forcedfail, which is TRUE in the latter case.
4238 The skipping flag is set true when expanding a substring that isn't actually
4239 going to be used (after "if" or "lookup") and it prevents lookups from
4240 happening lower down.
4242 Store usage: At start, a store block of the length of the input plus 64
4243 is obtained. This is expanded as necessary by string_cat(), which might have to
4244 get a new block, or might be able to expand the original. At the end of the
4245 function we can release any store above that portion of the yield block that
4246 was actually used. In many cases this will be optimal.
4248 However: if the first item in the expansion is a variable name or header name,
4249 we reset the store before processing it; if the result is in fresh store, we
4250 use that without copying. This is helpful for expanding strings like
4251 $message_headers which can get very long.
4253 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4254 since resetting the store at the end of the expansion will free store that was
4255 allocated by the plugin code as well as the slop after the expanded string. So
4256 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4257 and, given the acl condition, ${if }. This is an unfortunate consequence of
4258 string expansion becoming too powerful.
4261 string the string to be expanded
4262 ket_ends true if expansion is to stop at }
4263 left if not NULL, a pointer to the first character after the
4264 expansion is placed here (typically used with ket_ends)
4265 skipping TRUE for recursive calls when the value isn't actually going
4266 to be used (to allow for optimisation)
4267 honour_dollar TRUE if $ is to be expanded,
4268 FALSE if it's just another character
4269 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4272 Returns: NULL if expansion fails:
4273 expand_string_forcedfail is set TRUE if failure was forced
4274 expand_string_message contains a textual error message
4275 a pointer to the expanded string on success
4279 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
4280 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
4282 rmark reset_point = store_mark();
4283 gstring * yield = string_get(Ustrlen(string) + 64);
4285 const uschar *s = string;
4286 uschar *save_expand_nstring[EXPAND_MAXN+1];
4287 int save_expand_nlength[EXPAND_MAXN+1];
4288 BOOL resetok = TRUE;
4293 debug_printf_indent("/%s: %s\n",
4294 skipping ? "---scanning" : "considering", string);
4296 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
4298 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4302 f.expand_string_forcedfail = FALSE;
4303 expand_string_message = US"";
4305 if (is_tainted(string))
4307 expand_string_message =
4308 string_sprintf("attempt to expand tainted string '%s'", s);
4309 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4318 /* \ escapes the next character, which must exist, or else
4319 the expansion fails. There's a special escape, \N, which causes
4320 copying of the subject verbatim up to the next \N. Otherwise,
4321 the escapes are the standard set. */
4327 expand_string_message = US"\\ at end of string";
4333 const uschar * t = s + 2;
4334 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
4335 yield = string_catn(yield, t, s - t);
4336 if (*s != 0) s += 2;
4342 ch[0] = string_interpret_escape(&s);
4344 yield = string_catn(yield, ch, 1);
4351 /* Anything other than $ is just copied verbatim, unless we are
4352 looking for a terminating } character. */
4355 if (ket_ends && *s == '}') break;
4357 if (*s != '$' || !honour_dollar)
4359 yield = string_catn(yield, s++, 1);
4363 /* No { after the $ - must be a plain name or a number for string
4364 match variable. There has to be a fudge for variables that are the
4365 names of header fields preceded by "$header_" because header field
4366 names can contain any printing characters except space and colon.
4367 For those that don't like typing this much, "$h_" is a synonym for
4368 "$header_". A non-existent header yields a NULL value; nothing is
4371 if (isalpha((*(++s))))
4378 s = read_name(name, sizeof(name), s, US"_");
4380 /* If this is the first thing to be expanded, release the pre-allocated
4384 g = store_get(sizeof(gstring), FALSE);
4385 else if (yield->ptr == 0)
4387 if (resetok) reset_point = store_reset(reset_point);
4389 reset_point = store_mark();
4390 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
4395 if ( ( *(t = name) == 'h'
4396 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4398 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4401 unsigned flags = *name == 'r' ? FH_WANT_RAW
4402 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4404 uschar * charset = *name == 'b' ? NULL : headers_charset;
4406 s = read_header_name(name, sizeof(name), s);
4407 value = find_header(name, &newsize, flags, charset);
4409 /* If we didn't find the header, and the header contains a closing brace
4410 character, this may be a user error where the terminating colon
4411 has been omitted. Set a flag to adjust the error message in this case.
4412 But there is no error here - nothing gets inserted. */
4416 if (Ustrchr(name, '}')) malformed_header = TRUE;
4423 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4425 expand_string_message =
4426 string_sprintf("unknown variable name \"%s\"", name);
4427 check_variable_error_message(name);
4431 /* If the data is known to be in a new buffer, newsize will be set to the
4432 size of that buffer. If this is the first thing in an expansion string,
4433 yield will be NULL; just point it at the new store instead of copying. Many
4434 expansion strings contain just one reference, so this is a useful
4435 optimization, especially for humungous headers. We need to use a gstring
4436 structure that is not allocated after that new-buffer, else a later store
4437 reset in the middle of the buffer will make it inaccessible. */
4439 len = Ustrlen(value);
4440 if (!yield && newsize != 0)
4443 yield->size = newsize;
4448 yield = string_catn(yield, value, len);
4456 s = read_cnumber(&n, s);
4457 if (n >= 0 && n <= expand_nmax)
4458 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4462 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4464 if (*s != '{') /*}*/
4466 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4470 /* After { there can be various things, but they all start with
4471 an initial word, except for a number for a string match variable. */
4473 if (isdigit((*(++s))))
4476 s = read_cnumber(&n, s); /*{*/
4479 expand_string_message = US"} expected after number";
4482 if (n >= 0 && n <= expand_nmax)
4483 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4489 expand_string_message = US"letter or digit expected after ${"; /*}*/
4493 /* Allow "-" in names to cater for substrings with negative
4494 arguments. Since we are checking for known names after { this is
4497 s = read_name(name, sizeof(name), s, US"_-");
4498 item_type = chop_match(name, item_table, nelem(item_table));
4502 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4503 If the ACL returns accept or reject we return content set by "message ="
4504 There is currently no limit on recursion; this would have us call
4505 acl_check_internal() directly and get a current level from somewhere.
4506 See also the acl expansion condition ECOND_ACL and the traditional
4507 acl modifier ACLC_ACL.
4508 Assume that the function has side-effects on the store that must be preserved.
4512 /* ${acl {name} {arg1}{arg2}...} */
4514 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4518 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4521 case 1: goto EXPAND_FAILED_CURLY;
4523 case 3: goto EXPAND_FAILED;
4525 if (skipping) continue;
4528 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4533 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4535 yield = string_cat(yield, user_msg);
4539 f.expand_string_forcedfail = TRUE;
4542 expand_string_message = string_sprintf("%s from acl \"%s\"",
4543 rc_names[rc], sub[0]);
4548 case EITEM_AUTHRESULTS:
4549 /* ${authresults {mysystemname}} */
4553 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4556 case 1: goto EXPAND_FAILED_CURLY;
4558 case 3: goto EXPAND_FAILED;
4561 yield = string_append(yield, 3,
4562 US"Authentication-Results: ", sub_arg[0], US"; none");
4565 yield = authres_local(yield, sub_arg[0]);
4566 yield = authres_iprev(yield);
4567 yield = authres_smtpauth(yield);
4569 yield = authres_spf(yield);
4571 #ifndef DISABLE_DKIM
4572 yield = authres_dkim(yield);
4574 #ifdef SUPPORT_DMARC
4575 yield = authres_dmarc(yield);
4577 #ifdef EXPERIMENTAL_ARC
4578 yield = authres_arc(yield);
4583 /* Handle conditionals - preserve the values of the numerical expansion
4584 variables in case they get changed by a regular expression match in the
4585 condition. If not, they retain their external settings. At the end
4586 of this "if" section, they get restored to their previous values. */
4591 const uschar *next_s;
4592 int save_expand_nmax =
4593 save_expand_strings(save_expand_nstring, save_expand_nlength);
4595 while (isspace(*s)) s++;
4596 if (!(next_s = eval_condition(s, &resetok, skipping ? NULL : &cond)))
4597 goto EXPAND_FAILED; /* message already set */
4602 debug_printf_indent("|--condition: %.*s\n", (int)(next_s - s), s);
4603 debug_printf_indent("|-----result: %s\n", cond ? "true" : "false");
4607 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4608 "condition: %.*s\n",
4609 (int)(next_s - s), s);
4610 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4611 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4613 cond ? "true" : "false");
4618 /* The handling of "yes" and "no" result strings is now in a separate
4619 function that is also used by ${lookup} and ${extract} and ${run}. */
4621 switch(process_yesno(
4622 skipping, /* were previously skipping */
4623 cond, /* success/failure indicator */
4624 lookup_value, /* value to reset for string2 */
4625 &s, /* input pointer */
4626 &yield, /* output pointer */
4627 US"if", /* condition type */
4630 case 1: goto EXPAND_FAILED; /* when all is well, the */
4631 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4634 /* Restore external setting of expansion variables for continuation
4637 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4638 save_expand_nlength);
4643 case EITEM_IMAPFOLDER:
4644 { /* ${imapfolder {name}{sep]{specials}} */
4648 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4651 case 1: goto EXPAND_FAILED_CURLY;
4653 case 3: goto EXPAND_FAILED;
4656 if (!sub_arg[1]) /* One argument */
4658 sub_arg[1] = US"/"; /* default separator */
4661 else if (Ustrlen(sub_arg[1]) != 1)
4663 expand_string_message =
4665 "IMAP folder separator must be one character, found \"%s\"",
4672 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4673 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4675 yield = string_cat(yield, encoded);
4681 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4682 expanding an internal string that isn't actually going to be used. All we
4683 need to do is check the syntax, so don't do a lookup at all. Preserve the
4684 values of the numerical expansion variables in case they get changed by a
4685 partial lookup. If not, they retain their external settings. At the end
4686 of this "lookup" section, they get restored to their previous values. */
4690 int stype, partial, affixlen, starflags;
4691 int expand_setup = 0;
4693 uschar *key, *filename;
4694 const uschar *affix;
4695 uschar *save_lookup_value = lookup_value;
4696 int save_expand_nmax =
4697 save_expand_strings(save_expand_nstring, save_expand_nlength);
4699 if ((expand_forbid & RDO_LOOKUP) != 0)
4701 expand_string_message = US"lookup expansions are not permitted";
4705 /* Get the key we are to look up for single-key+file style lookups.
4706 Otherwise set the key NULL pro-tem. */
4708 while (isspace(*s)) s++;
4709 if (*s == '{') /*}*/
4711 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4712 if (!key) goto EXPAND_FAILED; /*{{*/
4715 expand_string_message = US"missing '}' after lookup key";
4716 goto EXPAND_FAILED_CURLY;
4718 while (isspace(*s)) s++;
4722 /* Find out the type of database */
4726 expand_string_message = US"missing lookup type";
4730 /* The type is a string that may contain special characters of various
4731 kinds. Allow everything except space or { to appear; the actual content
4732 is checked by search_findtype_partial. */ /*}*/
4734 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4736 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4740 while (isspace(*s)) s++;
4742 /* Now check for the individual search type and any partial or default
4743 options. Only those types that are actually in the binary are valid. */
4745 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4749 expand_string_message = search_error_message;
4753 /* Check that a key was provided for those lookup types that need it,
4754 and was not supplied for those that use the query style. */
4756 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4760 expand_string_message = string_sprintf("missing {key} for single-"
4761 "key \"%s\" lookup", name);
4769 expand_string_message = string_sprintf("a single key was given for "
4770 "lookup type \"%s\", which is not a single-key lookup type", name);
4775 /* Get the next string in brackets and expand it. It is the file name for
4776 single-key+file lookups, and the whole query otherwise. In the case of
4777 queries that also require a file name (e.g. sqlite), the file name comes
4782 expand_string_message = US"missing '{' for lookup file-or-query arg";
4783 goto EXPAND_FAILED_CURLY;
4785 if (!(filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
4789 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4790 goto EXPAND_FAILED_CURLY;
4792 while (isspace(*s)) s++;
4794 /* If this isn't a single-key+file lookup, re-arrange the variables
4795 to be appropriate for the search_ functions. For query-style lookups,
4796 there is just a "key", and no file name. For the special query-style +
4797 file types, the query (i.e. "key") starts with a file name. */
4801 while (isspace(*filename)) filename++;
4804 if (mac_islookup(stype, lookup_querystyle))
4808 if (*filename != '/')
4810 expand_string_message = string_sprintf(
4811 "absolute file name expected for \"%s\" lookup", name);
4814 while (*key != 0 && !isspace(*key)) key++;
4815 if (*key != 0) *key++ = 0;
4819 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4820 the entry was not found. Note that there is no search_close() function.
4821 Files are left open in case of re-use. At suitable places in higher logic,
4822 search_tidyup() is called to tidy all open files. This can save opening
4823 the same file several times. However, files may also get closed when
4824 others are opened, if too many are open at once. The rule is that a
4825 handle should not be used after a second search_open().
4827 Request that a partial search sets up $1 and maybe $2 by passing
4828 expand_setup containing zero. If its value changes, reset expand_nmax,
4829 since new variables will have been set. Note that at the end of this
4830 "lookup" section, the old numeric variables are restored. */
4833 lookup_value = NULL;
4836 void *handle = search_open(filename, stype, 0, NULL, NULL);
4839 expand_string_message = search_error_message;
4842 lookup_value = search_find(handle, filename, key, partial, affix,
4843 affixlen, starflags, &expand_setup);
4844 if (f.search_find_defer)
4846 expand_string_message =
4847 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4848 string_printing2(key, FALSE), search_error_message);
4851 if (expand_setup > 0) expand_nmax = expand_setup;
4854 /* The handling of "yes" and "no" result strings is now in a separate
4855 function that is also used by ${if} and ${extract}. */
4857 switch(process_yesno(
4858 skipping, /* were previously skipping */
4859 lookup_value != NULL, /* success/failure indicator */
4860 save_lookup_value, /* value to reset for string2 */
4861 &s, /* input pointer */
4862 &yield, /* output pointer */
4863 US"lookup", /* condition type */
4866 case 1: goto EXPAND_FAILED; /* when all is well, the */
4867 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4870 /* Restore external setting of expansion variables for carrying on
4871 at this level, and continue. */
4873 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4874 save_expand_nlength);
4878 /* If Perl support is configured, handle calling embedded perl subroutines,
4879 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4880 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4881 arguments (defined below). */
4883 #define EXIM_PERL_MAX_ARGS 8
4887 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4888 "is not included in this binary";
4891 #else /* EXIM_PERL */
4893 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4896 if ((expand_forbid & RDO_PERL) != 0)
4898 expand_string_message = US"Perl calls are not permitted";
4902 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4903 US"perl", &resetok))
4905 case 1: goto EXPAND_FAILED_CURLY;
4907 case 3: goto EXPAND_FAILED;
4910 /* If skipping, we don't actually do anything */
4912 if (skipping) continue;
4914 /* Start the interpreter if necessary */
4916 if (!opt_perl_started)
4919 if (!opt_perl_startup)
4921 expand_string_message = US"A setting of perl_startup is needed when "
4922 "using the Perl interpreter";
4925 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4926 if ((initerror = init_perl(opt_perl_startup)))
4928 expand_string_message =
4929 string_sprintf("error in perl_startup code: %s\n", initerror);
4932 opt_perl_started = TRUE;
4935 /* Call the function */
4937 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4938 new_yield = call_perl_cat(yield, &expand_string_message,
4939 sub_arg[0], sub_arg + 1);
4941 /* NULL yield indicates failure; if the message pointer has been set to
4942 NULL, the yield was undef, indicating a forced failure. Otherwise the
4943 message will indicate some kind of Perl error. */
4947 if (!expand_string_message)
4949 expand_string_message =
4950 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4951 "failure", sub_arg[0]);
4952 f.expand_string_forcedfail = TRUE;
4957 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4958 set during a callback from Perl. */
4960 f.expand_string_forcedfail = FALSE;
4964 #endif /* EXIM_PERL */
4966 /* Transform email address to "prvs" scheme to use
4967 as BATV-signed return path */
4974 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4976 case 1: goto EXPAND_FAILED_CURLY;
4978 case 3: goto EXPAND_FAILED;
4981 /* If skipping, we don't actually do anything */
4982 if (skipping) continue;
4984 /* sub_arg[0] is the address */
4985 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
4986 || domain == sub_arg[0] || Ustrlen(domain) == 1)
4988 expand_string_message = US"prvs first argument must be a qualified email address";
4992 /* Calculate the hash. The third argument must be a single-digit
4993 key number, or unset. */
4996 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4998 expand_string_message = US"prvs third argument must be a single digit";
5002 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5005 expand_string_message = US"prvs hmac-sha1 conversion failed";
5009 /* Now separate the domain from the local part */
5012 yield = string_catn(yield, US"prvs=", 5);
5013 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5014 yield = string_catn(yield, prvs_daystamp(7), 3);
5015 yield = string_catn(yield, p, 6);
5016 yield = string_catn(yield, US"=", 1);
5017 yield = string_cat (yield, sub_arg[0]);
5018 yield = string_catn(yield, US"@", 1);
5019 yield = string_cat (yield, domain);
5024 /* Check a prvs-encoded address for validity */
5026 case EITEM_PRVSCHECK:
5033 /* TF: Ugliness: We want to expand parameter 1 first, then set
5034 up expansion variables that are used in the expansion of
5035 parameter 2. So we clone the string for the first
5036 expansion, where we only expand parameter 1.
5038 PH: Actually, that isn't necessary. The read_subs() function is
5039 designed to work this way for the ${if and ${lookup expansions. I've
5043 /* Reset expansion variables */
5044 prvscheck_result = NULL;
5045 prvscheck_address = NULL;
5046 prvscheck_keynum = NULL;
5048 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
5050 case 1: goto EXPAND_FAILED_CURLY;
5052 case 3: goto EXPAND_FAILED;
5055 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5058 if (regex_match_and_setup(re,sub_arg[0],0,-1))
5060 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5061 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5062 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5063 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5064 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5066 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
5067 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
5068 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5069 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
5070 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
5072 /* Set up expansion variables */
5073 g = string_cat (NULL, local_part);
5074 g = string_catn(g, US"@", 1);
5075 g = string_cat (g, domain);
5076 prvscheck_address = string_from_gstring(g);
5077 prvscheck_keynum = string_copy(key_num);
5079 /* Now expand the second argument */
5080 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
5082 case 1: goto EXPAND_FAILED_CURLY;
5084 case 3: goto EXPAND_FAILED;
5087 /* Now we have the key and can check the address. */
5089 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5094 expand_string_message = US"hmac-sha1 conversion failed";
5098 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5099 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
5101 if (Ustrcmp(p,hash) == 0)
5103 /* Success, valid BATV address. Now check the expiry date. */
5104 uschar *now = prvs_daystamp(0);
5105 unsigned int inow = 0,iexpire = 1;
5107 (void)sscanf(CS now,"%u",&inow);
5108 (void)sscanf(CS daystamp,"%u",&iexpire);
5110 /* When "iexpire" is < 7, a "flip" has occurred.
5111 Adjust "inow" accordingly. */
5112 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5114 if (iexpire >= inow)
5116 prvscheck_result = US"1";
5117 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
5121 prvscheck_result = NULL;
5122 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
5127 prvscheck_result = NULL;
5128 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
5131 /* Now expand the final argument. We leave this till now so that
5132 it can include $prvscheck_result. */
5134 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
5136 case 1: goto EXPAND_FAILED_CURLY;
5138 case 3: goto EXPAND_FAILED;
5141 yield = string_cat(yield,
5142 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5144 /* Reset the "internal" variables afterwards, because they are in
5145 dynamic store that will be reclaimed if the expansion succeeded. */
5147 prvscheck_address = NULL;
5148 prvscheck_keynum = NULL;
5151 /* Does not look like a prvs encoded address, return the empty string.
5152 We need to make sure all subs are expanded first, so as to skip over
5155 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
5157 case 1: goto EXPAND_FAILED_CURLY;
5159 case 3: goto EXPAND_FAILED;
5165 /* Handle "readfile" to insert an entire file */
5167 case EITEM_READFILE:
5172 if ((expand_forbid & RDO_READFILE) != 0)
5174 expand_string_message = US"file insertions are not permitted";
5178 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
5180 case 1: goto EXPAND_FAILED_CURLY;
5182 case 3: goto EXPAND_FAILED;
5185 /* If skipping, we don't actually do anything */
5187 if (skipping) continue;
5189 /* Open the file and read it */
5191 if (!(f = Ufopen(sub_arg[0], "rb")))
5193 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
5197 yield = cat_file(f, yield, sub_arg[1]);
5202 /* Handle "readsocket" to insert data from a socket, either
5203 Inet or Unix domain */
5205 case EITEM_READSOCK:
5207 client_conn_ctx cctx;
5209 int save_ptr = yield->ptr;
5212 uschar * sub_arg[4];
5213 uschar * server_name = NULL;
5215 BOOL do_shutdown = TRUE;
5216 BOOL do_tls = FALSE; /* Only set under ! DISABLE_TLS */
5219 if (expand_forbid & RDO_READSOCK)
5221 expand_string_message = US"socket insertions are not permitted";
5225 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5226 because there may be a string for expansion on failure. */
5228 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
5230 case 1: goto EXPAND_FAILED_CURLY;
5231 case 2: /* Won't occur: no end check */
5232 case 3: goto EXPAND_FAILED;
5235 /* Grab the request string, if any */
5237 reqstr.data = sub_arg[1];
5238 reqstr.len = Ustrlen(sub_arg[1]);
5240 /* Sort out timeout, if given. The second arg is a list with the first element
5241 being a time value. Any more are options of form "name=value". Currently the
5242 only option recognised is "shutdown". */
5246 const uschar * list = sub_arg[2];
5250 item = string_nextinlist(&list, &sep, NULL, 0);
5251 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
5253 expand_string_message = string_sprintf("bad time value %s", item);
5257 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5258 if (Ustrncmp(item, US"shutdown=", 9) == 0)
5259 { if (Ustrcmp(item + 9, US"no") == 0) do_shutdown = FALSE; }
5261 else if (Ustrncmp(item, US"tls=", 4) == 0)
5262 { if (Ustrcmp(item + 9, US"no") != 0) do_tls = TRUE; }
5266 sub_arg[3] = NULL; /* No eol if no timeout */
5268 /* If skipping, we don't actually do anything. Otherwise, arrange to
5269 connect to either an IP or a Unix socket. */
5273 /* Handle an IP (internet) domain */
5275 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
5280 server_name = sub_arg[0] + 5;
5281 port_name = Ustrrchr(server_name, ':');
5283 /* Sort out the port */
5287 expand_string_message =
5288 string_sprintf("missing port for readsocket %s", sub_arg[0]);
5291 *port_name++ = 0; /* Terminate server name */
5293 if (isdigit(*port_name))
5296 port = Ustrtol(port_name, &end, 0);
5297 if (end != port_name + Ustrlen(port_name))
5299 expand_string_message =
5300 string_sprintf("invalid port number %s", port_name);
5306 struct servent *service_info = getservbyname(CS port_name, "tcp");
5309 expand_string_message = string_sprintf("unknown port \"%s\"",
5313 port = ntohs(service_info->s_port);
5316 /*XXX we trust that the request is idempotent for TFO. Hmm. */
5317 cctx.sock = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
5318 timeout, &host, &expand_string_message,
5319 do_tls ? NULL : &reqstr);
5320 callout_address = NULL;
5327 /* Handle a Unix domain socket */
5331 struct sockaddr_un sockun; /* don't call this "sun" ! */
5334 if ((cctx.sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
5336 expand_string_message = string_sprintf("failed to create socket: %s",
5341 sockun.sun_family = AF_UNIX;
5342 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
5344 server_name = US sockun.sun_path;
5346 sigalrm_seen = FALSE;
5348 rc = connect(cctx.sock, (struct sockaddr *)(&sockun), sizeof(sockun));
5352 expand_string_message = US "socket connect timed out";
5357 expand_string_message = string_sprintf("failed to connect to socket "
5358 "%s: %s", sub_arg[0], strerror(errno));
5361 host.name = server_name;
5362 host.address = US"";
5365 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
5370 smtp_connect_args conn_args = {.host = &host };
5371 tls_support tls_dummy = {.sni=NULL};
5374 if (!tls_client_start(&cctx, &conn_args, NULL, &tls_dummy, &errstr))
5376 expand_string_message = string_sprintf("TLS connect failed: %s", errstr);
5382 /* Allow sequencing of test actions */
5383 testharness_pause_ms(100);
5385 /* Write the request string, if not empty or already done */
5389 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
5393 do_tls ? tls_write(cctx.tls_ctx, reqstr.data, reqstr.len, FALSE) :
5395 write(cctx.sock, reqstr.data, reqstr.len)) != reqstr.len)
5397 expand_string_message = string_sprintf("request write to socket "
5398 "failed: %s", strerror(errno));
5403 /* Shut down the sending side of the socket. This helps some servers to
5404 recognise that it is their turn to do some work. Just in case some
5405 system doesn't have this function, make it conditional. */
5408 if (!do_tls && do_shutdown) shutdown(cctx.sock, SHUT_WR);
5411 testharness_pause_ms(100);
5413 /* Now we need to read from the socket, under a timeout. The function
5414 that reads a file can be used. */
5417 fp = fdopen(cctx.sock, "rb");
5418 sigalrm_seen = FALSE;
5422 do_tls ? cat_file_tls(cctx.tls_ctx, yield, sub_arg[3]) :
5424 cat_file(fp, yield, sub_arg[3]);
5430 tls_close(cctx.tls_ctx, TRUE);
5437 /* After a timeout, we restore the pointer in the result, that is,
5438 make sure we add nothing from the socket. */
5442 yield->ptr = save_ptr;
5443 expand_string_message = US "socket read timed out";
5448 /* The whole thing has worked (or we were skipping). If there is a
5449 failure string following, we need to skip it. */
5453 if (!expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok))
5457 expand_string_message = US"missing '}' closing failstring for readsocket";
5458 goto EXPAND_FAILED_CURLY;
5460 while (isspace(*s)) s++;
5466 expand_string_message = US"missing '}' closing readsocket";
5467 goto EXPAND_FAILED_CURLY;
5471 /* Come here on failure to create socket, connect socket, write to the
5472 socket, or timeout on reading. If another substring follows, expand and
5473 use it. Otherwise, those conditions give expand errors. */
5476 if (*s != '{') goto EXPAND_FAILED;
5477 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5478 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5480 yield = string_cat(yield, arg);
5483 expand_string_message = US"missing '}' closing failstring for readsocket";
5484 goto EXPAND_FAILED_CURLY;
5486 while (isspace(*s)) s++;
5490 /* Handle "run" to execute a program. */
5496 const uschar **argv;
5500 if ((expand_forbid & RDO_RUN) != 0)
5502 expand_string_message = US"running a command is not permitted";
5506 while (isspace(*s)) s++;
5509 expand_string_message = US"missing '{' for command arg of run";
5510 goto EXPAND_FAILED_CURLY;
5512 if (!(arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
5514 while (isspace(*s)) s++;
5517 expand_string_message = US"missing '}' closing command arg of run";
5518 goto EXPAND_FAILED_CURLY;
5521 if (skipping) /* Just pretend it worked when we're skipping */
5524 lookup_value = NULL;
5528 if (!transport_set_up_command(&argv, /* anchor for arg list */
5529 arg, /* raw command */
5530 FALSE, /* don't expand the arguments */
5531 0, /* not relevant when... */
5532 NULL, /* no transporting address */
5533 US"${run} expansion", /* for error messages */
5534 &expand_string_message)) /* where to put error message */
5537 /* Create the child process, making it a group leader. */
5539 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
5541 expand_string_message =
5542 string_sprintf("couldn't create child process: %s", strerror(errno));
5546 /* Nothing is written to the standard input. */
5550 /* Read the pipe to get the command's output into $value (which is kept
5551 in lookup_value). Read during execution, so that if the output exceeds
5552 the OS pipe buffer limit, we don't block forever. Remember to not release
5553 memory just allocated for $value. */
5556 f = fdopen(fd_out, "rb");
5557 sigalrm_seen = FALSE;
5559 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5563 /* Wait for the process to finish, applying the timeout, and inspect its
5564 return code for serious disasters. Simple non-zero returns are passed on.
5567 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5569 if (sigalrm_seen || runrc == -256)
5571 expand_string_message = US"command timed out";
5572 killpg(pid, SIGKILL); /* Kill the whole process group */
5575 else if (runrc == -257)
5576 expand_string_message = string_sprintf("wait() failed: %s",
5580 expand_string_message = string_sprintf("command killed by signal %d",
5587 /* Process the yes/no strings; $value may be useful in both cases */
5589 switch(process_yesno(
5590 skipping, /* were previously skipping */
5591 runrc == 0, /* success/failure indicator */
5592 lookup_value, /* value to reset for string2 */
5593 &s, /* input pointer */
5594 &yield, /* output pointer */
5595 US"run", /* condition type */
5598 case 1: goto EXPAND_FAILED; /* when all is well, the */
5599 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5605 /* Handle character translation for "tr" */
5609 int oldptr = yield->ptr;
5613 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5615 case 1: goto EXPAND_FAILED_CURLY;
5617 case 3: goto EXPAND_FAILED;
5620 yield = string_cat(yield, sub[0]);
5621 o2m = Ustrlen(sub[2]) - 1;
5623 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5625 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5629 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5636 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5637 expanded arguments. */
5646 int val[2] = { 0, -1 };
5649 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5650 Ensure that sub[2] is set in the ${length } case. */
5653 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5654 TRUE, name, &resetok))
5656 case 1: goto EXPAND_FAILED_CURLY;
5658 case 3: goto EXPAND_FAILED;
5661 /* Juggle the arguments if there are only two of them: always move the
5662 string to the last position and make ${length{n}{str}} equivalent to
5663 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5669 if (item_type == EITEM_LENGTH)
5676 for (int i = 0; i < 2; i++) if (sub[i])
5678 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5679 if (*ret != 0 || (i != 0 && val[i] < 0))
5681 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5682 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5688 item_type == EITEM_HASH
5689 ? compute_hash(sub[2], val[0], val[1], &len)
5690 : item_type == EITEM_NHASH
5691 ? compute_nhash(sub[2], val[0], val[1], &len)
5692 : extract_substr(sub[2], val[0], val[1], &len);
5695 yield = string_catn(yield, ret, len);
5699 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5700 This code originally contributed by Steve Haslam. It currently supports
5701 the use of MD5 and SHA-1 hashes.
5703 We need some workspace that is large enough to handle all the supported
5704 hash types. Use macros to set the sizes rather than be too elaborate. */
5706 #define MAX_HASHLEN 20
5707 #define MAX_HASHBLOCKLEN 64
5716 int hashlen; /* Number of octets for the hash algorithm's output */
5717 int hashblocklen; /* Number of octets the hash algorithm processes */
5719 unsigned int keylen;
5721 uschar keyhash[MAX_HASHLEN];
5722 uschar innerhash[MAX_HASHLEN];
5723 uschar finalhash[MAX_HASHLEN];
5724 uschar finalhash_hex[2*MAX_HASHLEN];
5725 uschar innerkey[MAX_HASHBLOCKLEN];
5726 uschar outerkey[MAX_HASHBLOCKLEN];
5728 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5730 case 1: goto EXPAND_FAILED_CURLY;
5732 case 3: goto EXPAND_FAILED;
5737 if (Ustrcmp(sub[0], "md5") == 0)
5740 use_base = &md5_base;
5744 else if (Ustrcmp(sub[0], "sha1") == 0)
5747 use_base = &sha1_ctx;
5753 expand_string_message =
5754 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5759 keylen = Ustrlen(keyptr);
5761 /* If the key is longer than the hash block length, then hash the key
5764 if (keylen > hashblocklen)
5766 chash_start(type, use_base);
5767 chash_end(type, use_base, keyptr, keylen, keyhash);
5772 /* Now make the inner and outer key values */
5774 memset(innerkey, 0x36, hashblocklen);
5775 memset(outerkey, 0x5c, hashblocklen);
5777 for (int i = 0; i < keylen; i++)
5779 innerkey[i] ^= keyptr[i];
5780 outerkey[i] ^= keyptr[i];
5783 /* Now do the hashes */
5785 chash_start(type, use_base);
5786 chash_mid(type, use_base, innerkey);
5787 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5789 chash_start(type, use_base);
5790 chash_mid(type, use_base, outerkey);
5791 chash_end(type, use_base, innerhash, hashlen, finalhash);
5793 /* Encode the final hash as a hex string */
5796 for (int i = 0; i < hashlen; i++)
5798 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5799 *p++ = hex_digits[finalhash[i] & 0x0f];
5802 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5803 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5805 yield = string_catn(yield, finalhash_hex, hashlen*2);
5810 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5811 We have to save the numerical variables and restore them afterwards. */
5816 int moffset, moffsetextra, slen;
5819 const uschar *rerror;
5822 int save_expand_nmax =
5823 save_expand_strings(save_expand_nstring, save_expand_nlength);
5825 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5827 case 1: goto EXPAND_FAILED_CURLY;
5829 case 3: goto EXPAND_FAILED;
5832 /* Compile the regular expression */
5834 if (!(re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror,
5837 expand_string_message = string_sprintf("regular expression error in "
5838 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5842 /* Now run a loop to do the substitutions as often as necessary. It ends
5843 when there are no more matches. Take care over matches of the null string;
5844 do the same thing as Perl does. */
5847 slen = Ustrlen(sub[0]);
5848 moffset = moffsetextra = 0;
5853 int ovector[3*(EXPAND_MAXN+1)];
5854 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5855 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5858 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5859 is not necessarily the end. We want to repeat the match from one
5860 character further along, but leaving the basic offset the same (for
5861 copying below). We can't be at the end of the string - that was checked
5862 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5863 finished; copy the remaining string and end the loop. */
5873 yield = string_catn(yield, subject+moffset, slen-moffset);
5877 /* Match - set up for expanding the replacement. */
5879 if (n == 0) n = EXPAND_MAXN + 1;
5881 for (int nn = 0; nn < n*2; nn += 2)
5883 expand_nstring[expand_nmax] = subject + ovector[nn];
5884 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5888 /* Copy the characters before the match, plus the expanded insertion. */
5890 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
5891 if (!(insert = expand_string(sub[2])))
5893 yield = string_cat(yield, insert);
5895 moffset = ovector[1];
5899 /* If we have matched an empty string, first check to see if we are at
5900 the end of the subject. If so, the loop is over. Otherwise, mimic
5901 what Perl's /g options does. This turns out to be rather cunning. First
5902 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5903 string at the same point. If this fails (picked up above) we advance to
5904 the next character. */
5906 if (ovector[0] == ovector[1])
5908 if (ovector[0] == slen) break;
5909 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5913 /* All done - restore numerical variables. */
5915 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5916 save_expand_nlength);
5920 /* Handle keyed and numbered substring extraction. If the first argument
5921 consists entirely of digits, then a numerical extraction is assumed. */
5925 int field_number = 1;
5926 BOOL field_number_set = FALSE;
5927 uschar *save_lookup_value = lookup_value;
5929 int save_expand_nmax =
5930 save_expand_strings(save_expand_nstring, save_expand_nlength);
5932 /* On reflection the original behaviour of extract-json for a string
5933 result, leaving it quoted, was a mistake. But it was already published,
5934 hence the addition of jsons. In a future major version, make json
5935 work like josons, and withdraw jsons. */
5937 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
5939 while (isspace(*s)) s++;
5941 /* Check for a format-variant specifier */
5943 if (*s != '{') /*}*/
5944 if (Ustrncmp(s, "json", 4) == 0)
5945 if (*(s += 4) == 's')
5946 {fmt = extract_jsons; s++;}
5950 /* While skipping we cannot rely on the data for expansions being
5951 available (eg. $item) hence cannot decide on numeric vs. keyed.
5952 Read a maximum of 5 arguments (including the yes/no) */
5956 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
5958 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5959 goto EXPAND_FAILED; /*'{'*/
5962 expand_string_message = US"missing '{' for arg of extract";
5963 goto EXPAND_FAILED_CURLY;
5965 while (isspace(*s)) s++;
5967 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
5968 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5972 while (isspace(*s)) s++;
5976 expand_string_message = US"missing '}' closing extract";
5977 goto EXPAND_FAILED_CURLY;
5981 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5983 while (isspace(*s)) s++;
5984 if (*s == '{') /*'}'*/
5986 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok)))
5987 goto EXPAND_FAILED; /*'{'*/
5990 expand_string_message = string_sprintf(
5991 "missing '}' closing arg %d of extract", i+1);
5992 goto EXPAND_FAILED_CURLY;
5995 /* After removal of leading and trailing white space, the first
5996 argument must not be empty; if it consists entirely of digits
5997 (optionally preceded by a minus sign), this is a numerical
5998 extraction, and we expect 3 arguments (normal) or 2 (json). */
6006 while (isspace(*p)) p++;
6010 while (len > 0 && isspace(p[len-1])) len--;
6015 expand_string_message = US"first argument of \"extract\" must "
6025 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
6029 if (fmt == extract_basic) j = 3; /* Need 3 args */
6030 field_number_set = TRUE;
6036 expand_string_message = string_sprintf(
6037 "missing '{' for arg %d of extract", i+1);
6038 goto EXPAND_FAILED_CURLY;
6042 /* Extract either the numbered or the keyed substring into $value. If
6043 skipping, just pretend the extraction failed. */
6046 lookup_value = NULL;
6050 lookup_value = field_number_set
6051 ? expand_gettokened(field_number, sub[1], sub[2])
6052 : expand_getkeyed(sub[0], sub[1]);
6059 const uschar * list;
6061 /* Array: Bracket-enclosed and comma-separated.
6062 Object: Brace-enclosed, comma-sep list of name:value pairs */
6064 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6066 expand_string_message =
6067 string_sprintf("%s wrapping %s for extract json",
6068 expand_string_message,
6069 field_number_set ? "array" : "object");
6070 goto EXPAND_FAILED_CURLY;
6074 if (field_number_set)
6076 if (field_number <= 0)
6078 expand_string_message = US"first argument of \"extract\" must "
6079 "be greater than zero";
6082 while (field_number > 0 && (item = json_nextinlist(&list)))
6084 if ((lookup_value = s = item))
6087 while (--s >= lookup_value && isspace(*s)) *s = '\0';
6092 lookup_value = NULL;
6093 while ((item = json_nextinlist(&list)))
6095 /* Item is: string name-sep value. string is quoted.
6096 Dequote the string and compare with the search key. */
6098 if (!(item = dewrap(item, US"\"\"")))
6100 expand_string_message =
6101 string_sprintf("%s wrapping string key for extract json",
6102 expand_string_message);
6103 goto EXPAND_FAILED_CURLY;
6105 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
6107 s = item + Ustrlen(item) + 1;
6108 while (isspace(*s)) s++;
6111 expand_string_message =
6112 US"missing object value-separator for extract json";
6113 goto EXPAND_FAILED_CURLY;
6116 while (isspace(*s)) s++;
6124 if ( fmt == extract_jsons
6126 && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6128 expand_string_message =
6129 string_sprintf("%s wrapping string result for extract jsons",
6130 expand_string_message);
6131 goto EXPAND_FAILED_CURLY;
6136 /* If no string follows, $value gets substituted; otherwise there can
6137 be yes/no strings, as for lookup or if. */
6139 switch(process_yesno(
6140 skipping, /* were previously skipping */
6141 lookup_value != NULL, /* success/failure indicator */
6142 save_lookup_value, /* value to reset for string2 */
6143 &s, /* input pointer */
6144 &yield, /* output pointer */
6145 US"extract", /* condition type */
6148 case 1: goto EXPAND_FAILED; /* when all is well, the */
6149 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6152 /* All done - restore numerical variables. */
6154 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6155 save_expand_nlength);
6160 /* return the Nth item from a list */
6162 case EITEM_LISTEXTRACT:
6164 int field_number = 1;
6165 uschar *save_lookup_value = lookup_value;
6167 int save_expand_nmax =
6168 save_expand_strings(save_expand_nstring, save_expand_nlength);
6170 /* Read the field & list arguments */
6172 for (int i = 0; i < 2; i++)
6174 while (isspace(*s)) s++;
6175 if (*s != '{') /*'}'*/
6177 expand_string_message = string_sprintf(
6178 "missing '{' for arg %d of listextract", i+1);
6179 goto EXPAND_FAILED_CURLY;
6182 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6183 if (!sub[i]) goto EXPAND_FAILED; /*{*/
6186 expand_string_message = string_sprintf(
6187 "missing '}' closing arg %d of listextract", i+1);
6188 goto EXPAND_FAILED_CURLY;
6191 /* After removal of leading and trailing white space, the first
6192 argument must be numeric and nonempty. */
6200 while (isspace(*p)) p++;
6204 while (len > 0 && isspace(p[len-1])) len--;
6207 if (!*p && !skipping)
6209 expand_string_message = US"first argument of \"listextract\" must "
6219 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6222 expand_string_message = US"first argument of \"listextract\" must "
6230 /* Extract the numbered element into $value. If
6231 skipping, just pretend the extraction failed. */
6233 lookup_value = skipping ? NULL : expand_getlistele(field_number, sub[1]);
6235 /* If no string follows, $value gets substituted; otherwise there can
6236 be yes/no strings, as for lookup or if. */
6238 switch(process_yesno(
6239 skipping, /* were previously skipping */
6240 lookup_value != NULL, /* success/failure indicator */
6241 save_lookup_value, /* value to reset for string2 */
6242 &s, /* input pointer */
6243 &yield, /* output pointer */
6244 US"listextract", /* condition type */
6247 case 1: goto EXPAND_FAILED; /* when all is well, the */
6248 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6251 /* All done - restore numerical variables. */
6253 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6254 save_expand_nlength);
6260 case EITEM_CERTEXTRACT:
6262 uschar *save_lookup_value = lookup_value;
6264 int save_expand_nmax =
6265 save_expand_strings(save_expand_nstring, save_expand_nlength);
6267 /* Read the field argument */
6268 while (isspace(*s)) s++;
6269 if (*s != '{') /*}*/
6271 expand_string_message = US"missing '{' for field arg of certextract";
6272 goto EXPAND_FAILED_CURLY;
6274 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6275 if (!sub[0]) goto EXPAND_FAILED; /*{*/
6278 expand_string_message = US"missing '}' closing field arg of certextract";
6279 goto EXPAND_FAILED_CURLY;
6281 /* strip spaces fore & aft */
6286 while (isspace(*p)) p++;
6290 while (len > 0 && isspace(p[len-1])) len--;
6294 /* inspect the cert argument */
6295 while (isspace(*s)) s++;
6296 if (*s != '{') /*}*/
6298 expand_string_message = US"missing '{' for cert variable arg of certextract";
6299 goto EXPAND_FAILED_CURLY;
6303 expand_string_message = US"second argument of \"certextract\" must "
6304 "be a certificate variable";
6307 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
6308 if (!sub[1]) goto EXPAND_FAILED; /*{*/
6311 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6312 goto EXPAND_FAILED_CURLY;
6316 lookup_value = NULL;
6319 lookup_value = expand_getcertele(sub[0], sub[1]);
6320 if (*expand_string_message) goto EXPAND_FAILED;
6322 switch(process_yesno(
6323 skipping, /* were previously skipping */
6324 lookup_value != NULL, /* success/failure indicator */
6325 save_lookup_value, /* value to reset for string2 */
6326 &s, /* input pointer */
6327 &yield, /* output pointer */
6328 US"certextract", /* condition type */
6331 case 1: goto EXPAND_FAILED; /* when all is well, the */
6332 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6335 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6336 save_expand_nlength);
6339 #endif /*DISABLE_TLS*/
6341 /* Handle list operations */
6348 int save_ptr = yield->ptr;
6349 uschar outsep[2] = { '\0', '\0' };
6350 const uschar *list, *expr, *temp;
6351 uschar *save_iterate_item = iterate_item;
6352 uschar *save_lookup_value = lookup_value;
6354 while (isspace(*s)) s++;
6357 expand_string_message =
6358 string_sprintf("missing '{' for first arg of %s", name);
6359 goto EXPAND_FAILED_CURLY;
6362 if (!(list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok)))
6366 expand_string_message =
6367 string_sprintf("missing '}' closing first arg of %s", name);
6368 goto EXPAND_FAILED_CURLY;
6371 if (item_type == EITEM_REDUCE)
6374 while (isspace(*s)) s++;
6377 expand_string_message = US"missing '{' for second arg of reduce";
6378 goto EXPAND_FAILED_CURLY;
6380 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6381 if (!t) goto EXPAND_FAILED;
6385 expand_string_message = US"missing '}' closing second arg of reduce";
6386 goto EXPAND_FAILED_CURLY;
6390 while (isspace(*s)) s++;
6393 expand_string_message =
6394 string_sprintf("missing '{' for last arg of %s", name);
6395 goto EXPAND_FAILED_CURLY;
6400 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6401 if scanning a "false" part). This allows us to find the end of the
6402 condition, because if the list is empty, we won't actually evaluate the
6403 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6404 the normal internal expansion function. */
6406 if (item_type == EITEM_FILTER)
6408 if ((temp = eval_condition(expr, &resetok, NULL)))
6412 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6416 expand_string_message = string_sprintf("%s inside \"%s\" item",
6417 expand_string_message, name);
6421 while (isspace(*s)) s++;
6424 expand_string_message = string_sprintf("missing } at end of condition "
6425 "or expression inside \"%s\"; could be an unquoted } in the content",
6430 while (isspace(*s)) s++; /*{*/
6433 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6438 /* If we are skipping, we can now just move on to the next item. When
6439 processing for real, we perform the iteration. */
6441 if (skipping) continue;
6442 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6444 *outsep = (uschar)sep; /* Separator as a string */
6446 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6447 name, iterate_item, lookup_value);
6449 if (item_type == EITEM_FILTER)
6452 if (!eval_condition(expr, &resetok, &condresult))
6454 iterate_item = save_iterate_item;
6455 lookup_value = save_lookup_value;
6456 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6457 expand_string_message, name);
6460 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6461 condresult? "true":"false");
6463 temp = iterate_item; /* TRUE => include this item */
6465 continue; /* FALSE => skip this item */
6468 /* EITEM_MAP and EITEM_REDUCE */
6472 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
6476 iterate_item = save_iterate_item;
6477 expand_string_message = string_sprintf("%s inside \"%s\" item",
6478 expand_string_message, name);
6481 if (item_type == EITEM_REDUCE)
6483 lookup_value = t; /* Update the value of $value */
6484 continue; /* and continue the iteration */
6488 /* We reach here for FILTER if the condition is true, always for MAP,
6489 and never for REDUCE. The value in "temp" is to be added to the output
6490 list that is being created, ensuring that any occurrences of the
6491 separator character are doubled. Unless we are dealing with the first
6492 item of the output list, add in a space if the new item begins with the
6493 separator character, or is an empty string. */
6495 if (yield->ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
6496 yield = string_catn(yield, US" ", 1);
6498 /* Add the string in "temp" to the output list that we are building,
6499 This is done in chunks by searching for the separator character. */
6503 size_t seglen = Ustrcspn(temp, outsep);
6505 yield = string_catn(yield, temp, seglen + 1);
6507 /* If we got to the end of the string we output one character
6508 too many; backup and end the loop. Otherwise arrange to double the
6511 if (temp[seglen] == '\0') { yield->ptr--; break; }
6512 yield = string_catn(yield, outsep, 1);
6516 /* Output a separator after the string: we will remove the redundant
6517 final one at the end. */
6519 yield = string_catn(yield, outsep, 1);
6520 } /* End of iteration over the list loop */
6522 /* REDUCE has generated no output above: output the final value of
6525 if (item_type == EITEM_REDUCE)
6527 yield = string_cat(yield, lookup_value);
6528 lookup_value = save_lookup_value; /* Restore $value */
6531 /* FILTER and MAP generate lists: if they have generated anything, remove
6532 the redundant final separator. Even though an empty item at the end of a
6533 list does not count, this is tidier. */
6535 else if (yield->ptr != save_ptr) yield->ptr--;
6537 /* Restore preserved $item */
6539 iterate_item = save_iterate_item;
6547 const uschar *srclist, *cmp, *xtract;
6548 uschar * opname, * srcitem;
6549 const uschar *dstlist = NULL, *dstkeylist = NULL;
6551 uschar *save_iterate_item = iterate_item;
6553 while (isspace(*s)) s++;
6556 expand_string_message = US"missing '{' for list arg of sort";
6557 goto EXPAND_FAILED_CURLY;
6560 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6561 if (!srclist) goto EXPAND_FAILED;
6564 expand_string_message = US"missing '}' closing list arg of sort";
6565 goto EXPAND_FAILED_CURLY;
6568 while (isspace(*s)) s++;
6571 expand_string_message = US"missing '{' for comparator arg of sort";
6572 goto EXPAND_FAILED_CURLY;
6575 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6576 if (!cmp) goto EXPAND_FAILED;
6579 expand_string_message = US"missing '}' closing comparator arg of sort";
6580 goto EXPAND_FAILED_CURLY;
6583 if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6585 if (!expand_string_message)
6586 expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6591 case ECOND_NUM_L: case ECOND_NUM_LE:
6592 case ECOND_NUM_G: case ECOND_NUM_GE:
6593 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6594 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6598 expand_string_message = US"comparator not handled for sort";
6602 while (isspace(*s)) s++;
6605 expand_string_message = US"missing '{' for extractor arg of sort";
6606 goto EXPAND_FAILED_CURLY;
6610 if (!(tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok)))
6612 xtract = string_copyn(xtract, s - xtract);
6616 expand_string_message = US"missing '}' closing extractor arg of sort";
6617 goto EXPAND_FAILED_CURLY;
6622 expand_string_message = US"missing } at end of \"sort\"";
6626 if (skipping) continue;
6628 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6630 uschar * srcfield, * dstitem;
6631 gstring * newlist = NULL;
6632 gstring * newkeylist = NULL;
6634 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6636 /* extract field for comparisons */
6637 iterate_item = srcitem;
6638 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6642 expand_string_message = string_sprintf(
6643 "field-extract in sort: \"%s\"", xtract);
6647 /* Insertion sort */
6649 /* copy output list until new-item < list-item */
6650 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6654 /* field for comparison */
6655 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6658 /* String-comparator names start with a letter; numeric names do not */
6660 if (sortsbefore(cond_type, isalpha(opname[0]),
6661 srcfield, dstfield))
6663 /* New-item sorts before this dst-item. Append new-item,
6664 then dst-item, then remainder of dst list. */
6666 newlist = string_append_listele(newlist, sep, srcitem);
6667 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6670 newlist = string_append_listele(newlist, sep, dstitem);
6671 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6673 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */
6674 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6676 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6678 newlist = string_append_listele(newlist, sep, dstitem);
6679 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6685 newlist = string_append_listele(newlist, sep, dstitem);
6686 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6689 /* If we ran out of dstlist without consuming srcitem, append it */
6692 newlist = string_append_listele(newlist, sep, srcitem);
6693 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6696 dstlist = newlist->s;
6697 dstkeylist = newkeylist->s;
6699 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6700 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6704 yield = string_cat(yield, dstlist);
6706 /* Restore preserved $item */
6707 iterate_item = save_iterate_item;
6711 expand_string_message = US"Internal error in sort (list mismatch)";
6716 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6717 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6718 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6719 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6721 #define EXPAND_DLFUNC_MAX_ARGS 8
6724 #ifndef EXPAND_DLFUNC
6725 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6726 "is not included in this binary";
6729 #else /* EXPAND_DLFUNC */
6732 exim_dlfunc_t *func;
6735 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6737 if ((expand_forbid & RDO_DLFUNC) != 0)
6739 expand_string_message =
6740 US"dynamically-loaded functions are not permitted";
6744 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6745 TRUE, US"dlfunc", &resetok))
6747 case 1: goto EXPAND_FAILED_CURLY;
6749 case 3: goto EXPAND_FAILED;
6752 /* If skipping, we don't actually do anything */
6754 if (skipping) continue;
6756 /* Look up the dynamically loaded object handle in the tree. If it isn't
6757 found, dlopen() the file and put the handle in the tree for next time. */
6759 if (!(t = tree_search(dlobj_anchor, argv[0])))
6761 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6764 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6765 argv[0], dlerror());
6766 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6769 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), is_tainted(argv[0]));
6770 Ustrcpy(t->name, argv[0]);
6771 t->data.ptr = handle;
6772 (void)tree_insertnode(&dlobj_anchor, t);
6775 /* Having obtained the dynamically loaded object handle, look up the
6776 function pointer. */
6778 if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6780 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6781 "%s", argv[1], argv[0], dlerror());
6782 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6786 /* Call the function and work out what to do with the result. If it
6787 returns OK, we have a replacement string; if it returns DEFER then
6788 expansion has failed in a non-forced manner; if it returns FAIL then
6789 failure was forced; if it returns ERROR or any other value there's a
6790 problem, so panic slightly. In any case, assume that the function has
6791 side-effects on the store that must be preserved. */
6795 for (argc = 0; argv[argc]; argc++);
6796 status = func(&result, argc - 2, &argv[2]);
6799 if (!result) result = US"";
6800 yield = string_cat(yield, result);
6805 expand_string_message = result ? result : US"(no message)";
6806 if (status == FAIL_FORCED)
6807 f.expand_string_forcedfail = TRUE;
6808 else if (status != FAIL)
6809 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6810 argv[0], argv[1], status, expand_string_message);
6814 #endif /* EXPAND_DLFUNC */
6816 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6819 uschar *save_lookup_value = lookup_value;
6821 while (isspace(*s)) s++;
6822 if (*s != '{') /*}*/
6825 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6826 if (!key) goto EXPAND_FAILED; /*{*/
6829 expand_string_message = US"missing '{' for name arg of env";
6830 goto EXPAND_FAILED_CURLY;
6833 lookup_value = US getenv(CS key);
6835 switch(process_yesno(
6836 skipping, /* were previously skipping */
6837 lookup_value != NULL, /* success/failure indicator */
6838 save_lookup_value, /* value to reset for string2 */
6839 &s, /* input pointer */
6840 &yield, /* output pointer */
6841 US"env", /* condition type */
6844 case 1: goto EXPAND_FAILED; /* when all is well, the */
6845 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6850 #ifdef EXPERIMENTAL_SRS_NATIVE
6851 case EITEM_SRS_ENCODE:
6852 /* ${srs_encode {secret} {return_path} {orig_domain}} */
6857 switch (read_subs(sub, 3, 3, CUSS &s, skipping, TRUE, name, &resetok))
6859 case 1: goto EXPAND_FAILED_CURLY;
6861 case 3: goto EXPAND_FAILED;
6864 yield = string_catn(yield, US"SRS0=", 5);
6866 /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
6867 hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
6868 yield = string_catn(yield, cksum, sizeof(cksum));
6869 yield = string_catn(yield, US"=", 1);
6871 /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
6877 gettimeofday(&now, NULL);
6878 for (unsigned long i = (now.tv_sec / 86400) & 0x3ff; i; i >>= 5)
6879 g = string_catn(g, &base32_chars[i & 0x1f], 1);
6880 if (g) while (g->ptr > 0)
6881 yield = string_catn(yield, &g->s[--g->ptr], 1);
6883 yield = string_catn(yield, US"=", 1);
6885 /* ${domain:$return_path}=${local_part:$return_path} */
6887 int start, end, domain;
6888 uschar * t = parse_extract_address(sub[1], &expand_string_message,
6889 &start, &end, &domain, FALSE);
6893 if (domain > 0) yield = string_cat(yield, t + domain);
6894 yield = string_catn(yield, US"=", 1);
6896 ? string_catn(yield, t, domain - 1) : string_cat(yield, t);
6899 /* @$original_domain */
6900 yield = string_catn(yield, US"@", 1);
6901 yield = string_cat(yield, sub[2]);
6904 #endif /*EXPERIMENTAL_SRS_NATIVE*/
6905 } /* EITEM_* switch */
6907 /* Control reaches here if the name is not recognized as one of the more
6908 complicated expansion items. Check for the "operator" syntax (name terminated
6909 by a colon). Some of the operators have arguments, separated by _ from the
6918 var_entry *vp = NULL;
6921 /* Owing to an historical mis-design, an underscore may be part of the
6922 operator name, or it may introduce arguments. We therefore first scan the
6923 table of names that contain underscores. If there is no match, we cut off
6924 the arguments and then scan the main table. */
6926 if ((c = chop_match(name, op_table_underscore,
6927 nelem(op_table_underscore))) < 0)
6929 if ((arg = Ustrchr(name, '_')))
6931 if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
6932 c += nelem(op_table_underscore);
6933 if (arg) *arg++ = '_'; /* Put back for error messages */
6936 /* Deal specially with operators that might take a certificate variable
6937 as we do not want to do the usual expansion. For most, expand the string.*/
6947 const uschar * s1 = s;
6948 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6950 if (!sub) goto EXPAND_FAILED; /*{*/
6953 expand_string_message =
6954 string_sprintf("missing '}' closing cert arg of %s", name);
6955 goto EXPAND_FAILED_CURLY;
6957 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6967 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6968 if (!sub) goto EXPAND_FAILED;
6973 /* If we are skipping, we don't need to perform the operation at all.
6974 This matters for operations like "mask", because the data may not be
6975 in the correct format when skipping. For example, the expression may test
6976 for the existence of $sender_host_address before trying to mask it. For
6977 other operations, doing them may not fail, but it is a waste of time. */
6979 if (skipping && c >= 0) continue;
6981 /* Otherwise, switch on the operator type */
6988 unsigned long int n = Ustrtoul(sub, &t, 10);
6993 expand_string_message = string_sprintf("argument for base32 "
6994 "operator is \"%s\", which is not a decimal number", sub);
6998 g = string_catn(g, &base32_chars[n & 0x1f], 1);
7000 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7007 unsigned long int n = 0;
7010 uschar * t = Ustrchr(base32_chars, *tt++);
7013 expand_string_message = string_sprintf("argument for base32d "
7014 "operator is \"%s\", which is not a base 32 number", sub);
7017 n = n * 32 + (t - base32_chars);
7019 yield = string_fmt_append(yield, "%ld", n);
7026 unsigned long int n = Ustrtoul(sub, &t, 10);
7029 expand_string_message = string_sprintf("argument for base62 "
7030 "operator is \"%s\", which is not a decimal number", sub);
7033 yield = string_cat(yield, string_base62(n));
7037 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7042 unsigned long int n = 0;
7045 uschar *t = Ustrchr(base62_chars, *tt++);
7048 expand_string_message = string_sprintf("argument for base62d "
7049 "operator is \"%s\", which is not a base %d number", sub,
7053 n = n * BASE_62 + (t - base62_chars);
7055 yield = string_fmt_append(yield, "%ld", n);
7061 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
7064 expand_string_message =
7065 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7066 expand_string_message);
7069 yield = string_cat(yield, expanded);
7076 uschar *t = sub - 1;
7077 while (*(++t) != 0) { *t = tolower(*t); count++; }
7078 yield = string_catn(yield, sub, count);
7085 uschar *t = sub - 1;
7086 while (*(++t) != 0) { *t = toupper(*t); count++; }
7087 yield = string_catn(yield, sub, count);
7093 if (vp && *(void **)vp->value)
7095 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7096 yield = string_cat(yield, cp);
7104 md5_end(&base, sub, Ustrlen(sub), digest);
7105 for (int j = 0; j < 16; j++)
7106 yield = string_fmt_append(yield, "%02x", digest[j]);
7112 if (vp && *(void **)vp->value)
7114 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7115 yield = string_cat(yield, cp);
7123 sha1_end(&h, sub, Ustrlen(sub), digest);
7124 for (int j = 0; j < 20; j++)
7125 yield = string_fmt_append(yield, "%02X", digest[j]);
7131 #ifdef EXIM_HAVE_SHA2
7132 if (vp && *(void **)vp->value)
7133 if (c == EOP_SHA256)
7134 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7136 expand_string_message = US"sha2_N not supported with certificates";
7141 hashmethod m = !arg ? HASH_SHA2_256
7142 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7143 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7144 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7147 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7149 expand_string_message = US"unrecognised sha2 variant";
7153 exim_sha_update(&h, sub, Ustrlen(sub));
7154 exim_sha_finish(&h, &b);
7156 yield = string_fmt_append(yield, "%02X", *b.data++);
7159 expand_string_message = US"sha256 only supported with TLS";
7164 #ifdef EXIM_HAVE_SHA3
7168 hashmethod m = !arg ? HASH_SHA3_256
7169 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7170 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7171 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7172 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7175 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7177 expand_string_message = US"unrecognised sha3 variant";
7181 exim_sha_update(&h, sub, Ustrlen(sub));
7182 exim_sha_finish(&h, &b);
7184 yield = string_fmt_append(yield, "%02X", *b.data++);
7188 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7192 /* Convert hex encoding to base64 encoding */
7202 for (enc = sub; *enc; enc++)
7204 if (!isxdigit(*enc))
7206 expand_string_message = string_sprintf("\"%s\" is not a hex "
7215 expand_string_message = string_sprintf("\"%s\" contains an odd "
7216 "number of characters", sub);
7220 while ((c = *in++) != 0)
7222 if (isdigit(c)) c -= '0';
7223 else c = toupper(c) - 'A' + 10;
7233 enc = b64encode(CUS sub, out - sub);
7234 yield = string_cat(yield, enc);
7238 /* Convert octets outside 0x21..0x7E to \xXX form */
7242 uschar *t = sub - 1;
7245 if (*t < 0x21 || 0x7E < *t)
7246 yield = string_fmt_append(yield, "\\x%02x", *t);
7248 yield = string_catn(yield, t, 1);
7253 /* count the number of list elements */
7261 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer))) cnt++;
7262 yield = string_fmt_append(yield, "%d", cnt);
7266 /* expand a named list given the name */
7267 /* handles nested named lists; requotes as colon-sep list */
7271 tree_node *t = NULL;
7272 const uschar * list;
7275 uschar * suffix = US"";
7276 BOOL needsep = FALSE;
7279 if (*sub == '+') sub++;
7280 if (!arg) /* no-argument version */
7282 if (!(t = tree_search(addresslist_anchor, sub)) &&
7283 !(t = tree_search(domainlist_anchor, sub)) &&
7284 !(t = tree_search(hostlist_anchor, sub)))
7285 t = tree_search(localpartlist_anchor, sub);
7287 else switch(*arg) /* specific list-type version */
7289 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
7290 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
7291 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
7292 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
7294 expand_string_message = US"bad suffix on \"list\" operator";
7300 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
7302 : *arg=='a'?"address "
7303 : *arg=='d'?"domain "
7305 : *arg=='l'?"localpart "
7310 list = ((namedlist_block *)(t->data.ptr))->string;
7312 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
7314 uschar * buf = US" : ";
7316 yield = string_catn(yield, buf, 3);
7320 if (*item == '+') /* list item is itself a named list */
7322 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
7323 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
7325 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
7329 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
7330 while ((cp= strpbrk(CCS item, tok)))
7332 yield = string_catn(yield, item, cp - CS item);
7333 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
7335 yield = string_catn(yield, US"::", 2);
7338 else /* sep in item; should already be doubled; emit once */
7340 yield = string_catn(yield, US tok, 1);
7341 if (*cp == sep) cp++;
7346 yield = string_cat(yield, item);
7351 /* mask applies a mask to an IP address; for example the result of
7352 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7359 int mask, maskoffset;
7360 int type = string_is_ip_address(sub, &maskoffset);
7365 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7370 if (maskoffset == 0)
7372 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7377 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7379 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
7381 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7386 /* Convert the address to binary integer(s) and apply the mask */
7388 sub[maskoffset] = 0;
7389 count = host_aton(sub, binary);
7390 host_mask(count, binary, mask);
7392 /* Convert to masked textual format and add to output. */
7394 yield = string_catn(yield, buffer,
7395 host_nmtoa(count, binary, mask, buffer, '.'));
7400 case EOP_IPV6DENORM:
7402 int type = string_is_ip_address(sub, NULL);
7409 (void) host_aton(sub, binary);
7412 case 4: /* convert to IPv4-mapped IPv6 */
7413 binary[0] = binary[1] = 0;
7414 binary[2] = 0x0000ffff;
7415 (void) host_aton(sub, binary+3);
7419 expand_string_message =
7420 string_sprintf("\"%s\" is not an IP address", sub);
7424 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7425 ? ipv6_nmtoa(binary, buffer)
7426 : host_nmtoa(4, binary, -1, buffer, ':')
7432 case EOP_LOCAL_PART:
7436 int start, end, domain;
7437 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7440 if (c != EOP_DOMAIN)
7441 yield = c == EOP_LOCAL_PART && domain > 0
7442 ? string_catn(yield, t, domain - 1)
7443 : string_cat(yield, t);
7444 else if (domain > 0)
7445 yield = string_cat(yield, t + domain);
7451 uschar outsep[2] = { ':', '\0' };
7452 uschar *address, *error;
7453 int save_ptr = yield->ptr;
7454 int start, end, domain; /* Not really used */
7456 while (isspace(*sub)) sub++;
7458 if (*outsep = *++sub) ++sub;
7461 expand_string_message = string_sprintf("output separator "
7462 "missing in expanding ${addresses:%s}", --sub);
7465 f.parse_allow_group = TRUE;
7469 uschar * p = parse_find_address_end(sub, FALSE);
7470 uschar saveend = *p;
7472 address = parse_extract_address(sub, &error, &start, &end, &domain,
7476 /* Add the address to the output list that we are building. This is
7477 done in chunks by searching for the separator character. At the
7478 start, unless we are dealing with the first address of the output
7479 list, add in a space if the new address begins with the separator
7480 character, or is an empty string. */
7484 if (yield->ptr != save_ptr && address[0] == *outsep)
7485 yield = string_catn(yield, US" ", 1);
7489 size_t seglen = Ustrcspn(address, outsep);
7490 yield = string_catn(yield, address, seglen + 1);
7492 /* If we got to the end of the string we output one character
7495 if (address[seglen] == '\0') { yield->ptr--; break; }
7496 yield = string_catn(yield, outsep, 1);
7497 address += seglen + 1;
7500 /* Output a separator after the string: we will remove the
7501 redundant final one at the end. */
7503 yield = string_catn(yield, outsep, 1);
7506 if (saveend == '\0') break;
7510 /* If we have generated anything, remove the redundant final
7513 if (yield->ptr != save_ptr) yield->ptr--;
7514 f.parse_allow_group = FALSE;
7519 /* quote puts a string in quotes if it is empty or contains anything
7520 other than alphamerics, underscore, dot, or hyphen.
7522 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7523 be quoted in order to be a valid local part.
7525 In both cases, newlines and carriage returns are converted into \n and \r
7529 case EOP_QUOTE_LOCAL_PART:
7532 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
7533 uschar *t = sub - 1;
7537 while (!needs_quote && *(++t) != 0)
7538 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7540 else /* EOP_QUOTE_LOCAL_PART */
7542 while (!needs_quote && *(++t) != 0)
7543 needs_quote = !isalnum(*t) &&
7544 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
7545 (*t != '.' || t == sub || t[1] == 0);
7550 yield = string_catn(yield, US"\"", 1);
7555 yield = string_catn(yield, US"\\n", 2);
7556 else if (*t == '\r')
7557 yield = string_catn(yield, US"\\r", 2);
7560 if (*t == '\\' || *t == '"')
7561 yield = string_catn(yield, US"\\", 1);
7562 yield = string_catn(yield, t, 1);
7565 yield = string_catn(yield, US"\"", 1);
7567 else yield = string_cat(yield, sub);
7571 /* quote_lookuptype does lookup-specific quoting */
7576 uschar *opt = Ustrchr(arg, '_');
7578 if (opt) *opt++ = 0;
7580 if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7582 expand_string_message = search_error_message;
7586 if (lookup_list[n]->quote)
7587 sub = (lookup_list[n]->quote)(sub, opt);
7593 expand_string_message = string_sprintf(
7594 "\"%s\" unrecognized after \"${quote_%s\"",
7599 yield = string_cat(yield, sub);
7603 /* rx quote sticks in \ before any non-alphameric character so that
7604 the insertion works in a regular expression. */
7608 uschar *t = sub - 1;
7612 yield = string_catn(yield, US"\\", 1);
7613 yield = string_catn(yield, t, 1);
7618 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7619 prescribed by the RFC, if there are characters that need to be encoded */
7623 uschar buffer[2048];
7624 yield = string_cat(yield,
7625 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7626 buffer, sizeof(buffer), FALSE));
7630 /* RFC 2047 decode */
7636 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7637 headers_charset, '?', &len, &error);
7640 expand_string_message = error;
7643 yield = string_catn(yield, decoded, len);
7647 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7657 if (c > 255) c = '_';
7659 yield = string_catn(yield, buff, 1);
7664 /* replace illegal UTF-8 sequences by replacement character */
7666 #define UTF8_REPLACEMENT_CHAR US"?"
7670 int seq_len = 0, index = 0;
7672 long codepoint = -1;
7674 uschar seq_buff[4]; /* accumulate utf-8 here */
7683 if ((c & 0xc0) != 0x80)
7684 /* wrong continuation byte; invalidate all bytes */
7685 complete = 1; /* error */
7688 codepoint = (codepoint << 6) | (c & 0x3f);
7689 seq_buff[index++] = c;
7690 if (--bytes_left == 0) /* codepoint complete */
7691 if(codepoint > 0x10FFFF) /* is it too large? */
7692 complete = -1; /* error (RFC3629 limit) */
7694 { /* finished; output utf-8 sequence */
7695 yield = string_catn(yield, seq_buff, seq_len);
7700 else /* no bytes left: new sequence */
7702 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7704 yield = string_catn(yield, &c, 1);
7707 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7709 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7714 codepoint = c & 0x1f;
7717 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7720 codepoint = c & 0x0f;
7722 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7725 codepoint = c & 0x07;
7727 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7730 seq_buff[index++] = c;
7731 seq_len = bytes_left + 1;
7732 } /* if(bytes_left) */
7736 bytes_left = index = 0;
7737 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7739 if ((complete == 1) && ((c & 0x80) == 0))
7740 /* ASCII character follows incomplete sequence */
7741 yield = string_catn(yield, &c, 1);
7743 /* If given a sequence truncated mid-character, we also want to report ?
7744 * Eg, ${length_1:フィル} is one byte, not one character, so we expect
7745 * ${utf8clean:${length_1:フィル}} to yield '?' */
7746 if (bytes_left != 0)
7748 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7754 case EOP_UTF8_DOMAIN_TO_ALABEL:
7756 uschar * error = NULL;
7757 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7760 expand_string_message = string_sprintf(
7761 "error converting utf8 (%s) to alabel: %s",
7762 string_printing(sub), error);
7765 yield = string_cat(yield, s);
7769 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7771 uschar * error = NULL;
7772 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7775 expand_string_message = string_sprintf(
7776 "error converting alabel (%s) to utf8: %s",
7777 string_printing(sub), error);
7780 yield = string_cat(yield, s);
7784 case EOP_UTF8_LOCALPART_TO_ALABEL:
7786 uschar * error = NULL;
7787 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7790 expand_string_message = string_sprintf(
7791 "error converting utf8 (%s) to alabel: %s",
7792 string_printing(sub), error);
7795 yield = string_cat(yield, s);
7796 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7800 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7802 uschar * error = NULL;
7803 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7806 expand_string_message = string_sprintf(
7807 "error converting alabel (%s) to utf8: %s",
7808 string_printing(sub), error);
7811 yield = string_cat(yield, s);
7814 #endif /* EXPERIMENTAL_INTERNATIONAL */
7816 /* escape turns all non-printing characters into escape sequences. */
7820 const uschar * t = string_printing(sub);
7821 yield = string_cat(yield, t);
7825 case EOP_ESCAPE8BIT:
7829 for (const uschar * s = sub; (c = *s); s++)
7830 yield = c < 127 && c != '\\'
7831 ? string_catn(yield, s, 1)
7832 : string_fmt_append(yield, "\\%03o", c);
7836 /* Handle numeric expression evaluation */
7841 uschar *save_sub = sub;
7842 uschar *error = NULL;
7843 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7846 expand_string_message = string_sprintf("error in expression "
7847 "evaluation: %s (after processing \"%.*s\")", error,
7848 (int)(sub-save_sub), save_sub);
7851 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
7855 /* Handle time period formatting */
7859 int n = readconf_readtime(sub, 0, FALSE);
7862 expand_string_message = string_sprintf("string \"%s\" is not an "
7863 "Exim time interval in \"%s\" operator", sub, name);
7866 yield = string_fmt_append(yield, "%d", n);
7870 case EOP_TIME_INTERVAL:
7873 uschar *t = read_number(&n, sub);
7874 if (*t != 0) /* Not A Number*/
7876 expand_string_message = string_sprintf("string \"%s\" is not a "
7877 "positive number in \"%s\" operator", sub, name);
7880 t = readconf_printtime(n);
7881 yield = string_cat(yield, t);
7885 /* Convert string to base64 encoding */
7891 uschar * s = vp && *(void **)vp->value
7892 ? tls_cert_der_b64(*(void **)vp->value)
7893 : b64encode(CUS sub, Ustrlen(sub));
7895 uschar * s = b64encode(CUS sub, Ustrlen(sub));
7897 yield = string_cat(yield, s);
7904 int len = b64decode(sub, &s);
7907 expand_string_message = string_sprintf("string \"%s\" is not "
7908 "well-formed for \"%s\" operator", sub, name);
7911 yield = string_cat(yield, s);
7915 /* strlen returns the length of the string */
7918 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
7921 /* length_n or l_n takes just the first n characters or the whole string,
7922 whichever is the shorter;
7924 substr_m_n, and s_m_n take n characters from offset m; negative m take
7925 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7926 takes the rest, either to the right or to the left.
7928 hash_n or h_n makes a hash of length n from the string, yielding n
7929 characters from the set a-z; hash_n_m makes a hash of length n, but
7930 uses m characters from the set a-zA-Z0-9.
7932 nhash_n returns a single number between 0 and n-1 (in text form), while
7933 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7934 between 0 and n-1 and the second between 0 and m-1. */
7954 expand_string_message = string_sprintf("missing values after %s",
7959 /* "length" has only one argument, effectively being synonymous with
7962 if (c == EOP_LENGTH || c == EOP_L)
7968 /* The others have one or two arguments; for "substr" the first may be
7969 negative. The second being negative means "not supplied". */
7974 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7977 /* Read up to two numbers, separated by underscores */
7982 if (arg != ret && *arg == '_' && pn == &value1)
7986 if (arg[1] != 0) arg++;
7988 else if (!isdigit(*arg))
7990 expand_string_message =
7991 string_sprintf("non-digit after underscore in \"%s\"", name);
7994 else *pn = (*pn)*10 + *arg++ - '0';
7998 /* Perform the required operation */
8000 ret = c == EOP_HASH || c == EOP_H
8001 ? compute_hash(sub, value1, value2, &len)
8002 : c == EOP_NHASH || c == EOP_NH
8003 ? compute_nhash(sub, value1, value2, &len)
8004 : extract_substr(sub, value1, value2, &len);
8005 if (!ret) goto EXPAND_FAILED;
8007 yield = string_catn(yield, ret, len);
8016 uschar **modetable[3];
8020 if (expand_forbid & RDO_EXISTS)
8022 expand_string_message = US"Use of the stat() expansion is not permitted";
8026 if (stat(CS sub, &st) < 0)
8028 expand_string_message = string_sprintf("stat(%s) failed: %s",
8029 sub, strerror(errno));
8033 switch (mode & S_IFMT)
8035 case S_IFIFO: smode[0] = 'p'; break;
8036 case S_IFCHR: smode[0] = 'c'; break;
8037 case S_IFDIR: smode[0] = 'd'; break;
8038 case S_IFBLK: smode[0] = 'b'; break;
8039 case S_IFREG: smode[0] = '-'; break;
8040 default: smode[0] = '?'; break;
8043 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8044 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8045 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8047 for (int i = 0; i < 3; i++)
8049 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8054 yield = string_fmt_append(yield,
8055 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8056 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8057 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8058 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8059 (long)st.st_gid, st.st_size, (long)st.st_atime,
8060 (long)st.st_mtime, (long)st.st_ctime);
8064 /* vaguely random number less than N */
8068 int_eximarith_t max = expanded_string_integer(sub, TRUE);
8070 if (expand_string_message)
8072 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8076 /* Reverse IP, including IPv6 to dotted-nibble */
8078 case EOP_REVERSE_IP:
8080 int family, maskptr;
8081 uschar reversed[128];
8083 family = string_is_ip_address(sub, &maskptr);
8086 expand_string_message = string_sprintf(
8087 "reverse_ip() not given an IP address [%s]", sub);
8090 invert_address(reversed, sub);
8091 yield = string_cat(yield, reversed);
8095 /* Unknown operator */
8098 expand_string_message =
8099 string_sprintf("unknown expansion operator \"%s\"", name);
8104 /* Handle a plain name. If this is the first thing in the expansion, release
8105 the pre-allocated buffer. If the result data is known to be in a new buffer,
8106 newsize will be set to the size of that buffer, and we can just point at that
8107 store instead of copying. Many expansion strings contain just one reference,
8108 so this is a useful optimization, especially for humungous headers
8109 ($message_headers). */
8118 g = store_get(sizeof(gstring), FALSE);
8119 else if (yield->ptr == 0)
8121 if (resetok) reset_point = store_reset(reset_point);
8123 reset_point = store_mark();
8124 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
8126 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
8128 expand_string_message =
8129 string_sprintf("unknown variable in \"${%s}\"", name);
8130 check_variable_error_message(name);
8133 len = Ustrlen(value);
8134 if (!yield && newsize)
8137 yield->size = newsize;
8142 yield = string_catn(yield, value, len);
8146 /* Else there's something wrong */
8148 expand_string_message =
8149 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8150 "in a variable reference)", name);
8154 /* If we hit the end of the string when ket_ends is set, there is a missing
8155 terminating brace. */
8157 if (ket_ends && *s == 0)
8159 expand_string_message = malformed_header
8160 ? US"missing } at end of string - could be header name not terminated by colon"
8161 : US"missing } at end of string";
8165 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8166 added to the string. If so, set up an empty string. Add a terminating zero. If
8167 left != NULL, return a pointer to the terminator. */
8170 yield = string_get(1);
8171 (void) string_from_gstring(yield);
8172 if (left) *left = s;
8174 /* Any stacking store that was used above the final string is no longer needed.
8175 In many cases the final string will be the first one that was got and so there
8176 will be optimal store usage. */
8178 if (resetok) gstring_release_unused(yield);
8179 else if (resetok_p) *resetok_p = FALSE;
8183 BOOL tainted = is_tainted(yield->s);
8186 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8187 debug_printf_indent("%sresult: %s\n",
8188 skipping ? "|-----" : "\\_____", yield->s);
8190 debug_printf_indent("%s \\__(tainted)\n",
8191 skipping ? "| " : " ");
8193 debug_printf_indent("\\___skipping: result is not used\n");
8197 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8198 "expanding: %.*s\n",
8199 (int)(s - string), string);
8200 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8202 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8205 debug_printf_indent("%s(tainted)\n",
8207 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8209 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8210 "skipping: result is not used\n");
8216 /* This is the failure exit: easiest to program with a goto. We still need
8217 to update the pointer to the terminator, for cases of nested calls with "fail".
8220 EXPAND_FAILED_CURLY:
8221 if (malformed_header)
8222 expand_string_message =
8223 US"missing or misplaced { or } - could be header name not terminated by colon";
8225 else if (!expand_string_message || !*expand_string_message)
8226 expand_string_message = US"missing or misplaced { or }";
8228 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8229 that is a bad idea, because expand_string_message is in dynamic store. */
8232 if (left) *left = s;
8236 debug_printf_indent("|failed to expand: %s\n", string);
8237 debug_printf_indent("%serror message: %s\n",
8238 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8239 if (f.expand_string_forcedfail)
8240 debug_printf_indent("\\failure was forced\n");
8244 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8246 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8247 "error message: %s\n",
8248 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8249 expand_string_message);
8250 if (f.expand_string_forcedfail)
8251 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8253 if (resetok_p && !resetok) *resetok_p = FALSE;
8259 /* This is the external function call. Do a quick check for any expansion
8260 metacharacters, and if there are none, just return the input string.
8262 Argument: the string to be expanded
8263 Returns: the expanded string, or NULL if expansion failed; if failure was
8264 due to a lookup deferring, search_find_defer will be TRUE
8268 expand_cstring(const uschar * string)
8270 if (Ustrpbrk(string, "$\\") != NULL)
8272 int old_pool = store_pool;
8275 f.search_find_defer = FALSE;
8276 malformed_header = FALSE;
8277 store_pool = POOL_MAIN;
8278 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
8279 store_pool = old_pool;
8287 expand_string(uschar * string)
8289 return US expand_cstring(CUS string);
8296 /*************************************************
8298 *************************************************/
8300 /* Now and again we want to expand a string and be sure that the result is in a
8301 new bit of store. This function does that.
8302 Since we know it has been copied, the de-const cast is safe.
8304 Argument: the string to be expanded
8305 Returns: the expanded string, always in a new bit of store, or NULL
8309 expand_string_copy(const uschar *string)
8311 const uschar *yield = expand_cstring(string);
8312 if (yield == string) yield = string_copy(string);
8318 /*************************************************
8319 * Expand and interpret as an integer *
8320 *************************************************/
8322 /* Expand a string, and convert the result into an integer.
8325 string the string to be expanded
8326 isplus TRUE if a non-negative number is expected
8328 Returns: the integer value, or
8329 -1 for an expansion error ) in both cases, message in
8330 -2 for an integer interpretation error ) expand_string_message
8331 expand_string_message is set NULL for an OK integer
8335 expand_string_integer(uschar *string, BOOL isplus)
8337 return expanded_string_integer(expand_string(string), isplus);
8341 /*************************************************
8342 * Interpret string as an integer *
8343 *************************************************/
8345 /* Convert a string (that has already been expanded) into an integer.
8347 This function is used inside the expansion code.
8350 s the string to be expanded
8351 isplus TRUE if a non-negative number is expected
8353 Returns: the integer value, or
8354 -1 if string is NULL (which implies an expansion error)
8355 -2 for an integer interpretation error
8356 expand_string_message is set NULL for an OK integer
8359 static int_eximarith_t
8360 expanded_string_integer(const uschar *s, BOOL isplus)
8362 int_eximarith_t value;
8363 uschar *msg = US"invalid integer \"%s\"";
8366 /* If expansion failed, expand_string_message will be set. */
8370 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8371 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8372 systems, so we set it zero ourselves. */
8375 expand_string_message = NULL; /* Indicates no error */
8377 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8378 equal to 0. Unfortunately, people actually relied upon that, so preserve
8379 the behaviour explicitly. Stripping leading whitespace is a harmless
8380 noop change since strtol skips it anyway (provided that there is a number
8384 while (isspace(*s)) ++s;
8388 debug_printf_indent("treating blank string as number 0\n");
8393 value = strtoll(CS s, CSS &endptr, 10);
8397 msg = US"integer expected but \"%s\" found";
8399 else if (value < 0 && isplus)
8401 msg = US"non-negative integer expected but \"%s\" found";
8405 switch (tolower(*endptr))
8410 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8415 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8416 else value *= 1024*1024;
8420 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8421 else value *= 1024*1024*1024;
8425 if (errno == ERANGE)
8426 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8429 while (isspace(*endptr)) endptr++;
8430 if (*endptr == 0) return value;
8434 expand_string_message = string_sprintf(CS msg, s);
8439 /* These values are usually fixed boolean values, but they are permitted to be
8443 addr address being routed
8444 mtype the module type
8445 mname the module name
8446 dbg_opt debug selectors
8447 oname the option name
8448 bvalue the router's boolean value
8449 svalue the router's string value
8450 rvalue where to put the returned value
8452 Returns: OK value placed in rvalue
8453 DEFER expansion failed
8457 exp_bool(address_item *addr,
8458 uschar *mtype, uschar *mname, unsigned dbg_opt,
8459 uschar *oname, BOOL bvalue,
8460 uschar *svalue, BOOL *rvalue)
8463 if (!svalue) { *rvalue = bvalue; return OK; }
8465 if (!(expanded = expand_string(svalue)))
8467 if (f.expand_string_forcedfail)
8469 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8473 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8474 oname, mname, mtype, expand_string_message);
8475 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8479 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8482 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8484 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8488 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8489 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8498 /* Avoid potentially exposing a password in a string about to be logged */
8501 expand_hide_passwords(uschar * s)
8503 return ( ( Ustrstr(s, "failed to expand") != NULL
8504 || Ustrstr(s, "expansion of ") != NULL
8506 && ( Ustrstr(s, "mysql") != NULL
8507 || Ustrstr(s, "pgsql") != NULL
8508 || Ustrstr(s, "redis") != NULL
8509 || Ustrstr(s, "sqlite") != NULL
8510 || Ustrstr(s, "ldap:") != NULL
8511 || Ustrstr(s, "ldaps:") != NULL
8512 || Ustrstr(s, "ldapi:") != NULL
8513 || Ustrstr(s, "ldapdn:") != NULL
8514 || Ustrstr(s, "ldapm:") != NULL
8516 ? US"Temporary internal error" : s;
8520 /* Read given named file into big_buffer. Use for keying material etc.
8521 The content will have an ascii NUL appended.
8526 Return: pointer to buffer, or NULL on error.
8530 expand_file_big_buffer(const uschar * filename)
8532 int fd, off = 0, len;
8534 if ((fd = open(CS filename, O_RDONLY)) < 0)
8536 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8543 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8546 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8554 big_buffer[off] = '\0';
8560 /*************************************************
8561 * Error-checking for testsuite *
8562 *************************************************/
8564 uschar * region_start;
8565 uschar * region_end;
8566 const uschar *var_name;
8567 const uschar *var_data;
8571 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8574 if (var_data >= e->region_start && var_data < e->region_end)
8576 e->var_name = CUS var_name;
8577 e->var_data = CUS var_data;
8582 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8584 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8585 .var_name = NULL, .var_data = NULL };
8587 /* check acl_ variables */
8588 tree_walk(acl_var_c, assert_variable_notin, &e);
8589 tree_walk(acl_var_m, assert_variable_notin, &e);
8591 /* check auth<n> variables */
8592 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8593 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
8595 /* check regex<n> variables */
8596 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8597 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
8599 /* check known-name variables */
8600 for (var_entry * v = var_table; v < var_table + var_table_size; v++)
8601 if (v->type == vtype_stringptr)
8602 assert_variable_notin(US v->name, *(USS v->value), &e);
8604 /* check dns and address trees */
8605 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8606 tree_walk(tree_duplicates, assert_variable_notin, &e);
8607 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8608 tree_walk(tree_unusable, assert_variable_notin, &e);
8611 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8612 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8613 e.var_name, filename, linenumber, e.var_data);
8618 /*************************************************
8619 **************************************************
8620 * Stand-alone test program *
8621 **************************************************
8622 *************************************************/
8628 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
8630 int ovector[3*(EXPAND_MAXN+1)];
8631 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8632 ovector, nelem(ovector));
8633 BOOL yield = n >= 0;
8634 if (n == 0) n = EXPAND_MAXN + 1;
8637 expand_nmax = setup < 0 ? 0 : setup + 1;
8638 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8640 expand_nstring[expand_nmax] = subject + ovector[nn];
8641 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8649 int main(int argc, uschar **argv)
8651 uschar buffer[1024];
8653 debug_selector = D_v;
8654 debug_file = stderr;
8655 debug_fd = fileno(debug_file);
8656 big_buffer = malloc(big_buffer_size);
8658 for (int i = 1; i < argc; i++)
8660 if (argv[i][0] == '+')
8662 debug_trace_memory = 2;
8665 if (isdigit(argv[i][0]))
8666 debug_selector = Ustrtol(argv[i], NULL, 0);
8668 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8672 eldap_default_servers = argv[i];
8675 mysql_servers = argv[i];
8678 pgsql_servers = argv[i];
8681 redis_servers = argv[i];
8685 else opt_perl_startup = argv[i];
8689 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8691 expand_nstring[1] = US"string 1....";
8692 expand_nlength[1] = 8;
8696 if (opt_perl_startup != NULL)
8699 printf("Starting Perl interpreter\n");
8700 errstr = init_perl(opt_perl_startup);
8703 printf("** error in perl_startup code: %s\n", errstr);
8704 return EXIT_FAILURE;
8707 #endif /* EXIM_PERL */
8709 /* Thie deliberately regards the input as untainted, so that it can be
8710 expanded; only reasonable since this is a test for string-expansions. */
8712 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8714 rmark reset_point = store_mark();
8715 uschar *yield = expand_string(buffer);
8717 printf("%s\n", yield);
8720 if (f.search_find_defer) printf("search_find deferred\n");
8721 printf("Failed: %s\n", expand_string_message);
8722 if (f.expand_string_forcedfail) printf("Forced failure\n");
8725 store_reset(reset_point);
8737 /* End of expand.c */