1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *);
17 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
20 # ifndef SUPPORT_CRYPTEQ
21 # define SUPPORT_CRYPTEQ
26 # include "lookups/ldap.h"
29 #ifdef SUPPORT_CRYPTEQ
34 extern char* crypt16(char*, char*);
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. Characters after the first 16 are ignored. It always generates
50 a 16-byte hash, which is expressed together with the salt as a string
51 of 24 base 64 digits. Here are some links to peruse:
53 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
54 http://seclists.org/bugtraq/1999/Mar/0076.html
56 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
57 and OSF/1. This is the same as the standard crypt if given a password
58 of 8 characters or less. If given more, it first does the same as crypt
59 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
60 using as salt the first two base 64 digits from the first hash block.
61 If the password is more than 16 characters then it crypts the 17th to 24th
62 characters using as salt the first two base 64 digits from the second hash
63 block. And so on: I've seen references to it cutting off the password at
64 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
66 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
67 http://seclists.org/bugtraq/1999/Mar/0109.html
68 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
69 TET1_html/sec.c222.html#no_id_208
71 Exim has something it calls "crypt16". It will either use a native
72 crypt16 or its own implementation. A native crypt16 will presumably
73 be the one that I called "crypt16" above. The internal "crypt16"
74 function, however, is a two-block-maximum implementation of what I called
75 "bigcrypt". The documentation matches the internal code.
77 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
78 that crypt16 and bigcrypt were different things.
80 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
81 to whatever it is using under that name. This unfortunately sets a
82 precedent for using "{crypt16}" to identify two incompatible algorithms
83 whose output can't be distinguished. With "{crypt16}" thus rendered
84 ambiguous, I suggest you deprecate it and invent two new identifiers
85 for the two algorithms.
87 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
88 of the password separately means they can be cracked separately, so
89 the double-length hash only doubles the cracking effort instead of
90 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
166 /* Tables of operator names, and corresponding switch numbers. The names must be
167 in alphabetical order. There are two tables, because underscore is used in some
168 cases to introduce arguments, whereas for other it is part of the name. This is
169 an historical mis-design. */
171 static uschar *op_table_underscore[] = {
174 US"quote_local_part",
179 ,US"utf8_domain_from_alabel",
180 US"utf8_domain_to_alabel",
181 US"utf8_localpart_from_alabel",
182 US"utf8_localpart_to_alabel"
189 EOP_QUOTE_LOCAL_PART,
194 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
195 EOP_UTF8_DOMAIN_TO_ALABEL,
196 EOP_UTF8_LOCALPART_FROM_ALABEL,
197 EOP_UTF8_LOCALPART_TO_ALABEL
201 static uschar *op_table_main[] = {
248 EOP_ADDRESS = nelem(op_table_underscore),
294 /* Table of condition names, and corresponding switch numbers. The names must
295 be in alphabetical order. */
297 static uschar *cond_table[] = {
301 US"==", /* Backward compatibility */
334 US"match_local_part",
359 ECOND_FIRST_DELIVERY,
380 ECOND_MATCH_LOCAL_PART,
390 /* Types of table entry */
393 vtype_int, /* value is address of int */
394 vtype_filter_int, /* ditto, but recognized only when filtering */
395 vtype_ino, /* value is address of ino_t (not always an int) */
396 vtype_uid, /* value is address of uid_t (not always an int) */
397 vtype_gid, /* value is address of gid_t (not always an int) */
398 vtype_bool, /* value is address of bool */
399 vtype_stringptr, /* value is address of pointer to string */
400 vtype_msgbody, /* as stringptr, but read when first required */
401 vtype_msgbody_end, /* ditto, the end of the message */
402 vtype_msgheaders, /* the message's headers, processed */
403 vtype_msgheaders_raw, /* the message's headers, unprocessed */
404 vtype_localpart, /* extract local part from string */
405 vtype_domain, /* extract domain from string */
406 vtype_string_func, /* value is string returned by given function */
407 vtype_todbsdin, /* value not used; generate BSD inbox tod */
408 vtype_tode, /* value not used; generate tod in epoch format */
409 vtype_todel, /* value not used; generate tod in epoch/usec format */
410 vtype_todf, /* value not used; generate full tod */
411 vtype_todl, /* value not used; generate log tod */
412 vtype_todlf, /* value not used; generate log file datestamp tod */
413 vtype_todzone, /* value not used; generate time zone only */
414 vtype_todzulu, /* value not used; generate zulu tod */
415 vtype_reply, /* value not used; get reply from headers */
416 vtype_pid, /* value not used; result is pid */
417 vtype_host_lookup, /* value not used; get host name */
418 vtype_load_avg, /* value not used; result is int from os_getloadavg */
419 vtype_pspace, /* partition space; value is T/F for spool/log */
420 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
421 vtype_cert /* SSL certificate */
423 ,vtype_dkim /* Lookup of value in DKIM signature */
427 /* Type for main variable table */
435 /* Type for entries pointing to address/length pairs. Not currently
443 static uschar * fn_recipients(void);
445 /* This table must be kept in alphabetical order. */
447 static var_entry var_table[] = {
448 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
449 they will be confused with user-creatable ACL variables. */
450 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
451 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
452 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
453 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
454 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
455 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
456 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
457 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
458 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
459 { "acl_narg", vtype_int, &acl_narg },
460 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
461 { "address_data", vtype_stringptr, &deliver_address_data },
462 { "address_file", vtype_stringptr, &address_file },
463 { "address_pipe", vtype_stringptr, &address_pipe },
464 #ifdef EXPERIMENTAL_ARC
465 { "arc_domains", vtype_string_func, &fn_arc_domains },
466 { "arc_oldest_pass", vtype_int, &arc_oldest_pass },
467 { "arc_state", vtype_stringptr, &arc_state },
468 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
470 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
471 { "authenticated_id", vtype_stringptr, &authenticated_id },
472 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
473 { "authentication_failed",vtype_int, &authentication_failed },
474 #ifdef WITH_CONTENT_SCAN
475 { "av_failed", vtype_int, &av_failed },
477 #ifdef EXPERIMENTAL_BRIGHTMAIL
478 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
479 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
480 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
481 { "bmi_deliver", vtype_int, &bmi_deliver },
483 { "body_linecount", vtype_int, &body_linecount },
484 { "body_zerocount", vtype_int, &body_zerocount },
485 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
486 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
487 { "caller_gid", vtype_gid, &real_gid },
488 { "caller_uid", vtype_uid, &real_uid },
489 { "callout_address", vtype_stringptr, &callout_address },
490 { "compile_date", vtype_stringptr, &version_date },
491 { "compile_number", vtype_stringptr, &version_cnumber },
492 { "config_dir", vtype_stringptr, &config_main_directory },
493 { "config_file", vtype_stringptr, &config_main_filename },
494 { "csa_status", vtype_stringptr, &csa_status },
495 #ifdef EXPERIMENTAL_DCC
496 { "dcc_header", vtype_stringptr, &dcc_header },
497 { "dcc_result", vtype_stringptr, &dcc_result },
500 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
501 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
502 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
503 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
504 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
505 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
506 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
507 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
508 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
509 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
510 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
511 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
512 { "dkim_key_length", vtype_int, &dkim_key_length },
513 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
514 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
515 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
516 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
517 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
518 { "dkim_signers", vtype_stringptr, &dkim_signers },
519 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
520 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
522 #ifdef EXPERIMENTAL_DMARC
523 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
524 { "dmarc_status", vtype_stringptr, &dmarc_status },
525 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
526 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
528 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
529 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
530 { "dnslist_text", vtype_stringptr, &dnslist_text },
531 { "dnslist_value", vtype_stringptr, &dnslist_value },
532 { "domain", vtype_stringptr, &deliver_domain },
533 { "domain_data", vtype_stringptr, &deliver_domain_data },
534 #ifndef DISABLE_EVENT
535 { "event_data", vtype_stringptr, &event_data },
537 /*XXX want to use generic vars for as many of these as possible*/
538 { "event_defer_errno", vtype_int, &event_defer_errno },
540 { "event_name", vtype_stringptr, &event_name },
542 { "exim_gid", vtype_gid, &exim_gid },
543 { "exim_path", vtype_stringptr, &exim_path },
544 { "exim_uid", vtype_uid, &exim_uid },
545 { "exim_version", vtype_stringptr, &version_string },
546 { "headers_added", vtype_string_func, &fn_hdrs_added },
547 { "home", vtype_stringptr, &deliver_home },
548 { "host", vtype_stringptr, &deliver_host },
549 { "host_address", vtype_stringptr, &deliver_host_address },
550 { "host_data", vtype_stringptr, &host_data },
551 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
552 { "host_lookup_failed", vtype_int, &host_lookup_failed },
553 { "host_port", vtype_int, &deliver_host_port },
554 { "initial_cwd", vtype_stringptr, &initial_cwd },
555 { "inode", vtype_ino, &deliver_inode },
556 { "interface_address", vtype_stringptr, &interface_address },
557 { "interface_port", vtype_int, &interface_port },
558 { "item", vtype_stringptr, &iterate_item },
560 { "ldap_dn", vtype_stringptr, &eldap_dn },
562 { "load_average", vtype_load_avg, NULL },
563 { "local_part", vtype_stringptr, &deliver_localpart },
564 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
565 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
566 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
567 #ifdef HAVE_LOCAL_SCAN
568 { "local_scan_data", vtype_stringptr, &local_scan_data },
570 { "local_user_gid", vtype_gid, &local_user_gid },
571 { "local_user_uid", vtype_uid, &local_user_uid },
572 { "localhost_number", vtype_int, &host_number },
573 { "log_inodes", vtype_pinodes, (void *)FALSE },
574 { "log_space", vtype_pspace, (void *)FALSE },
575 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
576 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
577 #ifdef WITH_CONTENT_SCAN
578 { "malware_name", vtype_stringptr, &malware_name },
580 { "max_received_linelength", vtype_int, &max_received_linelength },
581 { "message_age", vtype_int, &message_age },
582 { "message_body", vtype_msgbody, &message_body },
583 { "message_body_end", vtype_msgbody_end, &message_body_end },
584 { "message_body_size", vtype_int, &message_body_size },
585 { "message_exim_id", vtype_stringptr, &message_id },
586 { "message_headers", vtype_msgheaders, NULL },
587 { "message_headers_raw", vtype_msgheaders_raw, NULL },
588 { "message_id", vtype_stringptr, &message_id },
589 { "message_linecount", vtype_int, &message_linecount },
590 { "message_size", vtype_int, &message_size },
592 { "message_smtputf8", vtype_bool, &message_smtputf8 },
594 #ifdef WITH_CONTENT_SCAN
595 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
596 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
597 { "mime_boundary", vtype_stringptr, &mime_boundary },
598 { "mime_charset", vtype_stringptr, &mime_charset },
599 { "mime_content_description", vtype_stringptr, &mime_content_description },
600 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
601 { "mime_content_id", vtype_stringptr, &mime_content_id },
602 { "mime_content_size", vtype_int, &mime_content_size },
603 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
604 { "mime_content_type", vtype_stringptr, &mime_content_type },
605 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
606 { "mime_filename", vtype_stringptr, &mime_filename },
607 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
608 { "mime_is_multipart", vtype_int, &mime_is_multipart },
609 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
610 { "mime_part_count", vtype_int, &mime_part_count },
612 { "n0", vtype_filter_int, &filter_n[0] },
613 { "n1", vtype_filter_int, &filter_n[1] },
614 { "n2", vtype_filter_int, &filter_n[2] },
615 { "n3", vtype_filter_int, &filter_n[3] },
616 { "n4", vtype_filter_int, &filter_n[4] },
617 { "n5", vtype_filter_int, &filter_n[5] },
618 { "n6", vtype_filter_int, &filter_n[6] },
619 { "n7", vtype_filter_int, &filter_n[7] },
620 { "n8", vtype_filter_int, &filter_n[8] },
621 { "n9", vtype_filter_int, &filter_n[9] },
622 { "original_domain", vtype_stringptr, &deliver_domain_orig },
623 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
624 { "originator_gid", vtype_gid, &originator_gid },
625 { "originator_uid", vtype_uid, &originator_uid },
626 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
627 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
628 { "pid", vtype_pid, NULL },
630 { "prdr_requested", vtype_bool, &prdr_requested },
632 { "primary_hostname", vtype_stringptr, &primary_hostname },
633 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
634 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
635 { "proxy_external_port", vtype_int, &proxy_external_port },
636 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
637 { "proxy_local_port", vtype_int, &proxy_local_port },
638 { "proxy_session", vtype_bool, &proxy_session },
640 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
641 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
642 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
643 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
644 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
645 { "queue_name", vtype_stringptr, &queue_name },
646 { "rcpt_count", vtype_int, &rcpt_count },
647 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
648 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
649 { "received_count", vtype_int, &received_count },
650 { "received_for", vtype_stringptr, &received_for },
651 { "received_ip_address", vtype_stringptr, &interface_address },
652 { "received_port", vtype_int, &interface_port },
653 { "received_protocol", vtype_stringptr, &received_protocol },
654 { "received_time", vtype_int, &received_time.tv_sec },
655 { "recipient_data", vtype_stringptr, &recipient_data },
656 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
657 { "recipients", vtype_string_func, &fn_recipients },
658 { "recipients_count", vtype_int, &recipients_count },
659 #ifdef WITH_CONTENT_SCAN
660 { "regex_match_string", vtype_stringptr, ®ex_match_string },
662 { "reply_address", vtype_reply, NULL },
663 { "return_path", vtype_stringptr, &return_path },
664 { "return_size_limit", vtype_int, &bounce_return_size_limit },
665 { "router_name", vtype_stringptr, &router_name },
666 { "runrc", vtype_int, &runrc },
667 { "self_hostname", vtype_stringptr, &self_hostname },
668 { "sender_address", vtype_stringptr, &sender_address },
669 { "sender_address_data", vtype_stringptr, &sender_address_data },
670 { "sender_address_domain", vtype_domain, &sender_address },
671 { "sender_address_local_part", vtype_localpart, &sender_address },
672 { "sender_data", vtype_stringptr, &sender_data },
673 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
674 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
675 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
676 { "sender_host_address", vtype_stringptr, &sender_host_address },
677 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
678 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
679 { "sender_host_name", vtype_host_lookup, NULL },
680 { "sender_host_port", vtype_int, &sender_host_port },
681 { "sender_ident", vtype_stringptr, &sender_ident },
682 { "sender_rate", vtype_stringptr, &sender_rate },
683 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
684 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
685 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
686 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
687 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
688 { "sending_port", vtype_int, &sending_port },
689 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
690 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
691 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
692 { "smtp_command_history", vtype_string_func, &smtp_cmd_hist },
693 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
694 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
695 { "sn0", vtype_filter_int, &filter_sn[0] },
696 { "sn1", vtype_filter_int, &filter_sn[1] },
697 { "sn2", vtype_filter_int, &filter_sn[2] },
698 { "sn3", vtype_filter_int, &filter_sn[3] },
699 { "sn4", vtype_filter_int, &filter_sn[4] },
700 { "sn5", vtype_filter_int, &filter_sn[5] },
701 { "sn6", vtype_filter_int, &filter_sn[6] },
702 { "sn7", vtype_filter_int, &filter_sn[7] },
703 { "sn8", vtype_filter_int, &filter_sn[8] },
704 { "sn9", vtype_filter_int, &filter_sn[9] },
705 #ifdef WITH_CONTENT_SCAN
706 { "spam_action", vtype_stringptr, &spam_action },
707 { "spam_bar", vtype_stringptr, &spam_bar },
708 { "spam_report", vtype_stringptr, &spam_report },
709 { "spam_score", vtype_stringptr, &spam_score },
710 { "spam_score_int", vtype_stringptr, &spam_score_int },
713 { "spf_guess", vtype_stringptr, &spf_guess },
714 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
715 { "spf_received", vtype_stringptr, &spf_received },
716 { "spf_result", vtype_stringptr, &spf_result },
717 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
718 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
720 { "spool_directory", vtype_stringptr, &spool_directory },
721 { "spool_inodes", vtype_pinodes, (void *)TRUE },
722 { "spool_space", vtype_pspace, (void *)TRUE },
723 #ifdef EXPERIMENTAL_SRS
724 { "srs_db_address", vtype_stringptr, &srs_db_address },
725 { "srs_db_key", vtype_stringptr, &srs_db_key },
726 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
727 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
728 { "srs_recipient", vtype_stringptr, &srs_recipient },
729 { "srs_status", vtype_stringptr, &srs_status },
731 { "thisaddress", vtype_stringptr, &filter_thisaddress },
733 /* The non-(in,out) variables are now deprecated */
734 { "tls_bits", vtype_int, &tls_in.bits },
735 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
736 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
738 { "tls_in_bits", vtype_int, &tls_in.bits },
739 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
740 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
741 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
742 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
743 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
744 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
745 #if defined(SUPPORT_TLS)
746 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
748 { "tls_out_bits", vtype_int, &tls_out.bits },
749 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
750 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
752 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
754 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
755 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
756 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
757 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
758 #if defined(SUPPORT_TLS)
759 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
762 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
765 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
766 #if defined(SUPPORT_TLS)
767 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
770 { "tod_bsdinbox", vtype_todbsdin, NULL },
771 { "tod_epoch", vtype_tode, NULL },
772 { "tod_epoch_l", vtype_todel, NULL },
773 { "tod_full", vtype_todf, NULL },
774 { "tod_log", vtype_todl, NULL },
775 { "tod_logfile", vtype_todlf, NULL },
776 { "tod_zone", vtype_todzone, NULL },
777 { "tod_zulu", vtype_todzulu, NULL },
778 { "transport_name", vtype_stringptr, &transport_name },
779 { "value", vtype_stringptr, &lookup_value },
780 { "verify_mode", vtype_stringptr, &verify_mode },
781 { "version_number", vtype_stringptr, &version_string },
782 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
783 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
784 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
785 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
786 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
787 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
790 static int var_table_size = nelem(var_table);
791 static uschar var_buffer[256];
792 static BOOL malformed_header;
794 /* For textual hashes */
796 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
797 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
800 enum { HMAC_MD5, HMAC_SHA1 };
802 /* For numeric hashes */
804 static unsigned int prime[] = {
805 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
806 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
807 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
809 /* For printing modes in symbolic form */
811 static uschar *mtable_normal[] =
812 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
814 static uschar *mtable_setid[] =
815 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
817 static uschar *mtable_sticky[] =
818 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
820 /* flags for find_header() */
821 #define FH_EXISTS_ONLY BIT(0)
822 #define FH_WANT_RAW BIT(1)
823 #define FH_WANT_LIST BIT(2)
826 /*************************************************
827 * Tables for UTF-8 support *
828 *************************************************/
830 /* Table of the number of extra characters, indexed by the first character
831 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
834 static uschar utf8_table1[] = {
835 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
836 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
837 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
838 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
840 /* These are the masks for the data bits in the first byte of a character,
841 indexed by the number of additional bytes. */
843 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
845 /* Get the next UTF-8 character, advancing the pointer. */
847 #define GETUTF8INC(c, ptr) \
849 if ((c & 0xc0) == 0xc0) \
851 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
853 c = (c & utf8_table2[a]) << s; \
857 c |= (*ptr++ & 0x3f) << s; \
863 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
865 /*************************************************
866 * Binary chop search on a table *
867 *************************************************/
869 /* This is used for matching expansion items and operators.
872 name the name that is being sought
873 table the table to search
874 table_size the number of items in the table
876 Returns: the offset in the table, or -1
880 chop_match(uschar *name, uschar **table, int table_size)
882 uschar **bot = table;
883 uschar **top = table + table_size;
887 uschar **mid = bot + (top - bot)/2;
888 int c = Ustrcmp(name, *mid);
889 if (c == 0) return mid - table;
890 if (c > 0) bot = mid + 1; else top = mid;
898 /*************************************************
899 * Check a condition string *
900 *************************************************/
902 /* This function is called to expand a string, and test the result for a "true"
903 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
904 forced fail or lookup defer.
906 We used to release all store used, but this is not not safe due
907 to ${dlfunc } and ${acl }. In any case expand_string_internal()
908 is reasonably careful to release what it can.
910 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
913 condition the condition string
914 m1 text to be incorporated in panic error
917 Returns: TRUE if condition is met, FALSE if not
921 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
924 uschar *ss = expand_string(condition);
927 if (!expand_string_forcedfail && !search_find_defer)
928 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
929 "for %s %s: %s", condition, m1, m2, expand_string_message);
932 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
933 strcmpic(ss, US"false") != 0;
940 /*************************************************
941 * Pseudo-random number generation *
942 *************************************************/
944 /* Pseudo-random number generation. The result is not "expected" to be
945 cryptographically strong but not so weak that someone will shoot themselves
946 in the foot using it as a nonce in some email header scheme or whatever
947 weirdness they'll twist this into. The result should ideally handle fork().
949 However, if we're stuck unable to provide this, then we'll fall back to
950 appallingly bad randomness.
952 If SUPPORT_TLS is defined then this will not be used except as an emergency
957 Returns a random number in range [0, max-1]
961 # define vaguely_random_number vaguely_random_number_fallback
964 vaguely_random_number(int max)
967 # undef vaguely_random_number
969 static pid_t pid = 0;
971 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
981 #ifdef HAVE_ARC4RANDOM
982 /* cryptographically strong randomness, common on *BSD platforms, not
983 so much elsewhere. Alas. */
984 #ifndef NOT_HAVE_ARC4RANDOM_STIR
987 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
988 #ifdef HAVE_SRANDOMDEV
989 /* uses random(4) for seeding */
992 gettimeofday(&tv, NULL);
993 srandom(tv.tv_sec | tv.tv_usec | getpid());
996 /* Poor randomness and no seeding here */
1003 #ifdef HAVE_ARC4RANDOM
1004 return arc4random() % max;
1005 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1006 return random() % max;
1008 /* This one returns a 16-bit number, definitely not crypto-strong */
1009 return random_number(max);
1016 /*************************************************
1017 * Pick out a name from a string *
1018 *************************************************/
1020 /* If the name is too long, it is silently truncated.
1023 name points to a buffer into which to put the name
1024 max is the length of the buffer
1025 s points to the first alphabetic character of the name
1026 extras chars other than alphanumerics to permit
1028 Returns: pointer to the first character after the name
1030 Note: The test for *s != 0 in the while loop is necessary because
1031 Ustrchr() yields non-NULL if the character is zero (which is not something
1034 static const uschar *
1035 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1038 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1040 if (ptr < max-1) name[ptr++] = *s;
1049 /*************************************************
1050 * Pick out the rest of a header name *
1051 *************************************************/
1053 /* A variable name starting $header_ (or just $h_ for those who like
1054 abbreviations) might not be the complete header name because headers can
1055 contain any printing characters in their names, except ':'. This function is
1056 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1057 on the end, if the name was terminated by white space.
1060 name points to a buffer in which the name read so far exists
1061 max is the length of the buffer
1062 s points to the first character after the name so far, i.e. the
1063 first non-alphameric character after $header_xxxxx
1065 Returns: a pointer to the first character after the header name
1068 static const uschar *
1069 read_header_name(uschar *name, int max, const uschar *s)
1071 int prelen = Ustrchr(name, '_') - name + 1;
1072 int ptr = Ustrlen(name) - prelen;
1073 if (ptr > 0) memmove(name, name+prelen, ptr);
1074 while (mac_isgraph(*s) && *s != ':')
1076 if (ptr < max-1) name[ptr++] = *s;
1087 /*************************************************
1088 * Pick out a number from a string *
1089 *************************************************/
1092 n points to an integer into which to put the number
1093 s points to the first digit of the number
1095 Returns: a pointer to the character after the last digit
1097 /*XXX consider expanding to int_eximarith_t. But the test for
1098 "overbig numbers" in 0002 still needs to overflow it. */
1101 read_number(int *n, uschar *s)
1104 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1108 static const uschar *
1109 read_cnumber(int *n, const uschar *s)
1112 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1118 /*************************************************
1119 * Extract keyed subfield from a string *
1120 *************************************************/
1122 /* The yield is in dynamic store; NULL means that the key was not found.
1125 key points to the name of the key
1126 s points to the string from which to extract the subfield
1128 Returns: NULL if the subfield was not found, or
1129 a pointer to the subfield's data
1133 expand_getkeyed(uschar *key, const uschar *s)
1135 int length = Ustrlen(key);
1136 while (isspace(*s)) s++;
1138 /* Loop to search for the key */
1144 const uschar *dkey = s;
1146 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1147 dkeylength = s - dkey;
1148 while (isspace(*s)) s++;
1149 if (*s == '=') while (isspace((*(++s))));
1151 data = string_dequote(&s);
1152 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1155 while (isspace(*s)) s++;
1164 find_var_ent(uschar * name)
1167 int last = var_table_size;
1169 while (last > first)
1171 int middle = (first + last)/2;
1172 int c = Ustrcmp(name, var_table[middle].name);
1174 if (c > 0) { first = middle + 1; continue; }
1175 if (c < 0) { last = middle; continue; }
1176 return &var_table[middle];
1181 /*************************************************
1182 * Extract numbered subfield from string *
1183 *************************************************/
1185 /* Extracts a numbered field from a string that is divided by tokens - for
1186 example a line from /etc/passwd is divided by colon characters. First field is
1187 numbered one. Negative arguments count from the right. Zero returns the whole
1188 string. Returns NULL if there are insufficient tokens in the string
1191 Modifies final argument - this is a dynamically generated string, so that's OK.
1194 field number of field to be extracted,
1195 first field = 1, whole string = 0, last field = -1
1196 separators characters that are used to break string into tokens
1197 s points to the string from which to extract the subfield
1199 Returns: NULL if the field was not found,
1200 a pointer to the field's data inside s (modified to add 0)
1204 expand_gettokened (int field, uschar *separators, uschar *s)
1209 uschar *fieldtext = NULL;
1211 if (field == 0) return s;
1213 /* Break the line up into fields in place; for field > 0 we stop when we have
1214 done the number of fields we want. For field < 0 we continue till the end of
1215 the string, counting the number of fields. */
1217 count = (field > 0)? field : INT_MAX;
1223 /* Previous field was the last one in the string. For a positive field
1224 number, this means there are not enough fields. For a negative field number,
1225 check that there are enough, and scan back to find the one that is wanted. */
1229 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1230 if ((-field) == (INT_MAX - count - 1)) return s;
1234 while (ss[-1] != 0) ss--;
1240 /* Previous field was not last in the string; save its start and put a
1244 len = Ustrcspn(ss, separators);
1255 expand_getlistele(int field, const uschar * list)
1257 const uschar * tlist= list;
1263 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1266 if(field==0) return NULL;
1267 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1268 return string_nextinlist(&list, &sep, NULL, 0);
1272 /* Certificate fields, by name. Worry about by-OID later */
1273 /* Names are chosen to not have common prefixes */
1280 uschar * (*getfn)(void * cert, uschar * mod);
1282 static certfield certfields[] =
1283 { /* linear search; no special order */
1284 { US"version", 7, &tls_cert_version },
1285 { US"serial_number", 13, &tls_cert_serial_number },
1286 { US"subject", 7, &tls_cert_subject },
1287 { US"notbefore", 9, &tls_cert_not_before },
1288 { US"notafter", 8, &tls_cert_not_after },
1289 { US"issuer", 6, &tls_cert_issuer },
1290 { US"signature", 9, &tls_cert_signature },
1291 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1292 { US"subj_altname", 12, &tls_cert_subject_altname },
1293 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1294 { US"crl_uri", 7, &tls_cert_crl_uri },
1298 expand_getcertele(uschar * field, uschar * certvar)
1303 if (!(vp = find_var_ent(certvar)))
1305 expand_string_message =
1306 string_sprintf("no variable named \"%s\"", certvar);
1307 return NULL; /* Unknown variable name */
1309 /* NB this stops us passing certs around in variable. Might
1310 want to do that in future */
1311 if (vp->type != vtype_cert)
1313 expand_string_message =
1314 string_sprintf("\"%s\" is not a certificate", certvar);
1315 return NULL; /* Unknown variable name */
1317 if (!*(void **)vp->value)
1320 if (*field >= '0' && *field <= '9')
1321 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1323 for(cp = certfields;
1324 cp < certfields + nelem(certfields);
1326 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1328 uschar * modifier = *(field += cp->namelen) == ','
1330 return (*cp->getfn)( *(void **)vp->value, modifier );
1333 expand_string_message =
1334 string_sprintf("bad field selector \"%s\" for certextract", field);
1337 #endif /*SUPPORT_TLS*/
1339 /*************************************************
1340 * Extract a substring from a string *
1341 *************************************************/
1343 /* Perform the ${substr or ${length expansion operations.
1346 subject the input string
1347 value1 the offset from the start of the input string to the start of
1348 the output string; if negative, count from the right.
1349 value2 the length of the output string, or negative (-1) for unset
1350 if value1 is positive, unset means "all after"
1351 if value1 is negative, unset means "all before"
1352 len set to the length of the returned string
1354 Returns: pointer to the output string, or NULL if there is an error
1358 extract_substr(uschar *subject, int value1, int value2, int *len)
1360 int sublen = Ustrlen(subject);
1362 if (value1 < 0) /* count from right */
1366 /* If the position is before the start, skip to the start, and adjust the
1367 length. If the length ends up negative, the substring is null because nothing
1368 can precede. This falls out naturally when the length is unset, meaning "all
1374 if (value2 < 0) value2 = 0;
1378 /* Otherwise an unset length => characters before value1 */
1380 else if (value2 < 0)
1387 /* For a non-negative offset, if the starting position is past the end of the
1388 string, the result will be the null string. Otherwise, an unset length means
1389 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1393 if (value1 > sublen)
1398 else if (value2 < 0) value2 = sublen;
1401 /* Cut the length down to the maximum possible for the offset value, and get
1402 the required characters. */
1404 if (value1 + value2 > sublen) value2 = sublen - value1;
1406 return subject + value1;
1412 /*************************************************
1413 * Old-style hash of a string *
1414 *************************************************/
1416 /* Perform the ${hash expansion operation.
1419 subject the input string (an expanded substring)
1420 value1 the length of the output string; if greater or equal to the
1421 length of the input string, the input string is returned
1422 value2 the number of hash characters to use, or 26 if negative
1423 len set to the length of the returned string
1425 Returns: pointer to the output string, or NULL if there is an error
1429 compute_hash(uschar *subject, int value1, int value2, int *len)
1431 int sublen = Ustrlen(subject);
1433 if (value2 < 0) value2 = 26;
1434 else if (value2 > Ustrlen(hashcodes))
1436 expand_string_message =
1437 string_sprintf("hash count \"%d\" too big", value2);
1441 /* Calculate the hash text. We know it is shorter than the original string, so
1442 can safely place it in subject[] (we know that subject is always itself an
1443 expanded substring). */
1445 if (value1 < sublen)
1450 while ((c = (subject[j])) != 0)
1452 int shift = (c + j++) & 7;
1453 subject[i] ^= (c << shift) | (c >> (8-shift));
1454 if (++i >= value1) i = 0;
1456 for (i = 0; i < value1; i++)
1457 subject[i] = hashcodes[(subject[i]) % value2];
1459 else value1 = sublen;
1468 /*************************************************
1469 * Numeric hash of a string *
1470 *************************************************/
1472 /* Perform the ${nhash expansion operation. The first characters of the
1473 string are treated as most important, and get the highest prime numbers.
1476 subject the input string
1477 value1 the maximum value of the first part of the result
1478 value2 the maximum value of the second part of the result,
1479 or negative to produce only a one-part result
1480 len set to the length of the returned string
1482 Returns: pointer to the output string, or NULL if there is an error.
1486 compute_nhash (uschar *subject, int value1, int value2, int *len)
1488 uschar *s = subject;
1490 unsigned long int total = 0; /* no overflow */
1494 if (i == 0) i = nelem(prime) - 1;
1495 total += prime[i--] * (unsigned int)(*s++);
1498 /* If value2 is unset, just compute one number */
1501 s = string_sprintf("%lu", total % value1);
1503 /* Otherwise do a div/mod hash */
1507 total = total % (value1 * value2);
1508 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1519 /*************************************************
1520 * Find the value of a header or headers *
1521 *************************************************/
1523 /* Multiple instances of the same header get concatenated, and this function
1524 can also return a concatenation of all the header lines. When concatenating
1525 specific headers that contain lists of addresses, a comma is inserted between
1526 them. Otherwise we use a straight concatenation. Because some messages can have
1527 pathologically large number of lines, there is a limit on the length that is
1531 name the name of the header, without the leading $header_ or $h_,
1532 or NULL if a concatenation of all headers is required
1533 newsize return the size of memory block that was obtained; may be NULL
1534 if exists_only is TRUE
1535 flags FH_EXISTS_ONLY
1536 set if called from a def: test; don't need to build a string;
1537 just return a string that is not "" and not "0" if the header
1540 set if called for $rh_ or $rheader_ items; no processing,
1541 other than concatenating, will be done on the header. Also used
1542 for $message_headers_raw.
1544 Double colon chars in the content, and replace newline with
1545 colon between each element when concatenating; returning a
1546 colon-sep list (elements might contain newlines)
1547 charset name of charset to translate MIME words to; used only if
1548 want_raw is false; if NULL, no translation is done (this is
1549 used for $bh_ and $bheader_)
1551 Returns: NULL if the header does not exist, else a pointer to a new
1556 find_header(uschar *name, int *newsize, unsigned flags, uschar *charset)
1559 int len = name ? Ustrlen(name) : 0;
1564 for (h = header_list; 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 (flags & FH_EXISTS_ONLY)
1572 return US"1"; /* don't need actual string */
1575 s = h->text + len; /* text to insert */
1576 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */
1577 while (isspace(*s)) s++; /* remove leading white space */
1578 t = h->text + h->slen; /* end-point */
1580 /* Unless wanted raw, remove trailing whitespace, including the
1583 if (flags & FH_WANT_LIST)
1584 while (t > s && t[-1] == '\n') t--;
1585 else if (!(flags & FH_WANT_RAW))
1587 while (t > s && isspace(t[-1])) t--;
1589 /* Set comma if handling a single header and it's one of those
1590 that contains an address list, except when asked for raw headers. Only
1591 need to do this once. */
1593 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1596 /* Trim the header roughly if we're approaching limits */
1598 if ((g ? g->ptr : 0) + inc > header_insert_maxlen)
1599 inc = header_insert_maxlen - (g ? g->ptr : 0);
1601 /* For raw just copy the data; for a list, add the data as a colon-sep
1602 list-element; for comma-list add as an unchecked comma,newline sep
1603 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1604 stripped trailing WS above including the newline). We ignore the potential
1605 expansion due to colon-doubling, just leaving the loop if the limit is met
1608 if (flags & FH_WANT_LIST)
1609 g = string_append_listele_n(g, ':', s, (unsigned)inc);
1610 else if (flags & FH_WANT_RAW)
1612 g = string_catn(g, s, (unsigned)inc);
1613 (void) string_from_gstring(g);
1617 g = string_append2_listele_n(g, US",\n", s, (unsigned)inc);
1619 g = string_append2_listele_n(g, US"\n", s, (unsigned)inc);
1621 if (g && g->ptr >= header_insert_maxlen) break;
1624 if (!found) return NULL; /* No header found */
1625 if (!g) return US"";
1627 /* That's all we do for raw header expansion. */
1630 if (flags & FH_WANT_RAW)
1633 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1634 The rfc2047_decode2() function can return an error with decoded data if the
1635 charset translation fails. If decoding fails, it returns NULL. */
1639 uschar *decoded, *error;
1641 decoded = rfc2047_decode2(g->s, check_rfc2047_length, charset, '?', NULL,
1645 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1646 " input was: %s\n", error, g->s);
1648 return decoded ? decoded : g->s;
1655 /* Append a "local" element to an Authentication-Results: header
1656 if this was a non-smtp message.
1660 authres_local(gstring * g, const uschar * sysname)
1662 if (!authentication_local)
1664 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1665 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1670 /* Append an "iprev" element to an Authentication-Results: header
1671 if we have attempted to get the calling host's name.
1675 authres_iprev(gstring * g)
1677 if (sender_host_name)
1678 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1679 else if (host_lookup_deferred)
1680 g = string_catn(g, US";\n\tiprev=temperror", 19);
1681 else if (host_lookup_failed)
1682 g = string_catn(g, US";\n\tiprev=fail", 13);
1686 if (sender_host_address)
1687 g = string_append(g, 2, US" smtp.client-ip=", sender_host_address);
1693 /*************************************************
1694 * Return list of recipients *
1695 *************************************************/
1696 /* A recipients list is available only during system message filtering,
1697 during ACL processing after DATA, and while expanding pipe commands
1698 generated from a system filter, but not elsewhere. */
1707 if (!enable_dollar_recipients) return NULL;
1709 for (i = 0; i < recipients_count; i++)
1711 s = recipients_list[i].address;
1712 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1714 return g ? g->s : NULL;
1718 /*************************************************
1719 * Find value of a variable *
1720 *************************************************/
1722 /* The table of variables is kept in alphabetic order, so we can search it
1723 using a binary chop. The "choplen" variable is nothing to do with the binary
1727 name the name of the variable being sought
1728 exists_only TRUE if this is a def: test; passed on to find_header()
1729 skipping TRUE => skip any processing evaluation; this is not the same as
1730 exists_only because def: may test for values that are first
1732 newsize pointer to an int which is initially zero; if the answer is in
1733 a new memory buffer, *newsize is set to its size
1735 Returns: NULL if the variable does not exist, or
1736 a pointer to the variable's contents, or
1737 something non-NULL if exists_only is TRUE
1741 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1748 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1749 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1750 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1751 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1752 (this gave backwards compatibility at the changeover). There may be built-in
1753 variables whose names start acl_ but they should never start in this way. This
1754 slightly messy specification is a consequence of the history, needless to say.
1756 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1757 set, in which case give an error. */
1759 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1763 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1764 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1767 /* Handle $auth<n> variables. */
1769 if (Ustrncmp(name, "auth", 4) == 0)
1772 int n = Ustrtoul(name + 4, &endptr, 10);
1773 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1774 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1776 else if (Ustrncmp(name, "regex", 5) == 0)
1779 int n = Ustrtoul(name + 5, &endptr, 10);
1780 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1781 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1784 /* For all other variables, search the table */
1786 if (!(vp = find_var_ent(name)))
1787 return NULL; /* Unknown variable name */
1789 /* Found an existing variable. If in skipping state, the value isn't needed,
1790 and we want to avoid processing (such as looking up the host name). */
1798 case vtype_filter_int:
1799 if (!filter_running) return NULL;
1803 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1807 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1811 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1815 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1819 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1822 case vtype_stringptr: /* Pointer to string */
1823 return (s = *((uschar **)(val))) ? s : US"";
1826 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1829 case vtype_load_avg:
1830 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1833 case vtype_host_lookup: /* Lookup if not done so */
1834 if ( !sender_host_name && sender_host_address
1835 && !host_lookup_failed && host_name_lookup() == OK)
1836 host_build_sender_fullhost();
1837 return sender_host_name ? sender_host_name : US"";
1839 case vtype_localpart: /* Get local part from address */
1840 s = *((uschar **)(val));
1841 if (s == NULL) return US"";
1842 domain = Ustrrchr(s, '@');
1843 if (domain == NULL) return s;
1844 if (domain - s > sizeof(var_buffer) - 1)
1845 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1846 " in string expansion", sizeof(var_buffer));
1847 Ustrncpy(var_buffer, s, domain - s);
1848 var_buffer[domain - s] = 0;
1851 case vtype_domain: /* Get domain from address */
1852 s = *((uschar **)(val));
1853 if (s == NULL) return US"";
1854 domain = Ustrrchr(s, '@');
1855 return (domain == NULL)? US"" : domain + 1;
1857 case vtype_msgheaders:
1858 return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
1860 case vtype_msgheaders_raw:
1861 return find_header(NULL, newsize,
1862 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
1864 case vtype_msgbody: /* Pointer to msgbody string */
1865 case vtype_msgbody_end: /* Ditto, the end of the msg */
1866 ss = (uschar **)(val);
1867 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1870 off_t start_offset = SPOOL_DATA_START_OFFSET;
1871 int len = message_body_visible;
1872 if (len > message_size) len = message_size;
1873 *ss = body = store_malloc(len+1);
1875 if (vp->type == vtype_msgbody_end)
1877 struct stat statbuf;
1878 if (fstat(deliver_datafile, &statbuf) == 0)
1880 start_offset = statbuf.st_size - len;
1881 if (start_offset < SPOOL_DATA_START_OFFSET)
1882 start_offset = SPOOL_DATA_START_OFFSET;
1885 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1886 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1888 len = read(deliver_datafile, body, len);
1892 if (message_body_newlines) /* Separate loops for efficiency */
1894 { if (body[--len] == 0) body[len] = ' '; }
1897 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1900 return *ss ? *ss : US"";
1902 case vtype_todbsdin: /* BSD inbox time of day */
1903 return tod_stamp(tod_bsdin);
1905 case vtype_tode: /* Unix epoch time of day */
1906 return tod_stamp(tod_epoch);
1908 case vtype_todel: /* Unix epoch/usec time of day */
1909 return tod_stamp(tod_epoch_l);
1911 case vtype_todf: /* Full time of day */
1912 return tod_stamp(tod_full);
1914 case vtype_todl: /* Log format time of day */
1915 return tod_stamp(tod_log_bare); /* (without timezone) */
1917 case vtype_todzone: /* Time zone offset only */
1918 return tod_stamp(tod_zone);
1920 case vtype_todzulu: /* Zulu time */
1921 return tod_stamp(tod_zulu);
1923 case vtype_todlf: /* Log file datestamp tod */
1924 return tod_stamp(tod_log_datestamp_daily);
1926 case vtype_reply: /* Get reply address */
1927 s = find_header(US"reply-to:", newsize,
1928 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
1930 if (s) while (isspace(*s)) s++;
1933 *newsize = 0; /* For the *s==0 case */
1934 s = find_header(US"from:", newsize,
1935 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
1941 while (isspace(*s)) s++;
1942 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1943 while (t > s && isspace(t[-1])) t--;
1946 return s ? s : US"";
1948 case vtype_string_func:
1950 uschar * (*fn)() = val;
1957 sprintf(CS var_buffer, "%d",
1958 receive_statvfs(val == (void *)TRUE, &inodes));
1965 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1966 sprintf(CS var_buffer, "%d", inodes);
1971 return *(void **)val ? US"<cert>" : US"";
1973 #ifndef DISABLE_DKIM
1975 return dkim_exim_expand_query((int)(long)val);
1980 return NULL; /* Unknown variable. Silences static checkers. */
1987 modify_variable(uschar *name, void * value)
1990 if ((vp = find_var_ent(name))) vp->value = value;
1991 return; /* Unknown variable name, fail silently */
1999 /*************************************************
2000 * Read and expand substrings *
2001 *************************************************/
2003 /* This function is called to read and expand argument substrings for various
2004 expansion items. Some have a minimum requirement that is less than the maximum;
2005 in these cases, the first non-present one is set to NULL.
2008 sub points to vector of pointers to set
2009 n maximum number of substrings
2011 sptr points to current string pointer
2012 skipping the skipping flag
2013 check_end if TRUE, check for final '}'
2014 name name of item, for error message
2015 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2018 Returns: 0 OK; string pointer updated
2019 1 curly bracketing error (too few arguments)
2020 2 too many arguments (only if check_end is set); message set
2021 3 other error (expansion failure)
2025 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
2026 BOOL check_end, uschar *name, BOOL *resetok)
2029 const uschar *s = *sptr;
2031 while (isspace(*s)) s++;
2032 for (i = 0; i < n; i++)
2038 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2039 "(min is %d)", name, m);
2045 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2047 if (*s++ != '}') return 1;
2048 while (isspace(*s)) s++;
2050 if (check_end && *s++ != '}')
2054 expand_string_message = string_sprintf("Too many arguments for '%s' "
2055 "(max is %d)", name, n);
2058 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2069 /*************************************************
2070 * Elaborate message for bad variable *
2071 *************************************************/
2073 /* For the "unknown variable" message, take a look at the variable's name, and
2074 give additional information about possible ACL variables. The extra information
2075 is added on to expand_string_message.
2077 Argument: the name of the variable
2082 check_variable_error_message(uschar *name)
2084 if (Ustrncmp(name, "acl_", 4) == 0)
2085 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2086 (name[4] == 'c' || name[4] == 'm')?
2088 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2089 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2091 US"user-defined ACL variables must start acl_c or acl_m");
2097 Load args from sub array to globals, and call acl_check().
2098 Sub array will be corrupted on return.
2100 Returns: OK access is granted by an ACCEPT verb
2101 DISCARD access is (apparently) granted by a DISCARD verb
2102 FAIL access is denied
2103 FAIL_DROP access is denied; drop the connection
2104 DEFER can't tell at the moment
2108 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2111 int sav_narg = acl_narg;
2113 uschar * dummy_logmsg;
2114 extern int acl_where;
2116 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2117 for (i = 0; i < nsub && sub[i+1]; i++)
2119 uschar * tmp = acl_arg[i];
2120 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2121 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2126 sub[i+1] = acl_arg[i];
2127 acl_arg[i++] = NULL;
2131 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2133 acl_narg>0 ? acl_arg[0] : US"<none>",
2134 acl_narg>1 ? " +more" : "");
2136 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2138 for (i = 0; i < nsub; i++)
2139 acl_arg[i] = sub[i+1]; /* restore old args */
2140 acl_narg = sav_narg;
2148 /*************************************************
2149 * Read and evaluate a condition *
2150 *************************************************/
2154 s points to the start of the condition text
2155 resetok points to a BOOL which is written false if it is unsafe to
2156 free memory. Certain condition types (acl) may have side-effect
2157 allocation which must be preserved.
2158 yield points to a BOOL to hold the result of the condition test;
2159 if NULL, we are just reading through a condition that is
2160 part of an "or" combination to check syntax, or in a state
2161 where the answer isn't required
2163 Returns: a pointer to the first character after the condition, or
2167 static const uschar *
2168 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2170 BOOL testfor = TRUE;
2171 BOOL tempcond, combined_cond;
2173 BOOL sub2_honour_dollar = TRUE;
2174 int i, rc, cond_type, roffset;
2175 int_eximarith_t num[2];
2176 struct stat statbuf;
2178 const uschar *sub[10];
2181 const uschar *rerror;
2185 while (isspace(*s)) s++;
2186 if (*s == '!') { testfor = !testfor; s++; } else break;
2189 /* Numeric comparisons are symbolic */
2191 if (*s == '=' || *s == '>' || *s == '<')
2203 /* All other conditions are named */
2205 else s = read_name(name, 256, s, US"_");
2207 /* If we haven't read a name, it means some non-alpha character is first. */
2211 expand_string_message = string_sprintf("condition name expected, "
2212 "but found \"%.16s\"", s);
2216 /* Find which condition we are dealing with, and switch on it */
2218 cond_type = chop_match(name, cond_table, nelem(cond_table));
2221 /* def: tests for a non-empty variable, or for the existence of a header. If
2222 yield == NULL we are in a skipping state, and don't care about the answer. */
2230 expand_string_message = US"\":\" expected after \"def\"";
2234 s = read_name(name, 256, s+1, US"_");
2236 /* Test for a header's existence. If the name contains a closing brace
2237 character, this may be a user error where the terminating colon has been
2238 omitted. Set a flag to adjust a subsequent error message in this case. */
2240 if ( ( *(t = name) == 'h'
2241 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2243 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2246 s = read_header_name(name, 256, s);
2247 /* {-for-text-editors */
2248 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2250 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2253 /* Test for a variable's having a non-empty value. A non-existent variable
2254 causes an expansion failure. */
2258 if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2260 expand_string_message = (name[0] == 0)?
2261 string_sprintf("variable name omitted after \"def:\"") :
2262 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2263 check_variable_error_message(name);
2266 if (yield) *yield = (t[0] != 0) == testfor;
2273 /* first_delivery tests for first delivery attempt */
2275 case ECOND_FIRST_DELIVERY:
2276 if (yield != NULL) *yield = deliver_firsttime == testfor;
2280 /* queue_running tests for any process started by a queue runner */
2282 case ECOND_QUEUE_RUNNING:
2283 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2287 /* exists: tests for file existence
2288 isip: tests for any IP address
2289 isip4: tests for an IPv4 address
2290 isip6: tests for an IPv6 address
2291 pam: does PAM authentication
2292 radius: does RADIUS authentication
2293 ldapauth: does LDAP authentication
2294 pwcheck: does Cyrus SASL pwcheck authentication
2303 case ECOND_LDAPAUTH:
2306 while (isspace(*s)) s++;
2307 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2309 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2310 if (sub[0] == NULL) return NULL;
2311 /* {-for-text-editors */
2312 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2314 if (yield == NULL) return s; /* No need to run the test if skipping */
2319 if ((expand_forbid & RDO_EXISTS) != 0)
2321 expand_string_message = US"File existence tests are not permitted";
2324 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2330 rc = string_is_ip_address(sub[0], NULL);
2331 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2332 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2335 /* Various authentication tests - all optionally compiled */
2339 rc = auth_call_pam(sub[0], &expand_string_message);
2342 goto COND_FAILED_NOT_COMPILED;
2343 #endif /* SUPPORT_PAM */
2346 #ifdef RADIUS_CONFIG_FILE
2347 rc = auth_call_radius(sub[0], &expand_string_message);
2350 goto COND_FAILED_NOT_COMPILED;
2351 #endif /* RADIUS_CONFIG_FILE */
2353 case ECOND_LDAPAUTH:
2356 /* Just to keep the interface the same */
2358 int old_pool = store_pool;
2359 store_pool = POOL_SEARCH;
2360 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2361 &expand_string_message, &do_cache);
2362 store_pool = old_pool;
2366 goto COND_FAILED_NOT_COMPILED;
2367 #endif /* LOOKUP_LDAP */
2370 #ifdef CYRUS_PWCHECK_SOCKET
2371 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2374 goto COND_FAILED_NOT_COMPILED;
2375 #endif /* CYRUS_PWCHECK_SOCKET */
2377 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2378 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2380 if (rc == ERROR || rc == DEFER) return NULL;
2381 *yield = (rc == OK) == testfor;
2387 /* call ACL (in a conditional context). Accept true, deny false.
2388 Defer is a forced-fail. Anything set by message= goes to $value.
2389 Up to ten parameters are used; we use the braces round the name+args
2390 like the saslauthd condition does, to permit a variable number of args.
2391 See also the expansion-item version EITEM_ACL and the traditional
2392 acl modifier ACLC_ACL.
2393 Since the ACL may allocate new global variables, tell our caller to not
2398 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2404 while (isspace(*s)) s++;
2405 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2407 switch(read_subs(sub, nelem(sub), 1,
2408 &s, yield == NULL, TRUE, US"acl", resetok))
2410 case 1: expand_string_message = US"too few arguments or bracketing "
2413 case 3: return NULL;
2418 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2419 switch(eval_acl(sub, nelem(sub), &user_msg))
2424 lookup_value = NULL;
2426 lookup_value = string_copy(user_msg);
2427 *yield = cond == testfor;
2431 expand_string_forcedfail = TRUE;
2434 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2442 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2444 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2446 However, the last two are optional. That is why the whole set is enclosed
2447 in their own set of braces. */
2449 case ECOND_SASLAUTHD:
2450 #ifndef CYRUS_SASLAUTHD_SOCKET
2451 goto COND_FAILED_NOT_COMPILED;
2455 while (isspace(*s)) s++;
2456 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2457 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2460 case 1: expand_string_message = US"too few arguments or bracketing "
2461 "error for saslauthd";
2463 case 3: return NULL;
2465 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2468 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2469 &expand_string_message);
2470 if (rc == ERROR || rc == DEFER) return NULL;
2471 *yield = (rc == OK) == testfor;
2475 #endif /* CYRUS_SASLAUTHD_SOCKET */
2478 /* symbolic operators for numeric and string comparison, and a number of
2479 other operators, all requiring two arguments.
2481 crypteq: encrypts plaintext and compares against an encrypted text,
2482 using crypt(), crypt16(), MD5 or SHA-1
2483 inlist/inlisti: checks if first argument is in the list of the second
2484 match: does a regular expression match and sets up the numerical
2485 variables if it succeeds
2486 match_address: matches in an address list
2487 match_domain: matches in a domain list
2488 match_ip: matches a host list that is restricted to IP addresses
2489 match_local_part: matches in a local part list
2492 case ECOND_MATCH_ADDRESS:
2493 case ECOND_MATCH_DOMAIN:
2494 case ECOND_MATCH_IP:
2495 case ECOND_MATCH_LOCAL_PART:
2496 #ifndef EXPAND_LISTMATCH_RHS
2497 sub2_honour_dollar = FALSE;
2506 case ECOND_NUM_L: /* Numerical comparisons */
2513 case ECOND_STR_LT: /* String comparisons */
2524 for (i = 0; i < 2; i++)
2526 /* Sometimes, we don't expand substrings; too many insecure configurations
2527 created using match_address{}{} and friends, where the second param
2528 includes information from untrustworthy sources. */
2529 BOOL honour_dollar = TRUE;
2530 if ((i > 0) && !sub2_honour_dollar)
2531 honour_dollar = FALSE;
2533 while (isspace(*s)) s++;
2536 if (i == 0) goto COND_FAILED_CURLY_START;
2537 expand_string_message = string_sprintf("missing 2nd string in {} "
2538 "after \"%s\"", name);
2541 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2542 honour_dollar, resetok)))
2544 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2545 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2546 " for security reasons\n");
2547 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2549 /* Convert to numerical if required; we know that the names of all the
2550 conditions that compare numbers do not start with a letter. This just saves
2551 checking for them individually. */
2553 if (!isalpha(name[0]) && yield != NULL)
2558 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2562 num[i] = expanded_string_integer(sub[i], FALSE);
2563 if (expand_string_message != NULL) return NULL;
2567 /* Result not required */
2569 if (yield == NULL) return s;
2571 /* Do an appropriate comparison */
2577 tempcond = (num[0] == num[1]);
2581 tempcond = (num[0] > num[1]);
2585 tempcond = (num[0] >= num[1]);
2589 tempcond = (num[0] < num[1]);
2593 tempcond = (num[0] <= num[1]);
2597 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2601 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2605 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2609 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2613 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2617 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2621 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2625 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2629 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2633 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2636 case ECOND_MATCH: /* Regular expression match */
2637 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2641 expand_string_message = string_sprintf("regular expression error in "
2642 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2645 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2648 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2649 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2650 goto MATCHED_SOMETHING;
2652 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2653 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2654 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2655 goto MATCHED_SOMETHING;
2657 case ECOND_MATCH_IP: /* Match IP address in a host list */
2658 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2660 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2666 unsigned int *nullcache = NULL;
2667 check_host_block cb;
2669 cb.host_name = US"";
2670 cb.host_address = sub[0];
2672 /* If the host address starts off ::ffff: it is an IPv6 address in
2673 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2676 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2677 cb.host_address + 7 : cb.host_address;
2679 rc = match_check_list(
2680 &sub[1], /* the list */
2681 0, /* separator character */
2682 &hostlist_anchor, /* anchor pointer */
2683 &nullcache, /* cache pointer */
2684 check_host, /* function for testing */
2685 &cb, /* argument for function */
2686 MCL_HOST, /* type of check */
2687 sub[0], /* text for debugging */
2688 NULL); /* where to pass back data */
2690 goto MATCHED_SOMETHING;
2692 case ECOND_MATCH_LOCAL_PART:
2693 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2694 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2709 expand_string_message = string_sprintf("unable to complete match "
2710 "against \"%s\": %s", sub[1], search_error_message);
2716 /* Various "encrypted" comparisons. If the second string starts with
2717 "{" then an encryption type is given. Default to crypt() or crypt16()
2718 (build-time choice). */
2719 /* }-for-text-editors */
2722 #ifndef SUPPORT_CRYPTEQ
2723 goto COND_FAILED_NOT_COMPILED;
2725 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2727 int sublen = Ustrlen(sub[1]+5);
2732 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2734 /* If the length that we are comparing against is 24, the MD5 digest
2735 is expressed as a base64 string. This is the way LDAP does it. However,
2736 some other software uses a straightforward hex representation. We assume
2737 this if the length is 32. Other lengths fail. */
2741 uschar *coded = b64encode(digest, 16);
2742 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2743 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2744 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2746 else if (sublen == 32)
2750 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2752 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2753 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2754 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2758 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2759 "fail\n crypted=%s\n", sub[1]+5);
2764 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2766 int sublen = Ustrlen(sub[1]+6);
2771 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2773 /* If the length that we are comparing against is 28, assume the SHA1
2774 digest is expressed as a base64 string. If the length is 40, assume a
2775 straightforward hex representation. Other lengths fail. */
2779 uschar *coded = b64encode(digest, 20);
2780 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2781 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2782 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2784 else if (sublen == 40)
2788 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2790 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2791 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2792 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2796 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2797 "fail\n crypted=%s\n", sub[1]+6);
2802 else /* {crypt} or {crypt16} and non-{ at start */
2803 /* }-for-text-editors */
2808 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2813 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2818 else if (sub[1][0] == '{') /* }-for-text-editors */
2820 expand_string_message = string_sprintf("unknown encryption mechanism "
2821 "in \"%s\"", sub[1]);
2827 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2828 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2829 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2833 #define XSTR(s) STR(s)
2834 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2835 " subject=%s\n crypted=%s\n",
2836 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2841 /* If the encrypted string contains fewer than two characters (for the
2842 salt), force failure. Otherwise we get false positives: with an empty
2843 string the yield of crypt() is an empty string! */
2846 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2847 else if (errno == EINVAL)
2851 expand_string_message = string_sprintf("crypt error: %s\n",
2852 US strerror(errno));
2857 #endif /* SUPPORT_CRYPTEQ */
2862 const uschar * list = sub[1];
2864 uschar *save_iterate_item = iterate_item;
2865 int (*compare)(const uschar *, const uschar *);
2867 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", name, sub[0]);
2870 compare = cond_type == ECOND_INLISTI
2871 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2873 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2875 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
2876 if (compare(sub[0], iterate_item) == 0)
2882 iterate_item = save_iterate_item;
2885 } /* Switch for comparison conditions */
2887 *yield = tempcond == testfor;
2888 return s; /* End of comparison conditions */
2891 /* and/or: computes logical and/or of several conditions */
2895 subcondptr = (yield == NULL)? NULL : &tempcond;
2896 combined_cond = (cond_type == ECOND_AND);
2898 while (isspace(*s)) s++;
2899 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2903 while (isspace(*s)) s++;
2904 /* {-for-text-editors */
2905 if (*s == '}') break;
2906 if (*s != '{') /* }-for-text-editors */
2908 expand_string_message = string_sprintf("each subcondition "
2909 "inside an \"%s{...}\" condition must be in its own {}", name);
2913 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2915 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2916 expand_string_message, name);
2919 while (isspace(*s)) s++;
2921 /* {-for-text-editors */
2924 /* {-for-text-editors */
2925 expand_string_message = string_sprintf("missing } at end of condition "
2926 "inside \"%s\" group", name);
2932 if (cond_type == ECOND_AND)
2934 combined_cond &= tempcond;
2935 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2936 } /* evaluate any more */
2939 combined_cond |= tempcond;
2940 if (combined_cond) subcondptr = NULL; /* once true, don't */
2941 } /* evaluate any more */
2945 if (yield != NULL) *yield = (combined_cond == testfor);
2949 /* forall/forany: iterates a condition with different values */
2954 const uschar * list;
2956 uschar *save_iterate_item = iterate_item;
2958 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2960 while (isspace(*s)) s++;
2961 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2962 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2963 if (sub[0] == NULL) return NULL;
2964 /* {-for-text-editors */
2965 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2967 while (isspace(*s)) s++;
2968 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2972 /* Call eval_condition once, with result discarded (as if scanning a
2973 "false" part). This allows us to find the end of the condition, because if
2974 the list it empty, we won't actually evaluate the condition for real. */
2976 if (!(s = eval_condition(sub[1], resetok, NULL)))
2978 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2979 expand_string_message, name);
2982 while (isspace(*s)) s++;
2984 /* {-for-text-editors */
2987 /* {-for-text-editors */
2988 expand_string_message = string_sprintf("missing } at end of condition "
2989 "inside \"%s\"", name);
2993 if (yield != NULL) *yield = !testfor;
2995 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2997 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, iterate_item);
2998 if (!eval_condition(sub[1], resetok, &tempcond))
3000 expand_string_message = string_sprintf("%s inside \"%s\" condition",
3001 expand_string_message, name);
3002 iterate_item = save_iterate_item;
3005 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", name,
3006 tempcond? "true":"false");
3008 if (yield != NULL) *yield = (tempcond == testfor);
3009 if (tempcond == (cond_type == ECOND_FORANY)) break;
3012 iterate_item = save_iterate_item;
3017 /* The bool{} expansion condition maps a string to boolean.
3018 The values supported should match those supported by the ACL condition
3019 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3020 of true/false. Note that Router "condition" rules have a different
3021 interpretation, where general data can be used and only a few values
3023 Note that readconf.c boolean matching, for boolean configuration options,
3024 only matches true/yes/false/no.
3025 The bool_lax{} condition matches the Router logic, which is much more
3028 case ECOND_BOOL_LAX:
3034 BOOL boolvalue = FALSE;
3035 while (isspace(*s)) s++;
3036 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3037 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3038 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3040 case 1: expand_string_message = string_sprintf(
3041 "too few arguments or bracketing error for %s",
3045 case 3: return NULL;
3048 while (isspace(*t)) t++;
3052 /* trailing whitespace: seems like a good idea to ignore it too */
3054 while (isspace(*t2)) t2--;
3055 if (t2 != (t + len))
3062 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3063 /* logic for the lax case from expand_check_condition(), which also does
3064 expands, and the logic is both short and stable enough that there should
3065 be no maintenance burden from replicating it. */
3069 ? Ustrspn(t+1, "0123456789") == len-1
3070 : Ustrspn(t, "0123456789") == len)
3072 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3073 /* expand_check_condition only does a literal string "0" check */
3074 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3077 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3079 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3081 else if (cond_type == ECOND_BOOL_LAX)
3085 expand_string_message = string_sprintf("unrecognised boolean "
3089 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3090 boolvalue? "true":"false");
3091 if (yield != NULL) *yield = (boolvalue == testfor);
3095 /* Unknown condition */
3098 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3100 } /* End switch on condition type */
3102 /* Missing braces at start and end of data */
3104 COND_FAILED_CURLY_START:
3105 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3108 COND_FAILED_CURLY_END:
3109 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3113 /* A condition requires code that is not compiled */
3115 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3116 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3117 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3118 COND_FAILED_NOT_COMPILED:
3119 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3128 /*************************************************
3129 * Save numerical variables *
3130 *************************************************/
3132 /* This function is called from items such as "if" that want to preserve and
3133 restore the numbered variables.
3136 save_expand_string points to an array of pointers to set
3137 save_expand_nlength points to an array of ints for the lengths
3139 Returns: the value of expand max to save
3143 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3146 for (i = 0; i <= expand_nmax; i++)
3148 save_expand_nstring[i] = expand_nstring[i];
3149 save_expand_nlength[i] = expand_nlength[i];
3156 /*************************************************
3157 * Restore numerical variables *
3158 *************************************************/
3160 /* This function restored saved values of numerical strings.
3163 save_expand_nmax the number of strings to restore
3164 save_expand_string points to an array of pointers
3165 save_expand_nlength points to an array of ints
3171 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3172 int *save_expand_nlength)
3175 expand_nmax = save_expand_nmax;
3176 for (i = 0; i <= expand_nmax; i++)
3178 expand_nstring[i] = save_expand_nstring[i];
3179 expand_nlength[i] = save_expand_nlength[i];
3187 /*************************************************
3188 * Handle yes/no substrings *
3189 *************************************************/
3191 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3192 alternative substrings that depend on whether or not the condition was true,
3193 or the lookup or extraction succeeded. The substrings always have to be
3194 expanded, to check their syntax, but "skipping" is set when the result is not
3195 needed - this avoids unnecessary nested lookups.
3198 skipping TRUE if we were skipping when this item was reached
3199 yes TRUE if the first string is to be used, else use the second
3200 save_lookup a value to put back into lookup_value before the 2nd expansion
3201 sptr points to the input string pointer
3202 yieldptr points to the output growable-string pointer
3203 type "lookup", "if", "extract", "run", "env", "listextract" or
3204 "certextract" for error message
3205 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3208 Returns: 0 OK; lookup_value has been reset to save_lookup
3210 2 expansion failed because of bracketing error
3214 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3215 gstring ** yieldptr, uschar *type, BOOL *resetok)
3218 const uschar *s = *sptr; /* Local value */
3219 uschar *sub1, *sub2;
3220 const uschar * errwhere;
3222 /* If there are no following strings, we substitute the contents of $value for
3223 lookups and for extractions in the success case. For the ${if item, the string
3224 "true" is substituted. In the fail case, nothing is substituted for all three
3227 while (isspace(*s)) s++;
3232 if (yes && !skipping)
3233 *yieldptr = string_catn(*yieldptr, US"true", 4);
3237 if (yes && lookup_value && !skipping)
3238 *yieldptr = string_cat(*yieldptr, lookup_value);
3239 lookup_value = save_lookup;
3245 /* The first following string must be braced. */
3249 errwhere = US"'yes' part did not start with '{'";
3253 /* Expand the first substring. Forced failures are noticed only if we actually
3254 want this string. Set skipping in the call in the fail case (this will always
3255 be the case if we were already skipping). */
3257 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3258 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3259 expand_string_forcedfail = FALSE;
3262 errwhere = US"'yes' part did not end with '}'";
3266 /* If we want the first string, add it to the output */
3269 *yieldptr = string_cat(*yieldptr, sub1);
3271 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3272 $value to what it was at the start of the item, so that it has this value
3273 during the second string expansion. For the call from "if" or "run" to this
3274 function, save_lookup is set to lookup_value, so that this statement does
3277 lookup_value = save_lookup;
3279 /* There now follows either another substring, or "fail", or nothing. This
3280 time, forced failures are noticed only if we want the second string. We must
3281 set skipping in the nested call if we don't want this string, or if we were
3282 already skipping. */
3284 while (isspace(*s)) s++;
3287 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3288 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3289 expand_string_forcedfail = FALSE;
3292 errwhere = US"'no' part did not start with '{'";
3296 /* If we want the second string, add it to the output */
3299 *yieldptr = string_cat(*yieldptr, sub2);
3302 /* If there is no second string, but the word "fail" is present when the use of
3303 the second string is wanted, set a flag indicating it was a forced failure
3304 rather than a syntactic error. Swallow the terminating } in case this is nested
3305 inside another lookup or if or extract. */
3310 /* deconst cast ok here as source is s anyway */
3311 s = US read_name(name, sizeof(name), s, US"_");
3312 if (Ustrcmp(name, "fail") == 0)
3314 if (!yes && !skipping)
3316 while (isspace(*s)) s++;
3319 errwhere = US"did not close with '}' after forcedfail";
3322 expand_string_message =
3323 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3324 expand_string_forcedfail = TRUE;
3330 expand_string_message =
3331 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3336 /* All we have to do now is to check on the final closing brace. */
3338 while (isspace(*s)) s++;
3341 errwhere = US"did not close with '}'";
3347 /* Update the input pointer value before returning */
3352 /* Get here if there is a bracketing failure */
3353 expand_string_message = string_sprintf(
3354 "curly-bracket problem in conditional yes/no parsing: %s\n"
3355 " remaining string is '%s'", errwhere, --s);
3360 /* Get here for other failures */
3368 /*************************************************
3369 * Handle MD5 or SHA-1 computation for HMAC *
3370 *************************************************/
3372 /* These are some wrapping functions that enable the HMAC code to be a bit
3373 cleaner. A good compiler will spot the tail recursion.
3376 type HMAC_MD5 or HMAC_SHA1
3377 remaining are as for the cryptographic hash functions
3383 chash_start(int type, void *base)
3385 if (type == HMAC_MD5)
3386 md5_start((md5 *)base);
3388 sha1_start((hctx *)base);
3392 chash_mid(int type, void *base, uschar *string)
3394 if (type == HMAC_MD5)
3395 md5_mid((md5 *)base, string);
3397 sha1_mid((hctx *)base, string);
3401 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3403 if (type == HMAC_MD5)
3404 md5_end((md5 *)base, string, length, digest);
3406 sha1_end((hctx *)base, string, length, digest);
3413 /********************************************************
3414 * prvs: Get last three digits of days since Jan 1, 1970 *
3415 ********************************************************/
3417 /* This is needed to implement the "prvs" BATV reverse
3420 Argument: integer "days" offset to add or substract to
3421 or from the current number of days.
3423 Returns: pointer to string containing the last three
3424 digits of the number of days since Jan 1, 1970,
3425 modified by the offset argument, NULL if there
3426 was an error in the conversion.
3431 prvs_daystamp(int day_offset)
3433 uschar *days = store_get(32); /* Need at least 24 for cases */
3434 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3435 (time(NULL) + day_offset*86400)/86400);
3436 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3441 /********************************************************
3442 * prvs: perform HMAC-SHA1 computation of prvs bits *
3443 ********************************************************/
3445 /* This is needed to implement the "prvs" BATV reverse
3449 address RFC2821 Address to use
3450 key The key to use (must be less than 64 characters
3452 key_num Single-digit key number to use. Defaults to
3455 Returns: pointer to string containing the first three
3456 bytes of the final hash in hex format, NULL if
3457 there was an error in the process.
3461 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3463 gstring * hash_source;
3467 uschar innerhash[20];
3468 uschar finalhash[20];
3469 uschar innerkey[64];
3470 uschar outerkey[64];
3471 uschar *finalhash_hex = store_get(40);
3473 if (key_num == NULL)
3476 if (Ustrlen(key) > 64)
3479 hash_source = string_catn(NULL, key_num, 1);
3480 hash_source = string_catn(hash_source, daystamp, 3);
3481 hash_source = string_cat(hash_source, address);
3482 (void) string_from_gstring(hash_source);
3485 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3487 memset(innerkey, 0x36, 64);
3488 memset(outerkey, 0x5c, 64);
3490 for (i = 0; i < Ustrlen(key); i++)
3492 innerkey[i] ^= key[i];
3493 outerkey[i] ^= key[i];
3496 chash_start(HMAC_SHA1, &h);
3497 chash_mid(HMAC_SHA1, &h, innerkey);
3498 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3500 chash_start(HMAC_SHA1, &h);
3501 chash_mid(HMAC_SHA1, &h, outerkey);
3502 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3505 for (i = 0; i < 3; i++)
3507 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3508 *p++ = hex_digits[finalhash[i] & 0x0f];
3512 return finalhash_hex;
3518 /*************************************************
3519 * Join a file onto the output string *
3520 *************************************************/
3522 /* This is used for readfile/readsock and after a run expansion.
3523 It joins the contents of a file onto the output string, globally replacing
3524 newlines with a given string (optionally).
3528 yield pointer to the expandable string struct
3529 eol newline replacement string, or NULL
3531 Returns: new pointer for expandable string, terminated if non-null
3535 cat_file(FILE *f, gstring *yield, uschar *eol)
3537 uschar buffer[1024];
3539 while (Ufgets(buffer, sizeof(buffer), f))
3541 int len = Ustrlen(buffer);
3542 if (eol && buffer[len-1] == '\n') len--;
3543 yield = string_catn(yield, buffer, len);
3544 if (eol && buffer[len])
3545 yield = string_cat(yield, eol);
3548 (void) string_from_gstring(yield);
3555 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
3559 uschar buffer[1024];
3561 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
3562 for (s = buffer; rc--; s++)
3563 yield = eol && *s == '\n'
3564 ? string_cat(yield, eol) : string_catn(yield, s, 1);
3566 /* We assume that all errors, and any returns of zero bytes,
3567 are actually EOF. */
3569 (void) string_from_gstring(yield);
3575 /*************************************************
3576 * Evaluate numeric expression *
3577 *************************************************/
3579 /* This is a set of mutually recursive functions that evaluate an arithmetic
3580 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3581 these functions that is called from elsewhere is eval_expr, whose interface is:
3584 sptr pointer to the pointer to the string - gets updated
3585 decimal TRUE if numbers are to be assumed decimal
3586 error pointer to where to put an error message - must be NULL on input
3587 endket TRUE if ')' must terminate - FALSE for external call
3589 Returns: on success: the value of the expression, with *error still NULL
3590 on failure: an undefined value, with *error = a message
3593 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3596 static int_eximarith_t
3597 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3600 int_eximarith_t x = eval_op_or(&s, decimal, error);
3606 *error = US"expecting closing parenthesis";
3608 while (isspace(*(++s)));
3610 else if (*s != 0) *error = US"expecting operator";
3617 static int_eximarith_t
3618 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3623 while (isspace(*s)) s++;
3628 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3630 switch (tolower(*s))
3633 case 'k': n *= 1024; s++; break;
3634 case 'm': n *= 1024*1024; s++; break;
3635 case 'g': n *= 1024*1024*1024; s++; break;
3637 while (isspace (*s)) s++;
3642 n = eval_expr(&s, decimal, error, 1);
3646 *error = US"expecting number or opening parenthesis";
3654 static int_eximarith_t
3655 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3659 while (isspace(*s)) s++;
3660 if (*s == '+' || *s == '-' || *s == '~')
3663 x = eval_op_unary(&s, decimal, error);
3664 if (op == '-') x = -x;
3665 else if (op == '~') x = ~x;
3669 x = eval_number(&s, decimal, error);
3676 static int_eximarith_t
3677 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3680 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3683 while (*s == '*' || *s == '/' || *s == '%')
3686 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3687 if (*error != NULL) break;
3688 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3689 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3690 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3691 * -N*M is INT_MIN will yield INT_MIN.
3692 * Since we don't support floating point, this is somewhat simpler.
3693 * Ideally, we'd return an error, but since we overflow for all other
3694 * arithmetic, consistency suggests otherwise, but what's the correct value
3695 * to use? There is none.
3696 * The C standard guarantees overflow for unsigned arithmetic but signed
3697 * overflow invokes undefined behaviour; in practice, this is overflow
3698 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3699 * that long/longlong larger than int are available, or we could just work
3700 * with larger types. We should consider whether to guarantee 32bit eval
3701 * and 64-bit working variables, with errors returned. For now ...
3702 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3703 * can just let the other invalid results occur otherwise, as they have
3704 * until now. For this one case, we can coerce.
3706 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3709 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3710 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3720 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3736 static int_eximarith_t
3737 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3740 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3743 while (*s == '+' || *s == '-')
3746 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3748 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3749 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3750 { /* over-conservative check */
3752 ? US"overflow in sum" : US"overflow in difference";
3755 if (op == '+') x += y; else x -= y;
3763 static int_eximarith_t
3764 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3767 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3770 while ((*s == '<' || *s == '>') && s[1] == s[0])
3775 y = eval_op_sum(&s, decimal, error);
3776 if (*error != NULL) break;
3777 if (op == '<') x <<= y; else x >>= y;
3785 static int_eximarith_t
3786 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3789 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3796 y = eval_op_shift(&s, decimal, error);
3797 if (*error != NULL) break;
3806 static int_eximarith_t
3807 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3810 int_eximarith_t x = eval_op_and(&s, decimal, error);
3817 y = eval_op_and(&s, decimal, error);
3818 if (*error != NULL) break;
3827 static int_eximarith_t
3828 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3831 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3838 y = eval_op_xor(&s, decimal, error);
3839 if (*error != NULL) break;
3849 /*************************************************
3851 *************************************************/
3853 /* Returns either an unchanged string, or the expanded string in stacking pool
3854 store. Interpreted sequences are:
3856 \... normal escaping rules
3857 $name substitutes the variable
3859 ${op:string} operates on the expanded string value
3860 ${item{arg1}{arg2}...} expands the args and then does the business
3861 some literal args are not enclosed in {}
3863 There are now far too many operators and item types to make it worth listing
3864 them here in detail any more.
3866 We use an internal routine recursively to handle embedded substrings. The
3867 external function follows. The yield is NULL if the expansion failed, and there
3868 are two cases: if something collapsed syntactically, or if "fail" was given
3869 as the action on a lookup failure. These can be distinguished by looking at the
3870 variable expand_string_forcedfail, which is TRUE in the latter case.
3872 The skipping flag is set true when expanding a substring that isn't actually
3873 going to be used (after "if" or "lookup") and it prevents lookups from
3874 happening lower down.
3876 Store usage: At start, a store block of the length of the input plus 64
3877 is obtained. This is expanded as necessary by string_cat(), which might have to
3878 get a new block, or might be able to expand the original. At the end of the
3879 function we can release any store above that portion of the yield block that
3880 was actually used. In many cases this will be optimal.
3882 However: if the first item in the expansion is a variable name or header name,
3883 we reset the store before processing it; if the result is in fresh store, we
3884 use that without copying. This is helpful for expanding strings like
3885 $message_headers which can get very long.
3887 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3888 since resetting the store at the end of the expansion will free store that was
3889 allocated by the plugin code as well as the slop after the expanded string. So
3890 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3891 and, given the acl condition, ${if }. This is an unfortunate consequence of
3892 string expansion becoming too powerful.
3895 string the string to be expanded
3896 ket_ends true if expansion is to stop at }
3897 left if not NULL, a pointer to the first character after the
3898 expansion is placed here (typically used with ket_ends)
3899 skipping TRUE for recursive calls when the value isn't actually going
3900 to be used (to allow for optimisation)
3901 honour_dollar TRUE if $ is to be expanded,
3902 FALSE if it's just another character
3903 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3906 Returns: NULL if expansion fails:
3907 expand_string_forcedfail is set TRUE if failure was forced
3908 expand_string_message contains a textual error message
3909 a pointer to the expanded string on success
3913 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3914 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3916 gstring * yield = string_get(Ustrlen(string) + 64);
3918 const uschar *s = string;
3919 uschar *save_expand_nstring[EXPAND_MAXN+1];
3920 int save_expand_nlength[EXPAND_MAXN+1];
3921 BOOL resetok = TRUE;
3925 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
3927 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
3931 expand_string_forcedfail = FALSE;
3932 expand_string_message = US"";
3939 /* \ escapes the next character, which must exist, or else
3940 the expansion fails. There's a special escape, \N, which causes
3941 copying of the subject verbatim up to the next \N. Otherwise,
3942 the escapes are the standard set. */
3948 expand_string_message = US"\\ at end of string";
3954 const uschar * t = s + 2;
3955 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3956 yield = string_catn(yield, t, s - t);
3957 if (*s != 0) s += 2;
3963 ch[0] = string_interpret_escape(&s);
3965 yield = string_catn(yield, ch, 1);
3972 /* Anything other than $ is just copied verbatim, unless we are
3973 looking for a terminating } character. */
3976 if (ket_ends && *s == '}') break;
3978 if (*s != '$' || !honour_dollar)
3980 yield = string_catn(yield, s++, 1);
3984 /* No { after the $ - must be a plain name or a number for string
3985 match variable. There has to be a fudge for variables that are the
3986 names of header fields preceded by "$header_" because header field
3987 names can contain any printing characters except space and colon.
3988 For those that don't like typing this much, "$h_" is a synonym for
3989 "$header_". A non-existent header yields a NULL value; nothing is
3992 if (isalpha((*(++s))))
3999 s = read_name(name, sizeof(name), s, US"_");
4001 /* If this is the first thing to be expanded, release the pre-allocated
4005 g = store_get(sizeof(gstring));
4006 else if (yield->ptr == 0)
4008 if (resetok) store_reset(yield);
4010 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
4015 if ( ( *(t = name) == 'h'
4016 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4018 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4021 unsigned flags = *name == 'r' ? FH_WANT_RAW
4022 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4024 uschar * charset = *name == 'b' ? NULL : headers_charset;
4026 s = read_header_name(name, sizeof(name), s);
4027 value = find_header(name, &newsize, flags, charset);
4029 /* If we didn't find the header, and the header contains a closing brace
4030 character, this may be a user error where the terminating colon
4031 has been omitted. Set a flag to adjust the error message in this case.
4032 But there is no error here - nothing gets inserted. */
4036 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
4043 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4045 expand_string_message =
4046 string_sprintf("unknown variable name \"%s\"", name);
4047 check_variable_error_message(name);
4051 /* If the data is known to be in a new buffer, newsize will be set to the
4052 size of that buffer. If this is the first thing in an expansion string,
4053 yield will be NULL; just point it at the new store instead of copying. Many
4054 expansion strings contain just one reference, so this is a useful
4055 optimization, especially for humungous headers. We need to use a gstring
4056 structure that is not allocated after that new-buffer, else a later store
4057 reset in the middle of the buffer will make it inaccessible. */
4059 len = Ustrlen(value);
4060 if (!yield && newsize != 0)
4063 yield->size = newsize;
4068 yield = string_catn(yield, value, len);
4076 s = read_cnumber(&n, s);
4077 if (n >= 0 && n <= expand_nmax)
4078 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4082 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4084 if (*s != '{') /*}*/
4086 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4090 /* After { there can be various things, but they all start with
4091 an initial word, except for a number for a string match variable. */
4093 if (isdigit((*(++s))))
4096 s = read_cnumber(&n, s); /*{*/
4099 expand_string_message = US"} expected after number";
4102 if (n >= 0 && n <= expand_nmax)
4103 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4109 expand_string_message = US"letter or digit expected after ${"; /*}*/
4113 /* Allow "-" in names to cater for substrings with negative
4114 arguments. Since we are checking for known names after { this is
4117 s = read_name(name, sizeof(name), s, US"_-");
4118 item_type = chop_match(name, item_table, nelem(item_table));
4122 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4123 If the ACL returns accept or reject we return content set by "message ="
4124 There is currently no limit on recursion; this would have us call
4125 acl_check_internal() directly and get a current level from somewhere.
4126 See also the acl expansion condition ECOND_ACL and the traditional
4127 acl modifier ACLC_ACL.
4128 Assume that the function has side-effects on the store that must be preserved.
4132 /* ${acl {name} {arg1}{arg2}...} */
4134 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4137 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4140 case 1: goto EXPAND_FAILED_CURLY;
4142 case 3: goto EXPAND_FAILED;
4144 if (skipping) continue;
4147 switch(eval_acl(sub, nelem(sub), &user_msg))
4152 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4154 yield = string_cat(yield, user_msg);
4158 expand_string_forcedfail = TRUE;
4161 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4166 case EITEM_AUTHRESULTS:
4167 /* ${authresults {mysystemname}} */
4171 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4174 case 1: goto EXPAND_FAILED_CURLY;
4176 case 3: goto EXPAND_FAILED;
4179 yield = string_append(yield, 3,
4180 US"Authentication-Results: ", sub_arg[0], US"; none");
4183 yield = authres_local(yield, sub_arg[0]);
4184 yield = authres_iprev(yield);
4185 yield = authres_smtpauth(yield);
4187 yield = authres_spf(yield);
4189 #ifndef DISABLE_DKIM
4190 yield = authres_dkim(yield);
4192 #ifdef EXPERIMENTAL_DMARC
4193 yield = authres_dmarc(yield);
4195 #ifdef EXPERIMENTAL_ARC
4196 yield = authres_arc(yield);
4201 /* Handle conditionals - preserve the values of the numerical expansion
4202 variables in case they get changed by a regular expression match in the
4203 condition. If not, they retain their external settings. At the end
4204 of this "if" section, they get restored to their previous values. */
4209 const uschar *next_s;
4210 int save_expand_nmax =
4211 save_expand_strings(save_expand_nstring, save_expand_nlength);
4213 while (isspace(*s)) s++;
4214 next_s = eval_condition(s, &resetok, skipping ? NULL : &cond);
4215 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4219 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4220 "condition: %.*s\n",
4221 (int)(next_s - s), s);
4222 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4223 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4225 cond ? "true" : "false");
4230 /* The handling of "yes" and "no" result strings is now in a separate
4231 function that is also used by ${lookup} and ${extract} and ${run}. */
4233 switch(process_yesno(
4234 skipping, /* were previously skipping */
4235 cond, /* success/failure indicator */
4236 lookup_value, /* value to reset for string2 */
4237 &s, /* input pointer */
4238 &yield, /* output pointer */
4239 US"if", /* condition type */
4242 case 1: goto EXPAND_FAILED; /* when all is well, the */
4243 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4246 /* Restore external setting of expansion variables for continuation
4249 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4250 save_expand_nlength);
4255 case EITEM_IMAPFOLDER:
4256 { /* ${imapfolder {name}{sep]{specials}} */
4260 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4263 case 1: goto EXPAND_FAILED_CURLY;
4265 case 3: goto EXPAND_FAILED;
4268 if (sub_arg[1] == NULL) /* One argument */
4270 sub_arg[1] = US"/"; /* default separator */
4273 else if (Ustrlen(sub_arg[1]) != 1)
4275 expand_string_message =
4277 "IMAP folder separator must be one character, found \"%s\"",
4284 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4285 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4287 yield = string_cat(yield, encoded);
4293 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4294 expanding an internal string that isn't actually going to be used. All we
4295 need to do is check the syntax, so don't do a lookup at all. Preserve the
4296 values of the numerical expansion variables in case they get changed by a
4297 partial lookup. If not, they retain their external settings. At the end
4298 of this "lookup" section, they get restored to their previous values. */
4302 int stype, partial, affixlen, starflags;
4303 int expand_setup = 0;
4305 uschar *key, *filename;
4306 const uschar *affix;
4307 uschar *save_lookup_value = lookup_value;
4308 int save_expand_nmax =
4309 save_expand_strings(save_expand_nstring, save_expand_nlength);
4311 if ((expand_forbid & RDO_LOOKUP) != 0)
4313 expand_string_message = US"lookup expansions are not permitted";
4317 /* Get the key we are to look up for single-key+file style lookups.
4318 Otherwise set the key NULL pro-tem. */
4320 while (isspace(*s)) s++;
4321 if (*s == '{') /*}*/
4323 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4324 if (!key) goto EXPAND_FAILED; /*{{*/
4327 expand_string_message = US"missing '}' after lookup key";
4328 goto EXPAND_FAILED_CURLY;
4330 while (isspace(*s)) s++;
4334 /* Find out the type of database */
4338 expand_string_message = US"missing lookup type";
4342 /* The type is a string that may contain special characters of various
4343 kinds. Allow everything except space or { to appear; the actual content
4344 is checked by search_findtype_partial. */ /*}*/
4346 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4348 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4352 while (isspace(*s)) s++;
4354 /* Now check for the individual search type and any partial or default
4355 options. Only those types that are actually in the binary are valid. */
4357 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4361 expand_string_message = search_error_message;
4365 /* Check that a key was provided for those lookup types that need it,
4366 and was not supplied for those that use the query style. */
4368 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4372 expand_string_message = string_sprintf("missing {key} for single-"
4373 "key \"%s\" lookup", name);
4381 expand_string_message = string_sprintf("a single key was given for "
4382 "lookup type \"%s\", which is not a single-key lookup type", name);
4387 /* Get the next string in brackets and expand it. It is the file name for
4388 single-key+file lookups, and the whole query otherwise. In the case of
4389 queries that also require a file name (e.g. sqlite), the file name comes
4394 expand_string_message = US"missing '{' for lookup file-or-query arg";
4395 goto EXPAND_FAILED_CURLY;
4397 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4398 if (filename == NULL) goto EXPAND_FAILED;
4401 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4402 goto EXPAND_FAILED_CURLY;
4404 while (isspace(*s)) s++;
4406 /* If this isn't a single-key+file lookup, re-arrange the variables
4407 to be appropriate for the search_ functions. For query-style lookups,
4408 there is just a "key", and no file name. For the special query-style +
4409 file types, the query (i.e. "key") starts with a file name. */
4413 while (isspace(*filename)) filename++;
4416 if (mac_islookup(stype, lookup_querystyle))
4420 if (*filename != '/')
4422 expand_string_message = string_sprintf(
4423 "absolute file name expected for \"%s\" lookup", name);
4426 while (*key != 0 && !isspace(*key)) key++;
4427 if (*key != 0) *key++ = 0;
4431 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4432 the entry was not found. Note that there is no search_close() function.
4433 Files are left open in case of re-use. At suitable places in higher logic,
4434 search_tidyup() is called to tidy all open files. This can save opening
4435 the same file several times. However, files may also get closed when
4436 others are opened, if too many are open at once. The rule is that a
4437 handle should not be used after a second search_open().
4439 Request that a partial search sets up $1 and maybe $2 by passing
4440 expand_setup containing zero. If its value changes, reset expand_nmax,
4441 since new variables will have been set. Note that at the end of this
4442 "lookup" section, the old numeric variables are restored. */
4445 lookup_value = NULL;
4448 void *handle = search_open(filename, stype, 0, NULL, NULL);
4451 expand_string_message = search_error_message;
4454 lookup_value = search_find(handle, filename, key, partial, affix,
4455 affixlen, starflags, &expand_setup);
4456 if (search_find_defer)
4458 expand_string_message =
4459 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4460 string_printing2(key, FALSE), search_error_message);
4463 if (expand_setup > 0) expand_nmax = expand_setup;
4466 /* The handling of "yes" and "no" result strings is now in a separate
4467 function that is also used by ${if} and ${extract}. */
4469 switch(process_yesno(
4470 skipping, /* were previously skipping */
4471 lookup_value != NULL, /* success/failure indicator */
4472 save_lookup_value, /* value to reset for string2 */
4473 &s, /* input pointer */
4474 &yield, /* output pointer */
4475 US"lookup", /* condition type */
4478 case 1: goto EXPAND_FAILED; /* when all is well, the */
4479 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4482 /* Restore external setting of expansion variables for carrying on
4483 at this level, and continue. */
4485 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4486 save_expand_nlength);
4490 /* If Perl support is configured, handle calling embedded perl subroutines,
4491 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4492 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4493 arguments (defined below). */
4495 #define EXIM_PERL_MAX_ARGS 8
4499 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4500 "is not included in this binary";
4503 #else /* EXIM_PERL */
4505 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4508 if ((expand_forbid & RDO_PERL) != 0)
4510 expand_string_message = US"Perl calls are not permitted";
4514 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4515 US"perl", &resetok))
4517 case 1: goto EXPAND_FAILED_CURLY;
4519 case 3: goto EXPAND_FAILED;
4522 /* If skipping, we don't actually do anything */
4524 if (skipping) continue;
4526 /* Start the interpreter if necessary */
4528 if (!opt_perl_started)
4531 if (opt_perl_startup == NULL)
4533 expand_string_message = US"A setting of perl_startup is needed when "
4534 "using the Perl interpreter";
4537 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4538 initerror = init_perl(opt_perl_startup);
4539 if (initerror != NULL)
4541 expand_string_message =
4542 string_sprintf("error in perl_startup code: %s\n", initerror);
4545 opt_perl_started = TRUE;
4548 /* Call the function */
4550 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4551 new_yield = call_perl_cat(yield, &expand_string_message,
4552 sub_arg[0], sub_arg + 1);
4554 /* NULL yield indicates failure; if the message pointer has been set to
4555 NULL, the yield was undef, indicating a forced failure. Otherwise the
4556 message will indicate some kind of Perl error. */
4558 if (new_yield == NULL)
4560 if (expand_string_message == NULL)
4562 expand_string_message =
4563 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4564 "failure", sub_arg[0]);
4565 expand_string_forcedfail = TRUE;
4570 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4571 set during a callback from Perl. */
4573 expand_string_forcedfail = FALSE;
4577 #endif /* EXIM_PERL */
4579 /* Transform email address to "prvs" scheme to use
4580 as BATV-signed return path */
4587 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4589 case 1: goto EXPAND_FAILED_CURLY;
4591 case 3: goto EXPAND_FAILED;
4594 /* If skipping, we don't actually do anything */
4595 if (skipping) continue;
4597 /* sub_arg[0] is the address */
4598 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
4599 || domain == sub_arg[0] || Ustrlen(domain) == 1)
4601 expand_string_message = US"prvs first argument must be a qualified email address";
4605 /* Calculate the hash. The third argument must be a single-digit
4606 key number, or unset. */
4609 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4611 expand_string_message = US"prvs third argument must be a single digit";
4615 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
4618 expand_string_message = US"prvs hmac-sha1 conversion failed";
4622 /* Now separate the domain from the local part */
4625 yield = string_catn(yield, US"prvs=", 5);
4626 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
4627 yield = string_catn(yield, prvs_daystamp(7), 3);
4628 yield = string_catn(yield, p, 6);
4629 yield = string_catn(yield, US"=", 1);
4630 yield = string_cat (yield, sub_arg[0]);
4631 yield = string_catn(yield, US"@", 1);
4632 yield = string_cat (yield, domain);
4637 /* Check a prvs-encoded address for validity */
4639 case EITEM_PRVSCHECK:
4646 /* TF: Ugliness: We want to expand parameter 1 first, then set
4647 up expansion variables that are used in the expansion of
4648 parameter 2. So we clone the string for the first
4649 expansion, where we only expand parameter 1.
4651 PH: Actually, that isn't necessary. The read_subs() function is
4652 designed to work this way for the ${if and ${lookup expansions. I've
4656 /* Reset expansion variables */
4657 prvscheck_result = NULL;
4658 prvscheck_address = NULL;
4659 prvscheck_keynum = NULL;
4661 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4663 case 1: goto EXPAND_FAILED_CURLY;
4665 case 3: goto EXPAND_FAILED;
4668 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4671 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4673 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4674 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4675 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4676 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4677 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4679 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
4680 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
4681 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
4682 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
4683 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
4685 /* Set up expansion variables */
4686 g = string_cat (NULL, local_part);
4687 g = string_catn(g, US"@", 1);
4688 g = string_cat (g, domain);
4689 prvscheck_address = string_from_gstring(g);
4690 prvscheck_keynum = string_copy(key_num);
4692 /* Now expand the second argument */
4693 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4695 case 1: goto EXPAND_FAILED_CURLY;
4697 case 3: goto EXPAND_FAILED;
4700 /* Now we have the key and can check the address. */
4702 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4707 expand_string_message = US"hmac-sha1 conversion failed";
4711 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
4712 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
4714 if (Ustrcmp(p,hash) == 0)
4716 /* Success, valid BATV address. Now check the expiry date. */
4717 uschar *now = prvs_daystamp(0);
4718 unsigned int inow = 0,iexpire = 1;
4720 (void)sscanf(CS now,"%u",&inow);
4721 (void)sscanf(CS daystamp,"%u",&iexpire);
4723 /* When "iexpire" is < 7, a "flip" has occured.
4724 Adjust "inow" accordingly. */
4725 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4727 if (iexpire >= inow)
4729 prvscheck_result = US"1";
4730 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
4734 prvscheck_result = NULL;
4735 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
4740 prvscheck_result = NULL;
4741 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
4744 /* Now expand the final argument. We leave this till now so that
4745 it can include $prvscheck_result. */
4747 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4749 case 1: goto EXPAND_FAILED_CURLY;
4751 case 3: goto EXPAND_FAILED;
4754 yield = string_cat(yield,
4755 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4757 /* Reset the "internal" variables afterwards, because they are in
4758 dynamic store that will be reclaimed if the expansion succeeded. */
4760 prvscheck_address = NULL;
4761 prvscheck_keynum = NULL;
4764 /* Does not look like a prvs encoded address, return the empty string.
4765 We need to make sure all subs are expanded first, so as to skip over
4768 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4770 case 1: goto EXPAND_FAILED_CURLY;
4772 case 3: goto EXPAND_FAILED;
4778 /* Handle "readfile" to insert an entire file */
4780 case EITEM_READFILE:
4785 if ((expand_forbid & RDO_READFILE) != 0)
4787 expand_string_message = US"file insertions are not permitted";
4791 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4793 case 1: goto EXPAND_FAILED_CURLY;
4795 case 3: goto EXPAND_FAILED;
4798 /* If skipping, we don't actually do anything */
4800 if (skipping) continue;
4802 /* Open the file and read it */
4804 if (!(f = Ufopen(sub_arg[0], "rb")))
4806 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4810 yield = cat_file(f, yield, sub_arg[1]);
4815 /* Handle "readsocket" to insert data from a socket, either
4816 Inet or Unix domain */
4818 case EITEM_READSOCK:
4822 int save_ptr = yield->ptr;
4825 uschar * sub_arg[4];
4826 uschar * server_name = NULL;
4828 BOOL do_shutdown = TRUE;
4830 BOOL do_tls = FALSE;
4831 void * tls_ctx = NULL;
4835 if (expand_forbid & RDO_READSOCK)
4837 expand_string_message = US"socket insertions are not permitted";
4841 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4842 because there may be a string for expansion on failure. */
4844 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4846 case 1: goto EXPAND_FAILED_CURLY;
4847 case 2: /* Won't occur: no end check */
4848 case 3: goto EXPAND_FAILED;
4851 /* Grab the request string, if any */
4853 reqstr.data = sub_arg[1];
4854 reqstr.len = Ustrlen(sub_arg[1]);
4856 /* Sort out timeout, if given. The second arg is a list with the first element
4857 being a time value. Any more are options of form "name=value". Currently the
4858 only option recognised is "shutdown". */
4862 const uschar * list = sub_arg[2];
4866 item = string_nextinlist(&list, &sep, NULL, 0);
4867 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
4869 expand_string_message = string_sprintf("bad time value %s", item);
4873 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
4874 if (Ustrncmp(item, US"shutdown=", 9) == 0)
4875 { if (Ustrcmp(item + 9, US"no") == 0) do_shutdown = FALSE; }
4877 else if (Ustrncmp(item, US"tls=", 4) == 0)
4878 { if (Ustrcmp(item + 9, US"no") != 0) do_tls = TRUE; }
4882 sub_arg[3] = NULL; /* No eol if no timeout */
4884 /* If skipping, we don't actually do anything. Otherwise, arrange to
4885 connect to either an IP or a Unix socket. */
4889 /* Handle an IP (internet) domain */
4891 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4896 server_name = sub_arg[0] + 5;
4897 port_name = Ustrrchr(server_name, ':');
4899 /* Sort out the port */
4903 expand_string_message =
4904 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4907 *port_name++ = 0; /* Terminate server name */
4909 if (isdigit(*port_name))
4912 port = Ustrtol(port_name, &end, 0);
4913 if (end != port_name + Ustrlen(port_name))
4915 expand_string_message =
4916 string_sprintf("invalid port number %s", port_name);
4922 struct servent *service_info = getservbyname(CS port_name, "tcp");
4925 expand_string_message = string_sprintf("unknown port \"%s\"",
4929 port = ntohs(service_info->s_port);
4932 fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4933 timeout, &host, &expand_string_message,
4934 do_tls ? NULL : &reqstr);
4935 callout_address = NULL;
4938 if (!do_tls) reqstr.len = 0;
4941 /* Handle a Unix domain socket */
4945 struct sockaddr_un sockun; /* don't call this "sun" ! */
4948 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4950 expand_string_message = string_sprintf("failed to create socket: %s",
4955 sockun.sun_family = AF_UNIX;
4956 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4958 server_name = sockun.sun_path;
4960 sigalrm_seen = FALSE;
4962 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4966 expand_string_message = US "socket connect timed out";
4971 expand_string_message = string_sprintf("failed to connect to socket "
4972 "%s: %s", sub_arg[0], strerror(errno));
4975 host.name = server_name;
4976 host.address = US"";
4979 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
4984 tls_support tls_dummy = {0};
4987 if (!(tls_ctx = tls_client_start(fd, &host, NULL, NULL, NULL,
4988 &tls_dummy, &errstr)))
4990 expand_string_message = string_sprintf("TLS connect failed: %s", errstr);
4996 /* Allow sequencing of test actions */
4997 if (running_in_test_harness) millisleep(100);
4999 /* Write the request string, if not empty or already done */
5003 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
5007 tls_ctx ? tls_write(tls_ctx, reqstr.data, reqstr.len, FALSE) :
5009 write(fd, reqstr.data, reqstr.len)) != reqstr.len)
5011 expand_string_message = string_sprintf("request write to socket "
5012 "failed: %s", strerror(errno));
5017 /* Shut down the sending side of the socket. This helps some servers to
5018 recognise that it is their turn to do some work. Just in case some
5019 system doesn't have this function, make it conditional. */
5022 if (!tls_ctx && do_shutdown) shutdown(fd, SHUT_WR);
5025 if (running_in_test_harness) millisleep(100);
5027 /* Now we need to read from the socket, under a timeout. The function
5028 that reads a file can be used. */
5031 f = fdopen(fd, "rb");
5032 sigalrm_seen = FALSE;
5036 tls_ctx ? cat_file_tls(tls_ctx, yield, sub_arg[3]) :
5038 cat_file(f, yield, sub_arg[3]);
5044 tls_close(tls_ctx, TRUE);
5051 /* After a timeout, we restore the pointer in the result, that is,
5052 make sure we add nothing from the socket. */
5056 yield->ptr = save_ptr;
5057 expand_string_message = US "socket read timed out";
5062 /* The whole thing has worked (or we were skipping). If there is a
5063 failure string following, we need to skip it. */
5067 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
5071 expand_string_message = US"missing '}' closing failstring for readsocket";
5072 goto EXPAND_FAILED_CURLY;
5074 while (isspace(*s)) s++;
5080 expand_string_message = US"missing '}' closing readsocket";
5081 goto EXPAND_FAILED_CURLY;
5085 /* Come here on failure to create socket, connect socket, write to the
5086 socket, or timeout on reading. If another substring follows, expand and
5087 use it. Otherwise, those conditions give expand errors. */
5090 if (*s != '{') goto EXPAND_FAILED;
5091 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5092 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5094 yield = string_cat(yield, arg);
5097 expand_string_message = US"missing '}' closing failstring for readsocket";
5098 goto EXPAND_FAILED_CURLY;
5100 while (isspace(*s)) s++;
5104 /* Handle "run" to execute a program. */
5110 const uschar **argv;
5114 if ((expand_forbid & RDO_RUN) != 0)
5116 expand_string_message = US"running a command is not permitted";
5120 while (isspace(*s)) s++;
5123 expand_string_message = US"missing '{' for command arg of run";
5124 goto EXPAND_FAILED_CURLY;
5126 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5127 if (arg == NULL) goto EXPAND_FAILED;
5128 while (isspace(*s)) s++;
5131 expand_string_message = US"missing '}' closing command arg of run";
5132 goto EXPAND_FAILED_CURLY;
5135 if (skipping) /* Just pretend it worked when we're skipping */
5138 lookup_value = NULL;
5142 if (!transport_set_up_command(&argv, /* anchor for arg list */
5143 arg, /* raw command */
5144 FALSE, /* don't expand the arguments */
5145 0, /* not relevant when... */
5146 NULL, /* no transporting address */
5147 US"${run} expansion", /* for error messages */
5148 &expand_string_message)) /* where to put error message */
5151 /* Create the child process, making it a group leader. */
5153 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
5155 expand_string_message =
5156 string_sprintf("couldn't create child process: %s", strerror(errno));
5160 /* Nothing is written to the standard input. */
5164 /* Read the pipe to get the command's output into $value (which is kept
5165 in lookup_value). Read during execution, so that if the output exceeds
5166 the OS pipe buffer limit, we don't block forever. Remember to not release
5167 memory just allocated for $value. */
5170 f = fdopen(fd_out, "rb");
5171 sigalrm_seen = FALSE;
5173 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5177 /* Wait for the process to finish, applying the timeout, and inspect its
5178 return code for serious disasters. Simple non-zero returns are passed on.
5181 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5183 if (sigalrm_seen || runrc == -256)
5185 expand_string_message = string_sprintf("command timed out");
5186 killpg(pid, SIGKILL); /* Kill the whole process group */
5189 else if (runrc == -257)
5190 expand_string_message = string_sprintf("wait() failed: %s",
5194 expand_string_message = string_sprintf("command killed by signal %d",
5201 /* Process the yes/no strings; $value may be useful in both cases */
5203 switch(process_yesno(
5204 skipping, /* were previously skipping */
5205 runrc == 0, /* success/failure indicator */
5206 lookup_value, /* value to reset for string2 */
5207 &s, /* input pointer */
5208 &yield, /* output pointer */
5209 US"run", /* condition type */
5212 case 1: goto EXPAND_FAILED; /* when all is well, the */
5213 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5219 /* Handle character translation for "tr" */
5223 int oldptr = yield->ptr;
5227 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5229 case 1: goto EXPAND_FAILED_CURLY;
5231 case 3: goto EXPAND_FAILED;
5234 yield = string_cat(yield, sub[0]);
5235 o2m = Ustrlen(sub[2]) - 1;
5237 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5239 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5243 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5250 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5251 expanded arguments. */
5261 int val[2] = { 0, -1 };
5264 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5265 Ensure that sub[2] is set in the ${length } case. */
5268 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5269 TRUE, name, &resetok))
5271 case 1: goto EXPAND_FAILED_CURLY;
5273 case 3: goto EXPAND_FAILED;
5276 /* Juggle the arguments if there are only two of them: always move the
5277 string to the last position and make ${length{n}{str}} equivalent to
5278 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5284 if (item_type == EITEM_LENGTH)
5291 for (i = 0; i < 2; i++)
5293 if (sub[i] == NULL) continue;
5294 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5295 if (*ret != 0 || (i != 0 && val[i] < 0))
5297 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5298 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5304 (item_type == EITEM_HASH)?
5305 compute_hash(sub[2], val[0], val[1], &len) :
5306 (item_type == EITEM_NHASH)?
5307 compute_nhash(sub[2], val[0], val[1], &len) :
5308 extract_substr(sub[2], val[0], val[1], &len);
5310 if (ret == NULL) goto EXPAND_FAILED;
5311 yield = string_catn(yield, ret, len);
5315 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5316 This code originally contributed by Steve Haslam. It currently supports
5317 the use of MD5 and SHA-1 hashes.
5319 We need some workspace that is large enough to handle all the supported
5320 hash types. Use macros to set the sizes rather than be too elaborate. */
5322 #define MAX_HASHLEN 20
5323 #define MAX_HASHBLOCKLEN 64
5332 int hashlen; /* Number of octets for the hash algorithm's output */
5333 int hashblocklen; /* Number of octets the hash algorithm processes */
5335 unsigned int keylen;
5337 uschar keyhash[MAX_HASHLEN];
5338 uschar innerhash[MAX_HASHLEN];
5339 uschar finalhash[MAX_HASHLEN];
5340 uschar finalhash_hex[2*MAX_HASHLEN];
5341 uschar innerkey[MAX_HASHBLOCKLEN];
5342 uschar outerkey[MAX_HASHBLOCKLEN];
5344 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5346 case 1: goto EXPAND_FAILED_CURLY;
5348 case 3: goto EXPAND_FAILED;
5353 if (Ustrcmp(sub[0], "md5") == 0)
5356 use_base = &md5_base;
5360 else if (Ustrcmp(sub[0], "sha1") == 0)
5363 use_base = &sha1_ctx;
5369 expand_string_message =
5370 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5375 keylen = Ustrlen(keyptr);
5377 /* If the key is longer than the hash block length, then hash the key
5380 if (keylen > hashblocklen)
5382 chash_start(type, use_base);
5383 chash_end(type, use_base, keyptr, keylen, keyhash);
5388 /* Now make the inner and outer key values */
5390 memset(innerkey, 0x36, hashblocklen);
5391 memset(outerkey, 0x5c, hashblocklen);
5393 for (i = 0; i < keylen; i++)
5395 innerkey[i] ^= keyptr[i];
5396 outerkey[i] ^= keyptr[i];
5399 /* Now do the hashes */
5401 chash_start(type, use_base);
5402 chash_mid(type, use_base, innerkey);
5403 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5405 chash_start(type, use_base);
5406 chash_mid(type, use_base, outerkey);
5407 chash_end(type, use_base, innerhash, hashlen, finalhash);
5409 /* Encode the final hash as a hex string */
5412 for (i = 0; i < hashlen; i++)
5414 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5415 *p++ = hex_digits[finalhash[i] & 0x0f];
5418 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5419 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5421 yield = string_catn(yield, finalhash_hex, hashlen*2);
5426 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5427 We have to save the numerical variables and restore them afterwards. */
5432 int moffset, moffsetextra, slen;
5435 const uschar *rerror;
5438 int save_expand_nmax =
5439 save_expand_strings(save_expand_nstring, save_expand_nlength);
5441 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5443 case 1: goto EXPAND_FAILED_CURLY;
5445 case 3: goto EXPAND_FAILED;
5448 /* Compile the regular expression */
5450 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5455 expand_string_message = string_sprintf("regular expression error in "
5456 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5460 /* Now run a loop to do the substitutions as often as necessary. It ends
5461 when there are no more matches. Take care over matches of the null string;
5462 do the same thing as Perl does. */
5465 slen = Ustrlen(sub[0]);
5466 moffset = moffsetextra = 0;
5471 int ovector[3*(EXPAND_MAXN+1)];
5472 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5473 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5477 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5478 is not necessarily the end. We want to repeat the match from one
5479 character further along, but leaving the basic offset the same (for
5480 copying below). We can't be at the end of the string - that was checked
5481 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5482 finished; copy the remaining string and end the loop. */
5492 yield = string_catn(yield, subject+moffset, slen-moffset);
5496 /* Match - set up for expanding the replacement. */
5498 if (n == 0) n = EXPAND_MAXN + 1;
5500 for (nn = 0; nn < n*2; nn += 2)
5502 expand_nstring[expand_nmax] = subject + ovector[nn];
5503 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5507 /* Copy the characters before the match, plus the expanded insertion. */
5509 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
5510 insert = expand_string(sub[2]);
5511 if (insert == NULL) goto EXPAND_FAILED;
5512 yield = string_cat(yield, insert);
5514 moffset = ovector[1];
5518 /* If we have matched an empty string, first check to see if we are at
5519 the end of the subject. If so, the loop is over. Otherwise, mimic
5520 what Perl's /g options does. This turns out to be rather cunning. First
5521 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5522 string at the same point. If this fails (picked up above) we advance to
5523 the next character. */
5525 if (ovector[0] == ovector[1])
5527 if (ovector[0] == slen) break;
5528 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5532 /* All done - restore numerical variables. */
5534 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5535 save_expand_nlength);
5539 /* Handle keyed and numbered substring extraction. If the first argument
5540 consists entirely of digits, then a numerical extraction is assumed. */
5546 int field_number = 1;
5547 BOOL field_number_set = FALSE;
5548 uschar *save_lookup_value = lookup_value;
5550 int save_expand_nmax =
5551 save_expand_strings(save_expand_nstring, save_expand_nlength);
5553 /* While skipping we cannot rely on the data for expansions being
5554 available (eg. $item) hence cannot decide on numeric vs. keyed.
5555 Read a maximum of 5 arguments (including the yes/no) */
5559 while (isspace(*s)) s++;
5560 for (j = 5; j > 0 && *s == '{'; j--)
5562 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5563 goto EXPAND_FAILED; /*{*/
5566 expand_string_message = US"missing '{' for arg of extract";
5567 goto EXPAND_FAILED_CURLY;
5569 while (isspace(*s)) s++;
5571 if ( Ustrncmp(s, "fail", 4) == 0
5572 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5576 while (isspace(*s)) s++;
5580 expand_string_message = US"missing '}' closing extract";
5581 goto EXPAND_FAILED_CURLY;
5585 else for (i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5587 while (isspace(*s)) s++;
5588 if (*s == '{') /*}*/
5590 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5591 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5594 expand_string_message = string_sprintf(
5595 "missing '}' closing arg %d of extract", i+1);
5596 goto EXPAND_FAILED_CURLY;
5599 /* After removal of leading and trailing white space, the first
5600 argument must not be empty; if it consists entirely of digits
5601 (optionally preceded by a minus sign), this is a numerical
5602 extraction, and we expect 3 arguments. */
5610 while (isspace(*p)) p++;
5614 while (len > 0 && isspace(p[len-1])) len--;
5619 expand_string_message = US"first argument of \"extract\" must "
5629 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5633 j = 3; /* Need 3 args */
5634 field_number_set = TRUE;
5640 expand_string_message = string_sprintf(
5641 "missing '{' for arg %d of extract", i+1);
5642 goto EXPAND_FAILED_CURLY;
5646 /* Extract either the numbered or the keyed substring into $value. If
5647 skipping, just pretend the extraction failed. */
5649 lookup_value = skipping? NULL : field_number_set?
5650 expand_gettokened(field_number, sub[1], sub[2]) :
5651 expand_getkeyed(sub[0], sub[1]);
5653 /* If no string follows, $value gets substituted; otherwise there can
5654 be yes/no strings, as for lookup or if. */
5656 switch(process_yesno(
5657 skipping, /* were previously skipping */
5658 lookup_value != NULL, /* success/failure indicator */
5659 save_lookup_value, /* value to reset for string2 */
5660 &s, /* input pointer */
5661 &yield, /* output pointer */
5662 US"extract", /* condition type */
5665 case 1: goto EXPAND_FAILED; /* when all is well, the */
5666 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5669 /* All done - restore numerical variables. */
5671 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5672 save_expand_nlength);
5677 /* return the Nth item from a list */
5679 case EITEM_LISTEXTRACT:
5682 int field_number = 1;
5683 uschar *save_lookup_value = lookup_value;
5685 int save_expand_nmax =
5686 save_expand_strings(save_expand_nstring, save_expand_nlength);
5688 /* Read the field & list arguments */
5690 for (i = 0; i < 2; i++)
5692 while (isspace(*s)) s++;
5693 if (*s != '{') /*}*/
5695 expand_string_message = string_sprintf(
5696 "missing '{' for arg %d of listextract", i+1);
5697 goto EXPAND_FAILED_CURLY;
5700 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5701 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5704 expand_string_message = string_sprintf(
5705 "missing '}' closing arg %d of listextract", i+1);
5706 goto EXPAND_FAILED_CURLY;
5709 /* After removal of leading and trailing white space, the first
5710 argument must be numeric and nonempty. */
5718 while (isspace(*p)) p++;
5722 while (len > 0 && isspace(p[len-1])) len--;
5725 if (!*p && !skipping)
5727 expand_string_message = US"first argument of \"listextract\" must "
5737 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5740 expand_string_message = US"first argument of \"listextract\" must "
5748 /* Extract the numbered element into $value. If
5749 skipping, just pretend the extraction failed. */
5751 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5753 /* If no string follows, $value gets substituted; otherwise there can
5754 be yes/no strings, as for lookup or if. */
5756 switch(process_yesno(
5757 skipping, /* were previously skipping */
5758 lookup_value != NULL, /* success/failure indicator */
5759 save_lookup_value, /* value to reset for string2 */
5760 &s, /* input pointer */
5761 &yield, /* output pointer */
5762 US"listextract", /* condition type */
5765 case 1: goto EXPAND_FAILED; /* when all is well, the */
5766 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5769 /* All done - restore numerical variables. */
5771 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5772 save_expand_nlength);
5778 case EITEM_CERTEXTRACT:
5780 uschar *save_lookup_value = lookup_value;
5782 int save_expand_nmax =
5783 save_expand_strings(save_expand_nstring, save_expand_nlength);
5785 /* Read the field argument */
5786 while (isspace(*s)) s++;
5787 if (*s != '{') /*}*/
5789 expand_string_message = US"missing '{' for field arg of certextract";
5790 goto EXPAND_FAILED_CURLY;
5792 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5793 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5796 expand_string_message = US"missing '}' closing field arg of certextract";
5797 goto EXPAND_FAILED_CURLY;
5799 /* strip spaces fore & aft */
5804 while (isspace(*p)) p++;
5808 while (len > 0 && isspace(p[len-1])) len--;
5812 /* inspect the cert argument */
5813 while (isspace(*s)) s++;
5814 if (*s != '{') /*}*/
5816 expand_string_message = US"missing '{' for cert variable arg of certextract";
5817 goto EXPAND_FAILED_CURLY;
5821 expand_string_message = US"second argument of \"certextract\" must "
5822 "be a certificate variable";
5825 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5826 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5829 expand_string_message = US"missing '}' closing cert variable arg of certextract";
5830 goto EXPAND_FAILED_CURLY;
5834 lookup_value = NULL;
5837 lookup_value = expand_getcertele(sub[0], sub[1]);
5838 if (*expand_string_message) goto EXPAND_FAILED;
5840 switch(process_yesno(
5841 skipping, /* were previously skipping */
5842 lookup_value != NULL, /* success/failure indicator */
5843 save_lookup_value, /* value to reset for string2 */
5844 &s, /* input pointer */
5845 &yield, /* output pointer */
5846 US"certextract", /* condition type */
5849 case 1: goto EXPAND_FAILED; /* when all is well, the */
5850 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5853 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5854 save_expand_nlength);
5857 #endif /*SUPPORT_TLS*/
5859 /* Handle list operations */
5866 int save_ptr = yield->ptr;
5867 uschar outsep[2] = { '\0', '\0' };
5868 const uschar *list, *expr, *temp;
5869 uschar *save_iterate_item = iterate_item;
5870 uschar *save_lookup_value = lookup_value;
5872 while (isspace(*s)) s++;
5875 expand_string_message =
5876 string_sprintf("missing '{' for first arg of %s", name);
5877 goto EXPAND_FAILED_CURLY;
5880 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5881 if (list == NULL) goto EXPAND_FAILED;
5884 expand_string_message =
5885 string_sprintf("missing '}' closing first arg of %s", name);
5886 goto EXPAND_FAILED_CURLY;
5889 if (item_type == EITEM_REDUCE)
5892 while (isspace(*s)) s++;
5895 expand_string_message = US"missing '{' for second arg of reduce";
5896 goto EXPAND_FAILED_CURLY;
5898 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5899 if (!t) goto EXPAND_FAILED;
5903 expand_string_message = US"missing '}' closing second arg of reduce";
5904 goto EXPAND_FAILED_CURLY;
5908 while (isspace(*s)) s++;
5911 expand_string_message =
5912 string_sprintf("missing '{' for last arg of %s", name);
5913 goto EXPAND_FAILED_CURLY;
5918 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5919 if scanning a "false" part). This allows us to find the end of the
5920 condition, because if the list is empty, we won't actually evaluate the
5921 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5922 the normal internal expansion function. */
5924 if (item_type == EITEM_FILTER)
5926 temp = eval_condition(expr, &resetok, NULL);
5927 if (temp != NULL) s = temp;
5930 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5934 expand_string_message = string_sprintf("%s inside \"%s\" item",
5935 expand_string_message, name);
5939 while (isspace(*s)) s++;
5942 expand_string_message = string_sprintf("missing } at end of condition "
5943 "or expression inside \"%s\"; could be an unquoted } in the content",
5948 while (isspace(*s)) s++; /*{*/
5951 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5956 /* If we are skipping, we can now just move on to the next item. When
5957 processing for real, we perform the iteration. */
5959 if (skipping) continue;
5960 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
5962 *outsep = (uschar)sep; /* Separator as a string */
5964 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
5965 name, iterate_item, lookup_value);
5967 if (item_type == EITEM_FILTER)
5970 if (eval_condition(expr, &resetok, &condresult) == NULL)
5972 iterate_item = save_iterate_item;
5973 lookup_value = save_lookup_value;
5974 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5975 expand_string_message, name);
5978 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
5979 condresult? "true":"false");
5981 temp = iterate_item; /* TRUE => include this item */
5983 continue; /* FALSE => skip this item */
5986 /* EITEM_MAP and EITEM_REDUCE */
5990 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5994 iterate_item = save_iterate_item;
5995 expand_string_message = string_sprintf("%s inside \"%s\" item",
5996 expand_string_message, name);
5999 if (item_type == EITEM_REDUCE)
6001 lookup_value = t; /* Update the value of $value */
6002 continue; /* and continue the iteration */
6006 /* We reach here for FILTER if the condition is true, always for MAP,
6007 and never for REDUCE. The value in "temp" is to be added to the output
6008 list that is being created, ensuring that any occurrences of the
6009 separator character are doubled. Unless we are dealing with the first
6010 item of the output list, add in a space if the new item begins with the
6011 separator character, or is an empty string. */
6013 if (yield->ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
6014 yield = string_catn(yield, US" ", 1);
6016 /* Add the string in "temp" to the output list that we are building,
6017 This is done in chunks by searching for the separator character. */
6021 size_t seglen = Ustrcspn(temp, outsep);
6023 yield = string_catn(yield, temp, seglen + 1);
6025 /* If we got to the end of the string we output one character
6026 too many; backup and end the loop. Otherwise arrange to double the
6029 if (temp[seglen] == '\0') { yield->ptr--; break; }
6030 yield = string_catn(yield, outsep, 1);
6034 /* Output a separator after the string: we will remove the redundant
6035 final one at the end. */
6037 yield = string_catn(yield, outsep, 1);
6038 } /* End of iteration over the list loop */
6040 /* REDUCE has generated no output above: output the final value of
6043 if (item_type == EITEM_REDUCE)
6045 yield = string_cat(yield, lookup_value);
6046 lookup_value = save_lookup_value; /* Restore $value */
6049 /* FILTER and MAP generate lists: if they have generated anything, remove
6050 the redundant final separator. Even though an empty item at the end of a
6051 list does not count, this is tidier. */
6053 else if (yield->ptr != save_ptr) yield->ptr--;
6055 /* Restore preserved $item */
6057 iterate_item = save_iterate_item;
6064 const uschar *srclist, *cmp, *xtract;
6066 const uschar *dstlist = NULL, *dstkeylist = NULL;
6068 uschar *save_iterate_item = iterate_item;
6070 while (isspace(*s)) s++;
6073 expand_string_message = US"missing '{' for list arg of sort";
6074 goto EXPAND_FAILED_CURLY;
6077 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
6078 if (!srclist) goto EXPAND_FAILED;
6081 expand_string_message = US"missing '}' closing list arg of sort";
6082 goto EXPAND_FAILED_CURLY;
6085 while (isspace(*s)) s++;
6088 expand_string_message = US"missing '{' for comparator arg of sort";
6089 goto EXPAND_FAILED_CURLY;
6092 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6093 if (!cmp) goto EXPAND_FAILED;
6096 expand_string_message = US"missing '}' closing comparator arg of sort";
6097 goto EXPAND_FAILED_CURLY;
6100 while (isspace(*s)) s++;
6103 expand_string_message = US"missing '{' for extractor arg of sort";
6104 goto EXPAND_FAILED_CURLY;
6108 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6109 if (!tmp) goto EXPAND_FAILED;
6110 xtract = string_copyn(xtract, s - xtract);
6114 expand_string_message = US"missing '}' closing extractor arg of sort";
6115 goto EXPAND_FAILED_CURLY;
6120 expand_string_message = US"missing } at end of \"sort\"";
6124 if (skipping) continue;
6126 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6129 gstring * newlist = NULL;
6130 gstring * newkeylist = NULL;
6133 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6135 /* extract field for comparisons */
6136 iterate_item = srcitem;
6137 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6141 expand_string_message = string_sprintf(
6142 "field-extract in sort: \"%s\"", xtract);
6146 /* Insertion sort */
6148 /* copy output list until new-item < list-item */
6149 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6155 /* field for comparison */
6156 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6159 /* build and run condition string */
6160 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
6162 DEBUG(D_expand) debug_printf_indent("%s: cond = \"%s\"\n", name, expr);
6163 if (!eval_condition(expr, &resetok, &before))
6165 expand_string_message = string_sprintf("comparison in sort: %s",
6172 /* New-item sorts before this dst-item. Append new-item,
6173 then dst-item, then remainder of dst list. */
6175 newlist = string_append_listele(newlist, sep, srcitem);
6176 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6179 newlist = string_append_listele(newlist, sep, dstitem);
6180 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6182 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6184 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6186 newlist = string_append_listele(newlist, sep, dstitem);
6187 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6193 newlist = string_append_listele(newlist, sep, dstitem);
6194 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6197 /* If we ran out of dstlist without consuming srcitem, append it */
6200 newlist = string_append_listele(newlist, sep, srcitem);
6201 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6204 dstlist = newlist->s;
6205 dstkeylist = newkeylist->s;
6207 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6208 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6212 yield = string_cat(yield, dstlist);
6214 /* Restore preserved $item */
6215 iterate_item = save_iterate_item;
6219 expand_string_message = US"Internal error in sort (list mismatch)";
6224 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6225 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6226 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6227 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6229 #define EXPAND_DLFUNC_MAX_ARGS 8
6232 #ifndef EXPAND_DLFUNC
6233 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6234 "is not included in this binary";
6237 #else /* EXPAND_DLFUNC */
6240 exim_dlfunc_t *func;
6243 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6245 if ((expand_forbid & RDO_DLFUNC) != 0)
6247 expand_string_message =
6248 US"dynamically-loaded functions are not permitted";
6252 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6253 TRUE, US"dlfunc", &resetok))
6255 case 1: goto EXPAND_FAILED_CURLY;
6257 case 3: goto EXPAND_FAILED;
6260 /* If skipping, we don't actually do anything */
6262 if (skipping) continue;
6264 /* Look up the dynamically loaded object handle in the tree. If it isn't
6265 found, dlopen() the file and put the handle in the tree for next time. */
6267 t = tree_search(dlobj_anchor, argv[0]);
6270 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6273 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6274 argv[0], dlerror());
6275 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6278 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6279 Ustrcpy(t->name, argv[0]);
6280 t->data.ptr = handle;
6281 (void)tree_insertnode(&dlobj_anchor, t);
6284 /* Having obtained the dynamically loaded object handle, look up the
6285 function pointer. */
6287 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6290 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6291 "%s", argv[1], argv[0], dlerror());
6292 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6296 /* Call the function and work out what to do with the result. If it
6297 returns OK, we have a replacement string; if it returns DEFER then
6298 expansion has failed in a non-forced manner; if it returns FAIL then
6299 failure was forced; if it returns ERROR or any other value there's a
6300 problem, so panic slightly. In any case, assume that the function has
6301 side-effects on the store that must be preserved. */
6305 for (argc = 0; argv[argc] != NULL; argc++);
6306 status = func(&result, argc - 2, &argv[2]);
6309 if (result == NULL) result = US"";
6310 yield = string_cat(yield, result);
6315 expand_string_message = result == NULL ? US"(no message)" : result;
6316 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
6317 else if(status != FAIL)
6318 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6319 argv[0], argv[1], status, expand_string_message);
6323 #endif /* EXPAND_DLFUNC */
6325 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6328 uschar *save_lookup_value = lookup_value;
6330 while (isspace(*s)) s++;
6331 if (*s != '{') /*}*/
6334 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6335 if (!key) goto EXPAND_FAILED; /*{*/
6338 expand_string_message = US"missing '{' for name arg of env";
6339 goto EXPAND_FAILED_CURLY;
6342 lookup_value = US getenv(CS key);
6344 switch(process_yesno(
6345 skipping, /* were previously skipping */
6346 lookup_value != NULL, /* success/failure indicator */
6347 save_lookup_value, /* value to reset for string2 */
6348 &s, /* input pointer */
6349 &yield, /* output pointer */
6350 US"env", /* condition type */
6353 case 1: goto EXPAND_FAILED; /* when all is well, the */
6354 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6358 } /* EITEM_* switch */
6360 /* Control reaches here if the name is not recognized as one of the more
6361 complicated expansion items. Check for the "operator" syntax (name terminated
6362 by a colon). Some of the operators have arguments, separated by _ from the
6370 var_entry *vp = NULL;
6372 /* Owing to an historical mis-design, an underscore may be part of the
6373 operator name, or it may introduce arguments. We therefore first scan the
6374 table of names that contain underscores. If there is no match, we cut off
6375 the arguments and then scan the main table. */
6377 if ((c = chop_match(name, op_table_underscore,
6378 nelem(op_table_underscore))) < 0)
6380 arg = Ustrchr(name, '_');
6381 if (arg != NULL) *arg = 0;
6382 c = chop_match(name, op_table_main, nelem(op_table_main));
6383 if (c >= 0) c += nelem(op_table_underscore);
6384 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6387 /* Deal specially with operators that might take a certificate variable
6388 as we do not want to do the usual expansion. For most, expand the string.*/
6398 const uschar * s1 = s;
6399 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6401 if (!sub) goto EXPAND_FAILED; /*{*/
6404 expand_string_message =
6405 string_sprintf("missing '}' closing cert arg of %s", name);
6406 goto EXPAND_FAILED_CURLY;
6408 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6418 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6419 if (!sub) goto EXPAND_FAILED;
6424 /* If we are skipping, we don't need to perform the operation at all.
6425 This matters for operations like "mask", because the data may not be
6426 in the correct format when skipping. For example, the expression may test
6427 for the existence of $sender_host_address before trying to mask it. For
6428 other operations, doing them may not fail, but it is a waste of time. */
6430 if (skipping && c >= 0) continue;
6432 /* Otherwise, switch on the operator type */
6439 unsigned long int n = Ustrtoul(sub, &t, 10);
6444 expand_string_message = string_sprintf("argument for base32 "
6445 "operator is \"%s\", which is not a decimal number", sub);
6449 g = string_catn(g, &base32_chars[n & 0x1f], 1);
6451 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
6458 unsigned long int n = 0;
6462 uschar * t = Ustrchr(base32_chars, *tt++);
6465 expand_string_message = string_sprintf("argument for base32d "
6466 "operator is \"%s\", which is not a base 32 number", sub);
6469 n = n * 32 + (t - base32_chars);
6471 s = string_sprintf("%ld", n);
6472 yield = string_cat(yield, s);
6479 unsigned long int n = Ustrtoul(sub, &t, 10);
6482 expand_string_message = string_sprintf("argument for base62 "
6483 "operator is \"%s\", which is not a decimal number", sub);
6486 t = string_base62(n);
6487 yield = string_cat(yield, t);
6491 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6497 unsigned long int n = 0;
6500 uschar *t = Ustrchr(base62_chars, *tt++);
6503 expand_string_message = string_sprintf("argument for base62d "
6504 "operator is \"%s\", which is not a base %d number", sub,
6508 n = n * BASE_62 + (t - base62_chars);
6510 (void)sprintf(CS buf, "%ld", n);
6511 yield = string_cat(yield, buf);
6517 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6518 if (expanded == NULL)
6520 expand_string_message =
6521 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6522 expand_string_message);
6525 yield = string_cat(yield, expanded);
6532 uschar *t = sub - 1;
6533 while (*(++t) != 0) { *t = tolower(*t); count++; }
6534 yield = string_catn(yield, sub, count);
6541 uschar *t = sub - 1;
6542 while (*(++t) != 0) { *t = toupper(*t); count++; }
6543 yield = string_catn(yield, sub, count);
6549 if (vp && *(void **)vp->value)
6551 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6552 yield = string_cat(yield, cp);
6562 md5_end(&base, sub, Ustrlen(sub), digest);
6563 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6564 yield = string_cat(yield, US st);
6570 if (vp && *(void **)vp->value)
6572 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6573 yield = string_cat(yield, cp);
6583 sha1_end(&h, sub, Ustrlen(sub), digest);
6584 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6585 yield = string_catn(yield, US st, 40);
6590 #ifdef EXIM_HAVE_SHA2
6591 if (vp && *(void **)vp->value)
6593 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6594 yield = string_cat(yield, cp);
6602 if (!exim_sha_init(&h, HASH_SHA2_256))
6604 expand_string_message = US"unrecognised sha256 variant";
6607 exim_sha_update(&h, sub, Ustrlen(sub));
6608 exim_sha_finish(&h, &b);
6611 sprintf(st, "%02X", *b.data++);
6612 yield = string_catn(yield, US st, 2);
6616 expand_string_message = US"sha256 only supported with TLS";
6621 #ifdef EXIM_HAVE_SHA3
6626 hashmethod m = !arg ? HASH_SHA3_256
6627 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6628 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6629 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6630 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6633 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6635 expand_string_message = US"unrecognised sha3 variant";
6639 exim_sha_update(&h, sub, Ustrlen(sub));
6640 exim_sha_finish(&h, &b);
6643 sprintf(st, "%02X", *b.data++);
6644 yield = string_catn(yield, US st, 2);
6649 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
6653 /* Convert hex encoding to base64 encoding */
6663 for (enc = sub; *enc != 0; enc++)
6665 if (!isxdigit(*enc))
6667 expand_string_message = string_sprintf("\"%s\" is not a hex "
6676 expand_string_message = string_sprintf("\"%s\" contains an odd "
6677 "number of characters", sub);
6681 while ((c = *in++) != 0)
6683 if (isdigit(c)) c -= '0';
6684 else c = toupper(c) - 'A' + 10;
6696 enc = b64encode(sub, out - sub);
6697 yield = string_cat(yield, enc);
6701 /* Convert octets outside 0x21..0x7E to \xXX form */
6705 uschar *t = sub - 1;
6708 if (*t < 0x21 || 0x7E < *t)
6709 yield = string_catn(yield, string_sprintf("\\x%02x", *t), 4);
6711 yield = string_catn(yield, t, 1);
6716 /* count the number of list elements */
6725 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6726 cp = string_sprintf("%d", cnt);
6727 yield = string_cat(yield, cp);
6731 /* expand a named list given the name */
6732 /* handles nested named lists; requotes as colon-sep list */
6736 tree_node *t = NULL;
6737 const uschar * list;
6740 uschar * suffix = US"";
6741 BOOL needsep = FALSE;
6744 if (*sub == '+') sub++;
6745 if (arg == NULL) /* no-argument version */
6747 if (!(t = tree_search(addresslist_anchor, sub)) &&
6748 !(t = tree_search(domainlist_anchor, sub)) &&
6749 !(t = tree_search(hostlist_anchor, sub)))
6750 t = tree_search(localpartlist_anchor, sub);
6752 else switch(*arg) /* specific list-type version */
6754 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6755 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6756 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6757 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6759 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6765 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6767 : *arg=='a'?"address "
6768 : *arg=='d'?"domain "
6770 : *arg=='l'?"localpart "
6775 list = ((namedlist_block *)(t->data.ptr))->string;
6777 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
6779 uschar * buf = US" : ";
6781 yield = string_catn(yield, buf, 3);
6785 if (*item == '+') /* list item is itself a named list */
6787 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6788 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6790 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6794 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6795 while ((cp= strpbrk(CCS item, tok)))
6797 yield = string_catn(yield, item, cp - CS item);
6798 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6800 yield = string_catn(yield, US"::", 2);
6803 else /* sep in item; should already be doubled; emit once */
6805 yield = string_catn(yield, US tok, 1);
6806 if (*cp == sep) cp++;
6811 yield = string_cat(yield, item);
6816 /* mask applies a mask to an IP address; for example the result of
6817 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6824 int mask, maskoffset;
6825 int type = string_is_ip_address(sub, &maskoffset);
6830 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6835 if (maskoffset == 0)
6837 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6842 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6844 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6846 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6851 /* Convert the address to binary integer(s) and apply the mask */
6853 sub[maskoffset] = 0;
6854 count = host_aton(sub, binary);
6855 host_mask(count, binary, mask);
6857 /* Convert to masked textual format and add to output. */
6859 yield = string_catn(yield, buffer,
6860 host_nmtoa(count, binary, mask, buffer, '.'));
6865 case EOP_IPV6DENORM:
6867 int type = string_is_ip_address(sub, NULL);
6874 (void) host_aton(sub, binary);
6877 case 4: /* convert to IPv4-mapped IPv6 */
6878 binary[0] = binary[1] = 0;
6879 binary[2] = 0x0000ffff;
6880 (void) host_aton(sub, binary+3);
6884 expand_string_message =
6885 string_sprintf("\"%s\" is not an IP address", sub);
6889 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
6890 ? ipv6_nmtoa(binary, buffer)
6891 : host_nmtoa(4, binary, -1, buffer, ':')
6897 case EOP_LOCAL_PART:
6901 int start, end, domain;
6902 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
6905 if (c != EOP_DOMAIN)
6907 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6908 yield = string_catn(yield, sub+start, end-start);
6910 else if (domain != 0)
6913 yield = string_catn(yield, sub+domain, end-domain);
6920 uschar outsep[2] = { ':', '\0' };
6921 uschar *address, *error;
6922 int save_ptr = yield->ptr;
6923 int start, end, domain; /* Not really used */
6925 while (isspace(*sub)) sub++;
6927 if (*outsep = *++sub) ++sub;
6930 expand_string_message = string_sprintf("output separator "
6931 "missing in expanding ${addresses:%s}", --sub);
6934 parse_allow_group = TRUE;
6938 uschar *p = parse_find_address_end(sub, FALSE);
6939 uschar saveend = *p;
6941 address = parse_extract_address(sub, &error, &start, &end, &domain,
6945 /* Add the address to the output list that we are building. This is
6946 done in chunks by searching for the separator character. At the
6947 start, unless we are dealing with the first address of the output
6948 list, add in a space if the new address begins with the separator
6949 character, or is an empty string. */
6951 if (address != NULL)
6953 if (yield->ptr != save_ptr && address[0] == *outsep)
6954 yield = string_catn(yield, US" ", 1);
6958 size_t seglen = Ustrcspn(address, outsep);
6959 yield = string_catn(yield, address, seglen + 1);
6961 /* If we got to the end of the string we output one character
6964 if (address[seglen] == '\0') { yield->ptr--; break; }
6965 yield = string_catn(yield, outsep, 1);
6966 address += seglen + 1;
6969 /* Output a separator after the string: we will remove the
6970 redundant final one at the end. */
6972 yield = string_catn(yield, outsep, 1);
6975 if (saveend == '\0') break;
6979 /* If we have generated anything, remove the redundant final
6982 if (yield->ptr != save_ptr) yield->ptr--;
6983 parse_allow_group = FALSE;
6988 /* quote puts a string in quotes if it is empty or contains anything
6989 other than alphamerics, underscore, dot, or hyphen.
6991 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6992 be quoted in order to be a valid local part.
6994 In both cases, newlines and carriage returns are converted into \n and \r
6998 case EOP_QUOTE_LOCAL_PART:
7001 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
7002 uschar *t = sub - 1;
7006 while (!needs_quote && *(++t) != 0)
7007 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7009 else /* EOP_QUOTE_LOCAL_PART */
7011 while (!needs_quote && *(++t) != 0)
7012 needs_quote = !isalnum(*t) &&
7013 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
7014 (*t != '.' || t == sub || t[1] == 0);
7019 yield = string_catn(yield, US"\"", 1);
7024 yield = string_catn(yield, US"\\n", 2);
7025 else if (*t == '\r')
7026 yield = string_catn(yield, US"\\r", 2);
7029 if (*t == '\\' || *t == '"')
7030 yield = string_catn(yield, US"\\", 1);
7031 yield = string_catn(yield, t, 1);
7034 yield = string_catn(yield, US"\"", 1);
7036 else yield = string_cat(yield, sub);
7040 /* quote_lookuptype does lookup-specific quoting */
7045 uschar *opt = Ustrchr(arg, '_');
7047 if (opt != NULL) *opt++ = 0;
7049 n = search_findtype(arg, Ustrlen(arg));
7052 expand_string_message = search_error_message;
7056 if (lookup_list[n]->quote != NULL)
7057 sub = (lookup_list[n]->quote)(sub, opt);
7058 else if (opt != NULL) sub = NULL;
7062 expand_string_message = string_sprintf(
7063 "\"%s\" unrecognized after \"${quote_%s\"",
7068 yield = string_cat(yield, sub);
7072 /* rx quote sticks in \ before any non-alphameric character so that
7073 the insertion works in a regular expression. */
7077 uschar *t = sub - 1;
7081 yield = string_catn(yield, US"\\", 1);
7082 yield = string_catn(yield, t, 1);
7087 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7088 prescribed by the RFC, if there are characters that need to be encoded */
7092 uschar buffer[2048];
7093 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7094 buffer, sizeof(buffer), FALSE);
7095 yield = string_cat(yield, string);
7099 /* RFC 2047 decode */
7105 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7106 headers_charset, '?', &len, &error);
7109 expand_string_message = error;
7112 yield = string_catn(yield, decoded, len);
7116 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7126 if (c > 255) c = '_';
7128 yield = string_catn(yield, buff, 1);
7133 /* replace illegal UTF-8 sequences by replacement character */
7135 #define UTF8_REPLACEMENT_CHAR US"?"
7139 int seq_len = 0, index = 0;
7141 long codepoint = -1;
7142 uschar seq_buff[4]; /* accumulate utf-8 here */
7151 if ((c & 0xc0) != 0x80)
7152 /* wrong continuation byte; invalidate all bytes */
7153 complete = 1; /* error */
7156 codepoint = (codepoint << 6) | (c & 0x3f);
7157 seq_buff[index++] = c;
7158 if (--bytes_left == 0) /* codepoint complete */
7159 if(codepoint > 0x10FFFF) /* is it too large? */
7160 complete = -1; /* error (RFC3629 limit) */
7162 { /* finished; output utf-8 sequence */
7163 yield = string_catn(yield, seq_buff, seq_len);
7168 else /* no bytes left: new sequence */
7170 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7172 yield = string_catn(yield, &c, 1);
7175 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7177 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7182 codepoint = c & 0x1f;
7185 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7188 codepoint = c & 0x0f;
7190 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7193 codepoint = c & 0x07;
7195 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7198 seq_buff[index++] = c;
7199 seq_len = bytes_left + 1;
7200 } /* if(bytes_left) */
7204 bytes_left = index = 0;
7205 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7207 if ((complete == 1) && ((c & 0x80) == 0))
7208 /* ASCII character follows incomplete sequence */
7209 yield = string_catn(yield, &c, 1);
7215 case EOP_UTF8_DOMAIN_TO_ALABEL:
7217 uschar * error = NULL;
7218 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7221 expand_string_message = string_sprintf(
7222 "error converting utf8 (%s) to alabel: %s",
7223 string_printing(sub), error);
7226 yield = string_cat(yield, s);
7230 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7232 uschar * error = NULL;
7233 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7236 expand_string_message = string_sprintf(
7237 "error converting alabel (%s) to utf8: %s",
7238 string_printing(sub), error);
7241 yield = string_cat(yield, s);
7245 case EOP_UTF8_LOCALPART_TO_ALABEL:
7247 uschar * error = NULL;
7248 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7251 expand_string_message = string_sprintf(
7252 "error converting utf8 (%s) to alabel: %s",
7253 string_printing(sub), error);
7256 yield = string_cat(yield, s);
7257 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7261 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7263 uschar * error = NULL;
7264 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7267 expand_string_message = string_sprintf(
7268 "error converting alabel (%s) to utf8: %s",
7269 string_printing(sub), error);
7272 yield = string_cat(yield, s);
7275 #endif /* EXPERIMENTAL_INTERNATIONAL */
7277 /* escape turns all non-printing characters into escape sequences. */
7281 const uschar * t = string_printing(sub);
7282 yield = string_cat(yield, t);
7286 case EOP_ESCAPE8BIT:
7288 const uschar * s = sub;
7291 for (s = sub; (c = *s); s++)
7292 yield = c < 127 && c != '\\'
7293 ? string_catn(yield, s, 1)
7294 : string_catn(yield, string_sprintf("\\%03o", c), 4);
7298 /* Handle numeric expression evaluation */
7303 uschar *save_sub = sub;
7304 uschar *error = NULL;
7305 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7308 expand_string_message = string_sprintf("error in expression "
7309 "evaluation: %s (after processing \"%.*s\")", error,
7310 (int)(sub-save_sub), save_sub);
7313 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
7314 yield = string_cat(yield, var_buffer);
7318 /* Handle time period formating */
7322 int n = readconf_readtime(sub, 0, FALSE);
7325 expand_string_message = string_sprintf("string \"%s\" is not an "
7326 "Exim time interval in \"%s\" operator", sub, name);
7329 sprintf(CS var_buffer, "%d", n);
7330 yield = string_cat(yield, var_buffer);
7334 case EOP_TIME_INTERVAL:
7337 uschar *t = read_number(&n, sub);
7338 if (*t != 0) /* Not A Number*/
7340 expand_string_message = string_sprintf("string \"%s\" is not a "
7341 "positive number in \"%s\" operator", sub, name);
7344 t = readconf_printtime(n);
7345 yield = string_cat(yield, t);
7349 /* Convert string to base64 encoding */
7355 uschar * s = vp && *(void **)vp->value
7356 ? tls_cert_der_b64(*(void **)vp->value)
7357 : b64encode(sub, Ustrlen(sub));
7359 uschar * s = b64encode(sub, Ustrlen(sub));
7361 yield = string_cat(yield, s);
7368 int len = b64decode(sub, &s);
7371 expand_string_message = string_sprintf("string \"%s\" is not "
7372 "well-formed for \"%s\" operator", sub, name);
7375 yield = string_cat(yield, s);
7379 /* strlen returns the length of the string */
7384 (void)sprintf(CS buff, "%d", Ustrlen(sub));
7385 yield = string_cat(yield, buff);
7389 /* length_n or l_n takes just the first n characters or the whole string,
7390 whichever is the shorter;
7392 substr_m_n, and s_m_n take n characters from offset m; negative m take
7393 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7394 takes the rest, either to the right or to the left.
7396 hash_n or h_n makes a hash of length n from the string, yielding n
7397 characters from the set a-z; hash_n_m makes a hash of length n, but
7398 uses m characters from the set a-zA-Z0-9.
7400 nhash_n returns a single number between 0 and n-1 (in text form), while
7401 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7402 between 0 and n-1 and the second between 0 and m-1. */
7422 expand_string_message = string_sprintf("missing values after %s",
7427 /* "length" has only one argument, effectively being synonymous with
7430 if (c == EOP_LENGTH || c == EOP_L)
7436 /* The others have one or two arguments; for "substr" the first may be
7437 negative. The second being negative means "not supplied". */
7442 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7445 /* Read up to two numbers, separated by underscores */
7450 if (arg != ret && *arg == '_' && pn == &value1)
7454 if (arg[1] != 0) arg++;
7456 else if (!isdigit(*arg))
7458 expand_string_message =
7459 string_sprintf("non-digit after underscore in \"%s\"", name);
7462 else *pn = (*pn)*10 + *arg++ - '0';
7466 /* Perform the required operation */
7469 (c == EOP_HASH || c == EOP_H)?
7470 compute_hash(sub, value1, value2, &len) :
7471 (c == EOP_NHASH || c == EOP_NH)?
7472 compute_nhash(sub, value1, value2, &len) :
7473 extract_substr(sub, value1, value2, &len);
7475 if (ret == NULL) goto EXPAND_FAILED;
7476 yield = string_catn(yield, ret, len);
7486 uschar **modetable[3];
7491 if ((expand_forbid & RDO_EXISTS) != 0)
7493 expand_string_message = US"Use of the stat() expansion is not permitted";
7497 if (stat(CS sub, &st) < 0)
7499 expand_string_message = string_sprintf("stat(%s) failed: %s",
7500 sub, strerror(errno));
7504 switch (mode & S_IFMT)
7506 case S_IFIFO: smode[0] = 'p'; break;
7507 case S_IFCHR: smode[0] = 'c'; break;
7508 case S_IFDIR: smode[0] = 'd'; break;
7509 case S_IFBLK: smode[0] = 'b'; break;
7510 case S_IFREG: smode[0] = '-'; break;
7511 default: smode[0] = '?'; break;
7514 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7515 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7516 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7518 for (i = 0; i < 3; i++)
7520 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7525 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7526 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7527 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7528 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7529 (long)st.st_gid, st.st_size, (long)st.st_atime,
7530 (long)st.st_mtime, (long)st.st_ctime);
7531 yield = string_cat(yield, s);
7535 /* vaguely random number less than N */
7539 int_eximarith_t max;
7542 max = expanded_string_integer(sub, TRUE);
7543 if (expand_string_message != NULL)
7545 s = string_sprintf("%d", vaguely_random_number((int)max));
7546 yield = string_cat(yield, s);
7550 /* Reverse IP, including IPv6 to dotted-nibble */
7552 case EOP_REVERSE_IP:
7554 int family, maskptr;
7555 uschar reversed[128];
7557 family = string_is_ip_address(sub, &maskptr);
7560 expand_string_message = string_sprintf(
7561 "reverse_ip() not given an IP address [%s]", sub);
7564 invert_address(reversed, sub);
7565 yield = string_cat(yield, reversed);
7569 /* Unknown operator */
7572 expand_string_message =
7573 string_sprintf("unknown expansion operator \"%s\"", name);
7578 /* Handle a plain name. If this is the first thing in the expansion, release
7579 the pre-allocated buffer. If the result data is known to be in a new buffer,
7580 newsize will be set to the size of that buffer, and we can just point at that
7581 store instead of copying. Many expansion strings contain just one reference,
7582 so this is a useful optimization, especially for humungous headers
7583 ($message_headers). */
7592 g = store_get(sizeof(gstring));
7593 else if (yield->ptr == 0)
7595 if (resetok) store_reset(yield);
7597 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
7599 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
7601 expand_string_message =
7602 string_sprintf("unknown variable in \"${%s}\"", name);
7603 check_variable_error_message(name);
7606 len = Ustrlen(value);
7607 if (!yield && newsize)
7610 yield->size = newsize;
7615 yield = string_catn(yield, value, len);
7619 /* Else there's something wrong */
7621 expand_string_message =
7622 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7623 "in a variable reference)", name);
7627 /* If we hit the end of the string when ket_ends is set, there is a missing
7628 terminating brace. */
7630 if (ket_ends && *s == 0)
7632 expand_string_message = malformed_header
7633 ? US"missing } at end of string - could be header name not terminated by colon"
7634 : US"missing } at end of string";
7638 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7639 added to the string. If so, set up an empty string. Add a terminating zero. If
7640 left != NULL, return a pointer to the terminator. */
7643 yield = string_get(1);
7644 (void) string_from_gstring(yield);
7645 if (left) *left = s;
7647 /* Any stacking store that was used above the final string is no longer needed.
7648 In many cases the final string will be the first one that was got and so there
7649 will be optimal store usage. */
7651 if (resetok) store_reset(yield->s + (yield->size = yield->ptr + 1));
7652 else if (resetok_p) *resetok_p = FALSE;
7656 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
7657 "expanding: %.*s\n",
7658 (int)(s - string), string);
7659 debug_printf_indent("%s"
7660 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7662 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7665 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7666 "skipping: result is not used\n");
7671 /* This is the failure exit: easiest to program with a goto. We still need
7672 to update the pointer to the terminator, for cases of nested calls with "fail".
7675 EXPAND_FAILED_CURLY:
7676 if (malformed_header)
7677 expand_string_message =
7678 US"missing or misplaced { or } - could be header name not terminated by colon";
7680 else if (!expand_string_message || !*expand_string_message)
7681 expand_string_message = US"missing or misplaced { or }";
7683 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7684 that is a bad idea, because expand_string_message is in dynamic store. */
7687 if (left) *left = s;
7690 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
7692 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7693 "error message: %s\n",
7694 expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7695 expand_string_message);
7696 if (expand_string_forcedfail)
7697 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
7699 if (resetok_p && !resetok) *resetok_p = FALSE;
7705 /* This is the external function call. Do a quick check for any expansion
7706 metacharacters, and if there are none, just return the input string.
7708 Argument: the string to be expanded
7709 Returns: the expanded string, or NULL if expansion failed; if failure was
7710 due to a lookup deferring, search_find_defer will be TRUE
7714 expand_cstring(const uschar * string)
7716 if (Ustrpbrk(string, "$\\") != NULL)
7718 int old_pool = store_pool;
7721 search_find_defer = FALSE;
7722 malformed_header = FALSE;
7723 store_pool = POOL_MAIN;
7724 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7725 store_pool = old_pool;
7733 expand_string(uschar * string)
7735 return US expand_cstring(CUS string);
7742 /*************************************************
7744 *************************************************/
7746 /* Now and again we want to expand a string and be sure that the result is in a
7747 new bit of store. This function does that.
7748 Since we know it has been copied, the de-const cast is safe.
7750 Argument: the string to be expanded
7751 Returns: the expanded string, always in a new bit of store, or NULL
7755 expand_string_copy(const uschar *string)
7757 const uschar *yield = expand_cstring(string);
7758 if (yield == string) yield = string_copy(string);
7764 /*************************************************
7765 * Expand and interpret as an integer *
7766 *************************************************/
7768 /* Expand a string, and convert the result into an integer.
7771 string the string to be expanded
7772 isplus TRUE if a non-negative number is expected
7774 Returns: the integer value, or
7775 -1 for an expansion error ) in both cases, message in
7776 -2 for an integer interpretation error ) expand_string_message
7777 expand_string_message is set NULL for an OK integer
7781 expand_string_integer(uschar *string, BOOL isplus)
7783 return expanded_string_integer(expand_string(string), isplus);
7787 /*************************************************
7788 * Interpret string as an integer *
7789 *************************************************/
7791 /* Convert a string (that has already been expanded) into an integer.
7793 This function is used inside the expansion code.
7796 s the string to be expanded
7797 isplus TRUE if a non-negative number is expected
7799 Returns: the integer value, or
7800 -1 if string is NULL (which implies an expansion error)
7801 -2 for an integer interpretation error
7802 expand_string_message is set NULL for an OK integer
7805 static int_eximarith_t
7806 expanded_string_integer(const uschar *s, BOOL isplus)
7808 int_eximarith_t value;
7809 uschar *msg = US"invalid integer \"%s\"";
7812 /* If expansion failed, expand_string_message will be set. */
7814 if (s == NULL) return -1;
7816 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7817 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7818 systems, so we set it zero ourselves. */
7821 expand_string_message = NULL; /* Indicates no error */
7823 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7824 equal to 0. Unfortunately, people actually relied upon that, so preserve
7825 the behaviour explicitly. Stripping leading whitespace is a harmless
7826 noop change since strtol skips it anyway (provided that there is a number
7830 while (isspace(*s)) ++s;
7834 debug_printf_indent("treating blank string as number 0\n");
7839 value = strtoll(CS s, CSS &endptr, 10);
7843 msg = US"integer expected but \"%s\" found";
7845 else if (value < 0 && isplus)
7847 msg = US"non-negative integer expected but \"%s\" found";
7851 switch (tolower(*endptr))
7856 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7861 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7862 else value *= 1024*1024;
7866 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7867 else value *= 1024*1024*1024;
7871 if (errno == ERANGE)
7872 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7875 while (isspace(*endptr)) endptr++;
7876 if (*endptr == 0) return value;
7880 expand_string_message = string_sprintf(CS msg, s);
7885 /* These values are usually fixed boolean values, but they are permitted to be
7889 addr address being routed
7890 mtype the module type
7891 mname the module name
7892 dbg_opt debug selectors
7893 oname the option name
7894 bvalue the router's boolean value
7895 svalue the router's string value
7896 rvalue where to put the returned value
7898 Returns: OK value placed in rvalue
7899 DEFER expansion failed
7903 exp_bool(address_item *addr,
7904 uschar *mtype, uschar *mname, unsigned dbg_opt,
7905 uschar *oname, BOOL bvalue,
7906 uschar *svalue, BOOL *rvalue)
7909 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7911 expanded = expand_string(svalue);
7912 if (expanded == NULL)
7914 if (expand_string_forcedfail)
7916 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7920 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7921 oname, mname, mtype, expand_string_message);
7922 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7926 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7929 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7931 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7935 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7936 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7945 /* Avoid potentially exposing a password in a string about to be logged */
7948 expand_hide_passwords(uschar * s)
7950 return ( ( Ustrstr(s, "failed to expand") != NULL
7951 || Ustrstr(s, "expansion of ") != NULL
7953 && ( Ustrstr(s, "mysql") != NULL
7954 || Ustrstr(s, "pgsql") != NULL
7955 || Ustrstr(s, "redis") != NULL
7956 || Ustrstr(s, "sqlite") != NULL
7957 || Ustrstr(s, "ldap:") != NULL
7958 || Ustrstr(s, "ldaps:") != NULL
7959 || Ustrstr(s, "ldapi:") != NULL
7960 || Ustrstr(s, "ldapdn:") != NULL
7961 || Ustrstr(s, "ldapm:") != NULL
7963 ? US"Temporary internal error" : s;
7967 /* Read given named file into big_buffer. Use for keying material etc.
7968 The content will have an ascii NUL appended.
7973 Return: pointer to buffer, or NULL on error.
7977 expand_file_big_buffer(const uschar * filename)
7979 int fd, off = 0, len;
7981 if ((fd = open(CS filename, O_RDONLY)) < 0)
7983 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
7990 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
7993 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8001 big_buffer[off] = '\0';
8007 /*************************************************
8008 * Error-checking for testsuite *
8009 *************************************************/
8011 uschar * region_start;
8012 uschar * region_end;
8013 const uschar *var_name;
8014 const uschar *var_data;
8018 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8021 if (var_data >= e->region_start && var_data < e->region_end)
8023 e->var_name = CUS var_name;
8024 e->var_data = CUS var_data;
8029 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8031 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8032 .var_name = NULL, .var_data = NULL };
8036 /* check acl_ variables */
8037 tree_walk(acl_var_c, assert_variable_notin, &e);
8038 tree_walk(acl_var_m, assert_variable_notin, &e);
8040 /* check auth<n> variables */
8041 for (i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8042 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
8044 /* check regex<n> variables */
8045 for (i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8046 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
8048 /* check known-name variables */
8049 for (v = var_table; v < var_table + var_table_size; v++)
8050 if (v->type == vtype_stringptr)
8051 assert_variable_notin(US v->name, *(USS v->value), &e);
8053 /* check dns and address trees */
8054 tree_walk(tree_dns_fails, assert_variable_notin, &e);
8055 tree_walk(tree_duplicates, assert_variable_notin, &e);
8056 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8057 tree_walk(tree_unusable, assert_variable_notin, &e);
8060 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8061 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8062 e.var_name, filename, linenumber, e.var_data);
8067 /*************************************************
8068 **************************************************
8069 * Stand-alone test program *
8070 **************************************************
8071 *************************************************/
8077 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
8079 int ovector[3*(EXPAND_MAXN+1)];
8080 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8081 ovector, nelem(ovector));
8082 BOOL yield = n >= 0;
8083 if (n == 0) n = EXPAND_MAXN + 1;
8087 expand_nmax = (setup < 0)? 0 : setup + 1;
8088 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
8090 expand_nstring[expand_nmax] = subject + ovector[nn];
8091 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8099 int main(int argc, uschar **argv)
8102 uschar buffer[1024];
8104 debug_selector = D_v;
8105 debug_file = stderr;
8106 debug_fd = fileno(debug_file);
8107 big_buffer = malloc(big_buffer_size);
8109 for (i = 1; i < argc; i++)
8111 if (argv[i][0] == '+')
8113 debug_trace_memory = 2;
8116 if (isdigit(argv[i][0]))
8117 debug_selector = Ustrtol(argv[i], NULL, 0);
8119 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8123 eldap_default_servers = argv[i];
8126 mysql_servers = argv[i];
8129 pgsql_servers = argv[i];
8132 redis_servers = argv[i];
8136 else opt_perl_startup = argv[i];
8140 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8142 expand_nstring[1] = US"string 1....";
8143 expand_nlength[1] = 8;
8147 if (opt_perl_startup != NULL)
8150 printf("Starting Perl interpreter\n");
8151 errstr = init_perl(opt_perl_startup);
8154 printf("** error in perl_startup code: %s\n", errstr);
8155 return EXIT_FAILURE;
8158 #endif /* EXIM_PERL */
8160 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8162 void *reset_point = store_get(0);
8163 uschar *yield = expand_string(buffer);
8166 printf("%s\n", yield);
8167 store_reset(reset_point);
8171 if (search_find_defer) printf("search_find deferred\n");
8172 printf("Failed: %s\n", expand_string_message);
8173 if (expand_string_forcedfail) printf("Forced failure\n");
8187 /* End of expand.c */