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. */
1672 if (!enable_dollar_recipients) return NULL;
1674 for (i = 0; i < recipients_count; i++)
1676 /*XXX variant of list_appendele? */
1677 if (i != 0) g = string_catn(g, US", ", 2);
1678 g = string_cat(g, recipients_list[i].address);
1680 return string_from_gstring(g);
1684 /*************************************************
1685 * Find value of a variable *
1686 *************************************************/
1688 /* The table of variables is kept in alphabetic order, so we can search it
1689 using a binary chop. The "choplen" variable is nothing to do with the binary
1693 name the name of the variable being sought
1694 exists_only TRUE if this is a def: test; passed on to find_header()
1695 skipping TRUE => skip any processing evaluation; this is not the same as
1696 exists_only because def: may test for values that are first
1698 newsize pointer to an int which is initially zero; if the answer is in
1699 a new memory buffer, *newsize is set to its size
1701 Returns: NULL if the variable does not exist, or
1702 a pointer to the variable's contents, or
1703 something non-NULL if exists_only is TRUE
1707 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1714 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1715 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1716 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1717 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1718 (this gave backwards compatibility at the changeover). There may be built-in
1719 variables whose names start acl_ but they should never start in this way. This
1720 slightly messy specification is a consequence of the history, needless to say.
1722 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1723 set, in which case give an error. */
1725 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1729 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1730 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1733 /* Handle $auth<n> variables. */
1735 if (Ustrncmp(name, "auth", 4) == 0)
1738 int n = Ustrtoul(name + 4, &endptr, 10);
1739 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1740 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1742 else if (Ustrncmp(name, "regex", 5) == 0)
1745 int n = Ustrtoul(name + 5, &endptr, 10);
1746 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1747 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1750 /* For all other variables, search the table */
1752 if (!(vp = find_var_ent(name)))
1753 return NULL; /* Unknown variable name */
1755 /* Found an existing variable. If in skipping state, the value isn't needed,
1756 and we want to avoid processing (such as looking up the host name). */
1764 case vtype_filter_int:
1765 if (!filter_running) return NULL;
1769 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1773 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1777 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1781 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1785 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1788 case vtype_stringptr: /* Pointer to string */
1789 return (s = *((uschar **)(val))) ? s : US"";
1792 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1795 case vtype_load_avg:
1796 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1799 case vtype_host_lookup: /* Lookup if not done so */
1800 if (sender_host_name == NULL && sender_host_address != NULL &&
1801 !host_lookup_failed && host_name_lookup() == OK)
1802 host_build_sender_fullhost();
1803 return (sender_host_name == NULL)? US"" : sender_host_name;
1805 case vtype_localpart: /* Get local part from address */
1806 s = *((uschar **)(val));
1807 if (s == NULL) return US"";
1808 domain = Ustrrchr(s, '@');
1809 if (domain == NULL) return s;
1810 if (domain - s > sizeof(var_buffer) - 1)
1811 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1812 " in string expansion", sizeof(var_buffer));
1813 Ustrncpy(var_buffer, s, domain - s);
1814 var_buffer[domain - s] = 0;
1817 case vtype_domain: /* Get domain from address */
1818 s = *((uschar **)(val));
1819 if (s == NULL) return US"";
1820 domain = Ustrrchr(s, '@');
1821 return (domain == NULL)? US"" : domain + 1;
1823 case vtype_msgheaders:
1824 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1826 case vtype_msgheaders_raw:
1827 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1829 case vtype_msgbody: /* Pointer to msgbody string */
1830 case vtype_msgbody_end: /* Ditto, the end of the msg */
1831 ss = (uschar **)(val);
1832 if (!*ss && deliver_datafile >= 0) /* Read body when needed */
1835 off_t start_offset = SPOOL_DATA_START_OFFSET;
1836 int len = message_body_visible;
1837 if (len > message_size) len = message_size;
1838 *ss = body = store_malloc(len+1);
1840 if (vp->type == vtype_msgbody_end)
1842 struct stat statbuf;
1843 if (fstat(deliver_datafile, &statbuf) == 0)
1845 start_offset = statbuf.st_size - len;
1846 if (start_offset < SPOOL_DATA_START_OFFSET)
1847 start_offset = SPOOL_DATA_START_OFFSET;
1850 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1851 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1853 len = read(deliver_datafile, body, len);
1857 if (message_body_newlines) /* Separate loops for efficiency */
1859 { if (body[--len] == 0) body[len] = ' '; }
1862 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1865 return *ss ? *ss : US"";
1867 case vtype_todbsdin: /* BSD inbox time of day */
1868 return tod_stamp(tod_bsdin);
1870 case vtype_tode: /* Unix epoch time of day */
1871 return tod_stamp(tod_epoch);
1873 case vtype_todel: /* Unix epoch/usec time of day */
1874 return tod_stamp(tod_epoch_l);
1876 case vtype_todf: /* Full time of day */
1877 return tod_stamp(tod_full);
1879 case vtype_todl: /* Log format time of day */
1880 return tod_stamp(tod_log_bare); /* (without timezone) */
1882 case vtype_todzone: /* Time zone offset only */
1883 return tod_stamp(tod_zone);
1885 case vtype_todzulu: /* Zulu time */
1886 return tod_stamp(tod_zulu);
1888 case vtype_todlf: /* Log file datestamp tod */
1889 return tod_stamp(tod_log_datestamp_daily);
1891 case vtype_reply: /* Get reply address */
1892 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1894 if (s != NULL) while (isspace(*s)) s++;
1895 if (s == NULL || *s == 0)
1897 *newsize = 0; /* For the *s==0 case */
1898 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1903 while (isspace(*s)) s++;
1904 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1905 while (t > s && isspace(t[-1])) t--;
1908 return (s == NULL)? US"" : s;
1910 case vtype_string_func:
1912 uschar * (*fn)() = val;
1919 sprintf(CS var_buffer, "%d",
1920 receive_statvfs(val == (void *)TRUE, &inodes));
1927 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1928 sprintf(CS var_buffer, "%d", inodes);
1933 return *(void **)val ? US"<cert>" : US"";
1935 #ifndef DISABLE_DKIM
1937 return dkim_exim_expand_query((int)(long)val);
1942 return NULL; /* Unknown variable. Silences static checkers. */
1949 modify_variable(uschar *name, void * value)
1952 if ((vp = find_var_ent(name))) vp->value = value;
1953 return; /* Unknown variable name, fail silently */
1961 /*************************************************
1962 * Read and expand substrings *
1963 *************************************************/
1965 /* This function is called to read and expand argument substrings for various
1966 expansion items. Some have a minimum requirement that is less than the maximum;
1967 in these cases, the first non-present one is set to NULL.
1970 sub points to vector of pointers to set
1971 n maximum number of substrings
1973 sptr points to current string pointer
1974 skipping the skipping flag
1975 check_end if TRUE, check for final '}'
1976 name name of item, for error message
1977 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1980 Returns: 0 OK; string pointer updated
1981 1 curly bracketing error (too few arguments)
1982 2 too many arguments (only if check_end is set); message set
1983 3 other error (expansion failure)
1987 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1988 BOOL check_end, uschar *name, BOOL *resetok)
1991 const uschar *s = *sptr;
1993 while (isspace(*s)) s++;
1994 for (i = 0; i < n; i++)
2000 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2001 "(min is %d)", name, m);
2007 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2009 if (*s++ != '}') return 1;
2010 while (isspace(*s)) s++;
2012 if (check_end && *s++ != '}')
2016 expand_string_message = string_sprintf("Too many arguments for '%s' "
2017 "(max is %d)", name, n);
2020 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2031 /*************************************************
2032 * Elaborate message for bad variable *
2033 *************************************************/
2035 /* For the "unknown variable" message, take a look at the variable's name, and
2036 give additional information about possible ACL variables. The extra information
2037 is added on to expand_string_message.
2039 Argument: the name of the variable
2044 check_variable_error_message(uschar *name)
2046 if (Ustrncmp(name, "acl_", 4) == 0)
2047 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2048 (name[4] == 'c' || name[4] == 'm')?
2050 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2051 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2053 US"user-defined ACL variables must start acl_c or acl_m");
2059 Load args from sub array to globals, and call acl_check().
2060 Sub array will be corrupted on return.
2062 Returns: OK access is granted by an ACCEPT verb
2063 DISCARD access is (apparently) granted by a DISCARD verb
2064 FAIL access is denied
2065 FAIL_DROP access is denied; drop the connection
2066 DEFER can't tell at the moment
2070 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2073 int sav_narg = acl_narg;
2075 uschar * dummy_logmsg;
2076 extern int acl_where;
2078 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2079 for (i = 0; i < nsub && sub[i+1]; i++)
2081 uschar * tmp = acl_arg[i];
2082 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2083 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2088 sub[i+1] = acl_arg[i];
2089 acl_arg[i++] = NULL;
2093 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2095 acl_narg>0 ? acl_arg[0] : US"<none>",
2096 acl_narg>1 ? " +more" : "");
2098 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2100 for (i = 0; i < nsub; i++)
2101 acl_arg[i] = sub[i+1]; /* restore old args */
2102 acl_narg = sav_narg;
2110 /*************************************************
2111 * Read and evaluate a condition *
2112 *************************************************/
2116 s points to the start of the condition text
2117 resetok points to a BOOL which is written false if it is unsafe to
2118 free memory. Certain condition types (acl) may have side-effect
2119 allocation which must be preserved.
2120 yield points to a BOOL to hold the result of the condition test;
2121 if NULL, we are just reading through a condition that is
2122 part of an "or" combination to check syntax, or in a state
2123 where the answer isn't required
2125 Returns: a pointer to the first character after the condition, or
2129 static const uschar *
2130 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2132 BOOL testfor = TRUE;
2133 BOOL tempcond, combined_cond;
2135 BOOL sub2_honour_dollar = TRUE;
2136 int i, rc, cond_type, roffset;
2137 int_eximarith_t num[2];
2138 struct stat statbuf;
2140 const uschar *sub[10];
2143 const uschar *rerror;
2147 while (isspace(*s)) s++;
2148 if (*s == '!') { testfor = !testfor; s++; } else break;
2151 /* Numeric comparisons are symbolic */
2153 if (*s == '=' || *s == '>' || *s == '<')
2165 /* All other conditions are named */
2167 else s = read_name(name, 256, s, US"_");
2169 /* If we haven't read a name, it means some non-alpha character is first. */
2173 expand_string_message = string_sprintf("condition name expected, "
2174 "but found \"%.16s\"", s);
2178 /* Find which condition we are dealing with, and switch on it */
2180 cond_type = chop_match(name, cond_table, nelem(cond_table));
2183 /* def: tests for a non-empty variable, or for the existence of a header. If
2184 yield == NULL we are in a skipping state, and don't care about the answer. */
2189 expand_string_message = US"\":\" expected after \"def\"";
2193 s = read_name(name, 256, s+1, US"_");
2195 /* Test for a header's existence. If the name contains a closing brace
2196 character, this may be a user error where the terminating colon has been
2197 omitted. Set a flag to adjust a subsequent error message in this case. */
2199 if (Ustrncmp(name, "h_", 2) == 0 ||
2200 Ustrncmp(name, "rh_", 3) == 0 ||
2201 Ustrncmp(name, "bh_", 3) == 0 ||
2202 Ustrncmp(name, "header_", 7) == 0 ||
2203 Ustrncmp(name, "rheader_", 8) == 0 ||
2204 Ustrncmp(name, "bheader_", 8) == 0)
2206 s = read_header_name(name, 256, s);
2207 /* {-for-text-editors */
2208 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2209 if (yield != NULL) *yield =
2210 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2213 /* Test for a variable's having a non-empty value. A non-existent variable
2214 causes an expansion failure. */
2218 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2221 expand_string_message = (name[0] == 0)?
2222 string_sprintf("variable name omitted after \"def:\"") :
2223 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2224 check_variable_error_message(name);
2227 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2233 /* first_delivery tests for first delivery attempt */
2235 case ECOND_FIRST_DELIVERY:
2236 if (yield != NULL) *yield = deliver_firsttime == testfor;
2240 /* queue_running tests for any process started by a queue runner */
2242 case ECOND_QUEUE_RUNNING:
2243 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2247 /* exists: tests for file existence
2248 isip: tests for any IP address
2249 isip4: tests for an IPv4 address
2250 isip6: tests for an IPv6 address
2251 pam: does PAM authentication
2252 radius: does RADIUS authentication
2253 ldapauth: does LDAP authentication
2254 pwcheck: does Cyrus SASL pwcheck authentication
2263 case ECOND_LDAPAUTH:
2266 while (isspace(*s)) s++;
2267 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2269 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2270 if (sub[0] == NULL) return NULL;
2271 /* {-for-text-editors */
2272 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2274 if (yield == NULL) return s; /* No need to run the test if skipping */
2279 if ((expand_forbid & RDO_EXISTS) != 0)
2281 expand_string_message = US"File existence tests are not permitted";
2284 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2290 rc = string_is_ip_address(sub[0], NULL);
2291 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2292 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2295 /* Various authentication tests - all optionally compiled */
2299 rc = auth_call_pam(sub[0], &expand_string_message);
2302 goto COND_FAILED_NOT_COMPILED;
2303 #endif /* SUPPORT_PAM */
2306 #ifdef RADIUS_CONFIG_FILE
2307 rc = auth_call_radius(sub[0], &expand_string_message);
2310 goto COND_FAILED_NOT_COMPILED;
2311 #endif /* RADIUS_CONFIG_FILE */
2313 case ECOND_LDAPAUTH:
2316 /* Just to keep the interface the same */
2318 int old_pool = store_pool;
2319 store_pool = POOL_SEARCH;
2320 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2321 &expand_string_message, &do_cache);
2322 store_pool = old_pool;
2326 goto COND_FAILED_NOT_COMPILED;
2327 #endif /* LOOKUP_LDAP */
2330 #ifdef CYRUS_PWCHECK_SOCKET
2331 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2334 goto COND_FAILED_NOT_COMPILED;
2335 #endif /* CYRUS_PWCHECK_SOCKET */
2337 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2338 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2340 if (rc == ERROR || rc == DEFER) return NULL;
2341 *yield = (rc == OK) == testfor;
2347 /* call ACL (in a conditional context). Accept true, deny false.
2348 Defer is a forced-fail. Anything set by message= goes to $value.
2349 Up to ten parameters are used; we use the braces round the name+args
2350 like the saslauthd condition does, to permit a variable number of args.
2351 See also the expansion-item version EITEM_ACL and the traditional
2352 acl modifier ACLC_ACL.
2353 Since the ACL may allocate new global variables, tell our caller to not
2358 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2364 while (isspace(*s)) s++;
2365 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2367 switch(read_subs(sub, nelem(sub), 1,
2368 &s, yield == NULL, TRUE, US"acl", resetok))
2370 case 1: expand_string_message = US"too few arguments or bracketing "
2373 case 3: return NULL;
2378 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2379 switch(eval_acl(sub, nelem(sub), &user_msg))
2384 lookup_value = NULL;
2386 lookup_value = string_copy(user_msg);
2387 *yield = cond == testfor;
2391 expand_string_forcedfail = TRUE;
2394 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2402 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2404 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2406 However, the last two are optional. That is why the whole set is enclosed
2407 in their own set of braces. */
2409 case ECOND_SASLAUTHD:
2410 #ifndef CYRUS_SASLAUTHD_SOCKET
2411 goto COND_FAILED_NOT_COMPILED;
2415 while (isspace(*s)) s++;
2416 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2417 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2420 case 1: expand_string_message = US"too few arguments or bracketing "
2421 "error for saslauthd";
2423 case 3: return NULL;
2425 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2428 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2429 &expand_string_message);
2430 if (rc == ERROR || rc == DEFER) return NULL;
2431 *yield = (rc == OK) == testfor;
2435 #endif /* CYRUS_SASLAUTHD_SOCKET */
2438 /* symbolic operators for numeric and string comparison, and a number of
2439 other operators, all requiring two arguments.
2441 crypteq: encrypts plaintext and compares against an encrypted text,
2442 using crypt(), crypt16(), MD5 or SHA-1
2443 inlist/inlisti: checks if first argument is in the list of the second
2444 match: does a regular expression match and sets up the numerical
2445 variables if it succeeds
2446 match_address: matches in an address list
2447 match_domain: matches in a domain list
2448 match_ip: matches a host list that is restricted to IP addresses
2449 match_local_part: matches in a local part list
2452 case ECOND_MATCH_ADDRESS:
2453 case ECOND_MATCH_DOMAIN:
2454 case ECOND_MATCH_IP:
2455 case ECOND_MATCH_LOCAL_PART:
2456 #ifndef EXPAND_LISTMATCH_RHS
2457 sub2_honour_dollar = FALSE;
2466 case ECOND_NUM_L: /* Numerical comparisons */
2473 case ECOND_STR_LT: /* String comparisons */
2484 for (i = 0; i < 2; i++)
2486 /* Sometimes, we don't expand substrings; too many insecure configurations
2487 created using match_address{}{} and friends, where the second param
2488 includes information from untrustworthy sources. */
2489 BOOL honour_dollar = TRUE;
2490 if ((i > 0) && !sub2_honour_dollar)
2491 honour_dollar = FALSE;
2493 while (isspace(*s)) s++;
2496 if (i == 0) goto COND_FAILED_CURLY_START;
2497 expand_string_message = string_sprintf("missing 2nd string in {} "
2498 "after \"%s\"", name);
2501 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2502 honour_dollar, resetok);
2503 if (sub[i] == NULL) return NULL;
2504 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2506 /* Convert to numerical if required; we know that the names of all the
2507 conditions that compare numbers do not start with a letter. This just saves
2508 checking for them individually. */
2510 if (!isalpha(name[0]) && yield != NULL)
2515 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2519 num[i] = expanded_string_integer(sub[i], FALSE);
2520 if (expand_string_message != NULL) return NULL;
2524 /* Result not required */
2526 if (yield == NULL) return s;
2528 /* Do an appropriate comparison */
2534 tempcond = (num[0] == num[1]);
2538 tempcond = (num[0] > num[1]);
2542 tempcond = (num[0] >= num[1]);
2546 tempcond = (num[0] < num[1]);
2550 tempcond = (num[0] <= num[1]);
2554 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2558 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2562 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2566 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2570 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2574 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2578 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2582 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2586 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2590 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2593 case ECOND_MATCH: /* Regular expression match */
2594 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2598 expand_string_message = string_sprintf("regular expression error in "
2599 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2602 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2605 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2606 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2607 goto MATCHED_SOMETHING;
2609 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2610 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2611 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2612 goto MATCHED_SOMETHING;
2614 case ECOND_MATCH_IP: /* Match IP address in a host list */
2615 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2617 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2623 unsigned int *nullcache = NULL;
2624 check_host_block cb;
2626 cb.host_name = US"";
2627 cb.host_address = sub[0];
2629 /* If the host address starts off ::ffff: it is an IPv6 address in
2630 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2633 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2634 cb.host_address + 7 : cb.host_address;
2636 rc = match_check_list(
2637 &sub[1], /* the list */
2638 0, /* separator character */
2639 &hostlist_anchor, /* anchor pointer */
2640 &nullcache, /* cache pointer */
2641 check_host, /* function for testing */
2642 &cb, /* argument for function */
2643 MCL_HOST, /* type of check */
2644 sub[0], /* text for debugging */
2645 NULL); /* where to pass back data */
2647 goto MATCHED_SOMETHING;
2649 case ECOND_MATCH_LOCAL_PART:
2650 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2651 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2666 expand_string_message = string_sprintf("unable to complete match "
2667 "against \"%s\": %s", sub[1], search_error_message);
2673 /* Various "encrypted" comparisons. If the second string starts with
2674 "{" then an encryption type is given. Default to crypt() or crypt16()
2675 (build-time choice). */
2676 /* }-for-text-editors */
2679 #ifndef SUPPORT_CRYPTEQ
2680 goto COND_FAILED_NOT_COMPILED;
2682 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2684 int sublen = Ustrlen(sub[1]+5);
2689 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2691 /* If the length that we are comparing against is 24, the MD5 digest
2692 is expressed as a base64 string. This is the way LDAP does it. However,
2693 some other software uses a straightforward hex representation. We assume
2694 this if the length is 32. Other lengths fail. */
2698 uschar *coded = b64encode(digest, 16);
2699 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2700 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2701 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2703 else if (sublen == 32)
2707 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2709 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2710 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2711 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2715 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2716 "fail\n crypted=%s\n", sub[1]+5);
2721 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2723 int sublen = Ustrlen(sub[1]+6);
2728 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2730 /* If the length that we are comparing against is 28, assume the SHA1
2731 digest is expressed as a base64 string. If the length is 40, assume a
2732 straightforward hex representation. Other lengths fail. */
2736 uschar *coded = b64encode(digest, 20);
2737 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2738 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2739 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2741 else if (sublen == 40)
2745 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2747 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2748 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2749 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2753 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2754 "fail\n crypted=%s\n", sub[1]+6);
2759 else /* {crypt} or {crypt16} and non-{ at start */
2760 /* }-for-text-editors */
2765 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2770 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2775 else if (sub[1][0] == '{') /* }-for-text-editors */
2777 expand_string_message = string_sprintf("unknown encryption mechanism "
2778 "in \"%s\"", sub[1]);
2784 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2785 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2786 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2790 #define XSTR(s) STR(s)
2791 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2792 " subject=%s\n crypted=%s\n",
2793 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2798 /* If the encrypted string contains fewer than two characters (for the
2799 salt), force failure. Otherwise we get false positives: with an empty
2800 string the yield of crypt() is an empty string! */
2803 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2804 else if (errno == EINVAL)
2808 expand_string_message = string_sprintf("crypt error: %s\n",
2809 US strerror(errno));
2814 #endif /* SUPPORT_CRYPTEQ */
2819 const uschar * list = sub[1];
2821 uschar *save_iterate_item = iterate_item;
2822 int (*compare)(const uschar *, const uschar *);
2824 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2827 compare = cond_type == ECOND_INLISTI
2828 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2830 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2831 if (compare(sub[0], iterate_item) == 0)
2836 iterate_item = save_iterate_item;
2839 } /* Switch for comparison conditions */
2841 *yield = tempcond == testfor;
2842 return s; /* End of comparison conditions */
2845 /* and/or: computes logical and/or of several conditions */
2849 subcondptr = (yield == NULL)? NULL : &tempcond;
2850 combined_cond = (cond_type == ECOND_AND);
2852 while (isspace(*s)) s++;
2853 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2857 while (isspace(*s)) s++;
2858 /* {-for-text-editors */
2859 if (*s == '}') break;
2860 if (*s != '{') /* }-for-text-editors */
2862 expand_string_message = string_sprintf("each subcondition "
2863 "inside an \"%s{...}\" condition must be in its own {}", name);
2867 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2869 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2870 expand_string_message, name);
2873 while (isspace(*s)) s++;
2875 /* {-for-text-editors */
2878 /* {-for-text-editors */
2879 expand_string_message = string_sprintf("missing } at end of condition "
2880 "inside \"%s\" group", name);
2886 if (cond_type == ECOND_AND)
2888 combined_cond &= tempcond;
2889 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2890 } /* evaluate any more */
2893 combined_cond |= tempcond;
2894 if (combined_cond) subcondptr = NULL; /* once true, don't */
2895 } /* evaluate any more */
2899 if (yield != NULL) *yield = (combined_cond == testfor);
2903 /* forall/forany: iterates a condition with different values */
2908 const uschar * list;
2910 uschar *save_iterate_item = iterate_item;
2912 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2914 while (isspace(*s)) s++;
2915 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2916 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2917 if (sub[0] == NULL) return NULL;
2918 /* {-for-text-editors */
2919 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2921 while (isspace(*s)) s++;
2922 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2926 /* Call eval_condition once, with result discarded (as if scanning a
2927 "false" part). This allows us to find the end of the condition, because if
2928 the list it empty, we won't actually evaluate the condition for real. */
2930 if (!(s = eval_condition(sub[1], resetok, NULL)))
2932 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2933 expand_string_message, name);
2936 while (isspace(*s)) s++;
2938 /* {-for-text-editors */
2941 /* {-for-text-editors */
2942 expand_string_message = string_sprintf("missing } at end of condition "
2943 "inside \"%s\"", name);
2947 if (yield != NULL) *yield = !testfor;
2949 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2951 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, iterate_item);
2952 if (!eval_condition(sub[1], resetok, &tempcond))
2954 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2955 expand_string_message, name);
2956 iterate_item = save_iterate_item;
2959 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", name,
2960 tempcond? "true":"false");
2962 if (yield != NULL) *yield = (tempcond == testfor);
2963 if (tempcond == (cond_type == ECOND_FORANY)) break;
2966 iterate_item = save_iterate_item;
2971 /* The bool{} expansion condition maps a string to boolean.
2972 The values supported should match those supported by the ACL condition
2973 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2974 of true/false. Note that Router "condition" rules have a different
2975 interpretation, where general data can be used and only a few values
2977 Note that readconf.c boolean matching, for boolean configuration options,
2978 only matches true/yes/false/no.
2979 The bool_lax{} condition matches the Router logic, which is much more
2982 case ECOND_BOOL_LAX:
2988 BOOL boolvalue = FALSE;
2989 while (isspace(*s)) s++;
2990 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2991 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2992 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2994 case 1: expand_string_message = string_sprintf(
2995 "too few arguments or bracketing error for %s",
2999 case 3: return NULL;
3002 while (isspace(*t)) t++;
3006 /* trailing whitespace: seems like a good idea to ignore it too */
3008 while (isspace(*t2)) t2--;
3009 if (t2 != (t + len))
3016 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3017 /* logic for the lax case from expand_check_condition(), which also does
3018 expands, and the logic is both short and stable enough that there should
3019 be no maintenance burden from replicating it. */
3023 ? Ustrspn(t+1, "0123456789") == len-1
3024 : Ustrspn(t, "0123456789") == len)
3026 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3027 /* expand_check_condition only does a literal string "0" check */
3028 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3031 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3033 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3035 else if (cond_type == ECOND_BOOL_LAX)
3039 expand_string_message = string_sprintf("unrecognised boolean "
3043 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3044 boolvalue? "true":"false");
3045 if (yield != NULL) *yield = (boolvalue == testfor);
3049 /* Unknown condition */
3052 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3054 } /* End switch on condition type */
3056 /* Missing braces at start and end of data */
3058 COND_FAILED_CURLY_START:
3059 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3062 COND_FAILED_CURLY_END:
3063 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3067 /* A condition requires code that is not compiled */
3069 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3070 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3071 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3072 COND_FAILED_NOT_COMPILED:
3073 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3082 /*************************************************
3083 * Save numerical variables *
3084 *************************************************/
3086 /* This function is called from items such as "if" that want to preserve and
3087 restore the numbered variables.
3090 save_expand_string points to an array of pointers to set
3091 save_expand_nlength points to an array of ints for the lengths
3093 Returns: the value of expand max to save
3097 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3100 for (i = 0; i <= expand_nmax; i++)
3102 save_expand_nstring[i] = expand_nstring[i];
3103 save_expand_nlength[i] = expand_nlength[i];
3110 /*************************************************
3111 * Restore numerical variables *
3112 *************************************************/
3114 /* This function restored saved values of numerical strings.
3117 save_expand_nmax the number of strings to restore
3118 save_expand_string points to an array of pointers
3119 save_expand_nlength points to an array of ints
3125 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3126 int *save_expand_nlength)
3129 expand_nmax = save_expand_nmax;
3130 for (i = 0; i <= expand_nmax; i++)
3132 expand_nstring[i] = save_expand_nstring[i];
3133 expand_nlength[i] = save_expand_nlength[i];
3141 /*************************************************
3142 * Handle yes/no substrings *
3143 *************************************************/
3145 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3146 alternative substrings that depend on whether or not the condition was true,
3147 or the lookup or extraction succeeded. The substrings always have to be
3148 expanded, to check their syntax, but "skipping" is set when the result is not
3149 needed - this avoids unnecessary nested lookups.
3152 skipping TRUE if we were skipping when this item was reached
3153 yes TRUE if the first string is to be used, else use the second
3154 save_lookup a value to put back into lookup_value before the 2nd expansion
3155 sptr points to the input string pointer
3156 yieldptr points to the output growable-string pointer
3157 type "lookup", "if", "extract", "run", "env", "listextract" or
3158 "certextract" for error message
3159 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3162 Returns: 0 OK; lookup_value has been reset to save_lookup
3164 2 expansion failed because of bracketing error
3168 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3169 gstring ** yieldptr, uschar *type, BOOL *resetok)
3172 const uschar *s = *sptr; /* Local value */
3173 uschar *sub1, *sub2;
3174 const uschar * errwhere;
3176 /* If there are no following strings, we substitute the contents of $value for
3177 lookups and for extractions in the success case. For the ${if item, the string
3178 "true" is substituted. In the fail case, nothing is substituted for all three
3181 while (isspace(*s)) s++;
3186 if (yes && !skipping)
3187 *yieldptr = string_catn(*yieldptr, US"true", 4);
3191 if (yes && lookup_value && !skipping)
3192 *yieldptr = string_cat(*yieldptr, lookup_value);
3193 lookup_value = save_lookup;
3199 /* The first following string must be braced. */
3203 errwhere = US"'yes' part did not start with '{'";
3207 /* Expand the first substring. Forced failures are noticed only if we actually
3208 want this string. Set skipping in the call in the fail case (this will always
3209 be the case if we were already skipping). */
3211 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3212 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3213 expand_string_forcedfail = FALSE;
3216 errwhere = US"'yes' part did not end with '}'";
3220 /* If we want the first string, add it to the output */
3223 *yieldptr = string_cat(*yieldptr, sub1);
3225 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3226 $value to what it was at the start of the item, so that it has this value
3227 during the second string expansion. For the call from "if" or "run" to this
3228 function, save_lookup is set to lookup_value, so that this statement does
3231 lookup_value = save_lookup;
3233 /* There now follows either another substring, or "fail", or nothing. This
3234 time, forced failures are noticed only if we want the second string. We must
3235 set skipping in the nested call if we don't want this string, or if we were
3236 already skipping. */
3238 while (isspace(*s)) s++;
3241 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3242 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3243 expand_string_forcedfail = FALSE;
3246 errwhere = US"'no' part did not start with '{'";
3250 /* If we want the second string, add it to the output */
3253 *yieldptr = string_cat(*yieldptr, sub2);
3256 /* If there is no second string, but the word "fail" is present when the use of
3257 the second string is wanted, set a flag indicating it was a forced failure
3258 rather than a syntactic error. Swallow the terminating } in case this is nested
3259 inside another lookup or if or extract. */
3264 /* deconst cast ok here as source is s anyway */
3265 s = US read_name(name, sizeof(name), s, US"_");
3266 if (Ustrcmp(name, "fail") == 0)
3268 if (!yes && !skipping)
3270 while (isspace(*s)) s++;
3273 errwhere = US"did not close with '}' after forcedfail";
3276 expand_string_message =
3277 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3278 expand_string_forcedfail = TRUE;
3284 expand_string_message =
3285 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3290 /* All we have to do now is to check on the final closing brace. */
3292 while (isspace(*s)) s++;
3295 errwhere = US"did not close with '}'";
3301 /* Update the input pointer value before returning */
3306 /* Get here if there is a bracketing failure */
3307 expand_string_message = string_sprintf(
3308 "curly-bracket problem in conditional yes/no parsing: %s\n"
3309 " remaining string is '%s'", errwhere, --s);
3314 /* Get here for other failures */
3322 /*************************************************
3323 * Handle MD5 or SHA-1 computation for HMAC *
3324 *************************************************/
3326 /* These are some wrapping functions that enable the HMAC code to be a bit
3327 cleaner. A good compiler will spot the tail recursion.
3330 type HMAC_MD5 or HMAC_SHA1
3331 remaining are as for the cryptographic hash functions
3337 chash_start(int type, void *base)
3339 if (type == HMAC_MD5)
3340 md5_start((md5 *)base);
3342 sha1_start((hctx *)base);
3346 chash_mid(int type, void *base, uschar *string)
3348 if (type == HMAC_MD5)
3349 md5_mid((md5 *)base, string);
3351 sha1_mid((hctx *)base, string);
3355 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3357 if (type == HMAC_MD5)
3358 md5_end((md5 *)base, string, length, digest);
3360 sha1_end((hctx *)base, string, length, digest);
3367 /********************************************************
3368 * prvs: Get last three digits of days since Jan 1, 1970 *
3369 ********************************************************/
3371 /* This is needed to implement the "prvs" BATV reverse
3374 Argument: integer "days" offset to add or substract to
3375 or from the current number of days.
3377 Returns: pointer to string containing the last three
3378 digits of the number of days since Jan 1, 1970,
3379 modified by the offset argument, NULL if there
3380 was an error in the conversion.
3385 prvs_daystamp(int day_offset)
3387 uschar *days = store_get(32); /* Need at least 24 for cases */
3388 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3389 (time(NULL) + day_offset*86400)/86400);
3390 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3395 /********************************************************
3396 * prvs: perform HMAC-SHA1 computation of prvs bits *
3397 ********************************************************/
3399 /* This is needed to implement the "prvs" BATV reverse
3403 address RFC2821 Address to use
3404 key The key to use (must be less than 64 characters
3406 key_num Single-digit key number to use. Defaults to
3409 Returns: pointer to string containing the first three
3410 bytes of the final hash in hex format, NULL if
3411 there was an error in the process.
3415 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3417 gstring * hash_source;
3421 uschar innerhash[20];
3422 uschar finalhash[20];
3423 uschar innerkey[64];
3424 uschar outerkey[64];
3425 uschar *finalhash_hex = store_get(40);
3427 if (key_num == NULL)
3430 if (Ustrlen(key) > 64)
3433 hash_source = string_catn(NULL, key_num, 1);
3434 hash_source = string_catn(hash_source, daystamp, 3);
3435 hash_source = string_cat(hash_source, address);
3436 (void) string_from_gstring(hash_source);
3439 debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3441 memset(innerkey, 0x36, 64);
3442 memset(outerkey, 0x5c, 64);
3444 for (i = 0; i < Ustrlen(key); i++)
3446 innerkey[i] ^= key[i];
3447 outerkey[i] ^= key[i];
3450 chash_start(HMAC_SHA1, &h);
3451 chash_mid(HMAC_SHA1, &h, innerkey);
3452 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3454 chash_start(HMAC_SHA1, &h);
3455 chash_mid(HMAC_SHA1, &h, outerkey);
3456 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3459 for (i = 0; i < 3; i++)
3461 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3462 *p++ = hex_digits[finalhash[i] & 0x0f];
3466 return finalhash_hex;
3472 /*************************************************
3473 * Join a file onto the output string *
3474 *************************************************/
3476 /* This is used for readfile/readsock and after a run expansion.
3477 It joins the contents of a file onto the output string, globally replacing
3478 newlines with a given string (optionally).
3482 yield pointer to the expandable string struct
3483 eol newline replacement string, or NULL
3485 Returns: new pointer for expandable string, terminated if non-null
3489 cat_file(FILE *f, gstring *yield, uschar *eol)
3491 uschar buffer[1024];
3493 while (Ufgets(buffer, sizeof(buffer), f))
3495 int len = Ustrlen(buffer);
3496 if (eol && buffer[len-1] == '\n') len--;
3497 yield = string_catn(yield, buffer, len);
3498 if (eol && buffer[len])
3499 yield = string_cat(yield, eol);
3502 (void) string_from_gstring(yield);
3509 /*************************************************
3510 * Evaluate numeric expression *
3511 *************************************************/
3513 /* This is a set of mutually recursive functions that evaluate an arithmetic
3514 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3515 these functions that is called from elsewhere is eval_expr, whose interface is:
3518 sptr pointer to the pointer to the string - gets updated
3519 decimal TRUE if numbers are to be assumed decimal
3520 error pointer to where to put an error message - must be NULL on input
3521 endket TRUE if ')' must terminate - FALSE for external call
3523 Returns: on success: the value of the expression, with *error still NULL
3524 on failure: an undefined value, with *error = a message
3527 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3530 static int_eximarith_t
3531 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3534 int_eximarith_t x = eval_op_or(&s, decimal, error);
3540 *error = US"expecting closing parenthesis";
3542 while (isspace(*(++s)));
3544 else if (*s != 0) *error = US"expecting operator";
3551 static int_eximarith_t
3552 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3557 while (isspace(*s)) s++;
3562 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3564 switch (tolower(*s))
3567 case 'k': n *= 1024; s++; break;
3568 case 'm': n *= 1024*1024; s++; break;
3569 case 'g': n *= 1024*1024*1024; s++; break;
3571 while (isspace (*s)) s++;
3576 n = eval_expr(&s, decimal, error, 1);
3580 *error = US"expecting number or opening parenthesis";
3588 static int_eximarith_t
3589 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3593 while (isspace(*s)) s++;
3594 if (*s == '+' || *s == '-' || *s == '~')
3597 x = eval_op_unary(&s, decimal, error);
3598 if (op == '-') x = -x;
3599 else if (op == '~') x = ~x;
3603 x = eval_number(&s, decimal, error);
3610 static int_eximarith_t
3611 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3614 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3617 while (*s == '*' || *s == '/' || *s == '%')
3620 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3621 if (*error != NULL) break;
3622 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3623 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3624 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3625 * -N*M is INT_MIN will yield INT_MIN.
3626 * Since we don't support floating point, this is somewhat simpler.
3627 * Ideally, we'd return an error, but since we overflow for all other
3628 * arithmetic, consistency suggests otherwise, but what's the correct value
3629 * to use? There is none.
3630 * The C standard guarantees overflow for unsigned arithmetic but signed
3631 * overflow invokes undefined behaviour; in practice, this is overflow
3632 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3633 * that long/longlong larger than int are available, or we could just work
3634 * with larger types. We should consider whether to guarantee 32bit eval
3635 * and 64-bit working variables, with errors returned. For now ...
3636 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3637 * can just let the other invalid results occur otherwise, as they have
3638 * until now. For this one case, we can coerce.
3640 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3643 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3644 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3654 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3670 static int_eximarith_t
3671 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3674 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3677 while (*s == '+' || *s == '-')
3680 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3682 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3683 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3684 { /* over-conservative check */
3686 ? US"overflow in sum" : US"overflow in difference";
3689 if (op == '+') x += y; else x -= y;
3697 static int_eximarith_t
3698 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3701 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3704 while ((*s == '<' || *s == '>') && s[1] == s[0])
3709 y = eval_op_sum(&s, decimal, error);
3710 if (*error != NULL) break;
3711 if (op == '<') x <<= y; else x >>= y;
3719 static int_eximarith_t
3720 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3723 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3730 y = eval_op_shift(&s, decimal, error);
3731 if (*error != NULL) break;
3740 static int_eximarith_t
3741 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3744 int_eximarith_t x = eval_op_and(&s, decimal, error);
3751 y = eval_op_and(&s, decimal, error);
3752 if (*error != NULL) break;
3761 static int_eximarith_t
3762 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3765 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3772 y = eval_op_xor(&s, decimal, error);
3773 if (*error != NULL) break;
3783 /*************************************************
3785 *************************************************/
3787 /* Returns either an unchanged string, or the expanded string in stacking pool
3788 store. Interpreted sequences are:
3790 \... normal escaping rules
3791 $name substitutes the variable
3793 ${op:string} operates on the expanded string value
3794 ${item{arg1}{arg2}...} expands the args and then does the business
3795 some literal args are not enclosed in {}
3797 There are now far too many operators and item types to make it worth listing
3798 them here in detail any more.
3800 We use an internal routine recursively to handle embedded substrings. The
3801 external function follows. The yield is NULL if the expansion failed, and there
3802 are two cases: if something collapsed syntactically, or if "fail" was given
3803 as the action on a lookup failure. These can be distinguished by looking at the
3804 variable expand_string_forcedfail, which is TRUE in the latter case.
3806 The skipping flag is set true when expanding a substring that isn't actually
3807 going to be used (after "if" or "lookup") and it prevents lookups from
3808 happening lower down.
3810 Store usage: At start, a store block of the length of the input plus 64
3811 is obtained. This is expanded as necessary by string_cat(), which might have to
3812 get a new block, or might be able to expand the original. At the end of the
3813 function we can release any store above that portion of the yield block that
3814 was actually used. In many cases this will be optimal.
3816 However: if the first item in the expansion is a variable name or header name,
3817 we reset the store before processing it; if the result is in fresh store, we
3818 use that without copying. This is helpful for expanding strings like
3819 $message_headers which can get very long.
3821 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3822 since resetting the store at the end of the expansion will free store that was
3823 allocated by the plugin code as well as the slop after the expanded string. So
3824 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3825 and, given the acl condition, ${if }. This is an unfortunate consequence of
3826 string expansion becoming too powerful.
3829 string the string to be expanded
3830 ket_ends true if expansion is to stop at }
3831 left if not NULL, a pointer to the first character after the
3832 expansion is placed here (typically used with ket_ends)
3833 skipping TRUE for recursive calls when the value isn't actually going
3834 to be used (to allow for optimisation)
3835 honour_dollar TRUE if $ is to be expanded,
3836 FALSE if it's just another character
3837 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3840 Returns: NULL if expansion fails:
3841 expand_string_forcedfail is set TRUE if failure was forced
3842 expand_string_message contains a textual error message
3843 a pointer to the expanded string on success
3847 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3848 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3850 gstring * yield = string_get(Ustrlen(string) + 64);
3852 const uschar *s = string;
3853 uschar *save_expand_nstring[EXPAND_MAXN+1];
3854 int save_expand_nlength[EXPAND_MAXN+1];
3855 BOOL resetok = TRUE;
3859 debug_printf_indent(UTF8_DOWN_RIGHT "%s: %s\n",
3861 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
3865 expand_string_forcedfail = FALSE;
3866 expand_string_message = US"";
3873 /* \ escapes the next character, which must exist, or else
3874 the expansion fails. There's a special escape, \N, which causes
3875 copying of the subject verbatim up to the next \N. Otherwise,
3876 the escapes are the standard set. */
3882 expand_string_message = US"\\ at end of string";
3888 const uschar * t = s + 2;
3889 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3890 yield = string_catn(yield, t, s - t);
3891 if (*s != 0) s += 2;
3897 ch[0] = string_interpret_escape(&s);
3899 yield = string_catn(yield, ch, 1);
3906 /* Anything other than $ is just copied verbatim, unless we are
3907 looking for a terminating } character. */
3910 if (ket_ends && *s == '}') break;
3912 if (*s != '$' || !honour_dollar)
3914 yield = string_catn(yield, s++, 1);
3918 /* No { after the $ - must be a plain name or a number for string
3919 match variable. There has to be a fudge for variables that are the
3920 names of header fields preceded by "$header_" because header field
3921 names can contain any printing characters except space and colon.
3922 For those that don't like typing this much, "$h_" is a synonym for
3923 "$header_". A non-existent header yields a NULL value; nothing is
3926 if (isalpha((*(++s))))
3932 s = read_name(name, sizeof(name), s, US"_");
3934 /* If this is the first thing to be expanded, release the pre-allocated
3937 if (yield && yield->ptr == 0)
3939 if (resetok) store_reset(yield);
3941 g = store_get(sizeof(gstring));
3946 if (Ustrncmp(name, "h_", 2) == 0 ||
3947 Ustrncmp(name, "rh_", 3) == 0 ||
3948 Ustrncmp(name, "bh_", 3) == 0 ||
3949 Ustrncmp(name, "header_", 7) == 0 ||
3950 Ustrncmp(name, "rheader_", 8) == 0 ||
3951 Ustrncmp(name, "bheader_", 8) == 0)
3953 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3954 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3955 s = read_header_name(name, sizeof(name), s);
3956 value = find_header(name, FALSE, &newsize, want_raw, charset);
3958 /* If we didn't find the header, and the header contains a closing brace
3959 character, this may be a user error where the terminating colon
3960 has been omitted. Set a flag to adjust the error message in this case.
3961 But there is no error here - nothing gets inserted. */
3965 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3972 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
3974 expand_string_message =
3975 string_sprintf("unknown variable name \"%s\"", name);
3976 check_variable_error_message(name);
3980 /* If the data is known to be in a new buffer, newsize will be set to the
3981 size of that buffer. If this is the first thing in an expansion string,
3982 yield will be NULL; just point it at the new store instead of copying. Many
3983 expansion strings contain just one reference, so this is a useful
3984 optimization, especially for humungous headers. We need to use a gstring
3985 structure that is not allocated after that new-buffer, else a later store
3986 reset in the middle of the buffer will make it inaccessible. */
3988 len = Ustrlen(value);
3989 if (!yield && newsize != 0)
3992 yield->size = newsize;
3996 else yield = string_catn(yield, value, len);
4004 s = read_cnumber(&n, s);
4005 if (n >= 0 && n <= expand_nmax)
4006 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4010 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4012 if (*s != '{') /*}*/
4014 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4018 /* After { there can be various things, but they all start with
4019 an initial word, except for a number for a string match variable. */
4021 if (isdigit((*(++s))))
4024 s = read_cnumber(&n, s); /*{*/
4027 expand_string_message = US"} expected after number";
4030 if (n >= 0 && n <= expand_nmax)
4031 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4037 expand_string_message = US"letter or digit expected after ${"; /*}*/
4041 /* Allow "-" in names to cater for substrings with negative
4042 arguments. Since we are checking for known names after { this is
4045 s = read_name(name, sizeof(name), s, US"_-");
4046 item_type = chop_match(name, item_table, nelem(item_table));
4050 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4051 If the ACL returns accept or reject we return content set by "message ="
4052 There is currently no limit on recursion; this would have us call
4053 acl_check_internal() directly and get a current level from somewhere.
4054 See also the acl expansion condition ECOND_ACL and the traditional
4055 acl modifier ACLC_ACL.
4056 Assume that the function has side-effects on the store that must be preserved.
4060 /* ${acl {name} {arg1}{arg2}...} */
4062 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4065 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4068 case 1: goto EXPAND_FAILED_CURLY;
4070 case 3: goto EXPAND_FAILED;
4072 if (skipping) continue;
4075 switch(eval_acl(sub, nelem(sub), &user_msg))
4080 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4082 yield = string_cat(yield, user_msg);
4086 expand_string_forcedfail = TRUE;
4089 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4094 /* Handle conditionals - preserve the values of the numerical expansion
4095 variables in case they get changed by a regular expression match in the
4096 condition. If not, they retain their external settings. At the end
4097 of this "if" section, they get restored to their previous values. */
4102 const uschar *next_s;
4103 int save_expand_nmax =
4104 save_expand_strings(save_expand_nstring, save_expand_nlength);
4106 while (isspace(*s)) s++;
4107 next_s = eval_condition(s, &resetok, skipping ? NULL : &cond);
4108 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4112 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4113 "condition: %.*s\n",
4114 (int)(next_s - s), s);
4115 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4116 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4118 cond ? "true" : "false");
4123 /* The handling of "yes" and "no" result strings is now in a separate
4124 function that is also used by ${lookup} and ${extract} and ${run}. */
4126 switch(process_yesno(
4127 skipping, /* were previously skipping */
4128 cond, /* success/failure indicator */
4129 lookup_value, /* value to reset for string2 */
4130 &s, /* input pointer */
4131 &yield, /* output pointer */
4132 US"if", /* condition type */
4135 case 1: goto EXPAND_FAILED; /* when all is well, the */
4136 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4139 /* Restore external setting of expansion variables for continuation
4142 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4143 save_expand_nlength);
4148 case EITEM_IMAPFOLDER:
4149 { /* ${imapfolder {name}{sep]{specials}} */
4153 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4156 case 1: goto EXPAND_FAILED_CURLY;
4158 case 3: goto EXPAND_FAILED;
4161 if (sub_arg[1] == NULL) /* One argument */
4163 sub_arg[1] = US"/"; /* default separator */
4166 else if (Ustrlen(sub_arg[1]) != 1)
4168 expand_string_message =
4170 "IMAP folder separator must be one character, found \"%s\"",
4177 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4178 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4180 yield = string_cat(yield, encoded);
4186 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4187 expanding an internal string that isn't actually going to be used. All we
4188 need to do is check the syntax, so don't do a lookup at all. Preserve the
4189 values of the numerical expansion variables in case they get changed by a
4190 partial lookup. If not, they retain their external settings. At the end
4191 of this "lookup" section, they get restored to their previous values. */
4195 int stype, partial, affixlen, starflags;
4196 int expand_setup = 0;
4198 uschar *key, *filename;
4199 const uschar *affix;
4200 uschar *save_lookup_value = lookup_value;
4201 int save_expand_nmax =
4202 save_expand_strings(save_expand_nstring, save_expand_nlength);
4204 if ((expand_forbid & RDO_LOOKUP) != 0)
4206 expand_string_message = US"lookup expansions are not permitted";
4210 /* Get the key we are to look up for single-key+file style lookups.
4211 Otherwise set the key NULL pro-tem. */
4213 while (isspace(*s)) s++;
4214 if (*s == '{') /*}*/
4216 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4217 if (!key) goto EXPAND_FAILED; /*{{*/
4220 expand_string_message = US"missing '}' after lookup key";
4221 goto EXPAND_FAILED_CURLY;
4223 while (isspace(*s)) s++;
4227 /* Find out the type of database */
4231 expand_string_message = US"missing lookup type";
4235 /* The type is a string that may contain special characters of various
4236 kinds. Allow everything except space or { to appear; the actual content
4237 is checked by search_findtype_partial. */ /*}*/
4239 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4241 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4245 while (isspace(*s)) s++;
4247 /* Now check for the individual search type and any partial or default
4248 options. Only those types that are actually in the binary are valid. */
4250 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4254 expand_string_message = search_error_message;
4258 /* Check that a key was provided for those lookup types that need it,
4259 and was not supplied for those that use the query style. */
4261 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4265 expand_string_message = string_sprintf("missing {key} for single-"
4266 "key \"%s\" lookup", name);
4274 expand_string_message = string_sprintf("a single key was given for "
4275 "lookup type \"%s\", which is not a single-key lookup type", name);
4280 /* Get the next string in brackets and expand it. It is the file name for
4281 single-key+file lookups, and the whole query otherwise. In the case of
4282 queries that also require a file name (e.g. sqlite), the file name comes
4287 expand_string_message = US"missing '{' for lookup file-or-query arg";
4288 goto EXPAND_FAILED_CURLY;
4290 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4291 if (filename == NULL) goto EXPAND_FAILED;
4294 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4295 goto EXPAND_FAILED_CURLY;
4297 while (isspace(*s)) s++;
4299 /* If this isn't a single-key+file lookup, re-arrange the variables
4300 to be appropriate for the search_ functions. For query-style lookups,
4301 there is just a "key", and no file name. For the special query-style +
4302 file types, the query (i.e. "key") starts with a file name. */
4306 while (isspace(*filename)) filename++;
4309 if (mac_islookup(stype, lookup_querystyle))
4313 if (*filename != '/')
4315 expand_string_message = string_sprintf(
4316 "absolute file name expected for \"%s\" lookup", name);
4319 while (*key != 0 && !isspace(*key)) key++;
4320 if (*key != 0) *key++ = 0;
4324 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4325 the entry was not found. Note that there is no search_close() function.
4326 Files are left open in case of re-use. At suitable places in higher logic,
4327 search_tidyup() is called to tidy all open files. This can save opening
4328 the same file several times. However, files may also get closed when
4329 others are opened, if too many are open at once. The rule is that a
4330 handle should not be used after a second search_open().
4332 Request that a partial search sets up $1 and maybe $2 by passing
4333 expand_setup containing zero. If its value changes, reset expand_nmax,
4334 since new variables will have been set. Note that at the end of this
4335 "lookup" section, the old numeric variables are restored. */
4338 lookup_value = NULL;
4341 void *handle = search_open(filename, stype, 0, NULL, NULL);
4344 expand_string_message = search_error_message;
4347 lookup_value = search_find(handle, filename, key, partial, affix,
4348 affixlen, starflags, &expand_setup);
4349 if (search_find_defer)
4351 expand_string_message =
4352 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4353 string_printing2(key, FALSE), search_error_message);
4356 if (expand_setup > 0) expand_nmax = expand_setup;
4359 /* The handling of "yes" and "no" result strings is now in a separate
4360 function that is also used by ${if} and ${extract}. */
4362 switch(process_yesno(
4363 skipping, /* were previously skipping */
4364 lookup_value != NULL, /* success/failure indicator */
4365 save_lookup_value, /* value to reset for string2 */
4366 &s, /* input pointer */
4367 &yield, /* output pointer */
4368 US"lookup", /* condition type */
4371 case 1: goto EXPAND_FAILED; /* when all is well, the */
4372 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4375 /* Restore external setting of expansion variables for carrying on
4376 at this level, and continue. */
4378 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4379 save_expand_nlength);
4383 /* If Perl support is configured, handle calling embedded perl subroutines,
4384 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4385 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4386 arguments (defined below). */
4388 #define EXIM_PERL_MAX_ARGS 8
4392 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4393 "is not included in this binary";
4396 #else /* EXIM_PERL */
4398 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4401 if ((expand_forbid & RDO_PERL) != 0)
4403 expand_string_message = US"Perl calls are not permitted";
4407 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4408 US"perl", &resetok))
4410 case 1: goto EXPAND_FAILED_CURLY;
4412 case 3: goto EXPAND_FAILED;
4415 /* If skipping, we don't actually do anything */
4417 if (skipping) continue;
4419 /* Start the interpreter if necessary */
4421 if (!opt_perl_started)
4424 if (opt_perl_startup == NULL)
4426 expand_string_message = US"A setting of perl_startup is needed when "
4427 "using the Perl interpreter";
4430 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4431 initerror = init_perl(opt_perl_startup);
4432 if (initerror != NULL)
4434 expand_string_message =
4435 string_sprintf("error in perl_startup code: %s\n", initerror);
4438 opt_perl_started = TRUE;
4441 /* Call the function */
4443 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4444 new_yield = call_perl_cat(yield, &expand_string_message,
4445 sub_arg[0], sub_arg + 1);
4447 /* NULL yield indicates failure; if the message pointer has been set to
4448 NULL, the yield was undef, indicating a forced failure. Otherwise the
4449 message will indicate some kind of Perl error. */
4451 if (new_yield == NULL)
4453 if (expand_string_message == NULL)
4455 expand_string_message =
4456 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4457 "failure", sub_arg[0]);
4458 expand_string_forcedfail = TRUE;
4463 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4464 set during a callback from Perl. */
4466 expand_string_forcedfail = FALSE;
4470 #endif /* EXIM_PERL */
4472 /* Transform email address to "prvs" scheme to use
4473 as BATV-signed return path */
4480 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4482 case 1: goto EXPAND_FAILED_CURLY;
4484 case 3: goto EXPAND_FAILED;
4487 /* If skipping, we don't actually do anything */
4488 if (skipping) continue;
4490 /* sub_arg[0] is the address */
4491 domain = Ustrrchr(sub_arg[0],'@');
4492 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4494 expand_string_message = US"prvs first argument must be a qualified email address";
4498 /* Calculate the hash. The second argument must be a single-digit
4499 key number, or unset. */
4501 if (sub_arg[2] != NULL &&
4502 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4504 expand_string_message = US"prvs second argument must be a single digit";
4508 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4511 expand_string_message = US"prvs hmac-sha1 conversion failed";
4515 /* Now separate the domain from the local part */
4518 yield = string_catn(yield, US"prvs=", 5);
4519 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
4520 yield = string_catn(yield, prvs_daystamp(7), 3);
4521 yield = string_catn(yield, p, 6);
4522 yield = string_catn(yield, US"=", 1);
4523 yield = string_cat (yield, sub_arg[0]);
4524 yield = string_catn(yield, US"@", 1);
4525 yield = string_cat (yield, domain);
4530 /* Check a prvs-encoded address for validity */
4532 case EITEM_PRVSCHECK:
4539 /* TF: Ugliness: We want to expand parameter 1 first, then set
4540 up expansion variables that are used in the expansion of
4541 parameter 2. So we clone the string for the first
4542 expansion, where we only expand parameter 1.
4544 PH: Actually, that isn't necessary. The read_subs() function is
4545 designed to work this way for the ${if and ${lookup expansions. I've
4549 /* Reset expansion variables */
4550 prvscheck_result = NULL;
4551 prvscheck_address = NULL;
4552 prvscheck_keynum = NULL;
4554 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4556 case 1: goto EXPAND_FAILED_CURLY;
4558 case 3: goto EXPAND_FAILED;
4561 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4564 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4566 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4567 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4568 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4569 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4570 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4572 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
4573 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
4574 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
4575 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
4576 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
4578 /* Set up expansion variables */
4579 g = string_cat (NULL, local_part);
4580 g = string_catn(g, US"@", 1);
4581 g = string_cat (g, domain);
4582 prvscheck_address = string_from_gstring(g);
4583 prvscheck_keynum = string_copy(key_num);
4585 /* Now expand the second argument */
4586 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4588 case 1: goto EXPAND_FAILED_CURLY;
4590 case 3: goto EXPAND_FAILED;
4593 /* Now we have the key and can check the address. */
4595 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4600 expand_string_message = US"hmac-sha1 conversion failed";
4604 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
4605 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
4607 if (Ustrcmp(p,hash) == 0)
4609 /* Success, valid BATV address. Now check the expiry date. */
4610 uschar *now = prvs_daystamp(0);
4611 unsigned int inow = 0,iexpire = 1;
4613 (void)sscanf(CS now,"%u",&inow);
4614 (void)sscanf(CS daystamp,"%u",&iexpire);
4616 /* When "iexpire" is < 7, a "flip" has occured.
4617 Adjust "inow" accordingly. */
4618 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4620 if (iexpire >= inow)
4622 prvscheck_result = US"1";
4623 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
4627 prvscheck_result = NULL;
4628 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
4633 prvscheck_result = NULL;
4634 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
4637 /* Now expand the final argument. We leave this till now so that
4638 it can include $prvscheck_result. */
4640 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4642 case 1: goto EXPAND_FAILED_CURLY;
4644 case 3: goto EXPAND_FAILED;
4647 yield = string_cat(yield,
4648 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4650 /* Reset the "internal" variables afterwards, because they are in
4651 dynamic store that will be reclaimed if the expansion succeeded. */
4653 prvscheck_address = NULL;
4654 prvscheck_keynum = NULL;
4657 /* Does not look like a prvs encoded address, return the empty string.
4658 We need to make sure all subs are expanded first, so as to skip over
4661 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4663 case 1: goto EXPAND_FAILED_CURLY;
4665 case 3: goto EXPAND_FAILED;
4671 /* Handle "readfile" to insert an entire file */
4673 case EITEM_READFILE:
4678 if ((expand_forbid & RDO_READFILE) != 0)
4680 expand_string_message = US"file insertions are not permitted";
4684 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4686 case 1: goto EXPAND_FAILED_CURLY;
4688 case 3: goto EXPAND_FAILED;
4691 /* If skipping, we don't actually do anything */
4693 if (skipping) continue;
4695 /* Open the file and read it */
4697 if (!(f = Ufopen(sub_arg[0], "rb")))
4699 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4703 yield = cat_file(f, yield, sub_arg[1]);
4708 /* Handle "readsocket" to insert data from a socket, either
4709 Inet or Unix domain */
4711 case EITEM_READSOCK:
4715 int save_ptr = yield->ptr;
4719 BOOL do_shutdown = TRUE;
4722 if (expand_forbid & RDO_READSOCK)
4724 expand_string_message = US"socket insertions are not permitted";
4728 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4729 because there may be a string for expansion on failure. */
4731 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4733 case 1: goto EXPAND_FAILED_CURLY;
4734 case 2: /* Won't occur: no end check */
4735 case 3: goto EXPAND_FAILED;
4738 /* Grab the request string, if any */
4740 reqstr.data = sub_arg[1];
4741 reqstr.len = Ustrlen(sub_arg[1]);
4743 /* Sort out timeout, if given. The second arg is a list with the first element
4744 being a time value. Any more are options of form "name=value". Currently the
4745 only option recognised is "shutdown". */
4749 const uschar * list = sub_arg[2];
4753 item = string_nextinlist(&list, &sep, NULL, 0);
4754 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
4756 expand_string_message = string_sprintf("bad time value %s", item);
4760 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
4761 if (Ustrncmp(item, US"shutdown=", 9) == 0)
4762 if (Ustrcmp(item + 9, US"no") == 0)
4763 do_shutdown = FALSE;
4765 else sub_arg[3] = NULL; /* No eol if no timeout */
4767 /* If skipping, we don't actually do anything. Otherwise, arrange to
4768 connect to either an IP or a Unix socket. */
4772 /* Handle an IP (internet) domain */
4774 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4777 uschar * server_name = sub_arg[0] + 5;
4778 uschar * port_name = Ustrrchr(server_name, ':');
4780 /* Sort out the port */
4784 expand_string_message =
4785 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4788 *port_name++ = 0; /* Terminate server name */
4790 if (isdigit(*port_name))
4793 port = Ustrtol(port_name, &end, 0);
4794 if (end != port_name + Ustrlen(port_name))
4796 expand_string_message =
4797 string_sprintf("invalid port number %s", port_name);
4803 struct servent *service_info = getservbyname(CS port_name, "tcp");
4806 expand_string_message = string_sprintf("unknown port \"%s\"",
4810 port = ntohs(service_info->s_port);
4813 fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4814 timeout, NULL, &expand_string_message, &reqstr);
4815 callout_address = NULL;
4821 /* Handle a Unix domain socket */
4825 struct sockaddr_un sockun; /* don't call this "sun" ! */
4828 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4830 expand_string_message = string_sprintf("failed to create socket: %s",
4835 sockun.sun_family = AF_UNIX;
4836 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4839 sigalrm_seen = FALSE;
4841 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4845 expand_string_message = US "socket connect timed out";
4850 expand_string_message = string_sprintf("failed to connect to socket "
4851 "%s: %s", sub_arg[0], strerror(errno));
4856 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
4858 /* Allow sequencing of test actions */
4859 if (running_in_test_harness) millisleep(100);
4861 /* Write the request string, if not empty or already done */
4865 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
4867 if (write(fd, reqstr.data, reqstr.len) != reqstr.len)
4869 expand_string_message = string_sprintf("request write to socket "
4870 "failed: %s", strerror(errno));
4875 /* Shut down the sending side of the socket. This helps some servers to
4876 recognise that it is their turn to do some work. Just in case some
4877 system doesn't have this function, make it conditional. */
4880 if (do_shutdown) shutdown(fd, SHUT_WR);
4883 if (running_in_test_harness) millisleep(100);
4885 /* Now we need to read from the socket, under a timeout. The function
4886 that reads a file can be used. */
4888 f = fdopen(fd, "rb");
4889 sigalrm_seen = FALSE;
4891 yield = cat_file(f, yield, sub_arg[3]);
4895 /* After a timeout, we restore the pointer in the result, that is,
4896 make sure we add nothing from the socket. */
4900 yield->ptr = save_ptr;
4901 expand_string_message = US "socket read timed out";
4906 /* The whole thing has worked (or we were skipping). If there is a
4907 failure string following, we need to skip it. */
4911 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4915 expand_string_message = US"missing '}' closing failstring for readsocket";
4916 goto EXPAND_FAILED_CURLY;
4918 while (isspace(*s)) s++;
4924 expand_string_message = US"missing '}' closing readsocket";
4925 goto EXPAND_FAILED_CURLY;
4929 /* Come here on failure to create socket, connect socket, write to the
4930 socket, or timeout on reading. If another substring follows, expand and
4931 use it. Otherwise, those conditions give expand errors. */
4934 if (*s != '{') goto EXPAND_FAILED;
4935 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4936 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
4938 yield = string_cat(yield, arg);
4941 expand_string_message = US"missing '}' closing failstring for readsocket";
4942 goto EXPAND_FAILED_CURLY;
4944 while (isspace(*s)) s++;
4948 /* Handle "run" to execute a program. */
4954 const uschar **argv;
4958 if ((expand_forbid & RDO_RUN) != 0)
4960 expand_string_message = US"running a command is not permitted";
4964 while (isspace(*s)) s++;
4967 expand_string_message = US"missing '{' for command arg of run";
4968 goto EXPAND_FAILED_CURLY;
4970 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4971 if (arg == NULL) goto EXPAND_FAILED;
4972 while (isspace(*s)) s++;
4975 expand_string_message = US"missing '}' closing command arg of run";
4976 goto EXPAND_FAILED_CURLY;
4979 if (skipping) /* Just pretend it worked when we're skipping */
4982 lookup_value = NULL;
4986 if (!transport_set_up_command(&argv, /* anchor for arg list */
4987 arg, /* raw command */
4988 FALSE, /* don't expand the arguments */
4989 0, /* not relevant when... */
4990 NULL, /* no transporting address */
4991 US"${run} expansion", /* for error messages */
4992 &expand_string_message)) /* where to put error message */
4995 /* Create the child process, making it a group leader. */
4997 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
4999 expand_string_message =
5000 string_sprintf("couldn't create child process: %s", strerror(errno));
5004 /* Nothing is written to the standard input. */
5008 /* Read the pipe to get the command's output into $value (which is kept
5009 in lookup_value). Read during execution, so that if the output exceeds
5010 the OS pipe buffer limit, we don't block forever. Remember to not release
5011 memory just allocated for $value. */
5014 f = fdopen(fd_out, "rb");
5015 sigalrm_seen = FALSE;
5017 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5021 /* Wait for the process to finish, applying the timeout, and inspect its
5022 return code for serious disasters. Simple non-zero returns are passed on.
5025 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5027 if (sigalrm_seen || runrc == -256)
5029 expand_string_message = string_sprintf("command timed out");
5030 killpg(pid, SIGKILL); /* Kill the whole process group */
5033 else if (runrc == -257)
5034 expand_string_message = string_sprintf("wait() failed: %s",
5038 expand_string_message = string_sprintf("command killed by signal %d",
5045 /* Process the yes/no strings; $value may be useful in both cases */
5047 switch(process_yesno(
5048 skipping, /* were previously skipping */
5049 runrc == 0, /* success/failure indicator */
5050 lookup_value, /* value to reset for string2 */
5051 &s, /* input pointer */
5052 &yield, /* output pointer */
5053 US"run", /* condition type */
5056 case 1: goto EXPAND_FAILED; /* when all is well, the */
5057 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5063 /* Handle character translation for "tr" */
5067 int oldptr = yield->ptr;
5071 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5073 case 1: goto EXPAND_FAILED_CURLY;
5075 case 3: goto EXPAND_FAILED;
5078 yield = string_cat(yield, sub[0]);
5079 o2m = Ustrlen(sub[2]) - 1;
5081 if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5083 uschar *m = Ustrrchr(sub[1], yield->s[oldptr]);
5087 yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5094 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5095 expanded arguments. */
5105 int val[2] = { 0, -1 };
5108 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5109 Ensure that sub[2] is set in the ${length } case. */
5112 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5113 TRUE, name, &resetok))
5115 case 1: goto EXPAND_FAILED_CURLY;
5117 case 3: goto EXPAND_FAILED;
5120 /* Juggle the arguments if there are only two of them: always move the
5121 string to the last position and make ${length{n}{str}} equivalent to
5122 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5128 if (item_type == EITEM_LENGTH)
5135 for (i = 0; i < 2; i++)
5137 if (sub[i] == NULL) continue;
5138 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5139 if (*ret != 0 || (i != 0 && val[i] < 0))
5141 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5142 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5148 (item_type == EITEM_HASH)?
5149 compute_hash(sub[2], val[0], val[1], &len) :
5150 (item_type == EITEM_NHASH)?
5151 compute_nhash(sub[2], val[0], val[1], &len) :
5152 extract_substr(sub[2], val[0], val[1], &len);
5154 if (ret == NULL) goto EXPAND_FAILED;
5155 yield = string_catn(yield, ret, len);
5159 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5160 This code originally contributed by Steve Haslam. It currently supports
5161 the use of MD5 and SHA-1 hashes.
5163 We need some workspace that is large enough to handle all the supported
5164 hash types. Use macros to set the sizes rather than be too elaborate. */
5166 #define MAX_HASHLEN 20
5167 #define MAX_HASHBLOCKLEN 64
5176 int hashlen; /* Number of octets for the hash algorithm's output */
5177 int hashblocklen; /* Number of octets the hash algorithm processes */
5179 unsigned int keylen;
5181 uschar keyhash[MAX_HASHLEN];
5182 uschar innerhash[MAX_HASHLEN];
5183 uschar finalhash[MAX_HASHLEN];
5184 uschar finalhash_hex[2*MAX_HASHLEN];
5185 uschar innerkey[MAX_HASHBLOCKLEN];
5186 uschar outerkey[MAX_HASHBLOCKLEN];
5188 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5190 case 1: goto EXPAND_FAILED_CURLY;
5192 case 3: goto EXPAND_FAILED;
5197 if (Ustrcmp(sub[0], "md5") == 0)
5200 use_base = &md5_base;
5204 else if (Ustrcmp(sub[0], "sha1") == 0)
5207 use_base = &sha1_ctx;
5213 expand_string_message =
5214 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5219 keylen = Ustrlen(keyptr);
5221 /* If the key is longer than the hash block length, then hash the key
5224 if (keylen > hashblocklen)
5226 chash_start(type, use_base);
5227 chash_end(type, use_base, keyptr, keylen, keyhash);
5232 /* Now make the inner and outer key values */
5234 memset(innerkey, 0x36, hashblocklen);
5235 memset(outerkey, 0x5c, hashblocklen);
5237 for (i = 0; i < keylen; i++)
5239 innerkey[i] ^= keyptr[i];
5240 outerkey[i] ^= keyptr[i];
5243 /* Now do the hashes */
5245 chash_start(type, use_base);
5246 chash_mid(type, use_base, innerkey);
5247 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5249 chash_start(type, use_base);
5250 chash_mid(type, use_base, outerkey);
5251 chash_end(type, use_base, innerhash, hashlen, finalhash);
5253 /* Encode the final hash as a hex string */
5256 for (i = 0; i < hashlen; i++)
5258 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5259 *p++ = hex_digits[finalhash[i] & 0x0f];
5262 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5263 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5265 yield = string_catn(yield, finalhash_hex, hashlen*2);
5270 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5271 We have to save the numerical variables and restore them afterwards. */
5276 int moffset, moffsetextra, slen;
5279 const uschar *rerror;
5282 int save_expand_nmax =
5283 save_expand_strings(save_expand_nstring, save_expand_nlength);
5285 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5287 case 1: goto EXPAND_FAILED_CURLY;
5289 case 3: goto EXPAND_FAILED;
5292 /* Compile the regular expression */
5294 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5299 expand_string_message = string_sprintf("regular expression error in "
5300 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5304 /* Now run a loop to do the substitutions as often as necessary. It ends
5305 when there are no more matches. Take care over matches of the null string;
5306 do the same thing as Perl does. */
5309 slen = Ustrlen(sub[0]);
5310 moffset = moffsetextra = 0;
5315 int ovector[3*(EXPAND_MAXN+1)];
5316 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5317 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5321 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5322 is not necessarily the end. We want to repeat the match from one
5323 character further along, but leaving the basic offset the same (for
5324 copying below). We can't be at the end of the string - that was checked
5325 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5326 finished; copy the remaining string and end the loop. */
5336 yield = string_catn(yield, subject+moffset, slen-moffset);
5340 /* Match - set up for expanding the replacement. */
5342 if (n == 0) n = EXPAND_MAXN + 1;
5344 for (nn = 0; nn < n*2; nn += 2)
5346 expand_nstring[expand_nmax] = subject + ovector[nn];
5347 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5351 /* Copy the characters before the match, plus the expanded insertion. */
5353 yield = string_catn(yield, subject + moffset, ovector[0] - moffset);
5354 insert = expand_string(sub[2]);
5355 if (insert == NULL) goto EXPAND_FAILED;
5356 yield = string_cat(yield, insert);
5358 moffset = ovector[1];
5362 /* If we have matched an empty string, first check to see if we are at
5363 the end of the subject. If so, the loop is over. Otherwise, mimic
5364 what Perl's /g options does. This turns out to be rather cunning. First
5365 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5366 string at the same point. If this fails (picked up above) we advance to
5367 the next character. */
5369 if (ovector[0] == ovector[1])
5371 if (ovector[0] == slen) break;
5372 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5376 /* All done - restore numerical variables. */
5378 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5379 save_expand_nlength);
5383 /* Handle keyed and numbered substring extraction. If the first argument
5384 consists entirely of digits, then a numerical extraction is assumed. */
5390 int field_number = 1;
5391 BOOL field_number_set = FALSE;
5392 uschar *save_lookup_value = lookup_value;
5394 int save_expand_nmax =
5395 save_expand_strings(save_expand_nstring, save_expand_nlength);
5397 /* While skipping we cannot rely on the data for expansions being
5398 available (eg. $item) hence cannot decide on numeric vs. keyed.
5399 Read a maximum of 5 arguments (including the yes/no) */
5403 while (isspace(*s)) s++;
5404 for (j = 5; j > 0 && *s == '{'; j--)
5406 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5407 goto EXPAND_FAILED; /*{*/
5410 expand_string_message = US"missing '{' for arg of extract";
5411 goto EXPAND_FAILED_CURLY;
5413 while (isspace(*s)) s++;
5415 if ( Ustrncmp(s, "fail", 4) == 0
5416 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5420 while (isspace(*s)) s++;
5424 expand_string_message = US"missing '}' closing extract";
5425 goto EXPAND_FAILED_CURLY;
5429 else for (i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5431 while (isspace(*s)) s++;
5432 if (*s == '{') /*}*/
5434 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5435 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5438 expand_string_message = string_sprintf(
5439 "missing '}' closing arg %d of extract", i+1);
5440 goto EXPAND_FAILED_CURLY;
5443 /* After removal of leading and trailing white space, the first
5444 argument must not be empty; if it consists entirely of digits
5445 (optionally preceded by a minus sign), this is a numerical
5446 extraction, and we expect 3 arguments. */
5454 while (isspace(*p)) p++;
5458 while (len > 0 && isspace(p[len-1])) len--;
5463 expand_string_message = US"first argument of \"extract\" must "
5473 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5477 j = 3; /* Need 3 args */
5478 field_number_set = TRUE;
5484 expand_string_message = string_sprintf(
5485 "missing '{' for arg %d of extract", i+1);
5486 goto EXPAND_FAILED_CURLY;
5490 /* Extract either the numbered or the keyed substring into $value. If
5491 skipping, just pretend the extraction failed. */
5493 lookup_value = skipping? NULL : field_number_set?
5494 expand_gettokened(field_number, sub[1], sub[2]) :
5495 expand_getkeyed(sub[0], sub[1]);
5497 /* If no string follows, $value gets substituted; otherwise there can
5498 be yes/no strings, as for lookup or if. */
5500 switch(process_yesno(
5501 skipping, /* were previously skipping */
5502 lookup_value != NULL, /* success/failure indicator */
5503 save_lookup_value, /* value to reset for string2 */
5504 &s, /* input pointer */
5505 &yield, /* output pointer */
5506 US"extract", /* condition type */
5509 case 1: goto EXPAND_FAILED; /* when all is well, the */
5510 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5513 /* All done - restore numerical variables. */
5515 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5516 save_expand_nlength);
5521 /* return the Nth item from a list */
5523 case EITEM_LISTEXTRACT:
5526 int field_number = 1;
5527 uschar *save_lookup_value = lookup_value;
5529 int save_expand_nmax =
5530 save_expand_strings(save_expand_nstring, save_expand_nlength);
5532 /* Read the field & list arguments */
5534 for (i = 0; i < 2; i++)
5536 while (isspace(*s)) s++;
5537 if (*s != '{') /*}*/
5539 expand_string_message = string_sprintf(
5540 "missing '{' for arg %d of listextract", i+1);
5541 goto EXPAND_FAILED_CURLY;
5544 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5545 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5548 expand_string_message = string_sprintf(
5549 "missing '}' closing arg %d of listextract", i+1);
5550 goto EXPAND_FAILED_CURLY;
5553 /* After removal of leading and trailing white space, the first
5554 argument must be numeric and nonempty. */
5562 while (isspace(*p)) p++;
5566 while (len > 0 && isspace(p[len-1])) len--;
5569 if (!*p && !skipping)
5571 expand_string_message = US"first argument of \"listextract\" must "
5581 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5584 expand_string_message = US"first argument of \"listextract\" must "
5592 /* Extract the numbered element into $value. If
5593 skipping, just pretend the extraction failed. */
5595 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5597 /* If no string follows, $value gets substituted; otherwise there can
5598 be yes/no strings, as for lookup or if. */
5600 switch(process_yesno(
5601 skipping, /* were previously skipping */
5602 lookup_value != NULL, /* success/failure indicator */
5603 save_lookup_value, /* value to reset for string2 */
5604 &s, /* input pointer */
5605 &yield, /* output pointer */
5606 US"listextract", /* condition type */
5609 case 1: goto EXPAND_FAILED; /* when all is well, the */
5610 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5613 /* All done - restore numerical variables. */
5615 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5616 save_expand_nlength);
5622 case EITEM_CERTEXTRACT:
5624 uschar *save_lookup_value = lookup_value;
5626 int save_expand_nmax =
5627 save_expand_strings(save_expand_nstring, save_expand_nlength);
5629 /* Read the field argument */
5630 while (isspace(*s)) s++;
5631 if (*s != '{') /*}*/
5633 expand_string_message = US"missing '{' for field arg of certextract";
5634 goto EXPAND_FAILED_CURLY;
5636 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5637 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5640 expand_string_message = US"missing '}' closing field arg of certextract";
5641 goto EXPAND_FAILED_CURLY;
5643 /* strip spaces fore & aft */
5648 while (isspace(*p)) p++;
5652 while (len > 0 && isspace(p[len-1])) len--;
5656 /* inspect the cert argument */
5657 while (isspace(*s)) s++;
5658 if (*s != '{') /*}*/
5660 expand_string_message = US"missing '{' for cert variable arg of certextract";
5661 goto EXPAND_FAILED_CURLY;
5665 expand_string_message = US"second argument of \"certextract\" must "
5666 "be a certificate variable";
5669 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5670 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5673 expand_string_message = US"missing '}' closing cert variable arg of certextract";
5674 goto EXPAND_FAILED_CURLY;
5678 lookup_value = NULL;
5681 lookup_value = expand_getcertele(sub[0], sub[1]);
5682 if (*expand_string_message) goto EXPAND_FAILED;
5684 switch(process_yesno(
5685 skipping, /* were previously skipping */
5686 lookup_value != NULL, /* success/failure indicator */
5687 save_lookup_value, /* value to reset for string2 */
5688 &s, /* input pointer */
5689 &yield, /* output pointer */
5690 US"certextract", /* condition type */
5693 case 1: goto EXPAND_FAILED; /* when all is well, the */
5694 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5697 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5698 save_expand_nlength);
5701 #endif /*SUPPORT_TLS*/
5703 /* Handle list operations */
5710 int save_ptr = yield->ptr;
5711 uschar outsep[2] = { '\0', '\0' };
5712 const uschar *list, *expr, *temp;
5713 uschar *save_iterate_item = iterate_item;
5714 uschar *save_lookup_value = lookup_value;
5716 while (isspace(*s)) s++;
5719 expand_string_message =
5720 string_sprintf("missing '{' for first arg of %s", name);
5721 goto EXPAND_FAILED_CURLY;
5724 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5725 if (list == NULL) goto EXPAND_FAILED;
5728 expand_string_message =
5729 string_sprintf("missing '}' closing first arg of %s", name);
5730 goto EXPAND_FAILED_CURLY;
5733 if (item_type == EITEM_REDUCE)
5736 while (isspace(*s)) s++;
5739 expand_string_message = US"missing '{' for second arg of reduce";
5740 goto EXPAND_FAILED_CURLY;
5742 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5743 if (!t) goto EXPAND_FAILED;
5747 expand_string_message = US"missing '}' closing second arg of reduce";
5748 goto EXPAND_FAILED_CURLY;
5752 while (isspace(*s)) s++;
5755 expand_string_message =
5756 string_sprintf("missing '{' for last arg of %s", name);
5757 goto EXPAND_FAILED_CURLY;
5762 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5763 if scanning a "false" part). This allows us to find the end of the
5764 condition, because if the list is empty, we won't actually evaluate the
5765 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5766 the normal internal expansion function. */
5768 if (item_type == EITEM_FILTER)
5770 temp = eval_condition(expr, &resetok, NULL);
5771 if (temp != NULL) s = temp;
5774 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5778 expand_string_message = string_sprintf("%s inside \"%s\" item",
5779 expand_string_message, name);
5783 while (isspace(*s)) s++;
5786 expand_string_message = string_sprintf("missing } at end of condition "
5787 "or expression inside \"%s\"", name);
5791 while (isspace(*s)) s++; /*{*/
5794 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5799 /* If we are skipping, we can now just move on to the next item. When
5800 processing for real, we perform the iteration. */
5802 if (skipping) continue;
5803 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
5805 *outsep = (uschar)sep; /* Separator as a string */
5807 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
5808 name, iterate_item, lookup_value);
5810 if (item_type == EITEM_FILTER)
5813 if (eval_condition(expr, &resetok, &condresult) == NULL)
5815 iterate_item = save_iterate_item;
5816 lookup_value = save_lookup_value;
5817 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5818 expand_string_message, name);
5821 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
5822 condresult? "true":"false");
5824 temp = iterate_item; /* TRUE => include this item */
5826 continue; /* FALSE => skip this item */
5829 /* EITEM_MAP and EITEM_REDUCE */
5833 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5837 iterate_item = save_iterate_item;
5838 expand_string_message = string_sprintf("%s inside \"%s\" item",
5839 expand_string_message, name);
5842 if (item_type == EITEM_REDUCE)
5844 lookup_value = t; /* Update the value of $value */
5845 continue; /* and continue the iteration */
5849 /* We reach here for FILTER if the condition is true, always for MAP,
5850 and never for REDUCE. The value in "temp" is to be added to the output
5851 list that is being created, ensuring that any occurrences of the
5852 separator character are doubled. Unless we are dealing with the first
5853 item of the output list, add in a space if the new item begins with the
5854 separator character, or is an empty string. */
5856 if (yield->ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5857 yield = string_catn(yield, US" ", 1);
5859 /* Add the string in "temp" to the output list that we are building,
5860 This is done in chunks by searching for the separator character. */
5864 size_t seglen = Ustrcspn(temp, outsep);
5866 yield = string_catn(yield, temp, seglen + 1);
5868 /* If we got to the end of the string we output one character
5869 too many; backup and end the loop. Otherwise arrange to double the
5872 if (temp[seglen] == '\0') { yield->ptr--; break; }
5873 yield = string_catn(yield, outsep, 1);
5877 /* Output a separator after the string: we will remove the redundant
5878 final one at the end. */
5880 yield = string_catn(yield, outsep, 1);
5881 } /* End of iteration over the list loop */
5883 /* REDUCE has generated no output above: output the final value of
5886 if (item_type == EITEM_REDUCE)
5888 yield = string_cat(yield, lookup_value);
5889 lookup_value = save_lookup_value; /* Restore $value */
5892 /* FILTER and MAP generate lists: if they have generated anything, remove
5893 the redundant final separator. Even though an empty item at the end of a
5894 list does not count, this is tidier. */
5896 else if (yield->ptr != save_ptr) yield->ptr--;
5898 /* Restore preserved $item */
5900 iterate_item = save_iterate_item;
5907 const uschar *srclist, *cmp, *xtract;
5909 const uschar *dstlist = NULL, *dstkeylist = NULL;
5911 uschar *save_iterate_item = iterate_item;
5913 while (isspace(*s)) s++;
5916 expand_string_message = US"missing '{' for list arg of sort";
5917 goto EXPAND_FAILED_CURLY;
5920 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5921 if (!srclist) goto EXPAND_FAILED;
5924 expand_string_message = US"missing '}' closing list arg of sort";
5925 goto EXPAND_FAILED_CURLY;
5928 while (isspace(*s)) s++;
5931 expand_string_message = US"missing '{' for comparator arg of sort";
5932 goto EXPAND_FAILED_CURLY;
5935 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5936 if (!cmp) goto EXPAND_FAILED;
5939 expand_string_message = US"missing '}' closing comparator arg of sort";
5940 goto EXPAND_FAILED_CURLY;
5943 while (isspace(*s)) s++;
5946 expand_string_message = US"missing '{' for extractor arg of sort";
5947 goto EXPAND_FAILED_CURLY;
5951 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5952 if (!tmp) goto EXPAND_FAILED;
5953 xtract = string_copyn(xtract, s - xtract);
5957 expand_string_message = US"missing '}' closing extractor arg of sort";
5958 goto EXPAND_FAILED_CURLY;
5963 expand_string_message = US"missing } at end of \"sort\"";
5967 if (skipping) continue;
5969 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5972 gstring * newlist = NULL;
5973 gstring * newkeylist = NULL;
5976 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
5978 /* extract field for comparisons */
5979 iterate_item = srcitem;
5980 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5984 expand_string_message = string_sprintf(
5985 "field-extract in sort: \"%s\"", xtract);
5989 /* Insertion sort */
5991 /* copy output list until new-item < list-item */
5992 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5998 /* field for comparison */
5999 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6002 /* build and run condition string */
6003 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
6005 DEBUG(D_expand) debug_printf_indent("%s: cond = \"%s\"\n", name, expr);
6006 if (!eval_condition(expr, &resetok, &before))
6008 expand_string_message = string_sprintf("comparison in sort: %s",
6015 /* New-item sorts before this dst-item. Append new-item,
6016 then dst-item, then remainder of dst list. */
6018 newlist = string_append_listele(newlist, sep, srcitem);
6019 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6022 newlist = string_append_listele(newlist, sep, dstitem);
6023 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6025 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6027 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6029 newlist = string_append_listele(newlist, sep, dstitem);
6030 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6036 newlist = string_append_listele(newlist, sep, dstitem);
6037 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6040 /* If we ran out of dstlist without consuming srcitem, append it */
6043 newlist = string_append_listele(newlist, sep, srcitem);
6044 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6047 dstlist = newlist->s;
6048 dstkeylist = newkeylist->s;
6050 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6051 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6055 yield = string_cat(yield, dstlist);
6057 /* Restore preserved $item */
6058 iterate_item = save_iterate_item;
6062 expand_string_message = US"Internal error in sort (list mismatch)";
6067 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6068 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6069 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6070 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6072 #define EXPAND_DLFUNC_MAX_ARGS 8
6075 #ifndef EXPAND_DLFUNC
6076 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6077 "is not included in this binary";
6080 #else /* EXPAND_DLFUNC */
6083 exim_dlfunc_t *func;
6086 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6088 if ((expand_forbid & RDO_DLFUNC) != 0)
6090 expand_string_message =
6091 US"dynamically-loaded functions are not permitted";
6095 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6096 TRUE, US"dlfunc", &resetok))
6098 case 1: goto EXPAND_FAILED_CURLY;
6100 case 3: goto EXPAND_FAILED;
6103 /* If skipping, we don't actually do anything */
6105 if (skipping) continue;
6107 /* Look up the dynamically loaded object handle in the tree. If it isn't
6108 found, dlopen() the file and put the handle in the tree for next time. */
6110 t = tree_search(dlobj_anchor, argv[0]);
6113 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6116 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6117 argv[0], dlerror());
6118 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6121 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6122 Ustrcpy(t->name, argv[0]);
6123 t->data.ptr = handle;
6124 (void)tree_insertnode(&dlobj_anchor, t);
6127 /* Having obtained the dynamically loaded object handle, look up the
6128 function pointer. */
6130 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6133 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6134 "%s", argv[1], argv[0], dlerror());
6135 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6139 /* Call the function and work out what to do with the result. If it
6140 returns OK, we have a replacement string; if it returns DEFER then
6141 expansion has failed in a non-forced manner; if it returns FAIL then
6142 failure was forced; if it returns ERROR or any other value there's a
6143 problem, so panic slightly. In any case, assume that the function has
6144 side-effects on the store that must be preserved. */
6148 for (argc = 0; argv[argc] != NULL; argc++);
6149 status = func(&result, argc - 2, &argv[2]);
6152 if (result == NULL) result = US"";
6153 yield = string_cat(yield, result);
6158 expand_string_message = result == NULL ? US"(no message)" : result;
6159 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
6160 else if(status != FAIL)
6161 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6162 argv[0], argv[1], status, expand_string_message);
6166 #endif /* EXPAND_DLFUNC */
6168 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6171 uschar *save_lookup_value = lookup_value;
6173 while (isspace(*s)) s++;
6174 if (*s != '{') /*}*/
6177 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6178 if (!key) goto EXPAND_FAILED; /*{*/
6181 expand_string_message = US"missing '{' for name arg of env";
6182 goto EXPAND_FAILED_CURLY;
6185 lookup_value = US getenv(CS key);
6187 switch(process_yesno(
6188 skipping, /* were previously skipping */
6189 lookup_value != NULL, /* success/failure indicator */
6190 save_lookup_value, /* value to reset for string2 */
6191 &s, /* input pointer */
6192 &yield, /* output pointer */
6193 US"env", /* condition type */
6196 case 1: goto EXPAND_FAILED; /* when all is well, the */
6197 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6201 } /* EITEM_* switch */
6203 /* Control reaches here if the name is not recognized as one of the more
6204 complicated expansion items. Check for the "operator" syntax (name terminated
6205 by a colon). Some of the operators have arguments, separated by _ from the
6213 var_entry *vp = NULL;
6215 /* Owing to an historical mis-design, an underscore may be part of the
6216 operator name, or it may introduce arguments. We therefore first scan the
6217 table of names that contain underscores. If there is no match, we cut off
6218 the arguments and then scan the main table. */
6220 if ((c = chop_match(name, op_table_underscore,
6221 nelem(op_table_underscore))) < 0)
6223 arg = Ustrchr(name, '_');
6224 if (arg != NULL) *arg = 0;
6225 c = chop_match(name, op_table_main, nelem(op_table_main));
6226 if (c >= 0) c += nelem(op_table_underscore);
6227 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6230 /* Deal specially with operators that might take a certificate variable
6231 as we do not want to do the usual expansion. For most, expand the string.*/
6241 const uschar * s1 = s;
6242 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6244 if (!sub) goto EXPAND_FAILED; /*{*/
6247 expand_string_message =
6248 string_sprintf("missing '}' closing cert arg of %s", name);
6249 goto EXPAND_FAILED_CURLY;
6251 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6261 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6262 if (!sub) goto EXPAND_FAILED;
6267 /* If we are skipping, we don't need to perform the operation at all.
6268 This matters for operations like "mask", because the data may not be
6269 in the correct format when skipping. For example, the expression may test
6270 for the existence of $sender_host_address before trying to mask it. For
6271 other operations, doing them may not fail, but it is a waste of time. */
6273 if (skipping && c >= 0) continue;
6275 /* Otherwise, switch on the operator type */
6282 unsigned long int n = Ustrtoul(sub, &t, 10);
6287 expand_string_message = string_sprintf("argument for base32 "
6288 "operator is \"%s\", which is not a decimal number", sub);
6292 g = string_catn(g, &base32_chars[n & 0x1f], 1);
6294 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
6301 unsigned long int n = 0;
6305 uschar * t = Ustrchr(base32_chars, *tt++);
6308 expand_string_message = string_sprintf("argument for base32d "
6309 "operator is \"%s\", which is not a base 32 number", sub);
6312 n = n * 32 + (t - base32_chars);
6314 s = string_sprintf("%ld", n);
6315 yield = string_cat(yield, s);
6322 unsigned long int n = Ustrtoul(sub, &t, 10);
6325 expand_string_message = string_sprintf("argument for base62 "
6326 "operator is \"%s\", which is not a decimal number", sub);
6329 t = string_base62(n);
6330 yield = string_cat(yield, t);
6334 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6340 unsigned long int n = 0;
6343 uschar *t = Ustrchr(base62_chars, *tt++);
6346 expand_string_message = string_sprintf("argument for base62d "
6347 "operator is \"%s\", which is not a base %d number", sub,
6351 n = n * BASE_62 + (t - base62_chars);
6353 (void)sprintf(CS buf, "%ld", n);
6354 yield = string_cat(yield, buf);
6360 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6361 if (expanded == NULL)
6363 expand_string_message =
6364 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6365 expand_string_message);
6368 yield = string_cat(yield, expanded);
6375 uschar *t = sub - 1;
6376 while (*(++t) != 0) { *t = tolower(*t); count++; }
6377 yield = string_catn(yield, sub, count);
6384 uschar *t = sub - 1;
6385 while (*(++t) != 0) { *t = toupper(*t); count++; }
6386 yield = string_catn(yield, sub, count);
6392 if (vp && *(void **)vp->value)
6394 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6395 yield = string_cat(yield, cp);
6405 md5_end(&base, sub, Ustrlen(sub), digest);
6406 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6407 yield = string_cat(yield, US st);
6413 if (vp && *(void **)vp->value)
6415 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6416 yield = string_cat(yield, cp);
6426 sha1_end(&h, sub, Ustrlen(sub), digest);
6427 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6428 yield = string_catn(yield, US st, 40);
6433 #ifdef EXIM_HAVE_SHA2
6434 if (vp && *(void **)vp->value)
6436 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6437 yield = string_cat(yield, cp);
6445 if (!exim_sha_init(&h, HASH_SHA2_256))
6447 expand_string_message = US"unrecognised sha256 variant";
6450 exim_sha_update(&h, sub, Ustrlen(sub));
6451 exim_sha_finish(&h, &b);
6454 sprintf(st, "%02X", *b.data++);
6455 yield = string_catn(yield, US st, 2);
6459 expand_string_message = US"sha256 only supported with TLS";
6464 #ifdef EXIM_HAVE_SHA3
6469 hashmethod m = !arg ? HASH_SHA3_256
6470 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6471 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6472 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6473 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6476 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6478 expand_string_message = US"unrecognised sha3 variant";
6482 exim_sha_update(&h, sub, Ustrlen(sub));
6483 exim_sha_finish(&h, &b);
6486 sprintf(st, "%02X", *b.data++);
6487 yield = string_catn(yield, US st, 2);
6492 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 +";
6496 /* Convert hex encoding to base64 encoding */
6506 for (enc = sub; *enc != 0; enc++)
6508 if (!isxdigit(*enc))
6510 expand_string_message = string_sprintf("\"%s\" is not a hex "
6519 expand_string_message = string_sprintf("\"%s\" contains an odd "
6520 "number of characters", sub);
6524 while ((c = *in++) != 0)
6526 if (isdigit(c)) c -= '0';
6527 else c = toupper(c) - 'A' + 10;
6539 enc = b64encode(sub, out - sub);
6540 yield = string_cat(yield, enc);
6544 /* Convert octets outside 0x21..0x7E to \xXX form */
6548 uschar *t = sub - 1;
6551 if (*t < 0x21 || 0x7E < *t)
6552 yield = string_catn(yield, string_sprintf("\\x%02x", *t), 4);
6554 yield = string_catn(yield, t, 1);
6559 /* count the number of list elements */
6568 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6569 cp = string_sprintf("%d", cnt);
6570 yield = string_cat(yield, cp);
6574 /* expand a named list given the name */
6575 /* handles nested named lists; requotes as colon-sep list */
6579 tree_node *t = NULL;
6580 const uschar * list;
6583 uschar * suffix = US"";
6584 BOOL needsep = FALSE;
6587 if (*sub == '+') sub++;
6588 if (arg == NULL) /* no-argument version */
6590 if (!(t = tree_search(addresslist_anchor, sub)) &&
6591 !(t = tree_search(domainlist_anchor, sub)) &&
6592 !(t = tree_search(hostlist_anchor, sub)))
6593 t = tree_search(localpartlist_anchor, sub);
6595 else switch(*arg) /* specific list-type version */
6597 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6598 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6599 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6600 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6602 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6608 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6610 : *arg=='a'?"address "
6611 : *arg=='d'?"domain "
6613 : *arg=='l'?"localpart "
6618 list = ((namedlist_block *)(t->data.ptr))->string;
6620 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
6622 uschar * buf = US" : ";
6624 yield = string_catn(yield, buf, 3);
6628 if (*item == '+') /* list item is itself a named list */
6630 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6631 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6633 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6637 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6638 while ((cp= strpbrk(CCS item, tok)))
6640 yield = string_catn(yield, item, cp - CS item);
6641 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6643 yield = string_catn(yield, US"::", 2);
6646 else /* sep in item; should already be doubled; emit once */
6648 yield = string_catn(yield, US tok, 1);
6649 if (*cp == sep) cp++;
6654 yield = string_cat(yield, item);
6659 /* mask applies a mask to an IP address; for example the result of
6660 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6667 int mask, maskoffset;
6668 int type = string_is_ip_address(sub, &maskoffset);
6673 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6678 if (maskoffset == 0)
6680 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6685 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6687 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6689 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6694 /* Convert the address to binary integer(s) and apply the mask */
6696 sub[maskoffset] = 0;
6697 count = host_aton(sub, binary);
6698 host_mask(count, binary, mask);
6700 /* Convert to masked textual format and add to output. */
6702 yield = string_catn(yield, buffer,
6703 host_nmtoa(count, binary, mask, buffer, '.'));
6708 case EOP_IPV6DENORM:
6710 int type = string_is_ip_address(sub, NULL);
6717 (void) host_aton(sub, binary);
6720 case 4: /* convert to IPv4-mapped IPv6 */
6721 binary[0] = binary[1] = 0;
6722 binary[2] = 0x0000ffff;
6723 (void) host_aton(sub, binary+3);
6727 expand_string_message =
6728 string_sprintf("\"%s\" is not an IP address", sub);
6732 yield = string_catn(yield, buffer, c == EOP_IPV6NORM
6733 ? ipv6_nmtoa(binary, buffer)
6734 : host_nmtoa(4, binary, -1, buffer, ':')
6740 case EOP_LOCAL_PART:
6744 int start, end, domain;
6745 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
6748 if (c != EOP_DOMAIN)
6750 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6751 yield = string_catn(yield, sub+start, end-start);
6753 else if (domain != 0)
6756 yield = string_catn(yield, sub+domain, end-domain);
6763 uschar outsep[2] = { ':', '\0' };
6764 uschar *address, *error;
6765 int save_ptr = yield->ptr;
6766 int start, end, domain; /* Not really used */
6768 while (isspace(*sub)) sub++;
6769 if (*sub == '>') { *outsep = *++sub; ++sub; }
6770 parse_allow_group = TRUE;
6774 uschar *p = parse_find_address_end(sub, FALSE);
6775 uschar saveend = *p;
6777 address = parse_extract_address(sub, &error, &start, &end, &domain,
6781 /* Add the address to the output list that we are building. This is
6782 done in chunks by searching for the separator character. At the
6783 start, unless we are dealing with the first address of the output
6784 list, add in a space if the new address begins with the separator
6785 character, or is an empty string. */
6787 if (address != NULL)
6789 if (yield->ptr != save_ptr && address[0] == *outsep)
6790 yield = string_catn(yield, US" ", 1);
6794 size_t seglen = Ustrcspn(address, outsep);
6795 yield = string_catn(yield, address, seglen + 1);
6797 /* If we got to the end of the string we output one character
6800 if (address[seglen] == '\0') { yield->ptr--; break; }
6801 yield = string_catn(yield, outsep, 1);
6802 address += seglen + 1;
6805 /* Output a separator after the string: we will remove the
6806 redundant final one at the end. */
6808 yield = string_catn(yield, outsep, 1);
6811 if (saveend == '\0') break;
6815 /* If we have generated anything, remove the redundant final
6818 if (yield->ptr != save_ptr) yield->ptr--;
6819 parse_allow_group = FALSE;
6824 /* quote puts a string in quotes if it is empty or contains anything
6825 other than alphamerics, underscore, dot, or hyphen.
6827 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6828 be quoted in order to be a valid local part.
6830 In both cases, newlines and carriage returns are converted into \n and \r
6834 case EOP_QUOTE_LOCAL_PART:
6837 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6838 uschar *t = sub - 1;
6842 while (!needs_quote && *(++t) != 0)
6843 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6845 else /* EOP_QUOTE_LOCAL_PART */
6847 while (!needs_quote && *(++t) != 0)
6848 needs_quote = !isalnum(*t) &&
6849 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6850 (*t != '.' || t == sub || t[1] == 0);
6855 yield = string_catn(yield, US"\"", 1);
6860 yield = string_catn(yield, US"\\n", 2);
6861 else if (*t == '\r')
6862 yield = string_catn(yield, US"\\r", 2);
6865 if (*t == '\\' || *t == '"')
6866 yield = string_catn(yield, US"\\", 1);
6867 yield = string_catn(yield, t, 1);
6870 yield = string_catn(yield, US"\"", 1);
6872 else yield = string_cat(yield, sub);
6876 /* quote_lookuptype does lookup-specific quoting */
6881 uschar *opt = Ustrchr(arg, '_');
6883 if (opt != NULL) *opt++ = 0;
6885 n = search_findtype(arg, Ustrlen(arg));
6888 expand_string_message = search_error_message;
6892 if (lookup_list[n]->quote != NULL)
6893 sub = (lookup_list[n]->quote)(sub, opt);
6894 else if (opt != NULL) sub = NULL;
6898 expand_string_message = string_sprintf(
6899 "\"%s\" unrecognized after \"${quote_%s\"",
6904 yield = string_cat(yield, sub);
6908 /* rx quote sticks in \ before any non-alphameric character so that
6909 the insertion works in a regular expression. */
6913 uschar *t = sub - 1;
6917 yield = string_catn(yield, US"\\", 1);
6918 yield = string_catn(yield, t, 1);
6923 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6924 prescribed by the RFC, if there are characters that need to be encoded */
6928 uschar buffer[2048];
6929 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6930 buffer, sizeof(buffer), FALSE);
6931 yield = string_cat(yield, string);
6935 /* RFC 2047 decode */
6941 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6942 headers_charset, '?', &len, &error);
6945 expand_string_message = error;
6948 yield = string_catn(yield, decoded, len);
6952 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6962 if (c > 255) c = '_';
6964 yield = string_catn(yield, buff, 1);
6969 /* replace illegal UTF-8 sequences by replacement character */
6971 #define UTF8_REPLACEMENT_CHAR US"?"
6975 int seq_len = 0, index = 0;
6977 long codepoint = -1;
6978 uschar seq_buff[4]; /* accumulate utf-8 here */
6987 if ((c & 0xc0) != 0x80)
6988 /* wrong continuation byte; invalidate all bytes */
6989 complete = 1; /* error */
6992 codepoint = (codepoint << 6) | (c & 0x3f);
6993 seq_buff[index++] = c;
6994 if (--bytes_left == 0) /* codepoint complete */
6995 if(codepoint > 0x10FFFF) /* is it too large? */
6996 complete = -1; /* error (RFC3629 limit) */
6998 { /* finished; output utf-8 sequence */
6999 yield = string_catn(yield, seq_buff, seq_len);
7004 else /* no bytes left: new sequence */
7006 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7008 yield = string_catn(yield, &c, 1);
7011 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7013 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7018 codepoint = c & 0x1f;
7021 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7024 codepoint = c & 0x0f;
7026 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7029 codepoint = c & 0x07;
7031 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7034 seq_buff[index++] = c;
7035 seq_len = bytes_left + 1;
7036 } /* if(bytes_left) */
7040 bytes_left = index = 0;
7041 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7043 if ((complete == 1) && ((c & 0x80) == 0))
7044 /* ASCII character follows incomplete sequence */
7045 yield = string_catn(yield, &c, 1);
7051 case EOP_UTF8_DOMAIN_TO_ALABEL:
7053 uschar * error = NULL;
7054 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7057 expand_string_message = string_sprintf(
7058 "error converting utf8 (%s) to alabel: %s",
7059 string_printing(sub), error);
7062 yield = string_cat(yield, s);
7066 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7068 uschar * error = NULL;
7069 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7072 expand_string_message = string_sprintf(
7073 "error converting alabel (%s) to utf8: %s",
7074 string_printing(sub), error);
7077 yield = string_cat(yield, s);
7081 case EOP_UTF8_LOCALPART_TO_ALABEL:
7083 uschar * error = NULL;
7084 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7087 expand_string_message = string_sprintf(
7088 "error converting utf8 (%s) to alabel: %s",
7089 string_printing(sub), error);
7092 yield = string_cat(yield, s);
7093 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield->s);
7097 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7099 uschar * error = NULL;
7100 uschar * s = string_localpart_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, s);
7111 #endif /* EXPERIMENTAL_INTERNATIONAL */
7113 /* escape turns all non-printing characters into escape sequences. */
7117 const uschar * t = string_printing(sub);
7118 yield = string_cat(yield, t);
7122 case EOP_ESCAPE8BIT:
7124 const uschar * s = sub;
7127 for (s = sub; (c = *s); s++)
7128 yield = c < 127 && c != '\\'
7129 ? string_catn(yield, s, 1)
7130 : string_catn(yield, string_sprintf("\\%03o", c), 4);
7134 /* Handle numeric expression evaluation */
7139 uschar *save_sub = sub;
7140 uschar *error = NULL;
7141 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7144 expand_string_message = string_sprintf("error in expression "
7145 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
7149 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
7150 yield = string_cat(yield, var_buffer);
7154 /* Handle time period formating */
7158 int n = readconf_readtime(sub, 0, FALSE);
7161 expand_string_message = string_sprintf("string \"%s\" is not an "
7162 "Exim time interval in \"%s\" operator", sub, name);
7165 sprintf(CS var_buffer, "%d", n);
7166 yield = string_cat(yield, var_buffer);
7170 case EOP_TIME_INTERVAL:
7173 uschar *t = read_number(&n, sub);
7174 if (*t != 0) /* Not A Number*/
7176 expand_string_message = string_sprintf("string \"%s\" is not a "
7177 "positive number in \"%s\" operator", sub, name);
7180 t = readconf_printtime(n);
7181 yield = string_cat(yield, t);
7185 /* Convert string to base64 encoding */
7191 uschar * s = vp && *(void **)vp->value
7192 ? tls_cert_der_b64(*(void **)vp->value)
7193 : b64encode(sub, Ustrlen(sub));
7195 uschar * s = b64encode(sub, Ustrlen(sub));
7197 yield = string_cat(yield, s);
7204 int len = b64decode(sub, &s);
7207 expand_string_message = string_sprintf("string \"%s\" is not "
7208 "well-formed for \"%s\" operator", sub, name);
7211 yield = string_cat(yield, s);
7215 /* strlen returns the length of the string */
7220 (void)sprintf(CS buff, "%d", Ustrlen(sub));
7221 yield = string_cat(yield, buff);
7225 /* length_n or l_n takes just the first n characters or the whole string,
7226 whichever is the shorter;
7228 substr_m_n, and s_m_n take n characters from offset m; negative m take
7229 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7230 takes the rest, either to the right or to the left.
7232 hash_n or h_n makes a hash of length n from the string, yielding n
7233 characters from the set a-z; hash_n_m makes a hash of length n, but
7234 uses m characters from the set a-zA-Z0-9.
7236 nhash_n returns a single number between 0 and n-1 (in text form), while
7237 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7238 between 0 and n-1 and the second between 0 and m-1. */
7258 expand_string_message = string_sprintf("missing values after %s",
7263 /* "length" has only one argument, effectively being synonymous with
7266 if (c == EOP_LENGTH || c == EOP_L)
7272 /* The others have one or two arguments; for "substr" the first may be
7273 negative. The second being negative means "not supplied". */
7278 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7281 /* Read up to two numbers, separated by underscores */
7286 if (arg != ret && *arg == '_' && pn == &value1)
7290 if (arg[1] != 0) arg++;
7292 else if (!isdigit(*arg))
7294 expand_string_message =
7295 string_sprintf("non-digit after underscore in \"%s\"", name);
7298 else *pn = (*pn)*10 + *arg++ - '0';
7302 /* Perform the required operation */
7305 (c == EOP_HASH || c == EOP_H)?
7306 compute_hash(sub, value1, value2, &len) :
7307 (c == EOP_NHASH || c == EOP_NH)?
7308 compute_nhash(sub, value1, value2, &len) :
7309 extract_substr(sub, value1, value2, &len);
7311 if (ret == NULL) goto EXPAND_FAILED;
7312 yield = string_catn(yield, ret, len);
7322 uschar **modetable[3];
7327 if ((expand_forbid & RDO_EXISTS) != 0)
7329 expand_string_message = US"Use of the stat() expansion is not permitted";
7333 if (stat(CS sub, &st) < 0)
7335 expand_string_message = string_sprintf("stat(%s) failed: %s",
7336 sub, strerror(errno));
7340 switch (mode & S_IFMT)
7342 case S_IFIFO: smode[0] = 'p'; break;
7343 case S_IFCHR: smode[0] = 'c'; break;
7344 case S_IFDIR: smode[0] = 'd'; break;
7345 case S_IFBLK: smode[0] = 'b'; break;
7346 case S_IFREG: smode[0] = '-'; break;
7347 default: smode[0] = '?'; break;
7350 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7351 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7352 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7354 for (i = 0; i < 3; i++)
7356 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7361 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7362 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7363 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7364 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7365 (long)st.st_gid, st.st_size, (long)st.st_atime,
7366 (long)st.st_mtime, (long)st.st_ctime);
7367 yield = string_cat(yield, s);
7371 /* vaguely random number less than N */
7375 int_eximarith_t max;
7378 max = expanded_string_integer(sub, TRUE);
7379 if (expand_string_message != NULL)
7381 s = string_sprintf("%d", vaguely_random_number((int)max));
7382 yield = string_cat(yield, s);
7386 /* Reverse IP, including IPv6 to dotted-nibble */
7388 case EOP_REVERSE_IP:
7390 int family, maskptr;
7391 uschar reversed[128];
7393 family = string_is_ip_address(sub, &maskptr);
7396 expand_string_message = string_sprintf(
7397 "reverse_ip() not given an IP address [%s]", sub);
7400 invert_address(reversed, sub);
7401 yield = string_cat(yield, reversed);
7405 /* Unknown operator */
7408 expand_string_message =
7409 string_sprintf("unknown expansion operator \"%s\"", name);
7414 /* Handle a plain name. If this is the first thing in the expansion, release
7415 the pre-allocated buffer. If the result data is known to be in a new buffer,
7416 newsize will be set to the size of that buffer, and we can just point at that
7417 store instead of copying. Many expansion strings contain just one reference,
7418 so this is a useful optimization, especially for humungous headers
7419 ($message_headers). */
7427 if (yield && yield->ptr == 0)
7429 if (resetok) store_reset(yield);
7431 g = store_get(sizeof(gstring));
7433 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
7435 expand_string_message =
7436 string_sprintf("unknown variable in \"${%s}\"", name);
7437 check_variable_error_message(name);
7440 len = Ustrlen(value);
7441 if (!yield && newsize)
7444 yield->size = newsize;
7449 yield = string_catn(yield, value, len);
7453 /* Else there's something wrong */
7455 expand_string_message =
7456 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7457 "in a variable reference)", name);
7461 /* If we hit the end of the string when ket_ends is set, there is a missing
7462 terminating brace. */
7464 if (ket_ends && *s == 0)
7466 expand_string_message = malformed_header?
7467 US"missing } at end of string - could be header name not terminated by colon"
7469 US"missing } at end of string";
7473 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7474 added to the string. If so, set up an empty string. Add a terminating zero. If
7475 left != NULL, return a pointer to the terminator. */
7478 yield = string_get(1);
7479 (void) string_from_gstring(yield);
7480 if (left) *left = s;
7482 /* Any stacking store that was used above the final string is no longer needed.
7483 In many cases the final string will be the first one that was got and so there
7484 will be optimal store usage. */
7486 if (resetok) store_reset(yield->s + (yield->size = yield->ptr + 1));
7487 else if (resetok_p) *resetok_p = FALSE;
7491 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
7492 "expanding: %.*s\n",
7493 (int)(s - string), string);
7494 debug_printf_indent("%s"
7495 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7497 skipping ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7500 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7501 "skipping: result is not used\n");
7506 /* This is the failure exit: easiest to program with a goto. We still need
7507 to update the pointer to the terminator, for cases of nested calls with "fail".
7510 EXPAND_FAILED_CURLY:
7511 if (malformed_header)
7512 expand_string_message =
7513 US"missing or misplaced { or } - could be header name not terminated by colon";
7515 else if (!expand_string_message || !*expand_string_message)
7516 expand_string_message = US"missing or misplaced { or }";
7518 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7519 that is a bad idea, because expand_string_message is in dynamic store. */
7522 if (left) *left = s;
7525 debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
7527 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7528 "error message: %s\n",
7529 expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
7530 expand_string_message);
7531 if (expand_string_forcedfail)
7532 debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
7534 if (resetok_p) *resetok_p = resetok;
7540 /* This is the external function call. Do a quick check for any expansion
7541 metacharacters, and if there are none, just return the input string.
7543 Argument: the string to be expanded
7544 Returns: the expanded string, or NULL if expansion failed; if failure was
7545 due to a lookup deferring, search_find_defer will be TRUE
7549 expand_string(uschar *string)
7551 search_find_defer = FALSE;
7552 malformed_header = FALSE;
7553 return (Ustrpbrk(string, "$\\") == NULL)? string :
7554 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7560 expand_cstring(const uschar *string)
7562 search_find_defer = FALSE;
7563 malformed_header = FALSE;
7564 return (Ustrpbrk(string, "$\\") == NULL)? string :
7565 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7570 /*************************************************
7572 *************************************************/
7574 /* Now and again we want to expand a string and be sure that the result is in a
7575 new bit of store. This function does that.
7576 Since we know it has been copied, the de-const cast is safe.
7578 Argument: the string to be expanded
7579 Returns: the expanded string, always in a new bit of store, or NULL
7583 expand_string_copy(const uschar *string)
7585 const uschar *yield = expand_cstring(string);
7586 if (yield == string) yield = string_copy(string);
7592 /*************************************************
7593 * Expand and interpret as an integer *
7594 *************************************************/
7596 /* Expand a string, and convert the result into an integer.
7599 string the string to be expanded
7600 isplus TRUE if a non-negative number is expected
7602 Returns: the integer value, or
7603 -1 for an expansion error ) in both cases, message in
7604 -2 for an integer interpretation error ) expand_string_message
7605 expand_string_message is set NULL for an OK integer
7609 expand_string_integer(uschar *string, BOOL isplus)
7611 return expanded_string_integer(expand_string(string), isplus);
7615 /*************************************************
7616 * Interpret string as an integer *
7617 *************************************************/
7619 /* Convert a string (that has already been expanded) into an integer.
7621 This function is used inside the expansion code.
7624 s the string to be expanded
7625 isplus TRUE if a non-negative number is expected
7627 Returns: the integer value, or
7628 -1 if string is NULL (which implies an expansion error)
7629 -2 for an integer interpretation error
7630 expand_string_message is set NULL for an OK integer
7633 static int_eximarith_t
7634 expanded_string_integer(const uschar *s, BOOL isplus)
7636 int_eximarith_t value;
7637 uschar *msg = US"invalid integer \"%s\"";
7640 /* If expansion failed, expand_string_message will be set. */
7642 if (s == NULL) return -1;
7644 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7645 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7646 systems, so we set it zero ourselves. */
7649 expand_string_message = NULL; /* Indicates no error */
7651 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7652 equal to 0. Unfortunately, people actually relied upon that, so preserve
7653 the behaviour explicitly. Stripping leading whitespace is a harmless
7654 noop change since strtol skips it anyway (provided that there is a number
7658 while (isspace(*s)) ++s;
7662 debug_printf_indent("treating blank string as number 0\n");
7667 value = strtoll(CS s, CSS &endptr, 10);
7671 msg = US"integer expected but \"%s\" found";
7673 else if (value < 0 && isplus)
7675 msg = US"non-negative integer expected but \"%s\" found";
7679 switch (tolower(*endptr))
7684 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7689 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7690 else value *= 1024*1024;
7694 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7695 else value *= 1024*1024*1024;
7699 if (errno == ERANGE)
7700 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7703 while (isspace(*endptr)) endptr++;
7704 if (*endptr == 0) return value;
7708 expand_string_message = string_sprintf(CS msg, s);
7713 /* These values are usually fixed boolean values, but they are permitted to be
7717 addr address being routed
7718 mtype the module type
7719 mname the module name
7720 dbg_opt debug selectors
7721 oname the option name
7722 bvalue the router's boolean value
7723 svalue the router's string value
7724 rvalue where to put the returned value
7726 Returns: OK value placed in rvalue
7727 DEFER expansion failed
7731 exp_bool(address_item *addr,
7732 uschar *mtype, uschar *mname, unsigned dbg_opt,
7733 uschar *oname, BOOL bvalue,
7734 uschar *svalue, BOOL *rvalue)
7737 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7739 expanded = expand_string(svalue);
7740 if (expanded == NULL)
7742 if (expand_string_forcedfail)
7744 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7748 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7749 oname, mname, mtype, expand_string_message);
7750 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7754 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7757 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7759 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7763 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7764 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7773 /* Avoid potentially exposing a password in a string about to be logged */
7776 expand_hide_passwords(uschar * s)
7778 return ( ( Ustrstr(s, "failed to expand") != NULL
7779 || Ustrstr(s, "expansion of ") != NULL
7781 && ( Ustrstr(s, "mysql") != NULL
7782 || Ustrstr(s, "pgsql") != NULL
7783 || Ustrstr(s, "redis") != NULL
7784 || Ustrstr(s, "sqlite") != NULL
7785 || Ustrstr(s, "ldap:") != NULL
7786 || Ustrstr(s, "ldaps:") != NULL
7787 || Ustrstr(s, "ldapi:") != NULL
7788 || Ustrstr(s, "ldapdn:") != NULL
7789 || Ustrstr(s, "ldapm:") != NULL
7791 ? US"Temporary internal error" : s;
7796 /*************************************************
7797 * Error-checking for testsuite *
7798 *************************************************/
7800 const char * filename;
7802 uschar * region_start;
7803 uschar * region_end;
7804 const uschar *var_name;
7805 const uschar *var_data;
7809 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
7812 if (var_data >= e->region_start && var_data < e->region_end)
7814 e->var_name = CUS var_name;
7815 e->var_data = CUS var_data;
7820 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
7822 err_ctx e = {filename, linenumber, ptr, US ptr + len, NULL };
7826 /* check acl_ variables */
7827 tree_walk(acl_var_c, assert_variable_notin, &e);
7828 tree_walk(acl_var_m, assert_variable_notin, &e);
7830 /* check auth<n> variables */
7831 for (i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
7832 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
7834 /* check regex<n> variables */
7835 for (i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
7836 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
7838 /* check known-name variables */
7839 for (v = var_table; v < var_table + var_table_size; v++)
7840 if (v->type == vtype_stringptr)
7841 assert_variable_notin(US v->name, *(USS v->value), &e);
7844 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
7845 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
7846 e.var_name, e.filename, e.linenumber, e.var_data);
7851 /*************************************************
7852 **************************************************
7853 * Stand-alone test program *
7854 **************************************************
7855 *************************************************/
7861 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7863 int ovector[3*(EXPAND_MAXN+1)];
7864 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7865 ovector, nelem(ovector));
7866 BOOL yield = n >= 0;
7867 if (n == 0) n = EXPAND_MAXN + 1;
7871 expand_nmax = (setup < 0)? 0 : setup + 1;
7872 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7874 expand_nstring[expand_nmax] = subject + ovector[nn];
7875 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7883 int main(int argc, uschar **argv)
7886 uschar buffer[1024];
7888 debug_selector = D_v;
7889 debug_file = stderr;
7890 debug_fd = fileno(debug_file);
7891 big_buffer = malloc(big_buffer_size);
7893 for (i = 1; i < argc; i++)
7895 if (argv[i][0] == '+')
7897 debug_trace_memory = 2;
7900 if (isdigit(argv[i][0]))
7901 debug_selector = Ustrtol(argv[i], NULL, 0);
7903 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7907 eldap_default_servers = argv[i];
7910 mysql_servers = argv[i];
7913 pgsql_servers = argv[i];
7916 redis_servers = argv[i];
7920 else opt_perl_startup = argv[i];
7924 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7926 expand_nstring[1] = US"string 1....";
7927 expand_nlength[1] = 8;
7931 if (opt_perl_startup != NULL)
7934 printf("Starting Perl interpreter\n");
7935 errstr = init_perl(opt_perl_startup);
7938 printf("** error in perl_startup code: %s\n", errstr);
7939 return EXIT_FAILURE;
7942 #endif /* EXIM_PERL */
7944 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7946 void *reset_point = store_get(0);
7947 uschar *yield = expand_string(buffer);
7950 printf("%s\n", yield);
7951 store_reset(reset_point);
7955 if (search_find_defer) printf("search_find deferred\n");
7956 printf("Failed: %s\n", expand_string_message);
7957 if (expand_string_forcedfail) printf("Forced failure\n");
7971 /* End of expand.c */