1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
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[] = {
164 /* Tables of operator names, and corresponding switch numbers. The names must be
165 in alphabetical order. There are two tables, because underscore is used in some
166 cases to introduce arguments, whereas for other it is part of the name. This is
167 an historical mis-design. */
169 static uschar *op_table_underscore[] = {
172 US"quote_local_part",
177 ,US"utf8_domain_from_alabel",
178 US"utf8_domain_to_alabel",
179 US"utf8_localpart_from_alabel",
180 US"utf8_localpart_to_alabel"
187 EOP_QUOTE_LOCAL_PART,
192 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
193 EOP_UTF8_DOMAIN_TO_ALABEL,
194 EOP_UTF8_LOCALPART_FROM_ALABEL,
195 EOP_UTF8_LOCALPART_TO_ALABEL
199 static uschar *op_table_main[] = {
246 EOP_ADDRESS = nelem(op_table_underscore),
292 /* Table of condition names, and corresponding switch numbers. The names must
293 be in alphabetical order. */
295 static uschar *cond_table[] = {
299 US"==", /* Backward compatibility */
332 US"match_local_part",
357 ECOND_FIRST_DELIVERY,
378 ECOND_MATCH_LOCAL_PART,
388 /* Types of table entry */
391 vtype_int, /* value is address of int */
392 vtype_filter_int, /* ditto, but recognized only when filtering */
393 vtype_ino, /* value is address of ino_t (not always an int) */
394 vtype_uid, /* value is address of uid_t (not always an int) */
395 vtype_gid, /* value is address of gid_t (not always an int) */
396 vtype_bool, /* value is address of bool */
397 vtype_stringptr, /* value is address of pointer to string */
398 vtype_msgbody, /* as stringptr, but read when first required */
399 vtype_msgbody_end, /* ditto, the end of the message */
400 vtype_msgheaders, /* the message's headers, processed */
401 vtype_msgheaders_raw, /* the message's headers, unprocessed */
402 vtype_localpart, /* extract local part from string */
403 vtype_domain, /* extract domain from string */
404 vtype_string_func, /* value is string returned by given function */
405 vtype_todbsdin, /* value not used; generate BSD inbox tod */
406 vtype_tode, /* value not used; generate tod in epoch format */
407 vtype_todel, /* value not used; generate tod in epoch/usec format */
408 vtype_todf, /* value not used; generate full tod */
409 vtype_todl, /* value not used; generate log tod */
410 vtype_todlf, /* value not used; generate log file datestamp tod */
411 vtype_todzone, /* value not used; generate time zone only */
412 vtype_todzulu, /* value not used; generate zulu tod */
413 vtype_reply, /* value not used; get reply from headers */
414 vtype_pid, /* value not used; result is pid */
415 vtype_host_lookup, /* value not used; get host name */
416 vtype_load_avg, /* value not used; result is int from os_getloadavg */
417 vtype_pspace, /* partition space; value is T/F for spool/log */
418 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
419 vtype_cert /* SSL certificate */
421 ,vtype_dkim /* Lookup of value in DKIM signature */
425 /* Type for main variable table */
433 /* Type for entries pointing to address/length pairs. Not currently
441 static uschar * fn_recipients(void);
443 /* This table must be kept in alphabetical order. */
445 static var_entry var_table[] = {
446 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
447 they will be confused with user-creatable ACL variables. */
448 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
449 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
450 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
451 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
452 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
453 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
454 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
455 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
456 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
457 { "acl_narg", vtype_int, &acl_narg },
458 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
459 { "address_data", vtype_stringptr, &deliver_address_data },
460 { "address_file", vtype_stringptr, &address_file },
461 { "address_pipe", vtype_stringptr, &address_pipe },
462 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
463 { "authenticated_id", vtype_stringptr, &authenticated_id },
464 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
465 { "authentication_failed",vtype_int, &authentication_failed },
466 #ifdef WITH_CONTENT_SCAN
467 { "av_failed", vtype_int, &av_failed },
469 #ifdef EXPERIMENTAL_BRIGHTMAIL
470 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
471 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
472 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
473 { "bmi_deliver", vtype_int, &bmi_deliver },
475 { "body_linecount", vtype_int, &body_linecount },
476 { "body_zerocount", vtype_int, &body_zerocount },
477 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
478 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
479 { "caller_gid", vtype_gid, &real_gid },
480 { "caller_uid", vtype_uid, &real_uid },
481 { "callout_address", vtype_stringptr, &callout_address },
482 { "compile_date", vtype_stringptr, &version_date },
483 { "compile_number", vtype_stringptr, &version_cnumber },
484 { "config_dir", vtype_stringptr, &config_main_directory },
485 { "config_file", vtype_stringptr, &config_main_filename },
486 { "csa_status", vtype_stringptr, &csa_status },
487 #ifdef EXPERIMENTAL_DCC
488 { "dcc_header", vtype_stringptr, &dcc_header },
489 { "dcc_result", vtype_stringptr, &dcc_result },
492 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
493 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
494 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
495 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
496 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
497 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
498 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
499 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
500 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
501 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
502 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
503 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
504 { "dkim_key_length", vtype_int, &dkim_key_length },
505 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
506 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
507 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
508 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
509 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
510 { "dkim_signers", vtype_stringptr, &dkim_signers },
511 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
512 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
514 #ifdef EXPERIMENTAL_DMARC
515 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
516 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
517 { "dmarc_status", vtype_stringptr, &dmarc_status },
518 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
519 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
521 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
522 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
523 { "dnslist_text", vtype_stringptr, &dnslist_text },
524 { "dnslist_value", vtype_stringptr, &dnslist_value },
525 { "domain", vtype_stringptr, &deliver_domain },
526 { "domain_data", vtype_stringptr, &deliver_domain_data },
527 #ifndef DISABLE_EVENT
528 { "event_data", vtype_stringptr, &event_data },
530 /*XXX want to use generic vars for as many of these as possible*/
531 { "event_defer_errno", vtype_int, &event_defer_errno },
533 { "event_name", vtype_stringptr, &event_name },
535 { "exim_gid", vtype_gid, &exim_gid },
536 { "exim_path", vtype_stringptr, &exim_path },
537 { "exim_uid", vtype_uid, &exim_uid },
538 { "exim_version", vtype_stringptr, &version_string },
539 { "headers_added", vtype_string_func, &fn_hdrs_added },
540 { "home", vtype_stringptr, &deliver_home },
541 { "host", vtype_stringptr, &deliver_host },
542 { "host_address", vtype_stringptr, &deliver_host_address },
543 { "host_data", vtype_stringptr, &host_data },
544 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
545 { "host_lookup_failed", vtype_int, &host_lookup_failed },
546 { "host_port", vtype_int, &deliver_host_port },
547 { "initial_cwd", vtype_stringptr, &initial_cwd },
548 { "inode", vtype_ino, &deliver_inode },
549 { "interface_address", vtype_stringptr, &interface_address },
550 { "interface_port", vtype_int, &interface_port },
551 { "item", vtype_stringptr, &iterate_item },
553 { "ldap_dn", vtype_stringptr, &eldap_dn },
555 { "load_average", vtype_load_avg, NULL },
556 { "local_part", vtype_stringptr, &deliver_localpart },
557 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
558 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
559 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
560 { "local_scan_data", vtype_stringptr, &local_scan_data },
561 { "local_user_gid", vtype_gid, &local_user_gid },
562 { "local_user_uid", vtype_uid, &local_user_uid },
563 { "localhost_number", vtype_int, &host_number },
564 { "log_inodes", vtype_pinodes, (void *)FALSE },
565 { "log_space", vtype_pspace, (void *)FALSE },
566 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
567 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
568 #ifdef WITH_CONTENT_SCAN
569 { "malware_name", vtype_stringptr, &malware_name },
571 { "max_received_linelength", vtype_int, &max_received_linelength },
572 { "message_age", vtype_int, &message_age },
573 { "message_body", vtype_msgbody, &message_body },
574 { "message_body_end", vtype_msgbody_end, &message_body_end },
575 { "message_body_size", vtype_int, &message_body_size },
576 { "message_exim_id", vtype_stringptr, &message_id },
577 { "message_headers", vtype_msgheaders, NULL },
578 { "message_headers_raw", vtype_msgheaders_raw, NULL },
579 { "message_id", vtype_stringptr, &message_id },
580 { "message_linecount", vtype_int, &message_linecount },
581 { "message_size", vtype_int, &message_size },
583 { "message_smtputf8", vtype_bool, &message_smtputf8 },
585 #ifdef WITH_CONTENT_SCAN
586 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
587 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
588 { "mime_boundary", vtype_stringptr, &mime_boundary },
589 { "mime_charset", vtype_stringptr, &mime_charset },
590 { "mime_content_description", vtype_stringptr, &mime_content_description },
591 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
592 { "mime_content_id", vtype_stringptr, &mime_content_id },
593 { "mime_content_size", vtype_int, &mime_content_size },
594 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
595 { "mime_content_type", vtype_stringptr, &mime_content_type },
596 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
597 { "mime_filename", vtype_stringptr, &mime_filename },
598 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
599 { "mime_is_multipart", vtype_int, &mime_is_multipart },
600 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
601 { "mime_part_count", vtype_int, &mime_part_count },
603 { "n0", vtype_filter_int, &filter_n[0] },
604 { "n1", vtype_filter_int, &filter_n[1] },
605 { "n2", vtype_filter_int, &filter_n[2] },
606 { "n3", vtype_filter_int, &filter_n[3] },
607 { "n4", vtype_filter_int, &filter_n[4] },
608 { "n5", vtype_filter_int, &filter_n[5] },
609 { "n6", vtype_filter_int, &filter_n[6] },
610 { "n7", vtype_filter_int, &filter_n[7] },
611 { "n8", vtype_filter_int, &filter_n[8] },
612 { "n9", vtype_filter_int, &filter_n[9] },
613 { "original_domain", vtype_stringptr, &deliver_domain_orig },
614 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
615 { "originator_gid", vtype_gid, &originator_gid },
616 { "originator_uid", vtype_uid, &originator_uid },
617 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
618 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
619 { "pid", vtype_pid, NULL },
621 { "prdr_requested", vtype_bool, &prdr_requested },
623 { "primary_hostname", vtype_stringptr, &primary_hostname },
624 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
625 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
626 { "proxy_external_port", vtype_int, &proxy_external_port },
627 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
628 { "proxy_local_port", vtype_int, &proxy_local_port },
629 { "proxy_session", vtype_bool, &proxy_session },
631 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
632 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
633 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
634 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
635 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
636 { "queue_name", vtype_stringptr, &queue_name },
637 { "rcpt_count", vtype_int, &rcpt_count },
638 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
639 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
640 { "received_count", vtype_int, &received_count },
641 { "received_for", vtype_stringptr, &received_for },
642 { "received_ip_address", vtype_stringptr, &interface_address },
643 { "received_port", vtype_int, &interface_port },
644 { "received_protocol", vtype_stringptr, &received_protocol },
645 { "received_time", vtype_int, &received_time.tv_sec },
646 { "recipient_data", vtype_stringptr, &recipient_data },
647 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
648 { "recipients", vtype_string_func, &fn_recipients },
649 { "recipients_count", vtype_int, &recipients_count },
650 #ifdef WITH_CONTENT_SCAN
651 { "regex_match_string", vtype_stringptr, ®ex_match_string },
653 { "reply_address", vtype_reply, NULL },
654 { "return_path", vtype_stringptr, &return_path },
655 { "return_size_limit", vtype_int, &bounce_return_size_limit },
656 { "router_name", vtype_stringptr, &router_name },
657 { "runrc", vtype_int, &runrc },
658 { "self_hostname", vtype_stringptr, &self_hostname },
659 { "sender_address", vtype_stringptr, &sender_address },
660 { "sender_address_data", vtype_stringptr, &sender_address_data },
661 { "sender_address_domain", vtype_domain, &sender_address },
662 { "sender_address_local_part", vtype_localpart, &sender_address },
663 { "sender_data", vtype_stringptr, &sender_data },
664 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
665 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
666 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
667 { "sender_host_address", vtype_stringptr, &sender_host_address },
668 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
669 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
670 { "sender_host_name", vtype_host_lookup, NULL },
671 { "sender_host_port", vtype_int, &sender_host_port },
672 { "sender_ident", vtype_stringptr, &sender_ident },
673 { "sender_rate", vtype_stringptr, &sender_rate },
674 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
675 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
676 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
677 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
678 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
679 { "sending_port", vtype_int, &sending_port },
680 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
681 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
682 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
683 { "smtp_command_history", vtype_string_func, &smtp_cmd_hist },
684 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
685 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
686 { "sn0", vtype_filter_int, &filter_sn[0] },
687 { "sn1", vtype_filter_int, &filter_sn[1] },
688 { "sn2", vtype_filter_int, &filter_sn[2] },
689 { "sn3", vtype_filter_int, &filter_sn[3] },
690 { "sn4", vtype_filter_int, &filter_sn[4] },
691 { "sn5", vtype_filter_int, &filter_sn[5] },
692 { "sn6", vtype_filter_int, &filter_sn[6] },
693 { "sn7", vtype_filter_int, &filter_sn[7] },
694 { "sn8", vtype_filter_int, &filter_sn[8] },
695 { "sn9", vtype_filter_int, &filter_sn[9] },
696 #ifdef WITH_CONTENT_SCAN
697 { "spam_action", vtype_stringptr, &spam_action },
698 { "spam_bar", vtype_stringptr, &spam_bar },
699 { "spam_report", vtype_stringptr, &spam_report },
700 { "spam_score", vtype_stringptr, &spam_score },
701 { "spam_score_int", vtype_stringptr, &spam_score_int },
703 #ifdef EXPERIMENTAL_SPF
704 { "spf_guess", vtype_stringptr, &spf_guess },
705 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
706 { "spf_received", vtype_stringptr, &spf_received },
707 { "spf_result", vtype_stringptr, &spf_result },
708 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
710 { "spool_directory", vtype_stringptr, &spool_directory },
711 { "spool_inodes", vtype_pinodes, (void *)TRUE },
712 { "spool_space", vtype_pspace, (void *)TRUE },
713 #ifdef EXPERIMENTAL_SRS
714 { "srs_db_address", vtype_stringptr, &srs_db_address },
715 { "srs_db_key", vtype_stringptr, &srs_db_key },
716 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
717 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
718 { "srs_recipient", vtype_stringptr, &srs_recipient },
719 { "srs_status", vtype_stringptr, &srs_status },
721 { "thisaddress", vtype_stringptr, &filter_thisaddress },
723 /* The non-(in,out) variables are now deprecated */
724 { "tls_bits", vtype_int, &tls_in.bits },
725 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
726 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
728 { "tls_in_bits", vtype_int, &tls_in.bits },
729 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
730 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
731 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
732 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
733 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
734 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
735 #if defined(SUPPORT_TLS)
736 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
738 { "tls_out_bits", vtype_int, &tls_out.bits },
739 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
740 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
741 #ifdef EXPERIMENTAL_DANE
742 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
744 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
745 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
746 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
747 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
748 #if defined(SUPPORT_TLS)
749 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
751 #ifdef EXPERIMENTAL_DANE
752 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
755 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
756 #if defined(SUPPORT_TLS)
757 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
760 { "tod_bsdinbox", vtype_todbsdin, NULL },
761 { "tod_epoch", vtype_tode, NULL },
762 { "tod_epoch_l", vtype_todel, NULL },
763 { "tod_full", vtype_todf, NULL },
764 { "tod_log", vtype_todl, NULL },
765 { "tod_logfile", vtype_todlf, NULL },
766 { "tod_zone", vtype_todzone, NULL },
767 { "tod_zulu", vtype_todzulu, NULL },
768 { "transport_name", vtype_stringptr, &transport_name },
769 { "value", vtype_stringptr, &lookup_value },
770 { "verify_mode", vtype_stringptr, &verify_mode },
771 { "version_number", vtype_stringptr, &version_string },
772 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
773 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
774 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
775 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
776 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
777 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
780 static int var_table_size = nelem(var_table);
781 static uschar var_buffer[256];
782 static BOOL malformed_header;
784 /* For textual hashes */
786 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
787 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
790 enum { HMAC_MD5, HMAC_SHA1 };
792 /* For numeric hashes */
794 static unsigned int prime[] = {
795 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
796 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
797 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
799 /* For printing modes in symbolic form */
801 static uschar *mtable_normal[] =
802 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
804 static uschar *mtable_setid[] =
805 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
807 static uschar *mtable_sticky[] =
808 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
812 /*************************************************
813 * Tables for UTF-8 support *
814 *************************************************/
816 /* Table of the number of extra characters, indexed by the first character
817 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
820 static uschar utf8_table1[] = {
821 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
822 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
823 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
824 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
826 /* These are the masks for the data bits in the first byte of a character,
827 indexed by the number of additional bytes. */
829 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
831 /* Get the next UTF-8 character, advancing the pointer. */
833 #define GETUTF8INC(c, ptr) \
835 if ((c & 0xc0) == 0xc0) \
837 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
839 c = (c & utf8_table2[a]) << s; \
843 c |= (*ptr++ & 0x3f) << s; \
849 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
851 /*************************************************
852 * Binary chop search on a table *
853 *************************************************/
855 /* This is used for matching expansion items and operators.
858 name the name that is being sought
859 table the table to search
860 table_size the number of items in the table
862 Returns: the offset in the table, or -1
866 chop_match(uschar *name, uschar **table, int table_size)
868 uschar **bot = table;
869 uschar **top = table + table_size;
873 uschar **mid = bot + (top - bot)/2;
874 int c = Ustrcmp(name, *mid);
875 if (c == 0) return mid - table;
876 if (c > 0) bot = mid + 1; else top = mid;
884 /*************************************************
885 * Check a condition string *
886 *************************************************/
888 /* This function is called to expand a string, and test the result for a "true"
889 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
890 forced fail or lookup defer.
892 We used to release all store used, but this is not not safe due
893 to ${dlfunc } and ${acl }. In any case expand_string_internal()
894 is reasonably careful to release what it can.
896 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
899 condition the condition string
900 m1 text to be incorporated in panic error
903 Returns: TRUE if condition is met, FALSE if not
907 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
910 uschar *ss = expand_string(condition);
913 if (!expand_string_forcedfail && !search_find_defer)
914 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
915 "for %s %s: %s", condition, m1, m2, expand_string_message);
918 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
919 strcmpic(ss, US"false") != 0;
926 /*************************************************
927 * Pseudo-random number generation *
928 *************************************************/
930 /* Pseudo-random number generation. The result is not "expected" to be
931 cryptographically strong but not so weak that someone will shoot themselves
932 in the foot using it as a nonce in some email header scheme or whatever
933 weirdness they'll twist this into. The result should ideally handle fork().
935 However, if we're stuck unable to provide this, then we'll fall back to
936 appallingly bad randomness.
938 If SUPPORT_TLS is defined then this will not be used except as an emergency
943 Returns a random number in range [0, max-1]
947 # define vaguely_random_number vaguely_random_number_fallback
950 vaguely_random_number(int max)
953 # undef vaguely_random_number
955 static pid_t pid = 0;
957 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
967 #ifdef HAVE_ARC4RANDOM
968 /* cryptographically strong randomness, common on *BSD platforms, not
969 so much elsewhere. Alas. */
970 #ifndef NOT_HAVE_ARC4RANDOM_STIR
973 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
974 #ifdef HAVE_SRANDOMDEV
975 /* uses random(4) for seeding */
978 gettimeofday(&tv, NULL);
979 srandom(tv.tv_sec | tv.tv_usec | getpid());
982 /* Poor randomness and no seeding here */
989 #ifdef HAVE_ARC4RANDOM
990 return arc4random() % max;
991 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
992 return random() % max;
994 /* This one returns a 16-bit number, definitely not crypto-strong */
995 return random_number(max);
1002 /*************************************************
1003 * Pick out a name from a string *
1004 *************************************************/
1006 /* If the name is too long, it is silently truncated.
1009 name points to a buffer into which to put the name
1010 max is the length of the buffer
1011 s points to the first alphabetic character of the name
1012 extras chars other than alphanumerics to permit
1014 Returns: pointer to the first character after the name
1016 Note: The test for *s != 0 in the while loop is necessary because
1017 Ustrchr() yields non-NULL if the character is zero (which is not something
1020 static const uschar *
1021 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1024 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1026 if (ptr < max-1) name[ptr++] = *s;
1035 /*************************************************
1036 * Pick out the rest of a header name *
1037 *************************************************/
1039 /* A variable name starting $header_ (or just $h_ for those who like
1040 abbreviations) might not be the complete header name because headers can
1041 contain any printing characters in their names, except ':'. This function is
1042 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1043 on the end, if the name was terminated by white space.
1046 name points to a buffer in which the name read so far exists
1047 max is the length of the buffer
1048 s points to the first character after the name so far, i.e. the
1049 first non-alphameric character after $header_xxxxx
1051 Returns: a pointer to the first character after the header name
1054 static const uschar *
1055 read_header_name(uschar *name, int max, const uschar *s)
1057 int prelen = Ustrchr(name, '_') - name + 1;
1058 int ptr = Ustrlen(name) - prelen;
1059 if (ptr > 0) memmove(name, name+prelen, ptr);
1060 while (mac_isgraph(*s) && *s != ':')
1062 if (ptr < max-1) name[ptr++] = *s;
1073 /*************************************************
1074 * Pick out a number from a string *
1075 *************************************************/
1078 n points to an integer into which to put the number
1079 s points to the first digit of the number
1081 Returns: a pointer to the character after the last digit
1083 /*XXX consider expanding to int_eximarith_t. But the test for
1084 "overbig numbers" in 0002 still needs to overflow it. */
1087 read_number(int *n, uschar *s)
1090 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1094 static const uschar *
1095 read_cnumber(int *n, const uschar *s)
1098 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1104 /*************************************************
1105 * Extract keyed subfield from a string *
1106 *************************************************/
1108 /* The yield is in dynamic store; NULL means that the key was not found.
1111 key points to the name of the key
1112 s points to the string from which to extract the subfield
1114 Returns: NULL if the subfield was not found, or
1115 a pointer to the subfield's data
1119 expand_getkeyed(uschar *key, const uschar *s)
1121 int length = Ustrlen(key);
1122 while (isspace(*s)) s++;
1124 /* Loop to search for the key */
1130 const uschar *dkey = s;
1132 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1133 dkeylength = s - dkey;
1134 while (isspace(*s)) s++;
1135 if (*s == '=') while (isspace((*(++s))));
1137 data = string_dequote(&s);
1138 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1141 while (isspace(*s)) s++;
1150 find_var_ent(uschar * name)
1153 int last = var_table_size;
1155 while (last > first)
1157 int middle = (first + last)/2;
1158 int c = Ustrcmp(name, var_table[middle].name);
1160 if (c > 0) { first = middle + 1; continue; }
1161 if (c < 0) { last = middle; continue; }
1162 return &var_table[middle];
1167 /*************************************************
1168 * Extract numbered subfield from string *
1169 *************************************************/
1171 /* Extracts a numbered field from a string that is divided by tokens - for
1172 example a line from /etc/passwd is divided by colon characters. First field is
1173 numbered one. Negative arguments count from the right. Zero returns the whole
1174 string. Returns NULL if there are insufficient tokens in the string
1177 Modifies final argument - this is a dynamically generated string, so that's OK.
1180 field number of field to be extracted,
1181 first field = 1, whole string = 0, last field = -1
1182 separators characters that are used to break string into tokens
1183 s points to the string from which to extract the subfield
1185 Returns: NULL if the field was not found,
1186 a pointer to the field's data inside s (modified to add 0)
1190 expand_gettokened (int field, uschar *separators, uschar *s)
1195 uschar *fieldtext = NULL;
1197 if (field == 0) return s;
1199 /* Break the line up into fields in place; for field > 0 we stop when we have
1200 done the number of fields we want. For field < 0 we continue till the end of
1201 the string, counting the number of fields. */
1203 count = (field > 0)? field : INT_MAX;
1209 /* Previous field was the last one in the string. For a positive field
1210 number, this means there are not enough fields. For a negative field number,
1211 check that there are enough, and scan back to find the one that is wanted. */
1215 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1216 if ((-field) == (INT_MAX - count - 1)) return s;
1220 while (ss[-1] != 0) ss--;
1226 /* Previous field was not last in the string; save its start and put a
1230 len = Ustrcspn(ss, separators);
1241 expand_getlistele(int field, const uschar * list)
1243 const uschar * tlist= list;
1249 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1252 if(field==0) return NULL;
1253 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1254 return string_nextinlist(&list, &sep, NULL, 0);
1258 /* Certificate fields, by name. Worry about by-OID later */
1259 /* Names are chosen to not have common prefixes */
1266 uschar * (*getfn)(void * cert, uschar * mod);
1268 static certfield certfields[] =
1269 { /* linear search; no special order */
1270 { US"version", 7, &tls_cert_version },
1271 { US"serial_number", 13, &tls_cert_serial_number },
1272 { US"subject", 7, &tls_cert_subject },
1273 { US"notbefore", 9, &tls_cert_not_before },
1274 { US"notafter", 8, &tls_cert_not_after },
1275 { US"issuer", 6, &tls_cert_issuer },
1276 { US"signature", 9, &tls_cert_signature },
1277 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1278 { US"subj_altname", 12, &tls_cert_subject_altname },
1279 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1280 { US"crl_uri", 7, &tls_cert_crl_uri },
1284 expand_getcertele(uschar * field, uschar * certvar)
1289 if (!(vp = find_var_ent(certvar)))
1291 expand_string_message =
1292 string_sprintf("no variable named \"%s\"", certvar);
1293 return NULL; /* Unknown variable name */
1295 /* NB this stops us passing certs around in variable. Might
1296 want to do that in future */
1297 if (vp->type != vtype_cert)
1299 expand_string_message =
1300 string_sprintf("\"%s\" is not a certificate", certvar);
1301 return NULL; /* Unknown variable name */
1303 if (!*(void **)vp->value)
1306 if (*field >= '0' && *field <= '9')
1307 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1309 for(cp = certfields;
1310 cp < certfields + nelem(certfields);
1312 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1314 uschar * modifier = *(field += cp->namelen) == ','
1316 return (*cp->getfn)( *(void **)vp->value, modifier );
1319 expand_string_message =
1320 string_sprintf("bad field selector \"%s\" for certextract", field);
1323 #endif /*SUPPORT_TLS*/
1325 /*************************************************
1326 * Extract a substring from a string *
1327 *************************************************/
1329 /* Perform the ${substr or ${length expansion operations.
1332 subject the input string
1333 value1 the offset from the start of the input string to the start of
1334 the output string; if negative, count from the right.
1335 value2 the length of the output string, or negative (-1) for unset
1336 if value1 is positive, unset means "all after"
1337 if value1 is negative, unset means "all before"
1338 len set to the length of the returned string
1340 Returns: pointer to the output string, or NULL if there is an error
1344 extract_substr(uschar *subject, int value1, int value2, int *len)
1346 int sublen = Ustrlen(subject);
1348 if (value1 < 0) /* count from right */
1352 /* If the position is before the start, skip to the start, and adjust the
1353 length. If the length ends up negative, the substring is null because nothing
1354 can precede. This falls out naturally when the length is unset, meaning "all
1360 if (value2 < 0) value2 = 0;
1364 /* Otherwise an unset length => characters before value1 */
1366 else if (value2 < 0)
1373 /* For a non-negative offset, if the starting position is past the end of the
1374 string, the result will be the null string. Otherwise, an unset length means
1375 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1379 if (value1 > sublen)
1384 else if (value2 < 0) value2 = sublen;
1387 /* Cut the length down to the maximum possible for the offset value, and get
1388 the required characters. */
1390 if (value1 + value2 > sublen) value2 = sublen - value1;
1392 return subject + value1;
1398 /*************************************************
1399 * Old-style hash of a string *
1400 *************************************************/
1402 /* Perform the ${hash expansion operation.
1405 subject the input string (an expanded substring)
1406 value1 the length of the output string; if greater or equal to the
1407 length of the input string, the input string is returned
1408 value2 the number of hash characters to use, or 26 if negative
1409 len set to the length of the returned string
1411 Returns: pointer to the output string, or NULL if there is an error
1415 compute_hash(uschar *subject, int value1, int value2, int *len)
1417 int sublen = Ustrlen(subject);
1419 if (value2 < 0) value2 = 26;
1420 else if (value2 > Ustrlen(hashcodes))
1422 expand_string_message =
1423 string_sprintf("hash count \"%d\" too big", value2);
1427 /* Calculate the hash text. We know it is shorter than the original string, so
1428 can safely place it in subject[] (we know that subject is always itself an
1429 expanded substring). */
1431 if (value1 < sublen)
1436 while ((c = (subject[j])) != 0)
1438 int shift = (c + j++) & 7;
1439 subject[i] ^= (c << shift) | (c >> (8-shift));
1440 if (++i >= value1) i = 0;
1442 for (i = 0; i < value1; i++)
1443 subject[i] = hashcodes[(subject[i]) % value2];
1445 else value1 = sublen;
1454 /*************************************************
1455 * Numeric hash of a string *
1456 *************************************************/
1458 /* Perform the ${nhash expansion operation. The first characters of the
1459 string are treated as most important, and get the highest prime numbers.
1462 subject the input string
1463 value1 the maximum value of the first part of the result
1464 value2 the maximum value of the second part of the result,
1465 or negative to produce only a one-part result
1466 len set to the length of the returned string
1468 Returns: pointer to the output string, or NULL if there is an error.
1472 compute_nhash (uschar *subject, int value1, int value2, int *len)
1474 uschar *s = subject;
1476 unsigned long int total = 0; /* no overflow */
1480 if (i == 0) i = nelem(prime) - 1;
1481 total += prime[i--] * (unsigned int)(*s++);
1484 /* If value2 is unset, just compute one number */
1487 s = string_sprintf("%d", total % value1);
1489 /* Otherwise do a div/mod hash */
1493 total = total % (value1 * value2);
1494 s = string_sprintf("%d/%d", total/value2, total % value2);
1505 /*************************************************
1506 * Find the value of a header or headers *
1507 *************************************************/
1509 /* Multiple instances of the same header get concatenated, and this function
1510 can also return a concatenation of all the header lines. When concatenating
1511 specific headers that contain lists of addresses, a comma is inserted between
1512 them. Otherwise we use a straight concatenation. Because some messages can have
1513 pathologically large number of lines, there is a limit on the length that is
1514 returned. Also, to avoid massive store use which would result from using
1515 string_cat() as it copies and extends strings, we do a preliminary pass to find
1516 out exactly how much store will be needed. On "normal" messages this will be
1520 name the name of the header, without the leading $header_ or $h_,
1521 or NULL if a concatenation of all headers is required
1522 exists_only TRUE if called from a def: test; don't need to build a string;
1523 just return a string that is not "" and not "0" if the header
1525 newsize return the size of memory block that was obtained; may be NULL
1526 if exists_only is TRUE
1527 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1528 other than concatenating, will be done on the header. Also used
1529 for $message_headers_raw.
1530 charset name of charset to translate MIME words to; used only if
1531 want_raw is false; if NULL, no translation is done (this is
1532 used for $bh_ and $bheader_)
1534 Returns: NULL if the header does not exist, else a pointer to a new
1539 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1542 BOOL found = name == NULL;
1544 int len = found? 0 : Ustrlen(name);
1546 uschar *yield = NULL;
1549 /* Loop for two passes - saves code repetition */
1551 for (i = 0; i < 2; i++)
1556 for (h = header_list; size < header_insert_maxlen && h; h = h->next)
1557 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */
1558 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1563 if (exists_only) return US"1"; /* don't need actual string */
1565 t = h->text + len; /* text to insert */
1566 if (!want_raw) /* unless wanted raw, */
1567 while (isspace(*t)) t++; /* remove leading white space */
1568 ilen = h->slen - (t - h->text); /* length to insert */
1570 /* Unless wanted raw, remove trailing whitespace, including the
1574 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1576 /* Set comma = 1 if handling a single header and it's one of those
1577 that contains an address list, except when asked for raw headers. Only
1578 need to do this once. */
1580 if (!want_raw && name && comma == 0 &&
1581 Ustrchr("BCFRST", h->type) != NULL)
1584 /* First pass - compute total store needed; second pass - compute
1585 total store used, including this header. */
1587 size += ilen + comma + 1; /* +1 for the newline */
1589 /* Second pass - concatenate the data, up to a maximum. Note that
1590 the loop stops when size hits the limit. */
1594 if (size > header_insert_maxlen)
1596 ilen -= size - header_insert_maxlen - 1;
1599 Ustrncpy(ptr, t, ilen);
1602 /* For a non-raw header, put in the comma if needed, then add
1603 back the newline we removed above, provided there was some text in
1606 if (!want_raw && ilen > 0)
1608 if (comma != 0) *ptr++ = ',';
1614 /* At end of first pass, return NULL if no header found. Then truncate size
1615 if necessary, and get the buffer to hold the data, returning the buffer size.
1620 if (!found) return NULL;
1621 if (size > header_insert_maxlen) size = header_insert_maxlen;
1622 *newsize = size + 1;
1623 ptr = yield = store_get(*newsize);
1627 /* That's all we do for raw header expansion. */
1632 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1633 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1634 function can return an error with decoded data if the charset translation
1635 fails. If decoding fails, it returns NULL. */
1639 uschar *decoded, *error;
1640 if (ptr > yield && ptr[-1] == '\n') ptr--;
1641 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1643 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1647 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1648 " input was: %s\n", error, yield);
1650 if (decoded != NULL) yield = decoded;
1659 /*************************************************
1660 * Return list of recipients *
1661 *************************************************/
1662 /* A recipients list is available only during system message filtering,
1663 during ACL processing after DATA, and while expanding pipe commands
1664 generated from a system filter, but not elsewhere. */
1669 if (!enable_dollar_recipients) return NULL; else
1674 uschar * s = store_get(size);
1675 for (i = 0; i < recipients_count; i++)
1677 if (i != 0) s = string_catn(s, &size, &ptr, US", ", 2);
1678 s = string_cat(s, &size, &ptr, recipients_list[i].address);
1680 s[ptr] = 0; /* string_cat() leaves room */
1686 /*************************************************
1687 * Find value of a variable *
1688 *************************************************/
1690 /* The table of variables is kept in alphabetic order, so we can search it
1691 using a binary chop. The "choplen" variable is nothing to do with the binary
1695 name the name of the variable being sought
1696 exists_only TRUE if this is a def: test; passed on to find_header()
1697 skipping TRUE => skip any processing evaluation; this is not the same as
1698 exists_only because def: may test for values that are first
1700 newsize pointer to an int which is initially zero; if the answer is in
1701 a new memory buffer, *newsize is set to its size
1703 Returns: NULL if the variable does not exist, or
1704 a pointer to the variable's contents, or
1705 something non-NULL if exists_only is TRUE
1709 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1716 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1717 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1718 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1719 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1720 (this gave backwards compatibility at the changeover). There may be built-in
1721 variables whose names start acl_ but they should never start in this way. This
1722 slightly messy specification is a consequence of the history, needless to say.
1724 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1725 set, in which case give an error. */
1727 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1731 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1732 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1735 /* Handle $auth<n> variables. */
1737 if (Ustrncmp(name, "auth", 4) == 0)
1740 int n = Ustrtoul(name + 4, &endptr, 10);
1741 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1742 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1744 else if (Ustrncmp(name, "regex", 5) == 0)
1747 int n = Ustrtoul(name + 5, &endptr, 10);
1748 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1749 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1752 /* For all other variables, search the table */
1754 if (!(vp = find_var_ent(name)))
1755 return NULL; /* Unknown variable name */
1757 /* Found an existing variable. If in skipping state, the value isn't needed,
1758 and we want to avoid processing (such as looking up the host name). */
1766 case vtype_filter_int:
1767 if (!filter_running) return NULL;
1771 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1775 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1779 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1783 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1787 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1790 case vtype_stringptr: /* Pointer to string */
1791 return (s = *((uschar **)(val))) ? s : US"";
1794 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1797 case vtype_load_avg:
1798 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1801 case vtype_host_lookup: /* Lookup if not done so */
1802 if (sender_host_name == NULL && sender_host_address != NULL &&
1803 !host_lookup_failed && host_name_lookup() == OK)
1804 host_build_sender_fullhost();
1805 return (sender_host_name == NULL)? US"" : sender_host_name;
1807 case vtype_localpart: /* Get local part from address */
1808 s = *((uschar **)(val));
1809 if (s == NULL) return US"";
1810 domain = Ustrrchr(s, '@');
1811 if (domain == NULL) return s;
1812 if (domain - s > sizeof(var_buffer) - 1)
1813 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1814 " in string expansion", sizeof(var_buffer));
1815 Ustrncpy(var_buffer, s, domain - s);
1816 var_buffer[domain - s] = 0;
1819 case vtype_domain: /* Get domain from address */
1820 s = *((uschar **)(val));
1821 if (s == NULL) return US"";
1822 domain = Ustrrchr(s, '@');
1823 return (domain == NULL)? US"" : domain + 1;
1825 case vtype_msgheaders:
1826 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1828 case vtype_msgheaders_raw:
1829 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1831 case vtype_msgbody: /* Pointer to msgbody string */
1832 case vtype_msgbody_end: /* Ditto, the end of the msg */
1833 ss = (uschar **)(val);
1834 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1837 off_t start_offset = SPOOL_DATA_START_OFFSET;
1838 int len = message_body_visible;
1839 if (len > message_size) len = message_size;
1840 *ss = body = store_malloc(len+1);
1842 if (vp->type == vtype_msgbody_end)
1844 struct stat statbuf;
1845 if (fstat(deliver_datafile, &statbuf) == 0)
1847 start_offset = statbuf.st_size - len;
1848 if (start_offset < SPOOL_DATA_START_OFFSET)
1849 start_offset = SPOOL_DATA_START_OFFSET;
1852 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1853 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1855 len = read(deliver_datafile, body, len);
1859 if (message_body_newlines) /* Separate loops for efficiency */
1861 { if (body[--len] == 0) body[len] = ' '; }
1864 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1867 return *ss ? *ss : US"";
1869 case vtype_todbsdin: /* BSD inbox time of day */
1870 return tod_stamp(tod_bsdin);
1872 case vtype_tode: /* Unix epoch time of day */
1873 return tod_stamp(tod_epoch);
1875 case vtype_todel: /* Unix epoch/usec time of day */
1876 return tod_stamp(tod_epoch_l);
1878 case vtype_todf: /* Full time of day */
1879 return tod_stamp(tod_full);
1881 case vtype_todl: /* Log format time of day */
1882 return tod_stamp(tod_log_bare); /* (without timezone) */
1884 case vtype_todzone: /* Time zone offset only */
1885 return tod_stamp(tod_zone);
1887 case vtype_todzulu: /* Zulu time */
1888 return tod_stamp(tod_zulu);
1890 case vtype_todlf: /* Log file datestamp tod */
1891 return tod_stamp(tod_log_datestamp_daily);
1893 case vtype_reply: /* Get reply address */
1894 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1896 if (s != NULL) while (isspace(*s)) s++;
1897 if (s == NULL || *s == 0)
1899 *newsize = 0; /* For the *s==0 case */
1900 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1905 while (isspace(*s)) s++;
1906 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1907 while (t > s && isspace(t[-1])) t--;
1910 return (s == NULL)? US"" : s;
1912 case vtype_string_func:
1914 uschar * (*fn)() = val;
1921 sprintf(CS var_buffer, "%d",
1922 receive_statvfs(val == (void *)TRUE, &inodes));
1929 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1930 sprintf(CS var_buffer, "%d", inodes);
1935 return *(void **)val ? US"<cert>" : US"";
1937 #ifndef DISABLE_DKIM
1939 return dkim_exim_expand_query((int)(long)val);
1944 return NULL; /* Unknown variable. Silences static checkers. */
1951 modify_variable(uschar *name, void * value)
1954 if ((vp = find_var_ent(name))) vp->value = value;
1955 return; /* Unknown variable name, fail silently */
1963 /*************************************************
1964 * Read and expand substrings *
1965 *************************************************/
1967 /* This function is called to read and expand argument substrings for various
1968 expansion items. Some have a minimum requirement that is less than the maximum;
1969 in these cases, the first non-present one is set to NULL.
1972 sub points to vector of pointers to set
1973 n maximum number of substrings
1975 sptr points to current string pointer
1976 skipping the skipping flag
1977 check_end if TRUE, check for final '}'
1978 name name of item, for error message
1979 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1982 Returns: 0 OK; string pointer updated
1983 1 curly bracketing error (too few arguments)
1984 2 too many arguments (only if check_end is set); message set
1985 3 other error (expansion failure)
1989 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1990 BOOL check_end, uschar *name, BOOL *resetok)
1993 const uschar *s = *sptr;
1995 while (isspace(*s)) s++;
1996 for (i = 0; i < n; i++)
2002 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2003 "(min is %d)", name, m);
2009 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2011 if (*s++ != '}') return 1;
2012 while (isspace(*s)) s++;
2014 if (check_end && *s++ != '}')
2018 expand_string_message = string_sprintf("Too many arguments for '%s' "
2019 "(max is %d)", name, n);
2022 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2033 /*************************************************
2034 * Elaborate message for bad variable *
2035 *************************************************/
2037 /* For the "unknown variable" message, take a look at the variable's name, and
2038 give additional information about possible ACL variables. The extra information
2039 is added on to expand_string_message.
2041 Argument: the name of the variable
2046 check_variable_error_message(uschar *name)
2048 if (Ustrncmp(name, "acl_", 4) == 0)
2049 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2050 (name[4] == 'c' || name[4] == 'm')?
2052 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2053 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2055 US"user-defined ACL variables must start acl_c or acl_m");
2061 Load args from sub array to globals, and call acl_check().
2062 Sub array will be corrupted on return.
2064 Returns: OK access is granted by an ACCEPT verb
2065 DISCARD access is (apparently) granted by a DISCARD verb
2066 FAIL access is denied
2067 FAIL_DROP access is denied; drop the connection
2068 DEFER can't tell at the moment
2072 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2075 int sav_narg = acl_narg;
2077 uschar * dummy_logmsg;
2078 extern int acl_where;
2080 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2081 for (i = 0; i < nsub && sub[i+1]; i++)
2083 uschar * tmp = acl_arg[i];
2084 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2085 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2090 sub[i+1] = acl_arg[i];
2091 acl_arg[i++] = NULL;
2095 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2097 acl_narg>0 ? acl_arg[0] : US"<none>",
2098 acl_narg>1 ? " +more" : "");
2100 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2102 for (i = 0; i < nsub; i++)
2103 acl_arg[i] = sub[i+1]; /* restore old args */
2104 acl_narg = sav_narg;
2112 /*************************************************
2113 * Read and evaluate a condition *
2114 *************************************************/
2118 s points to the start of the condition text
2119 resetok points to a BOOL which is written false if it is unsafe to
2120 free memory. Certain condition types (acl) may have side-effect
2121 allocation which must be preserved.
2122 yield points to a BOOL to hold the result of the condition test;
2123 if NULL, we are just reading through a condition that is
2124 part of an "or" combination to check syntax, or in a state
2125 where the answer isn't required
2127 Returns: a pointer to the first character after the condition, or
2131 static const uschar *
2132 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2134 BOOL testfor = TRUE;
2135 BOOL tempcond, combined_cond;
2137 BOOL sub2_honour_dollar = TRUE;
2138 int i, rc, cond_type, roffset;
2139 int_eximarith_t num[2];
2140 struct stat statbuf;
2142 const uschar *sub[10];
2145 const uschar *rerror;
2149 while (isspace(*s)) s++;
2150 if (*s == '!') { testfor = !testfor; s++; } else break;
2153 /* Numeric comparisons are symbolic */
2155 if (*s == '=' || *s == '>' || *s == '<')
2167 /* All other conditions are named */
2169 else s = read_name(name, 256, s, US"_");
2171 /* If we haven't read a name, it means some non-alpha character is first. */
2175 expand_string_message = string_sprintf("condition name expected, "
2176 "but found \"%.16s\"", s);
2180 /* Find which condition we are dealing with, and switch on it */
2182 cond_type = chop_match(name, cond_table, nelem(cond_table));
2185 /* def: tests for a non-empty variable, or for the existence of a header. If
2186 yield == NULL we are in a skipping state, and don't care about the answer. */
2191 expand_string_message = US"\":\" expected after \"def\"";
2195 s = read_name(name, 256, s+1, US"_");
2197 /* Test for a header's existence. If the name contains a closing brace
2198 character, this may be a user error where the terminating colon has been
2199 omitted. Set a flag to adjust a subsequent error message in this case. */
2201 if (Ustrncmp(name, "h_", 2) == 0 ||
2202 Ustrncmp(name, "rh_", 3) == 0 ||
2203 Ustrncmp(name, "bh_", 3) == 0 ||
2204 Ustrncmp(name, "header_", 7) == 0 ||
2205 Ustrncmp(name, "rheader_", 8) == 0 ||
2206 Ustrncmp(name, "bheader_", 8) == 0)
2208 s = read_header_name(name, 256, s);
2209 /* {-for-text-editors */
2210 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2211 if (yield != NULL) *yield =
2212 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2215 /* Test for a variable's having a non-empty value. A non-existent variable
2216 causes an expansion failure. */
2220 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2223 expand_string_message = (name[0] == 0)?
2224 string_sprintf("variable name omitted after \"def:\"") :
2225 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2226 check_variable_error_message(name);
2229 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2235 /* first_delivery tests for first delivery attempt */
2237 case ECOND_FIRST_DELIVERY:
2238 if (yield != NULL) *yield = deliver_firsttime == testfor;
2242 /* queue_running tests for any process started by a queue runner */
2244 case ECOND_QUEUE_RUNNING:
2245 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2249 /* exists: tests for file existence
2250 isip: tests for any IP address
2251 isip4: tests for an IPv4 address
2252 isip6: tests for an IPv6 address
2253 pam: does PAM authentication
2254 radius: does RADIUS authentication
2255 ldapauth: does LDAP authentication
2256 pwcheck: does Cyrus SASL pwcheck authentication
2265 case ECOND_LDAPAUTH:
2268 while (isspace(*s)) s++;
2269 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2271 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2272 if (sub[0] == NULL) return NULL;
2273 /* {-for-text-editors */
2274 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2276 if (yield == NULL) return s; /* No need to run the test if skipping */
2281 if ((expand_forbid & RDO_EXISTS) != 0)
2283 expand_string_message = US"File existence tests are not permitted";
2286 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2292 rc = string_is_ip_address(sub[0], NULL);
2293 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2294 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2297 /* Various authentication tests - all optionally compiled */
2301 rc = auth_call_pam(sub[0], &expand_string_message);
2304 goto COND_FAILED_NOT_COMPILED;
2305 #endif /* SUPPORT_PAM */
2308 #ifdef RADIUS_CONFIG_FILE
2309 rc = auth_call_radius(sub[0], &expand_string_message);
2312 goto COND_FAILED_NOT_COMPILED;
2313 #endif /* RADIUS_CONFIG_FILE */
2315 case ECOND_LDAPAUTH:
2318 /* Just to keep the interface the same */
2320 int old_pool = store_pool;
2321 store_pool = POOL_SEARCH;
2322 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2323 &expand_string_message, &do_cache);
2324 store_pool = old_pool;
2328 goto COND_FAILED_NOT_COMPILED;
2329 #endif /* LOOKUP_LDAP */
2332 #ifdef CYRUS_PWCHECK_SOCKET
2333 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2336 goto COND_FAILED_NOT_COMPILED;
2337 #endif /* CYRUS_PWCHECK_SOCKET */
2339 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2340 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2342 if (rc == ERROR || rc == DEFER) return NULL;
2343 *yield = (rc == OK) == testfor;
2349 /* call ACL (in a conditional context). Accept true, deny false.
2350 Defer is a forced-fail. Anything set by message= goes to $value.
2351 Up to ten parameters are used; we use the braces round the name+args
2352 like the saslauthd condition does, to permit a variable number of args.
2353 See also the expansion-item version EITEM_ACL and the traditional
2354 acl modifier ACLC_ACL.
2355 Since the ACL may allocate new global variables, tell our caller to not
2360 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2368 while (isspace(*s)) s++;
2369 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2371 switch(read_subs(sub, nelem(sub), 1,
2372 &s, yield == NULL, TRUE, US"acl", resetok))
2374 case 1: expand_string_message = US"too few arguments or bracketing "
2377 case 3: return NULL;
2382 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2383 switch(eval_acl(sub, nelem(sub), &user_msg))
2388 lookup_value = NULL;
2391 lookup_value = string_cat(NULL, &size, &ptr, user_msg);
2392 lookup_value[ptr] = '\0';
2394 *yield = cond == testfor;
2398 expand_string_forcedfail = TRUE;
2401 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2409 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2411 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2413 However, the last two are optional. That is why the whole set is enclosed
2414 in their own set of braces. */
2416 case ECOND_SASLAUTHD:
2417 #ifndef CYRUS_SASLAUTHD_SOCKET
2418 goto COND_FAILED_NOT_COMPILED;
2422 while (isspace(*s)) s++;
2423 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2424 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2427 case 1: expand_string_message = US"too few arguments or bracketing "
2428 "error for saslauthd";
2430 case 3: return NULL;
2432 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2435 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2436 &expand_string_message);
2437 if (rc == ERROR || rc == DEFER) return NULL;
2438 *yield = (rc == OK) == testfor;
2442 #endif /* CYRUS_SASLAUTHD_SOCKET */
2445 /* symbolic operators for numeric and string comparison, and a number of
2446 other operators, all requiring two arguments.
2448 crypteq: encrypts plaintext and compares against an encrypted text,
2449 using crypt(), crypt16(), MD5 or SHA-1
2450 inlist/inlisti: checks if first argument is in the list of the second
2451 match: does a regular expression match and sets up the numerical
2452 variables if it succeeds
2453 match_address: matches in an address list
2454 match_domain: matches in a domain list
2455 match_ip: matches a host list that is restricted to IP addresses
2456 match_local_part: matches in a local part list
2459 case ECOND_MATCH_ADDRESS:
2460 case ECOND_MATCH_DOMAIN:
2461 case ECOND_MATCH_IP:
2462 case ECOND_MATCH_LOCAL_PART:
2463 #ifndef EXPAND_LISTMATCH_RHS
2464 sub2_honour_dollar = FALSE;
2473 case ECOND_NUM_L: /* Numerical comparisons */
2480 case ECOND_STR_LT: /* String comparisons */
2491 for (i = 0; i < 2; i++)
2493 /* Sometimes, we don't expand substrings; too many insecure configurations
2494 created using match_address{}{} and friends, where the second param
2495 includes information from untrustworthy sources. */
2496 BOOL honour_dollar = TRUE;
2497 if ((i > 0) && !sub2_honour_dollar)
2498 honour_dollar = FALSE;
2500 while (isspace(*s)) s++;
2503 if (i == 0) goto COND_FAILED_CURLY_START;
2504 expand_string_message = string_sprintf("missing 2nd string in {} "
2505 "after \"%s\"", name);
2508 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2509 honour_dollar, resetok);
2510 if (sub[i] == NULL) return NULL;
2511 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2513 /* Convert to numerical if required; we know that the names of all the
2514 conditions that compare numbers do not start with a letter. This just saves
2515 checking for them individually. */
2517 if (!isalpha(name[0]) && yield != NULL)
2522 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2526 num[i] = expanded_string_integer(sub[i], FALSE);
2527 if (expand_string_message != NULL) return NULL;
2531 /* Result not required */
2533 if (yield == NULL) return s;
2535 /* Do an appropriate comparison */
2541 tempcond = (num[0] == num[1]);
2545 tempcond = (num[0] > num[1]);
2549 tempcond = (num[0] >= num[1]);
2553 tempcond = (num[0] < num[1]);
2557 tempcond = (num[0] <= num[1]);
2561 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2565 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2569 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2573 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
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);
2600 case ECOND_MATCH: /* Regular expression match */
2601 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2605 expand_string_message = string_sprintf("regular expression error in "
2606 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2609 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2612 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2613 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2614 goto MATCHED_SOMETHING;
2616 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2617 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2618 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2619 goto MATCHED_SOMETHING;
2621 case ECOND_MATCH_IP: /* Match IP address in a host list */
2622 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2624 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2630 unsigned int *nullcache = NULL;
2631 check_host_block cb;
2633 cb.host_name = US"";
2634 cb.host_address = sub[0];
2636 /* If the host address starts off ::ffff: it is an IPv6 address in
2637 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2640 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2641 cb.host_address + 7 : cb.host_address;
2643 rc = match_check_list(
2644 &sub[1], /* the list */
2645 0, /* separator character */
2646 &hostlist_anchor, /* anchor pointer */
2647 &nullcache, /* cache pointer */
2648 check_host, /* function for testing */
2649 &cb, /* argument for function */
2650 MCL_HOST, /* type of check */
2651 sub[0], /* text for debugging */
2652 NULL); /* where to pass back data */
2654 goto MATCHED_SOMETHING;
2656 case ECOND_MATCH_LOCAL_PART:
2657 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2658 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2673 expand_string_message = string_sprintf("unable to complete match "
2674 "against \"%s\": %s", sub[1], search_error_message);
2680 /* Various "encrypted" comparisons. If the second string starts with
2681 "{" then an encryption type is given. Default to crypt() or crypt16()
2682 (build-time choice). */
2683 /* }-for-text-editors */
2686 #ifndef SUPPORT_CRYPTEQ
2687 goto COND_FAILED_NOT_COMPILED;
2689 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2691 int sublen = Ustrlen(sub[1]+5);
2696 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2698 /* If the length that we are comparing against is 24, the MD5 digest
2699 is expressed as a base64 string. This is the way LDAP does it. However,
2700 some other software uses a straightforward hex representation. We assume
2701 this if the length is 32. Other lengths fail. */
2705 uschar *coded = b64encode(digest, 16);
2706 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2707 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2708 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2710 else if (sublen == 32)
2714 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2716 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2717 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2718 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2722 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2723 "fail\n crypted=%s\n", sub[1]+5);
2728 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2730 int sublen = Ustrlen(sub[1]+6);
2735 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2737 /* If the length that we are comparing against is 28, assume the SHA1
2738 digest is expressed as a base64 string. If the length is 40, assume a
2739 straightforward hex representation. Other lengths fail. */
2743 uschar *coded = b64encode(digest, 20);
2744 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2745 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2746 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2748 else if (sublen == 40)
2752 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2754 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2755 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2756 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2760 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2761 "fail\n crypted=%s\n", sub[1]+6);
2766 else /* {crypt} or {crypt16} and non-{ at start */
2767 /* }-for-text-editors */
2772 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2777 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2782 else if (sub[1][0] == '{') /* }-for-text-editors */
2784 expand_string_message = string_sprintf("unknown encryption mechanism "
2785 "in \"%s\"", sub[1]);
2791 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2792 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2793 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2797 #define XSTR(s) STR(s)
2798 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2799 " subject=%s\n crypted=%s\n",
2800 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2805 /* If the encrypted string contains fewer than two characters (for the
2806 salt), force failure. Otherwise we get false positives: with an empty
2807 string the yield of crypt() is an empty string! */
2810 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2811 else if (errno == EINVAL)
2815 expand_string_message = string_sprintf("crypt error: %s\n",
2816 US strerror(errno));
2821 #endif /* SUPPORT_CRYPTEQ */
2826 const uschar * list = sub[1];
2828 uschar *save_iterate_item = iterate_item;
2829 int (*compare)(const uschar *, const uschar *);
2831 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2834 compare = cond_type == ECOND_INLISTI
2835 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2837 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2838 if (compare(sub[0], iterate_item) == 0)
2843 iterate_item = save_iterate_item;
2846 } /* Switch for comparison conditions */
2848 *yield = tempcond == testfor;
2849 return s; /* End of comparison conditions */
2852 /* and/or: computes logical and/or of several conditions */
2856 subcondptr = (yield == NULL)? NULL : &tempcond;
2857 combined_cond = (cond_type == ECOND_AND);
2859 while (isspace(*s)) s++;
2860 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2864 while (isspace(*s)) s++;
2865 /* {-for-text-editors */
2866 if (*s == '}') break;
2867 if (*s != '{') /* }-for-text-editors */
2869 expand_string_message = string_sprintf("each subcondition "
2870 "inside an \"%s{...}\" condition must be in its own {}", name);
2874 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2876 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2877 expand_string_message, name);
2880 while (isspace(*s)) s++;
2882 /* {-for-text-editors */
2885 /* {-for-text-editors */
2886 expand_string_message = string_sprintf("missing } at end of condition "
2887 "inside \"%s\" group", name);
2893 if (cond_type == ECOND_AND)
2895 combined_cond &= tempcond;
2896 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2897 } /* evaluate any more */
2900 combined_cond |= tempcond;
2901 if (combined_cond) subcondptr = NULL; /* once true, don't */
2902 } /* evaluate any more */
2906 if (yield != NULL) *yield = (combined_cond == testfor);
2910 /* forall/forany: iterates a condition with different values */
2915 const uschar * list;
2917 uschar *save_iterate_item = iterate_item;
2919 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2921 while (isspace(*s)) s++;
2922 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2923 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2924 if (sub[0] == NULL) return NULL;
2925 /* {-for-text-editors */
2926 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2928 while (isspace(*s)) s++;
2929 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2933 /* Call eval_condition once, with result discarded (as if scanning a
2934 "false" part). This allows us to find the end of the condition, because if
2935 the list it empty, we won't actually evaluate the condition for real. */
2937 if (!(s = eval_condition(sub[1], resetok, NULL)))
2939 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2940 expand_string_message, name);
2943 while (isspace(*s)) s++;
2945 /* {-for-text-editors */
2948 /* {-for-text-editors */
2949 expand_string_message = string_sprintf("missing } at end of condition "
2950 "inside \"%s\"", name);
2954 if (yield != NULL) *yield = !testfor;
2956 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2958 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, iterate_item);
2959 if (!eval_condition(sub[1], resetok, &tempcond))
2961 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2962 expand_string_message, name);
2963 iterate_item = save_iterate_item;
2966 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", name,
2967 tempcond? "true":"false");
2969 if (yield != NULL) *yield = (tempcond == testfor);
2970 if (tempcond == (cond_type == ECOND_FORANY)) break;
2973 iterate_item = save_iterate_item;
2978 /* The bool{} expansion condition maps a string to boolean.
2979 The values supported should match those supported by the ACL condition
2980 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2981 of true/false. Note that Router "condition" rules have a different
2982 interpretation, where general data can be used and only a few values
2984 Note that readconf.c boolean matching, for boolean configuration options,
2985 only matches true/yes/false/no.
2986 The bool_lax{} condition matches the Router logic, which is much more
2989 case ECOND_BOOL_LAX:
2995 BOOL boolvalue = FALSE;
2996 while (isspace(*s)) s++;
2997 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2998 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2999 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3001 case 1: expand_string_message = string_sprintf(
3002 "too few arguments or bracketing error for %s",
3006 case 3: return NULL;
3009 while (isspace(*t)) t++;
3013 /* trailing whitespace: seems like a good idea to ignore it too */
3015 while (isspace(*t2)) t2--;
3016 if (t2 != (t + len))
3023 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3024 /* logic for the lax case from expand_check_condition(), which also does
3025 expands, and the logic is both short and stable enough that there should
3026 be no maintenance burden from replicating it. */
3030 ? Ustrspn(t+1, "0123456789") == len-1
3031 : Ustrspn(t, "0123456789") == len)
3033 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3034 /* expand_check_condition only does a literal string "0" check */
3035 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3038 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3040 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3042 else if (cond_type == ECOND_BOOL_LAX)
3046 expand_string_message = string_sprintf("unrecognised boolean "
3050 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3051 boolvalue? "true":"false");
3052 if (yield != NULL) *yield = (boolvalue == testfor);
3056 /* Unknown condition */
3059 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3061 } /* End switch on condition type */
3063 /* Missing braces at start and end of data */
3065 COND_FAILED_CURLY_START:
3066 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3069 COND_FAILED_CURLY_END:
3070 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3074 /* A condition requires code that is not compiled */
3076 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3077 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3078 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3079 COND_FAILED_NOT_COMPILED:
3080 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3089 /*************************************************
3090 * Save numerical variables *
3091 *************************************************/
3093 /* This function is called from items such as "if" that want to preserve and
3094 restore the numbered variables.
3097 save_expand_string points to an array of pointers to set
3098 save_expand_nlength points to an array of ints for the lengths
3100 Returns: the value of expand max to save
3104 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3107 for (i = 0; i <= expand_nmax; i++)
3109 save_expand_nstring[i] = expand_nstring[i];
3110 save_expand_nlength[i] = expand_nlength[i];
3117 /*************************************************
3118 * Restore numerical variables *
3119 *************************************************/
3121 /* This function restored saved values of numerical strings.
3124 save_expand_nmax the number of strings to restore
3125 save_expand_string points to an array of pointers
3126 save_expand_nlength points to an array of ints
3132 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3133 int *save_expand_nlength)
3136 expand_nmax = save_expand_nmax;
3137 for (i = 0; i <= expand_nmax; i++)
3139 expand_nstring[i] = save_expand_nstring[i];
3140 expand_nlength[i] = save_expand_nlength[i];
3148 /*************************************************
3149 * Handle yes/no substrings *
3150 *************************************************/
3152 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3153 alternative substrings that depend on whether or not the condition was true,
3154 or the lookup or extraction succeeded. The substrings always have to be
3155 expanded, to check their syntax, but "skipping" is set when the result is not
3156 needed - this avoids unnecessary nested lookups.
3159 skipping TRUE if we were skipping when this item was reached
3160 yes TRUE if the first string is to be used, else use the second
3161 save_lookup a value to put back into lookup_value before the 2nd expansion
3162 sptr points to the input string pointer
3163 yieldptr points to the output string pointer
3164 sizeptr points to the output string size
3165 ptrptr points to the output string pointer
3166 type "lookup", "if", "extract", "run", "env", "listextract" or
3167 "certextract" for error message
3168 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3171 Returns: 0 OK; lookup_value has been reset to save_lookup
3173 2 expansion failed because of bracketing error
3177 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3178 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3181 const uschar *s = *sptr; /* Local value */
3182 uschar *sub1, *sub2;
3183 const uschar * errwhere;
3185 /* If there are no following strings, we substitute the contents of $value for
3186 lookups and for extractions in the success case. For the ${if item, the string
3187 "true" is substituted. In the fail case, nothing is substituted for all three
3190 while (isspace(*s)) s++;
3195 if (yes && !skipping)
3196 *yieldptr = string_catn(*yieldptr, sizeptr, ptrptr, US"true", 4);
3200 if (yes && lookup_value && !skipping)
3201 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value);
3202 lookup_value = save_lookup;
3208 /* The first following string must be braced. */
3212 errwhere = US"'yes' part did not start with '{'";
3216 /* Expand the first substring. Forced failures are noticed only if we actually
3217 want this string. Set skipping in the call in the fail case (this will always
3218 be the case if we were already skipping). */
3220 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3221 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3222 expand_string_forcedfail = FALSE;
3225 errwhere = US"'yes' part did not end with '}'";
3229 /* If we want the first string, add it to the output */
3232 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1);
3234 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3235 $value to what it was at the start of the item, so that it has this value
3236 during the second string expansion. For the call from "if" or "run" to this
3237 function, save_lookup is set to lookup_value, so that this statement does
3240 lookup_value = save_lookup;
3242 /* There now follows either another substring, or "fail", or nothing. This
3243 time, forced failures are noticed only if we want the second string. We must
3244 set skipping in the nested call if we don't want this string, or if we were
3245 already skipping. */
3247 while (isspace(*s)) s++;
3250 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3251 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3252 expand_string_forcedfail = FALSE;
3255 errwhere = US"'no' part did not start with '{'";
3259 /* If we want the second string, add it to the output */
3262 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2);
3265 /* If there is no second string, but the word "fail" is present when the use of
3266 the second string is wanted, set a flag indicating it was a forced failure
3267 rather than a syntactic error. Swallow the terminating } in case this is nested
3268 inside another lookup or if or extract. */
3273 /* deconst cast ok here as source is s anyway */
3274 s = US read_name(name, sizeof(name), s, US"_");
3275 if (Ustrcmp(name, "fail") == 0)
3277 if (!yes && !skipping)
3279 while (isspace(*s)) s++;
3282 errwhere = US"did not close with '}' after forcedfail";
3285 expand_string_message =
3286 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3287 expand_string_forcedfail = TRUE;
3293 expand_string_message =
3294 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3299 /* All we have to do now is to check on the final closing brace. */
3301 while (isspace(*s)) s++;
3304 errwhere = US"did not close with '}'";
3310 /* Update the input pointer value before returning */
3315 /* Get here if there is a bracketing failure */
3316 expand_string_message = string_sprintf(
3317 "curly-bracket problem in conditional yes/no parsing: %s\n"
3318 " remaining string is '%s'", errwhere, --s);
3323 /* Get here for other failures */
3331 /*************************************************
3332 * Handle MD5 or SHA-1 computation for HMAC *
3333 *************************************************/
3335 /* These are some wrapping functions that enable the HMAC code to be a bit
3336 cleaner. A good compiler will spot the tail recursion.
3339 type HMAC_MD5 or HMAC_SHA1
3340 remaining are as for the cryptographic hash functions
3346 chash_start(int type, void *base)
3348 if (type == HMAC_MD5)
3349 md5_start((md5 *)base);
3351 sha1_start((hctx *)base);
3355 chash_mid(int type, void *base, uschar *string)
3357 if (type == HMAC_MD5)
3358 md5_mid((md5 *)base, string);
3360 sha1_mid((hctx *)base, string);
3364 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3366 if (type == HMAC_MD5)
3367 md5_end((md5 *)base, string, length, digest);
3369 sha1_end((hctx *)base, string, length, digest);
3376 /********************************************************
3377 * prvs: Get last three digits of days since Jan 1, 1970 *
3378 ********************************************************/
3380 /* This is needed to implement the "prvs" BATV reverse
3383 Argument: integer "days" offset to add or substract to
3384 or from the current number of days.
3386 Returns: pointer to string containing the last three
3387 digits of the number of days since Jan 1, 1970,
3388 modified by the offset argument, NULL if there
3389 was an error in the conversion.
3394 prvs_daystamp(int day_offset)
3396 uschar *days = store_get(32); /* Need at least 24 for cases */
3397 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3398 (time(NULL) + day_offset*86400)/86400);
3399 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3404 /********************************************************
3405 * prvs: perform HMAC-SHA1 computation of prvs bits *
3406 ********************************************************/
3408 /* This is needed to implement the "prvs" BATV reverse
3412 address RFC2821 Address to use
3413 key The key to use (must be less than 64 characters
3415 key_num Single-digit key number to use. Defaults to
3418 Returns: pointer to string containing the first three
3419 bytes of the final hash in hex format, NULL if
3420 there was an error in the process.
3424 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3426 uschar *hash_source, *p;
3427 int size = 0,offset = 0,i;
3429 uschar innerhash[20];
3430 uschar finalhash[20];
3431 uschar innerkey[64];
3432 uschar outerkey[64];
3433 uschar *finalhash_hex = store_get(40);
3435 if (key_num == NULL)
3438 if (Ustrlen(key) > 64)
3441 hash_source = string_catn(NULL, &size, &offset, key_num, 1);
3442 hash_source = string_catn(hash_source, &size, &offset, daystamp, 3);
3443 hash_source = string_cat(hash_source, &size, &offset, address);
3444 hash_source[offset] = '\0';
3446 DEBUG(D_expand) debug_printf_indent("prvs: hash source is '%s'\n", hash_source);
3448 memset(innerkey, 0x36, 64);
3449 memset(outerkey, 0x5c, 64);
3451 for (i = 0; i < Ustrlen(key); i++)
3453 innerkey[i] ^= key[i];
3454 outerkey[i] ^= key[i];
3457 chash_start(HMAC_SHA1, &h);
3458 chash_mid(HMAC_SHA1, &h, innerkey);
3459 chash_end(HMAC_SHA1, &h, hash_source, offset, innerhash);
3461 chash_start(HMAC_SHA1, &h);
3462 chash_mid(HMAC_SHA1, &h, outerkey);
3463 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3466 for (i = 0; i < 3; i++)
3468 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3469 *p++ = hex_digits[finalhash[i] & 0x0f];
3473 return finalhash_hex;
3479 /*************************************************
3480 * Join a file onto the output string *
3481 *************************************************/
3483 /* This is used for readfile/readsock and after a run expansion.
3484 It joins the contents of a file onto the output string, globally replacing
3485 newlines with a given string (optionally).
3489 yield pointer to the expandable string
3490 sizep pointer to the current size
3491 ptrp pointer to the current position
3492 eol newline replacement string, or NULL
3494 Returns: new value of string pointer
3498 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3500 uschar buffer[1024];
3502 while (Ufgets(buffer, sizeof(buffer), f))
3504 int len = Ustrlen(buffer);
3505 if (eol && buffer[len-1] == '\n') len--;
3506 yield = string_catn(yield, sizep, ptrp, buffer, len);
3507 if (eol && buffer[len])
3508 yield = string_cat(yield, sizep, ptrp, eol);
3511 if (yield) yield[*ptrp] = 0;
3519 /*************************************************
3520 * Evaluate numeric expression *
3521 *************************************************/
3523 /* This is a set of mutually recursive functions that evaluate an arithmetic
3524 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3525 these functions that is called from elsewhere is eval_expr, whose interface is:
3528 sptr pointer to the pointer to the string - gets updated
3529 decimal TRUE if numbers are to be assumed decimal
3530 error pointer to where to put an error message - must be NULL on input
3531 endket TRUE if ')' must terminate - FALSE for external call
3533 Returns: on success: the value of the expression, with *error still NULL
3534 on failure: an undefined value, with *error = a message
3537 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3540 static int_eximarith_t
3541 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3544 int_eximarith_t x = eval_op_or(&s, decimal, error);
3550 *error = US"expecting closing parenthesis";
3552 while (isspace(*(++s)));
3554 else if (*s != 0) *error = US"expecting operator";
3561 static int_eximarith_t
3562 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3567 while (isspace(*s)) s++;
3572 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3574 switch (tolower(*s))
3577 case 'k': n *= 1024; s++; break;
3578 case 'm': n *= 1024*1024; s++; break;
3579 case 'g': n *= 1024*1024*1024; s++; break;
3581 while (isspace (*s)) s++;
3586 n = eval_expr(&s, decimal, error, 1);
3590 *error = US"expecting number or opening parenthesis";
3598 static int_eximarith_t
3599 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3603 while (isspace(*s)) s++;
3604 if (*s == '+' || *s == '-' || *s == '~')
3607 x = eval_op_unary(&s, decimal, error);
3608 if (op == '-') x = -x;
3609 else if (op == '~') x = ~x;
3613 x = eval_number(&s, decimal, error);
3620 static int_eximarith_t
3621 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3624 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3627 while (*s == '*' || *s == '/' || *s == '%')
3630 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3631 if (*error != NULL) break;
3632 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3633 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3634 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3635 * -N*M is INT_MIN will yield INT_MIN.
3636 * Since we don't support floating point, this is somewhat simpler.
3637 * Ideally, we'd return an error, but since we overflow for all other
3638 * arithmetic, consistency suggests otherwise, but what's the correct value
3639 * to use? There is none.
3640 * The C standard guarantees overflow for unsigned arithmetic but signed
3641 * overflow invokes undefined behaviour; in practice, this is overflow
3642 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3643 * that long/longlong larger than int are available, or we could just work
3644 * with larger types. We should consider whether to guarantee 32bit eval
3645 * and 64-bit working variables, with errors returned. For now ...
3646 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3647 * can just let the other invalid results occur otherwise, as they have
3648 * until now. For this one case, we can coerce.
3650 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3653 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3654 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3664 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3680 static int_eximarith_t
3681 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3684 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3687 while (*s == '+' || *s == '-')
3690 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3692 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3693 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3694 { /* over-conservative check */
3696 ? US"overflow in sum" : US"overflow in difference";
3699 if (op == '+') x += y; else x -= y;
3707 static int_eximarith_t
3708 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3711 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3714 while ((*s == '<' || *s == '>') && s[1] == s[0])
3719 y = eval_op_sum(&s, decimal, error);
3720 if (*error != NULL) break;
3721 if (op == '<') x <<= y; else x >>= y;
3729 static int_eximarith_t
3730 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3733 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3740 y = eval_op_shift(&s, decimal, error);
3741 if (*error != NULL) break;
3750 static int_eximarith_t
3751 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3754 int_eximarith_t x = eval_op_and(&s, decimal, error);
3761 y = eval_op_and(&s, decimal, error);
3762 if (*error != NULL) break;
3771 static int_eximarith_t
3772 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3775 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3782 y = eval_op_xor(&s, decimal, error);
3783 if (*error != NULL) break;
3793 /*************************************************
3795 *************************************************/
3797 /* Returns either an unchanged string, or the expanded string in stacking pool
3798 store. Interpreted sequences are:
3800 \... normal escaping rules
3801 $name substitutes the variable
3803 ${op:string} operates on the expanded string value
3804 ${item{arg1}{arg2}...} expands the args and then does the business
3805 some literal args are not enclosed in {}
3807 There are now far too many operators and item types to make it worth listing
3808 them here in detail any more.
3810 We use an internal routine recursively to handle embedded substrings. The
3811 external function follows. The yield is NULL if the expansion failed, and there
3812 are two cases: if something collapsed syntactically, or if "fail" was given
3813 as the action on a lookup failure. These can be distinguished by looking at the
3814 variable expand_string_forcedfail, which is TRUE in the latter case.
3816 The skipping flag is set true when expanding a substring that isn't actually
3817 going to be used (after "if" or "lookup") and it prevents lookups from
3818 happening lower down.
3820 Store usage: At start, a store block of the length of the input plus 64
3821 is obtained. This is expanded as necessary by string_cat(), which might have to
3822 get a new block, or might be able to expand the original. At the end of the
3823 function we can release any store above that portion of the yield block that
3824 was actually used. In many cases this will be optimal.
3826 However: if the first item in the expansion is a variable name or header name,
3827 we reset the store before processing it; if the result is in fresh store, we
3828 use that without copying. This is helpful for expanding strings like
3829 $message_headers which can get very long.
3831 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3832 since resetting the store at the end of the expansion will free store that was
3833 allocated by the plugin code as well as the slop after the expanded string. So
3834 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3835 and, given the acl condition, ${if }. This is an unfortunate consequence of
3836 string expansion becoming too powerful.
3839 string the string to be expanded
3840 ket_ends true if expansion is to stop at }
3841 left if not NULL, a pointer to the first character after the
3842 expansion is placed here (typically used with ket_ends)
3843 skipping TRUE for recursive calls when the value isn't actually going
3844 to be used (to allow for optimisation)
3845 honour_dollar TRUE if $ is to be expanded,
3846 FALSE if it's just another character
3847 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3850 Returns: NULL if expansion fails:
3851 expand_string_forcedfail is set TRUE if failure was forced
3852 expand_string_message contains a textual error message
3853 a pointer to the expanded string on success
3857 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3858 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3861 int size = Ustrlen(string)+ 64;
3862 uschar *yield = store_get(size);
3864 const uschar *s = string;
3865 uschar *save_expand_nstring[EXPAND_MAXN+1];
3866 int save_expand_nlength[EXPAND_MAXN+1];
3867 BOOL resetok = TRUE;
3871 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
3873 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
3877 expand_string_forcedfail = FALSE;
3878 expand_string_message = US"";
3885 /* \ escapes the next character, which must exist, or else
3886 the expansion fails. There's a special escape, \N, which causes
3887 copying of the subject verbatim up to the next \N. Otherwise,
3888 the escapes are the standard set. */
3894 expand_string_message = US"\\ at end of string";
3900 const uschar * t = s + 2;
3901 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3902 yield = string_catn(yield, &size, &ptr, t, s - t);
3903 if (*s != 0) s += 2;
3909 ch[0] = string_interpret_escape(&s);
3911 yield = string_catn(yield, &size, &ptr, ch, 1);
3918 /* Anything other than $ is just copied verbatim, unless we are
3919 looking for a terminating } character. */
3922 if (ket_ends && *s == '}') break;
3924 if (*s != '$' || !honour_dollar)
3926 yield = string_catn(yield, &size, &ptr, s++, 1);
3930 /* No { after the $ - must be a plain name or a number for string
3931 match variable. There has to be a fudge for variables that are the
3932 names of header fields preceded by "$header_" because header field
3933 names can contain any printing characters except space and colon.
3934 For those that don't like typing this much, "$h_" is a synonym for
3935 "$header_". A non-existent header yields a NULL value; nothing is
3938 if (isalpha((*(++s))))
3943 s = read_name(name, sizeof(name), s, US"_");
3945 /* If this is the first thing to be expanded, release the pre-allocated
3948 if (ptr == 0 && yield != NULL)
3950 if (resetok) store_reset(yield);
3957 if (Ustrncmp(name, "h_", 2) == 0 ||
3958 Ustrncmp(name, "rh_", 3) == 0 ||
3959 Ustrncmp(name, "bh_", 3) == 0 ||
3960 Ustrncmp(name, "header_", 7) == 0 ||
3961 Ustrncmp(name, "rheader_", 8) == 0 ||
3962 Ustrncmp(name, "bheader_", 8) == 0)
3964 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3965 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3966 s = read_header_name(name, sizeof(name), s);
3967 value = find_header(name, FALSE, &newsize, want_raw, charset);
3969 /* If we didn't find the header, and the header contains a closing brace
3970 character, this may be a user error where the terminating colon
3971 has been omitted. Set a flag to adjust the error message in this case.
3972 But there is no error here - nothing gets inserted. */
3976 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3983 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
3985 expand_string_message =
3986 string_sprintf("unknown variable name \"%s\"", name);
3987 check_variable_error_message(name);
3991 /* If the data is known to be in a new buffer, newsize will be set to the
3992 size of that buffer. If this is the first thing in an expansion string,
3993 yield will be NULL; just point it at the new store instead of copying. Many
3994 expansion strings contain just one reference, so this is a useful
3995 optimization, especially for humungous headers. */
3997 len = Ustrlen(value);
3998 if (yield == NULL && newsize != 0)
4004 else yield = string_catn(yield, &size, &ptr, value, len);
4012 s = read_cnumber(&n, s);
4013 if (n >= 0 && n <= expand_nmax)
4014 yield = string_catn(yield, &size, &ptr, expand_nstring[n],
4019 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4021 if (*s != '{') /*}*/
4023 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4027 /* After { there can be various things, but they all start with
4028 an initial word, except for a number for a string match variable. */
4030 if (isdigit((*(++s))))
4033 s = read_cnumber(&n, s); /*{*/
4036 expand_string_message = US"} expected after number";
4039 if (n >= 0 && n <= expand_nmax)
4040 yield = string_catn(yield, &size, &ptr, expand_nstring[n],
4047 expand_string_message = US"letter or digit expected after ${"; /*}*/
4051 /* Allow "-" in names to cater for substrings with negative
4052 arguments. Since we are checking for known names after { this is
4055 s = read_name(name, sizeof(name), s, US"_-");
4056 item_type = chop_match(name, item_table, nelem(item_table));
4060 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4061 If the ACL returns accept or reject we return content set by "message ="
4062 There is currently no limit on recursion; this would have us call
4063 acl_check_internal() directly and get a current level from somewhere.
4064 See also the acl expansion condition ECOND_ACL and the traditional
4065 acl modifier ACLC_ACL.
4066 Assume that the function has side-effects on the store that must be preserved.
4070 /* ${acl {name} {arg1}{arg2}...} */
4072 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4075 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4078 case 1: goto EXPAND_FAILED_CURLY;
4080 case 3: goto EXPAND_FAILED;
4082 if (skipping) continue;
4085 switch(eval_acl(sub, nelem(sub), &user_msg))
4090 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4092 yield = string_cat(yield, &size, &ptr, user_msg);
4096 expand_string_forcedfail = TRUE;
4099 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4104 /* Handle conditionals - preserve the values of the numerical expansion
4105 variables in case they get changed by a regular expression match in the
4106 condition. If not, they retain their external settings. At the end
4107 of this "if" section, they get restored to their previous values. */
4112 const uschar *next_s;
4113 int save_expand_nmax =
4114 save_expand_strings(save_expand_nstring, save_expand_nlength);
4116 while (isspace(*s)) s++;
4117 next_s = eval_condition(s, &resetok, skipping ? NULL : &cond);
4118 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4122 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4123 "condition: %.*s\n",
4124 (int)(next_s - s), s);
4125 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4126 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4128 cond ? "true" : "false");
4133 /* The handling of "yes" and "no" result strings is now in a separate
4134 function that is also used by ${lookup} and ${extract} and ${run}. */
4136 switch(process_yesno(
4137 skipping, /* were previously skipping */
4138 cond, /* success/failure indicator */
4139 lookup_value, /* value to reset for string2 */
4140 &s, /* input pointer */
4141 &yield, /* output pointer */
4142 &size, /* output size */
4143 &ptr, /* output current point */
4144 US"if", /* condition type */
4147 case 1: goto EXPAND_FAILED; /* when all is well, the */
4148 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4151 /* Restore external setting of expansion variables for continuation
4154 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4155 save_expand_nlength);
4160 case EITEM_IMAPFOLDER:
4161 { /* ${imapfolder {name}{sep]{specials}} */
4165 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4168 case 1: goto EXPAND_FAILED_CURLY;
4170 case 3: goto EXPAND_FAILED;
4173 if (sub_arg[1] == NULL) /* One argument */
4175 sub_arg[1] = US"/"; /* default separator */
4178 else if (Ustrlen(sub_arg[1]) != 1)
4180 expand_string_message =
4182 "IMAP folder separator must be one character, found \"%s\"",
4189 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4190 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4192 yield = string_cat(yield, &size, &ptr, encoded);
4198 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4199 expanding an internal string that isn't actually going to be used. All we
4200 need to do is check the syntax, so don't do a lookup at all. Preserve the
4201 values of the numerical expansion variables in case they get changed by a
4202 partial lookup. If not, they retain their external settings. At the end
4203 of this "lookup" section, they get restored to their previous values. */
4207 int stype, partial, affixlen, starflags;
4208 int expand_setup = 0;
4210 uschar *key, *filename;
4211 const uschar *affix;
4212 uschar *save_lookup_value = lookup_value;
4213 int save_expand_nmax =
4214 save_expand_strings(save_expand_nstring, save_expand_nlength);
4216 if ((expand_forbid & RDO_LOOKUP) != 0)
4218 expand_string_message = US"lookup expansions are not permitted";
4222 /* Get the key we are to look up for single-key+file style lookups.
4223 Otherwise set the key NULL pro-tem. */
4225 while (isspace(*s)) s++;
4226 if (*s == '{') /*}*/
4228 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4229 if (!key) goto EXPAND_FAILED; /*{{*/
4232 expand_string_message = US"missing '}' after lookup key";
4233 goto EXPAND_FAILED_CURLY;
4235 while (isspace(*s)) s++;
4239 /* Find out the type of database */
4243 expand_string_message = US"missing lookup type";
4247 /* The type is a string that may contain special characters of various
4248 kinds. Allow everything except space or { to appear; the actual content
4249 is checked by search_findtype_partial. */ /*}*/
4251 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4253 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4257 while (isspace(*s)) s++;
4259 /* Now check for the individual search type and any partial or default
4260 options. Only those types that are actually in the binary are valid. */
4262 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4266 expand_string_message = search_error_message;
4270 /* Check that a key was provided for those lookup types that need it,
4271 and was not supplied for those that use the query style. */
4273 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4277 expand_string_message = string_sprintf("missing {key} for single-"
4278 "key \"%s\" lookup", name);
4286 expand_string_message = string_sprintf("a single key was given for "
4287 "lookup type \"%s\", which is not a single-key lookup type", name);
4292 /* Get the next string in brackets and expand it. It is the file name for
4293 single-key+file lookups, and the whole query otherwise. In the case of
4294 queries that also require a file name (e.g. sqlite), the file name comes
4299 expand_string_message = US"missing '{' for lookup file-or-query arg";
4300 goto EXPAND_FAILED_CURLY;
4302 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4303 if (filename == NULL) goto EXPAND_FAILED;
4306 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4307 goto EXPAND_FAILED_CURLY;
4309 while (isspace(*s)) s++;
4311 /* If this isn't a single-key+file lookup, re-arrange the variables
4312 to be appropriate for the search_ functions. For query-style lookups,
4313 there is just a "key", and no file name. For the special query-style +
4314 file types, the query (i.e. "key") starts with a file name. */
4318 while (isspace(*filename)) filename++;
4321 if (mac_islookup(stype, lookup_querystyle))
4325 if (*filename != '/')
4327 expand_string_message = string_sprintf(
4328 "absolute file name expected for \"%s\" lookup", name);
4331 while (*key != 0 && !isspace(*key)) key++;
4332 if (*key != 0) *key++ = 0;
4336 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4337 the entry was not found. Note that there is no search_close() function.
4338 Files are left open in case of re-use. At suitable places in higher logic,
4339 search_tidyup() is called to tidy all open files. This can save opening
4340 the same file several times. However, files may also get closed when
4341 others are opened, if too many are open at once. The rule is that a
4342 handle should not be used after a second search_open().
4344 Request that a partial search sets up $1 and maybe $2 by passing
4345 expand_setup containing zero. If its value changes, reset expand_nmax,
4346 since new variables will have been set. Note that at the end of this
4347 "lookup" section, the old numeric variables are restored. */
4350 lookup_value = NULL;
4353 void *handle = search_open(filename, stype, 0, NULL, NULL);
4356 expand_string_message = search_error_message;
4359 lookup_value = search_find(handle, filename, key, partial, affix,
4360 affixlen, starflags, &expand_setup);
4361 if (search_find_defer)
4363 expand_string_message =
4364 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4365 string_printing2(key, FALSE), search_error_message);
4368 if (expand_setup > 0) expand_nmax = expand_setup;
4371 /* The handling of "yes" and "no" result strings is now in a separate
4372 function that is also used by ${if} and ${extract}. */
4374 switch(process_yesno(
4375 skipping, /* were previously skipping */
4376 lookup_value != NULL, /* success/failure indicator */
4377 save_lookup_value, /* value to reset for string2 */
4378 &s, /* input pointer */
4379 &yield, /* output pointer */
4380 &size, /* output size */
4381 &ptr, /* output current point */
4382 US"lookup", /* condition type */
4385 case 1: goto EXPAND_FAILED; /* when all is well, the */
4386 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4389 /* Restore external setting of expansion variables for carrying on
4390 at this level, and continue. */
4392 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4393 save_expand_nlength);
4397 /* If Perl support is configured, handle calling embedded perl subroutines,
4398 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4399 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4400 arguments (defined below). */
4402 #define EXIM_PERL_MAX_ARGS 8
4406 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4407 "is not included in this binary";
4410 #else /* EXIM_PERL */
4412 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4415 if ((expand_forbid & RDO_PERL) != 0)
4417 expand_string_message = US"Perl calls are not permitted";
4421 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4422 US"perl", &resetok))
4424 case 1: goto EXPAND_FAILED_CURLY;
4426 case 3: goto EXPAND_FAILED;
4429 /* If skipping, we don't actually do anything */
4431 if (skipping) continue;
4433 /* Start the interpreter if necessary */
4435 if (!opt_perl_started)
4438 if (opt_perl_startup == NULL)
4440 expand_string_message = US"A setting of perl_startup is needed when "
4441 "using the Perl interpreter";
4444 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4445 initerror = init_perl(opt_perl_startup);
4446 if (initerror != NULL)
4448 expand_string_message =
4449 string_sprintf("error in perl_startup code: %s\n", initerror);
4452 opt_perl_started = TRUE;
4455 /* Call the function */
4457 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4458 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4459 sub_arg[0], sub_arg + 1);
4461 /* NULL yield indicates failure; if the message pointer has been set to
4462 NULL, the yield was undef, indicating a forced failure. Otherwise the
4463 message will indicate some kind of Perl error. */
4465 if (new_yield == NULL)
4467 if (expand_string_message == NULL)
4469 expand_string_message =
4470 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4471 "failure", sub_arg[0]);
4472 expand_string_forcedfail = TRUE;
4477 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4478 set during a callback from Perl. */
4480 expand_string_forcedfail = FALSE;
4484 #endif /* EXIM_PERL */
4486 /* Transform email address to "prvs" scheme to use
4487 as BATV-signed return path */
4494 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4496 case 1: goto EXPAND_FAILED_CURLY;
4498 case 3: goto EXPAND_FAILED;
4501 /* If skipping, we don't actually do anything */
4502 if (skipping) continue;
4504 /* sub_arg[0] is the address */
4505 domain = Ustrrchr(sub_arg[0],'@');
4506 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4508 expand_string_message = US"prvs first argument must be a qualified email address";
4512 /* Calculate the hash. The second argument must be a single-digit
4513 key number, or unset. */
4515 if (sub_arg[2] != NULL &&
4516 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4518 expand_string_message = US"prvs second argument must be a single digit";
4522 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4525 expand_string_message = US"prvs hmac-sha1 conversion failed";
4529 /* Now separate the domain from the local part */
4532 yield = string_catn(yield, &size, &ptr, US"prvs=", 5);
4533 yield = string_catn(yield, &size, &ptr, sub_arg[2] ? sub_arg[2] : US"0", 1);
4534 yield = string_catn(yield, &size, &ptr, prvs_daystamp(7), 3);
4535 yield = string_catn(yield, &size, &ptr, p, 6);
4536 yield = string_catn(yield, &size, &ptr, US"=", 1);
4537 yield = string_cat (yield, &size, &ptr, sub_arg[0]);
4538 yield = string_catn(yield, &size, &ptr, US"@", 1);
4539 yield = string_cat (yield, &size, &ptr, domain);
4544 /* Check a prvs-encoded address for validity */
4546 case EITEM_PRVSCHECK:
4549 int mysize = 0, myptr = 0;
4553 /* TF: Ugliness: We want to expand parameter 1 first, then set
4554 up expansion variables that are used in the expansion of
4555 parameter 2. So we clone the string for the first
4556 expansion, where we only expand parameter 1.
4558 PH: Actually, that isn't necessary. The read_subs() function is
4559 designed to work this way for the ${if and ${lookup expansions. I've
4563 /* Reset expansion variables */
4564 prvscheck_result = NULL;
4565 prvscheck_address = NULL;
4566 prvscheck_keynum = NULL;
4568 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4570 case 1: goto EXPAND_FAILED_CURLY;
4572 case 3: goto EXPAND_FAILED;
4575 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4578 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4580 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4581 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4582 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4583 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4584 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4586 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
4587 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
4588 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
4589 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
4590 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
4592 /* Set up expansion variables */
4593 prvscheck_address = string_cat (NULL, &mysize, &myptr, local_part);
4594 prvscheck_address = string_catn(prvscheck_address, &mysize, &myptr, US"@", 1);
4595 prvscheck_address = string_cat (prvscheck_address, &mysize, &myptr, domain);
4596 prvscheck_address[myptr] = '\0';
4597 prvscheck_keynum = string_copy(key_num);
4599 /* Now expand the second argument */
4600 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4602 case 1: goto EXPAND_FAILED_CURLY;
4604 case 3: goto EXPAND_FAILED;
4607 /* Now we have the key and can check the address. */
4609 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4614 expand_string_message = US"hmac-sha1 conversion failed";
4618 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
4619 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
4621 if (Ustrcmp(p,hash) == 0)
4623 /* Success, valid BATV address. Now check the expiry date. */
4624 uschar *now = prvs_daystamp(0);
4625 unsigned int inow = 0,iexpire = 1;
4627 (void)sscanf(CS now,"%u",&inow);
4628 (void)sscanf(CS daystamp,"%u",&iexpire);
4630 /* When "iexpire" is < 7, a "flip" has occured.
4631 Adjust "inow" accordingly. */
4632 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4634 if (iexpire >= inow)
4636 prvscheck_result = US"1";
4637 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
4641 prvscheck_result = NULL;
4642 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
4647 prvscheck_result = NULL;
4648 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
4651 /* Now expand the final argument. We leave this till now so that
4652 it can include $prvscheck_result. */
4654 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4656 case 1: goto EXPAND_FAILED_CURLY;
4658 case 3: goto EXPAND_FAILED;
4661 yield = string_cat(yield, &size, &ptr,
4662 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4664 /* Reset the "internal" variables afterwards, because they are in
4665 dynamic store that will be reclaimed if the expansion succeeded. */
4667 prvscheck_address = NULL;
4668 prvscheck_keynum = NULL;
4671 /* Does not look like a prvs encoded address, return the empty string.
4672 We need to make sure all subs are expanded first, so as to skip over
4675 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4677 case 1: goto EXPAND_FAILED_CURLY;
4679 case 3: goto EXPAND_FAILED;
4685 /* Handle "readfile" to insert an entire file */
4687 case EITEM_READFILE:
4692 if ((expand_forbid & RDO_READFILE) != 0)
4694 expand_string_message = US"file insertions are not permitted";
4698 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4700 case 1: goto EXPAND_FAILED_CURLY;
4702 case 3: goto EXPAND_FAILED;
4705 /* If skipping, we don't actually do anything */
4707 if (skipping) continue;
4709 /* Open the file and read it */
4711 if (!(f = Ufopen(sub_arg[0], "rb")))
4713 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4717 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4722 /* Handle "readsocket" to insert data from a socket, either
4723 Inet or Unix domain */
4725 case EITEM_READSOCK:
4733 BOOL do_shutdown = TRUE;
4736 if (expand_forbid & RDO_READSOCK)
4738 expand_string_message = US"socket insertions are not permitted";
4742 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4743 because there may be a string for expansion on failure. */
4745 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4747 case 1: goto EXPAND_FAILED_CURLY;
4748 case 2: /* Won't occur: no end check */
4749 case 3: goto EXPAND_FAILED;
4752 /* Grab the request string, if any */
4754 reqstr.data = sub_arg[1];
4755 reqstr.len = Ustrlen(sub_arg[1]);
4757 /* Sort out timeout, if given. The second arg is a list with the first element
4758 being a time value. Any more are options of form "name=value". Currently the
4759 only option recognised is "shutdown". */
4763 const uschar * list = sub_arg[2];
4767 item = string_nextinlist(&list, &sep, NULL, 0);
4768 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
4770 expand_string_message = string_sprintf("bad time value %s", item);
4774 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
4775 if (Ustrncmp(item, US"shutdown=", 9) == 0)
4776 if (Ustrcmp(item + 9, US"no") == 0)
4777 do_shutdown = FALSE;
4779 else sub_arg[3] = NULL; /* No eol if no timeout */
4781 /* If skipping, we don't actually do anything. Otherwise, arrange to
4782 connect to either an IP or a Unix socket. */
4786 /* Handle an IP (internet) domain */
4788 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4791 uschar * server_name = sub_arg[0] + 5;
4792 uschar * port_name = Ustrrchr(server_name, ':');
4794 /* Sort out the port */
4798 expand_string_message =
4799 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4802 *port_name++ = 0; /* Terminate server name */
4804 if (isdigit(*port_name))
4807 port = Ustrtol(port_name, &end, 0);
4808 if (end != port_name + Ustrlen(port_name))
4810 expand_string_message =
4811 string_sprintf("invalid port number %s", port_name);
4817 struct servent *service_info = getservbyname(CS port_name, "tcp");
4820 expand_string_message = string_sprintf("unknown port \"%s\"",
4824 port = ntohs(service_info->s_port);
4827 fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4828 timeout, NULL, &expand_string_message, &reqstr);
4829 callout_address = NULL;
4835 /* Handle a Unix domain socket */
4839 struct sockaddr_un sockun; /* don't call this "sun" ! */
4842 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4844 expand_string_message = string_sprintf("failed to create socket: %s",
4849 sockun.sun_family = AF_UNIX;
4850 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4853 sigalrm_seen = FALSE;
4855 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4859 expand_string_message = US "socket connect timed out";
4864 expand_string_message = string_sprintf("failed to connect to socket "
4865 "%s: %s", sub_arg[0], strerror(errno));
4870 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
4872 /* Allow sequencing of test actions */
4873 if (running_in_test_harness) millisleep(100);
4875 /* Write the request string, if not empty or already done */
4879 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
4881 if (write(fd, reqstr.data, reqstr.len) != reqstr.len)
4883 expand_string_message = string_sprintf("request write to socket "
4884 "failed: %s", strerror(errno));
4889 /* Shut down the sending side of the socket. This helps some servers to
4890 recognise that it is their turn to do some work. Just in case some
4891 system doesn't have this function, make it conditional. */
4894 if (do_shutdown) shutdown(fd, SHUT_WR);
4897 if (running_in_test_harness) millisleep(100);
4899 /* Now we need to read from the socket, under a timeout. The function
4900 that reads a file can be used. */
4902 f = fdopen(fd, "rb");
4903 sigalrm_seen = FALSE;
4905 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4909 /* After a timeout, we restore the pointer in the result, that is,
4910 make sure we add nothing from the socket. */
4915 expand_string_message = US "socket read timed out";
4920 /* The whole thing has worked (or we were skipping). If there is a
4921 failure string following, we need to skip it. */
4925 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4929 expand_string_message = US"missing '}' closing failstring for readsocket";
4930 goto EXPAND_FAILED_CURLY;
4932 while (isspace(*s)) s++;
4938 expand_string_message = US"missing '}' closing readsocket";
4939 goto EXPAND_FAILED_CURLY;
4943 /* Come here on failure to create socket, connect socket, write to the
4944 socket, or timeout on reading. If another substring follows, expand and
4945 use it. Otherwise, those conditions give expand errors. */
4948 if (*s != '{') goto EXPAND_FAILED;
4949 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4950 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
4952 yield = string_cat(yield, &size, &ptr, arg);
4955 expand_string_message = US"missing '}' closing failstring for readsocket";
4956 goto EXPAND_FAILED_CURLY;
4958 while (isspace(*s)) s++;
4962 /* Handle "run" to execute a program. */
4968 const uschar **argv;
4971 int lsize = 0, lptr = 0;
4973 if ((expand_forbid & RDO_RUN) != 0)
4975 expand_string_message = US"running a command is not permitted";
4979 while (isspace(*s)) s++;
4982 expand_string_message = US"missing '{' for command arg of run";
4983 goto EXPAND_FAILED_CURLY;
4985 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4986 if (arg == NULL) goto EXPAND_FAILED;
4987 while (isspace(*s)) s++;
4990 expand_string_message = US"missing '}' closing command arg of run";
4991 goto EXPAND_FAILED_CURLY;
4994 if (skipping) /* Just pretend it worked when we're skipping */
4997 lookup_value = NULL;
5001 if (!transport_set_up_command(&argv, /* anchor for arg list */
5002 arg, /* raw command */
5003 FALSE, /* don't expand the arguments */
5004 0, /* not relevant when... */
5005 NULL, /* no transporting address */
5006 US"${run} expansion", /* for error messages */
5007 &expand_string_message)) /* where to put error message */
5010 /* Create the child process, making it a group leader. */
5012 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
5014 expand_string_message =
5015 string_sprintf("couldn't create child process: %s", strerror(errno));
5019 /* Nothing is written to the standard input. */
5023 /* Read the pipe to get the command's output into $value (which is kept
5024 in lookup_value). Read during execution, so that if the output exceeds
5025 the OS pipe buffer limit, we don't block forever. Remember to not release
5026 memory just allocated for $value. */
5029 f = fdopen(fd_out, "rb");
5030 sigalrm_seen = FALSE;
5032 lookup_value = cat_file(f, NULL, &lsize, &lptr, NULL);
5036 /* Wait for the process to finish, applying the timeout, and inspect its
5037 return code for serious disasters. Simple non-zero returns are passed on.
5040 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5042 if (sigalrm_seen || runrc == -256)
5044 expand_string_message = string_sprintf("command timed out");
5045 killpg(pid, SIGKILL); /* Kill the whole process group */
5048 else if (runrc == -257)
5049 expand_string_message = string_sprintf("wait() failed: %s",
5053 expand_string_message = string_sprintf("command killed by signal %d",
5060 /* Process the yes/no strings; $value may be useful in both cases */
5062 switch(process_yesno(
5063 skipping, /* were previously skipping */
5064 runrc == 0, /* success/failure indicator */
5065 lookup_value, /* value to reset for string2 */
5066 &s, /* input pointer */
5067 &yield, /* output pointer */
5068 &size, /* output size */
5069 &ptr, /* output current point */
5070 US"run", /* condition type */
5073 case 1: goto EXPAND_FAILED; /* when all is well, the */
5074 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5080 /* Handle character translation for "tr" */
5088 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5090 case 1: goto EXPAND_FAILED_CURLY;
5092 case 3: goto EXPAND_FAILED;
5095 yield = string_cat(yield, &size, &ptr, sub[0]);
5096 o2m = Ustrlen(sub[2]) - 1;
5098 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
5100 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
5104 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
5111 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5112 expanded arguments. */
5122 int val[2] = { 0, -1 };
5125 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5126 Ensure that sub[2] is set in the ${length } case. */
5129 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5130 TRUE, name, &resetok))
5132 case 1: goto EXPAND_FAILED_CURLY;
5134 case 3: goto EXPAND_FAILED;
5137 /* Juggle the arguments if there are only two of them: always move the
5138 string to the last position and make ${length{n}{str}} equivalent to
5139 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5145 if (item_type == EITEM_LENGTH)
5152 for (i = 0; i < 2; i++)
5154 if (sub[i] == NULL) continue;
5155 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5156 if (*ret != 0 || (i != 0 && val[i] < 0))
5158 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5159 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5165 (item_type == EITEM_HASH)?
5166 compute_hash(sub[2], val[0], val[1], &len) :
5167 (item_type == EITEM_NHASH)?
5168 compute_nhash(sub[2], val[0], val[1], &len) :
5169 extract_substr(sub[2], val[0], val[1], &len);
5171 if (ret == NULL) goto EXPAND_FAILED;
5172 yield = string_catn(yield, &size, &ptr, ret, len);
5176 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5177 This code originally contributed by Steve Haslam. It currently supports
5178 the use of MD5 and SHA-1 hashes.
5180 We need some workspace that is large enough to handle all the supported
5181 hash types. Use macros to set the sizes rather than be too elaborate. */
5183 #define MAX_HASHLEN 20
5184 #define MAX_HASHBLOCKLEN 64
5193 int hashlen; /* Number of octets for the hash algorithm's output */
5194 int hashblocklen; /* Number of octets the hash algorithm processes */
5196 unsigned int keylen;
5198 uschar keyhash[MAX_HASHLEN];
5199 uschar innerhash[MAX_HASHLEN];
5200 uschar finalhash[MAX_HASHLEN];
5201 uschar finalhash_hex[2*MAX_HASHLEN];
5202 uschar innerkey[MAX_HASHBLOCKLEN];
5203 uschar outerkey[MAX_HASHBLOCKLEN];
5205 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5207 case 1: goto EXPAND_FAILED_CURLY;
5209 case 3: goto EXPAND_FAILED;
5214 if (Ustrcmp(sub[0], "md5") == 0)
5217 use_base = &md5_base;
5221 else if (Ustrcmp(sub[0], "sha1") == 0)
5224 use_base = &sha1_ctx;
5230 expand_string_message =
5231 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5236 keylen = Ustrlen(keyptr);
5238 /* If the key is longer than the hash block length, then hash the key
5241 if (keylen > hashblocklen)
5243 chash_start(type, use_base);
5244 chash_end(type, use_base, keyptr, keylen, keyhash);
5249 /* Now make the inner and outer key values */
5251 memset(innerkey, 0x36, hashblocklen);
5252 memset(outerkey, 0x5c, hashblocklen);
5254 for (i = 0; i < keylen; i++)
5256 innerkey[i] ^= keyptr[i];
5257 outerkey[i] ^= keyptr[i];
5260 /* Now do the hashes */
5262 chash_start(type, use_base);
5263 chash_mid(type, use_base, innerkey);
5264 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5266 chash_start(type, use_base);
5267 chash_mid(type, use_base, outerkey);
5268 chash_end(type, use_base, innerhash, hashlen, finalhash);
5270 /* Encode the final hash as a hex string */
5273 for (i = 0; i < hashlen; i++)
5275 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5276 *p++ = hex_digits[finalhash[i] & 0x0f];
5279 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5280 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5282 yield = string_catn(yield, &size, &ptr, finalhash_hex, hashlen*2);
5287 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5288 We have to save the numerical variables and restore them afterwards. */
5293 int moffset, moffsetextra, slen;
5296 const uschar *rerror;
5299 int save_expand_nmax =
5300 save_expand_strings(save_expand_nstring, save_expand_nlength);
5302 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5304 case 1: goto EXPAND_FAILED_CURLY;
5306 case 3: goto EXPAND_FAILED;
5309 /* Compile the regular expression */
5311 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5316 expand_string_message = string_sprintf("regular expression error in "
5317 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5321 /* Now run a loop to do the substitutions as often as necessary. It ends
5322 when there are no more matches. Take care over matches of the null string;
5323 do the same thing as Perl does. */
5326 slen = Ustrlen(sub[0]);
5327 moffset = moffsetextra = 0;
5332 int ovector[3*(EXPAND_MAXN+1)];
5333 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5334 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5338 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5339 is not necessarily the end. We want to repeat the match from one
5340 character further along, but leaving the basic offset the same (for
5341 copying below). We can't be at the end of the string - that was checked
5342 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5343 finished; copy the remaining string and end the loop. */
5353 yield = string_catn(yield, &size, &ptr, subject+moffset, slen-moffset);
5357 /* Match - set up for expanding the replacement. */
5359 if (n == 0) n = EXPAND_MAXN + 1;
5361 for (nn = 0; nn < n*2; nn += 2)
5363 expand_nstring[expand_nmax] = subject + ovector[nn];
5364 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5368 /* Copy the characters before the match, plus the expanded insertion. */
5370 yield = string_catn(yield, &size, &ptr, subject + moffset,
5371 ovector[0] - moffset);
5372 insert = expand_string(sub[2]);
5373 if (insert == NULL) goto EXPAND_FAILED;
5374 yield = string_cat(yield, &size, &ptr, insert);
5376 moffset = ovector[1];
5380 /* If we have matched an empty string, first check to see if we are at
5381 the end of the subject. If so, the loop is over. Otherwise, mimic
5382 what Perl's /g options does. This turns out to be rather cunning. First
5383 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5384 string at the same point. If this fails (picked up above) we advance to
5385 the next character. */
5387 if (ovector[0] == ovector[1])
5389 if (ovector[0] == slen) break;
5390 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5394 /* All done - restore numerical variables. */
5396 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5397 save_expand_nlength);
5401 /* Handle keyed and numbered substring extraction. If the first argument
5402 consists entirely of digits, then a numerical extraction is assumed. */
5408 int field_number = 1;
5409 BOOL field_number_set = FALSE;
5410 uschar *save_lookup_value = lookup_value;
5412 int save_expand_nmax =
5413 save_expand_strings(save_expand_nstring, save_expand_nlength);
5415 /* While skipping we cannot rely on the data for expansions being
5416 available (eg. $item) hence cannot decide on numeric vs. keyed.
5417 Read a maximum of 5 arguments (including the yes/no) */
5421 while (isspace(*s)) s++;
5422 for (j = 5; j > 0 && *s == '{'; j--)
5424 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5425 goto EXPAND_FAILED; /*{*/
5428 expand_string_message = US"missing '{' for arg of extract";
5429 goto EXPAND_FAILED_CURLY;
5431 while (isspace(*s)) s++;
5433 if ( Ustrncmp(s, "fail", 4) == 0
5434 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5438 while (isspace(*s)) s++;
5442 expand_string_message = US"missing '}' closing extract";
5443 goto EXPAND_FAILED_CURLY;
5447 else for (i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5449 while (isspace(*s)) s++;
5450 if (*s == '{') /*}*/
5452 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5453 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5456 expand_string_message = string_sprintf(
5457 "missing '}' closing arg %d of extract", i+1);
5458 goto EXPAND_FAILED_CURLY;
5461 /* After removal of leading and trailing white space, the first
5462 argument must not be empty; if it consists entirely of digits
5463 (optionally preceded by a minus sign), this is a numerical
5464 extraction, and we expect 3 arguments. */
5472 while (isspace(*p)) p++;
5476 while (len > 0 && isspace(p[len-1])) len--;
5481 expand_string_message = US"first argument of \"extract\" must "
5491 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5495 j = 3; /* Need 3 args */
5496 field_number_set = TRUE;
5502 expand_string_message = string_sprintf(
5503 "missing '{' for arg %d of extract", i+1);
5504 goto EXPAND_FAILED_CURLY;
5508 /* Extract either the numbered or the keyed substring into $value. If
5509 skipping, just pretend the extraction failed. */
5511 lookup_value = skipping? NULL : field_number_set?
5512 expand_gettokened(field_number, sub[1], sub[2]) :
5513 expand_getkeyed(sub[0], sub[1]);
5515 /* If no string follows, $value gets substituted; otherwise there can
5516 be yes/no strings, as for lookup or if. */
5518 switch(process_yesno(
5519 skipping, /* were previously skipping */
5520 lookup_value != NULL, /* success/failure indicator */
5521 save_lookup_value, /* value to reset for string2 */
5522 &s, /* input pointer */
5523 &yield, /* output pointer */
5524 &size, /* output size */
5525 &ptr, /* output current point */
5526 US"extract", /* condition type */
5529 case 1: goto EXPAND_FAILED; /* when all is well, the */
5530 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5533 /* All done - restore numerical variables. */
5535 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5536 save_expand_nlength);
5541 /* return the Nth item from a list */
5543 case EITEM_LISTEXTRACT:
5546 int field_number = 1;
5547 uschar *save_lookup_value = lookup_value;
5549 int save_expand_nmax =
5550 save_expand_strings(save_expand_nstring, save_expand_nlength);
5552 /* Read the field & list arguments */
5554 for (i = 0; i < 2; i++)
5556 while (isspace(*s)) s++;
5557 if (*s != '{') /*}*/
5559 expand_string_message = string_sprintf(
5560 "missing '{' for arg %d of listextract", i+1);
5561 goto EXPAND_FAILED_CURLY;
5564 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5565 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5568 expand_string_message = string_sprintf(
5569 "missing '}' closing arg %d of listextract", i+1);
5570 goto EXPAND_FAILED_CURLY;
5573 /* After removal of leading and trailing white space, the first
5574 argument must be numeric and nonempty. */
5582 while (isspace(*p)) p++;
5586 while (len > 0 && isspace(p[len-1])) len--;
5589 if (!*p && !skipping)
5591 expand_string_message = US"first argument of \"listextract\" must "
5601 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5604 expand_string_message = US"first argument of \"listextract\" must "
5612 /* Extract the numbered element into $value. If
5613 skipping, just pretend the extraction failed. */
5615 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5617 /* If no string follows, $value gets substituted; otherwise there can
5618 be yes/no strings, as for lookup or if. */
5620 switch(process_yesno(
5621 skipping, /* were previously skipping */
5622 lookup_value != NULL, /* success/failure indicator */
5623 save_lookup_value, /* value to reset for string2 */
5624 &s, /* input pointer */
5625 &yield, /* output pointer */
5626 &size, /* output size */
5627 &ptr, /* output current point */
5628 US"listextract", /* condition type */
5631 case 1: goto EXPAND_FAILED; /* when all is well, the */
5632 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5635 /* All done - restore numerical variables. */
5637 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5638 save_expand_nlength);
5644 case EITEM_CERTEXTRACT:
5646 uschar *save_lookup_value = lookup_value;
5648 int save_expand_nmax =
5649 save_expand_strings(save_expand_nstring, save_expand_nlength);
5651 /* Read the field argument */
5652 while (isspace(*s)) s++;
5653 if (*s != '{') /*}*/
5655 expand_string_message = US"missing '{' for field arg of certextract";
5656 goto EXPAND_FAILED_CURLY;
5658 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5659 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5662 expand_string_message = US"missing '}' closing field arg of certextract";
5663 goto EXPAND_FAILED_CURLY;
5665 /* strip spaces fore & aft */
5670 while (isspace(*p)) p++;
5674 while (len > 0 && isspace(p[len-1])) len--;
5678 /* inspect the cert argument */
5679 while (isspace(*s)) s++;
5680 if (*s != '{') /*}*/
5682 expand_string_message = US"missing '{' for cert variable arg of certextract";
5683 goto EXPAND_FAILED_CURLY;
5687 expand_string_message = US"second argument of \"certextract\" must "
5688 "be a certificate variable";
5691 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5692 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5695 expand_string_message = US"missing '}' closing cert variable arg of certextract";
5696 goto EXPAND_FAILED_CURLY;
5700 lookup_value = NULL;
5703 lookup_value = expand_getcertele(sub[0], sub[1]);
5704 if (*expand_string_message) goto EXPAND_FAILED;
5706 switch(process_yesno(
5707 skipping, /* were previously skipping */
5708 lookup_value != NULL, /* success/failure indicator */
5709 save_lookup_value, /* value to reset for string2 */
5710 &s, /* input pointer */
5711 &yield, /* output pointer */
5712 &size, /* output size */
5713 &ptr, /* output current point */
5714 US"certextract", /* condition type */
5717 case 1: goto EXPAND_FAILED; /* when all is well, the */
5718 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5721 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5722 save_expand_nlength);
5725 #endif /*SUPPORT_TLS*/
5727 /* Handle list operations */
5735 uschar outsep[2] = { '\0', '\0' };
5736 const uschar *list, *expr, *temp;
5737 uschar *save_iterate_item = iterate_item;
5738 uschar *save_lookup_value = lookup_value;
5740 while (isspace(*s)) s++;
5743 expand_string_message =
5744 string_sprintf("missing '{' for first arg of %s", name);
5745 goto EXPAND_FAILED_CURLY;
5748 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5749 if (list == NULL) goto EXPAND_FAILED;
5752 expand_string_message =
5753 string_sprintf("missing '}' closing first arg of %s", name);
5754 goto EXPAND_FAILED_CURLY;
5757 if (item_type == EITEM_REDUCE)
5760 while (isspace(*s)) s++;
5763 expand_string_message = US"missing '{' for second arg of reduce";
5764 goto EXPAND_FAILED_CURLY;
5766 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5767 if (!t) goto EXPAND_FAILED;
5771 expand_string_message = US"missing '}' closing second arg of reduce";
5772 goto EXPAND_FAILED_CURLY;
5776 while (isspace(*s)) s++;
5779 expand_string_message =
5780 string_sprintf("missing '{' for last arg of %s", name);
5781 goto EXPAND_FAILED_CURLY;
5786 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5787 if scanning a "false" part). This allows us to find the end of the
5788 condition, because if the list is empty, we won't actually evaluate the
5789 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5790 the normal internal expansion function. */
5792 if (item_type == EITEM_FILTER)
5794 temp = eval_condition(expr, &resetok, NULL);
5795 if (temp != NULL) s = temp;
5798 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5802 expand_string_message = string_sprintf("%s inside \"%s\" item",
5803 expand_string_message, name);
5807 while (isspace(*s)) s++;
5810 expand_string_message = string_sprintf("missing } at end of condition "
5811 "or expression inside \"%s\"", name);
5815 while (isspace(*s)) s++; /*{*/
5818 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5823 /* If we are skipping, we can now just move on to the next item. When
5824 processing for real, we perform the iteration. */
5826 if (skipping) continue;
5827 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
5829 *outsep = (uschar)sep; /* Separator as a string */
5831 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
5832 name, iterate_item, lookup_value);
5834 if (item_type == EITEM_FILTER)
5837 if (eval_condition(expr, &resetok, &condresult) == NULL)
5839 iterate_item = save_iterate_item;
5840 lookup_value = save_lookup_value;
5841 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5842 expand_string_message, name);
5845 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
5846 condresult? "true":"false");
5848 temp = iterate_item; /* TRUE => include this item */
5850 continue; /* FALSE => skip this item */
5853 /* EITEM_MAP and EITEM_REDUCE */
5857 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5861 iterate_item = save_iterate_item;
5862 expand_string_message = string_sprintf("%s inside \"%s\" item",
5863 expand_string_message, name);
5866 if (item_type == EITEM_REDUCE)
5868 lookup_value = t; /* Update the value of $value */
5869 continue; /* and continue the iteration */
5873 /* We reach here for FILTER if the condition is true, always for MAP,
5874 and never for REDUCE. The value in "temp" is to be added to the output
5875 list that is being created, ensuring that any occurrences of the
5876 separator character are doubled. Unless we are dealing with the first
5877 item of the output list, add in a space if the new item begins with the
5878 separator character, or is an empty string. */
5880 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5881 yield = string_catn(yield, &size, &ptr, US" ", 1);
5883 /* Add the string in "temp" to the output list that we are building,
5884 This is done in chunks by searching for the separator character. */
5888 size_t seglen = Ustrcspn(temp, outsep);
5890 yield = string_catn(yield, &size, &ptr, temp, seglen + 1);
5892 /* If we got to the end of the string we output one character
5893 too many; backup and end the loop. Otherwise arrange to double the
5896 if (temp[seglen] == '\0') { ptr--; break; }
5897 yield = string_catn(yield, &size, &ptr, outsep, 1);
5901 /* Output a separator after the string: we will remove the redundant
5902 final one at the end. */
5904 yield = string_catn(yield, &size, &ptr, outsep, 1);
5905 } /* End of iteration over the list loop */
5907 /* REDUCE has generated no output above: output the final value of
5910 if (item_type == EITEM_REDUCE)
5912 yield = string_cat(yield, &size, &ptr, lookup_value);
5913 lookup_value = save_lookup_value; /* Restore $value */
5916 /* FILTER and MAP generate lists: if they have generated anything, remove
5917 the redundant final separator. Even though an empty item at the end of a
5918 list does not count, this is tidier. */
5920 else if (ptr != save_ptr) ptr--;
5922 /* Restore preserved $item */
5924 iterate_item = save_iterate_item;
5931 const uschar *srclist, *cmp, *xtract;
5933 const uschar *dstlist = NULL, *dstkeylist = NULL;
5935 uschar *save_iterate_item = iterate_item;
5937 while (isspace(*s)) s++;
5940 expand_string_message = US"missing '{' for list arg of sort";
5941 goto EXPAND_FAILED_CURLY;
5944 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5945 if (!srclist) goto EXPAND_FAILED;
5948 expand_string_message = US"missing '}' closing list arg of sort";
5949 goto EXPAND_FAILED_CURLY;
5952 while (isspace(*s)) s++;
5955 expand_string_message = US"missing '{' for comparator arg of sort";
5956 goto EXPAND_FAILED_CURLY;
5959 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5960 if (!cmp) goto EXPAND_FAILED;
5963 expand_string_message = US"missing '}' closing comparator arg of sort";
5964 goto EXPAND_FAILED_CURLY;
5967 while (isspace(*s)) s++;
5970 expand_string_message = US"missing '{' for extractor arg of sort";
5971 goto EXPAND_FAILED_CURLY;
5975 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5976 if (!tmp) goto EXPAND_FAILED;
5977 xtract = string_copyn(xtract, s - xtract);
5981 expand_string_message = US"missing '}' closing extractor arg of sort";
5982 goto EXPAND_FAILED_CURLY;
5987 expand_string_message = US"missing } at end of \"sort\"";
5991 if (skipping) continue;
5993 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5996 uschar * newlist = NULL;
5997 int size = 0, len = 0;
5998 uschar * newkeylist = NULL;
5999 int ksize = 0, klen = 0;
6002 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6004 /* extract field for comparisons */
6005 iterate_item = srcitem;
6006 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
6010 expand_string_message = string_sprintf(
6011 "field-extract in sort: \"%s\"", xtract);
6015 /* Insertion sort */
6017 /* copy output list until new-item < list-item */
6018 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6024 /* field for comparison */
6025 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6028 /* build and run condition string */
6029 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
6031 DEBUG(D_expand) debug_printf_indent("%s: cond = \"%s\"\n", name, expr);
6032 if (!eval_condition(expr, &resetok, &before))
6034 expand_string_message = string_sprintf("comparison in sort: %s",
6041 /* New-item sorts before this dst-item. Append new-item,
6042 then dst-item, then remainder of dst list. */
6044 newlist = string_append_listele(newlist, &size, &len, sep, srcitem);
6045 newkeylist = string_append_listele(newkeylist, &ksize, &klen, sep, srcfield);
6048 newlist = string_append_listele(newlist, &size, &len, sep, dstitem);
6049 newkeylist = string_append_listele(newkeylist, &ksize, &klen, sep, dstfield);
6051 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6053 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6055 newlist = string_append_listele(newlist, &size, &len, sep, dstitem);
6056 newkeylist = string_append_listele(newkeylist, &ksize, &klen, sep, dstfield);
6062 newlist = string_append_listele(newlist, &size, &len, sep, dstitem);
6063 newkeylist = string_append_listele(newkeylist, &ksize, &klen, sep, dstfield);
6066 /* If we ran out of dstlist without consuming srcitem, append it */
6069 newlist = string_append_listele(newlist, &size, &len, sep, srcitem);
6070 newkeylist = string_append_listele(newkeylist, &ksize, &klen, sep, srcfield);
6074 dstkeylist = newkeylist;
6076 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6077 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6081 yield = string_cat(yield, &size, &ptr, dstlist);
6083 /* Restore preserved $item */
6084 iterate_item = save_iterate_item;
6088 expand_string_message = US"Internal error in sort (list mismatch)";
6093 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6094 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6095 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6096 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6098 #define EXPAND_DLFUNC_MAX_ARGS 8
6101 #ifndef EXPAND_DLFUNC
6102 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6103 "is not included in this binary";
6106 #else /* EXPAND_DLFUNC */
6109 exim_dlfunc_t *func;
6112 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6114 if ((expand_forbid & RDO_DLFUNC) != 0)
6116 expand_string_message =
6117 US"dynamically-loaded functions are not permitted";
6121 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6122 TRUE, US"dlfunc", &resetok))
6124 case 1: goto EXPAND_FAILED_CURLY;
6126 case 3: goto EXPAND_FAILED;
6129 /* If skipping, we don't actually do anything */
6131 if (skipping) continue;
6133 /* Look up the dynamically loaded object handle in the tree. If it isn't
6134 found, dlopen() the file and put the handle in the tree for next time. */
6136 t = tree_search(dlobj_anchor, argv[0]);
6139 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6142 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6143 argv[0], dlerror());
6144 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6147 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6148 Ustrcpy(t->name, argv[0]);
6149 t->data.ptr = handle;
6150 (void)tree_insertnode(&dlobj_anchor, t);
6153 /* Having obtained the dynamically loaded object handle, look up the
6154 function pointer. */
6156 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6159 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6160 "%s", argv[1], argv[0], dlerror());
6161 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6165 /* Call the function and work out what to do with the result. If it
6166 returns OK, we have a replacement string; if it returns DEFER then
6167 expansion has failed in a non-forced manner; if it returns FAIL then
6168 failure was forced; if it returns ERROR or any other value there's a
6169 problem, so panic slightly. In any case, assume that the function has
6170 side-effects on the store that must be preserved. */
6174 for (argc = 0; argv[argc] != NULL; argc++);
6175 status = func(&result, argc - 2, &argv[2]);
6178 if (result == NULL) result = US"";
6179 yield = string_cat(yield, &size, &ptr, result);
6184 expand_string_message = result == NULL ? US"(no message)" : result;
6185 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
6186 else if(status != FAIL)
6187 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6188 argv[0], argv[1], status, expand_string_message);
6192 #endif /* EXPAND_DLFUNC */
6194 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6197 uschar *save_lookup_value = lookup_value;
6199 while (isspace(*s)) s++;
6200 if (*s != '{') /*}*/
6203 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6204 if (!key) goto EXPAND_FAILED; /*{*/
6207 expand_string_message = US"missing '{' for name arg of env";
6208 goto EXPAND_FAILED_CURLY;
6211 lookup_value = US getenv(CS key);
6213 switch(process_yesno(
6214 skipping, /* were previously skipping */
6215 lookup_value != NULL, /* success/failure indicator */
6216 save_lookup_value, /* value to reset for string2 */
6217 &s, /* input pointer */
6218 &yield, /* output pointer */
6219 &size, /* output size */
6220 &ptr, /* output current point */
6221 US"env", /* condition type */
6224 case 1: goto EXPAND_FAILED; /* when all is well, the */
6225 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6229 } /* EITEM_* switch */
6231 /* Control reaches here if the name is not recognized as one of the more
6232 complicated expansion items. Check for the "operator" syntax (name terminated
6233 by a colon). Some of the operators have arguments, separated by _ from the
6241 var_entry *vp = NULL;
6243 /* Owing to an historical mis-design, an underscore may be part of the
6244 operator name, or it may introduce arguments. We therefore first scan the
6245 table of names that contain underscores. If there is no match, we cut off
6246 the arguments and then scan the main table. */
6248 if ((c = chop_match(name, op_table_underscore,
6249 nelem(op_table_underscore))) < 0)
6251 arg = Ustrchr(name, '_');
6252 if (arg != NULL) *arg = 0;
6253 c = chop_match(name, op_table_main, nelem(op_table_main));
6254 if (c >= 0) c += nelem(op_table_underscore);
6255 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6258 /* Deal specially with operators that might take a certificate variable
6259 as we do not want to do the usual expansion. For most, expand the string.*/
6269 const uschar * s1 = s;
6270 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6272 if (!sub) goto EXPAND_FAILED; /*{*/
6275 expand_string_message =
6276 string_sprintf("missing '}' closing cert arg of %s", name);
6277 goto EXPAND_FAILED_CURLY;
6279 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6289 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6290 if (!sub) goto EXPAND_FAILED;
6295 /* If we are skipping, we don't need to perform the operation at all.
6296 This matters for operations like "mask", because the data may not be
6297 in the correct format when skipping. For example, the expression may test
6298 for the existence of $sender_host_address before trying to mask it. For
6299 other operations, doing them may not fail, but it is a waste of time. */
6301 if (skipping && c >= 0) continue;
6303 /* Otherwise, switch on the operator type */
6310 unsigned long int n = Ustrtoul(sub, &t, 10);
6316 expand_string_message = string_sprintf("argument for base32 "
6317 "operator is \"%s\", which is not a decimal number", sub);
6321 s = string_catn(s, &sz, &i, &base32_chars[n & 0x1f], 1);
6323 while (i > 0) yield = string_catn(yield, &size, &ptr, &s[--i], 1);
6330 unsigned long int n = 0;
6334 uschar * t = Ustrchr(base32_chars, *tt++);
6337 expand_string_message = string_sprintf("argument for base32d "
6338 "operator is \"%s\", which is not a base 32 number", sub);
6341 n = n * 32 + (t - base32_chars);
6343 s = string_sprintf("%ld", n);
6344 yield = string_cat(yield, &size, &ptr, s);
6351 unsigned long int n = Ustrtoul(sub, &t, 10);
6354 expand_string_message = string_sprintf("argument for base62 "
6355 "operator is \"%s\", which is not a decimal number", sub);
6358 t = string_base62(n);
6359 yield = string_cat(yield, &size, &ptr, t);
6363 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6369 unsigned long int n = 0;
6372 uschar *t = Ustrchr(base62_chars, *tt++);
6375 expand_string_message = string_sprintf("argument for base62d "
6376 "operator is \"%s\", which is not a base %d number", sub,
6380 n = n * BASE_62 + (t - base62_chars);
6382 (void)sprintf(CS buf, "%ld", n);
6383 yield = string_cat(yield, &size, &ptr, buf);
6389 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6390 if (expanded == NULL)
6392 expand_string_message =
6393 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6394 expand_string_message);
6397 yield = string_cat(yield, &size, &ptr, expanded);
6404 uschar *t = sub - 1;
6405 while (*(++t) != 0) { *t = tolower(*t); count++; }
6406 yield = string_catn(yield, &size, &ptr, sub, count);
6413 uschar *t = sub - 1;
6414 while (*(++t) != 0) { *t = toupper(*t); count++; }
6415 yield = string_catn(yield, &size, &ptr, sub, count);
6421 if (vp && *(void **)vp->value)
6423 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6424 yield = string_cat(yield, &size, &ptr, cp);
6434 md5_end(&base, sub, Ustrlen(sub), digest);
6435 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6436 yield = string_cat(yield, &size, &ptr, US st);
6442 if (vp && *(void **)vp->value)
6444 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6445 yield = string_cat(yield, &size, &ptr, cp);
6455 sha1_end(&h, sub, Ustrlen(sub), digest);
6456 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6457 yield = string_catn(yield, &size, &ptr, US st, 40);
6462 #ifdef EXIM_HAVE_SHA2
6463 if (vp && *(void **)vp->value)
6465 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6466 yield = string_cat(yield, &size, &ptr, cp);
6474 if (!exim_sha_init(&h, HASH_SHA2_256))
6476 expand_string_message = US"unrecognised sha256 variant";
6479 exim_sha_update(&h, sub, Ustrlen(sub));
6480 exim_sha_finish(&h, &b);
6483 sprintf(st, "%02X", *b.data++);
6484 yield = string_catn(yield, &size, &ptr, US st, 2);
6488 expand_string_message = US"sha256 only supported with TLS";
6493 #ifdef EXIM_HAVE_SHA3
6498 hashmethod m = !arg ? HASH_SHA3_256
6499 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6500 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6501 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6502 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6505 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6507 expand_string_message = US"unrecognised sha3 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, &size, &ptr, US st, 2);
6521 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 +";
6525 /* Convert hex encoding to base64 encoding */
6535 for (enc = sub; *enc != 0; enc++)
6537 if (!isxdigit(*enc))
6539 expand_string_message = string_sprintf("\"%s\" is not a hex "
6548 expand_string_message = string_sprintf("\"%s\" contains an odd "
6549 "number of characters", sub);
6553 while ((c = *in++) != 0)
6555 if (isdigit(c)) c -= '0';
6556 else c = toupper(c) - 'A' + 10;
6568 enc = b64encode(sub, out - sub);
6569 yield = string_cat(yield, &size, &ptr, enc);
6573 /* Convert octets outside 0x21..0x7E to \xXX form */
6577 uschar *t = sub - 1;
6580 if (*t < 0x21 || 0x7E < *t)
6581 yield = string_catn(yield, &size, &ptr,
6582 string_sprintf("\\x%02x", *t), 4);
6584 yield = string_catn(yield, &size, &ptr, t, 1);
6589 /* count the number of list elements */
6598 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6599 cp = string_sprintf("%d", cnt);
6600 yield = string_cat(yield, &size, &ptr, cp);
6604 /* expand a named list given the name */
6605 /* handles nested named lists; requotes as colon-sep list */
6609 tree_node *t = NULL;
6610 const uschar * list;
6613 uschar * suffix = US"";
6614 BOOL needsep = FALSE;
6617 if (*sub == '+') sub++;
6618 if (arg == NULL) /* no-argument version */
6620 if (!(t = tree_search(addresslist_anchor, sub)) &&
6621 !(t = tree_search(domainlist_anchor, sub)) &&
6622 !(t = tree_search(hostlist_anchor, sub)))
6623 t = tree_search(localpartlist_anchor, sub);
6625 else switch(*arg) /* specific list-type version */
6627 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6628 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6629 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6630 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6632 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6638 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6640 : *arg=='a'?"address "
6641 : *arg=='d'?"domain "
6643 : *arg=='l'?"localpart "
6648 list = ((namedlist_block *)(t->data.ptr))->string;
6650 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6652 uschar * buf = US" : ";
6654 yield = string_catn(yield, &size, &ptr, buf, 3);
6658 if (*item == '+') /* list item is itself a named list */
6660 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6661 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6663 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6667 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6668 while ((cp= strpbrk(CCS item, tok)))
6670 yield = string_catn(yield, &size, &ptr, item, cp-CS item);
6671 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6673 yield = string_catn(yield, &size, &ptr, US"::", 2);
6676 else /* sep in item; should already be doubled; emit once */
6678 yield = string_catn(yield, &size, &ptr, US tok, 1);
6679 if (*cp == sep) cp++;
6684 yield = string_cat(yield, &size, &ptr, item);
6689 /* mask applies a mask to an IP address; for example the result of
6690 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6697 int mask, maskoffset;
6698 int type = string_is_ip_address(sub, &maskoffset);
6703 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6708 if (maskoffset == 0)
6710 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6715 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6717 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6719 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6724 /* Convert the address to binary integer(s) and apply the mask */
6726 sub[maskoffset] = 0;
6727 count = host_aton(sub, binary);
6728 host_mask(count, binary, mask);
6730 /* Convert to masked textual format and add to output. */
6732 yield = string_catn(yield, &size, &ptr, buffer,
6733 host_nmtoa(count, binary, mask, buffer, '.'));
6738 case EOP_IPV6DENORM:
6740 int type = string_is_ip_address(sub, NULL);
6747 (void) host_aton(sub, binary);
6750 case 4: /* convert to IPv4-mapped IPv6 */
6751 binary[0] = binary[1] = 0;
6752 binary[2] = 0x0000ffff;
6753 (void) host_aton(sub, binary+3);
6757 expand_string_message =
6758 string_sprintf("\"%s\" is not an IP address", sub);
6762 yield = string_catn(yield, &size, &ptr, buffer,
6764 ? ipv6_nmtoa(binary, buffer)
6765 : host_nmtoa(4, binary, -1, buffer, ':')
6771 case EOP_LOCAL_PART:
6775 int start, end, domain;
6776 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
6779 if (c != EOP_DOMAIN)
6781 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6782 yield = string_catn(yield, &size, &ptr, sub+start, end-start);
6784 else if (domain != 0)
6787 yield = string_catn(yield, &size, &ptr, sub+domain, end-domain);
6794 uschar outsep[2] = { ':', '\0' };
6795 uschar *address, *error;
6797 int start, end, domain; /* Not really used */
6799 while (isspace(*sub)) sub++;
6800 if (*sub == '>') { *outsep = *++sub; ++sub; }
6801 parse_allow_group = TRUE;
6805 uschar *p = parse_find_address_end(sub, FALSE);
6806 uschar saveend = *p;
6808 address = parse_extract_address(sub, &error, &start, &end, &domain,
6812 /* Add the address to the output list that we are building. This is
6813 done in chunks by searching for the separator character. At the
6814 start, unless we are dealing with the first address of the output
6815 list, add in a space if the new address begins with the separator
6816 character, or is an empty string. */
6818 if (address != NULL)
6820 if (ptr != save_ptr && address[0] == *outsep)
6821 yield = string_catn(yield, &size, &ptr, US" ", 1);
6825 size_t seglen = Ustrcspn(address, outsep);
6826 yield = string_catn(yield, &size, &ptr, address, seglen + 1);
6828 /* If we got to the end of the string we output one character
6831 if (address[seglen] == '\0') { ptr--; break; }
6832 yield = string_catn(yield, &size, &ptr, outsep, 1);
6833 address += seglen + 1;
6836 /* Output a separator after the string: we will remove the
6837 redundant final one at the end. */
6839 yield = string_catn(yield, &size, &ptr, outsep, 1);
6842 if (saveend == '\0') break;
6846 /* If we have generated anything, remove the redundant final
6849 if (ptr != save_ptr) ptr--;
6850 parse_allow_group = FALSE;
6855 /* quote puts a string in quotes if it is empty or contains anything
6856 other than alphamerics, underscore, dot, or hyphen.
6858 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6859 be quoted in order to be a valid local part.
6861 In both cases, newlines and carriage returns are converted into \n and \r
6865 case EOP_QUOTE_LOCAL_PART:
6868 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6869 uschar *t = sub - 1;
6873 while (!needs_quote && *(++t) != 0)
6874 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6876 else /* EOP_QUOTE_LOCAL_PART */
6878 while (!needs_quote && *(++t) != 0)
6879 needs_quote = !isalnum(*t) &&
6880 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6881 (*t != '.' || t == sub || t[1] == 0);
6886 yield = string_catn(yield, &size, &ptr, US"\"", 1);
6891 yield = string_catn(yield, &size, &ptr, US"\\n", 2);
6892 else if (*t == '\r')
6893 yield = string_catn(yield, &size, &ptr, US"\\r", 2);
6896 if (*t == '\\' || *t == '"')
6897 yield = string_catn(yield, &size, &ptr, US"\\", 1);
6898 yield = string_catn(yield, &size, &ptr, t, 1);
6901 yield = string_catn(yield, &size, &ptr, US"\"", 1);
6903 else yield = string_cat(yield, &size, &ptr, sub);
6907 /* quote_lookuptype does lookup-specific quoting */
6912 uschar *opt = Ustrchr(arg, '_');
6914 if (opt != NULL) *opt++ = 0;
6916 n = search_findtype(arg, Ustrlen(arg));
6919 expand_string_message = search_error_message;
6923 if (lookup_list[n]->quote != NULL)
6924 sub = (lookup_list[n]->quote)(sub, opt);
6925 else if (opt != NULL) sub = NULL;
6929 expand_string_message = string_sprintf(
6930 "\"%s\" unrecognized after \"${quote_%s\"",
6935 yield = string_cat(yield, &size, &ptr, sub);
6939 /* rx quote sticks in \ before any non-alphameric character so that
6940 the insertion works in a regular expression. */
6944 uschar *t = sub - 1;
6948 yield = string_catn(yield, &size, &ptr, US"\\", 1);
6949 yield = string_catn(yield, &size, &ptr, t, 1);
6954 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6955 prescribed by the RFC, if there are characters that need to be encoded */
6959 uschar buffer[2048];
6960 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6961 buffer, sizeof(buffer), FALSE);
6962 yield = string_cat(yield, &size, &ptr, string);
6966 /* RFC 2047 decode */
6972 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6973 headers_charset, '?', &len, &error);
6976 expand_string_message = error;
6979 yield = string_catn(yield, &size, &ptr, decoded, len);
6983 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6993 if (c > 255) c = '_';
6995 yield = string_catn(yield, &size, &ptr, buff, 1);
7000 /* replace illegal UTF-8 sequences by replacement character */
7002 #define UTF8_REPLACEMENT_CHAR US"?"
7006 int seq_len = 0, index = 0;
7008 long codepoint = -1;
7009 uschar seq_buff[4]; /* accumulate utf-8 here */
7018 if ((c & 0xc0) != 0x80)
7019 /* wrong continuation byte; invalidate all bytes */
7020 complete = 1; /* error */
7023 codepoint = (codepoint << 6) | (c & 0x3f);
7024 seq_buff[index++] = c;
7025 if (--bytes_left == 0) /* codepoint complete */
7026 if(codepoint > 0x10FFFF) /* is it too large? */
7027 complete = -1; /* error (RFC3629 limit) */
7029 { /* finished; output utf-8 sequence */
7030 yield = string_catn(yield, &size, &ptr, seq_buff, seq_len);
7035 else /* no bytes left: new sequence */
7037 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7039 yield = string_catn(yield, &size, &ptr, &c, 1);
7042 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7044 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7049 codepoint = c & 0x1f;
7052 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7055 codepoint = c & 0x0f;
7057 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7060 codepoint = c & 0x07;
7062 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7065 seq_buff[index++] = c;
7066 seq_len = bytes_left + 1;
7067 } /* if(bytes_left) */
7071 bytes_left = index = 0;
7072 yield = string_catn(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
7074 if ((complete == 1) && ((c & 0x80) == 0))
7075 /* ASCII character follows incomplete sequence */
7076 yield = string_catn(yield, &size, &ptr, &c, 1);
7082 case EOP_UTF8_DOMAIN_TO_ALABEL:
7084 uschar * error = NULL;
7085 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7088 expand_string_message = string_sprintf(
7089 "error converting utf8 (%s) to alabel: %s",
7090 string_printing(sub), error);
7093 yield = string_cat(yield, &size, &ptr, s);
7097 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7099 uschar * error = NULL;
7100 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7103 expand_string_message = string_sprintf(
7104 "error converting alabel (%s) to utf8: %s",
7105 string_printing(sub), error);
7108 yield = string_cat(yield, &size, &ptr, s);
7112 case EOP_UTF8_LOCALPART_TO_ALABEL:
7114 uschar * error = NULL;
7115 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7118 expand_string_message = string_sprintf(
7119 "error converting utf8 (%s) to alabel: %s",
7120 string_printing(sub), error);
7123 yield = string_cat(yield, &size, &ptr, s);
7124 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield);
7128 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7130 uschar * error = NULL;
7131 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7134 expand_string_message = string_sprintf(
7135 "error converting alabel (%s) to utf8: %s",
7136 string_printing(sub), error);
7139 yield = string_cat(yield, &size, &ptr, s);
7142 #endif /* EXPERIMENTAL_INTERNATIONAL */
7144 /* escape turns all non-printing characters into escape sequences. */
7148 const uschar * t = string_printing(sub);
7149 yield = string_cat(yield, &size, &ptr, t);
7153 case EOP_ESCAPE8BIT:
7155 const uschar * s = sub;
7158 for (s = sub; (c = *s); s++)
7159 yield = c < 127 && c != '\\'
7160 ? string_catn(yield, &size, &ptr, s, 1)
7161 : string_catn(yield, &size, &ptr, string_sprintf("\\%03o", c), 4);
7165 /* Handle numeric expression evaluation */
7170 uschar *save_sub = sub;
7171 uschar *error = NULL;
7172 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7175 expand_string_message = string_sprintf("error in expression "
7176 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
7180 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
7181 yield = string_cat(yield, &size, &ptr, var_buffer);
7185 /* Handle time period formating */
7189 int n = readconf_readtime(sub, 0, FALSE);
7192 expand_string_message = string_sprintf("string \"%s\" is not an "
7193 "Exim time interval in \"%s\" operator", sub, name);
7196 sprintf(CS var_buffer, "%d", n);
7197 yield = string_cat(yield, &size, &ptr, var_buffer);
7201 case EOP_TIME_INTERVAL:
7204 uschar *t = read_number(&n, sub);
7205 if (*t != 0) /* Not A Number*/
7207 expand_string_message = string_sprintf("string \"%s\" is not a "
7208 "positive number in \"%s\" operator", sub, name);
7211 t = readconf_printtime(n);
7212 yield = string_cat(yield, &size, &ptr, t);
7216 /* Convert string to base64 encoding */
7222 uschar * s = vp && *(void **)vp->value
7223 ? tls_cert_der_b64(*(void **)vp->value)
7224 : b64encode(sub, Ustrlen(sub));
7226 uschar * s = b64encode(sub, Ustrlen(sub));
7228 yield = string_cat(yield, &size, &ptr, s);
7235 int len = b64decode(sub, &s);
7238 expand_string_message = string_sprintf("string \"%s\" is not "
7239 "well-formed for \"%s\" operator", sub, name);
7242 yield = string_cat(yield, &size, &ptr, s);
7246 /* strlen returns the length of the string */
7251 (void)sprintf(CS buff, "%d", Ustrlen(sub));
7252 yield = string_cat(yield, &size, &ptr, buff);
7256 /* length_n or l_n takes just the first n characters or the whole string,
7257 whichever is the shorter;
7259 substr_m_n, and s_m_n take n characters from offset m; negative m take
7260 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7261 takes the rest, either to the right or to the left.
7263 hash_n or h_n makes a hash of length n from the string, yielding n
7264 characters from the set a-z; hash_n_m makes a hash of length n, but
7265 uses m characters from the set a-zA-Z0-9.
7267 nhash_n returns a single number between 0 and n-1 (in text form), while
7268 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7269 between 0 and n-1 and the second between 0 and m-1. */
7289 expand_string_message = string_sprintf("missing values after %s",
7294 /* "length" has only one argument, effectively being synonymous with
7297 if (c == EOP_LENGTH || c == EOP_L)
7303 /* The others have one or two arguments; for "substr" the first may be
7304 negative. The second being negative means "not supplied". */
7309 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7312 /* Read up to two numbers, separated by underscores */
7317 if (arg != ret && *arg == '_' && pn == &value1)
7321 if (arg[1] != 0) arg++;
7323 else if (!isdigit(*arg))
7325 expand_string_message =
7326 string_sprintf("non-digit after underscore in \"%s\"", name);
7329 else *pn = (*pn)*10 + *arg++ - '0';
7333 /* Perform the required operation */
7336 (c == EOP_HASH || c == EOP_H)?
7337 compute_hash(sub, value1, value2, &len) :
7338 (c == EOP_NHASH || c == EOP_NH)?
7339 compute_nhash(sub, value1, value2, &len) :
7340 extract_substr(sub, value1, value2, &len);
7342 if (ret == NULL) goto EXPAND_FAILED;
7343 yield = string_catn(yield, &size, &ptr, ret, len);
7353 uschar **modetable[3];
7358 if ((expand_forbid & RDO_EXISTS) != 0)
7360 expand_string_message = US"Use of the stat() expansion is not permitted";
7364 if (stat(CS sub, &st) < 0)
7366 expand_string_message = string_sprintf("stat(%s) failed: %s",
7367 sub, strerror(errno));
7371 switch (mode & S_IFMT)
7373 case S_IFIFO: smode[0] = 'p'; break;
7374 case S_IFCHR: smode[0] = 'c'; break;
7375 case S_IFDIR: smode[0] = 'd'; break;
7376 case S_IFBLK: smode[0] = 'b'; break;
7377 case S_IFREG: smode[0] = '-'; break;
7378 default: smode[0] = '?'; break;
7381 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7382 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7383 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7385 for (i = 0; i < 3; i++)
7387 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7392 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7393 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7394 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7395 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7396 (long)st.st_gid, st.st_size, (long)st.st_atime,
7397 (long)st.st_mtime, (long)st.st_ctime);
7398 yield = string_cat(yield, &size, &ptr, s);
7402 /* vaguely random number less than N */
7406 int_eximarith_t max;
7409 max = expanded_string_integer(sub, TRUE);
7410 if (expand_string_message != NULL)
7412 s = string_sprintf("%d", vaguely_random_number((int)max));
7413 yield = string_cat(yield, &size, &ptr, s);
7417 /* Reverse IP, including IPv6 to dotted-nibble */
7419 case EOP_REVERSE_IP:
7421 int family, maskptr;
7422 uschar reversed[128];
7424 family = string_is_ip_address(sub, &maskptr);
7427 expand_string_message = string_sprintf(
7428 "reverse_ip() not given an IP address [%s]", sub);
7431 invert_address(reversed, sub);
7432 yield = string_cat(yield, &size, &ptr, reversed);
7436 /* Unknown operator */
7439 expand_string_message =
7440 string_sprintf("unknown expansion operator \"%s\"", name);
7445 /* Handle a plain name. If this is the first thing in the expansion, release
7446 the pre-allocated buffer. If the result data is known to be in a new buffer,
7447 newsize will be set to the size of that buffer, and we can just point at that
7448 store instead of copying. Many expansion strings contain just one reference,
7449 so this is a useful optimization, especially for humungous headers
7450 ($message_headers). */
7458 if (resetok) store_reset(yield);
7462 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
7464 expand_string_message =
7465 string_sprintf("unknown variable in \"${%s}\"", name);
7466 check_variable_error_message(name);
7469 len = Ustrlen(value);
7470 if (!yield && newsize)
7477 yield = string_catn(yield, &size, &ptr, value, len);
7481 /* Else there's something wrong */
7483 expand_string_message =
7484 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7485 "in a variable reference)", name);
7489 /* If we hit the end of the string when ket_ends is set, there is a missing
7490 terminating brace. */
7492 if (ket_ends && *s == 0)
7494 expand_string_message = malformed_header?
7495 US"missing } at end of string - could be header name not terminated by colon"
7497 US"missing } at end of string";
7501 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7502 added to the string. If so, set up an empty string. Add a terminating zero. If
7503 left != NULL, return a pointer to the terminator. */
7505 if (yield == NULL) yield = store_get(1);
7507 if (left != NULL) *left = s;
7509 /* Any stacking store that was used above the final string is no longer needed.
7510 In many cases the final string will be the first one that was got and so there
7511 will be optimal store usage. */
7513 if (resetok) store_reset(yield + ptr + 1);
7514 else if (resetok_p) *resetok_p = FALSE;
7518 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
7519 "expanding: %.*s\n",
7520 (int)(s - string), string);
7521 debug_printf_indent("%s"
7522 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7524 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7527 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7528 "skipping: result is not used\n");
7533 /* This is the failure exit: easiest to program with a goto. We still need
7534 to update the pointer to the terminator, for cases of nested calls with "fail".
7537 EXPAND_FAILED_CURLY:
7538 if (malformed_header)
7539 expand_string_message =
7540 US"missing or misplaced { or } - could be header name not terminated by colon";
7542 else if (!expand_string_message || !*expand_string_message)
7543 expand_string_message = US"missing or misplaced { or }";
7545 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7546 that is a bad idea, because expand_string_message is in dynamic store. */
7549 if (left != NULL) *left = s;
7552 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
7554 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7555 "error message: %s\n",
7556 expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7557 expand_string_message);
7558 if (expand_string_forcedfail)
7559 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
7561 if (resetok_p) *resetok_p = resetok;
7567 /* This is the external function call. Do a quick check for any expansion
7568 metacharacters, and if there are none, just return the input string.
7570 Argument: the string to be expanded
7571 Returns: the expanded string, or NULL if expansion failed; if failure was
7572 due to a lookup deferring, search_find_defer will be TRUE
7576 expand_string(uschar *string)
7578 search_find_defer = FALSE;
7579 malformed_header = FALSE;
7580 return (Ustrpbrk(string, "$\\") == NULL)? string :
7581 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7587 expand_cstring(const uschar *string)
7589 search_find_defer = FALSE;
7590 malformed_header = FALSE;
7591 return (Ustrpbrk(string, "$\\") == NULL)? string :
7592 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7597 /*************************************************
7599 *************************************************/
7601 /* Now and again we want to expand a string and be sure that the result is in a
7602 new bit of store. This function does that.
7603 Since we know it has been copied, the de-const cast is safe.
7605 Argument: the string to be expanded
7606 Returns: the expanded string, always in a new bit of store, or NULL
7610 expand_string_copy(const uschar *string)
7612 const uschar *yield = expand_cstring(string);
7613 if (yield == string) yield = string_copy(string);
7619 /*************************************************
7620 * Expand and interpret as an integer *
7621 *************************************************/
7623 /* Expand a string, and convert the result into an integer.
7626 string the string to be expanded
7627 isplus TRUE if a non-negative number is expected
7629 Returns: the integer value, or
7630 -1 for an expansion error ) in both cases, message in
7631 -2 for an integer interpretation error ) expand_string_message
7632 expand_string_message is set NULL for an OK integer
7636 expand_string_integer(uschar *string, BOOL isplus)
7638 return expanded_string_integer(expand_string(string), isplus);
7642 /*************************************************
7643 * Interpret string as an integer *
7644 *************************************************/
7646 /* Convert a string (that has already been expanded) into an integer.
7648 This function is used inside the expansion code.
7651 s the string to be expanded
7652 isplus TRUE if a non-negative number is expected
7654 Returns: the integer value, or
7655 -1 if string is NULL (which implies an expansion error)
7656 -2 for an integer interpretation error
7657 expand_string_message is set NULL for an OK integer
7660 static int_eximarith_t
7661 expanded_string_integer(const uschar *s, BOOL isplus)
7663 int_eximarith_t value;
7664 uschar *msg = US"invalid integer \"%s\"";
7667 /* If expansion failed, expand_string_message will be set. */
7669 if (s == NULL) return -1;
7671 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7672 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7673 systems, so we set it zero ourselves. */
7676 expand_string_message = NULL; /* Indicates no error */
7678 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7679 equal to 0. Unfortunately, people actually relied upon that, so preserve
7680 the behaviour explicitly. Stripping leading whitespace is a harmless
7681 noop change since strtol skips it anyway (provided that there is a number
7685 while (isspace(*s)) ++s;
7689 debug_printf_indent("treating blank string as number 0\n");
7694 value = strtoll(CS s, CSS &endptr, 10);
7698 msg = US"integer expected but \"%s\" found";
7700 else if (value < 0 && isplus)
7702 msg = US"non-negative integer expected but \"%s\" found";
7706 switch (tolower(*endptr))
7711 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7716 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7717 else value *= 1024*1024;
7721 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7722 else value *= 1024*1024*1024;
7726 if (errno == ERANGE)
7727 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7730 while (isspace(*endptr)) endptr++;
7731 if (*endptr == 0) return value;
7735 expand_string_message = string_sprintf(CS msg, s);
7740 /* These values are usually fixed boolean values, but they are permitted to be
7744 addr address being routed
7745 mtype the module type
7746 mname the module name
7747 dbg_opt debug selectors
7748 oname the option name
7749 bvalue the router's boolean value
7750 svalue the router's string value
7751 rvalue where to put the returned value
7753 Returns: OK value placed in rvalue
7754 DEFER expansion failed
7758 exp_bool(address_item *addr,
7759 uschar *mtype, uschar *mname, unsigned dbg_opt,
7760 uschar *oname, BOOL bvalue,
7761 uschar *svalue, BOOL *rvalue)
7764 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7766 expanded = expand_string(svalue);
7767 if (expanded == NULL)
7769 if (expand_string_forcedfail)
7771 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7775 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7776 oname, mname, mtype, expand_string_message);
7777 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7781 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7784 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7786 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7790 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7791 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7800 /* Avoid potentially exposing a password in a string about to be logged */
7803 expand_hide_passwords(uschar * s)
7805 return ( ( Ustrstr(s, "failed to expand") != NULL
7806 || Ustrstr(s, "expansion of ") != NULL
7808 && ( Ustrstr(s, "mysql") != NULL
7809 || Ustrstr(s, "pgsql") != NULL
7810 || Ustrstr(s, "redis") != NULL
7811 || Ustrstr(s, "sqlite") != NULL
7812 || Ustrstr(s, "ldap:") != NULL
7813 || Ustrstr(s, "ldaps:") != NULL
7814 || Ustrstr(s, "ldapi:") != NULL
7815 || Ustrstr(s, "ldapdn:") != NULL
7816 || Ustrstr(s, "ldapm:") != NULL
7818 ? US"Temporary internal error" : s;
7823 /*************************************************
7824 * Error-checking for testsuite *
7825 *************************************************/
7827 const char * filename;
7829 uschar * region_start;
7830 uschar * region_end;
7831 const uschar *var_name;
7832 const uschar *var_data;
7836 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
7839 if (var_data >= e->region_start && var_data < e->region_end)
7841 e->var_name = CUS var_name;
7842 e->var_data = CUS var_data;
7847 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
7849 err_ctx e = {filename, linenumber, ptr, US ptr + len, NULL };
7853 /* check acl_ variables */
7854 tree_walk(acl_var_c, assert_variable_notin, &e);
7855 tree_walk(acl_var_m, assert_variable_notin, &e);
7857 /* check auth<n> variables */
7858 for (i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
7859 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
7861 /* check regex<n> variables */
7862 for (i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
7863 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
7865 /* check known-name variables */
7866 for (v = var_table; v < var_table + var_table_size; v++)
7867 if (v->type == vtype_stringptr)
7868 assert_variable_notin(US v->name, *(USS v->value), &e);
7871 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
7872 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
7873 e.var_name, e.filename, e.linenumber, e.var_data);
7878 /*************************************************
7879 **************************************************
7880 * Stand-alone test program *
7881 **************************************************
7882 *************************************************/
7888 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7890 int ovector[3*(EXPAND_MAXN+1)];
7891 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7892 ovector, nelem(ovector));
7893 BOOL yield = n >= 0;
7894 if (n == 0) n = EXPAND_MAXN + 1;
7898 expand_nmax = (setup < 0)? 0 : setup + 1;
7899 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7901 expand_nstring[expand_nmax] = subject + ovector[nn];
7902 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7910 int main(int argc, uschar **argv)
7913 uschar buffer[1024];
7915 debug_selector = D_v;
7916 debug_file = stderr;
7917 debug_fd = fileno(debug_file);
7918 big_buffer = malloc(big_buffer_size);
7920 for (i = 1; i < argc; i++)
7922 if (argv[i][0] == '+')
7924 debug_trace_memory = 2;
7927 if (isdigit(argv[i][0]))
7928 debug_selector = Ustrtol(argv[i], NULL, 0);
7930 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7934 eldap_default_servers = argv[i];
7937 mysql_servers = argv[i];
7940 pgsql_servers = argv[i];
7943 redis_servers = argv[i];
7947 else opt_perl_startup = argv[i];
7951 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7953 expand_nstring[1] = US"string 1....";
7954 expand_nlength[1] = 8;
7958 if (opt_perl_startup != NULL)
7961 printf("Starting Perl interpreter\n");
7962 errstr = init_perl(opt_perl_startup);
7965 printf("** error in perl_startup code: %s\n", errstr);
7966 return EXIT_FAILURE;
7969 #endif /* EXIM_PERL */
7971 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7973 void *reset_point = store_get(0);
7974 uschar *yield = expand_string(buffer);
7977 printf("%s\n", yield);
7978 store_reset(reset_point);
7982 if (search_find_defer) printf("search_find deferred\n");
7983 printf("Failed: %s\n", expand_string_message);
7984 if (expand_string_forcedfail) printf("Forced failure\n");
7998 /* End of expand.c */