1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *);
17 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
20 # ifndef SUPPORT_CRYPTEQ
21 # define SUPPORT_CRYPTEQ
26 # include "lookups/ldap.h"
29 #ifdef SUPPORT_CRYPTEQ
34 extern char* crypt16(char*, char*);
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. Characters after the first 16 are ignored. It always generates
50 a 16-byte hash, which is expressed together with the salt as a string
51 of 24 base 64 digits. Here are some links to peruse:
53 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
54 http://seclists.org/bugtraq/1999/Mar/0076.html
56 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
57 and OSF/1. This is the same as the standard crypt if given a password
58 of 8 characters or less. If given more, it first does the same as crypt
59 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
60 using as salt the first two base 64 digits from the first hash block.
61 If the password is more than 16 characters then it crypts the 17th to 24th
62 characters using as salt the first two base 64 digits from the second hash
63 block. And so on: I've seen references to it cutting off the password at
64 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
66 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
67 http://seclists.org/bugtraq/1999/Mar/0109.html
68 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
69 TET1_html/sec.c222.html#no_id_208
71 Exim has something it calls "crypt16". It will either use a native
72 crypt16 or its own implementation. A native crypt16 will presumably
73 be the one that I called "crypt16" above. The internal "crypt16"
74 function, however, is a two-block-maximum implementation of what I called
75 "bigcrypt". The documentation matches the internal code.
77 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
78 that crypt16 and bigcrypt were different things.
80 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
81 to whatever it is using under that name. This unfortunately sets a
82 precedent for using "{crypt16}" to identify two incompatible algorithms
83 whose output can't be distinguished. With "{crypt16}" thus rendered
84 ambiguous, I suggest you deprecate it and invent two new identifiers
85 for the two algorithms.
87 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
88 of the password separately means they can be cracked separately, so
89 the double-length hash only doubles the cracking effort instead of
90 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
166 /* Tables of operator names, and corresponding switch numbers. The names must be
167 in alphabetical order. There are two tables, because underscore is used in some
168 cases to introduce arguments, whereas for other it is part of the name. This is
169 an historical mis-design. */
171 static uschar *op_table_underscore[] = {
174 US"quote_local_part",
179 ,US"utf8_domain_from_alabel",
180 US"utf8_domain_to_alabel",
181 US"utf8_localpart_from_alabel",
182 US"utf8_localpart_to_alabel"
189 EOP_QUOTE_LOCAL_PART,
194 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
195 EOP_UTF8_DOMAIN_TO_ALABEL,
196 EOP_UTF8_LOCALPART_FROM_ALABEL,
197 EOP_UTF8_LOCALPART_TO_ALABEL
201 static uschar *op_table_main[] = {
248 EOP_ADDRESS = nelem(op_table_underscore),
294 /* Table of condition names, and corresponding switch numbers. The names must
295 be in alphabetical order. */
297 static uschar *cond_table[] = {
301 US"==", /* Backward compatibility */
334 US"match_local_part",
359 ECOND_FIRST_DELIVERY,
380 ECOND_MATCH_LOCAL_PART,
390 /* Types of table entry */
393 vtype_int, /* value is address of int */
394 vtype_filter_int, /* ditto, but recognized only when filtering */
395 vtype_ino, /* value is address of ino_t (not always an int) */
396 vtype_uid, /* value is address of uid_t (not always an int) */
397 vtype_gid, /* value is address of gid_t (not always an int) */
398 vtype_bool, /* value is address of bool */
399 vtype_stringptr, /* value is address of pointer to string */
400 vtype_msgbody, /* as stringptr, but read when first required */
401 vtype_msgbody_end, /* ditto, the end of the message */
402 vtype_msgheaders, /* the message's headers, processed */
403 vtype_msgheaders_raw, /* the message's headers, unprocessed */
404 vtype_localpart, /* extract local part from string */
405 vtype_domain, /* extract domain from string */
406 vtype_string_func, /* value is string returned by given function */
407 vtype_todbsdin, /* value not used; generate BSD inbox tod */
408 vtype_tode, /* value not used; generate tod in epoch format */
409 vtype_todel, /* value not used; generate tod in epoch/usec format */
410 vtype_todf, /* value not used; generate full tod */
411 vtype_todl, /* value not used; generate log tod */
412 vtype_todlf, /* value not used; generate log file datestamp tod */
413 vtype_todzone, /* value not used; generate time zone only */
414 vtype_todzulu, /* value not used; generate zulu tod */
415 vtype_reply, /* value not used; get reply from headers */
416 vtype_pid, /* value not used; result is pid */
417 vtype_host_lookup, /* value not used; get host name */
418 vtype_load_avg, /* value not used; result is int from os_getloadavg */
419 vtype_pspace, /* partition space; value is T/F for spool/log */
420 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
421 vtype_cert /* SSL certificate */
423 ,vtype_dkim /* Lookup of value in DKIM signature */
427 /* Type for main variable table */
435 /* Type for entries pointing to address/length pairs. Not currently
443 static uschar * fn_recipients(void);
445 /* This table must be kept in alphabetical order. */
447 static var_entry var_table[] = {
448 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
449 they will be confused with user-creatable ACL variables. */
450 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
451 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
452 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
453 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
454 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
455 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
456 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
457 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
458 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
459 { "acl_narg", vtype_int, &acl_narg },
460 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
461 { "address_data", vtype_stringptr, &deliver_address_data },
462 { "address_file", vtype_stringptr, &address_file },
463 { "address_pipe", vtype_stringptr, &address_pipe },
464 #ifdef EXPERIMENTAL_ARC
465 { "arc_state", vtype_stringptr, &arc_state },
466 { "arc_state_reason", vtype_stringptr, &arc_state_reason },
468 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
469 { "authenticated_id", vtype_stringptr, &authenticated_id },
470 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
471 { "authentication_failed",vtype_int, &authentication_failed },
472 #ifdef WITH_CONTENT_SCAN
473 { "av_failed", vtype_int, &av_failed },
475 #ifdef EXPERIMENTAL_BRIGHTMAIL
476 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
477 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
478 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
479 { "bmi_deliver", vtype_int, &bmi_deliver },
481 { "body_linecount", vtype_int, &body_linecount },
482 { "body_zerocount", vtype_int, &body_zerocount },
483 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
484 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
485 { "caller_gid", vtype_gid, &real_gid },
486 { "caller_uid", vtype_uid, &real_uid },
487 { "callout_address", vtype_stringptr, &callout_address },
488 { "compile_date", vtype_stringptr, &version_date },
489 { "compile_number", vtype_stringptr, &version_cnumber },
490 { "config_dir", vtype_stringptr, &config_main_directory },
491 { "config_file", vtype_stringptr, &config_main_filename },
492 { "csa_status", vtype_stringptr, &csa_status },
493 #ifdef EXPERIMENTAL_DCC
494 { "dcc_header", vtype_stringptr, &dcc_header },
495 { "dcc_result", vtype_stringptr, &dcc_result },
498 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
499 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
500 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
501 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
502 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
503 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
504 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
505 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
506 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
507 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
508 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
509 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
510 { "dkim_key_length", vtype_int, &dkim_key_length },
511 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
512 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
513 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
514 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
515 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
516 { "dkim_signers", vtype_stringptr, &dkim_signers },
517 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
518 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
520 #ifdef EXPERIMENTAL_DMARC
521 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
522 { "dmarc_status", vtype_stringptr, &dmarc_status },
523 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
524 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
526 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
527 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
528 { "dnslist_text", vtype_stringptr, &dnslist_text },
529 { "dnslist_value", vtype_stringptr, &dnslist_value },
530 { "domain", vtype_stringptr, &deliver_domain },
531 { "domain_data", vtype_stringptr, &deliver_domain_data },
532 #ifndef DISABLE_EVENT
533 { "event_data", vtype_stringptr, &event_data },
535 /*XXX want to use generic vars for as many of these as possible*/
536 { "event_defer_errno", vtype_int, &event_defer_errno },
538 { "event_name", vtype_stringptr, &event_name },
540 { "exim_gid", vtype_gid, &exim_gid },
541 { "exim_path", vtype_stringptr, &exim_path },
542 { "exim_uid", vtype_uid, &exim_uid },
543 { "exim_version", vtype_stringptr, &version_string },
544 { "headers_added", vtype_string_func, &fn_hdrs_added },
545 { "home", vtype_stringptr, &deliver_home },
546 { "host", vtype_stringptr, &deliver_host },
547 { "host_address", vtype_stringptr, &deliver_host_address },
548 { "host_data", vtype_stringptr, &host_data },
549 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
550 { "host_lookup_failed", vtype_int, &host_lookup_failed },
551 { "host_port", vtype_int, &deliver_host_port },
552 { "initial_cwd", vtype_stringptr, &initial_cwd },
553 { "inode", vtype_ino, &deliver_inode },
554 { "interface_address", vtype_stringptr, &interface_address },
555 { "interface_port", vtype_int, &interface_port },
556 { "item", vtype_stringptr, &iterate_item },
558 { "ldap_dn", vtype_stringptr, &eldap_dn },
560 { "load_average", vtype_load_avg, NULL },
561 { "local_part", vtype_stringptr, &deliver_localpart },
562 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
563 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
564 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
565 { "local_scan_data", vtype_stringptr, &local_scan_data },
566 { "local_user_gid", vtype_gid, &local_user_gid },
567 { "local_user_uid", vtype_uid, &local_user_uid },
568 { "localhost_number", vtype_int, &host_number },
569 { "log_inodes", vtype_pinodes, (void *)FALSE },
570 { "log_space", vtype_pspace, (void *)FALSE },
571 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
572 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
573 #ifdef WITH_CONTENT_SCAN
574 { "malware_name", vtype_stringptr, &malware_name },
576 { "max_received_linelength", vtype_int, &max_received_linelength },
577 { "message_age", vtype_int, &message_age },
578 { "message_body", vtype_msgbody, &message_body },
579 { "message_body_end", vtype_msgbody_end, &message_body_end },
580 { "message_body_size", vtype_int, &message_body_size },
581 { "message_exim_id", vtype_stringptr, &message_id },
582 { "message_headers", vtype_msgheaders, NULL },
583 { "message_headers_raw", vtype_msgheaders_raw, NULL },
584 { "message_id", vtype_stringptr, &message_id },
585 { "message_linecount", vtype_int, &message_linecount },
586 { "message_size", vtype_int, &message_size },
588 { "message_smtputf8", vtype_bool, &message_smtputf8 },
590 #ifdef WITH_CONTENT_SCAN
591 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
592 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
593 { "mime_boundary", vtype_stringptr, &mime_boundary },
594 { "mime_charset", vtype_stringptr, &mime_charset },
595 { "mime_content_description", vtype_stringptr, &mime_content_description },
596 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
597 { "mime_content_id", vtype_stringptr, &mime_content_id },
598 { "mime_content_size", vtype_int, &mime_content_size },
599 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
600 { "mime_content_type", vtype_stringptr, &mime_content_type },
601 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
602 { "mime_filename", vtype_stringptr, &mime_filename },
603 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
604 { "mime_is_multipart", vtype_int, &mime_is_multipart },
605 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
606 { "mime_part_count", vtype_int, &mime_part_count },
608 { "n0", vtype_filter_int, &filter_n[0] },
609 { "n1", vtype_filter_int, &filter_n[1] },
610 { "n2", vtype_filter_int, &filter_n[2] },
611 { "n3", vtype_filter_int, &filter_n[3] },
612 { "n4", vtype_filter_int, &filter_n[4] },
613 { "n5", vtype_filter_int, &filter_n[5] },
614 { "n6", vtype_filter_int, &filter_n[6] },
615 { "n7", vtype_filter_int, &filter_n[7] },
616 { "n8", vtype_filter_int, &filter_n[8] },
617 { "n9", vtype_filter_int, &filter_n[9] },
618 { "original_domain", vtype_stringptr, &deliver_domain_orig },
619 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
620 { "originator_gid", vtype_gid, &originator_gid },
621 { "originator_uid", vtype_uid, &originator_uid },
622 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
623 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
624 { "pid", vtype_pid, NULL },
626 { "prdr_requested", vtype_bool, &prdr_requested },
628 { "primary_hostname", vtype_stringptr, &primary_hostname },
629 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
630 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
631 { "proxy_external_port", vtype_int, &proxy_external_port },
632 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
633 { "proxy_local_port", vtype_int, &proxy_local_port },
634 { "proxy_session", vtype_bool, &proxy_session },
636 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
637 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
638 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
639 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
640 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
641 { "queue_name", vtype_stringptr, &queue_name },
642 { "rcpt_count", vtype_int, &rcpt_count },
643 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
644 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
645 { "received_count", vtype_int, &received_count },
646 { "received_for", vtype_stringptr, &received_for },
647 { "received_ip_address", vtype_stringptr, &interface_address },
648 { "received_port", vtype_int, &interface_port },
649 { "received_protocol", vtype_stringptr, &received_protocol },
650 { "received_time", vtype_int, &received_time.tv_sec },
651 { "recipient_data", vtype_stringptr, &recipient_data },
652 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
653 { "recipients", vtype_string_func, &fn_recipients },
654 { "recipients_count", vtype_int, &recipients_count },
655 #ifdef WITH_CONTENT_SCAN
656 { "regex_match_string", vtype_stringptr, ®ex_match_string },
658 { "reply_address", vtype_reply, NULL },
659 { "return_path", vtype_stringptr, &return_path },
660 { "return_size_limit", vtype_int, &bounce_return_size_limit },
661 { "router_name", vtype_stringptr, &router_name },
662 { "runrc", vtype_int, &runrc },
663 { "self_hostname", vtype_stringptr, &self_hostname },
664 { "sender_address", vtype_stringptr, &sender_address },
665 { "sender_address_data", vtype_stringptr, &sender_address_data },
666 { "sender_address_domain", vtype_domain, &sender_address },
667 { "sender_address_local_part", vtype_localpart, &sender_address },
668 { "sender_data", vtype_stringptr, &sender_data },
669 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
670 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
671 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
672 { "sender_host_address", vtype_stringptr, &sender_host_address },
673 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
674 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
675 { "sender_host_name", vtype_host_lookup, NULL },
676 { "sender_host_port", vtype_int, &sender_host_port },
677 { "sender_ident", vtype_stringptr, &sender_ident },
678 { "sender_rate", vtype_stringptr, &sender_rate },
679 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
680 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
681 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
682 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
683 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
684 { "sending_port", vtype_int, &sending_port },
685 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
686 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
687 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
688 { "smtp_command_history", vtype_string_func, &smtp_cmd_hist },
689 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
690 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
691 { "sn0", vtype_filter_int, &filter_sn[0] },
692 { "sn1", vtype_filter_int, &filter_sn[1] },
693 { "sn2", vtype_filter_int, &filter_sn[2] },
694 { "sn3", vtype_filter_int, &filter_sn[3] },
695 { "sn4", vtype_filter_int, &filter_sn[4] },
696 { "sn5", vtype_filter_int, &filter_sn[5] },
697 { "sn6", vtype_filter_int, &filter_sn[6] },
698 { "sn7", vtype_filter_int, &filter_sn[7] },
699 { "sn8", vtype_filter_int, &filter_sn[8] },
700 { "sn9", vtype_filter_int, &filter_sn[9] },
701 #ifdef WITH_CONTENT_SCAN
702 { "spam_action", vtype_stringptr, &spam_action },
703 { "spam_bar", vtype_stringptr, &spam_bar },
704 { "spam_report", vtype_stringptr, &spam_report },
705 { "spam_score", vtype_stringptr, &spam_score },
706 { "spam_score_int", vtype_stringptr, &spam_score_int },
709 { "spf_guess", vtype_stringptr, &spf_guess },
710 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
711 { "spf_received", vtype_stringptr, &spf_received },
712 { "spf_result", vtype_stringptr, &spf_result },
713 { "spf_result_guessed", vtype_bool, &spf_result_guessed },
714 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
716 { "spool_directory", vtype_stringptr, &spool_directory },
717 { "spool_inodes", vtype_pinodes, (void *)TRUE },
718 { "spool_space", vtype_pspace, (void *)TRUE },
719 #ifdef EXPERIMENTAL_SRS
720 { "srs_db_address", vtype_stringptr, &srs_db_address },
721 { "srs_db_key", vtype_stringptr, &srs_db_key },
722 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
723 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
724 { "srs_recipient", vtype_stringptr, &srs_recipient },
725 { "srs_status", vtype_stringptr, &srs_status },
727 { "thisaddress", vtype_stringptr, &filter_thisaddress },
729 /* The non-(in,out) variables are now deprecated */
730 { "tls_bits", vtype_int, &tls_in.bits },
731 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
732 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
734 { "tls_in_bits", vtype_int, &tls_in.bits },
735 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
736 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
737 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
738 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
739 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
740 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
741 #if defined(SUPPORT_TLS)
742 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
744 { "tls_out_bits", vtype_int, &tls_out.bits },
745 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
746 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
748 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
750 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
751 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
752 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
753 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
754 #if defined(SUPPORT_TLS)
755 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
758 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
761 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
762 #if defined(SUPPORT_TLS)
763 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
766 { "tod_bsdinbox", vtype_todbsdin, NULL },
767 { "tod_epoch", vtype_tode, NULL },
768 { "tod_epoch_l", vtype_todel, NULL },
769 { "tod_full", vtype_todf, NULL },
770 { "tod_log", vtype_todl, NULL },
771 { "tod_logfile", vtype_todlf, NULL },
772 { "tod_zone", vtype_todzone, NULL },
773 { "tod_zulu", vtype_todzulu, NULL },
774 { "transport_name", vtype_stringptr, &transport_name },
775 { "value", vtype_stringptr, &lookup_value },
776 { "verify_mode", vtype_stringptr, &verify_mode },
777 { "version_number", vtype_stringptr, &version_string },
778 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
779 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
780 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
781 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
782 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
783 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
786 static int var_table_size = nelem(var_table);
787 static uschar var_buffer[256];
788 static BOOL malformed_header;
790 /* For textual hashes */
792 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
793 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
796 enum { HMAC_MD5, HMAC_SHA1 };
798 /* For numeric hashes */
800 static unsigned int prime[] = {
801 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
802 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
803 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
805 /* For printing modes in symbolic form */
807 static uschar *mtable_normal[] =
808 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
810 static uschar *mtable_setid[] =
811 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
813 static uschar *mtable_sticky[] =
814 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
818 /*************************************************
819 * Tables for UTF-8 support *
820 *************************************************/
822 /* Table of the number of extra characters, indexed by the first character
823 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
826 static uschar utf8_table1[] = {
827 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
828 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
829 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
830 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
832 /* These are the masks for the data bits in the first byte of a character,
833 indexed by the number of additional bytes. */
835 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
837 /* Get the next UTF-8 character, advancing the pointer. */
839 #define GETUTF8INC(c, ptr) \
841 if ((c & 0xc0) == 0xc0) \
843 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
845 c = (c & utf8_table2[a]) << s; \
849 c |= (*ptr++ & 0x3f) << s; \
855 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
857 /*************************************************
858 * Binary chop search on a table *
859 *************************************************/
861 /* This is used for matching expansion items and operators.
864 name the name that is being sought
865 table the table to search
866 table_size the number of items in the table
868 Returns: the offset in the table, or -1
872 chop_match(uschar *name, uschar **table, int table_size)
874 uschar **bot = table;
875 uschar **top = table + table_size;
879 uschar **mid = bot + (top - bot)/2;
880 int c = Ustrcmp(name, *mid);
881 if (c == 0) return mid - table;
882 if (c > 0) bot = mid + 1; else top = mid;
890 /*************************************************
891 * Check a condition string *
892 *************************************************/
894 /* This function is called to expand a string, and test the result for a "true"
895 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
896 forced fail or lookup defer.
898 We used to release all store used, but this is not not safe due
899 to ${dlfunc } and ${acl }. In any case expand_string_internal()
900 is reasonably careful to release what it can.
902 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
905 condition the condition string
906 m1 text to be incorporated in panic error
909 Returns: TRUE if condition is met, FALSE if not
913 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
916 uschar *ss = expand_string(condition);
919 if (!expand_string_forcedfail && !search_find_defer)
920 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
921 "for %s %s: %s", condition, m1, m2, expand_string_message);
924 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
925 strcmpic(ss, US"false") != 0;
932 /*************************************************
933 * Pseudo-random number generation *
934 *************************************************/
936 /* Pseudo-random number generation. The result is not "expected" to be
937 cryptographically strong but not so weak that someone will shoot themselves
938 in the foot using it as a nonce in some email header scheme or whatever
939 weirdness they'll twist this into. The result should ideally handle fork().
941 However, if we're stuck unable to provide this, then we'll fall back to
942 appallingly bad randomness.
944 If SUPPORT_TLS is defined then this will not be used except as an emergency
949 Returns a random number in range [0, max-1]
953 # define vaguely_random_number vaguely_random_number_fallback
956 vaguely_random_number(int max)
959 # undef vaguely_random_number
961 static pid_t pid = 0;
963 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
973 #ifdef HAVE_ARC4RANDOM
974 /* cryptographically strong randomness, common on *BSD platforms, not
975 so much elsewhere. Alas. */
976 #ifndef NOT_HAVE_ARC4RANDOM_STIR
979 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
980 #ifdef HAVE_SRANDOMDEV
981 /* uses random(4) for seeding */
984 gettimeofday(&tv, NULL);
985 srandom(tv.tv_sec | tv.tv_usec | getpid());
988 /* Poor randomness and no seeding here */
995 #ifdef HAVE_ARC4RANDOM
996 return arc4random() % max;
997 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
998 return random() % max;
1000 /* This one returns a 16-bit number, definitely not crypto-strong */
1001 return random_number(max);
1008 /*************************************************
1009 * Pick out a name from a string *
1010 *************************************************/
1012 /* If the name is too long, it is silently truncated.
1015 name points to a buffer into which to put the name
1016 max is the length of the buffer
1017 s points to the first alphabetic character of the name
1018 extras chars other than alphanumerics to permit
1020 Returns: pointer to the first character after the name
1022 Note: The test for *s != 0 in the while loop is necessary because
1023 Ustrchr() yields non-NULL if the character is zero (which is not something
1026 static const uschar *
1027 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1030 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1032 if (ptr < max-1) name[ptr++] = *s;
1041 /*************************************************
1042 * Pick out the rest of a header name *
1043 *************************************************/
1045 /* A variable name starting $header_ (or just $h_ for those who like
1046 abbreviations) might not be the complete header name because headers can
1047 contain any printing characters in their names, except ':'. This function is
1048 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1049 on the end, if the name was terminated by white space.
1052 name points to a buffer in which the name read so far exists
1053 max is the length of the buffer
1054 s points to the first character after the name so far, i.e. the
1055 first non-alphameric character after $header_xxxxx
1057 Returns: a pointer to the first character after the header name
1060 static const uschar *
1061 read_header_name(uschar *name, int max, const uschar *s)
1063 int prelen = Ustrchr(name, '_') - name + 1;
1064 int ptr = Ustrlen(name) - prelen;
1065 if (ptr > 0) memmove(name, name+prelen, ptr);
1066 while (mac_isgraph(*s) && *s != ':')
1068 if (ptr < max-1) name[ptr++] = *s;
1079 /*************************************************
1080 * Pick out a number from a string *
1081 *************************************************/
1084 n points to an integer into which to put the number
1085 s points to the first digit of the number
1087 Returns: a pointer to the character after the last digit
1089 /*XXX consider expanding to int_eximarith_t. But the test for
1090 "overbig numbers" in 0002 still needs to overflow it. */
1093 read_number(int *n, uschar *s)
1096 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1100 static const uschar *
1101 read_cnumber(int *n, const uschar *s)
1104 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1110 /*************************************************
1111 * Extract keyed subfield from a string *
1112 *************************************************/
1114 /* The yield is in dynamic store; NULL means that the key was not found.
1117 key points to the name of the key
1118 s points to the string from which to extract the subfield
1120 Returns: NULL if the subfield was not found, or
1121 a pointer to the subfield's data
1125 expand_getkeyed(uschar *key, const uschar *s)
1127 int length = Ustrlen(key);
1128 while (isspace(*s)) s++;
1130 /* Loop to search for the key */
1136 const uschar *dkey = s;
1138 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1139 dkeylength = s - dkey;
1140 while (isspace(*s)) s++;
1141 if (*s == '=') while (isspace((*(++s))));
1143 data = string_dequote(&s);
1144 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1147 while (isspace(*s)) s++;
1156 find_var_ent(uschar * name)
1159 int last = var_table_size;
1161 while (last > first)
1163 int middle = (first + last)/2;
1164 int c = Ustrcmp(name, var_table[middle].name);
1166 if (c > 0) { first = middle + 1; continue; }
1167 if (c < 0) { last = middle; continue; }
1168 return &var_table[middle];
1173 /*************************************************
1174 * Extract numbered subfield from string *
1175 *************************************************/
1177 /* Extracts a numbered field from a string that is divided by tokens - for
1178 example a line from /etc/passwd is divided by colon characters. First field is
1179 numbered one. Negative arguments count from the right. Zero returns the whole
1180 string. Returns NULL if there are insufficient tokens in the string
1183 Modifies final argument - this is a dynamically generated string, so that's OK.
1186 field number of field to be extracted,
1187 first field = 1, whole string = 0, last field = -1
1188 separators characters that are used to break string into tokens
1189 s points to the string from which to extract the subfield
1191 Returns: NULL if the field was not found,
1192 a pointer to the field's data inside s (modified to add 0)
1196 expand_gettokened (int field, uschar *separators, uschar *s)
1201 uschar *fieldtext = NULL;
1203 if (field == 0) return s;
1205 /* Break the line up into fields in place; for field > 0 we stop when we have
1206 done the number of fields we want. For field < 0 we continue till the end of
1207 the string, counting the number of fields. */
1209 count = (field > 0)? field : INT_MAX;
1215 /* Previous field was the last one in the string. For a positive field
1216 number, this means there are not enough fields. For a negative field number,
1217 check that there are enough, and scan back to find the one that is wanted. */
1221 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1222 if ((-field) == (INT_MAX - count - 1)) return s;
1226 while (ss[-1] != 0) ss--;
1232 /* Previous field was not last in the string; save its start and put a
1236 len = Ustrcspn(ss, separators);
1247 expand_getlistele(int field, const uschar * list)
1249 const uschar * tlist= list;
1255 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1258 if(field==0) return NULL;
1259 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1260 return string_nextinlist(&list, &sep, NULL, 0);
1264 /* Certificate fields, by name. Worry about by-OID later */
1265 /* Names are chosen to not have common prefixes */
1272 uschar * (*getfn)(void * cert, uschar * mod);
1274 static certfield certfields[] =
1275 { /* linear search; no special order */
1276 { US"version", 7, &tls_cert_version },
1277 { US"serial_number", 13, &tls_cert_serial_number },
1278 { US"subject", 7, &tls_cert_subject },
1279 { US"notbefore", 9, &tls_cert_not_before },
1280 { US"notafter", 8, &tls_cert_not_after },
1281 { US"issuer", 6, &tls_cert_issuer },
1282 { US"signature", 9, &tls_cert_signature },
1283 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1284 { US"subj_altname", 12, &tls_cert_subject_altname },
1285 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1286 { US"crl_uri", 7, &tls_cert_crl_uri },
1290 expand_getcertele(uschar * field, uschar * certvar)
1295 if (!(vp = find_var_ent(certvar)))
1297 expand_string_message =
1298 string_sprintf("no variable named \"%s\"", certvar);
1299 return NULL; /* Unknown variable name */
1301 /* NB this stops us passing certs around in variable. Might
1302 want to do that in future */
1303 if (vp->type != vtype_cert)
1305 expand_string_message =
1306 string_sprintf("\"%s\" is not a certificate", certvar);
1307 return NULL; /* Unknown variable name */
1309 if (!*(void **)vp->value)
1312 if (*field >= '0' && *field <= '9')
1313 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1315 for(cp = certfields;
1316 cp < certfields + nelem(certfields);
1318 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1320 uschar * modifier = *(field += cp->namelen) == ','
1322 return (*cp->getfn)( *(void **)vp->value, modifier );
1325 expand_string_message =
1326 string_sprintf("bad field selector \"%s\" for certextract", field);
1329 #endif /*SUPPORT_TLS*/
1331 /*************************************************
1332 * Extract a substring from a string *
1333 *************************************************/
1335 /* Perform the ${substr or ${length expansion operations.
1338 subject the input string
1339 value1 the offset from the start of the input string to the start of
1340 the output string; if negative, count from the right.
1341 value2 the length of the output string, or negative (-1) for unset
1342 if value1 is positive, unset means "all after"
1343 if value1 is negative, unset means "all before"
1344 len set to the length of the returned string
1346 Returns: pointer to the output string, or NULL if there is an error
1350 extract_substr(uschar *subject, int value1, int value2, int *len)
1352 int sublen = Ustrlen(subject);
1354 if (value1 < 0) /* count from right */
1358 /* If the position is before the start, skip to the start, and adjust the
1359 length. If the length ends up negative, the substring is null because nothing
1360 can precede. This falls out naturally when the length is unset, meaning "all
1366 if (value2 < 0) value2 = 0;
1370 /* Otherwise an unset length => characters before value1 */
1372 else if (value2 < 0)
1379 /* For a non-negative offset, if the starting position is past the end of the
1380 string, the result will be the null string. Otherwise, an unset length means
1381 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1385 if (value1 > sublen)
1390 else if (value2 < 0) value2 = sublen;
1393 /* Cut the length down to the maximum possible for the offset value, and get
1394 the required characters. */
1396 if (value1 + value2 > sublen) value2 = sublen - value1;
1398 return subject + value1;
1404 /*************************************************
1405 * Old-style hash of a string *
1406 *************************************************/
1408 /* Perform the ${hash expansion operation.
1411 subject the input string (an expanded substring)
1412 value1 the length of the output string; if greater or equal to the
1413 length of the input string, the input string is returned
1414 value2 the number of hash characters to use, or 26 if negative
1415 len set to the length of the returned string
1417 Returns: pointer to the output string, or NULL if there is an error
1421 compute_hash(uschar *subject, int value1, int value2, int *len)
1423 int sublen = Ustrlen(subject);
1425 if (value2 < 0) value2 = 26;
1426 else if (value2 > Ustrlen(hashcodes))
1428 expand_string_message =
1429 string_sprintf("hash count \"%d\" too big", value2);
1433 /* Calculate the hash text. We know it is shorter than the original string, so
1434 can safely place it in subject[] (we know that subject is always itself an
1435 expanded substring). */
1437 if (value1 < sublen)
1442 while ((c = (subject[j])) != 0)
1444 int shift = (c + j++) & 7;
1445 subject[i] ^= (c << shift) | (c >> (8-shift));
1446 if (++i >= value1) i = 0;
1448 for (i = 0; i < value1; i++)
1449 subject[i] = hashcodes[(subject[i]) % value2];
1451 else value1 = sublen;
1460 /*************************************************
1461 * Numeric hash of a string *
1462 *************************************************/
1464 /* Perform the ${nhash expansion operation. The first characters of the
1465 string are treated as most important, and get the highest prime numbers.
1468 subject the input string
1469 value1 the maximum value of the first part of the result
1470 value2 the maximum value of the second part of the result,
1471 or negative to produce only a one-part result
1472 len set to the length of the returned string
1474 Returns: pointer to the output string, or NULL if there is an error.
1478 compute_nhash (uschar *subject, int value1, int value2, int *len)
1480 uschar *s = subject;
1482 unsigned long int total = 0; /* no overflow */
1486 if (i == 0) i = nelem(prime) - 1;
1487 total += prime[i--] * (unsigned int)(*s++);
1490 /* If value2 is unset, just compute one number */
1493 s = string_sprintf("%lu", total % value1);
1495 /* Otherwise do a div/mod hash */
1499 total = total % (value1 * value2);
1500 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1511 /*************************************************
1512 * Find the value of a header or headers *
1513 *************************************************/
1515 /* Multiple instances of the same header get concatenated, and this function
1516 can also return a concatenation of all the header lines. When concatenating
1517 specific headers that contain lists of addresses, a comma is inserted between
1518 them. Otherwise we use a straight concatenation. Because some messages can have
1519 pathologically large number of lines, there is a limit on the length that is
1520 returned. Also, to avoid massive store use which would result from using
1521 string_cat() as it copies and extends strings, we do a preliminary pass to find
1522 out exactly how much store will be needed. On "normal" messages this will be
1526 name the name of the header, without the leading $header_ or $h_,
1527 or NULL if a concatenation of all headers is required
1528 exists_only TRUE if called from a def: test; don't need to build a string;
1529 just return a string that is not "" and not "0" if the header
1531 newsize return the size of memory block that was obtained; may be NULL
1532 if exists_only is TRUE
1533 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1534 other than concatenating, will be done on the header. Also used
1535 for $message_headers_raw.
1536 charset name of charset to translate MIME words to; used only if
1537 want_raw is false; if NULL, no translation is done (this is
1538 used for $bh_ and $bheader_)
1540 Returns: NULL if the header does not exist, else a pointer to a new
1545 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1548 BOOL found = name == NULL;
1550 int len = found? 0 : Ustrlen(name);
1552 uschar *yield = NULL;
1555 /* Loop for two passes - saves code repetition */
1557 for (i = 0; i < 2; i++)
1562 for (h = header_list; size < header_insert_maxlen && h; h = h->next)
1563 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1564 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1569 if (exists_only) return US"1"; /* don't need actual string */
1571 t = h->text + len; /* text to insert */
1572 if (!want_raw) /* unless wanted raw, */
1573 while (isspace(*t)) t++; /* remove leading white space */
1574 ilen = h->slen - (t - h->text); /* length to insert */
1576 /* Unless wanted raw, remove trailing whitespace, including the
1580 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1582 /* Set comma = 1 if handling a single header and it's one of those
1583 that contains an address list, except when asked for raw headers. Only
1584 need to do this once. */
1586 if (!want_raw && name && comma == 0 &&
1587 Ustrchr("BCFRST", h->type) != NULL)
1590 /* First pass - compute total store needed; second pass - compute
1591 total store used, including this header. */
1593 size += ilen + comma + 1; /* +1 for the newline */
1595 /* Second pass - concatenate the data, up to a maximum. Note that
1596 the loop stops when size hits the limit. */
1600 if (size > header_insert_maxlen)
1602 ilen -= size - header_insert_maxlen - 1;
1605 Ustrncpy(ptr, t, ilen);
1608 /* For a non-raw header, put in the comma if needed, then add
1609 back the newline we removed above, provided there was some text in
1612 if (!want_raw && ilen > 0)
1614 if (comma != 0) *ptr++ = ',';
1620 /* At end of first pass, return NULL if no header found. Then truncate size
1621 if necessary, and get the buffer to hold the data, returning the buffer size.
1626 if (!found) return NULL;
1627 if (size > header_insert_maxlen) size = header_insert_maxlen;
1628 *newsize = size + 1;
1629 ptr = yield = store_get(*newsize);
1633 /* That's all we do for raw header expansion. */
1638 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1639 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1640 function can return an error with decoded data if the charset translation
1641 fails. If decoding fails, it returns NULL. */
1645 uschar *decoded, *error;
1646 if (ptr > yield && ptr[-1] == '\n') ptr--;
1647 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1649 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1653 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1654 " input was: %s\n", error, yield);
1656 if (decoded != NULL) yield = decoded;
1665 /* Append an "iprev" element to an Autherntication-Results: header
1666 if we have attempted to get the calling host's name.
1670 authres_iprev(gstring * g)
1672 if (sender_host_name)
1673 return string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1674 if (host_lookup_deferred)
1675 return string_catn(g, US";\n\tiprev=temperror", 19);
1676 if (host_lookup_failed)
1677 return string_catn(g, US";\n\tiprev=fail", 13);
1683 /*************************************************
1684 * Return list of recipients *
1685 *************************************************/
1686 /* A recipients list is available only during system message filtering,
1687 during ACL processing after DATA, and while expanding pipe commands
1688 generated from a system filter, but not elsewhere. */
1696 if (!enable_dollar_recipients) return NULL;
1698 for (i = 0; i < recipients_count; i++)
1700 /*XXX variant of list_appendele? */
1701 if (i != 0) g = string_catn(g, US", ", 2);
1702 g = string_cat(g, recipients_list[i].address);
1704 return string_from_gstring(g);
1708 /*************************************************
1709 * Find value of a variable *
1710 *************************************************/
1712 /* The table of variables is kept in alphabetic order, so we can search it
1713 using a binary chop. The "choplen" variable is nothing to do with the binary
1717 name the name of the variable being sought
1718 exists_only TRUE if this is a def: test; passed on to find_header()
1719 skipping TRUE => skip any processing evaluation; this is not the same as
1720 exists_only because def: may test for values that are first
1722 newsize pointer to an int which is initially zero; if the answer is in
1723 a new memory buffer, *newsize is set to its size
1725 Returns: NULL if the variable does not exist, or
1726 a pointer to the variable's contents, or
1727 something non-NULL if exists_only is TRUE
1731 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1738 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1739 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1740 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1741 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1742 (this gave backwards compatibility at the changeover). There may be built-in
1743 variables whose names start acl_ but they should never start in this way. This
1744 slightly messy specification is a consequence of the history, needless to say.
1746 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1747 set, in which case give an error. */
1749 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1753 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1754 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1757 /* Handle $auth<n> variables. */
1759 if (Ustrncmp(name, "auth", 4) == 0)
1762 int n = Ustrtoul(name + 4, &endptr, 10);
1763 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1764 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1766 else if (Ustrncmp(name, "regex", 5) == 0)
1769 int n = Ustrtoul(name + 5, &endptr, 10);
1770 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1771 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1774 /* For all other variables, search the table */
1776 if (!(vp = find_var_ent(name)))
1777 return NULL; /* Unknown variable name */
1779 /* Found an existing variable. If in skipping state, the value isn't needed,
1780 and we want to avoid processing (such as looking up the host name). */
1788 case vtype_filter_int:
1789 if (!filter_running) return NULL;
1793 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1797 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1801 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1805 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1809 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1812 case vtype_stringptr: /* Pointer to string */
1813 return (s = *((uschar **)(val))) ? s : US"";
1816 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1819 case vtype_load_avg:
1820 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1823 case vtype_host_lookup: /* Lookup if not done so */
1824 if ( !sender_host_name && sender_host_address
1825 && !host_lookup_failed && host_name_lookup() == OK)
1826 host_build_sender_fullhost();
1827 return sender_host_name ? sender_host_name : US"";
1829 case vtype_localpart: /* Get local part from address */
1830 s = *((uschar **)(val));
1831 if (s == NULL) return US"";
1832 domain = Ustrrchr(s, '@');
1833 if (domain == NULL) return s;
1834 if (domain - s > sizeof(var_buffer) - 1)
1835 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1836 " in string expansion", sizeof(var_buffer));
1837 Ustrncpy(var_buffer, s, domain - s);
1838 var_buffer[domain - s] = 0;
1841 case vtype_domain: /* Get domain from address */
1842 s = *((uschar **)(val));
1843 if (s == NULL) return US"";
1844 domain = Ustrrchr(s, '@');
1845 return (domain == NULL)? US"" : domain + 1;
1847 case vtype_msgheaders:
1848 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1850 case vtype_msgheaders_raw:
1851 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1853 case vtype_msgbody: /* Pointer to msgbody string */
1854 case vtype_msgbody_end: /* Ditto, the end of the msg */
1855 ss = (uschar **)(val);
1856 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1859 off_t start_offset = SPOOL_DATA_START_OFFSET;
1860 int len = message_body_visible;
1861 if (len > message_size) len = message_size;
1862 *ss = body = store_malloc(len+1);
1864 if (vp->type == vtype_msgbody_end)
1866 struct stat statbuf;
1867 if (fstat(deliver_datafile, &statbuf) == 0)
1869 start_offset = statbuf.st_size - len;
1870 if (start_offset < SPOOL_DATA_START_OFFSET)
1871 start_offset = SPOOL_DATA_START_OFFSET;
1874 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1875 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1877 len = read(deliver_datafile, body, len);
1881 if (message_body_newlines) /* Separate loops for efficiency */
1883 { if (body[--len] == 0) body[len] = ' '; }
1886 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1889 return *ss ? *ss : US"";
1891 case vtype_todbsdin: /* BSD inbox time of day */
1892 return tod_stamp(tod_bsdin);
1894 case vtype_tode: /* Unix epoch time of day */
1895 return tod_stamp(tod_epoch);
1897 case vtype_todel: /* Unix epoch/usec time of day */
1898 return tod_stamp(tod_epoch_l);
1900 case vtype_todf: /* Full time of day */
1901 return tod_stamp(tod_full);
1903 case vtype_todl: /* Log format time of day */
1904 return tod_stamp(tod_log_bare); /* (without timezone) */
1906 case vtype_todzone: /* Time zone offset only */
1907 return tod_stamp(tod_zone);
1909 case vtype_todzulu: /* Zulu time */
1910 return tod_stamp(tod_zulu);
1912 case vtype_todlf: /* Log file datestamp tod */
1913 return tod_stamp(tod_log_datestamp_daily);
1915 case vtype_reply: /* Get reply address */
1916 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1918 if (s != NULL) while (isspace(*s)) s++;
1919 if (s == NULL || *s == 0)
1921 *newsize = 0; /* For the *s==0 case */
1922 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1927 while (isspace(*s)) s++;
1928 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1929 while (t > s && isspace(t[-1])) t--;
1932 return (s == NULL)? US"" : s;
1934 case vtype_string_func:
1936 uschar * (*fn)() = val;
1943 sprintf(CS var_buffer, "%d",
1944 receive_statvfs(val == (void *)TRUE, &inodes));
1951 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1952 sprintf(CS var_buffer, "%d", inodes);
1957 return *(void **)val ? US"<cert>" : US"";
1959 #ifndef DISABLE_DKIM
1961 return dkim_exim_expand_query((int)(long)val);
1966 return NULL; /* Unknown variable. Silences static checkers. */
1973 modify_variable(uschar *name, void * value)
1976 if ((vp = find_var_ent(name))) vp->value = value;
1977 return; /* Unknown variable name, fail silently */
1985 /*************************************************
1986 * Read and expand substrings *
1987 *************************************************/
1989 /* This function is called to read and expand argument substrings for various
1990 expansion items. Some have a minimum requirement that is less than the maximum;
1991 in these cases, the first non-present one is set to NULL.
1994 sub points to vector of pointers to set
1995 n maximum number of substrings
1997 sptr points to current string pointer
1998 skipping the skipping flag
1999 check_end if TRUE, check for final '}'
2000 name name of item, for error message
2001 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2004 Returns: 0 OK; string pointer updated
2005 1 curly bracketing error (too few arguments)
2006 2 too many arguments (only if check_end is set); message set
2007 3 other error (expansion failure)
2011 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
2012 BOOL check_end, uschar *name, BOOL *resetok)
2015 const uschar *s = *sptr;
2017 while (isspace(*s)) s++;
2018 for (i = 0; i < n; i++)
2024 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2025 "(min is %d)", name, m);
2031 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2033 if (*s++ != '}') return 1;
2034 while (isspace(*s)) s++;
2036 if (check_end && *s++ != '}')
2040 expand_string_message = string_sprintf("Too many arguments for '%s' "
2041 "(max is %d)", name, n);
2044 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2055 /*************************************************
2056 * Elaborate message for bad variable *
2057 *************************************************/
2059 /* For the "unknown variable" message, take a look at the variable's name, and
2060 give additional information about possible ACL variables. The extra information
2061 is added on to expand_string_message.
2063 Argument: the name of the variable
2068 check_variable_error_message(uschar *name)
2070 if (Ustrncmp(name, "acl_", 4) == 0)
2071 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2072 (name[4] == 'c' || name[4] == 'm')?
2074 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2075 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2077 US"user-defined ACL variables must start acl_c or acl_m");
2083 Load args from sub array to globals, and call acl_check().
2084 Sub array will be corrupted on return.
2086 Returns: OK access is granted by an ACCEPT verb
2087 DISCARD access is (apparently) granted by a DISCARD verb
2088 FAIL access is denied
2089 FAIL_DROP access is denied; drop the connection
2090 DEFER can't tell at the moment
2094 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2097 int sav_narg = acl_narg;
2099 uschar * dummy_logmsg;
2100 extern int acl_where;
2102 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2103 for (i = 0; i < nsub && sub[i+1]; i++)
2105 uschar * tmp = acl_arg[i];
2106 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2107 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2112 sub[i+1] = acl_arg[i];
2113 acl_arg[i++] = NULL;
2117 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2119 acl_narg>0 ? acl_arg[0] : US"<none>",
2120 acl_narg>1 ? " +more" : "");
2122 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2124 for (i = 0; i < nsub; i++)
2125 acl_arg[i] = sub[i+1]; /* restore old args */
2126 acl_narg = sav_narg;
2134 /*************************************************
2135 * Read and evaluate a condition *
2136 *************************************************/
2140 s points to the start of the condition text
2141 resetok points to a BOOL which is written false if it is unsafe to
2142 free memory. Certain condition types (acl) may have side-effect
2143 allocation which must be preserved.
2144 yield points to a BOOL to hold the result of the condition test;
2145 if NULL, we are just reading through a condition that is
2146 part of an "or" combination to check syntax, or in a state
2147 where the answer isn't required
2149 Returns: a pointer to the first character after the condition, or
2153 static const uschar *
2154 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2156 BOOL testfor = TRUE;
2157 BOOL tempcond, combined_cond;
2159 BOOL sub2_honour_dollar = TRUE;
2160 int i, rc, cond_type, roffset;
2161 int_eximarith_t num[2];
2162 struct stat statbuf;
2164 const uschar *sub[10];
2167 const uschar *rerror;
2171 while (isspace(*s)) s++;
2172 if (*s == '!') { testfor = !testfor; s++; } else break;
2175 /* Numeric comparisons are symbolic */
2177 if (*s == '=' || *s == '>' || *s == '<')
2189 /* All other conditions are named */
2191 else s = read_name(name, 256, s, US"_");
2193 /* If we haven't read a name, it means some non-alpha character is first. */
2197 expand_string_message = string_sprintf("condition name expected, "
2198 "but found \"%.16s\"", s);
2202 /* Find which condition we are dealing with, and switch on it */
2204 cond_type = chop_match(name, cond_table, nelem(cond_table));
2207 /* def: tests for a non-empty variable, or for the existence of a header. If
2208 yield == NULL we are in a skipping state, and don't care about the answer. */
2213 expand_string_message = US"\":\" expected after \"def\"";
2217 s = read_name(name, 256, s+1, US"_");
2219 /* Test for a header's existence. If the name contains a closing brace
2220 character, this may be a user error where the terminating colon has been
2221 omitted. Set a flag to adjust a subsequent error message in this case. */
2223 if (Ustrncmp(name, "h_", 2) == 0 ||
2224 Ustrncmp(name, "rh_", 3) == 0 ||
2225 Ustrncmp(name, "bh_", 3) == 0 ||
2226 Ustrncmp(name, "header_", 7) == 0 ||
2227 Ustrncmp(name, "rheader_", 8) == 0 ||
2228 Ustrncmp(name, "bheader_", 8) == 0)
2230 s = read_header_name(name, 256, s);
2231 /* {-for-text-editors */
2232 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2233 if (yield != NULL) *yield =
2234 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2237 /* Test for a variable's having a non-empty value. A non-existent variable
2238 causes an expansion failure. */
2242 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2245 expand_string_message = (name[0] == 0)?
2246 string_sprintf("variable name omitted after \"def:\"") :
2247 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2248 check_variable_error_message(name);
2251 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2257 /* first_delivery tests for first delivery attempt */
2259 case ECOND_FIRST_DELIVERY:
2260 if (yield != NULL) *yield = deliver_firsttime == testfor;
2264 /* queue_running tests for any process started by a queue runner */
2266 case ECOND_QUEUE_RUNNING:
2267 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2271 /* exists: tests for file existence
2272 isip: tests for any IP address
2273 isip4: tests for an IPv4 address
2274 isip6: tests for an IPv6 address
2275 pam: does PAM authentication
2276 radius: does RADIUS authentication
2277 ldapauth: does LDAP authentication
2278 pwcheck: does Cyrus SASL pwcheck authentication
2287 case ECOND_LDAPAUTH:
2290 while (isspace(*s)) s++;
2291 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2293 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2294 if (sub[0] == NULL) return NULL;
2295 /* {-for-text-editors */
2296 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2298 if (yield == NULL) return s; /* No need to run the test if skipping */
2303 if ((expand_forbid & RDO_EXISTS) != 0)
2305 expand_string_message = US"File existence tests are not permitted";
2308 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2314 rc = string_is_ip_address(sub[0], NULL);
2315 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2316 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2319 /* Various authentication tests - all optionally compiled */
2323 rc = auth_call_pam(sub[0], &expand_string_message);
2326 goto COND_FAILED_NOT_COMPILED;
2327 #endif /* SUPPORT_PAM */
2330 #ifdef RADIUS_CONFIG_FILE
2331 rc = auth_call_radius(sub[0], &expand_string_message);
2334 goto COND_FAILED_NOT_COMPILED;
2335 #endif /* RADIUS_CONFIG_FILE */
2337 case ECOND_LDAPAUTH:
2340 /* Just to keep the interface the same */
2342 int old_pool = store_pool;
2343 store_pool = POOL_SEARCH;
2344 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2345 &expand_string_message, &do_cache);
2346 store_pool = old_pool;
2350 goto COND_FAILED_NOT_COMPILED;
2351 #endif /* LOOKUP_LDAP */
2354 #ifdef CYRUS_PWCHECK_SOCKET
2355 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2358 goto COND_FAILED_NOT_COMPILED;
2359 #endif /* CYRUS_PWCHECK_SOCKET */
2361 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2362 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2364 if (rc == ERROR || rc == DEFER) return NULL;
2365 *yield = (rc == OK) == testfor;
2371 /* call ACL (in a conditional context). Accept true, deny false.
2372 Defer is a forced-fail. Anything set by message= goes to $value.
2373 Up to ten parameters are used; we use the braces round the name+args
2374 like the saslauthd condition does, to permit a variable number of args.
2375 See also the expansion-item version EITEM_ACL and the traditional
2376 acl modifier ACLC_ACL.
2377 Since the ACL may allocate new global variables, tell our caller to not
2382 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2388 while (isspace(*s)) s++;
2389 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2391 switch(read_subs(sub, nelem(sub), 1,
2392 &s, yield == NULL, TRUE, US"acl", resetok))
2394 case 1: expand_string_message = US"too few arguments or bracketing "
2397 case 3: return NULL;
2402 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2403 switch(eval_acl(sub, nelem(sub), &user_msg))
2408 lookup_value = NULL;
2410 lookup_value = string_copy(user_msg);
2411 *yield = cond == testfor;
2415 expand_string_forcedfail = TRUE;
2418 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2426 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2428 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2430 However, the last two are optional. That is why the whole set is enclosed
2431 in their own set of braces. */
2433 case ECOND_SASLAUTHD:
2434 #ifndef CYRUS_SASLAUTHD_SOCKET
2435 goto COND_FAILED_NOT_COMPILED;
2439 while (isspace(*s)) s++;
2440 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2441 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2444 case 1: expand_string_message = US"too few arguments or bracketing "
2445 "error for saslauthd";
2447 case 3: return NULL;
2449 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2452 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2453 &expand_string_message);
2454 if (rc == ERROR || rc == DEFER) return NULL;
2455 *yield = (rc == OK) == testfor;
2459 #endif /* CYRUS_SASLAUTHD_SOCKET */
2462 /* symbolic operators for numeric and string comparison, and a number of
2463 other operators, all requiring two arguments.
2465 crypteq: encrypts plaintext and compares against an encrypted text,
2466 using crypt(), crypt16(), MD5 or SHA-1
2467 inlist/inlisti: checks if first argument is in the list of the second
2468 match: does a regular expression match and sets up the numerical
2469 variables if it succeeds
2470 match_address: matches in an address list
2471 match_domain: matches in a domain list
2472 match_ip: matches a host list that is restricted to IP addresses
2473 match_local_part: matches in a local part list
2476 case ECOND_MATCH_ADDRESS:
2477 case ECOND_MATCH_DOMAIN:
2478 case ECOND_MATCH_IP:
2479 case ECOND_MATCH_LOCAL_PART:
2480 #ifndef EXPAND_LISTMATCH_RHS
2481 sub2_honour_dollar = FALSE;
2490 case ECOND_NUM_L: /* Numerical comparisons */
2497 case ECOND_STR_LT: /* String comparisons */
2508 for (i = 0; i < 2; i++)
2510 /* Sometimes, we don't expand substrings; too many insecure configurations
2511 created using match_address{}{} and friends, where the second param
2512 includes information from untrustworthy sources. */
2513 BOOL honour_dollar = TRUE;
2514 if ((i > 0) && !sub2_honour_dollar)
2515 honour_dollar = FALSE;
2517 while (isspace(*s)) s++;
2520 if (i == 0) goto COND_FAILED_CURLY_START;
2521 expand_string_message = string_sprintf("missing 2nd string in {} "
2522 "after \"%s\"", name);
2525 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2526 honour_dollar, resetok)))
2528 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2529 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2530 " for security reasons\n");
2531 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2533 /* Convert to numerical if required; we know that the names of all the
2534 conditions that compare numbers do not start with a letter. This just saves
2535 checking for them individually. */
2537 if (!isalpha(name[0]) && yield != NULL)
2542 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2546 num[i] = expanded_string_integer(sub[i], FALSE);
2547 if (expand_string_message != NULL) return NULL;
2551 /* Result not required */
2553 if (yield == NULL) return s;
2555 /* Do an appropriate comparison */
2561 tempcond = (num[0] == num[1]);
2565 tempcond = (num[0] > num[1]);
2569 tempcond = (num[0] >= num[1]);
2573 tempcond = (num[0] < num[1]);
2577 tempcond = (num[0] <= num[1]);
2581 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2585 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2589 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2593 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
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);
2620 case ECOND_MATCH: /* Regular expression match */
2621 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2625 expand_string_message = string_sprintf("regular expression error in "
2626 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2629 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2632 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2633 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2634 goto MATCHED_SOMETHING;
2636 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2637 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2638 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2639 goto MATCHED_SOMETHING;
2641 case ECOND_MATCH_IP: /* Match IP address in a host list */
2642 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2644 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2650 unsigned int *nullcache = NULL;
2651 check_host_block cb;
2653 cb.host_name = US"";
2654 cb.host_address = sub[0];
2656 /* If the host address starts off ::ffff: it is an IPv6 address in
2657 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2660 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2661 cb.host_address + 7 : cb.host_address;
2663 rc = match_check_list(
2664 &sub[1], /* the list */
2665 0, /* separator character */
2666 &hostlist_anchor, /* anchor pointer */
2667 &nullcache, /* cache pointer */
2668 check_host, /* function for testing */
2669 &cb, /* argument for function */
2670 MCL_HOST, /* type of check */
2671 sub[0], /* text for debugging */
2672 NULL); /* where to pass back data */
2674 goto MATCHED_SOMETHING;
2676 case ECOND_MATCH_LOCAL_PART:
2677 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2678 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2693 expand_string_message = string_sprintf("unable to complete match "
2694 "against \"%s\": %s", sub[1], search_error_message);
2700 /* Various "encrypted" comparisons. If the second string starts with
2701 "{" then an encryption type is given. Default to crypt() or crypt16()
2702 (build-time choice). */
2703 /* }-for-text-editors */
2706 #ifndef SUPPORT_CRYPTEQ
2707 goto COND_FAILED_NOT_COMPILED;
2709 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2711 int sublen = Ustrlen(sub[1]+5);
2716 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2718 /* If the length that we are comparing against is 24, the MD5 digest
2719 is expressed as a base64 string. This is the way LDAP does it. However,
2720 some other software uses a straightforward hex representation. We assume
2721 this if the length is 32. Other lengths fail. */
2725 uschar *coded = b64encode(digest, 16);
2726 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2727 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2728 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2730 else if (sublen == 32)
2734 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2736 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2737 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2738 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2742 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2743 "fail\n crypted=%s\n", sub[1]+5);
2748 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2750 int sublen = Ustrlen(sub[1]+6);
2755 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2757 /* If the length that we are comparing against is 28, assume the SHA1
2758 digest is expressed as a base64 string. If the length is 40, assume a
2759 straightforward hex representation. Other lengths fail. */
2763 uschar *coded = b64encode(digest, 20);
2764 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2765 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2766 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2768 else if (sublen == 40)
2772 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2774 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2775 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2776 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2780 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2781 "fail\n crypted=%s\n", sub[1]+6);
2786 else /* {crypt} or {crypt16} and non-{ at start */
2787 /* }-for-text-editors */
2792 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2797 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2802 else if (sub[1][0] == '{') /* }-for-text-editors */
2804 expand_string_message = string_sprintf("unknown encryption mechanism "
2805 "in \"%s\"", sub[1]);
2811 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2812 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2813 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2817 #define XSTR(s) STR(s)
2818 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2819 " subject=%s\n crypted=%s\n",
2820 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2825 /* If the encrypted string contains fewer than two characters (for the
2826 salt), force failure. Otherwise we get false positives: with an empty
2827 string the yield of crypt() is an empty string! */
2830 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2831 else if (errno == EINVAL)
2835 expand_string_message = string_sprintf("crypt error: %s\n",
2836 US strerror(errno));
2841 #endif /* SUPPORT_CRYPTEQ */
2846 const uschar * list = sub[1];
2848 uschar *save_iterate_item = iterate_item;
2849 int (*compare)(const uschar *, const uschar *);
2851 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", name, sub[0]);
2854 compare = cond_type == ECOND_INLISTI
2855 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2857 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2859 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
2860 if (compare(sub[0], iterate_item) == 0)
2866 iterate_item = save_iterate_item;
2869 } /* Switch for comparison conditions */
2871 *yield = tempcond == testfor;
2872 return s; /* End of comparison conditions */
2875 /* and/or: computes logical and/or of several conditions */
2879 subcondptr = (yield == NULL)? NULL : &tempcond;
2880 combined_cond = (cond_type == ECOND_AND);
2882 while (isspace(*s)) s++;
2883 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2887 while (isspace(*s)) s++;
2888 /* {-for-text-editors */
2889 if (*s == '}') break;
2890 if (*s != '{') /* }-for-text-editors */
2892 expand_string_message = string_sprintf("each subcondition "
2893 "inside an \"%s{...}\" condition must be in its own {}", name);
2897 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2899 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2900 expand_string_message, name);
2903 while (isspace(*s)) s++;
2905 /* {-for-text-editors */
2908 /* {-for-text-editors */
2909 expand_string_message = string_sprintf("missing } at end of condition "
2910 "inside \"%s\" group", name);
2916 if (cond_type == ECOND_AND)
2918 combined_cond &= tempcond;
2919 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2920 } /* evaluate any more */
2923 combined_cond |= tempcond;
2924 if (combined_cond) subcondptr = NULL; /* once true, don't */
2925 } /* evaluate any more */
2929 if (yield != NULL) *yield = (combined_cond == testfor);
2933 /* forall/forany: iterates a condition with different values */
2938 const uschar * list;
2940 uschar *save_iterate_item = iterate_item;
2942 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2944 while (isspace(*s)) s++;
2945 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2946 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2947 if (sub[0] == NULL) return NULL;
2948 /* {-for-text-editors */
2949 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2951 while (isspace(*s)) s++;
2952 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2956 /* Call eval_condition once, with result discarded (as if scanning a
2957 "false" part). This allows us to find the end of the condition, because if
2958 the list it empty, we won't actually evaluate the condition for real. */
2960 if (!(s = eval_condition(sub[1], resetok, NULL)))
2962 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2963 expand_string_message, name);
2966 while (isspace(*s)) s++;
2968 /* {-for-text-editors */
2971 /* {-for-text-editors */
2972 expand_string_message = string_sprintf("missing } at end of condition "
2973 "inside \"%s\"", name);
2977 if (yield != NULL) *yield = !testfor;
2979 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2981 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, iterate_item);
2982 if (!eval_condition(sub[1], resetok, &tempcond))
2984 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2985 expand_string_message, name);
2986 iterate_item = save_iterate_item;
2989 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", name,
2990 tempcond? "true":"false");
2992 if (yield != NULL) *yield = (tempcond == testfor);
2993 if (tempcond == (cond_type == ECOND_FORANY)) break;
2996 iterate_item = save_iterate_item;
3001 /* The bool{} expansion condition maps a string to boolean.
3002 The values supported should match those supported by the ACL condition
3003 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3004 of true/false. Note that Router "condition" rules have a different
3005 interpretation, where general data can be used and only a few values
3007 Note that readconf.c boolean matching, for boolean configuration options,
3008 only matches true/yes/false/no.
3009 The bool_lax{} condition matches the Router logic, which is much more
3012 case ECOND_BOOL_LAX:
3018 BOOL boolvalue = FALSE;
3019 while (isspace(*s)) s++;
3020 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3021 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3022 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3024 case 1: expand_string_message = string_sprintf(
3025 "too few arguments or bracketing error for %s",
3029 case 3: return NULL;
3032 while (isspace(*t)) t++;
3036 /* trailing whitespace: seems like a good idea to ignore it too */
3038 while (isspace(*t2)) t2--;
3039 if (t2 != (t + len))
3046 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3047 /* logic for the lax case from expand_check_condition(), which also does
3048 expands, and the logic is both short and stable enough that there should
3049 be no maintenance burden from replicating it. */
3053 ? Ustrspn(t+1, "0123456789") == len-1
3054 : Ustrspn(t, "0123456789") == len)
3056 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3057 /* expand_check_condition only does a literal string "0" check */
3058 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3061 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3063 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3065 else if (cond_type == ECOND_BOOL_LAX)
3069 expand_string_message = string_sprintf("unrecognised boolean "
3073 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3074 boolvalue? "true":"false");
3075 if (yield != NULL) *yield = (boolvalue == testfor);
3079 /* Unknown condition */
3082 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3084 } /* End switch on condition type */
3086 /* Missing braces at start and end of data */
3088 COND_FAILED_CURLY_START:
3089 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3092 COND_FAILED_CURLY_END:
3093 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3097 /* A condition requires code that is not compiled */
3099 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3100 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3101 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3102 COND_FAILED_NOT_COMPILED:
3103 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3112 /*************************************************
3113 * Save numerical variables *
3114 *************************************************/
3116 /* This function is called from items such as "if" that want to preserve and
3117 restore the numbered variables.
3120 save_expand_string points to an array of pointers to set
3121 save_expand_nlength points to an array of ints for the lengths
3123 Returns: the value of expand max to save
3127 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3130 for (i = 0; i <= expand_nmax; i++)
3132 save_expand_nstring[i] = expand_nstring[i];
3133 save_expand_nlength[i] = expand_nlength[i];
3140 /*************************************************
3141 * Restore numerical variables *
3142 *************************************************/
3144 /* This function restored saved values of numerical strings.
3147 save_expand_nmax the number of strings to restore
3148 save_expand_string points to an array of pointers
3149 save_expand_nlength points to an array of ints
3155 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3156 int *save_expand_nlength)
3159 expand_nmax = save_expand_nmax;
3160 for (i = 0; i <= expand_nmax; i++)
3162 expand_nstring[i] = save_expand_nstring[i];
3163 expand_nlength[i] = save_expand_nlength[i];
3171 /*************************************************
3172 * Handle yes/no substrings *
3173 *************************************************/
3175 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3176 alternative substrings that depend on whether or not the condition was true,
3177 or the lookup or extraction succeeded. The substrings always have to be
3178 expanded, to check their syntax, but "skipping" is set when the result is not
3179 needed - this avoids unnecessary nested lookups.
3182 skipping TRUE if we were skipping when this item was reached
3183 yes TRUE if the first string is to be used, else use the second
3184 save_lookup a value to put back into lookup_value before the 2nd expansion
3185 sptr points to the input string pointer
3186 yieldptr points to the output growable-string pointer
3187 type "lookup", "if", "extract", "run", "env", "listextract" or
3188 "certextract" for error message
3189 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3192 Returns: 0 OK; lookup_value has been reset to save_lookup
3194 2 expansion failed because of bracketing error
3198 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3199 gstring ** yieldptr, uschar *type, BOOL *resetok)
3202 const uschar *s = *sptr; /* Local value */
3203 uschar *sub1, *sub2;
3204 const uschar * errwhere;
3206 /* If there are no following strings, we substitute the contents of $value for
3207 lookups and for extractions in the success case. For the ${if item, the string
3208 "true" is substituted. In the fail case, nothing is substituted for all three
3211 while (isspace(*s)) s++;
3216 if (yes && !skipping)
3217 *yieldptr = string_catn(*yieldptr, US"true", 4);
3221 if (yes && lookup_value && !skipping)
3222 *yieldptr = string_cat(*yieldptr, lookup_value);
3223 lookup_value = save_lookup;
3229 /* The first following string must be braced. */
3233 errwhere = US"'yes' part did not start with '{'";
3237 /* Expand the first substring. Forced failures are noticed only if we actually
3238 want this string. Set skipping in the call in the fail case (this will always
3239 be the case if we were already skipping). */
3241 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3242 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3243 expand_string_forcedfail = FALSE;
3246 errwhere = US"'yes' part did not end with '}'";
3250 /* If we want the first string, add it to the output */
3253 *yieldptr = string_cat(*yieldptr, sub1);
3255 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3256 $value to what it was at the start of the item, so that it has this value
3257 during the second string expansion. For the call from "if" or "run" to this
3258 function, save_lookup is set to lookup_value, so that this statement does
3261 lookup_value = save_lookup;
3263 /* There now follows either another substring, or "fail", or nothing. This
3264 time, forced failures are noticed only if we want the second string. We must
3265 set skipping in the nested call if we don't want this string, or if we were
3266 already skipping. */
3268 while (isspace(*s)) s++;
3271 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3272 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3273 expand_string_forcedfail = FALSE;
3276 errwhere = US"'no' part did not start with '{'";
3280 /* If we want the second string, add it to the output */
3283 *yieldptr = string_cat(*yieldptr, sub2);
3286 /* If there is no second string, but the word "fail" is present when the use of
3287 the second string is wanted, set a flag indicating it was a forced failure
3288 rather than a syntactic error. Swallow the terminating } in case this is nested
3289 inside another lookup or if or extract. */
3294 /* deconst cast ok here as source is s anyway */
3295 s = US read_name(name, sizeof(name), s, US"_");
3296 if (Ustrcmp(name, "fail") == 0)
3298 if (!yes && !skipping)
3300 while (isspace(*s)) s++;
3303 errwhere = US"did not close with '}' after forcedfail";
3306 expand_string_message =
3307 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3308 expand_string_forcedfail = TRUE;
3314 expand_string_message =
3315 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3320 /* All we have to do now is to check on the final closing brace. */
3322 while (isspace(*s)) s++;
3325 errwhere = US"did not close with '}'";
3331 /* Update the input pointer value before returning */
3336 /* Get here if there is a bracketing failure */
3337 expand_string_message = string_sprintf(
3338 "curly-bracket problem in conditional yes/no parsing: %s\n"
3339 " remaining string is '%s'", errwhere, --s);
3344 /* Get here for other failures */
3352 /*************************************************
3353 * Handle MD5 or SHA-1 computation for HMAC *
3354 *************************************************/
3356 /* These are some wrapping functions that enable the HMAC code to be a bit
3357 cleaner. A good compiler will spot the tail recursion.
3360 type HMAC_MD5 or HMAC_SHA1
3361 remaining are as for the cryptographic hash functions
3367 chash_start(int type, void *base)
3369 if (type == HMAC_MD5)
3370 md5_start((md5 *)base);
3372 sha1_start((hctx *)base);
3376 chash_mid(int type, void *base, uschar *string)
3378 if (type == HMAC_MD5)
3379 md5_mid((md5 *)base, string);
3381 sha1_mid((hctx *)base, string);
3385 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3387 if (type == HMAC_MD5)
3388 md5_end((md5 *)base, string, length, digest);
3390 sha1_end((hctx *)base, string, length, digest);
3397 /********************************************************
3398 * prvs: Get last three digits of days since Jan 1, 1970 *
3399 ********************************************************/
3401 /* This is needed to implement the "prvs" BATV reverse
3404 Argument: integer "days" offset to add or substract to
3405 or from the current number of days.
3407 Returns: pointer to string containing the last three
3408 digits of the number of days since Jan 1, 1970,
3409 modified by the offset argument, NULL if there
3410 was an error in the conversion.
3415 prvs_daystamp(int day_offset)
3417 uschar *days = store_get(32); /* Need at least 24 for cases */
3418 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3419 (time(NULL) + day_offset*86400)/86400);
3420 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3425 /********************************************************
3426 * prvs: perform HMAC-SHA1 computation of prvs bits *
3427 ********************************************************/
3429 /* This is needed to implement the "prvs" BATV reverse
3433 address RFC2821 Address to use
3434 key The key to use (must be less than 64 characters
3436 key_num Single-digit key number to use. Defaults to
3439 Returns: pointer to string containing the first three
3440 bytes of the final hash in hex format, NULL if
3441 there was an error in the process.
3445 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3447 gstring * hash_source;
3451 uschar innerhash[20];
3452 uschar finalhash[20];
3453 uschar innerkey[64];
3454 uschar outerkey[64];
3455 uschar *finalhash_hex = store_get(40);
3457 if (key_num == NULL)
3460 if (Ustrlen(key) > 64)
3463 hash_source = string_catn(NULL, key_num, 1);
3464 hash_source = string_catn(hash_source, daystamp, 3);
3465 hash_source = string_cat(hash_source, address);
3466 (void) string_from_gstring(hash_source);
3469 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3471 memset(innerkey, 0x36, 64);
3472 memset(outerkey, 0x5c, 64);
3474 for (i = 0; i < Ustrlen(key); i++)
3476 innerkey[i] ^= key[i];
3477 outerkey[i] ^= key[i];
3480 chash_start(HMAC_SHA1, &h);
3481 chash_mid(HMAC_SHA1, &h, innerkey);
3482 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3484 chash_start(HMAC_SHA1, &h);
3485 chash_mid(HMAC_SHA1, &h, outerkey);
3486 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3489 for (i = 0; i < 3; i++)
3491 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3492 *p++ = hex_digits[finalhash[i] & 0x0f];
3496 return finalhash_hex;
3502 /*************************************************
3503 * Join a file onto the output string *
3504 *************************************************/
3506 /* This is used for readfile/readsock and after a run expansion.
3507 It joins the contents of a file onto the output string, globally replacing
3508 newlines with a given string (optionally).
3512 yield pointer to the expandable string struct
3513 eol newline replacement string, or NULL
3515 Returns: new pointer for expandable string, terminated if non-null
3519 cat_file(FILE *f, gstring *yield, uschar *eol)
3521 uschar buffer[1024];
3523 while (Ufgets(buffer, sizeof(buffer), f))
3525 int len = Ustrlen(buffer);
3526 if (eol && buffer[len-1] == '\n') len--;
3527 yield = string_catn(yield, buffer, len);
3528 if (eol && buffer[len])
3529 yield = string_cat(yield, eol);
3532 (void) string_from_gstring(yield);
3539 /*************************************************
3540 * Evaluate numeric expression *
3541 *************************************************/
3543 /* This is a set of mutually recursive functions that evaluate an arithmetic
3544 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3545 these functions that is called from elsewhere is eval_expr, whose interface is:
3548 sptr pointer to the pointer to the string - gets updated
3549 decimal TRUE if numbers are to be assumed decimal
3550 error pointer to where to put an error message - must be NULL on input
3551 endket TRUE if ')' must terminate - FALSE for external call
3553 Returns: on success: the value of the expression, with *error still NULL
3554 on failure: an undefined value, with *error = a message
3557 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3560 static int_eximarith_t
3561 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3564 int_eximarith_t x = eval_op_or(&s, decimal, error);
3570 *error = US"expecting closing parenthesis";
3572 while (isspace(*(++s)));
3574 else if (*s != 0) *error = US"expecting operator";
3581 static int_eximarith_t
3582 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3587 while (isspace(*s)) s++;
3592 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3594 switch (tolower(*s))
3597 case 'k': n *= 1024; s++; break;
3598 case 'm': n *= 1024*1024; s++; break;
3599 case 'g': n *= 1024*1024*1024; s++; break;
3601 while (isspace (*s)) s++;
3606 n = eval_expr(&s, decimal, error, 1);
3610 *error = US"expecting number or opening parenthesis";
3618 static int_eximarith_t
3619 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3623 while (isspace(*s)) s++;
3624 if (*s == '+' || *s == '-' || *s == '~')
3627 x = eval_op_unary(&s, decimal, error);
3628 if (op == '-') x = -x;
3629 else if (op == '~') x = ~x;
3633 x = eval_number(&s, decimal, error);
3640 static int_eximarith_t
3641 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3644 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3647 while (*s == '*' || *s == '/' || *s == '%')
3650 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3651 if (*error != NULL) break;
3652 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3653 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3654 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3655 * -N*M is INT_MIN will yield INT_MIN.
3656 * Since we don't support floating point, this is somewhat simpler.
3657 * Ideally, we'd return an error, but since we overflow for all other
3658 * arithmetic, consistency suggests otherwise, but what's the correct value
3659 * to use? There is none.
3660 * The C standard guarantees overflow for unsigned arithmetic but signed
3661 * overflow invokes undefined behaviour; in practice, this is overflow
3662 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3663 * that long/longlong larger than int are available, or we could just work
3664 * with larger types. We should consider whether to guarantee 32bit eval
3665 * and 64-bit working variables, with errors returned. For now ...
3666 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3667 * can just let the other invalid results occur otherwise, as they have
3668 * until now. For this one case, we can coerce.
3670 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3673 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3674 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3684 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3700 static int_eximarith_t
3701 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3704 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3707 while (*s == '+' || *s == '-')
3710 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3712 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3713 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3714 { /* over-conservative check */
3716 ? US"overflow in sum" : US"overflow in difference";
3719 if (op == '+') x += y; else x -= y;
3727 static int_eximarith_t
3728 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3731 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3734 while ((*s == '<' || *s == '>') && s[1] == s[0])
3739 y = eval_op_sum(&s, decimal, error);
3740 if (*error != NULL) break;
3741 if (op == '<') x <<= y; else x >>= y;
3749 static int_eximarith_t
3750 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3753 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3760 y = eval_op_shift(&s, decimal, error);
3761 if (*error != NULL) break;
3770 static int_eximarith_t
3771 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3774 int_eximarith_t x = eval_op_and(&s, decimal, error);
3781 y = eval_op_and(&s, decimal, error);
3782 if (*error != NULL) break;
3791 static int_eximarith_t
3792 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3795 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3802 y = eval_op_xor(&s, decimal, error);
3803 if (*error != NULL) break;
3813 /*************************************************
3815 *************************************************/
3817 /* Returns either an unchanged string, or the expanded string in stacking pool
3818 store. Interpreted sequences are:
3820 \... normal escaping rules
3821 $name substitutes the variable
3823 ${op:string} operates on the expanded string value
3824 ${item{arg1}{arg2}...} expands the args and then does the business
3825 some literal args are not enclosed in {}
3827 There are now far too many operators and item types to make it worth listing
3828 them here in detail any more.
3830 We use an internal routine recursively to handle embedded substrings. The
3831 external function follows. The yield is NULL if the expansion failed, and there
3832 are two cases: if something collapsed syntactically, or if "fail" was given
3833 as the action on a lookup failure. These can be distinguished by looking at the
3834 variable expand_string_forcedfail, which is TRUE in the latter case.
3836 The skipping flag is set true when expanding a substring that isn't actually
3837 going to be used (after "if" or "lookup") and it prevents lookups from
3838 happening lower down.
3840 Store usage: At start, a store block of the length of the input plus 64
3841 is obtained. This is expanded as necessary by string_cat(), which might have to
3842 get a new block, or might be able to expand the original. At the end of the
3843 function we can release any store above that portion of the yield block that
3844 was actually used. In many cases this will be optimal.
3846 However: if the first item in the expansion is a variable name or header name,
3847 we reset the store before processing it; if the result is in fresh store, we
3848 use that without copying. This is helpful for expanding strings like
3849 $message_headers which can get very long.
3851 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3852 since resetting the store at the end of the expansion will free store that was
3853 allocated by the plugin code as well as the slop after the expanded string. So
3854 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3855 and, given the acl condition, ${if }. This is an unfortunate consequence of
3856 string expansion becoming too powerful.
3859 string the string to be expanded
3860 ket_ends true if expansion is to stop at }
3861 left if not NULL, a pointer to the first character after the
3862 expansion is placed here (typically used with ket_ends)
3863 skipping TRUE for recursive calls when the value isn't actually going
3864 to be used (to allow for optimisation)
3865 honour_dollar TRUE if $ is to be expanded,
3866 FALSE if it's just another character
3867 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3870 Returns: NULL if expansion fails:
3871 expand_string_forcedfail is set TRUE if failure was forced
3872 expand_string_message contains a textual error message
3873 a pointer to the expanded string on success
3877 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3878 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3880 gstring * yield = string_get(Ustrlen(string) + 64);
3882 const uschar *s = string;
3883 uschar *save_expand_nstring[EXPAND_MAXN+1];
3884 int save_expand_nlength[EXPAND_MAXN+1];
3885 BOOL resetok = TRUE;
3889 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
3891 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
3895 expand_string_forcedfail = FALSE;
3896 expand_string_message = US"";
3903 /* \ escapes the next character, which must exist, or else
3904 the expansion fails. There's a special escape, \N, which causes
3905 copying of the subject verbatim up to the next \N. Otherwise,
3906 the escapes are the standard set. */
3912 expand_string_message = US"\\ at end of string";
3918 const uschar * t = s + 2;
3919 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3920 yield = string_catn(yield, t, s - t);
3921 if (*s != 0) s += 2;
3927 ch[0] = string_interpret_escape(&s);
3929 yield = string_catn(yield, ch, 1);
3936 /* Anything other than $ is just copied verbatim, unless we are
3937 looking for a terminating } character. */
3940 if (ket_ends && *s == '}') break;
3942 if (*s != '$' || !honour_dollar)
3944 yield = string_catn(yield, s++, 1);
3948 /* No { after the $ - must be a plain name or a number for string
3949 match variable. There has to be a fudge for variables that are the
3950 names of header fields preceded by "$header_" because header field
3951 names can contain any printing characters except space and colon.
3952 For those that don't like typing this much, "$h_" is a synonym for
3953 "$header_". A non-existent header yields a NULL value; nothing is
3956 if (isalpha((*(++s))))
3962 s = read_name(name, sizeof(name), s, US"_");
3964 /* If this is the first thing to be expanded, release the pre-allocated
3968 g = store_get(sizeof(gstring));
3969 else if (yield->ptr == 0)
3971 if (resetok) store_reset(yield);
3973 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
3978 if (Ustrncmp(name, "h_", 2) == 0 ||
3979 Ustrncmp(name, "rh_", 3) == 0 ||
3980 Ustrncmp(name, "bh_", 3) == 0 ||
3981 Ustrncmp(name, "header_", 7) == 0 ||
3982 Ustrncmp(name, "rheader_", 8) == 0 ||
3983 Ustrncmp(name, "bheader_", 8) == 0)
3985 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3986 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3987 s = read_header_name(name, sizeof(name), s);
3988 value = find_header(name, FALSE, &newsize, want_raw, charset);
3990 /* If we didn't find the header, and the header contains a closing brace
3991 character, this may be a user error where the terminating colon
3992 has been omitted. Set a flag to adjust the error message in this case.
3993 But there is no error here - nothing gets inserted. */
3997 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
4004 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4006 expand_string_message =
4007 string_sprintf("unknown variable name \"%s\"", name);
4008 check_variable_error_message(name);
4012 /* If the data is known to be in a new buffer, newsize will be set to the
4013 size of that buffer. If this is the first thing in an expansion string,
4014 yield will be NULL; just point it at the new store instead of copying. Many
4015 expansion strings contain just one reference, so this is a useful
4016 optimization, especially for humungous headers. We need to use a gstring
4017 structure that is not allocated after that new-buffer, else a later store
4018 reset in the middle of the buffer will make it inaccessible. */
4020 len = Ustrlen(value);
4021 if (!yield && newsize != 0)
4024 yield->size = newsize;
4029 yield = string_catn(yield, value, len);
4037 s = read_cnumber(&n, s);
4038 if (n >= 0 && n <= expand_nmax)
4039 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4043 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4045 if (*s != '{') /*}*/
4047 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4051 /* After { there can be various things, but they all start with
4052 an initial word, except for a number for a string match variable. */
4054 if (isdigit((*(++s))))
4057 s = read_cnumber(&n, s); /*{*/
4060 expand_string_message = US"} expected after number";
4063 if (n >= 0 && n <= expand_nmax)
4064 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4070 expand_string_message = US"letter or digit expected after ${"; /*}*/
4074 /* Allow "-" in names to cater for substrings with negative
4075 arguments. Since we are checking for known names after { this is
4078 s = read_name(name, sizeof(name), s, US"_-");
4079 item_type = chop_match(name, item_table, nelem(item_table));
4083 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4084 If the ACL returns accept or reject we return content set by "message ="
4085 There is currently no limit on recursion; this would have us call
4086 acl_check_internal() directly and get a current level from somewhere.
4087 See also the acl expansion condition ECOND_ACL and the traditional
4088 acl modifier ACLC_ACL.
4089 Assume that the function has side-effects on the store that must be preserved.
4093 /* ${acl {name} {arg1}{arg2}...} */
4095 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4098 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4101 case 1: goto EXPAND_FAILED_CURLY;
4103 case 3: goto EXPAND_FAILED;
4105 if (skipping) continue;
4108 switch(eval_acl(sub, nelem(sub), &user_msg))
4113 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4115 yield = string_cat(yield, user_msg);
4119 expand_string_forcedfail = TRUE;
4122 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4127 case EITEM_AUTHRESULTS:
4128 /* ${authresults {mysystemname}} */
4132 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4135 case 1: goto EXPAND_FAILED_CURLY;
4137 case 3: goto EXPAND_FAILED;
4140 yield = string_append(yield, 3,
4141 US"Authentication-Results: ", sub_arg[0], US"; none");
4144 yield = authres_iprev(yield);
4145 yield = authres_smtpauth(yield);
4147 yield = authres_spf(yield);
4149 #ifndef DISABLE_DKIM
4150 yield = authres_dkim(yield);
4152 #ifdef EXPERIMENTAL_DMARC
4153 yield = authres_dmarc(yield);
4155 #ifdef EXPERIMENTAL_ARC
4156 yield = authres_arc(yield);
4161 /* Handle conditionals - preserve the values of the numerical expansion
4162 variables in case they get changed by a regular expression match in the
4163 condition. If not, they retain their external settings. At the end
4164 of this "if" section, they get restored to their previous values. */
4169 const uschar *next_s;
4170 int save_expand_nmax =
4171 save_expand_strings(save_expand_nstring, save_expand_nlength);
4173 while (isspace(*s)) s++;
4174 next_s = eval_condition(s, &resetok, skipping ? NULL : &cond);
4175 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4179 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4180 "condition: %.*s\n",
4181 (int)(next_s - s), s);
4182 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4183 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4185 cond ? "true" : "false");
4190 /* The handling of "yes" and "no" result strings is now in a separate
4191 function that is also used by ${lookup} and ${extract} and ${run}. */
4193 switch(process_yesno(
4194 skipping, /* were previously skipping */
4195 cond, /* success/failure indicator */
4196 lookup_value, /* value to reset for string2 */
4197 &s, /* input pointer */
4198 &yield, /* output pointer */
4199 US"if", /* condition type */
4202 case 1: goto EXPAND_FAILED; /* when all is well, the */
4203 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4206 /* Restore external setting of expansion variables for continuation
4209 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4210 save_expand_nlength);
4215 case EITEM_IMAPFOLDER:
4216 { /* ${imapfolder {name}{sep]{specials}} */
4220 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4223 case 1: goto EXPAND_FAILED_CURLY;
4225 case 3: goto EXPAND_FAILED;
4228 if (sub_arg[1] == NULL) /* One argument */
4230 sub_arg[1] = US"/"; /* default separator */
4233 else if (Ustrlen(sub_arg[1]) != 1)
4235 expand_string_message =
4237 "IMAP folder separator must be one character, found \"%s\"",
4244 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4245 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4247 yield = string_cat(yield, encoded);
4253 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4254 expanding an internal string that isn't actually going to be used. All we
4255 need to do is check the syntax, so don't do a lookup at all. Preserve the
4256 values of the numerical expansion variables in case they get changed by a
4257 partial lookup. If not, they retain their external settings. At the end
4258 of this "lookup" section, they get restored to their previous values. */
4262 int stype, partial, affixlen, starflags;
4263 int expand_setup = 0;
4265 uschar *key, *filename;
4266 const uschar *affix;
4267 uschar *save_lookup_value = lookup_value;
4268 int save_expand_nmax =
4269 save_expand_strings(save_expand_nstring, save_expand_nlength);
4271 if ((expand_forbid & RDO_LOOKUP) != 0)
4273 expand_string_message = US"lookup expansions are not permitted";
4277 /* Get the key we are to look up for single-key+file style lookups.
4278 Otherwise set the key NULL pro-tem. */
4280 while (isspace(*s)) s++;
4281 if (*s == '{') /*}*/
4283 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4284 if (!key) goto EXPAND_FAILED; /*{{*/
4287 expand_string_message = US"missing '}' after lookup key";
4288 goto EXPAND_FAILED_CURLY;
4290 while (isspace(*s)) s++;
4294 /* Find out the type of database */
4298 expand_string_message = US"missing lookup type";
4302 /* The type is a string that may contain special characters of various
4303 kinds. Allow everything except space or { to appear; the actual content
4304 is checked by search_findtype_partial. */ /*}*/
4306 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4308 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4312 while (isspace(*s)) s++;
4314 /* Now check for the individual search type and any partial or default
4315 options. Only those types that are actually in the binary are valid. */
4317 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4321 expand_string_message = search_error_message;
4325 /* Check that a key was provided for those lookup types that need it,
4326 and was not supplied for those that use the query style. */
4328 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4332 expand_string_message = string_sprintf("missing {key} for single-"
4333 "key \"%s\" lookup", name);
4341 expand_string_message = string_sprintf("a single key was given for "
4342 "lookup type \"%s\", which is not a single-key lookup type", name);
4347 /* Get the next string in brackets and expand it. It is the file name for
4348 single-key+file lookups, and the whole query otherwise. In the case of
4349 queries that also require a file name (e.g. sqlite), the file name comes
4354 expand_string_message = US"missing '{' for lookup file-or-query arg";
4355 goto EXPAND_FAILED_CURLY;
4357 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4358 if (filename == NULL) goto EXPAND_FAILED;
4361 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4362 goto EXPAND_FAILED_CURLY;
4364 while (isspace(*s)) s++;
4366 /* If this isn't a single-key+file lookup, re-arrange the variables
4367 to be appropriate for the search_ functions. For query-style lookups,
4368 there is just a "key", and no file name. For the special query-style +
4369 file types, the query (i.e. "key") starts with a file name. */
4373 while (isspace(*filename)) filename++;
4376 if (mac_islookup(stype, lookup_querystyle))
4380 if (*filename != '/')
4382 expand_string_message = string_sprintf(
4383 "absolute file name expected for \"%s\" lookup", name);
4386 while (*key != 0 && !isspace(*key)) key++;
4387 if (*key != 0) *key++ = 0;
4391 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4392 the entry was not found. Note that there is no search_close() function.
4393 Files are left open in case of re-use. At suitable places in higher logic,
4394 search_tidyup() is called to tidy all open files. This can save opening
4395 the same file several times. However, files may also get closed when
4396 others are opened, if too many are open at once. The rule is that a
4397 handle should not be used after a second search_open().
4399 Request that a partial search sets up $1 and maybe $2 by passing
4400 expand_setup containing zero. If its value changes, reset expand_nmax,
4401 since new variables will have been set. Note that at the end of this
4402 "lookup" section, the old numeric variables are restored. */
4405 lookup_value = NULL;
4408 void *handle = search_open(filename, stype, 0, NULL, NULL);
4411 expand_string_message = search_error_message;
4414 lookup_value = search_find(handle, filename, key, partial, affix,
4415 affixlen, starflags, &expand_setup);
4416 if (search_find_defer)
4418 expand_string_message =
4419 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4420 string_printing2(key, FALSE), search_error_message);
4423 if (expand_setup > 0) expand_nmax = expand_setup;
4426 /* The handling of "yes" and "no" result strings is now in a separate
4427 function that is also used by ${if} and ${extract}. */
4429 switch(process_yesno(
4430 skipping, /* were previously skipping */
4431 lookup_value != NULL, /* success/failure indicator */
4432 save_lookup_value, /* value to reset for string2 */
4433 &s, /* input pointer */
4434 &yield, /* output pointer */
4435 US"lookup", /* condition type */
4438 case 1: goto EXPAND_FAILED; /* when all is well, the */
4439 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4442 /* Restore external setting of expansion variables for carrying on
4443 at this level, and continue. */
4445 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4446 save_expand_nlength);
4450 /* If Perl support is configured, handle calling embedded perl subroutines,
4451 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4452 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4453 arguments (defined below). */
4455 #define EXIM_PERL_MAX_ARGS 8
4459 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4460 "is not included in this binary";
4463 #else /* EXIM_PERL */
4465 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4468 if ((expand_forbid & RDO_PERL) != 0)
4470 expand_string_message = US"Perl calls are not permitted";
4474 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4475 US"perl", &resetok))
4477 case 1: goto EXPAND_FAILED_CURLY;
4479 case 3: goto EXPAND_FAILED;
4482 /* If skipping, we don't actually do anything */
4484 if (skipping) continue;
4486 /* Start the interpreter if necessary */
4488 if (!opt_perl_started)
4491 if (opt_perl_startup == NULL)
4493 expand_string_message = US"A setting of perl_startup is needed when "
4494 "using the Perl interpreter";
4497 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4498 initerror = init_perl(opt_perl_startup);
4499 if (initerror != NULL)
4501 expand_string_message =
4502 string_sprintf("error in perl_startup code: %s\n", initerror);
4505 opt_perl_started = TRUE;
4508 /* Call the function */
4510 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4511 new_yield = call_perl_cat(yield, &expand_string_message,
4512 sub_arg[0], sub_arg + 1);
4514 /* NULL yield indicates failure; if the message pointer has been set to
4515 NULL, the yield was undef, indicating a forced failure. Otherwise the
4516 message will indicate some kind of Perl error. */
4518 if (new_yield == NULL)
4520 if (expand_string_message == NULL)
4522 expand_string_message =
4523 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4524 "failure", sub_arg[0]);
4525 expand_string_forcedfail = TRUE;
4530 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4531 set during a callback from Perl. */
4533 expand_string_forcedfail = FALSE;
4537 #endif /* EXIM_PERL */
4539 /* Transform email address to "prvs" scheme to use
4540 as BATV-signed return path */
4547 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4549 case 1: goto EXPAND_FAILED_CURLY;
4551 case 3: goto EXPAND_FAILED;
4554 /* If skipping, we don't actually do anything */
4555 if (skipping) continue;
4557 /* sub_arg[0] is the address */
4558 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
4559 || domain == sub_arg[0] || Ustrlen(domain) == 1)
4561 expand_string_message = US"prvs first argument must be a qualified email address";
4565 /* Calculate the hash. The third argument must be a single-digit
4566 key number, or unset. */
4569 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4571 expand_string_message = US"prvs third argument must be a single digit";
4575 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
4578 expand_string_message = US"prvs hmac-sha1 conversion failed";
4582 /* Now separate the domain from the local part */
4585 yield = string_catn(yield, US"prvs=", 5);
4586 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
4587 yield = string_catn(yield, prvs_daystamp(7), 3);
4588 yield = string_catn(yield, p, 6);
4589 yield = string_catn(yield, US"=", 1);
4590 yield = string_cat (yield, sub_arg[0]);
4591 yield = string_catn(yield, US"@", 1);
4592 yield = string_cat (yield, domain);
4597 /* Check a prvs-encoded address for validity */
4599 case EITEM_PRVSCHECK:
4606 /* TF: Ugliness: We want to expand parameter 1 first, then set
4607 up expansion variables that are used in the expansion of
4608 parameter 2. So we clone the string for the first
4609 expansion, where we only expand parameter 1.
4611 PH: Actually, that isn't necessary. The read_subs() function is
4612 designed to work this way for the ${if and ${lookup expansions. I've
4616 /* Reset expansion variables */
4617 prvscheck_result = NULL;
4618 prvscheck_address = NULL;
4619 prvscheck_keynum = NULL;
4621 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4623 case 1: goto EXPAND_FAILED_CURLY;
4625 case 3: goto EXPAND_FAILED;
4628 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4631 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4633 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4634 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4635 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4636 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4637 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4639 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
4640 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
4641 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
4642 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
4643 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
4645 /* Set up expansion variables */
4646 g = string_cat (NULL, local_part);
4647 g = string_catn(g, US"@", 1);
4648 g = string_cat (g, domain);
4649 prvscheck_address = string_from_gstring(g);
4650 prvscheck_keynum = string_copy(key_num);
4652 /* Now expand the second argument */
4653 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4655 case 1: goto EXPAND_FAILED_CURLY;
4657 case 3: goto EXPAND_FAILED;
4660 /* Now we have the key and can check the address. */
4662 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4667 expand_string_message = US"hmac-sha1 conversion failed";
4671 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
4672 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
4674 if (Ustrcmp(p,hash) == 0)
4676 /* Success, valid BATV address. Now check the expiry date. */
4677 uschar *now = prvs_daystamp(0);
4678 unsigned int inow = 0,iexpire = 1;
4680 (void)sscanf(CS now,"%u",&inow);
4681 (void)sscanf(CS daystamp,"%u",&iexpire);
4683 /* When "iexpire" is < 7, a "flip" has occured.
4684 Adjust "inow" accordingly. */
4685 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4687 if (iexpire >= inow)
4689 prvscheck_result = US"1";
4690 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
4694 prvscheck_result = NULL;
4695 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
4700 prvscheck_result = NULL;
4701 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
4704 /* Now expand the final argument. We leave this till now so that
4705 it can include $prvscheck_result. */
4707 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4709 case 1: goto EXPAND_FAILED_CURLY;
4711 case 3: goto EXPAND_FAILED;
4714 yield = string_cat(yield,
4715 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4717 /* Reset the "internal" variables afterwards, because they are in
4718 dynamic store that will be reclaimed if the expansion succeeded. */
4720 prvscheck_address = NULL;
4721 prvscheck_keynum = NULL;
4724 /* Does not look like a prvs encoded address, return the empty string.
4725 We need to make sure all subs are expanded first, so as to skip over
4728 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4730 case 1: goto EXPAND_FAILED_CURLY;
4732 case 3: goto EXPAND_FAILED;
4738 /* Handle "readfile" to insert an entire file */
4740 case EITEM_READFILE:
4745 if ((expand_forbid & RDO_READFILE) != 0)
4747 expand_string_message = US"file insertions are not permitted";
4751 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4753 case 1: goto EXPAND_FAILED_CURLY;
4755 case 3: goto EXPAND_FAILED;
4758 /* If skipping, we don't actually do anything */
4760 if (skipping) continue;
4762 /* Open the file and read it */
4764 if (!(f = Ufopen(sub_arg[0], "rb")))
4766 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4770 yield = cat_file(f, yield, sub_arg[1]);
4775 /* Handle "readsocket" to insert data from a socket, either
4776 Inet or Unix domain */
4778 case EITEM_READSOCK:
4782 int save_ptr = yield->ptr;
4786 BOOL do_shutdown = TRUE;
4789 if (expand_forbid & RDO_READSOCK)
4791 expand_string_message = US"socket insertions are not permitted";
4795 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4796 because there may be a string for expansion on failure. */
4798 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4800 case 1: goto EXPAND_FAILED_CURLY;
4801 case 2: /* Won't occur: no end check */
4802 case 3: goto EXPAND_FAILED;
4805 /* Grab the request string, if any */
4807 reqstr.data = sub_arg[1];
4808 reqstr.len = Ustrlen(sub_arg[1]);
4810 /* Sort out timeout, if given. The second arg is a list with the first element
4811 being a time value. Any more are options of form "name=value". Currently the
4812 only option recognised is "shutdown". */
4816 const uschar * list = sub_arg[2];
4820 item = string_nextinlist(&list, &sep, NULL, 0);
4821 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
4823 expand_string_message = string_sprintf("bad time value %s", item);
4827 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
4828 if (Ustrncmp(item, US"shutdown=", 9) == 0)
4829 if (Ustrcmp(item + 9, US"no") == 0)
4830 do_shutdown = FALSE;
4832 else sub_arg[3] = NULL; /* No eol if no timeout */
4834 /* If skipping, we don't actually do anything. Otherwise, arrange to
4835 connect to either an IP or a Unix socket. */
4839 /* Handle an IP (internet) domain */
4841 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4844 uschar * server_name = sub_arg[0] + 5;
4845 uschar * port_name = Ustrrchr(server_name, ':');
4847 /* Sort out the port */
4851 expand_string_message =
4852 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4855 *port_name++ = 0; /* Terminate server name */
4857 if (isdigit(*port_name))
4860 port = Ustrtol(port_name, &end, 0);
4861 if (end != port_name + Ustrlen(port_name))
4863 expand_string_message =
4864 string_sprintf("invalid port number %s", port_name);
4870 struct servent *service_info = getservbyname(CS port_name, "tcp");
4873 expand_string_message = string_sprintf("unknown port \"%s\"",
4877 port = ntohs(service_info->s_port);
4880 fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4881 timeout, NULL, &expand_string_message, &reqstr);
4882 callout_address = NULL;
4888 /* Handle a Unix domain socket */
4892 struct sockaddr_un sockun; /* don't call this "sun" ! */
4895 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4897 expand_string_message = string_sprintf("failed to create socket: %s",
4902 sockun.sun_family = AF_UNIX;
4903 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4906 sigalrm_seen = FALSE;
4908 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4912 expand_string_message = US "socket connect timed out";
4917 expand_string_message = string_sprintf("failed to connect to socket "
4918 "%s: %s", sub_arg[0], strerror(errno));
4923 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
4925 /* Allow sequencing of test actions */
4926 if (running_in_test_harness) millisleep(100);
4928 /* Write the request string, if not empty or already done */
4932 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
4934 if (write(fd, reqstr.data, reqstr.len) != reqstr.len)
4936 expand_string_message = string_sprintf("request write to socket "
4937 "failed: %s", strerror(errno));
4942 /* Shut down the sending side of the socket. This helps some servers to
4943 recognise that it is their turn to do some work. Just in case some
4944 system doesn't have this function, make it conditional. */
4947 if (do_shutdown) shutdown(fd, SHUT_WR);
4950 if (running_in_test_harness) millisleep(100);
4952 /* Now we need to read from the socket, under a timeout. The function
4953 that reads a file can be used. */
4955 f = fdopen(fd, "rb");
4956 sigalrm_seen = FALSE;
4958 yield = cat_file(f, yield, sub_arg[3]);
4962 /* After a timeout, we restore the pointer in the result, that is,
4963 make sure we add nothing from the socket. */
4967 yield->ptr = save_ptr;
4968 expand_string_message = US "socket read timed out";
4973 /* The whole thing has worked (or we were skipping). If there is a
4974 failure string following, we need to skip it. */
4978 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4982 expand_string_message = US"missing '}' closing failstring for readsocket";
4983 goto EXPAND_FAILED_CURLY;
4985 while (isspace(*s)) s++;
4991 expand_string_message = US"missing '}' closing readsocket";
4992 goto EXPAND_FAILED_CURLY;
4996 /* Come here on failure to create socket, connect socket, write to the
4997 socket, or timeout on reading. If another substring follows, expand and
4998 use it. Otherwise, those conditions give expand errors. */
5001 if (*s != '{') goto EXPAND_FAILED;
5002 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5003 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
5005 yield = string_cat(yield, arg);
5008 expand_string_message = US"missing '}' closing failstring for readsocket";
5009 goto EXPAND_FAILED_CURLY;
5011 while (isspace(*s)) s++;
5015 /* Handle "run" to execute a program. */
5021 const uschar **argv;
5025 if ((expand_forbid & RDO_RUN) != 0)
5027 expand_string_message = US"running a command is not permitted";
5031 while (isspace(*s)) s++;
5034 expand_string_message = US"missing '{' for command arg of run";
5035 goto EXPAND_FAILED_CURLY;
5037 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5038 if (arg == NULL) goto EXPAND_FAILED;
5039 while (isspace(*s)) s++;
5042 expand_string_message = US"missing '}' closing command arg of run";
5043 goto EXPAND_FAILED_CURLY;
5046 if (skipping) /* Just pretend it worked when we're skipping */
5049 lookup_value = NULL;
5053 if (!transport_set_up_command(&argv, /* anchor for arg list */
5054 arg, /* raw command */
5055 FALSE, /* don't expand the arguments */
5056 0, /* not relevant when... */
5057 NULL, /* no transporting address */
5058 US"${run} expansion", /* for error messages */
5059 &expand_string_message)) /* where to put error message */
5062 /* Create the child process, making it a group leader. */
5064 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
5066 expand_string_message =
5067 string_sprintf("couldn't create child process: %s", strerror(errno));
5071 /* Nothing is written to the standard input. */
5075 /* Read the pipe to get the command's output into $value (which is kept
5076 in lookup_value). Read during execution, so that if the output exceeds
5077 the OS pipe buffer limit, we don't block forever. Remember to not release
5078 memory just allocated for $value. */
5081 f = fdopen(fd_out, "rb");
5082 sigalrm_seen = FALSE;
5084 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5088 /* Wait for the process to finish, applying the timeout, and inspect its
5089 return code for serious disasters. Simple non-zero returns are passed on.
5092 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5094 if (sigalrm_seen || runrc == -256)
5096 expand_string_message = string_sprintf("command timed out");
5097 killpg(pid, SIGKILL); /* Kill the whole process group */
5100 else if (runrc == -257)
5101 expand_string_message = string_sprintf("wait() failed: %s",
5105 expand_string_message = string_sprintf("command killed by signal %d",
5112 /* Process the yes/no strings; $value may be useful in both cases */
5114 switch(process_yesno(
5115 skipping, /* were previously skipping */
5116 runrc == 0, /* success/failure indicator */
5117 lookup_value, /* value to reset for string2 */
5118 &s, /* input pointer */
5119 &yield, /* output pointer */
5120 US"run", /* condition type */
5123 case 1: goto EXPAND_FAILED; /* when all is well, the */
5124 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5130 /* Handle character translation for "tr" */
5134 int oldptr = yield->ptr;
5138 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5140 case 1: goto EXPAND_FAILED_CURLY;
5142 case 3: goto EXPAND_FAILED;
5145 yield = string_cat(yield, sub[0]);
5146 o2m = Ustrlen(sub[2]) - 1;
5148 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5150 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5154 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5161 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5162 expanded arguments. */
5172 int val[2] = { 0, -1 };
5175 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5176 Ensure that sub[2] is set in the ${length } case. */
5179 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5180 TRUE, name, &resetok))
5182 case 1: goto EXPAND_FAILED_CURLY;
5184 case 3: goto EXPAND_FAILED;
5187 /* Juggle the arguments if there are only two of them: always move the
5188 string to the last position and make ${length{n}{str}} equivalent to
5189 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5195 if (item_type == EITEM_LENGTH)
5202 for (i = 0; i < 2; i++)
5204 if (sub[i] == NULL) continue;
5205 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5206 if (*ret != 0 || (i != 0 && val[i] < 0))
5208 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5209 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5215 (item_type == EITEM_HASH)?
5216 compute_hash(sub[2], val[0], val[1], &len) :
5217 (item_type == EITEM_NHASH)?
5218 compute_nhash(sub[2], val[0], val[1], &len) :
5219 extract_substr(sub[2], val[0], val[1], &len);
5221 if (ret == NULL) goto EXPAND_FAILED;
5222 yield = string_catn(yield, ret, len);
5226 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5227 This code originally contributed by Steve Haslam. It currently supports
5228 the use of MD5 and SHA-1 hashes.
5230 We need some workspace that is large enough to handle all the supported
5231 hash types. Use macros to set the sizes rather than be too elaborate. */
5233 #define MAX_HASHLEN 20
5234 #define MAX_HASHBLOCKLEN 64
5243 int hashlen; /* Number of octets for the hash algorithm's output */
5244 int hashblocklen; /* Number of octets the hash algorithm processes */
5246 unsigned int keylen;
5248 uschar keyhash[MAX_HASHLEN];
5249 uschar innerhash[MAX_HASHLEN];
5250 uschar finalhash[MAX_HASHLEN];
5251 uschar finalhash_hex[2*MAX_HASHLEN];
5252 uschar innerkey[MAX_HASHBLOCKLEN];
5253 uschar outerkey[MAX_HASHBLOCKLEN];
5255 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5257 case 1: goto EXPAND_FAILED_CURLY;
5259 case 3: goto EXPAND_FAILED;
5264 if (Ustrcmp(sub[0], "md5") == 0)
5267 use_base = &md5_base;
5271 else if (Ustrcmp(sub[0], "sha1") == 0)
5274 use_base = &sha1_ctx;
5280 expand_string_message =
5281 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5286 keylen = Ustrlen(keyptr);
5288 /* If the key is longer than the hash block length, then hash the key
5291 if (keylen > hashblocklen)
5293 chash_start(type, use_base);
5294 chash_end(type, use_base, keyptr, keylen, keyhash);
5299 /* Now make the inner and outer key values */
5301 memset(innerkey, 0x36, hashblocklen);
5302 memset(outerkey, 0x5c, hashblocklen);
5304 for (i = 0; i < keylen; i++)
5306 innerkey[i] ^= keyptr[i];
5307 outerkey[i] ^= keyptr[i];
5310 /* Now do the hashes */
5312 chash_start(type, use_base);
5313 chash_mid(type, use_base, innerkey);
5314 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5316 chash_start(type, use_base);
5317 chash_mid(type, use_base, outerkey);
5318 chash_end(type, use_base, innerhash, hashlen, finalhash);
5320 /* Encode the final hash as a hex string */
5323 for (i = 0; i < hashlen; i++)
5325 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5326 *p++ = hex_digits[finalhash[i] & 0x0f];
5329 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5330 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5332 yield = string_catn(yield, finalhash_hex, hashlen*2);
5337 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5338 We have to save the numerical variables and restore them afterwards. */
5343 int moffset, moffsetextra, slen;
5346 const uschar *rerror;
5349 int save_expand_nmax =
5350 save_expand_strings(save_expand_nstring, save_expand_nlength);
5352 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5354 case 1: goto EXPAND_FAILED_CURLY;
5356 case 3: goto EXPAND_FAILED;
5359 /* Compile the regular expression */
5361 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5366 expand_string_message = string_sprintf("regular expression error in "
5367 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5371 /* Now run a loop to do the substitutions as often as necessary. It ends
5372 when there are no more matches. Take care over matches of the null string;
5373 do the same thing as Perl does. */
5376 slen = Ustrlen(sub[0]);
5377 moffset = moffsetextra = 0;
5382 int ovector[3*(EXPAND_MAXN+1)];
5383 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5384 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5388 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5389 is not necessarily the end. We want to repeat the match from one
5390 character further along, but leaving the basic offset the same (for
5391 copying below). We can't be at the end of the string - that was checked
5392 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5393 finished; copy the remaining string and end the loop. */
5403 yield = string_catn(yield, subject+moffset, slen-moffset);
5407 /* Match - set up for expanding the replacement. */
5409 if (n == 0) n = EXPAND_MAXN + 1;
5411 for (nn = 0; nn < n*2; nn += 2)
5413 expand_nstring[expand_nmax] = subject + ovector[nn];
5414 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5418 /* Copy the characters before the match, plus the expanded insertion. */
5420 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
5421 insert = expand_string(sub[2]);
5422 if (insert == NULL) goto EXPAND_FAILED;
5423 yield = string_cat(yield, insert);
5425 moffset = ovector[1];
5429 /* If we have matched an empty string, first check to see if we are at
5430 the end of the subject. If so, the loop is over. Otherwise, mimic
5431 what Perl's /g options does. This turns out to be rather cunning. First
5432 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5433 string at the same point. If this fails (picked up above) we advance to
5434 the next character. */
5436 if (ovector[0] == ovector[1])
5438 if (ovector[0] == slen) break;
5439 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5443 /* All done - restore numerical variables. */
5445 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5446 save_expand_nlength);
5450 /* Handle keyed and numbered substring extraction. If the first argument
5451 consists entirely of digits, then a numerical extraction is assumed. */
5457 int field_number = 1;
5458 BOOL field_number_set = FALSE;
5459 uschar *save_lookup_value = lookup_value;
5461 int save_expand_nmax =
5462 save_expand_strings(save_expand_nstring, save_expand_nlength);
5464 /* While skipping we cannot rely on the data for expansions being
5465 available (eg. $item) hence cannot decide on numeric vs. keyed.
5466 Read a maximum of 5 arguments (including the yes/no) */
5470 while (isspace(*s)) s++;
5471 for (j = 5; j > 0 && *s == '{'; j--)
5473 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5474 goto EXPAND_FAILED; /*{*/
5477 expand_string_message = US"missing '{' for arg of extract";
5478 goto EXPAND_FAILED_CURLY;
5480 while (isspace(*s)) s++;
5482 if ( Ustrncmp(s, "fail", 4) == 0
5483 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5487 while (isspace(*s)) s++;
5491 expand_string_message = US"missing '}' closing extract";
5492 goto EXPAND_FAILED_CURLY;
5496 else for (i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5498 while (isspace(*s)) s++;
5499 if (*s == '{') /*}*/
5501 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5502 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5505 expand_string_message = string_sprintf(
5506 "missing '}' closing arg %d of extract", i+1);
5507 goto EXPAND_FAILED_CURLY;
5510 /* After removal of leading and trailing white space, the first
5511 argument must not be empty; if it consists entirely of digits
5512 (optionally preceded by a minus sign), this is a numerical
5513 extraction, and we expect 3 arguments. */
5521 while (isspace(*p)) p++;
5525 while (len > 0 && isspace(p[len-1])) len--;
5530 expand_string_message = US"first argument of \"extract\" must "
5540 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5544 j = 3; /* Need 3 args */
5545 field_number_set = TRUE;
5551 expand_string_message = string_sprintf(
5552 "missing '{' for arg %d of extract", i+1);
5553 goto EXPAND_FAILED_CURLY;
5557 /* Extract either the numbered or the keyed substring into $value. If
5558 skipping, just pretend the extraction failed. */
5560 lookup_value = skipping? NULL : field_number_set?
5561 expand_gettokened(field_number, sub[1], sub[2]) :
5562 expand_getkeyed(sub[0], sub[1]);
5564 /* If no string follows, $value gets substituted; otherwise there can
5565 be yes/no strings, as for lookup or if. */
5567 switch(process_yesno(
5568 skipping, /* were previously skipping */
5569 lookup_value != NULL, /* success/failure indicator */
5570 save_lookup_value, /* value to reset for string2 */
5571 &s, /* input pointer */
5572 &yield, /* output pointer */
5573 US"extract", /* condition type */
5576 case 1: goto EXPAND_FAILED; /* when all is well, the */
5577 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5580 /* All done - restore numerical variables. */
5582 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5583 save_expand_nlength);
5588 /* return the Nth item from a list */
5590 case EITEM_LISTEXTRACT:
5593 int field_number = 1;
5594 uschar *save_lookup_value = lookup_value;
5596 int save_expand_nmax =
5597 save_expand_strings(save_expand_nstring, save_expand_nlength);
5599 /* Read the field & list arguments */
5601 for (i = 0; i < 2; i++)
5603 while (isspace(*s)) s++;
5604 if (*s != '{') /*}*/
5606 expand_string_message = string_sprintf(
5607 "missing '{' for arg %d of listextract", i+1);
5608 goto EXPAND_FAILED_CURLY;
5611 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5612 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5615 expand_string_message = string_sprintf(
5616 "missing '}' closing arg %d of listextract", i+1);
5617 goto EXPAND_FAILED_CURLY;
5620 /* After removal of leading and trailing white space, the first
5621 argument must be numeric and nonempty. */
5629 while (isspace(*p)) p++;
5633 while (len > 0 && isspace(p[len-1])) len--;
5636 if (!*p && !skipping)
5638 expand_string_message = US"first argument of \"listextract\" must "
5648 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5651 expand_string_message = US"first argument of \"listextract\" must "
5659 /* Extract the numbered element into $value. If
5660 skipping, just pretend the extraction failed. */
5662 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5664 /* If no string follows, $value gets substituted; otherwise there can
5665 be yes/no strings, as for lookup or if. */
5667 switch(process_yesno(
5668 skipping, /* were previously skipping */
5669 lookup_value != NULL, /* success/failure indicator */
5670 save_lookup_value, /* value to reset for string2 */
5671 &s, /* input pointer */
5672 &yield, /* output pointer */
5673 US"listextract", /* condition type */
5676 case 1: goto EXPAND_FAILED; /* when all is well, the */
5677 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5680 /* All done - restore numerical variables. */
5682 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5683 save_expand_nlength);
5689 case EITEM_CERTEXTRACT:
5691 uschar *save_lookup_value = lookup_value;
5693 int save_expand_nmax =
5694 save_expand_strings(save_expand_nstring, save_expand_nlength);
5696 /* Read the field argument */
5697 while (isspace(*s)) s++;
5698 if (*s != '{') /*}*/
5700 expand_string_message = US"missing '{' for field arg of certextract";
5701 goto EXPAND_FAILED_CURLY;
5703 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5704 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5707 expand_string_message = US"missing '}' closing field arg of certextract";
5708 goto EXPAND_FAILED_CURLY;
5710 /* strip spaces fore & aft */
5715 while (isspace(*p)) p++;
5719 while (len > 0 && isspace(p[len-1])) len--;
5723 /* inspect the cert argument */
5724 while (isspace(*s)) s++;
5725 if (*s != '{') /*}*/
5727 expand_string_message = US"missing '{' for cert variable arg of certextract";
5728 goto EXPAND_FAILED_CURLY;
5732 expand_string_message = US"second argument of \"certextract\" must "
5733 "be a certificate variable";
5736 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5737 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5740 expand_string_message = US"missing '}' closing cert variable arg of certextract";
5741 goto EXPAND_FAILED_CURLY;
5745 lookup_value = NULL;
5748 lookup_value = expand_getcertele(sub[0], sub[1]);
5749 if (*expand_string_message) goto EXPAND_FAILED;
5751 switch(process_yesno(
5752 skipping, /* were previously skipping */
5753 lookup_value != NULL, /* success/failure indicator */
5754 save_lookup_value, /* value to reset for string2 */
5755 &s, /* input pointer */
5756 &yield, /* output pointer */
5757 US"certextract", /* condition type */
5760 case 1: goto EXPAND_FAILED; /* when all is well, the */
5761 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5764 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5765 save_expand_nlength);
5768 #endif /*SUPPORT_TLS*/
5770 /* Handle list operations */
5777 int save_ptr = yield->ptr;
5778 uschar outsep[2] = { '\0', '\0' };
5779 const uschar *list, *expr, *temp;
5780 uschar *save_iterate_item = iterate_item;
5781 uschar *save_lookup_value = lookup_value;
5783 while (isspace(*s)) s++;
5786 expand_string_message =
5787 string_sprintf("missing '{' for first arg of %s", name);
5788 goto EXPAND_FAILED_CURLY;
5791 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5792 if (list == NULL) goto EXPAND_FAILED;
5795 expand_string_message =
5796 string_sprintf("missing '}' closing first arg of %s", name);
5797 goto EXPAND_FAILED_CURLY;
5800 if (item_type == EITEM_REDUCE)
5803 while (isspace(*s)) s++;
5806 expand_string_message = US"missing '{' for second arg of reduce";
5807 goto EXPAND_FAILED_CURLY;
5809 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5810 if (!t) goto EXPAND_FAILED;
5814 expand_string_message = US"missing '}' closing second arg of reduce";
5815 goto EXPAND_FAILED_CURLY;
5819 while (isspace(*s)) s++;
5822 expand_string_message =
5823 string_sprintf("missing '{' for last arg of %s", name);
5824 goto EXPAND_FAILED_CURLY;
5829 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5830 if scanning a "false" part). This allows us to find the end of the
5831 condition, because if the list is empty, we won't actually evaluate the
5832 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5833 the normal internal expansion function. */
5835 if (item_type == EITEM_FILTER)
5837 temp = eval_condition(expr, &resetok, NULL);
5838 if (temp != NULL) s = temp;
5841 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5845 expand_string_message = string_sprintf("%s inside \"%s\" item",
5846 expand_string_message, name);
5850 while (isspace(*s)) s++;
5853 expand_string_message = string_sprintf("missing } at end of condition "
5854 "or expression inside \"%s\"; could be an unquoted } in the content",
5859 while (isspace(*s)) s++; /*{*/
5862 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5867 /* If we are skipping, we can now just move on to the next item. When
5868 processing for real, we perform the iteration. */
5870 if (skipping) continue;
5871 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
5873 *outsep = (uschar)sep; /* Separator as a string */
5875 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
5876 name, iterate_item, lookup_value);
5878 if (item_type == EITEM_FILTER)
5881 if (eval_condition(expr, &resetok, &condresult) == NULL)
5883 iterate_item = save_iterate_item;
5884 lookup_value = save_lookup_value;
5885 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5886 expand_string_message, name);
5889 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
5890 condresult? "true":"false");
5892 temp = iterate_item; /* TRUE => include this item */
5894 continue; /* FALSE => skip this item */
5897 /* EITEM_MAP and EITEM_REDUCE */
5901 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5905 iterate_item = save_iterate_item;
5906 expand_string_message = string_sprintf("%s inside \"%s\" item",
5907 expand_string_message, name);
5910 if (item_type == EITEM_REDUCE)
5912 lookup_value = t; /* Update the value of $value */
5913 continue; /* and continue the iteration */
5917 /* We reach here for FILTER if the condition is true, always for MAP,
5918 and never for REDUCE. The value in "temp" is to be added to the output
5919 list that is being created, ensuring that any occurrences of the
5920 separator character are doubled. Unless we are dealing with the first
5921 item of the output list, add in a space if the new item begins with the
5922 separator character, or is an empty string. */
5924 if (yield->ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5925 yield = string_catn(yield, US" ", 1);
5927 /* Add the string in "temp" to the output list that we are building,
5928 This is done in chunks by searching for the separator character. */
5932 size_t seglen = Ustrcspn(temp, outsep);
5934 yield = string_catn(yield, temp, seglen + 1);
5936 /* If we got to the end of the string we output one character
5937 too many; backup and end the loop. Otherwise arrange to double the
5940 if (temp[seglen] == '\0') { yield->ptr--; break; }
5941 yield = string_catn(yield, outsep, 1);
5945 /* Output a separator after the string: we will remove the redundant
5946 final one at the end. */
5948 yield = string_catn(yield, outsep, 1);
5949 } /* End of iteration over the list loop */
5951 /* REDUCE has generated no output above: output the final value of
5954 if (item_type == EITEM_REDUCE)
5956 yield = string_cat(yield, lookup_value);
5957 lookup_value = save_lookup_value; /* Restore $value */
5960 /* FILTER and MAP generate lists: if they have generated anything, remove
5961 the redundant final separator. Even though an empty item at the end of a
5962 list does not count, this is tidier. */
5964 else if (yield->ptr != save_ptr) yield->ptr--;
5966 /* Restore preserved $item */
5968 iterate_item = save_iterate_item;
5975 const uschar *srclist, *cmp, *xtract;
5977 const uschar *dstlist = NULL, *dstkeylist = NULL;
5979 uschar *save_iterate_item = iterate_item;
5981 while (isspace(*s)) s++;
5984 expand_string_message = US"missing '{' for list arg of sort";
5985 goto EXPAND_FAILED_CURLY;
5988 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5989 if (!srclist) goto EXPAND_FAILED;
5992 expand_string_message = US"missing '}' closing list arg of sort";
5993 goto EXPAND_FAILED_CURLY;
5996 while (isspace(*s)) s++;
5999 expand_string_message = US"missing '{' for comparator arg of sort";
6000 goto EXPAND_FAILED_CURLY;
6003 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
6004 if (!cmp) goto EXPAND_FAILED;
6007 expand_string_message = US"missing '}' closing comparator arg of sort";
6008 goto EXPAND_FAILED_CURLY;
6011 while (isspace(*s)) s++;
6014 expand_string_message = US"missing '{' for extractor arg of sort";
6015 goto EXPAND_FAILED_CURLY;
6019 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6020 if (!tmp) goto EXPAND_FAILED;
6021 xtract = string_copyn(xtract, s - xtract);
6025 expand_string_message = US"missing '}' closing extractor arg of sort";
6026 goto EXPAND_FAILED_CURLY;
6031 expand_string_message = US"missing } at end of \"sort\"";
6035 if (skipping) continue;
6037 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6040 gstring * newlist = NULL;
6041 gstring * newkeylist = NULL;
6044 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6046 /* extract field for comparisons */
6047 iterate_item = srcitem;
6048 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6052 expand_string_message = string_sprintf(
6053 "field-extract in sort: \"%s\"", xtract);
6057 /* Insertion sort */
6059 /* copy output list until new-item < list-item */
6060 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6066 /* field for comparison */
6067 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6070 /* build and run condition string */
6071 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
6073 DEBUG(D_expand) debug_printf_indent("%s: cond = \"%s\"\n", name, expr);
6074 if (!eval_condition(expr, &resetok, &before))
6076 expand_string_message = string_sprintf("comparison in sort: %s",
6083 /* New-item sorts before this dst-item. Append new-item,
6084 then dst-item, then remainder of dst list. */
6086 newlist = string_append_listele(newlist, sep, srcitem);
6087 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6090 newlist = string_append_listele(newlist, sep, dstitem);
6091 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6093 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6095 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6097 newlist = string_append_listele(newlist, sep, dstitem);
6098 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6104 newlist = string_append_listele(newlist, sep, dstitem);
6105 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6108 /* If we ran out of dstlist without consuming srcitem, append it */
6111 newlist = string_append_listele(newlist, sep, srcitem);
6112 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6115 dstlist = newlist->s;
6116 dstkeylist = newkeylist->s;
6118 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6119 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6123 yield = string_cat(yield, dstlist);
6125 /* Restore preserved $item */
6126 iterate_item = save_iterate_item;
6130 expand_string_message = US"Internal error in sort (list mismatch)";
6135 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6136 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6137 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6138 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6140 #define EXPAND_DLFUNC_MAX_ARGS 8
6143 #ifndef EXPAND_DLFUNC
6144 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6145 "is not included in this binary";
6148 #else /* EXPAND_DLFUNC */
6151 exim_dlfunc_t *func;
6154 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6156 if ((expand_forbid & RDO_DLFUNC) != 0)
6158 expand_string_message =
6159 US"dynamically-loaded functions are not permitted";
6163 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6164 TRUE, US"dlfunc", &resetok))
6166 case 1: goto EXPAND_FAILED_CURLY;
6168 case 3: goto EXPAND_FAILED;
6171 /* If skipping, we don't actually do anything */
6173 if (skipping) continue;
6175 /* Look up the dynamically loaded object handle in the tree. If it isn't
6176 found, dlopen() the file and put the handle in the tree for next time. */
6178 t = tree_search(dlobj_anchor, argv[0]);
6181 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6184 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6185 argv[0], dlerror());
6186 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6189 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6190 Ustrcpy(t->name, argv[0]);
6191 t->data.ptr = handle;
6192 (void)tree_insertnode(&dlobj_anchor, t);
6195 /* Having obtained the dynamically loaded object handle, look up the
6196 function pointer. */
6198 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6201 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6202 "%s", argv[1], argv[0], dlerror());
6203 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6207 /* Call the function and work out what to do with the result. If it
6208 returns OK, we have a replacement string; if it returns DEFER then
6209 expansion has failed in a non-forced manner; if it returns FAIL then
6210 failure was forced; if it returns ERROR or any other value there's a
6211 problem, so panic slightly. In any case, assume that the function has
6212 side-effects on the store that must be preserved. */
6216 for (argc = 0; argv[argc] != NULL; argc++);
6217 status = func(&result, argc - 2, &argv[2]);
6220 if (result == NULL) result = US"";
6221 yield = string_cat(yield, result);
6226 expand_string_message = result == NULL ? US"(no message)" : result;
6227 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
6228 else if(status != FAIL)
6229 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6230 argv[0], argv[1], status, expand_string_message);
6234 #endif /* EXPAND_DLFUNC */
6236 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6239 uschar *save_lookup_value = lookup_value;
6241 while (isspace(*s)) s++;
6242 if (*s != '{') /*}*/
6245 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6246 if (!key) goto EXPAND_FAILED; /*{*/
6249 expand_string_message = US"missing '{' for name arg of env";
6250 goto EXPAND_FAILED_CURLY;
6253 lookup_value = US getenv(CS key);
6255 switch(process_yesno(
6256 skipping, /* were previously skipping */
6257 lookup_value != NULL, /* success/failure indicator */
6258 save_lookup_value, /* value to reset for string2 */
6259 &s, /* input pointer */
6260 &yield, /* output pointer */
6261 US"env", /* condition type */
6264 case 1: goto EXPAND_FAILED; /* when all is well, the */
6265 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6269 } /* EITEM_* switch */
6271 /* Control reaches here if the name is not recognized as one of the more
6272 complicated expansion items. Check for the "operator" syntax (name terminated
6273 by a colon). Some of the operators have arguments, separated by _ from the
6281 var_entry *vp = NULL;
6283 /* Owing to an historical mis-design, an underscore may be part of the
6284 operator name, or it may introduce arguments. We therefore first scan the
6285 table of names that contain underscores. If there is no match, we cut off
6286 the arguments and then scan the main table. */
6288 if ((c = chop_match(name, op_table_underscore,
6289 nelem(op_table_underscore))) < 0)
6291 arg = Ustrchr(name, '_');
6292 if (arg != NULL) *arg = 0;
6293 c = chop_match(name, op_table_main, nelem(op_table_main));
6294 if (c >= 0) c += nelem(op_table_underscore);
6295 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6298 /* Deal specially with operators that might take a certificate variable
6299 as we do not want to do the usual expansion. For most, expand the string.*/
6309 const uschar * s1 = s;
6310 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6312 if (!sub) goto EXPAND_FAILED; /*{*/
6315 expand_string_message =
6316 string_sprintf("missing '}' closing cert arg of %s", name);
6317 goto EXPAND_FAILED_CURLY;
6319 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6329 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6330 if (!sub) goto EXPAND_FAILED;
6335 /* If we are skipping, we don't need to perform the operation at all.
6336 This matters for operations like "mask", because the data may not be
6337 in the correct format when skipping. For example, the expression may test
6338 for the existence of $sender_host_address before trying to mask it. For
6339 other operations, doing them may not fail, but it is a waste of time. */
6341 if (skipping && c >= 0) continue;
6343 /* Otherwise, switch on the operator type */
6350 unsigned long int n = Ustrtoul(sub, &t, 10);
6355 expand_string_message = string_sprintf("argument for base32 "
6356 "operator is \"%s\", which is not a decimal number", sub);
6360 g = string_catn(g, &base32_chars[n & 0x1f], 1);
6362 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
6369 unsigned long int n = 0;
6373 uschar * t = Ustrchr(base32_chars, *tt++);
6376 expand_string_message = string_sprintf("argument for base32d "
6377 "operator is \"%s\", which is not a base 32 number", sub);
6380 n = n * 32 + (t - base32_chars);
6382 s = string_sprintf("%ld", n);
6383 yield = string_cat(yield, s);
6390 unsigned long int n = Ustrtoul(sub, &t, 10);
6393 expand_string_message = string_sprintf("argument for base62 "
6394 "operator is \"%s\", which is not a decimal number", sub);
6397 t = string_base62(n);
6398 yield = string_cat(yield, t);
6402 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6408 unsigned long int n = 0;
6411 uschar *t = Ustrchr(base62_chars, *tt++);
6414 expand_string_message = string_sprintf("argument for base62d "
6415 "operator is \"%s\", which is not a base %d number", sub,
6419 n = n * BASE_62 + (t - base62_chars);
6421 (void)sprintf(CS buf, "%ld", n);
6422 yield = string_cat(yield, buf);
6428 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6429 if (expanded == NULL)
6431 expand_string_message =
6432 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6433 expand_string_message);
6436 yield = string_cat(yield, expanded);
6443 uschar *t = sub - 1;
6444 while (*(++t) != 0) { *t = tolower(*t); count++; }
6445 yield = string_catn(yield, sub, count);
6452 uschar *t = sub - 1;
6453 while (*(++t) != 0) { *t = toupper(*t); count++; }
6454 yield = string_catn(yield, sub, count);
6460 if (vp && *(void **)vp->value)
6462 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6463 yield = string_cat(yield, cp);
6473 md5_end(&base, sub, Ustrlen(sub), digest);
6474 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6475 yield = string_cat(yield, US st);
6481 if (vp && *(void **)vp->value)
6483 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6484 yield = string_cat(yield, cp);
6494 sha1_end(&h, sub, Ustrlen(sub), digest);
6495 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6496 yield = string_catn(yield, US st, 40);
6501 #ifdef EXIM_HAVE_SHA2
6502 if (vp && *(void **)vp->value)
6504 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6505 yield = string_cat(yield, cp);
6513 if (!exim_sha_init(&h, HASH_SHA2_256))
6515 expand_string_message = US"unrecognised sha256 variant";
6518 exim_sha_update(&h, sub, Ustrlen(sub));
6519 exim_sha_finish(&h, &b);
6522 sprintf(st, "%02X", *b.data++);
6523 yield = string_catn(yield, US st, 2);
6527 expand_string_message = US"sha256 only supported with TLS";
6532 #ifdef EXIM_HAVE_SHA3
6537 hashmethod m = !arg ? HASH_SHA3_256
6538 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6539 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6540 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6541 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6544 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6546 expand_string_message = US"unrecognised sha3 variant";
6550 exim_sha_update(&h, sub, Ustrlen(sub));
6551 exim_sha_finish(&h, &b);
6554 sprintf(st, "%02X", *b.data++);
6555 yield = string_catn(yield, US st, 2);
6560 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
6564 /* Convert hex encoding to base64 encoding */
6574 for (enc = sub; *enc != 0; enc++)
6576 if (!isxdigit(*enc))
6578 expand_string_message = string_sprintf("\"%s\" is not a hex "
6587 expand_string_message = string_sprintf("\"%s\" contains an odd "
6588 "number of characters", sub);
6592 while ((c = *in++) != 0)
6594 if (isdigit(c)) c -= '0';
6595 else c = toupper(c) - 'A' + 10;
6607 enc = b64encode(sub, out - sub);
6608 yield = string_cat(yield, enc);
6612 /* Convert octets outside 0x21..0x7E to \xXX form */
6616 uschar *t = sub - 1;
6619 if (*t < 0x21 || 0x7E < *t)
6620 yield = string_catn(yield, string_sprintf("\\x%02x", *t), 4);
6622 yield = string_catn(yield, t, 1);
6627 /* count the number of list elements */
6636 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6637 cp = string_sprintf("%d", cnt);
6638 yield = string_cat(yield, cp);
6642 /* expand a named list given the name */
6643 /* handles nested named lists; requotes as colon-sep list */
6647 tree_node *t = NULL;
6648 const uschar * list;
6651 uschar * suffix = US"";
6652 BOOL needsep = FALSE;
6655 if (*sub == '+') sub++;
6656 if (arg == NULL) /* no-argument version */
6658 if (!(t = tree_search(addresslist_anchor, sub)) &&
6659 !(t = tree_search(domainlist_anchor, sub)) &&
6660 !(t = tree_search(hostlist_anchor, sub)))
6661 t = tree_search(localpartlist_anchor, sub);
6663 else switch(*arg) /* specific list-type version */
6665 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6666 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6667 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6668 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6670 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6676 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6678 : *arg=='a'?"address "
6679 : *arg=='d'?"domain "
6681 : *arg=='l'?"localpart "
6686 list = ((namedlist_block *)(t->data.ptr))->string;
6688 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
6690 uschar * buf = US" : ";
6692 yield = string_catn(yield, buf, 3);
6696 if (*item == '+') /* list item is itself a named list */
6698 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6699 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6701 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6705 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6706 while ((cp= strpbrk(CCS item, tok)))
6708 yield = string_catn(yield, item, cp - CS item);
6709 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6711 yield = string_catn(yield, US"::", 2);
6714 else /* sep in item; should already be doubled; emit once */
6716 yield = string_catn(yield, US tok, 1);
6717 if (*cp == sep) cp++;
6722 yield = string_cat(yield, item);
6727 /* mask applies a mask to an IP address; for example the result of
6728 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6735 int mask, maskoffset;
6736 int type = string_is_ip_address(sub, &maskoffset);
6741 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6746 if (maskoffset == 0)
6748 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6753 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6755 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6757 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6762 /* Convert the address to binary integer(s) and apply the mask */
6764 sub[maskoffset] = 0;
6765 count = host_aton(sub, binary);
6766 host_mask(count, binary, mask);
6768 /* Convert to masked textual format and add to output. */
6770 yield = string_catn(yield, buffer,
6771 host_nmtoa(count, binary, mask, buffer, '.'));
6776 case EOP_IPV6DENORM:
6778 int type = string_is_ip_address(sub, NULL);
6785 (void) host_aton(sub, binary);
6788 case 4: /* convert to IPv4-mapped IPv6 */
6789 binary[0] = binary[1] = 0;
6790 binary[2] = 0x0000ffff;
6791 (void) host_aton(sub, binary+3);
6795 expand_string_message =
6796 string_sprintf("\"%s\" is not an IP address", sub);
6800 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
6801 ? ipv6_nmtoa(binary, buffer)
6802 : host_nmtoa(4, binary, -1, buffer, ':')
6808 case EOP_LOCAL_PART:
6812 int start, end, domain;
6813 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
6816 if (c != EOP_DOMAIN)
6818 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6819 yield = string_catn(yield, sub+start, end-start);
6821 else if (domain != 0)
6824 yield = string_catn(yield, sub+domain, end-domain);
6831 uschar outsep[2] = { ':', '\0' };
6832 uschar *address, *error;
6833 int save_ptr = yield->ptr;
6834 int start, end, domain; /* Not really used */
6836 while (isspace(*sub)) sub++;
6838 if (*outsep = *++sub) ++sub;
6841 expand_string_message = string_sprintf("output separator "
6842 "missing in expanding ${addresses:%s}", --sub);
6845 parse_allow_group = TRUE;
6849 uschar *p = parse_find_address_end(sub, FALSE);
6850 uschar saveend = *p;
6852 address = parse_extract_address(sub, &error, &start, &end, &domain,
6856 /* Add the address to the output list that we are building. This is
6857 done in chunks by searching for the separator character. At the
6858 start, unless we are dealing with the first address of the output
6859 list, add in a space if the new address begins with the separator
6860 character, or is an empty string. */
6862 if (address != NULL)
6864 if (yield->ptr != save_ptr && address[0] == *outsep)
6865 yield = string_catn(yield, US" ", 1);
6869 size_t seglen = Ustrcspn(address, outsep);
6870 yield = string_catn(yield, address, seglen + 1);
6872 /* If we got to the end of the string we output one character
6875 if (address[seglen] == '\0') { yield->ptr--; break; }
6876 yield = string_catn(yield, outsep, 1);
6877 address += seglen + 1;
6880 /* Output a separator after the string: we will remove the
6881 redundant final one at the end. */
6883 yield = string_catn(yield, outsep, 1);
6886 if (saveend == '\0') break;
6890 /* If we have generated anything, remove the redundant final
6893 if (yield->ptr != save_ptr) yield->ptr--;
6894 parse_allow_group = FALSE;
6899 /* quote puts a string in quotes if it is empty or contains anything
6900 other than alphamerics, underscore, dot, or hyphen.
6902 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6903 be quoted in order to be a valid local part.
6905 In both cases, newlines and carriage returns are converted into \n and \r
6909 case EOP_QUOTE_LOCAL_PART:
6912 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6913 uschar *t = sub - 1;
6917 while (!needs_quote && *(++t) != 0)
6918 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6920 else /* EOP_QUOTE_LOCAL_PART */
6922 while (!needs_quote && *(++t) != 0)
6923 needs_quote = !isalnum(*t) &&
6924 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6925 (*t != '.' || t == sub || t[1] == 0);
6930 yield = string_catn(yield, US"\"", 1);
6935 yield = string_catn(yield, US"\\n", 2);
6936 else if (*t == '\r')
6937 yield = string_catn(yield, US"\\r", 2);
6940 if (*t == '\\' || *t == '"')
6941 yield = string_catn(yield, US"\\", 1);
6942 yield = string_catn(yield, t, 1);
6945 yield = string_catn(yield, US"\"", 1);
6947 else yield = string_cat(yield, sub);
6951 /* quote_lookuptype does lookup-specific quoting */
6956 uschar *opt = Ustrchr(arg, '_');
6958 if (opt != NULL) *opt++ = 0;
6960 n = search_findtype(arg, Ustrlen(arg));
6963 expand_string_message = search_error_message;
6967 if (lookup_list[n]->quote != NULL)
6968 sub = (lookup_list[n]->quote)(sub, opt);
6969 else if (opt != NULL) sub = NULL;
6973 expand_string_message = string_sprintf(
6974 "\"%s\" unrecognized after \"${quote_%s\"",
6979 yield = string_cat(yield, sub);
6983 /* rx quote sticks in \ before any non-alphameric character so that
6984 the insertion works in a regular expression. */
6988 uschar *t = sub - 1;
6992 yield = string_catn(yield, US"\\", 1);
6993 yield = string_catn(yield, t, 1);
6998 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6999 prescribed by the RFC, if there are characters that need to be encoded */
7003 uschar buffer[2048];
7004 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7005 buffer, sizeof(buffer), FALSE);
7006 yield = string_cat(yield, string);
7010 /* RFC 2047 decode */
7016 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7017 headers_charset, '?', &len, &error);
7020 expand_string_message = error;
7023 yield = string_catn(yield, decoded, len);
7027 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7037 if (c > 255) c = '_';
7039 yield = string_catn(yield, buff, 1);
7044 /* replace illegal UTF-8 sequences by replacement character */
7046 #define UTF8_REPLACEMENT_CHAR US"?"
7050 int seq_len = 0, index = 0;
7052 long codepoint = -1;
7053 uschar seq_buff[4]; /* accumulate utf-8 here */
7062 if ((c & 0xc0) != 0x80)
7063 /* wrong continuation byte; invalidate all bytes */
7064 complete = 1; /* error */
7067 codepoint = (codepoint << 6) | (c & 0x3f);
7068 seq_buff[index++] = c;
7069 if (--bytes_left == 0) /* codepoint complete */
7070 if(codepoint > 0x10FFFF) /* is it too large? */
7071 complete = -1; /* error (RFC3629 limit) */
7073 { /* finished; output utf-8 sequence */
7074 yield = string_catn(yield, seq_buff, seq_len);
7079 else /* no bytes left: new sequence */
7081 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7083 yield = string_catn(yield, &c, 1);
7086 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7088 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7093 codepoint = c & 0x1f;
7096 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7099 codepoint = c & 0x0f;
7101 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7104 codepoint = c & 0x07;
7106 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7109 seq_buff[index++] = c;
7110 seq_len = bytes_left + 1;
7111 } /* if(bytes_left) */
7115 bytes_left = index = 0;
7116 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7118 if ((complete == 1) && ((c & 0x80) == 0))
7119 /* ASCII character follows incomplete sequence */
7120 yield = string_catn(yield, &c, 1);
7126 case EOP_UTF8_DOMAIN_TO_ALABEL:
7128 uschar * error = NULL;
7129 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7132 expand_string_message = string_sprintf(
7133 "error converting utf8 (%s) to alabel: %s",
7134 string_printing(sub), error);
7137 yield = string_cat(yield, s);
7141 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7143 uschar * error = NULL;
7144 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7147 expand_string_message = string_sprintf(
7148 "error converting alabel (%s) to utf8: %s",
7149 string_printing(sub), error);
7152 yield = string_cat(yield, s);
7156 case EOP_UTF8_LOCALPART_TO_ALABEL:
7158 uschar * error = NULL;
7159 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7162 expand_string_message = string_sprintf(
7163 "error converting utf8 (%s) to alabel: %s",
7164 string_printing(sub), error);
7167 yield = string_cat(yield, s);
7168 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7172 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7174 uschar * error = NULL;
7175 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7178 expand_string_message = string_sprintf(
7179 "error converting alabel (%s) to utf8: %s",
7180 string_printing(sub), error);
7183 yield = string_cat(yield, s);
7186 #endif /* EXPERIMENTAL_INTERNATIONAL */
7188 /* escape turns all non-printing characters into escape sequences. */
7192 const uschar * t = string_printing(sub);
7193 yield = string_cat(yield, t);
7197 case EOP_ESCAPE8BIT:
7199 const uschar * s = sub;
7202 for (s = sub; (c = *s); s++)
7203 yield = c < 127 && c != '\\'
7204 ? string_catn(yield, s, 1)
7205 : string_catn(yield, string_sprintf("\\%03o", c), 4);
7209 /* Handle numeric expression evaluation */
7214 uschar *save_sub = sub;
7215 uschar *error = NULL;
7216 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7219 expand_string_message = string_sprintf("error in expression "
7220 "evaluation: %s (after processing \"%.*s\")", error,
7221 (int)(sub-save_sub), save_sub);
7224 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
7225 yield = string_cat(yield, var_buffer);
7229 /* Handle time period formating */
7233 int n = readconf_readtime(sub, 0, FALSE);
7236 expand_string_message = string_sprintf("string \"%s\" is not an "
7237 "Exim time interval in \"%s\" operator", sub, name);
7240 sprintf(CS var_buffer, "%d", n);
7241 yield = string_cat(yield, var_buffer);
7245 case EOP_TIME_INTERVAL:
7248 uschar *t = read_number(&n, sub);
7249 if (*t != 0) /* Not A Number*/
7251 expand_string_message = string_sprintf("string \"%s\" is not a "
7252 "positive number in \"%s\" operator", sub, name);
7255 t = readconf_printtime(n);
7256 yield = string_cat(yield, t);
7260 /* Convert string to base64 encoding */
7266 uschar * s = vp && *(void **)vp->value
7267 ? tls_cert_der_b64(*(void **)vp->value)
7268 : b64encode(sub, Ustrlen(sub));
7270 uschar * s = b64encode(sub, Ustrlen(sub));
7272 yield = string_cat(yield, s);
7279 int len = b64decode(sub, &s);
7282 expand_string_message = string_sprintf("string \"%s\" is not "
7283 "well-formed for \"%s\" operator", sub, name);
7286 yield = string_cat(yield, s);
7290 /* strlen returns the length of the string */
7295 (void)sprintf(CS buff, "%d", Ustrlen(sub));
7296 yield = string_cat(yield, buff);
7300 /* length_n or l_n takes just the first n characters or the whole string,
7301 whichever is the shorter;
7303 substr_m_n, and s_m_n take n characters from offset m; negative m take
7304 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7305 takes the rest, either to the right or to the left.
7307 hash_n or h_n makes a hash of length n from the string, yielding n
7308 characters from the set a-z; hash_n_m makes a hash of length n, but
7309 uses m characters from the set a-zA-Z0-9.
7311 nhash_n returns a single number between 0 and n-1 (in text form), while
7312 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7313 between 0 and n-1 and the second between 0 and m-1. */
7333 expand_string_message = string_sprintf("missing values after %s",
7338 /* "length" has only one argument, effectively being synonymous with
7341 if (c == EOP_LENGTH || c == EOP_L)
7347 /* The others have one or two arguments; for "substr" the first may be
7348 negative. The second being negative means "not supplied". */
7353 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7356 /* Read up to two numbers, separated by underscores */
7361 if (arg != ret && *arg == '_' && pn == &value1)
7365 if (arg[1] != 0) arg++;
7367 else if (!isdigit(*arg))
7369 expand_string_message =
7370 string_sprintf("non-digit after underscore in \"%s\"", name);
7373 else *pn = (*pn)*10 + *arg++ - '0';
7377 /* Perform the required operation */
7380 (c == EOP_HASH || c == EOP_H)?
7381 compute_hash(sub, value1, value2, &len) :
7382 (c == EOP_NHASH || c == EOP_NH)?
7383 compute_nhash(sub, value1, value2, &len) :
7384 extract_substr(sub, value1, value2, &len);
7386 if (ret == NULL) goto EXPAND_FAILED;
7387 yield = string_catn(yield, ret, len);
7397 uschar **modetable[3];
7402 if ((expand_forbid & RDO_EXISTS) != 0)
7404 expand_string_message = US"Use of the stat() expansion is not permitted";
7408 if (stat(CS sub, &st) < 0)
7410 expand_string_message = string_sprintf("stat(%s) failed: %s",
7411 sub, strerror(errno));
7415 switch (mode & S_IFMT)
7417 case S_IFIFO: smode[0] = 'p'; break;
7418 case S_IFCHR: smode[0] = 'c'; break;
7419 case S_IFDIR: smode[0] = 'd'; break;
7420 case S_IFBLK: smode[0] = 'b'; break;
7421 case S_IFREG: smode[0] = '-'; break;
7422 default: smode[0] = '?'; break;
7425 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7426 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7427 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7429 for (i = 0; i < 3; i++)
7431 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7436 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7437 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7438 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7439 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7440 (long)st.st_gid, st.st_size, (long)st.st_atime,
7441 (long)st.st_mtime, (long)st.st_ctime);
7442 yield = string_cat(yield, s);
7446 /* vaguely random number less than N */
7450 int_eximarith_t max;
7453 max = expanded_string_integer(sub, TRUE);
7454 if (expand_string_message != NULL)
7456 s = string_sprintf("%d", vaguely_random_number((int)max));
7457 yield = string_cat(yield, s);
7461 /* Reverse IP, including IPv6 to dotted-nibble */
7463 case EOP_REVERSE_IP:
7465 int family, maskptr;
7466 uschar reversed[128];
7468 family = string_is_ip_address(sub, &maskptr);
7471 expand_string_message = string_sprintf(
7472 "reverse_ip() not given an IP address [%s]", sub);
7475 invert_address(reversed, sub);
7476 yield = string_cat(yield, reversed);
7480 /* Unknown operator */
7483 expand_string_message =
7484 string_sprintf("unknown expansion operator \"%s\"", name);
7489 /* Handle a plain name. If this is the first thing in the expansion, release
7490 the pre-allocated buffer. If the result data is known to be in a new buffer,
7491 newsize will be set to the size of that buffer, and we can just point at that
7492 store instead of copying. Many expansion strings contain just one reference,
7493 so this is a useful optimization, especially for humungous headers
7494 ($message_headers). */
7503 g = store_get(sizeof(gstring));
7504 else if (yield->ptr == 0)
7506 if (resetok) store_reset(yield);
7508 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
7510 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
7512 expand_string_message =
7513 string_sprintf("unknown variable in \"${%s}\"", name);
7514 check_variable_error_message(name);
7517 len = Ustrlen(value);
7518 if (!yield && newsize)
7521 yield->size = newsize;
7526 yield = string_catn(yield, value, len);
7530 /* Else there's something wrong */
7532 expand_string_message =
7533 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7534 "in a variable reference)", name);
7538 /* If we hit the end of the string when ket_ends is set, there is a missing
7539 terminating brace. */
7541 if (ket_ends && *s == 0)
7543 expand_string_message = malformed_header
7544 ? US"missing } at end of string - could be header name not terminated by colon"
7545 : US"missing } at end of string";
7549 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7550 added to the string. If so, set up an empty string. Add a terminating zero. If
7551 left != NULL, return a pointer to the terminator. */
7554 yield = string_get(1);
7555 (void) string_from_gstring(yield);
7556 if (left) *left = s;
7558 /* Any stacking store that was used above the final string is no longer needed.
7559 In many cases the final string will be the first one that was got and so there
7560 will be optimal store usage. */
7562 if (resetok) store_reset(yield->s + (yield->size = yield->ptr + 1));
7563 else if (resetok_p) *resetok_p = FALSE;
7567 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
7568 "expanding: %.*s\n",
7569 (int)(s - string), string);
7570 debug_printf_indent("%s"
7571 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7573 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7576 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7577 "skipping: result is not used\n");
7582 /* This is the failure exit: easiest to program with a goto. We still need
7583 to update the pointer to the terminator, for cases of nested calls with "fail".
7586 EXPAND_FAILED_CURLY:
7587 if (malformed_header)
7588 expand_string_message =
7589 US"missing or misplaced { or } - could be header name not terminated by colon";
7591 else if (!expand_string_message || !*expand_string_message)
7592 expand_string_message = US"missing or misplaced { or }";
7594 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7595 that is a bad idea, because expand_string_message is in dynamic store. */
7598 if (left) *left = s;
7601 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
7603 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7604 "error message: %s\n",
7605 expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7606 expand_string_message);
7607 if (expand_string_forcedfail)
7608 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
7610 if (resetok_p && !resetok) *resetok_p = FALSE;
7616 /* This is the external function call. Do a quick check for any expansion
7617 metacharacters, and if there are none, just return the input string.
7619 Argument: the string to be expanded
7620 Returns: the expanded string, or NULL if expansion failed; if failure was
7621 due to a lookup deferring, search_find_defer will be TRUE
7625 expand_cstring(const uschar * string)
7627 if (Ustrpbrk(string, "$\\") != NULL)
7629 int old_pool = store_pool;
7632 search_find_defer = FALSE;
7633 malformed_header = FALSE;
7634 store_pool = POOL_MAIN;
7635 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7636 store_pool = old_pool;
7644 expand_string(uschar * string)
7646 return US expand_cstring(CUS string);
7653 /*************************************************
7655 *************************************************/
7657 /* Now and again we want to expand a string and be sure that the result is in a
7658 new bit of store. This function does that.
7659 Since we know it has been copied, the de-const cast is safe.
7661 Argument: the string to be expanded
7662 Returns: the expanded string, always in a new bit of store, or NULL
7666 expand_string_copy(const uschar *string)
7668 const uschar *yield = expand_cstring(string);
7669 if (yield == string) yield = string_copy(string);
7675 /*************************************************
7676 * Expand and interpret as an integer *
7677 *************************************************/
7679 /* Expand a string, and convert the result into an integer.
7682 string the string to be expanded
7683 isplus TRUE if a non-negative number is expected
7685 Returns: the integer value, or
7686 -1 for an expansion error ) in both cases, message in
7687 -2 for an integer interpretation error ) expand_string_message
7688 expand_string_message is set NULL for an OK integer
7692 expand_string_integer(uschar *string, BOOL isplus)
7694 return expanded_string_integer(expand_string(string), isplus);
7698 /*************************************************
7699 * Interpret string as an integer *
7700 *************************************************/
7702 /* Convert a string (that has already been expanded) into an integer.
7704 This function is used inside the expansion code.
7707 s the string to be expanded
7708 isplus TRUE if a non-negative number is expected
7710 Returns: the integer value, or
7711 -1 if string is NULL (which implies an expansion error)
7712 -2 for an integer interpretation error
7713 expand_string_message is set NULL for an OK integer
7716 static int_eximarith_t
7717 expanded_string_integer(const uschar *s, BOOL isplus)
7719 int_eximarith_t value;
7720 uschar *msg = US"invalid integer \"%s\"";
7723 /* If expansion failed, expand_string_message will be set. */
7725 if (s == NULL) return -1;
7727 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7728 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7729 systems, so we set it zero ourselves. */
7732 expand_string_message = NULL; /* Indicates no error */
7734 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7735 equal to 0. Unfortunately, people actually relied upon that, so preserve
7736 the behaviour explicitly. Stripping leading whitespace is a harmless
7737 noop change since strtol skips it anyway (provided that there is a number
7741 while (isspace(*s)) ++s;
7745 debug_printf_indent("treating blank string as number 0\n");
7750 value = strtoll(CS s, CSS &endptr, 10);
7754 msg = US"integer expected but \"%s\" found";
7756 else if (value < 0 && isplus)
7758 msg = US"non-negative integer expected but \"%s\" found";
7762 switch (tolower(*endptr))
7767 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7772 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7773 else value *= 1024*1024;
7777 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7778 else value *= 1024*1024*1024;
7782 if (errno == ERANGE)
7783 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7786 while (isspace(*endptr)) endptr++;
7787 if (*endptr == 0) return value;
7791 expand_string_message = string_sprintf(CS msg, s);
7796 /* These values are usually fixed boolean values, but they are permitted to be
7800 addr address being routed
7801 mtype the module type
7802 mname the module name
7803 dbg_opt debug selectors
7804 oname the option name
7805 bvalue the router's boolean value
7806 svalue the router's string value
7807 rvalue where to put the returned value
7809 Returns: OK value placed in rvalue
7810 DEFER expansion failed
7814 exp_bool(address_item *addr,
7815 uschar *mtype, uschar *mname, unsigned dbg_opt,
7816 uschar *oname, BOOL bvalue,
7817 uschar *svalue, BOOL *rvalue)
7820 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7822 expanded = expand_string(svalue);
7823 if (expanded == NULL)
7825 if (expand_string_forcedfail)
7827 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7831 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7832 oname, mname, mtype, expand_string_message);
7833 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7837 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7840 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7842 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7846 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7847 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7856 /* Avoid potentially exposing a password in a string about to be logged */
7859 expand_hide_passwords(uschar * s)
7861 return ( ( Ustrstr(s, "failed to expand") != NULL
7862 || Ustrstr(s, "expansion of ") != NULL
7864 && ( Ustrstr(s, "mysql") != NULL
7865 || Ustrstr(s, "pgsql") != NULL
7866 || Ustrstr(s, "redis") != NULL
7867 || Ustrstr(s, "sqlite") != NULL
7868 || Ustrstr(s, "ldap:") != NULL
7869 || Ustrstr(s, "ldaps:") != NULL
7870 || Ustrstr(s, "ldapi:") != NULL
7871 || Ustrstr(s, "ldapdn:") != NULL
7872 || Ustrstr(s, "ldapm:") != NULL
7874 ? US"Temporary internal error" : s;
7878 /* Read given named file into big_buffer. Use for keying material etc.
7879 The content will have an ascii NUL appended.
7884 Return: pointer to buffer, or NULL on error.
7888 expand_file_big_buffer(const uschar * filename)
7890 int fd, off = 0, len;
7892 if ((fd = open(CS filename, O_RDONLY)) < 0)
7894 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
7901 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
7904 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
7912 big_buffer[off] = '\0';
7918 /*************************************************
7919 * Error-checking for testsuite *
7920 *************************************************/
7922 uschar * region_start;
7923 uschar * region_end;
7924 const uschar *var_name;
7925 const uschar *var_data;
7929 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
7932 if (var_data >= e->region_start && var_data < e->region_end)
7934 e->var_name = CUS var_name;
7935 e->var_data = CUS var_data;
7940 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
7942 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
7943 .var_name = NULL, .var_data = NULL };
7947 /* check acl_ variables */
7948 tree_walk(acl_var_c, assert_variable_notin, &e);
7949 tree_walk(acl_var_m, assert_variable_notin, &e);
7951 /* check auth<n> variables */
7952 for (i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
7953 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
7955 /* check regex<n> variables */
7956 for (i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
7957 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
7959 /* check known-name variables */
7960 for (v = var_table; v < var_table + var_table_size; v++)
7961 if (v->type == vtype_stringptr)
7962 assert_variable_notin(US v->name, *(USS v->value), &e);
7964 /* check dns and address trees */
7965 tree_walk(tree_dns_fails, assert_variable_notin, &e);
7966 tree_walk(tree_duplicates, assert_variable_notin, &e);
7967 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
7968 tree_walk(tree_unusable, assert_variable_notin, &e);
7971 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
7972 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
7973 e.var_name, filename, linenumber, e.var_data);
7978 /*************************************************
7979 **************************************************
7980 * Stand-alone test program *
7981 **************************************************
7982 *************************************************/
7988 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7990 int ovector[3*(EXPAND_MAXN+1)];
7991 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7992 ovector, nelem(ovector));
7993 BOOL yield = n >= 0;
7994 if (n == 0) n = EXPAND_MAXN + 1;
7998 expand_nmax = (setup < 0)? 0 : setup + 1;
7999 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
8001 expand_nstring[expand_nmax] = subject + ovector[nn];
8002 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8010 int main(int argc, uschar **argv)
8013 uschar buffer[1024];
8015 debug_selector = D_v;
8016 debug_file = stderr;
8017 debug_fd = fileno(debug_file);
8018 big_buffer = malloc(big_buffer_size);
8020 for (i = 1; i < argc; i++)
8022 if (argv[i][0] == '+')
8024 debug_trace_memory = 2;
8027 if (isdigit(argv[i][0]))
8028 debug_selector = Ustrtol(argv[i], NULL, 0);
8030 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8034 eldap_default_servers = argv[i];
8037 mysql_servers = argv[i];
8040 pgsql_servers = argv[i];
8043 redis_servers = argv[i];
8047 else opt_perl_startup = argv[i];
8051 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8053 expand_nstring[1] = US"string 1....";
8054 expand_nlength[1] = 8;
8058 if (opt_perl_startup != NULL)
8061 printf("Starting Perl interpreter\n");
8062 errstr = init_perl(opt_perl_startup);
8065 printf("** error in perl_startup code: %s\n", errstr);
8066 return EXIT_FAILURE;
8069 #endif /* EXIM_PERL */
8071 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8073 void *reset_point = store_get(0);
8074 uschar *yield = expand_string(buffer);
8077 printf("%s\n", yield);
8078 store_reset(reset_point);
8082 if (search_find_defer) printf("search_find deferred\n");
8083 printf("Failed: %s\n", expand_string_message);
8084 if (expand_string_forcedfail) printf("Forced failure\n");
8098 /* End of expand.c */