1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *);
17 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
20 #ifndef SUPPORT_CRYPTEQ
21 #define SUPPORT_CRYPTEQ
26 #include "lookups/ldap.h"
29 #ifdef SUPPORT_CRYPTEQ
34 extern char* crypt16(char*, char*);
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. 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[] = {
245 EOP_ADDRESS = nelem(op_table_underscore),
290 /* Table of condition names, and corresponding switch numbers. The names must
291 be in alphabetical order. */
293 static uschar *cond_table[] = {
297 US"==", /* Backward compatibility */
330 US"match_local_part",
355 ECOND_FIRST_DELIVERY,
376 ECOND_MATCH_LOCAL_PART,
386 /* Types of table entry */
389 vtype_int, /* value is address of int */
390 vtype_filter_int, /* ditto, but recognized only when filtering */
391 vtype_ino, /* value is address of ino_t (not always an int) */
392 vtype_uid, /* value is address of uid_t (not always an int) */
393 vtype_gid, /* value is address of gid_t (not always an int) */
394 vtype_bool, /* value is address of bool */
395 vtype_stringptr, /* value is address of pointer to string */
396 vtype_msgbody, /* as stringptr, but read when first required */
397 vtype_msgbody_end, /* ditto, the end of the message */
398 vtype_msgheaders, /* the message's headers, processed */
399 vtype_msgheaders_raw, /* the message's headers, unprocessed */
400 vtype_localpart, /* extract local part from string */
401 vtype_domain, /* extract domain from string */
402 vtype_string_func, /* value is string returned by given function */
403 vtype_todbsdin, /* value not used; generate BSD inbox tod */
404 vtype_tode, /* value not used; generate tod in epoch format */
405 vtype_todel, /* value not used; generate tod in epoch/usec format */
406 vtype_todf, /* value not used; generate full tod */
407 vtype_todl, /* value not used; generate log tod */
408 vtype_todlf, /* value not used; generate log file datestamp tod */
409 vtype_todzone, /* value not used; generate time zone only */
410 vtype_todzulu, /* value not used; generate zulu tod */
411 vtype_reply, /* value not used; get reply from headers */
412 vtype_pid, /* value not used; result is pid */
413 vtype_host_lookup, /* value not used; get host name */
414 vtype_load_avg, /* value not used; result is int from os_getloadavg */
415 vtype_pspace, /* partition space; value is T/F for spool/log */
416 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
417 vtype_cert /* SSL certificate */
419 ,vtype_dkim /* Lookup of value in DKIM signature */
423 /* Type for main variable table */
431 /* Type for entries pointing to address/length pairs. Not currently
439 static uschar * fn_recipients(void);
441 /* This table must be kept in alphabetical order. */
443 static var_entry var_table[] = {
444 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
445 they will be confused with user-creatable ACL variables. */
446 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
447 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
448 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
449 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
450 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
451 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
452 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
453 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
454 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
455 { "acl_narg", vtype_int, &acl_narg },
456 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
457 { "address_data", vtype_stringptr, &deliver_address_data },
458 { "address_file", vtype_stringptr, &address_file },
459 { "address_pipe", vtype_stringptr, &address_pipe },
460 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
461 { "authenticated_id", vtype_stringptr, &authenticated_id },
462 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
463 { "authentication_failed",vtype_int, &authentication_failed },
464 #ifdef WITH_CONTENT_SCAN
465 { "av_failed", vtype_int, &av_failed },
467 #ifdef EXPERIMENTAL_BRIGHTMAIL
468 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
469 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
470 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
471 { "bmi_deliver", vtype_int, &bmi_deliver },
473 { "body_linecount", vtype_int, &body_linecount },
474 { "body_zerocount", vtype_int, &body_zerocount },
475 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
476 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
477 { "caller_gid", vtype_gid, &real_gid },
478 { "caller_uid", vtype_uid, &real_uid },
479 { "callout_address", vtype_stringptr, &callout_address },
480 { "compile_date", vtype_stringptr, &version_date },
481 { "compile_number", vtype_stringptr, &version_cnumber },
482 { "config_dir", vtype_stringptr, &config_main_directory },
483 { "config_file", vtype_stringptr, &config_main_filename },
484 { "csa_status", vtype_stringptr, &csa_status },
485 #ifdef EXPERIMENTAL_DCC
486 { "dcc_header", vtype_stringptr, &dcc_header },
487 { "dcc_result", vtype_stringptr, &dcc_result },
490 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
491 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
492 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
493 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
494 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
495 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
496 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
497 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
498 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
499 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
500 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
501 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
502 { "dkim_key_length", vtype_int, &dkim_key_length },
503 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
504 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
505 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
506 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
507 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
508 { "dkim_signers", vtype_stringptr, &dkim_signers },
509 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
510 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
512 #ifdef EXPERIMENTAL_DMARC
513 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
514 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
515 { "dmarc_status", vtype_stringptr, &dmarc_status },
516 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
517 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
519 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
520 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
521 { "dnslist_text", vtype_stringptr, &dnslist_text },
522 { "dnslist_value", vtype_stringptr, &dnslist_value },
523 { "domain", vtype_stringptr, &deliver_domain },
524 { "domain_data", vtype_stringptr, &deliver_domain_data },
525 #ifndef DISABLE_EVENT
526 { "event_data", vtype_stringptr, &event_data },
528 /*XXX want to use generic vars for as many of these as possible*/
529 { "event_defer_errno", vtype_int, &event_defer_errno },
531 { "event_name", vtype_stringptr, &event_name },
533 { "exim_gid", vtype_gid, &exim_gid },
534 { "exim_path", vtype_stringptr, &exim_path },
535 { "exim_uid", vtype_uid, &exim_uid },
536 { "exim_version", vtype_stringptr, &version_string },
537 { "headers_added", vtype_string_func, &fn_hdrs_added },
538 { "home", vtype_stringptr, &deliver_home },
539 { "host", vtype_stringptr, &deliver_host },
540 { "host_address", vtype_stringptr, &deliver_host_address },
541 { "host_data", vtype_stringptr, &host_data },
542 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
543 { "host_lookup_failed", vtype_int, &host_lookup_failed },
544 { "host_port", vtype_int, &deliver_host_port },
545 { "initial_cwd", vtype_stringptr, &initial_cwd },
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 { "queue_name", vtype_stringptr, &queue_name },
635 { "rcpt_count", vtype_int, &rcpt_count },
636 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
637 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
638 { "received_count", vtype_int, &received_count },
639 { "received_for", vtype_stringptr, &received_for },
640 { "received_ip_address", vtype_stringptr, &interface_address },
641 { "received_port", vtype_int, &interface_port },
642 { "received_protocol", vtype_stringptr, &received_protocol },
643 { "received_time", vtype_int, &received_time },
644 { "recipient_data", vtype_stringptr, &recipient_data },
645 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
646 { "recipients", vtype_string_func, &fn_recipients },
647 { "recipients_count", vtype_int, &recipients_count },
648 #ifdef WITH_CONTENT_SCAN
649 { "regex_match_string", vtype_stringptr, ®ex_match_string },
651 { "reply_address", vtype_reply, NULL },
652 { "return_path", vtype_stringptr, &return_path },
653 { "return_size_limit", vtype_int, &bounce_return_size_limit },
654 { "router_name", vtype_stringptr, &router_name },
655 { "runrc", vtype_int, &runrc },
656 { "self_hostname", vtype_stringptr, &self_hostname },
657 { "sender_address", vtype_stringptr, &sender_address },
658 { "sender_address_data", vtype_stringptr, &sender_address_data },
659 { "sender_address_domain", vtype_domain, &sender_address },
660 { "sender_address_local_part", vtype_localpart, &sender_address },
661 { "sender_data", vtype_stringptr, &sender_data },
662 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
663 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
664 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
665 { "sender_host_address", vtype_stringptr, &sender_host_address },
666 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
667 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
668 { "sender_host_name", vtype_host_lookup, NULL },
669 { "sender_host_port", vtype_int, &sender_host_port },
670 { "sender_ident", vtype_stringptr, &sender_ident },
671 { "sender_rate", vtype_stringptr, &sender_rate },
672 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
673 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
674 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
675 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
676 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
677 { "sending_port", vtype_int, &sending_port },
678 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
679 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
680 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
681 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
682 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
683 { "sn0", vtype_filter_int, &filter_sn[0] },
684 { "sn1", vtype_filter_int, &filter_sn[1] },
685 { "sn2", vtype_filter_int, &filter_sn[2] },
686 { "sn3", vtype_filter_int, &filter_sn[3] },
687 { "sn4", vtype_filter_int, &filter_sn[4] },
688 { "sn5", vtype_filter_int, &filter_sn[5] },
689 { "sn6", vtype_filter_int, &filter_sn[6] },
690 { "sn7", vtype_filter_int, &filter_sn[7] },
691 { "sn8", vtype_filter_int, &filter_sn[8] },
692 { "sn9", vtype_filter_int, &filter_sn[9] },
693 #ifdef WITH_CONTENT_SCAN
694 { "spam_action", vtype_stringptr, &spam_action },
695 { "spam_bar", vtype_stringptr, &spam_bar },
696 { "spam_report", vtype_stringptr, &spam_report },
697 { "spam_score", vtype_stringptr, &spam_score },
698 { "spam_score_int", vtype_stringptr, &spam_score_int },
700 #ifdef EXPERIMENTAL_SPF
701 { "spf_guess", vtype_stringptr, &spf_guess },
702 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
703 { "spf_received", vtype_stringptr, &spf_received },
704 { "spf_result", vtype_stringptr, &spf_result },
705 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
707 { "spool_directory", vtype_stringptr, &spool_directory },
708 { "spool_inodes", vtype_pinodes, (void *)TRUE },
709 { "spool_space", vtype_pspace, (void *)TRUE },
710 #ifdef EXPERIMENTAL_SRS
711 { "srs_db_address", vtype_stringptr, &srs_db_address },
712 { "srs_db_key", vtype_stringptr, &srs_db_key },
713 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
714 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
715 { "srs_recipient", vtype_stringptr, &srs_recipient },
716 { "srs_status", vtype_stringptr, &srs_status },
718 { "thisaddress", vtype_stringptr, &filter_thisaddress },
720 /* The non-(in,out) variables are now deprecated */
721 { "tls_bits", vtype_int, &tls_in.bits },
722 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
723 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
725 { "tls_in_bits", vtype_int, &tls_in.bits },
726 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
727 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
728 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
729 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
730 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
731 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
732 #if defined(SUPPORT_TLS)
733 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
735 { "tls_out_bits", vtype_int, &tls_out.bits },
736 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
737 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
738 #ifdef EXPERIMENTAL_DANE
739 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
741 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
742 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
743 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
744 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
745 #if defined(SUPPORT_TLS)
746 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
748 #ifdef EXPERIMENTAL_DANE
749 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
752 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
753 #if defined(SUPPORT_TLS)
754 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
757 { "tod_bsdinbox", vtype_todbsdin, NULL },
758 { "tod_epoch", vtype_tode, NULL },
759 { "tod_epoch_l", vtype_todel, NULL },
760 { "tod_full", vtype_todf, NULL },
761 { "tod_log", vtype_todl, NULL },
762 { "tod_logfile", vtype_todlf, NULL },
763 { "tod_zone", vtype_todzone, NULL },
764 { "tod_zulu", vtype_todzulu, NULL },
765 { "transport_name", vtype_stringptr, &transport_name },
766 { "value", vtype_stringptr, &lookup_value },
767 { "verify_mode", vtype_stringptr, &verify_mode },
768 { "version_number", vtype_stringptr, &version_string },
769 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
770 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
771 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
772 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
773 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
774 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
777 static int var_table_size = nelem(var_table);
778 static uschar var_buffer[256];
779 static BOOL malformed_header;
781 /* For textual hashes */
783 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
784 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
787 enum { HMAC_MD5, HMAC_SHA1 };
789 /* For numeric hashes */
791 static unsigned int prime[] = {
792 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
793 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
794 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
796 /* For printing modes in symbolic form */
798 static uschar *mtable_normal[] =
799 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
801 static uschar *mtable_setid[] =
802 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
804 static uschar *mtable_sticky[] =
805 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
809 /*************************************************
810 * Tables for UTF-8 support *
811 *************************************************/
813 /* Table of the number of extra characters, indexed by the first character
814 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
817 static uschar utf8_table1[] = {
818 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
819 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
820 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
821 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
823 /* These are the masks for the data bits in the first byte of a character,
824 indexed by the number of additional bytes. */
826 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
828 /* Get the next UTF-8 character, advancing the pointer. */
830 #define GETUTF8INC(c, ptr) \
832 if ((c & 0xc0) == 0xc0) \
834 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
836 c = (c & utf8_table2[a]) << s; \
840 c |= (*ptr++ & 0x3f) << s; \
846 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
848 /*************************************************
849 * Binary chop search on a table *
850 *************************************************/
852 /* This is used for matching expansion items and operators.
855 name the name that is being sought
856 table the table to search
857 table_size the number of items in the table
859 Returns: the offset in the table, or -1
863 chop_match(uschar *name, uschar **table, int table_size)
865 uschar **bot = table;
866 uschar **top = table + table_size;
870 uschar **mid = bot + (top - bot)/2;
871 int c = Ustrcmp(name, *mid);
872 if (c == 0) return mid - table;
873 if (c > 0) bot = mid + 1; else top = mid;
881 /*************************************************
882 * Check a condition string *
883 *************************************************/
885 /* This function is called to expand a string, and test the result for a "true"
886 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
887 forced fail or lookup defer.
889 We used to release all store used, but this is not not safe due
890 to ${dlfunc } and ${acl }. In any case expand_string_internal()
891 is reasonably careful to release what it can.
893 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
896 condition the condition string
897 m1 text to be incorporated in panic error
900 Returns: TRUE if condition is met, FALSE if not
904 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
907 uschar *ss = expand_string(condition);
910 if (!expand_string_forcedfail && !search_find_defer)
911 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
912 "for %s %s: %s", condition, m1, m2, expand_string_message);
915 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
916 strcmpic(ss, US"false") != 0;
923 /*************************************************
924 * Pseudo-random number generation *
925 *************************************************/
927 /* Pseudo-random number generation. The result is not "expected" to be
928 cryptographically strong but not so weak that someone will shoot themselves
929 in the foot using it as a nonce in some email header scheme or whatever
930 weirdness they'll twist this into. The result should ideally handle fork().
932 However, if we're stuck unable to provide this, then we'll fall back to
933 appallingly bad randomness.
935 If SUPPORT_TLS is defined then this will not be used except as an emergency
940 Returns a random number in range [0, max-1]
944 # define vaguely_random_number vaguely_random_number_fallback
947 vaguely_random_number(int max)
950 # undef vaguely_random_number
952 static pid_t pid = 0;
954 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
964 #ifdef HAVE_ARC4RANDOM
965 /* cryptographically strong randomness, common on *BSD platforms, not
966 so much elsewhere. Alas. */
967 #ifndef NOT_HAVE_ARC4RANDOM_STIR
970 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
971 #ifdef HAVE_SRANDOMDEV
972 /* uses random(4) for seeding */
975 gettimeofday(&tv, NULL);
976 srandom(tv.tv_sec | tv.tv_usec | getpid());
979 /* Poor randomness and no seeding here */
986 #ifdef HAVE_ARC4RANDOM
987 return arc4random() % max;
988 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
989 return random() % max;
991 /* This one returns a 16-bit number, definitely not crypto-strong */
992 return random_number(max);
999 /*************************************************
1000 * Pick out a name from a string *
1001 *************************************************/
1003 /* If the name is too long, it is silently truncated.
1006 name points to a buffer into which to put the name
1007 max is the length of the buffer
1008 s points to the first alphabetic character of the name
1009 extras chars other than alphanumerics to permit
1011 Returns: pointer to the first character after the name
1013 Note: The test for *s != 0 in the while loop is necessary because
1014 Ustrchr() yields non-NULL if the character is zero (which is not something
1017 static const uschar *
1018 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1021 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1023 if (ptr < max-1) name[ptr++] = *s;
1032 /*************************************************
1033 * Pick out the rest of a header name *
1034 *************************************************/
1036 /* A variable name starting $header_ (or just $h_ for those who like
1037 abbreviations) might not be the complete header name because headers can
1038 contain any printing characters in their names, except ':'. This function is
1039 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1040 on the end, if the name was terminated by white space.
1043 name points to a buffer in which the name read so far exists
1044 max is the length of the buffer
1045 s points to the first character after the name so far, i.e. the
1046 first non-alphameric character after $header_xxxxx
1048 Returns: a pointer to the first character after the header name
1051 static const uschar *
1052 read_header_name(uschar *name, int max, const uschar *s)
1054 int prelen = Ustrchr(name, '_') - name + 1;
1055 int ptr = Ustrlen(name) - prelen;
1056 if (ptr > 0) memmove(name, name+prelen, ptr);
1057 while (mac_isgraph(*s) && *s != ':')
1059 if (ptr < max-1) name[ptr++] = *s;
1070 /*************************************************
1071 * Pick out a number from a string *
1072 *************************************************/
1075 n points to an integer into which to put the number
1076 s points to the first digit of the number
1078 Returns: a pointer to the character after the last digit
1080 /*XXX consider expanding to int_eximarith_t. But the test for
1081 "overbig numbers" in 0002 still needs to overflow it. */
1084 read_number(int *n, uschar *s)
1087 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1091 static const uschar *
1092 read_cnumber(int *n, const uschar *s)
1095 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1101 /*************************************************
1102 * Extract keyed subfield from a string *
1103 *************************************************/
1105 /* The yield is in dynamic store; NULL means that the key was not found.
1108 key points to the name of the key
1109 s points to the string from which to extract the subfield
1111 Returns: NULL if the subfield was not found, or
1112 a pointer to the subfield's data
1116 expand_getkeyed(uschar *key, const uschar *s)
1118 int length = Ustrlen(key);
1119 while (isspace(*s)) s++;
1121 /* Loop to search for the key */
1127 const uschar *dkey = s;
1129 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1130 dkeylength = s - dkey;
1131 while (isspace(*s)) s++;
1132 if (*s == '=') while (isspace((*(++s))));
1134 data = string_dequote(&s);
1135 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1138 while (isspace(*s)) s++;
1147 find_var_ent(uschar * name)
1150 int last = var_table_size;
1152 while (last > first)
1154 int middle = (first + last)/2;
1155 int c = Ustrcmp(name, var_table[middle].name);
1157 if (c > 0) { first = middle + 1; continue; }
1158 if (c < 0) { last = middle; continue; }
1159 return &var_table[middle];
1164 /*************************************************
1165 * Extract numbered subfield from string *
1166 *************************************************/
1168 /* Extracts a numbered field from a string that is divided by tokens - for
1169 example a line from /etc/passwd is divided by colon characters. First field is
1170 numbered one. Negative arguments count from the right. Zero returns the whole
1171 string. Returns NULL if there are insufficient tokens in the string
1174 Modifies final argument - this is a dynamically generated string, so that's OK.
1177 field number of field to be extracted,
1178 first field = 1, whole string = 0, last field = -1
1179 separators characters that are used to break string into tokens
1180 s points to the string from which to extract the subfield
1182 Returns: NULL if the field was not found,
1183 a pointer to the field's data inside s (modified to add 0)
1187 expand_gettokened (int field, uschar *separators, uschar *s)
1192 uschar *fieldtext = NULL;
1194 if (field == 0) return s;
1196 /* Break the line up into fields in place; for field > 0 we stop when we have
1197 done the number of fields we want. For field < 0 we continue till the end of
1198 the string, counting the number of fields. */
1200 count = (field > 0)? field : INT_MAX;
1206 /* Previous field was the last one in the string. For a positive field
1207 number, this means there are not enough fields. For a negative field number,
1208 check that there are enough, and scan back to find the one that is wanted. */
1212 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1213 if ((-field) == (INT_MAX - count - 1)) return s;
1217 while (ss[-1] != 0) ss--;
1223 /* Previous field was not last in the string; save its start and put a
1227 len = Ustrcspn(ss, separators);
1238 expand_getlistele(int field, const uschar * list)
1240 const uschar * tlist= list;
1246 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1249 if(field==0) return NULL;
1250 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1251 return string_nextinlist(&list, &sep, NULL, 0);
1255 /* Certificate fields, by name. Worry about by-OID later */
1256 /* Names are chosen to not have common prefixes */
1263 uschar * (*getfn)(void * cert, uschar * mod);
1265 static certfield certfields[] =
1266 { /* linear search; no special order */
1267 { US"version", 7, &tls_cert_version },
1268 { US"serial_number", 13, &tls_cert_serial_number },
1269 { US"subject", 7, &tls_cert_subject },
1270 { US"notbefore", 9, &tls_cert_not_before },
1271 { US"notafter", 8, &tls_cert_not_after },
1272 { US"issuer", 6, &tls_cert_issuer },
1273 { US"signature", 9, &tls_cert_signature },
1274 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1275 { US"subj_altname", 12, &tls_cert_subject_altname },
1276 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1277 { US"crl_uri", 7, &tls_cert_crl_uri },
1281 expand_getcertele(uschar * field, uschar * certvar)
1286 if (!(vp = find_var_ent(certvar)))
1288 expand_string_message =
1289 string_sprintf("no variable named \"%s\"", certvar);
1290 return NULL; /* Unknown variable name */
1292 /* NB this stops us passing certs around in variable. Might
1293 want to do that in future */
1294 if (vp->type != vtype_cert)
1296 expand_string_message =
1297 string_sprintf("\"%s\" is not a certificate", certvar);
1298 return NULL; /* Unknown variable name */
1300 if (!*(void **)vp->value)
1303 if (*field >= '0' && *field <= '9')
1304 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1306 for(cp = certfields;
1307 cp < certfields + nelem(certfields);
1309 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1311 uschar * modifier = *(field += cp->namelen) == ','
1313 return (*cp->getfn)( *(void **)vp->value, modifier );
1316 expand_string_message =
1317 string_sprintf("bad field selector \"%s\" for certextract", field);
1320 #endif /*SUPPORT_TLS*/
1322 /*************************************************
1323 * Extract a substring from a string *
1324 *************************************************/
1326 /* Perform the ${substr or ${length expansion operations.
1329 subject the input string
1330 value1 the offset from the start of the input string to the start of
1331 the output string; if negative, count from the right.
1332 value2 the length of the output string, or negative (-1) for unset
1333 if value1 is positive, unset means "all after"
1334 if value1 is negative, unset means "all before"
1335 len set to the length of the returned string
1337 Returns: pointer to the output string, or NULL if there is an error
1341 extract_substr(uschar *subject, int value1, int value2, int *len)
1343 int sublen = Ustrlen(subject);
1345 if (value1 < 0) /* count from right */
1349 /* If the position is before the start, skip to the start, and adjust the
1350 length. If the length ends up negative, the substring is null because nothing
1351 can precede. This falls out naturally when the length is unset, meaning "all
1357 if (value2 < 0) value2 = 0;
1361 /* Otherwise an unset length => characters before value1 */
1363 else if (value2 < 0)
1370 /* For a non-negative offset, if the starting position is past the end of the
1371 string, the result will be the null string. Otherwise, an unset length means
1372 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1376 if (value1 > sublen)
1381 else if (value2 < 0) value2 = sublen;
1384 /* Cut the length down to the maximum possible for the offset value, and get
1385 the required characters. */
1387 if (value1 + value2 > sublen) value2 = sublen - value1;
1389 return subject + value1;
1395 /*************************************************
1396 * Old-style hash of a string *
1397 *************************************************/
1399 /* Perform the ${hash expansion operation.
1402 subject the input string (an expanded substring)
1403 value1 the length of the output string; if greater or equal to the
1404 length of the input string, the input string is returned
1405 value2 the number of hash characters to use, or 26 if negative
1406 len set to the length of the returned string
1408 Returns: pointer to the output string, or NULL if there is an error
1412 compute_hash(uschar *subject, int value1, int value2, int *len)
1414 int sublen = Ustrlen(subject);
1416 if (value2 < 0) value2 = 26;
1417 else if (value2 > Ustrlen(hashcodes))
1419 expand_string_message =
1420 string_sprintf("hash count \"%d\" too big", value2);
1424 /* Calculate the hash text. We know it is shorter than the original string, so
1425 can safely place it in subject[] (we know that subject is always itself an
1426 expanded substring). */
1428 if (value1 < sublen)
1433 while ((c = (subject[j])) != 0)
1435 int shift = (c + j++) & 7;
1436 subject[i] ^= (c << shift) | (c >> (8-shift));
1437 if (++i >= value1) i = 0;
1439 for (i = 0; i < value1; i++)
1440 subject[i] = hashcodes[(subject[i]) % value2];
1442 else value1 = sublen;
1451 /*************************************************
1452 * Numeric hash of a string *
1453 *************************************************/
1455 /* Perform the ${nhash expansion operation. The first characters of the
1456 string are treated as most important, and get the highest prime numbers.
1459 subject the input string
1460 value1 the maximum value of the first part of the result
1461 value2 the maximum value of the second part of the result,
1462 or negative to produce only a one-part result
1463 len set to the length of the returned string
1465 Returns: pointer to the output string, or NULL if there is an error.
1469 compute_nhash (uschar *subject, int value1, int value2, int *len)
1471 uschar *s = subject;
1473 unsigned long int total = 0; /* no overflow */
1477 if (i == 0) i = nelem(prime) - 1;
1478 total += prime[i--] * (unsigned int)(*s++);
1481 /* If value2 is unset, just compute one number */
1485 s = string_sprintf("%d", total % value1);
1488 /* Otherwise do a div/mod hash */
1492 total = total % (value1 * value2);
1493 s = string_sprintf("%d/%d", total/value2, total % value2);
1504 /*************************************************
1505 * Find the value of a header or headers *
1506 *************************************************/
1508 /* Multiple instances of the same header get concatenated, and this function
1509 can also return a concatenation of all the header lines. When concatenating
1510 specific headers that contain lists of addresses, a comma is inserted between
1511 them. Otherwise we use a straight concatenation. Because some messages can have
1512 pathologically large number of lines, there is a limit on the length that is
1513 returned. Also, to avoid massive store use which would result from using
1514 string_cat() as it copies and extends strings, we do a preliminary pass to find
1515 out exactly how much store will be needed. On "normal" messages this will be
1519 name the name of the header, without the leading $header_ or $h_,
1520 or NULL if a concatenation of all headers is required
1521 exists_only TRUE if called from a def: test; don't need to build a string;
1522 just return a string that is not "" and not "0" if the header
1524 newsize return the size of memory block that was obtained; may be NULL
1525 if exists_only is TRUE
1526 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1527 other than concatenating, will be done on the header. Also used
1528 for $message_headers_raw.
1529 charset name of charset to translate MIME words to; used only if
1530 want_raw is false; if NULL, no translation is done (this is
1531 used for $bh_ and $bheader_)
1533 Returns: NULL if the header does not exist, else a pointer to a new
1538 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1541 BOOL found = name == NULL;
1543 int len = found? 0 : Ustrlen(name);
1545 uschar *yield = NULL;
1548 /* Loop for two passes - saves code repetition */
1550 for (i = 0; i < 2; i++)
1555 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1557 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1559 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1564 if (exists_only) return US"1"; /* don't need actual string */
1566 t = h->text + len; /* text to insert */
1567 if (!want_raw) /* unless wanted raw, */
1568 while (isspace(*t)) t++; /* remove leading white space */
1569 ilen = h->slen - (t - h->text); /* length to insert */
1571 /* Unless wanted raw, remove trailing whitespace, including the
1575 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1577 /* Set comma = 1 if handling a single header and it's one of those
1578 that contains an address list, except when asked for raw headers. Only
1579 need to do this once. */
1581 if (!want_raw && name != NULL && comma == 0 &&
1582 Ustrchr("BCFRST", h->type) != NULL)
1585 /* First pass - compute total store needed; second pass - compute
1586 total store used, including this header. */
1588 size += ilen + comma + 1; /* +1 for the newline */
1590 /* Second pass - concatentate the data, up to a maximum. Note that
1591 the loop stops when size hits the limit. */
1595 if (size > header_insert_maxlen)
1597 ilen -= size - header_insert_maxlen - 1;
1600 Ustrncpy(ptr, t, ilen);
1603 /* For a non-raw header, put in the comma if needed, then add
1604 back the newline we removed above, provided there was some text in
1607 if (!want_raw && ilen > 0)
1609 if (comma != 0) *ptr++ = ',';
1617 /* At end of first pass, return NULL if no header found. Then truncate size
1618 if necessary, and get the buffer to hold the data, returning the buffer size.
1623 if (!found) return NULL;
1624 if (size > header_insert_maxlen) size = header_insert_maxlen;
1625 *newsize = size + 1;
1626 ptr = yield = store_get(*newsize);
1630 /* That's all we do for raw header expansion. */
1637 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1638 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1639 function can return an error with decoded data if the charset translation
1640 fails. If decoding fails, it returns NULL. */
1644 uschar *decoded, *error;
1645 if (ptr > yield && ptr[-1] == '\n') ptr--;
1646 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1648 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1652 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1653 " input was: %s\n", error, yield);
1655 if (decoded != NULL) yield = decoded;
1664 /*************************************************
1665 * Return list of recipients *
1666 *************************************************/
1667 /* A recipients list is available only during system message filtering,
1668 during ACL processing after DATA, and while expanding pipe commands
1669 generated from a system filter, but not elsewhere. */
1674 if (!enable_dollar_recipients) return NULL; else
1679 uschar * s = store_get(size);
1680 for (i = 0; i < recipients_count; i++)
1682 if (i != 0) s = string_catn(s, &size, &ptr, US", ", 2);
1683 s = string_cat(s, &size, &ptr, recipients_list[i].address);
1685 s[ptr] = 0; /* string_cat() leaves room */
1691 /*************************************************
1692 * Find value of a variable *
1693 *************************************************/
1695 /* The table of variables is kept in alphabetic order, so we can search it
1696 using a binary chop. The "choplen" variable is nothing to do with the binary
1700 name the name of the variable being sought
1701 exists_only TRUE if this is a def: test; passed on to find_header()
1702 skipping TRUE => skip any processing evaluation; this is not the same as
1703 exists_only because def: may test for values that are first
1705 newsize pointer to an int which is initially zero; if the answer is in
1706 a new memory buffer, *newsize is set to its size
1708 Returns: NULL if the variable does not exist, or
1709 a pointer to the variable's contents, or
1710 something non-NULL if exists_only is TRUE
1714 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1721 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1722 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1723 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1724 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1725 (this gave backwards compatibility at the changeover). There may be built-in
1726 variables whose names start acl_ but they should never start in this way. This
1727 slightly messy specification is a consequence of the history, needless to say.
1729 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1730 set, in which case give an error. */
1732 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1736 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1737 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1740 /* Handle $auth<n> variables. */
1742 if (Ustrncmp(name, "auth", 4) == 0)
1745 int n = Ustrtoul(name + 4, &endptr, 10);
1746 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1747 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1749 else if (Ustrncmp(name, "regex", 5) == 0)
1752 int n = Ustrtoul(name + 5, &endptr, 10);
1753 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1754 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1757 /* For all other variables, search the table */
1759 if (!(vp = find_var_ent(name)))
1760 return NULL; /* Unknown variable name */
1762 /* Found an existing variable. If in skipping state, the value isn't needed,
1763 and we want to avoid processing (such as looking up the host name). */
1771 case vtype_filter_int:
1772 if (!filter_running) return NULL;
1776 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1780 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1784 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1788 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1792 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1795 case vtype_stringptr: /* Pointer to string */
1796 return (s = *((uschar **)(val))) ? s : US"";
1799 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1802 case vtype_load_avg:
1803 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1806 case vtype_host_lookup: /* Lookup if not done so */
1807 if (sender_host_name == NULL && sender_host_address != NULL &&
1808 !host_lookup_failed && host_name_lookup() == OK)
1809 host_build_sender_fullhost();
1810 return (sender_host_name == NULL)? US"" : sender_host_name;
1812 case vtype_localpart: /* Get local part from address */
1813 s = *((uschar **)(val));
1814 if (s == NULL) return US"";
1815 domain = Ustrrchr(s, '@');
1816 if (domain == NULL) return s;
1817 if (domain - s > sizeof(var_buffer) - 1)
1818 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1819 " in string expansion", sizeof(var_buffer));
1820 Ustrncpy(var_buffer, s, domain - s);
1821 var_buffer[domain - s] = 0;
1824 case vtype_domain: /* Get domain from address */
1825 s = *((uschar **)(val));
1826 if (s == NULL) return US"";
1827 domain = Ustrrchr(s, '@');
1828 return (domain == NULL)? US"" : domain + 1;
1830 case vtype_msgheaders:
1831 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1833 case vtype_msgheaders_raw:
1834 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1836 case vtype_msgbody: /* Pointer to msgbody string */
1837 case vtype_msgbody_end: /* Ditto, the end of the msg */
1838 ss = (uschar **)(val);
1839 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1842 off_t start_offset = SPOOL_DATA_START_OFFSET;
1843 int len = message_body_visible;
1844 if (len > message_size) len = message_size;
1845 *ss = body = store_malloc(len+1);
1847 if (vp->type == vtype_msgbody_end)
1849 struct stat statbuf;
1850 if (fstat(deliver_datafile, &statbuf) == 0)
1852 start_offset = statbuf.st_size - len;
1853 if (start_offset < SPOOL_DATA_START_OFFSET)
1854 start_offset = SPOOL_DATA_START_OFFSET;
1857 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1858 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1860 len = read(deliver_datafile, body, len);
1864 if (message_body_newlines) /* Separate loops for efficiency */
1866 { if (body[--len] == 0) body[len] = ' '; }
1869 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1872 return (*ss == NULL)? US"" : *ss;
1874 case vtype_todbsdin: /* BSD inbox time of day */
1875 return tod_stamp(tod_bsdin);
1877 case vtype_tode: /* Unix epoch time of day */
1878 return tod_stamp(tod_epoch);
1880 case vtype_todel: /* Unix epoch/usec time of day */
1881 return tod_stamp(tod_epoch_l);
1883 case vtype_todf: /* Full time of day */
1884 return tod_stamp(tod_full);
1886 case vtype_todl: /* Log format time of day */
1887 return tod_stamp(tod_log_bare); /* (without timezone) */
1889 case vtype_todzone: /* Time zone offset only */
1890 return tod_stamp(tod_zone);
1892 case vtype_todzulu: /* Zulu time */
1893 return tod_stamp(tod_zulu);
1895 case vtype_todlf: /* Log file datestamp tod */
1896 return tod_stamp(tod_log_datestamp_daily);
1898 case vtype_reply: /* Get reply address */
1899 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1901 if (s != NULL) while (isspace(*s)) s++;
1902 if (s == NULL || *s == 0)
1904 *newsize = 0; /* For the *s==0 case */
1905 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1910 while (isspace(*s)) s++;
1911 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1912 while (t > s && isspace(t[-1])) t--;
1915 return (s == NULL)? US"" : s;
1917 case vtype_string_func:
1919 uschar * (*fn)() = val;
1926 sprintf(CS var_buffer, "%d",
1927 receive_statvfs(val == (void *)TRUE, &inodes));
1934 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1935 sprintf(CS var_buffer, "%d", inodes);
1940 return *(void **)val ? US"<cert>" : US"";
1942 #ifndef DISABLE_DKIM
1944 return dkim_exim_expand_query((int)(long)val);
1949 return NULL; /* Unknown variable. Silences static checkers. */
1956 modify_variable(uschar *name, void * value)
1959 if ((vp = find_var_ent(name))) vp->value = value;
1960 return; /* Unknown variable name, fail silently */
1967 /*************************************************
1968 * Read and expand substrings *
1969 *************************************************/
1971 /* This function is called to read and expand argument substrings for various
1972 expansion items. Some have a minimum requirement that is less than the maximum;
1973 in these cases, the first non-present one is set to NULL.
1976 sub points to vector of pointers to set
1977 n maximum number of substrings
1979 sptr points to current string pointer
1980 skipping the skipping flag
1981 check_end if TRUE, check for final '}'
1982 name name of item, for error message
1983 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1986 Returns: 0 OK; string pointer updated
1987 1 curly bracketing error (too few arguments)
1988 2 too many arguments (only if check_end is set); message set
1989 3 other error (expansion failure)
1993 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1994 BOOL check_end, uschar *name, BOOL *resetok)
1997 const uschar *s = *sptr;
1999 while (isspace(*s)) s++;
2000 for (i = 0; i < n; i++)
2006 expand_string_message = string_sprintf("Not enough arguments for '%s' "
2007 "(min is %d)", name, m);
2013 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2015 if (*s++ != '}') return 1;
2016 while (isspace(*s)) s++;
2018 if (check_end && *s++ != '}')
2022 expand_string_message = string_sprintf("Too many arguments for '%s' "
2023 "(max is %d)", name, n);
2026 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2037 /*************************************************
2038 * Elaborate message for bad variable *
2039 *************************************************/
2041 /* For the "unknown variable" message, take a look at the variable's name, and
2042 give additional information about possible ACL variables. The extra information
2043 is added on to expand_string_message.
2045 Argument: the name of the variable
2050 check_variable_error_message(uschar *name)
2052 if (Ustrncmp(name, "acl_", 4) == 0)
2053 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2054 (name[4] == 'c' || name[4] == 'm')?
2056 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2057 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2059 US"user-defined ACL variables must start acl_c or acl_m");
2065 Load args from sub array to globals, and call acl_check().
2066 Sub array will be corrupted on return.
2068 Returns: OK access is granted by an ACCEPT verb
2069 DISCARD access is (apparently) granted by a DISCARD verb
2070 FAIL access is denied
2071 FAIL_DROP access is denied; drop the connection
2072 DEFER can't tell at the moment
2076 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2079 int sav_narg = acl_narg;
2081 uschar * dummy_logmsg;
2082 extern int acl_where;
2084 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2085 for (i = 0; i < nsub && sub[i+1]; i++)
2087 uschar * tmp = acl_arg[i];
2088 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2089 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2094 sub[i+1] = acl_arg[i];
2095 acl_arg[i++] = NULL;
2099 debug_printf("expanding: acl: %s arg: %s%s\n",
2101 acl_narg>0 ? acl_arg[0] : US"<none>",
2102 acl_narg>1 ? " +more" : "");
2104 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2106 for (i = 0; i < nsub; i++)
2107 acl_arg[i] = sub[i+1]; /* restore old args */
2108 acl_narg = sav_narg;
2116 /*************************************************
2117 * Read and evaluate a condition *
2118 *************************************************/
2122 s points to the start of the condition text
2123 resetok points to a BOOL which is written false if it is unsafe to
2124 free memory. Certain condition types (acl) may have side-effect
2125 allocation which must be preserved.
2126 yield points to a BOOL to hold the result of the condition test;
2127 if NULL, we are just reading through a condition that is
2128 part of an "or" combination to check syntax, or in a state
2129 where the answer isn't required
2131 Returns: a pointer to the first character after the condition, or
2135 static const uschar *
2136 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2138 BOOL testfor = TRUE;
2139 BOOL tempcond, combined_cond;
2141 BOOL sub2_honour_dollar = TRUE;
2142 int i, rc, cond_type, roffset;
2143 int_eximarith_t num[2];
2144 struct stat statbuf;
2146 const uschar *sub[10];
2149 const uschar *rerror;
2153 while (isspace(*s)) s++;
2154 if (*s == '!') { testfor = !testfor; s++; } else break;
2157 /* Numeric comparisons are symbolic */
2159 if (*s == '=' || *s == '>' || *s == '<')
2171 /* All other conditions are named */
2173 else s = read_name(name, 256, s, US"_");
2175 /* If we haven't read a name, it means some non-alpha character is first. */
2179 expand_string_message = string_sprintf("condition name expected, "
2180 "but found \"%.16s\"", s);
2184 /* Find which condition we are dealing with, and switch on it */
2186 cond_type = chop_match(name, cond_table, nelem(cond_table));
2189 /* def: tests for a non-empty variable, or for the existence of a header. If
2190 yield == NULL we are in a skipping state, and don't care about the answer. */
2195 expand_string_message = US"\":\" expected after \"def\"";
2199 s = read_name(name, 256, s+1, US"_");
2201 /* Test for a header's existence. If the name contains a closing brace
2202 character, this may be a user error where the terminating colon has been
2203 omitted. Set a flag to adjust a subsequent error message in this case. */
2205 if (Ustrncmp(name, "h_", 2) == 0 ||
2206 Ustrncmp(name, "rh_", 3) == 0 ||
2207 Ustrncmp(name, "bh_", 3) == 0 ||
2208 Ustrncmp(name, "header_", 7) == 0 ||
2209 Ustrncmp(name, "rheader_", 8) == 0 ||
2210 Ustrncmp(name, "bheader_", 8) == 0)
2212 s = read_header_name(name, 256, s);
2213 /* {-for-text-editors */
2214 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2215 if (yield != NULL) *yield =
2216 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2219 /* Test for a variable's having a non-empty value. A non-existent variable
2220 causes an expansion failure. */
2224 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2227 expand_string_message = (name[0] == 0)?
2228 string_sprintf("variable name omitted after \"def:\"") :
2229 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2230 check_variable_error_message(name);
2233 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2239 /* first_delivery tests for first delivery attempt */
2241 case ECOND_FIRST_DELIVERY:
2242 if (yield != NULL) *yield = deliver_firsttime == testfor;
2246 /* queue_running tests for any process started by a queue runner */
2248 case ECOND_QUEUE_RUNNING:
2249 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2253 /* exists: tests for file existence
2254 isip: tests for any IP address
2255 isip4: tests for an IPv4 address
2256 isip6: tests for an IPv6 address
2257 pam: does PAM authentication
2258 radius: does RADIUS authentication
2259 ldapauth: does LDAP authentication
2260 pwcheck: does Cyrus SASL pwcheck authentication
2269 case ECOND_LDAPAUTH:
2272 while (isspace(*s)) s++;
2273 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2275 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2276 if (sub[0] == NULL) return NULL;
2277 /* {-for-text-editors */
2278 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2280 if (yield == NULL) return s; /* No need to run the test if skipping */
2285 if ((expand_forbid & RDO_EXISTS) != 0)
2287 expand_string_message = US"File existence tests are not permitted";
2290 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2296 rc = string_is_ip_address(sub[0], NULL);
2297 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2298 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2301 /* Various authentication tests - all optionally compiled */
2305 rc = auth_call_pam(sub[0], &expand_string_message);
2308 goto COND_FAILED_NOT_COMPILED;
2309 #endif /* SUPPORT_PAM */
2312 #ifdef RADIUS_CONFIG_FILE
2313 rc = auth_call_radius(sub[0], &expand_string_message);
2316 goto COND_FAILED_NOT_COMPILED;
2317 #endif /* RADIUS_CONFIG_FILE */
2319 case ECOND_LDAPAUTH:
2322 /* Just to keep the interface the same */
2324 int old_pool = store_pool;
2325 store_pool = POOL_SEARCH;
2326 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2327 &expand_string_message, &do_cache);
2328 store_pool = old_pool;
2332 goto COND_FAILED_NOT_COMPILED;
2333 #endif /* LOOKUP_LDAP */
2336 #ifdef CYRUS_PWCHECK_SOCKET
2337 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2340 goto COND_FAILED_NOT_COMPILED;
2341 #endif /* CYRUS_PWCHECK_SOCKET */
2343 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2344 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2346 if (rc == ERROR || rc == DEFER) return NULL;
2347 *yield = (rc == OK) == testfor;
2353 /* call ACL (in a conditional context). Accept true, deny false.
2354 Defer is a forced-fail. Anything set by message= goes to $value.
2355 Up to ten parameters are used; we use the braces round the name+args
2356 like the saslauthd condition does, to permit a variable number of args.
2357 See also the expansion-item version EITEM_ACL and the traditional
2358 acl modifier ACLC_ACL.
2359 Since the ACL may allocate new global variables, tell our caller to not
2364 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2372 while (isspace(*s)) s++;
2373 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2375 switch(read_subs(sub, nelem(sub), 1,
2376 &s, yield == NULL, TRUE, US"acl", resetok))
2378 case 1: expand_string_message = US"too few arguments or bracketing "
2381 case 3: return NULL;
2384 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2385 if (yield != NULL) switch(eval_acl(sub, nelem(sub), &user_msg))
2390 lookup_value = NULL;
2393 lookup_value = string_cat(NULL, &size, &ptr, user_msg);
2394 lookup_value[ptr] = '\0';
2396 *yield = cond == testfor;
2400 expand_string_forcedfail = TRUE;
2403 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2410 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2412 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2414 However, the last two are optional. That is why the whole set is enclosed
2415 in their own set of braces. */
2417 case ECOND_SASLAUTHD:
2418 #ifndef CYRUS_SASLAUTHD_SOCKET
2419 goto COND_FAILED_NOT_COMPILED;
2423 while (isspace(*s)) s++;
2424 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2425 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2428 case 1: expand_string_message = US"too few arguments or bracketing "
2429 "error for saslauthd";
2431 case 3: return NULL;
2433 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2436 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2437 &expand_string_message);
2438 if (rc == ERROR || rc == DEFER) return NULL;
2439 *yield = (rc == OK) == testfor;
2443 #endif /* CYRUS_SASLAUTHD_SOCKET */
2446 /* symbolic operators for numeric and string comparison, and a number of
2447 other operators, all requiring two arguments.
2449 crypteq: encrypts plaintext and compares against an encrypted text,
2450 using crypt(), crypt16(), MD5 or SHA-1
2451 inlist/inlisti: checks if first argument is in the list of the second
2452 match: does a regular expression match and sets up the numerical
2453 variables if it succeeds
2454 match_address: matches in an address list
2455 match_domain: matches in a domain list
2456 match_ip: matches a host list that is restricted to IP addresses
2457 match_local_part: matches in a local part list
2460 case ECOND_MATCH_ADDRESS:
2461 case ECOND_MATCH_DOMAIN:
2462 case ECOND_MATCH_IP:
2463 case ECOND_MATCH_LOCAL_PART:
2464 #ifndef EXPAND_LISTMATCH_RHS
2465 sub2_honour_dollar = FALSE;
2474 case ECOND_NUM_L: /* Numerical comparisons */
2481 case ECOND_STR_LT: /* String comparisons */
2492 for (i = 0; i < 2; i++)
2494 /* Sometimes, we don't expand substrings; too many insecure configurations
2495 created using match_address{}{} and friends, where the second param
2496 includes information from untrustworthy sources. */
2497 BOOL honour_dollar = TRUE;
2498 if ((i > 0) && !sub2_honour_dollar)
2499 honour_dollar = FALSE;
2501 while (isspace(*s)) s++;
2504 if (i == 0) goto COND_FAILED_CURLY_START;
2505 expand_string_message = string_sprintf("missing 2nd string in {} "
2506 "after \"%s\"", name);
2509 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2510 honour_dollar, resetok);
2511 if (sub[i] == NULL) return NULL;
2512 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2514 /* Convert to numerical if required; we know that the names of all the
2515 conditions that compare numbers do not start with a letter. This just saves
2516 checking for them individually. */
2518 if (!isalpha(name[0]) && yield != NULL)
2523 debug_printf("empty string cast to zero for numerical comparison\n");
2527 num[i] = expanded_string_integer(sub[i], FALSE);
2528 if (expand_string_message != NULL) return NULL;
2532 /* Result not required */
2534 if (yield == NULL) return s;
2536 /* Do an appropriate comparison */
2542 tempcond = (num[0] == num[1]);
2546 tempcond = (num[0] > num[1]);
2550 tempcond = (num[0] >= num[1]);
2554 tempcond = (num[0] < num[1]);
2558 tempcond = (num[0] <= num[1]);
2562 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2566 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2570 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2574 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2578 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2582 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2586 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2590 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2594 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2598 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2601 case ECOND_MATCH: /* Regular expression match */
2602 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2606 expand_string_message = string_sprintf("regular expression error in "
2607 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2610 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2613 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2614 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2615 goto MATCHED_SOMETHING;
2617 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2618 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2619 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2620 goto MATCHED_SOMETHING;
2622 case ECOND_MATCH_IP: /* Match IP address in a host list */
2623 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2625 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2631 unsigned int *nullcache = NULL;
2632 check_host_block cb;
2634 cb.host_name = US"";
2635 cb.host_address = sub[0];
2637 /* If the host address starts off ::ffff: it is an IPv6 address in
2638 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2641 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2642 cb.host_address + 7 : cb.host_address;
2644 rc = match_check_list(
2645 &sub[1], /* the list */
2646 0, /* separator character */
2647 &hostlist_anchor, /* anchor pointer */
2648 &nullcache, /* cache pointer */
2649 check_host, /* function for testing */
2650 &cb, /* argument for function */
2651 MCL_HOST, /* type of check */
2652 sub[0], /* text for debugging */
2653 NULL); /* where to pass back data */
2655 goto MATCHED_SOMETHING;
2657 case ECOND_MATCH_LOCAL_PART:
2658 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2659 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2674 expand_string_message = string_sprintf("unable to complete match "
2675 "against \"%s\": %s", sub[1], search_error_message);
2681 /* Various "encrypted" comparisons. If the second string starts with
2682 "{" then an encryption type is given. Default to crypt() or crypt16()
2683 (build-time choice). */
2684 /* }-for-text-editors */
2687 #ifndef SUPPORT_CRYPTEQ
2688 goto COND_FAILED_NOT_COMPILED;
2690 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2692 int sublen = Ustrlen(sub[1]+5);
2697 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2699 /* If the length that we are comparing against is 24, the MD5 digest
2700 is expressed as a base64 string. This is the way LDAP does it. However,
2701 some other software uses a straightforward hex representation. We assume
2702 this if the length is 32. Other lengths fail. */
2706 uschar *coded = b64encode(digest, 16);
2707 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2708 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2709 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2711 else if (sublen == 32)
2715 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2717 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2718 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2719 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2723 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2724 "fail\n crypted=%s\n", sub[1]+5);
2729 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2731 int sublen = Ustrlen(sub[1]+6);
2736 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2738 /* If the length that we are comparing against is 28, assume the SHA1
2739 digest is expressed as a base64 string. If the length is 40, assume a
2740 straightforward hex representation. Other lengths fail. */
2744 uschar *coded = b64encode(digest, 20);
2745 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2746 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2747 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2749 else if (sublen == 40)
2753 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2755 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2756 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2757 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2761 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2762 "fail\n crypted=%s\n", sub[1]+6);
2767 else /* {crypt} or {crypt16} and non-{ at start */
2768 /* }-for-text-editors */
2773 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2778 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2783 else if (sub[1][0] == '{') /* }-for-text-editors */
2785 expand_string_message = string_sprintf("unknown encryption mechanism "
2786 "in \"%s\"", sub[1]);
2792 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2793 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2794 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2798 #define XSTR(s) STR(s)
2799 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2800 " subject=%s\n crypted=%s\n",
2801 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2806 /* If the encrypted string contains fewer than two characters (for the
2807 salt), force failure. Otherwise we get false positives: with an empty
2808 string the yield of crypt() is an empty string! */
2811 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2812 else if (errno == EINVAL)
2816 expand_string_message = string_sprintf("crypt error: %s\n",
2817 US strerror(errno));
2822 #endif /* SUPPORT_CRYPTEQ */
2827 const uschar * list = sub[1];
2829 uschar *save_iterate_item = iterate_item;
2830 int (*compare)(const uschar *, const uschar *);
2832 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2835 compare = cond_type == ECOND_INLISTI
2836 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2838 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2839 if (compare(sub[0], iterate_item) == 0)
2844 iterate_item = save_iterate_item;
2847 } /* Switch for comparison conditions */
2849 *yield = tempcond == testfor;
2850 return s; /* End of comparison conditions */
2853 /* and/or: computes logical and/or of several conditions */
2857 subcondptr = (yield == NULL)? NULL : &tempcond;
2858 combined_cond = (cond_type == ECOND_AND);
2860 while (isspace(*s)) s++;
2861 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2865 while (isspace(*s)) s++;
2866 /* {-for-text-editors */
2867 if (*s == '}') break;
2868 if (*s != '{') /* }-for-text-editors */
2870 expand_string_message = string_sprintf("each subcondition "
2871 "inside an \"%s{...}\" condition must be in its own {}", name);
2875 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2877 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2878 expand_string_message, name);
2881 while (isspace(*s)) s++;
2883 /* {-for-text-editors */
2886 /* {-for-text-editors */
2887 expand_string_message = string_sprintf("missing } at end of condition "
2888 "inside \"%s\" group", name);
2894 if (cond_type == ECOND_AND)
2896 combined_cond &= tempcond;
2897 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2898 } /* evaluate any more */
2901 combined_cond |= tempcond;
2902 if (combined_cond) subcondptr = NULL; /* once true, don't */
2903 } /* evaluate any more */
2907 if (yield != NULL) *yield = (combined_cond == testfor);
2911 /* forall/forany: iterates a condition with different values */
2916 const uschar * list;
2918 uschar *save_iterate_item = iterate_item;
2920 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2922 while (isspace(*s)) s++;
2923 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2924 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2925 if (sub[0] == NULL) return NULL;
2926 /* {-for-text-editors */
2927 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2929 while (isspace(*s)) s++;
2930 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2934 /* Call eval_condition once, with result discarded (as if scanning a
2935 "false" part). This allows us to find the end of the condition, because if
2936 the list it empty, we won't actually evaluate the condition for real. */
2938 if (!(s = eval_condition(sub[1], resetok, NULL)))
2940 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2941 expand_string_message, name);
2944 while (isspace(*s)) s++;
2946 /* {-for-text-editors */
2949 /* {-for-text-editors */
2950 expand_string_message = string_sprintf("missing } at end of condition "
2951 "inside \"%s\"", name);
2955 if (yield != NULL) *yield = !testfor;
2957 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2959 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2960 if (!eval_condition(sub[1], resetok, &tempcond))
2962 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2963 expand_string_message, name);
2964 iterate_item = save_iterate_item;
2967 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2968 tempcond? "true":"false");
2970 if (yield != NULL) *yield = (tempcond == testfor);
2971 if (tempcond == (cond_type == ECOND_FORANY)) break;
2974 iterate_item = save_iterate_item;
2979 /* The bool{} expansion condition maps a string to boolean.
2980 The values supported should match those supported by the ACL condition
2981 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2982 of true/false. Note that Router "condition" rules have a different
2983 interpretation, where general data can be used and only a few values
2985 Note that readconf.c boolean matching, for boolean configuration options,
2986 only matches true/yes/false/no.
2987 The bool_lax{} condition matches the Router logic, which is much more
2990 case ECOND_BOOL_LAX:
2996 BOOL boolvalue = FALSE;
2997 while (isspace(*s)) s++;
2998 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2999 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3000 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
3002 case 1: expand_string_message = string_sprintf(
3003 "too few arguments or bracketing error for %s",
3007 case 3: return NULL;
3010 while (isspace(*t)) t++;
3014 /* trailing whitespace: seems like a good idea to ignore it too */
3016 while (isspace(*t2)) t2--;
3017 if (t2 != (t + len))
3024 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
3025 /* logic for the lax case from expand_check_condition(), which also does
3026 expands, and the logic is both short and stable enough that there should
3027 be no maintenance burden from replicating it. */
3031 ? Ustrspn(t+1, "0123456789") == len-1
3032 : Ustrspn(t, "0123456789") == len)
3034 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3035 /* expand_check_condition only does a literal string "0" check */
3036 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3039 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3041 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3043 else if (cond_type == ECOND_BOOL_LAX)
3047 expand_string_message = string_sprintf("unrecognised boolean "
3051 if (yield != NULL) *yield = (boolvalue == testfor);
3055 /* Unknown condition */
3058 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3060 } /* End switch on condition type */
3062 /* Missing braces at start and end of data */
3064 COND_FAILED_CURLY_START:
3065 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3068 COND_FAILED_CURLY_END:
3069 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3073 /* A condition requires code that is not compiled */
3075 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3076 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3077 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3078 COND_FAILED_NOT_COMPILED:
3079 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3088 /*************************************************
3089 * Save numerical variables *
3090 *************************************************/
3092 /* This function is called from items such as "if" that want to preserve and
3093 restore the numbered variables.
3096 save_expand_string points to an array of pointers to set
3097 save_expand_nlength points to an array of ints for the lengths
3099 Returns: the value of expand max to save
3103 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3106 for (i = 0; i <= expand_nmax; i++)
3108 save_expand_nstring[i] = expand_nstring[i];
3109 save_expand_nlength[i] = expand_nlength[i];
3116 /*************************************************
3117 * Restore numerical variables *
3118 *************************************************/
3120 /* This function restored saved values of numerical strings.
3123 save_expand_nmax the number of strings to restore
3124 save_expand_string points to an array of pointers
3125 save_expand_nlength points to an array of ints
3131 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3132 int *save_expand_nlength)
3135 expand_nmax = save_expand_nmax;
3136 for (i = 0; i <= expand_nmax; i++)
3138 expand_nstring[i] = save_expand_nstring[i];
3139 expand_nlength[i] = save_expand_nlength[i];
3147 /*************************************************
3148 * Handle yes/no substrings *
3149 *************************************************/
3151 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3152 alternative substrings that depend on whether or not the condition was true,
3153 or the lookup or extraction succeeded. The substrings always have to be
3154 expanded, to check their syntax, but "skipping" is set when the result is not
3155 needed - this avoids unnecessary nested lookups.
3158 skipping TRUE if we were skipping when this item was reached
3159 yes TRUE if the first string is to be used, else use the second
3160 save_lookup a value to put back into lookup_value before the 2nd expansion
3161 sptr points to the input string pointer
3162 yieldptr points to the output string pointer
3163 sizeptr points to the output string size
3164 ptrptr points to the output string pointer
3165 type "lookup", "if", "extract", "run", "env", "listextract" or
3166 "certextract" for error message
3167 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3170 Returns: 0 OK; lookup_value has been reset to save_lookup
3172 2 expansion failed because of bracketing error
3176 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3177 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3180 const uschar *s = *sptr; /* Local value */
3181 uschar *sub1, *sub2;
3182 const uschar * errwhere;
3184 /* If there are no following strings, we substitute the contents of $value for
3185 lookups and for extractions in the success case. For the ${if item, the string
3186 "true" is substituted. In the fail case, nothing is substituted for all three
3189 while (isspace(*s)) s++;
3194 if (yes) *yieldptr = string_catn(*yieldptr, sizeptr, ptrptr, US"true", 4);
3198 if (yes && lookup_value)
3199 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value);
3200 lookup_value = save_lookup;
3206 /* The first following string must be braced. */
3210 errwhere = US"'yes' part did not start with '{'";
3214 /* Expand the first substring. Forced failures are noticed only if we actually
3215 want this string. Set skipping in the call in the fail case (this will always
3216 be the case if we were already skipping). */
3218 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3219 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3220 expand_string_forcedfail = FALSE;
3223 errwhere = US"'yes' part did not end with '}'";
3227 /* If we want the first string, add it to the output */
3230 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1);
3232 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3233 $value to what it was at the start of the item, so that it has this value
3234 during the second string expansion. For the call from "if" or "run" to this
3235 function, save_lookup is set to lookup_value, so that this statement does
3238 lookup_value = save_lookup;
3240 /* There now follows either another substring, or "fail", or nothing. This
3241 time, forced failures are noticed only if we want the second string. We must
3242 set skipping in the nested call if we don't want this string, or if we were
3243 already skipping. */
3245 while (isspace(*s)) s++;
3248 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3249 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3250 expand_string_forcedfail = FALSE;
3253 errwhere = US"'no' part did not start with '{'";
3257 /* If we want the second string, add it to the output */
3260 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2);
3263 /* If there is no second string, but the word "fail" is present when the use of
3264 the second string is wanted, set a flag indicating it was a forced failure
3265 rather than a syntactic error. Swallow the terminating } in case this is nested
3266 inside another lookup or if or extract. */
3271 /* deconst cast ok here as source is s anyway */
3272 s = US read_name(name, sizeof(name), s, US"_");
3273 if (Ustrcmp(name, "fail") == 0)
3275 if (!yes && !skipping)
3277 while (isspace(*s)) s++;
3280 errwhere = US"did not close with '}' after forcedfail";
3283 expand_string_message =
3284 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3285 expand_string_forcedfail = TRUE;
3291 expand_string_message =
3292 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3297 /* All we have to do now is to check on the final closing brace. */
3299 while (isspace(*s)) s++;
3302 errwhere = US"did not close with '}'";
3308 /* Update the input pointer value before returning */
3313 /* Get here if there is a bracketing failure */
3314 expand_string_message = string_sprintf(
3315 "curly-bracket problem in conditional yes/no parsing: %s\n"
3316 " remaining string is '%s'", errwhere, --s);
3321 /* Get here for other failures */
3329 /*************************************************
3330 * Handle MD5 or SHA-1 computation for HMAC *
3331 *************************************************/
3333 /* These are some wrapping functions that enable the HMAC code to be a bit
3334 cleaner. A good compiler will spot the tail recursion.
3337 type HMAC_MD5 or HMAC_SHA1
3338 remaining are as for the cryptographic hash functions
3344 chash_start(int type, void *base)
3346 if (type == HMAC_MD5)
3347 md5_start((md5 *)base);
3349 sha1_start((hctx *)base);
3353 chash_mid(int type, void *base, uschar *string)
3355 if (type == HMAC_MD5)
3356 md5_mid((md5 *)base, string);
3358 sha1_mid((hctx *)base, string);
3362 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3364 if (type == HMAC_MD5)
3365 md5_end((md5 *)base, string, length, digest);
3367 sha1_end((hctx *)base, string, length, digest);
3374 /********************************************************
3375 * prvs: Get last three digits of days since Jan 1, 1970 *
3376 ********************************************************/
3378 /* This is needed to implement the "prvs" BATV reverse
3381 Argument: integer "days" offset to add or substract to
3382 or from the current number of days.
3384 Returns: pointer to string containing the last three
3385 digits of the number of days since Jan 1, 1970,
3386 modified by the offset argument, NULL if there
3387 was an error in the conversion.
3392 prvs_daystamp(int day_offset)
3394 uschar *days = store_get(32); /* Need at least 24 for cases */
3395 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3396 (time(NULL) + day_offset*86400)/86400);
3397 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3402 /********************************************************
3403 * prvs: perform HMAC-SHA1 computation of prvs bits *
3404 ********************************************************/
3406 /* This is needed to implement the "prvs" BATV reverse
3410 address RFC2821 Address to use
3411 key The key to use (must be less than 64 characters
3413 key_num Single-digit key number to use. Defaults to
3416 Returns: pointer to string containing the first three
3417 bytes of the final hash in hex format, NULL if
3418 there was an error in the process.
3422 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3424 uschar *hash_source, *p;
3425 int size = 0,offset = 0,i;
3427 uschar innerhash[20];
3428 uschar finalhash[20];
3429 uschar innerkey[64];
3430 uschar outerkey[64];
3431 uschar *finalhash_hex = store_get(40);
3433 if (key_num == NULL)
3436 if (Ustrlen(key) > 64)
3439 hash_source = string_catn(NULL, &size, &offset, key_num, 1);
3440 hash_source = string_catn(hash_source, &size, &offset, daystamp, 3);
3441 hash_source = string_cat(hash_source, &size, &offset, address);
3442 hash_source[offset] = '\0';
3444 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3446 memset(innerkey, 0x36, 64);
3447 memset(outerkey, 0x5c, 64);
3449 for (i = 0; i < Ustrlen(key); i++)
3451 innerkey[i] ^= key[i];
3452 outerkey[i] ^= key[i];
3455 chash_start(HMAC_SHA1, &h);
3456 chash_mid(HMAC_SHA1, &h, innerkey);
3457 chash_end(HMAC_SHA1, &h, hash_source, offset, innerhash);
3459 chash_start(HMAC_SHA1, &h);
3460 chash_mid(HMAC_SHA1, &h, outerkey);
3461 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3464 for (i = 0; i < 3; i++)
3466 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3467 *p++ = hex_digits[finalhash[i] & 0x0f];
3471 return finalhash_hex;
3477 /*************************************************
3478 * Join a file onto the output string *
3479 *************************************************/
3481 /* This is used for readfile/readsock and after a run expansion.
3482 It joins the contents of a file onto the output string, globally replacing
3483 newlines with a given string (optionally).
3487 yield pointer to the expandable string
3488 sizep pointer to the current size
3489 ptrp pointer to the current position
3490 eol newline replacement string, or NULL
3492 Returns: new value of string pointer
3496 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3498 int eollen = eol ? Ustrlen(eol) : 0;
3499 uschar buffer[1024];
3501 while (Ufgets(buffer, sizeof(buffer), f))
3503 int len = Ustrlen(buffer);
3504 if (eol && buffer[len-1] == '\n') len--;
3505 yield = string_catn(yield, sizep, ptrp, buffer, len);
3506 if (buffer[len] != 0)
3507 yield = string_catn(yield, sizep, ptrp, eol, eollen);
3510 if (yield) yield[*ptrp] = 0;
3518 /*************************************************
3519 * Evaluate numeric expression *
3520 *************************************************/
3522 /* This is a set of mutually recursive functions that evaluate an arithmetic
3523 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3524 these functions that is called from elsewhere is eval_expr, whose interface is:
3527 sptr pointer to the pointer to the string - gets updated
3528 decimal TRUE if numbers are to be assumed decimal
3529 error pointer to where to put an error message - must be NULL on input
3530 endket TRUE if ')' must terminate - FALSE for external call
3532 Returns: on success: the value of the expression, with *error still NULL
3533 on failure: an undefined value, with *error = a message
3536 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3539 static int_eximarith_t
3540 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3543 int_eximarith_t x = eval_op_or(&s, decimal, error);
3549 *error = US"expecting closing parenthesis";
3551 while (isspace(*(++s)));
3553 else if (*s != 0) *error = US"expecting operator";
3560 static int_eximarith_t
3561 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3566 while (isspace(*s)) s++;
3571 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3573 switch (tolower(*s))
3576 case 'k': n *= 1024; s++; break;
3577 case 'm': n *= 1024*1024; s++; break;
3578 case 'g': n *= 1024*1024*1024; s++; break;
3580 while (isspace (*s)) s++;
3585 n = eval_expr(&s, decimal, error, 1);
3589 *error = US"expecting number or opening parenthesis";
3597 static int_eximarith_t
3598 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3602 while (isspace(*s)) s++;
3603 if (*s == '+' || *s == '-' || *s == '~')
3606 x = eval_op_unary(&s, decimal, error);
3607 if (op == '-') x = -x;
3608 else if (op == '~') x = ~x;
3612 x = eval_number(&s, decimal, error);
3619 static int_eximarith_t
3620 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3623 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3626 while (*s == '*' || *s == '/' || *s == '%')
3629 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3630 if (*error != NULL) break;
3631 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3632 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3633 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3634 * -N*M is INT_MIN will yielf INT_MIN.
3635 * Since we don't support floating point, this is somewhat simpler.
3636 * Ideally, we'd return an error, but since we overflow for all other
3637 * arithmetic, consistency suggests otherwise, but what's the correct value
3638 * to use? There is none.
3639 * The C standard guarantees overflow for unsigned arithmetic but signed
3640 * overflow invokes undefined behaviour; in practice, this is overflow
3641 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3642 * that long/longlong larger than int are available, or we could just work
3643 * with larger types. We should consider whether to guarantee 32bit eval
3644 * and 64-bit working variables, with errors returned. For now ...
3645 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3646 * can just let the other invalid results occur otherwise, as they have
3647 * until now. For this one case, we can coerce.
3649 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3652 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3653 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3663 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3679 static int_eximarith_t
3680 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3683 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3686 while (*s == '+' || *s == '-')
3689 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3691 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3692 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3693 { /* over-conservative check */
3695 ? US"overflow in sum" : US"overflow in difference";
3698 if (op == '+') x += y; else x -= y;
3706 static int_eximarith_t
3707 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3710 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3713 while ((*s == '<' || *s == '>') && s[1] == s[0])
3718 y = eval_op_sum(&s, decimal, error);
3719 if (*error != NULL) break;
3720 if (op == '<') x <<= y; else x >>= y;
3728 static int_eximarith_t
3729 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3732 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3739 y = eval_op_shift(&s, decimal, error);
3740 if (*error != NULL) break;
3749 static int_eximarith_t
3750 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3753 int_eximarith_t x = eval_op_and(&s, decimal, error);
3760 y = eval_op_and(&s, decimal, error);
3761 if (*error != NULL) break;
3770 static int_eximarith_t
3771 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3774 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3781 y = eval_op_xor(&s, decimal, error);
3782 if (*error != NULL) break;
3792 /*************************************************
3794 *************************************************/
3796 /* Returns either an unchanged string, or the expanded string in stacking pool
3797 store. Interpreted sequences are:
3799 \... normal escaping rules
3800 $name substitutes the variable
3802 ${op:string} operates on the expanded string value
3803 ${item{arg1}{arg2}...} expands the args and then does the business
3804 some literal args are not enclosed in {}
3806 There are now far too many operators and item types to make it worth listing
3807 them here in detail any more.
3809 We use an internal routine recursively to handle embedded substrings. The
3810 external function follows. The yield is NULL if the expansion failed, and there
3811 are two cases: if something collapsed syntactically, or if "fail" was given
3812 as the action on a lookup failure. These can be distinguised by looking at the
3813 variable expand_string_forcedfail, which is TRUE in the latter case.
3815 The skipping flag is set true when expanding a substring that isn't actually
3816 going to be used (after "if" or "lookup") and it prevents lookups from
3817 happening lower down.
3819 Store usage: At start, a store block of the length of the input plus 64
3820 is obtained. This is expanded as necessary by string_cat(), which might have to
3821 get a new block, or might be able to expand the original. At the end of the
3822 function we can release any store above that portion of the yield block that
3823 was actually used. In many cases this will be optimal.
3825 However: if the first item in the expansion is a variable name or header name,
3826 we reset the store before processing it; if the result is in fresh store, we
3827 use that without copying. This is helpful for expanding strings like
3828 $message_headers which can get very long.
3830 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3831 since resetting the store at the end of the expansion will free store that was
3832 allocated by the plugin code as well as the slop after the expanded string. So
3833 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3834 and, given the acl condition, ${if }. This is an unfortunate consequence of
3835 string expansion becoming too powerful.
3838 string the string to be expanded
3839 ket_ends true if expansion is to stop at }
3840 left if not NULL, a pointer to the first character after the
3841 expansion is placed here (typically used with ket_ends)
3842 skipping TRUE for recursive calls when the value isn't actually going
3843 to be used (to allow for optimisation)
3844 honour_dollar TRUE if $ is to be expanded,
3845 FALSE if it's just another character
3846 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3849 Returns: NULL if expansion fails:
3850 expand_string_forcedfail is set TRUE if failure was forced
3851 expand_string_message contains a textual error message
3852 a pointer to the expanded string on success
3856 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3857 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3860 int size = Ustrlen(string)+ 64;
3861 uschar *yield = store_get(size);
3863 const uschar *s = string;
3864 uschar *save_expand_nstring[EXPAND_MAXN+1];
3865 int save_expand_nlength[EXPAND_MAXN+1];
3866 BOOL resetok = TRUE;
3869 debug_printf("%s: %s\n", skipping ? " scanning" : "considering", string);
3871 expand_string_forcedfail = FALSE;
3872 expand_string_message = US"";
3879 /* \ escapes the next character, which must exist, or else
3880 the expansion fails. There's a special escape, \N, which causes
3881 copying of the subject verbatim up to the next \N. Otherwise,
3882 the escapes are the standard set. */
3888 expand_string_message = US"\\ at end of string";
3894 const uschar * t = s + 2;
3895 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3896 yield = string_catn(yield, &size, &ptr, t, s - t);
3897 if (*s != 0) s += 2;
3903 ch[0] = string_interpret_escape(&s);
3905 yield = string_catn(yield, &size, &ptr, ch, 1);
3912 /* Anything other than $ is just copied verbatim, unless we are
3913 looking for a terminating } character. */
3916 if (ket_ends && *s == '}') break;
3918 if (*s != '$' || !honour_dollar)
3920 yield = string_catn(yield, &size, &ptr, s++, 1);
3924 /* No { after the $ - must be a plain name or a number for string
3925 match variable. There has to be a fudge for variables that are the
3926 names of header fields preceded by "$header_" because header field
3927 names can contain any printing characters except space and colon.
3928 For those that don't like typing this much, "$h_" is a synonym for
3929 "$header_". A non-existent header yields a NULL value; nothing is
3932 if (isalpha((*(++s))))
3937 s = read_name(name, sizeof(name), s, US"_");
3939 /* If this is the first thing to be expanded, release the pre-allocated
3942 if (ptr == 0 && yield != NULL)
3944 if (resetok) store_reset(yield);
3951 if (Ustrncmp(name, "h_", 2) == 0 ||
3952 Ustrncmp(name, "rh_", 3) == 0 ||
3953 Ustrncmp(name, "bh_", 3) == 0 ||
3954 Ustrncmp(name, "header_", 7) == 0 ||
3955 Ustrncmp(name, "rheader_", 8) == 0 ||
3956 Ustrncmp(name, "bheader_", 8) == 0)
3958 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3959 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3960 s = read_header_name(name, sizeof(name), s);
3961 value = find_header(name, FALSE, &newsize, want_raw, charset);
3963 /* If we didn't find the header, and the header contains a closing brace
3964 character, this may be a user error where the terminating colon
3965 has been omitted. Set a flag to adjust the error message in this case.
3966 But there is no error here - nothing gets inserted. */
3970 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3977 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
3979 expand_string_message =
3980 string_sprintf("unknown variable name \"%s\"", name);
3981 check_variable_error_message(name);
3985 /* If the data is known to be in a new buffer, newsize will be set to the
3986 size of that buffer. If this is the first thing in an expansion string,
3987 yield will be NULL; just point it at the new store instead of copying. Many
3988 expansion strings contain just one reference, so this is a useful
3989 optimization, especially for humungous headers. */
3991 len = Ustrlen(value);
3992 if (yield == NULL && newsize != 0)
3998 else yield = string_catn(yield, &size, &ptr, value, len);
4006 s = read_cnumber(&n, s);
4007 if (n >= 0 && n <= expand_nmax)
4008 yield = string_catn(yield, &size, &ptr, expand_nstring[n],
4013 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4015 if (*s != '{') /*}*/
4017 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4021 /* After { there can be various things, but they all start with
4022 an initial word, except for a number for a string match variable. */
4024 if (isdigit((*(++s))))
4027 s = read_cnumber(&n, s); /*{*/
4030 expand_string_message = US"} expected after number";
4033 if (n >= 0 && n <= expand_nmax)
4034 yield = string_catn(yield, &size, &ptr, expand_nstring[n],
4041 expand_string_message = US"letter or digit expected after ${"; /*}*/
4045 /* Allow "-" in names to cater for substrings with negative
4046 arguments. Since we are checking for known names after { this is
4049 s = read_name(name, sizeof(name), s, US"_-");
4050 item_type = chop_match(name, item_table, nelem(item_table));
4054 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4055 If the ACL returns accept or reject we return content set by "message ="
4056 There is currently no limit on recursion; this would have us call
4057 acl_check_internal() directly and get a current level from somewhere.
4058 See also the acl expansion condition ECOND_ACL and the traditional
4059 acl modifier ACLC_ACL.
4060 Assume that the function has side-effects on the store that must be preserved.
4064 /* ${acl {name} {arg1}{arg2}...} */
4066 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4069 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4072 case 1: goto EXPAND_FAILED_CURLY;
4074 case 3: goto EXPAND_FAILED;
4076 if (skipping) continue;
4079 switch(eval_acl(sub, nelem(sub), &user_msg))
4084 debug_printf("acl expansion yield: %s\n", user_msg);
4086 yield = string_cat(yield, &size, &ptr, user_msg);
4090 expand_string_forcedfail = TRUE;
4093 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4098 /* Handle conditionals - preserve the values of the numerical expansion
4099 variables in case they get changed by a regular expression match in the
4100 condition. If not, they retain their external settings. At the end
4101 of this "if" section, they get restored to their previous values. */
4106 const uschar *next_s;
4107 int save_expand_nmax =
4108 save_expand_strings(save_expand_nstring, save_expand_nlength);
4110 while (isspace(*s)) s++;
4111 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
4112 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4115 debug_printf(" condition: %.*s\n result: %s\n",
4116 (int)(next_s - s), s,
4117 cond ? "true" : "false");
4121 /* The handling of "yes" and "no" result strings is now in a separate
4122 function that is also used by ${lookup} and ${extract} and ${run}. */
4124 switch(process_yesno(
4125 skipping, /* were previously skipping */
4126 cond, /* success/failure indicator */
4127 lookup_value, /* value to reset for string2 */
4128 &s, /* input pointer */
4129 &yield, /* output pointer */
4130 &size, /* output size */
4131 &ptr, /* output current point */
4132 US"if", /* condition type */
4135 case 1: goto EXPAND_FAILED; /* when all is well, the */
4136 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4139 /* Restore external setting of expansion variables for continuation
4142 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4143 save_expand_nlength);
4148 case EITEM_IMAPFOLDER:
4149 { /* ${imapfolder {name}{sep]{specials}} */
4153 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4156 case 1: goto EXPAND_FAILED_CURLY;
4158 case 3: goto EXPAND_FAILED;
4161 if (sub_arg[1] == NULL) /* One argument */
4163 sub_arg[1] = US"/"; /* default separator */
4166 else if (Ustrlen(sub_arg[1]) != 1)
4168 expand_string_message =
4170 "IMAP folder separator must be one character, found \"%s\"",
4175 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4176 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4179 yield = string_cat(yield, &size, &ptr, encoded);
4184 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4185 expanding an internal string that isn't actually going to be used. All we
4186 need to do is check the syntax, so don't do a lookup at all. Preserve the
4187 values of the numerical expansion variables in case they get changed by a
4188 partial lookup. If not, they retain their external settings. At the end
4189 of this "lookup" section, they get restored to their previous values. */
4193 int stype, partial, affixlen, starflags;
4194 int expand_setup = 0;
4196 uschar *key, *filename;
4197 const uschar *affix;
4198 uschar *save_lookup_value = lookup_value;
4199 int save_expand_nmax =
4200 save_expand_strings(save_expand_nstring, save_expand_nlength);
4202 if ((expand_forbid & RDO_LOOKUP) != 0)
4204 expand_string_message = US"lookup expansions are not permitted";
4208 /* Get the key we are to look up for single-key+file style lookups.
4209 Otherwise set the key NULL pro-tem. */
4211 while (isspace(*s)) s++;
4212 if (*s == '{') /*}*/
4214 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4215 if (!key) goto EXPAND_FAILED; /*{{*/
4218 expand_string_message = US"missing '}' after lookup key";
4219 goto EXPAND_FAILED_CURLY;
4221 while (isspace(*s)) s++;
4225 /* Find out the type of database */
4229 expand_string_message = US"missing lookup type";
4233 /* The type is a string that may contain special characters of various
4234 kinds. Allow everything except space or { to appear; the actual content
4235 is checked by search_findtype_partial. */ /*}*/
4237 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4239 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4243 while (isspace(*s)) s++;
4245 /* Now check for the individual search type and any partial or default
4246 options. Only those types that are actually in the binary are valid. */
4248 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4252 expand_string_message = search_error_message;
4256 /* Check that a key was provided for those lookup types that need it,
4257 and was not supplied for those that use the query style. */
4259 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4263 expand_string_message = string_sprintf("missing {key} for single-"
4264 "key \"%s\" lookup", name);
4272 expand_string_message = string_sprintf("a single key was given for "
4273 "lookup type \"%s\", which is not a single-key lookup type", name);
4278 /* Get the next string in brackets and expand it. It is the file name for
4279 single-key+file lookups, and the whole query otherwise. In the case of
4280 queries that also require a file name (e.g. sqlite), the file name comes
4285 expand_string_message = US"missing '{' for lookup file-or-query arg";
4286 goto EXPAND_FAILED_CURLY;
4288 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4289 if (filename == NULL) goto EXPAND_FAILED;
4292 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4293 goto EXPAND_FAILED_CURLY;
4295 while (isspace(*s)) s++;
4297 /* If this isn't a single-key+file lookup, re-arrange the variables
4298 to be appropriate for the search_ functions. For query-style lookups,
4299 there is just a "key", and no file name. For the special query-style +
4300 file types, the query (i.e. "key") starts with a file name. */
4304 while (isspace(*filename)) filename++;
4307 if (mac_islookup(stype, lookup_querystyle))
4311 if (*filename != '/')
4313 expand_string_message = string_sprintf(
4314 "absolute file name expected for \"%s\" lookup", name);
4317 while (*key != 0 && !isspace(*key)) key++;
4318 if (*key != 0) *key++ = 0;
4322 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4323 the entry was not found. Note that there is no search_close() function.
4324 Files are left open in case of re-use. At suitable places in higher logic,
4325 search_tidyup() is called to tidy all open files. This can save opening
4326 the same file several times. However, files may also get closed when
4327 others are opened, if too many are open at once. The rule is that a
4328 handle should not be used after a second search_open().
4330 Request that a partial search sets up $1 and maybe $2 by passing
4331 expand_setup containing zero. If its value changes, reset expand_nmax,
4332 since new variables will have been set. Note that at the end of this
4333 "lookup" section, the old numeric variables are restored. */
4336 lookup_value = NULL;
4339 void *handle = search_open(filename, stype, 0, NULL, NULL);
4342 expand_string_message = search_error_message;
4345 lookup_value = search_find(handle, filename, key, partial, affix,
4346 affixlen, starflags, &expand_setup);
4347 if (search_find_defer)
4349 expand_string_message =
4350 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4351 string_printing2(key, FALSE), search_error_message);
4354 if (expand_setup > 0) expand_nmax = expand_setup;
4357 /* The handling of "yes" and "no" result strings is now in a separate
4358 function that is also used by ${if} and ${extract}. */
4360 switch(process_yesno(
4361 skipping, /* were previously skipping */
4362 lookup_value != NULL, /* success/failure indicator */
4363 save_lookup_value, /* value to reset for string2 */
4364 &s, /* input pointer */
4365 &yield, /* output pointer */
4366 &size, /* output size */
4367 &ptr, /* output current point */
4368 US"lookup", /* condition type */
4371 case 1: goto EXPAND_FAILED; /* when all is well, the */
4372 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4375 /* Restore external setting of expansion variables for carrying on
4376 at this level, and continue. */
4378 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4379 save_expand_nlength);
4383 /* If Perl support is configured, handle calling embedded perl subroutines,
4384 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4385 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4386 arguments (defined below). */
4388 #define EXIM_PERL_MAX_ARGS 8
4392 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4393 "is not included in this binary";
4396 #else /* EXIM_PERL */
4398 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4401 if ((expand_forbid & RDO_PERL) != 0)
4403 expand_string_message = US"Perl calls are not permitted";
4407 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4408 US"perl", &resetok))
4410 case 1: goto EXPAND_FAILED_CURLY;
4412 case 3: goto EXPAND_FAILED;
4415 /* If skipping, we don't actually do anything */
4417 if (skipping) continue;
4419 /* Start the interpreter if necessary */
4421 if (!opt_perl_started)
4424 if (opt_perl_startup == NULL)
4426 expand_string_message = US"A setting of perl_startup is needed when "
4427 "using the Perl interpreter";
4430 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4431 initerror = init_perl(opt_perl_startup);
4432 if (initerror != NULL)
4434 expand_string_message =
4435 string_sprintf("error in perl_startup code: %s\n", initerror);
4438 opt_perl_started = TRUE;
4441 /* Call the function */
4443 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4444 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4445 sub_arg[0], sub_arg + 1);
4447 /* NULL yield indicates failure; if the message pointer has been set to
4448 NULL, the yield was undef, indicating a forced failure. Otherwise the
4449 message will indicate some kind of Perl error. */
4451 if (new_yield == NULL)
4453 if (expand_string_message == NULL)
4455 expand_string_message =
4456 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4457 "failure", sub_arg[0]);
4458 expand_string_forcedfail = TRUE;
4463 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4464 set during a callback from Perl. */
4466 expand_string_forcedfail = FALSE;
4470 #endif /* EXIM_PERL */
4472 /* Transform email address to "prvs" scheme to use
4473 as BATV-signed return path */
4480 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4482 case 1: goto EXPAND_FAILED_CURLY;
4484 case 3: goto EXPAND_FAILED;
4487 /* If skipping, we don't actually do anything */
4488 if (skipping) continue;
4490 /* sub_arg[0] is the address */
4491 domain = Ustrrchr(sub_arg[0],'@');
4492 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4494 expand_string_message = US"prvs first argument must be a qualified email address";
4498 /* Calculate the hash. The second argument must be a single-digit
4499 key number, or unset. */
4501 if (sub_arg[2] != NULL &&
4502 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4504 expand_string_message = US"prvs second argument must be a single digit";
4508 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4511 expand_string_message = US"prvs hmac-sha1 conversion failed";
4515 /* Now separate the domain from the local part */
4518 yield = string_catn(yield, &size, &ptr, US"prvs=", 5);
4519 yield = string_catn(yield, &size, &ptr, sub_arg[2] ? sub_arg[2] : US"0", 1);
4520 yield = string_catn(yield, &size, &ptr, prvs_daystamp(7), 3);
4521 yield = string_catn(yield, &size, &ptr, p, 6);
4522 yield = string_catn(yield, &size, &ptr, US"=", 1);
4523 yield = string_cat (yield, &size, &ptr, sub_arg[0]);
4524 yield = string_catn(yield, &size, &ptr, US"@", 1);
4525 yield = string_cat (yield, &size, &ptr, domain);
4530 /* Check a prvs-encoded address for validity */
4532 case EITEM_PRVSCHECK:
4535 int mysize = 0, myptr = 0;
4539 /* TF: Ugliness: We want to expand parameter 1 first, then set
4540 up expansion variables that are used in the expansion of
4541 parameter 2. So we clone the string for the first
4542 expansion, where we only expand parameter 1.
4544 PH: Actually, that isn't necessary. The read_subs() function is
4545 designed to work this way for the ${if and ${lookup expansions. I've
4549 /* Reset expansion variables */
4550 prvscheck_result = NULL;
4551 prvscheck_address = NULL;
4552 prvscheck_keynum = NULL;
4554 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4556 case 1: goto EXPAND_FAILED_CURLY;
4558 case 3: goto EXPAND_FAILED;
4561 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4564 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4566 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4567 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4568 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4569 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4570 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4572 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4573 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4574 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4575 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4576 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4578 /* Set up expansion variables */
4579 prvscheck_address = string_cat (NULL, &mysize, &myptr, local_part);
4580 prvscheck_address = string_catn(prvscheck_address, &mysize, &myptr, US"@", 1);
4581 prvscheck_address = string_cat (prvscheck_address, &mysize, &myptr, domain);
4582 prvscheck_address[myptr] = '\0';
4583 prvscheck_keynum = string_copy(key_num);
4585 /* Now expand the second argument */
4586 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4588 case 1: goto EXPAND_FAILED_CURLY;
4590 case 3: goto EXPAND_FAILED;
4593 /* Now we have the key and can check the address. */
4595 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4600 expand_string_message = US"hmac-sha1 conversion failed";
4604 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4605 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4607 if (Ustrcmp(p,hash) == 0)
4609 /* Success, valid BATV address. Now check the expiry date. */
4610 uschar *now = prvs_daystamp(0);
4611 unsigned int inow = 0,iexpire = 1;
4613 (void)sscanf(CS now,"%u",&inow);
4614 (void)sscanf(CS daystamp,"%u",&iexpire);
4616 /* When "iexpire" is < 7, a "flip" has occured.
4617 Adjust "inow" accordingly. */
4618 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4620 if (iexpire >= inow)
4622 prvscheck_result = US"1";
4623 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4627 prvscheck_result = NULL;
4628 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4633 prvscheck_result = NULL;
4634 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4637 /* Now expand the final argument. We leave this till now so that
4638 it can include $prvscheck_result. */
4640 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4642 case 1: goto EXPAND_FAILED_CURLY;
4644 case 3: goto EXPAND_FAILED;
4647 yield = string_cat(yield, &size, &ptr,
4648 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4650 /* Reset the "internal" variables afterwards, because they are in
4651 dynamic store that will be reclaimed if the expansion succeeded. */
4653 prvscheck_address = NULL;
4654 prvscheck_keynum = NULL;
4658 /* Does not look like a prvs encoded address, return the empty string.
4659 We need to make sure all subs are expanded first, so as to skip over
4662 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4664 case 1: goto EXPAND_FAILED_CURLY;
4666 case 3: goto EXPAND_FAILED;
4673 /* Handle "readfile" to insert an entire file */
4675 case EITEM_READFILE:
4680 if ((expand_forbid & RDO_READFILE) != 0)
4682 expand_string_message = US"file insertions are not permitted";
4686 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4688 case 1: goto EXPAND_FAILED_CURLY;
4690 case 3: goto EXPAND_FAILED;
4693 /* If skipping, we don't actually do anything */
4695 if (skipping) continue;
4697 /* Open the file and read it */
4699 f = Ufopen(sub_arg[0], "rb");
4702 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4706 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4711 /* Handle "readsocket" to insert data from a Unix domain socket */
4713 case EITEM_READSOCK:
4719 struct sockaddr_un sockun; /* don't call this "sun" ! */
4723 if ((expand_forbid & RDO_READSOCK) != 0)
4725 expand_string_message = US"socket insertions are not permitted";
4729 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4730 because there may be a string for expansion on failure. */
4732 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4734 case 1: goto EXPAND_FAILED_CURLY;
4735 case 2: /* Won't occur: no end check */
4736 case 3: goto EXPAND_FAILED;
4739 /* Sort out timeout, if given */
4741 if (sub_arg[2] != NULL)
4743 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4746 expand_string_message = string_sprintf("bad time value %s",
4751 else sub_arg[3] = NULL; /* No eol if no timeout */
4753 /* If skipping, we don't actually do anything. Otherwise, arrange to
4754 connect to either an IP or a Unix socket. */
4758 /* Handle an IP (internet) domain */
4760 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4763 uschar *server_name = sub_arg[0] + 5;
4764 uschar *port_name = Ustrrchr(server_name, ':');
4766 /* Sort out the port */
4768 if (port_name == NULL)
4770 expand_string_message =
4771 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4774 *port_name++ = 0; /* Terminate server name */
4776 if (isdigit(*port_name))
4779 port = Ustrtol(port_name, &end, 0);
4780 if (end != port_name + Ustrlen(port_name))
4782 expand_string_message =
4783 string_sprintf("invalid port number %s", port_name);
4789 struct servent *service_info = getservbyname(CS port_name, "tcp");
4790 if (service_info == NULL)
4792 expand_string_message = string_sprintf("unknown port \"%s\"",
4796 port = ntohs(service_info->s_port);
4799 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4800 timeout, NULL, &expand_string_message)) < 0)
4804 /* Handle a Unix domain socket */
4809 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4811 expand_string_message = string_sprintf("failed to create socket: %s",
4816 sockun.sun_family = AF_UNIX;
4817 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4820 sigalrm_seen = FALSE;
4822 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4826 expand_string_message = US "socket connect timed out";
4831 expand_string_message = string_sprintf("failed to connect to socket "
4832 "%s: %s", sub_arg[0], strerror(errno));
4837 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4839 /* Allow sequencing of test actions */
4840 if (running_in_test_harness) millisleep(100);
4842 /* Write the request string, if not empty */
4844 if (sub_arg[1][0] != 0)
4846 int len = Ustrlen(sub_arg[1]);
4847 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4849 if (write(fd, sub_arg[1], len) != len)
4851 expand_string_message = string_sprintf("request write to socket "
4852 "failed: %s", strerror(errno));
4857 /* Shut down the sending side of the socket. This helps some servers to
4858 recognise that it is their turn to do some work. Just in case some
4859 system doesn't have this function, make it conditional. */
4862 shutdown(fd, SHUT_WR);
4865 if (running_in_test_harness) millisleep(100);
4867 /* Now we need to read from the socket, under a timeout. The function
4868 that reads a file can be used. */
4870 f = fdopen(fd, "rb");
4871 sigalrm_seen = FALSE;
4873 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4877 /* After a timeout, we restore the pointer in the result, that is,
4878 make sure we add nothing from the socket. */
4883 expand_string_message = US "socket read timed out";
4888 /* The whole thing has worked (or we were skipping). If there is a
4889 failure string following, we need to skip it. */
4893 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4897 expand_string_message = US"missing '}' closing failstring for readsocket";
4898 goto EXPAND_FAILED_CURLY;
4900 while (isspace(*s)) s++;
4906 expand_string_message = US"missing '}' closing readsocket";
4907 goto EXPAND_FAILED_CURLY;
4911 /* Come here on failure to create socket, connect socket, write to the
4912 socket, or timeout on reading. If another substring follows, expand and
4913 use it. Otherwise, those conditions give expand errors. */
4916 if (*s != '{') goto EXPAND_FAILED;
4917 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4918 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
4920 yield = string_cat(yield, &size, &ptr, arg);
4923 expand_string_message = US"missing '}' closing failstring for readsocket";
4924 goto EXPAND_FAILED_CURLY;
4926 while (isspace(*s)) s++;
4930 /* Handle "run" to execute a program. */
4936 const uschar **argv;
4939 int lsize = 0, lptr = 0;
4941 if ((expand_forbid & RDO_RUN) != 0)
4943 expand_string_message = US"running a command is not permitted";
4947 while (isspace(*s)) s++;
4950 expand_string_message = US"missing '{' for command arg of run";
4951 goto EXPAND_FAILED_CURLY;
4953 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4954 if (arg == NULL) goto EXPAND_FAILED;
4955 while (isspace(*s)) s++;
4958 expand_string_message = US"missing '}' closing command arg of run";
4959 goto EXPAND_FAILED_CURLY;
4962 if (skipping) /* Just pretend it worked when we're skipping */
4966 if (!transport_set_up_command(&argv, /* anchor for arg list */
4967 arg, /* raw command */
4968 FALSE, /* don't expand the arguments */
4969 0, /* not relevant when... */
4970 NULL, /* no transporting address */
4971 US"${run} expansion", /* for error messages */
4972 &expand_string_message)) /* where to put error message */
4975 /* Create the child process, making it a group leader. */
4977 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
4979 expand_string_message =
4980 string_sprintf("couldn't create child process: %s", strerror(errno));
4984 /* Nothing is written to the standard input. */
4988 /* Read the pipe to get the command's output into $value (which is kept
4989 in lookup_value). Read during execution, so that if the output exceeds
4990 the OS pipe buffer limit, we don't block forever. Remember to not release
4991 memory just allocated for $value. */
4994 f = fdopen(fd_out, "rb");
4995 sigalrm_seen = FALSE;
4997 lookup_value = cat_file(f, NULL, &lsize, &lptr, NULL);
5001 /* Wait for the process to finish, applying the timeout, and inspect its
5002 return code for serious disasters. Simple non-zero returns are passed on.
5005 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
5007 if (sigalrm_seen == TRUE || runrc == -256)
5009 expand_string_message = string_sprintf("command timed out");
5010 killpg(pid, SIGKILL); /* Kill the whole process group */
5013 else if (runrc == -257)
5014 expand_string_message = string_sprintf("wait() failed: %s",
5018 expand_string_message = string_sprintf("command killed by signal %d",
5025 /* Process the yes/no strings; $value may be useful in both cases */
5027 switch(process_yesno(
5028 skipping, /* were previously skipping */
5029 runrc == 0, /* success/failure indicator */
5030 lookup_value, /* value to reset for string2 */
5031 &s, /* input pointer */
5032 &yield, /* output pointer */
5033 &size, /* output size */
5034 &ptr, /* output current point */
5035 US"run", /* condition type */
5038 case 1: goto EXPAND_FAILED; /* when all is well, the */
5039 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5045 /* Handle character translation for "tr" */
5053 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5055 case 1: goto EXPAND_FAILED_CURLY;
5057 case 3: goto EXPAND_FAILED;
5060 yield = string_cat(yield, &size, &ptr, sub[0]);
5061 o2m = Ustrlen(sub[2]) - 1;
5063 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
5065 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
5069 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
5076 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5077 expanded arguments. */
5087 int val[2] = { 0, -1 };
5090 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5091 Ensure that sub[2] is set in the ${length } case. */
5094 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5095 TRUE, name, &resetok))
5097 case 1: goto EXPAND_FAILED_CURLY;
5099 case 3: goto EXPAND_FAILED;
5102 /* Juggle the arguments if there are only two of them: always move the
5103 string to the last position and make ${length{n}{str}} equivalent to
5104 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5110 if (item_type == EITEM_LENGTH)
5117 for (i = 0; i < 2; i++)
5119 if (sub[i] == NULL) continue;
5120 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5121 if (*ret != 0 || (i != 0 && val[i] < 0))
5123 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5124 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5130 (item_type == EITEM_HASH)?
5131 compute_hash(sub[2], val[0], val[1], &len) :
5132 (item_type == EITEM_NHASH)?
5133 compute_nhash(sub[2], val[0], val[1], &len) :
5134 extract_substr(sub[2], val[0], val[1], &len);
5136 if (ret == NULL) goto EXPAND_FAILED;
5137 yield = string_catn(yield, &size, &ptr, ret, len);
5141 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5142 This code originally contributed by Steve Haslam. It currently supports
5143 the use of MD5 and SHA-1 hashes.
5145 We need some workspace that is large enough to handle all the supported
5146 hash types. Use macros to set the sizes rather than be too elaborate. */
5148 #define MAX_HASHLEN 20
5149 #define MAX_HASHBLOCKLEN 64
5158 int hashlen; /* Number of octets for the hash algorithm's output */
5159 int hashblocklen; /* Number of octets the hash algorithm processes */
5161 unsigned int keylen;
5163 uschar keyhash[MAX_HASHLEN];
5164 uschar innerhash[MAX_HASHLEN];
5165 uschar finalhash[MAX_HASHLEN];
5166 uschar finalhash_hex[2*MAX_HASHLEN];
5167 uschar innerkey[MAX_HASHBLOCKLEN];
5168 uschar outerkey[MAX_HASHBLOCKLEN];
5170 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5172 case 1: goto EXPAND_FAILED_CURLY;
5174 case 3: goto EXPAND_FAILED;
5177 if (Ustrcmp(sub[0], "md5") == 0)
5180 use_base = &md5_base;
5184 else if (Ustrcmp(sub[0], "sha1") == 0)
5187 use_base = &sha1_ctx;
5193 expand_string_message =
5194 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5199 keylen = Ustrlen(keyptr);
5201 /* If the key is longer than the hash block length, then hash the key
5204 if (keylen > hashblocklen)
5206 chash_start(type, use_base);
5207 chash_end(type, use_base, keyptr, keylen, keyhash);
5212 /* Now make the inner and outer key values */
5214 memset(innerkey, 0x36, hashblocklen);
5215 memset(outerkey, 0x5c, hashblocklen);
5217 for (i = 0; i < keylen; i++)
5219 innerkey[i] ^= keyptr[i];
5220 outerkey[i] ^= keyptr[i];
5223 /* Now do the hashes */
5225 chash_start(type, use_base);
5226 chash_mid(type, use_base, innerkey);
5227 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5229 chash_start(type, use_base);
5230 chash_mid(type, use_base, outerkey);
5231 chash_end(type, use_base, innerhash, hashlen, finalhash);
5233 /* Encode the final hash as a hex string */
5236 for (i = 0; i < hashlen; i++)
5238 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5239 *p++ = hex_digits[finalhash[i] & 0x0f];
5242 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5243 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5245 yield = string_catn(yield, &size, &ptr, finalhash_hex, hashlen*2);
5250 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5251 We have to save the numerical variables and restore them afterwards. */
5256 int moffset, moffsetextra, slen;
5259 const uschar *rerror;
5262 int save_expand_nmax =
5263 save_expand_strings(save_expand_nstring, save_expand_nlength);
5265 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5267 case 1: goto EXPAND_FAILED_CURLY;
5269 case 3: goto EXPAND_FAILED;
5272 /* Compile the regular expression */
5274 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5279 expand_string_message = string_sprintf("regular expression error in "
5280 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5284 /* Now run a loop to do the substitutions as often as necessary. It ends
5285 when there are no more matches. Take care over matches of the null string;
5286 do the same thing as Perl does. */
5289 slen = Ustrlen(sub[0]);
5290 moffset = moffsetextra = 0;
5295 int ovector[3*(EXPAND_MAXN+1)];
5296 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5297 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5301 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5302 is not necessarily the end. We want to repeat the match from one
5303 character further along, but leaving the basic offset the same (for
5304 copying below). We can't be at the end of the string - that was checked
5305 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5306 finished; copy the remaining string and end the loop. */
5316 yield = string_catn(yield, &size, &ptr, subject+moffset, slen-moffset);
5320 /* Match - set up for expanding the replacement. */
5322 if (n == 0) n = EXPAND_MAXN + 1;
5324 for (nn = 0; nn < n*2; nn += 2)
5326 expand_nstring[expand_nmax] = subject + ovector[nn];
5327 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5331 /* Copy the characters before the match, plus the expanded insertion. */
5333 yield = string_catn(yield, &size, &ptr, subject + moffset,
5334 ovector[0] - moffset);
5335 insert = expand_string(sub[2]);
5336 if (insert == NULL) goto EXPAND_FAILED;
5337 yield = string_cat(yield, &size, &ptr, insert);
5339 moffset = ovector[1];
5343 /* If we have matched an empty string, first check to see if we are at
5344 the end of the subject. If so, the loop is over. Otherwise, mimic
5345 what Perl's /g options does. This turns out to be rather cunning. First
5346 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5347 string at the same point. If this fails (picked up above) we advance to
5348 the next character. */
5350 if (ovector[0] == ovector[1])
5352 if (ovector[0] == slen) break;
5353 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5357 /* All done - restore numerical variables. */
5359 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5360 save_expand_nlength);
5364 /* Handle keyed and numbered substring extraction. If the first argument
5365 consists entirely of digits, then a numerical extraction is assumed. */
5371 int field_number = 1;
5372 BOOL field_number_set = FALSE;
5373 uschar *save_lookup_value = lookup_value;
5375 int save_expand_nmax =
5376 save_expand_strings(save_expand_nstring, save_expand_nlength);
5378 /* While skipping we cannot rely on the data for expansions being
5379 available (eg. $item) hence cannot decide on numeric vs. keyed.
5380 Read a maximum of 5 arguments (inclding the yes/no) */
5384 while (isspace(*s)) s++;
5385 for (j = 5; j > 0 && *s == '{'; j--)
5387 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5388 goto EXPAND_FAILED; /*{*/
5391 expand_string_message = US"missing '{' for arg of extract";
5392 goto EXPAND_FAILED_CURLY;
5394 while (isspace(*s)) s++;
5396 if ( Ustrncmp(s, "fail", 4) == 0
5397 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5401 while (isspace(*s)) s++;
5405 expand_string_message = US"missing '}' closing extract";
5406 goto EXPAND_FAILED_CURLY;
5410 else for (i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5412 while (isspace(*s)) s++;
5413 if (*s == '{') /*}*/
5415 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5416 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5419 expand_string_message = string_sprintf(
5420 "missing '}' closing arg %d of extract", i+1);
5421 goto EXPAND_FAILED_CURLY;
5424 /* After removal of leading and trailing white space, the first
5425 argument must not be empty; if it consists entirely of digits
5426 (optionally preceded by a minus sign), this is a numerical
5427 extraction, and we expect 3 arguments. */
5435 while (isspace(*p)) p++;
5439 while (len > 0 && isspace(p[len-1])) len--;
5444 expand_string_message = US"first argument of \"extract\" must "
5454 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5458 j = 3; /* Need 3 args */
5459 field_number_set = TRUE;
5465 expand_string_message = string_sprintf(
5466 "missing '{' for arg %d of extract", i+1);
5467 goto EXPAND_FAILED_CURLY;
5471 /* Extract either the numbered or the keyed substring into $value. If
5472 skipping, just pretend the extraction failed. */
5474 lookup_value = skipping? NULL : field_number_set?
5475 expand_gettokened(field_number, sub[1], sub[2]) :
5476 expand_getkeyed(sub[0], sub[1]);
5478 /* If no string follows, $value gets substituted; otherwise there can
5479 be yes/no strings, as for lookup or if. */
5481 switch(process_yesno(
5482 skipping, /* were previously skipping */
5483 lookup_value != NULL, /* success/failure indicator */
5484 save_lookup_value, /* value to reset for string2 */
5485 &s, /* input pointer */
5486 &yield, /* output pointer */
5487 &size, /* output size */
5488 &ptr, /* output current point */
5489 US"extract", /* condition type */
5492 case 1: goto EXPAND_FAILED; /* when all is well, the */
5493 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5496 /* All done - restore numerical variables. */
5498 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5499 save_expand_nlength);
5504 /* return the Nth item from a list */
5506 case EITEM_LISTEXTRACT:
5509 int field_number = 1;
5510 uschar *save_lookup_value = lookup_value;
5512 int save_expand_nmax =
5513 save_expand_strings(save_expand_nstring, save_expand_nlength);
5515 /* Read the field & list arguments */
5517 for (i = 0; i < 2; i++)
5519 while (isspace(*s)) s++;
5520 if (*s != '{') /*}*/
5522 expand_string_message = string_sprintf(
5523 "missing '{' for arg %d of listextract", i+1);
5524 goto EXPAND_FAILED_CURLY;
5527 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5528 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5531 expand_string_message = string_sprintf(
5532 "missing '}' closing arg %d of listextract", i+1);
5533 goto EXPAND_FAILED_CURLY;
5536 /* After removal of leading and trailing white space, the first
5537 argument must be numeric and nonempty. */
5545 while (isspace(*p)) p++;
5549 while (len > 0 && isspace(p[len-1])) len--;
5552 if (!*p && !skipping)
5554 expand_string_message = US"first argument of \"listextract\" must "
5564 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5567 expand_string_message = US"first argument of \"listextract\" must "
5575 /* Extract the numbered element into $value. If
5576 skipping, just pretend the extraction failed. */
5578 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5580 /* If no string follows, $value gets substituted; otherwise there can
5581 be yes/no strings, as for lookup or if. */
5583 switch(process_yesno(
5584 skipping, /* were previously skipping */
5585 lookup_value != NULL, /* success/failure indicator */
5586 save_lookup_value, /* value to reset for string2 */
5587 &s, /* input pointer */
5588 &yield, /* output pointer */
5589 &size, /* output size */
5590 &ptr, /* output current point */
5591 US"listextract", /* condition type */
5594 case 1: goto EXPAND_FAILED; /* when all is well, the */
5595 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5598 /* All done - restore numerical variables. */
5600 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5601 save_expand_nlength);
5607 case EITEM_CERTEXTRACT:
5609 uschar *save_lookup_value = lookup_value;
5611 int save_expand_nmax =
5612 save_expand_strings(save_expand_nstring, save_expand_nlength);
5614 /* Read the field argument */
5615 while (isspace(*s)) s++;
5616 if (*s != '{') /*}*/
5618 expand_string_message = US"missing '{' for field arg of certextract";
5619 goto EXPAND_FAILED_CURLY;
5621 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5622 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5625 expand_string_message = US"missing '}' closing field arg of certextract";
5626 goto EXPAND_FAILED_CURLY;
5628 /* strip spaces fore & aft */
5633 while (isspace(*p)) p++;
5637 while (len > 0 && isspace(p[len-1])) len--;
5641 /* inspect the cert argument */
5642 while (isspace(*s)) s++;
5643 if (*s != '{') /*}*/
5645 expand_string_message = US"missing '{' for cert variable arg of certextract";
5646 goto EXPAND_FAILED_CURLY;
5650 expand_string_message = US"second argument of \"certextract\" must "
5651 "be a certificate variable";
5654 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5655 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5658 expand_string_message = US"missing '}' closing cert variable arg of certextract";
5659 goto EXPAND_FAILED_CURLY;
5663 lookup_value = NULL;
5666 lookup_value = expand_getcertele(sub[0], sub[1]);
5667 if (*expand_string_message) goto EXPAND_FAILED;
5669 switch(process_yesno(
5670 skipping, /* were previously skipping */
5671 lookup_value != NULL, /* success/failure indicator */
5672 save_lookup_value, /* value to reset for string2 */
5673 &s, /* input pointer */
5674 &yield, /* output pointer */
5675 &size, /* output size */
5676 &ptr, /* output current point */
5677 US"certextract", /* condition type */
5680 case 1: goto EXPAND_FAILED; /* when all is well, the */
5681 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5684 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5685 save_expand_nlength);
5688 #endif /*SUPPORT_TLS*/
5690 /* Handle list operations */
5698 uschar outsep[2] = { '\0', '\0' };
5699 const uschar *list, *expr, *temp;
5700 uschar *save_iterate_item = iterate_item;
5701 uschar *save_lookup_value = lookup_value;
5703 while (isspace(*s)) s++;
5706 expand_string_message =
5707 string_sprintf("missing '{' for first arg of %s", name);
5708 goto EXPAND_FAILED_CURLY;
5711 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5712 if (list == NULL) goto EXPAND_FAILED;
5715 expand_string_message =
5716 string_sprintf("missing '}' closing first arg of %s", name);
5717 goto EXPAND_FAILED_CURLY;
5720 if (item_type == EITEM_REDUCE)
5723 while (isspace(*s)) s++;
5726 expand_string_message = US"missing '{' for second arg of reduce";
5727 goto EXPAND_FAILED_CURLY;
5729 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5730 if (!t) goto EXPAND_FAILED;
5734 expand_string_message = US"missing '}' closing second arg of reduce";
5735 goto EXPAND_FAILED_CURLY;
5739 while (isspace(*s)) s++;
5742 expand_string_message =
5743 string_sprintf("missing '{' for last arg of %s", name);
5744 goto EXPAND_FAILED_CURLY;
5749 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5750 if scanning a "false" part). This allows us to find the end of the
5751 condition, because if the list is empty, we won't actually evaluate the
5752 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5753 the normal internal expansion function. */
5755 if (item_type == EITEM_FILTER)
5757 temp = eval_condition(expr, &resetok, NULL);
5758 if (temp != NULL) s = temp;
5761 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5765 expand_string_message = string_sprintf("%s inside \"%s\" item",
5766 expand_string_message, name);
5770 while (isspace(*s)) s++;
5773 expand_string_message = string_sprintf("missing } at end of condition "
5774 "or expression inside \"%s\"", name);
5778 while (isspace(*s)) s++; /*{*/
5781 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5786 /* If we are skipping, we can now just move on to the next item. When
5787 processing for real, we perform the iteration. */
5789 if (skipping) continue;
5790 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5792 *outsep = (uschar)sep; /* Separator as a string */
5794 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5796 if (item_type == EITEM_FILTER)
5799 if (eval_condition(expr, &resetok, &condresult) == NULL)
5801 iterate_item = save_iterate_item;
5802 lookup_value = save_lookup_value;
5803 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5804 expand_string_message, name);
5807 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5808 condresult? "true":"false");
5810 temp = iterate_item; /* TRUE => include this item */
5812 continue; /* FALSE => skip this item */
5815 /* EITEM_MAP and EITEM_REDUCE */
5819 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5823 iterate_item = save_iterate_item;
5824 expand_string_message = string_sprintf("%s inside \"%s\" item",
5825 expand_string_message, name);
5828 if (item_type == EITEM_REDUCE)
5830 lookup_value = t; /* Update the value of $value */
5831 continue; /* and continue the iteration */
5835 /* We reach here for FILTER if the condition is true, always for MAP,
5836 and never for REDUCE. The value in "temp" is to be added to the output
5837 list that is being created, ensuring that any occurrences of the
5838 separator character are doubled. Unless we are dealing with the first
5839 item of the output list, add in a space if the new item begins with the
5840 separator character, or is an empty string. */
5842 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5843 yield = string_catn(yield, &size, &ptr, US" ", 1);
5845 /* Add the string in "temp" to the output list that we are building,
5846 This is done in chunks by searching for the separator character. */
5850 size_t seglen = Ustrcspn(temp, outsep);
5852 yield = string_catn(yield, &size, &ptr, temp, seglen + 1);
5854 /* If we got to the end of the string we output one character
5855 too many; backup and end the loop. Otherwise arrange to double the
5858 if (temp[seglen] == '\0') { ptr--; break; }
5859 yield = string_catn(yield, &size, &ptr, outsep, 1);
5863 /* Output a separator after the string: we will remove the redundant
5864 final one at the end. */
5866 yield = string_catn(yield, &size, &ptr, outsep, 1);
5867 } /* End of iteration over the list loop */
5869 /* REDUCE has generated no output above: output the final value of
5872 if (item_type == EITEM_REDUCE)
5874 yield = string_cat(yield, &size, &ptr, lookup_value);
5875 lookup_value = save_lookup_value; /* Restore $value */
5878 /* FILTER and MAP generate lists: if they have generated anything, remove
5879 the redundant final separator. Even though an empty item at the end of a
5880 list does not count, this is tidier. */
5882 else if (ptr != save_ptr) ptr--;
5884 /* Restore preserved $item */
5886 iterate_item = save_iterate_item;
5893 const uschar *srclist, *cmp, *xtract;
5895 const uschar *dstlist = NULL, *dstkeylist = NULL;
5897 uschar *save_iterate_item = iterate_item;
5899 while (isspace(*s)) s++;
5902 expand_string_message = US"missing '{' for list arg of sort";
5903 goto EXPAND_FAILED_CURLY;
5906 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5907 if (!srclist) goto EXPAND_FAILED;
5910 expand_string_message = US"missing '}' closing list arg of sort";
5911 goto EXPAND_FAILED_CURLY;
5914 while (isspace(*s)) s++;
5917 expand_string_message = US"missing '{' for comparator arg of sort";
5918 goto EXPAND_FAILED_CURLY;
5921 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5922 if (!cmp) goto EXPAND_FAILED;
5925 expand_string_message = US"missing '}' closing comparator arg of sort";
5926 goto EXPAND_FAILED_CURLY;
5929 while (isspace(*s)) s++;
5932 expand_string_message = US"missing '{' for extractor arg of sort";
5933 goto EXPAND_FAILED_CURLY;
5937 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5938 if (!tmp) goto EXPAND_FAILED;
5939 xtract = string_copyn(xtract, s - xtract);
5943 expand_string_message = US"missing '}' closing extractor arg of sort";
5944 goto EXPAND_FAILED_CURLY;
5949 expand_string_message = US"missing } at end of \"sort\"";
5953 if (skipping) continue;
5955 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5958 uschar * newlist = NULL;
5959 uschar * newkeylist = NULL;
5962 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, srcitem);
5964 /* extract field for comparisons */
5965 iterate_item = srcitem;
5966 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5970 expand_string_message = string_sprintf(
5971 "field-extract in sort: \"%s\"", xtract);
5975 /* Insertion sort */
5977 /* copy output list until new-item < list-item */
5978 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5984 /* field for comparison */
5985 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5988 /* build and run condition string */
5989 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
5991 DEBUG(D_expand) debug_printf("%s: cond = \"%s\"\n", name, expr);
5992 if (!eval_condition(expr, &resetok, &before))
5994 expand_string_message = string_sprintf("comparison in sort: %s",
6001 /* New-item sorts before this dst-item. Append new-item,
6002 then dst-item, then remainder of dst list. */
6004 newlist = string_append_listele(newlist, sep, srcitem);
6005 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6008 newlist = string_append_listele(newlist, sep, dstitem);
6009 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6011 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6013 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6015 newlist = string_append_listele(newlist, sep, dstitem);
6016 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6022 newlist = string_append_listele(newlist, sep, dstitem);
6023 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6026 /* If we ran out of dstlist without consuming srcitem, append it */
6029 newlist = string_append_listele(newlist, sep, srcitem);
6030 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6034 dstkeylist = newkeylist;
6036 DEBUG(D_expand) debug_printf("%s: dstlist = \"%s\"\n", name, dstlist);
6037 DEBUG(D_expand) debug_printf("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6041 yield = string_cat(yield, &size, &ptr, dstlist);
6043 /* Restore preserved $item */
6044 iterate_item = save_iterate_item;
6048 expand_string_message = US"Internal error in sort (list mismatch)";
6053 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6054 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6055 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6056 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6058 #define EXPAND_DLFUNC_MAX_ARGS 8
6061 #ifndef EXPAND_DLFUNC
6062 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6063 "is not included in this binary";
6066 #else /* EXPAND_DLFUNC */
6069 exim_dlfunc_t *func;
6072 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6074 if ((expand_forbid & RDO_DLFUNC) != 0)
6076 expand_string_message =
6077 US"dynamically-loaded functions are not permitted";
6081 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6082 TRUE, US"dlfunc", &resetok))
6084 case 1: goto EXPAND_FAILED_CURLY;
6086 case 3: goto EXPAND_FAILED;
6089 /* If skipping, we don't actually do anything */
6091 if (skipping) continue;
6093 /* Look up the dynamically loaded object handle in the tree. If it isn't
6094 found, dlopen() the file and put the handle in the tree for next time. */
6096 t = tree_search(dlobj_anchor, argv[0]);
6099 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6102 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6103 argv[0], dlerror());
6104 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6107 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6108 Ustrcpy(t->name, argv[0]);
6109 t->data.ptr = handle;
6110 (void)tree_insertnode(&dlobj_anchor, t);
6113 /* Having obtained the dynamically loaded object handle, look up the
6114 function pointer. */
6116 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6119 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6120 "%s", argv[1], argv[0], dlerror());
6121 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6125 /* Call the function and work out what to do with the result. If it
6126 returns OK, we have a replacement string; if it returns DEFER then
6127 expansion has failed in a non-forced manner; if it returns FAIL then
6128 failure was forced; if it returns ERROR or any other value there's a
6129 problem, so panic slightly. In any case, assume that the function has
6130 side-effects on the store that must be preserved. */
6134 for (argc = 0; argv[argc] != NULL; argc++);
6135 status = func(&result, argc - 2, &argv[2]);
6138 if (result == NULL) result = US"";
6139 yield = string_cat(yield, &size, &ptr, result);
6144 expand_string_message = result == NULL ? US"(no message)" : result;
6145 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
6146 else if(status != FAIL)
6147 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6148 argv[0], argv[1], status, expand_string_message);
6152 #endif /* EXPAND_DLFUNC */
6154 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6157 uschar *save_lookup_value = lookup_value;
6159 while (isspace(*s)) s++;
6160 if (*s != '{') /*}*/
6163 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6164 if (!key) goto EXPAND_FAILED; /*{*/
6167 expand_string_message = US"missing '{' for name arg of env";
6168 goto EXPAND_FAILED_CURLY;
6171 lookup_value = US getenv(CS key);
6173 switch(process_yesno(
6174 skipping, /* were previously skipping */
6175 lookup_value != NULL, /* success/failure indicator */
6176 save_lookup_value, /* value to reset for string2 */
6177 &s, /* input pointer */
6178 &yield, /* output pointer */
6179 &size, /* output size */
6180 &ptr, /* output current point */
6181 US"env", /* condition type */
6184 case 1: goto EXPAND_FAILED; /* when all is well, the */
6185 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6189 } /* EITEM_* switch */
6191 /* Control reaches here if the name is not recognized as one of the more
6192 complicated expansion items. Check for the "operator" syntax (name terminated
6193 by a colon). Some of the operators have arguments, separated by _ from the
6201 var_entry *vp = NULL;
6203 /* Owing to an historical mis-design, an underscore may be part of the
6204 operator name, or it may introduce arguments. We therefore first scan the
6205 table of names that contain underscores. If there is no match, we cut off
6206 the arguments and then scan the main table. */
6208 if ((c = chop_match(name, op_table_underscore,
6209 nelem(op_table_underscore))) < 0)
6211 arg = Ustrchr(name, '_');
6212 if (arg != NULL) *arg = 0;
6213 c = chop_match(name, op_table_main, nelem(op_table_main));
6214 if (c >= 0) c += nelem(op_table_underscore);
6215 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6218 /* Deal specially with operators that might take a certificate variable
6219 as we do not want to do the usual expansion. For most, expand the string.*/
6229 const uschar * s1 = s;
6230 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6232 if (!sub) goto EXPAND_FAILED; /*{*/
6235 expand_string_message =
6236 string_sprintf("missing '}' closing cert arg of %s", name);
6237 goto EXPAND_FAILED_CURLY;
6239 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6249 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6250 if (!sub) goto EXPAND_FAILED;
6255 /* If we are skipping, we don't need to perform the operation at all.
6256 This matters for operations like "mask", because the data may not be
6257 in the correct format when skipping. For example, the expression may test
6258 for the existence of $sender_host_address before trying to mask it. For
6259 other operations, doing them may not fail, but it is a waste of time. */
6261 if (skipping && c >= 0) continue;
6263 /* Otherwise, switch on the operator type */
6270 unsigned long int n = Ustrtoul(sub, &t, 10);
6276 expand_string_message = string_sprintf("argument for base32 "
6277 "operator is \"%s\", which is not a decimal number", sub);
6281 s = string_catn(s, &sz, &i, &base32_chars[n & 0x1f], 1);
6283 while (i > 0) yield = string_catn(yield, &size, &ptr, &s[--i], 1);
6290 unsigned long int n = 0;
6294 uschar * t = Ustrchr(base32_chars, *tt++);
6297 expand_string_message = string_sprintf("argument for base32d "
6298 "operator is \"%s\", which is not a base 32 number", sub);
6301 n = n * 32 + (t - base32_chars);
6303 s = string_sprintf("%ld", n);
6304 yield = string_cat(yield, &size, &ptr, s);
6311 unsigned long int n = Ustrtoul(sub, &t, 10);
6314 expand_string_message = string_sprintf("argument for base62 "
6315 "operator is \"%s\", which is not a decimal number", sub);
6318 t = string_base62(n);
6319 yield = string_cat(yield, &size, &ptr, t);
6323 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6329 unsigned long int n = 0;
6332 uschar *t = Ustrchr(base62_chars, *tt++);
6335 expand_string_message = string_sprintf("argument for base62d "
6336 "operator is \"%s\", which is not a base %d number", sub,
6340 n = n * BASE_62 + (t - base62_chars);
6342 (void)sprintf(CS buf, "%ld", n);
6343 yield = string_cat(yield, &size, &ptr, buf);
6349 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6350 if (expanded == NULL)
6352 expand_string_message =
6353 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6354 expand_string_message);
6357 yield = string_cat(yield, &size, &ptr, expanded);
6364 uschar *t = sub - 1;
6365 while (*(++t) != 0) { *t = tolower(*t); count++; }
6366 yield = string_catn(yield, &size, &ptr, sub, count);
6373 uschar *t = sub - 1;
6374 while (*(++t) != 0) { *t = toupper(*t); count++; }
6375 yield = string_catn(yield, &size, &ptr, sub, count);
6381 if (vp && *(void **)vp->value)
6383 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6384 yield = string_cat(yield, &size, &ptr, cp);
6394 md5_end(&base, sub, Ustrlen(sub), digest);
6395 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6396 yield = string_cat(yield, &size, &ptr, US st);
6402 if (vp && *(void **)vp->value)
6404 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6405 yield = string_cat(yield, &size, &ptr, cp);
6415 sha1_end(&h, sub, Ustrlen(sub), digest);
6416 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6417 yield = string_catn(yield, &size, &ptr, US st, 40);
6422 #ifdef EXIM_HAVE_SHA2
6423 if (vp && *(void **)vp->value)
6425 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6426 yield = string_cat(yield, &size, &ptr, cp);
6434 exim_sha_init(&h, HASH_SHA256);
6435 exim_sha_update(&h, sub, Ustrlen(sub));
6436 exim_sha_finish(&h, &b);
6439 sprintf(st, "%02X", *b.data++);
6440 yield = string_catn(yield, &size, &ptr, US st, 2);
6444 expand_string_message = US"sha256 only supported with TLS";
6449 #ifdef EXIM_HAVE_SHA3
6454 hashmethod m = !arg ? HASH_SHA3_256
6455 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
6456 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
6457 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
6458 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
6461 if (m == HASH_BADTYPE)
6463 expand_string_message = US"unrecognised sha3 variant";
6467 exim_sha_init(&h, m);
6468 exim_sha_update(&h, sub, Ustrlen(sub));
6469 exim_sha_finish(&h, &b);
6472 sprintf(st, "%02X", *b.data++);
6473 yield = string_catn(yield, &size, &ptr, US st, 2);
6478 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 +";
6482 /* Convert hex encoding to base64 encoding */
6492 for (enc = sub; *enc != 0; enc++)
6494 if (!isxdigit(*enc))
6496 expand_string_message = string_sprintf("\"%s\" is not a hex "
6505 expand_string_message = string_sprintf("\"%s\" contains an odd "
6506 "number of characters", sub);
6510 while ((c = *in++) != 0)
6512 if (isdigit(c)) c -= '0';
6513 else c = toupper(c) - 'A' + 10;
6525 enc = b64encode(sub, out - sub);
6526 yield = string_cat(yield, &size, &ptr, enc);
6530 /* Convert octets outside 0x21..0x7E to \xXX form */
6534 uschar *t = sub - 1;
6537 if (*t < 0x21 || 0x7E < *t)
6538 yield = string_catn(yield, &size, &ptr,
6539 string_sprintf("\\x%02x", *t), 4);
6541 yield = string_catn(yield, &size, &ptr, t, 1);
6546 /* count the number of list elements */
6555 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6556 cp = string_sprintf("%d", cnt);
6557 yield = string_cat(yield, &size, &ptr, cp);
6561 /* expand a named list given the name */
6562 /* handles nested named lists; requotes as colon-sep list */
6566 tree_node *t = NULL;
6567 const uschar * list;
6570 uschar * suffix = US"";
6571 BOOL needsep = FALSE;
6574 if (*sub == '+') sub++;
6575 if (arg == NULL) /* no-argument version */
6577 if (!(t = tree_search(addresslist_anchor, sub)) &&
6578 !(t = tree_search(domainlist_anchor, sub)) &&
6579 !(t = tree_search(hostlist_anchor, sub)))
6580 t = tree_search(localpartlist_anchor, sub);
6582 else switch(*arg) /* specific list-type version */
6584 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6585 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6586 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6587 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6589 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6595 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6597 : *arg=='a'?"address "
6598 : *arg=='d'?"domain "
6600 : *arg=='l'?"localpart "
6605 list = ((namedlist_block *)(t->data.ptr))->string;
6607 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6609 uschar * buf = US" : ";
6611 yield = string_catn(yield, &size, &ptr, buf, 3);
6615 if (*item == '+') /* list item is itself a named list */
6617 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6618 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6620 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6624 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6625 while ((cp= strpbrk((const char *)item, tok)))
6627 yield = string_catn(yield, &size, &ptr, item, cp-(char *)item);
6628 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6630 yield = string_catn(yield, &size, &ptr, US"::", 2);
6631 item = (uschar *)cp;
6633 else /* sep in item; should already be doubled; emit once */
6635 yield = string_catn(yield, &size, &ptr, (uschar *)tok, 1);
6636 if (*cp == sep) cp++;
6637 item = (uschar *)cp;
6641 yield = string_cat(yield, &size, &ptr, item);
6646 /* mask applies a mask to an IP address; for example the result of
6647 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6654 int mask, maskoffset;
6655 int type = string_is_ip_address(sub, &maskoffset);
6660 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6665 if (maskoffset == 0)
6667 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6672 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6674 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6676 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6681 /* Convert the address to binary integer(s) and apply the mask */
6683 sub[maskoffset] = 0;
6684 count = host_aton(sub, binary);
6685 host_mask(count, binary, mask);
6687 /* Convert to masked textual format and add to output. */
6689 yield = string_catn(yield, &size, &ptr, buffer,
6690 host_nmtoa(count, binary, mask, buffer, '.'));
6695 case EOP_IPV6DENORM:
6697 int type = string_is_ip_address(sub, NULL);
6704 (void) host_aton(sub, binary);
6707 case 4: /* convert to IPv4-mapped IPv6 */
6708 binary[0] = binary[1] = 0;
6709 binary[2] = 0x0000ffff;
6710 (void) host_aton(sub, binary+3);
6714 expand_string_message =
6715 string_sprintf("\"%s\" is not an IP address", sub);
6719 yield = string_catn(yield, &size, &ptr, buffer,
6721 ? ipv6_nmtoa(binary, buffer)
6722 : host_nmtoa(4, binary, -1, buffer, ':')
6728 case EOP_LOCAL_PART:
6732 int start, end, domain;
6733 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6737 if (c != EOP_DOMAIN)
6739 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6740 yield = string_catn(yield, &size, &ptr, sub+start, end-start);
6742 else if (domain != 0)
6745 yield = string_catn(yield, &size, &ptr, sub+domain, end-domain);
6753 uschar outsep[2] = { ':', '\0' };
6754 uschar *address, *error;
6756 int start, end, domain; /* Not really used */
6758 while (isspace(*sub)) sub++;
6759 if (*sub == '>') { *outsep = *++sub; ++sub; }
6760 parse_allow_group = TRUE;
6764 uschar *p = parse_find_address_end(sub, FALSE);
6765 uschar saveend = *p;
6767 address = parse_extract_address(sub, &error, &start, &end, &domain,
6771 /* Add the address to the output list that we are building. This is
6772 done in chunks by searching for the separator character. At the
6773 start, unless we are dealing with the first address of the output
6774 list, add in a space if the new address begins with the separator
6775 character, or is an empty string. */
6777 if (address != NULL)
6779 if (ptr != save_ptr && address[0] == *outsep)
6780 yield = string_catn(yield, &size, &ptr, US" ", 1);
6784 size_t seglen = Ustrcspn(address, outsep);
6785 yield = string_catn(yield, &size, &ptr, address, seglen + 1);
6787 /* If we got to the end of the string we output one character
6790 if (address[seglen] == '\0') { ptr--; break; }
6791 yield = string_catn(yield, &size, &ptr, outsep, 1);
6792 address += seglen + 1;
6795 /* Output a separator after the string: we will remove the
6796 redundant final one at the end. */
6798 yield = string_catn(yield, &size, &ptr, outsep, 1);
6801 if (saveend == '\0') break;
6805 /* If we have generated anything, remove the redundant final
6808 if (ptr != save_ptr) ptr--;
6809 parse_allow_group = FALSE;
6814 /* quote puts a string in quotes if it is empty or contains anything
6815 other than alphamerics, underscore, dot, or hyphen.
6817 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6818 be quoted in order to be a valid local part.
6820 In both cases, newlines and carriage returns are converted into \n and \r
6824 case EOP_QUOTE_LOCAL_PART:
6827 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6828 uschar *t = sub - 1;
6832 while (!needs_quote && *(++t) != 0)
6833 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6835 else /* EOP_QUOTE_LOCAL_PART */
6837 while (!needs_quote && *(++t) != 0)
6838 needs_quote = !isalnum(*t) &&
6839 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6840 (*t != '.' || t == sub || t[1] == 0);
6845 yield = string_catn(yield, &size, &ptr, US"\"", 1);
6850 yield = string_catn(yield, &size, &ptr, US"\\n", 2);
6851 else if (*t == '\r')
6852 yield = string_catn(yield, &size, &ptr, US"\\r", 2);
6855 if (*t == '\\' || *t == '"')
6856 yield = string_catn(yield, &size, &ptr, US"\\", 1);
6857 yield = string_catn(yield, &size, &ptr, t, 1);
6860 yield = string_catn(yield, &size, &ptr, US"\"", 1);
6862 else yield = string_cat(yield, &size, &ptr, sub);
6866 /* quote_lookuptype does lookup-specific quoting */
6871 uschar *opt = Ustrchr(arg, '_');
6873 if (opt != NULL) *opt++ = 0;
6875 n = search_findtype(arg, Ustrlen(arg));
6878 expand_string_message = search_error_message;
6882 if (lookup_list[n]->quote != NULL)
6883 sub = (lookup_list[n]->quote)(sub, opt);
6884 else if (opt != NULL) sub = NULL;
6888 expand_string_message = string_sprintf(
6889 "\"%s\" unrecognized after \"${quote_%s\"",
6894 yield = string_cat(yield, &size, &ptr, sub);
6898 /* rx quote sticks in \ before any non-alphameric character so that
6899 the insertion works in a regular expression. */
6903 uschar *t = sub - 1;
6907 yield = string_catn(yield, &size, &ptr, US"\\", 1);
6908 yield = string_catn(yield, &size, &ptr, t, 1);
6913 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6914 prescribed by the RFC, if there are characters that need to be encoded */
6918 uschar buffer[2048];
6919 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6920 buffer, sizeof(buffer), FALSE);
6921 yield = string_cat(yield, &size, &ptr, string);
6925 /* RFC 2047 decode */
6931 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6932 headers_charset, '?', &len, &error);
6935 expand_string_message = error;
6938 yield = string_catn(yield, &size, &ptr, decoded, len);
6942 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6952 if (c > 255) c = '_';
6954 yield = string_catn(yield, &size, &ptr, buff, 1);
6959 /* replace illegal UTF-8 sequences by replacement character */
6961 #define UTF8_REPLACEMENT_CHAR US"?"
6965 int seq_len = 0, index = 0;
6967 long codepoint = -1;
6968 uschar seq_buff[4]; /* accumulate utf-8 here */
6977 if ((c & 0xc0) != 0x80)
6978 /* wrong continuation byte; invalidate all bytes */
6979 complete = 1; /* error */
6982 codepoint = (codepoint << 6) | (c & 0x3f);
6983 seq_buff[index++] = c;
6984 if (--bytes_left == 0) /* codepoint complete */
6985 if(codepoint > 0x10FFFF) /* is it too large? */
6986 complete = -1; /* error (RFC3629 limit) */
6988 { /* finished; output utf-8 sequence */
6989 yield = string_catn(yield, &size, &ptr, seq_buff, seq_len);
6994 else /* no bytes left: new sequence */
6996 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6998 yield = string_catn(yield, &size, &ptr, &c, 1);
7001 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
7003 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
7008 codepoint = c & 0x1f;
7011 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
7014 codepoint = c & 0x0f;
7016 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
7019 codepoint = c & 0x07;
7021 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7024 seq_buff[index++] = c;
7025 seq_len = bytes_left + 1;
7026 } /* if(bytes_left) */
7030 bytes_left = index = 0;
7031 yield = string_catn(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
7033 if ((complete == 1) && ((c & 0x80) == 0))
7034 /* ASCII character follows incomplete sequence */
7035 yield = string_catn(yield, &size, &ptr, &c, 1);
7041 case EOP_UTF8_DOMAIN_TO_ALABEL:
7043 uschar * error = NULL;
7044 uschar * s = string_domain_utf8_to_alabel(sub, &error);
7047 expand_string_message = string_sprintf(
7048 "error converting utf8 (%s) to alabel: %s",
7049 string_printing(sub), error);
7052 yield = string_cat(yield, &size, &ptr, s);
7056 case EOP_UTF8_DOMAIN_FROM_ALABEL:
7058 uschar * error = NULL;
7059 uschar * s = string_domain_alabel_to_utf8(sub, &error);
7062 expand_string_message = string_sprintf(
7063 "error converting alabel (%s) to utf8: %s",
7064 string_printing(sub), error);
7067 yield = string_cat(yield, &size, &ptr, s);
7071 case EOP_UTF8_LOCALPART_TO_ALABEL:
7073 uschar * error = NULL;
7074 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7077 expand_string_message = string_sprintf(
7078 "error converting utf8 (%s) to alabel: %s",
7079 string_printing(sub), error);
7082 yield = string_cat(yield, &size, &ptr, s);
7083 DEBUG(D_expand) debug_printf("yield: '%s'\n", yield);
7087 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7089 uschar * error = NULL;
7090 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7093 expand_string_message = string_sprintf(
7094 "error converting alabel (%s) to utf8: %s",
7095 string_printing(sub), error);
7098 yield = string_cat(yield, &size, &ptr, s);
7101 #endif /* EXPERIMENTAL_INTERNATIONAL */
7103 /* escape turns all non-printing characters into escape sequences. */
7107 const uschar *t = string_printing(sub);
7108 yield = string_cat(yield, &size, &ptr, t);
7112 /* Handle numeric expression evaluation */
7117 uschar *save_sub = sub;
7118 uschar *error = NULL;
7119 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7122 expand_string_message = string_sprintf("error in expression "
7123 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
7127 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
7128 yield = string_cat(yield, &size, &ptr, var_buffer);
7132 /* Handle time period formating */
7136 int n = readconf_readtime(sub, 0, FALSE);
7139 expand_string_message = string_sprintf("string \"%s\" is not an "
7140 "Exim time interval in \"%s\" operator", sub, name);
7143 sprintf(CS var_buffer, "%d", n);
7144 yield = string_cat(yield, &size, &ptr, var_buffer);
7148 case EOP_TIME_INTERVAL:
7151 uschar *t = read_number(&n, sub);
7152 if (*t != 0) /* Not A Number*/
7154 expand_string_message = string_sprintf("string \"%s\" is not a "
7155 "positive number in \"%s\" operator", sub, name);
7158 t = readconf_printtime(n);
7159 yield = string_cat(yield, &size, &ptr, t);
7163 /* Convert string to base64 encoding */
7169 uschar * s = vp && *(void **)vp->value
7170 ? tls_cert_der_b64(*(void **)vp->value)
7171 : b64encode(sub, Ustrlen(sub));
7173 uschar * s = b64encode(sub, Ustrlen(sub));
7175 yield = string_cat(yield, &size, &ptr, s);
7182 int len = b64decode(sub, &s);
7185 expand_string_message = string_sprintf("string \"%s\" is not "
7186 "well-formed for \"%s\" operator", sub, name);
7189 yield = string_cat(yield, &size, &ptr, s);
7193 /* strlen returns the length of the string */
7198 (void)sprintf(CS buff, "%d", Ustrlen(sub));
7199 yield = string_cat(yield, &size, &ptr, buff);
7203 /* length_n or l_n takes just the first n characters or the whole string,
7204 whichever is the shorter;
7206 substr_m_n, and s_m_n take n characters from offset m; negative m take
7207 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7208 takes the rest, either to the right or to the left.
7210 hash_n or h_n makes a hash of length n from the string, yielding n
7211 characters from the set a-z; hash_n_m makes a hash of length n, but
7212 uses m characters from the set a-zA-Z0-9.
7214 nhash_n returns a single number between 0 and n-1 (in text form), while
7215 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7216 between 0 and n-1 and the second between 0 and m-1. */
7236 expand_string_message = string_sprintf("missing values after %s",
7241 /* "length" has only one argument, effectively being synonymous with
7244 if (c == EOP_LENGTH || c == EOP_L)
7250 /* The others have one or two arguments; for "substr" the first may be
7251 negative. The second being negative means "not supplied". */
7256 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7259 /* Read up to two numbers, separated by underscores */
7264 if (arg != ret && *arg == '_' && pn == &value1)
7268 if (arg[1] != 0) arg++;
7270 else if (!isdigit(*arg))
7272 expand_string_message =
7273 string_sprintf("non-digit after underscore in \"%s\"", name);
7276 else *pn = (*pn)*10 + *arg++ - '0';
7280 /* Perform the required operation */
7283 (c == EOP_HASH || c == EOP_H)?
7284 compute_hash(sub, value1, value2, &len) :
7285 (c == EOP_NHASH || c == EOP_NH)?
7286 compute_nhash(sub, value1, value2, &len) :
7287 extract_substr(sub, value1, value2, &len);
7289 if (ret == NULL) goto EXPAND_FAILED;
7290 yield = string_catn(yield, &size, &ptr, ret, len);
7300 uschar **modetable[3];
7305 if ((expand_forbid & RDO_EXISTS) != 0)
7307 expand_string_message = US"Use of the stat() expansion is not permitted";
7311 if (stat(CS sub, &st) < 0)
7313 expand_string_message = string_sprintf("stat(%s) failed: %s",
7314 sub, strerror(errno));
7318 switch (mode & S_IFMT)
7320 case S_IFIFO: smode[0] = 'p'; break;
7321 case S_IFCHR: smode[0] = 'c'; break;
7322 case S_IFDIR: smode[0] = 'd'; break;
7323 case S_IFBLK: smode[0] = 'b'; break;
7324 case S_IFREG: smode[0] = '-'; break;
7325 default: smode[0] = '?'; break;
7328 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7329 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7330 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7332 for (i = 0; i < 3; i++)
7334 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7339 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7340 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7341 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7342 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7343 (long)st.st_gid, st.st_size, (long)st.st_atime,
7344 (long)st.st_mtime, (long)st.st_ctime);
7345 yield = string_cat(yield, &size, &ptr, s);
7349 /* vaguely random number less than N */
7353 int_eximarith_t max;
7356 max = expanded_string_integer(sub, TRUE);
7357 if (expand_string_message != NULL)
7359 s = string_sprintf("%d", vaguely_random_number((int)max));
7360 yield = string_cat(yield, &size, &ptr, s);
7364 /* Reverse IP, including IPv6 to dotted-nibble */
7366 case EOP_REVERSE_IP:
7368 int family, maskptr;
7369 uschar reversed[128];
7371 family = string_is_ip_address(sub, &maskptr);
7374 expand_string_message = string_sprintf(
7375 "reverse_ip() not given an IP address [%s]", sub);
7378 invert_address(reversed, sub);
7379 yield = string_cat(yield, &size, &ptr, reversed);
7383 /* Unknown operator */
7386 expand_string_message =
7387 string_sprintf("unknown expansion operator \"%s\"", name);
7392 /* Handle a plain name. If this is the first thing in the expansion, release
7393 the pre-allocated buffer. If the result data is known to be in a new buffer,
7394 newsize will be set to the size of that buffer, and we can just point at that
7395 store instead of copying. Many expansion strings contain just one reference,
7396 so this is a useful optimization, especially for humungous headers
7397 ($message_headers). */
7405 if (resetok) store_reset(yield);
7409 value = find_variable(name, FALSE, skipping, &newsize);
7412 expand_string_message =
7413 string_sprintf("unknown variable in \"${%s}\"", name);
7414 check_variable_error_message(name);
7417 len = Ustrlen(value);
7418 if (yield == NULL && newsize != 0)
7424 else yield = string_catn(yield, &size, &ptr, value, len);
7428 /* Else there's something wrong */
7430 expand_string_message =
7431 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7432 "in a variable reference)", name);
7436 /* If we hit the end of the string when ket_ends is set, there is a missing
7437 terminating brace. */
7439 if (ket_ends && *s == 0)
7441 expand_string_message = malformed_header?
7442 US"missing } at end of string - could be header name not terminated by colon"
7444 US"missing } at end of string";
7448 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7449 added to the string. If so, set up an empty string. Add a terminating zero. If
7450 left != NULL, return a pointer to the terminator. */
7452 if (yield == NULL) yield = store_get(1);
7454 if (left != NULL) *left = s;
7456 /* Any stacking store that was used above the final string is no longer needed.
7457 In many cases the final string will be the first one that was got and so there
7458 will be optimal store usage. */
7460 if (resetok) store_reset(yield + ptr + 1);
7461 else if (resetok_p) *resetok_p = FALSE;
7465 debug_printf(" expanding: %.*s\n result: %s\n", (int)(s - string), string,
7467 if (skipping) debug_printf(" skipping: result is not used\n");
7471 /* This is the failure exit: easiest to program with a goto. We still need
7472 to update the pointer to the terminator, for cases of nested calls with "fail".
7475 EXPAND_FAILED_CURLY:
7476 if (malformed_header)
7477 expand_string_message =
7478 US"missing or misplaced { or } - could be header name not terminated by colon";
7480 else if (!expand_string_message || !*expand_string_message)
7481 expand_string_message = US"missing or misplaced { or }";
7483 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7484 that is a bad idea, because expand_string_message is in dynamic store. */
7487 if (left != NULL) *left = s;
7490 debug_printf("failed to expand: %s\n", string);
7491 debug_printf(" error message: %s\n", expand_string_message);
7492 if (expand_string_forcedfail) debug_printf("failure was forced\n");
7494 if (resetok_p) *resetok_p = resetok;
7499 /* This is the external function call. Do a quick check for any expansion
7500 metacharacters, and if there are none, just return the input string.
7502 Argument: the string to be expanded
7503 Returns: the expanded string, or NULL if expansion failed; if failure was
7504 due to a lookup deferring, search_find_defer will be TRUE
7508 expand_string(uschar *string)
7510 search_find_defer = FALSE;
7511 malformed_header = FALSE;
7512 return (Ustrpbrk(string, "$\\") == NULL)? string :
7513 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7519 expand_cstring(const uschar *string)
7521 search_find_defer = FALSE;
7522 malformed_header = FALSE;
7523 return (Ustrpbrk(string, "$\\") == NULL)? string :
7524 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7529 /*************************************************
7531 *************************************************/
7533 /* Now and again we want to expand a string and be sure that the result is in a
7534 new bit of store. This function does that.
7535 Since we know it has been copied, the de-const cast is safe.
7537 Argument: the string to be expanded
7538 Returns: the expanded string, always in a new bit of store, or NULL
7542 expand_string_copy(const uschar *string)
7544 const uschar *yield = expand_cstring(string);
7545 if (yield == string) yield = string_copy(string);
7551 /*************************************************
7552 * Expand and interpret as an integer *
7553 *************************************************/
7555 /* Expand a string, and convert the result into an integer.
7558 string the string to be expanded
7559 isplus TRUE if a non-negative number is expected
7561 Returns: the integer value, or
7562 -1 for an expansion error ) in both cases, message in
7563 -2 for an integer interpretation error ) expand_string_message
7564 expand_string_message is set NULL for an OK integer
7568 expand_string_integer(uschar *string, BOOL isplus)
7570 return expanded_string_integer(expand_string(string), isplus);
7574 /*************************************************
7575 * Interpret string as an integer *
7576 *************************************************/
7578 /* Convert a string (that has already been expanded) into an integer.
7580 This function is used inside the expansion code.
7583 s the string to be expanded
7584 isplus TRUE if a non-negative number is expected
7586 Returns: the integer value, or
7587 -1 if string is NULL (which implies an expansion error)
7588 -2 for an integer interpretation error
7589 expand_string_message is set NULL for an OK integer
7592 static int_eximarith_t
7593 expanded_string_integer(const uschar *s, BOOL isplus)
7595 int_eximarith_t value;
7596 uschar *msg = US"invalid integer \"%s\"";
7599 /* If expansion failed, expand_string_message will be set. */
7601 if (s == NULL) return -1;
7603 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7604 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7605 systems, so we set it zero ourselves. */
7608 expand_string_message = NULL; /* Indicates no error */
7610 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7611 equal to 0. Unfortunately, people actually relied upon that, so preserve
7612 the behaviour explicitly. Stripping leading whitespace is a harmless
7613 noop change since strtol skips it anyway (provided that there is a number
7617 while (isspace(*s)) ++s;
7621 debug_printf("treating blank string as number 0\n");
7626 value = strtoll(CS s, CSS &endptr, 10);
7630 msg = US"integer expected but \"%s\" found";
7632 else if (value < 0 && isplus)
7634 msg = US"non-negative integer expected but \"%s\" found";
7638 switch (tolower(*endptr))
7643 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7648 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7649 else value *= 1024*1024;
7653 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7654 else value *= 1024*1024*1024;
7658 if (errno == ERANGE)
7659 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7662 while (isspace(*endptr)) endptr++;
7663 if (*endptr == 0) return value;
7667 expand_string_message = string_sprintf(CS msg, s);
7672 /* These values are usually fixed boolean values, but they are permitted to be
7676 addr address being routed
7677 mtype the module type
7678 mname the module name
7679 dbg_opt debug selectors
7680 oname the option name
7681 bvalue the router's boolean value
7682 svalue the router's string value
7683 rvalue where to put the returned value
7685 Returns: OK value placed in rvalue
7686 DEFER expansion failed
7690 exp_bool(address_item *addr,
7691 uschar *mtype, uschar *mname, unsigned dbg_opt,
7692 uschar *oname, BOOL bvalue,
7693 uschar *svalue, BOOL *rvalue)
7696 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7698 expanded = expand_string(svalue);
7699 if (expanded == NULL)
7701 if (expand_string_forcedfail)
7703 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7707 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7708 oname, mname, mtype, expand_string_message);
7709 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7713 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7716 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7718 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7722 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7723 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7732 /* Avoid potentially exposing a password in a string about to be logged */
7735 expand_hide_passwords(uschar * s)
7737 return ( ( Ustrstr(s, "failed to expand") != NULL
7738 || Ustrstr(s, "expansion of ") != NULL
7740 && ( Ustrstr(s, "mysql") != NULL
7741 || Ustrstr(s, "pgsql") != NULL
7742 || Ustrstr(s, "redis") != NULL
7743 || Ustrstr(s, "sqlite") != NULL
7744 || Ustrstr(s, "ldap:") != NULL
7745 || Ustrstr(s, "ldaps:") != NULL
7746 || Ustrstr(s, "ldapi:") != NULL
7747 || Ustrstr(s, "ldapdn:") != NULL
7748 || Ustrstr(s, "ldapm:") != NULL
7750 ? US"Temporary internal error" : s;
7756 /*************************************************
7757 **************************************************
7758 * Stand-alone test program *
7759 **************************************************
7760 *************************************************/
7766 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7768 int ovector[3*(EXPAND_MAXN+1)];
7769 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7770 ovector, nelem(ovector));
7771 BOOL yield = n >= 0;
7772 if (n == 0) n = EXPAND_MAXN + 1;
7776 expand_nmax = (setup < 0)? 0 : setup + 1;
7777 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7779 expand_nstring[expand_nmax] = subject + ovector[nn];
7780 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7788 int main(int argc, uschar **argv)
7791 uschar buffer[1024];
7793 debug_selector = D_v;
7794 debug_file = stderr;
7795 debug_fd = fileno(debug_file);
7796 big_buffer = malloc(big_buffer_size);
7798 for (i = 1; i < argc; i++)
7800 if (argv[i][0] == '+')
7802 debug_trace_memory = 2;
7805 if (isdigit(argv[i][0]))
7806 debug_selector = Ustrtol(argv[i], NULL, 0);
7808 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7812 eldap_default_servers = argv[i];
7815 mysql_servers = argv[i];
7818 pgsql_servers = argv[i];
7821 redis_servers = argv[i];
7825 else opt_perl_startup = argv[i];
7829 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7831 expand_nstring[1] = US"string 1....";
7832 expand_nlength[1] = 8;
7836 if (opt_perl_startup != NULL)
7839 printf("Starting Perl interpreter\n");
7840 errstr = init_perl(opt_perl_startup);
7843 printf("** error in perl_startup code: %s\n", errstr);
7844 return EXIT_FAILURE;
7847 #endif /* EXIM_PERL */
7849 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7851 void *reset_point = store_get(0);
7852 uschar *yield = expand_string(buffer);
7855 printf("%s\n", yield);
7856 store_reset(reset_point);
7860 if (search_find_defer) printf("search_find deferred\n");
7861 printf("Failed: %s\n", expand_string_message);
7862 if (expand_string_forcedfail) printf("Forced failure\n");
7876 /* End of expand.c */