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[] = {
248 EOP_ADDRESS = nelem(op_table_underscore),
294 /* Table of condition names, and corresponding switch numbers. The names must
295 be in alphabetical order. */
297 static uschar *cond_table[] = {
301 US"==", /* Backward compatibility */
338 US"match_local_part",
363 ECOND_FIRST_DELIVERY,
388 ECOND_MATCH_LOCAL_PART,
398 /* Types of table entry */
401 vtype_int, /* value is address of int */
402 vtype_filter_int, /* ditto, but recognized only when filtering */
403 vtype_ino, /* value is address of ino_t (not always an int) */
404 vtype_uid, /* value is address of uid_t (not always an int) */
405 vtype_gid, /* value is address of gid_t (not always an int) */
406 vtype_bool, /* value is address of bool */
407 vtype_stringptr, /* value is address of pointer to string */
408 vtype_msgbody, /* as stringptr, but read when first required */
409 vtype_msgbody_end, /* ditto, the end of the message */
410 vtype_msgheaders, /* the message's headers, processed */
411 vtype_msgheaders_raw, /* the message's headers, unprocessed */
412 vtype_localpart, /* extract local part from string */
413 vtype_domain, /* extract domain from string */
414 vtype_string_func, /* value is string returned by given function */
415 vtype_todbsdin, /* value not used; generate BSD inbox tod */
416 vtype_tode, /* value not used; generate tod in epoch format */
417 vtype_todel, /* value not used; generate tod in epoch/usec format */
418 vtype_todf, /* value not used; generate full tod */
419 vtype_todl, /* value not used; generate log tod */
420 vtype_todlf, /* value not used; generate log file datestamp tod */
421 vtype_todzone, /* value not used; generate time zone only */
422 vtype_todzulu, /* value not used; generate zulu tod */
423 vtype_reply, /* value not used; get reply from headers */
424 vtype_pid, /* value not used; result is pid */
425 vtype_host_lookup, /* value not used; get host name */
426 vtype_load_avg, /* value not used; result is int from os_getloadavg */
427 vtype_pspace, /* partition space; value is T/F for spool/log */
428 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
429 vtype_cert /* SSL certificate */
431 ,vtype_dkim /* Lookup of value in DKIM signature */
435 /* Type for main variable table */
443 /* Type for entries pointing to address/length pairs. Not currently
451 static uschar * fn_recipients(void);
453 /* This table must be kept in alphabetical order. */
455 static var_entry var_table[] = {
456 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
457 they will be confused with user-creatable ACL variables. */
458 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
459 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
460 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
461 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
462 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
463 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
464 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
465 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
466 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
467 { "acl_narg", vtype_int, &acl_narg },
468 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
469 { "address_data", vtype_stringptr, &deliver_address_data },
470 { "address_file", vtype_stringptr, &address_file },
471 { "address_pipe", vtype_stringptr, &address_pipe },
472 #ifdef EXPERIMENTAL_ARC
473 { "arc_domains", vtype_string_func, &fn_arc_domains },
474 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
475 { "arc_state", vtype_stringptr, &arc_state },
476 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
478 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
479 { "authenticated_id", vtype_stringptr, &authenticated_id },
480 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
481 { "authentication_failed",vtype_int, &authentication_failed },
482 #ifdef WITH_CONTENT_SCAN
483 { "av_failed", vtype_int, &av_failed },
485 #ifdef EXPERIMENTAL_BRIGHTMAIL
486 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
487 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
488 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
489 { "bmi_deliver", vtype_int, &bmi_deliver },
491 { "body_linecount", vtype_int, &body_linecount },
492 { "body_zerocount", vtype_int, &body_zerocount },
493 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
494 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
495 { "caller_gid", vtype_gid, &real_gid },
496 { "caller_uid", vtype_uid, &real_uid },
497 { "callout_address", vtype_stringptr, &callout_address },
498 { "compile_date", vtype_stringptr, &version_date },
499 { "compile_number", vtype_stringptr, &version_cnumber },
500 { "config_dir", vtype_stringptr, &config_main_directory },
501 { "config_file", vtype_stringptr, &config_main_filename },
502 { "csa_status", vtype_stringptr, &csa_status },
503 #ifdef EXPERIMENTAL_DCC
504 { "dcc_header", vtype_stringptr, &dcc_header },
505 { "dcc_result", vtype_stringptr, &dcc_result },
508 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
509 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
510 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
511 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
512 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
513 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
514 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
515 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
516 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
517 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
518 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
519 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
520 { "dkim_key_length", vtype_int, &dkim_key_length },
521 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
522 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
523 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
524 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
525 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
526 { "dkim_signers", vtype_stringptr, &dkim_signers },
527 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
528 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
530 #ifdef EXPERIMENTAL_DMARC
531 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
532 { "dmarc_status", vtype_stringptr, &dmarc_status },
533 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
534 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
536 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
537 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
538 { "dnslist_text", vtype_stringptr, &dnslist_text },
539 { "dnslist_value", vtype_stringptr, &dnslist_value },
540 { "domain", vtype_stringptr, &deliver_domain },
541 { "domain_data", vtype_stringptr, &deliver_domain_data },
542 #ifndef DISABLE_EVENT
543 { "event_data", vtype_stringptr, &event_data },
545 /*XXX want to use generic vars for as many of these as possible*/
546 { "event_defer_errno", vtype_int, &event_defer_errno },
548 { "event_name", vtype_stringptr, &event_name },
550 { "exim_gid", vtype_gid, &exim_gid },
551 { "exim_path", vtype_stringptr, &exim_path },
552 { "exim_uid", vtype_uid, &exim_uid },
553 { "exim_version", vtype_stringptr, &version_string },
554 { "headers_added", vtype_string_func, &fn_hdrs_added },
555 { "home", vtype_stringptr, &deliver_home },
556 { "host", vtype_stringptr, &deliver_host },
557 { "host_address", vtype_stringptr, &deliver_host_address },
558 { "host_data", vtype_stringptr, &host_data },
559 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
560 { "host_lookup_failed", vtype_int, &host_lookup_failed },
561 { "host_port", vtype_int, &deliver_host_port },
562 { "initial_cwd", vtype_stringptr, &initial_cwd },
563 { "inode", vtype_ino, &deliver_inode },
564 { "interface_address", vtype_stringptr, &interface_address },
565 { "interface_port", vtype_int, &interface_port },
566 { "item", vtype_stringptr, &iterate_item },
568 { "ldap_dn", vtype_stringptr, &eldap_dn },
570 { "load_average", vtype_load_avg, NULL },
571 { "local_part", vtype_stringptr, &deliver_localpart },
572 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
573 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
574 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
575 #ifdef HAVE_LOCAL_SCAN
576 { "local_scan_data", vtype_stringptr, &local_scan_data },
578 { "local_user_gid", vtype_gid, &local_user_gid },
579 { "local_user_uid", vtype_uid, &local_user_uid },
580 { "localhost_number", vtype_int, &host_number },
581 { "log_inodes", vtype_pinodes, (void *)FALSE },
582 { "log_space", vtype_pspace, (void *)FALSE },
583 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
584 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
585 #ifdef WITH_CONTENT_SCAN
586 { "malware_name", vtype_stringptr, &malware_name },
588 { "max_received_linelength", vtype_int, &max_received_linelength },
589 { "message_age", vtype_int, &message_age },
590 { "message_body", vtype_msgbody, &message_body },
591 { "message_body_end", vtype_msgbody_end, &message_body_end },
592 { "message_body_size", vtype_int, &message_body_size },
593 { "message_exim_id", vtype_stringptr, &message_id },
594 { "message_headers", vtype_msgheaders, NULL },
595 { "message_headers_raw", vtype_msgheaders_raw, NULL },
596 { "message_id", vtype_stringptr, &message_id },
597 { "message_linecount", vtype_int, &message_linecount },
598 { "message_size", vtype_int, &message_size },
600 { "message_smtputf8", vtype_bool, &message_smtputf8 },
602 #ifdef WITH_CONTENT_SCAN
603 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
604 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
605 { "mime_boundary", vtype_stringptr, &mime_boundary },
606 { "mime_charset", vtype_stringptr, &mime_charset },
607 { "mime_content_description", vtype_stringptr, &mime_content_description },
608 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
609 { "mime_content_id", vtype_stringptr, &mime_content_id },
610 { "mime_content_size", vtype_int, &mime_content_size },
611 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
612 { "mime_content_type", vtype_stringptr, &mime_content_type },
613 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
614 { "mime_filename", vtype_stringptr, &mime_filename },
615 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
616 { "mime_is_multipart", vtype_int, &mime_is_multipart },
617 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
618 { "mime_part_count", vtype_int, &mime_part_count },
620 { "n0", vtype_filter_int, &filter_n[0] },
621 { "n1", vtype_filter_int, &filter_n[1] },
622 { "n2", vtype_filter_int, &filter_n[2] },
623 { "n3", vtype_filter_int, &filter_n[3] },
624 { "n4", vtype_filter_int, &filter_n[4] },
625 { "n5", vtype_filter_int, &filter_n[5] },
626 { "n6", vtype_filter_int, &filter_n[6] },
627 { "n7", vtype_filter_int, &filter_n[7] },
628 { "n8", vtype_filter_int, &filter_n[8] },
629 { "n9", vtype_filter_int, &filter_n[9] },
630 { "original_domain", vtype_stringptr, &deliver_domain_orig },
631 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
632 { "originator_gid", vtype_gid, &originator_gid },
633 { "originator_uid", vtype_uid, &originator_uid },
634 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
635 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
636 { "pid", vtype_pid, NULL },
638 { "prdr_requested", vtype_bool, &prdr_requested },
640 { "primary_hostname", vtype_stringptr, &primary_hostname },
641 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
642 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
643 { "proxy_external_port", vtype_int, &proxy_external_port },
644 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
645 { "proxy_local_port", vtype_int, &proxy_local_port },
646 { "proxy_session", vtype_bool, &proxy_session },
648 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
649 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
650 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
651 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
652 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
653 { "queue_name", vtype_stringptr, &queue_name },
654 { "rcpt_count", vtype_int, &rcpt_count },
655 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
656 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
657 { "received_count", vtype_int, &received_count },
658 { "received_for", vtype_stringptr, &received_for },
659 { "received_ip_address", vtype_stringptr, &interface_address },
660 { "received_port", vtype_int, &interface_port },
661 { "received_protocol", vtype_stringptr, &received_protocol },
662 { "received_time", vtype_int, &received_time.tv_sec },
663 { "recipient_data", vtype_stringptr, &recipient_data },
664 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
665 { "recipients", vtype_string_func, &fn_recipients },
666 { "recipients_count", vtype_int, &recipients_count },
667 #ifdef WITH_CONTENT_SCAN
668 { "regex_match_string", vtype_stringptr, ®ex_match_string },
670 { "reply_address", vtype_reply, NULL },
671 #if defined(SUPPORT_TLS) && defined(EXPERIMENTAL_REQUIRETLS)
672 { "requiretls", vtype_bool, &tls_requiretls },
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, &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 #if defined(SUPPORT_TLS)
758 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
760 { "tls_out_bits", vtype_int, &tls_out.bits },
761 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
762 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
763 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },
765 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
767 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
768 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
769 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
770 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
771 #if defined(SUPPORT_TLS)
772 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
775 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
778 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
779 #if defined(SUPPORT_TLS)
780 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
783 { "tod_bsdinbox", vtype_todbsdin, NULL },
784 { "tod_epoch", vtype_tode, NULL },
785 { "tod_epoch_l", vtype_todel, NULL },
786 { "tod_full", vtype_todf, NULL },
787 { "tod_log", vtype_todl, NULL },
788 { "tod_logfile", vtype_todlf, NULL },
789 { "tod_zone", vtype_todzone, NULL },
790 { "tod_zulu", vtype_todzulu, NULL },
791 { "transport_name", vtype_stringptr, &transport_name },
792 { "value", vtype_stringptr, &lookup_value },
793 { "verify_mode", vtype_stringptr, &verify_mode },
794 { "version_number", vtype_stringptr, &version_string },
795 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
796 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
797 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
798 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
799 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
800 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
803 static int var_table_size = nelem(var_table);
804 static uschar var_buffer[256];
805 static BOOL malformed_header;
807 /* For textual hashes */
809 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
810 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
813 enum { HMAC_MD5, HMAC_SHA1 };
815 /* For numeric hashes */
817 static unsigned int prime[] = {
818 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
819 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
820 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
822 /* For printing modes in symbolic form */
824 static uschar *mtable_normal[] =
825 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
827 static uschar *mtable_setid[] =
828 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
830 static uschar *mtable_sticky[] =
831 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
833 /* flags for find_header() */
834 #define FH_EXISTS_ONLY BIT(0)
835 #define FH_WANT_RAW BIT(1)
836 #define FH_WANT_LIST BIT(2)
839 /*************************************************
840 * Tables for UTF-8 support *
841 *************************************************/
843 /* Table of the number of extra characters, indexed by the first character
844 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
847 static uschar utf8_table1[] = {
848 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
849 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
850 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
851 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
853 /* These are the masks for the data bits in the first byte of a character,
854 indexed by the number of additional bytes. */
856 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
858 /* Get the next UTF-8 character, advancing the pointer. */
860 #define GETUTF8INC(c, ptr) \
862 if ((c & 0xc0) == 0xc0) \
864 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
866 c = (c & utf8_table2[a]) << s; \
870 c |= (*ptr++ & 0x3f) << s; \
876 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
878 /*************************************************
879 * Binary chop search on a table *
880 *************************************************/
882 /* This is used for matching expansion items and operators.
885 name the name that is being sought
886 table the table to search
887 table_size the number of items in the table
889 Returns: the offset in the table, or -1
893 chop_match(uschar *name, uschar **table, int table_size)
895 uschar **bot = table;
896 uschar **top = table + table_size;
900 uschar **mid = bot + (top - bot)/2;
901 int c = Ustrcmp(name, *mid);
902 if (c == 0) return mid - table;
903 if (c > 0) bot = mid + 1; else top = mid;
911 /*************************************************
912 * Check a condition string *
913 *************************************************/
915 /* This function is called to expand a string, and test the result for a "true"
916 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
917 forced fail or lookup defer.
919 We used to release all store used, but this is not not safe due
920 to ${dlfunc } and ${acl }. In any case expand_string_internal()
921 is reasonably careful to release what it can.
923 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
926 condition the condition string
927 m1 text to be incorporated in panic error
930 Returns: TRUE if condition is met, FALSE if not
934 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
937 uschar *ss = expand_string(condition);
940 if (!f.expand_string_forcedfail && !f.search_find_defer)
941 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
942 "for %s %s: %s", condition, m1, m2, expand_string_message);
945 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
946 strcmpic(ss, US"false") != 0;
953 /*************************************************
954 * Pseudo-random number generation *
955 *************************************************/
957 /* Pseudo-random number generation. The result is not "expected" to be
958 cryptographically strong but not so weak that someone will shoot themselves
959 in the foot using it as a nonce in some email header scheme or whatever
960 weirdness they'll twist this into. The result should ideally handle fork().
962 However, if we're stuck unable to provide this, then we'll fall back to
963 appallingly bad randomness.
965 If SUPPORT_TLS is defined then this will not be used except as an emergency
970 Returns a random number in range [0, max-1]
974 # define vaguely_random_number vaguely_random_number_fallback
977 vaguely_random_number(int max)
980 # undef vaguely_random_number
982 static pid_t pid = 0;
984 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
994 #ifdef HAVE_ARC4RANDOM
995 /* cryptographically strong randomness, common on *BSD platforms, not
996 so much elsewhere. Alas. */
997 #ifndef NOT_HAVE_ARC4RANDOM_STIR
1000 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1001 #ifdef HAVE_SRANDOMDEV
1002 /* uses random(4) for seeding */
1005 gettimeofday(&tv, NULL);
1006 srandom(tv.tv_sec | tv.tv_usec | getpid());
1009 /* Poor randomness and no seeding here */
1016 #ifdef HAVE_ARC4RANDOM
1017 return arc4random() % max;
1018 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1019 return random() % max;
1021 /* This one returns a 16-bit number, definitely not crypto-strong */
1022 return random_number(max);
1029 /*************************************************
1030 * Pick out a name from a string *
1031 *************************************************/
1033 /* If the name is too long, it is silently truncated.
1036 name points to a buffer into which to put the name
1037 max is the length of the buffer
1038 s points to the first alphabetic character of the name
1039 extras chars other than alphanumerics to permit
1041 Returns: pointer to the first character after the name
1043 Note: The test for *s != 0 in the while loop is necessary because
1044 Ustrchr() yields non-NULL if the character is zero (which is not something
1047 static const uschar *
1048 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1051 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1053 if (ptr < max-1) name[ptr++] = *s;
1062 /*************************************************
1063 * Pick out the rest of a header name *
1064 *************************************************/
1066 /* A variable name starting $header_ (or just $h_ for those who like
1067 abbreviations) might not be the complete header name because headers can
1068 contain any printing characters in their names, except ':'. This function is
1069 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1070 on the end, if the name was terminated by white space.
1073 name points to a buffer in which the name read so far exists
1074 max is the length of the buffer
1075 s points to the first character after the name so far, i.e. the
1076 first non-alphameric character after $header_xxxxx
1078 Returns: a pointer to the first character after the header name
1081 static const uschar *
1082 read_header_name(uschar *name, int max, const uschar *s)
1084 int prelen = Ustrchr(name, '_') - name + 1;
1085 int ptr = Ustrlen(name) - prelen;
1086 if (ptr > 0) memmove(name, name+prelen, ptr);
1087 while (mac_isgraph(*s) && *s != ':')
1089 if (ptr < max-1) name[ptr++] = *s;
1100 /*************************************************
1101 * Pick out a number from a string *
1102 *************************************************/
1105 n points to an integer into which to put the number
1106 s points to the first digit of the number
1108 Returns: a pointer to the character after the last digit
1110 /*XXX consider expanding to int_eximarith_t. But the test for
1111 "overbig numbers" in 0002 still needs to overflow it. */
1114 read_number(int *n, uschar *s)
1117 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1121 static const uschar *
1122 read_cnumber(int *n, const uschar *s)
1125 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1131 /*************************************************
1132 * Extract keyed subfield from a string *
1133 *************************************************/
1135 /* The yield is in dynamic store; NULL means that the key was not found.
1138 key points to the name of the key
1139 s points to the string from which to extract the subfield
1141 Returns: NULL if the subfield was not found, or
1142 a pointer to the subfield's data
1146 expand_getkeyed(uschar * key, const uschar * s)
1148 int length = Ustrlen(key);
1149 while (isspace(*s)) s++;
1151 /* Loop to search for the key */
1157 const uschar * dkey = s;
1159 while (*s && *s != '=' && !isspace(*s)) s++;
1160 dkeylength = s - dkey;
1161 while (isspace(*s)) s++;
1162 if (*s == '=') while (isspace((*(++s))));
1164 data = string_dequote(&s);
1165 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1168 while (isspace(*s)) s++;
1177 find_var_ent(uschar * name)
1180 int last = var_table_size;
1182 while (last > first)
1184 int middle = (first + last)/2;
1185 int c = Ustrcmp(name, var_table[middle].name);
1187 if (c > 0) { first = middle + 1; continue; }
1188 if (c < 0) { last = middle; continue; }
1189 return &var_table[middle];
1194 /*************************************************
1195 * Extract numbered subfield from string *
1196 *************************************************/
1198 /* Extracts a numbered field from a string that is divided by tokens - for
1199 example a line from /etc/passwd is divided by colon characters. First field is
1200 numbered one. Negative arguments count from the right. Zero returns the whole
1201 string. Returns NULL if there are insufficient tokens in the string
1204 Modifies final argument - this is a dynamically generated string, so that's OK.
1207 field number of field to be extracted,
1208 first field = 1, whole string = 0, last field = -1
1209 separators characters that are used to break string into tokens
1210 s points to the string from which to extract the subfield
1212 Returns: NULL if the field was not found,
1213 a pointer to the field's data inside s (modified to add 0)
1217 expand_gettokened (int field, uschar *separators, uschar *s)
1222 uschar *fieldtext = NULL;
1224 if (field == 0) return s;
1226 /* Break the line up into fields in place; for field > 0 we stop when we have
1227 done the number of fields we want. For field < 0 we continue till the end of
1228 the string, counting the number of fields. */
1230 count = (field > 0)? field : INT_MAX;
1236 /* Previous field was the last one in the string. For a positive field
1237 number, this means there are not enough fields. For a negative field number,
1238 check that there are enough, and scan back to find the one that is wanted. */
1242 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1243 if ((-field) == (INT_MAX - count - 1)) return s;
1247 while (ss[-1] != 0) ss--;
1253 /* Previous field was not last in the string; save its start and put a
1257 len = Ustrcspn(ss, separators);
1268 expand_getlistele(int field, const uschar * list)
1270 const uschar * tlist = list;
1276 for (field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1279 if (field == 0) return NULL;
1280 while (--field > 0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1281 return string_nextinlist(&list, &sep, NULL, 0);
1285 /* Certificate fields, by name. Worry about by-OID later */
1286 /* Names are chosen to not have common prefixes */
1293 uschar * (*getfn)(void * cert, uschar * mod);
1295 static certfield certfields[] =
1296 { /* linear search; no special order */
1297 { US"version", 7, &tls_cert_version },
1298 { US"serial_number", 13, &tls_cert_serial_number },
1299 { US"subject", 7, &tls_cert_subject },
1300 { US"notbefore", 9, &tls_cert_not_before },
1301 { US"notafter", 8, &tls_cert_not_after },
1302 { US"issuer", 6, &tls_cert_issuer },
1303 { US"signature", 9, &tls_cert_signature },
1304 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1305 { US"subj_altname", 12, &tls_cert_subject_altname },
1306 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1307 { US"crl_uri", 7, &tls_cert_crl_uri },
1311 expand_getcertele(uschar * field, uschar * certvar)
1315 if (!(vp = find_var_ent(certvar)))
1317 expand_string_message =
1318 string_sprintf("no variable named \"%s\"", certvar);
1319 return NULL; /* Unknown variable name */
1321 /* NB this stops us passing certs around in variable. Might
1322 want to do that in future */
1323 if (vp->type != vtype_cert)
1325 expand_string_message =
1326 string_sprintf("\"%s\" is not a certificate", certvar);
1327 return NULL; /* Unknown variable name */
1329 if (!*(void **)vp->value)
1332 if (*field >= '0' && *field <= '9')
1333 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1335 for (certfield * cp = certfields;
1336 cp < certfields + nelem(certfields);
1338 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1340 uschar * modifier = *(field += cp->namelen) == ','
1342 return (*cp->getfn)( *(void **)vp->value, modifier );
1345 expand_string_message =
1346 string_sprintf("bad field selector \"%s\" for certextract", field);
1349 #endif /*SUPPORT_TLS*/
1351 /*************************************************
1352 * Extract a substring from a string *
1353 *************************************************/
1355 /* Perform the ${substr or ${length expansion operations.
1358 subject the input string
1359 value1 the offset from the start of the input string to the start of
1360 the output string; if negative, count from the right.
1361 value2 the length of the output string, or negative (-1) for unset
1362 if value1 is positive, unset means "all after"
1363 if value1 is negative, unset means "all before"
1364 len set to the length of the returned string
1366 Returns: pointer to the output string, or NULL if there is an error
1370 extract_substr(uschar *subject, int value1, int value2, int *len)
1372 int sublen = Ustrlen(subject);
1374 if (value1 < 0) /* count from right */
1378 /* If the position is before the start, skip to the start, and adjust the
1379 length. If the length ends up negative, the substring is null because nothing
1380 can precede. This falls out naturally when the length is unset, meaning "all
1386 if (value2 < 0) value2 = 0;
1390 /* Otherwise an unset length => characters before value1 */
1392 else if (value2 < 0)
1399 /* For a non-negative offset, if the starting position is past the end of the
1400 string, the result will be the null string. Otherwise, an unset length means
1401 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1405 if (value1 > sublen)
1410 else if (value2 < 0) value2 = sublen;
1413 /* Cut the length down to the maximum possible for the offset value, and get
1414 the required characters. */
1416 if (value1 + value2 > sublen) value2 = sublen - value1;
1418 return subject + value1;
1424 /*************************************************
1425 * Old-style hash of a string *
1426 *************************************************/
1428 /* Perform the ${hash expansion operation.
1431 subject the input string (an expanded substring)
1432 value1 the length of the output string; if greater or equal to the
1433 length of the input string, the input string is returned
1434 value2 the number of hash characters to use, or 26 if negative
1435 len set to the length of the returned string
1437 Returns: pointer to the output string, or NULL if there is an error
1441 compute_hash(uschar *subject, int value1, int value2, int *len)
1443 int sublen = Ustrlen(subject);
1445 if (value2 < 0) value2 = 26;
1446 else if (value2 > Ustrlen(hashcodes))
1448 expand_string_message =
1449 string_sprintf("hash count \"%d\" too big", value2);
1453 /* Calculate the hash text. We know it is shorter than the original string, so
1454 can safely place it in subject[] (we know that subject is always itself an
1455 expanded substring). */
1457 if (value1 < sublen)
1462 while ((c = (subject[j])) != 0)
1464 int shift = (c + j++) & 7;
1465 subject[i] ^= (c << shift) | (c >> (8-shift));
1466 if (++i >= value1) i = 0;
1468 for (i = 0; i < value1; i++)
1469 subject[i] = hashcodes[(subject[i]) % value2];
1471 else value1 = sublen;
1480 /*************************************************
1481 * Numeric hash of a string *
1482 *************************************************/
1484 /* Perform the ${nhash expansion operation. The first characters of the
1485 string are treated as most important, and get the highest prime numbers.
1488 subject the input string
1489 value1 the maximum value of the first part of the result
1490 value2 the maximum value of the second part of the result,
1491 or negative to produce only a one-part result
1492 len set to the length of the returned string
1494 Returns: pointer to the output string, or NULL if there is an error.
1498 compute_nhash (uschar *subject, int value1, int value2, int *len)
1500 uschar *s = subject;
1502 unsigned long int total = 0; /* no overflow */
1506 if (i == 0) i = nelem(prime) - 1;
1507 total += prime[i--] * (unsigned int)(*s++);
1510 /* If value2 is unset, just compute one number */
1513 s = string_sprintf("%lu", total % value1);
1515 /* Otherwise do a div/mod hash */
1519 total = total % (value1 * value2);
1520 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1531 /*************************************************
1532 * Find the value of a header or headers *
1533 *************************************************/
1535 /* Multiple instances of the same header get concatenated, and this function
1536 can also return a concatenation of all the header lines. When concatenating
1537 specific headers that contain lists of addresses, a comma is inserted between
1538 them. Otherwise we use a straight concatenation. Because some messages can have
1539 pathologically large number of lines, there is a limit on the length that is
1543 name the name of the header, without the leading $header_ or $h_,
1544 or NULL if a concatenation of all headers is required
1545 newsize return the size of memory block that was obtained; may be NULL
1546 if exists_only is TRUE
1547 flags FH_EXISTS_ONLY
1548 set if called from a def: test; don't need to build a string;
1549 just return a string that is not "" and not "0" if the header
1552 set if called for $rh_ or $rheader_ items; no processing,
1553 other than concatenating, will be done on the header. Also used
1554 for $message_headers_raw.
1556 Double colon chars in the content, and replace newline with
1557 colon between each element when concatenating; returning a
1558 colon-sep list (elements might contain newlines)
1559 charset name of charset to translate MIME words to; used only if
1560 want_raw is false; if NULL, no translation is done (this is
1561 used for $bh_ and $bheader_)
1563 Returns: NULL if the header does not exist, else a pointer to a new
1568 find_header(uschar *name, int *newsize, unsigned flags, uschar *charset)
1571 int len = name ? Ustrlen(name) : 0;
1575 for (header_line * h = header_list; h; h = h->next)
1576 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1577 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1582 if (flags & FH_EXISTS_ONLY)
1583 return US"1"; /* don't need actual string */
1586 s = h->text + len; /* text to insert */
1587 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1588 while (isspace(*s)) s++; /* remove leading white space */
1589 t = h->text + h->slen; /* end-point */
1591 /* Unless wanted raw, remove trailing whitespace, including the
1594 if (flags & FH_WANT_LIST)
1595 while (t > s && t[-1] == '\n') t--;
1596 else if (!(flags & FH_WANT_RAW))
1598 while (t > s && isspace(t[-1])) t--;
1600 /* Set comma if handling a single header and it's one of those
1601 that contains an address list, except when asked for raw headers. Only
1602 need to do this once. */
1604 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1607 /* Trim the header roughly if we're approaching limits */
1609 if ((g ? g->ptr : 0) + inc > header_insert_maxlen)
1610 inc = header_insert_maxlen - (g ? g->ptr : 0);
1612 /* For raw just copy the data; for a list, add the data as a colon-sep
1613 list-element; for comma-list add as an unchecked comma,newline sep
1614 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1615 stripped trailing WS above including the newline). We ignore the potential
1616 expansion due to colon-doubling, just leaving the loop if the limit is met
1619 if (flags & FH_WANT_LIST)
1620 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1621 else if (flags & FH_WANT_RAW)
1623 g = string_catn(g, s, (unsigned)inc);
1624 (void) string_from_gstring(g);
1628 g = string_append2_listele_n(g, US",\n", s, (unsigned)inc);
1630 g = string_append2_listele_n(g, US"\n", s, (unsigned)inc);
1632 if (g && g->ptr >= header_insert_maxlen) break;
1635 if (!found) return NULL; /* No header found */
1636 if (!g) return US"";
1638 /* That's all we do for raw header expansion. */
1641 if (flags & FH_WANT_RAW)
1644 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1645 The rfc2047_decode2() function can return an error with decoded data if the
1646 charset translation fails. If decoding fails, it returns NULL. */
1650 uschar *decoded, *error;
1652 decoded = rfc2047_decode2(g->s, check_rfc2047_length, charset, '?', NULL,
1656 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1657 " input was: %s\n", error, g->s);
1659 return decoded ? decoded : g->s;
1666 /* Append a "local" element to an Authentication-Results: header
1667 if this was a non-smtp message.
1671 authres_local(gstring * g, const uschar * sysname)
1673 if (!f.authentication_local)
1675 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1676 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1681 /* Append an "iprev" element to an Authentication-Results: header
1682 if we have attempted to get the calling host's name.
1686 authres_iprev(gstring * g)
1688 if (sender_host_name)
1689 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1690 else if (host_lookup_deferred)
1691 g = string_catn(g, US";\n\tiprev=temperror", 19);
1692 else if (host_lookup_failed)
1693 g = string_catn(g, US";\n\tiprev=fail", 13);
1697 if (sender_host_address)
1698 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1704 /*************************************************
1705 * Return list of recipients *
1706 *************************************************/
1707 /* A recipients list is available only during system message filtering,
1708 during ACL processing after DATA, and while expanding pipe commands
1709 generated from a system filter, but not elsewhere. */
1717 if (!f.enable_dollar_recipients) return NULL;
1719 for (int i = 0; i < recipients_count; i++)
1721 s = recipients_list[i].address;
1722 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1724 return g ? g->s : NULL;
1728 /*************************************************
1729 * Find value of a variable *
1730 *************************************************/
1732 /* The table of variables is kept in alphabetic order, so we can search it
1733 using a binary chop. The "choplen" variable is nothing to do with the binary
1737 name the name of the variable being sought
1738 exists_only TRUE if this is a def: test; passed on to find_header()
1739 skipping TRUE => skip any processing evaluation; this is not the same as
1740 exists_only because def: may test for values that are first
1742 newsize pointer to an int which is initially zero; if the answer is in
1743 a new memory buffer, *newsize is set to its size
1745 Returns: NULL if the variable does not exist, or
1746 a pointer to the variable's contents, or
1747 something non-NULL if exists_only is TRUE
1751 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1758 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1759 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1760 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1761 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1762 (this gave backwards compatibility at the changeover). There may be built-in
1763 variables whose names start acl_ but they should never start in this way. This
1764 slightly messy specification is a consequence of the history, needless to say.
1766 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1767 set, in which case give an error. */
1769 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1773 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1774 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1777 /* Handle $auth<n> variables. */
1779 if (Ustrncmp(name, "auth", 4) == 0)
1782 int n = Ustrtoul(name + 4, &endptr, 10);
1783 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1784 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1786 else if (Ustrncmp(name, "regex", 5) == 0)
1789 int n = Ustrtoul(name + 5, &endptr, 10);
1790 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1791 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1794 /* For all other variables, search the table */
1796 if (!(vp = find_var_ent(name)))
1797 return NULL; /* Unknown variable name */
1799 /* Found an existing variable. If in skipping state, the value isn't needed,
1800 and we want to avoid processing (such as looking up the host name). */
1808 case vtype_filter_int:
1809 if (!f.filter_running) return NULL;
1813 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1817 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1821 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1825 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1829 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1832 case vtype_stringptr: /* Pointer to string */
1833 return (s = *((uschar **)(val))) ? s : US"";
1836 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1839 case vtype_load_avg:
1840 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1843 case vtype_host_lookup: /* Lookup if not done so */
1844 if ( !sender_host_name && sender_host_address
1845 && !host_lookup_failed && host_name_lookup() == OK)
1846 host_build_sender_fullhost();
1847 return sender_host_name ? sender_host_name : US"";
1849 case vtype_localpart: /* Get local part from address */
1850 s = *((uschar **)(val));
1851 if (s == NULL) return US"";
1852 domain = Ustrrchr(s, '@');
1853 if (domain == NULL) return s;
1854 if (domain - s > sizeof(var_buffer) - 1)
1855 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1856 " in string expansion", sizeof(var_buffer));
1857 Ustrncpy(var_buffer, s, domain - s);
1858 var_buffer[domain - s] = 0;
1861 case vtype_domain: /* Get domain from address */
1862 s = *((uschar **)(val));
1863 if (s == NULL) return US"";
1864 domain = Ustrrchr(s, '@');
1865 return (domain == NULL)? US"" : domain + 1;
1867 case vtype_msgheaders:
1868 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
1870 case vtype_msgheaders_raw:
1871 return find_header(NULL, newsize,
1872 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
1874 case vtype_msgbody: /* Pointer to msgbody string */
1875 case vtype_msgbody_end: /* Ditto, the end of the msg */
1876 ss = (uschar **)(val);
1877 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1880 off_t start_offset = SPOOL_DATA_START_OFFSET;
1881 int len = message_body_visible;
1882 if (len > message_size) len = message_size;
1883 *ss = body = store_malloc(len+1);
1885 if (vp->type == vtype_msgbody_end)
1887 struct stat statbuf;
1888 if (fstat(deliver_datafile, &statbuf) == 0)
1890 start_offset = statbuf.st_size - len;
1891 if (start_offset < SPOOL_DATA_START_OFFSET)
1892 start_offset = SPOOL_DATA_START_OFFSET;
1895 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1896 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1898 len = read(deliver_datafile, body, len);
1902 if (message_body_newlines) /* Separate loops for efficiency */
1904 { if (body[--len] == 0) body[len] = ' '; }
1907 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1910 return *ss ? *ss : US"";
1912 case vtype_todbsdin: /* BSD inbox time of day */
1913 return tod_stamp(tod_bsdin);
1915 case vtype_tode: /* Unix epoch time of day */
1916 return tod_stamp(tod_epoch);
1918 case vtype_todel: /* Unix epoch/usec time of day */
1919 return tod_stamp(tod_epoch_l);
1921 case vtype_todf: /* Full time of day */
1922 return tod_stamp(tod_full);
1924 case vtype_todl: /* Log format time of day */
1925 return tod_stamp(tod_log_bare); /* (without timezone) */
1927 case vtype_todzone: /* Time zone offset only */
1928 return tod_stamp(tod_zone);
1930 case vtype_todzulu: /* Zulu time */
1931 return tod_stamp(tod_zulu);
1933 case vtype_todlf: /* Log file datestamp tod */
1934 return tod_stamp(tod_log_datestamp_daily);
1936 case vtype_reply: /* Get reply address */
1937 s = find_header(US"reply-to:", newsize,
1938 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
1940 if (s) while (isspace(*s)) s++;
1943 *newsize = 0; /* For the *s==0 case */
1944 s = find_header(US"from:", newsize,
1945 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
1951 while (isspace(*s)) s++;
1952 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1953 while (t > s && isspace(t[-1])) t--;
1956 return s ? s : US"";
1958 case vtype_string_func:
1960 uschar * (*fn)() = val;
1967 sprintf(CS var_buffer, PR_EXIM_ARITH,
1968 receive_statvfs(val == (void *)TRUE, &inodes));
1975 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1976 sprintf(CS var_buffer, "%d", inodes);
1981 return *(void **)val ? US"<cert>" : US"";
1983 #ifndef DISABLE_DKIM
1985 return dkim_exim_expand_query((int)(long)val);
1990 return NULL; /* Unknown variable. Silences static checkers. */
1997 modify_variable(uschar *name, void * value)
2000 if ((vp = find_var_ent(name))) vp->value = value;
2001 return; /* Unknown variable name, fail silently */
2009 /*************************************************
2010 * Read and expand substrings *
2011 *************************************************/
2013 /* This function is called to read and expand argument substrings for various
2014 expansion items. Some have a minimum requirement that is less than the maximum;
2015 in these cases, the first non-present one is set to NULL.
2018 sub points to vector of pointers to set
2019 n maximum number of substrings
2021 sptr points to current string pointer
2022 skipping the skipping flag
2023 check_end if TRUE, check for final '}'
2024 name name of item, for error message
2025 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2028 Returns: 0 OK; string pointer updated
2029 1 curly bracketing error (too few arguments)
2030 2 too many arguments (only if check_end is set); message set
2031 3 other error (expansion failure)
2035 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
2036 BOOL check_end, uschar *name, BOOL *resetok)
2038 const uschar *s = *sptr;
2040 while (isspace(*s)) s++;
2041 for (int i = 0; i < n; i++)
2047 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2048 "(min is %d)", name, m);
2054 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2056 if (*s++ != '}') return 1;
2057 while (isspace(*s)) s++;
2059 if (check_end && *s++ != '}')
2063 expand_string_message = string_sprintf("Too many arguments for '%s' "
2064 "(max is %d)", name, n);
2067 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2078 /*************************************************
2079 * Elaborate message for bad variable *
2080 *************************************************/
2082 /* For the "unknown variable" message, take a look at the variable's name, and
2083 give additional information about possible ACL variables. The extra information
2084 is added on to expand_string_message.
2086 Argument: the name of the variable
2091 check_variable_error_message(uschar *name)
2093 if (Ustrncmp(name, "acl_", 4) == 0)
2094 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2095 (name[4] == 'c' || name[4] == 'm')?
2097 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2098 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2100 US"user-defined ACL variables must start acl_c or acl_m");
2106 Load args from sub array to globals, and call acl_check().
2107 Sub array will be corrupted on return.
2109 Returns: OK access is granted by an ACCEPT verb
2110 DISCARD access is (apparently) granted by a DISCARD verb
2111 FAIL access is denied
2112 FAIL_DROP access is denied; drop the connection
2113 DEFER can't tell at the moment
2117 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2120 int sav_narg = acl_narg;
2122 uschar * dummy_logmsg;
2123 extern int acl_where;
2125 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2126 for (i = 0; i < nsub && sub[i+1]; i++)
2128 uschar * tmp = acl_arg[i];
2129 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2130 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2135 sub[i+1] = acl_arg[i];
2136 acl_arg[i++] = NULL;
2140 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2142 acl_narg>0 ? acl_arg[0] : US"<none>",
2143 acl_narg>1 ? " +more" : "");
2145 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2147 for (i = 0; i < nsub; i++)
2148 acl_arg[i] = sub[i+1]; /* restore old args */
2149 acl_narg = sav_narg;
2157 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2158 The given string is modified on return. Leading whitespace is skipped while
2159 looking for the opening wrap character, then the rest is scanned for the trailing
2160 (non-escaped) wrap character. A backslash in the string will act as an escape.
2162 A nul is written over the trailing wrap, and a pointer to the char after the
2163 leading wrap is returned.
2166 s String for de-wrapping
2167 wrap Two-char string, the first being the opener, second the closer wrapping
2170 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2174 dewrap(uschar * s, const uschar * wrap)
2178 BOOL quotesmode = wrap[0] == wrap[1];
2180 while (isspace(*p)) p++;
2188 if (*p == '\\') p++;
2189 else if (!quotesmode && *p == wrap[-1]) depth++;
2190 else if (*p == *wrap)
2201 expand_string_message = string_sprintf("missing '%c'", *wrap);
2206 /* Pull off the leading array or object element, returning
2207 a copy in an allocated string. Update the list pointer.
2209 The element may itself be an abject or array.
2210 Return NULL when the list is empty.
2214 json_nextinlist(const uschar ** list)
2216 unsigned array_depth = 0, object_depth = 0;
2217 const uschar * s = *list, * item;
2219 while (isspace(*s)) s++;
2222 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2226 case '[': array_depth++; break;
2227 case ']': array_depth--; break;
2228 case '{': object_depth++; break;
2229 case '}': object_depth--; break;
2231 *list = *s ? s+1 : s;
2232 if (item == s) return NULL;
2233 item = string_copyn(item, s - item);
2234 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
2240 /*************************************************
2241 * Read and evaluate a condition *
2242 *************************************************/
2246 s points to the start of the condition text
2247 resetok points to a BOOL which is written false if it is unsafe to
2248 free memory. Certain condition types (acl) may have side-effect
2249 allocation which must be preserved.
2250 yield points to a BOOL to hold the result of the condition test;
2251 if NULL, we are just reading through a condition that is
2252 part of an "or" combination to check syntax, or in a state
2253 where the answer isn't required
2255 Returns: a pointer to the first character after the condition, or
2259 static const uschar *
2260 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2262 BOOL testfor = TRUE;
2263 BOOL tempcond, combined_cond;
2265 BOOL sub2_honour_dollar = TRUE;
2266 BOOL is_forany, is_json, is_jsons;
2267 int rc, cond_type, roffset;
2268 int_eximarith_t num[2];
2269 struct stat statbuf;
2271 const uschar *sub[10];
2274 const uschar *rerror;
2278 while (isspace(*s)) s++;
2279 if (*s == '!') { testfor = !testfor; s++; } else break;
2282 /* Numeric comparisons are symbolic */
2284 if (*s == '=' || *s == '>' || *s == '<')
2296 /* All other conditions are named */
2298 else s = read_name(name, 256, s, US"_");
2300 /* If we haven't read a name, it means some non-alpha character is first. */
2304 expand_string_message = string_sprintf("condition name expected, "
2305 "but found \"%.16s\"", s);
2309 /* Find which condition we are dealing with, and switch on it */
2311 cond_type = chop_match(name, cond_table, nelem(cond_table));
2314 /* def: tests for a non-empty variable, or for the existence of a header. If
2315 yield == NULL we are in a skipping state, and don't care about the answer. */
2323 expand_string_message = US"\":\" expected after \"def\"";
2327 s = read_name(name, 256, s+1, US"_");
2329 /* Test for a header's existence. If the name contains a closing brace
2330 character, this may be a user error where the terminating colon has been
2331 omitted. Set a flag to adjust a subsequent error message in this case. */
2333 if ( ( *(t = name) == 'h'
2334 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2336 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2339 s = read_header_name(name, 256, s);
2340 /* {-for-text-editors */
2341 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2343 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2346 /* Test for a variable's having a non-empty value. A non-existent variable
2347 causes an expansion failure. */
2351 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2353 expand_string_message = (name[0] == 0)?
2354 string_sprintf("variable name omitted after \"def:\"") :
2355 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2356 check_variable_error_message(name);
2359 if (yield) *yield = (t[0] != 0) == testfor;
2366 /* first_delivery tests for first delivery attempt */
2368 case ECOND_FIRST_DELIVERY:
2369 if (yield != NULL) *yield = f.deliver_firsttime == testfor;
2373 /* queue_running tests for any process started by a queue runner */
2375 case ECOND_QUEUE_RUNNING:
2376 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2380 /* exists: tests for file existence
2381 isip: tests for any IP address
2382 isip4: tests for an IPv4 address
2383 isip6: tests for an IPv6 address
2384 pam: does PAM authentication
2385 radius: does RADIUS authentication
2386 ldapauth: does LDAP authentication
2387 pwcheck: does Cyrus SASL pwcheck authentication
2396 case ECOND_LDAPAUTH:
2399 while (isspace(*s)) s++;
2400 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2402 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2403 if (sub[0] == NULL) return NULL;
2404 /* {-for-text-editors */
2405 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2407 if (yield == NULL) return s; /* No need to run the test if skipping */
2412 if ((expand_forbid & RDO_EXISTS) != 0)
2414 expand_string_message = US"File existence tests are not permitted";
2417 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2423 rc = string_is_ip_address(sub[0], NULL);
2424 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2425 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2428 /* Various authentication tests - all optionally compiled */
2432 rc = auth_call_pam(sub[0], &expand_string_message);
2435 goto COND_FAILED_NOT_COMPILED;
2436 #endif /* SUPPORT_PAM */
2439 #ifdef RADIUS_CONFIG_FILE
2440 rc = auth_call_radius(sub[0], &expand_string_message);
2443 goto COND_FAILED_NOT_COMPILED;
2444 #endif /* RADIUS_CONFIG_FILE */
2446 case ECOND_LDAPAUTH:
2449 /* Just to keep the interface the same */
2451 int old_pool = store_pool;
2452 store_pool = POOL_SEARCH;
2453 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2454 &expand_string_message, &do_cache);
2455 store_pool = old_pool;
2459 goto COND_FAILED_NOT_COMPILED;
2460 #endif /* LOOKUP_LDAP */
2463 #ifdef CYRUS_PWCHECK_SOCKET
2464 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2467 goto COND_FAILED_NOT_COMPILED;
2468 #endif /* CYRUS_PWCHECK_SOCKET */
2470 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2471 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2473 if (rc == ERROR || rc == DEFER) return NULL;
2474 *yield = (rc == OK) == testfor;
2480 /* call ACL (in a conditional context). Accept true, deny false.
2481 Defer is a forced-fail. Anything set by message= goes to $value.
2482 Up to ten parameters are used; we use the braces round the name+args
2483 like the saslauthd condition does, to permit a variable number of args.
2484 See also the expansion-item version EITEM_ACL and the traditional
2485 acl modifier ACLC_ACL.
2486 Since the ACL may allocate new global variables, tell our caller to not
2491 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2497 while (isspace(*s)) s++;
2498 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2500 switch(read_subs(sub, nelem(sub), 1,
2501 &s, yield == NULL, TRUE, US"acl", resetok))
2503 case 1: expand_string_message = US"too few arguments or bracketing "
2506 case 3: return NULL;
2511 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2512 switch(eval_acl(sub, nelem(sub), &user_msg))
2517 lookup_value = NULL;
2519 lookup_value = string_copy(user_msg);
2520 *yield = cond == testfor;
2524 f.expand_string_forcedfail = TRUE;
2527 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2535 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2537 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2539 However, the last two are optional. That is why the whole set is enclosed
2540 in their own set of braces. */
2542 case ECOND_SASLAUTHD:
2543 #ifndef CYRUS_SASLAUTHD_SOCKET
2544 goto COND_FAILED_NOT_COMPILED;
2548 while (isspace(*s)) s++;
2549 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2550 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2553 case 1: expand_string_message = US"too few arguments or bracketing "
2554 "error for saslauthd";
2556 case 3: return NULL;
2558 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2561 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2562 &expand_string_message);
2563 if (rc == ERROR || rc == DEFER) return NULL;
2564 *yield = (rc == OK) == testfor;
2568 #endif /* CYRUS_SASLAUTHD_SOCKET */
2571 /* symbolic operators for numeric and string comparison, and a number of
2572 other operators, all requiring two arguments.
2574 crypteq: encrypts plaintext and compares against an encrypted text,
2575 using crypt(), crypt16(), MD5 or SHA-1
2576 inlist/inlisti: checks if first argument is in the list of the second
2577 match: does a regular expression match and sets up the numerical
2578 variables if it succeeds
2579 match_address: matches in an address list
2580 match_domain: matches in a domain list
2581 match_ip: matches a host list that is restricted to IP addresses
2582 match_local_part: matches in a local part list
2585 case ECOND_MATCH_ADDRESS:
2586 case ECOND_MATCH_DOMAIN:
2587 case ECOND_MATCH_IP:
2588 case ECOND_MATCH_LOCAL_PART:
2589 #ifndef EXPAND_LISTMATCH_RHS
2590 sub2_honour_dollar = FALSE;
2599 case ECOND_NUM_L: /* Numerical comparisons */
2606 case ECOND_STR_LT: /* String comparisons */
2617 for (int i = 0; i < 2; i++)
2619 /* Sometimes, we don't expand substrings; too many insecure configurations
2620 created using match_address{}{} and friends, where the second param
2621 includes information from untrustworthy sources. */
2622 BOOL honour_dollar = TRUE;
2623 if ((i > 0) && !sub2_honour_dollar)
2624 honour_dollar = FALSE;
2626 while (isspace(*s)) s++;
2629 if (i == 0) goto COND_FAILED_CURLY_START;
2630 expand_string_message = string_sprintf("missing 2nd string in {} "
2631 "after \"%s\"", name);
2634 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2635 honour_dollar, resetok)))
2637 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2638 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2639 " for security reasons\n");
2640 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2642 /* Convert to numerical if required; we know that the names of all the
2643 conditions that compare numbers do not start with a letter. This just saves
2644 checking for them individually. */
2646 if (!isalpha(name[0]) && yield != NULL)
2651 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2655 num[i] = expanded_string_integer(sub[i], FALSE);
2656 if (expand_string_message != NULL) return NULL;
2660 /* Result not required */
2662 if (yield == NULL) return s;
2664 /* Do an appropriate comparison */
2670 tempcond = (num[0] == num[1]);
2674 tempcond = (num[0] > num[1]);
2678 tempcond = (num[0] >= num[1]);
2682 tempcond = (num[0] < num[1]);
2686 tempcond = (num[0] <= num[1]);
2690 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2694 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2698 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2702 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2706 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2710 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2714 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2718 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2722 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2726 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2729 case ECOND_MATCH: /* Regular expression match */
2730 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2734 expand_string_message = string_sprintf("regular expression error in "
2735 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2738 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2741 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2742 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2743 goto MATCHED_SOMETHING;
2745 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2746 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2747 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2748 goto MATCHED_SOMETHING;
2750 case ECOND_MATCH_IP: /* Match IP address in a host list */
2751 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2753 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2759 unsigned int *nullcache = NULL;
2760 check_host_block cb;
2762 cb.host_name = US"";
2763 cb.host_address = sub[0];
2765 /* If the host address starts off ::ffff: it is an IPv6 address in
2766 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2769 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2770 cb.host_address + 7 : cb.host_address;
2772 rc = match_check_list(
2773 &sub[1], /* the list */
2774 0, /* separator character */
2775 &hostlist_anchor, /* anchor pointer */
2776 &nullcache, /* cache pointer */
2777 check_host, /* function for testing */
2778 &cb, /* argument for function */
2779 MCL_HOST, /* type of check */
2780 sub[0], /* text for debugging */
2781 NULL); /* where to pass back data */
2783 goto MATCHED_SOMETHING;
2785 case ECOND_MATCH_LOCAL_PART:
2786 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2787 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2802 expand_string_message = string_sprintf("unable to complete match "
2803 "against \"%s\": %s", sub[1], search_error_message);
2809 /* Various "encrypted" comparisons. If the second string starts with
2810 "{" then an encryption type is given. Default to crypt() or crypt16()
2811 (build-time choice). */
2812 /* }-for-text-editors */
2815 #ifndef SUPPORT_CRYPTEQ
2816 goto COND_FAILED_NOT_COMPILED;
2818 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2820 int sublen = Ustrlen(sub[1]+5);
2825 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2827 /* If the length that we are comparing against is 24, the MD5 digest
2828 is expressed as a base64 string. This is the way LDAP does it. However,
2829 some other software uses a straightforward hex representation. We assume
2830 this if the length is 32. Other lengths fail. */
2834 uschar *coded = b64encode(CUS digest, 16);
2835 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2836 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2837 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2839 else if (sublen == 32)
2842 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2844 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2845 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2846 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2850 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2851 "fail\n crypted=%s\n", sub[1]+5);
2856 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2858 int sublen = Ustrlen(sub[1]+6);
2863 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2865 /* If the length that we are comparing against is 28, assume the SHA1
2866 digest is expressed as a base64 string. If the length is 40, assume a
2867 straightforward hex representation. Other lengths fail. */
2871 uschar *coded = b64encode(CUS digest, 20);
2872 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2873 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2874 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2876 else if (sublen == 40)
2879 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2881 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2882 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2883 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2887 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2888 "fail\n crypted=%s\n", sub[1]+6);
2893 else /* {crypt} or {crypt16} and non-{ at start */
2894 /* }-for-text-editors */
2899 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2904 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2909 else if (sub[1][0] == '{') /* }-for-text-editors */
2911 expand_string_message = string_sprintf("unknown encryption mechanism "
2912 "in \"%s\"", sub[1]);
2918 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2919 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2920 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2924 #define XSTR(s) STR(s)
2925 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2926 " subject=%s\n crypted=%s\n",
2927 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2932 /* If the encrypted string contains fewer than two characters (for the
2933 salt), force failure. Otherwise we get false positives: with an empty
2934 string the yield of crypt() is an empty string! */
2937 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2938 else if (errno == EINVAL)
2942 expand_string_message = string_sprintf("crypt error: %s\n",
2943 US strerror(errno));
2948 #endif /* SUPPORT_CRYPTEQ */
2953 const uschar * list = sub[1];
2955 uschar *save_iterate_item = iterate_item;
2956 int (*compare)(const uschar *, const uschar *);
2958 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", name, sub[0]);
2961 compare = cond_type == ECOND_INLISTI
2962 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2964 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2966 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
2967 if (compare(sub[0], iterate_item) == 0)
2973 iterate_item = save_iterate_item;
2976 } /* Switch for comparison conditions */
2978 *yield = tempcond == testfor;
2979 return s; /* End of comparison conditions */
2982 /* and/or: computes logical and/or of several conditions */
2986 subcondptr = (yield == NULL)? NULL : &tempcond;
2987 combined_cond = (cond_type == ECOND_AND);
2989 while (isspace(*s)) s++;
2990 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2994 while (isspace(*s)) s++;
2995 /* {-for-text-editors */
2996 if (*s == '}') break;
2997 if (*s != '{') /* }-for-text-editors */
2999 expand_string_message = string_sprintf("each subcondition "
3000 "inside an \"%s{...}\" condition must be in its own {}", name);
3004 if (!(s = eval_condition(s+1, resetok, subcondptr)))
3006 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3007 expand_string_message, name);
3010 while (isspace(*s)) s++;
3012 /* {-for-text-editors */
3015 /* {-for-text-editors */
3016 expand_string_message = string_sprintf("missing } at end of condition "
3017 "inside \"%s\" group", name);
3023 if (cond_type == ECOND_AND)
3025 combined_cond &= tempcond;
3026 if (!combined_cond) subcondptr = NULL; /* once false, don't */
3027 } /* evaluate any more */
3030 combined_cond |= tempcond;
3031 if (combined_cond) subcondptr = NULL; /* once true, don't */
3032 } /* evaluate any more */
3036 if (yield != NULL) *yield = (combined_cond == testfor);
3040 /* forall/forany: iterates a condition with different values */
3042 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3043 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3044 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3045 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;
3046 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3047 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;
3051 const uschar * list;
3053 uschar *save_iterate_item = iterate_item;
3055 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
3057 while (isspace(*s)) s++;
3058 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3059 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
3060 if (sub[0] == NULL) return NULL;
3061 /* {-for-text-editors */
3062 if (*s++ != '}') goto COND_FAILED_CURLY_END;
3064 while (isspace(*s)) s++;
3065 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3069 /* Call eval_condition once, with result discarded (as if scanning a
3070 "false" part). This allows us to find the end of the condition, because if
3071 the list it empty, we won't actually evaluate the condition for real. */
3073 if (!(s = eval_condition(sub[1], resetok, NULL)))
3075 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3076 expand_string_message, name);
3079 while (isspace(*s)) s++;
3081 /* {-for-text-editors */
3084 /* {-for-text-editors */
3085 expand_string_message = string_sprintf("missing } at end of condition "
3086 "inside \"%s\"", name);
3090 if (yield) *yield = !testfor;
3092 if (is_json) list = dewrap(string_copy(list), US"[]");
3093 while ((iterate_item = is_json
3094 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3097 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3099 expand_string_message =
3100 string_sprintf("%s wrapping string result for extract jsons",
3101 expand_string_message);
3102 iterate_item = save_iterate_item;
3106 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, iterate_item);
3107 if (!eval_condition(sub[1], resetok, &tempcond))
3109 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3110 expand_string_message, name);
3111 iterate_item = save_iterate_item;
3114 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", name,
3115 tempcond? "true":"false");
3117 if (yield) *yield = (tempcond == testfor);
3118 if (tempcond == is_forany) break;
3121 iterate_item = save_iterate_item;
3126 /* The bool{} expansion condition maps a string to boolean.
3127 The values supported should match those supported by the ACL condition
3128 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3129 of true/false. Note that Router "condition" rules have a different
3130 interpretation, where general data can be used and only a few values
3132 Note that readconf.c boolean matching, for boolean configuration options,
3133 only matches true/yes/false/no.
3134 The bool_lax{} condition matches the Router logic, which is much more
3137 case ECOND_BOOL_LAX:
3143 BOOL boolvalue = FALSE;
3144 while (isspace(*s)) s++;
3145 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3146 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3147 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3149 case 1: expand_string_message = string_sprintf(
3150 "too few arguments or bracketing error for %s",
3154 case 3: return NULL;
3157 while (isspace(*t)) t++;
3161 /* trailing whitespace: seems like a good idea to ignore it too */
3163 while (isspace(*t2)) t2--;
3164 if (t2 != (t + len))
3171 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3172 /* logic for the lax case from expand_check_condition(), which also does
3173 expands, and the logic is both short and stable enough that there should
3174 be no maintenance burden from replicating it. */
3178 ? Ustrspn(t+1, "0123456789") == len-1
3179 : Ustrspn(t, "0123456789") == len)
3181 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3182 /* expand_check_condition only does a literal string "0" check */
3183 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3186 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3188 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3190 else if (cond_type == ECOND_BOOL_LAX)
3194 expand_string_message = string_sprintf("unrecognised boolean "
3198 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3199 boolvalue? "true":"false");
3200 if (yield != NULL) *yield = (boolvalue == testfor);
3204 /* Unknown condition */
3207 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3209 } /* End switch on condition type */
3211 /* Missing braces at start and end of data */
3213 COND_FAILED_CURLY_START:
3214 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3217 COND_FAILED_CURLY_END:
3218 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3222 /* A condition requires code that is not compiled */
3224 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3225 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3226 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3227 COND_FAILED_NOT_COMPILED:
3228 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3237 /*************************************************
3238 * Save numerical variables *
3239 *************************************************/
3241 /* This function is called from items such as "if" that want to preserve and
3242 restore the numbered variables.
3245 save_expand_string points to an array of pointers to set
3246 save_expand_nlength points to an array of ints for the lengths
3248 Returns: the value of expand max to save
3252 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3254 for (int i = 0; i <= expand_nmax; i++)
3256 save_expand_nstring[i] = expand_nstring[i];
3257 save_expand_nlength[i] = expand_nlength[i];
3264 /*************************************************
3265 * Restore numerical variables *
3266 *************************************************/
3268 /* This function restored saved values of numerical strings.
3271 save_expand_nmax the number of strings to restore
3272 save_expand_string points to an array of pointers
3273 save_expand_nlength points to an array of ints
3279 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3280 int *save_expand_nlength)
3282 expand_nmax = save_expand_nmax;
3283 for (int i = 0; i <= expand_nmax; i++)
3285 expand_nstring[i] = save_expand_nstring[i];
3286 expand_nlength[i] = save_expand_nlength[i];
3294 /*************************************************
3295 * Handle yes/no substrings *
3296 *************************************************/
3298 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3299 alternative substrings that depend on whether or not the condition was true,
3300 or the lookup or extraction succeeded. The substrings always have to be
3301 expanded, to check their syntax, but "skipping" is set when the result is not
3302 needed - this avoids unnecessary nested lookups.
3305 skipping TRUE if we were skipping when this item was reached
3306 yes TRUE if the first string is to be used, else use the second
3307 save_lookup a value to put back into lookup_value before the 2nd expansion
3308 sptr points to the input string pointer
3309 yieldptr points to the output growable-string pointer
3310 type "lookup", "if", "extract", "run", "env", "listextract" or
3311 "certextract" for error message
3312 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3315 Returns: 0 OK; lookup_value has been reset to save_lookup
3317 2 expansion failed because of bracketing error
3321 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3322 gstring ** yieldptr, uschar *type, BOOL *resetok)
3325 const uschar *s = *sptr; /* Local value */
3326 uschar *sub1, *sub2;
3327 const uschar * errwhere;
3329 /* If there are no following strings, we substitute the contents of $value for
3330 lookups and for extractions in the success case. For the ${if item, the string
3331 "true" is substituted. In the fail case, nothing is substituted for all three
3334 while (isspace(*s)) s++;
3339 if (yes && !skipping)
3340 *yieldptr = string_catn(*yieldptr, US"true", 4);
3344 if (yes && lookup_value && !skipping)
3345 *yieldptr = string_cat(*yieldptr, lookup_value);
3346 lookup_value = save_lookup;
3352 /* The first following string must be braced. */
3356 errwhere = US"'yes' part did not start with '{'";
3360 /* Expand the first substring. Forced failures are noticed only if we actually
3361 want this string. Set skipping in the call in the fail case (this will always
3362 be the case if we were already skipping). */
3364 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3365 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3366 f.expand_string_forcedfail = FALSE;
3369 errwhere = US"'yes' part did not end with '}'";
3373 /* If we want the first string, add it to the output */
3376 *yieldptr = string_cat(*yieldptr, sub1);
3378 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3379 $value to what it was at the start of the item, so that it has this value
3380 during the second string expansion. For the call from "if" or "run" to this
3381 function, save_lookup is set to lookup_value, so that this statement does
3384 lookup_value = save_lookup;
3386 /* There now follows either another substring, or "fail", or nothing. This
3387 time, forced failures are noticed only if we want the second string. We must
3388 set skipping in the nested call if we don't want this string, or if we were
3389 already skipping. */
3391 while (isspace(*s)) s++;
3394 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3395 if (sub2 == NULL && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3396 f.expand_string_forcedfail = FALSE;
3399 errwhere = US"'no' part did not start with '{'";
3403 /* If we want the second string, add it to the output */
3406 *yieldptr = string_cat(*yieldptr, sub2);
3409 /* If there is no second string, but the word "fail" is present when the use of
3410 the second string is wanted, set a flag indicating it was a forced failure
3411 rather than a syntactic error. Swallow the terminating } in case this is nested
3412 inside another lookup or if or extract. */
3417 /* deconst cast ok here as source is s anyway */
3418 s = US read_name(name, sizeof(name), s, US"_");
3419 if (Ustrcmp(name, "fail") == 0)
3421 if (!yes && !skipping)
3423 while (isspace(*s)) s++;
3426 errwhere = US"did not close with '}' after forcedfail";
3429 expand_string_message =
3430 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3431 f.expand_string_forcedfail = TRUE;
3437 expand_string_message =
3438 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3443 /* All we have to do now is to check on the final closing brace. */
3445 while (isspace(*s)) s++;
3448 errwhere = US"did not close with '}'";
3454 /* Update the input pointer value before returning */
3459 /* Get here if there is a bracketing failure */
3460 expand_string_message = string_sprintf(
3461 "curly-bracket problem in conditional yes/no parsing: %s\n"
3462 " remaining string is '%s'", errwhere, --s);
3467 /* Get here for other failures */
3475 /*************************************************
3476 * Handle MD5 or SHA-1 computation for HMAC *
3477 *************************************************/
3479 /* These are some wrapping functions that enable the HMAC code to be a bit
3480 cleaner. A good compiler will spot the tail recursion.
3483 type HMAC_MD5 or HMAC_SHA1
3484 remaining are as for the cryptographic hash functions
3490 chash_start(int type, void *base)
3492 if (type == HMAC_MD5)
3493 md5_start((md5 *)base);
3495 sha1_start((hctx *)base);
3499 chash_mid(int type, void *base, uschar *string)
3501 if (type == HMAC_MD5)
3502 md5_mid((md5 *)base, string);
3504 sha1_mid((hctx *)base, string);
3508 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3510 if (type == HMAC_MD5)
3511 md5_end((md5 *)base, string, length, digest);
3513 sha1_end((hctx *)base, string, length, digest);
3520 /********************************************************
3521 * prvs: Get last three digits of days since Jan 1, 1970 *
3522 ********************************************************/
3524 /* This is needed to implement the "prvs" BATV reverse
3527 Argument: integer "days" offset to add or substract to
3528 or from the current number of days.
3530 Returns: pointer to string containing the last three
3531 digits of the number of days since Jan 1, 1970,
3532 modified by the offset argument, NULL if there
3533 was an error in the conversion.
3538 prvs_daystamp(int day_offset)
3540 uschar *days = store_get(32); /* Need at least 24 for cases */
3541 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3542 (time(NULL) + day_offset*86400)/86400);
3543 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3548 /********************************************************
3549 * prvs: perform HMAC-SHA1 computation of prvs bits *
3550 ********************************************************/
3552 /* This is needed to implement the "prvs" BATV reverse
3556 address RFC2821 Address to use
3557 key The key to use (must be less than 64 characters
3559 key_num Single-digit key number to use. Defaults to
3562 Returns: pointer to string containing the first three
3563 bytes of the final hash in hex format, NULL if
3564 there was an error in the process.
3568 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3570 gstring * hash_source;
3573 uschar innerhash[20];
3574 uschar finalhash[20];
3575 uschar innerkey[64];
3576 uschar outerkey[64];
3577 uschar *finalhash_hex = store_get(40);
3579 if (key_num == NULL)
3582 if (Ustrlen(key) > 64)
3585 hash_source = string_catn(NULL, key_num, 1);
3586 hash_source = string_catn(hash_source, daystamp, 3);
3587 hash_source = string_cat(hash_source, address);
3588 (void) string_from_gstring(hash_source);
3591 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3593 memset(innerkey, 0x36, 64);
3594 memset(outerkey, 0x5c, 64);
3596 for (int i = 0; i < Ustrlen(key); i++)
3598 innerkey[i] ^= key[i];
3599 outerkey[i] ^= key[i];
3602 chash_start(HMAC_SHA1, &h);
3603 chash_mid(HMAC_SHA1, &h, innerkey);
3604 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3606 chash_start(HMAC_SHA1, &h);
3607 chash_mid(HMAC_SHA1, &h, outerkey);
3608 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3611 for (int i = 0; i < 3; i++)
3613 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3614 *p++ = hex_digits[finalhash[i] & 0x0f];
3618 return finalhash_hex;
3624 /*************************************************
3625 * Join a file onto the output string *
3626 *************************************************/
3628 /* This is used for readfile/readsock and after a run expansion.
3629 It joins the contents of a file onto the output string, globally replacing
3630 newlines with a given string (optionally).
3634 yield pointer to the expandable string struct
3635 eol newline replacement string, or NULL
3637 Returns: new pointer for expandable string, terminated if non-null
3641 cat_file(FILE *f, gstring *yield, uschar *eol)
3643 uschar buffer[1024];
3645 while (Ufgets(buffer, sizeof(buffer), f))
3647 int len = Ustrlen(buffer);
3648 if (eol && buffer[len-1] == '\n') len--;
3649 yield = string_catn(yield, buffer, len);
3650 if (eol && buffer[len])
3651 yield = string_cat(yield, eol);
3654 (void) string_from_gstring(yield);
3661 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
3664 uschar buffer[1024];
3666 /*XXX could we read direct into a pre-grown string? */
3668 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
3669 for (uschar * s = buffer; rc--; s++)
3670 yield = eol && *s == '\n'
3671 ? string_cat(yield, eol) : string_catn(yield, s, 1);
3673 /* We assume that all errors, and any returns of zero bytes,
3674 are actually EOF. */
3676 (void) string_from_gstring(yield);
3682 /*************************************************
3683 * Evaluate numeric expression *
3684 *************************************************/
3686 /* This is a set of mutually recursive functions that evaluate an arithmetic
3687 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3688 these functions that is called from elsewhere is eval_expr, whose interface is:
3691 sptr pointer to the pointer to the string - gets updated
3692 decimal TRUE if numbers are to be assumed decimal
3693 error pointer to where to put an error message - must be NULL on input
3694 endket TRUE if ')' must terminate - FALSE for external call
3696 Returns: on success: the value of the expression, with *error still NULL
3697 on failure: an undefined value, with *error = a message
3700 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3703 static int_eximarith_t
3704 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3707 int_eximarith_t x = eval_op_or(&s, decimal, error);
3713 *error = US"expecting closing parenthesis";
3715 while (isspace(*(++s)));
3717 else if (*s != 0) *error = US"expecting operator";
3724 static int_eximarith_t
3725 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3730 while (isspace(*s)) s++;
3735 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3737 switch (tolower(*s))
3740 case 'k': n *= 1024; s++; break;
3741 case 'm': n *= 1024*1024; s++; break;
3742 case 'g': n *= 1024*1024*1024; s++; break;
3744 while (isspace (*s)) s++;
3749 n = eval_expr(&s, decimal, error, 1);
3753 *error = US"expecting number or opening parenthesis";
3761 static int_eximarith_t
3762 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3766 while (isspace(*s)) s++;
3767 if (*s == '+' || *s == '-' || *s == '~')
3770 x = eval_op_unary(&s, decimal, error);
3771 if (op == '-') x = -x;
3772 else if (op == '~') x = ~x;
3776 x = eval_number(&s, decimal, error);
3783 static int_eximarith_t
3784 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3787 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3790 while (*s == '*' || *s == '/' || *s == '%')
3793 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3794 if (*error != NULL) break;
3795 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3796 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3797 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3798 * -N*M is INT_MIN will yield INT_MIN.
3799 * Since we don't support floating point, this is somewhat simpler.
3800 * Ideally, we'd return an error, but since we overflow for all other
3801 * arithmetic, consistency suggests otherwise, but what's the correct value
3802 * to use? There is none.
3803 * The C standard guarantees overflow for unsigned arithmetic but signed
3804 * overflow invokes undefined behaviour; in practice, this is overflow
3805 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3806 * that long/longlong larger than int are available, or we could just work
3807 * with larger types. We should consider whether to guarantee 32bit eval
3808 * and 64-bit working variables, with errors returned. For now ...
3809 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3810 * can just let the other invalid results occur otherwise, as they have
3811 * until now. For this one case, we can coerce.
3813 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3816 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3817 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3827 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3843 static int_eximarith_t
3844 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3847 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3850 while (*s == '+' || *s == '-')
3853 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3855 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3856 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3857 { /* over-conservative check */
3859 ? US"overflow in sum" : US"overflow in difference";
3862 if (op == '+') x += y; else x -= y;
3870 static int_eximarith_t
3871 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3874 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3877 while ((*s == '<' || *s == '>') && s[1] == s[0])
3882 y = eval_op_sum(&s, decimal, error);
3883 if (*error != NULL) break;
3884 if (op == '<') x <<= y; else x >>= y;
3892 static int_eximarith_t
3893 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3896 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3903 y = eval_op_shift(&s, decimal, error);
3904 if (*error != NULL) break;
3913 static int_eximarith_t
3914 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3917 int_eximarith_t x = eval_op_and(&s, decimal, error);
3924 y = eval_op_and(&s, decimal, error);
3925 if (*error != NULL) break;
3934 static int_eximarith_t
3935 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3938 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3945 y = eval_op_xor(&s, decimal, error);
3946 if (*error != NULL) break;
3956 /*************************************************
3958 *************************************************/
3960 /* Returns either an unchanged string, or the expanded string in stacking pool
3961 store. Interpreted sequences are:
3963 \... normal escaping rules
3964 $name substitutes the variable
3966 ${op:string} operates on the expanded string value
3967 ${item{arg1}{arg2}...} expands the args and then does the business
3968 some literal args are not enclosed in {}
3970 There are now far too many operators and item types to make it worth listing
3971 them here in detail any more.
3973 We use an internal routine recursively to handle embedded substrings. The
3974 external function follows. The yield is NULL if the expansion failed, and there
3975 are two cases: if something collapsed syntactically, or if "fail" was given
3976 as the action on a lookup failure. These can be distinguished by looking at the
3977 variable expand_string_forcedfail, which is TRUE in the latter case.
3979 The skipping flag is set true when expanding a substring that isn't actually
3980 going to be used (after "if" or "lookup") and it prevents lookups from
3981 happening lower down.
3983 Store usage: At start, a store block of the length of the input plus 64
3984 is obtained. This is expanded as necessary by string_cat(), which might have to
3985 get a new block, or might be able to expand the original. At the end of the
3986 function we can release any store above that portion of the yield block that
3987 was actually used. In many cases this will be optimal.
3989 However: if the first item in the expansion is a variable name or header name,
3990 we reset the store before processing it; if the result is in fresh store, we
3991 use that without copying. This is helpful for expanding strings like
3992 $message_headers which can get very long.
3994 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3995 since resetting the store at the end of the expansion will free store that was
3996 allocated by the plugin code as well as the slop after the expanded string. So
3997 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3998 and, given the acl condition, ${if }. This is an unfortunate consequence of
3999 string expansion becoming too powerful.
4002 string the string to be expanded
4003 ket_ends true if expansion is to stop at }
4004 left if not NULL, a pointer to the first character after the
4005 expansion is placed here (typically used with ket_ends)
4006 skipping TRUE for recursive calls when the value isn't actually going
4007 to be used (to allow for optimisation)
4008 honour_dollar TRUE if $ is to be expanded,
4009 FALSE if it's just another character
4010 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
4013 Returns: NULL if expansion fails:
4014 expand_string_forcedfail is set TRUE if failure was forced
4015 expand_string_message contains a textual error message
4016 a pointer to the expanded string on success
4020 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
4021 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
4023 gstring * yield = string_get(Ustrlen(string) + 64);
4025 const uschar *s = string;
4026 uschar *save_expand_nstring[EXPAND_MAXN+1];
4027 int save_expand_nlength[EXPAND_MAXN+1];
4028 BOOL resetok = TRUE;
4033 debug_printf_indent("/%s: %s\n",
4034 skipping ? "---scanning" : "considering", string);
4036 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
4038 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4042 f.expand_string_forcedfail = FALSE;
4043 expand_string_message = US"";
4050 /* \ escapes the next character, which must exist, or else
4051 the expansion fails. There's a special escape, \N, which causes
4052 copying of the subject verbatim up to the next \N. Otherwise,
4053 the escapes are the standard set. */
4059 expand_string_message = US"\\ at end of string";
4065 const uschar * t = s + 2;
4066 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
4067 yield = string_catn(yield, t, s - t);
4068 if (*s != 0) s += 2;
4074 ch[0] = string_interpret_escape(&s);
4076 yield = string_catn(yield, ch, 1);
4083 /* Anything other than $ is just copied verbatim, unless we are
4084 looking for a terminating } character. */
4087 if (ket_ends && *s == '}') break;
4089 if (*s != '$' || !honour_dollar)
4091 yield = string_catn(yield, s++, 1);
4095 /* No { after the $ - must be a plain name or a number for string
4096 match variable. There has to be a fudge for variables that are the
4097 names of header fields preceded by "$header_" because header field
4098 names can contain any printing characters except space and colon.
4099 For those that don't like typing this much, "$h_" is a synonym for
4100 "$header_". A non-existent header yields a NULL value; nothing is
4103 if (isalpha((*(++s))))
4110 s = read_name(name, sizeof(name), s, US"_");
4112 /* If this is the first thing to be expanded, release the pre-allocated
4116 g = store_get(sizeof(gstring));
4117 else if (yield->ptr == 0)
4119 if (resetok) store_reset(yield);
4121 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
4126 if ( ( *(t = name) == 'h'
4127 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4129 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4132 unsigned flags = *name == 'r' ? FH_WANT_RAW
4133 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4135 uschar * charset = *name == 'b' ? NULL : headers_charset;
4137 s = read_header_name(name, sizeof(name), s);
4138 value = find_header(name, &newsize, flags, charset);
4140 /* If we didn't find the header, and the header contains a closing brace
4141 character, this may be a user error where the terminating colon
4142 has been omitted. Set a flag to adjust the error message in this case.
4143 But there is no error here - nothing gets inserted. */
4147 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
4154 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4156 expand_string_message =
4157 string_sprintf("unknown variable name \"%s\"", name);
4158 check_variable_error_message(name);
4162 /* If the data is known to be in a new buffer, newsize will be set to the
4163 size of that buffer. If this is the first thing in an expansion string,
4164 yield will be NULL; just point it at the new store instead of copying. Many
4165 expansion strings contain just one reference, so this is a useful
4166 optimization, especially for humungous headers. We need to use a gstring
4167 structure that is not allocated after that new-buffer, else a later store
4168 reset in the middle of the buffer will make it inaccessible. */
4170 len = Ustrlen(value);
4171 if (!yield && newsize != 0)
4174 yield->size = newsize;
4179 yield = string_catn(yield, value, len);
4187 s = read_cnumber(&n, s);
4188 if (n >= 0 && n <= expand_nmax)
4189 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4193 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4195 if (*s != '{') /*}*/
4197 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4201 /* After { there can be various things, but they all start with
4202 an initial word, except for a number for a string match variable. */
4204 if (isdigit((*(++s))))
4207 s = read_cnumber(&n, s); /*{*/
4210 expand_string_message = US"} expected after number";
4213 if (n >= 0 && n <= expand_nmax)
4214 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4220 expand_string_message = US"letter or digit expected after ${"; /*}*/
4224 /* Allow "-" in names to cater for substrings with negative
4225 arguments. Since we are checking for known names after { this is
4228 s = read_name(name, sizeof(name), s, US"_-");
4229 item_type = chop_match(name, item_table, nelem(item_table));
4233 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4234 If the ACL returns accept or reject we return content set by "message ="
4235 There is currently no limit on recursion; this would have us call
4236 acl_check_internal() directly and get a current level from somewhere.
4237 See also the acl expansion condition ECOND_ACL and the traditional
4238 acl modifier ACLC_ACL.
4239 Assume that the function has side-effects on the store that must be preserved.
4243 /* ${acl {name} {arg1}{arg2}...} */
4245 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4248 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4251 case 1: goto EXPAND_FAILED_CURLY;
4253 case 3: goto EXPAND_FAILED;
4255 if (skipping) continue;
4258 switch(eval_acl(sub, nelem(sub), &user_msg))
4263 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4265 yield = string_cat(yield, user_msg);
4269 f.expand_string_forcedfail = TRUE;
4272 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4277 case EITEM_AUTHRESULTS:
4278 /* ${authresults {mysystemname}} */
4282 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4285 case 1: goto EXPAND_FAILED_CURLY;
4287 case 3: goto EXPAND_FAILED;
4290 yield = string_append(yield, 3,
4291 US"Authentication-Results: ", sub_arg[0], US"; none");
4294 yield = authres_local(yield, sub_arg[0]);
4295 yield = authres_iprev(yield);
4296 yield = authres_smtpauth(yield);
4298 yield = authres_spf(yield);
4300 #ifndef DISABLE_DKIM
4301 yield = authres_dkim(yield);
4303 #ifdef EXPERIMENTAL_DMARC
4304 yield = authres_dmarc(yield);
4306 #ifdef EXPERIMENTAL_ARC
4307 yield = authres_arc(yield);
4312 /* Handle conditionals - preserve the values of the numerical expansion
4313 variables in case they get changed by a regular expression match in the
4314 condition. If not, they retain their external settings. At the end
4315 of this "if" section, they get restored to their previous values. */
4320 const uschar *next_s;
4321 int save_expand_nmax =
4322 save_expand_strings(save_expand_nstring, save_expand_nlength);
4324 while (isspace(*s)) s++;
4325 next_s = eval_condition(s, &resetok, skipping ? NULL : &cond);
4326 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4331 debug_printf_indent("|--condition: %.*s\n", (int)(next_s - s), s);
4332 debug_printf_indent("|-----result: %s\n", cond ? "true" : "false");
4336 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4337 "condition: %.*s\n",
4338 (int)(next_s - s), s);
4339 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4340 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4342 cond ? "true" : "false");
4347 /* The handling of "yes" and "no" result strings is now in a separate
4348 function that is also used by ${lookup} and ${extract} and ${run}. */
4350 switch(process_yesno(
4351 skipping, /* were previously skipping */
4352 cond, /* success/failure indicator */
4353 lookup_value, /* value to reset for string2 */
4354 &s, /* input pointer */
4355 &yield, /* output pointer */
4356 US"if", /* condition type */
4359 case 1: goto EXPAND_FAILED; /* when all is well, the */
4360 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4363 /* Restore external setting of expansion variables for continuation
4366 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4367 save_expand_nlength);
4372 case EITEM_IMAPFOLDER:
4373 { /* ${imapfolder {name}{sep]{specials}} */
4377 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4380 case 1: goto EXPAND_FAILED_CURLY;
4382 case 3: goto EXPAND_FAILED;
4385 if (sub_arg[1] == NULL) /* One argument */
4387 sub_arg[1] = US"/"; /* default separator */
4390 else if (Ustrlen(sub_arg[1]) != 1)
4392 expand_string_message =
4394 "IMAP folder separator must be one character, found \"%s\"",
4401 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4402 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4404 yield = string_cat(yield, encoded);
4410 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4411 expanding an internal string that isn't actually going to be used. All we
4412 need to do is check the syntax, so don't do a lookup at all. Preserve the
4413 values of the numerical expansion variables in case they get changed by a
4414 partial lookup. If not, they retain their external settings. At the end
4415 of this "lookup" section, they get restored to their previous values. */
4419 int stype, partial, affixlen, starflags;
4420 int expand_setup = 0;
4422 uschar *key, *filename;
4423 const uschar *affix;
4424 uschar *save_lookup_value = lookup_value;
4425 int save_expand_nmax =
4426 save_expand_strings(save_expand_nstring, save_expand_nlength);
4428 if ((expand_forbid & RDO_LOOKUP) != 0)
4430 expand_string_message = US"lookup expansions are not permitted";
4434 /* Get the key we are to look up for single-key+file style lookups.
4435 Otherwise set the key NULL pro-tem. */
4437 while (isspace(*s)) s++;
4438 if (*s == '{') /*}*/
4440 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4441 if (!key) goto EXPAND_FAILED; /*{{*/
4444 expand_string_message = US"missing '}' after lookup key";
4445 goto EXPAND_FAILED_CURLY;
4447 while (isspace(*s)) s++;
4451 /* Find out the type of database */
4455 expand_string_message = US"missing lookup type";
4459 /* The type is a string that may contain special characters of various
4460 kinds. Allow everything except space or { to appear; the actual content
4461 is checked by search_findtype_partial. */ /*}*/
4463 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4465 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4469 while (isspace(*s)) s++;
4471 /* Now check for the individual search type and any partial or default
4472 options. Only those types that are actually in the binary are valid. */
4474 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4478 expand_string_message = search_error_message;
4482 /* Check that a key was provided for those lookup types that need it,
4483 and was not supplied for those that use the query style. */
4485 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4489 expand_string_message = string_sprintf("missing {key} for single-"
4490 "key \"%s\" lookup", name);
4498 expand_string_message = string_sprintf("a single key was given for "
4499 "lookup type \"%s\", which is not a single-key lookup type", name);
4504 /* Get the next string in brackets and expand it. It is the file name for
4505 single-key+file lookups, and the whole query otherwise. In the case of
4506 queries that also require a file name (e.g. sqlite), the file name comes
4511 expand_string_message = US"missing '{' for lookup file-or-query arg";
4512 goto EXPAND_FAILED_CURLY;
4514 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4515 if (filename == NULL) goto EXPAND_FAILED;
4518 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4519 goto EXPAND_FAILED_CURLY;
4521 while (isspace(*s)) s++;
4523 /* If this isn't a single-key+file lookup, re-arrange the variables
4524 to be appropriate for the search_ functions. For query-style lookups,
4525 there is just a "key", and no file name. For the special query-style +
4526 file types, the query (i.e. "key") starts with a file name. */
4530 while (isspace(*filename)) filename++;
4533 if (mac_islookup(stype, lookup_querystyle))
4537 if (*filename != '/')
4539 expand_string_message = string_sprintf(
4540 "absolute file name expected for \"%s\" lookup", name);
4543 while (*key != 0 && !isspace(*key)) key++;
4544 if (*key != 0) *key++ = 0;
4548 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4549 the entry was not found. Note that there is no search_close() function.
4550 Files are left open in case of re-use. At suitable places in higher logic,
4551 search_tidyup() is called to tidy all open files. This can save opening
4552 the same file several times. However, files may also get closed when
4553 others are opened, if too many are open at once. The rule is that a
4554 handle should not be used after a second search_open().
4556 Request that a partial search sets up $1 and maybe $2 by passing
4557 expand_setup containing zero. If its value changes, reset expand_nmax,
4558 since new variables will have been set. Note that at the end of this
4559 "lookup" section, the old numeric variables are restored. */
4562 lookup_value = NULL;
4565 void *handle = search_open(filename, stype, 0, NULL, NULL);
4568 expand_string_message = search_error_message;
4571 lookup_value = search_find(handle, filename, key, partial, affix,
4572 affixlen, starflags, &expand_setup);
4573 if (f.search_find_defer)
4575 expand_string_message =
4576 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4577 string_printing2(key, FALSE), search_error_message);
4580 if (expand_setup > 0) expand_nmax = expand_setup;
4583 /* The handling of "yes" and "no" result strings is now in a separate
4584 function that is also used by ${if} and ${extract}. */
4586 switch(process_yesno(
4587 skipping, /* were previously skipping */
4588 lookup_value != NULL, /* success/failure indicator */
4589 save_lookup_value, /* value to reset for string2 */
4590 &s, /* input pointer */
4591 &yield, /* output pointer */
4592 US"lookup", /* condition type */
4595 case 1: goto EXPAND_FAILED; /* when all is well, the */
4596 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4599 /* Restore external setting of expansion variables for carrying on
4600 at this level, and continue. */
4602 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4603 save_expand_nlength);
4607 /* If Perl support is configured, handle calling embedded perl subroutines,
4608 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4609 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4610 arguments (defined below). */
4612 #define EXIM_PERL_MAX_ARGS 8
4616 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4617 "is not included in this binary";
4620 #else /* EXIM_PERL */
4622 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4625 if ((expand_forbid & RDO_PERL) != 0)
4627 expand_string_message = US"Perl calls are not permitted";
4631 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4632 US"perl", &resetok))
4634 case 1: goto EXPAND_FAILED_CURLY;
4636 case 3: goto EXPAND_FAILED;
4639 /* If skipping, we don't actually do anything */
4641 if (skipping) continue;
4643 /* Start the interpreter if necessary */
4645 if (!opt_perl_started)
4648 if (opt_perl_startup == NULL)
4650 expand_string_message = US"A setting of perl_startup is needed when "
4651 "using the Perl interpreter";
4654 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4655 initerror = init_perl(opt_perl_startup);
4656 if (initerror != NULL)
4658 expand_string_message =
4659 string_sprintf("error in perl_startup code: %s\n", initerror);
4662 opt_perl_started = TRUE;
4665 /* Call the function */
4667 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4668 new_yield = call_perl_cat(yield, &expand_string_message,
4669 sub_arg[0], sub_arg + 1);
4671 /* NULL yield indicates failure; if the message pointer has been set to
4672 NULL, the yield was undef, indicating a forced failure. Otherwise the
4673 message will indicate some kind of Perl error. */
4675 if (new_yield == NULL)
4677 if (expand_string_message == NULL)
4679 expand_string_message =
4680 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4681 "failure", sub_arg[0]);
4682 f.expand_string_forcedfail = TRUE;
4687 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4688 set during a callback from Perl. */
4690 f.expand_string_forcedfail = FALSE;
4694 #endif /* EXIM_PERL */
4696 /* Transform email address to "prvs" scheme to use
4697 as BATV-signed return path */
4704 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4706 case 1: goto EXPAND_FAILED_CURLY;
4708 case 3: goto EXPAND_FAILED;
4711 /* If skipping, we don't actually do anything */
4712 if (skipping) continue;
4714 /* sub_arg[0] is the address */
4715 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
4716 || domain == sub_arg[0] || Ustrlen(domain) == 1)
4718 expand_string_message = US"prvs first argument must be a qualified email address";
4722 /* Calculate the hash. The third argument must be a single-digit
4723 key number, or unset. */
4726 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4728 expand_string_message = US"prvs third argument must be a single digit";
4732 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
4735 expand_string_message = US"prvs hmac-sha1 conversion failed";
4739 /* Now separate the domain from the local part */
4742 yield = string_catn(yield, US"prvs=", 5);
4743 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
4744 yield = string_catn(yield, prvs_daystamp(7), 3);
4745 yield = string_catn(yield, p, 6);
4746 yield = string_catn(yield, US"=", 1);
4747 yield = string_cat (yield, sub_arg[0]);
4748 yield = string_catn(yield, US"@", 1);
4749 yield = string_cat (yield, domain);
4754 /* Check a prvs-encoded address for validity */
4756 case EITEM_PRVSCHECK:
4763 /* TF: Ugliness: We want to expand parameter 1 first, then set
4764 up expansion variables that are used in the expansion of
4765 parameter 2. So we clone the string for the first
4766 expansion, where we only expand parameter 1.
4768 PH: Actually, that isn't necessary. The read_subs() function is
4769 designed to work this way for the ${if and ${lookup expansions. I've
4773 /* Reset expansion variables */
4774 prvscheck_result = NULL;
4775 prvscheck_address = NULL;
4776 prvscheck_keynum = NULL;
4778 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4780 case 1: goto EXPAND_FAILED_CURLY;
4782 case 3: goto EXPAND_FAILED;
4785 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4788 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4790 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4791 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4792 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4793 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4794 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4796 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
4797 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
4798 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
4799 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
4800 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
4802 /* Set up expansion variables */
4803 g = string_cat (NULL, local_part);
4804 g = string_catn(g, US"@", 1);
4805 g = string_cat (g, domain);
4806 prvscheck_address = string_from_gstring(g);
4807 prvscheck_keynum = string_copy(key_num);
4809 /* Now expand the second argument */
4810 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4812 case 1: goto EXPAND_FAILED_CURLY;
4814 case 3: goto EXPAND_FAILED;
4817 /* Now we have the key and can check the address. */
4819 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4824 expand_string_message = US"hmac-sha1 conversion failed";
4828 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
4829 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
4831 if (Ustrcmp(p,hash) == 0)
4833 /* Success, valid BATV address. Now check the expiry date. */
4834 uschar *now = prvs_daystamp(0);
4835 unsigned int inow = 0,iexpire = 1;
4837 (void)sscanf(CS now,"%u",&inow);
4838 (void)sscanf(CS daystamp,"%u",&iexpire);
4840 /* When "iexpire" is < 7, a "flip" has occured.
4841 Adjust "inow" accordingly. */
4842 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4844 if (iexpire >= inow)
4846 prvscheck_result = US"1";
4847 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
4851 prvscheck_result = NULL;
4852 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
4857 prvscheck_result = NULL;
4858 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
4861 /* Now expand the final argument. We leave this till now so that
4862 it can include $prvscheck_result. */
4864 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4866 case 1: goto EXPAND_FAILED_CURLY;
4868 case 3: goto EXPAND_FAILED;
4871 yield = string_cat(yield,
4872 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4874 /* Reset the "internal" variables afterwards, because they are in
4875 dynamic store that will be reclaimed if the expansion succeeded. */
4877 prvscheck_address = NULL;
4878 prvscheck_keynum = NULL;
4881 /* Does not look like a prvs encoded address, return the empty string.
4882 We need to make sure all subs are expanded first, so as to skip over
4885 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4887 case 1: goto EXPAND_FAILED_CURLY;
4889 case 3: goto EXPAND_FAILED;
4895 /* Handle "readfile" to insert an entire file */
4897 case EITEM_READFILE:
4902 if ((expand_forbid & RDO_READFILE) != 0)
4904 expand_string_message = US"file insertions are not permitted";
4908 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4910 case 1: goto EXPAND_FAILED_CURLY;
4912 case 3: goto EXPAND_FAILED;
4915 /* If skipping, we don't actually do anything */
4917 if (skipping) continue;
4919 /* Open the file and read it */
4921 if (!(f = Ufopen(sub_arg[0], "rb")))
4923 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4927 yield = cat_file(f, yield, sub_arg[1]);
4932 /* Handle "readsocket" to insert data from a socket, either
4933 Inet or Unix domain */
4935 case EITEM_READSOCK:
4939 int save_ptr = yield->ptr;
4942 uschar * sub_arg[4];
4943 uschar * server_name = NULL;
4945 BOOL do_shutdown = TRUE;
4946 BOOL do_tls = FALSE; /* Only set under SUPPORT_TLS */
4947 void * tls_ctx = NULL; /* ditto */
4950 if (expand_forbid & RDO_READSOCK)
4952 expand_string_message = US"socket insertions are not permitted";
4956 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4957 because there may be a string for expansion on failure. */
4959 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4961 case 1: goto EXPAND_FAILED_CURLY;
4962 case 2: /* Won't occur: no end check */
4963 case 3: goto EXPAND_FAILED;
4966 /* Grab the request string, if any */
4968 reqstr.data = sub_arg[1];
4969 reqstr.len = Ustrlen(sub_arg[1]);
4971 /* Sort out timeout, if given. The second arg is a list with the first element
4972 being a time value. Any more are options of form "name=value". Currently the
4973 only option recognised is "shutdown". */
4977 const uschar * list = sub_arg[2];
4981 item = string_nextinlist(&list, &sep, NULL, 0);
4982 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
4984 expand_string_message = string_sprintf("bad time value %s", item);
4988 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
4989 if (Ustrncmp(item, US"shutdown=", 9) == 0)
4990 { if (Ustrcmp(item + 9, US"no") == 0) do_shutdown = FALSE; }
4992 else if (Ustrncmp(item, US"tls=", 4) == 0)
4993 { if (Ustrcmp(item + 9, US"no") != 0) do_tls = TRUE; }
4997 sub_arg[3] = NULL; /* No eol if no timeout */
4999 /* If skipping, we don't actually do anything. Otherwise, arrange to
5000 connect to either an IP or a Unix socket. */
5004 /* Handle an IP (internet) domain */
5006 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
5011 server_name = sub_arg[0] + 5;
5012 port_name = Ustrrchr(server_name, ':');
5014 /* Sort out the port */
5018 expand_string_message =
5019 string_sprintf("missing port for readsocket %s", sub_arg[0]);
5022 *port_name++ = 0; /* Terminate server name */
5024 if (isdigit(*port_name))
5027 port = Ustrtol(port_name, &end, 0);
5028 if (end != port_name + Ustrlen(port_name))
5030 expand_string_message =
5031 string_sprintf("invalid port number %s", port_name);
5037 struct servent *service_info = getservbyname(CS port_name, "tcp");
5040 expand_string_message = string_sprintf("unknown port \"%s\"",
5044 port = ntohs(service_info->s_port);
5047 /*XXX we trust that the request is idempotent. Hmm. */
5048 fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
5049 timeout, &host, &expand_string_message,
5050 do_tls ? NULL : &reqstr);
5051 callout_address = NULL;
5058 /* Handle a Unix domain socket */
5062 struct sockaddr_un sockun; /* don't call this "sun" ! */
5065 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
5067 expand_string_message = string_sprintf("failed to create socket: %s",
5072 sockun.sun_family = AF_UNIX;
5073 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
5075 server_name = US sockun.sun_path;
5077 sigalrm_seen = FALSE;
5079 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
5083 expand_string_message = US "socket connect timed out";
5088 expand_string_message = string_sprintf("failed to connect to socket "
5089 "%s: %s", sub_arg[0], strerror(errno));
5092 host.name = server_name;
5093 host.address = US"";
5096 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
5101 tls_support tls_dummy = {.sni=NULL};
5104 if (!(tls_ctx = tls_client_start(fd, &host, NULL, NULL,
5105 # ifdef SUPPORT_DANE
5108 &tls_dummy, &errstr)))
5110 expand_string_message = string_sprintf("TLS connect failed: %s", errstr);
5116 /* Allow sequencing of test actions */
5117 if (f.running_in_test_harness) millisleep(100);
5119 /* Write the request string, if not empty or already done */
5123 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
5127 tls_ctx ? tls_write(tls_ctx, reqstr.data, reqstr.len, FALSE) :
5129 write(fd, reqstr.data, reqstr.len)) != reqstr.len)
5131 expand_string_message = string_sprintf("request write to socket "
5132 "failed: %s", strerror(errno));
5137 /* Shut down the sending side of the socket. This helps some servers to
5138 recognise that it is their turn to do some work. Just in case some
5139 system doesn't have this function, make it conditional. */
5142 if (!tls_ctx && do_shutdown) shutdown(fd, SHUT_WR);
5145 if (f.running_in_test_harness) millisleep(100);
5147 /* Now we need to read from the socket, under a timeout. The function
5148 that reads a file can be used. */
5151 fp = fdopen(fd, "rb");
5152 sigalrm_seen = FALSE;
5156 tls_ctx ? cat_file_tls(tls_ctx, yield, sub_arg[3]) :
5158 cat_file(fp, yield, sub_arg[3]);
5164 tls_close(tls_ctx, TRUE);
5171 /* After a timeout, we restore the pointer in the result, that is,
5172 make sure we add nothing from the socket. */
5176 yield->ptr = save_ptr;
5177 expand_string_message = US "socket read timed out";
5182 /* The whole thing has worked (or we were skipping). If there is a
5183 failure string following, we need to skip it. */
5187 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
5191 expand_string_message = US"missing '}' closing failstring for readsocket";
5192 goto EXPAND_FAILED_CURLY;
5194 while (isspace(*s)) s++;
5200 expand_string_message = US"missing '}' closing readsocket";
5201 goto EXPAND_FAILED_CURLY;
5205 /* Come here on failure to create socket, connect socket, write to the
5206 socket, or timeout on reading. If another substring follows, expand and
5207 use it. Otherwise, those conditions give expand errors. */
5210 if (*s != '{') goto EXPAND_FAILED;
5211 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5212 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5214 yield = string_cat(yield, arg);
5217 expand_string_message = US"missing '}' closing failstring for readsocket";
5218 goto EXPAND_FAILED_CURLY;
5220 while (isspace(*s)) s++;
5224 /* Handle "run" to execute a program. */
5230 const uschar **argv;
5234 if ((expand_forbid & RDO_RUN) != 0)
5236 expand_string_message = US"running a command is not permitted";
5240 while (isspace(*s)) s++;
5243 expand_string_message = US"missing '{' for command arg of run";
5244 goto EXPAND_FAILED_CURLY;
5246 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5247 if (arg == NULL) goto EXPAND_FAILED;
5248 while (isspace(*s)) s++;
5251 expand_string_message = US"missing '}' closing command arg of run";
5252 goto EXPAND_FAILED_CURLY;
5255 if (skipping) /* Just pretend it worked when we're skipping */
5258 lookup_value = NULL;
5262 if (!transport_set_up_command(&argv, /* anchor for arg list */
5263 arg, /* raw command */
5264 FALSE, /* don't expand the arguments */
5265 0, /* not relevant when... */
5266 NULL, /* no transporting address */
5267 US"${run} expansion", /* for error messages */
5268 &expand_string_message)) /* where to put error message */
5271 /* Create the child process, making it a group leader. */
5273 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
5275 expand_string_message =
5276 string_sprintf("couldn't create child process: %s", strerror(errno));
5280 /* Nothing is written to the standard input. */
5284 /* Read the pipe to get the command's output into $value (which is kept
5285 in lookup_value). Read during execution, so that if the output exceeds
5286 the OS pipe buffer limit, we don't block forever. Remember to not release
5287 memory just allocated for $value. */
5290 f = fdopen(fd_out, "rb");
5291 sigalrm_seen = FALSE;
5293 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5297 /* Wait for the process to finish, applying the timeout, and inspect its
5298 return code for serious disasters. Simple non-zero returns are passed on.
5301 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5303 if (sigalrm_seen || runrc == -256)
5305 expand_string_message = string_sprintf("command timed out");
5306 killpg(pid, SIGKILL); /* Kill the whole process group */
5309 else if (runrc == -257)
5310 expand_string_message = string_sprintf("wait() failed: %s",
5314 expand_string_message = string_sprintf("command killed by signal %d",
5321 /* Process the yes/no strings; $value may be useful in both cases */
5323 switch(process_yesno(
5324 skipping, /* were previously skipping */
5325 runrc == 0, /* success/failure indicator */
5326 lookup_value, /* value to reset for string2 */
5327 &s, /* input pointer */
5328 &yield, /* output pointer */
5329 US"run", /* condition type */
5332 case 1: goto EXPAND_FAILED; /* when all is well, the */
5333 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5339 /* Handle character translation for "tr" */
5343 int oldptr = yield->ptr;
5347 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5349 case 1: goto EXPAND_FAILED_CURLY;
5351 case 3: goto EXPAND_FAILED;
5354 yield = string_cat(yield, sub[0]);
5355 o2m = Ustrlen(sub[2]) - 1;
5357 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5359 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5363 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5370 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5371 expanded arguments. */
5380 int val[2] = { 0, -1 };
5383 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5384 Ensure that sub[2] is set in the ${length } case. */
5387 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5388 TRUE, name, &resetok))
5390 case 1: goto EXPAND_FAILED_CURLY;
5392 case 3: goto EXPAND_FAILED;
5395 /* Juggle the arguments if there are only two of them: always move the
5396 string to the last position and make ${length{n}{str}} equivalent to
5397 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5403 if (item_type == EITEM_LENGTH)
5410 for (int i = 0; i < 2; i++) if (sub[i])
5412 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5413 if (*ret != 0 || (i != 0 && val[i] < 0))
5415 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5416 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5422 (item_type == EITEM_HASH)?
5423 compute_hash(sub[2], val[0], val[1], &len) :
5424 (item_type == EITEM_NHASH)?
5425 compute_nhash(sub[2], val[0], val[1], &len) :
5426 extract_substr(sub[2], val[0], val[1], &len);
5428 if (ret == NULL) goto EXPAND_FAILED;
5429 yield = string_catn(yield, ret, len);
5433 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5434 This code originally contributed by Steve Haslam. It currently supports
5435 the use of MD5 and SHA-1 hashes.
5437 We need some workspace that is large enough to handle all the supported
5438 hash types. Use macros to set the sizes rather than be too elaborate. */
5440 #define MAX_HASHLEN 20
5441 #define MAX_HASHBLOCKLEN 64
5450 int hashlen; /* Number of octets for the hash algorithm's output */
5451 int hashblocklen; /* Number of octets the hash algorithm processes */
5453 unsigned int keylen;
5455 uschar keyhash[MAX_HASHLEN];
5456 uschar innerhash[MAX_HASHLEN];
5457 uschar finalhash[MAX_HASHLEN];
5458 uschar finalhash_hex[2*MAX_HASHLEN];
5459 uschar innerkey[MAX_HASHBLOCKLEN];
5460 uschar outerkey[MAX_HASHBLOCKLEN];
5462 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5464 case 1: goto EXPAND_FAILED_CURLY;
5466 case 3: goto EXPAND_FAILED;
5471 if (Ustrcmp(sub[0], "md5") == 0)
5474 use_base = &md5_base;
5478 else if (Ustrcmp(sub[0], "sha1") == 0)
5481 use_base = &sha1_ctx;
5487 expand_string_message =
5488 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5493 keylen = Ustrlen(keyptr);
5495 /* If the key is longer than the hash block length, then hash the key
5498 if (keylen > hashblocklen)
5500 chash_start(type, use_base);
5501 chash_end(type, use_base, keyptr, keylen, keyhash);
5506 /* Now make the inner and outer key values */
5508 memset(innerkey, 0x36, hashblocklen);
5509 memset(outerkey, 0x5c, hashblocklen);
5511 for (int i = 0; i < keylen; i++)
5513 innerkey[i] ^= keyptr[i];
5514 outerkey[i] ^= keyptr[i];
5517 /* Now do the hashes */
5519 chash_start(type, use_base);
5520 chash_mid(type, use_base, innerkey);
5521 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5523 chash_start(type, use_base);
5524 chash_mid(type, use_base, outerkey);
5525 chash_end(type, use_base, innerhash, hashlen, finalhash);
5527 /* Encode the final hash as a hex string */
5530 for (int i = 0; i < hashlen; i++)
5532 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5533 *p++ = hex_digits[finalhash[i] & 0x0f];
5536 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5537 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5539 yield = string_catn(yield, finalhash_hex, hashlen*2);
5544 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5545 We have to save the numerical variables and restore them afterwards. */
5550 int moffset, moffsetextra, slen;
5553 const uschar *rerror;
5556 int save_expand_nmax =
5557 save_expand_strings(save_expand_nstring, save_expand_nlength);
5559 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5561 case 1: goto EXPAND_FAILED_CURLY;
5563 case 3: goto EXPAND_FAILED;
5566 /* Compile the regular expression */
5568 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5573 expand_string_message = string_sprintf("regular expression error in "
5574 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5578 /* Now run a loop to do the substitutions as often as necessary. It ends
5579 when there are no more matches. Take care over matches of the null string;
5580 do the same thing as Perl does. */
5583 slen = Ustrlen(sub[0]);
5584 moffset = moffsetextra = 0;
5589 int ovector[3*(EXPAND_MAXN+1)];
5590 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5591 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5594 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5595 is not necessarily the end. We want to repeat the match from one
5596 character further along, but leaving the basic offset the same (for
5597 copying below). We can't be at the end of the string - that was checked
5598 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5599 finished; copy the remaining string and end the loop. */
5609 yield = string_catn(yield, subject+moffset, slen-moffset);
5613 /* Match - set up for expanding the replacement. */
5615 if (n == 0) n = EXPAND_MAXN + 1;
5617 for (int nn = 0; nn < n*2; nn += 2)
5619 expand_nstring[expand_nmax] = subject + ovector[nn];
5620 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5624 /* Copy the characters before the match, plus the expanded insertion. */
5626 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
5627 insert = expand_string(sub[2]);
5628 if (insert == NULL) goto EXPAND_FAILED;
5629 yield = string_cat(yield, insert);
5631 moffset = ovector[1];
5635 /* If we have matched an empty string, first check to see if we are at
5636 the end of the subject. If so, the loop is over. Otherwise, mimic
5637 what Perl's /g options does. This turns out to be rather cunning. First
5638 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5639 string at the same point. If this fails (picked up above) we advance to
5640 the next character. */
5642 if (ovector[0] == ovector[1])
5644 if (ovector[0] == slen) break;
5645 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5649 /* All done - restore numerical variables. */
5651 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5652 save_expand_nlength);
5656 /* Handle keyed and numbered substring extraction. If the first argument
5657 consists entirely of digits, then a numerical extraction is assumed. */
5661 int field_number = 1;
5662 BOOL field_number_set = FALSE;
5663 uschar *save_lookup_value = lookup_value;
5665 int save_expand_nmax =
5666 save_expand_strings(save_expand_nstring, save_expand_nlength);
5667 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
5669 while (isspace(*s)) s++;
5671 /* Check for a format-variant specifier */
5673 if (*s != '{') /*}*/
5674 if (Ustrncmp(s, "json", 4) == 0)
5675 if (*(s += 4) == 's')
5676 {fmt = extract_jsons; s++;}
5680 /* While skipping we cannot rely on the data for expansions being
5681 available (eg. $item) hence cannot decide on numeric vs. keyed.
5682 Read a maximum of 5 arguments (including the yes/no) */
5686 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
5688 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5689 goto EXPAND_FAILED; /*'{'*/
5692 expand_string_message = US"missing '{' for arg of extract";
5693 goto EXPAND_FAILED_CURLY;
5695 while (isspace(*s)) s++;
5697 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
5698 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5702 while (isspace(*s)) s++;
5706 expand_string_message = US"missing '}' closing extract";
5707 goto EXPAND_FAILED_CURLY;
5711 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5713 while (isspace(*s)) s++;
5714 if (*s == '{') /*'}'*/
5716 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5717 if (sub[i] == NULL) goto EXPAND_FAILED; /*'{'*/
5720 expand_string_message = string_sprintf(
5721 "missing '}' closing arg %d of extract", i+1);
5722 goto EXPAND_FAILED_CURLY;
5725 /* After removal of leading and trailing white space, the first
5726 argument must not be empty; if it consists entirely of digits
5727 (optionally preceded by a minus sign), this is a numerical
5728 extraction, and we expect 3 arguments (normal) or 2 (json). */
5736 while (isspace(*p)) p++;
5740 while (len > 0 && isspace(p[len-1])) len--;
5745 expand_string_message = US"first argument of \"extract\" must "
5755 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5759 if (fmt == extract_basic) j = 3; /* Need 3 args */
5760 field_number_set = TRUE;
5766 expand_string_message = string_sprintf(
5767 "missing '{' for arg %d of extract", i+1);
5768 goto EXPAND_FAILED_CURLY;
5772 /* Extract either the numbered or the keyed substring into $value. If
5773 skipping, just pretend the extraction failed. */
5776 lookup_value = NULL;
5780 lookup_value = field_number_set
5781 ? expand_gettokened(field_number, sub[1], sub[2])
5782 : expand_getkeyed(sub[0], sub[1]);
5789 const uschar * list;
5791 /* Array: Bracket-enclosed and comma-separated.
5792 Object: Brace-enclosed, comma-sep list of name:value pairs */
5794 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
5796 expand_string_message =
5797 string_sprintf("%s wrapping %s for extract json",
5798 expand_string_message,
5799 field_number_set ? "array" : "object");
5800 goto EXPAND_FAILED_CURLY;
5804 if (field_number_set)
5806 if (field_number <= 0)
5808 expand_string_message = US"first argument of \"extract\" must "
5809 "be greater than zero";
5812 while (field_number > 0 && (item = json_nextinlist(&list)))
5817 while (--s >= lookup_value && isspace(*s)) *s = '\0';
5821 lookup_value = NULL;
5822 while ((item = json_nextinlist(&list)))
5824 /* Item is: string name-sep value. string is quoted.
5825 Dequote the string and compare with the search key. */
5827 if (!(item = dewrap(item, US"\"\"")))
5829 expand_string_message =
5830 string_sprintf("%s wrapping string key for extract json",
5831 expand_string_message);
5832 goto EXPAND_FAILED_CURLY;
5834 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
5836 s = item + Ustrlen(item) + 1;
5837 while (isspace(*s)) s++;
5840 expand_string_message = string_sprintf(
5841 "missing object value-separator for extract json");
5842 goto EXPAND_FAILED_CURLY;
5845 while (isspace(*s)) s++;
5853 if (fmt == extract_jsons)
5854 if (!(lookup_value = dewrap(lookup_value, US"\"\"")))
5856 expand_string_message =
5857 string_sprintf("%s wrapping string result for extract jsons",
5858 expand_string_message);
5859 goto EXPAND_FAILED_CURLY;
5863 /* If no string follows, $value gets substituted; otherwise there can
5864 be yes/no strings, as for lookup or if. */
5866 switch(process_yesno(
5867 skipping, /* were previously skipping */
5868 lookup_value != NULL, /* success/failure indicator */
5869 save_lookup_value, /* value to reset for string2 */
5870 &s, /* input pointer */
5871 &yield, /* output pointer */
5872 US"extract", /* condition type */
5875 case 1: goto EXPAND_FAILED; /* when all is well, the */
5876 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5879 /* All done - restore numerical variables. */
5881 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5882 save_expand_nlength);
5887 /* return the Nth item from a list */
5889 case EITEM_LISTEXTRACT:
5891 int field_number = 1;
5892 uschar *save_lookup_value = lookup_value;
5894 int save_expand_nmax =
5895 save_expand_strings(save_expand_nstring, save_expand_nlength);
5897 /* Read the field & list arguments */
5899 for (int i = 0; i < 2; i++)
5901 while (isspace(*s)) s++;
5902 if (*s != '{') /*'}'*/
5904 expand_string_message = string_sprintf(
5905 "missing '{' for arg %d of listextract", i+1);
5906 goto EXPAND_FAILED_CURLY;
5909 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5910 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5913 expand_string_message = string_sprintf(
5914 "missing '}' closing arg %d of listextract", i+1);
5915 goto EXPAND_FAILED_CURLY;
5918 /* After removal of leading and trailing white space, the first
5919 argument must be numeric and nonempty. */
5927 while (isspace(*p)) p++;
5931 while (len > 0 && isspace(p[len-1])) len--;
5934 if (!*p && !skipping)
5936 expand_string_message = US"first argument of \"listextract\" must "
5946 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5949 expand_string_message = US"first argument of \"listextract\" must "
5957 /* Extract the numbered element into $value. If
5958 skipping, just pretend the extraction failed. */
5960 lookup_value = skipping ? NULL : expand_getlistele(field_number, sub[1]);
5962 /* If no string follows, $value gets substituted; otherwise there can
5963 be yes/no strings, as for lookup or if. */
5965 switch(process_yesno(
5966 skipping, /* were previously skipping */
5967 lookup_value != NULL, /* success/failure indicator */
5968 save_lookup_value, /* value to reset for string2 */
5969 &s, /* input pointer */
5970 &yield, /* output pointer */
5971 US"listextract", /* condition type */
5974 case 1: goto EXPAND_FAILED; /* when all is well, the */
5975 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5978 /* All done - restore numerical variables. */
5980 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5981 save_expand_nlength);
5987 case EITEM_CERTEXTRACT:
5989 uschar *save_lookup_value = lookup_value;
5991 int save_expand_nmax =
5992 save_expand_strings(save_expand_nstring, save_expand_nlength);
5994 /* Read the field argument */
5995 while (isspace(*s)) s++;
5996 if (*s != '{') /*}*/
5998 expand_string_message = US"missing '{' for field arg of certextract";
5999 goto EXPAND_FAILED_CURLY;
6001 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6002 if (!sub[0]) goto EXPAND_FAILED; /*{*/
6005 expand_string_message = US"missing '}' closing field arg of certextract";
6006 goto EXPAND_FAILED_CURLY;
6008 /* strip spaces fore & aft */
6013 while (isspace(*p)) p++;
6017 while (len > 0 && isspace(p[len-1])) len--;
6021 /* inspect the cert argument */
6022 while (isspace(*s)) s++;
6023 if (*s != '{') /*}*/
6025 expand_string_message = US"missing '{' for cert variable arg of certextract";
6026 goto EXPAND_FAILED_CURLY;
6030 expand_string_message = US"second argument of \"certextract\" must "
6031 "be a certificate variable";
6034 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
6035 if (!sub[1]) goto EXPAND_FAILED; /*{*/
6038 expand_string_message = US"missing '}' closing cert variable arg of certextract";
6039 goto EXPAND_FAILED_CURLY;
6043 lookup_value = NULL;
6046 lookup_value = expand_getcertele(sub[0], sub[1]);
6047 if (*expand_string_message) goto EXPAND_FAILED;
6049 switch(process_yesno(
6050 skipping, /* were previously skipping */
6051 lookup_value != NULL, /* success/failure indicator */
6052 save_lookup_value, /* value to reset for string2 */
6053 &s, /* input pointer */
6054 &yield, /* output pointer */
6055 US"certextract", /* condition type */
6058 case 1: goto EXPAND_FAILED; /* when all is well, the */
6059 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6062 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6063 save_expand_nlength);
6066 #endif /*SUPPORT_TLS*/
6068 /* Handle list operations */
6075 int save_ptr = yield->ptr;
6076 uschar outsep[2] = { '\0', '\0' };
6077 const uschar *list, *expr, *temp;
6078 uschar *save_iterate_item = iterate_item;
6079 uschar *save_lookup_value = lookup_value;
6081 while (isspace(*s)) s++;
6084 expand_string_message =
6085 string_sprintf("missing '{' for first arg of %s", name);
6086 goto EXPAND_FAILED_CURLY;
6089 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6090 if (list == NULL) goto EXPAND_FAILED;
6093 expand_string_message =
6094 string_sprintf("missing '}' closing first arg of %s", name);
6095 goto EXPAND_FAILED_CURLY;
6098 if (item_type == EITEM_REDUCE)
6101 while (isspace(*s)) s++;
6104 expand_string_message = US"missing '{' for second arg of reduce";
6105 goto EXPAND_FAILED_CURLY;
6107 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6108 if (!t) goto EXPAND_FAILED;
6112 expand_string_message = US"missing '}' closing second arg of reduce";
6113 goto EXPAND_FAILED_CURLY;
6117 while (isspace(*s)) s++;
6120 expand_string_message =
6121 string_sprintf("missing '{' for last arg of %s", name);
6122 goto EXPAND_FAILED_CURLY;
6127 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6128 if scanning a "false" part). This allows us to find the end of the
6129 condition, because if the list is empty, we won't actually evaluate the
6130 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6131 the normal internal expansion function. */
6133 if (item_type == EITEM_FILTER)
6135 temp = eval_condition(expr, &resetok, NULL);
6136 if (temp != NULL) s = temp;
6139 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6143 expand_string_message = string_sprintf("%s inside \"%s\" item",
6144 expand_string_message, name);
6148 while (isspace(*s)) s++;
6151 expand_string_message = string_sprintf("missing } at end of condition "
6152 "or expression inside \"%s\"; could be an unquoted } in the content",
6157 while (isspace(*s)) s++; /*{*/
6160 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6165 /* If we are skipping, we can now just move on to the next item. When
6166 processing for real, we perform the iteration. */
6168 if (skipping) continue;
6169 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6171 *outsep = (uschar)sep; /* Separator as a string */
6173 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6174 name, iterate_item, lookup_value);
6176 if (item_type == EITEM_FILTER)
6179 if (eval_condition(expr, &resetok, &condresult) == NULL)
6181 iterate_item = save_iterate_item;
6182 lookup_value = save_lookup_value;
6183 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6184 expand_string_message, name);
6187 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6188 condresult? "true":"false");
6190 temp = iterate_item; /* TRUE => include this item */
6192 continue; /* FALSE => skip this item */
6195 /* EITEM_MAP and EITEM_REDUCE */
6199 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
6203 iterate_item = save_iterate_item;
6204 expand_string_message = string_sprintf("%s inside \"%s\" item",
6205 expand_string_message, name);
6208 if (item_type == EITEM_REDUCE)
6210 lookup_value = t; /* Update the value of $value */
6211 continue; /* and continue the iteration */
6215 /* We reach here for FILTER if the condition is true, always for MAP,
6216 and never for REDUCE. The value in "temp" is to be added to the output
6217 list that is being created, ensuring that any occurrences of the
6218 separator character are doubled. Unless we are dealing with the first
6219 item of the output list, add in a space if the new item begins with the
6220 separator character, or is an empty string. */
6222 if (yield->ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
6223 yield = string_catn(yield, US" ", 1);
6225 /* Add the string in "temp" to the output list that we are building,
6226 This is done in chunks by searching for the separator character. */
6230 size_t seglen = Ustrcspn(temp, outsep);
6232 yield = string_catn(yield, temp, seglen + 1);
6234 /* If we got to the end of the string we output one character
6235 too many; backup and end the loop. Otherwise arrange to double the
6238 if (temp[seglen] == '\0') { yield->ptr--; break; }
6239 yield = string_catn(yield, outsep, 1);
6243 /* Output a separator after the string: we will remove the redundant
6244 final one at the end. */
6246 yield = string_catn(yield, outsep, 1);
6247 } /* End of iteration over the list loop */
6249 /* REDUCE has generated no output above: output the final value of
6252 if (item_type == EITEM_REDUCE)
6254 yield = string_cat(yield, lookup_value);
6255 lookup_value = save_lookup_value; /* Restore $value */
6258 /* FILTER and MAP generate lists: if they have generated anything, remove
6259 the redundant final separator. Even though an empty item at the end of a
6260 list does not count, this is tidier. */
6262 else if (yield->ptr != save_ptr) yield->ptr--;
6264 /* Restore preserved $item */
6266 iterate_item = save_iterate_item;
6273 const uschar *srclist, *cmp, *xtract;
6275 const uschar *dstlist = NULL, *dstkeylist = NULL;
6277 uschar *save_iterate_item = iterate_item;
6279 while (isspace(*s)) s++;
6282 expand_string_message = US"missing '{' for list arg of sort";
6283 goto EXPAND_FAILED_CURLY;
6286 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6287 if (!srclist) goto EXPAND_FAILED;
6290 expand_string_message = US"missing '}' closing list arg of sort";
6291 goto EXPAND_FAILED_CURLY;
6294 while (isspace(*s)) s++;
6297 expand_string_message = US"missing '{' for comparator arg of sort";
6298 goto EXPAND_FAILED_CURLY;
6301 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6302 if (!cmp) goto EXPAND_FAILED;
6305 expand_string_message = US"missing '}' closing comparator arg of sort";
6306 goto EXPAND_FAILED_CURLY;
6309 while (isspace(*s)) s++;
6312 expand_string_message = US"missing '{' for extractor arg of sort";
6313 goto EXPAND_FAILED_CURLY;
6317 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6318 if (!tmp) goto EXPAND_FAILED;
6319 xtract = string_copyn(xtract, s - xtract);
6323 expand_string_message = US"missing '}' closing extractor arg of sort";
6324 goto EXPAND_FAILED_CURLY;
6329 expand_string_message = US"missing } at end of \"sort\"";
6333 if (skipping) continue;
6335 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6338 gstring * newlist = NULL;
6339 gstring * newkeylist = NULL;
6342 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6344 /* extract field for comparisons */
6345 iterate_item = srcitem;
6346 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6350 expand_string_message = string_sprintf(
6351 "field-extract in sort: \"%s\"", xtract);
6355 /* Insertion sort */
6357 /* copy output list until new-item < list-item */
6358 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6364 /* field for comparison */
6365 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6368 /* build and run condition string */
6369 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
6371 DEBUG(D_expand) debug_printf_indent("%s: cond = \"%s\"\n", name, expr);
6372 if (!eval_condition(expr, &resetok, &before))
6374 expand_string_message = string_sprintf("comparison in sort: %s",
6381 /* New-item sorts before this dst-item. Append new-item,
6382 then dst-item, then remainder of dst list. */
6384 newlist = string_append_listele(newlist, sep, srcitem);
6385 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6388 newlist = string_append_listele(newlist, sep, dstitem);
6389 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6391 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6393 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6395 newlist = string_append_listele(newlist, sep, dstitem);
6396 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6402 newlist = string_append_listele(newlist, sep, dstitem);
6403 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6406 /* If we ran out of dstlist without consuming srcitem, append it */
6409 newlist = string_append_listele(newlist, sep, srcitem);
6410 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6413 dstlist = newlist->s;
6414 dstkeylist = newkeylist->s;
6416 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6417 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6421 yield = string_cat(yield, dstlist);
6423 /* Restore preserved $item */
6424 iterate_item = save_iterate_item;
6428 expand_string_message = US"Internal error in sort (list mismatch)";
6433 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6434 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6435 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6436 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6438 #define EXPAND_DLFUNC_MAX_ARGS 8
6441 #ifndef EXPAND_DLFUNC
6442 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6443 "is not included in this binary";
6446 #else /* EXPAND_DLFUNC */
6449 exim_dlfunc_t *func;
6452 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6454 if ((expand_forbid & RDO_DLFUNC) != 0)
6456 expand_string_message =
6457 US"dynamically-loaded functions are not permitted";
6461 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6462 TRUE, US"dlfunc", &resetok))
6464 case 1: goto EXPAND_FAILED_CURLY;
6466 case 3: goto EXPAND_FAILED;
6469 /* If skipping, we don't actually do anything */
6471 if (skipping) continue;
6473 /* Look up the dynamically loaded object handle in the tree. If it isn't
6474 found, dlopen() the file and put the handle in the tree for next time. */
6476 if (!(t = tree_search(dlobj_anchor, argv[0])))
6478 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6481 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6482 argv[0], dlerror());
6483 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6486 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6487 Ustrcpy(t->name, argv[0]);
6488 t->data.ptr = handle;
6489 (void)tree_insertnode(&dlobj_anchor, t);
6492 /* Having obtained the dynamically loaded object handle, look up the
6493 function pointer. */
6495 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6498 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6499 "%s", argv[1], argv[0], dlerror());
6500 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6504 /* Call the function and work out what to do with the result. If it
6505 returns OK, we have a replacement string; if it returns DEFER then
6506 expansion has failed in a non-forced manner; if it returns FAIL then
6507 failure was forced; if it returns ERROR or any other value there's a
6508 problem, so panic slightly. In any case, assume that the function has
6509 side-effects on the store that must be preserved. */
6513 for (argc = 0; argv[argc] != NULL; argc++);
6514 status = func(&result, argc - 2, &argv[2]);
6517 if (result == NULL) result = US"";
6518 yield = string_cat(yield, result);
6523 expand_string_message = result == NULL ? US"(no message)" : result;
6524 if(status == FAIL_FORCED) f.expand_string_forcedfail = TRUE;
6525 else if(status != FAIL)
6526 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6527 argv[0], argv[1], status, expand_string_message);
6531 #endif /* EXPAND_DLFUNC */
6533 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6536 uschar *save_lookup_value = lookup_value;
6538 while (isspace(*s)) s++;
6539 if (*s != '{') /*}*/
6542 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6543 if (!key) goto EXPAND_FAILED; /*{*/
6546 expand_string_message = US"missing '{' for name arg of env";
6547 goto EXPAND_FAILED_CURLY;
6550 lookup_value = US getenv(CS key);
6552 switch(process_yesno(
6553 skipping, /* were previously skipping */
6554 lookup_value != NULL, /* success/failure indicator */
6555 save_lookup_value, /* value to reset for string2 */
6556 &s, /* input pointer */
6557 &yield, /* output pointer */
6558 US"env", /* condition type */
6561 case 1: goto EXPAND_FAILED; /* when all is well, the */
6562 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6566 } /* EITEM_* switch */
6568 /* Control reaches here if the name is not recognized as one of the more
6569 complicated expansion items. Check for the "operator" syntax (name terminated
6570 by a colon). Some of the operators have arguments, separated by _ from the
6579 var_entry *vp = NULL;
6582 /* Owing to an historical mis-design, an underscore may be part of the
6583 operator name, or it may introduce arguments. We therefore first scan the
6584 table of names that contain underscores. If there is no match, we cut off
6585 the arguments and then scan the main table. */
6587 if ((c = chop_match(name, op_table_underscore,
6588 nelem(op_table_underscore))) < 0)
6590 arg = Ustrchr(name, '_');
6591 if (arg != NULL) *arg = 0;
6592 c = chop_match(name, op_table_main, nelem(op_table_main));
6593 if (c >= 0) c += nelem(op_table_underscore);
6594 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6597 /* Deal specially with operators that might take a certificate variable
6598 as we do not want to do the usual expansion. For most, expand the string.*/
6608 const uschar * s1 = s;
6609 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6611 if (!sub) goto EXPAND_FAILED; /*{*/
6614 expand_string_message =
6615 string_sprintf("missing '}' closing cert arg of %s", name);
6616 goto EXPAND_FAILED_CURLY;
6618 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6628 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6629 if (!sub) goto EXPAND_FAILED;
6634 /* If we are skipping, we don't need to perform the operation at all.
6635 This matters for operations like "mask", because the data may not be
6636 in the correct format when skipping. For example, the expression may test
6637 for the existence of $sender_host_address before trying to mask it. For
6638 other operations, doing them may not fail, but it is a waste of time. */
6640 if (skipping && c >= 0) continue;
6642 /* Otherwise, switch on the operator type */
6649 unsigned long int n = Ustrtoul(sub, &t, 10);
6654 expand_string_message = string_sprintf("argument for base32 "
6655 "operator is \"%s\", which is not a decimal number", sub);
6659 g = string_catn(g, &base32_chars[n & 0x1f], 1);
6661 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
6668 unsigned long int n = 0;
6672 uschar * t = Ustrchr(base32_chars, *tt++);
6675 expand_string_message = string_sprintf("argument for base32d "
6676 "operator is \"%s\", which is not a base 32 number", sub);
6679 n = n * 32 + (t - base32_chars);
6681 s = string_sprintf("%ld", n);
6682 yield = string_cat(yield, s);
6689 unsigned long int n = Ustrtoul(sub, &t, 10);
6692 expand_string_message = string_sprintf("argument for base62 "
6693 "operator is \"%s\", which is not a decimal number", sub);
6696 t = string_base62(n);
6697 yield = string_cat(yield, t);
6701 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6706 unsigned long int n = 0;
6709 uschar *t = Ustrchr(base62_chars, *tt++);
6712 expand_string_message = string_sprintf("argument for base62d "
6713 "operator is \"%s\", which is not a base %d number", sub,
6717 n = n * BASE_62 + (t - base62_chars);
6719 yield = string_fmt_append(yield, "%ld", n);
6725 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6726 if (expanded == NULL)
6728 expand_string_message =
6729 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6730 expand_string_message);
6733 yield = string_cat(yield, expanded);
6740 uschar *t = sub - 1;
6741 while (*(++t) != 0) { *t = tolower(*t); count++; }
6742 yield = string_catn(yield, sub, count);
6749 uschar *t = sub - 1;
6750 while (*(++t) != 0) { *t = toupper(*t); count++; }
6751 yield = string_catn(yield, sub, count);
6757 if (vp && *(void **)vp->value)
6759 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6760 yield = string_cat(yield, cp);
6768 md5_end(&base, sub, Ustrlen(sub), digest);
6769 for (int j = 0; j < 16; j++)
6770 yield = string_fmt_append(yield, "%02x", digest[j]);
6776 if (vp && *(void **)vp->value)
6778 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6779 yield = string_cat(yield, cp);
6787 sha1_end(&h, sub, Ustrlen(sub), digest);
6788 for (int j = 0; j < 20; j++)
6789 yield = string_fmt_append(yield, "%02X", digest[j]);
6794 #ifdef EXIM_HAVE_SHA2
6795 if (vp && *(void **)vp->value)
6797 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6798 yield = string_cat(yield, cp);
6805 if (!exim_sha_init(&h, HASH_SHA2_256))
6807 expand_string_message = US"unrecognised sha256 variant";
6810 exim_sha_update(&h, sub, Ustrlen(sub));
6811 exim_sha_finish(&h, &b);
6813 yield = string_fmt_append(yield, "%02X", *b.data++);
6816 expand_string_message = US"sha256 only supported with TLS";
6821 #ifdef EXIM_HAVE_SHA3
6825 hashmethod m = !arg ? HASH_SHA3_256
6826 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6827 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6828 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6829 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6832 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6834 expand_string_message = US"unrecognised sha3 variant";
6838 exim_sha_update(&h, sub, Ustrlen(sub));
6839 exim_sha_finish(&h, &b);
6841 yield = string_fmt_append(yield, "%02X", *b.data++);
6845 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
6849 /* Convert hex encoding to base64 encoding */
6859 for (enc = sub; *enc; enc++)
6861 if (!isxdigit(*enc))
6863 expand_string_message = string_sprintf("\"%s\" is not a hex "
6872 expand_string_message = string_sprintf("\"%s\" contains an odd "
6873 "number of characters", sub);
6877 while ((c = *in++) != 0)
6879 if (isdigit(c)) c -= '0';
6880 else c = toupper(c) - 'A' + 10;
6890 enc = b64encode(CUS sub, out - sub);
6891 yield = string_cat(yield, enc);
6895 /* Convert octets outside 0x21..0x7E to \xXX form */
6899 uschar *t = sub - 1;
6902 if (*t < 0x21 || 0x7E < *t)
6903 yield = string_fmt_append(yield, "\\x%02x", *t);
6905 yield = string_catn(yield, t, 1);
6910 /* count the number of list elements */
6918 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6919 yield = string_fmt_append(yield, "%d", cnt);
6923 /* expand a named list given the name */
6924 /* handles nested named lists; requotes as colon-sep list */
6928 tree_node *t = NULL;
6929 const uschar * list;
6932 uschar * suffix = US"";
6933 BOOL needsep = FALSE;
6936 if (*sub == '+') sub++;
6937 if (arg == NULL) /* no-argument version */
6939 if (!(t = tree_search(addresslist_anchor, sub)) &&
6940 !(t = tree_search(domainlist_anchor, sub)) &&
6941 !(t = tree_search(hostlist_anchor, sub)))
6942 t = tree_search(localpartlist_anchor, sub);
6944 else switch(*arg) /* specific list-type version */
6946 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6947 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6948 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6949 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6951 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6957 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6959 : *arg=='a'?"address "
6960 : *arg=='d'?"domain "
6962 : *arg=='l'?"localpart "
6967 list = ((namedlist_block *)(t->data.ptr))->string;
6969 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
6971 uschar * buf = US" : ";
6973 yield = string_catn(yield, buf, 3);
6977 if (*item == '+') /* list item is itself a named list */
6979 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6980 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6982 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6986 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6987 while ((cp= strpbrk(CCS item, tok)))
6989 yield = string_catn(yield, item, cp - CS item);
6990 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6992 yield = string_catn(yield, US"::", 2);
6995 else /* sep in item; should already be doubled; emit once */
6997 yield = string_catn(yield, US tok, 1);
6998 if (*cp == sep) cp++;
7003 yield = string_cat(yield, item);
7008 /* mask applies a mask to an IP address; for example the result of
7009 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7016 int mask, maskoffset;
7017 int type = string_is_ip_address(sub, &maskoffset);
7022 expand_string_message = string_sprintf("\"%s\" is not an IP address",
7027 if (maskoffset == 0)
7029 expand_string_message = string_sprintf("missing mask value in \"%s\"",
7034 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7036 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
7038 expand_string_message = string_sprintf("mask value too big in \"%s\"",
7043 /* Convert the address to binary integer(s) and apply the mask */
7045 sub[maskoffset] = 0;
7046 count = host_aton(sub, binary);
7047 host_mask(count, binary, mask);
7049 /* Convert to masked textual format and add to output. */
7051 yield = string_catn(yield, buffer,
7052 host_nmtoa(count, binary, mask, buffer, '.'));
7057 case EOP_IPV6DENORM:
7059 int type = string_is_ip_address(sub, NULL);
7066 (void) host_aton(sub, binary);
7069 case 4: /* convert to IPv4-mapped IPv6 */
7070 binary[0] = binary[1] = 0;
7071 binary[2] = 0x0000ffff;
7072 (void) host_aton(sub, binary+3);
7076 expand_string_message =
7077 string_sprintf("\"%s\" is not an IP address", sub);
7081 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7082 ? ipv6_nmtoa(binary, buffer)
7083 : host_nmtoa(4, binary, -1, buffer, ':')
7089 case EOP_LOCAL_PART:
7093 int start, end, domain;
7094 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7097 if (c != EOP_DOMAIN)
7099 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
7100 yield = string_catn(yield, sub+start, end-start);
7102 else if (domain != 0)
7105 yield = string_catn(yield, sub+domain, end-domain);
7112 uschar outsep[2] = { ':', '\0' };
7113 uschar *address, *error;
7114 int save_ptr = yield->ptr;
7115 int start, end, domain; /* Not really used */
7117 while (isspace(*sub)) sub++;
7119 if (*outsep = *++sub) ++sub;
7122 expand_string_message = string_sprintf("output separator "
7123 "missing in expanding ${addresses:%s}", --sub);
7126 f.parse_allow_group = TRUE;
7130 uschar *p = parse_find_address_end(sub, FALSE);
7131 uschar saveend = *p;
7133 address = parse_extract_address(sub, &error, &start, &end, &domain,
7137 /* Add the address to the output list that we are building. This is
7138 done in chunks by searching for the separator character. At the
7139 start, unless we are dealing with the first address of the output
7140 list, add in a space if the new address begins with the separator
7141 character, or is an empty string. */
7143 if (address != NULL)
7145 if (yield->ptr != save_ptr && address[0] == *outsep)
7146 yield = string_catn(yield, US" ", 1);
7150 size_t seglen = Ustrcspn(address, outsep);
7151 yield = string_catn(yield, address, seglen + 1);
7153 /* If we got to the end of the string we output one character
7156 if (address[seglen] == '\0') { yield->ptr--; break; }
7157 yield = string_catn(yield, outsep, 1);
7158 address += seglen + 1;
7161 /* Output a separator after the string: we will remove the
7162 redundant final one at the end. */
7164 yield = string_catn(yield, outsep, 1);
7167 if (saveend == '\0') break;
7171 /* If we have generated anything, remove the redundant final
7174 if (yield->ptr != save_ptr) yield->ptr--;
7175 f.parse_allow_group = FALSE;
7180 /* quote puts a string in quotes if it is empty or contains anything
7181 other than alphamerics, underscore, dot, or hyphen.
7183 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7184 be quoted in order to be a valid local part.
7186 In both cases, newlines and carriage returns are converted into \n and \r
7190 case EOP_QUOTE_LOCAL_PART:
7193 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
7194 uschar *t = sub - 1;
7198 while (!needs_quote && *(++t) != 0)
7199 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7201 else /* EOP_QUOTE_LOCAL_PART */
7203 while (!needs_quote && *(++t) != 0)
7204 needs_quote = !isalnum(*t) &&
7205 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
7206 (*t != '.' || t == sub || t[1] == 0);
7211 yield = string_catn(yield, US"\"", 1);
7216 yield = string_catn(yield, US"\\n", 2);
7217 else if (*t == '\r')
7218 yield = string_catn(yield, US"\\r", 2);
7221 if (*t == '\\' || *t == '"')
7222 yield = string_catn(yield, US"\\", 1);
7223 yield = string_catn(yield, t, 1);
7226 yield = string_catn(yield, US"\"", 1);
7228 else yield = string_cat(yield, sub);
7232 /* quote_lookuptype does lookup-specific quoting */
7237 uschar *opt = Ustrchr(arg, '_');
7239 if (opt != NULL) *opt++ = 0;
7241 n = search_findtype(arg, Ustrlen(arg));
7244 expand_string_message = search_error_message;
7248 if (lookup_list[n]->quote != NULL)
7249 sub = (lookup_list[n]->quote)(sub, opt);
7250 else if (opt != NULL) sub = NULL;
7254 expand_string_message = string_sprintf(
7255 "\"%s\" unrecognized after \"${quote_%s\"",
7260 yield = string_cat(yield, sub);
7264 /* rx quote sticks in \ before any non-alphameric character so that
7265 the insertion works in a regular expression. */
7269 uschar *t = sub - 1;
7273 yield = string_catn(yield, US"\\", 1);
7274 yield = string_catn(yield, t, 1);
7279 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7280 prescribed by the RFC, if there are characters that need to be encoded */
7284 uschar buffer[2048];
7285 yield = string_cat(yield,
7286 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7287 buffer, sizeof(buffer), FALSE));
7291 /* RFC 2047 decode */
7297 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7298 headers_charset, '?', &len, &error);
7301 expand_string_message = error;
7304 yield = string_catn(yield, decoded, len);
7308 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7318 if (c > 255) c = '_';
7320 yield = string_catn(yield, buff, 1);
7325 /* replace illegal UTF-8 sequences by replacement character */
7327 #define UTF8_REPLACEMENT_CHAR US"?"
7331 int seq_len = 0, index = 0;
7333 long codepoint = -1;
7335 uschar seq_buff[4]; /* accumulate utf-8 here */
7344 if ((c & 0xc0) != 0x80)
7345 /* wrong continuation byte; invalidate all bytes */
7346 complete = 1; /* error */
7349 codepoint = (codepoint << 6) | (c & 0x3f);
7350 seq_buff[index++] = c;
7351 if (--bytes_left == 0) /* codepoint complete */
7352 if(codepoint > 0x10FFFF) /* is it too large? */
7353 complete = -1; /* error (RFC3629 limit) */
7355 { /* finished; output utf-8 sequence */
7356 yield = string_catn(yield, seq_buff, seq_len);
7361 else /* no bytes left: new sequence */
7363 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7365 yield = string_catn(yield, &c, 1);
7368 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7370 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7375 codepoint = c & 0x1f;
7378 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7381 codepoint = c & 0x0f;
7383 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7386 codepoint = c & 0x07;
7388 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7391 seq_buff[index++] = c;
7392 seq_len = bytes_left + 1;
7393 } /* if(bytes_left) */
7397 bytes_left = index = 0;
7398 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7400 if ((complete == 1) && ((c & 0x80) == 0))
7401 /* ASCII character follows incomplete sequence */
7402 yield = string_catn(yield, &c, 1);
7404 /* If given a sequence truncated mid-character, we also want to report ?
7405 * Eg, ${length_1:フィル} is one byte, not one character, so we expect
7406 * ${utf8clean:${length_1:フィル}} to yield '?' */
7407 if (bytes_left != 0)
7409 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7415 case EOP_UTF8_DOMAIN_TO_ALABEL:
7417 uschar * error = NULL;
7418 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7421 expand_string_message = string_sprintf(
7422 "error converting utf8 (%s) to alabel: %s",
7423 string_printing(sub), error);
7426 yield = string_cat(yield, s);
7430 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7432 uschar * error = NULL;
7433 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7436 expand_string_message = string_sprintf(
7437 "error converting alabel (%s) to utf8: %s",
7438 string_printing(sub), error);
7441 yield = string_cat(yield, s);
7445 case EOP_UTF8_LOCALPART_TO_ALABEL:
7447 uschar * error = NULL;
7448 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7451 expand_string_message = string_sprintf(
7452 "error converting utf8 (%s) to alabel: %s",
7453 string_printing(sub), error);
7456 yield = string_cat(yield, s);
7457 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7461 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7463 uschar * error = NULL;
7464 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7467 expand_string_message = string_sprintf(
7468 "error converting alabel (%s) to utf8: %s",
7469 string_printing(sub), error);
7472 yield = string_cat(yield, s);
7475 #endif /* EXPERIMENTAL_INTERNATIONAL */
7477 /* escape turns all non-printing characters into escape sequences. */
7481 const uschar * t = string_printing(sub);
7482 yield = string_cat(yield, t);
7486 case EOP_ESCAPE8BIT:
7490 for (const uschar * s = sub; (c = *s); s++)
7491 yield = c < 127 && c != '\\'
7492 ? string_catn(yield, s, 1)
7493 : string_fmt_append(yield, "\\%03o", c);
7497 /* Handle numeric expression evaluation */
7502 uschar *save_sub = sub;
7503 uschar *error = NULL;
7504 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7507 expand_string_message = string_sprintf("error in expression "
7508 "evaluation: %s (after processing \"%.*s\")", error,
7509 (int)(sub-save_sub), save_sub);
7512 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
7516 /* Handle time period formating */
7520 int n = readconf_readtime(sub, 0, FALSE);
7523 expand_string_message = string_sprintf("string \"%s\" is not an "
7524 "Exim time interval in \"%s\" operator", sub, name);
7527 yield = string_fmt_append(yield, "%d", n);
7531 case EOP_TIME_INTERVAL:
7534 uschar *t = read_number(&n, sub);
7535 if (*t != 0) /* Not A Number*/
7537 expand_string_message = string_sprintf("string \"%s\" is not a "
7538 "positive number in \"%s\" operator", sub, name);
7541 t = readconf_printtime(n);
7542 yield = string_cat(yield, t);
7546 /* Convert string to base64 encoding */
7552 uschar * s = vp && *(void **)vp->value
7553 ? tls_cert_der_b64(*(void **)vp->value)
7554 : b64encode(CUS sub, Ustrlen(sub));
7556 uschar * s = b64encode(CUS sub, Ustrlen(sub));
7558 yield = string_cat(yield, s);
7565 int len = b64decode(sub, &s);
7568 expand_string_message = string_sprintf("string \"%s\" is not "
7569 "well-formed for \"%s\" operator", sub, name);
7572 yield = string_cat(yield, s);
7576 /* strlen returns the length of the string */
7579 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
7582 /* length_n or l_n takes just the first n characters or the whole string,
7583 whichever is the shorter;
7585 substr_m_n, and s_m_n take n characters from offset m; negative m take
7586 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7587 takes the rest, either to the right or to the left.
7589 hash_n or h_n makes a hash of length n from the string, yielding n
7590 characters from the set a-z; hash_n_m makes a hash of length n, but
7591 uses m characters from the set a-zA-Z0-9.
7593 nhash_n returns a single number between 0 and n-1 (in text form), while
7594 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7595 between 0 and n-1 and the second between 0 and m-1. */
7615 expand_string_message = string_sprintf("missing values after %s",
7620 /* "length" has only one argument, effectively being synonymous with
7623 if (c == EOP_LENGTH || c == EOP_L)
7629 /* The others have one or two arguments; for "substr" the first may be
7630 negative. The second being negative means "not supplied". */
7635 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7638 /* Read up to two numbers, separated by underscores */
7643 if (arg != ret && *arg == '_' && pn == &value1)
7647 if (arg[1] != 0) arg++;
7649 else if (!isdigit(*arg))
7651 expand_string_message =
7652 string_sprintf("non-digit after underscore in \"%s\"", name);
7655 else *pn = (*pn)*10 + *arg++ - '0';
7659 /* Perform the required operation */
7662 (c == EOP_HASH || c == EOP_H)?
7663 compute_hash(sub, value1, value2, &len) :
7664 (c == EOP_NHASH || c == EOP_NH)?
7665 compute_nhash(sub, value1, value2, &len) :
7666 extract_substr(sub, value1, value2, &len);
7668 if (ret == NULL) goto EXPAND_FAILED;
7669 yield = string_catn(yield, ret, len);
7678 uschar **modetable[3];
7682 if (expand_forbid & RDO_EXISTS)
7684 expand_string_message = US"Use of the stat() expansion is not permitted";
7688 if (stat(CS sub, &st) < 0)
7690 expand_string_message = string_sprintf("stat(%s) failed: %s",
7691 sub, strerror(errno));
7695 switch (mode & S_IFMT)
7697 case S_IFIFO: smode[0] = 'p'; break;
7698 case S_IFCHR: smode[0] = 'c'; break;
7699 case S_IFDIR: smode[0] = 'd'; break;
7700 case S_IFBLK: smode[0] = 'b'; break;
7701 case S_IFREG: smode[0] = '-'; break;
7702 default: smode[0] = '?'; break;
7705 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7706 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7707 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7709 for (int i = 0; i < 3; i++)
7711 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7716 yield = string_fmt_append(yield,
7717 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7718 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7719 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7720 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7721 (long)st.st_gid, st.st_size, (long)st.st_atime,
7722 (long)st.st_mtime, (long)st.st_ctime);
7726 /* vaguely random number less than N */
7730 int_eximarith_t max = expanded_string_integer(sub, TRUE);
7732 if (expand_string_message)
7734 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
7738 /* Reverse IP, including IPv6 to dotted-nibble */
7740 case EOP_REVERSE_IP:
7742 int family, maskptr;
7743 uschar reversed[128];
7745 family = string_is_ip_address(sub, &maskptr);
7748 expand_string_message = string_sprintf(
7749 "reverse_ip() not given an IP address [%s]", sub);
7752 invert_address(reversed, sub);
7753 yield = string_cat(yield, reversed);
7757 /* Unknown operator */
7760 expand_string_message =
7761 string_sprintf("unknown expansion operator \"%s\"", name);
7766 /* Handle a plain name. If this is the first thing in the expansion, release
7767 the pre-allocated buffer. If the result data is known to be in a new buffer,
7768 newsize will be set to the size of that buffer, and we can just point at that
7769 store instead of copying. Many expansion strings contain just one reference,
7770 so this is a useful optimization, especially for humungous headers
7771 ($message_headers). */
7780 g = store_get(sizeof(gstring));
7781 else if (yield->ptr == 0)
7783 if (resetok) store_reset(yield);
7785 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
7787 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
7789 expand_string_message =
7790 string_sprintf("unknown variable in \"${%s}\"", name);
7791 check_variable_error_message(name);
7794 len = Ustrlen(value);
7795 if (!yield && newsize)
7798 yield->size = newsize;
7803 yield = string_catn(yield, value, len);
7807 /* Else there's something wrong */
7809 expand_string_message =
7810 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7811 "in a variable reference)", name);
7815 /* If we hit the end of the string when ket_ends is set, there is a missing
7816 terminating brace. */
7818 if (ket_ends && *s == 0)
7820 expand_string_message = malformed_header
7821 ? US"missing } at end of string - could be header name not terminated by colon"
7822 : US"missing } at end of string";
7826 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7827 added to the string. If so, set up an empty string. Add a terminating zero. If
7828 left != NULL, return a pointer to the terminator. */
7831 yield = string_get(1);
7832 (void) string_from_gstring(yield);
7833 if (left) *left = s;
7835 /* Any stacking store that was used above the final string is no longer needed.
7836 In many cases the final string will be the first one that was got and so there
7837 will be optimal store usage. */
7839 if (resetok) store_reset(yield->s + (yield->size = yield->ptr + 1));
7840 else if (resetok_p) *resetok_p = FALSE;
7845 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
7846 debug_printf_indent("%sresult: %s\n",
7847 skipping ? "|-----" : "\\_____", yield->s);
7849 debug_printf_indent("\\___skipping: result is not used\n");
7853 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
7854 "expanding: %.*s\n",
7855 (int)(s - string), string);
7856 debug_printf_indent("%s"
7857 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7859 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7862 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7863 "skipping: result is not used\n");
7868 /* This is the failure exit: easiest to program with a goto. We still need
7869 to update the pointer to the terminator, for cases of nested calls with "fail".
7872 EXPAND_FAILED_CURLY:
7873 if (malformed_header)
7874 expand_string_message =
7875 US"missing or misplaced { or } - could be header name not terminated by colon";
7877 else if (!expand_string_message || !*expand_string_message)
7878 expand_string_message = US"missing or misplaced { or }";
7880 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7881 that is a bad idea, because expand_string_message is in dynamic store. */
7884 if (left) *left = s;
7888 debug_printf_indent("|failed to expand: %s\n", string);
7889 debug_printf_indent("%serror message: %s\n",
7890 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
7891 if (f.expand_string_forcedfail)
7892 debug_printf_indent("\\failure was forced\n");
7896 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
7898 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7899 "error message: %s\n",
7900 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7901 expand_string_message);
7902 if (f.expand_string_forcedfail)
7903 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
7905 if (resetok_p && !resetok) *resetok_p = FALSE;
7911 /* This is the external function call. Do a quick check for any expansion
7912 metacharacters, and if there are none, just return the input string.
7914 Argument: the string to be expanded
7915 Returns: the expanded string, or NULL if expansion failed; if failure was
7916 due to a lookup deferring, search_find_defer will be TRUE
7920 expand_cstring(const uschar * string)
7922 if (Ustrpbrk(string, "$\\") != NULL)
7924 int old_pool = store_pool;
7927 f.search_find_defer = FALSE;
7928 malformed_header = FALSE;
7929 store_pool = POOL_MAIN;
7930 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7931 store_pool = old_pool;
7939 expand_string(uschar * string)
7941 return US expand_cstring(CUS string);
7948 /*************************************************
7950 *************************************************/
7952 /* Now and again we want to expand a string and be sure that the result is in a
7953 new bit of store. This function does that.
7954 Since we know it has been copied, the de-const cast is safe.
7956 Argument: the string to be expanded
7957 Returns: the expanded string, always in a new bit of store, or NULL
7961 expand_string_copy(const uschar *string)
7963 const uschar *yield = expand_cstring(string);
7964 if (yield == string) yield = string_copy(string);
7970 /*************************************************
7971 * Expand and interpret as an integer *
7972 *************************************************/
7974 /* Expand a string, and convert the result into an integer.
7977 string the string to be expanded
7978 isplus TRUE if a non-negative number is expected
7980 Returns: the integer value, or
7981 -1 for an expansion error ) in both cases, message in
7982 -2 for an integer interpretation error ) expand_string_message
7983 expand_string_message is set NULL for an OK integer
7987 expand_string_integer(uschar *string, BOOL isplus)
7989 return expanded_string_integer(expand_string(string), isplus);
7993 /*************************************************
7994 * Interpret string as an integer *
7995 *************************************************/
7997 /* Convert a string (that has already been expanded) into an integer.
7999 This function is used inside the expansion code.
8002 s the string to be expanded
8003 isplus TRUE if a non-negative number is expected
8005 Returns: the integer value, or
8006 -1 if string is NULL (which implies an expansion error)
8007 -2 for an integer interpretation error
8008 expand_string_message is set NULL for an OK integer
8011 static int_eximarith_t
8012 expanded_string_integer(const uschar *s, BOOL isplus)
8014 int_eximarith_t value;
8015 uschar *msg = US"invalid integer \"%s\"";
8018 /* If expansion failed, expand_string_message will be set. */
8020 if (s == NULL) return -1;
8022 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8023 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8024 systems, so we set it zero ourselves. */
8027 expand_string_message = NULL; /* Indicates no error */
8029 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8030 equal to 0. Unfortunately, people actually relied upon that, so preserve
8031 the behaviour explicitly. Stripping leading whitespace is a harmless
8032 noop change since strtol skips it anyway (provided that there is a number
8036 while (isspace(*s)) ++s;
8040 debug_printf_indent("treating blank string as number 0\n");
8045 value = strtoll(CS s, CSS &endptr, 10);
8049 msg = US"integer expected but \"%s\" found";
8051 else if (value < 0 && isplus)
8053 msg = US"non-negative integer expected but \"%s\" found";
8057 switch (tolower(*endptr))
8062 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8067 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8068 else value *= 1024*1024;
8072 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8073 else value *= 1024*1024*1024;
8077 if (errno == ERANGE)
8078 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8081 while (isspace(*endptr)) endptr++;
8082 if (*endptr == 0) return value;
8086 expand_string_message = string_sprintf(CS msg, s);
8091 /* These values are usually fixed boolean values, but they are permitted to be
8095 addr address being routed
8096 mtype the module type
8097 mname the module name
8098 dbg_opt debug selectors
8099 oname the option name
8100 bvalue the router's boolean value
8101 svalue the router's string value
8102 rvalue where to put the returned value
8104 Returns: OK value placed in rvalue
8105 DEFER expansion failed
8109 exp_bool(address_item *addr,
8110 uschar *mtype, uschar *mname, unsigned dbg_opt,
8111 uschar *oname, BOOL bvalue,
8112 uschar *svalue, BOOL *rvalue)
8115 if (svalue == NULL) { *rvalue = bvalue; return OK; }
8117 expanded = expand_string(svalue);
8118 if (expanded == NULL)
8120 if (f.expand_string_forcedfail)
8122 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8126 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8127 oname, mname, mtype, expand_string_message);
8128 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8132 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8135 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8137 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8141 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8142 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8151 /* Avoid potentially exposing a password in a string about to be logged */
8154 expand_hide_passwords(uschar * s)
8156 return ( ( Ustrstr(s, "failed to expand") != NULL
8157 || Ustrstr(s, "expansion of ") != NULL
8159 && ( Ustrstr(s, "mysql") != NULL
8160 || Ustrstr(s, "pgsql") != NULL
8161 || Ustrstr(s, "redis") != NULL
8162 || Ustrstr(s, "sqlite") != NULL
8163 || Ustrstr(s, "ldap:") != NULL
8164 || Ustrstr(s, "ldaps:") != NULL
8165 || Ustrstr(s, "ldapi:") != NULL
8166 || Ustrstr(s, "ldapdn:") != NULL
8167 || Ustrstr(s, "ldapm:") != NULL
8169 ? US"Temporary internal error" : s;
8173 /* Read given named file into big_buffer. Use for keying material etc.
8174 The content will have an ascii NUL appended.
8179 Return: pointer to buffer, or NULL on error.
8183 expand_file_big_buffer(const uschar * filename)
8185 int fd, off = 0, len;
8187 if ((fd = open(CS filename, O_RDONLY)) < 0)
8189 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8196 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8199 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8207 big_buffer[off] = '\0';
8213 /*************************************************
8214 * Error-checking for testsuite *
8215 *************************************************/
8217 uschar * region_start;
8218 uschar * region_end;
8219 const uschar *var_name;
8220 const uschar *var_data;
8224 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8227 if (var_data >= e->region_start && var_data < e->region_end)
8229 e->var_name = CUS var_name;
8230 e->var_data = CUS var_data;
8235 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8237 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8238 .var_name = NULL, .var_data = NULL };
8240 /* check acl_ variables */
8241 tree_walk(acl_var_c, assert_variable_notin, &e);
8242 tree_walk(acl_var_m, assert_variable_notin, &e);
8244 /* check auth<n> variables */
8245 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8246 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
8248 /* check regex<n> variables */
8249 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8250 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
8252 /* check known-name variables */
8253 for (var_entry * v = var_table; v < var_table + var_table_size; v++)
8254 if (v->type == vtype_stringptr)
8255 assert_variable_notin(US v->name, *(USS v->value), &e);
8257 /* check dns and address trees */
8258 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8259 tree_walk(tree_duplicates, assert_variable_notin, &e);
8260 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8261 tree_walk(tree_unusable, assert_variable_notin, &e);
8264 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8265 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8266 e.var_name, filename, linenumber, e.var_data);
8271 /*************************************************
8272 **************************************************
8273 * Stand-alone test program *
8274 **************************************************
8275 *************************************************/
8281 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
8283 int ovector[3*(EXPAND_MAXN+1)];
8284 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8285 ovector, nelem(ovector));
8286 BOOL yield = n >= 0;
8287 if (n == 0) n = EXPAND_MAXN + 1;
8290 expand_nmax = setup < 0 ? 0 : setup + 1;
8291 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8293 expand_nstring[expand_nmax] = subject + ovector[nn];
8294 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8302 int main(int argc, uschar **argv)
8304 uschar buffer[1024];
8306 debug_selector = D_v;
8307 debug_file = stderr;
8308 debug_fd = fileno(debug_file);
8309 big_buffer = malloc(big_buffer_size);
8311 for (int i = 1; i < argc; i++)
8313 if (argv[i][0] == '+')
8315 debug_trace_memory = 2;
8318 if (isdigit(argv[i][0]))
8319 debug_selector = Ustrtol(argv[i], NULL, 0);
8321 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8325 eldap_default_servers = argv[i];
8328 mysql_servers = argv[i];
8331 pgsql_servers = argv[i];
8334 redis_servers = argv[i];
8338 else opt_perl_startup = argv[i];
8342 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8344 expand_nstring[1] = US"string 1....";
8345 expand_nlength[1] = 8;
8349 if (opt_perl_startup != NULL)
8352 printf("Starting Perl interpreter\n");
8353 errstr = init_perl(opt_perl_startup);
8356 printf("** error in perl_startup code: %s\n", errstr);
8357 return EXIT_FAILURE;
8360 #endif /* EXIM_PERL */
8362 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8364 void *reset_point = store_get(0);
8365 uschar *yield = expand_string(buffer);
8368 printf("%s\n", yield);
8369 store_reset(reset_point);
8373 if (f.search_find_defer) printf("search_find deferred\n");
8374 printf("Failed: %s\n", expand_string_message);
8375 if (f.expand_string_forcedfail) printf("Forced failure\n");
8389 /* End of expand.c */