1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *);
17 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
20 #ifndef SUPPORT_CRYPTEQ
21 #define SUPPORT_CRYPTEQ
26 #include "lookups/ldap.h"
29 #ifdef SUPPORT_CRYPTEQ
34 extern char* crypt16(char*, char*);
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. Charaters after the first 16 are ignored. It always generates
50 a 16-byte hash, which is expressed together with the salt as a string
51 of 24 base 64 digits. Here are some links to peruse:
53 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
54 http://seclists.org/bugtraq/1999/Mar/0076.html
56 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
57 and OSF/1. This is the same as the standard crypt if given a password
58 of 8 characters or less. If given more, it first does the same as crypt
59 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
60 using as salt the first two base 64 digits from the first hash block.
61 If the password is more than 16 characters then it crypts the 17th to 24th
62 characters using as salt the first two base 64 digits from the second hash
63 block. And so on: I've seen references to it cutting off the password at
64 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
66 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
67 http://seclists.org/bugtraq/1999/Mar/0109.html
68 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
69 TET1_html/sec.c222.html#no_id_208
71 Exim has something it calls "crypt16". It will either use a native
72 crypt16 or its own implementation. A native crypt16 will presumably
73 be the one that I called "crypt16" above. The internal "crypt16"
74 function, however, is a two-block-maximum implementation of what I called
75 "bigcrypt". The documentation matches the internal code.
77 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
78 that crypt16 and bigcrypt were different things.
80 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
81 to whatever it is using under that name. This unfortunately sets a
82 precedent for using "{crypt16}" to identify two incompatible algorithms
83 whose output can't be distinguished. With "{crypt16}" thus rendered
84 ambiguous, I suggest you deprecate it and invent two new identifiers
85 for the two algorithms.
87 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
88 of the password separately means they can be cracked separately, so
89 the double-length hash only doubles the cracking effort instead of
90 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
164 /* Tables of operator names, and corresponding switch numbers. The names must be
165 in alphabetical order. There are two tables, because underscore is used in some
166 cases to introduce arguments, whereas for other it is part of the name. This is
167 an historical mis-design. */
169 static uschar *op_table_underscore[] = {
172 US"quote_local_part",
177 ,US"utf8_domain_from_alabel",
178 US"utf8_domain_to_alabel",
179 US"utf8_localpart_from_alabel",
180 US"utf8_localpart_to_alabel"
187 EOP_QUOTE_LOCAL_PART,
192 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
193 EOP_UTF8_DOMAIN_TO_ALABEL,
194 EOP_UTF8_LOCALPART_FROM_ALABEL,
195 EOP_UTF8_LOCALPART_TO_ALABEL
199 static uschar *op_table_main[] = {
242 EOP_ADDRESS = nelem(op_table_underscore),
284 /* Table of condition names, and corresponding switch numbers. The names must
285 be in alphabetical order. */
287 static uschar *cond_table[] = {
291 US"==", /* Backward compatibility */
324 US"match_local_part",
349 ECOND_FIRST_DELIVERY,
370 ECOND_MATCH_LOCAL_PART,
380 /* Types of table entry */
383 vtype_int, /* value is address of int */
384 vtype_filter_int, /* ditto, but recognized only when filtering */
385 vtype_ino, /* value is address of ino_t (not always an int) */
386 vtype_uid, /* value is address of uid_t (not always an int) */
387 vtype_gid, /* value is address of gid_t (not always an int) */
388 vtype_bool, /* value is address of bool */
389 vtype_stringptr, /* value is address of pointer to string */
390 vtype_msgbody, /* as stringptr, but read when first required */
391 vtype_msgbody_end, /* ditto, the end of the message */
392 vtype_msgheaders, /* the message's headers, processed */
393 vtype_msgheaders_raw, /* the message's headers, unprocessed */
394 vtype_localpart, /* extract local part from string */
395 vtype_domain, /* extract domain from string */
396 vtype_string_func, /* value is string returned by given function */
397 vtype_todbsdin, /* value not used; generate BSD inbox tod */
398 vtype_tode, /* value not used; generate tod in epoch format */
399 vtype_todel, /* value not used; generate tod in epoch/usec format */
400 vtype_todf, /* value not used; generate full tod */
401 vtype_todl, /* value not used; generate log tod */
402 vtype_todlf, /* value not used; generate log file datestamp tod */
403 vtype_todzone, /* value not used; generate time zone only */
404 vtype_todzulu, /* value not used; generate zulu tod */
405 vtype_reply, /* value not used; get reply from headers */
406 vtype_pid, /* value not used; result is pid */
407 vtype_host_lookup, /* value not used; get host name */
408 vtype_load_avg, /* value not used; result is int from os_getloadavg */
409 vtype_pspace, /* partition space; value is T/F for spool/log */
410 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
411 vtype_cert /* SSL certificate */
413 ,vtype_dkim /* Lookup of value in DKIM signature */
417 /* Type for main variable table */
425 /* Type for entries pointing to address/length pairs. Not currently
433 static uschar * fn_recipients(void);
435 /* This table must be kept in alphabetical order. */
437 static var_entry var_table[] = {
438 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
439 they will be confused with user-creatable ACL variables. */
440 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
441 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
442 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
443 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
444 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
445 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
446 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
447 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
448 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
449 { "acl_narg", vtype_int, &acl_narg },
450 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
451 { "address_data", vtype_stringptr, &deliver_address_data },
452 { "address_file", vtype_stringptr, &address_file },
453 { "address_pipe", vtype_stringptr, &address_pipe },
454 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
455 { "authenticated_id", vtype_stringptr, &authenticated_id },
456 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
457 { "authentication_failed",vtype_int, &authentication_failed },
458 #ifdef WITH_CONTENT_SCAN
459 { "av_failed", vtype_int, &av_failed },
461 #ifdef EXPERIMENTAL_BRIGHTMAIL
462 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
463 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
464 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
465 { "bmi_deliver", vtype_int, &bmi_deliver },
467 { "body_linecount", vtype_int, &body_linecount },
468 { "body_zerocount", vtype_int, &body_zerocount },
469 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
470 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
471 { "caller_gid", vtype_gid, &real_gid },
472 { "caller_uid", vtype_uid, &real_uid },
473 { "callout_address", vtype_stringptr, &callout_address },
474 { "compile_date", vtype_stringptr, &version_date },
475 { "compile_number", vtype_stringptr, &version_cnumber },
476 { "config_dir", vtype_stringptr, &config_main_directory },
477 { "config_file", vtype_stringptr, &config_main_filename },
478 { "csa_status", vtype_stringptr, &csa_status },
479 #ifdef EXPERIMENTAL_DCC
480 { "dcc_header", vtype_stringptr, &dcc_header },
481 { "dcc_result", vtype_stringptr, &dcc_result },
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_length", vtype_int, &dkim_key_length },
497 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
498 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
499 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
500 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
501 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
502 { "dkim_signers", vtype_stringptr, &dkim_signers },
503 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
504 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
506 #ifdef EXPERIMENTAL_DMARC
507 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
508 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
509 { "dmarc_status", vtype_stringptr, &dmarc_status },
510 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
511 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
513 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
514 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
515 { "dnslist_text", vtype_stringptr, &dnslist_text },
516 { "dnslist_value", vtype_stringptr, &dnslist_value },
517 { "domain", vtype_stringptr, &deliver_domain },
518 { "domain_data", vtype_stringptr, &deliver_domain_data },
519 #ifndef DISABLE_EVENT
520 { "event_data", vtype_stringptr, &event_data },
522 /*XXX want to use generic vars for as many of these as possible*/
523 { "event_defer_errno", vtype_int, &event_defer_errno },
525 { "event_name", vtype_stringptr, &event_name },
527 { "exim_gid", vtype_gid, &exim_gid },
528 { "exim_path", vtype_stringptr, &exim_path },
529 { "exim_uid", vtype_uid, &exim_uid },
530 { "exim_version", vtype_stringptr, &version_string },
531 { "headers_added", vtype_string_func, &fn_hdrs_added },
532 { "home", vtype_stringptr, &deliver_home },
533 { "host", vtype_stringptr, &deliver_host },
534 { "host_address", vtype_stringptr, &deliver_host_address },
535 { "host_data", vtype_stringptr, &host_data },
536 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
537 { "host_lookup_failed", vtype_int, &host_lookup_failed },
538 { "host_port", vtype_int, &deliver_host_port },
539 { "initial_cwd", vtype_stringptr, &initial_cwd },
540 { "inode", vtype_ino, &deliver_inode },
541 { "interface_address", vtype_stringptr, &interface_address },
542 { "interface_port", vtype_int, &interface_port },
543 { "item", vtype_stringptr, &iterate_item },
545 { "ldap_dn", vtype_stringptr, &eldap_dn },
547 { "load_average", vtype_load_avg, NULL },
548 { "local_part", vtype_stringptr, &deliver_localpart },
549 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
550 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
551 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
552 { "local_scan_data", vtype_stringptr, &local_scan_data },
553 { "local_user_gid", vtype_gid, &local_user_gid },
554 { "local_user_uid", vtype_uid, &local_user_uid },
555 { "localhost_number", vtype_int, &host_number },
556 { "log_inodes", vtype_pinodes, (void *)FALSE },
557 { "log_space", vtype_pspace, (void *)FALSE },
558 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
559 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
560 #ifdef WITH_CONTENT_SCAN
561 { "malware_name", vtype_stringptr, &malware_name },
563 { "max_received_linelength", vtype_int, &max_received_linelength },
564 { "message_age", vtype_int, &message_age },
565 { "message_body", vtype_msgbody, &message_body },
566 { "message_body_end", vtype_msgbody_end, &message_body_end },
567 { "message_body_size", vtype_int, &message_body_size },
568 { "message_exim_id", vtype_stringptr, &message_id },
569 { "message_headers", vtype_msgheaders, NULL },
570 { "message_headers_raw", vtype_msgheaders_raw, NULL },
571 { "message_id", vtype_stringptr, &message_id },
572 { "message_linecount", vtype_int, &message_linecount },
573 { "message_size", vtype_int, &message_size },
575 { "message_smtputf8", vtype_bool, &message_smtputf8 },
577 #ifdef WITH_CONTENT_SCAN
578 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
579 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
580 { "mime_boundary", vtype_stringptr, &mime_boundary },
581 { "mime_charset", vtype_stringptr, &mime_charset },
582 { "mime_content_description", vtype_stringptr, &mime_content_description },
583 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
584 { "mime_content_id", vtype_stringptr, &mime_content_id },
585 { "mime_content_size", vtype_int, &mime_content_size },
586 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
587 { "mime_content_type", vtype_stringptr, &mime_content_type },
588 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
589 { "mime_filename", vtype_stringptr, &mime_filename },
590 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
591 { "mime_is_multipart", vtype_int, &mime_is_multipart },
592 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
593 { "mime_part_count", vtype_int, &mime_part_count },
595 { "n0", vtype_filter_int, &filter_n[0] },
596 { "n1", vtype_filter_int, &filter_n[1] },
597 { "n2", vtype_filter_int, &filter_n[2] },
598 { "n3", vtype_filter_int, &filter_n[3] },
599 { "n4", vtype_filter_int, &filter_n[4] },
600 { "n5", vtype_filter_int, &filter_n[5] },
601 { "n6", vtype_filter_int, &filter_n[6] },
602 { "n7", vtype_filter_int, &filter_n[7] },
603 { "n8", vtype_filter_int, &filter_n[8] },
604 { "n9", vtype_filter_int, &filter_n[9] },
605 { "original_domain", vtype_stringptr, &deliver_domain_orig },
606 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
607 { "originator_gid", vtype_gid, &originator_gid },
608 { "originator_uid", vtype_uid, &originator_uid },
609 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
610 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
611 { "pid", vtype_pid, NULL },
613 { "prdr_requested", vtype_bool, &prdr_requested },
615 { "primary_hostname", vtype_stringptr, &primary_hostname },
616 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
617 { "proxy_external_address",vtype_stringptr, &proxy_external_address },
618 { "proxy_external_port", vtype_int, &proxy_external_port },
619 { "proxy_local_address", vtype_stringptr, &proxy_local_address },
620 { "proxy_local_port", vtype_int, &proxy_local_port },
621 { "proxy_session", vtype_bool, &proxy_session },
623 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
624 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
625 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
626 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
627 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
628 { "rcpt_count", vtype_int, &rcpt_count },
629 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
630 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
631 { "received_count", vtype_int, &received_count },
632 { "received_for", vtype_stringptr, &received_for },
633 { "received_ip_address", vtype_stringptr, &interface_address },
634 { "received_port", vtype_int, &interface_port },
635 { "received_protocol", vtype_stringptr, &received_protocol },
636 { "received_time", vtype_int, &received_time },
637 { "recipient_data", vtype_stringptr, &recipient_data },
638 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
639 { "recipients", vtype_string_func, &fn_recipients },
640 { "recipients_count", vtype_int, &recipients_count },
641 #ifdef WITH_CONTENT_SCAN
642 { "regex_match_string", vtype_stringptr, ®ex_match_string },
644 { "reply_address", vtype_reply, NULL },
645 { "return_path", vtype_stringptr, &return_path },
646 { "return_size_limit", vtype_int, &bounce_return_size_limit },
647 { "router_name", vtype_stringptr, &router_name },
648 { "runrc", vtype_int, &runrc },
649 { "self_hostname", vtype_stringptr, &self_hostname },
650 { "sender_address", vtype_stringptr, &sender_address },
651 { "sender_address_data", vtype_stringptr, &sender_address_data },
652 { "sender_address_domain", vtype_domain, &sender_address },
653 { "sender_address_local_part", vtype_localpart, &sender_address },
654 { "sender_data", vtype_stringptr, &sender_data },
655 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
656 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
657 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
658 { "sender_host_address", vtype_stringptr, &sender_host_address },
659 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
660 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
661 { "sender_host_name", vtype_host_lookup, NULL },
662 { "sender_host_port", vtype_int, &sender_host_port },
663 { "sender_ident", vtype_stringptr, &sender_ident },
664 { "sender_rate", vtype_stringptr, &sender_rate },
665 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
666 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
667 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
668 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
669 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
670 { "sending_port", vtype_int, &sending_port },
671 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
672 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
673 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
674 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
675 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
676 { "sn0", vtype_filter_int, &filter_sn[0] },
677 { "sn1", vtype_filter_int, &filter_sn[1] },
678 { "sn2", vtype_filter_int, &filter_sn[2] },
679 { "sn3", vtype_filter_int, &filter_sn[3] },
680 { "sn4", vtype_filter_int, &filter_sn[4] },
681 { "sn5", vtype_filter_int, &filter_sn[5] },
682 { "sn6", vtype_filter_int, &filter_sn[6] },
683 { "sn7", vtype_filter_int, &filter_sn[7] },
684 { "sn8", vtype_filter_int, &filter_sn[8] },
685 { "sn9", vtype_filter_int, &filter_sn[9] },
686 #ifdef WITH_CONTENT_SCAN
687 { "spam_action", vtype_stringptr, &spam_action },
688 { "spam_bar", vtype_stringptr, &spam_bar },
689 { "spam_report", vtype_stringptr, &spam_report },
690 { "spam_score", vtype_stringptr, &spam_score },
691 { "spam_score_int", vtype_stringptr, &spam_score_int },
693 #ifdef EXPERIMENTAL_SPF
694 { "spf_guess", vtype_stringptr, &spf_guess },
695 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
696 { "spf_received", vtype_stringptr, &spf_received },
697 { "spf_result", vtype_stringptr, &spf_result },
698 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
700 { "spool_directory", vtype_stringptr, &spool_directory },
701 { "spool_inodes", vtype_pinodes, (void *)TRUE },
702 { "spool_space", vtype_pspace, (void *)TRUE },
703 #ifdef EXPERIMENTAL_SRS
704 { "srs_db_address", vtype_stringptr, &srs_db_address },
705 { "srs_db_key", vtype_stringptr, &srs_db_key },
706 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
707 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
708 { "srs_recipient", vtype_stringptr, &srs_recipient },
709 { "srs_status", vtype_stringptr, &srs_status },
711 { "thisaddress", vtype_stringptr, &filter_thisaddress },
713 /* The non-(in,out) variables are now deprecated */
714 { "tls_bits", vtype_int, &tls_in.bits },
715 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
716 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
718 { "tls_in_bits", vtype_int, &tls_in.bits },
719 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
720 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
721 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
722 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
723 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
724 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
725 #if defined(SUPPORT_TLS)
726 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
728 { "tls_out_bits", vtype_int, &tls_out.bits },
729 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
730 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
731 #ifdef EXPERIMENTAL_DANE
732 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
734 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
735 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
736 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
737 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
738 #if defined(SUPPORT_TLS)
739 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
741 #ifdef EXPERIMENTAL_DANE
742 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
745 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
746 #if defined(SUPPORT_TLS)
747 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
750 { "tod_bsdinbox", vtype_todbsdin, NULL },
751 { "tod_epoch", vtype_tode, NULL },
752 { "tod_epoch_l", vtype_todel, NULL },
753 { "tod_full", vtype_todf, NULL },
754 { "tod_log", vtype_todl, NULL },
755 { "tod_logfile", vtype_todlf, NULL },
756 { "tod_zone", vtype_todzone, NULL },
757 { "tod_zulu", vtype_todzulu, NULL },
758 { "transport_name", vtype_stringptr, &transport_name },
759 { "value", vtype_stringptr, &lookup_value },
760 { "verify_mode", vtype_stringptr, &verify_mode },
761 { "version_number", vtype_stringptr, &version_string },
762 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
763 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
764 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
765 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
766 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
767 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
770 static int var_table_size = nelem(var_table);
771 static uschar var_buffer[256];
772 static BOOL malformed_header;
774 /* For textual hashes */
776 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
777 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
780 enum { HMAC_MD5, HMAC_SHA1 };
782 /* For numeric hashes */
784 static unsigned int prime[] = {
785 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
786 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
787 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
789 /* For printing modes in symbolic form */
791 static uschar *mtable_normal[] =
792 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
794 static uschar *mtable_setid[] =
795 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
797 static uschar *mtable_sticky[] =
798 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
802 /*************************************************
803 * Tables for UTF-8 support *
804 *************************************************/
806 /* Table of the number of extra characters, indexed by the first character
807 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
810 static uschar utf8_table1[] = {
811 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
812 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
813 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
814 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
816 /* These are the masks for the data bits in the first byte of a character,
817 indexed by the number of additional bytes. */
819 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
821 /* Get the next UTF-8 character, advancing the pointer. */
823 #define GETUTF8INC(c, ptr) \
825 if ((c & 0xc0) == 0xc0) \
827 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
829 c = (c & utf8_table2[a]) << s; \
833 c |= (*ptr++ & 0x3f) << s; \
838 /*************************************************
839 * Binary chop search on a table *
840 *************************************************/
842 /* This is used for matching expansion items and operators.
845 name the name that is being sought
846 table the table to search
847 table_size the number of items in the table
849 Returns: the offset in the table, or -1
853 chop_match(uschar *name, uschar **table, int table_size)
855 uschar **bot = table;
856 uschar **top = table + table_size;
860 uschar **mid = bot + (top - bot)/2;
861 int c = Ustrcmp(name, *mid);
862 if (c == 0) return mid - table;
863 if (c > 0) bot = mid + 1; else top = mid;
871 /*************************************************
872 * Check a condition string *
873 *************************************************/
875 /* This function is called to expand a string, and test the result for a "true"
876 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
877 forced fail or lookup defer.
879 We used to release all store used, but this is not not safe due
880 to ${dlfunc } and ${acl }. In any case expand_string_internal()
881 is reasonably careful to release what it can.
883 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
886 condition the condition string
887 m1 text to be incorporated in panic error
890 Returns: TRUE if condition is met, FALSE if not
894 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
897 uschar *ss = expand_string(condition);
900 if (!expand_string_forcedfail && !search_find_defer)
901 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
902 "for %s %s: %s", condition, m1, m2, expand_string_message);
905 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
906 strcmpic(ss, US"false") != 0;
913 /*************************************************
914 * Pseudo-random number generation *
915 *************************************************/
917 /* Pseudo-random number generation. The result is not "expected" to be
918 cryptographically strong but not so weak that someone will shoot themselves
919 in the foot using it as a nonce in some email header scheme or whatever
920 weirdness they'll twist this into. The result should ideally handle fork().
922 However, if we're stuck unable to provide this, then we'll fall back to
923 appallingly bad randomness.
925 If SUPPORT_TLS is defined then this will not be used except as an emergency
930 Returns a random number in range [0, max-1]
934 # define vaguely_random_number vaguely_random_number_fallback
937 vaguely_random_number(int max)
940 # undef vaguely_random_number
942 static pid_t pid = 0;
944 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
954 #ifdef HAVE_ARC4RANDOM
955 /* cryptographically strong randomness, common on *BSD platforms, not
956 so much elsewhere. Alas. */
957 #ifndef NOT_HAVE_ARC4RANDOM_STIR
960 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
961 #ifdef HAVE_SRANDOMDEV
962 /* uses random(4) for seeding */
965 gettimeofday(&tv, NULL);
966 srandom(tv.tv_sec | tv.tv_usec | getpid());
969 /* Poor randomness and no seeding here */
976 #ifdef HAVE_ARC4RANDOM
977 return arc4random() % max;
978 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
979 return random() % max;
981 /* This one returns a 16-bit number, definitely not crypto-strong */
982 return random_number(max);
989 /*************************************************
990 * Pick out a name from a string *
991 *************************************************/
993 /* If the name is too long, it is silently truncated.
996 name points to a buffer into which to put the name
997 max is the length of the buffer
998 s points to the first alphabetic character of the name
999 extras chars other than alphanumerics to permit
1001 Returns: pointer to the first character after the name
1003 Note: The test for *s != 0 in the while loop is necessary because
1004 Ustrchr() yields non-NULL if the character is zero (which is not something
1007 static const uschar *
1008 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1011 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1013 if (ptr < max-1) name[ptr++] = *s;
1022 /*************************************************
1023 * Pick out the rest of a header name *
1024 *************************************************/
1026 /* A variable name starting $header_ (or just $h_ for those who like
1027 abbreviations) might not be the complete header name because headers can
1028 contain any printing characters in their names, except ':'. This function is
1029 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1030 on the end, if the name was terminated by white space.
1033 name points to a buffer in which the name read so far exists
1034 max is the length of the buffer
1035 s points to the first character after the name so far, i.e. the
1036 first non-alphameric character after $header_xxxxx
1038 Returns: a pointer to the first character after the header name
1041 static const uschar *
1042 read_header_name(uschar *name, int max, const uschar *s)
1044 int prelen = Ustrchr(name, '_') - name + 1;
1045 int ptr = Ustrlen(name) - prelen;
1046 if (ptr > 0) memmove(name, name+prelen, ptr);
1047 while (mac_isgraph(*s) && *s != ':')
1049 if (ptr < max-1) name[ptr++] = *s;
1060 /*************************************************
1061 * Pick out a number from a string *
1062 *************************************************/
1065 n points to an integer into which to put the number
1066 s points to the first digit of the number
1068 Returns: a pointer to the character after the last digit
1070 /*XXX consider expanding to int_eximarith_t. But the test for
1071 "overbig numbers" in 0002 still needs to overflow it. */
1074 read_number(int *n, uschar *s)
1077 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1081 static const uschar *
1082 read_cnumber(int *n, const uschar *s)
1085 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1091 /*************************************************
1092 * Extract keyed subfield from a string *
1093 *************************************************/
1095 /* The yield is in dynamic store; NULL means that the key was not found.
1098 key points to the name of the key
1099 s points to the string from which to extract the subfield
1101 Returns: NULL if the subfield was not found, or
1102 a pointer to the subfield's data
1106 expand_getkeyed(uschar *key, const uschar *s)
1108 int length = Ustrlen(key);
1109 while (isspace(*s)) s++;
1111 /* Loop to search for the key */
1117 const uschar *dkey = s;
1119 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1120 dkeylength = s - dkey;
1121 while (isspace(*s)) s++;
1122 if (*s == '=') while (isspace((*(++s))));
1124 data = string_dequote(&s);
1125 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1128 while (isspace(*s)) s++;
1137 find_var_ent(uschar * name)
1140 int last = var_table_size;
1142 while (last > first)
1144 int middle = (first + last)/2;
1145 int c = Ustrcmp(name, var_table[middle].name);
1147 if (c > 0) { first = middle + 1; continue; }
1148 if (c < 0) { last = middle; continue; }
1149 return &var_table[middle];
1154 /*************************************************
1155 * Extract numbered subfield from string *
1156 *************************************************/
1158 /* Extracts a numbered field from a string that is divided by tokens - for
1159 example a line from /etc/passwd is divided by colon characters. First field is
1160 numbered one. Negative arguments count from the right. Zero returns the whole
1161 string. Returns NULL if there are insufficient tokens in the string
1164 Modifies final argument - this is a dynamically generated string, so that's OK.
1167 field number of field to be extracted,
1168 first field = 1, whole string = 0, last field = -1
1169 separators characters that are used to break string into tokens
1170 s points to the string from which to extract the subfield
1172 Returns: NULL if the field was not found,
1173 a pointer to the field's data inside s (modified to add 0)
1177 expand_gettokened (int field, uschar *separators, uschar *s)
1182 uschar *fieldtext = NULL;
1184 if (field == 0) return s;
1186 /* Break the line up into fields in place; for field > 0 we stop when we have
1187 done the number of fields we want. For field < 0 we continue till the end of
1188 the string, counting the number of fields. */
1190 count = (field > 0)? field : INT_MAX;
1196 /* Previous field was the last one in the string. For a positive field
1197 number, this means there are not enough fields. For a negative field number,
1198 check that there are enough, and scan back to find the one that is wanted. */
1202 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1203 if ((-field) == (INT_MAX - count - 1)) return s;
1207 while (ss[-1] != 0) ss--;
1213 /* Previous field was not last in the string; save its start and put a
1217 len = Ustrcspn(ss, separators);
1228 expand_getlistele(int field, const uschar * list)
1230 const uschar * tlist= list;
1236 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1239 if(field==0) return NULL;
1240 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1241 return string_nextinlist(&list, &sep, NULL, 0);
1245 /* Certificate fields, by name. Worry about by-OID later */
1246 /* Names are chosen to not have common prefixes */
1253 uschar * (*getfn)(void * cert, uschar * mod);
1255 static certfield certfields[] =
1256 { /* linear search; no special order */
1257 { US"version", 7, &tls_cert_version },
1258 { US"serial_number", 13, &tls_cert_serial_number },
1259 { US"subject", 7, &tls_cert_subject },
1260 { US"notbefore", 9, &tls_cert_not_before },
1261 { US"notafter", 8, &tls_cert_not_after },
1262 { US"issuer", 6, &tls_cert_issuer },
1263 { US"signature", 9, &tls_cert_signature },
1264 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1265 { US"subj_altname", 12, &tls_cert_subject_altname },
1266 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1267 { US"crl_uri", 7, &tls_cert_crl_uri },
1271 expand_getcertele(uschar * field, uschar * certvar)
1276 if (!(vp = find_var_ent(certvar)))
1278 expand_string_message =
1279 string_sprintf("no variable named \"%s\"", certvar);
1280 return NULL; /* Unknown variable name */
1282 /* NB this stops us passing certs around in variable. Might
1283 want to do that in future */
1284 if (vp->type != vtype_cert)
1286 expand_string_message =
1287 string_sprintf("\"%s\" is not a certificate", certvar);
1288 return NULL; /* Unknown variable name */
1290 if (!*(void **)vp->value)
1293 if (*field >= '0' && *field <= '9')
1294 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1296 for(cp = certfields;
1297 cp < certfields + nelem(certfields);
1299 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1301 uschar * modifier = *(field += cp->namelen) == ','
1303 return (*cp->getfn)( *(void **)vp->value, modifier );
1306 expand_string_message =
1307 string_sprintf("bad field selector \"%s\" for certextract", field);
1310 #endif /*SUPPORT_TLS*/
1312 /*************************************************
1313 * Extract a substring from a string *
1314 *************************************************/
1316 /* Perform the ${substr or ${length expansion operations.
1319 subject the input string
1320 value1 the offset from the start of the input string to the start of
1321 the output string; if negative, count from the right.
1322 value2 the length of the output string, or negative (-1) for unset
1323 if value1 is positive, unset means "all after"
1324 if value1 is negative, unset means "all before"
1325 len set to the length of the returned string
1327 Returns: pointer to the output string, or NULL if there is an error
1331 extract_substr(uschar *subject, int value1, int value2, int *len)
1333 int sublen = Ustrlen(subject);
1335 if (value1 < 0) /* count from right */
1339 /* If the position is before the start, skip to the start, and adjust the
1340 length. If the length ends up negative, the substring is null because nothing
1341 can precede. This falls out naturally when the length is unset, meaning "all
1347 if (value2 < 0) value2 = 0;
1351 /* Otherwise an unset length => characters before value1 */
1353 else if (value2 < 0)
1360 /* For a non-negative offset, if the starting position is past the end of the
1361 string, the result will be the null string. Otherwise, an unset length means
1362 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1366 if (value1 > sublen)
1371 else if (value2 < 0) value2 = sublen;
1374 /* Cut the length down to the maximum possible for the offset value, and get
1375 the required characters. */
1377 if (value1 + value2 > sublen) value2 = sublen - value1;
1379 return subject + value1;
1385 /*************************************************
1386 * Old-style hash of a string *
1387 *************************************************/
1389 /* Perform the ${hash expansion operation.
1392 subject the input string (an expanded substring)
1393 value1 the length of the output string; if greater or equal to the
1394 length of the input string, the input string is returned
1395 value2 the number of hash characters to use, or 26 if negative
1396 len set to the length of the returned string
1398 Returns: pointer to the output string, or NULL if there is an error
1402 compute_hash(uschar *subject, int value1, int value2, int *len)
1404 int sublen = Ustrlen(subject);
1406 if (value2 < 0) value2 = 26;
1407 else if (value2 > Ustrlen(hashcodes))
1409 expand_string_message =
1410 string_sprintf("hash count \"%d\" too big", value2);
1414 /* Calculate the hash text. We know it is shorter than the original string, so
1415 can safely place it in subject[] (we know that subject is always itself an
1416 expanded substring). */
1418 if (value1 < sublen)
1423 while ((c = (subject[j])) != 0)
1425 int shift = (c + j++) & 7;
1426 subject[i] ^= (c << shift) | (c >> (8-shift));
1427 if (++i >= value1) i = 0;
1429 for (i = 0; i < value1; i++)
1430 subject[i] = hashcodes[(subject[i]) % value2];
1432 else value1 = sublen;
1441 /*************************************************
1442 * Numeric hash of a string *
1443 *************************************************/
1445 /* Perform the ${nhash expansion operation. The first characters of the
1446 string are treated as most important, and get the highest prime numbers.
1449 subject the input string
1450 value1 the maximum value of the first part of the result
1451 value2 the maximum value of the second part of the result,
1452 or negative to produce only a one-part result
1453 len set to the length of the returned string
1455 Returns: pointer to the output string, or NULL if there is an error.
1459 compute_nhash (uschar *subject, int value1, int value2, int *len)
1461 uschar *s = subject;
1463 unsigned long int total = 0; /* no overflow */
1467 if (i == 0) i = nelem(prime) - 1;
1468 total += prime[i--] * (unsigned int)(*s++);
1471 /* If value2 is unset, just compute one number */
1475 s = string_sprintf("%d", total % value1);
1478 /* Otherwise do a div/mod hash */
1482 total = total % (value1 * value2);
1483 s = string_sprintf("%d/%d", total/value2, total % value2);
1494 /*************************************************
1495 * Find the value of a header or headers *
1496 *************************************************/
1498 /* Multiple instances of the same header get concatenated, and this function
1499 can also return a concatenation of all the header lines. When concatenating
1500 specific headers that contain lists of addresses, a comma is inserted between
1501 them. Otherwise we use a straight concatenation. Because some messages can have
1502 pathologically large number of lines, there is a limit on the length that is
1503 returned. Also, to avoid massive store use which would result from using
1504 string_cat() as it copies and extends strings, we do a preliminary pass to find
1505 out exactly how much store will be needed. On "normal" messages this will be
1509 name the name of the header, without the leading $header_ or $h_,
1510 or NULL if a concatenation of all headers is required
1511 exists_only TRUE if called from a def: test; don't need to build a string;
1512 just return a string that is not "" and not "0" if the header
1514 newsize return the size of memory block that was obtained; may be NULL
1515 if exists_only is TRUE
1516 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1517 other than concatenating, will be done on the header. Also used
1518 for $message_headers_raw.
1519 charset name of charset to translate MIME words to; used only if
1520 want_raw is false; if NULL, no translation is done (this is
1521 used for $bh_ and $bheader_)
1523 Returns: NULL if the header does not exist, else a pointer to a new
1528 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1531 BOOL found = name == NULL;
1533 int len = found? 0 : Ustrlen(name);
1535 uschar *yield = NULL;
1538 /* Loop for two passes - saves code repetition */
1540 for (i = 0; i < 2; i++)
1545 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1547 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1549 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1554 if (exists_only) return US"1"; /* don't need actual string */
1556 t = h->text + len; /* text to insert */
1557 if (!want_raw) /* unless wanted raw, */
1558 while (isspace(*t)) t++; /* remove leading white space */
1559 ilen = h->slen - (t - h->text); /* length to insert */
1561 /* Unless wanted raw, remove trailing whitespace, including the
1565 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1567 /* Set comma = 1 if handling a single header and it's one of those
1568 that contains an address list, except when asked for raw headers. Only
1569 need to do this once. */
1571 if (!want_raw && name != NULL && comma == 0 &&
1572 Ustrchr("BCFRST", h->type) != NULL)
1575 /* First pass - compute total store needed; second pass - compute
1576 total store used, including this header. */
1578 size += ilen + comma + 1; /* +1 for the newline */
1580 /* Second pass - concatentate the data, up to a maximum. Note that
1581 the loop stops when size hits the limit. */
1585 if (size > header_insert_maxlen)
1587 ilen -= size - header_insert_maxlen - 1;
1590 Ustrncpy(ptr, t, ilen);
1593 /* For a non-raw header, put in the comma if needed, then add
1594 back the newline we removed above, provided there was some text in
1597 if (!want_raw && ilen > 0)
1599 if (comma != 0) *ptr++ = ',';
1607 /* At end of first pass, return NULL if no header found. Then truncate size
1608 if necessary, and get the buffer to hold the data, returning the buffer size.
1613 if (!found) return NULL;
1614 if (size > header_insert_maxlen) size = header_insert_maxlen;
1615 *newsize = size + 1;
1616 ptr = yield = store_get(*newsize);
1620 /* That's all we do for raw header expansion. */
1627 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1628 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1629 function can return an error with decoded data if the charset translation
1630 fails. If decoding fails, it returns NULL. */
1634 uschar *decoded, *error;
1635 if (ptr > yield && ptr[-1] == '\n') ptr--;
1636 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1638 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1642 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1643 " input was: %s\n", error, yield);
1645 if (decoded != NULL) yield = decoded;
1654 /*************************************************
1655 * Return list of recipients *
1656 *************************************************/
1657 /* A recipients list is available only during system message filtering,
1658 during ACL processing after DATA, and while expanding pipe commands
1659 generated from a system filter, but not elsewhere. */
1664 if (!enable_dollar_recipients) return NULL; else
1669 uschar * s = store_get(size);
1670 for (i = 0; i < recipients_count; i++)
1672 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1673 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1674 Ustrlen(recipients_list[i].address));
1676 s[ptr] = 0; /* string_cat() leaves room */
1682 /*************************************************
1683 * Find value of a variable *
1684 *************************************************/
1686 /* The table of variables is kept in alphabetic order, so we can search it
1687 using a binary chop. The "choplen" variable is nothing to do with the binary
1691 name the name of the variable being sought
1692 exists_only TRUE if this is a def: test; passed on to find_header()
1693 skipping TRUE => skip any processing evaluation; this is not the same as
1694 exists_only because def: may test for values that are first
1696 newsize pointer to an int which is initially zero; if the answer is in
1697 a new memory buffer, *newsize is set to its size
1699 Returns: NULL if the variable does not exist, or
1700 a pointer to the variable's contents, or
1701 something non-NULL if exists_only is TRUE
1705 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1712 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1713 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1714 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1715 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1716 (this gave backwards compatibility at the changeover). There may be built-in
1717 variables whose names start acl_ but they should never start in this way. This
1718 slightly messy specification is a consequence of the history, needless to say.
1720 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1721 set, in which case give an error. */
1723 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1727 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1728 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1731 /* Handle $auth<n> variables. */
1733 if (Ustrncmp(name, "auth", 4) == 0)
1736 int n = Ustrtoul(name + 4, &endptr, 10);
1737 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1738 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1740 else if (Ustrncmp(name, "regex", 5) == 0)
1743 int n = Ustrtoul(name + 5, &endptr, 10);
1744 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1745 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1748 /* For all other variables, search the table */
1750 if (!(vp = find_var_ent(name)))
1751 return NULL; /* Unknown variable name */
1753 /* Found an existing variable. If in skipping state, the value isn't needed,
1754 and we want to avoid processing (such as looking up the host name). */
1762 case vtype_filter_int:
1763 if (!filter_running) return NULL;
1767 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1771 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1775 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1779 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1783 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1786 case vtype_stringptr: /* Pointer to string */
1787 return (s = *((uschar **)(val))) ? s : US"";
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 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1849 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1851 len = read(deliver_datafile, body, len);
1855 if (message_body_newlines) /* Separate loops for efficiency */
1857 { if (body[--len] == 0) body[len] = ' '; }
1860 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1863 return (*ss == NULL)? US"" : *ss;
1865 case vtype_todbsdin: /* BSD inbox time of day */
1866 return tod_stamp(tod_bsdin);
1868 case vtype_tode: /* Unix epoch time of day */
1869 return tod_stamp(tod_epoch);
1871 case vtype_todel: /* Unix epoch/usec time of day */
1872 return tod_stamp(tod_epoch_l);
1874 case vtype_todf: /* Full time of day */
1875 return tod_stamp(tod_full);
1877 case vtype_todl: /* Log format time of day */
1878 return tod_stamp(tod_log_bare); /* (without timezone) */
1880 case vtype_todzone: /* Time zone offset only */
1881 return tod_stamp(tod_zone);
1883 case vtype_todzulu: /* Zulu time */
1884 return tod_stamp(tod_zulu);
1886 case vtype_todlf: /* Log file datestamp tod */
1887 return tod_stamp(tod_log_datestamp_daily);
1889 case vtype_reply: /* Get reply address */
1890 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1892 if (s != NULL) while (isspace(*s)) s++;
1893 if (s == NULL || *s == 0)
1895 *newsize = 0; /* For the *s==0 case */
1896 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1901 while (isspace(*s)) s++;
1902 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1903 while (t > s && isspace(t[-1])) t--;
1906 return (s == NULL)? US"" : s;
1908 case vtype_string_func:
1910 uschar * (*fn)() = val;
1917 sprintf(CS var_buffer, "%d",
1918 receive_statvfs(val == (void *)TRUE, &inodes));
1925 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1926 sprintf(CS var_buffer, "%d", inodes);
1931 return *(void **)val ? US"<cert>" : US"";
1933 #ifndef DISABLE_DKIM
1935 return dkim_exim_expand_query((int)(long)val);
1940 return NULL; /* Unknown variable. Silences static checkers. */
1947 modify_variable(uschar *name, void * value)
1950 if ((vp = find_var_ent(name))) vp->value = value;
1951 return; /* Unknown variable name, fail silently */
1958 /*************************************************
1959 * Read and expand substrings *
1960 *************************************************/
1962 /* This function is called to read and expand argument substrings for various
1963 expansion items. Some have a minimum requirement that is less than the maximum;
1964 in these cases, the first non-present one is set to NULL.
1967 sub points to vector of pointers to set
1968 n maximum number of substrings
1970 sptr points to current string pointer
1971 skipping the skipping flag
1972 check_end if TRUE, check for final '}'
1973 name name of item, for error message
1974 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1977 Returns: 0 OK; string pointer updated
1978 1 curly bracketing error (too few arguments)
1979 2 too many arguments (only if check_end is set); message set
1980 3 other error (expansion failure)
1984 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1985 BOOL check_end, uschar *name, BOOL *resetok)
1988 const uschar *s = *sptr;
1990 while (isspace(*s)) s++;
1991 for (i = 0; i < n; i++)
1995 if (i < m) return 1;
1999 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
2000 if (sub[i] == NULL) return 3;
2001 if (*s++ != '}') return 1;
2002 while (isspace(*s)) s++;
2004 if (check_end && *s++ != '}')
2008 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
2009 "(max is %d)", name, n);
2022 /*************************************************
2023 * Elaborate message for bad variable *
2024 *************************************************/
2026 /* For the "unknown variable" message, take a look at the variable's name, and
2027 give additional information about possible ACL variables. The extra information
2028 is added on to expand_string_message.
2030 Argument: the name of the variable
2035 check_variable_error_message(uschar *name)
2037 if (Ustrncmp(name, "acl_", 4) == 0)
2038 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2039 (name[4] == 'c' || name[4] == 'm')?
2041 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2042 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2044 US"user-defined ACL variables must start acl_c or acl_m");
2050 Load args from sub array to globals, and call acl_check().
2051 Sub array will be corrupted on return.
2053 Returns: OK access is granted by an ACCEPT verb
2054 DISCARD access is (apparently) granted by a DISCARD verb
2055 FAIL access is denied
2056 FAIL_DROP access is denied; drop the connection
2057 DEFER can't tell at the moment
2061 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2064 int sav_narg = acl_narg;
2066 uschar * dummy_logmsg;
2067 extern int acl_where;
2069 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2070 for (i = 0; i < nsub && sub[i+1]; i++)
2072 uschar * tmp = acl_arg[i];
2073 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2074 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2079 sub[i+1] = acl_arg[i];
2080 acl_arg[i++] = NULL;
2084 debug_printf("expanding: acl: %s arg: %s%s\n",
2086 acl_narg>0 ? acl_arg[0] : US"<none>",
2087 acl_narg>1 ? " +more" : "");
2089 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2091 for (i = 0; i < nsub; i++)
2092 acl_arg[i] = sub[i+1]; /* restore old args */
2093 acl_narg = sav_narg;
2101 /*************************************************
2102 * Read and evaluate a condition *
2103 *************************************************/
2107 s points to the start of the condition text
2108 resetok points to a BOOL which is written false if it is unsafe to
2109 free memory. Certain condition types (acl) may have side-effect
2110 allocation which must be preserved.
2111 yield points to a BOOL to hold the result of the condition test;
2112 if NULL, we are just reading through a condition that is
2113 part of an "or" combination to check syntax, or in a state
2114 where the answer isn't required
2116 Returns: a pointer to the first character after the condition, or
2120 static const uschar *
2121 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2123 BOOL testfor = TRUE;
2124 BOOL tempcond, combined_cond;
2126 BOOL sub2_honour_dollar = TRUE;
2127 int i, rc, cond_type, roffset;
2128 int_eximarith_t num[2];
2129 struct stat statbuf;
2131 const uschar *sub[10];
2134 const uschar *rerror;
2138 while (isspace(*s)) s++;
2139 if (*s == '!') { testfor = !testfor; s++; } else break;
2142 /* Numeric comparisons are symbolic */
2144 if (*s == '=' || *s == '>' || *s == '<')
2156 /* All other conditions are named */
2158 else s = read_name(name, 256, s, US"_");
2160 /* If we haven't read a name, it means some non-alpha character is first. */
2164 expand_string_message = string_sprintf("condition name expected, "
2165 "but found \"%.16s\"", s);
2169 /* Find which condition we are dealing with, and switch on it */
2171 cond_type = chop_match(name, cond_table, nelem(cond_table));
2174 /* def: tests for a non-empty variable, or for the existence of a header. If
2175 yield == NULL we are in a skipping state, and don't care about the answer. */
2180 expand_string_message = US"\":\" expected after \"def\"";
2184 s = read_name(name, 256, s+1, US"_");
2186 /* Test for a header's existence. If the name contains a closing brace
2187 character, this may be a user error where the terminating colon has been
2188 omitted. Set a flag to adjust a subsequent error message in this case. */
2190 if (Ustrncmp(name, "h_", 2) == 0 ||
2191 Ustrncmp(name, "rh_", 3) == 0 ||
2192 Ustrncmp(name, "bh_", 3) == 0 ||
2193 Ustrncmp(name, "header_", 7) == 0 ||
2194 Ustrncmp(name, "rheader_", 8) == 0 ||
2195 Ustrncmp(name, "bheader_", 8) == 0)
2197 s = read_header_name(name, 256, s);
2198 /* {-for-text-editors */
2199 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2200 if (yield != NULL) *yield =
2201 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2204 /* Test for a variable's having a non-empty value. A non-existent variable
2205 causes an expansion failure. */
2209 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2212 expand_string_message = (name[0] == 0)?
2213 string_sprintf("variable name omitted after \"def:\"") :
2214 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2215 check_variable_error_message(name);
2218 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2224 /* first_delivery tests for first delivery attempt */
2226 case ECOND_FIRST_DELIVERY:
2227 if (yield != NULL) *yield = deliver_firsttime == testfor;
2231 /* queue_running tests for any process started by a queue runner */
2233 case ECOND_QUEUE_RUNNING:
2234 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2238 /* exists: tests for file existence
2239 isip: tests for any IP address
2240 isip4: tests for an IPv4 address
2241 isip6: tests for an IPv6 address
2242 pam: does PAM authentication
2243 radius: does RADIUS authentication
2244 ldapauth: does LDAP authentication
2245 pwcheck: does Cyrus SASL pwcheck authentication
2254 case ECOND_LDAPAUTH:
2257 while (isspace(*s)) s++;
2258 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2260 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2261 if (sub[0] == NULL) return NULL;
2262 /* {-for-text-editors */
2263 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2265 if (yield == NULL) return s; /* No need to run the test if skipping */
2270 if ((expand_forbid & RDO_EXISTS) != 0)
2272 expand_string_message = US"File existence tests are not permitted";
2275 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2281 rc = string_is_ip_address(sub[0], NULL);
2282 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2283 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2286 /* Various authentication tests - all optionally compiled */
2290 rc = auth_call_pam(sub[0], &expand_string_message);
2293 goto COND_FAILED_NOT_COMPILED;
2294 #endif /* SUPPORT_PAM */
2297 #ifdef RADIUS_CONFIG_FILE
2298 rc = auth_call_radius(sub[0], &expand_string_message);
2301 goto COND_FAILED_NOT_COMPILED;
2302 #endif /* RADIUS_CONFIG_FILE */
2304 case ECOND_LDAPAUTH:
2307 /* Just to keep the interface the same */
2309 int old_pool = store_pool;
2310 store_pool = POOL_SEARCH;
2311 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2312 &expand_string_message, &do_cache);
2313 store_pool = old_pool;
2317 goto COND_FAILED_NOT_COMPILED;
2318 #endif /* LOOKUP_LDAP */
2321 #ifdef CYRUS_PWCHECK_SOCKET
2322 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2325 goto COND_FAILED_NOT_COMPILED;
2326 #endif /* CYRUS_PWCHECK_SOCKET */
2328 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2329 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2331 if (rc == ERROR || rc == DEFER) return NULL;
2332 *yield = (rc == OK) == testfor;
2338 /* call ACL (in a conditional context). Accept true, deny false.
2339 Defer is a forced-fail. Anything set by message= goes to $value.
2340 Up to ten parameters are used; we use the braces round the name+args
2341 like the saslauthd condition does, to permit a variable number of args.
2342 See also the expansion-item version EITEM_ACL and the traditional
2343 acl modifier ACLC_ACL.
2344 Since the ACL may allocate new global variables, tell our caller to not
2349 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2357 while (isspace(*s)) s++;
2358 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2360 switch(read_subs(sub, nelem(sub), 1,
2361 &s, yield == NULL, TRUE, US"acl", resetok))
2363 case 1: expand_string_message = US"too few arguments or bracketing "
2366 case 3: return NULL;
2369 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2370 if (yield != NULL) switch(eval_acl(sub, nelem(sub), &user_msg))
2375 lookup_value = NULL;
2378 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2379 lookup_value[ptr] = '\0';
2381 *yield = cond == testfor;
2385 expand_string_forcedfail = TRUE;
2388 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2395 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2397 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2399 However, the last two are optional. That is why the whole set is enclosed
2400 in their own set of braces. */
2402 case ECOND_SASLAUTHD:
2403 #ifndef CYRUS_SASLAUTHD_SOCKET
2404 goto COND_FAILED_NOT_COMPILED;
2408 while (isspace(*s)) s++;
2409 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2410 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2413 case 1: expand_string_message = US"too few arguments or bracketing "
2414 "error for saslauthd";
2416 case 3: return NULL;
2418 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2421 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2422 &expand_string_message);
2423 if (rc == ERROR || rc == DEFER) return NULL;
2424 *yield = (rc == OK) == testfor;
2428 #endif /* CYRUS_SASLAUTHD_SOCKET */
2431 /* symbolic operators for numeric and string comparison, and a number of
2432 other operators, all requiring two arguments.
2434 crypteq: encrypts plaintext and compares against an encrypted text,
2435 using crypt(), crypt16(), MD5 or SHA-1
2436 inlist/inlisti: checks if first argument is in the list of the second
2437 match: does a regular expression match and sets up the numerical
2438 variables if it succeeds
2439 match_address: matches in an address list
2440 match_domain: matches in a domain list
2441 match_ip: matches a host list that is restricted to IP addresses
2442 match_local_part: matches in a local part list
2445 case ECOND_MATCH_ADDRESS:
2446 case ECOND_MATCH_DOMAIN:
2447 case ECOND_MATCH_IP:
2448 case ECOND_MATCH_LOCAL_PART:
2449 #ifndef EXPAND_LISTMATCH_RHS
2450 sub2_honour_dollar = FALSE;
2459 case ECOND_NUM_L: /* Numerical comparisons */
2466 case ECOND_STR_LT: /* String comparisons */
2477 for (i = 0; i < 2; i++)
2479 /* Sometimes, we don't expand substrings; too many insecure configurations
2480 created using match_address{}{} and friends, where the second param
2481 includes information from untrustworthy sources. */
2482 BOOL honour_dollar = TRUE;
2483 if ((i > 0) && !sub2_honour_dollar)
2484 honour_dollar = FALSE;
2486 while (isspace(*s)) s++;
2489 if (i == 0) goto COND_FAILED_CURLY_START;
2490 expand_string_message = string_sprintf("missing 2nd string in {} "
2491 "after \"%s\"", name);
2494 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2495 honour_dollar, resetok);
2496 if (sub[i] == NULL) return NULL;
2497 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2499 /* Convert to numerical if required; we know that the names of all the
2500 conditions that compare numbers do not start with a letter. This just saves
2501 checking for them individually. */
2503 if (!isalpha(name[0]) && yield != NULL)
2509 debug_printf("empty string cast to zero for numerical comparison\n");
2513 num[i] = expanded_string_integer(sub[i], FALSE);
2514 if (expand_string_message != NULL) return NULL;
2519 /* Result not required */
2521 if (yield == NULL) return s;
2523 /* Do an appropriate comparison */
2529 tempcond = (num[0] == num[1]);
2533 tempcond = (num[0] > num[1]);
2537 tempcond = (num[0] >= num[1]);
2541 tempcond = (num[0] < num[1]);
2545 tempcond = (num[0] <= num[1]);
2549 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2553 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2557 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2561 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2565 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2569 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2573 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2577 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2581 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2585 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2588 case ECOND_MATCH: /* Regular expression match */
2589 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2593 expand_string_message = string_sprintf("regular expression error in "
2594 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2597 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2600 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2601 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2602 goto MATCHED_SOMETHING;
2604 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2605 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2606 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2607 goto MATCHED_SOMETHING;
2609 case ECOND_MATCH_IP: /* Match IP address in a host list */
2610 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2612 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2618 unsigned int *nullcache = NULL;
2619 check_host_block cb;
2621 cb.host_name = US"";
2622 cb.host_address = sub[0];
2624 /* If the host address starts off ::ffff: it is an IPv6 address in
2625 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2628 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2629 cb.host_address + 7 : cb.host_address;
2631 rc = match_check_list(
2632 &sub[1], /* the list */
2633 0, /* separator character */
2634 &hostlist_anchor, /* anchor pointer */
2635 &nullcache, /* cache pointer */
2636 check_host, /* function for testing */
2637 &cb, /* argument for function */
2638 MCL_HOST, /* type of check */
2639 sub[0], /* text for debugging */
2640 NULL); /* where to pass back data */
2642 goto MATCHED_SOMETHING;
2644 case ECOND_MATCH_LOCAL_PART:
2645 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2646 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2661 expand_string_message = string_sprintf("unable to complete match "
2662 "against \"%s\": %s", sub[1], search_error_message);
2668 /* Various "encrypted" comparisons. If the second string starts with
2669 "{" then an encryption type is given. Default to crypt() or crypt16()
2670 (build-time choice). */
2671 /* }-for-text-editors */
2674 #ifndef SUPPORT_CRYPTEQ
2675 goto COND_FAILED_NOT_COMPILED;
2677 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2679 int sublen = Ustrlen(sub[1]+5);
2684 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2686 /* If the length that we are comparing against is 24, the MD5 digest
2687 is expressed as a base64 string. This is the way LDAP does it. However,
2688 some other software uses a straightforward hex representation. We assume
2689 this if the length is 32. Other lengths fail. */
2693 uschar *coded = b64encode((uschar *)digest, 16);
2694 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2695 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2696 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2698 else if (sublen == 32)
2702 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2704 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2705 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2706 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2710 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2711 "fail\n crypted=%s\n", sub[1]+5);
2716 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2718 int sublen = Ustrlen(sub[1]+6);
2723 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2725 /* If the length that we are comparing against is 28, assume the SHA1
2726 digest is expressed as a base64 string. If the length is 40, assume a
2727 straightforward hex representation. Other lengths fail. */
2731 uschar *coded = b64encode((uschar *)digest, 20);
2732 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2733 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2734 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2736 else if (sublen == 40)
2740 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2742 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2743 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2744 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2748 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2749 "fail\n crypted=%s\n", sub[1]+6);
2754 else /* {crypt} or {crypt16} and non-{ at start */
2755 /* }-for-text-editors */
2760 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2765 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2770 else if (sub[1][0] == '{') /* }-for-text-editors */
2772 expand_string_message = string_sprintf("unknown encryption mechanism "
2773 "in \"%s\"", sub[1]);
2779 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2780 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2781 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2785 #define XSTR(s) STR(s)
2786 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2787 " subject=%s\n crypted=%s\n",
2788 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2793 /* If the encrypted string contains fewer than two characters (for the
2794 salt), force failure. Otherwise we get false positives: with an empty
2795 string the yield of crypt() is an empty string! */
2798 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2799 else if (errno == EINVAL)
2803 expand_string_message = string_sprintf("crypt error: %s\n",
2804 US strerror(errno));
2809 #endif /* SUPPORT_CRYPTEQ */
2814 const uschar * list = sub[1];
2816 uschar *save_iterate_item = iterate_item;
2817 int (*compare)(const uschar *, const uschar *);
2819 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2822 compare = cond_type == ECOND_INLISTI
2823 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2825 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2826 if (compare(sub[0], iterate_item) == 0)
2831 iterate_item = save_iterate_item;
2834 } /* Switch for comparison conditions */
2836 *yield = tempcond == testfor;
2837 return s; /* End of comparison conditions */
2840 /* and/or: computes logical and/or of several conditions */
2844 subcondptr = (yield == NULL)? NULL : &tempcond;
2845 combined_cond = (cond_type == ECOND_AND);
2847 while (isspace(*s)) s++;
2848 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2852 while (isspace(*s)) s++;
2853 /* {-for-text-editors */
2854 if (*s == '}') break;
2855 if (*s != '{') /* }-for-text-editors */
2857 expand_string_message = string_sprintf("each subcondition "
2858 "inside an \"%s{...}\" condition must be in its own {}", name);
2862 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2864 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2865 expand_string_message, name);
2868 while (isspace(*s)) s++;
2870 /* {-for-text-editors */
2873 /* {-for-text-editors */
2874 expand_string_message = string_sprintf("missing } at end of condition "
2875 "inside \"%s\" group", name);
2881 if (cond_type == ECOND_AND)
2883 combined_cond &= tempcond;
2884 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2885 } /* evaluate any more */
2888 combined_cond |= tempcond;
2889 if (combined_cond) subcondptr = NULL; /* once true, don't */
2890 } /* evaluate any more */
2894 if (yield != NULL) *yield = (combined_cond == testfor);
2898 /* forall/forany: iterates a condition with different values */
2903 const uschar * list;
2905 uschar *save_iterate_item = iterate_item;
2907 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2909 while (isspace(*s)) s++;
2910 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2911 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2912 if (sub[0] == NULL) return NULL;
2913 /* {-for-text-editors */
2914 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2916 while (isspace(*s)) s++;
2917 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2921 /* Call eval_condition once, with result discarded (as if scanning a
2922 "false" part). This allows us to find the end of the condition, because if
2923 the list it empty, we won't actually evaluate the condition for real. */
2925 if (!(s = eval_condition(sub[1], resetok, NULL)))
2927 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2928 expand_string_message, name);
2931 while (isspace(*s)) s++;
2933 /* {-for-text-editors */
2936 /* {-for-text-editors */
2937 expand_string_message = string_sprintf("missing } at end of condition "
2938 "inside \"%s\"", name);
2942 if (yield != NULL) *yield = !testfor;
2944 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2946 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2947 if (!eval_condition(sub[1], resetok, &tempcond))
2949 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2950 expand_string_message, name);
2951 iterate_item = save_iterate_item;
2954 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2955 tempcond? "true":"false");
2957 if (yield != NULL) *yield = (tempcond == testfor);
2958 if (tempcond == (cond_type == ECOND_FORANY)) break;
2961 iterate_item = save_iterate_item;
2966 /* The bool{} expansion condition maps a string to boolean.
2967 The values supported should match those supported by the ACL condition
2968 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2969 of true/false. Note that Router "condition" rules have a different
2970 interpretation, where general data can be used and only a few values
2972 Note that readconf.c boolean matching, for boolean configuration options,
2973 only matches true/yes/false/no.
2974 The bool_lax{} condition matches the Router logic, which is much more
2977 case ECOND_BOOL_LAX:
2983 BOOL boolvalue = FALSE;
2984 while (isspace(*s)) s++;
2985 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2986 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2987 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2989 case 1: expand_string_message = string_sprintf(
2990 "too few arguments or bracketing error for %s",
2994 case 3: return NULL;
2997 while (isspace(*t)) t++;
3001 /* trailing whitespace: seems like a good idea to ignore it too */
3003 while (isspace(*t2)) t2--;
3004 if (t2 != (t + len))
3011 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
3012 /* logic for the lax case from expand_check_condition(), which also does
3013 expands, and the logic is both short and stable enough that there should
3014 be no maintenance burden from replicating it. */
3018 ? Ustrspn(t+1, "0123456789") == len-1
3019 : Ustrspn(t, "0123456789") == len)
3021 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3022 /* expand_check_condition only does a literal string "0" check */
3023 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3026 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3028 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3030 else if (cond_type == ECOND_BOOL_LAX)
3034 expand_string_message = string_sprintf("unrecognised boolean "
3038 if (yield != NULL) *yield = (boolvalue == testfor);
3042 /* Unknown condition */
3045 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3047 } /* End switch on condition type */
3049 /* Missing braces at start and end of data */
3051 COND_FAILED_CURLY_START:
3052 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3055 COND_FAILED_CURLY_END:
3056 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3060 /* A condition requires code that is not compiled */
3062 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3063 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3064 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3065 COND_FAILED_NOT_COMPILED:
3066 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3075 /*************************************************
3076 * Save numerical variables *
3077 *************************************************/
3079 /* This function is called from items such as "if" that want to preserve and
3080 restore the numbered variables.
3083 save_expand_string points to an array of pointers to set
3084 save_expand_nlength points to an array of ints for the lengths
3086 Returns: the value of expand max to save
3090 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3093 for (i = 0; i <= expand_nmax; i++)
3095 save_expand_nstring[i] = expand_nstring[i];
3096 save_expand_nlength[i] = expand_nlength[i];
3103 /*************************************************
3104 * Restore numerical variables *
3105 *************************************************/
3107 /* This function restored saved values of numerical strings.
3110 save_expand_nmax the number of strings to restore
3111 save_expand_string points to an array of pointers
3112 save_expand_nlength points to an array of ints
3118 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3119 int *save_expand_nlength)
3122 expand_nmax = save_expand_nmax;
3123 for (i = 0; i <= expand_nmax; i++)
3125 expand_nstring[i] = save_expand_nstring[i];
3126 expand_nlength[i] = save_expand_nlength[i];
3134 /*************************************************
3135 * Handle yes/no substrings *
3136 *************************************************/
3138 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3139 alternative substrings that depend on whether or not the condition was true,
3140 or the lookup or extraction succeeded. The substrings always have to be
3141 expanded, to check their syntax, but "skipping" is set when the result is not
3142 needed - this avoids unnecessary nested lookups.
3145 skipping TRUE if we were skipping when this item was reached
3146 yes TRUE if the first string is to be used, else use the second
3147 save_lookup a value to put back into lookup_value before the 2nd expansion
3148 sptr points to the input string pointer
3149 yieldptr points to the output string pointer
3150 sizeptr points to the output string size
3151 ptrptr points to the output string pointer
3152 type "lookup", "if", "extract", "run", "env", "listextract" or
3153 "certextract" for error message
3154 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3157 Returns: 0 OK; lookup_value has been reset to save_lookup
3159 2 expansion failed because of bracketing error
3163 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3164 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3167 const uschar *s = *sptr; /* Local value */
3168 uschar *sub1, *sub2;
3170 /* If there are no following strings, we substitute the contents of $value for
3171 lookups and for extractions in the success case. For the ${if item, the string
3172 "true" is substituted. In the fail case, nothing is substituted for all three
3175 while (isspace(*s)) s++;
3180 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3184 if (yes && lookup_value)
3185 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3186 Ustrlen(lookup_value));
3187 lookup_value = save_lookup;
3193 /* The first following string must be braced. */
3195 if (*s++ != '{') goto FAILED_CURLY;
3197 /* Expand the first substring. Forced failures are noticed only if we actually
3198 want this string. Set skipping in the call in the fail case (this will always
3199 be the case if we were already skipping). */
3201 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3202 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3203 expand_string_forcedfail = FALSE;
3204 if (*s++ != '}') goto FAILED_CURLY;
3206 /* If we want the first string, add it to the output */
3209 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3211 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3212 $value to what it was at the start of the item, so that it has this value
3213 during the second string expansion. For the call from "if" or "run" to this
3214 function, save_lookup is set to lookup_value, so that this statement does
3217 lookup_value = save_lookup;
3219 /* There now follows either another substring, or "fail", or nothing. This
3220 time, forced failures are noticed only if we want the second string. We must
3221 set skipping in the nested call if we don't want this string, or if we were
3222 already skipping. */
3224 while (isspace(*s)) s++;
3227 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3228 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3229 expand_string_forcedfail = FALSE;
3230 if (*s++ != '}') goto FAILED_CURLY;
3232 /* If we want the second string, add it to the output */
3235 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3238 /* If there is no second string, but the word "fail" is present when the use of
3239 the second string is wanted, set a flag indicating it was a forced failure
3240 rather than a syntactic error. Swallow the terminating } in case this is nested
3241 inside another lookup or if or extract. */
3246 /* deconst cast ok here as source is s anyway */
3247 s = US read_name(name, sizeof(name), s, US"_");
3248 if (Ustrcmp(name, "fail") == 0)
3250 if (!yes && !skipping)
3252 while (isspace(*s)) s++;
3253 if (*s++ != '}') goto FAILED_CURLY;
3254 expand_string_message =
3255 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3256 expand_string_forcedfail = TRUE;
3262 expand_string_message =
3263 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3268 /* All we have to do now is to check on the final closing brace. */
3270 while (isspace(*s)) s++;
3271 if (*s++ == '}') goto RETURN;
3273 /* Get here if there is a bracketing failure */
3278 /* Get here for other failures */
3283 /* Update the input pointer value before returning */
3293 /*************************************************
3294 * Handle MD5 or SHA-1 computation for HMAC *
3295 *************************************************/
3297 /* These are some wrapping functions that enable the HMAC code to be a bit
3298 cleaner. A good compiler will spot the tail recursion.
3301 type HMAC_MD5 or HMAC_SHA1
3302 remaining are as for the cryptographic hash functions
3308 chash_start(int type, void *base)
3310 if (type == HMAC_MD5)
3311 md5_start((md5 *)base);
3313 sha1_start((sha1 *)base);
3317 chash_mid(int type, void *base, uschar *string)
3319 if (type == HMAC_MD5)
3320 md5_mid((md5 *)base, string);
3322 sha1_mid((sha1 *)base, string);
3326 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3328 if (type == HMAC_MD5)
3329 md5_end((md5 *)base, string, length, digest);
3331 sha1_end((sha1 *)base, string, length, digest);
3338 /********************************************************
3339 * prvs: Get last three digits of days since Jan 1, 1970 *
3340 ********************************************************/
3342 /* This is needed to implement the "prvs" BATV reverse
3345 Argument: integer "days" offset to add or substract to
3346 or from the current number of days.
3348 Returns: pointer to string containing the last three
3349 digits of the number of days since Jan 1, 1970,
3350 modified by the offset argument, NULL if there
3351 was an error in the conversion.
3356 prvs_daystamp(int day_offset)
3358 uschar *days = store_get(32); /* Need at least 24 for cases */
3359 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3360 (time(NULL) + day_offset*86400)/86400);
3361 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3366 /********************************************************
3367 * prvs: perform HMAC-SHA1 computation of prvs bits *
3368 ********************************************************/
3370 /* This is needed to implement the "prvs" BATV reverse
3374 address RFC2821 Address to use
3375 key The key to use (must be less than 64 characters
3377 key_num Single-digit key number to use. Defaults to
3380 Returns: pointer to string containing the first three
3381 bytes of the final hash in hex format, NULL if
3382 there was an error in the process.
3386 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3388 uschar *hash_source, *p;
3389 int size = 0,offset = 0,i;
3391 void *use_base = &sha1_base;
3392 uschar innerhash[20];
3393 uschar finalhash[20];
3394 uschar innerkey[64];
3395 uschar outerkey[64];
3396 uschar *finalhash_hex = store_get(40);
3398 if (key_num == NULL)
3401 if (Ustrlen(key) > 64)
3404 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3405 hash_source = string_cat(hash_source,&size,&offset,daystamp,3);
3406 hash_source = string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3407 hash_source[offset] = '\0';
3409 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3411 memset(innerkey, 0x36, 64);
3412 memset(outerkey, 0x5c, 64);
3414 for (i = 0; i < Ustrlen(key); i++)
3416 innerkey[i] ^= key[i];
3417 outerkey[i] ^= key[i];
3420 chash_start(HMAC_SHA1, use_base);
3421 chash_mid(HMAC_SHA1, use_base, innerkey);
3422 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3424 chash_start(HMAC_SHA1, use_base);
3425 chash_mid(HMAC_SHA1, use_base, outerkey);
3426 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3429 for (i = 0; i < 3; i++)
3431 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3432 *p++ = hex_digits[finalhash[i] & 0x0f];
3436 return finalhash_hex;
3442 /*************************************************
3443 * Join a file onto the output string *
3444 *************************************************/
3446 /* This is used for readfile/readsock and after a run expansion.
3447 It joins the contents of a file onto the output string, globally replacing
3448 newlines with a given string (optionally).
3452 yield pointer to the expandable string
3453 sizep pointer to the current size
3454 ptrp pointer to the current position
3455 eol newline replacement string, or NULL
3457 Returns: new value of string pointer
3461 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3463 int eollen = eol ? Ustrlen(eol) : 0;
3464 uschar buffer[1024];
3466 while (Ufgets(buffer, sizeof(buffer), f))
3468 int len = Ustrlen(buffer);
3469 if (eol && buffer[len-1] == '\n') len--;
3470 yield = string_cat(yield, sizep, ptrp, buffer, len);
3471 if (buffer[len] != 0)
3472 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3475 if (yield) yield[*ptrp] = 0;
3483 /*************************************************
3484 * Evaluate numeric expression *
3485 *************************************************/
3487 /* This is a set of mutually recursive functions that evaluate an arithmetic
3488 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3489 these functions that is called from elsewhere is eval_expr, whose interface is:
3492 sptr pointer to the pointer to the string - gets updated
3493 decimal TRUE if numbers are to be assumed decimal
3494 error pointer to where to put an error message - must be NULL on input
3495 endket TRUE if ')' must terminate - FALSE for external call
3497 Returns: on success: the value of the expression, with *error still NULL
3498 on failure: an undefined value, with *error = a message
3501 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3504 static int_eximarith_t
3505 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3508 int_eximarith_t x = eval_op_or(&s, decimal, error);
3514 *error = US"expecting closing parenthesis";
3516 while (isspace(*(++s)));
3518 else if (*s != 0) *error = US"expecting operator";
3525 static int_eximarith_t
3526 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3531 while (isspace(*s)) s++;
3536 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3538 switch (tolower(*s))
3541 case 'k': n *= 1024; s++; break;
3542 case 'm': n *= 1024*1024; s++; break;
3543 case 'g': n *= 1024*1024*1024; s++; break;
3545 while (isspace (*s)) s++;
3550 n = eval_expr(&s, decimal, error, 1);
3554 *error = US"expecting number or opening parenthesis";
3562 static int_eximarith_t
3563 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3567 while (isspace(*s)) s++;
3568 if (*s == '+' || *s == '-' || *s == '~')
3571 x = eval_op_unary(&s, decimal, error);
3572 if (op == '-') x = -x;
3573 else if (op == '~') x = ~x;
3577 x = eval_number(&s, decimal, error);
3584 static int_eximarith_t
3585 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3588 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3591 while (*s == '*' || *s == '/' || *s == '%')
3594 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3595 if (*error != NULL) break;
3596 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3597 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3598 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3599 * -N*M is INT_MIN will yielf INT_MIN.
3600 * Since we don't support floating point, this is somewhat simpler.
3601 * Ideally, we'd return an error, but since we overflow for all other
3602 * arithmetic, consistency suggests otherwise, but what's the correct value
3603 * to use? There is none.
3604 * The C standard guarantees overflow for unsigned arithmetic but signed
3605 * overflow invokes undefined behaviour; in practice, this is overflow
3606 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3607 * that long/longlong larger than int are available, or we could just work
3608 * with larger types. We should consider whether to guarantee 32bit eval
3609 * and 64-bit working variables, with errors returned. For now ...
3610 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3611 * can just let the other invalid results occur otherwise, as they have
3612 * until now. For this one case, we can coerce.
3614 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3617 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3618 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3628 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3644 static int_eximarith_t
3645 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3648 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3651 while (*s == '+' || *s == '-')
3654 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3656 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3657 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3658 { /* over-conservative check */
3660 ? US"overflow in sum" : US"overflow in difference";
3663 if (op == '+') x += y; else x -= y;
3671 static int_eximarith_t
3672 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3675 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3678 while ((*s == '<' || *s == '>') && s[1] == s[0])
3683 y = eval_op_sum(&s, decimal, error);
3684 if (*error != NULL) break;
3685 if (op == '<') x <<= y; else x >>= y;
3693 static int_eximarith_t
3694 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3697 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3704 y = eval_op_shift(&s, decimal, error);
3705 if (*error != NULL) break;
3714 static int_eximarith_t
3715 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3718 int_eximarith_t x = eval_op_and(&s, decimal, error);
3725 y = eval_op_and(&s, decimal, error);
3726 if (*error != NULL) break;
3735 static int_eximarith_t
3736 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3739 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3746 y = eval_op_xor(&s, decimal, error);
3747 if (*error != NULL) break;
3757 /*************************************************
3759 *************************************************/
3761 /* Returns either an unchanged string, or the expanded string in stacking pool
3762 store. Interpreted sequences are:
3764 \... normal escaping rules
3765 $name substitutes the variable
3767 ${op:string} operates on the expanded string value
3768 ${item{arg1}{arg2}...} expands the args and then does the business
3769 some literal args are not enclosed in {}
3771 There are now far too many operators and item types to make it worth listing
3772 them here in detail any more.
3774 We use an internal routine recursively to handle embedded substrings. The
3775 external function follows. The yield is NULL if the expansion failed, and there
3776 are two cases: if something collapsed syntactically, or if "fail" was given
3777 as the action on a lookup failure. These can be distinguised by looking at the
3778 variable expand_string_forcedfail, which is TRUE in the latter case.
3780 The skipping flag is set true when expanding a substring that isn't actually
3781 going to be used (after "if" or "lookup") and it prevents lookups from
3782 happening lower down.
3784 Store usage: At start, a store block of the length of the input plus 64
3785 is obtained. This is expanded as necessary by string_cat(), which might have to
3786 get a new block, or might be able to expand the original. At the end of the
3787 function we can release any store above that portion of the yield block that
3788 was actually used. In many cases this will be optimal.
3790 However: if the first item in the expansion is a variable name or header name,
3791 we reset the store before processing it; if the result is in fresh store, we
3792 use that without copying. This is helpful for expanding strings like
3793 $message_headers which can get very long.
3795 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3796 since resetting the store at the end of the expansion will free store that was
3797 allocated by the plugin code as well as the slop after the expanded string. So
3798 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3799 and, given the acl condition, ${if }. This is an unfortunate consequence of
3800 string expansion becoming too powerful.
3803 string the string to be expanded
3804 ket_ends true if expansion is to stop at }
3805 left if not NULL, a pointer to the first character after the
3806 expansion is placed here (typically used with ket_ends)
3807 skipping TRUE for recursive calls when the value isn't actually going
3808 to be used (to allow for optimisation)
3809 honour_dollar TRUE if $ is to be expanded,
3810 FALSE if it's just another character
3811 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3814 Returns: NULL if expansion fails:
3815 expand_string_forcedfail is set TRUE if failure was forced
3816 expand_string_message contains a textual error message
3817 a pointer to the expanded string on success
3821 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3822 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3825 int size = Ustrlen(string)+ 64;
3827 uschar *yield = store_get(size);
3828 const uschar *s = string;
3829 uschar *save_expand_nstring[EXPAND_MAXN+1];
3830 int save_expand_nlength[EXPAND_MAXN+1];
3831 BOOL resetok = TRUE;
3833 expand_string_forcedfail = FALSE;
3834 expand_string_message = US"";
3841 /* \ escapes the next character, which must exist, or else
3842 the expansion fails. There's a special escape, \N, which causes
3843 copying of the subject verbatim up to the next \N. Otherwise,
3844 the escapes are the standard set. */
3850 expand_string_message = US"\\ at end of string";
3856 const uschar * t = s + 2;
3857 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3858 yield = string_cat(yield, &size, &ptr, t, s - t);
3859 if (*s != 0) s += 2;
3865 ch[0] = string_interpret_escape(&s);
3867 yield = string_cat(yield, &size, &ptr, ch, 1);
3874 /* Anything other than $ is just copied verbatim, unless we are
3875 looking for a terminating } character. */
3878 if (ket_ends && *s == '}') break;
3880 if (*s != '$' || !honour_dollar)
3882 yield = string_cat(yield, &size, &ptr, s++, 1);
3886 /* No { after the $ - must be a plain name or a number for string
3887 match variable. There has to be a fudge for variables that are the
3888 names of header fields preceded by "$header_" because header field
3889 names can contain any printing characters except space and colon.
3890 For those that don't like typing this much, "$h_" is a synonym for
3891 "$header_". A non-existent header yields a NULL value; nothing is
3894 if (isalpha((*(++s))))
3899 s = read_name(name, sizeof(name), s, US"_");
3901 /* If this is the first thing to be expanded, release the pre-allocated
3904 if (ptr == 0 && yield != NULL)
3906 if (resetok) store_reset(yield);
3913 if (Ustrncmp(name, "h_", 2) == 0 ||
3914 Ustrncmp(name, "rh_", 3) == 0 ||
3915 Ustrncmp(name, "bh_", 3) == 0 ||
3916 Ustrncmp(name, "header_", 7) == 0 ||
3917 Ustrncmp(name, "rheader_", 8) == 0 ||
3918 Ustrncmp(name, "bheader_", 8) == 0)
3920 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3921 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3922 s = read_header_name(name, sizeof(name), s);
3923 value = find_header(name, FALSE, &newsize, want_raw, charset);
3925 /* If we didn't find the header, and the header contains a closing brace
3926 character, this may be a user error where the terminating colon
3927 has been omitted. Set a flag to adjust the error message in this case.
3928 But there is no error here - nothing gets inserted. */
3932 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3939 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
3941 expand_string_message =
3942 string_sprintf("unknown variable name \"%s\"", name);
3943 check_variable_error_message(name);
3947 /* If the data is known to be in a new buffer, newsize will be set to the
3948 size of that buffer. If this is the first thing in an expansion string,
3949 yield will be NULL; just point it at the new store instead of copying. Many
3950 expansion strings contain just one reference, so this is a useful
3951 optimization, especially for humungous headers. */
3953 len = Ustrlen(value);
3954 if (yield == NULL && newsize != 0)
3960 else yield = string_cat(yield, &size, &ptr, value, len);
3968 s = read_cnumber(&n, s);
3969 if (n >= 0 && n <= expand_nmax)
3970 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3975 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3977 if (*s != '{') /*}*/
3979 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3983 /* After { there can be various things, but they all start with
3984 an initial word, except for a number for a string match variable. */
3986 if (isdigit((*(++s))))
3989 s = read_cnumber(&n, s); /*{*/
3992 expand_string_message = US"} expected after number";
3995 if (n >= 0 && n <= expand_nmax)
3996 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
4003 expand_string_message = US"letter or digit expected after ${"; /*}*/
4007 /* Allow "-" in names to cater for substrings with negative
4008 arguments. Since we are checking for known names after { this is
4011 s = read_name(name, sizeof(name), s, US"_-");
4012 item_type = chop_match(name, item_table, nelem(item_table));
4016 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4017 If the ACL returns accept or reject we return content set by "message ="
4018 There is currently no limit on recursion; this would have us call
4019 acl_check_internal() directly and get a current level from somewhere.
4020 See also the acl expansion condition ECOND_ACL and the traditional
4021 acl modifier ACLC_ACL.
4022 Assume that the function has side-effects on the store that must be preserved.
4026 /* ${acl {name} {arg1}{arg2}...} */
4028 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4031 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4034 case 1: goto EXPAND_FAILED_CURLY;
4036 case 3: goto EXPAND_FAILED;
4038 if (skipping) continue;
4041 switch(eval_acl(sub, nelem(sub), &user_msg))
4046 debug_printf("acl expansion yield: %s\n", user_msg);
4048 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
4052 expand_string_forcedfail = TRUE;
4055 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4060 /* Handle conditionals - preserve the values of the numerical expansion
4061 variables in case they get changed by a regular expression match in the
4062 condition. If not, they retain their external settings. At the end
4063 of this "if" section, they get restored to their previous values. */
4068 const uschar *next_s;
4069 int save_expand_nmax =
4070 save_expand_strings(save_expand_nstring, save_expand_nlength);
4072 while (isspace(*s)) s++;
4073 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
4074 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4077 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
4078 cond? "true" : "false");
4082 /* The handling of "yes" and "no" result strings is now in a separate
4083 function that is also used by ${lookup} and ${extract} and ${run}. */
4085 switch(process_yesno(
4086 skipping, /* were previously skipping */
4087 cond, /* success/failure indicator */
4088 lookup_value, /* value to reset for string2 */
4089 &s, /* input pointer */
4090 &yield, /* output pointer */
4091 &size, /* output size */
4092 &ptr, /* output current point */
4093 US"if", /* condition type */
4096 case 1: goto EXPAND_FAILED; /* when all is well, the */
4097 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4100 /* Restore external setting of expansion variables for continuation
4103 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4104 save_expand_nlength);
4109 case EITEM_IMAPFOLDER:
4110 { /* ${imapfolder {name}{sep]{specials}} */
4114 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4117 case 1: goto EXPAND_FAILED_CURLY;
4119 case 3: goto EXPAND_FAILED;
4122 if (sub_arg[1] == NULL) /* One argument */
4124 sub_arg[1] = US"/"; /* default separator */
4127 else if (Ustrlen(sub_arg[1]) != 1)
4129 expand_string_message =
4131 "IMAP folder separator must be one character, found \"%s\"",
4136 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4137 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4140 yield = string_cat(yield, &size, &ptr, encoded, Ustrlen(encoded));
4145 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4146 expanding an internal string that isn't actually going to be used. All we
4147 need to do is check the syntax, so don't do a lookup at all. Preserve the
4148 values of the numerical expansion variables in case they get changed by a
4149 partial lookup. If not, they retain their external settings. At the end
4150 of this "lookup" section, they get restored to their previous values. */
4154 int stype, partial, affixlen, starflags;
4155 int expand_setup = 0;
4157 uschar *key, *filename;
4158 const uschar *affix;
4159 uschar *save_lookup_value = lookup_value;
4160 int save_expand_nmax =
4161 save_expand_strings(save_expand_nstring, save_expand_nlength);
4163 if ((expand_forbid & RDO_LOOKUP) != 0)
4165 expand_string_message = US"lookup expansions are not permitted";
4169 /* Get the key we are to look up for single-key+file style lookups.
4170 Otherwise set the key NULL pro-tem. */
4172 while (isspace(*s)) s++;
4173 if (*s == '{') /*}*/
4175 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4176 if (key == NULL) goto EXPAND_FAILED; /*{*/
4177 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4178 while (isspace(*s)) s++;
4182 /* Find out the type of database */
4186 expand_string_message = US"missing lookup type";
4190 /* The type is a string that may contain special characters of various
4191 kinds. Allow everything except space or { to appear; the actual content
4192 is checked by search_findtype_partial. */ /*}*/
4194 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4196 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4200 while (isspace(*s)) s++;
4202 /* Now check for the individual search type and any partial or default
4203 options. Only those types that are actually in the binary are valid. */
4205 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4209 expand_string_message = search_error_message;
4213 /* Check that a key was provided for those lookup types that need it,
4214 and was not supplied for those that use the query style. */
4216 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4220 expand_string_message = string_sprintf("missing {key} for single-"
4221 "key \"%s\" lookup", name);
4229 expand_string_message = string_sprintf("a single key was given for "
4230 "lookup type \"%s\", which is not a single-key lookup type", name);
4235 /* Get the next string in brackets and expand it. It is the file name for
4236 single-key+file lookups, and the whole query otherwise. In the case of
4237 queries that also require a file name (e.g. sqlite), the file name comes
4240 if (*s != '{') goto EXPAND_FAILED_CURLY;
4241 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4242 if (filename == NULL) goto EXPAND_FAILED;
4243 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4244 while (isspace(*s)) s++;
4246 /* If this isn't a single-key+file lookup, re-arrange the variables
4247 to be appropriate for the search_ functions. For query-style lookups,
4248 there is just a "key", and no file name. For the special query-style +
4249 file types, the query (i.e. "key") starts with a file name. */
4253 while (isspace(*filename)) filename++;
4256 if (mac_islookup(stype, lookup_querystyle))
4262 if (*filename != '/')
4264 expand_string_message = string_sprintf(
4265 "absolute file name expected for \"%s\" lookup", name);
4268 while (*key != 0 && !isspace(*key)) key++;
4269 if (*key != 0) *key++ = 0;
4273 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4274 the entry was not found. Note that there is no search_close() function.
4275 Files are left open in case of re-use. At suitable places in higher logic,
4276 search_tidyup() is called to tidy all open files. This can save opening
4277 the same file several times. However, files may also get closed when
4278 others are opened, if too many are open at once. The rule is that a
4279 handle should not be used after a second search_open().
4281 Request that a partial search sets up $1 and maybe $2 by passing
4282 expand_setup containing zero. If its value changes, reset expand_nmax,
4283 since new variables will have been set. Note that at the end of this
4284 "lookup" section, the old numeric variables are restored. */
4287 lookup_value = NULL;
4290 void *handle = search_open(filename, stype, 0, NULL, NULL);
4293 expand_string_message = search_error_message;
4296 lookup_value = search_find(handle, filename, key, partial, affix,
4297 affixlen, starflags, &expand_setup);
4298 if (search_find_defer)
4300 expand_string_message =
4301 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4302 string_printing2(key, FALSE), search_error_message);
4305 if (expand_setup > 0) expand_nmax = expand_setup;
4308 /* The handling of "yes" and "no" result strings is now in a separate
4309 function that is also used by ${if} and ${extract}. */
4311 switch(process_yesno(
4312 skipping, /* were previously skipping */
4313 lookup_value != NULL, /* success/failure indicator */
4314 save_lookup_value, /* value to reset for string2 */
4315 &s, /* input pointer */
4316 &yield, /* output pointer */
4317 &size, /* output size */
4318 &ptr, /* output current point */
4319 US"lookup", /* condition type */
4322 case 1: goto EXPAND_FAILED; /* when all is well, the */
4323 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4326 /* Restore external setting of expansion variables for carrying on
4327 at this level, and continue. */
4329 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4330 save_expand_nlength);
4334 /* If Perl support is configured, handle calling embedded perl subroutines,
4335 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4336 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4337 arguments (defined below). */
4339 #define EXIM_PERL_MAX_ARGS 8
4343 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4344 "is not included in this binary";
4347 #else /* EXIM_PERL */
4349 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4352 if ((expand_forbid & RDO_PERL) != 0)
4354 expand_string_message = US"Perl calls are not permitted";
4358 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4359 US"perl", &resetok))
4361 case 1: goto EXPAND_FAILED_CURLY;
4363 case 3: goto EXPAND_FAILED;
4366 /* If skipping, we don't actually do anything */
4368 if (skipping) continue;
4370 /* Start the interpreter if necessary */
4372 if (!opt_perl_started)
4375 if (opt_perl_startup == NULL)
4377 expand_string_message = US"A setting of perl_startup is needed when "
4378 "using the Perl interpreter";
4381 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4382 initerror = init_perl(opt_perl_startup);
4383 if (initerror != NULL)
4385 expand_string_message =
4386 string_sprintf("error in perl_startup code: %s\n", initerror);
4389 opt_perl_started = TRUE;
4392 /* Call the function */
4394 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4395 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4396 sub_arg[0], sub_arg + 1);
4398 /* NULL yield indicates failure; if the message pointer has been set to
4399 NULL, the yield was undef, indicating a forced failure. Otherwise the
4400 message will indicate some kind of Perl error. */
4402 if (new_yield == NULL)
4404 if (expand_string_message == NULL)
4406 expand_string_message =
4407 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4408 "failure", sub_arg[0]);
4409 expand_string_forcedfail = TRUE;
4414 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4415 set during a callback from Perl. */
4417 expand_string_forcedfail = FALSE;
4421 #endif /* EXIM_PERL */
4423 /* Transform email address to "prvs" scheme to use
4424 as BATV-signed return path */
4431 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4433 case 1: goto EXPAND_FAILED_CURLY;
4435 case 3: goto EXPAND_FAILED;
4438 /* If skipping, we don't actually do anything */
4439 if (skipping) continue;
4441 /* sub_arg[0] is the address */
4442 domain = Ustrrchr(sub_arg[0],'@');
4443 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4445 expand_string_message = US"prvs first argument must be a qualified email address";
4449 /* Calculate the hash. The second argument must be a single-digit
4450 key number, or unset. */
4452 if (sub_arg[2] != NULL &&
4453 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4455 expand_string_message = US"prvs second argument must be a single digit";
4459 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4462 expand_string_message = US"prvs hmac-sha1 conversion failed";
4466 /* Now separate the domain from the local part */
4469 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4470 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4471 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4472 string_cat(yield,&size,&ptr,p,6);
4473 string_cat(yield,&size,&ptr,US"=",1);
4474 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4475 string_cat(yield,&size,&ptr,US"@",1);
4476 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4481 /* Check a prvs-encoded address for validity */
4483 case EITEM_PRVSCHECK:
4486 int mysize = 0, myptr = 0;
4490 /* TF: Ugliness: We want to expand parameter 1 first, then set
4491 up expansion variables that are used in the expansion of
4492 parameter 2. So we clone the string for the first
4493 expansion, where we only expand parameter 1.
4495 PH: Actually, that isn't necessary. The read_subs() function is
4496 designed to work this way for the ${if and ${lookup expansions. I've
4500 /* Reset expansion variables */
4501 prvscheck_result = NULL;
4502 prvscheck_address = NULL;
4503 prvscheck_keynum = NULL;
4505 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4507 case 1: goto EXPAND_FAILED_CURLY;
4509 case 3: goto EXPAND_FAILED;
4512 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4515 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4517 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4518 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4519 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4520 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4521 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4523 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4524 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4525 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4526 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4527 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4529 /* Set up expansion variables */
4530 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4531 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4532 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4533 prvscheck_address[myptr] = '\0';
4534 prvscheck_keynum = string_copy(key_num);
4536 /* Now expand the second argument */
4537 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4539 case 1: goto EXPAND_FAILED_CURLY;
4541 case 3: goto EXPAND_FAILED;
4544 /* Now we have the key and can check the address. */
4546 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4551 expand_string_message = US"hmac-sha1 conversion failed";
4555 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4556 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4558 if (Ustrcmp(p,hash) == 0)
4560 /* Success, valid BATV address. Now check the expiry date. */
4561 uschar *now = prvs_daystamp(0);
4562 unsigned int inow = 0,iexpire = 1;
4564 (void)sscanf(CS now,"%u",&inow);
4565 (void)sscanf(CS daystamp,"%u",&iexpire);
4567 /* When "iexpire" is < 7, a "flip" has occured.
4568 Adjust "inow" accordingly. */
4569 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4571 if (iexpire >= inow)
4573 prvscheck_result = US"1";
4574 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4578 prvscheck_result = NULL;
4579 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4584 prvscheck_result = NULL;
4585 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4588 /* Now expand the final argument. We leave this till now so that
4589 it can include $prvscheck_result. */
4591 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4593 case 1: goto EXPAND_FAILED_CURLY;
4595 case 3: goto EXPAND_FAILED;
4598 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4599 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4601 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4603 /* Reset the "internal" variables afterwards, because they are in
4604 dynamic store that will be reclaimed if the expansion succeeded. */
4606 prvscheck_address = NULL;
4607 prvscheck_keynum = NULL;
4611 /* Does not look like a prvs encoded address, return the empty string.
4612 We need to make sure all subs are expanded first, so as to skip over
4615 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4617 case 1: goto EXPAND_FAILED_CURLY;
4619 case 3: goto EXPAND_FAILED;
4626 /* Handle "readfile" to insert an entire file */
4628 case EITEM_READFILE:
4633 if ((expand_forbid & RDO_READFILE) != 0)
4635 expand_string_message = US"file insertions are not permitted";
4639 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4641 case 1: goto EXPAND_FAILED_CURLY;
4643 case 3: goto EXPAND_FAILED;
4646 /* If skipping, we don't actually do anything */
4648 if (skipping) continue;
4650 /* Open the file and read it */
4652 f = Ufopen(sub_arg[0], "rb");
4655 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4659 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4664 /* Handle "readsocket" to insert data from a Unix domain socket */
4666 case EITEM_READSOCK:
4672 struct sockaddr_un sockun; /* don't call this "sun" ! */
4676 if ((expand_forbid & RDO_READSOCK) != 0)
4678 expand_string_message = US"socket insertions are not permitted";
4682 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4683 because there may be a string for expansion on failure. */
4685 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4687 case 1: goto EXPAND_FAILED_CURLY;
4688 case 2: /* Won't occur: no end check */
4689 case 3: goto EXPAND_FAILED;
4692 /* Sort out timeout, if given */
4694 if (sub_arg[2] != NULL)
4696 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4699 expand_string_message = string_sprintf("bad time value %s",
4704 else sub_arg[3] = NULL; /* No eol if no timeout */
4706 /* If skipping, we don't actually do anything. Otherwise, arrange to
4707 connect to either an IP or a Unix socket. */
4711 /* Handle an IP (internet) domain */
4713 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4716 uschar *server_name = sub_arg[0] + 5;
4717 uschar *port_name = Ustrrchr(server_name, ':');
4719 /* Sort out the port */
4721 if (port_name == NULL)
4723 expand_string_message =
4724 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4727 *port_name++ = 0; /* Terminate server name */
4729 if (isdigit(*port_name))
4732 port = Ustrtol(port_name, &end, 0);
4733 if (end != port_name + Ustrlen(port_name))
4735 expand_string_message =
4736 string_sprintf("invalid port number %s", port_name);
4742 struct servent *service_info = getservbyname(CS port_name, "tcp");
4743 if (service_info == NULL)
4745 expand_string_message = string_sprintf("unknown port \"%s\"",
4749 port = ntohs(service_info->s_port);
4752 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4753 timeout, NULL, &expand_string_message)) < 0)
4757 /* Handle a Unix domain socket */
4762 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4764 expand_string_message = string_sprintf("failed to create socket: %s",
4769 sockun.sun_family = AF_UNIX;
4770 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4773 sigalrm_seen = FALSE;
4775 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4779 expand_string_message = US "socket connect timed out";
4784 expand_string_message = string_sprintf("failed to connect to socket "
4785 "%s: %s", sub_arg[0], strerror(errno));
4790 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4792 /* Allow sequencing of test actions */
4793 if (running_in_test_harness) millisleep(100);
4795 /* Write the request string, if not empty */
4797 if (sub_arg[1][0] != 0)
4799 int len = Ustrlen(sub_arg[1]);
4800 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4802 if (write(fd, sub_arg[1], len) != len)
4804 expand_string_message = string_sprintf("request write to socket "
4805 "failed: %s", strerror(errno));
4810 /* Shut down the sending side of the socket. This helps some servers to
4811 recognise that it is their turn to do some work. Just in case some
4812 system doesn't have this function, make it conditional. */
4815 shutdown(fd, SHUT_WR);
4818 if (running_in_test_harness) millisleep(100);
4820 /* Now we need to read from the socket, under a timeout. The function
4821 that reads a file can be used. */
4823 f = fdopen(fd, "rb");
4824 sigalrm_seen = FALSE;
4826 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4830 /* After a timeout, we restore the pointer in the result, that is,
4831 make sure we add nothing from the socket. */
4836 expand_string_message = US "socket read timed out";
4841 /* The whole thing has worked (or we were skipping). If there is a
4842 failure string following, we need to skip it. */
4846 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4848 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4849 while (isspace(*s)) s++;
4851 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4854 /* Come here on failure to create socket, connect socket, write to the
4855 socket, or timeout on reading. If another substring follows, expand and
4856 use it. Otherwise, those conditions give expand errors. */
4859 if (*s != '{') goto EXPAND_FAILED;
4860 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4861 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4862 if (arg == NULL) goto EXPAND_FAILED;
4863 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4864 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4865 while (isspace(*s)) s++;
4866 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4870 /* Handle "run" to execute a program. */
4876 const uschar **argv;
4879 int lsize = 0, lptr = 0;
4881 if ((expand_forbid & RDO_RUN) != 0)
4883 expand_string_message = US"running a command is not permitted";
4887 while (isspace(*s)) s++;
4888 if (*s != '{') goto EXPAND_FAILED_CURLY;
4889 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4890 if (arg == NULL) goto EXPAND_FAILED;
4891 while (isspace(*s)) s++;
4892 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4894 if (skipping) /* Just pretend it worked when we're skipping */
4900 if (!transport_set_up_command(&argv, /* anchor for arg list */
4901 arg, /* raw command */
4902 FALSE, /* don't expand the arguments */
4903 0, /* not relevant when... */
4904 NULL, /* no transporting address */
4905 US"${run} expansion", /* for error messages */
4906 &expand_string_message)) /* where to put error message */
4909 /* Create the child process, making it a group leader. */
4911 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
4913 expand_string_message =
4914 string_sprintf("couldn't create child process: %s", strerror(errno));
4918 /* Nothing is written to the standard input. */
4922 /* Read the pipe to get the command's output into $value (which is kept
4923 in lookup_value). Read during execution, so that if the output exceeds
4924 the OS pipe buffer limit, we don't block forever. Remember to not release
4925 memory just allocated for $value. */
4928 f = fdopen(fd_out, "rb");
4929 sigalrm_seen = FALSE;
4931 lookup_value = cat_file(f, NULL, &lsize, &lptr, NULL);
4935 /* Wait for the process to finish, applying the timeout, and inspect its
4936 return code for serious disasters. Simple non-zero returns are passed on.
4939 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4941 if (sigalrm_seen == TRUE || runrc == -256)
4943 expand_string_message = string_sprintf("command timed out");
4944 killpg(pid, SIGKILL); /* Kill the whole process group */
4947 else if (runrc == -257)
4948 expand_string_message = string_sprintf("wait() failed: %s",
4952 expand_string_message = string_sprintf("command killed by signal %d",
4959 /* Process the yes/no strings; $value may be useful in both cases */
4961 switch(process_yesno(
4962 skipping, /* were previously skipping */
4963 runrc == 0, /* success/failure indicator */
4964 lookup_value, /* value to reset for string2 */
4965 &s, /* input pointer */
4966 &yield, /* output pointer */
4967 &size, /* output size */
4968 &ptr, /* output current point */
4969 US"run", /* condition type */
4972 case 1: goto EXPAND_FAILED; /* when all is well, the */
4973 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4979 /* Handle character translation for "tr" */
4987 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4989 case 1: goto EXPAND_FAILED_CURLY;
4991 case 3: goto EXPAND_FAILED;
4994 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4995 o2m = Ustrlen(sub[2]) - 1;
4997 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4999 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
5003 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
5010 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5011 expanded arguments. */
5021 int val[2] = { 0, -1 };
5024 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5025 Ensure that sub[2] is set in the ${length } case. */
5028 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5029 TRUE, name, &resetok))
5031 case 1: goto EXPAND_FAILED_CURLY;
5033 case 3: goto EXPAND_FAILED;
5036 /* Juggle the arguments if there are only two of them: always move the
5037 string to the last position and make ${length{n}{str}} equivalent to
5038 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5044 if (item_type == EITEM_LENGTH)
5051 for (i = 0; i < 2; i++)
5053 if (sub[i] == NULL) continue;
5054 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5055 if (*ret != 0 || (i != 0 && val[i] < 0))
5057 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5058 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5064 (item_type == EITEM_HASH)?
5065 compute_hash(sub[2], val[0], val[1], &len) :
5066 (item_type == EITEM_NHASH)?
5067 compute_nhash(sub[2], val[0], val[1], &len) :
5068 extract_substr(sub[2], val[0], val[1], &len);
5070 if (ret == NULL) goto EXPAND_FAILED;
5071 yield = string_cat(yield, &size, &ptr, ret, len);
5075 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5076 This code originally contributed by Steve Haslam. It currently supports
5077 the use of MD5 and SHA-1 hashes.
5079 We need some workspace that is large enough to handle all the supported
5080 hash types. Use macros to set the sizes rather than be too elaborate. */
5082 #define MAX_HASHLEN 20
5083 #define MAX_HASHBLOCKLEN 64
5092 int hashlen; /* Number of octets for the hash algorithm's output */
5093 int hashblocklen; /* Number of octets the hash algorithm processes */
5095 unsigned int keylen;
5097 uschar keyhash[MAX_HASHLEN];
5098 uschar innerhash[MAX_HASHLEN];
5099 uschar finalhash[MAX_HASHLEN];
5100 uschar finalhash_hex[2*MAX_HASHLEN];
5101 uschar innerkey[MAX_HASHBLOCKLEN];
5102 uschar outerkey[MAX_HASHBLOCKLEN];
5104 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5106 case 1: goto EXPAND_FAILED_CURLY;
5108 case 3: goto EXPAND_FAILED;
5111 if (Ustrcmp(sub[0], "md5") == 0)
5114 use_base = &md5_base;
5118 else if (Ustrcmp(sub[0], "sha1") == 0)
5121 use_base = &sha1_base;
5127 expand_string_message =
5128 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5133 keylen = Ustrlen(keyptr);
5135 /* If the key is longer than the hash block length, then hash the key
5138 if (keylen > hashblocklen)
5140 chash_start(type, use_base);
5141 chash_end(type, use_base, keyptr, keylen, keyhash);
5146 /* Now make the inner and outer key values */
5148 memset(innerkey, 0x36, hashblocklen);
5149 memset(outerkey, 0x5c, hashblocklen);
5151 for (i = 0; i < keylen; i++)
5153 innerkey[i] ^= keyptr[i];
5154 outerkey[i] ^= keyptr[i];
5157 /* Now do the hashes */
5159 chash_start(type, use_base);
5160 chash_mid(type, use_base, innerkey);
5161 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5163 chash_start(type, use_base);
5164 chash_mid(type, use_base, outerkey);
5165 chash_end(type, use_base, innerhash, hashlen, finalhash);
5167 /* Encode the final hash as a hex string */
5170 for (i = 0; i < hashlen; i++)
5172 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5173 *p++ = hex_digits[finalhash[i] & 0x0f];
5176 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5177 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5179 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5184 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5185 We have to save the numerical variables and restore them afterwards. */
5190 int moffset, moffsetextra, slen;
5193 const uschar *rerror;
5196 int save_expand_nmax =
5197 save_expand_strings(save_expand_nstring, save_expand_nlength);
5199 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5201 case 1: goto EXPAND_FAILED_CURLY;
5203 case 3: goto EXPAND_FAILED;
5206 /* Compile the regular expression */
5208 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5213 expand_string_message = string_sprintf("regular expression error in "
5214 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5218 /* Now run a loop to do the substitutions as often as necessary. It ends
5219 when there are no more matches. Take care over matches of the null string;
5220 do the same thing as Perl does. */
5223 slen = Ustrlen(sub[0]);
5224 moffset = moffsetextra = 0;
5229 int ovector[3*(EXPAND_MAXN+1)];
5230 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5231 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5235 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5236 is not necessarily the end. We want to repeat the match from one
5237 character further along, but leaving the basic offset the same (for
5238 copying below). We can't be at the end of the string - that was checked
5239 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5240 finished; copy the remaining string and end the loop. */
5250 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5254 /* Match - set up for expanding the replacement. */
5256 if (n == 0) n = EXPAND_MAXN + 1;
5258 for (nn = 0; nn < n*2; nn += 2)
5260 expand_nstring[expand_nmax] = subject + ovector[nn];
5261 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5265 /* Copy the characters before the match, plus the expanded insertion. */
5267 yield = string_cat(yield, &size, &ptr, subject + moffset,
5268 ovector[0] - moffset);
5269 insert = expand_string(sub[2]);
5270 if (insert == NULL) goto EXPAND_FAILED;
5271 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5273 moffset = ovector[1];
5277 /* If we have matched an empty string, first check to see if we are at
5278 the end of the subject. If so, the loop is over. Otherwise, mimic
5279 what Perl's /g options does. This turns out to be rather cunning. First
5280 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5281 string at the same point. If this fails (picked up above) we advance to
5282 the next character. */
5284 if (ovector[0] == ovector[1])
5286 if (ovector[0] == slen) break;
5287 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5291 /* All done - restore numerical variables. */
5293 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5294 save_expand_nlength);
5298 /* Handle keyed and numbered substring extraction. If the first argument
5299 consists entirely of digits, then a numerical extraction is assumed. */
5305 int field_number = 1;
5306 BOOL field_number_set = FALSE;
5307 uschar *save_lookup_value = lookup_value;
5309 int save_expand_nmax =
5310 save_expand_strings(save_expand_nstring, save_expand_nlength);
5312 /* While skipping we cannot rely on the data for expansions being
5313 available (eg. $item) hence cannot decide on numeric vs. keyed.
5314 Just read as many arguments as there are. */
5318 while (isspace(*s)) s++;
5321 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5322 goto EXPAND_FAILED; /*{*/
5323 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5324 while (isspace(*s)) s++;
5327 goto EXPAND_FAILED_CURLY;
5330 else for (i = 0; i < j; i++) /* Read the proper number of arguments */
5332 while (isspace(*s)) s++;
5333 if (*s == '{') /*}*/
5335 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5336 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5337 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5339 /* After removal of leading and trailing white space, the first
5340 argument must not be empty; if it consists entirely of digits
5341 (optionally preceded by a minus sign), this is a numerical
5342 extraction, and we expect 3 arguments. */
5350 while (isspace(*p)) p++;
5354 while (len > 0 && isspace(p[len-1])) len--;
5359 expand_string_message = US"first argument of \"extract\" must "
5369 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5373 j = 3; /* Need 3 args */
5374 field_number_set = TRUE;
5378 else goto EXPAND_FAILED_CURLY;
5381 /* Extract either the numbered or the keyed substring into $value. If
5382 skipping, just pretend the extraction failed. */
5384 lookup_value = skipping? NULL : field_number_set?
5385 expand_gettokened(field_number, sub[1], sub[2]) :
5386 expand_getkeyed(sub[0], sub[1]);
5388 /* If no string follows, $value gets substituted; otherwise there can
5389 be yes/no strings, as for lookup or if. */
5391 switch(process_yesno(
5392 skipping, /* were previously skipping */
5393 lookup_value != NULL, /* success/failure indicator */
5394 save_lookup_value, /* value to reset for string2 */
5395 &s, /* input pointer */
5396 &yield, /* output pointer */
5397 &size, /* output size */
5398 &ptr, /* output current point */
5399 US"extract", /* condition type */
5402 case 1: goto EXPAND_FAILED; /* when all is well, the */
5403 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5406 /* All done - restore numerical variables. */
5408 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5409 save_expand_nlength);
5414 /* return the Nth item from a list */
5416 case EITEM_LISTEXTRACT:
5419 int field_number = 1;
5420 uschar *save_lookup_value = lookup_value;
5422 int save_expand_nmax =
5423 save_expand_strings(save_expand_nstring, save_expand_nlength);
5425 /* Read the field & list arguments */
5427 for (i = 0; i < 2; i++)
5429 while (isspace(*s)) s++;
5430 if (*s != '{') /*}*/
5431 goto EXPAND_FAILED_CURLY;
5433 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5434 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5435 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5437 /* After removal of leading and trailing white space, the first
5438 argument must be numeric and nonempty. */
5446 while (isspace(*p)) p++;
5450 while (len > 0 && isspace(p[len-1])) len--;
5453 if (!*p && !skipping)
5455 expand_string_message = US"first argument of \"listextract\" must "
5465 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5468 expand_string_message = US"first argument of \"listextract\" must "
5476 /* Extract the numbered element into $value. If
5477 skipping, just pretend the extraction failed. */
5479 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5481 /* If no string follows, $value gets substituted; otherwise there can
5482 be yes/no strings, as for lookup or if. */
5484 switch(process_yesno(
5485 skipping, /* were previously skipping */
5486 lookup_value != NULL, /* success/failure indicator */
5487 save_lookup_value, /* value to reset for string2 */
5488 &s, /* input pointer */
5489 &yield, /* output pointer */
5490 &size, /* output size */
5491 &ptr, /* output current point */
5492 US"listextract", /* condition type */
5495 case 1: goto EXPAND_FAILED; /* when all is well, the */
5496 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5499 /* All done - restore numerical variables. */
5501 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5502 save_expand_nlength);
5508 case EITEM_CERTEXTRACT:
5510 uschar *save_lookup_value = lookup_value;
5512 int save_expand_nmax =
5513 save_expand_strings(save_expand_nstring, save_expand_nlength);
5515 /* Read the field argument */
5516 while (isspace(*s)) s++;
5517 if (*s != '{') /*}*/
5518 goto EXPAND_FAILED_CURLY;
5519 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5520 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5521 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5522 /* strip spaces fore & aft */
5527 while (isspace(*p)) p++;
5531 while (len > 0 && isspace(p[len-1])) len--;
5535 /* inspect the cert argument */
5536 while (isspace(*s)) s++;
5537 if (*s != '{') /*}*/
5538 goto EXPAND_FAILED_CURLY;
5541 expand_string_message = US"second argument of \"certextract\" must "
5542 "be a certificate variable";
5545 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5546 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5547 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5550 lookup_value = NULL;
5553 lookup_value = expand_getcertele(sub[0], sub[1]);
5554 if (*expand_string_message) goto EXPAND_FAILED;
5556 switch(process_yesno(
5557 skipping, /* were previously skipping */
5558 lookup_value != NULL, /* success/failure indicator */
5559 save_lookup_value, /* value to reset for string2 */
5560 &s, /* input pointer */
5561 &yield, /* output pointer */
5562 &size, /* output size */
5563 &ptr, /* output current point */
5564 US"certextract", /* condition type */
5567 case 1: goto EXPAND_FAILED; /* when all is well, the */
5568 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5571 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5572 save_expand_nlength);
5575 #endif /*SUPPORT_TLS*/
5577 /* Handle list operations */
5585 uschar outsep[2] = { '\0', '\0' };
5586 const uschar *list, *expr, *temp;
5587 uschar *save_iterate_item = iterate_item;
5588 uschar *save_lookup_value = lookup_value;
5590 while (isspace(*s)) s++;
5591 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5593 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5594 if (list == NULL) goto EXPAND_FAILED;
5595 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5597 if (item_type == EITEM_REDUCE)
5600 while (isspace(*s)) s++;
5601 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5602 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5603 if (!t) goto EXPAND_FAILED;
5605 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5608 while (isspace(*s)) s++;
5609 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5613 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5614 if scanning a "false" part). This allows us to find the end of the
5615 condition, because if the list is empty, we won't actually evaluate the
5616 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5617 the normal internal expansion function. */
5619 if (item_type == EITEM_FILTER)
5621 temp = eval_condition(expr, &resetok, NULL);
5622 if (temp != NULL) s = temp;
5625 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5629 expand_string_message = string_sprintf("%s inside \"%s\" item",
5630 expand_string_message, name);
5634 while (isspace(*s)) s++;
5637 expand_string_message = string_sprintf("missing } at end of condition "
5638 "or expression inside \"%s\"", name);
5642 while (isspace(*s)) s++; /*{*/
5645 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5650 /* If we are skipping, we can now just move on to the next item. When
5651 processing for real, we perform the iteration. */
5653 if (skipping) continue;
5654 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5656 *outsep = (uschar)sep; /* Separator as a string */
5658 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5660 if (item_type == EITEM_FILTER)
5663 if (eval_condition(expr, &resetok, &condresult) == NULL)
5665 iterate_item = save_iterate_item;
5666 lookup_value = save_lookup_value;
5667 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5668 expand_string_message, name);
5671 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5672 condresult? "true":"false");
5674 temp = iterate_item; /* TRUE => include this item */
5676 continue; /* FALSE => skip this item */
5679 /* EITEM_MAP and EITEM_REDUCE */
5683 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5687 iterate_item = save_iterate_item;
5688 expand_string_message = string_sprintf("%s inside \"%s\" item",
5689 expand_string_message, name);
5692 if (item_type == EITEM_REDUCE)
5694 lookup_value = t; /* Update the value of $value */
5695 continue; /* and continue the iteration */
5699 /* We reach here for FILTER if the condition is true, always for MAP,
5700 and never for REDUCE. The value in "temp" is to be added to the output
5701 list that is being created, ensuring that any occurrences of the
5702 separator character are doubled. Unless we are dealing with the first
5703 item of the output list, add in a space if the new item begins with the
5704 separator character, or is an empty string. */
5706 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5707 yield = string_cat(yield, &size, &ptr, US" ", 1);
5709 /* Add the string in "temp" to the output list that we are building,
5710 This is done in chunks by searching for the separator character. */
5714 size_t seglen = Ustrcspn(temp, outsep);
5715 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5717 /* If we got to the end of the string we output one character
5718 too many; backup and end the loop. Otherwise arrange to double the
5721 if (temp[seglen] == '\0') { ptr--; break; }
5722 yield = string_cat(yield, &size, &ptr, outsep, 1);
5726 /* Output a separator after the string: we will remove the redundant
5727 final one at the end. */
5729 yield = string_cat(yield, &size, &ptr, outsep, 1);
5730 } /* End of iteration over the list loop */
5732 /* REDUCE has generated no output above: output the final value of
5735 if (item_type == EITEM_REDUCE)
5737 yield = string_cat(yield, &size, &ptr, lookup_value,
5738 Ustrlen(lookup_value));
5739 lookup_value = save_lookup_value; /* Restore $value */
5742 /* FILTER and MAP generate lists: if they have generated anything, remove
5743 the redundant final separator. Even though an empty item at the end of a
5744 list does not count, this is tidier. */
5746 else if (ptr != save_ptr) ptr--;
5748 /* Restore preserved $item */
5750 iterate_item = save_iterate_item;
5757 const uschar *srclist, *cmp, *xtract;
5759 const uschar *dstlist = NULL, *dstkeylist = NULL;
5761 uschar *save_iterate_item = iterate_item;
5763 while (isspace(*s)) s++;
5764 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5766 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5767 if (!srclist) goto EXPAND_FAILED;
5768 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5770 while (isspace(*s)) s++;
5771 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5773 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5774 if (!cmp) goto EXPAND_FAILED;
5775 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5777 while (isspace(*s)) s++;
5778 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5781 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5782 if (!tmp) goto EXPAND_FAILED;
5783 xtract = string_copyn(xtract, s - xtract);
5785 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5789 expand_string_message = US"missing } at end of \"sort\"";
5793 if (skipping) continue;
5795 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5798 uschar * newlist = NULL;
5799 uschar * newkeylist = NULL;
5802 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, srcitem);
5804 /* extract field for comparisons */
5805 iterate_item = srcitem;
5806 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5810 expand_string_message = string_sprintf(
5811 "field-extract in sort: \"%s\"", xtract);
5815 /* Insertion sort */
5817 /* copy output list until new-item < list-item */
5818 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5824 /* field for comparison */
5825 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5828 /* build and run condition string */
5829 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
5831 DEBUG(D_expand) debug_printf("%s: cond = \"%s\"\n", name, expr);
5832 if (!eval_condition(expr, &resetok, &before))
5834 expand_string_message = string_sprintf("comparison in sort: %s",
5841 /* New-item sorts before this dst-item. Append new-item,
5842 then dst-item, then remainder of dst list. */
5844 newlist = string_append_listele(newlist, sep, srcitem);
5845 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5848 newlist = string_append_listele(newlist, sep, dstitem);
5849 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5851 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5853 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5855 newlist = string_append_listele(newlist, sep, dstitem);
5856 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5862 newlist = string_append_listele(newlist, sep, dstitem);
5863 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5866 /* If we ran out of dstlist without consuming srcitem, append it */
5869 newlist = string_append_listele(newlist, sep, srcitem);
5870 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5874 dstkeylist = newkeylist;
5876 DEBUG(D_expand) debug_printf("%s: dstlist = \"%s\"\n", name, dstlist);
5877 DEBUG(D_expand) debug_printf("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
5881 yield = string_cat(yield, &size, &ptr, dstlist, Ustrlen(dstlist));
5883 /* Restore preserved $item */
5884 iterate_item = save_iterate_item;
5888 expand_string_message = US"Internal error in sort (list mismatch)";
5893 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5894 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5895 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5896 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5898 #define EXPAND_DLFUNC_MAX_ARGS 8
5901 #ifndef EXPAND_DLFUNC
5902 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5903 "is not included in this binary";
5906 #else /* EXPAND_DLFUNC */
5909 exim_dlfunc_t *func;
5912 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5914 if ((expand_forbid & RDO_DLFUNC) != 0)
5916 expand_string_message =
5917 US"dynamically-loaded functions are not permitted";
5921 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5922 TRUE, US"dlfunc", &resetok))
5924 case 1: goto EXPAND_FAILED_CURLY;
5926 case 3: goto EXPAND_FAILED;
5929 /* If skipping, we don't actually do anything */
5931 if (skipping) continue;
5933 /* Look up the dynamically loaded object handle in the tree. If it isn't
5934 found, dlopen() the file and put the handle in the tree for next time. */
5936 t = tree_search(dlobj_anchor, argv[0]);
5939 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5942 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5943 argv[0], dlerror());
5944 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5947 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5948 Ustrcpy(t->name, argv[0]);
5949 t->data.ptr = handle;
5950 (void)tree_insertnode(&dlobj_anchor, t);
5953 /* Having obtained the dynamically loaded object handle, look up the
5954 function pointer. */
5956 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5959 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5960 "%s", argv[1], argv[0], dlerror());
5961 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5965 /* Call the function and work out what to do with the result. If it
5966 returns OK, we have a replacement string; if it returns DEFER then
5967 expansion has failed in a non-forced manner; if it returns FAIL then
5968 failure was forced; if it returns ERROR or any other value there's a
5969 problem, so panic slightly. In any case, assume that the function has
5970 side-effects on the store that must be preserved. */
5974 for (argc = 0; argv[argc] != NULL; argc++);
5975 status = func(&result, argc - 2, &argv[2]);
5978 if (result == NULL) result = US"";
5979 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5984 expand_string_message = result == NULL ? US"(no message)" : result;
5985 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5986 else if(status != FAIL)
5987 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5988 argv[0], argv[1], status, expand_string_message);
5992 #endif /* EXPAND_DLFUNC */
5994 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
5997 uschar *save_lookup_value = lookup_value;
5999 while (isspace(*s)) s++;
6000 if (*s != '{') /*}*/
6003 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6004 if (!key) goto EXPAND_FAILED; /*{*/
6005 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
6007 lookup_value = US getenv(CS key);
6009 switch(process_yesno(
6010 skipping, /* were previously skipping */
6011 lookup_value != NULL, /* success/failure indicator */
6012 save_lookup_value, /* value to reset for string2 */
6013 &s, /* input pointer */
6014 &yield, /* output pointer */
6015 &size, /* output size */
6016 &ptr, /* output current point */
6017 US"env", /* condition type */
6020 case 1: goto EXPAND_FAILED; /* when all is well, the */
6021 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6025 } /* EITEM_* switch */
6027 /* Control reaches here if the name is not recognized as one of the more
6028 complicated expansion items. Check for the "operator" syntax (name terminated
6029 by a colon). Some of the operators have arguments, separated by _ from the
6037 var_entry *vp = NULL;
6039 /* Owing to an historical mis-design, an underscore may be part of the
6040 operator name, or it may introduce arguments. We therefore first scan the
6041 table of names that contain underscores. If there is no match, we cut off
6042 the arguments and then scan the main table. */
6044 if ((c = chop_match(name, op_table_underscore,
6045 nelem(op_table_underscore))) < 0)
6047 arg = Ustrchr(name, '_');
6048 if (arg != NULL) *arg = 0;
6049 c = chop_match(name, op_table_main, nelem(op_table_main));
6050 if (c >= 0) c += nelem(op_table_underscore);
6051 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6054 /* Deal specially with operators that might take a certificate variable
6055 as we do not want to do the usual expansion. For most, expand the string.*/
6065 const uschar * s1 = s;
6066 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6068 if (!sub) goto EXPAND_FAILED; /*{*/
6069 if (*s1 != '}') goto EXPAND_FAILED_CURLY;
6070 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6080 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6081 if (!sub) goto EXPAND_FAILED;
6086 /* If we are skipping, we don't need to perform the operation at all.
6087 This matters for operations like "mask", because the data may not be
6088 in the correct format when skipping. For example, the expression may test
6089 for the existence of $sender_host_address before trying to mask it. For
6090 other operations, doing them may not fail, but it is a waste of time. */
6092 if (skipping && c >= 0) continue;
6094 /* Otherwise, switch on the operator type */
6101 unsigned long int n = Ustrtoul(sub, &t, 10);
6104 expand_string_message = string_sprintf("argument for base62 "
6105 "operator is \"%s\", which is not a decimal number", sub);
6108 t = string_base62(n);
6109 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6113 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6119 unsigned long int n = 0;
6122 uschar *t = Ustrchr(base62_chars, *tt++);
6125 expand_string_message = string_sprintf("argument for base62d "
6126 "operator is \"%s\", which is not a base %d number", sub,
6130 n = n * BASE_62 + (t - base62_chars);
6132 (void)sprintf(CS buf, "%ld", n);
6133 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
6139 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6140 if (expanded == NULL)
6142 expand_string_message =
6143 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6144 expand_string_message);
6147 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
6154 uschar *t = sub - 1;
6155 while (*(++t) != 0) { *t = tolower(*t); count++; }
6156 yield = string_cat(yield, &size, &ptr, sub, count);
6163 uschar *t = sub - 1;
6164 while (*(++t) != 0) { *t = toupper(*t); count++; }
6165 yield = string_cat(yield, &size, &ptr, sub, count);
6171 if (vp && *(void **)vp->value)
6173 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6174 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6184 md5_end(&base, sub, Ustrlen(sub), digest);
6185 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6186 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6192 if (vp && *(void **)vp->value)
6194 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6195 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6205 sha1_end(&base, sub, Ustrlen(sub), digest);
6206 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6207 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6213 if (vp && *(void **)vp->value)
6215 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6216 yield = string_cat(yield, &size, &ptr, cp, (int)Ustrlen(cp));
6220 expand_string_message = US"sha256 only supported for certificates";
6223 /* Convert hex encoding to base64 encoding */
6233 for (enc = sub; *enc != 0; enc++)
6235 if (!isxdigit(*enc))
6237 expand_string_message = string_sprintf("\"%s\" is not a hex "
6246 expand_string_message = string_sprintf("\"%s\" contains an odd "
6247 "number of characters", sub);
6251 while ((c = *in++) != 0)
6253 if (isdigit(c)) c -= '0';
6254 else c = toupper(c) - 'A' + 10;
6266 enc = b64encode(sub, out - sub);
6267 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
6271 /* Convert octets outside 0x21..0x7E to \xXX form */
6275 uschar *t = sub - 1;
6278 if (*t < 0x21 || 0x7E < *t)
6279 yield = string_cat(yield, &size, &ptr,
6280 string_sprintf("\\x%02x", *t), 4);
6282 yield = string_cat(yield, &size, &ptr, t, 1);
6287 /* count the number of list elements */
6296 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6297 cp = string_sprintf("%d", cnt);
6298 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6302 /* expand a named list given the name */
6303 /* handles nested named lists; requotes as colon-sep list */
6307 tree_node *t = NULL;
6308 const uschar * list;
6311 uschar * suffix = US"";
6312 BOOL needsep = FALSE;
6315 if (*sub == '+') sub++;
6316 if (arg == NULL) /* no-argument version */
6318 if (!(t = tree_search(addresslist_anchor, sub)) &&
6319 !(t = tree_search(domainlist_anchor, sub)) &&
6320 !(t = tree_search(hostlist_anchor, sub)))
6321 t = tree_search(localpartlist_anchor, sub);
6323 else switch(*arg) /* specific list-type version */
6325 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6326 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6327 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6328 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6330 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6336 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6338 : *arg=='a'?"address "
6339 : *arg=='d'?"domain "
6341 : *arg=='l'?"localpart "
6346 list = ((namedlist_block *)(t->data.ptr))->string;
6348 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6350 uschar * buf = US" : ";
6352 yield = string_cat(yield, &size, &ptr, buf, 3);
6356 if (*item == '+') /* list item is itself a named list */
6358 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6359 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6361 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6365 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6366 while ((cp= strpbrk((const char *)item, tok)))
6368 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
6369 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6371 yield = string_cat(yield, &size, &ptr, US"::", 2);
6372 item = (uschar *)cp;
6374 else /* sep in item; should already be doubled; emit once */
6376 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
6377 if (*cp == sep) cp++;
6378 item = (uschar *)cp;
6382 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
6387 /* mask applies a mask to an IP address; for example the result of
6388 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6395 int mask, maskoffset;
6396 int type = string_is_ip_address(sub, &maskoffset);
6401 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6406 if (maskoffset == 0)
6408 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6413 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6415 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6417 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6422 /* Convert the address to binary integer(s) and apply the mask */
6424 sub[maskoffset] = 0;
6425 count = host_aton(sub, binary);
6426 host_mask(count, binary, mask);
6428 /* Convert to masked textual format and add to output. */
6430 yield = string_cat(yield, &size, &ptr, buffer,
6431 host_nmtoa(count, binary, mask, buffer, '.'));
6436 case EOP_IPV6DENORM:
6438 int type = string_is_ip_address(sub, NULL);
6445 (void) host_aton(sub, binary);
6448 case 4: /* convert to IPv4-mapped IPv6 */
6449 binary[0] = binary[1] = 0;
6450 binary[2] = 0x0000ffff;
6451 (void) host_aton(sub, binary+3);
6455 expand_string_message =
6456 string_sprintf("\"%s\" is not an IP address", sub);
6460 yield = string_cat(yield, &size, &ptr, buffer,
6462 ? ipv6_nmtoa(binary, buffer)
6463 : host_nmtoa(4, binary, -1, buffer, ':')
6469 case EOP_LOCAL_PART:
6473 int start, end, domain;
6474 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6478 if (c != EOP_DOMAIN)
6480 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6481 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
6483 else if (domain != 0)
6486 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
6494 uschar outsep[2] = { ':', '\0' };
6495 uschar *address, *error;
6497 int start, end, domain; /* Not really used */
6499 while (isspace(*sub)) sub++;
6500 if (*sub == '>') { *outsep = *++sub; ++sub; }
6501 parse_allow_group = TRUE;
6505 uschar *p = parse_find_address_end(sub, FALSE);
6506 uschar saveend = *p;
6508 address = parse_extract_address(sub, &error, &start, &end, &domain,
6512 /* Add the address to the output list that we are building. This is
6513 done in chunks by searching for the separator character. At the
6514 start, unless we are dealing with the first address of the output
6515 list, add in a space if the new address begins with the separator
6516 character, or is an empty string. */
6518 if (address != NULL)
6520 if (ptr != save_ptr && address[0] == *outsep)
6521 yield = string_cat(yield, &size, &ptr, US" ", 1);
6525 size_t seglen = Ustrcspn(address, outsep);
6526 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
6528 /* If we got to the end of the string we output one character
6531 if (address[seglen] == '\0') { ptr--; break; }
6532 yield = string_cat(yield, &size, &ptr, outsep, 1);
6533 address += seglen + 1;
6536 /* Output a separator after the string: we will remove the
6537 redundant final one at the end. */
6539 yield = string_cat(yield, &size, &ptr, outsep, 1);
6542 if (saveend == '\0') break;
6546 /* If we have generated anything, remove the redundant final
6549 if (ptr != save_ptr) ptr--;
6550 parse_allow_group = FALSE;
6555 /* quote puts a string in quotes if it is empty or contains anything
6556 other than alphamerics, underscore, dot, or hyphen.
6558 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6559 be quoted in order to be a valid local part.
6561 In both cases, newlines and carriage returns are converted into \n and \r
6565 case EOP_QUOTE_LOCAL_PART:
6568 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6569 uschar *t = sub - 1;
6573 while (!needs_quote && *(++t) != 0)
6574 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6576 else /* EOP_QUOTE_LOCAL_PART */
6578 while (!needs_quote && *(++t) != 0)
6579 needs_quote = !isalnum(*t) &&
6580 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6581 (*t != '.' || t == sub || t[1] == 0);
6586 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6591 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6592 else if (*t == '\r')
6593 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6596 if (*t == '\\' || *t == '"')
6597 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6598 yield = string_cat(yield, &size, &ptr, t, 1);
6601 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6603 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6607 /* quote_lookuptype does lookup-specific quoting */
6612 uschar *opt = Ustrchr(arg, '_');
6614 if (opt != NULL) *opt++ = 0;
6616 n = search_findtype(arg, Ustrlen(arg));
6619 expand_string_message = search_error_message;
6623 if (lookup_list[n]->quote != NULL)
6624 sub = (lookup_list[n]->quote)(sub, opt);
6625 else if (opt != NULL) sub = NULL;
6629 expand_string_message = string_sprintf(
6630 "\"%s\" unrecognized after \"${quote_%s\"",
6635 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6639 /* rx quote sticks in \ before any non-alphameric character so that
6640 the insertion works in a regular expression. */
6644 uschar *t = sub - 1;
6648 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6649 yield = string_cat(yield, &size, &ptr, t, 1);
6654 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6655 prescribed by the RFC, if there are characters that need to be encoded */
6659 uschar buffer[2048];
6660 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6661 buffer, sizeof(buffer), FALSE);
6662 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6666 /* RFC 2047 decode */
6672 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6673 headers_charset, '?', &len, &error);
6676 expand_string_message = error;
6679 yield = string_cat(yield, &size, &ptr, decoded, len);
6683 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6693 if (c > 255) c = '_';
6695 yield = string_cat(yield, &size, &ptr, buff, 1);
6700 /* replace illegal UTF-8 sequences by replacement character */
6702 #define UTF8_REPLACEMENT_CHAR US"?"
6706 int seq_len = 0, index = 0;
6708 long codepoint = -1;
6709 uschar seq_buff[4]; /* accumulate utf-8 here */
6718 if ((c & 0xc0) != 0x80)
6719 /* wrong continuation byte; invalidate all bytes */
6720 complete = 1; /* error */
6723 codepoint = (codepoint << 6) | (c & 0x3f);
6724 seq_buff[index++] = c;
6725 if (--bytes_left == 0) /* codepoint complete */
6726 if(codepoint > 0x10FFFF) /* is it too large? */
6727 complete = -1; /* error (RFC3629 limit) */
6729 { /* finished; output utf-8 sequence */
6730 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6735 else /* no bytes left: new sequence */
6737 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6739 yield = string_cat(yield, &size, &ptr, &c, 1);
6742 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6744 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6749 codepoint = c & 0x1f;
6752 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6755 codepoint = c & 0x0f;
6757 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6760 codepoint = c & 0x07;
6762 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6765 seq_buff[index++] = c;
6766 seq_len = bytes_left + 1;
6767 } /* if(bytes_left) */
6771 bytes_left = index = 0;
6772 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6774 if ((complete == 1) && ((c & 0x80) == 0))
6775 /* ASCII character follows incomplete sequence */
6776 yield = string_cat(yield, &size, &ptr, &c, 1);
6782 case EOP_UTF8_DOMAIN_TO_ALABEL:
6784 uschar * error = NULL;
6785 uschar * s = string_domain_utf8_to_alabel(sub, &error);
6788 expand_string_message = string_sprintf(
6789 "error converting utf8 (%s) to alabel: %s",
6790 string_printing(sub), error);
6793 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6797 case EOP_UTF8_DOMAIN_FROM_ALABEL:
6799 uschar * error = NULL;
6800 uschar * s = string_domain_alabel_to_utf8(sub, &error);
6803 expand_string_message = string_sprintf(
6804 "error converting alabel (%s) to utf8: %s",
6805 string_printing(sub), error);
6808 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6812 case EOP_UTF8_LOCALPART_TO_ALABEL:
6814 uschar * error = NULL;
6815 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
6818 expand_string_message = string_sprintf(
6819 "error converting utf8 (%s) to alabel: %s",
6820 string_printing(sub), error);
6823 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6824 DEBUG(D_expand) debug_printf("yield: '%s'\n", yield);
6828 case EOP_UTF8_LOCALPART_FROM_ALABEL:
6830 uschar * error = NULL;
6831 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
6834 expand_string_message = string_sprintf(
6835 "error converting alabel (%s) to utf8: %s",
6836 string_printing(sub), error);
6839 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6842 #endif /* EXPERIMENTAL_INTERNATIONAL */
6844 /* escape turns all non-printing characters into escape sequences. */
6848 const uschar *t = string_printing(sub);
6849 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6853 /* Handle numeric expression evaluation */
6858 uschar *save_sub = sub;
6859 uschar *error = NULL;
6860 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6863 expand_string_message = string_sprintf("error in expression "
6864 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6868 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6869 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6873 /* Handle time period formating */
6877 int n = readconf_readtime(sub, 0, FALSE);
6880 expand_string_message = string_sprintf("string \"%s\" is not an "
6881 "Exim time interval in \"%s\" operator", sub, name);
6884 sprintf(CS var_buffer, "%d", n);
6885 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6889 case EOP_TIME_INTERVAL:
6892 uschar *t = read_number(&n, sub);
6893 if (*t != 0) /* Not A Number*/
6895 expand_string_message = string_sprintf("string \"%s\" is not a "
6896 "positive number in \"%s\" operator", sub, name);
6899 t = readconf_printtime(n);
6900 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6904 /* Convert string to base64 encoding */
6910 uschar * s = vp && *(void **)vp->value
6911 ? tls_cert_der_b64(*(void **)vp->value)
6912 : b64encode(sub, Ustrlen(sub));
6914 uschar * s = b64encode(sub, Ustrlen(sub));
6916 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6923 int len = b64decode(sub, &s);
6926 expand_string_message = string_sprintf("string \"%s\" is not "
6927 "well-formed for \"%s\" operator", sub, name);
6930 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6934 /* strlen returns the length of the string */
6939 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6940 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6944 /* length_n or l_n takes just the first n characters or the whole string,
6945 whichever is the shorter;
6947 substr_m_n, and s_m_n take n characters from offset m; negative m take
6948 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6949 takes the rest, either to the right or to the left.
6951 hash_n or h_n makes a hash of length n from the string, yielding n
6952 characters from the set a-z; hash_n_m makes a hash of length n, but
6953 uses m characters from the set a-zA-Z0-9.
6955 nhash_n returns a single number between 0 and n-1 (in text form), while
6956 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6957 between 0 and n-1 and the second between 0 and m-1. */
6977 expand_string_message = string_sprintf("missing values after %s",
6982 /* "length" has only one argument, effectively being synonymous with
6985 if (c == EOP_LENGTH || c == EOP_L)
6991 /* The others have one or two arguments; for "substr" the first may be
6992 negative. The second being negative means "not supplied". */
6997 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7000 /* Read up to two numbers, separated by underscores */
7005 if (arg != ret && *arg == '_' && pn == &value1)
7009 if (arg[1] != 0) arg++;
7011 else if (!isdigit(*arg))
7013 expand_string_message =
7014 string_sprintf("non-digit after underscore in \"%s\"", name);
7017 else *pn = (*pn)*10 + *arg++ - '0';
7021 /* Perform the required operation */
7024 (c == EOP_HASH || c == EOP_H)?
7025 compute_hash(sub, value1, value2, &len) :
7026 (c == EOP_NHASH || c == EOP_NH)?
7027 compute_nhash(sub, value1, value2, &len) :
7028 extract_substr(sub, value1, value2, &len);
7030 if (ret == NULL) goto EXPAND_FAILED;
7031 yield = string_cat(yield, &size, &ptr, ret, len);
7041 uschar **modetable[3];
7046 if ((expand_forbid & RDO_EXISTS) != 0)
7048 expand_string_message = US"Use of the stat() expansion is not permitted";
7052 if (stat(CS sub, &st) < 0)
7054 expand_string_message = string_sprintf("stat(%s) failed: %s",
7055 sub, strerror(errno));
7059 switch (mode & S_IFMT)
7061 case S_IFIFO: smode[0] = 'p'; break;
7062 case S_IFCHR: smode[0] = 'c'; break;
7063 case S_IFDIR: smode[0] = 'd'; break;
7064 case S_IFBLK: smode[0] = 'b'; break;
7065 case S_IFREG: smode[0] = '-'; break;
7066 default: smode[0] = '?'; break;
7069 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7070 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7071 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7073 for (i = 0; i < 3; i++)
7075 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7080 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7081 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7082 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7083 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7084 (long)st.st_gid, st.st_size, (long)st.st_atime,
7085 (long)st.st_mtime, (long)st.st_ctime);
7086 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
7090 /* vaguely random number less than N */
7094 int_eximarith_t max;
7097 max = expanded_string_integer(sub, TRUE);
7098 if (expand_string_message != NULL)
7100 s = string_sprintf("%d", vaguely_random_number((int)max));
7101 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
7105 /* Reverse IP, including IPv6 to dotted-nibble */
7107 case EOP_REVERSE_IP:
7109 int family, maskptr;
7110 uschar reversed[128];
7112 family = string_is_ip_address(sub, &maskptr);
7115 expand_string_message = string_sprintf(
7116 "reverse_ip() not given an IP address [%s]", sub);
7119 invert_address(reversed, sub);
7120 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
7124 /* Unknown operator */
7127 expand_string_message =
7128 string_sprintf("unknown expansion operator \"%s\"", name);
7133 /* Handle a plain name. If this is the first thing in the expansion, release
7134 the pre-allocated buffer. If the result data is known to be in a new buffer,
7135 newsize will be set to the size of that buffer, and we can just point at that
7136 store instead of copying. Many expansion strings contain just one reference,
7137 so this is a useful optimization, especially for humungous headers
7138 ($message_headers). */
7146 if (resetok) store_reset(yield);
7150 value = find_variable(name, FALSE, skipping, &newsize);
7153 expand_string_message =
7154 string_sprintf("unknown variable in \"${%s}\"", name);
7155 check_variable_error_message(name);
7158 len = Ustrlen(value);
7159 if (yield == NULL && newsize != 0)
7165 else yield = string_cat(yield, &size, &ptr, value, len);
7169 /* Else there's something wrong */
7171 expand_string_message =
7172 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7173 "in a variable reference)", name);
7177 /* If we hit the end of the string when ket_ends is set, there is a missing
7178 terminating brace. */
7180 if (ket_ends && *s == 0)
7182 expand_string_message = malformed_header?
7183 US"missing } at end of string - could be header name not terminated by colon"
7185 US"missing } at end of string";
7189 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7190 added to the string. If so, set up an empty string. Add a terminating zero. If
7191 left != NULL, return a pointer to the terminator. */
7193 if (yield == NULL) yield = store_get(1);
7195 if (left != NULL) *left = s;
7197 /* Any stacking store that was used above the final string is no longer needed.
7198 In many cases the final string will be the first one that was got and so there
7199 will be optimal store usage. */
7201 if (resetok) store_reset(yield + ptr + 1);
7202 else if (resetok_p) *resetok_p = FALSE;
7206 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
7208 if (skipping) debug_printf("skipping: result is not used\n");
7212 /* This is the failure exit: easiest to program with a goto. We still need
7213 to update the pointer to the terminator, for cases of nested calls with "fail".
7216 EXPAND_FAILED_CURLY:
7217 expand_string_message = malformed_header?
7218 US"missing or misplaced { or } - could be header name not terminated by colon"
7220 US"missing or misplaced { or }";
7222 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7223 that is a bad idea, because expand_string_message is in dynamic store. */
7226 if (left != NULL) *left = s;
7229 debug_printf("failed to expand: %s\n", string);
7230 debug_printf(" error message: %s\n", expand_string_message);
7231 if (expand_string_forcedfail) debug_printf("failure was forced\n");
7233 if (resetok_p) *resetok_p = resetok;
7238 /* This is the external function call. Do a quick check for any expansion
7239 metacharacters, and if there are none, just return the input string.
7241 Argument: the string to be expanded
7242 Returns: the expanded string, or NULL if expansion failed; if failure was
7243 due to a lookup deferring, search_find_defer will be TRUE
7247 expand_string(uschar *string)
7249 search_find_defer = FALSE;
7250 malformed_header = FALSE;
7251 return (Ustrpbrk(string, "$\\") == NULL)? string :
7252 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7258 expand_cstring(const uschar *string)
7260 search_find_defer = FALSE;
7261 malformed_header = FALSE;
7262 return (Ustrpbrk(string, "$\\") == NULL)? string :
7263 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7268 /*************************************************
7270 *************************************************/
7272 /* Now and again we want to expand a string and be sure that the result is in a
7273 new bit of store. This function does that.
7274 Since we know it has been copied, the de-const cast is safe.
7276 Argument: the string to be expanded
7277 Returns: the expanded string, always in a new bit of store, or NULL
7281 expand_string_copy(const uschar *string)
7283 const uschar *yield = expand_cstring(string);
7284 if (yield == string) yield = string_copy(string);
7290 /*************************************************
7291 * Expand and interpret as an integer *
7292 *************************************************/
7294 /* Expand a string, and convert the result into an integer.
7297 string the string to be expanded
7298 isplus TRUE if a non-negative number is expected
7300 Returns: the integer value, or
7301 -1 for an expansion error ) in both cases, message in
7302 -2 for an integer interpretation error ) expand_string_message
7303 expand_string_message is set NULL for an OK integer
7307 expand_string_integer(uschar *string, BOOL isplus)
7309 return expanded_string_integer(expand_string(string), isplus);
7313 /*************************************************
7314 * Interpret string as an integer *
7315 *************************************************/
7317 /* Convert a string (that has already been expanded) into an integer.
7319 This function is used inside the expansion code.
7322 s the string to be expanded
7323 isplus TRUE if a non-negative number is expected
7325 Returns: the integer value, or
7326 -1 if string is NULL (which implies an expansion error)
7327 -2 for an integer interpretation error
7328 expand_string_message is set NULL for an OK integer
7331 static int_eximarith_t
7332 expanded_string_integer(const uschar *s, BOOL isplus)
7334 int_eximarith_t value;
7335 uschar *msg = US"invalid integer \"%s\"";
7338 /* If expansion failed, expand_string_message will be set. */
7340 if (s == NULL) return -1;
7342 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7343 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7344 systems, so we set it zero ourselves. */
7347 expand_string_message = NULL; /* Indicates no error */
7349 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7350 equal to 0. Unfortunately, people actually relied upon that, so preserve
7351 the behaviour explicitly. Stripping leading whitespace is a harmless
7352 noop change since strtol skips it anyway (provided that there is a number
7356 while (isspace(*s)) ++s;
7360 debug_printf("treating blank string as number 0\n");
7365 value = strtoll(CS s, CSS &endptr, 10);
7369 msg = US"integer expected but \"%s\" found";
7371 else if (value < 0 && isplus)
7373 msg = US"non-negative integer expected but \"%s\" found";
7377 switch (tolower(*endptr))
7382 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7387 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7388 else value *= 1024*1024;
7392 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7393 else value *= 1024*1024*1024;
7397 if (errno == ERANGE)
7398 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7401 while (isspace(*endptr)) endptr++;
7402 if (*endptr == 0) return value;
7406 expand_string_message = string_sprintf(CS msg, s);
7411 /* These values are usually fixed boolean values, but they are permitted to be
7415 addr address being routed
7416 mtype the module type
7417 mname the module name
7418 dbg_opt debug selectors
7419 oname the option name
7420 bvalue the router's boolean value
7421 svalue the router's string value
7422 rvalue where to put the returned value
7424 Returns: OK value placed in rvalue
7425 DEFER expansion failed
7429 exp_bool(address_item *addr,
7430 uschar *mtype, uschar *mname, unsigned dbg_opt,
7431 uschar *oname, BOOL bvalue,
7432 uschar *svalue, BOOL *rvalue)
7435 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7437 expanded = expand_string(svalue);
7438 if (expanded == NULL)
7440 if (expand_string_forcedfail)
7442 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7446 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7447 oname, mname, mtype, expand_string_message);
7448 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7452 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7455 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7457 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7461 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7462 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7472 /*************************************************
7473 **************************************************
7474 * Stand-alone test program *
7475 **************************************************
7476 *************************************************/
7482 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7484 int ovector[3*(EXPAND_MAXN+1)];
7485 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7486 ovector, nelem(ovector));
7487 BOOL yield = n >= 0;
7488 if (n == 0) n = EXPAND_MAXN + 1;
7492 expand_nmax = (setup < 0)? 0 : setup + 1;
7493 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7495 expand_nstring[expand_nmax] = subject + ovector[nn];
7496 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7504 int main(int argc, uschar **argv)
7507 uschar buffer[1024];
7509 debug_selector = D_v;
7510 debug_file = stderr;
7511 debug_fd = fileno(debug_file);
7512 big_buffer = malloc(big_buffer_size);
7514 for (i = 1; i < argc; i++)
7516 if (argv[i][0] == '+')
7518 debug_trace_memory = 2;
7521 if (isdigit(argv[i][0]))
7522 debug_selector = Ustrtol(argv[i], NULL, 0);
7524 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7528 eldap_default_servers = argv[i];
7531 mysql_servers = argv[i];
7534 pgsql_servers = argv[i];
7537 redis_servers = argv[i];
7541 else opt_perl_startup = argv[i];
7545 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7547 expand_nstring[1] = US"string 1....";
7548 expand_nlength[1] = 8;
7552 if (opt_perl_startup != NULL)
7555 printf("Starting Perl interpreter\n");
7556 errstr = init_perl(opt_perl_startup);
7559 printf("** error in perl_startup code: %s\n", errstr);
7560 return EXIT_FAILURE;
7563 #endif /* EXIM_PERL */
7565 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7567 void *reset_point = store_get(0);
7568 uschar *yield = expand_string(buffer);
7571 printf("%s\n", yield);
7572 store_reset(reset_point);
7576 if (search_find_defer) printf("search_find deferred\n");
7577 printf("Failed: %s\n", expand_string_message);
7578 if (expand_string_forcedfail) printf("Forced failure\n");
7592 /* End of expand.c */