1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
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. Charaters 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[] = {
242 EOP_ADDRESS = nelem(op_table_underscore),
284 /* Table of condition names, and corresponding switch numbers. The names must
285 be in alphabetical order. */
287 static uschar *cond_table[] = {
291 US"==", /* Backward compatibility */
324 US"match_local_part",
349 ECOND_FIRST_DELIVERY,
370 ECOND_MATCH_LOCAL_PART,
380 /* Types of table entry */
383 vtype_int, /* value is address of int */
384 vtype_filter_int, /* ditto, but recognized only when filtering */
385 vtype_ino, /* value is address of ino_t (not always an int) */
386 vtype_uid, /* value is address of uid_t (not always an int) */
387 vtype_gid, /* value is address of gid_t (not always an int) */
388 vtype_bool, /* value is address of bool */
389 vtype_stringptr, /* value is address of pointer to string */
390 vtype_msgbody, /* as stringptr, but read when first required */
391 vtype_msgbody_end, /* ditto, the end of the message */
392 vtype_msgheaders, /* the message's headers, processed */
393 vtype_msgheaders_raw, /* the message's headers, unprocessed */
394 vtype_localpart, /* extract local part from string */
395 vtype_domain, /* extract domain from string */
396 vtype_string_func, /* value is string returned by given function */
397 vtype_todbsdin, /* value not used; generate BSD inbox tod */
398 vtype_tode, /* value not used; generate tod in epoch format */
399 vtype_todel, /* value not used; generate tod in epoch/usec format */
400 vtype_todf, /* value not used; generate full tod */
401 vtype_todl, /* value not used; generate log tod */
402 vtype_todlf, /* value not used; generate log file datestamp tod */
403 vtype_todzone, /* value not used; generate time zone only */
404 vtype_todzulu, /* value not used; generate zulu tod */
405 vtype_reply, /* value not used; get reply from headers */
406 vtype_pid, /* value not used; result is pid */
407 vtype_host_lookup, /* value not used; get host name */
408 vtype_load_avg, /* value not used; result is int from os_getloadavg */
409 vtype_pspace, /* partition space; value is T/F for spool/log */
410 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
411 vtype_cert /* SSL certificate */
413 ,vtype_dkim /* Lookup of value in DKIM signature */
417 /* Type for main variable table */
425 /* Type for entries pointing to address/length pairs. Not currently
433 static uschar * fn_recipients(void);
435 /* This table must be kept in alphabetical order. */
437 static var_entry var_table[] = {
438 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
439 they will be confused with user-creatable ACL variables. */
440 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
441 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
442 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
443 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
444 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
445 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
446 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
447 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
448 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
449 { "acl_narg", vtype_int, &acl_narg },
450 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
451 { "address_data", vtype_stringptr, &deliver_address_data },
452 { "address_file", vtype_stringptr, &address_file },
453 { "address_pipe", vtype_stringptr, &address_pipe },
454 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
455 { "authenticated_id", vtype_stringptr, &authenticated_id },
456 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
457 { "authentication_failed",vtype_int, &authentication_failed },
458 #ifdef WITH_CONTENT_SCAN
459 { "av_failed", vtype_int, &av_failed },
461 #ifdef EXPERIMENTAL_BRIGHTMAIL
462 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
463 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
464 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
465 { "bmi_deliver", vtype_int, &bmi_deliver },
467 { "body_linecount", vtype_int, &body_linecount },
468 { "body_zerocount", vtype_int, &body_zerocount },
469 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
470 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
471 { "caller_gid", vtype_gid, &real_gid },
472 { "caller_uid", vtype_uid, &real_uid },
473 { "callout_address", vtype_stringptr, &callout_address },
474 { "compile_date", vtype_stringptr, &version_date },
475 { "compile_number", vtype_stringptr, &version_cnumber },
476 { "config_dir", vtype_stringptr, &config_main_directory },
477 { "config_file", vtype_stringptr, &config_main_filename },
478 { "csa_status", vtype_stringptr, &csa_status },
479 #ifdef EXPERIMENTAL_DCC
480 { "dcc_header", vtype_stringptr, &dcc_header },
481 { "dcc_result", vtype_stringptr, &dcc_result },
483 #ifdef WITH_OLD_DEMIME
484 { "demime_errorlevel", vtype_int, &demime_errorlevel },
485 { "demime_reason", vtype_stringptr, &demime_reason },
488 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
489 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
490 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
491 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
492 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
493 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
494 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
495 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
496 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
497 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
498 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
499 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
500 { "dkim_key_length", vtype_int, &dkim_key_length },
501 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
502 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
503 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
504 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
505 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
506 { "dkim_signers", vtype_stringptr, &dkim_signers },
507 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
508 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
510 #ifdef EXPERIMENTAL_DMARC
511 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
512 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
513 { "dmarc_status", vtype_stringptr, &dmarc_status },
514 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
515 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
517 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
518 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
519 { "dnslist_text", vtype_stringptr, &dnslist_text },
520 { "dnslist_value", vtype_stringptr, &dnslist_value },
521 { "domain", vtype_stringptr, &deliver_domain },
522 { "domain_data", vtype_stringptr, &deliver_domain_data },
523 #ifndef DISABLE_EVENT
524 { "event_data", vtype_stringptr, &event_data },
526 /*XXX want to use generic vars for as many of these as possible*/
527 { "event_defer_errno", vtype_int, &event_defer_errno },
529 { "event_name", vtype_stringptr, &event_name },
531 { "exim_gid", vtype_gid, &exim_gid },
532 { "exim_path", vtype_stringptr, &exim_path },
533 { "exim_uid", vtype_uid, &exim_uid },
534 { "exim_version", vtype_stringptr, &version_string },
535 #ifdef WITH_OLD_DEMIME
536 { "found_extension", vtype_stringptr, &found_extension },
538 { "headers_added", vtype_string_func, &fn_hdrs_added },
539 { "home", vtype_stringptr, &deliver_home },
540 { "host", vtype_stringptr, &deliver_host },
541 { "host_address", vtype_stringptr, &deliver_host_address },
542 { "host_data", vtype_stringptr, &host_data },
543 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
544 { "host_lookup_failed", vtype_int, &host_lookup_failed },
545 { "host_port", vtype_int, &deliver_host_port },
546 { "inode", vtype_ino, &deliver_inode },
547 { "interface_address", vtype_stringptr, &interface_address },
548 { "interface_port", vtype_int, &interface_port },
549 { "item", vtype_stringptr, &iterate_item },
551 { "ldap_dn", vtype_stringptr, &eldap_dn },
553 { "load_average", vtype_load_avg, NULL },
554 { "local_part", vtype_stringptr, &deliver_localpart },
555 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
556 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
557 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
558 { "local_scan_data", vtype_stringptr, &local_scan_data },
559 { "local_user_gid", vtype_gid, &local_user_gid },
560 { "local_user_uid", vtype_uid, &local_user_uid },
561 { "localhost_number", vtype_int, &host_number },
562 { "log_inodes", vtype_pinodes, (void *)FALSE },
563 { "log_space", vtype_pspace, (void *)FALSE },
564 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
565 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
566 #ifdef WITH_CONTENT_SCAN
567 { "malware_name", vtype_stringptr, &malware_name },
569 { "max_received_linelength", vtype_int, &max_received_linelength },
570 { "message_age", vtype_int, &message_age },
571 { "message_body", vtype_msgbody, &message_body },
572 { "message_body_end", vtype_msgbody_end, &message_body_end },
573 { "message_body_size", vtype_int, &message_body_size },
574 { "message_exim_id", vtype_stringptr, &message_id },
575 { "message_headers", vtype_msgheaders, NULL },
576 { "message_headers_raw", vtype_msgheaders_raw, NULL },
577 { "message_id", vtype_stringptr, &message_id },
578 { "message_linecount", vtype_int, &message_linecount },
579 { "message_size", vtype_int, &message_size },
581 { "message_smtputf8", vtype_bool, &message_smtputf8 },
583 #ifdef WITH_CONTENT_SCAN
584 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
585 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
586 { "mime_boundary", vtype_stringptr, &mime_boundary },
587 { "mime_charset", vtype_stringptr, &mime_charset },
588 { "mime_content_description", vtype_stringptr, &mime_content_description },
589 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
590 { "mime_content_id", vtype_stringptr, &mime_content_id },
591 { "mime_content_size", vtype_int, &mime_content_size },
592 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
593 { "mime_content_type", vtype_stringptr, &mime_content_type },
594 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
595 { "mime_filename", vtype_stringptr, &mime_filename },
596 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
597 { "mime_is_multipart", vtype_int, &mime_is_multipart },
598 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
599 { "mime_part_count", vtype_int, &mime_part_count },
601 { "n0", vtype_filter_int, &filter_n[0] },
602 { "n1", vtype_filter_int, &filter_n[1] },
603 { "n2", vtype_filter_int, &filter_n[2] },
604 { "n3", vtype_filter_int, &filter_n[3] },
605 { "n4", vtype_filter_int, &filter_n[4] },
606 { "n5", vtype_filter_int, &filter_n[5] },
607 { "n6", vtype_filter_int, &filter_n[6] },
608 { "n7", vtype_filter_int, &filter_n[7] },
609 { "n8", vtype_filter_int, &filter_n[8] },
610 { "n9", vtype_filter_int, &filter_n[9] },
611 { "original_domain", vtype_stringptr, &deliver_domain_orig },
612 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
613 { "originator_gid", vtype_gid, &originator_gid },
614 { "originator_uid", vtype_uid, &originator_uid },
615 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
616 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
617 { "pid", vtype_pid, NULL },
619 { "prdr_requested", vtype_bool, &prdr_requested },
621 { "primary_hostname", vtype_stringptr, &primary_hostname },
622 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
623 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
624 { "proxy_external_port", vtype_int, &proxy_external_port },
625 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
626 { "proxy_local_port", vtype_int, &proxy_local_port },
627 { "proxy_session", vtype_bool, &proxy_session },
629 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
630 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
631 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
632 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
633 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
634 { "rcpt_count", vtype_int, &rcpt_count },
635 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
636 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
637 { "received_count", vtype_int, &received_count },
638 { "received_for", vtype_stringptr, &received_for },
639 { "received_ip_address", vtype_stringptr, &interface_address },
640 { "received_port", vtype_int, &interface_port },
641 { "received_protocol", vtype_stringptr, &received_protocol },
642 { "received_time", vtype_int, &received_time },
643 { "recipient_data", vtype_stringptr, &recipient_data },
644 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
645 { "recipients", vtype_string_func, &fn_recipients },
646 { "recipients_count", vtype_int, &recipients_count },
647 #ifdef WITH_CONTENT_SCAN
648 { "regex_match_string", vtype_stringptr, ®ex_match_string },
650 { "reply_address", vtype_reply, NULL },
651 { "return_path", vtype_stringptr, &return_path },
652 { "return_size_limit", vtype_int, &bounce_return_size_limit },
653 { "router_name", vtype_stringptr, &router_name },
654 { "runrc", vtype_int, &runrc },
655 { "self_hostname", vtype_stringptr, &self_hostname },
656 { "sender_address", vtype_stringptr, &sender_address },
657 { "sender_address_data", vtype_stringptr, &sender_address_data },
658 { "sender_address_domain", vtype_domain, &sender_address },
659 { "sender_address_local_part", vtype_localpart, &sender_address },
660 { "sender_data", vtype_stringptr, &sender_data },
661 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
662 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
663 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
664 { "sender_host_address", vtype_stringptr, &sender_host_address },
665 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
666 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
667 { "sender_host_name", vtype_host_lookup, NULL },
668 { "sender_host_port", vtype_int, &sender_host_port },
669 { "sender_ident", vtype_stringptr, &sender_ident },
670 { "sender_rate", vtype_stringptr, &sender_rate },
671 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
672 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
673 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
674 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
675 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
676 { "sending_port", vtype_int, &sending_port },
677 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
678 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
679 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
680 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
681 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
682 { "sn0", vtype_filter_int, &filter_sn[0] },
683 { "sn1", vtype_filter_int, &filter_sn[1] },
684 { "sn2", vtype_filter_int, &filter_sn[2] },
685 { "sn3", vtype_filter_int, &filter_sn[3] },
686 { "sn4", vtype_filter_int, &filter_sn[4] },
687 { "sn5", vtype_filter_int, &filter_sn[5] },
688 { "sn6", vtype_filter_int, &filter_sn[6] },
689 { "sn7", vtype_filter_int, &filter_sn[7] },
690 { "sn8", vtype_filter_int, &filter_sn[8] },
691 { "sn9", vtype_filter_int, &filter_sn[9] },
692 #ifdef WITH_CONTENT_SCAN
693 { "spam_action", vtype_stringptr, &spam_action },
694 { "spam_bar", vtype_stringptr, &spam_bar },
695 { "spam_report", vtype_stringptr, &spam_report },
696 { "spam_score", vtype_stringptr, &spam_score },
697 { "spam_score_int", vtype_stringptr, &spam_score_int },
699 #ifdef EXPERIMENTAL_SPF
700 { "spf_guess", vtype_stringptr, &spf_guess },
701 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
702 { "spf_received", vtype_stringptr, &spf_received },
703 { "spf_result", vtype_stringptr, &spf_result },
704 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
706 { "spool_directory", vtype_stringptr, &spool_directory },
707 { "spool_inodes", vtype_pinodes, (void *)TRUE },
708 { "spool_space", vtype_pspace, (void *)TRUE },
709 #ifdef EXPERIMENTAL_SRS
710 { "srs_db_address", vtype_stringptr, &srs_db_address },
711 { "srs_db_key", vtype_stringptr, &srs_db_key },
712 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
713 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
714 { "srs_recipient", vtype_stringptr, &srs_recipient },
715 { "srs_status", vtype_stringptr, &srs_status },
717 { "thisaddress", vtype_stringptr, &filter_thisaddress },
719 /* The non-(in,out) variables are now deprecated */
720 { "tls_bits", vtype_int, &tls_in.bits },
721 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
722 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
724 { "tls_in_bits", vtype_int, &tls_in.bits },
725 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
726 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
727 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
728 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
729 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
730 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
731 #if defined(SUPPORT_TLS)
732 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
734 { "tls_out_bits", vtype_int, &tls_out.bits },
735 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
736 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
737 #ifdef EXPERIMENTAL_DANE
738 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
740 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
741 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
742 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
743 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
744 #if defined(SUPPORT_TLS)
745 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
747 #ifdef EXPERIMENTAL_DANE
748 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
751 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
752 #if defined(SUPPORT_TLS)
753 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
756 { "tod_bsdinbox", vtype_todbsdin, NULL },
757 { "tod_epoch", vtype_tode, NULL },
758 { "tod_epoch_l", vtype_todel, NULL },
759 { "tod_full", vtype_todf, NULL },
760 { "tod_log", vtype_todl, NULL },
761 { "tod_logfile", vtype_todlf, NULL },
762 { "tod_zone", vtype_todzone, NULL },
763 { "tod_zulu", vtype_todzulu, NULL },
764 { "transport_name", vtype_stringptr, &transport_name },
765 { "value", vtype_stringptr, &lookup_value },
766 { "verify_mode", vtype_stringptr, &verify_mode },
767 { "version_number", vtype_stringptr, &version_string },
768 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
769 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
770 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
771 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
772 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
773 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
776 static int var_table_size = nelem(var_table);
777 static uschar var_buffer[256];
778 static BOOL malformed_header;
780 /* For textual hashes */
782 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
783 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
786 enum { HMAC_MD5, HMAC_SHA1 };
788 /* For numeric hashes */
790 static unsigned int prime[] = {
791 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
792 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
793 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
795 /* For printing modes in symbolic form */
797 static uschar *mtable_normal[] =
798 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
800 static uschar *mtable_setid[] =
801 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
803 static uschar *mtable_sticky[] =
804 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
808 /*************************************************
809 * Tables for UTF-8 support *
810 *************************************************/
812 /* Table of the number of extra characters, indexed by the first character
813 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
816 static uschar utf8_table1[] = {
817 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
818 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
819 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
820 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
822 /* These are the masks for the data bits in the first byte of a character,
823 indexed by the number of additional bytes. */
825 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
827 /* Get the next UTF-8 character, advancing the pointer. */
829 #define GETUTF8INC(c, ptr) \
831 if ((c & 0xc0) == 0xc0) \
833 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
835 c = (c & utf8_table2[a]) << s; \
839 c |= (*ptr++ & 0x3f) << s; \
844 /*************************************************
845 * Binary chop search on a table *
846 *************************************************/
848 /* This is used for matching expansion items and operators.
851 name the name that is being sought
852 table the table to search
853 table_size the number of items in the table
855 Returns: the offset in the table, or -1
859 chop_match(uschar *name, uschar **table, int table_size)
861 uschar **bot = table;
862 uschar **top = table + table_size;
866 uschar **mid = bot + (top - bot)/2;
867 int c = Ustrcmp(name, *mid);
868 if (c == 0) return mid - table;
869 if (c > 0) bot = mid + 1; else top = mid;
877 /*************************************************
878 * Check a condition string *
879 *************************************************/
881 /* This function is called to expand a string, and test the result for a "true"
882 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
883 forced fail or lookup defer.
885 We used to release all store used, but this is not not safe due
886 to ${dlfunc } and ${acl }. In any case expand_string_internal()
887 is reasonably careful to release what it can.
889 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
892 condition the condition string
893 m1 text to be incorporated in panic error
896 Returns: TRUE if condition is met, FALSE if not
900 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
903 uschar *ss = expand_string(condition);
906 if (!expand_string_forcedfail && !search_find_defer)
907 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
908 "for %s %s: %s", condition, m1, m2, expand_string_message);
911 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
912 strcmpic(ss, US"false") != 0;
919 /*************************************************
920 * Pseudo-random number generation *
921 *************************************************/
923 /* Pseudo-random number generation. The result is not "expected" to be
924 cryptographically strong but not so weak that someone will shoot themselves
925 in the foot using it as a nonce in some email header scheme or whatever
926 weirdness they'll twist this into. The result should ideally handle fork().
928 However, if we're stuck unable to provide this, then we'll fall back to
929 appallingly bad randomness.
931 If SUPPORT_TLS is defined then this will not be used except as an emergency
936 Returns a random number in range [0, max-1]
940 # define vaguely_random_number vaguely_random_number_fallback
943 vaguely_random_number(int max)
946 # undef vaguely_random_number
948 static pid_t pid = 0;
950 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
960 #ifdef HAVE_ARC4RANDOM
961 /* cryptographically strong randomness, common on *BSD platforms, not
962 so much elsewhere. Alas. */
963 #ifndef NOT_HAVE_ARC4RANDOM_STIR
966 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
967 #ifdef HAVE_SRANDOMDEV
968 /* uses random(4) for seeding */
971 gettimeofday(&tv, NULL);
972 srandom(tv.tv_sec | tv.tv_usec | getpid());
975 /* Poor randomness and no seeding here */
982 #ifdef HAVE_ARC4RANDOM
983 return arc4random() % max;
984 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
985 return random() % max;
987 /* This one returns a 16-bit number, definitely not crypto-strong */
988 return random_number(max);
995 /*************************************************
996 * Pick out a name from a string *
997 *************************************************/
999 /* If the name is too long, it is silently truncated.
1002 name points to a buffer into which to put the name
1003 max is the length of the buffer
1004 s points to the first alphabetic character of the name
1005 extras chars other than alphanumerics to permit
1007 Returns: pointer to the first character after the name
1009 Note: The test for *s != 0 in the while loop is necessary because
1010 Ustrchr() yields non-NULL if the character is zero (which is not something
1013 static const uschar *
1014 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1017 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1019 if (ptr < max-1) name[ptr++] = *s;
1028 /*************************************************
1029 * Pick out the rest of a header name *
1030 *************************************************/
1032 /* A variable name starting $header_ (or just $h_ for those who like
1033 abbreviations) might not be the complete header name because headers can
1034 contain any printing characters in their names, except ':'. This function is
1035 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1036 on the end, if the name was terminated by white space.
1039 name points to a buffer in which the name read so far exists
1040 max is the length of the buffer
1041 s points to the first character after the name so far, i.e. the
1042 first non-alphameric character after $header_xxxxx
1044 Returns: a pointer to the first character after the header name
1047 static const uschar *
1048 read_header_name(uschar *name, int max, const uschar *s)
1050 int prelen = Ustrchr(name, '_') - name + 1;
1051 int ptr = Ustrlen(name) - prelen;
1052 if (ptr > 0) memmove(name, name+prelen, ptr);
1053 while (mac_isgraph(*s) && *s != ':')
1055 if (ptr < max-1) name[ptr++] = *s;
1066 /*************************************************
1067 * Pick out a number from a string *
1068 *************************************************/
1071 n points to an integer into which to put the number
1072 s points to the first digit of the number
1074 Returns: a pointer to the character after the last digit
1078 read_number(int *n, uschar *s)
1081 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1085 static const uschar *
1086 read_cnumber(int *n, const uschar *s)
1089 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1095 /*************************************************
1096 * Extract keyed subfield from a string *
1097 *************************************************/
1099 /* The yield is in dynamic store; NULL means that the key was not found.
1102 key points to the name of the key
1103 s points to the string from which to extract the subfield
1105 Returns: NULL if the subfield was not found, or
1106 a pointer to the subfield's data
1110 expand_getkeyed(uschar *key, const uschar *s)
1112 int length = Ustrlen(key);
1113 while (isspace(*s)) s++;
1115 /* Loop to search for the key */
1121 const uschar *dkey = s;
1123 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1124 dkeylength = s - dkey;
1125 while (isspace(*s)) s++;
1126 if (*s == '=') while (isspace((*(++s))));
1128 data = string_dequote(&s);
1129 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1132 while (isspace(*s)) s++;
1141 find_var_ent(uschar * name)
1144 int last = var_table_size;
1146 while (last > first)
1148 int middle = (first + last)/2;
1149 int c = Ustrcmp(name, var_table[middle].name);
1151 if (c > 0) { first = middle + 1; continue; }
1152 if (c < 0) { last = middle; continue; }
1153 return &var_table[middle];
1158 /*************************************************
1159 * Extract numbered subfield from string *
1160 *************************************************/
1162 /* Extracts a numbered field from a string that is divided by tokens - for
1163 example a line from /etc/passwd is divided by colon characters. First field is
1164 numbered one. Negative arguments count from the right. Zero returns the whole
1165 string. Returns NULL if there are insufficient tokens in the string
1168 Modifies final argument - this is a dynamically generated string, so that's OK.
1171 field number of field to be extracted,
1172 first field = 1, whole string = 0, last field = -1
1173 separators characters that are used to break string into tokens
1174 s points to the string from which to extract the subfield
1176 Returns: NULL if the field was not found,
1177 a pointer to the field's data inside s (modified to add 0)
1181 expand_gettokened (int field, uschar *separators, uschar *s)
1186 uschar *fieldtext = NULL;
1188 if (field == 0) return s;
1190 /* Break the line up into fields in place; for field > 0 we stop when we have
1191 done the number of fields we want. For field < 0 we continue till the end of
1192 the string, counting the number of fields. */
1194 count = (field > 0)? field : INT_MAX;
1200 /* Previous field was the last one in the string. For a positive field
1201 number, this means there are not enough fields. For a negative field number,
1202 check that there are enough, and scan back to find the one that is wanted. */
1206 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1207 if ((-field) == (INT_MAX - count - 1)) return s;
1211 while (ss[-1] != 0) ss--;
1217 /* Previous field was not last in the string; save its start and put a
1221 len = Ustrcspn(ss, separators);
1232 expand_getlistele(int field, const uschar * list)
1234 const uschar * tlist= list;
1240 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1243 if(field==0) return NULL;
1244 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1245 return string_nextinlist(&list, &sep, NULL, 0);
1249 /* Certificate fields, by name. Worry about by-OID later */
1250 /* Names are chosen to not have common prefixes */
1257 uschar * (*getfn)(void * cert, uschar * mod);
1259 static certfield certfields[] =
1260 { /* linear search; no special order */
1261 { US"version", 7, &tls_cert_version },
1262 { US"serial_number", 13, &tls_cert_serial_number },
1263 { US"subject", 7, &tls_cert_subject },
1264 { US"notbefore", 9, &tls_cert_not_before },
1265 { US"notafter", 8, &tls_cert_not_after },
1266 { US"issuer", 6, &tls_cert_issuer },
1267 { US"signature", 9, &tls_cert_signature },
1268 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1269 { US"subj_altname", 12, &tls_cert_subject_altname },
1270 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1271 { US"crl_uri", 7, &tls_cert_crl_uri },
1275 expand_getcertele(uschar * field, uschar * certvar)
1280 if (!(vp = find_var_ent(certvar)))
1282 expand_string_message =
1283 string_sprintf("no variable named \"%s\"", certvar);
1284 return NULL; /* Unknown variable name */
1286 /* NB this stops us passing certs around in variable. Might
1287 want to do that in future */
1288 if (vp->type != vtype_cert)
1290 expand_string_message =
1291 string_sprintf("\"%s\" is not a certificate", certvar);
1292 return NULL; /* Unknown variable name */
1294 if (!*(void **)vp->value)
1297 if (*field >= '0' && *field <= '9')
1298 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1300 for(cp = certfields;
1301 cp < certfields + nelem(certfields);
1303 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1305 uschar * modifier = *(field += cp->namelen) == ','
1307 return (*cp->getfn)( *(void **)vp->value, modifier );
1310 expand_string_message =
1311 string_sprintf("bad field selector \"%s\" for certextract", field);
1314 #endif /*SUPPORT_TLS*/
1316 /*************************************************
1317 * Extract a substring from a string *
1318 *************************************************/
1320 /* Perform the ${substr or ${length expansion operations.
1323 subject the input string
1324 value1 the offset from the start of the input string to the start of
1325 the output string; if negative, count from the right.
1326 value2 the length of the output string, or negative (-1) for unset
1327 if value1 is positive, unset means "all after"
1328 if value1 is negative, unset means "all before"
1329 len set to the length of the returned string
1331 Returns: pointer to the output string, or NULL if there is an error
1335 extract_substr(uschar *subject, int value1, int value2, int *len)
1337 int sublen = Ustrlen(subject);
1339 if (value1 < 0) /* count from right */
1343 /* If the position is before the start, skip to the start, and adjust the
1344 length. If the length ends up negative, the substring is null because nothing
1345 can precede. This falls out naturally when the length is unset, meaning "all
1351 if (value2 < 0) value2 = 0;
1355 /* Otherwise an unset length => characters before value1 */
1357 else if (value2 < 0)
1364 /* For a non-negative offset, if the starting position is past the end of the
1365 string, the result will be the null string. Otherwise, an unset length means
1366 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1370 if (value1 > sublen)
1375 else if (value2 < 0) value2 = sublen;
1378 /* Cut the length down to the maximum possible for the offset value, and get
1379 the required characters. */
1381 if (value1 + value2 > sublen) value2 = sublen - value1;
1383 return subject + value1;
1389 /*************************************************
1390 * Old-style hash of a string *
1391 *************************************************/
1393 /* Perform the ${hash expansion operation.
1396 subject the input string (an expanded substring)
1397 value1 the length of the output string; if greater or equal to the
1398 length of the input string, the input string is returned
1399 value2 the number of hash characters to use, or 26 if negative
1400 len set to the length of the returned string
1402 Returns: pointer to the output string, or NULL if there is an error
1406 compute_hash(uschar *subject, int value1, int value2, int *len)
1408 int sublen = Ustrlen(subject);
1410 if (value2 < 0) value2 = 26;
1411 else if (value2 > Ustrlen(hashcodes))
1413 expand_string_message =
1414 string_sprintf("hash count \"%d\" too big", value2);
1418 /* Calculate the hash text. We know it is shorter than the original string, so
1419 can safely place it in subject[] (we know that subject is always itself an
1420 expanded substring). */
1422 if (value1 < sublen)
1427 while ((c = (subject[j])) != 0)
1429 int shift = (c + j++) & 7;
1430 subject[i] ^= (c << shift) | (c >> (8-shift));
1431 if (++i >= value1) i = 0;
1433 for (i = 0; i < value1; i++)
1434 subject[i] = hashcodes[(subject[i]) % value2];
1436 else value1 = sublen;
1445 /*************************************************
1446 * Numeric hash of a string *
1447 *************************************************/
1449 /* Perform the ${nhash expansion operation. The first characters of the
1450 string are treated as most important, and get the highest prime numbers.
1453 subject the input string
1454 value1 the maximum value of the first part of the result
1455 value2 the maximum value of the second part of the result,
1456 or negative to produce only a one-part result
1457 len set to the length of the returned string
1459 Returns: pointer to the output string, or NULL if there is an error.
1463 compute_nhash (uschar *subject, int value1, int value2, int *len)
1465 uschar *s = subject;
1467 unsigned long int total = 0; /* no overflow */
1471 if (i == 0) i = nelem(prime) - 1;
1472 total += prime[i--] * (unsigned int)(*s++);
1475 /* If value2 is unset, just compute one number */
1479 s = string_sprintf("%d", total % value1);
1482 /* Otherwise do a div/mod hash */
1486 total = total % (value1 * value2);
1487 s = string_sprintf("%d/%d", total/value2, total % value2);
1498 /*************************************************
1499 * Find the value of a header or headers *
1500 *************************************************/
1502 /* Multiple instances of the same header get concatenated, and this function
1503 can also return a concatenation of all the header lines. When concatenating
1504 specific headers that contain lists of addresses, a comma is inserted between
1505 them. Otherwise we use a straight concatenation. Because some messages can have
1506 pathologically large number of lines, there is a limit on the length that is
1507 returned. Also, to avoid massive store use which would result from using
1508 string_cat() as it copies and extends strings, we do a preliminary pass to find
1509 out exactly how much store will be needed. On "normal" messages this will be
1513 name the name of the header, without the leading $header_ or $h_,
1514 or NULL if a concatenation of all headers is required
1515 exists_only TRUE if called from a def: test; don't need to build a string;
1516 just return a string that is not "" and not "0" if the header
1518 newsize return the size of memory block that was obtained; may be NULL
1519 if exists_only is TRUE
1520 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1521 other than concatenating, will be done on the header. Also used
1522 for $message_headers_raw.
1523 charset name of charset to translate MIME words to; used only if
1524 want_raw is false; if NULL, no translation is done (this is
1525 used for $bh_ and $bheader_)
1527 Returns: NULL if the header does not exist, else a pointer to a new
1532 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1535 BOOL found = name == NULL;
1537 int len = found? 0 : Ustrlen(name);
1539 uschar *yield = NULL;
1542 /* Loop for two passes - saves code repetition */
1544 for (i = 0; i < 2; i++)
1549 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1551 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1553 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1558 if (exists_only) return US"1"; /* don't need actual string */
1560 t = h->text + len; /* text to insert */
1561 if (!want_raw) /* unless wanted raw, */
1562 while (isspace(*t)) t++; /* remove leading white space */
1563 ilen = h->slen - (t - h->text); /* length to insert */
1565 /* Unless wanted raw, remove trailing whitespace, including the
1569 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1571 /* Set comma = 1 if handling a single header and it's one of those
1572 that contains an address list, except when asked for raw headers. Only
1573 need to do this once. */
1575 if (!want_raw && name != NULL && comma == 0 &&
1576 Ustrchr("BCFRST", h->type) != NULL)
1579 /* First pass - compute total store needed; second pass - compute
1580 total store used, including this header. */
1582 size += ilen + comma + 1; /* +1 for the newline */
1584 /* Second pass - concatentate the data, up to a maximum. Note that
1585 the loop stops when size hits the limit. */
1589 if (size > header_insert_maxlen)
1591 ilen -= size - header_insert_maxlen - 1;
1594 Ustrncpy(ptr, t, ilen);
1597 /* For a non-raw header, put in the comma if needed, then add
1598 back the newline we removed above, provided there was some text in
1601 if (!want_raw && ilen > 0)
1603 if (comma != 0) *ptr++ = ',';
1611 /* At end of first pass, return NULL if no header found. Then truncate size
1612 if necessary, and get the buffer to hold the data, returning the buffer size.
1617 if (!found) return NULL;
1618 if (size > header_insert_maxlen) size = header_insert_maxlen;
1619 *newsize = size + 1;
1620 ptr = yield = store_get(*newsize);
1624 /* That's all we do for raw header expansion. */
1631 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1632 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1633 function can return an error with decoded data if the charset translation
1634 fails. If decoding fails, it returns NULL. */
1638 uschar *decoded, *error;
1639 if (ptr > yield && ptr[-1] == '\n') ptr--;
1640 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1642 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1646 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1647 " input was: %s\n", error, yield);
1649 if (decoded != NULL) yield = decoded;
1658 /*************************************************
1659 * Return list of recipients *
1660 *************************************************/
1661 /* A recipients list is available only during system message filtering,
1662 during ACL processing after DATA, and while expanding pipe commands
1663 generated from a system filter, but not elsewhere. */
1668 if (!enable_dollar_recipients) return NULL; else
1673 uschar * s = store_get(size);
1674 for (i = 0; i < recipients_count; i++)
1676 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1677 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1678 Ustrlen(recipients_list[i].address));
1680 s[ptr] = 0; /* string_cat() leaves room */
1686 /*************************************************
1687 * Find value of a variable *
1688 *************************************************/
1690 /* The table of variables is kept in alphabetic order, so we can search it
1691 using a binary chop. The "choplen" variable is nothing to do with the binary
1695 name the name of the variable being sought
1696 exists_only TRUE if this is a def: test; passed on to find_header()
1697 skipping TRUE => skip any processing evaluation; this is not the same as
1698 exists_only because def: may test for values that are first
1700 newsize pointer to an int which is initially zero; if the answer is in
1701 a new memory buffer, *newsize is set to its size
1703 Returns: NULL if the variable does not exist, or
1704 a pointer to the variable's contents, or
1705 something non-NULL if exists_only is TRUE
1709 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1716 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1717 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1718 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1719 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1720 (this gave backwards compatibility at the changeover). There may be built-in
1721 variables whose names start acl_ but they should never start in this way. This
1722 slightly messy specification is a consequence of the history, needless to say.
1724 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1725 set, in which case give an error. */
1727 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1731 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1732 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1735 /* Handle $auth<n> variables. */
1737 if (Ustrncmp(name, "auth", 4) == 0)
1740 int n = Ustrtoul(name + 4, &endptr, 10);
1741 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1742 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1744 else if (Ustrncmp(name, "regex", 5) == 0)
1747 int n = Ustrtoul(name + 5, &endptr, 10);
1748 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1749 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1752 /* For all other variables, search the table */
1754 if (!(vp = find_var_ent(name)))
1755 return NULL; /* Unknown variable name */
1757 /* Found an existing variable. If in skipping state, the value isn't needed,
1758 and we want to avoid processing (such as looking up the host name). */
1766 case vtype_filter_int:
1767 if (!filter_running) return NULL;
1771 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1775 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1779 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1783 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1787 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1790 case vtype_stringptr: /* Pointer to string */
1791 return (s = *((uschar **)(val))) ? s : US"";
1794 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1797 case vtype_load_avg:
1798 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1801 case vtype_host_lookup: /* Lookup if not done so */
1802 if (sender_host_name == NULL && sender_host_address != NULL &&
1803 !host_lookup_failed && host_name_lookup() == OK)
1804 host_build_sender_fullhost();
1805 return (sender_host_name == NULL)? US"" : sender_host_name;
1807 case vtype_localpart: /* Get local part from address */
1808 s = *((uschar **)(val));
1809 if (s == NULL) return US"";
1810 domain = Ustrrchr(s, '@');
1811 if (domain == NULL) return s;
1812 if (domain - s > sizeof(var_buffer) - 1)
1813 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1814 " in string expansion", sizeof(var_buffer));
1815 Ustrncpy(var_buffer, s, domain - s);
1816 var_buffer[domain - s] = 0;
1819 case vtype_domain: /* Get domain from address */
1820 s = *((uschar **)(val));
1821 if (s == NULL) return US"";
1822 domain = Ustrrchr(s, '@');
1823 return (domain == NULL)? US"" : domain + 1;
1825 case vtype_msgheaders:
1826 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1828 case vtype_msgheaders_raw:
1829 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1831 case vtype_msgbody: /* Pointer to msgbody string */
1832 case vtype_msgbody_end: /* Ditto, the end of the msg */
1833 ss = (uschar **)(val);
1834 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1837 off_t start_offset = SPOOL_DATA_START_OFFSET;
1838 int len = message_body_visible;
1839 if (len > message_size) len = message_size;
1840 *ss = body = store_malloc(len+1);
1842 if (vp->type == vtype_msgbody_end)
1844 struct stat statbuf;
1845 if (fstat(deliver_datafile, &statbuf) == 0)
1847 start_offset = statbuf.st_size - len;
1848 if (start_offset < SPOOL_DATA_START_OFFSET)
1849 start_offset = SPOOL_DATA_START_OFFSET;
1852 lseek(deliver_datafile, start_offset, SEEK_SET);
1853 len = read(deliver_datafile, body, len);
1857 if (message_body_newlines) /* Separate loops for efficiency */
1859 { if (body[--len] == 0) body[len] = ' '; }
1862 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1865 return (*ss == NULL)? US"" : *ss;
1867 case vtype_todbsdin: /* BSD inbox time of day */
1868 return tod_stamp(tod_bsdin);
1870 case vtype_tode: /* Unix epoch time of day */
1871 return tod_stamp(tod_epoch);
1873 case vtype_todel: /* Unix epoch/usec time of day */
1874 return tod_stamp(tod_epoch_l);
1876 case vtype_todf: /* Full time of day */
1877 return tod_stamp(tod_full);
1879 case vtype_todl: /* Log format time of day */
1880 return tod_stamp(tod_log_bare); /* (without timezone) */
1882 case vtype_todzone: /* Time zone offset only */
1883 return tod_stamp(tod_zone);
1885 case vtype_todzulu: /* Zulu time */
1886 return tod_stamp(tod_zulu);
1888 case vtype_todlf: /* Log file datestamp tod */
1889 return tod_stamp(tod_log_datestamp_daily);
1891 case vtype_reply: /* Get reply address */
1892 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1894 if (s != NULL) while (isspace(*s)) s++;
1895 if (s == NULL || *s == 0)
1897 *newsize = 0; /* For the *s==0 case */
1898 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1903 while (isspace(*s)) s++;
1904 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1905 while (t > s && isspace(t[-1])) t--;
1908 return (s == NULL)? US"" : s;
1910 case vtype_string_func:
1912 uschar * (*fn)() = val;
1919 sprintf(CS var_buffer, "%d",
1920 receive_statvfs(val == (void *)TRUE, &inodes));
1927 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1928 sprintf(CS var_buffer, "%d", inodes);
1933 return *(void **)val ? US"<cert>" : US"";
1935 #ifndef DISABLE_DKIM
1937 return dkim_exim_expand_query((int)(long)val);
1942 return NULL; /* Unknown variable. Silences static checkers. */
1949 modify_variable(uschar *name, void * value)
1952 if ((vp = find_var_ent(name))) vp->value = value;
1953 return; /* Unknown variable name, fail silently */
1960 /*************************************************
1961 * Read and expand substrings *
1962 *************************************************/
1964 /* This function is called to read and expand argument substrings for various
1965 expansion items. Some have a minimum requirement that is less than the maximum;
1966 in these cases, the first non-present one is set to NULL.
1969 sub points to vector of pointers to set
1970 n maximum number of substrings
1972 sptr points to current string pointer
1973 skipping the skipping flag
1974 check_end if TRUE, check for final '}'
1975 name name of item, for error message
1976 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1979 Returns: 0 OK; string pointer updated
1980 1 curly bracketing error (too few arguments)
1981 2 too many arguments (only if check_end is set); message set
1982 3 other error (expansion failure)
1986 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1987 BOOL check_end, uschar *name, BOOL *resetok)
1990 const uschar *s = *sptr;
1992 while (isspace(*s)) s++;
1993 for (i = 0; i < n; i++)
1997 if (i < m) return 1;
2001 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
2002 if (sub[i] == NULL) return 3;
2003 if (*s++ != '}') return 1;
2004 while (isspace(*s)) s++;
2006 if (check_end && *s++ != '}')
2010 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
2011 "(max is %d)", name, n);
2024 /*************************************************
2025 * Elaborate message for bad variable *
2026 *************************************************/
2028 /* For the "unknown variable" message, take a look at the variable's name, and
2029 give additional information about possible ACL variables. The extra information
2030 is added on to expand_string_message.
2032 Argument: the name of the variable
2037 check_variable_error_message(uschar *name)
2039 if (Ustrncmp(name, "acl_", 4) == 0)
2040 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2041 (name[4] == 'c' || name[4] == 'm')?
2043 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2044 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2046 US"user-defined ACL variables must start acl_c or acl_m");
2052 Load args from sub array to globals, and call acl_check().
2053 Sub array will be corrupted on return.
2055 Returns: OK access is granted by an ACCEPT verb
2056 DISCARD access is granted by a DISCARD verb
2057 FAIL access is denied
2058 FAIL_DROP access is denied; drop the connection
2059 DEFER can't tell at the moment
2063 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2066 int sav_narg = acl_narg;
2068 uschar * dummy_logmsg;
2069 extern int acl_where;
2071 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2072 for (i = 0; i < nsub && sub[i+1]; i++)
2074 uschar * tmp = acl_arg[i];
2075 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2076 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2081 sub[i+1] = acl_arg[i];
2082 acl_arg[i++] = NULL;
2086 debug_printf("expanding: acl: %s arg: %s%s\n",
2088 acl_narg>0 ? acl_arg[0] : US"<none>",
2089 acl_narg>1 ? " +more" : "");
2091 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2093 for (i = 0; i < nsub; i++)
2094 acl_arg[i] = sub[i+1]; /* restore old args */
2095 acl_narg = sav_narg;
2103 /*************************************************
2104 * Read and evaluate a condition *
2105 *************************************************/
2109 s points to the start of the condition text
2110 resetok points to a BOOL which is written false if it is unsafe to
2111 free memory. Certain condition types (acl) may have side-effect
2112 allocation which must be preserved.
2113 yield points to a BOOL to hold the result of the condition test;
2114 if NULL, we are just reading through a condition that is
2115 part of an "or" combination to check syntax, or in a state
2116 where the answer isn't required
2118 Returns: a pointer to the first character after the condition, or
2122 static const uschar *
2123 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2125 BOOL testfor = TRUE;
2126 BOOL tempcond, combined_cond;
2128 BOOL sub2_honour_dollar = TRUE;
2129 int i, rc, cond_type, roffset;
2130 int_eximarith_t num[2];
2131 struct stat statbuf;
2133 const uschar *sub[10];
2136 const uschar *rerror;
2140 while (isspace(*s)) s++;
2141 if (*s == '!') { testfor = !testfor; s++; } else break;
2144 /* Numeric comparisons are symbolic */
2146 if (*s == '=' || *s == '>' || *s == '<')
2158 /* All other conditions are named */
2160 else s = read_name(name, 256, s, US"_");
2162 /* If we haven't read a name, it means some non-alpha character is first. */
2166 expand_string_message = string_sprintf("condition name expected, "
2167 "but found \"%.16s\"", s);
2171 /* Find which condition we are dealing with, and switch on it */
2173 cond_type = chop_match(name, cond_table, nelem(cond_table));
2176 /* def: tests for a non-empty variable, or for the existence of a header. If
2177 yield == NULL we are in a skipping state, and don't care about the answer. */
2182 expand_string_message = US"\":\" expected after \"def\"";
2186 s = read_name(name, 256, s+1, US"_");
2188 /* Test for a header's existence. If the name contains a closing brace
2189 character, this may be a user error where the terminating colon has been
2190 omitted. Set a flag to adjust a subsequent error message in this case. */
2192 if (Ustrncmp(name, "h_", 2) == 0 ||
2193 Ustrncmp(name, "rh_", 3) == 0 ||
2194 Ustrncmp(name, "bh_", 3) == 0 ||
2195 Ustrncmp(name, "header_", 7) == 0 ||
2196 Ustrncmp(name, "rheader_", 8) == 0 ||
2197 Ustrncmp(name, "bheader_", 8) == 0)
2199 s = read_header_name(name, 256, s);
2200 /* {-for-text-editors */
2201 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2202 if (yield != NULL) *yield =
2203 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2206 /* Test for a variable's having a non-empty value. A non-existent variable
2207 causes an expansion failure. */
2211 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2214 expand_string_message = (name[0] == 0)?
2215 string_sprintf("variable name omitted after \"def:\"") :
2216 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2217 check_variable_error_message(name);
2220 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2226 /* first_delivery tests for first delivery attempt */
2228 case ECOND_FIRST_DELIVERY:
2229 if (yield != NULL) *yield = deliver_firsttime == testfor;
2233 /* queue_running tests for any process started by a queue runner */
2235 case ECOND_QUEUE_RUNNING:
2236 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2240 /* exists: tests for file existence
2241 isip: tests for any IP address
2242 isip4: tests for an IPv4 address
2243 isip6: tests for an IPv6 address
2244 pam: does PAM authentication
2245 radius: does RADIUS authentication
2246 ldapauth: does LDAP authentication
2247 pwcheck: does Cyrus SASL pwcheck authentication
2256 case ECOND_LDAPAUTH:
2259 while (isspace(*s)) s++;
2260 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2262 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2263 if (sub[0] == NULL) return NULL;
2264 /* {-for-text-editors */
2265 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2267 if (yield == NULL) return s; /* No need to run the test if skipping */
2272 if ((expand_forbid & RDO_EXISTS) != 0)
2274 expand_string_message = US"File existence tests are not permitted";
2277 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2283 rc = string_is_ip_address(sub[0], NULL);
2284 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2285 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2288 /* Various authentication tests - all optionally compiled */
2292 rc = auth_call_pam(sub[0], &expand_string_message);
2295 goto COND_FAILED_NOT_COMPILED;
2296 #endif /* SUPPORT_PAM */
2299 #ifdef RADIUS_CONFIG_FILE
2300 rc = auth_call_radius(sub[0], &expand_string_message);
2303 goto COND_FAILED_NOT_COMPILED;
2304 #endif /* RADIUS_CONFIG_FILE */
2306 case ECOND_LDAPAUTH:
2309 /* Just to keep the interface the same */
2311 int old_pool = store_pool;
2312 store_pool = POOL_SEARCH;
2313 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2314 &expand_string_message, &do_cache);
2315 store_pool = old_pool;
2319 goto COND_FAILED_NOT_COMPILED;
2320 #endif /* LOOKUP_LDAP */
2323 #ifdef CYRUS_PWCHECK_SOCKET
2324 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2327 goto COND_FAILED_NOT_COMPILED;
2328 #endif /* CYRUS_PWCHECK_SOCKET */
2330 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2331 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2333 if (rc == ERROR || rc == DEFER) return NULL;
2334 *yield = (rc == OK) == testfor;
2340 /* call ACL (in a conditional context). Accept true, deny false.
2341 Defer is a forced-fail. Anything set by message= goes to $value.
2342 Up to ten parameters are used; we use the braces round the name+args
2343 like the saslauthd condition does, to permit a variable number of args.
2344 See also the expansion-item version EITEM_ACL and the traditional
2345 acl modifier ACLC_ACL.
2346 Since the ACL may allocate new global variables, tell our caller to not
2351 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2359 while (isspace(*s)) s++;
2360 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2362 switch(read_subs(sub, nelem(sub), 1,
2363 &s, yield == NULL, TRUE, US"acl", resetok))
2365 case 1: expand_string_message = US"too few arguments or bracketing "
2368 case 3: return NULL;
2372 if (yield != NULL) switch(eval_acl(sub, nelem(sub), &user_msg))
2377 lookup_value = NULL;
2380 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2381 lookup_value[ptr] = '\0';
2383 *yield = cond == testfor;
2387 expand_string_forcedfail = TRUE;
2389 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2396 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2398 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2400 However, the last two are optional. That is why the whole set is enclosed
2401 in their own set of braces. */
2403 case ECOND_SASLAUTHD:
2404 #ifndef CYRUS_SASLAUTHD_SOCKET
2405 goto COND_FAILED_NOT_COMPILED;
2409 while (isspace(*s)) s++;
2410 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2411 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2414 case 1: expand_string_message = US"too few arguments or bracketing "
2415 "error for saslauthd";
2417 case 3: return NULL;
2419 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2422 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2423 &expand_string_message);
2424 if (rc == ERROR || rc == DEFER) return NULL;
2425 *yield = (rc == OK) == testfor;
2429 #endif /* CYRUS_SASLAUTHD_SOCKET */
2432 /* symbolic operators for numeric and string comparison, and a number of
2433 other operators, all requiring two arguments.
2435 crypteq: encrypts plaintext and compares against an encrypted text,
2436 using crypt(), crypt16(), MD5 or SHA-1
2437 inlist/inlisti: checks if first argument is in the list of the second
2438 match: does a regular expression match and sets up the numerical
2439 variables if it succeeds
2440 match_address: matches in an address list
2441 match_domain: matches in a domain list
2442 match_ip: matches a host list that is restricted to IP addresses
2443 match_local_part: matches in a local part list
2446 case ECOND_MATCH_ADDRESS:
2447 case ECOND_MATCH_DOMAIN:
2448 case ECOND_MATCH_IP:
2449 case ECOND_MATCH_LOCAL_PART:
2450 #ifndef EXPAND_LISTMATCH_RHS
2451 sub2_honour_dollar = FALSE;
2460 case ECOND_NUM_L: /* Numerical comparisons */
2467 case ECOND_STR_LT: /* String comparisons */
2478 for (i = 0; i < 2; i++)
2480 /* Sometimes, we don't expand substrings; too many insecure configurations
2481 created using match_address{}{} and friends, where the second param
2482 includes information from untrustworthy sources. */
2483 BOOL honour_dollar = TRUE;
2484 if ((i > 0) && !sub2_honour_dollar)
2485 honour_dollar = FALSE;
2487 while (isspace(*s)) s++;
2490 if (i == 0) goto COND_FAILED_CURLY_START;
2491 expand_string_message = string_sprintf("missing 2nd string in {} "
2492 "after \"%s\"", name);
2495 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2496 honour_dollar, resetok);
2497 if (sub[i] == NULL) return NULL;
2498 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2500 /* Convert to numerical if required; we know that the names of all the
2501 conditions that compare numbers do not start with a letter. This just saves
2502 checking for them individually. */
2504 if (!isalpha(name[0]) && yield != NULL)
2510 debug_printf("empty string cast to zero for numerical comparison\n");
2514 num[i] = expanded_string_integer(sub[i], FALSE);
2515 if (expand_string_message != NULL) return NULL;
2520 /* Result not required */
2522 if (yield == NULL) return s;
2524 /* Do an appropriate comparison */
2530 tempcond = (num[0] == num[1]);
2534 tempcond = (num[0] > num[1]);
2538 tempcond = (num[0] >= num[1]);
2542 tempcond = (num[0] < num[1]);
2546 tempcond = (num[0] <= num[1]);
2550 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2554 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2558 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2562 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2566 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2570 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2574 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2578 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2582 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2586 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2589 case ECOND_MATCH: /* Regular expression match */
2590 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2594 expand_string_message = string_sprintf("regular expression error in "
2595 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2598 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2601 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2602 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2603 goto MATCHED_SOMETHING;
2605 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2606 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2607 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2608 goto MATCHED_SOMETHING;
2610 case ECOND_MATCH_IP: /* Match IP address in a host list */
2611 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2613 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2619 unsigned int *nullcache = NULL;
2620 check_host_block cb;
2622 cb.host_name = US"";
2623 cb.host_address = sub[0];
2625 /* If the host address starts off ::ffff: it is an IPv6 address in
2626 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2629 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2630 cb.host_address + 7 : cb.host_address;
2632 rc = match_check_list(
2633 &sub[1], /* the list */
2634 0, /* separator character */
2635 &hostlist_anchor, /* anchor pointer */
2636 &nullcache, /* cache pointer */
2637 check_host, /* function for testing */
2638 &cb, /* argument for function */
2639 MCL_HOST, /* type of check */
2640 sub[0], /* text for debugging */
2641 NULL); /* where to pass back data */
2643 goto MATCHED_SOMETHING;
2645 case ECOND_MATCH_LOCAL_PART:
2646 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2647 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2662 expand_string_message = string_sprintf("unable to complete match "
2663 "against \"%s\": %s", sub[1], search_error_message);
2669 /* Various "encrypted" comparisons. If the second string starts with
2670 "{" then an encryption type is given. Default to crypt() or crypt16()
2671 (build-time choice). */
2672 /* }-for-text-editors */
2675 #ifndef SUPPORT_CRYPTEQ
2676 goto COND_FAILED_NOT_COMPILED;
2678 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2680 int sublen = Ustrlen(sub[1]+5);
2685 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2687 /* If the length that we are comparing against is 24, the MD5 digest
2688 is expressed as a base64 string. This is the way LDAP does it. However,
2689 some other software uses a straightforward hex representation. We assume
2690 this if the length is 32. Other lengths fail. */
2694 uschar *coded = b64encode((uschar *)digest, 16);
2695 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2696 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2697 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2699 else if (sublen == 32)
2703 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2705 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2706 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2707 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2711 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2712 "fail\n crypted=%s\n", sub[1]+5);
2717 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2719 int sublen = Ustrlen(sub[1]+6);
2724 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2726 /* If the length that we are comparing against is 28, assume the SHA1
2727 digest is expressed as a base64 string. If the length is 40, assume a
2728 straightforward hex representation. Other lengths fail. */
2732 uschar *coded = b64encode((uschar *)digest, 20);
2733 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2734 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2735 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2737 else if (sublen == 40)
2741 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2743 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2744 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2745 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2749 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2750 "fail\n crypted=%s\n", sub[1]+6);
2755 else /* {crypt} or {crypt16} and non-{ at start */
2756 /* }-for-text-editors */
2761 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2766 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2771 else if (sub[1][0] == '{') /* }-for-text-editors */
2773 expand_string_message = string_sprintf("unknown encryption mechanism "
2774 "in \"%s\"", sub[1]);
2780 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2781 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2782 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2786 #define XSTR(s) STR(s)
2787 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2788 " subject=%s\n crypted=%s\n",
2789 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2794 /* If the encrypted string contains fewer than two characters (for the
2795 salt), force failure. Otherwise we get false positives: with an empty
2796 string the yield of crypt() is an empty string! */
2799 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2800 else if (errno == EINVAL)
2804 expand_string_message = string_sprintf("crypt error: %s\n",
2805 US strerror(errno));
2810 #endif /* SUPPORT_CRYPTEQ */
2815 const uschar * list = sub[1];
2817 uschar *save_iterate_item = iterate_item;
2818 int (*compare)(const uschar *, const uschar *);
2820 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2823 compare = cond_type == ECOND_INLISTI
2824 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2826 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2827 if (compare(sub[0], iterate_item) == 0)
2832 iterate_item = save_iterate_item;
2835 } /* Switch for comparison conditions */
2837 *yield = tempcond == testfor;
2838 return s; /* End of comparison conditions */
2841 /* and/or: computes logical and/or of several conditions */
2845 subcondptr = (yield == NULL)? NULL : &tempcond;
2846 combined_cond = (cond_type == ECOND_AND);
2848 while (isspace(*s)) s++;
2849 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2853 while (isspace(*s)) s++;
2854 /* {-for-text-editors */
2855 if (*s == '}') break;
2856 if (*s != '{') /* }-for-text-editors */
2858 expand_string_message = string_sprintf("each subcondition "
2859 "inside an \"%s{...}\" condition must be in its own {}", name);
2863 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2865 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2866 expand_string_message, name);
2869 while (isspace(*s)) s++;
2871 /* {-for-text-editors */
2874 /* {-for-text-editors */
2875 expand_string_message = string_sprintf("missing } at end of condition "
2876 "inside \"%s\" group", name);
2882 if (cond_type == ECOND_AND)
2884 combined_cond &= tempcond;
2885 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2886 } /* evaluate any more */
2889 combined_cond |= tempcond;
2890 if (combined_cond) subcondptr = NULL; /* once true, don't */
2891 } /* evaluate any more */
2895 if (yield != NULL) *yield = (combined_cond == testfor);
2899 /* forall/forany: iterates a condition with different values */
2904 const uschar * list;
2906 uschar *save_iterate_item = iterate_item;
2908 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2910 while (isspace(*s)) s++;
2911 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2912 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2913 if (sub[0] == NULL) return NULL;
2914 /* {-for-text-editors */
2915 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2917 while (isspace(*s)) s++;
2918 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2922 /* Call eval_condition once, with result discarded (as if scanning a
2923 "false" part). This allows us to find the end of the condition, because if
2924 the list it empty, we won't actually evaluate the condition for real. */
2926 if (!(s = eval_condition(sub[1], resetok, NULL)))
2928 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2929 expand_string_message, name);
2932 while (isspace(*s)) s++;
2934 /* {-for-text-editors */
2937 /* {-for-text-editors */
2938 expand_string_message = string_sprintf("missing } at end of condition "
2939 "inside \"%s\"", name);
2943 if (yield != NULL) *yield = !testfor;
2945 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2947 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2948 if (!eval_condition(sub[1], resetok, &tempcond))
2950 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2951 expand_string_message, name);
2952 iterate_item = save_iterate_item;
2955 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2956 tempcond? "true":"false");
2958 if (yield != NULL) *yield = (tempcond == testfor);
2959 if (tempcond == (cond_type == ECOND_FORANY)) break;
2962 iterate_item = save_iterate_item;
2967 /* The bool{} expansion condition maps a string to boolean.
2968 The values supported should match those supported by the ACL condition
2969 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2970 of true/false. Note that Router "condition" rules have a different
2971 interpretation, where general data can be used and only a few values
2973 Note that readconf.c boolean matching, for boolean configuration options,
2974 only matches true/yes/false/no.
2975 The bool_lax{} condition matches the Router logic, which is much more
2978 case ECOND_BOOL_LAX:
2984 BOOL boolvalue = FALSE;
2985 while (isspace(*s)) s++;
2986 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2987 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2988 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2990 case 1: expand_string_message = string_sprintf(
2991 "too few arguments or bracketing error for %s",
2995 case 3: return NULL;
2998 while (isspace(*t)) t++;
3002 /* trailing whitespace: seems like a good idea to ignore it too */
3004 while (isspace(*t2)) t2--;
3005 if (t2 != (t + len))
3012 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
3013 /* logic for the lax case from expand_check_condition(), which also does
3014 expands, and the logic is both short and stable enough that there should
3015 be no maintenance burden from replicating it. */
3019 ? Ustrspn(t+1, "0123456789") == len-1
3020 : Ustrspn(t, "0123456789") == len)
3022 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3023 /* expand_check_condition only does a literal string "0" check */
3024 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3027 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3029 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3031 else if (cond_type == ECOND_BOOL_LAX)
3035 expand_string_message = string_sprintf("unrecognised boolean "
3039 if (yield != NULL) *yield = (boolvalue == testfor);
3043 /* Unknown condition */
3046 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3048 } /* End switch on condition type */
3050 /* Missing braces at start and end of data */
3052 COND_FAILED_CURLY_START:
3053 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3056 COND_FAILED_CURLY_END:
3057 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3061 /* A condition requires code that is not compiled */
3063 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3064 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3065 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3066 COND_FAILED_NOT_COMPILED:
3067 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3076 /*************************************************
3077 * Save numerical variables *
3078 *************************************************/
3080 /* This function is called from items such as "if" that want to preserve and
3081 restore the numbered variables.
3084 save_expand_string points to an array of pointers to set
3085 save_expand_nlength points to an array of ints for the lengths
3087 Returns: the value of expand max to save
3091 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3094 for (i = 0; i <= expand_nmax; i++)
3096 save_expand_nstring[i] = expand_nstring[i];
3097 save_expand_nlength[i] = expand_nlength[i];
3104 /*************************************************
3105 * Restore numerical variables *
3106 *************************************************/
3108 /* This function restored saved values of numerical strings.
3111 save_expand_nmax the number of strings to restore
3112 save_expand_string points to an array of pointers
3113 save_expand_nlength points to an array of ints
3119 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3120 int *save_expand_nlength)
3123 expand_nmax = save_expand_nmax;
3124 for (i = 0; i <= expand_nmax; i++)
3126 expand_nstring[i] = save_expand_nstring[i];
3127 expand_nlength[i] = save_expand_nlength[i];
3135 /*************************************************
3136 * Handle yes/no substrings *
3137 *************************************************/
3139 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3140 alternative substrings that depend on whether or not the condition was true,
3141 or the lookup or extraction succeeded. The substrings always have to be
3142 expanded, to check their syntax, but "skipping" is set when the result is not
3143 needed - this avoids unnecessary nested lookups.
3146 skipping TRUE if we were skipping when this item was reached
3147 yes TRUE if the first string is to be used, else use the second
3148 save_lookup a value to put back into lookup_value before the 2nd expansion
3149 sptr points to the input string pointer
3150 yieldptr points to the output string pointer
3151 sizeptr points to the output string size
3152 ptrptr points to the output string pointer
3153 type "lookup", "if", "extract", "run", "env", "listextract" or
3154 "certextract" for error message
3155 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3158 Returns: 0 OK; lookup_value has been reset to save_lookup
3160 2 expansion failed because of bracketing error
3164 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3165 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3168 const uschar *s = *sptr; /* Local value */
3169 uschar *sub1, *sub2;
3171 /* If there are no following strings, we substitute the contents of $value for
3172 lookups and for extractions in the success case. For the ${if item, the string
3173 "true" is substituted. In the fail case, nothing is substituted for all three
3176 while (isspace(*s)) s++;
3181 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3185 if (yes && lookup_value)
3186 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3187 Ustrlen(lookup_value));
3188 lookup_value = save_lookup;
3194 /* The first following string must be braced. */
3196 if (*s++ != '{') goto FAILED_CURLY;
3198 /* Expand the first substring. Forced failures are noticed only if we actually
3199 want this string. Set skipping in the call in the fail case (this will always
3200 be the case if we were already skipping). */
3202 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3203 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3204 expand_string_forcedfail = FALSE;
3205 if (*s++ != '}') goto FAILED_CURLY;
3207 /* If we want the first string, add it to the output */
3210 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3212 /* If this is called from a lookup or an extract, we want to restore $value to
3213 what it was at the start of the item, so that it has this value during the
3214 second string expansion. For the call from "if" or "run" to this function,
3215 save_lookup is set to lookup_value, so that this statement does nothing. */
3217 lookup_value = save_lookup;
3219 /* There now follows either another substring, or "fail", or nothing. This
3220 time, forced failures are noticed only if we want the second string. We must
3221 set skipping in the nested call if we don't want this string, or if we were
3222 already skipping. */
3224 while (isspace(*s)) s++;
3227 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3228 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3229 expand_string_forcedfail = FALSE;
3230 if (*s++ != '}') goto FAILED_CURLY;
3232 /* If we want the second string, add it to the output */
3235 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3238 /* If there is no second string, but the word "fail" is present when the use of
3239 the second string is wanted, set a flag indicating it was a forced failure
3240 rather than a syntactic error. Swallow the terminating } in case this is nested
3241 inside another lookup or if or extract. */
3246 /* deconst cast ok here as source is s anyway */
3247 s = US read_name(name, sizeof(name), s, US"_");
3248 if (Ustrcmp(name, "fail") == 0)
3250 if (!yes && !skipping)
3252 while (isspace(*s)) s++;
3253 if (*s++ != '}') goto FAILED_CURLY;
3254 expand_string_message =
3255 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3256 expand_string_forcedfail = TRUE;
3262 expand_string_message =
3263 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3268 /* All we have to do now is to check on the final closing brace. */
3270 while (isspace(*s)) s++;
3271 if (*s++ == '}') goto RETURN;
3273 /* Get here if there is a bracketing failure */
3278 /* Get here for other failures */
3283 /* Update the input pointer value before returning */
3293 /*************************************************
3294 * Handle MD5 or SHA-1 computation for HMAC *
3295 *************************************************/
3297 /* These are some wrapping functions that enable the HMAC code to be a bit
3298 cleaner. A good compiler will spot the tail recursion.
3301 type HMAC_MD5 or HMAC_SHA1
3302 remaining are as for the cryptographic hash functions
3308 chash_start(int type, void *base)
3310 if (type == HMAC_MD5)
3311 md5_start((md5 *)base);
3313 sha1_start((sha1 *)base);
3317 chash_mid(int type, void *base, uschar *string)
3319 if (type == HMAC_MD5)
3320 md5_mid((md5 *)base, string);
3322 sha1_mid((sha1 *)base, string);
3326 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3328 if (type == HMAC_MD5)
3329 md5_end((md5 *)base, string, length, digest);
3331 sha1_end((sha1 *)base, string, length, digest);
3338 /********************************************************
3339 * prvs: Get last three digits of days since Jan 1, 1970 *
3340 ********************************************************/
3342 /* This is needed to implement the "prvs" BATV reverse
3345 Argument: integer "days" offset to add or substract to
3346 or from the current number of days.
3348 Returns: pointer to string containing the last three
3349 digits of the number of days since Jan 1, 1970,
3350 modified by the offset argument, NULL if there
3351 was an error in the conversion.
3356 prvs_daystamp(int day_offset)
3358 uschar *days = store_get(32); /* Need at least 24 for cases */
3359 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3360 (time(NULL) + day_offset*86400)/86400);
3361 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3366 /********************************************************
3367 * prvs: perform HMAC-SHA1 computation of prvs bits *
3368 ********************************************************/
3370 /* This is needed to implement the "prvs" BATV reverse
3374 address RFC2821 Address to use
3375 key The key to use (must be less than 64 characters
3377 key_num Single-digit key number to use. Defaults to
3380 Returns: pointer to string containing the first three
3381 bytes of the final hash in hex format, NULL if
3382 there was an error in the process.
3386 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3388 uschar *hash_source, *p;
3389 int size = 0,offset = 0,i;
3391 void *use_base = &sha1_base;
3392 uschar innerhash[20];
3393 uschar finalhash[20];
3394 uschar innerkey[64];
3395 uschar outerkey[64];
3396 uschar *finalhash_hex = store_get(40);
3398 if (key_num == NULL)
3401 if (Ustrlen(key) > 64)
3404 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3405 string_cat(hash_source,&size,&offset,daystamp,3);
3406 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3407 hash_source[offset] = '\0';
3409 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3411 memset(innerkey, 0x36, 64);
3412 memset(outerkey, 0x5c, 64);
3414 for (i = 0; i < Ustrlen(key); i++)
3416 innerkey[i] ^= key[i];
3417 outerkey[i] ^= key[i];
3420 chash_start(HMAC_SHA1, use_base);
3421 chash_mid(HMAC_SHA1, use_base, innerkey);
3422 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3424 chash_start(HMAC_SHA1, use_base);
3425 chash_mid(HMAC_SHA1, use_base, outerkey);
3426 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3429 for (i = 0; i < 3; i++)
3431 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3432 *p++ = hex_digits[finalhash[i] & 0x0f];
3436 return finalhash_hex;
3442 /*************************************************
3443 * Join a file onto the output string *
3444 *************************************************/
3446 /* This is used for readfile and after a run expansion. It joins the contents
3447 of a file onto the output string, globally replacing newlines with a given
3448 string (optionally). The file is closed at the end.
3452 yield pointer to the expandable string
3453 sizep pointer to the current size
3454 ptrp pointer to the current position
3455 eol newline replacement string, or NULL
3457 Returns: new value of string pointer
3461 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3464 uschar buffer[1024];
3466 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3468 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3470 int len = Ustrlen(buffer);
3471 if (eol != NULL && buffer[len-1] == '\n') len--;
3472 yield = string_cat(yield, sizep, ptrp, buffer, len);
3473 if (buffer[len] != 0)
3474 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3477 if (yield != NULL) yield[*ptrp] = 0;
3485 /*************************************************
3486 * Evaluate numeric expression *
3487 *************************************************/
3489 /* This is a set of mutually recursive functions that evaluate an arithmetic
3490 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3491 these functions that is called from elsewhere is eval_expr, whose interface is:
3494 sptr pointer to the pointer to the string - gets updated
3495 decimal TRUE if numbers are to be assumed decimal
3496 error pointer to where to put an error message - must be NULL on input
3497 endket TRUE if ')' must terminate - FALSE for external call
3499 Returns: on success: the value of the expression, with *error still NULL
3500 on failure: an undefined value, with *error = a message
3503 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3506 static int_eximarith_t
3507 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3510 int_eximarith_t x = eval_op_or(&s, decimal, error);
3516 *error = US"expecting closing parenthesis";
3518 while (isspace(*(++s)));
3520 else if (*s != 0) *error = US"expecting operator";
3527 static int_eximarith_t
3528 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3533 while (isspace(*s)) s++;
3538 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3540 switch (tolower(*s))
3543 case 'k': n *= 1024; s++; break;
3544 case 'm': n *= 1024*1024; s++; break;
3545 case 'g': n *= 1024*1024*1024; s++; break;
3547 while (isspace (*s)) s++;
3552 n = eval_expr(&s, decimal, error, 1);
3556 *error = US"expecting number or opening parenthesis";
3564 static int_eximarith_t
3565 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3569 while (isspace(*s)) s++;
3570 if (*s == '+' || *s == '-' || *s == '~')
3573 x = eval_op_unary(&s, decimal, error);
3574 if (op == '-') x = -x;
3575 else if (op == '~') x = ~x;
3579 x = eval_number(&s, decimal, error);
3586 static int_eximarith_t
3587 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3590 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3593 while (*s == '*' || *s == '/' || *s == '%')
3596 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3597 if (*error != NULL) break;
3598 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3599 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3600 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3601 * -N*M is INT_MIN will yielf INT_MIN.
3602 * Since we don't support floating point, this is somewhat simpler.
3603 * Ideally, we'd return an error, but since we overflow for all other
3604 * arithmetic, consistency suggests otherwise, but what's the correct value
3605 * to use? There is none.
3606 * The C standard guarantees overflow for unsigned arithmetic but signed
3607 * overflow invokes undefined behaviour; in practice, this is overflow
3608 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3609 * that long/longlong larger than int are available, or we could just work
3610 * with larger types. We should consider whether to guarantee 32bit eval
3611 * and 64-bit working variables, with errors returned. For now ...
3612 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3613 * can just let the other invalid results occur otherwise, as they have
3614 * until now. For this one case, we can coerce.
3616 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3619 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3620 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3630 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3646 static int_eximarith_t
3647 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3650 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3653 while (*s == '+' || *s == '-')
3656 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3657 if (*error != NULL) break;
3658 if (op == '+') x += y; else x -= y;
3666 static int_eximarith_t
3667 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3670 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3673 while ((*s == '<' || *s == '>') && s[1] == s[0])
3678 y = eval_op_sum(&s, decimal, error);
3679 if (*error != NULL) break;
3680 if (op == '<') x <<= y; else x >>= y;
3688 static int_eximarith_t
3689 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3692 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3699 y = eval_op_shift(&s, decimal, error);
3700 if (*error != NULL) break;
3709 static int_eximarith_t
3710 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3713 int_eximarith_t x = eval_op_and(&s, decimal, error);
3720 y = eval_op_and(&s, decimal, error);
3721 if (*error != NULL) break;
3730 static int_eximarith_t
3731 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3734 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3741 y = eval_op_xor(&s, decimal, error);
3742 if (*error != NULL) break;
3752 /*************************************************
3754 *************************************************/
3756 /* Returns either an unchanged string, or the expanded string in stacking pool
3757 store. Interpreted sequences are:
3759 \... normal escaping rules
3760 $name substitutes the variable
3762 ${op:string} operates on the expanded string value
3763 ${item{arg1}{arg2}...} expands the args and then does the business
3764 some literal args are not enclosed in {}
3766 There are now far too many operators and item types to make it worth listing
3767 them here in detail any more.
3769 We use an internal routine recursively to handle embedded substrings. The
3770 external function follows. The yield is NULL if the expansion failed, and there
3771 are two cases: if something collapsed syntactically, or if "fail" was given
3772 as the action on a lookup failure. These can be distinguised by looking at the
3773 variable expand_string_forcedfail, which is TRUE in the latter case.
3775 The skipping flag is set true when expanding a substring that isn't actually
3776 going to be used (after "if" or "lookup") and it prevents lookups from
3777 happening lower down.
3779 Store usage: At start, a store block of the length of the input plus 64
3780 is obtained. This is expanded as necessary by string_cat(), which might have to
3781 get a new block, or might be able to expand the original. At the end of the
3782 function we can release any store above that portion of the yield block that
3783 was actually used. In many cases this will be optimal.
3785 However: if the first item in the expansion is a variable name or header name,
3786 we reset the store before processing it; if the result is in fresh store, we
3787 use that without copying. This is helpful for expanding strings like
3788 $message_headers which can get very long.
3790 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3791 since resetting the store at the end of the expansion will free store that was
3792 allocated by the plugin code as well as the slop after the expanded string. So
3793 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3794 and, given the acl condition, ${if }. This is an unfortunate consequence of
3795 string expansion becoming too powerful.
3798 string the string to be expanded
3799 ket_ends true if expansion is to stop at }
3800 left if not NULL, a pointer to the first character after the
3801 expansion is placed here (typically used with ket_ends)
3802 skipping TRUE for recursive calls when the value isn't actually going
3803 to be used (to allow for optimisation)
3804 honour_dollar TRUE if $ is to be expanded,
3805 FALSE if it's just another character
3806 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3809 Returns: NULL if expansion fails:
3810 expand_string_forcedfail is set TRUE if failure was forced
3811 expand_string_message contains a textual error message
3812 a pointer to the expanded string on success
3816 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3817 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3820 int size = Ustrlen(string)+ 64;
3822 uschar *yield = store_get(size);
3823 const uschar *s = string;
3824 uschar *save_expand_nstring[EXPAND_MAXN+1];
3825 int save_expand_nlength[EXPAND_MAXN+1];
3826 BOOL resetok = TRUE;
3828 expand_string_forcedfail = FALSE;
3829 expand_string_message = US"";
3836 /* \ escapes the next character, which must exist, or else
3837 the expansion fails. There's a special escape, \N, which causes
3838 copying of the subject verbatim up to the next \N. Otherwise,
3839 the escapes are the standard set. */
3845 expand_string_message = US"\\ at end of string";
3851 const uschar * t = s + 2;
3852 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3853 yield = string_cat(yield, &size, &ptr, t, s - t);
3854 if (*s != 0) s += 2;
3860 ch[0] = string_interpret_escape(&s);
3862 yield = string_cat(yield, &size, &ptr, ch, 1);
3869 /* Anything other than $ is just copied verbatim, unless we are
3870 looking for a terminating } character. */
3873 if (ket_ends && *s == '}') break;
3875 if (*s != '$' || !honour_dollar)
3877 yield = string_cat(yield, &size, &ptr, s++, 1);
3881 /* No { after the $ - must be a plain name or a number for string
3882 match variable. There has to be a fudge for variables that are the
3883 names of header fields preceded by "$header_" because header field
3884 names can contain any printing characters except space and colon.
3885 For those that don't like typing this much, "$h_" is a synonym for
3886 "$header_". A non-existent header yields a NULL value; nothing is
3889 if (isalpha((*(++s))))
3894 s = read_name(name, sizeof(name), s, US"_");
3896 /* If this is the first thing to be expanded, release the pre-allocated
3899 if (ptr == 0 && yield != NULL)
3901 if (resetok) store_reset(yield);
3908 if (Ustrncmp(name, "h_", 2) == 0 ||
3909 Ustrncmp(name, "rh_", 3) == 0 ||
3910 Ustrncmp(name, "bh_", 3) == 0 ||
3911 Ustrncmp(name, "header_", 7) == 0 ||
3912 Ustrncmp(name, "rheader_", 8) == 0 ||
3913 Ustrncmp(name, "bheader_", 8) == 0)
3915 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3916 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3917 s = read_header_name(name, sizeof(name), s);
3918 value = find_header(name, FALSE, &newsize, want_raw, charset);
3920 /* If we didn't find the header, and the header contains a closing brace
3921 character, this may be a user error where the terminating colon
3922 has been omitted. Set a flag to adjust the error message in this case.
3923 But there is no error here - nothing gets inserted. */
3927 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3934 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
3936 expand_string_message =
3937 string_sprintf("unknown variable name \"%s\"", name);
3938 check_variable_error_message(name);
3942 /* If the data is known to be in a new buffer, newsize will be set to the
3943 size of that buffer. If this is the first thing in an expansion string,
3944 yield will be NULL; just point it at the new store instead of copying. Many
3945 expansion strings contain just one reference, so this is a useful
3946 optimization, especially for humungous headers. */
3948 len = Ustrlen(value);
3949 if (yield == NULL && newsize != 0)
3955 else yield = string_cat(yield, &size, &ptr, value, len);
3963 s = read_cnumber(&n, s);
3964 if (n >= 0 && n <= expand_nmax)
3965 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3970 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3972 if (*s != '{') /*}*/
3974 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3978 /* After { there can be various things, but they all start with
3979 an initial word, except for a number for a string match variable. */
3981 if (isdigit((*(++s))))
3984 s = read_cnumber(&n, s); /*{*/
3987 expand_string_message = US"} expected after number";
3990 if (n >= 0 && n <= expand_nmax)
3991 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3998 expand_string_message = US"letter or digit expected after ${"; /*}*/
4002 /* Allow "-" in names to cater for substrings with negative
4003 arguments. Since we are checking for known names after { this is
4006 s = read_name(name, sizeof(name), s, US"_-");
4007 item_type = chop_match(name, item_table, nelem(item_table));
4011 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4012 If the ACL returns accept or reject we return content set by "message ="
4013 There is currently no limit on recursion; this would have us call
4014 acl_check_internal() directly and get a current level from somewhere.
4015 See also the acl expansion condition ECOND_ACL and the traditional
4016 acl modifier ACLC_ACL.
4017 Assume that the function has side-effects on the store that must be preserved.
4021 /* ${acl {name} {arg1}{arg2}...} */
4023 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4026 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4029 case 1: goto EXPAND_FAILED_CURLY;
4031 case 3: goto EXPAND_FAILED;
4033 if (skipping) continue;
4036 switch(eval_acl(sub, nelem(sub), &user_msg))
4041 debug_printf("acl expansion yield: %s\n", user_msg);
4043 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
4047 expand_string_forcedfail = TRUE;
4049 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4054 /* Handle conditionals - preserve the values of the numerical expansion
4055 variables in case they get changed by a regular expression match in the
4056 condition. If not, they retain their external settings. At the end
4057 of this "if" section, they get restored to their previous values. */
4062 const uschar *next_s;
4063 int save_expand_nmax =
4064 save_expand_strings(save_expand_nstring, save_expand_nlength);
4066 while (isspace(*s)) s++;
4067 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
4068 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4071 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
4072 cond? "true" : "false");
4076 /* The handling of "yes" and "no" result strings is now in a separate
4077 function that is also used by ${lookup} and ${extract} and ${run}. */
4079 switch(process_yesno(
4080 skipping, /* were previously skipping */
4081 cond, /* success/failure indicator */
4082 lookup_value, /* value to reset for string2 */
4083 &s, /* input pointer */
4084 &yield, /* output pointer */
4085 &size, /* output size */
4086 &ptr, /* output current point */
4087 US"if", /* condition type */
4090 case 1: goto EXPAND_FAILED; /* when all is well, the */
4091 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4094 /* Restore external setting of expansion variables for continuation
4097 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4098 save_expand_nlength);
4103 case EITEM_IMAPFOLDER:
4104 { /* ${imapfolder {name}{sep]{specials}} */
4108 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4111 case 1: goto EXPAND_FAILED_CURLY;
4113 case 3: goto EXPAND_FAILED;
4116 if (sub_arg[1] == NULL) /* One argument */
4118 sub_arg[1] = US"/"; /* default separator */
4121 else if (Ustrlen(sub_arg[1]) != 1)
4123 expand_string_message =
4125 "IMAP folder separator must be one character, found \"%s\"",
4130 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4131 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4134 yield = string_cat(yield, &size, &ptr, encoded, Ustrlen(encoded));
4139 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4140 expanding an internal string that isn't actually going to be used. All we
4141 need to do is check the syntax, so don't do a lookup at all. Preserve the
4142 values of the numerical expansion variables in case they get changed by a
4143 partial lookup. If not, they retain their external settings. At the end
4144 of this "lookup" section, they get restored to their previous values. */
4148 int stype, partial, affixlen, starflags;
4149 int expand_setup = 0;
4151 uschar *key, *filename;
4152 const uschar *affix;
4153 uschar *save_lookup_value = lookup_value;
4154 int save_expand_nmax =
4155 save_expand_strings(save_expand_nstring, save_expand_nlength);
4157 if ((expand_forbid & RDO_LOOKUP) != 0)
4159 expand_string_message = US"lookup expansions are not permitted";
4163 /* Get the key we are to look up for single-key+file style lookups.
4164 Otherwise set the key NULL pro-tem. */
4166 while (isspace(*s)) s++;
4167 if (*s == '{') /*}*/
4169 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4170 if (key == NULL) goto EXPAND_FAILED; /*{*/
4171 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4172 while (isspace(*s)) s++;
4176 /* Find out the type of database */
4180 expand_string_message = US"missing lookup type";
4184 /* The type is a string that may contain special characters of various
4185 kinds. Allow everything except space or { to appear; the actual content
4186 is checked by search_findtype_partial. */ /*}*/
4188 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4190 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4194 while (isspace(*s)) s++;
4196 /* Now check for the individual search type and any partial or default
4197 options. Only those types that are actually in the binary are valid. */
4199 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4203 expand_string_message = search_error_message;
4207 /* Check that a key was provided for those lookup types that need it,
4208 and was not supplied for those that use the query style. */
4210 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4214 expand_string_message = string_sprintf("missing {key} for single-"
4215 "key \"%s\" lookup", name);
4223 expand_string_message = string_sprintf("a single key was given for "
4224 "lookup type \"%s\", which is not a single-key lookup type", name);
4229 /* Get the next string in brackets and expand it. It is the file name for
4230 single-key+file lookups, and the whole query otherwise. In the case of
4231 queries that also require a file name (e.g. sqlite), the file name comes
4234 if (*s != '{') goto EXPAND_FAILED_CURLY;
4235 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4236 if (filename == NULL) goto EXPAND_FAILED;
4237 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4238 while (isspace(*s)) s++;
4240 /* If this isn't a single-key+file lookup, re-arrange the variables
4241 to be appropriate for the search_ functions. For query-style lookups,
4242 there is just a "key", and no file name. For the special query-style +
4243 file types, the query (i.e. "key") starts with a file name. */
4247 while (isspace(*filename)) filename++;
4250 if (mac_islookup(stype, lookup_querystyle))
4256 if (*filename != '/')
4258 expand_string_message = string_sprintf(
4259 "absolute file name expected for \"%s\" lookup", name);
4262 while (*key != 0 && !isspace(*key)) key++;
4263 if (*key != 0) *key++ = 0;
4267 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4268 the entry was not found. Note that there is no search_close() function.
4269 Files are left open in case of re-use. At suitable places in higher logic,
4270 search_tidyup() is called to tidy all open files. This can save opening
4271 the same file several times. However, files may also get closed when
4272 others are opened, if too many are open at once. The rule is that a
4273 handle should not be used after a second search_open().
4275 Request that a partial search sets up $1 and maybe $2 by passing
4276 expand_setup containing zero. If its value changes, reset expand_nmax,
4277 since new variables will have been set. Note that at the end of this
4278 "lookup" section, the old numeric variables are restored. */
4281 lookup_value = NULL;
4284 void *handle = search_open(filename, stype, 0, NULL, NULL);
4287 expand_string_message = search_error_message;
4290 lookup_value = search_find(handle, filename, key, partial, affix,
4291 affixlen, starflags, &expand_setup);
4292 if (search_find_defer)
4294 expand_string_message =
4295 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4296 string_printing2(key, FALSE), search_error_message);
4299 if (expand_setup > 0) expand_nmax = expand_setup;
4302 /* The handling of "yes" and "no" result strings is now in a separate
4303 function that is also used by ${if} and ${extract}. */
4305 switch(process_yesno(
4306 skipping, /* were previously skipping */
4307 lookup_value != NULL, /* success/failure indicator */
4308 save_lookup_value, /* value to reset for string2 */
4309 &s, /* input pointer */
4310 &yield, /* output pointer */
4311 &size, /* output size */
4312 &ptr, /* output current point */
4313 US"lookup", /* condition type */
4316 case 1: goto EXPAND_FAILED; /* when all is well, the */
4317 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4320 /* Restore external setting of expansion variables for carrying on
4321 at this level, and continue. */
4323 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4324 save_expand_nlength);
4328 /* If Perl support is configured, handle calling embedded perl subroutines,
4329 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4330 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4331 arguments (defined below). */
4333 #define EXIM_PERL_MAX_ARGS 8
4337 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4338 "is not included in this binary";
4341 #else /* EXIM_PERL */
4343 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4346 if ((expand_forbid & RDO_PERL) != 0)
4348 expand_string_message = US"Perl calls are not permitted";
4352 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4353 US"perl", &resetok))
4355 case 1: goto EXPAND_FAILED_CURLY;
4357 case 3: goto EXPAND_FAILED;
4360 /* If skipping, we don't actually do anything */
4362 if (skipping) continue;
4364 /* Start the interpreter if necessary */
4366 if (!opt_perl_started)
4369 if (opt_perl_startup == NULL)
4371 expand_string_message = US"A setting of perl_startup is needed when "
4372 "using the Perl interpreter";
4375 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4376 initerror = init_perl(opt_perl_startup);
4377 if (initerror != NULL)
4379 expand_string_message =
4380 string_sprintf("error in perl_startup code: %s\n", initerror);
4383 opt_perl_started = TRUE;
4386 /* Call the function */
4388 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4389 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4390 sub_arg[0], sub_arg + 1);
4392 /* NULL yield indicates failure; if the message pointer has been set to
4393 NULL, the yield was undef, indicating a forced failure. Otherwise the
4394 message will indicate some kind of Perl error. */
4396 if (new_yield == NULL)
4398 if (expand_string_message == NULL)
4400 expand_string_message =
4401 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4402 "failure", sub_arg[0]);
4403 expand_string_forcedfail = TRUE;
4408 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4409 set during a callback from Perl. */
4411 expand_string_forcedfail = FALSE;
4415 #endif /* EXIM_PERL */
4417 /* Transform email address to "prvs" scheme to use
4418 as BATV-signed return path */
4425 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4427 case 1: goto EXPAND_FAILED_CURLY;
4429 case 3: goto EXPAND_FAILED;
4432 /* If skipping, we don't actually do anything */
4433 if (skipping) continue;
4435 /* sub_arg[0] is the address */
4436 domain = Ustrrchr(sub_arg[0],'@');
4437 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4439 expand_string_message = US"prvs first argument must be a qualified email address";
4443 /* Calculate the hash. The second argument must be a single-digit
4444 key number, or unset. */
4446 if (sub_arg[2] != NULL &&
4447 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4449 expand_string_message = US"prvs second argument must be a single digit";
4453 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4456 expand_string_message = US"prvs hmac-sha1 conversion failed";
4460 /* Now separate the domain from the local part */
4463 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4464 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4465 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4466 string_cat(yield,&size,&ptr,p,6);
4467 string_cat(yield,&size,&ptr,US"=",1);
4468 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4469 string_cat(yield,&size,&ptr,US"@",1);
4470 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4475 /* Check a prvs-encoded address for validity */
4477 case EITEM_PRVSCHECK:
4480 int mysize = 0, myptr = 0;
4484 /* TF: Ugliness: We want to expand parameter 1 first, then set
4485 up expansion variables that are used in the expansion of
4486 parameter 2. So we clone the string for the first
4487 expansion, where we only expand parameter 1.
4489 PH: Actually, that isn't necessary. The read_subs() function is
4490 designed to work this way for the ${if and ${lookup expansions. I've
4494 /* Reset expansion variables */
4495 prvscheck_result = NULL;
4496 prvscheck_address = NULL;
4497 prvscheck_keynum = NULL;
4499 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4501 case 1: goto EXPAND_FAILED_CURLY;
4503 case 3: goto EXPAND_FAILED;
4506 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4509 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4511 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4512 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4513 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4514 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4515 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4517 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4518 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4519 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4520 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4521 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4523 /* Set up expansion variables */
4524 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4525 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4526 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4527 prvscheck_address[myptr] = '\0';
4528 prvscheck_keynum = string_copy(key_num);
4530 /* Now expand the second argument */
4531 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4533 case 1: goto EXPAND_FAILED_CURLY;
4535 case 3: goto EXPAND_FAILED;
4538 /* Now we have the key and can check the address. */
4540 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4545 expand_string_message = US"hmac-sha1 conversion failed";
4549 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4550 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4552 if (Ustrcmp(p,hash) == 0)
4554 /* Success, valid BATV address. Now check the expiry date. */
4555 uschar *now = prvs_daystamp(0);
4556 unsigned int inow = 0,iexpire = 1;
4558 (void)sscanf(CS now,"%u",&inow);
4559 (void)sscanf(CS daystamp,"%u",&iexpire);
4561 /* When "iexpire" is < 7, a "flip" has occured.
4562 Adjust "inow" accordingly. */
4563 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4565 if (iexpire >= inow)
4567 prvscheck_result = US"1";
4568 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4572 prvscheck_result = NULL;
4573 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4578 prvscheck_result = NULL;
4579 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4582 /* Now expand the final argument. We leave this till now so that
4583 it can include $prvscheck_result. */
4585 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4587 case 1: goto EXPAND_FAILED_CURLY;
4589 case 3: goto EXPAND_FAILED;
4592 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4593 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4595 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4597 /* Reset the "internal" variables afterwards, because they are in
4598 dynamic store that will be reclaimed if the expansion succeeded. */
4600 prvscheck_address = NULL;
4601 prvscheck_keynum = NULL;
4605 /* Does not look like a prvs encoded address, return the empty string.
4606 We need to make sure all subs are expanded first, so as to skip over
4609 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4611 case 1: goto EXPAND_FAILED_CURLY;
4613 case 3: goto EXPAND_FAILED;
4620 /* Handle "readfile" to insert an entire file */
4622 case EITEM_READFILE:
4627 if ((expand_forbid & RDO_READFILE) != 0)
4629 expand_string_message = US"file insertions are not permitted";
4633 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4635 case 1: goto EXPAND_FAILED_CURLY;
4637 case 3: goto EXPAND_FAILED;
4640 /* If skipping, we don't actually do anything */
4642 if (skipping) continue;
4644 /* Open the file and read it */
4646 f = Ufopen(sub_arg[0], "rb");
4649 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4653 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4658 /* Handle "readsocket" to insert data from a Unix domain socket */
4660 case EITEM_READSOCK:
4666 struct sockaddr_un sockun; /* don't call this "sun" ! */
4670 if ((expand_forbid & RDO_READSOCK) != 0)
4672 expand_string_message = US"socket insertions are not permitted";
4676 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4677 because there may be a string for expansion on failure. */
4679 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4681 case 1: goto EXPAND_FAILED_CURLY;
4682 case 2: /* Won't occur: no end check */
4683 case 3: goto EXPAND_FAILED;
4686 /* Sort out timeout, if given */
4688 if (sub_arg[2] != NULL)
4690 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4693 expand_string_message = string_sprintf("bad time value %s",
4698 else sub_arg[3] = NULL; /* No eol if no timeout */
4700 /* If skipping, we don't actually do anything. Otherwise, arrange to
4701 connect to either an IP or a Unix socket. */
4705 /* Handle an IP (internet) domain */
4707 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4710 uschar *server_name = sub_arg[0] + 5;
4711 uschar *port_name = Ustrrchr(server_name, ':');
4713 /* Sort out the port */
4715 if (port_name == NULL)
4717 expand_string_message =
4718 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4721 *port_name++ = 0; /* Terminate server name */
4723 if (isdigit(*port_name))
4726 port = Ustrtol(port_name, &end, 0);
4727 if (end != port_name + Ustrlen(port_name))
4729 expand_string_message =
4730 string_sprintf("invalid port number %s", port_name);
4736 struct servent *service_info = getservbyname(CS port_name, "tcp");
4737 if (service_info == NULL)
4739 expand_string_message = string_sprintf("unknown port \"%s\"",
4743 port = ntohs(service_info->s_port);
4746 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4747 timeout, NULL, &expand_string_message)) < 0)
4751 /* Handle a Unix domain socket */
4756 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4758 expand_string_message = string_sprintf("failed to create socket: %s",
4763 sockun.sun_family = AF_UNIX;
4764 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4767 sigalrm_seen = FALSE;
4769 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4773 expand_string_message = US "socket connect timed out";
4778 expand_string_message = string_sprintf("failed to connect to socket "
4779 "%s: %s", sub_arg[0], strerror(errno));
4784 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4786 /* Allow sequencing of test actions */
4787 if (running_in_test_harness) millisleep(100);
4789 /* Write the request string, if not empty */
4791 if (sub_arg[1][0] != 0)
4793 int len = Ustrlen(sub_arg[1]);
4794 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4796 if (write(fd, sub_arg[1], len) != len)
4798 expand_string_message = string_sprintf("request write to socket "
4799 "failed: %s", strerror(errno));
4804 /* Shut down the sending side of the socket. This helps some servers to
4805 recognise that it is their turn to do some work. Just in case some
4806 system doesn't have this function, make it conditional. */
4809 shutdown(fd, SHUT_WR);
4812 if (running_in_test_harness) millisleep(100);
4814 /* Now we need to read from the socket, under a timeout. The function
4815 that reads a file can be used. */
4817 f = fdopen(fd, "rb");
4818 sigalrm_seen = FALSE;
4820 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4824 /* After a timeout, we restore the pointer in the result, that is,
4825 make sure we add nothing from the socket. */
4830 expand_string_message = US "socket read timed out";
4835 /* The whole thing has worked (or we were skipping). If there is a
4836 failure string following, we need to skip it. */
4840 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4842 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4843 while (isspace(*s)) s++;
4845 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4848 /* Come here on failure to create socket, connect socket, write to the
4849 socket, or timeout on reading. If another substring follows, expand and
4850 use it. Otherwise, those conditions give expand errors. */
4853 if (*s != '{') goto EXPAND_FAILED;
4854 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4855 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4856 if (arg == NULL) goto EXPAND_FAILED;
4857 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4858 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4859 while (isspace(*s)) s++;
4860 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4864 /* Handle "run" to execute a program. */
4870 const uschar **argv;
4876 if ((expand_forbid & RDO_RUN) != 0)
4878 expand_string_message = US"running a command is not permitted";
4882 while (isspace(*s)) s++;
4883 if (*s != '{') goto EXPAND_FAILED_CURLY;
4884 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4885 if (arg == NULL) goto EXPAND_FAILED;
4886 while (isspace(*s)) s++;
4887 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4889 if (skipping) /* Just pretend it worked when we're skipping */
4895 if (!transport_set_up_command(&argv, /* anchor for arg list */
4896 arg, /* raw command */
4897 FALSE, /* don't expand the arguments */
4898 0, /* not relevant when... */
4899 NULL, /* no transporting address */
4900 US"${run} expansion", /* for error messages */
4901 &expand_string_message)) /* where to put error message */
4906 /* Create the child process, making it a group leader. */
4908 pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4912 expand_string_message =
4913 string_sprintf("couldn't create child process: %s", strerror(errno));
4917 /* Nothing is written to the standard input. */
4921 /* Read the pipe to get the command's output into $value (which is kept
4922 in lookup_value). Read during execution, so that if the output exceeds
4923 the OS pipe buffer limit, we don't block forever. Remember to not release
4924 memory just allocated for $value. */
4927 f = fdopen(fd_out, "rb");
4928 sigalrm_seen = FALSE;
4930 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4934 /* Wait for the process to finish, applying the timeout, and inspect its
4935 return code for serious disasters. Simple non-zero returns are passed on.
4938 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4940 if (sigalrm_seen == TRUE || runrc == -256)
4942 expand_string_message = string_sprintf("command timed out");
4943 killpg(pid, SIGKILL); /* Kill the whole process group */
4946 else if (runrc == -257)
4947 expand_string_message = string_sprintf("wait() failed: %s",
4951 expand_string_message = string_sprintf("command killed by signal %d",
4958 /* Process the yes/no strings; $value may be useful in both cases */
4960 switch(process_yesno(
4961 skipping, /* were previously skipping */
4962 runrc == 0, /* success/failure indicator */
4963 lookup_value, /* value to reset for string2 */
4964 &s, /* input pointer */
4965 &yield, /* output pointer */
4966 &size, /* output size */
4967 &ptr, /* output current point */
4968 US"run", /* condition type */
4971 case 1: goto EXPAND_FAILED; /* when all is well, the */
4972 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4978 /* Handle character translation for "tr" */
4986 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4988 case 1: goto EXPAND_FAILED_CURLY;
4990 case 3: goto EXPAND_FAILED;
4993 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4994 o2m = Ustrlen(sub[2]) - 1;
4996 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4998 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
5002 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
5009 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5010 expanded arguments. */
5020 int val[2] = { 0, -1 };
5023 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5024 Ensure that sub[2] is set in the ${length } case. */
5027 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5028 TRUE, name, &resetok))
5030 case 1: goto EXPAND_FAILED_CURLY;
5032 case 3: goto EXPAND_FAILED;
5035 /* Juggle the arguments if there are only two of them: always move the
5036 string to the last position and make ${length{n}{str}} equivalent to
5037 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5043 if (item_type == EITEM_LENGTH)
5050 for (i = 0; i < 2; i++)
5052 if (sub[i] == NULL) continue;
5053 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5054 if (*ret != 0 || (i != 0 && val[i] < 0))
5056 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5057 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5063 (item_type == EITEM_HASH)?
5064 compute_hash(sub[2], val[0], val[1], &len) :
5065 (item_type == EITEM_NHASH)?
5066 compute_nhash(sub[2], val[0], val[1], &len) :
5067 extract_substr(sub[2], val[0], val[1], &len);
5069 if (ret == NULL) goto EXPAND_FAILED;
5070 yield = string_cat(yield, &size, &ptr, ret, len);
5074 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5075 This code originally contributed by Steve Haslam. It currently supports
5076 the use of MD5 and SHA-1 hashes.
5078 We need some workspace that is large enough to handle all the supported
5079 hash types. Use macros to set the sizes rather than be too elaborate. */
5081 #define MAX_HASHLEN 20
5082 #define MAX_HASHBLOCKLEN 64
5091 int hashlen; /* Number of octets for the hash algorithm's output */
5092 int hashblocklen; /* Number of octets the hash algorithm processes */
5094 unsigned int keylen;
5096 uschar keyhash[MAX_HASHLEN];
5097 uschar innerhash[MAX_HASHLEN];
5098 uschar finalhash[MAX_HASHLEN];
5099 uschar finalhash_hex[2*MAX_HASHLEN];
5100 uschar innerkey[MAX_HASHBLOCKLEN];
5101 uschar outerkey[MAX_HASHBLOCKLEN];
5103 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5105 case 1: goto EXPAND_FAILED_CURLY;
5107 case 3: goto EXPAND_FAILED;
5110 if (Ustrcmp(sub[0], "md5") == 0)
5113 use_base = &md5_base;
5117 else if (Ustrcmp(sub[0], "sha1") == 0)
5120 use_base = &sha1_base;
5126 expand_string_message =
5127 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5132 keylen = Ustrlen(keyptr);
5134 /* If the key is longer than the hash block length, then hash the key
5137 if (keylen > hashblocklen)
5139 chash_start(type, use_base);
5140 chash_end(type, use_base, keyptr, keylen, keyhash);
5145 /* Now make the inner and outer key values */
5147 memset(innerkey, 0x36, hashblocklen);
5148 memset(outerkey, 0x5c, hashblocklen);
5150 for (i = 0; i < keylen; i++)
5152 innerkey[i] ^= keyptr[i];
5153 outerkey[i] ^= keyptr[i];
5156 /* Now do the hashes */
5158 chash_start(type, use_base);
5159 chash_mid(type, use_base, innerkey);
5160 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5162 chash_start(type, use_base);
5163 chash_mid(type, use_base, outerkey);
5164 chash_end(type, use_base, innerhash, hashlen, finalhash);
5166 /* Encode the final hash as a hex string */
5169 for (i = 0; i < hashlen; i++)
5171 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5172 *p++ = hex_digits[finalhash[i] & 0x0f];
5175 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5176 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5178 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5183 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5184 We have to save the numerical variables and restore them afterwards. */
5189 int moffset, moffsetextra, slen;
5192 const uschar *rerror;
5195 int save_expand_nmax =
5196 save_expand_strings(save_expand_nstring, save_expand_nlength);
5198 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5200 case 1: goto EXPAND_FAILED_CURLY;
5202 case 3: goto EXPAND_FAILED;
5205 /* Compile the regular expression */
5207 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5212 expand_string_message = string_sprintf("regular expression error in "
5213 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5217 /* Now run a loop to do the substitutions as often as necessary. It ends
5218 when there are no more matches. Take care over matches of the null string;
5219 do the same thing as Perl does. */
5222 slen = Ustrlen(sub[0]);
5223 moffset = moffsetextra = 0;
5228 int ovector[3*(EXPAND_MAXN+1)];
5229 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5230 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5234 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5235 is not necessarily the end. We want to repeat the match from one
5236 character further along, but leaving the basic offset the same (for
5237 copying below). We can't be at the end of the string - that was checked
5238 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5239 finished; copy the remaining string and end the loop. */
5249 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5253 /* Match - set up for expanding the replacement. */
5255 if (n == 0) n = EXPAND_MAXN + 1;
5257 for (nn = 0; nn < n*2; nn += 2)
5259 expand_nstring[expand_nmax] = subject + ovector[nn];
5260 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5264 /* Copy the characters before the match, plus the expanded insertion. */
5266 yield = string_cat(yield, &size, &ptr, subject + moffset,
5267 ovector[0] - moffset);
5268 insert = expand_string(sub[2]);
5269 if (insert == NULL) goto EXPAND_FAILED;
5270 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5272 moffset = ovector[1];
5276 /* If we have matched an empty string, first check to see if we are at
5277 the end of the subject. If so, the loop is over. Otherwise, mimic
5278 what Perl's /g options does. This turns out to be rather cunning. First
5279 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5280 string at the same point. If this fails (picked up above) we advance to
5281 the next character. */
5283 if (ovector[0] == ovector[1])
5285 if (ovector[0] == slen) break;
5286 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5290 /* All done - restore numerical variables. */
5292 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5293 save_expand_nlength);
5297 /* Handle keyed and numbered substring extraction. If the first argument
5298 consists entirely of digits, then a numerical extraction is assumed. */
5304 int field_number = 1;
5305 BOOL field_number_set = FALSE;
5306 uschar *save_lookup_value = lookup_value;
5308 int save_expand_nmax =
5309 save_expand_strings(save_expand_nstring, save_expand_nlength);
5311 /* Read the arguments */
5313 for (i = 0; i < j; i++)
5315 while (isspace(*s)) s++;
5316 if (*s == '{') /*}*/
5318 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5319 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5320 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5322 /* After removal of leading and trailing white space, the first
5323 argument must not be empty; if it consists entirely of digits
5324 (optionally preceded by a minus sign), this is a numerical
5325 extraction, and we expect 3 arguments. */
5333 while (isspace(*p)) p++;
5337 while (len > 0 && isspace(p[len-1])) len--;
5344 expand_string_message = US"first argument of \"extract\" must "
5354 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5358 j = 3; /* Need 3 args */
5359 field_number_set = TRUE;
5364 else goto EXPAND_FAILED_CURLY;
5367 /* Extract either the numbered or the keyed substring into $value. If
5368 skipping, just pretend the extraction failed. */
5370 lookup_value = skipping? NULL : field_number_set?
5371 expand_gettokened(field_number, sub[1], sub[2]) :
5372 expand_getkeyed(sub[0], sub[1]);
5374 /* If no string follows, $value gets substituted; otherwise there can
5375 be yes/no strings, as for lookup or if. */
5377 switch(process_yesno(
5378 skipping, /* were previously skipping */
5379 lookup_value != NULL, /* success/failure indicator */
5380 save_lookup_value, /* value to reset for string2 */
5381 &s, /* input pointer */
5382 &yield, /* output pointer */
5383 &size, /* output size */
5384 &ptr, /* output current point */
5385 US"extract", /* condition type */
5388 case 1: goto EXPAND_FAILED; /* when all is well, the */
5389 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5392 /* All done - restore numerical variables. */
5394 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5395 save_expand_nlength);
5400 /* return the Nth item from a list */
5402 case EITEM_LISTEXTRACT:
5405 int field_number = 1;
5406 uschar *save_lookup_value = lookup_value;
5408 int save_expand_nmax =
5409 save_expand_strings(save_expand_nstring, save_expand_nlength);
5411 /* Read the field & list arguments */
5413 for (i = 0; i < 2; i++)
5415 while (isspace(*s)) s++;
5416 if (*s != '{') /*}*/
5417 goto EXPAND_FAILED_CURLY;
5419 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5420 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5421 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5423 /* After removal of leading and trailing white space, the first
5424 argument must be numeric and nonempty. */
5432 while (isspace(*p)) p++;
5436 while (len > 0 && isspace(p[len-1])) len--;
5439 if (!*p && !skipping)
5441 expand_string_message = US"first argument of \"listextract\" must "
5451 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5454 expand_string_message = US"first argument of \"listextract\" must "
5462 /* Extract the numbered element into $value. If
5463 skipping, just pretend the extraction failed. */
5465 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5467 /* If no string follows, $value gets substituted; otherwise there can
5468 be yes/no strings, as for lookup or if. */
5470 switch(process_yesno(
5471 skipping, /* were previously skipping */
5472 lookup_value != NULL, /* success/failure indicator */
5473 save_lookup_value, /* value to reset for string2 */
5474 &s, /* input pointer */
5475 &yield, /* output pointer */
5476 &size, /* output size */
5477 &ptr, /* output current point */
5478 US"listextract", /* condition type */
5481 case 1: goto EXPAND_FAILED; /* when all is well, the */
5482 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5485 /* All done - restore numerical variables. */
5487 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5488 save_expand_nlength);
5494 case EITEM_CERTEXTRACT:
5496 uschar *save_lookup_value = lookup_value;
5498 int save_expand_nmax =
5499 save_expand_strings(save_expand_nstring, save_expand_nlength);
5501 /* Read the field argument */
5502 while (isspace(*s)) s++;
5503 if (*s != '{') /*}*/
5504 goto EXPAND_FAILED_CURLY;
5505 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5506 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5507 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5508 /* strip spaces fore & aft */
5513 while (isspace(*p)) p++;
5517 while (len > 0 && isspace(p[len-1])) len--;
5521 /* inspect the cert argument */
5522 while (isspace(*s)) s++;
5523 if (*s != '{') /*}*/
5524 goto EXPAND_FAILED_CURLY;
5527 expand_string_message = US"second argument of \"certextract\" must "
5528 "be a certificate variable";
5531 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5532 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5533 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5536 lookup_value = NULL;
5539 lookup_value = expand_getcertele(sub[0], sub[1]);
5540 if (*expand_string_message) goto EXPAND_FAILED;
5542 switch(process_yesno(
5543 skipping, /* were previously skipping */
5544 lookup_value != NULL, /* success/failure indicator */
5545 save_lookup_value, /* value to reset for string2 */
5546 &s, /* input pointer */
5547 &yield, /* output pointer */
5548 &size, /* output size */
5549 &ptr, /* output current point */
5550 US"certextract", /* condition type */
5553 case 1: goto EXPAND_FAILED; /* when all is well, the */
5554 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5557 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5558 save_expand_nlength);
5561 #endif /*SUPPORT_TLS*/
5563 /* Handle list operations */
5571 uschar outsep[2] = { '\0', '\0' };
5572 const uschar *list, *expr, *temp;
5573 uschar *save_iterate_item = iterate_item;
5574 uschar *save_lookup_value = lookup_value;
5576 while (isspace(*s)) s++;
5577 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5579 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5580 if (list == NULL) goto EXPAND_FAILED;
5581 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5583 if (item_type == EITEM_REDUCE)
5586 while (isspace(*s)) s++;
5587 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5588 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5589 if (!t) goto EXPAND_FAILED;
5591 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5594 while (isspace(*s)) s++;
5595 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5599 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5600 if scanning a "false" part). This allows us to find the end of the
5601 condition, because if the list is empty, we won't actually evaluate the
5602 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5603 the normal internal expansion function. */
5605 if (item_type == EITEM_FILTER)
5607 temp = eval_condition(expr, &resetok, NULL);
5608 if (temp != NULL) s = temp;
5611 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5615 expand_string_message = string_sprintf("%s inside \"%s\" item",
5616 expand_string_message, name);
5620 while (isspace(*s)) s++;
5623 expand_string_message = string_sprintf("missing } at end of condition "
5624 "or expression inside \"%s\"", name);
5628 while (isspace(*s)) s++; /*{*/
5631 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5636 /* If we are skipping, we can now just move on to the next item. When
5637 processing for real, we perform the iteration. */
5639 if (skipping) continue;
5640 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5642 *outsep = (uschar)sep; /* Separator as a string */
5644 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5646 if (item_type == EITEM_FILTER)
5649 if (eval_condition(expr, &resetok, &condresult) == NULL)
5651 iterate_item = save_iterate_item;
5652 lookup_value = save_lookup_value;
5653 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5654 expand_string_message, name);
5657 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5658 condresult? "true":"false");
5660 temp = iterate_item; /* TRUE => include this item */
5662 continue; /* FALSE => skip this item */
5665 /* EITEM_MAP and EITEM_REDUCE */
5669 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5673 iterate_item = save_iterate_item;
5674 expand_string_message = string_sprintf("%s inside \"%s\" item",
5675 expand_string_message, name);
5678 if (item_type == EITEM_REDUCE)
5680 lookup_value = t; /* Update the value of $value */
5681 continue; /* and continue the iteration */
5685 /* We reach here for FILTER if the condition is true, always for MAP,
5686 and never for REDUCE. The value in "temp" is to be added to the output
5687 list that is being created, ensuring that any occurrences of the
5688 separator character are doubled. Unless we are dealing with the first
5689 item of the output list, add in a space if the new item begins with the
5690 separator character, or is an empty string. */
5692 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5693 yield = string_cat(yield, &size, &ptr, US" ", 1);
5695 /* Add the string in "temp" to the output list that we are building,
5696 This is done in chunks by searching for the separator character. */
5700 size_t seglen = Ustrcspn(temp, outsep);
5701 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5703 /* If we got to the end of the string we output one character
5704 too many; backup and end the loop. Otherwise arrange to double the
5707 if (temp[seglen] == '\0') { ptr--; break; }
5708 yield = string_cat(yield, &size, &ptr, outsep, 1);
5712 /* Output a separator after the string: we will remove the redundant
5713 final one at the end. */
5715 yield = string_cat(yield, &size, &ptr, outsep, 1);
5716 } /* End of iteration over the list loop */
5718 /* REDUCE has generated no output above: output the final value of
5721 if (item_type == EITEM_REDUCE)
5723 yield = string_cat(yield, &size, &ptr, lookup_value,
5724 Ustrlen(lookup_value));
5725 lookup_value = save_lookup_value; /* Restore $value */
5728 /* FILTER and MAP generate lists: if they have generated anything, remove
5729 the redundant final separator. Even though an empty item at the end of a
5730 list does not count, this is tidier. */
5732 else if (ptr != save_ptr) ptr--;
5734 /* Restore preserved $item */
5736 iterate_item = save_iterate_item;
5743 const uschar *srclist, *cmp, *xtract;
5745 const uschar *dstlist = NULL, *dstkeylist = NULL;
5747 uschar *save_iterate_item = iterate_item;
5749 while (isspace(*s)) s++;
5750 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5752 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5753 if (!srclist) goto EXPAND_FAILED;
5754 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5756 while (isspace(*s)) s++;
5757 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5759 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5760 if (!cmp) goto EXPAND_FAILED;
5761 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5763 while (isspace(*s)) s++;
5764 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5767 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5768 if (!tmp) goto EXPAND_FAILED;
5769 xtract = string_copyn(xtract, s - xtract);
5771 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5775 expand_string_message = US"missing } at end of \"sort\"";
5779 if (skipping) continue;
5781 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5784 uschar * newlist = NULL;
5785 uschar * newkeylist = NULL;
5788 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, srcitem);
5790 /* extract field for comparisons */
5791 iterate_item = srcitem;
5792 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5796 expand_string_message = string_sprintf(
5797 "field-extract in sort: \"%s\"", xtract);
5801 /* Insertion sort */
5803 /* copy output list until new-item < list-item */
5804 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5810 /* field for comparison */
5811 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5814 /* build and run condition string */
5815 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
5817 DEBUG(D_expand) debug_printf("%s: cond = \"%s\"\n", name, expr);
5818 if (!eval_condition(expr, &resetok, &before))
5820 expand_string_message = string_sprintf("comparison in sort: %s",
5827 /* New-item sorts before this dst-item. Append new-item,
5828 then dst-item, then remainder of dst list. */
5830 newlist = string_append_listele(newlist, sep, srcitem);
5831 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5834 newlist = string_append_listele(newlist, sep, dstitem);
5835 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5837 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5839 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5841 newlist = string_append_listele(newlist, sep, dstitem);
5842 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5848 newlist = string_append_listele(newlist, sep, dstitem);
5849 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5852 /* If we ran out of dstlist without consuming srcitem, append it */
5855 newlist = string_append_listele(newlist, sep, srcitem);
5856 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5860 dstkeylist = newkeylist;
5862 DEBUG(D_expand) debug_printf("%s: dstlist = \"%s\"\n", name, dstlist);
5863 DEBUG(D_expand) debug_printf("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
5867 yield = string_cat(yield, &size, &ptr, dstlist, Ustrlen(dstlist));
5869 /* Restore preserved $item */
5870 iterate_item = save_iterate_item;
5874 expand_string_message = US"Internal error in sort (list mismatch)";
5879 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5880 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5881 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5882 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5884 #define EXPAND_DLFUNC_MAX_ARGS 8
5887 #ifndef EXPAND_DLFUNC
5888 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5889 "is not included in this binary";
5892 #else /* EXPAND_DLFUNC */
5895 exim_dlfunc_t *func;
5898 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5900 if ((expand_forbid & RDO_DLFUNC) != 0)
5902 expand_string_message =
5903 US"dynamically-loaded functions are not permitted";
5907 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5908 TRUE, US"dlfunc", &resetok))
5910 case 1: goto EXPAND_FAILED_CURLY;
5912 case 3: goto EXPAND_FAILED;
5915 /* If skipping, we don't actually do anything */
5917 if (skipping) continue;
5919 /* Look up the dynamically loaded object handle in the tree. If it isn't
5920 found, dlopen() the file and put the handle in the tree for next time. */
5922 t = tree_search(dlobj_anchor, argv[0]);
5925 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5928 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5929 argv[0], dlerror());
5930 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5933 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5934 Ustrcpy(t->name, argv[0]);
5935 t->data.ptr = handle;
5936 (void)tree_insertnode(&dlobj_anchor, t);
5939 /* Having obtained the dynamically loaded object handle, look up the
5940 function pointer. */
5942 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5945 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5946 "%s", argv[1], argv[0], dlerror());
5947 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5951 /* Call the function and work out what to do with the result. If it
5952 returns OK, we have a replacement string; if it returns DEFER then
5953 expansion has failed in a non-forced manner; if it returns FAIL then
5954 failure was forced; if it returns ERROR or any other value there's a
5955 problem, so panic slightly. In any case, assume that the function has
5956 side-effects on the store that must be preserved. */
5960 for (argc = 0; argv[argc] != NULL; argc++);
5961 status = func(&result, argc - 2, &argv[2]);
5964 if (result == NULL) result = US"";
5965 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5970 expand_string_message = result == NULL ? US"(no message)" : result;
5971 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5972 else if(status != FAIL)
5973 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5974 argv[0], argv[1], status, expand_string_message);
5978 #endif /* EXPAND_DLFUNC */
5980 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
5983 uschar *save_lookup_value = lookup_value;
5985 while (isspace(*s)) s++;
5986 if (*s != '{') /*}*/
5989 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5990 if (!key) goto EXPAND_FAILED; /*{*/
5991 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5993 lookup_value = US getenv(CS key);
5995 switch(process_yesno(
5996 skipping, /* were previously skipping */
5997 lookup_value != NULL, /* success/failure indicator */
5998 save_lookup_value, /* value to reset for string2 */
5999 &s, /* input pointer */
6000 &yield, /* output pointer */
6001 &size, /* output size */
6002 &ptr, /* output current point */
6003 US"env", /* condition type */
6006 case 1: goto EXPAND_FAILED; /* when all is well, the */
6007 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6011 } /* EITEM_* switch */
6013 /* Control reaches here if the name is not recognized as one of the more
6014 complicated expansion items. Check for the "operator" syntax (name terminated
6015 by a colon). Some of the operators have arguments, separated by _ from the
6023 var_entry *vp = NULL;
6025 /* Owing to an historical mis-design, an underscore may be part of the
6026 operator name, or it may introduce arguments. We therefore first scan the
6027 table of names that contain underscores. If there is no match, we cut off
6028 the arguments and then scan the main table. */
6030 if ((c = chop_match(name, op_table_underscore,
6031 nelem(op_table_underscore))) < 0)
6033 arg = Ustrchr(name, '_');
6034 if (arg != NULL) *arg = 0;
6035 c = chop_match(name, op_table_main, nelem(op_table_main));
6036 if (c >= 0) c += nelem(op_table_underscore);
6037 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6040 /* Deal specially with operators that might take a certificate variable
6041 as we do not want to do the usual expansion. For most, expand the string.*/
6051 const uschar * s1 = s;
6052 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6054 if (!sub) goto EXPAND_FAILED; /*{*/
6055 if (*s1 != '}') goto EXPAND_FAILED_CURLY;
6056 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6066 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6067 if (!sub) goto EXPAND_FAILED;
6072 /* If we are skipping, we don't need to perform the operation at all.
6073 This matters for operations like "mask", because the data may not be
6074 in the correct format when skipping. For example, the expression may test
6075 for the existence of $sender_host_address before trying to mask it. For
6076 other operations, doing them may not fail, but it is a waste of time. */
6078 if (skipping && c >= 0) continue;
6080 /* Otherwise, switch on the operator type */
6087 unsigned long int n = Ustrtoul(sub, &t, 10);
6090 expand_string_message = string_sprintf("argument for base62 "
6091 "operator is \"%s\", which is not a decimal number", sub);
6094 t = string_base62(n);
6095 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6099 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6105 unsigned long int n = 0;
6108 uschar *t = Ustrchr(base62_chars, *tt++);
6111 expand_string_message = string_sprintf("argument for base62d "
6112 "operator is \"%s\", which is not a base %d number", sub,
6116 n = n * BASE_62 + (t - base62_chars);
6118 (void)sprintf(CS buf, "%ld", n);
6119 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
6125 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6126 if (expanded == NULL)
6128 expand_string_message =
6129 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6130 expand_string_message);
6133 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
6140 uschar *t = sub - 1;
6141 while (*(++t) != 0) { *t = tolower(*t); count++; }
6142 yield = string_cat(yield, &size, &ptr, sub, count);
6149 uschar *t = sub - 1;
6150 while (*(++t) != 0) { *t = toupper(*t); count++; }
6151 yield = string_cat(yield, &size, &ptr, sub, count);
6157 if (vp && *(void **)vp->value)
6159 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6160 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6170 md5_end(&base, sub, Ustrlen(sub), digest);
6171 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6172 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6178 if (vp && *(void **)vp->value)
6180 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6181 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6191 sha1_end(&base, sub, Ustrlen(sub), digest);
6192 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6193 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6199 if (vp && *(void **)vp->value)
6201 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6202 yield = string_cat(yield, &size, &ptr, cp, (int)Ustrlen(cp));
6206 expand_string_message = US"sha256 only supported for certificates";
6209 /* Convert hex encoding to base64 encoding */
6219 for (enc = sub; *enc != 0; enc++)
6221 if (!isxdigit(*enc))
6223 expand_string_message = string_sprintf("\"%s\" is not a hex "
6232 expand_string_message = string_sprintf("\"%s\" contains an odd "
6233 "number of characters", sub);
6237 while ((c = *in++) != 0)
6239 if (isdigit(c)) c -= '0';
6240 else c = toupper(c) - 'A' + 10;
6252 enc = b64encode(sub, out - sub);
6253 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
6257 /* Convert octets outside 0x21..0x7E to \xXX form */
6261 uschar *t = sub - 1;
6264 if (*t < 0x21 || 0x7E < *t)
6265 yield = string_cat(yield, &size, &ptr,
6266 string_sprintf("\\x%02x", *t), 4);
6268 yield = string_cat(yield, &size, &ptr, t, 1);
6273 /* count the number of list elements */
6282 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6283 cp = string_sprintf("%d", cnt);
6284 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6288 /* expand a named list given the name */
6289 /* handles nested named lists; requotes as colon-sep list */
6293 tree_node *t = NULL;
6294 const uschar * list;
6297 uschar * suffix = US"";
6298 BOOL needsep = FALSE;
6301 if (*sub == '+') sub++;
6302 if (arg == NULL) /* no-argument version */
6304 if (!(t = tree_search(addresslist_anchor, sub)) &&
6305 !(t = tree_search(domainlist_anchor, sub)) &&
6306 !(t = tree_search(hostlist_anchor, sub)))
6307 t = tree_search(localpartlist_anchor, sub);
6309 else switch(*arg) /* specific list-type version */
6311 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6312 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6313 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6314 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6316 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6322 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6324 : *arg=='a'?"address "
6325 : *arg=='d'?"domain "
6327 : *arg=='l'?"localpart "
6332 list = ((namedlist_block *)(t->data.ptr))->string;
6334 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6336 uschar * buf = US" : ";
6338 yield = string_cat(yield, &size, &ptr, buf, 3);
6342 if (*item == '+') /* list item is itself a named list */
6344 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6345 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6347 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6351 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6352 while ((cp= strpbrk((const char *)item, tok)))
6354 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
6355 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6357 yield = string_cat(yield, &size, &ptr, US"::", 2);
6358 item = (uschar *)cp;
6360 else /* sep in item; should already be doubled; emit once */
6362 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
6363 if (*cp == sep) cp++;
6364 item = (uschar *)cp;
6368 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
6373 /* mask applies a mask to an IP address; for example the result of
6374 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6381 int mask, maskoffset;
6382 int type = string_is_ip_address(sub, &maskoffset);
6387 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6392 if (maskoffset == 0)
6394 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6399 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6401 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6403 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6408 /* Convert the address to binary integer(s) and apply the mask */
6410 sub[maskoffset] = 0;
6411 count = host_aton(sub, binary);
6412 host_mask(count, binary, mask);
6414 /* Convert to masked textual format and add to output. */
6416 yield = string_cat(yield, &size, &ptr, buffer,
6417 host_nmtoa(count, binary, mask, buffer, '.'));
6422 case EOP_IPV6DENORM:
6424 int type = string_is_ip_address(sub, NULL);
6431 (void) host_aton(sub, binary);
6434 case 4: /* convert to IPv4-mapped IPv6 */
6435 binary[0] = binary[1] = 0;
6436 binary[2] = 0x0000ffff;
6437 (void) host_aton(sub, binary+3);
6441 expand_string_message =
6442 string_sprintf("\"%s\" is not an IP address", sub);
6446 yield = string_cat(yield, &size, &ptr, buffer,
6448 ? ipv6_nmtoa(binary, buffer)
6449 : host_nmtoa(4, binary, -1, buffer, ':')
6455 case EOP_LOCAL_PART:
6459 int start, end, domain;
6460 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6464 if (c != EOP_DOMAIN)
6466 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6467 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
6469 else if (domain != 0)
6472 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
6480 uschar outsep[2] = { ':', '\0' };
6481 uschar *address, *error;
6483 int start, end, domain; /* Not really used */
6485 while (isspace(*sub)) sub++;
6486 if (*sub == '>') { *outsep = *++sub; ++sub; }
6487 parse_allow_group = TRUE;
6491 uschar *p = parse_find_address_end(sub, FALSE);
6492 uschar saveend = *p;
6494 address = parse_extract_address(sub, &error, &start, &end, &domain,
6498 /* Add the address to the output list that we are building. This is
6499 done in chunks by searching for the separator character. At the
6500 start, unless we are dealing with the first address of the output
6501 list, add in a space if the new address begins with the separator
6502 character, or is an empty string. */
6504 if (address != NULL)
6506 if (ptr != save_ptr && address[0] == *outsep)
6507 yield = string_cat(yield, &size, &ptr, US" ", 1);
6511 size_t seglen = Ustrcspn(address, outsep);
6512 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
6514 /* If we got to the end of the string we output one character
6517 if (address[seglen] == '\0') { ptr--; break; }
6518 yield = string_cat(yield, &size, &ptr, outsep, 1);
6519 address += seglen + 1;
6522 /* Output a separator after the string: we will remove the
6523 redundant final one at the end. */
6525 yield = string_cat(yield, &size, &ptr, outsep, 1);
6528 if (saveend == '\0') break;
6532 /* If we have generated anything, remove the redundant final
6535 if (ptr != save_ptr) ptr--;
6536 parse_allow_group = FALSE;
6541 /* quote puts a string in quotes if it is empty or contains anything
6542 other than alphamerics, underscore, dot, or hyphen.
6544 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6545 be quoted in order to be a valid local part.
6547 In both cases, newlines and carriage returns are converted into \n and \r
6551 case EOP_QUOTE_LOCAL_PART:
6554 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6555 uschar *t = sub - 1;
6559 while (!needs_quote && *(++t) != 0)
6560 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6562 else /* EOP_QUOTE_LOCAL_PART */
6564 while (!needs_quote && *(++t) != 0)
6565 needs_quote = !isalnum(*t) &&
6566 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6567 (*t != '.' || t == sub || t[1] == 0);
6572 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6577 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6578 else if (*t == '\r')
6579 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6582 if (*t == '\\' || *t == '"')
6583 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6584 yield = string_cat(yield, &size, &ptr, t, 1);
6587 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6589 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6593 /* quote_lookuptype does lookup-specific quoting */
6598 uschar *opt = Ustrchr(arg, '_');
6600 if (opt != NULL) *opt++ = 0;
6602 n = search_findtype(arg, Ustrlen(arg));
6605 expand_string_message = search_error_message;
6609 if (lookup_list[n]->quote != NULL)
6610 sub = (lookup_list[n]->quote)(sub, opt);
6611 else if (opt != NULL) sub = NULL;
6615 expand_string_message = string_sprintf(
6616 "\"%s\" unrecognized after \"${quote_%s\"",
6621 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6625 /* rx quote sticks in \ before any non-alphameric character so that
6626 the insertion works in a regular expression. */
6630 uschar *t = sub - 1;
6634 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6635 yield = string_cat(yield, &size, &ptr, t, 1);
6640 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6641 prescribed by the RFC, if there are characters that need to be encoded */
6645 uschar buffer[2048];
6646 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6647 buffer, sizeof(buffer), FALSE);
6648 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6652 /* RFC 2047 decode */
6658 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6659 headers_charset, '?', &len, &error);
6662 expand_string_message = error;
6665 yield = string_cat(yield, &size, &ptr, decoded, len);
6669 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6679 if (c > 255) c = '_';
6681 yield = string_cat(yield, &size, &ptr, buff, 1);
6686 /* replace illegal UTF-8 sequences by replacement character */
6688 #define UTF8_REPLACEMENT_CHAR US"?"
6692 int seq_len = 0, index = 0;
6694 long codepoint = -1;
6695 uschar seq_buff[4]; /* accumulate utf-8 here */
6704 if ((c & 0xc0) != 0x80)
6705 /* wrong continuation byte; invalidate all bytes */
6706 complete = 1; /* error */
6709 codepoint = (codepoint << 6) | (c & 0x3f);
6710 seq_buff[index++] = c;
6711 if (--bytes_left == 0) /* codepoint complete */
6712 if(codepoint > 0x10FFFF) /* is it too large? */
6713 complete = -1; /* error (RFC3629 limit) */
6715 { /* finished; output utf-8 sequence */
6716 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6721 else /* no bytes left: new sequence */
6723 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6725 yield = string_cat(yield, &size, &ptr, &c, 1);
6728 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6730 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6735 codepoint = c & 0x1f;
6738 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6741 codepoint = c & 0x0f;
6743 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6746 codepoint = c & 0x07;
6748 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6751 seq_buff[index++] = c;
6752 seq_len = bytes_left + 1;
6753 } /* if(bytes_left) */
6757 bytes_left = index = 0;
6758 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6760 if ((complete == 1) && ((c & 0x80) == 0))
6761 /* ASCII character follows incomplete sequence */
6762 yield = string_cat(yield, &size, &ptr, &c, 1);
6768 case EOP_UTF8_DOMAIN_TO_ALABEL:
6770 uschar * error = NULL;
6771 uschar * s = string_domain_utf8_to_alabel(sub, &error);
6774 expand_string_message = string_sprintf(
6775 "error converting utf8 (%s) to alabel: %s",
6776 string_printing(sub), error);
6779 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6783 case EOP_UTF8_DOMAIN_FROM_ALABEL:
6785 uschar * error = NULL;
6786 uschar * s = string_domain_alabel_to_utf8(sub, &error);
6789 expand_string_message = string_sprintf(
6790 "error converting alabel (%s) to utf8: %s",
6791 string_printing(sub), error);
6794 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6798 case EOP_UTF8_LOCALPART_TO_ALABEL:
6800 uschar * error = NULL;
6801 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
6804 expand_string_message = string_sprintf(
6805 "error converting utf8 (%s) to alabel: %s",
6806 string_printing(sub), error);
6809 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6810 DEBUG(D_expand) debug_printf("yield: '%s'\n", yield);
6814 case EOP_UTF8_LOCALPART_FROM_ALABEL:
6816 uschar * error = NULL;
6817 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
6820 expand_string_message = string_sprintf(
6821 "error converting alabel (%s) to utf8: %s",
6822 string_printing(sub), error);
6825 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6828 #endif /* EXPERIMENTAL_INTERNATIONAL */
6830 /* escape turns all non-printing characters into escape sequences. */
6834 const uschar *t = string_printing(sub);
6835 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6839 /* Handle numeric expression evaluation */
6844 uschar *save_sub = sub;
6845 uschar *error = NULL;
6846 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6849 expand_string_message = string_sprintf("error in expression "
6850 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6854 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6855 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6859 /* Handle time period formating */
6863 int n = readconf_readtime(sub, 0, FALSE);
6866 expand_string_message = string_sprintf("string \"%s\" is not an "
6867 "Exim time interval in \"%s\" operator", sub, name);
6870 sprintf(CS var_buffer, "%d", n);
6871 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6875 case EOP_TIME_INTERVAL:
6878 uschar *t = read_number(&n, sub);
6879 if (*t != 0) /* Not A Number*/
6881 expand_string_message = string_sprintf("string \"%s\" is not a "
6882 "positive number in \"%s\" operator", sub, name);
6885 t = readconf_printtime(n);
6886 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6890 /* Convert string to base64 encoding */
6896 uschar * s = vp && *(void **)vp->value
6897 ? tls_cert_der_b64(*(void **)vp->value)
6898 : b64encode(sub, Ustrlen(sub));
6900 uschar * s = b64encode(sub, Ustrlen(sub));
6902 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6909 int len = b64decode(sub, &s);
6912 expand_string_message = string_sprintf("string \"%s\" is not "
6913 "well-formed for \"%s\" operator", sub, name);
6916 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6920 /* strlen returns the length of the string */
6925 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6926 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6930 /* length_n or l_n takes just the first n characters or the whole string,
6931 whichever is the shorter;
6933 substr_m_n, and s_m_n take n characters from offset m; negative m take
6934 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6935 takes the rest, either to the right or to the left.
6937 hash_n or h_n makes a hash of length n from the string, yielding n
6938 characters from the set a-z; hash_n_m makes a hash of length n, but
6939 uses m characters from the set a-zA-Z0-9.
6941 nhash_n returns a single number between 0 and n-1 (in text form), while
6942 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6943 between 0 and n-1 and the second between 0 and m-1. */
6963 expand_string_message = string_sprintf("missing values after %s",
6968 /* "length" has only one argument, effectively being synonymous with
6971 if (c == EOP_LENGTH || c == EOP_L)
6977 /* The others have one or two arguments; for "substr" the first may be
6978 negative. The second being negative means "not supplied". */
6983 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6986 /* Read up to two numbers, separated by underscores */
6991 if (arg != ret && *arg == '_' && pn == &value1)
6995 if (arg[1] != 0) arg++;
6997 else if (!isdigit(*arg))
6999 expand_string_message =
7000 string_sprintf("non-digit after underscore in \"%s\"", name);
7003 else *pn = (*pn)*10 + *arg++ - '0';
7007 /* Perform the required operation */
7010 (c == EOP_HASH || c == EOP_H)?
7011 compute_hash(sub, value1, value2, &len) :
7012 (c == EOP_NHASH || c == EOP_NH)?
7013 compute_nhash(sub, value1, value2, &len) :
7014 extract_substr(sub, value1, value2, &len);
7016 if (ret == NULL) goto EXPAND_FAILED;
7017 yield = string_cat(yield, &size, &ptr, ret, len);
7027 uschar **modetable[3];
7032 if ((expand_forbid & RDO_EXISTS) != 0)
7034 expand_string_message = US"Use of the stat() expansion is not permitted";
7038 if (stat(CS sub, &st) < 0)
7040 expand_string_message = string_sprintf("stat(%s) failed: %s",
7041 sub, strerror(errno));
7045 switch (mode & S_IFMT)
7047 case S_IFIFO: smode[0] = 'p'; break;
7048 case S_IFCHR: smode[0] = 'c'; break;
7049 case S_IFDIR: smode[0] = 'd'; break;
7050 case S_IFBLK: smode[0] = 'b'; break;
7051 case S_IFREG: smode[0] = '-'; break;
7052 default: smode[0] = '?'; break;
7055 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7056 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7057 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7059 for (i = 0; i < 3; i++)
7061 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7066 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7067 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7068 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7069 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7070 (long)st.st_gid, st.st_size, (long)st.st_atime,
7071 (long)st.st_mtime, (long)st.st_ctime);
7072 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
7076 /* vaguely random number less than N */
7080 int_eximarith_t max;
7083 max = expanded_string_integer(sub, TRUE);
7084 if (expand_string_message != NULL)
7086 s = string_sprintf("%d", vaguely_random_number((int)max));
7087 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
7091 /* Reverse IP, including IPv6 to dotted-nibble */
7093 case EOP_REVERSE_IP:
7095 int family, maskptr;
7096 uschar reversed[128];
7098 family = string_is_ip_address(sub, &maskptr);
7101 expand_string_message = string_sprintf(
7102 "reverse_ip() not given an IP address [%s]", sub);
7105 invert_address(reversed, sub);
7106 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
7110 /* Unknown operator */
7113 expand_string_message =
7114 string_sprintf("unknown expansion operator \"%s\"", name);
7119 /* Handle a plain name. If this is the first thing in the expansion, release
7120 the pre-allocated buffer. If the result data is known to be in a new buffer,
7121 newsize will be set to the size of that buffer, and we can just point at that
7122 store instead of copying. Many expansion strings contain just one reference,
7123 so this is a useful optimization, especially for humungous headers
7124 ($message_headers). */
7132 if (resetok) store_reset(yield);
7136 value = find_variable(name, FALSE, skipping, &newsize);
7139 expand_string_message =
7140 string_sprintf("unknown variable in \"${%s}\"", name);
7141 check_variable_error_message(name);
7144 len = Ustrlen(value);
7145 if (yield == NULL && newsize != 0)
7151 else yield = string_cat(yield, &size, &ptr, value, len);
7155 /* Else there's something wrong */
7157 expand_string_message =
7158 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7159 "in a variable reference)", name);
7163 /* If we hit the end of the string when ket_ends is set, there is a missing
7164 terminating brace. */
7166 if (ket_ends && *s == 0)
7168 expand_string_message = malformed_header?
7169 US"missing } at end of string - could be header name not terminated by colon"
7171 US"missing } at end of string";
7175 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7176 added to the string. If so, set up an empty string. Add a terminating zero. If
7177 left != NULL, return a pointer to the terminator. */
7179 if (yield == NULL) yield = store_get(1);
7181 if (left != NULL) *left = s;
7183 /* Any stacking store that was used above the final string is no longer needed.
7184 In many cases the final string will be the first one that was got and so there
7185 will be optimal store usage. */
7187 if (resetok) store_reset(yield + ptr + 1);
7188 else if (resetok_p) *resetok_p = FALSE;
7192 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
7194 if (skipping) debug_printf("skipping: result is not used\n");
7198 /* This is the failure exit: easiest to program with a goto. We still need
7199 to update the pointer to the terminator, for cases of nested calls with "fail".
7202 EXPAND_FAILED_CURLY:
7203 expand_string_message = malformed_header?
7204 US"missing or misplaced { or } - could be header name not terminated by colon"
7206 US"missing or misplaced { or }";
7208 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7209 that is a bad idea, because expand_string_message is in dynamic store. */
7212 if (left != NULL) *left = s;
7215 debug_printf("failed to expand: %s\n", string);
7216 debug_printf(" error message: %s\n", expand_string_message);
7217 if (expand_string_forcedfail) debug_printf("failure was forced\n");
7219 if (resetok_p) *resetok_p = resetok;
7224 /* This is the external function call. Do a quick check for any expansion
7225 metacharacters, and if there are none, just return the input string.
7227 Argument: the string to be expanded
7228 Returns: the expanded string, or NULL if expansion failed; if failure was
7229 due to a lookup deferring, search_find_defer will be TRUE
7233 expand_string(uschar *string)
7235 search_find_defer = FALSE;
7236 malformed_header = FALSE;
7237 return (Ustrpbrk(string, "$\\") == NULL)? string :
7238 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7244 expand_cstring(const uschar *string)
7246 search_find_defer = FALSE;
7247 malformed_header = FALSE;
7248 return (Ustrpbrk(string, "$\\") == NULL)? string :
7249 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7254 /*************************************************
7256 *************************************************/
7258 /* Now and again we want to expand a string and be sure that the result is in a
7259 new bit of store. This function does that.
7260 Since we know it has been copied, the de-const cast is safe.
7262 Argument: the string to be expanded
7263 Returns: the expanded string, always in a new bit of store, or NULL
7267 expand_string_copy(const uschar *string)
7269 const uschar *yield = expand_cstring(string);
7270 if (yield == string) yield = string_copy(string);
7276 /*************************************************
7277 * Expand and interpret as an integer *
7278 *************************************************/
7280 /* Expand a string, and convert the result into an integer.
7283 string the string to be expanded
7284 isplus TRUE if a non-negative number is expected
7286 Returns: the integer value, or
7287 -1 for an expansion error ) in both cases, message in
7288 -2 for an integer interpretation error ) expand_string_message
7289 expand_string_message is set NULL for an OK integer
7293 expand_string_integer(uschar *string, BOOL isplus)
7295 return expanded_string_integer(expand_string(string), isplus);
7299 /*************************************************
7300 * Interpret string as an integer *
7301 *************************************************/
7303 /* Convert a string (that has already been expanded) into an integer.
7305 This function is used inside the expansion code.
7308 s the string to be expanded
7309 isplus TRUE if a non-negative number is expected
7311 Returns: the integer value, or
7312 -1 if string is NULL (which implies an expansion error)
7313 -2 for an integer interpretation error
7314 expand_string_message is set NULL for an OK integer
7317 static int_eximarith_t
7318 expanded_string_integer(const uschar *s, BOOL isplus)
7320 int_eximarith_t value;
7321 uschar *msg = US"invalid integer \"%s\"";
7324 /* If expansion failed, expand_string_message will be set. */
7326 if (s == NULL) return -1;
7328 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7329 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7330 systems, so we set it zero ourselves. */
7333 expand_string_message = NULL; /* Indicates no error */
7335 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7336 equal to 0. Unfortunately, people actually relied upon that, so preserve
7337 the behaviour explicitly. Stripping leading whitespace is a harmless
7338 noop change since strtol skips it anyway (provided that there is a number
7342 while (isspace(*s)) ++s;
7346 debug_printf("treating blank string as number 0\n");
7351 value = strtoll(CS s, CSS &endptr, 10);
7355 msg = US"integer expected but \"%s\" found";
7357 else if (value < 0 && isplus)
7359 msg = US"non-negative integer expected but \"%s\" found";
7363 switch (tolower(*endptr))
7368 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7373 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7374 else value *= 1024*1024;
7378 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7379 else value *= 1024*1024*1024;
7383 if (errno == ERANGE)
7384 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7387 while (isspace(*endptr)) endptr++;
7388 if (*endptr == 0) return value;
7392 expand_string_message = string_sprintf(CS msg, s);
7397 /* These values are usually fixed boolean values, but they are permitted to be
7401 addr address being routed
7402 mtype the module type
7403 mname the module name
7404 dbg_opt debug selectors
7405 oname the option name
7406 bvalue the router's boolean value
7407 svalue the router's string value
7408 rvalue where to put the returned value
7410 Returns: OK value placed in rvalue
7411 DEFER expansion failed
7415 exp_bool(address_item *addr,
7416 uschar *mtype, uschar *mname, unsigned dbg_opt,
7417 uschar *oname, BOOL bvalue,
7418 uschar *svalue, BOOL *rvalue)
7421 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7423 expanded = expand_string(svalue);
7424 if (expanded == NULL)
7426 if (expand_string_forcedfail)
7428 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7432 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7433 oname, mname, mtype, expand_string_message);
7434 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7438 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7441 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7443 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7447 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7448 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7458 /*************************************************
7459 **************************************************
7460 * Stand-alone test program *
7461 **************************************************
7462 *************************************************/
7468 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7470 int ovector[3*(EXPAND_MAXN+1)];
7471 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7472 ovector, nelem(ovector));
7473 BOOL yield = n >= 0;
7474 if (n == 0) n = EXPAND_MAXN + 1;
7478 expand_nmax = (setup < 0)? 0 : setup + 1;
7479 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7481 expand_nstring[expand_nmax] = subject + ovector[nn];
7482 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7490 int main(int argc, uschar **argv)
7493 uschar buffer[1024];
7495 debug_selector = D_v;
7496 debug_file = stderr;
7497 debug_fd = fileno(debug_file);
7498 big_buffer = malloc(big_buffer_size);
7500 for (i = 1; i < argc; i++)
7502 if (argv[i][0] == '+')
7504 debug_trace_memory = 2;
7507 if (isdigit(argv[i][0]))
7508 debug_selector = Ustrtol(argv[i], NULL, 0);
7510 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7514 eldap_default_servers = argv[i];
7517 mysql_servers = argv[i];
7520 pgsql_servers = argv[i];
7523 redis_servers = argv[i];
7527 else opt_perl_startup = argv[i];
7531 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7533 expand_nstring[1] = US"string 1....";
7534 expand_nlength[1] = 8;
7538 if (opt_perl_startup != NULL)
7541 printf("Starting Perl interpreter\n");
7542 errstr = init_perl(opt_perl_startup);
7545 printf("** error in perl_startup code: %s\n", errstr);
7546 return EXIT_FAILURE;
7549 #endif /* EXIM_PERL */
7551 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7553 void *reset_point = store_get(0);
7554 uschar *yield = expand_string(buffer);
7557 printf("%s\n", yield);
7558 store_reset(reset_point);
7562 if (search_find_defer) printf("search_find deferred\n");
7563 printf("Failed: %s\n", expand_string_message);
7564 if (expand_string_forcedfail) printf("Forced failure\n");
7578 /* End of expand.c */