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_catn(s, &size, &ptr, US", ", 2);
1673 s = string_cat(s, &size, &ptr, recipients_list[i].address);
1675 s[ptr] = 0; /* string_cat() leaves room */
1681 /*************************************************
1682 * Find value of a variable *
1683 *************************************************/
1685 /* The table of variables is kept in alphabetic order, so we can search it
1686 using a binary chop. The "choplen" variable is nothing to do with the binary
1690 name the name of the variable being sought
1691 exists_only TRUE if this is a def: test; passed on to find_header()
1692 skipping TRUE => skip any processing evaluation; this is not the same as
1693 exists_only because def: may test for values that are first
1695 newsize pointer to an int which is initially zero; if the answer is in
1696 a new memory buffer, *newsize is set to its size
1698 Returns: NULL if the variable does not exist, or
1699 a pointer to the variable's contents, or
1700 something non-NULL if exists_only is TRUE
1704 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1711 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1712 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1713 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1714 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1715 (this gave backwards compatibility at the changeover). There may be built-in
1716 variables whose names start acl_ but they should never start in this way. This
1717 slightly messy specification is a consequence of the history, needless to say.
1719 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1720 set, in which case give an error. */
1722 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1726 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1727 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1730 /* Handle $auth<n> variables. */
1732 if (Ustrncmp(name, "auth", 4) == 0)
1735 int n = Ustrtoul(name + 4, &endptr, 10);
1736 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1737 return !auth_vars[n-1] ? US"" : auth_vars[n-1];
1739 else if (Ustrncmp(name, "regex", 5) == 0)
1742 int n = Ustrtoul(name + 5, &endptr, 10);
1743 if (*endptr == 0 && n != 0 && n <= REGEX_VARS)
1744 return !regex_vars[n-1] ? US"" : regex_vars[n-1];
1747 /* For all other variables, search the table */
1749 if (!(vp = find_var_ent(name)))
1750 return NULL; /* Unknown variable name */
1752 /* Found an existing variable. If in skipping state, the value isn't needed,
1753 and we want to avoid processing (such as looking up the host name). */
1761 case vtype_filter_int:
1762 if (!filter_running) return NULL;
1766 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1770 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1774 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1778 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1782 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1785 case vtype_stringptr: /* Pointer to string */
1786 return (s = *((uschar **)(val))) ? s : US"";
1789 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1792 case vtype_load_avg:
1793 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1796 case vtype_host_lookup: /* Lookup if not done so */
1797 if (sender_host_name == NULL && sender_host_address != NULL &&
1798 !host_lookup_failed && host_name_lookup() == OK)
1799 host_build_sender_fullhost();
1800 return (sender_host_name == NULL)? US"" : sender_host_name;
1802 case vtype_localpart: /* Get local part from address */
1803 s = *((uschar **)(val));
1804 if (s == NULL) return US"";
1805 domain = Ustrrchr(s, '@');
1806 if (domain == NULL) return s;
1807 if (domain - s > sizeof(var_buffer) - 1)
1808 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1809 " in string expansion", sizeof(var_buffer));
1810 Ustrncpy(var_buffer, s, domain - s);
1811 var_buffer[domain - s] = 0;
1814 case vtype_domain: /* Get domain from address */
1815 s = *((uschar **)(val));
1816 if (s == NULL) return US"";
1817 domain = Ustrrchr(s, '@');
1818 return (domain == NULL)? US"" : domain + 1;
1820 case vtype_msgheaders:
1821 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1823 case vtype_msgheaders_raw:
1824 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1826 case vtype_msgbody: /* Pointer to msgbody string */
1827 case vtype_msgbody_end: /* Ditto, the end of the msg */
1828 ss = (uschar **)(val);
1829 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1832 off_t start_offset = SPOOL_DATA_START_OFFSET;
1833 int len = message_body_visible;
1834 if (len > message_size) len = message_size;
1835 *ss = body = store_malloc(len+1);
1837 if (vp->type == vtype_msgbody_end)
1839 struct stat statbuf;
1840 if (fstat(deliver_datafile, &statbuf) == 0)
1842 start_offset = statbuf.st_size - len;
1843 if (start_offset < SPOOL_DATA_START_OFFSET)
1844 start_offset = SPOOL_DATA_START_OFFSET;
1847 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
1848 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
1850 len = read(deliver_datafile, body, len);
1854 if (message_body_newlines) /* Separate loops for efficiency */
1856 { if (body[--len] == 0) body[len] = ' '; }
1859 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1862 return (*ss == NULL)? US"" : *ss;
1864 case vtype_todbsdin: /* BSD inbox time of day */
1865 return tod_stamp(tod_bsdin);
1867 case vtype_tode: /* Unix epoch time of day */
1868 return tod_stamp(tod_epoch);
1870 case vtype_todel: /* Unix epoch/usec time of day */
1871 return tod_stamp(tod_epoch_l);
1873 case vtype_todf: /* Full time of day */
1874 return tod_stamp(tod_full);
1876 case vtype_todl: /* Log format time of day */
1877 return tod_stamp(tod_log_bare); /* (without timezone) */
1879 case vtype_todzone: /* Time zone offset only */
1880 return tod_stamp(tod_zone);
1882 case vtype_todzulu: /* Zulu time */
1883 return tod_stamp(tod_zulu);
1885 case vtype_todlf: /* Log file datestamp tod */
1886 return tod_stamp(tod_log_datestamp_daily);
1888 case vtype_reply: /* Get reply address */
1889 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1891 if (s != NULL) while (isspace(*s)) s++;
1892 if (s == NULL || *s == 0)
1894 *newsize = 0; /* For the *s==0 case */
1895 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1900 while (isspace(*s)) s++;
1901 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1902 while (t > s && isspace(t[-1])) t--;
1905 return (s == NULL)? US"" : s;
1907 case vtype_string_func:
1909 uschar * (*fn)() = val;
1916 sprintf(CS var_buffer, "%d",
1917 receive_statvfs(val == (void *)TRUE, &inodes));
1924 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1925 sprintf(CS var_buffer, "%d", inodes);
1930 return *(void **)val ? US"<cert>" : US"";
1932 #ifndef DISABLE_DKIM
1934 return dkim_exim_expand_query((int)(long)val);
1939 return NULL; /* Unknown variable. Silences static checkers. */
1946 modify_variable(uschar *name, void * value)
1949 if ((vp = find_var_ent(name))) vp->value = value;
1950 return; /* Unknown variable name, fail silently */
1957 /*************************************************
1958 * Read and expand substrings *
1959 *************************************************/
1961 /* This function is called to read and expand argument substrings for various
1962 expansion items. Some have a minimum requirement that is less than the maximum;
1963 in these cases, the first non-present one is set to NULL.
1966 sub points to vector of pointers to set
1967 n maximum number of substrings
1969 sptr points to current string pointer
1970 skipping the skipping flag
1971 check_end if TRUE, check for final '}'
1972 name name of item, for error message
1973 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1976 Returns: 0 OK; string pointer updated
1977 1 curly bracketing error (too few arguments)
1978 2 too many arguments (only if check_end is set); message set
1979 3 other error (expansion failure)
1983 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1984 BOOL check_end, uschar *name, BOOL *resetok)
1987 const uschar *s = *sptr;
1989 while (isspace(*s)) s++;
1990 for (i = 0; i < n; i++)
1996 expand_string_message = string_sprintf("Not enough arguments for '%s' "
1997 "(min is %d)", name, m);
2003 if (!(sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok)))
2005 if (*s++ != '}') return 1;
2006 while (isspace(*s)) s++;
2008 if (check_end && *s++ != '}')
2012 expand_string_message = string_sprintf("Too many arguments for '%s' "
2013 "(max is %d)", name, n);
2016 expand_string_message = string_sprintf("missing '}' after '%s'", name);
2027 /*************************************************
2028 * Elaborate message for bad variable *
2029 *************************************************/
2031 /* For the "unknown variable" message, take a look at the variable's name, and
2032 give additional information about possible ACL variables. The extra information
2033 is added on to expand_string_message.
2035 Argument: the name of the variable
2040 check_variable_error_message(uschar *name)
2042 if (Ustrncmp(name, "acl_", 4) == 0)
2043 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2044 (name[4] == 'c' || name[4] == 'm')?
2046 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2047 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2049 US"user-defined ACL variables must start acl_c or acl_m");
2055 Load args from sub array to globals, and call acl_check().
2056 Sub array will be corrupted on return.
2058 Returns: OK access is granted by an ACCEPT verb
2059 DISCARD access is (apparently) granted by a DISCARD verb
2060 FAIL access is denied
2061 FAIL_DROP access is denied; drop the connection
2062 DEFER can't tell at the moment
2066 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2069 int sav_narg = acl_narg;
2071 uschar * dummy_logmsg;
2072 extern int acl_where;
2074 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2075 for (i = 0; i < nsub && sub[i+1]; i++)
2077 uschar * tmp = acl_arg[i];
2078 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2079 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2084 sub[i+1] = acl_arg[i];
2085 acl_arg[i++] = NULL;
2089 debug_printf("expanding: acl: %s arg: %s%s\n",
2091 acl_narg>0 ? acl_arg[0] : US"<none>",
2092 acl_narg>1 ? " +more" : "");
2094 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2096 for (i = 0; i < nsub; i++)
2097 acl_arg[i] = sub[i+1]; /* restore old args */
2098 acl_narg = sav_narg;
2106 /*************************************************
2107 * Read and evaluate a condition *
2108 *************************************************/
2112 s points to the start of the condition text
2113 resetok points to a BOOL which is written false if it is unsafe to
2114 free memory. Certain condition types (acl) may have side-effect
2115 allocation which must be preserved.
2116 yield points to a BOOL to hold the result of the condition test;
2117 if NULL, we are just reading through a condition that is
2118 part of an "or" combination to check syntax, or in a state
2119 where the answer isn't required
2121 Returns: a pointer to the first character after the condition, or
2125 static const uschar *
2126 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2128 BOOL testfor = TRUE;
2129 BOOL tempcond, combined_cond;
2131 BOOL sub2_honour_dollar = TRUE;
2132 int i, rc, cond_type, roffset;
2133 int_eximarith_t num[2];
2134 struct stat statbuf;
2136 const uschar *sub[10];
2139 const uschar *rerror;
2143 while (isspace(*s)) s++;
2144 if (*s == '!') { testfor = !testfor; s++; } else break;
2147 /* Numeric comparisons are symbolic */
2149 if (*s == '=' || *s == '>' || *s == '<')
2161 /* All other conditions are named */
2163 else s = read_name(name, 256, s, US"_");
2165 /* If we haven't read a name, it means some non-alpha character is first. */
2169 expand_string_message = string_sprintf("condition name expected, "
2170 "but found \"%.16s\"", s);
2174 /* Find which condition we are dealing with, and switch on it */
2176 cond_type = chop_match(name, cond_table, nelem(cond_table));
2179 /* def: tests for a non-empty variable, or for the existence of a header. If
2180 yield == NULL we are in a skipping state, and don't care about the answer. */
2185 expand_string_message = US"\":\" expected after \"def\"";
2189 s = read_name(name, 256, s+1, US"_");
2191 /* Test for a header's existence. If the name contains a closing brace
2192 character, this may be a user error where the terminating colon has been
2193 omitted. Set a flag to adjust a subsequent error message in this case. */
2195 if (Ustrncmp(name, "h_", 2) == 0 ||
2196 Ustrncmp(name, "rh_", 3) == 0 ||
2197 Ustrncmp(name, "bh_", 3) == 0 ||
2198 Ustrncmp(name, "header_", 7) == 0 ||
2199 Ustrncmp(name, "rheader_", 8) == 0 ||
2200 Ustrncmp(name, "bheader_", 8) == 0)
2202 s = read_header_name(name, 256, s);
2203 /* {-for-text-editors */
2204 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2205 if (yield != NULL) *yield =
2206 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2209 /* Test for a variable's having a non-empty value. A non-existent variable
2210 causes an expansion failure. */
2214 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2217 expand_string_message = (name[0] == 0)?
2218 string_sprintf("variable name omitted after \"def:\"") :
2219 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2220 check_variable_error_message(name);
2223 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2229 /* first_delivery tests for first delivery attempt */
2231 case ECOND_FIRST_DELIVERY:
2232 if (yield != NULL) *yield = deliver_firsttime == testfor;
2236 /* queue_running tests for any process started by a queue runner */
2238 case ECOND_QUEUE_RUNNING:
2239 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2243 /* exists: tests for file existence
2244 isip: tests for any IP address
2245 isip4: tests for an IPv4 address
2246 isip6: tests for an IPv6 address
2247 pam: does PAM authentication
2248 radius: does RADIUS authentication
2249 ldapauth: does LDAP authentication
2250 pwcheck: does Cyrus SASL pwcheck authentication
2259 case ECOND_LDAPAUTH:
2262 while (isspace(*s)) s++;
2263 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2265 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2266 if (sub[0] == NULL) return NULL;
2267 /* {-for-text-editors */
2268 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2270 if (yield == NULL) return s; /* No need to run the test if skipping */
2275 if ((expand_forbid & RDO_EXISTS) != 0)
2277 expand_string_message = US"File existence tests are not permitted";
2280 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2286 rc = string_is_ip_address(sub[0], NULL);
2287 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2288 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2291 /* Various authentication tests - all optionally compiled */
2295 rc = auth_call_pam(sub[0], &expand_string_message);
2298 goto COND_FAILED_NOT_COMPILED;
2299 #endif /* SUPPORT_PAM */
2302 #ifdef RADIUS_CONFIG_FILE
2303 rc = auth_call_radius(sub[0], &expand_string_message);
2306 goto COND_FAILED_NOT_COMPILED;
2307 #endif /* RADIUS_CONFIG_FILE */
2309 case ECOND_LDAPAUTH:
2312 /* Just to keep the interface the same */
2314 int old_pool = store_pool;
2315 store_pool = POOL_SEARCH;
2316 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2317 &expand_string_message, &do_cache);
2318 store_pool = old_pool;
2322 goto COND_FAILED_NOT_COMPILED;
2323 #endif /* LOOKUP_LDAP */
2326 #ifdef CYRUS_PWCHECK_SOCKET
2327 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2330 goto COND_FAILED_NOT_COMPILED;
2331 #endif /* CYRUS_PWCHECK_SOCKET */
2333 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2334 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2336 if (rc == ERROR || rc == DEFER) return NULL;
2337 *yield = (rc == OK) == testfor;
2343 /* call ACL (in a conditional context). Accept true, deny false.
2344 Defer is a forced-fail. Anything set by message= goes to $value.
2345 Up to ten parameters are used; we use the braces round the name+args
2346 like the saslauthd condition does, to permit a variable number of args.
2347 See also the expansion-item version EITEM_ACL and the traditional
2348 acl modifier ACLC_ACL.
2349 Since the ACL may allocate new global variables, tell our caller to not
2354 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2362 while (isspace(*s)) s++;
2363 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2365 switch(read_subs(sub, nelem(sub), 1,
2366 &s, yield == NULL, TRUE, US"acl", resetok))
2368 case 1: expand_string_message = US"too few arguments or bracketing "
2371 case 3: return NULL;
2374 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2375 if (yield != NULL) switch(eval_acl(sub, nelem(sub), &user_msg))
2380 lookup_value = NULL;
2383 lookup_value = string_cat(NULL, &size, &ptr, user_msg);
2384 lookup_value[ptr] = '\0';
2386 *yield = cond == testfor;
2390 expand_string_forcedfail = TRUE;
2393 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2400 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2402 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2404 However, the last two are optional. That is why the whole set is enclosed
2405 in their own set of braces. */
2407 case ECOND_SASLAUTHD:
2408 #ifndef CYRUS_SASLAUTHD_SOCKET
2409 goto COND_FAILED_NOT_COMPILED;
2413 while (isspace(*s)) s++;
2414 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2415 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2418 case 1: expand_string_message = US"too few arguments or bracketing "
2419 "error for saslauthd";
2421 case 3: return NULL;
2423 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2426 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2427 &expand_string_message);
2428 if (rc == ERROR || rc == DEFER) return NULL;
2429 *yield = (rc == OK) == testfor;
2433 #endif /* CYRUS_SASLAUTHD_SOCKET */
2436 /* symbolic operators for numeric and string comparison, and a number of
2437 other operators, all requiring two arguments.
2439 crypteq: encrypts plaintext and compares against an encrypted text,
2440 using crypt(), crypt16(), MD5 or SHA-1
2441 inlist/inlisti: checks if first argument is in the list of the second
2442 match: does a regular expression match and sets up the numerical
2443 variables if it succeeds
2444 match_address: matches in an address list
2445 match_domain: matches in a domain list
2446 match_ip: matches a host list that is restricted to IP addresses
2447 match_local_part: matches in a local part list
2450 case ECOND_MATCH_ADDRESS:
2451 case ECOND_MATCH_DOMAIN:
2452 case ECOND_MATCH_IP:
2453 case ECOND_MATCH_LOCAL_PART:
2454 #ifndef EXPAND_LISTMATCH_RHS
2455 sub2_honour_dollar = FALSE;
2464 case ECOND_NUM_L: /* Numerical comparisons */
2471 case ECOND_STR_LT: /* String comparisons */
2482 for (i = 0; i < 2; i++)
2484 /* Sometimes, we don't expand substrings; too many insecure configurations
2485 created using match_address{}{} and friends, where the second param
2486 includes information from untrustworthy sources. */
2487 BOOL honour_dollar = TRUE;
2488 if ((i > 0) && !sub2_honour_dollar)
2489 honour_dollar = FALSE;
2491 while (isspace(*s)) s++;
2494 if (i == 0) goto COND_FAILED_CURLY_START;
2495 expand_string_message = string_sprintf("missing 2nd string in {} "
2496 "after \"%s\"", name);
2499 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2500 honour_dollar, resetok);
2501 if (sub[i] == NULL) return NULL;
2502 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2504 /* Convert to numerical if required; we know that the names of all the
2505 conditions that compare numbers do not start with a letter. This just saves
2506 checking for them individually. */
2508 if (!isalpha(name[0]) && yield != NULL)
2513 debug_printf("empty string cast to zero for numerical comparison\n");
2517 num[i] = expanded_string_integer(sub[i], FALSE);
2518 if (expand_string_message != NULL) return NULL;
2522 /* Result not required */
2524 if (yield == NULL) return s;
2526 /* Do an appropriate comparison */
2532 tempcond = (num[0] == num[1]);
2536 tempcond = (num[0] > num[1]);
2540 tempcond = (num[0] >= num[1]);
2544 tempcond = (num[0] < num[1]);
2548 tempcond = (num[0] <= num[1]);
2552 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2556 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2560 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2564 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2568 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2572 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2576 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2580 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2584 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2588 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2591 case ECOND_MATCH: /* Regular expression match */
2592 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2596 expand_string_message = string_sprintf("regular expression error in "
2597 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2600 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2603 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2604 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2605 goto MATCHED_SOMETHING;
2607 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2608 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2609 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2610 goto MATCHED_SOMETHING;
2612 case ECOND_MATCH_IP: /* Match IP address in a host list */
2613 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2615 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2621 unsigned int *nullcache = NULL;
2622 check_host_block cb;
2624 cb.host_name = US"";
2625 cb.host_address = sub[0];
2627 /* If the host address starts off ::ffff: it is an IPv6 address in
2628 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2631 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2632 cb.host_address + 7 : cb.host_address;
2634 rc = match_check_list(
2635 &sub[1], /* the list */
2636 0, /* separator character */
2637 &hostlist_anchor, /* anchor pointer */
2638 &nullcache, /* cache pointer */
2639 check_host, /* function for testing */
2640 &cb, /* argument for function */
2641 MCL_HOST, /* type of check */
2642 sub[0], /* text for debugging */
2643 NULL); /* where to pass back data */
2645 goto MATCHED_SOMETHING;
2647 case ECOND_MATCH_LOCAL_PART:
2648 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2649 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2664 expand_string_message = string_sprintf("unable to complete match "
2665 "against \"%s\": %s", sub[1], search_error_message);
2671 /* Various "encrypted" comparisons. If the second string starts with
2672 "{" then an encryption type is given. Default to crypt() or crypt16()
2673 (build-time choice). */
2674 /* }-for-text-editors */
2677 #ifndef SUPPORT_CRYPTEQ
2678 goto COND_FAILED_NOT_COMPILED;
2680 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2682 int sublen = Ustrlen(sub[1]+5);
2687 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
2689 /* If the length that we are comparing against is 24, the MD5 digest
2690 is expressed as a base64 string. This is the way LDAP does it. However,
2691 some other software uses a straightforward hex representation. We assume
2692 this if the length is 32. Other lengths fail. */
2696 uschar *coded = b64encode(digest, 16);
2697 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2698 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2699 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2701 else if (sublen == 32)
2705 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2707 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2708 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2709 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2713 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2714 "fail\n crypted=%s\n", sub[1]+5);
2719 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2721 int sublen = Ustrlen(sub[1]+6);
2726 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
2728 /* If the length that we are comparing against is 28, assume the SHA1
2729 digest is expressed as a base64 string. If the length is 40, assume a
2730 straightforward hex representation. Other lengths fail. */
2734 uschar *coded = b64encode(digest, 20);
2735 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2736 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2737 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2739 else if (sublen == 40)
2743 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2745 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2746 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2747 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2751 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2752 "fail\n crypted=%s\n", sub[1]+6);
2757 else /* {crypt} or {crypt16} and non-{ at start */
2758 /* }-for-text-editors */
2763 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2768 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2773 else if (sub[1][0] == '{') /* }-for-text-editors */
2775 expand_string_message = string_sprintf("unknown encryption mechanism "
2776 "in \"%s\"", sub[1]);
2782 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2783 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2784 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2788 #define XSTR(s) STR(s)
2789 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2790 " subject=%s\n crypted=%s\n",
2791 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
2796 /* If the encrypted string contains fewer than two characters (for the
2797 salt), force failure. Otherwise we get false positives: with an empty
2798 string the yield of crypt() is an empty string! */
2801 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
2802 else if (errno == EINVAL)
2806 expand_string_message = string_sprintf("crypt error: %s\n",
2807 US strerror(errno));
2812 #endif /* SUPPORT_CRYPTEQ */
2817 const uschar * list = sub[1];
2819 uschar *save_iterate_item = iterate_item;
2820 int (*compare)(const uschar *, const uschar *);
2822 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2825 compare = cond_type == ECOND_INLISTI
2826 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2828 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2829 if (compare(sub[0], iterate_item) == 0)
2834 iterate_item = save_iterate_item;
2837 } /* Switch for comparison conditions */
2839 *yield = tempcond == testfor;
2840 return s; /* End of comparison conditions */
2843 /* and/or: computes logical and/or of several conditions */
2847 subcondptr = (yield == NULL)? NULL : &tempcond;
2848 combined_cond = (cond_type == ECOND_AND);
2850 while (isspace(*s)) s++;
2851 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2855 while (isspace(*s)) s++;
2856 /* {-for-text-editors */
2857 if (*s == '}') break;
2858 if (*s != '{') /* }-for-text-editors */
2860 expand_string_message = string_sprintf("each subcondition "
2861 "inside an \"%s{...}\" condition must be in its own {}", name);
2865 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2867 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2868 expand_string_message, name);
2871 while (isspace(*s)) s++;
2873 /* {-for-text-editors */
2876 /* {-for-text-editors */
2877 expand_string_message = string_sprintf("missing } at end of condition "
2878 "inside \"%s\" group", name);
2884 if (cond_type == ECOND_AND)
2886 combined_cond &= tempcond;
2887 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2888 } /* evaluate any more */
2891 combined_cond |= tempcond;
2892 if (combined_cond) subcondptr = NULL; /* once true, don't */
2893 } /* evaluate any more */
2897 if (yield != NULL) *yield = (combined_cond == testfor);
2901 /* forall/forany: iterates a condition with different values */
2906 const uschar * list;
2908 uschar *save_iterate_item = iterate_item;
2910 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2912 while (isspace(*s)) s++;
2913 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2914 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2915 if (sub[0] == NULL) return NULL;
2916 /* {-for-text-editors */
2917 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2919 while (isspace(*s)) s++;
2920 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2924 /* Call eval_condition once, with result discarded (as if scanning a
2925 "false" part). This allows us to find the end of the condition, because if
2926 the list it empty, we won't actually evaluate the condition for real. */
2928 if (!(s = eval_condition(sub[1], resetok, NULL)))
2930 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2931 expand_string_message, name);
2934 while (isspace(*s)) s++;
2936 /* {-for-text-editors */
2939 /* {-for-text-editors */
2940 expand_string_message = string_sprintf("missing } at end of condition "
2941 "inside \"%s\"", name);
2945 if (yield != NULL) *yield = !testfor;
2947 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2949 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2950 if (!eval_condition(sub[1], resetok, &tempcond))
2952 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2953 expand_string_message, name);
2954 iterate_item = save_iterate_item;
2957 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2958 tempcond? "true":"false");
2960 if (yield != NULL) *yield = (tempcond == testfor);
2961 if (tempcond == (cond_type == ECOND_FORANY)) break;
2964 iterate_item = save_iterate_item;
2969 /* The bool{} expansion condition maps a string to boolean.
2970 The values supported should match those supported by the ACL condition
2971 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2972 of true/false. Note that Router "condition" rules have a different
2973 interpretation, where general data can be used and only a few values
2975 Note that readconf.c boolean matching, for boolean configuration options,
2976 only matches true/yes/false/no.
2977 The bool_lax{} condition matches the Router logic, which is much more
2980 case ECOND_BOOL_LAX:
2986 BOOL boolvalue = FALSE;
2987 while (isspace(*s)) s++;
2988 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2989 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2990 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2992 case 1: expand_string_message = string_sprintf(
2993 "too few arguments or bracketing error for %s",
2997 case 3: return NULL;
3000 while (isspace(*t)) t++;
3004 /* trailing whitespace: seems like a good idea to ignore it too */
3006 while (isspace(*t2)) t2--;
3007 if (t2 != (t + len))
3014 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
3015 /* logic for the lax case from expand_check_condition(), which also does
3016 expands, and the logic is both short and stable enough that there should
3017 be no maintenance burden from replicating it. */
3021 ? Ustrspn(t+1, "0123456789") == len-1
3022 : Ustrspn(t, "0123456789") == len)
3024 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3025 /* expand_check_condition only does a literal string "0" check */
3026 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3029 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3031 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3033 else if (cond_type == ECOND_BOOL_LAX)
3037 expand_string_message = string_sprintf("unrecognised boolean "
3041 if (yield != NULL) *yield = (boolvalue == testfor);
3045 /* Unknown condition */
3048 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3050 } /* End switch on condition type */
3052 /* Missing braces at start and end of data */
3054 COND_FAILED_CURLY_START:
3055 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3058 COND_FAILED_CURLY_END:
3059 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3063 /* A condition requires code that is not compiled */
3065 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3066 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3067 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3068 COND_FAILED_NOT_COMPILED:
3069 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3078 /*************************************************
3079 * Save numerical variables *
3080 *************************************************/
3082 /* This function is called from items such as "if" that want to preserve and
3083 restore the numbered variables.
3086 save_expand_string points to an array of pointers to set
3087 save_expand_nlength points to an array of ints for the lengths
3089 Returns: the value of expand max to save
3093 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3096 for (i = 0; i <= expand_nmax; i++)
3098 save_expand_nstring[i] = expand_nstring[i];
3099 save_expand_nlength[i] = expand_nlength[i];
3106 /*************************************************
3107 * Restore numerical variables *
3108 *************************************************/
3110 /* This function restored saved values of numerical strings.
3113 save_expand_nmax the number of strings to restore
3114 save_expand_string points to an array of pointers
3115 save_expand_nlength points to an array of ints
3121 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3122 int *save_expand_nlength)
3125 expand_nmax = save_expand_nmax;
3126 for (i = 0; i <= expand_nmax; i++)
3128 expand_nstring[i] = save_expand_nstring[i];
3129 expand_nlength[i] = save_expand_nlength[i];
3137 /*************************************************
3138 * Handle yes/no substrings *
3139 *************************************************/
3141 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3142 alternative substrings that depend on whether or not the condition was true,
3143 or the lookup or extraction succeeded. The substrings always have to be
3144 expanded, to check their syntax, but "skipping" is set when the result is not
3145 needed - this avoids unnecessary nested lookups.
3148 skipping TRUE if we were skipping when this item was reached
3149 yes TRUE if the first string is to be used, else use the second
3150 save_lookup a value to put back into lookup_value before the 2nd expansion
3151 sptr points to the input string pointer
3152 yieldptr points to the output string pointer
3153 sizeptr points to the output string size
3154 ptrptr points to the output string pointer
3155 type "lookup", "if", "extract", "run", "env", "listextract" or
3156 "certextract" for error message
3157 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3160 Returns: 0 OK; lookup_value has been reset to save_lookup
3162 2 expansion failed because of bracketing error
3166 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3167 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3170 const uschar *s = *sptr; /* Local value */
3171 uschar *sub1, *sub2;
3172 const uschar * errwhere;
3174 /* If there are no following strings, we substitute the contents of $value for
3175 lookups and for extractions in the success case. For the ${if item, the string
3176 "true" is substituted. In the fail case, nothing is substituted for all three
3179 while (isspace(*s)) s++;
3184 if (yes) *yieldptr = string_catn(*yieldptr, sizeptr, ptrptr, US"true", 4);
3188 if (yes && lookup_value)
3189 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value);
3190 lookup_value = save_lookup;
3196 /* The first following string must be braced. */
3200 errwhere = US"'yes' part did not start with '{'";
3204 /* Expand the first substring. Forced failures are noticed only if we actually
3205 want this string. Set skipping in the call in the fail case (this will always
3206 be the case if we were already skipping). */
3208 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3209 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3210 expand_string_forcedfail = FALSE;
3213 errwhere = US"'yes' part did not end with '}'";
3217 /* If we want the first string, add it to the output */
3220 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1);
3222 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3223 $value to what it was at the start of the item, so that it has this value
3224 during the second string expansion. For the call from "if" or "run" to this
3225 function, save_lookup is set to lookup_value, so that this statement does
3228 lookup_value = save_lookup;
3230 /* There now follows either another substring, or "fail", or nothing. This
3231 time, forced failures are noticed only if we want the second string. We must
3232 set skipping in the nested call if we don't want this string, or if we were
3233 already skipping. */
3235 while (isspace(*s)) s++;
3238 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3239 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3240 expand_string_forcedfail = FALSE;
3243 errwhere = US"'no' part did not start with '{'";
3247 /* If we want the second string, add it to the output */
3250 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2);
3253 /* If there is no second string, but the word "fail" is present when the use of
3254 the second string is wanted, set a flag indicating it was a forced failure
3255 rather than a syntactic error. Swallow the terminating } in case this is nested
3256 inside another lookup or if or extract. */
3261 /* deconst cast ok here as source is s anyway */
3262 s = US read_name(name, sizeof(name), s, US"_");
3263 if (Ustrcmp(name, "fail") == 0)
3265 if (!yes && !skipping)
3267 while (isspace(*s)) s++;
3270 errwhere = US"did not close with '}' after forcedfail";
3273 expand_string_message =
3274 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3275 expand_string_forcedfail = TRUE;
3281 expand_string_message =
3282 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3287 /* All we have to do now is to check on the final closing brace. */
3289 while (isspace(*s)) s++;
3292 errwhere = US"did not close with '}'";
3298 /* Update the input pointer value before returning */
3303 /* Get here if there is a bracketing failure */
3304 expand_string_message = string_sprintf(
3305 "curly-bracket problem in conditional yes/no parsing: %s\n"
3306 " remaining string is '%s'", errwhere, --s);
3311 /* Get here for other failures */
3319 /*************************************************
3320 * Handle MD5 or SHA-1 computation for HMAC *
3321 *************************************************/
3323 /* These are some wrapping functions that enable the HMAC code to be a bit
3324 cleaner. A good compiler will spot the tail recursion.
3327 type HMAC_MD5 or HMAC_SHA1
3328 remaining are as for the cryptographic hash functions
3334 chash_start(int type, void *base)
3336 if (type == HMAC_MD5)
3337 md5_start((md5 *)base);
3339 sha1_start((hctx *)base);
3343 chash_mid(int type, void *base, uschar *string)
3345 if (type == HMAC_MD5)
3346 md5_mid((md5 *)base, string);
3348 sha1_mid((hctx *)base, string);
3352 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3354 if (type == HMAC_MD5)
3355 md5_end((md5 *)base, string, length, digest);
3357 sha1_end((hctx *)base, string, length, digest);
3364 /********************************************************
3365 * prvs: Get last three digits of days since Jan 1, 1970 *
3366 ********************************************************/
3368 /* This is needed to implement the "prvs" BATV reverse
3371 Argument: integer "days" offset to add or substract to
3372 or from the current number of days.
3374 Returns: pointer to string containing the last three
3375 digits of the number of days since Jan 1, 1970,
3376 modified by the offset argument, NULL if there
3377 was an error in the conversion.
3382 prvs_daystamp(int day_offset)
3384 uschar *days = store_get(32); /* Need at least 24 for cases */
3385 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3386 (time(NULL) + day_offset*86400)/86400);
3387 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3392 /********************************************************
3393 * prvs: perform HMAC-SHA1 computation of prvs bits *
3394 ********************************************************/
3396 /* This is needed to implement the "prvs" BATV reverse
3400 address RFC2821 Address to use
3401 key The key to use (must be less than 64 characters
3403 key_num Single-digit key number to use. Defaults to
3406 Returns: pointer to string containing the first three
3407 bytes of the final hash in hex format, NULL if
3408 there was an error in the process.
3412 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3414 uschar *hash_source, *p;
3415 int size = 0,offset = 0,i;
3417 uschar innerhash[20];
3418 uschar finalhash[20];
3419 uschar innerkey[64];
3420 uschar outerkey[64];
3421 uschar *finalhash_hex = store_get(40);
3423 if (key_num == NULL)
3426 if (Ustrlen(key) > 64)
3429 hash_source = string_catn(NULL, &size, &offset, key_num, 1);
3430 hash_source = string_catn(hash_source, &size, &offset, daystamp, 3);
3431 hash_source = string_cat(hash_source, &size, &offset, address);
3432 hash_source[offset] = '\0';
3434 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3436 memset(innerkey, 0x36, 64);
3437 memset(outerkey, 0x5c, 64);
3439 for (i = 0; i < Ustrlen(key); i++)
3441 innerkey[i] ^= key[i];
3442 outerkey[i] ^= key[i];
3445 chash_start(HMAC_SHA1, &h);
3446 chash_mid(HMAC_SHA1, &h, innerkey);
3447 chash_end(HMAC_SHA1, &h, hash_source, offset, innerhash);
3449 chash_start(HMAC_SHA1, &h);
3450 chash_mid(HMAC_SHA1, &h, outerkey);
3451 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3454 for (i = 0; i < 3; i++)
3456 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3457 *p++ = hex_digits[finalhash[i] & 0x0f];
3461 return finalhash_hex;
3467 /*************************************************
3468 * Join a file onto the output string *
3469 *************************************************/
3471 /* This is used for readfile/readsock and after a run expansion.
3472 It joins the contents of a file onto the output string, globally replacing
3473 newlines with a given string (optionally).
3477 yield pointer to the expandable string
3478 sizep pointer to the current size
3479 ptrp pointer to the current position
3480 eol newline replacement string, or NULL
3482 Returns: new value of string pointer
3486 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3488 int eollen = eol ? Ustrlen(eol) : 0;
3489 uschar buffer[1024];
3491 while (Ufgets(buffer, sizeof(buffer), f))
3493 int len = Ustrlen(buffer);
3494 if (eol && buffer[len-1] == '\n') len--;
3495 yield = string_catn(yield, sizep, ptrp, buffer, len);
3496 if (buffer[len] != 0)
3497 yield = string_catn(yield, sizep, ptrp, eol, eollen);
3500 if (yield) yield[*ptrp] = 0;
3508 /*************************************************
3509 * Evaluate numeric expression *
3510 *************************************************/
3512 /* This is a set of mutually recursive functions that evaluate an arithmetic
3513 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3514 these functions that is called from elsewhere is eval_expr, whose interface is:
3517 sptr pointer to the pointer to the string - gets updated
3518 decimal TRUE if numbers are to be assumed decimal
3519 error pointer to where to put an error message - must be NULL on input
3520 endket TRUE if ')' must terminate - FALSE for external call
3522 Returns: on success: the value of the expression, with *error still NULL
3523 on failure: an undefined value, with *error = a message
3526 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3529 static int_eximarith_t
3530 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3533 int_eximarith_t x = eval_op_or(&s, decimal, error);
3539 *error = US"expecting closing parenthesis";
3541 while (isspace(*(++s)));
3543 else if (*s != 0) *error = US"expecting operator";
3550 static int_eximarith_t
3551 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3556 while (isspace(*s)) s++;
3561 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3563 switch (tolower(*s))
3566 case 'k': n *= 1024; s++; break;
3567 case 'm': n *= 1024*1024; s++; break;
3568 case 'g': n *= 1024*1024*1024; s++; break;
3570 while (isspace (*s)) s++;
3575 n = eval_expr(&s, decimal, error, 1);
3579 *error = US"expecting number or opening parenthesis";
3587 static int_eximarith_t
3588 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3592 while (isspace(*s)) s++;
3593 if (*s == '+' || *s == '-' || *s == '~')
3596 x = eval_op_unary(&s, decimal, error);
3597 if (op == '-') x = -x;
3598 else if (op == '~') x = ~x;
3602 x = eval_number(&s, decimal, error);
3609 static int_eximarith_t
3610 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3613 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3616 while (*s == '*' || *s == '/' || *s == '%')
3619 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3620 if (*error != NULL) break;
3621 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3622 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3623 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3624 * -N*M is INT_MIN will yielf INT_MIN.
3625 * Since we don't support floating point, this is somewhat simpler.
3626 * Ideally, we'd return an error, but since we overflow for all other
3627 * arithmetic, consistency suggests otherwise, but what's the correct value
3628 * to use? There is none.
3629 * The C standard guarantees overflow for unsigned arithmetic but signed
3630 * overflow invokes undefined behaviour; in practice, this is overflow
3631 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3632 * that long/longlong larger than int are available, or we could just work
3633 * with larger types. We should consider whether to guarantee 32bit eval
3634 * and 64-bit working variables, with errors returned. For now ...
3635 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3636 * can just let the other invalid results occur otherwise, as they have
3637 * until now. For this one case, we can coerce.
3639 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3642 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3643 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3653 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3669 static int_eximarith_t
3670 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3673 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3676 while (*s == '+' || *s == '-')
3679 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3681 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)
3682 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
3683 { /* over-conservative check */
3685 ? US"overflow in sum" : US"overflow in difference";
3688 if (op == '+') x += y; else x -= y;
3696 static int_eximarith_t
3697 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3700 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3703 while ((*s == '<' || *s == '>') && s[1] == s[0])
3708 y = eval_op_sum(&s, decimal, error);
3709 if (*error != NULL) break;
3710 if (op == '<') x <<= y; else x >>= y;
3718 static int_eximarith_t
3719 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3722 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3729 y = eval_op_shift(&s, decimal, error);
3730 if (*error != NULL) break;
3739 static int_eximarith_t
3740 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3743 int_eximarith_t x = eval_op_and(&s, decimal, error);
3750 y = eval_op_and(&s, decimal, error);
3751 if (*error != NULL) break;
3760 static int_eximarith_t
3761 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3764 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3771 y = eval_op_xor(&s, decimal, error);
3772 if (*error != NULL) break;
3782 /*************************************************
3784 *************************************************/
3786 /* Returns either an unchanged string, or the expanded string in stacking pool
3787 store. Interpreted sequences are:
3789 \... normal escaping rules
3790 $name substitutes the variable
3792 ${op:string} operates on the expanded string value
3793 ${item{arg1}{arg2}...} expands the args and then does the business
3794 some literal args are not enclosed in {}
3796 There are now far too many operators and item types to make it worth listing
3797 them here in detail any more.
3799 We use an internal routine recursively to handle embedded substrings. The
3800 external function follows. The yield is NULL if the expansion failed, and there
3801 are two cases: if something collapsed syntactically, or if "fail" was given
3802 as the action on a lookup failure. These can be distinguised by looking at the
3803 variable expand_string_forcedfail, which is TRUE in the latter case.
3805 The skipping flag is set true when expanding a substring that isn't actually
3806 going to be used (after "if" or "lookup") and it prevents lookups from
3807 happening lower down.
3809 Store usage: At start, a store block of the length of the input plus 64
3810 is obtained. This is expanded as necessary by string_cat(), which might have to
3811 get a new block, or might be able to expand the original. At the end of the
3812 function we can release any store above that portion of the yield block that
3813 was actually used. In many cases this will be optimal.
3815 However: if the first item in the expansion is a variable name or header name,
3816 we reset the store before processing it; if the result is in fresh store, we
3817 use that without copying. This is helpful for expanding strings like
3818 $message_headers which can get very long.
3820 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3821 since resetting the store at the end of the expansion will free store that was
3822 allocated by the plugin code as well as the slop after the expanded string. So
3823 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3824 and, given the acl condition, ${if }. This is an unfortunate consequence of
3825 string expansion becoming too powerful.
3828 string the string to be expanded
3829 ket_ends true if expansion is to stop at }
3830 left if not NULL, a pointer to the first character after the
3831 expansion is placed here (typically used with ket_ends)
3832 skipping TRUE for recursive calls when the value isn't actually going
3833 to be used (to allow for optimisation)
3834 honour_dollar TRUE if $ is to be expanded,
3835 FALSE if it's just another character
3836 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3839 Returns: NULL if expansion fails:
3840 expand_string_forcedfail is set TRUE if failure was forced
3841 expand_string_message contains a textual error message
3842 a pointer to the expanded string on success
3846 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3847 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3850 int size = Ustrlen(string)+ 64;
3851 uschar *yield = store_get(size);
3853 const uschar *s = string;
3854 uschar *save_expand_nstring[EXPAND_MAXN+1];
3855 int save_expand_nlength[EXPAND_MAXN+1];
3856 BOOL resetok = TRUE;
3859 debug_printf("%s: %s\n", skipping ? " scanning" : "considering", string);
3861 expand_string_forcedfail = FALSE;
3862 expand_string_message = US"";
3869 /* \ escapes the next character, which must exist, or else
3870 the expansion fails. There's a special escape, \N, which causes
3871 copying of the subject verbatim up to the next \N. Otherwise,
3872 the escapes are the standard set. */
3878 expand_string_message = US"\\ at end of string";
3884 const uschar * t = s + 2;
3885 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3886 yield = string_catn(yield, &size, &ptr, t, s - t);
3887 if (*s != 0) s += 2;
3893 ch[0] = string_interpret_escape(&s);
3895 yield = string_catn(yield, &size, &ptr, ch, 1);
3902 /* Anything other than $ is just copied verbatim, unless we are
3903 looking for a terminating } character. */
3906 if (ket_ends && *s == '}') break;
3908 if (*s != '$' || !honour_dollar)
3910 yield = string_catn(yield, &size, &ptr, s++, 1);
3914 /* No { after the $ - must be a plain name or a number for string
3915 match variable. There has to be a fudge for variables that are the
3916 names of header fields preceded by "$header_" because header field
3917 names can contain any printing characters except space and colon.
3918 For those that don't like typing this much, "$h_" is a synonym for
3919 "$header_". A non-existent header yields a NULL value; nothing is
3922 if (isalpha((*(++s))))
3927 s = read_name(name, sizeof(name), s, US"_");
3929 /* If this is the first thing to be expanded, release the pre-allocated
3932 if (ptr == 0 && yield != NULL)
3934 if (resetok) store_reset(yield);
3941 if (Ustrncmp(name, "h_", 2) == 0 ||
3942 Ustrncmp(name, "rh_", 3) == 0 ||
3943 Ustrncmp(name, "bh_", 3) == 0 ||
3944 Ustrncmp(name, "header_", 7) == 0 ||
3945 Ustrncmp(name, "rheader_", 8) == 0 ||
3946 Ustrncmp(name, "bheader_", 8) == 0)
3948 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3949 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3950 s = read_header_name(name, sizeof(name), s);
3951 value = find_header(name, FALSE, &newsize, want_raw, charset);
3953 /* If we didn't find the header, and the header contains a closing brace
3954 character, this may be a user error where the terminating colon
3955 has been omitted. Set a flag to adjust the error message in this case.
3956 But there is no error here - nothing gets inserted. */
3960 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3967 else if (!(value = find_variable(name, FALSE, skipping, &newsize)))
3969 expand_string_message =
3970 string_sprintf("unknown variable name \"%s\"", name);
3971 check_variable_error_message(name);
3975 /* If the data is known to be in a new buffer, newsize will be set to the
3976 size of that buffer. If this is the first thing in an expansion string,
3977 yield will be NULL; just point it at the new store instead of copying. Many
3978 expansion strings contain just one reference, so this is a useful
3979 optimization, especially for humungous headers. */
3981 len = Ustrlen(value);
3982 if (yield == NULL && newsize != 0)
3988 else yield = string_catn(yield, &size, &ptr, value, len);
3996 s = read_cnumber(&n, s);
3997 if (n >= 0 && n <= expand_nmax)
3998 yield = string_catn(yield, &size, &ptr, expand_nstring[n],
4003 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4005 if (*s != '{') /*}*/
4007 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
4011 /* After { there can be various things, but they all start with
4012 an initial word, except for a number for a string match variable. */
4014 if (isdigit((*(++s))))
4017 s = read_cnumber(&n, s); /*{*/
4020 expand_string_message = US"} expected after number";
4023 if (n >= 0 && n <= expand_nmax)
4024 yield = string_catn(yield, &size, &ptr, expand_nstring[n],
4031 expand_string_message = US"letter or digit expected after ${"; /*}*/
4035 /* Allow "-" in names to cater for substrings with negative
4036 arguments. Since we are checking for known names after { this is
4039 s = read_name(name, sizeof(name), s, US"_-");
4040 item_type = chop_match(name, item_table, nelem(item_table));
4044 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4045 If the ACL returns accept or reject we return content set by "message ="
4046 There is currently no limit on recursion; this would have us call
4047 acl_check_internal() directly and get a current level from somewhere.
4048 See also the acl expansion condition ECOND_ACL and the traditional
4049 acl modifier ACLC_ACL.
4050 Assume that the function has side-effects on the store that must be preserved.
4054 /* ${acl {name} {arg1}{arg2}...} */
4056 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4059 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4062 case 1: goto EXPAND_FAILED_CURLY;
4064 case 3: goto EXPAND_FAILED;
4066 if (skipping) continue;
4069 switch(eval_acl(sub, nelem(sub), &user_msg))
4074 debug_printf("acl expansion yield: %s\n", user_msg);
4076 yield = string_cat(yield, &size, &ptr, user_msg);
4080 expand_string_forcedfail = TRUE;
4083 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4088 /* Handle conditionals - preserve the values of the numerical expansion
4089 variables in case they get changed by a regular expression match in the
4090 condition. If not, they retain their external settings. At the end
4091 of this "if" section, they get restored to their previous values. */
4096 const uschar *next_s;
4097 int save_expand_nmax =
4098 save_expand_strings(save_expand_nstring, save_expand_nlength);
4100 while (isspace(*s)) s++;
4101 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
4102 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4105 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
4106 cond? "true" : "false");
4110 /* The handling of "yes" and "no" result strings is now in a separate
4111 function that is also used by ${lookup} and ${extract} and ${run}. */
4113 switch(process_yesno(
4114 skipping, /* were previously skipping */
4115 cond, /* success/failure indicator */
4116 lookup_value, /* value to reset for string2 */
4117 &s, /* input pointer */
4118 &yield, /* output pointer */
4119 &size, /* output size */
4120 &ptr, /* output current point */
4121 US"if", /* condition type */
4124 case 1: goto EXPAND_FAILED; /* when all is well, the */
4125 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4128 /* Restore external setting of expansion variables for continuation
4131 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4132 save_expand_nlength);
4137 case EITEM_IMAPFOLDER:
4138 { /* ${imapfolder {name}{sep]{specials}} */
4142 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4145 case 1: goto EXPAND_FAILED_CURLY;
4147 case 3: goto EXPAND_FAILED;
4150 if (sub_arg[1] == NULL) /* One argument */
4152 sub_arg[1] = US"/"; /* default separator */
4155 else if (Ustrlen(sub_arg[1]) != 1)
4157 expand_string_message =
4159 "IMAP folder separator must be one character, found \"%s\"",
4164 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4165 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4168 yield = string_cat(yield, &size, &ptr, encoded);
4173 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4174 expanding an internal string that isn't actually going to be used. All we
4175 need to do is check the syntax, so don't do a lookup at all. Preserve the
4176 values of the numerical expansion variables in case they get changed by a
4177 partial lookup. If not, they retain their external settings. At the end
4178 of this "lookup" section, they get restored to their previous values. */
4182 int stype, partial, affixlen, starflags;
4183 int expand_setup = 0;
4185 uschar *key, *filename;
4186 const uschar *affix;
4187 uschar *save_lookup_value = lookup_value;
4188 int save_expand_nmax =
4189 save_expand_strings(save_expand_nstring, save_expand_nlength);
4191 if ((expand_forbid & RDO_LOOKUP) != 0)
4193 expand_string_message = US"lookup expansions are not permitted";
4197 /* Get the key we are to look up for single-key+file style lookups.
4198 Otherwise set the key NULL pro-tem. */
4200 while (isspace(*s)) s++;
4201 if (*s == '{') /*}*/
4203 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4204 if (!key) goto EXPAND_FAILED; /*{{*/
4207 expand_string_message = US"missing '}' after lookup key";
4208 goto EXPAND_FAILED_CURLY;
4210 while (isspace(*s)) s++;
4214 /* Find out the type of database */
4218 expand_string_message = US"missing lookup type";
4222 /* The type is a string that may contain special characters of various
4223 kinds. Allow everything except space or { to appear; the actual content
4224 is checked by search_findtype_partial. */ /*}*/
4226 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4228 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4232 while (isspace(*s)) s++;
4234 /* Now check for the individual search type and any partial or default
4235 options. Only those types that are actually in the binary are valid. */
4237 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4241 expand_string_message = search_error_message;
4245 /* Check that a key was provided for those lookup types that need it,
4246 and was not supplied for those that use the query style. */
4248 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4252 expand_string_message = string_sprintf("missing {key} for single-"
4253 "key \"%s\" lookup", name);
4261 expand_string_message = string_sprintf("a single key was given for "
4262 "lookup type \"%s\", which is not a single-key lookup type", name);
4267 /* Get the next string in brackets and expand it. It is the file name for
4268 single-key+file lookups, and the whole query otherwise. In the case of
4269 queries that also require a file name (e.g. sqlite), the file name comes
4274 expand_string_message = US"missing '{' for lookup file-or-query arg";
4275 goto EXPAND_FAILED_CURLY;
4277 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4278 if (filename == NULL) goto EXPAND_FAILED;
4281 expand_string_message = US"missing '}' closing lookup file-or-query arg";
4282 goto EXPAND_FAILED_CURLY;
4284 while (isspace(*s)) s++;
4286 /* If this isn't a single-key+file lookup, re-arrange the variables
4287 to be appropriate for the search_ functions. For query-style lookups,
4288 there is just a "key", and no file name. For the special query-style +
4289 file types, the query (i.e. "key") starts with a file name. */
4293 while (isspace(*filename)) filename++;
4296 if (mac_islookup(stype, lookup_querystyle))
4300 if (*filename != '/')
4302 expand_string_message = string_sprintf(
4303 "absolute file name expected for \"%s\" lookup", name);
4306 while (*key != 0 && !isspace(*key)) key++;
4307 if (*key != 0) *key++ = 0;
4311 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4312 the entry was not found. Note that there is no search_close() function.
4313 Files are left open in case of re-use. At suitable places in higher logic,
4314 search_tidyup() is called to tidy all open files. This can save opening
4315 the same file several times. However, files may also get closed when
4316 others are opened, if too many are open at once. The rule is that a
4317 handle should not be used after a second search_open().
4319 Request that a partial search sets up $1 and maybe $2 by passing
4320 expand_setup containing zero. If its value changes, reset expand_nmax,
4321 since new variables will have been set. Note that at the end of this
4322 "lookup" section, the old numeric variables are restored. */
4325 lookup_value = NULL;
4328 void *handle = search_open(filename, stype, 0, NULL, NULL);
4331 expand_string_message = search_error_message;
4334 lookup_value = search_find(handle, filename, key, partial, affix,
4335 affixlen, starflags, &expand_setup);
4336 if (search_find_defer)
4338 expand_string_message =
4339 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4340 string_printing2(key, FALSE), search_error_message);
4343 if (expand_setup > 0) expand_nmax = expand_setup;
4346 /* The handling of "yes" and "no" result strings is now in a separate
4347 function that is also used by ${if} and ${extract}. */
4349 switch(process_yesno(
4350 skipping, /* were previously skipping */
4351 lookup_value != NULL, /* success/failure indicator */
4352 save_lookup_value, /* value to reset for string2 */
4353 &s, /* input pointer */
4354 &yield, /* output pointer */
4355 &size, /* output size */
4356 &ptr, /* output current point */
4357 US"lookup", /* condition type */
4360 case 1: goto EXPAND_FAILED; /* when all is well, the */
4361 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4364 /* Restore external setting of expansion variables for carrying on
4365 at this level, and continue. */
4367 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4368 save_expand_nlength);
4372 /* If Perl support is configured, handle calling embedded perl subroutines,
4373 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4374 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4375 arguments (defined below). */
4377 #define EXIM_PERL_MAX_ARGS 8
4381 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4382 "is not included in this binary";
4385 #else /* EXIM_PERL */
4387 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4390 if ((expand_forbid & RDO_PERL) != 0)
4392 expand_string_message = US"Perl calls are not permitted";
4396 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4397 US"perl", &resetok))
4399 case 1: goto EXPAND_FAILED_CURLY;
4401 case 3: goto EXPAND_FAILED;
4404 /* If skipping, we don't actually do anything */
4406 if (skipping) continue;
4408 /* Start the interpreter if necessary */
4410 if (!opt_perl_started)
4413 if (opt_perl_startup == NULL)
4415 expand_string_message = US"A setting of perl_startup is needed when "
4416 "using the Perl interpreter";
4419 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4420 initerror = init_perl(opt_perl_startup);
4421 if (initerror != NULL)
4423 expand_string_message =
4424 string_sprintf("error in perl_startup code: %s\n", initerror);
4427 opt_perl_started = TRUE;
4430 /* Call the function */
4432 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4433 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4434 sub_arg[0], sub_arg + 1);
4436 /* NULL yield indicates failure; if the message pointer has been set to
4437 NULL, the yield was undef, indicating a forced failure. Otherwise the
4438 message will indicate some kind of Perl error. */
4440 if (new_yield == NULL)
4442 if (expand_string_message == NULL)
4444 expand_string_message =
4445 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4446 "failure", sub_arg[0]);
4447 expand_string_forcedfail = TRUE;
4452 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4453 set during a callback from Perl. */
4455 expand_string_forcedfail = FALSE;
4459 #endif /* EXIM_PERL */
4461 /* Transform email address to "prvs" scheme to use
4462 as BATV-signed return path */
4469 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4471 case 1: goto EXPAND_FAILED_CURLY;
4473 case 3: goto EXPAND_FAILED;
4476 /* If skipping, we don't actually do anything */
4477 if (skipping) continue;
4479 /* sub_arg[0] is the address */
4480 domain = Ustrrchr(sub_arg[0],'@');
4481 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4483 expand_string_message = US"prvs first argument must be a qualified email address";
4487 /* Calculate the hash. The second argument must be a single-digit
4488 key number, or unset. */
4490 if (sub_arg[2] != NULL &&
4491 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4493 expand_string_message = US"prvs second argument must be a single digit";
4497 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4500 expand_string_message = US"prvs hmac-sha1 conversion failed";
4504 /* Now separate the domain from the local part */
4507 yield = string_catn(yield, &size, &ptr, US"prvs=", 5);
4508 yield = string_catn(yield, &size, &ptr, sub_arg[2] ? sub_arg[2] : US"0", 1);
4509 yield = string_catn(yield, &size, &ptr, prvs_daystamp(7), 3);
4510 yield = string_catn(yield, &size, &ptr, p, 6);
4511 yield = string_catn(yield, &size, &ptr, US"=", 1);
4512 yield = string_cat (yield, &size, &ptr, sub_arg[0]);
4513 yield = string_catn(yield, &size, &ptr, US"@", 1);
4514 yield = string_cat (yield, &size, &ptr, domain);
4519 /* Check a prvs-encoded address for validity */
4521 case EITEM_PRVSCHECK:
4524 int mysize = 0, myptr = 0;
4528 /* TF: Ugliness: We want to expand parameter 1 first, then set
4529 up expansion variables that are used in the expansion of
4530 parameter 2. So we clone the string for the first
4531 expansion, where we only expand parameter 1.
4533 PH: Actually, that isn't necessary. The read_subs() function is
4534 designed to work this way for the ${if and ${lookup expansions. I've
4538 /* Reset expansion variables */
4539 prvscheck_result = NULL;
4540 prvscheck_address = NULL;
4541 prvscheck_keynum = NULL;
4543 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4545 case 1: goto EXPAND_FAILED_CURLY;
4547 case 3: goto EXPAND_FAILED;
4550 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4553 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4555 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4556 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4557 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4558 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4559 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4561 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4562 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4563 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4564 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4565 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4567 /* Set up expansion variables */
4568 prvscheck_address = string_cat (NULL, &mysize, &myptr, local_part);
4569 prvscheck_address = string_catn(prvscheck_address, &mysize, &myptr, US"@", 1);
4570 prvscheck_address = string_cat (prvscheck_address, &mysize, &myptr, domain);
4571 prvscheck_address[myptr] = '\0';
4572 prvscheck_keynum = string_copy(key_num);
4574 /* Now expand the second argument */
4575 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4577 case 1: goto EXPAND_FAILED_CURLY;
4579 case 3: goto EXPAND_FAILED;
4582 /* Now we have the key and can check the address. */
4584 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4589 expand_string_message = US"hmac-sha1 conversion failed";
4593 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4594 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4596 if (Ustrcmp(p,hash) == 0)
4598 /* Success, valid BATV address. Now check the expiry date. */
4599 uschar *now = prvs_daystamp(0);
4600 unsigned int inow = 0,iexpire = 1;
4602 (void)sscanf(CS now,"%u",&inow);
4603 (void)sscanf(CS daystamp,"%u",&iexpire);
4605 /* When "iexpire" is < 7, a "flip" has occured.
4606 Adjust "inow" accordingly. */
4607 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4609 if (iexpire >= inow)
4611 prvscheck_result = US"1";
4612 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4616 prvscheck_result = NULL;
4617 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4622 prvscheck_result = NULL;
4623 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4626 /* Now expand the final argument. We leave this till now so that
4627 it can include $prvscheck_result. */
4629 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4631 case 1: goto EXPAND_FAILED_CURLY;
4633 case 3: goto EXPAND_FAILED;
4636 yield = string_cat(yield, &size, &ptr,
4637 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
4639 /* Reset the "internal" variables afterwards, because they are in
4640 dynamic store that will be reclaimed if the expansion succeeded. */
4642 prvscheck_address = NULL;
4643 prvscheck_keynum = NULL;
4647 /* Does not look like a prvs encoded address, return the empty string.
4648 We need to make sure all subs are expanded first, so as to skip over
4651 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4653 case 1: goto EXPAND_FAILED_CURLY;
4655 case 3: goto EXPAND_FAILED;
4662 /* Handle "readfile" to insert an entire file */
4664 case EITEM_READFILE:
4669 if ((expand_forbid & RDO_READFILE) != 0)
4671 expand_string_message = US"file insertions are not permitted";
4675 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4677 case 1: goto EXPAND_FAILED_CURLY;
4679 case 3: goto EXPAND_FAILED;
4682 /* If skipping, we don't actually do anything */
4684 if (skipping) continue;
4686 /* Open the file and read it */
4688 f = Ufopen(sub_arg[0], "rb");
4691 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4695 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4700 /* Handle "readsocket" to insert data from a Unix domain socket */
4702 case EITEM_READSOCK:
4708 struct sockaddr_un sockun; /* don't call this "sun" ! */
4712 if ((expand_forbid & RDO_READSOCK) != 0)
4714 expand_string_message = US"socket insertions are not permitted";
4718 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4719 because there may be a string for expansion on failure. */
4721 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4723 case 1: goto EXPAND_FAILED_CURLY;
4724 case 2: /* Won't occur: no end check */
4725 case 3: goto EXPAND_FAILED;
4728 /* Sort out timeout, if given */
4730 if (sub_arg[2] != NULL)
4732 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4735 expand_string_message = string_sprintf("bad time value %s",
4740 else sub_arg[3] = NULL; /* No eol if no timeout */
4742 /* If skipping, we don't actually do anything. Otherwise, arrange to
4743 connect to either an IP or a Unix socket. */
4747 /* Handle an IP (internet) domain */
4749 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4752 uschar *server_name = sub_arg[0] + 5;
4753 uschar *port_name = Ustrrchr(server_name, ':');
4755 /* Sort out the port */
4757 if (port_name == NULL)
4759 expand_string_message =
4760 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4763 *port_name++ = 0; /* Terminate server name */
4765 if (isdigit(*port_name))
4768 port = Ustrtol(port_name, &end, 0);
4769 if (end != port_name + Ustrlen(port_name))
4771 expand_string_message =
4772 string_sprintf("invalid port number %s", port_name);
4778 struct servent *service_info = getservbyname(CS port_name, "tcp");
4779 if (service_info == NULL)
4781 expand_string_message = string_sprintf("unknown port \"%s\"",
4785 port = ntohs(service_info->s_port);
4788 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4789 timeout, NULL, &expand_string_message)) < 0)
4793 /* Handle a Unix domain socket */
4798 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4800 expand_string_message = string_sprintf("failed to create socket: %s",
4805 sockun.sun_family = AF_UNIX;
4806 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4809 sigalrm_seen = FALSE;
4811 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4815 expand_string_message = US "socket connect timed out";
4820 expand_string_message = string_sprintf("failed to connect to socket "
4821 "%s: %s", sub_arg[0], strerror(errno));
4826 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4828 /* Allow sequencing of test actions */
4829 if (running_in_test_harness) millisleep(100);
4831 /* Write the request string, if not empty */
4833 if (sub_arg[1][0] != 0)
4835 int len = Ustrlen(sub_arg[1]);
4836 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4838 if (write(fd, sub_arg[1], len) != len)
4840 expand_string_message = string_sprintf("request write to socket "
4841 "failed: %s", strerror(errno));
4846 /* Shut down the sending side of the socket. This helps some servers to
4847 recognise that it is their turn to do some work. Just in case some
4848 system doesn't have this function, make it conditional. */
4851 shutdown(fd, SHUT_WR);
4854 if (running_in_test_harness) millisleep(100);
4856 /* Now we need to read from the socket, under a timeout. The function
4857 that reads a file can be used. */
4859 f = fdopen(fd, "rb");
4860 sigalrm_seen = FALSE;
4862 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4866 /* After a timeout, we restore the pointer in the result, that is,
4867 make sure we add nothing from the socket. */
4872 expand_string_message = US "socket read timed out";
4877 /* The whole thing has worked (or we were skipping). If there is a
4878 failure string following, we need to skip it. */
4882 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4886 expand_string_message = US"missing '}' closing failstring for readsocket";
4887 goto EXPAND_FAILED_CURLY;
4889 while (isspace(*s)) s++;
4895 expand_string_message = US"missing '}' closing readsocket";
4896 goto EXPAND_FAILED_CURLY;
4900 /* Come here on failure to create socket, connect socket, write to the
4901 socket, or timeout on reading. If another substring follows, expand and
4902 use it. Otherwise, those conditions give expand errors. */
4905 if (*s != '{') goto EXPAND_FAILED;
4906 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4907 if (!(arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok)))
4909 yield = string_cat(yield, &size, &ptr, arg);
4912 expand_string_message = US"missing '}' closing failstring for readsocket";
4913 goto EXPAND_FAILED_CURLY;
4915 while (isspace(*s)) s++;
4919 /* Handle "run" to execute a program. */
4925 const uschar **argv;
4928 int lsize = 0, lptr = 0;
4930 if ((expand_forbid & RDO_RUN) != 0)
4932 expand_string_message = US"running a command is not permitted";
4936 while (isspace(*s)) s++;
4939 expand_string_message = US"missing '{' for command arg of run";
4940 goto EXPAND_FAILED_CURLY;
4942 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4943 if (arg == NULL) goto EXPAND_FAILED;
4944 while (isspace(*s)) s++;
4947 expand_string_message = US"missing '}' closing command arg of run";
4948 goto EXPAND_FAILED_CURLY;
4951 if (skipping) /* Just pretend it worked when we're skipping */
4955 if (!transport_set_up_command(&argv, /* anchor for arg list */
4956 arg, /* raw command */
4957 FALSE, /* don't expand the arguments */
4958 0, /* not relevant when... */
4959 NULL, /* no transporting address */
4960 US"${run} expansion", /* for error messages */
4961 &expand_string_message)) /* where to put error message */
4964 /* Create the child process, making it a group leader. */
4966 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE)) < 0)
4968 expand_string_message =
4969 string_sprintf("couldn't create child process: %s", strerror(errno));
4973 /* Nothing is written to the standard input. */
4977 /* Read the pipe to get the command's output into $value (which is kept
4978 in lookup_value). Read during execution, so that if the output exceeds
4979 the OS pipe buffer limit, we don't block forever. Remember to not release
4980 memory just allocated for $value. */
4983 f = fdopen(fd_out, "rb");
4984 sigalrm_seen = FALSE;
4986 lookup_value = cat_file(f, NULL, &lsize, &lptr, NULL);
4990 /* Wait for the process to finish, applying the timeout, and inspect its
4991 return code for serious disasters. Simple non-zero returns are passed on.
4994 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4996 if (sigalrm_seen == TRUE || runrc == -256)
4998 expand_string_message = string_sprintf("command timed out");
4999 killpg(pid, SIGKILL); /* Kill the whole process group */
5002 else if (runrc == -257)
5003 expand_string_message = string_sprintf("wait() failed: %s",
5007 expand_string_message = string_sprintf("command killed by signal %d",
5014 /* Process the yes/no strings; $value may be useful in both cases */
5016 switch(process_yesno(
5017 skipping, /* were previously skipping */
5018 runrc == 0, /* success/failure indicator */
5019 lookup_value, /* value to reset for string2 */
5020 &s, /* input pointer */
5021 &yield, /* output pointer */
5022 &size, /* output size */
5023 &ptr, /* output current point */
5024 US"run", /* condition type */
5027 case 1: goto EXPAND_FAILED; /* when all is well, the */
5028 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5034 /* Handle character translation for "tr" */
5042 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
5044 case 1: goto EXPAND_FAILED_CURLY;
5046 case 3: goto EXPAND_FAILED;
5049 yield = string_cat(yield, &size, &ptr, sub[0]);
5050 o2m = Ustrlen(sub[2]) - 1;
5052 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
5054 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
5058 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
5065 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5066 expanded arguments. */
5076 int val[2] = { 0, -1 };
5079 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5080 Ensure that sub[2] is set in the ${length } case. */
5083 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5084 TRUE, name, &resetok))
5086 case 1: goto EXPAND_FAILED_CURLY;
5088 case 3: goto EXPAND_FAILED;
5091 /* Juggle the arguments if there are only two of them: always move the
5092 string to the last position and make ${length{n}{str}} equivalent to
5093 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5099 if (item_type == EITEM_LENGTH)
5106 for (i = 0; i < 2; i++)
5108 if (sub[i] == NULL) continue;
5109 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5110 if (*ret != 0 || (i != 0 && val[i] < 0))
5112 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5113 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5119 (item_type == EITEM_HASH)?
5120 compute_hash(sub[2], val[0], val[1], &len) :
5121 (item_type == EITEM_NHASH)?
5122 compute_nhash(sub[2], val[0], val[1], &len) :
5123 extract_substr(sub[2], val[0], val[1], &len);
5125 if (ret == NULL) goto EXPAND_FAILED;
5126 yield = string_catn(yield, &size, &ptr, ret, len);
5130 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5131 This code originally contributed by Steve Haslam. It currently supports
5132 the use of MD5 and SHA-1 hashes.
5134 We need some workspace that is large enough to handle all the supported
5135 hash types. Use macros to set the sizes rather than be too elaborate. */
5137 #define MAX_HASHLEN 20
5138 #define MAX_HASHBLOCKLEN 64
5147 int hashlen; /* Number of octets for the hash algorithm's output */
5148 int hashblocklen; /* Number of octets the hash algorithm processes */
5150 unsigned int keylen;
5152 uschar keyhash[MAX_HASHLEN];
5153 uschar innerhash[MAX_HASHLEN];
5154 uschar finalhash[MAX_HASHLEN];
5155 uschar finalhash_hex[2*MAX_HASHLEN];
5156 uschar innerkey[MAX_HASHBLOCKLEN];
5157 uschar outerkey[MAX_HASHBLOCKLEN];
5159 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5161 case 1: goto EXPAND_FAILED_CURLY;
5163 case 3: goto EXPAND_FAILED;
5166 if (Ustrcmp(sub[0], "md5") == 0)
5169 use_base = &md5_base;
5173 else if (Ustrcmp(sub[0], "sha1") == 0)
5176 use_base = &sha1_ctx;
5182 expand_string_message =
5183 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5188 keylen = Ustrlen(keyptr);
5190 /* If the key is longer than the hash block length, then hash the key
5193 if (keylen > hashblocklen)
5195 chash_start(type, use_base);
5196 chash_end(type, use_base, keyptr, keylen, keyhash);
5201 /* Now make the inner and outer key values */
5203 memset(innerkey, 0x36, hashblocklen);
5204 memset(outerkey, 0x5c, hashblocklen);
5206 for (i = 0; i < keylen; i++)
5208 innerkey[i] ^= keyptr[i];
5209 outerkey[i] ^= keyptr[i];
5212 /* Now do the hashes */
5214 chash_start(type, use_base);
5215 chash_mid(type, use_base, innerkey);
5216 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5218 chash_start(type, use_base);
5219 chash_mid(type, use_base, outerkey);
5220 chash_end(type, use_base, innerhash, hashlen, finalhash);
5222 /* Encode the final hash as a hex string */
5225 for (i = 0; i < hashlen; i++)
5227 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5228 *p++ = hex_digits[finalhash[i] & 0x0f];
5231 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5232 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5234 yield = string_catn(yield, &size, &ptr, finalhash_hex, hashlen*2);
5239 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5240 We have to save the numerical variables and restore them afterwards. */
5245 int moffset, moffsetextra, slen;
5248 const uschar *rerror;
5251 int save_expand_nmax =
5252 save_expand_strings(save_expand_nstring, save_expand_nlength);
5254 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5256 case 1: goto EXPAND_FAILED_CURLY;
5258 case 3: goto EXPAND_FAILED;
5261 /* Compile the regular expression */
5263 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5268 expand_string_message = string_sprintf("regular expression error in "
5269 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5273 /* Now run a loop to do the substitutions as often as necessary. It ends
5274 when there are no more matches. Take care over matches of the null string;
5275 do the same thing as Perl does. */
5278 slen = Ustrlen(sub[0]);
5279 moffset = moffsetextra = 0;
5284 int ovector[3*(EXPAND_MAXN+1)];
5285 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5286 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5290 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5291 is not necessarily the end. We want to repeat the match from one
5292 character further along, but leaving the basic offset the same (for
5293 copying below). We can't be at the end of the string - that was checked
5294 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5295 finished; copy the remaining string and end the loop. */
5305 yield = string_catn(yield, &size, &ptr, subject+moffset, slen-moffset);
5309 /* Match - set up for expanding the replacement. */
5311 if (n == 0) n = EXPAND_MAXN + 1;
5313 for (nn = 0; nn < n*2; nn += 2)
5315 expand_nstring[expand_nmax] = subject + ovector[nn];
5316 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5320 /* Copy the characters before the match, plus the expanded insertion. */
5322 yield = string_catn(yield, &size, &ptr, subject + moffset,
5323 ovector[0] - moffset);
5324 insert = expand_string(sub[2]);
5325 if (insert == NULL) goto EXPAND_FAILED;
5326 yield = string_cat(yield, &size, &ptr, insert);
5328 moffset = ovector[1];
5332 /* If we have matched an empty string, first check to see if we are at
5333 the end of the subject. If so, the loop is over. Otherwise, mimic
5334 what Perl's /g options does. This turns out to be rather cunning. First
5335 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5336 string at the same point. If this fails (picked up above) we advance to
5337 the next character. */
5339 if (ovector[0] == ovector[1])
5341 if (ovector[0] == slen) break;
5342 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5346 /* All done - restore numerical variables. */
5348 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5349 save_expand_nlength);
5353 /* Handle keyed and numbered substring extraction. If the first argument
5354 consists entirely of digits, then a numerical extraction is assumed. */
5360 int field_number = 1;
5361 BOOL field_number_set = FALSE;
5362 uschar *save_lookup_value = lookup_value;
5364 int save_expand_nmax =
5365 save_expand_strings(save_expand_nstring, save_expand_nlength);
5367 /* While skipping we cannot rely on the data for expansions being
5368 available (eg. $item) hence cannot decide on numeric vs. keyed.
5369 Read a maximum of 5 arguments (inclding the yes/no) */
5373 while (isspace(*s)) s++;
5374 for (j = 5; j > 0 && *s == '{'; j--)
5376 if (!expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok))
5377 goto EXPAND_FAILED; /*{*/
5380 expand_string_message = US"missing '{' for arg of extract";
5381 goto EXPAND_FAILED_CURLY;
5383 while (isspace(*s)) s++;
5385 if ( Ustrncmp(s, "fail", 4) == 0
5386 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
5390 while (isspace(*s)) s++;
5394 expand_string_message = US"missing '}' closing extract";
5395 goto EXPAND_FAILED_CURLY;
5399 else for (i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
5401 while (isspace(*s)) s++;
5402 if (*s == '{') /*}*/
5404 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5405 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5408 expand_string_message = string_sprintf(
5409 "missing '}' closing arg %d of extract", i+1);
5410 goto EXPAND_FAILED_CURLY;
5413 /* After removal of leading and trailing white space, the first
5414 argument must not be empty; if it consists entirely of digits
5415 (optionally preceded by a minus sign), this is a numerical
5416 extraction, and we expect 3 arguments. */
5424 while (isspace(*p)) p++;
5428 while (len > 0 && isspace(p[len-1])) len--;
5433 expand_string_message = US"first argument of \"extract\" must "
5443 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5447 j = 3; /* Need 3 args */
5448 field_number_set = TRUE;
5454 expand_string_message = string_sprintf(
5455 "missing '{' for arg %d of extract", i+1);
5456 goto EXPAND_FAILED_CURLY;
5460 /* Extract either the numbered or the keyed substring into $value. If
5461 skipping, just pretend the extraction failed. */
5463 lookup_value = skipping? NULL : field_number_set?
5464 expand_gettokened(field_number, sub[1], sub[2]) :
5465 expand_getkeyed(sub[0], sub[1]);
5467 /* If no string follows, $value gets substituted; otherwise there can
5468 be yes/no strings, as for lookup or if. */
5470 switch(process_yesno(
5471 skipping, /* were previously skipping */
5472 lookup_value != NULL, /* success/failure indicator */
5473 save_lookup_value, /* value to reset for string2 */
5474 &s, /* input pointer */
5475 &yield, /* output pointer */
5476 &size, /* output size */
5477 &ptr, /* output current point */
5478 US"extract", /* condition type */
5481 case 1: goto EXPAND_FAILED; /* when all is well, the */
5482 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5485 /* All done - restore numerical variables. */
5487 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5488 save_expand_nlength);
5493 /* return the Nth item from a list */
5495 case EITEM_LISTEXTRACT:
5498 int field_number = 1;
5499 uschar *save_lookup_value = lookup_value;
5501 int save_expand_nmax =
5502 save_expand_strings(save_expand_nstring, save_expand_nlength);
5504 /* Read the field & list arguments */
5506 for (i = 0; i < 2; i++)
5508 while (isspace(*s)) s++;
5509 if (*s != '{') /*}*/
5511 expand_string_message = string_sprintf(
5512 "missing '{' for arg %d of listextract", i+1);
5513 goto EXPAND_FAILED_CURLY;
5516 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5517 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5520 expand_string_message = string_sprintf(
5521 "missing '}' closing arg %d of listextract", i+1);
5522 goto EXPAND_FAILED_CURLY;
5525 /* After removal of leading and trailing white space, the first
5526 argument must be numeric and nonempty. */
5534 while (isspace(*p)) p++;
5538 while (len > 0 && isspace(p[len-1])) len--;
5541 if (!*p && !skipping)
5543 expand_string_message = US"first argument of \"listextract\" must "
5553 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5556 expand_string_message = US"first argument of \"listextract\" must "
5564 /* Extract the numbered element into $value. If
5565 skipping, just pretend the extraction failed. */
5567 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5569 /* If no string follows, $value gets substituted; otherwise there can
5570 be yes/no strings, as for lookup or if. */
5572 switch(process_yesno(
5573 skipping, /* were previously skipping */
5574 lookup_value != NULL, /* success/failure indicator */
5575 save_lookup_value, /* value to reset for string2 */
5576 &s, /* input pointer */
5577 &yield, /* output pointer */
5578 &size, /* output size */
5579 &ptr, /* output current point */
5580 US"listextract", /* condition type */
5583 case 1: goto EXPAND_FAILED; /* when all is well, the */
5584 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5587 /* All done - restore numerical variables. */
5589 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5590 save_expand_nlength);
5596 case EITEM_CERTEXTRACT:
5598 uschar *save_lookup_value = lookup_value;
5600 int save_expand_nmax =
5601 save_expand_strings(save_expand_nstring, save_expand_nlength);
5603 /* Read the field argument */
5604 while (isspace(*s)) s++;
5605 if (*s != '{') /*}*/
5607 expand_string_message = US"missing '{' for field arg of certextract";
5608 goto EXPAND_FAILED_CURLY;
5610 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5611 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5614 expand_string_message = US"missing '}' closing field arg of certextract";
5615 goto EXPAND_FAILED_CURLY;
5617 /* strip spaces fore & aft */
5622 while (isspace(*p)) p++;
5626 while (len > 0 && isspace(p[len-1])) len--;
5630 /* inspect the cert argument */
5631 while (isspace(*s)) s++;
5632 if (*s != '{') /*}*/
5634 expand_string_message = US"missing '{' for cert variable arg of certextract";
5635 goto EXPAND_FAILED_CURLY;
5639 expand_string_message = US"second argument of \"certextract\" must "
5640 "be a certificate variable";
5643 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5644 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5647 expand_string_message = US"missing '}' closing cert variable arg of certextract";
5648 goto EXPAND_FAILED_CURLY;
5652 lookup_value = NULL;
5655 lookup_value = expand_getcertele(sub[0], sub[1]);
5656 if (*expand_string_message) goto EXPAND_FAILED;
5658 switch(process_yesno(
5659 skipping, /* were previously skipping */
5660 lookup_value != NULL, /* success/failure indicator */
5661 save_lookup_value, /* value to reset for string2 */
5662 &s, /* input pointer */
5663 &yield, /* output pointer */
5664 &size, /* output size */
5665 &ptr, /* output current point */
5666 US"certextract", /* condition type */
5669 case 1: goto EXPAND_FAILED; /* when all is well, the */
5670 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5673 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5674 save_expand_nlength);
5677 #endif /*SUPPORT_TLS*/
5679 /* Handle list operations */
5687 uschar outsep[2] = { '\0', '\0' };
5688 const uschar *list, *expr, *temp;
5689 uschar *save_iterate_item = iterate_item;
5690 uschar *save_lookup_value = lookup_value;
5692 while (isspace(*s)) s++;
5695 expand_string_message =
5696 string_sprintf("missing '{' for first arg of %s", name);
5697 goto EXPAND_FAILED_CURLY;
5700 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5701 if (list == NULL) goto EXPAND_FAILED;
5704 expand_string_message =
5705 string_sprintf("missing '}' closing first arg of %s", name);
5706 goto EXPAND_FAILED_CURLY;
5709 if (item_type == EITEM_REDUCE)
5712 while (isspace(*s)) s++;
5715 expand_string_message = US"missing '{' for second arg of reduce";
5716 goto EXPAND_FAILED_CURLY;
5718 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5719 if (!t) goto EXPAND_FAILED;
5723 expand_string_message = US"missing '}' closing second arg of reduce";
5724 goto EXPAND_FAILED_CURLY;
5728 while (isspace(*s)) s++;
5731 expand_string_message =
5732 string_sprintf("missing '{' for last arg of %s", name);
5733 goto EXPAND_FAILED_CURLY;
5738 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5739 if scanning a "false" part). This allows us to find the end of the
5740 condition, because if the list is empty, we won't actually evaluate the
5741 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5742 the normal internal expansion function. */
5744 if (item_type == EITEM_FILTER)
5746 temp = eval_condition(expr, &resetok, NULL);
5747 if (temp != NULL) s = temp;
5750 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5754 expand_string_message = string_sprintf("%s inside \"%s\" item",
5755 expand_string_message, name);
5759 while (isspace(*s)) s++;
5762 expand_string_message = string_sprintf("missing } at end of condition "
5763 "or expression inside \"%s\"", name);
5767 while (isspace(*s)) s++; /*{*/
5770 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5775 /* If we are skipping, we can now just move on to the next item. When
5776 processing for real, we perform the iteration. */
5778 if (skipping) continue;
5779 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5781 *outsep = (uschar)sep; /* Separator as a string */
5783 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5785 if (item_type == EITEM_FILTER)
5788 if (eval_condition(expr, &resetok, &condresult) == NULL)
5790 iterate_item = save_iterate_item;
5791 lookup_value = save_lookup_value;
5792 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5793 expand_string_message, name);
5796 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5797 condresult? "true":"false");
5799 temp = iterate_item; /* TRUE => include this item */
5801 continue; /* FALSE => skip this item */
5804 /* EITEM_MAP and EITEM_REDUCE */
5808 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5812 iterate_item = save_iterate_item;
5813 expand_string_message = string_sprintf("%s inside \"%s\" item",
5814 expand_string_message, name);
5817 if (item_type == EITEM_REDUCE)
5819 lookup_value = t; /* Update the value of $value */
5820 continue; /* and continue the iteration */
5824 /* We reach here for FILTER if the condition is true, always for MAP,
5825 and never for REDUCE. The value in "temp" is to be added to the output
5826 list that is being created, ensuring that any occurrences of the
5827 separator character are doubled. Unless we are dealing with the first
5828 item of the output list, add in a space if the new item begins with the
5829 separator character, or is an empty string. */
5831 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5832 yield = string_catn(yield, &size, &ptr, US" ", 1);
5834 /* Add the string in "temp" to the output list that we are building,
5835 This is done in chunks by searching for the separator character. */
5839 size_t seglen = Ustrcspn(temp, outsep);
5841 yield = string_catn(yield, &size, &ptr, temp, seglen + 1);
5843 /* If we got to the end of the string we output one character
5844 too many; backup and end the loop. Otherwise arrange to double the
5847 if (temp[seglen] == '\0') { ptr--; break; }
5848 yield = string_catn(yield, &size, &ptr, outsep, 1);
5852 /* Output a separator after the string: we will remove the redundant
5853 final one at the end. */
5855 yield = string_catn(yield, &size, &ptr, outsep, 1);
5856 } /* End of iteration over the list loop */
5858 /* REDUCE has generated no output above: output the final value of
5861 if (item_type == EITEM_REDUCE)
5863 yield = string_cat(yield, &size, &ptr, lookup_value);
5864 lookup_value = save_lookup_value; /* Restore $value */
5867 /* FILTER and MAP generate lists: if they have generated anything, remove
5868 the redundant final separator. Even though an empty item at the end of a
5869 list does not count, this is tidier. */
5871 else if (ptr != save_ptr) ptr--;
5873 /* Restore preserved $item */
5875 iterate_item = save_iterate_item;
5882 const uschar *srclist, *cmp, *xtract;
5884 const uschar *dstlist = NULL, *dstkeylist = NULL;
5886 uschar *save_iterate_item = iterate_item;
5888 while (isspace(*s)) s++;
5891 expand_string_message = US"missing '{' for list arg of sort";
5892 goto EXPAND_FAILED_CURLY;
5895 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5896 if (!srclist) goto EXPAND_FAILED;
5899 expand_string_message = US"missing '}' closing list arg of sort";
5900 goto EXPAND_FAILED_CURLY;
5903 while (isspace(*s)) s++;
5906 expand_string_message = US"missing '{' for comparator arg of sort";
5907 goto EXPAND_FAILED_CURLY;
5910 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5911 if (!cmp) goto EXPAND_FAILED;
5914 expand_string_message = US"missing '}' closing comparator arg of sort";
5915 goto EXPAND_FAILED_CURLY;
5918 while (isspace(*s)) s++;
5921 expand_string_message = US"missing '{' for extractor arg of sort";
5922 goto EXPAND_FAILED_CURLY;
5926 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5927 if (!tmp) goto EXPAND_FAILED;
5928 xtract = string_copyn(xtract, s - xtract);
5932 expand_string_message = US"missing '}' closing extractor arg of sort";
5933 goto EXPAND_FAILED_CURLY;
5938 expand_string_message = US"missing } at end of \"sort\"";
5942 if (skipping) continue;
5944 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5947 uschar * newlist = NULL;
5948 uschar * newkeylist = NULL;
5951 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, srcitem);
5953 /* extract field for comparisons */
5954 iterate_item = srcitem;
5955 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5959 expand_string_message = string_sprintf(
5960 "field-extract in sort: \"%s\"", xtract);
5964 /* Insertion sort */
5966 /* copy output list until new-item < list-item */
5967 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5973 /* field for comparison */
5974 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5977 /* build and run condition string */
5978 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
5980 DEBUG(D_expand) debug_printf("%s: cond = \"%s\"\n", name, expr);
5981 if (!eval_condition(expr, &resetok, &before))
5983 expand_string_message = string_sprintf("comparison in sort: %s",
5990 /* New-item sorts before this dst-item. Append new-item,
5991 then dst-item, then remainder of dst list. */
5993 newlist = string_append_listele(newlist, sep, srcitem);
5994 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5997 newlist = string_append_listele(newlist, sep, dstitem);
5998 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6000 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6002 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6004 newlist = string_append_listele(newlist, sep, dstitem);
6005 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6011 newlist = string_append_listele(newlist, sep, dstitem);
6012 newkeylist = string_append_listele(newkeylist, sep, dstfield);
6015 /* If we ran out of dstlist without consuming srcitem, append it */
6018 newlist = string_append_listele(newlist, sep, srcitem);
6019 newkeylist = string_append_listele(newkeylist, sep, srcfield);
6023 dstkeylist = newkeylist;
6025 DEBUG(D_expand) debug_printf("%s: dstlist = \"%s\"\n", name, dstlist);
6026 DEBUG(D_expand) debug_printf("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6030 yield = string_cat(yield, &size, &ptr, dstlist);
6032 /* Restore preserved $item */
6033 iterate_item = save_iterate_item;
6037 expand_string_message = US"Internal error in sort (list mismatch)";
6042 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6043 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6044 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6045 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6047 #define EXPAND_DLFUNC_MAX_ARGS 8
6050 #ifndef EXPAND_DLFUNC
6051 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
6052 "is not included in this binary";
6055 #else /* EXPAND_DLFUNC */
6058 exim_dlfunc_t *func;
6061 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6063 if ((expand_forbid & RDO_DLFUNC) != 0)
6065 expand_string_message =
6066 US"dynamically-loaded functions are not permitted";
6070 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
6071 TRUE, US"dlfunc", &resetok))
6073 case 1: goto EXPAND_FAILED_CURLY;
6075 case 3: goto EXPAND_FAILED;
6078 /* If skipping, we don't actually do anything */
6080 if (skipping) continue;
6082 /* Look up the dynamically loaded object handle in the tree. If it isn't
6083 found, dlopen() the file and put the handle in the tree for next time. */
6085 t = tree_search(dlobj_anchor, argv[0]);
6088 void *handle = dlopen(CS argv[0], RTLD_LAZY);
6091 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6092 argv[0], dlerror());
6093 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6096 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
6097 Ustrcpy(t->name, argv[0]);
6098 t->data.ptr = handle;
6099 (void)tree_insertnode(&dlobj_anchor, t);
6102 /* Having obtained the dynamically loaded object handle, look up the
6103 function pointer. */
6105 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
6108 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6109 "%s", argv[1], argv[0], dlerror());
6110 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6114 /* Call the function and work out what to do with the result. If it
6115 returns OK, we have a replacement string; if it returns DEFER then
6116 expansion has failed in a non-forced manner; if it returns FAIL then
6117 failure was forced; if it returns ERROR or any other value there's a
6118 problem, so panic slightly. In any case, assume that the function has
6119 side-effects on the store that must be preserved. */
6123 for (argc = 0; argv[argc] != NULL; argc++);
6124 status = func(&result, argc - 2, &argv[2]);
6127 if (result == NULL) result = US"";
6128 yield = string_cat(yield, &size, &ptr, result);
6133 expand_string_message = result == NULL ? US"(no message)" : result;
6134 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
6135 else if(status != FAIL)
6136 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6137 argv[0], argv[1], status, expand_string_message);
6141 #endif /* EXPAND_DLFUNC */
6143 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
6146 uschar *save_lookup_value = lookup_value;
6148 while (isspace(*s)) s++;
6149 if (*s != '{') /*}*/
6152 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6153 if (!key) goto EXPAND_FAILED; /*{*/
6156 expand_string_message = US"missing '{' for name arg of env";
6157 goto EXPAND_FAILED_CURLY;
6160 lookup_value = US getenv(CS key);
6162 switch(process_yesno(
6163 skipping, /* were previously skipping */
6164 lookup_value != NULL, /* success/failure indicator */
6165 save_lookup_value, /* value to reset for string2 */
6166 &s, /* input pointer */
6167 &yield, /* output pointer */
6168 &size, /* output size */
6169 &ptr, /* output current point */
6170 US"env", /* condition type */
6173 case 1: goto EXPAND_FAILED; /* when all is well, the */
6174 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
6178 } /* EITEM_* switch */
6180 /* Control reaches here if the name is not recognized as one of the more
6181 complicated expansion items. Check for the "operator" syntax (name terminated
6182 by a colon). Some of the operators have arguments, separated by _ from the
6190 var_entry *vp = NULL;
6192 /* Owing to an historical mis-design, an underscore may be part of the
6193 operator name, or it may introduce arguments. We therefore first scan the
6194 table of names that contain underscores. If there is no match, we cut off
6195 the arguments and then scan the main table. */
6197 if ((c = chop_match(name, op_table_underscore,
6198 nelem(op_table_underscore))) < 0)
6200 arg = Ustrchr(name, '_');
6201 if (arg != NULL) *arg = 0;
6202 c = chop_match(name, op_table_main, nelem(op_table_main));
6203 if (c >= 0) c += nelem(op_table_underscore);
6204 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6207 /* Deal specially with operators that might take a certificate variable
6208 as we do not want to do the usual expansion. For most, expand the string.*/
6218 const uschar * s1 = s;
6219 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6221 if (!sub) goto EXPAND_FAILED; /*{*/
6224 expand_string_message =
6225 string_sprintf("missing '}' closing cert arg of %s", name);
6226 goto EXPAND_FAILED_CURLY;
6228 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6238 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6239 if (!sub) goto EXPAND_FAILED;
6244 /* If we are skipping, we don't need to perform the operation at all.
6245 This matters for operations like "mask", because the data may not be
6246 in the correct format when skipping. For example, the expression may test
6247 for the existence of $sender_host_address before trying to mask it. For
6248 other operations, doing them may not fail, but it is a waste of time. */
6250 if (skipping && c >= 0) continue;
6252 /* Otherwise, switch on the operator type */
6259 unsigned long int n = Ustrtoul(sub, &t, 10);
6262 expand_string_message = string_sprintf("argument for base62 "
6263 "operator is \"%s\", which is not a decimal number", sub);
6266 t = string_base62(n);
6267 yield = string_cat(yield, &size, &ptr, t);
6271 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6277 unsigned long int n = 0;
6280 uschar *t = Ustrchr(base62_chars, *tt++);
6283 expand_string_message = string_sprintf("argument for base62d "
6284 "operator is \"%s\", which is not a base %d number", sub,
6288 n = n * BASE_62 + (t - base62_chars);
6290 (void)sprintf(CS buf, "%ld", n);
6291 yield = string_cat(yield, &size, &ptr, buf);
6297 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6298 if (expanded == NULL)
6300 expand_string_message =
6301 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6302 expand_string_message);
6305 yield = string_cat(yield, &size, &ptr, expanded);
6312 uschar *t = sub - 1;
6313 while (*(++t) != 0) { *t = tolower(*t); count++; }
6314 yield = string_catn(yield, &size, &ptr, sub, count);
6321 uschar *t = sub - 1;
6322 while (*(++t) != 0) { *t = toupper(*t); count++; }
6323 yield = string_catn(yield, &size, &ptr, sub, count);
6329 if (vp && *(void **)vp->value)
6331 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6332 yield = string_cat(yield, &size, &ptr, cp);
6342 md5_end(&base, sub, Ustrlen(sub), digest);
6343 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6344 yield = string_cat(yield, &size, &ptr, US st);
6350 if (vp && *(void **)vp->value)
6352 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6353 yield = string_cat(yield, &size, &ptr, cp);
6363 sha1_end(&h, sub, Ustrlen(sub), digest);
6364 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6365 yield = string_catn(yield, &size, &ptr, US st, 40);
6371 if (vp && *(void **)vp->value)
6373 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6374 yield = string_cat(yield, &size, &ptr, cp);
6382 exim_sha_init(&h, HASH_SHA256);
6383 exim_sha_update(&h, sub, Ustrlen(sub));
6384 exim_sha_finish(&h, &b);
6387 sprintf(st, "%02X", *b.data++);
6388 yield = string_catn(yield, &size, &ptr, US st, 2);
6392 expand_string_message = US"sha256 only supported with TLS";
6396 /* Convert hex encoding to base64 encoding */
6406 for (enc = sub; *enc != 0; enc++)
6408 if (!isxdigit(*enc))
6410 expand_string_message = string_sprintf("\"%s\" is not a hex "
6419 expand_string_message = string_sprintf("\"%s\" contains an odd "
6420 "number of characters", sub);
6424 while ((c = *in++) != 0)
6426 if (isdigit(c)) c -= '0';
6427 else c = toupper(c) - 'A' + 10;
6439 enc = b64encode(sub, out - sub);
6440 yield = string_cat(yield, &size, &ptr, enc);
6444 /* Convert octets outside 0x21..0x7E to \xXX form */
6448 uschar *t = sub - 1;
6451 if (*t < 0x21 || 0x7E < *t)
6452 yield = string_catn(yield, &size, &ptr,
6453 string_sprintf("\\x%02x", *t), 4);
6455 yield = string_catn(yield, &size, &ptr, t, 1);
6460 /* count the number of list elements */
6469 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6470 cp = string_sprintf("%d", cnt);
6471 yield = string_cat(yield, &size, &ptr, cp);
6475 /* expand a named list given the name */
6476 /* handles nested named lists; requotes as colon-sep list */
6480 tree_node *t = NULL;
6481 const uschar * list;
6484 uschar * suffix = US"";
6485 BOOL needsep = FALSE;
6488 if (*sub == '+') sub++;
6489 if (arg == NULL) /* no-argument version */
6491 if (!(t = tree_search(addresslist_anchor, sub)) &&
6492 !(t = tree_search(domainlist_anchor, sub)) &&
6493 !(t = tree_search(hostlist_anchor, sub)))
6494 t = tree_search(localpartlist_anchor, sub);
6496 else switch(*arg) /* specific list-type version */
6498 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6499 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6500 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6501 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6503 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6509 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6511 : *arg=='a'?"address "
6512 : *arg=='d'?"domain "
6514 : *arg=='l'?"localpart "
6519 list = ((namedlist_block *)(t->data.ptr))->string;
6521 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6523 uschar * buf = US" : ";
6525 yield = string_catn(yield, &size, &ptr, buf, 3);
6529 if (*item == '+') /* list item is itself a named list */
6531 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6532 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6534 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6538 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6539 while ((cp= strpbrk((const char *)item, tok)))
6541 yield = string_catn(yield, &size, &ptr, item, cp-(char *)item);
6542 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6544 yield = string_catn(yield, &size, &ptr, US"::", 2);
6545 item = (uschar *)cp;
6547 else /* sep in item; should already be doubled; emit once */
6549 yield = string_catn(yield, &size, &ptr, (uschar *)tok, 1);
6550 if (*cp == sep) cp++;
6551 item = (uschar *)cp;
6555 yield = string_cat(yield, &size, &ptr, item);
6560 /* mask applies a mask to an IP address; for example the result of
6561 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6568 int mask, maskoffset;
6569 int type = string_is_ip_address(sub, &maskoffset);
6574 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6579 if (maskoffset == 0)
6581 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6586 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6588 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6590 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6595 /* Convert the address to binary integer(s) and apply the mask */
6597 sub[maskoffset] = 0;
6598 count = host_aton(sub, binary);
6599 host_mask(count, binary, mask);
6601 /* Convert to masked textual format and add to output. */
6603 yield = string_catn(yield, &size, &ptr, buffer,
6604 host_nmtoa(count, binary, mask, buffer, '.'));
6609 case EOP_IPV6DENORM:
6611 int type = string_is_ip_address(sub, NULL);
6618 (void) host_aton(sub, binary);
6621 case 4: /* convert to IPv4-mapped IPv6 */
6622 binary[0] = binary[1] = 0;
6623 binary[2] = 0x0000ffff;
6624 (void) host_aton(sub, binary+3);
6628 expand_string_message =
6629 string_sprintf("\"%s\" is not an IP address", sub);
6633 yield = string_catn(yield, &size, &ptr, buffer,
6635 ? ipv6_nmtoa(binary, buffer)
6636 : host_nmtoa(4, binary, -1, buffer, ':')
6642 case EOP_LOCAL_PART:
6646 int start, end, domain;
6647 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6651 if (c != EOP_DOMAIN)
6653 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6654 yield = string_catn(yield, &size, &ptr, sub+start, end-start);
6656 else if (domain != 0)
6659 yield = string_catn(yield, &size, &ptr, sub+domain, end-domain);
6667 uschar outsep[2] = { ':', '\0' };
6668 uschar *address, *error;
6670 int start, end, domain; /* Not really used */
6672 while (isspace(*sub)) sub++;
6673 if (*sub == '>') { *outsep = *++sub; ++sub; }
6674 parse_allow_group = TRUE;
6678 uschar *p = parse_find_address_end(sub, FALSE);
6679 uschar saveend = *p;
6681 address = parse_extract_address(sub, &error, &start, &end, &domain,
6685 /* Add the address to the output list that we are building. This is
6686 done in chunks by searching for the separator character. At the
6687 start, unless we are dealing with the first address of the output
6688 list, add in a space if the new address begins with the separator
6689 character, or is an empty string. */
6691 if (address != NULL)
6693 if (ptr != save_ptr && address[0] == *outsep)
6694 yield = string_catn(yield, &size, &ptr, US" ", 1);
6698 size_t seglen = Ustrcspn(address, outsep);
6699 yield = string_catn(yield, &size, &ptr, address, seglen + 1);
6701 /* If we got to the end of the string we output one character
6704 if (address[seglen] == '\0') { ptr--; break; }
6705 yield = string_catn(yield, &size, &ptr, outsep, 1);
6706 address += seglen + 1;
6709 /* Output a separator after the string: we will remove the
6710 redundant final one at the end. */
6712 yield = string_catn(yield, &size, &ptr, outsep, 1);
6715 if (saveend == '\0') break;
6719 /* If we have generated anything, remove the redundant final
6722 if (ptr != save_ptr) ptr--;
6723 parse_allow_group = FALSE;
6728 /* quote puts a string in quotes if it is empty or contains anything
6729 other than alphamerics, underscore, dot, or hyphen.
6731 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6732 be quoted in order to be a valid local part.
6734 In both cases, newlines and carriage returns are converted into \n and \r
6738 case EOP_QUOTE_LOCAL_PART:
6741 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6742 uschar *t = sub - 1;
6746 while (!needs_quote && *(++t) != 0)
6747 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6749 else /* EOP_QUOTE_LOCAL_PART */
6751 while (!needs_quote && *(++t) != 0)
6752 needs_quote = !isalnum(*t) &&
6753 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6754 (*t != '.' || t == sub || t[1] == 0);
6759 yield = string_catn(yield, &size, &ptr, US"\"", 1);
6764 yield = string_catn(yield, &size, &ptr, US"\\n", 2);
6765 else if (*t == '\r')
6766 yield = string_catn(yield, &size, &ptr, US"\\r", 2);
6769 if (*t == '\\' || *t == '"')
6770 yield = string_catn(yield, &size, &ptr, US"\\", 1);
6771 yield = string_catn(yield, &size, &ptr, t, 1);
6774 yield = string_catn(yield, &size, &ptr, US"\"", 1);
6776 else yield = string_cat(yield, &size, &ptr, sub);
6780 /* quote_lookuptype does lookup-specific quoting */
6785 uschar *opt = Ustrchr(arg, '_');
6787 if (opt != NULL) *opt++ = 0;
6789 n = search_findtype(arg, Ustrlen(arg));
6792 expand_string_message = search_error_message;
6796 if (lookup_list[n]->quote != NULL)
6797 sub = (lookup_list[n]->quote)(sub, opt);
6798 else if (opt != NULL) sub = NULL;
6802 expand_string_message = string_sprintf(
6803 "\"%s\" unrecognized after \"${quote_%s\"",
6808 yield = string_cat(yield, &size, &ptr, sub);
6812 /* rx quote sticks in \ before any non-alphameric character so that
6813 the insertion works in a regular expression. */
6817 uschar *t = sub - 1;
6821 yield = string_catn(yield, &size, &ptr, US"\\", 1);
6822 yield = string_catn(yield, &size, &ptr, t, 1);
6827 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6828 prescribed by the RFC, if there are characters that need to be encoded */
6832 uschar buffer[2048];
6833 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6834 buffer, sizeof(buffer), FALSE);
6835 yield = string_cat(yield, &size, &ptr, string);
6839 /* RFC 2047 decode */
6845 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6846 headers_charset, '?', &len, &error);
6849 expand_string_message = error;
6852 yield = string_catn(yield, &size, &ptr, decoded, len);
6856 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6866 if (c > 255) c = '_';
6868 yield = string_catn(yield, &size, &ptr, buff, 1);
6873 /* replace illegal UTF-8 sequences by replacement character */
6875 #define UTF8_REPLACEMENT_CHAR US"?"
6879 int seq_len = 0, index = 0;
6881 long codepoint = -1;
6882 uschar seq_buff[4]; /* accumulate utf-8 here */
6891 if ((c & 0xc0) != 0x80)
6892 /* wrong continuation byte; invalidate all bytes */
6893 complete = 1; /* error */
6896 codepoint = (codepoint << 6) | (c & 0x3f);
6897 seq_buff[index++] = c;
6898 if (--bytes_left == 0) /* codepoint complete */
6899 if(codepoint > 0x10FFFF) /* is it too large? */
6900 complete = -1; /* error (RFC3629 limit) */
6902 { /* finished; output utf-8 sequence */
6903 yield = string_catn(yield, &size, &ptr, seq_buff, seq_len);
6908 else /* no bytes left: new sequence */
6910 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6912 yield = string_catn(yield, &size, &ptr, &c, 1);
6915 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6917 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6922 codepoint = c & 0x1f;
6925 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6928 codepoint = c & 0x0f;
6930 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6933 codepoint = c & 0x07;
6935 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6938 seq_buff[index++] = c;
6939 seq_len = bytes_left + 1;
6940 } /* if(bytes_left) */
6944 bytes_left = index = 0;
6945 yield = string_catn(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6947 if ((complete == 1) && ((c & 0x80) == 0))
6948 /* ASCII character follows incomplete sequence */
6949 yield = string_catn(yield, &size, &ptr, &c, 1);
6955 case EOP_UTF8_DOMAIN_TO_ALABEL:
6957 uschar * error = NULL;
6958 uschar * s = string_domain_utf8_to_alabel(sub, &error);
6961 expand_string_message = string_sprintf(
6962 "error converting utf8 (%s) to alabel: %s",
6963 string_printing(sub), error);
6966 yield = string_cat(yield, &size, &ptr, s);
6970 case EOP_UTF8_DOMAIN_FROM_ALABEL:
6972 uschar * error = NULL;
6973 uschar * s = string_domain_alabel_to_utf8(sub, &error);
6976 expand_string_message = string_sprintf(
6977 "error converting alabel (%s) to utf8: %s",
6978 string_printing(sub), error);
6981 yield = string_cat(yield, &size, &ptr, s);
6985 case EOP_UTF8_LOCALPART_TO_ALABEL:
6987 uschar * error = NULL;
6988 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
6991 expand_string_message = string_sprintf(
6992 "error converting utf8 (%s) to alabel: %s",
6993 string_printing(sub), error);
6996 yield = string_cat(yield, &size, &ptr, s);
6997 DEBUG(D_expand) debug_printf("yield: '%s'\n", yield);
7001 case EOP_UTF8_LOCALPART_FROM_ALABEL:
7003 uschar * error = NULL;
7004 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
7007 expand_string_message = string_sprintf(
7008 "error converting alabel (%s) to utf8: %s",
7009 string_printing(sub), error);
7012 yield = string_cat(yield, &size, &ptr, s);
7015 #endif /* EXPERIMENTAL_INTERNATIONAL */
7017 /* escape turns all non-printing characters into escape sequences. */
7021 const uschar *t = string_printing(sub);
7022 yield = string_cat(yield, &size, &ptr, t);
7026 /* Handle numeric expression evaluation */
7031 uschar *save_sub = sub;
7032 uschar *error = NULL;
7033 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
7036 expand_string_message = string_sprintf("error in expression "
7037 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
7041 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
7042 yield = string_cat(yield, &size, &ptr, var_buffer);
7046 /* Handle time period formating */
7050 int n = readconf_readtime(sub, 0, FALSE);
7053 expand_string_message = string_sprintf("string \"%s\" is not an "
7054 "Exim time interval in \"%s\" operator", sub, name);
7057 sprintf(CS var_buffer, "%d", n);
7058 yield = string_cat(yield, &size, &ptr, var_buffer);
7062 case EOP_TIME_INTERVAL:
7065 uschar *t = read_number(&n, sub);
7066 if (*t != 0) /* Not A Number*/
7068 expand_string_message = string_sprintf("string \"%s\" is not a "
7069 "positive number in \"%s\" operator", sub, name);
7072 t = readconf_printtime(n);
7073 yield = string_cat(yield, &size, &ptr, t);
7077 /* Convert string to base64 encoding */
7083 uschar * s = vp && *(void **)vp->value
7084 ? tls_cert_der_b64(*(void **)vp->value)
7085 : b64encode(sub, Ustrlen(sub));
7087 uschar * s = b64encode(sub, Ustrlen(sub));
7089 yield = string_cat(yield, &size, &ptr, s);
7096 int len = b64decode(sub, &s);
7099 expand_string_message = string_sprintf("string \"%s\" is not "
7100 "well-formed for \"%s\" operator", sub, name);
7103 yield = string_cat(yield, &size, &ptr, s);
7107 /* strlen returns the length of the string */
7112 (void)sprintf(CS buff, "%d", Ustrlen(sub));
7113 yield = string_cat(yield, &size, &ptr, buff);
7117 /* length_n or l_n takes just the first n characters or the whole string,
7118 whichever is the shorter;
7120 substr_m_n, and s_m_n take n characters from offset m; negative m take
7121 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7122 takes the rest, either to the right or to the left.
7124 hash_n or h_n makes a hash of length n from the string, yielding n
7125 characters from the set a-z; hash_n_m makes a hash of length n, but
7126 uses m characters from the set a-zA-Z0-9.
7128 nhash_n returns a single number between 0 and n-1 (in text form), while
7129 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7130 between 0 and n-1 and the second between 0 and m-1. */
7150 expand_string_message = string_sprintf("missing values after %s",
7155 /* "length" has only one argument, effectively being synonymous with
7158 if (c == EOP_LENGTH || c == EOP_L)
7164 /* The others have one or two arguments; for "substr" the first may be
7165 negative. The second being negative means "not supplied". */
7170 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
7173 /* Read up to two numbers, separated by underscores */
7178 if (arg != ret && *arg == '_' && pn == &value1)
7182 if (arg[1] != 0) arg++;
7184 else if (!isdigit(*arg))
7186 expand_string_message =
7187 string_sprintf("non-digit after underscore in \"%s\"", name);
7190 else *pn = (*pn)*10 + *arg++ - '0';
7194 /* Perform the required operation */
7197 (c == EOP_HASH || c == EOP_H)?
7198 compute_hash(sub, value1, value2, &len) :
7199 (c == EOP_NHASH || c == EOP_NH)?
7200 compute_nhash(sub, value1, value2, &len) :
7201 extract_substr(sub, value1, value2, &len);
7203 if (ret == NULL) goto EXPAND_FAILED;
7204 yield = string_catn(yield, &size, &ptr, ret, len);
7214 uschar **modetable[3];
7219 if ((expand_forbid & RDO_EXISTS) != 0)
7221 expand_string_message = US"Use of the stat() expansion is not permitted";
7225 if (stat(CS sub, &st) < 0)
7227 expand_string_message = string_sprintf("stat(%s) failed: %s",
7228 sub, strerror(errno));
7232 switch (mode & S_IFMT)
7234 case S_IFIFO: smode[0] = 'p'; break;
7235 case S_IFCHR: smode[0] = 'c'; break;
7236 case S_IFDIR: smode[0] = 'd'; break;
7237 case S_IFBLK: smode[0] = 'b'; break;
7238 case S_IFREG: smode[0] = '-'; break;
7239 default: smode[0] = '?'; break;
7242 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
7243 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
7244 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
7246 for (i = 0; i < 3; i++)
7248 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
7253 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7254 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
7255 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
7256 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
7257 (long)st.st_gid, st.st_size, (long)st.st_atime,
7258 (long)st.st_mtime, (long)st.st_ctime);
7259 yield = string_cat(yield, &size, &ptr, s);
7263 /* vaguely random number less than N */
7267 int_eximarith_t max;
7270 max = expanded_string_integer(sub, TRUE);
7271 if (expand_string_message != NULL)
7273 s = string_sprintf("%d", vaguely_random_number((int)max));
7274 yield = string_cat(yield, &size, &ptr, s);
7278 /* Reverse IP, including IPv6 to dotted-nibble */
7280 case EOP_REVERSE_IP:
7282 int family, maskptr;
7283 uschar reversed[128];
7285 family = string_is_ip_address(sub, &maskptr);
7288 expand_string_message = string_sprintf(
7289 "reverse_ip() not given an IP address [%s]", sub);
7292 invert_address(reversed, sub);
7293 yield = string_cat(yield, &size, &ptr, reversed);
7297 /* Unknown operator */
7300 expand_string_message =
7301 string_sprintf("unknown expansion operator \"%s\"", name);
7306 /* Handle a plain name. If this is the first thing in the expansion, release
7307 the pre-allocated buffer. If the result data is known to be in a new buffer,
7308 newsize will be set to the size of that buffer, and we can just point at that
7309 store instead of copying. Many expansion strings contain just one reference,
7310 so this is a useful optimization, especially for humungous headers
7311 ($message_headers). */
7319 if (resetok) store_reset(yield);
7323 value = find_variable(name, FALSE, skipping, &newsize);
7326 expand_string_message =
7327 string_sprintf("unknown variable in \"${%s}\"", name);
7328 check_variable_error_message(name);
7331 len = Ustrlen(value);
7332 if (yield == NULL && newsize != 0)
7338 else yield = string_catn(yield, &size, &ptr, value, len);
7342 /* Else there's something wrong */
7344 expand_string_message =
7345 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7346 "in a variable reference)", name);
7350 /* If we hit the end of the string when ket_ends is set, there is a missing
7351 terminating brace. */
7353 if (ket_ends && *s == 0)
7355 expand_string_message = malformed_header?
7356 US"missing } at end of string - could be header name not terminated by colon"
7358 US"missing } at end of string";
7362 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7363 added to the string. If so, set up an empty string. Add a terminating zero. If
7364 left != NULL, return a pointer to the terminator. */
7366 if (yield == NULL) yield = store_get(1);
7368 if (left != NULL) *left = s;
7370 /* Any stacking store that was used above the final string is no longer needed.
7371 In many cases the final string will be the first one that was got and so there
7372 will be optimal store usage. */
7374 if (resetok) store_reset(yield + ptr + 1);
7375 else if (resetok_p) *resetok_p = FALSE;
7379 debug_printf(" expanding: %.*s\n result: %s\n", (int)(s - string), string,
7381 if (skipping) debug_printf(" skipping: result is not used\n");
7385 /* This is the failure exit: easiest to program with a goto. We still need
7386 to update the pointer to the terminator, for cases of nested calls with "fail".
7389 EXPAND_FAILED_CURLY:
7390 if (malformed_header)
7391 expand_string_message =
7392 US"missing or misplaced { or } - could be header name not terminated by colon";
7394 else if (!expand_string_message || !*expand_string_message)
7395 expand_string_message = US"missing or misplaced { or }";
7397 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7398 that is a bad idea, because expand_string_message is in dynamic store. */
7401 if (left != NULL) *left = s;
7404 debug_printf("failed to expand: %s\n", string);
7405 debug_printf(" error message: %s\n", expand_string_message);
7406 if (expand_string_forcedfail) debug_printf("failure was forced\n");
7408 if (resetok_p) *resetok_p = resetok;
7413 /* This is the external function call. Do a quick check for any expansion
7414 metacharacters, and if there are none, just return the input string.
7416 Argument: the string to be expanded
7417 Returns: the expanded string, or NULL if expansion failed; if failure was
7418 due to a lookup deferring, search_find_defer will be TRUE
7422 expand_string(uschar *string)
7424 search_find_defer = FALSE;
7425 malformed_header = FALSE;
7426 return (Ustrpbrk(string, "$\\") == NULL)? string :
7427 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7433 expand_cstring(const uschar *string)
7435 search_find_defer = FALSE;
7436 malformed_header = FALSE;
7437 return (Ustrpbrk(string, "$\\") == NULL)? string :
7438 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7443 /*************************************************
7445 *************************************************/
7447 /* Now and again we want to expand a string and be sure that the result is in a
7448 new bit of store. This function does that.
7449 Since we know it has been copied, the de-const cast is safe.
7451 Argument: the string to be expanded
7452 Returns: the expanded string, always in a new bit of store, or NULL
7456 expand_string_copy(const uschar *string)
7458 const uschar *yield = expand_cstring(string);
7459 if (yield == string) yield = string_copy(string);
7465 /*************************************************
7466 * Expand and interpret as an integer *
7467 *************************************************/
7469 /* Expand a string, and convert the result into an integer.
7472 string the string to be expanded
7473 isplus TRUE if a non-negative number is expected
7475 Returns: the integer value, or
7476 -1 for an expansion error ) in both cases, message in
7477 -2 for an integer interpretation error ) expand_string_message
7478 expand_string_message is set NULL for an OK integer
7482 expand_string_integer(uschar *string, BOOL isplus)
7484 return expanded_string_integer(expand_string(string), isplus);
7488 /*************************************************
7489 * Interpret string as an integer *
7490 *************************************************/
7492 /* Convert a string (that has already been expanded) into an integer.
7494 This function is used inside the expansion code.
7497 s the string to be expanded
7498 isplus TRUE if a non-negative number is expected
7500 Returns: the integer value, or
7501 -1 if string is NULL (which implies an expansion error)
7502 -2 for an integer interpretation error
7503 expand_string_message is set NULL for an OK integer
7506 static int_eximarith_t
7507 expanded_string_integer(const uschar *s, BOOL isplus)
7509 int_eximarith_t value;
7510 uschar *msg = US"invalid integer \"%s\"";
7513 /* If expansion failed, expand_string_message will be set. */
7515 if (s == NULL) return -1;
7517 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7518 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7519 systems, so we set it zero ourselves. */
7522 expand_string_message = NULL; /* Indicates no error */
7524 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7525 equal to 0. Unfortunately, people actually relied upon that, so preserve
7526 the behaviour explicitly. Stripping leading whitespace is a harmless
7527 noop change since strtol skips it anyway (provided that there is a number
7531 while (isspace(*s)) ++s;
7535 debug_printf("treating blank string as number 0\n");
7540 value = strtoll(CS s, CSS &endptr, 10);
7544 msg = US"integer expected but \"%s\" found";
7546 else if (value < 0 && isplus)
7548 msg = US"non-negative integer expected but \"%s\" found";
7552 switch (tolower(*endptr))
7557 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7562 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7563 else value *= 1024*1024;
7567 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7568 else value *= 1024*1024*1024;
7572 if (errno == ERANGE)
7573 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7576 while (isspace(*endptr)) endptr++;
7577 if (*endptr == 0) return value;
7581 expand_string_message = string_sprintf(CS msg, s);
7586 /* These values are usually fixed boolean values, but they are permitted to be
7590 addr address being routed
7591 mtype the module type
7592 mname the module name
7593 dbg_opt debug selectors
7594 oname the option name
7595 bvalue the router's boolean value
7596 svalue the router's string value
7597 rvalue where to put the returned value
7599 Returns: OK value placed in rvalue
7600 DEFER expansion failed
7604 exp_bool(address_item *addr,
7605 uschar *mtype, uschar *mname, unsigned dbg_opt,
7606 uschar *oname, BOOL bvalue,
7607 uschar *svalue, BOOL *rvalue)
7610 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7612 expanded = expand_string(svalue);
7613 if (expanded == NULL)
7615 if (expand_string_forcedfail)
7617 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7621 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7622 oname, mname, mtype, expand_string_message);
7623 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7627 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7630 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7632 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7636 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7637 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7646 /* Avoid potentially exposing a password in a string about to be logged */
7649 expand_hide_passwords(uschar * s)
7651 return ( ( Ustrstr(s, "failed to expand") != NULL
7652 || Ustrstr(s, "expansion of ") != NULL
7654 && ( Ustrstr(s, "mysql") != NULL
7655 || Ustrstr(s, "pgsql") != NULL
7656 || Ustrstr(s, "redis") != NULL
7657 || Ustrstr(s, "sqlite") != NULL
7658 || Ustrstr(s, "ldap:") != NULL
7659 || Ustrstr(s, "ldaps:") != NULL
7660 || Ustrstr(s, "ldapi:") != NULL
7661 || Ustrstr(s, "ldapdn:") != NULL
7662 || Ustrstr(s, "ldapm:") != NULL
7664 ? US"Temporary internal error" : s;
7670 /*************************************************
7671 **************************************************
7672 * Stand-alone test program *
7673 **************************************************
7674 *************************************************/
7680 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7682 int ovector[3*(EXPAND_MAXN+1)];
7683 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7684 ovector, nelem(ovector));
7685 BOOL yield = n >= 0;
7686 if (n == 0) n = EXPAND_MAXN + 1;
7690 expand_nmax = (setup < 0)? 0 : setup + 1;
7691 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7693 expand_nstring[expand_nmax] = subject + ovector[nn];
7694 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7702 int main(int argc, uschar **argv)
7705 uschar buffer[1024];
7707 debug_selector = D_v;
7708 debug_file = stderr;
7709 debug_fd = fileno(debug_file);
7710 big_buffer = malloc(big_buffer_size);
7712 for (i = 1; i < argc; i++)
7714 if (argv[i][0] == '+')
7716 debug_trace_memory = 2;
7719 if (isdigit(argv[i][0]))
7720 debug_selector = Ustrtol(argv[i], NULL, 0);
7722 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7726 eldap_default_servers = argv[i];
7729 mysql_servers = argv[i];
7732 pgsql_servers = argv[i];
7735 redis_servers = argv[i];
7739 else opt_perl_startup = argv[i];
7743 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7745 expand_nstring[1] = US"string 1....";
7746 expand_nlength[1] = 8;
7750 if (opt_perl_startup != NULL)
7753 printf("Starting Perl interpreter\n");
7754 errstr = init_perl(opt_perl_startup);
7757 printf("** error in perl_startup code: %s\n", errstr);
7758 return EXIT_FAILURE;
7761 #endif /* EXIM_PERL */
7763 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7765 void *reset_point = store_get(0);
7766 uschar *yield = expand_string(buffer);
7769 printf("%s\n", yield);
7770 store_reset(reset_point);
7774 if (search_find_defer) printf("search_find deferred\n");
7775 printf("Failed: %s\n", expand_string_message);
7776 if (expand_string_forcedfail) printf("Forced failure\n");
7790 /* End of expand.c */