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 },
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_count_at_connection_start", vtype_int, &smtp_accept_count },
684 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
685 { "sn0", vtype_filter_int, &filter_sn[0] },
686 { "sn1", vtype_filter_int, &filter_sn[1] },
687 { "sn2", vtype_filter_int, &filter_sn[2] },
688 { "sn3", vtype_filter_int, &filter_sn[3] },
689 { "sn4", vtype_filter_int, &filter_sn[4] },
690 { "sn5", vtype_filter_int, &filter_sn[5] },
691 { "sn6", vtype_filter_int, &filter_sn[6] },
692 { "sn7", vtype_filter_int, &filter_sn[7] },
693 { "sn8", vtype_filter_int, &filter_sn[8] },
694 { "sn9", vtype_filter_int, &filter_sn[9] },
695 #ifdef WITH_CONTENT_SCAN
696 { "spam_action", vtype_stringptr, &spam_action },
697 { "spam_bar", vtype_stringptr, &spam_bar },
698 { "spam_report", vtype_stringptr, &spam_report },
699 { "spam_score", vtype_stringptr, &spam_score },
700 { "spam_score_int", vtype_stringptr, &spam_score_int },
702 #ifdef EXPERIMENTAL_SPF
703 { "spf_guess", vtype_stringptr, &spf_guess },
704 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
705 { "spf_received", vtype_stringptr, &spf_received },
706 { "spf_result", vtype_stringptr, &spf_result },
707 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
709 { "spool_directory", vtype_stringptr, &spool_directory },
710 { "spool_inodes", vtype_pinodes, (void *)TRUE },
711 { "spool_space", vtype_pspace, (void *)TRUE },
712 #ifdef EXPERIMENTAL_SRS
713 { "srs_db_address", vtype_stringptr, &srs_db_address },
714 { "srs_db_key", vtype_stringptr, &srs_db_key },
715 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
716 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
717 { "srs_recipient", vtype_stringptr, &srs_recipient },
718 { "srs_status", vtype_stringptr, &srs_status },
720 { "thisaddress", vtype_stringptr, &filter_thisaddress },
722 /* The non-(in,out) variables are now deprecated */
723 { "tls_bits", vtype_int, &tls_in.bits },
724 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
725 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
727 { "tls_in_bits", vtype_int, &tls_in.bits },
728 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
729 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
730 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
731 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
732 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
733 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
734 #if defined(SUPPORT_TLS)
735 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
737 { "tls_out_bits", vtype_int, &tls_out.bits },
738 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
739 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
740 #ifdef EXPERIMENTAL_DANE
741 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
743 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
744 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
745 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
746 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
747 #if defined(SUPPORT_TLS)
748 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
750 #ifdef EXPERIMENTAL_DANE
751 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
754 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
755 #if defined(SUPPORT_TLS)
756 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
759 { "tod_bsdinbox", vtype_todbsdin, NULL },
760 { "tod_epoch", vtype_tode, NULL },
761 { "tod_epoch_l", vtype_todel, NULL },
762 { "tod_full", vtype_todf, NULL },
763 { "tod_log", vtype_todl, NULL },
764 { "tod_logfile", vtype_todlf, NULL },
765 { "tod_zone", vtype_todzone, NULL },
766 { "tod_zulu", vtype_todzulu, NULL },
767 { "transport_name", vtype_stringptr, &transport_name },
768 { "value", vtype_stringptr, &lookup_value },
769 { "verify_mode", vtype_stringptr, &verify_mode },
770 { "version_number", vtype_stringptr, &version_string },
771 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
772 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
773 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
774 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
775 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
776 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
779 static int var_table_size = nelem(var_table);
780 static uschar var_buffer[256];
781 static BOOL malformed_header;
783 /* For textual hashes */
785 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
786 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
789 enum { HMAC_MD5, HMAC_SHA1 };
791 /* For numeric hashes */
793 static unsigned int prime[] = {
794 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
795 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
796 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
798 /* For printing modes in symbolic form */
800 static uschar *mtable_normal[] =
801 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
803 static uschar *mtable_setid[] =
804 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
806 static uschar *mtable_sticky[] =
807 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
811 /*************************************************
812 * Tables for UTF-8 support *
813 *************************************************/
815 /* Table of the number of extra characters, indexed by the first character
816 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
819 static uschar utf8_table1[] = {
820 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
821 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
822 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
823 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
825 /* These are the masks for the data bits in the first byte of a character,
826 indexed by the number of additional bytes. */
828 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
830 /* Get the next UTF-8 character, advancing the pointer. */
832 #define GETUTF8INC(c, ptr) \
834 if ((c & 0xc0) == 0xc0) \
836 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
838 c = (c & utf8_table2[a]) << s; \
842 c |= (*ptr++ & 0x3f) << s; \
848 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
850 /*************************************************
851 * Binary chop search on a table *
852 *************************************************/
854 /* This is used for matching expansion items and operators.
857 name the name that is being sought
858 table the table to search
859 table_size the number of items in the table
861 Returns: the offset in the table, or -1
865 chop_match(uschar *name, uschar **table, int table_size)
867 uschar **bot = table;
868 uschar **top = table + table_size;
872 uschar **mid = bot + (top - bot)/2;
873 int c = Ustrcmp(name, *mid);
874 if (c == 0) return mid - table;
875 if (c > 0) bot = mid + 1; else top = mid;
883 /*************************************************
884 * Check a condition string *
885 *************************************************/
887 /* This function is called to expand a string, and test the result for a "true"
888 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
889 forced fail or lookup defer.
891 We used to release all store used, but this is not not safe due
892 to ${dlfunc } and ${acl }. In any case expand_string_internal()
893 is reasonably careful to release what it can.
895 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
898 condition the condition string
899 m1 text to be incorporated in panic error
902 Returns: TRUE if condition is met, FALSE if not
906 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
909 uschar *ss = expand_string(condition);
912 if (!expand_string_forcedfail && !search_find_defer)
913 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
914 "for %s %s: %s", condition, m1, m2, expand_string_message);
917 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
918 strcmpic(ss, US"false") != 0;
925 /*************************************************
926 * Pseudo-random number generation *
927 *************************************************/
929 /* Pseudo-random number generation. The result is not "expected" to be
930 cryptographically strong but not so weak that someone will shoot themselves
931 in the foot using it as a nonce in some email header scheme or whatever
932 weirdness they'll twist this into. The result should ideally handle fork().
934 However, if we're stuck unable to provide this, then we'll fall back to
935 appallingly bad randomness.
937 If SUPPORT_TLS is defined then this will not be used except as an emergency
942 Returns a random number in range [0, max-1]
946 # define vaguely_random_number vaguely_random_number_fallback
949 vaguely_random_number(int max)
952 # undef vaguely_random_number
954 static pid_t pid = 0;
956 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
966 #ifdef HAVE_ARC4RANDOM
967 /* cryptographically strong randomness, common on *BSD platforms, not
968 so much elsewhere. Alas. */
969 #ifndef NOT_HAVE_ARC4RANDOM_STIR
972 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
973 #ifdef HAVE_SRANDOMDEV
974 /* uses random(4) for seeding */
977 gettimeofday(&tv, NULL);
978 srandom(tv.tv_sec | tv.tv_usec | getpid());
981 /* Poor randomness and no seeding here */
988 #ifdef HAVE_ARC4RANDOM
989 return arc4random() % max;
990 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
991 return random() % max;
993 /* This one returns a 16-bit number, definitely not crypto-strong */
994 return random_number(max);
1001 /*************************************************
1002 * Pick out a name from a string *
1003 *************************************************/
1005 /* If the name is too long, it is silently truncated.
1008 name points to a buffer into which to put the name
1009 max is the length of the buffer
1010 s points to the first alphabetic character of the name
1011 extras chars other than alphanumerics to permit
1013 Returns: pointer to the first character after the name
1015 Note: The test for *s != 0 in the while loop is necessary because
1016 Ustrchr() yields non-NULL if the character is zero (which is not something
1019 static const uschar *
1020 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1023 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1025 if (ptr < max-1) name[ptr++] = *s;
1034 /*************************************************
1035 * Pick out the rest of a header name *
1036 *************************************************/
1038 /* A variable name starting $header_ (or just $h_ for those who like
1039 abbreviations) might not be the complete header name because headers can
1040 contain any printing characters in their names, except ':'. This function is
1041 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1042 on the end, if the name was terminated by white space.
1045 name points to a buffer in which the name read so far exists
1046 max is the length of the buffer
1047 s points to the first character after the name so far, i.e. the
1048 first non-alphameric character after $header_xxxxx
1050 Returns: a pointer to the first character after the header name
1053 static const uschar *
1054 read_header_name(uschar *name, int max, const uschar *s)
1056 int prelen = Ustrchr(name, '_') - name + 1;
1057 int ptr = Ustrlen(name) - prelen;
1058 if (ptr > 0) memmove(name, name+prelen, ptr);
1059 while (mac_isgraph(*s) && *s != ':')
1061 if (ptr < max-1) name[ptr++] = *s;
1072 /*************************************************
1073 * Pick out a number from a string *
1074 *************************************************/
1077 n points to an integer into which to put the number
1078 s points to the first digit of the number
1080 Returns: a pointer to the character after the last digit
1082 /*XXX consider expanding to int_eximarith_t. But the test for
1083 "overbig numbers" in 0002 still needs to overflow it. */
1086 read_number(int *n, uschar *s)
1089 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1093 static const uschar *
1094 read_cnumber(int *n, const uschar *s)
1097 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1103 /*************************************************
1104 * Extract keyed subfield from a string *
1105 *************************************************/
1107 /* The yield is in dynamic store; NULL means that the key was not found.
1110 key points to the name of the key
1111 s points to the string from which to extract the subfield
1113 Returns: NULL if the subfield was not found, or
1114 a pointer to the subfield's data
1118 expand_getkeyed(uschar *key, const uschar *s)
1120 int length = Ustrlen(key);
1121 while (isspace(*s)) s++;
1123 /* Loop to search for the key */
1129 const uschar *dkey = s;
1131 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1132 dkeylength = s - dkey;
1133 while (isspace(*s)) s++;
1134 if (*s == '=') while (isspace((*(++s))));
1136 data = string_dequote(&s);
1137 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1140 while (isspace(*s)) s++;
1149 find_var_ent(uschar * name)
1152 int last = var_table_size;
1154 while (last > first)
1156 int middle = (first + last)/2;
1157 int c = Ustrcmp(name, var_table[middle].name);
1159 if (c > 0) { first = middle + 1; continue; }
1160 if (c < 0) { last = middle; continue; }
1161 return &var_table[middle];
1166 /*************************************************
1167 * Extract numbered subfield from string *
1168 *************************************************/
1170 /* Extracts a numbered field from a string that is divided by tokens - for
1171 example a line from /etc/passwd is divided by colon characters. First field is
1172 numbered one. Negative arguments count from the right. Zero returns the whole
1173 string. Returns NULL if there are insufficient tokens in the string
1176 Modifies final argument - this is a dynamically generated string, so that's OK.
1179 field number of field to be extracted,
1180 first field = 1, whole string = 0, last field = -1
1181 separators characters that are used to break string into tokens
1182 s points to the string from which to extract the subfield
1184 Returns: NULL if the field was not found,
1185 a pointer to the field's data inside s (modified to add 0)
1189 expand_gettokened (int field, uschar *separators, uschar *s)
1194 uschar *fieldtext = NULL;
1196 if (field == 0) return s;
1198 /* Break the line up into fields in place; for field > 0 we stop when we have
1199 done the number of fields we want. For field < 0 we continue till the end of
1200 the string, counting the number of fields. */
1202 count = (field > 0)? field : INT_MAX;
1208 /* Previous field was the last one in the string. For a positive field
1209 number, this means there are not enough fields. For a negative field number,
1210 check that there are enough, and scan back to find the one that is wanted. */
1214 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1215 if ((-field) == (INT_MAX - count - 1)) return s;
1219 while (ss[-1] != 0) ss--;
1225 /* Previous field was not last in the string; save its start and put a
1229 len = Ustrcspn(ss, separators);
1240 expand_getlistele(int field, const uschar * list)
1242 const uschar * tlist= list;
1248 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1251 if(field==0) return NULL;
1252 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1253 return string_nextinlist(&list, &sep, NULL, 0);
1257 /* Certificate fields, by name. Worry about by-OID later */
1258 /* Names are chosen to not have common prefixes */
1265 uschar * (*getfn)(void * cert, uschar * mod);
1267 static certfield certfields[] =
1268 { /* linear search; no special order */
1269 { US"version", 7, &tls_cert_version },
1270 { US"serial_number", 13, &tls_cert_serial_number },
1271 { US"subject", 7, &tls_cert_subject },
1272 { US"notbefore", 9, &tls_cert_not_before },
1273 { US"notafter", 8, &tls_cert_not_after },
1274 { US"issuer", 6, &tls_cert_issuer },
1275 { US"signature", 9, &tls_cert_signature },
1276 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1277 { US"subj_altname", 12, &tls_cert_subject_altname },
1278 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1279 { US"crl_uri", 7, &tls_cert_crl_uri },
1283 expand_getcertele(uschar * field, uschar * certvar)
1288 if (!(vp = find_var_ent(certvar)))
1290 expand_string_message =
1291 string_sprintf("no variable named \"%s\"", certvar);
1292 return NULL; /* Unknown variable name */
1294 /* NB this stops us passing certs around in variable. Might
1295 want to do that in future */
1296 if (vp->type != vtype_cert)
1298 expand_string_message =
1299 string_sprintf("\"%s\" is not a certificate", certvar);
1300 return NULL; /* Unknown variable name */
1302 if (!*(void **)vp->value)
1305 if (*field >= '0' && *field <= '9')
1306 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1308 for(cp = certfields;
1309 cp < certfields + nelem(certfields);
1311 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1313 uschar * modifier = *(field += cp->namelen) == ','
1315 return (*cp->getfn)( *(void **)vp->value, modifier );
1318 expand_string_message =
1319 string_sprintf("bad field selector \"%s\" for certextract", field);
1322 #endif /*SUPPORT_TLS*/
1324 /*************************************************
1325 * Extract a substring from a string *
1326 *************************************************/
1328 /* Perform the ${substr or ${length expansion operations.
1331 subject the input string
1332 value1 the offset from the start of the input string to the start of
1333 the output string; if negative, count from the right.
1334 value2 the length of the output string, or negative (-1) for unset
1335 if value1 is positive, unset means "all after"
1336 if value1 is negative, unset means "all before"
1337 len set to the length of the returned string
1339 Returns: pointer to the output string, or NULL if there is an error
1343 extract_substr(uschar *subject, int value1, int value2, int *len)
1345 int sublen = Ustrlen(subject);
1347 if (value1 < 0) /* count from right */
1351 /* If the position is before the start, skip to the start, and adjust the
1352 length. If the length ends up negative, the substring is null because nothing
1353 can precede. This falls out naturally when the length is unset, meaning "all
1359 if (value2 < 0) value2 = 0;
1363 /* Otherwise an unset length => characters before value1 */
1365 else if (value2 < 0)
1372 /* For a non-negative offset, if the starting position is past the end of the
1373 string, the result will be the null string. Otherwise, an unset length means
1374 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1378 if (value1 > sublen)
1383 else if (value2 < 0) value2 = sublen;
1386 /* Cut the length down to the maximum possible for the offset value, and get
1387 the required characters. */
1389 if (value1 + value2 > sublen) value2 = sublen - value1;
1391 return subject + value1;
1397 /*************************************************
1398 * Old-style hash of a string *
1399 *************************************************/
1401 /* Perform the ${hash expansion operation.
1404 subject the input string (an expanded substring)
1405 value1 the length of the output string; if greater or equal to the
1406 length of the input string, the input string is returned
1407 value2 the number of hash characters to use, or 26 if negative
1408 len set to the length of the returned string
1410 Returns: pointer to the output string, or NULL if there is an error
1414 compute_hash(uschar *subject, int value1, int value2, int *len)
1416 int sublen = Ustrlen(subject);
1418 if (value2 < 0) value2 = 26;
1419 else if (value2 > Ustrlen(hashcodes))
1421 expand_string_message =
1422 string_sprintf("hash count \"%d\" too big", value2);
1426 /* Calculate the hash text. We know it is shorter than the original string, so
1427 can safely place it in subject[] (we know that subject is always itself an
1428 expanded substring). */
1430 if (value1 < sublen)
1435 while ((c = (subject[j])) != 0)
1437 int shift = (c + j++) & 7;
1438 subject[i] ^= (c << shift) | (c >> (8-shift));
1439 if (++i >= value1) i = 0;
1441 for (i = 0; i < value1; i++)
1442 subject[i] = hashcodes[(subject[i]) % value2];
1444 else value1 = sublen;
1453 /*************************************************
1454 * Numeric hash of a string *
1455 *************************************************/
1457 /* Perform the ${nhash expansion operation. The first characters of the
1458 string are treated as most important, and get the highest prime numbers.
1461 subject the input string
1462 value1 the maximum value of the first part of the result
1463 value2 the maximum value of the second part of the result,
1464 or negative to produce only a one-part result
1465 len set to the length of the returned string
1467 Returns: pointer to the output string, or NULL if there is an error.
1471 compute_nhash (uschar *subject, int value1, int value2, int *len)
1473 uschar *s = subject;
1475 unsigned long int total = 0; /* no overflow */
1479 if (i == 0) i = nelem(prime) - 1;
1480 total += prime[i--] * (unsigned int)(*s++);
1483 /* If value2 is unset, just compute one number */
1487 s = string_sprintf("%d", total % value1);
1490 /* Otherwise do a div/mod hash */
1494 total = total % (value1 * value2);
1495 s = string_sprintf("%d/%d", total/value2, total % value2);
1506 /*************************************************
1507 * Find the value of a header or headers *
1508 *************************************************/
1510 /* Multiple instances of the same header get concatenated, and this function
1511 can also return a concatenation of all the header lines. When concatenating
1512 specific headers that contain lists of addresses, a comma is inserted between
1513 them. Otherwise we use a straight concatenation. Because some messages can have
1514 pathologically large number of lines, there is a limit on the length that is
1515 returned. Also, to avoid massive store use which would result from using
1516 string_cat() as it copies and extends strings, we do a preliminary pass to find
1517 out exactly how much store will be needed. On "normal" messages this will be
1521 name the name of the header, without the leading $header_ or $h_,
1522 or NULL if a concatenation of all headers is required
1523 exists_only TRUE if called from a def: test; don't need to build a string;
1524 just return a string that is not "" and not "0" if the header
1526 newsize return the size of memory block that was obtained; may be NULL
1527 if exists_only is TRUE
1528 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1529 other than concatenating, will be done on the header. Also used
1530 for $message_headers_raw.
1531 charset name of charset to translate MIME words to; used only if
1532 want_raw is false; if NULL, no translation is done (this is
1533 used for $bh_ and $bheader_)
1535 Returns: NULL if the header does not exist, else a pointer to a new
1540 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1543 BOOL found = name == NULL;
1545 int len = found? 0 : Ustrlen(name);
1547 uschar *yield = NULL;
1550 /* Loop for two passes - saves code repetition */
1552 for (i = 0; i < 2; i++)
1557 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1559 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1561 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1566 if (exists_only) return US"1"; /* don't need actual string */
1568 t = h->text + len; /* text to insert */
1569 if (!want_raw) /* unless wanted raw, */
1570 while (isspace(*t)) t++; /* remove leading white space */
1571 ilen = h->slen - (t - h->text); /* length to insert */
1573 /* Unless wanted raw, remove trailing whitespace, including the
1577 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1579 /* Set comma = 1 if handling a single header and it's one of those
1580 that contains an address list, except when asked for raw headers. Only
1581 need to do this once. */
1583 if (!want_raw && name != NULL && comma == 0 &&
1584 Ustrchr("BCFRST", h->type) != NULL)
1587 /* First pass - compute total store needed; second pass - compute
1588 total store used, including this header. */
1590 size += ilen + comma + 1; /* +1 for the newline */
1592 /* Second pass - concatenate the data, up to a maximum. Note that
1593 the loop stops when size hits the limit. */
1597 if (size > header_insert_maxlen)
1599 ilen -= size - header_insert_maxlen - 1;
1602 Ustrncpy(ptr, t, ilen);
1605 /* For a non-raw header, put in the comma if needed, then add
1606 back the newline we removed above, provided there was some text in
1609 if (!want_raw && ilen > 0)
1611 if (comma != 0) *ptr++ = ',';
1619 /* At end of first pass, return NULL if no header found. Then truncate size
1620 if necessary, and get the buffer to hold the data, returning the buffer size.
1625 if (!found) return NULL;
1626 if (size > header_insert_maxlen) size = header_insert_maxlen;
1627 *newsize = size + 1;
1628 ptr = yield = store_get(*newsize);
1632 /* That's all we do for raw header expansion. */
1639 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1640 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1641 function can return an error with decoded data if the charset translation
1642 fails. If decoding fails, it returns NULL. */
1646 uschar *decoded, *error;
1647 if (ptr > yield && ptr[-1] == '\n') ptr--;
1648 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1650 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1654 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1655 " input was: %s\n", error, yield);
1657 if (decoded != NULL) yield = decoded;
1666 /*************************************************
1667 * Return list of recipients *
1668 *************************************************/
1669 /* A recipients list is available only during system message filtering,
1670 during ACL processing after DATA, and while expanding pipe commands
1671 generated from a system filter, but not elsewhere. */
1676 if (!enable_dollar_recipients) return NULL; else
1681 uschar * s = store_get(size);
1682 for (i = 0; i < recipients_count; i++)
1684 if (i != 0) s = string_catn(s, &size, &ptr, US", ", 2);
1685 s = string_cat(s, &size, &ptr, recipients_list[i].address);
1687 s[ptr] = 0; /* string_cat() leaves room */
1693 /*************************************************
1694 * Find value of a variable *
1695 *************************************************/
1697 /* The table of variables is kept in alphabetic order, so we can search it
1698 using a binary chop. The "choplen" variable is nothing to do with the binary
1702 name the name of the variable being sought
1703 exists_only TRUE if this is a def: test; passed on to find_header()
1704 skipping TRUE => skip any processing evaluation; this is not the same as
1705 exists_only because def: may test for values that are first
1707 newsize pointer to an int which is initially zero; if the answer is in
1708 a new memory buffer, *newsize is set to its size
1710 Returns: NULL if the variable does not exist, or
1711 a pointer to the variable's contents, or
1712 something non-NULL if exists_only is TRUE
1716 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1723 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1724 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1725 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1726 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1727 (this gave backwards compatibility at the changeover). There may be built-in
1728 variables whose names start acl_ but they should never start in this way. This
1729 slightly messy specification is a consequence of the history, needless to say.
1731 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1732 set, in which case give an error. */
1734 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1738 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1739 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1742 /* Handle $auth<n> variables. */
1744 if (Ustrncmp(name, "auth", 4) == 0)
1747 int n = Ustrtoul(name + 4, &endptr, 10);
1748 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1749 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1751 else if (Ustrncmp(name, "regex", 5) == 0)
1754 int n = Ustrtoul(name + 5, &endptr, 10);
1755 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1756 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1759 /* For all other variables, search the table */
1761 if (!(vp = find_var_ent(name)))
1762 return NULL; /* Unknown variable name */
1764 /* Found an existing variable. If in skipping state, the value isn't needed,
1765 and we want to avoid processing (such as looking up the host name). */
1773 case vtype_filter_int:
1774 if (!filter_running) return NULL;
1778 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1782 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1786 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1790 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1794 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1797 case vtype_stringptr: /* Pointer to string */
1798 return (s = *((uschar **)(val))) ? s : US"";
1801 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1804 case vtype_load_avg:
1805 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1808 case vtype_host_lookup: /* Lookup if not done so */
1809 if (sender_host_name == NULL && sender_host_address != NULL &&
1810 !host_lookup_failed && host_name_lookup() == OK)
1811 host_build_sender_fullhost();
1812 return (sender_host_name == NULL)? US"" : sender_host_name;
1814 case vtype_localpart: /* Get local part from address */
1815 s = *((uschar **)(val));
1816 if (s == NULL) return US"";
1817 domain = Ustrrchr(s, '@');
1818 if (domain == NULL) return s;
1819 if (domain - s > sizeof(var_buffer) - 1)
1820 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1821 " in string expansion", sizeof(var_buffer));
1822 Ustrncpy(var_buffer, s, domain - s);
1823 var_buffer[domain - s] = 0;
1826 case vtype_domain: /* Get domain from address */
1827 s = *((uschar **)(val));
1828 if (s == NULL) return US"";
1829 domain = Ustrrchr(s, '@');
1830 return (domain == NULL)? US"" : domain + 1;
1832 case vtype_msgheaders:
1833 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1835 case vtype_msgheaders_raw:
1836 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1838 case vtype_msgbody: /* Pointer to msgbody string */
1839 case vtype_msgbody_end: /* Ditto, the end of the msg */
1840 ss = (uschar **)(val);
1841 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1844 off_t start_offset = SPOOL_DATA_START_OFFSET;
1845 int len = message_body_visible;
1846 if (len > message_size) len = message_size;
1847 *ss = body = store_malloc(len+1);
1849 if (vp->type == vtype_msgbody_end)
1851 struct stat statbuf;
1852 if (fstat(deliver_datafile, &statbuf) == 0)
1854 start_offset = statbuf.st_size - len;
1855 if (start_offset < SPOOL_DATA_START_OFFSET)
1856 start_offset = SPOOL_DATA_START_OFFSET;
1859 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1860 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1862 len = read(deliver_datafile, body, len);
1866 if (message_body_newlines) /* Separate loops for efficiency */
1868 { if (body[--len] == 0) body[len] = ' '; }
1871 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1874 return (*ss == NULL)? US"" : *ss;
1876 case vtype_todbsdin: /* BSD inbox time of day */
1877 return tod_stamp(tod_bsdin);
1879 case vtype_tode: /* Unix epoch time of day */
1880 return tod_stamp(tod_epoch);
1882 case vtype_todel: /* Unix epoch/usec time of day */
1883 return tod_stamp(tod_epoch_l);
1885 case vtype_todf: /* Full time of day */
1886 return tod_stamp(tod_full);
1888 case vtype_todl: /* Log format time of day */
1889 return tod_stamp(tod_log_bare); /* (without timezone) */
1891 case vtype_todzone: /* Time zone offset only */
1892 return tod_stamp(tod_zone);
1894 case vtype_todzulu: /* Zulu time */
1895 return tod_stamp(tod_zulu);
1897 case vtype_todlf: /* Log file datestamp tod */
1898 return tod_stamp(tod_log_datestamp_daily);
1900 case vtype_reply: /* Get reply address */
1901 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1903 if (s != NULL) while (isspace(*s)) s++;
1904 if (s == NULL || *s == 0)
1906 *newsize = 0; /* For the *s==0 case */
1907 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1912 while (isspace(*s)) s++;
1913 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1914 while (t > s && isspace(t[-1])) t--;
1917 return (s == NULL)? US"" : s;
1919 case vtype_string_func:
1921 uschar * (*fn)() = val;
1928 sprintf(CS var_buffer, "%d",
1929 receive_statvfs(val == (void *)TRUE, &inodes));
1936 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1937 sprintf(CS var_buffer, "%d", inodes);
1942 return *(void **)val ? US"<cert>" : US"";
1944 #ifndef DISABLE_DKIM
1946 return dkim_exim_expand_query((int)(long)val);
1951 return NULL; /* Unknown variable. Silences static checkers. */
1958 modify_variable(uschar *name, void * value)
1961 if ((vp = find_var_ent(name))) vp->value = value;
1962 return; /* Unknown variable name, fail silently */
1970 /*************************************************
1971 * Read and expand substrings *
1972 *************************************************/
1974 /* This function is called to read and expand argument substrings for various
1975 expansion items. Some have a minimum requirement that is less than the maximum;
1976 in these cases, the first non-present one is set to NULL.
1979 sub points to vector of pointers to set
1980 n maximum number of substrings
1982 sptr points to current string pointer
1983 skipping the skipping flag
1984 check_end if TRUE, check for final '}'
1985 name name of item, for error message
1986 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1989 Returns: 0 OK; string pointer updated
1990 1 curly bracketing error (too few arguments)
1991 2 too many arguments (only if check_end is set); message set
1992 3 other error (expansion failure)
1996 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1997 BOOL check_end, uschar *name, BOOL *resetok)
2000 const uschar *s = *sptr;
2002 while (isspace(*s)) s++;
2003 for (i = 0; i < n; i++)
2009 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2010 "(min is %d)", name, m);
2016 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2018 if (*s++ != '}') return 1;
2019 while (isspace(*s)) s++;
2021 if (check_end && *s++ != '}')
2025 expand_string_message = string_sprintf("Too many arguments for '%s' "
2026 "(max is %d)", name, n);
2029 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2040 /*************************************************
2041 * Elaborate message for bad variable *
2042 *************************************************/
2044 /* For the "unknown variable" message, take a look at the variable's name, and
2045 give additional information about possible ACL variables. The extra information
2046 is added on to expand_string_message.
2048 Argument: the name of the variable
2053 check_variable_error_message(uschar *name)
2055 if (Ustrncmp(name, "acl_", 4) == 0)
2056 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2057 (name[4] == 'c' || name[4] == 'm')?
2059 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2060 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2062 US"user-defined ACL variables must start acl_c or acl_m");
2068 Load args from sub array to globals, and call acl_check().
2069 Sub array will be corrupted on return.
2071 Returns: OK access is granted by an ACCEPT verb
2072 DISCARD access is (apparently) granted by a DISCARD verb
2073 FAIL access is denied
2074 FAIL_DROP access is denied; drop the connection
2075 DEFER can't tell at the moment
2079 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2082 int sav_narg = acl_narg;
2084 uschar * dummy_logmsg;
2085 extern int acl_where;
2087 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2088 for (i = 0; i < nsub && sub[i+1]; i++)
2090 uschar * tmp = acl_arg[i];
2091 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2092 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2097 sub[i+1] = acl_arg[i];
2098 acl_arg[i++] = NULL;
2102 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2104 acl_narg>0 ? acl_arg[0] : US"<none>",
2105 acl_narg>1 ? " +more" : "");
2107 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2109 for (i = 0; i < nsub; i++)
2110 acl_arg[i] = sub[i+1]; /* restore old args */
2111 acl_narg = sav_narg;
2119 /*************************************************
2120 * Read and evaluate a condition *
2121 *************************************************/
2125 s points to the start of the condition text
2126 resetok points to a BOOL which is written false if it is unsafe to
2127 free memory. Certain condition types (acl) may have side-effect
2128 allocation which must be preserved.
2129 yield points to a BOOL to hold the result of the condition test;
2130 if NULL, we are just reading through a condition that is
2131 part of an "or" combination to check syntax, or in a state
2132 where the answer isn't required
2134 Returns: a pointer to the first character after the condition, or
2138 static const uschar *
2139 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2141 BOOL testfor = TRUE;
2142 BOOL tempcond, combined_cond;
2144 BOOL sub2_honour_dollar = TRUE;
2145 int i, rc, cond_type, roffset;
2146 int_eximarith_t num[2];
2147 struct stat statbuf;
2149 const uschar *sub[10];
2152 const uschar *rerror;
2156 while (isspace(*s)) s++;
2157 if (*s == '!') { testfor = !testfor; s++; } else break;
2160 /* Numeric comparisons are symbolic */
2162 if (*s == '=' || *s == '>' || *s == '<')
2174 /* All other conditions are named */
2176 else s = read_name(name, 256, s, US"_");
2178 /* If we haven't read a name, it means some non-alpha character is first. */
2182 expand_string_message = string_sprintf("condition name expected, "
2183 "but found \"%.16s\"", s);
2187 /* Find which condition we are dealing with, and switch on it */
2189 cond_type = chop_match(name, cond_table, nelem(cond_table));
2192 /* def: tests for a non-empty variable, or for the existence of a header. If
2193 yield == NULL we are in a skipping state, and don't care about the answer. */
2198 expand_string_message = US"\":\" expected after \"def\"";
2202 s = read_name(name, 256, s+1, US"_");
2204 /* Test for a header's existence. If the name contains a closing brace
2205 character, this may be a user error where the terminating colon has been
2206 omitted. Set a flag to adjust a subsequent error message in this case. */
2208 if (Ustrncmp(name, "h_", 2) == 0 ||
2209 Ustrncmp(name, "rh_", 3) == 0 ||
2210 Ustrncmp(name, "bh_", 3) == 0 ||
2211 Ustrncmp(name, "header_", 7) == 0 ||
2212 Ustrncmp(name, "rheader_", 8) == 0 ||
2213 Ustrncmp(name, "bheader_", 8) == 0)
2215 s = read_header_name(name, 256, s);
2216 /* {-for-text-editors */
2217 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2218 if (yield != NULL) *yield =
2219 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2222 /* Test for a variable's having a non-empty value. A non-existent variable
2223 causes an expansion failure. */
2227 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2230 expand_string_message = (name[0] == 0)?
2231 string_sprintf("variable name omitted after \"def:\"") :
2232 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2233 check_variable_error_message(name);
2236 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2242 /* first_delivery tests for first delivery attempt */
2244 case ECOND_FIRST_DELIVERY:
2245 if (yield != NULL) *yield = deliver_firsttime == testfor;
2249 /* queue_running tests for any process started by a queue runner */
2251 case ECOND_QUEUE_RUNNING:
2252 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2256 /* exists: tests for file existence
2257 isip: tests for any IP address
2258 isip4: tests for an IPv4 address
2259 isip6: tests for an IPv6 address
2260 pam: does PAM authentication
2261 radius: does RADIUS authentication
2262 ldapauth: does LDAP authentication
2263 pwcheck: does Cyrus SASL pwcheck authentication
2272 case ECOND_LDAPAUTH:
2275 while (isspace(*s)) s++;
2276 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2278 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2279 if (sub[0] == NULL) return NULL;
2280 /* {-for-text-editors */
2281 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2283 if (yield == NULL) return s; /* No need to run the test if skipping */
2288 if ((expand_forbid & RDO_EXISTS) != 0)
2290 expand_string_message = US"File existence tests are not permitted";
2293 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2299 rc = string_is_ip_address(sub[0], NULL);
2300 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2301 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2304 /* Various authentication tests - all optionally compiled */
2308 rc = auth_call_pam(sub[0], &expand_string_message);
2311 goto COND_FAILED_NOT_COMPILED;
2312 #endif /* SUPPORT_PAM */
2315 #ifdef RADIUS_CONFIG_FILE
2316 rc = auth_call_radius(sub[0], &expand_string_message);
2319 goto COND_FAILED_NOT_COMPILED;
2320 #endif /* RADIUS_CONFIG_FILE */
2322 case ECOND_LDAPAUTH:
2325 /* Just to keep the interface the same */
2327 int old_pool = store_pool;
2328 store_pool = POOL_SEARCH;
2329 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2330 &expand_string_message, &do_cache);
2331 store_pool = old_pool;
2335 goto COND_FAILED_NOT_COMPILED;
2336 #endif /* LOOKUP_LDAP */
2339 #ifdef CYRUS_PWCHECK_SOCKET
2340 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2343 goto COND_FAILED_NOT_COMPILED;
2344 #endif /* CYRUS_PWCHECK_SOCKET */
2346 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2347 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2349 if (rc == ERROR || rc == DEFER) return NULL;
2350 *yield = (rc == OK) == testfor;
2356 /* call ACL (in a conditional context). Accept true, deny false.
2357 Defer is a forced-fail. Anything set by message= goes to $value.
2358 Up to ten parameters are used; we use the braces round the name+args
2359 like the saslauthd condition does, to permit a variable number of args.
2360 See also the expansion-item version EITEM_ACL and the traditional
2361 acl modifier ACLC_ACL.
2362 Since the ACL may allocate new global variables, tell our caller to not
2367 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2375 while (isspace(*s)) s++;
2376 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2378 switch(read_subs(sub, nelem(sub), 1,
2379 &s, yield == NULL, TRUE, US"acl", resetok))
2381 case 1: expand_string_message = US"too few arguments or bracketing "
2384 case 3: return NULL;
2387 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2388 if (yield != NULL) switch(eval_acl(sub, nelem(sub), &user_msg))
2393 lookup_value = NULL;
2396 lookup_value = string_cat(NULL, &size, &ptr, user_msg);
2397 lookup_value[ptr] = '\0';
2399 *yield = cond == testfor;
2403 expand_string_forcedfail = TRUE;
2406 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2413 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2415 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2417 However, the last two are optional. That is why the whole set is enclosed
2418 in their own set of braces. */
2420 case ECOND_SASLAUTHD:
2421 #ifndef CYRUS_SASLAUTHD_SOCKET
2422 goto COND_FAILED_NOT_COMPILED;
2426 while (isspace(*s)) s++;
2427 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2428 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2431 case 1: expand_string_message = US"too few arguments or bracketing "
2432 "error for saslauthd";
2434 case 3: return NULL;
2436 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2439 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2440 &expand_string_message);
2441 if (rc == ERROR || rc == DEFER) return NULL;
2442 *yield = (rc == OK) == testfor;
2446 #endif /* CYRUS_SASLAUTHD_SOCKET */
2449 /* symbolic operators for numeric and string comparison, and a number of
2450 other operators, all requiring two arguments.
2452 crypteq: encrypts plaintext and compares against an encrypted text,
2453 using crypt(), crypt16(), MD5 or SHA-1
2454 inlist/inlisti: checks if first argument is in the list of the second
2455 match: does a regular expression match and sets up the numerical
2456 variables if it succeeds
2457 match_address: matches in an address list
2458 match_domain: matches in a domain list
2459 match_ip: matches a host list that is restricted to IP addresses
2460 match_local_part: matches in a local part list
2463 case ECOND_MATCH_ADDRESS:
2464 case ECOND_MATCH_DOMAIN:
2465 case ECOND_MATCH_IP:
2466 case ECOND_MATCH_LOCAL_PART:
2467 #ifndef EXPAND_LISTMATCH_RHS
2468 sub2_honour_dollar = FALSE;
2477 case ECOND_NUM_L: /* Numerical comparisons */
2484 case ECOND_STR_LT: /* String comparisons */
2495 for (i = 0; i < 2; i++)
2497 /* Sometimes, we don't expand substrings; too many insecure configurations
2498 created using match_address{}{} and friends, where the second param
2499 includes information from untrustworthy sources. */
2500 BOOL honour_dollar = TRUE;
2501 if ((i > 0) && !sub2_honour_dollar)
2502 honour_dollar = FALSE;
2504 while (isspace(*s)) s++;
2507 if (i == 0) goto COND_FAILED_CURLY_START;
2508 expand_string_message = string_sprintf("missing 2nd string in {} "
2509 "after \"%s\"", name);
2512 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2513 honour_dollar, resetok);
2514 if (sub[i] == NULL) return NULL;
2515 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2517 /* Convert to numerical if required; we know that the names of all the
2518 conditions that compare numbers do not start with a letter. This just saves
2519 checking for them individually. */
2521 if (!isalpha(name[0]) && yield != NULL)
2526 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2530 num[i] = expanded_string_integer(sub[i], FALSE);
2531 if (expand_string_message != NULL) return NULL;
2535 /* Result not required */
2537 if (yield == NULL) return s;
2539 /* Do an appropriate comparison */
2545 tempcond = (num[0] == num[1]);
2549 tempcond = (num[0] > num[1]);
2553 tempcond = (num[0] >= num[1]);
2557 tempcond = (num[0] < num[1]);
2561 tempcond = (num[0] <= num[1]);
2565 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2569 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2573 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2577 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2581 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2585 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2589 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2593 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2597 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2601 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2604 case ECOND_MATCH: /* Regular expression match */
2605 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2609 expand_string_message = string_sprintf("regular expression error in "
2610 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2613 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2616 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2617 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2618 goto MATCHED_SOMETHING;
2620 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2621 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2622 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2623 goto MATCHED_SOMETHING;
2625 case ECOND_MATCH_IP: /* Match IP address in a host list */
2626 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2628 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2634 unsigned int *nullcache = NULL;
2635 check_host_block cb;
2637 cb.host_name = US"";
2638 cb.host_address = sub[0];
2640 /* If the host address starts off ::ffff: it is an IPv6 address in
2641 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2644 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2645 cb.host_address + 7 : cb.host_address;
2647 rc = match_check_list(
2648 &sub[1], /* the list */
2649 0, /* separator character */
2650 &hostlist_anchor, /* anchor pointer */
2651 &nullcache, /* cache pointer */
2652 check_host, /* function for testing */
2653 &cb, /* argument for function */
2654 MCL_HOST, /* type of check */
2655 sub[0], /* text for debugging */
2656 NULL); /* where to pass back data */
2658 goto MATCHED_SOMETHING;
2660 case ECOND_MATCH_LOCAL_PART:
2661 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2662 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2677 expand_string_message = string_sprintf("unable to complete match "
2678 "against \"%s\": %s", sub[1], search_error_message);
2684 /* Various "encrypted" comparisons. If the second string starts with
2685 "{" then an encryption type is given. Default to crypt() or crypt16()
2686 (build-time choice). */
2687 /* }-for-text-editors */
2690 #ifndef SUPPORT_CRYPTEQ
2691 goto COND_FAILED_NOT_COMPILED;
2693 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2695 int sublen = Ustrlen(sub[1]+5);
2700 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2702 /* If the length that we are comparing against is 24, the MD5 digest
2703 is expressed as a base64 string. This is the way LDAP does it. However,
2704 some other software uses a straightforward hex representation. We assume
2705 this if the length is 32. Other lengths fail. */
2709 uschar *coded = b64encode(digest, 16);
2710 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2711 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2712 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2714 else if (sublen == 32)
2718 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2720 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2721 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2722 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2726 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2727 "fail\n crypted=%s\n", sub[1]+5);
2732 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2734 int sublen = Ustrlen(sub[1]+6);
2739 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2741 /* If the length that we are comparing against is 28, assume the SHA1
2742 digest is expressed as a base64 string. If the length is 40, assume a
2743 straightforward hex representation. Other lengths fail. */
2747 uschar *coded = b64encode(digest, 20);
2748 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2749 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2750 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2752 else if (sublen == 40)
2756 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2758 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2759 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2760 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2764 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2765 "fail\n crypted=%s\n", sub[1]+6);
2770 else /* {crypt} or {crypt16} and non-{ at start */
2771 /* }-for-text-editors */
2776 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2781 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2786 else if (sub[1][0] == '{') /* }-for-text-editors */
2788 expand_string_message = string_sprintf("unknown encryption mechanism "
2789 "in \"%s\"", sub[1]);
2795 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2796 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2797 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2801 #define XSTR(s) STR(s)
2802 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2803 " subject=%s\n crypted=%s\n",
2804 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2809 /* If the encrypted string contains fewer than two characters (for the
2810 salt), force failure. Otherwise we get false positives: with an empty
2811 string the yield of crypt() is an empty string! */
2814 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2815 else if (errno == EINVAL)
2819 expand_string_message = string_sprintf("crypt error: %s\n",
2820 US strerror(errno));
2825 #endif /* SUPPORT_CRYPTEQ */
2830 const uschar * list = sub[1];
2832 uschar *save_iterate_item = iterate_item;
2833 int (*compare)(const uschar *, const uschar *);
2835 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2838 compare = cond_type == ECOND_INLISTI
2839 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2841 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2842 if (compare(sub[0], iterate_item) == 0)
2847 iterate_item = save_iterate_item;
2850 } /* Switch for comparison conditions */
2852 *yield = tempcond == testfor;
2853 return s; /* End of comparison conditions */
2856 /* and/or: computes logical and/or of several conditions */
2860 subcondptr = (yield == NULL)? NULL : &tempcond;
2861 combined_cond = (cond_type == ECOND_AND);
2863 while (isspace(*s)) s++;
2864 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2868 while (isspace(*s)) s++;
2869 /* {-for-text-editors */
2870 if (*s == '}') break;
2871 if (*s != '{') /* }-for-text-editors */
2873 expand_string_message = string_sprintf("each subcondition "
2874 "inside an \"%s{...}\" condition must be in its own {}", name);
2878 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2880 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2881 expand_string_message, name);
2884 while (isspace(*s)) s++;
2886 /* {-for-text-editors */
2889 /* {-for-text-editors */
2890 expand_string_message = string_sprintf("missing } at end of condition "
2891 "inside \"%s\" group", name);
2897 if (cond_type == ECOND_AND)
2899 combined_cond &= tempcond;
2900 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2901 } /* evaluate any more */
2904 combined_cond |= tempcond;
2905 if (combined_cond) subcondptr = NULL; /* once true, don't */
2906 } /* evaluate any more */
2910 if (yield != NULL) *yield = (combined_cond == testfor);
2914 /* forall/forany: iterates a condition with different values */
2919 const uschar * list;
2921 uschar *save_iterate_item = iterate_item;
2923 DEBUG(D_expand) debug_printf_indent("condition: %s\n", name);
2925 while (isspace(*s)) s++;
2926 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2927 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2928 if (sub[0] == NULL) return NULL;
2929 /* {-for-text-editors */
2930 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2932 while (isspace(*s)) s++;
2933 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2937 /* Call eval_condition once, with result discarded (as if scanning a
2938 "false" part). This allows us to find the end of the condition, because if
2939 the list it empty, we won't actually evaluate the condition for real. */
2941 if (!(s = eval_condition(sub[1], resetok, NULL)))
2943 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2944 expand_string_message, name);
2947 while (isspace(*s)) s++;
2949 /* {-for-text-editors */
2952 /* {-for-text-editors */
2953 expand_string_message = string_sprintf("missing } at end of condition "
2954 "inside \"%s\"", name);
2958 if (yield != NULL) *yield = !testfor;
2960 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2962 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, iterate_item);
2963 if (!eval_condition(sub[1], resetok, &tempcond))
2965 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2966 expand_string_message, name);
2967 iterate_item = save_iterate_item;
2970 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", name,
2971 tempcond? "true":"false");
2973 if (yield != NULL) *yield = (tempcond == testfor);
2974 if (tempcond == (cond_type == ECOND_FORANY)) break;
2977 iterate_item = save_iterate_item;
2982 /* The bool{} expansion condition maps a string to boolean.
2983 The values supported should match those supported by the ACL condition
2984 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2985 of true/false. Note that Router "condition" rules have a different
2986 interpretation, where general data can be used and only a few values
2988 Note that readconf.c boolean matching, for boolean configuration options,
2989 only matches true/yes/false/no.
2990 The bool_lax{} condition matches the Router logic, which is much more
2993 case ECOND_BOOL_LAX:
2999 BOOL boolvalue = FALSE;
3000 while (isspace(*s)) s++;
3001 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
3002 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3003 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3005 case 1: expand_string_message = string_sprintf(
3006 "too few arguments or bracketing error for %s",
3010 case 3: return NULL;
3013 while (isspace(*t)) t++;
3017 /* trailing whitespace: seems like a good idea to ignore it too */
3019 while (isspace(*t2)) t2--;
3020 if (t2 != (t + len))
3027 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3028 /* logic for the lax case from expand_check_condition(), which also does
3029 expands, and the logic is both short and stable enough that there should
3030 be no maintenance burden from replicating it. */
3034 ? Ustrspn(t+1, "0123456789") == len-1
3035 : Ustrspn(t, "0123456789") == len)
3037 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3038 /* expand_check_condition only does a literal string "0" check */
3039 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3042 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3044 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3046 else if (cond_type == ECOND_BOOL_LAX)
3050 expand_string_message = string_sprintf("unrecognised boolean "
3054 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3055 boolvalue? "true":"false");
3056 if (yield != NULL) *yield = (boolvalue == testfor);
3060 /* Unknown condition */
3063 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3065 } /* End switch on condition type */
3067 /* Missing braces at start and end of data */
3069 COND_FAILED_CURLY_START:
3070 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3073 COND_FAILED_CURLY_END:
3074 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3078 /* A condition requires code that is not compiled */
3080 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3081 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3082 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3083 COND_FAILED_NOT_COMPILED:
3084 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3093 /*************************************************
3094 * Save numerical variables *
3095 *************************************************/
3097 /* This function is called from items such as "if" that want to preserve and
3098 restore the numbered variables.
3101 save_expand_string points to an array of pointers to set
3102 save_expand_nlength points to an array of ints for the lengths
3104 Returns: the value of expand max to save
3108 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3111 for (i = 0; i <= expand_nmax; i++)
3113 save_expand_nstring[i] = expand_nstring[i];
3114 save_expand_nlength[i] = expand_nlength[i];
3121 /*************************************************
3122 * Restore numerical variables *
3123 *************************************************/
3125 /* This function restored saved values of numerical strings.
3128 save_expand_nmax the number of strings to restore
3129 save_expand_string points to an array of pointers
3130 save_expand_nlength points to an array of ints
3136 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3137 int *save_expand_nlength)
3140 expand_nmax = save_expand_nmax;
3141 for (i = 0; i <= expand_nmax; i++)
3143 expand_nstring[i] = save_expand_nstring[i];
3144 expand_nlength[i] = save_expand_nlength[i];
3152 /*************************************************
3153 * Handle yes/no substrings *
3154 *************************************************/
3156 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3157 alternative substrings that depend on whether or not the condition was true,
3158 or the lookup or extraction succeeded. The substrings always have to be
3159 expanded, to check their syntax, but "skipping" is set when the result is not
3160 needed - this avoids unnecessary nested lookups.
3163 skipping TRUE if we were skipping when this item was reached
3164 yes TRUE if the first string is to be used, else use the second
3165 save_lookup a value to put back into lookup_value before the 2nd expansion
3166 sptr points to the input string pointer
3167 yieldptr points to the output string pointer
3168 sizeptr points to the output string size
3169 ptrptr points to the output string pointer
3170 type "lookup", "if", "extract", "run", "env", "listextract" or
3171 "certextract" for error message
3172 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3175 Returns: 0 OK; lookup_value has been reset to save_lookup
3177 2 expansion failed because of bracketing error
3181 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3182 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3185 const uschar *s = *sptr; /* Local value */
3186 uschar *sub1, *sub2;
3187 const uschar * errwhere;
3189 /* If there are no following strings, we substitute the contents of $value for
3190 lookups and for extractions in the success case. For the ${if item, the string
3191 "true" is substituted. In the fail case, nothing is substituted for all three
3194 while (isspace(*s)) s++;
3199 if (yes && !skipping)
3200 *yieldptr = string_catn(*yieldptr, sizeptr, ptrptr, US"true", 4);
3204 if (yes && lookup_value && !skipping)
3205 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value);
3206 lookup_value = save_lookup;
3212 /* The first following string must be braced. */
3216 errwhere = US"'yes' part did not start with '{'";
3220 /* Expand the first substring. Forced failures are noticed only if we actually
3221 want this string. Set skipping in the call in the fail case (this will always
3222 be the case if we were already skipping). */
3224 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3225 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3226 expand_string_forcedfail = FALSE;
3229 errwhere = US"'yes' part did not end with '}'";
3233 /* If we want the first string, add it to the output */
3236 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1);
3238 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3239 $value to what it was at the start of the item, so that it has this value
3240 during the second string expansion. For the call from "if" or "run" to this
3241 function, save_lookup is set to lookup_value, so that this statement does
3244 lookup_value = save_lookup;
3246 /* There now follows either another substring, or "fail", or nothing. This
3247 time, forced failures are noticed only if we want the second string. We must
3248 set skipping in the nested call if we don't want this string, or if we were
3249 already skipping. */
3251 while (isspace(*s)) s++;
3254 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3255 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3256 expand_string_forcedfail = FALSE;
3259 errwhere = US"'no' part did not start with '{'";
3263 /* If we want the second string, add it to the output */
3266 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2);
3269 /* If there is no second string, but the word "fail" is present when the use of
3270 the second string is wanted, set a flag indicating it was a forced failure
3271 rather than a syntactic error. Swallow the terminating } in case this is nested
3272 inside another lookup or if or extract. */
3277 /* deconst cast ok here as source is s anyway */
3278 s = US read_name(name, sizeof(name), s, US"_");
3279 if (Ustrcmp(name, "fail") == 0)
3281 if (!yes && !skipping)
3283 while (isspace(*s)) s++;
3286 errwhere = US"did not close with '}' after forcedfail";
3289 expand_string_message =
3290 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3291 expand_string_forcedfail = TRUE;
3297 expand_string_message =
3298 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3303 /* All we have to do now is to check on the final closing brace. */
3305 while (isspace(*s)) s++;
3308 errwhere = US"did not close with '}'";
3314 /* Update the input pointer value before returning */
3319 /* Get here if there is a bracketing failure */
3320 expand_string_message = string_sprintf(
3321 "curly-bracket problem in conditional yes/no parsing: %s\n"
3322 " remaining string is '%s'", errwhere, --s);
3327 /* Get here for other failures */
3335 /*************************************************
3336 * Handle MD5 or SHA-1 computation for HMAC *
3337 *************************************************/
3339 /* These are some wrapping functions that enable the HMAC code to be a bit
3340 cleaner. A good compiler will spot the tail recursion.
3343 type HMAC_MD5 or HMAC_SHA1
3344 remaining are as for the cryptographic hash functions
3350 chash_start(int type, void *base)
3352 if (type == HMAC_MD5)
3353 md5_start((md5 *)base);
3355 sha1_start((hctx *)base);
3359 chash_mid(int type, void *base, uschar *string)
3361 if (type == HMAC_MD5)
3362 md5_mid((md5 *)base, string);
3364 sha1_mid((hctx *)base, string);
3368 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3370 if (type == HMAC_MD5)
3371 md5_end((md5 *)base, string, length, digest);
3373 sha1_end((hctx *)base, string, length, digest);
3380 /********************************************************
3381 * prvs: Get last three digits of days since Jan 1, 1970 *
3382 ********************************************************/
3384 /* This is needed to implement the "prvs" BATV reverse
3387 Argument: integer "days" offset to add or substract to
3388 or from the current number of days.
3390 Returns: pointer to string containing the last three
3391 digits of the number of days since Jan 1, 1970,
3392 modified by the offset argument, NULL if there
3393 was an error in the conversion.
3398 prvs_daystamp(int day_offset)
3400 uschar *days = store_get(32); /* Need at least 24 for cases */
3401 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3402 (time(NULL) + day_offset*86400)/86400);
3403 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3408 /********************************************************
3409 * prvs: perform HMAC-SHA1 computation of prvs bits *
3410 ********************************************************/
3412 /* This is needed to implement the "prvs" BATV reverse
3416 address RFC2821 Address to use
3417 key The key to use (must be less than 64 characters
3419 key_num Single-digit key number to use. Defaults to
3422 Returns: pointer to string containing the first three
3423 bytes of the final hash in hex format, NULL if
3424 there was an error in the process.
3428 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3430 uschar *hash_source, *p;
3431 int size = 0,offset = 0,i;
3433 uschar innerhash[20];
3434 uschar finalhash[20];
3435 uschar innerkey[64];
3436 uschar outerkey[64];
3437 uschar *finalhash_hex = store_get(40);
3439 if (key_num == NULL)
3442 if (Ustrlen(key) > 64)
3445 hash_source = string_catn(NULL, &size, &offset, key_num, 1);
3446 hash_source = string_catn(hash_source, &size, &offset, daystamp, 3);
3447 hash_source = string_cat(hash_source, &size, &offset, address);
3448 hash_source[offset] = '\0';
3450 DEBUG(D_expand) debug_printf_indent("prvs: hash source is '%s'\n", hash_source);
3452 memset(innerkey, 0x36, 64);
3453 memset(outerkey, 0x5c, 64);
3455 for (i = 0; i < Ustrlen(key); i++)
3457 innerkey[i] ^= key[i];
3458 outerkey[i] ^= key[i];
3461 chash_start(HMAC_SHA1, &h);
3462 chash_mid(HMAC_SHA1, &h, innerkey);
3463 chash_end(HMAC_SHA1, &h, hash_source, offset, innerhash);
3465 chash_start(HMAC_SHA1, &h);
3466 chash_mid(HMAC_SHA1, &h, outerkey);
3467 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3470 for (i = 0; i < 3; i++)
3472 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3473 *p++ = hex_digits[finalhash[i] & 0x0f];
3477 return finalhash_hex;
3483 /*************************************************
3484 * Join a file onto the output string *
3485 *************************************************/
3487 /* This is used for readfile/readsock and after a run expansion.
3488 It joins the contents of a file onto the output string, globally replacing
3489 newlines with a given string (optionally).
3493 yield pointer to the expandable string
3494 sizep pointer to the current size
3495 ptrp pointer to the current position
3496 eol newline replacement string, or NULL
3498 Returns: new value of string pointer
3502 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3504 uschar buffer[1024];
3506 while (Ufgets(buffer, sizeof(buffer), f))
3508 int len = Ustrlen(buffer);
3509 if (eol && buffer[len-1] == '\n') len--;
3510 yield = string_catn(yield, sizep, ptrp, buffer, len);
3511 if (eol && buffer[len])
3512 yield = string_cat(yield, sizep, ptrp, eol);
3515 if (yield) yield[*ptrp] = 0;
3523 /*************************************************
3524 * Evaluate numeric expression *
3525 *************************************************/
3527 /* This is a set of mutually recursive functions that evaluate an arithmetic
3528 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3529 these functions that is called from elsewhere is eval_expr, whose interface is:
3532 sptr pointer to the pointer to the string - gets updated
3533 decimal TRUE if numbers are to be assumed decimal
3534 error pointer to where to put an error message - must be NULL on input
3535 endket TRUE if ')' must terminate - FALSE for external call
3537 Returns: on success: the value of the expression, with *error still NULL
3538 on failure: an undefined value, with *error = a message
3541 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3544 static int_eximarith_t
3545 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3548 int_eximarith_t x = eval_op_or(&s, decimal, error);
3554 *error = US"expecting closing parenthesis";
3556 while (isspace(*(++s)));
3558 else if (*s != 0) *error = US"expecting operator";
3565 static int_eximarith_t
3566 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3571 while (isspace(*s)) s++;
3576 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3578 switch (tolower(*s))
3581 case 'k': n *= 1024; s++; break;
3582 case 'm': n *= 1024*1024; s++; break;
3583 case 'g': n *= 1024*1024*1024; s++; break;
3585 while (isspace (*s)) s++;
3590 n = eval_expr(&s, decimal, error, 1);
3594 *error = US"expecting number or opening parenthesis";
3602 static int_eximarith_t
3603 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3607 while (isspace(*s)) s++;
3608 if (*s == '+' || *s == '-' || *s == '~')
3611 x = eval_op_unary(&s, decimal, error);
3612 if (op == '-') x = -x;
3613 else if (op == '~') x = ~x;
3617 x = eval_number(&s, decimal, error);
3624 static int_eximarith_t
3625 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3628 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3631 while (*s == '*' || *s == '/' || *s == '%')
3634 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3635 if (*error != NULL) break;
3636 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3637 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3638 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3639 * -N*M is INT_MIN will yield INT_MIN.
3640 * Since we don't support floating point, this is somewhat simpler.
3641 * Ideally, we'd return an error, but since we overflow for all other
3642 * arithmetic, consistency suggests otherwise, but what's the correct value
3643 * to use? There is none.
3644 * The C standard guarantees overflow for unsigned arithmetic but signed
3645 * overflow invokes undefined behaviour; in practice, this is overflow
3646 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3647 * that long/longlong larger than int are available, or we could just work
3648 * with larger types. We should consider whether to guarantee 32bit eval
3649 * and 64-bit working variables, with errors returned. For now ...
3650 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3651 * can just let the other invalid results occur otherwise, as they have
3652 * until now. For this one case, we can coerce.
3654 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3657 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3658 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3668 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3684 static int_eximarith_t
3685 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3688 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3691 while (*s == '+' || *s == '-')
3694 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3696 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3697 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3698 { /* over-conservative check */
3700 ? US"overflow in sum" : US"overflow in difference";
3703 if (op == '+') x += y; else x -= y;
3711 static int_eximarith_t
3712 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3715 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3718 while ((*s == '<' || *s == '>') && s[1] == s[0])
3723 y = eval_op_sum(&s, decimal, error);
3724 if (*error != NULL) break;
3725 if (op == '<') x <<= y; else x >>= y;
3733 static int_eximarith_t
3734 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3737 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3744 y = eval_op_shift(&s, decimal, error);
3745 if (*error != NULL) break;
3754 static int_eximarith_t
3755 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3758 int_eximarith_t x = eval_op_and(&s, decimal, error);
3765 y = eval_op_and(&s, decimal, error);
3766 if (*error != NULL) break;
3775 static int_eximarith_t
3776 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3779 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3786 y = eval_op_xor(&s, decimal, error);
3787 if (*error != NULL) break;
3797 /*************************************************
3799 *************************************************/
3801 /* Returns either an unchanged string, or the expanded string in stacking pool
3802 store. Interpreted sequences are:
3804 \... normal escaping rules
3805 $name substitutes the variable
3807 ${op:string} operates on the expanded string value
3808 ${item{arg1}{arg2}...} expands the args and then does the business
3809 some literal args are not enclosed in {}
3811 There are now far too many operators and item types to make it worth listing
3812 them here in detail any more.
3814 We use an internal routine recursively to handle embedded substrings. The
3815 external function follows. The yield is NULL if the expansion failed, and there
3816 are two cases: if something collapsed syntactically, or if "fail" was given
3817 as the action on a lookup failure. These can be distinguished by looking at the
3818 variable expand_string_forcedfail, which is TRUE in the latter case.
3820 The skipping flag is set true when expanding a substring that isn't actually
3821 going to be used (after "if" or "lookup") and it prevents lookups from
3822 happening lower down.
3824 Store usage: At start, a store block of the length of the input plus 64
3825 is obtained. This is expanded as necessary by string_cat(), which might have to
3826 get a new block, or might be able to expand the original. At the end of the
3827 function we can release any store above that portion of the yield block that
3828 was actually used. In many cases this will be optimal.
3830 However: if the first item in the expansion is a variable name or header name,
3831 we reset the store before processing it; if the result is in fresh store, we
3832 use that without copying. This is helpful for expanding strings like
3833 $message_headers which can get very long.
3835 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3836 since resetting the store at the end of the expansion will free store that was
3837 allocated by the plugin code as well as the slop after the expanded string. So
3838 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3839 and, given the acl condition, ${if }. This is an unfortunate consequence of
3840 string expansion becoming too powerful.
3843 string the string to be expanded
3844 ket_ends true if expansion is to stop at }
3845 left if not NULL, a pointer to the first character after the
3846 expansion is placed here (typically used with ket_ends)
3847 skipping TRUE for recursive calls when the value isn't actually going
3848 to be used (to allow for optimisation)
3849 honour_dollar TRUE if $ is to be expanded,
3850 FALSE if it's just another character
3851 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3854 Returns: NULL if expansion fails:
3855 expand_string_forcedfail is set TRUE if failure was forced
3856 expand_string_message contains a textual error message
3857 a pointer to the expanded string on success
3861 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3862 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3865 int size = Ustrlen(string)+ 64;
3866 uschar *yield = store_get(size);
3868 const uschar *s = string;
3869 uschar *save_expand_nstring[EXPAND_MAXN+1];
3870 int save_expand_nlength[EXPAND_MAXN+1];
3871 BOOL resetok = TRUE;
3875 debug_printf_indent("/%s: %s\n", skipping ? " scanning" : "considering", string);
3877 expand_string_forcedfail = FALSE;
3878 expand_string_message = US"";
3885 /* \ escapes the next character, which must exist, or else
3886 the expansion fails. There's a special escape, \N, which causes
3887 copying of the subject verbatim up to the next \N. Otherwise,
3888 the escapes are the standard set. */
3894 expand_string_message = US"\\ at end of string";
3900 const uschar * t = s + 2;
3901 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3902 yield = string_catn(yield, &size, &ptr, t, s - t);
3903 if (*s != 0) s += 2;
3909 ch[0] = string_interpret_escape(&s);
3911 yield = string_catn(yield, &size, &ptr, ch, 1);
3918 /* Anything other than $ is just copied verbatim, unless we are
3919 looking for a terminating } character. */
3922 if (ket_ends && *s == '}') break;
3924 if (*s != '$' || !honour_dollar)
3926 yield = string_catn(yield, &size, &ptr, s++, 1);
3930 /* No { after the $ - must be a plain name or a number for string
3931 match variable. There has to be a fudge for variables that are the
3932 names of header fields preceded by "$header_" because header field
3933 names can contain any printing characters except space and colon.
3934 For those that don't like typing this much, "$h_" is a synonym for
3935 "$header_". A non-existent header yields a NULL value; nothing is
3938 if (isalpha((*(++s))))
3943 s = read_name(name, sizeof(name), s, US"_");
3945 /* If this is the first thing to be expanded, release the pre-allocated
3948 if (ptr == 0 && yield != NULL)
3950 if (resetok) store_reset(yield);
3957 if (Ustrncmp(name, "h_", 2) == 0 ||
3958 Ustrncmp(name, "rh_", 3) == 0 ||
3959 Ustrncmp(name, "bh_", 3) == 0 ||
3960 Ustrncmp(name, "header_", 7) == 0 ||
3961 Ustrncmp(name, "rheader_", 8) == 0 ||
3962 Ustrncmp(name, "bheader_", 8) == 0)
3964 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3965 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3966 s = read_header_name(name, sizeof(name), s);
3967 value = find_header(name, FALSE, &newsize, want_raw, charset);
3969 /* If we didn't find the header, and the header contains a closing brace
3970 character, this may be a user error where the terminating colon
3971 has been omitted. Set a flag to adjust the error message in this case.
3972 But there is no error here - nothing gets inserted. */
3976 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3983 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
3985 expand_string_message =
3986 string_sprintf("unknown variable name \"%s\"", name);
3987 check_variable_error_message(name);
3991 /* If the data is known to be in a new buffer, newsize will be set to the
3992 size of that buffer. If this is the first thing in an expansion string,
3993 yield will be NULL; just point it at the new store instead of copying. Many
3994 expansion strings contain just one reference, so this is a useful
3995 optimization, especially for humungous headers. */
3997 len = Ustrlen(value);
3998 if (yield == NULL && newsize != 0)
4004 else yield = string_catn(yield, &size, &ptr, value, len);
4012 s = read_cnumber(&n, s);
4013 if (n >= 0 && n <= expand_nmax)
4014 yield = string_catn(yield, &size, &ptr, expand_nstring[n],
4019 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4021 if (*s != '{') /*}*/
4023 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4027 /* After { there can be various things, but they all start with
4028 an initial word, except for a number for a string match variable. */
4030 if (isdigit((*(++s))))
4033 s = read_cnumber(&n, s); /*{*/
4036 expand_string_message = US"} expected after number";
4039 if (n >= 0 && n <= expand_nmax)
4040 yield = string_catn(yield, &size, &ptr, expand_nstring[n],
4047 expand_string_message = US"letter or digit expected after ${"; /*}*/
4051 /* Allow "-" in names to cater for substrings with negative
4052 arguments. Since we are checking for known names after { this is
4055 s = read_name(name, sizeof(name), s, US"_-");
4056 item_type = chop_match(name, item_table, nelem(item_table));
4060 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4061 If the ACL returns accept or reject we return content set by "message ="
4062 There is currently no limit on recursion; this would have us call
4063 acl_check_internal() directly and get a current level from somewhere.
4064 See also the acl expansion condition ECOND_ACL and the traditional
4065 acl modifier ACLC_ACL.
4066 Assume that the function has side-effects on the store that must be preserved.
4070 /* ${acl {name} {arg1}{arg2}...} */
4072 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4075 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4078 case 1: goto EXPAND_FAILED_CURLY;
4080 case 3: goto EXPAND_FAILED;
4082 if (skipping) continue;
4085 switch(eval_acl(sub, nelem(sub), &user_msg))
4090 debug_printf_indent("acl expansion yield: %s\n", user_msg);
4092 yield = string_cat(yield, &size, &ptr, user_msg);
4096 expand_string_forcedfail = TRUE;
4099 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4104 /* Handle conditionals - preserve the values of the numerical expansion
4105 variables in case they get changed by a regular expression match in the
4106 condition. If not, they retain their external settings. At the end
4107 of this "if" section, they get restored to their previous values. */
4112 const uschar *next_s;
4113 int save_expand_nmax =
4114 save_expand_strings(save_expand_nstring, save_expand_nlength);
4116 while (isspace(*s)) s++;
4117 next_s = eval_condition(s, &resetok, skipping ? NULL : &cond);
4118 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4122 debug_printf_indent("|__condition: %.*s\n", (int)(next_s - s), s);
4123 debug_printf_indent("|_____result: %s\n", cond ? "true" : "false");
4128 /* The handling of "yes" and "no" result strings is now in a separate
4129 function that is also used by ${lookup} and ${extract} and ${run}. */
4131 switch(process_yesno(
4132 skipping, /* were previously skipping */
4133 cond, /* success/failure indicator */
4134 lookup_value, /* value to reset for string2 */
4135 &s, /* input pointer */
4136 &yield, /* output pointer */
4137 &size, /* output size */
4138 &ptr, /* output current point */
4139 US"if", /* condition type */
4142 case 1: goto EXPAND_FAILED; /* when all is well, the */
4143 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4146 /* Restore external setting of expansion variables for continuation
4149 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4150 save_expand_nlength);
4155 case EITEM_IMAPFOLDER:
4156 { /* ${imapfolder {name}{sep]{specials}} */
4160 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4163 case 1: goto EXPAND_FAILED_CURLY;
4165 case 3: goto EXPAND_FAILED;
4168 if (sub_arg[1] == NULL) /* One argument */
4170 sub_arg[1] = US"/"; /* default separator */
4173 else if (Ustrlen(sub_arg[1]) != 1)
4175 expand_string_message =
4177 "IMAP folder separator must be one character, found \"%s\"",
4184 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4185 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4187 yield = string_cat(yield, &size, &ptr, encoded);
4193 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4194 expanding an internal string that isn't actually going to be used. All we
4195 need to do is check the syntax, so don't do a lookup at all. Preserve the
4196 values of the numerical expansion variables in case they get changed by a
4197 partial lookup. If not, they retain their external settings. At the end
4198 of this "lookup" section, they get restored to their previous values. */
4202 int stype, partial, affixlen, starflags;
4203 int expand_setup = 0;
4205 uschar *key, *filename;
4206 const uschar *affix;
4207 uschar *save_lookup_value = lookup_value;
4208 int save_expand_nmax =
4209 save_expand_strings(save_expand_nstring, save_expand_nlength);
4211 if ((expand_forbid & RDO_LOOKUP) != 0)
4213 expand_string_message = US"lookup expansions are not permitted";
4217 /* Get the key we are to look up for single-key+file style lookups.
4218 Otherwise set the key NULL pro-tem. */
4220 while (isspace(*s)) s++;
4221 if (*s == '{') /*}*/
4223 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4224 if (!key) goto EXPAND_FAILED; /*{{*/
4227 expand_string_message = US"missing '}' after lookup key";
4228 goto EXPAND_FAILED_CURLY;
4230 while (isspace(*s)) s++;
4234 /* Find out the type of database */
4238 expand_string_message = US"missing lookup type";
4242 /* The type is a string that may contain special characters of various
4243 kinds. Allow everything except space or { to appear; the actual content
4244 is checked by search_findtype_partial. */ /*}*/
4246 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4248 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4252 while (isspace(*s)) s++;
4254 /* Now check for the individual search type and any partial or default
4255 options. Only those types that are actually in the binary are valid. */
4257 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4261 expand_string_message = search_error_message;
4265 /* Check that a key was provided for those lookup types that need it,
4266 and was not supplied for those that use the query style. */
4268 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4272 expand_string_message = string_sprintf("missing {key} for single-"
4273 "key \"%s\" lookup", name);
4281 expand_string_message = string_sprintf("a single key was given for "
4282 "lookup type \"%s\", which is not a single-key lookup type", name);
4287 /* Get the next string in brackets and expand it. It is the file name for
4288 single-key+file lookups, and the whole query otherwise. In the case of
4289 queries that also require a file name (e.g. sqlite), the file name comes
4294 expand_string_message = US"missing '{' for lookup file-or-query arg";
4295 goto EXPAND_FAILED_CURLY;
4297 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4298 if (filename == NULL) goto EXPAND_FAILED;
4301 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4302 goto EXPAND_FAILED_CURLY;
4304 while (isspace(*s)) s++;
4306 /* If this isn't a single-key+file lookup, re-arrange the variables
4307 to be appropriate for the search_ functions. For query-style lookups,
4308 there is just a "key", and no file name. For the special query-style +
4309 file types, the query (i.e. "key") starts with a file name. */
4313 while (isspace(*filename)) filename++;
4316 if (mac_islookup(stype, lookup_querystyle))
4320 if (*filename != '/')
4322 expand_string_message = string_sprintf(
4323 "absolute file name expected for \"%s\" lookup", name);
4326 while (*key != 0 && !isspace(*key)) key++;
4327 if (*key != 0) *key++ = 0;
4331 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4332 the entry was not found. Note that there is no search_close() function.
4333 Files are left open in case of re-use. At suitable places in higher logic,
4334 search_tidyup() is called to tidy all open files. This can save opening
4335 the same file several times. However, files may also get closed when
4336 others are opened, if too many are open at once. The rule is that a
4337 handle should not be used after a second search_open().
4339 Request that a partial search sets up $1 and maybe $2 by passing
4340 expand_setup containing zero. If its value changes, reset expand_nmax,
4341 since new variables will have been set. Note that at the end of this
4342 "lookup" section, the old numeric variables are restored. */
4345 lookup_value = NULL;
4348 void *handle = search_open(filename, stype, 0, NULL, NULL);
4351 expand_string_message = search_error_message;
4354 lookup_value = search_find(handle, filename, key, partial, affix,
4355 affixlen, starflags, &expand_setup);
4356 if (search_find_defer)
4358 expand_string_message =
4359 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4360 string_printing2(key, FALSE), search_error_message);
4363 if (expand_setup > 0) expand_nmax = expand_setup;
4366 /* The handling of "yes" and "no" result strings is now in a separate
4367 function that is also used by ${if} and ${extract}. */
4369 switch(process_yesno(
4370 skipping, /* were previously skipping */
4371 lookup_value != NULL, /* success/failure indicator */
4372 save_lookup_value, /* value to reset for string2 */
4373 &s, /* input pointer */
4374 &yield, /* output pointer */
4375 &size, /* output size */
4376 &ptr, /* output current point */
4377 US"lookup", /* condition type */
4380 case 1: goto EXPAND_FAILED; /* when all is well, the */
4381 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4384 /* Restore external setting of expansion variables for carrying on
4385 at this level, and continue. */
4387 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4388 save_expand_nlength);
4392 /* If Perl support is configured, handle calling embedded perl subroutines,
4393 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4394 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4395 arguments (defined below). */
4397 #define EXIM_PERL_MAX_ARGS 8
4401 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4402 "is not included in this binary";
4405 #else /* EXIM_PERL */
4407 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4410 if ((expand_forbid & RDO_PERL) != 0)
4412 expand_string_message = US"Perl calls are not permitted";
4416 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4417 US"perl", &resetok))
4419 case 1: goto EXPAND_FAILED_CURLY;
4421 case 3: goto EXPAND_FAILED;
4424 /* If skipping, we don't actually do anything */
4426 if (skipping) continue;
4428 /* Start the interpreter if necessary */
4430 if (!opt_perl_started)
4433 if (opt_perl_startup == NULL)
4435 expand_string_message = US"A setting of perl_startup is needed when "
4436 "using the Perl interpreter";
4439 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4440 initerror = init_perl(opt_perl_startup);
4441 if (initerror != NULL)
4443 expand_string_message =
4444 string_sprintf("error in perl_startup code: %s\n", initerror);
4447 opt_perl_started = TRUE;
4450 /* Call the function */
4452 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4453 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4454 sub_arg[0], sub_arg + 1);
4456 /* NULL yield indicates failure; if the message pointer has been set to
4457 NULL, the yield was undef, indicating a forced failure. Otherwise the
4458 message will indicate some kind of Perl error. */
4460 if (new_yield == NULL)
4462 if (expand_string_message == NULL)
4464 expand_string_message =
4465 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4466 "failure", sub_arg[0]);
4467 expand_string_forcedfail = TRUE;
4472 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4473 set during a callback from Perl. */
4475 expand_string_forcedfail = FALSE;
4479 #endif /* EXIM_PERL */
4481 /* Transform email address to "prvs" scheme to use
4482 as BATV-signed return path */
4489 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4491 case 1: goto EXPAND_FAILED_CURLY;
4493 case 3: goto EXPAND_FAILED;
4496 /* If skipping, we don't actually do anything */
4497 if (skipping) continue;
4499 /* sub_arg[0] is the address */
4500 domain = Ustrrchr(sub_arg[0],'@');
4501 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4503 expand_string_message = US"prvs first argument must be a qualified email address";
4507 /* Calculate the hash. The second argument must be a single-digit
4508 key number, or unset. */
4510 if (sub_arg[2] != NULL &&
4511 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4513 expand_string_message = US"prvs second argument must be a single digit";
4517 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4520 expand_string_message = US"prvs hmac-sha1 conversion failed";
4524 /* Now separate the domain from the local part */
4527 yield = string_catn(yield, &size, &ptr, US"prvs=", 5);
4528 yield = string_catn(yield, &size, &ptr, sub_arg[2] ? sub_arg[2] : US"0", 1);
4529 yield = string_catn(yield, &size, &ptr, prvs_daystamp(7), 3);
4530 yield = string_catn(yield, &size, &ptr, p, 6);
4531 yield = string_catn(yield, &size, &ptr, US"=", 1);
4532 yield = string_cat (yield, &size, &ptr, sub_arg[0]);
4533 yield = string_catn(yield, &size, &ptr, US"@", 1);
4534 yield = string_cat (yield, &size, &ptr, domain);
4539 /* Check a prvs-encoded address for validity */
4541 case EITEM_PRVSCHECK:
4544 int mysize = 0, myptr = 0;
4548 /* TF: Ugliness: We want to expand parameter 1 first, then set
4549 up expansion variables that are used in the expansion of
4550 parameter 2. So we clone the string for the first
4551 expansion, where we only expand parameter 1.
4553 PH: Actually, that isn't necessary. The read_subs() function is
4554 designed to work this way for the ${if and ${lookup expansions. I've
4558 /* Reset expansion variables */
4559 prvscheck_result = NULL;
4560 prvscheck_address = NULL;
4561 prvscheck_keynum = NULL;
4563 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4565 case 1: goto EXPAND_FAILED_CURLY;
4567 case 3: goto EXPAND_FAILED;
4570 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4573 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4575 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4576 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4577 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4578 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4579 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4581 DEBUG(D_expand) debug_printf_indent("prvscheck localpart: %s\n", local_part);
4582 DEBUG(D_expand) debug_printf_indent("prvscheck key number: %s\n", key_num);
4583 DEBUG(D_expand) debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
4584 DEBUG(D_expand) debug_printf_indent("prvscheck hash: %s\n", hash);
4585 DEBUG(D_expand) debug_printf_indent("prvscheck domain: %s\n", domain);
4587 /* Set up expansion variables */
4588 prvscheck_address = string_cat (NULL, &mysize, &myptr, local_part);
4589 prvscheck_address = string_catn(prvscheck_address, &mysize, &myptr, US"@", 1);
4590 prvscheck_address = string_cat (prvscheck_address, &mysize, &myptr, domain);
4591 prvscheck_address[myptr] = '\0';
4592 prvscheck_keynum = string_copy(key_num);
4594 /* Now expand the second argument */
4595 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4597 case 1: goto EXPAND_FAILED_CURLY;
4599 case 3: goto EXPAND_FAILED;
4602 /* Now we have the key and can check the address. */
4604 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4609 expand_string_message = US"hmac-sha1 conversion failed";
4613 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
4614 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);
4616 if (Ustrcmp(p,hash) == 0)
4618 /* Success, valid BATV address. Now check the expiry date. */
4619 uschar *now = prvs_daystamp(0);
4620 unsigned int inow = 0,iexpire = 1;
4622 (void)sscanf(CS now,"%u",&inow);
4623 (void)sscanf(CS daystamp,"%u",&iexpire);
4625 /* When "iexpire" is < 7, a "flip" has occured.
4626 Adjust "inow" accordingly. */
4627 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4629 if (iexpire >= inow)
4631 prvscheck_result = US"1";
4632 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
4636 prvscheck_result = NULL;
4637 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
4642 prvscheck_result = NULL;
4643 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
4646 /* Now expand the final argument. We leave this till now so that
4647 it can include $prvscheck_result. */
4649 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4651 case 1: goto EXPAND_FAILED_CURLY;
4653 case 3: goto EXPAND_FAILED;
4656 yield = string_cat(yield, &size, &ptr,
4657 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4659 /* Reset the "internal" variables afterwards, because they are in
4660 dynamic store that will be reclaimed if the expansion succeeded. */
4662 prvscheck_address = NULL;
4663 prvscheck_keynum = NULL;
4666 /* Does not look like a prvs encoded address, return the empty string.
4667 We need to make sure all subs are expanded first, so as to skip over
4670 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4672 case 1: goto EXPAND_FAILED_CURLY;
4674 case 3: goto EXPAND_FAILED;
4680 /* Handle "readfile" to insert an entire file */
4682 case EITEM_READFILE:
4687 if ((expand_forbid & RDO_READFILE) != 0)
4689 expand_string_message = US"file insertions are not permitted";
4693 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4695 case 1: goto EXPAND_FAILED_CURLY;
4697 case 3: goto EXPAND_FAILED;
4700 /* If skipping, we don't actually do anything */
4702 if (skipping) continue;
4704 /* Open the file and read it */
4706 f = Ufopen(sub_arg[0], "rb");
4709 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4713 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4718 /* Handle "readsocket" to insert data from a Unix domain socket */
4720 case EITEM_READSOCK:
4726 struct sockaddr_un sockun; /* don't call this "sun" ! */
4729 BOOL do_shutdown = TRUE;
4731 if (expand_forbid & RDO_READSOCK)
4733 expand_string_message = US"socket insertions are not permitted";
4737 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4738 because there may be a string for expansion on failure. */
4740 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4742 case 1: goto EXPAND_FAILED_CURLY;
4743 case 2: /* Won't occur: no end check */
4744 case 3: goto EXPAND_FAILED;
4747 /* Sort out timeout, if given. The second arg is a list with the first element
4748 being a time value. Any more are options of form "name=value". Currently the
4749 only option recognised is "shutdown". */
4753 const uschar * list = sub_arg[2];
4757 item = string_nextinlist(&list, &sep, NULL, 0);
4758 if ((timeout = readconf_readtime(item, 0, FALSE)) < 0)
4760 expand_string_message = string_sprintf("bad time value %s", item);
4764 while ((item = string_nextinlist(&list, &sep, NULL, 0)))
4765 if (Ustrncmp(item, US"shutdown=", 9) == 0)
4766 if (Ustrcmp(item + 9, US"no") == 0)
4767 do_shutdown = FALSE;
4769 else sub_arg[3] = NULL; /* No eol if no timeout */
4771 /* If skipping, we don't actually do anything. Otherwise, arrange to
4772 connect to either an IP or a Unix socket. */
4776 /* Handle an IP (internet) domain */
4778 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4781 uschar *server_name = sub_arg[0] + 5;
4782 uschar *port_name = Ustrrchr(server_name, ':');
4784 /* Sort out the port */
4786 if (port_name == NULL)
4788 expand_string_message =
4789 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4792 *port_name++ = 0; /* Terminate server name */
4794 if (isdigit(*port_name))
4797 port = Ustrtol(port_name, &end, 0);
4798 if (end != port_name + Ustrlen(port_name))
4800 expand_string_message =
4801 string_sprintf("invalid port number %s", port_name);
4807 struct servent *service_info = getservbyname(CS port_name, "tcp");
4808 if (service_info == NULL)
4810 expand_string_message = string_sprintf("unknown port \"%s\"",
4814 port = ntohs(service_info->s_port);
4817 fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4818 timeout, NULL, &expand_string_message);
4819 callout_address = NULL;
4824 /* Handle a Unix domain socket */
4829 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4831 expand_string_message = string_sprintf("failed to create socket: %s",
4836 sockun.sun_family = AF_UNIX;
4837 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4840 sigalrm_seen = FALSE;
4842 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4846 expand_string_message = US "socket connect timed out";
4851 expand_string_message = string_sprintf("failed to connect to socket "
4852 "%s: %s", sub_arg[0], strerror(errno));
4857 DEBUG(D_expand) debug_printf_indent("connected to socket %s\n", sub_arg[0]);
4859 /* Allow sequencing of test actions */
4860 if (running_in_test_harness) millisleep(100);
4862 /* Write the request string, if not empty */
4864 if (sub_arg[1][0] != 0)
4866 int len = Ustrlen(sub_arg[1]);
4867 DEBUG(D_expand) debug_printf_indent("writing \"%s\" to socket\n",
4869 if (write(fd, sub_arg[1], len) != len)
4871 expand_string_message = string_sprintf("request write to socket "
4872 "failed: %s", strerror(errno));
4877 /* Shut down the sending side of the socket. This helps some servers to
4878 recognise that it is their turn to do some work. Just in case some
4879 system doesn't have this function, make it conditional. */
4882 if (do_shutdown) shutdown(fd, SHUT_WR);
4885 if (running_in_test_harness) millisleep(100);
4887 /* Now we need to read from the socket, under a timeout. The function
4888 that reads a file can be used. */
4890 f = fdopen(fd, "rb");
4891 sigalrm_seen = FALSE;
4893 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4897 /* After a timeout, we restore the pointer in the result, that is,
4898 make sure we add nothing from the socket. */
4903 expand_string_message = US "socket read timed out";
4908 /* The whole thing has worked (or we were skipping). If there is a
4909 failure string following, we need to skip it. */
4913 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4917 expand_string_message = US"missing '}' closing failstring for readsocket";
4918 goto EXPAND_FAILED_CURLY;
4920 while (isspace(*s)) s++;
4926 expand_string_message = US"missing '}' closing readsocket";
4927 goto EXPAND_FAILED_CURLY;
4931 /* Come here on failure to create socket, connect socket, write to the
4932 socket, or timeout on reading. If another substring follows, expand and
4933 use it. Otherwise, those conditions give expand errors. */
4936 if (*s != '{') goto EXPAND_FAILED;
4937 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4938 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
4940 yield = string_cat(yield, &size, &ptr, arg);
4943 expand_string_message = US"missing '}' closing failstring for readsocket";
4944 goto EXPAND_FAILED_CURLY;
4946 while (isspace(*s)) s++;
4950 /* Handle "run" to execute a program. */
4956 const uschar **argv;
4959 int lsize = 0, lptr = 0;
4961 if ((expand_forbid & RDO_RUN) != 0)
4963 expand_string_message = US"running a command is not permitted";
4967 while (isspace(*s)) s++;
4970 expand_string_message = US"missing '{' for command arg of run";
4971 goto EXPAND_FAILED_CURLY;
4973 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4974 if (arg == NULL) goto EXPAND_FAILED;
4975 while (isspace(*s)) s++;
4978 expand_string_message = US"missing '}' closing command arg of run";
4979 goto EXPAND_FAILED_CURLY;
4982 if (skipping) /* Just pretend it worked when we're skipping */
4985 lookup_value = NULL;
4989 if (!transport_set_up_command(&argv, /* anchor for arg list */
4990 arg, /* raw command */
4991 FALSE, /* don't expand the arguments */
4992 0, /* not relevant when... */
4993 NULL, /* no transporting address */
4994 US"${run} expansion", /* for error messages */
4995 &expand_string_message)) /* where to put error message */
4998 /* Create the child process, making it a group leader. */
5000 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
5002 expand_string_message =
5003 string_sprintf("couldn't create child process: %s", strerror(errno));
5007 /* Nothing is written to the standard input. */
5011 /* Read the pipe to get the command's output into $value (which is kept
5012 in lookup_value). Read during execution, so that if the output exceeds
5013 the OS pipe buffer limit, we don't block forever. Remember to not release
5014 memory just allocated for $value. */
5017 f = fdopen(fd_out, "rb");
5018 sigalrm_seen = FALSE;
5020 lookup_value = cat_file(f, NULL, &lsize, &lptr, NULL);
5024 /* Wait for the process to finish, applying the timeout, and inspect its
5025 return code for serious disasters. Simple non-zero returns are passed on.
5028 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5030 if (sigalrm_seen || runrc == -256)
5032 expand_string_message = string_sprintf("command timed out");
5033 killpg(pid, SIGKILL); /* Kill the whole process group */
5036 else if (runrc == -257)
5037 expand_string_message = string_sprintf("wait() failed: %s",
5041 expand_string_message = string_sprintf("command killed by signal %d",
5048 /* Process the yes/no strings; $value may be useful in both cases */
5050 switch(process_yesno(
5051 skipping, /* were previously skipping */
5052 runrc == 0, /* success/failure indicator */
5053 lookup_value, /* value to reset for string2 */
5054 &s, /* input pointer */
5055 &yield, /* output pointer */
5056 &size, /* output size */
5057 &ptr, /* output current point */
5058 US"run", /* condition type */
5061 case 1: goto EXPAND_FAILED; /* when all is well, the */
5062 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5068 /* Handle character translation for "tr" */
5076 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5078 case 1: goto EXPAND_FAILED_CURLY;
5080 case 3: goto EXPAND_FAILED;
5083 yield = string_cat(yield, &size, &ptr, sub[0]);
5084 o2m = Ustrlen(sub[2]) - 1;
5086 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
5088 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
5092 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
5099 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5100 expanded arguments. */
5110 int val[2] = { 0, -1 };
5113 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5114 Ensure that sub[2] is set in the ${length } case. */
5117 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5118 TRUE, name, &resetok))
5120 case 1: goto EXPAND_FAILED_CURLY;
5122 case 3: goto EXPAND_FAILED;
5125 /* Juggle the arguments if there are only two of them: always move the
5126 string to the last position and make ${length{n}{str}} equivalent to
5127 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5133 if (item_type == EITEM_LENGTH)
5140 for (i = 0; i < 2; i++)
5142 if (sub[i] == NULL) continue;
5143 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5144 if (*ret != 0 || (i != 0 && val[i] < 0))
5146 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5147 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5153 (item_type == EITEM_HASH)?
5154 compute_hash(sub[2], val[0], val[1], &len) :
5155 (item_type == EITEM_NHASH)?
5156 compute_nhash(sub[2], val[0], val[1], &len) :
5157 extract_substr(sub[2], val[0], val[1], &len);
5159 if (ret == NULL) goto EXPAND_FAILED;
5160 yield = string_catn(yield, &size, &ptr, ret, len);
5164 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5165 This code originally contributed by Steve Haslam. It currently supports
5166 the use of MD5 and SHA-1 hashes.
5168 We need some workspace that is large enough to handle all the supported
5169 hash types. Use macros to set the sizes rather than be too elaborate. */
5171 #define MAX_HASHLEN 20
5172 #define MAX_HASHBLOCKLEN 64
5181 int hashlen; /* Number of octets for the hash algorithm's output */
5182 int hashblocklen; /* Number of octets the hash algorithm processes */
5184 unsigned int keylen;
5186 uschar keyhash[MAX_HASHLEN];
5187 uschar innerhash[MAX_HASHLEN];
5188 uschar finalhash[MAX_HASHLEN];
5189 uschar finalhash_hex[2*MAX_HASHLEN];
5190 uschar innerkey[MAX_HASHBLOCKLEN];
5191 uschar outerkey[MAX_HASHBLOCKLEN];
5193 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5195 case 1: goto EXPAND_FAILED_CURLY;
5197 case 3: goto EXPAND_FAILED;
5202 if (Ustrcmp(sub[0], "md5") == 0)
5205 use_base = &md5_base;
5209 else if (Ustrcmp(sub[0], "sha1") == 0)
5212 use_base = &sha1_ctx;
5218 expand_string_message =
5219 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5224 keylen = Ustrlen(keyptr);
5226 /* If the key is longer than the hash block length, then hash the key
5229 if (keylen > hashblocklen)
5231 chash_start(type, use_base);
5232 chash_end(type, use_base, keyptr, keylen, keyhash);
5237 /* Now make the inner and outer key values */
5239 memset(innerkey, 0x36, hashblocklen);
5240 memset(outerkey, 0x5c, hashblocklen);
5242 for (i = 0; i < keylen; i++)
5244 innerkey[i] ^= keyptr[i];
5245 outerkey[i] ^= keyptr[i];
5248 /* Now do the hashes */
5250 chash_start(type, use_base);
5251 chash_mid(type, use_base, innerkey);
5252 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5254 chash_start(type, use_base);
5255 chash_mid(type, use_base, outerkey);
5256 chash_end(type, use_base, innerhash, hashlen, finalhash);
5258 /* Encode the final hash as a hex string */
5261 for (i = 0; i < hashlen; i++)
5263 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5264 *p++ = hex_digits[finalhash[i] & 0x0f];
5267 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5268 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5270 yield = string_catn(yield, &size, &ptr, finalhash_hex, hashlen*2);
5275 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5276 We have to save the numerical variables and restore them afterwards. */
5281 int moffset, moffsetextra, slen;
5284 const uschar *rerror;
5287 int save_expand_nmax =
5288 save_expand_strings(save_expand_nstring, save_expand_nlength);
5290 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5292 case 1: goto EXPAND_FAILED_CURLY;
5294 case 3: goto EXPAND_FAILED;
5297 /* Compile the regular expression */
5299 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5304 expand_string_message = string_sprintf("regular expression error in "
5305 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5309 /* Now run a loop to do the substitutions as often as necessary. It ends
5310 when there are no more matches. Take care over matches of the null string;
5311 do the same thing as Perl does. */
5314 slen = Ustrlen(sub[0]);
5315 moffset = moffsetextra = 0;
5320 int ovector[3*(EXPAND_MAXN+1)];
5321 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5322 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5326 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5327 is not necessarily the end. We want to repeat the match from one
5328 character further along, but leaving the basic offset the same (for
5329 copying below). We can't be at the end of the string - that was checked
5330 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5331 finished; copy the remaining string and end the loop. */
5341 yield = string_catn(yield, &size, &ptr, subject+moffset, slen-moffset);
5345 /* Match - set up for expanding the replacement. */
5347 if (n == 0) n = EXPAND_MAXN + 1;
5349 for (nn = 0; nn < n*2; nn += 2)
5351 expand_nstring[expand_nmax] = subject + ovector[nn];
5352 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5356 /* Copy the characters before the match, plus the expanded insertion. */
5358 yield = string_catn(yield, &size, &ptr, subject + moffset,
5359 ovector[0] - moffset);
5360 insert = expand_string(sub[2]);
5361 if (insert == NULL) goto EXPAND_FAILED;
5362 yield = string_cat(yield, &size, &ptr, insert);
5364 moffset = ovector[1];
5368 /* If we have matched an empty string, first check to see if we are at
5369 the end of the subject. If so, the loop is over. Otherwise, mimic
5370 what Perl's /g options does. This turns out to be rather cunning. First
5371 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5372 string at the same point. If this fails (picked up above) we advance to
5373 the next character. */
5375 if (ovector[0] == ovector[1])
5377 if (ovector[0] == slen) break;
5378 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5382 /* All done - restore numerical variables. */
5384 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5385 save_expand_nlength);
5389 /* Handle keyed and numbered substring extraction. If the first argument
5390 consists entirely of digits, then a numerical extraction is assumed. */
5396 int field_number = 1;
5397 BOOL field_number_set = FALSE;
5398 uschar *save_lookup_value = lookup_value;
5400 int save_expand_nmax =
5401 save_expand_strings(save_expand_nstring, save_expand_nlength);
5403 /* While skipping we cannot rely on the data for expansions being
5404 available (eg. $item) hence cannot decide on numeric vs. keyed.
5405 Read a maximum of 5 arguments (including the yes/no) */
5409 while (isspace(*s)) s++;
5410 for (j = 5; j > 0 && *s == '{'; j--)
5412 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5413 goto EXPAND_FAILED; /*{*/
5416 expand_string_message = US"missing '{' for arg of extract";
5417 goto EXPAND_FAILED_CURLY;
5419 while (isspace(*s)) s++;
5421 if ( Ustrncmp(s, "fail", 4) == 0
5422 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5426 while (isspace(*s)) s++;
5430 expand_string_message = US"missing '}' closing extract";
5431 goto EXPAND_FAILED_CURLY;
5435 else for (i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5437 while (isspace(*s)) s++;
5438 if (*s == '{') /*}*/
5440 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5441 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5444 expand_string_message = string_sprintf(
5445 "missing '}' closing arg %d of extract", i+1);
5446 goto EXPAND_FAILED_CURLY;
5449 /* After removal of leading and trailing white space, the first
5450 argument must not be empty; if it consists entirely of digits
5451 (optionally preceded by a minus sign), this is a numerical
5452 extraction, and we expect 3 arguments. */
5460 while (isspace(*p)) p++;
5464 while (len > 0 && isspace(p[len-1])) len--;
5469 expand_string_message = US"first argument of \"extract\" must "
5479 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5483 j = 3; /* Need 3 args */
5484 field_number_set = TRUE;
5490 expand_string_message = string_sprintf(
5491 "missing '{' for arg %d of extract", i+1);
5492 goto EXPAND_FAILED_CURLY;
5496 /* Extract either the numbered or the keyed substring into $value. If
5497 skipping, just pretend the extraction failed. */
5499 lookup_value = skipping? NULL : field_number_set?
5500 expand_gettokened(field_number, sub[1], sub[2]) :
5501 expand_getkeyed(sub[0], sub[1]);
5503 /* If no string follows, $value gets substituted; otherwise there can
5504 be yes/no strings, as for lookup or if. */
5506 switch(process_yesno(
5507 skipping, /* were previously skipping */
5508 lookup_value != NULL, /* success/failure indicator */
5509 save_lookup_value, /* value to reset for string2 */
5510 &s, /* input pointer */
5511 &yield, /* output pointer */
5512 &size, /* output size */
5513 &ptr, /* output current point */
5514 US"extract", /* condition type */
5517 case 1: goto EXPAND_FAILED; /* when all is well, the */
5518 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5521 /* All done - restore numerical variables. */
5523 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5524 save_expand_nlength);
5529 /* return the Nth item from a list */
5531 case EITEM_LISTEXTRACT:
5534 int field_number = 1;
5535 uschar *save_lookup_value = lookup_value;
5537 int save_expand_nmax =
5538 save_expand_strings(save_expand_nstring, save_expand_nlength);
5540 /* Read the field & list arguments */
5542 for (i = 0; i < 2; i++)
5544 while (isspace(*s)) s++;
5545 if (*s != '{') /*}*/
5547 expand_string_message = string_sprintf(
5548 "missing '{' for arg %d of listextract", i+1);
5549 goto EXPAND_FAILED_CURLY;
5552 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5553 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5556 expand_string_message = string_sprintf(
5557 "missing '}' closing arg %d of listextract", i+1);
5558 goto EXPAND_FAILED_CURLY;
5561 /* After removal of leading and trailing white space, the first
5562 argument must be numeric and nonempty. */
5570 while (isspace(*p)) p++;
5574 while (len > 0 && isspace(p[len-1])) len--;
5577 if (!*p && !skipping)
5579 expand_string_message = US"first argument of \"listextract\" must "
5589 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5592 expand_string_message = US"first argument of \"listextract\" must "
5600 /* Extract the numbered element into $value. If
5601 skipping, just pretend the extraction failed. */
5603 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5605 /* If no string follows, $value gets substituted; otherwise there can
5606 be yes/no strings, as for lookup or if. */
5608 switch(process_yesno(
5609 skipping, /* were previously skipping */
5610 lookup_value != NULL, /* success/failure indicator */
5611 save_lookup_value, /* value to reset for string2 */
5612 &s, /* input pointer */
5613 &yield, /* output pointer */
5614 &size, /* output size */
5615 &ptr, /* output current point */
5616 US"listextract", /* condition type */
5619 case 1: goto EXPAND_FAILED; /* when all is well, the */
5620 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5623 /* All done - restore numerical variables. */
5625 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5626 save_expand_nlength);
5632 case EITEM_CERTEXTRACT:
5634 uschar *save_lookup_value = lookup_value;
5636 int save_expand_nmax =
5637 save_expand_strings(save_expand_nstring, save_expand_nlength);
5639 /* Read the field argument */
5640 while (isspace(*s)) s++;
5641 if (*s != '{') /*}*/
5643 expand_string_message = US"missing '{' for field arg of certextract";
5644 goto EXPAND_FAILED_CURLY;
5646 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5647 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5650 expand_string_message = US"missing '}' closing field arg of certextract";
5651 goto EXPAND_FAILED_CURLY;
5653 /* strip spaces fore & aft */
5658 while (isspace(*p)) p++;
5662 while (len > 0 && isspace(p[len-1])) len--;
5666 /* inspect the cert argument */
5667 while (isspace(*s)) s++;
5668 if (*s != '{') /*}*/
5670 expand_string_message = US"missing '{' for cert variable arg of certextract";
5671 goto EXPAND_FAILED_CURLY;
5675 expand_string_message = US"second argument of \"certextract\" must "
5676 "be a certificate variable";
5679 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5680 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5683 expand_string_message = US"missing '}' closing cert variable arg of certextract";
5684 goto EXPAND_FAILED_CURLY;
5688 lookup_value = NULL;
5691 lookup_value = expand_getcertele(sub[0], sub[1]);
5692 if (*expand_string_message) goto EXPAND_FAILED;
5694 switch(process_yesno(
5695 skipping, /* were previously skipping */
5696 lookup_value != NULL, /* success/failure indicator */
5697 save_lookup_value, /* value to reset for string2 */
5698 &s, /* input pointer */
5699 &yield, /* output pointer */
5700 &size, /* output size */
5701 &ptr, /* output current point */
5702 US"certextract", /* condition type */
5705 case 1: goto EXPAND_FAILED; /* when all is well, the */
5706 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5709 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5710 save_expand_nlength);
5713 #endif /*SUPPORT_TLS*/
5715 /* Handle list operations */
5723 uschar outsep[2] = { '\0', '\0' };
5724 const uschar *list, *expr, *temp;
5725 uschar *save_iterate_item = iterate_item;
5726 uschar *save_lookup_value = lookup_value;
5728 while (isspace(*s)) s++;
5731 expand_string_message =
5732 string_sprintf("missing '{' for first arg of %s", name);
5733 goto EXPAND_FAILED_CURLY;
5736 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5737 if (list == NULL) goto EXPAND_FAILED;
5740 expand_string_message =
5741 string_sprintf("missing '}' closing first arg of %s", name);
5742 goto EXPAND_FAILED_CURLY;
5745 if (item_type == EITEM_REDUCE)
5748 while (isspace(*s)) s++;
5751 expand_string_message = US"missing '{' for second arg of reduce";
5752 goto EXPAND_FAILED_CURLY;
5754 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5755 if (!t) goto EXPAND_FAILED;
5759 expand_string_message = US"missing '}' closing second arg of reduce";
5760 goto EXPAND_FAILED_CURLY;
5764 while (isspace(*s)) s++;
5767 expand_string_message =
5768 string_sprintf("missing '{' for last arg of %s", name);
5769 goto EXPAND_FAILED_CURLY;
5774 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5775 if scanning a "false" part). This allows us to find the end of the
5776 condition, because if the list is empty, we won't actually evaluate the
5777 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5778 the normal internal expansion function. */
5780 if (item_type == EITEM_FILTER)
5782 temp = eval_condition(expr, &resetok, NULL);
5783 if (temp != NULL) s = temp;
5786 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5790 expand_string_message = string_sprintf("%s inside \"%s\" item",
5791 expand_string_message, name);
5795 while (isspace(*s)) s++;
5798 expand_string_message = string_sprintf("missing } at end of condition "
5799 "or expression inside \"%s\"", name);
5803 while (isspace(*s)) s++; /*{*/
5806 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5811 /* If we are skipping, we can now just move on to the next item. When
5812 processing for real, we perform the iteration. */
5814 if (skipping) continue;
5815 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
5817 *outsep = (uschar)sep; /* Separator as a string */
5819 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
5820 name, iterate_item, lookup_value);
5822 if (item_type == EITEM_FILTER)
5825 if (eval_condition(expr, &resetok, &condresult) == NULL)
5827 iterate_item = save_iterate_item;
5828 lookup_value = save_lookup_value;
5829 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5830 expand_string_message, name);
5833 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
5834 condresult? "true":"false");
5836 temp = iterate_item; /* TRUE => include this item */
5838 continue; /* FALSE => skip this item */
5841 /* EITEM_MAP and EITEM_REDUCE */
5845 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5849 iterate_item = save_iterate_item;
5850 expand_string_message = string_sprintf("%s inside \"%s\" item",
5851 expand_string_message, name);
5854 if (item_type == EITEM_REDUCE)
5856 lookup_value = t; /* Update the value of $value */
5857 continue; /* and continue the iteration */
5861 /* We reach here for FILTER if the condition is true, always for MAP,
5862 and never for REDUCE. The value in "temp" is to be added to the output
5863 list that is being created, ensuring that any occurrences of the
5864 separator character are doubled. Unless we are dealing with the first
5865 item of the output list, add in a space if the new item begins with the
5866 separator character, or is an empty string. */
5868 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5869 yield = string_catn(yield, &size, &ptr, US" ", 1);
5871 /* Add the string in "temp" to the output list that we are building,
5872 This is done in chunks by searching for the separator character. */
5876 size_t seglen = Ustrcspn(temp, outsep);
5878 yield = string_catn(yield, &size, &ptr, temp, seglen + 1);
5880 /* If we got to the end of the string we output one character
5881 too many; backup and end the loop. Otherwise arrange to double the
5884 if (temp[seglen] == '\0') { ptr--; break; }
5885 yield = string_catn(yield, &size, &ptr, outsep, 1);
5889 /* Output a separator after the string: we will remove the redundant
5890 final one at the end. */
5892 yield = string_catn(yield, &size, &ptr, outsep, 1);
5893 } /* End of iteration over the list loop */
5895 /* REDUCE has generated no output above: output the final value of
5898 if (item_type == EITEM_REDUCE)
5900 yield = string_cat(yield, &size, &ptr, lookup_value);
5901 lookup_value = save_lookup_value; /* Restore $value */
5904 /* FILTER and MAP generate lists: if they have generated anything, remove
5905 the redundant final separator. Even though an empty item at the end of a
5906 list does not count, this is tidier. */
5908 else if (ptr != save_ptr) ptr--;
5910 /* Restore preserved $item */
5912 iterate_item = save_iterate_item;
5919 const uschar *srclist, *cmp, *xtract;
5921 const uschar *dstlist = NULL, *dstkeylist = NULL;
5923 uschar *save_iterate_item = iterate_item;
5925 while (isspace(*s)) s++;
5928 expand_string_message = US"missing '{' for list arg of sort";
5929 goto EXPAND_FAILED_CURLY;
5932 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5933 if (!srclist) goto EXPAND_FAILED;
5936 expand_string_message = US"missing '}' closing list arg of sort";
5937 goto EXPAND_FAILED_CURLY;
5940 while (isspace(*s)) s++;
5943 expand_string_message = US"missing '{' for comparator arg of sort";
5944 goto EXPAND_FAILED_CURLY;
5947 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5948 if (!cmp) goto EXPAND_FAILED;
5951 expand_string_message = US"missing '}' closing comparator arg of sort";
5952 goto EXPAND_FAILED_CURLY;
5955 while (isspace(*s)) s++;
5958 expand_string_message = US"missing '{' for extractor arg of sort";
5959 goto EXPAND_FAILED_CURLY;
5963 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5964 if (!tmp) goto EXPAND_FAILED;
5965 xtract = string_copyn(xtract, s - xtract);
5969 expand_string_message = US"missing '}' closing extractor arg of sort";
5970 goto EXPAND_FAILED_CURLY;
5975 expand_string_message = US"missing } at end of \"sort\"";
5979 if (skipping) continue;
5981 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5984 uschar * newlist = NULL;
5985 uschar * newkeylist = NULL;
5988 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
5990 /* extract field for comparisons */
5991 iterate_item = srcitem;
5992 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5996 expand_string_message = string_sprintf(
5997 "field-extract in sort: \"%s\"", xtract);
6001 /* Insertion sort */
6003 /* copy output list until new-item < list-item */
6004 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6010 /* field for comparison */
6011 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6014 /* build and run condition string */
6015 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
6017 DEBUG(D_expand) debug_printf_indent("%s: cond = \"%s\"\n", name, expr);
6018 if (!eval_condition(expr, &resetok, &before))
6020 expand_string_message = string_sprintf("comparison in sort: %s",
6027 /* New-item sorts before this dst-item. Append new-item,
6028 then dst-item, then remainder of dst list. */
6030 newlist = string_append_listele(newlist, sep, srcitem);
6031 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6034 newlist = string_append_listele(newlist, sep, dstitem);
6035 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6037 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6039 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6041 newlist = string_append_listele(newlist, sep, dstitem);
6042 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6048 newlist = string_append_listele(newlist, sep, dstitem);
6049 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6052 /* If we ran out of dstlist without consuming srcitem, append it */
6055 newlist = string_append_listele(newlist, sep, srcitem);
6056 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6060 dstkeylist = newkeylist;
6062 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6063 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6067 yield = string_cat(yield, &size, &ptr, dstlist);
6069 /* Restore preserved $item */
6070 iterate_item = save_iterate_item;
6074 expand_string_message = US"Internal error in sort (list mismatch)";
6079 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6080 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6081 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6082 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6084 #define EXPAND_DLFUNC_MAX_ARGS 8
6087 #ifndef EXPAND_DLFUNC
6088 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6089 "is not included in this binary";
6092 #else /* EXPAND_DLFUNC */
6095 exim_dlfunc_t *func;
6098 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6100 if ((expand_forbid & RDO_DLFUNC) != 0)
6102 expand_string_message =
6103 US"dynamically-loaded functions are not permitted";
6107 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6108 TRUE, US"dlfunc", &resetok))
6110 case 1: goto EXPAND_FAILED_CURLY;
6112 case 3: goto EXPAND_FAILED;
6115 /* If skipping, we don't actually do anything */
6117 if (skipping) continue;
6119 /* Look up the dynamically loaded object handle in the tree. If it isn't
6120 found, dlopen() the file and put the handle in the tree for next time. */
6122 t = tree_search(dlobj_anchor, argv[0]);
6125 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6128 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6129 argv[0], dlerror());
6130 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6133 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6134 Ustrcpy(t->name, argv[0]);
6135 t->data.ptr = handle;
6136 (void)tree_insertnode(&dlobj_anchor, t);
6139 /* Having obtained the dynamically loaded object handle, look up the
6140 function pointer. */
6142 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6145 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6146 "%s", argv[1], argv[0], dlerror());
6147 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6151 /* Call the function and work out what to do with the result. If it
6152 returns OK, we have a replacement string; if it returns DEFER then
6153 expansion has failed in a non-forced manner; if it returns FAIL then
6154 failure was forced; if it returns ERROR or any other value there's a
6155 problem, so panic slightly. In any case, assume that the function has
6156 side-effects on the store that must be preserved. */
6160 for (argc = 0; argv[argc] != NULL; argc++);
6161 status = func(&result, argc - 2, &argv[2]);
6164 if (result == NULL) result = US"";
6165 yield = string_cat(yield, &size, &ptr, result);
6170 expand_string_message = result == NULL ? US"(no message)" : result;
6171 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
6172 else if(status != FAIL)
6173 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6174 argv[0], argv[1], status, expand_string_message);
6178 #endif /* EXPAND_DLFUNC */
6180 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6183 uschar *save_lookup_value = lookup_value;
6185 while (isspace(*s)) s++;
6186 if (*s != '{') /*}*/
6189 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6190 if (!key) goto EXPAND_FAILED; /*{*/
6193 expand_string_message = US"missing '{' for name arg of env";
6194 goto EXPAND_FAILED_CURLY;
6197 lookup_value = US getenv(CS key);
6199 switch(process_yesno(
6200 skipping, /* were previously skipping */
6201 lookup_value != NULL, /* success/failure indicator */
6202 save_lookup_value, /* value to reset for string2 */
6203 &s, /* input pointer */
6204 &yield, /* output pointer */
6205 &size, /* output size */
6206 &ptr, /* output current point */
6207 US"env", /* condition type */
6210 case 1: goto EXPAND_FAILED; /* when all is well, the */
6211 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6215 } /* EITEM_* switch */
6217 /* Control reaches here if the name is not recognized as one of the more
6218 complicated expansion items. Check for the "operator" syntax (name terminated
6219 by a colon). Some of the operators have arguments, separated by _ from the
6227 var_entry *vp = NULL;
6229 /* Owing to an historical mis-design, an underscore may be part of the
6230 operator name, or it may introduce arguments. We therefore first scan the
6231 table of names that contain underscores. If there is no match, we cut off
6232 the arguments and then scan the main table. */
6234 if ((c = chop_match(name, op_table_underscore,
6235 nelem(op_table_underscore))) < 0)
6237 arg = Ustrchr(name, '_');
6238 if (arg != NULL) *arg = 0;
6239 c = chop_match(name, op_table_main, nelem(op_table_main));
6240 if (c >= 0) c += nelem(op_table_underscore);
6241 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6244 /* Deal specially with operators that might take a certificate variable
6245 as we do not want to do the usual expansion. For most, expand the string.*/
6255 const uschar * s1 = s;
6256 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6258 if (!sub) goto EXPAND_FAILED; /*{*/
6261 expand_string_message =
6262 string_sprintf("missing '}' closing cert arg of %s", name);
6263 goto EXPAND_FAILED_CURLY;
6265 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6275 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6276 if (!sub) goto EXPAND_FAILED;
6281 /* If we are skipping, we don't need to perform the operation at all.
6282 This matters for operations like "mask", because the data may not be
6283 in the correct format when skipping. For example, the expression may test
6284 for the existence of $sender_host_address before trying to mask it. For
6285 other operations, doing them may not fail, but it is a waste of time. */
6287 if (skipping && c >= 0) continue;
6289 /* Otherwise, switch on the operator type */
6296 unsigned long int n = Ustrtoul(sub, &t, 10);
6302 expand_string_message = string_sprintf("argument for base32 "
6303 "operator is \"%s\", which is not a decimal number", sub);
6307 s = string_catn(s, &sz, &i, &base32_chars[n & 0x1f], 1);
6309 while (i > 0) yield = string_catn(yield, &size, &ptr, &s[--i], 1);
6316 unsigned long int n = 0;
6320 uschar * t = Ustrchr(base32_chars, *tt++);
6323 expand_string_message = string_sprintf("argument for base32d "
6324 "operator is \"%s\", which is not a base 32 number", sub);
6327 n = n * 32 + (t - base32_chars);
6329 s = string_sprintf("%ld", n);
6330 yield = string_cat(yield, &size, &ptr, s);
6337 unsigned long int n = Ustrtoul(sub, &t, 10);
6340 expand_string_message = string_sprintf("argument for base62 "
6341 "operator is \"%s\", which is not a decimal number", sub);
6344 t = string_base62(n);
6345 yield = string_cat(yield, &size, &ptr, t);
6349 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6355 unsigned long int n = 0;
6358 uschar *t = Ustrchr(base62_chars, *tt++);
6361 expand_string_message = string_sprintf("argument for base62d "
6362 "operator is \"%s\", which is not a base %d number", sub,
6366 n = n * BASE_62 + (t - base62_chars);
6368 (void)sprintf(CS buf, "%ld", n);
6369 yield = string_cat(yield, &size, &ptr, buf);
6375 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6376 if (expanded == NULL)
6378 expand_string_message =
6379 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6380 expand_string_message);
6383 yield = string_cat(yield, &size, &ptr, expanded);
6390 uschar *t = sub - 1;
6391 while (*(++t) != 0) { *t = tolower(*t); count++; }
6392 yield = string_catn(yield, &size, &ptr, sub, count);
6399 uschar *t = sub - 1;
6400 while (*(++t) != 0) { *t = toupper(*t); count++; }
6401 yield = string_catn(yield, &size, &ptr, sub, count);
6407 if (vp && *(void **)vp->value)
6409 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6410 yield = string_cat(yield, &size, &ptr, cp);
6420 md5_end(&base, sub, Ustrlen(sub), digest);
6421 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6422 yield = string_cat(yield, &size, &ptr, US st);
6428 if (vp && *(void **)vp->value)
6430 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6431 yield = string_cat(yield, &size, &ptr, cp);
6441 sha1_end(&h, sub, Ustrlen(sub), digest);
6442 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6443 yield = string_catn(yield, &size, &ptr, US st, 40);
6448 #ifdef EXIM_HAVE_SHA2
6449 if (vp && *(void **)vp->value)
6451 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6452 yield = string_cat(yield, &size, &ptr, cp);
6460 if (!exim_sha_init(&h, HASH_SHA256))
6462 expand_string_message = US"unrecognised sha256 variant";
6465 exim_sha_update(&h, sub, Ustrlen(sub));
6466 exim_sha_finish(&h, &b);
6469 sprintf(st, "%02X", *b.data++);
6470 yield = string_catn(yield, &size, &ptr, US st, 2);
6474 expand_string_message = US"sha256 only supported with TLS";
6479 #ifdef EXIM_HAVE_SHA3
6484 hashmethod m = !arg ? HASH_SHA3_256
6485 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6486 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6487 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6488 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6491 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
6493 expand_string_message = US"unrecognised sha3 variant";
6497 exim_sha_update(&h, sub, Ustrlen(sub));
6498 exim_sha_finish(&h, &b);
6501 sprintf(st, "%02X", *b.data++);
6502 yield = string_catn(yield, &size, &ptr, US st, 2);
6507 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 +";
6511 /* Convert hex encoding to base64 encoding */
6521 for (enc = sub; *enc != 0; enc++)
6523 if (!isxdigit(*enc))
6525 expand_string_message = string_sprintf("\"%s\" is not a hex "
6534 expand_string_message = string_sprintf("\"%s\" contains an odd "
6535 "number of characters", sub);
6539 while ((c = *in++) != 0)
6541 if (isdigit(c)) c -= '0';
6542 else c = toupper(c) - 'A' + 10;
6554 enc = b64encode(sub, out - sub);
6555 yield = string_cat(yield, &size, &ptr, enc);
6559 /* Convert octets outside 0x21..0x7E to \xXX form */
6563 uschar *t = sub - 1;
6566 if (*t < 0x21 || 0x7E < *t)
6567 yield = string_catn(yield, &size, &ptr,
6568 string_sprintf("\\x%02x", *t), 4);
6570 yield = string_catn(yield, &size, &ptr, t, 1);
6575 /* count the number of list elements */
6584 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6585 cp = string_sprintf("%d", cnt);
6586 yield = string_cat(yield, &size, &ptr, cp);
6590 /* expand a named list given the name */
6591 /* handles nested named lists; requotes as colon-sep list */
6595 tree_node *t = NULL;
6596 const uschar * list;
6599 uschar * suffix = US"";
6600 BOOL needsep = FALSE;
6603 if (*sub == '+') sub++;
6604 if (arg == NULL) /* no-argument version */
6606 if (!(t = tree_search(addresslist_anchor, sub)) &&
6607 !(t = tree_search(domainlist_anchor, sub)) &&
6608 !(t = tree_search(hostlist_anchor, sub)))
6609 t = tree_search(localpartlist_anchor, sub);
6611 else switch(*arg) /* specific list-type version */
6613 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6614 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6615 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6616 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6618 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6624 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6626 : *arg=='a'?"address "
6627 : *arg=='d'?"domain "
6629 : *arg=='l'?"localpart "
6634 list = ((namedlist_block *)(t->data.ptr))->string;
6636 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6638 uschar * buf = US" : ";
6640 yield = string_catn(yield, &size, &ptr, buf, 3);
6644 if (*item == '+') /* list item is itself a named list */
6646 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6647 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6649 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6653 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6654 while ((cp= strpbrk((const char *)item, tok)))
6656 yield = string_catn(yield, &size, &ptr, item, cp-(char *)item);
6657 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6659 yield = string_catn(yield, &size, &ptr, US"::", 2);
6660 item = (uschar *)cp;
6662 else /* sep in item; should already be doubled; emit once */
6664 yield = string_catn(yield, &size, &ptr, (uschar *)tok, 1);
6665 if (*cp == sep) cp++;
6666 item = (uschar *)cp;
6670 yield = string_cat(yield, &size, &ptr, item);
6675 /* mask applies a mask to an IP address; for example the result of
6676 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6683 int mask, maskoffset;
6684 int type = string_is_ip_address(sub, &maskoffset);
6689 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6694 if (maskoffset == 0)
6696 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6701 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6703 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6705 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6710 /* Convert the address to binary integer(s) and apply the mask */
6712 sub[maskoffset] = 0;
6713 count = host_aton(sub, binary);
6714 host_mask(count, binary, mask);
6716 /* Convert to masked textual format and add to output. */
6718 yield = string_catn(yield, &size, &ptr, buffer,
6719 host_nmtoa(count, binary, mask, buffer, '.'));
6724 case EOP_IPV6DENORM:
6726 int type = string_is_ip_address(sub, NULL);
6733 (void) host_aton(sub, binary);
6736 case 4: /* convert to IPv4-mapped IPv6 */
6737 binary[0] = binary[1] = 0;
6738 binary[2] = 0x0000ffff;
6739 (void) host_aton(sub, binary+3);
6743 expand_string_message =
6744 string_sprintf("\"%s\" is not an IP address", sub);
6748 yield = string_catn(yield, &size, &ptr, buffer,
6750 ? ipv6_nmtoa(binary, buffer)
6751 : host_nmtoa(4, binary, -1, buffer, ':')
6757 case EOP_LOCAL_PART:
6761 int start, end, domain;
6762 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
6765 if (c != EOP_DOMAIN)
6767 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6768 yield = string_catn(yield, &size, &ptr, sub+start, end-start);
6770 else if (domain != 0)
6773 yield = string_catn(yield, &size, &ptr, sub+domain, end-domain);
6780 uschar outsep[2] = { ':', '\0' };
6781 uschar *address, *error;
6783 int start, end, domain; /* Not really used */
6785 while (isspace(*sub)) sub++;
6786 if (*sub == '>') { *outsep = *++sub; ++sub; }
6787 parse_allow_group = TRUE;
6791 uschar *p = parse_find_address_end(sub, FALSE);
6792 uschar saveend = *p;
6794 address = parse_extract_address(sub, &error, &start, &end, &domain,
6798 /* Add the address to the output list that we are building. This is
6799 done in chunks by searching for the separator character. At the
6800 start, unless we are dealing with the first address of the output
6801 list, add in a space if the new address begins with the separator
6802 character, or is an empty string. */
6804 if (address != NULL)
6806 if (ptr != save_ptr && address[0] == *outsep)
6807 yield = string_catn(yield, &size, &ptr, US" ", 1);
6811 size_t seglen = Ustrcspn(address, outsep);
6812 yield = string_catn(yield, &size, &ptr, address, seglen + 1);
6814 /* If we got to the end of the string we output one character
6817 if (address[seglen] == '\0') { ptr--; break; }
6818 yield = string_catn(yield, &size, &ptr, outsep, 1);
6819 address += seglen + 1;
6822 /* Output a separator after the string: we will remove the
6823 redundant final one at the end. */
6825 yield = string_catn(yield, &size, &ptr, outsep, 1);
6828 if (saveend == '\0') break;
6832 /* If we have generated anything, remove the redundant final
6835 if (ptr != save_ptr) ptr--;
6836 parse_allow_group = FALSE;
6841 /* quote puts a string in quotes if it is empty or contains anything
6842 other than alphamerics, underscore, dot, or hyphen.
6844 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6845 be quoted in order to be a valid local part.
6847 In both cases, newlines and carriage returns are converted into \n and \r
6851 case EOP_QUOTE_LOCAL_PART:
6854 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6855 uschar *t = sub - 1;
6859 while (!needs_quote && *(++t) != 0)
6860 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6862 else /* EOP_QUOTE_LOCAL_PART */
6864 while (!needs_quote && *(++t) != 0)
6865 needs_quote = !isalnum(*t) &&
6866 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6867 (*t != '.' || t == sub || t[1] == 0);
6872 yield = string_catn(yield, &size, &ptr, US"\"", 1);
6877 yield = string_catn(yield, &size, &ptr, US"\\n", 2);
6878 else if (*t == '\r')
6879 yield = string_catn(yield, &size, &ptr, US"\\r", 2);
6882 if (*t == '\\' || *t == '"')
6883 yield = string_catn(yield, &size, &ptr, US"\\", 1);
6884 yield = string_catn(yield, &size, &ptr, t, 1);
6887 yield = string_catn(yield, &size, &ptr, US"\"", 1);
6889 else yield = string_cat(yield, &size, &ptr, sub);
6893 /* quote_lookuptype does lookup-specific quoting */
6898 uschar *opt = Ustrchr(arg, '_');
6900 if (opt != NULL) *opt++ = 0;
6902 n = search_findtype(arg, Ustrlen(arg));
6905 expand_string_message = search_error_message;
6909 if (lookup_list[n]->quote != NULL)
6910 sub = (lookup_list[n]->quote)(sub, opt);
6911 else if (opt != NULL) sub = NULL;
6915 expand_string_message = string_sprintf(
6916 "\"%s\" unrecognized after \"${quote_%s\"",
6921 yield = string_cat(yield, &size, &ptr, sub);
6925 /* rx quote sticks in \ before any non-alphameric character so that
6926 the insertion works in a regular expression. */
6930 uschar *t = sub - 1;
6934 yield = string_catn(yield, &size, &ptr, US"\\", 1);
6935 yield = string_catn(yield, &size, &ptr, t, 1);
6940 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6941 prescribed by the RFC, if there are characters that need to be encoded */
6945 uschar buffer[2048];
6946 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6947 buffer, sizeof(buffer), FALSE);
6948 yield = string_cat(yield, &size, &ptr, string);
6952 /* RFC 2047 decode */
6958 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6959 headers_charset, '?', &len, &error);
6962 expand_string_message = error;
6965 yield = string_catn(yield, &size, &ptr, decoded, len);
6969 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6979 if (c > 255) c = '_';
6981 yield = string_catn(yield, &size, &ptr, buff, 1);
6986 /* replace illegal UTF-8 sequences by replacement character */
6988 #define UTF8_REPLACEMENT_CHAR US"?"
6992 int seq_len = 0, index = 0;
6994 long codepoint = -1;
6995 uschar seq_buff[4]; /* accumulate utf-8 here */
7004 if ((c & 0xc0) != 0x80)
7005 /* wrong continuation byte; invalidate all bytes */
7006 complete = 1; /* error */
7009 codepoint = (codepoint << 6) | (c & 0x3f);
7010 seq_buff[index++] = c;
7011 if (--bytes_left == 0) /* codepoint complete */
7012 if(codepoint > 0x10FFFF) /* is it too large? */
7013 complete = -1; /* error (RFC3629 limit) */
7015 { /* finished; output utf-8 sequence */
7016 yield = string_catn(yield, &size, &ptr, seq_buff, seq_len);
7021 else /* no bytes left: new sequence */
7023 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7025 yield = string_catn(yield, &size, &ptr, &c, 1);
7028 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7030 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7035 codepoint = c & 0x1f;
7038 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7041 codepoint = c & 0x0f;
7043 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7046 codepoint = c & 0x07;
7048 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7051 seq_buff[index++] = c;
7052 seq_len = bytes_left + 1;
7053 } /* if(bytes_left) */
7057 bytes_left = index = 0;
7058 yield = string_catn(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
7060 if ((complete == 1) && ((c & 0x80) == 0))
7061 /* ASCII character follows incomplete sequence */
7062 yield = string_catn(yield, &size, &ptr, &c, 1);
7068 case EOP_UTF8_DOMAIN_TO_ALABEL:
7070 uschar * error = NULL;
7071 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7074 expand_string_message = string_sprintf(
7075 "error converting utf8 (%s) to alabel: %s",
7076 string_printing(sub), error);
7079 yield = string_cat(yield, &size, &ptr, s);
7083 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7085 uschar * error = NULL;
7086 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7089 expand_string_message = string_sprintf(
7090 "error converting alabel (%s) to utf8: %s",
7091 string_printing(sub), error);
7094 yield = string_cat(yield, &size, &ptr, s);
7098 case EOP_UTF8_LOCALPART_TO_ALABEL:
7100 uschar * error = NULL;
7101 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7104 expand_string_message = string_sprintf(
7105 "error converting utf8 (%s) to alabel: %s",
7106 string_printing(sub), error);
7109 yield = string_cat(yield, &size, &ptr, s);
7110 DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", yield);
7114 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7116 uschar * error = NULL;
7117 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7120 expand_string_message = string_sprintf(
7121 "error converting alabel (%s) to utf8: %s",
7122 string_printing(sub), error);
7125 yield = string_cat(yield, &size, &ptr, s);
7128 #endif /* EXPERIMENTAL_INTERNATIONAL */
7130 /* escape turns all non-printing characters into escape sequences. */
7134 const uschar * t = string_printing(sub);
7135 yield = string_cat(yield, &size, &ptr, t);
7139 case EOP_ESCAPE8BIT:
7141 const uschar * s = sub;
7144 for (s = sub; (c = *s); s++)
7145 yield = c < 127 && c != '\\'
7146 ? string_catn(yield, &size, &ptr, s, 1)
7147 : string_catn(yield, &size, &ptr, string_sprintf("\\%03o", c), 4);
7151 /* Handle numeric expression evaluation */
7156 uschar *save_sub = sub;
7157 uschar *error = NULL;
7158 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7161 expand_string_message = string_sprintf("error in expression "
7162 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
7166 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
7167 yield = string_cat(yield, &size, &ptr, var_buffer);
7171 /* Handle time period formating */
7175 int n = readconf_readtime(sub, 0, FALSE);
7178 expand_string_message = string_sprintf("string \"%s\" is not an "
7179 "Exim time interval in \"%s\" operator", sub, name);
7182 sprintf(CS var_buffer, "%d", n);
7183 yield = string_cat(yield, &size, &ptr, var_buffer);
7187 case EOP_TIME_INTERVAL:
7190 uschar *t = read_number(&n, sub);
7191 if (*t != 0) /* Not A Number*/
7193 expand_string_message = string_sprintf("string \"%s\" is not a "
7194 "positive number in \"%s\" operator", sub, name);
7197 t = readconf_printtime(n);
7198 yield = string_cat(yield, &size, &ptr, t);
7202 /* Convert string to base64 encoding */
7208 uschar * s = vp && *(void **)vp->value
7209 ? tls_cert_der_b64(*(void **)vp->value)
7210 : b64encode(sub, Ustrlen(sub));
7212 uschar * s = b64encode(sub, Ustrlen(sub));
7214 yield = string_cat(yield, &size, &ptr, s);
7221 int len = b64decode(sub, &s);
7224 expand_string_message = string_sprintf("string \"%s\" is not "
7225 "well-formed for \"%s\" operator", sub, name);
7228 yield = string_cat(yield, &size, &ptr, s);
7232 /* strlen returns the length of the string */
7237 (void)sprintf(CS buff, "%d", Ustrlen(sub));
7238 yield = string_cat(yield, &size, &ptr, buff);
7242 /* length_n or l_n takes just the first n characters or the whole string,
7243 whichever is the shorter;
7245 substr_m_n, and s_m_n take n characters from offset m; negative m take
7246 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7247 takes the rest, either to the right or to the left.
7249 hash_n or h_n makes a hash of length n from the string, yielding n
7250 characters from the set a-z; hash_n_m makes a hash of length n, but
7251 uses m characters from the set a-zA-Z0-9.
7253 nhash_n returns a single number between 0 and n-1 (in text form), while
7254 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7255 between 0 and n-1 and the second between 0 and m-1. */
7275 expand_string_message = string_sprintf("missing values after %s",
7280 /* "length" has only one argument, effectively being synonymous with
7283 if (c == EOP_LENGTH || c == EOP_L)
7289 /* The others have one or two arguments; for "substr" the first may be
7290 negative. The second being negative means "not supplied". */
7295 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7298 /* Read up to two numbers, separated by underscores */
7303 if (arg != ret && *arg == '_' && pn == &value1)
7307 if (arg[1] != 0) arg++;
7309 else if (!isdigit(*arg))
7311 expand_string_message =
7312 string_sprintf("non-digit after underscore in \"%s\"", name);
7315 else *pn = (*pn)*10 + *arg++ - '0';
7319 /* Perform the required operation */
7322 (c == EOP_HASH || c == EOP_H)?
7323 compute_hash(sub, value1, value2, &len) :
7324 (c == EOP_NHASH || c == EOP_NH)?
7325 compute_nhash(sub, value1, value2, &len) :
7326 extract_substr(sub, value1, value2, &len);
7328 if (ret == NULL) goto EXPAND_FAILED;
7329 yield = string_catn(yield, &size, &ptr, ret, len);
7339 uschar **modetable[3];
7344 if ((expand_forbid & RDO_EXISTS) != 0)
7346 expand_string_message = US"Use of the stat() expansion is not permitted";
7350 if (stat(CS sub, &st) < 0)
7352 expand_string_message = string_sprintf("stat(%s) failed: %s",
7353 sub, strerror(errno));
7357 switch (mode & S_IFMT)
7359 case S_IFIFO: smode[0] = 'p'; break;
7360 case S_IFCHR: smode[0] = 'c'; break;
7361 case S_IFDIR: smode[0] = 'd'; break;
7362 case S_IFBLK: smode[0] = 'b'; break;
7363 case S_IFREG: smode[0] = '-'; break;
7364 default: smode[0] = '?'; break;
7367 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7368 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7369 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7371 for (i = 0; i < 3; i++)
7373 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7378 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7379 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7380 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7381 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7382 (long)st.st_gid, st.st_size, (long)st.st_atime,
7383 (long)st.st_mtime, (long)st.st_ctime);
7384 yield = string_cat(yield, &size, &ptr, s);
7388 /* vaguely random number less than N */
7392 int_eximarith_t max;
7395 max = expanded_string_integer(sub, TRUE);
7396 if (expand_string_message != NULL)
7398 s = string_sprintf("%d", vaguely_random_number((int)max));
7399 yield = string_cat(yield, &size, &ptr, s);
7403 /* Reverse IP, including IPv6 to dotted-nibble */
7405 case EOP_REVERSE_IP:
7407 int family, maskptr;
7408 uschar reversed[128];
7410 family = string_is_ip_address(sub, &maskptr);
7413 expand_string_message = string_sprintf(
7414 "reverse_ip() not given an IP address [%s]", sub);
7417 invert_address(reversed, sub);
7418 yield = string_cat(yield, &size, &ptr, reversed);
7422 /* Unknown operator */
7425 expand_string_message =
7426 string_sprintf("unknown expansion operator \"%s\"", name);
7431 /* Handle a plain name. If this is the first thing in the expansion, release
7432 the pre-allocated buffer. If the result data is known to be in a new buffer,
7433 newsize will be set to the size of that buffer, and we can just point at that
7434 store instead of copying. Many expansion strings contain just one reference,
7435 so this is a useful optimization, especially for humungous headers
7436 ($message_headers). */
7444 if (resetok) store_reset(yield);
7448 if (!(value = find_variable(name, FALSE, skipping, &newsize)))
7450 expand_string_message =
7451 string_sprintf("unknown variable in \"${%s}\"", name);
7452 check_variable_error_message(name);
7455 len = Ustrlen(value);
7456 if (!yield && newsize)
7463 yield = string_catn(yield, &size, &ptr, value, len);
7467 /* Else there's something wrong */
7469 expand_string_message =
7470 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7471 "in a variable reference)", name);
7475 /* If we hit the end of the string when ket_ends is set, there is a missing
7476 terminating brace. */
7478 if (ket_ends && *s == 0)
7480 expand_string_message = malformed_header?
7481 US"missing } at end of string - could be header name not terminated by colon"
7483 US"missing } at end of string";
7487 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7488 added to the string. If so, set up an empty string. Add a terminating zero. If
7489 left != NULL, return a pointer to the terminator. */
7491 if (yield == NULL) yield = store_get(1);
7493 if (left != NULL) *left = s;
7495 /* Any stacking store that was used above the final string is no longer needed.
7496 In many cases the final string will be the first one that was got and so there
7497 will be optimal store usage. */
7499 if (resetok) store_reset(yield + ptr + 1);
7500 else if (resetok_p) *resetok_p = FALSE;
7504 debug_printf_indent("|__expanding: %.*s\n", (int)(s - string), string);
7505 debug_printf_indent("%s_____result: %s\n", skipping ? "|" : "\\", yield);
7506 if (skipping) debug_printf_indent("\\___skipping: result is not used\n");
7511 /* This is the failure exit: easiest to program with a goto. We still need
7512 to update the pointer to the terminator, for cases of nested calls with "fail".
7515 EXPAND_FAILED_CURLY:
7516 if (malformed_header)
7517 expand_string_message =
7518 US"missing or misplaced { or } - could be header name not terminated by colon";
7520 else if (!expand_string_message || !*expand_string_message)
7521 expand_string_message = US"missing or misplaced { or }";
7523 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7524 that is a bad idea, because expand_string_message is in dynamic store. */
7527 if (left != NULL) *left = s;
7530 debug_printf_indent("|failed to expand: %s\n", string);
7531 debug_printf_indent("%s___error message: %s\n",
7532 expand_string_forcedfail ? "|" : "\\", expand_string_message);
7533 if (expand_string_forcedfail) debug_printf_indent("\\failure was forced\n");
7535 if (resetok_p) *resetok_p = resetok;
7541 /* This is the external function call. Do a quick check for any expansion
7542 metacharacters, and if there are none, just return the input string.
7544 Argument: the string to be expanded
7545 Returns: the expanded string, or NULL if expansion failed; if failure was
7546 due to a lookup deferring, search_find_defer will be TRUE
7550 expand_string(uschar *string)
7552 search_find_defer = FALSE;
7553 malformed_header = FALSE;
7554 return (Ustrpbrk(string, "$\\") == NULL)? string :
7555 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7561 expand_cstring(const uschar *string)
7563 search_find_defer = FALSE;
7564 malformed_header = FALSE;
7565 return (Ustrpbrk(string, "$\\") == NULL)? string :
7566 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7571 /*************************************************
7573 *************************************************/
7575 /* Now and again we want to expand a string and be sure that the result is in a
7576 new bit of store. This function does that.
7577 Since we know it has been copied, the de-const cast is safe.
7579 Argument: the string to be expanded
7580 Returns: the expanded string, always in a new bit of store, or NULL
7584 expand_string_copy(const uschar *string)
7586 const uschar *yield = expand_cstring(string);
7587 if (yield == string) yield = string_copy(string);
7593 /*************************************************
7594 * Expand and interpret as an integer *
7595 *************************************************/
7597 /* Expand a string, and convert the result into an integer.
7600 string the string to be expanded
7601 isplus TRUE if a non-negative number is expected
7603 Returns: the integer value, or
7604 -1 for an expansion error ) in both cases, message in
7605 -2 for an integer interpretation error ) expand_string_message
7606 expand_string_message is set NULL for an OK integer
7610 expand_string_integer(uschar *string, BOOL isplus)
7612 return expanded_string_integer(expand_string(string), isplus);
7616 /*************************************************
7617 * Interpret string as an integer *
7618 *************************************************/
7620 /* Convert a string (that has already been expanded) into an integer.
7622 This function is used inside the expansion code.
7625 s the string to be expanded
7626 isplus TRUE if a non-negative number is expected
7628 Returns: the integer value, or
7629 -1 if string is NULL (which implies an expansion error)
7630 -2 for an integer interpretation error
7631 expand_string_message is set NULL for an OK integer
7634 static int_eximarith_t
7635 expanded_string_integer(const uschar *s, BOOL isplus)
7637 int_eximarith_t value;
7638 uschar *msg = US"invalid integer \"%s\"";
7641 /* If expansion failed, expand_string_message will be set. */
7643 if (s == NULL) return -1;
7645 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7646 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7647 systems, so we set it zero ourselves. */
7650 expand_string_message = NULL; /* Indicates no error */
7652 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7653 equal to 0. Unfortunately, people actually relied upon that, so preserve
7654 the behaviour explicitly. Stripping leading whitespace is a harmless
7655 noop change since strtol skips it anyway (provided that there is a number
7659 while (isspace(*s)) ++s;
7663 debug_printf_indent("treating blank string as number 0\n");
7668 value = strtoll(CS s, CSS &endptr, 10);
7672 msg = US"integer expected but \"%s\" found";
7674 else if (value < 0 && isplus)
7676 msg = US"non-negative integer expected but \"%s\" found";
7680 switch (tolower(*endptr))
7685 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7690 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7691 else value *= 1024*1024;
7695 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7696 else value *= 1024*1024*1024;
7700 if (errno == ERANGE)
7701 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7704 while (isspace(*endptr)) endptr++;
7705 if (*endptr == 0) return value;
7709 expand_string_message = string_sprintf(CS msg, s);
7714 /* These values are usually fixed boolean values, but they are permitted to be
7718 addr address being routed
7719 mtype the module type
7720 mname the module name
7721 dbg_opt debug selectors
7722 oname the option name
7723 bvalue the router's boolean value
7724 svalue the router's string value
7725 rvalue where to put the returned value
7727 Returns: OK value placed in rvalue
7728 DEFER expansion failed
7732 exp_bool(address_item *addr,
7733 uschar *mtype, uschar *mname, unsigned dbg_opt,
7734 uschar *oname, BOOL bvalue,
7735 uschar *svalue, BOOL *rvalue)
7738 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7740 expanded = expand_string(svalue);
7741 if (expanded == NULL)
7743 if (expand_string_forcedfail)
7745 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7749 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7750 oname, mname, mtype, expand_string_message);
7751 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7755 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7758 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7760 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7764 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7765 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7774 /* Avoid potentially exposing a password in a string about to be logged */
7777 expand_hide_passwords(uschar * s)
7779 return ( ( Ustrstr(s, "failed to expand") != NULL
7780 || Ustrstr(s, "expansion of ") != NULL
7782 && ( Ustrstr(s, "mysql") != NULL
7783 || Ustrstr(s, "pgsql") != NULL
7784 || Ustrstr(s, "redis") != NULL
7785 || Ustrstr(s, "sqlite") != NULL
7786 || Ustrstr(s, "ldap:") != NULL
7787 || Ustrstr(s, "ldaps:") != NULL
7788 || Ustrstr(s, "ldapi:") != NULL
7789 || Ustrstr(s, "ldapdn:") != NULL
7790 || Ustrstr(s, "ldapm:") != NULL
7792 ? US"Temporary internal error" : s;
7797 /*************************************************
7798 * Error-checking for testsuite *
7799 *************************************************/
7801 const char * filename;
7803 uschar * region_start;
7804 uschar * region_end;
7805 const uschar *var_name;
7806 const uschar *var_data;
7810 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
7813 if (var_data >= e->region_start && var_data < e->region_end)
7815 e->var_name = CUS var_name;
7816 e->var_data = CUS var_data;
7821 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
7823 err_ctx e = {filename, linenumber, ptr, US ptr + len, NULL };
7827 /* check acl_ variables */
7828 tree_walk(acl_var_c, assert_variable_notin, &e);
7829 tree_walk(acl_var_m, assert_variable_notin, &e);
7831 /* check auth<n> variables */
7832 for (i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
7833 assert_variable_notin(US"auth<n>", auth_vars[i], &e);
7835 /* check regex<n> variables */
7836 for (i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
7837 assert_variable_notin(US"regex<n>", regex_vars[i], &e);
7839 /* check known-name variables */
7840 for (v = var_table; v < var_table + var_table_size; v++)
7841 if (v->type == vtype_stringptr)
7842 assert_variable_notin(US v->name, *(USS v->value), &e);
7845 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
7846 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
7847 e.var_name, e.filename, e.linenumber, e.var_data);
7852 /*************************************************
7853 **************************************************
7854 * Stand-alone test program *
7855 **************************************************
7856 *************************************************/
7862 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7864 int ovector[3*(EXPAND_MAXN+1)];
7865 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7866 ovector, nelem(ovector));
7867 BOOL yield = n >= 0;
7868 if (n == 0) n = EXPAND_MAXN + 1;
7872 expand_nmax = (setup < 0)? 0 : setup + 1;
7873 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7875 expand_nstring[expand_nmax] = subject + ovector[nn];
7876 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7884 int main(int argc, uschar **argv)
7887 uschar buffer[1024];
7889 debug_selector = D_v;
7890 debug_file = stderr;
7891 debug_fd = fileno(debug_file);
7892 big_buffer = malloc(big_buffer_size);
7894 for (i = 1; i < argc; i++)
7896 if (argv[i][0] == '+')
7898 debug_trace_memory = 2;
7901 if (isdigit(argv[i][0]))
7902 debug_selector = Ustrtol(argv[i], NULL, 0);
7904 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7908 eldap_default_servers = argv[i];
7911 mysql_servers = argv[i];
7914 pgsql_servers = argv[i];
7917 redis_servers = argv[i];
7921 else opt_perl_startup = argv[i];
7925 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7927 expand_nstring[1] = US"string 1....";
7928 expand_nlength[1] = 8;
7932 if (opt_perl_startup != NULL)
7935 printf("Starting Perl interpreter\n");
7936 errstr = init_perl(opt_perl_startup);
7939 printf("** error in perl_startup code: %s\n", errstr);
7940 return EXIT_FAILURE;
7943 #endif /* EXIM_PERL */
7945 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7947 void *reset_point = store_get(0);
7948 uschar *yield = expand_string(buffer);
7951 printf("%s\n", yield);
7952 store_reset(reset_point);
7956 if (search_find_defer) printf("search_find deferred\n");
7957 printf("Failed: %s\n", expand_string_message);
7958 if (expand_string_forcedfail) printf("Forced failure\n");
7972 /* End of expand.c */