1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *);
17 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
20 #ifndef SUPPORT_CRYPTEQ
21 #define SUPPORT_CRYPTEQ
26 #include "lookups/ldap.h"
29 #ifdef SUPPORT_CRYPTEQ
34 extern char* crypt16(char*, char*);
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. Charaters after the first 16 are ignored. It always generates
50 a 16-byte hash, which is expressed together with the salt as a string
51 of 24 base 64 digits. Here are some links to peruse:
53 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
54 http://seclists.org/bugtraq/1999/Mar/0076.html
56 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
57 and OSF/1. This is the same as the standard crypt if given a password
58 of 8 characters or less. If given more, it first does the same as crypt
59 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
60 using as salt the first two base 64 digits from the first hash block.
61 If the password is more than 16 characters then it crypts the 17th to 24th
62 characters using as salt the first two base 64 digits from the second hash
63 block. And so on: I've seen references to it cutting off the password at
64 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
66 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
67 http://seclists.org/bugtraq/1999/Mar/0109.html
68 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
69 TET1_html/sec.c222.html#no_id_208
71 Exim has something it calls "crypt16". It will either use a native
72 crypt16 or its own implementation. A native crypt16 will presumably
73 be the one that I called "crypt16" above. The internal "crypt16"
74 function, however, is a two-block-maximum implementation of what I called
75 "bigcrypt". The documentation matches the internal code.
77 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
78 that crypt16 and bigcrypt were different things.
80 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
81 to whatever it is using under that name. This unfortunately sets a
82 precedent for using "{crypt16}" to identify two incompatible algorithms
83 whose output can't be distinguished. With "{crypt16}" thus rendered
84 ambiguous, I suggest you deprecate it and invent two new identifiers
85 for the two algorithms.
87 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
88 of the password separately means they can be cracked separately, so
89 the double-length hash only doubles the cracking effort instead of
90 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
164 /* Tables of operator names, and corresponding switch numbers. The names must be
165 in alphabetical order. There are two tables, because underscore is used in some
166 cases to introduce arguments, whereas for other it is part of the name. This is
167 an historical mis-design. */
169 static uschar *op_table_underscore[] = {
172 US"quote_local_part",
177 ,US"utf8_domain_from_alabel",
178 US"utf8_domain_to_alabel",
179 US"utf8_localpart_from_alabel",
180 US"utf8_localpart_to_alabel"
187 EOP_QUOTE_LOCAL_PART,
192 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
193 EOP_UTF8_DOMAIN_TO_ALABEL,
194 EOP_UTF8_LOCALPART_FROM_ALABEL,
195 EOP_UTF8_LOCALPART_TO_ALABEL
199 static uschar *op_table_main[] = {
242 EOP_ADDRESS = nelem(op_table_underscore),
284 /* Table of condition names, and corresponding switch numbers. The names must
285 be in alphabetical order. */
287 static uschar *cond_table[] = {
291 US"==", /* Backward compatibility */
324 US"match_local_part",
349 ECOND_FIRST_DELIVERY,
370 ECOND_MATCH_LOCAL_PART,
380 /* Types of table entry */
383 vtype_int, /* value is address of int */
384 vtype_filter_int, /* ditto, but recognized only when filtering */
385 vtype_ino, /* value is address of ino_t (not always an int) */
386 vtype_uid, /* value is address of uid_t (not always an int) */
387 vtype_gid, /* value is address of gid_t (not always an int) */
388 vtype_bool, /* value is address of bool */
389 vtype_stringptr, /* value is address of pointer to string */
390 vtype_msgbody, /* as stringptr, but read when first required */
391 vtype_msgbody_end, /* ditto, the end of the message */
392 vtype_msgheaders, /* the message's headers, processed */
393 vtype_msgheaders_raw, /* the message's headers, unprocessed */
394 vtype_localpart, /* extract local part from string */
395 vtype_domain, /* extract domain from string */
396 vtype_string_func, /* value is string returned by given function */
397 vtype_todbsdin, /* value not used; generate BSD inbox tod */
398 vtype_tode, /* value not used; generate tod in epoch format */
399 vtype_todel, /* value not used; generate tod in epoch/usec format */
400 vtype_todf, /* value not used; generate full tod */
401 vtype_todl, /* value not used; generate log tod */
402 vtype_todlf, /* value not used; generate log file datestamp tod */
403 vtype_todzone, /* value not used; generate time zone only */
404 vtype_todzulu, /* value not used; generate zulu tod */
405 vtype_reply, /* value not used; get reply from headers */
406 vtype_pid, /* value not used; result is pid */
407 vtype_host_lookup, /* value not used; get host name */
408 vtype_load_avg, /* value not used; result is int from os_getloadavg */
409 vtype_pspace, /* partition space; value is T/F for spool/log */
410 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
411 vtype_cert /* SSL certificate */
413 ,vtype_dkim /* Lookup of value in DKIM signature */
417 /* Type for main variable table */
425 /* Type for entries pointing to address/length pairs. Not currently
433 static uschar * fn_recipients(void);
435 /* This table must be kept in alphabetical order. */
437 static var_entry var_table[] = {
438 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
439 they will be confused with user-creatable ACL variables. */
440 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
441 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
442 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
443 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
444 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
445 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
446 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
447 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
448 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
449 { "acl_narg", vtype_int, &acl_narg },
450 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
451 { "address_data", vtype_stringptr, &deliver_address_data },
452 { "address_file", vtype_stringptr, &address_file },
453 { "address_pipe", vtype_stringptr, &address_pipe },
454 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
455 { "authenticated_id", vtype_stringptr, &authenticated_id },
456 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
457 { "authentication_failed",vtype_int, &authentication_failed },
458 #ifdef WITH_CONTENT_SCAN
459 { "av_failed", vtype_int, &av_failed },
461 #ifdef EXPERIMENTAL_BRIGHTMAIL
462 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
463 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
464 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
465 { "bmi_deliver", vtype_int, &bmi_deliver },
467 { "body_linecount", vtype_int, &body_linecount },
468 { "body_zerocount", vtype_int, &body_zerocount },
469 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
470 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
471 { "caller_gid", vtype_gid, &real_gid },
472 { "caller_uid", vtype_uid, &real_uid },
473 { "callout_address", vtype_stringptr, &callout_address },
474 { "compile_date", vtype_stringptr, &version_date },
475 { "compile_number", vtype_stringptr, &version_cnumber },
476 { "config_dir", vtype_stringptr, &config_main_directory },
477 { "config_file", vtype_stringptr, &config_main_filename },
478 { "csa_status", vtype_stringptr, &csa_status },
479 #ifdef EXPERIMENTAL_DCC
480 { "dcc_header", vtype_stringptr, &dcc_header },
481 { "dcc_result", vtype_stringptr, &dcc_result },
483 #ifdef WITH_OLD_DEMIME
484 { "demime_errorlevel", vtype_int, &demime_errorlevel },
485 { "demime_reason", vtype_stringptr, &demime_reason },
488 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
489 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
490 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
491 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
492 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
493 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
494 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
495 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
496 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
497 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
498 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
499 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
500 { "dkim_key_length", vtype_int, &dkim_key_length },
501 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
502 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
503 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
504 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
505 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
506 { "dkim_signers", vtype_stringptr, &dkim_signers },
507 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
508 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
510 #ifdef EXPERIMENTAL_DMARC
511 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
512 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
513 { "dmarc_status", vtype_stringptr, &dmarc_status },
514 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
515 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
517 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
518 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
519 { "dnslist_text", vtype_stringptr, &dnslist_text },
520 { "dnslist_value", vtype_stringptr, &dnslist_value },
521 { "domain", vtype_stringptr, &deliver_domain },
522 { "domain_data", vtype_stringptr, &deliver_domain_data },
523 #ifndef DISABLE_EVENT
524 { "event_data", vtype_stringptr, &event_data },
526 /*XXX want to use generic vars for as many of these as possible*/
527 { "event_defer_errno", vtype_int, &event_defer_errno },
529 { "event_name", vtype_stringptr, &event_name },
531 { "exim_gid", vtype_gid, &exim_gid },
532 { "exim_path", vtype_stringptr, &exim_path },
533 { "exim_uid", vtype_uid, &exim_uid },
534 { "exim_version", vtype_stringptr, &version_string },
535 #ifdef WITH_OLD_DEMIME
536 { "found_extension", vtype_stringptr, &found_extension },
538 { "headers_added", vtype_string_func, &fn_hdrs_added },
539 { "home", vtype_stringptr, &deliver_home },
540 { "host", vtype_stringptr, &deliver_host },
541 { "host_address", vtype_stringptr, &deliver_host_address },
542 { "host_data", vtype_stringptr, &host_data },
543 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
544 { "host_lookup_failed", vtype_int, &host_lookup_failed },
545 { "host_port", vtype_int, &deliver_host_port },
546 { "inode", vtype_ino, &deliver_inode },
547 { "interface_address", vtype_stringptr, &interface_address },
548 { "interface_port", vtype_int, &interface_port },
549 { "item", vtype_stringptr, &iterate_item },
551 { "ldap_dn", vtype_stringptr, &eldap_dn },
553 { "load_average", vtype_load_avg, NULL },
554 { "local_part", vtype_stringptr, &deliver_localpart },
555 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
556 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
557 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
558 { "local_scan_data", vtype_stringptr, &local_scan_data },
559 { "local_user_gid", vtype_gid, &local_user_gid },
560 { "local_user_uid", vtype_uid, &local_user_uid },
561 { "localhost_number", vtype_int, &host_number },
562 { "log_inodes", vtype_pinodes, (void *)FALSE },
563 { "log_space", vtype_pspace, (void *)FALSE },
564 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
565 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
566 #ifdef WITH_CONTENT_SCAN
567 { "malware_name", vtype_stringptr, &malware_name },
569 { "max_received_linelength", vtype_int, &max_received_linelength },
570 { "message_age", vtype_int, &message_age },
571 { "message_body", vtype_msgbody, &message_body },
572 { "message_body_end", vtype_msgbody_end, &message_body_end },
573 { "message_body_size", vtype_int, &message_body_size },
574 { "message_exim_id", vtype_stringptr, &message_id },
575 { "message_headers", vtype_msgheaders, NULL },
576 { "message_headers_raw", vtype_msgheaders_raw, NULL },
577 { "message_id", vtype_stringptr, &message_id },
578 { "message_linecount", vtype_int, &message_linecount },
579 { "message_size", vtype_int, &message_size },
581 { "message_smtputf8", vtype_bool, &message_smtputf8 },
583 #ifdef WITH_CONTENT_SCAN
584 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
585 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
586 { "mime_boundary", vtype_stringptr, &mime_boundary },
587 { "mime_charset", vtype_stringptr, &mime_charset },
588 { "mime_content_description", vtype_stringptr, &mime_content_description },
589 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
590 { "mime_content_id", vtype_stringptr, &mime_content_id },
591 { "mime_content_size", vtype_int, &mime_content_size },
592 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
593 { "mime_content_type", vtype_stringptr, &mime_content_type },
594 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
595 { "mime_filename", vtype_stringptr, &mime_filename },
596 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
597 { "mime_is_multipart", vtype_int, &mime_is_multipart },
598 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
599 { "mime_part_count", vtype_int, &mime_part_count },
601 { "n0", vtype_filter_int, &filter_n[0] },
602 { "n1", vtype_filter_int, &filter_n[1] },
603 { "n2", vtype_filter_int, &filter_n[2] },
604 { "n3", vtype_filter_int, &filter_n[3] },
605 { "n4", vtype_filter_int, &filter_n[4] },
606 { "n5", vtype_filter_int, &filter_n[5] },
607 { "n6", vtype_filter_int, &filter_n[6] },
608 { "n7", vtype_filter_int, &filter_n[7] },
609 { "n8", vtype_filter_int, &filter_n[8] },
610 { "n9", vtype_filter_int, &filter_n[9] },
611 { "original_domain", vtype_stringptr, &deliver_domain_orig },
612 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
613 { "originator_gid", vtype_gid, &originator_gid },
614 { "originator_uid", vtype_uid, &originator_uid },
615 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
616 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
617 { "pid", vtype_pid, NULL },
619 { "prdr_requested", vtype_bool, &prdr_requested },
621 { "primary_hostname", vtype_stringptr, &primary_hostname },
622 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
623 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
624 { "proxy_external_port", vtype_int, &proxy_external_port },
625 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
626 { "proxy_local_port", vtype_int, &proxy_local_port },
627 { "proxy_session", vtype_bool, &proxy_session },
629 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
630 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
631 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
632 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
633 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
634 { "rcpt_count", vtype_int, &rcpt_count },
635 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
636 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
637 { "received_count", vtype_int, &received_count },
638 { "received_for", vtype_stringptr, &received_for },
639 { "received_ip_address", vtype_stringptr, &interface_address },
640 { "received_port", vtype_int, &interface_port },
641 { "received_protocol", vtype_stringptr, &received_protocol },
642 { "received_time", vtype_int, &received_time },
643 { "recipient_data", vtype_stringptr, &recipient_data },
644 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
645 { "recipients", vtype_string_func, &fn_recipients },
646 { "recipients_count", vtype_int, &recipients_count },
647 #ifdef WITH_CONTENT_SCAN
648 { "regex_match_string", vtype_stringptr, ®ex_match_string },
650 { "reply_address", vtype_reply, NULL },
651 { "return_path", vtype_stringptr, &return_path },
652 { "return_size_limit", vtype_int, &bounce_return_size_limit },
653 { "router_name", vtype_stringptr, &router_name },
654 { "runrc", vtype_int, &runrc },
655 { "self_hostname", vtype_stringptr, &self_hostname },
656 { "sender_address", vtype_stringptr, &sender_address },
657 { "sender_address_data", vtype_stringptr, &sender_address_data },
658 { "sender_address_domain", vtype_domain, &sender_address },
659 { "sender_address_local_part", vtype_localpart, &sender_address },
660 { "sender_data", vtype_stringptr, &sender_data },
661 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
662 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
663 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
664 { "sender_host_address", vtype_stringptr, &sender_host_address },
665 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
666 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
667 { "sender_host_name", vtype_host_lookup, NULL },
668 { "sender_host_port", vtype_int, &sender_host_port },
669 { "sender_ident", vtype_stringptr, &sender_ident },
670 { "sender_rate", vtype_stringptr, &sender_rate },
671 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
672 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
673 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
674 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
675 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
676 { "sending_port", vtype_int, &sending_port },
677 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
678 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
679 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
680 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
681 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
682 { "sn0", vtype_filter_int, &filter_sn[0] },
683 { "sn1", vtype_filter_int, &filter_sn[1] },
684 { "sn2", vtype_filter_int, &filter_sn[2] },
685 { "sn3", vtype_filter_int, &filter_sn[3] },
686 { "sn4", vtype_filter_int, &filter_sn[4] },
687 { "sn5", vtype_filter_int, &filter_sn[5] },
688 { "sn6", vtype_filter_int, &filter_sn[6] },
689 { "sn7", vtype_filter_int, &filter_sn[7] },
690 { "sn8", vtype_filter_int, &filter_sn[8] },
691 { "sn9", vtype_filter_int, &filter_sn[9] },
692 #ifdef WITH_CONTENT_SCAN
693 { "spam_action", vtype_stringptr, &spam_action },
694 { "spam_bar", vtype_stringptr, &spam_bar },
695 { "spam_report", vtype_stringptr, &spam_report },
696 { "spam_score", vtype_stringptr, &spam_score },
697 { "spam_score_int", vtype_stringptr, &spam_score_int },
699 #ifdef EXPERIMENTAL_SPF
700 { "spf_guess", vtype_stringptr, &spf_guess },
701 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
702 { "spf_received", vtype_stringptr, &spf_received },
703 { "spf_result", vtype_stringptr, &spf_result },
704 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
706 { "spool_directory", vtype_stringptr, &spool_directory },
707 { "spool_inodes", vtype_pinodes, (void *)TRUE },
708 { "spool_space", vtype_pspace, (void *)TRUE },
709 #ifdef EXPERIMENTAL_SRS
710 { "srs_db_address", vtype_stringptr, &srs_db_address },
711 { "srs_db_key", vtype_stringptr, &srs_db_key },
712 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
713 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
714 { "srs_recipient", vtype_stringptr, &srs_recipient },
715 { "srs_status", vtype_stringptr, &srs_status },
717 { "thisaddress", vtype_stringptr, &filter_thisaddress },
719 /* The non-(in,out) variables are now deprecated */
720 { "tls_bits", vtype_int, &tls_in.bits },
721 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
722 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
724 { "tls_in_bits", vtype_int, &tls_in.bits },
725 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
726 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
727 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
728 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
729 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
730 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
731 #if defined(SUPPORT_TLS)
732 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
734 { "tls_out_bits", vtype_int, &tls_out.bits },
735 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
736 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
737 #ifdef EXPERIMENTAL_DANE
738 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
740 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
741 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
742 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
743 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
744 #if defined(SUPPORT_TLS)
745 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
747 #ifdef EXPERIMENTAL_DANE
748 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
751 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
752 #if defined(SUPPORT_TLS)
753 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
756 { "tod_bsdinbox", vtype_todbsdin, NULL },
757 { "tod_epoch", vtype_tode, NULL },
758 { "tod_epoch_l", vtype_todel, NULL },
759 { "tod_full", vtype_todf, NULL },
760 { "tod_log", vtype_todl, NULL },
761 { "tod_logfile", vtype_todlf, NULL },
762 { "tod_zone", vtype_todzone, NULL },
763 { "tod_zulu", vtype_todzulu, NULL },
764 { "transport_name", vtype_stringptr, &transport_name },
765 { "value", vtype_stringptr, &lookup_value },
766 { "verify_mode", vtype_stringptr, &verify_mode },
767 { "version_number", vtype_stringptr, &version_string },
768 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
769 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
770 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
771 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
772 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
773 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
776 static int var_table_size = nelem(var_table);
777 static uschar var_buffer[256];
778 static BOOL malformed_header;
780 /* For textual hashes */
782 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
783 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
786 enum { HMAC_MD5, HMAC_SHA1 };
788 /* For numeric hashes */
790 static unsigned int prime[] = {
791 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
792 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
793 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
795 /* For printing modes in symbolic form */
797 static uschar *mtable_normal[] =
798 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
800 static uschar *mtable_setid[] =
801 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
803 static uschar *mtable_sticky[] =
804 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
808 /*************************************************
809 * Tables for UTF-8 support *
810 *************************************************/
812 /* Table of the number of extra characters, indexed by the first character
813 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
816 static uschar utf8_table1[] = {
817 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
818 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
819 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
820 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
822 /* These are the masks for the data bits in the first byte of a character,
823 indexed by the number of additional bytes. */
825 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
827 /* Get the next UTF-8 character, advancing the pointer. */
829 #define GETUTF8INC(c, ptr) \
831 if ((c & 0xc0) == 0xc0) \
833 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
835 c = (c & utf8_table2[a]) << s; \
839 c |= (*ptr++ & 0x3f) << s; \
844 /*************************************************
845 * Binary chop search on a table *
846 *************************************************/
848 /* This is used for matching expansion items and operators.
851 name the name that is being sought
852 table the table to search
853 table_size the number of items in the table
855 Returns: the offset in the table, or -1
859 chop_match(uschar *name, uschar **table, int table_size)
861 uschar **bot = table;
862 uschar **top = table + table_size;
866 uschar **mid = bot + (top - bot)/2;
867 int c = Ustrcmp(name, *mid);
868 if (c == 0) return mid - table;
869 if (c > 0) bot = mid + 1; else top = mid;
877 /*************************************************
878 * Check a condition string *
879 *************************************************/
881 /* This function is called to expand a string, and test the result for a "true"
882 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
883 forced fail or lookup defer.
885 We used to release all store used, but this is not not safe due
886 to ${dlfunc } and ${acl }. In any case expand_string_internal()
887 is reasonably careful to release what it can.
889 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
892 condition the condition string
893 m1 text to be incorporated in panic error
896 Returns: TRUE if condition is met, FALSE if not
900 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
903 uschar *ss = expand_string(condition);
906 if (!expand_string_forcedfail && !search_find_defer)
907 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
908 "for %s %s: %s", condition, m1, m2, expand_string_message);
911 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
912 strcmpic(ss, US"false") != 0;
919 /*************************************************
920 * Pseudo-random number generation *
921 *************************************************/
923 /* Pseudo-random number generation. The result is not "expected" to be
924 cryptographically strong but not so weak that someone will shoot themselves
925 in the foot using it as a nonce in some email header scheme or whatever
926 weirdness they'll twist this into. The result should ideally handle fork().
928 However, if we're stuck unable to provide this, then we'll fall back to
929 appallingly bad randomness.
931 If SUPPORT_TLS is defined then this will not be used except as an emergency
936 Returns a random number in range [0, max-1]
940 # define vaguely_random_number vaguely_random_number_fallback
943 vaguely_random_number(int max)
946 # undef vaguely_random_number
948 static pid_t pid = 0;
950 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
960 #ifdef HAVE_ARC4RANDOM
961 /* cryptographically strong randomness, common on *BSD platforms, not
962 so much elsewhere. Alas. */
963 #ifndef NOT_HAVE_ARC4RANDOM_STIR
966 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
967 #ifdef HAVE_SRANDOMDEV
968 /* uses random(4) for seeding */
971 gettimeofday(&tv, NULL);
972 srandom(tv.tv_sec | tv.tv_usec | getpid());
975 /* Poor randomness and no seeding here */
982 #ifdef HAVE_ARC4RANDOM
983 return arc4random() % max;
984 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
985 return random() % max;
987 /* This one returns a 16-bit number, definitely not crypto-strong */
988 return random_number(max);
995 /*************************************************
996 * Pick out a name from a string *
997 *************************************************/
999 /* If the name is too long, it is silently truncated.
1002 name points to a buffer into which to put the name
1003 max is the length of the buffer
1004 s points to the first alphabetic character of the name
1005 extras chars other than alphanumerics to permit
1007 Returns: pointer to the first character after the name
1009 Note: The test for *s != 0 in the while loop is necessary because
1010 Ustrchr() yields non-NULL if the character is zero (which is not something
1013 static const uschar *
1014 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1017 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1019 if (ptr < max-1) name[ptr++] = *s;
1028 /*************************************************
1029 * Pick out the rest of a header name *
1030 *************************************************/
1032 /* A variable name starting $header_ (or just $h_ for those who like
1033 abbreviations) might not be the complete header name because headers can
1034 contain any printing characters in their names, except ':'. This function is
1035 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1036 on the end, if the name was terminated by white space.
1039 name points to a buffer in which the name read so far exists
1040 max is the length of the buffer
1041 s points to the first character after the name so far, i.e. the
1042 first non-alphameric character after $header_xxxxx
1044 Returns: a pointer to the first character after the header name
1047 static const uschar *
1048 read_header_name(uschar *name, int max, const uschar *s)
1050 int prelen = Ustrchr(name, '_') - name + 1;
1051 int ptr = Ustrlen(name) - prelen;
1052 if (ptr > 0) memmove(name, name+prelen, ptr);
1053 while (mac_isgraph(*s) && *s != ':')
1055 if (ptr < max-1) name[ptr++] = *s;
1066 /*************************************************
1067 * Pick out a number from a string *
1068 *************************************************/
1071 n points to an integer into which to put the number
1072 s points to the first digit of the number
1074 Returns: a pointer to the character after the last digit
1076 /*XXX consider expanding to int_eximarith_t. But the test for
1077 "overbig numbers" in 0002 still needs to overflow it. */
1080 read_number(int *n, uschar *s)
1083 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1087 static const uschar *
1088 read_cnumber(int *n, const uschar *s)
1091 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1097 /*************************************************
1098 * Extract keyed subfield from a string *
1099 *************************************************/
1101 /* The yield is in dynamic store; NULL means that the key was not found.
1104 key points to the name of the key
1105 s points to the string from which to extract the subfield
1107 Returns: NULL if the subfield was not found, or
1108 a pointer to the subfield's data
1112 expand_getkeyed(uschar *key, const uschar *s)
1114 int length = Ustrlen(key);
1115 while (isspace(*s)) s++;
1117 /* Loop to search for the key */
1123 const uschar *dkey = s;
1125 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1126 dkeylength = s - dkey;
1127 while (isspace(*s)) s++;
1128 if (*s == '=') while (isspace((*(++s))));
1130 data = string_dequote(&s);
1131 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1134 while (isspace(*s)) s++;
1143 find_var_ent(uschar * name)
1146 int last = var_table_size;
1148 while (last > first)
1150 int middle = (first + last)/2;
1151 int c = Ustrcmp(name, var_table[middle].name);
1153 if (c > 0) { first = middle + 1; continue; }
1154 if (c < 0) { last = middle; continue; }
1155 return &var_table[middle];
1160 /*************************************************
1161 * Extract numbered subfield from string *
1162 *************************************************/
1164 /* Extracts a numbered field from a string that is divided by tokens - for
1165 example a line from /etc/passwd is divided by colon characters. First field is
1166 numbered one. Negative arguments count from the right. Zero returns the whole
1167 string. Returns NULL if there are insufficient tokens in the string
1170 Modifies final argument - this is a dynamically generated string, so that's OK.
1173 field number of field to be extracted,
1174 first field = 1, whole string = 0, last field = -1
1175 separators characters that are used to break string into tokens
1176 s points to the string from which to extract the subfield
1178 Returns: NULL if the field was not found,
1179 a pointer to the field's data inside s (modified to add 0)
1183 expand_gettokened (int field, uschar *separators, uschar *s)
1188 uschar *fieldtext = NULL;
1190 if (field == 0) return s;
1192 /* Break the line up into fields in place; for field > 0 we stop when we have
1193 done the number of fields we want. For field < 0 we continue till the end of
1194 the string, counting the number of fields. */
1196 count = (field > 0)? field : INT_MAX;
1202 /* Previous field was the last one in the string. For a positive field
1203 number, this means there are not enough fields. For a negative field number,
1204 check that there are enough, and scan back to find the one that is wanted. */
1208 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1209 if ((-field) == (INT_MAX - count - 1)) return s;
1213 while (ss[-1] != 0) ss--;
1219 /* Previous field was not last in the string; save its start and put a
1223 len = Ustrcspn(ss, separators);
1234 expand_getlistele(int field, const uschar * list)
1236 const uschar * tlist= list;
1242 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1245 if(field==0) return NULL;
1246 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1247 return string_nextinlist(&list, &sep, NULL, 0);
1251 /* Certificate fields, by name. Worry about by-OID later */
1252 /* Names are chosen to not have common prefixes */
1259 uschar * (*getfn)(void * cert, uschar * mod);
1261 static certfield certfields[] =
1262 { /* linear search; no special order */
1263 { US"version", 7, &tls_cert_version },
1264 { US"serial_number", 13, &tls_cert_serial_number },
1265 { US"subject", 7, &tls_cert_subject },
1266 { US"notbefore", 9, &tls_cert_not_before },
1267 { US"notafter", 8, &tls_cert_not_after },
1268 { US"issuer", 6, &tls_cert_issuer },
1269 { US"signature", 9, &tls_cert_signature },
1270 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1271 { US"subj_altname", 12, &tls_cert_subject_altname },
1272 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1273 { US"crl_uri", 7, &tls_cert_crl_uri },
1277 expand_getcertele(uschar * field, uschar * certvar)
1282 if (!(vp = find_var_ent(certvar)))
1284 expand_string_message =
1285 string_sprintf("no variable named \"%s\"", certvar);
1286 return NULL; /* Unknown variable name */
1288 /* NB this stops us passing certs around in variable. Might
1289 want to do that in future */
1290 if (vp->type != vtype_cert)
1292 expand_string_message =
1293 string_sprintf("\"%s\" is not a certificate", certvar);
1294 return NULL; /* Unknown variable name */
1296 if (!*(void **)vp->value)
1299 if (*field >= '0' && *field <= '9')
1300 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1302 for(cp = certfields;
1303 cp < certfields + nelem(certfields);
1305 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1307 uschar * modifier = *(field += cp->namelen) == ','
1309 return (*cp->getfn)( *(void **)vp->value, modifier );
1312 expand_string_message =
1313 string_sprintf("bad field selector \"%s\" for certextract", field);
1316 #endif /*SUPPORT_TLS*/
1318 /*************************************************
1319 * Extract a substring from a string *
1320 *************************************************/
1322 /* Perform the ${substr or ${length expansion operations.
1325 subject the input string
1326 value1 the offset from the start of the input string to the start of
1327 the output string; if negative, count from the right.
1328 value2 the length of the output string, or negative (-1) for unset
1329 if value1 is positive, unset means "all after"
1330 if value1 is negative, unset means "all before"
1331 len set to the length of the returned string
1333 Returns: pointer to the output string, or NULL if there is an error
1337 extract_substr(uschar *subject, int value1, int value2, int *len)
1339 int sublen = Ustrlen(subject);
1341 if (value1 < 0) /* count from right */
1345 /* If the position is before the start, skip to the start, and adjust the
1346 length. If the length ends up negative, the substring is null because nothing
1347 can precede. This falls out naturally when the length is unset, meaning "all
1353 if (value2 < 0) value2 = 0;
1357 /* Otherwise an unset length => characters before value1 */
1359 else if (value2 < 0)
1366 /* For a non-negative offset, if the starting position is past the end of the
1367 string, the result will be the null string. Otherwise, an unset length means
1368 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1372 if (value1 > sublen)
1377 else if (value2 < 0) value2 = sublen;
1380 /* Cut the length down to the maximum possible for the offset value, and get
1381 the required characters. */
1383 if (value1 + value2 > sublen) value2 = sublen - value1;
1385 return subject + value1;
1391 /*************************************************
1392 * Old-style hash of a string *
1393 *************************************************/
1395 /* Perform the ${hash expansion operation.
1398 subject the input string (an expanded substring)
1399 value1 the length of the output string; if greater or equal to the
1400 length of the input string, the input string is returned
1401 value2 the number of hash characters to use, or 26 if negative
1402 len set to the length of the returned string
1404 Returns: pointer to the output string, or NULL if there is an error
1408 compute_hash(uschar *subject, int value1, int value2, int *len)
1410 int sublen = Ustrlen(subject);
1412 if (value2 < 0) value2 = 26;
1413 else if (value2 > Ustrlen(hashcodes))
1415 expand_string_message =
1416 string_sprintf("hash count \"%d\" too big", value2);
1420 /* Calculate the hash text. We know it is shorter than the original string, so
1421 can safely place it in subject[] (we know that subject is always itself an
1422 expanded substring). */
1424 if (value1 < sublen)
1429 while ((c = (subject[j])) != 0)
1431 int shift = (c + j++) & 7;
1432 subject[i] ^= (c << shift) | (c >> (8-shift));
1433 if (++i >= value1) i = 0;
1435 for (i = 0; i < value1; i++)
1436 subject[i] = hashcodes[(subject[i]) % value2];
1438 else value1 = sublen;
1447 /*************************************************
1448 * Numeric hash of a string *
1449 *************************************************/
1451 /* Perform the ${nhash expansion operation. The first characters of the
1452 string are treated as most important, and get the highest prime numbers.
1455 subject the input string
1456 value1 the maximum value of the first part of the result
1457 value2 the maximum value of the second part of the result,
1458 or negative to produce only a one-part result
1459 len set to the length of the returned string
1461 Returns: pointer to the output string, or NULL if there is an error.
1465 compute_nhash (uschar *subject, int value1, int value2, int *len)
1467 uschar *s = subject;
1469 unsigned long int total = 0; /* no overflow */
1473 if (i == 0) i = nelem(prime) - 1;
1474 total += prime[i--] * (unsigned int)(*s++);
1477 /* If value2 is unset, just compute one number */
1481 s = string_sprintf("%d", total % value1);
1484 /* Otherwise do a div/mod hash */
1488 total = total % (value1 * value2);
1489 s = string_sprintf("%d/%d", total/value2, total % value2);
1500 /*************************************************
1501 * Find the value of a header or headers *
1502 *************************************************/
1504 /* Multiple instances of the same header get concatenated, and this function
1505 can also return a concatenation of all the header lines. When concatenating
1506 specific headers that contain lists of addresses, a comma is inserted between
1507 them. Otherwise we use a straight concatenation. Because some messages can have
1508 pathologically large number of lines, there is a limit on the length that is
1509 returned. Also, to avoid massive store use which would result from using
1510 string_cat() as it copies and extends strings, we do a preliminary pass to find
1511 out exactly how much store will be needed. On "normal" messages this will be
1515 name the name of the header, without the leading $header_ or $h_,
1516 or NULL if a concatenation of all headers is required
1517 exists_only TRUE if called from a def: test; don't need to build a string;
1518 just return a string that is not "" and not "0" if the header
1520 newsize return the size of memory block that was obtained; may be NULL
1521 if exists_only is TRUE
1522 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1523 other than concatenating, will be done on the header. Also used
1524 for $message_headers_raw.
1525 charset name of charset to translate MIME words to; used only if
1526 want_raw is false; if NULL, no translation is done (this is
1527 used for $bh_ and $bheader_)
1529 Returns: NULL if the header does not exist, else a pointer to a new
1534 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1537 BOOL found = name == NULL;
1539 int len = found? 0 : Ustrlen(name);
1541 uschar *yield = NULL;
1544 /* Loop for two passes - saves code repetition */
1546 for (i = 0; i < 2; i++)
1551 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1553 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1555 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1560 if (exists_only) return US"1"; /* don't need actual string */
1562 t = h->text + len; /* text to insert */
1563 if (!want_raw) /* unless wanted raw, */
1564 while (isspace(*t)) t++; /* remove leading white space */
1565 ilen = h->slen - (t - h->text); /* length to insert */
1567 /* Unless wanted raw, remove trailing whitespace, including the
1571 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1573 /* Set comma = 1 if handling a single header and it's one of those
1574 that contains an address list, except when asked for raw headers. Only
1575 need to do this once. */
1577 if (!want_raw && name != NULL && comma == 0 &&
1578 Ustrchr("BCFRST", h->type) != NULL)
1581 /* First pass - compute total store needed; second pass - compute
1582 total store used, including this header. */
1584 size += ilen + comma + 1; /* +1 for the newline */
1586 /* Second pass - concatentate the data, up to a maximum. Note that
1587 the loop stops when size hits the limit. */
1591 if (size > header_insert_maxlen)
1593 ilen -= size - header_insert_maxlen - 1;
1596 Ustrncpy(ptr, t, ilen);
1599 /* For a non-raw header, put in the comma if needed, then add
1600 back the newline we removed above, provided there was some text in
1603 if (!want_raw && ilen > 0)
1605 if (comma != 0) *ptr++ = ',';
1613 /* At end of first pass, return NULL if no header found. Then truncate size
1614 if necessary, and get the buffer to hold the data, returning the buffer size.
1619 if (!found) return NULL;
1620 if (size > header_insert_maxlen) size = header_insert_maxlen;
1621 *newsize = size + 1;
1622 ptr = yield = store_get(*newsize);
1626 /* That's all we do for raw header expansion. */
1633 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1634 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1635 function can return an error with decoded data if the charset translation
1636 fails. If decoding fails, it returns NULL. */
1640 uschar *decoded, *error;
1641 if (ptr > yield && ptr[-1] == '\n') ptr--;
1642 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1644 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1648 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1649 " input was: %s\n", error, yield);
1651 if (decoded != NULL) yield = decoded;
1660 /*************************************************
1661 * Return list of recipients *
1662 *************************************************/
1663 /* A recipients list is available only during system message filtering,
1664 during ACL processing after DATA, and while expanding pipe commands
1665 generated from a system filter, but not elsewhere. */
1670 if (!enable_dollar_recipients) return NULL; else
1675 uschar * s = store_get(size);
1676 for (i = 0; i < recipients_count; i++)
1678 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1679 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1680 Ustrlen(recipients_list[i].address));
1682 s[ptr] = 0; /* string_cat() leaves room */
1688 /*************************************************
1689 * Find value of a variable *
1690 *************************************************/
1692 /* The table of variables is kept in alphabetic order, so we can search it
1693 using a binary chop. The "choplen" variable is nothing to do with the binary
1697 name the name of the variable being sought
1698 exists_only TRUE if this is a def: test; passed on to find_header()
1699 skipping TRUE => skip any processing evaluation; this is not the same as
1700 exists_only because def: may test for values that are first
1702 newsize pointer to an int which is initially zero; if the answer is in
1703 a new memory buffer, *newsize is set to its size
1705 Returns: NULL if the variable does not exist, or
1706 a pointer to the variable's contents, or
1707 something non-NULL if exists_only is TRUE
1711 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1718 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1719 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1720 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1721 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1722 (this gave backwards compatibility at the changeover). There may be built-in
1723 variables whose names start acl_ but they should never start in this way. This
1724 slightly messy specification is a consequence of the history, needless to say.
1726 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1727 set, in which case give an error. */
1729 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1733 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1734 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1737 /* Handle $auth<n> variables. */
1739 if (Ustrncmp(name, "auth", 4) == 0)
1742 int n = Ustrtoul(name + 4, &endptr, 10);
1743 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1744 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1746 else if (Ustrncmp(name, "regex", 5) == 0)
1749 int n = Ustrtoul(name + 5, &endptr, 10);
1750 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1751 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1754 /* For all other variables, search the table */
1756 if (!(vp = find_var_ent(name)))
1757 return NULL; /* Unknown variable name */
1759 /* Found an existing variable. If in skipping state, the value isn't needed,
1760 and we want to avoid processing (such as looking up the host name). */
1768 case vtype_filter_int:
1769 if (!filter_running) return NULL;
1773 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1777 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1781 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1785 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1789 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1792 case vtype_stringptr: /* Pointer to string */
1793 return (s = *((uschar **)(val))) ? s : US"";
1796 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1799 case vtype_load_avg:
1800 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1803 case vtype_host_lookup: /* Lookup if not done so */
1804 if (sender_host_name == NULL && sender_host_address != NULL &&
1805 !host_lookup_failed && host_name_lookup() == OK)
1806 host_build_sender_fullhost();
1807 return (sender_host_name == NULL)? US"" : sender_host_name;
1809 case vtype_localpart: /* Get local part from address */
1810 s = *((uschar **)(val));
1811 if (s == NULL) return US"";
1812 domain = Ustrrchr(s, '@');
1813 if (domain == NULL) return s;
1814 if (domain - s > sizeof(var_buffer) - 1)
1815 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1816 " in string expansion", sizeof(var_buffer));
1817 Ustrncpy(var_buffer, s, domain - s);
1818 var_buffer[domain - s] = 0;
1821 case vtype_domain: /* Get domain from address */
1822 s = *((uschar **)(val));
1823 if (s == NULL) return US"";
1824 domain = Ustrrchr(s, '@');
1825 return (domain == NULL)? US"" : domain + 1;
1827 case vtype_msgheaders:
1828 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1830 case vtype_msgheaders_raw:
1831 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1833 case vtype_msgbody: /* Pointer to msgbody string */
1834 case vtype_msgbody_end: /* Ditto, the end of the msg */
1835 ss = (uschar **)(val);
1836 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1839 off_t start_offset = SPOOL_DATA_START_OFFSET;
1840 int len = message_body_visible;
1841 if (len > message_size) len = message_size;
1842 *ss = body = store_malloc(len+1);
1844 if (vp->type == vtype_msgbody_end)
1846 struct stat statbuf;
1847 if (fstat(deliver_datafile, &statbuf) == 0)
1849 start_offset = statbuf.st_size - len;
1850 if (start_offset < SPOOL_DATA_START_OFFSET)
1851 start_offset = SPOOL_DATA_START_OFFSET;
1854 lseek(deliver_datafile, start_offset, SEEK_SET);
1855 len = read(deliver_datafile, body, len);
1859 if (message_body_newlines) /* Separate loops for efficiency */
1861 { if (body[--len] == 0) body[len] = ' '; }
1864 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1867 return (*ss == NULL)? US"" : *ss;
1869 case vtype_todbsdin: /* BSD inbox time of day */
1870 return tod_stamp(tod_bsdin);
1872 case vtype_tode: /* Unix epoch time of day */
1873 return tod_stamp(tod_epoch);
1875 case vtype_todel: /* Unix epoch/usec time of day */
1876 return tod_stamp(tod_epoch_l);
1878 case vtype_todf: /* Full time of day */
1879 return tod_stamp(tod_full);
1881 case vtype_todl: /* Log format time of day */
1882 return tod_stamp(tod_log_bare); /* (without timezone) */
1884 case vtype_todzone: /* Time zone offset only */
1885 return tod_stamp(tod_zone);
1887 case vtype_todzulu: /* Zulu time */
1888 return tod_stamp(tod_zulu);
1890 case vtype_todlf: /* Log file datestamp tod */
1891 return tod_stamp(tod_log_datestamp_daily);
1893 case vtype_reply: /* Get reply address */
1894 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1896 if (s != NULL) while (isspace(*s)) s++;
1897 if (s == NULL || *s == 0)
1899 *newsize = 0; /* For the *s==0 case */
1900 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1905 while (isspace(*s)) s++;
1906 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1907 while (t > s && isspace(t[-1])) t--;
1910 return (s == NULL)? US"" : s;
1912 case vtype_string_func:
1914 uschar * (*fn)() = val;
1921 sprintf(CS var_buffer, "%d",
1922 receive_statvfs(val == (void *)TRUE, &inodes));
1929 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1930 sprintf(CS var_buffer, "%d", inodes);
1935 return *(void **)val ? US"<cert>" : US"";
1937 #ifndef DISABLE_DKIM
1939 return dkim_exim_expand_query((int)(long)val);
1944 return NULL; /* Unknown variable. Silences static checkers. */
1951 modify_variable(uschar *name, void * value)
1954 if ((vp = find_var_ent(name))) vp->value = value;
1955 return; /* Unknown variable name, fail silently */
1962 /*************************************************
1963 * Read and expand substrings *
1964 *************************************************/
1966 /* This function is called to read and expand argument substrings for various
1967 expansion items. Some have a minimum requirement that is less than the maximum;
1968 in these cases, the first non-present one is set to NULL.
1971 sub points to vector of pointers to set
1972 n maximum number of substrings
1974 sptr points to current string pointer
1975 skipping the skipping flag
1976 check_end if TRUE, check for final '}'
1977 name name of item, for error message
1978 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1981 Returns: 0 OK; string pointer updated
1982 1 curly bracketing error (too few arguments)
1983 2 too many arguments (only if check_end is set); message set
1984 3 other error (expansion failure)
1988 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1989 BOOL check_end, uschar *name, BOOL *resetok)
1992 const uschar *s = *sptr;
1994 while (isspace(*s)) s++;
1995 for (i = 0; i < n; i++)
1999 if (i < m) return 1;
2003 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
2004 if (sub[i] == NULL) return 3;
2005 if (*s++ != '}') return 1;
2006 while (isspace(*s)) s++;
2008 if (check_end && *s++ != '}')
2012 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
2013 "(max is %d)", name, n);
2026 /*************************************************
2027 * Elaborate message for bad variable *
2028 *************************************************/
2030 /* For the "unknown variable" message, take a look at the variable's name, and
2031 give additional information about possible ACL variables. The extra information
2032 is added on to expand_string_message.
2034 Argument: the name of the variable
2039 check_variable_error_message(uschar *name)
2041 if (Ustrncmp(name, "acl_", 4) == 0)
2042 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2043 (name[4] == 'c' || name[4] == 'm')?
2045 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2046 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2048 US"user-defined ACL variables must start acl_c or acl_m");
2054 Load args from sub array to globals, and call acl_check().
2055 Sub array will be corrupted on return.
2057 Returns: OK access is granted by an ACCEPT verb
2058 DISCARD access is granted by a DISCARD verb
2059 FAIL access is denied
2060 FAIL_DROP access is denied; drop the connection
2061 DEFER can't tell at the moment
2065 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2068 int sav_narg = acl_narg;
2070 uschar * dummy_logmsg;
2071 extern int acl_where;
2073 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2074 for (i = 0; i < nsub && sub[i+1]; i++)
2076 uschar * tmp = acl_arg[i];
2077 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2078 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2083 sub[i+1] = acl_arg[i];
2084 acl_arg[i++] = NULL;
2088 debug_printf("expanding: acl: %s arg: %s%s\n",
2090 acl_narg>0 ? acl_arg[0] : US"<none>",
2091 acl_narg>1 ? " +more" : "");
2093 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2095 for (i = 0; i < nsub; i++)
2096 acl_arg[i] = sub[i+1]; /* restore old args */
2097 acl_narg = sav_narg;
2105 /*************************************************
2106 * Read and evaluate a condition *
2107 *************************************************/
2111 s points to the start of the condition text
2112 resetok points to a BOOL which is written false if it is unsafe to
2113 free memory. Certain condition types (acl) may have side-effect
2114 allocation which must be preserved.
2115 yield points to a BOOL to hold the result of the condition test;
2116 if NULL, we are just reading through a condition that is
2117 part of an "or" combination to check syntax, or in a state
2118 where the answer isn't required
2120 Returns: a pointer to the first character after the condition, or
2124 static const uschar *
2125 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2127 BOOL testfor = TRUE;
2128 BOOL tempcond, combined_cond;
2130 BOOL sub2_honour_dollar = TRUE;
2131 int i, rc, cond_type, roffset;
2132 int_eximarith_t num[2];
2133 struct stat statbuf;
2135 const uschar *sub[10];
2138 const uschar *rerror;
2142 while (isspace(*s)) s++;
2143 if (*s == '!') { testfor = !testfor; s++; } else break;
2146 /* Numeric comparisons are symbolic */
2148 if (*s == '=' || *s == '>' || *s == '<')
2160 /* All other conditions are named */
2162 else s = read_name(name, 256, s, US"_");
2164 /* If we haven't read a name, it means some non-alpha character is first. */
2168 expand_string_message = string_sprintf("condition name expected, "
2169 "but found \"%.16s\"", s);
2173 /* Find which condition we are dealing with, and switch on it */
2175 cond_type = chop_match(name, cond_table, nelem(cond_table));
2178 /* def: tests for a non-empty variable, or for the existence of a header. If
2179 yield == NULL we are in a skipping state, and don't care about the answer. */
2184 expand_string_message = US"\":\" expected after \"def\"";
2188 s = read_name(name, 256, s+1, US"_");
2190 /* Test for a header's existence. If the name contains a closing brace
2191 character, this may be a user error where the terminating colon has been
2192 omitted. Set a flag to adjust a subsequent error message in this case. */
2194 if (Ustrncmp(name, "h_", 2) == 0 ||
2195 Ustrncmp(name, "rh_", 3) == 0 ||
2196 Ustrncmp(name, "bh_", 3) == 0 ||
2197 Ustrncmp(name, "header_", 7) == 0 ||
2198 Ustrncmp(name, "rheader_", 8) == 0 ||
2199 Ustrncmp(name, "bheader_", 8) == 0)
2201 s = read_header_name(name, 256, s);
2202 /* {-for-text-editors */
2203 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2204 if (yield != NULL) *yield =
2205 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2208 /* Test for a variable's having a non-empty value. A non-existent variable
2209 causes an expansion failure. */
2213 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2216 expand_string_message = (name[0] == 0)?
2217 string_sprintf("variable name omitted after \"def:\"") :
2218 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2219 check_variable_error_message(name);
2222 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2228 /* first_delivery tests for first delivery attempt */
2230 case ECOND_FIRST_DELIVERY:
2231 if (yield != NULL) *yield = deliver_firsttime == testfor;
2235 /* queue_running tests for any process started by a queue runner */
2237 case ECOND_QUEUE_RUNNING:
2238 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2242 /* exists: tests for file existence
2243 isip: tests for any IP address
2244 isip4: tests for an IPv4 address
2245 isip6: tests for an IPv6 address
2246 pam: does PAM authentication
2247 radius: does RADIUS authentication
2248 ldapauth: does LDAP authentication
2249 pwcheck: does Cyrus SASL pwcheck authentication
2258 case ECOND_LDAPAUTH:
2261 while (isspace(*s)) s++;
2262 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2264 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2265 if (sub[0] == NULL) return NULL;
2266 /* {-for-text-editors */
2267 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2269 if (yield == NULL) return s; /* No need to run the test if skipping */
2274 if ((expand_forbid & RDO_EXISTS) != 0)
2276 expand_string_message = US"File existence tests are not permitted";
2279 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2285 rc = string_is_ip_address(sub[0], NULL);
2286 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2287 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2290 /* Various authentication tests - all optionally compiled */
2294 rc = auth_call_pam(sub[0], &expand_string_message);
2297 goto COND_FAILED_NOT_COMPILED;
2298 #endif /* SUPPORT_PAM */
2301 #ifdef RADIUS_CONFIG_FILE
2302 rc = auth_call_radius(sub[0], &expand_string_message);
2305 goto COND_FAILED_NOT_COMPILED;
2306 #endif /* RADIUS_CONFIG_FILE */
2308 case ECOND_LDAPAUTH:
2311 /* Just to keep the interface the same */
2313 int old_pool = store_pool;
2314 store_pool = POOL_SEARCH;
2315 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2316 &expand_string_message, &do_cache);
2317 store_pool = old_pool;
2321 goto COND_FAILED_NOT_COMPILED;
2322 #endif /* LOOKUP_LDAP */
2325 #ifdef CYRUS_PWCHECK_SOCKET
2326 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2329 goto COND_FAILED_NOT_COMPILED;
2330 #endif /* CYRUS_PWCHECK_SOCKET */
2332 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2333 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2335 if (rc == ERROR || rc == DEFER) return NULL;
2336 *yield = (rc == OK) == testfor;
2342 /* call ACL (in a conditional context). Accept true, deny false.
2343 Defer is a forced-fail. Anything set by message= goes to $value.
2344 Up to ten parameters are used; we use the braces round the name+args
2345 like the saslauthd condition does, to permit a variable number of args.
2346 See also the expansion-item version EITEM_ACL and the traditional
2347 acl modifier ACLC_ACL.
2348 Since the ACL may allocate new global variables, tell our caller to not
2353 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2361 while (isspace(*s)) s++;
2362 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2364 switch(read_subs(sub, nelem(sub), 1,
2365 &s, yield == NULL, TRUE, US"acl", resetok))
2367 case 1: expand_string_message = US"too few arguments or bracketing "
2370 case 3: return NULL;
2374 if (yield != NULL) switch(eval_acl(sub, nelem(sub), &user_msg))
2379 lookup_value = NULL;
2382 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2383 lookup_value[ptr] = '\0';
2385 *yield = cond == testfor;
2389 expand_string_forcedfail = TRUE;
2391 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2398 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2400 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2402 However, the last two are optional. That is why the whole set is enclosed
2403 in their own set of braces. */
2405 case ECOND_SASLAUTHD:
2406 #ifndef CYRUS_SASLAUTHD_SOCKET
2407 goto COND_FAILED_NOT_COMPILED;
2411 while (isspace(*s)) s++;
2412 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2413 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2416 case 1: expand_string_message = US"too few arguments or bracketing "
2417 "error for saslauthd";
2419 case 3: return NULL;
2421 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2424 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2425 &expand_string_message);
2426 if (rc == ERROR || rc == DEFER) return NULL;
2427 *yield = (rc == OK) == testfor;
2431 #endif /* CYRUS_SASLAUTHD_SOCKET */
2434 /* symbolic operators for numeric and string comparison, and a number of
2435 other operators, all requiring two arguments.
2437 crypteq: encrypts plaintext and compares against an encrypted text,
2438 using crypt(), crypt16(), MD5 or SHA-1
2439 inlist/inlisti: checks if first argument is in the list of the second
2440 match: does a regular expression match and sets up the numerical
2441 variables if it succeeds
2442 match_address: matches in an address list
2443 match_domain: matches in a domain list
2444 match_ip: matches a host list that is restricted to IP addresses
2445 match_local_part: matches in a local part list
2448 case ECOND_MATCH_ADDRESS:
2449 case ECOND_MATCH_DOMAIN:
2450 case ECOND_MATCH_IP:
2451 case ECOND_MATCH_LOCAL_PART:
2452 #ifndef EXPAND_LISTMATCH_RHS
2453 sub2_honour_dollar = FALSE;
2462 case ECOND_NUM_L: /* Numerical comparisons */
2469 case ECOND_STR_LT: /* String comparisons */
2480 for (i = 0; i < 2; i++)
2482 /* Sometimes, we don't expand substrings; too many insecure configurations
2483 created using match_address{}{} and friends, where the second param
2484 includes information from untrustworthy sources. */
2485 BOOL honour_dollar = TRUE;
2486 if ((i > 0) && !sub2_honour_dollar)
2487 honour_dollar = FALSE;
2489 while (isspace(*s)) s++;
2492 if (i == 0) goto COND_FAILED_CURLY_START;
2493 expand_string_message = string_sprintf("missing 2nd string in {} "
2494 "after \"%s\"", name);
2497 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2498 honour_dollar, resetok);
2499 if (sub[i] == NULL) return NULL;
2500 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2502 /* Convert to numerical if required; we know that the names of all the
2503 conditions that compare numbers do not start with a letter. This just saves
2504 checking for them individually. */
2506 if (!isalpha(name[0]) && yield != NULL)
2512 debug_printf("empty string cast to zero for numerical comparison\n");
2516 num[i] = expanded_string_integer(sub[i], FALSE);
2517 if (expand_string_message != NULL) return NULL;
2522 /* Result not required */
2524 if (yield == NULL) return s;
2526 /* Do an appropriate comparison */
2532 tempcond = (num[0] == num[1]);
2536 tempcond = (num[0] > num[1]);
2540 tempcond = (num[0] >= num[1]);
2544 tempcond = (num[0] < num[1]);
2548 tempcond = (num[0] <= num[1]);
2552 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2556 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2560 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2564 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2568 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2572 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2576 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2580 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2584 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2588 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2591 case ECOND_MATCH: /* Regular expression match */
2592 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2596 expand_string_message = string_sprintf("regular expression error in "
2597 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2600 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2603 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2604 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2605 goto MATCHED_SOMETHING;
2607 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2608 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2609 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2610 goto MATCHED_SOMETHING;
2612 case ECOND_MATCH_IP: /* Match IP address in a host list */
2613 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2615 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2621 unsigned int *nullcache = NULL;
2622 check_host_block cb;
2624 cb.host_name = US"";
2625 cb.host_address = sub[0];
2627 /* If the host address starts off ::ffff: it is an IPv6 address in
2628 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2631 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2632 cb.host_address + 7 : cb.host_address;
2634 rc = match_check_list(
2635 &sub[1], /* the list */
2636 0, /* separator character */
2637 &hostlist_anchor, /* anchor pointer */
2638 &nullcache, /* cache pointer */
2639 check_host, /* function for testing */
2640 &cb, /* argument for function */
2641 MCL_HOST, /* type of check */
2642 sub[0], /* text for debugging */
2643 NULL); /* where to pass back data */
2645 goto MATCHED_SOMETHING;
2647 case ECOND_MATCH_LOCAL_PART:
2648 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2649 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2664 expand_string_message = string_sprintf("unable to complete match "
2665 "against \"%s\": %s", sub[1], search_error_message);
2671 /* Various "encrypted" comparisons. If the second string starts with
2672 "{" then an encryption type is given. Default to crypt() or crypt16()
2673 (build-time choice). */
2674 /* }-for-text-editors */
2677 #ifndef SUPPORT_CRYPTEQ
2678 goto COND_FAILED_NOT_COMPILED;
2680 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2682 int sublen = Ustrlen(sub[1]+5);
2687 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2689 /* If the length that we are comparing against is 24, the MD5 digest
2690 is expressed as a base64 string. This is the way LDAP does it. However,
2691 some other software uses a straightforward hex representation. We assume
2692 this if the length is 32. Other lengths fail. */
2696 uschar *coded = b64encode((uschar *)digest, 16);
2697 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2698 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2699 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2701 else if (sublen == 32)
2705 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2707 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2708 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2709 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2713 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2714 "fail\n crypted=%s\n", sub[1]+5);
2719 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2721 int sublen = Ustrlen(sub[1]+6);
2726 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2728 /* If the length that we are comparing against is 28, assume the SHA1
2729 digest is expressed as a base64 string. If the length is 40, assume a
2730 straightforward hex representation. Other lengths fail. */
2734 uschar *coded = b64encode((uschar *)digest, 20);
2735 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2736 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2737 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2739 else if (sublen == 40)
2743 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2745 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2746 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2747 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2751 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2752 "fail\n crypted=%s\n", sub[1]+6);
2757 else /* {crypt} or {crypt16} and non-{ at start */
2758 /* }-for-text-editors */
2763 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2768 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2773 else if (sub[1][0] == '{') /* }-for-text-editors */
2775 expand_string_message = string_sprintf("unknown encryption mechanism "
2776 "in \"%s\"", sub[1]);
2782 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2783 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2784 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2788 #define XSTR(s) STR(s)
2789 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2790 " subject=%s\n crypted=%s\n",
2791 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2796 /* If the encrypted string contains fewer than two characters (for the
2797 salt), force failure. Otherwise we get false positives: with an empty
2798 string the yield of crypt() is an empty string! */
2801 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2802 else if (errno == EINVAL)
2806 expand_string_message = string_sprintf("crypt error: %s\n",
2807 US strerror(errno));
2812 #endif /* SUPPORT_CRYPTEQ */
2817 const uschar * list = sub[1];
2819 uschar *save_iterate_item = iterate_item;
2820 int (*compare)(const uschar *, const uschar *);
2822 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2825 compare = cond_type == ECOND_INLISTI
2826 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2828 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2829 if (compare(sub[0], iterate_item) == 0)
2834 iterate_item = save_iterate_item;
2837 } /* Switch for comparison conditions */
2839 *yield = tempcond == testfor;
2840 return s; /* End of comparison conditions */
2843 /* and/or: computes logical and/or of several conditions */
2847 subcondptr = (yield == NULL)? NULL : &tempcond;
2848 combined_cond = (cond_type == ECOND_AND);
2850 while (isspace(*s)) s++;
2851 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2855 while (isspace(*s)) s++;
2856 /* {-for-text-editors */
2857 if (*s == '}') break;
2858 if (*s != '{') /* }-for-text-editors */
2860 expand_string_message = string_sprintf("each subcondition "
2861 "inside an \"%s{...}\" condition must be in its own {}", name);
2865 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2867 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2868 expand_string_message, name);
2871 while (isspace(*s)) s++;
2873 /* {-for-text-editors */
2876 /* {-for-text-editors */
2877 expand_string_message = string_sprintf("missing } at end of condition "
2878 "inside \"%s\" group", name);
2884 if (cond_type == ECOND_AND)
2886 combined_cond &= tempcond;
2887 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2888 } /* evaluate any more */
2891 combined_cond |= tempcond;
2892 if (combined_cond) subcondptr = NULL; /* once true, don't */
2893 } /* evaluate any more */
2897 if (yield != NULL) *yield = (combined_cond == testfor);
2901 /* forall/forany: iterates a condition with different values */
2906 const uschar * list;
2908 uschar *save_iterate_item = iterate_item;
2910 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2912 while (isspace(*s)) s++;
2913 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2914 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2915 if (sub[0] == NULL) return NULL;
2916 /* {-for-text-editors */
2917 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2919 while (isspace(*s)) s++;
2920 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2924 /* Call eval_condition once, with result discarded (as if scanning a
2925 "false" part). This allows us to find the end of the condition, because if
2926 the list it empty, we won't actually evaluate the condition for real. */
2928 if (!(s = eval_condition(sub[1], resetok, NULL)))
2930 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2931 expand_string_message, name);
2934 while (isspace(*s)) s++;
2936 /* {-for-text-editors */
2939 /* {-for-text-editors */
2940 expand_string_message = string_sprintf("missing } at end of condition "
2941 "inside \"%s\"", name);
2945 if (yield != NULL) *yield = !testfor;
2947 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2949 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2950 if (!eval_condition(sub[1], resetok, &tempcond))
2952 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2953 expand_string_message, name);
2954 iterate_item = save_iterate_item;
2957 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2958 tempcond? "true":"false");
2960 if (yield != NULL) *yield = (tempcond == testfor);
2961 if (tempcond == (cond_type == ECOND_FORANY)) break;
2964 iterate_item = save_iterate_item;
2969 /* The bool{} expansion condition maps a string to boolean.
2970 The values supported should match those supported by the ACL condition
2971 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2972 of true/false. Note that Router "condition" rules have a different
2973 interpretation, where general data can be used and only a few values
2975 Note that readconf.c boolean matching, for boolean configuration options,
2976 only matches true/yes/false/no.
2977 The bool_lax{} condition matches the Router logic, which is much more
2980 case ECOND_BOOL_LAX:
2986 BOOL boolvalue = FALSE;
2987 while (isspace(*s)) s++;
2988 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2989 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2990 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2992 case 1: expand_string_message = string_sprintf(
2993 "too few arguments or bracketing error for %s",
2997 case 3: return NULL;
3000 while (isspace(*t)) t++;
3004 /* trailing whitespace: seems like a good idea to ignore it too */
3006 while (isspace(*t2)) t2--;
3007 if (t2 != (t + len))
3014 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
3015 /* logic for the lax case from expand_check_condition(), which also does
3016 expands, and the logic is both short and stable enough that there should
3017 be no maintenance burden from replicating it. */
3021 ? Ustrspn(t+1, "0123456789") == len-1
3022 : Ustrspn(t, "0123456789") == len)
3024 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3025 /* expand_check_condition only does a literal string "0" check */
3026 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3029 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3031 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3033 else if (cond_type == ECOND_BOOL_LAX)
3037 expand_string_message = string_sprintf("unrecognised boolean "
3041 if (yield != NULL) *yield = (boolvalue == testfor);
3045 /* Unknown condition */
3048 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3050 } /* End switch on condition type */
3052 /* Missing braces at start and end of data */
3054 COND_FAILED_CURLY_START:
3055 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3058 COND_FAILED_CURLY_END:
3059 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3063 /* A condition requires code that is not compiled */
3065 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3066 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3067 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3068 COND_FAILED_NOT_COMPILED:
3069 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3078 /*************************************************
3079 * Save numerical variables *
3080 *************************************************/
3082 /* This function is called from items such as "if" that want to preserve and
3083 restore the numbered variables.
3086 save_expand_string points to an array of pointers to set
3087 save_expand_nlength points to an array of ints for the lengths
3089 Returns: the value of expand max to save
3093 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3096 for (i = 0; i <= expand_nmax; i++)
3098 save_expand_nstring[i] = expand_nstring[i];
3099 save_expand_nlength[i] = expand_nlength[i];
3106 /*************************************************
3107 * Restore numerical variables *
3108 *************************************************/
3110 /* This function restored saved values of numerical strings.
3113 save_expand_nmax the number of strings to restore
3114 save_expand_string points to an array of pointers
3115 save_expand_nlength points to an array of ints
3121 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3122 int *save_expand_nlength)
3125 expand_nmax = save_expand_nmax;
3126 for (i = 0; i <= expand_nmax; i++)
3128 expand_nstring[i] = save_expand_nstring[i];
3129 expand_nlength[i] = save_expand_nlength[i];
3137 /*************************************************
3138 * Handle yes/no substrings *
3139 *************************************************/
3141 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3142 alternative substrings that depend on whether or not the condition was true,
3143 or the lookup or extraction succeeded. The substrings always have to be
3144 expanded, to check their syntax, but "skipping" is set when the result is not
3145 needed - this avoids unnecessary nested lookups.
3148 skipping TRUE if we were skipping when this item was reached
3149 yes TRUE if the first string is to be used, else use the second
3150 save_lookup a value to put back into lookup_value before the 2nd expansion
3151 sptr points to the input string pointer
3152 yieldptr points to the output string pointer
3153 sizeptr points to the output string size
3154 ptrptr points to the output string pointer
3155 type "lookup", "if", "extract", "run", "env", "listextract" or
3156 "certextract" for error message
3157 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3160 Returns: 0 OK; lookup_value has been reset to save_lookup
3162 2 expansion failed because of bracketing error
3166 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3167 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3170 const uschar *s = *sptr; /* Local value */
3171 uschar *sub1, *sub2;
3173 /* If there are no following strings, we substitute the contents of $value for
3174 lookups and for extractions in the success case. For the ${if item, the string
3175 "true" is substituted. In the fail case, nothing is substituted for all three
3178 while (isspace(*s)) s++;
3183 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3187 if (yes && lookup_value)
3188 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3189 Ustrlen(lookup_value));
3190 lookup_value = save_lookup;
3196 /* The first following string must be braced. */
3198 if (*s++ != '{') goto FAILED_CURLY;
3200 /* Expand the first substring. Forced failures are noticed only if we actually
3201 want this string. Set skipping in the call in the fail case (this will always
3202 be the case if we were already skipping). */
3204 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3205 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3206 expand_string_forcedfail = FALSE;
3207 if (*s++ != '}') goto FAILED_CURLY;
3209 /* If we want the first string, add it to the output */
3212 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3214 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3215 $value to what it was at the start of the item, so that it has this value
3216 during the second string expansion. For the call from "if" or "run" to this
3217 function, save_lookup is set to lookup_value, so that this statement does
3220 lookup_value = save_lookup;
3222 /* There now follows either another substring, or "fail", or nothing. This
3223 time, forced failures are noticed only if we want the second string. We must
3224 set skipping in the nested call if we don't want this string, or if we were
3225 already skipping. */
3227 while (isspace(*s)) s++;
3230 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3231 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3232 expand_string_forcedfail = FALSE;
3233 if (*s++ != '}') goto FAILED_CURLY;
3235 /* If we want the second string, add it to the output */
3238 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3241 /* If there is no second string, but the word "fail" is present when the use of
3242 the second string is wanted, set a flag indicating it was a forced failure
3243 rather than a syntactic error. Swallow the terminating } in case this is nested
3244 inside another lookup or if or extract. */
3249 /* deconst cast ok here as source is s anyway */
3250 s = US read_name(name, sizeof(name), s, US"_");
3251 if (Ustrcmp(name, "fail") == 0)
3253 if (!yes && !skipping)
3255 while (isspace(*s)) s++;
3256 if (*s++ != '}') goto FAILED_CURLY;
3257 expand_string_message =
3258 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3259 expand_string_forcedfail = TRUE;
3265 expand_string_message =
3266 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3271 /* All we have to do now is to check on the final closing brace. */
3273 while (isspace(*s)) s++;
3274 if (*s++ == '}') goto RETURN;
3276 /* Get here if there is a bracketing failure */
3281 /* Get here for other failures */
3286 /* Update the input pointer value before returning */
3296 /*************************************************
3297 * Handle MD5 or SHA-1 computation for HMAC *
3298 *************************************************/
3300 /* These are some wrapping functions that enable the HMAC code to be a bit
3301 cleaner. A good compiler will spot the tail recursion.
3304 type HMAC_MD5 or HMAC_SHA1
3305 remaining are as for the cryptographic hash functions
3311 chash_start(int type, void *base)
3313 if (type == HMAC_MD5)
3314 md5_start((md5 *)base);
3316 sha1_start((sha1 *)base);
3320 chash_mid(int type, void *base, uschar *string)
3322 if (type == HMAC_MD5)
3323 md5_mid((md5 *)base, string);
3325 sha1_mid((sha1 *)base, string);
3329 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3331 if (type == HMAC_MD5)
3332 md5_end((md5 *)base, string, length, digest);
3334 sha1_end((sha1 *)base, string, length, digest);
3341 /********************************************************
3342 * prvs: Get last three digits of days since Jan 1, 1970 *
3343 ********************************************************/
3345 /* This is needed to implement the "prvs" BATV reverse
3348 Argument: integer "days" offset to add or substract to
3349 or from the current number of days.
3351 Returns: pointer to string containing the last three
3352 digits of the number of days since Jan 1, 1970,
3353 modified by the offset argument, NULL if there
3354 was an error in the conversion.
3359 prvs_daystamp(int day_offset)
3361 uschar *days = store_get(32); /* Need at least 24 for cases */
3362 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3363 (time(NULL) + day_offset*86400)/86400);
3364 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3369 /********************************************************
3370 * prvs: perform HMAC-SHA1 computation of prvs bits *
3371 ********************************************************/
3373 /* This is needed to implement the "prvs" BATV reverse
3377 address RFC2821 Address to use
3378 key The key to use (must be less than 64 characters
3380 key_num Single-digit key number to use. Defaults to
3383 Returns: pointer to string containing the first three
3384 bytes of the final hash in hex format, NULL if
3385 there was an error in the process.
3389 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3391 uschar *hash_source, *p;
3392 int size = 0,offset = 0,i;
3394 void *use_base = &sha1_base;
3395 uschar innerhash[20];
3396 uschar finalhash[20];
3397 uschar innerkey[64];
3398 uschar outerkey[64];
3399 uschar *finalhash_hex = store_get(40);
3401 if (key_num == NULL)
3404 if (Ustrlen(key) > 64)
3407 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3408 string_cat(hash_source,&size,&offset,daystamp,3);
3409 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3410 hash_source[offset] = '\0';
3412 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3414 memset(innerkey, 0x36, 64);
3415 memset(outerkey, 0x5c, 64);
3417 for (i = 0; i < Ustrlen(key); i++)
3419 innerkey[i] ^= key[i];
3420 outerkey[i] ^= key[i];
3423 chash_start(HMAC_SHA1, use_base);
3424 chash_mid(HMAC_SHA1, use_base, innerkey);
3425 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3427 chash_start(HMAC_SHA1, use_base);
3428 chash_mid(HMAC_SHA1, use_base, outerkey);
3429 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3432 for (i = 0; i < 3; i++)
3434 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3435 *p++ = hex_digits[finalhash[i] & 0x0f];
3439 return finalhash_hex;
3445 /*************************************************
3446 * Join a file onto the output string *
3447 *************************************************/
3449 /* This is used for readfile/readsock and after a run expansion.
3450 It joins the contents of a file onto the output string, globally replacing
3451 newlines with a given string (optionally).
3455 yield pointer to the expandable string
3456 sizep pointer to the current size
3457 ptrp pointer to the current position
3458 eol newline replacement string, or NULL
3460 Returns: new value of string pointer
3464 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3466 int eollen = eol ? Ustrlen(eol) : 0;
3467 uschar buffer[1024];
3469 while (Ufgets(buffer, sizeof(buffer), f))
3471 int len = Ustrlen(buffer);
3472 if (eol && buffer[len-1] == '\n') len--;
3473 yield = string_cat(yield, sizep, ptrp, buffer, len);
3474 if (buffer[len] != 0)
3475 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3478 if (yield) yield[*ptrp] = 0;
3486 /*************************************************
3487 * Evaluate numeric expression *
3488 *************************************************/
3490 /* This is a set of mutually recursive functions that evaluate an arithmetic
3491 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3492 these functions that is called from elsewhere is eval_expr, whose interface is:
3495 sptr pointer to the pointer to the string - gets updated
3496 decimal TRUE if numbers are to be assumed decimal
3497 error pointer to where to put an error message - must be NULL on input
3498 endket TRUE if ')' must terminate - FALSE for external call
3500 Returns: on success: the value of the expression, with *error still NULL
3501 on failure: an undefined value, with *error = a message
3504 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3507 static int_eximarith_t
3508 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3511 int_eximarith_t x = eval_op_or(&s, decimal, error);
3517 *error = US"expecting closing parenthesis";
3519 while (isspace(*(++s)));
3521 else if (*s != 0) *error = US"expecting operator";
3528 static int_eximarith_t
3529 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3534 while (isspace(*s)) s++;
3539 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3541 switch (tolower(*s))
3544 case 'k': n *= 1024; s++; break;
3545 case 'm': n *= 1024*1024; s++; break;
3546 case 'g': n *= 1024*1024*1024; s++; break;
3548 while (isspace (*s)) s++;
3553 n = eval_expr(&s, decimal, error, 1);
3557 *error = US"expecting number or opening parenthesis";
3565 static int_eximarith_t
3566 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3570 while (isspace(*s)) s++;
3571 if (*s == '+' || *s == '-' || *s == '~')
3574 x = eval_op_unary(&s, decimal, error);
3575 if (op == '-') x = -x;
3576 else if (op == '~') x = ~x;
3580 x = eval_number(&s, decimal, error);
3587 static int_eximarith_t
3588 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3591 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3594 while (*s == '*' || *s == '/' || *s == '%')
3597 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3598 if (*error != NULL) break;
3599 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3600 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3601 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3602 * -N*M is INT_MIN will yielf INT_MIN.
3603 * Since we don't support floating point, this is somewhat simpler.
3604 * Ideally, we'd return an error, but since we overflow for all other
3605 * arithmetic, consistency suggests otherwise, but what's the correct value
3606 * to use? There is none.
3607 * The C standard guarantees overflow for unsigned arithmetic but signed
3608 * overflow invokes undefined behaviour; in practice, this is overflow
3609 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3610 * that long/longlong larger than int are available, or we could just work
3611 * with larger types. We should consider whether to guarantee 32bit eval
3612 * and 64-bit working variables, with errors returned. For now ...
3613 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3614 * can just let the other invalid results occur otherwise, as they have
3615 * until now. For this one case, we can coerce.
3617 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3620 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3621 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3631 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3647 static int_eximarith_t
3648 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3651 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3654 while (*s == '+' || *s == '-')
3657 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3658 if (*error != NULL) break;
3659 if (op == '+') x += y; else x -= y;
3667 static int_eximarith_t
3668 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3671 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3674 while ((*s == '<' || *s == '>') && s[1] == s[0])
3679 y = eval_op_sum(&s, decimal, error);
3680 if (*error != NULL) break;
3681 if (op == '<') x <<= y; else x >>= y;
3689 static int_eximarith_t
3690 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3693 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3700 y = eval_op_shift(&s, decimal, error);
3701 if (*error != NULL) break;
3710 static int_eximarith_t
3711 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3714 int_eximarith_t x = eval_op_and(&s, decimal, error);
3721 y = eval_op_and(&s, decimal, error);
3722 if (*error != NULL) break;
3731 static int_eximarith_t
3732 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3735 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3742 y = eval_op_xor(&s, decimal, error);
3743 if (*error != NULL) break;
3753 /*************************************************
3755 *************************************************/
3757 /* Returns either an unchanged string, or the expanded string in stacking pool
3758 store. Interpreted sequences are:
3760 \... normal escaping rules
3761 $name substitutes the variable
3763 ${op:string} operates on the expanded string value
3764 ${item{arg1}{arg2}...} expands the args and then does the business
3765 some literal args are not enclosed in {}
3767 There are now far too many operators and item types to make it worth listing
3768 them here in detail any more.
3770 We use an internal routine recursively to handle embedded substrings. The
3771 external function follows. The yield is NULL if the expansion failed, and there
3772 are two cases: if something collapsed syntactically, or if "fail" was given
3773 as the action on a lookup failure. These can be distinguised by looking at the
3774 variable expand_string_forcedfail, which is TRUE in the latter case.
3776 The skipping flag is set true when expanding a substring that isn't actually
3777 going to be used (after "if" or "lookup") and it prevents lookups from
3778 happening lower down.
3780 Store usage: At start, a store block of the length of the input plus 64
3781 is obtained. This is expanded as necessary by string_cat(), which might have to
3782 get a new block, or might be able to expand the original. At the end of the
3783 function we can release any store above that portion of the yield block that
3784 was actually used. In many cases this will be optimal.
3786 However: if the first item in the expansion is a variable name or header name,
3787 we reset the store before processing it; if the result is in fresh store, we
3788 use that without copying. This is helpful for expanding strings like
3789 $message_headers which can get very long.
3791 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3792 since resetting the store at the end of the expansion will free store that was
3793 allocated by the plugin code as well as the slop after the expanded string. So
3794 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3795 and, given the acl condition, ${if }. This is an unfortunate consequence of
3796 string expansion becoming too powerful.
3799 string the string to be expanded
3800 ket_ends true if expansion is to stop at }
3801 left if not NULL, a pointer to the first character after the
3802 expansion is placed here (typically used with ket_ends)
3803 skipping TRUE for recursive calls when the value isn't actually going
3804 to be used (to allow for optimisation)
3805 honour_dollar TRUE if $ is to be expanded,
3806 FALSE if it's just another character
3807 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3810 Returns: NULL if expansion fails:
3811 expand_string_forcedfail is set TRUE if failure was forced
3812 expand_string_message contains a textual error message
3813 a pointer to the expanded string on success
3817 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3818 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3821 int size = Ustrlen(string)+ 64;
3823 uschar *yield = store_get(size);
3824 const uschar *s = string;
3825 uschar *save_expand_nstring[EXPAND_MAXN+1];
3826 int save_expand_nlength[EXPAND_MAXN+1];
3827 BOOL resetok = TRUE;
3829 expand_string_forcedfail = FALSE;
3830 expand_string_message = US"";
3837 /* \ escapes the next character, which must exist, or else
3838 the expansion fails. There's a special escape, \N, which causes
3839 copying of the subject verbatim up to the next \N. Otherwise,
3840 the escapes are the standard set. */
3846 expand_string_message = US"\\ at end of string";
3852 const uschar * t = s + 2;
3853 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3854 yield = string_cat(yield, &size, &ptr, t, s - t);
3855 if (*s != 0) s += 2;
3861 ch[0] = string_interpret_escape(&s);
3863 yield = string_cat(yield, &size, &ptr, ch, 1);
3870 /* Anything other than $ is just copied verbatim, unless we are
3871 looking for a terminating } character. */
3874 if (ket_ends && *s == '}') break;
3876 if (*s != '$' || !honour_dollar)
3878 yield = string_cat(yield, &size, &ptr, s++, 1);
3882 /* No { after the $ - must be a plain name or a number for string
3883 match variable. There has to be a fudge for variables that are the
3884 names of header fields preceded by "$header_" because header field
3885 names can contain any printing characters except space and colon.
3886 For those that don't like typing this much, "$h_" is a synonym for
3887 "$header_". A non-existent header yields a NULL value; nothing is
3890 if (isalpha((*(++s))))
3895 s = read_name(name, sizeof(name), s, US"_");
3897 /* If this is the first thing to be expanded, release the pre-allocated
3900 if (ptr == 0 && yield != NULL)
3902 if (resetok) store_reset(yield);
3909 if (Ustrncmp(name, "h_", 2) == 0 ||
3910 Ustrncmp(name, "rh_", 3) == 0 ||
3911 Ustrncmp(name, "bh_", 3) == 0 ||
3912 Ustrncmp(name, "header_", 7) == 0 ||
3913 Ustrncmp(name, "rheader_", 8) == 0 ||
3914 Ustrncmp(name, "bheader_", 8) == 0)
3916 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3917 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3918 s = read_header_name(name, sizeof(name), s);
3919 value = find_header(name, FALSE, &newsize, want_raw, charset);
3921 /* If we didn't find the header, and the header contains a closing brace
3922 character, this may be a user error where the terminating colon
3923 has been omitted. Set a flag to adjust the error message in this case.
3924 But there is no error here - nothing gets inserted. */
3928 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3935 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
3937 expand_string_message =
3938 string_sprintf("unknown variable name \"%s\"", name);
3939 check_variable_error_message(name);
3943 /* If the data is known to be in a new buffer, newsize will be set to the
3944 size of that buffer. If this is the first thing in an expansion string,
3945 yield will be NULL; just point it at the new store instead of copying. Many
3946 expansion strings contain just one reference, so this is a useful
3947 optimization, especially for humungous headers. */
3949 len = Ustrlen(value);
3950 if (yield == NULL && newsize != 0)
3956 else yield = string_cat(yield, &size, &ptr, value, len);
3964 s = read_cnumber(&n, s);
3965 if (n >= 0 && n <= expand_nmax)
3966 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3971 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3973 if (*s != '{') /*}*/
3975 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3979 /* After { there can be various things, but they all start with
3980 an initial word, except for a number for a string match variable. */
3982 if (isdigit((*(++s))))
3985 s = read_cnumber(&n, s); /*{*/
3988 expand_string_message = US"} expected after number";
3991 if (n >= 0 && n <= expand_nmax)
3992 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3999 expand_string_message = US"letter or digit expected after ${"; /*}*/
4003 /* Allow "-" in names to cater for substrings with negative
4004 arguments. Since we are checking for known names after { this is
4007 s = read_name(name, sizeof(name), s, US"_-");
4008 item_type = chop_match(name, item_table, nelem(item_table));
4012 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4013 If the ACL returns accept or reject we return content set by "message ="
4014 There is currently no limit on recursion; this would have us call
4015 acl_check_internal() directly and get a current level from somewhere.
4016 See also the acl expansion condition ECOND_ACL and the traditional
4017 acl modifier ACLC_ACL.
4018 Assume that the function has side-effects on the store that must be preserved.
4022 /* ${acl {name} {arg1}{arg2}...} */
4024 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4027 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4030 case 1: goto EXPAND_FAILED_CURLY;
4032 case 3: goto EXPAND_FAILED;
4034 if (skipping) continue;
4037 switch(eval_acl(sub, nelem(sub), &user_msg))
4042 debug_printf("acl expansion yield: %s\n", user_msg);
4044 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
4048 expand_string_forcedfail = TRUE;
4050 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4055 /* Handle conditionals - preserve the values of the numerical expansion
4056 variables in case they get changed by a regular expression match in the
4057 condition. If not, they retain their external settings. At the end
4058 of this "if" section, they get restored to their previous values. */
4063 const uschar *next_s;
4064 int save_expand_nmax =
4065 save_expand_strings(save_expand_nstring, save_expand_nlength);
4067 while (isspace(*s)) s++;
4068 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
4069 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4072 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
4073 cond? "true" : "false");
4077 /* The handling of "yes" and "no" result strings is now in a separate
4078 function that is also used by ${lookup} and ${extract} and ${run}. */
4080 switch(process_yesno(
4081 skipping, /* were previously skipping */
4082 cond, /* success/failure indicator */
4083 lookup_value, /* value to reset for string2 */
4084 &s, /* input pointer */
4085 &yield, /* output pointer */
4086 &size, /* output size */
4087 &ptr, /* output current point */
4088 US"if", /* condition type */
4091 case 1: goto EXPAND_FAILED; /* when all is well, the */
4092 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4095 /* Restore external setting of expansion variables for continuation
4098 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4099 save_expand_nlength);
4104 case EITEM_IMAPFOLDER:
4105 { /* ${imapfolder {name}{sep]{specials}} */
4109 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4112 case 1: goto EXPAND_FAILED_CURLY;
4114 case 3: goto EXPAND_FAILED;
4117 if (sub_arg[1] == NULL) /* One argument */
4119 sub_arg[1] = US"/"; /* default separator */
4122 else if (Ustrlen(sub_arg[1]) != 1)
4124 expand_string_message =
4126 "IMAP folder separator must be one character, found \"%s\"",
4131 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4132 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4135 yield = string_cat(yield, &size, &ptr, encoded, Ustrlen(encoded));
4140 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4141 expanding an internal string that isn't actually going to be used. All we
4142 need to do is check the syntax, so don't do a lookup at all. Preserve the
4143 values of the numerical expansion variables in case they get changed by a
4144 partial lookup. If not, they retain their external settings. At the end
4145 of this "lookup" section, they get restored to their previous values. */
4149 int stype, partial, affixlen, starflags;
4150 int expand_setup = 0;
4152 uschar *key, *filename;
4153 const uschar *affix;
4154 uschar *save_lookup_value = lookup_value;
4155 int save_expand_nmax =
4156 save_expand_strings(save_expand_nstring, save_expand_nlength);
4158 if ((expand_forbid & RDO_LOOKUP) != 0)
4160 expand_string_message = US"lookup expansions are not permitted";
4164 /* Get the key we are to look up for single-key+file style lookups.
4165 Otherwise set the key NULL pro-tem. */
4167 while (isspace(*s)) s++;
4168 if (*s == '{') /*}*/
4170 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4171 if (key == NULL) goto EXPAND_FAILED; /*{*/
4172 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4173 while (isspace(*s)) s++;
4177 /* Find out the type of database */
4181 expand_string_message = US"missing lookup type";
4185 /* The type is a string that may contain special characters of various
4186 kinds. Allow everything except space or { to appear; the actual content
4187 is checked by search_findtype_partial. */ /*}*/
4189 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4191 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4195 while (isspace(*s)) s++;
4197 /* Now check for the individual search type and any partial or default
4198 options. Only those types that are actually in the binary are valid. */
4200 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4204 expand_string_message = search_error_message;
4208 /* Check that a key was provided for those lookup types that need it,
4209 and was not supplied for those that use the query style. */
4211 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4215 expand_string_message = string_sprintf("missing {key} for single-"
4216 "key \"%s\" lookup", name);
4224 expand_string_message = string_sprintf("a single key was given for "
4225 "lookup type \"%s\", which is not a single-key lookup type", name);
4230 /* Get the next string in brackets and expand it. It is the file name for
4231 single-key+file lookups, and the whole query otherwise. In the case of
4232 queries that also require a file name (e.g. sqlite), the file name comes
4235 if (*s != '{') goto EXPAND_FAILED_CURLY;
4236 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4237 if (filename == NULL) goto EXPAND_FAILED;
4238 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4239 while (isspace(*s)) s++;
4241 /* If this isn't a single-key+file lookup, re-arrange the variables
4242 to be appropriate for the search_ functions. For query-style lookups,
4243 there is just a "key", and no file name. For the special query-style +
4244 file types, the query (i.e. "key") starts with a file name. */
4248 while (isspace(*filename)) filename++;
4251 if (mac_islookup(stype, lookup_querystyle))
4257 if (*filename != '/')
4259 expand_string_message = string_sprintf(
4260 "absolute file name expected for \"%s\" lookup", name);
4263 while (*key != 0 && !isspace(*key)) key++;
4264 if (*key != 0) *key++ = 0;
4268 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4269 the entry was not found. Note that there is no search_close() function.
4270 Files are left open in case of re-use. At suitable places in higher logic,
4271 search_tidyup() is called to tidy all open files. This can save opening
4272 the same file several times. However, files may also get closed when
4273 others are opened, if too many are open at once. The rule is that a
4274 handle should not be used after a second search_open().
4276 Request that a partial search sets up $1 and maybe $2 by passing
4277 expand_setup containing zero. If its value changes, reset expand_nmax,
4278 since new variables will have been set. Note that at the end of this
4279 "lookup" section, the old numeric variables are restored. */
4282 lookup_value = NULL;
4285 void *handle = search_open(filename, stype, 0, NULL, NULL);
4288 expand_string_message = search_error_message;
4291 lookup_value = search_find(handle, filename, key, partial, affix,
4292 affixlen, starflags, &expand_setup);
4293 if (search_find_defer)
4295 expand_string_message =
4296 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4297 string_printing2(key, FALSE), search_error_message);
4300 if (expand_setup > 0) expand_nmax = expand_setup;
4303 /* The handling of "yes" and "no" result strings is now in a separate
4304 function that is also used by ${if} and ${extract}. */
4306 switch(process_yesno(
4307 skipping, /* were previously skipping */
4308 lookup_value != NULL, /* success/failure indicator */
4309 save_lookup_value, /* value to reset for string2 */
4310 &s, /* input pointer */
4311 &yield, /* output pointer */
4312 &size, /* output size */
4313 &ptr, /* output current point */
4314 US"lookup", /* condition type */
4317 case 1: goto EXPAND_FAILED; /* when all is well, the */
4318 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4321 /* Restore external setting of expansion variables for carrying on
4322 at this level, and continue. */
4324 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4325 save_expand_nlength);
4329 /* If Perl support is configured, handle calling embedded perl subroutines,
4330 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4331 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4332 arguments (defined below). */
4334 #define EXIM_PERL_MAX_ARGS 8
4338 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4339 "is not included in this binary";
4342 #else /* EXIM_PERL */
4344 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4347 if ((expand_forbid & RDO_PERL) != 0)
4349 expand_string_message = US"Perl calls are not permitted";
4353 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4354 US"perl", &resetok))
4356 case 1: goto EXPAND_FAILED_CURLY;
4358 case 3: goto EXPAND_FAILED;
4361 /* If skipping, we don't actually do anything */
4363 if (skipping) continue;
4365 /* Start the interpreter if necessary */
4367 if (!opt_perl_started)
4370 if (opt_perl_startup == NULL)
4372 expand_string_message = US"A setting of perl_startup is needed when "
4373 "using the Perl interpreter";
4376 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4377 initerror = init_perl(opt_perl_startup);
4378 if (initerror != NULL)
4380 expand_string_message =
4381 string_sprintf("error in perl_startup code: %s\n", initerror);
4384 opt_perl_started = TRUE;
4387 /* Call the function */
4389 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4390 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4391 sub_arg[0], sub_arg + 1);
4393 /* NULL yield indicates failure; if the message pointer has been set to
4394 NULL, the yield was undef, indicating a forced failure. Otherwise the
4395 message will indicate some kind of Perl error. */
4397 if (new_yield == NULL)
4399 if (expand_string_message == NULL)
4401 expand_string_message =
4402 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4403 "failure", sub_arg[0]);
4404 expand_string_forcedfail = TRUE;
4409 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4410 set during a callback from Perl. */
4412 expand_string_forcedfail = FALSE;
4416 #endif /* EXIM_PERL */
4418 /* Transform email address to "prvs" scheme to use
4419 as BATV-signed return path */
4426 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4428 case 1: goto EXPAND_FAILED_CURLY;
4430 case 3: goto EXPAND_FAILED;
4433 /* If skipping, we don't actually do anything */
4434 if (skipping) continue;
4436 /* sub_arg[0] is the address */
4437 domain = Ustrrchr(sub_arg[0],'@');
4438 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4440 expand_string_message = US"prvs first argument must be a qualified email address";
4444 /* Calculate the hash. The second argument must be a single-digit
4445 key number, or unset. */
4447 if (sub_arg[2] != NULL &&
4448 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4450 expand_string_message = US"prvs second argument must be a single digit";
4454 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4457 expand_string_message = US"prvs hmac-sha1 conversion failed";
4461 /* Now separate the domain from the local part */
4464 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4465 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4466 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4467 string_cat(yield,&size,&ptr,p,6);
4468 string_cat(yield,&size,&ptr,US"=",1);
4469 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4470 string_cat(yield,&size,&ptr,US"@",1);
4471 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4476 /* Check a prvs-encoded address for validity */
4478 case EITEM_PRVSCHECK:
4481 int mysize = 0, myptr = 0;
4485 /* TF: Ugliness: We want to expand parameter 1 first, then set
4486 up expansion variables that are used in the expansion of
4487 parameter 2. So we clone the string for the first
4488 expansion, where we only expand parameter 1.
4490 PH: Actually, that isn't necessary. The read_subs() function is
4491 designed to work this way for the ${if and ${lookup expansions. I've
4495 /* Reset expansion variables */
4496 prvscheck_result = NULL;
4497 prvscheck_address = NULL;
4498 prvscheck_keynum = NULL;
4500 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4502 case 1: goto EXPAND_FAILED_CURLY;
4504 case 3: goto EXPAND_FAILED;
4507 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4510 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4512 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4513 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4514 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4515 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4516 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4518 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4519 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4520 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4521 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4522 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4524 /* Set up expansion variables */
4525 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4526 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4527 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4528 prvscheck_address[myptr] = '\0';
4529 prvscheck_keynum = string_copy(key_num);
4531 /* Now expand the second argument */
4532 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4534 case 1: goto EXPAND_FAILED_CURLY;
4536 case 3: goto EXPAND_FAILED;
4539 /* Now we have the key and can check the address. */
4541 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4546 expand_string_message = US"hmac-sha1 conversion failed";
4550 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4551 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4553 if (Ustrcmp(p,hash) == 0)
4555 /* Success, valid BATV address. Now check the expiry date. */
4556 uschar *now = prvs_daystamp(0);
4557 unsigned int inow = 0,iexpire = 1;
4559 (void)sscanf(CS now,"%u",&inow);
4560 (void)sscanf(CS daystamp,"%u",&iexpire);
4562 /* When "iexpire" is < 7, a "flip" has occured.
4563 Adjust "inow" accordingly. */
4564 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4566 if (iexpire >= inow)
4568 prvscheck_result = US"1";
4569 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4573 prvscheck_result = NULL;
4574 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4579 prvscheck_result = NULL;
4580 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4583 /* Now expand the final argument. We leave this till now so that
4584 it can include $prvscheck_result. */
4586 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4588 case 1: goto EXPAND_FAILED_CURLY;
4590 case 3: goto EXPAND_FAILED;
4593 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4594 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4596 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4598 /* Reset the "internal" variables afterwards, because they are in
4599 dynamic store that will be reclaimed if the expansion succeeded. */
4601 prvscheck_address = NULL;
4602 prvscheck_keynum = NULL;
4606 /* Does not look like a prvs encoded address, return the empty string.
4607 We need to make sure all subs are expanded first, so as to skip over
4610 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4612 case 1: goto EXPAND_FAILED_CURLY;
4614 case 3: goto EXPAND_FAILED;
4621 /* Handle "readfile" to insert an entire file */
4623 case EITEM_READFILE:
4628 if ((expand_forbid & RDO_READFILE) != 0)
4630 expand_string_message = US"file insertions are not permitted";
4634 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4636 case 1: goto EXPAND_FAILED_CURLY;
4638 case 3: goto EXPAND_FAILED;
4641 /* If skipping, we don't actually do anything */
4643 if (skipping) continue;
4645 /* Open the file and read it */
4647 f = Ufopen(sub_arg[0], "rb");
4650 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4654 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4659 /* Handle "readsocket" to insert data from a Unix domain socket */
4661 case EITEM_READSOCK:
4667 struct sockaddr_un sockun; /* don't call this "sun" ! */
4671 if ((expand_forbid & RDO_READSOCK) != 0)
4673 expand_string_message = US"socket insertions are not permitted";
4677 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4678 because there may be a string for expansion on failure. */
4680 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4682 case 1: goto EXPAND_FAILED_CURLY;
4683 case 2: /* Won't occur: no end check */
4684 case 3: goto EXPAND_FAILED;
4687 /* Sort out timeout, if given */
4689 if (sub_arg[2] != NULL)
4691 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4694 expand_string_message = string_sprintf("bad time value %s",
4699 else sub_arg[3] = NULL; /* No eol if no timeout */
4701 /* If skipping, we don't actually do anything. Otherwise, arrange to
4702 connect to either an IP or a Unix socket. */
4706 /* Handle an IP (internet) domain */
4708 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4711 uschar *server_name = sub_arg[0] + 5;
4712 uschar *port_name = Ustrrchr(server_name, ':');
4714 /* Sort out the port */
4716 if (port_name == NULL)
4718 expand_string_message =
4719 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4722 *port_name++ = 0; /* Terminate server name */
4724 if (isdigit(*port_name))
4727 port = Ustrtol(port_name, &end, 0);
4728 if (end != port_name + Ustrlen(port_name))
4730 expand_string_message =
4731 string_sprintf("invalid port number %s", port_name);
4737 struct servent *service_info = getservbyname(CS port_name, "tcp");
4738 if (service_info == NULL)
4740 expand_string_message = string_sprintf("unknown port \"%s\"",
4744 port = ntohs(service_info->s_port);
4747 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4748 timeout, NULL, &expand_string_message)) < 0)
4752 /* Handle a Unix domain socket */
4757 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4759 expand_string_message = string_sprintf("failed to create socket: %s",
4764 sockun.sun_family = AF_UNIX;
4765 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4768 sigalrm_seen = FALSE;
4770 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4774 expand_string_message = US "socket connect timed out";
4779 expand_string_message = string_sprintf("failed to connect to socket "
4780 "%s: %s", sub_arg[0], strerror(errno));
4785 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4787 /* Allow sequencing of test actions */
4788 if (running_in_test_harness) millisleep(100);
4790 /* Write the request string, if not empty */
4792 if (sub_arg[1][0] != 0)
4794 int len = Ustrlen(sub_arg[1]);
4795 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4797 if (write(fd, sub_arg[1], len) != len)
4799 expand_string_message = string_sprintf("request write to socket "
4800 "failed: %s", strerror(errno));
4805 /* Shut down the sending side of the socket. This helps some servers to
4806 recognise that it is their turn to do some work. Just in case some
4807 system doesn't have this function, make it conditional. */
4810 shutdown(fd, SHUT_WR);
4813 if (running_in_test_harness) millisleep(100);
4815 /* Now we need to read from the socket, under a timeout. The function
4816 that reads a file can be used. */
4818 f = fdopen(fd, "rb");
4819 sigalrm_seen = FALSE;
4821 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4825 /* After a timeout, we restore the pointer in the result, that is,
4826 make sure we add nothing from the socket. */
4831 expand_string_message = US "socket read timed out";
4836 /* The whole thing has worked (or we were skipping). If there is a
4837 failure string following, we need to skip it. */
4841 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4843 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4844 while (isspace(*s)) s++;
4846 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4849 /* Come here on failure to create socket, connect socket, write to the
4850 socket, or timeout on reading. If another substring follows, expand and
4851 use it. Otherwise, those conditions give expand errors. */
4854 if (*s != '{') goto EXPAND_FAILED;
4855 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4856 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4857 if (arg == NULL) goto EXPAND_FAILED;
4858 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4859 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4860 while (isspace(*s)) s++;
4861 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4865 /* Handle "run" to execute a program. */
4871 const uschar **argv;
4874 int lsize = 0, lptr = 0;
4876 if ((expand_forbid & RDO_RUN) != 0)
4878 expand_string_message = US"running a command is not permitted";
4882 while (isspace(*s)) s++;
4883 if (*s != '{') goto EXPAND_FAILED_CURLY;
4884 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4885 if (arg == NULL) goto EXPAND_FAILED;
4886 while (isspace(*s)) s++;
4887 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4889 if (skipping) /* Just pretend it worked when we're skipping */
4895 if (!transport_set_up_command(&argv, /* anchor for arg list */
4896 arg, /* raw command */
4897 FALSE, /* don't expand the arguments */
4898 0, /* not relevant when... */
4899 NULL, /* no transporting address */
4900 US"${run} expansion", /* for error messages */
4901 &expand_string_message)) /* where to put error message */
4904 /* Create the child process, making it a group leader. */
4906 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
4908 expand_string_message =
4909 string_sprintf("couldn't create child process: %s", strerror(errno));
4913 /* Nothing is written to the standard input. */
4917 /* Read the pipe to get the command's output into $value (which is kept
4918 in lookup_value). Read during execution, so that if the output exceeds
4919 the OS pipe buffer limit, we don't block forever. Remember to not release
4920 memory just allocated for $value. */
4923 f = fdopen(fd_out, "rb");
4924 sigalrm_seen = FALSE;
4926 lookup_value = cat_file(f, NULL, &lsize, &lptr, NULL);
4930 /* Wait for the process to finish, applying the timeout, and inspect its
4931 return code for serious disasters. Simple non-zero returns are passed on.
4934 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4936 if (sigalrm_seen == TRUE || runrc == -256)
4938 expand_string_message = string_sprintf("command timed out");
4939 killpg(pid, SIGKILL); /* Kill the whole process group */
4942 else if (runrc == -257)
4943 expand_string_message = string_sprintf("wait() failed: %s",
4947 expand_string_message = string_sprintf("command killed by signal %d",
4954 /* Process the yes/no strings; $value may be useful in both cases */
4956 switch(process_yesno(
4957 skipping, /* were previously skipping */
4958 runrc == 0, /* success/failure indicator */
4959 lookup_value, /* value to reset for string2 */
4960 &s, /* input pointer */
4961 &yield, /* output pointer */
4962 &size, /* output size */
4963 &ptr, /* output current point */
4964 US"run", /* condition type */
4967 case 1: goto EXPAND_FAILED; /* when all is well, the */
4968 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4974 /* Handle character translation for "tr" */
4982 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4984 case 1: goto EXPAND_FAILED_CURLY;
4986 case 3: goto EXPAND_FAILED;
4989 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4990 o2m = Ustrlen(sub[2]) - 1;
4992 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4994 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4998 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
5005 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5006 expanded arguments. */
5016 int val[2] = { 0, -1 };
5019 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5020 Ensure that sub[2] is set in the ${length } case. */
5023 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5024 TRUE, name, &resetok))
5026 case 1: goto EXPAND_FAILED_CURLY;
5028 case 3: goto EXPAND_FAILED;
5031 /* Juggle the arguments if there are only two of them: always move the
5032 string to the last position and make ${length{n}{str}} equivalent to
5033 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5039 if (item_type == EITEM_LENGTH)
5046 for (i = 0; i < 2; i++)
5048 if (sub[i] == NULL) continue;
5049 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5050 if (*ret != 0 || (i != 0 && val[i] < 0))
5052 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5053 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5059 (item_type == EITEM_HASH)?
5060 compute_hash(sub[2], val[0], val[1], &len) :
5061 (item_type == EITEM_NHASH)?
5062 compute_nhash(sub[2], val[0], val[1], &len) :
5063 extract_substr(sub[2], val[0], val[1], &len);
5065 if (ret == NULL) goto EXPAND_FAILED;
5066 yield = string_cat(yield, &size, &ptr, ret, len);
5070 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5071 This code originally contributed by Steve Haslam. It currently supports
5072 the use of MD5 and SHA-1 hashes.
5074 We need some workspace that is large enough to handle all the supported
5075 hash types. Use macros to set the sizes rather than be too elaborate. */
5077 #define MAX_HASHLEN 20
5078 #define MAX_HASHBLOCKLEN 64
5087 int hashlen; /* Number of octets for the hash algorithm's output */
5088 int hashblocklen; /* Number of octets the hash algorithm processes */
5090 unsigned int keylen;
5092 uschar keyhash[MAX_HASHLEN];
5093 uschar innerhash[MAX_HASHLEN];
5094 uschar finalhash[MAX_HASHLEN];
5095 uschar finalhash_hex[2*MAX_HASHLEN];
5096 uschar innerkey[MAX_HASHBLOCKLEN];
5097 uschar outerkey[MAX_HASHBLOCKLEN];
5099 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5101 case 1: goto EXPAND_FAILED_CURLY;
5103 case 3: goto EXPAND_FAILED;
5106 if (Ustrcmp(sub[0], "md5") == 0)
5109 use_base = &md5_base;
5113 else if (Ustrcmp(sub[0], "sha1") == 0)
5116 use_base = &sha1_base;
5122 expand_string_message =
5123 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5128 keylen = Ustrlen(keyptr);
5130 /* If the key is longer than the hash block length, then hash the key
5133 if (keylen > hashblocklen)
5135 chash_start(type, use_base);
5136 chash_end(type, use_base, keyptr, keylen, keyhash);
5141 /* Now make the inner and outer key values */
5143 memset(innerkey, 0x36, hashblocklen);
5144 memset(outerkey, 0x5c, hashblocklen);
5146 for (i = 0; i < keylen; i++)
5148 innerkey[i] ^= keyptr[i];
5149 outerkey[i] ^= keyptr[i];
5152 /* Now do the hashes */
5154 chash_start(type, use_base);
5155 chash_mid(type, use_base, innerkey);
5156 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5158 chash_start(type, use_base);
5159 chash_mid(type, use_base, outerkey);
5160 chash_end(type, use_base, innerhash, hashlen, finalhash);
5162 /* Encode the final hash as a hex string */
5165 for (i = 0; i < hashlen; i++)
5167 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5168 *p++ = hex_digits[finalhash[i] & 0x0f];
5171 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5172 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5174 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5179 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5180 We have to save the numerical variables and restore them afterwards. */
5185 int moffset, moffsetextra, slen;
5188 const uschar *rerror;
5191 int save_expand_nmax =
5192 save_expand_strings(save_expand_nstring, save_expand_nlength);
5194 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5196 case 1: goto EXPAND_FAILED_CURLY;
5198 case 3: goto EXPAND_FAILED;
5201 /* Compile the regular expression */
5203 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5208 expand_string_message = string_sprintf("regular expression error in "
5209 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5213 /* Now run a loop to do the substitutions as often as necessary. It ends
5214 when there are no more matches. Take care over matches of the null string;
5215 do the same thing as Perl does. */
5218 slen = Ustrlen(sub[0]);
5219 moffset = moffsetextra = 0;
5224 int ovector[3*(EXPAND_MAXN+1)];
5225 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5226 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5230 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5231 is not necessarily the end. We want to repeat the match from one
5232 character further along, but leaving the basic offset the same (for
5233 copying below). We can't be at the end of the string - that was checked
5234 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5235 finished; copy the remaining string and end the loop. */
5245 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5249 /* Match - set up for expanding the replacement. */
5251 if (n == 0) n = EXPAND_MAXN + 1;
5253 for (nn = 0; nn < n*2; nn += 2)
5255 expand_nstring[expand_nmax] = subject + ovector[nn];
5256 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5260 /* Copy the characters before the match, plus the expanded insertion. */
5262 yield = string_cat(yield, &size, &ptr, subject + moffset,
5263 ovector[0] - moffset);
5264 insert = expand_string(sub[2]);
5265 if (insert == NULL) goto EXPAND_FAILED;
5266 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5268 moffset = ovector[1];
5272 /* If we have matched an empty string, first check to see if we are at
5273 the end of the subject. If so, the loop is over. Otherwise, mimic
5274 what Perl's /g options does. This turns out to be rather cunning. First
5275 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5276 string at the same point. If this fails (picked up above) we advance to
5277 the next character. */
5279 if (ovector[0] == ovector[1])
5281 if (ovector[0] == slen) break;
5282 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5286 /* All done - restore numerical variables. */
5288 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5289 save_expand_nlength);
5293 /* Handle keyed and numbered substring extraction. If the first argument
5294 consists entirely of digits, then a numerical extraction is assumed. */
5300 int field_number = 1;
5301 BOOL field_number_set = FALSE;
5302 uschar *save_lookup_value = lookup_value;
5304 int save_expand_nmax =
5305 save_expand_strings(save_expand_nstring, save_expand_nlength);
5307 /* Read the arguments */
5309 for (i = 0; i < j; i++)
5311 while (isspace(*s)) s++;
5312 if (*s == '{') /*}*/
5314 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5315 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5316 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5318 /* After removal of leading and trailing white space, the first
5319 argument must not be empty; if it consists entirely of digits
5320 (optionally preceded by a minus sign), this is a numerical
5321 extraction, and we expect 3 arguments. */
5329 while (isspace(*p)) p++;
5333 while (len > 0 && isspace(p[len-1])) len--;
5340 expand_string_message = US"first argument of \"extract\" must "
5350 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5354 j = 3; /* Need 3 args */
5355 field_number_set = TRUE;
5360 else goto EXPAND_FAILED_CURLY;
5363 /* Extract either the numbered or the keyed substring into $value. If
5364 skipping, just pretend the extraction failed. */
5366 lookup_value = skipping? NULL : field_number_set?
5367 expand_gettokened(field_number, sub[1], sub[2]) :
5368 expand_getkeyed(sub[0], sub[1]);
5370 /* If no string follows, $value gets substituted; otherwise there can
5371 be yes/no strings, as for lookup or if. */
5373 switch(process_yesno(
5374 skipping, /* were previously skipping */
5375 lookup_value != NULL, /* success/failure indicator */
5376 save_lookup_value, /* value to reset for string2 */
5377 &s, /* input pointer */
5378 &yield, /* output pointer */
5379 &size, /* output size */
5380 &ptr, /* output current point */
5381 US"extract", /* condition type */
5384 case 1: goto EXPAND_FAILED; /* when all is well, the */
5385 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5388 /* All done - restore numerical variables. */
5390 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5391 save_expand_nlength);
5396 /* return the Nth item from a list */
5398 case EITEM_LISTEXTRACT:
5401 int field_number = 1;
5402 uschar *save_lookup_value = lookup_value;
5404 int save_expand_nmax =
5405 save_expand_strings(save_expand_nstring, save_expand_nlength);
5407 /* Read the field & list arguments */
5409 for (i = 0; i < 2; i++)
5411 while (isspace(*s)) s++;
5412 if (*s != '{') /*}*/
5413 goto EXPAND_FAILED_CURLY;
5415 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5416 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5417 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5419 /* After removal of leading and trailing white space, the first
5420 argument must be numeric and nonempty. */
5428 while (isspace(*p)) p++;
5432 while (len > 0 && isspace(p[len-1])) len--;
5435 if (!*p && !skipping)
5437 expand_string_message = US"first argument of \"listextract\" must "
5447 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5450 expand_string_message = US"first argument of \"listextract\" must "
5458 /* Extract the numbered element into $value. If
5459 skipping, just pretend the extraction failed. */
5461 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5463 /* If no string follows, $value gets substituted; otherwise there can
5464 be yes/no strings, as for lookup or if. */
5466 switch(process_yesno(
5467 skipping, /* were previously skipping */
5468 lookup_value != NULL, /* success/failure indicator */
5469 save_lookup_value, /* value to reset for string2 */
5470 &s, /* input pointer */
5471 &yield, /* output pointer */
5472 &size, /* output size */
5473 &ptr, /* output current point */
5474 US"listextract", /* condition type */
5477 case 1: goto EXPAND_FAILED; /* when all is well, the */
5478 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5481 /* All done - restore numerical variables. */
5483 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5484 save_expand_nlength);
5490 case EITEM_CERTEXTRACT:
5492 uschar *save_lookup_value = lookup_value;
5494 int save_expand_nmax =
5495 save_expand_strings(save_expand_nstring, save_expand_nlength);
5497 /* Read the field argument */
5498 while (isspace(*s)) s++;
5499 if (*s != '{') /*}*/
5500 goto EXPAND_FAILED_CURLY;
5501 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5502 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5503 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5504 /* strip spaces fore & aft */
5509 while (isspace(*p)) p++;
5513 while (len > 0 && isspace(p[len-1])) len--;
5517 /* inspect the cert argument */
5518 while (isspace(*s)) s++;
5519 if (*s != '{') /*}*/
5520 goto EXPAND_FAILED_CURLY;
5523 expand_string_message = US"second argument of \"certextract\" must "
5524 "be a certificate variable";
5527 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5528 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5529 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5532 lookup_value = NULL;
5535 lookup_value = expand_getcertele(sub[0], sub[1]);
5536 if (*expand_string_message) goto EXPAND_FAILED;
5538 switch(process_yesno(
5539 skipping, /* were previously skipping */
5540 lookup_value != NULL, /* success/failure indicator */
5541 save_lookup_value, /* value to reset for string2 */
5542 &s, /* input pointer */
5543 &yield, /* output pointer */
5544 &size, /* output size */
5545 &ptr, /* output current point */
5546 US"certextract", /* condition type */
5549 case 1: goto EXPAND_FAILED; /* when all is well, the */
5550 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5553 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5554 save_expand_nlength);
5557 #endif /*SUPPORT_TLS*/
5559 /* Handle list operations */
5567 uschar outsep[2] = { '\0', '\0' };
5568 const uschar *list, *expr, *temp;
5569 uschar *save_iterate_item = iterate_item;
5570 uschar *save_lookup_value = lookup_value;
5572 while (isspace(*s)) s++;
5573 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5575 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5576 if (list == NULL) goto EXPAND_FAILED;
5577 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5579 if (item_type == EITEM_REDUCE)
5582 while (isspace(*s)) s++;
5583 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5584 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5585 if (!t) goto EXPAND_FAILED;
5587 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5590 while (isspace(*s)) s++;
5591 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5595 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5596 if scanning a "false" part). This allows us to find the end of the
5597 condition, because if the list is empty, we won't actually evaluate the
5598 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5599 the normal internal expansion function. */
5601 if (item_type == EITEM_FILTER)
5603 temp = eval_condition(expr, &resetok, NULL);
5604 if (temp != NULL) s = temp;
5607 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5611 expand_string_message = string_sprintf("%s inside \"%s\" item",
5612 expand_string_message, name);
5616 while (isspace(*s)) s++;
5619 expand_string_message = string_sprintf("missing } at end of condition "
5620 "or expression inside \"%s\"", name);
5624 while (isspace(*s)) s++; /*{*/
5627 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5632 /* If we are skipping, we can now just move on to the next item. When
5633 processing for real, we perform the iteration. */
5635 if (skipping) continue;
5636 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5638 *outsep = (uschar)sep; /* Separator as a string */
5640 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5642 if (item_type == EITEM_FILTER)
5645 if (eval_condition(expr, &resetok, &condresult) == NULL)
5647 iterate_item = save_iterate_item;
5648 lookup_value = save_lookup_value;
5649 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5650 expand_string_message, name);
5653 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5654 condresult? "true":"false");
5656 temp = iterate_item; /* TRUE => include this item */
5658 continue; /* FALSE => skip this item */
5661 /* EITEM_MAP and EITEM_REDUCE */
5665 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5669 iterate_item = save_iterate_item;
5670 expand_string_message = string_sprintf("%s inside \"%s\" item",
5671 expand_string_message, name);
5674 if (item_type == EITEM_REDUCE)
5676 lookup_value = t; /* Update the value of $value */
5677 continue; /* and continue the iteration */
5681 /* We reach here for FILTER if the condition is true, always for MAP,
5682 and never for REDUCE. The value in "temp" is to be added to the output
5683 list that is being created, ensuring that any occurrences of the
5684 separator character are doubled. Unless we are dealing with the first
5685 item of the output list, add in a space if the new item begins with the
5686 separator character, or is an empty string. */
5688 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5689 yield = string_cat(yield, &size, &ptr, US" ", 1);
5691 /* Add the string in "temp" to the output list that we are building,
5692 This is done in chunks by searching for the separator character. */
5696 size_t seglen = Ustrcspn(temp, outsep);
5697 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5699 /* If we got to the end of the string we output one character
5700 too many; backup and end the loop. Otherwise arrange to double the
5703 if (temp[seglen] == '\0') { ptr--; break; }
5704 yield = string_cat(yield, &size, &ptr, outsep, 1);
5708 /* Output a separator after the string: we will remove the redundant
5709 final one at the end. */
5711 yield = string_cat(yield, &size, &ptr, outsep, 1);
5712 } /* End of iteration over the list loop */
5714 /* REDUCE has generated no output above: output the final value of
5717 if (item_type == EITEM_REDUCE)
5719 yield = string_cat(yield, &size, &ptr, lookup_value,
5720 Ustrlen(lookup_value));
5721 lookup_value = save_lookup_value; /* Restore $value */
5724 /* FILTER and MAP generate lists: if they have generated anything, remove
5725 the redundant final separator. Even though an empty item at the end of a
5726 list does not count, this is tidier. */
5728 else if (ptr != save_ptr) ptr--;
5730 /* Restore preserved $item */
5732 iterate_item = save_iterate_item;
5739 const uschar *srclist, *cmp, *xtract;
5741 const uschar *dstlist = NULL, *dstkeylist = NULL;
5743 uschar *save_iterate_item = iterate_item;
5745 while (isspace(*s)) s++;
5746 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5748 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5749 if (!srclist) goto EXPAND_FAILED;
5750 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5752 while (isspace(*s)) s++;
5753 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5755 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5756 if (!cmp) goto EXPAND_FAILED;
5757 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5759 while (isspace(*s)) s++;
5760 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5763 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5764 if (!tmp) goto EXPAND_FAILED;
5765 xtract = string_copyn(xtract, s - xtract);
5767 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5771 expand_string_message = US"missing } at end of \"sort\"";
5775 if (skipping) continue;
5777 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5780 uschar * newlist = NULL;
5781 uschar * newkeylist = NULL;
5784 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, srcitem);
5786 /* extract field for comparisons */
5787 iterate_item = srcitem;
5788 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5792 expand_string_message = string_sprintf(
5793 "field-extract in sort: \"%s\"", xtract);
5797 /* Insertion sort */
5799 /* copy output list until new-item < list-item */
5800 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5806 /* field for comparison */
5807 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5810 /* build and run condition string */
5811 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
5813 DEBUG(D_expand) debug_printf("%s: cond = \"%s\"\n", name, expr);
5814 if (!eval_condition(expr, &resetok, &before))
5816 expand_string_message = string_sprintf("comparison in sort: %s",
5823 /* New-item sorts before this dst-item. Append new-item,
5824 then dst-item, then remainder of dst list. */
5826 newlist = string_append_listele(newlist, sep, srcitem);
5827 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5830 newlist = string_append_listele(newlist, sep, dstitem);
5831 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5833 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5835 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5837 newlist = string_append_listele(newlist, sep, dstitem);
5838 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5844 newlist = string_append_listele(newlist, sep, dstitem);
5845 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5848 /* If we ran out of dstlist without consuming srcitem, append it */
5851 newlist = string_append_listele(newlist, sep, srcitem);
5852 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5856 dstkeylist = newkeylist;
5858 DEBUG(D_expand) debug_printf("%s: dstlist = \"%s\"\n", name, dstlist);
5859 DEBUG(D_expand) debug_printf("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
5863 yield = string_cat(yield, &size, &ptr, dstlist, Ustrlen(dstlist));
5865 /* Restore preserved $item */
5866 iterate_item = save_iterate_item;
5870 expand_string_message = US"Internal error in sort (list mismatch)";
5875 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5876 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5877 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5878 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5880 #define EXPAND_DLFUNC_MAX_ARGS 8
5883 #ifndef EXPAND_DLFUNC
5884 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5885 "is not included in this binary";
5888 #else /* EXPAND_DLFUNC */
5891 exim_dlfunc_t *func;
5894 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5896 if ((expand_forbid & RDO_DLFUNC) != 0)
5898 expand_string_message =
5899 US"dynamically-loaded functions are not permitted";
5903 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5904 TRUE, US"dlfunc", &resetok))
5906 case 1: goto EXPAND_FAILED_CURLY;
5908 case 3: goto EXPAND_FAILED;
5911 /* If skipping, we don't actually do anything */
5913 if (skipping) continue;
5915 /* Look up the dynamically loaded object handle in the tree. If it isn't
5916 found, dlopen() the file and put the handle in the tree for next time. */
5918 t = tree_search(dlobj_anchor, argv[0]);
5921 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5924 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5925 argv[0], dlerror());
5926 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5929 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5930 Ustrcpy(t->name, argv[0]);
5931 t->data.ptr = handle;
5932 (void)tree_insertnode(&dlobj_anchor, t);
5935 /* Having obtained the dynamically loaded object handle, look up the
5936 function pointer. */
5938 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5941 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5942 "%s", argv[1], argv[0], dlerror());
5943 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5947 /* Call the function and work out what to do with the result. If it
5948 returns OK, we have a replacement string; if it returns DEFER then
5949 expansion has failed in a non-forced manner; if it returns FAIL then
5950 failure was forced; if it returns ERROR or any other value there's a
5951 problem, so panic slightly. In any case, assume that the function has
5952 side-effects on the store that must be preserved. */
5956 for (argc = 0; argv[argc] != NULL; argc++);
5957 status = func(&result, argc - 2, &argv[2]);
5960 if (result == NULL) result = US"";
5961 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5966 expand_string_message = result == NULL ? US"(no message)" : result;
5967 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5968 else if(status != FAIL)
5969 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5970 argv[0], argv[1], status, expand_string_message);
5974 #endif /* EXPAND_DLFUNC */
5976 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
5979 uschar *save_lookup_value = lookup_value;
5981 while (isspace(*s)) s++;
5982 if (*s != '{') /*}*/
5985 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5986 if (!key) goto EXPAND_FAILED; /*{*/
5987 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5989 lookup_value = US getenv(CS key);
5991 switch(process_yesno(
5992 skipping, /* were previously skipping */
5993 lookup_value != NULL, /* success/failure indicator */
5994 save_lookup_value, /* value to reset for string2 */
5995 &s, /* input pointer */
5996 &yield, /* output pointer */
5997 &size, /* output size */
5998 &ptr, /* output current point */
5999 US"env", /* condition type */
6002 case 1: goto EXPAND_FAILED; /* when all is well, the */
6003 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6007 } /* EITEM_* switch */
6009 /* Control reaches here if the name is not recognized as one of the more
6010 complicated expansion items. Check for the "operator" syntax (name terminated
6011 by a colon). Some of the operators have arguments, separated by _ from the
6019 var_entry *vp = NULL;
6021 /* Owing to an historical mis-design, an underscore may be part of the
6022 operator name, or it may introduce arguments. We therefore first scan the
6023 table of names that contain underscores. If there is no match, we cut off
6024 the arguments and then scan the main table. */
6026 if ((c = chop_match(name, op_table_underscore,
6027 nelem(op_table_underscore))) < 0)
6029 arg = Ustrchr(name, '_');
6030 if (arg != NULL) *arg = 0;
6031 c = chop_match(name, op_table_main, nelem(op_table_main));
6032 if (c >= 0) c += nelem(op_table_underscore);
6033 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6036 /* Deal specially with operators that might take a certificate variable
6037 as we do not want to do the usual expansion. For most, expand the string.*/
6047 const uschar * s1 = s;
6048 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6050 if (!sub) goto EXPAND_FAILED; /*{*/
6051 if (*s1 != '}') goto EXPAND_FAILED_CURLY;
6052 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6062 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6063 if (!sub) goto EXPAND_FAILED;
6068 /* If we are skipping, we don't need to perform the operation at all.
6069 This matters for operations like "mask", because the data may not be
6070 in the correct format when skipping. For example, the expression may test
6071 for the existence of $sender_host_address before trying to mask it. For
6072 other operations, doing them may not fail, but it is a waste of time. */
6074 if (skipping && c >= 0) continue;
6076 /* Otherwise, switch on the operator type */
6083 unsigned long int n = Ustrtoul(sub, &t, 10);
6086 expand_string_message = string_sprintf("argument for base62 "
6087 "operator is \"%s\", which is not a decimal number", sub);
6090 t = string_base62(n);
6091 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6095 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6101 unsigned long int n = 0;
6104 uschar *t = Ustrchr(base62_chars, *tt++);
6107 expand_string_message = string_sprintf("argument for base62d "
6108 "operator is \"%s\", which is not a base %d number", sub,
6112 n = n * BASE_62 + (t - base62_chars);
6114 (void)sprintf(CS buf, "%ld", n);
6115 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
6121 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6122 if (expanded == NULL)
6124 expand_string_message =
6125 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6126 expand_string_message);
6129 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
6136 uschar *t = sub - 1;
6137 while (*(++t) != 0) { *t = tolower(*t); count++; }
6138 yield = string_cat(yield, &size, &ptr, sub, count);
6145 uschar *t = sub - 1;
6146 while (*(++t) != 0) { *t = toupper(*t); count++; }
6147 yield = string_cat(yield, &size, &ptr, sub, count);
6153 if (vp && *(void **)vp->value)
6155 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6156 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6166 md5_end(&base, sub, Ustrlen(sub), digest);
6167 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6168 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6174 if (vp && *(void **)vp->value)
6176 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6177 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6187 sha1_end(&base, sub, Ustrlen(sub), digest);
6188 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6189 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6195 if (vp && *(void **)vp->value)
6197 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6198 yield = string_cat(yield, &size, &ptr, cp, (int)Ustrlen(cp));
6202 expand_string_message = US"sha256 only supported for certificates";
6205 /* Convert hex encoding to base64 encoding */
6215 for (enc = sub; *enc != 0; enc++)
6217 if (!isxdigit(*enc))
6219 expand_string_message = string_sprintf("\"%s\" is not a hex "
6228 expand_string_message = string_sprintf("\"%s\" contains an odd "
6229 "number of characters", sub);
6233 while ((c = *in++) != 0)
6235 if (isdigit(c)) c -= '0';
6236 else c = toupper(c) - 'A' + 10;
6248 enc = b64encode(sub, out - sub);
6249 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
6253 /* Convert octets outside 0x21..0x7E to \xXX form */
6257 uschar *t = sub - 1;
6260 if (*t < 0x21 || 0x7E < *t)
6261 yield = string_cat(yield, &size, &ptr,
6262 string_sprintf("\\x%02x", *t), 4);
6264 yield = string_cat(yield, &size, &ptr, t, 1);
6269 /* count the number of list elements */
6278 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6279 cp = string_sprintf("%d", cnt);
6280 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6284 /* expand a named list given the name */
6285 /* handles nested named lists; requotes as colon-sep list */
6289 tree_node *t = NULL;
6290 const uschar * list;
6293 uschar * suffix = US"";
6294 BOOL needsep = FALSE;
6297 if (*sub == '+') sub++;
6298 if (arg == NULL) /* no-argument version */
6300 if (!(t = tree_search(addresslist_anchor, sub)) &&
6301 !(t = tree_search(domainlist_anchor, sub)) &&
6302 !(t = tree_search(hostlist_anchor, sub)))
6303 t = tree_search(localpartlist_anchor, sub);
6305 else switch(*arg) /* specific list-type version */
6307 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6308 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6309 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6310 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6312 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6318 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6320 : *arg=='a'?"address "
6321 : *arg=='d'?"domain "
6323 : *arg=='l'?"localpart "
6328 list = ((namedlist_block *)(t->data.ptr))->string;
6330 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6332 uschar * buf = US" : ";
6334 yield = string_cat(yield, &size, &ptr, buf, 3);
6338 if (*item == '+') /* list item is itself a named list */
6340 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6341 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6343 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6347 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6348 while ((cp= strpbrk((const char *)item, tok)))
6350 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
6351 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6353 yield = string_cat(yield, &size, &ptr, US"::", 2);
6354 item = (uschar *)cp;
6356 else /* sep in item; should already be doubled; emit once */
6358 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
6359 if (*cp == sep) cp++;
6360 item = (uschar *)cp;
6364 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
6369 /* mask applies a mask to an IP address; for example the result of
6370 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6377 int mask, maskoffset;
6378 int type = string_is_ip_address(sub, &maskoffset);
6383 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6388 if (maskoffset == 0)
6390 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6395 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6397 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6399 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6404 /* Convert the address to binary integer(s) and apply the mask */
6406 sub[maskoffset] = 0;
6407 count = host_aton(sub, binary);
6408 host_mask(count, binary, mask);
6410 /* Convert to masked textual format and add to output. */
6412 yield = string_cat(yield, &size, &ptr, buffer,
6413 host_nmtoa(count, binary, mask, buffer, '.'));
6418 case EOP_IPV6DENORM:
6420 int type = string_is_ip_address(sub, NULL);
6427 (void) host_aton(sub, binary);
6430 case 4: /* convert to IPv4-mapped IPv6 */
6431 binary[0] = binary[1] = 0;
6432 binary[2] = 0x0000ffff;
6433 (void) host_aton(sub, binary+3);
6437 expand_string_message =
6438 string_sprintf("\"%s\" is not an IP address", sub);
6442 yield = string_cat(yield, &size, &ptr, buffer,
6444 ? ipv6_nmtoa(binary, buffer)
6445 : host_nmtoa(4, binary, -1, buffer, ':')
6451 case EOP_LOCAL_PART:
6455 int start, end, domain;
6456 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6460 if (c != EOP_DOMAIN)
6462 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6463 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
6465 else if (domain != 0)
6468 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
6476 uschar outsep[2] = { ':', '\0' };
6477 uschar *address, *error;
6479 int start, end, domain; /* Not really used */
6481 while (isspace(*sub)) sub++;
6482 if (*sub == '>') { *outsep = *++sub; ++sub; }
6483 parse_allow_group = TRUE;
6487 uschar *p = parse_find_address_end(sub, FALSE);
6488 uschar saveend = *p;
6490 address = parse_extract_address(sub, &error, &start, &end, &domain,
6494 /* Add the address to the output list that we are building. This is
6495 done in chunks by searching for the separator character. At the
6496 start, unless we are dealing with the first address of the output
6497 list, add in a space if the new address begins with the separator
6498 character, or is an empty string. */
6500 if (address != NULL)
6502 if (ptr != save_ptr && address[0] == *outsep)
6503 yield = string_cat(yield, &size, &ptr, US" ", 1);
6507 size_t seglen = Ustrcspn(address, outsep);
6508 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
6510 /* If we got to the end of the string we output one character
6513 if (address[seglen] == '\0') { ptr--; break; }
6514 yield = string_cat(yield, &size, &ptr, outsep, 1);
6515 address += seglen + 1;
6518 /* Output a separator after the string: we will remove the
6519 redundant final one at the end. */
6521 yield = string_cat(yield, &size, &ptr, outsep, 1);
6524 if (saveend == '\0') break;
6528 /* If we have generated anything, remove the redundant final
6531 if (ptr != save_ptr) ptr--;
6532 parse_allow_group = FALSE;
6537 /* quote puts a string in quotes if it is empty or contains anything
6538 other than alphamerics, underscore, dot, or hyphen.
6540 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6541 be quoted in order to be a valid local part.
6543 In both cases, newlines and carriage returns are converted into \n and \r
6547 case EOP_QUOTE_LOCAL_PART:
6550 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6551 uschar *t = sub - 1;
6555 while (!needs_quote && *(++t) != 0)
6556 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6558 else /* EOP_QUOTE_LOCAL_PART */
6560 while (!needs_quote && *(++t) != 0)
6561 needs_quote = !isalnum(*t) &&
6562 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6563 (*t != '.' || t == sub || t[1] == 0);
6568 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6573 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6574 else if (*t == '\r')
6575 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6578 if (*t == '\\' || *t == '"')
6579 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6580 yield = string_cat(yield, &size, &ptr, t, 1);
6583 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6585 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6589 /* quote_lookuptype does lookup-specific quoting */
6594 uschar *opt = Ustrchr(arg, '_');
6596 if (opt != NULL) *opt++ = 0;
6598 n = search_findtype(arg, Ustrlen(arg));
6601 expand_string_message = search_error_message;
6605 if (lookup_list[n]->quote != NULL)
6606 sub = (lookup_list[n]->quote)(sub, opt);
6607 else if (opt != NULL) sub = NULL;
6611 expand_string_message = string_sprintf(
6612 "\"%s\" unrecognized after \"${quote_%s\"",
6617 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6621 /* rx quote sticks in \ before any non-alphameric character so that
6622 the insertion works in a regular expression. */
6626 uschar *t = sub - 1;
6630 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6631 yield = string_cat(yield, &size, &ptr, t, 1);
6636 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6637 prescribed by the RFC, if there are characters that need to be encoded */
6641 uschar buffer[2048];
6642 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6643 buffer, sizeof(buffer), FALSE);
6644 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6648 /* RFC 2047 decode */
6654 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6655 headers_charset, '?', &len, &error);
6658 expand_string_message = error;
6661 yield = string_cat(yield, &size, &ptr, decoded, len);
6665 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6675 if (c > 255) c = '_';
6677 yield = string_cat(yield, &size, &ptr, buff, 1);
6682 /* replace illegal UTF-8 sequences by replacement character */
6684 #define UTF8_REPLACEMENT_CHAR US"?"
6688 int seq_len = 0, index = 0;
6690 long codepoint = -1;
6691 uschar seq_buff[4]; /* accumulate utf-8 here */
6700 if ((c & 0xc0) != 0x80)
6701 /* wrong continuation byte; invalidate all bytes */
6702 complete = 1; /* error */
6705 codepoint = (codepoint << 6) | (c & 0x3f);
6706 seq_buff[index++] = c;
6707 if (--bytes_left == 0) /* codepoint complete */
6708 if(codepoint > 0x10FFFF) /* is it too large? */
6709 complete = -1; /* error (RFC3629 limit) */
6711 { /* finished; output utf-8 sequence */
6712 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6717 else /* no bytes left: new sequence */
6719 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6721 yield = string_cat(yield, &size, &ptr, &c, 1);
6724 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6726 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6731 codepoint = c & 0x1f;
6734 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6737 codepoint = c & 0x0f;
6739 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6742 codepoint = c & 0x07;
6744 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6747 seq_buff[index++] = c;
6748 seq_len = bytes_left + 1;
6749 } /* if(bytes_left) */
6753 bytes_left = index = 0;
6754 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6756 if ((complete == 1) && ((c & 0x80) == 0))
6757 /* ASCII character follows incomplete sequence */
6758 yield = string_cat(yield, &size, &ptr, &c, 1);
6764 case EOP_UTF8_DOMAIN_TO_ALABEL:
6766 uschar * error = NULL;
6767 uschar * s = string_domain_utf8_to_alabel(sub, &error);
6770 expand_string_message = string_sprintf(
6771 "error converting utf8 (%s) to alabel: %s",
6772 string_printing(sub), error);
6775 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6779 case EOP_UTF8_DOMAIN_FROM_ALABEL:
6781 uschar * error = NULL;
6782 uschar * s = string_domain_alabel_to_utf8(sub, &error);
6785 expand_string_message = string_sprintf(
6786 "error converting alabel (%s) to utf8: %s",
6787 string_printing(sub), error);
6790 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6794 case EOP_UTF8_LOCALPART_TO_ALABEL:
6796 uschar * error = NULL;
6797 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
6800 expand_string_message = string_sprintf(
6801 "error converting utf8 (%s) to alabel: %s",
6802 string_printing(sub), error);
6805 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6806 DEBUG(D_expand) debug_printf("yield: '%s'\n", yield);
6810 case EOP_UTF8_LOCALPART_FROM_ALABEL:
6812 uschar * error = NULL;
6813 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
6816 expand_string_message = string_sprintf(
6817 "error converting alabel (%s) to utf8: %s",
6818 string_printing(sub), error);
6821 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6824 #endif /* EXPERIMENTAL_INTERNATIONAL */
6826 /* escape turns all non-printing characters into escape sequences. */
6830 const uschar *t = string_printing(sub);
6831 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6835 /* Handle numeric expression evaluation */
6840 uschar *save_sub = sub;
6841 uschar *error = NULL;
6842 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6845 expand_string_message = string_sprintf("error in expression "
6846 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6850 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6851 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6855 /* Handle time period formating */
6859 int n = readconf_readtime(sub, 0, FALSE);
6862 expand_string_message = string_sprintf("string \"%s\" is not an "
6863 "Exim time interval in \"%s\" operator", sub, name);
6866 sprintf(CS var_buffer, "%d", n);
6867 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6871 case EOP_TIME_INTERVAL:
6874 uschar *t = read_number(&n, sub);
6875 if (*t != 0) /* Not A Number*/
6877 expand_string_message = string_sprintf("string \"%s\" is not a "
6878 "positive number in \"%s\" operator", sub, name);
6881 t = readconf_printtime(n);
6882 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6886 /* Convert string to base64 encoding */
6892 uschar * s = vp && *(void **)vp->value
6893 ? tls_cert_der_b64(*(void **)vp->value)
6894 : b64encode(sub, Ustrlen(sub));
6896 uschar * s = b64encode(sub, Ustrlen(sub));
6898 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6905 int len = b64decode(sub, &s);
6908 expand_string_message = string_sprintf("string \"%s\" is not "
6909 "well-formed for \"%s\" operator", sub, name);
6912 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6916 /* strlen returns the length of the string */
6921 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6922 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6926 /* length_n or l_n takes just the first n characters or the whole string,
6927 whichever is the shorter;
6929 substr_m_n, and s_m_n take n characters from offset m; negative m take
6930 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6931 takes the rest, either to the right or to the left.
6933 hash_n or h_n makes a hash of length n from the string, yielding n
6934 characters from the set a-z; hash_n_m makes a hash of length n, but
6935 uses m characters from the set a-zA-Z0-9.
6937 nhash_n returns a single number between 0 and n-1 (in text form), while
6938 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6939 between 0 and n-1 and the second between 0 and m-1. */
6959 expand_string_message = string_sprintf("missing values after %s",
6964 /* "length" has only one argument, effectively being synonymous with
6967 if (c == EOP_LENGTH || c == EOP_L)
6973 /* The others have one or two arguments; for "substr" the first may be
6974 negative. The second being negative means "not supplied". */
6979 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6982 /* Read up to two numbers, separated by underscores */
6987 if (arg != ret && *arg == '_' && pn == &value1)
6991 if (arg[1] != 0) arg++;
6993 else if (!isdigit(*arg))
6995 expand_string_message =
6996 string_sprintf("non-digit after underscore in \"%s\"", name);
6999 else *pn = (*pn)*10 + *arg++ - '0';
7003 /* Perform the required operation */
7006 (c == EOP_HASH || c == EOP_H)?
7007 compute_hash(sub, value1, value2, &len) :
7008 (c == EOP_NHASH || c == EOP_NH)?
7009 compute_nhash(sub, value1, value2, &len) :
7010 extract_substr(sub, value1, value2, &len);
7012 if (ret == NULL) goto EXPAND_FAILED;
7013 yield = string_cat(yield, &size, &ptr, ret, len);
7023 uschar **modetable[3];
7028 if ((expand_forbid & RDO_EXISTS) != 0)
7030 expand_string_message = US"Use of the stat() expansion is not permitted";
7034 if (stat(CS sub, &st) < 0)
7036 expand_string_message = string_sprintf("stat(%s) failed: %s",
7037 sub, strerror(errno));
7041 switch (mode & S_IFMT)
7043 case S_IFIFO: smode[0] = 'p'; break;
7044 case S_IFCHR: smode[0] = 'c'; break;
7045 case S_IFDIR: smode[0] = 'd'; break;
7046 case S_IFBLK: smode[0] = 'b'; break;
7047 case S_IFREG: smode[0] = '-'; break;
7048 default: smode[0] = '?'; break;
7051 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7052 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7053 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7055 for (i = 0; i < 3; i++)
7057 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7062 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7063 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7064 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7065 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7066 (long)st.st_gid, st.st_size, (long)st.st_atime,
7067 (long)st.st_mtime, (long)st.st_ctime);
7068 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
7072 /* vaguely random number less than N */
7076 int_eximarith_t max;
7079 max = expanded_string_integer(sub, TRUE);
7080 if (expand_string_message != NULL)
7082 s = string_sprintf("%d", vaguely_random_number((int)max));
7083 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
7087 /* Reverse IP, including IPv6 to dotted-nibble */
7089 case EOP_REVERSE_IP:
7091 int family, maskptr;
7092 uschar reversed[128];
7094 family = string_is_ip_address(sub, &maskptr);
7097 expand_string_message = string_sprintf(
7098 "reverse_ip() not given an IP address [%s]", sub);
7101 invert_address(reversed, sub);
7102 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
7106 /* Unknown operator */
7109 expand_string_message =
7110 string_sprintf("unknown expansion operator \"%s\"", name);
7115 /* Handle a plain name. If this is the first thing in the expansion, release
7116 the pre-allocated buffer. If the result data is known to be in a new buffer,
7117 newsize will be set to the size of that buffer, and we can just point at that
7118 store instead of copying. Many expansion strings contain just one reference,
7119 so this is a useful optimization, especially for humungous headers
7120 ($message_headers). */
7128 if (resetok) store_reset(yield);
7132 value = find_variable(name, FALSE, skipping, &newsize);
7135 expand_string_message =
7136 string_sprintf("unknown variable in \"${%s}\"", name);
7137 check_variable_error_message(name);
7140 len = Ustrlen(value);
7141 if (yield == NULL && newsize != 0)
7147 else yield = string_cat(yield, &size, &ptr, value, len);
7151 /* Else there's something wrong */
7153 expand_string_message =
7154 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7155 "in a variable reference)", name);
7159 /* If we hit the end of the string when ket_ends is set, there is a missing
7160 terminating brace. */
7162 if (ket_ends && *s == 0)
7164 expand_string_message = malformed_header?
7165 US"missing } at end of string - could be header name not terminated by colon"
7167 US"missing } at end of string";
7171 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7172 added to the string. If so, set up an empty string. Add a terminating zero. If
7173 left != NULL, return a pointer to the terminator. */
7175 if (yield == NULL) yield = store_get(1);
7177 if (left != NULL) *left = s;
7179 /* Any stacking store that was used above the final string is no longer needed.
7180 In many cases the final string will be the first one that was got and so there
7181 will be optimal store usage. */
7183 if (resetok) store_reset(yield + ptr + 1);
7184 else if (resetok_p) *resetok_p = FALSE;
7188 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
7190 if (skipping) debug_printf("skipping: result is not used\n");
7194 /* This is the failure exit: easiest to program with a goto. We still need
7195 to update the pointer to the terminator, for cases of nested calls with "fail".
7198 EXPAND_FAILED_CURLY:
7199 expand_string_message = malformed_header?
7200 US"missing or misplaced { or } - could be header name not terminated by colon"
7202 US"missing or misplaced { or }";
7204 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7205 that is a bad idea, because expand_string_message is in dynamic store. */
7208 if (left != NULL) *left = s;
7211 debug_printf("failed to expand: %s\n", string);
7212 debug_printf(" error message: %s\n", expand_string_message);
7213 if (expand_string_forcedfail) debug_printf("failure was forced\n");
7215 if (resetok_p) *resetok_p = resetok;
7220 /* This is the external function call. Do a quick check for any expansion
7221 metacharacters, and if there are none, just return the input string.
7223 Argument: the string to be expanded
7224 Returns: the expanded string, or NULL if expansion failed; if failure was
7225 due to a lookup deferring, search_find_defer will be TRUE
7229 expand_string(uschar *string)
7231 search_find_defer = FALSE;
7232 malformed_header = FALSE;
7233 return (Ustrpbrk(string, "$\\") == NULL)? string :
7234 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7240 expand_cstring(const uschar *string)
7242 search_find_defer = FALSE;
7243 malformed_header = FALSE;
7244 return (Ustrpbrk(string, "$\\") == NULL)? string :
7245 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7250 /*************************************************
7252 *************************************************/
7254 /* Now and again we want to expand a string and be sure that the result is in a
7255 new bit of store. This function does that.
7256 Since we know it has been copied, the de-const cast is safe.
7258 Argument: the string to be expanded
7259 Returns: the expanded string, always in a new bit of store, or NULL
7263 expand_string_copy(const uschar *string)
7265 const uschar *yield = expand_cstring(string);
7266 if (yield == string) yield = string_copy(string);
7272 /*************************************************
7273 * Expand and interpret as an integer *
7274 *************************************************/
7276 /* Expand a string, and convert the result into an integer.
7279 string the string to be expanded
7280 isplus TRUE if a non-negative number is expected
7282 Returns: the integer value, or
7283 -1 for an expansion error ) in both cases, message in
7284 -2 for an integer interpretation error ) expand_string_message
7285 expand_string_message is set NULL for an OK integer
7289 expand_string_integer(uschar *string, BOOL isplus)
7291 return expanded_string_integer(expand_string(string), isplus);
7295 /*************************************************
7296 * Interpret string as an integer *
7297 *************************************************/
7299 /* Convert a string (that has already been expanded) into an integer.
7301 This function is used inside the expansion code.
7304 s the string to be expanded
7305 isplus TRUE if a non-negative number is expected
7307 Returns: the integer value, or
7308 -1 if string is NULL (which implies an expansion error)
7309 -2 for an integer interpretation error
7310 expand_string_message is set NULL for an OK integer
7313 static int_eximarith_t
7314 expanded_string_integer(const uschar *s, BOOL isplus)
7316 int_eximarith_t value;
7317 uschar *msg = US"invalid integer \"%s\"";
7320 /* If expansion failed, expand_string_message will be set. */
7322 if (s == NULL) return -1;
7324 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7325 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7326 systems, so we set it zero ourselves. */
7329 expand_string_message = NULL; /* Indicates no error */
7331 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7332 equal to 0. Unfortunately, people actually relied upon that, so preserve
7333 the behaviour explicitly. Stripping leading whitespace is a harmless
7334 noop change since strtol skips it anyway (provided that there is a number
7338 while (isspace(*s)) ++s;
7342 debug_printf("treating blank string as number 0\n");
7347 value = strtoll(CS s, CSS &endptr, 10);
7351 msg = US"integer expected but \"%s\" found";
7353 else if (value < 0 && isplus)
7355 msg = US"non-negative integer expected but \"%s\" found";
7359 switch (tolower(*endptr))
7364 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7369 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7370 else value *= 1024*1024;
7374 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7375 else value *= 1024*1024*1024;
7379 if (errno == ERANGE)
7380 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7383 while (isspace(*endptr)) endptr++;
7384 if (*endptr == 0) return value;
7388 expand_string_message = string_sprintf(CS msg, s);
7393 /* These values are usually fixed boolean values, but they are permitted to be
7397 addr address being routed
7398 mtype the module type
7399 mname the module name
7400 dbg_opt debug selectors
7401 oname the option name
7402 bvalue the router's boolean value
7403 svalue the router's string value
7404 rvalue where to put the returned value
7406 Returns: OK value placed in rvalue
7407 DEFER expansion failed
7411 exp_bool(address_item *addr,
7412 uschar *mtype, uschar *mname, unsigned dbg_opt,
7413 uschar *oname, BOOL bvalue,
7414 uschar *svalue, BOOL *rvalue)
7417 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7419 expanded = expand_string(svalue);
7420 if (expanded == NULL)
7422 if (expand_string_forcedfail)
7424 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7428 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7429 oname, mname, mtype, expand_string_message);
7430 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7434 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7437 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7439 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7443 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7444 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7454 /*************************************************
7455 **************************************************
7456 * Stand-alone test program *
7457 **************************************************
7458 *************************************************/
7464 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7466 int ovector[3*(EXPAND_MAXN+1)];
7467 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7468 ovector, nelem(ovector));
7469 BOOL yield = n >= 0;
7470 if (n == 0) n = EXPAND_MAXN + 1;
7474 expand_nmax = (setup < 0)? 0 : setup + 1;
7475 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7477 expand_nstring[expand_nmax] = subject + ovector[nn];
7478 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7486 int main(int argc, uschar **argv)
7489 uschar buffer[1024];
7491 debug_selector = D_v;
7492 debug_file = stderr;
7493 debug_fd = fileno(debug_file);
7494 big_buffer = malloc(big_buffer_size);
7496 for (i = 1; i < argc; i++)
7498 if (argv[i][0] == '+')
7500 debug_trace_memory = 2;
7503 if (isdigit(argv[i][0]))
7504 debug_selector = Ustrtol(argv[i], NULL, 0);
7506 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7510 eldap_default_servers = argv[i];
7513 mysql_servers = argv[i];
7516 pgsql_servers = argv[i];
7519 redis_servers = argv[i];
7523 else opt_perl_startup = argv[i];
7527 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7529 expand_nstring[1] = US"string 1....";
7530 expand_nlength[1] = 8;
7534 if (opt_perl_startup != NULL)
7537 printf("Starting Perl interpreter\n");
7538 errstr = init_perl(opt_perl_startup);
7541 printf("** error in perl_startup code: %s\n", errstr);
7542 return EXIT_FAILURE;
7545 #endif /* EXIM_PERL */
7547 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7549 void *reset_point = store_get(0);
7550 uschar *yield = expand_string(buffer);
7553 printf("%s\n", yield);
7554 store_reset(reset_point);
7558 if (search_find_defer) printf("search_find deferred\n");
7559 printf("Failed: %s\n", expand_string_message);
7560 if (expand_string_forcedfail) printf("Forced failure\n");
7574 /* End of expand.c */