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 */
334 US"match_local_part",
359 ECOND_FIRST_DELIVERY,
380 ECOND_MATCH_LOCAL_PART,
390 /* Types of table entry */
393 vtype_int, /* value is address of int */
394 vtype_filter_int, /* ditto, but recognized only when filtering */
395 vtype_ino, /* value is address of ino_t (not always an int) */
396 vtype_uid, /* value is address of uid_t (not always an int) */
397 vtype_gid, /* value is address of gid_t (not always an int) */
398 vtype_bool, /* value is address of bool */
399 vtype_stringptr, /* value is address of pointer to string */
400 vtype_msgbody, /* as stringptr, but read when first required */
401 vtype_msgbody_end, /* ditto, the end of the message */
402 vtype_msgheaders, /* the message's headers, processed */
403 vtype_msgheaders_raw, /* the message's headers, unprocessed */
404 vtype_localpart, /* extract local part from string */
405 vtype_domain, /* extract domain from string */
406 vtype_string_func, /* value is string returned by given function */
407 vtype_todbsdin, /* value not used; generate BSD inbox tod */
408 vtype_tode, /* value not used; generate tod in epoch format */
409 vtype_todel, /* value not used; generate tod in epoch/usec format */
410 vtype_todf, /* value not used; generate full tod */
411 vtype_todl, /* value not used; generate log tod */
412 vtype_todlf, /* value not used; generate log file datestamp tod */
413 vtype_todzone, /* value not used; generate time zone only */
414 vtype_todzulu, /* value not used; generate zulu tod */
415 vtype_reply, /* value not used; get reply from headers */
416 vtype_pid, /* value not used; result is pid */
417 vtype_host_lookup, /* value not used; get host name */
418 vtype_load_avg, /* value not used; result is int from os_getloadavg */
419 vtype_pspace, /* partition space; value is T/F for spool/log */
420 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
421 vtype_cert /* SSL certificate */
423 ,vtype_dkim /* Lookup of value in DKIM signature */
427 /* Type for main variable table */
435 /* Type for entries pointing to address/length pairs. Not currently
443 static uschar * fn_recipients(void);
445 /* This table must be kept in alphabetical order. */
447 static var_entry var_table[] = {
448 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
449 they will be confused with user-creatable ACL variables. */
450 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
451 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
452 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
453 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
454 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
455 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
456 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
457 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
458 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
459 { "acl_narg", vtype_int, &acl_narg },
460 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
461 { "address_data", vtype_stringptr, &deliver_address_data },
462 { "address_file", vtype_stringptr, &address_file },
463 { "address_pipe", vtype_stringptr, &address_pipe },
464 #ifdef EXPERIMENTAL_ARC
465 { "arc_domains", vtype_string_func, &fn_arc_domains },
466 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
467 { "arc_state", vtype_stringptr, &arc_state },
468 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
470 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
471 { "authenticated_id", vtype_stringptr, &authenticated_id },
472 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
473 { "authentication_failed",vtype_int, &authentication_failed },
474 #ifdef WITH_CONTENT_SCAN
475 { "av_failed", vtype_int, &av_failed },
477 #ifdef EXPERIMENTAL_BRIGHTMAIL
478 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
479 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
480 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
481 { "bmi_deliver", vtype_int, &bmi_deliver },
483 { "body_linecount", vtype_int, &body_linecount },
484 { "body_zerocount", vtype_int, &body_zerocount },
485 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
486 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
487 { "caller_gid", vtype_gid, &real_gid },
488 { "caller_uid", vtype_uid, &real_uid },
489 { "callout_address", vtype_stringptr, &callout_address },
490 { "compile_date", vtype_stringptr, &version_date },
491 { "compile_number", vtype_stringptr, &version_cnumber },
492 { "config_dir", vtype_stringptr, &config_main_directory },
493 { "config_file", vtype_stringptr, &config_main_filename },
494 { "csa_status", vtype_stringptr, &csa_status },
495 #ifdef EXPERIMENTAL_DCC
496 { "dcc_header", vtype_stringptr, &dcc_header },
497 { "dcc_result", vtype_stringptr, &dcc_result },
500 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
501 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
502 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
503 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
504 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
505 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
506 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
507 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
508 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
509 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
510 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
511 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
512 { "dkim_key_length", vtype_int, &dkim_key_length },
513 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
514 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
515 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
516 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
517 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
518 { "dkim_signers", vtype_stringptr, &dkim_signers },
519 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
520 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
522 #ifdef EXPERIMENTAL_DMARC
523 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
524 { "dmarc_status", vtype_stringptr, &dmarc_status },
525 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
526 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
528 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
529 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
530 { "dnslist_text", vtype_stringptr, &dnslist_text },
531 { "dnslist_value", vtype_stringptr, &dnslist_value },
532 { "domain", vtype_stringptr, &deliver_domain },
533 { "domain_data", vtype_stringptr, &deliver_domain_data },
534 #ifndef DISABLE_EVENT
535 { "event_data", vtype_stringptr, &event_data },
537 /*XXX want to use generic vars for as many of these as possible*/
538 { "event_defer_errno", vtype_int, &event_defer_errno },
540 { "event_name", vtype_stringptr, &event_name },
542 { "exim_gid", vtype_gid, &exim_gid },
543 { "exim_path", vtype_stringptr, &exim_path },
544 { "exim_uid", vtype_uid, &exim_uid },
545 { "exim_version", vtype_stringptr, &version_string },
546 { "headers_added", vtype_string_func, &fn_hdrs_added },
547 { "home", vtype_stringptr, &deliver_home },
548 { "host", vtype_stringptr, &deliver_host },
549 { "host_address", vtype_stringptr, &deliver_host_address },
550 { "host_data", vtype_stringptr, &host_data },
551 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
552 { "host_lookup_failed", vtype_int, &host_lookup_failed },
553 { "host_port", vtype_int, &deliver_host_port },
554 { "initial_cwd", vtype_stringptr, &initial_cwd },
555 { "inode", vtype_ino, &deliver_inode },
556 { "interface_address", vtype_stringptr, &interface_address },
557 { "interface_port", vtype_int, &interface_port },
558 { "item", vtype_stringptr, &iterate_item },
560 { "ldap_dn", vtype_stringptr, &eldap_dn },
562 { "load_average", vtype_load_avg, NULL },
563 { "local_part", vtype_stringptr, &deliver_localpart },
564 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
565 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
566 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
567 #ifdef HAVE_LOCAL_SCAN
568 { "local_scan_data", vtype_stringptr, &local_scan_data },
570 { "local_user_gid", vtype_gid, &local_user_gid },
571 { "local_user_uid", vtype_uid, &local_user_uid },
572 { "localhost_number", vtype_int, &host_number },
573 { "log_inodes", vtype_pinodes, (void *)FALSE },
574 { "log_space", vtype_pspace, (void *)FALSE },
575 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
576 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
577 #ifdef WITH_CONTENT_SCAN
578 { "malware_name", vtype_stringptr, &malware_name },
580 { "max_received_linelength", vtype_int, &max_received_linelength },
581 { "message_age", vtype_int, &message_age },
582 { "message_body", vtype_msgbody, &message_body },
583 { "message_body_end", vtype_msgbody_end, &message_body_end },
584 { "message_body_size", vtype_int, &message_body_size },
585 { "message_exim_id", vtype_stringptr, &message_id },
586 { "message_headers", vtype_msgheaders, NULL },
587 { "message_headers_raw", vtype_msgheaders_raw, NULL },
588 { "message_id", vtype_stringptr, &message_id },
589 { "message_linecount", vtype_int, &message_linecount },
590 { "message_size", vtype_int, &message_size },
592 { "message_smtputf8", vtype_bool, &message_smtputf8 },
594 #ifdef WITH_CONTENT_SCAN
595 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
596 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
597 { "mime_boundary", vtype_stringptr, &mime_boundary },
598 { "mime_charset", vtype_stringptr, &mime_charset },
599 { "mime_content_description", vtype_stringptr, &mime_content_description },
600 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
601 { "mime_content_id", vtype_stringptr, &mime_content_id },
602 { "mime_content_size", vtype_int, &mime_content_size },
603 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
604 { "mime_content_type", vtype_stringptr, &mime_content_type },
605 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
606 { "mime_filename", vtype_stringptr, &mime_filename },
607 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
608 { "mime_is_multipart", vtype_int, &mime_is_multipart },
609 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
610 { "mime_part_count", vtype_int, &mime_part_count },
612 { "n0", vtype_filter_int, &filter_n[0] },
613 { "n1", vtype_filter_int, &filter_n[1] },
614 { "n2", vtype_filter_int, &filter_n[2] },
615 { "n3", vtype_filter_int, &filter_n[3] },
616 { "n4", vtype_filter_int, &filter_n[4] },
617 { "n5", vtype_filter_int, &filter_n[5] },
618 { "n6", vtype_filter_int, &filter_n[6] },
619 { "n7", vtype_filter_int, &filter_n[7] },
620 { "n8", vtype_filter_int, &filter_n[8] },
621 { "n9", vtype_filter_int, &filter_n[9] },
622 { "original_domain", vtype_stringptr, &deliver_domain_orig },
623 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
624 { "originator_gid", vtype_gid, &originator_gid },
625 { "originator_uid", vtype_uid, &originator_uid },
626 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
627 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
628 { "pid", vtype_pid, NULL },
630 { "prdr_requested", vtype_bool, &prdr_requested },
632 { "primary_hostname", vtype_stringptr, &primary_hostname },
633 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
634 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
635 { "proxy_external_port", vtype_int, &proxy_external_port },
636 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
637 { "proxy_local_port", vtype_int, &proxy_local_port },
638 { "proxy_session", vtype_bool, &proxy_session },
640 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
641 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
642 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
643 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
644 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
645 { "queue_name", vtype_stringptr, &queue_name },
646 { "rcpt_count", vtype_int, &rcpt_count },
647 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
648 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
649 { "received_count", vtype_int, &received_count },
650 { "received_for", vtype_stringptr, &received_for },
651 { "received_ip_address", vtype_stringptr, &interface_address },
652 { "received_port", vtype_int, &interface_port },
653 { "received_protocol", vtype_stringptr, &received_protocol },
654 { "received_time", vtype_int, &received_time.tv_sec },
655 { "recipient_data", vtype_stringptr, &recipient_data },
656 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
657 { "recipients", vtype_string_func, &fn_recipients },
658 { "recipients_count", vtype_int, &recipients_count },
659 #ifdef WITH_CONTENT_SCAN
660 { "regex_match_string", vtype_stringptr, ®ex_match_string },
662 { "reply_address", vtype_reply, NULL },
663 #if defined(SUPPORT_TLS) && defined(EXPERIMENTAL_REQUIRETLS)
664 { "requiretls", vtype_bool, &tls_requiretls },
666 { "return_path", vtype_stringptr, &return_path },
667 { "return_size_limit", vtype_int, &bounce_return_size_limit },
668 { "router_name", vtype_stringptr, &router_name },
669 { "runrc", vtype_int, &runrc },
670 { "self_hostname", vtype_stringptr, &self_hostname },
671 { "sender_address", vtype_stringptr, &sender_address },
672 { "sender_address_data", vtype_stringptr, &sender_address_data },
673 { "sender_address_domain", vtype_domain, &sender_address },
674 { "sender_address_local_part", vtype_localpart, &sender_address },
675 { "sender_data", vtype_stringptr, &sender_data },
676 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
677 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
678 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
679 { "sender_host_address", vtype_stringptr, &sender_host_address },
680 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
681 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
682 { "sender_host_name", vtype_host_lookup, NULL },
683 { "sender_host_port", vtype_int, &sender_host_port },
684 { "sender_ident", vtype_stringptr, &sender_ident },
685 { "sender_rate", vtype_stringptr, &sender_rate },
686 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
687 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
688 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
689 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
690 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
691 { "sending_port", vtype_int, &sending_port },
692 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
693 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
694 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
695 { "smtp_command_history", vtype_string_func, &smtp_cmd_hist },
696 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
697 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
698 { "sn0", vtype_filter_int, &filter_sn[0] },
699 { "sn1", vtype_filter_int, &filter_sn[1] },
700 { "sn2", vtype_filter_int, &filter_sn[2] },
701 { "sn3", vtype_filter_int, &filter_sn[3] },
702 { "sn4", vtype_filter_int, &filter_sn[4] },
703 { "sn5", vtype_filter_int, &filter_sn[5] },
704 { "sn6", vtype_filter_int, &filter_sn[6] },
705 { "sn7", vtype_filter_int, &filter_sn[7] },
706 { "sn8", vtype_filter_int, &filter_sn[8] },
707 { "sn9", vtype_filter_int, &filter_sn[9] },
708 #ifdef WITH_CONTENT_SCAN
709 { "spam_action", vtype_stringptr, &spam_action },
710 { "spam_bar", vtype_stringptr, &spam_bar },
711 { "spam_report", vtype_stringptr, &spam_report },
712 { "spam_score", vtype_stringptr, &spam_score },
713 { "spam_score_int", vtype_stringptr, &spam_score_int },
716 { "spf_guess", vtype_stringptr, &spf_guess },
717 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
718 { "spf_received", vtype_stringptr, &spf_received },
719 { "spf_result", vtype_stringptr, &spf_result },
720 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
721 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
723 { "spool_directory", vtype_stringptr, &spool_directory },
724 { "spool_inodes", vtype_pinodes, (void *)TRUE },
725 { "spool_space", vtype_pspace, (void *)TRUE },
726 #ifdef EXPERIMENTAL_SRS
727 { "srs_db_address", vtype_stringptr, &srs_db_address },
728 { "srs_db_key", vtype_stringptr, &srs_db_key },
729 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
730 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
731 { "srs_recipient", vtype_stringptr, &srs_recipient },
732 { "srs_status", vtype_stringptr, &srs_status },
734 { "thisaddress", vtype_stringptr, &filter_thisaddress },
736 /* The non-(in,out) variables are now deprecated */
737 { "tls_bits", vtype_int, &tls_in.bits },
738 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
739 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
741 { "tls_in_bits", vtype_int, &tls_in.bits },
742 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
743 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
744 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
745 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
746 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
747 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
748 #if defined(SUPPORT_TLS)
749 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
751 { "tls_out_bits", vtype_int, &tls_out.bits },
752 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
753 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
755 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
757 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
758 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
759 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
760 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
761 #if defined(SUPPORT_TLS)
762 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
765 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
768 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
769 #if defined(SUPPORT_TLS)
770 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
773 { "tod_bsdinbox", vtype_todbsdin, NULL },
774 { "tod_epoch", vtype_tode, NULL },
775 { "tod_epoch_l", vtype_todel, NULL },
776 { "tod_full", vtype_todf, NULL },
777 { "tod_log", vtype_todl, NULL },
778 { "tod_logfile", vtype_todlf, NULL },
779 { "tod_zone", vtype_todzone, NULL },
780 { "tod_zulu", vtype_todzulu, NULL },
781 { "transport_name", vtype_stringptr, &transport_name },
782 { "value", vtype_stringptr, &lookup_value },
783 { "verify_mode", vtype_stringptr, &verify_mode },
784 { "version_number", vtype_stringptr, &version_string },
785 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
786 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
787 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
788 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
789 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
790 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
793 static int var_table_size = nelem(var_table);
794 static uschar var_buffer[256];
795 static BOOL malformed_header;
797 /* For textual hashes */
799 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
800 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
803 enum { HMAC_MD5, HMAC_SHA1 };
805 /* For numeric hashes */
807 static unsigned int prime[] = {
808 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
809 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
810 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
812 /* For printing modes in symbolic form */
814 static uschar *mtable_normal[] =
815 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
817 static uschar *mtable_setid[] =
818 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
820 static uschar *mtable_sticky[] =
821 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
823 /* flags for find_header() */
824 #define FH_EXISTS_ONLY BIT(0)
825 #define FH_WANT_RAW BIT(1)
826 #define FH_WANT_LIST BIT(2)
829 /*************************************************
830 * Tables for UTF-8 support *
831 *************************************************/
833 /* Table of the number of extra characters, indexed by the first character
834 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
837 static uschar utf8_table1[] = {
838 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
839 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
840 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
841 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
843 /* These are the masks for the data bits in the first byte of a character,
844 indexed by the number of additional bytes. */
846 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
848 /* Get the next UTF-8 character, advancing the pointer. */
850 #define GETUTF8INC(c, ptr) \
852 if ((c & 0xc0) == 0xc0) \
854 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
856 c = (c & utf8_table2[a]) << s; \
860 c |= (*ptr++ & 0x3f) << s; \
866 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
868 /*************************************************
869 * Binary chop search on a table *
870 *************************************************/
872 /* This is used for matching expansion items and operators.
875 name the name that is being sought
876 table the table to search
877 table_size the number of items in the table
879 Returns: the offset in the table, or -1
883 chop_match(uschar *name, uschar **table, int table_size)
885 uschar **bot = table;
886 uschar **top = table + table_size;
890 uschar **mid = bot + (top - bot)/2;
891 int c = Ustrcmp(name, *mid);
892 if (c == 0) return mid - table;
893 if (c > 0) bot = mid + 1; else top = mid;
901 /*************************************************
902 * Check a condition string *
903 *************************************************/
905 /* This function is called to expand a string, and test the result for a "true"
906 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
907 forced fail or lookup defer.
909 We used to release all store used, but this is not not safe due
910 to ${dlfunc } and ${acl }. In any case expand_string_internal()
911 is reasonably careful to release what it can.
913 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
916 condition the condition string
917 m1 text to be incorporated in panic error
920 Returns: TRUE if condition is met, FALSE if not
924 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
927 uschar *ss = expand_string(condition);
930 if (!f.expand_string_forcedfail && !f.search_find_defer)
931 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
932 "for %s %s: %s", condition, m1, m2, expand_string_message);
935 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
936 strcmpic(ss, US"false") != 0;
943 /*************************************************
944 * Pseudo-random number generation *
945 *************************************************/
947 /* Pseudo-random number generation. The result is not "expected" to be
948 cryptographically strong but not so weak that someone will shoot themselves
949 in the foot using it as a nonce in some email header scheme or whatever
950 weirdness they'll twist this into. The result should ideally handle fork().
952 However, if we're stuck unable to provide this, then we'll fall back to
953 appallingly bad randomness.
955 If SUPPORT_TLS is defined then this will not be used except as an emergency
960 Returns a random number in range [0, max-1]
964 # define vaguely_random_number vaguely_random_number_fallback
967 vaguely_random_number(int max)
970 # undef vaguely_random_number
972 static pid_t pid = 0;
974 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
984 #ifdef HAVE_ARC4RANDOM
985 /* cryptographically strong randomness, common on *BSD platforms, not
986 so much elsewhere. Alas. */
987 #ifndef NOT_HAVE_ARC4RANDOM_STIR
990 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
991 #ifdef HAVE_SRANDOMDEV
992 /* uses random(4) for seeding */
995 gettimeofday(&tv, NULL);
996 srandom(tv.tv_sec | tv.tv_usec | getpid());
999 /* Poor randomness and no seeding here */
1006 #ifdef HAVE_ARC4RANDOM
1007 return arc4random() % max;
1008 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1009 return random() % max;
1011 /* This one returns a 16-bit number, definitely not crypto-strong */
1012 return random_number(max);
1019 /*************************************************
1020 * Pick out a name from a string *
1021 *************************************************/
1023 /* If the name is too long, it is silently truncated.
1026 name points to a buffer into which to put the name
1027 max is the length of the buffer
1028 s points to the first alphabetic character of the name
1029 extras chars other than alphanumerics to permit
1031 Returns: pointer to the first character after the name
1033 Note: The test for *s != 0 in the while loop is necessary because
1034 Ustrchr() yields non-NULL if the character is zero (which is not something
1037 static const uschar *
1038 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1041 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1043 if (ptr < max-1) name[ptr++] = *s;
1052 /*************************************************
1053 * Pick out the rest of a header name *
1054 *************************************************/
1056 /* A variable name starting $header_ (or just $h_ for those who like
1057 abbreviations) might not be the complete header name because headers can
1058 contain any printing characters in their names, except ':'. This function is
1059 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1060 on the end, if the name was terminated by white space.
1063 name points to a buffer in which the name read so far exists
1064 max is the length of the buffer
1065 s points to the first character after the name so far, i.e. the
1066 first non-alphameric character after $header_xxxxx
1068 Returns: a pointer to the first character after the header name
1071 static const uschar *
1072 read_header_name(uschar *name, int max, const uschar *s)
1074 int prelen = Ustrchr(name, '_') - name + 1;
1075 int ptr = Ustrlen(name) - prelen;
1076 if (ptr > 0) memmove(name, name+prelen, ptr);
1077 while (mac_isgraph(*s) && *s != ':')
1079 if (ptr < max-1) name[ptr++] = *s;
1090 /*************************************************
1091 * Pick out a number from a string *
1092 *************************************************/
1095 n points to an integer into which to put the number
1096 s points to the first digit of the number
1098 Returns: a pointer to the character after the last digit
1100 /*XXX consider expanding to int_eximarith_t. But the test for
1101 "overbig numbers" in 0002 still needs to overflow it. */
1104 read_number(int *n, uschar *s)
1107 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1111 static const uschar *
1112 read_cnumber(int *n, const uschar *s)
1115 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1121 /*************************************************
1122 * Extract keyed subfield from a string *
1123 *************************************************/
1125 /* The yield is in dynamic store; NULL means that the key was not found.
1128 key points to the name of the key
1129 s points to the string from which to extract the subfield
1131 Returns: NULL if the subfield was not found, or
1132 a pointer to the subfield's data
1136 expand_getkeyed(uschar * key, const uschar * s)
1138 int length = Ustrlen(key);
1139 while (isspace(*s)) s++;
1141 /* Loop to search for the key */
1147 const uschar * dkey = s;
1149 while (*s && *s != '=' && !isspace(*s)) s++;
1150 dkeylength = s - dkey;
1151 while (isspace(*s)) s++;
1152 if (*s == '=') while (isspace((*(++s))));
1154 data = string_dequote(&s);
1155 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1158 while (isspace(*s)) s++;
1167 find_var_ent(uschar * name)
1170 int last = var_table_size;
1172 while (last > first)
1174 int middle = (first + last)/2;
1175 int c = Ustrcmp(name, var_table[middle].name);
1177 if (c > 0) { first = middle + 1; continue; }
1178 if (c < 0) { last = middle; continue; }
1179 return &var_table[middle];
1184 /*************************************************
1185 * Extract numbered subfield from string *
1186 *************************************************/
1188 /* Extracts a numbered field from a string that is divided by tokens - for
1189 example a line from /etc/passwd is divided by colon characters. First field is
1190 numbered one. Negative arguments count from the right. Zero returns the whole
1191 string. Returns NULL if there are insufficient tokens in the string
1194 Modifies final argument - this is a dynamically generated string, so that's OK.
1197 field number of field to be extracted,
1198 first field = 1, whole string = 0, last field = -1
1199 separators characters that are used to break string into tokens
1200 s points to the string from which to extract the subfield
1202 Returns: NULL if the field was not found,
1203 a pointer to the field's data inside s (modified to add 0)
1207 expand_gettokened (int field, uschar *separators, uschar *s)
1212 uschar *fieldtext = NULL;
1214 if (field == 0) return s;
1216 /* Break the line up into fields in place; for field > 0 we stop when we have
1217 done the number of fields we want. For field < 0 we continue till the end of
1218 the string, counting the number of fields. */
1220 count = (field > 0)? field : INT_MAX;
1226 /* Previous field was the last one in the string. For a positive field
1227 number, this means there are not enough fields. For a negative field number,
1228 check that there are enough, and scan back to find the one that is wanted. */
1232 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1233 if ((-field) == (INT_MAX - count - 1)) return s;
1237 while (ss[-1] != 0) ss--;
1243 /* Previous field was not last in the string; save its start and put a
1247 len = Ustrcspn(ss, separators);
1258 expand_getlistele(int field, const uschar * list)
1260 const uschar * tlist = list;
1266 for (field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1269 if (field == 0) return NULL;
1270 while (--field > 0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1271 return string_nextinlist(&list, &sep, NULL, 0);
1275 /* Certificate fields, by name. Worry about by-OID later */
1276 /* Names are chosen to not have common prefixes */
1283 uschar * (*getfn)(void * cert, uschar * mod);
1285 static certfield certfields[] =
1286 { /* linear search; no special order */
1287 { US"version", 7, &tls_cert_version },
1288 { US"serial_number", 13, &tls_cert_serial_number },
1289 { US"subject", 7, &tls_cert_subject },
1290 { US"notbefore", 9, &tls_cert_not_before },
1291 { US"notafter", 8, &tls_cert_not_after },
1292 { US"issuer", 6, &tls_cert_issuer },
1293 { US"signature", 9, &tls_cert_signature },
1294 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1295 { US"subj_altname", 12, &tls_cert_subject_altname },
1296 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1297 { US"crl_uri", 7, &tls_cert_crl_uri },
1301 expand_getcertele(uschar * field, uschar * certvar)
1305 if (!(vp = find_var_ent(certvar)))
1307 expand_string_message =
1308 string_sprintf("no variable named \"%s\"", certvar);
1309 return NULL; /* Unknown variable name */
1311 /* NB this stops us passing certs around in variable. Might
1312 want to do that in future */
1313 if (vp->type != vtype_cert)
1315 expand_string_message =
1316 string_sprintf("\"%s\" is not a certificate", certvar);
1317 return NULL; /* Unknown variable name */
1319 if (!*(void **)vp->value)
1322 if (*field >= '0' && *field <= '9')
1323 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1325 for (certfield * cp = certfields;
1326 cp < certfields + nelem(certfields);
1328 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1330 uschar * modifier = *(field += cp->namelen) == ','
1332 return (*cp->getfn)( *(void **)vp->value, modifier );
1335 expand_string_message =
1336 string_sprintf("bad field selector \"%s\" for certextract", field);
1339 #endif /*SUPPORT_TLS*/
1341 /*************************************************
1342 * Extract a substring from a string *
1343 *************************************************/
1345 /* Perform the ${substr or ${length expansion operations.
1348 subject the input string
1349 value1 the offset from the start of the input string to the start of
1350 the output string; if negative, count from the right.
1351 value2 the length of the output string, or negative (-1) for unset
1352 if value1 is positive, unset means "all after"
1353 if value1 is negative, unset means "all before"
1354 len set to the length of the returned string
1356 Returns: pointer to the output string, or NULL if there is an error
1360 extract_substr(uschar *subject, int value1, int value2, int *len)
1362 int sublen = Ustrlen(subject);
1364 if (value1 < 0) /* count from right */
1368 /* If the position is before the start, skip to the start, and adjust the
1369 length. If the length ends up negative, the substring is null because nothing
1370 can precede. This falls out naturally when the length is unset, meaning "all
1376 if (value2 < 0) value2 = 0;
1380 /* Otherwise an unset length => characters before value1 */
1382 else if (value2 < 0)
1389 /* For a non-negative offset, if the starting position is past the end of the
1390 string, the result will be the null string. Otherwise, an unset length means
1391 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1395 if (value1 > sublen)
1400 else if (value2 < 0) value2 = sublen;
1403 /* Cut the length down to the maximum possible for the offset value, and get
1404 the required characters. */
1406 if (value1 + value2 > sublen) value2 = sublen - value1;
1408 return subject + value1;
1414 /*************************************************
1415 * Old-style hash of a string *
1416 *************************************************/
1418 /* Perform the ${hash expansion operation.
1421 subject the input string (an expanded substring)
1422 value1 the length of the output string; if greater or equal to the
1423 length of the input string, the input string is returned
1424 value2 the number of hash characters to use, or 26 if negative
1425 len set to the length of the returned string
1427 Returns: pointer to the output string, or NULL if there is an error
1431 compute_hash(uschar *subject, int value1, int value2, int *len)
1433 int sublen = Ustrlen(subject);
1435 if (value2 < 0) value2 = 26;
1436 else if (value2 > Ustrlen(hashcodes))
1438 expand_string_message =
1439 string_sprintf("hash count \"%d\" too big", value2);
1443 /* Calculate the hash text. We know it is shorter than the original string, so
1444 can safely place it in subject[] (we know that subject is always itself an
1445 expanded substring). */
1447 if (value1 < sublen)
1452 while ((c = (subject[j])) != 0)
1454 int shift = (c + j++) & 7;
1455 subject[i] ^= (c << shift) | (c >> (8-shift));
1456 if (++i >= value1) i = 0;
1458 for (i = 0; i < value1; i++)
1459 subject[i] = hashcodes[(subject[i]) % value2];
1461 else value1 = sublen;
1470 /*************************************************
1471 * Numeric hash of a string *
1472 *************************************************/
1474 /* Perform the ${nhash expansion operation. The first characters of the
1475 string are treated as most important, and get the highest prime numbers.
1478 subject the input string
1479 value1 the maximum value of the first part of the result
1480 value2 the maximum value of the second part of the result,
1481 or negative to produce only a one-part result
1482 len set to the length of the returned string
1484 Returns: pointer to the output string, or NULL if there is an error.
1488 compute_nhash (uschar *subject, int value1, int value2, int *len)
1490 uschar *s = subject;
1492 unsigned long int total = 0; /* no overflow */
1496 if (i == 0) i = nelem(prime) - 1;
1497 total += prime[i--] * (unsigned int)(*s++);
1500 /* If value2 is unset, just compute one number */
1503 s = string_sprintf("%lu", total % value1);
1505 /* Otherwise do a div/mod hash */
1509 total = total % (value1 * value2);
1510 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1521 /*************************************************
1522 * Find the value of a header or headers *
1523 *************************************************/
1525 /* Multiple instances of the same header get concatenated, and this function
1526 can also return a concatenation of all the header lines. When concatenating
1527 specific headers that contain lists of addresses, a comma is inserted between
1528 them. Otherwise we use a straight concatenation. Because some messages can have
1529 pathologically large number of lines, there is a limit on the length that is
1533 name the name of the header, without the leading $header_ or $h_,
1534 or NULL if a concatenation of all headers is required
1535 newsize return the size of memory block that was obtained; may be NULL
1536 if exists_only is TRUE
1537 flags FH_EXISTS_ONLY
1538 set if called from a def: test; don't need to build a string;
1539 just return a string that is not "" and not "0" if the header
1542 set if called for $rh_ or $rheader_ items; no processing,
1543 other than concatenating, will be done on the header. Also used
1544 for $message_headers_raw.
1546 Double colon chars in the content, and replace newline with
1547 colon between each element when concatenating; returning a
1548 colon-sep list (elements might contain newlines)
1549 charset name of charset to translate MIME words to; used only if
1550 want_raw is false; if NULL, no translation is done (this is
1551 used for $bh_ and $bheader_)
1553 Returns: NULL if the header does not exist, else a pointer to a new
1558 find_header(uschar *name, int *newsize, unsigned flags, uschar *charset)
1561 int len = name ? Ustrlen(name) : 0;
1565 for (header_line * h = header_list; h; h = h->next)
1566 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1567 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1572 if (flags & FH_EXISTS_ONLY)
1573 return US"1"; /* don't need actual string */
1576 s = h->text + len; /* text to insert */
1577 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1578 while (isspace(*s)) s++; /* remove leading white space */
1579 t = h->text + h->slen; /* end-point */
1581 /* Unless wanted raw, remove trailing whitespace, including the
1584 if (flags & FH_WANT_LIST)
1585 while (t > s && t[-1] == '\n') t--;
1586 else if (!(flags & FH_WANT_RAW))
1588 while (t > s && isspace(t[-1])) t--;
1590 /* Set comma if handling a single header and it's one of those
1591 that contains an address list, except when asked for raw headers. Only
1592 need to do this once. */
1594 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1597 /* Trim the header roughly if we're approaching limits */
1599 if ((g ? g->ptr : 0) + inc > header_insert_maxlen)
1600 inc = header_insert_maxlen - (g ? g->ptr : 0);
1602 /* For raw just copy the data; for a list, add the data as a colon-sep
1603 list-element; for comma-list add as an unchecked comma,newline sep
1604 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1605 stripped trailing WS above including the newline). We ignore the potential
1606 expansion due to colon-doubling, just leaving the loop if the limit is met
1609 if (flags & FH_WANT_LIST)
1610 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1611 else if (flags & FH_WANT_RAW)
1613 g = string_catn(g, s, (unsigned)inc);
1614 (void) string_from_gstring(g);
1618 g = string_append2_listele_n(g, US",\n", s, (unsigned)inc);
1620 g = string_append2_listele_n(g, US"\n", s, (unsigned)inc);
1622 if (g && g->ptr >= header_insert_maxlen) break;
1625 if (!found) return NULL; /* No header found */
1626 if (!g) return US"";
1628 /* That's all we do for raw header expansion. */
1631 if (flags & FH_WANT_RAW)
1634 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1635 The rfc2047_decode2() function can return an error with decoded data if the
1636 charset translation fails. If decoding fails, it returns NULL. */
1640 uschar *decoded, *error;
1642 decoded = rfc2047_decode2(g->s, check_rfc2047_length, charset, '?', NULL,
1646 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1647 " input was: %s\n", error, g->s);
1649 return decoded ? decoded : g->s;
1656 /* Append a "local" element to an Authentication-Results: header
1657 if this was a non-smtp message.
1661 authres_local(gstring * g, const uschar * sysname)
1663 if (!f.authentication_local)
1665 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1666 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1671 /* Append an "iprev" element to an Authentication-Results: header
1672 if we have attempted to get the calling host's name.
1676 authres_iprev(gstring * g)
1678 if (sender_host_name)
1679 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1680 else if (host_lookup_deferred)
1681 g = string_catn(g, US";\n\tiprev=temperror", 19);
1682 else if (host_lookup_failed)
1683 g = string_catn(g, US";\n\tiprev=fail", 13);
1687 if (sender_host_address)
1688 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1694 /*************************************************
1695 * Return list of recipients *
1696 *************************************************/
1697 /* A recipients list is available only during system message filtering,
1698 during ACL processing after DATA, and while expanding pipe commands
1699 generated from a system filter, but not elsewhere. */
1707 if (!f.enable_dollar_recipients) return NULL;
1709 for (int i = 0; i < recipients_count; i++)
1711 s = recipients_list[i].address;
1712 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1714 return g ? g->s : NULL;
1718 /*************************************************
1719 * Find value of a variable *
1720 *************************************************/
1722 /* The table of variables is kept in alphabetic order, so we can search it
1723 using a binary chop. The "choplen" variable is nothing to do with the binary
1727 name the name of the variable being sought
1728 exists_only TRUE if this is a def: test; passed on to find_header()
1729 skipping TRUE => skip any processing evaluation; this is not the same as
1730 exists_only because def: may test for values that are first
1732 newsize pointer to an int which is initially zero; if the answer is in
1733 a new memory buffer, *newsize is set to its size
1735 Returns: NULL if the variable does not exist, or
1736 a pointer to the variable's contents, or
1737 something non-NULL if exists_only is TRUE
1741 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1748 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1749 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1750 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1751 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1752 (this gave backwards compatibility at the changeover). There may be built-in
1753 variables whose names start acl_ but they should never start in this way. This
1754 slightly messy specification is a consequence of the history, needless to say.
1756 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1757 set, in which case give an error. */
1759 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1763 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1764 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1767 /* Handle $auth<n> variables. */
1769 if (Ustrncmp(name, "auth", 4) == 0)
1772 int n = Ustrtoul(name + 4, &endptr, 10);
1773 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1774 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1776 else if (Ustrncmp(name, "regex", 5) == 0)
1779 int n = Ustrtoul(name + 5, &endptr, 10);
1780 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1781 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1784 /* For all other variables, search the table */
1786 if (!(vp = find_var_ent(name)))
1787 return NULL; /* Unknown variable name */
1789 /* Found an existing variable. If in skipping state, the value isn't needed,
1790 and we want to avoid processing (such as looking up the host name). */
1798 case vtype_filter_int:
1799 if (!f.filter_running) return NULL;
1803 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1807 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1811 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1815 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1819 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1822 case vtype_stringptr: /* Pointer to string */
1823 return (s = *((uschar **)(val))) ? s : US"";
1826 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1829 case vtype_load_avg:
1830 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1833 case vtype_host_lookup: /* Lookup if not done so */
1834 if ( !sender_host_name && sender_host_address
1835 && !host_lookup_failed && host_name_lookup() == OK)
1836 host_build_sender_fullhost();
1837 return sender_host_name ? sender_host_name : US"";
1839 case vtype_localpart: /* Get local part from address */
1840 s = *((uschar **)(val));
1841 if (s == NULL) return US"";
1842 domain = Ustrrchr(s, '@');
1843 if (domain == NULL) return s;
1844 if (domain - s > sizeof(var_buffer) - 1)
1845 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1846 " in string expansion", sizeof(var_buffer));
1847 Ustrncpy(var_buffer, s, domain - s);
1848 var_buffer[domain - s] = 0;
1851 case vtype_domain: /* Get domain from address */
1852 s = *((uschar **)(val));
1853 if (s == NULL) return US"";
1854 domain = Ustrrchr(s, '@');
1855 return (domain == NULL)? US"" : domain + 1;
1857 case vtype_msgheaders:
1858 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
1860 case vtype_msgheaders_raw:
1861 return find_header(NULL, newsize,
1862 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
1864 case vtype_msgbody: /* Pointer to msgbody string */
1865 case vtype_msgbody_end: /* Ditto, the end of the msg */
1866 ss = (uschar **)(val);
1867 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1870 off_t start_offset = SPOOL_DATA_START_OFFSET;
1871 int len = message_body_visible;
1872 if (len > message_size) len = message_size;
1873 *ss = body = store_malloc(len+1);
1875 if (vp->type == vtype_msgbody_end)
1877 struct stat statbuf;
1878 if (fstat(deliver_datafile, &statbuf) == 0)
1880 start_offset = statbuf.st_size - len;
1881 if (start_offset < SPOOL_DATA_START_OFFSET)
1882 start_offset = SPOOL_DATA_START_OFFSET;
1885 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1886 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1888 len = read(deliver_datafile, body, len);
1892 if (message_body_newlines) /* Separate loops for efficiency */
1894 { if (body[--len] == 0) body[len] = ' '; }
1897 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1900 return *ss ? *ss : US"";
1902 case vtype_todbsdin: /* BSD inbox time of day */
1903 return tod_stamp(tod_bsdin);
1905 case vtype_tode: /* Unix epoch time of day */
1906 return tod_stamp(tod_epoch);
1908 case vtype_todel: /* Unix epoch/usec time of day */
1909 return tod_stamp(tod_epoch_l);
1911 case vtype_todf: /* Full time of day */
1912 return tod_stamp(tod_full);
1914 case vtype_todl: /* Log format time of day */
1915 return tod_stamp(tod_log_bare); /* (without timezone) */
1917 case vtype_todzone: /* Time zone offset only */
1918 return tod_stamp(tod_zone);
1920 case vtype_todzulu: /* Zulu time */
1921 return tod_stamp(tod_zulu);
1923 case vtype_todlf: /* Log file datestamp tod */
1924 return tod_stamp(tod_log_datestamp_daily);
1926 case vtype_reply: /* Get reply address */
1927 s = find_header(US"reply-to:", newsize,
1928 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
1930 if (s) while (isspace(*s)) s++;
1933 *newsize = 0; /* For the *s==0 case */
1934 s = find_header(US"from:", newsize,
1935 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
1941 while (isspace(*s)) s++;
1942 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1943 while (t > s && isspace(t[-1])) t--;
1946 return s ? s : US"";
1948 case vtype_string_func:
1950 uschar * (*fn)() = val;
1957 sprintf(CS var_buffer, PR_EXIM_ARITH,
1958 receive_statvfs(val == (void *)TRUE, &inodes));
1965 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1966 sprintf(CS var_buffer, "%d", inodes);
1971 return *(void **)val ? US"<cert>" : US"";
1973 #ifndef DISABLE_DKIM
1975 return dkim_exim_expand_query((int)(long)val);
1980 return NULL; /* Unknown variable. Silences static checkers. */
1987 modify_variable(uschar *name, void * value)
1990 if ((vp = find_var_ent(name))) vp->value = value;
1991 return; /* Unknown variable name, fail silently */
1999 /*************************************************
2000 * Read and expand substrings *
2001 *************************************************/
2003 /* This function is called to read and expand argument substrings for various
2004 expansion items. Some have a minimum requirement that is less than the maximum;
2005 in these cases, the first non-present one is set to NULL.
2008 sub points to vector of pointers to set
2009 n maximum number of substrings
2011 sptr points to current string pointer
2012 skipping the skipping flag
2013 check_end if TRUE, check for final '}'
2014 name name of item, for error message
2015 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2018 Returns: 0 OK; string pointer updated
2019 1 curly bracketing error (too few arguments)
2020 2 too many arguments (only if check_end is set); message set
2021 3 other error (expansion failure)
2025 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
2026 BOOL check_end, uschar *name, BOOL *resetok)
2028 const uschar *s = *sptr;
2030 while (isspace(*s)) s++;
2031 for (int i = 0; i < n; i++)
2037 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2038 "(min is %d)", name, m);
2044 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2046 if (*s++ != '}') return 1;
2047 while (isspace(*s)) s++;
2049 if (check_end && *s++ != '}')
2053 expand_string_message = string_sprintf("Too many arguments for '%s' "
2054 "(max is %d)", name, n);
2057 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2068 /*************************************************
2069 * Elaborate message for bad variable *
2070 *************************************************/
2072 /* For the "unknown variable" message, take a look at the variable's name, and
2073 give additional information about possible ACL variables. The extra information
2074 is added on to expand_string_message.
2076 Argument: the name of the variable
2081 check_variable_error_message(uschar *name)
2083 if (Ustrncmp(name, "acl_", 4) == 0)
2084 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2085 (name[4] == 'c' || name[4] == 'm')?
2087 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2088 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2090 US"user-defined ACL variables must start acl_c or acl_m");
2096 Load args from sub array to globals, and call acl_check().
2097 Sub array will be corrupted on return.
2099 Returns: OK access is granted by an ACCEPT verb
2100 DISCARD access is (apparently) granted by a DISCARD verb
2101 FAIL access is denied
2102 FAIL_DROP access is denied; drop the connection
2103 DEFER can't tell at the moment
2107 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2110 int sav_narg = acl_narg;
2112 uschar * dummy_logmsg;
2113 extern int acl_where;
2115 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2116 for (i = 0; i < nsub && sub[i+1]; i++)
2118 uschar * tmp = acl_arg[i];
2119 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2120 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2125 sub[i+1] = acl_arg[i];
2126 acl_arg[i++] = NULL;
2130 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2132 acl_narg>0 ? acl_arg[0] : US"<none>",
2133 acl_narg>1 ? " +more" : "");
2135 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2137 for (i = 0; i < nsub; i++)
2138 acl_arg[i] = sub[i+1]; /* restore old args */
2139 acl_narg = sav_narg;
2147 /*************************************************
2148 * Read and evaluate a condition *
2149 *************************************************/
2153 s points to the start of the condition text
2154 resetok points to a BOOL which is written false if it is unsafe to
2155 free memory. Certain condition types (acl) may have side-effect
2156 allocation which must be preserved.
2157 yield points to a BOOL to hold the result of the condition test;
2158 if NULL, we are just reading through a condition that is
2159 part of an "or" combination to check syntax, or in a state
2160 where the answer isn't required
2162 Returns: a pointer to the first character after the condition, or
2166 static const uschar *
2167 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2169 BOOL testfor = TRUE;
2170 BOOL tempcond, combined_cond;
2172 BOOL sub2_honour_dollar = TRUE;
2173 int rc, cond_type, roffset;
2174 int_eximarith_t num[2];
2175 struct stat statbuf;
2177 const uschar *sub[10];
2180 const uschar *rerror;
2184 while (isspace(*s)) s++;
2185 if (*s == '!') { testfor = !testfor; s++; } else break;
2188 /* Numeric comparisons are symbolic */
2190 if (*s == '=' || *s == '>' || *s == '<')
2202 /* All other conditions are named */
2204 else s = read_name(name, 256, s, US"_");
2206 /* If we haven't read a name, it means some non-alpha character is first. */
2210 expand_string_message = string_sprintf("condition name expected, "
2211 "but found \"%.16s\"", s);
2215 /* Find which condition we are dealing with, and switch on it */
2217 cond_type = chop_match(name, cond_table, nelem(cond_table));
2220 /* def: tests for a non-empty variable, or for the existence of a header. If
2221 yield == NULL we are in a skipping state, and don't care about the answer. */
2229 expand_string_message = US"\":\" expected after \"def\"";
2233 s = read_name(name, 256, s+1, US"_");
2235 /* Test for a header's existence. If the name contains a closing brace
2236 character, this may be a user error where the terminating colon has been
2237 omitted. Set a flag to adjust a subsequent error message in this case. */
2239 if ( ( *(t = name) == 'h'
2240 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2242 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2245 s = read_header_name(name, 256, s);
2246 /* {-for-text-editors */
2247 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2249 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2252 /* Test for a variable's having a non-empty value. A non-existent variable
2253 causes an expansion failure. */
2257 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2259 expand_string_message = (name[0] == 0)?
2260 string_sprintf("variable name omitted after \"def:\"") :
2261 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2262 check_variable_error_message(name);
2265 if (yield) *yield = (t[0] != 0) == testfor;
2272 /* first_delivery tests for first delivery attempt */
2274 case ECOND_FIRST_DELIVERY:
2275 if (yield != NULL) *yield = f.deliver_firsttime == testfor;
2279 /* queue_running tests for any process started by a queue runner */
2281 case ECOND_QUEUE_RUNNING:
2282 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2286 /* exists: tests for file existence
2287 isip: tests for any IP address
2288 isip4: tests for an IPv4 address
2289 isip6: tests for an IPv6 address
2290 pam: does PAM authentication
2291 radius: does RADIUS authentication
2292 ldapauth: does LDAP authentication
2293 pwcheck: does Cyrus SASL pwcheck authentication
2302 case ECOND_LDAPAUTH:
2305 while (isspace(*s)) s++;
2306 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2308 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2309 if (sub[0] == NULL) return NULL;
2310 /* {-for-text-editors */
2311 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2313 if (yield == NULL) return s; /* No need to run the test if skipping */
2318 if ((expand_forbid & RDO_EXISTS) != 0)
2320 expand_string_message = US"File existence tests are not permitted";
2323 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2329 rc = string_is_ip_address(sub[0], NULL);
2330 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2331 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2334 /* Various authentication tests - all optionally compiled */
2338 rc = auth_call_pam(sub[0], &expand_string_message);
2341 goto COND_FAILED_NOT_COMPILED;
2342 #endif /* SUPPORT_PAM */
2345 #ifdef RADIUS_CONFIG_FILE
2346 rc = auth_call_radius(sub[0], &expand_string_message);
2349 goto COND_FAILED_NOT_COMPILED;
2350 #endif /* RADIUS_CONFIG_FILE */
2352 case ECOND_LDAPAUTH:
2355 /* Just to keep the interface the same */
2357 int old_pool = store_pool;
2358 store_pool = POOL_SEARCH;
2359 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2360 &expand_string_message, &do_cache);
2361 store_pool = old_pool;
2365 goto COND_FAILED_NOT_COMPILED;
2366 #endif /* LOOKUP_LDAP */
2369 #ifdef CYRUS_PWCHECK_SOCKET
2370 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2373 goto COND_FAILED_NOT_COMPILED;
2374 #endif /* CYRUS_PWCHECK_SOCKET */
2376 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2377 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2379 if (rc == ERROR || rc == DEFER) return NULL;
2380 *yield = (rc == OK) == testfor;
2386 /* call ACL (in a conditional context). Accept true, deny false.
2387 Defer is a forced-fail. Anything set by message= goes to $value.
2388 Up to ten parameters are used; we use the braces round the name+args
2389 like the saslauthd condition does, to permit a variable number of args.
2390 See also the expansion-item version EITEM_ACL and the traditional
2391 acl modifier ACLC_ACL.
2392 Since the ACL may allocate new global variables, tell our caller to not
2397 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2403 while (isspace(*s)) s++;
2404 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2406 switch(read_subs(sub, nelem(sub), 1,
2407 &s, yield == NULL, TRUE, US"acl", resetok))
2409 case 1: expand_string_message = US"too few arguments or bracketing "
2412 case 3: return NULL;
2417 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2418 switch(eval_acl(sub, nelem(sub), &user_msg))
2423 lookup_value = NULL;
2425 lookup_value = string_copy(user_msg);
2426 *yield = cond == testfor;
2430 f.expand_string_forcedfail = TRUE;
2433 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2441 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2443 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2445 However, the last two are optional. That is why the whole set is enclosed
2446 in their own set of braces. */
2448 case ECOND_SASLAUTHD:
2449 #ifndef CYRUS_SASLAUTHD_SOCKET
2450 goto COND_FAILED_NOT_COMPILED;
2454 while (isspace(*s)) s++;
2455 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2456 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2459 case 1: expand_string_message = US"too few arguments or bracketing "
2460 "error for saslauthd";
2462 case 3: return NULL;
2464 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2467 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2468 &expand_string_message);
2469 if (rc == ERROR || rc == DEFER) return NULL;
2470 *yield = (rc == OK) == testfor;
2474 #endif /* CYRUS_SASLAUTHD_SOCKET */
2477 /* symbolic operators for numeric and string comparison, and a number of
2478 other operators, all requiring two arguments.
2480 crypteq: encrypts plaintext and compares against an encrypted text,
2481 using crypt(), crypt16(), MD5 or SHA-1
2482 inlist/inlisti: checks if first argument is in the list of the second
2483 match: does a regular expression match and sets up the numerical
2484 variables if it succeeds
2485 match_address: matches in an address list
2486 match_domain: matches in a domain list
2487 match_ip: matches a host list that is restricted to IP addresses
2488 match_local_part: matches in a local part list
2491 case ECOND_MATCH_ADDRESS:
2492 case ECOND_MATCH_DOMAIN:
2493 case ECOND_MATCH_IP:
2494 case ECOND_MATCH_LOCAL_PART:
2495 #ifndef EXPAND_LISTMATCH_RHS
2496 sub2_honour_dollar = FALSE;
2505 case ECOND_NUM_L: /* Numerical comparisons */
2512 case ECOND_STR_LT: /* String comparisons */
2523 for (int i = 0; i < 2; i++)
2525 /* Sometimes, we don't expand substrings; too many insecure configurations
2526 created using match_address{}{} and friends, where the second param
2527 includes information from untrustworthy sources. */
2528 BOOL honour_dollar = TRUE;
2529 if ((i > 0) && !sub2_honour_dollar)
2530 honour_dollar = FALSE;
2532 while (isspace(*s)) s++;
2535 if (i == 0) goto COND_FAILED_CURLY_START;
2536 expand_string_message = string_sprintf("missing 2nd string in {} "
2537 "after \"%s\"", name);
2540 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2541 honour_dollar, resetok)))
2543 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2544 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2545 " for security reasons\n");
2546 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2548 /* Convert to numerical if required; we know that the names of all the
2549 conditions that compare numbers do not start with a letter. This just saves
2550 checking for them individually. */
2552 if (!isalpha(name[0]) && yield != NULL)
2557 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2561 num[i] = expanded_string_integer(sub[i], FALSE);
2562 if (expand_string_message != NULL) return NULL;
2566 /* Result not required */
2568 if (yield == NULL) return s;
2570 /* Do an appropriate comparison */
2576 tempcond = (num[0] == num[1]);
2580 tempcond = (num[0] > num[1]);
2584 tempcond = (num[0] >= num[1]);
2588 tempcond = (num[0] < num[1]);
2592 tempcond = (num[0] <= num[1]);
2596 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2600 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2604 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2608 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2612 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2616 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2620 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2624 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2628 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2632 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2635 case ECOND_MATCH: /* Regular expression match */
2636 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2640 expand_string_message = string_sprintf("regular expression error in "
2641 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2644 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2647 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2648 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2649 goto MATCHED_SOMETHING;
2651 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2652 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2653 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2654 goto MATCHED_SOMETHING;
2656 case ECOND_MATCH_IP: /* Match IP address in a host list */
2657 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2659 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2665 unsigned int *nullcache = NULL;
2666 check_host_block cb;
2668 cb.host_name = US"";
2669 cb.host_address = sub[0];
2671 /* If the host address starts off ::ffff: it is an IPv6 address in
2672 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2675 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2676 cb.host_address + 7 : cb.host_address;
2678 rc = match_check_list(
2679 &sub[1], /* the list */
2680 0, /* separator character */
2681 &hostlist_anchor, /* anchor pointer */
2682 &nullcache, /* cache pointer */
2683 check_host, /* function for testing */
2684 &cb, /* argument for function */
2685 MCL_HOST, /* type of check */
2686 sub[0], /* text for debugging */
2687 NULL); /* where to pass back data */
2689 goto MATCHED_SOMETHING;
2691 case ECOND_MATCH_LOCAL_PART:
2692 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2693 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2708 expand_string_message = string_sprintf("unable to complete match "
2709 "against \"%s\": %s", sub[1], search_error_message);
2715 /* Various "encrypted" comparisons. If the second string starts with
2716 "{" then an encryption type is given. Default to crypt() or crypt16()
2717 (build-time choice). */
2718 /* }-for-text-editors */
2721 #ifndef SUPPORT_CRYPTEQ
2722 goto COND_FAILED_NOT_COMPILED;
2724 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2726 int sublen = Ustrlen(sub[1]+5);
2731 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2733 /* If the length that we are comparing against is 24, the MD5 digest
2734 is expressed as a base64 string. This is the way LDAP does it. However,
2735 some other software uses a straightforward hex representation. We assume
2736 this if the length is 32. Other lengths fail. */
2740 uschar *coded = b64encode(digest, 16);
2741 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2742 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2743 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2745 else if (sublen == 32)
2748 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2750 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2751 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2752 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2756 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2757 "fail\n crypted=%s\n", sub[1]+5);
2762 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2764 int sublen = Ustrlen(sub[1]+6);
2769 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2771 /* If the length that we are comparing against is 28, assume the SHA1
2772 digest is expressed as a base64 string. If the length is 40, assume a
2773 straightforward hex representation. Other lengths fail. */
2777 uschar *coded = b64encode(digest, 20);
2778 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2779 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2780 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2782 else if (sublen == 40)
2785 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2787 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2788 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2789 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2793 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2794 "fail\n crypted=%s\n", sub[1]+6);
2799 else /* {crypt} or {crypt16} and non-{ at start */
2800 /* }-for-text-editors */
2805 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2810 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2815 else if (sub[1][0] == '{') /* }-for-text-editors */
2817 expand_string_message = string_sprintf("unknown encryption mechanism "
2818 "in \"%s\"", sub[1]);
2824 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2825 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2826 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2830 #define XSTR(s) STR(s)
2831 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2832 " subject=%s\n crypted=%s\n",
2833 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2838 /* If the encrypted string contains fewer than two characters (for the
2839 salt), force failure. Otherwise we get false positives: with an empty
2840 string the yield of crypt() is an empty string! */
2843 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2844 else if (errno == EINVAL)
2848 expand_string_message = string_sprintf("crypt error: %s\n",
2849 US strerror(errno));
2854 #endif /* SUPPORT_CRYPTEQ */
2859 const uschar * list = sub[1];
2861 uschar *save_iterate_item = iterate_item;
2862 int (*compare)(const uschar *, const uschar *);
2864 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", name, sub[0]);
2867 compare = cond_type == ECOND_INLISTI
2868 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2870 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2872 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
2873 if (compare(sub[0], iterate_item) == 0)
2879 iterate_item = save_iterate_item;
2882 } /* Switch for comparison conditions */
2884 *yield = tempcond == testfor;
2885 return s; /* End of comparison conditions */
2888 /* and/or: computes logical and/or of several conditions */
2892 subcondptr = (yield == NULL)? NULL : &tempcond;
2893 combined_cond = (cond_type == ECOND_AND);
2895 while (isspace(*s)) s++;
2896 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2900 while (isspace(*s)) s++;
2901 /* {-for-text-editors */
2902 if (*s == '}') break;
2903 if (*s != '{') /* }-for-text-editors */
2905 expand_string_message = string_sprintf("each subcondition "
2906 "inside an \"%s{...}\" condition must be in its own {}", name);
2910 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2912 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2913 expand_string_message, name);
2916 while (isspace(*s)) s++;
2918 /* {-for-text-editors */
2921 /* {-for-text-editors */
2922 expand_string_message = string_sprintf("missing } at end of condition "
2923 "inside \"%s\" group", name);
2929 if (cond_type == ECOND_AND)
2931 combined_cond &= tempcond;
2932 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2933 } /* evaluate any more */
2936 combined_cond |= tempcond;
2937 if (combined_cond) subcondptr = NULL; /* once true, don't */
2938 } /* evaluate any more */
2942 if (yield != NULL) *yield = (combined_cond == testfor);
2946 /* forall/forany: iterates a condition with different values */
2951 const uschar * list;
2953 uschar *save_iterate_item = iterate_item;
2955 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2957 while (isspace(*s)) s++;
2958 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2959 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2960 if (sub[0] == NULL) return NULL;
2961 /* {-for-text-editors */
2962 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2964 while (isspace(*s)) s++;
2965 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2969 /* Call eval_condition once, with result discarded (as if scanning a
2970 "false" part). This allows us to find the end of the condition, because if
2971 the list it empty, we won't actually evaluate the condition for real. */
2973 if (!(s = eval_condition(sub[1], resetok, NULL)))
2975 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2976 expand_string_message, name);
2979 while (isspace(*s)) s++;
2981 /* {-for-text-editors */
2984 /* {-for-text-editors */
2985 expand_string_message = string_sprintf("missing } at end of condition "
2986 "inside \"%s\"", name);
2990 if (yield != NULL) *yield = !testfor;
2992 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2994 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, iterate_item);
2995 if (!eval_condition(sub[1], resetok, &tempcond))
2997 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2998 expand_string_message, name);
2999 iterate_item = save_iterate_item;
3002 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", name,
3003 tempcond? "true":"false");
3005 if (yield != NULL) *yield = (tempcond == testfor);
3006 if (tempcond == (cond_type == ECOND_FORANY)) break;
3009 iterate_item = save_iterate_item;
3014 /* The bool{} expansion condition maps a string to boolean.
3015 The values supported should match those supported by the ACL condition
3016 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3017 of true/false. Note that Router "condition" rules have a different
3018 interpretation, where general data can be used and only a few values
3020 Note that readconf.c boolean matching, for boolean configuration options,
3021 only matches true/yes/false/no.
3022 The bool_lax{} condition matches the Router logic, which is much more
3025 case ECOND_BOOL_LAX:
3031 BOOL boolvalue = FALSE;
3032 while (isspace(*s)) s++;
3033 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3034 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3035 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3037 case 1: expand_string_message = string_sprintf(
3038 "too few arguments or bracketing error for %s",
3042 case 3: return NULL;
3045 while (isspace(*t)) t++;
3049 /* trailing whitespace: seems like a good idea to ignore it too */
3051 while (isspace(*t2)) t2--;
3052 if (t2 != (t + len))
3059 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3060 /* logic for the lax case from expand_check_condition(), which also does
3061 expands, and the logic is both short and stable enough that there should
3062 be no maintenance burden from replicating it. */
3066 ? Ustrspn(t+1, "0123456789") == len-1
3067 : Ustrspn(t, "0123456789") == len)
3069 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3070 /* expand_check_condition only does a literal string "0" check */
3071 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3074 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3076 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3078 else if (cond_type == ECOND_BOOL_LAX)
3082 expand_string_message = string_sprintf("unrecognised boolean "
3086 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3087 boolvalue? "true":"false");
3088 if (yield != NULL) *yield = (boolvalue == testfor);
3092 /* Unknown condition */
3095 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3097 } /* End switch on condition type */
3099 /* Missing braces at start and end of data */
3101 COND_FAILED_CURLY_START:
3102 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3105 COND_FAILED_CURLY_END:
3106 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3110 /* A condition requires code that is not compiled */
3112 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3113 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3114 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3115 COND_FAILED_NOT_COMPILED:
3116 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3125 /*************************************************
3126 * Save numerical variables *
3127 *************************************************/
3129 /* This function is called from items such as "if" that want to preserve and
3130 restore the numbered variables.
3133 save_expand_string points to an array of pointers to set
3134 save_expand_nlength points to an array of ints for the lengths
3136 Returns: the value of expand max to save
3140 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3142 for (int i = 0; i <= expand_nmax; i++)
3144 save_expand_nstring[i] = expand_nstring[i];
3145 save_expand_nlength[i] = expand_nlength[i];
3152 /*************************************************
3153 * Restore numerical variables *
3154 *************************************************/
3156 /* This function restored saved values of numerical strings.
3159 save_expand_nmax the number of strings to restore
3160 save_expand_string points to an array of pointers
3161 save_expand_nlength points to an array of ints
3167 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3168 int *save_expand_nlength)
3170 expand_nmax = save_expand_nmax;
3171 for (int i = 0; i <= expand_nmax; i++)
3173 expand_nstring[i] = save_expand_nstring[i];
3174 expand_nlength[i] = save_expand_nlength[i];
3182 /*************************************************
3183 * Handle yes/no substrings *
3184 *************************************************/
3186 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3187 alternative substrings that depend on whether or not the condition was true,
3188 or the lookup or extraction succeeded. The substrings always have to be
3189 expanded, to check their syntax, but "skipping" is set when the result is not
3190 needed - this avoids unnecessary nested lookups.
3193 skipping TRUE if we were skipping when this item was reached
3194 yes TRUE if the first string is to be used, else use the second
3195 save_lookup a value to put back into lookup_value before the 2nd expansion
3196 sptr points to the input string pointer
3197 yieldptr points to the output growable-string pointer
3198 type "lookup", "if", "extract", "run", "env", "listextract" or
3199 "certextract" for error message
3200 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3203 Returns: 0 OK; lookup_value has been reset to save_lookup
3205 2 expansion failed because of bracketing error
3209 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3210 gstring ** yieldptr, uschar *type, BOOL *resetok)
3213 const uschar *s = *sptr; /* Local value */
3214 uschar *sub1, *sub2;
3215 const uschar * errwhere;
3217 /* If there are no following strings, we substitute the contents of $value for
3218 lookups and for extractions in the success case. For the ${if item, the string
3219 "true" is substituted. In the fail case, nothing is substituted for all three
3222 while (isspace(*s)) s++;
3227 if (yes && !skipping)
3228 *yieldptr = string_catn(*yieldptr, US"true", 4);
3232 if (yes && lookup_value && !skipping)
3233 *yieldptr = string_cat(*yieldptr, lookup_value);
3234 lookup_value = save_lookup;
3240 /* The first following string must be braced. */
3244 errwhere = US"'yes' part did not start with '{'";
3248 /* Expand the first substring. Forced failures are noticed only if we actually
3249 want this string. Set skipping in the call in the fail case (this will always
3250 be the case if we were already skipping). */
3252 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3253 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3254 f.expand_string_forcedfail = FALSE;
3257 errwhere = US"'yes' part did not end with '}'";
3261 /* If we want the first string, add it to the output */
3264 *yieldptr = string_cat(*yieldptr, sub1);
3266 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3267 $value to what it was at the start of the item, so that it has this value
3268 during the second string expansion. For the call from "if" or "run" to this
3269 function, save_lookup is set to lookup_value, so that this statement does
3272 lookup_value = save_lookup;
3274 /* There now follows either another substring, or "fail", or nothing. This
3275 time, forced failures are noticed only if we want the second string. We must
3276 set skipping in the nested call if we don't want this string, or if we were
3277 already skipping. */
3279 while (isspace(*s)) s++;
3282 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3283 if (sub2 == NULL && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3284 f.expand_string_forcedfail = FALSE;
3287 errwhere = US"'no' part did not start with '{'";
3291 /* If we want the second string, add it to the output */
3294 *yieldptr = string_cat(*yieldptr, sub2);
3297 /* If there is no second string, but the word "fail" is present when the use of
3298 the second string is wanted, set a flag indicating it was a forced failure
3299 rather than a syntactic error. Swallow the terminating } in case this is nested
3300 inside another lookup or if or extract. */
3305 /* deconst cast ok here as source is s anyway */
3306 s = US read_name(name, sizeof(name), s, US"_");
3307 if (Ustrcmp(name, "fail") == 0)
3309 if (!yes && !skipping)
3311 while (isspace(*s)) s++;
3314 errwhere = US"did not close with '}' after forcedfail";
3317 expand_string_message =
3318 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3319 f.expand_string_forcedfail = TRUE;
3325 expand_string_message =
3326 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3331 /* All we have to do now is to check on the final closing brace. */
3333 while (isspace(*s)) s++;
3336 errwhere = US"did not close with '}'";
3342 /* Update the input pointer value before returning */
3347 /* Get here if there is a bracketing failure */
3348 expand_string_message = string_sprintf(
3349 "curly-bracket problem in conditional yes/no parsing: %s\n"
3350 " remaining string is '%s'", errwhere, --s);
3355 /* Get here for other failures */
3363 /*************************************************
3364 * Handle MD5 or SHA-1 computation for HMAC *
3365 *************************************************/
3367 /* These are some wrapping functions that enable the HMAC code to be a bit
3368 cleaner. A good compiler will spot the tail recursion.
3371 type HMAC_MD5 or HMAC_SHA1
3372 remaining are as for the cryptographic hash functions
3378 chash_start(int type, void *base)
3380 if (type == HMAC_MD5)
3381 md5_start((md5 *)base);
3383 sha1_start((hctx *)base);
3387 chash_mid(int type, void *base, uschar *string)
3389 if (type == HMAC_MD5)
3390 md5_mid((md5 *)base, string);
3392 sha1_mid((hctx *)base, string);
3396 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3398 if (type == HMAC_MD5)
3399 md5_end((md5 *)base, string, length, digest);
3401 sha1_end((hctx *)base, string, length, digest);
3408 /********************************************************
3409 * prvs: Get last three digits of days since Jan 1, 1970 *
3410 ********************************************************/
3412 /* This is needed to implement the "prvs" BATV reverse
3415 Argument: integer "days" offset to add or substract to
3416 or from the current number of days.
3418 Returns: pointer to string containing the last three
3419 digits of the number of days since Jan 1, 1970,
3420 modified by the offset argument, NULL if there
3421 was an error in the conversion.
3426 prvs_daystamp(int day_offset)
3428 uschar *days = store_get(32); /* Need at least 24 for cases */
3429 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3430 (time(NULL) + day_offset*86400)/86400);
3431 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3436 /********************************************************
3437 * prvs: perform HMAC-SHA1 computation of prvs bits *
3438 ********************************************************/
3440 /* This is needed to implement the "prvs" BATV reverse
3444 address RFC2821 Address to use
3445 key The key to use (must be less than 64 characters
3447 key_num Single-digit key number to use. Defaults to
3450 Returns: pointer to string containing the first three
3451 bytes of the final hash in hex format, NULL if
3452 there was an error in the process.
3456 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3458 gstring * hash_source;
3461 uschar innerhash[20];
3462 uschar finalhash[20];
3463 uschar innerkey[64];
3464 uschar outerkey[64];
3465 uschar *finalhash_hex = store_get(40);
3467 if (key_num == NULL)
3470 if (Ustrlen(key) > 64)
3473 hash_source = string_catn(NULL, key_num, 1);
3474 hash_source = string_catn(hash_source, daystamp, 3);
3475 hash_source = string_cat(hash_source, address);
3476 (void) string_from_gstring(hash_source);
3479 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3481 memset(innerkey, 0x36, 64);
3482 memset(outerkey, 0x5c, 64);
3484 for (int i = 0; i < Ustrlen(key); i++)
3486 innerkey[i] ^= key[i];
3487 outerkey[i] ^= key[i];
3490 chash_start(HMAC_SHA1, &h);
3491 chash_mid(HMAC_SHA1, &h, innerkey);
3492 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3494 chash_start(HMAC_SHA1, &h);
3495 chash_mid(HMAC_SHA1, &h, outerkey);
3496 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3499 for (int i = 0; i < 3; i++)
3501 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3502 *p++ = hex_digits[finalhash[i] & 0x0f];
3506 return finalhash_hex;
3512 /*************************************************
3513 * Join a file onto the output string *
3514 *************************************************/
3516 /* This is used for readfile/readsock and after a run expansion.
3517 It joins the contents of a file onto the output string, globally replacing
3518 newlines with a given string (optionally).
3522 yield pointer to the expandable string struct
3523 eol newline replacement string, or NULL
3525 Returns: new pointer for expandable string, terminated if non-null
3529 cat_file(FILE *f, gstring *yield, uschar *eol)
3531 uschar buffer[1024];
3533 while (Ufgets(buffer, sizeof(buffer), f))
3535 int len = Ustrlen(buffer);
3536 if (eol && buffer[len-1] == '\n') len--;
3537 yield = string_catn(yield, buffer, len);
3538 if (eol && buffer[len])
3539 yield = string_cat(yield, eol);
3542 (void) string_from_gstring(yield);
3549 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
3552 uschar buffer[1024];
3554 /*XXX could we read direct into a pre-grown string? */
3556 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
3557 for (uschar * s = buffer; rc--; s++)
3558 yield = eol && *s == '\n'
3559 ? string_cat(yield, eol) : string_catn(yield, s, 1);
3561 /* We assume that all errors, and any returns of zero bytes,
3562 are actually EOF. */
3564 (void) string_from_gstring(yield);
3570 /*************************************************
3571 * Evaluate numeric expression *
3572 *************************************************/
3574 /* This is a set of mutually recursive functions that evaluate an arithmetic
3575 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3576 these functions that is called from elsewhere is eval_expr, whose interface is:
3579 sptr pointer to the pointer to the string - gets updated
3580 decimal TRUE if numbers are to be assumed decimal
3581 error pointer to where to put an error message - must be NULL on input
3582 endket TRUE if ')' must terminate - FALSE for external call
3584 Returns: on success: the value of the expression, with *error still NULL
3585 on failure: an undefined value, with *error = a message
3588 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3591 static int_eximarith_t
3592 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3595 int_eximarith_t x = eval_op_or(&s, decimal, error);
3601 *error = US"expecting closing parenthesis";
3603 while (isspace(*(++s)));
3605 else if (*s != 0) *error = US"expecting operator";
3612 static int_eximarith_t
3613 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3618 while (isspace(*s)) s++;
3623 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3625 switch (tolower(*s))
3628 case 'k': n *= 1024; s++; break;
3629 case 'm': n *= 1024*1024; s++; break;
3630 case 'g': n *= 1024*1024*1024; s++; break;
3632 while (isspace (*s)) s++;
3637 n = eval_expr(&s, decimal, error, 1);
3641 *error = US"expecting number or opening parenthesis";
3649 static int_eximarith_t
3650 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3654 while (isspace(*s)) s++;
3655 if (*s == '+' || *s == '-' || *s == '~')
3658 x = eval_op_unary(&s, decimal, error);
3659 if (op == '-') x = -x;
3660 else if (op == '~') x = ~x;
3664 x = eval_number(&s, decimal, error);
3671 static int_eximarith_t
3672 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3675 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3678 while (*s == '*' || *s == '/' || *s == '%')
3681 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3682 if (*error != NULL) break;
3683 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3684 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3685 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3686 * -N*M is INT_MIN will yield INT_MIN.
3687 * Since we don't support floating point, this is somewhat simpler.
3688 * Ideally, we'd return an error, but since we overflow for all other
3689 * arithmetic, consistency suggests otherwise, but what's the correct value
3690 * to use? There is none.
3691 * The C standard guarantees overflow for unsigned arithmetic but signed
3692 * overflow invokes undefined behaviour; in practice, this is overflow
3693 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3694 * that long/longlong larger than int are available, or we could just work
3695 * with larger types. We should consider whether to guarantee 32bit eval
3696 * and 64-bit working variables, with errors returned. For now ...
3697 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3698 * can just let the other invalid results occur otherwise, as they have
3699 * until now. For this one case, we can coerce.
3701 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3704 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3705 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3715 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3731 static int_eximarith_t
3732 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3735 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3738 while (*s == '+' || *s == '-')
3741 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3743 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3744 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3745 { /* over-conservative check */
3747 ? US"overflow in sum" : US"overflow in difference";
3750 if (op == '+') x += y; else x -= y;
3758 static int_eximarith_t
3759 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3762 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3765 while ((*s == '<' || *s == '>') && s[1] == s[0])
3770 y = eval_op_sum(&s, decimal, error);
3771 if (*error != NULL) break;
3772 if (op == '<') x <<= y; else x >>= y;
3780 static int_eximarith_t
3781 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3784 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3791 y = eval_op_shift(&s, decimal, error);
3792 if (*error != NULL) break;
3801 static int_eximarith_t
3802 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3805 int_eximarith_t x = eval_op_and(&s, decimal, error);
3812 y = eval_op_and(&s, decimal, error);
3813 if (*error != NULL) break;
3822 static int_eximarith_t
3823 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3826 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3833 y = eval_op_xor(&s, decimal, error);
3834 if (*error != NULL) break;
3844 /* Return pointer to dewrapped string, with enclosing specified chars removed.
3845 The given string is modified on return. Leading whitespace is skipped while
3846 looking for the opening wrap character, then the rest is scanned for the trailing
3847 (non-escaped) wrap character. A backslash in the string will act as an escape.
3849 A nul is written over the trailing wrap, and a pointer to the char after the
3850 leading wrap is returned.
3853 s String for de-wrapping
3854 wrap Two-char string, the first being the opener, second the closer wrapping
3857 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
3861 dewrap(uschar * s, const uschar * wrap)
3865 BOOL quotesmode = wrap[0] == wrap[1];
3867 while (isspace(*p)) p++;
3875 if (*p == '\\') p++;
3876 else if (!quotesmode && *p == wrap[-1]) depth++;
3877 else if (*p == *wrap)
3888 expand_string_message = string_sprintf("missing '%c'", *wrap);
3893 /* Pull off the leading array or object element, returning
3894 a copy in an allocated string. Update the list pointer.
3896 The element may itself be an abject or array.
3900 json_nextinlist(const uschar ** list)
3902 unsigned array_depth = 0, object_depth = 0;
3903 const uschar * s = *list, * item;
3905 while (isspace(*s)) s++;
3908 *s && (*s != ',' || array_depth != 0 || object_depth != 0);
3912 case '[': array_depth++; break;
3913 case ']': array_depth--; break;
3914 case '{': object_depth++; break;
3915 case '}': object_depth--; break;
3917 *list = *s ? s+1 : s;
3918 item = string_copyn(item, s - item);
3919 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);
3925 /*************************************************
3927 *************************************************/
3929 /* Returns either an unchanged string, or the expanded string in stacking pool
3930 store. Interpreted sequences are:
3932 \... normal escaping rules
3933 $name substitutes the variable
3935 ${op:string} operates on the expanded string value
3936 ${item{arg1}{arg2}...} expands the args and then does the business
3937 some literal args are not enclosed in {}
3939 There are now far too many operators and item types to make it worth listing
3940 them here in detail any more.
3942 We use an internal routine recursively to handle embedded substrings. The
3943 external function follows. The yield is NULL if the expansion failed, and there
3944 are two cases: if something collapsed syntactically, or if "fail" was given
3945 as the action on a lookup failure. These can be distinguished by looking at the
3946 variable expand_string_forcedfail, which is TRUE in the latter case.
3948 The skipping flag is set true when expanding a substring that isn't actually
3949 going to be used (after "if" or "lookup") and it prevents lookups from
3950 happening lower down.
3952 Store usage: At start, a store block of the length of the input plus 64
3953 is obtained. This is expanded as necessary by string_cat(), which might have to
3954 get a new block, or might be able to expand the original. At the end of the
3955 function we can release any store above that portion of the yield block that
3956 was actually used. In many cases this will be optimal.
3958 However: if the first item in the expansion is a variable name or header name,
3959 we reset the store before processing it; if the result is in fresh store, we
3960 use that without copying. This is helpful for expanding strings like
3961 $message_headers which can get very long.
3963 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3964 since resetting the store at the end of the expansion will free store that was
3965 allocated by the plugin code as well as the slop after the expanded string. So
3966 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3967 and, given the acl condition, ${if }. This is an unfortunate consequence of
3968 string expansion becoming too powerful.
3971 string the string to be expanded
3972 ket_ends true if expansion is to stop at }
3973 left if not NULL, a pointer to the first character after the
3974 expansion is placed here (typically used with ket_ends)
3975 skipping TRUE for recursive calls when the value isn't actually going
3976 to be used (to allow for optimisation)
3977 honour_dollar TRUE if $ is to be expanded,
3978 FALSE if it's just another character
3979 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3982 Returns: NULL if expansion fails:
3983 expand_string_forcedfail is set TRUE if failure was forced
3984 expand_string_message contains a textual error message
3985 a pointer to the expanded string on success
3989 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3990 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3992 gstring * yield = string_get(Ustrlen(string) + 64);
3994 const uschar *s = string;
3995 uschar *save_expand_nstring[EXPAND_MAXN+1];
3996 int save_expand_nlength[EXPAND_MAXN+1];
3997 BOOL resetok = TRUE;
4002 debug_printf_indent("/%s: %s\n",
4003 skipping ? "---scanning" : "considering", string);
4005 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
4007 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4011 f.expand_string_forcedfail = FALSE;
4012 expand_string_message = US"";
4019 /* \ escapes the next character, which must exist, or else
4020 the expansion fails. There's a special escape, \N, which causes
4021 copying of the subject verbatim up to the next \N. Otherwise,
4022 the escapes are the standard set. */
4028 expand_string_message = US"\\ at end of string";
4034 const uschar * t = s + 2;
4035 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
4036 yield = string_catn(yield, t, s - t);
4037 if (*s != 0) s += 2;
4043 ch[0] = string_interpret_escape(&s);
4045 yield = string_catn(yield, ch, 1);
4052 /* Anything other than $ is just copied verbatim, unless we are
4053 looking for a terminating } character. */
4056 if (ket_ends && *s == '}') break;
4058 if (*s != '$' || !honour_dollar)
4060 yield = string_catn(yield, s++, 1);
4064 /* No { after the $ - must be a plain name or a number for string
4065 match variable. There has to be a fudge for variables that are the
4066 names of header fields preceded by "$header_" because header field
4067 names can contain any printing characters except space and colon.
4068 For those that don't like typing this much, "$h_" is a synonym for
4069 "$header_". A non-existent header yields a NULL value; nothing is
4072 if (isalpha((*(++s))))
4079 s = read_name(name, sizeof(name), s, US"_");
4081 /* If this is the first thing to be expanded, release the pre-allocated
4085 g = store_get(sizeof(gstring));
4086 else if (yield->ptr == 0)
4088 if (resetok) store_reset(yield);
4090 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
4095 if ( ( *(t = name) == 'h'
4096 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4098 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4101 unsigned flags = *name == 'r' ? FH_WANT_RAW
4102 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4104 uschar * charset = *name == 'b' ? NULL : headers_charset;
4106 s = read_header_name(name, sizeof(name), s);
4107 value = find_header(name, &newsize, flags, charset);
4109 /* If we didn't find the header, and the header contains a closing brace
4110 character, this may be a user error where the terminating colon
4111 has been omitted. Set a flag to adjust the error message in this case.
4112 But there is no error here - nothing gets inserted. */
4116 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
4123 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4125 expand_string_message =
4126 string_sprintf("unknown variable name \"%s\"", name);
4127 check_variable_error_message(name);
4131 /* If the data is known to be in a new buffer, newsize will be set to the
4132 size of that buffer. If this is the first thing in an expansion string,
4133 yield will be NULL; just point it at the new store instead of copying. Many
4134 expansion strings contain just one reference, so this is a useful
4135 optimization, especially for humungous headers. We need to use a gstring
4136 structure that is not allocated after that new-buffer, else a later store
4137 reset in the middle of the buffer will make it inaccessible. */
4139 len = Ustrlen(value);
4140 if (!yield && newsize != 0)
4143 yield->size = newsize;
4148 yield = string_catn(yield, value, len);
4156 s = read_cnumber(&n, s);
4157 if (n >= 0 && n <= expand_nmax)
4158 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4162 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4164 if (*s != '{') /*}*/
4166 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4170 /* After { there can be various things, but they all start with
4171 an initial word, except for a number for a string match variable. */
4173 if (isdigit((*(++s))))
4176 s = read_cnumber(&n, s); /*{*/
4179 expand_string_message = US"} expected after number";
4182 if (n >= 0 && n <= expand_nmax)
4183 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4189 expand_string_message = US"letter or digit expected after ${"; /*}*/
4193 /* Allow "-" in names to cater for substrings with negative
4194 arguments. Since we are checking for known names after { this is
4197 s = read_name(name, sizeof(name), s, US"_-");
4198 item_type = chop_match(name, item_table, nelem(item_table));
4202 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4203 If the ACL returns accept or reject we return content set by "message ="
4204 There is currently no limit on recursion; this would have us call
4205 acl_check_internal() directly and get a current level from somewhere.
4206 See also the acl expansion condition ECOND_ACL and the traditional
4207 acl modifier ACLC_ACL.
4208 Assume that the function has side-effects on the store that must be preserved.
4212 /* ${acl {name} {arg1}{arg2}...} */
4214 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4217 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4220 case 1: goto EXPAND_FAILED_CURLY;
4222 case 3: goto EXPAND_FAILED;
4224 if (skipping) continue;
4227 switch(eval_acl(sub, nelem(sub), &user_msg))
4232 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4234 yield = string_cat(yield, user_msg);
4238 f.expand_string_forcedfail = TRUE;
4241 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4246 case EITEM_AUTHRESULTS:
4247 /* ${authresults {mysystemname}} */
4251 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4254 case 1: goto EXPAND_FAILED_CURLY;
4256 case 3: goto EXPAND_FAILED;
4259 yield = string_append(yield, 3,
4260 US"Authentication-Results: ", sub_arg[0], US"; none");
4263 yield = authres_local(yield, sub_arg[0]);
4264 yield = authres_iprev(yield);
4265 yield = authres_smtpauth(yield);
4267 yield = authres_spf(yield);
4269 #ifndef DISABLE_DKIM
4270 yield = authres_dkim(yield);
4272 #ifdef EXPERIMENTAL_DMARC
4273 yield = authres_dmarc(yield);
4275 #ifdef EXPERIMENTAL_ARC
4276 yield = authres_arc(yield);
4281 /* Handle conditionals - preserve the values of the numerical expansion
4282 variables in case they get changed by a regular expression match in the
4283 condition. If not, they retain their external settings. At the end
4284 of this "if" section, they get restored to their previous values. */
4289 const uschar *next_s;
4290 int save_expand_nmax =
4291 save_expand_strings(save_expand_nstring, save_expand_nlength);
4293 while (isspace(*s)) s++;
4294 next_s = eval_condition(s, &resetok, skipping ? NULL : &cond);
4295 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4300 debug_printf_indent("|--condition: %.*s\n", (int)(next_s - s), s);
4301 debug_printf_indent("|-----result: %s\n", cond ? "true" : "false");
4305 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4306 "condition: %.*s\n",
4307 (int)(next_s - s), s);
4308 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4309 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4311 cond ? "true" : "false");
4316 /* The handling of "yes" and "no" result strings is now in a separate
4317 function that is also used by ${lookup} and ${extract} and ${run}. */
4319 switch(process_yesno(
4320 skipping, /* were previously skipping */
4321 cond, /* success/failure indicator */
4322 lookup_value, /* value to reset for string2 */
4323 &s, /* input pointer */
4324 &yield, /* output pointer */
4325 US"if", /* condition type */
4328 case 1: goto EXPAND_FAILED; /* when all is well, the */
4329 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4332 /* Restore external setting of expansion variables for continuation
4335 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4336 save_expand_nlength);
4341 case EITEM_IMAPFOLDER:
4342 { /* ${imapfolder {name}{sep]{specials}} */
4346 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4349 case 1: goto EXPAND_FAILED_CURLY;
4351 case 3: goto EXPAND_FAILED;
4354 if (sub_arg[1] == NULL) /* One argument */
4356 sub_arg[1] = US"/"; /* default separator */
4359 else if (Ustrlen(sub_arg[1]) != 1)
4361 expand_string_message =
4363 "IMAP folder separator must be one character, found \"%s\"",
4370 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4371 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4373 yield = string_cat(yield, encoded);
4379 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4380 expanding an internal string that isn't actually going to be used. All we
4381 need to do is check the syntax, so don't do a lookup at all. Preserve the
4382 values of the numerical expansion variables in case they get changed by a
4383 partial lookup. If not, they retain their external settings. At the end
4384 of this "lookup" section, they get restored to their previous values. */
4388 int stype, partial, affixlen, starflags;
4389 int expand_setup = 0;
4391 uschar *key, *filename;
4392 const uschar *affix;
4393 uschar *save_lookup_value = lookup_value;
4394 int save_expand_nmax =
4395 save_expand_strings(save_expand_nstring, save_expand_nlength);
4397 if ((expand_forbid & RDO_LOOKUP) != 0)
4399 expand_string_message = US"lookup expansions are not permitted";
4403 /* Get the key we are to look up for single-key+file style lookups.
4404 Otherwise set the key NULL pro-tem. */
4406 while (isspace(*s)) s++;
4407 if (*s == '{') /*}*/
4409 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4410 if (!key) goto EXPAND_FAILED; /*{{*/
4413 expand_string_message = US"missing '}' after lookup key";
4414 goto EXPAND_FAILED_CURLY;
4416 while (isspace(*s)) s++;
4420 /* Find out the type of database */
4424 expand_string_message = US"missing lookup type";
4428 /* The type is a string that may contain special characters of various
4429 kinds. Allow everything except space or { to appear; the actual content
4430 is checked by search_findtype_partial. */ /*}*/
4432 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4434 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4438 while (isspace(*s)) s++;
4440 /* Now check for the individual search type and any partial or default
4441 options. Only those types that are actually in the binary are valid. */
4443 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4447 expand_string_message = search_error_message;
4451 /* Check that a key was provided for those lookup types that need it,
4452 and was not supplied for those that use the query style. */
4454 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4458 expand_string_message = string_sprintf("missing {key} for single-"
4459 "key \"%s\" lookup", name);
4467 expand_string_message = string_sprintf("a single key was given for "
4468 "lookup type \"%s\", which is not a single-key lookup type", name);
4473 /* Get the next string in brackets and expand it. It is the file name for
4474 single-key+file lookups, and the whole query otherwise. In the case of
4475 queries that also require a file name (e.g. sqlite), the file name comes
4480 expand_string_message = US"missing '{' for lookup file-or-query arg";
4481 goto EXPAND_FAILED_CURLY;
4483 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4484 if (filename == NULL) goto EXPAND_FAILED;
4487 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4488 goto EXPAND_FAILED_CURLY;
4490 while (isspace(*s)) s++;
4492 /* If this isn't a single-key+file lookup, re-arrange the variables
4493 to be appropriate for the search_ functions. For query-style lookups,
4494 there is just a "key", and no file name. For the special query-style +
4495 file types, the query (i.e. "key") starts with a file name. */
4499 while (isspace(*filename)) filename++;
4502 if (mac_islookup(stype, lookup_querystyle))
4506 if (*filename != '/')
4508 expand_string_message = string_sprintf(
4509 "absolute file name expected for \"%s\" lookup", name);
4512 while (*key != 0 && !isspace(*key)) key++;
4513 if (*key != 0) *key++ = 0;
4517 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4518 the entry was not found. Note that there is no search_close() function.
4519 Files are left open in case of re-use. At suitable places in higher logic,
4520 search_tidyup() is called to tidy all open files. This can save opening
4521 the same file several times. However, files may also get closed when
4522 others are opened, if too many are open at once. The rule is that a
4523 handle should not be used after a second search_open().
4525 Request that a partial search sets up $1 and maybe $2 by passing
4526 expand_setup containing zero. If its value changes, reset expand_nmax,
4527 since new variables will have been set. Note that at the end of this
4528 "lookup" section, the old numeric variables are restored. */
4531 lookup_value = NULL;
4534 void *handle = search_open(filename, stype, 0, NULL, NULL);
4537 expand_string_message = search_error_message;
4540 lookup_value = search_find(handle, filename, key, partial, affix,
4541 affixlen, starflags, &expand_setup);
4542 if (f.search_find_defer)
4544 expand_string_message =
4545 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4546 string_printing2(key, FALSE), search_error_message);
4549 if (expand_setup > 0) expand_nmax = expand_setup;
4552 /* The handling of "yes" and "no" result strings is now in a separate
4553 function that is also used by ${if} and ${extract}. */
4555 switch(process_yesno(
4556 skipping, /* were previously skipping */
4557 lookup_value != NULL, /* success/failure indicator */
4558 save_lookup_value, /* value to reset for string2 */
4559 &s, /* input pointer */
4560 &yield, /* output pointer */
4561 US"lookup", /* condition type */
4564 case 1: goto EXPAND_FAILED; /* when all is well, the */
4565 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4568 /* Restore external setting of expansion variables for carrying on
4569 at this level, and continue. */
4571 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4572 save_expand_nlength);
4576 /* If Perl support is configured, handle calling embedded perl subroutines,
4577 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4578 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4579 arguments (defined below). */
4581 #define EXIM_PERL_MAX_ARGS 8
4585 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4586 "is not included in this binary";
4589 #else /* EXIM_PERL */
4591 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4594 if ((expand_forbid & RDO_PERL) != 0)
4596 expand_string_message = US"Perl calls are not permitted";
4600 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4601 US"perl", &resetok))
4603 case 1: goto EXPAND_FAILED_CURLY;
4605 case 3: goto EXPAND_FAILED;
4608 /* If skipping, we don't actually do anything */
4610 if (skipping) continue;
4612 /* Start the interpreter if necessary */
4614 if (!opt_perl_started)
4617 if (opt_perl_startup == NULL)
4619 expand_string_message = US"A setting of perl_startup is needed when "
4620 "using the Perl interpreter";
4623 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4624 initerror = init_perl(opt_perl_startup);
4625 if (initerror != NULL)
4627 expand_string_message =
4628 string_sprintf("error in perl_startup code: %s\n", initerror);
4631 opt_perl_started = TRUE;
4634 /* Call the function */
4636 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4637 new_yield = call_perl_cat(yield, &expand_string_message,
4638 sub_arg[0], sub_arg + 1);
4640 /* NULL yield indicates failure; if the message pointer has been set to
4641 NULL, the yield was undef, indicating a forced failure. Otherwise the
4642 message will indicate some kind of Perl error. */
4644 if (new_yield == NULL)
4646 if (expand_string_message == NULL)
4648 expand_string_message =
4649 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4650 "failure", sub_arg[0]);
4651 f.expand_string_forcedfail = TRUE;
4656 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4657 set during a callback from Perl. */
4659 f.expand_string_forcedfail = FALSE;
4663 #endif /* EXIM_PERL */
4665 /* Transform email address to "prvs" scheme to use
4666 as BATV-signed return path */
4673 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4675 case 1: goto EXPAND_FAILED_CURLY;
4677 case 3: goto EXPAND_FAILED;
4680 /* If skipping, we don't actually do anything */
4681 if (skipping) continue;
4683 /* sub_arg[0] is the address */
4684 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
4685 || domain == sub_arg[0] || Ustrlen(domain) == 1)
4687 expand_string_message = US"prvs first argument must be a qualified email address";
4691 /* Calculate the hash. The third argument must be a single-digit
4692 key number, or unset. */
4695 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4697 expand_string_message = US"prvs third argument must be a single digit";
4701 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
4704 expand_string_message = US"prvs hmac-sha1 conversion failed";
4708 /* Now separate the domain from the local part */
4711 yield = string_catn(yield, US"prvs=", 5);
4712 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
4713 yield = string_catn(yield, prvs_daystamp(7), 3);
4714 yield = string_catn(yield, p, 6);
4715 yield = string_catn(yield, US"=", 1);
4716 yield = string_cat (yield, sub_arg[0]);
4717 yield = string_catn(yield, US"@", 1);
4718 yield = string_cat (yield, domain);
4723 /* Check a prvs-encoded address for validity */
4725 case EITEM_PRVSCHECK:
4732 /* TF: Ugliness: We want to expand parameter 1 first, then set
4733 up expansion variables that are used in the expansion of
4734 parameter 2. So we clone the string for the first
4735 expansion, where we only expand parameter 1.
4737 PH: Actually, that isn't necessary. The read_subs() function is
4738 designed to work this way for the ${if and ${lookup expansions. I've
4742 /* Reset expansion variables */
4743 prvscheck_result = NULL;
4744 prvscheck_address = NULL;
4745 prvscheck_keynum = NULL;
4747 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4749 case 1: goto EXPAND_FAILED_CURLY;
4751 case 3: goto EXPAND_FAILED;
4754 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4757 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4759 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4760 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4761 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4762 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4763 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4765 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
4766 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
4767 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
4768 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
4769 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
4771 /* Set up expansion variables */
4772 g = string_cat (NULL, local_part);
4773 g = string_catn(g, US"@", 1);
4774 g = string_cat (g, domain);
4775 prvscheck_address = string_from_gstring(g);
4776 prvscheck_keynum = string_copy(key_num);
4778 /* Now expand the second argument */
4779 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4781 case 1: goto EXPAND_FAILED_CURLY;
4783 case 3: goto EXPAND_FAILED;
4786 /* Now we have the key and can check the address. */
4788 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4793 expand_string_message = US"hmac-sha1 conversion failed";
4797 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
4798 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
4800 if (Ustrcmp(p,hash) == 0)
4802 /* Success, valid BATV address. Now check the expiry date. */
4803 uschar *now = prvs_daystamp(0);
4804 unsigned int inow = 0,iexpire = 1;
4806 (void)sscanf(CS now,"%u",&inow);
4807 (void)sscanf(CS daystamp,"%u",&iexpire);
4809 /* When "iexpire" is < 7, a "flip" has occurred.
4810 Adjust "inow" accordingly. */
4811 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4813 if (iexpire >= inow)
4815 prvscheck_result = US"1";
4816 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
4820 prvscheck_result = NULL;
4821 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
4826 prvscheck_result = NULL;
4827 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
4830 /* Now expand the final argument. We leave this till now so that
4831 it can include $prvscheck_result. */
4833 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4835 case 1: goto EXPAND_FAILED_CURLY;
4837 case 3: goto EXPAND_FAILED;
4840 yield = string_cat(yield,
4841 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4843 /* Reset the "internal" variables afterwards, because they are in
4844 dynamic store that will be reclaimed if the expansion succeeded. */
4846 prvscheck_address = NULL;
4847 prvscheck_keynum = NULL;
4850 /* Does not look like a prvs encoded address, return the empty string.
4851 We need to make sure all subs are expanded first, so as to skip over
4854 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4856 case 1: goto EXPAND_FAILED_CURLY;
4858 case 3: goto EXPAND_FAILED;
4864 /* Handle "readfile" to insert an entire file */
4866 case EITEM_READFILE:
4871 if ((expand_forbid & RDO_READFILE) != 0)
4873 expand_string_message = US"file insertions are not permitted";
4877 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4879 case 1: goto EXPAND_FAILED_CURLY;
4881 case 3: goto EXPAND_FAILED;
4884 /* If skipping, we don't actually do anything */
4886 if (skipping) continue;
4888 /* Open the file and read it */
4890 if (!(f = Ufopen(sub_arg[0], "rb")))
4892 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4896 yield = cat_file(f, yield, sub_arg[1]);
4901 /* Handle "readsocket" to insert data from a socket, either
4902 Inet or Unix domain */
4904 case EITEM_READSOCK:
4908 int save_ptr = yield->ptr;
4911 uschar * sub_arg[4];
4912 uschar * server_name = NULL;
4914 BOOL do_shutdown = TRUE;
4915 BOOL do_tls = FALSE; /* Only set under SUPPORT_TLS */
4916 void * tls_ctx = NULL; /* ditto */
4919 if (expand_forbid & RDO_READSOCK)
4921 expand_string_message = US"socket insertions are not permitted";
4925 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4926 because there may be a string for expansion on failure. */
4928 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4930 case 1: goto EXPAND_FAILED_CURLY;
4931 case 2: /* Won't occur: no end check */
4932 case 3: goto EXPAND_FAILED;
4935 /* Grab the request string, if any */
4937 reqstr.data = sub_arg[1];
4938 reqstr.len = Ustrlen(sub_arg[1]);
4940 /* Sort out timeout, if given. The second arg is a list with the first element
4941 being a time value. Any more are options of form "name=value". Currently the
4942 only option recognised is "shutdown". */
4946 const uschar * list = sub_arg[2];
4950 item = string_nextinlist(&list, &sep, NULL, 0);
4951 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
4953 expand_string_message = string_sprintf("bad time value %s", item);
4957 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
4958 if (Ustrncmp(item, US"shutdown=", 9) == 0)
4959 { if (Ustrcmp(item + 9, US"no") == 0) do_shutdown = FALSE; }
4961 else if (Ustrncmp(item, US"tls=", 4) == 0)
4962 { if (Ustrcmp(item + 9, US"no") != 0) do_tls = TRUE; }
4966 sub_arg[3] = NULL; /* No eol if no timeout */
4968 /* If skipping, we don't actually do anything. Otherwise, arrange to
4969 connect to either an IP or a Unix socket. */
4973 /* Handle an IP (internet) domain */
4975 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4980 server_name = sub_arg[0] + 5;
4981 port_name = Ustrrchr(server_name, ':');
4983 /* Sort out the port */
4987 expand_string_message =
4988 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4991 *port_name++ = 0; /* Terminate server name */
4993 if (isdigit(*port_name))
4996 port = Ustrtol(port_name, &end, 0);
4997 if (end != port_name + Ustrlen(port_name))
4999 expand_string_message =
5000 string_sprintf("invalid port number %s", port_name);
5006 struct servent *service_info = getservbyname(CS port_name, "tcp");
5009 expand_string_message = string_sprintf("unknown port \"%s\"",
5013 port = ntohs(service_info->s_port);
5016 /*XXX we trust that the request is idempotent. Hmm. */
5017 fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
5018 timeout, &host, &expand_string_message,
5019 do_tls ? NULL : &reqstr);
5020 callout_address = NULL;
5027 /* Handle a Unix domain socket */
5031 struct sockaddr_un sockun; /* don't call this "sun" ! */
5034 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
5036 expand_string_message = string_sprintf("failed to create socket: %s",
5041 sockun.sun_family = AF_UNIX;
5042 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
5044 server_name = US sockun.sun_path;
5046 sigalrm_seen = FALSE;
5048 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
5052 expand_string_message = US "socket connect timed out";
5057 expand_string_message = string_sprintf("failed to connect to socket "
5058 "%s: %s", sub_arg[0], strerror(errno));
5061 host.name = server_name;
5062 host.address = US"";
5065 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
5070 tls_support tls_dummy = {.sni=NULL};
5073 if (!(tls_ctx = tls_client_start(fd, &host, NULL, NULL,
5074 # ifdef SUPPORT_DANE
5077 &tls_dummy, &errstr)))
5079 expand_string_message = string_sprintf("TLS connect failed: %s", errstr);
5085 /* Allow sequencing of test actions */
5086 if (f.running_in_test_harness) millisleep(100);
5088 /* Write the request string, if not empty or already done */
5092 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
5096 tls_ctx ? tls_write(tls_ctx, reqstr.data, reqstr.len, FALSE) :
5098 write(fd, reqstr.data, reqstr.len)) != reqstr.len)
5100 expand_string_message = string_sprintf("request write to socket "
5101 "failed: %s", strerror(errno));
5106 /* Shut down the sending side of the socket. This helps some servers to
5107 recognise that it is their turn to do some work. Just in case some
5108 system doesn't have this function, make it conditional. */
5111 if (!tls_ctx && do_shutdown) shutdown(fd, SHUT_WR);
5114 if (f.running_in_test_harness) millisleep(100);
5116 /* Now we need to read from the socket, under a timeout. The function
5117 that reads a file can be used. */
5120 fp = fdopen(fd, "rb");
5121 sigalrm_seen = FALSE;
5125 tls_ctx ? cat_file_tls(tls_ctx, yield, sub_arg[3]) :
5127 cat_file(fp, yield, sub_arg[3]);
5133 tls_close(tls_ctx, TRUE);
5140 /* After a timeout, we restore the pointer in the result, that is,
5141 make sure we add nothing from the socket. */
5145 yield->ptr = save_ptr;
5146 expand_string_message = US "socket read timed out";
5151 /* The whole thing has worked (or we were skipping). If there is a
5152 failure string following, we need to skip it. */
5156 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
5160 expand_string_message = US"missing '}' closing failstring for readsocket";
5161 goto EXPAND_FAILED_CURLY;
5163 while (isspace(*s)) s++;
5169 expand_string_message = US"missing '}' closing readsocket";
5170 goto EXPAND_FAILED_CURLY;
5174 /* Come here on failure to create socket, connect socket, write to the
5175 socket, or timeout on reading. If another substring follows, expand and
5176 use it. Otherwise, those conditions give expand errors. */
5179 if (*s != '{') goto EXPAND_FAILED;
5180 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5181 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5183 yield = string_cat(yield, arg);
5186 expand_string_message = US"missing '}' closing failstring for readsocket";
5187 goto EXPAND_FAILED_CURLY;
5189 while (isspace(*s)) s++;
5193 /* Handle "run" to execute a program. */
5199 const uschar **argv;
5203 if ((expand_forbid & RDO_RUN) != 0)
5205 expand_string_message = US"running a command is not permitted";
5209 while (isspace(*s)) s++;
5212 expand_string_message = US"missing '{' for command arg of run";
5213 goto EXPAND_FAILED_CURLY;
5215 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5216 if (arg == NULL) goto EXPAND_FAILED;
5217 while (isspace(*s)) s++;
5220 expand_string_message = US"missing '}' closing command arg of run";
5221 goto EXPAND_FAILED_CURLY;
5224 if (skipping) /* Just pretend it worked when we're skipping */
5227 lookup_value = NULL;
5231 if (!transport_set_up_command(&argv, /* anchor for arg list */
5232 arg, /* raw command */
5233 FALSE, /* don't expand the arguments */
5234 0, /* not relevant when... */
5235 NULL, /* no transporting address */
5236 US"${run} expansion", /* for error messages */
5237 &expand_string_message)) /* where to put error message */
5240 /* Create the child process, making it a group leader. */
5242 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
5244 expand_string_message =
5245 string_sprintf("couldn't create child process: %s", strerror(errno));
5249 /* Nothing is written to the standard input. */
5253 /* Read the pipe to get the command's output into $value (which is kept
5254 in lookup_value). Read during execution, so that if the output exceeds
5255 the OS pipe buffer limit, we don't block forever. Remember to not release
5256 memory just allocated for $value. */
5259 f = fdopen(fd_out, "rb");
5260 sigalrm_seen = FALSE;
5262 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5266 /* Wait for the process to finish, applying the timeout, and inspect its
5267 return code for serious disasters. Simple non-zero returns are passed on.
5270 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5272 if (sigalrm_seen || runrc == -256)
5274 expand_string_message = string_sprintf("command timed out");
5275 killpg(pid, SIGKILL); /* Kill the whole process group */
5278 else if (runrc == -257)
5279 expand_string_message = string_sprintf("wait() failed: %s",
5283 expand_string_message = string_sprintf("command killed by signal %d",
5290 /* Process the yes/no strings; $value may be useful in both cases */
5292 switch(process_yesno(
5293 skipping, /* were previously skipping */
5294 runrc == 0, /* success/failure indicator */
5295 lookup_value, /* value to reset for string2 */
5296 &s, /* input pointer */
5297 &yield, /* output pointer */
5298 US"run", /* condition type */
5301 case 1: goto EXPAND_FAILED; /* when all is well, the */
5302 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5308 /* Handle character translation for "tr" */
5312 int oldptr = yield->ptr;
5316 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5318 case 1: goto EXPAND_FAILED_CURLY;
5320 case 3: goto EXPAND_FAILED;
5323 yield = string_cat(yield, sub[0]);
5324 o2m = Ustrlen(sub[2]) - 1;
5326 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5328 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5332 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5339 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5340 expanded arguments. */
5349 int val[2] = { 0, -1 };
5352 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5353 Ensure that sub[2] is set in the ${length } case. */
5356 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5357 TRUE, name, &resetok))
5359 case 1: goto EXPAND_FAILED_CURLY;
5361 case 3: goto EXPAND_FAILED;
5364 /* Juggle the arguments if there are only two of them: always move the
5365 string to the last position and make ${length{n}{str}} equivalent to
5366 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5372 if (item_type == EITEM_LENGTH)
5379 for (int i = 0; i < 2; i++) if (sub[i])
5381 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5382 if (*ret != 0 || (i != 0 && val[i] < 0))
5384 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5385 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5391 (item_type == EITEM_HASH)?
5392 compute_hash(sub[2], val[0], val[1], &len) :
5393 (item_type == EITEM_NHASH)?
5394 compute_nhash(sub[2], val[0], val[1], &len) :
5395 extract_substr(sub[2], val[0], val[1], &len);
5397 if (ret == NULL) goto EXPAND_FAILED;
5398 yield = string_catn(yield, ret, len);
5402 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5403 This code originally contributed by Steve Haslam. It currently supports
5404 the use of MD5 and SHA-1 hashes.
5406 We need some workspace that is large enough to handle all the supported
5407 hash types. Use macros to set the sizes rather than be too elaborate. */
5409 #define MAX_HASHLEN 20
5410 #define MAX_HASHBLOCKLEN 64
5419 int hashlen; /* Number of octets for the hash algorithm's output */
5420 int hashblocklen; /* Number of octets the hash algorithm processes */
5422 unsigned int keylen;
5424 uschar keyhash[MAX_HASHLEN];
5425 uschar innerhash[MAX_HASHLEN];
5426 uschar finalhash[MAX_HASHLEN];
5427 uschar finalhash_hex[2*MAX_HASHLEN];
5428 uschar innerkey[MAX_HASHBLOCKLEN];
5429 uschar outerkey[MAX_HASHBLOCKLEN];
5431 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5433 case 1: goto EXPAND_FAILED_CURLY;
5435 case 3: goto EXPAND_FAILED;
5440 if (Ustrcmp(sub[0], "md5") == 0)
5443 use_base = &md5_base;
5447 else if (Ustrcmp(sub[0], "sha1") == 0)
5450 use_base = &sha1_ctx;
5456 expand_string_message =
5457 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5462 keylen = Ustrlen(keyptr);
5464 /* If the key is longer than the hash block length, then hash the key
5467 if (keylen > hashblocklen)
5469 chash_start(type, use_base);
5470 chash_end(type, use_base, keyptr, keylen, keyhash);
5475 /* Now make the inner and outer key values */
5477 memset(innerkey, 0x36, hashblocklen);
5478 memset(outerkey, 0x5c, hashblocklen);
5480 for (int i = 0; i < keylen; i++)
5482 innerkey[i] ^= keyptr[i];
5483 outerkey[i] ^= keyptr[i];
5486 /* Now do the hashes */
5488 chash_start(type, use_base);
5489 chash_mid(type, use_base, innerkey);
5490 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5492 chash_start(type, use_base);
5493 chash_mid(type, use_base, outerkey);
5494 chash_end(type, use_base, innerhash, hashlen, finalhash);
5496 /* Encode the final hash as a hex string */
5499 for (int i = 0; i < hashlen; i++)
5501 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5502 *p++ = hex_digits[finalhash[i] & 0x0f];
5505 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5506 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5508 yield = string_catn(yield, finalhash_hex, hashlen*2);
5513 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5514 We have to save the numerical variables and restore them afterwards. */
5519 int moffset, moffsetextra, slen;
5522 const uschar *rerror;
5525 int save_expand_nmax =
5526 save_expand_strings(save_expand_nstring, save_expand_nlength);
5528 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5530 case 1: goto EXPAND_FAILED_CURLY;
5532 case 3: goto EXPAND_FAILED;
5535 /* Compile the regular expression */
5537 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5542 expand_string_message = string_sprintf("regular expression error in "
5543 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5547 /* Now run a loop to do the substitutions as often as necessary. It ends
5548 when there are no more matches. Take care over matches of the null string;
5549 do the same thing as Perl does. */
5552 slen = Ustrlen(sub[0]);
5553 moffset = moffsetextra = 0;
5558 int ovector[3*(EXPAND_MAXN+1)];
5559 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5560 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5563 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5564 is not necessarily the end. We want to repeat the match from one
5565 character further along, but leaving the basic offset the same (for
5566 copying below). We can't be at the end of the string - that was checked
5567 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5568 finished; copy the remaining string and end the loop. */
5578 yield = string_catn(yield, subject+moffset, slen-moffset);
5582 /* Match - set up for expanding the replacement. */
5584 if (n == 0) n = EXPAND_MAXN + 1;
5586 for (int nn = 0; nn < n*2; nn += 2)
5588 expand_nstring[expand_nmax] = subject + ovector[nn];
5589 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5593 /* Copy the characters before the match, plus the expanded insertion. */
5595 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
5596 insert = expand_string(sub[2]);
5597 if (insert == NULL) goto EXPAND_FAILED;
5598 yield = string_cat(yield, insert);
5600 moffset = ovector[1];
5604 /* If we have matched an empty string, first check to see if we are at
5605 the end of the subject. If so, the loop is over. Otherwise, mimic
5606 what Perl's /g options does. This turns out to be rather cunning. First
5607 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5608 string at the same point. If this fails (picked up above) we advance to
5609 the next character. */
5611 if (ovector[0] == ovector[1])
5613 if (ovector[0] == slen) break;
5614 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5618 /* All done - restore numerical variables. */
5620 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5621 save_expand_nlength);
5625 /* Handle keyed and numbered substring extraction. If the first argument
5626 consists entirely of digits, then a numerical extraction is assumed. */
5630 int field_number = 1;
5631 BOOL field_number_set = FALSE;
5632 uschar *save_lookup_value = lookup_value;
5634 int save_expand_nmax =
5635 save_expand_strings(save_expand_nstring, save_expand_nlength);
5636 enum {extract_basic, extract_json} fmt = extract_basic;
5638 while (isspace(*s)) s++;
5640 /* Check for a format-variant specifier */
5642 if (*s != '{') /*}*/
5643 if (Ustrncmp(s, "json", 4) == 0)
5644 {fmt = extract_json; s += 4;}
5646 /* While skipping we cannot rely on the data for expansions being
5647 available (eg. $item) hence cannot decide on numeric vs. keyed.
5648 Read a maximum of 5 arguments (including the yes/no) */
5652 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/
5654 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5655 goto EXPAND_FAILED; /*'{'*/
5658 expand_string_message = US"missing '{' for arg of extract";
5659 goto EXPAND_FAILED_CURLY;
5661 while (isspace(*s)) s++;
5663 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/
5664 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5668 while (isspace(*s)) s++;
5672 expand_string_message = US"missing '}' closing extract";
5673 goto EXPAND_FAILED_CURLY;
5677 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5679 while (isspace(*s)) s++;
5680 if (*s == '{') /*'}'*/
5682 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5683 if (sub[i] == NULL) goto EXPAND_FAILED; /*'{'*/
5686 expand_string_message = string_sprintf(
5687 "missing '}' closing arg %d of extract", i+1);
5688 goto EXPAND_FAILED_CURLY;
5691 /* After removal of leading and trailing white space, the first
5692 argument must not be empty; if it consists entirely of digits
5693 (optionally preceded by a minus sign), this is a numerical
5694 extraction, and we expect 3 arguments (normal) or 2 (json). */
5702 while (isspace(*p)) p++;
5706 while (len > 0 && isspace(p[len-1])) len--;
5711 expand_string_message = US"first argument of \"extract\" must "
5721 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5725 if (fmt != extract_json) j = 3; /* Need 3 args */
5726 field_number_set = TRUE;
5732 expand_string_message = string_sprintf(
5733 "missing '{' for arg %d of extract", i+1);
5734 goto EXPAND_FAILED_CURLY;
5738 /* Extract either the numbered or the keyed substring into $value. If
5739 skipping, just pretend the extraction failed. */
5742 lookup_value = NULL;
5746 lookup_value = field_number_set
5747 ? expand_gettokened(field_number, sub[1], sub[2])
5748 : expand_getkeyed(sub[0], sub[1]);
5754 const uschar * list;
5756 /* Array: Bracket-enclosed and comma-separated.
5757 Object: Brace-enclosed, comma-sep list of name:value pairs */
5759 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
5761 expand_string_message =
5762 string_sprintf("%s wrapping %s for extract json",
5763 expand_string_message,
5764 field_number_set ? "array" : "object");
5765 goto EXPAND_FAILED_CURLY;
5769 if (field_number_set)
5771 if (field_number <= 0)
5773 expand_string_message = US"first argument of \"extract\" must "
5774 "be greater than zero";
5777 while (field_number > 0 && (item = json_nextinlist(&list)))
5782 while (--s >= lookup_value && isspace(*s)) *s = '\0';
5786 lookup_value = NULL;
5787 while ((item = json_nextinlist(&list)))
5789 /* Item is: string name-sep value. string is quoted.
5790 Dequote the string and compare with the search key. */
5792 if (!(item = dewrap(item, US"\"\"")))
5794 expand_string_message =
5795 string_sprintf("%s wrapping string key for extract json",
5796 expand_string_message);
5797 goto EXPAND_FAILED_CURLY;
5799 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */
5801 s = item + Ustrlen(item) + 1;
5802 while (isspace(*s)) s++;
5805 expand_string_message = string_sprintf(
5806 "missing object value-separator for extract json");
5807 goto EXPAND_FAILED_CURLY;
5810 while (isspace(*s)) s++;
5819 /* If no string follows, $value gets substituted; otherwise there can
5820 be yes/no strings, as for lookup or if. */
5822 switch(process_yesno(
5823 skipping, /* were previously skipping */
5824 lookup_value != NULL, /* success/failure indicator */
5825 save_lookup_value, /* value to reset for string2 */
5826 &s, /* input pointer */
5827 &yield, /* output pointer */
5828 US"extract", /* condition type */
5831 case 1: goto EXPAND_FAILED; /* when all is well, the */
5832 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5835 /* All done - restore numerical variables. */
5837 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5838 save_expand_nlength);
5843 /* return the Nth item from a list */
5845 case EITEM_LISTEXTRACT:
5847 int field_number = 1;
5848 uschar *save_lookup_value = lookup_value;
5850 int save_expand_nmax =
5851 save_expand_strings(save_expand_nstring, save_expand_nlength);
5853 /* Read the field & list arguments */
5855 for (int i = 0; i < 2; i++)
5857 while (isspace(*s)) s++;
5858 if (*s != '{') /*'}'*/
5860 expand_string_message = string_sprintf(
5861 "missing '{' for arg %d of listextract", i+1);
5862 goto EXPAND_FAILED_CURLY;
5865 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5866 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5869 expand_string_message = string_sprintf(
5870 "missing '}' closing arg %d of listextract", i+1);
5871 goto EXPAND_FAILED_CURLY;
5874 /* After removal of leading and trailing white space, the first
5875 argument must be numeric and nonempty. */
5883 while (isspace(*p)) p++;
5887 while (len > 0 && isspace(p[len-1])) len--;
5890 if (!*p && !skipping)
5892 expand_string_message = US"first argument of \"listextract\" must "
5902 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5905 expand_string_message = US"first argument of \"listextract\" must "
5913 /* Extract the numbered element into $value. If
5914 skipping, just pretend the extraction failed. */
5916 lookup_value = skipping ? NULL : expand_getlistele(field_number, sub[1]);
5918 /* If no string follows, $value gets substituted; otherwise there can
5919 be yes/no strings, as for lookup or if. */
5921 switch(process_yesno(
5922 skipping, /* were previously skipping */
5923 lookup_value != NULL, /* success/failure indicator */
5924 save_lookup_value, /* value to reset for string2 */
5925 &s, /* input pointer */
5926 &yield, /* output pointer */
5927 US"listextract", /* condition type */
5930 case 1: goto EXPAND_FAILED; /* when all is well, the */
5931 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5934 /* All done - restore numerical variables. */
5936 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5937 save_expand_nlength);
5943 case EITEM_CERTEXTRACT:
5945 uschar *save_lookup_value = lookup_value;
5947 int save_expand_nmax =
5948 save_expand_strings(save_expand_nstring, save_expand_nlength);
5950 /* Read the field argument */
5951 while (isspace(*s)) s++;
5952 if (*s != '{') /*}*/
5954 expand_string_message = US"missing '{' for field arg of certextract";
5955 goto EXPAND_FAILED_CURLY;
5957 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5958 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5961 expand_string_message = US"missing '}' closing field arg of certextract";
5962 goto EXPAND_FAILED_CURLY;
5964 /* strip spaces fore & aft */
5969 while (isspace(*p)) p++;
5973 while (len > 0 && isspace(p[len-1])) len--;
5977 /* inspect the cert argument */
5978 while (isspace(*s)) s++;
5979 if (*s != '{') /*}*/
5981 expand_string_message = US"missing '{' for cert variable arg of certextract";
5982 goto EXPAND_FAILED_CURLY;
5986 expand_string_message = US"second argument of \"certextract\" must "
5987 "be a certificate variable";
5990 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5991 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5994 expand_string_message = US"missing '}' closing cert variable arg of certextract";
5995 goto EXPAND_FAILED_CURLY;
5999 lookup_value = NULL;
6002 lookup_value = expand_getcertele(sub[0], sub[1]);
6003 if (*expand_string_message) goto EXPAND_FAILED;
6005 switch(process_yesno(
6006 skipping, /* were previously skipping */
6007 lookup_value != NULL, /* success/failure indicator */
6008 save_lookup_value, /* value to reset for string2 */
6009 &s, /* input pointer */
6010 &yield, /* output pointer */
6011 US"certextract", /* condition type */
6014 case 1: goto EXPAND_FAILED; /* when all is well, the */
6015 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6018 restore_expand_strings(save_expand_nmax, save_expand_nstring,
6019 save_expand_nlength);
6022 #endif /*SUPPORT_TLS*/
6024 /* Handle list operations */
6031 int save_ptr = yield->ptr;
6032 uschar outsep[2] = { '\0', '\0' };
6033 const uschar *list, *expr, *temp;
6034 uschar *save_iterate_item = iterate_item;
6035 uschar *save_lookup_value = lookup_value;
6037 while (isspace(*s)) s++;
6040 expand_string_message =
6041 string_sprintf("missing '{' for first arg of %s", name);
6042 goto EXPAND_FAILED_CURLY;
6045 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6046 if (list == NULL) goto EXPAND_FAILED;
6049 expand_string_message =
6050 string_sprintf("missing '}' closing first arg of %s", name);
6051 goto EXPAND_FAILED_CURLY;
6054 if (item_type == EITEM_REDUCE)
6057 while (isspace(*s)) s++;
6060 expand_string_message = US"missing '{' for second arg of reduce";
6061 goto EXPAND_FAILED_CURLY;
6063 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6064 if (!t) goto EXPAND_FAILED;
6068 expand_string_message = US"missing '}' closing second arg of reduce";
6069 goto EXPAND_FAILED_CURLY;
6073 while (isspace(*s)) s++;
6076 expand_string_message =
6077 string_sprintf("missing '{' for last arg of %s", name);
6078 goto EXPAND_FAILED_CURLY;
6083 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6084 if scanning a "false" part). This allows us to find the end of the
6085 condition, because if the list is empty, we won't actually evaluate the
6086 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6087 the normal internal expansion function. */
6089 if (item_type == EITEM_FILTER)
6091 temp = eval_condition(expr, &resetok, NULL);
6092 if (temp != NULL) s = temp;
6095 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6099 expand_string_message = string_sprintf("%s inside \"%s\" item",
6100 expand_string_message, name);
6104 while (isspace(*s)) s++;
6107 expand_string_message = string_sprintf("missing } at end of condition "
6108 "or expression inside \"%s\"; could be an unquoted } in the content",
6113 while (isspace(*s)) s++; /*{*/
6116 expand_string_message = string_sprintf("missing } at end of \"%s\"",
6121 /* If we are skipping, we can now just move on to the next item. When
6122 processing for real, we perform the iteration. */
6124 if (skipping) continue;
6125 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6127 *outsep = (uschar)sep; /* Separator as a string */
6129 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
6130 name, iterate_item, lookup_value);
6132 if (item_type == EITEM_FILTER)
6135 if (eval_condition(expr, &resetok, &condresult) == NULL)
6137 iterate_item = save_iterate_item;
6138 lookup_value = save_lookup_value;
6139 expand_string_message = string_sprintf("%s inside \"%s\" condition",
6140 expand_string_message, name);
6143 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6144 condresult? "true":"false");
6146 temp = iterate_item; /* TRUE => include this item */
6148 continue; /* FALSE => skip this item */
6151 /* EITEM_MAP and EITEM_REDUCE */
6155 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
6159 iterate_item = save_iterate_item;
6160 expand_string_message = string_sprintf("%s inside \"%s\" item",
6161 expand_string_message, name);
6164 if (item_type == EITEM_REDUCE)
6166 lookup_value = t; /* Update the value of $value */
6167 continue; /* and continue the iteration */
6171 /* We reach here for FILTER if the condition is true, always for MAP,
6172 and never for REDUCE. The value in "temp" is to be added to the output
6173 list that is being created, ensuring that any occurrences of the
6174 separator character are doubled. Unless we are dealing with the first
6175 item of the output list, add in a space if the new item begins with the
6176 separator character, or is an empty string. */
6178 if (yield->ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
6179 yield = string_catn(yield, US" ", 1);
6181 /* Add the string in "temp" to the output list that we are building,
6182 This is done in chunks by searching for the separator character. */
6186 size_t seglen = Ustrcspn(temp, outsep);
6188 yield = string_catn(yield, temp, seglen + 1);
6190 /* If we got to the end of the string we output one character
6191 too many; backup and end the loop. Otherwise arrange to double the
6194 if (temp[seglen] == '\0') { yield->ptr--; break; }
6195 yield = string_catn(yield, outsep, 1);
6199 /* Output a separator after the string: we will remove the redundant
6200 final one at the end. */
6202 yield = string_catn(yield, outsep, 1);
6203 } /* End of iteration over the list loop */
6205 /* REDUCE has generated no output above: output the final value of
6208 if (item_type == EITEM_REDUCE)
6210 yield = string_cat(yield, lookup_value);
6211 lookup_value = save_lookup_value; /* Restore $value */
6214 /* FILTER and MAP generate lists: if they have generated anything, remove
6215 the redundant final separator. Even though an empty item at the end of a
6216 list does not count, this is tidier. */
6218 else if (yield->ptr != save_ptr) yield->ptr--;
6220 /* Restore preserved $item */
6222 iterate_item = save_iterate_item;
6229 const uschar *srclist, *cmp, *xtract;
6231 const uschar *dstlist = NULL, *dstkeylist = NULL;
6233 uschar *save_iterate_item = iterate_item;
6235 while (isspace(*s)) s++;
6238 expand_string_message = US"missing '{' for list arg of sort";
6239 goto EXPAND_FAILED_CURLY;
6242 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6243 if (!srclist) goto EXPAND_FAILED;
6246 expand_string_message = US"missing '}' closing list arg of sort";
6247 goto EXPAND_FAILED_CURLY;
6250 while (isspace(*s)) s++;
6253 expand_string_message = US"missing '{' for comparator arg of sort";
6254 goto EXPAND_FAILED_CURLY;
6257 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6258 if (!cmp) goto EXPAND_FAILED;
6261 expand_string_message = US"missing '}' closing comparator arg of sort";
6262 goto EXPAND_FAILED_CURLY;
6265 while (isspace(*s)) s++;
6268 expand_string_message = US"missing '{' for extractor arg of sort";
6269 goto EXPAND_FAILED_CURLY;
6273 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6274 if (!tmp) goto EXPAND_FAILED;
6275 xtract = string_copyn(xtract, s - xtract);
6279 expand_string_message = US"missing '}' closing extractor arg of sort";
6280 goto EXPAND_FAILED_CURLY;
6285 expand_string_message = US"missing } at end of \"sort\"";
6289 if (skipping) continue;
6291 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6294 gstring * newlist = NULL;
6295 gstring * newkeylist = NULL;
6298 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6300 /* extract field for comparisons */
6301 iterate_item = srcitem;
6302 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6306 expand_string_message = string_sprintf(
6307 "field-extract in sort: \"%s\"", xtract);
6311 /* Insertion sort */
6313 /* copy output list until new-item < list-item */
6314 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6320 /* field for comparison */
6321 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6324 /* build and run condition string */
6325 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
6327 DEBUG(D_expand) debug_printf_indent("%s: cond = \"%s\"\n", name, expr);
6328 if (!eval_condition(expr, &resetok, &before))
6330 expand_string_message = string_sprintf("comparison in sort: %s",
6337 /* New-item sorts before this dst-item. Append new-item,
6338 then dst-item, then remainder of dst list. */
6340 newlist = string_append_listele(newlist, sep, srcitem);
6341 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6344 newlist = string_append_listele(newlist, sep, dstitem);
6345 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6347 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6349 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6351 newlist = string_append_listele(newlist, sep, dstitem);
6352 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6358 newlist = string_append_listele(newlist, sep, dstitem);
6359 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6362 /* If we ran out of dstlist without consuming srcitem, append it */
6365 newlist = string_append_listele(newlist, sep, srcitem);
6366 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6369 dstlist = newlist->s;
6370 dstkeylist = newkeylist->s;
6372 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6373 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6377 yield = string_cat(yield, dstlist);
6379 /* Restore preserved $item */
6380 iterate_item = save_iterate_item;
6384 expand_string_message = US"Internal error in sort (list mismatch)";
6389 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6390 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6391 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6392 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6394 #define EXPAND_DLFUNC_MAX_ARGS 8
6397 #ifndef EXPAND_DLFUNC
6398 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6399 "is not included in this binary";
6402 #else /* EXPAND_DLFUNC */
6405 exim_dlfunc_t *func;
6408 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6410 if ((expand_forbid & RDO_DLFUNC) != 0)
6412 expand_string_message =
6413 US"dynamically-loaded functions are not permitted";
6417 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6418 TRUE, US"dlfunc", &resetok))
6420 case 1: goto EXPAND_FAILED_CURLY;
6422 case 3: goto EXPAND_FAILED;
6425 /* If skipping, we don't actually do anything */
6427 if (skipping) continue;
6429 /* Look up the dynamically loaded object handle in the tree. If it isn't
6430 found, dlopen() the file and put the handle in the tree for next time. */
6432 if (!(t = tree_search(dlobj_anchor, argv[0])))
6434 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6437 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6438 argv[0], dlerror());
6439 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6442 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6443 Ustrcpy(t->name, argv[0]);
6444 t->data.ptr = handle;
6445 (void)tree_insertnode(&dlobj_anchor, t);
6448 /* Having obtained the dynamically loaded object handle, look up the
6449 function pointer. */
6451 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6454 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6455 "%s", argv[1], argv[0], dlerror());
6456 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6460 /* Call the function and work out what to do with the result. If it
6461 returns OK, we have a replacement string; if it returns DEFER then
6462 expansion has failed in a non-forced manner; if it returns FAIL then
6463 failure was forced; if it returns ERROR or any other value there's a
6464 problem, so panic slightly. In any case, assume that the function has
6465 side-effects on the store that must be preserved. */
6469 for (argc = 0; argv[argc] != NULL; argc++);
6470 status = func(&result, argc - 2, &argv[2]);
6473 if (result == NULL) result = US"";
6474 yield = string_cat(yield, result);
6479 expand_string_message = result == NULL ? US"(no message)" : result;
6480 if(status == FAIL_FORCED) f.expand_string_forcedfail = TRUE;
6481 else if(status != FAIL)
6482 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6483 argv[0], argv[1], status, expand_string_message);
6487 #endif /* EXPAND_DLFUNC */
6489 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6492 uschar *save_lookup_value = lookup_value;
6494 while (isspace(*s)) s++;
6495 if (*s != '{') /*}*/
6498 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6499 if (!key) goto EXPAND_FAILED; /*{*/
6502 expand_string_message = US"missing '{' for name arg of env";
6503 goto EXPAND_FAILED_CURLY;
6506 lookup_value = US getenv(CS key);
6508 switch(process_yesno(
6509 skipping, /* were previously skipping */
6510 lookup_value != NULL, /* success/failure indicator */
6511 save_lookup_value, /* value to reset for string2 */
6512 &s, /* input pointer */
6513 &yield, /* output pointer */
6514 US"env", /* condition type */
6517 case 1: goto EXPAND_FAILED; /* when all is well, the */
6518 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6522 } /* EITEM_* switch */
6524 /* Control reaches here if the name is not recognized as one of the more
6525 complicated expansion items. Check for the "operator" syntax (name terminated
6526 by a colon). Some of the operators have arguments, separated by _ from the
6535 var_entry *vp = NULL;
6538 /* Owing to an historical mis-design, an underscore may be part of the
6539 operator name, or it may introduce arguments. We therefore first scan the
6540 table of names that contain underscores. If there is no match, we cut off
6541 the arguments and then scan the main table. */
6543 if ((c = chop_match(name, op_table_underscore,
6544 nelem(op_table_underscore))) < 0)
6546 arg = Ustrchr(name, '_');
6547 if (arg != NULL) *arg = 0;
6548 c = chop_match(name, op_table_main, nelem(op_table_main));
6549 if (c >= 0) c += nelem(op_table_underscore);
6550 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6553 /* Deal specially with operators that might take a certificate variable
6554 as we do not want to do the usual expansion. For most, expand the string.*/
6564 const uschar * s1 = s;
6565 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6567 if (!sub) goto EXPAND_FAILED; /*{*/
6570 expand_string_message =
6571 string_sprintf("missing '}' closing cert arg of %s", name);
6572 goto EXPAND_FAILED_CURLY;
6574 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6584 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6585 if (!sub) goto EXPAND_FAILED;
6590 /* If we are skipping, we don't need to perform the operation at all.
6591 This matters for operations like "mask", because the data may not be
6592 in the correct format when skipping. For example, the expression may test
6593 for the existence of $sender_host_address before trying to mask it. For
6594 other operations, doing them may not fail, but it is a waste of time. */
6596 if (skipping && c >= 0) continue;
6598 /* Otherwise, switch on the operator type */
6605 unsigned long int n = Ustrtoul(sub, &t, 10);
6610 expand_string_message = string_sprintf("argument for base32 "
6611 "operator is \"%s\", which is not a decimal number", sub);
6615 g = string_catn(g, &base32_chars[n & 0x1f], 1);
6617 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
6624 unsigned long int n = 0;
6628 uschar * t = Ustrchr(base32_chars, *tt++);
6631 expand_string_message = string_sprintf("argument for base32d "
6632 "operator is \"%s\", which is not a base 32 number", sub);
6635 n = n * 32 + (t - base32_chars);
6637 s = string_sprintf("%ld", n);
6638 yield = string_cat(yield, s);
6645 unsigned long int n = Ustrtoul(sub, &t, 10);
6648 expand_string_message = string_sprintf("argument for base62 "
6649 "operator is \"%s\", which is not a decimal number", sub);
6652 t = string_base62(n);
6653 yield = string_cat(yield, t);
6657 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6662 unsigned long int n = 0;
6665 uschar *t = Ustrchr(base62_chars, *tt++);
6668 expand_string_message = string_sprintf("argument for base62d "
6669 "operator is \"%s\", which is not a base %d number", sub,
6673 n = n * BASE_62 + (t - base62_chars);
6675 yield = string_fmt_append(yield, "%ld", n);
6681 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6682 if (expanded == NULL)
6684 expand_string_message =
6685 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6686 expand_string_message);
6689 yield = string_cat(yield, expanded);
6696 uschar *t = sub - 1;
6697 while (*(++t) != 0) { *t = tolower(*t); count++; }
6698 yield = string_catn(yield, sub, count);
6705 uschar *t = sub - 1;
6706 while (*(++t) != 0) { *t = toupper(*t); count++; }
6707 yield = string_catn(yield, sub, count);
6713 if (vp && *(void **)vp->value)
6715 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6716 yield = string_cat(yield, cp);
6724 md5_end(&base, sub, Ustrlen(sub), digest);
6725 for (int j = 0; j < 16; j++)
6726 yield = string_fmt_append(yield, "%02x", digest[j]);
6732 if (vp && *(void **)vp->value)
6734 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6735 yield = string_cat(yield, cp);
6743 sha1_end(&h, sub, Ustrlen(sub), digest);
6744 for (int j = 0; j < 20; j++)
6745 yield = string_fmt_append(yield, "%02X", digest[j]);
6750 #ifdef EXIM_HAVE_SHA2
6751 if (vp && *(void **)vp->value)
6753 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6754 yield = string_cat(yield, cp);
6761 if (!exim_sha_init(&h, HASH_SHA2_256))
6763 expand_string_message = US"unrecognised sha256 variant";
6766 exim_sha_update(&h, sub, Ustrlen(sub));
6767 exim_sha_finish(&h, &b);
6769 yield = string_fmt_append(yield, "%02X", *b.data++);
6772 expand_string_message = US"sha256 only supported with TLS";
6777 #ifdef EXIM_HAVE_SHA3
6781 hashmethod m = !arg ? HASH_SHA3_256
6782 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6783 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6784 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6785 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6788 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6790 expand_string_message = US"unrecognised sha3 variant";
6794 exim_sha_update(&h, sub, Ustrlen(sub));
6795 exim_sha_finish(&h, &b);
6797 yield = string_fmt_append(yield, "%02X", *b.data++);
6801 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
6805 /* Convert hex encoding to base64 encoding */
6815 for (enc = sub; *enc; enc++)
6817 if (!isxdigit(*enc))
6819 expand_string_message = string_sprintf("\"%s\" is not a hex "
6828 expand_string_message = string_sprintf("\"%s\" contains an odd "
6829 "number of characters", sub);
6833 while ((c = *in++) != 0)
6835 if (isdigit(c)) c -= '0';
6836 else c = toupper(c) - 'A' + 10;
6846 enc = b64encode(sub, out - sub);
6847 yield = string_cat(yield, enc);
6851 /* Convert octets outside 0x21..0x7E to \xXX form */
6855 uschar *t = sub - 1;
6858 if (*t < 0x21 || 0x7E < *t)
6859 yield = string_fmt_append(yield, "\\x%02x", *t);
6861 yield = string_catn(yield, t, 1);
6866 /* count the number of list elements */
6874 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6875 yield = string_fmt_append(yield, "%d", cnt);
6879 /* expand a named list given the name */
6880 /* handles nested named lists; requotes as colon-sep list */
6884 tree_node *t = NULL;
6885 const uschar * list;
6888 uschar * suffix = US"";
6889 BOOL needsep = FALSE;
6892 if (*sub == '+') sub++;
6893 if (arg == NULL) /* no-argument version */
6895 if (!(t = tree_search(addresslist_anchor, sub)) &&
6896 !(t = tree_search(domainlist_anchor, sub)) &&
6897 !(t = tree_search(hostlist_anchor, sub)))
6898 t = tree_search(localpartlist_anchor, sub);
6900 else switch(*arg) /* specific list-type version */
6902 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6903 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6904 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6905 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6907 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6913 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6915 : *arg=='a'?"address "
6916 : *arg=='d'?"domain "
6918 : *arg=='l'?"localpart "
6923 list = ((namedlist_block *)(t->data.ptr))->string;
6925 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
6927 uschar * buf = US" : ";
6929 yield = string_catn(yield, buf, 3);
6933 if (*item == '+') /* list item is itself a named list */
6935 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6936 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6938 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6942 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6943 while ((cp= strpbrk(CCS item, tok)))
6945 yield = string_catn(yield, item, cp - CS item);
6946 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6948 yield = string_catn(yield, US"::", 2);
6951 else /* sep in item; should already be doubled; emit once */
6953 yield = string_catn(yield, US tok, 1);
6954 if (*cp == sep) cp++;
6959 yield = string_cat(yield, item);
6964 /* mask applies a mask to an IP address; for example the result of
6965 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6972 int mask, maskoffset;
6973 int type = string_is_ip_address(sub, &maskoffset);
6978 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6983 if (maskoffset == 0)
6985 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6990 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6992 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6994 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6999 /* Convert the address to binary integer(s) and apply the mask */
7001 sub[maskoffset] = 0;
7002 count = host_aton(sub, binary);
7003 host_mask(count, binary, mask);
7005 /* Convert to masked textual format and add to output. */
7007 yield = string_catn(yield, buffer,
7008 host_nmtoa(count, binary, mask, buffer, '.'));
7013 case EOP_IPV6DENORM:
7015 int type = string_is_ip_address(sub, NULL);
7022 (void) host_aton(sub, binary);
7025 case 4: /* convert to IPv4-mapped IPv6 */
7026 binary[0] = binary[1] = 0;
7027 binary[2] = 0x0000ffff;
7028 (void) host_aton(sub, binary+3);
7032 expand_string_message =
7033 string_sprintf("\"%s\" is not an IP address", sub);
7037 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7038 ? ipv6_nmtoa(binary, buffer)
7039 : host_nmtoa(4, binary, -1, buffer, ':')
7045 case EOP_LOCAL_PART:
7049 int start, end, domain;
7050 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7053 if (c != EOP_DOMAIN)
7055 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
7056 yield = string_catn(yield, sub+start, end-start);
7058 else if (domain != 0)
7061 yield = string_catn(yield, sub+domain, end-domain);
7068 uschar outsep[2] = { ':', '\0' };
7069 uschar *address, *error;
7070 int save_ptr = yield->ptr;
7071 int start, end, domain; /* Not really used */
7073 while (isspace(*sub)) sub++;
7075 if (*outsep = *++sub) ++sub;
7078 expand_string_message = string_sprintf("output separator "
7079 "missing in expanding ${addresses:%s}", --sub);
7082 f.parse_allow_group = TRUE;
7086 uschar *p = parse_find_address_end(sub, FALSE);
7087 uschar saveend = *p;
7089 address = parse_extract_address(sub, &error, &start, &end, &domain,
7093 /* Add the address to the output list that we are building. This is
7094 done in chunks by searching for the separator character. At the
7095 start, unless we are dealing with the first address of the output
7096 list, add in a space if the new address begins with the separator
7097 character, or is an empty string. */
7099 if (address != NULL)
7101 if (yield->ptr != save_ptr && address[0] == *outsep)
7102 yield = string_catn(yield, US" ", 1);
7106 size_t seglen = Ustrcspn(address, outsep);
7107 yield = string_catn(yield, address, seglen + 1);
7109 /* If we got to the end of the string we output one character
7112 if (address[seglen] == '\0') { yield->ptr--; break; }
7113 yield = string_catn(yield, outsep, 1);
7114 address += seglen + 1;
7117 /* Output a separator after the string: we will remove the
7118 redundant final one at the end. */
7120 yield = string_catn(yield, outsep, 1);
7123 if (saveend == '\0') break;
7127 /* If we have generated anything, remove the redundant final
7130 if (yield->ptr != save_ptr) yield->ptr--;
7131 f.parse_allow_group = FALSE;
7136 /* quote puts a string in quotes if it is empty or contains anything
7137 other than alphamerics, underscore, dot, or hyphen.
7139 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7140 be quoted in order to be a valid local part.
7142 In both cases, newlines and carriage returns are converted into \n and \r
7146 case EOP_QUOTE_LOCAL_PART:
7149 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
7150 uschar *t = sub - 1;
7154 while (!needs_quote && *(++t) != 0)
7155 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7157 else /* EOP_QUOTE_LOCAL_PART */
7159 while (!needs_quote && *(++t) != 0)
7160 needs_quote = !isalnum(*t) &&
7161 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
7162 (*t != '.' || t == sub || t[1] == 0);
7167 yield = string_catn(yield, US"\"", 1);
7172 yield = string_catn(yield, US"\\n", 2);
7173 else if (*t == '\r')
7174 yield = string_catn(yield, US"\\r", 2);
7177 if (*t == '\\' || *t == '"')
7178 yield = string_catn(yield, US"\\", 1);
7179 yield = string_catn(yield, t, 1);
7182 yield = string_catn(yield, US"\"", 1);
7184 else yield = string_cat(yield, sub);
7188 /* quote_lookuptype does lookup-specific quoting */
7193 uschar *opt = Ustrchr(arg, '_');
7195 if (opt != NULL) *opt++ = 0;
7197 n = search_findtype(arg, Ustrlen(arg));
7200 expand_string_message = search_error_message;
7204 if (lookup_list[n]->quote != NULL)
7205 sub = (lookup_list[n]->quote)(sub, opt);
7206 else if (opt != NULL) sub = NULL;
7210 expand_string_message = string_sprintf(
7211 "\"%s\" unrecognized after \"${quote_%s\"",
7216 yield = string_cat(yield, sub);
7220 /* rx quote sticks in \ before any non-alphameric character so that
7221 the insertion works in a regular expression. */
7225 uschar *t = sub - 1;
7229 yield = string_catn(yield, US"\\", 1);
7230 yield = string_catn(yield, t, 1);
7235 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7236 prescribed by the RFC, if there are characters that need to be encoded */
7240 uschar buffer[2048];
7241 yield = string_cat(yield,
7242 parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7243 buffer, sizeof(buffer), FALSE));
7247 /* RFC 2047 decode */
7253 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7254 headers_charset, '?', &len, &error);
7257 expand_string_message = error;
7260 yield = string_catn(yield, decoded, len);
7264 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7274 if (c > 255) c = '_';
7276 yield = string_catn(yield, buff, 1);
7281 /* replace illegal UTF-8 sequences by replacement character */
7283 #define UTF8_REPLACEMENT_CHAR US"?"
7287 int seq_len = 0, index = 0;
7289 long codepoint = -1;
7291 uschar seq_buff[4]; /* accumulate utf-8 here */
7300 if ((c & 0xc0) != 0x80)
7301 /* wrong continuation byte; invalidate all bytes */
7302 complete = 1; /* error */
7305 codepoint = (codepoint << 6) | (c & 0x3f);
7306 seq_buff[index++] = c;
7307 if (--bytes_left == 0) /* codepoint complete */
7308 if(codepoint > 0x10FFFF) /* is it too large? */
7309 complete = -1; /* error (RFC3629 limit) */
7311 { /* finished; output utf-8 sequence */
7312 yield = string_catn(yield, seq_buff, seq_len);
7317 else /* no bytes left: new sequence */
7319 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7321 yield = string_catn(yield, &c, 1);
7324 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7326 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7331 codepoint = c & 0x1f;
7334 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7337 codepoint = c & 0x0f;
7339 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7342 codepoint = c & 0x07;
7344 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7347 seq_buff[index++] = c;
7348 seq_len = bytes_left + 1;
7349 } /* if(bytes_left) */
7353 bytes_left = index = 0;
7354 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7356 if ((complete == 1) && ((c & 0x80) == 0))
7357 /* ASCII character follows incomplete sequence */
7358 yield = string_catn(yield, &c, 1);
7360 /* If given a sequence truncated mid-character, we also want to report ?
7361 * Eg, ${length_1:フィル} is one byte, not one character, so we expect
7362 * ${utf8clean:${length_1:フィル}} to yield '?' */
7363 if (bytes_left != 0)
7365 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7371 case EOP_UTF8_DOMAIN_TO_ALABEL:
7373 uschar * error = NULL;
7374 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7377 expand_string_message = string_sprintf(
7378 "error converting utf8 (%s) to alabel: %s",
7379 string_printing(sub), error);
7382 yield = string_cat(yield, s);
7386 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7388 uschar * error = NULL;
7389 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7392 expand_string_message = string_sprintf(
7393 "error converting alabel (%s) to utf8: %s",
7394 string_printing(sub), error);
7397 yield = string_cat(yield, s);
7401 case EOP_UTF8_LOCALPART_TO_ALABEL:
7403 uschar * error = NULL;
7404 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7407 expand_string_message = string_sprintf(
7408 "error converting utf8 (%s) to alabel: %s",
7409 string_printing(sub), error);
7412 yield = string_cat(yield, s);
7413 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7417 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7419 uschar * error = NULL;
7420 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7423 expand_string_message = string_sprintf(
7424 "error converting alabel (%s) to utf8: %s",
7425 string_printing(sub), error);
7428 yield = string_cat(yield, s);
7431 #endif /* EXPERIMENTAL_INTERNATIONAL */
7433 /* escape turns all non-printing characters into escape sequences. */
7437 const uschar * t = string_printing(sub);
7438 yield = string_cat(yield, t);
7442 case EOP_ESCAPE8BIT:
7446 for (const uschar * s = sub; (c = *s); s++)
7447 yield = c < 127 && c != '\\'
7448 ? string_catn(yield, s, 1)
7449 : string_fmt_append(yield, "\\%03o", c);
7453 /* Handle numeric expression evaluation */
7458 uschar *save_sub = sub;
7459 uschar *error = NULL;
7460 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7463 expand_string_message = string_sprintf("error in expression "
7464 "evaluation: %s (after processing \"%.*s\")", error,
7465 (int)(sub-save_sub), save_sub);
7468 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
7472 /* Handle time period formatting */
7476 int n = readconf_readtime(sub, 0, FALSE);
7479 expand_string_message = string_sprintf("string \"%s\" is not an "
7480 "Exim time interval in \"%s\" operator", sub, name);
7483 yield = string_fmt_append(yield, "%d", n);
7487 case EOP_TIME_INTERVAL:
7490 uschar *t = read_number(&n, sub);
7491 if (*t != 0) /* Not A Number*/
7493 expand_string_message = string_sprintf("string \"%s\" is not a "
7494 "positive number in \"%s\" operator", sub, name);
7497 t = readconf_printtime(n);
7498 yield = string_cat(yield, t);
7502 /* Convert string to base64 encoding */
7508 uschar * s = vp && *(void **)vp->value
7509 ? tls_cert_der_b64(*(void **)vp->value)
7510 : b64encode(sub, Ustrlen(sub));
7512 uschar * s = b64encode(sub, Ustrlen(sub));
7514 yield = string_cat(yield, s);
7521 int len = b64decode(sub, &s);
7524 expand_string_message = string_sprintf("string \"%s\" is not "
7525 "well-formed for \"%s\" operator", sub, name);
7528 yield = string_cat(yield, s);
7532 /* strlen returns the length of the string */
7535 yield = string_fmt_append(yield, "%d", Ustrlen(sub));
7538 /* length_n or l_n takes just the first n characters or the whole string,
7539 whichever is the shorter;
7541 substr_m_n, and s_m_n take n characters from offset m; negative m take
7542 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7543 takes the rest, either to the right or to the left.
7545 hash_n or h_n makes a hash of length n from the string, yielding n
7546 characters from the set a-z; hash_n_m makes a hash of length n, but
7547 uses m characters from the set a-zA-Z0-9.
7549 nhash_n returns a single number between 0 and n-1 (in text form), while
7550 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7551 between 0 and n-1 and the second between 0 and m-1. */
7571 expand_string_message = string_sprintf("missing values after %s",
7576 /* "length" has only one argument, effectively being synonymous with
7579 if (c == EOP_LENGTH || c == EOP_L)
7585 /* The others have one or two arguments; for "substr" the first may be
7586 negative. The second being negative means "not supplied". */
7591 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7594 /* Read up to two numbers, separated by underscores */
7599 if (arg != ret && *arg == '_' && pn == &value1)
7603 if (arg[1] != 0) arg++;
7605 else if (!isdigit(*arg))
7607 expand_string_message =
7608 string_sprintf("non-digit after underscore in \"%s\"", name);
7611 else *pn = (*pn)*10 + *arg++ - '0';
7615 /* Perform the required operation */
7618 (c == EOP_HASH || c == EOP_H)?
7619 compute_hash(sub, value1, value2, &len) :
7620 (c == EOP_NHASH || c == EOP_NH)?
7621 compute_nhash(sub, value1, value2, &len) :
7622 extract_substr(sub, value1, value2, &len);
7624 if (ret == NULL) goto EXPAND_FAILED;
7625 yield = string_catn(yield, ret, len);
7634 uschar **modetable[3];
7638 if (expand_forbid & RDO_EXISTS)
7640 expand_string_message = US"Use of the stat() expansion is not permitted";
7644 if (stat(CS sub, &st) < 0)
7646 expand_string_message = string_sprintf("stat(%s) failed: %s",
7647 sub, strerror(errno));
7651 switch (mode & S_IFMT)
7653 case S_IFIFO: smode[0] = 'p'; break;
7654 case S_IFCHR: smode[0] = 'c'; break;
7655 case S_IFDIR: smode[0] = 'd'; break;
7656 case S_IFBLK: smode[0] = 'b'; break;
7657 case S_IFREG: smode[0] = '-'; break;
7658 default: smode[0] = '?'; break;
7661 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7662 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7663 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7665 for (int i = 0; i < 3; i++)
7667 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7672 yield = string_fmt_append(yield,
7673 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7674 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7675 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7676 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7677 (long)st.st_gid, st.st_size, (long)st.st_atime,
7678 (long)st.st_mtime, (long)st.st_ctime);
7682 /* vaguely random number less than N */
7686 int_eximarith_t max = expanded_string_integer(sub, TRUE);
7688 if (expand_string_message)
7690 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
7694 /* Reverse IP, including IPv6 to dotted-nibble */
7696 case EOP_REVERSE_IP:
7698 int family, maskptr;
7699 uschar reversed[128];
7701 family = string_is_ip_address(sub, &maskptr);
7704 expand_string_message = string_sprintf(
7705 "reverse_ip() not given an IP address [%s]", sub);
7708 invert_address(reversed, sub);
7709 yield = string_cat(yield, reversed);
7713 /* Unknown operator */
7716 expand_string_message =
7717 string_sprintf("unknown expansion operator \"%s\"", name);
7722 /* Handle a plain name. If this is the first thing in the expansion, release
7723 the pre-allocated buffer. If the result data is known to be in a new buffer,
7724 newsize will be set to the size of that buffer, and we can just point at that
7725 store instead of copying. Many expansion strings contain just one reference,
7726 so this is a useful optimization, especially for humungous headers
7727 ($message_headers). */
7736 g = store_get(sizeof(gstring));
7737 else if (yield->ptr == 0)
7739 if (resetok) store_reset(yield);
7741 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
7743 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
7745 expand_string_message =
7746 string_sprintf("unknown variable in \"${%s}\"", name);
7747 check_variable_error_message(name);
7750 len = Ustrlen(value);
7751 if (!yield && newsize)
7754 yield->size = newsize;
7759 yield = string_catn(yield, value, len);
7763 /* Else there's something wrong */
7765 expand_string_message =
7766 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7767 "in a variable reference)", name);
7771 /* If we hit the end of the string when ket_ends is set, there is a missing
7772 terminating brace. */
7774 if (ket_ends && *s == 0)
7776 expand_string_message = malformed_header
7777 ? US"missing } at end of string - could be header name not terminated by colon"
7778 : US"missing } at end of string";
7782 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7783 added to the string. If so, set up an empty string. Add a terminating zero. If
7784 left != NULL, return a pointer to the terminator. */
7787 yield = string_get(1);
7788 (void) string_from_gstring(yield);
7789 if (left) *left = s;
7791 /* Any stacking store that was used above the final string is no longer needed.
7792 In many cases the final string will be the first one that was got and so there
7793 will be optimal store usage. */
7795 if (resetok) store_reset(yield->s + (yield->size = yield->ptr + 1));
7796 else if (resetok_p) *resetok_p = FALSE;
7801 debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
7802 debug_printf_indent("%sresult: %s\n",
7803 skipping ? "|-----" : "\\_____", yield->s);
7805 debug_printf_indent("\\___skipping: result is not used\n");
7809 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
7810 "expanding: %.*s\n",
7811 (int)(s - string), string);
7812 debug_printf_indent("%s"
7813 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7815 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7818 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7819 "skipping: result is not used\n");
7824 /* This is the failure exit: easiest to program with a goto. We still need
7825 to update the pointer to the terminator, for cases of nested calls with "fail".
7828 EXPAND_FAILED_CURLY:
7829 if (malformed_header)
7830 expand_string_message =
7831 US"missing or misplaced { or } - could be header name not terminated by colon";
7833 else if (!expand_string_message || !*expand_string_message)
7834 expand_string_message = US"missing or misplaced { or }";
7836 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7837 that is a bad idea, because expand_string_message is in dynamic store. */
7840 if (left) *left = s;
7844 debug_printf_indent("|failed to expand: %s\n", string);
7845 debug_printf_indent("%serror message: %s\n",
7846 f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
7847 if (f.expand_string_forcedfail)
7848 debug_printf_indent("\\failure was forced\n");
7852 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
7854 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7855 "error message: %s\n",
7856 f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7857 expand_string_message);
7858 if (f.expand_string_forcedfail)
7859 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
7861 if (resetok_p && !resetok) *resetok_p = FALSE;
7867 /* This is the external function call. Do a quick check for any expansion
7868 metacharacters, and if there are none, just return the input string.
7870 Argument: the string to be expanded
7871 Returns: the expanded string, or NULL if expansion failed; if failure was
7872 due to a lookup deferring, search_find_defer will be TRUE
7876 expand_cstring(const uschar * string)
7878 if (Ustrpbrk(string, "$\\") != NULL)
7880 int old_pool = store_pool;
7883 f.search_find_defer = FALSE;
7884 malformed_header = FALSE;
7885 store_pool = POOL_MAIN;
7886 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7887 store_pool = old_pool;
7895 expand_string(uschar * string)
7897 return US expand_cstring(CUS string);
7904 /*************************************************
7906 *************************************************/
7908 /* Now and again we want to expand a string and be sure that the result is in a
7909 new bit of store. This function does that.
7910 Since we know it has been copied, the de-const cast is safe.
7912 Argument: the string to be expanded
7913 Returns: the expanded string, always in a new bit of store, or NULL
7917 expand_string_copy(const uschar *string)
7919 const uschar *yield = expand_cstring(string);
7920 if (yield == string) yield = string_copy(string);
7926 /*************************************************
7927 * Expand and interpret as an integer *
7928 *************************************************/
7930 /* Expand a string, and convert the result into an integer.
7933 string the string to be expanded
7934 isplus TRUE if a non-negative number is expected
7936 Returns: the integer value, or
7937 -1 for an expansion error ) in both cases, message in
7938 -2 for an integer interpretation error ) expand_string_message
7939 expand_string_message is set NULL for an OK integer
7943 expand_string_integer(uschar *string, BOOL isplus)
7945 return expanded_string_integer(expand_string(string), isplus);
7949 /*************************************************
7950 * Interpret string as an integer *
7951 *************************************************/
7953 /* Convert a string (that has already been expanded) into an integer.
7955 This function is used inside the expansion code.
7958 s the string to be expanded
7959 isplus TRUE if a non-negative number is expected
7961 Returns: the integer value, or
7962 -1 if string is NULL (which implies an expansion error)
7963 -2 for an integer interpretation error
7964 expand_string_message is set NULL for an OK integer
7967 static int_eximarith_t
7968 expanded_string_integer(const uschar *s, BOOL isplus)
7970 int_eximarith_t value;
7971 uschar *msg = US"invalid integer \"%s\"";
7974 /* If expansion failed, expand_string_message will be set. */
7976 if (s == NULL) return -1;
7978 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7979 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7980 systems, so we set it zero ourselves. */
7983 expand_string_message = NULL; /* Indicates no error */
7985 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7986 equal to 0. Unfortunately, people actually relied upon that, so preserve
7987 the behaviour explicitly. Stripping leading whitespace is a harmless
7988 noop change since strtol skips it anyway (provided that there is a number
7992 while (isspace(*s)) ++s;
7996 debug_printf_indent("treating blank string as number 0\n");
8001 value = strtoll(CS s, CSS &endptr, 10);
8005 msg = US"integer expected but \"%s\" found";
8007 else if (value < 0 && isplus)
8009 msg = US"non-negative integer expected but \"%s\" found";
8013 switch (tolower(*endptr))
8018 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8023 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8024 else value *= 1024*1024;
8028 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8029 else value *= 1024*1024*1024;
8033 if (errno == ERANGE)
8034 msg = US"absolute value of integer \"%s\" is too large (overflow)";
8037 while (isspace(*endptr)) endptr++;
8038 if (*endptr == 0) return value;
8042 expand_string_message = string_sprintf(CS msg, s);
8047 /* These values are usually fixed boolean values, but they are permitted to be
8051 addr address being routed
8052 mtype the module type
8053 mname the module name
8054 dbg_opt debug selectors
8055 oname the option name
8056 bvalue the router's boolean value
8057 svalue the router's string value
8058 rvalue where to put the returned value
8060 Returns: OK value placed in rvalue
8061 DEFER expansion failed
8065 exp_bool(address_item *addr,
8066 uschar *mtype, uschar *mname, unsigned dbg_opt,
8067 uschar *oname, BOOL bvalue,
8068 uschar *svalue, BOOL *rvalue)
8071 if (svalue == NULL) { *rvalue = bvalue; return OK; }
8073 expanded = expand_string(svalue);
8074 if (expanded == NULL)
8076 if (f.expand_string_forcedfail)
8078 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8082 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8083 oname, mname, mtype, expand_string_message);
8084 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8088 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8091 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8093 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8097 addr->message = string_sprintf("\"%s\" is not a valid value for the "
8098 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8107 /* Avoid potentially exposing a password in a string about to be logged */
8110 expand_hide_passwords(uschar * s)
8112 return ( ( Ustrstr(s, "failed to expand") != NULL
8113 || Ustrstr(s, "expansion of ") != NULL
8115 && ( Ustrstr(s, "mysql") != NULL
8116 || Ustrstr(s, "pgsql") != NULL
8117 || Ustrstr(s, "redis") != NULL
8118 || Ustrstr(s, "sqlite") != NULL
8119 || Ustrstr(s, "ldap:") != NULL
8120 || Ustrstr(s, "ldaps:") != NULL
8121 || Ustrstr(s, "ldapi:") != NULL
8122 || Ustrstr(s, "ldapdn:") != NULL
8123 || Ustrstr(s, "ldapm:") != NULL
8125 ? US"Temporary internal error" : s;
8129 /* Read given named file into big_buffer. Use for keying material etc.
8130 The content will have an ascii NUL appended.
8135 Return: pointer to buffer, or NULL on error.
8139 expand_file_big_buffer(const uschar * filename)
8141 int fd, off = 0, len;
8143 if ((fd = open(CS filename, O_RDONLY)) < 0)
8145 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8152 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8155 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8163 big_buffer[off] = '\0';
8169 /*************************************************
8170 * Error-checking for testsuite *
8171 *************************************************/
8173 uschar * region_start;
8174 uschar * region_end;
8175 const uschar *var_name;
8176 const uschar *var_data;
8180 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8183 if (var_data >= e->region_start && var_data < e->region_end)
8185 e->var_name = CUS var_name;
8186 e->var_data = CUS var_data;
8191 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8193 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8194 .var_name = NULL, .var_data = NULL };
8196 /* check acl_ variables */
8197 tree_walk(acl_var_c, assert_variable_notin, &e);
8198 tree_walk(acl_var_m, assert_variable_notin, &e);
8200 /* check auth<n> variables */
8201 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8202 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
8204 /* check regex<n> variables */
8205 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8206 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
8208 /* check known-name variables */
8209 for (var_entry * v = var_table; v < var_table + var_table_size; v++)
8210 if (v->type == vtype_stringptr)
8211 assert_variable_notin(US v->name, *(USS v->value), &e);
8213 /* check dns and address trees */
8214 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8215 tree_walk(tree_duplicates, assert_variable_notin, &e);
8216 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8217 tree_walk(tree_unusable, assert_variable_notin, &e);
8220 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8221 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8222 e.var_name, filename, linenumber, e.var_data);
8227 /*************************************************
8228 **************************************************
8229 * Stand-alone test program *
8230 **************************************************
8231 *************************************************/
8237 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
8239 int ovector[3*(EXPAND_MAXN+1)];
8240 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8241 ovector, nelem(ovector));
8242 BOOL yield = n >= 0;
8243 if (n == 0) n = EXPAND_MAXN + 1;
8246 expand_nmax = setup < 0 ? 0 : setup + 1;
8247 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8249 expand_nstring[expand_nmax] = subject + ovector[nn];
8250 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8258 int main(int argc, uschar **argv)
8260 uschar buffer[1024];
8262 debug_selector = D_v;
8263 debug_file = stderr;
8264 debug_fd = fileno(debug_file);
8265 big_buffer = malloc(big_buffer_size);
8267 for (int i = 1; i < argc; i++)
8269 if (argv[i][0] == '+')
8271 debug_trace_memory = 2;
8274 if (isdigit(argv[i][0]))
8275 debug_selector = Ustrtol(argv[i], NULL, 0);
8277 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8281 eldap_default_servers = argv[i];
8284 mysql_servers = argv[i];
8287 pgsql_servers = argv[i];
8290 redis_servers = argv[i];
8294 else opt_perl_startup = argv[i];
8298 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8300 expand_nstring[1] = US"string 1....";
8301 expand_nlength[1] = 8;
8305 if (opt_perl_startup != NULL)
8308 printf("Starting Perl interpreter\n");
8309 errstr = init_perl(opt_perl_startup);
8312 printf("** error in perl_startup code: %s\n", errstr);
8313 return EXIT_FAILURE;
8316 #endif /* EXIM_PERL */
8318 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8320 void *reset_point = store_get(0);
8321 uschar *yield = expand_string(buffer);
8324 printf("%s\n", yield);
8325 store_reset(reset_point);
8329 if (f.search_find_defer) printf("search_find deferred\n");
8330 printf("Failed: %s\n", expand_string_message);
8331 if (f.expand_string_forcedfail) printf("Forced failure\n");
8345 /* End of expand.c */