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[] = {
240 EOP_ADDRESS = nelem(op_table_underscore),
280 /* Table of condition names, and corresponding switch numbers. The names must
281 be in alphabetical order. */
283 static uschar *cond_table[] = {
287 US"==", /* Backward compatibility */
320 US"match_local_part",
345 ECOND_FIRST_DELIVERY,
366 ECOND_MATCH_LOCAL_PART,
376 /* Types of table entry */
379 vtype_int, /* value is address of int */
380 vtype_filter_int, /* ditto, but recognized only when filtering */
381 vtype_ino, /* value is address of ino_t (not always an int) */
382 vtype_uid, /* value is address of uid_t (not always an int) */
383 vtype_gid, /* value is address of gid_t (not always an int) */
384 vtype_bool, /* value is address of bool */
385 vtype_stringptr, /* value is address of pointer to string */
386 vtype_msgbody, /* as stringptr, but read when first required */
387 vtype_msgbody_end, /* ditto, the end of the message */
388 vtype_msgheaders, /* the message's headers, processed */
389 vtype_msgheaders_raw, /* the message's headers, unprocessed */
390 vtype_localpart, /* extract local part from string */
391 vtype_domain, /* extract domain from string */
392 vtype_string_func, /* value is string returned by given function */
393 vtype_todbsdin, /* value not used; generate BSD inbox tod */
394 vtype_tode, /* value not used; generate tod in epoch format */
395 vtype_todel, /* value not used; generate tod in epoch/usec format */
396 vtype_todf, /* value not used; generate full tod */
397 vtype_todl, /* value not used; generate log tod */
398 vtype_todlf, /* value not used; generate log file datestamp tod */
399 vtype_todzone, /* value not used; generate time zone only */
400 vtype_todzulu, /* value not used; generate zulu tod */
401 vtype_reply, /* value not used; get reply from headers */
402 vtype_pid, /* value not used; result is pid */
403 vtype_host_lookup, /* value not used; get host name */
404 vtype_load_avg, /* value not used; result is int from os_getloadavg */
405 vtype_pspace, /* partition space; value is T/F for spool/log */
406 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
407 vtype_cert /* SSL certificate */
409 ,vtype_dkim /* Lookup of value in DKIM signature */
413 /* Type for main variable table */
421 /* Type for entries pointing to address/length pairs. Not currently
429 static uschar * fn_recipients(void);
431 /* This table must be kept in alphabetical order. */
433 static var_entry var_table[] = {
434 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
435 they will be confused with user-creatable ACL variables. */
436 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
437 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
438 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
439 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
440 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
441 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
442 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
443 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
444 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
445 { "acl_narg", vtype_int, &acl_narg },
446 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
447 { "address_data", vtype_stringptr, &deliver_address_data },
448 { "address_file", vtype_stringptr, &address_file },
449 { "address_pipe", vtype_stringptr, &address_pipe },
450 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
451 { "authenticated_id", vtype_stringptr, &authenticated_id },
452 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
453 { "authentication_failed",vtype_int, &authentication_failed },
454 #ifdef WITH_CONTENT_SCAN
455 { "av_failed", vtype_int, &av_failed },
457 #ifdef EXPERIMENTAL_BRIGHTMAIL
458 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
459 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
460 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
461 { "bmi_deliver", vtype_int, &bmi_deliver },
463 { "body_linecount", vtype_int, &body_linecount },
464 { "body_zerocount", vtype_int, &body_zerocount },
465 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
466 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
467 { "caller_gid", vtype_gid, &real_gid },
468 { "caller_uid", vtype_uid, &real_uid },
469 { "callout_address", vtype_stringptr, &callout_address },
470 { "compile_date", vtype_stringptr, &version_date },
471 { "compile_number", vtype_stringptr, &version_cnumber },
472 { "config_dir", vtype_stringptr, &config_main_directory },
473 { "config_file", vtype_stringptr, &config_main_filename },
474 { "csa_status", vtype_stringptr, &csa_status },
475 #ifdef EXPERIMENTAL_DCC
476 { "dcc_header", vtype_stringptr, &dcc_header },
477 { "dcc_result", vtype_stringptr, &dcc_result },
479 #ifdef WITH_OLD_DEMIME
480 { "demime_errorlevel", vtype_int, &demime_errorlevel },
481 { "demime_reason", vtype_stringptr, &demime_reason },
484 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
485 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
486 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
487 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
488 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
489 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
490 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
491 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
492 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
493 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
494 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
495 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
496 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
497 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
498 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
499 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
500 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
501 { "dkim_signers", vtype_stringptr, &dkim_signers },
502 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
503 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
505 #ifdef EXPERIMENTAL_DMARC
506 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
507 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
508 { "dmarc_status", vtype_stringptr, &dmarc_status },
509 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
510 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
512 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
513 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
514 { "dnslist_text", vtype_stringptr, &dnslist_text },
515 { "dnslist_value", vtype_stringptr, &dnslist_value },
516 { "domain", vtype_stringptr, &deliver_domain },
517 { "domain_data", vtype_stringptr, &deliver_domain_data },
518 #ifdef EXPERIMENTAL_EVENT
519 { "event_data", vtype_stringptr, &event_data },
521 /*XXX want to use generic vars for as many of these as possible*/
522 { "event_defer_errno", vtype_int, &event_defer_errno },
524 { "event_name", vtype_stringptr, &event_name },
526 { "exim_gid", vtype_gid, &exim_gid },
527 { "exim_path", vtype_stringptr, &exim_path },
528 { "exim_uid", vtype_uid, &exim_uid },
529 { "exim_version", vtype_stringptr, &version_string },
530 #ifdef WITH_OLD_DEMIME
531 { "found_extension", vtype_stringptr, &found_extension },
533 { "headers_added", vtype_string_func, &fn_hdrs_added },
534 { "home", vtype_stringptr, &deliver_home },
535 { "host", vtype_stringptr, &deliver_host },
536 { "host_address", vtype_stringptr, &deliver_host_address },
537 { "host_data", vtype_stringptr, &host_data },
538 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
539 { "host_lookup_failed", vtype_int, &host_lookup_failed },
540 { "host_port", vtype_int, &deliver_host_port },
541 { "inode", vtype_ino, &deliver_inode },
542 { "interface_address", vtype_stringptr, &interface_address },
543 { "interface_port", vtype_int, &interface_port },
544 { "item", vtype_stringptr, &iterate_item },
546 { "ldap_dn", vtype_stringptr, &eldap_dn },
548 { "load_average", vtype_load_avg, NULL },
549 { "local_part", vtype_stringptr, &deliver_localpart },
550 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
551 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
552 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
553 { "local_scan_data", vtype_stringptr, &local_scan_data },
554 { "local_user_gid", vtype_gid, &local_user_gid },
555 { "local_user_uid", vtype_uid, &local_user_uid },
556 { "localhost_number", vtype_int, &host_number },
557 { "log_inodes", vtype_pinodes, (void *)FALSE },
558 { "log_space", vtype_pspace, (void *)FALSE },
559 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
560 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
561 #ifdef WITH_CONTENT_SCAN
562 { "malware_name", vtype_stringptr, &malware_name },
564 { "max_received_linelength", vtype_int, &max_received_linelength },
565 { "message_age", vtype_int, &message_age },
566 { "message_body", vtype_msgbody, &message_body },
567 { "message_body_end", vtype_msgbody_end, &message_body_end },
568 { "message_body_size", vtype_int, &message_body_size },
569 { "message_exim_id", vtype_stringptr, &message_id },
570 { "message_headers", vtype_msgheaders, NULL },
571 { "message_headers_raw", vtype_msgheaders_raw, NULL },
572 { "message_id", vtype_stringptr, &message_id },
573 { "message_linecount", vtype_int, &message_linecount },
574 { "message_size", vtype_int, &message_size },
575 #ifdef EXPERIMENTAL_INTERNATIONAL
576 { "message_smtputf8", vtype_bool, &message_smtputf8 },
578 #ifdef WITH_CONTENT_SCAN
579 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
580 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
581 { "mime_boundary", vtype_stringptr, &mime_boundary },
582 { "mime_charset", vtype_stringptr, &mime_charset },
583 { "mime_content_description", vtype_stringptr, &mime_content_description },
584 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
585 { "mime_content_id", vtype_stringptr, &mime_content_id },
586 { "mime_content_size", vtype_int, &mime_content_size },
587 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
588 { "mime_content_type", vtype_stringptr, &mime_content_type },
589 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
590 { "mime_filename", vtype_stringptr, &mime_filename },
591 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
592 { "mime_is_multipart", vtype_int, &mime_is_multipart },
593 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
594 { "mime_part_count", vtype_int, &mime_part_count },
596 { "n0", vtype_filter_int, &filter_n[0] },
597 { "n1", vtype_filter_int, &filter_n[1] },
598 { "n2", vtype_filter_int, &filter_n[2] },
599 { "n3", vtype_filter_int, &filter_n[3] },
600 { "n4", vtype_filter_int, &filter_n[4] },
601 { "n5", vtype_filter_int, &filter_n[5] },
602 { "n6", vtype_filter_int, &filter_n[6] },
603 { "n7", vtype_filter_int, &filter_n[7] },
604 { "n8", vtype_filter_int, &filter_n[8] },
605 { "n9", vtype_filter_int, &filter_n[9] },
606 { "original_domain", vtype_stringptr, &deliver_domain_orig },
607 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
608 { "originator_gid", vtype_gid, &originator_gid },
609 { "originator_uid", vtype_uid, &originator_uid },
610 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
611 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
612 { "pid", vtype_pid, NULL },
614 { "prdr_requested", vtype_bool, &prdr_requested },
616 { "primary_hostname", vtype_stringptr, &primary_hostname },
617 #ifdef EXPERIMENTAL_PROXY
618 { "proxy_host_address", vtype_stringptr, &proxy_host_address },
619 { "proxy_host_port", vtype_int, &proxy_host_port },
620 { "proxy_session", vtype_bool, &proxy_session },
621 { "proxy_target_address",vtype_stringptr, &proxy_target_address },
622 { "proxy_target_port", vtype_int, &proxy_target_port },
624 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
625 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
626 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
627 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
628 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
629 { "rcpt_count", vtype_int, &rcpt_count },
630 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
631 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
632 { "received_count", vtype_int, &received_count },
633 { "received_for", vtype_stringptr, &received_for },
634 { "received_ip_address", vtype_stringptr, &interface_address },
635 { "received_port", vtype_int, &interface_port },
636 { "received_protocol", vtype_stringptr, &received_protocol },
637 { "received_time", vtype_int, &received_time },
638 { "recipient_data", vtype_stringptr, &recipient_data },
639 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
640 { "recipients", vtype_string_func, &fn_recipients },
641 { "recipients_count", vtype_int, &recipients_count },
642 #ifdef WITH_CONTENT_SCAN
643 { "regex_match_string", vtype_stringptr, ®ex_match_string },
645 { "reply_address", vtype_reply, NULL },
646 { "return_path", vtype_stringptr, &return_path },
647 { "return_size_limit", vtype_int, &bounce_return_size_limit },
648 { "router_name", vtype_stringptr, &router_name },
649 { "runrc", vtype_int, &runrc },
650 { "self_hostname", vtype_stringptr, &self_hostname },
651 { "sender_address", vtype_stringptr, &sender_address },
652 { "sender_address_data", vtype_stringptr, &sender_address_data },
653 { "sender_address_domain", vtype_domain, &sender_address },
654 { "sender_address_local_part", vtype_localpart, &sender_address },
655 { "sender_data", vtype_stringptr, &sender_data },
656 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
657 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
658 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
659 { "sender_host_address", vtype_stringptr, &sender_host_address },
660 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
661 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
662 { "sender_host_name", vtype_host_lookup, NULL },
663 { "sender_host_port", vtype_int, &sender_host_port },
664 { "sender_ident", vtype_stringptr, &sender_ident },
665 { "sender_rate", vtype_stringptr, &sender_rate },
666 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
667 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
668 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
669 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
670 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
671 { "sending_port", vtype_int, &sending_port },
672 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
673 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
674 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
675 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
676 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
677 { "sn0", vtype_filter_int, &filter_sn[0] },
678 { "sn1", vtype_filter_int, &filter_sn[1] },
679 { "sn2", vtype_filter_int, &filter_sn[2] },
680 { "sn3", vtype_filter_int, &filter_sn[3] },
681 { "sn4", vtype_filter_int, &filter_sn[4] },
682 { "sn5", vtype_filter_int, &filter_sn[5] },
683 { "sn6", vtype_filter_int, &filter_sn[6] },
684 { "sn7", vtype_filter_int, &filter_sn[7] },
685 { "sn8", vtype_filter_int, &filter_sn[8] },
686 { "sn9", vtype_filter_int, &filter_sn[9] },
687 #ifdef WITH_CONTENT_SCAN
688 { "spam_action", vtype_stringptr, &spam_action },
689 { "spam_bar", vtype_stringptr, &spam_bar },
690 { "spam_report", vtype_stringptr, &spam_report },
691 { "spam_score", vtype_stringptr, &spam_score },
692 { "spam_score_int", vtype_stringptr, &spam_score_int },
694 #ifdef EXPERIMENTAL_SPF
695 { "spf_guess", vtype_stringptr, &spf_guess },
696 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
697 { "spf_received", vtype_stringptr, &spf_received },
698 { "spf_result", vtype_stringptr, &spf_result },
699 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
701 { "spool_directory", vtype_stringptr, &spool_directory },
702 { "spool_inodes", vtype_pinodes, (void *)TRUE },
703 { "spool_space", vtype_pspace, (void *)TRUE },
704 #ifdef EXPERIMENTAL_SRS
705 { "srs_db_address", vtype_stringptr, &srs_db_address },
706 { "srs_db_key", vtype_stringptr, &srs_db_key },
707 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
708 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
709 { "srs_recipient", vtype_stringptr, &srs_recipient },
710 { "srs_status", vtype_stringptr, &srs_status },
712 { "thisaddress", vtype_stringptr, &filter_thisaddress },
714 /* The non-(in,out) variables are now deprecated */
715 { "tls_bits", vtype_int, &tls_in.bits },
716 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
717 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
719 { "tls_in_bits", vtype_int, &tls_in.bits },
720 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
721 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
722 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
723 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
724 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
725 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
726 #if defined(SUPPORT_TLS)
727 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
729 { "tls_out_bits", vtype_int, &tls_out.bits },
730 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
731 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
732 #ifdef EXPERIMENTAL_DANE
733 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
735 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
736 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
737 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
738 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
739 #if defined(SUPPORT_TLS)
740 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
742 #ifdef EXPERIMENTAL_DANE
743 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
746 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
747 #if defined(SUPPORT_TLS)
748 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
751 { "tod_bsdinbox", vtype_todbsdin, NULL },
752 { "tod_epoch", vtype_tode, NULL },
753 { "tod_epoch_l", vtype_todel, NULL },
754 { "tod_full", vtype_todf, NULL },
755 { "tod_log", vtype_todl, NULL },
756 { "tod_logfile", vtype_todlf, NULL },
757 { "tod_zone", vtype_todzone, NULL },
758 { "tod_zulu", vtype_todzulu, NULL },
759 { "transport_name", vtype_stringptr, &transport_name },
760 { "value", vtype_stringptr, &lookup_value },
761 { "verify_mode", vtype_stringptr, &verify_mode },
762 { "version_number", vtype_stringptr, &version_string },
763 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
764 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
765 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
766 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
767 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
768 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
771 static int var_table_size = nelem(var_table);
772 static uschar var_buffer[256];
773 static BOOL malformed_header;
775 /* For textual hashes */
777 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
778 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
781 enum { HMAC_MD5, HMAC_SHA1 };
783 /* For numeric hashes */
785 static unsigned int prime[] = {
786 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
787 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
788 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
790 /* For printing modes in symbolic form */
792 static uschar *mtable_normal[] =
793 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
795 static uschar *mtable_setid[] =
796 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
798 static uschar *mtable_sticky[] =
799 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
803 /*************************************************
804 * Tables for UTF-8 support *
805 *************************************************/
807 /* Table of the number of extra characters, indexed by the first character
808 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
811 static uschar utf8_table1[] = {
812 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
813 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
814 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
815 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
817 /* These are the masks for the data bits in the first byte of a character,
818 indexed by the number of additional bytes. */
820 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
822 /* Get the next UTF-8 character, advancing the pointer. */
824 #define GETUTF8INC(c, ptr) \
826 if ((c & 0xc0) == 0xc0) \
828 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
830 c = (c & utf8_table2[a]) << s; \
834 c |= (*ptr++ & 0x3f) << s; \
839 /*************************************************
840 * Binary chop search on a table *
841 *************************************************/
843 /* This is used for matching expansion items and operators.
846 name the name that is being sought
847 table the table to search
848 table_size the number of items in the table
850 Returns: the offset in the table, or -1
854 chop_match(uschar *name, uschar **table, int table_size)
856 uschar **bot = table;
857 uschar **top = table + table_size;
861 uschar **mid = bot + (top - bot)/2;
862 int c = Ustrcmp(name, *mid);
863 if (c == 0) return mid - table;
864 if (c > 0) bot = mid + 1; else top = mid;
872 /*************************************************
873 * Check a condition string *
874 *************************************************/
876 /* This function is called to expand a string, and test the result for a "true"
877 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
878 forced fail or lookup defer.
880 We used to release all store used, but this is not not safe due
881 to ${dlfunc } and ${acl }. In any case expand_string_internal()
882 is reasonably careful to release what it can.
884 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
887 condition the condition string
888 m1 text to be incorporated in panic error
891 Returns: TRUE if condition is met, FALSE if not
895 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
898 uschar *ss = expand_string(condition);
901 if (!expand_string_forcedfail && !search_find_defer)
902 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
903 "for %s %s: %s", condition, m1, m2, expand_string_message);
906 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
907 strcmpic(ss, US"false") != 0;
914 /*************************************************
915 * Pseudo-random number generation *
916 *************************************************/
918 /* Pseudo-random number generation. The result is not "expected" to be
919 cryptographically strong but not so weak that someone will shoot themselves
920 in the foot using it as a nonce in some email header scheme or whatever
921 weirdness they'll twist this into. The result should ideally handle fork().
923 However, if we're stuck unable to provide this, then we'll fall back to
924 appallingly bad randomness.
926 If SUPPORT_TLS is defined then this will not be used except as an emergency
931 Returns a random number in range [0, max-1]
935 # define vaguely_random_number vaguely_random_number_fallback
938 vaguely_random_number(int max)
941 # undef vaguely_random_number
943 static pid_t pid = 0;
945 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
955 #ifdef HAVE_ARC4RANDOM
956 /* cryptographically strong randomness, common on *BSD platforms, not
957 so much elsewhere. Alas. */
958 #ifndef NOT_HAVE_ARC4RANDOM_STIR
961 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
962 #ifdef HAVE_SRANDOMDEV
963 /* uses random(4) for seeding */
966 gettimeofday(&tv, NULL);
967 srandom(tv.tv_sec | tv.tv_usec | getpid());
970 /* Poor randomness and no seeding here */
977 #ifdef HAVE_ARC4RANDOM
978 return arc4random() % max;
979 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
980 return random() % max;
982 /* This one returns a 16-bit number, definitely not crypto-strong */
983 return random_number(max);
990 /*************************************************
991 * Pick out a name from a string *
992 *************************************************/
994 /* If the name is too long, it is silently truncated.
997 name points to a buffer into which to put the name
998 max is the length of the buffer
999 s points to the first alphabetic character of the name
1000 extras chars other than alphanumerics to permit
1002 Returns: pointer to the first character after the name
1004 Note: The test for *s != 0 in the while loop is necessary because
1005 Ustrchr() yields non-NULL if the character is zero (which is not something
1008 static const uschar *
1009 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1012 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1014 if (ptr < max-1) name[ptr++] = *s;
1023 /*************************************************
1024 * Pick out the rest of a header name *
1025 *************************************************/
1027 /* A variable name starting $header_ (or just $h_ for those who like
1028 abbreviations) might not be the complete header name because headers can
1029 contain any printing characters in their names, except ':'. This function is
1030 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1031 on the end, if the name was terminated by white space.
1034 name points to a buffer in which the name read so far exists
1035 max is the length of the buffer
1036 s points to the first character after the name so far, i.e. the
1037 first non-alphameric character after $header_xxxxx
1039 Returns: a pointer to the first character after the header name
1042 static const uschar *
1043 read_header_name(uschar *name, int max, const uschar *s)
1045 int prelen = Ustrchr(name, '_') - name + 1;
1046 int ptr = Ustrlen(name) - prelen;
1047 if (ptr > 0) memmove(name, name+prelen, ptr);
1048 while (mac_isgraph(*s) && *s != ':')
1050 if (ptr < max-1) name[ptr++] = *s;
1061 /*************************************************
1062 * Pick out a number from a string *
1063 *************************************************/
1066 n points to an integer into which to put the number
1067 s points to the first digit of the number
1069 Returns: a pointer to the character after the last digit
1073 read_number(int *n, uschar *s)
1076 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1080 static const uschar *
1081 read_cnumber(int *n, const uschar *s)
1084 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1090 /*************************************************
1091 * Extract keyed subfield from a string *
1092 *************************************************/
1094 /* The yield is in dynamic store; NULL means that the key was not found.
1097 key points to the name of the key
1098 s points to the string from which to extract the subfield
1100 Returns: NULL if the subfield was not found, or
1101 a pointer to the subfield's data
1105 expand_getkeyed(uschar *key, const uschar *s)
1107 int length = Ustrlen(key);
1108 while (isspace(*s)) s++;
1110 /* Loop to search for the key */
1116 const uschar *dkey = s;
1118 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1119 dkeylength = s - dkey;
1120 while (isspace(*s)) s++;
1121 if (*s == '=') while (isspace((*(++s))));
1123 data = string_dequote(&s);
1124 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1127 while (isspace(*s)) s++;
1136 find_var_ent(uschar * name)
1139 int last = var_table_size;
1141 while (last > first)
1143 int middle = (first + last)/2;
1144 int c = Ustrcmp(name, var_table[middle].name);
1146 if (c > 0) { first = middle + 1; continue; }
1147 if (c < 0) { last = middle; continue; }
1148 return &var_table[middle];
1153 /*************************************************
1154 * Extract numbered subfield from string *
1155 *************************************************/
1157 /* Extracts a numbered field from a string that is divided by tokens - for
1158 example a line from /etc/passwd is divided by colon characters. First field is
1159 numbered one. Negative arguments count from the right. Zero returns the whole
1160 string. Returns NULL if there are insufficient tokens in the string
1163 Modifies final argument - this is a dynamically generated string, so that's OK.
1166 field number of field to be extracted,
1167 first field = 1, whole string = 0, last field = -1
1168 separators characters that are used to break string into tokens
1169 s points to the string from which to extract the subfield
1171 Returns: NULL if the field was not found,
1172 a pointer to the field's data inside s (modified to add 0)
1176 expand_gettokened (int field, uschar *separators, uschar *s)
1181 uschar *fieldtext = NULL;
1183 if (field == 0) return s;
1185 /* Break the line up into fields in place; for field > 0 we stop when we have
1186 done the number of fields we want. For field < 0 we continue till the end of
1187 the string, counting the number of fields. */
1189 count = (field > 0)? field : INT_MAX;
1195 /* Previous field was the last one in the string. For a positive field
1196 number, this means there are not enough fields. For a negative field number,
1197 check that there are enough, and scan back to find the one that is wanted. */
1201 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1202 if ((-field) == (INT_MAX - count - 1)) return s;
1206 while (ss[-1] != 0) ss--;
1212 /* Previous field was not last in the string; save its start and put a
1216 len = Ustrcspn(ss, separators);
1227 expand_getlistele(int field, const uschar * list)
1229 const uschar * tlist= list;
1235 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1238 if(field==0) return NULL;
1239 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1240 return string_nextinlist(&list, &sep, NULL, 0);
1244 /* Certificate fields, by name. Worry about by-OID later */
1245 /* Names are chosen to not have common prefixes */
1252 uschar * (*getfn)(void * cert, uschar * mod);
1254 static certfield certfields[] =
1255 { /* linear search; no special order */
1256 { US"version", 7, &tls_cert_version },
1257 { US"serial_number", 13, &tls_cert_serial_number },
1258 { US"subject", 7, &tls_cert_subject },
1259 { US"notbefore", 9, &tls_cert_not_before },
1260 { US"notafter", 8, &tls_cert_not_after },
1261 { US"issuer", 6, &tls_cert_issuer },
1262 { US"signature", 9, &tls_cert_signature },
1263 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1264 { US"subj_altname", 12, &tls_cert_subject_altname },
1265 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1266 { US"crl_uri", 7, &tls_cert_crl_uri },
1270 expand_getcertele(uschar * field, uschar * certvar)
1275 if (!(vp = find_var_ent(certvar)))
1277 expand_string_message =
1278 string_sprintf("no variable named \"%s\"", certvar);
1279 return NULL; /* Unknown variable name */
1281 /* NB this stops us passing certs around in variable. Might
1282 want to do that in future */
1283 if (vp->type != vtype_cert)
1285 expand_string_message =
1286 string_sprintf("\"%s\" is not a certificate", certvar);
1287 return NULL; /* Unknown variable name */
1289 if (!*(void **)vp->value)
1292 if (*field >= '0' && *field <= '9')
1293 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1295 for(cp = certfields;
1296 cp < certfields + nelem(certfields);
1298 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1300 uschar * modifier = *(field += cp->namelen) == ','
1302 return (*cp->getfn)( *(void **)vp->value, modifier );
1305 expand_string_message =
1306 string_sprintf("bad field selector \"%s\" for certextract", field);
1309 #endif /*SUPPORT_TLS*/
1311 /*************************************************
1312 * Extract a substring from a string *
1313 *************************************************/
1315 /* Perform the ${substr or ${length expansion operations.
1318 subject the input string
1319 value1 the offset from the start of the input string to the start of
1320 the output string; if negative, count from the right.
1321 value2 the length of the output string, or negative (-1) for unset
1322 if value1 is positive, unset means "all after"
1323 if value1 is negative, unset means "all before"
1324 len set to the length of the returned string
1326 Returns: pointer to the output string, or NULL if there is an error
1330 extract_substr(uschar *subject, int value1, int value2, int *len)
1332 int sublen = Ustrlen(subject);
1334 if (value1 < 0) /* count from right */
1338 /* If the position is before the start, skip to the start, and adjust the
1339 length. If the length ends up negative, the substring is null because nothing
1340 can precede. This falls out naturally when the length is unset, meaning "all
1346 if (value2 < 0) value2 = 0;
1350 /* Otherwise an unset length => characters before value1 */
1352 else if (value2 < 0)
1359 /* For a non-negative offset, if the starting position is past the end of the
1360 string, the result will be the null string. Otherwise, an unset length means
1361 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1365 if (value1 > sublen)
1370 else if (value2 < 0) value2 = sublen;
1373 /* Cut the length down to the maximum possible for the offset value, and get
1374 the required characters. */
1376 if (value1 + value2 > sublen) value2 = sublen - value1;
1378 return subject + value1;
1384 /*************************************************
1385 * Old-style hash of a string *
1386 *************************************************/
1388 /* Perform the ${hash expansion operation.
1391 subject the input string (an expanded substring)
1392 value1 the length of the output string; if greater or equal to the
1393 length of the input string, the input string is returned
1394 value2 the number of hash characters to use, or 26 if negative
1395 len set to the length of the returned string
1397 Returns: pointer to the output string, or NULL if there is an error
1401 compute_hash(uschar *subject, int value1, int value2, int *len)
1403 int sublen = Ustrlen(subject);
1405 if (value2 < 0) value2 = 26;
1406 else if (value2 > Ustrlen(hashcodes))
1408 expand_string_message =
1409 string_sprintf("hash count \"%d\" too big", value2);
1413 /* Calculate the hash text. We know it is shorter than the original string, so
1414 can safely place it in subject[] (we know that subject is always itself an
1415 expanded substring). */
1417 if (value1 < sublen)
1422 while ((c = (subject[j])) != 0)
1424 int shift = (c + j++) & 7;
1425 subject[i] ^= (c << shift) | (c >> (8-shift));
1426 if (++i >= value1) i = 0;
1428 for (i = 0; i < value1; i++)
1429 subject[i] = hashcodes[(subject[i]) % value2];
1431 else value1 = sublen;
1440 /*************************************************
1441 * Numeric hash of a string *
1442 *************************************************/
1444 /* Perform the ${nhash expansion operation. The first characters of the
1445 string are treated as most important, and get the highest prime numbers.
1448 subject the input string
1449 value1 the maximum value of the first part of the result
1450 value2 the maximum value of the second part of the result,
1451 or negative to produce only a one-part result
1452 len set to the length of the returned string
1454 Returns: pointer to the output string, or NULL if there is an error.
1458 compute_nhash (uschar *subject, int value1, int value2, int *len)
1460 uschar *s = subject;
1462 unsigned long int total = 0; /* no overflow */
1466 if (i == 0) i = nelem(prime) - 1;
1467 total += prime[i--] * (unsigned int)(*s++);
1470 /* If value2 is unset, just compute one number */
1474 s = string_sprintf("%d", total % value1);
1477 /* Otherwise do a div/mod hash */
1481 total = total % (value1 * value2);
1482 s = string_sprintf("%d/%d", total/value2, total % value2);
1493 /*************************************************
1494 * Find the value of a header or headers *
1495 *************************************************/
1497 /* Multiple instances of the same header get concatenated, and this function
1498 can also return a concatenation of all the header lines. When concatenating
1499 specific headers that contain lists of addresses, a comma is inserted between
1500 them. Otherwise we use a straight concatenation. Because some messages can have
1501 pathologically large number of lines, there is a limit on the length that is
1502 returned. Also, to avoid massive store use which would result from using
1503 string_cat() as it copies and extends strings, we do a preliminary pass to find
1504 out exactly how much store will be needed. On "normal" messages this will be
1508 name the name of the header, without the leading $header_ or $h_,
1509 or NULL if a concatenation of all headers is required
1510 exists_only TRUE if called from a def: test; don't need to build a string;
1511 just return a string that is not "" and not "0" if the header
1513 newsize return the size of memory block that was obtained; may be NULL
1514 if exists_only is TRUE
1515 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1516 other than concatenating, will be done on the header. Also used
1517 for $message_headers_raw.
1518 charset name of charset to translate MIME words to; used only if
1519 want_raw is false; if NULL, no translation is done (this is
1520 used for $bh_ and $bheader_)
1522 Returns: NULL if the header does not exist, else a pointer to a new
1527 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1530 BOOL found = name == NULL;
1532 int len = found? 0 : Ustrlen(name);
1534 uschar *yield = NULL;
1537 /* Loop for two passes - saves code repetition */
1539 for (i = 0; i < 2; i++)
1544 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1546 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1548 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1553 if (exists_only) return US"1"; /* don't need actual string */
1555 t = h->text + len; /* text to insert */
1556 if (!want_raw) /* unless wanted raw, */
1557 while (isspace(*t)) t++; /* remove leading white space */
1558 ilen = h->slen - (t - h->text); /* length to insert */
1560 /* Unless wanted raw, remove trailing whitespace, including the
1564 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1566 /* Set comma = 1 if handling a single header and it's one of those
1567 that contains an address list, except when asked for raw headers. Only
1568 need to do this once. */
1570 if (!want_raw && name != NULL && comma == 0 &&
1571 Ustrchr("BCFRST", h->type) != NULL)
1574 /* First pass - compute total store needed; second pass - compute
1575 total store used, including this header. */
1577 size += ilen + comma + 1; /* +1 for the newline */
1579 /* Second pass - concatentate the data, up to a maximum. Note that
1580 the loop stops when size hits the limit. */
1584 if (size > header_insert_maxlen)
1586 ilen -= size - header_insert_maxlen - 1;
1589 Ustrncpy(ptr, t, ilen);
1592 /* For a non-raw header, put in the comma if needed, then add
1593 back the newline we removed above, provided there was some text in
1596 if (!want_raw && ilen > 0)
1598 if (comma != 0) *ptr++ = ',';
1606 /* At end of first pass, return NULL if no header found. Then truncate size
1607 if necessary, and get the buffer to hold the data, returning the buffer size.
1612 if (!found) return NULL;
1613 if (size > header_insert_maxlen) size = header_insert_maxlen;
1614 *newsize = size + 1;
1615 ptr = yield = store_get(*newsize);
1619 /* That's all we do for raw header expansion. */
1626 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1627 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1628 function can return an error with decoded data if the charset translation
1629 fails. If decoding fails, it returns NULL. */
1633 uschar *decoded, *error;
1634 if (ptr > yield && ptr[-1] == '\n') ptr--;
1635 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1637 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1641 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1642 " input was: %s\n", error, yield);
1644 if (decoded != NULL) yield = decoded;
1653 /*************************************************
1654 * Return list of recipients *
1655 *************************************************/
1656 /* A recipients list is available only during system message filtering,
1657 during ACL processing after DATA, and while expanding pipe commands
1658 generated from a system filter, but not elsewhere. */
1663 if (!enable_dollar_recipients) return NULL; else
1668 uschar * s = store_get(size);
1669 for (i = 0; i < recipients_count; i++)
1671 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1672 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1673 Ustrlen(recipients_list[i].address));
1675 s[ptr] = 0; /* string_cat() leaves room */
1681 /*************************************************
1682 * Find value of a variable *
1683 *************************************************/
1685 /* The table of variables is kept in alphabetic order, so we can search it
1686 using a binary chop. The "choplen" variable is nothing to do with the binary
1690 name the name of the variable being sought
1691 exists_only TRUE if this is a def: test; passed on to find_header()
1692 skipping TRUE => skip any processing evaluation; this is not the same as
1693 exists_only because def: may test for values that are first
1695 newsize pointer to an int which is initially zero; if the answer is in
1696 a new memory buffer, *newsize is set to its size
1698 Returns: NULL if the variable does not exist, or
1699 a pointer to the variable's contents, or
1700 something non-NULL if exists_only is TRUE
1704 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1711 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1712 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1713 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1714 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1715 (this gave backwards compatibility at the changeover). There may be built-in
1716 variables whose names start acl_ but they should never start in this way. This
1717 slightly messy specification is a consequence of the history, needless to say.
1719 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1720 set, in which case give an error. */
1722 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1726 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1727 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1730 /* Handle $auth<n> variables. */
1732 if (Ustrncmp(name, "auth", 4) == 0)
1735 int n = Ustrtoul(name + 4, &endptr, 10);
1736 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1737 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1739 else if (Ustrncmp(name, "regex", 5) == 0)
1742 int n = Ustrtoul(name + 5, &endptr, 10);
1743 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1744 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1747 /* For all other variables, search the table */
1749 if (!(vp = find_var_ent(name)))
1750 return NULL; /* Unknown variable name */
1752 /* Found an existing variable. If in skipping state, the value isn't needed,
1753 and we want to avoid processing (such as looking up the host name). */
1761 case vtype_filter_int:
1762 if (!filter_running) return NULL;
1766 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1770 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1774 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1778 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1782 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1785 case vtype_stringptr: /* Pointer to string */
1786 s = *((uschar **)(val));
1787 return (s == NULL)? US"" : s;
1790 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1793 case vtype_load_avg:
1794 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1797 case vtype_host_lookup: /* Lookup if not done so */
1798 if (sender_host_name == NULL && sender_host_address != NULL &&
1799 !host_lookup_failed && host_name_lookup() == OK)
1800 host_build_sender_fullhost();
1801 return (sender_host_name == NULL)? US"" : sender_host_name;
1803 case vtype_localpart: /* Get local part from address */
1804 s = *((uschar **)(val));
1805 if (s == NULL) return US"";
1806 domain = Ustrrchr(s, '@');
1807 if (domain == NULL) return s;
1808 if (domain - s > sizeof(var_buffer) - 1)
1809 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1810 " in string expansion", sizeof(var_buffer));
1811 Ustrncpy(var_buffer, s, domain - s);
1812 var_buffer[domain - s] = 0;
1815 case vtype_domain: /* Get domain from address */
1816 s = *((uschar **)(val));
1817 if (s == NULL) return US"";
1818 domain = Ustrrchr(s, '@');
1819 return (domain == NULL)? US"" : domain + 1;
1821 case vtype_msgheaders:
1822 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1824 case vtype_msgheaders_raw:
1825 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1827 case vtype_msgbody: /* Pointer to msgbody string */
1828 case vtype_msgbody_end: /* Ditto, the end of the msg */
1829 ss = (uschar **)(val);
1830 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1833 off_t start_offset = SPOOL_DATA_START_OFFSET;
1834 int len = message_body_visible;
1835 if (len > message_size) len = message_size;
1836 *ss = body = store_malloc(len+1);
1838 if (vp->type == vtype_msgbody_end)
1840 struct stat statbuf;
1841 if (fstat(deliver_datafile, &statbuf) == 0)
1843 start_offset = statbuf.st_size - len;
1844 if (start_offset < SPOOL_DATA_START_OFFSET)
1845 start_offset = SPOOL_DATA_START_OFFSET;
1848 lseek(deliver_datafile, start_offset, SEEK_SET);
1849 len = read(deliver_datafile, body, len);
1853 if (message_body_newlines) /* Separate loops for efficiency */
1856 { if (body[--len] == 0) body[len] = ' '; }
1861 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1865 return (*ss == NULL)? US"" : *ss;
1867 case vtype_todbsdin: /* BSD inbox time of day */
1868 return tod_stamp(tod_bsdin);
1870 case vtype_tode: /* Unix epoch time of day */
1871 return tod_stamp(tod_epoch);
1873 case vtype_todel: /* Unix epoch/usec time of day */
1874 return tod_stamp(tod_epoch_l);
1876 case vtype_todf: /* Full time of day */
1877 return tod_stamp(tod_full);
1879 case vtype_todl: /* Log format time of day */
1880 return tod_stamp(tod_log_bare); /* (without timezone) */
1882 case vtype_todzone: /* Time zone offset only */
1883 return tod_stamp(tod_zone);
1885 case vtype_todzulu: /* Zulu time */
1886 return tod_stamp(tod_zulu);
1888 case vtype_todlf: /* Log file datestamp tod */
1889 return tod_stamp(tod_log_datestamp_daily);
1891 case vtype_reply: /* Get reply address */
1892 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1894 if (s != NULL) while (isspace(*s)) s++;
1895 if (s == NULL || *s == 0)
1897 *newsize = 0; /* For the *s==0 case */
1898 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1903 while (isspace(*s)) s++;
1904 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1905 while (t > s && isspace(t[-1])) t--;
1908 return (s == NULL)? US"" : s;
1910 case vtype_string_func:
1912 uschar * (*fn)() = val;
1919 sprintf(CS var_buffer, "%d",
1920 receive_statvfs(val == (void *)TRUE, &inodes));
1927 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1928 sprintf(CS var_buffer, "%d", inodes);
1933 return *(void **)val ? US"<cert>" : US"";
1935 #ifndef DISABLE_DKIM
1937 return dkim_exim_expand_query((int)(long)val);
1942 return NULL; /* Unknown variable. Silences static checkers. */
1949 modify_variable(uschar *name, void * value)
1952 if ((vp = find_var_ent(name))) vp->value = value;
1953 return; /* Unknown variable name, fail silently */
1960 /*************************************************
1961 * Read and expand substrings *
1962 *************************************************/
1964 /* This function is called to read and expand argument substrings for various
1965 expansion items. Some have a minimum requirement that is less than the maximum;
1966 in these cases, the first non-present one is set to NULL.
1969 sub points to vector of pointers to set
1970 n maximum number of substrings
1972 sptr points to current string pointer
1973 skipping the skipping flag
1974 check_end if TRUE, check for final '}'
1975 name name of item, for error message
1976 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1979 Returns: 0 OK; string pointer updated
1980 1 curly bracketing error (too few arguments)
1981 2 too many arguments (only if check_end is set); message set
1982 3 other error (expansion failure)
1986 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1987 BOOL check_end, uschar *name, BOOL *resetok)
1990 const uschar *s = *sptr;
1992 while (isspace(*s)) s++;
1993 for (i = 0; i < n; i++)
1997 if (i < m) return 1;
2001 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
2002 if (sub[i] == NULL) return 3;
2003 if (*s++ != '}') return 1;
2004 while (isspace(*s)) s++;
2006 if (check_end && *s++ != '}')
2010 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
2011 "(max is %d)", name, n);
2024 /*************************************************
2025 * Elaborate message for bad variable *
2026 *************************************************/
2028 /* For the "unknown variable" message, take a look at the variable's name, and
2029 give additional information about possible ACL variables. The extra information
2030 is added on to expand_string_message.
2032 Argument: the name of the variable
2037 check_variable_error_message(uschar *name)
2039 if (Ustrncmp(name, "acl_", 4) == 0)
2040 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2041 (name[4] == 'c' || name[4] == 'm')?
2043 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2044 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2046 US"user-defined ACL variables must start acl_c or acl_m");
2052 Load args from sub array to globals, and call acl_check().
2053 Sub array will be corrupted on return.
2055 Returns: OK access is granted by an ACCEPT verb
2056 DISCARD access is granted by a DISCARD verb
2057 FAIL access is denied
2058 FAIL_DROP access is denied; drop the connection
2059 DEFER can't tell at the moment
2063 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2066 int sav_narg = acl_narg;
2068 uschar * dummy_logmsg;
2069 extern int acl_where;
2071 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2072 for (i = 0; i < nsub && sub[i+1]; i++)
2074 uschar * tmp = acl_arg[i];
2075 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2076 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2081 sub[i+1] = acl_arg[i];
2082 acl_arg[i++] = NULL;
2086 debug_printf("expanding: acl: %s arg: %s%s\n",
2088 acl_narg>0 ? acl_arg[0] : US"<none>",
2089 acl_narg>1 ? " +more" : "");
2091 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2093 for (i = 0; i < nsub; i++)
2094 acl_arg[i] = sub[i+1]; /* restore old args */
2095 acl_narg = sav_narg;
2103 /*************************************************
2104 * Read and evaluate a condition *
2105 *************************************************/
2109 s points to the start of the condition text
2110 resetok points to a BOOL which is written false if it is unsafe to
2111 free memory. Certain condition types (acl) may have side-effect
2112 allocation which must be preserved.
2113 yield points to a BOOL to hold the result of the condition test;
2114 if NULL, we are just reading through a condition that is
2115 part of an "or" combination to check syntax, or in a state
2116 where the answer isn't required
2118 Returns: a pointer to the first character after the condition, or
2122 static const uschar *
2123 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2125 BOOL testfor = TRUE;
2126 BOOL tempcond, combined_cond;
2128 BOOL sub2_honour_dollar = TRUE;
2129 int i, rc, cond_type, roffset;
2130 int_eximarith_t num[2];
2131 struct stat statbuf;
2133 const uschar *sub[10];
2136 const uschar *rerror;
2140 while (isspace(*s)) s++;
2141 if (*s == '!') { testfor = !testfor; s++; } else break;
2144 /* Numeric comparisons are symbolic */
2146 if (*s == '=' || *s == '>' || *s == '<')
2158 /* All other conditions are named */
2160 else s = read_name(name, 256, s, US"_");
2162 /* If we haven't read a name, it means some non-alpha character is first. */
2166 expand_string_message = string_sprintf("condition name expected, "
2167 "but found \"%.16s\"", s);
2171 /* Find which condition we are dealing with, and switch on it */
2173 cond_type = chop_match(name, cond_table, nelem(cond_table));
2176 /* def: tests for a non-empty variable, or for the existence of a header. If
2177 yield == NULL we are in a skipping state, and don't care about the answer. */
2182 expand_string_message = US"\":\" expected after \"def\"";
2186 s = read_name(name, 256, s+1, US"_");
2188 /* Test for a header's existence. If the name contains a closing brace
2189 character, this may be a user error where the terminating colon has been
2190 omitted. Set a flag to adjust a subsequent error message in this case. */
2192 if (Ustrncmp(name, "h_", 2) == 0 ||
2193 Ustrncmp(name, "rh_", 3) == 0 ||
2194 Ustrncmp(name, "bh_", 3) == 0 ||
2195 Ustrncmp(name, "header_", 7) == 0 ||
2196 Ustrncmp(name, "rheader_", 8) == 0 ||
2197 Ustrncmp(name, "bheader_", 8) == 0)
2199 s = read_header_name(name, 256, s);
2200 /* {-for-text-editors */
2201 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2202 if (yield != NULL) *yield =
2203 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2206 /* Test for a variable's having a non-empty value. A non-existent variable
2207 causes an expansion failure. */
2211 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2214 expand_string_message = (name[0] == 0)?
2215 string_sprintf("variable name omitted after \"def:\"") :
2216 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2217 check_variable_error_message(name);
2220 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2226 /* first_delivery tests for first delivery attempt */
2228 case ECOND_FIRST_DELIVERY:
2229 if (yield != NULL) *yield = deliver_firsttime == testfor;
2233 /* queue_running tests for any process started by a queue runner */
2235 case ECOND_QUEUE_RUNNING:
2236 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2240 /* exists: tests for file existence
2241 isip: tests for any IP address
2242 isip4: tests for an IPv4 address
2243 isip6: tests for an IPv6 address
2244 pam: does PAM authentication
2245 radius: does RADIUS authentication
2246 ldapauth: does LDAP authentication
2247 pwcheck: does Cyrus SASL pwcheck authentication
2256 case ECOND_LDAPAUTH:
2259 while (isspace(*s)) s++;
2260 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2262 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2263 if (sub[0] == NULL) return NULL;
2264 /* {-for-text-editors */
2265 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2267 if (yield == NULL) return s; /* No need to run the test if skipping */
2272 if ((expand_forbid & RDO_EXISTS) != 0)
2274 expand_string_message = US"File existence tests are not permitted";
2277 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2283 rc = string_is_ip_address(sub[0], NULL);
2284 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2285 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2288 /* Various authentication tests - all optionally compiled */
2292 rc = auth_call_pam(sub[0], &expand_string_message);
2295 goto COND_FAILED_NOT_COMPILED;
2296 #endif /* SUPPORT_PAM */
2299 #ifdef RADIUS_CONFIG_FILE
2300 rc = auth_call_radius(sub[0], &expand_string_message);
2303 goto COND_FAILED_NOT_COMPILED;
2304 #endif /* RADIUS_CONFIG_FILE */
2306 case ECOND_LDAPAUTH:
2309 /* Just to keep the interface the same */
2311 int old_pool = store_pool;
2312 store_pool = POOL_SEARCH;
2313 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2314 &expand_string_message, &do_cache);
2315 store_pool = old_pool;
2319 goto COND_FAILED_NOT_COMPILED;
2320 #endif /* LOOKUP_LDAP */
2323 #ifdef CYRUS_PWCHECK_SOCKET
2324 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2327 goto COND_FAILED_NOT_COMPILED;
2328 #endif /* CYRUS_PWCHECK_SOCKET */
2330 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2331 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2333 if (rc == ERROR || rc == DEFER) return NULL;
2334 *yield = (rc == OK) == testfor;
2340 /* call ACL (in a conditional context). Accept true, deny false.
2341 Defer is a forced-fail. Anything set by message= goes to $value.
2342 Up to ten parameters are used; we use the braces round the name+args
2343 like the saslauthd condition does, to permit a variable number of args.
2344 See also the expansion-item version EITEM_ACL and the traditional
2345 acl modifier ACLC_ACL.
2346 Since the ACL may allocate new global variables, tell our caller to not
2351 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2359 while (isspace(*s)) s++;
2360 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2362 switch(read_subs(sub, nelem(sub), 1,
2363 &s, yield == NULL, TRUE, US"acl", resetok))
2365 case 1: expand_string_message = US"too few arguments or bracketing "
2368 case 3: return NULL;
2372 if (yield != NULL) switch(eval_acl(sub, nelem(sub), &user_msg))
2377 lookup_value = NULL;
2380 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2381 lookup_value[ptr] = '\0';
2383 *yield = cond == testfor;
2387 expand_string_forcedfail = TRUE;
2389 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2396 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2398 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2400 However, the last two are optional. That is why the whole set is enclosed
2401 in their own set of braces. */
2403 case ECOND_SASLAUTHD:
2404 #ifndef CYRUS_SASLAUTHD_SOCKET
2405 goto COND_FAILED_NOT_COMPILED;
2409 while (isspace(*s)) s++;
2410 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2411 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2414 case 1: expand_string_message = US"too few arguments or bracketing "
2415 "error for saslauthd";
2417 case 3: return NULL;
2419 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2422 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2423 &expand_string_message);
2424 if (rc == ERROR || rc == DEFER) return NULL;
2425 *yield = (rc == OK) == testfor;
2429 #endif /* CYRUS_SASLAUTHD_SOCKET */
2432 /* symbolic operators for numeric and string comparison, and a number of
2433 other operators, all requiring two arguments.
2435 crypteq: encrypts plaintext and compares against an encrypted text,
2436 using crypt(), crypt16(), MD5 or SHA-1
2437 inlist/inlisti: checks if first argument is in the list of the second
2438 match: does a regular expression match and sets up the numerical
2439 variables if it succeeds
2440 match_address: matches in an address list
2441 match_domain: matches in a domain list
2442 match_ip: matches a host list that is restricted to IP addresses
2443 match_local_part: matches in a local part list
2446 case ECOND_MATCH_ADDRESS:
2447 case ECOND_MATCH_DOMAIN:
2448 case ECOND_MATCH_IP:
2449 case ECOND_MATCH_LOCAL_PART:
2450 #ifndef EXPAND_LISTMATCH_RHS
2451 sub2_honour_dollar = FALSE;
2460 case ECOND_NUM_L: /* Numerical comparisons */
2467 case ECOND_STR_LT: /* String comparisons */
2478 for (i = 0; i < 2; i++)
2480 /* Sometimes, we don't expand substrings; too many insecure configurations
2481 created using match_address{}{} and friends, where the second param
2482 includes information from untrustworthy sources. */
2483 BOOL honour_dollar = TRUE;
2484 if ((i > 0) && !sub2_honour_dollar)
2485 honour_dollar = FALSE;
2487 while (isspace(*s)) s++;
2490 if (i == 0) goto COND_FAILED_CURLY_START;
2491 expand_string_message = string_sprintf("missing 2nd string in {} "
2492 "after \"%s\"", name);
2495 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2496 honour_dollar, resetok);
2497 if (sub[i] == NULL) return NULL;
2498 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2500 /* Convert to numerical if required; we know that the names of all the
2501 conditions that compare numbers do not start with a letter. This just saves
2502 checking for them individually. */
2504 if (!isalpha(name[0]) && yield != NULL)
2510 debug_printf("empty string cast to zero for numerical comparison\n");
2514 num[i] = expanded_string_integer(sub[i], FALSE);
2515 if (expand_string_message != NULL) return NULL;
2520 /* Result not required */
2522 if (yield == NULL) return s;
2524 /* Do an appropriate comparison */
2530 tempcond = (num[0] == num[1]);
2534 tempcond = (num[0] > num[1]);
2538 tempcond = (num[0] >= num[1]);
2542 tempcond = (num[0] < num[1]);
2546 tempcond = (num[0] <= num[1]);
2550 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2554 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2558 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2562 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2566 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2570 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2574 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2578 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2582 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2586 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2589 case ECOND_MATCH: /* Regular expression match */
2590 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2594 expand_string_message = string_sprintf("regular expression error in "
2595 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2598 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2601 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2602 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2603 goto MATCHED_SOMETHING;
2605 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2606 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2607 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2608 goto MATCHED_SOMETHING;
2610 case ECOND_MATCH_IP: /* Match IP address in a host list */
2611 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2613 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2619 unsigned int *nullcache = NULL;
2620 check_host_block cb;
2622 cb.host_name = US"";
2623 cb.host_address = sub[0];
2625 /* If the host address starts off ::ffff: it is an IPv6 address in
2626 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2629 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2630 cb.host_address + 7 : cb.host_address;
2632 rc = match_check_list(
2633 &sub[1], /* the list */
2634 0, /* separator character */
2635 &hostlist_anchor, /* anchor pointer */
2636 &nullcache, /* cache pointer */
2637 check_host, /* function for testing */
2638 &cb, /* argument for function */
2639 MCL_HOST, /* type of check */
2640 sub[0], /* text for debugging */
2641 NULL); /* where to pass back data */
2643 goto MATCHED_SOMETHING;
2645 case ECOND_MATCH_LOCAL_PART:
2646 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2647 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2662 expand_string_message = string_sprintf("unable to complete match "
2663 "against \"%s\": %s", sub[1], search_error_message);
2669 /* Various "encrypted" comparisons. If the second string starts with
2670 "{" then an encryption type is given. Default to crypt() or crypt16()
2671 (build-time choice). */
2672 /* }-for-text-editors */
2675 #ifndef SUPPORT_CRYPTEQ
2676 goto COND_FAILED_NOT_COMPILED;
2678 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2680 int sublen = Ustrlen(sub[1]+5);
2685 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2687 /* If the length that we are comparing against is 24, the MD5 digest
2688 is expressed as a base64 string. This is the way LDAP does it. However,
2689 some other software uses a straightforward hex representation. We assume
2690 this if the length is 32. Other lengths fail. */
2694 uschar *coded = auth_b64encode((uschar *)digest, 16);
2695 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2696 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2697 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2699 else if (sublen == 32)
2703 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2705 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2706 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2707 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2711 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2712 "fail\n crypted=%s\n", sub[1]+5);
2717 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2719 int sublen = Ustrlen(sub[1]+6);
2724 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2726 /* If the length that we are comparing against is 28, assume the SHA1
2727 digest is expressed as a base64 string. If the length is 40, assume a
2728 straightforward hex representation. Other lengths fail. */
2732 uschar *coded = auth_b64encode((uschar *)digest, 20);
2733 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2734 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2735 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2737 else if (sublen == 40)
2741 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2743 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2744 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2745 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2749 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2750 "fail\n crypted=%s\n", sub[1]+6);
2755 else /* {crypt} or {crypt16} and non-{ at start */
2756 /* }-for-text-editors */
2761 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2766 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2771 else if (sub[1][0] == '{') /* }-for-text-editors */
2773 expand_string_message = string_sprintf("unknown encryption mechanism "
2774 "in \"%s\"", sub[1]);
2780 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2781 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2782 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2786 #define XSTR(s) STR(s)
2787 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2788 " subject=%s\n crypted=%s\n",
2789 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2794 /* If the encrypted string contains fewer than two characters (for the
2795 salt), force failure. Otherwise we get false positives: with an empty
2796 string the yield of crypt() is an empty string! */
2798 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2799 (Ustrcmp(coded, sub[1]) == 0);
2802 #endif /* SUPPORT_CRYPTEQ */
2807 const uschar * list = sub[1];
2809 uschar *save_iterate_item = iterate_item;
2810 int (*compare)(const uschar *, const uschar *);
2812 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2815 compare = cond_type == ECOND_INLISTI
2816 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2818 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2819 if (compare(sub[0], iterate_item) == 0)
2824 iterate_item = save_iterate_item;
2827 } /* Switch for comparison conditions */
2829 *yield = tempcond == testfor;
2830 return s; /* End of comparison conditions */
2833 /* and/or: computes logical and/or of several conditions */
2837 subcondptr = (yield == NULL)? NULL : &tempcond;
2838 combined_cond = (cond_type == ECOND_AND);
2840 while (isspace(*s)) s++;
2841 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2845 while (isspace(*s)) s++;
2846 /* {-for-text-editors */
2847 if (*s == '}') break;
2848 if (*s != '{') /* }-for-text-editors */
2850 expand_string_message = string_sprintf("each subcondition "
2851 "inside an \"%s{...}\" condition must be in its own {}", name);
2855 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2857 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2858 expand_string_message, name);
2861 while (isspace(*s)) s++;
2863 /* {-for-text-editors */
2866 /* {-for-text-editors */
2867 expand_string_message = string_sprintf("missing } at end of condition "
2868 "inside \"%s\" group", name);
2874 if (cond_type == ECOND_AND)
2876 combined_cond &= tempcond;
2877 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2878 } /* evaluate any more */
2881 combined_cond |= tempcond;
2882 if (combined_cond) subcondptr = NULL; /* once true, don't */
2883 } /* evaluate any more */
2887 if (yield != NULL) *yield = (combined_cond == testfor);
2891 /* forall/forany: iterates a condition with different values */
2896 const uschar * list;
2898 uschar *save_iterate_item = iterate_item;
2900 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2902 while (isspace(*s)) s++;
2903 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2904 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2905 if (sub[0] == NULL) return NULL;
2906 /* {-for-text-editors */
2907 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2909 while (isspace(*s)) s++;
2910 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2914 /* Call eval_condition once, with result discarded (as if scanning a
2915 "false" part). This allows us to find the end of the condition, because if
2916 the list it empty, we won't actually evaluate the condition for real. */
2918 if (!(s = eval_condition(sub[1], resetok, NULL)))
2920 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2921 expand_string_message, name);
2924 while (isspace(*s)) s++;
2926 /* {-for-text-editors */
2929 /* {-for-text-editors */
2930 expand_string_message = string_sprintf("missing } at end of condition "
2931 "inside \"%s\"", name);
2935 if (yield != NULL) *yield = !testfor;
2937 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2939 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2940 if (!eval_condition(sub[1], resetok, &tempcond))
2942 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2943 expand_string_message, name);
2944 iterate_item = save_iterate_item;
2947 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2948 tempcond? "true":"false");
2950 if (yield != NULL) *yield = (tempcond == testfor);
2951 if (tempcond == (cond_type == ECOND_FORANY)) break;
2954 iterate_item = save_iterate_item;
2959 /* The bool{} expansion condition maps a string to boolean.
2960 The values supported should match those supported by the ACL condition
2961 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2962 of true/false. Note that Router "condition" rules have a different
2963 interpretation, where general data can be used and only a few values
2965 Note that readconf.c boolean matching, for boolean configuration options,
2966 only matches true/yes/false/no.
2967 The bool_lax{} condition matches the Router logic, which is much more
2970 case ECOND_BOOL_LAX:
2976 BOOL boolvalue = FALSE;
2977 while (isspace(*s)) s++;
2978 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2979 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2980 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2982 case 1: expand_string_message = string_sprintf(
2983 "too few arguments or bracketing error for %s",
2987 case 3: return NULL;
2990 while (isspace(*t)) t++;
2994 /* trailing whitespace: seems like a good idea to ignore it too */
2996 while (isspace(*t2)) t2--;
2997 if (t2 != (t + len))
3004 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
3005 /* logic for the lax case from expand_check_condition(), which also does
3006 expands, and the logic is both short and stable enough that there should
3007 be no maintenance burden from replicating it. */
3011 ? Ustrspn(t+1, "0123456789") == len-1
3012 : Ustrspn(t, "0123456789") == len)
3014 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3015 /* expand_check_condition only does a literal string "0" check */
3016 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3019 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3021 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3023 else if (cond_type == ECOND_BOOL_LAX)
3027 expand_string_message = string_sprintf("unrecognised boolean "
3031 if (yield != NULL) *yield = (boolvalue == testfor);
3035 /* Unknown condition */
3038 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3040 } /* End switch on condition type */
3042 /* Missing braces at start and end of data */
3044 COND_FAILED_CURLY_START:
3045 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3048 COND_FAILED_CURLY_END:
3049 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3053 /* A condition requires code that is not compiled */
3055 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3056 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3057 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3058 COND_FAILED_NOT_COMPILED:
3059 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3068 /*************************************************
3069 * Save numerical variables *
3070 *************************************************/
3072 /* This function is called from items such as "if" that want to preserve and
3073 restore the numbered variables.
3076 save_expand_string points to an array of pointers to set
3077 save_expand_nlength points to an array of ints for the lengths
3079 Returns: the value of expand max to save
3083 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3086 for (i = 0; i <= expand_nmax; i++)
3088 save_expand_nstring[i] = expand_nstring[i];
3089 save_expand_nlength[i] = expand_nlength[i];
3096 /*************************************************
3097 * Restore numerical variables *
3098 *************************************************/
3100 /* This function restored saved values of numerical strings.
3103 save_expand_nmax the number of strings to restore
3104 save_expand_string points to an array of pointers
3105 save_expand_nlength points to an array of ints
3111 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3112 int *save_expand_nlength)
3115 expand_nmax = save_expand_nmax;
3116 for (i = 0; i <= expand_nmax; i++)
3118 expand_nstring[i] = save_expand_nstring[i];
3119 expand_nlength[i] = save_expand_nlength[i];
3127 /*************************************************
3128 * Handle yes/no substrings *
3129 *************************************************/
3131 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3132 alternative substrings that depend on whether or not the condition was true,
3133 or the lookup or extraction succeeded. The substrings always have to be
3134 expanded, to check their syntax, but "skipping" is set when the result is not
3135 needed - this avoids unnecessary nested lookups.
3138 skipping TRUE if we were skipping when this item was reached
3139 yes TRUE if the first string is to be used, else use the second
3140 save_lookup a value to put back into lookup_value before the 2nd expansion
3141 sptr points to the input string pointer
3142 yieldptr points to the output string pointer
3143 sizeptr points to the output string size
3144 ptrptr points to the output string pointer
3145 type "lookup" or "if" or "extract" or "run", for error message
3146 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3149 Returns: 0 OK; lookup_value has been reset to save_lookup
3151 2 expansion failed because of bracketing error
3155 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3156 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3159 const uschar *s = *sptr; /* Local value */
3160 uschar *sub1, *sub2;
3162 /* If there are no following strings, we substitute the contents of $value for
3163 lookups and for extractions in the success case. For the ${if item, the string
3164 "true" is substituted. In the fail case, nothing is substituted for all three
3167 while (isspace(*s)) s++;
3172 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3176 if (yes && lookup_value != NULL)
3177 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3178 Ustrlen(lookup_value));
3179 lookup_value = save_lookup;
3185 /* The first following string must be braced. */
3187 if (*s++ != '{') goto FAILED_CURLY;
3189 /* Expand the first substring. Forced failures are noticed only if we actually
3190 want this string. Set skipping in the call in the fail case (this will always
3191 be the case if we were already skipping). */
3193 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3194 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3195 expand_string_forcedfail = FALSE;
3196 if (*s++ != '}') goto FAILED_CURLY;
3198 /* If we want the first string, add it to the output */
3201 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3203 /* If this is called from a lookup or an extract, we want to restore $value to
3204 what it was at the start of the item, so that it has this value during the
3205 second string expansion. For the call from "if" or "run" to this function,
3206 save_lookup is set to lookup_value, so that this statement does nothing. */
3208 lookup_value = save_lookup;
3210 /* There now follows either another substring, or "fail", or nothing. This
3211 time, forced failures are noticed only if we want the second string. We must
3212 set skipping in the nested call if we don't want this string, or if we were
3213 already skipping. */
3215 while (isspace(*s)) s++;
3218 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3219 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3220 expand_string_forcedfail = FALSE;
3221 if (*s++ != '}') goto FAILED_CURLY;
3223 /* If we want the second string, add it to the output */
3226 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3229 /* If there is no second string, but the word "fail" is present when the use of
3230 the second string is wanted, set a flag indicating it was a forced failure
3231 rather than a syntactic error. Swallow the terminating } in case this is nested
3232 inside another lookup or if or extract. */
3237 /* deconst cast ok here as source is s anyway */
3238 s = US read_name(name, sizeof(name), s, US"_");
3239 if (Ustrcmp(name, "fail") == 0)
3241 if (!yes && !skipping)
3243 while (isspace(*s)) s++;
3244 if (*s++ != '}') goto FAILED_CURLY;
3245 expand_string_message =
3246 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3247 expand_string_forcedfail = TRUE;
3253 expand_string_message =
3254 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3259 /* All we have to do now is to check on the final closing brace. */
3261 while (isspace(*s)) s++;
3262 if (*s++ == '}') goto RETURN;
3264 /* Get here if there is a bracketing failure */
3269 /* Get here for other failures */
3274 /* Update the input pointer value before returning */
3284 /*************************************************
3285 * Handle MD5 or SHA-1 computation for HMAC *
3286 *************************************************/
3288 /* These are some wrapping functions that enable the HMAC code to be a bit
3289 cleaner. A good compiler will spot the tail recursion.
3292 type HMAC_MD5 or HMAC_SHA1
3293 remaining are as for the cryptographic hash functions
3299 chash_start(int type, void *base)
3301 if (type == HMAC_MD5)
3302 md5_start((md5 *)base);
3304 sha1_start((sha1 *)base);
3308 chash_mid(int type, void *base, uschar *string)
3310 if (type == HMAC_MD5)
3311 md5_mid((md5 *)base, string);
3313 sha1_mid((sha1 *)base, string);
3317 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3319 if (type == HMAC_MD5)
3320 md5_end((md5 *)base, string, length, digest);
3322 sha1_end((sha1 *)base, string, length, digest);
3329 /********************************************************
3330 * prvs: Get last three digits of days since Jan 1, 1970 *
3331 ********************************************************/
3333 /* This is needed to implement the "prvs" BATV reverse
3336 Argument: integer "days" offset to add or substract to
3337 or from the current number of days.
3339 Returns: pointer to string containing the last three
3340 digits of the number of days since Jan 1, 1970,
3341 modified by the offset argument, NULL if there
3342 was an error in the conversion.
3347 prvs_daystamp(int day_offset)
3349 uschar *days = store_get(32); /* Need at least 24 for cases */
3350 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3351 (time(NULL) + day_offset*86400)/86400);
3352 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3357 /********************************************************
3358 * prvs: perform HMAC-SHA1 computation of prvs bits *
3359 ********************************************************/
3361 /* This is needed to implement the "prvs" BATV reverse
3365 address RFC2821 Address to use
3366 key The key to use (must be less than 64 characters
3368 key_num Single-digit key number to use. Defaults to
3371 Returns: pointer to string containing the first three
3372 bytes of the final hash in hex format, NULL if
3373 there was an error in the process.
3377 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3379 uschar *hash_source, *p;
3380 int size = 0,offset = 0,i;
3382 void *use_base = &sha1_base;
3383 uschar innerhash[20];
3384 uschar finalhash[20];
3385 uschar innerkey[64];
3386 uschar outerkey[64];
3387 uschar *finalhash_hex = store_get(40);
3389 if (key_num == NULL)
3392 if (Ustrlen(key) > 64)
3395 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3396 string_cat(hash_source,&size,&offset,daystamp,3);
3397 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3398 hash_source[offset] = '\0';
3400 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3402 memset(innerkey, 0x36, 64);
3403 memset(outerkey, 0x5c, 64);
3405 for (i = 0; i < Ustrlen(key); i++)
3407 innerkey[i] ^= key[i];
3408 outerkey[i] ^= key[i];
3411 chash_start(HMAC_SHA1, use_base);
3412 chash_mid(HMAC_SHA1, use_base, innerkey);
3413 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3415 chash_start(HMAC_SHA1, use_base);
3416 chash_mid(HMAC_SHA1, use_base, outerkey);
3417 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3420 for (i = 0; i < 3; i++)
3422 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3423 *p++ = hex_digits[finalhash[i] & 0x0f];
3427 return finalhash_hex;
3433 /*************************************************
3434 * Join a file onto the output string *
3435 *************************************************/
3437 /* This is used for readfile and after a run expansion. It joins the contents
3438 of a file onto the output string, globally replacing newlines with a given
3439 string (optionally). The file is closed at the end.
3443 yield pointer to the expandable string
3444 sizep pointer to the current size
3445 ptrp pointer to the current position
3446 eol newline replacement string, or NULL
3448 Returns: new value of string pointer
3452 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3455 uschar buffer[1024];
3457 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3459 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3461 int len = Ustrlen(buffer);
3462 if (eol != NULL && buffer[len-1] == '\n') len--;
3463 yield = string_cat(yield, sizep, ptrp, buffer, len);
3464 if (buffer[len] != 0)
3465 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3468 if (yield != NULL) yield[*ptrp] = 0;
3476 /*************************************************
3477 * Evaluate numeric expression *
3478 *************************************************/
3480 /* This is a set of mutually recursive functions that evaluate an arithmetic
3481 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3482 these functions that is called from elsewhere is eval_expr, whose interface is:
3485 sptr pointer to the pointer to the string - gets updated
3486 decimal TRUE if numbers are to be assumed decimal
3487 error pointer to where to put an error message - must be NULL on input
3488 endket TRUE if ')' must terminate - FALSE for external call
3490 Returns: on success: the value of the expression, with *error still NULL
3491 on failure: an undefined value, with *error = a message
3494 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3497 static int_eximarith_t
3498 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3501 int_eximarith_t x = eval_op_or(&s, decimal, error);
3507 *error = US"expecting closing parenthesis";
3509 while (isspace(*(++s)));
3511 else if (*s != 0) *error = US"expecting operator";
3518 static int_eximarith_t
3519 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3524 while (isspace(*s)) s++;
3529 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3531 switch (tolower(*s))
3534 case 'k': n *= 1024; s++; break;
3535 case 'm': n *= 1024*1024; s++; break;
3536 case 'g': n *= 1024*1024*1024; s++; break;
3538 while (isspace (*s)) s++;
3543 n = eval_expr(&s, decimal, error, 1);
3547 *error = US"expecting number or opening parenthesis";
3555 static int_eximarith_t
3556 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3560 while (isspace(*s)) s++;
3561 if (*s == '+' || *s == '-' || *s == '~')
3564 x = eval_op_unary(&s, decimal, error);
3565 if (op == '-') x = -x;
3566 else if (op == '~') x = ~x;
3570 x = eval_number(&s, decimal, error);
3577 static int_eximarith_t
3578 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3581 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3584 while (*s == '*' || *s == '/' || *s == '%')
3587 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3588 if (*error != NULL) break;
3589 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3590 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3591 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3592 * -N*M is INT_MIN will yielf INT_MIN.
3593 * Since we don't support floating point, this is somewhat simpler.
3594 * Ideally, we'd return an error, but since we overflow for all other
3595 * arithmetic, consistency suggests otherwise, but what's the correct value
3596 * to use? There is none.
3597 * The C standard guarantees overflow for unsigned arithmetic but signed
3598 * overflow invokes undefined behaviour; in practice, this is overflow
3599 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3600 * that long/longlong larger than int are available, or we could just work
3601 * with larger types. We should consider whether to guarantee 32bit eval
3602 * and 64-bit working variables, with errors returned. For now ...
3603 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3604 * can just let the other invalid results occur otherwise, as they have
3605 * until now. For this one case, we can coerce.
3607 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3610 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3611 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3621 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3637 static int_eximarith_t
3638 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3641 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3644 while (*s == '+' || *s == '-')
3647 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3648 if (*error != NULL) break;
3649 if (op == '+') x += y; else x -= y;
3657 static int_eximarith_t
3658 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3661 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3664 while ((*s == '<' || *s == '>') && s[1] == s[0])
3669 y = eval_op_sum(&s, decimal, error);
3670 if (*error != NULL) break;
3671 if (op == '<') x <<= y; else x >>= y;
3679 static int_eximarith_t
3680 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3683 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3690 y = eval_op_shift(&s, decimal, error);
3691 if (*error != NULL) break;
3700 static int_eximarith_t
3701 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3704 int_eximarith_t x = eval_op_and(&s, decimal, error);
3711 y = eval_op_and(&s, decimal, error);
3712 if (*error != NULL) break;
3721 static int_eximarith_t
3722 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3725 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3732 y = eval_op_xor(&s, decimal, error);
3733 if (*error != NULL) break;
3743 /*************************************************
3745 *************************************************/
3747 /* Returns either an unchanged string, or the expanded string in stacking pool
3748 store. Interpreted sequences are:
3750 \... normal escaping rules
3751 $name substitutes the variable
3753 ${op:string} operates on the expanded string value
3754 ${item{arg1}{arg2}...} expands the args and then does the business
3755 some literal args are not enclosed in {}
3757 There are now far too many operators and item types to make it worth listing
3758 them here in detail any more.
3760 We use an internal routine recursively to handle embedded substrings. The
3761 external function follows. The yield is NULL if the expansion failed, and there
3762 are two cases: if something collapsed syntactically, or if "fail" was given
3763 as the action on a lookup failure. These can be distinguised by looking at the
3764 variable expand_string_forcedfail, which is TRUE in the latter case.
3766 The skipping flag is set true when expanding a substring that isn't actually
3767 going to be used (after "if" or "lookup") and it prevents lookups from
3768 happening lower down.
3770 Store usage: At start, a store block of the length of the input plus 64
3771 is obtained. This is expanded as necessary by string_cat(), which might have to
3772 get a new block, or might be able to expand the original. At the end of the
3773 function we can release any store above that portion of the yield block that
3774 was actually used. In many cases this will be optimal.
3776 However: if the first item in the expansion is a variable name or header name,
3777 we reset the store before processing it; if the result is in fresh store, we
3778 use that without copying. This is helpful for expanding strings like
3779 $message_headers which can get very long.
3781 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3782 since resetting the store at the end of the expansion will free store that was
3783 allocated by the plugin code as well as the slop after the expanded string. So
3784 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3785 and, given the acl condition, ${if }. This is an unfortunate consequence of
3786 string expansion becoming too powerful.
3789 string the string to be expanded
3790 ket_ends true if expansion is to stop at }
3791 left if not NULL, a pointer to the first character after the
3792 expansion is placed here (typically used with ket_ends)
3793 skipping TRUE for recursive calls when the value isn't actually going
3794 to be used (to allow for optimisation)
3795 honour_dollar TRUE if $ is to be expanded,
3796 FALSE if it's just another character
3797 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3800 Returns: NULL if expansion fails:
3801 expand_string_forcedfail is set TRUE if failure was forced
3802 expand_string_message contains a textual error message
3803 a pointer to the expanded string on success
3807 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3808 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3811 int size = Ustrlen(string)+ 64;
3813 uschar *yield = store_get(size);
3814 const uschar *s = string;
3815 uschar *save_expand_nstring[EXPAND_MAXN+1];
3816 int save_expand_nlength[EXPAND_MAXN+1];
3817 BOOL resetok = TRUE;
3819 expand_string_forcedfail = FALSE;
3820 expand_string_message = US"";
3827 /* \ escapes the next character, which must exist, or else
3828 the expansion fails. There's a special escape, \N, which causes
3829 copying of the subject verbatim up to the next \N. Otherwise,
3830 the escapes are the standard set. */
3836 expand_string_message = US"\\ at end of string";
3842 const uschar * t = s + 2;
3843 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3844 yield = string_cat(yield, &size, &ptr, t, s - t);
3845 if (*s != 0) s += 2;
3851 ch[0] = string_interpret_escape(&s);
3853 yield = string_cat(yield, &size, &ptr, ch, 1);
3860 /* Anything other than $ is just copied verbatim, unless we are
3861 looking for a terminating } character. */
3864 if (ket_ends && *s == '}') break;
3866 if (*s != '$' || !honour_dollar)
3868 yield = string_cat(yield, &size, &ptr, s++, 1);
3872 /* No { after the $ - must be a plain name or a number for string
3873 match variable. There has to be a fudge for variables that are the
3874 names of header fields preceded by "$header_" because header field
3875 names can contain any printing characters except space and colon.
3876 For those that don't like typing this much, "$h_" is a synonym for
3877 "$header_". A non-existent header yields a NULL value; nothing is
3880 if (isalpha((*(++s))))
3885 s = read_name(name, sizeof(name), s, US"_");
3887 /* If this is the first thing to be expanded, release the pre-allocated
3890 if (ptr == 0 && yield != NULL)
3892 if (resetok) store_reset(yield);
3899 if (Ustrncmp(name, "h_", 2) == 0 ||
3900 Ustrncmp(name, "rh_", 3) == 0 ||
3901 Ustrncmp(name, "bh_", 3) == 0 ||
3902 Ustrncmp(name, "header_", 7) == 0 ||
3903 Ustrncmp(name, "rheader_", 8) == 0 ||
3904 Ustrncmp(name, "bheader_", 8) == 0)
3906 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3907 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3908 s = read_header_name(name, sizeof(name), s);
3909 value = find_header(name, FALSE, &newsize, want_raw, charset);
3911 /* If we didn't find the header, and the header contains a closing brace
3912 character, this may be a user error where the terminating colon
3913 has been omitted. Set a flag to adjust the error message in this case.
3914 But there is no error here - nothing gets inserted. */
3918 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3927 value = find_variable(name, FALSE, skipping, &newsize);
3930 expand_string_message =
3931 string_sprintf("unknown variable name \"%s\"", name);
3932 check_variable_error_message(name);
3937 /* If the data is known to be in a new buffer, newsize will be set to the
3938 size of that buffer. If this is the first thing in an expansion string,
3939 yield will be NULL; just point it at the new store instead of copying. Many
3940 expansion strings contain just one reference, so this is a useful
3941 optimization, especially for humungous headers. */
3943 len = Ustrlen(value);
3944 if (yield == NULL && newsize != 0)
3950 else yield = string_cat(yield, &size, &ptr, value, len);
3958 s = read_cnumber(&n, s);
3959 if (n >= 0 && n <= expand_nmax)
3960 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3965 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3967 if (*s != '{') /*}*/
3969 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3973 /* After { there can be various things, but they all start with
3974 an initial word, except for a number for a string match variable. */
3976 if (isdigit((*(++s))))
3979 s = read_cnumber(&n, s); /*{*/
3982 expand_string_message = US"} expected after number";
3985 if (n >= 0 && n <= expand_nmax)
3986 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3993 expand_string_message = US"letter or digit expected after ${"; /*}*/
3997 /* Allow "-" in names to cater for substrings with negative
3998 arguments. Since we are checking for known names after { this is
4001 s = read_name(name, sizeof(name), s, US"_-");
4002 item_type = chop_match(name, item_table, nelem(item_table));
4006 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4007 If the ACL returns accept or reject we return content set by "message ="
4008 There is currently no limit on recursion; this would have us call
4009 acl_check_internal() directly and get a current level from somewhere.
4010 See also the acl expansion condition ECOND_ACL and the traditional
4011 acl modifier ACLC_ACL.
4012 Assume that the function has side-effects on the store that must be preserved.
4016 /* ${acl {name} {arg1}{arg2}...} */
4018 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4021 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4024 case 1: goto EXPAND_FAILED_CURLY;
4026 case 3: goto EXPAND_FAILED;
4028 if (skipping) continue;
4031 switch(eval_acl(sub, nelem(sub), &user_msg))
4036 debug_printf("acl expansion yield: %s\n", user_msg);
4038 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
4042 expand_string_forcedfail = TRUE;
4044 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4049 /* Handle conditionals - preserve the values of the numerical expansion
4050 variables in case they get changed by a regular expression match in the
4051 condition. If not, they retain their external settings. At the end
4052 of this "if" section, they get restored to their previous values. */
4057 const uschar *next_s;
4058 int save_expand_nmax =
4059 save_expand_strings(save_expand_nstring, save_expand_nlength);
4061 while (isspace(*s)) s++;
4062 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
4063 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4066 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
4067 cond? "true" : "false");
4071 /* The handling of "yes" and "no" result strings is now in a separate
4072 function that is also used by ${lookup} and ${extract} and ${run}. */
4074 switch(process_yesno(
4075 skipping, /* were previously skipping */
4076 cond, /* success/failure indicator */
4077 lookup_value, /* value to reset for string2 */
4078 &s, /* input pointer */
4079 &yield, /* output pointer */
4080 &size, /* output size */
4081 &ptr, /* output current point */
4082 US"if", /* condition type */
4085 case 1: goto EXPAND_FAILED; /* when all is well, the */
4086 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4089 /* Restore external setting of expansion variables for continuation
4092 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4093 save_expand_nlength);
4097 #ifdef EXPERIMENTAL_INTERNATIONAL
4098 case EITEM_IMAPFOLDER:
4099 { /* ${imapfolder {name}{sep]{specials}} */
4103 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4106 case 1: goto EXPAND_FAILED_CURLY;
4108 case 3: goto EXPAND_FAILED;
4111 if (sub_arg[1] == NULL) /* One argument */
4113 sub_arg[1] = US"/"; /* default separator */
4116 else if (Ustrlen(sub_arg[1]) != 1)
4118 expand_string_message =
4120 "IMAP folder separator must be one character, found \"%s\"",
4125 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4126 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4129 yield = string_cat(yield, &size, &ptr, encoded, Ustrlen(encoded));
4134 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4135 expanding an internal string that isn't actually going to be used. All we
4136 need to do is check the syntax, so don't do a lookup at all. Preserve the
4137 values of the numerical expansion variables in case they get changed by a
4138 partial lookup. If not, they retain their external settings. At the end
4139 of this "lookup" section, they get restored to their previous values. */
4143 int stype, partial, affixlen, starflags;
4144 int expand_setup = 0;
4146 uschar *key, *filename;
4147 const uschar *affix;
4148 uschar *save_lookup_value = lookup_value;
4149 int save_expand_nmax =
4150 save_expand_strings(save_expand_nstring, save_expand_nlength);
4152 if ((expand_forbid & RDO_LOOKUP) != 0)
4154 expand_string_message = US"lookup expansions are not permitted";
4158 /* Get the key we are to look up for single-key+file style lookups.
4159 Otherwise set the key NULL pro-tem. */
4161 while (isspace(*s)) s++;
4162 if (*s == '{') /*}*/
4164 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4165 if (key == NULL) goto EXPAND_FAILED; /*{*/
4166 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4167 while (isspace(*s)) s++;
4171 /* Find out the type of database */
4175 expand_string_message = US"missing lookup type";
4179 /* The type is a string that may contain special characters of various
4180 kinds. Allow everything except space or { to appear; the actual content
4181 is checked by search_findtype_partial. */ /*}*/
4183 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4185 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4189 while (isspace(*s)) s++;
4191 /* Now check for the individual search type and any partial or default
4192 options. Only those types that are actually in the binary are valid. */
4194 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4198 expand_string_message = search_error_message;
4202 /* Check that a key was provided for those lookup types that need it,
4203 and was not supplied for those that use the query style. */
4205 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4209 expand_string_message = string_sprintf("missing {key} for single-"
4210 "key \"%s\" lookup", name);
4218 expand_string_message = string_sprintf("a single key was given for "
4219 "lookup type \"%s\", which is not a single-key lookup type", name);
4224 /* Get the next string in brackets and expand it. It is the file name for
4225 single-key+file lookups, and the whole query otherwise. In the case of
4226 queries that also require a file name (e.g. sqlite), the file name comes
4229 if (*s != '{') goto EXPAND_FAILED_CURLY;
4230 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4231 if (filename == NULL) goto EXPAND_FAILED;
4232 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4233 while (isspace(*s)) s++;
4235 /* If this isn't a single-key+file lookup, re-arrange the variables
4236 to be appropriate for the search_ functions. For query-style lookups,
4237 there is just a "key", and no file name. For the special query-style +
4238 file types, the query (i.e. "key") starts with a file name. */
4242 while (isspace(*filename)) filename++;
4245 if (mac_islookup(stype, lookup_querystyle))
4251 if (*filename != '/')
4253 expand_string_message = string_sprintf(
4254 "absolute file name expected for \"%s\" lookup", name);
4257 while (*key != 0 && !isspace(*key)) key++;
4258 if (*key != 0) *key++ = 0;
4262 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4263 the entry was not found. Note that there is no search_close() function.
4264 Files are left open in case of re-use. At suitable places in higher logic,
4265 search_tidyup() is called to tidy all open files. This can save opening
4266 the same file several times. However, files may also get closed when
4267 others are opened, if too many are open at once. The rule is that a
4268 handle should not be used after a second search_open().
4270 Request that a partial search sets up $1 and maybe $2 by passing
4271 expand_setup containing zero. If its value changes, reset expand_nmax,
4272 since new variables will have been set. Note that at the end of this
4273 "lookup" section, the old numeric variables are restored. */
4276 lookup_value = NULL;
4279 void *handle = search_open(filename, stype, 0, NULL, NULL);
4282 expand_string_message = search_error_message;
4285 lookup_value = search_find(handle, filename, key, partial, affix,
4286 affixlen, starflags, &expand_setup);
4287 if (search_find_defer)
4289 expand_string_message =
4290 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4291 string_printing2(key, FALSE), search_error_message);
4294 if (expand_setup > 0) expand_nmax = expand_setup;
4297 /* The handling of "yes" and "no" result strings is now in a separate
4298 function that is also used by ${if} and ${extract}. */
4300 switch(process_yesno(
4301 skipping, /* were previously skipping */
4302 lookup_value != NULL, /* success/failure indicator */
4303 save_lookup_value, /* value to reset for string2 */
4304 &s, /* input pointer */
4305 &yield, /* output pointer */
4306 &size, /* output size */
4307 &ptr, /* output current point */
4308 US"lookup", /* condition type */
4311 case 1: goto EXPAND_FAILED; /* when all is well, the */
4312 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4315 /* Restore external setting of expansion variables for carrying on
4316 at this level, and continue. */
4318 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4319 save_expand_nlength);
4323 /* If Perl support is configured, handle calling embedded perl subroutines,
4324 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4325 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4326 arguments (defined below). */
4328 #define EXIM_PERL_MAX_ARGS 8
4332 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4333 "is not included in this binary";
4336 #else /* EXIM_PERL */
4338 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4341 if ((expand_forbid & RDO_PERL) != 0)
4343 expand_string_message = US"Perl calls are not permitted";
4347 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4348 US"perl", &resetok))
4350 case 1: goto EXPAND_FAILED_CURLY;
4352 case 3: goto EXPAND_FAILED;
4355 /* If skipping, we don't actually do anything */
4357 if (skipping) continue;
4359 /* Start the interpreter if necessary */
4361 if (!opt_perl_started)
4364 if (opt_perl_startup == NULL)
4366 expand_string_message = US"A setting of perl_startup is needed when "
4367 "using the Perl interpreter";
4370 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4371 initerror = init_perl(opt_perl_startup);
4372 if (initerror != NULL)
4374 expand_string_message =
4375 string_sprintf("error in perl_startup code: %s\n", initerror);
4378 opt_perl_started = TRUE;
4381 /* Call the function */
4383 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4384 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4385 sub_arg[0], sub_arg + 1);
4387 /* NULL yield indicates failure; if the message pointer has been set to
4388 NULL, the yield was undef, indicating a forced failure. Otherwise the
4389 message will indicate some kind of Perl error. */
4391 if (new_yield == NULL)
4393 if (expand_string_message == NULL)
4395 expand_string_message =
4396 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4397 "failure", sub_arg[0]);
4398 expand_string_forcedfail = TRUE;
4403 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4404 set during a callback from Perl. */
4406 expand_string_forcedfail = FALSE;
4410 #endif /* EXIM_PERL */
4412 /* Transform email address to "prvs" scheme to use
4413 as BATV-signed return path */
4420 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4422 case 1: goto EXPAND_FAILED_CURLY;
4424 case 3: goto EXPAND_FAILED;
4427 /* If skipping, we don't actually do anything */
4428 if (skipping) continue;
4430 /* sub_arg[0] is the address */
4431 domain = Ustrrchr(sub_arg[0],'@');
4432 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4434 expand_string_message = US"prvs first argument must be a qualified email address";
4438 /* Calculate the hash. The second argument must be a single-digit
4439 key number, or unset. */
4441 if (sub_arg[2] != NULL &&
4442 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4444 expand_string_message = US"prvs second argument must be a single digit";
4448 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4451 expand_string_message = US"prvs hmac-sha1 conversion failed";
4455 /* Now separate the domain from the local part */
4458 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4459 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4460 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4461 string_cat(yield,&size,&ptr,p,6);
4462 string_cat(yield,&size,&ptr,US"=",1);
4463 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4464 string_cat(yield,&size,&ptr,US"@",1);
4465 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4470 /* Check a prvs-encoded address for validity */
4472 case EITEM_PRVSCHECK:
4475 int mysize = 0, myptr = 0;
4479 /* TF: Ugliness: We want to expand parameter 1 first, then set
4480 up expansion variables that are used in the expansion of
4481 parameter 2. So we clone the string for the first
4482 expansion, where we only expand parameter 1.
4484 PH: Actually, that isn't necessary. The read_subs() function is
4485 designed to work this way for the ${if and ${lookup expansions. I've
4489 /* Reset expansion variables */
4490 prvscheck_result = NULL;
4491 prvscheck_address = NULL;
4492 prvscheck_keynum = NULL;
4494 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4496 case 1: goto EXPAND_FAILED_CURLY;
4498 case 3: goto EXPAND_FAILED;
4501 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4504 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4506 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4507 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4508 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4509 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4510 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4512 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4513 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4514 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4515 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4516 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4518 /* Set up expansion variables */
4519 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4520 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4521 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4522 prvscheck_address[myptr] = '\0';
4523 prvscheck_keynum = string_copy(key_num);
4525 /* Now expand the second argument */
4526 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4528 case 1: goto EXPAND_FAILED_CURLY;
4530 case 3: goto EXPAND_FAILED;
4533 /* Now we have the key and can check the address. */
4535 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4540 expand_string_message = US"hmac-sha1 conversion failed";
4544 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4545 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4547 if (Ustrcmp(p,hash) == 0)
4549 /* Success, valid BATV address. Now check the expiry date. */
4550 uschar *now = prvs_daystamp(0);
4551 unsigned int inow = 0,iexpire = 1;
4553 (void)sscanf(CS now,"%u",&inow);
4554 (void)sscanf(CS daystamp,"%u",&iexpire);
4556 /* When "iexpire" is < 7, a "flip" has occured.
4557 Adjust "inow" accordingly. */
4558 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4560 if (iexpire >= inow)
4562 prvscheck_result = US"1";
4563 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4567 prvscheck_result = NULL;
4568 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4573 prvscheck_result = NULL;
4574 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4577 /* Now expand the final argument. We leave this till now so that
4578 it can include $prvscheck_result. */
4580 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4582 case 1: goto EXPAND_FAILED_CURLY;
4584 case 3: goto EXPAND_FAILED;
4587 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4588 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4590 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4592 /* Reset the "internal" variables afterwards, because they are in
4593 dynamic store that will be reclaimed if the expansion succeeded. */
4595 prvscheck_address = NULL;
4596 prvscheck_keynum = NULL;
4600 /* Does not look like a prvs encoded address, return the empty string.
4601 We need to make sure all subs are expanded first, so as to skip over
4604 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4606 case 1: goto EXPAND_FAILED_CURLY;
4608 case 3: goto EXPAND_FAILED;
4615 /* Handle "readfile" to insert an entire file */
4617 case EITEM_READFILE:
4622 if ((expand_forbid & RDO_READFILE) != 0)
4624 expand_string_message = US"file insertions are not permitted";
4628 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4630 case 1: goto EXPAND_FAILED_CURLY;
4632 case 3: goto EXPAND_FAILED;
4635 /* If skipping, we don't actually do anything */
4637 if (skipping) continue;
4639 /* Open the file and read it */
4641 f = Ufopen(sub_arg[0], "rb");
4644 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4648 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4653 /* Handle "readsocket" to insert data from a Unix domain socket */
4655 case EITEM_READSOCK:
4661 struct sockaddr_un sockun; /* don't call this "sun" ! */
4665 if ((expand_forbid & RDO_READSOCK) != 0)
4667 expand_string_message = US"socket insertions are not permitted";
4671 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4672 because there may be a string for expansion on failure. */
4674 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4676 case 1: goto EXPAND_FAILED_CURLY;
4677 case 2: /* Won't occur: no end check */
4678 case 3: goto EXPAND_FAILED;
4681 /* Sort out timeout, if given */
4683 if (sub_arg[2] != NULL)
4685 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4688 expand_string_message = string_sprintf("bad time value %s",
4693 else sub_arg[3] = NULL; /* No eol if no timeout */
4695 /* If skipping, we don't actually do anything. Otherwise, arrange to
4696 connect to either an IP or a Unix socket. */
4700 /* Handle an IP (internet) domain */
4702 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4705 uschar *server_name = sub_arg[0] + 5;
4706 uschar *port_name = Ustrrchr(server_name, ':');
4708 /* Sort out the port */
4710 if (port_name == NULL)
4712 expand_string_message =
4713 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4716 *port_name++ = 0; /* Terminate server name */
4718 if (isdigit(*port_name))
4721 port = Ustrtol(port_name, &end, 0);
4722 if (end != port_name + Ustrlen(port_name))
4724 expand_string_message =
4725 string_sprintf("invalid port number %s", port_name);
4731 struct servent *service_info = getservbyname(CS port_name, "tcp");
4732 if (service_info == NULL)
4734 expand_string_message = string_sprintf("unknown port \"%s\"",
4738 port = ntohs(service_info->s_port);
4741 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4742 timeout, NULL, &expand_string_message)) < 0)
4746 /* Handle a Unix domain socket */
4751 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4753 expand_string_message = string_sprintf("failed to create socket: %s",
4758 sockun.sun_family = AF_UNIX;
4759 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4762 sigalrm_seen = FALSE;
4764 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4768 expand_string_message = US "socket connect timed out";
4773 expand_string_message = string_sprintf("failed to connect to socket "
4774 "%s: %s", sub_arg[0], strerror(errno));
4779 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4781 /* Allow sequencing of test actions */
4782 if (running_in_test_harness) millisleep(100);
4784 /* Write the request string, if not empty */
4786 if (sub_arg[1][0] != 0)
4788 int len = Ustrlen(sub_arg[1]);
4789 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4791 if (write(fd, sub_arg[1], len) != len)
4793 expand_string_message = string_sprintf("request write to socket "
4794 "failed: %s", strerror(errno));
4799 /* Shut down the sending side of the socket. This helps some servers to
4800 recognise that it is their turn to do some work. Just in case some
4801 system doesn't have this function, make it conditional. */
4804 shutdown(fd, SHUT_WR);
4807 if (running_in_test_harness) millisleep(100);
4809 /* Now we need to read from the socket, under a timeout. The function
4810 that reads a file can be used. */
4812 f = fdopen(fd, "rb");
4813 sigalrm_seen = FALSE;
4815 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4819 /* After a timeout, we restore the pointer in the result, that is,
4820 make sure we add nothing from the socket. */
4825 expand_string_message = US "socket read timed out";
4830 /* The whole thing has worked (or we were skipping). If there is a
4831 failure string following, we need to skip it. */
4835 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4837 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4838 while (isspace(*s)) s++;
4840 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4843 /* Come here on failure to create socket, connect socket, write to the
4844 socket, or timeout on reading. If another substring follows, expand and
4845 use it. Otherwise, those conditions give expand errors. */
4848 if (*s != '{') goto EXPAND_FAILED;
4849 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4850 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4851 if (arg == NULL) goto EXPAND_FAILED;
4852 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4853 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4854 while (isspace(*s)) s++;
4855 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4859 /* Handle "run" to execute a program. */
4865 const uschar **argv;
4871 if ((expand_forbid & RDO_RUN) != 0)
4873 expand_string_message = US"running a command is not permitted";
4877 while (isspace(*s)) s++;
4878 if (*s != '{') goto EXPAND_FAILED_CURLY;
4879 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4880 if (arg == NULL) goto EXPAND_FAILED;
4881 while (isspace(*s)) s++;
4882 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4884 if (skipping) /* Just pretend it worked when we're skipping */
4890 if (!transport_set_up_command(&argv, /* anchor for arg list */
4891 arg, /* raw command */
4892 FALSE, /* don't expand the arguments */
4893 0, /* not relevant when... */
4894 NULL, /* no transporting address */
4895 US"${run} expansion", /* for error messages */
4896 &expand_string_message)) /* where to put error message */
4901 /* Create the child process, making it a group leader. */
4903 pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4907 expand_string_message =
4908 string_sprintf("couldn't create child process: %s", strerror(errno));
4912 /* Nothing is written to the standard input. */
4916 /* Read the pipe to get the command's output into $value (which is kept
4917 in lookup_value). Read during execution, so that if the output exceeds
4918 the OS pipe buffer limit, we don't block forever. */
4920 f = fdopen(fd_out, "rb");
4921 sigalrm_seen = FALSE;
4923 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4927 /* Wait for the process to finish, applying the timeout, and inspect its
4928 return code for serious disasters. Simple non-zero returns are passed on.
4931 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4933 if (sigalrm_seen == TRUE || runrc == -256)
4935 expand_string_message = string_sprintf("command timed out");
4936 killpg(pid, SIGKILL); /* Kill the whole process group */
4939 else if (runrc == -257)
4940 expand_string_message = string_sprintf("wait() failed: %s",
4944 expand_string_message = string_sprintf("command killed by signal %d",
4951 /* Process the yes/no strings; $value may be useful in both cases */
4953 switch(process_yesno(
4954 skipping, /* were previously skipping */
4955 runrc == 0, /* success/failure indicator */
4956 lookup_value, /* value to reset for string2 */
4957 &s, /* input pointer */
4958 &yield, /* output pointer */
4959 &size, /* output size */
4960 &ptr, /* output current point */
4961 US"run", /* condition type */
4964 case 1: goto EXPAND_FAILED; /* when all is well, the */
4965 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4971 /* Handle character translation for "tr" */
4979 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4981 case 1: goto EXPAND_FAILED_CURLY;
4983 case 3: goto EXPAND_FAILED;
4986 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4987 o2m = Ustrlen(sub[2]) - 1;
4989 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4991 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4995 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
5002 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5003 expanded arguments. */
5013 int val[2] = { 0, -1 };
5016 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5017 Ensure that sub[2] is set in the ${length } case. */
5020 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5021 TRUE, name, &resetok))
5023 case 1: goto EXPAND_FAILED_CURLY;
5025 case 3: goto EXPAND_FAILED;
5028 /* Juggle the arguments if there are only two of them: always move the
5029 string to the last position and make ${length{n}{str}} equivalent to
5030 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5036 if (item_type == EITEM_LENGTH)
5043 for (i = 0; i < 2; i++)
5045 if (sub[i] == NULL) continue;
5046 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5047 if (*ret != 0 || (i != 0 && val[i] < 0))
5049 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5050 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5056 (item_type == EITEM_HASH)?
5057 compute_hash(sub[2], val[0], val[1], &len) :
5058 (item_type == EITEM_NHASH)?
5059 compute_nhash(sub[2], val[0], val[1], &len) :
5060 extract_substr(sub[2], val[0], val[1], &len);
5062 if (ret == NULL) goto EXPAND_FAILED;
5063 yield = string_cat(yield, &size, &ptr, ret, len);
5067 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5068 This code originally contributed by Steve Haslam. It currently supports
5069 the use of MD5 and SHA-1 hashes.
5071 We need some workspace that is large enough to handle all the supported
5072 hash types. Use macros to set the sizes rather than be too elaborate. */
5074 #define MAX_HASHLEN 20
5075 #define MAX_HASHBLOCKLEN 64
5084 int hashlen; /* Number of octets for the hash algorithm's output */
5085 int hashblocklen; /* Number of octets the hash algorithm processes */
5087 unsigned int keylen;
5089 uschar keyhash[MAX_HASHLEN];
5090 uschar innerhash[MAX_HASHLEN];
5091 uschar finalhash[MAX_HASHLEN];
5092 uschar finalhash_hex[2*MAX_HASHLEN];
5093 uschar innerkey[MAX_HASHBLOCKLEN];
5094 uschar outerkey[MAX_HASHBLOCKLEN];
5096 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5098 case 1: goto EXPAND_FAILED_CURLY;
5100 case 3: goto EXPAND_FAILED;
5103 if (Ustrcmp(sub[0], "md5") == 0)
5106 use_base = &md5_base;
5110 else if (Ustrcmp(sub[0], "sha1") == 0)
5113 use_base = &sha1_base;
5119 expand_string_message =
5120 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5125 keylen = Ustrlen(keyptr);
5127 /* If the key is longer than the hash block length, then hash the key
5130 if (keylen > hashblocklen)
5132 chash_start(type, use_base);
5133 chash_end(type, use_base, keyptr, keylen, keyhash);
5138 /* Now make the inner and outer key values */
5140 memset(innerkey, 0x36, hashblocklen);
5141 memset(outerkey, 0x5c, hashblocklen);
5143 for (i = 0; i < keylen; i++)
5145 innerkey[i] ^= keyptr[i];
5146 outerkey[i] ^= keyptr[i];
5149 /* Now do the hashes */
5151 chash_start(type, use_base);
5152 chash_mid(type, use_base, innerkey);
5153 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5155 chash_start(type, use_base);
5156 chash_mid(type, use_base, outerkey);
5157 chash_end(type, use_base, innerhash, hashlen, finalhash);
5159 /* Encode the final hash as a hex string */
5162 for (i = 0; i < hashlen; i++)
5164 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5165 *p++ = hex_digits[finalhash[i] & 0x0f];
5168 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5169 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5171 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5176 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5177 We have to save the numerical variables and restore them afterwards. */
5182 int moffset, moffsetextra, slen;
5185 const uschar *rerror;
5188 int save_expand_nmax =
5189 save_expand_strings(save_expand_nstring, save_expand_nlength);
5191 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5193 case 1: goto EXPAND_FAILED_CURLY;
5195 case 3: goto EXPAND_FAILED;
5198 /* Compile the regular expression */
5200 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5205 expand_string_message = string_sprintf("regular expression error in "
5206 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5210 /* Now run a loop to do the substitutions as often as necessary. It ends
5211 when there are no more matches. Take care over matches of the null string;
5212 do the same thing as Perl does. */
5215 slen = Ustrlen(sub[0]);
5216 moffset = moffsetextra = 0;
5221 int ovector[3*(EXPAND_MAXN+1)];
5222 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5223 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5227 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5228 is not necessarily the end. We want to repeat the match from one
5229 character further along, but leaving the basic offset the same (for
5230 copying below). We can't be at the end of the string - that was checked
5231 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5232 finished; copy the remaining string and end the loop. */
5242 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5246 /* Match - set up for expanding the replacement. */
5248 if (n == 0) n = EXPAND_MAXN + 1;
5250 for (nn = 0; nn < n*2; nn += 2)
5252 expand_nstring[expand_nmax] = subject + ovector[nn];
5253 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5257 /* Copy the characters before the match, plus the expanded insertion. */
5259 yield = string_cat(yield, &size, &ptr, subject + moffset,
5260 ovector[0] - moffset);
5261 insert = expand_string(sub[2]);
5262 if (insert == NULL) goto EXPAND_FAILED;
5263 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5265 moffset = ovector[1];
5269 /* If we have matched an empty string, first check to see if we are at
5270 the end of the subject. If so, the loop is over. Otherwise, mimic
5271 what Perl's /g options does. This turns out to be rather cunning. First
5272 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5273 string at the same point. If this fails (picked up above) we advance to
5274 the next character. */
5276 if (ovector[0] == ovector[1])
5278 if (ovector[0] == slen) break;
5279 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5283 /* All done - restore numerical variables. */
5285 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5286 save_expand_nlength);
5290 /* Handle keyed and numbered substring extraction. If the first argument
5291 consists entirely of digits, then a numerical extraction is assumed. */
5297 int field_number = 1;
5298 BOOL field_number_set = FALSE;
5299 uschar *save_lookup_value = lookup_value;
5301 int save_expand_nmax =
5302 save_expand_strings(save_expand_nstring, save_expand_nlength);
5304 /* Read the arguments */
5306 for (i = 0; i < j; i++)
5308 while (isspace(*s)) s++;
5309 if (*s == '{') /*}*/
5311 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5312 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5313 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5315 /* After removal of leading and trailing white space, the first
5316 argument must not be empty; if it consists entirely of digits
5317 (optionally preceded by a minus sign), this is a numerical
5318 extraction, and we expect 3 arguments. */
5326 while (isspace(*p)) p++;
5330 while (len > 0 && isspace(p[len-1])) len--;
5337 expand_string_message = US"first argument of \"extract\" must "
5347 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5351 j = 3; /* Need 3 args */
5352 field_number_set = TRUE;
5357 else goto EXPAND_FAILED_CURLY;
5360 /* Extract either the numbered or the keyed substring into $value. If
5361 skipping, just pretend the extraction failed. */
5363 lookup_value = skipping? NULL : field_number_set?
5364 expand_gettokened(field_number, sub[1], sub[2]) :
5365 expand_getkeyed(sub[0], sub[1]);
5367 /* If no string follows, $value gets substituted; otherwise there can
5368 be yes/no strings, as for lookup or if. */
5370 switch(process_yesno(
5371 skipping, /* were previously skipping */
5372 lookup_value != NULL, /* success/failure indicator */
5373 save_lookup_value, /* value to reset for string2 */
5374 &s, /* input pointer */
5375 &yield, /* output pointer */
5376 &size, /* output size */
5377 &ptr, /* output current point */
5378 US"extract", /* condition type */
5381 case 1: goto EXPAND_FAILED; /* when all is well, the */
5382 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5385 /* All done - restore numerical variables. */
5387 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5388 save_expand_nlength);
5393 /* return the Nth item from a list */
5395 case EITEM_LISTEXTRACT:
5398 int field_number = 1;
5399 uschar *save_lookup_value = lookup_value;
5401 int save_expand_nmax =
5402 save_expand_strings(save_expand_nstring, save_expand_nlength);
5404 /* Read the field & list arguments */
5406 for (i = 0; i < 2; i++)
5408 while (isspace(*s)) s++;
5409 if (*s != '{') /*}*/
5410 goto EXPAND_FAILED_CURLY;
5412 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5413 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5414 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5416 /* After removal of leading and trailing white space, the first
5417 argument must be numeric and nonempty. */
5425 while (isspace(*p)) p++;
5429 while (len > 0 && isspace(p[len-1])) len--;
5432 if (!*p && !skipping)
5434 expand_string_message = US"first argument of \"listextract\" must "
5444 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5447 expand_string_message = US"first argument of \"listextract\" must "
5455 /* Extract the numbered element into $value. If
5456 skipping, just pretend the extraction failed. */
5458 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5460 /* If no string follows, $value gets substituted; otherwise there can
5461 be yes/no strings, as for lookup or if. */
5463 switch(process_yesno(
5464 skipping, /* were previously skipping */
5465 lookup_value != NULL, /* success/failure indicator */
5466 save_lookup_value, /* value to reset for string2 */
5467 &s, /* input pointer */
5468 &yield, /* output pointer */
5469 &size, /* output size */
5470 &ptr, /* output current point */
5471 US"extract", /* condition type */
5474 case 1: goto EXPAND_FAILED; /* when all is well, the */
5475 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5478 /* All done - restore numerical variables. */
5480 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5481 save_expand_nlength);
5487 case EITEM_CERTEXTRACT:
5489 uschar *save_lookup_value = lookup_value;
5491 int save_expand_nmax =
5492 save_expand_strings(save_expand_nstring, save_expand_nlength);
5494 /* Read the field argument */
5495 while (isspace(*s)) s++;
5496 if (*s != '{') /*}*/
5497 goto EXPAND_FAILED_CURLY;
5498 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5499 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5500 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5501 /* strip spaces fore & aft */
5506 while (isspace(*p)) p++;
5510 while (len > 0 && isspace(p[len-1])) len--;
5514 /* inspect the cert argument */
5515 while (isspace(*s)) s++;
5516 if (*s != '{') /*}*/
5517 goto EXPAND_FAILED_CURLY;
5520 expand_string_message = US"second argument of \"certextract\" must "
5521 "be a certificate variable";
5524 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5525 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5526 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5529 lookup_value = NULL;
5532 lookup_value = expand_getcertele(sub[0], sub[1]);
5533 if (*expand_string_message) goto EXPAND_FAILED;
5535 switch(process_yesno(
5536 skipping, /* were previously skipping */
5537 lookup_value != NULL, /* success/failure indicator */
5538 save_lookup_value, /* value to reset for string2 */
5539 &s, /* input pointer */
5540 &yield, /* output pointer */
5541 &size, /* output size */
5542 &ptr, /* output current point */
5543 US"extract", /* condition type */
5546 case 1: goto EXPAND_FAILED; /* when all is well, the */
5547 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5550 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5551 save_expand_nlength);
5554 #endif /*SUPPORT_TLS*/
5556 /* Handle list operations */
5564 uschar outsep[2] = { '\0', '\0' };
5565 const uschar *list, *expr, *temp;
5566 uschar *save_iterate_item = iterate_item;
5567 uschar *save_lookup_value = lookup_value;
5569 while (isspace(*s)) s++;
5570 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5572 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5573 if (list == NULL) goto EXPAND_FAILED;
5574 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5576 if (item_type == EITEM_REDUCE)
5579 while (isspace(*s)) s++;
5580 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5581 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5582 if (!t) goto EXPAND_FAILED;
5584 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5587 while (isspace(*s)) s++;
5588 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5592 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5593 if scanning a "false" part). This allows us to find the end of the
5594 condition, because if the list is empty, we won't actually evaluate the
5595 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5596 the normal internal expansion function. */
5598 if (item_type == EITEM_FILTER)
5600 temp = eval_condition(expr, &resetok, NULL);
5601 if (temp != NULL) s = temp;
5604 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5608 expand_string_message = string_sprintf("%s inside \"%s\" item",
5609 expand_string_message, name);
5613 while (isspace(*s)) s++;
5616 expand_string_message = string_sprintf("missing } at end of condition "
5617 "or expression inside \"%s\"", name);
5621 while (isspace(*s)) s++; /*{*/
5624 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5629 /* If we are skipping, we can now just move on to the next item. When
5630 processing for real, we perform the iteration. */
5632 if (skipping) continue;
5633 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5635 *outsep = (uschar)sep; /* Separator as a string */
5637 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5639 if (item_type == EITEM_FILTER)
5642 if (eval_condition(expr, &resetok, &condresult) == NULL)
5644 iterate_item = save_iterate_item;
5645 lookup_value = save_lookup_value;
5646 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5647 expand_string_message, name);
5650 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5651 condresult? "true":"false");
5653 temp = iterate_item; /* TRUE => include this item */
5655 continue; /* FALSE => skip this item */
5658 /* EITEM_MAP and EITEM_REDUCE */
5662 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5666 iterate_item = save_iterate_item;
5667 expand_string_message = string_sprintf("%s inside \"%s\" item",
5668 expand_string_message, name);
5671 if (item_type == EITEM_REDUCE)
5673 lookup_value = t; /* Update the value of $value */
5674 continue; /* and continue the iteration */
5678 /* We reach here for FILTER if the condition is true, always for MAP,
5679 and never for REDUCE. The value in "temp" is to be added to the output
5680 list that is being created, ensuring that any occurrences of the
5681 separator character are doubled. Unless we are dealing with the first
5682 item of the output list, add in a space if the new item begins with the
5683 separator character, or is an empty string. */
5685 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5686 yield = string_cat(yield, &size, &ptr, US" ", 1);
5688 /* Add the string in "temp" to the output list that we are building,
5689 This is done in chunks by searching for the separator character. */
5693 size_t seglen = Ustrcspn(temp, outsep);
5694 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5696 /* If we got to the end of the string we output one character
5697 too many; backup and end the loop. Otherwise arrange to double the
5700 if (temp[seglen] == '\0') { ptr--; break; }
5701 yield = string_cat(yield, &size, &ptr, outsep, 1);
5705 /* Output a separator after the string: we will remove the redundant
5706 final one at the end. */
5708 yield = string_cat(yield, &size, &ptr, outsep, 1);
5709 } /* End of iteration over the list loop */
5711 /* REDUCE has generated no output above: output the final value of
5714 if (item_type == EITEM_REDUCE)
5716 yield = string_cat(yield, &size, &ptr, lookup_value,
5717 Ustrlen(lookup_value));
5718 lookup_value = save_lookup_value; /* Restore $value */
5721 /* FILTER and MAP generate lists: if they have generated anything, remove
5722 the redundant final separator. Even though an empty item at the end of a
5723 list does not count, this is tidier. */
5725 else if (ptr != save_ptr) ptr--;
5727 /* Restore preserved $item */
5729 iterate_item = save_iterate_item;
5736 const uschar *srclist, *cmp, *xtract;
5738 const uschar *dstlist = NULL, *dstkeylist = NULL;
5740 uschar *save_iterate_item = iterate_item;
5742 while (isspace(*s)) s++;
5743 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5745 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5746 if (!srclist) goto EXPAND_FAILED;
5747 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5749 while (isspace(*s)) s++;
5750 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5752 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5753 if (!cmp) goto EXPAND_FAILED;
5754 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5756 while (isspace(*s)) s++;
5757 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5760 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5761 if (!tmp) goto EXPAND_FAILED;
5762 xtract = string_copyn(xtract, s - xtract);
5764 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5768 expand_string_message = US"missing } at end of \"sort\"";
5772 if (skipping) continue;
5774 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5777 uschar * newlist = NULL;
5778 uschar * newkeylist = NULL;
5781 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, srcitem);
5783 /* extract field for comparisons */
5784 iterate_item = srcitem;
5785 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5789 expand_string_message = string_sprintf(
5790 "field-extract in sort: \"%s\"", xtract);
5794 /* Insertion sort */
5796 /* copy output list until new-item < list-item */
5797 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5803 /* field for comparison */
5804 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5807 /* build and run condition string */
5808 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
5810 DEBUG(D_expand) debug_printf("%s: cond = \"%s\"\n", name, expr);
5811 if (!eval_condition(expr, &resetok, &before))
5813 expand_string_message = string_sprintf("comparison in sort: %s",
5820 /* New-item sorts before this dst-item. Append new-item,
5821 then dst-item, then remainder of dst list. */
5823 newlist = string_append_listele(newlist, sep, srcitem);
5824 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5827 newlist = string_append_listele(newlist, sep, dstitem);
5828 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5830 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5832 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5834 newlist = string_append_listele(newlist, sep, dstitem);
5835 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5841 newlist = string_append_listele(newlist, sep, dstitem);
5842 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5845 /* If we ran out of dstlist without consuming srcitem, append it */
5848 newlist = string_append_listele(newlist, sep, srcitem);
5849 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5853 dstkeylist = newkeylist;
5855 DEBUG(D_expand) debug_printf("%s: dstlist = \"%s\"\n", name, dstlist);
5856 DEBUG(D_expand) debug_printf("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
5860 yield = string_cat(yield, &size, &ptr, dstlist, Ustrlen(dstlist));
5862 /* Restore preserved $item */
5863 iterate_item = save_iterate_item;
5867 expand_string_message = US"Internal error in sort (list mismatch)";
5872 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5873 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5874 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5875 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5877 #define EXPAND_DLFUNC_MAX_ARGS 8
5880 #ifndef EXPAND_DLFUNC
5881 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5882 "is not included in this binary";
5885 #else /* EXPAND_DLFUNC */
5888 exim_dlfunc_t *func;
5891 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5893 if ((expand_forbid & RDO_DLFUNC) != 0)
5895 expand_string_message =
5896 US"dynamically-loaded functions are not permitted";
5900 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5901 TRUE, US"dlfunc", &resetok))
5903 case 1: goto EXPAND_FAILED_CURLY;
5905 case 3: goto EXPAND_FAILED;
5908 /* If skipping, we don't actually do anything */
5910 if (skipping) continue;
5912 /* Look up the dynamically loaded object handle in the tree. If it isn't
5913 found, dlopen() the file and put the handle in the tree for next time. */
5915 t = tree_search(dlobj_anchor, argv[0]);
5918 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5921 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5922 argv[0], dlerror());
5923 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5926 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5927 Ustrcpy(t->name, argv[0]);
5928 t->data.ptr = handle;
5929 (void)tree_insertnode(&dlobj_anchor, t);
5932 /* Having obtained the dynamically loaded object handle, look up the
5933 function pointer. */
5935 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5938 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5939 "%s", argv[1], argv[0], dlerror());
5940 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5944 /* Call the function and work out what to do with the result. If it
5945 returns OK, we have a replacement string; if it returns DEFER then
5946 expansion has failed in a non-forced manner; if it returns FAIL then
5947 failure was forced; if it returns ERROR or any other value there's a
5948 problem, so panic slightly. In any case, assume that the function has
5949 side-effects on the store that must be preserved. */
5953 for (argc = 0; argv[argc] != NULL; argc++);
5954 status = func(&result, argc - 2, &argv[2]);
5957 if (result == NULL) result = US"";
5958 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5963 expand_string_message = result == NULL ? US"(no message)" : result;
5964 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5965 else if(status != FAIL)
5966 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5967 argv[0], argv[1], status, expand_string_message);
5971 #endif /* EXPAND_DLFUNC */
5973 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
5976 uschar *save_lookup_value = lookup_value;
5978 while (isspace(*s)) s++;
5979 if (*s != '{') /*}*/
5982 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5983 if (!key) goto EXPAND_FAILED; /*{*/
5984 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5986 lookup_value = US getenv(CS key);
5988 switch(process_yesno(
5989 skipping, /* were previously skipping */
5990 lookup_value != NULL, /* success/failure indicator */
5991 save_lookup_value, /* value to reset for string2 */
5992 &s, /* input pointer */
5993 &yield, /* output pointer */
5994 &size, /* output size */
5995 &ptr, /* output current point */
5996 US"env", /* condition type */
5999 case 1: goto EXPAND_FAILED; /* when all is well, the */
6000 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6004 } /* EITEM_* switch */
6006 /* Control reaches here if the name is not recognized as one of the more
6007 complicated expansion items. Check for the "operator" syntax (name terminated
6008 by a colon). Some of the operators have arguments, separated by _ from the
6016 var_entry *vp = NULL;
6018 /* Owing to an historical mis-design, an underscore may be part of the
6019 operator name, or it may introduce arguments. We therefore first scan the
6020 table of names that contain underscores. If there is no match, we cut off
6021 the arguments and then scan the main table. */
6023 if ((c = chop_match(name, op_table_underscore,
6024 nelem(op_table_underscore))) < 0)
6026 arg = Ustrchr(name, '_');
6027 if (arg != NULL) *arg = 0;
6028 c = chop_match(name, op_table_main, nelem(op_table_main));
6029 if (c >= 0) c += nelem(op_table_underscore);
6030 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6033 /* Deal specially with operators that might take a certificate variable
6034 as we do not want to do the usual expansion. For most, expand the string.*/
6043 const uschar * s1 = s;
6044 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6046 if (!sub) goto EXPAND_FAILED; /*{*/
6047 if (*s1 != '}') goto EXPAND_FAILED_CURLY;
6048 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6058 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6059 if (!sub) goto EXPAND_FAILED;
6064 /* If we are skipping, we don't need to perform the operation at all.
6065 This matters for operations like "mask", because the data may not be
6066 in the correct format when skipping. For example, the expression may test
6067 for the existence of $sender_host_address before trying to mask it. For
6068 other operations, doing them may not fail, but it is a waste of time. */
6070 if (skipping && c >= 0) continue;
6072 /* Otherwise, switch on the operator type */
6079 unsigned long int n = Ustrtoul(sub, &t, 10);
6082 expand_string_message = string_sprintf("argument for base62 "
6083 "operator is \"%s\", which is not a decimal number", sub);
6086 t = string_base62(n);
6087 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6091 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6097 unsigned long int n = 0;
6100 uschar *t = Ustrchr(base62_chars, *tt++);
6103 expand_string_message = string_sprintf("argument for base62d "
6104 "operator is \"%s\", which is not a base %d number", sub,
6108 n = n * BASE_62 + (t - base62_chars);
6110 (void)sprintf(CS buf, "%ld", n);
6111 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
6117 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6118 if (expanded == NULL)
6120 expand_string_message =
6121 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6122 expand_string_message);
6125 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
6132 uschar *t = sub - 1;
6133 while (*(++t) != 0) { *t = tolower(*t); count++; }
6134 yield = string_cat(yield, &size, &ptr, sub, count);
6141 uschar *t = sub - 1;
6142 while (*(++t) != 0) { *t = toupper(*t); count++; }
6143 yield = string_cat(yield, &size, &ptr, sub, count);
6149 if (vp && *(void **)vp->value)
6151 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6152 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6162 md5_end(&base, sub, Ustrlen(sub), digest);
6163 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6164 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6170 if (vp && *(void **)vp->value)
6172 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6173 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6183 sha1_end(&base, sub, Ustrlen(sub), digest);
6184 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6185 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6191 if (vp && *(void **)vp->value)
6193 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6194 yield = string_cat(yield, &size, &ptr, cp, (int)Ustrlen(cp));
6198 expand_string_message = US"sha256 only supported for certificates";
6201 /* Convert hex encoding to base64 encoding */
6211 for (enc = sub; *enc != 0; enc++)
6213 if (!isxdigit(*enc))
6215 expand_string_message = string_sprintf("\"%s\" is not a hex "
6224 expand_string_message = string_sprintf("\"%s\" contains an odd "
6225 "number of characters", sub);
6229 while ((c = *in++) != 0)
6231 if (isdigit(c)) c -= '0';
6232 else c = toupper(c) - 'A' + 10;
6244 enc = auth_b64encode(sub, out - sub);
6245 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
6249 /* Convert octets outside 0x21..0x7E to \xXX form */
6253 uschar *t = sub - 1;
6256 if (*t < 0x21 || 0x7E < *t)
6257 yield = string_cat(yield, &size, &ptr,
6258 string_sprintf("\\x%02x", *t), 4);
6260 yield = string_cat(yield, &size, &ptr, t, 1);
6265 /* count the number of list elements */
6274 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6275 cp = string_sprintf("%d", cnt);
6276 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6280 /* expand a named list given the name */
6281 /* handles nested named lists; requotes as colon-sep list */
6285 tree_node *t = NULL;
6286 const uschar * list;
6289 uschar * suffix = US"";
6290 BOOL needsep = FALSE;
6293 if (*sub == '+') sub++;
6294 if (arg == NULL) /* no-argument version */
6296 if (!(t = tree_search(addresslist_anchor, sub)) &&
6297 !(t = tree_search(domainlist_anchor, sub)) &&
6298 !(t = tree_search(hostlist_anchor, sub)))
6299 t = tree_search(localpartlist_anchor, sub);
6301 else switch(*arg) /* specific list-type version */
6303 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6304 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6305 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6306 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6308 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6314 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6316 : *arg=='a'?"address "
6317 : *arg=='d'?"domain "
6319 : *arg=='l'?"localpart "
6324 list = ((namedlist_block *)(t->data.ptr))->string;
6326 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6328 uschar * buf = US" : ";
6330 yield = string_cat(yield, &size, &ptr, buf, 3);
6334 if (*item == '+') /* list item is itself a named list */
6336 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6337 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6339 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6343 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6344 while ((cp= strpbrk((const char *)item, tok)))
6346 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
6347 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6349 yield = string_cat(yield, &size, &ptr, US"::", 2);
6350 item = (uschar *)cp;
6352 else /* sep in item; should already be doubled; emit once */
6354 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
6355 if (*cp == sep) cp++;
6356 item = (uschar *)cp;
6360 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
6365 /* mask applies a mask to an IP address; for example the result of
6366 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6373 int mask, maskoffset;
6374 int type = string_is_ip_address(sub, &maskoffset);
6379 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6384 if (maskoffset == 0)
6386 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6391 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6393 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6395 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6400 /* Convert the address to binary integer(s) and apply the mask */
6402 sub[maskoffset] = 0;
6403 count = host_aton(sub, binary);
6404 host_mask(count, binary, mask);
6406 /* Convert to masked textual format and add to output. */
6408 yield = string_cat(yield, &size, &ptr, buffer,
6409 host_nmtoa(count, binary, mask, buffer, '.'));
6414 case EOP_IPV6DENORM:
6416 int type = string_is_ip_address(sub, NULL);
6423 (void) host_aton(sub, binary);
6426 case 4: /* convert to IPv4-mapped IPv6 */
6427 binary[0] = binary[1] = 0;
6428 binary[2] = 0x0000ffff;
6429 (void) host_aton(sub, binary+3);
6433 expand_string_message =
6434 string_sprintf("\"%s\" is not an IP address", sub);
6438 yield = string_cat(yield, &size, &ptr, buffer,
6440 ? ipv6_nmtoa(binary, buffer)
6441 : host_nmtoa(4, binary, -1, buffer, ':')
6447 case EOP_LOCAL_PART:
6451 int start, end, domain;
6452 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6456 if (c != EOP_DOMAIN)
6458 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6459 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
6461 else if (domain != 0)
6464 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
6472 uschar outsep[2] = { ':', '\0' };
6473 uschar *address, *error;
6475 int start, end, domain; /* Not really used */
6477 while (isspace(*sub)) sub++;
6478 if (*sub == '>') { *outsep = *++sub; ++sub; }
6479 parse_allow_group = TRUE;
6483 uschar *p = parse_find_address_end(sub, FALSE);
6484 uschar saveend = *p;
6486 address = parse_extract_address(sub, &error, &start, &end, &domain,
6490 /* Add the address to the output list that we are building. This is
6491 done in chunks by searching for the separator character. At the
6492 start, unless we are dealing with the first address of the output
6493 list, add in a space if the new address begins with the separator
6494 character, or is an empty string. */
6496 if (address != NULL)
6498 if (ptr != save_ptr && address[0] == *outsep)
6499 yield = string_cat(yield, &size, &ptr, US" ", 1);
6503 size_t seglen = Ustrcspn(address, outsep);
6504 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
6506 /* If we got to the end of the string we output one character
6509 if (address[seglen] == '\0') { ptr--; break; }
6510 yield = string_cat(yield, &size, &ptr, outsep, 1);
6511 address += seglen + 1;
6514 /* Output a separator after the string: we will remove the
6515 redundant final one at the end. */
6517 yield = string_cat(yield, &size, &ptr, outsep, 1);
6520 if (saveend == '\0') break;
6524 /* If we have generated anything, remove the redundant final
6527 if (ptr != save_ptr) ptr--;
6528 parse_allow_group = FALSE;
6533 /* quote puts a string in quotes if it is empty or contains anything
6534 other than alphamerics, underscore, dot, or hyphen.
6536 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6537 be quoted in order to be a valid local part.
6539 In both cases, newlines and carriage returns are converted into \n and \r
6543 case EOP_QUOTE_LOCAL_PART:
6546 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6547 uschar *t = sub - 1;
6551 while (!needs_quote && *(++t) != 0)
6552 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6554 else /* EOP_QUOTE_LOCAL_PART */
6556 while (!needs_quote && *(++t) != 0)
6557 needs_quote = !isalnum(*t) &&
6558 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6559 (*t != '.' || t == sub || t[1] == 0);
6564 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6569 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6570 else if (*t == '\r')
6571 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6574 if (*t == '\\' || *t == '"')
6575 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6576 yield = string_cat(yield, &size, &ptr, t, 1);
6579 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6581 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6585 /* quote_lookuptype does lookup-specific quoting */
6590 uschar *opt = Ustrchr(arg, '_');
6592 if (opt != NULL) *opt++ = 0;
6594 n = search_findtype(arg, Ustrlen(arg));
6597 expand_string_message = search_error_message;
6601 if (lookup_list[n]->quote != NULL)
6602 sub = (lookup_list[n]->quote)(sub, opt);
6603 else if (opt != NULL) sub = NULL;
6607 expand_string_message = string_sprintf(
6608 "\"%s\" unrecognized after \"${quote_%s\"",
6613 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6617 /* rx quote sticks in \ before any non-alphameric character so that
6618 the insertion works in a regular expression. */
6622 uschar *t = sub - 1;
6626 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6627 yield = string_cat(yield, &size, &ptr, t, 1);
6632 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6633 prescribed by the RFC, if there are characters that need to be encoded */
6637 uschar buffer[2048];
6638 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6639 buffer, sizeof(buffer), FALSE);
6640 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6644 /* RFC 2047 decode */
6650 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6651 headers_charset, '?', &len, &error);
6654 expand_string_message = error;
6657 yield = string_cat(yield, &size, &ptr, decoded, len);
6661 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6671 if (c > 255) c = '_';
6673 yield = string_cat(yield, &size, &ptr, buff, 1);
6678 /* replace illegal UTF-8 sequences by replacement character */
6680 #define UTF8_REPLACEMENT_CHAR US"?"
6684 int seq_len = 0, index = 0;
6686 long codepoint = -1;
6687 uschar seq_buff[4]; /* accumulate utf-8 here */
6696 if ((c & 0xc0) != 0x80)
6697 /* wrong continuation byte; invalidate all bytes */
6698 complete = 1; /* error */
6701 codepoint = (codepoint << 6) | (c & 0x3f);
6702 seq_buff[index++] = c;
6703 if (--bytes_left == 0) /* codepoint complete */
6704 if(codepoint > 0x10FFFF) /* is it too large? */
6705 complete = -1; /* error (RFC3629 limit) */
6707 { /* finished; output utf-8 sequence */
6708 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6713 else /* no bytes left: new sequence */
6715 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6717 yield = string_cat(yield, &size, &ptr, &c, 1);
6720 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6722 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6727 codepoint = c & 0x1f;
6730 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6733 codepoint = c & 0x0f;
6735 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6738 codepoint = c & 0x07;
6740 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6743 seq_buff[index++] = c;
6744 seq_len = bytes_left + 1;
6745 } /* if(bytes_left) */
6749 bytes_left = index = 0;
6750 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6752 if ((complete == 1) && ((c & 0x80) == 0))
6753 /* ASCII character follows incomplete sequence */
6754 yield = string_cat(yield, &size, &ptr, &c, 1);
6759 #ifdef EXPERIMENTAL_INTERNATIONAL
6760 case EOP_UTF8_DOMAIN_TO_ALABEL:
6762 uschar * error = NULL;
6763 uschar * s = string_domain_utf8_to_alabel(sub, &error);
6766 expand_string_message = string_sprintf(
6767 "error converting utf8 (%s) to alabel: %s",
6768 string_printing(sub), error);
6771 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6775 case EOP_UTF8_DOMAIN_FROM_ALABEL:
6777 uschar * error = NULL;
6778 uschar * s = string_domain_alabel_to_utf8(sub, &error);
6781 expand_string_message = string_sprintf(
6782 "error converting alabel (%s) to utf8: %s",
6783 string_printing(sub), error);
6786 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6790 case EOP_UTF8_LOCALPART_TO_ALABEL:
6792 uschar * error = NULL;
6793 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
6796 expand_string_message = string_sprintf(
6797 "error converting utf8 (%s) to alabel: %s",
6798 string_printing(sub), error);
6801 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6802 DEBUG(D_expand) debug_printf("yield: '%s'\n", yield);
6806 case EOP_UTF8_LOCALPART_FROM_ALABEL:
6808 uschar * error = NULL;
6809 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
6812 expand_string_message = string_sprintf(
6813 "error converting alabel (%s) to utf8: %s",
6814 string_printing(sub), error);
6817 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6820 #endif /* EXPERIMENTAL_INTERNATIONAL */
6822 /* escape turns all non-printing characters into escape sequences. */
6826 const uschar *t = string_printing(sub);
6827 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6831 /* Handle numeric expression evaluation */
6836 uschar *save_sub = sub;
6837 uschar *error = NULL;
6838 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6841 expand_string_message = string_sprintf("error in expression "
6842 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6846 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6847 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6851 /* Handle time period formating */
6855 int n = readconf_readtime(sub, 0, FALSE);
6858 expand_string_message = string_sprintf("string \"%s\" is not an "
6859 "Exim time interval in \"%s\" operator", sub, name);
6862 sprintf(CS var_buffer, "%d", n);
6863 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6867 case EOP_TIME_INTERVAL:
6870 uschar *t = read_number(&n, sub);
6871 if (*t != 0) /* Not A Number*/
6873 expand_string_message = string_sprintf("string \"%s\" is not a "
6874 "positive number in \"%s\" operator", sub, name);
6877 t = readconf_printtime(n);
6878 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6882 /* Convert string to base64 encoding */
6886 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6887 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6891 /* strlen returns the length of the string */
6896 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6897 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6901 /* length_n or l_n takes just the first n characters or the whole string,
6902 whichever is the shorter;
6904 substr_m_n, and s_m_n take n characters from offset m; negative m take
6905 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6906 takes the rest, either to the right or to the left.
6908 hash_n or h_n makes a hash of length n from the string, yielding n
6909 characters from the set a-z; hash_n_m makes a hash of length n, but
6910 uses m characters from the set a-zA-Z0-9.
6912 nhash_n returns a single number between 0 and n-1 (in text form), while
6913 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6914 between 0 and n-1 and the second between 0 and m-1. */
6934 expand_string_message = string_sprintf("missing values after %s",
6939 /* "length" has only one argument, effectively being synonymous with
6942 if (c == EOP_LENGTH || c == EOP_L)
6948 /* The others have one or two arguments; for "substr" the first may be
6949 negative. The second being negative means "not supplied". */
6954 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6957 /* Read up to two numbers, separated by underscores */
6962 if (arg != ret && *arg == '_' && pn == &value1)
6966 if (arg[1] != 0) arg++;
6968 else if (!isdigit(*arg))
6970 expand_string_message =
6971 string_sprintf("non-digit after underscore in \"%s\"", name);
6974 else *pn = (*pn)*10 + *arg++ - '0';
6978 /* Perform the required operation */
6981 (c == EOP_HASH || c == EOP_H)?
6982 compute_hash(sub, value1, value2, &len) :
6983 (c == EOP_NHASH || c == EOP_NH)?
6984 compute_nhash(sub, value1, value2, &len) :
6985 extract_substr(sub, value1, value2, &len);
6987 if (ret == NULL) goto EXPAND_FAILED;
6988 yield = string_cat(yield, &size, &ptr, ret, len);
6998 uschar **modetable[3];
7003 if ((expand_forbid & RDO_EXISTS) != 0)
7005 expand_string_message = US"Use of the stat() expansion is not permitted";
7009 if (stat(CS sub, &st) < 0)
7011 expand_string_message = string_sprintf("stat(%s) failed: %s",
7012 sub, strerror(errno));
7016 switch (mode & S_IFMT)
7018 case S_IFIFO: smode[0] = 'p'; break;
7019 case S_IFCHR: smode[0] = 'c'; break;
7020 case S_IFDIR: smode[0] = 'd'; break;
7021 case S_IFBLK: smode[0] = 'b'; break;
7022 case S_IFREG: smode[0] = '-'; break;
7023 default: smode[0] = '?'; break;
7026 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7027 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7028 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7030 for (i = 0; i < 3; i++)
7032 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7037 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7038 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7039 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7040 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7041 (long)st.st_gid, st.st_size, (long)st.st_atime,
7042 (long)st.st_mtime, (long)st.st_ctime);
7043 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
7047 /* vaguely random number less than N */
7051 int_eximarith_t max;
7054 max = expanded_string_integer(sub, TRUE);
7055 if (expand_string_message != NULL)
7057 s = string_sprintf("%d", vaguely_random_number((int)max));
7058 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
7062 /* Reverse IP, including IPv6 to dotted-nibble */
7064 case EOP_REVERSE_IP:
7066 int family, maskptr;
7067 uschar reversed[128];
7069 family = string_is_ip_address(sub, &maskptr);
7072 expand_string_message = string_sprintf(
7073 "reverse_ip() not given an IP address [%s]", sub);
7076 invert_address(reversed, sub);
7077 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
7081 /* Unknown operator */
7084 expand_string_message =
7085 string_sprintf("unknown expansion operator \"%s\"", name);
7090 /* Handle a plain name. If this is the first thing in the expansion, release
7091 the pre-allocated buffer. If the result data is known to be in a new buffer,
7092 newsize will be set to the size of that buffer, and we can just point at that
7093 store instead of copying. Many expansion strings contain just one reference,
7094 so this is a useful optimization, especially for humungous headers
7095 ($message_headers). */
7103 if (resetok) store_reset(yield);
7107 value = find_variable(name, FALSE, skipping, &newsize);
7110 expand_string_message =
7111 string_sprintf("unknown variable in \"${%s}\"", name);
7112 check_variable_error_message(name);
7115 len = Ustrlen(value);
7116 if (yield == NULL && newsize != 0)
7122 else yield = string_cat(yield, &size, &ptr, value, len);
7126 /* Else there's something wrong */
7128 expand_string_message =
7129 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7130 "in a variable reference)", name);
7134 /* If we hit the end of the string when ket_ends is set, there is a missing
7135 terminating brace. */
7137 if (ket_ends && *s == 0)
7139 expand_string_message = malformed_header?
7140 US"missing } at end of string - could be header name not terminated by colon"
7142 US"missing } at end of string";
7146 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7147 added to the string. If so, set up an empty string. Add a terminating zero. If
7148 left != NULL, return a pointer to the terminator. */
7150 if (yield == NULL) yield = store_get(1);
7152 if (left != NULL) *left = s;
7154 /* Any stacking store that was used above the final string is no longer needed.
7155 In many cases the final string will be the first one that was got and so there
7156 will be optimal store usage. */
7158 if (resetok) store_reset(yield + ptr + 1);
7159 else if (resetok_p) *resetok_p = FALSE;
7163 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
7165 if (skipping) debug_printf("skipping: result is not used\n");
7169 /* This is the failure exit: easiest to program with a goto. We still need
7170 to update the pointer to the terminator, for cases of nested calls with "fail".
7173 EXPAND_FAILED_CURLY:
7174 expand_string_message = malformed_header?
7175 US"missing or misplaced { or } - could be header name not terminated by colon"
7177 US"missing or misplaced { or }";
7179 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7180 that is a bad idea, because expand_string_message is in dynamic store. */
7183 if (left != NULL) *left = s;
7186 debug_printf("failed to expand: %s\n", string);
7187 debug_printf(" error message: %s\n", expand_string_message);
7188 if (expand_string_forcedfail) debug_printf("failure was forced\n");
7190 if (resetok_p) *resetok_p = resetok;
7195 /* This is the external function call. Do a quick check for any expansion
7196 metacharacters, and if there are none, just return the input string.
7198 Argument: the string to be expanded
7199 Returns: the expanded string, or NULL if expansion failed; if failure was
7200 due to a lookup deferring, search_find_defer will be TRUE
7204 expand_string(uschar *string)
7206 search_find_defer = FALSE;
7207 malformed_header = FALSE;
7208 return (Ustrpbrk(string, "$\\") == NULL)? string :
7209 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7215 expand_cstring(const uschar *string)
7217 search_find_defer = FALSE;
7218 malformed_header = FALSE;
7219 return (Ustrpbrk(string, "$\\") == NULL)? string :
7220 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7225 /*************************************************
7227 *************************************************/
7229 /* Now and again we want to expand a string and be sure that the result is in a
7230 new bit of store. This function does that.
7231 Since we know it has been copied, the de-const cast is safe.
7233 Argument: the string to be expanded
7234 Returns: the expanded string, always in a new bit of store, or NULL
7238 expand_string_copy(const uschar *string)
7240 const uschar *yield = expand_cstring(string);
7241 if (yield == string) yield = string_copy(string);
7247 /*************************************************
7248 * Expand and interpret as an integer *
7249 *************************************************/
7251 /* Expand a string, and convert the result into an integer.
7254 string the string to be expanded
7255 isplus TRUE if a non-negative number is expected
7257 Returns: the integer value, or
7258 -1 for an expansion error ) in both cases, message in
7259 -2 for an integer interpretation error ) expand_string_message
7260 expand_string_message is set NULL for an OK integer
7264 expand_string_integer(uschar *string, BOOL isplus)
7266 return expanded_string_integer(expand_string(string), isplus);
7270 /*************************************************
7271 * Interpret string as an integer *
7272 *************************************************/
7274 /* Convert a string (that has already been expanded) into an integer.
7276 This function is used inside the expansion code.
7279 s the string to be expanded
7280 isplus TRUE if a non-negative number is expected
7282 Returns: the integer value, or
7283 -1 if string is NULL (which implies an expansion error)
7284 -2 for an integer interpretation error
7285 expand_string_message is set NULL for an OK integer
7288 static int_eximarith_t
7289 expanded_string_integer(const uschar *s, BOOL isplus)
7291 int_eximarith_t value;
7292 uschar *msg = US"invalid integer \"%s\"";
7295 /* If expansion failed, expand_string_message will be set. */
7297 if (s == NULL) return -1;
7299 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7300 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7301 systems, so we set it zero ourselves. */
7304 expand_string_message = NULL; /* Indicates no error */
7306 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7307 equal to 0. Unfortunately, people actually relied upon that, so preserve
7308 the behaviour explicitly. Stripping leading whitespace is a harmless
7309 noop change since strtol skips it anyway (provided that there is a number
7313 while (isspace(*s)) ++s;
7317 debug_printf("treating blank string as number 0\n");
7322 value = strtoll(CS s, CSS &endptr, 10);
7326 msg = US"integer expected but \"%s\" found";
7328 else if (value < 0 && isplus)
7330 msg = US"non-negative integer expected but \"%s\" found";
7334 switch (tolower(*endptr))
7339 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7344 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7345 else value *= 1024*1024;
7349 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7350 else value *= 1024*1024*1024;
7354 if (errno == ERANGE)
7355 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7358 while (isspace(*endptr)) endptr++;
7359 if (*endptr == 0) return value;
7363 expand_string_message = string_sprintf(CS msg, s);
7368 /* These values are usually fixed boolean values, but they are permitted to be
7372 addr address being routed
7373 mtype the module type
7374 mname the module name
7375 dbg_opt debug selectors
7376 oname the option name
7377 bvalue the router's boolean value
7378 svalue the router's string value
7379 rvalue where to put the returned value
7381 Returns: OK value placed in rvalue
7382 DEFER expansion failed
7386 exp_bool(address_item *addr,
7387 uschar *mtype, uschar *mname, unsigned dbg_opt,
7388 uschar *oname, BOOL bvalue,
7389 uschar *svalue, BOOL *rvalue)
7392 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7394 expanded = expand_string(svalue);
7395 if (expanded == NULL)
7397 if (expand_string_forcedfail)
7399 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7403 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7404 oname, mname, mtype, expand_string_message);
7405 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7409 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7412 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7414 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7418 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7419 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7429 /*************************************************
7430 **************************************************
7431 * Stand-alone test program *
7432 **************************************************
7433 *************************************************/
7439 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7441 int ovector[3*(EXPAND_MAXN+1)];
7442 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7443 ovector, nelem(ovector));
7444 BOOL yield = n >= 0;
7445 if (n == 0) n = EXPAND_MAXN + 1;
7449 expand_nmax = (setup < 0)? 0 : setup + 1;
7450 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7452 expand_nstring[expand_nmax] = subject + ovector[nn];
7453 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7461 int main(int argc, uschar **argv)
7464 uschar buffer[1024];
7466 debug_selector = D_v;
7467 debug_file = stderr;
7468 debug_fd = fileno(debug_file);
7469 big_buffer = malloc(big_buffer_size);
7471 for (i = 1; i < argc; i++)
7473 if (argv[i][0] == '+')
7475 debug_trace_memory = 2;
7478 if (isdigit(argv[i][0]))
7479 debug_selector = Ustrtol(argv[i], NULL, 0);
7481 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7485 eldap_default_servers = argv[i];
7488 mysql_servers = argv[i];
7491 pgsql_servers = argv[i];
7493 #ifdef EXPERIMENTAL_REDIS
7494 redis_servers = argv[i];
7498 else opt_perl_startup = argv[i];
7502 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7504 expand_nstring[1] = US"string 1....";
7505 expand_nlength[1] = 8;
7509 if (opt_perl_startup != NULL)
7512 printf("Starting Perl interpreter\n");
7513 errstr = init_perl(opt_perl_startup);
7516 printf("** error in perl_startup code: %s\n", errstr);
7517 return EXIT_FAILURE;
7520 #endif /* EXIM_PERL */
7522 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7524 void *reset_point = store_get(0);
7525 uschar *yield = expand_string(buffer);
7528 printf("%s\n", yield);
7529 store_reset(reset_point);
7533 if (search_find_defer) printf("search_find deferred\n");
7534 printf("Failed: %s\n", expand_string_message);
7535 if (expand_string_forcedfail) printf("Forced failure\n");
7549 /* End of expand.c */