1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *);
17 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
20 # ifndef SUPPORT_CRYPTEQ
21 # define SUPPORT_CRYPTEQ
26 # include "lookups/ldap.h"
29 #ifdef SUPPORT_CRYPTEQ
34 extern char* crypt16(char*, char*);
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. Characters after the first 16 are ignored. It always generates
50 a 16-byte hash, which is expressed together with the salt as a string
51 of 24 base 64 digits. Here are some links to peruse:
53 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
54 http://seclists.org/bugtraq/1999/Mar/0076.html
56 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
57 and OSF/1. This is the same as the standard crypt if given a password
58 of 8 characters or less. If given more, it first does the same as crypt
59 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
60 using as salt the first two base 64 digits from the first hash block.
61 If the password is more than 16 characters then it crypts the 17th to 24th
62 characters using as salt the first two base 64 digits from the second hash
63 block. And so on: I've seen references to it cutting off the password at
64 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
66 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
67 http://seclists.org/bugtraq/1999/Mar/0109.html
68 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
69 TET1_html/sec.c222.html#no_id_208
71 Exim has something it calls "crypt16". It will either use a native
72 crypt16 or its own implementation. A native crypt16 will presumably
73 be the one that I called "crypt16" above. The internal "crypt16"
74 function, however, is a two-block-maximum implementation of what I called
75 "bigcrypt". The documentation matches the internal code.
77 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
78 that crypt16 and bigcrypt were different things.
80 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
81 to whatever it is using under that name. This unfortunately sets a
82 precedent for using "{crypt16}" to identify two incompatible algorithms
83 whose output can't be distinguished. With "{crypt16}" thus rendered
84 ambiguous, I suggest you deprecate it and invent two new identifiers
85 for the two algorithms.
87 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
88 of the password separately means they can be cracked separately, so
89 the double-length hash only doubles the cracking effort instead of
90 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
166 /* Tables of operator names, and corresponding switch numbers. The names must be
167 in alphabetical order. There are two tables, because underscore is used in some
168 cases to introduce arguments, whereas for other it is part of the name. This is
169 an historical mis-design. */
171 static uschar *op_table_underscore[] = {
174 US"quote_local_part",
179 ,US"utf8_domain_from_alabel",
180 US"utf8_domain_to_alabel",
181 US"utf8_localpart_from_alabel",
182 US"utf8_localpart_to_alabel"
189 EOP_QUOTE_LOCAL_PART,
194 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
195 EOP_UTF8_DOMAIN_TO_ALABEL,
196 EOP_UTF8_LOCALPART_FROM_ALABEL,
197 EOP_UTF8_LOCALPART_TO_ALABEL
201 static uschar *op_table_main[] = {
249 EOP_ADDRESS = nelem(op_table_underscore),
296 /* Table of condition names, and corresponding switch numbers. The names must
297 be in alphabetical order. */
299 static uschar *cond_table[] = {
303 US"==", /* Backward compatibility */
340 US"match_local_part",
365 ECOND_FIRST_DELIVERY,
390 ECOND_MATCH_LOCAL_PART,
400 /* Types of table entry */
403 vtype_int, /* value is address of int */
404 vtype_filter_int, /* ditto, but recognized only when filtering */
405 vtype_ino, /* value is address of ino_t (not always an int) */
406 vtype_uid, /* value is address of uid_t (not always an int) */
407 vtype_gid, /* value is address of gid_t (not always an int) */
408 vtype_bool, /* value is address of bool */
409 vtype_stringptr, /* value is address of pointer to string */
410 vtype_msgbody, /* as stringptr, but read when first required */
411 vtype_msgbody_end, /* ditto, the end of the message */
412 vtype_msgheaders, /* the message's headers, processed */
413 vtype_msgheaders_raw, /* the message's headers, unprocessed */
414 vtype_localpart, /* extract local part from string */
415 vtype_domain, /* extract domain from string */
416 vtype_string_func, /* value is string returned by given function */
417 vtype_todbsdin, /* value not used; generate BSD inbox tod */
418 vtype_tode, /* value not used; generate tod in epoch format */
419 vtype_todel, /* value not used; generate tod in epoch/usec format */
420 vtype_todf, /* value not used; generate full tod */
421 vtype_todl, /* value not used; generate log tod */
422 vtype_todlf, /* value not used; generate log file datestamp tod */
423 vtype_todzone, /* value not used; generate time zone only */
424 vtype_todzulu, /* value not used; generate zulu tod */
425 vtype_reply, /* value not used; get reply from headers */
426 vtype_pid, /* value not used; result is pid */
427 vtype_host_lookup, /* value not used; get host name */
428 vtype_load_avg, /* value not used; result is int from os_getloadavg */
429 vtype_pspace, /* partition space; value is T/F for spool/log */
430 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
431 vtype_cert /* SSL certificate */
433 ,vtype_dkim /* Lookup of value in DKIM signature */
437 /* Type for main variable table */
445 /* Type for entries pointing to address/length pairs. Not currently
453 static uschar * fn_recipients(void);
454 typedef uschar * stringptr_fn_t(void);
456 /* This table must be kept in alphabetical order. */
458 static var_entry var_table[] = {
459 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
460 they will be confused with user-creatable ACL variables. */
461 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
462 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
463 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
464 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
465 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
466 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
467 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
468 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
469 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
470 { "acl_narg", vtype_int, &acl_narg },
471 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
472 { "address_data", vtype_stringptr, &deliver_address_data },
473 { "address_file", vtype_stringptr, &address_file },
474 { "address_pipe", vtype_stringptr, &address_pipe },
475 #ifdef EXPERIMENTAL_ARC
476 { "arc_domains", vtype_string_func, (void *) &fn_arc_domains },
477 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
478 { "arc_state", vtype_stringptr, &arc_state },
479 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
481 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
482 { "authenticated_id", vtype_stringptr, &authenticated_id },
483 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
484 { "authentication_failed",vtype_int, &authentication_failed },
485 #ifdef WITH_CONTENT_SCAN
486 { "av_failed", vtype_int, &av_failed },
488 #ifdef EXPERIMENTAL_BRIGHTMAIL
489 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
490 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
491 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
492 { "bmi_deliver", vtype_int, &bmi_deliver },
494 { "body_linecount", vtype_int, &body_linecount },
495 { "body_zerocount", vtype_int, &body_zerocount },
496 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
497 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
498 { "caller_gid", vtype_gid, &real_gid },
499 { "caller_uid", vtype_uid, &real_uid },
500 { "callout_address", vtype_stringptr, &callout_address },
501 { "compile_date", vtype_stringptr, &version_date },
502 { "compile_number", vtype_stringptr, &version_cnumber },
503 { "config_dir", vtype_stringptr, &config_main_directory },
504 { "config_file", vtype_stringptr, &config_main_filename },
505 { "csa_status", vtype_stringptr, &csa_status },
506 #ifdef EXPERIMENTAL_DCC
507 { "dcc_header", vtype_stringptr, &dcc_header },
508 { "dcc_result", vtype_stringptr, &dcc_result },
511 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
512 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
513 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
514 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
515 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
516 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
517 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
518 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
519 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
520 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
521 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
522 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
523 { "dkim_key_length", vtype_int, &dkim_key_length },
524 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
525 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
526 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
527 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
528 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
529 { "dkim_signers", vtype_stringptr, &dkim_signers },
530 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
531 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
534 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
535 { "dmarc_status", vtype_stringptr, &dmarc_status },
536 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
537 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
539 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
540 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
541 { "dnslist_text", vtype_stringptr, &dnslist_text },
542 { "dnslist_value", vtype_stringptr, &dnslist_value },
543 { "domain", vtype_stringptr, &deliver_domain },
544 { "domain_data", vtype_stringptr, &deliver_domain_data },
545 #ifndef DISABLE_EVENT
546 { "event_data", vtype_stringptr, &event_data },
548 /*XXX want to use generic vars for as many of these as possible*/
549 { "event_defer_errno", vtype_int, &event_defer_errno },
551 { "event_name", vtype_stringptr, &event_name },
553 { "exim_gid", vtype_gid, &exim_gid },
554 { "exim_path", vtype_stringptr, &exim_path },
555 { "exim_uid", vtype_uid, &exim_uid },
556 { "exim_version", vtype_stringptr, &version_string },
557 { "headers_added", vtype_string_func, (void *) &fn_hdrs_added },
558 { "home", vtype_stringptr, &deliver_home },
559 { "host", vtype_stringptr, &deliver_host },
560 { "host_address", vtype_stringptr, &deliver_host_address },
561 { "host_data", vtype_stringptr, &host_data },
562 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
563 { "host_lookup_failed", vtype_int, &host_lookup_failed },
564 { "host_port", vtype_int, &deliver_host_port },
565 { "initial_cwd", vtype_stringptr, &initial_cwd },
566 { "inode", vtype_ino, &deliver_inode },
567 { "interface_address", vtype_stringptr, &interface_address },
568 { "interface_port", vtype_int, &interface_port },
569 { "item", vtype_stringptr, &iterate_item },
571 { "ldap_dn", vtype_stringptr, &eldap_dn },
573 { "load_average", vtype_load_avg, NULL },
574 { "local_part", vtype_stringptr, &deliver_localpart },
575 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
576 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
577 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
578 #ifdef HAVE_LOCAL_SCAN
579 { "local_scan_data", vtype_stringptr, &local_scan_data },
581 { "local_user_gid", vtype_gid, &local_user_gid },
582 { "local_user_uid", vtype_uid, &local_user_uid },
583 { "localhost_number", vtype_int, &host_number },
584 { "log_inodes", vtype_pinodes, (void *)FALSE },
585 { "log_space", vtype_pspace, (void *)FALSE },
586 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
587 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
588 #ifdef WITH_CONTENT_SCAN
589 { "malware_name", vtype_stringptr, &malware_name },
591 { "max_received_linelength", vtype_int, &max_received_linelength },
592 { "message_age", vtype_int, &message_age },
593 { "message_body", vtype_msgbody, &message_body },
594 { "message_body_end", vtype_msgbody_end, &message_body_end },
595 { "message_body_size", vtype_int, &message_body_size },
596 { "message_exim_id", vtype_stringptr, &message_id },
597 { "message_headers", vtype_msgheaders, NULL },
598 { "message_headers_raw", vtype_msgheaders_raw, NULL },
599 { "message_id", vtype_stringptr, &message_id },
600 { "message_linecount", vtype_int, &message_linecount },
601 { "message_size", vtype_int, &message_size },
603 { "message_smtputf8", vtype_bool, &message_smtputf8 },
605 #ifdef WITH_CONTENT_SCAN
606 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
607 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
608 { "mime_boundary", vtype_stringptr, &mime_boundary },
609 { "mime_charset", vtype_stringptr, &mime_charset },
610 { "mime_content_description", vtype_stringptr, &mime_content_description },
611 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
612 { "mime_content_id", vtype_stringptr, &mime_content_id },
613 { "mime_content_size", vtype_int, &mime_content_size },
614 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
615 { "mime_content_type", vtype_stringptr, &mime_content_type },
616 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
617 { "mime_filename", vtype_stringptr, &mime_filename },
618 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
619 { "mime_is_multipart", vtype_int, &mime_is_multipart },
620 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
621 { "mime_part_count", vtype_int, &mime_part_count },
623 { "n0", vtype_filter_int, &filter_n[0] },
624 { "n1", vtype_filter_int, &filter_n[1] },
625 { "n2", vtype_filter_int, &filter_n[2] },
626 { "n3", vtype_filter_int, &filter_n[3] },
627 { "n4", vtype_filter_int, &filter_n[4] },
628 { "n5", vtype_filter_int, &filter_n[5] },
629 { "n6", vtype_filter_int, &filter_n[6] },
630 { "n7", vtype_filter_int, &filter_n[7] },
631 { "n8", vtype_filter_int, &filter_n[8] },
632 { "n9", vtype_filter_int, &filter_n[9] },
633 { "original_domain", vtype_stringptr, &deliver_domain_orig },
634 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
635 { "originator_gid", vtype_gid, &originator_gid },
636 { "originator_uid", vtype_uid, &originator_uid },
637 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
638 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
639 { "pid", vtype_pid, NULL },
641 { "prdr_requested", vtype_bool, &prdr_requested },
643 { "primary_hostname", vtype_stringptr, &primary_hostname },
644 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
645 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
646 { "proxy_external_port", vtype_int, &proxy_external_port },
647 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
648 { "proxy_local_port", vtype_int, &proxy_local_port },
649 { "proxy_session", vtype_bool, &proxy_session },
651 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
652 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
653 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
654 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
655 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
656 { "queue_name", vtype_stringptr, &queue_name },
657 { "rcpt_count", vtype_int, &rcpt_count },
658 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
659 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
660 { "received_count", vtype_int, &received_count },
661 { "received_for", vtype_stringptr, &received_for },
662 { "received_ip_address", vtype_stringptr, &interface_address },
663 { "received_port", vtype_int, &interface_port },
664 { "received_protocol", vtype_stringptr, &received_protocol },
665 { "received_time", vtype_int, &received_time.tv_sec },
666 { "recipient_data", vtype_stringptr, &recipient_data },
667 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
668 { "recipients", vtype_string_func, (void *) &fn_recipients },
669 { "recipients_count", vtype_int, &recipients_count },
670 #ifdef WITH_CONTENT_SCAN
671 { "regex_match_string", vtype_stringptr, ®ex_match_string },
673 { "reply_address", vtype_reply, NULL },
674 { "return_path", vtype_stringptr, &return_path },
675 { "return_size_limit", vtype_int, &bounce_return_size_limit },
676 { "router_name", vtype_stringptr, &router_name },
677 { "runrc", vtype_int, &runrc },
678 { "self_hostname", vtype_stringptr, &self_hostname },
679 { "sender_address", vtype_stringptr, &sender_address },
680 { "sender_address_data", vtype_stringptr, &sender_address_data },
681 { "sender_address_domain", vtype_domain, &sender_address },
682 { "sender_address_local_part", vtype_localpart, &sender_address },
683 { "sender_data", vtype_stringptr, &sender_data },
684 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
685 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
686 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
687 { "sender_host_address", vtype_stringptr, &sender_host_address },
688 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
689 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
690 { "sender_host_name", vtype_host_lookup, NULL },
691 { "sender_host_port", vtype_int, &sender_host_port },
692 { "sender_ident", vtype_stringptr, &sender_ident },
693 { "sender_rate", vtype_stringptr, &sender_rate },
694 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
695 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
696 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
697 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
698 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
699 { "sending_port", vtype_int, &sending_port },
700 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
701 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
702 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
703 { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
704 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
705 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
706 { "sn0", vtype_filter_int, &filter_sn[0] },
707 { "sn1", vtype_filter_int, &filter_sn[1] },
708 { "sn2", vtype_filter_int, &filter_sn[2] },
709 { "sn3", vtype_filter_int, &filter_sn[3] },
710 { "sn4", vtype_filter_int, &filter_sn[4] },
711 { "sn5", vtype_filter_int, &filter_sn[5] },
712 { "sn6", vtype_filter_int, &filter_sn[6] },
713 { "sn7", vtype_filter_int, &filter_sn[7] },
714 { "sn8", vtype_filter_int, &filter_sn[8] },
715 { "sn9", vtype_filter_int, &filter_sn[9] },
716 #ifdef WITH_CONTENT_SCAN
717 { "spam_action", vtype_stringptr, &spam_action },
718 { "spam_bar", vtype_stringptr, &spam_bar },
719 { "spam_report", vtype_stringptr, &spam_report },
720 { "spam_score", vtype_stringptr, &spam_score },
721 { "spam_score_int", vtype_stringptr, &spam_score_int },
724 { "spf_guess", vtype_stringptr, &spf_guess },
725 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
726 { "spf_received", vtype_stringptr, &spf_received },
727 { "spf_result", vtype_stringptr, &spf_result },
728 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
729 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
731 { "spool_directory", vtype_stringptr, &spool_directory },
732 { "spool_inodes", vtype_pinodes, (void *)TRUE },
733 { "spool_space", vtype_pspace, (void *)TRUE },
734 #ifdef EXPERIMENTAL_SRS
735 { "srs_db_address", vtype_stringptr, &srs_db_address },
736 { "srs_db_key", vtype_stringptr, &srs_db_key },
737 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
738 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
739 { "srs_recipient", vtype_stringptr, &srs_recipient },
740 { "srs_status", vtype_stringptr, &srs_status },
742 { "thisaddress", vtype_stringptr, &filter_thisaddress },
744 /* The non-(in,out) variables are now deprecated */
745 { "tls_bits", vtype_int, &tls_in.bits },
746 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
747 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
749 { "tls_in_bits", vtype_int, &tls_in.bits },
750 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
751 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
752 { "tls_in_cipher_std", vtype_stringptr, &tls_in.cipher_stdname },
753 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
754 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
755 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
756 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
757 #ifdef EXPERIMENTAL_TLS_RESUME
758 { "tls_in_resumption", vtype_int, &tls_in.resumption },
761 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
763 { "tls_in_ver", vtype_stringptr, &tls_in.ver },
764 { "tls_out_bits", vtype_int, &tls_out.bits },
765 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
766 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
767 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },
769 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
771 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
772 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
773 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
774 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
775 #ifdef EXPERIMENTAL_TLS_RESUME
776 { "tls_out_resumption", vtype_int, &tls_out.resumption },
779 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
782 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
784 { "tls_out_ver", vtype_stringptr, &tls_out.ver },
786 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
788 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
791 { "tod_bsdinbox", vtype_todbsdin, NULL },
792 { "tod_epoch", vtype_tode, NULL },
793 { "tod_epoch_l", vtype_todel, NULL },
794 { "tod_full", vtype_todf, NULL },
795 { "tod_log", vtype_todl, NULL },
796 { "tod_logfile", vtype_todlf, NULL },
797 { "tod_zone", vtype_todzone, NULL },
798 { "tod_zulu", vtype_todzulu, NULL },
799 { "transport_name", vtype_stringptr, &transport_name },
800 { "value", vtype_stringptr, &lookup_value },
801 { "verify_mode", vtype_stringptr, &verify_mode },
802 { "version_number", vtype_stringptr, &version_string },
803 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
804 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
805 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
806 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
807 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
808 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
811 static int var_table_size = nelem(var_table);
812 static uschar var_buffer[256];
813 static BOOL malformed_header;
815 /* For textual hashes */
817 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
818 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
821 enum { HMAC_MD5, HMAC_SHA1 };
823 /* For numeric hashes */
825 static unsigned int prime[] = {
826 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
827 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
828 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
830 /* For printing modes in symbolic form */
832 static uschar *mtable_normal[] =
833 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
835 static uschar *mtable_setid[] =
836 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
838 static uschar *mtable_sticky[] =
839 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
841 /* flags for find_header() */
842 #define FH_EXISTS_ONLY BIT(0)
843 #define FH_WANT_RAW BIT(1)
844 #define FH_WANT_LIST BIT(2)
847 /*************************************************
848 * Tables for UTF-8 support *
849 *************************************************/
851 /* Table of the number of extra characters, indexed by the first character
852 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
855 static uschar utf8_table1[] = {
856 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
857 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
858 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
859 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
861 /* These are the masks for the data bits in the first byte of a character,
862 indexed by the number of additional bytes. */
864 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
866 /* Get the next UTF-8 character, advancing the pointer. */
868 #define GETUTF8INC(c, ptr) \
870 if ((c & 0xc0) == 0xc0) \
872 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
874 c = (c & utf8_table2[a]) << s; \
878 c |= (*ptr++ & 0x3f) << s; \
884 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
886 /*************************************************
887 * Binary chop search on a table *
888 *************************************************/
890 /* This is used for matching expansion items and operators.
893 name the name that is being sought
894 table the table to search
895 table_size the number of items in the table
897 Returns: the offset in the table, or -1
901 chop_match(uschar *name, uschar **table, int table_size)
903 uschar **bot = table;
904 uschar **top = table + table_size;
908 uschar **mid = bot + (top - bot)/2;
909 int c = Ustrcmp(name, *mid);
910 if (c == 0) return mid - table;
911 if (c > 0) bot = mid + 1; else top = mid;
919 /*************************************************
920 * Check a condition string *
921 *************************************************/
923 /* This function is called to expand a string, and test the result for a "true"
924 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
925 forced fail or lookup defer.
927 We used to release all store used, but this is not not safe due
928 to ${dlfunc } and ${acl }. In any case expand_string_internal()
929 is reasonably careful to release what it can.
931 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
934 condition the condition string
935 m1 text to be incorporated in panic error
938 Returns: TRUE if condition is met, FALSE if not
942 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
945 uschar *ss = expand_string(condition);
948 if (!f.expand_string_forcedfail && !f.search_find_defer)
949 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
950 "for %s %s: %s", condition, m1, m2, expand_string_message);
953 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
954 strcmpic(ss, US"false") != 0;
961 /*************************************************
962 * Pseudo-random number generation *
963 *************************************************/
965 /* Pseudo-random number generation. The result is not "expected" to be
966 cryptographically strong but not so weak that someone will shoot themselves
967 in the foot using it as a nonce in some email header scheme or whatever
968 weirdness they'll twist this into. The result should ideally handle fork().
970 However, if we're stuck unable to provide this, then we'll fall back to
971 appallingly bad randomness.
973 If DISABLE_TLS is not defined then this will not be used except as an emergency
978 Returns a random number in range [0, max-1]
982 # define vaguely_random_number vaguely_random_number_fallback
985 vaguely_random_number(int max)
988 # undef vaguely_random_number
990 static pid_t pid = 0;
993 if ((p2 = getpid()) != pid)
998 #ifdef HAVE_ARC4RANDOM
999 /* cryptographically strong randomness, common on *BSD platforms, not
1000 so much elsewhere. Alas. */
1001 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1004 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1005 # ifdef HAVE_SRANDOMDEV
1006 /* uses random(4) for seeding */
1011 gettimeofday(&tv, NULL);
1012 srandom(tv.tv_sec | tv.tv_usec | getpid());
1016 /* Poor randomness and no seeding here */
1023 #ifdef HAVE_ARC4RANDOM
1024 return arc4random() % max;
1025 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1026 return random() % max;
1028 /* This one returns a 16-bit number, definitely not crypto-strong */
1029 return random_number(max);
1036 /*************************************************
1037 * Pick out a name from a string *
1038 *************************************************/
1040 /* If the name is too long, it is silently truncated.
1043 name points to a buffer into which to put the name
1044 max is the length of the buffer
1045 s points to the first alphabetic character of the name
1046 extras chars other than alphanumerics to permit
1048 Returns: pointer to the first character after the name
1050 Note: The test for *s != 0 in the while loop is necessary because
1051 Ustrchr() yields non-NULL if the character is zero (which is not something
1054 static const uschar *
1055 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1058 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1060 if (ptr < max-1) name[ptr++] = *s;
1069 /*************************************************
1070 * Pick out the rest of a header name *
1071 *************************************************/
1073 /* A variable name starting $header_ (or just $h_ for those who like
1074 abbreviations) might not be the complete header name because headers can
1075 contain any printing characters in their names, except ':'. This function is
1076 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1077 on the end, if the name was terminated by white space.
1080 name points to a buffer in which the name read so far exists
1081 max is the length of the buffer
1082 s points to the first character after the name so far, i.e. the
1083 first non-alphameric character after $header_xxxxx
1085 Returns: a pointer to the first character after the header name
1088 static const uschar *
1089 read_header_name(uschar *name, int max, const uschar *s)
1091 int prelen = Ustrchr(name, '_') - name + 1;
1092 int ptr = Ustrlen(name) - prelen;
1093 if (ptr > 0) memmove(name, name+prelen, ptr);
1094 while (mac_isgraph(*s) && *s != ':')
1096 if (ptr < max-1) name[ptr++] = *s;
1107 /*************************************************
1108 * Pick out a number from a string *
1109 *************************************************/
1112 n points to an integer into which to put the number
1113 s points to the first digit of the number
1115 Returns: a pointer to the character after the last digit
1117 /*XXX consider expanding to int_eximarith_t. But the test for
1118 "overbig numbers" in 0002 still needs to overflow it. */
1121 read_number(int *n, uschar *s)
1124 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1128 static const uschar *
1129 read_cnumber(int *n, const uschar *s)
1132 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1138 /*************************************************
1139 * Extract keyed subfield from a string *
1140 *************************************************/
1142 /* The yield is in dynamic store; NULL means that the key was not found.
1145 key points to the name of the key
1146 s points to the string from which to extract the subfield
1148 Returns: NULL if the subfield was not found, or
1149 a pointer to the subfield's data
1153 expand_getkeyed(uschar * key, const uschar * s)
1155 int length = Ustrlen(key);
1156 while (isspace(*s)) s++;
1158 /* Loop to search for the key */
1164 const uschar * dkey = s;
1166 while (*s && *s != '=' && !isspace(*s)) s++;
1167 dkeylength = s - dkey;
1168 while (isspace(*s)) s++;
1169 if (*s == '=') while (isspace((*(++s))));
1171 data = string_dequote(&s);
1172 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1175 while (isspace(*s)) s++;
1184 find_var_ent(uschar * name)
1187 int last = var_table_size;
1189 while (last > first)
1191 int middle = (first + last)/2;
1192 int c = Ustrcmp(name, var_table[middle].name);
1194 if (c > 0) { first = middle + 1; continue; }
1195 if (c < 0) { last = middle; continue; }
1196 return &var_table[middle];
1201 /*************************************************
1202 * Extract numbered subfield from string *
1203 *************************************************/
1205 /* Extracts a numbered field from a string that is divided by tokens - for
1206 example a line from /etc/passwd is divided by colon characters. First field is
1207 numbered one. Negative arguments count from the right. Zero returns the whole
1208 string. Returns NULL if there are insufficient tokens in the string
1211 Modifies final argument - this is a dynamically generated string, so that's OK.
1214 field number of field to be extracted,
1215 first field = 1, whole string = 0, last field = -1
1216 separators characters that are used to break string into tokens
1217 s points to the string from which to extract the subfield
1219 Returns: NULL if the field was not found,
1220 a pointer to the field's data inside s (modified to add 0)
1224 expand_gettokened (int field, uschar *separators, uschar *s)
1229 uschar *fieldtext = NULL;
1231 if (field == 0) return s;
1233 /* Break the line up into fields in place; for field > 0 we stop when we have
1234 done the number of fields we want. For field < 0 we continue till the end of
1235 the string, counting the number of fields. */
1237 count = (field > 0)? field : INT_MAX;
1243 /* Previous field was the last one in the string. For a positive field
1244 number, this means there are not enough fields. For a negative field number,
1245 check that there are enough, and scan back to find the one that is wanted. */
1249 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1250 if ((-field) == (INT_MAX - count - 1)) return s;
1254 while (ss[-1] != 0) ss--;
1260 /* Previous field was not last in the string; save its start and put a
1264 len = Ustrcspn(ss, separators);
1275 expand_getlistele(int field, const uschar * list)
1277 const uschar * tlist = list;
1283 for (field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1286 if (field == 0) return NULL;
1287 while (--field > 0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1288 return string_nextinlist(&list, &sep, NULL, 0);
1292 /* Certificate fields, by name. Worry about by-OID later */
1293 /* Names are chosen to not have common prefixes */
1300 uschar * (*getfn)(void * cert, uschar * mod);
1302 static certfield certfields[] =
1303 { /* linear search; no special order */
1304 { US"version", 7, &tls_cert_version },
1305 { US"serial_number", 13, &tls_cert_serial_number },
1306 { US"subject", 7, &tls_cert_subject },
1307 { US"notbefore", 9, &tls_cert_not_before },
1308 { US"notafter", 8, &tls_cert_not_after },
1309 { US"issuer", 6, &tls_cert_issuer },
1310 { US"signature", 9, &tls_cert_signature },
1311 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1312 { US"subj_altname", 12, &tls_cert_subject_altname },
1313 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1314 { US"crl_uri", 7, &tls_cert_crl_uri },
1318 expand_getcertele(uschar * field, uschar * certvar)
1322 if (!(vp = find_var_ent(certvar)))
1324 expand_string_message =
1325 string_sprintf("no variable named \"%s\"", certvar);
1326 return NULL; /* Unknown variable name */
1328 /* NB this stops us passing certs around in variable. Might
1329 want to do that in future */
1330 if (vp->type != vtype_cert)
1332 expand_string_message =
1333 string_sprintf("\"%s\" is not a certificate", certvar);
1334 return NULL; /* Unknown variable name */
1336 if (!*(void **)vp->value)
1339 if (*field >= '0' && *field <= '9')
1340 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1342 for (certfield * cp = certfields;
1343 cp < certfields + nelem(certfields);
1345 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1347 uschar * modifier = *(field += cp->namelen) == ','
1349 return (*cp->getfn)( *(void **)vp->value, modifier );
1352 expand_string_message =
1353 string_sprintf("bad field selector \"%s\" for certextract", field);
1356 #endif /*DISABLE_TLS*/
1358 /*************************************************
1359 * Extract a substring from a string *
1360 *************************************************/
1362 /* Perform the ${substr or ${length expansion operations.
1365 subject the input string
1366 value1 the offset from the start of the input string to the start of
1367 the output string; if negative, count from the right.
1368 value2 the length of the output string, or negative (-1) for unset
1369 if value1 is positive, unset means "all after"
1370 if value1 is negative, unset means "all before"
1371 len set to the length of the returned string
1373 Returns: pointer to the output string, or NULL if there is an error
1377 extract_substr(uschar *subject, int value1, int value2, int *len)
1379 int sublen = Ustrlen(subject);
1381 if (value1 < 0) /* count from right */
1385 /* If the position is before the start, skip to the start, and adjust the
1386 length. If the length ends up negative, the substring is null because nothing
1387 can precede. This falls out naturally when the length is unset, meaning "all
1393 if (value2 < 0) value2 = 0;
1397 /* Otherwise an unset length => characters before value1 */
1399 else if (value2 < 0)
1406 /* For a non-negative offset, if the starting position is past the end of the
1407 string, the result will be the null string. Otherwise, an unset length means
1408 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1412 if (value1 > sublen)
1417 else if (value2 < 0) value2 = sublen;
1420 /* Cut the length down to the maximum possible for the offset value, and get
1421 the required characters. */
1423 if (value1 + value2 > sublen) value2 = sublen - value1;
1425 return subject + value1;
1431 /*************************************************
1432 * Old-style hash of a string *
1433 *************************************************/
1435 /* Perform the ${hash expansion operation.
1438 subject the input string (an expanded substring)
1439 value1 the length of the output string; if greater or equal to the
1440 length of the input string, the input string is returned
1441 value2 the number of hash characters to use, or 26 if negative
1442 len set to the length of the returned string
1444 Returns: pointer to the output string, or NULL if there is an error
1448 compute_hash(uschar *subject, int value1, int value2, int *len)
1450 int sublen = Ustrlen(subject);
1452 if (value2 < 0) value2 = 26;
1453 else if (value2 > Ustrlen(hashcodes))
1455 expand_string_message =
1456 string_sprintf("hash count \"%d\" too big", value2);
1460 /* Calculate the hash text. We know it is shorter than the original string, so
1461 can safely place it in subject[] (we know that subject is always itself an
1462 expanded substring). */
1464 if (value1 < sublen)
1469 while ((c = (subject[j])) != 0)
1471 int shift = (c + j++) & 7;
1472 subject[i] ^= (c << shift) | (c >> (8-shift));
1473 if (++i >= value1) i = 0;
1475 for (i = 0; i < value1; i++)
1476 subject[i] = hashcodes[(subject[i]) % value2];
1478 else value1 = sublen;
1487 /*************************************************
1488 * Numeric hash of a string *
1489 *************************************************/
1491 /* Perform the ${nhash expansion operation. The first characters of the
1492 string are treated as most important, and get the highest prime numbers.
1495 subject the input string
1496 value1 the maximum value of the first part of the result
1497 value2 the maximum value of the second part of the result,
1498 or negative to produce only a one-part result
1499 len set to the length of the returned string
1501 Returns: pointer to the output string, or NULL if there is an error.
1505 compute_nhash (uschar *subject, int value1, int value2, int *len)
1507 uschar *s = subject;
1509 unsigned long int total = 0; /* no overflow */
1513 if (i == 0) i = nelem(prime) - 1;
1514 total += prime[i--] * (unsigned int)(*s++);
1517 /* If value2 is unset, just compute one number */
1520 s = string_sprintf("%lu", total % value1);
1522 /* Otherwise do a div/mod hash */
1526 total = total % (value1 * value2);
1527 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1538 /*************************************************
1539 * Find the value of a header or headers *
1540 *************************************************/
1542 /* Multiple instances of the same header get concatenated, and this function
1543 can also return a concatenation of all the header lines. When concatenating
1544 specific headers that contain lists of addresses, a comma is inserted between
1545 them. Otherwise we use a straight concatenation. Because some messages can have
1546 pathologically large number of lines, there is a limit on the length that is
1550 name the name of the header, without the leading $header_ or $h_,
1551 or NULL if a concatenation of all headers is required
1552 newsize return the size of memory block that was obtained; may be NULL
1553 if exists_only is TRUE
1554 flags FH_EXISTS_ONLY
1555 set if called from a def: test; don't need to build a string;
1556 just return a string that is not "" and not "0" if the header
1559 set if called for $rh_ or $rheader_ items; no processing,
1560 other than concatenating, will be done on the header. Also used
1561 for $message_headers_raw.
1563 Double colon chars in the content, and replace newline with
1564 colon between each element when concatenating; returning a
1565 colon-sep list (elements might contain newlines)
1566 charset name of charset to translate MIME words to; used only if
1567 want_raw is false; if NULL, no translation is done (this is
1568 used for $bh_ and $bheader_)
1570 Returns: NULL if the header does not exist, else a pointer to a new
1575 find_header(uschar *name, int *newsize, unsigned flags, uschar *charset)
1578 int len = name ? Ustrlen(name) : 0;
1582 for (header_line * h = header_list; h; h = h->next)
1583 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1584 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1589 if (flags & FH_EXISTS_ONLY)
1590 return US"1"; /* don't need actual string */
1593 s = h->text + len; /* text to insert */
1594 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1595 while (isspace(*s)) s++; /* remove leading white space */
1596 t = h->text + h->slen; /* end-point */
1598 /* Unless wanted raw, remove trailing whitespace, including the
1601 if (flags & FH_WANT_LIST)
1602 while (t > s && t[-1] == '\n') t--;
1603 else if (!(flags & FH_WANT_RAW))
1605 while (t > s && isspace(t[-1])) t--;
1607 /* Set comma if handling a single header and it's one of those
1608 that contains an address list, except when asked for raw headers. Only
1609 need to do this once. */
1611 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1614 /* Trim the header roughly if we're approaching limits */
1616 if ((g ? g->ptr : 0) + inc > header_insert_maxlen)
1617 inc = header_insert_maxlen - (g ? g->ptr : 0);
1619 /* For raw just copy the data; for a list, add the data as a colon-sep
1620 list-element; for comma-list add as an unchecked comma,newline sep
1621 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1622 stripped trailing WS above including the newline). We ignore the potential
1623 expansion due to colon-doubling, just leaving the loop if the limit is met
1626 if (flags & FH_WANT_LIST)
1627 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1628 else if (flags & FH_WANT_RAW)
1630 g = string_catn(g, s, (unsigned)inc);
1631 (void) string_from_gstring(g);
1635 g = string_append2_listele_n(g, US",\n", s, (unsigned)inc);
1637 g = string_append2_listele_n(g, US"\n", s, (unsigned)inc);
1639 if (g && g->ptr >= header_insert_maxlen) break;
1642 if (!found) return NULL; /* No header found */
1643 if (!g) return US"";
1645 /* That's all we do for raw header expansion. */
1648 if (flags & FH_WANT_RAW)
1651 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1652 The rfc2047_decode2() function can return an error with decoded data if the
1653 charset translation fails. If decoding fails, it returns NULL. */
1657 uschar *decoded, *error;
1659 decoded = rfc2047_decode2(g->s, check_rfc2047_length, charset, '?', NULL,
1663 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1664 " input was: %s\n", error, g->s);
1666 return decoded ? decoded : g->s;
1673 /* Append a "local" element to an Authentication-Results: header
1674 if this was a non-smtp message.
1678 authres_local(gstring * g, const uschar * sysname)
1680 if (!f.authentication_local)
1682 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1683 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1688 /* Append an "iprev" element to an Authentication-Results: header
1689 if we have attempted to get the calling host's name.
1693 authres_iprev(gstring * g)
1695 if (sender_host_name)
1696 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1697 else if (host_lookup_deferred)
1698 g = string_catn(g, US";\n\tiprev=temperror", 19);
1699 else if (host_lookup_failed)
1700 g = string_catn(g, US";\n\tiprev=fail", 13);
1704 if (sender_host_address)
1705 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1711 /*************************************************
1712 * Return list of recipients *
1713 *************************************************/
1714 /* A recipients list is available only during system message filtering,
1715 during ACL processing after DATA, and while expanding pipe commands
1716 generated from a system filter, but not elsewhere. */
1724 if (!f.enable_dollar_recipients) return NULL;
1726 for (int i = 0; i < recipients_count; i++)
1728 s = recipients_list[i].address;
1729 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1731 return g ? g->s : NULL;
1735 /*************************************************
1736 * Find value of a variable *
1737 *************************************************/
1739 /* The table of variables is kept in alphabetic order, so we can search it
1740 using a binary chop. The "choplen" variable is nothing to do with the binary
1744 name the name of the variable being sought
1745 exists_only TRUE if this is a def: test; passed on to find_header()
1746 skipping TRUE => skip any processing evaluation; this is not the same as
1747 exists_only because def: may test for values that are first
1749 newsize pointer to an int which is initially zero; if the answer is in
1750 a new memory buffer, *newsize is set to its size
1752 Returns: NULL if the variable does not exist, or
1753 a pointer to the variable's contents, or
1754 something non-NULL if exists_only is TRUE
1758 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1765 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1766 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1767 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1768 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1769 (this gave backwards compatibility at the changeover). There may be built-in
1770 variables whose names start acl_ but they should never start in this way. This
1771 slightly messy specification is a consequence of the history, needless to say.
1773 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1774 set, in which case give an error. */
1776 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1780 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1781 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1783 else if (Ustrncmp(name, "r_", 2) == 0)
1785 tree_node * node = tree_search(router_var, name + 2);
1786 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1789 /* Handle $auth<n> variables. */
1791 if (Ustrncmp(name, "auth", 4) == 0)
1794 int n = Ustrtoul(name + 4, &endptr, 10);
1795 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1796 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1798 else if (Ustrncmp(name, "regex", 5) == 0)
1801 int n = Ustrtoul(name + 5, &endptr, 10);
1802 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1803 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1806 /* For all other variables, search the table */
1808 if (!(vp = find_var_ent(name)))
1809 return NULL; /* Unknown variable name */
1811 /* Found an existing variable. If in skipping state, the value isn't needed,
1812 and we want to avoid processing (such as looking up the host name). */
1820 case vtype_filter_int:
1821 if (!f.filter_running) return NULL;
1825 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1829 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1833 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1837 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1841 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1844 case vtype_stringptr: /* Pointer to string */
1845 return (s = *((uschar **)(val))) ? s : US"";
1848 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1851 case vtype_load_avg:
1852 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1855 case vtype_host_lookup: /* Lookup if not done so */
1856 if ( !sender_host_name && sender_host_address
1857 && !host_lookup_failed && host_name_lookup() == OK)
1858 host_build_sender_fullhost();
1859 return sender_host_name ? sender_host_name : US"";
1861 case vtype_localpart: /* Get local part from address */
1862 if (!(s = *((uschar **)(val)))) return US"";
1863 if (!(domain = Ustrrchr(s, '@'))) return s;
1864 if (domain - s > sizeof(var_buffer) - 1)
1865 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1866 " in string expansion", sizeof(var_buffer));
1867 return string_copyn(s, domain - s);
1869 case vtype_domain: /* Get domain from address */
1870 if (!(s = *((uschar **)(val)))) return US"";
1871 domain = Ustrrchr(s, '@');
1872 return domain ? domain + 1 : US"";
1874 case vtype_msgheaders:
1875 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
1877 case vtype_msgheaders_raw:
1878 return find_header(NULL, newsize,
1879 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
1881 case vtype_msgbody: /* Pointer to msgbody string */
1882 case vtype_msgbody_end: /* Ditto, the end of the msg */
1883 ss = (uschar **)(val);
1884 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1887 off_t start_offset = SPOOL_DATA_START_OFFSET;
1888 int len = message_body_visible;
1889 if (len > message_size) len = message_size;
1890 *ss = body = store_malloc(len+1);
1892 if (vp->type == vtype_msgbody_end)
1894 struct stat statbuf;
1895 if (fstat(deliver_datafile, &statbuf) == 0)
1897 start_offset = statbuf.st_size - len;
1898 if (start_offset < SPOOL_DATA_START_OFFSET)
1899 start_offset = SPOOL_DATA_START_OFFSET;
1902 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1903 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1905 len = read(deliver_datafile, body, len);
1909 if (message_body_newlines) /* Separate loops for efficiency */
1911 { if (body[--len] == 0) body[len] = ' '; }
1914 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1917 return *ss ? *ss : US"";
1919 case vtype_todbsdin: /* BSD inbox time of day */
1920 return tod_stamp(tod_bsdin);
1922 case vtype_tode: /* Unix epoch time of day */
1923 return tod_stamp(tod_epoch);
1925 case vtype_todel: /* Unix epoch/usec time of day */
1926 return tod_stamp(tod_epoch_l);
1928 case vtype_todf: /* Full time of day */
1929 return tod_stamp(tod_full);
1931 case vtype_todl: /* Log format time of day */
1932 return tod_stamp(tod_log_bare); /* (without timezone) */
1934 case vtype_todzone: /* Time zone offset only */
1935 return tod_stamp(tod_zone);
1937 case vtype_todzulu: /* Zulu time */
1938 return tod_stamp(tod_zulu);
1940 case vtype_todlf: /* Log file datestamp tod */
1941 return tod_stamp(tod_log_datestamp_daily);
1943 case vtype_reply: /* Get reply address */
1944 s = find_header(US"reply-to:", newsize,
1945 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
1947 if (s) while (isspace(*s)) s++;
1950 *newsize = 0; /* For the *s==0 case */
1951 s = find_header(US"from:", newsize,
1952 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
1958 while (isspace(*s)) s++;
1959 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1960 while (t > s && isspace(t[-1])) t--;
1963 return s ? s : US"";
1965 case vtype_string_func:
1967 stringptr_fn_t * fn = (stringptr_fn_t *) val;
1974 sprintf(CS var_buffer, PR_EXIM_ARITH,
1975 receive_statvfs(val == (void *)TRUE, &inodes));
1982 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1983 sprintf(CS var_buffer, "%d", inodes);
1988 return *(void **)val ? US"<cert>" : US"";
1990 #ifndef DISABLE_DKIM
1992 return dkim_exim_expand_query((int)(long)val);
1997 return NULL; /* Unknown variable. Silences static checkers. */
2004 modify_variable(uschar *name, void * value)
2007 if ((vp = find_var_ent(name))) vp->value = value;
2008 return; /* Unknown variable name, fail silently */
2016 /*************************************************
2017 * Read and expand substrings *
2018 *************************************************/
2020 /* This function is called to read and expand argument substrings for various
2021 expansion items. Some have a minimum requirement that is less than the maximum;
2022 in these cases, the first non-present one is set to NULL.
2025 sub points to vector of pointers to set
2026 n maximum number of substrings
2028 sptr points to current string pointer
2029 skipping the skipping flag
2030 check_end if TRUE, check for final '}'
2031 name name of item, for error message
2032 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2035 Returns: 0 OK; string pointer updated
2036 1 curly bracketing error (too few arguments)
2037 2 too many arguments (only if check_end is set); message set
2038 3 other error (expansion failure)
2042 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
2043 BOOL check_end, uschar *name, BOOL *resetok)
2045 const uschar *s = *sptr;
2047 while (isspace(*s)) s++;
2048 for (int i = 0; i < n; i++)
2054 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2055 "(min is %d)", name, m);
2061 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2063 if (*s++ != '}') return 1;
2064 while (isspace(*s)) s++;
2066 if (check_end && *s++ != '}')
2070 expand_string_message = string_sprintf("Too many arguments for '%s' "
2071 "(max is %d)", name, n);
2074 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2085 /*************************************************
2086 * Elaborate message for bad variable *
2087 *************************************************/
2089 /* For the "unknown variable" message, take a look at the variable's name, and
2090 give additional information about possible ACL variables. The extra information
2091 is added on to expand_string_message.
2093 Argument: the name of the variable
2098 check_variable_error_message(uschar *name)
2100 if (Ustrncmp(name, "acl_", 4) == 0)
2101 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2102 (name[4] == 'c' || name[4] == 'm')?
2104 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2105 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2107 US"user-defined ACL variables must start acl_c or acl_m");
2113 Load args from sub array to globals, and call acl_check().
2114 Sub array will be corrupted on return.
2116 Returns: OK access is granted by an ACCEPT verb
2117 DISCARD access is (apparently) granted by a DISCARD verb
2118 FAIL access is denied
2119 FAIL_DROP access is denied; drop the connection
2120 DEFER can't tell at the moment
2124 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2127 int sav_narg = acl_narg;
2129 uschar * dummy_logmsg;
2130 extern int acl_where;
2132 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2133 for (i = 0; i < nsub && sub[i+1]; i++)
2135 uschar * tmp = acl_arg[i];
2136 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2137 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2142 sub[i+1] = acl_arg[i];
2143 acl_arg[i++] = NULL;
2147 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2149 acl_narg>0 ? acl_arg[0] : US"<none>",
2150 acl_narg>1 ? " +more" : "");
2152 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2154 for (i = 0; i < nsub; i++)
2155 acl_arg[i] = sub[i+1]; /* restore old args */
2156 acl_narg = sav_narg;
2164 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2165 The given string is modified on return. Leading whitespace is skipped while
2166 looking for the opening wrap character, then the rest is scanned for the trailing
2167 (non-escaped) wrap character. A backslash in the string will act as an escape.
2169 A nul is written over the trailing wrap, and a pointer to the char after the
2170 leading wrap is returned.
2173 s String for de-wrapping
2174 wrap Two-char string, the first being the opener, second the closer wrapping
2177 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2181 dewrap(uschar * s, const uschar * wrap)
2185 BOOL quotesmode = wrap[0] == wrap[1];
2187 while (isspace(*p)) p++;
2195 if (*p == '\\') p++;
2196 else if (!quotesmode && *p == wrap[-1]) depth++;
2197 else if (*p == *wrap)
2208 expand_string_message = string_sprintf("missing '%c'", *wrap);
2213 /* Pull off the leading array or object element, returning
2214 a copy in an allocated string. Update the list pointer.
2216 The element may itself be an abject or array.
2217 Return NULL when the list is empty.
2221 json_nextinlist(const uschar ** list)
2223 unsigned array_depth = 0, object_depth = 0;
2224 const uschar * s = *list, * item;
2226 while (isspace(*s)) s++;
2229 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2233 case '[': array_depth++; break;
2234 case ']': array_depth--; break;
2235 case '{': object_depth++; break;
2236 case '}': object_depth--; break;
2238 *list = *s ? s+1 : s;
2239 if (item == s) return NULL;
2240 item = string_copyn(item, s - item);
2241 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2247 /************************************************/
2248 /* Return offset in ops table, or -1 if not found.
2249 Repoint to just after the operator in the string.
2252 ss string representation of operator
2253 opname split-out operator name
2257 identify_operator(const uschar ** ss, uschar ** opname)
2259 const uschar * s = *ss;
2262 /* Numeric comparisons are symbolic */
2264 if (*s == '=' || *s == '>' || *s == '<')
2276 /* All other conditions are named */
2279 s = read_name(name, sizeof(name), s, US"_");
2282 /* If we haven't read a name, it means some non-alpha character is first. */
2286 expand_string_message = string_sprintf("condition name expected, "
2287 "but found \"%.16s\"", s);
2291 *opname = string_copy(name);
2293 return chop_match(name, cond_table, nelem(cond_table));
2297 /*************************************************
2298 * Read and evaluate a condition *
2299 *************************************************/
2303 s points to the start of the condition text
2304 resetok points to a BOOL which is written false if it is unsafe to
2305 free memory. Certain condition types (acl) may have side-effect
2306 allocation which must be preserved.
2307 yield points to a BOOL to hold the result of the condition test;
2308 if NULL, we are just reading through a condition that is
2309 part of an "or" combination to check syntax, or in a state
2310 where the answer isn't required
2312 Returns: a pointer to the first character after the condition, or
2316 static const uschar *
2317 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2319 BOOL testfor = TRUE;
2320 BOOL tempcond, combined_cond;
2322 BOOL sub2_honour_dollar = TRUE;
2323 BOOL is_forany, is_json, is_jsons;
2324 int rc, cond_type, roffset;
2325 int_eximarith_t num[2];
2326 struct stat statbuf;
2329 const uschar *sub[10];
2332 const uschar *rerror;
2336 while (isspace(*s)) s++;
2337 if (*s == '!') { testfor = !testfor; s++; } else break;
2340 switch(cond_type = identify_operator(&s, &opname))
2342 /* def: tests for a non-empty variable, or for the existence of a header. If
2343 yield == NULL we are in a skipping state, and don't care about the answer. */
2351 expand_string_message = US"\":\" expected after \"def\"";
2355 s = read_name(name, sizeof(name), s+1, US"_");
2357 /* Test for a header's existence. If the name contains a closing brace
2358 character, this may be a user error where the terminating colon has been
2359 omitted. Set a flag to adjust a subsequent error message in this case. */
2361 if ( ( *(t = name) == 'h'
2362 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2364 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2367 s = read_header_name(name, sizeof(name), s);
2368 /* {-for-text-editors */
2369 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2371 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2374 /* Test for a variable's having a non-empty value. A non-existent variable
2375 causes an expansion failure. */
2379 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2381 expand_string_message = name[0]
2382 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2383 : US"variable name omitted after \"def:\"";
2384 check_variable_error_message(name);
2387 if (yield) *yield = (t[0] != 0) == testfor;
2394 /* first_delivery tests for first delivery attempt */
2396 case ECOND_FIRST_DELIVERY:
2397 if (yield != NULL) *yield = f.deliver_firsttime == testfor;
2401 /* queue_running tests for any process started by a queue runner */
2403 case ECOND_QUEUE_RUNNING:
2404 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2408 /* exists: tests for file existence
2409 isip: tests for any IP address
2410 isip4: tests for an IPv4 address
2411 isip6: tests for an IPv6 address
2412 pam: does PAM authentication
2413 radius: does RADIUS authentication
2414 ldapauth: does LDAP authentication
2415 pwcheck: does Cyrus SASL pwcheck authentication
2424 case ECOND_LDAPAUTH:
2427 while (isspace(*s)) s++;
2428 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2430 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2431 if (sub[0] == NULL) return NULL;
2432 /* {-for-text-editors */
2433 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2435 if (yield == NULL) return s; /* No need to run the test if skipping */
2440 if ((expand_forbid & RDO_EXISTS) != 0)
2442 expand_string_message = US"File existence tests are not permitted";
2445 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2451 rc = string_is_ip_address(sub[0], NULL);
2452 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2453 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2456 /* Various authentication tests - all optionally compiled */
2460 rc = auth_call_pam(sub[0], &expand_string_message);
2463 goto COND_FAILED_NOT_COMPILED;
2464 #endif /* SUPPORT_PAM */
2467 #ifdef RADIUS_CONFIG_FILE
2468 rc = auth_call_radius(sub[0], &expand_string_message);
2471 goto COND_FAILED_NOT_COMPILED;
2472 #endif /* RADIUS_CONFIG_FILE */
2474 case ECOND_LDAPAUTH:
2477 /* Just to keep the interface the same */
2479 int old_pool = store_pool;
2480 store_pool = POOL_SEARCH;
2481 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2482 &expand_string_message, &do_cache);
2483 store_pool = old_pool;
2487 goto COND_FAILED_NOT_COMPILED;
2488 #endif /* LOOKUP_LDAP */
2491 #ifdef CYRUS_PWCHECK_SOCKET
2492 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2495 goto COND_FAILED_NOT_COMPILED;
2496 #endif /* CYRUS_PWCHECK_SOCKET */
2498 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2499 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2501 if (rc == ERROR || rc == DEFER) return NULL;
2502 *yield = (rc == OK) == testfor;
2508 /* call ACL (in a conditional context). Accept true, deny false.
2509 Defer is a forced-fail. Anything set by message= goes to $value.
2510 Up to ten parameters are used; we use the braces round the name+args
2511 like the saslauthd condition does, to permit a variable number of args.
2512 See also the expansion-item version EITEM_ACL and the traditional
2513 acl modifier ACLC_ACL.
2514 Since the ACL may allocate new global variables, tell our caller to not
2519 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2525 while (isspace(*s)) s++;
2526 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2528 switch(read_subs(sub, nelem(sub), 1,
2529 &s, yield == NULL, TRUE, US"acl", resetok))
2531 case 1: expand_string_message = US"too few arguments or bracketing "
2534 case 3: return NULL;
2540 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2541 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2546 lookup_value = NULL;
2548 lookup_value = string_copy(user_msg);
2549 *yield = cond == testfor;
2553 f.expand_string_forcedfail = TRUE;
2556 expand_string_message = string_sprintf("%s from acl \"%s\"",
2557 rc_names[rc], sub[0]);
2565 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2567 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2569 However, the last two are optional. That is why the whole set is enclosed
2570 in their own set of braces. */
2572 case ECOND_SASLAUTHD:
2573 #ifndef CYRUS_SASLAUTHD_SOCKET
2574 goto COND_FAILED_NOT_COMPILED;
2578 while (isspace(*s)) s++;
2579 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2580 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2583 case 1: expand_string_message = US"too few arguments or bracketing "
2584 "error for saslauthd";
2586 case 3: return NULL;
2588 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2591 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2592 &expand_string_message);
2593 if (rc == ERROR || rc == DEFER) return NULL;
2594 *yield = (rc == OK) == testfor;
2598 #endif /* CYRUS_SASLAUTHD_SOCKET */
2601 /* symbolic operators for numeric and string comparison, and a number of
2602 other operators, all requiring two arguments.
2604 crypteq: encrypts plaintext and compares against an encrypted text,
2605 using crypt(), crypt16(), MD5 or SHA-1
2606 inlist/inlisti: checks if first argument is in the list of the second
2607 match: does a regular expression match and sets up the numerical
2608 variables if it succeeds
2609 match_address: matches in an address list
2610 match_domain: matches in a domain list
2611 match_ip: matches a host list that is restricted to IP addresses
2612 match_local_part: matches in a local part list
2615 case ECOND_MATCH_ADDRESS:
2616 case ECOND_MATCH_DOMAIN:
2617 case ECOND_MATCH_IP:
2618 case ECOND_MATCH_LOCAL_PART:
2619 #ifndef EXPAND_LISTMATCH_RHS
2620 sub2_honour_dollar = FALSE;
2629 case ECOND_NUM_L: /* Numerical comparisons */
2636 case ECOND_STR_LT: /* String comparisons */
2647 for (int i = 0; i < 2; i++)
2649 /* Sometimes, we don't expand substrings; too many insecure configurations
2650 created using match_address{}{} and friends, where the second param
2651 includes information from untrustworthy sources. */
2652 BOOL honour_dollar = TRUE;
2653 if ((i > 0) && !sub2_honour_dollar)
2654 honour_dollar = FALSE;
2656 while (isspace(*s)) s++;
2659 if (i == 0) goto COND_FAILED_CURLY_START;
2660 expand_string_message = string_sprintf("missing 2nd string in {} "
2661 "after \"%s\"", opname);
2664 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2665 honour_dollar, resetok)))
2667 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2668 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2669 " for security reasons\n");
2670 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2672 /* Convert to numerical if required; we know that the names of all the
2673 conditions that compare numbers do not start with a letter. This just saves
2674 checking for them individually. */
2676 if (!isalpha(opname[0]) && yield != NULL)
2681 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2685 num[i] = expanded_string_integer(sub[i], FALSE);
2686 if (expand_string_message != NULL) return NULL;
2690 /* Result not required */
2692 if (yield == NULL) return s;
2694 /* Do an appropriate comparison */
2700 tempcond = (num[0] == num[1]);
2704 tempcond = (num[0] > num[1]);
2708 tempcond = (num[0] >= num[1]);
2712 tempcond = (num[0] < num[1]);
2716 tempcond = (num[0] <= num[1]);
2720 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2724 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2728 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2732 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2736 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2740 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2744 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2748 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2752 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2756 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2759 case ECOND_MATCH: /* Regular expression match */
2760 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2764 expand_string_message = string_sprintf("regular expression error in "
2765 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2768 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2771 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2772 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2773 goto MATCHED_SOMETHING;
2775 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2776 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2777 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2778 goto MATCHED_SOMETHING;
2780 case ECOND_MATCH_IP: /* Match IP address in a host list */
2781 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2783 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2789 unsigned int *nullcache = NULL;
2790 check_host_block cb;
2792 cb.host_name = US"";
2793 cb.host_address = sub[0];
2795 /* If the host address starts off ::ffff: it is an IPv6 address in
2796 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2799 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2800 cb.host_address + 7 : cb.host_address;
2802 rc = match_check_list(
2803 &sub[1], /* the list */
2804 0, /* separator character */
2805 &hostlist_anchor, /* anchor pointer */
2806 &nullcache, /* cache pointer */
2807 check_host, /* function for testing */
2808 &cb, /* argument for function */
2809 MCL_HOST, /* type of check */
2810 sub[0], /* text for debugging */
2811 NULL); /* where to pass back data */
2813 goto MATCHED_SOMETHING;
2815 case ECOND_MATCH_LOCAL_PART:
2816 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2817 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2832 expand_string_message = string_sprintf("unable to complete match "
2833 "against \"%s\": %s", sub[1], search_error_message);
2839 /* Various "encrypted" comparisons. If the second string starts with
2840 "{" then an encryption type is given. Default to crypt() or crypt16()
2841 (build-time choice). */
2842 /* }-for-text-editors */
2845 #ifndef SUPPORT_CRYPTEQ
2846 goto COND_FAILED_NOT_COMPILED;
2848 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2850 int sublen = Ustrlen(sub[1]+5);
2855 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2857 /* If the length that we are comparing against is 24, the MD5 digest
2858 is expressed as a base64 string. This is the way LDAP does it. However,
2859 some other software uses a straightforward hex representation. We assume
2860 this if the length is 32. Other lengths fail. */
2864 uschar *coded = b64encode(CUS digest, 16);
2865 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2866 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2867 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2869 else if (sublen == 32)
2872 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2874 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2875 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2876 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2880 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2881 "fail\n crypted=%s\n", sub[1]+5);
2886 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2888 int sublen = Ustrlen(sub[1]+6);
2893 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2895 /* If the length that we are comparing against is 28, assume the SHA1
2896 digest is expressed as a base64 string. If the length is 40, assume a
2897 straightforward hex representation. Other lengths fail. */
2901 uschar *coded = b64encode(CUS digest, 20);
2902 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2903 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2904 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2906 else if (sublen == 40)
2909 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2911 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2912 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2913 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2917 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2918 "fail\n crypted=%s\n", sub[1]+6);
2923 else /* {crypt} or {crypt16} and non-{ at start */
2924 /* }-for-text-editors */
2929 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2934 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2939 else if (sub[1][0] == '{') /* }-for-text-editors */
2941 expand_string_message = string_sprintf("unknown encryption mechanism "
2942 "in \"%s\"", sub[1]);
2948 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2949 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2950 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2954 #define XSTR(s) STR(s)
2955 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2956 " subject=%s\n crypted=%s\n",
2957 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2962 /* If the encrypted string contains fewer than two characters (for the
2963 salt), force failure. Otherwise we get false positives: with an empty
2964 string the yield of crypt() is an empty string! */
2967 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2968 else if (errno == EINVAL)
2972 expand_string_message = string_sprintf("crypt error: %s\n",
2973 US strerror(errno));
2978 #endif /* SUPPORT_CRYPTEQ */
2983 const uschar * list = sub[1];
2985 uschar *save_iterate_item = iterate_item;
2986 int (*compare)(const uschar *, const uschar *);
2988 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);
2991 compare = cond_type == ECOND_INLISTI
2992 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2994 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2996 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
2997 if (compare(sub[0], iterate_item) == 0)
3003 iterate_item = save_iterate_item;
3006 } /* Switch for comparison conditions */
3008 *yield = tempcond == testfor;
3009 return s; /* End of comparison conditions */
3012 /* and/or: computes logical and/or of several conditions */
3016 subcondptr = (yield == NULL)? NULL : &tempcond;
3017 combined_cond = (cond_type == ECOND_AND);
3019 while (isspace(*s)) s++;
3020 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3024 while (isspace(*s)) s++;
3025 /* {-for-text-editors */
3026 if (*s == '}') break;
3027 if (*s != '{') /* }-for-text-editors */
3029 expand_string_message = string_sprintf("each subcondition "
3030 "inside an \"%s{...}\" condition must be in its own {}", opname);
3034 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3036 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3037 expand_string_message, opname);
3040 while (isspace(*s)) s++;
3042 /* {-for-text-editors */
3045 /* {-for-text-editors */
3046 expand_string_message = string_sprintf("missing } at end of condition "
3047 "inside \"%s\" group", opname);
3053 if (cond_type == ECOND_AND)
3055 combined_cond &= tempcond;
3056 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3057 } /* evaluate any more */
3060 combined_cond |= tempcond;
3061 if (combined_cond) subcondptr = NULL; /* once true, don't */
3062 } /* evaluate any more */
3066 if (yield != NULL) *yield = (combined_cond == testfor);
3070 /* forall/forany: iterates a condition with different values */
3072 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3073 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3074 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3075 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3076 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3077 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3081 const uschar * list;
3083 uschar *save_iterate_item = iterate_item;
3085 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3087 while (isspace(*s)) s++;
3088 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3089 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
3090 if (sub[0] == NULL) return NULL;
3091 /* {-for-text-editors */
3092 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3094 while (isspace(*s)) s++;
3095 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3099 /* Call eval_condition once, with result discarded (as if scanning a
3100 "false" part). This allows us to find the end of the condition, because if
3101 the list it empty, we won't actually evaluate the condition for real. */
3103 if (!(s = eval_condition(sub[1], resetok, NULL)))
3105 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3106 expand_string_message, opname);
3109 while (isspace(*s)) s++;
3111 /* {-for-text-editors */
3114 /* {-for-text-editors */
3115 expand_string_message = string_sprintf("missing } at end of condition "
3116 "inside \"%s\"", opname);
3120 if (yield) *yield = !testfor;
3122 if (is_json) list = dewrap(string_copy(list), US"[]");
3123 while ((iterate_item = is_json
3124 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3127 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3129 expand_string_message =
3130 string_sprintf("%s wrapping string result for extract jsons",
3131 expand_string_message);
3132 iterate_item = save_iterate_item;
3136 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3137 if (!eval_condition(sub[1], resetok, &tempcond))
3139 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3140 expand_string_message, opname);
3141 iterate_item = save_iterate_item;
3144 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3145 tempcond? "true":"false");
3147 if (yield) *yield = (tempcond == testfor);
3148 if (tempcond == is_forany) break;
3151 iterate_item = save_iterate_item;
3156 /* The bool{} expansion condition maps a string to boolean.
3157 The values supported should match those supported by the ACL condition
3158 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3159 of true/false. Note that Router "condition" rules have a different
3160 interpretation, where general data can be used and only a few values
3162 Note that readconf.c boolean matching, for boolean configuration options,
3163 only matches true/yes/false/no.
3164 The bool_lax{} condition matches the Router logic, which is much more
3167 case ECOND_BOOL_LAX:
3173 BOOL boolvalue = FALSE;
3174 while (isspace(*s)) s++;
3175 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3176 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3177 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3179 case 1: expand_string_message = string_sprintf(
3180 "too few arguments or bracketing error for %s",
3184 case 3: return NULL;
3187 while (isspace(*t)) t++;
3191 /* trailing whitespace: seems like a good idea to ignore it too */
3193 while (isspace(*t2)) t2--;
3194 if (t2 != (t + len))
3201 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3202 /* logic for the lax case from expand_check_condition(), which also does
3203 expands, and the logic is both short and stable enough that there should
3204 be no maintenance burden from replicating it. */
3208 ? Ustrspn(t+1, "0123456789") == len-1
3209 : Ustrspn(t, "0123456789") == len)
3211 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3212 /* expand_check_condition only does a literal string "0" check */
3213 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3216 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3218 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3220 else if (cond_type == ECOND_BOOL_LAX)
3224 expand_string_message = string_sprintf("unrecognised boolean "
3228 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3229 boolvalue? "true":"false");
3230 if (yield != NULL) *yield = (boolvalue == testfor);
3234 /* Unknown condition */
3237 if (!expand_string_message || !*expand_string_message)
3238 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3240 } /* End switch on condition type */
3242 /* Missing braces at start and end of data */
3244 COND_FAILED_CURLY_START:
3245 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3248 COND_FAILED_CURLY_END:
3249 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3253 /* A condition requires code that is not compiled */
3255 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3256 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3257 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3258 COND_FAILED_NOT_COMPILED:
3259 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3268 /*************************************************
3269 * Save numerical variables *
3270 *************************************************/
3272 /* This function is called from items such as "if" that want to preserve and
3273 restore the numbered variables.
3276 save_expand_string points to an array of pointers to set
3277 save_expand_nlength points to an array of ints for the lengths
3279 Returns: the value of expand max to save
3283 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3285 for (int i = 0; i <= expand_nmax; i++)
3287 save_expand_nstring[i] = expand_nstring[i];
3288 save_expand_nlength[i] = expand_nlength[i];
3295 /*************************************************
3296 * Restore numerical variables *
3297 *************************************************/
3299 /* This function restored saved values of numerical strings.
3302 save_expand_nmax the number of strings to restore
3303 save_expand_string points to an array of pointers
3304 save_expand_nlength points to an array of ints
3310 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3311 int *save_expand_nlength)
3313 expand_nmax = save_expand_nmax;
3314 for (int i = 0; i <= expand_nmax; i++)
3316 expand_nstring[i] = save_expand_nstring[i];
3317 expand_nlength[i] = save_expand_nlength[i];
3325 /*************************************************
3326 * Handle yes/no substrings *
3327 *************************************************/
3329 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3330 alternative substrings that depend on whether or not the condition was true,
3331 or the lookup or extraction succeeded. The substrings always have to be
3332 expanded, to check their syntax, but "skipping" is set when the result is not
3333 needed - this avoids unnecessary nested lookups.
3336 skipping TRUE if we were skipping when this item was reached
3337 yes TRUE if the first string is to be used, else use the second
3338 save_lookup a value to put back into lookup_value before the 2nd expansion
3339 sptr points to the input string pointer
3340 yieldptr points to the output growable-string pointer
3341 type "lookup", "if", "extract", "run", "env", "listextract" or
3342 "certextract" for error message
3343 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3346 Returns: 0 OK; lookup_value has been reset to save_lookup
3348 2 expansion failed because of bracketing error
3352 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3353 gstring ** yieldptr, uschar *type, BOOL *resetok)
3356 const uschar *s = *sptr; /* Local value */
3357 uschar *sub1, *sub2;
3358 const uschar * errwhere;
3360 /* If there are no following strings, we substitute the contents of $value for
3361 lookups and for extractions in the success case. For the ${if item, the string
3362 "true" is substituted. In the fail case, nothing is substituted for all three
3365 while (isspace(*s)) s++;
3370 if (yes && !skipping)
3371 *yieldptr = string_catn(*yieldptr, US"true", 4);
3375 if (yes && lookup_value && !skipping)
3376 *yieldptr = string_cat(*yieldptr, lookup_value);
3377 lookup_value = save_lookup;
3383 /* The first following string must be braced. */
3387 errwhere = US"'yes' part did not start with '{'";
3391 /* Expand the first substring. Forced failures are noticed only if we actually
3392 want this string. Set skipping in the call in the fail case (this will always
3393 be the case if we were already skipping). */
3395 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3396 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3397 f.expand_string_forcedfail = FALSE;
3400 errwhere = US"'yes' part did not end with '}'";
3404 /* If we want the first string, add it to the output */
3407 *yieldptr = string_cat(*yieldptr, sub1);
3409 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3410 $value to what it was at the start of the item, so that it has this value
3411 during the second string expansion. For the call from "if" or "run" to this
3412 function, save_lookup is set to lookup_value, so that this statement does
3415 lookup_value = save_lookup;
3417 /* There now follows either another substring, or "fail", or nothing. This
3418 time, forced failures are noticed only if we want the second string. We must
3419 set skipping in the nested call if we don't want this string, or if we were
3420 already skipping. */
3422 while (isspace(*s)) s++;
3425 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3426 if (sub2 == NULL && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3427 f.expand_string_forcedfail = FALSE;
3430 errwhere = US"'no' part did not start with '{'";
3434 /* If we want the second string, add it to the output */
3437 *yieldptr = string_cat(*yieldptr, sub2);
3440 /* If there is no second string, but the word "fail" is present when the use of
3441 the second string is wanted, set a flag indicating it was a forced failure
3442 rather than a syntactic error. Swallow the terminating } in case this is nested
3443 inside another lookup or if or extract. */
3448 /* deconst cast ok here as source is s anyway */
3449 s = US read_name(name, sizeof(name), s, US"_");
3450 if (Ustrcmp(name, "fail") == 0)
3452 if (!yes && !skipping)
3454 while (isspace(*s)) s++;
3457 errwhere = US"did not close with '}' after forcedfail";
3460 expand_string_message =
3461 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3462 f.expand_string_forcedfail = TRUE;
3468 expand_string_message =
3469 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3474 /* All we have to do now is to check on the final closing brace. */
3476 while (isspace(*s)) s++;
3479 errwhere = US"did not close with '}'";
3485 /* Update the input pointer value before returning */
3490 /* Get here if there is a bracketing failure */
3491 expand_string_message = string_sprintf(
3492 "curly-bracket problem in conditional yes/no parsing: %s\n"
3493 " remaining string is '%s'", errwhere, --s);
3498 /* Get here for other failures */
3506 /*************************************************
3507 * Handle MD5 or SHA-1 computation for HMAC *
3508 *************************************************/
3510 /* These are some wrapping functions that enable the HMAC code to be a bit
3511 cleaner. A good compiler will spot the tail recursion.
3514 type HMAC_MD5 or HMAC_SHA1
3515 remaining are as for the cryptographic hash functions
3521 chash_start(int type, void * base)
3523 if (type == HMAC_MD5)
3524 md5_start((md5 *)base);
3526 sha1_start((hctx *)base);
3530 chash_mid(int type, void * base, const uschar * string)
3532 if (type == HMAC_MD5)
3533 md5_mid((md5 *)base, string);
3535 sha1_mid((hctx *)base, string);
3539 chash_end(int type, void * base, const uschar * string, int length,
3542 if (type == HMAC_MD5)
3543 md5_end((md5 *)base, string, length, digest);
3545 sha1_end((hctx *)base, string, length, digest);
3552 /********************************************************
3553 * prvs: Get last three digits of days since Jan 1, 1970 *
3554 ********************************************************/
3556 /* This is needed to implement the "prvs" BATV reverse
3559 Argument: integer "days" offset to add or substract to
3560 or from the current number of days.
3562 Returns: pointer to string containing the last three
3563 digits of the number of days since Jan 1, 1970,
3564 modified by the offset argument, NULL if there
3565 was an error in the conversion.
3570 prvs_daystamp(int day_offset)
3572 uschar *days = store_get(32, FALSE); /* Need at least 24 for cases */
3573 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3574 (time(NULL) + day_offset*86400)/86400);
3575 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3580 /********************************************************
3581 * prvs: perform HMAC-SHA1 computation of prvs bits *
3582 ********************************************************/
3584 /* This is needed to implement the "prvs" BATV reverse
3588 address RFC2821 Address to use
3589 key The key to use (must be less than 64 characters
3591 key_num Single-digit key number to use. Defaults to
3594 Returns: pointer to string containing the first three
3595 bytes of the final hash in hex format, NULL if
3596 there was an error in the process.
3600 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3602 gstring * hash_source;
3605 uschar innerhash[20];
3606 uschar finalhash[20];
3607 uschar innerkey[64];
3608 uschar outerkey[64];
3609 uschar *finalhash_hex;
3611 if (key_num == NULL)
3614 if (Ustrlen(key) > 64)
3617 hash_source = string_catn(NULL, key_num, 1);
3618 hash_source = string_catn(hash_source, daystamp, 3);
3619 hash_source = string_cat(hash_source, address);
3620 (void) string_from_gstring(hash_source);
3623 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3625 memset(innerkey, 0x36, 64);
3626 memset(outerkey, 0x5c, 64);
3628 for (int i = 0; i < Ustrlen(key); i++)
3630 innerkey[i] ^= key[i];
3631 outerkey[i] ^= key[i];
3634 chash_start(HMAC_SHA1, &h);
3635 chash_mid(HMAC_SHA1, &h, innerkey);
3636 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3638 chash_start(HMAC_SHA1, &h);
3639 chash_mid(HMAC_SHA1, &h, outerkey);
3640 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3642 /* Hashing is deemed sufficient to de-taint any input data */
3644 p = finalhash_hex = store_get(40, FALSE);
3645 for (int i = 0; i < 3; i++)
3647 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3648 *p++ = hex_digits[finalhash[i] & 0x0f];
3652 return finalhash_hex;
3658 /*************************************************
3659 * Join a file onto the output string *
3660 *************************************************/
3662 /* This is used for readfile/readsock and after a run expansion.
3663 It joins the contents of a file onto the output string, globally replacing
3664 newlines with a given string (optionally).
3668 yield pointer to the expandable string struct
3669 eol newline replacement string, or NULL
3671 Returns: new pointer for expandable string, terminated if non-null
3675 cat_file(FILE *f, gstring *yield, uschar *eol)
3677 uschar buffer[1024];
3679 while (Ufgets(buffer, sizeof(buffer), f))
3681 int len = Ustrlen(buffer);
3682 if (eol && buffer[len-1] == '\n') len--;
3683 yield = string_catn(yield, buffer, len);
3684 if (eol && buffer[len])
3685 yield = string_cat(yield, eol);
3688 (void) string_from_gstring(yield);
3695 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
3698 uschar buffer[1024];
3700 /*XXX could we read direct into a pre-grown string? */
3702 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
3703 for (uschar * s = buffer; rc--; s++)
3704 yield = eol && *s == '\n'
3705 ? string_cat(yield, eol) : string_catn(yield, s, 1);
3707 /* We assume that all errors, and any returns of zero bytes,
3708 are actually EOF. */
3710 (void) string_from_gstring(yield);
3716 /*************************************************
3717 * Evaluate numeric expression *
3718 *************************************************/
3720 /* This is a set of mutually recursive functions that evaluate an arithmetic
3721 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3722 these functions that is called from elsewhere is eval_expr, whose interface is:
3725 sptr pointer to the pointer to the string - gets updated
3726 decimal TRUE if numbers are to be assumed decimal
3727 error pointer to where to put an error message - must be NULL on input
3728 endket TRUE if ')' must terminate - FALSE for external call
3730 Returns: on success: the value of the expression, with *error still NULL
3731 on failure: an undefined value, with *error = a message
3734 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3737 static int_eximarith_t
3738 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3741 int_eximarith_t x = eval_op_or(&s, decimal, error);
3746 *error = US"expecting closing parenthesis";
3748 while (isspace(*(++s)));
3750 *error = US"expecting operator";
3756 static int_eximarith_t
3757 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3763 while (isspace(*s)) s++;
3764 if (isdigit((c = *s)))
3767 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3769 switch (tolower(*s))
3772 case 'k': n *= 1024; s++; break;
3773 case 'm': n *= 1024*1024; s++; break;
3774 case 'g': n *= 1024*1024*1024; s++; break;
3776 while (isspace (*s)) s++;
3781 n = eval_expr(&s, decimal, error, 1);
3785 *error = US"expecting number or opening parenthesis";
3793 static int_eximarith_t
3794 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3798 while (isspace(*s)) s++;
3799 if (*s == '+' || *s == '-' || *s == '~')
3802 x = eval_op_unary(&s, decimal, error);
3803 if (op == '-') x = -x;
3804 else if (op == '~') x = ~x;
3807 x = eval_number(&s, decimal, error);
3814 static int_eximarith_t
3815 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3818 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3821 while (*s == '*' || *s == '/' || *s == '%')
3824 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3825 if (*error != NULL) break;
3826 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3827 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3828 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3829 * -N*M is INT_MIN will yield INT_MIN.
3830 * Since we don't support floating point, this is somewhat simpler.
3831 * Ideally, we'd return an error, but since we overflow for all other
3832 * arithmetic, consistency suggests otherwise, but what's the correct value
3833 * to use? There is none.
3834 * The C standard guarantees overflow for unsigned arithmetic but signed
3835 * overflow invokes undefined behaviour; in practice, this is overflow
3836 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3837 * that long/longlong larger than int are available, or we could just work
3838 * with larger types. We should consider whether to guarantee 32bit eval
3839 * and 64-bit working variables, with errors returned. For now ...
3840 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3841 * can just let the other invalid results occur otherwise, as they have
3842 * until now. For this one case, we can coerce.
3844 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3847 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3848 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3858 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3874 static int_eximarith_t
3875 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3878 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3881 while (*s == '+' || *s == '-')
3884 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3886 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3887 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3888 { /* over-conservative check */
3890 ? US"overflow in sum" : US"overflow in difference";
3893 if (op == '+') x += y; else x -= y;
3901 static int_eximarith_t
3902 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3905 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3908 while ((*s == '<' || *s == '>') && s[1] == s[0])
3913 y = eval_op_sum(&s, decimal, error);
3914 if (*error != NULL) break;
3915 if (op == '<') x <<= y; else x >>= y;
3923 static int_eximarith_t
3924 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3927 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3934 y = eval_op_shift(&s, decimal, error);
3935 if (*error != NULL) break;
3944 static int_eximarith_t
3945 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3948 int_eximarith_t x = eval_op_and(&s, decimal, error);
3955 y = eval_op_and(&s, decimal, error);
3956 if (*error != NULL) break;
3965 static int_eximarith_t
3966 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3969 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3976 y = eval_op_xor(&s, decimal, error);
3977 if (*error != NULL) break;
3987 /************************************************/
3988 /* Comparison operation for sort expansion. We need to avoid
3989 re-expanding the fields being compared, so need a custom routine.
3992 cond_type Comparison operator code
3993 leftarg, rightarg Arguments for comparison
3995 Return true iff (leftarg compare rightarg)
3999 sortsbefore(int cond_type, BOOL alpha_cond,
4000 const uschar * leftarg, const uschar * rightarg)
4002 int_eximarith_t l_num, r_num;
4006 l_num = expanded_string_integer(leftarg, FALSE);
4007 if (expand_string_message) return FALSE;
4008 r_num = expanded_string_integer(rightarg, FALSE);
4009 if (expand_string_message) return FALSE;
4013 case ECOND_NUM_G: return l_num > r_num;
4014 case ECOND_NUM_GE: return l_num >= r_num;
4015 case ECOND_NUM_L: return l_num < r_num;
4016 case ECOND_NUM_LE: return l_num <= r_num;
4023 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;
4024 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;
4025 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;
4026 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4027 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;
4028 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;
4029 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;
4030 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4033 return FALSE; /* should not happen */
4037 /*************************************************
4039 *************************************************/
4041 /* Returns either an unchanged string, or the expanded string in stacking pool
4042 store. Interpreted sequences are:
4044 \... normal escaping rules
4045 $name substitutes the variable
4047 ${op:string} operates on the expanded string value
4048 ${item{arg1}{arg2}...} expands the args and then does the business
4049 some literal args are not enclosed in {}
4051 There are now far too many operators and item types to make it worth listing
4052 them here in detail any more.
4054 We use an internal routine recursively to handle embedded substrings. The
4055 external function follows. The yield is NULL if the expansion failed, and there
4056 are two cases: if something collapsed syntactically, or if "fail" was given
4057 as the action on a lookup failure. These can be distinguished by looking at the
4058 variable expand_string_forcedfail, which is TRUE in the latter case.
4060 The skipping flag is set true when expanding a substring that isn't actually
4061 going to be used (after "if" or "lookup") and it prevents lookups from
4062 happening lower down.
4064 Store usage: At start, a store block of the length of the input plus 64
4065 is obtained. This is expanded as necessary by string_cat(), which might have to
4066 get a new block, or might be able to expand the original. At the end of the
4067 function we can release any store above that portion of the yield block that
4068 was actually used. In many cases this will be optimal.
4070 However: if the first item in the expansion is a variable name or header name,
4071 we reset the store before processing it; if the result is in fresh store, we
4072 use that without copying. This is helpful for expanding strings like
4073 $message_headers which can get very long.
4075 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4076 since resetting the store at the end of the expansion will free store that was
4077 allocated by the plugin code as well as the slop after the expanded string. So
4078 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4079 and, given the acl condition, ${if }. This is an unfortunate consequence of
4080 string expansion becoming too powerful.
4083 string the string to be expanded
4084 ket_ends true if expansion is to stop at }
4085 left if not NULL, a pointer to the first character after the
4086 expansion is placed here (typically used with ket_ends)
4087 skipping TRUE for recursive calls when the value isn't actually going
4088 to be used (to allow for optimisation)
4089 honour_dollar TRUE if $ is to be expanded,
4090 FALSE if it's just another character
4091 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4094 Returns: NULL if expansion fails:
4095 expand_string_forcedfail is set TRUE if failure was forced
4096 expand_string_message contains a textual error message
4097 a pointer to the expanded string on success
4101 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
4102 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
4104 rmark reset_point = store_mark();
4105 gstring * yield = string_get(Ustrlen(string) + 64);
4107 const uschar *s = string;
4108 uschar *save_expand_nstring[EXPAND_MAXN+1];
4109 int save_expand_nlength[EXPAND_MAXN+1];
4110 BOOL resetok = TRUE;
4115 debug_printf_indent("/%s: %s\n",
4116 skipping ? "---scanning" : "considering", string);
4118 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
4120 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4124 f.expand_string_forcedfail = FALSE;
4125 expand_string_message = US"";
4127 if (is_tainted(string))
4129 expand_string_message =
4130 string_sprintf("attempt to expand tainted string '%s'", s);
4131 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4140 /* \ escapes the next character, which must exist, or else
4141 the expansion fails. There's a special escape, \N, which causes
4142 copying of the subject verbatim up to the next \N. Otherwise,
4143 the escapes are the standard set. */
4149 expand_string_message = US"\\ at end of string";
4155 const uschar * t = s + 2;
4156 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
4157 yield = string_catn(yield, t, s - t);
4158 if (*s != 0) s += 2;
4164 ch[0] = string_interpret_escape(&s);
4166 yield = string_catn(yield, ch, 1);
4173 /* Anything other than $ is just copied verbatim, unless we are
4174 looking for a terminating } character. */
4177 if (ket_ends && *s == '}') break;
4179 if (*s != '$' || !honour_dollar)
4181 yield = string_catn(yield, s++, 1);
4185 /* No { after the $ - must be a plain name or a number for string
4186 match variable. There has to be a fudge for variables that are the
4187 names of header fields preceded by "$header_" because header field
4188 names can contain any printing characters except space and colon.
4189 For those that don't like typing this much, "$h_" is a synonym for
4190 "$header_". A non-existent header yields a NULL value; nothing is
4193 if (isalpha((*(++s))))
4200 s = read_name(name, sizeof(name), s, US"_");
4202 /* If this is the first thing to be expanded, release the pre-allocated
4206 g = store_get(sizeof(gstring), FALSE);
4207 else if (yield->ptr == 0)
4209 if (resetok) reset_point = store_reset(reset_point);
4211 reset_point = store_mark();
4212 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
4217 if ( ( *(t = name) == 'h'
4218 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4220 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4223 unsigned flags = *name == 'r' ? FH_WANT_RAW
4224 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4226 uschar * charset = *name == 'b' ? NULL : headers_charset;
4228 s = read_header_name(name, sizeof(name), s);
4229 value = find_header(name, &newsize, flags, charset);
4231 /* If we didn't find the header, and the header contains a closing brace
4232 character, this may be a user error where the terminating colon
4233 has been omitted. Set a flag to adjust the error message in this case.
4234 But there is no error here - nothing gets inserted. */
4238 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
4245 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4247 expand_string_message =
4248 string_sprintf("unknown variable name \"%s\"", name);
4249 check_variable_error_message(name);
4253 /* If the data is known to be in a new buffer, newsize will be set to the
4254 size of that buffer. If this is the first thing in an expansion string,
4255 yield will be NULL; just point it at the new store instead of copying. Many
4256 expansion strings contain just one reference, so this is a useful
4257 optimization, especially for humungous headers. We need to use a gstring
4258 structure that is not allocated after that new-buffer, else a later store
4259 reset in the middle of the buffer will make it inaccessible. */
4261 len = Ustrlen(value);
4262 if (!yield && newsize != 0)
4265 yield->size = newsize;
4270 yield = string_catn(yield, value, len);
4278 s = read_cnumber(&n, s);
4279 if (n >= 0 && n <= expand_nmax)
4280 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4284 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4286 if (*s != '{') /*}*/
4288 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4292 /* After { there can be various things, but they all start with
4293 an initial word, except for a number for a string match variable. */
4295 if (isdigit((*(++s))))
4298 s = read_cnumber(&n, s); /*{*/
4301 expand_string_message = US"} expected after number";
4304 if (n >= 0 && n <= expand_nmax)
4305 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4311 expand_string_message = US"letter or digit expected after ${"; /*}*/
4315 /* Allow "-" in names to cater for substrings with negative
4316 arguments. Since we are checking for known names after { this is
4319 s = read_name(name, sizeof(name), s, US"_-");
4320 item_type = chop_match(name, item_table, nelem(item_table));
4324 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4325 If the ACL returns accept or reject we return content set by "message ="
4326 There is currently no limit on recursion; this would have us call
4327 acl_check_internal() directly and get a current level from somewhere.
4328 See also the acl expansion condition ECOND_ACL and the traditional
4329 acl modifier ACLC_ACL.
4330 Assume that the function has side-effects on the store that must be preserved.
4334 /* ${acl {name} {arg1}{arg2}...} */
4336 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4340 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4343 case 1: goto EXPAND_FAILED_CURLY;
4345 case 3: goto EXPAND_FAILED;
4347 if (skipping) continue;
4350 switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4355 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4357 yield = string_cat(yield, user_msg);
4361 f.expand_string_forcedfail = TRUE;
4364 expand_string_message = string_sprintf("%s from acl \"%s\"",
4365 rc_names[rc], sub[0]);
4370 case EITEM_AUTHRESULTS:
4371 /* ${authresults {mysystemname}} */
4375 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4378 case 1: goto EXPAND_FAILED_CURLY;
4380 case 3: goto EXPAND_FAILED;
4383 yield = string_append(yield, 3,
4384 US"Authentication-Results: ", sub_arg[0], US"; none");
4387 yield = authres_local(yield, sub_arg[0]);
4388 yield = authres_iprev(yield);
4389 yield = authres_smtpauth(yield);
4391 yield = authres_spf(yield);
4393 #ifndef DISABLE_DKIM
4394 yield = authres_dkim(yield);
4396 #ifdef SUPPORT_DMARC
4397 yield = authres_dmarc(yield);
4399 #ifdef EXPERIMENTAL_ARC
4400 yield = authres_arc(yield);
4405 /* Handle conditionals - preserve the values of the numerical expansion
4406 variables in case they get changed by a regular expression match in the
4407 condition. If not, they retain their external settings. At the end
4408 of this "if" section, they get restored to their previous values. */
4413 const uschar *next_s;
4414 int save_expand_nmax =
4415 save_expand_strings(save_expand_nstring, save_expand_nlength);
4417 while (isspace(*s)) s++;
4418 next_s = eval_condition(s, &resetok, skipping ? NULL : &cond);
4419 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4424 debug_printf_indent("|--condition: %.*s\n", (int)(next_s - s), s);
4425 debug_printf_indent("|-----result: %s\n", cond ? "true" : "false");
4429 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4430 "condition: %.*s\n",
4431 (int)(next_s - s), s);
4432 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4433 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4435 cond ? "true" : "false");
4440 /* The handling of "yes" and "no" result strings is now in a separate
4441 function that is also used by ${lookup} and ${extract} and ${run}. */
4443 switch(process_yesno(
4444 skipping, /* were previously skipping */
4445 cond, /* success/failure indicator */
4446 lookup_value, /* value to reset for string2 */
4447 &s, /* input pointer */
4448 &yield, /* output pointer */
4449 US"if", /* condition type */
4452 case 1: goto EXPAND_FAILED; /* when all is well, the */
4453 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4456 /* Restore external setting of expansion variables for continuation
4459 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4460 save_expand_nlength);
4465 case EITEM_IMAPFOLDER:
4466 { /* ${imapfolder {name}{sep]{specials}} */
4470 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4473 case 1: goto EXPAND_FAILED_CURLY;
4475 case 3: goto EXPAND_FAILED;
4478 if (sub_arg[1] == NULL) /* One argument */
4480 sub_arg[1] = US"/"; /* default separator */
4483 else if (Ustrlen(sub_arg[1]) != 1)
4485 expand_string_message =
4487 "IMAP folder separator must be one character, found \"%s\"",
4494 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4495 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4497 yield = string_cat(yield, encoded);
4503 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4504 expanding an internal string that isn't actually going to be used. All we
4505 need to do is check the syntax, so don't do a lookup at all. Preserve the
4506 values of the numerical expansion variables in case they get changed by a
4507 partial lookup. If not, they retain their external settings. At the end
4508 of this "lookup" section, they get restored to their previous values. */
4512 int stype, partial, affixlen, starflags;
4513 int expand_setup = 0;
4515 uschar *key, *filename;
4516 const uschar *affix;
4517 uschar *save_lookup_value = lookup_value;
4518 int save_expand_nmax =
4519 save_expand_strings(save_expand_nstring, save_expand_nlength);
4521 if ((expand_forbid & RDO_LOOKUP) != 0)
4523 expand_string_message = US"lookup expansions are not permitted";
4527 /* Get the key we are to look up for single-key+file style lookups.
4528 Otherwise set the key NULL pro-tem. */
4530 while (isspace(*s)) s++;
4531 if (*s == '{') /*}*/
4533 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4534 if (!key) goto EXPAND_FAILED; /*{{*/
4537 expand_string_message = US"missing '}' after lookup key";
4538 goto EXPAND_FAILED_CURLY;
4540 while (isspace(*s)) s++;
4544 /* Find out the type of database */
4548 expand_string_message = US"missing lookup type";
4552 /* The type is a string that may contain special characters of various
4553 kinds. Allow everything except space or { to appear; the actual content
4554 is checked by search_findtype_partial. */ /*}*/
4556 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4558 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4562 while (isspace(*s)) s++;
4564 /* Now check for the individual search type and any partial or default
4565 options. Only those types that are actually in the binary are valid. */
4567 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4571 expand_string_message = search_error_message;
4575 /* Check that a key was provided for those lookup types that need it,
4576 and was not supplied for those that use the query style. */
4578 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4582 expand_string_message = string_sprintf("missing {key} for single-"
4583 "key \"%s\" lookup", name);
4591 expand_string_message = string_sprintf("a single key was given for "
4592 "lookup type \"%s\", which is not a single-key lookup type", name);
4597 /* Get the next string in brackets and expand it. It is the file name for
4598 single-key+file lookups, and the whole query otherwise. In the case of
4599 queries that also require a file name (e.g. sqlite), the file name comes
4604 expand_string_message = US"missing '{' for lookup file-or-query arg";
4605 goto EXPAND_FAILED_CURLY;
4607 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4608 if (filename == NULL) goto EXPAND_FAILED;
4611 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4612 goto EXPAND_FAILED_CURLY;
4614 while (isspace(*s)) s++;
4616 /* If this isn't a single-key+file lookup, re-arrange the variables
4617 to be appropriate for the search_ functions. For query-style lookups,
4618 there is just a "key", and no file name. For the special query-style +
4619 file types, the query (i.e. "key") starts with a file name. */
4623 while (isspace(*filename)) filename++;
4626 if (mac_islookup(stype, lookup_querystyle))
4630 if (*filename != '/')
4632 expand_string_message = string_sprintf(
4633 "absolute file name expected for \"%s\" lookup", name);
4636 while (*key != 0 && !isspace(*key)) key++;
4637 if (*key != 0) *key++ = 0;
4641 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4642 the entry was not found. Note that there is no search_close() function.
4643 Files are left open in case of re-use. At suitable places in higher logic,
4644 search_tidyup() is called to tidy all open files. This can save opening
4645 the same file several times. However, files may also get closed when
4646 others are opened, if too many are open at once. The rule is that a
4647 handle should not be used after a second search_open().
4649 Request that a partial search sets up $1 and maybe $2 by passing
4650 expand_setup containing zero. If its value changes, reset expand_nmax,
4651 since new variables will have been set. Note that at the end of this
4652 "lookup" section, the old numeric variables are restored. */
4655 lookup_value = NULL;
4658 void *handle = search_open(filename, stype, 0, NULL, NULL);
4661 expand_string_message = search_error_message;
4664 lookup_value = search_find(handle, filename, key, partial, affix,
4665 affixlen, starflags, &expand_setup);
4666 if (f.search_find_defer)
4668 expand_string_message =
4669 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4670 string_printing2(key, FALSE), search_error_message);
4673 if (expand_setup > 0) expand_nmax = expand_setup;
4676 /* The handling of "yes" and "no" result strings is now in a separate
4677 function that is also used by ${if} and ${extract}. */
4679 switch(process_yesno(
4680 skipping, /* were previously skipping */
4681 lookup_value != NULL, /* success/failure indicator */
4682 save_lookup_value, /* value to reset for string2 */
4683 &s, /* input pointer */
4684 &yield, /* output pointer */
4685 US"lookup", /* condition type */
4688 case 1: goto EXPAND_FAILED; /* when all is well, the */
4689 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4692 /* Restore external setting of expansion variables for carrying on
4693 at this level, and continue. */
4695 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4696 save_expand_nlength);
4700 /* If Perl support is configured, handle calling embedded perl subroutines,
4701 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4702 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4703 arguments (defined below). */
4705 #define EXIM_PERL_MAX_ARGS 8
4709 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4710 "is not included in this binary";
4713 #else /* EXIM_PERL */
4715 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4718 if ((expand_forbid & RDO_PERL) != 0)
4720 expand_string_message = US"Perl calls are not permitted";
4724 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4725 US"perl", &resetok))
4727 case 1: goto EXPAND_FAILED_CURLY;
4729 case 3: goto EXPAND_FAILED;
4732 /* If skipping, we don't actually do anything */
4734 if (skipping) continue;
4736 /* Start the interpreter if necessary */
4738 if (!opt_perl_started)
4741 if (opt_perl_startup == NULL)
4743 expand_string_message = US"A setting of perl_startup is needed when "
4744 "using the Perl interpreter";
4747 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4748 initerror = init_perl(opt_perl_startup);
4749 if (initerror != NULL)
4751 expand_string_message =
4752 string_sprintf("error in perl_startup code: %s\n", initerror);
4755 opt_perl_started = TRUE;
4758 /* Call the function */
4760 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4761 new_yield = call_perl_cat(yield, &expand_string_message,
4762 sub_arg[0], sub_arg + 1);
4764 /* NULL yield indicates failure; if the message pointer has been set to
4765 NULL, the yield was undef, indicating a forced failure. Otherwise the
4766 message will indicate some kind of Perl error. */
4768 if (new_yield == NULL)
4770 if (expand_string_message == NULL)
4772 expand_string_message =
4773 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4774 "failure", sub_arg[0]);
4775 f.expand_string_forcedfail = TRUE;
4780 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4781 set during a callback from Perl. */
4783 f.expand_string_forcedfail = FALSE;
4787 #endif /* EXIM_PERL */
4789 /* Transform email address to "prvs" scheme to use
4790 as BATV-signed return path */
4797 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4799 case 1: goto EXPAND_FAILED_CURLY;
4801 case 3: goto EXPAND_FAILED;
4804 /* If skipping, we don't actually do anything */
4805 if (skipping) continue;
4807 /* sub_arg[0] is the address */
4808 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
4809 || domain == sub_arg[0] || Ustrlen(domain) == 1)
4811 expand_string_message = US"prvs first argument must be a qualified email address";
4815 /* Calculate the hash. The third argument must be a single-digit
4816 key number, or unset. */
4819 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4821 expand_string_message = US"prvs third argument must be a single digit";
4825 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
4828 expand_string_message = US"prvs hmac-sha1 conversion failed";
4832 /* Now separate the domain from the local part */
4835 yield = string_catn(yield, US"prvs=", 5);
4836 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
4837 yield = string_catn(yield, prvs_daystamp(7), 3);
4838 yield = string_catn(yield, p, 6);
4839 yield = string_catn(yield, US"=", 1);
4840 yield = string_cat (yield, sub_arg[0]);
4841 yield = string_catn(yield, US"@", 1);
4842 yield = string_cat (yield, domain);
4847 /* Check a prvs-encoded address for validity */
4849 case EITEM_PRVSCHECK:
4856 /* TF: Ugliness: We want to expand parameter 1 first, then set
4857 up expansion variables that are used in the expansion of
4858 parameter 2. So we clone the string for the first
4859 expansion, where we only expand parameter 1.
4861 PH: Actually, that isn't necessary. The read_subs() function is
4862 designed to work this way for the ${if and ${lookup expansions. I've
4866 /* Reset expansion variables */
4867 prvscheck_result = NULL;
4868 prvscheck_address = NULL;
4869 prvscheck_keynum = NULL;
4871 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4873 case 1: goto EXPAND_FAILED_CURLY;
4875 case 3: goto EXPAND_FAILED;
4878 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4881 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4883 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4884 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4885 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4886 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4887 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4889 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
4890 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
4891 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
4892 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
4893 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
4895 /* Set up expansion variables */
4896 g = string_cat (NULL, local_part);
4897 g = string_catn(g, US"@", 1);
4898 g = string_cat (g, domain);
4899 prvscheck_address = string_from_gstring(g);
4900 prvscheck_keynum = string_copy(key_num);
4902 /* Now expand the second argument */
4903 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4905 case 1: goto EXPAND_FAILED_CURLY;
4907 case 3: goto EXPAND_FAILED;
4910 /* Now we have the key and can check the address. */
4912 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4917 expand_string_message = US"hmac-sha1 conversion failed";
4921 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
4922 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
4924 if (Ustrcmp(p,hash) == 0)
4926 /* Success, valid BATV address. Now check the expiry date. */
4927 uschar *now = prvs_daystamp(0);
4928 unsigned int inow = 0,iexpire = 1;
4930 (void)sscanf(CS now,"%u",&inow);
4931 (void)sscanf(CS daystamp,"%u",&iexpire);
4933 /* When "iexpire" is < 7, a "flip" has occurred.
4934 Adjust "inow" accordingly. */
4935 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4937 if (iexpire >= inow)
4939 prvscheck_result = US"1";
4940 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
4944 prvscheck_result = NULL;
4945 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
4950 prvscheck_result = NULL;
4951 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
4954 /* Now expand the final argument. We leave this till now so that
4955 it can include $prvscheck_result. */
4957 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4959 case 1: goto EXPAND_FAILED_CURLY;
4961 case 3: goto EXPAND_FAILED;
4964 yield = string_cat(yield,
4965 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4967 /* Reset the "internal" variables afterwards, because they are in
4968 dynamic store that will be reclaimed if the expansion succeeded. */
4970 prvscheck_address = NULL;
4971 prvscheck_keynum = NULL;
4974 /* Does not look like a prvs encoded address, return the empty string.
4975 We need to make sure all subs are expanded first, so as to skip over
4978 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4980 case 1: goto EXPAND_FAILED_CURLY;
4982 case 3: goto EXPAND_FAILED;
4988 /* Handle "readfile" to insert an entire file */
4990 case EITEM_READFILE:
4995 if ((expand_forbid & RDO_READFILE) != 0)
4997 expand_string_message = US"file insertions are not permitted";
5001 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
5003 case 1: goto EXPAND_FAILED_CURLY;
5005 case 3: goto EXPAND_FAILED;
5008 /* If skipping, we don't actually do anything */
5010 if (skipping) continue;
5012 /* Open the file and read it */
5014 if (!(f = Ufopen(sub_arg[0], "rb")))
5016 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
5020 yield = cat_file(f, yield, sub_arg[1]);
5025 /* Handle "readsocket" to insert data from a socket, either
5026 Inet or Unix domain */
5028 case EITEM_READSOCK:
5030 client_conn_ctx cctx;
5032 int save_ptr = yield->ptr;
5035 uschar * sub_arg[4];
5036 uschar * server_name = NULL;
5038 BOOL do_shutdown = TRUE;
5039 BOOL do_tls = FALSE; /* Only set under ! DISABLE_TLS */
5042 if (expand_forbid & RDO_READSOCK)
5044 expand_string_message = US"socket insertions are not permitted";
5048 /* Read up to 4 arguments, but don't do the end of item check afterwards,
5049 because there may be a string for expansion on failure. */
5051 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
5053 case 1: goto EXPAND_FAILED_CURLY;
5054 case 2: /* Won't occur: no end check */
5055 case 3: goto EXPAND_FAILED;
5058 /* Grab the request string, if any */
5060 reqstr.data = sub_arg[1];
5061 reqstr.len = Ustrlen(sub_arg[1]);
5063 /* Sort out timeout, if given. The second arg is a list with the first element
5064 being a time value. Any more are options of form "name=value". Currently the
5065 only option recognised is "shutdown". */
5069 const uschar * list = sub_arg[2];
5073 item = string_nextinlist(&list, &sep, NULL, 0);
5074 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
5076 expand_string_message = string_sprintf("bad time value %s", item);
5080 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5081 if (Ustrncmp(item, US"shutdown=", 9) == 0)
5082 { if (Ustrcmp(item + 9, US"no") == 0) do_shutdown = FALSE; }
5084 else if (Ustrncmp(item, US"tls=", 4) == 0)
5085 { if (Ustrcmp(item + 9, US"no") != 0) do_tls = TRUE; }
5089 sub_arg[3] = NULL; /* No eol if no timeout */
5091 /* If skipping, we don't actually do anything. Otherwise, arrange to
5092 connect to either an IP or a Unix socket. */
5096 /* Handle an IP (internet) domain */
5098 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
5103 server_name = sub_arg[0] + 5;
5104 port_name = Ustrrchr(server_name, ':');
5106 /* Sort out the port */
5110 expand_string_message =
5111 string_sprintf("missing port for readsocket %s", sub_arg[0]);
5114 *port_name++ = 0; /* Terminate server name */
5116 if (isdigit(*port_name))
5119 port = Ustrtol(port_name, &end, 0);
5120 if (end != port_name + Ustrlen(port_name))
5122 expand_string_message =
5123 string_sprintf("invalid port number %s", port_name);
5129 struct servent *service_info = getservbyname(CS port_name, "tcp");
5132 expand_string_message = string_sprintf("unknown port \"%s\"",
5136 port = ntohs(service_info->s_port);
5139 /*XXX we trust that the request is idempotent for TFO. Hmm. */
5140 cctx.sock = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
5141 timeout, &host, &expand_string_message,
5142 do_tls ? NULL : &reqstr);
5143 callout_address = NULL;
5150 /* Handle a Unix domain socket */
5154 struct sockaddr_un sockun; /* don't call this "sun" ! */
5157 if ((cctx.sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
5159 expand_string_message = string_sprintf("failed to create socket: %s",
5164 sockun.sun_family = AF_UNIX;
5165 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
5167 server_name = US sockun.sun_path;
5169 sigalrm_seen = FALSE;
5171 rc = connect(cctx.sock, (struct sockaddr *)(&sockun), sizeof(sockun));
5175 expand_string_message = US "socket connect timed out";
5180 expand_string_message = string_sprintf("failed to connect to socket "
5181 "%s: %s", sub_arg[0], strerror(errno));
5184 host.name = server_name;
5185 host.address = US"";
5188 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
5193 smtp_connect_args conn_args = {.host = &host };
5194 tls_support tls_dummy = {.sni=NULL};
5197 if (!tls_client_start(&cctx, &conn_args, NULL, &tls_dummy, &errstr))
5199 expand_string_message = string_sprintf("TLS connect failed: %s", errstr);
5205 /* Allow sequencing of test actions */
5206 testharness_pause_ms(100);
5208 /* Write the request string, if not empty or already done */
5212 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
5216 do_tls ? tls_write(cctx.tls_ctx, reqstr.data, reqstr.len, FALSE) :
5218 write(cctx.sock, reqstr.data, reqstr.len)) != reqstr.len)
5220 expand_string_message = string_sprintf("request write to socket "
5221 "failed: %s", strerror(errno));
5226 /* Shut down the sending side of the socket. This helps some servers to
5227 recognise that it is their turn to do some work. Just in case some
5228 system doesn't have this function, make it conditional. */
5231 if (!do_tls && do_shutdown) shutdown(cctx.sock, SHUT_WR);
5234 testharness_pause_ms(100);
5236 /* Now we need to read from the socket, under a timeout. The function
5237 that reads a file can be used. */
5240 fp = fdopen(cctx.sock, "rb");
5241 sigalrm_seen = FALSE;
5245 do_tls ? cat_file_tls(cctx.tls_ctx, yield, sub_arg[3]) :
5247 cat_file(fp, yield, sub_arg[3]);
5253 tls_close(cctx.tls_ctx, TRUE);
5260 /* After a timeout, we restore the pointer in the result, that is,
5261 make sure we add nothing from the socket. */
5265 yield->ptr = save_ptr;
5266 expand_string_message = US "socket read timed out";
5271 /* The whole thing has worked (or we were skipping). If there is a
5272 failure string following, we need to skip it. */
5276 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
5280 expand_string_message = US"missing '}' closing failstring for readsocket";
5281 goto EXPAND_FAILED_CURLY;
5283 while (isspace(*s)) s++;
5289 expand_string_message = US"missing '}' closing readsocket";
5290 goto EXPAND_FAILED_CURLY;
5294 /* Come here on failure to create socket, connect socket, write to the
5295 socket, or timeout on reading. If another substring follows, expand and
5296 use it. Otherwise, those conditions give expand errors. */
5299 if (*s != '{') goto EXPAND_FAILED;
5300 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5301 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5303 yield = string_cat(yield, arg);
5306 expand_string_message = US"missing '}' closing failstring for readsocket";
5307 goto EXPAND_FAILED_CURLY;
5309 while (isspace(*s)) s++;
5313 /* Handle "run" to execute a program. */
5319 const uschar **argv;
5323 if ((expand_forbid & RDO_RUN) != 0)
5325 expand_string_message = US"running a command is not permitted";
5329 while (isspace(*s)) s++;
5332 expand_string_message = US"missing '{' for command arg of run";
5333 goto EXPAND_FAILED_CURLY;
5335 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5336 if (arg == NULL) goto EXPAND_FAILED;
5337 while (isspace(*s)) s++;
5340 expand_string_message = US"missing '}' closing command arg of run";
5341 goto EXPAND_FAILED_CURLY;
5344 if (skipping) /* Just pretend it worked when we're skipping */
5347 lookup_value = NULL;
5351 if (!transport_set_up_command(&argv, /* anchor for arg list */
5352 arg, /* raw command */
5353 FALSE, /* don't expand the arguments */
5354 0, /* not relevant when... */
5355 NULL, /* no transporting address */
5356 US"${run} expansion", /* for error messages */
5357 &expand_string_message)) /* where to put error message */
5360 /* Create the child process, making it a group leader. */
5362 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
5364 expand_string_message =
5365 string_sprintf("couldn't create child process: %s", strerror(errno));
5369 /* Nothing is written to the standard input. */
5373 /* Read the pipe to get the command's output into $value (which is kept
5374 in lookup_value). Read during execution, so that if the output exceeds
5375 the OS pipe buffer limit, we don't block forever. Remember to not release
5376 memory just allocated for $value. */
5379 f = fdopen(fd_out, "rb");
5380 sigalrm_seen = FALSE;
5382 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5386 /* Wait for the process to finish, applying the timeout, and inspect its
5387 return code for serious disasters. Simple non-zero returns are passed on.
5390 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5392 if (sigalrm_seen || runrc == -256)
5394 expand_string_message = US"command timed out";
5395 killpg(pid, SIGKILL); /* Kill the whole process group */
5398 else if (runrc == -257)
5399 expand_string_message = string_sprintf("wait() failed: %s",
5403 expand_string_message = string_sprintf("command killed by signal %d",
5410 /* Process the yes/no strings; $value may be useful in both cases */
5412 switch(process_yesno(
5413 skipping, /* were previously skipping */
5414 runrc == 0, /* success/failure indicator */
5415 lookup_value, /* value to reset for string2 */
5416 &s, /* input pointer */
5417 &yield, /* output pointer */
5418 US"run", /* condition type */
5421 case 1: goto EXPAND_FAILED; /* when all is well, the */
5422 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5428 /* Handle character translation for "tr" */
5432 int oldptr = yield->ptr;
5436 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5438 case 1: goto EXPAND_FAILED_CURLY;
5440 case 3: goto EXPAND_FAILED;
5443 yield = string_cat(yield, sub[0]);
5444 o2m = Ustrlen(sub[2]) - 1;
5446 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5448 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5452 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5459 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5460 expanded arguments. */
5469 int val[2] = { 0, -1 };
5472 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5473 Ensure that sub[2] is set in the ${length } case. */
5476 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5477 TRUE, name, &resetok))
5479 case 1: goto EXPAND_FAILED_CURLY;
5481 case 3: goto EXPAND_FAILED;
5484 /* Juggle the arguments if there are only two of them: always move the
5485 string to the last position and make ${length{n}{str}} equivalent to
5486 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5492 if (item_type == EITEM_LENGTH)
5499 for (int i = 0; i < 2; i++) if (sub[i])
5501 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5502 if (*ret != 0 || (i != 0 && val[i] < 0))
5504 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5505 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5511 (item_type == EITEM_HASH)?
5512 compute_hash(sub[2], val[0], val[1], &len) :
5513 (item_type == EITEM_NHASH)?
5514 compute_nhash(sub[2], val[0], val[1], &len) :
5515 extract_substr(sub[2], val[0], val[1], &len);
5517 if (ret == NULL) goto EXPAND_FAILED;
5518 yield = string_catn(yield, ret, len);
5522 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5523 This code originally contributed by Steve Haslam. It currently supports
5524 the use of MD5 and SHA-1 hashes.
5526 We need some workspace that is large enough to handle all the supported
5527 hash types. Use macros to set the sizes rather than be too elaborate. */
5529 #define MAX_HASHLEN 20
5530 #define MAX_HASHBLOCKLEN 64
5539 int hashlen; /* Number of octets for the hash algorithm's output */
5540 int hashblocklen; /* Number of octets the hash algorithm processes */
5542 unsigned int keylen;
5544 uschar keyhash[MAX_HASHLEN];
5545 uschar innerhash[MAX_HASHLEN];
5546 uschar finalhash[MAX_HASHLEN];
5547 uschar finalhash_hex[2*MAX_HASHLEN];
5548 uschar innerkey[MAX_HASHBLOCKLEN];
5549 uschar outerkey[MAX_HASHBLOCKLEN];
5551 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5553 case 1: goto EXPAND_FAILED_CURLY;
5555 case 3: goto EXPAND_FAILED;
5560 if (Ustrcmp(sub[0], "md5") == 0)
5563 use_base = &md5_base;
5567 else if (Ustrcmp(sub[0], "sha1") == 0)
5570 use_base = &sha1_ctx;
5576 expand_string_message =
5577 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5582 keylen = Ustrlen(keyptr);
5584 /* If the key is longer than the hash block length, then hash the key
5587 if (keylen > hashblocklen)
5589 chash_start(type, use_base);
5590 chash_end(type, use_base, keyptr, keylen, keyhash);
5595 /* Now make the inner and outer key values */
5597 memset(innerkey, 0x36, hashblocklen);
5598 memset(outerkey, 0x5c, hashblocklen);
5600 for (int i = 0; i < keylen; i++)
5602 innerkey[i] ^= keyptr[i];
5603 outerkey[i] ^= keyptr[i];
5606 /* Now do the hashes */
5608 chash_start(type, use_base);
5609 chash_mid(type, use_base, innerkey);
5610 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5612 chash_start(type, use_base);
5613 chash_mid(type, use_base, outerkey);
5614 chash_end(type, use_base, innerhash, hashlen, finalhash);
5616 /* Encode the final hash as a hex string */
5619 for (int i = 0; i < hashlen; i++)
5621 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5622 *p++ = hex_digits[finalhash[i] & 0x0f];
5625 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5626 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5628 yield = string_catn(yield, finalhash_hex, hashlen*2);
5633 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5634 We have to save the numerical variables and restore them afterwards. */
5639 int moffset, moffsetextra, slen;
5642 const uschar *rerror;
5645 int save_expand_nmax =
5646 save_expand_strings(save_expand_nstring, save_expand_nlength);
5648 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5650 case 1: goto EXPAND_FAILED_CURLY;
5652 case 3: goto EXPAND_FAILED;
5655 /* Compile the regular expression */
5657 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5662 expand_string_message = string_sprintf("regular expression error in "
5663 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5667 /* Now run a loop to do the substitutions as often as necessary. It ends
5668 when there are no more matches. Take care over matches of the null string;
5669 do the same thing as Perl does. */
5672 slen = Ustrlen(sub[0]);
5673 moffset = moffsetextra = 0;
5678 int ovector[3*(EXPAND_MAXN+1)];
5679 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5680 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5683 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5684 is not necessarily the end. We want to repeat the match from one
5685 character further along, but leaving the basic offset the same (for
5686 copying below). We can't be at the end of the string - that was checked
5687 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5688 finished; copy the remaining string and end the loop. */
5698 yield = string_catn(yield, subject+moffset, slen-moffset);
5702 /* Match - set up for expanding the replacement. */
5704 if (n == 0) n = EXPAND_MAXN + 1;
5706 for (int nn = 0; nn < n*2; nn += 2)
5708 expand_nstring[expand_nmax] = subject + ovector[nn];
5709 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5713 /* Copy the characters before the match, plus the expanded insertion. */
5715 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
5716 insert = expand_string(sub[2]);
5717 if (insert == NULL) goto EXPAND_FAILED;
5718 yield = string_cat(yield, insert);
5720 moffset = ovector[1];
5724 /* If we have matched an empty string, first check to see if we are at
5725 the end of the subject. If so, the loop is over. Otherwise, mimic
5726 what Perl's /g options does. This turns out to be rather cunning. First
5727 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5728 string at the same point. If this fails (picked up above) we advance to
5729 the next character. */
5731 if (ovector[0] == ovector[1])
5733 if (ovector[0] == slen) break;
5734 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5738 /* All done - restore numerical variables. */
5740 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5741 save_expand_nlength);
5745 /* Handle keyed and numbered substring extraction. If the first argument
5746 consists entirely of digits, then a numerical extraction is assumed. */
5750 int field_number = 1;
5751 BOOL field_number_set = FALSE;
5752 uschar *save_lookup_value = lookup_value;
5754 int save_expand_nmax =
5755 save_expand_strings(save_expand_nstring, save_expand_nlength);
5757 /* On reflection the original behaviour of extract-json for a string
5758 result, leaving it quoted, was a mistake. But it was already published,
5759 hence the addition of jsons. In a future major version, make json
5760 work like josons, and withdraw jsons. */
5762 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
5764 while (isspace(*s)) s++;
5766 /* Check for a format-variant specifier */
5768 if (*s != '{') /*}*/
5769 if (Ustrncmp(s, "json", 4) == 0)
5770 if (*(s += 4) == 's')
5771 {fmt = extract_jsons; s++;}
5775 /* While skipping we cannot rely on the data for expansions being
5776 available (eg. $item) hence cannot decide on numeric vs. keyed.
5777 Read a maximum of 5 arguments (including the yes/no) */
5781 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
5783 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5784 goto EXPAND_FAILED; /*'{'*/
5787 expand_string_message = US"missing '{' for arg of extract";
5788 goto EXPAND_FAILED_CURLY;
5790 while (isspace(*s)) s++;
5792 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
5793 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5797 while (isspace(*s)) s++;
5801 expand_string_message = US"missing '}' closing extract";
5802 goto EXPAND_FAILED_CURLY;
5806 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5808 while (isspace(*s)) s++;
5809 if (*s == '{') /*'}'*/
5811 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5812 if (sub[i] == NULL) goto EXPAND_FAILED; /*'{'*/
5815 expand_string_message = string_sprintf(
5816 "missing '}' closing arg %d of extract", i+1);
5817 goto EXPAND_FAILED_CURLY;
5820 /* After removal of leading and trailing white space, the first
5821 argument must not be empty; if it consists entirely of digits
5822 (optionally preceded by a minus sign), this is a numerical
5823 extraction, and we expect 3 arguments (normal) or 2 (json). */
5831 while (isspace(*p)) p++;
5835 while (len > 0 && isspace(p[len-1])) len--;
5840 expand_string_message = US"first argument of \"extract\" must "
5850 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5854 if (fmt == extract_basic) j = 3; /* Need 3 args */
5855 field_number_set = TRUE;
5861 expand_string_message = string_sprintf(
5862 "missing '{' for arg %d of extract", i+1);
5863 goto EXPAND_FAILED_CURLY;
5867 /* Extract either the numbered or the keyed substring into $value. If
5868 skipping, just pretend the extraction failed. */
5871 lookup_value = NULL;
5875 lookup_value = field_number_set
5876 ? expand_gettokened(field_number, sub[1], sub[2])
5877 : expand_getkeyed(sub[0], sub[1]);
5884 const uschar * list;
5886 /* Array: Bracket-enclosed and comma-separated.
5887 Object: Brace-enclosed, comma-sep list of name:value pairs */
5889 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
5891 expand_string_message =
5892 string_sprintf("%s wrapping %s for extract json",
5893 expand_string_message,
5894 field_number_set ? "array" : "object");
5895 goto EXPAND_FAILED_CURLY;
5899 if (field_number_set)
5901 if (field_number <= 0)
5903 expand_string_message = US"first argument of \"extract\" must "
5904 "be greater than zero";
5907 while (field_number > 0 && (item = json_nextinlist(&list)))
5909 if ((lookup_value = s = item))
5912 while (--s >= lookup_value && isspace(*s)) *s = '\0';
5917 lookup_value = NULL;
5918 while ((item = json_nextinlist(&list)))
5920 /* Item is: string name-sep value. string is quoted.
5921 Dequote the string and compare with the search key. */
5923 if (!(item = dewrap(item, US"\"\"")))
5925 expand_string_message =
5926 string_sprintf("%s wrapping string key for extract json",
5927 expand_string_message);
5928 goto EXPAND_FAILED_CURLY;
5930 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
5932 s = item + Ustrlen(item) + 1;
5933 while (isspace(*s)) s++;
5936 expand_string_message =
5937 US"missing object value-separator for extract json";
5938 goto EXPAND_FAILED_CURLY;
5941 while (isspace(*s)) s++;
5949 if ( fmt == extract_jsons
5951 && !(lookup_value = dewrap(lookup_value, US"\"\"")))
5953 expand_string_message =
5954 string_sprintf("%s wrapping string result for extract jsons",
5955 expand_string_message);
5956 goto EXPAND_FAILED_CURLY;
5961 /* If no string follows, $value gets substituted; otherwise there can
5962 be yes/no strings, as for lookup or if. */
5964 switch(process_yesno(
5965 skipping, /* were previously skipping */
5966 lookup_value != NULL, /* success/failure indicator */
5967 save_lookup_value, /* value to reset for string2 */
5968 &s, /* input pointer */
5969 &yield, /* output pointer */
5970 US"extract", /* condition type */
5973 case 1: goto EXPAND_FAILED; /* when all is well, the */
5974 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5977 /* All done - restore numerical variables. */
5979 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5980 save_expand_nlength);
5985 /* return the Nth item from a list */
5987 case EITEM_LISTEXTRACT:
5989 int field_number = 1;
5990 uschar *save_lookup_value = lookup_value;
5992 int save_expand_nmax =
5993 save_expand_strings(save_expand_nstring, save_expand_nlength);
5995 /* Read the field & list arguments */
5997 for (int i = 0; i < 2; i++)
5999 while (isspace(*s)) s++;
6000 if (*s != '{') /*'}'*/
6002 expand_string_message = string_sprintf(
6003 "missing '{' for arg %d of listextract", i+1);
6004 goto EXPAND_FAILED_CURLY;
6007 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6008 if (!sub[i]) goto EXPAND_FAILED; /*{*/
6011 expand_string_message = string_sprintf(
6012 "missing '}' closing arg %d of listextract", i+1);
6013 goto EXPAND_FAILED_CURLY;
6016 /* After removal of leading and trailing white space, the first
6017 argument must be numeric and nonempty. */
6025 while (isspace(*p)) p++;
6029 while (len > 0 && isspace(p[len-1])) len--;
6032 if (!*p && !skipping)
6034 expand_string_message = US"first argument of \"listextract\" must "
6044 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6047 expand_string_message = US"first argument of \"listextract\" must "
6055 /* Extract the numbered element into $value. If
6056 skipping, just pretend the extraction failed. */
6058 lookup_value = skipping ? NULL : expand_getlistele(field_number, sub[1]);
6060 /* If no string follows, $value gets substituted; otherwise there can
6061 be yes/no strings, as for lookup or if. */
6063 switch(process_yesno(
6064 skipping, /* were previously skipping */
6065 lookup_value != NULL, /* success/failure indicator */
6066 save_lookup_value, /* value to reset for string2 */
6067 &s, /* input pointer */
6068 &yield, /* output pointer */
6069 US"listextract", /* condition type */
6072 case 1: goto EXPAND_FAILED; /* when all is well, the */
6073 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6076 /* All done - restore numerical variables. */
6078 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6079 save_expand_nlength);
6085 case EITEM_CERTEXTRACT:
6087 uschar *save_lookup_value = lookup_value;
6089 int save_expand_nmax =
6090 save_expand_strings(save_expand_nstring, save_expand_nlength);
6092 /* Read the field argument */
6093 while (isspace(*s)) s++;
6094 if (*s != '{') /*}*/
6096 expand_string_message = US"missing '{' for field arg of certextract";
6097 goto EXPAND_FAILED_CURLY;
6099 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6100 if (!sub[0]) goto EXPAND_FAILED; /*{*/
6103 expand_string_message = US"missing '}' closing field arg of certextract";
6104 goto EXPAND_FAILED_CURLY;
6106 /* strip spaces fore & aft */
6111 while (isspace(*p)) p++;
6115 while (len > 0 && isspace(p[len-1])) len--;
6119 /* inspect the cert argument */
6120 while (isspace(*s)) s++;
6121 if (*s != '{') /*}*/
6123 expand_string_message = US"missing '{' for cert variable arg of certextract";
6124 goto EXPAND_FAILED_CURLY;
6128 expand_string_message = US"second argument of \"certextract\" must "
6129 "be a certificate variable";
6132 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
6133 if (!sub[1]) goto EXPAND_FAILED; /*{*/
6136 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6137 goto EXPAND_FAILED_CURLY;
6141 lookup_value = NULL;
6144 lookup_value = expand_getcertele(sub[0], sub[1]);
6145 if (*expand_string_message) goto EXPAND_FAILED;
6147 switch(process_yesno(
6148 skipping, /* were previously skipping */
6149 lookup_value != NULL, /* success/failure indicator */
6150 save_lookup_value, /* value to reset for string2 */
6151 &s, /* input pointer */
6152 &yield, /* output pointer */
6153 US"certextract", /* condition type */
6156 case 1: goto EXPAND_FAILED; /* when all is well, the */
6157 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6160 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6161 save_expand_nlength);
6164 #endif /*DISABLE_TLS*/
6166 /* Handle list operations */
6173 int save_ptr = yield->ptr;
6174 uschar outsep[2] = { '\0', '\0' };
6175 const uschar *list, *expr, *temp;
6176 uschar *save_iterate_item = iterate_item;
6177 uschar *save_lookup_value = lookup_value;
6179 while (isspace(*s)) s++;
6182 expand_string_message =
6183 string_sprintf("missing '{' for first arg of %s", name);
6184 goto EXPAND_FAILED_CURLY;
6187 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6188 if (list == NULL) goto EXPAND_FAILED;
6191 expand_string_message =
6192 string_sprintf("missing '}' closing first arg of %s", name);
6193 goto EXPAND_FAILED_CURLY;
6196 if (item_type == EITEM_REDUCE)
6199 while (isspace(*s)) s++;
6202 expand_string_message = US"missing '{' for second arg of reduce";
6203 goto EXPAND_FAILED_CURLY;
6205 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6206 if (!t) goto EXPAND_FAILED;
6210 expand_string_message = US"missing '}' closing second arg of reduce";
6211 goto EXPAND_FAILED_CURLY;
6215 while (isspace(*s)) s++;
6218 expand_string_message =
6219 string_sprintf("missing '{' for last arg of %s", name);
6220 goto EXPAND_FAILED_CURLY;
6225 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6226 if scanning a "false" part). This allows us to find the end of the
6227 condition, because if the list is empty, we won't actually evaluate the
6228 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6229 the normal internal expansion function. */
6231 if (item_type == EITEM_FILTER)
6233 temp = eval_condition(expr, &resetok, NULL);
6234 if (temp != NULL) s = temp;
6237 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6241 expand_string_message = string_sprintf("%s inside \"%s\" item",
6242 expand_string_message, name);
6246 while (isspace(*s)) s++;
6249 expand_string_message = string_sprintf("missing } at end of condition "
6250 "or expression inside \"%s\"; could be an unquoted } in the content",
6255 while (isspace(*s)) s++; /*{*/
6258 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6263 /* If we are skipping, we can now just move on to the next item. When
6264 processing for real, we perform the iteration. */
6266 if (skipping) continue;
6267 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6269 *outsep = (uschar)sep; /* Separator as a string */
6271 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6272 name, iterate_item, lookup_value);
6274 if (item_type == EITEM_FILTER)
6277 if (eval_condition(expr, &resetok, &condresult) == NULL)
6279 iterate_item = save_iterate_item;
6280 lookup_value = save_lookup_value;
6281 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6282 expand_string_message, name);
6285 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6286 condresult? "true":"false");
6288 temp = iterate_item; /* TRUE => include this item */
6290 continue; /* FALSE => skip this item */
6293 /* EITEM_MAP and EITEM_REDUCE */
6297 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
6301 iterate_item = save_iterate_item;
6302 expand_string_message = string_sprintf("%s inside \"%s\" item",
6303 expand_string_message, name);
6306 if (item_type == EITEM_REDUCE)
6308 lookup_value = t; /* Update the value of $value */
6309 continue; /* and continue the iteration */
6313 /* We reach here for FILTER if the condition is true, always for MAP,
6314 and never for REDUCE. The value in "temp" is to be added to the output
6315 list that is being created, ensuring that any occurrences of the
6316 separator character are doubled. Unless we are dealing with the first
6317 item of the output list, add in a space if the new item begins with the
6318 separator character, or is an empty string. */
6320 if (yield->ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
6321 yield = string_catn(yield, US" ", 1);
6323 /* Add the string in "temp" to the output list that we are building,
6324 This is done in chunks by searching for the separator character. */
6328 size_t seglen = Ustrcspn(temp, outsep);
6330 yield = string_catn(yield, temp, seglen + 1);
6332 /* If we got to the end of the string we output one character
6333 too many; backup and end the loop. Otherwise arrange to double the
6336 if (temp[seglen] == '\0') { yield->ptr--; break; }
6337 yield = string_catn(yield, outsep, 1);
6341 /* Output a separator after the string: we will remove the redundant
6342 final one at the end. */
6344 yield = string_catn(yield, outsep, 1);
6345 } /* End of iteration over the list loop */
6347 /* REDUCE has generated no output above: output the final value of
6350 if (item_type == EITEM_REDUCE)
6352 yield = string_cat(yield, lookup_value);
6353 lookup_value = save_lookup_value; /* Restore $value */
6356 /* FILTER and MAP generate lists: if they have generated anything, remove
6357 the redundant final separator. Even though an empty item at the end of a
6358 list does not count, this is tidier. */
6360 else if (yield->ptr != save_ptr) yield->ptr--;
6362 /* Restore preserved $item */
6364 iterate_item = save_iterate_item;
6372 const uschar *srclist, *cmp, *xtract;
6373 uschar * opname, * srcitem;
6374 const uschar *dstlist = NULL, *dstkeylist = NULL;
6376 uschar *save_iterate_item = iterate_item;
6378 while (isspace(*s)) s++;
6381 expand_string_message = US"missing '{' for list arg of sort";
6382 goto EXPAND_FAILED_CURLY;
6385 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6386 if (!srclist) goto EXPAND_FAILED;
6389 expand_string_message = US"missing '}' closing list arg of sort";
6390 goto EXPAND_FAILED_CURLY;
6393 while (isspace(*s)) s++;
6396 expand_string_message = US"missing '{' for comparator arg of sort";
6397 goto EXPAND_FAILED_CURLY;
6400 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6401 if (!cmp) goto EXPAND_FAILED;
6404 expand_string_message = US"missing '}' closing comparator arg of sort";
6405 goto EXPAND_FAILED_CURLY;
6408 if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6410 if (!expand_string_message)
6411 expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6416 case ECOND_NUM_L: case ECOND_NUM_LE:
6417 case ECOND_NUM_G: case ECOND_NUM_GE:
6418 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6419 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6423 expand_string_message = US"comparator not handled for sort";
6427 while (isspace(*s)) s++;
6430 expand_string_message = US"missing '{' for extractor arg of sort";
6431 goto EXPAND_FAILED_CURLY;
6435 if (!(tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok)))
6437 xtract = string_copyn(xtract, s - xtract);
6441 expand_string_message = US"missing '}' closing extractor arg of sort";
6442 goto EXPAND_FAILED_CURLY;
6447 expand_string_message = US"missing } at end of \"sort\"";
6451 if (skipping) continue;
6453 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6455 uschar * srcfield, * dstitem;
6456 gstring * newlist = NULL;
6457 gstring * newkeylist = NULL;
6459 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6461 /* extract field for comparisons */
6462 iterate_item = srcitem;
6463 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6467 expand_string_message = string_sprintf(
6468 "field-extract in sort: \"%s\"", xtract);
6472 /* Insertion sort */
6474 /* copy output list until new-item < list-item */
6475 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6479 /* field for comparison */
6480 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6483 /* String-comparator names start with a letter; numeric names do not */
6485 if (sortsbefore(cond_type, isalpha(opname[0]),
6486 srcfield, dstfield))
6488 /* New-item sorts before this dst-item. Append new-item,
6489 then dst-item, then remainder of dst list. */
6491 newlist = string_append_listele(newlist, sep, srcitem);
6492 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6495 newlist = string_append_listele(newlist, sep, dstitem);
6496 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6498 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */
6499 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6501 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6503 newlist = string_append_listele(newlist, sep, dstitem);
6504 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6510 newlist = string_append_listele(newlist, sep, dstitem);
6511 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6514 /* If we ran out of dstlist without consuming srcitem, append it */
6517 newlist = string_append_listele(newlist, sep, srcitem);
6518 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6521 dstlist = newlist->s;
6522 dstkeylist = newkeylist->s;
6524 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6525 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6529 yield = string_cat(yield, dstlist);
6531 /* Restore preserved $item */
6532 iterate_item = save_iterate_item;
6536 expand_string_message = US"Internal error in sort (list mismatch)";
6541 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6542 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6543 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6544 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6546 #define EXPAND_DLFUNC_MAX_ARGS 8
6549 #ifndef EXPAND_DLFUNC
6550 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6551 "is not included in this binary";
6554 #else /* EXPAND_DLFUNC */
6557 exim_dlfunc_t *func;
6560 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6562 if ((expand_forbid & RDO_DLFUNC) != 0)
6564 expand_string_message =
6565 US"dynamically-loaded functions are not permitted";
6569 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6570 TRUE, US"dlfunc", &resetok))
6572 case 1: goto EXPAND_FAILED_CURLY;
6574 case 3: goto EXPAND_FAILED;
6577 /* If skipping, we don't actually do anything */
6579 if (skipping) continue;
6581 /* Look up the dynamically loaded object handle in the tree. If it isn't
6582 found, dlopen() the file and put the handle in the tree for next time. */
6584 if (!(t = tree_search(dlobj_anchor, argv[0])))
6586 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6589 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6590 argv[0], dlerror());
6591 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6594 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), is_tainted(argv[0]));
6595 Ustrcpy(t->name, argv[0]);
6596 t->data.ptr = handle;
6597 (void)tree_insertnode(&dlobj_anchor, t);
6600 /* Having obtained the dynamically loaded object handle, look up the
6601 function pointer. */
6603 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6606 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6607 "%s", argv[1], argv[0], dlerror());
6608 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6612 /* Call the function and work out what to do with the result. If it
6613 returns OK, we have a replacement string; if it returns DEFER then
6614 expansion has failed in a non-forced manner; if it returns FAIL then
6615 failure was forced; if it returns ERROR or any other value there's a
6616 problem, so panic slightly. In any case, assume that the function has
6617 side-effects on the store that must be preserved. */
6621 for (argc = 0; argv[argc] != NULL; argc++);
6622 status = func(&result, argc - 2, &argv[2]);
6625 if (result == NULL) result = US"";
6626 yield = string_cat(yield, result);
6631 expand_string_message = result == NULL ? US"(no message)" : result;
6632 if(status == FAIL_FORCED) f.expand_string_forcedfail = TRUE;
6633 else if(status != FAIL)
6634 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6635 argv[0], argv[1], status, expand_string_message);
6639 #endif /* EXPAND_DLFUNC */
6641 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6644 uschar *save_lookup_value = lookup_value;
6646 while (isspace(*s)) s++;
6647 if (*s != '{') /*}*/
6650 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6651 if (!key) goto EXPAND_FAILED; /*{*/
6654 expand_string_message = US"missing '{' for name arg of env";
6655 goto EXPAND_FAILED_CURLY;
6658 lookup_value = US getenv(CS key);
6660 switch(process_yesno(
6661 skipping, /* were previously skipping */
6662 lookup_value != NULL, /* success/failure indicator */
6663 save_lookup_value, /* value to reset for string2 */
6664 &s, /* input pointer */
6665 &yield, /* output pointer */
6666 US"env", /* condition type */
6669 case 1: goto EXPAND_FAILED; /* when all is well, the */
6670 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6674 } /* EITEM_* switch */
6676 /* Control reaches here if the name is not recognized as one of the more
6677 complicated expansion items. Check for the "operator" syntax (name terminated
6678 by a colon). Some of the operators have arguments, separated by _ from the
6687 var_entry *vp = NULL;
6690 /* Owing to an historical mis-design, an underscore may be part of the
6691 operator name, or it may introduce arguments. We therefore first scan the
6692 table of names that contain underscores. If there is no match, we cut off
6693 the arguments and then scan the main table. */
6695 if ((c = chop_match(name, op_table_underscore,
6696 nelem(op_table_underscore))) < 0)
6698 arg = Ustrchr(name, '_');
6699 if (arg != NULL) *arg = 0;
6700 c = chop_match(name, op_table_main, nelem(op_table_main));
6701 if (c >= 0) c += nelem(op_table_underscore);
6702 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6705 /* Deal specially with operators that might take a certificate variable
6706 as we do not want to do the usual expansion. For most, expand the string.*/
6716 const uschar * s1 = s;
6717 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6719 if (!sub) goto EXPAND_FAILED; /*{*/
6722 expand_string_message =
6723 string_sprintf("missing '}' closing cert arg of %s", name);
6724 goto EXPAND_FAILED_CURLY;
6726 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6736 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6737 if (!sub) goto EXPAND_FAILED;
6742 /* If we are skipping, we don't need to perform the operation at all.
6743 This matters for operations like "mask", because the data may not be
6744 in the correct format when skipping. For example, the expression may test
6745 for the existence of $sender_host_address before trying to mask it. For
6746 other operations, doing them may not fail, but it is a waste of time. */
6748 if (skipping && c >= 0) continue;
6750 /* Otherwise, switch on the operator type */
6757 unsigned long int n = Ustrtoul(sub, &t, 10);
6762 expand_string_message = string_sprintf("argument for base32 "
6763 "operator is \"%s\", which is not a decimal number", sub);
6767 g = string_catn(g, &base32_chars[n & 0x1f], 1);
6769 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
6776 unsigned long int n = 0;
6780 uschar * t = Ustrchr(base32_chars, *tt++);
6783 expand_string_message = string_sprintf("argument for base32d "
6784 "operator is \"%s\", which is not a base 32 number", sub);
6787 n = n * 32 + (t - base32_chars);
6789 s = string_sprintf("%ld", n);
6790 yield = string_cat(yield, s);
6797 unsigned long int n = Ustrtoul(sub, &t, 10);
6800 expand_string_message = string_sprintf("argument for base62 "
6801 "operator is \"%s\", which is not a decimal number", sub);
6804 t = string_base62(n);
6805 yield = string_cat(yield, t);
6809 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6814 unsigned long int n = 0;
6817 uschar *t = Ustrchr(base62_chars, *tt++);
6820 expand_string_message = string_sprintf("argument for base62d "
6821 "operator is \"%s\", which is not a base %d number", sub,
6825 n = n * BASE_62 + (t - base62_chars);
6827 yield = string_fmt_append(yield, "%ld", n);
6833 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6834 if (expanded == NULL)
6836 expand_string_message =
6837 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6838 expand_string_message);
6841 yield = string_cat(yield, expanded);
6848 uschar *t = sub - 1;
6849 while (*(++t) != 0) { *t = tolower(*t); count++; }
6850 yield = string_catn(yield, sub, count);
6857 uschar *t = sub - 1;
6858 while (*(++t) != 0) { *t = toupper(*t); count++; }
6859 yield = string_catn(yield, sub, count);
6865 if (vp && *(void **)vp->value)
6867 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6868 yield = string_cat(yield, cp);
6876 md5_end(&base, sub, Ustrlen(sub), digest);
6877 for (int j = 0; j < 16; j++)
6878 yield = string_fmt_append(yield, "%02x", digest[j]);
6884 if (vp && *(void **)vp->value)
6886 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6887 yield = string_cat(yield, cp);
6895 sha1_end(&h, sub, Ustrlen(sub), digest);
6896 for (int j = 0; j < 20; j++)
6897 yield = string_fmt_append(yield, "%02X", digest[j]);
6903 #ifdef EXIM_HAVE_SHA2
6904 if (vp && *(void **)vp->value)
6905 if (c == EOP_SHA256)
6906 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
6908 expand_string_message = US"sha2_N not supported with certificates";
6913 hashmethod m = !arg ? HASH_SHA2_256
6914 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
6915 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
6916 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
6919 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6921 expand_string_message = US"unrecognised sha2 variant";
6925 exim_sha_update(&h, sub, Ustrlen(sub));
6926 exim_sha_finish(&h, &b);
6928 yield = string_fmt_append(yield, "%02X", *b.data++);
6931 expand_string_message = US"sha256 only supported with TLS";
6936 #ifdef EXIM_HAVE_SHA3
6940 hashmethod m = !arg ? HASH_SHA3_256
6941 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6942 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6943 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6944 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6947 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6949 expand_string_message = US"unrecognised sha3 variant";
6953 exim_sha_update(&h, sub, Ustrlen(sub));
6954 exim_sha_finish(&h, &b);
6956 yield = string_fmt_append(yield, "%02X", *b.data++);
6960 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
6964 /* Convert hex encoding to base64 encoding */
6974 for (enc = sub; *enc; enc++)
6976 if (!isxdigit(*enc))
6978 expand_string_message = string_sprintf("\"%s\" is not a hex "
6987 expand_string_message = string_sprintf("\"%s\" contains an odd "
6988 "number of characters", sub);
6992 while ((c = *in++) != 0)
6994 if (isdigit(c)) c -= '0';
6995 else c = toupper(c) - 'A' + 10;
7005 enc = b64encode(CUS sub, out - sub);
7006 yield = string_cat(yield, enc);
7010 /* Convert octets outside 0x21..0x7E to \xXX form */
7014 uschar *t = sub - 1;
7017 if (*t < 0x21 || 0x7E < *t)
7018 yield = string_fmt_append(yield, "\\x%02x", *t);
7020 yield = string_catn(yield, t, 1);
7025 /* count the number of list elements */
7033 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
7034 yield = string_fmt_append(yield, "%d", cnt);
7038 /* expand a named list given the name */
7039 /* handles nested named lists; requotes as colon-sep list */
7043 tree_node *t = NULL;
7044 const uschar * list;
7047 uschar * suffix = US"";
7048 BOOL needsep = FALSE;
7051 if (*sub == '+') sub++;
7052 if (arg == NULL) /* no-argument version */
7054 if (!(t = tree_search(addresslist_anchor, sub)) &&
7055 !(t = tree_search(domainlist_anchor, sub)) &&
7056 !(t = tree_search(hostlist_anchor, sub)))
7057 t = tree_search(localpartlist_anchor, sub);
7059 else switch(*arg) /* specific list-type version */
7061 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
7062 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
7063 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
7064 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
7066 expand_string_message = US"bad suffix on \"list\" operator";
7072 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
7074 : *arg=='a'?"address "
7075 : *arg=='d'?"domain "
7077 : *arg=='l'?"localpart "
7082 list = ((namedlist_block *)(t->data.ptr))->string;
7084 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
7086 uschar * buf = US" : ";
7088 yield = string_catn(yield, buf, 3);
7092 if (*item == '+') /* list item is itself a named list */
7094 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
7095 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
7097 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
7101 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
7102 while ((cp= strpbrk(CCS item, tok)))
7104 yield = string_catn(yield, item, cp - CS item);
7105 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
7107 yield = string_catn(yield, US"::", 2);
7110 else /* sep in item; should already be doubled; emit once */
7112 yield = string_catn(yield, US tok, 1);
7113 if (*cp == sep) cp++;
7118 yield = string_cat(yield, item);
7123 /* mask applies a mask to an IP address; for example the result of
7124 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7131 int mask, maskoffset;
7132 int type = string_is_ip_address(sub, &maskoffset);
7137 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7142 if (maskoffset == 0)
7144 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7149 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7151 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
7153 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7158 /* Convert the address to binary integer(s) and apply the mask */
7160 sub[maskoffset] = 0;
7161 count = host_aton(sub, binary);
7162 host_mask(count, binary, mask);
7164 /* Convert to masked textual format and add to output. */
7166 yield = string_catn(yield, buffer,
7167 host_nmtoa(count, binary, mask, buffer, '.'));
7172 case EOP_IPV6DENORM:
7174 int type = string_is_ip_address(sub, NULL);
7181 (void) host_aton(sub, binary);
7184 case 4: /* convert to IPv4-mapped IPv6 */
7185 binary[0] = binary[1] = 0;
7186 binary[2] = 0x0000ffff;
7187 (void) host_aton(sub, binary+3);
7191 expand_string_message =
7192 string_sprintf("\"%s\" is not an IP address", sub);
7196 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7197 ? ipv6_nmtoa(binary, buffer)
7198 : host_nmtoa(4, binary, -1, buffer, ':')
7204 case EOP_LOCAL_PART:
7208 int start, end, domain;
7209 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7212 if (c != EOP_DOMAIN)
7213 yield = c == EOP_LOCAL_PART && domain > 0
7214 ? string_catn(yield, t, domain - 1)
7215 : string_cat(yield, t);
7216 else if (domain > 0)
7217 yield = string_cat(yield, t + domain);
7223 uschar outsep[2] = { ':', '\0' };
7224 uschar *address, *error;
7225 int save_ptr = yield->ptr;
7226 int start, end, domain; /* Not really used */
7228 while (isspace(*sub)) sub++;
7230 if (*outsep = *++sub) ++sub;
7233 expand_string_message = string_sprintf("output separator "
7234 "missing in expanding ${addresses:%s}", --sub);
7237 f.parse_allow_group = TRUE;
7241 uschar * p = parse_find_address_end(sub, FALSE);
7242 uschar saveend = *p;
7244 address = parse_extract_address(sub, &error, &start, &end, &domain,
7248 /* Add the address to the output list that we are building. This is
7249 done in chunks by searching for the separator character. At the
7250 start, unless we are dealing with the first address of the output
7251 list, add in a space if the new address begins with the separator
7252 character, or is an empty string. */
7256 if (yield->ptr != save_ptr && address[0] == *outsep)
7257 yield = string_catn(yield, US" ", 1);
7261 size_t seglen = Ustrcspn(address, outsep);
7262 yield = string_catn(yield, address, seglen + 1);
7264 /* If we got to the end of the string we output one character
7267 if (address[seglen] == '\0') { yield->ptr--; break; }
7268 yield = string_catn(yield, outsep, 1);
7269 address += seglen + 1;
7272 /* Output a separator after the string: we will remove the
7273 redundant final one at the end. */
7275 yield = string_catn(yield, outsep, 1);
7278 if (saveend == '\0') break;
7282 /* If we have generated anything, remove the redundant final
7285 if (yield->ptr != save_ptr) yield->ptr--;
7286 f.parse_allow_group = FALSE;
7291 /* quote puts a string in quotes if it is empty or contains anything
7292 other than alphamerics, underscore, dot, or hyphen.
7294 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7295 be quoted in order to be a valid local part.
7297 In both cases, newlines and carriage returns are converted into \n and \r
7301 case EOP_QUOTE_LOCAL_PART:
7304 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
7305 uschar *t = sub - 1;
7309 while (!needs_quote && *(++t) != 0)
7310 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7312 else /* EOP_QUOTE_LOCAL_PART */
7314 while (!needs_quote && *(++t) != 0)
7315 needs_quote = !isalnum(*t) &&
7316 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
7317 (*t != '.' || t == sub || t[1] == 0);
7322 yield = string_catn(yield, US"\"", 1);
7327 yield = string_catn(yield, US"\\n", 2);
7328 else if (*t == '\r')
7329 yield = string_catn(yield, US"\\r", 2);
7332 if (*t == '\\' || *t == '"')
7333 yield = string_catn(yield, US"\\", 1);
7334 yield = string_catn(yield, t, 1);
7337 yield = string_catn(yield, US"\"", 1);
7339 else yield = string_cat(yield, sub);
7343 /* quote_lookuptype does lookup-specific quoting */
7348 uschar *opt = Ustrchr(arg, '_');
7350 if (opt != NULL) *opt++ = 0;
7352 n = search_findtype(arg, Ustrlen(arg));
7355 expand_string_message = search_error_message;
7359 if (lookup_list[n]->quote != NULL)
7360 sub = (lookup_list[n]->quote)(sub, opt);
7361 else if (opt != NULL) sub = NULL;
7365 expand_string_message = string_sprintf(
7366 "\"%s\" unrecognized after \"${quote_%s\"",
7371 yield = string_cat(yield, sub);
7375 /* rx quote sticks in \ before any non-alphameric character so that
7376 the insertion works in a regular expression. */
7380 uschar *t = sub - 1;
7384 yield = string_catn(yield, US"\\", 1);
7385 yield = string_catn(yield, t, 1);
7390 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7391 prescribed by the RFC, if there are characters that need to be encoded */
7395 uschar buffer[2048];
7396 yield = string_cat(yield,
7397 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7398 buffer, sizeof(buffer), FALSE));
7402 /* RFC 2047 decode */
7408 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7409 headers_charset, '?', &len, &error);
7412 expand_string_message = error;
7415 yield = string_catn(yield, decoded, len);
7419 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7429 if (c > 255) c = '_';
7431 yield = string_catn(yield, buff, 1);
7436 /* replace illegal UTF-8 sequences by replacement character */
7438 #define UTF8_REPLACEMENT_CHAR US"?"
7442 int seq_len = 0, index = 0;
7444 long codepoint = -1;
7446 uschar seq_buff[4]; /* accumulate utf-8 here */
7455 if ((c & 0xc0) != 0x80)
7456 /* wrong continuation byte; invalidate all bytes */
7457 complete = 1; /* error */
7460 codepoint = (codepoint << 6) | (c & 0x3f);
7461 seq_buff[index++] = c;
7462 if (--bytes_left == 0) /* codepoint complete */
7463 if(codepoint > 0x10FFFF) /* is it too large? */
7464 complete = -1; /* error (RFC3629 limit) */
7466 { /* finished; output utf-8 sequence */
7467 yield = string_catn(yield, seq_buff, seq_len);
7472 else /* no bytes left: new sequence */
7474 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7476 yield = string_catn(yield, &c, 1);
7479 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7481 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7486 codepoint = c & 0x1f;
7489 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7492 codepoint = c & 0x0f;
7494 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7497 codepoint = c & 0x07;
7499 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7502 seq_buff[index++] = c;
7503 seq_len = bytes_left + 1;
7504 } /* if(bytes_left) */
7508 bytes_left = index = 0;
7509 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7511 if ((complete == 1) && ((c & 0x80) == 0))
7512 /* ASCII character follows incomplete sequence */
7513 yield = string_catn(yield, &c, 1);
7515 /* If given a sequence truncated mid-character, we also want to report ?
7516 * Eg, ${length_1:フィル} is one byte, not one character, so we expect
7517 * ${utf8clean:${length_1:フィル}} to yield '?' */
7518 if (bytes_left != 0)
7520 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7526 case EOP_UTF8_DOMAIN_TO_ALABEL:
7528 uschar * error = NULL;
7529 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7532 expand_string_message = string_sprintf(
7533 "error converting utf8 (%s) to alabel: %s",
7534 string_printing(sub), error);
7537 yield = string_cat(yield, s);
7541 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7543 uschar * error = NULL;
7544 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7547 expand_string_message = string_sprintf(
7548 "error converting alabel (%s) to utf8: %s",
7549 string_printing(sub), error);
7552 yield = string_cat(yield, s);
7556 case EOP_UTF8_LOCALPART_TO_ALABEL:
7558 uschar * error = NULL;
7559 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7562 expand_string_message = string_sprintf(
7563 "error converting utf8 (%s) to alabel: %s",
7564 string_printing(sub), error);
7567 yield = string_cat(yield, s);
7568 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7572 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7574 uschar * error = NULL;
7575 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7578 expand_string_message = string_sprintf(
7579 "error converting alabel (%s) to utf8: %s",
7580 string_printing(sub), error);
7583 yield = string_cat(yield, s);
7586 #endif /* EXPERIMENTAL_INTERNATIONAL */
7588 /* escape turns all non-printing characters into escape sequences. */
7592 const uschar * t = string_printing(sub);
7593 yield = string_cat(yield, t);
7597 case EOP_ESCAPE8BIT:
7601 for (const uschar * s = sub; (c = *s); s++)
7602 yield = c < 127 && c != '\\'
7603 ? string_catn(yield, s, 1)
7604 : string_fmt_append(yield, "\\%03o", c);
7608 /* Handle numeric expression evaluation */
7613 uschar *save_sub = sub;
7614 uschar *error = NULL;
7615 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7618 expand_string_message = string_sprintf("error in expression "
7619 "evaluation: %s (after processing \"%.*s\")", error,
7620 (int)(sub-save_sub), save_sub);
7623 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
7627 /* Handle time period formatting */
7631 int n = readconf_readtime(sub, 0, FALSE);
7634 expand_string_message = string_sprintf("string \"%s\" is not an "
7635 "Exim time interval in \"%s\" operator", sub, name);
7638 yield = string_fmt_append(yield, "%d", n);
7642 case EOP_TIME_INTERVAL:
7645 uschar *t = read_number(&n, sub);
7646 if (*t != 0) /* Not A Number*/
7648 expand_string_message = string_sprintf("string \"%s\" is not a "
7649 "positive number in \"%s\" operator", sub, name);
7652 t = readconf_printtime(n);
7653 yield = string_cat(yield, t);
7657 /* Convert string to base64 encoding */
7663 uschar * s = vp && *(void **)vp->value
7664 ? tls_cert_der_b64(*(void **)vp->value)
7665 : b64encode(CUS sub, Ustrlen(sub));
7667 uschar * s = b64encode(CUS sub, Ustrlen(sub));
7669 yield = string_cat(yield, s);
7676 int len = b64decode(sub, &s);
7679 expand_string_message = string_sprintf("string \"%s\" is not "
7680 "well-formed for \"%s\" operator", sub, name);
7683 yield = string_cat(yield, s);
7687 /* strlen returns the length of the string */
7690 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
7693 /* length_n or l_n takes just the first n characters or the whole string,
7694 whichever is the shorter;
7696 substr_m_n, and s_m_n take n characters from offset m; negative m take
7697 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7698 takes the rest, either to the right or to the left.
7700 hash_n or h_n makes a hash of length n from the string, yielding n
7701 characters from the set a-z; hash_n_m makes a hash of length n, but
7702 uses m characters from the set a-zA-Z0-9.
7704 nhash_n returns a single number between 0 and n-1 (in text form), while
7705 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7706 between 0 and n-1 and the second between 0 and m-1. */
7726 expand_string_message = string_sprintf("missing values after %s",
7731 /* "length" has only one argument, effectively being synonymous with
7734 if (c == EOP_LENGTH || c == EOP_L)
7740 /* The others have one or two arguments; for "substr" the first may be
7741 negative. The second being negative means "not supplied". */
7746 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7749 /* Read up to two numbers, separated by underscores */
7754 if (arg != ret && *arg == '_' && pn == &value1)
7758 if (arg[1] != 0) arg++;
7760 else if (!isdigit(*arg))
7762 expand_string_message =
7763 string_sprintf("non-digit after underscore in \"%s\"", name);
7766 else *pn = (*pn)*10 + *arg++ - '0';
7770 /* Perform the required operation */
7773 (c == EOP_HASH || c == EOP_H)?
7774 compute_hash(sub, value1, value2, &len) :
7775 (c == EOP_NHASH || c == EOP_NH)?
7776 compute_nhash(sub, value1, value2, &len) :
7777 extract_substr(sub, value1, value2, &len);
7779 if (ret == NULL) goto EXPAND_FAILED;
7780 yield = string_catn(yield, ret, len);
7789 uschar **modetable[3];
7793 if (expand_forbid & RDO_EXISTS)
7795 expand_string_message = US"Use of the stat() expansion is not permitted";
7799 if (stat(CS sub, &st) < 0)
7801 expand_string_message = string_sprintf("stat(%s) failed: %s",
7802 sub, strerror(errno));
7806 switch (mode & S_IFMT)
7808 case S_IFIFO: smode[0] = 'p'; break;
7809 case S_IFCHR: smode[0] = 'c'; break;
7810 case S_IFDIR: smode[0] = 'd'; break;
7811 case S_IFBLK: smode[0] = 'b'; break;
7812 case S_IFREG: smode[0] = '-'; break;
7813 default: smode[0] = '?'; break;
7816 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7817 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7818 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7820 for (int i = 0; i < 3; i++)
7822 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7827 yield = string_fmt_append(yield,
7828 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7829 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7830 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7831 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7832 (long)st.st_gid, st.st_size, (long)st.st_atime,
7833 (long)st.st_mtime, (long)st.st_ctime);
7837 /* vaguely random number less than N */
7841 int_eximarith_t max = expanded_string_integer(sub, TRUE);
7843 if (expand_string_message)
7845 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
7849 /* Reverse IP, including IPv6 to dotted-nibble */
7851 case EOP_REVERSE_IP:
7853 int family, maskptr;
7854 uschar reversed[128];
7856 family = string_is_ip_address(sub, &maskptr);
7859 expand_string_message = string_sprintf(
7860 "reverse_ip() not given an IP address [%s]", sub);
7863 invert_address(reversed, sub);
7864 yield = string_cat(yield, reversed);
7868 /* Unknown operator */
7871 expand_string_message =
7872 string_sprintf("unknown expansion operator \"%s\"", name);
7877 /* Handle a plain name. If this is the first thing in the expansion, release
7878 the pre-allocated buffer. If the result data is known to be in a new buffer,
7879 newsize will be set to the size of that buffer, and we can just point at that
7880 store instead of copying. Many expansion strings contain just one reference,
7881 so this is a useful optimization, especially for humungous headers
7882 ($message_headers). */
7891 g = store_get(sizeof(gstring), FALSE);
7892 else if (yield->ptr == 0)
7894 if (resetok) reset_point = store_reset(reset_point);
7896 reset_point = store_mark();
7897 g = store_get(sizeof(gstring), FALSE); /* alloc _before_ calling find_variable() */
7899 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
7901 expand_string_message =
7902 string_sprintf("unknown variable in \"${%s}\"", name);
7903 check_variable_error_message(name);
7906 len = Ustrlen(value);
7907 if (!yield && newsize)
7910 yield->size = newsize;
7915 yield = string_catn(yield, value, len);
7919 /* Else there's something wrong */
7921 expand_string_message =
7922 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7923 "in a variable reference)", name);
7927 /* If we hit the end of the string when ket_ends is set, there is a missing
7928 terminating brace. */
7930 if (ket_ends && *s == 0)
7932 expand_string_message = malformed_header
7933 ? US"missing } at end of string - could be header name not terminated by colon"
7934 : US"missing } at end of string";
7938 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7939 added to the string. If so, set up an empty string. Add a terminating zero. If
7940 left != NULL, return a pointer to the terminator. */
7943 yield = string_get(1);
7944 (void) string_from_gstring(yield);
7945 if (left) *left = s;
7947 /* Any stacking store that was used above the final string is no longer needed.
7948 In many cases the final string will be the first one that was got and so there
7949 will be optimal store usage. */
7951 if (resetok) gstring_release_unused(yield);
7952 else if (resetok_p) *resetok_p = FALSE;
7956 BOOL tainted = is_tainted(yield->s);
7959 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
7960 debug_printf_indent("%sresult: %s\n",
7961 skipping ? "|-----" : "\\_____", yield->s);
7963 debug_printf_indent("%s \\__(tainted)\n",
7964 skipping ? "| " : " ");
7966 debug_printf_indent("\\___skipping: result is not used\n");
7970 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
7971 "expanding: %.*s\n",
7972 (int)(s - string), string);
7973 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7975 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7978 debug_printf_indent("%s(tainted)\n",
7980 ? UTF8_VERT " " : " " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
7982 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7983 "skipping: result is not used\n");
7989 /* This is the failure exit: easiest to program with a goto. We still need
7990 to update the pointer to the terminator, for cases of nested calls with "fail".
7993 EXPAND_FAILED_CURLY:
7994 if (malformed_header)
7995 expand_string_message =
7996 US"missing or misplaced { or } - could be header name not terminated by colon";
7998 else if (!expand_string_message || !*expand_string_message)
7999 expand_string_message = US"missing or misplaced { or }";
8001 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8002 that is a bad idea, because expand_string_message is in dynamic store. */
8005 if (left) *left = s;
8009 debug_printf_indent("|failed to expand: %s\n", string);
8010 debug_printf_indent("%serror message: %s\n",
8011 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8012 if (f.expand_string_forcedfail)
8013 debug_printf_indent("\\failure was forced\n");
8017 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8019 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8020 "error message: %s\n",
8021 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8022 expand_string_message);
8023 if (f.expand_string_forcedfail)
8024 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8026 if (resetok_p && !resetok) *resetok_p = FALSE;
8032 /* This is the external function call. Do a quick check for any expansion
8033 metacharacters, and if there are none, just return the input string.
8035 Argument: the string to be expanded
8036 Returns: the expanded string, or NULL if expansion failed; if failure was
8037 due to a lookup deferring, search_find_defer will be TRUE
8041 expand_cstring(const uschar * string)
8043 if (Ustrpbrk(string, "$\\") != NULL)
8045 int old_pool = store_pool;
8048 f.search_find_defer = FALSE;
8049 malformed_header = FALSE;
8050 store_pool = POOL_MAIN;
8051 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
8052 store_pool = old_pool;
8060 expand_string(uschar * string)
8062 return US expand_cstring(CUS string);
8069 /*************************************************
8071 *************************************************/
8073 /* Now and again we want to expand a string and be sure that the result is in a
8074 new bit of store. This function does that.
8075 Since we know it has been copied, the de-const cast is safe.
8077 Argument: the string to be expanded
8078 Returns: the expanded string, always in a new bit of store, or NULL
8082 expand_string_copy(const uschar *string)
8084 const uschar *yield = expand_cstring(string);
8085 if (yield == string) yield = string_copy(string);
8091 /*************************************************
8092 * Expand and interpret as an integer *
8093 *************************************************/
8095 /* Expand a string, and convert the result into an integer.
8098 string the string to be expanded
8099 isplus TRUE if a non-negative number is expected
8101 Returns: the integer value, or
8102 -1 for an expansion error ) in both cases, message in
8103 -2 for an integer interpretation error ) expand_string_message
8104 expand_string_message is set NULL for an OK integer
8108 expand_string_integer(uschar *string, BOOL isplus)
8110 return expanded_string_integer(expand_string(string), isplus);
8114 /*************************************************
8115 * Interpret string as an integer *
8116 *************************************************/
8118 /* Convert a string (that has already been expanded) into an integer.
8120 This function is used inside the expansion code.
8123 s the string to be expanded
8124 isplus TRUE if a non-negative number is expected
8126 Returns: the integer value, or
8127 -1 if string is NULL (which implies an expansion error)
8128 -2 for an integer interpretation error
8129 expand_string_message is set NULL for an OK integer
8132 static int_eximarith_t
8133 expanded_string_integer(const uschar *s, BOOL isplus)
8135 int_eximarith_t value;
8136 uschar *msg = US"invalid integer \"%s\"";
8139 /* If expansion failed, expand_string_message will be set. */
8141 if (s == NULL) return -1;
8143 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8144 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8145 systems, so we set it zero ourselves. */
8148 expand_string_message = NULL; /* Indicates no error */
8150 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8151 equal to 0. Unfortunately, people actually relied upon that, so preserve
8152 the behaviour explicitly. Stripping leading whitespace is a harmless
8153 noop change since strtol skips it anyway (provided that there is a number
8157 while (isspace(*s)) ++s;
8161 debug_printf_indent("treating blank string as number 0\n");
8166 value = strtoll(CS s, CSS &endptr, 10);
8170 msg = US"integer expected but \"%s\" found";
8172 else if (value < 0 && isplus)
8174 msg = US"non-negative integer expected but \"%s\" found";
8178 switch (tolower(*endptr))
8183 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8188 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8189 else value *= 1024*1024;
8193 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8194 else value *= 1024*1024*1024;
8198 if (errno == ERANGE)
8199 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8202 while (isspace(*endptr)) endptr++;
8203 if (*endptr == 0) return value;
8207 expand_string_message = string_sprintf(CS msg, s);
8212 /* These values are usually fixed boolean values, but they are permitted to be
8216 addr address being routed
8217 mtype the module type
8218 mname the module name
8219 dbg_opt debug selectors
8220 oname the option name
8221 bvalue the router's boolean value
8222 svalue the router's string value
8223 rvalue where to put the returned value
8225 Returns: OK value placed in rvalue
8226 DEFER expansion failed
8230 exp_bool(address_item *addr,
8231 uschar *mtype, uschar *mname, unsigned dbg_opt,
8232 uschar *oname, BOOL bvalue,
8233 uschar *svalue, BOOL *rvalue)
8236 if (svalue == NULL) { *rvalue = bvalue; return OK; }
8238 expanded = expand_string(svalue);
8239 if (expanded == NULL)
8241 if (f.expand_string_forcedfail)
8243 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8247 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8248 oname, mname, mtype, expand_string_message);
8249 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8253 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8256 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8258 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8262 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8263 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8272 /* Avoid potentially exposing a password in a string about to be logged */
8275 expand_hide_passwords(uschar * s)
8277 return ( ( Ustrstr(s, "failed to expand") != NULL
8278 || Ustrstr(s, "expansion of ") != NULL
8280 && ( Ustrstr(s, "mysql") != NULL
8281 || Ustrstr(s, "pgsql") != NULL
8282 || Ustrstr(s, "redis") != NULL
8283 || Ustrstr(s, "sqlite") != NULL
8284 || Ustrstr(s, "ldap:") != NULL
8285 || Ustrstr(s, "ldaps:") != NULL
8286 || Ustrstr(s, "ldapi:") != NULL
8287 || Ustrstr(s, "ldapdn:") != NULL
8288 || Ustrstr(s, "ldapm:") != NULL
8290 ? US"Temporary internal error" : s;
8294 /* Read given named file into big_buffer. Use for keying material etc.
8295 The content will have an ascii NUL appended.
8300 Return: pointer to buffer, or NULL on error.
8304 expand_file_big_buffer(const uschar * filename)
8306 int fd, off = 0, len;
8308 if ((fd = open(CS filename, O_RDONLY)) < 0)
8310 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8317 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8320 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8328 big_buffer[off] = '\0';
8334 /*************************************************
8335 * Error-checking for testsuite *
8336 *************************************************/
8338 uschar * region_start;
8339 uschar * region_end;
8340 const uschar *var_name;
8341 const uschar *var_data;
8345 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8348 if (var_data >= e->region_start && var_data < e->region_end)
8350 e->var_name = CUS var_name;
8351 e->var_data = CUS var_data;
8356 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8358 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8359 .var_name = NULL, .var_data = NULL };
8361 /* check acl_ variables */
8362 tree_walk(acl_var_c, assert_variable_notin, &e);
8363 tree_walk(acl_var_m, assert_variable_notin, &e);
8365 /* check auth<n> variables */
8366 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8367 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
8369 /* check regex<n> variables */
8370 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8371 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
8373 /* check known-name variables */
8374 for (var_entry * v = var_table; v < var_table + var_table_size; v++)
8375 if (v->type == vtype_stringptr)
8376 assert_variable_notin(US v->name, *(USS v->value), &e);
8378 /* check dns and address trees */
8379 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8380 tree_walk(tree_duplicates, assert_variable_notin, &e);
8381 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8382 tree_walk(tree_unusable, assert_variable_notin, &e);
8385 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8386 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8387 e.var_name, filename, linenumber, e.var_data);
8392 /*************************************************
8393 **************************************************
8394 * Stand-alone test program *
8395 **************************************************
8396 *************************************************/
8402 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
8404 int ovector[3*(EXPAND_MAXN+1)];
8405 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8406 ovector, nelem(ovector));
8407 BOOL yield = n >= 0;
8408 if (n == 0) n = EXPAND_MAXN + 1;
8411 expand_nmax = setup < 0 ? 0 : setup + 1;
8412 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8414 expand_nstring[expand_nmax] = subject + ovector[nn];
8415 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8423 int main(int argc, uschar **argv)
8425 uschar buffer[1024];
8427 debug_selector = D_v;
8428 debug_file = stderr;
8429 debug_fd = fileno(debug_file);
8430 big_buffer = malloc(big_buffer_size);
8432 for (int i = 1; i < argc; i++)
8434 if (argv[i][0] == '+')
8436 debug_trace_memory = 2;
8439 if (isdigit(argv[i][0]))
8440 debug_selector = Ustrtol(argv[i], NULL, 0);
8442 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8446 eldap_default_servers = argv[i];
8449 mysql_servers = argv[i];
8452 pgsql_servers = argv[i];
8455 redis_servers = argv[i];
8459 else opt_perl_startup = argv[i];
8463 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8465 expand_nstring[1] = US"string 1....";
8466 expand_nlength[1] = 8;
8470 if (opt_perl_startup != NULL)
8473 printf("Starting Perl interpreter\n");
8474 errstr = init_perl(opt_perl_startup);
8477 printf("** error in perl_startup code: %s\n", errstr);
8478 return EXIT_FAILURE;
8481 #endif /* EXIM_PERL */
8483 /* Thie deliberately regards the input as untainted, so that it can be
8484 expanded; only reasonable since this is a test for string-expansions. */
8486 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8488 rmark reset_point = store_mark();
8489 uschar *yield = expand_string(buffer);
8491 printf("%s\n", yield);
8494 if (f.search_find_defer) printf("search_find deferred\n");
8495 printf("Failed: %s\n", expand_string_message);
8496 if (f.expand_string_forcedfail) printf("Forced failure\n");
8499 store_reset(reset_point);
8511 /* End of expand.c */