1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *);
17 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
20 #ifndef SUPPORT_CRYPTEQ
21 #define SUPPORT_CRYPTEQ
26 #include "lookups/ldap.h"
29 #ifdef SUPPORT_CRYPTEQ
34 extern char* crypt16(char*, char*);
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. Charaters after the first 16 are ignored. It always generates
50 a 16-byte hash, which is expressed together with the salt as a string
51 of 24 base 64 digits. Here are some links to peruse:
53 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
54 http://seclists.org/bugtraq/1999/Mar/0076.html
56 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
57 and OSF/1. This is the same as the standard crypt if given a password
58 of 8 characters or less. If given more, it first does the same as crypt
59 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
60 using as salt the first two base 64 digits from the first hash block.
61 If the password is more than 16 characters then it crypts the 17th to 24th
62 characters using as salt the first two base 64 digits from the second hash
63 block. And so on: I've seen references to it cutting off the password at
64 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
66 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
67 http://seclists.org/bugtraq/1999/Mar/0109.html
68 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
69 TET1_html/sec.c222.html#no_id_208
71 Exim has something it calls "crypt16". It will either use a native
72 crypt16 or its own implementation. A native crypt16 will presumably
73 be the one that I called "crypt16" above. The internal "crypt16"
74 function, however, is a two-block-maximum implementation of what I called
75 "bigcrypt". The documentation matches the internal code.
77 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
78 that crypt16 and bigcrypt were different things.
80 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
81 to whatever it is using under that name. This unfortunately sets a
82 precedent for using "{crypt16}" to identify two incompatible algorithms
83 whose output can't be distinguished. With "{crypt16}" thus rendered
84 ambiguous, I suggest you deprecate it and invent two new identifiers
85 for the two algorithms.
87 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
88 of the password separately means they can be cracked separately, so
89 the double-length hash only doubles the cracking effort instead of
90 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
114 #ifdef EXPERIMENTAL_INTERNATIONAL
144 #ifdef EXPERIMENTAL_INTERNATIONAL
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",
176 #ifdef EXPERIMENTAL_INTERNATIONAL
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,
191 #ifdef EXPERIMENTAL_INTERNATIONAL
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[] = {
238 EOP_ADDRESS = nelem(op_table_underscore),
276 /* Table of condition names, and corresponding switch numbers. The names must
277 be in alphabetical order. */
279 static uschar *cond_table[] = {
283 US"==", /* Backward compatibility */
316 US"match_local_part",
341 ECOND_FIRST_DELIVERY,
362 ECOND_MATCH_LOCAL_PART,
372 /* Types of table entry */
375 vtype_int, /* value is address of int */
376 vtype_filter_int, /* ditto, but recognized only when filtering */
377 vtype_ino, /* value is address of ino_t (not always an int) */
378 vtype_uid, /* value is address of uid_t (not always an int) */
379 vtype_gid, /* value is address of gid_t (not always an int) */
380 vtype_bool, /* value is address of bool */
381 vtype_stringptr, /* value is address of pointer to string */
382 vtype_msgbody, /* as stringptr, but read when first required */
383 vtype_msgbody_end, /* ditto, the end of the message */
384 vtype_msgheaders, /* the message's headers, processed */
385 vtype_msgheaders_raw, /* the message's headers, unprocessed */
386 vtype_localpart, /* extract local part from string */
387 vtype_domain, /* extract domain from string */
388 vtype_string_func, /* value is string returned by given function */
389 vtype_todbsdin, /* value not used; generate BSD inbox tod */
390 vtype_tode, /* value not used; generate tod in epoch format */
391 vtype_todel, /* value not used; generate tod in epoch/usec format */
392 vtype_todf, /* value not used; generate full tod */
393 vtype_todl, /* value not used; generate log tod */
394 vtype_todlf, /* value not used; generate log file datestamp tod */
395 vtype_todzone, /* value not used; generate time zone only */
396 vtype_todzulu, /* value not used; generate zulu tod */
397 vtype_reply, /* value not used; get reply from headers */
398 vtype_pid, /* value not used; result is pid */
399 vtype_host_lookup, /* value not used; get host name */
400 vtype_load_avg, /* value not used; result is int from os_getloadavg */
401 vtype_pspace, /* partition space; value is T/F for spool/log */
402 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
403 vtype_cert /* SSL certificate */
405 ,vtype_dkim /* Lookup of value in DKIM signature */
409 /* Type for main variable table */
417 /* Type for entries pointing to address/length pairs. Not currently
425 static uschar * fn_recipients(void);
427 /* This table must be kept in alphabetical order. */
429 static var_entry var_table[] = {
430 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
431 they will be confused with user-creatable ACL variables. */
432 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
433 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
434 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
435 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
436 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
437 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
438 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
439 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
440 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
441 { "acl_narg", vtype_int, &acl_narg },
442 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
443 { "address_data", vtype_stringptr, &deliver_address_data },
444 { "address_file", vtype_stringptr, &address_file },
445 { "address_pipe", vtype_stringptr, &address_pipe },
446 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
447 { "authenticated_id", vtype_stringptr, &authenticated_id },
448 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
449 { "authentication_failed",vtype_int, &authentication_failed },
450 #ifdef WITH_CONTENT_SCAN
451 { "av_failed", vtype_int, &av_failed },
453 #ifdef EXPERIMENTAL_BRIGHTMAIL
454 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
455 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
456 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
457 { "bmi_deliver", vtype_int, &bmi_deliver },
459 { "body_linecount", vtype_int, &body_linecount },
460 { "body_zerocount", vtype_int, &body_zerocount },
461 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
462 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
463 { "caller_gid", vtype_gid, &real_gid },
464 { "caller_uid", vtype_uid, &real_uid },
465 { "callout_address", vtype_stringptr, &callout_address },
466 { "compile_date", vtype_stringptr, &version_date },
467 { "compile_number", vtype_stringptr, &version_cnumber },
468 { "config_dir", vtype_stringptr, &config_main_directory },
469 { "config_file", vtype_stringptr, &config_main_filename },
470 { "csa_status", vtype_stringptr, &csa_status },
471 #ifdef EXPERIMENTAL_DCC
472 { "dcc_header", vtype_stringptr, &dcc_header },
473 { "dcc_result", vtype_stringptr, &dcc_result },
475 #ifdef WITH_OLD_DEMIME
476 { "demime_errorlevel", vtype_int, &demime_errorlevel },
477 { "demime_reason", vtype_stringptr, &demime_reason },
480 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
481 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
482 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
483 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
484 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
485 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
486 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
487 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
488 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
489 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
490 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
491 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
492 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
493 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
494 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
495 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
496 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
497 { "dkim_signers", vtype_stringptr, &dkim_signers },
498 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
499 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
501 #ifdef EXPERIMENTAL_DMARC
502 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
503 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
504 { "dmarc_status", vtype_stringptr, &dmarc_status },
505 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
506 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
508 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
509 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
510 { "dnslist_text", vtype_stringptr, &dnslist_text },
511 { "dnslist_value", vtype_stringptr, &dnslist_value },
512 { "domain", vtype_stringptr, &deliver_domain },
513 { "domain_data", vtype_stringptr, &deliver_domain_data },
514 #ifdef EXPERIMENTAL_EVENT
515 { "event_data", vtype_stringptr, &event_data },
517 /*XXX want to use generic vars for as many of these as possible*/
518 { "event_defer_errno", vtype_int, &event_defer_errno },
520 { "event_name", vtype_stringptr, &event_name },
522 { "exim_gid", vtype_gid, &exim_gid },
523 { "exim_path", vtype_stringptr, &exim_path },
524 { "exim_uid", vtype_uid, &exim_uid },
525 { "exim_version", vtype_stringptr, &version_string },
526 #ifdef WITH_OLD_DEMIME
527 { "found_extension", vtype_stringptr, &found_extension },
529 { "headers_added", vtype_string_func, &fn_hdrs_added },
530 { "home", vtype_stringptr, &deliver_home },
531 { "host", vtype_stringptr, &deliver_host },
532 { "host_address", vtype_stringptr, &deliver_host_address },
533 { "host_data", vtype_stringptr, &host_data },
534 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
535 { "host_lookup_failed", vtype_int, &host_lookup_failed },
536 { "host_port", vtype_int, &deliver_host_port },
537 { "inode", vtype_ino, &deliver_inode },
538 { "interface_address", vtype_stringptr, &interface_address },
539 { "interface_port", vtype_int, &interface_port },
540 { "item", vtype_stringptr, &iterate_item },
542 { "ldap_dn", vtype_stringptr, &eldap_dn },
544 { "load_average", vtype_load_avg, NULL },
545 { "local_part", vtype_stringptr, &deliver_localpart },
546 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
547 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
548 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
549 { "local_scan_data", vtype_stringptr, &local_scan_data },
550 { "local_user_gid", vtype_gid, &local_user_gid },
551 { "local_user_uid", vtype_uid, &local_user_uid },
552 { "localhost_number", vtype_int, &host_number },
553 { "log_inodes", vtype_pinodes, (void *)FALSE },
554 { "log_space", vtype_pspace, (void *)FALSE },
555 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
556 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
557 #ifdef WITH_CONTENT_SCAN
558 { "malware_name", vtype_stringptr, &malware_name },
560 { "max_received_linelength", vtype_int, &max_received_linelength },
561 { "message_age", vtype_int, &message_age },
562 { "message_body", vtype_msgbody, &message_body },
563 { "message_body_end", vtype_msgbody_end, &message_body_end },
564 { "message_body_size", vtype_int, &message_body_size },
565 { "message_exim_id", vtype_stringptr, &message_id },
566 { "message_headers", vtype_msgheaders, NULL },
567 { "message_headers_raw", vtype_msgheaders_raw, NULL },
568 { "message_id", vtype_stringptr, &message_id },
569 { "message_linecount", vtype_int, &message_linecount },
570 { "message_size", vtype_int, &message_size },
571 #ifdef EXPERIMENTAL_INTERNATIONAL
572 { "message_smtputf8", vtype_bool, &message_smtputf8 },
574 #ifdef WITH_CONTENT_SCAN
575 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
576 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
577 { "mime_boundary", vtype_stringptr, &mime_boundary },
578 { "mime_charset", vtype_stringptr, &mime_charset },
579 { "mime_content_description", vtype_stringptr, &mime_content_description },
580 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
581 { "mime_content_id", vtype_stringptr, &mime_content_id },
582 { "mime_content_size", vtype_int, &mime_content_size },
583 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
584 { "mime_content_type", vtype_stringptr, &mime_content_type },
585 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
586 { "mime_filename", vtype_stringptr, &mime_filename },
587 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
588 { "mime_is_multipart", vtype_int, &mime_is_multipart },
589 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
590 { "mime_part_count", vtype_int, &mime_part_count },
592 { "n0", vtype_filter_int, &filter_n[0] },
593 { "n1", vtype_filter_int, &filter_n[1] },
594 { "n2", vtype_filter_int, &filter_n[2] },
595 { "n3", vtype_filter_int, &filter_n[3] },
596 { "n4", vtype_filter_int, &filter_n[4] },
597 { "n5", vtype_filter_int, &filter_n[5] },
598 { "n6", vtype_filter_int, &filter_n[6] },
599 { "n7", vtype_filter_int, &filter_n[7] },
600 { "n8", vtype_filter_int, &filter_n[8] },
601 { "n9", vtype_filter_int, &filter_n[9] },
602 { "original_domain", vtype_stringptr, &deliver_domain_orig },
603 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
604 { "originator_gid", vtype_gid, &originator_gid },
605 { "originator_uid", vtype_uid, &originator_uid },
606 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
607 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
608 { "pid", vtype_pid, NULL },
609 { "primary_hostname", vtype_stringptr, &primary_hostname },
610 #ifdef EXPERIMENTAL_PROXY
611 { "proxy_host_address", vtype_stringptr, &proxy_host_address },
612 { "proxy_host_port", vtype_int, &proxy_host_port },
613 { "proxy_session", vtype_bool, &proxy_session },
614 { "proxy_target_address",vtype_stringptr, &proxy_target_address },
615 { "proxy_target_port", vtype_int, &proxy_target_port },
617 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
618 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
619 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
620 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
621 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
622 { "rcpt_count", vtype_int, &rcpt_count },
623 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
624 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
625 { "received_count", vtype_int, &received_count },
626 { "received_for", vtype_stringptr, &received_for },
627 { "received_ip_address", vtype_stringptr, &interface_address },
628 { "received_port", vtype_int, &interface_port },
629 { "received_protocol", vtype_stringptr, &received_protocol },
630 { "received_time", vtype_int, &received_time },
631 { "recipient_data", vtype_stringptr, &recipient_data },
632 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
633 { "recipients", vtype_string_func, &fn_recipients },
634 { "recipients_count", vtype_int, &recipients_count },
635 #ifdef WITH_CONTENT_SCAN
636 { "regex_match_string", vtype_stringptr, ®ex_match_string },
638 { "reply_address", vtype_reply, NULL },
639 { "return_path", vtype_stringptr, &return_path },
640 { "return_size_limit", vtype_int, &bounce_return_size_limit },
641 { "router_name", vtype_stringptr, &router_name },
642 { "runrc", vtype_int, &runrc },
643 { "self_hostname", vtype_stringptr, &self_hostname },
644 { "sender_address", vtype_stringptr, &sender_address },
645 { "sender_address_data", vtype_stringptr, &sender_address_data },
646 { "sender_address_domain", vtype_domain, &sender_address },
647 { "sender_address_local_part", vtype_localpart, &sender_address },
648 { "sender_data", vtype_stringptr, &sender_data },
649 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
650 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
651 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
652 { "sender_host_address", vtype_stringptr, &sender_host_address },
653 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
654 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
655 { "sender_host_name", vtype_host_lookup, NULL },
656 { "sender_host_port", vtype_int, &sender_host_port },
657 { "sender_ident", vtype_stringptr, &sender_ident },
658 { "sender_rate", vtype_stringptr, &sender_rate },
659 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
660 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
661 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
662 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
663 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
664 { "sending_port", vtype_int, &sending_port },
665 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
666 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
667 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
668 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
669 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
670 { "sn0", vtype_filter_int, &filter_sn[0] },
671 { "sn1", vtype_filter_int, &filter_sn[1] },
672 { "sn2", vtype_filter_int, &filter_sn[2] },
673 { "sn3", vtype_filter_int, &filter_sn[3] },
674 { "sn4", vtype_filter_int, &filter_sn[4] },
675 { "sn5", vtype_filter_int, &filter_sn[5] },
676 { "sn6", vtype_filter_int, &filter_sn[6] },
677 { "sn7", vtype_filter_int, &filter_sn[7] },
678 { "sn8", vtype_filter_int, &filter_sn[8] },
679 { "sn9", vtype_filter_int, &filter_sn[9] },
680 #ifdef WITH_CONTENT_SCAN
681 { "spam_action", vtype_stringptr, &spam_action },
682 { "spam_bar", vtype_stringptr, &spam_bar },
683 { "spam_report", vtype_stringptr, &spam_report },
684 { "spam_score", vtype_stringptr, &spam_score },
685 { "spam_score_int", vtype_stringptr, &spam_score_int },
687 #ifdef EXPERIMENTAL_SPF
688 { "spf_guess", vtype_stringptr, &spf_guess },
689 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
690 { "spf_received", vtype_stringptr, &spf_received },
691 { "spf_result", vtype_stringptr, &spf_result },
692 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
694 { "spool_directory", vtype_stringptr, &spool_directory },
695 { "spool_inodes", vtype_pinodes, (void *)TRUE },
696 { "spool_space", vtype_pspace, (void *)TRUE },
697 #ifdef EXPERIMENTAL_SRS
698 { "srs_db_address", vtype_stringptr, &srs_db_address },
699 { "srs_db_key", vtype_stringptr, &srs_db_key },
700 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
701 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
702 { "srs_recipient", vtype_stringptr, &srs_recipient },
703 { "srs_status", vtype_stringptr, &srs_status },
705 { "thisaddress", vtype_stringptr, &filter_thisaddress },
707 /* The non-(in,out) variables are now deprecated */
708 { "tls_bits", vtype_int, &tls_in.bits },
709 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
710 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
712 { "tls_in_bits", vtype_int, &tls_in.bits },
713 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
714 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
715 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
716 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
717 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
718 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
719 #if defined(SUPPORT_TLS)
720 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
722 { "tls_out_bits", vtype_int, &tls_out.bits },
723 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
724 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
725 #ifdef EXPERIMENTAL_DANE
726 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
728 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
729 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
730 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
731 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
732 #if defined(SUPPORT_TLS)
733 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
735 #ifdef EXPERIMENTAL_DANE
736 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
739 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
740 #if defined(SUPPORT_TLS)
741 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
744 { "tod_bsdinbox", vtype_todbsdin, NULL },
745 { "tod_epoch", vtype_tode, NULL },
746 { "tod_epoch_l", vtype_todel, NULL },
747 { "tod_full", vtype_todf, NULL },
748 { "tod_log", vtype_todl, NULL },
749 { "tod_logfile", vtype_todlf, NULL },
750 { "tod_zone", vtype_todzone, NULL },
751 { "tod_zulu", vtype_todzulu, NULL },
752 { "transport_name", vtype_stringptr, &transport_name },
753 { "value", vtype_stringptr, &lookup_value },
754 { "verify_mode", vtype_stringptr, &verify_mode },
755 { "version_number", vtype_stringptr, &version_string },
756 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
757 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
758 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
759 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
760 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
761 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
764 static int var_table_size = nelem(var_table);
765 static uschar var_buffer[256];
766 static BOOL malformed_header;
768 /* For textual hashes */
770 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
771 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
774 enum { HMAC_MD5, HMAC_SHA1 };
776 /* For numeric hashes */
778 static unsigned int prime[] = {
779 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
780 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
781 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
783 /* For printing modes in symbolic form */
785 static uschar *mtable_normal[] =
786 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
788 static uschar *mtable_setid[] =
789 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
791 static uschar *mtable_sticky[] =
792 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
796 /*************************************************
797 * Tables for UTF-8 support *
798 *************************************************/
800 /* Table of the number of extra characters, indexed by the first character
801 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
804 static uschar utf8_table1[] = {
805 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
806 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
807 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
808 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
810 /* These are the masks for the data bits in the first byte of a character,
811 indexed by the number of additional bytes. */
813 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
815 /* Get the next UTF-8 character, advancing the pointer. */
817 #define GETUTF8INC(c, ptr) \
819 if ((c & 0xc0) == 0xc0) \
821 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
823 c = (c & utf8_table2[a]) << s; \
827 c |= (*ptr++ & 0x3f) << s; \
832 /*************************************************
833 * Binary chop search on a table *
834 *************************************************/
836 /* This is used for matching expansion items and operators.
839 name the name that is being sought
840 table the table to search
841 table_size the number of items in the table
843 Returns: the offset in the table, or -1
847 chop_match(uschar *name, uschar **table, int table_size)
849 uschar **bot = table;
850 uschar **top = table + table_size;
854 uschar **mid = bot + (top - bot)/2;
855 int c = Ustrcmp(name, *mid);
856 if (c == 0) return mid - table;
857 if (c > 0) bot = mid + 1; else top = mid;
865 /*************************************************
866 * Check a condition string *
867 *************************************************/
869 /* This function is called to expand a string, and test the result for a "true"
870 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
871 forced fail or lookup defer.
873 We used to release all store used, but this is not not safe due
874 to ${dlfunc } and ${acl }. In any case expand_string_internal()
875 is reasonably careful to release what it can.
877 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
880 condition the condition string
881 m1 text to be incorporated in panic error
884 Returns: TRUE if condition is met, FALSE if not
888 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
891 uschar *ss = expand_string(condition);
894 if (!expand_string_forcedfail && !search_find_defer)
895 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
896 "for %s %s: %s", condition, m1, m2, expand_string_message);
899 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
900 strcmpic(ss, US"false") != 0;
907 /*************************************************
908 * Pseudo-random number generation *
909 *************************************************/
911 /* Pseudo-random number generation. The result is not "expected" to be
912 cryptographically strong but not so weak that someone will shoot themselves
913 in the foot using it as a nonce in some email header scheme or whatever
914 weirdness they'll twist this into. The result should ideally handle fork().
916 However, if we're stuck unable to provide this, then we'll fall back to
917 appallingly bad randomness.
919 If SUPPORT_TLS is defined then this will not be used except as an emergency
924 Returns a random number in range [0, max-1]
928 # define vaguely_random_number vaguely_random_number_fallback
931 vaguely_random_number(int max)
934 # undef vaguely_random_number
936 static pid_t pid = 0;
938 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
948 #ifdef HAVE_ARC4RANDOM
949 /* cryptographically strong randomness, common on *BSD platforms, not
950 so much elsewhere. Alas. */
951 #ifndef NOT_HAVE_ARC4RANDOM_STIR
954 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
955 #ifdef HAVE_SRANDOMDEV
956 /* uses random(4) for seeding */
959 gettimeofday(&tv, NULL);
960 srandom(tv.tv_sec | tv.tv_usec | getpid());
963 /* Poor randomness and no seeding here */
970 #ifdef HAVE_ARC4RANDOM
971 return arc4random() % max;
972 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
973 return random() % max;
975 /* This one returns a 16-bit number, definitely not crypto-strong */
976 return random_number(max);
983 /*************************************************
984 * Pick out a name from a string *
985 *************************************************/
987 /* If the name is too long, it is silently truncated.
990 name points to a buffer into which to put the name
991 max is the length of the buffer
992 s points to the first alphabetic character of the name
993 extras chars other than alphanumerics to permit
995 Returns: pointer to the first character after the name
997 Note: The test for *s != 0 in the while loop is necessary because
998 Ustrchr() yields non-NULL if the character is zero (which is not something
1001 static const uschar *
1002 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1005 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1007 if (ptr < max-1) name[ptr++] = *s;
1016 /*************************************************
1017 * Pick out the rest of a header name *
1018 *************************************************/
1020 /* A variable name starting $header_ (or just $h_ for those who like
1021 abbreviations) might not be the complete header name because headers can
1022 contain any printing characters in their names, except ':'. This function is
1023 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1024 on the end, if the name was terminated by white space.
1027 name points to a buffer in which the name read so far exists
1028 max is the length of the buffer
1029 s points to the first character after the name so far, i.e. the
1030 first non-alphameric character after $header_xxxxx
1032 Returns: a pointer to the first character after the header name
1035 static const uschar *
1036 read_header_name(uschar *name, int max, const uschar *s)
1038 int prelen = Ustrchr(name, '_') - name + 1;
1039 int ptr = Ustrlen(name) - prelen;
1040 if (ptr > 0) memmove(name, name+prelen, ptr);
1041 while (mac_isgraph(*s) && *s != ':')
1043 if (ptr < max-1) name[ptr++] = *s;
1054 /*************************************************
1055 * Pick out a number from a string *
1056 *************************************************/
1059 n points to an integer into which to put the number
1060 s points to the first digit of the number
1062 Returns: a pointer to the character after the last digit
1066 read_number(int *n, uschar *s)
1069 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1073 static const uschar *
1074 read_cnumber(int *n, const uschar *s)
1077 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1083 /*************************************************
1084 * Extract keyed subfield from a string *
1085 *************************************************/
1087 /* The yield is in dynamic store; NULL means that the key was not found.
1090 key points to the name of the key
1091 s points to the string from which to extract the subfield
1093 Returns: NULL if the subfield was not found, or
1094 a pointer to the subfield's data
1098 expand_getkeyed(uschar *key, const uschar *s)
1100 int length = Ustrlen(key);
1101 while (isspace(*s)) s++;
1103 /* Loop to search for the key */
1109 const uschar *dkey = s;
1111 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1112 dkeylength = s - dkey;
1113 while (isspace(*s)) s++;
1114 if (*s == '=') while (isspace((*(++s))));
1116 data = string_dequote(&s);
1117 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1120 while (isspace(*s)) s++;
1129 find_var_ent(uschar * name)
1132 int last = var_table_size;
1134 while (last > first)
1136 int middle = (first + last)/2;
1137 int c = Ustrcmp(name, var_table[middle].name);
1139 if (c > 0) { first = middle + 1; continue; }
1140 if (c < 0) { last = middle; continue; }
1141 return &var_table[middle];
1146 /*************************************************
1147 * Extract numbered subfield from string *
1148 *************************************************/
1150 /* Extracts a numbered field from a string that is divided by tokens - for
1151 example a line from /etc/passwd is divided by colon characters. First field is
1152 numbered one. Negative arguments count from the right. Zero returns the whole
1153 string. Returns NULL if there are insufficient tokens in the string
1156 Modifies final argument - this is a dynamically generated string, so that's OK.
1159 field number of field to be extracted,
1160 first field = 1, whole string = 0, last field = -1
1161 separators characters that are used to break string into tokens
1162 s points to the string from which to extract the subfield
1164 Returns: NULL if the field was not found,
1165 a pointer to the field's data inside s (modified to add 0)
1169 expand_gettokened (int field, uschar *separators, uschar *s)
1174 uschar *fieldtext = NULL;
1176 if (field == 0) return s;
1178 /* Break the line up into fields in place; for field > 0 we stop when we have
1179 done the number of fields we want. For field < 0 we continue till the end of
1180 the string, counting the number of fields. */
1182 count = (field > 0)? field : INT_MAX;
1188 /* Previous field was the last one in the string. For a positive field
1189 number, this means there are not enough fields. For a negative field number,
1190 check that there are enough, and scan back to find the one that is wanted. */
1194 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1195 if ((-field) == (INT_MAX - count - 1)) return s;
1199 while (ss[-1] != 0) ss--;
1205 /* Previous field was not last in the string; save its start and put a
1209 len = Ustrcspn(ss, separators);
1220 expand_getlistele(int field, const uschar * list)
1222 const uschar * tlist= list;
1228 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1231 if(field==0) return NULL;
1232 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1233 return string_nextinlist(&list, &sep, NULL, 0);
1237 /* Certificate fields, by name. Worry about by-OID later */
1238 /* Names are chosen to not have common prefixes */
1245 uschar * (*getfn)(void * cert, uschar * mod);
1247 static certfield certfields[] =
1248 { /* linear search; no special order */
1249 { US"version", 7, &tls_cert_version },
1250 { US"serial_number", 13, &tls_cert_serial_number },
1251 { US"subject", 7, &tls_cert_subject },
1252 { US"notbefore", 9, &tls_cert_not_before },
1253 { US"notafter", 8, &tls_cert_not_after },
1254 { US"issuer", 6, &tls_cert_issuer },
1255 { US"signature", 9, &tls_cert_signature },
1256 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1257 { US"subj_altname", 12, &tls_cert_subject_altname },
1258 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1259 { US"crl_uri", 7, &tls_cert_crl_uri },
1263 expand_getcertele(uschar * field, uschar * certvar)
1268 if (!(vp = find_var_ent(certvar)))
1270 expand_string_message =
1271 string_sprintf("no variable named \"%s\"", certvar);
1272 return NULL; /* Unknown variable name */
1274 /* NB this stops us passing certs around in variable. Might
1275 want to do that in future */
1276 if (vp->type != vtype_cert)
1278 expand_string_message =
1279 string_sprintf("\"%s\" is not a certificate", certvar);
1280 return NULL; /* Unknown variable name */
1282 if (!*(void **)vp->value)
1285 if (*field >= '0' && *field <= '9')
1286 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1288 for(cp = certfields;
1289 cp < certfields + nelem(certfields);
1291 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1293 uschar * modifier = *(field += cp->namelen) == ','
1295 return (*cp->getfn)( *(void **)vp->value, modifier );
1298 expand_string_message =
1299 string_sprintf("bad field selector \"%s\" for certextract", field);
1302 #endif /*SUPPORT_TLS*/
1304 /*************************************************
1305 * Extract a substring from a string *
1306 *************************************************/
1308 /* Perform the ${substr or ${length expansion operations.
1311 subject the input string
1312 value1 the offset from the start of the input string to the start of
1313 the output string; if negative, count from the right.
1314 value2 the length of the output string, or negative (-1) for unset
1315 if value1 is positive, unset means "all after"
1316 if value1 is negative, unset means "all before"
1317 len set to the length of the returned string
1319 Returns: pointer to the output string, or NULL if there is an error
1323 extract_substr(uschar *subject, int value1, int value2, int *len)
1325 int sublen = Ustrlen(subject);
1327 if (value1 < 0) /* count from right */
1331 /* If the position is before the start, skip to the start, and adjust the
1332 length. If the length ends up negative, the substring is null because nothing
1333 can precede. This falls out naturally when the length is unset, meaning "all
1339 if (value2 < 0) value2 = 0;
1343 /* Otherwise an unset length => characters before value1 */
1345 else if (value2 < 0)
1352 /* For a non-negative offset, if the starting position is past the end of the
1353 string, the result will be the null string. Otherwise, an unset length means
1354 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1358 if (value1 > sublen)
1363 else if (value2 < 0) value2 = sublen;
1366 /* Cut the length down to the maximum possible for the offset value, and get
1367 the required characters. */
1369 if (value1 + value2 > sublen) value2 = sublen - value1;
1371 return subject + value1;
1377 /*************************************************
1378 * Old-style hash of a string *
1379 *************************************************/
1381 /* Perform the ${hash expansion operation.
1384 subject the input string (an expanded substring)
1385 value1 the length of the output string; if greater or equal to the
1386 length of the input string, the input string is returned
1387 value2 the number of hash characters to use, or 26 if negative
1388 len set to the length of the returned string
1390 Returns: pointer to the output string, or NULL if there is an error
1394 compute_hash(uschar *subject, int value1, int value2, int *len)
1396 int sublen = Ustrlen(subject);
1398 if (value2 < 0) value2 = 26;
1399 else if (value2 > Ustrlen(hashcodes))
1401 expand_string_message =
1402 string_sprintf("hash count \"%d\" too big", value2);
1406 /* Calculate the hash text. We know it is shorter than the original string, so
1407 can safely place it in subject[] (we know that subject is always itself an
1408 expanded substring). */
1410 if (value1 < sublen)
1415 while ((c = (subject[j])) != 0)
1417 int shift = (c + j++) & 7;
1418 subject[i] ^= (c << shift) | (c >> (8-shift));
1419 if (++i >= value1) i = 0;
1421 for (i = 0; i < value1; i++)
1422 subject[i] = hashcodes[(subject[i]) % value2];
1424 else value1 = sublen;
1433 /*************************************************
1434 * Numeric hash of a string *
1435 *************************************************/
1437 /* Perform the ${nhash expansion operation. The first characters of the
1438 string are treated as most important, and get the highest prime numbers.
1441 subject the input string
1442 value1 the maximum value of the first part of the result
1443 value2 the maximum value of the second part of the result,
1444 or negative to produce only a one-part result
1445 len set to the length of the returned string
1447 Returns: pointer to the output string, or NULL if there is an error.
1451 compute_nhash (uschar *subject, int value1, int value2, int *len)
1453 uschar *s = subject;
1455 unsigned long int total = 0; /* no overflow */
1459 if (i == 0) i = nelem(prime) - 1;
1460 total += prime[i--] * (unsigned int)(*s++);
1463 /* If value2 is unset, just compute one number */
1467 s = string_sprintf("%d", total % value1);
1470 /* Otherwise do a div/mod hash */
1474 total = total % (value1 * value2);
1475 s = string_sprintf("%d/%d", total/value2, total % value2);
1486 /*************************************************
1487 * Find the value of a header or headers *
1488 *************************************************/
1490 /* Multiple instances of the same header get concatenated, and this function
1491 can also return a concatenation of all the header lines. When concatenating
1492 specific headers that contain lists of addresses, a comma is inserted between
1493 them. Otherwise we use a straight concatenation. Because some messages can have
1494 pathologically large number of lines, there is a limit on the length that is
1495 returned. Also, to avoid massive store use which would result from using
1496 string_cat() as it copies and extends strings, we do a preliminary pass to find
1497 out exactly how much store will be needed. On "normal" messages this will be
1501 name the name of the header, without the leading $header_ or $h_,
1502 or NULL if a concatenation of all headers is required
1503 exists_only TRUE if called from a def: test; don't need to build a string;
1504 just return a string that is not "" and not "0" if the header
1506 newsize return the size of memory block that was obtained; may be NULL
1507 if exists_only is TRUE
1508 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1509 other than concatenating, will be done on the header. Also used
1510 for $message_headers_raw.
1511 charset name of charset to translate MIME words to; used only if
1512 want_raw is false; if NULL, no translation is done (this is
1513 used for $bh_ and $bheader_)
1515 Returns: NULL if the header does not exist, else a pointer to a new
1520 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1523 BOOL found = name == NULL;
1525 int len = found? 0 : Ustrlen(name);
1527 uschar *yield = NULL;
1530 /* Loop for two passes - saves code repetition */
1532 for (i = 0; i < 2; i++)
1537 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1539 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1541 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1546 if (exists_only) return US"1"; /* don't need actual string */
1548 t = h->text + len; /* text to insert */
1549 if (!want_raw) /* unless wanted raw, */
1550 while (isspace(*t)) t++; /* remove leading white space */
1551 ilen = h->slen - (t - h->text); /* length to insert */
1553 /* Unless wanted raw, remove trailing whitespace, including the
1557 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1559 /* Set comma = 1 if handling a single header and it's one of those
1560 that contains an address list, except when asked for raw headers. Only
1561 need to do this once. */
1563 if (!want_raw && name != NULL && comma == 0 &&
1564 Ustrchr("BCFRST", h->type) != NULL)
1567 /* First pass - compute total store needed; second pass - compute
1568 total store used, including this header. */
1570 size += ilen + comma + 1; /* +1 for the newline */
1572 /* Second pass - concatentate the data, up to a maximum. Note that
1573 the loop stops when size hits the limit. */
1577 if (size > header_insert_maxlen)
1579 ilen -= size - header_insert_maxlen - 1;
1582 Ustrncpy(ptr, t, ilen);
1585 /* For a non-raw header, put in the comma if needed, then add
1586 back the newline we removed above, provided there was some text in
1589 if (!want_raw && ilen > 0)
1591 if (comma != 0) *ptr++ = ',';
1599 /* At end of first pass, return NULL if no header found. Then truncate size
1600 if necessary, and get the buffer to hold the data, returning the buffer size.
1605 if (!found) return NULL;
1606 if (size > header_insert_maxlen) size = header_insert_maxlen;
1607 *newsize = size + 1;
1608 ptr = yield = store_get(*newsize);
1612 /* That's all we do for raw header expansion. */
1619 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1620 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1621 function can return an error with decoded data if the charset translation
1622 fails. If decoding fails, it returns NULL. */
1626 uschar *decoded, *error;
1627 if (ptr > yield && ptr[-1] == '\n') ptr--;
1628 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1630 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1634 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1635 " input was: %s\n", error, yield);
1637 if (decoded != NULL) yield = decoded;
1646 /*************************************************
1647 * Return list of recipients *
1648 *************************************************/
1649 /* A recipients list is available only during system message filtering,
1650 during ACL processing after DATA, and while expanding pipe commands
1651 generated from a system filter, but not elsewhere. */
1656 if (!enable_dollar_recipients) return NULL; else
1661 uschar * s = store_get(size);
1662 for (i = 0; i < recipients_count; i++)
1664 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1665 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1666 Ustrlen(recipients_list[i].address));
1668 s[ptr] = 0; /* string_cat() leaves room */
1674 /*************************************************
1675 * Find value of a variable *
1676 *************************************************/
1678 /* The table of variables is kept in alphabetic order, so we can search it
1679 using a binary chop. The "choplen" variable is nothing to do with the binary
1683 name the name of the variable being sought
1684 exists_only TRUE if this is a def: test; passed on to find_header()
1685 skipping TRUE => skip any processing evaluation; this is not the same as
1686 exists_only because def: may test for values that are first
1688 newsize pointer to an int which is initially zero; if the answer is in
1689 a new memory buffer, *newsize is set to its size
1691 Returns: NULL if the variable does not exist, or
1692 a pointer to the variable's contents, or
1693 something non-NULL if exists_only is TRUE
1697 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1704 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1705 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1706 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1707 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1708 (this gave backwards compatibility at the changeover). There may be built-in
1709 variables whose names start acl_ but they should never start in this way. This
1710 slightly messy specification is a consequence of the history, needless to say.
1712 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1713 set, in which case give an error. */
1715 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1719 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1720 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1723 /* Handle $auth<n> variables. */
1725 if (Ustrncmp(name, "auth", 4) == 0)
1728 int n = Ustrtoul(name + 4, &endptr, 10);
1729 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1730 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1732 else if (Ustrncmp(name, "regex", 5) == 0)
1735 int n = Ustrtoul(name + 5, &endptr, 10);
1736 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1737 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1740 /* For all other variables, search the table */
1742 if (!(vp = find_var_ent(name)))
1743 return NULL; /* Unknown variable name */
1745 /* Found an existing variable. If in skipping state, the value isn't needed,
1746 and we want to avoid processing (such as looking up the host name). */
1754 case vtype_filter_int:
1755 if (!filter_running) return NULL;
1759 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1763 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1767 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1771 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1775 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1778 case vtype_stringptr: /* Pointer to string */
1779 s = *((uschar **)(val));
1780 return (s == NULL)? US"" : s;
1783 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1786 case vtype_load_avg:
1787 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1790 case vtype_host_lookup: /* Lookup if not done so */
1791 if (sender_host_name == NULL && sender_host_address != NULL &&
1792 !host_lookup_failed && host_name_lookup() == OK)
1793 host_build_sender_fullhost();
1794 return (sender_host_name == NULL)? US"" : sender_host_name;
1796 case vtype_localpart: /* Get local part from address */
1797 s = *((uschar **)(val));
1798 if (s == NULL) return US"";
1799 domain = Ustrrchr(s, '@');
1800 if (domain == NULL) return s;
1801 if (domain - s > sizeof(var_buffer) - 1)
1802 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1803 " in string expansion", sizeof(var_buffer));
1804 Ustrncpy(var_buffer, s, domain - s);
1805 var_buffer[domain - s] = 0;
1808 case vtype_domain: /* Get domain from address */
1809 s = *((uschar **)(val));
1810 if (s == NULL) return US"";
1811 domain = Ustrrchr(s, '@');
1812 return (domain == NULL)? US"" : domain + 1;
1814 case vtype_msgheaders:
1815 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1817 case vtype_msgheaders_raw:
1818 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1820 case vtype_msgbody: /* Pointer to msgbody string */
1821 case vtype_msgbody_end: /* Ditto, the end of the msg */
1822 ss = (uschar **)(val);
1823 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1826 off_t start_offset = SPOOL_DATA_START_OFFSET;
1827 int len = message_body_visible;
1828 if (len > message_size) len = message_size;
1829 *ss = body = store_malloc(len+1);
1831 if (vp->type == vtype_msgbody_end)
1833 struct stat statbuf;
1834 if (fstat(deliver_datafile, &statbuf) == 0)
1836 start_offset = statbuf.st_size - len;
1837 if (start_offset < SPOOL_DATA_START_OFFSET)
1838 start_offset = SPOOL_DATA_START_OFFSET;
1841 lseek(deliver_datafile, start_offset, SEEK_SET);
1842 len = read(deliver_datafile, body, len);
1846 if (message_body_newlines) /* Separate loops for efficiency */
1849 { if (body[--len] == 0) body[len] = ' '; }
1854 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1858 return (*ss == NULL)? US"" : *ss;
1860 case vtype_todbsdin: /* BSD inbox time of day */
1861 return tod_stamp(tod_bsdin);
1863 case vtype_tode: /* Unix epoch time of day */
1864 return tod_stamp(tod_epoch);
1866 case vtype_todel: /* Unix epoch/usec time of day */
1867 return tod_stamp(tod_epoch_l);
1869 case vtype_todf: /* Full time of day */
1870 return tod_stamp(tod_full);
1872 case vtype_todl: /* Log format time of day */
1873 return tod_stamp(tod_log_bare); /* (without timezone) */
1875 case vtype_todzone: /* Time zone offset only */
1876 return tod_stamp(tod_zone);
1878 case vtype_todzulu: /* Zulu time */
1879 return tod_stamp(tod_zulu);
1881 case vtype_todlf: /* Log file datestamp tod */
1882 return tod_stamp(tod_log_datestamp_daily);
1884 case vtype_reply: /* Get reply address */
1885 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1887 if (s != NULL) while (isspace(*s)) s++;
1888 if (s == NULL || *s == 0)
1890 *newsize = 0; /* For the *s==0 case */
1891 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1896 while (isspace(*s)) s++;
1897 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1898 while (t > s && isspace(t[-1])) t--;
1901 return (s == NULL)? US"" : s;
1903 case vtype_string_func:
1905 uschar * (*fn)() = val;
1912 sprintf(CS var_buffer, "%d",
1913 receive_statvfs(val == (void *)TRUE, &inodes));
1920 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1921 sprintf(CS var_buffer, "%d", inodes);
1926 return *(void **)val ? US"<cert>" : US"";
1928 #ifndef DISABLE_DKIM
1930 return dkim_exim_expand_query((int)(long)val);
1935 return NULL; /* Unknown variable. Silences static checkers. */
1942 modify_variable(uschar *name, void * value)
1945 if ((vp = find_var_ent(name))) vp->value = value;
1946 return; /* Unknown variable name, fail silently */
1953 /*************************************************
1954 * Read and expand substrings *
1955 *************************************************/
1957 /* This function is called to read and expand argument substrings for various
1958 expansion items. Some have a minimum requirement that is less than the maximum;
1959 in these cases, the first non-present one is set to NULL.
1962 sub points to vector of pointers to set
1963 n maximum number of substrings
1965 sptr points to current string pointer
1966 skipping the skipping flag
1967 check_end if TRUE, check for final '}'
1968 name name of item, for error message
1969 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1972 Returns: 0 OK; string pointer updated
1973 1 curly bracketing error (too few arguments)
1974 2 too many arguments (only if check_end is set); message set
1975 3 other error (expansion failure)
1979 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1980 BOOL check_end, uschar *name, BOOL *resetok)
1983 const uschar *s = *sptr;
1985 while (isspace(*s)) s++;
1986 for (i = 0; i < n; i++)
1990 if (i < m) return 1;
1994 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
1995 if (sub[i] == NULL) return 3;
1996 if (*s++ != '}') return 1;
1997 while (isspace(*s)) s++;
1999 if (check_end && *s++ != '}')
2003 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
2004 "(max is %d)", name, n);
2017 /*************************************************
2018 * Elaborate message for bad variable *
2019 *************************************************/
2021 /* For the "unknown variable" message, take a look at the variable's name, and
2022 give additional information about possible ACL variables. The extra information
2023 is added on to expand_string_message.
2025 Argument: the name of the variable
2030 check_variable_error_message(uschar *name)
2032 if (Ustrncmp(name, "acl_", 4) == 0)
2033 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2034 (name[4] == 'c' || name[4] == 'm')?
2036 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2037 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2039 US"user-defined ACL variables must start acl_c or acl_m");
2045 Load args from sub array to globals, and call acl_check().
2046 Sub array will be corrupted on return.
2048 Returns: OK access is granted by an ACCEPT verb
2049 DISCARD access is granted by a DISCARD verb
2050 FAIL access is denied
2051 FAIL_DROP access is denied; drop the connection
2052 DEFER can't tell at the moment
2056 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2059 int sav_narg = acl_narg;
2061 uschar * dummy_logmsg;
2062 extern int acl_where;
2064 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2065 for (i = 0; i < nsub && sub[i+1]; i++)
2067 uschar * tmp = acl_arg[i];
2068 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2069 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2074 sub[i+1] = acl_arg[i];
2075 acl_arg[i++] = NULL;
2079 debug_printf("expanding: acl: %s arg: %s%s\n",
2081 acl_narg>0 ? acl_arg[0] : US"<none>",
2082 acl_narg>1 ? " +more" : "");
2084 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2086 for (i = 0; i < nsub; i++)
2087 acl_arg[i] = sub[i+1]; /* restore old args */
2088 acl_narg = sav_narg;
2096 /*************************************************
2097 * Read and evaluate a condition *
2098 *************************************************/
2102 s points to the start of the condition text
2103 resetok points to a BOOL which is written false if it is unsafe to
2104 free memory. Certain condition types (acl) may have side-effect
2105 allocation which must be preserved.
2106 yield points to a BOOL to hold the result of the condition test;
2107 if NULL, we are just reading through a condition that is
2108 part of an "or" combination to check syntax, or in a state
2109 where the answer isn't required
2111 Returns: a pointer to the first character after the condition, or
2115 static const uschar *
2116 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2118 BOOL testfor = TRUE;
2119 BOOL tempcond, combined_cond;
2121 BOOL sub2_honour_dollar = TRUE;
2122 int i, rc, cond_type, roffset;
2123 int_eximarith_t num[2];
2124 struct stat statbuf;
2126 const uschar *sub[10];
2129 const uschar *rerror;
2133 while (isspace(*s)) s++;
2134 if (*s == '!') { testfor = !testfor; s++; } else break;
2137 /* Numeric comparisons are symbolic */
2139 if (*s == '=' || *s == '>' || *s == '<')
2151 /* All other conditions are named */
2153 else s = read_name(name, 256, s, US"_");
2155 /* If we haven't read a name, it means some non-alpha character is first. */
2159 expand_string_message = string_sprintf("condition name expected, "
2160 "but found \"%.16s\"", s);
2164 /* Find which condition we are dealing with, and switch on it */
2166 cond_type = chop_match(name, cond_table, nelem(cond_table));
2169 /* def: tests for a non-empty variable, or for the existence of a header. If
2170 yield == NULL we are in a skipping state, and don't care about the answer. */
2175 expand_string_message = US"\":\" expected after \"def\"";
2179 s = read_name(name, 256, s+1, US"_");
2181 /* Test for a header's existence. If the name contains a closing brace
2182 character, this may be a user error where the terminating colon has been
2183 omitted. Set a flag to adjust a subsequent error message in this case. */
2185 if (Ustrncmp(name, "h_", 2) == 0 ||
2186 Ustrncmp(name, "rh_", 3) == 0 ||
2187 Ustrncmp(name, "bh_", 3) == 0 ||
2188 Ustrncmp(name, "header_", 7) == 0 ||
2189 Ustrncmp(name, "rheader_", 8) == 0 ||
2190 Ustrncmp(name, "bheader_", 8) == 0)
2192 s = read_header_name(name, 256, s);
2193 /* {-for-text-editors */
2194 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2195 if (yield != NULL) *yield =
2196 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2199 /* Test for a variable's having a non-empty value. A non-existent variable
2200 causes an expansion failure. */
2204 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2207 expand_string_message = (name[0] == 0)?
2208 string_sprintf("variable name omitted after \"def:\"") :
2209 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2210 check_variable_error_message(name);
2213 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2219 /* first_delivery tests for first delivery attempt */
2221 case ECOND_FIRST_DELIVERY:
2222 if (yield != NULL) *yield = deliver_firsttime == testfor;
2226 /* queue_running tests for any process started by a queue runner */
2228 case ECOND_QUEUE_RUNNING:
2229 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2233 /* exists: tests for file existence
2234 isip: tests for any IP address
2235 isip4: tests for an IPv4 address
2236 isip6: tests for an IPv6 address
2237 pam: does PAM authentication
2238 radius: does RADIUS authentication
2239 ldapauth: does LDAP authentication
2240 pwcheck: does Cyrus SASL pwcheck authentication
2249 case ECOND_LDAPAUTH:
2252 while (isspace(*s)) s++;
2253 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2255 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2256 if (sub[0] == NULL) return NULL;
2257 /* {-for-text-editors */
2258 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2260 if (yield == NULL) return s; /* No need to run the test if skipping */
2265 if ((expand_forbid & RDO_EXISTS) != 0)
2267 expand_string_message = US"File existence tests are not permitted";
2270 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2276 rc = string_is_ip_address(sub[0], NULL);
2277 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2278 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2281 /* Various authentication tests - all optionally compiled */
2285 rc = auth_call_pam(sub[0], &expand_string_message);
2288 goto COND_FAILED_NOT_COMPILED;
2289 #endif /* SUPPORT_PAM */
2292 #ifdef RADIUS_CONFIG_FILE
2293 rc = auth_call_radius(sub[0], &expand_string_message);
2296 goto COND_FAILED_NOT_COMPILED;
2297 #endif /* RADIUS_CONFIG_FILE */
2299 case ECOND_LDAPAUTH:
2302 /* Just to keep the interface the same */
2304 int old_pool = store_pool;
2305 store_pool = POOL_SEARCH;
2306 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2307 &expand_string_message, &do_cache);
2308 store_pool = old_pool;
2312 goto COND_FAILED_NOT_COMPILED;
2313 #endif /* LOOKUP_LDAP */
2316 #ifdef CYRUS_PWCHECK_SOCKET
2317 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2320 goto COND_FAILED_NOT_COMPILED;
2321 #endif /* CYRUS_PWCHECK_SOCKET */
2323 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2324 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2326 if (rc == ERROR || rc == DEFER) return NULL;
2327 *yield = (rc == OK) == testfor;
2333 /* call ACL (in a conditional context). Accept true, deny false.
2334 Defer is a forced-fail. Anything set by message= goes to $value.
2335 Up to ten parameters are used; we use the braces round the name+args
2336 like the saslauthd condition does, to permit a variable number of args.
2337 See also the expansion-item version EITEM_ACL and the traditional
2338 acl modifier ACLC_ACL.
2339 Since the ACL may allocate new global variables, tell our caller to not
2344 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2352 while (isspace(*s)) s++;
2353 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2355 switch(read_subs(sub, nelem(sub), 1,
2356 &s, yield == NULL, TRUE, US"acl", resetok))
2358 case 1: expand_string_message = US"too few arguments or bracketing "
2361 case 3: return NULL;
2365 if (yield != NULL) switch(eval_acl(sub, nelem(sub), &user_msg))
2370 lookup_value = NULL;
2373 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2374 lookup_value[ptr] = '\0';
2376 *yield = cond == testfor;
2380 expand_string_forcedfail = TRUE;
2382 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2389 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2391 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2393 However, the last two are optional. That is why the whole set is enclosed
2394 in their own set of braces. */
2396 case ECOND_SASLAUTHD:
2397 #ifndef CYRUS_SASLAUTHD_SOCKET
2398 goto COND_FAILED_NOT_COMPILED;
2402 while (isspace(*s)) s++;
2403 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2404 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2407 case 1: expand_string_message = US"too few arguments or bracketing "
2408 "error for saslauthd";
2410 case 3: return NULL;
2412 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2415 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2416 &expand_string_message);
2417 if (rc == ERROR || rc == DEFER) return NULL;
2418 *yield = (rc == OK) == testfor;
2422 #endif /* CYRUS_SASLAUTHD_SOCKET */
2425 /* symbolic operators for numeric and string comparison, and a number of
2426 other operators, all requiring two arguments.
2428 crypteq: encrypts plaintext and compares against an encrypted text,
2429 using crypt(), crypt16(), MD5 or SHA-1
2430 inlist/inlisti: checks if first argument is in the list of the second
2431 match: does a regular expression match and sets up the numerical
2432 variables if it succeeds
2433 match_address: matches in an address list
2434 match_domain: matches in a domain list
2435 match_ip: matches a host list that is restricted to IP addresses
2436 match_local_part: matches in a local part list
2439 case ECOND_MATCH_ADDRESS:
2440 case ECOND_MATCH_DOMAIN:
2441 case ECOND_MATCH_IP:
2442 case ECOND_MATCH_LOCAL_PART:
2443 #ifndef EXPAND_LISTMATCH_RHS
2444 sub2_honour_dollar = FALSE;
2453 case ECOND_NUM_L: /* Numerical comparisons */
2460 case ECOND_STR_LT: /* String comparisons */
2471 for (i = 0; i < 2; i++)
2473 /* Sometimes, we don't expand substrings; too many insecure configurations
2474 created using match_address{}{} and friends, where the second param
2475 includes information from untrustworthy sources. */
2476 BOOL honour_dollar = TRUE;
2477 if ((i > 0) && !sub2_honour_dollar)
2478 honour_dollar = FALSE;
2480 while (isspace(*s)) s++;
2483 if (i == 0) goto COND_FAILED_CURLY_START;
2484 expand_string_message = string_sprintf("missing 2nd string in {} "
2485 "after \"%s\"", name);
2488 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2489 honour_dollar, resetok);
2490 if (sub[i] == NULL) return NULL;
2491 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2493 /* Convert to numerical if required; we know that the names of all the
2494 conditions that compare numbers do not start with a letter. This just saves
2495 checking for them individually. */
2497 if (!isalpha(name[0]) && yield != NULL)
2503 debug_printf("empty string cast to zero for numerical comparison\n");
2507 num[i] = expanded_string_integer(sub[i], FALSE);
2508 if (expand_string_message != NULL) return NULL;
2513 /* Result not required */
2515 if (yield == NULL) return s;
2517 /* Do an appropriate comparison */
2523 tempcond = (num[0] == num[1]);
2527 tempcond = (num[0] > num[1]);
2531 tempcond = (num[0] >= num[1]);
2535 tempcond = (num[0] < num[1]);
2539 tempcond = (num[0] <= num[1]);
2543 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2547 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2551 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2555 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2559 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2563 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2567 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2571 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2575 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2579 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2582 case ECOND_MATCH: /* Regular expression match */
2583 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2587 expand_string_message = string_sprintf("regular expression error in "
2588 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2591 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2594 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2595 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2596 goto MATCHED_SOMETHING;
2598 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2599 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2600 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2601 goto MATCHED_SOMETHING;
2603 case ECOND_MATCH_IP: /* Match IP address in a host list */
2604 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2606 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2612 unsigned int *nullcache = NULL;
2613 check_host_block cb;
2615 cb.host_name = US"";
2616 cb.host_address = sub[0];
2618 /* If the host address starts off ::ffff: it is an IPv6 address in
2619 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2622 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2623 cb.host_address + 7 : cb.host_address;
2625 rc = match_check_list(
2626 &sub[1], /* the list */
2627 0, /* separator character */
2628 &hostlist_anchor, /* anchor pointer */
2629 &nullcache, /* cache pointer */
2630 check_host, /* function for testing */
2631 &cb, /* argument for function */
2632 MCL_HOST, /* type of check */
2633 sub[0], /* text for debugging */
2634 NULL); /* where to pass back data */
2636 goto MATCHED_SOMETHING;
2638 case ECOND_MATCH_LOCAL_PART:
2639 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2640 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2655 expand_string_message = string_sprintf("unable to complete match "
2656 "against \"%s\": %s", sub[1], search_error_message);
2662 /* Various "encrypted" comparisons. If the second string starts with
2663 "{" then an encryption type is given. Default to crypt() or crypt16()
2664 (build-time choice). */
2665 /* }-for-text-editors */
2668 #ifndef SUPPORT_CRYPTEQ
2669 goto COND_FAILED_NOT_COMPILED;
2671 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2673 int sublen = Ustrlen(sub[1]+5);
2678 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2680 /* If the length that we are comparing against is 24, the MD5 digest
2681 is expressed as a base64 string. This is the way LDAP does it. However,
2682 some other software uses a straightforward hex representation. We assume
2683 this if the length is 32. Other lengths fail. */
2687 uschar *coded = auth_b64encode((uschar *)digest, 16);
2688 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2689 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2690 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2692 else if (sublen == 32)
2696 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2698 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2699 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2700 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2704 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2705 "fail\n crypted=%s\n", sub[1]+5);
2710 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2712 int sublen = Ustrlen(sub[1]+6);
2717 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2719 /* If the length that we are comparing against is 28, assume the SHA1
2720 digest is expressed as a base64 string. If the length is 40, assume a
2721 straightforward hex representation. Other lengths fail. */
2725 uschar *coded = auth_b64encode((uschar *)digest, 20);
2726 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2727 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2728 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2730 else if (sublen == 40)
2734 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2736 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2737 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2738 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2742 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2743 "fail\n crypted=%s\n", sub[1]+6);
2748 else /* {crypt} or {crypt16} and non-{ at start */
2749 /* }-for-text-editors */
2754 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2759 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2764 else if (sub[1][0] == '{') /* }-for-text-editors */
2766 expand_string_message = string_sprintf("unknown encryption mechanism "
2767 "in \"%s\"", sub[1]);
2773 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2774 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2775 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2779 #define XSTR(s) STR(s)
2780 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2781 " subject=%s\n crypted=%s\n",
2782 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2787 /* If the encrypted string contains fewer than two characters (for the
2788 salt), force failure. Otherwise we get false positives: with an empty
2789 string the yield of crypt() is an empty string! */
2791 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2792 (Ustrcmp(coded, sub[1]) == 0);
2795 #endif /* SUPPORT_CRYPTEQ */
2800 const uschar * list = sub[1];
2802 uschar *save_iterate_item = iterate_item;
2803 int (*compare)(const uschar *, const uschar *);
2805 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2808 compare = cond_type == ECOND_INLISTI
2809 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2811 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2812 if (compare(sub[0], iterate_item) == 0)
2817 iterate_item = save_iterate_item;
2820 } /* Switch for comparison conditions */
2822 *yield = tempcond == testfor;
2823 return s; /* End of comparison conditions */
2826 /* and/or: computes logical and/or of several conditions */
2830 subcondptr = (yield == NULL)? NULL : &tempcond;
2831 combined_cond = (cond_type == ECOND_AND);
2833 while (isspace(*s)) s++;
2834 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2838 while (isspace(*s)) s++;
2839 /* {-for-text-editors */
2840 if (*s == '}') break;
2841 if (*s != '{') /* }-for-text-editors */
2843 expand_string_message = string_sprintf("each subcondition "
2844 "inside an \"%s{...}\" condition must be in its own {}", name);
2848 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2850 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2851 expand_string_message, name);
2854 while (isspace(*s)) s++;
2856 /* {-for-text-editors */
2859 /* {-for-text-editors */
2860 expand_string_message = string_sprintf("missing } at end of condition "
2861 "inside \"%s\" group", name);
2867 if (cond_type == ECOND_AND)
2869 combined_cond &= tempcond;
2870 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2871 } /* evaluate any more */
2874 combined_cond |= tempcond;
2875 if (combined_cond) subcondptr = NULL; /* once true, don't */
2876 } /* evaluate any more */
2880 if (yield != NULL) *yield = (combined_cond == testfor);
2884 /* forall/forany: iterates a condition with different values */
2889 const uschar * list;
2891 uschar *save_iterate_item = iterate_item;
2893 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2895 while (isspace(*s)) s++;
2896 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2897 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2898 if (sub[0] == NULL) return NULL;
2899 /* {-for-text-editors */
2900 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2902 while (isspace(*s)) s++;
2903 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2907 /* Call eval_condition once, with result discarded (as if scanning a
2908 "false" part). This allows us to find the end of the condition, because if
2909 the list it empty, we won't actually evaluate the condition for real. */
2911 if (!(s = eval_condition(sub[1], resetok, NULL)))
2913 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2914 expand_string_message, name);
2917 while (isspace(*s)) s++;
2919 /* {-for-text-editors */
2922 /* {-for-text-editors */
2923 expand_string_message = string_sprintf("missing } at end of condition "
2924 "inside \"%s\"", name);
2928 if (yield != NULL) *yield = !testfor;
2930 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2932 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2933 if (!eval_condition(sub[1], resetok, &tempcond))
2935 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2936 expand_string_message, name);
2937 iterate_item = save_iterate_item;
2940 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2941 tempcond? "true":"false");
2943 if (yield != NULL) *yield = (tempcond == testfor);
2944 if (tempcond == (cond_type == ECOND_FORANY)) break;
2947 iterate_item = save_iterate_item;
2952 /* The bool{} expansion condition maps a string to boolean.
2953 The values supported should match those supported by the ACL condition
2954 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2955 of true/false. Note that Router "condition" rules have a different
2956 interpretation, where general data can be used and only a few values
2958 Note that readconf.c boolean matching, for boolean configuration options,
2959 only matches true/yes/false/no.
2960 The bool_lax{} condition matches the Router logic, which is much more
2963 case ECOND_BOOL_LAX:
2969 BOOL boolvalue = FALSE;
2970 while (isspace(*s)) s++;
2971 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2972 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2973 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2975 case 1: expand_string_message = string_sprintf(
2976 "too few arguments or bracketing error for %s",
2980 case 3: return NULL;
2983 while (isspace(*t)) t++;
2987 /* trailing whitespace: seems like a good idea to ignore it too */
2989 while (isspace(*t2)) t2--;
2990 if (t2 != (t + len))
2997 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2998 /* logic for the lax case from expand_check_condition(), which also does
2999 expands, and the logic is both short and stable enough that there should
3000 be no maintenance burden from replicating it. */
3004 ? Ustrspn(t+1, "0123456789") == len-1
3005 : Ustrspn(t, "0123456789") == len)
3007 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3008 /* expand_check_condition only does a literal string "0" check */
3009 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3012 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3014 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3016 else if (cond_type == ECOND_BOOL_LAX)
3020 expand_string_message = string_sprintf("unrecognised boolean "
3024 if (yield != NULL) *yield = (boolvalue == testfor);
3028 /* Unknown condition */
3031 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3033 } /* End switch on condition type */
3035 /* Missing braces at start and end of data */
3037 COND_FAILED_CURLY_START:
3038 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3041 COND_FAILED_CURLY_END:
3042 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3046 /* A condition requires code that is not compiled */
3048 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3049 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3050 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3051 COND_FAILED_NOT_COMPILED:
3052 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3061 /*************************************************
3062 * Save numerical variables *
3063 *************************************************/
3065 /* This function is called from items such as "if" that want to preserve and
3066 restore the numbered variables.
3069 save_expand_string points to an array of pointers to set
3070 save_expand_nlength points to an array of ints for the lengths
3072 Returns: the value of expand max to save
3076 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3079 for (i = 0; i <= expand_nmax; i++)
3081 save_expand_nstring[i] = expand_nstring[i];
3082 save_expand_nlength[i] = expand_nlength[i];
3089 /*************************************************
3090 * Restore numerical variables *
3091 *************************************************/
3093 /* This function restored saved values of numerical strings.
3096 save_expand_nmax the number of strings to restore
3097 save_expand_string points to an array of pointers
3098 save_expand_nlength points to an array of ints
3104 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3105 int *save_expand_nlength)
3108 expand_nmax = save_expand_nmax;
3109 for (i = 0; i <= expand_nmax; i++)
3111 expand_nstring[i] = save_expand_nstring[i];
3112 expand_nlength[i] = save_expand_nlength[i];
3120 /*************************************************
3121 * Handle yes/no substrings *
3122 *************************************************/
3124 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3125 alternative substrings that depend on whether or not the condition was true,
3126 or the lookup or extraction succeeded. The substrings always have to be
3127 expanded, to check their syntax, but "skipping" is set when the result is not
3128 needed - this avoids unnecessary nested lookups.
3131 skipping TRUE if we were skipping when this item was reached
3132 yes TRUE if the first string is to be used, else use the second
3133 save_lookup a value to put back into lookup_value before the 2nd expansion
3134 sptr points to the input string pointer
3135 yieldptr points to the output string pointer
3136 sizeptr points to the output string size
3137 ptrptr points to the output string pointer
3138 type "lookup" or "if" or "extract" or "run", for error message
3139 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3142 Returns: 0 OK; lookup_value has been reset to save_lookup
3144 2 expansion failed because of bracketing error
3148 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3149 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3152 const uschar *s = *sptr; /* Local value */
3153 uschar *sub1, *sub2;
3155 /* If there are no following strings, we substitute the contents of $value for
3156 lookups and for extractions in the success case. For the ${if item, the string
3157 "true" is substituted. In the fail case, nothing is substituted for all three
3160 while (isspace(*s)) s++;
3165 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3169 if (yes && lookup_value != NULL)
3170 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3171 Ustrlen(lookup_value));
3172 lookup_value = save_lookup;
3178 /* The first following string must be braced. */
3180 if (*s++ != '{') goto FAILED_CURLY;
3182 /* Expand the first substring. Forced failures are noticed only if we actually
3183 want this string. Set skipping in the call in the fail case (this will always
3184 be the case if we were already skipping). */
3186 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3187 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3188 expand_string_forcedfail = FALSE;
3189 if (*s++ != '}') goto FAILED_CURLY;
3191 /* If we want the first string, add it to the output */
3194 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3196 /* If this is called from a lookup or an extract, we want to restore $value to
3197 what it was at the start of the item, so that it has this value during the
3198 second string expansion. For the call from "if" or "run" to this function,
3199 save_lookup is set to lookup_value, so that this statement does nothing. */
3201 lookup_value = save_lookup;
3203 /* There now follows either another substring, or "fail", or nothing. This
3204 time, forced failures are noticed only if we want the second string. We must
3205 set skipping in the nested call if we don't want this string, or if we were
3206 already skipping. */
3208 while (isspace(*s)) s++;
3211 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3212 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3213 expand_string_forcedfail = FALSE;
3214 if (*s++ != '}') goto FAILED_CURLY;
3216 /* If we want the second string, add it to the output */
3219 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3222 /* If there is no second string, but the word "fail" is present when the use of
3223 the second string is wanted, set a flag indicating it was a forced failure
3224 rather than a syntactic error. Swallow the terminating } in case this is nested
3225 inside another lookup or if or extract. */
3230 /* deconst cast ok here as source is s anyway */
3231 s = US read_name(name, sizeof(name), s, US"_");
3232 if (Ustrcmp(name, "fail") == 0)
3234 if (!yes && !skipping)
3236 while (isspace(*s)) s++;
3237 if (*s++ != '}') goto FAILED_CURLY;
3238 expand_string_message =
3239 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3240 expand_string_forcedfail = TRUE;
3246 expand_string_message =
3247 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3252 /* All we have to do now is to check on the final closing brace. */
3254 while (isspace(*s)) s++;
3255 if (*s++ == '}') goto RETURN;
3257 /* Get here if there is a bracketing failure */
3262 /* Get here for other failures */
3267 /* Update the input pointer value before returning */
3277 /*************************************************
3278 * Handle MD5 or SHA-1 computation for HMAC *
3279 *************************************************/
3281 /* These are some wrapping functions that enable the HMAC code to be a bit
3282 cleaner. A good compiler will spot the tail recursion.
3285 type HMAC_MD5 or HMAC_SHA1
3286 remaining are as for the cryptographic hash functions
3292 chash_start(int type, void *base)
3294 if (type == HMAC_MD5)
3295 md5_start((md5 *)base);
3297 sha1_start((sha1 *)base);
3301 chash_mid(int type, void *base, uschar *string)
3303 if (type == HMAC_MD5)
3304 md5_mid((md5 *)base, string);
3306 sha1_mid((sha1 *)base, string);
3310 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3312 if (type == HMAC_MD5)
3313 md5_end((md5 *)base, string, length, digest);
3315 sha1_end((sha1 *)base, string, length, digest);
3322 /********************************************************
3323 * prvs: Get last three digits of days since Jan 1, 1970 *
3324 ********************************************************/
3326 /* This is needed to implement the "prvs" BATV reverse
3329 Argument: integer "days" offset to add or substract to
3330 or from the current number of days.
3332 Returns: pointer to string containing the last three
3333 digits of the number of days since Jan 1, 1970,
3334 modified by the offset argument, NULL if there
3335 was an error in the conversion.
3340 prvs_daystamp(int day_offset)
3342 uschar *days = store_get(32); /* Need at least 24 for cases */
3343 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3344 (time(NULL) + day_offset*86400)/86400);
3345 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3350 /********************************************************
3351 * prvs: perform HMAC-SHA1 computation of prvs bits *
3352 ********************************************************/
3354 /* This is needed to implement the "prvs" BATV reverse
3358 address RFC2821 Address to use
3359 key The key to use (must be less than 64 characters
3361 key_num Single-digit key number to use. Defaults to
3364 Returns: pointer to string containing the first three
3365 bytes of the final hash in hex format, NULL if
3366 there was an error in the process.
3370 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3372 uschar *hash_source, *p;
3373 int size = 0,offset = 0,i;
3375 void *use_base = &sha1_base;
3376 uschar innerhash[20];
3377 uschar finalhash[20];
3378 uschar innerkey[64];
3379 uschar outerkey[64];
3380 uschar *finalhash_hex = store_get(40);
3382 if (key_num == NULL)
3385 if (Ustrlen(key) > 64)
3388 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3389 string_cat(hash_source,&size,&offset,daystamp,3);
3390 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3391 hash_source[offset] = '\0';
3393 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3395 memset(innerkey, 0x36, 64);
3396 memset(outerkey, 0x5c, 64);
3398 for (i = 0; i < Ustrlen(key); i++)
3400 innerkey[i] ^= key[i];
3401 outerkey[i] ^= key[i];
3404 chash_start(HMAC_SHA1, use_base);
3405 chash_mid(HMAC_SHA1, use_base, innerkey);
3406 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3408 chash_start(HMAC_SHA1, use_base);
3409 chash_mid(HMAC_SHA1, use_base, outerkey);
3410 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3413 for (i = 0; i < 3; i++)
3415 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3416 *p++ = hex_digits[finalhash[i] & 0x0f];
3420 return finalhash_hex;
3426 /*************************************************
3427 * Join a file onto the output string *
3428 *************************************************/
3430 /* This is used for readfile and after a run expansion. It joins the contents
3431 of a file onto the output string, globally replacing newlines with a given
3432 string (optionally). The file is closed at the end.
3436 yield pointer to the expandable string
3437 sizep pointer to the current size
3438 ptrp pointer to the current position
3439 eol newline replacement string, or NULL
3441 Returns: new value of string pointer
3445 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3448 uschar buffer[1024];
3450 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3452 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3454 int len = Ustrlen(buffer);
3455 if (eol != NULL && buffer[len-1] == '\n') len--;
3456 yield = string_cat(yield, sizep, ptrp, buffer, len);
3457 if (buffer[len] != 0)
3458 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3461 if (yield != NULL) yield[*ptrp] = 0;
3469 /*************************************************
3470 * Evaluate numeric expression *
3471 *************************************************/
3473 /* This is a set of mutually recursive functions that evaluate an arithmetic
3474 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3475 these functions that is called from elsewhere is eval_expr, whose interface is:
3478 sptr pointer to the pointer to the string - gets updated
3479 decimal TRUE if numbers are to be assumed decimal
3480 error pointer to where to put an error message - must be NULL on input
3481 endket TRUE if ')' must terminate - FALSE for external call
3483 Returns: on success: the value of the expression, with *error still NULL
3484 on failure: an undefined value, with *error = a message
3487 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3490 static int_eximarith_t
3491 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3494 int_eximarith_t x = eval_op_or(&s, decimal, error);
3500 *error = US"expecting closing parenthesis";
3502 while (isspace(*(++s)));
3504 else if (*s != 0) *error = US"expecting operator";
3511 static int_eximarith_t
3512 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3517 while (isspace(*s)) s++;
3522 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3524 switch (tolower(*s))
3527 case 'k': n *= 1024; s++; break;
3528 case 'm': n *= 1024*1024; s++; break;
3529 case 'g': n *= 1024*1024*1024; s++; break;
3531 while (isspace (*s)) s++;
3536 n = eval_expr(&s, decimal, error, 1);
3540 *error = US"expecting number or opening parenthesis";
3548 static int_eximarith_t
3549 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3553 while (isspace(*s)) s++;
3554 if (*s == '+' || *s == '-' || *s == '~')
3557 x = eval_op_unary(&s, decimal, error);
3558 if (op == '-') x = -x;
3559 else if (op == '~') x = ~x;
3563 x = eval_number(&s, decimal, error);
3570 static int_eximarith_t
3571 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3574 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3577 while (*s == '*' || *s == '/' || *s == '%')
3580 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3581 if (*error != NULL) break;
3582 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3583 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3584 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3585 * -N*M is INT_MIN will yielf INT_MIN.
3586 * Since we don't support floating point, this is somewhat simpler.
3587 * Ideally, we'd return an error, but since we overflow for all other
3588 * arithmetic, consistency suggests otherwise, but what's the correct value
3589 * to use? There is none.
3590 * The C standard guarantees overflow for unsigned arithmetic but signed
3591 * overflow invokes undefined behaviour; in practice, this is overflow
3592 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3593 * that long/longlong larger than int are available, or we could just work
3594 * with larger types. We should consider whether to guarantee 32bit eval
3595 * and 64-bit working variables, with errors returned. For now ...
3596 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3597 * can just let the other invalid results occur otherwise, as they have
3598 * until now. For this one case, we can coerce.
3600 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3603 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3604 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3614 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3630 static int_eximarith_t
3631 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3634 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3637 while (*s == '+' || *s == '-')
3640 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3641 if (*error != NULL) break;
3642 if (op == '+') x += y; else x -= y;
3650 static int_eximarith_t
3651 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3654 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3657 while ((*s == '<' || *s == '>') && s[1] == s[0])
3662 y = eval_op_sum(&s, decimal, error);
3663 if (*error != NULL) break;
3664 if (op == '<') x <<= y; else x >>= y;
3672 static int_eximarith_t
3673 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3676 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3683 y = eval_op_shift(&s, decimal, error);
3684 if (*error != NULL) break;
3693 static int_eximarith_t
3694 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3697 int_eximarith_t x = eval_op_and(&s, decimal, error);
3704 y = eval_op_and(&s, decimal, error);
3705 if (*error != NULL) break;
3714 static int_eximarith_t
3715 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3718 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3725 y = eval_op_xor(&s, decimal, error);
3726 if (*error != NULL) break;
3736 /*************************************************
3738 *************************************************/
3740 /* Returns either an unchanged string, or the expanded string in stacking pool
3741 store. Interpreted sequences are:
3743 \... normal escaping rules
3744 $name substitutes the variable
3746 ${op:string} operates on the expanded string value
3747 ${item{arg1}{arg2}...} expands the args and then does the business
3748 some literal args are not enclosed in {}
3750 There are now far too many operators and item types to make it worth listing
3751 them here in detail any more.
3753 We use an internal routine recursively to handle embedded substrings. The
3754 external function follows. The yield is NULL if the expansion failed, and there
3755 are two cases: if something collapsed syntactically, or if "fail" was given
3756 as the action on a lookup failure. These can be distinguised by looking at the
3757 variable expand_string_forcedfail, which is TRUE in the latter case.
3759 The skipping flag is set true when expanding a substring that isn't actually
3760 going to be used (after "if" or "lookup") and it prevents lookups from
3761 happening lower down.
3763 Store usage: At start, a store block of the length of the input plus 64
3764 is obtained. This is expanded as necessary by string_cat(), which might have to
3765 get a new block, or might be able to expand the original. At the end of the
3766 function we can release any store above that portion of the yield block that
3767 was actually used. In many cases this will be optimal.
3769 However: if the first item in the expansion is a variable name or header name,
3770 we reset the store before processing it; if the result is in fresh store, we
3771 use that without copying. This is helpful for expanding strings like
3772 $message_headers which can get very long.
3774 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3775 since resetting the store at the end of the expansion will free store that was
3776 allocated by the plugin code as well as the slop after the expanded string. So
3777 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3778 and, given the acl condition, ${if }. This is an unfortunate consequence of
3779 string expansion becoming too powerful.
3782 string the string to be expanded
3783 ket_ends true if expansion is to stop at }
3784 left if not NULL, a pointer to the first character after the
3785 expansion is placed here (typically used with ket_ends)
3786 skipping TRUE for recursive calls when the value isn't actually going
3787 to be used (to allow for optimisation)
3788 honour_dollar TRUE if $ is to be expanded,
3789 FALSE if it's just another character
3790 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3793 Returns: NULL if expansion fails:
3794 expand_string_forcedfail is set TRUE if failure was forced
3795 expand_string_message contains a textual error message
3796 a pointer to the expanded string on success
3800 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3801 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3804 int size = Ustrlen(string)+ 64;
3806 uschar *yield = store_get(size);
3807 const uschar *s = string;
3808 uschar *save_expand_nstring[EXPAND_MAXN+1];
3809 int save_expand_nlength[EXPAND_MAXN+1];
3810 BOOL resetok = TRUE;
3812 expand_string_forcedfail = FALSE;
3813 expand_string_message = US"";
3820 /* \ escapes the next character, which must exist, or else
3821 the expansion fails. There's a special escape, \N, which causes
3822 copying of the subject verbatim up to the next \N. Otherwise,
3823 the escapes are the standard set. */
3829 expand_string_message = US"\\ at end of string";
3835 const uschar * t = s + 2;
3836 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3837 yield = string_cat(yield, &size, &ptr, t, s - t);
3838 if (*s != 0) s += 2;
3844 ch[0] = string_interpret_escape(&s);
3846 yield = string_cat(yield, &size, &ptr, ch, 1);
3853 /* Anything other than $ is just copied verbatim, unless we are
3854 looking for a terminating } character. */
3857 if (ket_ends && *s == '}') break;
3859 if (*s != '$' || !honour_dollar)
3861 yield = string_cat(yield, &size, &ptr, s++, 1);
3865 /* No { after the $ - must be a plain name or a number for string
3866 match variable. There has to be a fudge for variables that are the
3867 names of header fields preceded by "$header_" because header field
3868 names can contain any printing characters except space and colon.
3869 For those that don't like typing this much, "$h_" is a synonym for
3870 "$header_". A non-existent header yields a NULL value; nothing is
3873 if (isalpha((*(++s))))
3878 s = read_name(name, sizeof(name), s, US"_");
3880 /* If this is the first thing to be expanded, release the pre-allocated
3883 if (ptr == 0 && yield != NULL)
3885 if (resetok) store_reset(yield);
3892 if (Ustrncmp(name, "h_", 2) == 0 ||
3893 Ustrncmp(name, "rh_", 3) == 0 ||
3894 Ustrncmp(name, "bh_", 3) == 0 ||
3895 Ustrncmp(name, "header_", 7) == 0 ||
3896 Ustrncmp(name, "rheader_", 8) == 0 ||
3897 Ustrncmp(name, "bheader_", 8) == 0)
3899 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3900 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3901 s = read_header_name(name, sizeof(name), s);
3902 value = find_header(name, FALSE, &newsize, want_raw, charset);
3904 /* If we didn't find the header, and the header contains a closing brace
3905 character, this may be a user error where the terminating colon
3906 has been omitted. Set a flag to adjust the error message in this case.
3907 But there is no error here - nothing gets inserted. */
3911 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3920 value = find_variable(name, FALSE, skipping, &newsize);
3923 expand_string_message =
3924 string_sprintf("unknown variable name \"%s\"", name);
3925 check_variable_error_message(name);
3930 /* If the data is known to be in a new buffer, newsize will be set to the
3931 size of that buffer. If this is the first thing in an expansion string,
3932 yield will be NULL; just point it at the new store instead of copying. Many
3933 expansion strings contain just one reference, so this is a useful
3934 optimization, especially for humungous headers. */
3936 len = Ustrlen(value);
3937 if (yield == NULL && newsize != 0)
3943 else yield = string_cat(yield, &size, &ptr, value, len);
3951 s = read_cnumber(&n, s);
3952 if (n >= 0 && n <= expand_nmax)
3953 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3958 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3960 if (*s != '{') /*}*/
3962 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3966 /* After { there can be various things, but they all start with
3967 an initial word, except for a number for a string match variable. */
3969 if (isdigit((*(++s))))
3972 s = read_cnumber(&n, s); /*{*/
3975 expand_string_message = US"} expected after number";
3978 if (n >= 0 && n <= expand_nmax)
3979 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3986 expand_string_message = US"letter or digit expected after ${"; /*}*/
3990 /* Allow "-" in names to cater for substrings with negative
3991 arguments. Since we are checking for known names after { this is
3994 s = read_name(name, sizeof(name), s, US"_-");
3995 item_type = chop_match(name, item_table, nelem(item_table));
3999 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4000 If the ACL returns accept or reject we return content set by "message ="
4001 There is currently no limit on recursion; this would have us call
4002 acl_check_internal() directly and get a current level from somewhere.
4003 See also the acl expansion condition ECOND_ACL and the traditional
4004 acl modifier ACLC_ACL.
4005 Assume that the function has side-effects on the store that must be preserved.
4009 /* ${acl {name} {arg1}{arg2}...} */
4011 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4014 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4017 case 1: goto EXPAND_FAILED_CURLY;
4019 case 3: goto EXPAND_FAILED;
4021 if (skipping) continue;
4024 switch(eval_acl(sub, nelem(sub), &user_msg))
4029 debug_printf("acl expansion yield: %s\n", user_msg);
4031 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
4035 expand_string_forcedfail = TRUE;
4037 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4042 /* Handle conditionals - preserve the values of the numerical expansion
4043 variables in case they get changed by a regular expression match in the
4044 condition. If not, they retain their external settings. At the end
4045 of this "if" section, they get restored to their previous values. */
4050 const uschar *next_s;
4051 int save_expand_nmax =
4052 save_expand_strings(save_expand_nstring, save_expand_nlength);
4054 while (isspace(*s)) s++;
4055 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
4056 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4059 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
4060 cond? "true" : "false");
4064 /* The handling of "yes" and "no" result strings is now in a separate
4065 function that is also used by ${lookup} and ${extract} and ${run}. */
4067 switch(process_yesno(
4068 skipping, /* were previously skipping */
4069 cond, /* success/failure indicator */
4070 lookup_value, /* value to reset for string2 */
4071 &s, /* input pointer */
4072 &yield, /* output pointer */
4073 &size, /* output size */
4074 &ptr, /* output current point */
4075 US"if", /* condition type */
4078 case 1: goto EXPAND_FAILED; /* when all is well, the */
4079 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4082 /* Restore external setting of expansion variables for continuation
4085 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4086 save_expand_nlength);
4090 #ifdef EXPERIMENTAL_INTERNATIONAL
4091 case EITEM_IMAPFOLDER:
4092 { /* ${imapfolder {name}{sep]{specials}} */
4096 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4099 case 1: goto EXPAND_FAILED_CURLY;
4101 case 3: goto EXPAND_FAILED;
4104 if (sub_arg[1] == NULL) /* One argument */
4106 sub_arg[1] = US"/"; /* default separator */
4109 else if (Ustrlen(sub_arg[1]) != 1)
4111 expand_string_message =
4113 "IMAP folder separator must be one character, found \"%s\"",
4118 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4119 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4122 yield = string_cat(yield, &size, &ptr, encoded, Ustrlen(encoded));
4127 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4128 expanding an internal string that isn't actually going to be used. All we
4129 need to do is check the syntax, so don't do a lookup at all. Preserve the
4130 values of the numerical expansion variables in case they get changed by a
4131 partial lookup. If not, they retain their external settings. At the end
4132 of this "lookup" section, they get restored to their previous values. */
4136 int stype, partial, affixlen, starflags;
4137 int expand_setup = 0;
4139 uschar *key, *filename;
4140 const uschar *affix;
4141 uschar *save_lookup_value = lookup_value;
4142 int save_expand_nmax =
4143 save_expand_strings(save_expand_nstring, save_expand_nlength);
4145 if ((expand_forbid & RDO_LOOKUP) != 0)
4147 expand_string_message = US"lookup expansions are not permitted";
4151 /* Get the key we are to look up for single-key+file style lookups.
4152 Otherwise set the key NULL pro-tem. */
4154 while (isspace(*s)) s++;
4155 if (*s == '{') /*}*/
4157 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4158 if (key == NULL) goto EXPAND_FAILED; /*{*/
4159 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4160 while (isspace(*s)) s++;
4164 /* Find out the type of database */
4168 expand_string_message = US"missing lookup type";
4172 /* The type is a string that may contain special characters of various
4173 kinds. Allow everything except space or { to appear; the actual content
4174 is checked by search_findtype_partial. */ /*}*/
4176 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4178 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4182 while (isspace(*s)) s++;
4184 /* Now check for the individual search type and any partial or default
4185 options. Only those types that are actually in the binary are valid. */
4187 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4191 expand_string_message = search_error_message;
4195 /* Check that a key was provided for those lookup types that need it,
4196 and was not supplied for those that use the query style. */
4198 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4202 expand_string_message = string_sprintf("missing {key} for single-"
4203 "key \"%s\" lookup", name);
4211 expand_string_message = string_sprintf("a single key was given for "
4212 "lookup type \"%s\", which is not a single-key lookup type", name);
4217 /* Get the next string in brackets and expand it. It is the file name for
4218 single-key+file lookups, and the whole query otherwise. In the case of
4219 queries that also require a file name (e.g. sqlite), the file name comes
4222 if (*s != '{') goto EXPAND_FAILED_CURLY;
4223 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4224 if (filename == NULL) goto EXPAND_FAILED;
4225 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4226 while (isspace(*s)) s++;
4228 /* If this isn't a single-key+file lookup, re-arrange the variables
4229 to be appropriate for the search_ functions. For query-style lookups,
4230 there is just a "key", and no file name. For the special query-style +
4231 file types, the query (i.e. "key") starts with a file name. */
4235 while (isspace(*filename)) filename++;
4238 if (mac_islookup(stype, lookup_querystyle))
4244 if (*filename != '/')
4246 expand_string_message = string_sprintf(
4247 "absolute file name expected for \"%s\" lookup", name);
4250 while (*key != 0 && !isspace(*key)) key++;
4251 if (*key != 0) *key++ = 0;
4255 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4256 the entry was not found. Note that there is no search_close() function.
4257 Files are left open in case of re-use. At suitable places in higher logic,
4258 search_tidyup() is called to tidy all open files. This can save opening
4259 the same file several times. However, files may also get closed when
4260 others are opened, if too many are open at once. The rule is that a
4261 handle should not be used after a second search_open().
4263 Request that a partial search sets up $1 and maybe $2 by passing
4264 expand_setup containing zero. If its value changes, reset expand_nmax,
4265 since new variables will have been set. Note that at the end of this
4266 "lookup" section, the old numeric variables are restored. */
4269 lookup_value = NULL;
4272 void *handle = search_open(filename, stype, 0, NULL, NULL);
4275 expand_string_message = search_error_message;
4278 lookup_value = search_find(handle, filename, key, partial, affix,
4279 affixlen, starflags, &expand_setup);
4280 if (search_find_defer)
4282 expand_string_message =
4283 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4284 string_printing2(key, FALSE), search_error_message);
4287 if (expand_setup > 0) expand_nmax = expand_setup;
4290 /* The handling of "yes" and "no" result strings is now in a separate
4291 function that is also used by ${if} and ${extract}. */
4293 switch(process_yesno(
4294 skipping, /* were previously skipping */
4295 lookup_value != NULL, /* success/failure indicator */
4296 save_lookup_value, /* value to reset for string2 */
4297 &s, /* input pointer */
4298 &yield, /* output pointer */
4299 &size, /* output size */
4300 &ptr, /* output current point */
4301 US"lookup", /* condition type */
4304 case 1: goto EXPAND_FAILED; /* when all is well, the */
4305 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4308 /* Restore external setting of expansion variables for carrying on
4309 at this level, and continue. */
4311 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4312 save_expand_nlength);
4316 /* If Perl support is configured, handle calling embedded perl subroutines,
4317 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4318 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4319 arguments (defined below). */
4321 #define EXIM_PERL_MAX_ARGS 8
4325 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4326 "is not included in this binary";
4329 #else /* EXIM_PERL */
4331 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4334 if ((expand_forbid & RDO_PERL) != 0)
4336 expand_string_message = US"Perl calls are not permitted";
4340 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4341 US"perl", &resetok))
4343 case 1: goto EXPAND_FAILED_CURLY;
4345 case 3: goto EXPAND_FAILED;
4348 /* If skipping, we don't actually do anything */
4350 if (skipping) continue;
4352 /* Start the interpreter if necessary */
4354 if (!opt_perl_started)
4357 if (opt_perl_startup == NULL)
4359 expand_string_message = US"A setting of perl_startup is needed when "
4360 "using the Perl interpreter";
4363 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4364 initerror = init_perl(opt_perl_startup);
4365 if (initerror != NULL)
4367 expand_string_message =
4368 string_sprintf("error in perl_startup code: %s\n", initerror);
4371 opt_perl_started = TRUE;
4374 /* Call the function */
4376 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4377 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4378 sub_arg[0], sub_arg + 1);
4380 /* NULL yield indicates failure; if the message pointer has been set to
4381 NULL, the yield was undef, indicating a forced failure. Otherwise the
4382 message will indicate some kind of Perl error. */
4384 if (new_yield == NULL)
4386 if (expand_string_message == NULL)
4388 expand_string_message =
4389 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4390 "failure", sub_arg[0]);
4391 expand_string_forcedfail = TRUE;
4396 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4397 set during a callback from Perl. */
4399 expand_string_forcedfail = FALSE;
4403 #endif /* EXIM_PERL */
4405 /* Transform email address to "prvs" scheme to use
4406 as BATV-signed return path */
4413 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4415 case 1: goto EXPAND_FAILED_CURLY;
4417 case 3: goto EXPAND_FAILED;
4420 /* If skipping, we don't actually do anything */
4421 if (skipping) continue;
4423 /* sub_arg[0] is the address */
4424 domain = Ustrrchr(sub_arg[0],'@');
4425 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4427 expand_string_message = US"prvs first argument must be a qualified email address";
4431 /* Calculate the hash. The second argument must be a single-digit
4432 key number, or unset. */
4434 if (sub_arg[2] != NULL &&
4435 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4437 expand_string_message = US"prvs second argument must be a single digit";
4441 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4444 expand_string_message = US"prvs hmac-sha1 conversion failed";
4448 /* Now separate the domain from the local part */
4451 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4452 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4453 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4454 string_cat(yield,&size,&ptr,p,6);
4455 string_cat(yield,&size,&ptr,US"=",1);
4456 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4457 string_cat(yield,&size,&ptr,US"@",1);
4458 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4463 /* Check a prvs-encoded address for validity */
4465 case EITEM_PRVSCHECK:
4468 int mysize = 0, myptr = 0;
4472 /* TF: Ugliness: We want to expand parameter 1 first, then set
4473 up expansion variables that are used in the expansion of
4474 parameter 2. So we clone the string for the first
4475 expansion, where we only expand parameter 1.
4477 PH: Actually, that isn't necessary. The read_subs() function is
4478 designed to work this way for the ${if and ${lookup expansions. I've
4482 /* Reset expansion variables */
4483 prvscheck_result = NULL;
4484 prvscheck_address = NULL;
4485 prvscheck_keynum = NULL;
4487 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4489 case 1: goto EXPAND_FAILED_CURLY;
4491 case 3: goto EXPAND_FAILED;
4494 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4497 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4499 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4500 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4501 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4502 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4503 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4505 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4506 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4507 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4508 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4509 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4511 /* Set up expansion variables */
4512 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4513 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4514 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4515 prvscheck_address[myptr] = '\0';
4516 prvscheck_keynum = string_copy(key_num);
4518 /* Now expand the second argument */
4519 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4521 case 1: goto EXPAND_FAILED_CURLY;
4523 case 3: goto EXPAND_FAILED;
4526 /* Now we have the key and can check the address. */
4528 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4533 expand_string_message = US"hmac-sha1 conversion failed";
4537 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4538 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4540 if (Ustrcmp(p,hash) == 0)
4542 /* Success, valid BATV address. Now check the expiry date. */
4543 uschar *now = prvs_daystamp(0);
4544 unsigned int inow = 0,iexpire = 1;
4546 (void)sscanf(CS now,"%u",&inow);
4547 (void)sscanf(CS daystamp,"%u",&iexpire);
4549 /* When "iexpire" is < 7, a "flip" has occured.
4550 Adjust "inow" accordingly. */
4551 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4553 if (iexpire >= inow)
4555 prvscheck_result = US"1";
4556 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4560 prvscheck_result = NULL;
4561 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4566 prvscheck_result = NULL;
4567 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4570 /* Now expand the final argument. We leave this till now so that
4571 it can include $prvscheck_result. */
4573 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4575 case 1: goto EXPAND_FAILED_CURLY;
4577 case 3: goto EXPAND_FAILED;
4580 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4581 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4583 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4585 /* Reset the "internal" variables afterwards, because they are in
4586 dynamic store that will be reclaimed if the expansion succeeded. */
4588 prvscheck_address = NULL;
4589 prvscheck_keynum = NULL;
4593 /* Does not look like a prvs encoded address, return the empty string.
4594 We need to make sure all subs are expanded first, so as to skip over
4597 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4599 case 1: goto EXPAND_FAILED_CURLY;
4601 case 3: goto EXPAND_FAILED;
4608 /* Handle "readfile" to insert an entire file */
4610 case EITEM_READFILE:
4615 if ((expand_forbid & RDO_READFILE) != 0)
4617 expand_string_message = US"file insertions are not permitted";
4621 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4623 case 1: goto EXPAND_FAILED_CURLY;
4625 case 3: goto EXPAND_FAILED;
4628 /* If skipping, we don't actually do anything */
4630 if (skipping) continue;
4632 /* Open the file and read it */
4634 f = Ufopen(sub_arg[0], "rb");
4637 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4641 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4646 /* Handle "readsocket" to insert data from a Unix domain socket */
4648 case EITEM_READSOCK:
4654 struct sockaddr_un sockun; /* don't call this "sun" ! */
4658 if ((expand_forbid & RDO_READSOCK) != 0)
4660 expand_string_message = US"socket insertions are not permitted";
4664 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4665 because there may be a string for expansion on failure. */
4667 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4669 case 1: goto EXPAND_FAILED_CURLY;
4670 case 2: /* Won't occur: no end check */
4671 case 3: goto EXPAND_FAILED;
4674 /* Sort out timeout, if given */
4676 if (sub_arg[2] != NULL)
4678 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4681 expand_string_message = string_sprintf("bad time value %s",
4686 else sub_arg[3] = NULL; /* No eol if no timeout */
4688 /* If skipping, we don't actually do anything. Otherwise, arrange to
4689 connect to either an IP or a Unix socket. */
4693 /* Handle an IP (internet) domain */
4695 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4698 uschar *server_name = sub_arg[0] + 5;
4699 uschar *port_name = Ustrrchr(server_name, ':');
4701 /* Sort out the port */
4703 if (port_name == NULL)
4705 expand_string_message =
4706 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4709 *port_name++ = 0; /* Terminate server name */
4711 if (isdigit(*port_name))
4714 port = Ustrtol(port_name, &end, 0);
4715 if (end != port_name + Ustrlen(port_name))
4717 expand_string_message =
4718 string_sprintf("invalid port number %s", port_name);
4724 struct servent *service_info = getservbyname(CS port_name, "tcp");
4725 if (service_info == NULL)
4727 expand_string_message = string_sprintf("unknown port \"%s\"",
4731 port = ntohs(service_info->s_port);
4734 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4735 timeout, NULL, &expand_string_message)) < 0)
4739 /* Handle a Unix domain socket */
4744 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4746 expand_string_message = string_sprintf("failed to create socket: %s",
4751 sockun.sun_family = AF_UNIX;
4752 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4755 sigalrm_seen = FALSE;
4757 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4761 expand_string_message = US "socket connect timed out";
4766 expand_string_message = string_sprintf("failed to connect to socket "
4767 "%s: %s", sub_arg[0], strerror(errno));
4772 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4774 /* Allow sequencing of test actions */
4775 if (running_in_test_harness) millisleep(100);
4777 /* Write the request string, if not empty */
4779 if (sub_arg[1][0] != 0)
4781 int len = Ustrlen(sub_arg[1]);
4782 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4784 if (write(fd, sub_arg[1], len) != len)
4786 expand_string_message = string_sprintf("request write to socket "
4787 "failed: %s", strerror(errno));
4792 /* Shut down the sending side of the socket. This helps some servers to
4793 recognise that it is their turn to do some work. Just in case some
4794 system doesn't have this function, make it conditional. */
4797 shutdown(fd, SHUT_WR);
4800 if (running_in_test_harness) millisleep(100);
4802 /* Now we need to read from the socket, under a timeout. The function
4803 that reads a file can be used. */
4805 f = fdopen(fd, "rb");
4806 sigalrm_seen = FALSE;
4808 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4812 /* After a timeout, we restore the pointer in the result, that is,
4813 make sure we add nothing from the socket. */
4818 expand_string_message = US "socket read timed out";
4823 /* The whole thing has worked (or we were skipping). If there is a
4824 failure string following, we need to skip it. */
4828 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4830 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4831 while (isspace(*s)) s++;
4833 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4836 /* Come here on failure to create socket, connect socket, write to the
4837 socket, or timeout on reading. If another substring follows, expand and
4838 use it. Otherwise, those conditions give expand errors. */
4841 if (*s != '{') goto EXPAND_FAILED;
4842 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4843 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4844 if (arg == NULL) goto EXPAND_FAILED;
4845 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4846 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4847 while (isspace(*s)) s++;
4848 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4852 /* Handle "run" to execute a program. */
4858 const uschar **argv;
4864 if ((expand_forbid & RDO_RUN) != 0)
4866 expand_string_message = US"running a command is not permitted";
4870 while (isspace(*s)) s++;
4871 if (*s != '{') goto EXPAND_FAILED_CURLY;
4872 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4873 if (arg == NULL) goto EXPAND_FAILED;
4874 while (isspace(*s)) s++;
4875 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4877 if (skipping) /* Just pretend it worked when we're skipping */
4883 if (!transport_set_up_command(&argv, /* anchor for arg list */
4884 arg, /* raw command */
4885 FALSE, /* don't expand the arguments */
4886 0, /* not relevant when... */
4887 NULL, /* no transporting address */
4888 US"${run} expansion", /* for error messages */
4889 &expand_string_message)) /* where to put error message */
4894 /* Create the child process, making it a group leader. */
4896 pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4900 expand_string_message =
4901 string_sprintf("couldn't create child process: %s", strerror(errno));
4905 /* Nothing is written to the standard input. */
4909 /* Read the pipe to get the command's output into $value (which is kept
4910 in lookup_value). Read during execution, so that if the output exceeds
4911 the OS pipe buffer limit, we don't block forever. */
4913 f = fdopen(fd_out, "rb");
4914 sigalrm_seen = FALSE;
4916 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4920 /* Wait for the process to finish, applying the timeout, and inspect its
4921 return code for serious disasters. Simple non-zero returns are passed on.
4924 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4926 if (sigalrm_seen == TRUE || runrc == -256)
4928 expand_string_message = string_sprintf("command timed out");
4929 killpg(pid, SIGKILL); /* Kill the whole process group */
4932 else if (runrc == -257)
4933 expand_string_message = string_sprintf("wait() failed: %s",
4937 expand_string_message = string_sprintf("command killed by signal %d",
4944 /* Process the yes/no strings; $value may be useful in both cases */
4946 switch(process_yesno(
4947 skipping, /* were previously skipping */
4948 runrc == 0, /* success/failure indicator */
4949 lookup_value, /* value to reset for string2 */
4950 &s, /* input pointer */
4951 &yield, /* output pointer */
4952 &size, /* output size */
4953 &ptr, /* output current point */
4954 US"run", /* condition type */
4957 case 1: goto EXPAND_FAILED; /* when all is well, the */
4958 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4964 /* Handle character translation for "tr" */
4972 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4974 case 1: goto EXPAND_FAILED_CURLY;
4976 case 3: goto EXPAND_FAILED;
4979 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4980 o2m = Ustrlen(sub[2]) - 1;
4982 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4984 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4988 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4995 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4996 expanded arguments. */
5006 int val[2] = { 0, -1 };
5009 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5010 Ensure that sub[2] is set in the ${length } case. */
5013 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5014 TRUE, name, &resetok))
5016 case 1: goto EXPAND_FAILED_CURLY;
5018 case 3: goto EXPAND_FAILED;
5021 /* Juggle the arguments if there are only two of them: always move the
5022 string to the last position and make ${length{n}{str}} equivalent to
5023 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5029 if (item_type == EITEM_LENGTH)
5036 for (i = 0; i < 2; i++)
5038 if (sub[i] == NULL) continue;
5039 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5040 if (*ret != 0 || (i != 0 && val[i] < 0))
5042 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5043 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5049 (item_type == EITEM_HASH)?
5050 compute_hash(sub[2], val[0], val[1], &len) :
5051 (item_type == EITEM_NHASH)?
5052 compute_nhash(sub[2], val[0], val[1], &len) :
5053 extract_substr(sub[2], val[0], val[1], &len);
5055 if (ret == NULL) goto EXPAND_FAILED;
5056 yield = string_cat(yield, &size, &ptr, ret, len);
5060 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5061 This code originally contributed by Steve Haslam. It currently supports
5062 the use of MD5 and SHA-1 hashes.
5064 We need some workspace that is large enough to handle all the supported
5065 hash types. Use macros to set the sizes rather than be too elaborate. */
5067 #define MAX_HASHLEN 20
5068 #define MAX_HASHBLOCKLEN 64
5077 int hashlen; /* Number of octets for the hash algorithm's output */
5078 int hashblocklen; /* Number of octets the hash algorithm processes */
5080 unsigned int keylen;
5082 uschar keyhash[MAX_HASHLEN];
5083 uschar innerhash[MAX_HASHLEN];
5084 uschar finalhash[MAX_HASHLEN];
5085 uschar finalhash_hex[2*MAX_HASHLEN];
5086 uschar innerkey[MAX_HASHBLOCKLEN];
5087 uschar outerkey[MAX_HASHBLOCKLEN];
5089 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5091 case 1: goto EXPAND_FAILED_CURLY;
5093 case 3: goto EXPAND_FAILED;
5096 if (Ustrcmp(sub[0], "md5") == 0)
5099 use_base = &md5_base;
5103 else if (Ustrcmp(sub[0], "sha1") == 0)
5106 use_base = &sha1_base;
5112 expand_string_message =
5113 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5118 keylen = Ustrlen(keyptr);
5120 /* If the key is longer than the hash block length, then hash the key
5123 if (keylen > hashblocklen)
5125 chash_start(type, use_base);
5126 chash_end(type, use_base, keyptr, keylen, keyhash);
5131 /* Now make the inner and outer key values */
5133 memset(innerkey, 0x36, hashblocklen);
5134 memset(outerkey, 0x5c, hashblocklen);
5136 for (i = 0; i < keylen; i++)
5138 innerkey[i] ^= keyptr[i];
5139 outerkey[i] ^= keyptr[i];
5142 /* Now do the hashes */
5144 chash_start(type, use_base);
5145 chash_mid(type, use_base, innerkey);
5146 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5148 chash_start(type, use_base);
5149 chash_mid(type, use_base, outerkey);
5150 chash_end(type, use_base, innerhash, hashlen, finalhash);
5152 /* Encode the final hash as a hex string */
5155 for (i = 0; i < hashlen; i++)
5157 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5158 *p++ = hex_digits[finalhash[i] & 0x0f];
5161 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5162 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5164 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5169 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5170 We have to save the numerical variables and restore them afterwards. */
5175 int moffset, moffsetextra, slen;
5178 const uschar *rerror;
5181 int save_expand_nmax =
5182 save_expand_strings(save_expand_nstring, save_expand_nlength);
5184 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5186 case 1: goto EXPAND_FAILED_CURLY;
5188 case 3: goto EXPAND_FAILED;
5191 /* Compile the regular expression */
5193 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5198 expand_string_message = string_sprintf("regular expression error in "
5199 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5203 /* Now run a loop to do the substitutions as often as necessary. It ends
5204 when there are no more matches. Take care over matches of the null string;
5205 do the same thing as Perl does. */
5208 slen = Ustrlen(sub[0]);
5209 moffset = moffsetextra = 0;
5214 int ovector[3*(EXPAND_MAXN+1)];
5215 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5216 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5220 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5221 is not necessarily the end. We want to repeat the match from one
5222 character further along, but leaving the basic offset the same (for
5223 copying below). We can't be at the end of the string - that was checked
5224 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5225 finished; copy the remaining string and end the loop. */
5235 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5239 /* Match - set up for expanding the replacement. */
5241 if (n == 0) n = EXPAND_MAXN + 1;
5243 for (nn = 0; nn < n*2; nn += 2)
5245 expand_nstring[expand_nmax] = subject + ovector[nn];
5246 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5250 /* Copy the characters before the match, plus the expanded insertion. */
5252 yield = string_cat(yield, &size, &ptr, subject + moffset,
5253 ovector[0] - moffset);
5254 insert = expand_string(sub[2]);
5255 if (insert == NULL) goto EXPAND_FAILED;
5256 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5258 moffset = ovector[1];
5262 /* If we have matched an empty string, first check to see if we are at
5263 the end of the subject. If so, the loop is over. Otherwise, mimic
5264 what Perl's /g options does. This turns out to be rather cunning. First
5265 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5266 string at the same point. If this fails (picked up above) we advance to
5267 the next character. */
5269 if (ovector[0] == ovector[1])
5271 if (ovector[0] == slen) break;
5272 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5276 /* All done - restore numerical variables. */
5278 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5279 save_expand_nlength);
5283 /* Handle keyed and numbered substring extraction. If the first argument
5284 consists entirely of digits, then a numerical extraction is assumed. */
5290 int field_number = 1;
5291 BOOL field_number_set = FALSE;
5292 uschar *save_lookup_value = lookup_value;
5294 int save_expand_nmax =
5295 save_expand_strings(save_expand_nstring, save_expand_nlength);
5297 /* Read the arguments */
5299 for (i = 0; i < j; i++)
5301 while (isspace(*s)) s++;
5302 if (*s == '{') /*}*/
5304 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5305 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5306 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5308 /* After removal of leading and trailing white space, the first
5309 argument must not be empty; if it consists entirely of digits
5310 (optionally preceded by a minus sign), this is a numerical
5311 extraction, and we expect 3 arguments. */
5319 while (isspace(*p)) p++;
5323 while (len > 0 && isspace(p[len-1])) len--;
5330 expand_string_message = US"first argument of \"extract\" must "
5340 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5344 j = 3; /* Need 3 args */
5345 field_number_set = TRUE;
5350 else goto EXPAND_FAILED_CURLY;
5353 /* Extract either the numbered or the keyed substring into $value. If
5354 skipping, just pretend the extraction failed. */
5356 lookup_value = skipping? NULL : field_number_set?
5357 expand_gettokened(field_number, sub[1], sub[2]) :
5358 expand_getkeyed(sub[0], sub[1]);
5360 /* If no string follows, $value gets substituted; otherwise there can
5361 be yes/no strings, as for lookup or if. */
5363 switch(process_yesno(
5364 skipping, /* were previously skipping */
5365 lookup_value != NULL, /* success/failure indicator */
5366 save_lookup_value, /* value to reset for string2 */
5367 &s, /* input pointer */
5368 &yield, /* output pointer */
5369 &size, /* output size */
5370 &ptr, /* output current point */
5371 US"extract", /* condition type */
5374 case 1: goto EXPAND_FAILED; /* when all is well, the */
5375 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5378 /* All done - restore numerical variables. */
5380 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5381 save_expand_nlength);
5386 /* return the Nth item from a list */
5388 case EITEM_LISTEXTRACT:
5391 int field_number = 1;
5392 uschar *save_lookup_value = lookup_value;
5394 int save_expand_nmax =
5395 save_expand_strings(save_expand_nstring, save_expand_nlength);
5397 /* Read the field & list arguments */
5399 for (i = 0; i < 2; i++)
5401 while (isspace(*s)) s++;
5402 if (*s != '{') /*}*/
5403 goto EXPAND_FAILED_CURLY;
5405 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5406 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5407 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5409 /* After removal of leading and trailing white space, the first
5410 argument must be numeric and nonempty. */
5418 while (isspace(*p)) p++;
5422 while (len > 0 && isspace(p[len-1])) len--;
5425 if (!*p && !skipping)
5427 expand_string_message = US"first argument of \"listextract\" must "
5437 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5440 expand_string_message = US"first argument of \"listextract\" must "
5448 /* Extract the numbered element into $value. If
5449 skipping, just pretend the extraction failed. */
5451 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5453 /* If no string follows, $value gets substituted; otherwise there can
5454 be yes/no strings, as for lookup or if. */
5456 switch(process_yesno(
5457 skipping, /* were previously skipping */
5458 lookup_value != NULL, /* success/failure indicator */
5459 save_lookup_value, /* value to reset for string2 */
5460 &s, /* input pointer */
5461 &yield, /* output pointer */
5462 &size, /* output size */
5463 &ptr, /* output current point */
5464 US"extract", /* condition type */
5467 case 1: goto EXPAND_FAILED; /* when all is well, the */
5468 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5471 /* All done - restore numerical variables. */
5473 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5474 save_expand_nlength);
5480 case EITEM_CERTEXTRACT:
5482 uschar *save_lookup_value = lookup_value;
5484 int save_expand_nmax =
5485 save_expand_strings(save_expand_nstring, save_expand_nlength);
5487 /* Read the field argument */
5488 while (isspace(*s)) s++;
5489 if (*s != '{') /*}*/
5490 goto EXPAND_FAILED_CURLY;
5491 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5492 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5493 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5494 /* strip spaces fore & aft */
5499 while (isspace(*p)) p++;
5503 while (len > 0 && isspace(p[len-1])) len--;
5507 /* inspect the cert argument */
5508 while (isspace(*s)) s++;
5509 if (*s != '{') /*}*/
5510 goto EXPAND_FAILED_CURLY;
5513 expand_string_message = US"second argument of \"certextract\" must "
5514 "be a certificate variable";
5517 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5518 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5519 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5522 lookup_value = NULL;
5525 lookup_value = expand_getcertele(sub[0], sub[1]);
5526 if (*expand_string_message) goto EXPAND_FAILED;
5528 switch(process_yesno(
5529 skipping, /* were previously skipping */
5530 lookup_value != NULL, /* success/failure indicator */
5531 save_lookup_value, /* value to reset for string2 */
5532 &s, /* input pointer */
5533 &yield, /* output pointer */
5534 &size, /* output size */
5535 &ptr, /* output current point */
5536 US"extract", /* condition type */
5539 case 1: goto EXPAND_FAILED; /* when all is well, the */
5540 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5543 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5544 save_expand_nlength);
5547 #endif /*SUPPORT_TLS*/
5549 /* Handle list operations */
5557 uschar outsep[2] = { '\0', '\0' };
5558 const uschar *list, *expr, *temp;
5559 uschar *save_iterate_item = iterate_item;
5560 uschar *save_lookup_value = lookup_value;
5562 while (isspace(*s)) s++;
5563 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5565 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5566 if (list == NULL) goto EXPAND_FAILED;
5567 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5569 if (item_type == EITEM_REDUCE)
5572 while (isspace(*s)) s++;
5573 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5574 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5575 if (!t) goto EXPAND_FAILED;
5577 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5580 while (isspace(*s)) s++;
5581 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5585 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5586 if scanning a "false" part). This allows us to find the end of the
5587 condition, because if the list is empty, we won't actually evaluate the
5588 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5589 the normal internal expansion function. */
5591 if (item_type == EITEM_FILTER)
5593 temp = eval_condition(expr, &resetok, NULL);
5594 if (temp != NULL) s = temp;
5597 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5601 expand_string_message = string_sprintf("%s inside \"%s\" item",
5602 expand_string_message, name);
5606 while (isspace(*s)) s++;
5609 expand_string_message = string_sprintf("missing } at end of condition "
5610 "or expression inside \"%s\"", name);
5614 while (isspace(*s)) s++; /*{*/
5617 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5622 /* If we are skipping, we can now just move on to the next item. When
5623 processing for real, we perform the iteration. */
5625 if (skipping) continue;
5626 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5628 *outsep = (uschar)sep; /* Separator as a string */
5630 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5632 if (item_type == EITEM_FILTER)
5635 if (eval_condition(expr, &resetok, &condresult) == NULL)
5637 iterate_item = save_iterate_item;
5638 lookup_value = save_lookup_value;
5639 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5640 expand_string_message, name);
5643 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5644 condresult? "true":"false");
5646 temp = iterate_item; /* TRUE => include this item */
5648 continue; /* FALSE => skip this item */
5651 /* EITEM_MAP and EITEM_REDUCE */
5655 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5659 iterate_item = save_iterate_item;
5660 expand_string_message = string_sprintf("%s inside \"%s\" item",
5661 expand_string_message, name);
5664 if (item_type == EITEM_REDUCE)
5666 lookup_value = t; /* Update the value of $value */
5667 continue; /* and continue the iteration */
5671 /* We reach here for FILTER if the condition is true, always for MAP,
5672 and never for REDUCE. The value in "temp" is to be added to the output
5673 list that is being created, ensuring that any occurrences of the
5674 separator character are doubled. Unless we are dealing with the first
5675 item of the output list, add in a space if the new item begins with the
5676 separator character, or is an empty string. */
5678 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5679 yield = string_cat(yield, &size, &ptr, US" ", 1);
5681 /* Add the string in "temp" to the output list that we are building,
5682 This is done in chunks by searching for the separator character. */
5686 size_t seglen = Ustrcspn(temp, outsep);
5687 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5689 /* If we got to the end of the string we output one character
5690 too many; backup and end the loop. Otherwise arrange to double the
5693 if (temp[seglen] == '\0') { ptr--; break; }
5694 yield = string_cat(yield, &size, &ptr, outsep, 1);
5698 /* Output a separator after the string: we will remove the redundant
5699 final one at the end. */
5701 yield = string_cat(yield, &size, &ptr, outsep, 1);
5702 } /* End of iteration over the list loop */
5704 /* REDUCE has generated no output above: output the final value of
5707 if (item_type == EITEM_REDUCE)
5709 yield = string_cat(yield, &size, &ptr, lookup_value,
5710 Ustrlen(lookup_value));
5711 lookup_value = save_lookup_value; /* Restore $value */
5714 /* FILTER and MAP generate lists: if they have generated anything, remove
5715 the redundant final separator. Even though an empty item at the end of a
5716 list does not count, this is tidier. */
5718 else if (ptr != save_ptr) ptr--;
5720 /* Restore preserved $item */
5722 iterate_item = save_iterate_item;
5729 const uschar *srclist, *cmp, *xtract;
5731 const uschar *dstlist = NULL, *dstkeylist = NULL;
5733 uschar *save_iterate_item = iterate_item;
5735 while (isspace(*s)) s++;
5736 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5738 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5739 if (!srclist) goto EXPAND_FAILED;
5740 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5742 while (isspace(*s)) s++;
5743 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5745 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5746 if (!cmp) goto EXPAND_FAILED;
5747 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5749 while (isspace(*s)) s++;
5750 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5753 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5754 if (!tmp) goto EXPAND_FAILED;
5755 xtract = string_copyn(xtract, s - xtract);
5757 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5761 expand_string_message = US"missing } at end of \"sort\"";
5765 if (skipping) continue;
5767 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5770 uschar * newlist = NULL;
5771 uschar * newkeylist = NULL;
5774 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, srcitem);
5776 /* extract field for comparisons */
5777 iterate_item = srcitem;
5778 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5782 expand_string_message = string_sprintf(
5783 "field-extract in sort: \"%s\"", xtract);
5787 /* Insertion sort */
5789 /* copy output list until new-item < list-item */
5790 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5796 /* field for comparison */
5797 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5800 /* build and run condition string */
5801 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
5803 DEBUG(D_expand) debug_printf("%s: cond = \"%s\"\n", name, expr);
5804 if (!eval_condition(expr, &resetok, &before))
5806 expand_string_message = string_sprintf("comparison in sort: %s",
5813 /* New-item sorts before this dst-item. Append new-item,
5814 then dst-item, then remainder of dst list. */
5816 newlist = string_append_listele(newlist, sep, srcitem);
5817 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5820 newlist = string_append_listele(newlist, sep, dstitem);
5821 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5823 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5825 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5827 newlist = string_append_listele(newlist, sep, dstitem);
5828 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5834 newlist = string_append_listele(newlist, sep, dstitem);
5835 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5838 /* If we ran out of dstlist without consuming srcitem, append it */
5841 newlist = string_append_listele(newlist, sep, srcitem);
5842 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5846 dstkeylist = newkeylist;
5848 DEBUG(D_expand) debug_printf("%s: dstlist = \"%s\"\n", name, dstlist);
5849 DEBUG(D_expand) debug_printf("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
5853 yield = string_cat(yield, &size, &ptr, dstlist, Ustrlen(dstlist));
5855 /* Restore preserved $item */
5856 iterate_item = save_iterate_item;
5860 expand_string_message = US"Internal error in sort (list mismatch)";
5865 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5866 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5867 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5868 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5870 #define EXPAND_DLFUNC_MAX_ARGS 8
5873 #ifndef EXPAND_DLFUNC
5874 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5875 "is not included in this binary";
5878 #else /* EXPAND_DLFUNC */
5881 exim_dlfunc_t *func;
5884 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5886 if ((expand_forbid & RDO_DLFUNC) != 0)
5888 expand_string_message =
5889 US"dynamically-loaded functions are not permitted";
5893 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5894 TRUE, US"dlfunc", &resetok))
5896 case 1: goto EXPAND_FAILED_CURLY;
5898 case 3: goto EXPAND_FAILED;
5901 /* If skipping, we don't actually do anything */
5903 if (skipping) continue;
5905 /* Look up the dynamically loaded object handle in the tree. If it isn't
5906 found, dlopen() the file and put the handle in the tree for next time. */
5908 t = tree_search(dlobj_anchor, argv[0]);
5911 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5914 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5915 argv[0], dlerror());
5916 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5919 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5920 Ustrcpy(t->name, argv[0]);
5921 t->data.ptr = handle;
5922 (void)tree_insertnode(&dlobj_anchor, t);
5925 /* Having obtained the dynamically loaded object handle, look up the
5926 function pointer. */
5928 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5931 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5932 "%s", argv[1], argv[0], dlerror());
5933 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5937 /* Call the function and work out what to do with the result. If it
5938 returns OK, we have a replacement string; if it returns DEFER then
5939 expansion has failed in a non-forced manner; if it returns FAIL then
5940 failure was forced; if it returns ERROR or any other value there's a
5941 problem, so panic slightly. In any case, assume that the function has
5942 side-effects on the store that must be preserved. */
5946 for (argc = 0; argv[argc] != NULL; argc++);
5947 status = func(&result, argc - 2, &argv[2]);
5950 if (result == NULL) result = US"";
5951 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5956 expand_string_message = result == NULL ? US"(no message)" : result;
5957 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5958 else if(status != FAIL)
5959 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5960 argv[0], argv[1], status, expand_string_message);
5964 #endif /* EXPAND_DLFUNC */
5966 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
5969 uschar *save_lookup_value = lookup_value;
5971 while (isspace(*s)) s++;
5972 if (*s != '{') /*}*/
5975 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5976 if (!key) goto EXPAND_FAILED; /*{*/
5977 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5979 lookup_value = US getenv(CS key);
5981 switch(process_yesno(
5982 skipping, /* were previously skipping */
5983 lookup_value != NULL, /* success/failure indicator */
5984 save_lookup_value, /* value to reset for string2 */
5985 &s, /* input pointer */
5986 &yield, /* output pointer */
5987 &size, /* output size */
5988 &ptr, /* output current point */
5989 US"env", /* condition type */
5992 case 1: goto EXPAND_FAILED; /* when all is well, the */
5993 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5997 } /* EITEM_* switch */
5999 /* Control reaches here if the name is not recognized as one of the more
6000 complicated expansion items. Check for the "operator" syntax (name terminated
6001 by a colon). Some of the operators have arguments, separated by _ from the
6009 var_entry *vp = NULL;
6011 /* Owing to an historical mis-design, an underscore may be part of the
6012 operator name, or it may introduce arguments. We therefore first scan the
6013 table of names that contain underscores. If there is no match, we cut off
6014 the arguments and then scan the main table. */
6016 if ((c = chop_match(name, op_table_underscore,
6017 nelem(op_table_underscore))) < 0)
6019 arg = Ustrchr(name, '_');
6020 if (arg != NULL) *arg = 0;
6021 c = chop_match(name, op_table_main, nelem(op_table_main));
6022 if (c >= 0) c += nelem(op_table_underscore);
6023 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6026 /* Deal specially with operators that might take a certificate variable
6027 as we do not want to do the usual expansion. For most, expand the string.*/
6036 const uschar * s1 = s;
6037 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6039 if (!sub) goto EXPAND_FAILED; /*{*/
6040 if (*s1 != '}') goto EXPAND_FAILED_CURLY;
6041 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6051 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6052 if (!sub) goto EXPAND_FAILED;
6057 /* If we are skipping, we don't need to perform the operation at all.
6058 This matters for operations like "mask", because the data may not be
6059 in the correct format when skipping. For example, the expression may test
6060 for the existence of $sender_host_address before trying to mask it. For
6061 other operations, doing them may not fail, but it is a waste of time. */
6063 if (skipping && c >= 0) continue;
6065 /* Otherwise, switch on the operator type */
6072 unsigned long int n = Ustrtoul(sub, &t, 10);
6075 expand_string_message = string_sprintf("argument for base62 "
6076 "operator is \"%s\", which is not a decimal number", sub);
6079 t = string_base62(n);
6080 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6084 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6090 unsigned long int n = 0;
6093 uschar *t = Ustrchr(base62_chars, *tt++);
6096 expand_string_message = string_sprintf("argument for base62d "
6097 "operator is \"%s\", which is not a base %d number", sub,
6101 n = n * BASE_62 + (t - base62_chars);
6103 (void)sprintf(CS buf, "%ld", n);
6104 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
6110 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6111 if (expanded == NULL)
6113 expand_string_message =
6114 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6115 expand_string_message);
6118 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
6125 uschar *t = sub - 1;
6126 while (*(++t) != 0) { *t = tolower(*t); count++; }
6127 yield = string_cat(yield, &size, &ptr, sub, count);
6134 uschar *t = sub - 1;
6135 while (*(++t) != 0) { *t = toupper(*t); count++; }
6136 yield = string_cat(yield, &size, &ptr, sub, count);
6142 if (vp && *(void **)vp->value)
6144 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6145 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6155 md5_end(&base, sub, Ustrlen(sub), digest);
6156 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6157 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6163 if (vp && *(void **)vp->value)
6165 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6166 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6176 sha1_end(&base, sub, Ustrlen(sub), digest);
6177 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6178 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6184 if (vp && *(void **)vp->value)
6186 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6187 yield = string_cat(yield, &size, &ptr, cp, (int)Ustrlen(cp));
6191 expand_string_message = US"sha256 only supported for certificates";
6194 /* Convert hex encoding to base64 encoding */
6204 for (enc = sub; *enc != 0; enc++)
6206 if (!isxdigit(*enc))
6208 expand_string_message = string_sprintf("\"%s\" is not a hex "
6217 expand_string_message = string_sprintf("\"%s\" contains an odd "
6218 "number of characters", sub);
6222 while ((c = *in++) != 0)
6224 if (isdigit(c)) c -= '0';
6225 else c = toupper(c) - 'A' + 10;
6237 enc = auth_b64encode(sub, out - sub);
6238 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
6242 /* Convert octets outside 0x21..0x7E to \xXX form */
6246 uschar *t = sub - 1;
6249 if (*t < 0x21 || 0x7E < *t)
6250 yield = string_cat(yield, &size, &ptr,
6251 string_sprintf("\\x%02x", *t), 4);
6253 yield = string_cat(yield, &size, &ptr, t, 1);
6258 /* count the number of list elements */
6267 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6268 cp = string_sprintf("%d", cnt);
6269 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6273 /* expand a named list given the name */
6274 /* handles nested named lists; requotes as colon-sep list */
6278 tree_node *t = NULL;
6279 const uschar * list;
6282 uschar * suffix = US"";
6283 BOOL needsep = FALSE;
6286 if (*sub == '+') sub++;
6287 if (arg == NULL) /* no-argument version */
6289 if (!(t = tree_search(addresslist_anchor, sub)) &&
6290 !(t = tree_search(domainlist_anchor, sub)) &&
6291 !(t = tree_search(hostlist_anchor, sub)))
6292 t = tree_search(localpartlist_anchor, sub);
6294 else switch(*arg) /* specific list-type version */
6296 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6297 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6298 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6299 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6301 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6307 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6309 : *arg=='a'?"address "
6310 : *arg=='d'?"domain "
6312 : *arg=='l'?"localpart "
6317 list = ((namedlist_block *)(t->data.ptr))->string;
6319 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6321 uschar * buf = US" : ";
6323 yield = string_cat(yield, &size, &ptr, buf, 3);
6327 if (*item == '+') /* list item is itself a named list */
6329 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6330 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6332 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6336 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6337 while ((cp= strpbrk((const char *)item, tok)))
6339 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
6340 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6342 yield = string_cat(yield, &size, &ptr, US"::", 2);
6343 item = (uschar *)cp;
6345 else /* sep in item; should already be doubled; emit once */
6347 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
6348 if (*cp == sep) cp++;
6349 item = (uschar *)cp;
6353 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
6358 /* mask applies a mask to an IP address; for example the result of
6359 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6366 int mask, maskoffset;
6367 int type = string_is_ip_address(sub, &maskoffset);
6372 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6377 if (maskoffset == 0)
6379 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6384 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6386 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6388 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6393 /* Convert the address to binary integer(s) and apply the mask */
6395 sub[maskoffset] = 0;
6396 count = host_aton(sub, binary);
6397 host_mask(count, binary, mask);
6399 /* Convert to masked textual format and add to output. */
6401 yield = string_cat(yield, &size, &ptr, buffer,
6402 host_nmtoa(count, binary, mask, buffer, '.'));
6407 case EOP_LOCAL_PART:
6411 int start, end, domain;
6412 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6416 if (c != EOP_DOMAIN)
6418 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6419 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
6421 else if (domain != 0)
6424 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
6432 uschar outsep[2] = { ':', '\0' };
6433 uschar *address, *error;
6435 int start, end, domain; /* Not really used */
6437 while (isspace(*sub)) sub++;
6438 if (*sub == '>') { *outsep = *++sub; ++sub; }
6439 parse_allow_group = TRUE;
6443 uschar *p = parse_find_address_end(sub, FALSE);
6444 uschar saveend = *p;
6446 address = parse_extract_address(sub, &error, &start, &end, &domain,
6450 /* Add the address to the output list that we are building. This is
6451 done in chunks by searching for the separator character. At the
6452 start, unless we are dealing with the first address of the output
6453 list, add in a space if the new address begins with the separator
6454 character, or is an empty string. */
6456 if (address != NULL)
6458 if (ptr != save_ptr && address[0] == *outsep)
6459 yield = string_cat(yield, &size, &ptr, US" ", 1);
6463 size_t seglen = Ustrcspn(address, outsep);
6464 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
6466 /* If we got to the end of the string we output one character
6469 if (address[seglen] == '\0') { ptr--; break; }
6470 yield = string_cat(yield, &size, &ptr, outsep, 1);
6471 address += seglen + 1;
6474 /* Output a separator after the string: we will remove the
6475 redundant final one at the end. */
6477 yield = string_cat(yield, &size, &ptr, outsep, 1);
6480 if (saveend == '\0') break;
6484 /* If we have generated anything, remove the redundant final
6487 if (ptr != save_ptr) ptr--;
6488 parse_allow_group = FALSE;
6493 /* quote puts a string in quotes if it is empty or contains anything
6494 other than alphamerics, underscore, dot, or hyphen.
6496 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6497 be quoted in order to be a valid local part.
6499 In both cases, newlines and carriage returns are converted into \n and \r
6503 case EOP_QUOTE_LOCAL_PART:
6506 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6507 uschar *t = sub - 1;
6511 while (!needs_quote && *(++t) != 0)
6512 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6514 else /* EOP_QUOTE_LOCAL_PART */
6516 while (!needs_quote && *(++t) != 0)
6517 needs_quote = !isalnum(*t) &&
6518 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6519 (*t != '.' || t == sub || t[1] == 0);
6524 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6529 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6530 else if (*t == '\r')
6531 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6534 if (*t == '\\' || *t == '"')
6535 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6536 yield = string_cat(yield, &size, &ptr, t, 1);
6539 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6541 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6545 /* quote_lookuptype does lookup-specific quoting */
6550 uschar *opt = Ustrchr(arg, '_');
6552 if (opt != NULL) *opt++ = 0;
6554 n = search_findtype(arg, Ustrlen(arg));
6557 expand_string_message = search_error_message;
6561 if (lookup_list[n]->quote != NULL)
6562 sub = (lookup_list[n]->quote)(sub, opt);
6563 else if (opt != NULL) sub = NULL;
6567 expand_string_message = string_sprintf(
6568 "\"%s\" unrecognized after \"${quote_%s\"",
6573 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6577 /* rx quote sticks in \ before any non-alphameric character so that
6578 the insertion works in a regular expression. */
6582 uschar *t = sub - 1;
6586 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6587 yield = string_cat(yield, &size, &ptr, t, 1);
6592 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6593 prescribed by the RFC, if there are characters that need to be encoded */
6597 uschar buffer[2048];
6598 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6599 buffer, sizeof(buffer), FALSE);
6600 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6604 /* RFC 2047 decode */
6610 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6611 headers_charset, '?', &len, &error);
6614 expand_string_message = error;
6617 yield = string_cat(yield, &size, &ptr, decoded, len);
6621 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6631 if (c > 255) c = '_';
6633 yield = string_cat(yield, &size, &ptr, buff, 1);
6638 /* replace illegal UTF-8 sequences by replacement character */
6640 #define UTF8_REPLACEMENT_CHAR US"?"
6644 int seq_len = 0, index = 0;
6646 long codepoint = -1;
6647 uschar seq_buff[4]; /* accumulate utf-8 here */
6656 if ((c & 0xc0) != 0x80)
6657 /* wrong continuation byte; invalidate all bytes */
6658 complete = 1; /* error */
6661 codepoint = (codepoint << 6) | (c & 0x3f);
6662 seq_buff[index++] = c;
6663 if (--bytes_left == 0) /* codepoint complete */
6664 if(codepoint > 0x10FFFF) /* is it too large? */
6665 complete = -1; /* error (RFC3629 limit) */
6667 { /* finished; output utf-8 sequence */
6668 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6673 else /* no bytes left: new sequence */
6675 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6677 yield = string_cat(yield, &size, &ptr, &c, 1);
6680 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6682 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6687 codepoint = c & 0x1f;
6690 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6693 codepoint = c & 0x0f;
6695 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6698 codepoint = c & 0x07;
6700 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6703 seq_buff[index++] = c;
6704 seq_len = bytes_left + 1;
6705 } /* if(bytes_left) */
6709 bytes_left = index = 0;
6710 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6712 if ((complete == 1) && ((c & 0x80) == 0))
6713 /* ASCII character follows incomplete sequence */
6714 yield = string_cat(yield, &size, &ptr, &c, 1);
6719 #ifdef EXPERIMENTAL_INTERNATIONAL
6720 case EOP_UTF8_DOMAIN_TO_ALABEL:
6722 uschar * error = NULL;
6723 uschar * s = string_domain_utf8_to_alabel(sub, &error);
6726 expand_string_message = string_sprintf(
6727 "error converting utf8 (%s) to alabel: %s",
6728 string_printing(sub), error);
6731 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6735 case EOP_UTF8_DOMAIN_FROM_ALABEL:
6737 uschar * error = NULL;
6738 uschar * s = string_domain_alabel_to_utf8(sub, &error);
6741 expand_string_message = string_sprintf(
6742 "error converting alabel (%s) to utf8: %s",
6743 string_printing(sub), error);
6746 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6750 case EOP_UTF8_LOCALPART_TO_ALABEL:
6752 uschar * error = NULL;
6753 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
6756 expand_string_message = string_sprintf(
6757 "error converting utf8 (%s) to alabel: %s",
6758 string_printing(sub), error);
6761 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6762 DEBUG(D_expand) debug_printf("yield: '%s'\n", yield);
6766 case EOP_UTF8_LOCALPART_FROM_ALABEL:
6768 uschar * error = NULL;
6769 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
6772 expand_string_message = string_sprintf(
6773 "error converting alabel (%s) to utf8: %s",
6774 string_printing(sub), error);
6777 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6780 #endif /* EXPERIMENTAL_INTERNATIONAL */
6782 /* escape turns all non-printing characters into escape sequences. */
6786 const uschar *t = string_printing(sub);
6787 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6791 /* Handle numeric expression evaluation */
6796 uschar *save_sub = sub;
6797 uschar *error = NULL;
6798 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6801 expand_string_message = string_sprintf("error in expression "
6802 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6806 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6807 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6811 /* Handle time period formating */
6815 int n = readconf_readtime(sub, 0, FALSE);
6818 expand_string_message = string_sprintf("string \"%s\" is not an "
6819 "Exim time interval in \"%s\" operator", sub, name);
6822 sprintf(CS var_buffer, "%d", n);
6823 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6827 case EOP_TIME_INTERVAL:
6830 uschar *t = read_number(&n, sub);
6831 if (*t != 0) /* Not A Number*/
6833 expand_string_message = string_sprintf("string \"%s\" is not a "
6834 "positive number in \"%s\" operator", sub, name);
6837 t = readconf_printtime(n);
6838 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6842 /* Convert string to base64 encoding */
6846 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6847 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6851 /* strlen returns the length of the string */
6856 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6857 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6861 /* length_n or l_n takes just the first n characters or the whole string,
6862 whichever is the shorter;
6864 substr_m_n, and s_m_n take n characters from offset m; negative m take
6865 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6866 takes the rest, either to the right or to the left.
6868 hash_n or h_n makes a hash of length n from the string, yielding n
6869 characters from the set a-z; hash_n_m makes a hash of length n, but
6870 uses m characters from the set a-zA-Z0-9.
6872 nhash_n returns a single number between 0 and n-1 (in text form), while
6873 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6874 between 0 and n-1 and the second between 0 and m-1. */
6894 expand_string_message = string_sprintf("missing values after %s",
6899 /* "length" has only one argument, effectively being synonymous with
6902 if (c == EOP_LENGTH || c == EOP_L)
6908 /* The others have one or two arguments; for "substr" the first may be
6909 negative. The second being negative means "not supplied". */
6914 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6917 /* Read up to two numbers, separated by underscores */
6922 if (arg != ret && *arg == '_' && pn == &value1)
6926 if (arg[1] != 0) arg++;
6928 else if (!isdigit(*arg))
6930 expand_string_message =
6931 string_sprintf("non-digit after underscore in \"%s\"", name);
6934 else *pn = (*pn)*10 + *arg++ - '0';
6938 /* Perform the required operation */
6941 (c == EOP_HASH || c == EOP_H)?
6942 compute_hash(sub, value1, value2, &len) :
6943 (c == EOP_NHASH || c == EOP_NH)?
6944 compute_nhash(sub, value1, value2, &len) :
6945 extract_substr(sub, value1, value2, &len);
6947 if (ret == NULL) goto EXPAND_FAILED;
6948 yield = string_cat(yield, &size, &ptr, ret, len);
6958 uschar **modetable[3];
6963 if ((expand_forbid & RDO_EXISTS) != 0)
6965 expand_string_message = US"Use of the stat() expansion is not permitted";
6969 if (stat(CS sub, &st) < 0)
6971 expand_string_message = string_sprintf("stat(%s) failed: %s",
6972 sub, strerror(errno));
6976 switch (mode & S_IFMT)
6978 case S_IFIFO: smode[0] = 'p'; break;
6979 case S_IFCHR: smode[0] = 'c'; break;
6980 case S_IFDIR: smode[0] = 'd'; break;
6981 case S_IFBLK: smode[0] = 'b'; break;
6982 case S_IFREG: smode[0] = '-'; break;
6983 default: smode[0] = '?'; break;
6986 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6987 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6988 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6990 for (i = 0; i < 3; i++)
6992 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6997 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6998 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6999 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7000 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7001 (long)st.st_gid, st.st_size, (long)st.st_atime,
7002 (long)st.st_mtime, (long)st.st_ctime);
7003 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
7007 /* vaguely random number less than N */
7011 int_eximarith_t max;
7014 max = expanded_string_integer(sub, TRUE);
7015 if (expand_string_message != NULL)
7017 s = string_sprintf("%d", vaguely_random_number((int)max));
7018 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
7022 /* Reverse IP, including IPv6 to dotted-nibble */
7024 case EOP_REVERSE_IP:
7026 int family, maskptr;
7027 uschar reversed[128];
7029 family = string_is_ip_address(sub, &maskptr);
7032 expand_string_message = string_sprintf(
7033 "reverse_ip() not given an IP address [%s]", sub);
7036 invert_address(reversed, sub);
7037 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
7041 /* Unknown operator */
7044 expand_string_message =
7045 string_sprintf("unknown expansion operator \"%s\"", name);
7050 /* Handle a plain name. If this is the first thing in the expansion, release
7051 the pre-allocated buffer. If the result data is known to be in a new buffer,
7052 newsize will be set to the size of that buffer, and we can just point at that
7053 store instead of copying. Many expansion strings contain just one reference,
7054 so this is a useful optimization, especially for humungous headers
7055 ($message_headers). */
7063 if (resetok) store_reset(yield);
7067 value = find_variable(name, FALSE, skipping, &newsize);
7070 expand_string_message =
7071 string_sprintf("unknown variable in \"${%s}\"", name);
7072 check_variable_error_message(name);
7075 len = Ustrlen(value);
7076 if (yield == NULL && newsize != 0)
7082 else yield = string_cat(yield, &size, &ptr, value, len);
7086 /* Else there's something wrong */
7088 expand_string_message =
7089 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7090 "in a variable reference)", name);
7094 /* If we hit the end of the string when ket_ends is set, there is a missing
7095 terminating brace. */
7097 if (ket_ends && *s == 0)
7099 expand_string_message = malformed_header?
7100 US"missing } at end of string - could be header name not terminated by colon"
7102 US"missing } at end of string";
7106 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7107 added to the string. If so, set up an empty string. Add a terminating zero. If
7108 left != NULL, return a pointer to the terminator. */
7110 if (yield == NULL) yield = store_get(1);
7112 if (left != NULL) *left = s;
7114 /* Any stacking store that was used above the final string is no longer needed.
7115 In many cases the final string will be the first one that was got and so there
7116 will be optimal store usage. */
7118 if (resetok) store_reset(yield + ptr + 1);
7119 else if (resetok_p) *resetok_p = FALSE;
7123 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
7125 if (skipping) debug_printf("skipping: result is not used\n");
7129 /* This is the failure exit: easiest to program with a goto. We still need
7130 to update the pointer to the terminator, for cases of nested calls with "fail".
7133 EXPAND_FAILED_CURLY:
7134 expand_string_message = malformed_header?
7135 US"missing or misplaced { or } - could be header name not terminated by colon"
7137 US"missing or misplaced { or }";
7139 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7140 that is a bad idea, because expand_string_message is in dynamic store. */
7143 if (left != NULL) *left = s;
7146 debug_printf("failed to expand: %s\n", string);
7147 debug_printf(" error message: %s\n", expand_string_message);
7148 if (expand_string_forcedfail) debug_printf("failure was forced\n");
7150 if (resetok_p) *resetok_p = resetok;
7155 /* This is the external function call. Do a quick check for any expansion
7156 metacharacters, and if there are none, just return the input string.
7158 Argument: the string to be expanded
7159 Returns: the expanded string, or NULL if expansion failed; if failure was
7160 due to a lookup deferring, search_find_defer will be TRUE
7164 expand_string(uschar *string)
7166 search_find_defer = FALSE;
7167 malformed_header = FALSE;
7168 return (Ustrpbrk(string, "$\\") == NULL)? string :
7169 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7175 expand_cstring(const uschar *string)
7177 search_find_defer = FALSE;
7178 malformed_header = FALSE;
7179 return (Ustrpbrk(string, "$\\") == NULL)? string :
7180 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7185 /*************************************************
7187 *************************************************/
7189 /* Now and again we want to expand a string and be sure that the result is in a
7190 new bit of store. This function does that.
7191 Since we know it has been copied, the de-const cast is safe.
7193 Argument: the string to be expanded
7194 Returns: the expanded string, always in a new bit of store, or NULL
7198 expand_string_copy(const uschar *string)
7200 const uschar *yield = expand_cstring(string);
7201 if (yield == string) yield = string_copy(string);
7207 /*************************************************
7208 * Expand and interpret as an integer *
7209 *************************************************/
7211 /* Expand a string, and convert the result into an integer.
7214 string the string to be expanded
7215 isplus TRUE if a non-negative number is expected
7217 Returns: the integer value, or
7218 -1 for an expansion error ) in both cases, message in
7219 -2 for an integer interpretation error ) expand_string_message
7220 expand_string_message is set NULL for an OK integer
7224 expand_string_integer(uschar *string, BOOL isplus)
7226 return expanded_string_integer(expand_string(string), isplus);
7230 /*************************************************
7231 * Interpret string as an integer *
7232 *************************************************/
7234 /* Convert a string (that has already been expanded) into an integer.
7236 This function is used inside the expansion code.
7239 s the string to be expanded
7240 isplus TRUE if a non-negative number is expected
7242 Returns: the integer value, or
7243 -1 if string is NULL (which implies an expansion error)
7244 -2 for an integer interpretation error
7245 expand_string_message is set NULL for an OK integer
7248 static int_eximarith_t
7249 expanded_string_integer(const uschar *s, BOOL isplus)
7251 int_eximarith_t value;
7252 uschar *msg = US"invalid integer \"%s\"";
7255 /* If expansion failed, expand_string_message will be set. */
7257 if (s == NULL) return -1;
7259 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7260 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7261 systems, so we set it zero ourselves. */
7264 expand_string_message = NULL; /* Indicates no error */
7266 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7267 equal to 0. Unfortunately, people actually relied upon that, so preserve
7268 the behaviour explicitly. Stripping leading whitespace is a harmless
7269 noop change since strtol skips it anyway (provided that there is a number
7273 while (isspace(*s)) ++s;
7277 debug_printf("treating blank string as number 0\n");
7282 value = strtoll(CS s, CSS &endptr, 10);
7286 msg = US"integer expected but \"%s\" found";
7288 else if (value < 0 && isplus)
7290 msg = US"non-negative integer expected but \"%s\" found";
7294 switch (tolower(*endptr))
7299 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7304 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7305 else value *= 1024*1024;
7309 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7310 else value *= 1024*1024*1024;
7314 if (errno == ERANGE)
7315 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7318 while (isspace(*endptr)) endptr++;
7319 if (*endptr == 0) return value;
7323 expand_string_message = string_sprintf(CS msg, s);
7328 /* These values are usually fixed boolean values, but they are permitted to be
7332 addr address being routed
7333 mtype the module type
7334 mname the module name
7335 dbg_opt debug selectors
7336 oname the option name
7337 bvalue the router's boolean value
7338 svalue the router's string value
7339 rvalue where to put the returned value
7341 Returns: OK value placed in rvalue
7342 DEFER expansion failed
7346 exp_bool(address_item *addr,
7347 uschar *mtype, uschar *mname, unsigned dbg_opt,
7348 uschar *oname, BOOL bvalue,
7349 uschar *svalue, BOOL *rvalue)
7352 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7354 expanded = expand_string(svalue);
7355 if (expanded == NULL)
7357 if (expand_string_forcedfail)
7359 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7363 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7364 oname, mname, mtype, expand_string_message);
7365 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7369 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7372 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7374 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7378 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7379 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7389 /*************************************************
7390 **************************************************
7391 * Stand-alone test program *
7392 **************************************************
7393 *************************************************/
7399 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7401 int ovector[3*(EXPAND_MAXN+1)];
7402 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7403 ovector, nelem(ovector));
7404 BOOL yield = n >= 0;
7405 if (n == 0) n = EXPAND_MAXN + 1;
7409 expand_nmax = (setup < 0)? 0 : setup + 1;
7410 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7412 expand_nstring[expand_nmax] = subject + ovector[nn];
7413 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7421 int main(int argc, uschar **argv)
7424 uschar buffer[1024];
7426 debug_selector = D_v;
7427 debug_file = stderr;
7428 debug_fd = fileno(debug_file);
7429 big_buffer = malloc(big_buffer_size);
7431 for (i = 1; i < argc; i++)
7433 if (argv[i][0] == '+')
7435 debug_trace_memory = 2;
7438 if (isdigit(argv[i][0]))
7439 debug_selector = Ustrtol(argv[i], NULL, 0);
7441 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7445 eldap_default_servers = argv[i];
7448 mysql_servers = argv[i];
7451 pgsql_servers = argv[i];
7453 #ifdef EXPERIMENTAL_REDIS
7454 redis_servers = argv[i];
7458 else opt_perl_startup = argv[i];
7462 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7464 expand_nstring[1] = US"string 1....";
7465 expand_nlength[1] = 8;
7469 if (opt_perl_startup != NULL)
7472 printf("Starting Perl interpreter\n");
7473 errstr = init_perl(opt_perl_startup);
7476 printf("** error in perl_startup code: %s\n", errstr);
7477 return EXIT_FAILURE;
7480 #endif /* EXIM_PERL */
7482 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7484 void *reset_point = store_get(0);
7485 uschar *yield = expand_string(buffer);
7488 printf("%s\n", yield);
7489 store_reset(reset_point);
7493 if (search_find_defer) printf("search_find deferred\n");
7494 printf("Failed: %s\n", expand_string_message);
7495 if (expand_string_forcedfail) printf("Forced failure\n");
7509 /* End of expand.c */