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_state", vtype_stringptr, &arc_state },
466 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
468 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
469 { "authenticated_id", vtype_stringptr, &authenticated_id },
470 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
471 { "authentication_failed",vtype_int, &authentication_failed },
472 #ifdef WITH_CONTENT_SCAN
473 { "av_failed", vtype_int, &av_failed },
475 #ifdef EXPERIMENTAL_BRIGHTMAIL
476 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
477 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
478 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
479 { "bmi_deliver", vtype_int, &bmi_deliver },
481 { "body_linecount", vtype_int, &body_linecount },
482 { "body_zerocount", vtype_int, &body_zerocount },
483 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
484 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
485 { "caller_gid", vtype_gid, &real_gid },
486 { "caller_uid", vtype_uid, &real_uid },
487 { "callout_address", vtype_stringptr, &callout_address },
488 { "compile_date", vtype_stringptr, &version_date },
489 { "compile_number", vtype_stringptr, &version_cnumber },
490 { "config_dir", vtype_stringptr, &config_main_directory },
491 { "config_file", vtype_stringptr, &config_main_filename },
492 { "csa_status", vtype_stringptr, &csa_status },
493 #ifdef EXPERIMENTAL_DCC
494 { "dcc_header", vtype_stringptr, &dcc_header },
495 { "dcc_result", vtype_stringptr, &dcc_result },
498 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
499 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
500 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
501 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
502 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
503 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
504 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
505 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
506 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
507 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
508 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
509 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
510 { "dkim_key_length", vtype_int, &dkim_key_length },
511 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
512 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
513 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
514 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
515 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
516 { "dkim_signers", vtype_stringptr, &dkim_signers },
517 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
518 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
520 #ifdef EXPERIMENTAL_DMARC
521 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
522 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
523 { "dmarc_status", vtype_stringptr, &dmarc_status },
524 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
525 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
527 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
528 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
529 { "dnslist_text", vtype_stringptr, &dnslist_text },
530 { "dnslist_value", vtype_stringptr, &dnslist_value },
531 { "domain", vtype_stringptr, &deliver_domain },
532 { "domain_data", vtype_stringptr, &deliver_domain_data },
533 #ifndef DISABLE_EVENT
534 { "event_data", vtype_stringptr, &event_data },
536 /*XXX want to use generic vars for as many of these as possible*/
537 { "event_defer_errno", vtype_int, &event_defer_errno },
539 { "event_name", vtype_stringptr, &event_name },
541 { "exim_gid", vtype_gid, &exim_gid },
542 { "exim_path", vtype_stringptr, &exim_path },
543 { "exim_uid", vtype_uid, &exim_uid },
544 { "exim_version", vtype_stringptr, &version_string },
545 { "headers_added", vtype_string_func, &fn_hdrs_added },
546 { "home", vtype_stringptr, &deliver_home },
547 { "host", vtype_stringptr, &deliver_host },
548 { "host_address", vtype_stringptr, &deliver_host_address },
549 { "host_data", vtype_stringptr, &host_data },
550 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
551 { "host_lookup_failed", vtype_int, &host_lookup_failed },
552 { "host_port", vtype_int, &deliver_host_port },
553 { "initial_cwd", vtype_stringptr, &initial_cwd },
554 { "inode", vtype_ino, &deliver_inode },
555 { "interface_address", vtype_stringptr, &interface_address },
556 { "interface_port", vtype_int, &interface_port },
557 { "item", vtype_stringptr, &iterate_item },
559 { "ldap_dn", vtype_stringptr, &eldap_dn },
561 { "load_average", vtype_load_avg, NULL },
562 { "local_part", vtype_stringptr, &deliver_localpart },
563 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
564 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
565 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
566 #ifdef HAVE_LOCAL_SCAN
567 { "local_scan_data", vtype_stringptr, &local_scan_data },
569 { "local_user_gid", vtype_gid, &local_user_gid },
570 { "local_user_uid", vtype_uid, &local_user_uid },
571 { "localhost_number", vtype_int, &host_number },
572 { "log_inodes", vtype_pinodes, (void *)FALSE },
573 { "log_space", vtype_pspace, (void *)FALSE },
574 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
575 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
576 #ifdef WITH_CONTENT_SCAN
577 { "malware_name", vtype_stringptr, &malware_name },
579 { "max_received_linelength", vtype_int, &max_received_linelength },
580 { "message_age", vtype_int, &message_age },
581 { "message_body", vtype_msgbody, &message_body },
582 { "message_body_end", vtype_msgbody_end, &message_body_end },
583 { "message_body_size", vtype_int, &message_body_size },
584 { "message_exim_id", vtype_stringptr, &message_id },
585 { "message_headers", vtype_msgheaders, NULL },
586 { "message_headers_raw", vtype_msgheaders_raw, NULL },
587 { "message_id", vtype_stringptr, &message_id },
588 { "message_linecount", vtype_int, &message_linecount },
589 { "message_size", vtype_int, &message_size },
591 { "message_smtputf8", vtype_bool, &message_smtputf8 },
593 #ifdef WITH_CONTENT_SCAN
594 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
595 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
596 { "mime_boundary", vtype_stringptr, &mime_boundary },
597 { "mime_charset", vtype_stringptr, &mime_charset },
598 { "mime_content_description", vtype_stringptr, &mime_content_description },
599 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
600 { "mime_content_id", vtype_stringptr, &mime_content_id },
601 { "mime_content_size", vtype_int, &mime_content_size },
602 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
603 { "mime_content_type", vtype_stringptr, &mime_content_type },
604 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
605 { "mime_filename", vtype_stringptr, &mime_filename },
606 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
607 { "mime_is_multipart", vtype_int, &mime_is_multipart },
608 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
609 { "mime_part_count", vtype_int, &mime_part_count },
611 { "n0", vtype_filter_int, &filter_n[0] },
612 { "n1", vtype_filter_int, &filter_n[1] },
613 { "n2", vtype_filter_int, &filter_n[2] },
614 { "n3", vtype_filter_int, &filter_n[3] },
615 { "n4", vtype_filter_int, &filter_n[4] },
616 { "n5", vtype_filter_int, &filter_n[5] },
617 { "n6", vtype_filter_int, &filter_n[6] },
618 { "n7", vtype_filter_int, &filter_n[7] },
619 { "n8", vtype_filter_int, &filter_n[8] },
620 { "n9", vtype_filter_int, &filter_n[9] },
621 { "original_domain", vtype_stringptr, &deliver_domain_orig },
622 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
623 { "originator_gid", vtype_gid, &originator_gid },
624 { "originator_uid", vtype_uid, &originator_uid },
625 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
626 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
627 { "pid", vtype_pid, NULL },
629 { "prdr_requested", vtype_bool, &prdr_requested },
631 { "primary_hostname", vtype_stringptr, &primary_hostname },
632 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
633 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
634 { "proxy_external_port", vtype_int, &proxy_external_port },
635 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
636 { "proxy_local_port", vtype_int, &proxy_local_port },
637 { "proxy_session", vtype_bool, &proxy_session },
639 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
640 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
641 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
642 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
643 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
644 { "queue_name", vtype_stringptr, &queue_name },
645 { "rcpt_count", vtype_int, &rcpt_count },
646 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
647 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
648 { "received_count", vtype_int, &received_count },
649 { "received_for", vtype_stringptr, &received_for },
650 { "received_ip_address", vtype_stringptr, &interface_address },
651 { "received_port", vtype_int, &interface_port },
652 { "received_protocol", vtype_stringptr, &received_protocol },
653 { "received_time", vtype_int, &received_time.tv_sec },
654 { "recipient_data", vtype_stringptr, &recipient_data },
655 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
656 { "recipients", vtype_string_func, &fn_recipients },
657 { "recipients_count", vtype_int, &recipients_count },
658 #ifdef WITH_CONTENT_SCAN
659 { "regex_match_string", vtype_stringptr, ®ex_match_string },
661 { "reply_address", vtype_reply, NULL },
662 { "return_path", vtype_stringptr, &return_path },
663 { "return_size_limit", vtype_int, &bounce_return_size_limit },
664 { "router_name", vtype_stringptr, &router_name },
665 { "runrc", vtype_int, &runrc },
666 { "self_hostname", vtype_stringptr, &self_hostname },
667 { "sender_address", vtype_stringptr, &sender_address },
668 { "sender_address_data", vtype_stringptr, &sender_address_data },
669 { "sender_address_domain", vtype_domain, &sender_address },
670 { "sender_address_local_part", vtype_localpart, &sender_address },
671 { "sender_data", vtype_stringptr, &sender_data },
672 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
673 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
674 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
675 { "sender_host_address", vtype_stringptr, &sender_host_address },
676 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
677 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
678 { "sender_host_name", vtype_host_lookup, NULL },
679 { "sender_host_port", vtype_int, &sender_host_port },
680 { "sender_ident", vtype_stringptr, &sender_ident },
681 { "sender_rate", vtype_stringptr, &sender_rate },
682 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
683 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
684 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
685 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
686 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
687 { "sending_port", vtype_int, &sending_port },
688 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
689 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
690 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
691 { "smtp_command_history", vtype_string_func, &smtp_cmd_hist },
692 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
693 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
694 { "sn0", vtype_filter_int, &filter_sn[0] },
695 { "sn1", vtype_filter_int, &filter_sn[1] },
696 { "sn2", vtype_filter_int, &filter_sn[2] },
697 { "sn3", vtype_filter_int, &filter_sn[3] },
698 { "sn4", vtype_filter_int, &filter_sn[4] },
699 { "sn5", vtype_filter_int, &filter_sn[5] },
700 { "sn6", vtype_filter_int, &filter_sn[6] },
701 { "sn7", vtype_filter_int, &filter_sn[7] },
702 { "sn8", vtype_filter_int, &filter_sn[8] },
703 { "sn9", vtype_filter_int, &filter_sn[9] },
704 #ifdef WITH_CONTENT_SCAN
705 { "spam_action", vtype_stringptr, &spam_action },
706 { "spam_bar", vtype_stringptr, &spam_bar },
707 { "spam_report", vtype_stringptr, &spam_report },
708 { "spam_score", vtype_stringptr, &spam_score },
709 { "spam_score_int", vtype_stringptr, &spam_score_int },
712 { "spf_guess", vtype_stringptr, &spf_guess },
713 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
714 { "spf_received", vtype_stringptr, &spf_received },
715 { "spf_result", vtype_stringptr, &spf_result },
716 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
718 { "spool_directory", vtype_stringptr, &spool_directory },
719 { "spool_inodes", vtype_pinodes, (void *)TRUE },
720 { "spool_space", vtype_pspace, (void *)TRUE },
721 #ifdef EXPERIMENTAL_SRS
722 { "srs_db_address", vtype_stringptr, &srs_db_address },
723 { "srs_db_key", vtype_stringptr, &srs_db_key },
724 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
725 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
726 { "srs_recipient", vtype_stringptr, &srs_recipient },
727 { "srs_status", vtype_stringptr, &srs_status },
729 { "thisaddress", vtype_stringptr, &filter_thisaddress },
731 /* The non-(in,out) variables are now deprecated */
732 { "tls_bits", vtype_int, &tls_in.bits },
733 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
734 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
736 { "tls_in_bits", vtype_int, &tls_in.bits },
737 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
738 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
739 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
740 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
741 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
742 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
743 #if defined(SUPPORT_TLS)
744 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
746 { "tls_out_bits", vtype_int, &tls_out.bits },
747 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
748 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
750 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
752 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
753 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
754 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
755 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
756 #if defined(SUPPORT_TLS)
757 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
760 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
763 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
764 #if defined(SUPPORT_TLS)
765 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
768 { "tod_bsdinbox", vtype_todbsdin, NULL },
769 { "tod_epoch", vtype_tode, NULL },
770 { "tod_epoch_l", vtype_todel, NULL },
771 { "tod_full", vtype_todf, NULL },
772 { "tod_log", vtype_todl, NULL },
773 { "tod_logfile", vtype_todlf, NULL },
774 { "tod_zone", vtype_todzone, NULL },
775 { "tod_zulu", vtype_todzulu, NULL },
776 { "transport_name", vtype_stringptr, &transport_name },
777 { "value", vtype_stringptr, &lookup_value },
778 { "verify_mode", vtype_stringptr, &verify_mode },
779 { "version_number", vtype_stringptr, &version_string },
780 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
781 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
782 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
783 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
784 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
785 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
788 static int var_table_size = nelem(var_table);
789 static uschar var_buffer[256];
790 static BOOL malformed_header;
792 /* For textual hashes */
794 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
795 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
798 enum { HMAC_MD5, HMAC_SHA1 };
800 /* For numeric hashes */
802 static unsigned int prime[] = {
803 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
804 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
805 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
807 /* For printing modes in symbolic form */
809 static uschar *mtable_normal[] =
810 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
812 static uschar *mtable_setid[] =
813 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
815 static uschar *mtable_sticky[] =
816 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
820 /*************************************************
821 * Tables for UTF-8 support *
822 *************************************************/
824 /* Table of the number of extra characters, indexed by the first character
825 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
828 static uschar utf8_table1[] = {
829 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
830 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
831 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
832 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
834 /* These are the masks for the data bits in the first byte of a character,
835 indexed by the number of additional bytes. */
837 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
839 /* Get the next UTF-8 character, advancing the pointer. */
841 #define GETUTF8INC(c, ptr) \
843 if ((c & 0xc0) == 0xc0) \
845 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
847 c = (c & utf8_table2[a]) << s; \
851 c |= (*ptr++ & 0x3f) << s; \
857 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
859 /*************************************************
860 * Binary chop search on a table *
861 *************************************************/
863 /* This is used for matching expansion items and operators.
866 name the name that is being sought
867 table the table to search
868 table_size the number of items in the table
870 Returns: the offset in the table, or -1
874 chop_match(uschar *name, uschar **table, int table_size)
876 uschar **bot = table;
877 uschar **top = table + table_size;
881 uschar **mid = bot + (top - bot)/2;
882 int c = Ustrcmp(name, *mid);
883 if (c == 0) return mid - table;
884 if (c > 0) bot = mid + 1; else top = mid;
892 /*************************************************
893 * Check a condition string *
894 *************************************************/
896 /* This function is called to expand a string, and test the result for a "true"
897 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
898 forced fail or lookup defer.
900 We used to release all store used, but this is not not safe due
901 to ${dlfunc } and ${acl }. In any case expand_string_internal()
902 is reasonably careful to release what it can.
904 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
907 condition the condition string
908 m1 text to be incorporated in panic error
911 Returns: TRUE if condition is met, FALSE if not
915 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
918 uschar *ss = expand_string(condition);
921 if (!expand_string_forcedfail && !search_find_defer)
922 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
923 "for %s %s: %s", condition, m1, m2, expand_string_message);
926 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
927 strcmpic(ss, US"false") != 0;
934 /*************************************************
935 * Pseudo-random number generation *
936 *************************************************/
938 /* Pseudo-random number generation. The result is not "expected" to be
939 cryptographically strong but not so weak that someone will shoot themselves
940 in the foot using it as a nonce in some email header scheme or whatever
941 weirdness they'll twist this into. The result should ideally handle fork().
943 However, if we're stuck unable to provide this, then we'll fall back to
944 appallingly bad randomness.
946 If SUPPORT_TLS is defined then this will not be used except as an emergency
951 Returns a random number in range [0, max-1]
955 # define vaguely_random_number vaguely_random_number_fallback
958 vaguely_random_number(int max)
961 # undef vaguely_random_number
963 static pid_t pid = 0;
965 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
975 #ifdef HAVE_ARC4RANDOM
976 /* cryptographically strong randomness, common on *BSD platforms, not
977 so much elsewhere. Alas. */
978 #ifndef NOT_HAVE_ARC4RANDOM_STIR
981 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
982 #ifdef HAVE_SRANDOMDEV
983 /* uses random(4) for seeding */
986 gettimeofday(&tv, NULL);
987 srandom(tv.tv_sec | tv.tv_usec | getpid());
990 /* Poor randomness and no seeding here */
997 #ifdef HAVE_ARC4RANDOM
998 return arc4random() % max;
999 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1000 return random() % max;
1002 /* This one returns a 16-bit number, definitely not crypto-strong */
1003 return random_number(max);
1010 /*************************************************
1011 * Pick out a name from a string *
1012 *************************************************/
1014 /* If the name is too long, it is silently truncated.
1017 name points to a buffer into which to put the name
1018 max is the length of the buffer
1019 s points to the first alphabetic character of the name
1020 extras chars other than alphanumerics to permit
1022 Returns: pointer to the first character after the name
1024 Note: The test for *s != 0 in the while loop is necessary because
1025 Ustrchr() yields non-NULL if the character is zero (which is not something
1028 static const uschar *
1029 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1032 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1034 if (ptr < max-1) name[ptr++] = *s;
1043 /*************************************************
1044 * Pick out the rest of a header name *
1045 *************************************************/
1047 /* A variable name starting $header_ (or just $h_ for those who like
1048 abbreviations) might not be the complete header name because headers can
1049 contain any printing characters in their names, except ':'. This function is
1050 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1051 on the end, if the name was terminated by white space.
1054 name points to a buffer in which the name read so far exists
1055 max is the length of the buffer
1056 s points to the first character after the name so far, i.e. the
1057 first non-alphameric character after $header_xxxxx
1059 Returns: a pointer to the first character after the header name
1062 static const uschar *
1063 read_header_name(uschar *name, int max, const uschar *s)
1065 int prelen = Ustrchr(name, '_') - name + 1;
1066 int ptr = Ustrlen(name) - prelen;
1067 if (ptr > 0) memmove(name, name+prelen, ptr);
1068 while (mac_isgraph(*s) && *s != ':')
1070 if (ptr < max-1) name[ptr++] = *s;
1081 /*************************************************
1082 * Pick out a number from a string *
1083 *************************************************/
1086 n points to an integer into which to put the number
1087 s points to the first digit of the number
1089 Returns: a pointer to the character after the last digit
1091 /*XXX consider expanding to int_eximarith_t. But the test for
1092 "overbig numbers" in 0002 still needs to overflow it. */
1095 read_number(int *n, uschar *s)
1098 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1102 static const uschar *
1103 read_cnumber(int *n, const uschar *s)
1106 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1112 /*************************************************
1113 * Extract keyed subfield from a string *
1114 *************************************************/
1116 /* The yield is in dynamic store; NULL means that the key was not found.
1119 key points to the name of the key
1120 s points to the string from which to extract the subfield
1122 Returns: NULL if the subfield was not found, or
1123 a pointer to the subfield's data
1127 expand_getkeyed(uschar *key, const uschar *s)
1129 int length = Ustrlen(key);
1130 while (isspace(*s)) s++;
1132 /* Loop to search for the key */
1138 const uschar *dkey = s;
1140 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1141 dkeylength = s - dkey;
1142 while (isspace(*s)) s++;
1143 if (*s == '=') while (isspace((*(++s))));
1145 data = string_dequote(&s);
1146 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1149 while (isspace(*s)) s++;
1158 find_var_ent(uschar * name)
1161 int last = var_table_size;
1163 while (last > first)
1165 int middle = (first + last)/2;
1166 int c = Ustrcmp(name, var_table[middle].name);
1168 if (c > 0) { first = middle + 1; continue; }
1169 if (c < 0) { last = middle; continue; }
1170 return &var_table[middle];
1175 /*************************************************
1176 * Extract numbered subfield from string *
1177 *************************************************/
1179 /* Extracts a numbered field from a string that is divided by tokens - for
1180 example a line from /etc/passwd is divided by colon characters. First field is
1181 numbered one. Negative arguments count from the right. Zero returns the whole
1182 string. Returns NULL if there are insufficient tokens in the string
1185 Modifies final argument - this is a dynamically generated string, so that's OK.
1188 field number of field to be extracted,
1189 first field = 1, whole string = 0, last field = -1
1190 separators characters that are used to break string into tokens
1191 s points to the string from which to extract the subfield
1193 Returns: NULL if the field was not found,
1194 a pointer to the field's data inside s (modified to add 0)
1198 expand_gettokened (int field, uschar *separators, uschar *s)
1203 uschar *fieldtext = NULL;
1205 if (field == 0) return s;
1207 /* Break the line up into fields in place; for field > 0 we stop when we have
1208 done the number of fields we want. For field < 0 we continue till the end of
1209 the string, counting the number of fields. */
1211 count = (field > 0)? field : INT_MAX;
1217 /* Previous field was the last one in the string. For a positive field
1218 number, this means there are not enough fields. For a negative field number,
1219 check that there are enough, and scan back to find the one that is wanted. */
1223 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1224 if ((-field) == (INT_MAX - count - 1)) return s;
1228 while (ss[-1] != 0) ss--;
1234 /* Previous field was not last in the string; save its start and put a
1238 len = Ustrcspn(ss, separators);
1249 expand_getlistele(int field, const uschar * list)
1251 const uschar * tlist= list;
1257 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1260 if(field==0) return NULL;
1261 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1262 return string_nextinlist(&list, &sep, NULL, 0);
1266 /* Certificate fields, by name. Worry about by-OID later */
1267 /* Names are chosen to not have common prefixes */
1274 uschar * (*getfn)(void * cert, uschar * mod);
1276 static certfield certfields[] =
1277 { /* linear search; no special order */
1278 { US"version", 7, &tls_cert_version },
1279 { US"serial_number", 13, &tls_cert_serial_number },
1280 { US"subject", 7, &tls_cert_subject },
1281 { US"notbefore", 9, &tls_cert_not_before },
1282 { US"notafter", 8, &tls_cert_not_after },
1283 { US"issuer", 6, &tls_cert_issuer },
1284 { US"signature", 9, &tls_cert_signature },
1285 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1286 { US"subj_altname", 12, &tls_cert_subject_altname },
1287 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1288 { US"crl_uri", 7, &tls_cert_crl_uri },
1292 expand_getcertele(uschar * field, uschar * certvar)
1297 if (!(vp = find_var_ent(certvar)))
1299 expand_string_message =
1300 string_sprintf("no variable named \"%s\"", certvar);
1301 return NULL; /* Unknown variable name */
1303 /* NB this stops us passing certs around in variable. Might
1304 want to do that in future */
1305 if (vp->type != vtype_cert)
1307 expand_string_message =
1308 string_sprintf("\"%s\" is not a certificate", certvar);
1309 return NULL; /* Unknown variable name */
1311 if (!*(void **)vp->value)
1314 if (*field >= '0' && *field <= '9')
1315 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1317 for(cp = certfields;
1318 cp < certfields + nelem(certfields);
1320 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1322 uschar * modifier = *(field += cp->namelen) == ','
1324 return (*cp->getfn)( *(void **)vp->value, modifier );
1327 expand_string_message =
1328 string_sprintf("bad field selector \"%s\" for certextract", field);
1331 #endif /*SUPPORT_TLS*/
1333 /*************************************************
1334 * Extract a substring from a string *
1335 *************************************************/
1337 /* Perform the ${substr or ${length expansion operations.
1340 subject the input string
1341 value1 the offset from the start of the input string to the start of
1342 the output string; if negative, count from the right.
1343 value2 the length of the output string, or negative (-1) for unset
1344 if value1 is positive, unset means "all after"
1345 if value1 is negative, unset means "all before"
1346 len set to the length of the returned string
1348 Returns: pointer to the output string, or NULL if there is an error
1352 extract_substr(uschar *subject, int value1, int value2, int *len)
1354 int sublen = Ustrlen(subject);
1356 if (value1 < 0) /* count from right */
1360 /* If the position is before the start, skip to the start, and adjust the
1361 length. If the length ends up negative, the substring is null because nothing
1362 can precede. This falls out naturally when the length is unset, meaning "all
1368 if (value2 < 0) value2 = 0;
1372 /* Otherwise an unset length => characters before value1 */
1374 else if (value2 < 0)
1381 /* For a non-negative offset, if the starting position is past the end of the
1382 string, the result will be the null string. Otherwise, an unset length means
1383 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1387 if (value1 > sublen)
1392 else if (value2 < 0) value2 = sublen;
1395 /* Cut the length down to the maximum possible for the offset value, and get
1396 the required characters. */
1398 if (value1 + value2 > sublen) value2 = sublen - value1;
1400 return subject + value1;
1406 /*************************************************
1407 * Old-style hash of a string *
1408 *************************************************/
1410 /* Perform the ${hash expansion operation.
1413 subject the input string (an expanded substring)
1414 value1 the length of the output string; if greater or equal to the
1415 length of the input string, the input string is returned
1416 value2 the number of hash characters to use, or 26 if negative
1417 len set to the length of the returned string
1419 Returns: pointer to the output string, or NULL if there is an error
1423 compute_hash(uschar *subject, int value1, int value2, int *len)
1425 int sublen = Ustrlen(subject);
1427 if (value2 < 0) value2 = 26;
1428 else if (value2 > Ustrlen(hashcodes))
1430 expand_string_message =
1431 string_sprintf("hash count \"%d\" too big", value2);
1435 /* Calculate the hash text. We know it is shorter than the original string, so
1436 can safely place it in subject[] (we know that subject is always itself an
1437 expanded substring). */
1439 if (value1 < sublen)
1444 while ((c = (subject[j])) != 0)
1446 int shift = (c + j++) & 7;
1447 subject[i] ^= (c << shift) | (c >> (8-shift));
1448 if (++i >= value1) i = 0;
1450 for (i = 0; i < value1; i++)
1451 subject[i] = hashcodes[(subject[i]) % value2];
1453 else value1 = sublen;
1462 /*************************************************
1463 * Numeric hash of a string *
1464 *************************************************/
1466 /* Perform the ${nhash expansion operation. The first characters of the
1467 string are treated as most important, and get the highest prime numbers.
1470 subject the input string
1471 value1 the maximum value of the first part of the result
1472 value2 the maximum value of the second part of the result,
1473 or negative to produce only a one-part result
1474 len set to the length of the returned string
1476 Returns: pointer to the output string, or NULL if there is an error.
1480 compute_nhash (uschar *subject, int value1, int value2, int *len)
1482 uschar *s = subject;
1484 unsigned long int total = 0; /* no overflow */
1488 if (i == 0) i = nelem(prime) - 1;
1489 total += prime[i--] * (unsigned int)(*s++);
1492 /* If value2 is unset, just compute one number */
1495 s = string_sprintf("%lu", total % value1);
1497 /* Otherwise do a div/mod hash */
1501 total = total % (value1 * value2);
1502 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1513 /*************************************************
1514 * Find the value of a header or headers *
1515 *************************************************/
1517 /* Multiple instances of the same header get concatenated, and this function
1518 can also return a concatenation of all the header lines. When concatenating
1519 specific headers that contain lists of addresses, a comma is inserted between
1520 them. Otherwise we use a straight concatenation. Because some messages can have
1521 pathologically large number of lines, there is a limit on the length that is
1522 returned. Also, to avoid massive store use which would result from using
1523 string_cat() as it copies and extends strings, we do a preliminary pass to find
1524 out exactly how much store will be needed. On "normal" messages this will be
1528 name the name of the header, without the leading $header_ or $h_,
1529 or NULL if a concatenation of all headers is required
1530 exists_only TRUE if called from a def: test; don't need to build a string;
1531 just return a string that is not "" and not "0" if the header
1533 newsize return the size of memory block that was obtained; may be NULL
1534 if exists_only is TRUE
1535 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1536 other than concatenating, will be done on the header. Also used
1537 for $message_headers_raw.
1538 charset name of charset to translate MIME words to; used only if
1539 want_raw is false; if NULL, no translation is done (this is
1540 used for $bh_ and $bheader_)
1542 Returns: NULL if the header does not exist, else a pointer to a new
1547 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1550 BOOL found = name == NULL;
1552 int len = found? 0 : Ustrlen(name);
1554 uschar *yield = NULL;
1557 /* Loop for two passes - saves code repetition */
1559 for (i = 0; i < 2; i++)
1564 for (h = header_list; size < header_insert_maxlen && h; h = h->next)
1565 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1566 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1571 if (exists_only) return US"1"; /* don't need actual string */
1573 t = h->text + len; /* text to insert */
1574 if (!want_raw) /* unless wanted raw, */
1575 while (isspace(*t)) t++; /* remove leading white space */
1576 ilen = h->slen - (t - h->text); /* length to insert */
1578 /* Unless wanted raw, remove trailing whitespace, including the
1582 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1584 /* Set comma = 1 if handling a single header and it's one of those
1585 that contains an address list, except when asked for raw headers. Only
1586 need to do this once. */
1588 if (!want_raw && name && comma == 0 &&
1589 Ustrchr("BCFRST", h->type) != NULL)
1592 /* First pass - compute total store needed; second pass - compute
1593 total store used, including this header. */
1595 size += ilen + comma + 1; /* +1 for the newline */
1597 /* Second pass - concatenate the data, up to a maximum. Note that
1598 the loop stops when size hits the limit. */
1602 if (size > header_insert_maxlen)
1604 ilen -= size - header_insert_maxlen - 1;
1607 Ustrncpy(ptr, t, ilen);
1610 /* For a non-raw header, put in the comma if needed, then add
1611 back the newline we removed above, provided there was some text in
1614 if (!want_raw && ilen > 0)
1616 if (comma != 0) *ptr++ = ',';
1622 /* At end of first pass, return NULL if no header found. Then truncate size
1623 if necessary, and get the buffer to hold the data, returning the buffer size.
1628 if (!found) return NULL;
1629 if (size > header_insert_maxlen) size = header_insert_maxlen;
1630 *newsize = size + 1;
1631 ptr = yield = store_get(*newsize);
1635 /* That's all we do for raw header expansion. */
1640 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1641 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1642 function can return an error with decoded data if the charset translation
1643 fails. If decoding fails, it returns NULL. */
1647 uschar *decoded, *error;
1648 if (ptr > yield && ptr[-1] == '\n') ptr--;
1649 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1651 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1655 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1656 " input was: %s\n", error, yield);
1658 if (decoded != NULL) yield = decoded;
1667 /* Append an "iprev" element to an Autherntication-Results: header
1668 if we have attempted to get the calling host's name.
1672 authres_iprev(gstring * g)
1674 if (sender_host_name)
1675 return string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1676 if (host_lookup_deferred)
1677 return string_catn(g, US";\n\tiprev=temperror", 19);
1678 if (host_lookup_failed)
1679 return string_catn(g, US";\n\tiprev=fail", 13);
1685 /*************************************************
1686 * Return list of recipients *
1687 *************************************************/
1688 /* A recipients list is available only during system message filtering,
1689 during ACL processing after DATA, and while expanding pipe commands
1690 generated from a system filter, but not elsewhere. */
1698 if (!enable_dollar_recipients) return NULL;
1700 for (i = 0; i < recipients_count; i++)
1702 /*XXX variant of list_appendele? */
1703 if (i != 0) g = string_catn(g, US", ", 2);
1704 g = string_cat(g, recipients_list[i].address);
1706 return string_from_gstring(g);
1710 /*************************************************
1711 * Find value of a variable *
1712 *************************************************/
1714 /* The table of variables is kept in alphabetic order, so we can search it
1715 using a binary chop. The "choplen" variable is nothing to do with the binary
1719 name the name of the variable being sought
1720 exists_only TRUE if this is a def: test; passed on to find_header()
1721 skipping TRUE => skip any processing evaluation; this is not the same as
1722 exists_only because def: may test for values that are first
1724 newsize pointer to an int which is initially zero; if the answer is in
1725 a new memory buffer, *newsize is set to its size
1727 Returns: NULL if the variable does not exist, or
1728 a pointer to the variable's contents, or
1729 something non-NULL if exists_only is TRUE
1733 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1740 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1741 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1742 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1743 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1744 (this gave backwards compatibility at the changeover). There may be built-in
1745 variables whose names start acl_ but they should never start in this way. This
1746 slightly messy specification is a consequence of the history, needless to say.
1748 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1749 set, in which case give an error. */
1751 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1755 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1756 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1759 /* Handle $auth<n> variables. */
1761 if (Ustrncmp(name, "auth", 4) == 0)
1764 int n = Ustrtoul(name + 4, &endptr, 10);
1765 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1766 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1768 else if (Ustrncmp(name, "regex", 5) == 0)
1771 int n = Ustrtoul(name + 5, &endptr, 10);
1772 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1773 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1776 /* For all other variables, search the table */
1778 if (!(vp = find_var_ent(name)))
1779 return NULL; /* Unknown variable name */
1781 /* Found an existing variable. If in skipping state, the value isn't needed,
1782 and we want to avoid processing (such as looking up the host name). */
1790 case vtype_filter_int:
1791 if (!filter_running) return NULL;
1795 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1799 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1803 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1807 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1811 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1814 case vtype_stringptr: /* Pointer to string */
1815 return (s = *((uschar **)(val))) ? s : US"";
1818 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1821 case vtype_load_avg:
1822 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1825 case vtype_host_lookup: /* Lookup if not done so */
1826 if ( !sender_host_name && sender_host_address
1827 && !host_lookup_failed && host_name_lookup() == OK)
1828 host_build_sender_fullhost();
1829 return sender_host_name ? sender_host_name : US"";
1831 case vtype_localpart: /* Get local part from address */
1832 s = *((uschar **)(val));
1833 if (s == NULL) return US"";
1834 domain = Ustrrchr(s, '@');
1835 if (domain == NULL) return s;
1836 if (domain - s > sizeof(var_buffer) - 1)
1837 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1838 " in string expansion", sizeof(var_buffer));
1839 Ustrncpy(var_buffer, s, domain - s);
1840 var_buffer[domain - s] = 0;
1843 case vtype_domain: /* Get domain from address */
1844 s = *((uschar **)(val));
1845 if (s == NULL) return US"";
1846 domain = Ustrrchr(s, '@');
1847 return (domain == NULL)? US"" : domain + 1;
1849 case vtype_msgheaders:
1850 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1852 case vtype_msgheaders_raw:
1853 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1855 case vtype_msgbody: /* Pointer to msgbody string */
1856 case vtype_msgbody_end: /* Ditto, the end of the msg */
1857 ss = (uschar **)(val);
1858 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1861 off_t start_offset = SPOOL_DATA_START_OFFSET;
1862 int len = message_body_visible;
1863 if (len > message_size) len = message_size;
1864 *ss = body = store_malloc(len+1);
1866 if (vp->type == vtype_msgbody_end)
1868 struct stat statbuf;
1869 if (fstat(deliver_datafile, &statbuf) == 0)
1871 start_offset = statbuf.st_size - len;
1872 if (start_offset < SPOOL_DATA_START_OFFSET)
1873 start_offset = SPOOL_DATA_START_OFFSET;
1876 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1877 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1879 len = read(deliver_datafile, body, len);
1883 if (message_body_newlines) /* Separate loops for efficiency */
1885 { if (body[--len] == 0) body[len] = ' '; }
1888 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1891 return *ss ? *ss : US"";
1893 case vtype_todbsdin: /* BSD inbox time of day */
1894 return tod_stamp(tod_bsdin);
1896 case vtype_tode: /* Unix epoch time of day */
1897 return tod_stamp(tod_epoch);
1899 case vtype_todel: /* Unix epoch/usec time of day */
1900 return tod_stamp(tod_epoch_l);
1902 case vtype_todf: /* Full time of day */
1903 return tod_stamp(tod_full);
1905 case vtype_todl: /* Log format time of day */
1906 return tod_stamp(tod_log_bare); /* (without timezone) */
1908 case vtype_todzone: /* Time zone offset only */
1909 return tod_stamp(tod_zone);
1911 case vtype_todzulu: /* Zulu time */
1912 return tod_stamp(tod_zulu);
1914 case vtype_todlf: /* Log file datestamp tod */
1915 return tod_stamp(tod_log_datestamp_daily);
1917 case vtype_reply: /* Get reply address */
1918 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1920 if (s != NULL) while (isspace(*s)) s++;
1921 if (s == NULL || *s == 0)
1923 *newsize = 0; /* For the *s==0 case */
1924 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1929 while (isspace(*s)) s++;
1930 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1931 while (t > s && isspace(t[-1])) t--;
1934 return (s == NULL)? US"" : s;
1936 case vtype_string_func:
1938 uschar * (*fn)() = val;
1945 sprintf(CS var_buffer, "%d",
1946 receive_statvfs(val == (void *)TRUE, &inodes));
1953 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1954 sprintf(CS var_buffer, "%d", inodes);
1959 return *(void **)val ? US"<cert>" : US"";
1961 #ifndef DISABLE_DKIM
1963 return dkim_exim_expand_query((int)(long)val);
1968 return NULL; /* Unknown variable. Silences static checkers. */
1975 modify_variable(uschar *name, void * value)
1978 if ((vp = find_var_ent(name))) vp->value = value;
1979 return; /* Unknown variable name, fail silently */
1987 /*************************************************
1988 * Read and expand substrings *
1989 *************************************************/
1991 /* This function is called to read and expand argument substrings for various
1992 expansion items. Some have a minimum requirement that is less than the maximum;
1993 in these cases, the first non-present one is set to NULL.
1996 sub points to vector of pointers to set
1997 n maximum number of substrings
1999 sptr points to current string pointer
2000 skipping the skipping flag
2001 check_end if TRUE, check for final '}'
2002 name name of item, for error message
2003 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2006 Returns: 0 OK; string pointer updated
2007 1 curly bracketing error (too few arguments)
2008 2 too many arguments (only if check_end is set); message set
2009 3 other error (expansion failure)
2013 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
2014 BOOL check_end, uschar *name, BOOL *resetok)
2017 const uschar *s = *sptr;
2019 while (isspace(*s)) s++;
2020 for (i = 0; i < n; i++)
2026 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2027 "(min is %d)", name, m);
2033 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2035 if (*s++ != '}') return 1;
2036 while (isspace(*s)) s++;
2038 if (check_end && *s++ != '}')
2042 expand_string_message = string_sprintf("Too many arguments for '%s' "
2043 "(max is %d)", name, n);
2046 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2057 /*************************************************
2058 * Elaborate message for bad variable *
2059 *************************************************/
2061 /* For the "unknown variable" message, take a look at the variable's name, and
2062 give additional information about possible ACL variables. The extra information
2063 is added on to expand_string_message.
2065 Argument: the name of the variable
2070 check_variable_error_message(uschar *name)
2072 if (Ustrncmp(name, "acl_", 4) == 0)
2073 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2074 (name[4] == 'c' || name[4] == 'm')?
2076 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2077 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2079 US"user-defined ACL variables must start acl_c or acl_m");
2085 Load args from sub array to globals, and call acl_check().
2086 Sub array will be corrupted on return.
2088 Returns: OK access is granted by an ACCEPT verb
2089 DISCARD access is (apparently) granted by a DISCARD verb
2090 FAIL access is denied
2091 FAIL_DROP access is denied; drop the connection
2092 DEFER can't tell at the moment
2096 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2099 int sav_narg = acl_narg;
2101 uschar * dummy_logmsg;
2102 extern int acl_where;
2104 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2105 for (i = 0; i < nsub && sub[i+1]; i++)
2107 uschar * tmp = acl_arg[i];
2108 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2109 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2114 sub[i+1] = acl_arg[i];
2115 acl_arg[i++] = NULL;
2119 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2121 acl_narg>0 ? acl_arg[0] : US"<none>",
2122 acl_narg>1 ? " +more" : "");
2124 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2126 for (i = 0; i < nsub; i++)
2127 acl_arg[i] = sub[i+1]; /* restore old args */
2128 acl_narg = sav_narg;
2136 /*************************************************
2137 * Read and evaluate a condition *
2138 *************************************************/
2142 s points to the start of the condition text
2143 resetok points to a BOOL which is written false if it is unsafe to
2144 free memory. Certain condition types (acl) may have side-effect
2145 allocation which must be preserved.
2146 yield points to a BOOL to hold the result of the condition test;
2147 if NULL, we are just reading through a condition that is
2148 part of an "or" combination to check syntax, or in a state
2149 where the answer isn't required
2151 Returns: a pointer to the first character after the condition, or
2155 static const uschar *
2156 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2158 BOOL testfor = TRUE;
2159 BOOL tempcond, combined_cond;
2161 BOOL sub2_honour_dollar = TRUE;
2162 int i, rc, cond_type, roffset;
2163 int_eximarith_t num[2];
2164 struct stat statbuf;
2166 const uschar *sub[10];
2169 const uschar *rerror;
2173 while (isspace(*s)) s++;
2174 if (*s == '!') { testfor = !testfor; s++; } else break;
2177 /* Numeric comparisons are symbolic */
2179 if (*s == '=' || *s == '>' || *s == '<')
2191 /* All other conditions are named */
2193 else s = read_name(name, 256, s, US"_");
2195 /* If we haven't read a name, it means some non-alpha character is first. */
2199 expand_string_message = string_sprintf("condition name expected, "
2200 "but found \"%.16s\"", s);
2204 /* Find which condition we are dealing with, and switch on it */
2206 cond_type = chop_match(name, cond_table, nelem(cond_table));
2209 /* def: tests for a non-empty variable, or for the existence of a header. If
2210 yield == NULL we are in a skipping state, and don't care about the answer. */
2215 expand_string_message = US"\":\" expected after \"def\"";
2219 s = read_name(name, 256, s+1, US"_");
2221 /* Test for a header's existence. If the name contains a closing brace
2222 character, this may be a user error where the terminating colon has been
2223 omitted. Set a flag to adjust a subsequent error message in this case. */
2225 if (Ustrncmp(name, "h_", 2) == 0 ||
2226 Ustrncmp(name, "rh_", 3) == 0 ||
2227 Ustrncmp(name, "bh_", 3) == 0 ||
2228 Ustrncmp(name, "header_", 7) == 0 ||
2229 Ustrncmp(name, "rheader_", 8) == 0 ||
2230 Ustrncmp(name, "bheader_", 8) == 0)
2232 s = read_header_name(name, 256, s);
2233 /* {-for-text-editors */
2234 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2235 if (yield != NULL) *yield =
2236 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2239 /* Test for a variable's having a non-empty value. A non-existent variable
2240 causes an expansion failure. */
2244 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2247 expand_string_message = (name[0] == 0)?
2248 string_sprintf("variable name omitted after \"def:\"") :
2249 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2250 check_variable_error_message(name);
2253 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2259 /* first_delivery tests for first delivery attempt */
2261 case ECOND_FIRST_DELIVERY:
2262 if (yield != NULL) *yield = deliver_firsttime == testfor;
2266 /* queue_running tests for any process started by a queue runner */
2268 case ECOND_QUEUE_RUNNING:
2269 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2273 /* exists: tests for file existence
2274 isip: tests for any IP address
2275 isip4: tests for an IPv4 address
2276 isip6: tests for an IPv6 address
2277 pam: does PAM authentication
2278 radius: does RADIUS authentication
2279 ldapauth: does LDAP authentication
2280 pwcheck: does Cyrus SASL pwcheck authentication
2289 case ECOND_LDAPAUTH:
2292 while (isspace(*s)) s++;
2293 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2295 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2296 if (sub[0] == NULL) return NULL;
2297 /* {-for-text-editors */
2298 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2300 if (yield == NULL) return s; /* No need to run the test if skipping */
2305 if ((expand_forbid & RDO_EXISTS) != 0)
2307 expand_string_message = US"File existence tests are not permitted";
2310 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2316 rc = string_is_ip_address(sub[0], NULL);
2317 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2318 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2321 /* Various authentication tests - all optionally compiled */
2325 rc = auth_call_pam(sub[0], &expand_string_message);
2328 goto COND_FAILED_NOT_COMPILED;
2329 #endif /* SUPPORT_PAM */
2332 #ifdef RADIUS_CONFIG_FILE
2333 rc = auth_call_radius(sub[0], &expand_string_message);
2336 goto COND_FAILED_NOT_COMPILED;
2337 #endif /* RADIUS_CONFIG_FILE */
2339 case ECOND_LDAPAUTH:
2342 /* Just to keep the interface the same */
2344 int old_pool = store_pool;
2345 store_pool = POOL_SEARCH;
2346 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2347 &expand_string_message, &do_cache);
2348 store_pool = old_pool;
2352 goto COND_FAILED_NOT_COMPILED;
2353 #endif /* LOOKUP_LDAP */
2356 #ifdef CYRUS_PWCHECK_SOCKET
2357 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2360 goto COND_FAILED_NOT_COMPILED;
2361 #endif /* CYRUS_PWCHECK_SOCKET */
2363 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2364 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2366 if (rc == ERROR || rc == DEFER) return NULL;
2367 *yield = (rc == OK) == testfor;
2373 /* call ACL (in a conditional context). Accept true, deny false.
2374 Defer is a forced-fail. Anything set by message= goes to $value.
2375 Up to ten parameters are used; we use the braces round the name+args
2376 like the saslauthd condition does, to permit a variable number of args.
2377 See also the expansion-item version EITEM_ACL and the traditional
2378 acl modifier ACLC_ACL.
2379 Since the ACL may allocate new global variables, tell our caller to not
2384 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2390 while (isspace(*s)) s++;
2391 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2393 switch(read_subs(sub, nelem(sub), 1,
2394 &s, yield == NULL, TRUE, US"acl", resetok))
2396 case 1: expand_string_message = US"too few arguments or bracketing "
2399 case 3: return NULL;
2404 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2405 switch(eval_acl(sub, nelem(sub), &user_msg))
2410 lookup_value = NULL;
2412 lookup_value = string_copy(user_msg);
2413 *yield = cond == testfor;
2417 expand_string_forcedfail = TRUE;
2420 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2428 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2430 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2432 However, the last two are optional. That is why the whole set is enclosed
2433 in their own set of braces. */
2435 case ECOND_SASLAUTHD:
2436 #ifndef CYRUS_SASLAUTHD_SOCKET
2437 goto COND_FAILED_NOT_COMPILED;
2441 while (isspace(*s)) s++;
2442 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2443 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2446 case 1: expand_string_message = US"too few arguments or bracketing "
2447 "error for saslauthd";
2449 case 3: return NULL;
2451 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2454 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2455 &expand_string_message);
2456 if (rc == ERROR || rc == DEFER) return NULL;
2457 *yield = (rc == OK) == testfor;
2461 #endif /* CYRUS_SASLAUTHD_SOCKET */
2464 /* symbolic operators for numeric and string comparison, and a number of
2465 other operators, all requiring two arguments.
2467 crypteq: encrypts plaintext and compares against an encrypted text,
2468 using crypt(), crypt16(), MD5 or SHA-1
2469 inlist/inlisti: checks if first argument is in the list of the second
2470 match: does a regular expression match and sets up the numerical
2471 variables if it succeeds
2472 match_address: matches in an address list
2473 match_domain: matches in a domain list
2474 match_ip: matches a host list that is restricted to IP addresses
2475 match_local_part: matches in a local part list
2478 case ECOND_MATCH_ADDRESS:
2479 case ECOND_MATCH_DOMAIN:
2480 case ECOND_MATCH_IP:
2481 case ECOND_MATCH_LOCAL_PART:
2482 #ifndef EXPAND_LISTMATCH_RHS
2483 sub2_honour_dollar = FALSE;
2492 case ECOND_NUM_L: /* Numerical comparisons */
2499 case ECOND_STR_LT: /* String comparisons */
2510 for (i = 0; i < 2; i++)
2512 /* Sometimes, we don't expand substrings; too many insecure configurations
2513 created using match_address{}{} and friends, where the second param
2514 includes information from untrustworthy sources. */
2515 BOOL honour_dollar = TRUE;
2516 if ((i > 0) && !sub2_honour_dollar)
2517 honour_dollar = FALSE;
2519 while (isspace(*s)) s++;
2522 if (i == 0) goto COND_FAILED_CURLY_START;
2523 expand_string_message = string_sprintf("missing 2nd string in {} "
2524 "after \"%s\"", name);
2527 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2528 honour_dollar, resetok)))
2530 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2531 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2532 " for security reasons\n");
2533 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2535 /* Convert to numerical if required; we know that the names of all the
2536 conditions that compare numbers do not start with a letter. This just saves
2537 checking for them individually. */
2539 if (!isalpha(name[0]) && yield != NULL)
2544 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2548 num[i] = expanded_string_integer(sub[i], FALSE);
2549 if (expand_string_message != NULL) return NULL;
2553 /* Result not required */
2555 if (yield == NULL) return s;
2557 /* Do an appropriate comparison */
2563 tempcond = (num[0] == num[1]);
2567 tempcond = (num[0] > num[1]);
2571 tempcond = (num[0] >= num[1]);
2575 tempcond = (num[0] < num[1]);
2579 tempcond = (num[0] <= num[1]);
2583 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2587 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2591 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2595 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2599 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2603 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2607 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2611 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2615 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2619 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2622 case ECOND_MATCH: /* Regular expression match */
2623 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2627 expand_string_message = string_sprintf("regular expression error in "
2628 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2631 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2634 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2635 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2636 goto MATCHED_SOMETHING;
2638 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2639 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2640 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2641 goto MATCHED_SOMETHING;
2643 case ECOND_MATCH_IP: /* Match IP address in a host list */
2644 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2646 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2652 unsigned int *nullcache = NULL;
2653 check_host_block cb;
2655 cb.host_name = US"";
2656 cb.host_address = sub[0];
2658 /* If the host address starts off ::ffff: it is an IPv6 address in
2659 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2662 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2663 cb.host_address + 7 : cb.host_address;
2665 rc = match_check_list(
2666 &sub[1], /* the list */
2667 0, /* separator character */
2668 &hostlist_anchor, /* anchor pointer */
2669 &nullcache, /* cache pointer */
2670 check_host, /* function for testing */
2671 &cb, /* argument for function */
2672 MCL_HOST, /* type of check */
2673 sub[0], /* text for debugging */
2674 NULL); /* where to pass back data */
2676 goto MATCHED_SOMETHING;
2678 case ECOND_MATCH_LOCAL_PART:
2679 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2680 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2695 expand_string_message = string_sprintf("unable to complete match "
2696 "against \"%s\": %s", sub[1], search_error_message);
2702 /* Various "encrypted" comparisons. If the second string starts with
2703 "{" then an encryption type is given. Default to crypt() or crypt16()
2704 (build-time choice). */
2705 /* }-for-text-editors */
2708 #ifndef SUPPORT_CRYPTEQ
2709 goto COND_FAILED_NOT_COMPILED;
2711 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2713 int sublen = Ustrlen(sub[1]+5);
2718 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2720 /* If the length that we are comparing against is 24, the MD5 digest
2721 is expressed as a base64 string. This is the way LDAP does it. However,
2722 some other software uses a straightforward hex representation. We assume
2723 this if the length is 32. Other lengths fail. */
2727 uschar *coded = b64encode(digest, 16);
2728 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2729 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2730 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2732 else if (sublen == 32)
2736 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2738 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2739 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2740 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2744 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2745 "fail\n crypted=%s\n", sub[1]+5);
2750 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2752 int sublen = Ustrlen(sub[1]+6);
2757 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2759 /* If the length that we are comparing against is 28, assume the SHA1
2760 digest is expressed as a base64 string. If the length is 40, assume a
2761 straightforward hex representation. Other lengths fail. */
2765 uschar *coded = b64encode(digest, 20);
2766 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2767 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2768 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2770 else if (sublen == 40)
2774 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2776 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2777 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2778 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2782 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2783 "fail\n crypted=%s\n", sub[1]+6);
2788 else /* {crypt} or {crypt16} and non-{ at start */
2789 /* }-for-text-editors */
2794 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2799 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2804 else if (sub[1][0] == '{') /* }-for-text-editors */
2806 expand_string_message = string_sprintf("unknown encryption mechanism "
2807 "in \"%s\"", sub[1]);
2813 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2814 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2815 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2819 #define XSTR(s) STR(s)
2820 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2821 " subject=%s\n crypted=%s\n",
2822 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2827 /* If the encrypted string contains fewer than two characters (for the
2828 salt), force failure. Otherwise we get false positives: with an empty
2829 string the yield of crypt() is an empty string! */
2832 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2833 else if (errno == EINVAL)
2837 expand_string_message = string_sprintf("crypt error: %s\n",
2838 US strerror(errno));
2843 #endif /* SUPPORT_CRYPTEQ */
2848 const uschar * list = sub[1];
2850 uschar *save_iterate_item = iterate_item;
2851 int (*compare)(const uschar *, const uschar *);
2853 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", name, sub[0]);
2856 compare = cond_type == ECOND_INLISTI
2857 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2859 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2861 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
2862 if (compare(sub[0], iterate_item) == 0)
2868 iterate_item = save_iterate_item;
2871 } /* Switch for comparison conditions */
2873 *yield = tempcond == testfor;
2874 return s; /* End of comparison conditions */
2877 /* and/or: computes logical and/or of several conditions */
2881 subcondptr = (yield == NULL)? NULL : &tempcond;
2882 combined_cond = (cond_type == ECOND_AND);
2884 while (isspace(*s)) s++;
2885 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2889 while (isspace(*s)) s++;
2890 /* {-for-text-editors */
2891 if (*s == '}') break;
2892 if (*s != '{') /* }-for-text-editors */
2894 expand_string_message = string_sprintf("each subcondition "
2895 "inside an \"%s{...}\" condition must be in its own {}", name);
2899 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2901 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2902 expand_string_message, name);
2905 while (isspace(*s)) s++;
2907 /* {-for-text-editors */
2910 /* {-for-text-editors */
2911 expand_string_message = string_sprintf("missing } at end of condition "
2912 "inside \"%s\" group", name);
2918 if (cond_type == ECOND_AND)
2920 combined_cond &= tempcond;
2921 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2922 } /* evaluate any more */
2925 combined_cond |= tempcond;
2926 if (combined_cond) subcondptr = NULL; /* once true, don't */
2927 } /* evaluate any more */
2931 if (yield != NULL) *yield = (combined_cond == testfor);
2935 /* forall/forany: iterates a condition with different values */
2940 const uschar * list;
2942 uschar *save_iterate_item = iterate_item;
2944 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2946 while (isspace(*s)) s++;
2947 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2948 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2949 if (sub[0] == NULL) return NULL;
2950 /* {-for-text-editors */
2951 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2953 while (isspace(*s)) s++;
2954 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2958 /* Call eval_condition once, with result discarded (as if scanning a
2959 "false" part). This allows us to find the end of the condition, because if
2960 the list it empty, we won't actually evaluate the condition for real. */
2962 if (!(s = eval_condition(sub[1], resetok, NULL)))
2964 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2965 expand_string_message, name);
2968 while (isspace(*s)) s++;
2970 /* {-for-text-editors */
2973 /* {-for-text-editors */
2974 expand_string_message = string_sprintf("missing } at end of condition "
2975 "inside \"%s\"", name);
2979 if (yield != NULL) *yield = !testfor;
2981 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2983 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, iterate_item);
2984 if (!eval_condition(sub[1], resetok, &tempcond))
2986 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2987 expand_string_message, name);
2988 iterate_item = save_iterate_item;
2991 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", name,
2992 tempcond? "true":"false");
2994 if (yield != NULL) *yield = (tempcond == testfor);
2995 if (tempcond == (cond_type == ECOND_FORANY)) break;
2998 iterate_item = save_iterate_item;
3003 /* The bool{} expansion condition maps a string to boolean.
3004 The values supported should match those supported by the ACL condition
3005 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3006 of true/false. Note that Router "condition" rules have a different
3007 interpretation, where general data can be used and only a few values
3009 Note that readconf.c boolean matching, for boolean configuration options,
3010 only matches true/yes/false/no.
3011 The bool_lax{} condition matches the Router logic, which is much more
3014 case ECOND_BOOL_LAX:
3020 BOOL boolvalue = FALSE;
3021 while (isspace(*s)) s++;
3022 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3023 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3024 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3026 case 1: expand_string_message = string_sprintf(
3027 "too few arguments or bracketing error for %s",
3031 case 3: return NULL;
3034 while (isspace(*t)) t++;
3038 /* trailing whitespace: seems like a good idea to ignore it too */
3040 while (isspace(*t2)) t2--;
3041 if (t2 != (t + len))
3048 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3049 /* logic for the lax case from expand_check_condition(), which also does
3050 expands, and the logic is both short and stable enough that there should
3051 be no maintenance burden from replicating it. */
3055 ? Ustrspn(t+1, "0123456789") == len-1
3056 : Ustrspn(t, "0123456789") == len)
3058 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3059 /* expand_check_condition only does a literal string "0" check */
3060 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3063 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3065 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3067 else if (cond_type == ECOND_BOOL_LAX)
3071 expand_string_message = string_sprintf("unrecognised boolean "
3075 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3076 boolvalue? "true":"false");
3077 if (yield != NULL) *yield = (boolvalue == testfor);
3081 /* Unknown condition */
3084 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3086 } /* End switch on condition type */
3088 /* Missing braces at start and end of data */
3090 COND_FAILED_CURLY_START:
3091 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3094 COND_FAILED_CURLY_END:
3095 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3099 /* A condition requires code that is not compiled */
3101 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3102 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3103 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3104 COND_FAILED_NOT_COMPILED:
3105 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3114 /*************************************************
3115 * Save numerical variables *
3116 *************************************************/
3118 /* This function is called from items such as "if" that want to preserve and
3119 restore the numbered variables.
3122 save_expand_string points to an array of pointers to set
3123 save_expand_nlength points to an array of ints for the lengths
3125 Returns: the value of expand max to save
3129 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3132 for (i = 0; i <= expand_nmax; i++)
3134 save_expand_nstring[i] = expand_nstring[i];
3135 save_expand_nlength[i] = expand_nlength[i];
3142 /*************************************************
3143 * Restore numerical variables *
3144 *************************************************/
3146 /* This function restored saved values of numerical strings.
3149 save_expand_nmax the number of strings to restore
3150 save_expand_string points to an array of pointers
3151 save_expand_nlength points to an array of ints
3157 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3158 int *save_expand_nlength)
3161 expand_nmax = save_expand_nmax;
3162 for (i = 0; i <= expand_nmax; i++)
3164 expand_nstring[i] = save_expand_nstring[i];
3165 expand_nlength[i] = save_expand_nlength[i];
3173 /*************************************************
3174 * Handle yes/no substrings *
3175 *************************************************/
3177 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3178 alternative substrings that depend on whether or not the condition was true,
3179 or the lookup or extraction succeeded. The substrings always have to be
3180 expanded, to check their syntax, but "skipping" is set when the result is not
3181 needed - this avoids unnecessary nested lookups.
3184 skipping TRUE if we were skipping when this item was reached
3185 yes TRUE if the first string is to be used, else use the second
3186 save_lookup a value to put back into lookup_value before the 2nd expansion
3187 sptr points to the input string pointer
3188 yieldptr points to the output growable-string pointer
3189 type "lookup", "if", "extract", "run", "env", "listextract" or
3190 "certextract" for error message
3191 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3194 Returns: 0 OK; lookup_value has been reset to save_lookup
3196 2 expansion failed because of bracketing error
3200 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3201 gstring ** yieldptr, uschar *type, BOOL *resetok)
3204 const uschar *s = *sptr; /* Local value */
3205 uschar *sub1, *sub2;
3206 const uschar * errwhere;
3208 /* If there are no following strings, we substitute the contents of $value for
3209 lookups and for extractions in the success case. For the ${if item, the string
3210 "true" is substituted. In the fail case, nothing is substituted for all three
3213 while (isspace(*s)) s++;
3218 if (yes && !skipping)
3219 *yieldptr = string_catn(*yieldptr, US"true", 4);
3223 if (yes && lookup_value && !skipping)
3224 *yieldptr = string_cat(*yieldptr, lookup_value);
3225 lookup_value = save_lookup;
3231 /* The first following string must be braced. */
3235 errwhere = US"'yes' part did not start with '{'";
3239 /* Expand the first substring. Forced failures are noticed only if we actually
3240 want this string. Set skipping in the call in the fail case (this will always
3241 be the case if we were already skipping). */
3243 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3244 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3245 expand_string_forcedfail = FALSE;
3248 errwhere = US"'yes' part did not end with '}'";
3252 /* If we want the first string, add it to the output */
3255 *yieldptr = string_cat(*yieldptr, sub1);
3257 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3258 $value to what it was at the start of the item, so that it has this value
3259 during the second string expansion. For the call from "if" or "run" to this
3260 function, save_lookup is set to lookup_value, so that this statement does
3263 lookup_value = save_lookup;
3265 /* There now follows either another substring, or "fail", or nothing. This
3266 time, forced failures are noticed only if we want the second string. We must
3267 set skipping in the nested call if we don't want this string, or if we were
3268 already skipping. */
3270 while (isspace(*s)) s++;
3273 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3274 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3275 expand_string_forcedfail = FALSE;
3278 errwhere = US"'no' part did not start with '{'";
3282 /* If we want the second string, add it to the output */
3285 *yieldptr = string_cat(*yieldptr, sub2);
3288 /* If there is no second string, but the word "fail" is present when the use of
3289 the second string is wanted, set a flag indicating it was a forced failure
3290 rather than a syntactic error. Swallow the terminating } in case this is nested
3291 inside another lookup or if or extract. */
3296 /* deconst cast ok here as source is s anyway */
3297 s = US read_name(name, sizeof(name), s, US"_");
3298 if (Ustrcmp(name, "fail") == 0)
3300 if (!yes && !skipping)
3302 while (isspace(*s)) s++;
3305 errwhere = US"did not close with '}' after forcedfail";
3308 expand_string_message =
3309 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3310 expand_string_forcedfail = TRUE;
3316 expand_string_message =
3317 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3322 /* All we have to do now is to check on the final closing brace. */
3324 while (isspace(*s)) s++;
3327 errwhere = US"did not close with '}'";
3333 /* Update the input pointer value before returning */
3338 /* Get here if there is a bracketing failure */
3339 expand_string_message = string_sprintf(
3340 "curly-bracket problem in conditional yes/no parsing: %s\n"
3341 " remaining string is '%s'", errwhere, --s);
3346 /* Get here for other failures */
3354 /*************************************************
3355 * Handle MD5 or SHA-1 computation for HMAC *
3356 *************************************************/
3358 /* These are some wrapping functions that enable the HMAC code to be a bit
3359 cleaner. A good compiler will spot the tail recursion.
3362 type HMAC_MD5 or HMAC_SHA1
3363 remaining are as for the cryptographic hash functions
3369 chash_start(int type, void *base)
3371 if (type == HMAC_MD5)
3372 md5_start((md5 *)base);
3374 sha1_start((hctx *)base);
3378 chash_mid(int type, void *base, uschar *string)
3380 if (type == HMAC_MD5)
3381 md5_mid((md5 *)base, string);
3383 sha1_mid((hctx *)base, string);
3387 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3389 if (type == HMAC_MD5)
3390 md5_end((md5 *)base, string, length, digest);
3392 sha1_end((hctx *)base, string, length, digest);
3399 /********************************************************
3400 * prvs: Get last three digits of days since Jan 1, 1970 *
3401 ********************************************************/
3403 /* This is needed to implement the "prvs" BATV reverse
3406 Argument: integer "days" offset to add or substract to
3407 or from the current number of days.
3409 Returns: pointer to string containing the last three
3410 digits of the number of days since Jan 1, 1970,
3411 modified by the offset argument, NULL if there
3412 was an error in the conversion.
3417 prvs_daystamp(int day_offset)
3419 uschar *days = store_get(32); /* Need at least 24 for cases */
3420 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3421 (time(NULL) + day_offset*86400)/86400);
3422 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3427 /********************************************************
3428 * prvs: perform HMAC-SHA1 computation of prvs bits *
3429 ********************************************************/
3431 /* This is needed to implement the "prvs" BATV reverse
3435 address RFC2821 Address to use
3436 key The key to use (must be less than 64 characters
3438 key_num Single-digit key number to use. Defaults to
3441 Returns: pointer to string containing the first three
3442 bytes of the final hash in hex format, NULL if
3443 there was an error in the process.
3447 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3449 gstring * hash_source;
3453 uschar innerhash[20];
3454 uschar finalhash[20];
3455 uschar innerkey[64];
3456 uschar outerkey[64];
3457 uschar *finalhash_hex = store_get(40);
3459 if (key_num == NULL)
3462 if (Ustrlen(key) > 64)
3465 hash_source = string_catn(NULL, key_num, 1);
3466 hash_source = string_catn(hash_source, daystamp, 3);
3467 hash_source = string_cat(hash_source, address);
3468 (void) string_from_gstring(hash_source);
3471 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3473 memset(innerkey, 0x36, 64);
3474 memset(outerkey, 0x5c, 64);
3476 for (i = 0; i < Ustrlen(key); i++)
3478 innerkey[i] ^= key[i];
3479 outerkey[i] ^= key[i];
3482 chash_start(HMAC_SHA1, &h);
3483 chash_mid(HMAC_SHA1, &h, innerkey);
3484 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3486 chash_start(HMAC_SHA1, &h);
3487 chash_mid(HMAC_SHA1, &h, outerkey);
3488 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3491 for (i = 0; i < 3; i++)
3493 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3494 *p++ = hex_digits[finalhash[i] & 0x0f];
3498 return finalhash_hex;
3504 /*************************************************
3505 * Join a file onto the output string *
3506 *************************************************/
3508 /* This is used for readfile/readsock and after a run expansion.
3509 It joins the contents of a file onto the output string, globally replacing
3510 newlines with a given string (optionally).
3514 yield pointer to the expandable string struct
3515 eol newline replacement string, or NULL
3517 Returns: new pointer for expandable string, terminated if non-null
3521 cat_file(FILE *f, gstring *yield, uschar *eol)
3523 uschar buffer[1024];
3525 while (Ufgets(buffer, sizeof(buffer), f))
3527 int len = Ustrlen(buffer);
3528 if (eol && buffer[len-1] == '\n') len--;
3529 yield = string_catn(yield, buffer, len);
3530 if (eol && buffer[len])
3531 yield = string_cat(yield, eol);
3534 (void) string_from_gstring(yield);
3541 /*************************************************
3542 * Evaluate numeric expression *
3543 *************************************************/
3545 /* This is a set of mutually recursive functions that evaluate an arithmetic
3546 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3547 these functions that is called from elsewhere is eval_expr, whose interface is:
3550 sptr pointer to the pointer to the string - gets updated
3551 decimal TRUE if numbers are to be assumed decimal
3552 error pointer to where to put an error message - must be NULL on input
3553 endket TRUE if ')' must terminate - FALSE for external call
3555 Returns: on success: the value of the expression, with *error still NULL
3556 on failure: an undefined value, with *error = a message
3559 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3562 static int_eximarith_t
3563 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3566 int_eximarith_t x = eval_op_or(&s, decimal, error);
3572 *error = US"expecting closing parenthesis";
3574 while (isspace(*(++s)));
3576 else if (*s != 0) *error = US"expecting operator";
3583 static int_eximarith_t
3584 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3589 while (isspace(*s)) s++;
3594 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3596 switch (tolower(*s))
3599 case 'k': n *= 1024; s++; break;
3600 case 'm': n *= 1024*1024; s++; break;
3601 case 'g': n *= 1024*1024*1024; s++; break;
3603 while (isspace (*s)) s++;
3608 n = eval_expr(&s, decimal, error, 1);
3612 *error = US"expecting number or opening parenthesis";
3620 static int_eximarith_t
3621 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3625 while (isspace(*s)) s++;
3626 if (*s == '+' || *s == '-' || *s == '~')
3629 x = eval_op_unary(&s, decimal, error);
3630 if (op == '-') x = -x;
3631 else if (op == '~') x = ~x;
3635 x = eval_number(&s, decimal, error);
3642 static int_eximarith_t
3643 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3646 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3649 while (*s == '*' || *s == '/' || *s == '%')
3652 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3653 if (*error != NULL) break;
3654 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3655 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3656 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3657 * -N*M is INT_MIN will yield INT_MIN.
3658 * Since we don't support floating point, this is somewhat simpler.
3659 * Ideally, we'd return an error, but since we overflow for all other
3660 * arithmetic, consistency suggests otherwise, but what's the correct value
3661 * to use? There is none.
3662 * The C standard guarantees overflow for unsigned arithmetic but signed
3663 * overflow invokes undefined behaviour; in practice, this is overflow
3664 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3665 * that long/longlong larger than int are available, or we could just work
3666 * with larger types. We should consider whether to guarantee 32bit eval
3667 * and 64-bit working variables, with errors returned. For now ...
3668 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3669 * can just let the other invalid results occur otherwise, as they have
3670 * until now. For this one case, we can coerce.
3672 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3675 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3676 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3686 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3702 static int_eximarith_t
3703 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3706 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3709 while (*s == '+' || *s == '-')
3712 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3714 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3715 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3716 { /* over-conservative check */
3718 ? US"overflow in sum" : US"overflow in difference";
3721 if (op == '+') x += y; else x -= y;
3729 static int_eximarith_t
3730 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3733 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3736 while ((*s == '<' || *s == '>') && s[1] == s[0])
3741 y = eval_op_sum(&s, decimal, error);
3742 if (*error != NULL) break;
3743 if (op == '<') x <<= y; else x >>= y;
3751 static int_eximarith_t
3752 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3755 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3762 y = eval_op_shift(&s, decimal, error);
3763 if (*error != NULL) break;
3772 static int_eximarith_t
3773 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3776 int_eximarith_t x = eval_op_and(&s, decimal, error);
3783 y = eval_op_and(&s, decimal, error);
3784 if (*error != NULL) break;
3793 static int_eximarith_t
3794 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3797 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3804 y = eval_op_xor(&s, decimal, error);
3805 if (*error != NULL) break;
3815 /*************************************************
3817 *************************************************/
3819 /* Returns either an unchanged string, or the expanded string in stacking pool
3820 store. Interpreted sequences are:
3822 \... normal escaping rules
3823 $name substitutes the variable
3825 ${op:string} operates on the expanded string value
3826 ${item{arg1}{arg2}...} expands the args and then does the business
3827 some literal args are not enclosed in {}
3829 There are now far too many operators and item types to make it worth listing
3830 them here in detail any more.
3832 We use an internal routine recursively to handle embedded substrings. The
3833 external function follows. The yield is NULL if the expansion failed, and there
3834 are two cases: if something collapsed syntactically, or if "fail" was given
3835 as the action on a lookup failure. These can be distinguished by looking at the
3836 variable expand_string_forcedfail, which is TRUE in the latter case.
3838 The skipping flag is set true when expanding a substring that isn't actually
3839 going to be used (after "if" or "lookup") and it prevents lookups from
3840 happening lower down.
3842 Store usage: At start, a store block of the length of the input plus 64
3843 is obtained. This is expanded as necessary by string_cat(), which might have to
3844 get a new block, or might be able to expand the original. At the end of the
3845 function we can release any store above that portion of the yield block that
3846 was actually used. In many cases this will be optimal.
3848 However: if the first item in the expansion is a variable name or header name,
3849 we reset the store before processing it; if the result is in fresh store, we
3850 use that without copying. This is helpful for expanding strings like
3851 $message_headers which can get very long.
3853 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3854 since resetting the store at the end of the expansion will free store that was
3855 allocated by the plugin code as well as the slop after the expanded string. So
3856 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3857 and, given the acl condition, ${if }. This is an unfortunate consequence of
3858 string expansion becoming too powerful.
3861 string the string to be expanded
3862 ket_ends true if expansion is to stop at }
3863 left if not NULL, a pointer to the first character after the
3864 expansion is placed here (typically used with ket_ends)
3865 skipping TRUE for recursive calls when the value isn't actually going
3866 to be used (to allow for optimisation)
3867 honour_dollar TRUE if $ is to be expanded,
3868 FALSE if it's just another character
3869 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3872 Returns: NULL if expansion fails:
3873 expand_string_forcedfail is set TRUE if failure was forced
3874 expand_string_message contains a textual error message
3875 a pointer to the expanded string on success
3879 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3880 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3882 gstring * yield = string_get(Ustrlen(string) + 64);
3884 const uschar *s = string;
3885 uschar *save_expand_nstring[EXPAND_MAXN+1];
3886 int save_expand_nlength[EXPAND_MAXN+1];
3887 BOOL resetok = TRUE;
3891 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
3893 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
3897 expand_string_forcedfail = FALSE;
3898 expand_string_message = US"";
3905 /* \ escapes the next character, which must exist, or else
3906 the expansion fails. There's a special escape, \N, which causes
3907 copying of the subject verbatim up to the next \N. Otherwise,
3908 the escapes are the standard set. */
3914 expand_string_message = US"\\ at end of string";
3920 const uschar * t = s + 2;
3921 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3922 yield = string_catn(yield, t, s - t);
3923 if (*s != 0) s += 2;
3929 ch[0] = string_interpret_escape(&s);
3931 yield = string_catn(yield, ch, 1);
3938 /* Anything other than $ is just copied verbatim, unless we are
3939 looking for a terminating } character. */
3942 if (ket_ends && *s == '}') break;
3944 if (*s != '$' || !honour_dollar)
3946 yield = string_catn(yield, s++, 1);
3950 /* No { after the $ - must be a plain name or a number for string
3951 match variable. There has to be a fudge for variables that are the
3952 names of header fields preceded by "$header_" because header field
3953 names can contain any printing characters except space and colon.
3954 For those that don't like typing this much, "$h_" is a synonym for
3955 "$header_". A non-existent header yields a NULL value; nothing is
3958 if (isalpha((*(++s))))
3964 s = read_name(name, sizeof(name), s, US"_");
3966 /* If this is the first thing to be expanded, release the pre-allocated
3970 g = store_get(sizeof(gstring));
3971 else if (yield->ptr == 0)
3973 if (resetok) store_reset(yield);
3975 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
3980 if (Ustrncmp(name, "h_", 2) == 0 ||
3981 Ustrncmp(name, "rh_", 3) == 0 ||
3982 Ustrncmp(name, "bh_", 3) == 0 ||
3983 Ustrncmp(name, "header_", 7) == 0 ||
3984 Ustrncmp(name, "rheader_", 8) == 0 ||
3985 Ustrncmp(name, "bheader_", 8) == 0)
3987 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3988 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3989 s = read_header_name(name, sizeof(name), s);
3990 value = find_header(name, FALSE, &newsize, want_raw, charset);
3992 /* If we didn't find the header, and the header contains a closing brace
3993 character, this may be a user error where the terminating colon
3994 has been omitted. Set a flag to adjust the error message in this case.
3995 But there is no error here - nothing gets inserted. */
3999 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
4006 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4008 expand_string_message =
4009 string_sprintf("unknown variable name \"%s\"", name);
4010 check_variable_error_message(name);
4014 /* If the data is known to be in a new buffer, newsize will be set to the
4015 size of that buffer. If this is the first thing in an expansion string,
4016 yield will be NULL; just point it at the new store instead of copying. Many
4017 expansion strings contain just one reference, so this is a useful
4018 optimization, especially for humungous headers. We need to use a gstring
4019 structure that is not allocated after that new-buffer, else a later store
4020 reset in the middle of the buffer will make it inaccessible. */
4022 len = Ustrlen(value);
4023 if (!yield && newsize != 0)
4026 yield->size = newsize;
4031 yield = string_catn(yield, value, len);
4039 s = read_cnumber(&n, s);
4040 if (n >= 0 && n <= expand_nmax)
4041 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4045 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4047 if (*s != '{') /*}*/
4049 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4053 /* After { there can be various things, but they all start with
4054 an initial word, except for a number for a string match variable. */
4056 if (isdigit((*(++s))))
4059 s = read_cnumber(&n, s); /*{*/
4062 expand_string_message = US"} expected after number";
4065 if (n >= 0 && n <= expand_nmax)
4066 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4072 expand_string_message = US"letter or digit expected after ${"; /*}*/
4076 /* Allow "-" in names to cater for substrings with negative
4077 arguments. Since we are checking for known names after { this is
4080 s = read_name(name, sizeof(name), s, US"_-");
4081 item_type = chop_match(name, item_table, nelem(item_table));
4085 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4086 If the ACL returns accept or reject we return content set by "message ="
4087 There is currently no limit on recursion; this would have us call
4088 acl_check_internal() directly and get a current level from somewhere.
4089 See also the acl expansion condition ECOND_ACL and the traditional
4090 acl modifier ACLC_ACL.
4091 Assume that the function has side-effects on the store that must be preserved.
4095 /* ${acl {name} {arg1}{arg2}...} */
4097 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4100 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4103 case 1: goto EXPAND_FAILED_CURLY;
4105 case 3: goto EXPAND_FAILED;
4107 if (skipping) continue;
4110 switch(eval_acl(sub, nelem(sub), &user_msg))
4115 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4117 yield = string_cat(yield, user_msg);
4121 expand_string_forcedfail = TRUE;
4124 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4129 case EITEM_AUTHRESULTS:
4130 /* ${authresults {mysystemname}} */
4134 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4137 case 1: goto EXPAND_FAILED_CURLY;
4139 case 3: goto EXPAND_FAILED;
4142 yield = string_append(yield, 3,
4143 US"Authentication-Results: ", sub_arg[0], US"; none");
4146 yield = authres_iprev(yield);
4147 yield = authres_smtpauth(yield);
4149 yield = authres_spf(yield);
4151 #ifndef DISABLE_DKIM
4152 yield = authres_dkim(yield);
4154 #ifdef EXPERIMENTAL_ARC
4155 yield = authres_arc(yield);
4160 /* Handle conditionals - preserve the values of the numerical expansion
4161 variables in case they get changed by a regular expression match in the
4162 condition. If not, they retain their external settings. At the end
4163 of this "if" section, they get restored to their previous values. */
4168 const uschar *next_s;
4169 int save_expand_nmax =
4170 save_expand_strings(save_expand_nstring, save_expand_nlength);
4172 while (isspace(*s)) s++;
4173 next_s = eval_condition(s, &resetok, skipping ? NULL : &cond);
4174 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4178 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4179 "condition: %.*s\n",
4180 (int)(next_s - s), s);
4181 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4182 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4184 cond ? "true" : "false");
4189 /* The handling of "yes" and "no" result strings is now in a separate
4190 function that is also used by ${lookup} and ${extract} and ${run}. */
4192 switch(process_yesno(
4193 skipping, /* were previously skipping */
4194 cond, /* success/failure indicator */
4195 lookup_value, /* value to reset for string2 */
4196 &s, /* input pointer */
4197 &yield, /* output pointer */
4198 US"if", /* condition type */
4201 case 1: goto EXPAND_FAILED; /* when all is well, the */
4202 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4205 /* Restore external setting of expansion variables for continuation
4208 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4209 save_expand_nlength);
4214 case EITEM_IMAPFOLDER:
4215 { /* ${imapfolder {name}{sep]{specials}} */
4219 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4222 case 1: goto EXPAND_FAILED_CURLY;
4224 case 3: goto EXPAND_FAILED;
4227 if (sub_arg[1] == NULL) /* One argument */
4229 sub_arg[1] = US"/"; /* default separator */
4232 else if (Ustrlen(sub_arg[1]) != 1)
4234 expand_string_message =
4236 "IMAP folder separator must be one character, found \"%s\"",
4243 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4244 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4246 yield = string_cat(yield, encoded);
4252 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4253 expanding an internal string that isn't actually going to be used. All we
4254 need to do is check the syntax, so don't do a lookup at all. Preserve the
4255 values of the numerical expansion variables in case they get changed by a
4256 partial lookup. If not, they retain their external settings. At the end
4257 of this "lookup" section, they get restored to their previous values. */
4261 int stype, partial, affixlen, starflags;
4262 int expand_setup = 0;
4264 uschar *key, *filename;
4265 const uschar *affix;
4266 uschar *save_lookup_value = lookup_value;
4267 int save_expand_nmax =
4268 save_expand_strings(save_expand_nstring, save_expand_nlength);
4270 if ((expand_forbid & RDO_LOOKUP) != 0)
4272 expand_string_message = US"lookup expansions are not permitted";
4276 /* Get the key we are to look up for single-key+file style lookups.
4277 Otherwise set the key NULL pro-tem. */
4279 while (isspace(*s)) s++;
4280 if (*s == '{') /*}*/
4282 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4283 if (!key) goto EXPAND_FAILED; /*{{*/
4286 expand_string_message = US"missing '}' after lookup key";
4287 goto EXPAND_FAILED_CURLY;
4289 while (isspace(*s)) s++;
4293 /* Find out the type of database */
4297 expand_string_message = US"missing lookup type";
4301 /* The type is a string that may contain special characters of various
4302 kinds. Allow everything except space or { to appear; the actual content
4303 is checked by search_findtype_partial. */ /*}*/
4305 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4307 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4311 while (isspace(*s)) s++;
4313 /* Now check for the individual search type and any partial or default
4314 options. Only those types that are actually in the binary are valid. */
4316 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4320 expand_string_message = search_error_message;
4324 /* Check that a key was provided for those lookup types that need it,
4325 and was not supplied for those that use the query style. */
4327 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4331 expand_string_message = string_sprintf("missing {key} for single-"
4332 "key \"%s\" lookup", name);
4340 expand_string_message = string_sprintf("a single key was given for "
4341 "lookup type \"%s\", which is not a single-key lookup type", name);
4346 /* Get the next string in brackets and expand it. It is the file name for
4347 single-key+file lookups, and the whole query otherwise. In the case of
4348 queries that also require a file name (e.g. sqlite), the file name comes
4353 expand_string_message = US"missing '{' for lookup file-or-query arg";
4354 goto EXPAND_FAILED_CURLY;
4356 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4357 if (filename == NULL) goto EXPAND_FAILED;
4360 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4361 goto EXPAND_FAILED_CURLY;
4363 while (isspace(*s)) s++;
4365 /* If this isn't a single-key+file lookup, re-arrange the variables
4366 to be appropriate for the search_ functions. For query-style lookups,
4367 there is just a "key", and no file name. For the special query-style +
4368 file types, the query (i.e. "key") starts with a file name. */
4372 while (isspace(*filename)) filename++;
4375 if (mac_islookup(stype, lookup_querystyle))
4379 if (*filename != '/')
4381 expand_string_message = string_sprintf(
4382 "absolute file name expected for \"%s\" lookup", name);
4385 while (*key != 0 && !isspace(*key)) key++;
4386 if (*key != 0) *key++ = 0;
4390 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4391 the entry was not found. Note that there is no search_close() function.
4392 Files are left open in case of re-use. At suitable places in higher logic,
4393 search_tidyup() is called to tidy all open files. This can save opening
4394 the same file several times. However, files may also get closed when
4395 others are opened, if too many are open at once. The rule is that a
4396 handle should not be used after a second search_open().
4398 Request that a partial search sets up $1 and maybe $2 by passing
4399 expand_setup containing zero. If its value changes, reset expand_nmax,
4400 since new variables will have been set. Note that at the end of this
4401 "lookup" section, the old numeric variables are restored. */
4404 lookup_value = NULL;
4407 void *handle = search_open(filename, stype, 0, NULL, NULL);
4410 expand_string_message = search_error_message;
4413 lookup_value = search_find(handle, filename, key, partial, affix,
4414 affixlen, starflags, &expand_setup);
4415 if (search_find_defer)
4417 expand_string_message =
4418 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4419 string_printing2(key, FALSE), search_error_message);
4422 if (expand_setup > 0) expand_nmax = expand_setup;
4425 /* The handling of "yes" and "no" result strings is now in a separate
4426 function that is also used by ${if} and ${extract}. */
4428 switch(process_yesno(
4429 skipping, /* were previously skipping */
4430 lookup_value != NULL, /* success/failure indicator */
4431 save_lookup_value, /* value to reset for string2 */
4432 &s, /* input pointer */
4433 &yield, /* output pointer */
4434 US"lookup", /* condition type */
4437 case 1: goto EXPAND_FAILED; /* when all is well, the */
4438 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4441 /* Restore external setting of expansion variables for carrying on
4442 at this level, and continue. */
4444 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4445 save_expand_nlength);
4449 /* If Perl support is configured, handle calling embedded perl subroutines,
4450 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4451 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4452 arguments (defined below). */
4454 #define EXIM_PERL_MAX_ARGS 8
4458 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4459 "is not included in this binary";
4462 #else /* EXIM_PERL */
4464 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4467 if ((expand_forbid & RDO_PERL) != 0)
4469 expand_string_message = US"Perl calls are not permitted";
4473 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4474 US"perl", &resetok))
4476 case 1: goto EXPAND_FAILED_CURLY;
4478 case 3: goto EXPAND_FAILED;
4481 /* If skipping, we don't actually do anything */
4483 if (skipping) continue;
4485 /* Start the interpreter if necessary */
4487 if (!opt_perl_started)
4490 if (opt_perl_startup == NULL)
4492 expand_string_message = US"A setting of perl_startup is needed when "
4493 "using the Perl interpreter";
4496 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4497 initerror = init_perl(opt_perl_startup);
4498 if (initerror != NULL)
4500 expand_string_message =
4501 string_sprintf("error in perl_startup code: %s\n", initerror);
4504 opt_perl_started = TRUE;
4507 /* Call the function */
4509 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4510 new_yield = call_perl_cat(yield, &expand_string_message,
4511 sub_arg[0], sub_arg + 1);
4513 /* NULL yield indicates failure; if the message pointer has been set to
4514 NULL, the yield was undef, indicating a forced failure. Otherwise the
4515 message will indicate some kind of Perl error. */
4517 if (new_yield == NULL)
4519 if (expand_string_message == NULL)
4521 expand_string_message =
4522 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4523 "failure", sub_arg[0]);
4524 expand_string_forcedfail = TRUE;
4529 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4530 set during a callback from Perl. */
4532 expand_string_forcedfail = FALSE;
4536 #endif /* EXIM_PERL */
4538 /* Transform email address to "prvs" scheme to use
4539 as BATV-signed return path */
4546 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4548 case 1: goto EXPAND_FAILED_CURLY;
4550 case 3: goto EXPAND_FAILED;
4553 /* If skipping, we don't actually do anything */
4554 if (skipping) continue;
4556 /* sub_arg[0] is the address */
4557 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
4558 || domain == sub_arg[0] || Ustrlen(domain) == 1)
4560 expand_string_message = US"prvs first argument must be a qualified email address";
4564 /* Calculate the hash. The third argument must be a single-digit
4565 key number, or unset. */
4568 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4570 expand_string_message = US"prvs third argument must be a single digit";
4574 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
4577 expand_string_message = US"prvs hmac-sha1 conversion failed";
4581 /* Now separate the domain from the local part */
4584 yield = string_catn(yield, US"prvs=", 5);
4585 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
4586 yield = string_catn(yield, prvs_daystamp(7), 3);
4587 yield = string_catn(yield, p, 6);
4588 yield = string_catn(yield, US"=", 1);
4589 yield = string_cat (yield, sub_arg[0]);
4590 yield = string_catn(yield, US"@", 1);
4591 yield = string_cat (yield, domain);
4596 /* Check a prvs-encoded address for validity */
4598 case EITEM_PRVSCHECK:
4605 /* TF: Ugliness: We want to expand parameter 1 first, then set
4606 up expansion variables that are used in the expansion of
4607 parameter 2. So we clone the string for the first
4608 expansion, where we only expand parameter 1.
4610 PH: Actually, that isn't necessary. The read_subs() function is
4611 designed to work this way for the ${if and ${lookup expansions. I've
4615 /* Reset expansion variables */
4616 prvscheck_result = NULL;
4617 prvscheck_address = NULL;
4618 prvscheck_keynum = NULL;
4620 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4622 case 1: goto EXPAND_FAILED_CURLY;
4624 case 3: goto EXPAND_FAILED;
4627 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4630 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4632 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4633 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4634 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4635 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4636 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4638 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
4639 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
4640 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
4641 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
4642 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
4644 /* Set up expansion variables */
4645 g = string_cat (NULL, local_part);
4646 g = string_catn(g, US"@", 1);
4647 g = string_cat (g, domain);
4648 prvscheck_address = string_from_gstring(g);
4649 prvscheck_keynum = string_copy(key_num);
4651 /* Now expand the second argument */
4652 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4654 case 1: goto EXPAND_FAILED_CURLY;
4656 case 3: goto EXPAND_FAILED;
4659 /* Now we have the key and can check the address. */
4661 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4666 expand_string_message = US"hmac-sha1 conversion failed";
4670 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
4671 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
4673 if (Ustrcmp(p,hash) == 0)
4675 /* Success, valid BATV address. Now check the expiry date. */
4676 uschar *now = prvs_daystamp(0);
4677 unsigned int inow = 0,iexpire = 1;
4679 (void)sscanf(CS now,"%u",&inow);
4680 (void)sscanf(CS daystamp,"%u",&iexpire);
4682 /* When "iexpire" is < 7, a "flip" has occured.
4683 Adjust "inow" accordingly. */
4684 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4686 if (iexpire >= inow)
4688 prvscheck_result = US"1";
4689 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
4693 prvscheck_result = NULL;
4694 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
4699 prvscheck_result = NULL;
4700 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
4703 /* Now expand the final argument. We leave this till now so that
4704 it can include $prvscheck_result. */
4706 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4708 case 1: goto EXPAND_FAILED_CURLY;
4710 case 3: goto EXPAND_FAILED;
4713 yield = string_cat(yield,
4714 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4716 /* Reset the "internal" variables afterwards, because they are in
4717 dynamic store that will be reclaimed if the expansion succeeded. */
4719 prvscheck_address = NULL;
4720 prvscheck_keynum = NULL;
4723 /* Does not look like a prvs encoded address, return the empty string.
4724 We need to make sure all subs are expanded first, so as to skip over
4727 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4729 case 1: goto EXPAND_FAILED_CURLY;
4731 case 3: goto EXPAND_FAILED;
4737 /* Handle "readfile" to insert an entire file */
4739 case EITEM_READFILE:
4744 if ((expand_forbid & RDO_READFILE) != 0)
4746 expand_string_message = US"file insertions are not permitted";
4750 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4752 case 1: goto EXPAND_FAILED_CURLY;
4754 case 3: goto EXPAND_FAILED;
4757 /* If skipping, we don't actually do anything */
4759 if (skipping) continue;
4761 /* Open the file and read it */
4763 if (!(f = Ufopen(sub_arg[0], "rb")))
4765 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4769 yield = cat_file(f, yield, sub_arg[1]);
4774 /* Handle "readsocket" to insert data from a socket, either
4775 Inet or Unix domain */
4777 case EITEM_READSOCK:
4781 int save_ptr = yield->ptr;
4785 BOOL do_shutdown = TRUE;
4788 if (expand_forbid & RDO_READSOCK)
4790 expand_string_message = US"socket insertions are not permitted";
4794 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4795 because there may be a string for expansion on failure. */
4797 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4799 case 1: goto EXPAND_FAILED_CURLY;
4800 case 2: /* Won't occur: no end check */
4801 case 3: goto EXPAND_FAILED;
4804 /* Grab the request string, if any */
4806 reqstr.data = sub_arg[1];
4807 reqstr.len = Ustrlen(sub_arg[1]);
4809 /* Sort out timeout, if given. The second arg is a list with the first element
4810 being a time value. Any more are options of form "name=value". Currently the
4811 only option recognised is "shutdown". */
4815 const uschar * list = sub_arg[2];
4819 item = string_nextinlist(&list, &sep, NULL, 0);
4820 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
4822 expand_string_message = string_sprintf("bad time value %s", item);
4826 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
4827 if (Ustrncmp(item, US"shutdown=", 9) == 0)
4828 if (Ustrcmp(item + 9, US"no") == 0)
4829 do_shutdown = FALSE;
4831 else sub_arg[3] = NULL; /* No eol if no timeout */
4833 /* If skipping, we don't actually do anything. Otherwise, arrange to
4834 connect to either an IP or a Unix socket. */
4838 /* Handle an IP (internet) domain */
4840 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4843 uschar * server_name = sub_arg[0] + 5;
4844 uschar * port_name = Ustrrchr(server_name, ':');
4846 /* Sort out the port */
4850 expand_string_message =
4851 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4854 *port_name++ = 0; /* Terminate server name */
4856 if (isdigit(*port_name))
4859 port = Ustrtol(port_name, &end, 0);
4860 if (end != port_name + Ustrlen(port_name))
4862 expand_string_message =
4863 string_sprintf("invalid port number %s", port_name);
4869 struct servent *service_info = getservbyname(CS port_name, "tcp");
4872 expand_string_message = string_sprintf("unknown port \"%s\"",
4876 port = ntohs(service_info->s_port);
4879 fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4880 timeout, NULL, &expand_string_message, &reqstr);
4881 callout_address = NULL;
4887 /* Handle a Unix domain socket */
4891 struct sockaddr_un sockun; /* don't call this "sun" ! */
4894 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4896 expand_string_message = string_sprintf("failed to create socket: %s",
4901 sockun.sun_family = AF_UNIX;
4902 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4905 sigalrm_seen = FALSE;
4907 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4911 expand_string_message = US "socket connect timed out";
4916 expand_string_message = string_sprintf("failed to connect to socket "
4917 "%s: %s", sub_arg[0], strerror(errno));
4922 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
4924 /* Allow sequencing of test actions */
4925 if (running_in_test_harness) millisleep(100);
4927 /* Write the request string, if not empty or already done */
4931 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
4933 if (write(fd, reqstr.data, reqstr.len) != reqstr.len)
4935 expand_string_message = string_sprintf("request write to socket "
4936 "failed: %s", strerror(errno));
4941 /* Shut down the sending side of the socket. This helps some servers to
4942 recognise that it is their turn to do some work. Just in case some
4943 system doesn't have this function, make it conditional. */
4946 if (do_shutdown) shutdown(fd, SHUT_WR);
4949 if (running_in_test_harness) millisleep(100);
4951 /* Now we need to read from the socket, under a timeout. The function
4952 that reads a file can be used. */
4954 f = fdopen(fd, "rb");
4955 sigalrm_seen = FALSE;
4957 yield = cat_file(f, yield, sub_arg[3]);
4961 /* After a timeout, we restore the pointer in the result, that is,
4962 make sure we add nothing from the socket. */
4966 yield->ptr = save_ptr;
4967 expand_string_message = US "socket read timed out";
4972 /* The whole thing has worked (or we were skipping). If there is a
4973 failure string following, we need to skip it. */
4977 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4981 expand_string_message = US"missing '}' closing failstring for readsocket";
4982 goto EXPAND_FAILED_CURLY;
4984 while (isspace(*s)) s++;
4990 expand_string_message = US"missing '}' closing readsocket";
4991 goto EXPAND_FAILED_CURLY;
4995 /* Come here on failure to create socket, connect socket, write to the
4996 socket, or timeout on reading. If another substring follows, expand and
4997 use it. Otherwise, those conditions give expand errors. */
5000 if (*s != '{') goto EXPAND_FAILED;
5001 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5002 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5004 yield = string_cat(yield, arg);
5007 expand_string_message = US"missing '}' closing failstring for readsocket";
5008 goto EXPAND_FAILED_CURLY;
5010 while (isspace(*s)) s++;
5014 /* Handle "run" to execute a program. */
5020 const uschar **argv;
5024 if ((expand_forbid & RDO_RUN) != 0)
5026 expand_string_message = US"running a command is not permitted";
5030 while (isspace(*s)) s++;
5033 expand_string_message = US"missing '{' for command arg of run";
5034 goto EXPAND_FAILED_CURLY;
5036 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5037 if (arg == NULL) goto EXPAND_FAILED;
5038 while (isspace(*s)) s++;
5041 expand_string_message = US"missing '}' closing command arg of run";
5042 goto EXPAND_FAILED_CURLY;
5045 if (skipping) /* Just pretend it worked when we're skipping */
5048 lookup_value = NULL;
5052 if (!transport_set_up_command(&argv, /* anchor for arg list */
5053 arg, /* raw command */
5054 FALSE, /* don't expand the arguments */
5055 0, /* not relevant when... */
5056 NULL, /* no transporting address */
5057 US"${run} expansion", /* for error messages */
5058 &expand_string_message)) /* where to put error message */
5061 /* Create the child process, making it a group leader. */
5063 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
5065 expand_string_message =
5066 string_sprintf("couldn't create child process: %s", strerror(errno));
5070 /* Nothing is written to the standard input. */
5074 /* Read the pipe to get the command's output into $value (which is kept
5075 in lookup_value). Read during execution, so that if the output exceeds
5076 the OS pipe buffer limit, we don't block forever. Remember to not release
5077 memory just allocated for $value. */
5080 f = fdopen(fd_out, "rb");
5081 sigalrm_seen = FALSE;
5083 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5087 /* Wait for the process to finish, applying the timeout, and inspect its
5088 return code for serious disasters. Simple non-zero returns are passed on.
5091 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5093 if (sigalrm_seen || runrc == -256)
5095 expand_string_message = string_sprintf("command timed out");
5096 killpg(pid, SIGKILL); /* Kill the whole process group */
5099 else if (runrc == -257)
5100 expand_string_message = string_sprintf("wait() failed: %s",
5104 expand_string_message = string_sprintf("command killed by signal %d",
5111 /* Process the yes/no strings; $value may be useful in both cases */
5113 switch(process_yesno(
5114 skipping, /* were previously skipping */
5115 runrc == 0, /* success/failure indicator */
5116 lookup_value, /* value to reset for string2 */
5117 &s, /* input pointer */
5118 &yield, /* output pointer */
5119 US"run", /* condition type */
5122 case 1: goto EXPAND_FAILED; /* when all is well, the */
5123 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5129 /* Handle character translation for "tr" */
5133 int oldptr = yield->ptr;
5137 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5139 case 1: goto EXPAND_FAILED_CURLY;
5141 case 3: goto EXPAND_FAILED;
5144 yield = string_cat(yield, sub[0]);
5145 o2m = Ustrlen(sub[2]) - 1;
5147 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5149 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5153 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5160 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5161 expanded arguments. */
5171 int val[2] = { 0, -1 };
5174 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5175 Ensure that sub[2] is set in the ${length } case. */
5178 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5179 TRUE, name, &resetok))
5181 case 1: goto EXPAND_FAILED_CURLY;
5183 case 3: goto EXPAND_FAILED;
5186 /* Juggle the arguments if there are only two of them: always move the
5187 string to the last position and make ${length{n}{str}} equivalent to
5188 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5194 if (item_type == EITEM_LENGTH)
5201 for (i = 0; i < 2; i++)
5203 if (sub[i] == NULL) continue;
5204 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5205 if (*ret != 0 || (i != 0 && val[i] < 0))
5207 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5208 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5214 (item_type == EITEM_HASH)?
5215 compute_hash(sub[2], val[0], val[1], &len) :
5216 (item_type == EITEM_NHASH)?
5217 compute_nhash(sub[2], val[0], val[1], &len) :
5218 extract_substr(sub[2], val[0], val[1], &len);
5220 if (ret == NULL) goto EXPAND_FAILED;
5221 yield = string_catn(yield, ret, len);
5225 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5226 This code originally contributed by Steve Haslam. It currently supports
5227 the use of MD5 and SHA-1 hashes.
5229 We need some workspace that is large enough to handle all the supported
5230 hash types. Use macros to set the sizes rather than be too elaborate. */
5232 #define MAX_HASHLEN 20
5233 #define MAX_HASHBLOCKLEN 64
5242 int hashlen; /* Number of octets for the hash algorithm's output */
5243 int hashblocklen; /* Number of octets the hash algorithm processes */
5245 unsigned int keylen;
5247 uschar keyhash[MAX_HASHLEN];
5248 uschar innerhash[MAX_HASHLEN];
5249 uschar finalhash[MAX_HASHLEN];
5250 uschar finalhash_hex[2*MAX_HASHLEN];
5251 uschar innerkey[MAX_HASHBLOCKLEN];
5252 uschar outerkey[MAX_HASHBLOCKLEN];
5254 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5256 case 1: goto EXPAND_FAILED_CURLY;
5258 case 3: goto EXPAND_FAILED;
5263 if (Ustrcmp(sub[0], "md5") == 0)
5266 use_base = &md5_base;
5270 else if (Ustrcmp(sub[0], "sha1") == 0)
5273 use_base = &sha1_ctx;
5279 expand_string_message =
5280 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5285 keylen = Ustrlen(keyptr);
5287 /* If the key is longer than the hash block length, then hash the key
5290 if (keylen > hashblocklen)
5292 chash_start(type, use_base);
5293 chash_end(type, use_base, keyptr, keylen, keyhash);
5298 /* Now make the inner and outer key values */
5300 memset(innerkey, 0x36, hashblocklen);
5301 memset(outerkey, 0x5c, hashblocklen);
5303 for (i = 0; i < keylen; i++)
5305 innerkey[i] ^= keyptr[i];
5306 outerkey[i] ^= keyptr[i];
5309 /* Now do the hashes */
5311 chash_start(type, use_base);
5312 chash_mid(type, use_base, innerkey);
5313 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5315 chash_start(type, use_base);
5316 chash_mid(type, use_base, outerkey);
5317 chash_end(type, use_base, innerhash, hashlen, finalhash);
5319 /* Encode the final hash as a hex string */
5322 for (i = 0; i < hashlen; i++)
5324 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5325 *p++ = hex_digits[finalhash[i] & 0x0f];
5328 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5329 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5331 yield = string_catn(yield, finalhash_hex, hashlen*2);
5336 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5337 We have to save the numerical variables and restore them afterwards. */
5342 int moffset, moffsetextra, slen;
5345 const uschar *rerror;
5348 int save_expand_nmax =
5349 save_expand_strings(save_expand_nstring, save_expand_nlength);
5351 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5353 case 1: goto EXPAND_FAILED_CURLY;
5355 case 3: goto EXPAND_FAILED;
5358 /* Compile the regular expression */
5360 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5365 expand_string_message = string_sprintf("regular expression error in "
5366 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5370 /* Now run a loop to do the substitutions as often as necessary. It ends
5371 when there are no more matches. Take care over matches of the null string;
5372 do the same thing as Perl does. */
5375 slen = Ustrlen(sub[0]);
5376 moffset = moffsetextra = 0;
5381 int ovector[3*(EXPAND_MAXN+1)];
5382 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5383 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5387 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5388 is not necessarily the end. We want to repeat the match from one
5389 character further along, but leaving the basic offset the same (for
5390 copying below). We can't be at the end of the string - that was checked
5391 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5392 finished; copy the remaining string and end the loop. */
5402 yield = string_catn(yield, subject+moffset, slen-moffset);
5406 /* Match - set up for expanding the replacement. */
5408 if (n == 0) n = EXPAND_MAXN + 1;
5410 for (nn = 0; nn < n*2; nn += 2)
5412 expand_nstring[expand_nmax] = subject + ovector[nn];
5413 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5417 /* Copy the characters before the match, plus the expanded insertion. */
5419 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
5420 insert = expand_string(sub[2]);
5421 if (insert == NULL) goto EXPAND_FAILED;
5422 yield = string_cat(yield, insert);
5424 moffset = ovector[1];
5428 /* If we have matched an empty string, first check to see if we are at
5429 the end of the subject. If so, the loop is over. Otherwise, mimic
5430 what Perl's /g options does. This turns out to be rather cunning. First
5431 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5432 string at the same point. If this fails (picked up above) we advance to
5433 the next character. */
5435 if (ovector[0] == ovector[1])
5437 if (ovector[0] == slen) break;
5438 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5442 /* All done - restore numerical variables. */
5444 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5445 save_expand_nlength);
5449 /* Handle keyed and numbered substring extraction. If the first argument
5450 consists entirely of digits, then a numerical extraction is assumed. */
5456 int field_number = 1;
5457 BOOL field_number_set = FALSE;
5458 uschar *save_lookup_value = lookup_value;
5460 int save_expand_nmax =
5461 save_expand_strings(save_expand_nstring, save_expand_nlength);
5463 /* While skipping we cannot rely on the data for expansions being
5464 available (eg. $item) hence cannot decide on numeric vs. keyed.
5465 Read a maximum of 5 arguments (including the yes/no) */
5469 while (isspace(*s)) s++;
5470 for (j = 5; j > 0 && *s == '{'; j--)
5472 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5473 goto EXPAND_FAILED; /*{*/
5476 expand_string_message = US"missing '{' for arg of extract";
5477 goto EXPAND_FAILED_CURLY;
5479 while (isspace(*s)) s++;
5481 if ( Ustrncmp(s, "fail", 4) == 0
5482 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5486 while (isspace(*s)) s++;
5490 expand_string_message = US"missing '}' closing extract";
5491 goto EXPAND_FAILED_CURLY;
5495 else for (i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5497 while (isspace(*s)) s++;
5498 if (*s == '{') /*}*/
5500 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5501 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5504 expand_string_message = string_sprintf(
5505 "missing '}' closing arg %d of extract", i+1);
5506 goto EXPAND_FAILED_CURLY;
5509 /* After removal of leading and trailing white space, the first
5510 argument must not be empty; if it consists entirely of digits
5511 (optionally preceded by a minus sign), this is a numerical
5512 extraction, and we expect 3 arguments. */
5520 while (isspace(*p)) p++;
5524 while (len > 0 && isspace(p[len-1])) len--;
5529 expand_string_message = US"first argument of \"extract\" must "
5539 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5543 j = 3; /* Need 3 args */
5544 field_number_set = TRUE;
5550 expand_string_message = string_sprintf(
5551 "missing '{' for arg %d of extract", i+1);
5552 goto EXPAND_FAILED_CURLY;
5556 /* Extract either the numbered or the keyed substring into $value. If
5557 skipping, just pretend the extraction failed. */
5559 lookup_value = skipping? NULL : field_number_set?
5560 expand_gettokened(field_number, sub[1], sub[2]) :
5561 expand_getkeyed(sub[0], sub[1]);
5563 /* If no string follows, $value gets substituted; otherwise there can
5564 be yes/no strings, as for lookup or if. */
5566 switch(process_yesno(
5567 skipping, /* were previously skipping */
5568 lookup_value != NULL, /* success/failure indicator */
5569 save_lookup_value, /* value to reset for string2 */
5570 &s, /* input pointer */
5571 &yield, /* output pointer */
5572 US"extract", /* condition type */
5575 case 1: goto EXPAND_FAILED; /* when all is well, the */
5576 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5579 /* All done - restore numerical variables. */
5581 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5582 save_expand_nlength);
5587 /* return the Nth item from a list */
5589 case EITEM_LISTEXTRACT:
5592 int field_number = 1;
5593 uschar *save_lookup_value = lookup_value;
5595 int save_expand_nmax =
5596 save_expand_strings(save_expand_nstring, save_expand_nlength);
5598 /* Read the field & list arguments */
5600 for (i = 0; i < 2; i++)
5602 while (isspace(*s)) s++;
5603 if (*s != '{') /*}*/
5605 expand_string_message = string_sprintf(
5606 "missing '{' for arg %d of listextract", i+1);
5607 goto EXPAND_FAILED_CURLY;
5610 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5611 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5614 expand_string_message = string_sprintf(
5615 "missing '}' closing arg %d of listextract", i+1);
5616 goto EXPAND_FAILED_CURLY;
5619 /* After removal of leading and trailing white space, the first
5620 argument must be numeric and nonempty. */
5628 while (isspace(*p)) p++;
5632 while (len > 0 && isspace(p[len-1])) len--;
5635 if (!*p && !skipping)
5637 expand_string_message = US"first argument of \"listextract\" must "
5647 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5650 expand_string_message = US"first argument of \"listextract\" must "
5658 /* Extract the numbered element into $value. If
5659 skipping, just pretend the extraction failed. */
5661 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5663 /* If no string follows, $value gets substituted; otherwise there can
5664 be yes/no strings, as for lookup or if. */
5666 switch(process_yesno(
5667 skipping, /* were previously skipping */
5668 lookup_value != NULL, /* success/failure indicator */
5669 save_lookup_value, /* value to reset for string2 */
5670 &s, /* input pointer */
5671 &yield, /* output pointer */
5672 US"listextract", /* condition type */
5675 case 1: goto EXPAND_FAILED; /* when all is well, the */
5676 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5679 /* All done - restore numerical variables. */
5681 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5682 save_expand_nlength);
5688 case EITEM_CERTEXTRACT:
5690 uschar *save_lookup_value = lookup_value;
5692 int save_expand_nmax =
5693 save_expand_strings(save_expand_nstring, save_expand_nlength);
5695 /* Read the field argument */
5696 while (isspace(*s)) s++;
5697 if (*s != '{') /*}*/
5699 expand_string_message = US"missing '{' for field arg of certextract";
5700 goto EXPAND_FAILED_CURLY;
5702 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5703 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5706 expand_string_message = US"missing '}' closing field arg of certextract";
5707 goto EXPAND_FAILED_CURLY;
5709 /* strip spaces fore & aft */
5714 while (isspace(*p)) p++;
5718 while (len > 0 && isspace(p[len-1])) len--;
5722 /* inspect the cert argument */
5723 while (isspace(*s)) s++;
5724 if (*s != '{') /*}*/
5726 expand_string_message = US"missing '{' for cert variable arg of certextract";
5727 goto EXPAND_FAILED_CURLY;
5731 expand_string_message = US"second argument of \"certextract\" must "
5732 "be a certificate variable";
5735 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5736 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5739 expand_string_message = US"missing '}' closing cert variable arg of certextract";
5740 goto EXPAND_FAILED_CURLY;
5744 lookup_value = NULL;
5747 lookup_value = expand_getcertele(sub[0], sub[1]);
5748 if (*expand_string_message) goto EXPAND_FAILED;
5750 switch(process_yesno(
5751 skipping, /* were previously skipping */
5752 lookup_value != NULL, /* success/failure indicator */
5753 save_lookup_value, /* value to reset for string2 */
5754 &s, /* input pointer */
5755 &yield, /* output pointer */
5756 US"certextract", /* condition type */
5759 case 1: goto EXPAND_FAILED; /* when all is well, the */
5760 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5763 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5764 save_expand_nlength);
5767 #endif /*SUPPORT_TLS*/
5769 /* Handle list operations */
5776 int save_ptr = yield->ptr;
5777 uschar outsep[2] = { '\0', '\0' };
5778 const uschar *list, *expr, *temp;
5779 uschar *save_iterate_item = iterate_item;
5780 uschar *save_lookup_value = lookup_value;
5782 while (isspace(*s)) s++;
5785 expand_string_message =
5786 string_sprintf("missing '{' for first arg of %s", name);
5787 goto EXPAND_FAILED_CURLY;
5790 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5791 if (list == NULL) goto EXPAND_FAILED;
5794 expand_string_message =
5795 string_sprintf("missing '}' closing first arg of %s", name);
5796 goto EXPAND_FAILED_CURLY;
5799 if (item_type == EITEM_REDUCE)
5802 while (isspace(*s)) s++;
5805 expand_string_message = US"missing '{' for second arg of reduce";
5806 goto EXPAND_FAILED_CURLY;
5808 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5809 if (!t) goto EXPAND_FAILED;
5813 expand_string_message = US"missing '}' closing second arg of reduce";
5814 goto EXPAND_FAILED_CURLY;
5818 while (isspace(*s)) s++;
5821 expand_string_message =
5822 string_sprintf("missing '{' for last arg of %s", name);
5823 goto EXPAND_FAILED_CURLY;
5828 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5829 if scanning a "false" part). This allows us to find the end of the
5830 condition, because if the list is empty, we won't actually evaluate the
5831 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5832 the normal internal expansion function. */
5834 if (item_type == EITEM_FILTER)
5836 temp = eval_condition(expr, &resetok, NULL);
5837 if (temp != NULL) s = temp;
5840 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5844 expand_string_message = string_sprintf("%s inside \"%s\" item",
5845 expand_string_message, name);
5849 while (isspace(*s)) s++;
5852 expand_string_message = string_sprintf("missing } at end of condition "
5853 "or expression inside \"%s\"; could be an unquoted } in the content",
5858 while (isspace(*s)) s++; /*{*/
5861 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5866 /* If we are skipping, we can now just move on to the next item. When
5867 processing for real, we perform the iteration. */
5869 if (skipping) continue;
5870 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
5872 *outsep = (uschar)sep; /* Separator as a string */
5874 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
5875 name, iterate_item, lookup_value);
5877 if (item_type == EITEM_FILTER)
5880 if (eval_condition(expr, &resetok, &condresult) == NULL)
5882 iterate_item = save_iterate_item;
5883 lookup_value = save_lookup_value;
5884 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5885 expand_string_message, name);
5888 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
5889 condresult? "true":"false");
5891 temp = iterate_item; /* TRUE => include this item */
5893 continue; /* FALSE => skip this item */
5896 /* EITEM_MAP and EITEM_REDUCE */
5900 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5904 iterate_item = save_iterate_item;
5905 expand_string_message = string_sprintf("%s inside \"%s\" item",
5906 expand_string_message, name);
5909 if (item_type == EITEM_REDUCE)
5911 lookup_value = t; /* Update the value of $value */
5912 continue; /* and continue the iteration */
5916 /* We reach here for FILTER if the condition is true, always for MAP,
5917 and never for REDUCE. The value in "temp" is to be added to the output
5918 list that is being created, ensuring that any occurrences of the
5919 separator character are doubled. Unless we are dealing with the first
5920 item of the output list, add in a space if the new item begins with the
5921 separator character, or is an empty string. */
5923 if (yield->ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5924 yield = string_catn(yield, US" ", 1);
5926 /* Add the string in "temp" to the output list that we are building,
5927 This is done in chunks by searching for the separator character. */
5931 size_t seglen = Ustrcspn(temp, outsep);
5933 yield = string_catn(yield, temp, seglen + 1);
5935 /* If we got to the end of the string we output one character
5936 too many; backup and end the loop. Otherwise arrange to double the
5939 if (temp[seglen] == '\0') { yield->ptr--; break; }
5940 yield = string_catn(yield, outsep, 1);
5944 /* Output a separator after the string: we will remove the redundant
5945 final one at the end. */
5947 yield = string_catn(yield, outsep, 1);
5948 } /* End of iteration over the list loop */
5950 /* REDUCE has generated no output above: output the final value of
5953 if (item_type == EITEM_REDUCE)
5955 yield = string_cat(yield, lookup_value);
5956 lookup_value = save_lookup_value; /* Restore $value */
5959 /* FILTER and MAP generate lists: if they have generated anything, remove
5960 the redundant final separator. Even though an empty item at the end of a
5961 list does not count, this is tidier. */
5963 else if (yield->ptr != save_ptr) yield->ptr--;
5965 /* Restore preserved $item */
5967 iterate_item = save_iterate_item;
5974 const uschar *srclist, *cmp, *xtract;
5976 const uschar *dstlist = NULL, *dstkeylist = NULL;
5978 uschar *save_iterate_item = iterate_item;
5980 while (isspace(*s)) s++;
5983 expand_string_message = US"missing '{' for list arg of sort";
5984 goto EXPAND_FAILED_CURLY;
5987 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5988 if (!srclist) goto EXPAND_FAILED;
5991 expand_string_message = US"missing '}' closing list arg of sort";
5992 goto EXPAND_FAILED_CURLY;
5995 while (isspace(*s)) s++;
5998 expand_string_message = US"missing '{' for comparator arg of sort";
5999 goto EXPAND_FAILED_CURLY;
6002 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6003 if (!cmp) goto EXPAND_FAILED;
6006 expand_string_message = US"missing '}' closing comparator arg of sort";
6007 goto EXPAND_FAILED_CURLY;
6010 while (isspace(*s)) s++;
6013 expand_string_message = US"missing '{' for extractor arg of sort";
6014 goto EXPAND_FAILED_CURLY;
6018 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6019 if (!tmp) goto EXPAND_FAILED;
6020 xtract = string_copyn(xtract, s - xtract);
6024 expand_string_message = US"missing '}' closing extractor arg of sort";
6025 goto EXPAND_FAILED_CURLY;
6030 expand_string_message = US"missing } at end of \"sort\"";
6034 if (skipping) continue;
6036 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6039 gstring * newlist = NULL;
6040 gstring * newkeylist = NULL;
6043 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6045 /* extract field for comparisons */
6046 iterate_item = srcitem;
6047 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6051 expand_string_message = string_sprintf(
6052 "field-extract in sort: \"%s\"", xtract);
6056 /* Insertion sort */
6058 /* copy output list until new-item < list-item */
6059 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6065 /* field for comparison */
6066 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6069 /* build and run condition string */
6070 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
6072 DEBUG(D_expand) debug_printf_indent("%s: cond = \"%s\"\n", name, expr);
6073 if (!eval_condition(expr, &resetok, &before))
6075 expand_string_message = string_sprintf("comparison in sort: %s",
6082 /* New-item sorts before this dst-item. Append new-item,
6083 then dst-item, then remainder of dst list. */
6085 newlist = string_append_listele(newlist, sep, srcitem);
6086 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6089 newlist = string_append_listele(newlist, sep, dstitem);
6090 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6092 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6094 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6096 newlist = string_append_listele(newlist, sep, dstitem);
6097 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6103 newlist = string_append_listele(newlist, sep, dstitem);
6104 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6107 /* If we ran out of dstlist without consuming srcitem, append it */
6110 newlist = string_append_listele(newlist, sep, srcitem);
6111 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6114 dstlist = newlist->s;
6115 dstkeylist = newkeylist->s;
6117 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6118 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6122 yield = string_cat(yield, dstlist);
6124 /* Restore preserved $item */
6125 iterate_item = save_iterate_item;
6129 expand_string_message = US"Internal error in sort (list mismatch)";
6134 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6135 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6136 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6137 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6139 #define EXPAND_DLFUNC_MAX_ARGS 8
6142 #ifndef EXPAND_DLFUNC
6143 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6144 "is not included in this binary";
6147 #else /* EXPAND_DLFUNC */
6150 exim_dlfunc_t *func;
6153 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6155 if ((expand_forbid & RDO_DLFUNC) != 0)
6157 expand_string_message =
6158 US"dynamically-loaded functions are not permitted";
6162 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6163 TRUE, US"dlfunc", &resetok))
6165 case 1: goto EXPAND_FAILED_CURLY;
6167 case 3: goto EXPAND_FAILED;
6170 /* If skipping, we don't actually do anything */
6172 if (skipping) continue;
6174 /* Look up the dynamically loaded object handle in the tree. If it isn't
6175 found, dlopen() the file and put the handle in the tree for next time. */
6177 t = tree_search(dlobj_anchor, argv[0]);
6180 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6183 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6184 argv[0], dlerror());
6185 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6188 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6189 Ustrcpy(t->name, argv[0]);
6190 t->data.ptr = handle;
6191 (void)tree_insertnode(&dlobj_anchor, t);
6194 /* Having obtained the dynamically loaded object handle, look up the
6195 function pointer. */
6197 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6200 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6201 "%s", argv[1], argv[0], dlerror());
6202 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6206 /* Call the function and work out what to do with the result. If it
6207 returns OK, we have a replacement string; if it returns DEFER then
6208 expansion has failed in a non-forced manner; if it returns FAIL then
6209 failure was forced; if it returns ERROR or any other value there's a
6210 problem, so panic slightly. In any case, assume that the function has
6211 side-effects on the store that must be preserved. */
6215 for (argc = 0; argv[argc] != NULL; argc++);
6216 status = func(&result, argc - 2, &argv[2]);
6219 if (result == NULL) result = US"";
6220 yield = string_cat(yield, result);
6225 expand_string_message = result == NULL ? US"(no message)" : result;
6226 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
6227 else if(status != FAIL)
6228 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6229 argv[0], argv[1], status, expand_string_message);
6233 #endif /* EXPAND_DLFUNC */
6235 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6238 uschar *save_lookup_value = lookup_value;
6240 while (isspace(*s)) s++;
6241 if (*s != '{') /*}*/
6244 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6245 if (!key) goto EXPAND_FAILED; /*{*/
6248 expand_string_message = US"missing '{' for name arg of env";
6249 goto EXPAND_FAILED_CURLY;
6252 lookup_value = US getenv(CS key);
6254 switch(process_yesno(
6255 skipping, /* were previously skipping */
6256 lookup_value != NULL, /* success/failure indicator */
6257 save_lookup_value, /* value to reset for string2 */
6258 &s, /* input pointer */
6259 &yield, /* output pointer */
6260 US"env", /* condition type */
6263 case 1: goto EXPAND_FAILED; /* when all is well, the */
6264 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6268 } /* EITEM_* switch */
6270 /* Control reaches here if the name is not recognized as one of the more
6271 complicated expansion items. Check for the "operator" syntax (name terminated
6272 by a colon). Some of the operators have arguments, separated by _ from the
6280 var_entry *vp = NULL;
6282 /* Owing to an historical mis-design, an underscore may be part of the
6283 operator name, or it may introduce arguments. We therefore first scan the
6284 table of names that contain underscores. If there is no match, we cut off
6285 the arguments and then scan the main table. */
6287 if ((c = chop_match(name, op_table_underscore,
6288 nelem(op_table_underscore))) < 0)
6290 arg = Ustrchr(name, '_');
6291 if (arg != NULL) *arg = 0;
6292 c = chop_match(name, op_table_main, nelem(op_table_main));
6293 if (c >= 0) c += nelem(op_table_underscore);
6294 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6297 /* Deal specially with operators that might take a certificate variable
6298 as we do not want to do the usual expansion. For most, expand the string.*/
6308 const uschar * s1 = s;
6309 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6311 if (!sub) goto EXPAND_FAILED; /*{*/
6314 expand_string_message =
6315 string_sprintf("missing '}' closing cert arg of %s", name);
6316 goto EXPAND_FAILED_CURLY;
6318 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6328 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6329 if (!sub) goto EXPAND_FAILED;
6334 /* If we are skipping, we don't need to perform the operation at all.
6335 This matters for operations like "mask", because the data may not be
6336 in the correct format when skipping. For example, the expression may test
6337 for the existence of $sender_host_address before trying to mask it. For
6338 other operations, doing them may not fail, but it is a waste of time. */
6340 if (skipping && c >= 0) continue;
6342 /* Otherwise, switch on the operator type */
6349 unsigned long int n = Ustrtoul(sub, &t, 10);
6354 expand_string_message = string_sprintf("argument for base32 "
6355 "operator is \"%s\", which is not a decimal number", sub);
6359 g = string_catn(g, &base32_chars[n & 0x1f], 1);
6361 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
6368 unsigned long int n = 0;
6372 uschar * t = Ustrchr(base32_chars, *tt++);
6375 expand_string_message = string_sprintf("argument for base32d "
6376 "operator is \"%s\", which is not a base 32 number", sub);
6379 n = n * 32 + (t - base32_chars);
6381 s = string_sprintf("%ld", n);
6382 yield = string_cat(yield, s);
6389 unsigned long int n = Ustrtoul(sub, &t, 10);
6392 expand_string_message = string_sprintf("argument for base62 "
6393 "operator is \"%s\", which is not a decimal number", sub);
6396 t = string_base62(n);
6397 yield = string_cat(yield, t);
6401 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6407 unsigned long int n = 0;
6410 uschar *t = Ustrchr(base62_chars, *tt++);
6413 expand_string_message = string_sprintf("argument for base62d "
6414 "operator is \"%s\", which is not a base %d number", sub,
6418 n = n * BASE_62 + (t - base62_chars);
6420 (void)sprintf(CS buf, "%ld", n);
6421 yield = string_cat(yield, buf);
6427 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6428 if (expanded == NULL)
6430 expand_string_message =
6431 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6432 expand_string_message);
6435 yield = string_cat(yield, expanded);
6442 uschar *t = sub - 1;
6443 while (*(++t) != 0) { *t = tolower(*t); count++; }
6444 yield = string_catn(yield, sub, count);
6451 uschar *t = sub - 1;
6452 while (*(++t) != 0) { *t = toupper(*t); count++; }
6453 yield = string_catn(yield, sub, count);
6459 if (vp && *(void **)vp->value)
6461 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6462 yield = string_cat(yield, cp);
6472 md5_end(&base, sub, Ustrlen(sub), digest);
6473 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6474 yield = string_cat(yield, US st);
6480 if (vp && *(void **)vp->value)
6482 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6483 yield = string_cat(yield, cp);
6493 sha1_end(&h, sub, Ustrlen(sub), digest);
6494 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6495 yield = string_catn(yield, US st, 40);
6500 #ifdef EXIM_HAVE_SHA2
6501 if (vp && *(void **)vp->value)
6503 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6504 yield = string_cat(yield, cp);
6512 if (!exim_sha_init(&h, HASH_SHA2_256))
6514 expand_string_message = US"unrecognised sha256 variant";
6517 exim_sha_update(&h, sub, Ustrlen(sub));
6518 exim_sha_finish(&h, &b);
6521 sprintf(st, "%02X", *b.data++);
6522 yield = string_catn(yield, US st, 2);
6526 expand_string_message = US"sha256 only supported with TLS";
6531 #ifdef EXIM_HAVE_SHA3
6536 hashmethod m = !arg ? HASH_SHA3_256
6537 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6538 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6539 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6540 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6543 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6545 expand_string_message = US"unrecognised sha3 variant";
6549 exim_sha_update(&h, sub, Ustrlen(sub));
6550 exim_sha_finish(&h, &b);
6553 sprintf(st, "%02X", *b.data++);
6554 yield = string_catn(yield, US st, 2);
6559 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
6563 /* Convert hex encoding to base64 encoding */
6573 for (enc = sub; *enc != 0; enc++)
6575 if (!isxdigit(*enc))
6577 expand_string_message = string_sprintf("\"%s\" is not a hex "
6586 expand_string_message = string_sprintf("\"%s\" contains an odd "
6587 "number of characters", sub);
6591 while ((c = *in++) != 0)
6593 if (isdigit(c)) c -= '0';
6594 else c = toupper(c) - 'A' + 10;
6606 enc = b64encode(sub, out - sub);
6607 yield = string_cat(yield, enc);
6611 /* Convert octets outside 0x21..0x7E to \xXX form */
6615 uschar *t = sub - 1;
6618 if (*t < 0x21 || 0x7E < *t)
6619 yield = string_catn(yield, string_sprintf("\\x%02x", *t), 4);
6621 yield = string_catn(yield, t, 1);
6626 /* count the number of list elements */
6635 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6636 cp = string_sprintf("%d", cnt);
6637 yield = string_cat(yield, cp);
6641 /* expand a named list given the name */
6642 /* handles nested named lists; requotes as colon-sep list */
6646 tree_node *t = NULL;
6647 const uschar * list;
6650 uschar * suffix = US"";
6651 BOOL needsep = FALSE;
6654 if (*sub == '+') sub++;
6655 if (arg == NULL) /* no-argument version */
6657 if (!(t = tree_search(addresslist_anchor, sub)) &&
6658 !(t = tree_search(domainlist_anchor, sub)) &&
6659 !(t = tree_search(hostlist_anchor, sub)))
6660 t = tree_search(localpartlist_anchor, sub);
6662 else switch(*arg) /* specific list-type version */
6664 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6665 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6666 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6667 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6669 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6675 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6677 : *arg=='a'?"address "
6678 : *arg=='d'?"domain "
6680 : *arg=='l'?"localpart "
6685 list = ((namedlist_block *)(t->data.ptr))->string;
6687 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
6689 uschar * buf = US" : ";
6691 yield = string_catn(yield, buf, 3);
6695 if (*item == '+') /* list item is itself a named list */
6697 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6698 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6700 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6704 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6705 while ((cp= strpbrk(CCS item, tok)))
6707 yield = string_catn(yield, item, cp - CS item);
6708 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6710 yield = string_catn(yield, US"::", 2);
6713 else /* sep in item; should already be doubled; emit once */
6715 yield = string_catn(yield, US tok, 1);
6716 if (*cp == sep) cp++;
6721 yield = string_cat(yield, item);
6726 /* mask applies a mask to an IP address; for example the result of
6727 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6734 int mask, maskoffset;
6735 int type = string_is_ip_address(sub, &maskoffset);
6740 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6745 if (maskoffset == 0)
6747 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6752 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6754 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6756 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6761 /* Convert the address to binary integer(s) and apply the mask */
6763 sub[maskoffset] = 0;
6764 count = host_aton(sub, binary);
6765 host_mask(count, binary, mask);
6767 /* Convert to masked textual format and add to output. */
6769 yield = string_catn(yield, buffer,
6770 host_nmtoa(count, binary, mask, buffer, '.'));
6775 case EOP_IPV6DENORM:
6777 int type = string_is_ip_address(sub, NULL);
6784 (void) host_aton(sub, binary);
6787 case 4: /* convert to IPv4-mapped IPv6 */
6788 binary[0] = binary[1] = 0;
6789 binary[2] = 0x0000ffff;
6790 (void) host_aton(sub, binary+3);
6794 expand_string_message =
6795 string_sprintf("\"%s\" is not an IP address", sub);
6799 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
6800 ? ipv6_nmtoa(binary, buffer)
6801 : host_nmtoa(4, binary, -1, buffer, ':')
6807 case EOP_LOCAL_PART:
6811 int start, end, domain;
6812 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
6815 if (c != EOP_DOMAIN)
6817 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6818 yield = string_catn(yield, sub+start, end-start);
6820 else if (domain != 0)
6823 yield = string_catn(yield, sub+domain, end-domain);
6830 uschar outsep[2] = { ':', '\0' };
6831 uschar *address, *error;
6832 int save_ptr = yield->ptr;
6833 int start, end, domain; /* Not really used */
6835 while (isspace(*sub)) sub++;
6837 if (*outsep = *++sub) ++sub;
6840 expand_string_message = string_sprintf("output separator "
6841 "missing in expanding ${addresses:%s}", --sub);
6844 parse_allow_group = TRUE;
6848 uschar *p = parse_find_address_end(sub, FALSE);
6849 uschar saveend = *p;
6851 address = parse_extract_address(sub, &error, &start, &end, &domain,
6855 /* Add the address to the output list that we are building. This is
6856 done in chunks by searching for the separator character. At the
6857 start, unless we are dealing with the first address of the output
6858 list, add in a space if the new address begins with the separator
6859 character, or is an empty string. */
6861 if (address != NULL)
6863 if (yield->ptr != save_ptr && address[0] == *outsep)
6864 yield = string_catn(yield, US" ", 1);
6868 size_t seglen = Ustrcspn(address, outsep);
6869 yield = string_catn(yield, address, seglen + 1);
6871 /* If we got to the end of the string we output one character
6874 if (address[seglen] == '\0') { yield->ptr--; break; }
6875 yield = string_catn(yield, outsep, 1);
6876 address += seglen + 1;
6879 /* Output a separator after the string: we will remove the
6880 redundant final one at the end. */
6882 yield = string_catn(yield, outsep, 1);
6885 if (saveend == '\0') break;
6889 /* If we have generated anything, remove the redundant final
6892 if (yield->ptr != save_ptr) yield->ptr--;
6893 parse_allow_group = FALSE;
6898 /* quote puts a string in quotes if it is empty or contains anything
6899 other than alphamerics, underscore, dot, or hyphen.
6901 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6902 be quoted in order to be a valid local part.
6904 In both cases, newlines and carriage returns are converted into \n and \r
6908 case EOP_QUOTE_LOCAL_PART:
6911 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6912 uschar *t = sub - 1;
6916 while (!needs_quote && *(++t) != 0)
6917 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6919 else /* EOP_QUOTE_LOCAL_PART */
6921 while (!needs_quote && *(++t) != 0)
6922 needs_quote = !isalnum(*t) &&
6923 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6924 (*t != '.' || t == sub || t[1] == 0);
6929 yield = string_catn(yield, US"\"", 1);
6934 yield = string_catn(yield, US"\\n", 2);
6935 else if (*t == '\r')
6936 yield = string_catn(yield, US"\\r", 2);
6939 if (*t == '\\' || *t == '"')
6940 yield = string_catn(yield, US"\\", 1);
6941 yield = string_catn(yield, t, 1);
6944 yield = string_catn(yield, US"\"", 1);
6946 else yield = string_cat(yield, sub);
6950 /* quote_lookuptype does lookup-specific quoting */
6955 uschar *opt = Ustrchr(arg, '_');
6957 if (opt != NULL) *opt++ = 0;
6959 n = search_findtype(arg, Ustrlen(arg));
6962 expand_string_message = search_error_message;
6966 if (lookup_list[n]->quote != NULL)
6967 sub = (lookup_list[n]->quote)(sub, opt);
6968 else if (opt != NULL) sub = NULL;
6972 expand_string_message = string_sprintf(
6973 "\"%s\" unrecognized after \"${quote_%s\"",
6978 yield = string_cat(yield, sub);
6982 /* rx quote sticks in \ before any non-alphameric character so that
6983 the insertion works in a regular expression. */
6987 uschar *t = sub - 1;
6991 yield = string_catn(yield, US"\\", 1);
6992 yield = string_catn(yield, t, 1);
6997 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6998 prescribed by the RFC, if there are characters that need to be encoded */
7002 uschar buffer[2048];
7003 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7004 buffer, sizeof(buffer), FALSE);
7005 yield = string_cat(yield, string);
7009 /* RFC 2047 decode */
7015 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7016 headers_charset, '?', &len, &error);
7019 expand_string_message = error;
7022 yield = string_catn(yield, decoded, len);
7026 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7036 if (c > 255) c = '_';
7038 yield = string_catn(yield, buff, 1);
7043 /* replace illegal UTF-8 sequences by replacement character */
7045 #define UTF8_REPLACEMENT_CHAR US"?"
7049 int seq_len = 0, index = 0;
7051 long codepoint = -1;
7052 uschar seq_buff[4]; /* accumulate utf-8 here */
7061 if ((c & 0xc0) != 0x80)
7062 /* wrong continuation byte; invalidate all bytes */
7063 complete = 1; /* error */
7066 codepoint = (codepoint << 6) | (c & 0x3f);
7067 seq_buff[index++] = c;
7068 if (--bytes_left == 0) /* codepoint complete */
7069 if(codepoint > 0x10FFFF) /* is it too large? */
7070 complete = -1; /* error (RFC3629 limit) */
7072 { /* finished; output utf-8 sequence */
7073 yield = string_catn(yield, seq_buff, seq_len);
7078 else /* no bytes left: new sequence */
7080 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7082 yield = string_catn(yield, &c, 1);
7085 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7087 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7092 codepoint = c & 0x1f;
7095 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7098 codepoint = c & 0x0f;
7100 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7103 codepoint = c & 0x07;
7105 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7108 seq_buff[index++] = c;
7109 seq_len = bytes_left + 1;
7110 } /* if(bytes_left) */
7114 bytes_left = index = 0;
7115 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7117 if ((complete == 1) && ((c & 0x80) == 0))
7118 /* ASCII character follows incomplete sequence */
7119 yield = string_catn(yield, &c, 1);
7125 case EOP_UTF8_DOMAIN_TO_ALABEL:
7127 uschar * error = NULL;
7128 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7131 expand_string_message = string_sprintf(
7132 "error converting utf8 (%s) to alabel: %s",
7133 string_printing(sub), error);
7136 yield = string_cat(yield, s);
7140 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7142 uschar * error = NULL;
7143 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7146 expand_string_message = string_sprintf(
7147 "error converting alabel (%s) to utf8: %s",
7148 string_printing(sub), error);
7151 yield = string_cat(yield, s);
7155 case EOP_UTF8_LOCALPART_TO_ALABEL:
7157 uschar * error = NULL;
7158 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7161 expand_string_message = string_sprintf(
7162 "error converting utf8 (%s) to alabel: %s",
7163 string_printing(sub), error);
7166 yield = string_cat(yield, s);
7167 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7171 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7173 uschar * error = NULL;
7174 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7177 expand_string_message = string_sprintf(
7178 "error converting alabel (%s) to utf8: %s",
7179 string_printing(sub), error);
7182 yield = string_cat(yield, s);
7185 #endif /* EXPERIMENTAL_INTERNATIONAL */
7187 /* escape turns all non-printing characters into escape sequences. */
7191 const uschar * t = string_printing(sub);
7192 yield = string_cat(yield, t);
7196 case EOP_ESCAPE8BIT:
7198 const uschar * s = sub;
7201 for (s = sub; (c = *s); s++)
7202 yield = c < 127 && c != '\\'
7203 ? string_catn(yield, s, 1)
7204 : string_catn(yield, string_sprintf("\\%03o", c), 4);
7208 /* Handle numeric expression evaluation */
7213 uschar *save_sub = sub;
7214 uschar *error = NULL;
7215 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7218 expand_string_message = string_sprintf("error in expression "
7219 "evaluation: %s (after processing \"%.*s\")", error,
7220 (int)(sub-save_sub), save_sub);
7223 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
7224 yield = string_cat(yield, var_buffer);
7228 /* Handle time period formating */
7232 int n = readconf_readtime(sub, 0, FALSE);
7235 expand_string_message = string_sprintf("string \"%s\" is not an "
7236 "Exim time interval in \"%s\" operator", sub, name);
7239 sprintf(CS var_buffer, "%d", n);
7240 yield = string_cat(yield, var_buffer);
7244 case EOP_TIME_INTERVAL:
7247 uschar *t = read_number(&n, sub);
7248 if (*t != 0) /* Not A Number*/
7250 expand_string_message = string_sprintf("string \"%s\" is not a "
7251 "positive number in \"%s\" operator", sub, name);
7254 t = readconf_printtime(n);
7255 yield = string_cat(yield, t);
7259 /* Convert string to base64 encoding */
7265 uschar * s = vp && *(void **)vp->value
7266 ? tls_cert_der_b64(*(void **)vp->value)
7267 : b64encode(sub, Ustrlen(sub));
7269 uschar * s = b64encode(sub, Ustrlen(sub));
7271 yield = string_cat(yield, s);
7278 int len = b64decode(sub, &s);
7281 expand_string_message = string_sprintf("string \"%s\" is not "
7282 "well-formed for \"%s\" operator", sub, name);
7285 yield = string_cat(yield, s);
7289 /* strlen returns the length of the string */
7294 (void)sprintf(CS buff, "%d", Ustrlen(sub));
7295 yield = string_cat(yield, buff);
7299 /* length_n or l_n takes just the first n characters or the whole string,
7300 whichever is the shorter;
7302 substr_m_n, and s_m_n take n characters from offset m; negative m take
7303 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7304 takes the rest, either to the right or to the left.
7306 hash_n or h_n makes a hash of length n from the string, yielding n
7307 characters from the set a-z; hash_n_m makes a hash of length n, but
7308 uses m characters from the set a-zA-Z0-9.
7310 nhash_n returns a single number between 0 and n-1 (in text form), while
7311 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7312 between 0 and n-1 and the second between 0 and m-1. */
7332 expand_string_message = string_sprintf("missing values after %s",
7337 /* "length" has only one argument, effectively being synonymous with
7340 if (c == EOP_LENGTH || c == EOP_L)
7346 /* The others have one or two arguments; for "substr" the first may be
7347 negative. The second being negative means "not supplied". */
7352 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7355 /* Read up to two numbers, separated by underscores */
7360 if (arg != ret && *arg == '_' && pn == &value1)
7364 if (arg[1] != 0) arg++;
7366 else if (!isdigit(*arg))
7368 expand_string_message =
7369 string_sprintf("non-digit after underscore in \"%s\"", name);
7372 else *pn = (*pn)*10 + *arg++ - '0';
7376 /* Perform the required operation */
7379 (c == EOP_HASH || c == EOP_H)?
7380 compute_hash(sub, value1, value2, &len) :
7381 (c == EOP_NHASH || c == EOP_NH)?
7382 compute_nhash(sub, value1, value2, &len) :
7383 extract_substr(sub, value1, value2, &len);
7385 if (ret == NULL) goto EXPAND_FAILED;
7386 yield = string_catn(yield, ret, len);
7396 uschar **modetable[3];
7401 if ((expand_forbid & RDO_EXISTS) != 0)
7403 expand_string_message = US"Use of the stat() expansion is not permitted";
7407 if (stat(CS sub, &st) < 0)
7409 expand_string_message = string_sprintf("stat(%s) failed: %s",
7410 sub, strerror(errno));
7414 switch (mode & S_IFMT)
7416 case S_IFIFO: smode[0] = 'p'; break;
7417 case S_IFCHR: smode[0] = 'c'; break;
7418 case S_IFDIR: smode[0] = 'd'; break;
7419 case S_IFBLK: smode[0] = 'b'; break;
7420 case S_IFREG: smode[0] = '-'; break;
7421 default: smode[0] = '?'; break;
7424 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7425 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7426 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7428 for (i = 0; i < 3; i++)
7430 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7435 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7436 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7437 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7438 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7439 (long)st.st_gid, st.st_size, (long)st.st_atime,
7440 (long)st.st_mtime, (long)st.st_ctime);
7441 yield = string_cat(yield, s);
7445 /* vaguely random number less than N */
7449 int_eximarith_t max;
7452 max = expanded_string_integer(sub, TRUE);
7453 if (expand_string_message != NULL)
7455 s = string_sprintf("%d", vaguely_random_number((int)max));
7456 yield = string_cat(yield, s);
7460 /* Reverse IP, including IPv6 to dotted-nibble */
7462 case EOP_REVERSE_IP:
7464 int family, maskptr;
7465 uschar reversed[128];
7467 family = string_is_ip_address(sub, &maskptr);
7470 expand_string_message = string_sprintf(
7471 "reverse_ip() not given an IP address [%s]", sub);
7474 invert_address(reversed, sub);
7475 yield = string_cat(yield, reversed);
7479 /* Unknown operator */
7482 expand_string_message =
7483 string_sprintf("unknown expansion operator \"%s\"", name);
7488 /* Handle a plain name. If this is the first thing in the expansion, release
7489 the pre-allocated buffer. If the result data is known to be in a new buffer,
7490 newsize will be set to the size of that buffer, and we can just point at that
7491 store instead of copying. Many expansion strings contain just one reference,
7492 so this is a useful optimization, especially for humungous headers
7493 ($message_headers). */
7502 g = store_get(sizeof(gstring));
7503 else if (yield->ptr == 0)
7505 if (resetok) store_reset(yield);
7507 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
7509 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
7511 expand_string_message =
7512 string_sprintf("unknown variable in \"${%s}\"", name);
7513 check_variable_error_message(name);
7516 len = Ustrlen(value);
7517 if (!yield && newsize)
7520 yield->size = newsize;
7525 yield = string_catn(yield, value, len);
7529 /* Else there's something wrong */
7531 expand_string_message =
7532 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7533 "in a variable reference)", name);
7537 /* If we hit the end of the string when ket_ends is set, there is a missing
7538 terminating brace. */
7540 if (ket_ends && *s == 0)
7542 expand_string_message = malformed_header
7543 ? US"missing } at end of string - could be header name not terminated by colon"
7544 : US"missing } at end of string";
7548 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7549 added to the string. If so, set up an empty string. Add a terminating zero. If
7550 left != NULL, return a pointer to the terminator. */
7553 yield = string_get(1);
7554 (void) string_from_gstring(yield);
7555 if (left) *left = s;
7557 /* Any stacking store that was used above the final string is no longer needed.
7558 In many cases the final string will be the first one that was got and so there
7559 will be optimal store usage. */
7561 if (resetok) store_reset(yield->s + (yield->size = yield->ptr + 1));
7562 else if (resetok_p) *resetok_p = FALSE;
7566 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
7567 "expanding: %.*s\n",
7568 (int)(s - string), string);
7569 debug_printf_indent("%s"
7570 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7572 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7575 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7576 "skipping: result is not used\n");
7581 /* This is the failure exit: easiest to program with a goto. We still need
7582 to update the pointer to the terminator, for cases of nested calls with "fail".
7585 EXPAND_FAILED_CURLY:
7586 if (malformed_header)
7587 expand_string_message =
7588 US"missing or misplaced { or } - could be header name not terminated by colon";
7590 else if (!expand_string_message || !*expand_string_message)
7591 expand_string_message = US"missing or misplaced { or }";
7593 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7594 that is a bad idea, because expand_string_message is in dynamic store. */
7597 if (left) *left = s;
7600 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
7602 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7603 "error message: %s\n",
7604 expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7605 expand_string_message);
7606 if (expand_string_forcedfail)
7607 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
7609 if (resetok_p && !resetok) *resetok_p = FALSE;
7615 /* This is the external function call. Do a quick check for any expansion
7616 metacharacters, and if there are none, just return the input string.
7618 Argument: the string to be expanded
7619 Returns: the expanded string, or NULL if expansion failed; if failure was
7620 due to a lookup deferring, search_find_defer will be TRUE
7624 expand_cstring(const uschar * string)
7626 if (Ustrpbrk(string, "$\\") != NULL)
7628 int old_pool = store_pool;
7631 search_find_defer = FALSE;
7632 malformed_header = FALSE;
7633 store_pool = POOL_MAIN;
7634 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7635 store_pool = old_pool;
7643 expand_string(uschar * string)
7645 return US expand_cstring(CUS string);
7652 /*************************************************
7654 *************************************************/
7656 /* Now and again we want to expand a string and be sure that the result is in a
7657 new bit of store. This function does that.
7658 Since we know it has been copied, the de-const cast is safe.
7660 Argument: the string to be expanded
7661 Returns: the expanded string, always in a new bit of store, or NULL
7665 expand_string_copy(const uschar *string)
7667 const uschar *yield = expand_cstring(string);
7668 if (yield == string) yield = string_copy(string);
7674 /*************************************************
7675 * Expand and interpret as an integer *
7676 *************************************************/
7678 /* Expand a string, and convert the result into an integer.
7681 string the string to be expanded
7682 isplus TRUE if a non-negative number is expected
7684 Returns: the integer value, or
7685 -1 for an expansion error ) in both cases, message in
7686 -2 for an integer interpretation error ) expand_string_message
7687 expand_string_message is set NULL for an OK integer
7691 expand_string_integer(uschar *string, BOOL isplus)
7693 return expanded_string_integer(expand_string(string), isplus);
7697 /*************************************************
7698 * Interpret string as an integer *
7699 *************************************************/
7701 /* Convert a string (that has already been expanded) into an integer.
7703 This function is used inside the expansion code.
7706 s the string to be expanded
7707 isplus TRUE if a non-negative number is expected
7709 Returns: the integer value, or
7710 -1 if string is NULL (which implies an expansion error)
7711 -2 for an integer interpretation error
7712 expand_string_message is set NULL for an OK integer
7715 static int_eximarith_t
7716 expanded_string_integer(const uschar *s, BOOL isplus)
7718 int_eximarith_t value;
7719 uschar *msg = US"invalid integer \"%s\"";
7722 /* If expansion failed, expand_string_message will be set. */
7724 if (s == NULL) return -1;
7726 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7727 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7728 systems, so we set it zero ourselves. */
7731 expand_string_message = NULL; /* Indicates no error */
7733 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7734 equal to 0. Unfortunately, people actually relied upon that, so preserve
7735 the behaviour explicitly. Stripping leading whitespace is a harmless
7736 noop change since strtol skips it anyway (provided that there is a number
7740 while (isspace(*s)) ++s;
7744 debug_printf_indent("treating blank string as number 0\n");
7749 value = strtoll(CS s, CSS &endptr, 10);
7753 msg = US"integer expected but \"%s\" found";
7755 else if (value < 0 && isplus)
7757 msg = US"non-negative integer expected but \"%s\" found";
7761 switch (tolower(*endptr))
7766 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7771 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7772 else value *= 1024*1024;
7776 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7777 else value *= 1024*1024*1024;
7781 if (errno == ERANGE)
7782 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7785 while (isspace(*endptr)) endptr++;
7786 if (*endptr == 0) return value;
7790 expand_string_message = string_sprintf(CS msg, s);
7795 /* These values are usually fixed boolean values, but they are permitted to be
7799 addr address being routed
7800 mtype the module type
7801 mname the module name
7802 dbg_opt debug selectors
7803 oname the option name
7804 bvalue the router's boolean value
7805 svalue the router's string value
7806 rvalue where to put the returned value
7808 Returns: OK value placed in rvalue
7809 DEFER expansion failed
7813 exp_bool(address_item *addr,
7814 uschar *mtype, uschar *mname, unsigned dbg_opt,
7815 uschar *oname, BOOL bvalue,
7816 uschar *svalue, BOOL *rvalue)
7819 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7821 expanded = expand_string(svalue);
7822 if (expanded == NULL)
7824 if (expand_string_forcedfail)
7826 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7830 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7831 oname, mname, mtype, expand_string_message);
7832 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7836 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7839 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7841 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7845 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7846 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7855 /* Avoid potentially exposing a password in a string about to be logged */
7858 expand_hide_passwords(uschar * s)
7860 return ( ( Ustrstr(s, "failed to expand") != NULL
7861 || Ustrstr(s, "expansion of ") != NULL
7863 && ( Ustrstr(s, "mysql") != NULL
7864 || Ustrstr(s, "pgsql") != NULL
7865 || Ustrstr(s, "redis") != NULL
7866 || Ustrstr(s, "sqlite") != NULL
7867 || Ustrstr(s, "ldap:") != NULL
7868 || Ustrstr(s, "ldaps:") != NULL
7869 || Ustrstr(s, "ldapi:") != NULL
7870 || Ustrstr(s, "ldapdn:") != NULL
7871 || Ustrstr(s, "ldapm:") != NULL
7873 ? US"Temporary internal error" : s;
7877 /* Read given named file into big_buffer. Use for keying material etc.
7878 The content will have an ascii NUL appended.
7883 Return: pointer to buffer, or NULL on error.
7887 expand_file_big_buffer(const uschar * filename)
7889 int fd, off = 0, len;
7891 if ((fd = open(CS filename, O_RDONLY)) < 0)
7893 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
7900 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
7903 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
7911 big_buffer[off] = '\0';
7917 /*************************************************
7918 * Error-checking for testsuite *
7919 *************************************************/
7921 uschar * region_start;
7922 uschar * region_end;
7923 const uschar *var_name;
7924 const uschar *var_data;
7928 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
7931 if (var_data >= e->region_start && var_data < e->region_end)
7933 e->var_name = CUS var_name;
7934 e->var_data = CUS var_data;
7939 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
7941 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
7942 .var_name = NULL, .var_data = NULL };
7946 /* check acl_ variables */
7947 tree_walk(acl_var_c, assert_variable_notin, &e);
7948 tree_walk(acl_var_m, assert_variable_notin, &e);
7950 /* check auth<n> variables */
7951 for (i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
7952 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
7954 /* check regex<n> variables */
7955 for (i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
7956 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
7958 /* check known-name variables */
7959 for (v = var_table; v < var_table + var_table_size; v++)
7960 if (v->type == vtype_stringptr)
7961 assert_variable_notin(US v->name, *(USS v->value), &e);
7963 /* check dns and address trees */
7964 tree_walk(tree_dns_fails, assert_variable_notin, &e);
7965 tree_walk(tree_duplicates, assert_variable_notin, &e);
7966 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
7967 tree_walk(tree_unusable, assert_variable_notin, &e);
7970 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
7971 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
7972 e.var_name, filename, linenumber, e.var_data);
7977 /*************************************************
7978 **************************************************
7979 * Stand-alone test program *
7980 **************************************************
7981 *************************************************/
7987 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7989 int ovector[3*(EXPAND_MAXN+1)];
7990 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7991 ovector, nelem(ovector));
7992 BOOL yield = n >= 0;
7993 if (n == 0) n = EXPAND_MAXN + 1;
7997 expand_nmax = (setup < 0)? 0 : setup + 1;
7998 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
8000 expand_nstring[expand_nmax] = subject + ovector[nn];
8001 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8009 int main(int argc, uschar **argv)
8012 uschar buffer[1024];
8014 debug_selector = D_v;
8015 debug_file = stderr;
8016 debug_fd = fileno(debug_file);
8017 big_buffer = malloc(big_buffer_size);
8019 for (i = 1; i < argc; i++)
8021 if (argv[i][0] == '+')
8023 debug_trace_memory = 2;
8026 if (isdigit(argv[i][0]))
8027 debug_selector = Ustrtol(argv[i], NULL, 0);
8029 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8033 eldap_default_servers = argv[i];
8036 mysql_servers = argv[i];
8039 pgsql_servers = argv[i];
8042 redis_servers = argv[i];
8046 else opt_perl_startup = argv[i];
8050 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8052 expand_nstring[1] = US"string 1....";
8053 expand_nlength[1] = 8;
8057 if (opt_perl_startup != NULL)
8060 printf("Starting Perl interpreter\n");
8061 errstr = init_perl(opt_perl_startup);
8064 printf("** error in perl_startup code: %s\n", errstr);
8065 return EXIT_FAILURE;
8068 #endif /* EXIM_PERL */
8070 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8072 void *reset_point = store_get(0);
8073 uschar *yield = expand_string(buffer);
8076 printf("%s\n", yield);
8077 store_reset(reset_point);
8081 if (search_find_defer) printf("search_find deferred\n");
8082 printf("Failed: %s\n", expand_string_message);
8083 if (expand_string_forcedfail) printf("Forced failure\n");
8097 /* End of expand.c */