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[] = {
244 EOP_ADDRESS = nelem(op_table_underscore),
288 /* Table of condition names, and corresponding switch numbers. The names must
289 be in alphabetical order. */
291 static uschar *cond_table[] = {
295 US"==", /* Backward compatibility */
328 US"match_local_part",
353 ECOND_FIRST_DELIVERY,
374 ECOND_MATCH_LOCAL_PART,
384 /* Types of table entry */
387 vtype_int, /* value is address of int */
388 vtype_filter_int, /* ditto, but recognized only when filtering */
389 vtype_ino, /* value is address of ino_t (not always an int) */
390 vtype_uid, /* value is address of uid_t (not always an int) */
391 vtype_gid, /* value is address of gid_t (not always an int) */
392 vtype_bool, /* value is address of bool */
393 vtype_stringptr, /* value is address of pointer to string */
394 vtype_msgbody, /* as stringptr, but read when first required */
395 vtype_msgbody_end, /* ditto, the end of the message */
396 vtype_msgheaders, /* the message's headers, processed */
397 vtype_msgheaders_raw, /* the message's headers, unprocessed */
398 vtype_localpart, /* extract local part from string */
399 vtype_domain, /* extract domain from string */
400 vtype_string_func, /* value is string returned by given function */
401 vtype_todbsdin, /* value not used; generate BSD inbox tod */
402 vtype_tode, /* value not used; generate tod in epoch format */
403 vtype_todel, /* value not used; generate tod in epoch/usec format */
404 vtype_todf, /* value not used; generate full tod */
405 vtype_todl, /* value not used; generate log tod */
406 vtype_todlf, /* value not used; generate log file datestamp tod */
407 vtype_todzone, /* value not used; generate time zone only */
408 vtype_todzulu, /* value not used; generate zulu tod */
409 vtype_reply, /* value not used; get reply from headers */
410 vtype_pid, /* value not used; result is pid */
411 vtype_host_lookup, /* value not used; get host name */
412 vtype_load_avg, /* value not used; result is int from os_getloadavg */
413 vtype_pspace, /* partition space; value is T/F for spool/log */
414 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
415 vtype_cert /* SSL certificate */
417 ,vtype_dkim /* Lookup of value in DKIM signature */
421 /* Type for main variable table */
429 /* Type for entries pointing to address/length pairs. Not currently
437 static uschar * fn_recipients(void);
439 /* This table must be kept in alphabetical order. */
441 static var_entry var_table[] = {
442 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
443 they will be confused with user-creatable ACL variables. */
444 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
445 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
446 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
447 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
448 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
449 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
450 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
451 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
452 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
453 { "acl_narg", vtype_int, &acl_narg },
454 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
455 { "address_data", vtype_stringptr, &deliver_address_data },
456 { "address_file", vtype_stringptr, &address_file },
457 { "address_pipe", vtype_stringptr, &address_pipe },
458 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
459 { "authenticated_id", vtype_stringptr, &authenticated_id },
460 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
461 { "authentication_failed",vtype_int, &authentication_failed },
462 #ifdef WITH_CONTENT_SCAN
463 { "av_failed", vtype_int, &av_failed },
465 #ifdef EXPERIMENTAL_BRIGHTMAIL
466 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
467 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
468 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
469 { "bmi_deliver", vtype_int, &bmi_deliver },
471 { "body_linecount", vtype_int, &body_linecount },
472 { "body_zerocount", vtype_int, &body_zerocount },
473 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
474 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
475 { "caller_gid", vtype_gid, &real_gid },
476 { "caller_uid", vtype_uid, &real_uid },
477 { "callout_address", vtype_stringptr, &callout_address },
478 { "compile_date", vtype_stringptr, &version_date },
479 { "compile_number", vtype_stringptr, &version_cnumber },
480 { "config_dir", vtype_stringptr, &config_main_directory },
481 { "config_file", vtype_stringptr, &config_main_filename },
482 { "csa_status", vtype_stringptr, &csa_status },
483 #ifdef EXPERIMENTAL_DCC
484 { "dcc_header", vtype_stringptr, &dcc_header },
485 { "dcc_result", vtype_stringptr, &dcc_result },
487 #ifdef WITH_OLD_DEMIME
488 { "demime_errorlevel", vtype_int, &demime_errorlevel },
489 { "demime_reason", vtype_stringptr, &demime_reason },
492 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
493 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
494 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
495 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
496 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
497 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
498 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
499 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
500 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
501 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
502 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
503 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
504 { "dkim_key_length", vtype_int, &dkim_key_length },
505 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
506 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
507 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
508 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
509 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
510 { "dkim_signers", vtype_stringptr, &dkim_signers },
511 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
512 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
514 #ifdef EXPERIMENTAL_DMARC
515 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
516 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
517 { "dmarc_status", vtype_stringptr, &dmarc_status },
518 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
519 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
521 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
522 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
523 { "dnslist_text", vtype_stringptr, &dnslist_text },
524 { "dnslist_value", vtype_stringptr, &dnslist_value },
525 { "domain", vtype_stringptr, &deliver_domain },
526 { "domain_data", vtype_stringptr, &deliver_domain_data },
527 #ifndef DISABLE_EVENT
528 { "event_data", vtype_stringptr, &event_data },
530 /*XXX want to use generic vars for as many of these as possible*/
531 { "event_defer_errno", vtype_int, &event_defer_errno },
533 { "event_name", vtype_stringptr, &event_name },
535 { "exim_gid", vtype_gid, &exim_gid },
536 { "exim_path", vtype_stringptr, &exim_path },
537 { "exim_uid", vtype_uid, &exim_uid },
538 { "exim_version", vtype_stringptr, &version_string },
539 #ifdef WITH_OLD_DEMIME
540 { "found_extension", vtype_stringptr, &found_extension },
542 { "headers_added", vtype_string_func, &fn_hdrs_added },
543 { "home", vtype_stringptr, &deliver_home },
544 { "host", vtype_stringptr, &deliver_host },
545 { "host_address", vtype_stringptr, &deliver_host_address },
546 { "host_data", vtype_stringptr, &host_data },
547 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
548 { "host_lookup_failed", vtype_int, &host_lookup_failed },
549 { "host_port", vtype_int, &deliver_host_port },
550 { "inode", vtype_ino, &deliver_inode },
551 { "interface_address", vtype_stringptr, &interface_address },
552 { "interface_port", vtype_int, &interface_port },
553 { "item", vtype_stringptr, &iterate_item },
555 { "ldap_dn", vtype_stringptr, &eldap_dn },
557 { "load_average", vtype_load_avg, NULL },
558 { "local_part", vtype_stringptr, &deliver_localpart },
559 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
560 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
561 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
562 { "local_scan_data", vtype_stringptr, &local_scan_data },
563 { "local_user_gid", vtype_gid, &local_user_gid },
564 { "local_user_uid", vtype_uid, &local_user_uid },
565 { "localhost_number", vtype_int, &host_number },
566 { "log_inodes", vtype_pinodes, (void *)FALSE },
567 { "log_space", vtype_pspace, (void *)FALSE },
568 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
569 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
570 #ifdef WITH_CONTENT_SCAN
571 { "malware_name", vtype_stringptr, &malware_name },
573 { "max_received_linelength", vtype_int, &max_received_linelength },
574 { "message_age", vtype_int, &message_age },
575 { "message_body", vtype_msgbody, &message_body },
576 { "message_body_end", vtype_msgbody_end, &message_body_end },
577 { "message_body_size", vtype_int, &message_body_size },
578 { "message_exim_id", vtype_stringptr, &message_id },
579 { "message_headers", vtype_msgheaders, NULL },
580 { "message_headers_raw", vtype_msgheaders_raw, NULL },
581 { "message_id", vtype_stringptr, &message_id },
582 { "message_linecount", vtype_int, &message_linecount },
583 { "message_size", vtype_int, &message_size },
585 { "message_smtputf8", vtype_bool, &message_smtputf8 },
587 #ifdef WITH_CONTENT_SCAN
588 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
589 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
590 { "mime_boundary", vtype_stringptr, &mime_boundary },
591 { "mime_charset", vtype_stringptr, &mime_charset },
592 { "mime_content_description", vtype_stringptr, &mime_content_description },
593 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
594 { "mime_content_id", vtype_stringptr, &mime_content_id },
595 { "mime_content_size", vtype_int, &mime_content_size },
596 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
597 { "mime_content_type", vtype_stringptr, &mime_content_type },
598 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
599 { "mime_filename", vtype_stringptr, &mime_filename },
600 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
601 { "mime_is_multipart", vtype_int, &mime_is_multipart },
602 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
603 { "mime_part_count", vtype_int, &mime_part_count },
605 { "n0", vtype_filter_int, &filter_n[0] },
606 { "n1", vtype_filter_int, &filter_n[1] },
607 { "n2", vtype_filter_int, &filter_n[2] },
608 { "n3", vtype_filter_int, &filter_n[3] },
609 { "n4", vtype_filter_int, &filter_n[4] },
610 { "n5", vtype_filter_int, &filter_n[5] },
611 { "n6", vtype_filter_int, &filter_n[6] },
612 { "n7", vtype_filter_int, &filter_n[7] },
613 { "n8", vtype_filter_int, &filter_n[8] },
614 { "n9", vtype_filter_int, &filter_n[9] },
615 { "original_domain", vtype_stringptr, &deliver_domain_orig },
616 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
617 { "originator_gid", vtype_gid, &originator_gid },
618 { "originator_uid", vtype_uid, &originator_uid },
619 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
620 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
621 { "pid", vtype_pid, NULL },
623 { "prdr_requested", vtype_bool, &prdr_requested },
625 { "primary_hostname", vtype_stringptr, &primary_hostname },
626 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
627 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
628 { "proxy_external_port", vtype_int, &proxy_external_port },
629 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
630 { "proxy_local_port", vtype_int, &proxy_local_port },
631 { "proxy_session", vtype_bool, &proxy_session },
633 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
634 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
635 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
636 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
637 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
638 { "rcpt_count", vtype_int, &rcpt_count },
639 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
640 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
641 { "received_count", vtype_int, &received_count },
642 { "received_for", vtype_stringptr, &received_for },
643 { "received_ip_address", vtype_stringptr, &interface_address },
644 { "received_port", vtype_int, &interface_port },
645 { "received_protocol", vtype_stringptr, &received_protocol },
646 { "received_time", vtype_int, &received_time },
647 { "recipient_data", vtype_stringptr, &recipient_data },
648 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
649 { "recipients", vtype_string_func, &fn_recipients },
650 { "recipients_count", vtype_int, &recipients_count },
651 #ifdef WITH_CONTENT_SCAN
652 { "regex_match_string", vtype_stringptr, ®ex_match_string },
654 { "reply_address", vtype_reply, NULL },
655 { "return_path", vtype_stringptr, &return_path },
656 { "return_size_limit", vtype_int, &bounce_return_size_limit },
657 { "router_name", vtype_stringptr, &router_name },
658 { "runrc", vtype_int, &runrc },
659 { "self_hostname", vtype_stringptr, &self_hostname },
660 { "sender_address", vtype_stringptr, &sender_address },
661 { "sender_address_data", vtype_stringptr, &sender_address_data },
662 { "sender_address_domain", vtype_domain, &sender_address },
663 { "sender_address_local_part", vtype_localpart, &sender_address },
664 { "sender_data", vtype_stringptr, &sender_data },
665 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
666 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
667 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
668 { "sender_host_address", vtype_stringptr, &sender_host_address },
669 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
670 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
671 { "sender_host_name", vtype_host_lookup, NULL },
672 { "sender_host_port", vtype_int, &sender_host_port },
673 { "sender_ident", vtype_stringptr, &sender_ident },
674 { "sender_rate", vtype_stringptr, &sender_rate },
675 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
676 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
677 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
678 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
679 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
680 { "sending_port", vtype_int, &sending_port },
681 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
682 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
683 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
684 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
685 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
686 { "sn0", vtype_filter_int, &filter_sn[0] },
687 { "sn1", vtype_filter_int, &filter_sn[1] },
688 { "sn2", vtype_filter_int, &filter_sn[2] },
689 { "sn3", vtype_filter_int, &filter_sn[3] },
690 { "sn4", vtype_filter_int, &filter_sn[4] },
691 { "sn5", vtype_filter_int, &filter_sn[5] },
692 { "sn6", vtype_filter_int, &filter_sn[6] },
693 { "sn7", vtype_filter_int, &filter_sn[7] },
694 { "sn8", vtype_filter_int, &filter_sn[8] },
695 { "sn9", vtype_filter_int, &filter_sn[9] },
696 #ifdef WITH_CONTENT_SCAN
697 { "spam_action", vtype_stringptr, &spam_action },
698 { "spam_bar", vtype_stringptr, &spam_bar },
699 { "spam_report", vtype_stringptr, &spam_report },
700 { "spam_score", vtype_stringptr, &spam_score },
701 { "spam_score_int", vtype_stringptr, &spam_score_int },
703 #ifdef EXPERIMENTAL_SPF
704 { "spf_guess", vtype_stringptr, &spf_guess },
705 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
706 { "spf_received", vtype_stringptr, &spf_received },
707 { "spf_result", vtype_stringptr, &spf_result },
708 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
710 { "spool_directory", vtype_stringptr, &spool_directory },
711 { "spool_inodes", vtype_pinodes, (void *)TRUE },
712 { "spool_space", vtype_pspace, (void *)TRUE },
713 #ifdef EXPERIMENTAL_SRS
714 { "srs_db_address", vtype_stringptr, &srs_db_address },
715 { "srs_db_key", vtype_stringptr, &srs_db_key },
716 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
717 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
718 { "srs_recipient", vtype_stringptr, &srs_recipient },
719 { "srs_status", vtype_stringptr, &srs_status },
721 { "thisaddress", vtype_stringptr, &filter_thisaddress },
723 /* The non-(in,out) variables are now deprecated */
724 { "tls_bits", vtype_int, &tls_in.bits },
725 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
726 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
728 { "tls_in_bits", vtype_int, &tls_in.bits },
729 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
730 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
731 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
732 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
733 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
734 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
735 #if defined(SUPPORT_TLS)
736 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
738 { "tls_out_bits", vtype_int, &tls_out.bits },
739 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
740 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
741 #ifdef EXPERIMENTAL_DANE
742 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
744 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
745 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
746 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
747 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
748 #if defined(SUPPORT_TLS)
749 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
751 #ifdef EXPERIMENTAL_DANE
752 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
755 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
756 #if defined(SUPPORT_TLS)
757 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
760 { "tod_bsdinbox", vtype_todbsdin, NULL },
761 { "tod_epoch", vtype_tode, NULL },
762 { "tod_epoch_l", vtype_todel, NULL },
763 { "tod_full", vtype_todf, NULL },
764 { "tod_log", vtype_todl, NULL },
765 { "tod_logfile", vtype_todlf, NULL },
766 { "tod_zone", vtype_todzone, NULL },
767 { "tod_zulu", vtype_todzulu, NULL },
768 { "transport_name", vtype_stringptr, &transport_name },
769 { "value", vtype_stringptr, &lookup_value },
770 { "verify_mode", vtype_stringptr, &verify_mode },
771 { "version_number", vtype_stringptr, &version_string },
772 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
773 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
774 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
775 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
776 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
777 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
780 static int var_table_size = nelem(var_table);
781 static uschar var_buffer[256];
782 static BOOL malformed_header;
784 /* For textual hashes */
786 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
787 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
790 enum { HMAC_MD5, HMAC_SHA1 };
792 /* For numeric hashes */
794 static unsigned int prime[] = {
795 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
796 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
797 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
799 /* For printing modes in symbolic form */
801 static uschar *mtable_normal[] =
802 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
804 static uschar *mtable_setid[] =
805 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
807 static uschar *mtable_sticky[] =
808 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
812 /*************************************************
813 * Tables for UTF-8 support *
814 *************************************************/
816 /* Table of the number of extra characters, indexed by the first character
817 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
820 static uschar utf8_table1[] = {
821 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
822 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
823 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
824 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
826 /* These are the masks for the data bits in the first byte of a character,
827 indexed by the number of additional bytes. */
829 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
831 /* Get the next UTF-8 character, advancing the pointer. */
833 #define GETUTF8INC(c, ptr) \
835 if ((c & 0xc0) == 0xc0) \
837 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
839 c = (c & utf8_table2[a]) << s; \
843 c |= (*ptr++ & 0x3f) << s; \
849 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
851 /*************************************************
852 * Binary chop search on a table *
853 *************************************************/
855 /* This is used for matching expansion items and operators.
858 name the name that is being sought
859 table the table to search
860 table_size the number of items in the table
862 Returns: the offset in the table, or -1
866 chop_match(uschar *name, uschar **table, int table_size)
868 uschar **bot = table;
869 uschar **top = table + table_size;
873 uschar **mid = bot + (top - bot)/2;
874 int c = Ustrcmp(name, *mid);
875 if (c == 0) return mid - table;
876 if (c > 0) bot = mid + 1; else top = mid;
884 /*************************************************
885 * Check a condition string *
886 *************************************************/
888 /* This function is called to expand a string, and test the result for a "true"
889 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
890 forced fail or lookup defer.
892 We used to release all store used, but this is not not safe due
893 to ${dlfunc } and ${acl }. In any case expand_string_internal()
894 is reasonably careful to release what it can.
896 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
899 condition the condition string
900 m1 text to be incorporated in panic error
903 Returns: TRUE if condition is met, FALSE if not
907 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
910 uschar *ss = expand_string(condition);
913 if (!expand_string_forcedfail && !search_find_defer)
914 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
915 "for %s %s: %s", condition, m1, m2, expand_string_message);
918 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
919 strcmpic(ss, US"false") != 0;
926 /*************************************************
927 * Pseudo-random number generation *
928 *************************************************/
930 /* Pseudo-random number generation. The result is not "expected" to be
931 cryptographically strong but not so weak that someone will shoot themselves
932 in the foot using it as a nonce in some email header scheme or whatever
933 weirdness they'll twist this into. The result should ideally handle fork().
935 However, if we're stuck unable to provide this, then we'll fall back to
936 appallingly bad randomness.
938 If SUPPORT_TLS is defined then this will not be used except as an emergency
943 Returns a random number in range [0, max-1]
947 # define vaguely_random_number vaguely_random_number_fallback
950 vaguely_random_number(int max)
953 # undef vaguely_random_number
955 static pid_t pid = 0;
957 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
967 #ifdef HAVE_ARC4RANDOM
968 /* cryptographically strong randomness, common on *BSD platforms, not
969 so much elsewhere. Alas. */
970 #ifndef NOT_HAVE_ARC4RANDOM_STIR
973 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
974 #ifdef HAVE_SRANDOMDEV
975 /* uses random(4) for seeding */
978 gettimeofday(&tv, NULL);
979 srandom(tv.tv_sec | tv.tv_usec | getpid());
982 /* Poor randomness and no seeding here */
989 #ifdef HAVE_ARC4RANDOM
990 return arc4random() % max;
991 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
992 return random() % max;
994 /* This one returns a 16-bit number, definitely not crypto-strong */
995 return random_number(max);
1002 /*************************************************
1003 * Pick out a name from a string *
1004 *************************************************/
1006 /* If the name is too long, it is silently truncated.
1009 name points to a buffer into which to put the name
1010 max is the length of the buffer
1011 s points to the first alphabetic character of the name
1012 extras chars other than alphanumerics to permit
1014 Returns: pointer to the first character after the name
1016 Note: The test for *s != 0 in the while loop is necessary because
1017 Ustrchr() yields non-NULL if the character is zero (which is not something
1020 static const uschar *
1021 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1024 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1026 if (ptr < max-1) name[ptr++] = *s;
1035 /*************************************************
1036 * Pick out the rest of a header name *
1037 *************************************************/
1039 /* A variable name starting $header_ (or just $h_ for those who like
1040 abbreviations) might not be the complete header name because headers can
1041 contain any printing characters in their names, except ':'. This function is
1042 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1043 on the end, if the name was terminated by white space.
1046 name points to a buffer in which the name read so far exists
1047 max is the length of the buffer
1048 s points to the first character after the name so far, i.e. the
1049 first non-alphameric character after $header_xxxxx
1051 Returns: a pointer to the first character after the header name
1054 static const uschar *
1055 read_header_name(uschar *name, int max, const uschar *s)
1057 int prelen = Ustrchr(name, '_') - name + 1;
1058 int ptr = Ustrlen(name) - prelen;
1059 if (ptr > 0) memmove(name, name+prelen, ptr);
1060 while (mac_isgraph(*s) && *s != ':')
1062 if (ptr < max-1) name[ptr++] = *s;
1073 /*************************************************
1074 * Pick out a number from a string *
1075 *************************************************/
1078 n points to an integer into which to put the number
1079 s points to the first digit of the number
1081 Returns: a pointer to the character after the last digit
1085 read_number(int *n, uschar *s)
1088 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1092 static const uschar *
1093 read_cnumber(int *n, const uschar *s)
1096 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1102 /*************************************************
1103 * Extract keyed subfield from a string *
1104 *************************************************/
1106 /* The yield is in dynamic store; NULL means that the key was not found.
1109 key points to the name of the key
1110 s points to the string from which to extract the subfield
1112 Returns: NULL if the subfield was not found, or
1113 a pointer to the subfield's data
1117 expand_getkeyed(uschar *key, const uschar *s)
1119 int length = Ustrlen(key);
1120 while (isspace(*s)) s++;
1122 /* Loop to search for the key */
1128 const uschar *dkey = s;
1130 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1131 dkeylength = s - dkey;
1132 while (isspace(*s)) s++;
1133 if (*s == '=') while (isspace((*(++s))));
1135 data = string_dequote(&s);
1136 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1139 while (isspace(*s)) s++;
1148 find_var_ent(uschar * name)
1151 int last = var_table_size;
1153 while (last > first)
1155 int middle = (first + last)/2;
1156 int c = Ustrcmp(name, var_table[middle].name);
1158 if (c > 0) { first = middle + 1; continue; }
1159 if (c < 0) { last = middle; continue; }
1160 return &var_table[middle];
1165 /*************************************************
1166 * Extract numbered subfield from string *
1167 *************************************************/
1169 /* Extracts a numbered field from a string that is divided by tokens - for
1170 example a line from /etc/passwd is divided by colon characters. First field is
1171 numbered one. Negative arguments count from the right. Zero returns the whole
1172 string. Returns NULL if there are insufficient tokens in the string
1175 Modifies final argument - this is a dynamically generated string, so that's OK.
1178 field number of field to be extracted,
1179 first field = 1, whole string = 0, last field = -1
1180 separators characters that are used to break string into tokens
1181 s points to the string from which to extract the subfield
1183 Returns: NULL if the field was not found,
1184 a pointer to the field's data inside s (modified to add 0)
1188 expand_gettokened (int field, uschar *separators, uschar *s)
1193 uschar *fieldtext = NULL;
1195 if (field == 0) return s;
1197 /* Break the line up into fields in place; for field > 0 we stop when we have
1198 done the number of fields we want. For field < 0 we continue till the end of
1199 the string, counting the number of fields. */
1201 count = (field > 0)? field : INT_MAX;
1207 /* Previous field was the last one in the string. For a positive field
1208 number, this means there are not enough fields. For a negative field number,
1209 check that there are enough, and scan back to find the one that is wanted. */
1213 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1214 if ((-field) == (INT_MAX - count - 1)) return s;
1218 while (ss[-1] != 0) ss--;
1224 /* Previous field was not last in the string; save its start and put a
1228 len = Ustrcspn(ss, separators);
1239 expand_getlistele(int field, const uschar * list)
1241 const uschar * tlist= list;
1247 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1250 if(field==0) return NULL;
1251 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1252 return string_nextinlist(&list, &sep, NULL, 0);
1256 /* Certificate fields, by name. Worry about by-OID later */
1257 /* Names are chosen to not have common prefixes */
1264 uschar * (*getfn)(void * cert, uschar * mod);
1266 static certfield certfields[] =
1267 { /* linear search; no special order */
1268 { US"version", 7, &tls_cert_version },
1269 { US"serial_number", 13, &tls_cert_serial_number },
1270 { US"subject", 7, &tls_cert_subject },
1271 { US"notbefore", 9, &tls_cert_not_before },
1272 { US"notafter", 8, &tls_cert_not_after },
1273 { US"issuer", 6, &tls_cert_issuer },
1274 { US"signature", 9, &tls_cert_signature },
1275 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1276 { US"subj_altname", 12, &tls_cert_subject_altname },
1277 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1278 { US"crl_uri", 7, &tls_cert_crl_uri },
1282 expand_getcertele(uschar * field, uschar * certvar)
1287 if (!(vp = find_var_ent(certvar)))
1289 expand_string_message =
1290 string_sprintf("no variable named \"%s\"", certvar);
1291 return NULL; /* Unknown variable name */
1293 /* NB this stops us passing certs around in variable. Might
1294 want to do that in future */
1295 if (vp->type != vtype_cert)
1297 expand_string_message =
1298 string_sprintf("\"%s\" is not a certificate", certvar);
1299 return NULL; /* Unknown variable name */
1301 if (!*(void **)vp->value)
1304 if (*field >= '0' && *field <= '9')
1305 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1307 for(cp = certfields;
1308 cp < certfields + nelem(certfields);
1310 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1312 uschar * modifier = *(field += cp->namelen) == ','
1314 return (*cp->getfn)( *(void **)vp->value, modifier );
1317 expand_string_message =
1318 string_sprintf("bad field selector \"%s\" for certextract", field);
1321 #endif /*SUPPORT_TLS*/
1323 /*************************************************
1324 * Extract a substring from a string *
1325 *************************************************/
1327 /* Perform the ${substr or ${length expansion operations.
1330 subject the input string
1331 value1 the offset from the start of the input string to the start of
1332 the output string; if negative, count from the right.
1333 value2 the length of the output string, or negative (-1) for unset
1334 if value1 is positive, unset means "all after"
1335 if value1 is negative, unset means "all before"
1336 len set to the length of the returned string
1338 Returns: pointer to the output string, or NULL if there is an error
1342 extract_substr(uschar *subject, int value1, int value2, int *len)
1344 int sublen = Ustrlen(subject);
1346 if (value1 < 0) /* count from right */
1350 /* If the position is before the start, skip to the start, and adjust the
1351 length. If the length ends up negative, the substring is null because nothing
1352 can precede. This falls out naturally when the length is unset, meaning "all
1358 if (value2 < 0) value2 = 0;
1362 /* Otherwise an unset length => characters before value1 */
1364 else if (value2 < 0)
1371 /* For a non-negative offset, if the starting position is past the end of the
1372 string, the result will be the null string. Otherwise, an unset length means
1373 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1377 if (value1 > sublen)
1382 else if (value2 < 0) value2 = sublen;
1385 /* Cut the length down to the maximum possible for the offset value, and get
1386 the required characters. */
1388 if (value1 + value2 > sublen) value2 = sublen - value1;
1390 return subject + value1;
1396 /*************************************************
1397 * Old-style hash of a string *
1398 *************************************************/
1400 /* Perform the ${hash expansion operation.
1403 subject the input string (an expanded substring)
1404 value1 the length of the output string; if greater or equal to the
1405 length of the input string, the input string is returned
1406 value2 the number of hash characters to use, or 26 if negative
1407 len set to the length of the returned string
1409 Returns: pointer to the output string, or NULL if there is an error
1413 compute_hash(uschar *subject, int value1, int value2, int *len)
1415 int sublen = Ustrlen(subject);
1417 if (value2 < 0) value2 = 26;
1418 else if (value2 > Ustrlen(hashcodes))
1420 expand_string_message =
1421 string_sprintf("hash count \"%d\" too big", value2);
1425 /* Calculate the hash text. We know it is shorter than the original string, so
1426 can safely place it in subject[] (we know that subject is always itself an
1427 expanded substring). */
1429 if (value1 < sublen)
1434 while ((c = (subject[j])) != 0)
1436 int shift = (c + j++) & 7;
1437 subject[i] ^= (c << shift) | (c >> (8-shift));
1438 if (++i >= value1) i = 0;
1440 for (i = 0; i < value1; i++)
1441 subject[i] = hashcodes[(subject[i]) % value2];
1443 else value1 = sublen;
1452 /*************************************************
1453 * Numeric hash of a string *
1454 *************************************************/
1456 /* Perform the ${nhash expansion operation. The first characters of the
1457 string are treated as most important, and get the highest prime numbers.
1460 subject the input string
1461 value1 the maximum value of the first part of the result
1462 value2 the maximum value of the second part of the result,
1463 or negative to produce only a one-part result
1464 len set to the length of the returned string
1466 Returns: pointer to the output string, or NULL if there is an error.
1470 compute_nhash (uschar *subject, int value1, int value2, int *len)
1472 uschar *s = subject;
1474 unsigned long int total = 0; /* no overflow */
1478 if (i == 0) i = nelem(prime) - 1;
1479 total += prime[i--] * (unsigned int)(*s++);
1482 /* If value2 is unset, just compute one number */
1486 s = string_sprintf("%d", total % value1);
1489 /* Otherwise do a div/mod hash */
1493 total = total % (value1 * value2);
1494 s = string_sprintf("%d/%d", total/value2, total % value2);
1505 /*************************************************
1506 * Find the value of a header or headers *
1507 *************************************************/
1509 /* Multiple instances of the same header get concatenated, and this function
1510 can also return a concatenation of all the header lines. When concatenating
1511 specific headers that contain lists of addresses, a comma is inserted between
1512 them. Otherwise we use a straight concatenation. Because some messages can have
1513 pathologically large number of lines, there is a limit on the length that is
1514 returned. Also, to avoid massive store use which would result from using
1515 string_cat() as it copies and extends strings, we do a preliminary pass to find
1516 out exactly how much store will be needed. On "normal" messages this will be
1520 name the name of the header, without the leading $header_ or $h_,
1521 or NULL if a concatenation of all headers is required
1522 exists_only TRUE if called from a def: test; don't need to build a string;
1523 just return a string that is not "" and not "0" if the header
1525 newsize return the size of memory block that was obtained; may be NULL
1526 if exists_only is TRUE
1527 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1528 other than concatenating, will be done on the header. Also used
1529 for $message_headers_raw.
1530 charset name of charset to translate MIME words to; used only if
1531 want_raw is false; if NULL, no translation is done (this is
1532 used for $bh_ and $bheader_)
1534 Returns: NULL if the header does not exist, else a pointer to a new
1539 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1542 BOOL found = name == NULL;
1544 int len = found? 0 : Ustrlen(name);
1546 uschar *yield = NULL;
1549 /* Loop for two passes - saves code repetition */
1551 for (i = 0; i < 2; i++)
1556 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1558 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1560 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1565 if (exists_only) return US"1"; /* don't need actual string */
1567 t = h->text + len; /* text to insert */
1568 if (!want_raw) /* unless wanted raw, */
1569 while (isspace(*t)) t++; /* remove leading white space */
1570 ilen = h->slen - (t - h->text); /* length to insert */
1572 /* Unless wanted raw, remove trailing whitespace, including the
1576 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1578 /* Set comma = 1 if handling a single header and it's one of those
1579 that contains an address list, except when asked for raw headers. Only
1580 need to do this once. */
1582 if (!want_raw && name != NULL && comma == 0 &&
1583 Ustrchr("BCFRST", h->type) != NULL)
1586 /* First pass - compute total store needed; second pass - compute
1587 total store used, including this header. */
1589 size += ilen + comma + 1; /* +1 for the newline */
1591 /* Second pass - concatentate the data, up to a maximum. Note that
1592 the loop stops when size hits the limit. */
1596 if (size > header_insert_maxlen)
1598 ilen -= size - header_insert_maxlen - 1;
1601 Ustrncpy(ptr, t, ilen);
1604 /* For a non-raw header, put in the comma if needed, then add
1605 back the newline we removed above, provided there was some text in
1608 if (!want_raw && ilen > 0)
1610 if (comma != 0) *ptr++ = ',';
1618 /* At end of first pass, return NULL if no header found. Then truncate size
1619 if necessary, and get the buffer to hold the data, returning the buffer size.
1624 if (!found) return NULL;
1625 if (size > header_insert_maxlen) size = header_insert_maxlen;
1626 *newsize = size + 1;
1627 ptr = yield = store_get(*newsize);
1631 /* That's all we do for raw header expansion. */
1638 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1639 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1640 function can return an error with decoded data if the charset translation
1641 fails. If decoding fails, it returns NULL. */
1645 uschar *decoded, *error;
1646 if (ptr > yield && ptr[-1] == '\n') ptr--;
1647 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1649 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1653 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1654 " input was: %s\n", error, yield);
1656 if (decoded != NULL) yield = decoded;
1665 /*************************************************
1666 * Return list of recipients *
1667 *************************************************/
1668 /* A recipients list is available only during system message filtering,
1669 during ACL processing after DATA, and while expanding pipe commands
1670 generated from a system filter, but not elsewhere. */
1675 if (!enable_dollar_recipients) return NULL; else
1680 uschar * s = store_get(size);
1681 for (i = 0; i < recipients_count; i++)
1683 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1684 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1685 Ustrlen(recipients_list[i].address));
1687 s[ptr] = 0; /* string_cat() leaves room */
1693 /*************************************************
1694 * Find value of a variable *
1695 *************************************************/
1697 /* The table of variables is kept in alphabetic order, so we can search it
1698 using a binary chop. The "choplen" variable is nothing to do with the binary
1702 name the name of the variable being sought
1703 exists_only TRUE if this is a def: test; passed on to find_header()
1704 skipping TRUE => skip any processing evaluation; this is not the same as
1705 exists_only because def: may test for values that are first
1707 newsize pointer to an int which is initially zero; if the answer is in
1708 a new memory buffer, *newsize is set to its size
1710 Returns: NULL if the variable does not exist, or
1711 a pointer to the variable's contents, or
1712 something non-NULL if exists_only is TRUE
1716 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1723 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1724 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1725 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1726 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1727 (this gave backwards compatibility at the changeover). There may be built-in
1728 variables whose names start acl_ but they should never start in this way. This
1729 slightly messy specification is a consequence of the history, needless to say.
1731 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1732 set, in which case give an error. */
1734 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1738 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1739 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1742 /* Handle $auth<n> variables. */
1744 if (Ustrncmp(name, "auth", 4) == 0)
1747 int n = Ustrtoul(name + 4, &endptr, 10);
1748 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1749 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1751 else if (Ustrncmp(name, "regex", 5) == 0)
1754 int n = Ustrtoul(name + 5, &endptr, 10);
1755 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1756 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1759 /* For all other variables, search the table */
1761 if (!(vp = find_var_ent(name)))
1762 return NULL; /* Unknown variable name */
1764 /* Found an existing variable. If in skipping state, the value isn't needed,
1765 and we want to avoid processing (such as looking up the host name). */
1773 case vtype_filter_int:
1774 if (!filter_running) return NULL;
1778 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1782 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1786 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1790 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1794 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1797 case vtype_stringptr: /* Pointer to string */
1798 return (s = *((uschar **)(val))) ? s : US"";
1801 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1804 case vtype_load_avg:
1805 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1808 case vtype_host_lookup: /* Lookup if not done so */
1809 if (sender_host_name == NULL && sender_host_address != NULL &&
1810 !host_lookup_failed && host_name_lookup() == OK)
1811 host_build_sender_fullhost();
1812 return (sender_host_name == NULL)? US"" : sender_host_name;
1814 case vtype_localpart: /* Get local part from address */
1815 s = *((uschar **)(val));
1816 if (s == NULL) return US"";
1817 domain = Ustrrchr(s, '@');
1818 if (domain == NULL) return s;
1819 if (domain - s > sizeof(var_buffer) - 1)
1820 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1821 " in string expansion", sizeof(var_buffer));
1822 Ustrncpy(var_buffer, s, domain - s);
1823 var_buffer[domain - s] = 0;
1826 case vtype_domain: /* Get domain from address */
1827 s = *((uschar **)(val));
1828 if (s == NULL) return US"";
1829 domain = Ustrrchr(s, '@');
1830 return (domain == NULL)? US"" : domain + 1;
1832 case vtype_msgheaders:
1833 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1835 case vtype_msgheaders_raw:
1836 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1838 case vtype_msgbody: /* Pointer to msgbody string */
1839 case vtype_msgbody_end: /* Ditto, the end of the msg */
1840 ss = (uschar **)(val);
1841 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1844 off_t start_offset = SPOOL_DATA_START_OFFSET;
1845 int len = message_body_visible;
1846 if (len > message_size) len = message_size;
1847 *ss = body = store_malloc(len+1);
1849 if (vp->type == vtype_msgbody_end)
1851 struct stat statbuf;
1852 if (fstat(deliver_datafile, &statbuf) == 0)
1854 start_offset = statbuf.st_size - len;
1855 if (start_offset < SPOOL_DATA_START_OFFSET)
1856 start_offset = SPOOL_DATA_START_OFFSET;
1859 lseek(deliver_datafile, start_offset, SEEK_SET);
1860 len = read(deliver_datafile, body, len);
1864 if (message_body_newlines) /* Separate loops for efficiency */
1866 { if (body[--len] == 0) body[len] = ' '; }
1869 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1872 return (*ss == NULL)? US"" : *ss;
1874 case vtype_todbsdin: /* BSD inbox time of day */
1875 return tod_stamp(tod_bsdin);
1877 case vtype_tode: /* Unix epoch time of day */
1878 return tod_stamp(tod_epoch);
1880 case vtype_todel: /* Unix epoch/usec time of day */
1881 return tod_stamp(tod_epoch_l);
1883 case vtype_todf: /* Full time of day */
1884 return tod_stamp(tod_full);
1886 case vtype_todl: /* Log format time of day */
1887 return tod_stamp(tod_log_bare); /* (without timezone) */
1889 case vtype_todzone: /* Time zone offset only */
1890 return tod_stamp(tod_zone);
1892 case vtype_todzulu: /* Zulu time */
1893 return tod_stamp(tod_zulu);
1895 case vtype_todlf: /* Log file datestamp tod */
1896 return tod_stamp(tod_log_datestamp_daily);
1898 case vtype_reply: /* Get reply address */
1899 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1901 if (s != NULL) while (isspace(*s)) s++;
1902 if (s == NULL || *s == 0)
1904 *newsize = 0; /* For the *s==0 case */
1905 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1910 while (isspace(*s)) s++;
1911 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1912 while (t > s && isspace(t[-1])) t--;
1915 return (s == NULL)? US"" : s;
1917 case vtype_string_func:
1919 uschar * (*fn)() = val;
1926 sprintf(CS var_buffer, "%d",
1927 receive_statvfs(val == (void *)TRUE, &inodes));
1934 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1935 sprintf(CS var_buffer, "%d", inodes);
1940 return *(void **)val ? US"<cert>" : US"";
1942 #ifndef DISABLE_DKIM
1944 return dkim_exim_expand_query((int)(long)val);
1949 return NULL; /* Unknown variable. Silences static checkers. */
1956 modify_variable(uschar *name, void * value)
1959 if ((vp = find_var_ent(name))) vp->value = value;
1960 return; /* Unknown variable name, fail silently */
1967 /*************************************************
1968 * Read and expand substrings *
1969 *************************************************/
1971 /* This function is called to read and expand argument substrings for various
1972 expansion items. Some have a minimum requirement that is less than the maximum;
1973 in these cases, the first non-present one is set to NULL.
1976 sub points to vector of pointers to set
1977 n maximum number of substrings
1979 sptr points to current string pointer
1980 skipping the skipping flag
1981 check_end if TRUE, check for final '}'
1982 name name of item, for error message
1983 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1986 Returns: 0 OK; string pointer updated
1987 1 curly bracketing error (too few arguments)
1988 2 too many arguments (only if check_end is set); message set
1989 3 other error (expansion failure)
1993 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1994 BOOL check_end, uschar *name, BOOL *resetok)
1997 const uschar *s = *sptr;
1999 while (isspace(*s)) s++;
2000 for (i = 0; i < n; i++)
2004 if (i < m) return 1;
2008 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
2009 if (sub[i] == NULL) return 3;
2010 if (*s++ != '}') return 1;
2011 while (isspace(*s)) s++;
2013 if (check_end && *s++ != '}')
2017 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
2018 "(max is %d)", name, n);
2031 /*************************************************
2032 * Elaborate message for bad variable *
2033 *************************************************/
2035 /* For the "unknown variable" message, take a look at the variable's name, and
2036 give additional information about possible ACL variables. The extra information
2037 is added on to expand_string_message.
2039 Argument: the name of the variable
2044 check_variable_error_message(uschar *name)
2046 if (Ustrncmp(name, "acl_", 4) == 0)
2047 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2048 (name[4] == 'c' || name[4] == 'm')?
2050 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2051 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2053 US"user-defined ACL variables must start acl_c or acl_m");
2059 Load args from sub array to globals, and call acl_check().
2060 Sub array will be corrupted on return.
2062 Returns: OK access is granted by an ACCEPT verb
2063 DISCARD access is granted by a DISCARD verb
2064 FAIL access is denied
2065 FAIL_DROP access is denied; drop the connection
2066 DEFER can't tell at the moment
2070 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2073 int sav_narg = acl_narg;
2075 uschar * dummy_logmsg;
2076 extern int acl_where;
2078 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2079 for (i = 0; i < nsub && sub[i+1]; i++)
2081 uschar * tmp = acl_arg[i];
2082 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2083 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2088 sub[i+1] = acl_arg[i];
2089 acl_arg[i++] = NULL;
2093 debug_printf("expanding: acl: %s arg: %s%s\n",
2095 acl_narg>0 ? acl_arg[0] : US"<none>",
2096 acl_narg>1 ? " +more" : "");
2098 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2100 for (i = 0; i < nsub; i++)
2101 acl_arg[i] = sub[i+1]; /* restore old args */
2102 acl_narg = sav_narg;
2110 /*************************************************
2111 * Read and evaluate a condition *
2112 *************************************************/
2116 s points to the start of the condition text
2117 resetok points to a BOOL which is written false if it is unsafe to
2118 free memory. Certain condition types (acl) may have side-effect
2119 allocation which must be preserved.
2120 yield points to a BOOL to hold the result of the condition test;
2121 if NULL, we are just reading through a condition that is
2122 part of an "or" combination to check syntax, or in a state
2123 where the answer isn't required
2125 Returns: a pointer to the first character after the condition, or
2129 static const uschar *
2130 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2132 BOOL testfor = TRUE;
2133 BOOL tempcond, combined_cond;
2135 BOOL sub2_honour_dollar = TRUE;
2136 int i, rc, cond_type, roffset;
2137 int_eximarith_t num[2];
2138 struct stat statbuf;
2140 const uschar *sub[10];
2143 const uschar *rerror;
2147 while (isspace(*s)) s++;
2148 if (*s == '!') { testfor = !testfor; s++; } else break;
2151 /* Numeric comparisons are symbolic */
2153 if (*s == '=' || *s == '>' || *s == '<')
2165 /* All other conditions are named */
2167 else s = read_name(name, 256, s, US"_");
2169 /* If we haven't read a name, it means some non-alpha character is first. */
2173 expand_string_message = string_sprintf("condition name expected, "
2174 "but found \"%.16s\"", s);
2178 /* Find which condition we are dealing with, and switch on it */
2180 cond_type = chop_match(name, cond_table, nelem(cond_table));
2183 /* def: tests for a non-empty variable, or for the existence of a header. If
2184 yield == NULL we are in a skipping state, and don't care about the answer. */
2189 expand_string_message = US"\":\" expected after \"def\"";
2193 s = read_name(name, 256, s+1, US"_");
2195 /* Test for a header's existence. If the name contains a closing brace
2196 character, this may be a user error where the terminating colon has been
2197 omitted. Set a flag to adjust a subsequent error message in this case. */
2199 if (Ustrncmp(name, "h_", 2) == 0 ||
2200 Ustrncmp(name, "rh_", 3) == 0 ||
2201 Ustrncmp(name, "bh_", 3) == 0 ||
2202 Ustrncmp(name, "header_", 7) == 0 ||
2203 Ustrncmp(name, "rheader_", 8) == 0 ||
2204 Ustrncmp(name, "bheader_", 8) == 0)
2206 s = read_header_name(name, 256, s);
2207 /* {-for-text-editors */
2208 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2209 if (yield != NULL) *yield =
2210 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2213 /* Test for a variable's having a non-empty value. A non-existent variable
2214 causes an expansion failure. */
2218 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2221 expand_string_message = (name[0] == 0)?
2222 string_sprintf("variable name omitted after \"def:\"") :
2223 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2224 check_variable_error_message(name);
2227 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2233 /* first_delivery tests for first delivery attempt */
2235 case ECOND_FIRST_DELIVERY:
2236 if (yield != NULL) *yield = deliver_firsttime == testfor;
2240 /* queue_running tests for any process started by a queue runner */
2242 case ECOND_QUEUE_RUNNING:
2243 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2247 /* exists: tests for file existence
2248 isip: tests for any IP address
2249 isip4: tests for an IPv4 address
2250 isip6: tests for an IPv6 address
2251 pam: does PAM authentication
2252 radius: does RADIUS authentication
2253 ldapauth: does LDAP authentication
2254 pwcheck: does Cyrus SASL pwcheck authentication
2263 case ECOND_LDAPAUTH:
2266 while (isspace(*s)) s++;
2267 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2269 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2270 if (sub[0] == NULL) return NULL;
2271 /* {-for-text-editors */
2272 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2274 if (yield == NULL) return s; /* No need to run the test if skipping */
2279 if ((expand_forbid & RDO_EXISTS) != 0)
2281 expand_string_message = US"File existence tests are not permitted";
2284 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2290 rc = string_is_ip_address(sub[0], NULL);
2291 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2292 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2295 /* Various authentication tests - all optionally compiled */
2299 rc = auth_call_pam(sub[0], &expand_string_message);
2302 goto COND_FAILED_NOT_COMPILED;
2303 #endif /* SUPPORT_PAM */
2306 #ifdef RADIUS_CONFIG_FILE
2307 rc = auth_call_radius(sub[0], &expand_string_message);
2310 goto COND_FAILED_NOT_COMPILED;
2311 #endif /* RADIUS_CONFIG_FILE */
2313 case ECOND_LDAPAUTH:
2316 /* Just to keep the interface the same */
2318 int old_pool = store_pool;
2319 store_pool = POOL_SEARCH;
2320 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2321 &expand_string_message, &do_cache);
2322 store_pool = old_pool;
2326 goto COND_FAILED_NOT_COMPILED;
2327 #endif /* LOOKUP_LDAP */
2330 #ifdef CYRUS_PWCHECK_SOCKET
2331 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2334 goto COND_FAILED_NOT_COMPILED;
2335 #endif /* CYRUS_PWCHECK_SOCKET */
2337 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2338 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2340 if (rc == ERROR || rc == DEFER) return NULL;
2341 *yield = (rc == OK) == testfor;
2347 /* call ACL (in a conditional context). Accept true, deny false.
2348 Defer is a forced-fail. Anything set by message= goes to $value.
2349 Up to ten parameters are used; we use the braces round the name+args
2350 like the saslauthd condition does, to permit a variable number of args.
2351 See also the expansion-item version EITEM_ACL and the traditional
2352 acl modifier ACLC_ACL.
2353 Since the ACL may allocate new global variables, tell our caller to not
2358 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2366 while (isspace(*s)) s++;
2367 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2369 switch(read_subs(sub, nelem(sub), 1,
2370 &s, yield == NULL, TRUE, US"acl", resetok))
2372 case 1: expand_string_message = US"too few arguments or bracketing "
2375 case 3: return NULL;
2379 if (yield != NULL) switch(eval_acl(sub, nelem(sub), &user_msg))
2384 lookup_value = NULL;
2387 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2388 lookup_value[ptr] = '\0';
2390 *yield = cond == testfor;
2394 expand_string_forcedfail = TRUE;
2396 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2403 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2405 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2407 However, the last two are optional. That is why the whole set is enclosed
2408 in their own set of braces. */
2410 case ECOND_SASLAUTHD:
2411 #ifndef CYRUS_SASLAUTHD_SOCKET
2412 goto COND_FAILED_NOT_COMPILED;
2416 while (isspace(*s)) s++;
2417 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2418 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2421 case 1: expand_string_message = US"too few arguments or bracketing "
2422 "error for saslauthd";
2424 case 3: return NULL;
2426 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2429 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2430 &expand_string_message);
2431 if (rc == ERROR || rc == DEFER) return NULL;
2432 *yield = (rc == OK) == testfor;
2436 #endif /* CYRUS_SASLAUTHD_SOCKET */
2439 /* symbolic operators for numeric and string comparison, and a number of
2440 other operators, all requiring two arguments.
2442 crypteq: encrypts plaintext and compares against an encrypted text,
2443 using crypt(), crypt16(), MD5 or SHA-1
2444 inlist/inlisti: checks if first argument is in the list of the second
2445 match: does a regular expression match and sets up the numerical
2446 variables if it succeeds
2447 match_address: matches in an address list
2448 match_domain: matches in a domain list
2449 match_ip: matches a host list that is restricted to IP addresses
2450 match_local_part: matches in a local part list
2453 case ECOND_MATCH_ADDRESS:
2454 case ECOND_MATCH_DOMAIN:
2455 case ECOND_MATCH_IP:
2456 case ECOND_MATCH_LOCAL_PART:
2457 #ifndef EXPAND_LISTMATCH_RHS
2458 sub2_honour_dollar = FALSE;
2467 case ECOND_NUM_L: /* Numerical comparisons */
2474 case ECOND_STR_LT: /* String comparisons */
2485 for (i = 0; i < 2; i++)
2487 /* Sometimes, we don't expand substrings; too many insecure configurations
2488 created using match_address{}{} and friends, where the second param
2489 includes information from untrustworthy sources. */
2490 BOOL honour_dollar = TRUE;
2491 if ((i > 0) && !sub2_honour_dollar)
2492 honour_dollar = FALSE;
2494 while (isspace(*s)) s++;
2497 if (i == 0) goto COND_FAILED_CURLY_START;
2498 expand_string_message = string_sprintf("missing 2nd string in {} "
2499 "after \"%s\"", name);
2502 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2503 honour_dollar, resetok);
2504 if (sub[i] == NULL) return NULL;
2505 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2507 /* Convert to numerical if required; we know that the names of all the
2508 conditions that compare numbers do not start with a letter. This just saves
2509 checking for them individually. */
2511 if (!isalpha(name[0]) && yield != NULL)
2517 debug_printf("empty string cast to zero for numerical comparison\n");
2521 num[i] = expanded_string_integer(sub[i], FALSE);
2522 if (expand_string_message != NULL) return NULL;
2527 /* Result not required */
2529 if (yield == NULL) return s;
2531 /* Do an appropriate comparison */
2537 tempcond = (num[0] == num[1]);
2541 tempcond = (num[0] > num[1]);
2545 tempcond = (num[0] >= num[1]);
2549 tempcond = (num[0] < num[1]);
2553 tempcond = (num[0] <= num[1]);
2557 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2561 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2565 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2569 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2573 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2577 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2581 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2585 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2589 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2593 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2596 case ECOND_MATCH: /* Regular expression match */
2597 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2601 expand_string_message = string_sprintf("regular expression error in "
2602 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2605 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2608 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2609 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2610 goto MATCHED_SOMETHING;
2612 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2613 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2614 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2615 goto MATCHED_SOMETHING;
2617 case ECOND_MATCH_IP: /* Match IP address in a host list */
2618 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2620 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2626 unsigned int *nullcache = NULL;
2627 check_host_block cb;
2629 cb.host_name = US"";
2630 cb.host_address = sub[0];
2632 /* If the host address starts off ::ffff: it is an IPv6 address in
2633 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2636 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2637 cb.host_address + 7 : cb.host_address;
2639 rc = match_check_list(
2640 &sub[1], /* the list */
2641 0, /* separator character */
2642 &hostlist_anchor, /* anchor pointer */
2643 &nullcache, /* cache pointer */
2644 check_host, /* function for testing */
2645 &cb, /* argument for function */
2646 MCL_HOST, /* type of check */
2647 sub[0], /* text for debugging */
2648 NULL); /* where to pass back data */
2650 goto MATCHED_SOMETHING;
2652 case ECOND_MATCH_LOCAL_PART:
2653 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2654 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2669 expand_string_message = string_sprintf("unable to complete match "
2670 "against \"%s\": %s", sub[1], search_error_message);
2676 /* Various "encrypted" comparisons. If the second string starts with
2677 "{" then an encryption type is given. Default to crypt() or crypt16()
2678 (build-time choice). */
2679 /* }-for-text-editors */
2682 #ifndef SUPPORT_CRYPTEQ
2683 goto COND_FAILED_NOT_COMPILED;
2685 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2687 int sublen = Ustrlen(sub[1]+5);
2692 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2694 /* If the length that we are comparing against is 24, the MD5 digest
2695 is expressed as a base64 string. This is the way LDAP does it. However,
2696 some other software uses a straightforward hex representation. We assume
2697 this if the length is 32. Other lengths fail. */
2701 uschar *coded = b64encode((uschar *)digest, 16);
2702 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2703 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2704 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2706 else if (sublen == 32)
2710 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2712 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2713 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2714 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2718 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2719 "fail\n crypted=%s\n", sub[1]+5);
2724 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2726 int sublen = Ustrlen(sub[1]+6);
2731 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2733 /* If the length that we are comparing against is 28, assume the SHA1
2734 digest is expressed as a base64 string. If the length is 40, assume a
2735 straightforward hex representation. Other lengths fail. */
2739 uschar *coded = b64encode((uschar *)digest, 20);
2740 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2741 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2742 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2744 else if (sublen == 40)
2748 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2750 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2751 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2752 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2756 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2757 "fail\n crypted=%s\n", sub[1]+6);
2762 else /* {crypt} or {crypt16} and non-{ at start */
2763 /* }-for-text-editors */
2768 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2773 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2778 else if (sub[1][0] == '{') /* }-for-text-editors */
2780 expand_string_message = string_sprintf("unknown encryption mechanism "
2781 "in \"%s\"", sub[1]);
2787 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2788 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2789 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2793 #define XSTR(s) STR(s)
2794 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2795 " subject=%s\n crypted=%s\n",
2796 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2801 /* If the encrypted string contains fewer than two characters (for the
2802 salt), force failure. Otherwise we get false positives: with an empty
2803 string the yield of crypt() is an empty string! */
2806 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2807 else if (errno == EINVAL)
2811 expand_string_message = string_sprintf("crypt error: %s\n",
2812 US strerror(errno));
2817 #endif /* SUPPORT_CRYPTEQ */
2822 const uschar * list = sub[1];
2824 uschar *save_iterate_item = iterate_item;
2825 int (*compare)(const uschar *, const uschar *);
2827 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2830 compare = cond_type == ECOND_INLISTI
2831 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2833 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2834 if (compare(sub[0], iterate_item) == 0)
2839 iterate_item = save_iterate_item;
2842 } /* Switch for comparison conditions */
2844 *yield = tempcond == testfor;
2845 return s; /* End of comparison conditions */
2848 /* and/or: computes logical and/or of several conditions */
2852 subcondptr = (yield == NULL)? NULL : &tempcond;
2853 combined_cond = (cond_type == ECOND_AND);
2855 while (isspace(*s)) s++;
2856 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2860 while (isspace(*s)) s++;
2861 /* {-for-text-editors */
2862 if (*s == '}') break;
2863 if (*s != '{') /* }-for-text-editors */
2865 expand_string_message = string_sprintf("each subcondition "
2866 "inside an \"%s{...}\" condition must be in its own {}", name);
2870 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2872 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2873 expand_string_message, name);
2876 while (isspace(*s)) s++;
2878 /* {-for-text-editors */
2881 /* {-for-text-editors */
2882 expand_string_message = string_sprintf("missing } at end of condition "
2883 "inside \"%s\" group", name);
2889 if (cond_type == ECOND_AND)
2891 combined_cond &= tempcond;
2892 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2893 } /* evaluate any more */
2896 combined_cond |= tempcond;
2897 if (combined_cond) subcondptr = NULL; /* once true, don't */
2898 } /* evaluate any more */
2902 if (yield != NULL) *yield = (combined_cond == testfor);
2906 /* forall/forany: iterates a condition with different values */
2911 const uschar * list;
2913 uschar *save_iterate_item = iterate_item;
2915 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2917 while (isspace(*s)) s++;
2918 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2919 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2920 if (sub[0] == NULL) return NULL;
2921 /* {-for-text-editors */
2922 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2924 while (isspace(*s)) s++;
2925 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2929 /* Call eval_condition once, with result discarded (as if scanning a
2930 "false" part). This allows us to find the end of the condition, because if
2931 the list it empty, we won't actually evaluate the condition for real. */
2933 if (!(s = eval_condition(sub[1], resetok, NULL)))
2935 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2936 expand_string_message, name);
2939 while (isspace(*s)) s++;
2941 /* {-for-text-editors */
2944 /* {-for-text-editors */
2945 expand_string_message = string_sprintf("missing } at end of condition "
2946 "inside \"%s\"", name);
2950 if (yield != NULL) *yield = !testfor;
2952 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2954 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2955 if (!eval_condition(sub[1], resetok, &tempcond))
2957 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2958 expand_string_message, name);
2959 iterate_item = save_iterate_item;
2962 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2963 tempcond? "true":"false");
2965 if (yield != NULL) *yield = (tempcond == testfor);
2966 if (tempcond == (cond_type == ECOND_FORANY)) break;
2969 iterate_item = save_iterate_item;
2974 /* The bool{} expansion condition maps a string to boolean.
2975 The values supported should match those supported by the ACL condition
2976 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2977 of true/false. Note that Router "condition" rules have a different
2978 interpretation, where general data can be used and only a few values
2980 Note that readconf.c boolean matching, for boolean configuration options,
2981 only matches true/yes/false/no.
2982 The bool_lax{} condition matches the Router logic, which is much more
2985 case ECOND_BOOL_LAX:
2991 BOOL boolvalue = FALSE;
2992 while (isspace(*s)) s++;
2993 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2994 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2995 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2997 case 1: expand_string_message = string_sprintf(
2998 "too few arguments or bracketing error for %s",
3002 case 3: return NULL;
3005 while (isspace(*t)) t++;
3009 /* trailing whitespace: seems like a good idea to ignore it too */
3011 while (isspace(*t2)) t2--;
3012 if (t2 != (t + len))
3019 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
3020 /* logic for the lax case from expand_check_condition(), which also does
3021 expands, and the logic is both short and stable enough that there should
3022 be no maintenance burden from replicating it. */
3026 ? Ustrspn(t+1, "0123456789") == len-1
3027 : Ustrspn(t, "0123456789") == len)
3029 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3030 /* expand_check_condition only does a literal string "0" check */
3031 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3034 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3036 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3038 else if (cond_type == ECOND_BOOL_LAX)
3042 expand_string_message = string_sprintf("unrecognised boolean "
3046 if (yield != NULL) *yield = (boolvalue == testfor);
3050 /* Unknown condition */
3053 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3055 } /* End switch on condition type */
3057 /* Missing braces at start and end of data */
3059 COND_FAILED_CURLY_START:
3060 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3063 COND_FAILED_CURLY_END:
3064 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3068 /* A condition requires code that is not compiled */
3070 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3071 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3072 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3073 COND_FAILED_NOT_COMPILED:
3074 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3083 /*************************************************
3084 * Save numerical variables *
3085 *************************************************/
3087 /* This function is called from items such as "if" that want to preserve and
3088 restore the numbered variables.
3091 save_expand_string points to an array of pointers to set
3092 save_expand_nlength points to an array of ints for the lengths
3094 Returns: the value of expand max to save
3098 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3101 for (i = 0; i <= expand_nmax; i++)
3103 save_expand_nstring[i] = expand_nstring[i];
3104 save_expand_nlength[i] = expand_nlength[i];
3111 /*************************************************
3112 * Restore numerical variables *
3113 *************************************************/
3115 /* This function restored saved values of numerical strings.
3118 save_expand_nmax the number of strings to restore
3119 save_expand_string points to an array of pointers
3120 save_expand_nlength points to an array of ints
3126 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3127 int *save_expand_nlength)
3130 expand_nmax = save_expand_nmax;
3131 for (i = 0; i <= expand_nmax; i++)
3133 expand_nstring[i] = save_expand_nstring[i];
3134 expand_nlength[i] = save_expand_nlength[i];
3142 /*************************************************
3143 * Handle yes/no substrings *
3144 *************************************************/
3146 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3147 alternative substrings that depend on whether or not the condition was true,
3148 or the lookup or extraction succeeded. The substrings always have to be
3149 expanded, to check their syntax, but "skipping" is set when the result is not
3150 needed - this avoids unnecessary nested lookups.
3153 skipping TRUE if we were skipping when this item was reached
3154 yes TRUE if the first string is to be used, else use the second
3155 save_lookup a value to put back into lookup_value before the 2nd expansion
3156 sptr points to the input string pointer
3157 yieldptr points to the output string pointer
3158 sizeptr points to the output string size
3159 ptrptr points to the output string pointer
3160 type "lookup", "if", "extract", "run", "env", "listextract" or
3161 "certextract" for error message
3162 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3165 Returns: 0 OK; lookup_value has been reset to save_lookup
3167 2 expansion failed because of bracketing error
3171 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3172 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3175 const uschar *s = *sptr; /* Local value */
3176 uschar *sub1, *sub2;
3178 /* If there are no following strings, we substitute the contents of $value for
3179 lookups and for extractions in the success case. For the ${if item, the string
3180 "true" is substituted. In the fail case, nothing is substituted for all three
3183 while (isspace(*s)) s++;
3188 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3192 if (yes && lookup_value)
3193 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3194 Ustrlen(lookup_value));
3195 lookup_value = save_lookup;
3201 /* The first following string must be braced. */
3203 if (*s++ != '{') goto FAILED_CURLY;
3205 /* Expand the first substring. Forced failures are noticed only if we actually
3206 want this string. Set skipping in the call in the fail case (this will always
3207 be the case if we were already skipping). */
3209 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3210 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3211 expand_string_forcedfail = FALSE;
3212 if (*s++ != '}') goto FAILED_CURLY;
3214 /* If we want the first string, add it to the output */
3217 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3219 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3220 $value to what it was at the start of the item, so that it has this value
3221 during the second string expansion. For the call from "if" or "run" to this
3222 function, save_lookup is set to lookup_value, so that this statement does
3225 lookup_value = save_lookup;
3227 /* There now follows either another substring, or "fail", or nothing. This
3228 time, forced failures are noticed only if we want the second string. We must
3229 set skipping in the nested call if we don't want this string, or if we were
3230 already skipping. */
3232 while (isspace(*s)) s++;
3235 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3236 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3237 expand_string_forcedfail = FALSE;
3238 if (*s++ != '}') goto FAILED_CURLY;
3240 /* If we want the second string, add it to the output */
3243 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3246 /* If there is no second string, but the word "fail" is present when the use of
3247 the second string is wanted, set a flag indicating it was a forced failure
3248 rather than a syntactic error. Swallow the terminating } in case this is nested
3249 inside another lookup or if or extract. */
3254 /* deconst cast ok here as source is s anyway */
3255 s = US read_name(name, sizeof(name), s, US"_");
3256 if (Ustrcmp(name, "fail") == 0)
3258 if (!yes && !skipping)
3260 while (isspace(*s)) s++;
3261 if (*s++ != '}') goto FAILED_CURLY;
3262 expand_string_message =
3263 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3264 expand_string_forcedfail = TRUE;
3270 expand_string_message =
3271 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3276 /* All we have to do now is to check on the final closing brace. */
3278 while (isspace(*s)) s++;
3279 if (*s++ == '}') goto RETURN;
3281 /* Get here if there is a bracketing failure */
3286 /* Get here for other failures */
3291 /* Update the input pointer value before returning */
3301 /*************************************************
3302 * Handle MD5 or SHA-1 computation for HMAC *
3303 *************************************************/
3305 /* These are some wrapping functions that enable the HMAC code to be a bit
3306 cleaner. A good compiler will spot the tail recursion.
3309 type HMAC_MD5 or HMAC_SHA1
3310 remaining are as for the cryptographic hash functions
3316 chash_start(int type, void *base)
3318 if (type == HMAC_MD5)
3319 md5_start((md5 *)base);
3321 sha1_start((sha1 *)base);
3325 chash_mid(int type, void *base, uschar *string)
3327 if (type == HMAC_MD5)
3328 md5_mid((md5 *)base, string);
3330 sha1_mid((sha1 *)base, string);
3334 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3336 if (type == HMAC_MD5)
3337 md5_end((md5 *)base, string, length, digest);
3339 sha1_end((sha1 *)base, string, length, digest);
3346 /********************************************************
3347 * prvs: Get last three digits of days since Jan 1, 1970 *
3348 ********************************************************/
3350 /* This is needed to implement the "prvs" BATV reverse
3353 Argument: integer "days" offset to add or substract to
3354 or from the current number of days.
3356 Returns: pointer to string containing the last three
3357 digits of the number of days since Jan 1, 1970,
3358 modified by the offset argument, NULL if there
3359 was an error in the conversion.
3364 prvs_daystamp(int day_offset)
3366 uschar *days = store_get(32); /* Need at least 24 for cases */
3367 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3368 (time(NULL) + day_offset*86400)/86400);
3369 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3374 /********************************************************
3375 * prvs: perform HMAC-SHA1 computation of prvs bits *
3376 ********************************************************/
3378 /* This is needed to implement the "prvs" BATV reverse
3382 address RFC2821 Address to use
3383 key The key to use (must be less than 64 characters
3385 key_num Single-digit key number to use. Defaults to
3388 Returns: pointer to string containing the first three
3389 bytes of the final hash in hex format, NULL if
3390 there was an error in the process.
3394 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3396 uschar *hash_source, *p;
3397 int size = 0,offset = 0,i;
3399 void *use_base = &sha1_base;
3400 uschar innerhash[20];
3401 uschar finalhash[20];
3402 uschar innerkey[64];
3403 uschar outerkey[64];
3404 uschar *finalhash_hex = store_get(40);
3406 if (key_num == NULL)
3409 if (Ustrlen(key) > 64)
3412 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3413 string_cat(hash_source,&size,&offset,daystamp,3);
3414 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3415 hash_source[offset] = '\0';
3417 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3419 memset(innerkey, 0x36, 64);
3420 memset(outerkey, 0x5c, 64);
3422 for (i = 0; i < Ustrlen(key); i++)
3424 innerkey[i] ^= key[i];
3425 outerkey[i] ^= key[i];
3428 chash_start(HMAC_SHA1, use_base);
3429 chash_mid(HMAC_SHA1, use_base, innerkey);
3430 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3432 chash_start(HMAC_SHA1, use_base);
3433 chash_mid(HMAC_SHA1, use_base, outerkey);
3434 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3437 for (i = 0; i < 3; i++)
3439 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3440 *p++ = hex_digits[finalhash[i] & 0x0f];
3444 return finalhash_hex;
3450 /*************************************************
3451 * Join a file onto the output string *
3452 *************************************************/
3454 /* This is used for readfile/readsock and after a run expansion.
3455 It joins the contents of a file onto the output string, globally replacing
3456 newlines with a given string (optionally).
3460 yield pointer to the expandable string
3461 sizep pointer to the current size
3462 ptrp pointer to the current position
3463 eol newline replacement string, or NULL
3465 Returns: new value of string pointer
3469 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3471 int eollen = eol ? Ustrlen(eol) : 0;
3472 uschar buffer[1024];
3474 while (Ufgets(buffer, sizeof(buffer), f))
3476 int len = Ustrlen(buffer);
3477 if (eol && buffer[len-1] == '\n') len--;
3478 yield = string_cat(yield, sizep, ptrp, buffer, len);
3479 if (buffer[len] != 0)
3480 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3483 if (yield) yield[*ptrp] = 0;
3491 /*************************************************
3492 * Evaluate numeric expression *
3493 *************************************************/
3495 /* This is a set of mutually recursive functions that evaluate an arithmetic
3496 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3497 these functions that is called from elsewhere is eval_expr, whose interface is:
3500 sptr pointer to the pointer to the string - gets updated
3501 decimal TRUE if numbers are to be assumed decimal
3502 error pointer to where to put an error message - must be NULL on input
3503 endket TRUE if ')' must terminate - FALSE for external call
3505 Returns: on success: the value of the expression, with *error still NULL
3506 on failure: an undefined value, with *error = a message
3509 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3512 static int_eximarith_t
3513 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3516 int_eximarith_t x = eval_op_or(&s, decimal, error);
3522 *error = US"expecting closing parenthesis";
3524 while (isspace(*(++s)));
3526 else if (*s != 0) *error = US"expecting operator";
3533 static int_eximarith_t
3534 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3539 while (isspace(*s)) s++;
3544 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3546 switch (tolower(*s))
3549 case 'k': n *= 1024; s++; break;
3550 case 'm': n *= 1024*1024; s++; break;
3551 case 'g': n *= 1024*1024*1024; s++; break;
3553 while (isspace (*s)) s++;
3558 n = eval_expr(&s, decimal, error, 1);
3562 *error = US"expecting number or opening parenthesis";
3570 static int_eximarith_t
3571 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3575 while (isspace(*s)) s++;
3576 if (*s == '+' || *s == '-' || *s == '~')
3579 x = eval_op_unary(&s, decimal, error);
3580 if (op == '-') x = -x;
3581 else if (op == '~') x = ~x;
3585 x = eval_number(&s, decimal, error);
3592 static int_eximarith_t
3593 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3596 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3599 while (*s == '*' || *s == '/' || *s == '%')
3602 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3603 if (*error != NULL) break;
3604 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3605 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3606 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3607 * -N*M is INT_MIN will yielf INT_MIN.
3608 * Since we don't support floating point, this is somewhat simpler.
3609 * Ideally, we'd return an error, but since we overflow for all other
3610 * arithmetic, consistency suggests otherwise, but what's the correct value
3611 * to use? There is none.
3612 * The C standard guarantees overflow for unsigned arithmetic but signed
3613 * overflow invokes undefined behaviour; in practice, this is overflow
3614 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3615 * that long/longlong larger than int are available, or we could just work
3616 * with larger types. We should consider whether to guarantee 32bit eval
3617 * and 64-bit working variables, with errors returned. For now ...
3618 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3619 * can just let the other invalid results occur otherwise, as they have
3620 * until now. For this one case, we can coerce.
3622 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3625 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3626 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3636 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3652 static int_eximarith_t
3653 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3656 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3659 while (*s == '+' || *s == '-')
3662 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3663 if (*error != NULL) break;
3664 if (op == '+') x += y; else x -= y;
3672 static int_eximarith_t
3673 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3676 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3679 while ((*s == '<' || *s == '>') && s[1] == s[0])
3684 y = eval_op_sum(&s, decimal, error);
3685 if (*error != NULL) break;
3686 if (op == '<') x <<= y; else x >>= y;
3694 static int_eximarith_t
3695 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3698 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3705 y = eval_op_shift(&s, decimal, error);
3706 if (*error != NULL) break;
3715 static int_eximarith_t
3716 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3719 int_eximarith_t x = eval_op_and(&s, decimal, error);
3726 y = eval_op_and(&s, decimal, error);
3727 if (*error != NULL) break;
3736 static int_eximarith_t
3737 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3740 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3747 y = eval_op_xor(&s, decimal, error);
3748 if (*error != NULL) break;
3758 /*************************************************
3760 *************************************************/
3762 /* Returns either an unchanged string, or the expanded string in stacking pool
3763 store. Interpreted sequences are:
3765 \... normal escaping rules
3766 $name substitutes the variable
3768 ${op:string} operates on the expanded string value
3769 ${item{arg1}{arg2}...} expands the args and then does the business
3770 some literal args are not enclosed in {}
3772 There are now far too many operators and item types to make it worth listing
3773 them here in detail any more.
3775 We use an internal routine recursively to handle embedded substrings. The
3776 external function follows. The yield is NULL if the expansion failed, and there
3777 are two cases: if something collapsed syntactically, or if "fail" was given
3778 as the action on a lookup failure. These can be distinguised by looking at the
3779 variable expand_string_forcedfail, which is TRUE in the latter case.
3781 The skipping flag is set true when expanding a substring that isn't actually
3782 going to be used (after "if" or "lookup") and it prevents lookups from
3783 happening lower down.
3785 Store usage: At start, a store block of the length of the input plus 64
3786 is obtained. This is expanded as necessary by string_cat(), which might have to
3787 get a new block, or might be able to expand the original. At the end of the
3788 function we can release any store above that portion of the yield block that
3789 was actually used. In many cases this will be optimal.
3791 However: if the first item in the expansion is a variable name or header name,
3792 we reset the store before processing it; if the result is in fresh store, we
3793 use that without copying. This is helpful for expanding strings like
3794 $message_headers which can get very long.
3796 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3797 since resetting the store at the end of the expansion will free store that was
3798 allocated by the plugin code as well as the slop after the expanded string. So
3799 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3800 and, given the acl condition, ${if }. This is an unfortunate consequence of
3801 string expansion becoming too powerful.
3804 string the string to be expanded
3805 ket_ends true if expansion is to stop at }
3806 left if not NULL, a pointer to the first character after the
3807 expansion is placed here (typically used with ket_ends)
3808 skipping TRUE for recursive calls when the value isn't actually going
3809 to be used (to allow for optimisation)
3810 honour_dollar TRUE if $ is to be expanded,
3811 FALSE if it's just another character
3812 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3815 Returns: NULL if expansion fails:
3816 expand_string_forcedfail is set TRUE if failure was forced
3817 expand_string_message contains a textual error message
3818 a pointer to the expanded string on success
3822 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3823 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3826 int size = Ustrlen(string)+ 64;
3828 uschar *yield = store_get(size);
3829 const uschar *s = string;
3830 uschar *save_expand_nstring[EXPAND_MAXN+1];
3831 int save_expand_nlength[EXPAND_MAXN+1];
3832 BOOL resetok = TRUE;
3834 expand_string_forcedfail = FALSE;
3835 expand_string_message = US"";
3842 /* \ escapes the next character, which must exist, or else
3843 the expansion fails. There's a special escape, \N, which causes
3844 copying of the subject verbatim up to the next \N. Otherwise,
3845 the escapes are the standard set. */
3851 expand_string_message = US"\\ at end of string";
3857 const uschar * t = s + 2;
3858 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3859 yield = string_cat(yield, &size, &ptr, t, s - t);
3860 if (*s != 0) s += 2;
3866 ch[0] = string_interpret_escape(&s);
3868 yield = string_cat(yield, &size, &ptr, ch, 1);
3875 /* Anything other than $ is just copied verbatim, unless we are
3876 looking for a terminating } character. */
3879 if (ket_ends && *s == '}') break;
3881 if (*s != '$' || !honour_dollar)
3883 yield = string_cat(yield, &size, &ptr, s++, 1);
3887 /* No { after the $ - must be a plain name or a number for string
3888 match variable. There has to be a fudge for variables that are the
3889 names of header fields preceded by "$header_" because header field
3890 names can contain any printing characters except space and colon.
3891 For those that don't like typing this much, "$h_" is a synonym for
3892 "$header_". A non-existent header yields a NULL value; nothing is
3895 if (isalpha((*(++s))))
3900 s = read_name(name, sizeof(name), s, US"_");
3902 /* If this is the first thing to be expanded, release the pre-allocated
3905 if (ptr == 0 && yield != NULL)
3907 if (resetok) store_reset(yield);
3914 if (Ustrncmp(name, "h_", 2) == 0 ||
3915 Ustrncmp(name, "rh_", 3) == 0 ||
3916 Ustrncmp(name, "bh_", 3) == 0 ||
3917 Ustrncmp(name, "header_", 7) == 0 ||
3918 Ustrncmp(name, "rheader_", 8) == 0 ||
3919 Ustrncmp(name, "bheader_", 8) == 0)
3921 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3922 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3923 s = read_header_name(name, sizeof(name), s);
3924 value = find_header(name, FALSE, &newsize, want_raw, charset);
3926 /* If we didn't find the header, and the header contains a closing brace
3927 character, this may be a user error where the terminating colon
3928 has been omitted. Set a flag to adjust the error message in this case.
3929 But there is no error here - nothing gets inserted. */
3933 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3940 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
3942 expand_string_message =
3943 string_sprintf("unknown variable name \"%s\"", name);
3944 check_variable_error_message(name);
3948 /* If the data is known to be in a new buffer, newsize will be set to the
3949 size of that buffer. If this is the first thing in an expansion string,
3950 yield will be NULL; just point it at the new store instead of copying. Many
3951 expansion strings contain just one reference, so this is a useful
3952 optimization, especially for humungous headers. */
3954 len = Ustrlen(value);
3955 if (yield == NULL && newsize != 0)
3961 else yield = string_cat(yield, &size, &ptr, value, len);
3969 s = read_cnumber(&n, s);
3970 if (n >= 0 && n <= expand_nmax)
3971 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3976 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3978 if (*s != '{') /*}*/
3980 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3984 /* After { there can be various things, but they all start with
3985 an initial word, except for a number for a string match variable. */
3987 if (isdigit((*(++s))))
3990 s = read_cnumber(&n, s); /*{*/
3993 expand_string_message = US"} expected after number";
3996 if (n >= 0 && n <= expand_nmax)
3997 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
4004 expand_string_message = US"letter or digit expected after ${"; /*}*/
4008 /* Allow "-" in names to cater for substrings with negative
4009 arguments. Since we are checking for known names after { this is
4012 s = read_name(name, sizeof(name), s, US"_-");
4013 item_type = chop_match(name, item_table, nelem(item_table));
4017 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4018 If the ACL returns accept or reject we return content set by "message ="
4019 There is currently no limit on recursion; this would have us call
4020 acl_check_internal() directly and get a current level from somewhere.
4021 See also the acl expansion condition ECOND_ACL and the traditional
4022 acl modifier ACLC_ACL.
4023 Assume that the function has side-effects on the store that must be preserved.
4027 /* ${acl {name} {arg1}{arg2}...} */
4029 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4032 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4035 case 1: goto EXPAND_FAILED_CURLY;
4037 case 3: goto EXPAND_FAILED;
4039 if (skipping) continue;
4042 switch(eval_acl(sub, nelem(sub), &user_msg))
4047 debug_printf("acl expansion yield: %s\n", user_msg);
4049 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
4053 expand_string_forcedfail = TRUE;
4055 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4060 /* Handle conditionals - preserve the values of the numerical expansion
4061 variables in case they get changed by a regular expression match in the
4062 condition. If not, they retain their external settings. At the end
4063 of this "if" section, they get restored to their previous values. */
4068 const uschar *next_s;
4069 int save_expand_nmax =
4070 save_expand_strings(save_expand_nstring, save_expand_nlength);
4072 while (isspace(*s)) s++;
4073 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
4074 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4077 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
4078 cond? "true" : "false");
4082 /* The handling of "yes" and "no" result strings is now in a separate
4083 function that is also used by ${lookup} and ${extract} and ${run}. */
4085 switch(process_yesno(
4086 skipping, /* were previously skipping */
4087 cond, /* success/failure indicator */
4088 lookup_value, /* value to reset for string2 */
4089 &s, /* input pointer */
4090 &yield, /* output pointer */
4091 &size, /* output size */
4092 &ptr, /* output current point */
4093 US"if", /* condition type */
4096 case 1: goto EXPAND_FAILED; /* when all is well, the */
4097 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4100 /* Restore external setting of expansion variables for continuation
4103 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4104 save_expand_nlength);
4109 case EITEM_IMAPFOLDER:
4110 { /* ${imapfolder {name}{sep]{specials}} */
4114 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4117 case 1: goto EXPAND_FAILED_CURLY;
4119 case 3: goto EXPAND_FAILED;
4122 if (sub_arg[1] == NULL) /* One argument */
4124 sub_arg[1] = US"/"; /* default separator */
4127 else if (Ustrlen(sub_arg[1]) != 1)
4129 expand_string_message =
4131 "IMAP folder separator must be one character, found \"%s\"",
4136 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4137 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4140 yield = string_cat(yield, &size, &ptr, encoded, Ustrlen(encoded));
4145 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4146 expanding an internal string that isn't actually going to be used. All we
4147 need to do is check the syntax, so don't do a lookup at all. Preserve the
4148 values of the numerical expansion variables in case they get changed by a
4149 partial lookup. If not, they retain their external settings. At the end
4150 of this "lookup" section, they get restored to their previous values. */
4154 int stype, partial, affixlen, starflags;
4155 int expand_setup = 0;
4157 uschar *key, *filename;
4158 const uschar *affix;
4159 uschar *save_lookup_value = lookup_value;
4160 int save_expand_nmax =
4161 save_expand_strings(save_expand_nstring, save_expand_nlength);
4163 if ((expand_forbid & RDO_LOOKUP) != 0)
4165 expand_string_message = US"lookup expansions are not permitted";
4169 /* Get the key we are to look up for single-key+file style lookups.
4170 Otherwise set the key NULL pro-tem. */
4172 while (isspace(*s)) s++;
4173 if (*s == '{') /*}*/
4175 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4176 if (key == NULL) goto EXPAND_FAILED; /*{*/
4177 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4178 while (isspace(*s)) s++;
4182 /* Find out the type of database */
4186 expand_string_message = US"missing lookup type";
4190 /* The type is a string that may contain special characters of various
4191 kinds. Allow everything except space or { to appear; the actual content
4192 is checked by search_findtype_partial. */ /*}*/
4194 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4196 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4200 while (isspace(*s)) s++;
4202 /* Now check for the individual search type and any partial or default
4203 options. Only those types that are actually in the binary are valid. */
4205 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4209 expand_string_message = search_error_message;
4213 /* Check that a key was provided for those lookup types that need it,
4214 and was not supplied for those that use the query style. */
4216 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4220 expand_string_message = string_sprintf("missing {key} for single-"
4221 "key \"%s\" lookup", name);
4229 expand_string_message = string_sprintf("a single key was given for "
4230 "lookup type \"%s\", which is not a single-key lookup type", name);
4235 /* Get the next string in brackets and expand it. It is the file name for
4236 single-key+file lookups, and the whole query otherwise. In the case of
4237 queries that also require a file name (e.g. sqlite), the file name comes
4240 if (*s != '{') goto EXPAND_FAILED_CURLY;
4241 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4242 if (filename == NULL) goto EXPAND_FAILED;
4243 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4244 while (isspace(*s)) s++;
4246 /* If this isn't a single-key+file lookup, re-arrange the variables
4247 to be appropriate for the search_ functions. For query-style lookups,
4248 there is just a "key", and no file name. For the special query-style +
4249 file types, the query (i.e. "key") starts with a file name. */
4253 while (isspace(*filename)) filename++;
4256 if (mac_islookup(stype, lookup_querystyle))
4262 if (*filename != '/')
4264 expand_string_message = string_sprintf(
4265 "absolute file name expected for \"%s\" lookup", name);
4268 while (*key != 0 && !isspace(*key)) key++;
4269 if (*key != 0) *key++ = 0;
4273 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4274 the entry was not found. Note that there is no search_close() function.
4275 Files are left open in case of re-use. At suitable places in higher logic,
4276 search_tidyup() is called to tidy all open files. This can save opening
4277 the same file several times. However, files may also get closed when
4278 others are opened, if too many are open at once. The rule is that a
4279 handle should not be used after a second search_open().
4281 Request that a partial search sets up $1 and maybe $2 by passing
4282 expand_setup containing zero. If its value changes, reset expand_nmax,
4283 since new variables will have been set. Note that at the end of this
4284 "lookup" section, the old numeric variables are restored. */
4287 lookup_value = NULL;
4290 void *handle = search_open(filename, stype, 0, NULL, NULL);
4293 expand_string_message = search_error_message;
4296 lookup_value = search_find(handle, filename, key, partial, affix,
4297 affixlen, starflags, &expand_setup);
4298 if (search_find_defer)
4300 expand_string_message =
4301 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4302 string_printing2(key, FALSE), search_error_message);
4305 if (expand_setup > 0) expand_nmax = expand_setup;
4308 /* The handling of "yes" and "no" result strings is now in a separate
4309 function that is also used by ${if} and ${extract}. */
4311 switch(process_yesno(
4312 skipping, /* were previously skipping */
4313 lookup_value != NULL, /* success/failure indicator */
4314 save_lookup_value, /* value to reset for string2 */
4315 &s, /* input pointer */
4316 &yield, /* output pointer */
4317 &size, /* output size */
4318 &ptr, /* output current point */
4319 US"lookup", /* condition type */
4322 case 1: goto EXPAND_FAILED; /* when all is well, the */
4323 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4326 /* Restore external setting of expansion variables for carrying on
4327 at this level, and continue. */
4329 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4330 save_expand_nlength);
4334 /* If Perl support is configured, handle calling embedded perl subroutines,
4335 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4336 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4337 arguments (defined below). */
4339 #define EXIM_PERL_MAX_ARGS 8
4343 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4344 "is not included in this binary";
4347 #else /* EXIM_PERL */
4349 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4352 if ((expand_forbid & RDO_PERL) != 0)
4354 expand_string_message = US"Perl calls are not permitted";
4358 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4359 US"perl", &resetok))
4361 case 1: goto EXPAND_FAILED_CURLY;
4363 case 3: goto EXPAND_FAILED;
4366 /* If skipping, we don't actually do anything */
4368 if (skipping) continue;
4370 /* Start the interpreter if necessary */
4372 if (!opt_perl_started)
4375 if (opt_perl_startup == NULL)
4377 expand_string_message = US"A setting of perl_startup is needed when "
4378 "using the Perl interpreter";
4381 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4382 initerror = init_perl(opt_perl_startup);
4383 if (initerror != NULL)
4385 expand_string_message =
4386 string_sprintf("error in perl_startup code: %s\n", initerror);
4389 opt_perl_started = TRUE;
4392 /* Call the function */
4394 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4395 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4396 sub_arg[0], sub_arg + 1);
4398 /* NULL yield indicates failure; if the message pointer has been set to
4399 NULL, the yield was undef, indicating a forced failure. Otherwise the
4400 message will indicate some kind of Perl error. */
4402 if (new_yield == NULL)
4404 if (expand_string_message == NULL)
4406 expand_string_message =
4407 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4408 "failure", sub_arg[0]);
4409 expand_string_forcedfail = TRUE;
4414 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4415 set during a callback from Perl. */
4417 expand_string_forcedfail = FALSE;
4421 #endif /* EXIM_PERL */
4423 /* Transform email address to "prvs" scheme to use
4424 as BATV-signed return path */
4431 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4433 case 1: goto EXPAND_FAILED_CURLY;
4435 case 3: goto EXPAND_FAILED;
4438 /* If skipping, we don't actually do anything */
4439 if (skipping) continue;
4441 /* sub_arg[0] is the address */
4442 domain = Ustrrchr(sub_arg[0],'@');
4443 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4445 expand_string_message = US"prvs first argument must be a qualified email address";
4449 /* Calculate the hash. The second argument must be a single-digit
4450 key number, or unset. */
4452 if (sub_arg[2] != NULL &&
4453 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4455 expand_string_message = US"prvs second argument must be a single digit";
4459 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4462 expand_string_message = US"prvs hmac-sha1 conversion failed";
4466 /* Now separate the domain from the local part */
4469 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4470 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4471 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4472 string_cat(yield,&size,&ptr,p,6);
4473 string_cat(yield,&size,&ptr,US"=",1);
4474 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4475 string_cat(yield,&size,&ptr,US"@",1);
4476 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4481 /* Check a prvs-encoded address for validity */
4483 case EITEM_PRVSCHECK:
4486 int mysize = 0, myptr = 0;
4490 /* TF: Ugliness: We want to expand parameter 1 first, then set
4491 up expansion variables that are used in the expansion of
4492 parameter 2. So we clone the string for the first
4493 expansion, where we only expand parameter 1.
4495 PH: Actually, that isn't necessary. The read_subs() function is
4496 designed to work this way for the ${if and ${lookup expansions. I've
4500 /* Reset expansion variables */
4501 prvscheck_result = NULL;
4502 prvscheck_address = NULL;
4503 prvscheck_keynum = NULL;
4505 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4507 case 1: goto EXPAND_FAILED_CURLY;
4509 case 3: goto EXPAND_FAILED;
4512 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4515 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4517 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4518 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4519 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4520 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4521 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4523 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4524 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4525 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4526 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4527 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4529 /* Set up expansion variables */
4530 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4531 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4532 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4533 prvscheck_address[myptr] = '\0';
4534 prvscheck_keynum = string_copy(key_num);
4536 /* Now expand the second argument */
4537 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4539 case 1: goto EXPAND_FAILED_CURLY;
4541 case 3: goto EXPAND_FAILED;
4544 /* Now we have the key and can check the address. */
4546 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4551 expand_string_message = US"hmac-sha1 conversion failed";
4555 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4556 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4558 if (Ustrcmp(p,hash) == 0)
4560 /* Success, valid BATV address. Now check the expiry date. */
4561 uschar *now = prvs_daystamp(0);
4562 unsigned int inow = 0,iexpire = 1;
4564 (void)sscanf(CS now,"%u",&inow);
4565 (void)sscanf(CS daystamp,"%u",&iexpire);
4567 /* When "iexpire" is < 7, a "flip" has occured.
4568 Adjust "inow" accordingly. */
4569 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4571 if (iexpire >= inow)
4573 prvscheck_result = US"1";
4574 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4578 prvscheck_result = NULL;
4579 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4584 prvscheck_result = NULL;
4585 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4588 /* Now expand the final argument. We leave this till now so that
4589 it can include $prvscheck_result. */
4591 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4593 case 1: goto EXPAND_FAILED_CURLY;
4595 case 3: goto EXPAND_FAILED;
4598 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4599 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4601 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4603 /* Reset the "internal" variables afterwards, because they are in
4604 dynamic store that will be reclaimed if the expansion succeeded. */
4606 prvscheck_address = NULL;
4607 prvscheck_keynum = NULL;
4611 /* Does not look like a prvs encoded address, return the empty string.
4612 We need to make sure all subs are expanded first, so as to skip over
4615 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4617 case 1: goto EXPAND_FAILED_CURLY;
4619 case 3: goto EXPAND_FAILED;
4626 /* Handle "readfile" to insert an entire file */
4628 case EITEM_READFILE:
4633 if ((expand_forbid & RDO_READFILE) != 0)
4635 expand_string_message = US"file insertions are not permitted";
4639 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4641 case 1: goto EXPAND_FAILED_CURLY;
4643 case 3: goto EXPAND_FAILED;
4646 /* If skipping, we don't actually do anything */
4648 if (skipping) continue;
4650 /* Open the file and read it */
4652 f = Ufopen(sub_arg[0], "rb");
4655 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4659 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4664 /* Handle "readsocket" to insert data from a Unix domain socket */
4666 case EITEM_READSOCK:
4672 struct sockaddr_un sockun; /* don't call this "sun" ! */
4676 if ((expand_forbid & RDO_READSOCK) != 0)
4678 expand_string_message = US"socket insertions are not permitted";
4682 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4683 because there may be a string for expansion on failure. */
4685 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4687 case 1: goto EXPAND_FAILED_CURLY;
4688 case 2: /* Won't occur: no end check */
4689 case 3: goto EXPAND_FAILED;
4692 /* Sort out timeout, if given */
4694 if (sub_arg[2] != NULL)
4696 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4699 expand_string_message = string_sprintf("bad time value %s",
4704 else sub_arg[3] = NULL; /* No eol if no timeout */
4706 /* If skipping, we don't actually do anything. Otherwise, arrange to
4707 connect to either an IP or a Unix socket. */
4711 /* Handle an IP (internet) domain */
4713 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4716 uschar *server_name = sub_arg[0] + 5;
4717 uschar *port_name = Ustrrchr(server_name, ':');
4719 /* Sort out the port */
4721 if (port_name == NULL)
4723 expand_string_message =
4724 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4727 *port_name++ = 0; /* Terminate server name */
4729 if (isdigit(*port_name))
4732 port = Ustrtol(port_name, &end, 0);
4733 if (end != port_name + Ustrlen(port_name))
4735 expand_string_message =
4736 string_sprintf("invalid port number %s", port_name);
4742 struct servent *service_info = getservbyname(CS port_name, "tcp");
4743 if (service_info == NULL)
4745 expand_string_message = string_sprintf("unknown port \"%s\"",
4749 port = ntohs(service_info->s_port);
4752 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4753 timeout, NULL, &expand_string_message)) < 0)
4757 /* Handle a Unix domain socket */
4762 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4764 expand_string_message = string_sprintf("failed to create socket: %s",
4769 sockun.sun_family = AF_UNIX;
4770 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4773 sigalrm_seen = FALSE;
4775 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4779 expand_string_message = US "socket connect timed out";
4784 expand_string_message = string_sprintf("failed to connect to socket "
4785 "%s: %s", sub_arg[0], strerror(errno));
4790 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4792 /* Allow sequencing of test actions */
4793 if (running_in_test_harness) millisleep(100);
4795 /* Write the request string, if not empty */
4797 if (sub_arg[1][0] != 0)
4799 int len = Ustrlen(sub_arg[1]);
4800 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4802 if (write(fd, sub_arg[1], len) != len)
4804 expand_string_message = string_sprintf("request write to socket "
4805 "failed: %s", strerror(errno));
4810 /* Shut down the sending side of the socket. This helps some servers to
4811 recognise that it is their turn to do some work. Just in case some
4812 system doesn't have this function, make it conditional. */
4815 shutdown(fd, SHUT_WR);
4818 if (running_in_test_harness) millisleep(100);
4820 /* Now we need to read from the socket, under a timeout. The function
4821 that reads a file can be used. */
4823 f = fdopen(fd, "rb");
4824 sigalrm_seen = FALSE;
4826 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4830 /* After a timeout, we restore the pointer in the result, that is,
4831 make sure we add nothing from the socket. */
4836 expand_string_message = US "socket read timed out";
4841 /* The whole thing has worked (or we were skipping). If there is a
4842 failure string following, we need to skip it. */
4846 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4848 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4849 while (isspace(*s)) s++;
4851 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4854 /* Come here on failure to create socket, connect socket, write to the
4855 socket, or timeout on reading. If another substring follows, expand and
4856 use it. Otherwise, those conditions give expand errors. */
4859 if (*s != '{') goto EXPAND_FAILED;
4860 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4861 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4862 if (arg == NULL) goto EXPAND_FAILED;
4863 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4864 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4865 while (isspace(*s)) s++;
4866 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4870 /* Handle "run" to execute a program. */
4876 const uschar **argv;
4879 int lsize = 0, lptr = 0;
4881 if ((expand_forbid & RDO_RUN) != 0)
4883 expand_string_message = US"running a command is not permitted";
4887 while (isspace(*s)) s++;
4888 if (*s != '{') goto EXPAND_FAILED_CURLY;
4889 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4890 if (arg == NULL) goto EXPAND_FAILED;
4891 while (isspace(*s)) s++;
4892 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4894 if (skipping) /* Just pretend it worked when we're skipping */
4900 if (!transport_set_up_command(&argv, /* anchor for arg list */
4901 arg, /* raw command */
4902 FALSE, /* don't expand the arguments */
4903 0, /* not relevant when... */
4904 NULL, /* no transporting address */
4905 US"${run} expansion", /* for error messages */
4906 &expand_string_message)) /* where to put error message */
4909 /* Create the child process, making it a group leader. */
4911 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
4913 expand_string_message =
4914 string_sprintf("couldn't create child process: %s", strerror(errno));
4918 /* Nothing is written to the standard input. */
4922 /* Read the pipe to get the command's output into $value (which is kept
4923 in lookup_value). Read during execution, so that if the output exceeds
4924 the OS pipe buffer limit, we don't block forever. Remember to not release
4925 memory just allocated for $value. */
4928 f = fdopen(fd_out, "rb");
4929 sigalrm_seen = FALSE;
4931 lookup_value = cat_file(f, NULL, &lsize, &lptr, NULL);
4935 /* Wait for the process to finish, applying the timeout, and inspect its
4936 return code for serious disasters. Simple non-zero returns are passed on.
4939 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4941 if (sigalrm_seen == TRUE || runrc == -256)
4943 expand_string_message = string_sprintf("command timed out");
4944 killpg(pid, SIGKILL); /* Kill the whole process group */
4947 else if (runrc == -257)
4948 expand_string_message = string_sprintf("wait() failed: %s",
4952 expand_string_message = string_sprintf("command killed by signal %d",
4959 /* Process the yes/no strings; $value may be useful in both cases */
4961 switch(process_yesno(
4962 skipping, /* were previously skipping */
4963 runrc == 0, /* success/failure indicator */
4964 lookup_value, /* value to reset for string2 */
4965 &s, /* input pointer */
4966 &yield, /* output pointer */
4967 &size, /* output size */
4968 &ptr, /* output current point */
4969 US"run", /* condition type */
4972 case 1: goto EXPAND_FAILED; /* when all is well, the */
4973 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4979 /* Handle character translation for "tr" */
4987 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4989 case 1: goto EXPAND_FAILED_CURLY;
4991 case 3: goto EXPAND_FAILED;
4994 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4995 o2m = Ustrlen(sub[2]) - 1;
4997 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4999 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
5003 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
5010 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5011 expanded arguments. */
5021 int val[2] = { 0, -1 };
5024 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5025 Ensure that sub[2] is set in the ${length } case. */
5028 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5029 TRUE, name, &resetok))
5031 case 1: goto EXPAND_FAILED_CURLY;
5033 case 3: goto EXPAND_FAILED;
5036 /* Juggle the arguments if there are only two of them: always move the
5037 string to the last position and make ${length{n}{str}} equivalent to
5038 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5044 if (item_type == EITEM_LENGTH)
5051 for (i = 0; i < 2; i++)
5053 if (sub[i] == NULL) continue;
5054 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5055 if (*ret != 0 || (i != 0 && val[i] < 0))
5057 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5058 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5064 (item_type == EITEM_HASH)?
5065 compute_hash(sub[2], val[0], val[1], &len) :
5066 (item_type == EITEM_NHASH)?
5067 compute_nhash(sub[2], val[0], val[1], &len) :
5068 extract_substr(sub[2], val[0], val[1], &len);
5070 if (ret == NULL) goto EXPAND_FAILED;
5071 yield = string_cat(yield, &size, &ptr, ret, len);
5075 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5076 This code originally contributed by Steve Haslam. It currently supports
5077 the use of MD5 and SHA-1 hashes.
5079 We need some workspace that is large enough to handle all the supported
5080 hash types. Use macros to set the sizes rather than be too elaborate. */
5082 #define MAX_HASHLEN 20
5083 #define MAX_HASHBLOCKLEN 64
5092 int hashlen; /* Number of octets for the hash algorithm's output */
5093 int hashblocklen; /* Number of octets the hash algorithm processes */
5095 unsigned int keylen;
5097 uschar keyhash[MAX_HASHLEN];
5098 uschar innerhash[MAX_HASHLEN];
5099 uschar finalhash[MAX_HASHLEN];
5100 uschar finalhash_hex[2*MAX_HASHLEN];
5101 uschar innerkey[MAX_HASHBLOCKLEN];
5102 uschar outerkey[MAX_HASHBLOCKLEN];
5104 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5106 case 1: goto EXPAND_FAILED_CURLY;
5108 case 3: goto EXPAND_FAILED;
5113 if (Ustrcmp(sub[0], "md5") == 0)
5116 use_base = &md5_base;
5120 else if (Ustrcmp(sub[0], "sha1") == 0)
5123 use_base = &sha1_base;
5129 expand_string_message =
5130 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5135 keylen = Ustrlen(keyptr);
5137 /* If the key is longer than the hash block length, then hash the key
5140 if (keylen > hashblocklen)
5142 chash_start(type, use_base);
5143 chash_end(type, use_base, keyptr, keylen, keyhash);
5148 /* Now make the inner and outer key values */
5150 memset(innerkey, 0x36, hashblocklen);
5151 memset(outerkey, 0x5c, hashblocklen);
5153 for (i = 0; i < keylen; i++)
5155 innerkey[i] ^= keyptr[i];
5156 outerkey[i] ^= keyptr[i];
5159 /* Now do the hashes */
5161 chash_start(type, use_base);
5162 chash_mid(type, use_base, innerkey);
5163 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5165 chash_start(type, use_base);
5166 chash_mid(type, use_base, outerkey);
5167 chash_end(type, use_base, innerhash, hashlen, finalhash);
5169 /* Encode the final hash as a hex string */
5172 for (i = 0; i < hashlen; i++)
5174 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5175 *p++ = hex_digits[finalhash[i] & 0x0f];
5178 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n",
5179 sub[0], (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2,
5182 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5188 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5189 We have to save the numerical variables and restore them afterwards. */
5194 int moffset, moffsetextra, slen;
5197 const uschar *rerror;
5200 int save_expand_nmax =
5201 save_expand_strings(save_expand_nstring, save_expand_nlength);
5203 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5205 case 1: goto EXPAND_FAILED_CURLY;
5207 case 3: goto EXPAND_FAILED;
5210 /* Compile the regular expression */
5212 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5217 expand_string_message = string_sprintf("regular expression error in "
5218 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5222 /* Now run a loop to do the substitutions as often as necessary. It ends
5223 when there are no more matches. Take care over matches of the null string;
5224 do the same thing as Perl does. */
5227 slen = Ustrlen(sub[0]);
5228 moffset = moffsetextra = 0;
5233 int ovector[3*(EXPAND_MAXN+1)];
5234 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5235 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5239 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5240 is not necessarily the end. We want to repeat the match from one
5241 character further along, but leaving the basic offset the same (for
5242 copying below). We can't be at the end of the string - that was checked
5243 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5244 finished; copy the remaining string and end the loop. */
5254 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5258 /* Match - set up for expanding the replacement. */
5260 if (n == 0) n = EXPAND_MAXN + 1;
5262 for (nn = 0; nn < n*2; nn += 2)
5264 expand_nstring[expand_nmax] = subject + ovector[nn];
5265 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5269 /* Copy the characters before the match, plus the expanded insertion. */
5271 yield = string_cat(yield, &size, &ptr, subject + moffset,
5272 ovector[0] - moffset);
5273 insert = expand_string(sub[2]);
5274 if (insert == NULL) goto EXPAND_FAILED;
5275 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5277 moffset = ovector[1];
5281 /* If we have matched an empty string, first check to see if we are at
5282 the end of the subject. If so, the loop is over. Otherwise, mimic
5283 what Perl's /g options does. This turns out to be rather cunning. First
5284 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5285 string at the same point. If this fails (picked up above) we advance to
5286 the next character. */
5288 if (ovector[0] == ovector[1])
5290 if (ovector[0] == slen) break;
5291 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5295 /* All done - restore numerical variables. */
5297 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5298 save_expand_nlength);
5302 /* Handle keyed and numbered substring extraction. If the first argument
5303 consists entirely of digits, then a numerical extraction is assumed. */
5309 int field_number = 1;
5310 BOOL field_number_set = FALSE;
5311 uschar *save_lookup_value = lookup_value;
5313 int save_expand_nmax =
5314 save_expand_strings(save_expand_nstring, save_expand_nlength);
5316 /* Read the arguments */
5318 for (i = 0; i < j; i++)
5320 while (isspace(*s)) s++;
5321 if (*s == '{') /*}*/
5323 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5324 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5325 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5327 /* After removal of leading and trailing white space, the first
5328 argument must not be empty; if it consists entirely of digits
5329 (optionally preceded by a minus sign), this is a numerical
5330 extraction, and we expect 3 arguments. */
5338 while (isspace(*p)) p++;
5342 while (len > 0 && isspace(p[len-1])) len--;
5349 expand_string_message = US"first argument of \"extract\" must "
5359 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5363 j = 3; /* Need 3 args */
5364 field_number_set = TRUE;
5369 else goto EXPAND_FAILED_CURLY;
5372 /* Extract either the numbered or the keyed substring into $value. If
5373 skipping, just pretend the extraction failed. */
5375 lookup_value = skipping? NULL : field_number_set?
5376 expand_gettokened(field_number, sub[1], sub[2]) :
5377 expand_getkeyed(sub[0], sub[1]);
5379 /* If no string follows, $value gets substituted; otherwise there can
5380 be yes/no strings, as for lookup or if. */
5382 switch(process_yesno(
5383 skipping, /* were previously skipping */
5384 lookup_value != NULL, /* success/failure indicator */
5385 save_lookup_value, /* value to reset for string2 */
5386 &s, /* input pointer */
5387 &yield, /* output pointer */
5388 &size, /* output size */
5389 &ptr, /* output current point */
5390 US"extract", /* condition type */
5393 case 1: goto EXPAND_FAILED; /* when all is well, the */
5394 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5397 /* All done - restore numerical variables. */
5399 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5400 save_expand_nlength);
5405 /* return the Nth item from a list */
5407 case EITEM_LISTEXTRACT:
5410 int field_number = 1;
5411 uschar *save_lookup_value = lookup_value;
5413 int save_expand_nmax =
5414 save_expand_strings(save_expand_nstring, save_expand_nlength);
5416 /* Read the field & list arguments */
5418 for (i = 0; i < 2; i++)
5420 while (isspace(*s)) s++;
5421 if (*s != '{') /*}*/
5422 goto EXPAND_FAILED_CURLY;
5424 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5425 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5426 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5428 /* After removal of leading and trailing white space, the first
5429 argument must be numeric and nonempty. */
5437 while (isspace(*p)) p++;
5441 while (len > 0 && isspace(p[len-1])) len--;
5444 if (!*p && !skipping)
5446 expand_string_message = US"first argument of \"listextract\" must "
5456 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5459 expand_string_message = US"first argument of \"listextract\" must "
5467 /* Extract the numbered element into $value. If
5468 skipping, just pretend the extraction failed. */
5470 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5472 /* If no string follows, $value gets substituted; otherwise there can
5473 be yes/no strings, as for lookup or if. */
5475 switch(process_yesno(
5476 skipping, /* were previously skipping */
5477 lookup_value != NULL, /* success/failure indicator */
5478 save_lookup_value, /* value to reset for string2 */
5479 &s, /* input pointer */
5480 &yield, /* output pointer */
5481 &size, /* output size */
5482 &ptr, /* output current point */
5483 US"listextract", /* condition type */
5486 case 1: goto EXPAND_FAILED; /* when all is well, the */
5487 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5490 /* All done - restore numerical variables. */
5492 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5493 save_expand_nlength);
5499 case EITEM_CERTEXTRACT:
5501 uschar *save_lookup_value = lookup_value;
5503 int save_expand_nmax =
5504 save_expand_strings(save_expand_nstring, save_expand_nlength);
5506 /* Read the field argument */
5507 while (isspace(*s)) s++;
5508 if (*s != '{') /*}*/
5509 goto EXPAND_FAILED_CURLY;
5510 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5511 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5512 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5513 /* strip spaces fore & aft */
5518 while (isspace(*p)) p++;
5522 while (len > 0 && isspace(p[len-1])) len--;
5526 /* inspect the cert argument */
5527 while (isspace(*s)) s++;
5528 if (*s != '{') /*}*/
5529 goto EXPAND_FAILED_CURLY;
5532 expand_string_message = US"second argument of \"certextract\" must "
5533 "be a certificate variable";
5536 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5537 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5538 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5541 lookup_value = NULL;
5544 lookup_value = expand_getcertele(sub[0], sub[1]);
5545 if (*expand_string_message) goto EXPAND_FAILED;
5547 switch(process_yesno(
5548 skipping, /* were previously skipping */
5549 lookup_value != NULL, /* success/failure indicator */
5550 save_lookup_value, /* value to reset for string2 */
5551 &s, /* input pointer */
5552 &yield, /* output pointer */
5553 &size, /* output size */
5554 &ptr, /* output current point */
5555 US"certextract", /* condition type */
5558 case 1: goto EXPAND_FAILED; /* when all is well, the */
5559 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5562 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5563 save_expand_nlength);
5566 #endif /*SUPPORT_TLS*/
5568 /* Handle list operations */
5576 uschar outsep[2] = { '\0', '\0' };
5577 const uschar *list, *expr, *temp;
5578 uschar *save_iterate_item = iterate_item;
5579 uschar *save_lookup_value = lookup_value;
5581 while (isspace(*s)) s++;
5582 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5584 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5585 if (list == NULL) goto EXPAND_FAILED;
5586 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5588 if (item_type == EITEM_REDUCE)
5591 while (isspace(*s)) s++;
5592 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5593 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5594 if (!t) goto EXPAND_FAILED;
5596 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5599 while (isspace(*s)) s++;
5600 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5604 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5605 if scanning a "false" part). This allows us to find the end of the
5606 condition, because if the list is empty, we won't actually evaluate the
5607 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5608 the normal internal expansion function. */
5610 if (item_type == EITEM_FILTER)
5612 temp = eval_condition(expr, &resetok, NULL);
5613 if (temp != NULL) s = temp;
5616 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5620 expand_string_message = string_sprintf("%s inside \"%s\" item",
5621 expand_string_message, name);
5625 while (isspace(*s)) s++;
5628 expand_string_message = string_sprintf("missing } at end of condition "
5629 "or expression inside \"%s\"", name);
5633 while (isspace(*s)) s++; /*{*/
5636 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5641 /* If we are skipping, we can now just move on to the next item. When
5642 processing for real, we perform the iteration. */
5644 if (skipping) continue;
5645 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5647 *outsep = (uschar)sep; /* Separator as a string */
5649 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5651 if (item_type == EITEM_FILTER)
5654 if (eval_condition(expr, &resetok, &condresult) == NULL)
5656 iterate_item = save_iterate_item;
5657 lookup_value = save_lookup_value;
5658 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5659 expand_string_message, name);
5662 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5663 condresult? "true":"false");
5665 temp = iterate_item; /* TRUE => include this item */
5667 continue; /* FALSE => skip this item */
5670 /* EITEM_MAP and EITEM_REDUCE */
5674 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5678 iterate_item = save_iterate_item;
5679 expand_string_message = string_sprintf("%s inside \"%s\" item",
5680 expand_string_message, name);
5683 if (item_type == EITEM_REDUCE)
5685 lookup_value = t; /* Update the value of $value */
5686 continue; /* and continue the iteration */
5690 /* We reach here for FILTER if the condition is true, always for MAP,
5691 and never for REDUCE. The value in "temp" is to be added to the output
5692 list that is being created, ensuring that any occurrences of the
5693 separator character are doubled. Unless we are dealing with the first
5694 item of the output list, add in a space if the new item begins with the
5695 separator character, or is an empty string. */
5697 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5698 yield = string_cat(yield, &size, &ptr, US" ", 1);
5700 /* Add the string in "temp" to the output list that we are building,
5701 This is done in chunks by searching for the separator character. */
5705 size_t seglen = Ustrcspn(temp, outsep);
5706 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5708 /* If we got to the end of the string we output one character
5709 too many; backup and end the loop. Otherwise arrange to double the
5712 if (temp[seglen] == '\0') { ptr--; break; }
5713 yield = string_cat(yield, &size, &ptr, outsep, 1);
5717 /* Output a separator after the string: we will remove the redundant
5718 final one at the end. */
5720 yield = string_cat(yield, &size, &ptr, outsep, 1);
5721 } /* End of iteration over the list loop */
5723 /* REDUCE has generated no output above: output the final value of
5726 if (item_type == EITEM_REDUCE)
5728 yield = string_cat(yield, &size, &ptr, lookup_value,
5729 Ustrlen(lookup_value));
5730 lookup_value = save_lookup_value; /* Restore $value */
5733 /* FILTER and MAP generate lists: if they have generated anything, remove
5734 the redundant final separator. Even though an empty item at the end of a
5735 list does not count, this is tidier. */
5737 else if (ptr != save_ptr) ptr--;
5739 /* Restore preserved $item */
5741 iterate_item = save_iterate_item;
5748 const uschar *srclist, *cmp, *xtract;
5750 const uschar *dstlist = NULL, *dstkeylist = NULL;
5752 uschar *save_iterate_item = iterate_item;
5754 while (isspace(*s)) s++;
5755 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5757 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5758 if (!srclist) goto EXPAND_FAILED;
5759 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5761 while (isspace(*s)) s++;
5762 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5764 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5765 if (!cmp) goto EXPAND_FAILED;
5766 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5768 while (isspace(*s)) s++;
5769 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5772 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5773 if (!tmp) goto EXPAND_FAILED;
5774 xtract = string_copyn(xtract, s - xtract);
5776 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5780 expand_string_message = US"missing } at end of \"sort\"";
5784 if (skipping) continue;
5786 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5789 uschar * newlist = NULL;
5790 uschar * newkeylist = NULL;
5793 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, srcitem);
5795 /* extract field for comparisons */
5796 iterate_item = srcitem;
5797 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5801 expand_string_message = string_sprintf(
5802 "field-extract in sort: \"%s\"", xtract);
5806 /* Insertion sort */
5808 /* copy output list until new-item < list-item */
5809 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5815 /* field for comparison */
5816 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5819 /* build and run condition string */
5820 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
5822 DEBUG(D_expand) debug_printf("%s: cond = \"%s\"\n", name, expr);
5823 if (!eval_condition(expr, &resetok, &before))
5825 expand_string_message = string_sprintf("comparison in sort: %s",
5832 /* New-item sorts before this dst-item. Append new-item,
5833 then dst-item, then remainder of dst list. */
5835 newlist = string_append_listele(newlist, sep, srcitem);
5836 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5839 newlist = string_append_listele(newlist, sep, dstitem);
5840 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5842 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5844 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5846 newlist = string_append_listele(newlist, sep, dstitem);
5847 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5853 newlist = string_append_listele(newlist, sep, dstitem);
5854 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5857 /* If we ran out of dstlist without consuming srcitem, append it */
5860 newlist = string_append_listele(newlist, sep, srcitem);
5861 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5865 dstkeylist = newkeylist;
5867 DEBUG(D_expand) debug_printf("%s: dstlist = \"%s\"\n", name, dstlist);
5868 DEBUG(D_expand) debug_printf("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
5872 yield = string_cat(yield, &size, &ptr, dstlist, Ustrlen(dstlist));
5874 /* Restore preserved $item */
5875 iterate_item = save_iterate_item;
5879 expand_string_message = US"Internal error in sort (list mismatch)";
5884 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5885 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5886 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5887 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5889 #define EXPAND_DLFUNC_MAX_ARGS 8
5892 #ifndef EXPAND_DLFUNC
5893 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5894 "is not included in this binary";
5897 #else /* EXPAND_DLFUNC */
5900 exim_dlfunc_t *func;
5903 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5905 if ((expand_forbid & RDO_DLFUNC) != 0)
5907 expand_string_message =
5908 US"dynamically-loaded functions are not permitted";
5912 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5913 TRUE, US"dlfunc", &resetok))
5915 case 1: goto EXPAND_FAILED_CURLY;
5917 case 3: goto EXPAND_FAILED;
5920 /* If skipping, we don't actually do anything */
5922 if (skipping) continue;
5924 /* Look up the dynamically loaded object handle in the tree. If it isn't
5925 found, dlopen() the file and put the handle in the tree for next time. */
5927 t = tree_search(dlobj_anchor, argv[0]);
5930 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5933 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5934 argv[0], dlerror());
5935 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5938 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5939 Ustrcpy(t->name, argv[0]);
5940 t->data.ptr = handle;
5941 (void)tree_insertnode(&dlobj_anchor, t);
5944 /* Having obtained the dynamically loaded object handle, look up the
5945 function pointer. */
5947 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5950 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5951 "%s", argv[1], argv[0], dlerror());
5952 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5956 /* Call the function and work out what to do with the result. If it
5957 returns OK, we have a replacement string; if it returns DEFER then
5958 expansion has failed in a non-forced manner; if it returns FAIL then
5959 failure was forced; if it returns ERROR or any other value there's a
5960 problem, so panic slightly. In any case, assume that the function has
5961 side-effects on the store that must be preserved. */
5965 for (argc = 0; argv[argc] != NULL; argc++);
5966 status = func(&result, argc - 2, &argv[2]);
5969 if (result == NULL) result = US"";
5970 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5975 expand_string_message = result == NULL ? US"(no message)" : result;
5976 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5977 else if(status != FAIL)
5978 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5979 argv[0], argv[1], status, expand_string_message);
5983 #endif /* EXPAND_DLFUNC */
5985 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
5988 uschar *save_lookup_value = lookup_value;
5990 while (isspace(*s)) s++;
5991 if (*s != '{') /*}*/
5994 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5995 if (!key) goto EXPAND_FAILED; /*{*/
5996 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5998 lookup_value = US getenv(CS key);
6000 switch(process_yesno(
6001 skipping, /* were previously skipping */
6002 lookup_value != NULL, /* success/failure indicator */
6003 save_lookup_value, /* value to reset for string2 */
6004 &s, /* input pointer */
6005 &yield, /* output pointer */
6006 &size, /* output size */
6007 &ptr, /* output current point */
6008 US"env", /* condition type */
6011 case 1: goto EXPAND_FAILED; /* when all is well, the */
6012 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6016 } /* EITEM_* switch */
6018 /* Control reaches here if the name is not recognized as one of the more
6019 complicated expansion items. Check for the "operator" syntax (name terminated
6020 by a colon). Some of the operators have arguments, separated by _ from the
6028 var_entry *vp = NULL;
6030 /* Owing to an historical mis-design, an underscore may be part of the
6031 operator name, or it may introduce arguments. We therefore first scan the
6032 table of names that contain underscores. If there is no match, we cut off
6033 the arguments and then scan the main table. */
6035 if ((c = chop_match(name, op_table_underscore,
6036 nelem(op_table_underscore))) < 0)
6038 arg = Ustrchr(name, '_');
6039 if (arg != NULL) *arg = 0;
6040 c = chop_match(name, op_table_main, nelem(op_table_main));
6041 if (c >= 0) c += nelem(op_table_underscore);
6042 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6045 /* Deal specially with operators that might take a certificate variable
6046 as we do not want to do the usual expansion. For most, expand the string.*/
6056 const uschar * s1 = s;
6057 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6059 if (!sub) goto EXPAND_FAILED; /*{*/
6060 if (*s1 != '}') goto EXPAND_FAILED_CURLY;
6061 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6071 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6072 if (!sub) goto EXPAND_FAILED;
6077 /* If we are skipping, we don't need to perform the operation at all.
6078 This matters for operations like "mask", because the data may not be
6079 in the correct format when skipping. For example, the expression may test
6080 for the existence of $sender_host_address before trying to mask it. For
6081 other operations, doing them may not fail, but it is a waste of time. */
6083 if (skipping && c >= 0) continue;
6085 /* Otherwise, switch on the operator type */
6092 unsigned long int n = Ustrtoul(sub, &t, 10);
6098 expand_string_message = string_sprintf("argument for base32 "
6099 "operator is \"%s\", which is not a decimal number", sub);
6103 s = string_cat(s, &sz, &i, &base32_chars[n & 0x1f], 1);
6105 while (i > 0) yield = string_cat(yield, &size, &ptr, &s[--i], 1);
6112 unsigned long int n = 0;
6116 uschar * t = Ustrchr(base32_chars, *tt++);
6119 expand_string_message = string_sprintf("argument for base32d "
6120 "operator is \"%s\", which is not a base 32 number", sub);
6123 n = n * 32 + (t - base32_chars);
6125 s = string_sprintf("%ld", n);
6126 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6133 unsigned long int n = Ustrtoul(sub, &t, 10);
6136 expand_string_message = string_sprintf("argument for base62 "
6137 "operator is \"%s\", which is not a decimal number", sub);
6140 t = string_base62(n);
6141 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6145 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6151 unsigned long int n = 0;
6154 uschar *t = Ustrchr(base62_chars, *tt++);
6157 expand_string_message = string_sprintf("argument for base62d "
6158 "operator is \"%s\", which is not a base %d number", sub,
6162 n = n * BASE_62 + (t - base62_chars);
6164 (void)sprintf(CS buf, "%ld", n);
6165 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
6171 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6172 if (expanded == NULL)
6174 expand_string_message =
6175 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6176 expand_string_message);
6179 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
6186 uschar *t = sub - 1;
6187 while (*(++t) != 0) { *t = tolower(*t); count++; }
6188 yield = string_cat(yield, &size, &ptr, sub, count);
6195 uschar *t = sub - 1;
6196 while (*(++t) != 0) { *t = toupper(*t); count++; }
6197 yield = string_cat(yield, &size, &ptr, sub, count);
6203 if (vp && *(void **)vp->value)
6205 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6206 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6216 md5_end(&base, sub, Ustrlen(sub), digest);
6217 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6218 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6224 if (vp && *(void **)vp->value)
6226 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6227 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6237 sha1_end(&base, sub, Ustrlen(sub), digest);
6238 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6239 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6245 if (vp && *(void **)vp->value)
6247 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6248 yield = string_cat(yield, &size, &ptr, cp, (int)Ustrlen(cp));
6252 expand_string_message = US"sha256 only supported for certificates";
6255 /* Convert hex encoding to base64 encoding */
6265 for (enc = sub; *enc != 0; enc++)
6267 if (!isxdigit(*enc))
6269 expand_string_message = string_sprintf("\"%s\" is not a hex "
6278 expand_string_message = string_sprintf("\"%s\" contains an odd "
6279 "number of characters", sub);
6283 while ((c = *in++) != 0)
6285 if (isdigit(c)) c -= '0';
6286 else c = toupper(c) - 'A' + 10;
6298 enc = b64encode(sub, out - sub);
6299 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
6303 /* Convert octets outside 0x21..0x7E to \xXX form */
6307 uschar *t = sub - 1;
6310 if (*t < 0x21 || 0x7E < *t)
6311 yield = string_cat(yield, &size, &ptr,
6312 string_sprintf("\\x%02x", *t), 4);
6314 yield = string_cat(yield, &size, &ptr, t, 1);
6319 /* count the number of list elements */
6328 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6329 cp = string_sprintf("%d", cnt);
6330 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6334 /* expand a named list given the name */
6335 /* handles nested named lists; requotes as colon-sep list */
6339 tree_node *t = NULL;
6340 const uschar * list;
6343 uschar * suffix = US"";
6344 BOOL needsep = FALSE;
6347 if (*sub == '+') sub++;
6348 if (arg == NULL) /* no-argument version */
6350 if (!(t = tree_search(addresslist_anchor, sub)) &&
6351 !(t = tree_search(domainlist_anchor, sub)) &&
6352 !(t = tree_search(hostlist_anchor, sub)))
6353 t = tree_search(localpartlist_anchor, sub);
6355 else switch(*arg) /* specific list-type version */
6357 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6358 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6359 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6360 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6362 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6368 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6370 : *arg=='a'?"address "
6371 : *arg=='d'?"domain "
6373 : *arg=='l'?"localpart "
6378 list = ((namedlist_block *)(t->data.ptr))->string;
6380 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6382 uschar * buf = US" : ";
6384 yield = string_cat(yield, &size, &ptr, buf, 3);
6388 if (*item == '+') /* list item is itself a named list */
6390 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6391 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6393 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6397 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6398 while ((cp= strpbrk((const char *)item, tok)))
6400 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
6401 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6403 yield = string_cat(yield, &size, &ptr, US"::", 2);
6404 item = (uschar *)cp;
6406 else /* sep in item; should already be doubled; emit once */
6408 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
6409 if (*cp == sep) cp++;
6410 item = (uschar *)cp;
6414 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
6419 /* mask applies a mask to an IP address; for example the result of
6420 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6427 int mask, maskoffset;
6428 int type = string_is_ip_address(sub, &maskoffset);
6433 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6438 if (maskoffset == 0)
6440 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6445 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6447 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6449 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6454 /* Convert the address to binary integer(s) and apply the mask */
6456 sub[maskoffset] = 0;
6457 count = host_aton(sub, binary);
6458 host_mask(count, binary, mask);
6460 /* Convert to masked textual format and add to output. */
6462 yield = string_cat(yield, &size, &ptr, buffer,
6463 host_nmtoa(count, binary, mask, buffer, '.'));
6468 case EOP_IPV6DENORM:
6470 int type = string_is_ip_address(sub, NULL);
6477 (void) host_aton(sub, binary);
6480 case 4: /* convert to IPv4-mapped IPv6 */
6481 binary[0] = binary[1] = 0;
6482 binary[2] = 0x0000ffff;
6483 (void) host_aton(sub, binary+3);
6487 expand_string_message =
6488 string_sprintf("\"%s\" is not an IP address", sub);
6492 yield = string_cat(yield, &size, &ptr, buffer,
6494 ? ipv6_nmtoa(binary, buffer)
6495 : host_nmtoa(4, binary, -1, buffer, ':')
6501 case EOP_LOCAL_PART:
6505 int start, end, domain;
6506 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6510 if (c != EOP_DOMAIN)
6512 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6513 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
6515 else if (domain != 0)
6518 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
6526 uschar outsep[2] = { ':', '\0' };
6527 uschar *address, *error;
6529 int start, end, domain; /* Not really used */
6531 while (isspace(*sub)) sub++;
6532 if (*sub == '>') { *outsep = *++sub; ++sub; }
6533 parse_allow_group = TRUE;
6537 uschar *p = parse_find_address_end(sub, FALSE);
6538 uschar saveend = *p;
6540 address = parse_extract_address(sub, &error, &start, &end, &domain,
6544 /* Add the address to the output list that we are building. This is
6545 done in chunks by searching for the separator character. At the
6546 start, unless we are dealing with the first address of the output
6547 list, add in a space if the new address begins with the separator
6548 character, or is an empty string. */
6550 if (address != NULL)
6552 if (ptr != save_ptr && address[0] == *outsep)
6553 yield = string_cat(yield, &size, &ptr, US" ", 1);
6557 size_t seglen = Ustrcspn(address, outsep);
6558 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
6560 /* If we got to the end of the string we output one character
6563 if (address[seglen] == '\0') { ptr--; break; }
6564 yield = string_cat(yield, &size, &ptr, outsep, 1);
6565 address += seglen + 1;
6568 /* Output a separator after the string: we will remove the
6569 redundant final one at the end. */
6571 yield = string_cat(yield, &size, &ptr, outsep, 1);
6574 if (saveend == '\0') break;
6578 /* If we have generated anything, remove the redundant final
6581 if (ptr != save_ptr) ptr--;
6582 parse_allow_group = FALSE;
6587 /* quote puts a string in quotes if it is empty or contains anything
6588 other than alphamerics, underscore, dot, or hyphen.
6590 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6591 be quoted in order to be a valid local part.
6593 In both cases, newlines and carriage returns are converted into \n and \r
6597 case EOP_QUOTE_LOCAL_PART:
6600 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6601 uschar *t = sub - 1;
6605 while (!needs_quote && *(++t) != 0)
6606 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6608 else /* EOP_QUOTE_LOCAL_PART */
6610 while (!needs_quote && *(++t) != 0)
6611 needs_quote = !isalnum(*t) &&
6612 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6613 (*t != '.' || t == sub || t[1] == 0);
6618 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6623 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6624 else if (*t == '\r')
6625 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6628 if (*t == '\\' || *t == '"')
6629 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6630 yield = string_cat(yield, &size, &ptr, t, 1);
6633 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6635 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6639 /* quote_lookuptype does lookup-specific quoting */
6644 uschar *opt = Ustrchr(arg, '_');
6646 if (opt != NULL) *opt++ = 0;
6648 n = search_findtype(arg, Ustrlen(arg));
6651 expand_string_message = search_error_message;
6655 if (lookup_list[n]->quote != NULL)
6656 sub = (lookup_list[n]->quote)(sub, opt);
6657 else if (opt != NULL) sub = NULL;
6661 expand_string_message = string_sprintf(
6662 "\"%s\" unrecognized after \"${quote_%s\"",
6667 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6671 /* rx quote sticks in \ before any non-alphameric character so that
6672 the insertion works in a regular expression. */
6676 uschar *t = sub - 1;
6680 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6681 yield = string_cat(yield, &size, &ptr, t, 1);
6686 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6687 prescribed by the RFC, if there are characters that need to be encoded */
6691 uschar buffer[2048];
6692 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6693 buffer, sizeof(buffer), FALSE);
6694 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6698 /* RFC 2047 decode */
6704 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6705 headers_charset, '?', &len, &error);
6708 expand_string_message = error;
6711 yield = string_cat(yield, &size, &ptr, decoded, len);
6715 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6725 if (c > 255) c = '_';
6727 yield = string_cat(yield, &size, &ptr, buff, 1);
6732 /* replace illegal UTF-8 sequences by replacement character */
6734 #define UTF8_REPLACEMENT_CHAR US"?"
6738 int seq_len = 0, index = 0;
6740 long codepoint = -1;
6741 uschar seq_buff[4]; /* accumulate utf-8 here */
6750 if ((c & 0xc0) != 0x80)
6751 /* wrong continuation byte; invalidate all bytes */
6752 complete = 1; /* error */
6755 codepoint = (codepoint << 6) | (c & 0x3f);
6756 seq_buff[index++] = c;
6757 if (--bytes_left == 0) /* codepoint complete */
6758 if(codepoint > 0x10FFFF) /* is it too large? */
6759 complete = -1; /* error (RFC3629 limit) */
6761 { /* finished; output utf-8 sequence */
6762 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6767 else /* no bytes left: new sequence */
6769 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6771 yield = string_cat(yield, &size, &ptr, &c, 1);
6774 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6776 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6781 codepoint = c & 0x1f;
6784 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6787 codepoint = c & 0x0f;
6789 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6792 codepoint = c & 0x07;
6794 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6797 seq_buff[index++] = c;
6798 seq_len = bytes_left + 1;
6799 } /* if(bytes_left) */
6803 bytes_left = index = 0;
6804 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6806 if ((complete == 1) && ((c & 0x80) == 0))
6807 /* ASCII character follows incomplete sequence */
6808 yield = string_cat(yield, &size, &ptr, &c, 1);
6814 case EOP_UTF8_DOMAIN_TO_ALABEL:
6816 uschar * error = NULL;
6817 uschar * s = string_domain_utf8_to_alabel(sub, &error);
6820 expand_string_message = string_sprintf(
6821 "error converting utf8 (%s) to alabel: %s",
6822 string_printing(sub), error);
6825 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6829 case EOP_UTF8_DOMAIN_FROM_ALABEL:
6831 uschar * error = NULL;
6832 uschar * s = string_domain_alabel_to_utf8(sub, &error);
6835 expand_string_message = string_sprintf(
6836 "error converting alabel (%s) to utf8: %s",
6837 string_printing(sub), error);
6840 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6844 case EOP_UTF8_LOCALPART_TO_ALABEL:
6846 uschar * error = NULL;
6847 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
6850 expand_string_message = string_sprintf(
6851 "error converting utf8 (%s) to alabel: %s",
6852 string_printing(sub), error);
6855 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6856 DEBUG(D_expand) debug_printf("yield: '%s'\n", yield);
6860 case EOP_UTF8_LOCALPART_FROM_ALABEL:
6862 uschar * error = NULL;
6863 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
6866 expand_string_message = string_sprintf(
6867 "error converting alabel (%s) to utf8: %s",
6868 string_printing(sub), error);
6871 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6874 #endif /* EXPERIMENTAL_INTERNATIONAL */
6876 /* escape turns all non-printing characters into escape sequences. */
6880 const uschar *t = string_printing(sub);
6881 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6885 /* Handle numeric expression evaluation */
6890 uschar *save_sub = sub;
6891 uschar *error = NULL;
6892 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6895 expand_string_message = string_sprintf("error in expression "
6896 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6900 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6901 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6905 /* Handle time period formating */
6909 int n = readconf_readtime(sub, 0, FALSE);
6912 expand_string_message = string_sprintf("string \"%s\" is not an "
6913 "Exim time interval in \"%s\" operator", sub, name);
6916 sprintf(CS var_buffer, "%d", n);
6917 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6921 case EOP_TIME_INTERVAL:
6924 uschar *t = read_number(&n, sub);
6925 if (*t != 0) /* Not A Number*/
6927 expand_string_message = string_sprintf("string \"%s\" is not a "
6928 "positive number in \"%s\" operator", sub, name);
6931 t = readconf_printtime(n);
6932 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6936 /* Convert string to base64 encoding */
6942 uschar * s = vp && *(void **)vp->value
6943 ? tls_cert_der_b64(*(void **)vp->value)
6944 : b64encode(sub, Ustrlen(sub));
6946 uschar * s = b64encode(sub, Ustrlen(sub));
6948 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6955 int len = b64decode(sub, &s);
6958 expand_string_message = string_sprintf("string \"%s\" is not "
6959 "well-formed for \"%s\" operator", sub, name);
6962 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6966 /* strlen returns the length of the string */
6971 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6972 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6976 /* length_n or l_n takes just the first n characters or the whole string,
6977 whichever is the shorter;
6979 substr_m_n, and s_m_n take n characters from offset m; negative m take
6980 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6981 takes the rest, either to the right or to the left.
6983 hash_n or h_n makes a hash of length n from the string, yielding n
6984 characters from the set a-z; hash_n_m makes a hash of length n, but
6985 uses m characters from the set a-zA-Z0-9.
6987 nhash_n returns a single number between 0 and n-1 (in text form), while
6988 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6989 between 0 and n-1 and the second between 0 and m-1. */
7009 expand_string_message = string_sprintf("missing values after %s",
7014 /* "length" has only one argument, effectively being synonymous with
7017 if (c == EOP_LENGTH || c == EOP_L)
7023 /* The others have one or two arguments; for "substr" the first may be
7024 negative. The second being negative means "not supplied". */
7029 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7032 /* Read up to two numbers, separated by underscores */
7037 if (arg != ret && *arg == '_' && pn == &value1)
7041 if (arg[1] != 0) arg++;
7043 else if (!isdigit(*arg))
7045 expand_string_message =
7046 string_sprintf("non-digit after underscore in \"%s\"", name);
7049 else *pn = (*pn)*10 + *arg++ - '0';
7053 /* Perform the required operation */
7056 (c == EOP_HASH || c == EOP_H)?
7057 compute_hash(sub, value1, value2, &len) :
7058 (c == EOP_NHASH || c == EOP_NH)?
7059 compute_nhash(sub, value1, value2, &len) :
7060 extract_substr(sub, value1, value2, &len);
7062 if (ret == NULL) goto EXPAND_FAILED;
7063 yield = string_cat(yield, &size, &ptr, ret, len);
7073 uschar **modetable[3];
7078 if ((expand_forbid & RDO_EXISTS) != 0)
7080 expand_string_message = US"Use of the stat() expansion is not permitted";
7084 if (stat(CS sub, &st) < 0)
7086 expand_string_message = string_sprintf("stat(%s) failed: %s",
7087 sub, strerror(errno));
7091 switch (mode & S_IFMT)
7093 case S_IFIFO: smode[0] = 'p'; break;
7094 case S_IFCHR: smode[0] = 'c'; break;
7095 case S_IFDIR: smode[0] = 'd'; break;
7096 case S_IFBLK: smode[0] = 'b'; break;
7097 case S_IFREG: smode[0] = '-'; break;
7098 default: smode[0] = '?'; break;
7101 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7102 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7103 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7105 for (i = 0; i < 3; i++)
7107 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7112 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7113 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7114 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7115 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7116 (long)st.st_gid, st.st_size, (long)st.st_atime,
7117 (long)st.st_mtime, (long)st.st_ctime);
7118 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
7122 /* vaguely random number less than N */
7126 int_eximarith_t max;
7129 max = expanded_string_integer(sub, TRUE);
7130 if (expand_string_message != NULL)
7132 s = string_sprintf("%d", vaguely_random_number((int)max));
7133 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
7137 /* Reverse IP, including IPv6 to dotted-nibble */
7139 case EOP_REVERSE_IP:
7141 int family, maskptr;
7142 uschar reversed[128];
7144 family = string_is_ip_address(sub, &maskptr);
7147 expand_string_message = string_sprintf(
7148 "reverse_ip() not given an IP address [%s]", sub);
7151 invert_address(reversed, sub);
7152 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
7156 /* Unknown operator */
7159 expand_string_message =
7160 string_sprintf("unknown expansion operator \"%s\"", name);
7165 /* Handle a plain name. If this is the first thing in the expansion, release
7166 the pre-allocated buffer. If the result data is known to be in a new buffer,
7167 newsize will be set to the size of that buffer, and we can just point at that
7168 store instead of copying. Many expansion strings contain just one reference,
7169 so this is a useful optimization, especially for humungous headers
7170 ($message_headers). */
7178 if (resetok) store_reset(yield);
7182 value = find_variable(name, FALSE, skipping, &newsize);
7185 expand_string_message =
7186 string_sprintf("unknown variable in \"${%s}\"", name);
7187 check_variable_error_message(name);
7190 len = Ustrlen(value);
7191 if (yield == NULL && newsize != 0)
7197 else yield = string_cat(yield, &size, &ptr, value, len);
7201 /* Else there's something wrong */
7203 expand_string_message =
7204 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7205 "in a variable reference)", name);
7209 /* If we hit the end of the string when ket_ends is set, there is a missing
7210 terminating brace. */
7212 if (ket_ends && *s == 0)
7214 expand_string_message = malformed_header?
7215 US"missing } at end of string - could be header name not terminated by colon"
7217 US"missing } at end of string";
7221 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7222 added to the string. If so, set up an empty string. Add a terminating zero. If
7223 left != NULL, return a pointer to the terminator. */
7225 if (yield == NULL) yield = store_get(1);
7227 if (left != NULL) *left = s;
7229 /* Any stacking store that was used above the final string is no longer needed.
7230 In many cases the final string will be the first one that was got and so there
7231 will be optimal store usage. */
7233 if (resetok) store_reset(yield + ptr + 1);
7234 else if (resetok_p) *resetok_p = FALSE;
7238 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
7240 if (skipping) debug_printf("skipping: result is not used\n");
7244 /* This is the failure exit: easiest to program with a goto. We still need
7245 to update the pointer to the terminator, for cases of nested calls with "fail".
7248 EXPAND_FAILED_CURLY:
7249 expand_string_message = malformed_header?
7250 US"missing or misplaced { or } - could be header name not terminated by colon"
7252 US"missing or misplaced { or }";
7254 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7255 that is a bad idea, because expand_string_message is in dynamic store. */
7258 if (left != NULL) *left = s;
7261 debug_printf("failed to expand: %s\n", string);
7262 debug_printf(" error message: %s\n", expand_string_message);
7263 if (expand_string_forcedfail) debug_printf("failure was forced\n");
7265 if (resetok_p) *resetok_p = resetok;
7270 /* This is the external function call. Do a quick check for any expansion
7271 metacharacters, and if there are none, just return the input string.
7273 Argument: the string to be expanded
7274 Returns: the expanded string, or NULL if expansion failed; if failure was
7275 due to a lookup deferring, search_find_defer will be TRUE
7279 expand_string(uschar *string)
7281 search_find_defer = FALSE;
7282 malformed_header = FALSE;
7283 return (Ustrpbrk(string, "$\\") == NULL)? string :
7284 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7290 expand_cstring(const uschar *string)
7292 search_find_defer = FALSE;
7293 malformed_header = FALSE;
7294 return (Ustrpbrk(string, "$\\") == NULL)? string :
7295 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7300 /*************************************************
7302 *************************************************/
7304 /* Now and again we want to expand a string and be sure that the result is in a
7305 new bit of store. This function does that.
7306 Since we know it has been copied, the de-const cast is safe.
7308 Argument: the string to be expanded
7309 Returns: the expanded string, always in a new bit of store, or NULL
7313 expand_string_copy(const uschar *string)
7315 const uschar *yield = expand_cstring(string);
7316 if (yield == string) yield = string_copy(string);
7322 /*************************************************
7323 * Expand and interpret as an integer *
7324 *************************************************/
7326 /* Expand a string, and convert the result into an integer.
7329 string the string to be expanded
7330 isplus TRUE if a non-negative number is expected
7332 Returns: the integer value, or
7333 -1 for an expansion error ) in both cases, message in
7334 -2 for an integer interpretation error ) expand_string_message
7335 expand_string_message is set NULL for an OK integer
7339 expand_string_integer(uschar *string, BOOL isplus)
7341 return expanded_string_integer(expand_string(string), isplus);
7345 /*************************************************
7346 * Interpret string as an integer *
7347 *************************************************/
7349 /* Convert a string (that has already been expanded) into an integer.
7351 This function is used inside the expansion code.
7354 s the string to be expanded
7355 isplus TRUE if a non-negative number is expected
7357 Returns: the integer value, or
7358 -1 if string is NULL (which implies an expansion error)
7359 -2 for an integer interpretation error
7360 expand_string_message is set NULL for an OK integer
7363 static int_eximarith_t
7364 expanded_string_integer(const uschar *s, BOOL isplus)
7366 int_eximarith_t value;
7367 uschar *msg = US"invalid integer \"%s\"";
7370 /* If expansion failed, expand_string_message will be set. */
7372 if (s == NULL) return -1;
7374 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7375 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7376 systems, so we set it zero ourselves. */
7379 expand_string_message = NULL; /* Indicates no error */
7381 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7382 equal to 0. Unfortunately, people actually relied upon that, so preserve
7383 the behaviour explicitly. Stripping leading whitespace is a harmless
7384 noop change since strtol skips it anyway (provided that there is a number
7388 while (isspace(*s)) ++s;
7392 debug_printf("treating blank string as number 0\n");
7397 value = strtoll(CS s, CSS &endptr, 10);
7401 msg = US"integer expected but \"%s\" found";
7403 else if (value < 0 && isplus)
7405 msg = US"non-negative integer expected but \"%s\" found";
7409 switch (tolower(*endptr))
7414 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7419 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7420 else value *= 1024*1024;
7424 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7425 else value *= 1024*1024*1024;
7429 if (errno == ERANGE)
7430 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7433 while (isspace(*endptr)) endptr++;
7434 if (*endptr == 0) return value;
7438 expand_string_message = string_sprintf(CS msg, s);
7443 /* These values are usually fixed boolean values, but they are permitted to be
7447 addr address being routed
7448 mtype the module type
7449 mname the module name
7450 dbg_opt debug selectors
7451 oname the option name
7452 bvalue the router's boolean value
7453 svalue the router's string value
7454 rvalue where to put the returned value
7456 Returns: OK value placed in rvalue
7457 DEFER expansion failed
7461 exp_bool(address_item *addr,
7462 uschar *mtype, uschar *mname, unsigned dbg_opt,
7463 uschar *oname, BOOL bvalue,
7464 uschar *svalue, BOOL *rvalue)
7467 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7469 expanded = expand_string(svalue);
7470 if (expanded == NULL)
7472 if (expand_string_forcedfail)
7474 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7478 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7479 oname, mname, mtype, expand_string_message);
7480 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7484 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7487 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7489 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7493 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7494 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7504 /*************************************************
7505 **************************************************
7506 * Stand-alone test program *
7507 **************************************************
7508 *************************************************/
7514 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7516 int ovector[3*(EXPAND_MAXN+1)];
7517 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7518 ovector, nelem(ovector));
7519 BOOL yield = n >= 0;
7520 if (n == 0) n = EXPAND_MAXN + 1;
7524 expand_nmax = (setup < 0)? 0 : setup + 1;
7525 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7527 expand_nstring[expand_nmax] = subject + ovector[nn];
7528 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7536 int main(int argc, uschar **argv)
7539 uschar buffer[1024];
7541 debug_selector = D_v;
7542 debug_file = stderr;
7543 debug_fd = fileno(debug_file);
7544 big_buffer = malloc(big_buffer_size);
7546 for (i = 1; i < argc; i++)
7548 if (argv[i][0] == '+')
7550 debug_trace_memory = 2;
7553 if (isdigit(argv[i][0]))
7554 debug_selector = Ustrtol(argv[i], NULL, 0);
7556 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7560 eldap_default_servers = argv[i];
7563 mysql_servers = argv[i];
7566 pgsql_servers = argv[i];
7569 redis_servers = argv[i];
7573 else opt_perl_startup = argv[i];
7577 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7579 expand_nstring[1] = US"string 1....";
7580 expand_nlength[1] = 8;
7584 if (opt_perl_startup != NULL)
7587 printf("Starting Perl interpreter\n");
7588 errstr = init_perl(opt_perl_startup);
7591 printf("** error in perl_startup code: %s\n", errstr);
7592 return EXIT_FAILURE;
7595 #endif /* EXIM_PERL */
7597 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7599 void *reset_point = store_get(0);
7600 uschar *yield = expand_string(buffer);
7603 printf("%s\n", yield);
7604 store_reset(reset_point);
7608 if (search_find_defer) printf("search_find deferred\n");
7609 printf("Failed: %s\n", expand_string_message);
7610 if (expand_string_forcedfail) printf("Forced failure\n");
7624 /* End of expand.c */