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 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
465 { "authenticated_id", vtype_stringptr, &authenticated_id },
466 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
467 { "authentication_failed",vtype_int, &authentication_failed },
468 #ifdef WITH_CONTENT_SCAN
469 { "av_failed", vtype_int, &av_failed },
471 #ifdef EXPERIMENTAL_BRIGHTMAIL
472 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
473 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
474 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
475 { "bmi_deliver", vtype_int, &bmi_deliver },
477 { "body_linecount", vtype_int, &body_linecount },
478 { "body_zerocount", vtype_int, &body_zerocount },
479 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
480 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
481 { "caller_gid", vtype_gid, &real_gid },
482 { "caller_uid", vtype_uid, &real_uid },
483 { "callout_address", vtype_stringptr, &callout_address },
484 { "compile_date", vtype_stringptr, &version_date },
485 { "compile_number", vtype_stringptr, &version_cnumber },
486 { "config_dir", vtype_stringptr, &config_main_directory },
487 { "config_file", vtype_stringptr, &config_main_filename },
488 { "csa_status", vtype_stringptr, &csa_status },
489 #ifdef EXPERIMENTAL_DCC
490 { "dcc_header", vtype_stringptr, &dcc_header },
491 { "dcc_result", vtype_stringptr, &dcc_result },
494 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
495 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
496 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
497 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
498 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
499 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
500 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
501 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
502 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
503 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
504 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
505 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
506 { "dkim_key_length", vtype_int, &dkim_key_length },
507 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
508 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
509 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
510 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
511 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
512 { "dkim_signers", vtype_stringptr, &dkim_signers },
513 { "dkim_verify_reason", vtype_stringptr, &dkim_verify_reason },
514 { "dkim_verify_status", vtype_stringptr, &dkim_verify_status },
516 #ifdef EXPERIMENTAL_DMARC
517 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
518 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
519 { "dmarc_status", vtype_stringptr, &dmarc_status },
520 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
521 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
523 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
524 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
525 { "dnslist_text", vtype_stringptr, &dnslist_text },
526 { "dnslist_value", vtype_stringptr, &dnslist_value },
527 { "domain", vtype_stringptr, &deliver_domain },
528 { "domain_data", vtype_stringptr, &deliver_domain_data },
529 #ifndef DISABLE_EVENT
530 { "event_data", vtype_stringptr, &event_data },
532 /*XXX want to use generic vars for as many of these as possible*/
533 { "event_defer_errno", vtype_int, &event_defer_errno },
535 { "event_name", vtype_stringptr, &event_name },
537 { "exim_gid", vtype_gid, &exim_gid },
538 { "exim_path", vtype_stringptr, &exim_path },
539 { "exim_uid", vtype_uid, &exim_uid },
540 { "exim_version", vtype_stringptr, &version_string },
541 { "headers_added", vtype_string_func, &fn_hdrs_added },
542 { "home", vtype_stringptr, &deliver_home },
543 { "host", vtype_stringptr, &deliver_host },
544 { "host_address", vtype_stringptr, &deliver_host_address },
545 { "host_data", vtype_stringptr, &host_data },
546 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
547 { "host_lookup_failed", vtype_int, &host_lookup_failed },
548 { "host_port", vtype_int, &deliver_host_port },
549 { "initial_cwd", vtype_stringptr, &initial_cwd },
550 { "inode", vtype_ino, &deliver_inode },
551 { "interface_address", vtype_stringptr, &interface_address },
552 { "interface_port", vtype_int, &interface_port },
553 { "item", vtype_stringptr, &iterate_item },
555 { "ldap_dn", vtype_stringptr, &eldap_dn },
557 { "load_average", vtype_load_avg, NULL },
558 { "local_part", vtype_stringptr, &deliver_localpart },
559 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
560 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
561 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
562 { "local_scan_data", vtype_stringptr, &local_scan_data },
563 { "local_user_gid", vtype_gid, &local_user_gid },
564 { "local_user_uid", vtype_uid, &local_user_uid },
565 { "localhost_number", vtype_int, &host_number },
566 { "log_inodes", vtype_pinodes, (void *)FALSE },
567 { "log_space", vtype_pspace, (void *)FALSE },
568 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
569 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
570 #ifdef WITH_CONTENT_SCAN
571 { "malware_name", vtype_stringptr, &malware_name },
573 { "max_received_linelength", vtype_int, &max_received_linelength },
574 { "message_age", vtype_int, &message_age },
575 { "message_body", vtype_msgbody, &message_body },
576 { "message_body_end", vtype_msgbody_end, &message_body_end },
577 { "message_body_size", vtype_int, &message_body_size },
578 { "message_exim_id", vtype_stringptr, &message_id },
579 { "message_headers", vtype_msgheaders, NULL },
580 { "message_headers_raw", vtype_msgheaders_raw, NULL },
581 { "message_id", vtype_stringptr, &message_id },
582 { "message_linecount", vtype_int, &message_linecount },
583 { "message_size", vtype_int, &message_size },
585 { "message_smtputf8", vtype_bool, &message_smtputf8 },
587 #ifdef WITH_CONTENT_SCAN
588 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
589 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
590 { "mime_boundary", vtype_stringptr, &mime_boundary },
591 { "mime_charset", vtype_stringptr, &mime_charset },
592 { "mime_content_description", vtype_stringptr, &mime_content_description },
593 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
594 { "mime_content_id", vtype_stringptr, &mime_content_id },
595 { "mime_content_size", vtype_int, &mime_content_size },
596 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
597 { "mime_content_type", vtype_stringptr, &mime_content_type },
598 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
599 { "mime_filename", vtype_stringptr, &mime_filename },
600 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
601 { "mime_is_multipart", vtype_int, &mime_is_multipart },
602 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
603 { "mime_part_count", vtype_int, &mime_part_count },
605 { "n0", vtype_filter_int, &filter_n[0] },
606 { "n1", vtype_filter_int, &filter_n[1] },
607 { "n2", vtype_filter_int, &filter_n[2] },
608 { "n3", vtype_filter_int, &filter_n[3] },
609 { "n4", vtype_filter_int, &filter_n[4] },
610 { "n5", vtype_filter_int, &filter_n[5] },
611 { "n6", vtype_filter_int, &filter_n[6] },
612 { "n7", vtype_filter_int, &filter_n[7] },
613 { "n8", vtype_filter_int, &filter_n[8] },
614 { "n9", vtype_filter_int, &filter_n[9] },
615 { "original_domain", vtype_stringptr, &deliver_domain_orig },
616 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
617 { "originator_gid", vtype_gid, &originator_gid },
618 { "originator_uid", vtype_uid, &originator_uid },
619 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
620 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
621 { "pid", vtype_pid, NULL },
623 { "prdr_requested", vtype_bool, &prdr_requested },
625 { "primary_hostname", vtype_stringptr, &primary_hostname },
626 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
627 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
628 { "proxy_external_port", vtype_int, &proxy_external_port },
629 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
630 { "proxy_local_port", vtype_int, &proxy_local_port },
631 { "proxy_session", vtype_bool, &proxy_session },
633 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
634 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
635 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
636 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
637 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
638 { "queue_name", vtype_stringptr, &queue_name },
639 { "rcpt_count", vtype_int, &rcpt_count },
640 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
641 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
642 { "received_count", vtype_int, &received_count },
643 { "received_for", vtype_stringptr, &received_for },
644 { "received_ip_address", vtype_stringptr, &interface_address },
645 { "received_port", vtype_int, &interface_port },
646 { "received_protocol", vtype_stringptr, &received_protocol },
647 { "received_time", vtype_int, &received_time.tv_sec },
648 { "recipient_data", vtype_stringptr, &recipient_data },
649 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
650 { "recipients", vtype_string_func, &fn_recipients },
651 { "recipients_count", vtype_int, &recipients_count },
652 #ifdef WITH_CONTENT_SCAN
653 { "regex_match_string", vtype_stringptr, ®ex_match_string },
655 { "reply_address", vtype_reply, NULL },
656 { "return_path", vtype_stringptr, &return_path },
657 { "return_size_limit", vtype_int, &bounce_return_size_limit },
658 { "router_name", vtype_stringptr, &router_name },
659 { "runrc", vtype_int, &runrc },
660 { "self_hostname", vtype_stringptr, &self_hostname },
661 { "sender_address", vtype_stringptr, &sender_address },
662 { "sender_address_data", vtype_stringptr, &sender_address_data },
663 { "sender_address_domain", vtype_domain, &sender_address },
664 { "sender_address_local_part", vtype_localpart, &sender_address },
665 { "sender_data", vtype_stringptr, &sender_data },
666 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
667 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
668 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
669 { "sender_host_address", vtype_stringptr, &sender_host_address },
670 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
671 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
672 { "sender_host_name", vtype_host_lookup, NULL },
673 { "sender_host_port", vtype_int, &sender_host_port },
674 { "sender_ident", vtype_stringptr, &sender_ident },
675 { "sender_rate", vtype_stringptr, &sender_rate },
676 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
677 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
678 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
679 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
680 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
681 { "sending_port", vtype_int, &sending_port },
682 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
683 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
684 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
685 { "smtp_command_history", vtype_string_func, &smtp_cmd_hist },
686 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
687 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
688 { "sn0", vtype_filter_int, &filter_sn[0] },
689 { "sn1", vtype_filter_int, &filter_sn[1] },
690 { "sn2", vtype_filter_int, &filter_sn[2] },
691 { "sn3", vtype_filter_int, &filter_sn[3] },
692 { "sn4", vtype_filter_int, &filter_sn[4] },
693 { "sn5", vtype_filter_int, &filter_sn[5] },
694 { "sn6", vtype_filter_int, &filter_sn[6] },
695 { "sn7", vtype_filter_int, &filter_sn[7] },
696 { "sn8", vtype_filter_int, &filter_sn[8] },
697 { "sn9", vtype_filter_int, &filter_sn[9] },
698 #ifdef WITH_CONTENT_SCAN
699 { "spam_action", vtype_stringptr, &spam_action },
700 { "spam_bar", vtype_stringptr, &spam_bar },
701 { "spam_report", vtype_stringptr, &spam_report },
702 { "spam_score", vtype_stringptr, &spam_score },
703 { "spam_score_int", vtype_stringptr, &spam_score_int },
706 { "spf_guess", vtype_stringptr, &spf_guess },
707 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
708 { "spf_received", vtype_stringptr, &spf_received },
709 { "spf_result", vtype_stringptr, &spf_result },
710 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
712 { "spool_directory", vtype_stringptr, &spool_directory },
713 { "spool_inodes", vtype_pinodes, (void *)TRUE },
714 { "spool_space", vtype_pspace, (void *)TRUE },
715 #ifdef EXPERIMENTAL_SRS
716 { "srs_db_address", vtype_stringptr, &srs_db_address },
717 { "srs_db_key", vtype_stringptr, &srs_db_key },
718 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
719 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
720 { "srs_recipient", vtype_stringptr, &srs_recipient },
721 { "srs_status", vtype_stringptr, &srs_status },
723 { "thisaddress", vtype_stringptr, &filter_thisaddress },
725 /* The non-(in,out) variables are now deprecated */
726 { "tls_bits", vtype_int, &tls_in.bits },
727 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
728 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
730 { "tls_in_bits", vtype_int, &tls_in.bits },
731 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
732 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
733 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
734 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
735 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
736 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
737 #if defined(SUPPORT_TLS)
738 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
740 { "tls_out_bits", vtype_int, &tls_out.bits },
741 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
742 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
744 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
746 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
747 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
748 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
749 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
750 #if defined(SUPPORT_TLS)
751 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
754 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
757 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
758 #if defined(SUPPORT_TLS)
759 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
762 { "tod_bsdinbox", vtype_todbsdin, NULL },
763 { "tod_epoch", vtype_tode, NULL },
764 { "tod_epoch_l", vtype_todel, NULL },
765 { "tod_full", vtype_todf, NULL },
766 { "tod_log", vtype_todl, NULL },
767 { "tod_logfile", vtype_todlf, NULL },
768 { "tod_zone", vtype_todzone, NULL },
769 { "tod_zulu", vtype_todzulu, NULL },
770 { "transport_name", vtype_stringptr, &transport_name },
771 { "value", vtype_stringptr, &lookup_value },
772 { "verify_mode", vtype_stringptr, &verify_mode },
773 { "version_number", vtype_stringptr, &version_string },
774 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
775 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
776 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
777 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
778 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
779 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
782 static int var_table_size = nelem(var_table);
783 static uschar var_buffer[256];
784 static BOOL malformed_header;
786 /* For textual hashes */
788 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
789 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
792 enum { HMAC_MD5, HMAC_SHA1 };
794 /* For numeric hashes */
796 static unsigned int prime[] = {
797 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
798 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
799 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
801 /* For printing modes in symbolic form */
803 static uschar *mtable_normal[] =
804 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
806 static uschar *mtable_setid[] =
807 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
809 static uschar *mtable_sticky[] =
810 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
814 /*************************************************
815 * Tables for UTF-8 support *
816 *************************************************/
818 /* Table of the number of extra characters, indexed by the first character
819 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
822 static uschar utf8_table1[] = {
823 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
824 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
825 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
826 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
828 /* These are the masks for the data bits in the first byte of a character,
829 indexed by the number of additional bytes. */
831 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
833 /* Get the next UTF-8 character, advancing the pointer. */
835 #define GETUTF8INC(c, ptr) \
837 if ((c & 0xc0) == 0xc0) \
839 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
841 c = (c & utf8_table2[a]) << s; \
845 c |= (*ptr++ & 0x3f) << s; \
851 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
853 /*************************************************
854 * Binary chop search on a table *
855 *************************************************/
857 /* This is used for matching expansion items and operators.
860 name the name that is being sought
861 table the table to search
862 table_size the number of items in the table
864 Returns: the offset in the table, or -1
868 chop_match(uschar *name, uschar **table, int table_size)
870 uschar **bot = table;
871 uschar **top = table + table_size;
875 uschar **mid = bot + (top - bot)/2;
876 int c = Ustrcmp(name, *mid);
877 if (c == 0) return mid - table;
878 if (c > 0) bot = mid + 1; else top = mid;
886 /*************************************************
887 * Check a condition string *
888 *************************************************/
890 /* This function is called to expand a string, and test the result for a "true"
891 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
892 forced fail or lookup defer.
894 We used to release all store used, but this is not not safe due
895 to ${dlfunc } and ${acl }. In any case expand_string_internal()
896 is reasonably careful to release what it can.
898 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
901 condition the condition string
902 m1 text to be incorporated in panic error
905 Returns: TRUE if condition is met, FALSE if not
909 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
912 uschar *ss = expand_string(condition);
915 if (!expand_string_forcedfail && !search_find_defer)
916 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
917 "for %s %s: %s", condition, m1, m2, expand_string_message);
920 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
921 strcmpic(ss, US"false") != 0;
928 /*************************************************
929 * Pseudo-random number generation *
930 *************************************************/
932 /* Pseudo-random number generation. The result is not "expected" to be
933 cryptographically strong but not so weak that someone will shoot themselves
934 in the foot using it as a nonce in some email header scheme or whatever
935 weirdness they'll twist this into. The result should ideally handle fork().
937 However, if we're stuck unable to provide this, then we'll fall back to
938 appallingly bad randomness.
940 If SUPPORT_TLS is defined then this will not be used except as an emergency
945 Returns a random number in range [0, max-1]
949 # define vaguely_random_number vaguely_random_number_fallback
952 vaguely_random_number(int max)
955 # undef vaguely_random_number
957 static pid_t pid = 0;
959 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
969 #ifdef HAVE_ARC4RANDOM
970 /* cryptographically strong randomness, common on *BSD platforms, not
971 so much elsewhere. Alas. */
972 #ifndef NOT_HAVE_ARC4RANDOM_STIR
975 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
976 #ifdef HAVE_SRANDOMDEV
977 /* uses random(4) for seeding */
980 gettimeofday(&tv, NULL);
981 srandom(tv.tv_sec | tv.tv_usec | getpid());
984 /* Poor randomness and no seeding here */
991 #ifdef HAVE_ARC4RANDOM
992 return arc4random() % max;
993 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
994 return random() % max;
996 /* This one returns a 16-bit number, definitely not crypto-strong */
997 return random_number(max);
1004 /*************************************************
1005 * Pick out a name from a string *
1006 *************************************************/
1008 /* If the name is too long, it is silently truncated.
1011 name points to a buffer into which to put the name
1012 max is the length of the buffer
1013 s points to the first alphabetic character of the name
1014 extras chars other than alphanumerics to permit
1016 Returns: pointer to the first character after the name
1018 Note: The test for *s != 0 in the while loop is necessary because
1019 Ustrchr() yields non-NULL if the character is zero (which is not something
1022 static const uschar *
1023 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1026 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1028 if (ptr < max-1) name[ptr++] = *s;
1037 /*************************************************
1038 * Pick out the rest of a header name *
1039 *************************************************/
1041 /* A variable name starting $header_ (or just $h_ for those who like
1042 abbreviations) might not be the complete header name because headers can
1043 contain any printing characters in their names, except ':'. This function is
1044 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1045 on the end, if the name was terminated by white space.
1048 name points to a buffer in which the name read so far exists
1049 max is the length of the buffer
1050 s points to the first character after the name so far, i.e. the
1051 first non-alphameric character after $header_xxxxx
1053 Returns: a pointer to the first character after the header name
1056 static const uschar *
1057 read_header_name(uschar *name, int max, const uschar *s)
1059 int prelen = Ustrchr(name, '_') - name + 1;
1060 int ptr = Ustrlen(name) - prelen;
1061 if (ptr > 0) memmove(name, name+prelen, ptr);
1062 while (mac_isgraph(*s) && *s != ':')
1064 if (ptr < max-1) name[ptr++] = *s;
1075 /*************************************************
1076 * Pick out a number from a string *
1077 *************************************************/
1080 n points to an integer into which to put the number
1081 s points to the first digit of the number
1083 Returns: a pointer to the character after the last digit
1085 /*XXX consider expanding to int_eximarith_t. But the test for
1086 "overbig numbers" in 0002 still needs to overflow it. */
1089 read_number(int *n, uschar *s)
1092 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1096 static const uschar *
1097 read_cnumber(int *n, const uschar *s)
1100 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1106 /*************************************************
1107 * Extract keyed subfield from a string *
1108 *************************************************/
1110 /* The yield is in dynamic store; NULL means that the key was not found.
1113 key points to the name of the key
1114 s points to the string from which to extract the subfield
1116 Returns: NULL if the subfield was not found, or
1117 a pointer to the subfield's data
1121 expand_getkeyed(uschar *key, const uschar *s)
1123 int length = Ustrlen(key);
1124 while (isspace(*s)) s++;
1126 /* Loop to search for the key */
1132 const uschar *dkey = s;
1134 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1135 dkeylength = s - dkey;
1136 while (isspace(*s)) s++;
1137 if (*s == '=') while (isspace((*(++s))));
1139 data = string_dequote(&s);
1140 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1143 while (isspace(*s)) s++;
1152 find_var_ent(uschar * name)
1155 int last = var_table_size;
1157 while (last > first)
1159 int middle = (first + last)/2;
1160 int c = Ustrcmp(name, var_table[middle].name);
1162 if (c > 0) { first = middle + 1; continue; }
1163 if (c < 0) { last = middle; continue; }
1164 return &var_table[middle];
1169 /*************************************************
1170 * Extract numbered subfield from string *
1171 *************************************************/
1173 /* Extracts a numbered field from a string that is divided by tokens - for
1174 example a line from /etc/passwd is divided by colon characters. First field is
1175 numbered one. Negative arguments count from the right. Zero returns the whole
1176 string. Returns NULL if there are insufficient tokens in the string
1179 Modifies final argument - this is a dynamically generated string, so that's OK.
1182 field number of field to be extracted,
1183 first field = 1, whole string = 0, last field = -1
1184 separators characters that are used to break string into tokens
1185 s points to the string from which to extract the subfield
1187 Returns: NULL if the field was not found,
1188 a pointer to the field's data inside s (modified to add 0)
1192 expand_gettokened (int field, uschar *separators, uschar *s)
1197 uschar *fieldtext = NULL;
1199 if (field == 0) return s;
1201 /* Break the line up into fields in place; for field > 0 we stop when we have
1202 done the number of fields we want. For field < 0 we continue till the end of
1203 the string, counting the number of fields. */
1205 count = (field > 0)? field : INT_MAX;
1211 /* Previous field was the last one in the string. For a positive field
1212 number, this means there are not enough fields. For a negative field number,
1213 check that there are enough, and scan back to find the one that is wanted. */
1217 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1218 if ((-field) == (INT_MAX - count - 1)) return s;
1222 while (ss[-1] != 0) ss--;
1228 /* Previous field was not last in the string; save its start and put a
1232 len = Ustrcspn(ss, separators);
1243 expand_getlistele(int field, const uschar * list)
1245 const uschar * tlist= list;
1251 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1254 if(field==0) return NULL;
1255 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1256 return string_nextinlist(&list, &sep, NULL, 0);
1260 /* Certificate fields, by name. Worry about by-OID later */
1261 /* Names are chosen to not have common prefixes */
1268 uschar * (*getfn)(void * cert, uschar * mod);
1270 static certfield certfields[] =
1271 { /* linear search; no special order */
1272 { US"version", 7, &tls_cert_version },
1273 { US"serial_number", 13, &tls_cert_serial_number },
1274 { US"subject", 7, &tls_cert_subject },
1275 { US"notbefore", 9, &tls_cert_not_before },
1276 { US"notafter", 8, &tls_cert_not_after },
1277 { US"issuer", 6, &tls_cert_issuer },
1278 { US"signature", 9, &tls_cert_signature },
1279 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1280 { US"subj_altname", 12, &tls_cert_subject_altname },
1281 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1282 { US"crl_uri", 7, &tls_cert_crl_uri },
1286 expand_getcertele(uschar * field, uschar * certvar)
1291 if (!(vp = find_var_ent(certvar)))
1293 expand_string_message =
1294 string_sprintf("no variable named \"%s\"", certvar);
1295 return NULL; /* Unknown variable name */
1297 /* NB this stops us passing certs around in variable. Might
1298 want to do that in future */
1299 if (vp->type != vtype_cert)
1301 expand_string_message =
1302 string_sprintf("\"%s\" is not a certificate", certvar);
1303 return NULL; /* Unknown variable name */
1305 if (!*(void **)vp->value)
1308 if (*field >= '0' && *field <= '9')
1309 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1311 for(cp = certfields;
1312 cp < certfields + nelem(certfields);
1314 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1316 uschar * modifier = *(field += cp->namelen) == ','
1318 return (*cp->getfn)( *(void **)vp->value, modifier );
1321 expand_string_message =
1322 string_sprintf("bad field selector \"%s\" for certextract", field);
1325 #endif /*SUPPORT_TLS*/
1327 /*************************************************
1328 * Extract a substring from a string *
1329 *************************************************/
1331 /* Perform the ${substr or ${length expansion operations.
1334 subject the input string
1335 value1 the offset from the start of the input string to the start of
1336 the output string; if negative, count from the right.
1337 value2 the length of the output string, or negative (-1) for unset
1338 if value1 is positive, unset means "all after"
1339 if value1 is negative, unset means "all before"
1340 len set to the length of the returned string
1342 Returns: pointer to the output string, or NULL if there is an error
1346 extract_substr(uschar *subject, int value1, int value2, int *len)
1348 int sublen = Ustrlen(subject);
1350 if (value1 < 0) /* count from right */
1354 /* If the position is before the start, skip to the start, and adjust the
1355 length. If the length ends up negative, the substring is null because nothing
1356 can precede. This falls out naturally when the length is unset, meaning "all
1362 if (value2 < 0) value2 = 0;
1366 /* Otherwise an unset length => characters before value1 */
1368 else if (value2 < 0)
1375 /* For a non-negative offset, if the starting position is past the end of the
1376 string, the result will be the null string. Otherwise, an unset length means
1377 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1381 if (value1 > sublen)
1386 else if (value2 < 0) value2 = sublen;
1389 /* Cut the length down to the maximum possible for the offset value, and get
1390 the required characters. */
1392 if (value1 + value2 > sublen) value2 = sublen - value1;
1394 return subject + value1;
1400 /*************************************************
1401 * Old-style hash of a string *
1402 *************************************************/
1404 /* Perform the ${hash expansion operation.
1407 subject the input string (an expanded substring)
1408 value1 the length of the output string; if greater or equal to the
1409 length of the input string, the input string is returned
1410 value2 the number of hash characters to use, or 26 if negative
1411 len set to the length of the returned string
1413 Returns: pointer to the output string, or NULL if there is an error
1417 compute_hash(uschar *subject, int value1, int value2, int *len)
1419 int sublen = Ustrlen(subject);
1421 if (value2 < 0) value2 = 26;
1422 else if (value2 > Ustrlen(hashcodes))
1424 expand_string_message =
1425 string_sprintf("hash count \"%d\" too big", value2);
1429 /* Calculate the hash text. We know it is shorter than the original string, so
1430 can safely place it in subject[] (we know that subject is always itself an
1431 expanded substring). */
1433 if (value1 < sublen)
1438 while ((c = (subject[j])) != 0)
1440 int shift = (c + j++) & 7;
1441 subject[i] ^= (c << shift) | (c >> (8-shift));
1442 if (++i >= value1) i = 0;
1444 for (i = 0; i < value1; i++)
1445 subject[i] = hashcodes[(subject[i]) % value2];
1447 else value1 = sublen;
1456 /*************************************************
1457 * Numeric hash of a string *
1458 *************************************************/
1460 /* Perform the ${nhash expansion operation. The first characters of the
1461 string are treated as most important, and get the highest prime numbers.
1464 subject the input string
1465 value1 the maximum value of the first part of the result
1466 value2 the maximum value of the second part of the result,
1467 or negative to produce only a one-part result
1468 len set to the length of the returned string
1470 Returns: pointer to the output string, or NULL if there is an error.
1474 compute_nhash (uschar *subject, int value1, int value2, int *len)
1476 uschar *s = subject;
1478 unsigned long int total = 0; /* no overflow */
1482 if (i == 0) i = nelem(prime) - 1;
1483 total += prime[i--] * (unsigned int)(*s++);
1486 /* If value2 is unset, just compute one number */
1489 s = string_sprintf("%lu", total % value1);
1491 /* Otherwise do a div/mod hash */
1495 total = total % (value1 * value2);
1496 s = string_sprintf("%lu/%lu", total/value2, total % value2);
1507 /*************************************************
1508 * Find the value of a header or headers *
1509 *************************************************/
1511 /* Multiple instances of the same header get concatenated, and this function
1512 can also return a concatenation of all the header lines. When concatenating
1513 specific headers that contain lists of addresses, a comma is inserted between
1514 them. Otherwise we use a straight concatenation. Because some messages can have
1515 pathologically large number of lines, there is a limit on the length that is
1516 returned. Also, to avoid massive store use which would result from using
1517 string_cat() as it copies and extends strings, we do a preliminary pass to find
1518 out exactly how much store will be needed. On "normal" messages this will be
1522 name the name of the header, without the leading $header_ or $h_,
1523 or NULL if a concatenation of all headers is required
1524 exists_only TRUE if called from a def: test; don't need to build a string;
1525 just return a string that is not "" and not "0" if the header
1527 newsize return the size of memory block that was obtained; may be NULL
1528 if exists_only is TRUE
1529 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1530 other than concatenating, will be done on the header. Also used
1531 for $message_headers_raw.
1532 charset name of charset to translate MIME words to; used only if
1533 want_raw is false; if NULL, no translation is done (this is
1534 used for $bh_ and $bheader_)
1536 Returns: NULL if the header does not exist, else a pointer to a new
1541 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1544 BOOL found = name == NULL;
1546 int len = found? 0 : Ustrlen(name);
1548 uschar *yield = NULL;
1551 /* Loop for two passes - saves code repetition */
1553 for (i = 0; i < 2; i++)
1558 for (h = header_list; size < header_insert_maxlen && h; h = h->next)
1559 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1560 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1565 if (exists_only) return US"1"; /* don't need actual string */
1567 t = h->text + len; /* text to insert */
1568 if (!want_raw) /* unless wanted raw, */
1569 while (isspace(*t)) t++; /* remove leading white space */
1570 ilen = h->slen - (t - h->text); /* length to insert */
1572 /* Unless wanted raw, remove trailing whitespace, including the
1576 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1578 /* Set comma = 1 if handling a single header and it's one of those
1579 that contains an address list, except when asked for raw headers. Only
1580 need to do this once. */
1582 if (!want_raw && name && comma == 0 &&
1583 Ustrchr("BCFRST", h->type) != NULL)
1586 /* First pass - compute total store needed; second pass - compute
1587 total store used, including this header. */
1589 size += ilen + comma + 1; /* +1 for the newline */
1591 /* Second pass - concatenate the data, up to a maximum. Note that
1592 the loop stops when size hits the limit. */
1596 if (size > header_insert_maxlen)
1598 ilen -= size - header_insert_maxlen - 1;
1601 Ustrncpy(ptr, t, ilen);
1604 /* For a non-raw header, put in the comma if needed, then add
1605 back the newline we removed above, provided there was some text in
1608 if (!want_raw && ilen > 0)
1610 if (comma != 0) *ptr++ = ',';
1616 /* At end of first pass, return NULL if no header found. Then truncate size
1617 if necessary, and get the buffer to hold the data, returning the buffer size.
1622 if (!found) return NULL;
1623 if (size > header_insert_maxlen) size = header_insert_maxlen;
1624 *newsize = size + 1;
1625 ptr = yield = store_get(*newsize);
1629 /* That's all we do for raw header expansion. */
1634 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1635 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1636 function can return an error with decoded data if the charset translation
1637 fails. If decoding fails, it returns NULL. */
1641 uschar *decoded, *error;
1642 if (ptr > yield && ptr[-1] == '\n') ptr--;
1643 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1645 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1649 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1650 " input was: %s\n", error, yield);
1652 if (decoded != NULL) yield = decoded;
1661 /* Append an "iprev" element to an Autherntication-Results: header
1662 if we have attempted to get the calling host's name.
1666 authres_iprev(gstring * g)
1668 if (sender_host_name)
1669 return string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1670 if (host_lookup_deferred)
1671 return string_catn(g, US";\n\tiprev=temperror", 19);
1672 if (host_lookup_failed)
1673 return string_catn(g, US";\n\tiprev=fail", 13);
1679 /*************************************************
1680 * Return list of recipients *
1681 *************************************************/
1682 /* A recipients list is available only during system message filtering,
1683 during ACL processing after DATA, and while expanding pipe commands
1684 generated from a system filter, but not elsewhere. */
1692 if (!enable_dollar_recipients) return NULL;
1694 for (i = 0; i < recipients_count; i++)
1696 /*XXX variant of list_appendele? */
1697 if (i != 0) g = string_catn(g, US", ", 2);
1698 g = string_cat(g, recipients_list[i].address);
1700 return string_from_gstring(g);
1704 /*************************************************
1705 * Find value of a variable *
1706 *************************************************/
1708 /* The table of variables is kept in alphabetic order, so we can search it
1709 using a binary chop. The "choplen" variable is nothing to do with the binary
1713 name the name of the variable being sought
1714 exists_only TRUE if this is a def: test; passed on to find_header()
1715 skipping TRUE => skip any processing evaluation; this is not the same as
1716 exists_only because def: may test for values that are first
1718 newsize pointer to an int which is initially zero; if the answer is in
1719 a new memory buffer, *newsize is set to its size
1721 Returns: NULL if the variable does not exist, or
1722 a pointer to the variable's contents, or
1723 something non-NULL if exists_only is TRUE
1727 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1734 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1735 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1736 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1737 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1738 (this gave backwards compatibility at the changeover). There may be built-in
1739 variables whose names start acl_ but they should never start in this way. This
1740 slightly messy specification is a consequence of the history, needless to say.
1742 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1743 set, in which case give an error. */
1745 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1749 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1750 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1753 /* Handle $auth<n> variables. */
1755 if (Ustrncmp(name, "auth", 4) == 0)
1758 int n = Ustrtoul(name + 4, &endptr, 10);
1759 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1760 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1762 else if (Ustrncmp(name, "regex", 5) == 0)
1765 int n = Ustrtoul(name + 5, &endptr, 10);
1766 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1767 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1770 /* For all other variables, search the table */
1772 if (!(vp = find_var_ent(name)))
1773 return NULL; /* Unknown variable name */
1775 /* Found an existing variable. If in skipping state, the value isn't needed,
1776 and we want to avoid processing (such as looking up the host name). */
1784 case vtype_filter_int:
1785 if (!filter_running) return NULL;
1789 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1793 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1797 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1801 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1805 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1808 case vtype_stringptr: /* Pointer to string */
1809 return (s = *((uschar **)(val))) ? s : US"";
1812 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1815 case vtype_load_avg:
1816 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1819 case vtype_host_lookup: /* Lookup if not done so */
1820 if ( !sender_host_name && sender_host_address
1821 && !host_lookup_failed && host_name_lookup() == OK)
1822 host_build_sender_fullhost();
1823 return sender_host_name ? sender_host_name : US"";
1825 case vtype_localpart: /* Get local part from address */
1826 s = *((uschar **)(val));
1827 if (s == NULL) return US"";
1828 domain = Ustrrchr(s, '@');
1829 if (domain == NULL) return s;
1830 if (domain - s > sizeof(var_buffer) - 1)
1831 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1832 " in string expansion", sizeof(var_buffer));
1833 Ustrncpy(var_buffer, s, domain - s);
1834 var_buffer[domain - s] = 0;
1837 case vtype_domain: /* Get domain from address */
1838 s = *((uschar **)(val));
1839 if (s == NULL) return US"";
1840 domain = Ustrrchr(s, '@');
1841 return (domain == NULL)? US"" : domain + 1;
1843 case vtype_msgheaders:
1844 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1846 case vtype_msgheaders_raw:
1847 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1849 case vtype_msgbody: /* Pointer to msgbody string */
1850 case vtype_msgbody_end: /* Ditto, the end of the msg */
1851 ss = (uschar **)(val);
1852 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1855 off_t start_offset = SPOOL_DATA_START_OFFSET;
1856 int len = message_body_visible;
1857 if (len > message_size) len = message_size;
1858 *ss = body = store_malloc(len+1);
1860 if (vp->type == vtype_msgbody_end)
1862 struct stat statbuf;
1863 if (fstat(deliver_datafile, &statbuf) == 0)
1865 start_offset = statbuf.st_size - len;
1866 if (start_offset < SPOOL_DATA_START_OFFSET)
1867 start_offset = SPOOL_DATA_START_OFFSET;
1870 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1871 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1873 len = read(deliver_datafile, body, len);
1877 if (message_body_newlines) /* Separate loops for efficiency */
1879 { if (body[--len] == 0) body[len] = ' '; }
1882 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1885 return *ss ? *ss : US"";
1887 case vtype_todbsdin: /* BSD inbox time of day */
1888 return tod_stamp(tod_bsdin);
1890 case vtype_tode: /* Unix epoch time of day */
1891 return tod_stamp(tod_epoch);
1893 case vtype_todel: /* Unix epoch/usec time of day */
1894 return tod_stamp(tod_epoch_l);
1896 case vtype_todf: /* Full time of day */
1897 return tod_stamp(tod_full);
1899 case vtype_todl: /* Log format time of day */
1900 return tod_stamp(tod_log_bare); /* (without timezone) */
1902 case vtype_todzone: /* Time zone offset only */
1903 return tod_stamp(tod_zone);
1905 case vtype_todzulu: /* Zulu time */
1906 return tod_stamp(tod_zulu);
1908 case vtype_todlf: /* Log file datestamp tod */
1909 return tod_stamp(tod_log_datestamp_daily);
1911 case vtype_reply: /* Get reply address */
1912 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1914 if (s != NULL) while (isspace(*s)) s++;
1915 if (s == NULL || *s == 0)
1917 *newsize = 0; /* For the *s==0 case */
1918 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1923 while (isspace(*s)) s++;
1924 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1925 while (t > s && isspace(t[-1])) t--;
1928 return (s == NULL)? US"" : s;
1930 case vtype_string_func:
1932 uschar * (*fn)() = val;
1939 sprintf(CS var_buffer, "%d",
1940 receive_statvfs(val == (void *)TRUE, &inodes));
1947 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1948 sprintf(CS var_buffer, "%d", inodes);
1953 return *(void **)val ? US"<cert>" : US"";
1955 #ifndef DISABLE_DKIM
1957 return dkim_exim_expand_query((int)(long)val);
1962 return NULL; /* Unknown variable. Silences static checkers. */
1969 modify_variable(uschar *name, void * value)
1972 if ((vp = find_var_ent(name))) vp->value = value;
1973 return; /* Unknown variable name, fail silently */
1981 /*************************************************
1982 * Read and expand substrings *
1983 *************************************************/
1985 /* This function is called to read and expand argument substrings for various
1986 expansion items. Some have a minimum requirement that is less than the maximum;
1987 in these cases, the first non-present one is set to NULL.
1990 sub points to vector of pointers to set
1991 n maximum number of substrings
1993 sptr points to current string pointer
1994 skipping the skipping flag
1995 check_end if TRUE, check for final '}'
1996 name name of item, for error message
1997 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2000 Returns: 0 OK; string pointer updated
2001 1 curly bracketing error (too few arguments)
2002 2 too many arguments (only if check_end is set); message set
2003 3 other error (expansion failure)
2007 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
2008 BOOL check_end, uschar *name, BOOL *resetok)
2011 const uschar *s = *sptr;
2013 while (isspace(*s)) s++;
2014 for (i = 0; i < n; i++)
2020 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2021 "(min is %d)", name, m);
2027 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2029 if (*s++ != '}') return 1;
2030 while (isspace(*s)) s++;
2032 if (check_end && *s++ != '}')
2036 expand_string_message = string_sprintf("Too many arguments for '%s' "
2037 "(max is %d)", name, n);
2040 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2051 /*************************************************
2052 * Elaborate message for bad variable *
2053 *************************************************/
2055 /* For the "unknown variable" message, take a look at the variable's name, and
2056 give additional information about possible ACL variables. The extra information
2057 is added on to expand_string_message.
2059 Argument: the name of the variable
2064 check_variable_error_message(uschar *name)
2066 if (Ustrncmp(name, "acl_", 4) == 0)
2067 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2068 (name[4] == 'c' || name[4] == 'm')?
2070 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2071 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2073 US"user-defined ACL variables must start acl_c or acl_m");
2079 Load args from sub array to globals, and call acl_check().
2080 Sub array will be corrupted on return.
2082 Returns: OK access is granted by an ACCEPT verb
2083 DISCARD access is (apparently) granted by a DISCARD verb
2084 FAIL access is denied
2085 FAIL_DROP access is denied; drop the connection
2086 DEFER can't tell at the moment
2090 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2093 int sav_narg = acl_narg;
2095 uschar * dummy_logmsg;
2096 extern int acl_where;
2098 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2099 for (i = 0; i < nsub && sub[i+1]; i++)
2101 uschar * tmp = acl_arg[i];
2102 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2103 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2108 sub[i+1] = acl_arg[i];
2109 acl_arg[i++] = NULL;
2113 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2115 acl_narg>0 ? acl_arg[0] : US"<none>",
2116 acl_narg>1 ? " +more" : "");
2118 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2120 for (i = 0; i < nsub; i++)
2121 acl_arg[i] = sub[i+1]; /* restore old args */
2122 acl_narg = sav_narg;
2130 /*************************************************
2131 * Read and evaluate a condition *
2132 *************************************************/
2136 s points to the start of the condition text
2137 resetok points to a BOOL which is written false if it is unsafe to
2138 free memory. Certain condition types (acl) may have side-effect
2139 allocation which must be preserved.
2140 yield points to a BOOL to hold the result of the condition test;
2141 if NULL, we are just reading through a condition that is
2142 part of an "or" combination to check syntax, or in a state
2143 where the answer isn't required
2145 Returns: a pointer to the first character after the condition, or
2149 static const uschar *
2150 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2152 BOOL testfor = TRUE;
2153 BOOL tempcond, combined_cond;
2155 BOOL sub2_honour_dollar = TRUE;
2156 int i, rc, cond_type, roffset;
2157 int_eximarith_t num[2];
2158 struct stat statbuf;
2160 const uschar *sub[10];
2163 const uschar *rerror;
2167 while (isspace(*s)) s++;
2168 if (*s == '!') { testfor = !testfor; s++; } else break;
2171 /* Numeric comparisons are symbolic */
2173 if (*s == '=' || *s == '>' || *s == '<')
2185 /* All other conditions are named */
2187 else s = read_name(name, 256, s, US"_");
2189 /* If we haven't read a name, it means some non-alpha character is first. */
2193 expand_string_message = string_sprintf("condition name expected, "
2194 "but found \"%.16s\"", s);
2198 /* Find which condition we are dealing with, and switch on it */
2200 cond_type = chop_match(name, cond_table, nelem(cond_table));
2203 /* def: tests for a non-empty variable, or for the existence of a header. If
2204 yield == NULL we are in a skipping state, and don't care about the answer. */
2209 expand_string_message = US"\":\" expected after \"def\"";
2213 s = read_name(name, 256, s+1, US"_");
2215 /* Test for a header's existence. If the name contains a closing brace
2216 character, this may be a user error where the terminating colon has been
2217 omitted. Set a flag to adjust a subsequent error message in this case. */
2219 if (Ustrncmp(name, "h_", 2) == 0 ||
2220 Ustrncmp(name, "rh_", 3) == 0 ||
2221 Ustrncmp(name, "bh_", 3) == 0 ||
2222 Ustrncmp(name, "header_", 7) == 0 ||
2223 Ustrncmp(name, "rheader_", 8) == 0 ||
2224 Ustrncmp(name, "bheader_", 8) == 0)
2226 s = read_header_name(name, 256, s);
2227 /* {-for-text-editors */
2228 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2229 if (yield != NULL) *yield =
2230 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2233 /* Test for a variable's having a non-empty value. A non-existent variable
2234 causes an expansion failure. */
2238 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2241 expand_string_message = (name[0] == 0)?
2242 string_sprintf("variable name omitted after \"def:\"") :
2243 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2244 check_variable_error_message(name);
2247 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2253 /* first_delivery tests for first delivery attempt */
2255 case ECOND_FIRST_DELIVERY:
2256 if (yield != NULL) *yield = deliver_firsttime == testfor;
2260 /* queue_running tests for any process started by a queue runner */
2262 case ECOND_QUEUE_RUNNING:
2263 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2267 /* exists: tests for file existence
2268 isip: tests for any IP address
2269 isip4: tests for an IPv4 address
2270 isip6: tests for an IPv6 address
2271 pam: does PAM authentication
2272 radius: does RADIUS authentication
2273 ldapauth: does LDAP authentication
2274 pwcheck: does Cyrus SASL pwcheck authentication
2283 case ECOND_LDAPAUTH:
2286 while (isspace(*s)) s++;
2287 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2289 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2290 if (sub[0] == NULL) return NULL;
2291 /* {-for-text-editors */
2292 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2294 if (yield == NULL) return s; /* No need to run the test if skipping */
2299 if ((expand_forbid & RDO_EXISTS) != 0)
2301 expand_string_message = US"File existence tests are not permitted";
2304 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2310 rc = string_is_ip_address(sub[0], NULL);
2311 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2312 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2315 /* Various authentication tests - all optionally compiled */
2319 rc = auth_call_pam(sub[0], &expand_string_message);
2322 goto COND_FAILED_NOT_COMPILED;
2323 #endif /* SUPPORT_PAM */
2326 #ifdef RADIUS_CONFIG_FILE
2327 rc = auth_call_radius(sub[0], &expand_string_message);
2330 goto COND_FAILED_NOT_COMPILED;
2331 #endif /* RADIUS_CONFIG_FILE */
2333 case ECOND_LDAPAUTH:
2336 /* Just to keep the interface the same */
2338 int old_pool = store_pool;
2339 store_pool = POOL_SEARCH;
2340 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2341 &expand_string_message, &do_cache);
2342 store_pool = old_pool;
2346 goto COND_FAILED_NOT_COMPILED;
2347 #endif /* LOOKUP_LDAP */
2350 #ifdef CYRUS_PWCHECK_SOCKET
2351 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2354 goto COND_FAILED_NOT_COMPILED;
2355 #endif /* CYRUS_PWCHECK_SOCKET */
2357 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2358 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2360 if (rc == ERROR || rc == DEFER) return NULL;
2361 *yield = (rc == OK) == testfor;
2367 /* call ACL (in a conditional context). Accept true, deny false.
2368 Defer is a forced-fail. Anything set by message= goes to $value.
2369 Up to ten parameters are used; we use the braces round the name+args
2370 like the saslauthd condition does, to permit a variable number of args.
2371 See also the expansion-item version EITEM_ACL and the traditional
2372 acl modifier ACLC_ACL.
2373 Since the ACL may allocate new global variables, tell our caller to not
2378 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2384 while (isspace(*s)) s++;
2385 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2387 switch(read_subs(sub, nelem(sub), 1,
2388 &s, yield == NULL, TRUE, US"acl", resetok))
2390 case 1: expand_string_message = US"too few arguments or bracketing "
2393 case 3: return NULL;
2398 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2399 switch(eval_acl(sub, nelem(sub), &user_msg))
2404 lookup_value = NULL;
2406 lookup_value = string_copy(user_msg);
2407 *yield = cond == testfor;
2411 expand_string_forcedfail = TRUE;
2414 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2422 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2424 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2426 However, the last two are optional. That is why the whole set is enclosed
2427 in their own set of braces. */
2429 case ECOND_SASLAUTHD:
2430 #ifndef CYRUS_SASLAUTHD_SOCKET
2431 goto COND_FAILED_NOT_COMPILED;
2435 while (isspace(*s)) s++;
2436 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2437 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2440 case 1: expand_string_message = US"too few arguments or bracketing "
2441 "error for saslauthd";
2443 case 3: return NULL;
2445 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2448 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2449 &expand_string_message);
2450 if (rc == ERROR || rc == DEFER) return NULL;
2451 *yield = (rc == OK) == testfor;
2455 #endif /* CYRUS_SASLAUTHD_SOCKET */
2458 /* symbolic operators for numeric and string comparison, and a number of
2459 other operators, all requiring two arguments.
2461 crypteq: encrypts plaintext and compares against an encrypted text,
2462 using crypt(), crypt16(), MD5 or SHA-1
2463 inlist/inlisti: checks if first argument is in the list of the second
2464 match: does a regular expression match and sets up the numerical
2465 variables if it succeeds
2466 match_address: matches in an address list
2467 match_domain: matches in a domain list
2468 match_ip: matches a host list that is restricted to IP addresses
2469 match_local_part: matches in a local part list
2472 case ECOND_MATCH_ADDRESS:
2473 case ECOND_MATCH_DOMAIN:
2474 case ECOND_MATCH_IP:
2475 case ECOND_MATCH_LOCAL_PART:
2476 #ifndef EXPAND_LISTMATCH_RHS
2477 sub2_honour_dollar = FALSE;
2486 case ECOND_NUM_L: /* Numerical comparisons */
2493 case ECOND_STR_LT: /* String comparisons */
2504 for (i = 0; i < 2; i++)
2506 /* Sometimes, we don't expand substrings; too many insecure configurations
2507 created using match_address{}{} and friends, where the second param
2508 includes information from untrustworthy sources. */
2509 BOOL honour_dollar = TRUE;
2510 if ((i > 0) && !sub2_honour_dollar)
2511 honour_dollar = FALSE;
2513 while (isspace(*s)) s++;
2516 if (i == 0) goto COND_FAILED_CURLY_START;
2517 expand_string_message = string_sprintf("missing 2nd string in {} "
2518 "after \"%s\"", name);
2521 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2522 honour_dollar, resetok)))
2524 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2525 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2526 " for security reasons\n");
2527 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2529 /* Convert to numerical if required; we know that the names of all the
2530 conditions that compare numbers do not start with a letter. This just saves
2531 checking for them individually. */
2533 if (!isalpha(name[0]) && yield != NULL)
2538 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2542 num[i] = expanded_string_integer(sub[i], FALSE);
2543 if (expand_string_message != NULL) return NULL;
2547 /* Result not required */
2549 if (yield == NULL) return s;
2551 /* Do an appropriate comparison */
2557 tempcond = (num[0] == num[1]);
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 = (Ustrcmp(sub[0], sub[1]) < 0);
2581 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2585 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2589 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2593 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2597 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2601 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2605 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2609 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2613 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2616 case ECOND_MATCH: /* Regular expression match */
2617 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2621 expand_string_message = string_sprintf("regular expression error in "
2622 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2625 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2628 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2629 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2630 goto MATCHED_SOMETHING;
2632 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2633 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2634 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2635 goto MATCHED_SOMETHING;
2637 case ECOND_MATCH_IP: /* Match IP address in a host list */
2638 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2640 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2646 unsigned int *nullcache = NULL;
2647 check_host_block cb;
2649 cb.host_name = US"";
2650 cb.host_address = sub[0];
2652 /* If the host address starts off ::ffff: it is an IPv6 address in
2653 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2656 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2657 cb.host_address + 7 : cb.host_address;
2659 rc = match_check_list(
2660 &sub[1], /* the list */
2661 0, /* separator character */
2662 &hostlist_anchor, /* anchor pointer */
2663 &nullcache, /* cache pointer */
2664 check_host, /* function for testing */
2665 &cb, /* argument for function */
2666 MCL_HOST, /* type of check */
2667 sub[0], /* text for debugging */
2668 NULL); /* where to pass back data */
2670 goto MATCHED_SOMETHING;
2672 case ECOND_MATCH_LOCAL_PART:
2673 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2674 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2689 expand_string_message = string_sprintf("unable to complete match "
2690 "against \"%s\": %s", sub[1], search_error_message);
2696 /* Various "encrypted" comparisons. If the second string starts with
2697 "{" then an encryption type is given. Default to crypt() or crypt16()
2698 (build-time choice). */
2699 /* }-for-text-editors */
2702 #ifndef SUPPORT_CRYPTEQ
2703 goto COND_FAILED_NOT_COMPILED;
2705 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2707 int sublen = Ustrlen(sub[1]+5);
2712 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2714 /* If the length that we are comparing against is 24, the MD5 digest
2715 is expressed as a base64 string. This is the way LDAP does it. However,
2716 some other software uses a straightforward hex representation. We assume
2717 this if the length is 32. Other lengths fail. */
2721 uschar *coded = b64encode(digest, 16);
2722 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2723 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2724 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2726 else if (sublen == 32)
2730 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2732 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2733 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2734 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2738 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2739 "fail\n crypted=%s\n", sub[1]+5);
2744 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2746 int sublen = Ustrlen(sub[1]+6);
2751 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2753 /* If the length that we are comparing against is 28, assume the SHA1
2754 digest is expressed as a base64 string. If the length is 40, assume a
2755 straightforward hex representation. Other lengths fail. */
2759 uschar *coded = b64encode(digest, 20);
2760 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2761 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2762 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2764 else if (sublen == 40)
2768 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2770 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2771 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2772 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2776 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2777 "fail\n crypted=%s\n", sub[1]+6);
2782 else /* {crypt} or {crypt16} and non-{ at start */
2783 /* }-for-text-editors */
2788 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2793 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2798 else if (sub[1][0] == '{') /* }-for-text-editors */
2800 expand_string_message = string_sprintf("unknown encryption mechanism "
2801 "in \"%s\"", sub[1]);
2807 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2808 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2809 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2813 #define XSTR(s) STR(s)
2814 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2815 " subject=%s\n crypted=%s\n",
2816 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2821 /* If the encrypted string contains fewer than two characters (for the
2822 salt), force failure. Otherwise we get false positives: with an empty
2823 string the yield of crypt() is an empty string! */
2826 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2827 else if (errno == EINVAL)
2831 expand_string_message = string_sprintf("crypt error: %s\n",
2832 US strerror(errno));
2837 #endif /* SUPPORT_CRYPTEQ */
2842 const uschar * list = sub[1];
2844 uschar *save_iterate_item = iterate_item;
2845 int (*compare)(const uschar *, const uschar *);
2847 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", name, sub[0]);
2850 compare = cond_type == ECOND_INLISTI
2851 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2853 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2855 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
2856 if (compare(sub[0], iterate_item) == 0)
2862 iterate_item = save_iterate_item;
2865 } /* Switch for comparison conditions */
2867 *yield = tempcond == testfor;
2868 return s; /* End of comparison conditions */
2871 /* and/or: computes logical and/or of several conditions */
2875 subcondptr = (yield == NULL)? NULL : &tempcond;
2876 combined_cond = (cond_type == ECOND_AND);
2878 while (isspace(*s)) s++;
2879 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2883 while (isspace(*s)) s++;
2884 /* {-for-text-editors */
2885 if (*s == '}') break;
2886 if (*s != '{') /* }-for-text-editors */
2888 expand_string_message = string_sprintf("each subcondition "
2889 "inside an \"%s{...}\" condition must be in its own {}", name);
2893 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2895 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2896 expand_string_message, name);
2899 while (isspace(*s)) s++;
2901 /* {-for-text-editors */
2904 /* {-for-text-editors */
2905 expand_string_message = string_sprintf("missing } at end of condition "
2906 "inside \"%s\" group", name);
2912 if (cond_type == ECOND_AND)
2914 combined_cond &= tempcond;
2915 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2916 } /* evaluate any more */
2919 combined_cond |= tempcond;
2920 if (combined_cond) subcondptr = NULL; /* once true, don't */
2921 } /* evaluate any more */
2925 if (yield != NULL) *yield = (combined_cond == testfor);
2929 /* forall/forany: iterates a condition with different values */
2934 const uschar * list;
2936 uschar *save_iterate_item = iterate_item;
2938 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2940 while (isspace(*s)) s++;
2941 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2942 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2943 if (sub[0] == NULL) return NULL;
2944 /* {-for-text-editors */
2945 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2947 while (isspace(*s)) s++;
2948 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2952 /* Call eval_condition once, with result discarded (as if scanning a
2953 "false" part). This allows us to find the end of the condition, because if
2954 the list it empty, we won't actually evaluate the condition for real. */
2956 if (!(s = eval_condition(sub[1], resetok, NULL)))
2958 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2959 expand_string_message, name);
2962 while (isspace(*s)) s++;
2964 /* {-for-text-editors */
2967 /* {-for-text-editors */
2968 expand_string_message = string_sprintf("missing } at end of condition "
2969 "inside \"%s\"", name);
2973 if (yield != NULL) *yield = !testfor;
2975 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2977 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, iterate_item);
2978 if (!eval_condition(sub[1], resetok, &tempcond))
2980 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2981 expand_string_message, name);
2982 iterate_item = save_iterate_item;
2985 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", name,
2986 tempcond? "true":"false");
2988 if (yield != NULL) *yield = (tempcond == testfor);
2989 if (tempcond == (cond_type == ECOND_FORANY)) break;
2992 iterate_item = save_iterate_item;
2997 /* The bool{} expansion condition maps a string to boolean.
2998 The values supported should match those supported by the ACL condition
2999 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3000 of true/false. Note that Router "condition" rules have a different
3001 interpretation, where general data can be used and only a few values
3003 Note that readconf.c boolean matching, for boolean configuration options,
3004 only matches true/yes/false/no.
3005 The bool_lax{} condition matches the Router logic, which is much more
3008 case ECOND_BOOL_LAX:
3014 BOOL boolvalue = FALSE;
3015 while (isspace(*s)) s++;
3016 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3017 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3018 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3020 case 1: expand_string_message = string_sprintf(
3021 "too few arguments or bracketing error for %s",
3025 case 3: return NULL;
3028 while (isspace(*t)) t++;
3032 /* trailing whitespace: seems like a good idea to ignore it too */
3034 while (isspace(*t2)) t2--;
3035 if (t2 != (t + len))
3042 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3043 /* logic for the lax case from expand_check_condition(), which also does
3044 expands, and the logic is both short and stable enough that there should
3045 be no maintenance burden from replicating it. */
3049 ? Ustrspn(t+1, "0123456789") == len-1
3050 : Ustrspn(t, "0123456789") == len)
3052 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3053 /* expand_check_condition only does a literal string "0" check */
3054 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3057 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3059 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3061 else if (cond_type == ECOND_BOOL_LAX)
3065 expand_string_message = string_sprintf("unrecognised boolean "
3069 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3070 boolvalue? "true":"false");
3071 if (yield != NULL) *yield = (boolvalue == testfor);
3075 /* Unknown condition */
3078 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3080 } /* End switch on condition type */
3082 /* Missing braces at start and end of data */
3084 COND_FAILED_CURLY_START:
3085 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3088 COND_FAILED_CURLY_END:
3089 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3093 /* A condition requires code that is not compiled */
3095 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3096 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3097 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3098 COND_FAILED_NOT_COMPILED:
3099 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3108 /*************************************************
3109 * Save numerical variables *
3110 *************************************************/
3112 /* This function is called from items such as "if" that want to preserve and
3113 restore the numbered variables.
3116 save_expand_string points to an array of pointers to set
3117 save_expand_nlength points to an array of ints for the lengths
3119 Returns: the value of expand max to save
3123 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3126 for (i = 0; i <= expand_nmax; i++)
3128 save_expand_nstring[i] = expand_nstring[i];
3129 save_expand_nlength[i] = expand_nlength[i];
3136 /*************************************************
3137 * Restore numerical variables *
3138 *************************************************/
3140 /* This function restored saved values of numerical strings.
3143 save_expand_nmax the number of strings to restore
3144 save_expand_string points to an array of pointers
3145 save_expand_nlength points to an array of ints
3151 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3152 int *save_expand_nlength)
3155 expand_nmax = save_expand_nmax;
3156 for (i = 0; i <= expand_nmax; i++)
3158 expand_nstring[i] = save_expand_nstring[i];
3159 expand_nlength[i] = save_expand_nlength[i];
3167 /*************************************************
3168 * Handle yes/no substrings *
3169 *************************************************/
3171 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3172 alternative substrings that depend on whether or not the condition was true,
3173 or the lookup or extraction succeeded. The substrings always have to be
3174 expanded, to check their syntax, but "skipping" is set when the result is not
3175 needed - this avoids unnecessary nested lookups.
3178 skipping TRUE if we were skipping when this item was reached
3179 yes TRUE if the first string is to be used, else use the second
3180 save_lookup a value to put back into lookup_value before the 2nd expansion
3181 sptr points to the input string pointer
3182 yieldptr points to the output growable-string pointer
3183 type "lookup", "if", "extract", "run", "env", "listextract" or
3184 "certextract" for error message
3185 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3188 Returns: 0 OK; lookup_value has been reset to save_lookup
3190 2 expansion failed because of bracketing error
3194 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3195 gstring ** yieldptr, uschar *type, BOOL *resetok)
3198 const uschar *s = *sptr; /* Local value */
3199 uschar *sub1, *sub2;
3200 const uschar * errwhere;
3202 /* If there are no following strings, we substitute the contents of $value for
3203 lookups and for extractions in the success case. For the ${if item, the string
3204 "true" is substituted. In the fail case, nothing is substituted for all three
3207 while (isspace(*s)) s++;
3212 if (yes && !skipping)
3213 *yieldptr = string_catn(*yieldptr, US"true", 4);
3217 if (yes && lookup_value && !skipping)
3218 *yieldptr = string_cat(*yieldptr, lookup_value);
3219 lookup_value = save_lookup;
3225 /* The first following string must be braced. */
3229 errwhere = US"'yes' part did not start with '{'";
3233 /* Expand the first substring. Forced failures are noticed only if we actually
3234 want this string. Set skipping in the call in the fail case (this will always
3235 be the case if we were already skipping). */
3237 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3238 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3239 expand_string_forcedfail = FALSE;
3242 errwhere = US"'yes' part did not end with '}'";
3246 /* If we want the first string, add it to the output */
3249 *yieldptr = string_cat(*yieldptr, sub1);
3251 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3252 $value to what it was at the start of the item, so that it has this value
3253 during the second string expansion. For the call from "if" or "run" to this
3254 function, save_lookup is set to lookup_value, so that this statement does
3257 lookup_value = save_lookup;
3259 /* There now follows either another substring, or "fail", or nothing. This
3260 time, forced failures are noticed only if we want the second string. We must
3261 set skipping in the nested call if we don't want this string, or if we were
3262 already skipping. */
3264 while (isspace(*s)) s++;
3267 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3268 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3269 expand_string_forcedfail = FALSE;
3272 errwhere = US"'no' part did not start with '{'";
3276 /* If we want the second string, add it to the output */
3279 *yieldptr = string_cat(*yieldptr, sub2);
3282 /* If there is no second string, but the word "fail" is present when the use of
3283 the second string is wanted, set a flag indicating it was a forced failure
3284 rather than a syntactic error. Swallow the terminating } in case this is nested
3285 inside another lookup or if or extract. */
3290 /* deconst cast ok here as source is s anyway */
3291 s = US read_name(name, sizeof(name), s, US"_");
3292 if (Ustrcmp(name, "fail") == 0)
3294 if (!yes && !skipping)
3296 while (isspace(*s)) s++;
3299 errwhere = US"did not close with '}' after forcedfail";
3302 expand_string_message =
3303 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3304 expand_string_forcedfail = TRUE;
3310 expand_string_message =
3311 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3316 /* All we have to do now is to check on the final closing brace. */
3318 while (isspace(*s)) s++;
3321 errwhere = US"did not close with '}'";
3327 /* Update the input pointer value before returning */
3332 /* Get here if there is a bracketing failure */
3333 expand_string_message = string_sprintf(
3334 "curly-bracket problem in conditional yes/no parsing: %s\n"
3335 " remaining string is '%s'", errwhere, --s);
3340 /* Get here for other failures */
3348 /*************************************************
3349 * Handle MD5 or SHA-1 computation for HMAC *
3350 *************************************************/
3352 /* These are some wrapping functions that enable the HMAC code to be a bit
3353 cleaner. A good compiler will spot the tail recursion.
3356 type HMAC_MD5 or HMAC_SHA1
3357 remaining are as for the cryptographic hash functions
3363 chash_start(int type, void *base)
3365 if (type == HMAC_MD5)
3366 md5_start((md5 *)base);
3368 sha1_start((hctx *)base);
3372 chash_mid(int type, void *base, uschar *string)
3374 if (type == HMAC_MD5)
3375 md5_mid((md5 *)base, string);
3377 sha1_mid((hctx *)base, string);
3381 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3383 if (type == HMAC_MD5)
3384 md5_end((md5 *)base, string, length, digest);
3386 sha1_end((hctx *)base, string, length, digest);
3393 /********************************************************
3394 * prvs: Get last three digits of days since Jan 1, 1970 *
3395 ********************************************************/
3397 /* This is needed to implement the "prvs" BATV reverse
3400 Argument: integer "days" offset to add or substract to
3401 or from the current number of days.
3403 Returns: pointer to string containing the last three
3404 digits of the number of days since Jan 1, 1970,
3405 modified by the offset argument, NULL if there
3406 was an error in the conversion.
3411 prvs_daystamp(int day_offset)
3413 uschar *days = store_get(32); /* Need at least 24 for cases */
3414 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3415 (time(NULL) + day_offset*86400)/86400);
3416 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3421 /********************************************************
3422 * prvs: perform HMAC-SHA1 computation of prvs bits *
3423 ********************************************************/
3425 /* This is needed to implement the "prvs" BATV reverse
3429 address RFC2821 Address to use
3430 key The key to use (must be less than 64 characters
3432 key_num Single-digit key number to use. Defaults to
3435 Returns: pointer to string containing the first three
3436 bytes of the final hash in hex format, NULL if
3437 there was an error in the process.
3441 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3443 gstring * hash_source;
3447 uschar innerhash[20];
3448 uschar finalhash[20];
3449 uschar innerkey[64];
3450 uschar outerkey[64];
3451 uschar *finalhash_hex = store_get(40);
3453 if (key_num == NULL)
3456 if (Ustrlen(key) > 64)
3459 hash_source = string_catn(NULL, key_num, 1);
3460 hash_source = string_catn(hash_source, daystamp, 3);
3461 hash_source = string_cat(hash_source, address);
3462 (void) string_from_gstring(hash_source);
3465 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3467 memset(innerkey, 0x36, 64);
3468 memset(outerkey, 0x5c, 64);
3470 for (i = 0; i < Ustrlen(key); i++)
3472 innerkey[i] ^= key[i];
3473 outerkey[i] ^= key[i];
3476 chash_start(HMAC_SHA1, &h);
3477 chash_mid(HMAC_SHA1, &h, innerkey);
3478 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3480 chash_start(HMAC_SHA1, &h);
3481 chash_mid(HMAC_SHA1, &h, outerkey);
3482 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3485 for (i = 0; i < 3; i++)
3487 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3488 *p++ = hex_digits[finalhash[i] & 0x0f];
3492 return finalhash_hex;
3498 /*************************************************
3499 * Join a file onto the output string *
3500 *************************************************/
3502 /* This is used for readfile/readsock and after a run expansion.
3503 It joins the contents of a file onto the output string, globally replacing
3504 newlines with a given string (optionally).
3508 yield pointer to the expandable string struct
3509 eol newline replacement string, or NULL
3511 Returns: new pointer for expandable string, terminated if non-null
3515 cat_file(FILE *f, gstring *yield, uschar *eol)
3517 uschar buffer[1024];
3519 while (Ufgets(buffer, sizeof(buffer), f))
3521 int len = Ustrlen(buffer);
3522 if (eol && buffer[len-1] == '\n') len--;
3523 yield = string_catn(yield, buffer, len);
3524 if (eol && buffer[len])
3525 yield = string_cat(yield, eol);
3528 (void) string_from_gstring(yield);
3535 /*************************************************
3536 * Evaluate numeric expression *
3537 *************************************************/
3539 /* This is a set of mutually recursive functions that evaluate an arithmetic
3540 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3541 these functions that is called from elsewhere is eval_expr, whose interface is:
3544 sptr pointer to the pointer to the string - gets updated
3545 decimal TRUE if numbers are to be assumed decimal
3546 error pointer to where to put an error message - must be NULL on input
3547 endket TRUE if ')' must terminate - FALSE for external call
3549 Returns: on success: the value of the expression, with *error still NULL
3550 on failure: an undefined value, with *error = a message
3553 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3556 static int_eximarith_t
3557 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3560 int_eximarith_t x = eval_op_or(&s, decimal, error);
3566 *error = US"expecting closing parenthesis";
3568 while (isspace(*(++s)));
3570 else if (*s != 0) *error = US"expecting operator";
3577 static int_eximarith_t
3578 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3583 while (isspace(*s)) s++;
3588 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3590 switch (tolower(*s))
3593 case 'k': n *= 1024; s++; break;
3594 case 'm': n *= 1024*1024; s++; break;
3595 case 'g': n *= 1024*1024*1024; s++; break;
3597 while (isspace (*s)) s++;
3602 n = eval_expr(&s, decimal, error, 1);
3606 *error = US"expecting number or opening parenthesis";
3614 static int_eximarith_t
3615 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3619 while (isspace(*s)) s++;
3620 if (*s == '+' || *s == '-' || *s == '~')
3623 x = eval_op_unary(&s, decimal, error);
3624 if (op == '-') x = -x;
3625 else if (op == '~') x = ~x;
3629 x = eval_number(&s, decimal, error);
3636 static int_eximarith_t
3637 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3640 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3643 while (*s == '*' || *s == '/' || *s == '%')
3646 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3647 if (*error != NULL) break;
3648 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3649 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3650 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3651 * -N*M is INT_MIN will yield INT_MIN.
3652 * Since we don't support floating point, this is somewhat simpler.
3653 * Ideally, we'd return an error, but since we overflow for all other
3654 * arithmetic, consistency suggests otherwise, but what's the correct value
3655 * to use? There is none.
3656 * The C standard guarantees overflow for unsigned arithmetic but signed
3657 * overflow invokes undefined behaviour; in practice, this is overflow
3658 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3659 * that long/longlong larger than int are available, or we could just work
3660 * with larger types. We should consider whether to guarantee 32bit eval
3661 * and 64-bit working variables, with errors returned. For now ...
3662 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3663 * can just let the other invalid results occur otherwise, as they have
3664 * until now. For this one case, we can coerce.
3666 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3669 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3670 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3680 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3696 static int_eximarith_t
3697 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3700 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3703 while (*s == '+' || *s == '-')
3706 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3708 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3709 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3710 { /* over-conservative check */
3712 ? US"overflow in sum" : US"overflow in difference";
3715 if (op == '+') x += y; else x -= y;
3723 static int_eximarith_t
3724 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3727 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3730 while ((*s == '<' || *s == '>') && s[1] == s[0])
3735 y = eval_op_sum(&s, decimal, error);
3736 if (*error != NULL) break;
3737 if (op == '<') x <<= y; else x >>= y;
3745 static int_eximarith_t
3746 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3749 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3756 y = eval_op_shift(&s, decimal, error);
3757 if (*error != NULL) break;
3766 static int_eximarith_t
3767 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3770 int_eximarith_t x = eval_op_and(&s, decimal, error);
3777 y = eval_op_and(&s, decimal, error);
3778 if (*error != NULL) break;
3787 static int_eximarith_t
3788 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3791 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3798 y = eval_op_xor(&s, decimal, error);
3799 if (*error != NULL) break;
3809 /*************************************************
3811 *************************************************/
3813 /* Returns either an unchanged string, or the expanded string in stacking pool
3814 store. Interpreted sequences are:
3816 \... normal escaping rules
3817 $name substitutes the variable
3819 ${op:string} operates on the expanded string value
3820 ${item{arg1}{arg2}...} expands the args and then does the business
3821 some literal args are not enclosed in {}
3823 There are now far too many operators and item types to make it worth listing
3824 them here in detail any more.
3826 We use an internal routine recursively to handle embedded substrings. The
3827 external function follows. The yield is NULL if the expansion failed, and there
3828 are two cases: if something collapsed syntactically, or if "fail" was given
3829 as the action on a lookup failure. These can be distinguished by looking at the
3830 variable expand_string_forcedfail, which is TRUE in the latter case.
3832 The skipping flag is set true when expanding a substring that isn't actually
3833 going to be used (after "if" or "lookup") and it prevents lookups from
3834 happening lower down.
3836 Store usage: At start, a store block of the length of the input plus 64
3837 is obtained. This is expanded as necessary by string_cat(), which might have to
3838 get a new block, or might be able to expand the original. At the end of the
3839 function we can release any store above that portion of the yield block that
3840 was actually used. In many cases this will be optimal.
3842 However: if the first item in the expansion is a variable name or header name,
3843 we reset the store before processing it; if the result is in fresh store, we
3844 use that without copying. This is helpful for expanding strings like
3845 $message_headers which can get very long.
3847 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3848 since resetting the store at the end of the expansion will free store that was
3849 allocated by the plugin code as well as the slop after the expanded string. So
3850 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3851 and, given the acl condition, ${if }. This is an unfortunate consequence of
3852 string expansion becoming too powerful.
3855 string the string to be expanded
3856 ket_ends true if expansion is to stop at }
3857 left if not NULL, a pointer to the first character after the
3858 expansion is placed here (typically used with ket_ends)
3859 skipping TRUE for recursive calls when the value isn't actually going
3860 to be used (to allow for optimisation)
3861 honour_dollar TRUE if $ is to be expanded,
3862 FALSE if it's just another character
3863 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3866 Returns: NULL if expansion fails:
3867 expand_string_forcedfail is set TRUE if failure was forced
3868 expand_string_message contains a textual error message
3869 a pointer to the expanded string on success
3873 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3874 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3876 gstring * yield = string_get(Ustrlen(string) + 64);
3878 const uschar *s = string;
3879 uschar *save_expand_nstring[EXPAND_MAXN+1];
3880 int save_expand_nlength[EXPAND_MAXN+1];
3881 BOOL resetok = TRUE;
3885 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
3887 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
3891 expand_string_forcedfail = FALSE;
3892 expand_string_message = US"";
3899 /* \ escapes the next character, which must exist, or else
3900 the expansion fails. There's a special escape, \N, which causes
3901 copying of the subject verbatim up to the next \N. Otherwise,
3902 the escapes are the standard set. */
3908 expand_string_message = US"\\ at end of string";
3914 const uschar * t = s + 2;
3915 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3916 yield = string_catn(yield, t, s - t);
3917 if (*s != 0) s += 2;
3923 ch[0] = string_interpret_escape(&s);
3925 yield = string_catn(yield, ch, 1);
3932 /* Anything other than $ is just copied verbatim, unless we are
3933 looking for a terminating } character. */
3936 if (ket_ends && *s == '}') break;
3938 if (*s != '$' || !honour_dollar)
3940 yield = string_catn(yield, s++, 1);
3944 /* No { after the $ - must be a plain name or a number for string
3945 match variable. There has to be a fudge for variables that are the
3946 names of header fields preceded by "$header_" because header field
3947 names can contain any printing characters except space and colon.
3948 For those that don't like typing this much, "$h_" is a synonym for
3949 "$header_". A non-existent header yields a NULL value; nothing is
3952 if (isalpha((*(++s))))
3958 s = read_name(name, sizeof(name), s, US"_");
3960 /* If this is the first thing to be expanded, release the pre-allocated
3964 g = store_get(sizeof(gstring));
3965 else if (yield->ptr == 0)
3967 if (resetok) store_reset(yield);
3969 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
3974 if (Ustrncmp(name, "h_", 2) == 0 ||
3975 Ustrncmp(name, "rh_", 3) == 0 ||
3976 Ustrncmp(name, "bh_", 3) == 0 ||
3977 Ustrncmp(name, "header_", 7) == 0 ||
3978 Ustrncmp(name, "rheader_", 8) == 0 ||
3979 Ustrncmp(name, "bheader_", 8) == 0)
3981 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3982 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3983 s = read_header_name(name, sizeof(name), s);
3984 value = find_header(name, FALSE, &newsize, want_raw, charset);
3986 /* If we didn't find the header, and the header contains a closing brace
3987 character, this may be a user error where the terminating colon
3988 has been omitted. Set a flag to adjust the error message in this case.
3989 But there is no error here - nothing gets inserted. */
3993 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
4000 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
4002 expand_string_message =
4003 string_sprintf("unknown variable name \"%s\"", name);
4004 check_variable_error_message(name);
4008 /* If the data is known to be in a new buffer, newsize will be set to the
4009 size of that buffer. If this is the first thing in an expansion string,
4010 yield will be NULL; just point it at the new store instead of copying. Many
4011 expansion strings contain just one reference, so this is a useful
4012 optimization, especially for humungous headers. We need to use a gstring
4013 structure that is not allocated after that new-buffer, else a later store
4014 reset in the middle of the buffer will make it inaccessible. */
4016 len = Ustrlen(value);
4017 if (!yield && newsize != 0)
4020 yield->size = newsize;
4025 yield = string_catn(yield, value, len);
4033 s = read_cnumber(&n, s);
4034 if (n >= 0 && n <= expand_nmax)
4035 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4039 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4041 if (*s != '{') /*}*/
4043 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4047 /* After { there can be various things, but they all start with
4048 an initial word, except for a number for a string match variable. */
4050 if (isdigit((*(++s))))
4053 s = read_cnumber(&n, s); /*{*/
4056 expand_string_message = US"} expected after number";
4059 if (n >= 0 && n <= expand_nmax)
4060 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4066 expand_string_message = US"letter or digit expected after ${"; /*}*/
4070 /* Allow "-" in names to cater for substrings with negative
4071 arguments. Since we are checking for known names after { this is
4074 s = read_name(name, sizeof(name), s, US"_-");
4075 item_type = chop_match(name, item_table, nelem(item_table));
4079 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4080 If the ACL returns accept or reject we return content set by "message ="
4081 There is currently no limit on recursion; this would have us call
4082 acl_check_internal() directly and get a current level from somewhere.
4083 See also the acl expansion condition ECOND_ACL and the traditional
4084 acl modifier ACLC_ACL.
4085 Assume that the function has side-effects on the store that must be preserved.
4089 /* ${acl {name} {arg1}{arg2}...} */
4091 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4094 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4097 case 1: goto EXPAND_FAILED_CURLY;
4099 case 3: goto EXPAND_FAILED;
4101 if (skipping) continue;
4104 switch(eval_acl(sub, nelem(sub), &user_msg))
4109 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4111 yield = string_cat(yield, user_msg);
4115 expand_string_forcedfail = TRUE;
4118 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4123 case EITEM_AUTHRESULTS:
4124 /* ${authresults {mysystemname}} */
4128 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4131 case 1: goto EXPAND_FAILED_CURLY;
4133 case 3: goto EXPAND_FAILED;
4136 yield = string_append(yield, 3,
4137 US"Authentication-Results: ", sub_arg[0], US"; none");
4140 yield = authres_iprev(yield);
4141 yield = authres_smtpauth(yield);
4143 yield = authres_spf(yield);
4145 #ifndef DISABLE_DKIM
4146 yield = authres_dkim(yield);
4148 #ifdef EXPERIMENTAL_ARC
4149 yield = authres_arc(yield);
4154 /* Handle conditionals - preserve the values of the numerical expansion
4155 variables in case they get changed by a regular expression match in the
4156 condition. If not, they retain their external settings. At the end
4157 of this "if" section, they get restored to their previous values. */
4162 const uschar *next_s;
4163 int save_expand_nmax =
4164 save_expand_strings(save_expand_nstring, save_expand_nlength);
4166 while (isspace(*s)) s++;
4167 next_s = eval_condition(s, &resetok, skipping ? NULL : &cond);
4168 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4172 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4173 "condition: %.*s\n",
4174 (int)(next_s - s), s);
4175 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4176 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4178 cond ? "true" : "false");
4183 /* The handling of "yes" and "no" result strings is now in a separate
4184 function that is also used by ${lookup} and ${extract} and ${run}. */
4186 switch(process_yesno(
4187 skipping, /* were previously skipping */
4188 cond, /* success/failure indicator */
4189 lookup_value, /* value to reset for string2 */
4190 &s, /* input pointer */
4191 &yield, /* output pointer */
4192 US"if", /* condition type */
4195 case 1: goto EXPAND_FAILED; /* when all is well, the */
4196 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4199 /* Restore external setting of expansion variables for continuation
4202 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4203 save_expand_nlength);
4208 case EITEM_IMAPFOLDER:
4209 { /* ${imapfolder {name}{sep]{specials}} */
4213 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4216 case 1: goto EXPAND_FAILED_CURLY;
4218 case 3: goto EXPAND_FAILED;
4221 if (sub_arg[1] == NULL) /* One argument */
4223 sub_arg[1] = US"/"; /* default separator */
4226 else if (Ustrlen(sub_arg[1]) != 1)
4228 expand_string_message =
4230 "IMAP folder separator must be one character, found \"%s\"",
4237 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4238 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4240 yield = string_cat(yield, encoded);
4246 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4247 expanding an internal string that isn't actually going to be used. All we
4248 need to do is check the syntax, so don't do a lookup at all. Preserve the
4249 values of the numerical expansion variables in case they get changed by a
4250 partial lookup. If not, they retain their external settings. At the end
4251 of this "lookup" section, they get restored to their previous values. */
4255 int stype, partial, affixlen, starflags;
4256 int expand_setup = 0;
4258 uschar *key, *filename;
4259 const uschar *affix;
4260 uschar *save_lookup_value = lookup_value;
4261 int save_expand_nmax =
4262 save_expand_strings(save_expand_nstring, save_expand_nlength);
4264 if ((expand_forbid & RDO_LOOKUP) != 0)
4266 expand_string_message = US"lookup expansions are not permitted";
4270 /* Get the key we are to look up for single-key+file style lookups.
4271 Otherwise set the key NULL pro-tem. */
4273 while (isspace(*s)) s++;
4274 if (*s == '{') /*}*/
4276 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4277 if (!key) goto EXPAND_FAILED; /*{{*/
4280 expand_string_message = US"missing '}' after lookup key";
4281 goto EXPAND_FAILED_CURLY;
4283 while (isspace(*s)) s++;
4287 /* Find out the type of database */
4291 expand_string_message = US"missing lookup type";
4295 /* The type is a string that may contain special characters of various
4296 kinds. Allow everything except space or { to appear; the actual content
4297 is checked by search_findtype_partial. */ /*}*/
4299 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4301 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4305 while (isspace(*s)) s++;
4307 /* Now check for the individual search type and any partial or default
4308 options. Only those types that are actually in the binary are valid. */
4310 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4314 expand_string_message = search_error_message;
4318 /* Check that a key was provided for those lookup types that need it,
4319 and was not supplied for those that use the query style. */
4321 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4325 expand_string_message = string_sprintf("missing {key} for single-"
4326 "key \"%s\" lookup", name);
4334 expand_string_message = string_sprintf("a single key was given for "
4335 "lookup type \"%s\", which is not a single-key lookup type", name);
4340 /* Get the next string in brackets and expand it. It is the file name for
4341 single-key+file lookups, and the whole query otherwise. In the case of
4342 queries that also require a file name (e.g. sqlite), the file name comes
4347 expand_string_message = US"missing '{' for lookup file-or-query arg";
4348 goto EXPAND_FAILED_CURLY;
4350 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4351 if (filename == NULL) goto EXPAND_FAILED;
4354 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4355 goto EXPAND_FAILED_CURLY;
4357 while (isspace(*s)) s++;
4359 /* If this isn't a single-key+file lookup, re-arrange the variables
4360 to be appropriate for the search_ functions. For query-style lookups,
4361 there is just a "key", and no file name. For the special query-style +
4362 file types, the query (i.e. "key") starts with a file name. */
4366 while (isspace(*filename)) filename++;
4369 if (mac_islookup(stype, lookup_querystyle))
4373 if (*filename != '/')
4375 expand_string_message = string_sprintf(
4376 "absolute file name expected for \"%s\" lookup", name);
4379 while (*key != 0 && !isspace(*key)) key++;
4380 if (*key != 0) *key++ = 0;
4384 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4385 the entry was not found. Note that there is no search_close() function.
4386 Files are left open in case of re-use. At suitable places in higher logic,
4387 search_tidyup() is called to tidy all open files. This can save opening
4388 the same file several times. However, files may also get closed when
4389 others are opened, if too many are open at once. The rule is that a
4390 handle should not be used after a second search_open().
4392 Request that a partial search sets up $1 and maybe $2 by passing
4393 expand_setup containing zero. If its value changes, reset expand_nmax,
4394 since new variables will have been set. Note that at the end of this
4395 "lookup" section, the old numeric variables are restored. */
4398 lookup_value = NULL;
4401 void *handle = search_open(filename, stype, 0, NULL, NULL);
4404 expand_string_message = search_error_message;
4407 lookup_value = search_find(handle, filename, key, partial, affix,
4408 affixlen, starflags, &expand_setup);
4409 if (search_find_defer)
4411 expand_string_message =
4412 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4413 string_printing2(key, FALSE), search_error_message);
4416 if (expand_setup > 0) expand_nmax = expand_setup;
4419 /* The handling of "yes" and "no" result strings is now in a separate
4420 function that is also used by ${if} and ${extract}. */
4422 switch(process_yesno(
4423 skipping, /* were previously skipping */
4424 lookup_value != NULL, /* success/failure indicator */
4425 save_lookup_value, /* value to reset for string2 */
4426 &s, /* input pointer */
4427 &yield, /* output pointer */
4428 US"lookup", /* condition type */
4431 case 1: goto EXPAND_FAILED; /* when all is well, the */
4432 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4435 /* Restore external setting of expansion variables for carrying on
4436 at this level, and continue. */
4438 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4439 save_expand_nlength);
4443 /* If Perl support is configured, handle calling embedded perl subroutines,
4444 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4445 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4446 arguments (defined below). */
4448 #define EXIM_PERL_MAX_ARGS 8
4452 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4453 "is not included in this binary";
4456 #else /* EXIM_PERL */
4458 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4461 if ((expand_forbid & RDO_PERL) != 0)
4463 expand_string_message = US"Perl calls are not permitted";
4467 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4468 US"perl", &resetok))
4470 case 1: goto EXPAND_FAILED_CURLY;
4472 case 3: goto EXPAND_FAILED;
4475 /* If skipping, we don't actually do anything */
4477 if (skipping) continue;
4479 /* Start the interpreter if necessary */
4481 if (!opt_perl_started)
4484 if (opt_perl_startup == NULL)
4486 expand_string_message = US"A setting of perl_startup is needed when "
4487 "using the Perl interpreter";
4490 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4491 initerror = init_perl(opt_perl_startup);
4492 if (initerror != NULL)
4494 expand_string_message =
4495 string_sprintf("error in perl_startup code: %s\n", initerror);
4498 opt_perl_started = TRUE;
4501 /* Call the function */
4503 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4504 new_yield = call_perl_cat(yield, &expand_string_message,
4505 sub_arg[0], sub_arg + 1);
4507 /* NULL yield indicates failure; if the message pointer has been set to
4508 NULL, the yield was undef, indicating a forced failure. Otherwise the
4509 message will indicate some kind of Perl error. */
4511 if (new_yield == NULL)
4513 if (expand_string_message == NULL)
4515 expand_string_message =
4516 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4517 "failure", sub_arg[0]);
4518 expand_string_forcedfail = TRUE;
4523 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4524 set during a callback from Perl. */
4526 expand_string_forcedfail = FALSE;
4530 #endif /* EXIM_PERL */
4532 /* Transform email address to "prvs" scheme to use
4533 as BATV-signed return path */
4540 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4542 case 1: goto EXPAND_FAILED_CURLY;
4544 case 3: goto EXPAND_FAILED;
4547 /* If skipping, we don't actually do anything */
4548 if (skipping) continue;
4550 /* sub_arg[0] is the address */
4551 if ( !(domain = Ustrrchr(sub_arg[0],'@'))
4552 || domain == sub_arg[0] || Ustrlen(domain) == 1)
4554 expand_string_message = US"prvs first argument must be a qualified email address";
4558 /* Calculate the hash. The third argument must be a single-digit
4559 key number, or unset. */
4562 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4564 expand_string_message = US"prvs third argument must be a single digit";
4568 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
4571 expand_string_message = US"prvs hmac-sha1 conversion failed";
4575 /* Now separate the domain from the local part */
4578 yield = string_catn(yield, US"prvs=", 5);
4579 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
4580 yield = string_catn(yield, prvs_daystamp(7), 3);
4581 yield = string_catn(yield, p, 6);
4582 yield = string_catn(yield, US"=", 1);
4583 yield = string_cat (yield, sub_arg[0]);
4584 yield = string_catn(yield, US"@", 1);
4585 yield = string_cat (yield, domain);
4590 /* Check a prvs-encoded address for validity */
4592 case EITEM_PRVSCHECK:
4599 /* TF: Ugliness: We want to expand parameter 1 first, then set
4600 up expansion variables that are used in the expansion of
4601 parameter 2. So we clone the string for the first
4602 expansion, where we only expand parameter 1.
4604 PH: Actually, that isn't necessary. The read_subs() function is
4605 designed to work this way for the ${if and ${lookup expansions. I've
4609 /* Reset expansion variables */
4610 prvscheck_result = NULL;
4611 prvscheck_address = NULL;
4612 prvscheck_keynum = NULL;
4614 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4616 case 1: goto EXPAND_FAILED_CURLY;
4618 case 3: goto EXPAND_FAILED;
4621 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4624 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4626 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4627 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4628 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4629 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4630 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4632 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
4633 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
4634 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
4635 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
4636 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
4638 /* Set up expansion variables */
4639 g = string_cat (NULL, local_part);
4640 g = string_catn(g, US"@", 1);
4641 g = string_cat (g, domain);
4642 prvscheck_address = string_from_gstring(g);
4643 prvscheck_keynum = string_copy(key_num);
4645 /* Now expand the second argument */
4646 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4648 case 1: goto EXPAND_FAILED_CURLY;
4650 case 3: goto EXPAND_FAILED;
4653 /* Now we have the key and can check the address. */
4655 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4660 expand_string_message = US"hmac-sha1 conversion failed";
4664 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
4665 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
4667 if (Ustrcmp(p,hash) == 0)
4669 /* Success, valid BATV address. Now check the expiry date. */
4670 uschar *now = prvs_daystamp(0);
4671 unsigned int inow = 0,iexpire = 1;
4673 (void)sscanf(CS now,"%u",&inow);
4674 (void)sscanf(CS daystamp,"%u",&iexpire);
4676 /* When "iexpire" is < 7, a "flip" has occured.
4677 Adjust "inow" accordingly. */
4678 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4680 if (iexpire >= inow)
4682 prvscheck_result = US"1";
4683 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
4687 prvscheck_result = NULL;
4688 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
4693 prvscheck_result = NULL;
4694 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
4697 /* Now expand the final argument. We leave this till now so that
4698 it can include $prvscheck_result. */
4700 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4702 case 1: goto EXPAND_FAILED_CURLY;
4704 case 3: goto EXPAND_FAILED;
4707 yield = string_cat(yield,
4708 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4710 /* Reset the "internal" variables afterwards, because they are in
4711 dynamic store that will be reclaimed if the expansion succeeded. */
4713 prvscheck_address = NULL;
4714 prvscheck_keynum = NULL;
4717 /* Does not look like a prvs encoded address, return the empty string.
4718 We need to make sure all subs are expanded first, so as to skip over
4721 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4723 case 1: goto EXPAND_FAILED_CURLY;
4725 case 3: goto EXPAND_FAILED;
4731 /* Handle "readfile" to insert an entire file */
4733 case EITEM_READFILE:
4738 if ((expand_forbid & RDO_READFILE) != 0)
4740 expand_string_message = US"file insertions are not permitted";
4744 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4746 case 1: goto EXPAND_FAILED_CURLY;
4748 case 3: goto EXPAND_FAILED;
4751 /* If skipping, we don't actually do anything */
4753 if (skipping) continue;
4755 /* Open the file and read it */
4757 if (!(f = Ufopen(sub_arg[0], "rb")))
4759 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4763 yield = cat_file(f, yield, sub_arg[1]);
4768 /* Handle "readsocket" to insert data from a socket, either
4769 Inet or Unix domain */
4771 case EITEM_READSOCK:
4775 int save_ptr = yield->ptr;
4779 BOOL do_shutdown = TRUE;
4782 if (expand_forbid & RDO_READSOCK)
4784 expand_string_message = US"socket insertions are not permitted";
4788 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4789 because there may be a string for expansion on failure. */
4791 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4793 case 1: goto EXPAND_FAILED_CURLY;
4794 case 2: /* Won't occur: no end check */
4795 case 3: goto EXPAND_FAILED;
4798 /* Grab the request string, if any */
4800 reqstr.data = sub_arg[1];
4801 reqstr.len = Ustrlen(sub_arg[1]);
4803 /* Sort out timeout, if given. The second arg is a list with the first element
4804 being a time value. Any more are options of form "name=value". Currently the
4805 only option recognised is "shutdown". */
4809 const uschar * list = sub_arg[2];
4813 item = string_nextinlist(&list, &sep, NULL, 0);
4814 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
4816 expand_string_message = string_sprintf("bad time value %s", item);
4820 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
4821 if (Ustrncmp(item, US"shutdown=", 9) == 0)
4822 if (Ustrcmp(item + 9, US"no") == 0)
4823 do_shutdown = FALSE;
4825 else sub_arg[3] = NULL; /* No eol if no timeout */
4827 /* If skipping, we don't actually do anything. Otherwise, arrange to
4828 connect to either an IP or a Unix socket. */
4832 /* Handle an IP (internet) domain */
4834 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4837 uschar * server_name = sub_arg[0] + 5;
4838 uschar * port_name = Ustrrchr(server_name, ':');
4840 /* Sort out the port */
4844 expand_string_message =
4845 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4848 *port_name++ = 0; /* Terminate server name */
4850 if (isdigit(*port_name))
4853 port = Ustrtol(port_name, &end, 0);
4854 if (end != port_name + Ustrlen(port_name))
4856 expand_string_message =
4857 string_sprintf("invalid port number %s", port_name);
4863 struct servent *service_info = getservbyname(CS port_name, "tcp");
4866 expand_string_message = string_sprintf("unknown port \"%s\"",
4870 port = ntohs(service_info->s_port);
4873 fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4874 timeout, NULL, &expand_string_message, &reqstr);
4875 callout_address = NULL;
4881 /* Handle a Unix domain socket */
4885 struct sockaddr_un sockun; /* don't call this "sun" ! */
4888 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4890 expand_string_message = string_sprintf("failed to create socket: %s",
4895 sockun.sun_family = AF_UNIX;
4896 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4899 sigalrm_seen = FALSE;
4901 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4905 expand_string_message = US "socket connect timed out";
4910 expand_string_message = string_sprintf("failed to connect to socket "
4911 "%s: %s", sub_arg[0], strerror(errno));
4916 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
4918 /* Allow sequencing of test actions */
4919 if (running_in_test_harness) millisleep(100);
4921 /* Write the request string, if not empty or already done */
4925 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
4927 if (write(fd, reqstr.data, reqstr.len) != reqstr.len)
4929 expand_string_message = string_sprintf("request write to socket "
4930 "failed: %s", strerror(errno));
4935 /* Shut down the sending side of the socket. This helps some servers to
4936 recognise that it is their turn to do some work. Just in case some
4937 system doesn't have this function, make it conditional. */
4940 if (do_shutdown) shutdown(fd, SHUT_WR);
4943 if (running_in_test_harness) millisleep(100);
4945 /* Now we need to read from the socket, under a timeout. The function
4946 that reads a file can be used. */
4948 f = fdopen(fd, "rb");
4949 sigalrm_seen = FALSE;
4951 yield = cat_file(f, yield, sub_arg[3]);
4955 /* After a timeout, we restore the pointer in the result, that is,
4956 make sure we add nothing from the socket. */
4960 yield->ptr = save_ptr;
4961 expand_string_message = US "socket read timed out";
4966 /* The whole thing has worked (or we were skipping). If there is a
4967 failure string following, we need to skip it. */
4971 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4975 expand_string_message = US"missing '}' closing failstring for readsocket";
4976 goto EXPAND_FAILED_CURLY;
4978 while (isspace(*s)) s++;
4984 expand_string_message = US"missing '}' closing readsocket";
4985 goto EXPAND_FAILED_CURLY;
4989 /* Come here on failure to create socket, connect socket, write to the
4990 socket, or timeout on reading. If another substring follows, expand and
4991 use it. Otherwise, those conditions give expand errors. */
4994 if (*s != '{') goto EXPAND_FAILED;
4995 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4996 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
4998 yield = string_cat(yield, arg);
5001 expand_string_message = US"missing '}' closing failstring for readsocket";
5002 goto EXPAND_FAILED_CURLY;
5004 while (isspace(*s)) s++;
5008 /* Handle "run" to execute a program. */
5014 const uschar **argv;
5018 if ((expand_forbid & RDO_RUN) != 0)
5020 expand_string_message = US"running a command is not permitted";
5024 while (isspace(*s)) s++;
5027 expand_string_message = US"missing '{' for command arg of run";
5028 goto EXPAND_FAILED_CURLY;
5030 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5031 if (arg == NULL) goto EXPAND_FAILED;
5032 while (isspace(*s)) s++;
5035 expand_string_message = US"missing '}' closing command arg of run";
5036 goto EXPAND_FAILED_CURLY;
5039 if (skipping) /* Just pretend it worked when we're skipping */
5042 lookup_value = NULL;
5046 if (!transport_set_up_command(&argv, /* anchor for arg list */
5047 arg, /* raw command */
5048 FALSE, /* don't expand the arguments */
5049 0, /* not relevant when... */
5050 NULL, /* no transporting address */
5051 US"${run} expansion", /* for error messages */
5052 &expand_string_message)) /* where to put error message */
5055 /* Create the child process, making it a group leader. */
5057 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
5059 expand_string_message =
5060 string_sprintf("couldn't create child process: %s", strerror(errno));
5064 /* Nothing is written to the standard input. */
5068 /* Read the pipe to get the command's output into $value (which is kept
5069 in lookup_value). Read during execution, so that if the output exceeds
5070 the OS pipe buffer limit, we don't block forever. Remember to not release
5071 memory just allocated for $value. */
5074 f = fdopen(fd_out, "rb");
5075 sigalrm_seen = FALSE;
5077 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5081 /* Wait for the process to finish, applying the timeout, and inspect its
5082 return code for serious disasters. Simple non-zero returns are passed on.
5085 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5087 if (sigalrm_seen || runrc == -256)
5089 expand_string_message = string_sprintf("command timed out");
5090 killpg(pid, SIGKILL); /* Kill the whole process group */
5093 else if (runrc == -257)
5094 expand_string_message = string_sprintf("wait() failed: %s",
5098 expand_string_message = string_sprintf("command killed by signal %d",
5105 /* Process the yes/no strings; $value may be useful in both cases */
5107 switch(process_yesno(
5108 skipping, /* were previously skipping */
5109 runrc == 0, /* success/failure indicator */
5110 lookup_value, /* value to reset for string2 */
5111 &s, /* input pointer */
5112 &yield, /* output pointer */
5113 US"run", /* condition type */
5116 case 1: goto EXPAND_FAILED; /* when all is well, the */
5117 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5123 /* Handle character translation for "tr" */
5127 int oldptr = yield->ptr;
5131 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5133 case 1: goto EXPAND_FAILED_CURLY;
5135 case 3: goto EXPAND_FAILED;
5138 yield = string_cat(yield, sub[0]);
5139 o2m = Ustrlen(sub[2]) - 1;
5141 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5143 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5147 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5154 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5155 expanded arguments. */
5165 int val[2] = { 0, -1 };
5168 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5169 Ensure that sub[2] is set in the ${length } case. */
5172 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5173 TRUE, name, &resetok))
5175 case 1: goto EXPAND_FAILED_CURLY;
5177 case 3: goto EXPAND_FAILED;
5180 /* Juggle the arguments if there are only two of them: always move the
5181 string to the last position and make ${length{n}{str}} equivalent to
5182 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5188 if (item_type == EITEM_LENGTH)
5195 for (i = 0; i < 2; i++)
5197 if (sub[i] == NULL) continue;
5198 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5199 if (*ret != 0 || (i != 0 && val[i] < 0))
5201 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5202 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5208 (item_type == EITEM_HASH)?
5209 compute_hash(sub[2], val[0], val[1], &len) :
5210 (item_type == EITEM_NHASH)?
5211 compute_nhash(sub[2], val[0], val[1], &len) :
5212 extract_substr(sub[2], val[0], val[1], &len);
5214 if (ret == NULL) goto EXPAND_FAILED;
5215 yield = string_catn(yield, ret, len);
5219 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5220 This code originally contributed by Steve Haslam. It currently supports
5221 the use of MD5 and SHA-1 hashes.
5223 We need some workspace that is large enough to handle all the supported
5224 hash types. Use macros to set the sizes rather than be too elaborate. */
5226 #define MAX_HASHLEN 20
5227 #define MAX_HASHBLOCKLEN 64
5236 int hashlen; /* Number of octets for the hash algorithm's output */
5237 int hashblocklen; /* Number of octets the hash algorithm processes */
5239 unsigned int keylen;
5241 uschar keyhash[MAX_HASHLEN];
5242 uschar innerhash[MAX_HASHLEN];
5243 uschar finalhash[MAX_HASHLEN];
5244 uschar finalhash_hex[2*MAX_HASHLEN];
5245 uschar innerkey[MAX_HASHBLOCKLEN];
5246 uschar outerkey[MAX_HASHBLOCKLEN];
5248 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5250 case 1: goto EXPAND_FAILED_CURLY;
5252 case 3: goto EXPAND_FAILED;
5257 if (Ustrcmp(sub[0], "md5") == 0)
5260 use_base = &md5_base;
5264 else if (Ustrcmp(sub[0], "sha1") == 0)
5267 use_base = &sha1_ctx;
5273 expand_string_message =
5274 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5279 keylen = Ustrlen(keyptr);
5281 /* If the key is longer than the hash block length, then hash the key
5284 if (keylen > hashblocklen)
5286 chash_start(type, use_base);
5287 chash_end(type, use_base, keyptr, keylen, keyhash);
5292 /* Now make the inner and outer key values */
5294 memset(innerkey, 0x36, hashblocklen);
5295 memset(outerkey, 0x5c, hashblocklen);
5297 for (i = 0; i < keylen; i++)
5299 innerkey[i] ^= keyptr[i];
5300 outerkey[i] ^= keyptr[i];
5303 /* Now do the hashes */
5305 chash_start(type, use_base);
5306 chash_mid(type, use_base, innerkey);
5307 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5309 chash_start(type, use_base);
5310 chash_mid(type, use_base, outerkey);
5311 chash_end(type, use_base, innerhash, hashlen, finalhash);
5313 /* Encode the final hash as a hex string */
5316 for (i = 0; i < hashlen; i++)
5318 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5319 *p++ = hex_digits[finalhash[i] & 0x0f];
5322 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5323 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5325 yield = string_catn(yield, finalhash_hex, hashlen*2);
5330 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5331 We have to save the numerical variables and restore them afterwards. */
5336 int moffset, moffsetextra, slen;
5339 const uschar *rerror;
5342 int save_expand_nmax =
5343 save_expand_strings(save_expand_nstring, save_expand_nlength);
5345 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5347 case 1: goto EXPAND_FAILED_CURLY;
5349 case 3: goto EXPAND_FAILED;
5352 /* Compile the regular expression */
5354 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5359 expand_string_message = string_sprintf("regular expression error in "
5360 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5364 /* Now run a loop to do the substitutions as often as necessary. It ends
5365 when there are no more matches. Take care over matches of the null string;
5366 do the same thing as Perl does. */
5369 slen = Ustrlen(sub[0]);
5370 moffset = moffsetextra = 0;
5375 int ovector[3*(EXPAND_MAXN+1)];
5376 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5377 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5381 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5382 is not necessarily the end. We want to repeat the match from one
5383 character further along, but leaving the basic offset the same (for
5384 copying below). We can't be at the end of the string - that was checked
5385 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5386 finished; copy the remaining string and end the loop. */
5396 yield = string_catn(yield, subject+moffset, slen-moffset);
5400 /* Match - set up for expanding the replacement. */
5402 if (n == 0) n = EXPAND_MAXN + 1;
5404 for (nn = 0; nn < n*2; nn += 2)
5406 expand_nstring[expand_nmax] = subject + ovector[nn];
5407 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5411 /* Copy the characters before the match, plus the expanded insertion. */
5413 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
5414 insert = expand_string(sub[2]);
5415 if (insert == NULL) goto EXPAND_FAILED;
5416 yield = string_cat(yield, insert);
5418 moffset = ovector[1];
5422 /* If we have matched an empty string, first check to see if we are at
5423 the end of the subject. If so, the loop is over. Otherwise, mimic
5424 what Perl's /g options does. This turns out to be rather cunning. First
5425 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5426 string at the same point. If this fails (picked up above) we advance to
5427 the next character. */
5429 if (ovector[0] == ovector[1])
5431 if (ovector[0] == slen) break;
5432 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5436 /* All done - restore numerical variables. */
5438 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5439 save_expand_nlength);
5443 /* Handle keyed and numbered substring extraction. If the first argument
5444 consists entirely of digits, then a numerical extraction is assumed. */
5450 int field_number = 1;
5451 BOOL field_number_set = FALSE;
5452 uschar *save_lookup_value = lookup_value;
5454 int save_expand_nmax =
5455 save_expand_strings(save_expand_nstring, save_expand_nlength);
5457 /* While skipping we cannot rely on the data for expansions being
5458 available (eg. $item) hence cannot decide on numeric vs. keyed.
5459 Read a maximum of 5 arguments (including the yes/no) */
5463 while (isspace(*s)) s++;
5464 for (j = 5; j > 0 && *s == '{'; j--)
5466 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5467 goto EXPAND_FAILED; /*{*/
5470 expand_string_message = US"missing '{' for arg of extract";
5471 goto EXPAND_FAILED_CURLY;
5473 while (isspace(*s)) s++;
5475 if ( Ustrncmp(s, "fail", 4) == 0
5476 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5480 while (isspace(*s)) s++;
5484 expand_string_message = US"missing '}' closing extract";
5485 goto EXPAND_FAILED_CURLY;
5489 else for (i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5491 while (isspace(*s)) s++;
5492 if (*s == '{') /*}*/
5494 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5495 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5498 expand_string_message = string_sprintf(
5499 "missing '}' closing arg %d of extract", i+1);
5500 goto EXPAND_FAILED_CURLY;
5503 /* After removal of leading and trailing white space, the first
5504 argument must not be empty; if it consists entirely of digits
5505 (optionally preceded by a minus sign), this is a numerical
5506 extraction, and we expect 3 arguments. */
5514 while (isspace(*p)) p++;
5518 while (len > 0 && isspace(p[len-1])) len--;
5523 expand_string_message = US"first argument of \"extract\" must "
5533 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5537 j = 3; /* Need 3 args */
5538 field_number_set = TRUE;
5544 expand_string_message = string_sprintf(
5545 "missing '{' for arg %d of extract", i+1);
5546 goto EXPAND_FAILED_CURLY;
5550 /* Extract either the numbered or the keyed substring into $value. If
5551 skipping, just pretend the extraction failed. */
5553 lookup_value = skipping? NULL : field_number_set?
5554 expand_gettokened(field_number, sub[1], sub[2]) :
5555 expand_getkeyed(sub[0], sub[1]);
5557 /* If no string follows, $value gets substituted; otherwise there can
5558 be yes/no strings, as for lookup or if. */
5560 switch(process_yesno(
5561 skipping, /* were previously skipping */
5562 lookup_value != NULL, /* success/failure indicator */
5563 save_lookup_value, /* value to reset for string2 */
5564 &s, /* input pointer */
5565 &yield, /* output pointer */
5566 US"extract", /* condition type */
5569 case 1: goto EXPAND_FAILED; /* when all is well, the */
5570 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5573 /* All done - restore numerical variables. */
5575 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5576 save_expand_nlength);
5581 /* return the Nth item from a list */
5583 case EITEM_LISTEXTRACT:
5586 int field_number = 1;
5587 uschar *save_lookup_value = lookup_value;
5589 int save_expand_nmax =
5590 save_expand_strings(save_expand_nstring, save_expand_nlength);
5592 /* Read the field & list arguments */
5594 for (i = 0; i < 2; i++)
5596 while (isspace(*s)) s++;
5597 if (*s != '{') /*}*/
5599 expand_string_message = string_sprintf(
5600 "missing '{' for arg %d of listextract", i+1);
5601 goto EXPAND_FAILED_CURLY;
5604 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5605 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5608 expand_string_message = string_sprintf(
5609 "missing '}' closing arg %d of listextract", i+1);
5610 goto EXPAND_FAILED_CURLY;
5613 /* After removal of leading and trailing white space, the first
5614 argument must be numeric and nonempty. */
5622 while (isspace(*p)) p++;
5626 while (len > 0 && isspace(p[len-1])) len--;
5629 if (!*p && !skipping)
5631 expand_string_message = US"first argument of \"listextract\" must "
5641 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5644 expand_string_message = US"first argument of \"listextract\" must "
5652 /* Extract the numbered element into $value. If
5653 skipping, just pretend the extraction failed. */
5655 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5657 /* If no string follows, $value gets substituted; otherwise there can
5658 be yes/no strings, as for lookup or if. */
5660 switch(process_yesno(
5661 skipping, /* were previously skipping */
5662 lookup_value != NULL, /* success/failure indicator */
5663 save_lookup_value, /* value to reset for string2 */
5664 &s, /* input pointer */
5665 &yield, /* output pointer */
5666 US"listextract", /* condition type */
5669 case 1: goto EXPAND_FAILED; /* when all is well, the */
5670 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5673 /* All done - restore numerical variables. */
5675 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5676 save_expand_nlength);
5682 case EITEM_CERTEXTRACT:
5684 uschar *save_lookup_value = lookup_value;
5686 int save_expand_nmax =
5687 save_expand_strings(save_expand_nstring, save_expand_nlength);
5689 /* Read the field argument */
5690 while (isspace(*s)) s++;
5691 if (*s != '{') /*}*/
5693 expand_string_message = US"missing '{' for field arg of certextract";
5694 goto EXPAND_FAILED_CURLY;
5696 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5697 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5700 expand_string_message = US"missing '}' closing field arg of certextract";
5701 goto EXPAND_FAILED_CURLY;
5703 /* strip spaces fore & aft */
5708 while (isspace(*p)) p++;
5712 while (len > 0 && isspace(p[len-1])) len--;
5716 /* inspect the cert argument */
5717 while (isspace(*s)) s++;
5718 if (*s != '{') /*}*/
5720 expand_string_message = US"missing '{' for cert variable arg of certextract";
5721 goto EXPAND_FAILED_CURLY;
5725 expand_string_message = US"second argument of \"certextract\" must "
5726 "be a certificate variable";
5729 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5730 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5733 expand_string_message = US"missing '}' closing cert variable arg of certextract";
5734 goto EXPAND_FAILED_CURLY;
5738 lookup_value = NULL;
5741 lookup_value = expand_getcertele(sub[0], sub[1]);
5742 if (*expand_string_message) goto EXPAND_FAILED;
5744 switch(process_yesno(
5745 skipping, /* were previously skipping */
5746 lookup_value != NULL, /* success/failure indicator */
5747 save_lookup_value, /* value to reset for string2 */
5748 &s, /* input pointer */
5749 &yield, /* output pointer */
5750 US"certextract", /* condition type */
5753 case 1: goto EXPAND_FAILED; /* when all is well, the */
5754 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5757 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5758 save_expand_nlength);
5761 #endif /*SUPPORT_TLS*/
5763 /* Handle list operations */
5770 int save_ptr = yield->ptr;
5771 uschar outsep[2] = { '\0', '\0' };
5772 const uschar *list, *expr, *temp;
5773 uschar *save_iterate_item = iterate_item;
5774 uschar *save_lookup_value = lookup_value;
5776 while (isspace(*s)) s++;
5779 expand_string_message =
5780 string_sprintf("missing '{' for first arg of %s", name);
5781 goto EXPAND_FAILED_CURLY;
5784 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5785 if (list == NULL) goto EXPAND_FAILED;
5788 expand_string_message =
5789 string_sprintf("missing '}' closing first arg of %s", name);
5790 goto EXPAND_FAILED_CURLY;
5793 if (item_type == EITEM_REDUCE)
5796 while (isspace(*s)) s++;
5799 expand_string_message = US"missing '{' for second arg of reduce";
5800 goto EXPAND_FAILED_CURLY;
5802 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5803 if (!t) goto EXPAND_FAILED;
5807 expand_string_message = US"missing '}' closing second arg of reduce";
5808 goto EXPAND_FAILED_CURLY;
5812 while (isspace(*s)) s++;
5815 expand_string_message =
5816 string_sprintf("missing '{' for last arg of %s", name);
5817 goto EXPAND_FAILED_CURLY;
5822 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5823 if scanning a "false" part). This allows us to find the end of the
5824 condition, because if the list is empty, we won't actually evaluate the
5825 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5826 the normal internal expansion function. */
5828 if (item_type == EITEM_FILTER)
5830 temp = eval_condition(expr, &resetok, NULL);
5831 if (temp != NULL) s = temp;
5834 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5838 expand_string_message = string_sprintf("%s inside \"%s\" item",
5839 expand_string_message, name);
5843 while (isspace(*s)) s++;
5846 expand_string_message = string_sprintf("missing } at end of condition "
5847 "or expression inside \"%s\"; could be an unquoted } in the content",
5852 while (isspace(*s)) s++; /*{*/
5855 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5860 /* If we are skipping, we can now just move on to the next item. When
5861 processing for real, we perform the iteration. */
5863 if (skipping) continue;
5864 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
5866 *outsep = (uschar)sep; /* Separator as a string */
5868 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
5869 name, iterate_item, lookup_value);
5871 if (item_type == EITEM_FILTER)
5874 if (eval_condition(expr, &resetok, &condresult) == NULL)
5876 iterate_item = save_iterate_item;
5877 lookup_value = save_lookup_value;
5878 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5879 expand_string_message, name);
5882 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
5883 condresult? "true":"false");
5885 temp = iterate_item; /* TRUE => include this item */
5887 continue; /* FALSE => skip this item */
5890 /* EITEM_MAP and EITEM_REDUCE */
5894 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5898 iterate_item = save_iterate_item;
5899 expand_string_message = string_sprintf("%s inside \"%s\" item",
5900 expand_string_message, name);
5903 if (item_type == EITEM_REDUCE)
5905 lookup_value = t; /* Update the value of $value */
5906 continue; /* and continue the iteration */
5910 /* We reach here for FILTER if the condition is true, always for MAP,
5911 and never for REDUCE. The value in "temp" is to be added to the output
5912 list that is being created, ensuring that any occurrences of the
5913 separator character are doubled. Unless we are dealing with the first
5914 item of the output list, add in a space if the new item begins with the
5915 separator character, or is an empty string. */
5917 if (yield->ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5918 yield = string_catn(yield, US" ", 1);
5920 /* Add the string in "temp" to the output list that we are building,
5921 This is done in chunks by searching for the separator character. */
5925 size_t seglen = Ustrcspn(temp, outsep);
5927 yield = string_catn(yield, temp, seglen + 1);
5929 /* If we got to the end of the string we output one character
5930 too many; backup and end the loop. Otherwise arrange to double the
5933 if (temp[seglen] == '\0') { yield->ptr--; break; }
5934 yield = string_catn(yield, outsep, 1);
5938 /* Output a separator after the string: we will remove the redundant
5939 final one at the end. */
5941 yield = string_catn(yield, outsep, 1);
5942 } /* End of iteration over the list loop */
5944 /* REDUCE has generated no output above: output the final value of
5947 if (item_type == EITEM_REDUCE)
5949 yield = string_cat(yield, lookup_value);
5950 lookup_value = save_lookup_value; /* Restore $value */
5953 /* FILTER and MAP generate lists: if they have generated anything, remove
5954 the redundant final separator. Even though an empty item at the end of a
5955 list does not count, this is tidier. */
5957 else if (yield->ptr != save_ptr) yield->ptr--;
5959 /* Restore preserved $item */
5961 iterate_item = save_iterate_item;
5968 const uschar *srclist, *cmp, *xtract;
5970 const uschar *dstlist = NULL, *dstkeylist = NULL;
5972 uschar *save_iterate_item = iterate_item;
5974 while (isspace(*s)) s++;
5977 expand_string_message = US"missing '{' for list arg of sort";
5978 goto EXPAND_FAILED_CURLY;
5981 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5982 if (!srclist) goto EXPAND_FAILED;
5985 expand_string_message = US"missing '}' closing list arg of sort";
5986 goto EXPAND_FAILED_CURLY;
5989 while (isspace(*s)) s++;
5992 expand_string_message = US"missing '{' for comparator arg of sort";
5993 goto EXPAND_FAILED_CURLY;
5996 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5997 if (!cmp) goto EXPAND_FAILED;
6000 expand_string_message = US"missing '}' closing comparator arg of sort";
6001 goto EXPAND_FAILED_CURLY;
6004 while (isspace(*s)) s++;
6007 expand_string_message = US"missing '{' for extractor arg of sort";
6008 goto EXPAND_FAILED_CURLY;
6012 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
6013 if (!tmp) goto EXPAND_FAILED;
6014 xtract = string_copyn(xtract, s - xtract);
6018 expand_string_message = US"missing '}' closing extractor arg of sort";
6019 goto EXPAND_FAILED_CURLY;
6024 expand_string_message = US"missing } at end of \"sort\"";
6028 if (skipping) continue;
6030 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6033 gstring * newlist = NULL;
6034 gstring * newkeylist = NULL;
6037 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6039 /* extract field for comparisons */
6040 iterate_item = srcitem;
6041 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6045 expand_string_message = string_sprintf(
6046 "field-extract in sort: \"%s\"", xtract);
6050 /* Insertion sort */
6052 /* copy output list until new-item < list-item */
6053 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6059 /* field for comparison */
6060 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6063 /* build and run condition string */
6064 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
6066 DEBUG(D_expand) debug_printf_indent("%s: cond = \"%s\"\n", name, expr);
6067 if (!eval_condition(expr, &resetok, &before))
6069 expand_string_message = string_sprintf("comparison in sort: %s",
6076 /* New-item sorts before this dst-item. Append new-item,
6077 then dst-item, then remainder of dst list. */
6079 newlist = string_append_listele(newlist, sep, srcitem);
6080 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6083 newlist = string_append_listele(newlist, sep, dstitem);
6084 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6086 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6088 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6090 newlist = string_append_listele(newlist, sep, dstitem);
6091 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6097 newlist = string_append_listele(newlist, sep, dstitem);
6098 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6101 /* If we ran out of dstlist without consuming srcitem, append it */
6104 newlist = string_append_listele(newlist, sep, srcitem);
6105 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6108 dstlist = newlist->s;
6109 dstkeylist = newkeylist->s;
6111 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6112 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6116 yield = string_cat(yield, dstlist);
6118 /* Restore preserved $item */
6119 iterate_item = save_iterate_item;
6123 expand_string_message = US"Internal error in sort (list mismatch)";
6128 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6129 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6130 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6131 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6133 #define EXPAND_DLFUNC_MAX_ARGS 8
6136 #ifndef EXPAND_DLFUNC
6137 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6138 "is not included in this binary";
6141 #else /* EXPAND_DLFUNC */
6144 exim_dlfunc_t *func;
6147 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6149 if ((expand_forbid & RDO_DLFUNC) != 0)
6151 expand_string_message =
6152 US"dynamically-loaded functions are not permitted";
6156 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6157 TRUE, US"dlfunc", &resetok))
6159 case 1: goto EXPAND_FAILED_CURLY;
6161 case 3: goto EXPAND_FAILED;
6164 /* If skipping, we don't actually do anything */
6166 if (skipping) continue;
6168 /* Look up the dynamically loaded object handle in the tree. If it isn't
6169 found, dlopen() the file and put the handle in the tree for next time. */
6171 t = tree_search(dlobj_anchor, argv[0]);
6174 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6177 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6178 argv[0], dlerror());
6179 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6182 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6183 Ustrcpy(t->name, argv[0]);
6184 t->data.ptr = handle;
6185 (void)tree_insertnode(&dlobj_anchor, t);
6188 /* Having obtained the dynamically loaded object handle, look up the
6189 function pointer. */
6191 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6194 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6195 "%s", argv[1], argv[0], dlerror());
6196 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6200 /* Call the function and work out what to do with the result. If it
6201 returns OK, we have a replacement string; if it returns DEFER then
6202 expansion has failed in a non-forced manner; if it returns FAIL then
6203 failure was forced; if it returns ERROR or any other value there's a
6204 problem, so panic slightly. In any case, assume that the function has
6205 side-effects on the store that must be preserved. */
6209 for (argc = 0; argv[argc] != NULL; argc++);
6210 status = func(&result, argc - 2, &argv[2]);
6213 if (result == NULL) result = US"";
6214 yield = string_cat(yield, result);
6219 expand_string_message = result == NULL ? US"(no message)" : result;
6220 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
6221 else if(status != FAIL)
6222 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6223 argv[0], argv[1], status, expand_string_message);
6227 #endif /* EXPAND_DLFUNC */
6229 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6232 uschar *save_lookup_value = lookup_value;
6234 while (isspace(*s)) s++;
6235 if (*s != '{') /*}*/
6238 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6239 if (!key) goto EXPAND_FAILED; /*{*/
6242 expand_string_message = US"missing '{' for name arg of env";
6243 goto EXPAND_FAILED_CURLY;
6246 lookup_value = US getenv(CS key);
6248 switch(process_yesno(
6249 skipping, /* were previously skipping */
6250 lookup_value != NULL, /* success/failure indicator */
6251 save_lookup_value, /* value to reset for string2 */
6252 &s, /* input pointer */
6253 &yield, /* output pointer */
6254 US"env", /* condition type */
6257 case 1: goto EXPAND_FAILED; /* when all is well, the */
6258 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6262 } /* EITEM_* switch */
6264 /* Control reaches here if the name is not recognized as one of the more
6265 complicated expansion items. Check for the "operator" syntax (name terminated
6266 by a colon). Some of the operators have arguments, separated by _ from the
6274 var_entry *vp = NULL;
6276 /* Owing to an historical mis-design, an underscore may be part of the
6277 operator name, or it may introduce arguments. We therefore first scan the
6278 table of names that contain underscores. If there is no match, we cut off
6279 the arguments and then scan the main table. */
6281 if ((c = chop_match(name, op_table_underscore,
6282 nelem(op_table_underscore))) < 0)
6284 arg = Ustrchr(name, '_');
6285 if (arg != NULL) *arg = 0;
6286 c = chop_match(name, op_table_main, nelem(op_table_main));
6287 if (c >= 0) c += nelem(op_table_underscore);
6288 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6291 /* Deal specially with operators that might take a certificate variable
6292 as we do not want to do the usual expansion. For most, expand the string.*/
6302 const uschar * s1 = s;
6303 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6305 if (!sub) goto EXPAND_FAILED; /*{*/
6308 expand_string_message =
6309 string_sprintf("missing '}' closing cert arg of %s", name);
6310 goto EXPAND_FAILED_CURLY;
6312 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6322 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6323 if (!sub) goto EXPAND_FAILED;
6328 /* If we are skipping, we don't need to perform the operation at all.
6329 This matters for operations like "mask", because the data may not be
6330 in the correct format when skipping. For example, the expression may test
6331 for the existence of $sender_host_address before trying to mask it. For
6332 other operations, doing them may not fail, but it is a waste of time. */
6334 if (skipping && c >= 0) continue;
6336 /* Otherwise, switch on the operator type */
6343 unsigned long int n = Ustrtoul(sub, &t, 10);
6348 expand_string_message = string_sprintf("argument for base32 "
6349 "operator is \"%s\", which is not a decimal number", sub);
6353 g = string_catn(g, &base32_chars[n & 0x1f], 1);
6355 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
6362 unsigned long int n = 0;
6366 uschar * t = Ustrchr(base32_chars, *tt++);
6369 expand_string_message = string_sprintf("argument for base32d "
6370 "operator is \"%s\", which is not a base 32 number", sub);
6373 n = n * 32 + (t - base32_chars);
6375 s = string_sprintf("%ld", n);
6376 yield = string_cat(yield, s);
6383 unsigned long int n = Ustrtoul(sub, &t, 10);
6386 expand_string_message = string_sprintf("argument for base62 "
6387 "operator is \"%s\", which is not a decimal number", sub);
6390 t = string_base62(n);
6391 yield = string_cat(yield, t);
6395 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6401 unsigned long int n = 0;
6404 uschar *t = Ustrchr(base62_chars, *tt++);
6407 expand_string_message = string_sprintf("argument for base62d "
6408 "operator is \"%s\", which is not a base %d number", sub,
6412 n = n * BASE_62 + (t - base62_chars);
6414 (void)sprintf(CS buf, "%ld", n);
6415 yield = string_cat(yield, buf);
6421 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6422 if (expanded == NULL)
6424 expand_string_message =
6425 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6426 expand_string_message);
6429 yield = string_cat(yield, expanded);
6436 uschar *t = sub - 1;
6437 while (*(++t) != 0) { *t = tolower(*t); count++; }
6438 yield = string_catn(yield, sub, count);
6445 uschar *t = sub - 1;
6446 while (*(++t) != 0) { *t = toupper(*t); count++; }
6447 yield = string_catn(yield, sub, count);
6453 if (vp && *(void **)vp->value)
6455 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6456 yield = string_cat(yield, cp);
6466 md5_end(&base, sub, Ustrlen(sub), digest);
6467 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6468 yield = string_cat(yield, US st);
6474 if (vp && *(void **)vp->value)
6476 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6477 yield = string_cat(yield, cp);
6487 sha1_end(&h, sub, Ustrlen(sub), digest);
6488 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6489 yield = string_catn(yield, US st, 40);
6494 #ifdef EXIM_HAVE_SHA2
6495 if (vp && *(void **)vp->value)
6497 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6498 yield = string_cat(yield, cp);
6506 if (!exim_sha_init(&h, HASH_SHA2_256))
6508 expand_string_message = US"unrecognised sha256 variant";
6511 exim_sha_update(&h, sub, Ustrlen(sub));
6512 exim_sha_finish(&h, &b);
6515 sprintf(st, "%02X", *b.data++);
6516 yield = string_catn(yield, US st, 2);
6520 expand_string_message = US"sha256 only supported with TLS";
6525 #ifdef EXIM_HAVE_SHA3
6530 hashmethod m = !arg ? HASH_SHA3_256
6531 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6532 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6533 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6534 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6537 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6539 expand_string_message = US"unrecognised sha3 variant";
6543 exim_sha_update(&h, sub, Ustrlen(sub));
6544 exim_sha_finish(&h, &b);
6547 sprintf(st, "%02X", *b.data++);
6548 yield = string_catn(yield, US st, 2);
6553 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
6557 /* Convert hex encoding to base64 encoding */
6567 for (enc = sub; *enc != 0; enc++)
6569 if (!isxdigit(*enc))
6571 expand_string_message = string_sprintf("\"%s\" is not a hex "
6580 expand_string_message = string_sprintf("\"%s\" contains an odd "
6581 "number of characters", sub);
6585 while ((c = *in++) != 0)
6587 if (isdigit(c)) c -= '0';
6588 else c = toupper(c) - 'A' + 10;
6600 enc = b64encode(sub, out - sub);
6601 yield = string_cat(yield, enc);
6605 /* Convert octets outside 0x21..0x7E to \xXX form */
6609 uschar *t = sub - 1;
6612 if (*t < 0x21 || 0x7E < *t)
6613 yield = string_catn(yield, string_sprintf("\\x%02x", *t), 4);
6615 yield = string_catn(yield, t, 1);
6620 /* count the number of list elements */
6629 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6630 cp = string_sprintf("%d", cnt);
6631 yield = string_cat(yield, cp);
6635 /* expand a named list given the name */
6636 /* handles nested named lists; requotes as colon-sep list */
6640 tree_node *t = NULL;
6641 const uschar * list;
6644 uschar * suffix = US"";
6645 BOOL needsep = FALSE;
6648 if (*sub == '+') sub++;
6649 if (arg == NULL) /* no-argument version */
6651 if (!(t = tree_search(addresslist_anchor, sub)) &&
6652 !(t = tree_search(domainlist_anchor, sub)) &&
6653 !(t = tree_search(hostlist_anchor, sub)))
6654 t = tree_search(localpartlist_anchor, sub);
6656 else switch(*arg) /* specific list-type version */
6658 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6659 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6660 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6661 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6663 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6669 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6671 : *arg=='a'?"address "
6672 : *arg=='d'?"domain "
6674 : *arg=='l'?"localpart "
6679 list = ((namedlist_block *)(t->data.ptr))->string;
6681 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
6683 uschar * buf = US" : ";
6685 yield = string_catn(yield, buf, 3);
6689 if (*item == '+') /* list item is itself a named list */
6691 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6692 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6694 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6698 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6699 while ((cp= strpbrk(CCS item, tok)))
6701 yield = string_catn(yield, item, cp - CS item);
6702 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6704 yield = string_catn(yield, US"::", 2);
6707 else /* sep in item; should already be doubled; emit once */
6709 yield = string_catn(yield, US tok, 1);
6710 if (*cp == sep) cp++;
6715 yield = string_cat(yield, item);
6720 /* mask applies a mask to an IP address; for example the result of
6721 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6728 int mask, maskoffset;
6729 int type = string_is_ip_address(sub, &maskoffset);
6734 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6739 if (maskoffset == 0)
6741 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6746 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6748 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6750 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6755 /* Convert the address to binary integer(s) and apply the mask */
6757 sub[maskoffset] = 0;
6758 count = host_aton(sub, binary);
6759 host_mask(count, binary, mask);
6761 /* Convert to masked textual format and add to output. */
6763 yield = string_catn(yield, buffer,
6764 host_nmtoa(count, binary, mask, buffer, '.'));
6769 case EOP_IPV6DENORM:
6771 int type = string_is_ip_address(sub, NULL);
6778 (void) host_aton(sub, binary);
6781 case 4: /* convert to IPv4-mapped IPv6 */
6782 binary[0] = binary[1] = 0;
6783 binary[2] = 0x0000ffff;
6784 (void) host_aton(sub, binary+3);
6788 expand_string_message =
6789 string_sprintf("\"%s\" is not an IP address", sub);
6793 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
6794 ? ipv6_nmtoa(binary, buffer)
6795 : host_nmtoa(4, binary, -1, buffer, ':')
6801 case EOP_LOCAL_PART:
6805 int start, end, domain;
6806 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
6809 if (c != EOP_DOMAIN)
6811 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6812 yield = string_catn(yield, sub+start, end-start);
6814 else if (domain != 0)
6817 yield = string_catn(yield, sub+domain, end-domain);
6824 uschar outsep[2] = { ':', '\0' };
6825 uschar *address, *error;
6826 int save_ptr = yield->ptr;
6827 int start, end, domain; /* Not really used */
6829 while (isspace(*sub)) sub++;
6831 if (*outsep = *++sub) ++sub;
6834 expand_string_message = string_sprintf("output separator "
6835 "missing in expanding ${addresses:%s}", --sub);
6838 parse_allow_group = TRUE;
6842 uschar *p = parse_find_address_end(sub, FALSE);
6843 uschar saveend = *p;
6845 address = parse_extract_address(sub, &error, &start, &end, &domain,
6849 /* Add the address to the output list that we are building. This is
6850 done in chunks by searching for the separator character. At the
6851 start, unless we are dealing with the first address of the output
6852 list, add in a space if the new address begins with the separator
6853 character, or is an empty string. */
6855 if (address != NULL)
6857 if (yield->ptr != save_ptr && address[0] == *outsep)
6858 yield = string_catn(yield, US" ", 1);
6862 size_t seglen = Ustrcspn(address, outsep);
6863 yield = string_catn(yield, address, seglen + 1);
6865 /* If we got to the end of the string we output one character
6868 if (address[seglen] == '\0') { yield->ptr--; break; }
6869 yield = string_catn(yield, outsep, 1);
6870 address += seglen + 1;
6873 /* Output a separator after the string: we will remove the
6874 redundant final one at the end. */
6876 yield = string_catn(yield, outsep, 1);
6879 if (saveend == '\0') break;
6883 /* If we have generated anything, remove the redundant final
6886 if (yield->ptr != save_ptr) yield->ptr--;
6887 parse_allow_group = FALSE;
6892 /* quote puts a string in quotes if it is empty or contains anything
6893 other than alphamerics, underscore, dot, or hyphen.
6895 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6896 be quoted in order to be a valid local part.
6898 In both cases, newlines and carriage returns are converted into \n and \r
6902 case EOP_QUOTE_LOCAL_PART:
6905 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6906 uschar *t = sub - 1;
6910 while (!needs_quote && *(++t) != 0)
6911 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6913 else /* EOP_QUOTE_LOCAL_PART */
6915 while (!needs_quote && *(++t) != 0)
6916 needs_quote = !isalnum(*t) &&
6917 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6918 (*t != '.' || t == sub || t[1] == 0);
6923 yield = string_catn(yield, US"\"", 1);
6928 yield = string_catn(yield, US"\\n", 2);
6929 else if (*t == '\r')
6930 yield = string_catn(yield, US"\\r", 2);
6933 if (*t == '\\' || *t == '"')
6934 yield = string_catn(yield, US"\\", 1);
6935 yield = string_catn(yield, t, 1);
6938 yield = string_catn(yield, US"\"", 1);
6940 else yield = string_cat(yield, sub);
6944 /* quote_lookuptype does lookup-specific quoting */
6949 uschar *opt = Ustrchr(arg, '_');
6951 if (opt != NULL) *opt++ = 0;
6953 n = search_findtype(arg, Ustrlen(arg));
6956 expand_string_message = search_error_message;
6960 if (lookup_list[n]->quote != NULL)
6961 sub = (lookup_list[n]->quote)(sub, opt);
6962 else if (opt != NULL) sub = NULL;
6966 expand_string_message = string_sprintf(
6967 "\"%s\" unrecognized after \"${quote_%s\"",
6972 yield = string_cat(yield, sub);
6976 /* rx quote sticks in \ before any non-alphameric character so that
6977 the insertion works in a regular expression. */
6981 uschar *t = sub - 1;
6985 yield = string_catn(yield, US"\\", 1);
6986 yield = string_catn(yield, t, 1);
6991 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6992 prescribed by the RFC, if there are characters that need to be encoded */
6996 uschar buffer[2048];
6997 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6998 buffer, sizeof(buffer), FALSE);
6999 yield = string_cat(yield, string);
7003 /* RFC 2047 decode */
7009 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7010 headers_charset, '?', &len, &error);
7013 expand_string_message = error;
7016 yield = string_catn(yield, decoded, len);
7020 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7030 if (c > 255) c = '_';
7032 yield = string_catn(yield, buff, 1);
7037 /* replace illegal UTF-8 sequences by replacement character */
7039 #define UTF8_REPLACEMENT_CHAR US"?"
7043 int seq_len = 0, index = 0;
7045 long codepoint = -1;
7046 uschar seq_buff[4]; /* accumulate utf-8 here */
7055 if ((c & 0xc0) != 0x80)
7056 /* wrong continuation byte; invalidate all bytes */
7057 complete = 1; /* error */
7060 codepoint = (codepoint << 6) | (c & 0x3f);
7061 seq_buff[index++] = c;
7062 if (--bytes_left == 0) /* codepoint complete */
7063 if(codepoint > 0x10FFFF) /* is it too large? */
7064 complete = -1; /* error (RFC3629 limit) */
7066 { /* finished; output utf-8 sequence */
7067 yield = string_catn(yield, seq_buff, seq_len);
7072 else /* no bytes left: new sequence */
7074 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7076 yield = string_catn(yield, &c, 1);
7079 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7081 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7086 codepoint = c & 0x1f;
7089 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7092 codepoint = c & 0x0f;
7094 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7097 codepoint = c & 0x07;
7099 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7102 seq_buff[index++] = c;
7103 seq_len = bytes_left + 1;
7104 } /* if(bytes_left) */
7108 bytes_left = index = 0;
7109 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7111 if ((complete == 1) && ((c & 0x80) == 0))
7112 /* ASCII character follows incomplete sequence */
7113 yield = string_catn(yield, &c, 1);
7119 case EOP_UTF8_DOMAIN_TO_ALABEL:
7121 uschar * error = NULL;
7122 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7125 expand_string_message = string_sprintf(
7126 "error converting utf8 (%s) to alabel: %s",
7127 string_printing(sub), error);
7130 yield = string_cat(yield, s);
7134 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7136 uschar * error = NULL;
7137 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7140 expand_string_message = string_sprintf(
7141 "error converting alabel (%s) to utf8: %s",
7142 string_printing(sub), error);
7145 yield = string_cat(yield, s);
7149 case EOP_UTF8_LOCALPART_TO_ALABEL:
7151 uschar * error = NULL;
7152 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7155 expand_string_message = string_sprintf(
7156 "error converting utf8 (%s) to alabel: %s",
7157 string_printing(sub), error);
7160 yield = string_cat(yield, s);
7161 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7165 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7167 uschar * error = NULL;
7168 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7171 expand_string_message = string_sprintf(
7172 "error converting alabel (%s) to utf8: %s",
7173 string_printing(sub), error);
7176 yield = string_cat(yield, s);
7179 #endif /* EXPERIMENTAL_INTERNATIONAL */
7181 /* escape turns all non-printing characters into escape sequences. */
7185 const uschar * t = string_printing(sub);
7186 yield = string_cat(yield, t);
7190 case EOP_ESCAPE8BIT:
7192 const uschar * s = sub;
7195 for (s = sub; (c = *s); s++)
7196 yield = c < 127 && c != '\\'
7197 ? string_catn(yield, s, 1)
7198 : string_catn(yield, string_sprintf("\\%03o", c), 4);
7202 /* Handle numeric expression evaluation */
7207 uschar *save_sub = sub;
7208 uschar *error = NULL;
7209 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7212 expand_string_message = string_sprintf("error in expression "
7213 "evaluation: %s (after processing \"%.*s\")", error,
7214 (int)(sub-save_sub), save_sub);
7217 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
7218 yield = string_cat(yield, var_buffer);
7222 /* Handle time period formating */
7226 int n = readconf_readtime(sub, 0, FALSE);
7229 expand_string_message = string_sprintf("string \"%s\" is not an "
7230 "Exim time interval in \"%s\" operator", sub, name);
7233 sprintf(CS var_buffer, "%d", n);
7234 yield = string_cat(yield, var_buffer);
7238 case EOP_TIME_INTERVAL:
7241 uschar *t = read_number(&n, sub);
7242 if (*t != 0) /* Not A Number*/
7244 expand_string_message = string_sprintf("string \"%s\" is not a "
7245 "positive number in \"%s\" operator", sub, name);
7248 t = readconf_printtime(n);
7249 yield = string_cat(yield, t);
7253 /* Convert string to base64 encoding */
7259 uschar * s = vp && *(void **)vp->value
7260 ? tls_cert_der_b64(*(void **)vp->value)
7261 : b64encode(sub, Ustrlen(sub));
7263 uschar * s = b64encode(sub, Ustrlen(sub));
7265 yield = string_cat(yield, s);
7272 int len = b64decode(sub, &s);
7275 expand_string_message = string_sprintf("string \"%s\" is not "
7276 "well-formed for \"%s\" operator", sub, name);
7279 yield = string_cat(yield, s);
7283 /* strlen returns the length of the string */
7288 (void)sprintf(CS buff, "%d", Ustrlen(sub));
7289 yield = string_cat(yield, buff);
7293 /* length_n or l_n takes just the first n characters or the whole string,
7294 whichever is the shorter;
7296 substr_m_n, and s_m_n take n characters from offset m; negative m take
7297 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7298 takes the rest, either to the right or to the left.
7300 hash_n or h_n makes a hash of length n from the string, yielding n
7301 characters from the set a-z; hash_n_m makes a hash of length n, but
7302 uses m characters from the set a-zA-Z0-9.
7304 nhash_n returns a single number between 0 and n-1 (in text form), while
7305 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7306 between 0 and n-1 and the second between 0 and m-1. */
7326 expand_string_message = string_sprintf("missing values after %s",
7331 /* "length" has only one argument, effectively being synonymous with
7334 if (c == EOP_LENGTH || c == EOP_L)
7340 /* The others have one or two arguments; for "substr" the first may be
7341 negative. The second being negative means "not supplied". */
7346 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7349 /* Read up to two numbers, separated by underscores */
7354 if (arg != ret && *arg == '_' && pn == &value1)
7358 if (arg[1] != 0) arg++;
7360 else if (!isdigit(*arg))
7362 expand_string_message =
7363 string_sprintf("non-digit after underscore in \"%s\"", name);
7366 else *pn = (*pn)*10 + *arg++ - '0';
7370 /* Perform the required operation */
7373 (c == EOP_HASH || c == EOP_H)?
7374 compute_hash(sub, value1, value2, &len) :
7375 (c == EOP_NHASH || c == EOP_NH)?
7376 compute_nhash(sub, value1, value2, &len) :
7377 extract_substr(sub, value1, value2, &len);
7379 if (ret == NULL) goto EXPAND_FAILED;
7380 yield = string_catn(yield, ret, len);
7390 uschar **modetable[3];
7395 if ((expand_forbid & RDO_EXISTS) != 0)
7397 expand_string_message = US"Use of the stat() expansion is not permitted";
7401 if (stat(CS sub, &st) < 0)
7403 expand_string_message = string_sprintf("stat(%s) failed: %s",
7404 sub, strerror(errno));
7408 switch (mode & S_IFMT)
7410 case S_IFIFO: smode[0] = 'p'; break;
7411 case S_IFCHR: smode[0] = 'c'; break;
7412 case S_IFDIR: smode[0] = 'd'; break;
7413 case S_IFBLK: smode[0] = 'b'; break;
7414 case S_IFREG: smode[0] = '-'; break;
7415 default: smode[0] = '?'; break;
7418 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7419 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7420 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7422 for (i = 0; i < 3; i++)
7424 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7429 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7430 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7431 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7432 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7433 (long)st.st_gid, st.st_size, (long)st.st_atime,
7434 (long)st.st_mtime, (long)st.st_ctime);
7435 yield = string_cat(yield, s);
7439 /* vaguely random number less than N */
7443 int_eximarith_t max;
7446 max = expanded_string_integer(sub, TRUE);
7447 if (expand_string_message != NULL)
7449 s = string_sprintf("%d", vaguely_random_number((int)max));
7450 yield = string_cat(yield, s);
7454 /* Reverse IP, including IPv6 to dotted-nibble */
7456 case EOP_REVERSE_IP:
7458 int family, maskptr;
7459 uschar reversed[128];
7461 family = string_is_ip_address(sub, &maskptr);
7464 expand_string_message = string_sprintf(
7465 "reverse_ip() not given an IP address [%s]", sub);
7468 invert_address(reversed, sub);
7469 yield = string_cat(yield, reversed);
7473 /* Unknown operator */
7476 expand_string_message =
7477 string_sprintf("unknown expansion operator \"%s\"", name);
7482 /* Handle a plain name. If this is the first thing in the expansion, release
7483 the pre-allocated buffer. If the result data is known to be in a new buffer,
7484 newsize will be set to the size of that buffer, and we can just point at that
7485 store instead of copying. Many expansion strings contain just one reference,
7486 so this is a useful optimization, especially for humungous headers
7487 ($message_headers). */
7496 g = store_get(sizeof(gstring));
7497 else if (yield->ptr == 0)
7499 if (resetok) store_reset(yield);
7501 g = store_get(sizeof(gstring)); /* alloc _before_ calling find_variable() */
7503 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
7505 expand_string_message =
7506 string_sprintf("unknown variable in \"${%s}\"", name);
7507 check_variable_error_message(name);
7510 len = Ustrlen(value);
7511 if (!yield && newsize)
7514 yield->size = newsize;
7519 yield = string_catn(yield, value, len);
7523 /* Else there's something wrong */
7525 expand_string_message =
7526 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7527 "in a variable reference)", name);
7531 /* If we hit the end of the string when ket_ends is set, there is a missing
7532 terminating brace. */
7534 if (ket_ends && *s == 0)
7536 expand_string_message = malformed_header
7537 ? US"missing } at end of string - could be header name not terminated by colon"
7538 : US"missing } at end of string";
7542 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7543 added to the string. If so, set up an empty string. Add a terminating zero. If
7544 left != NULL, return a pointer to the terminator. */
7547 yield = string_get(1);
7548 (void) string_from_gstring(yield);
7549 if (left) *left = s;
7551 /* Any stacking store that was used above the final string is no longer needed.
7552 In many cases the final string will be the first one that was got and so there
7553 will be optimal store usage. */
7555 if (resetok) store_reset(yield->s + (yield->size = yield->ptr + 1));
7556 else if (resetok_p) *resetok_p = FALSE;
7560 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
7561 "expanding: %.*s\n",
7562 (int)(s - string), string);
7563 debug_printf_indent("%s"
7564 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7566 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7569 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7570 "skipping: result is not used\n");
7575 /* This is the failure exit: easiest to program with a goto. We still need
7576 to update the pointer to the terminator, for cases of nested calls with "fail".
7579 EXPAND_FAILED_CURLY:
7580 if (malformed_header)
7581 expand_string_message =
7582 US"missing or misplaced { or } - could be header name not terminated by colon";
7584 else if (!expand_string_message || !*expand_string_message)
7585 expand_string_message = US"missing or misplaced { or }";
7587 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7588 that is a bad idea, because expand_string_message is in dynamic store. */
7591 if (left) *left = s;
7594 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
7596 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7597 "error message: %s\n",
7598 expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7599 expand_string_message);
7600 if (expand_string_forcedfail)
7601 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
7603 if (resetok_p && !resetok) *resetok_p = FALSE;
7609 /* This is the external function call. Do a quick check for any expansion
7610 metacharacters, and if there are none, just return the input string.
7612 Argument: the string to be expanded
7613 Returns: the expanded string, or NULL if expansion failed; if failure was
7614 due to a lookup deferring, search_find_defer will be TRUE
7618 expand_cstring(const uschar * string)
7620 if (Ustrpbrk(string, "$\\") != NULL)
7622 int old_pool = store_pool;
7625 search_find_defer = FALSE;
7626 malformed_header = FALSE;
7627 store_pool = POOL_MAIN;
7628 s = expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7629 store_pool = old_pool;
7637 expand_string(uschar * string)
7639 return US expand_cstring(CUS string);
7646 /*************************************************
7648 *************************************************/
7650 /* Now and again we want to expand a string and be sure that the result is in a
7651 new bit of store. This function does that.
7652 Since we know it has been copied, the de-const cast is safe.
7654 Argument: the string to be expanded
7655 Returns: the expanded string, always in a new bit of store, or NULL
7659 expand_string_copy(const uschar *string)
7661 const uschar *yield = expand_cstring(string);
7662 if (yield == string) yield = string_copy(string);
7668 /*************************************************
7669 * Expand and interpret as an integer *
7670 *************************************************/
7672 /* Expand a string, and convert the result into an integer.
7675 string the string to be expanded
7676 isplus TRUE if a non-negative number is expected
7678 Returns: the integer value, or
7679 -1 for an expansion error ) in both cases, message in
7680 -2 for an integer interpretation error ) expand_string_message
7681 expand_string_message is set NULL for an OK integer
7685 expand_string_integer(uschar *string, BOOL isplus)
7687 return expanded_string_integer(expand_string(string), isplus);
7691 /*************************************************
7692 * Interpret string as an integer *
7693 *************************************************/
7695 /* Convert a string (that has already been expanded) into an integer.
7697 This function is used inside the expansion code.
7700 s the string to be expanded
7701 isplus TRUE if a non-negative number is expected
7703 Returns: the integer value, or
7704 -1 if string is NULL (which implies an expansion error)
7705 -2 for an integer interpretation error
7706 expand_string_message is set NULL for an OK integer
7709 static int_eximarith_t
7710 expanded_string_integer(const uschar *s, BOOL isplus)
7712 int_eximarith_t value;
7713 uschar *msg = US"invalid integer \"%s\"";
7716 /* If expansion failed, expand_string_message will be set. */
7718 if (s == NULL) return -1;
7720 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7721 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7722 systems, so we set it zero ourselves. */
7725 expand_string_message = NULL; /* Indicates no error */
7727 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7728 equal to 0. Unfortunately, people actually relied upon that, so preserve
7729 the behaviour explicitly. Stripping leading whitespace is a harmless
7730 noop change since strtol skips it anyway (provided that there is a number
7734 while (isspace(*s)) ++s;
7738 debug_printf_indent("treating blank string as number 0\n");
7743 value = strtoll(CS s, CSS &endptr, 10);
7747 msg = US"integer expected but \"%s\" found";
7749 else if (value < 0 && isplus)
7751 msg = US"non-negative integer expected but \"%s\" found";
7755 switch (tolower(*endptr))
7760 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7765 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7766 else value *= 1024*1024;
7770 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7771 else value *= 1024*1024*1024;
7775 if (errno == ERANGE)
7776 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7779 while (isspace(*endptr)) endptr++;
7780 if (*endptr == 0) return value;
7784 expand_string_message = string_sprintf(CS msg, s);
7789 /* These values are usually fixed boolean values, but they are permitted to be
7793 addr address being routed
7794 mtype the module type
7795 mname the module name
7796 dbg_opt debug selectors
7797 oname the option name
7798 bvalue the router's boolean value
7799 svalue the router's string value
7800 rvalue where to put the returned value
7802 Returns: OK value placed in rvalue
7803 DEFER expansion failed
7807 exp_bool(address_item *addr,
7808 uschar *mtype, uschar *mname, unsigned dbg_opt,
7809 uschar *oname, BOOL bvalue,
7810 uschar *svalue, BOOL *rvalue)
7813 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7815 expanded = expand_string(svalue);
7816 if (expanded == NULL)
7818 if (expand_string_forcedfail)
7820 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7824 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7825 oname, mname, mtype, expand_string_message);
7826 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7830 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7833 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7835 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7839 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7840 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7849 /* Avoid potentially exposing a password in a string about to be logged */
7852 expand_hide_passwords(uschar * s)
7854 return ( ( Ustrstr(s, "failed to expand") != NULL
7855 || Ustrstr(s, "expansion of ") != NULL
7857 && ( Ustrstr(s, "mysql") != NULL
7858 || Ustrstr(s, "pgsql") != NULL
7859 || Ustrstr(s, "redis") != NULL
7860 || Ustrstr(s, "sqlite") != NULL
7861 || Ustrstr(s, "ldap:") != NULL
7862 || Ustrstr(s, "ldaps:") != NULL
7863 || Ustrstr(s, "ldapi:") != NULL
7864 || Ustrstr(s, "ldapdn:") != NULL
7865 || Ustrstr(s, "ldapm:") != NULL
7867 ? US"Temporary internal error" : s;
7871 /* Read given named file into big_buffer. Use for keying material etc.
7872 The content will have an ascii NUL appended.
7877 Return: pointer to buffer, or NULL on error.
7881 expand_file_big_buffer(const uschar * filename)
7883 int fd, off = 0, len;
7885 if ((fd = open(CS filename, O_RDONLY)) < 0)
7887 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
7894 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
7897 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
7905 big_buffer[off] = '\0';
7911 /*************************************************
7912 * Error-checking for testsuite *
7913 *************************************************/
7915 uschar * region_start;
7916 uschar * region_end;
7917 const uschar *var_name;
7918 const uschar *var_data;
7922 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
7925 if (var_data >= e->region_start && var_data < e->region_end)
7927 e->var_name = CUS var_name;
7928 e->var_data = CUS var_data;
7933 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
7935 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
7936 .var_name = NULL, .var_data = NULL };
7940 /* check acl_ variables */
7941 tree_walk(acl_var_c, assert_variable_notin, &e);
7942 tree_walk(acl_var_m, assert_variable_notin, &e);
7944 /* check auth<n> variables */
7945 for (i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
7946 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
7948 /* check regex<n> variables */
7949 for (i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
7950 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
7952 /* check known-name variables */
7953 for (v = var_table; v < var_table + var_table_size; v++)
7954 if (v->type == vtype_stringptr)
7955 assert_variable_notin(US v->name, *(USS v->value), &e);
7957 /* check dns and address trees */
7958 tree_walk(tree_dns_fails, assert_variable_notin, &e);
7959 tree_walk(tree_duplicates, assert_variable_notin, &e);
7960 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
7961 tree_walk(tree_unusable, assert_variable_notin, &e);
7964 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
7965 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
7966 e.var_name, filename, linenumber, e.var_data);
7971 /*************************************************
7972 **************************************************
7973 * Stand-alone test program *
7974 **************************************************
7975 *************************************************/
7981 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7983 int ovector[3*(EXPAND_MAXN+1)];
7984 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7985 ovector, nelem(ovector));
7986 BOOL yield = n >= 0;
7987 if (n == 0) n = EXPAND_MAXN + 1;
7991 expand_nmax = (setup < 0)? 0 : setup + 1;
7992 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7994 expand_nstring[expand_nmax] = subject + ovector[nn];
7995 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
8003 int main(int argc, uschar **argv)
8006 uschar buffer[1024];
8008 debug_selector = D_v;
8009 debug_file = stderr;
8010 debug_fd = fileno(debug_file);
8011 big_buffer = malloc(big_buffer_size);
8013 for (i = 1; i < argc; i++)
8015 if (argv[i][0] == '+')
8017 debug_trace_memory = 2;
8020 if (isdigit(argv[i][0]))
8021 debug_selector = Ustrtol(argv[i], NULL, 0);
8023 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8027 eldap_default_servers = argv[i];
8030 mysql_servers = argv[i];
8033 pgsql_servers = argv[i];
8036 redis_servers = argv[i];
8040 else opt_perl_startup = argv[i];
8044 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8046 expand_nstring[1] = US"string 1....";
8047 expand_nlength[1] = 8;
8051 if (opt_perl_startup != NULL)
8054 printf("Starting Perl interpreter\n");
8055 errstr = init_perl(opt_perl_startup);
8058 printf("** error in perl_startup code: %s\n", errstr);
8059 return EXIT_FAILURE;
8062 #endif /* EXIM_PERL */
8064 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8066 void *reset_point = store_get(0);
8067 uschar *yield = expand_string(buffer);
8070 printf("%s\n", yield);
8071 store_reset(reset_point);
8075 if (search_find_defer) printf("search_find deferred\n");
8076 printf("Failed: %s\n", expand_string_message);
8077 if (expand_string_forcedfail) printf("Forced failure\n");
8091 /* End of expand.c */