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 { "return_path", vtype_stringptr, &return_path },
664 { "return_size_limit", vtype_int, &bounce_return_size_limit },
665 { "router_name", vtype_stringptr, &router_name },
666 { "runrc", vtype_int, &runrc },
667 { "self_hostname", vtype_stringptr, &self_hostname },
668 { "sender_address", vtype_stringptr, &sender_address },
669 { "sender_address_data", vtype_stringptr, &sender_address_data },
670 { "sender_address_domain", vtype_domain, &sender_address },
671 { "sender_address_local_part", vtype_localpart, &sender_address },
672 { "sender_data", vtype_stringptr, &sender_data },
673 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
674 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
675 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
676 { "sender_host_address", vtype_stringptr, &sender_host_address },
677 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
678 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
679 { "sender_host_name", vtype_host_lookup, NULL },
680 { "sender_host_port", vtype_int, &sender_host_port },
681 { "sender_ident", vtype_stringptr, &sender_ident },
682 { "sender_rate", vtype_stringptr, &sender_rate },
683 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
684 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
685 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
686 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
687 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
688 { "sending_port", vtype_int, &sending_port },
689 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
690 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
691 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
692 { "smtp_command_history", vtype_string_func, &smtp_cmd_hist },
693 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
694 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
695 { "sn0", vtype_filter_int, &filter_sn[0] },
696 { "sn1", vtype_filter_int, &filter_sn[1] },
697 { "sn2", vtype_filter_int, &filter_sn[2] },
698 { "sn3", vtype_filter_int, &filter_sn[3] },
699 { "sn4", vtype_filter_int, &filter_sn[4] },
700 { "sn5", vtype_filter_int, &filter_sn[5] },
701 { "sn6", vtype_filter_int, &filter_sn[6] },
702 { "sn7", vtype_filter_int, &filter_sn[7] },
703 { "sn8", vtype_filter_int, &filter_sn[8] },
704 { "sn9", vtype_filter_int, &filter_sn[9] },
705 #ifdef WITH_CONTENT_SCAN
706 { "spam_action", vtype_stringptr, &spam_action },
707 { "spam_bar", vtype_stringptr, &spam_bar },
708 { "spam_report", vtype_stringptr, &spam_report },
709 { "spam_score", vtype_stringptr, &spam_score },
710 { "spam_score_int", vtype_stringptr, &spam_score_int },
713 { "spf_guess", vtype_stringptr, &spf_guess },
714 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
715 { "spf_received", vtype_stringptr, &spf_received },
716 { "spf_result", vtype_stringptr, &spf_result },
717 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
718 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
720 { "spool_directory", vtype_stringptr, &spool_directory },
721 { "spool_inodes", vtype_pinodes, (void *)TRUE },
722 { "spool_space", vtype_pspace, (void *)TRUE },
723 #ifdef EXPERIMENTAL_SRS
724 { "srs_db_address", vtype_stringptr, &srs_db_address },
725 { "srs_db_key", vtype_stringptr, &srs_db_key },
726 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
727 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
728 { "srs_recipient", vtype_stringptr, &srs_recipient },
729 { "srs_status", vtype_stringptr, &srs_status },
731 { "thisaddress", vtype_stringptr, &filter_thisaddress },
733 /* The non-(in,out) variables are now deprecated */
734 { "tls_bits", vtype_int, &tls_in.bits },
735 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
736 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
738 { "tls_in_bits", vtype_int, &tls_in.bits },
739 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
740 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
741 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
742 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
743 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
744 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
745 #if defined(SUPPORT_TLS)
746 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
748 { "tls_out_bits", vtype_int, &tls_out.bits },
749 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
750 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
752 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
754 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
755 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
756 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
757 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
758 #if defined(SUPPORT_TLS)
759 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
762 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
765 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
766 #if defined(SUPPORT_TLS)
767 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
770 { "tod_bsdinbox", vtype_todbsdin, NULL },
771 { "tod_epoch", vtype_tode, NULL },
772 { "tod_epoch_l", vtype_todel, NULL },
773 { "tod_full", vtype_todf, NULL },
774 { "tod_log", vtype_todl, NULL },
775 { "tod_logfile", vtype_todlf, NULL },
776 { "tod_zone", vtype_todzone, NULL },
777 { "tod_zulu", vtype_todzulu, NULL },
778 { "transport_name", vtype_stringptr, &transport_name },
779 { "value", vtype_stringptr, &lookup_value },
780 { "verify_mode", vtype_stringptr, &verify_mode },
781 { "version_number", vtype_stringptr, &version_string },
782 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
783 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
784 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
785 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
786 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
787 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
790 static int var_table_size = nelem(var_table);
791 static uschar var_buffer[256];
792 static BOOL malformed_header;
794 /* For textual hashes */
796 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
797 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
800 enum { HMAC_MD5, HMAC_SHA1 };
802 /* For numeric hashes */
804 static unsigned int prime[] = {
805 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
806 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
807 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
809 /* For printing modes in symbolic form */
811 static uschar *mtable_normal[] =
812 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
814 static uschar *mtable_setid[] =
815 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
817 static uschar *mtable_sticky[] =
818 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
820 /* flags for find_header() */
821 #define FH_EXISTS_ONLY BIT(0)
822 #define FH_WANT_RAW BIT(1)
823 #define FH_WANT_LIST BIT(2)
826 /*************************************************
827 * Tables for UTF-8 support *
828 *************************************************/
830 /* Table of the number of extra characters, indexed by the first character
831 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
834 static uschar utf8_table1[] = {
835 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
836 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
837 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
838 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
840 /* These are the masks for the data bits in the first byte of a character,
841 indexed by the number of additional bytes. */
843 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
845 /* Get the next UTF-8 character, advancing the pointer. */
847 #define GETUTF8INC(c, ptr) \
849 if ((c & 0xc0) == 0xc0) \
851 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
853 c = (c & utf8_table2[a]) << s; \
857 c |= (*ptr++ & 0x3f) << s; \
863 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
865 /*************************************************
866 * Binary chop search on a table *
867 *************************************************/
869 /* This is used for matching expansion items and operators.
872 name the name that is being sought
873 table the table to search
874 table_size the number of items in the table
876 Returns: the offset in the table, or -1
880 chop_match(uschar *name, uschar **table, int table_size)
882 uschar **bot = table;
883 uschar **top = table + table_size;
887 uschar **mid = bot + (top - bot)/2;
888 int c = Ustrcmp(name, *mid);
889 if (c == 0) return mid - table;
890 if (c > 0) bot = mid + 1; else top = mid;
898 /*************************************************
899 * Check a condition string *
900 *************************************************/
902 /* This function is called to expand a string, and test the result for a "true"
903 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
904 forced fail or lookup defer.
906 We used to release all store used, but this is not not safe due
907 to ${dlfunc } and ${acl }. In any case expand_string_internal()
908 is reasonably careful to release what it can.
910 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
913 condition the condition string
914 m1 text to be incorporated in panic error
917 Returns: TRUE if condition is met, FALSE if not
921 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
924 uschar *ss = expand_string(condition);
927 if (!expand_string_forcedfail && !search_find_defer)
928 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
929 "for %s %s: %s", condition, m1, m2, expand_string_message);
932 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
933 strcmpic(ss, US"false") != 0;
940 /*************************************************
941 * Pseudo-random number generation *
942 *************************************************/
944 /* Pseudo-random number generation. The result is not "expected" to be
945 cryptographically strong but not so weak that someone will shoot themselves
946 in the foot using it as a nonce in some email header scheme or whatever
947 weirdness they'll twist this into. The result should ideally handle fork().
949 However, if we're stuck unable to provide this, then we'll fall back to
950 appallingly bad randomness.
952 If SUPPORT_TLS is defined then this will not be used except as an emergency
957 Returns a random number in range [0, max-1]
961 # define vaguely_random_number vaguely_random_number_fallback
964 vaguely_random_number(int max)
967 # undef vaguely_random_number
969 static pid_t pid = 0;
971 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
981 #ifdef HAVE_ARC4RANDOM
982 /* cryptographically strong randomness, common on *BSD platforms, not
983 so much elsewhere. Alas. */
984 #ifndef NOT_HAVE_ARC4RANDOM_STIR
987 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
988 #ifdef HAVE_SRANDOMDEV
989 /* uses random(4) for seeding */
992 gettimeofday(&tv, NULL);
993 srandom(tv.tv_sec | tv.tv_usec | getpid());
996 /* Poor randomness and no seeding here */
1003 #ifdef HAVE_ARC4RANDOM
1004 return arc4random() % max;
1005 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1006 return random() % max;
1008 /* This one returns a 16-bit number, definitely not crypto-strong */
1009 return random_number(max);
1016 /*************************************************
1017 * Pick out a name from a string *
1018 *************************************************/
1020 /* If the name is too long, it is silently truncated.
1023 name points to a buffer into which to put the name
1024 max is the length of the buffer
1025 s points to the first alphabetic character of the name
1026 extras chars other than alphanumerics to permit
1028 Returns: pointer to the first character after the name
1030 Note: The test for *s != 0 in the while loop is necessary because
1031 Ustrchr() yields non-NULL if the character is zero (which is not something
1034 static const uschar *
1035 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1038 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1040 if (ptr < max-1) name[ptr++] = *s;
1049 /*************************************************
1050 * Pick out the rest of a header name *
1051 *************************************************/
1053 /* A variable name starting $header_ (or just $h_ for those who like
1054 abbreviations) might not be the complete header name because headers can
1055 contain any printing characters in their names, except ':'. This function is
1056 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1057 on the end, if the name was terminated by white space.
1060 name points to a buffer in which the name read so far exists
1061 max is the length of the buffer
1062 s points to the first character after the name so far, i.e. the
1063 first non-alphameric character after $header_xxxxx
1065 Returns: a pointer to the first character after the header name
1068 static const uschar *
1069 read_header_name(uschar *name, int max, const uschar *s)
1071 int prelen = Ustrchr(name, '_') - name + 1;
1072 int ptr = Ustrlen(name) - prelen;
1073 if (ptr > 0) memmove(name, name+prelen, ptr);
1074 while (mac_isgraph(*s) && *s != ':')
1076 if (ptr < max-1) name[ptr++] = *s;
1087 /*************************************************
1088 * Pick out a number from a string *
1089 *************************************************/
1092 n points to an integer into which to put the number
1093 s points to the first digit of the number
1095 Returns: a pointer to the character after the last digit
1097 /*XXX consider expanding to int_eximarith_t. But the test for
1098 "overbig numbers" in 0002 still needs to overflow it. */
1101 read_number(int *n, uschar *s)
1104 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1108 static const uschar *
1109 read_cnumber(int *n, const uschar *s)
1112 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1118 /*************************************************
1119 * Extract keyed subfield from a string *
1120 *************************************************/
1122 /* The yield is in dynamic store; NULL means that the key was not found.
1125 key points to the name of the key
1126 s points to the string from which to extract the subfield
1128 Returns: NULL if the subfield was not found, or
1129 a pointer to the subfield's data
1133 expand_getkeyed(uschar *key, const uschar *s)
1135 int length = Ustrlen(key);
1136 while (isspace(*s)) s++;
1138 /* Loop to search for the key */
1144 const uschar *dkey = s;
1146 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1147 dkeylength = s - dkey;
1148 while (isspace(*s)) s++;
1149 if (*s == '=') while (isspace((*(++s))));
1151 data = string_dequote(&s);
1152 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1155 while (isspace(*s)) s++;
1164 find_var_ent(uschar * name)
1167 int last = var_table_size;
1169 while (last > first)
1171 int middle = (first + last)/2;
1172 int c = Ustrcmp(name, var_table[middle].name);
1174 if (c > 0) { first = middle + 1; continue; }
1175 if (c < 0) { last = middle; continue; }
1176 return &var_table[middle];
1181 /*************************************************
1182 * Extract numbered subfield from string *
1183 *************************************************/
1185 /* Extracts a numbered field from a string that is divided by tokens - for
1186 example a line from /etc/passwd is divided by colon characters. First field is
1187 numbered one. Negative arguments count from the right. Zero returns the whole
1188 string. Returns NULL if there are insufficient tokens in the string
1191 Modifies final argument - this is a dynamically generated string, so that's OK.
1194 field number of field to be extracted,
1195 first field = 1, whole string = 0, last field = -1
1196 separators characters that are used to break string into tokens
1197 s points to the string from which to extract the subfield
1199 Returns: NULL if the field was not found,
1200 a pointer to the field's data inside s (modified to add 0)
1204 expand_gettokened (int field, uschar *separators, uschar *s)
1209 uschar *fieldtext = NULL;
1211 if (field == 0) return s;
1213 /* Break the line up into fields in place; for field > 0 we stop when we have
1214 done the number of fields we want. For field < 0 we continue till the end of
1215 the string, counting the number of fields. */
1217 count = (field > 0)? field : INT_MAX;
1223 /* Previous field was the last one in the string. For a positive field
1224 number, this means there are not enough fields. For a negative field number,
1225 check that there are enough, and scan back to find the one that is wanted. */
1229 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1230 if ((-field) == (INT_MAX - count - 1)) return s;
1234 while (ss[-1] != 0) ss--;
1240 /* Previous field was not last in the string; save its start and put a
1244 len = Ustrcspn(ss, separators);
1255 expand_getlistele(int field, const uschar * list)
1257 const uschar * tlist= list;
1263 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1266 if(field==0) return NULL;
1267 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1268 return string_nextinlist(&list, &sep, NULL, 0);
1272 /* Certificate fields, by name. Worry about by-OID later */
1273 /* Names are chosen to not have common prefixes */
1280 uschar * (*getfn)(void * cert, uschar * mod);
1282 static certfield certfields[] =
1283 { /* linear search; no special order */
1284 { US"version", 7, &tls_cert_version },
1285 { US"serial_number", 13, &tls_cert_serial_number },
1286 { US"subject", 7, &tls_cert_subject },
1287 { US"notbefore", 9, &tls_cert_not_before },
1288 { US"notafter", 8, &tls_cert_not_after },
1289 { US"issuer", 6, &tls_cert_issuer },
1290 { US"signature", 9, &tls_cert_signature },
1291 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1292 { US"subj_altname", 12, &tls_cert_subject_altname },
1293 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1294 { US"crl_uri", 7, &tls_cert_crl_uri },
1298 expand_getcertele(uschar * field, uschar * certvar)
1303 if (!(vp = find_var_ent(certvar)))
1305 expand_string_message =
1306 string_sprintf("no variable named \"%s\"", certvar);
1307 return NULL; /* Unknown variable name */
1309 /* NB this stops us passing certs around in variable. Might
1310 want to do that in future */
1311 if (vp->type != vtype_cert)
1313 expand_string_message =
1314 string_sprintf("\"%s\" is not a certificate", certvar);
1315 return NULL; /* Unknown variable name */
1317 if (!*(void **)vp->value)
1320 if (*field >= '0' && *field <= '9')
1321 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1323 for(cp = certfields;
1324 cp < certfields + nelem(certfields);
1326 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1328 uschar * modifier = *(field += cp->namelen) == ','
1330 return (*cp->getfn)( *(void **)vp->value, modifier );
1333 expand_string_message =
1334 string_sprintf("bad field selector \"%s\" for certextract", field);
1337 #endif /*SUPPORT_TLS*/
1339 /*************************************************
1340 * Extract a substring from a string *
1341 *************************************************/
1343 /* Perform the ${substr or ${length expansion operations.
1346 subject the input string
1347 value1 the offset from the start of the input string to the start of
1348 the output string; if negative, count from the right.
1349 value2 the length of the output string, or negative (-1) for unset
1350 if value1 is positive, unset means "all after"
1351 if value1 is negative, unset means "all before"
1352 len set to the length of the returned string
1354 Returns: pointer to the output string, or NULL if there is an error
1358 extract_substr(uschar *subject, int value1, int value2, int *len)
1360 int sublen = Ustrlen(subject);
1362 if (value1 < 0) /* count from right */
1366 /* If the position is before the start, skip to the start, and adjust the
1367 length. If the length ends up negative, the substring is null because nothing
1368 can precede. This falls out naturally when the length is unset, meaning "all
1374 if (value2 < 0) value2 = 0;
1378 /* Otherwise an unset length => characters before value1 */
1380 else if (value2 < 0)
1387 /* For a non-negative offset, if the starting position is past the end of the
1388 string, the result will be the null string. Otherwise, an unset length means
1389 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1393 if (value1 > sublen)
1398 else if (value2 < 0) value2 = sublen;
1401 /* Cut the length down to the maximum possible for the offset value, and get
1402 the required characters. */
1404 if (value1 + value2 > sublen) value2 = sublen - value1;
1406 return subject + value1;
1412 /*************************************************
1413 * Old-style hash of a string *
1414 *************************************************/
1416 /* Perform the ${hash expansion operation.
1419 subject the input string (an expanded substring)
1420 value1 the length of the output string; if greater or equal to the
1421 length of the input string, the input string is returned
1422 value2 the number of hash characters to use, or 26 if negative
1423 len set to the length of the returned string
1425 Returns: pointer to the output string, or NULL if there is an error
1429 compute_hash(uschar *subject, int value1, int value2, int *len)
1431 int sublen = Ustrlen(subject);
1433 if (value2 < 0) value2 = 26;
1434 else if (value2 > Ustrlen(hashcodes))
1436 expand_string_message =
1437 string_sprintf("hash count \"%d\" too big", value2);
1441 /* Calculate the hash text. We know it is shorter than the original string, so
1442 can safely place it in subject[] (we know that subject is always itself an
1443 expanded substring). */
1445 if (value1 < sublen)
1450 while ((c = (subject[j])) != 0)
1452 int shift = (c + j++) & 7;
1453 subject[i] ^= (c << shift) | (c >> (8-shift));
1454 if (++i >= value1) i = 0;
1456 for (i = 0; i < value1; i++)
1457 subject[i] = hashcodes[(subject[i]) % value2];
1459 else value1 = sublen;
1468 /*************************************************
1469 * Numeric hash of a string *
1470 *************************************************/
1472 /* Perform the ${nhash expansion operation. The first characters of the
1473 string are treated as most important, and get the highest prime numbers.
1476 subject the input string
1477 value1 the maximum value of the first part of the result
1478 value2 the maximum value of the second part of the result,
1479 or negative to produce only a one-part result
1480 len set to the length of the returned string
1482 Returns: pointer to the output string, or NULL if there is an error.
1486 compute_nhash (uschar *subject, int value1, int value2, int *len)
1488 uschar *s = subject;
1490 unsigned long int total = 0; /* no overflow */
1494 if (i == 0) i = nelem(prime) - 1;
1495 total += prime[i--] * (unsigned int)(*s++);
1498 /* If value2 is unset, just compute one number */
1501 s = string_sprintf("%lu", total % value1);
1503 /* Otherwise do a div/mod hash */
1507 total = total % (value1 * value2);
1508 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1519 /*************************************************
1520 * Find the value of a header or headers *
1521 *************************************************/
1523 /* Multiple instances of the same header get concatenated, and this function
1524 can also return a concatenation of all the header lines. When concatenating
1525 specific headers that contain lists of addresses, a comma is inserted between
1526 them. Otherwise we use a straight concatenation. Because some messages can have
1527 pathologically large number of lines, there is a limit on the length that is
1528 returned. Also, to avoid massive store use which would result from using
1529 string_cat() as it copies and extends strings, we do a preliminary pass to find
1530 out exactly how much store will be needed. On "normal" messages this will be
1534 name the name of the header, without the leading $header_ or $h_,
1535 or NULL if a concatenation of all headers is required
1536 newsize return the size of memory block that was obtained; may be NULL
1537 if exists_only is TRUE
1538 flags FH_EXISTS_ONLY
1539 set if called from a def: test; don't need to build a string;
1540 just return a string that is not "" and not "0" if the header
1543 set if called for $rh_ or $rheader_ variables; no processing,
1544 other than concatenating, will be done on the header. Also used
1545 for $message_headers_raw.
1547 Double colon chars in the content, and replace newline with
1548 colon between each element when concatenating; returning a
1549 colon-sep list (elements might contain newlines)
1550 charset name of charset to translate MIME words to; used only if
1551 want_raw is false; if NULL, no translation is done (this is
1552 used for $bh_ and $bheader_)
1554 Returns: NULL if the header does not exist, else a pointer to a new
1559 find_header(uschar *name, int *newsize, unsigned flags, uschar *charset)
1562 int len = name ? Ustrlen(name) : 0;
1567 for (h = header_list; h; h = h->next)
1568 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1569 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1574 if (flags & FH_EXISTS_ONLY)
1575 return US"1"; /* don't need actual string */
1578 s = h->text + len; /* text to insert */
1579 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1580 while (isspace(*s)) s++; /* remove leading white space */
1581 t = h->text + h->slen; /* end-point */
1583 /* Unless wanted raw, remove trailing whitespace, including the
1586 if (flags & FH_WANT_LIST)
1587 while (t > s && t[-1] == '\n') t--;
1588 else if (!(flags & FH_WANT_RAW))
1590 while (t > s && isspace(t[-1])) t--;
1592 /* Set comma if handling a single header and it's one of those
1593 that contains an address list, except when asked for raw headers. Only
1594 need to do this once. */
1596 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1599 /* Trim the header roughly if we're approaching limits */
1601 if ((g ? g->ptr : 0) + inc > header_insert_maxlen)
1602 inc = header_insert_maxlen - (g ? g->ptr : 0);
1604 /* For raw just copy the data; for a list, add the data as a colon-sep
1605 list-element; for comma-list add as an unchecked comma,newline sep
1606 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1607 stripped trailing WS above including the newline). We ignore the potential
1608 expansion due to colon-doubling, just leaving the loop if the limit is met
1611 if (flags & FH_WANT_LIST)
1612 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1613 else if (flags & FH_WANT_RAW)
1615 g = string_catn(g, s, (unsigned)inc);
1616 (void) string_from_gstring(g);
1620 g = string_append2_listele_n(g, US",\n", s, (unsigned)inc);
1622 g = string_append2_listele_n(g, US"\n", s, (unsigned)inc);
1624 if (g && g->ptr >= header_insert_maxlen) break;
1627 if (!found) return NULL; /* No header found */
1628 if (!g) return US"";
1630 /* That's all we do for raw header expansion. */
1633 if (flags & FH_WANT_RAW)
1636 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1637 The rfc2047_decode2() function can return an error with decoded data if the
1638 charset translation fails. If decoding fails, it returns NULL. */
1642 uschar *decoded, *error;
1644 decoded = rfc2047_decode2(g->s, check_rfc2047_length, charset, '?', NULL,
1648 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1649 " input was: %s\n", error, g->s);
1651 return decoded ? decoded : g->s;
1658 /* Append a "local" element to an Authentication-Results: header
1659 if this was a non-smtp message.
1663 authres_local(gstring * g, const uschar * sysname)
1665 if (!authentication_local)
1667 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1668 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1673 /* Append an "iprev" element to an Authentication-Results: header
1674 if we have attempted to get the calling host's name.
1678 authres_iprev(gstring * g)
1680 if (sender_host_name)
1681 return string_append(g, sender_host_address ? 5 : 3,
1682 US";\n\tiprev=pass (", sender_host_name, US")",
1683 US" smtp.client-ip=", sender_host_address);
1684 if (host_lookup_deferred)
1685 return string_catn(g, US";\n\tiprev=temperror", 19);
1686 if (host_lookup_failed)
1687 return string_catn(g, US";\n\tiprev=fail", 13);
1693 /*************************************************
1694 * Return list of recipients *
1695 *************************************************/
1696 /* A recipients list is available only during system message filtering,
1697 during ACL processing after DATA, and while expanding pipe commands
1698 generated from a system filter, but not elsewhere. */
1707 if (!enable_dollar_recipients) return NULL;
1709 for (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 (!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, "%d",
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)
2029 const uschar *s = *sptr;
2031 while (isspace(*s)) s++;
2032 for (i = 0; i < n; i++)
2038 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2039 "(min is %d)", name, m);
2045 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2047 if (*s++ != '}') return 1;
2048 while (isspace(*s)) s++;
2050 if (check_end && *s++ != '}')
2054 expand_string_message = string_sprintf("Too many arguments for '%s' "
2055 "(max is %d)", name, n);
2058 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2069 /*************************************************
2070 * Elaborate message for bad variable *
2071 *************************************************/
2073 /* For the "unknown variable" message, take a look at the variable's name, and
2074 give additional information about possible ACL variables. The extra information
2075 is added on to expand_string_message.
2077 Argument: the name of the variable
2082 check_variable_error_message(uschar *name)
2084 if (Ustrncmp(name, "acl_", 4) == 0)
2085 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2086 (name[4] == 'c' || name[4] == 'm')?
2088 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2089 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2091 US"user-defined ACL variables must start acl_c or acl_m");
2097 Load args from sub array to globals, and call acl_check().
2098 Sub array will be corrupted on return.
2100 Returns: OK access is granted by an ACCEPT verb
2101 DISCARD access is (apparently) granted by a DISCARD verb
2102 FAIL access is denied
2103 FAIL_DROP access is denied; drop the connection
2104 DEFER can't tell at the moment
2108 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2111 int sav_narg = acl_narg;
2113 uschar * dummy_logmsg;
2114 extern int acl_where;
2116 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2117 for (i = 0; i < nsub && sub[i+1]; i++)
2119 uschar * tmp = acl_arg[i];
2120 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2121 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2126 sub[i+1] = acl_arg[i];
2127 acl_arg[i++] = NULL;
2131 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2133 acl_narg>0 ? acl_arg[0] : US"<none>",
2134 acl_narg>1 ? " +more" : "");
2136 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2138 for (i = 0; i < nsub; i++)
2139 acl_arg[i] = sub[i+1]; /* restore old args */
2140 acl_narg = sav_narg;
2148 /*************************************************
2149 * Read and evaluate a condition *
2150 *************************************************/
2154 s points to the start of the condition text
2155 resetok points to a BOOL which is written false if it is unsafe to
2156 free memory. Certain condition types (acl) may have side-effect
2157 allocation which must be preserved.
2158 yield points to a BOOL to hold the result of the condition test;
2159 if NULL, we are just reading through a condition that is
2160 part of an "or" combination to check syntax, or in a state
2161 where the answer isn't required
2163 Returns: a pointer to the first character after the condition, or
2167 static const uschar *
2168 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2170 BOOL testfor = TRUE;
2171 BOOL tempcond, combined_cond;
2173 BOOL sub2_honour_dollar = TRUE;
2174 int i, rc, cond_type, roffset;
2175 int_eximarith_t num[2];
2176 struct stat statbuf;
2178 const uschar *sub[10];
2181 const uschar *rerror;
2185 while (isspace(*s)) s++;
2186 if (*s == '!') { testfor = !testfor; s++; } else break;
2189 /* Numeric comparisons are symbolic */
2191 if (*s == '=' || *s == '>' || *s == '<')
2203 /* All other conditions are named */
2205 else s = read_name(name, 256, s, US"_");
2207 /* If we haven't read a name, it means some non-alpha character is first. */
2211 expand_string_message = string_sprintf("condition name expected, "
2212 "but found \"%.16s\"", s);
2216 /* Find which condition we are dealing with, and switch on it */
2218 cond_type = chop_match(name, cond_table, nelem(cond_table));
2221 /* def: tests for a non-empty variable, or for the existence of a header. If
2222 yield == NULL we are in a skipping state, and don't care about the answer. */
2230 expand_string_message = US"\":\" expected after \"def\"";
2234 s = read_name(name, 256, s+1, US"_");
2236 /* Test for a header's existence. If the name contains a closing brace
2237 character, this may be a user error where the terminating colon has been
2238 omitted. Set a flag to adjust a subsequent error message in this case. */
2240 if ( ( *(t = name) == 'h'
2241 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2243 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2246 s = read_header_name(name, 256, s);
2247 /* {-for-text-editors */
2248 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2250 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2253 /* Test for a variable's having a non-empty value. A non-existent variable
2254 causes an expansion failure. */
2258 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2260 expand_string_message = (name[0] == 0)?
2261 string_sprintf("variable name omitted after \"def:\"") :
2262 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2263 check_variable_error_message(name);
2266 if (yield) *yield = (t[0] != 0) == testfor;
2273 /* first_delivery tests for first delivery attempt */
2275 case ECOND_FIRST_DELIVERY:
2276 if (yield != NULL) *yield = deliver_firsttime == testfor;
2280 /* queue_running tests for any process started by a queue runner */
2282 case ECOND_QUEUE_RUNNING:
2283 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2287 /* exists: tests for file existence
2288 isip: tests for any IP address
2289 isip4: tests for an IPv4 address
2290 isip6: tests for an IPv6 address
2291 pam: does PAM authentication
2292 radius: does RADIUS authentication
2293 ldapauth: does LDAP authentication
2294 pwcheck: does Cyrus SASL pwcheck authentication
2303 case ECOND_LDAPAUTH:
2306 while (isspace(*s)) s++;
2307 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2309 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2310 if (sub[0] == NULL) return NULL;
2311 /* {-for-text-editors */
2312 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2314 if (yield == NULL) return s; /* No need to run the test if skipping */
2319 if ((expand_forbid & RDO_EXISTS) != 0)
2321 expand_string_message = US"File existence tests are not permitted";
2324 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2330 rc = string_is_ip_address(sub[0], NULL);
2331 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2332 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2335 /* Various authentication tests - all optionally compiled */
2339 rc = auth_call_pam(sub[0], &expand_string_message);
2342 goto COND_FAILED_NOT_COMPILED;
2343 #endif /* SUPPORT_PAM */
2346 #ifdef RADIUS_CONFIG_FILE
2347 rc = auth_call_radius(sub[0], &expand_string_message);
2350 goto COND_FAILED_NOT_COMPILED;
2351 #endif /* RADIUS_CONFIG_FILE */
2353 case ECOND_LDAPAUTH:
2356 /* Just to keep the interface the same */
2358 int old_pool = store_pool;
2359 store_pool = POOL_SEARCH;
2360 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2361 &expand_string_message, &do_cache);
2362 store_pool = old_pool;
2366 goto COND_FAILED_NOT_COMPILED;
2367 #endif /* LOOKUP_LDAP */
2370 #ifdef CYRUS_PWCHECK_SOCKET
2371 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2374 goto COND_FAILED_NOT_COMPILED;
2375 #endif /* CYRUS_PWCHECK_SOCKET */
2377 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2378 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2380 if (rc == ERROR || rc == DEFER) return NULL;
2381 *yield = (rc == OK) == testfor;
2387 /* call ACL (in a conditional context). Accept true, deny false.
2388 Defer is a forced-fail. Anything set by message= goes to $value.
2389 Up to ten parameters are used; we use the braces round the name+args
2390 like the saslauthd condition does, to permit a variable number of args.
2391 See also the expansion-item version EITEM_ACL and the traditional
2392 acl modifier ACLC_ACL.
2393 Since the ACL may allocate new global variables, tell our caller to not
2398 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2404 while (isspace(*s)) s++;
2405 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2407 switch(read_subs(sub, nelem(sub), 1,
2408 &s, yield == NULL, TRUE, US"acl", resetok))
2410 case 1: expand_string_message = US"too few arguments or bracketing "
2413 case 3: return NULL;
2418 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2419 switch(eval_acl(sub, nelem(sub), &user_msg))
2424 lookup_value = NULL;
2426 lookup_value = string_copy(user_msg);
2427 *yield = cond == testfor;
2431 expand_string_forcedfail = TRUE;
2434 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2442 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2444 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2446 However, the last two are optional. That is why the whole set is enclosed
2447 in their own set of braces. */
2449 case ECOND_SASLAUTHD:
2450 #ifndef CYRUS_SASLAUTHD_SOCKET
2451 goto COND_FAILED_NOT_COMPILED;
2455 while (isspace(*s)) s++;
2456 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2457 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2460 case 1: expand_string_message = US"too few arguments or bracketing "
2461 "error for saslauthd";
2463 case 3: return NULL;
2465 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2468 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2469 &expand_string_message);
2470 if (rc == ERROR || rc == DEFER) return NULL;
2471 *yield = (rc == OK) == testfor;
2475 #endif /* CYRUS_SASLAUTHD_SOCKET */
2478 /* symbolic operators for numeric and string comparison, and a number of
2479 other operators, all requiring two arguments.
2481 crypteq: encrypts plaintext and compares against an encrypted text,
2482 using crypt(), crypt16(), MD5 or SHA-1
2483 inlist/inlisti: checks if first argument is in the list of the second
2484 match: does a regular expression match and sets up the numerical
2485 variables if it succeeds
2486 match_address: matches in an address list
2487 match_domain: matches in a domain list
2488 match_ip: matches a host list that is restricted to IP addresses
2489 match_local_part: matches in a local part list
2492 case ECOND_MATCH_ADDRESS:
2493 case ECOND_MATCH_DOMAIN:
2494 case ECOND_MATCH_IP:
2495 case ECOND_MATCH_LOCAL_PART:
2496 #ifndef EXPAND_LISTMATCH_RHS
2497 sub2_honour_dollar = FALSE;
2506 case ECOND_NUM_L: /* Numerical comparisons */
2513 case ECOND_STR_LT: /* String comparisons */
2524 for (i = 0; i < 2; i++)
2526 /* Sometimes, we don't expand substrings; too many insecure configurations
2527 created using match_address{}{} and friends, where the second param
2528 includes information from untrustworthy sources. */
2529 BOOL honour_dollar = TRUE;
2530 if ((i > 0) && !sub2_honour_dollar)
2531 honour_dollar = FALSE;
2533 while (isspace(*s)) s++;
2536 if (i == 0) goto COND_FAILED_CURLY_START;
2537 expand_string_message = string_sprintf("missing 2nd string in {} "
2538 "after \"%s\"", name);
2541 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2542 honour_dollar, resetok)))
2544 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2545 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2546 " for security reasons\n");
2547 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2549 /* Convert to numerical if required; we know that the names of all the
2550 conditions that compare numbers do not start with a letter. This just saves
2551 checking for them individually. */
2553 if (!isalpha(name[0]) && yield != NULL)
2558 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2562 num[i] = expanded_string_integer(sub[i], FALSE);
2563 if (expand_string_message != NULL) return NULL;
2567 /* Result not required */
2569 if (yield == NULL) return s;
2571 /* Do an appropriate comparison */
2577 tempcond = (num[0] == num[1]);
2581 tempcond = (num[0] > num[1]);
2585 tempcond = (num[0] >= num[1]);
2589 tempcond = (num[0] < num[1]);
2593 tempcond = (num[0] <= num[1]);
2597 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2601 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2605 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2609 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2613 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2617 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2621 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2625 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2629 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2633 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2636 case ECOND_MATCH: /* Regular expression match */
2637 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2641 expand_string_message = string_sprintf("regular expression error in "
2642 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2645 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2648 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2649 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2650 goto MATCHED_SOMETHING;
2652 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2653 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2654 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2655 goto MATCHED_SOMETHING;
2657 case ECOND_MATCH_IP: /* Match IP address in a host list */
2658 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2660 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2666 unsigned int *nullcache = NULL;
2667 check_host_block cb;
2669 cb.host_name = US"";
2670 cb.host_address = sub[0];
2672 /* If the host address starts off ::ffff: it is an IPv6 address in
2673 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2676 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2677 cb.host_address + 7 : cb.host_address;
2679 rc = match_check_list(
2680 &sub[1], /* the list */
2681 0, /* separator character */
2682 &hostlist_anchor, /* anchor pointer */
2683 &nullcache, /* cache pointer */
2684 check_host, /* function for testing */
2685 &cb, /* argument for function */
2686 MCL_HOST, /* type of check */
2687 sub[0], /* text for debugging */
2688 NULL); /* where to pass back data */
2690 goto MATCHED_SOMETHING;
2692 case ECOND_MATCH_LOCAL_PART:
2693 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2694 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2709 expand_string_message = string_sprintf("unable to complete match "
2710 "against \"%s\": %s", sub[1], search_error_message);
2716 /* Various "encrypted" comparisons. If the second string starts with
2717 "{" then an encryption type is given. Default to crypt() or crypt16()
2718 (build-time choice). */
2719 /* }-for-text-editors */
2722 #ifndef SUPPORT_CRYPTEQ
2723 goto COND_FAILED_NOT_COMPILED;
2725 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2727 int sublen = Ustrlen(sub[1]+5);
2732 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2734 /* If the length that we are comparing against is 24, the MD5 digest
2735 is expressed as a base64 string. This is the way LDAP does it. However,
2736 some other software uses a straightforward hex representation. We assume
2737 this if the length is 32. Other lengths fail. */
2741 uschar *coded = b64encode(digest, 16);
2742 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2743 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2744 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2746 else if (sublen == 32)
2750 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2752 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2753 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2754 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2758 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2759 "fail\n crypted=%s\n", sub[1]+5);
2764 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2766 int sublen = Ustrlen(sub[1]+6);
2771 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2773 /* If the length that we are comparing against is 28, assume the SHA1
2774 digest is expressed as a base64 string. If the length is 40, assume a
2775 straightforward hex representation. Other lengths fail. */
2779 uschar *coded = b64encode(digest, 20);
2780 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2781 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2782 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2784 else if (sublen == 40)
2788 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2790 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2791 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2792 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2796 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2797 "fail\n crypted=%s\n", sub[1]+6);
2802 else /* {crypt} or {crypt16} and non-{ at start */
2803 /* }-for-text-editors */
2808 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2813 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2818 else if (sub[1][0] == '{') /* }-for-text-editors */
2820 expand_string_message = string_sprintf("unknown encryption mechanism "
2821 "in \"%s\"", sub[1]);
2827 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2828 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2829 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2833 #define XSTR(s) STR(s)
2834 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2835 " subject=%s\n crypted=%s\n",
2836 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2841 /* If the encrypted string contains fewer than two characters (for the
2842 salt), force failure. Otherwise we get false positives: with an empty
2843 string the yield of crypt() is an empty string! */
2846 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2847 else if (errno == EINVAL)
2851 expand_string_message = string_sprintf("crypt error: %s\n",
2852 US strerror(errno));
2857 #endif /* SUPPORT_CRYPTEQ */
2862 const uschar * list = sub[1];
2864 uschar *save_iterate_item = iterate_item;
2865 int (*compare)(const uschar *, const uschar *);
2867 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", name, sub[0]);
2870 compare = cond_type == ECOND_INLISTI
2871 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2873 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2875 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
2876 if (compare(sub[0], iterate_item) == 0)
2882 iterate_item = save_iterate_item;
2885 } /* Switch for comparison conditions */
2887 *yield = tempcond == testfor;
2888 return s; /* End of comparison conditions */
2891 /* and/or: computes logical and/or of several conditions */
2895 subcondptr = (yield == NULL)? NULL : &tempcond;
2896 combined_cond = (cond_type == ECOND_AND);
2898 while (isspace(*s)) s++;
2899 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2903 while (isspace(*s)) s++;
2904 /* {-for-text-editors */
2905 if (*s == '}') break;
2906 if (*s != '{') /* }-for-text-editors */
2908 expand_string_message = string_sprintf("each subcondition "
2909 "inside an \"%s{...}\" condition must be in its own {}", name);
2913 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2915 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2916 expand_string_message, name);
2919 while (isspace(*s)) s++;
2921 /* {-for-text-editors */
2924 /* {-for-text-editors */
2925 expand_string_message = string_sprintf("missing } at end of condition "
2926 "inside \"%s\" group", name);
2932 if (cond_type == ECOND_AND)
2934 combined_cond &= tempcond;
2935 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2936 } /* evaluate any more */
2939 combined_cond |= tempcond;
2940 if (combined_cond) subcondptr = NULL; /* once true, don't */
2941 } /* evaluate any more */
2945 if (yield != NULL) *yield = (combined_cond == testfor);
2949 /* forall/forany: iterates a condition with different values */
2954 const uschar * list;
2956 uschar *save_iterate_item = iterate_item;
2958 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2960 while (isspace(*s)) s++;
2961 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2962 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2963 if (sub[0] == NULL) return NULL;
2964 /* {-for-text-editors */
2965 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2967 while (isspace(*s)) s++;
2968 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2972 /* Call eval_condition once, with result discarded (as if scanning a
2973 "false" part). This allows us to find the end of the condition, because if
2974 the list it empty, we won't actually evaluate the condition for real. */
2976 if (!(s = eval_condition(sub[1], resetok, NULL)))
2978 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2979 expand_string_message, name);
2982 while (isspace(*s)) s++;
2984 /* {-for-text-editors */
2987 /* {-for-text-editors */
2988 expand_string_message = string_sprintf("missing } at end of condition "
2989 "inside \"%s\"", name);
2993 if (yield != NULL) *yield = !testfor;
2995 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2997 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, iterate_item);
2998 if (!eval_condition(sub[1], resetok, &tempcond))
3000 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3001 expand_string_message, name);
3002 iterate_item = save_iterate_item;
3005 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", name,
3006 tempcond? "true":"false");
3008 if (yield != NULL) *yield = (tempcond == testfor);
3009 if (tempcond == (cond_type == ECOND_FORANY)) break;
3012 iterate_item = save_iterate_item;
3017 /* The bool{} expansion condition maps a string to boolean.
3018 The values supported should match those supported by the ACL condition
3019 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3020 of true/false. Note that Router "condition" rules have a different
3021 interpretation, where general data can be used and only a few values
3023 Note that readconf.c boolean matching, for boolean configuration options,
3024 only matches true/yes/false/no.
3025 The bool_lax{} condition matches the Router logic, which is much more
3028 case ECOND_BOOL_LAX:
3034 BOOL boolvalue = FALSE;
3035 while (isspace(*s)) s++;
3036 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3037 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3038 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3040 case 1: expand_string_message = string_sprintf(
3041 "too few arguments or bracketing error for %s",
3045 case 3: return NULL;
3048 while (isspace(*t)) t++;
3052 /* trailing whitespace: seems like a good idea to ignore it too */
3054 while (isspace(*t2)) t2--;
3055 if (t2 != (t + len))
3062 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3063 /* logic for the lax case from expand_check_condition(), which also does
3064 expands, and the logic is both short and stable enough that there should
3065 be no maintenance burden from replicating it. */
3069 ? Ustrspn(t+1, "0123456789") == len-1
3070 : Ustrspn(t, "0123456789") == len)
3072 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3073 /* expand_check_condition only does a literal string "0" check */
3074 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3077 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3079 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3081 else if (cond_type == ECOND_BOOL_LAX)
3085 expand_string_message = string_sprintf("unrecognised boolean "
3089 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3090 boolvalue? "true":"false");
3091 if (yield != NULL) *yield = (boolvalue == testfor);
3095 /* Unknown condition */
3098 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3100 } /* End switch on condition type */
3102 /* Missing braces at start and end of data */
3104 COND_FAILED_CURLY_START:
3105 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3108 COND_FAILED_CURLY_END:
3109 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3113 /* A condition requires code that is not compiled */
3115 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3116 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3117 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3118 COND_FAILED_NOT_COMPILED:
3119 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3128 /*************************************************
3129 * Save numerical variables *
3130 *************************************************/
3132 /* This function is called from items such as "if" that want to preserve and
3133 restore the numbered variables.
3136 save_expand_string points to an array of pointers to set
3137 save_expand_nlength points to an array of ints for the lengths
3139 Returns: the value of expand max to save
3143 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3146 for (i = 0; i <= expand_nmax; i++)
3148 save_expand_nstring[i] = expand_nstring[i];
3149 save_expand_nlength[i] = expand_nlength[i];
3156 /*************************************************
3157 * Restore numerical variables *
3158 *************************************************/
3160 /* This function restored saved values of numerical strings.
3163 save_expand_nmax the number of strings to restore
3164 save_expand_string points to an array of pointers
3165 save_expand_nlength points to an array of ints
3171 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3172 int *save_expand_nlength)
3175 expand_nmax = save_expand_nmax;
3176 for (i = 0; i <= expand_nmax; i++)
3178 expand_nstring[i] = save_expand_nstring[i];
3179 expand_nlength[i] = save_expand_nlength[i];
3187 /*************************************************
3188 * Handle yes/no substrings *
3189 *************************************************/
3191 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3192 alternative substrings that depend on whether or not the condition was true,
3193 or the lookup or extraction succeeded. The substrings always have to be
3194 expanded, to check their syntax, but "skipping" is set when the result is not
3195 needed - this avoids unnecessary nested lookups.
3198 skipping TRUE if we were skipping when this item was reached
3199 yes TRUE if the first string is to be used, else use the second
3200 save_lookup a value to put back into lookup_value before the 2nd expansion
3201 sptr points to the input string pointer
3202 yieldptr points to the output growable-string pointer
3203 type "lookup", "if", "extract", "run", "env", "listextract" or
3204 "certextract" for error message
3205 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3208 Returns: 0 OK; lookup_value has been reset to save_lookup
3210 2 expansion failed because of bracketing error
3214 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3215 gstring ** yieldptr, uschar *type, BOOL *resetok)
3218 const uschar *s = *sptr; /* Local value */
3219 uschar *sub1, *sub2;
3220 const uschar * errwhere;
3222 /* If there are no following strings, we substitute the contents of $value for
3223 lookups and for extractions in the success case. For the ${if item, the string
3224 "true" is substituted. In the fail case, nothing is substituted for all three
3227 while (isspace(*s)) s++;
3232 if (yes && !skipping)
3233 *yieldptr = string_catn(*yieldptr, US"true", 4);
3237 if (yes && lookup_value && !skipping)
3238 *yieldptr = string_cat(*yieldptr, lookup_value);
3239 lookup_value = save_lookup;
3245 /* The first following string must be braced. */
3249 errwhere = US"'yes' part did not start with '{'";
3253 /* Expand the first substring. Forced failures are noticed only if we actually
3254 want this string. Set skipping in the call in the fail case (this will always
3255 be the case if we were already skipping). */
3257 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3258 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3259 expand_string_forcedfail = FALSE;
3262 errwhere = US"'yes' part did not end with '}'";
3266 /* If we want the first string, add it to the output */
3269 *yieldptr = string_cat(*yieldptr, sub1);
3271 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3272 $value to what it was at the start of the item, so that it has this value
3273 during the second string expansion. For the call from "if" or "run" to this
3274 function, save_lookup is set to lookup_value, so that this statement does
3277 lookup_value = save_lookup;
3279 /* There now follows either another substring, or "fail", or nothing. This
3280 time, forced failures are noticed only if we want the second string. We must
3281 set skipping in the nested call if we don't want this string, or if we were
3282 already skipping. */
3284 while (isspace(*s)) s++;
3287 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3288 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3289 expand_string_forcedfail = FALSE;
3292 errwhere = US"'no' part did not start with '{'";
3296 /* If we want the second string, add it to the output */
3299 *yieldptr = string_cat(*yieldptr, sub2);
3302 /* If there is no second string, but the word "fail" is present when the use of
3303 the second string is wanted, set a flag indicating it was a forced failure
3304 rather than a syntactic error. Swallow the terminating } in case this is nested
3305 inside another lookup or if or extract. */
3310 /* deconst cast ok here as source is s anyway */
3311 s = US read_name(name, sizeof(name), s, US"_");
3312 if (Ustrcmp(name, "fail") == 0)
3314 if (!yes && !skipping)
3316 while (isspace(*s)) s++;
3319 errwhere = US"did not close with '}' after forcedfail";
3322 expand_string_message =
3323 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3324 expand_string_forcedfail = TRUE;
3330 expand_string_message =
3331 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3336 /* All we have to do now is to check on the final closing brace. */
3338 while (isspace(*s)) s++;
3341 errwhere = US"did not close with '}'";
3347 /* Update the input pointer value before returning */
3352 /* Get here if there is a bracketing failure */
3353 expand_string_message = string_sprintf(
3354 "curly-bracket problem in conditional yes/no parsing: %s\n"
3355 " remaining string is '%s'", errwhere, --s);
3360 /* Get here for other failures */
3368 /*************************************************
3369 * Handle MD5 or SHA-1 computation for HMAC *
3370 *************************************************/
3372 /* These are some wrapping functions that enable the HMAC code to be a bit
3373 cleaner. A good compiler will spot the tail recursion.
3376 type HMAC_MD5 or HMAC_SHA1
3377 remaining are as for the cryptographic hash functions
3383 chash_start(int type, void *base)
3385 if (type == HMAC_MD5)
3386 md5_start((md5 *)base);
3388 sha1_start((hctx *)base);
3392 chash_mid(int type, void *base, uschar *string)
3394 if (type == HMAC_MD5)
3395 md5_mid((md5 *)base, string);
3397 sha1_mid((hctx *)base, string);
3401 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3403 if (type == HMAC_MD5)
3404 md5_end((md5 *)base, string, length, digest);
3406 sha1_end((hctx *)base, string, length, digest);
3413 /********************************************************
3414 * prvs: Get last three digits of days since Jan 1, 1970 *
3415 ********************************************************/
3417 /* This is needed to implement the "prvs" BATV reverse
3420 Argument: integer "days" offset to add or substract to
3421 or from the current number of days.
3423 Returns: pointer to string containing the last three
3424 digits of the number of days since Jan 1, 1970,
3425 modified by the offset argument, NULL if there
3426 was an error in the conversion.
3431 prvs_daystamp(int day_offset)
3433 uschar *days = store_get(32); /* Need at least 24 for cases */
3434 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3435 (time(NULL) + day_offset*86400)/86400);
3436 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3441 /********************************************************
3442 * prvs: perform HMAC-SHA1 computation of prvs bits *
3443 ********************************************************/
3445 /* This is needed to implement the "prvs" BATV reverse
3449 address RFC2821 Address to use
3450 key The key to use (must be less than 64 characters
3452 key_num Single-digit key number to use. Defaults to
3455 Returns: pointer to string containing the first three
3456 bytes of the final hash in hex format, NULL if
3457 there was an error in the process.
3461 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3463 gstring * hash_source;
3467 uschar innerhash[20];
3468 uschar finalhash[20];
3469 uschar innerkey[64];
3470 uschar outerkey[64];
3471 uschar *finalhash_hex = store_get(40);
3473 if (key_num == NULL)
3476 if (Ustrlen(key) > 64)
3479 hash_source = string_catn(NULL, key_num, 1);
3480 hash_source = string_catn(hash_source, daystamp, 3);
3481 hash_source = string_cat(hash_source, address);
3482 (void) string_from_gstring(hash_source);
3485 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3487 memset(innerkey, 0x36, 64);
3488 memset(outerkey, 0x5c, 64);
3490 for (i = 0; i < Ustrlen(key); i++)
3492 innerkey[i] ^= key[i];
3493 outerkey[i] ^= key[i];
3496 chash_start(HMAC_SHA1, &h);
3497 chash_mid(HMAC_SHA1, &h, innerkey);
3498 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3500 chash_start(HMAC_SHA1, &h);
3501 chash_mid(HMAC_SHA1, &h, outerkey);
3502 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3505 for (i = 0; i < 3; i++)
3507 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3508 *p++ = hex_digits[finalhash[i] & 0x0f];
3512 return finalhash_hex;
3518 /*************************************************
3519 * Join a file onto the output string *
3520 *************************************************/
3522 /* This is used for readfile/readsock and after a run expansion.
3523 It joins the contents of a file onto the output string, globally replacing
3524 newlines with a given string (optionally).
3528 yield pointer to the expandable string struct
3529 eol newline replacement string, or NULL
3531 Returns: new pointer for expandable string, terminated if non-null
3535 cat_file(FILE *f, gstring *yield, uschar *eol)
3537 uschar buffer[1024];
3539 while (Ufgets(buffer, sizeof(buffer), f))
3541 int len = Ustrlen(buffer);
3542 if (eol && buffer[len-1] == '\n') len--;
3543 yield = string_catn(yield, buffer, len);
3544 if (eol && buffer[len])
3545 yield = string_cat(yield, eol);
3548 (void) string_from_gstring(yield);
3555 /*************************************************
3556 * Evaluate numeric expression *
3557 *************************************************/
3559 /* This is a set of mutually recursive functions that evaluate an arithmetic
3560 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3561 these functions that is called from elsewhere is eval_expr, whose interface is:
3564 sptr pointer to the pointer to the string - gets updated
3565 decimal TRUE if numbers are to be assumed decimal
3566 error pointer to where to put an error message - must be NULL on input
3567 endket TRUE if ')' must terminate - FALSE for external call
3569 Returns: on success: the value of the expression, with *error still NULL
3570 on failure: an undefined value, with *error = a message
3573 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3576 static int_eximarith_t
3577 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3580 int_eximarith_t x = eval_op_or(&s, decimal, error);
3586 *error = US"expecting closing parenthesis";
3588 while (isspace(*(++s)));
3590 else if (*s != 0) *error = US"expecting operator";
3597 static int_eximarith_t
3598 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3603 while (isspace(*s)) s++;
3608 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3610 switch (tolower(*s))
3613 case 'k': n *= 1024; s++; break;
3614 case 'm': n *= 1024*1024; s++; break;
3615 case 'g': n *= 1024*1024*1024; s++; break;
3617 while (isspace (*s)) s++;
3622 n = eval_expr(&s, decimal, error, 1);
3626 *error = US"expecting number or opening parenthesis";
3634 static int_eximarith_t
3635 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3639 while (isspace(*s)) s++;
3640 if (*s == '+' || *s == '-' || *s == '~')
3643 x = eval_op_unary(&s, decimal, error);
3644 if (op == '-') x = -x;
3645 else if (op == '~') x = ~x;
3649 x = eval_number(&s, decimal, error);
3656 static int_eximarith_t
3657 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3660 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3663 while (*s == '*' || *s == '/' || *s == '%')
3666 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3667 if (*error != NULL) break;
3668 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3669 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3670 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3671 * -N*M is INT_MIN will yield INT_MIN.
3672 * Since we don't support floating point, this is somewhat simpler.
3673 * Ideally, we'd return an error, but since we overflow for all other
3674 * arithmetic, consistency suggests otherwise, but what's the correct value
3675 * to use? There is none.
3676 * The C standard guarantees overflow for unsigned arithmetic but signed
3677 * overflow invokes undefined behaviour; in practice, this is overflow
3678 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3679 * that long/longlong larger than int are available, or we could just work
3680 * with larger types. We should consider whether to guarantee 32bit eval
3681 * and 64-bit working variables, with errors returned. For now ...
3682 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3683 * can just let the other invalid results occur otherwise, as they have
3684 * until now. For this one case, we can coerce.
3686 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3689 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3690 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3700 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3716 static int_eximarith_t
3717 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3720 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3723 while (*s == '+' || *s == '-')
3726 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3728 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3729 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3730 { /* over-conservative check */
3732 ? US"overflow in sum" : US"overflow in difference";
3735 if (op == '+') x += y; else x -= y;
3743 static int_eximarith_t
3744 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3747 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3750 while ((*s == '<' || *s == '>') && s[1] == s[0])
3755 y = eval_op_sum(&s, decimal, error);
3756 if (*error != NULL) break;
3757 if (op == '<') x <<= y; else x >>= y;
3765 static int_eximarith_t
3766 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3769 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3776 y = eval_op_shift(&s, decimal, error);
3777 if (*error != NULL) break;
3786 static int_eximarith_t
3787 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3790 int_eximarith_t x = eval_op_and(&s, decimal, error);
3797 y = eval_op_and(&s, decimal, error);
3798 if (*error != NULL) break;
3807 static int_eximarith_t
3808 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3811 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3818 y = eval_op_xor(&s, decimal, error);
3819 if (*error != NULL) break;
3829 /*************************************************
3831 *************************************************/
3833 /* Returns either an unchanged string, or the expanded string in stacking pool
3834 store. Interpreted sequences are:
3836 \... normal escaping rules
3837 $name substitutes the variable
3839 ${op:string} operates on the expanded string value
3840 ${item{arg1}{arg2}...} expands the args and then does the business
3841 some literal args are not enclosed in {}
3843 There are now far too many operators and item types to make it worth listing
3844 them here in detail any more.
3846 We use an internal routine recursively to handle embedded substrings. The
3847 external function follows. The yield is NULL if the expansion failed, and there
3848 are two cases: if something collapsed syntactically, or if "fail" was given
3849 as the action on a lookup failure. These can be distinguished by looking at the
3850 variable expand_string_forcedfail, which is TRUE in the latter case.
3852 The skipping flag is set true when expanding a substring that isn't actually
3853 going to be used (after "if" or "lookup") and it prevents lookups from
3854 happening lower down.
3856 Store usage: At start, a store block of the length of the input plus 64
3857 is obtained. This is expanded as necessary by string_cat(), which might have to
3858 get a new block, or might be able to expand the original. At the end of the
3859 function we can release any store above that portion of the yield block that
3860 was actually used. In many cases this will be optimal.
3862 However: if the first item in the expansion is a variable name or header name,
3863 we reset the store before processing it; if the result is in fresh store, we
3864 use that without copying. This is helpful for expanding strings like
3865 $message_headers which can get very long.
3867 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3868 since resetting the store at the end of the expansion will free store that was
3869 allocated by the plugin code as well as the slop after the expanded string. So
3870 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3871 and, given the acl condition, ${if }. This is an unfortunate consequence of
3872 string expansion becoming too powerful.
3875 string the string to be expanded
3876 ket_ends true if expansion is to stop at }
3877 left if not NULL, a pointer to the first character after the
3878 expansion is placed here (typically used with ket_ends)
3879 skipping TRUE for recursive calls when the value isn't actually going
3880 to be used (to allow for optimisation)
3881 honour_dollar TRUE if $ is to be expanded,
3882 FALSE if it's just another character
3883 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3886 Returns: NULL if expansion fails:
3887 expand_string_forcedfail is set TRUE if failure was forced
3888 expand_string_message contains a textual error message
3889 a pointer to the expanded string on success
3893 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3894 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3896 gstring * yield = string_get(Ustrlen(string) + 64);
3898 const uschar *s = string;
3899 uschar *save_expand_nstring[EXPAND_MAXN+1];
3900 int save_expand_nlength[EXPAND_MAXN+1];
3901 BOOL resetok = TRUE;
3905 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
3907 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
3911 expand_string_forcedfail = FALSE;
3912 expand_string_message = US"";
3919 /* \ escapes the next character, which must exist, or else
3920 the expansion fails. There's a special escape, \N, which causes
3921 copying of the subject verbatim up to the next \N. Otherwise,
3922 the escapes are the standard set. */
3928 expand_string_message = US"\\ at end of string";
3934 const uschar * t = s + 2;
3935 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3936 yield = string_catn(yield, t, s - t);
3937 if (*s != 0) s += 2;
3943 ch[0] = string_interpret_escape(&s);
3945 yield = string_catn(yield, ch, 1);
3952 /* Anything other than $ is just copied verbatim, unless we are
3953 looking for a terminating } character. */
3956 if (ket_ends && *s == '}') break;
3958 if (*s != '$' || !honour_dollar)
3960 yield = string_catn(yield, s++, 1);
3964 /* No { after the $ - must be a plain name or a number for string
3965 match variable. There has to be a fudge for variables that are the
3966 names of header fields preceded by "$header_" because header field
3967 names can contain any printing characters except space and colon.
3968 For those that don't like typing this much, "$h_" is a synonym for
3969 "$header_". A non-existent header yields a NULL value; nothing is
3972 if (isalpha((*(++s))))
3979 s = read_name(name, sizeof(name), s, US"_");
3981 /* If this is the first thing to be expanded, release the pre-allocated
3985 g = store_get(sizeof(gstring));
3986 else if (yield->ptr == 0)
3988 if (resetok) store_reset(yield);
3990 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
3995 if ( ( *(t = name) == 'h'
3996 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
3998 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4001 unsigned flags = *name == 'r' ? FH_WANT_RAW
4002 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4004 uschar * charset = *name == 'b' ? NULL : headers_charset;
4006 s = read_header_name(name, sizeof(name), s);
4007 value = find_header(name, &newsize, flags, charset);
4009 /* If we didn't find the header, and the header contains a closing brace
4010 character, this may be a user error where the terminating colon
4011 has been omitted. Set a flag to adjust the error message in this case.
4012 But there is no error here - nothing gets inserted. */
4016 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
4023 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4025 expand_string_message =
4026 string_sprintf("unknown variable name \"%s\"", name);
4027 check_variable_error_message(name);
4031 /* If the data is known to be in a new buffer, newsize will be set to the
4032 size of that buffer. If this is the first thing in an expansion string,
4033 yield will be NULL; just point it at the new store instead of copying. Many
4034 expansion strings contain just one reference, so this is a useful
4035 optimization, especially for humungous headers. We need to use a gstring
4036 structure that is not allocated after that new-buffer, else a later store
4037 reset in the middle of the buffer will make it inaccessible. */
4039 len = Ustrlen(value);
4040 if (!yield && newsize != 0)
4043 yield->size = newsize;
4048 yield = string_catn(yield, value, len);
4056 s = read_cnumber(&n, s);
4057 if (n >= 0 && n <= expand_nmax)
4058 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4062 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4064 if (*s != '{') /*}*/
4066 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4070 /* After { there can be various things, but they all start with
4071 an initial word, except for a number for a string match variable. */
4073 if (isdigit((*(++s))))
4076 s = read_cnumber(&n, s); /*{*/
4079 expand_string_message = US"} expected after number";
4082 if (n >= 0 && n <= expand_nmax)
4083 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4089 expand_string_message = US"letter or digit expected after ${"; /*}*/
4093 /* Allow "-" in names to cater for substrings with negative
4094 arguments. Since we are checking for known names after { this is
4097 s = read_name(name, sizeof(name), s, US"_-");
4098 item_type = chop_match(name, item_table, nelem(item_table));
4102 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4103 If the ACL returns accept or reject we return content set by "message ="
4104 There is currently no limit on recursion; this would have us call
4105 acl_check_internal() directly and get a current level from somewhere.
4106 See also the acl expansion condition ECOND_ACL and the traditional
4107 acl modifier ACLC_ACL.
4108 Assume that the function has side-effects on the store that must be preserved.
4112 /* ${acl {name} {arg1}{arg2}...} */
4114 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4117 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4120 case 1: goto EXPAND_FAILED_CURLY;
4122 case 3: goto EXPAND_FAILED;
4124 if (skipping) continue;
4127 switch(eval_acl(sub, nelem(sub), &user_msg))
4132 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4134 yield = string_cat(yield, user_msg);
4138 expand_string_forcedfail = TRUE;
4141 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4146 case EITEM_AUTHRESULTS:
4147 /* ${authresults {mysystemname}} */
4151 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4154 case 1: goto EXPAND_FAILED_CURLY;
4156 case 3: goto EXPAND_FAILED;
4159 yield = string_append(yield, 3,
4160 US"Authentication-Results: ", sub_arg[0], US"; none");
4163 yield = authres_local(yield, sub_arg[0]);
4164 yield = authres_iprev(yield);
4165 yield = authres_smtpauth(yield);
4167 yield = authres_spf(yield);
4169 #ifndef DISABLE_DKIM
4170 yield = authres_dkim(yield);
4172 #ifdef EXPERIMENTAL_DMARC
4173 yield = authres_dmarc(yield);
4175 #ifdef EXPERIMENTAL_ARC
4176 yield = authres_arc(yield);
4181 /* Handle conditionals - preserve the values of the numerical expansion
4182 variables in case they get changed by a regular expression match in the
4183 condition. If not, they retain their external settings. At the end
4184 of this "if" section, they get restored to their previous values. */
4189 const uschar *next_s;
4190 int save_expand_nmax =
4191 save_expand_strings(save_expand_nstring, save_expand_nlength);
4193 while (isspace(*s)) s++;
4194 next_s = eval_condition(s, &resetok, skipping ? NULL : &cond);
4195 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4199 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4200 "condition: %.*s\n",
4201 (int)(next_s - s), s);
4202 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4203 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4205 cond ? "true" : "false");
4210 /* The handling of "yes" and "no" result strings is now in a separate
4211 function that is also used by ${lookup} and ${extract} and ${run}. */
4213 switch(process_yesno(
4214 skipping, /* were previously skipping */
4215 cond, /* success/failure indicator */
4216 lookup_value, /* value to reset for string2 */
4217 &s, /* input pointer */
4218 &yield, /* output pointer */
4219 US"if", /* condition type */
4222 case 1: goto EXPAND_FAILED; /* when all is well, the */
4223 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4226 /* Restore external setting of expansion variables for continuation
4229 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4230 save_expand_nlength);
4235 case EITEM_IMAPFOLDER:
4236 { /* ${imapfolder {name}{sep]{specials}} */
4240 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4243 case 1: goto EXPAND_FAILED_CURLY;
4245 case 3: goto EXPAND_FAILED;
4248 if (sub_arg[1] == NULL) /* One argument */
4250 sub_arg[1] = US"/"; /* default separator */
4253 else if (Ustrlen(sub_arg[1]) != 1)
4255 expand_string_message =
4257 "IMAP folder separator must be one character, found \"%s\"",
4264 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4265 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4267 yield = string_cat(yield, encoded);
4273 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4274 expanding an internal string that isn't actually going to be used. All we
4275 need to do is check the syntax, so don't do a lookup at all. Preserve the
4276 values of the numerical expansion variables in case they get changed by a
4277 partial lookup. If not, they retain their external settings. At the end
4278 of this "lookup" section, they get restored to their previous values. */
4282 int stype, partial, affixlen, starflags;
4283 int expand_setup = 0;
4285 uschar *key, *filename;
4286 const uschar *affix;
4287 uschar *save_lookup_value = lookup_value;
4288 int save_expand_nmax =
4289 save_expand_strings(save_expand_nstring, save_expand_nlength);
4291 if ((expand_forbid & RDO_LOOKUP) != 0)
4293 expand_string_message = US"lookup expansions are not permitted";
4297 /* Get the key we are to look up for single-key+file style lookups.
4298 Otherwise set the key NULL pro-tem. */
4300 while (isspace(*s)) s++;
4301 if (*s == '{') /*}*/
4303 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4304 if (!key) goto EXPAND_FAILED; /*{{*/
4307 expand_string_message = US"missing '}' after lookup key";
4308 goto EXPAND_FAILED_CURLY;
4310 while (isspace(*s)) s++;
4314 /* Find out the type of database */
4318 expand_string_message = US"missing lookup type";
4322 /* The type is a string that may contain special characters of various
4323 kinds. Allow everything except space or { to appear; the actual content
4324 is checked by search_findtype_partial. */ /*}*/
4326 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4328 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4332 while (isspace(*s)) s++;
4334 /* Now check for the individual search type and any partial or default
4335 options. Only those types that are actually in the binary are valid. */
4337 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4341 expand_string_message = search_error_message;
4345 /* Check that a key was provided for those lookup types that need it,
4346 and was not supplied for those that use the query style. */
4348 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4352 expand_string_message = string_sprintf("missing {key} for single-"
4353 "key \"%s\" lookup", name);
4361 expand_string_message = string_sprintf("a single key was given for "
4362 "lookup type \"%s\", which is not a single-key lookup type", name);
4367 /* Get the next string in brackets and expand it. It is the file name for
4368 single-key+file lookups, and the whole query otherwise. In the case of
4369 queries that also require a file name (e.g. sqlite), the file name comes
4374 expand_string_message = US"missing '{' for lookup file-or-query arg";
4375 goto EXPAND_FAILED_CURLY;
4377 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4378 if (filename == NULL) goto EXPAND_FAILED;
4381 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4382 goto EXPAND_FAILED_CURLY;
4384 while (isspace(*s)) s++;
4386 /* If this isn't a single-key+file lookup, re-arrange the variables
4387 to be appropriate for the search_ functions. For query-style lookups,
4388 there is just a "key", and no file name. For the special query-style +
4389 file types, the query (i.e. "key") starts with a file name. */
4393 while (isspace(*filename)) filename++;
4396 if (mac_islookup(stype, lookup_querystyle))
4400 if (*filename != '/')
4402 expand_string_message = string_sprintf(
4403 "absolute file name expected for \"%s\" lookup", name);
4406 while (*key != 0 && !isspace(*key)) key++;
4407 if (*key != 0) *key++ = 0;
4411 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4412 the entry was not found. Note that there is no search_close() function.
4413 Files are left open in case of re-use. At suitable places in higher logic,
4414 search_tidyup() is called to tidy all open files. This can save opening
4415 the same file several times. However, files may also get closed when
4416 others are opened, if too many are open at once. The rule is that a
4417 handle should not be used after a second search_open().
4419 Request that a partial search sets up $1 and maybe $2 by passing
4420 expand_setup containing zero. If its value changes, reset expand_nmax,
4421 since new variables will have been set. Note that at the end of this
4422 "lookup" section, the old numeric variables are restored. */
4425 lookup_value = NULL;
4428 void *handle = search_open(filename, stype, 0, NULL, NULL);
4431 expand_string_message = search_error_message;
4434 lookup_value = search_find(handle, filename, key, partial, affix,
4435 affixlen, starflags, &expand_setup);
4436 if (search_find_defer)
4438 expand_string_message =
4439 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4440 string_printing2(key, FALSE), search_error_message);
4443 if (expand_setup > 0) expand_nmax = expand_setup;
4446 /* The handling of "yes" and "no" result strings is now in a separate
4447 function that is also used by ${if} and ${extract}. */
4449 switch(process_yesno(
4450 skipping, /* were previously skipping */
4451 lookup_value != NULL, /* success/failure indicator */
4452 save_lookup_value, /* value to reset for string2 */
4453 &s, /* input pointer */
4454 &yield, /* output pointer */
4455 US"lookup", /* condition type */
4458 case 1: goto EXPAND_FAILED; /* when all is well, the */
4459 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4462 /* Restore external setting of expansion variables for carrying on
4463 at this level, and continue. */
4465 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4466 save_expand_nlength);
4470 /* If Perl support is configured, handle calling embedded perl subroutines,
4471 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4472 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4473 arguments (defined below). */
4475 #define EXIM_PERL_MAX_ARGS 8
4479 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4480 "is not included in this binary";
4483 #else /* EXIM_PERL */
4485 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4488 if ((expand_forbid & RDO_PERL) != 0)
4490 expand_string_message = US"Perl calls are not permitted";
4494 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4495 US"perl", &resetok))
4497 case 1: goto EXPAND_FAILED_CURLY;
4499 case 3: goto EXPAND_FAILED;
4502 /* If skipping, we don't actually do anything */
4504 if (skipping) continue;
4506 /* Start the interpreter if necessary */
4508 if (!opt_perl_started)
4511 if (opt_perl_startup == NULL)
4513 expand_string_message = US"A setting of perl_startup is needed when "
4514 "using the Perl interpreter";
4517 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4518 initerror = init_perl(opt_perl_startup);
4519 if (initerror != NULL)
4521 expand_string_message =
4522 string_sprintf("error in perl_startup code: %s\n", initerror);
4525 opt_perl_started = TRUE;
4528 /* Call the function */
4530 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4531 new_yield = call_perl_cat(yield, &expand_string_message,
4532 sub_arg[0], sub_arg + 1);
4534 /* NULL yield indicates failure; if the message pointer has been set to
4535 NULL, the yield was undef, indicating a forced failure. Otherwise the
4536 message will indicate some kind of Perl error. */
4538 if (new_yield == NULL)
4540 if (expand_string_message == NULL)
4542 expand_string_message =
4543 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4544 "failure", sub_arg[0]);
4545 expand_string_forcedfail = TRUE;
4550 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4551 set during a callback from Perl. */
4553 expand_string_forcedfail = FALSE;
4557 #endif /* EXIM_PERL */
4559 /* Transform email address to "prvs" scheme to use
4560 as BATV-signed return path */
4567 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4569 case 1: goto EXPAND_FAILED_CURLY;
4571 case 3: goto EXPAND_FAILED;
4574 /* If skipping, we don't actually do anything */
4575 if (skipping) continue;
4577 /* sub_arg[0] is the address */
4578 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
4579 || domain == sub_arg[0] || Ustrlen(domain) == 1)
4581 expand_string_message = US"prvs first argument must be a qualified email address";
4585 /* Calculate the hash. The third argument must be a single-digit
4586 key number, or unset. */
4589 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4591 expand_string_message = US"prvs third argument must be a single digit";
4595 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
4598 expand_string_message = US"prvs hmac-sha1 conversion failed";
4602 /* Now separate the domain from the local part */
4605 yield = string_catn(yield, US"prvs=", 5);
4606 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
4607 yield = string_catn(yield, prvs_daystamp(7), 3);
4608 yield = string_catn(yield, p, 6);
4609 yield = string_catn(yield, US"=", 1);
4610 yield = string_cat (yield, sub_arg[0]);
4611 yield = string_catn(yield, US"@", 1);
4612 yield = string_cat (yield, domain);
4617 /* Check a prvs-encoded address for validity */
4619 case EITEM_PRVSCHECK:
4626 /* TF: Ugliness: We want to expand parameter 1 first, then set
4627 up expansion variables that are used in the expansion of
4628 parameter 2. So we clone the string for the first
4629 expansion, where we only expand parameter 1.
4631 PH: Actually, that isn't necessary. The read_subs() function is
4632 designed to work this way for the ${if and ${lookup expansions. I've
4636 /* Reset expansion variables */
4637 prvscheck_result = NULL;
4638 prvscheck_address = NULL;
4639 prvscheck_keynum = NULL;
4641 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4643 case 1: goto EXPAND_FAILED_CURLY;
4645 case 3: goto EXPAND_FAILED;
4648 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4651 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4653 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4654 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4655 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4656 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4657 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4659 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
4660 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
4661 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
4662 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
4663 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
4665 /* Set up expansion variables */
4666 g = string_cat (NULL, local_part);
4667 g = string_catn(g, US"@", 1);
4668 g = string_cat (g, domain);
4669 prvscheck_address = string_from_gstring(g);
4670 prvscheck_keynum = string_copy(key_num);
4672 /* Now expand the second argument */
4673 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4675 case 1: goto EXPAND_FAILED_CURLY;
4677 case 3: goto EXPAND_FAILED;
4680 /* Now we have the key and can check the address. */
4682 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4687 expand_string_message = US"hmac-sha1 conversion failed";
4691 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
4692 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
4694 if (Ustrcmp(p,hash) == 0)
4696 /* Success, valid BATV address. Now check the expiry date. */
4697 uschar *now = prvs_daystamp(0);
4698 unsigned int inow = 0,iexpire = 1;
4700 (void)sscanf(CS now,"%u",&inow);
4701 (void)sscanf(CS daystamp,"%u",&iexpire);
4703 /* When "iexpire" is < 7, a "flip" has occured.
4704 Adjust "inow" accordingly. */
4705 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4707 if (iexpire >= inow)
4709 prvscheck_result = US"1";
4710 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
4714 prvscheck_result = NULL;
4715 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
4720 prvscheck_result = NULL;
4721 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
4724 /* Now expand the final argument. We leave this till now so that
4725 it can include $prvscheck_result. */
4727 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4729 case 1: goto EXPAND_FAILED_CURLY;
4731 case 3: goto EXPAND_FAILED;
4734 yield = string_cat(yield,
4735 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4737 /* Reset the "internal" variables afterwards, because they are in
4738 dynamic store that will be reclaimed if the expansion succeeded. */
4740 prvscheck_address = NULL;
4741 prvscheck_keynum = NULL;
4744 /* Does not look like a prvs encoded address, return the empty string.
4745 We need to make sure all subs are expanded first, so as to skip over
4748 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4750 case 1: goto EXPAND_FAILED_CURLY;
4752 case 3: goto EXPAND_FAILED;
4758 /* Handle "readfile" to insert an entire file */
4760 case EITEM_READFILE:
4765 if ((expand_forbid & RDO_READFILE) != 0)
4767 expand_string_message = US"file insertions are not permitted";
4771 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4773 case 1: goto EXPAND_FAILED_CURLY;
4775 case 3: goto EXPAND_FAILED;
4778 /* If skipping, we don't actually do anything */
4780 if (skipping) continue;
4782 /* Open the file and read it */
4784 if (!(f = Ufopen(sub_arg[0], "rb")))
4786 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4790 yield = cat_file(f, yield, sub_arg[1]);
4795 /* Handle "readsocket" to insert data from a socket, either
4796 Inet or Unix domain */
4798 case EITEM_READSOCK:
4802 int save_ptr = yield->ptr;
4806 BOOL do_shutdown = TRUE;
4809 if (expand_forbid & RDO_READSOCK)
4811 expand_string_message = US"socket insertions are not permitted";
4815 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4816 because there may be a string for expansion on failure. */
4818 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4820 case 1: goto EXPAND_FAILED_CURLY;
4821 case 2: /* Won't occur: no end check */
4822 case 3: goto EXPAND_FAILED;
4825 /* Grab the request string, if any */
4827 reqstr.data = sub_arg[1];
4828 reqstr.len = Ustrlen(sub_arg[1]);
4830 /* Sort out timeout, if given. The second arg is a list with the first element
4831 being a time value. Any more are options of form "name=value". Currently the
4832 only option recognised is "shutdown". */
4836 const uschar * list = sub_arg[2];
4840 item = string_nextinlist(&list, &sep, NULL, 0);
4841 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
4843 expand_string_message = string_sprintf("bad time value %s", item);
4847 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
4848 if (Ustrncmp(item, US"shutdown=", 9) == 0)
4849 if (Ustrcmp(item + 9, US"no") == 0)
4850 do_shutdown = FALSE;
4852 else sub_arg[3] = NULL; /* No eol if no timeout */
4854 /* If skipping, we don't actually do anything. Otherwise, arrange to
4855 connect to either an IP or a Unix socket. */
4859 /* Handle an IP (internet) domain */
4861 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4864 uschar * server_name = sub_arg[0] + 5;
4865 uschar * port_name = Ustrrchr(server_name, ':');
4867 /* Sort out the port */
4871 expand_string_message =
4872 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4875 *port_name++ = 0; /* Terminate server name */
4877 if (isdigit(*port_name))
4880 port = Ustrtol(port_name, &end, 0);
4881 if (end != port_name + Ustrlen(port_name))
4883 expand_string_message =
4884 string_sprintf("invalid port number %s", port_name);
4890 struct servent *service_info = getservbyname(CS port_name, "tcp");
4893 expand_string_message = string_sprintf("unknown port \"%s\"",
4897 port = ntohs(service_info->s_port);
4900 fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4901 timeout, NULL, &expand_string_message, &reqstr);
4902 callout_address = NULL;
4908 /* Handle a Unix domain socket */
4912 struct sockaddr_un sockun; /* don't call this "sun" ! */
4915 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4917 expand_string_message = string_sprintf("failed to create socket: %s",
4922 sockun.sun_family = AF_UNIX;
4923 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4926 sigalrm_seen = FALSE;
4928 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4932 expand_string_message = US "socket connect timed out";
4937 expand_string_message = string_sprintf("failed to connect to socket "
4938 "%s: %s", sub_arg[0], strerror(errno));
4943 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
4945 /* Allow sequencing of test actions */
4946 if (running_in_test_harness) millisleep(100);
4948 /* Write the request string, if not empty or already done */
4952 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
4954 if (write(fd, reqstr.data, reqstr.len) != reqstr.len)
4956 expand_string_message = string_sprintf("request write to socket "
4957 "failed: %s", strerror(errno));
4962 /* Shut down the sending side of the socket. This helps some servers to
4963 recognise that it is their turn to do some work. Just in case some
4964 system doesn't have this function, make it conditional. */
4967 if (do_shutdown) shutdown(fd, SHUT_WR);
4970 if (running_in_test_harness) millisleep(100);
4972 /* Now we need to read from the socket, under a timeout. The function
4973 that reads a file can be used. */
4975 f = fdopen(fd, "rb");
4976 sigalrm_seen = FALSE;
4978 yield = cat_file(f, yield, sub_arg[3]);
4982 /* After a timeout, we restore the pointer in the result, that is,
4983 make sure we add nothing from the socket. */
4987 yield->ptr = save_ptr;
4988 expand_string_message = US "socket read timed out";
4993 /* The whole thing has worked (or we were skipping). If there is a
4994 failure string following, we need to skip it. */
4998 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
5002 expand_string_message = US"missing '}' closing failstring for readsocket";
5003 goto EXPAND_FAILED_CURLY;
5005 while (isspace(*s)) s++;
5011 expand_string_message = US"missing '}' closing readsocket";
5012 goto EXPAND_FAILED_CURLY;
5016 /* Come here on failure to create socket, connect socket, write to the
5017 socket, or timeout on reading. If another substring follows, expand and
5018 use it. Otherwise, those conditions give expand errors. */
5021 if (*s != '{') goto EXPAND_FAILED;
5022 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5023 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5025 yield = string_cat(yield, arg);
5028 expand_string_message = US"missing '}' closing failstring for readsocket";
5029 goto EXPAND_FAILED_CURLY;
5031 while (isspace(*s)) s++;
5035 /* Handle "run" to execute a program. */
5041 const uschar **argv;
5045 if ((expand_forbid & RDO_RUN) != 0)
5047 expand_string_message = US"running a command is not permitted";
5051 while (isspace(*s)) s++;
5054 expand_string_message = US"missing '{' for command arg of run";
5055 goto EXPAND_FAILED_CURLY;
5057 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5058 if (arg == NULL) goto EXPAND_FAILED;
5059 while (isspace(*s)) s++;
5062 expand_string_message = US"missing '}' closing command arg of run";
5063 goto EXPAND_FAILED_CURLY;
5066 if (skipping) /* Just pretend it worked when we're skipping */
5069 lookup_value = NULL;
5073 if (!transport_set_up_command(&argv, /* anchor for arg list */
5074 arg, /* raw command */
5075 FALSE, /* don't expand the arguments */
5076 0, /* not relevant when... */
5077 NULL, /* no transporting address */
5078 US"${run} expansion", /* for error messages */
5079 &expand_string_message)) /* where to put error message */
5082 /* Create the child process, making it a group leader. */
5084 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
5086 expand_string_message =
5087 string_sprintf("couldn't create child process: %s", strerror(errno));
5091 /* Nothing is written to the standard input. */
5095 /* Read the pipe to get the command's output into $value (which is kept
5096 in lookup_value). Read during execution, so that if the output exceeds
5097 the OS pipe buffer limit, we don't block forever. Remember to not release
5098 memory just allocated for $value. */
5101 f = fdopen(fd_out, "rb");
5102 sigalrm_seen = FALSE;
5104 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5108 /* Wait for the process to finish, applying the timeout, and inspect its
5109 return code for serious disasters. Simple non-zero returns are passed on.
5112 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5114 if (sigalrm_seen || runrc == -256)
5116 expand_string_message = string_sprintf("command timed out");
5117 killpg(pid, SIGKILL); /* Kill the whole process group */
5120 else if (runrc == -257)
5121 expand_string_message = string_sprintf("wait() failed: %s",
5125 expand_string_message = string_sprintf("command killed by signal %d",
5132 /* Process the yes/no strings; $value may be useful in both cases */
5134 switch(process_yesno(
5135 skipping, /* were previously skipping */
5136 runrc == 0, /* success/failure indicator */
5137 lookup_value, /* value to reset for string2 */
5138 &s, /* input pointer */
5139 &yield, /* output pointer */
5140 US"run", /* condition type */
5143 case 1: goto EXPAND_FAILED; /* when all is well, the */
5144 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5150 /* Handle character translation for "tr" */
5154 int oldptr = yield->ptr;
5158 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5160 case 1: goto EXPAND_FAILED_CURLY;
5162 case 3: goto EXPAND_FAILED;
5165 yield = string_cat(yield, sub[0]);
5166 o2m = Ustrlen(sub[2]) - 1;
5168 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5170 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5174 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5181 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5182 expanded arguments. */
5192 int val[2] = { 0, -1 };
5195 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5196 Ensure that sub[2] is set in the ${length } case. */
5199 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5200 TRUE, name, &resetok))
5202 case 1: goto EXPAND_FAILED_CURLY;
5204 case 3: goto EXPAND_FAILED;
5207 /* Juggle the arguments if there are only two of them: always move the
5208 string to the last position and make ${length{n}{str}} equivalent to
5209 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5215 if (item_type == EITEM_LENGTH)
5222 for (i = 0; i < 2; i++)
5224 if (sub[i] == NULL) continue;
5225 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5226 if (*ret != 0 || (i != 0 && val[i] < 0))
5228 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5229 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5235 (item_type == EITEM_HASH)?
5236 compute_hash(sub[2], val[0], val[1], &len) :
5237 (item_type == EITEM_NHASH)?
5238 compute_nhash(sub[2], val[0], val[1], &len) :
5239 extract_substr(sub[2], val[0], val[1], &len);
5241 if (ret == NULL) goto EXPAND_FAILED;
5242 yield = string_catn(yield, ret, len);
5246 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5247 This code originally contributed by Steve Haslam. It currently supports
5248 the use of MD5 and SHA-1 hashes.
5250 We need some workspace that is large enough to handle all the supported
5251 hash types. Use macros to set the sizes rather than be too elaborate. */
5253 #define MAX_HASHLEN 20
5254 #define MAX_HASHBLOCKLEN 64
5263 int hashlen; /* Number of octets for the hash algorithm's output */
5264 int hashblocklen; /* Number of octets the hash algorithm processes */
5266 unsigned int keylen;
5268 uschar keyhash[MAX_HASHLEN];
5269 uschar innerhash[MAX_HASHLEN];
5270 uschar finalhash[MAX_HASHLEN];
5271 uschar finalhash_hex[2*MAX_HASHLEN];
5272 uschar innerkey[MAX_HASHBLOCKLEN];
5273 uschar outerkey[MAX_HASHBLOCKLEN];
5275 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5277 case 1: goto EXPAND_FAILED_CURLY;
5279 case 3: goto EXPAND_FAILED;
5284 if (Ustrcmp(sub[0], "md5") == 0)
5287 use_base = &md5_base;
5291 else if (Ustrcmp(sub[0], "sha1") == 0)
5294 use_base = &sha1_ctx;
5300 expand_string_message =
5301 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5306 keylen = Ustrlen(keyptr);
5308 /* If the key is longer than the hash block length, then hash the key
5311 if (keylen > hashblocklen)
5313 chash_start(type, use_base);
5314 chash_end(type, use_base, keyptr, keylen, keyhash);
5319 /* Now make the inner and outer key values */
5321 memset(innerkey, 0x36, hashblocklen);
5322 memset(outerkey, 0x5c, hashblocklen);
5324 for (i = 0; i < keylen; i++)
5326 innerkey[i] ^= keyptr[i];
5327 outerkey[i] ^= keyptr[i];
5330 /* Now do the hashes */
5332 chash_start(type, use_base);
5333 chash_mid(type, use_base, innerkey);
5334 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5336 chash_start(type, use_base);
5337 chash_mid(type, use_base, outerkey);
5338 chash_end(type, use_base, innerhash, hashlen, finalhash);
5340 /* Encode the final hash as a hex string */
5343 for (i = 0; i < hashlen; i++)
5345 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5346 *p++ = hex_digits[finalhash[i] & 0x0f];
5349 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5350 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5352 yield = string_catn(yield, finalhash_hex, hashlen*2);
5357 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5358 We have to save the numerical variables and restore them afterwards. */
5363 int moffset, moffsetextra, slen;
5366 const uschar *rerror;
5369 int save_expand_nmax =
5370 save_expand_strings(save_expand_nstring, save_expand_nlength);
5372 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5374 case 1: goto EXPAND_FAILED_CURLY;
5376 case 3: goto EXPAND_FAILED;
5379 /* Compile the regular expression */
5381 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5386 expand_string_message = string_sprintf("regular expression error in "
5387 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5391 /* Now run a loop to do the substitutions as often as necessary. It ends
5392 when there are no more matches. Take care over matches of the null string;
5393 do the same thing as Perl does. */
5396 slen = Ustrlen(sub[0]);
5397 moffset = moffsetextra = 0;
5402 int ovector[3*(EXPAND_MAXN+1)];
5403 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5404 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5408 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5409 is not necessarily the end. We want to repeat the match from one
5410 character further along, but leaving the basic offset the same (for
5411 copying below). We can't be at the end of the string - that was checked
5412 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5413 finished; copy the remaining string and end the loop. */
5423 yield = string_catn(yield, subject+moffset, slen-moffset);
5427 /* Match - set up for expanding the replacement. */
5429 if (n == 0) n = EXPAND_MAXN + 1;
5431 for (nn = 0; nn < n*2; nn += 2)
5433 expand_nstring[expand_nmax] = subject + ovector[nn];
5434 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5438 /* Copy the characters before the match, plus the expanded insertion. */
5440 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
5441 insert = expand_string(sub[2]);
5442 if (insert == NULL) goto EXPAND_FAILED;
5443 yield = string_cat(yield, insert);
5445 moffset = ovector[1];
5449 /* If we have matched an empty string, first check to see if we are at
5450 the end of the subject. If so, the loop is over. Otherwise, mimic
5451 what Perl's /g options does. This turns out to be rather cunning. First
5452 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5453 string at the same point. If this fails (picked up above) we advance to
5454 the next character. */
5456 if (ovector[0] == ovector[1])
5458 if (ovector[0] == slen) break;
5459 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5463 /* All done - restore numerical variables. */
5465 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5466 save_expand_nlength);
5470 /* Handle keyed and numbered substring extraction. If the first argument
5471 consists entirely of digits, then a numerical extraction is assumed. */
5477 int field_number = 1;
5478 BOOL field_number_set = FALSE;
5479 uschar *save_lookup_value = lookup_value;
5481 int save_expand_nmax =
5482 save_expand_strings(save_expand_nstring, save_expand_nlength);
5484 /* While skipping we cannot rely on the data for expansions being
5485 available (eg. $item) hence cannot decide on numeric vs. keyed.
5486 Read a maximum of 5 arguments (including the yes/no) */
5490 while (isspace(*s)) s++;
5491 for (j = 5; j > 0 && *s == '{'; j--)
5493 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5494 goto EXPAND_FAILED; /*{*/
5497 expand_string_message = US"missing '{' for arg of extract";
5498 goto EXPAND_FAILED_CURLY;
5500 while (isspace(*s)) s++;
5502 if ( Ustrncmp(s, "fail", 4) == 0
5503 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5507 while (isspace(*s)) s++;
5511 expand_string_message = US"missing '}' closing extract";
5512 goto EXPAND_FAILED_CURLY;
5516 else for (i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5518 while (isspace(*s)) s++;
5519 if (*s == '{') /*}*/
5521 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5522 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5525 expand_string_message = string_sprintf(
5526 "missing '}' closing arg %d of extract", i+1);
5527 goto EXPAND_FAILED_CURLY;
5530 /* After removal of leading and trailing white space, the first
5531 argument must not be empty; if it consists entirely of digits
5532 (optionally preceded by a minus sign), this is a numerical
5533 extraction, and we expect 3 arguments. */
5541 while (isspace(*p)) p++;
5545 while (len > 0 && isspace(p[len-1])) len--;
5550 expand_string_message = US"first argument of \"extract\" must "
5560 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5564 j = 3; /* Need 3 args */
5565 field_number_set = TRUE;
5571 expand_string_message = string_sprintf(
5572 "missing '{' for arg %d of extract", i+1);
5573 goto EXPAND_FAILED_CURLY;
5577 /* Extract either the numbered or the keyed substring into $value. If
5578 skipping, just pretend the extraction failed. */
5580 lookup_value = skipping? NULL : field_number_set?
5581 expand_gettokened(field_number, sub[1], sub[2]) :
5582 expand_getkeyed(sub[0], sub[1]);
5584 /* If no string follows, $value gets substituted; otherwise there can
5585 be yes/no strings, as for lookup or if. */
5587 switch(process_yesno(
5588 skipping, /* were previously skipping */
5589 lookup_value != NULL, /* success/failure indicator */
5590 save_lookup_value, /* value to reset for string2 */
5591 &s, /* input pointer */
5592 &yield, /* output pointer */
5593 US"extract", /* condition type */
5596 case 1: goto EXPAND_FAILED; /* when all is well, the */
5597 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5600 /* All done - restore numerical variables. */
5602 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5603 save_expand_nlength);
5608 /* return the Nth item from a list */
5610 case EITEM_LISTEXTRACT:
5613 int field_number = 1;
5614 uschar *save_lookup_value = lookup_value;
5616 int save_expand_nmax =
5617 save_expand_strings(save_expand_nstring, save_expand_nlength);
5619 /* Read the field & list arguments */
5621 for (i = 0; i < 2; i++)
5623 while (isspace(*s)) s++;
5624 if (*s != '{') /*}*/
5626 expand_string_message = string_sprintf(
5627 "missing '{' for arg %d of listextract", i+1);
5628 goto EXPAND_FAILED_CURLY;
5631 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5632 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5635 expand_string_message = string_sprintf(
5636 "missing '}' closing arg %d of listextract", i+1);
5637 goto EXPAND_FAILED_CURLY;
5640 /* After removal of leading and trailing white space, the first
5641 argument must be numeric and nonempty. */
5649 while (isspace(*p)) p++;
5653 while (len > 0 && isspace(p[len-1])) len--;
5656 if (!*p && !skipping)
5658 expand_string_message = US"first argument of \"listextract\" must "
5668 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5671 expand_string_message = US"first argument of \"listextract\" must "
5679 /* Extract the numbered element into $value. If
5680 skipping, just pretend the extraction failed. */
5682 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5684 /* If no string follows, $value gets substituted; otherwise there can
5685 be yes/no strings, as for lookup or if. */
5687 switch(process_yesno(
5688 skipping, /* were previously skipping */
5689 lookup_value != NULL, /* success/failure indicator */
5690 save_lookup_value, /* value to reset for string2 */
5691 &s, /* input pointer */
5692 &yield, /* output pointer */
5693 US"listextract", /* condition type */
5696 case 1: goto EXPAND_FAILED; /* when all is well, the */
5697 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5700 /* All done - restore numerical variables. */
5702 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5703 save_expand_nlength);
5709 case EITEM_CERTEXTRACT:
5711 uschar *save_lookup_value = lookup_value;
5713 int save_expand_nmax =
5714 save_expand_strings(save_expand_nstring, save_expand_nlength);
5716 /* Read the field argument */
5717 while (isspace(*s)) s++;
5718 if (*s != '{') /*}*/
5720 expand_string_message = US"missing '{' for field arg of certextract";
5721 goto EXPAND_FAILED_CURLY;
5723 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5724 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5727 expand_string_message = US"missing '}' closing field arg of certextract";
5728 goto EXPAND_FAILED_CURLY;
5730 /* strip spaces fore & aft */
5735 while (isspace(*p)) p++;
5739 while (len > 0 && isspace(p[len-1])) len--;
5743 /* inspect the cert argument */
5744 while (isspace(*s)) s++;
5745 if (*s != '{') /*}*/
5747 expand_string_message = US"missing '{' for cert variable arg of certextract";
5748 goto EXPAND_FAILED_CURLY;
5752 expand_string_message = US"second argument of \"certextract\" must "
5753 "be a certificate variable";
5756 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5757 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5760 expand_string_message = US"missing '}' closing cert variable arg of certextract";
5761 goto EXPAND_FAILED_CURLY;
5765 lookup_value = NULL;
5768 lookup_value = expand_getcertele(sub[0], sub[1]);
5769 if (*expand_string_message) goto EXPAND_FAILED;
5771 switch(process_yesno(
5772 skipping, /* were previously skipping */
5773 lookup_value != NULL, /* success/failure indicator */
5774 save_lookup_value, /* value to reset for string2 */
5775 &s, /* input pointer */
5776 &yield, /* output pointer */
5777 US"certextract", /* condition type */
5780 case 1: goto EXPAND_FAILED; /* when all is well, the */
5781 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5784 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5785 save_expand_nlength);
5788 #endif /*SUPPORT_TLS*/
5790 /* Handle list operations */
5797 int save_ptr = yield->ptr;
5798 uschar outsep[2] = { '\0', '\0' };
5799 const uschar *list, *expr, *temp;
5800 uschar *save_iterate_item = iterate_item;
5801 uschar *save_lookup_value = lookup_value;
5803 while (isspace(*s)) s++;
5806 expand_string_message =
5807 string_sprintf("missing '{' for first arg of %s", name);
5808 goto EXPAND_FAILED_CURLY;
5811 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5812 if (list == NULL) goto EXPAND_FAILED;
5815 expand_string_message =
5816 string_sprintf("missing '}' closing first arg of %s", name);
5817 goto EXPAND_FAILED_CURLY;
5820 if (item_type == EITEM_REDUCE)
5823 while (isspace(*s)) s++;
5826 expand_string_message = US"missing '{' for second arg of reduce";
5827 goto EXPAND_FAILED_CURLY;
5829 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5830 if (!t) goto EXPAND_FAILED;
5834 expand_string_message = US"missing '}' closing second arg of reduce";
5835 goto EXPAND_FAILED_CURLY;
5839 while (isspace(*s)) s++;
5842 expand_string_message =
5843 string_sprintf("missing '{' for last arg of %s", name);
5844 goto EXPAND_FAILED_CURLY;
5849 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5850 if scanning a "false" part). This allows us to find the end of the
5851 condition, because if the list is empty, we won't actually evaluate the
5852 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5853 the normal internal expansion function. */
5855 if (item_type == EITEM_FILTER)
5857 temp = eval_condition(expr, &resetok, NULL);
5858 if (temp != NULL) s = temp;
5861 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5865 expand_string_message = string_sprintf("%s inside \"%s\" item",
5866 expand_string_message, name);
5870 while (isspace(*s)) s++;
5873 expand_string_message = string_sprintf("missing } at end of condition "
5874 "or expression inside \"%s\"; could be an unquoted } in the content",
5879 while (isspace(*s)) s++; /*{*/
5882 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5887 /* If we are skipping, we can now just move on to the next item. When
5888 processing for real, we perform the iteration. */
5890 if (skipping) continue;
5891 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
5893 *outsep = (uschar)sep; /* Separator as a string */
5895 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
5896 name, iterate_item, lookup_value);
5898 if (item_type == EITEM_FILTER)
5901 if (eval_condition(expr, &resetok, &condresult) == NULL)
5903 iterate_item = save_iterate_item;
5904 lookup_value = save_lookup_value;
5905 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5906 expand_string_message, name);
5909 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
5910 condresult? "true":"false");
5912 temp = iterate_item; /* TRUE => include this item */
5914 continue; /* FALSE => skip this item */
5917 /* EITEM_MAP and EITEM_REDUCE */
5921 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5925 iterate_item = save_iterate_item;
5926 expand_string_message = string_sprintf("%s inside \"%s\" item",
5927 expand_string_message, name);
5930 if (item_type == EITEM_REDUCE)
5932 lookup_value = t; /* Update the value of $value */
5933 continue; /* and continue the iteration */
5937 /* We reach here for FILTER if the condition is true, always for MAP,
5938 and never for REDUCE. The value in "temp" is to be added to the output
5939 list that is being created, ensuring that any occurrences of the
5940 separator character are doubled. Unless we are dealing with the first
5941 item of the output list, add in a space if the new item begins with the
5942 separator character, or is an empty string. */
5944 if (yield->ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5945 yield = string_catn(yield, US" ", 1);
5947 /* Add the string in "temp" to the output list that we are building,
5948 This is done in chunks by searching for the separator character. */
5952 size_t seglen = Ustrcspn(temp, outsep);
5954 yield = string_catn(yield, temp, seglen + 1);
5956 /* If we got to the end of the string we output one character
5957 too many; backup and end the loop. Otherwise arrange to double the
5960 if (temp[seglen] == '\0') { yield->ptr--; break; }
5961 yield = string_catn(yield, outsep, 1);
5965 /* Output a separator after the string: we will remove the redundant
5966 final one at the end. */
5968 yield = string_catn(yield, outsep, 1);
5969 } /* End of iteration over the list loop */
5971 /* REDUCE has generated no output above: output the final value of
5974 if (item_type == EITEM_REDUCE)
5976 yield = string_cat(yield, lookup_value);
5977 lookup_value = save_lookup_value; /* Restore $value */
5980 /* FILTER and MAP generate lists: if they have generated anything, remove
5981 the redundant final separator. Even though an empty item at the end of a
5982 list does not count, this is tidier. */
5984 else if (yield->ptr != save_ptr) yield->ptr--;
5986 /* Restore preserved $item */
5988 iterate_item = save_iterate_item;
5995 const uschar *srclist, *cmp, *xtract;
5997 const uschar *dstlist = NULL, *dstkeylist = NULL;
5999 uschar *save_iterate_item = iterate_item;
6001 while (isspace(*s)) s++;
6004 expand_string_message = US"missing '{' for list arg of sort";
6005 goto EXPAND_FAILED_CURLY;
6008 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6009 if (!srclist) goto EXPAND_FAILED;
6012 expand_string_message = US"missing '}' closing list arg of sort";
6013 goto EXPAND_FAILED_CURLY;
6016 while (isspace(*s)) s++;
6019 expand_string_message = US"missing '{' for comparator arg of sort";
6020 goto EXPAND_FAILED_CURLY;
6023 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6024 if (!cmp) goto EXPAND_FAILED;
6027 expand_string_message = US"missing '}' closing comparator arg of sort";
6028 goto EXPAND_FAILED_CURLY;
6031 while (isspace(*s)) s++;
6034 expand_string_message = US"missing '{' for extractor arg of sort";
6035 goto EXPAND_FAILED_CURLY;
6039 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6040 if (!tmp) goto EXPAND_FAILED;
6041 xtract = string_copyn(xtract, s - xtract);
6045 expand_string_message = US"missing '}' closing extractor arg of sort";
6046 goto EXPAND_FAILED_CURLY;
6051 expand_string_message = US"missing } at end of \"sort\"";
6055 if (skipping) continue;
6057 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6060 gstring * newlist = NULL;
6061 gstring * newkeylist = NULL;
6064 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6066 /* extract field for comparisons */
6067 iterate_item = srcitem;
6068 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6072 expand_string_message = string_sprintf(
6073 "field-extract in sort: \"%s\"", xtract);
6077 /* Insertion sort */
6079 /* copy output list until new-item < list-item */
6080 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6086 /* field for comparison */
6087 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6090 /* build and run condition string */
6091 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
6093 DEBUG(D_expand) debug_printf_indent("%s: cond = \"%s\"\n", name, expr);
6094 if (!eval_condition(expr, &resetok, &before))
6096 expand_string_message = string_sprintf("comparison in sort: %s",
6103 /* New-item sorts before this dst-item. Append new-item,
6104 then dst-item, then remainder of dst list. */
6106 newlist = string_append_listele(newlist, sep, srcitem);
6107 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6110 newlist = string_append_listele(newlist, sep, dstitem);
6111 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6113 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6115 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6117 newlist = string_append_listele(newlist, sep, dstitem);
6118 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6124 newlist = string_append_listele(newlist, sep, dstitem);
6125 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6128 /* If we ran out of dstlist without consuming srcitem, append it */
6131 newlist = string_append_listele(newlist, sep, srcitem);
6132 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6135 dstlist = newlist->s;
6136 dstkeylist = newkeylist->s;
6138 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6139 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6143 yield = string_cat(yield, dstlist);
6145 /* Restore preserved $item */
6146 iterate_item = save_iterate_item;
6150 expand_string_message = US"Internal error in sort (list mismatch)";
6155 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6156 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6157 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6158 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6160 #define EXPAND_DLFUNC_MAX_ARGS 8
6163 #ifndef EXPAND_DLFUNC
6164 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6165 "is not included in this binary";
6168 #else /* EXPAND_DLFUNC */
6171 exim_dlfunc_t *func;
6174 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6176 if ((expand_forbid & RDO_DLFUNC) != 0)
6178 expand_string_message =
6179 US"dynamically-loaded functions are not permitted";
6183 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6184 TRUE, US"dlfunc", &resetok))
6186 case 1: goto EXPAND_FAILED_CURLY;
6188 case 3: goto EXPAND_FAILED;
6191 /* If skipping, we don't actually do anything */
6193 if (skipping) continue;
6195 /* Look up the dynamically loaded object handle in the tree. If it isn't
6196 found, dlopen() the file and put the handle in the tree for next time. */
6198 t = tree_search(dlobj_anchor, argv[0]);
6201 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6204 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6205 argv[0], dlerror());
6206 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6209 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6210 Ustrcpy(t->name, argv[0]);
6211 t->data.ptr = handle;
6212 (void)tree_insertnode(&dlobj_anchor, t);
6215 /* Having obtained the dynamically loaded object handle, look up the
6216 function pointer. */
6218 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6221 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6222 "%s", argv[1], argv[0], dlerror());
6223 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6227 /* Call the function and work out what to do with the result. If it
6228 returns OK, we have a replacement string; if it returns DEFER then
6229 expansion has failed in a non-forced manner; if it returns FAIL then
6230 failure was forced; if it returns ERROR or any other value there's a
6231 problem, so panic slightly. In any case, assume that the function has
6232 side-effects on the store that must be preserved. */
6236 for (argc = 0; argv[argc] != NULL; argc++);
6237 status = func(&result, argc - 2, &argv[2]);
6240 if (result == NULL) result = US"";
6241 yield = string_cat(yield, result);
6246 expand_string_message = result == NULL ? US"(no message)" : result;
6247 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
6248 else if(status != FAIL)
6249 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6250 argv[0], argv[1], status, expand_string_message);
6254 #endif /* EXPAND_DLFUNC */
6256 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6259 uschar *save_lookup_value = lookup_value;
6261 while (isspace(*s)) s++;
6262 if (*s != '{') /*}*/
6265 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6266 if (!key) goto EXPAND_FAILED; /*{*/
6269 expand_string_message = US"missing '{' for name arg of env";
6270 goto EXPAND_FAILED_CURLY;
6273 lookup_value = US getenv(CS key);
6275 switch(process_yesno(
6276 skipping, /* were previously skipping */
6277 lookup_value != NULL, /* success/failure indicator */
6278 save_lookup_value, /* value to reset for string2 */
6279 &s, /* input pointer */
6280 &yield, /* output pointer */
6281 US"env", /* condition type */
6284 case 1: goto EXPAND_FAILED; /* when all is well, the */
6285 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6289 } /* EITEM_* switch */
6291 /* Control reaches here if the name is not recognized as one of the more
6292 complicated expansion items. Check for the "operator" syntax (name terminated
6293 by a colon). Some of the operators have arguments, separated by _ from the
6301 var_entry *vp = NULL;
6303 /* Owing to an historical mis-design, an underscore may be part of the
6304 operator name, or it may introduce arguments. We therefore first scan the
6305 table of names that contain underscores. If there is no match, we cut off
6306 the arguments and then scan the main table. */
6308 if ((c = chop_match(name, op_table_underscore,
6309 nelem(op_table_underscore))) < 0)
6311 arg = Ustrchr(name, '_');
6312 if (arg != NULL) *arg = 0;
6313 c = chop_match(name, op_table_main, nelem(op_table_main));
6314 if (c >= 0) c += nelem(op_table_underscore);
6315 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6318 /* Deal specially with operators that might take a certificate variable
6319 as we do not want to do the usual expansion. For most, expand the string.*/
6329 const uschar * s1 = s;
6330 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6332 if (!sub) goto EXPAND_FAILED; /*{*/
6335 expand_string_message =
6336 string_sprintf("missing '}' closing cert arg of %s", name);
6337 goto EXPAND_FAILED_CURLY;
6339 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6349 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6350 if (!sub) goto EXPAND_FAILED;
6355 /* If we are skipping, we don't need to perform the operation at all.
6356 This matters for operations like "mask", because the data may not be
6357 in the correct format when skipping. For example, the expression may test
6358 for the existence of $sender_host_address before trying to mask it. For
6359 other operations, doing them may not fail, but it is a waste of time. */
6361 if (skipping && c >= 0) continue;
6363 /* Otherwise, switch on the operator type */
6370 unsigned long int n = Ustrtoul(sub, &t, 10);
6375 expand_string_message = string_sprintf("argument for base32 "
6376 "operator is \"%s\", which is not a decimal number", sub);
6380 g = string_catn(g, &base32_chars[n & 0x1f], 1);
6382 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
6389 unsigned long int n = 0;
6393 uschar * t = Ustrchr(base32_chars, *tt++);
6396 expand_string_message = string_sprintf("argument for base32d "
6397 "operator is \"%s\", which is not a base 32 number", sub);
6400 n = n * 32 + (t - base32_chars);
6402 s = string_sprintf("%ld", n);
6403 yield = string_cat(yield, s);
6410 unsigned long int n = Ustrtoul(sub, &t, 10);
6413 expand_string_message = string_sprintf("argument for base62 "
6414 "operator is \"%s\", which is not a decimal number", sub);
6417 t = string_base62(n);
6418 yield = string_cat(yield, t);
6422 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6428 unsigned long int n = 0;
6431 uschar *t = Ustrchr(base62_chars, *tt++);
6434 expand_string_message = string_sprintf("argument for base62d "
6435 "operator is \"%s\", which is not a base %d number", sub,
6439 n = n * BASE_62 + (t - base62_chars);
6441 (void)sprintf(CS buf, "%ld", n);
6442 yield = string_cat(yield, buf);
6448 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6449 if (expanded == NULL)
6451 expand_string_message =
6452 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6453 expand_string_message);
6456 yield = string_cat(yield, expanded);
6463 uschar *t = sub - 1;
6464 while (*(++t) != 0) { *t = tolower(*t); count++; }
6465 yield = string_catn(yield, sub, count);
6472 uschar *t = sub - 1;
6473 while (*(++t) != 0) { *t = toupper(*t); count++; }
6474 yield = string_catn(yield, sub, count);
6480 if (vp && *(void **)vp->value)
6482 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6483 yield = string_cat(yield, cp);
6493 md5_end(&base, sub, Ustrlen(sub), digest);
6494 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6495 yield = string_cat(yield, US st);
6501 if (vp && *(void **)vp->value)
6503 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6504 yield = string_cat(yield, cp);
6514 sha1_end(&h, sub, Ustrlen(sub), digest);
6515 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6516 yield = string_catn(yield, US st, 40);
6521 #ifdef EXIM_HAVE_SHA2
6522 if (vp && *(void **)vp->value)
6524 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6525 yield = string_cat(yield, cp);
6533 if (!exim_sha_init(&h, HASH_SHA2_256))
6535 expand_string_message = US"unrecognised sha256 variant";
6538 exim_sha_update(&h, sub, Ustrlen(sub));
6539 exim_sha_finish(&h, &b);
6542 sprintf(st, "%02X", *b.data++);
6543 yield = string_catn(yield, US st, 2);
6547 expand_string_message = US"sha256 only supported with TLS";
6552 #ifdef EXIM_HAVE_SHA3
6557 hashmethod m = !arg ? HASH_SHA3_256
6558 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6559 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6560 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6561 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6564 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6566 expand_string_message = US"unrecognised sha3 variant";
6570 exim_sha_update(&h, sub, Ustrlen(sub));
6571 exim_sha_finish(&h, &b);
6574 sprintf(st, "%02X", *b.data++);
6575 yield = string_catn(yield, US st, 2);
6580 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
6584 /* Convert hex encoding to base64 encoding */
6594 for (enc = sub; *enc != 0; enc++)
6596 if (!isxdigit(*enc))
6598 expand_string_message = string_sprintf("\"%s\" is not a hex "
6607 expand_string_message = string_sprintf("\"%s\" contains an odd "
6608 "number of characters", sub);
6612 while ((c = *in++) != 0)
6614 if (isdigit(c)) c -= '0';
6615 else c = toupper(c) - 'A' + 10;
6627 enc = b64encode(sub, out - sub);
6628 yield = string_cat(yield, enc);
6632 /* Convert octets outside 0x21..0x7E to \xXX form */
6636 uschar *t = sub - 1;
6639 if (*t < 0x21 || 0x7E < *t)
6640 yield = string_catn(yield, string_sprintf("\\x%02x", *t), 4);
6642 yield = string_catn(yield, t, 1);
6647 /* count the number of list elements */
6656 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6657 cp = string_sprintf("%d", cnt);
6658 yield = string_cat(yield, cp);
6662 /* expand a named list given the name */
6663 /* handles nested named lists; requotes as colon-sep list */
6667 tree_node *t = NULL;
6668 const uschar * list;
6671 uschar * suffix = US"";
6672 BOOL needsep = FALSE;
6675 if (*sub == '+') sub++;
6676 if (arg == NULL) /* no-argument version */
6678 if (!(t = tree_search(addresslist_anchor, sub)) &&
6679 !(t = tree_search(domainlist_anchor, sub)) &&
6680 !(t = tree_search(hostlist_anchor, sub)))
6681 t = tree_search(localpartlist_anchor, sub);
6683 else switch(*arg) /* specific list-type version */
6685 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6686 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6687 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6688 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6690 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6696 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6698 : *arg=='a'?"address "
6699 : *arg=='d'?"domain "
6701 : *arg=='l'?"localpart "
6706 list = ((namedlist_block *)(t->data.ptr))->string;
6708 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
6710 uschar * buf = US" : ";
6712 yield = string_catn(yield, buf, 3);
6716 if (*item == '+') /* list item is itself a named list */
6718 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6719 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6721 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6725 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6726 while ((cp= strpbrk(CCS item, tok)))
6728 yield = string_catn(yield, item, cp - CS item);
6729 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6731 yield = string_catn(yield, US"::", 2);
6734 else /* sep in item; should already be doubled; emit once */
6736 yield = string_catn(yield, US tok, 1);
6737 if (*cp == sep) cp++;
6742 yield = string_cat(yield, item);
6747 /* mask applies a mask to an IP address; for example the result of
6748 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6755 int mask, maskoffset;
6756 int type = string_is_ip_address(sub, &maskoffset);
6761 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6766 if (maskoffset == 0)
6768 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6773 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6775 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6777 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6782 /* Convert the address to binary integer(s) and apply the mask */
6784 sub[maskoffset] = 0;
6785 count = host_aton(sub, binary);
6786 host_mask(count, binary, mask);
6788 /* Convert to masked textual format and add to output. */
6790 yield = string_catn(yield, buffer,
6791 host_nmtoa(count, binary, mask, buffer, '.'));
6796 case EOP_IPV6DENORM:
6798 int type = string_is_ip_address(sub, NULL);
6805 (void) host_aton(sub, binary);
6808 case 4: /* convert to IPv4-mapped IPv6 */
6809 binary[0] = binary[1] = 0;
6810 binary[2] = 0x0000ffff;
6811 (void) host_aton(sub, binary+3);
6815 expand_string_message =
6816 string_sprintf("\"%s\" is not an IP address", sub);
6820 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
6821 ? ipv6_nmtoa(binary, buffer)
6822 : host_nmtoa(4, binary, -1, buffer, ':')
6828 case EOP_LOCAL_PART:
6832 int start, end, domain;
6833 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
6836 if (c != EOP_DOMAIN)
6838 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6839 yield = string_catn(yield, sub+start, end-start);
6841 else if (domain != 0)
6844 yield = string_catn(yield, sub+domain, end-domain);
6851 uschar outsep[2] = { ':', '\0' };
6852 uschar *address, *error;
6853 int save_ptr = yield->ptr;
6854 int start, end, domain; /* Not really used */
6856 while (isspace(*sub)) sub++;
6858 if (*outsep = *++sub) ++sub;
6861 expand_string_message = string_sprintf("output separator "
6862 "missing in expanding ${addresses:%s}", --sub);
6865 parse_allow_group = TRUE;
6869 uschar *p = parse_find_address_end(sub, FALSE);
6870 uschar saveend = *p;
6872 address = parse_extract_address(sub, &error, &start, &end, &domain,
6876 /* Add the address to the output list that we are building. This is
6877 done in chunks by searching for the separator character. At the
6878 start, unless we are dealing with the first address of the output
6879 list, add in a space if the new address begins with the separator
6880 character, or is an empty string. */
6882 if (address != NULL)
6884 if (yield->ptr != save_ptr && address[0] == *outsep)
6885 yield = string_catn(yield, US" ", 1);
6889 size_t seglen = Ustrcspn(address, outsep);
6890 yield = string_catn(yield, address, seglen + 1);
6892 /* If we got to the end of the string we output one character
6895 if (address[seglen] == '\0') { yield->ptr--; break; }
6896 yield = string_catn(yield, outsep, 1);
6897 address += seglen + 1;
6900 /* Output a separator after the string: we will remove the
6901 redundant final one at the end. */
6903 yield = string_catn(yield, outsep, 1);
6906 if (saveend == '\0') break;
6910 /* If we have generated anything, remove the redundant final
6913 if (yield->ptr != save_ptr) yield->ptr--;
6914 parse_allow_group = FALSE;
6919 /* quote puts a string in quotes if it is empty or contains anything
6920 other than alphamerics, underscore, dot, or hyphen.
6922 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6923 be quoted in order to be a valid local part.
6925 In both cases, newlines and carriage returns are converted into \n and \r
6929 case EOP_QUOTE_LOCAL_PART:
6932 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6933 uschar *t = sub - 1;
6937 while (!needs_quote && *(++t) != 0)
6938 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6940 else /* EOP_QUOTE_LOCAL_PART */
6942 while (!needs_quote && *(++t) != 0)
6943 needs_quote = !isalnum(*t) &&
6944 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6945 (*t != '.' || t == sub || t[1] == 0);
6950 yield = string_catn(yield, US"\"", 1);
6955 yield = string_catn(yield, US"\\n", 2);
6956 else if (*t == '\r')
6957 yield = string_catn(yield, US"\\r", 2);
6960 if (*t == '\\' || *t == '"')
6961 yield = string_catn(yield, US"\\", 1);
6962 yield = string_catn(yield, t, 1);
6965 yield = string_catn(yield, US"\"", 1);
6967 else yield = string_cat(yield, sub);
6971 /* quote_lookuptype does lookup-specific quoting */
6976 uschar *opt = Ustrchr(arg, '_');
6978 if (opt != NULL) *opt++ = 0;
6980 n = search_findtype(arg, Ustrlen(arg));
6983 expand_string_message = search_error_message;
6987 if (lookup_list[n]->quote != NULL)
6988 sub = (lookup_list[n]->quote)(sub, opt);
6989 else if (opt != NULL) sub = NULL;
6993 expand_string_message = string_sprintf(
6994 "\"%s\" unrecognized after \"${quote_%s\"",
6999 yield = string_cat(yield, sub);
7003 /* rx quote sticks in \ before any non-alphameric character so that
7004 the insertion works in a regular expression. */
7008 uschar *t = sub - 1;
7012 yield = string_catn(yield, US"\\", 1);
7013 yield = string_catn(yield, t, 1);
7018 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7019 prescribed by the RFC, if there are characters that need to be encoded */
7023 uschar buffer[2048];
7024 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7025 buffer, sizeof(buffer), FALSE);
7026 yield = string_cat(yield, string);
7030 /* RFC 2047 decode */
7036 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7037 headers_charset, '?', &len, &error);
7040 expand_string_message = error;
7043 yield = string_catn(yield, decoded, len);
7047 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7057 if (c > 255) c = '_';
7059 yield = string_catn(yield, buff, 1);
7064 /* replace illegal UTF-8 sequences by replacement character */
7066 #define UTF8_REPLACEMENT_CHAR US"?"
7070 int seq_len = 0, index = 0;
7072 long codepoint = -1;
7073 uschar seq_buff[4]; /* accumulate utf-8 here */
7082 if ((c & 0xc0) != 0x80)
7083 /* wrong continuation byte; invalidate all bytes */
7084 complete = 1; /* error */
7087 codepoint = (codepoint << 6) | (c & 0x3f);
7088 seq_buff[index++] = c;
7089 if (--bytes_left == 0) /* codepoint complete */
7090 if(codepoint > 0x10FFFF) /* is it too large? */
7091 complete = -1; /* error (RFC3629 limit) */
7093 { /* finished; output utf-8 sequence */
7094 yield = string_catn(yield, seq_buff, seq_len);
7099 else /* no bytes left: new sequence */
7101 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7103 yield = string_catn(yield, &c, 1);
7106 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7108 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7113 codepoint = c & 0x1f;
7116 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7119 codepoint = c & 0x0f;
7121 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7124 codepoint = c & 0x07;
7126 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7129 seq_buff[index++] = c;
7130 seq_len = bytes_left + 1;
7131 } /* if(bytes_left) */
7135 bytes_left = index = 0;
7136 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7138 if ((complete == 1) && ((c & 0x80) == 0))
7139 /* ASCII character follows incomplete sequence */
7140 yield = string_catn(yield, &c, 1);
7146 case EOP_UTF8_DOMAIN_TO_ALABEL:
7148 uschar * error = NULL;
7149 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7152 expand_string_message = string_sprintf(
7153 "error converting utf8 (%s) to alabel: %s",
7154 string_printing(sub), error);
7157 yield = string_cat(yield, s);
7161 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7163 uschar * error = NULL;
7164 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7167 expand_string_message = string_sprintf(
7168 "error converting alabel (%s) to utf8: %s",
7169 string_printing(sub), error);
7172 yield = string_cat(yield, s);
7176 case EOP_UTF8_LOCALPART_TO_ALABEL:
7178 uschar * error = NULL;
7179 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7182 expand_string_message = string_sprintf(
7183 "error converting utf8 (%s) to alabel: %s",
7184 string_printing(sub), error);
7187 yield = string_cat(yield, s);
7188 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7192 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7194 uschar * error = NULL;
7195 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7198 expand_string_message = string_sprintf(
7199 "error converting alabel (%s) to utf8: %s",
7200 string_printing(sub), error);
7203 yield = string_cat(yield, s);
7206 #endif /* EXPERIMENTAL_INTERNATIONAL */
7208 /* escape turns all non-printing characters into escape sequences. */
7212 const uschar * t = string_printing(sub);
7213 yield = string_cat(yield, t);
7217 case EOP_ESCAPE8BIT:
7219 const uschar * s = sub;
7222 for (s = sub; (c = *s); s++)
7223 yield = c < 127 && c != '\\'
7224 ? string_catn(yield, s, 1)
7225 : string_catn(yield, string_sprintf("\\%03o", c), 4);
7229 /* Handle numeric expression evaluation */
7234 uschar *save_sub = sub;
7235 uschar *error = NULL;
7236 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7239 expand_string_message = string_sprintf("error in expression "
7240 "evaluation: %s (after processing \"%.*s\")", error,
7241 (int)(sub-save_sub), save_sub);
7244 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
7245 yield = string_cat(yield, var_buffer);
7249 /* Handle time period formating */
7253 int n = readconf_readtime(sub, 0, FALSE);
7256 expand_string_message = string_sprintf("string \"%s\" is not an "
7257 "Exim time interval in \"%s\" operator", sub, name);
7260 sprintf(CS var_buffer, "%d", n);
7261 yield = string_cat(yield, var_buffer);
7265 case EOP_TIME_INTERVAL:
7268 uschar *t = read_number(&n, sub);
7269 if (*t != 0) /* Not A Number*/
7271 expand_string_message = string_sprintf("string \"%s\" is not a "
7272 "positive number in \"%s\" operator", sub, name);
7275 t = readconf_printtime(n);
7276 yield = string_cat(yield, t);
7280 /* Convert string to base64 encoding */
7286 uschar * s = vp && *(void **)vp->value
7287 ? tls_cert_der_b64(*(void **)vp->value)
7288 : b64encode(sub, Ustrlen(sub));
7290 uschar * s = b64encode(sub, Ustrlen(sub));
7292 yield = string_cat(yield, s);
7299 int len = b64decode(sub, &s);
7302 expand_string_message = string_sprintf("string \"%s\" is not "
7303 "well-formed for \"%s\" operator", sub, name);
7306 yield = string_cat(yield, s);
7310 /* strlen returns the length of the string */
7315 (void)sprintf(CS buff, "%d", Ustrlen(sub));
7316 yield = string_cat(yield, buff);
7320 /* length_n or l_n takes just the first n characters or the whole string,
7321 whichever is the shorter;
7323 substr_m_n, and s_m_n take n characters from offset m; negative m take
7324 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7325 takes the rest, either to the right or to the left.
7327 hash_n or h_n makes a hash of length n from the string, yielding n
7328 characters from the set a-z; hash_n_m makes a hash of length n, but
7329 uses m characters from the set a-zA-Z0-9.
7331 nhash_n returns a single number between 0 and n-1 (in text form), while
7332 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7333 between 0 and n-1 and the second between 0 and m-1. */
7353 expand_string_message = string_sprintf("missing values after %s",
7358 /* "length" has only one argument, effectively being synonymous with
7361 if (c == EOP_LENGTH || c == EOP_L)
7367 /* The others have one or two arguments; for "substr" the first may be
7368 negative. The second being negative means "not supplied". */
7373 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7376 /* Read up to two numbers, separated by underscores */
7381 if (arg != ret && *arg == '_' && pn == &value1)
7385 if (arg[1] != 0) arg++;
7387 else if (!isdigit(*arg))
7389 expand_string_message =
7390 string_sprintf("non-digit after underscore in \"%s\"", name);
7393 else *pn = (*pn)*10 + *arg++ - '0';
7397 /* Perform the required operation */
7400 (c == EOP_HASH || c == EOP_H)?
7401 compute_hash(sub, value1, value2, &len) :
7402 (c == EOP_NHASH || c == EOP_NH)?
7403 compute_nhash(sub, value1, value2, &len) :
7404 extract_substr(sub, value1, value2, &len);
7406 if (ret == NULL) goto EXPAND_FAILED;
7407 yield = string_catn(yield, ret, len);
7417 uschar **modetable[3];
7422 if ((expand_forbid & RDO_EXISTS) != 0)
7424 expand_string_message = US"Use of the stat() expansion is not permitted";
7428 if (stat(CS sub, &st) < 0)
7430 expand_string_message = string_sprintf("stat(%s) failed: %s",
7431 sub, strerror(errno));
7435 switch (mode & S_IFMT)
7437 case S_IFIFO: smode[0] = 'p'; break;
7438 case S_IFCHR: smode[0] = 'c'; break;
7439 case S_IFDIR: smode[0] = 'd'; break;
7440 case S_IFBLK: smode[0] = 'b'; break;
7441 case S_IFREG: smode[0] = '-'; break;
7442 default: smode[0] = '?'; break;
7445 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7446 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7447 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7449 for (i = 0; i < 3; i++)
7451 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7456 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7457 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7458 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7459 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7460 (long)st.st_gid, st.st_size, (long)st.st_atime,
7461 (long)st.st_mtime, (long)st.st_ctime);
7462 yield = string_cat(yield, s);
7466 /* vaguely random number less than N */
7470 int_eximarith_t max;
7473 max = expanded_string_integer(sub, TRUE);
7474 if (expand_string_message != NULL)
7476 s = string_sprintf("%d", vaguely_random_number((int)max));
7477 yield = string_cat(yield, s);
7481 /* Reverse IP, including IPv6 to dotted-nibble */
7483 case EOP_REVERSE_IP:
7485 int family, maskptr;
7486 uschar reversed[128];
7488 family = string_is_ip_address(sub, &maskptr);
7491 expand_string_message = string_sprintf(
7492 "reverse_ip() not given an IP address [%s]", sub);
7495 invert_address(reversed, sub);
7496 yield = string_cat(yield, reversed);
7500 /* Unknown operator */
7503 expand_string_message =
7504 string_sprintf("unknown expansion operator \"%s\"", name);
7509 /* Handle a plain name. If this is the first thing in the expansion, release
7510 the pre-allocated buffer. If the result data is known to be in a new buffer,
7511 newsize will be set to the size of that buffer, and we can just point at that
7512 store instead of copying. Many expansion strings contain just one reference,
7513 so this is a useful optimization, especially for humungous headers
7514 ($message_headers). */
7523 g = store_get(sizeof(gstring));
7524 else if (yield->ptr == 0)
7526 if (resetok) store_reset(yield);
7528 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
7530 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
7532 expand_string_message =
7533 string_sprintf("unknown variable in \"${%s}\"", name);
7534 check_variable_error_message(name);
7537 len = Ustrlen(value);
7538 if (!yield && newsize)
7541 yield->size = newsize;
7546 yield = string_catn(yield, value, len);
7550 /* Else there's something wrong */
7552 expand_string_message =
7553 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7554 "in a variable reference)", name);
7558 /* If we hit the end of the string when ket_ends is set, there is a missing
7559 terminating brace. */
7561 if (ket_ends && *s == 0)
7563 expand_string_message = malformed_header
7564 ? US"missing } at end of string - could be header name not terminated by colon"
7565 : US"missing } at end of string";
7569 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7570 added to the string. If so, set up an empty string. Add a terminating zero. If
7571 left != NULL, return a pointer to the terminator. */
7574 yield = string_get(1);
7575 (void) string_from_gstring(yield);
7576 if (left) *left = s;
7578 /* Any stacking store that was used above the final string is no longer needed.
7579 In many cases the final string will be the first one that was got and so there
7580 will be optimal store usage. */
7582 if (resetok) store_reset(yield->s + (yield->size = yield->ptr + 1));
7583 else if (resetok_p) *resetok_p = FALSE;
7587 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
7588 "expanding: %.*s\n",
7589 (int)(s - string), string);
7590 debug_printf_indent("%s"
7591 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7593 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7596 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7597 "skipping: result is not used\n");
7602 /* This is the failure exit: easiest to program with a goto. We still need
7603 to update the pointer to the terminator, for cases of nested calls with "fail".
7606 EXPAND_FAILED_CURLY:
7607 if (malformed_header)
7608 expand_string_message =
7609 US"missing or misplaced { or } - could be header name not terminated by colon";
7611 else if (!expand_string_message || !*expand_string_message)
7612 expand_string_message = US"missing or misplaced { or }";
7614 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7615 that is a bad idea, because expand_string_message is in dynamic store. */
7618 if (left) *left = s;
7621 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
7623 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7624 "error message: %s\n",
7625 expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7626 expand_string_message);
7627 if (expand_string_forcedfail)
7628 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
7630 if (resetok_p && !resetok) *resetok_p = FALSE;
7636 /* This is the external function call. Do a quick check for any expansion
7637 metacharacters, and if there are none, just return the input string.
7639 Argument: the string to be expanded
7640 Returns: the expanded string, or NULL if expansion failed; if failure was
7641 due to a lookup deferring, search_find_defer will be TRUE
7645 expand_cstring(const uschar * string)
7647 if (Ustrpbrk(string, "$\\") != NULL)
7649 int old_pool = store_pool;
7652 search_find_defer = FALSE;
7653 malformed_header = FALSE;
7654 store_pool = POOL_MAIN;
7655 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7656 store_pool = old_pool;
7664 expand_string(uschar * string)
7666 return US expand_cstring(CUS string);
7673 /*************************************************
7675 *************************************************/
7677 /* Now and again we want to expand a string and be sure that the result is in a
7678 new bit of store. This function does that.
7679 Since we know it has been copied, the de-const cast is safe.
7681 Argument: the string to be expanded
7682 Returns: the expanded string, always in a new bit of store, or NULL
7686 expand_string_copy(const uschar *string)
7688 const uschar *yield = expand_cstring(string);
7689 if (yield == string) yield = string_copy(string);
7695 /*************************************************
7696 * Expand and interpret as an integer *
7697 *************************************************/
7699 /* Expand a string, and convert the result into an integer.
7702 string the string to be expanded
7703 isplus TRUE if a non-negative number is expected
7705 Returns: the integer value, or
7706 -1 for an expansion error ) in both cases, message in
7707 -2 for an integer interpretation error ) expand_string_message
7708 expand_string_message is set NULL for an OK integer
7712 expand_string_integer(uschar *string, BOOL isplus)
7714 return expanded_string_integer(expand_string(string), isplus);
7718 /*************************************************
7719 * Interpret string as an integer *
7720 *************************************************/
7722 /* Convert a string (that has already been expanded) into an integer.
7724 This function is used inside the expansion code.
7727 s the string to be expanded
7728 isplus TRUE if a non-negative number is expected
7730 Returns: the integer value, or
7731 -1 if string is NULL (which implies an expansion error)
7732 -2 for an integer interpretation error
7733 expand_string_message is set NULL for an OK integer
7736 static int_eximarith_t
7737 expanded_string_integer(const uschar *s, BOOL isplus)
7739 int_eximarith_t value;
7740 uschar *msg = US"invalid integer \"%s\"";
7743 /* If expansion failed, expand_string_message will be set. */
7745 if (s == NULL) return -1;
7747 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7748 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7749 systems, so we set it zero ourselves. */
7752 expand_string_message = NULL; /* Indicates no error */
7754 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7755 equal to 0. Unfortunately, people actually relied upon that, so preserve
7756 the behaviour explicitly. Stripping leading whitespace is a harmless
7757 noop change since strtol skips it anyway (provided that there is a number
7761 while (isspace(*s)) ++s;
7765 debug_printf_indent("treating blank string as number 0\n");
7770 value = strtoll(CS s, CSS &endptr, 10);
7774 msg = US"integer expected but \"%s\" found";
7776 else if (value < 0 && isplus)
7778 msg = US"non-negative integer expected but \"%s\" found";
7782 switch (tolower(*endptr))
7787 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7792 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7793 else value *= 1024*1024;
7797 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7798 else value *= 1024*1024*1024;
7802 if (errno == ERANGE)
7803 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7806 while (isspace(*endptr)) endptr++;
7807 if (*endptr == 0) return value;
7811 expand_string_message = string_sprintf(CS msg, s);
7816 /* These values are usually fixed boolean values, but they are permitted to be
7820 addr address being routed
7821 mtype the module type
7822 mname the module name
7823 dbg_opt debug selectors
7824 oname the option name
7825 bvalue the router's boolean value
7826 svalue the router's string value
7827 rvalue where to put the returned value
7829 Returns: OK value placed in rvalue
7830 DEFER expansion failed
7834 exp_bool(address_item *addr,
7835 uschar *mtype, uschar *mname, unsigned dbg_opt,
7836 uschar *oname, BOOL bvalue,
7837 uschar *svalue, BOOL *rvalue)
7840 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7842 expanded = expand_string(svalue);
7843 if (expanded == NULL)
7845 if (expand_string_forcedfail)
7847 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7851 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7852 oname, mname, mtype, expand_string_message);
7853 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7857 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7860 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7862 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7866 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7867 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7876 /* Avoid potentially exposing a password in a string about to be logged */
7879 expand_hide_passwords(uschar * s)
7881 return ( ( Ustrstr(s, "failed to expand") != NULL
7882 || Ustrstr(s, "expansion of ") != NULL
7884 && ( Ustrstr(s, "mysql") != NULL
7885 || Ustrstr(s, "pgsql") != NULL
7886 || Ustrstr(s, "redis") != NULL
7887 || Ustrstr(s, "sqlite") != NULL
7888 || Ustrstr(s, "ldap:") != NULL
7889 || Ustrstr(s, "ldaps:") != NULL
7890 || Ustrstr(s, "ldapi:") != NULL
7891 || Ustrstr(s, "ldapdn:") != NULL
7892 || Ustrstr(s, "ldapm:") != NULL
7894 ? US"Temporary internal error" : s;
7898 /* Read given named file into big_buffer. Use for keying material etc.
7899 The content will have an ascii NUL appended.
7904 Return: pointer to buffer, or NULL on error.
7908 expand_file_big_buffer(const uschar * filename)
7910 int fd, off = 0, len;
7912 if ((fd = open(CS filename, O_RDONLY)) < 0)
7914 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
7921 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
7924 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
7932 big_buffer[off] = '\0';
7938 /*************************************************
7939 * Error-checking for testsuite *
7940 *************************************************/
7942 uschar * region_start;
7943 uschar * region_end;
7944 const uschar *var_name;
7945 const uschar *var_data;
7949 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
7952 if (var_data >= e->region_start && var_data < e->region_end)
7954 e->var_name = CUS var_name;
7955 e->var_data = CUS var_data;
7960 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
7962 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
7963 .var_name = NULL, .var_data = NULL };
7967 /* check acl_ variables */
7968 tree_walk(acl_var_c, assert_variable_notin, &e);
7969 tree_walk(acl_var_m, assert_variable_notin, &e);
7971 /* check auth<n> variables */
7972 for (i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
7973 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
7975 /* check regex<n> variables */
7976 for (i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
7977 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
7979 /* check known-name variables */
7980 for (v = var_table; v < var_table + var_table_size; v++)
7981 if (v->type == vtype_stringptr)
7982 assert_variable_notin(US v->name, *(USS v->value), &e);
7984 /* check dns and address trees */
7985 tree_walk(tree_dns_fails, assert_variable_notin, &e);
7986 tree_walk(tree_duplicates, assert_variable_notin, &e);
7987 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
7988 tree_walk(tree_unusable, assert_variable_notin, &e);
7991 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
7992 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
7993 e.var_name, filename, linenumber, e.var_data);
7998 /*************************************************
7999 **************************************************
8000 * Stand-alone test program *
8001 **************************************************
8002 *************************************************/
8008 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
8010 int ovector[3*(EXPAND_MAXN+1)];
8011 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8012 ovector, nelem(ovector));
8013 BOOL yield = n >= 0;
8014 if (n == 0) n = EXPAND_MAXN + 1;
8018 expand_nmax = (setup < 0)? 0 : setup + 1;
8019 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
8021 expand_nstring[expand_nmax] = subject + ovector[nn];
8022 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8030 int main(int argc, uschar **argv)
8033 uschar buffer[1024];
8035 debug_selector = D_v;
8036 debug_file = stderr;
8037 debug_fd = fileno(debug_file);
8038 big_buffer = malloc(big_buffer_size);
8040 for (i = 1; i < argc; i++)
8042 if (argv[i][0] == '+')
8044 debug_trace_memory = 2;
8047 if (isdigit(argv[i][0]))
8048 debug_selector = Ustrtol(argv[i], NULL, 0);
8050 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8054 eldap_default_servers = argv[i];
8057 mysql_servers = argv[i];
8060 pgsql_servers = argv[i];
8063 redis_servers = argv[i];
8067 else opt_perl_startup = argv[i];
8071 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8073 expand_nstring[1] = US"string 1....";
8074 expand_nlength[1] = 8;
8078 if (opt_perl_startup != NULL)
8081 printf("Starting Perl interpreter\n");
8082 errstr = init_perl(opt_perl_startup);
8085 printf("** error in perl_startup code: %s\n", errstr);
8086 return EXIT_FAILURE;
8089 #endif /* EXIM_PERL */
8091 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8093 void *reset_point = store_get(0);
8094 uschar *yield = expand_string(buffer);
8097 printf("%s\n", yield);
8098 store_reset(reset_point);
8102 if (search_find_defer) printf("search_find deferred\n");
8103 printf("Failed: %s\n", expand_string_message);
8104 if (expand_string_forcedfail) printf("Forced failure\n");
8118 /* End of expand.c */