1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(const uschar *, BOOL, const uschar **, BOOL, BOOL, BOOL *);
17 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
20 #ifndef SUPPORT_CRYPTEQ
21 #define SUPPORT_CRYPTEQ
26 #include "lookups/ldap.h"
29 #ifdef SUPPORT_CRYPTEQ
34 extern char* crypt16(char*, char*);
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. Charaters after the first 16 are ignored. It always generates
50 a 16-byte hash, which is expressed together with the salt as a string
51 of 24 base 64 digits. Here are some links to peruse:
53 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
54 http://seclists.org/bugtraq/1999/Mar/0076.html
56 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
57 and OSF/1. This is the same as the standard crypt if given a password
58 of 8 characters or less. If given more, it first does the same as crypt
59 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
60 using as salt the first two base 64 digits from the first hash block.
61 If the password is more than 16 characters then it crypts the 17th to 24th
62 characters using as salt the first two base 64 digits from the second hash
63 block. And so on: I've seen references to it cutting off the password at
64 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
66 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
67 http://seclists.org/bugtraq/1999/Mar/0109.html
68 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
69 TET1_html/sec.c222.html#no_id_208
71 Exim has something it calls "crypt16". It will either use a native
72 crypt16 or its own implementation. A native crypt16 will presumably
73 be the one that I called "crypt16" above. The internal "crypt16"
74 function, however, is a two-block-maximum implementation of what I called
75 "bigcrypt". The documentation matches the internal code.
77 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
78 that crypt16 and bigcrypt were different things.
80 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
81 to whatever it is using under that name. This unfortunately sets a
82 precedent for using "{crypt16}" to identify two incompatible algorithms
83 whose output can't be distinguished. With "{crypt16}" thus rendered
84 ambiguous, I suggest you deprecate it and invent two new identifiers
85 for the two algorithms.
87 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
88 of the password separately means they can be cracked separately, so
89 the double-length hash only doubles the cracking effort instead of
90 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
114 #ifdef EXPERIMENTAL_INTERNATIONAL
144 #ifdef EXPERIMENTAL_INTERNATIONAL
164 /* Tables of operator names, and corresponding switch numbers. The names must be
165 in alphabetical order. There are two tables, because underscore is used in some
166 cases to introduce arguments, whereas for other it is part of the name. This is
167 an historical mis-design. */
169 static uschar *op_table_underscore[] = {
172 US"quote_local_part",
176 #ifdef EXPERIMENTAL_INTERNATIONAL
177 ,US"utf8_domain_from_alabel",
178 US"utf8_domain_to_alabel",
179 US"utf8_localpart_from_alabel",
180 US"utf8_localpart_to_alabel"
187 EOP_QUOTE_LOCAL_PART,
191 #ifdef EXPERIMENTAL_INTERNATIONAL
192 ,EOP_UTF8_DOMAIN_FROM_ALABEL,
193 EOP_UTF8_DOMAIN_TO_ALABEL,
194 EOP_UTF8_LOCALPART_FROM_ALABEL,
195 EOP_UTF8_LOCALPART_TO_ALABEL
199 static uschar *op_table_main[] = {
238 EOP_ADDRESS = nelem(op_table_underscore),
276 /* Table of condition names, and corresponding switch numbers. The names must
277 be in alphabetical order. */
279 static uschar *cond_table[] = {
283 US"==", /* Backward compatibility */
316 US"match_local_part",
341 ECOND_FIRST_DELIVERY,
362 ECOND_MATCH_LOCAL_PART,
372 /* Types of table entry */
375 vtype_int, /* value is address of int */
376 vtype_filter_int, /* ditto, but recognized only when filtering */
377 vtype_ino, /* value is address of ino_t (not always an int) */
378 vtype_uid, /* value is address of uid_t (not always an int) */
379 vtype_gid, /* value is address of gid_t (not always an int) */
380 vtype_bool, /* value is address of bool */
381 vtype_stringptr, /* value is address of pointer to string */
382 vtype_msgbody, /* as stringptr, but read when first required */
383 vtype_msgbody_end, /* ditto, the end of the message */
384 vtype_msgheaders, /* the message's headers, processed */
385 vtype_msgheaders_raw, /* the message's headers, unprocessed */
386 vtype_localpart, /* extract local part from string */
387 vtype_domain, /* extract domain from string */
388 vtype_string_func, /* value is string returned by given function */
389 vtype_todbsdin, /* value not used; generate BSD inbox tod */
390 vtype_tode, /* value not used; generate tod in epoch format */
391 vtype_todel, /* value not used; generate tod in epoch/usec format */
392 vtype_todf, /* value not used; generate full tod */
393 vtype_todl, /* value not used; generate log tod */
394 vtype_todlf, /* value not used; generate log file datestamp tod */
395 vtype_todzone, /* value not used; generate time zone only */
396 vtype_todzulu, /* value not used; generate zulu tod */
397 vtype_reply, /* value not used; get reply from headers */
398 vtype_pid, /* value not used; result is pid */
399 vtype_host_lookup, /* value not used; get host name */
400 vtype_load_avg, /* value not used; result is int from os_getloadavg */
401 vtype_pspace, /* partition space; value is T/F for spool/log */
402 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
403 vtype_cert /* SSL certificate */
405 ,vtype_dkim /* Lookup of value in DKIM signature */
409 /* Type for main variable table */
417 /* Type for entries pointing to address/length pairs. Not currently
425 static uschar * fn_recipients(void);
427 /* This table must be kept in alphabetical order. */
429 static var_entry var_table[] = {
430 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
431 they will be confused with user-creatable ACL variables. */
432 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
433 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
434 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
435 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
436 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
437 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
438 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
439 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
440 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
441 { "acl_narg", vtype_int, &acl_narg },
442 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
443 { "address_data", vtype_stringptr, &deliver_address_data },
444 { "address_file", vtype_stringptr, &address_file },
445 { "address_pipe", vtype_stringptr, &address_pipe },
446 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
447 { "authenticated_id", vtype_stringptr, &authenticated_id },
448 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
449 { "authentication_failed",vtype_int, &authentication_failed },
450 #ifdef WITH_CONTENT_SCAN
451 { "av_failed", vtype_int, &av_failed },
453 #ifdef EXPERIMENTAL_BRIGHTMAIL
454 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
455 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
456 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
457 { "bmi_deliver", vtype_int, &bmi_deliver },
459 { "body_linecount", vtype_int, &body_linecount },
460 { "body_zerocount", vtype_int, &body_zerocount },
461 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
462 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
463 { "caller_gid", vtype_gid, &real_gid },
464 { "caller_uid", vtype_uid, &real_uid },
465 { "compile_date", vtype_stringptr, &version_date },
466 { "compile_number", vtype_stringptr, &version_cnumber },
467 { "config_dir", vtype_stringptr, &config_main_directory },
468 { "config_file", vtype_stringptr, &config_main_filename },
469 { "csa_status", vtype_stringptr, &csa_status },
470 #ifdef EXPERIMENTAL_DCC
471 { "dcc_header", vtype_stringptr, &dcc_header },
472 { "dcc_result", vtype_stringptr, &dcc_result },
474 #ifdef WITH_OLD_DEMIME
475 { "demime_errorlevel", vtype_int, &demime_errorlevel },
476 { "demime_reason", vtype_stringptr, &demime_reason },
479 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
480 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
481 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
482 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
483 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
484 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
485 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
486 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
487 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
488 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
489 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
490 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
491 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
492 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
493 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
494 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
495 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
496 { "dkim_signers", vtype_stringptr, &dkim_signers },
497 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
498 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
500 #ifdef EXPERIMENTAL_DMARC
501 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
502 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
503 { "dmarc_status", vtype_stringptr, &dmarc_status },
504 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
505 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
507 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
508 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
509 { "dnslist_text", vtype_stringptr, &dnslist_text },
510 { "dnslist_value", vtype_stringptr, &dnslist_value },
511 { "domain", vtype_stringptr, &deliver_domain },
512 { "domain_data", vtype_stringptr, &deliver_domain_data },
513 #ifdef EXPERIMENTAL_EVENT
514 { "event_data", vtype_stringptr, &event_data },
516 /*XXX want to use generic vars for as many of these as possible*/
517 { "event_defer_errno", vtype_int, &event_defer_errno },
519 { "event_name", vtype_stringptr, &event_name },
521 { "exim_gid", vtype_gid, &exim_gid },
522 { "exim_path", vtype_stringptr, &exim_path },
523 { "exim_uid", vtype_uid, &exim_uid },
524 { "exim_version", vtype_stringptr, &version_string },
525 #ifdef WITH_OLD_DEMIME
526 { "found_extension", vtype_stringptr, &found_extension },
528 { "headers_added", vtype_string_func, &fn_hdrs_added },
529 { "home", vtype_stringptr, &deliver_home },
530 { "host", vtype_stringptr, &deliver_host },
531 { "host_address", vtype_stringptr, &deliver_host_address },
532 { "host_data", vtype_stringptr, &host_data },
533 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
534 { "host_lookup_failed", vtype_int, &host_lookup_failed },
535 { "host_port", vtype_int, &deliver_host_port },
536 { "inode", vtype_ino, &deliver_inode },
537 { "interface_address", vtype_stringptr, &interface_address },
538 { "interface_port", vtype_int, &interface_port },
539 { "item", vtype_stringptr, &iterate_item },
541 { "ldap_dn", vtype_stringptr, &eldap_dn },
543 { "load_average", vtype_load_avg, NULL },
544 { "local_part", vtype_stringptr, &deliver_localpart },
545 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
546 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
547 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
548 { "local_scan_data", vtype_stringptr, &local_scan_data },
549 { "local_user_gid", vtype_gid, &local_user_gid },
550 { "local_user_uid", vtype_uid, &local_user_uid },
551 { "localhost_number", vtype_int, &host_number },
552 { "log_inodes", vtype_pinodes, (void *)FALSE },
553 { "log_space", vtype_pspace, (void *)FALSE },
554 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
555 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
556 #ifdef WITH_CONTENT_SCAN
557 { "malware_name", vtype_stringptr, &malware_name },
559 { "max_received_linelength", vtype_int, &max_received_linelength },
560 { "message_age", vtype_int, &message_age },
561 { "message_body", vtype_msgbody, &message_body },
562 { "message_body_end", vtype_msgbody_end, &message_body_end },
563 { "message_body_size", vtype_int, &message_body_size },
564 { "message_exim_id", vtype_stringptr, &message_id },
565 { "message_headers", vtype_msgheaders, NULL },
566 { "message_headers_raw", vtype_msgheaders_raw, NULL },
567 { "message_id", vtype_stringptr, &message_id },
568 { "message_linecount", vtype_int, &message_linecount },
569 { "message_size", vtype_int, &message_size },
570 #ifdef EXPERIMENTAL_INTERNATIONAL
571 { "message_smtputf8", vtype_bool, &message_smtputf8 },
573 #ifdef WITH_CONTENT_SCAN
574 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
575 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
576 { "mime_boundary", vtype_stringptr, &mime_boundary },
577 { "mime_charset", vtype_stringptr, &mime_charset },
578 { "mime_content_description", vtype_stringptr, &mime_content_description },
579 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
580 { "mime_content_id", vtype_stringptr, &mime_content_id },
581 { "mime_content_size", vtype_int, &mime_content_size },
582 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
583 { "mime_content_type", vtype_stringptr, &mime_content_type },
584 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
585 { "mime_filename", vtype_stringptr, &mime_filename },
586 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
587 { "mime_is_multipart", vtype_int, &mime_is_multipart },
588 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
589 { "mime_part_count", vtype_int, &mime_part_count },
591 { "n0", vtype_filter_int, &filter_n[0] },
592 { "n1", vtype_filter_int, &filter_n[1] },
593 { "n2", vtype_filter_int, &filter_n[2] },
594 { "n3", vtype_filter_int, &filter_n[3] },
595 { "n4", vtype_filter_int, &filter_n[4] },
596 { "n5", vtype_filter_int, &filter_n[5] },
597 { "n6", vtype_filter_int, &filter_n[6] },
598 { "n7", vtype_filter_int, &filter_n[7] },
599 { "n8", vtype_filter_int, &filter_n[8] },
600 { "n9", vtype_filter_int, &filter_n[9] },
601 { "original_domain", vtype_stringptr, &deliver_domain_orig },
602 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
603 { "originator_gid", vtype_gid, &originator_gid },
604 { "originator_uid", vtype_uid, &originator_uid },
605 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
606 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
607 { "pid", vtype_pid, NULL },
608 { "primary_hostname", vtype_stringptr, &primary_hostname },
609 #ifdef EXPERIMENTAL_PROXY
610 { "proxy_host_address", vtype_stringptr, &proxy_host_address },
611 { "proxy_host_port", vtype_int, &proxy_host_port },
612 { "proxy_session", vtype_bool, &proxy_session },
613 { "proxy_target_address",vtype_stringptr, &proxy_target_address },
614 { "proxy_target_port", vtype_int, &proxy_target_port },
616 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
617 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
618 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
619 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
620 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
621 { "rcpt_count", vtype_int, &rcpt_count },
622 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
623 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
624 { "received_count", vtype_int, &received_count },
625 { "received_for", vtype_stringptr, &received_for },
626 { "received_ip_address", vtype_stringptr, &interface_address },
627 { "received_port", vtype_int, &interface_port },
628 { "received_protocol", vtype_stringptr, &received_protocol },
629 { "received_time", vtype_int, &received_time },
630 { "recipient_data", vtype_stringptr, &recipient_data },
631 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
632 { "recipients", vtype_string_func, &fn_recipients },
633 { "recipients_count", vtype_int, &recipients_count },
634 #ifdef WITH_CONTENT_SCAN
635 { "regex_match_string", vtype_stringptr, ®ex_match_string },
637 { "reply_address", vtype_reply, NULL },
638 { "return_path", vtype_stringptr, &return_path },
639 { "return_size_limit", vtype_int, &bounce_return_size_limit },
640 { "router_name", vtype_stringptr, &router_name },
641 { "runrc", vtype_int, &runrc },
642 { "self_hostname", vtype_stringptr, &self_hostname },
643 { "sender_address", vtype_stringptr, &sender_address },
644 { "sender_address_data", vtype_stringptr, &sender_address_data },
645 { "sender_address_domain", vtype_domain, &sender_address },
646 { "sender_address_local_part", vtype_localpart, &sender_address },
647 { "sender_data", vtype_stringptr, &sender_data },
648 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
649 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },
650 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
651 { "sender_host_address", vtype_stringptr, &sender_host_address },
652 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
653 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
654 { "sender_host_name", vtype_host_lookup, NULL },
655 { "sender_host_port", vtype_int, &sender_host_port },
656 { "sender_ident", vtype_stringptr, &sender_ident },
657 { "sender_rate", vtype_stringptr, &sender_rate },
658 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
659 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
660 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
661 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
662 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
663 { "sending_port", vtype_int, &sending_port },
664 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
665 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
666 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
667 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
668 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
669 { "sn0", vtype_filter_int, &filter_sn[0] },
670 { "sn1", vtype_filter_int, &filter_sn[1] },
671 { "sn2", vtype_filter_int, &filter_sn[2] },
672 { "sn3", vtype_filter_int, &filter_sn[3] },
673 { "sn4", vtype_filter_int, &filter_sn[4] },
674 { "sn5", vtype_filter_int, &filter_sn[5] },
675 { "sn6", vtype_filter_int, &filter_sn[6] },
676 { "sn7", vtype_filter_int, &filter_sn[7] },
677 { "sn8", vtype_filter_int, &filter_sn[8] },
678 { "sn9", vtype_filter_int, &filter_sn[9] },
679 #ifdef WITH_CONTENT_SCAN
680 { "spam_action", vtype_stringptr, &spam_action },
681 { "spam_bar", vtype_stringptr, &spam_bar },
682 { "spam_report", vtype_stringptr, &spam_report },
683 { "spam_score", vtype_stringptr, &spam_score },
684 { "spam_score_int", vtype_stringptr, &spam_score_int },
686 #ifdef EXPERIMENTAL_SPF
687 { "spf_guess", vtype_stringptr, &spf_guess },
688 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
689 { "spf_received", vtype_stringptr, &spf_received },
690 { "spf_result", vtype_stringptr, &spf_result },
691 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
693 { "spool_directory", vtype_stringptr, &spool_directory },
694 { "spool_inodes", vtype_pinodes, (void *)TRUE },
695 { "spool_space", vtype_pspace, (void *)TRUE },
696 #ifdef EXPERIMENTAL_SRS
697 { "srs_db_address", vtype_stringptr, &srs_db_address },
698 { "srs_db_key", vtype_stringptr, &srs_db_key },
699 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
700 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
701 { "srs_recipient", vtype_stringptr, &srs_recipient },
702 { "srs_status", vtype_stringptr, &srs_status },
704 { "thisaddress", vtype_stringptr, &filter_thisaddress },
706 /* The non-(in,out) variables are now deprecated */
707 { "tls_bits", vtype_int, &tls_in.bits },
708 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
709 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
711 { "tls_in_bits", vtype_int, &tls_in.bits },
712 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
713 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
714 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
715 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
716 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
717 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
718 #if defined(SUPPORT_TLS)
719 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
721 { "tls_out_bits", vtype_int, &tls_out.bits },
722 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
723 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
724 #ifdef EXPERIMENTAL_DANE
725 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
727 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
728 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
729 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
730 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
731 #if defined(SUPPORT_TLS)
732 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
734 #ifdef EXPERIMENTAL_DANE
735 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
738 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
739 #if defined(SUPPORT_TLS)
740 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
743 { "tod_bsdinbox", vtype_todbsdin, NULL },
744 { "tod_epoch", vtype_tode, NULL },
745 { "tod_epoch_l", vtype_todel, NULL },
746 { "tod_full", vtype_todf, NULL },
747 { "tod_log", vtype_todl, NULL },
748 { "tod_logfile", vtype_todlf, NULL },
749 { "tod_zone", vtype_todzone, NULL },
750 { "tod_zulu", vtype_todzulu, NULL },
751 { "transport_name", vtype_stringptr, &transport_name },
752 { "value", vtype_stringptr, &lookup_value },
753 { "verify_mode", vtype_stringptr, &verify_mode },
754 { "version_number", vtype_stringptr, &version_string },
755 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
756 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
757 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
758 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
759 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
760 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
763 static int var_table_size = nelem(var_table);
764 static uschar var_buffer[256];
765 static BOOL malformed_header;
767 /* For textual hashes */
769 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
770 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
773 enum { HMAC_MD5, HMAC_SHA1 };
775 /* For numeric hashes */
777 static unsigned int prime[] = {
778 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
779 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
780 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
782 /* For printing modes in symbolic form */
784 static uschar *mtable_normal[] =
785 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
787 static uschar *mtable_setid[] =
788 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
790 static uschar *mtable_sticky[] =
791 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
795 /*************************************************
796 * Tables for UTF-8 support *
797 *************************************************/
799 /* Table of the number of extra characters, indexed by the first character
800 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
803 static uschar utf8_table1[] = {
804 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
805 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
806 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
807 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
809 /* These are the masks for the data bits in the first byte of a character,
810 indexed by the number of additional bytes. */
812 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
814 /* Get the next UTF-8 character, advancing the pointer. */
816 #define GETUTF8INC(c, ptr) \
818 if ((c & 0xc0) == 0xc0) \
820 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
822 c = (c & utf8_table2[a]) << s; \
826 c |= (*ptr++ & 0x3f) << s; \
831 /*************************************************
832 * Binary chop search on a table *
833 *************************************************/
835 /* This is used for matching expansion items and operators.
838 name the name that is being sought
839 table the table to search
840 table_size the number of items in the table
842 Returns: the offset in the table, or -1
846 chop_match(uschar *name, uschar **table, int table_size)
848 uschar **bot = table;
849 uschar **top = table + table_size;
853 uschar **mid = bot + (top - bot)/2;
854 int c = Ustrcmp(name, *mid);
855 if (c == 0) return mid - table;
856 if (c > 0) bot = mid + 1; else top = mid;
864 /*************************************************
865 * Check a condition string *
866 *************************************************/
868 /* This function is called to expand a string, and test the result for a "true"
869 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
870 forced fail or lookup defer.
872 We used to release all store used, but this is not not safe due
873 to ${dlfunc } and ${acl }. In any case expand_string_internal()
874 is reasonably careful to release what it can.
876 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
879 condition the condition string
880 m1 text to be incorporated in panic error
883 Returns: TRUE if condition is met, FALSE if not
887 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
890 uschar *ss = expand_string(condition);
893 if (!expand_string_forcedfail && !search_find_defer)
894 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
895 "for %s %s: %s", condition, m1, m2, expand_string_message);
898 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
899 strcmpic(ss, US"false") != 0;
906 /*************************************************
907 * Pseudo-random number generation *
908 *************************************************/
910 /* Pseudo-random number generation. The result is not "expected" to be
911 cryptographically strong but not so weak that someone will shoot themselves
912 in the foot using it as a nonce in some email header scheme or whatever
913 weirdness they'll twist this into. The result should ideally handle fork().
915 However, if we're stuck unable to provide this, then we'll fall back to
916 appallingly bad randomness.
918 If SUPPORT_TLS is defined then this will not be used except as an emergency
923 Returns a random number in range [0, max-1]
927 # define vaguely_random_number vaguely_random_number_fallback
930 vaguely_random_number(int max)
933 # undef vaguely_random_number
935 static pid_t pid = 0;
937 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
947 #ifdef HAVE_ARC4RANDOM
948 /* cryptographically strong randomness, common on *BSD platforms, not
949 so much elsewhere. Alas. */
950 #ifndef NOT_HAVE_ARC4RANDOM_STIR
953 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
954 #ifdef HAVE_SRANDOMDEV
955 /* uses random(4) for seeding */
958 gettimeofday(&tv, NULL);
959 srandom(tv.tv_sec | tv.tv_usec | getpid());
962 /* Poor randomness and no seeding here */
969 #ifdef HAVE_ARC4RANDOM
970 return arc4random() % max;
971 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
972 return random() % max;
974 /* This one returns a 16-bit number, definitely not crypto-strong */
975 return random_number(max);
982 /*************************************************
983 * Pick out a name from a string *
984 *************************************************/
986 /* If the name is too long, it is silently truncated.
989 name points to a buffer into which to put the name
990 max is the length of the buffer
991 s points to the first alphabetic character of the name
992 extras chars other than alphanumerics to permit
994 Returns: pointer to the first character after the name
996 Note: The test for *s != 0 in the while loop is necessary because
997 Ustrchr() yields non-NULL if the character is zero (which is not something
1000 static const uschar *
1001 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1004 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1006 if (ptr < max-1) name[ptr++] = *s;
1015 /*************************************************
1016 * Pick out the rest of a header name *
1017 *************************************************/
1019 /* A variable name starting $header_ (or just $h_ for those who like
1020 abbreviations) might not be the complete header name because headers can
1021 contain any printing characters in their names, except ':'. This function is
1022 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1023 on the end, if the name was terminated by white space.
1026 name points to a buffer in which the name read so far exists
1027 max is the length of the buffer
1028 s points to the first character after the name so far, i.e. the
1029 first non-alphameric character after $header_xxxxx
1031 Returns: a pointer to the first character after the header name
1034 static const uschar *
1035 read_header_name(uschar *name, int max, const uschar *s)
1037 int prelen = Ustrchr(name, '_') - name + 1;
1038 int ptr = Ustrlen(name) - prelen;
1039 if (ptr > 0) memmove(name, name+prelen, ptr);
1040 while (mac_isgraph(*s) && *s != ':')
1042 if (ptr < max-1) name[ptr++] = *s;
1053 /*************************************************
1054 * Pick out a number from a string *
1055 *************************************************/
1058 n points to an integer into which to put the number
1059 s points to the first digit of the number
1061 Returns: a pointer to the character after the last digit
1065 read_number(int *n, uschar *s)
1068 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1072 static const uschar *
1073 read_cnumber(int *n, const uschar *s)
1076 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1082 /*************************************************
1083 * Extract keyed subfield from a string *
1084 *************************************************/
1086 /* The yield is in dynamic store; NULL means that the key was not found.
1089 key points to the name of the key
1090 s points to the string from which to extract the subfield
1092 Returns: NULL if the subfield was not found, or
1093 a pointer to the subfield's data
1097 expand_getkeyed(uschar *key, const uschar *s)
1099 int length = Ustrlen(key);
1100 while (isspace(*s)) s++;
1102 /* Loop to search for the key */
1108 const uschar *dkey = s;
1110 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1111 dkeylength = s - dkey;
1112 while (isspace(*s)) s++;
1113 if (*s == '=') while (isspace((*(++s))));
1115 data = string_dequote(&s);
1116 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1119 while (isspace(*s)) s++;
1128 find_var_ent(uschar * name)
1131 int last = var_table_size;
1133 while (last > first)
1135 int middle = (first + last)/2;
1136 int c = Ustrcmp(name, var_table[middle].name);
1138 if (c > 0) { first = middle + 1; continue; }
1139 if (c < 0) { last = middle; continue; }
1140 return &var_table[middle];
1145 /*************************************************
1146 * Extract numbered subfield from string *
1147 *************************************************/
1149 /* Extracts a numbered field from a string that is divided by tokens - for
1150 example a line from /etc/passwd is divided by colon characters. First field is
1151 numbered one. Negative arguments count from the right. Zero returns the whole
1152 string. Returns NULL if there are insufficient tokens in the string
1155 Modifies final argument - this is a dynamically generated string, so that's OK.
1158 field number of field to be extracted,
1159 first field = 1, whole string = 0, last field = -1
1160 separators characters that are used to break string into tokens
1161 s points to the string from which to extract the subfield
1163 Returns: NULL if the field was not found,
1164 a pointer to the field's data inside s (modified to add 0)
1168 expand_gettokened (int field, uschar *separators, uschar *s)
1173 uschar *fieldtext = NULL;
1175 if (field == 0) return s;
1177 /* Break the line up into fields in place; for field > 0 we stop when we have
1178 done the number of fields we want. For field < 0 we continue till the end of
1179 the string, counting the number of fields. */
1181 count = (field > 0)? field : INT_MAX;
1187 /* Previous field was the last one in the string. For a positive field
1188 number, this means there are not enough fields. For a negative field number,
1189 check that there are enough, and scan back to find the one that is wanted. */
1193 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1194 if ((-field) == (INT_MAX - count - 1)) return s;
1198 while (ss[-1] != 0) ss--;
1204 /* Previous field was not last in the string; save its start and put a
1208 len = Ustrcspn(ss, separators);
1219 expand_getlistele(int field, const uschar * list)
1221 const uschar * tlist= list;
1227 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1230 if(field==0) return NULL;
1231 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1232 return string_nextinlist(&list, &sep, NULL, 0);
1236 /* Certificate fields, by name. Worry about by-OID later */
1237 /* Names are chosen to not have common prefixes */
1244 uschar * (*getfn)(void * cert, uschar * mod);
1246 static certfield certfields[] =
1247 { /* linear search; no special order */
1248 { US"version", 7, &tls_cert_version },
1249 { US"serial_number", 13, &tls_cert_serial_number },
1250 { US"subject", 7, &tls_cert_subject },
1251 { US"notbefore", 9, &tls_cert_not_before },
1252 { US"notafter", 8, &tls_cert_not_after },
1253 { US"issuer", 6, &tls_cert_issuer },
1254 { US"signature", 9, &tls_cert_signature },
1255 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1256 { US"subj_altname", 12, &tls_cert_subject_altname },
1257 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1258 { US"crl_uri", 7, &tls_cert_crl_uri },
1262 expand_getcertele(uschar * field, uschar * certvar)
1267 if (!(vp = find_var_ent(certvar)))
1269 expand_string_message =
1270 string_sprintf("no variable named \"%s\"", certvar);
1271 return NULL; /* Unknown variable name */
1273 /* NB this stops us passing certs around in variable. Might
1274 want to do that in future */
1275 if (vp->type != vtype_cert)
1277 expand_string_message =
1278 string_sprintf("\"%s\" is not a certificate", certvar);
1279 return NULL; /* Unknown variable name */
1281 if (!*(void **)vp->value)
1284 if (*field >= '0' && *field <= '9')
1285 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1287 for(cp = certfields;
1288 cp < certfields + nelem(certfields);
1290 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1292 uschar * modifier = *(field += cp->namelen) == ','
1294 return (*cp->getfn)( *(void **)vp->value, modifier );
1297 expand_string_message =
1298 string_sprintf("bad field selector \"%s\" for certextract", field);
1301 #endif /*SUPPORT_TLS*/
1303 /*************************************************
1304 * Extract a substring from a string *
1305 *************************************************/
1307 /* Perform the ${substr or ${length expansion operations.
1310 subject the input string
1311 value1 the offset from the start of the input string to the start of
1312 the output string; if negative, count from the right.
1313 value2 the length of the output string, or negative (-1) for unset
1314 if value1 is positive, unset means "all after"
1315 if value1 is negative, unset means "all before"
1316 len set to the length of the returned string
1318 Returns: pointer to the output string, or NULL if there is an error
1322 extract_substr(uschar *subject, int value1, int value2, int *len)
1324 int sublen = Ustrlen(subject);
1326 if (value1 < 0) /* count from right */
1330 /* If the position is before the start, skip to the start, and adjust the
1331 length. If the length ends up negative, the substring is null because nothing
1332 can precede. This falls out naturally when the length is unset, meaning "all
1338 if (value2 < 0) value2 = 0;
1342 /* Otherwise an unset length => characters before value1 */
1344 else if (value2 < 0)
1351 /* For a non-negative offset, if the starting position is past the end of the
1352 string, the result will be the null string. Otherwise, an unset length means
1353 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1357 if (value1 > sublen)
1362 else if (value2 < 0) value2 = sublen;
1365 /* Cut the length down to the maximum possible for the offset value, and get
1366 the required characters. */
1368 if (value1 + value2 > sublen) value2 = sublen - value1;
1370 return subject + value1;
1376 /*************************************************
1377 * Old-style hash of a string *
1378 *************************************************/
1380 /* Perform the ${hash expansion operation.
1383 subject the input string (an expanded substring)
1384 value1 the length of the output string; if greater or equal to the
1385 length of the input string, the input string is returned
1386 value2 the number of hash characters to use, or 26 if negative
1387 len set to the length of the returned string
1389 Returns: pointer to the output string, or NULL if there is an error
1393 compute_hash(uschar *subject, int value1, int value2, int *len)
1395 int sublen = Ustrlen(subject);
1397 if (value2 < 0) value2 = 26;
1398 else if (value2 > Ustrlen(hashcodes))
1400 expand_string_message =
1401 string_sprintf("hash count \"%d\" too big", value2);
1405 /* Calculate the hash text. We know it is shorter than the original string, so
1406 can safely place it in subject[] (we know that subject is always itself an
1407 expanded substring). */
1409 if (value1 < sublen)
1414 while ((c = (subject[j])) != 0)
1416 int shift = (c + j++) & 7;
1417 subject[i] ^= (c << shift) | (c >> (8-shift));
1418 if (++i >= value1) i = 0;
1420 for (i = 0; i < value1; i++)
1421 subject[i] = hashcodes[(subject[i]) % value2];
1423 else value1 = sublen;
1432 /*************************************************
1433 * Numeric hash of a string *
1434 *************************************************/
1436 /* Perform the ${nhash expansion operation. The first characters of the
1437 string are treated as most important, and get the highest prime numbers.
1440 subject the input string
1441 value1 the maximum value of the first part of the result
1442 value2 the maximum value of the second part of the result,
1443 or negative to produce only a one-part result
1444 len set to the length of the returned string
1446 Returns: pointer to the output string, or NULL if there is an error.
1450 compute_nhash (uschar *subject, int value1, int value2, int *len)
1452 uschar *s = subject;
1454 unsigned long int total = 0; /* no overflow */
1458 if (i == 0) i = nelem(prime) - 1;
1459 total += prime[i--] * (unsigned int)(*s++);
1462 /* If value2 is unset, just compute one number */
1466 s = string_sprintf("%d", total % value1);
1469 /* Otherwise do a div/mod hash */
1473 total = total % (value1 * value2);
1474 s = string_sprintf("%d/%d", total/value2, total % value2);
1485 /*************************************************
1486 * Find the value of a header or headers *
1487 *************************************************/
1489 /* Multiple instances of the same header get concatenated, and this function
1490 can also return a concatenation of all the header lines. When concatenating
1491 specific headers that contain lists of addresses, a comma is inserted between
1492 them. Otherwise we use a straight concatenation. Because some messages can have
1493 pathologically large number of lines, there is a limit on the length that is
1494 returned. Also, to avoid massive store use which would result from using
1495 string_cat() as it copies and extends strings, we do a preliminary pass to find
1496 out exactly how much store will be needed. On "normal" messages this will be
1500 name the name of the header, without the leading $header_ or $h_,
1501 or NULL if a concatenation of all headers is required
1502 exists_only TRUE if called from a def: test; don't need to build a string;
1503 just return a string that is not "" and not "0" if the header
1505 newsize return the size of memory block that was obtained; may be NULL
1506 if exists_only is TRUE
1507 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1508 other than concatenating, will be done on the header. Also used
1509 for $message_headers_raw.
1510 charset name of charset to translate MIME words to; used only if
1511 want_raw is false; if NULL, no translation is done (this is
1512 used for $bh_ and $bheader_)
1514 Returns: NULL if the header does not exist, else a pointer to a new
1519 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1522 BOOL found = name == NULL;
1524 int len = found? 0 : Ustrlen(name);
1526 uschar *yield = NULL;
1529 /* Loop for two passes - saves code repetition */
1531 for (i = 0; i < 2; i++)
1536 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1538 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1540 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1545 if (exists_only) return US"1"; /* don't need actual string */
1547 t = h->text + len; /* text to insert */
1548 if (!want_raw) /* unless wanted raw, */
1549 while (isspace(*t)) t++; /* remove leading white space */
1550 ilen = h->slen - (t - h->text); /* length to insert */
1552 /* Unless wanted raw, remove trailing whitespace, including the
1556 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1558 /* Set comma = 1 if handling a single header and it's one of those
1559 that contains an address list, except when asked for raw headers. Only
1560 need to do this once. */
1562 if (!want_raw && name != NULL && comma == 0 &&
1563 Ustrchr("BCFRST", h->type) != NULL)
1566 /* First pass - compute total store needed; second pass - compute
1567 total store used, including this header. */
1569 size += ilen + comma + 1; /* +1 for the newline */
1571 /* Second pass - concatentate the data, up to a maximum. Note that
1572 the loop stops when size hits the limit. */
1576 if (size > header_insert_maxlen)
1578 ilen -= size - header_insert_maxlen - 1;
1581 Ustrncpy(ptr, t, ilen);
1584 /* For a non-raw header, put in the comma if needed, then add
1585 back the newline we removed above, provided there was some text in
1588 if (!want_raw && ilen > 0)
1590 if (comma != 0) *ptr++ = ',';
1598 /* At end of first pass, return NULL if no header found. Then truncate size
1599 if necessary, and get the buffer to hold the data, returning the buffer size.
1604 if (!found) return NULL;
1605 if (size > header_insert_maxlen) size = header_insert_maxlen;
1606 *newsize = size + 1;
1607 ptr = yield = store_get(*newsize);
1611 /* That's all we do for raw header expansion. */
1618 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1619 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1620 function can return an error with decoded data if the charset translation
1621 fails. If decoding fails, it returns NULL. */
1625 uschar *decoded, *error;
1626 if (ptr > yield && ptr[-1] == '\n') ptr--;
1627 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1629 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1633 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1634 " input was: %s\n", error, yield);
1636 if (decoded != NULL) yield = decoded;
1645 /*************************************************
1646 * Return list of recipients *
1647 *************************************************/
1648 /* A recipients list is available only during system message filtering,
1649 during ACL processing after DATA, and while expanding pipe commands
1650 generated from a system filter, but not elsewhere. */
1655 if (!enable_dollar_recipients) return NULL; else
1660 uschar * s = store_get(size);
1661 for (i = 0; i < recipients_count; i++)
1663 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1664 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1665 Ustrlen(recipients_list[i].address));
1667 s[ptr] = 0; /* string_cat() leaves room */
1673 /*************************************************
1674 * Find value of a variable *
1675 *************************************************/
1677 /* The table of variables is kept in alphabetic order, so we can search it
1678 using a binary chop. The "choplen" variable is nothing to do with the binary
1682 name the name of the variable being sought
1683 exists_only TRUE if this is a def: test; passed on to find_header()
1684 skipping TRUE => skip any processing evaluation; this is not the same as
1685 exists_only because def: may test for values that are first
1687 newsize pointer to an int which is initially zero; if the answer is in
1688 a new memory buffer, *newsize is set to its size
1690 Returns: NULL if the variable does not exist, or
1691 a pointer to the variable's contents, or
1692 something non-NULL if exists_only is TRUE
1696 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1703 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1704 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1705 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1706 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1707 (this gave backwards compatibility at the changeover). There may be built-in
1708 variables whose names start acl_ but they should never start in this way. This
1709 slightly messy specification is a consequence of the history, needless to say.
1711 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1712 set, in which case give an error. */
1714 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1718 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1719 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1722 /* Handle $auth<n> variables. */
1724 if (Ustrncmp(name, "auth", 4) == 0)
1727 int n = Ustrtoul(name + 4, &endptr, 10);
1728 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1729 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1732 /* For all other variables, search the table */
1734 if (!(vp = find_var_ent(name)))
1735 return NULL; /* Unknown variable name */
1737 /* Found an existing variable. If in skipping state, the value isn't needed,
1738 and we want to avoid processing (such as looking up the host name). */
1746 case vtype_filter_int:
1747 if (!filter_running) return NULL;
1751 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1755 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1759 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1763 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1767 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1770 case vtype_stringptr: /* Pointer to string */
1771 s = *((uschar **)(val));
1772 return (s == NULL)? US"" : s;
1775 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1778 case vtype_load_avg:
1779 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1782 case vtype_host_lookup: /* Lookup if not done so */
1783 if (sender_host_name == NULL && sender_host_address != NULL &&
1784 !host_lookup_failed && host_name_lookup() == OK)
1785 host_build_sender_fullhost();
1786 return (sender_host_name == NULL)? US"" : sender_host_name;
1788 case vtype_localpart: /* Get local part from address */
1789 s = *((uschar **)(val));
1790 if (s == NULL) return US"";
1791 domain = Ustrrchr(s, '@');
1792 if (domain == NULL) return s;
1793 if (domain - s > sizeof(var_buffer) - 1)
1794 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1795 " in string expansion", sizeof(var_buffer));
1796 Ustrncpy(var_buffer, s, domain - s);
1797 var_buffer[domain - s] = 0;
1800 case vtype_domain: /* Get domain from address */
1801 s = *((uschar **)(val));
1802 if (s == NULL) return US"";
1803 domain = Ustrrchr(s, '@');
1804 return (domain == NULL)? US"" : domain + 1;
1806 case vtype_msgheaders:
1807 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1809 case vtype_msgheaders_raw:
1810 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1812 case vtype_msgbody: /* Pointer to msgbody string */
1813 case vtype_msgbody_end: /* Ditto, the end of the msg */
1814 ss = (uschar **)(val);
1815 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1818 off_t start_offset = SPOOL_DATA_START_OFFSET;
1819 int len = message_body_visible;
1820 if (len > message_size) len = message_size;
1821 *ss = body = store_malloc(len+1);
1823 if (vp->type == vtype_msgbody_end)
1825 struct stat statbuf;
1826 if (fstat(deliver_datafile, &statbuf) == 0)
1828 start_offset = statbuf.st_size - len;
1829 if (start_offset < SPOOL_DATA_START_OFFSET)
1830 start_offset = SPOOL_DATA_START_OFFSET;
1833 lseek(deliver_datafile, start_offset, SEEK_SET);
1834 len = read(deliver_datafile, body, len);
1838 if (message_body_newlines) /* Separate loops for efficiency */
1841 { if (body[--len] == 0) body[len] = ' '; }
1846 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1850 return (*ss == NULL)? US"" : *ss;
1852 case vtype_todbsdin: /* BSD inbox time of day */
1853 return tod_stamp(tod_bsdin);
1855 case vtype_tode: /* Unix epoch time of day */
1856 return tod_stamp(tod_epoch);
1858 case vtype_todel: /* Unix epoch/usec time of day */
1859 return tod_stamp(tod_epoch_l);
1861 case vtype_todf: /* Full time of day */
1862 return tod_stamp(tod_full);
1864 case vtype_todl: /* Log format time of day */
1865 return tod_stamp(tod_log_bare); /* (without timezone) */
1867 case vtype_todzone: /* Time zone offset only */
1868 return tod_stamp(tod_zone);
1870 case vtype_todzulu: /* Zulu time */
1871 return tod_stamp(tod_zulu);
1873 case vtype_todlf: /* Log file datestamp tod */
1874 return tod_stamp(tod_log_datestamp_daily);
1876 case vtype_reply: /* Get reply address */
1877 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1879 if (s != NULL) while (isspace(*s)) s++;
1880 if (s == NULL || *s == 0)
1882 *newsize = 0; /* For the *s==0 case */
1883 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1888 while (isspace(*s)) s++;
1889 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1890 while (t > s && isspace(t[-1])) t--;
1893 return (s == NULL)? US"" : s;
1895 case vtype_string_func:
1897 uschar * (*fn)() = val;
1904 sprintf(CS var_buffer, "%d",
1905 receive_statvfs(val == (void *)TRUE, &inodes));
1912 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1913 sprintf(CS var_buffer, "%d", inodes);
1918 return *(void **)val ? US"<cert>" : US"";
1920 #ifndef DISABLE_DKIM
1922 return dkim_exim_expand_query((int)(long)val);
1927 return NULL; /* Unknown variable. Silences static checkers. */
1934 modify_variable(uschar *name, void * value)
1937 if ((vp = find_var_ent(name))) vp->value = value;
1938 return; /* Unknown variable name, fail silently */
1945 /*************************************************
1946 * Read and expand substrings *
1947 *************************************************/
1949 /* This function is called to read and expand argument substrings for various
1950 expansion items. Some have a minimum requirement that is less than the maximum;
1951 in these cases, the first non-present one is set to NULL.
1954 sub points to vector of pointers to set
1955 n maximum number of substrings
1957 sptr points to current string pointer
1958 skipping the skipping flag
1959 check_end if TRUE, check for final '}'
1960 name name of item, for error message
1961 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1964 Returns: 0 OK; string pointer updated
1965 1 curly bracketing error (too few arguments)
1966 2 too many arguments (only if check_end is set); message set
1967 3 other error (expansion failure)
1971 read_subs(uschar **sub, int n, int m, const uschar **sptr, BOOL skipping,
1972 BOOL check_end, uschar *name, BOOL *resetok)
1975 const uschar *s = *sptr;
1977 while (isspace(*s)) s++;
1978 for (i = 0; i < n; i++)
1982 if (i < m) return 1;
1986 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
1987 if (sub[i] == NULL) return 3;
1988 if (*s++ != '}') return 1;
1989 while (isspace(*s)) s++;
1991 if (check_end && *s++ != '}')
1995 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1996 "(max is %d)", name, n);
2009 /*************************************************
2010 * Elaborate message for bad variable *
2011 *************************************************/
2013 /* For the "unknown variable" message, take a look at the variable's name, and
2014 give additional information about possible ACL variables. The extra information
2015 is added on to expand_string_message.
2017 Argument: the name of the variable
2022 check_variable_error_message(uschar *name)
2024 if (Ustrncmp(name, "acl_", 4) == 0)
2025 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2026 (name[4] == 'c' || name[4] == 'm')?
2028 US"6th character of a user-defined ACL variable must be a digit or underscore" :
2029 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2031 US"user-defined ACL variables must start acl_c or acl_m");
2037 Load args from sub array to globals, and call acl_check().
2038 Sub array will be corrupted on return.
2040 Returns: OK access is granted by an ACCEPT verb
2041 DISCARD access is granted by a DISCARD verb
2042 FAIL access is denied
2043 FAIL_DROP access is denied; drop the connection
2044 DEFER can't tell at the moment
2048 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2051 int sav_narg = acl_narg;
2053 uschar * dummy_logmsg;
2054 extern int acl_where;
2056 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2057 for (i = 0; i < nsub && sub[i+1]; i++)
2059 uschar * tmp = acl_arg[i];
2060 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2061 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2066 sub[i+1] = acl_arg[i];
2067 acl_arg[i++] = NULL;
2071 debug_printf("expanding: acl: %s arg: %s%s\n",
2073 acl_narg>0 ? acl_arg[0] : US"<none>",
2074 acl_narg>1 ? " +more" : "");
2076 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2078 for (i = 0; i < nsub; i++)
2079 acl_arg[i] = sub[i+1]; /* restore old args */
2080 acl_narg = sav_narg;
2088 /*************************************************
2089 * Read and evaluate a condition *
2090 *************************************************/
2094 s points to the start of the condition text
2095 resetok points to a BOOL which is written false if it is unsafe to
2096 free memory. Certain condition types (acl) may have side-effect
2097 allocation which must be preserved.
2098 yield points to a BOOL to hold the result of the condition test;
2099 if NULL, we are just reading through a condition that is
2100 part of an "or" combination to check syntax, or in a state
2101 where the answer isn't required
2103 Returns: a pointer to the first character after the condition, or
2107 static const uschar *
2108 eval_condition(const uschar *s, BOOL *resetok, BOOL *yield)
2110 BOOL testfor = TRUE;
2111 BOOL tempcond, combined_cond;
2113 BOOL sub2_honour_dollar = TRUE;
2114 int i, rc, cond_type, roffset;
2115 int_eximarith_t num[2];
2116 struct stat statbuf;
2118 const uschar *sub[10];
2121 const uschar *rerror;
2125 while (isspace(*s)) s++;
2126 if (*s == '!') { testfor = !testfor; s++; } else break;
2129 /* Numeric comparisons are symbolic */
2131 if (*s == '=' || *s == '>' || *s == '<')
2143 /* All other conditions are named */
2145 else s = read_name(name, 256, s, US"_");
2147 /* If we haven't read a name, it means some non-alpha character is first. */
2151 expand_string_message = string_sprintf("condition name expected, "
2152 "but found \"%.16s\"", s);
2156 /* Find which condition we are dealing with, and switch on it */
2158 cond_type = chop_match(name, cond_table, nelem(cond_table));
2161 /* def: tests for a non-empty variable, or for the existence of a header. If
2162 yield == NULL we are in a skipping state, and don't care about the answer. */
2167 expand_string_message = US"\":\" expected after \"def\"";
2171 s = read_name(name, 256, s+1, US"_");
2173 /* Test for a header's existence. If the name contains a closing brace
2174 character, this may be a user error where the terminating colon has been
2175 omitted. Set a flag to adjust a subsequent error message in this case. */
2177 if (Ustrncmp(name, "h_", 2) == 0 ||
2178 Ustrncmp(name, "rh_", 3) == 0 ||
2179 Ustrncmp(name, "bh_", 3) == 0 ||
2180 Ustrncmp(name, "header_", 7) == 0 ||
2181 Ustrncmp(name, "rheader_", 8) == 0 ||
2182 Ustrncmp(name, "bheader_", 8) == 0)
2184 s = read_header_name(name, 256, s);
2185 /* {-for-text-editors */
2186 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2187 if (yield != NULL) *yield =
2188 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2191 /* Test for a variable's having a non-empty value. A non-existent variable
2192 causes an expansion failure. */
2196 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2199 expand_string_message = (name[0] == 0)?
2200 string_sprintf("variable name omitted after \"def:\"") :
2201 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2202 check_variable_error_message(name);
2205 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2211 /* first_delivery tests for first delivery attempt */
2213 case ECOND_FIRST_DELIVERY:
2214 if (yield != NULL) *yield = deliver_firsttime == testfor;
2218 /* queue_running tests for any process started by a queue runner */
2220 case ECOND_QUEUE_RUNNING:
2221 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2225 /* exists: tests for file existence
2226 isip: tests for any IP address
2227 isip4: tests for an IPv4 address
2228 isip6: tests for an IPv6 address
2229 pam: does PAM authentication
2230 radius: does RADIUS authentication
2231 ldapauth: does LDAP authentication
2232 pwcheck: does Cyrus SASL pwcheck authentication
2241 case ECOND_LDAPAUTH:
2244 while (isspace(*s)) s++;
2245 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2247 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2248 if (sub[0] == NULL) return NULL;
2249 /* {-for-text-editors */
2250 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2252 if (yield == NULL) return s; /* No need to run the test if skipping */
2257 if ((expand_forbid & RDO_EXISTS) != 0)
2259 expand_string_message = US"File existence tests are not permitted";
2262 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2268 rc = string_is_ip_address(sub[0], NULL);
2269 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2270 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2273 /* Various authentication tests - all optionally compiled */
2277 rc = auth_call_pam(sub[0], &expand_string_message);
2280 goto COND_FAILED_NOT_COMPILED;
2281 #endif /* SUPPORT_PAM */
2284 #ifdef RADIUS_CONFIG_FILE
2285 rc = auth_call_radius(sub[0], &expand_string_message);
2288 goto COND_FAILED_NOT_COMPILED;
2289 #endif /* RADIUS_CONFIG_FILE */
2291 case ECOND_LDAPAUTH:
2294 /* Just to keep the interface the same */
2296 int old_pool = store_pool;
2297 store_pool = POOL_SEARCH;
2298 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2299 &expand_string_message, &do_cache);
2300 store_pool = old_pool;
2304 goto COND_FAILED_NOT_COMPILED;
2305 #endif /* LOOKUP_LDAP */
2308 #ifdef CYRUS_PWCHECK_SOCKET
2309 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2312 goto COND_FAILED_NOT_COMPILED;
2313 #endif /* CYRUS_PWCHECK_SOCKET */
2315 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2316 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2318 if (rc == ERROR || rc == DEFER) return NULL;
2319 *yield = (rc == OK) == testfor;
2325 /* call ACL (in a conditional context). Accept true, deny false.
2326 Defer is a forced-fail. Anything set by message= goes to $value.
2327 Up to ten parameters are used; we use the braces round the name+args
2328 like the saslauthd condition does, to permit a variable number of args.
2329 See also the expansion-item version EITEM_ACL and the traditional
2330 acl modifier ACLC_ACL.
2331 Since the ACL may allocate new global variables, tell our caller to not
2336 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2344 while (isspace(*s)) s++;
2345 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2347 switch(read_subs(sub, nelem(sub), 1,
2348 &s, yield == NULL, TRUE, US"acl", resetok))
2350 case 1: expand_string_message = US"too few arguments or bracketing "
2353 case 3: return NULL;
2357 if (yield != NULL) switch(eval_acl(sub, nelem(sub), &user_msg))
2362 lookup_value = NULL;
2365 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2366 lookup_value[ptr] = '\0';
2368 *yield = cond == testfor;
2372 expand_string_forcedfail = TRUE;
2374 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2381 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2383 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2385 However, the last two are optional. That is why the whole set is enclosed
2386 in their own set of braces. */
2388 case ECOND_SASLAUTHD:
2389 #ifndef CYRUS_SASLAUTHD_SOCKET
2390 goto COND_FAILED_NOT_COMPILED;
2394 while (isspace(*s)) s++;
2395 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2396 switch(read_subs(sub, nelem(sub), 2, &s, yield == NULL, TRUE, US"saslauthd",
2399 case 1: expand_string_message = US"too few arguments or bracketing "
2400 "error for saslauthd";
2402 case 3: return NULL;
2404 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2407 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2408 &expand_string_message);
2409 if (rc == ERROR || rc == DEFER) return NULL;
2410 *yield = (rc == OK) == testfor;
2414 #endif /* CYRUS_SASLAUTHD_SOCKET */
2417 /* symbolic operators for numeric and string comparison, and a number of
2418 other operators, all requiring two arguments.
2420 crypteq: encrypts plaintext and compares against an encrypted text,
2421 using crypt(), crypt16(), MD5 or SHA-1
2422 inlist/inlisti: checks if first argument is in the list of the second
2423 match: does a regular expression match and sets up the numerical
2424 variables if it succeeds
2425 match_address: matches in an address list
2426 match_domain: matches in a domain list
2427 match_ip: matches a host list that is restricted to IP addresses
2428 match_local_part: matches in a local part list
2431 case ECOND_MATCH_ADDRESS:
2432 case ECOND_MATCH_DOMAIN:
2433 case ECOND_MATCH_IP:
2434 case ECOND_MATCH_LOCAL_PART:
2435 #ifndef EXPAND_LISTMATCH_RHS
2436 sub2_honour_dollar = FALSE;
2445 case ECOND_NUM_L: /* Numerical comparisons */
2452 case ECOND_STR_LT: /* String comparisons */
2463 for (i = 0; i < 2; i++)
2465 /* Sometimes, we don't expand substrings; too many insecure configurations
2466 created using match_address{}{} and friends, where the second param
2467 includes information from untrustworthy sources. */
2468 BOOL honour_dollar = TRUE;
2469 if ((i > 0) && !sub2_honour_dollar)
2470 honour_dollar = FALSE;
2472 while (isspace(*s)) s++;
2475 if (i == 0) goto COND_FAILED_CURLY_START;
2476 expand_string_message = string_sprintf("missing 2nd string in {} "
2477 "after \"%s\"", name);
2480 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2481 honour_dollar, resetok);
2482 if (sub[i] == NULL) return NULL;
2483 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2485 /* Convert to numerical if required; we know that the names of all the
2486 conditions that compare numbers do not start with a letter. This just saves
2487 checking for them individually. */
2489 if (!isalpha(name[0]) && yield != NULL)
2495 debug_printf("empty string cast to zero for numerical comparison\n");
2499 num[i] = expanded_string_integer(sub[i], FALSE);
2500 if (expand_string_message != NULL) return NULL;
2505 /* Result not required */
2507 if (yield == NULL) return s;
2509 /* Do an appropriate comparison */
2515 tempcond = (num[0] == num[1]);
2519 tempcond = (num[0] > num[1]);
2523 tempcond = (num[0] >= num[1]);
2527 tempcond = (num[0] < num[1]);
2531 tempcond = (num[0] <= num[1]);
2535 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2539 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2543 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2547 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2551 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2555 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2559 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2563 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2567 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2571 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2574 case ECOND_MATCH: /* Regular expression match */
2575 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2579 expand_string_message = string_sprintf("regular expression error in "
2580 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2583 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2586 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2587 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2588 goto MATCHED_SOMETHING;
2590 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2591 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2592 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2593 goto MATCHED_SOMETHING;
2595 case ECOND_MATCH_IP: /* Match IP address in a host list */
2596 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2598 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2604 unsigned int *nullcache = NULL;
2605 check_host_block cb;
2607 cb.host_name = US"";
2608 cb.host_address = sub[0];
2610 /* If the host address starts off ::ffff: it is an IPv6 address in
2611 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2614 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2615 cb.host_address + 7 : cb.host_address;
2617 rc = match_check_list(
2618 &sub[1], /* the list */
2619 0, /* separator character */
2620 &hostlist_anchor, /* anchor pointer */
2621 &nullcache, /* cache pointer */
2622 check_host, /* function for testing */
2623 &cb, /* argument for function */
2624 MCL_HOST, /* type of check */
2625 sub[0], /* text for debugging */
2626 NULL); /* where to pass back data */
2628 goto MATCHED_SOMETHING;
2630 case ECOND_MATCH_LOCAL_PART:
2631 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2632 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2647 expand_string_message = string_sprintf("unable to complete match "
2648 "against \"%s\": %s", sub[1], search_error_message);
2654 /* Various "encrypted" comparisons. If the second string starts with
2655 "{" then an encryption type is given. Default to crypt() or crypt16()
2656 (build-time choice). */
2657 /* }-for-text-editors */
2660 #ifndef SUPPORT_CRYPTEQ
2661 goto COND_FAILED_NOT_COMPILED;
2663 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2665 int sublen = Ustrlen(sub[1]+5);
2670 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2672 /* If the length that we are comparing against is 24, the MD5 digest
2673 is expressed as a base64 string. This is the way LDAP does it. However,
2674 some other software uses a straightforward hex representation. We assume
2675 this if the length is 32. Other lengths fail. */
2679 uschar *coded = auth_b64encode((uschar *)digest, 16);
2680 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2681 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2682 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2684 else if (sublen == 32)
2688 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2690 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2691 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2692 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2696 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2697 "fail\n crypted=%s\n", sub[1]+5);
2702 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2704 int sublen = Ustrlen(sub[1]+6);
2709 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2711 /* If the length that we are comparing against is 28, assume the SHA1
2712 digest is expressed as a base64 string. If the length is 40, assume a
2713 straightforward hex representation. Other lengths fail. */
2717 uschar *coded = auth_b64encode((uschar *)digest, 20);
2718 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2719 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2720 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2722 else if (sublen == 40)
2726 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2728 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2729 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2730 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2734 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2735 "fail\n crypted=%s\n", sub[1]+6);
2740 else /* {crypt} or {crypt16} and non-{ at start */
2741 /* }-for-text-editors */
2746 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2751 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2756 else if (sub[1][0] == '{') /* }-for-text-editors */
2758 expand_string_message = string_sprintf("unknown encryption mechanism "
2759 "in \"%s\"", sub[1]);
2765 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2766 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2767 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2771 #define XSTR(s) STR(s)
2772 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2773 " subject=%s\n crypted=%s\n",
2774 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2779 /* If the encrypted string contains fewer than two characters (for the
2780 salt), force failure. Otherwise we get false positives: with an empty
2781 string the yield of crypt() is an empty string! */
2783 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2784 (Ustrcmp(coded, sub[1]) == 0);
2787 #endif /* SUPPORT_CRYPTEQ */
2792 const uschar * list = sub[1];
2794 uschar *save_iterate_item = iterate_item;
2795 int (*compare)(const uschar *, const uschar *);
2797 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2800 compare = cond_type == ECOND_INLISTI
2801 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
2803 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
2804 if (compare(sub[0], iterate_item) == 0)
2809 iterate_item = save_iterate_item;
2812 } /* Switch for comparison conditions */
2814 *yield = tempcond == testfor;
2815 return s; /* End of comparison conditions */
2818 /* and/or: computes logical and/or of several conditions */
2822 subcondptr = (yield == NULL)? NULL : &tempcond;
2823 combined_cond = (cond_type == ECOND_AND);
2825 while (isspace(*s)) s++;
2826 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2830 while (isspace(*s)) s++;
2831 /* {-for-text-editors */
2832 if (*s == '}') break;
2833 if (*s != '{') /* }-for-text-editors */
2835 expand_string_message = string_sprintf("each subcondition "
2836 "inside an \"%s{...}\" condition must be in its own {}", name);
2840 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2842 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2843 expand_string_message, name);
2846 while (isspace(*s)) s++;
2848 /* {-for-text-editors */
2851 /* {-for-text-editors */
2852 expand_string_message = string_sprintf("missing } at end of condition "
2853 "inside \"%s\" group", name);
2859 if (cond_type == ECOND_AND)
2861 combined_cond &= tempcond;
2862 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2863 } /* evaluate any more */
2866 combined_cond |= tempcond;
2867 if (combined_cond) subcondptr = NULL; /* once true, don't */
2868 } /* evaluate any more */
2872 if (yield != NULL) *yield = (combined_cond == testfor);
2876 /* forall/forany: iterates a condition with different values */
2881 const uschar * list;
2883 uschar *save_iterate_item = iterate_item;
2885 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2887 while (isspace(*s)) s++;
2888 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2889 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2890 if (sub[0] == NULL) return NULL;
2891 /* {-for-text-editors */
2892 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2894 while (isspace(*s)) s++;
2895 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2899 /* Call eval_condition once, with result discarded (as if scanning a
2900 "false" part). This allows us to find the end of the condition, because if
2901 the list it empty, we won't actually evaluate the condition for real. */
2903 if (!(s = eval_condition(sub[1], resetok, NULL)))
2905 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2906 expand_string_message, name);
2909 while (isspace(*s)) s++;
2911 /* {-for-text-editors */
2914 /* {-for-text-editors */
2915 expand_string_message = string_sprintf("missing } at end of condition "
2916 "inside \"%s\"", name);
2920 if (yield != NULL) *yield = !testfor;
2922 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
2924 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2925 if (!eval_condition(sub[1], resetok, &tempcond))
2927 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2928 expand_string_message, name);
2929 iterate_item = save_iterate_item;
2932 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2933 tempcond? "true":"false");
2935 if (yield != NULL) *yield = (tempcond == testfor);
2936 if (tempcond == (cond_type == ECOND_FORANY)) break;
2939 iterate_item = save_iterate_item;
2944 /* The bool{} expansion condition maps a string to boolean.
2945 The values supported should match those supported by the ACL condition
2946 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2947 of true/false. Note that Router "condition" rules have a different
2948 interpretation, where general data can be used and only a few values
2950 Note that readconf.c boolean matching, for boolean configuration options,
2951 only matches true/yes/false/no.
2952 The bool_lax{} condition matches the Router logic, which is much more
2955 case ECOND_BOOL_LAX:
2961 BOOL boolvalue = FALSE;
2962 while (isspace(*s)) s++;
2963 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2964 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2965 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2967 case 1: expand_string_message = string_sprintf(
2968 "too few arguments or bracketing error for %s",
2972 case 3: return NULL;
2975 while (isspace(*t)) t++;
2979 /* trailing whitespace: seems like a good idea to ignore it too */
2981 while (isspace(*t2)) t2--;
2982 if (t2 != (t + len))
2989 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2990 /* logic for the lax case from expand_check_condition(), which also does
2991 expands, and the logic is both short and stable enough that there should
2992 be no maintenance burden from replicating it. */
2996 ? Ustrspn(t+1, "0123456789") == len-1
2997 : Ustrspn(t, "0123456789") == len)
2999 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3000 /* expand_check_condition only does a literal string "0" check */
3001 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3004 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3006 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3008 else if (cond_type == ECOND_BOOL_LAX)
3012 expand_string_message = string_sprintf("unrecognised boolean "
3016 if (yield != NULL) *yield = (boolvalue == testfor);
3020 /* Unknown condition */
3023 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
3025 } /* End switch on condition type */
3027 /* Missing braces at start and end of data */
3029 COND_FAILED_CURLY_START:
3030 expand_string_message = string_sprintf("missing { after \"%s\"", name);
3033 COND_FAILED_CURLY_END:
3034 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3038 /* A condition requires code that is not compiled */
3040 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3041 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3042 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3043 COND_FAILED_NOT_COMPILED:
3044 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3053 /*************************************************
3054 * Save numerical variables *
3055 *************************************************/
3057 /* This function is called from items such as "if" that want to preserve and
3058 restore the numbered variables.
3061 save_expand_string points to an array of pointers to set
3062 save_expand_nlength points to an array of ints for the lengths
3064 Returns: the value of expand max to save
3068 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3071 for (i = 0; i <= expand_nmax; i++)
3073 save_expand_nstring[i] = expand_nstring[i];
3074 save_expand_nlength[i] = expand_nlength[i];
3081 /*************************************************
3082 * Restore numerical variables *
3083 *************************************************/
3085 /* This function restored saved values of numerical strings.
3088 save_expand_nmax the number of strings to restore
3089 save_expand_string points to an array of pointers
3090 save_expand_nlength points to an array of ints
3096 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3097 int *save_expand_nlength)
3100 expand_nmax = save_expand_nmax;
3101 for (i = 0; i <= expand_nmax; i++)
3103 expand_nstring[i] = save_expand_nstring[i];
3104 expand_nlength[i] = save_expand_nlength[i];
3112 /*************************************************
3113 * Handle yes/no substrings *
3114 *************************************************/
3116 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3117 alternative substrings that depend on whether or not the condition was true,
3118 or the lookup or extraction succeeded. The substrings always have to be
3119 expanded, to check their syntax, but "skipping" is set when the result is not
3120 needed - this avoids unnecessary nested lookups.
3123 skipping TRUE if we were skipping when this item was reached
3124 yes TRUE if the first string is to be used, else use the second
3125 save_lookup a value to put back into lookup_value before the 2nd expansion
3126 sptr points to the input string pointer
3127 yieldptr points to the output string pointer
3128 sizeptr points to the output string size
3129 ptrptr points to the output string pointer
3130 type "lookup" or "if" or "extract" or "run", for error message
3131 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3134 Returns: 0 OK; lookup_value has been reset to save_lookup
3136 2 expansion failed because of bracketing error
3140 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, const uschar **sptr,
3141 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3144 const uschar *s = *sptr; /* Local value */
3145 uschar *sub1, *sub2;
3147 /* If there are no following strings, we substitute the contents of $value for
3148 lookups and for extractions in the success case. For the ${if item, the string
3149 "true" is substituted. In the fail case, nothing is substituted for all three
3152 while (isspace(*s)) s++;
3157 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3161 if (yes && lookup_value != NULL)
3162 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3163 Ustrlen(lookup_value));
3164 lookup_value = save_lookup;
3170 /* The first following string must be braced. */
3172 if (*s++ != '{') goto FAILED_CURLY;
3174 /* Expand the first substring. Forced failures are noticed only if we actually
3175 want this string. Set skipping in the call in the fail case (this will always
3176 be the case if we were already skipping). */
3178 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3179 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3180 expand_string_forcedfail = FALSE;
3181 if (*s++ != '}') goto FAILED_CURLY;
3183 /* If we want the first string, add it to the output */
3186 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3188 /* If this is called from a lookup or an extract, we want to restore $value to
3189 what it was at the start of the item, so that it has this value during the
3190 second string expansion. For the call from "if" or "run" to this function,
3191 save_lookup is set to lookup_value, so that this statement does nothing. */
3193 lookup_value = save_lookup;
3195 /* There now follows either another substring, or "fail", or nothing. This
3196 time, forced failures are noticed only if we want the second string. We must
3197 set skipping in the nested call if we don't want this string, or if we were
3198 already skipping. */
3200 while (isspace(*s)) s++;
3203 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3204 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3205 expand_string_forcedfail = FALSE;
3206 if (*s++ != '}') goto FAILED_CURLY;
3208 /* If we want the second string, add it to the output */
3211 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3214 /* If there is no second string, but the word "fail" is present when the use of
3215 the second string is wanted, set a flag indicating it was a forced failure
3216 rather than a syntactic error. Swallow the terminating } in case this is nested
3217 inside another lookup or if or extract. */
3222 /* deconst cast ok here as source is s anyway */
3223 s = US read_name(name, sizeof(name), s, US"_");
3224 if (Ustrcmp(name, "fail") == 0)
3226 if (!yes && !skipping)
3228 while (isspace(*s)) s++;
3229 if (*s++ != '}') goto FAILED_CURLY;
3230 expand_string_message =
3231 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3232 expand_string_forcedfail = TRUE;
3238 expand_string_message =
3239 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3244 /* All we have to do now is to check on the final closing brace. */
3246 while (isspace(*s)) s++;
3247 if (*s++ == '}') goto RETURN;
3249 /* Get here if there is a bracketing failure */
3254 /* Get here for other failures */
3259 /* Update the input pointer value before returning */
3269 /*************************************************
3270 * Handle MD5 or SHA-1 computation for HMAC *
3271 *************************************************/
3273 /* These are some wrapping functions that enable the HMAC code to be a bit
3274 cleaner. A good compiler will spot the tail recursion.
3277 type HMAC_MD5 or HMAC_SHA1
3278 remaining are as for the cryptographic hash functions
3284 chash_start(int type, void *base)
3286 if (type == HMAC_MD5)
3287 md5_start((md5 *)base);
3289 sha1_start((sha1 *)base);
3293 chash_mid(int type, void *base, uschar *string)
3295 if (type == HMAC_MD5)
3296 md5_mid((md5 *)base, string);
3298 sha1_mid((sha1 *)base, string);
3302 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3304 if (type == HMAC_MD5)
3305 md5_end((md5 *)base, string, length, digest);
3307 sha1_end((sha1 *)base, string, length, digest);
3314 /********************************************************
3315 * prvs: Get last three digits of days since Jan 1, 1970 *
3316 ********************************************************/
3318 /* This is needed to implement the "prvs" BATV reverse
3321 Argument: integer "days" offset to add or substract to
3322 or from the current number of days.
3324 Returns: pointer to string containing the last three
3325 digits of the number of days since Jan 1, 1970,
3326 modified by the offset argument, NULL if there
3327 was an error in the conversion.
3332 prvs_daystamp(int day_offset)
3334 uschar *days = store_get(32); /* Need at least 24 for cases */
3335 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3336 (time(NULL) + day_offset*86400)/86400);
3337 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3342 /********************************************************
3343 * prvs: perform HMAC-SHA1 computation of prvs bits *
3344 ********************************************************/
3346 /* This is needed to implement the "prvs" BATV reverse
3350 address RFC2821 Address to use
3351 key The key to use (must be less than 64 characters
3353 key_num Single-digit key number to use. Defaults to
3356 Returns: pointer to string containing the first three
3357 bytes of the final hash in hex format, NULL if
3358 there was an error in the process.
3362 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3364 uschar *hash_source, *p;
3365 int size = 0,offset = 0,i;
3367 void *use_base = &sha1_base;
3368 uschar innerhash[20];
3369 uschar finalhash[20];
3370 uschar innerkey[64];
3371 uschar outerkey[64];
3372 uschar *finalhash_hex = store_get(40);
3374 if (key_num == NULL)
3377 if (Ustrlen(key) > 64)
3380 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3381 string_cat(hash_source,&size,&offset,daystamp,3);
3382 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3383 hash_source[offset] = '\0';
3385 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3387 memset(innerkey, 0x36, 64);
3388 memset(outerkey, 0x5c, 64);
3390 for (i = 0; i < Ustrlen(key); i++)
3392 innerkey[i] ^= key[i];
3393 outerkey[i] ^= key[i];
3396 chash_start(HMAC_SHA1, use_base);
3397 chash_mid(HMAC_SHA1, use_base, innerkey);
3398 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3400 chash_start(HMAC_SHA1, use_base);
3401 chash_mid(HMAC_SHA1, use_base, outerkey);
3402 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3405 for (i = 0; i < 3; i++)
3407 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3408 *p++ = hex_digits[finalhash[i] & 0x0f];
3412 return finalhash_hex;
3418 /*************************************************
3419 * Join a file onto the output string *
3420 *************************************************/
3422 /* This is used for readfile and after a run expansion. It joins the contents
3423 of a file onto the output string, globally replacing newlines with a given
3424 string (optionally). The file is closed at the end.
3428 yield pointer to the expandable string
3429 sizep pointer to the current size
3430 ptrp pointer to the current position
3431 eol newline replacement string, or NULL
3433 Returns: new value of string pointer
3437 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3440 uschar buffer[1024];
3442 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3444 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3446 int len = Ustrlen(buffer);
3447 if (eol != NULL && buffer[len-1] == '\n') len--;
3448 yield = string_cat(yield, sizep, ptrp, buffer, len);
3449 if (buffer[len] != 0)
3450 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3453 if (yield != NULL) yield[*ptrp] = 0;
3461 /*************************************************
3462 * Evaluate numeric expression *
3463 *************************************************/
3465 /* This is a set of mutually recursive functions that evaluate an arithmetic
3466 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3467 these functions that is called from elsewhere is eval_expr, whose interface is:
3470 sptr pointer to the pointer to the string - gets updated
3471 decimal TRUE if numbers are to be assumed decimal
3472 error pointer to where to put an error message - must be NULL on input
3473 endket TRUE if ')' must terminate - FALSE for external call
3475 Returns: on success: the value of the expression, with *error still NULL
3476 on failure: an undefined value, with *error = a message
3479 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3482 static int_eximarith_t
3483 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3486 int_eximarith_t x = eval_op_or(&s, decimal, error);
3492 *error = US"expecting closing parenthesis";
3494 while (isspace(*(++s)));
3496 else if (*s != 0) *error = US"expecting operator";
3503 static int_eximarith_t
3504 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3509 while (isspace(*s)) s++;
3514 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3516 switch (tolower(*s))
3519 case 'k': n *= 1024; s++; break;
3520 case 'm': n *= 1024*1024; s++; break;
3521 case 'g': n *= 1024*1024*1024; s++; break;
3523 while (isspace (*s)) s++;
3528 n = eval_expr(&s, decimal, error, 1);
3532 *error = US"expecting number or opening parenthesis";
3540 static int_eximarith_t
3541 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3545 while (isspace(*s)) s++;
3546 if (*s == '+' || *s == '-' || *s == '~')
3549 x = eval_op_unary(&s, decimal, error);
3550 if (op == '-') x = -x;
3551 else if (op == '~') x = ~x;
3555 x = eval_number(&s, decimal, error);
3562 static int_eximarith_t
3563 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3566 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3569 while (*s == '*' || *s == '/' || *s == '%')
3572 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3573 if (*error != NULL) break;
3574 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3575 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3576 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3577 * -N*M is INT_MIN will yielf INT_MIN.
3578 * Since we don't support floating point, this is somewhat simpler.
3579 * Ideally, we'd return an error, but since we overflow for all other
3580 * arithmetic, consistency suggests otherwise, but what's the correct value
3581 * to use? There is none.
3582 * The C standard guarantees overflow for unsigned arithmetic but signed
3583 * overflow invokes undefined behaviour; in practice, this is overflow
3584 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3585 * that long/longlong larger than int are available, or we could just work
3586 * with larger types. We should consider whether to guarantee 32bit eval
3587 * and 64-bit working variables, with errors returned. For now ...
3588 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3589 * can just let the other invalid results occur otherwise, as they have
3590 * until now. For this one case, we can coerce.
3592 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3595 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3596 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3606 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3622 static int_eximarith_t
3623 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3626 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3629 while (*s == '+' || *s == '-')
3632 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3633 if (*error != NULL) break;
3634 if (op == '+') x += y; else x -= y;
3642 static int_eximarith_t
3643 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3646 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3649 while ((*s == '<' || *s == '>') && s[1] == s[0])
3654 y = eval_op_sum(&s, decimal, error);
3655 if (*error != NULL) break;
3656 if (op == '<') x <<= y; else x >>= y;
3664 static int_eximarith_t
3665 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3668 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3675 y = eval_op_shift(&s, decimal, error);
3676 if (*error != NULL) break;
3685 static int_eximarith_t
3686 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3689 int_eximarith_t x = eval_op_and(&s, decimal, error);
3696 y = eval_op_and(&s, decimal, error);
3697 if (*error != NULL) break;
3706 static int_eximarith_t
3707 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3710 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3717 y = eval_op_xor(&s, decimal, error);
3718 if (*error != NULL) break;
3728 /*************************************************
3730 *************************************************/
3732 /* Returns either an unchanged string, or the expanded string in stacking pool
3733 store. Interpreted sequences are:
3735 \... normal escaping rules
3736 $name substitutes the variable
3738 ${op:string} operates on the expanded string value
3739 ${item{arg1}{arg2}...} expands the args and then does the business
3740 some literal args are not enclosed in {}
3742 There are now far too many operators and item types to make it worth listing
3743 them here in detail any more.
3745 We use an internal routine recursively to handle embedded substrings. The
3746 external function follows. The yield is NULL if the expansion failed, and there
3747 are two cases: if something collapsed syntactically, or if "fail" was given
3748 as the action on a lookup failure. These can be distinguised by looking at the
3749 variable expand_string_forcedfail, which is TRUE in the latter case.
3751 The skipping flag is set true when expanding a substring that isn't actually
3752 going to be used (after "if" or "lookup") and it prevents lookups from
3753 happening lower down.
3755 Store usage: At start, a store block of the length of the input plus 64
3756 is obtained. This is expanded as necessary by string_cat(), which might have to
3757 get a new block, or might be able to expand the original. At the end of the
3758 function we can release any store above that portion of the yield block that
3759 was actually used. In many cases this will be optimal.
3761 However: if the first item in the expansion is a variable name or header name,
3762 we reset the store before processing it; if the result is in fresh store, we
3763 use that without copying. This is helpful for expanding strings like
3764 $message_headers which can get very long.
3766 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3767 since resetting the store at the end of the expansion will free store that was
3768 allocated by the plugin code as well as the slop after the expanded string. So
3769 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3770 and, given the acl condition, ${if }. This is an unfortunate consequence of
3771 string expansion becoming too powerful.
3774 string the string to be expanded
3775 ket_ends true if expansion is to stop at }
3776 left if not NULL, a pointer to the first character after the
3777 expansion is placed here (typically used with ket_ends)
3778 skipping TRUE for recursive calls when the value isn't actually going
3779 to be used (to allow for optimisation)
3780 honour_dollar TRUE if $ is to be expanded,
3781 FALSE if it's just another character
3782 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3785 Returns: NULL if expansion fails:
3786 expand_string_forcedfail is set TRUE if failure was forced
3787 expand_string_message contains a textual error message
3788 a pointer to the expanded string on success
3792 expand_string_internal(const uschar *string, BOOL ket_ends, const uschar **left,
3793 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3796 int size = Ustrlen(string)+ 64;
3798 uschar *yield = store_get(size);
3799 const uschar *s = string;
3800 uschar *save_expand_nstring[EXPAND_MAXN+1];
3801 int save_expand_nlength[EXPAND_MAXN+1];
3802 BOOL resetok = TRUE;
3804 expand_string_forcedfail = FALSE;
3805 expand_string_message = US"";
3812 /* \ escapes the next character, which must exist, or else
3813 the expansion fails. There's a special escape, \N, which causes
3814 copying of the subject verbatim up to the next \N. Otherwise,
3815 the escapes are the standard set. */
3821 expand_string_message = US"\\ at end of string";
3827 const uschar * t = s + 2;
3828 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3829 yield = string_cat(yield, &size, &ptr, t, s - t);
3830 if (*s != 0) s += 2;
3836 ch[0] = string_interpret_escape(&s);
3838 yield = string_cat(yield, &size, &ptr, ch, 1);
3845 /* Anything other than $ is just copied verbatim, unless we are
3846 looking for a terminating } character. */
3849 if (ket_ends && *s == '}') break;
3851 if (*s != '$' || !honour_dollar)
3853 yield = string_cat(yield, &size, &ptr, s++, 1);
3857 /* No { after the $ - must be a plain name or a number for string
3858 match variable. There has to be a fudge for variables that are the
3859 names of header fields preceded by "$header_" because header field
3860 names can contain any printing characters except space and colon.
3861 For those that don't like typing this much, "$h_" is a synonym for
3862 "$header_". A non-existent header yields a NULL value; nothing is
3865 if (isalpha((*(++s))))
3870 s = read_name(name, sizeof(name), s, US"_");
3872 /* If this is the first thing to be expanded, release the pre-allocated
3875 if (ptr == 0 && yield != NULL)
3877 if (resetok) store_reset(yield);
3884 if (Ustrncmp(name, "h_", 2) == 0 ||
3885 Ustrncmp(name, "rh_", 3) == 0 ||
3886 Ustrncmp(name, "bh_", 3) == 0 ||
3887 Ustrncmp(name, "header_", 7) == 0 ||
3888 Ustrncmp(name, "rheader_", 8) == 0 ||
3889 Ustrncmp(name, "bheader_", 8) == 0)
3891 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3892 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3893 s = read_header_name(name, sizeof(name), s);
3894 value = find_header(name, FALSE, &newsize, want_raw, charset);
3896 /* If we didn't find the header, and the header contains a closing brace
3897 character, this may be a user error where the terminating colon
3898 has been omitted. Set a flag to adjust the error message in this case.
3899 But there is no error here - nothing gets inserted. */
3903 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3912 value = find_variable(name, FALSE, skipping, &newsize);
3915 expand_string_message =
3916 string_sprintf("unknown variable name \"%s\"", name);
3917 check_variable_error_message(name);
3922 /* If the data is known to be in a new buffer, newsize will be set to the
3923 size of that buffer. If this is the first thing in an expansion string,
3924 yield will be NULL; just point it at the new store instead of copying. Many
3925 expansion strings contain just one reference, so this is a useful
3926 optimization, especially for humungous headers. */
3928 len = Ustrlen(value);
3929 if (yield == NULL && newsize != 0)
3935 else yield = string_cat(yield, &size, &ptr, value, len);
3943 s = read_cnumber(&n, s);
3944 if (n >= 0 && n <= expand_nmax)
3945 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3950 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3952 if (*s != '{') /*}*/
3954 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3958 /* After { there can be various things, but they all start with
3959 an initial word, except for a number for a string match variable. */
3961 if (isdigit((*(++s))))
3964 s = read_cnumber(&n, s); /*{*/
3967 expand_string_message = US"} expected after number";
3970 if (n >= 0 && n <= expand_nmax)
3971 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3978 expand_string_message = US"letter or digit expected after ${"; /*}*/
3982 /* Allow "-" in names to cater for substrings with negative
3983 arguments. Since we are checking for known names after { this is
3986 s = read_name(name, sizeof(name), s, US"_-");
3987 item_type = chop_match(name, item_table, nelem(item_table));
3991 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3992 If the ACL returns accept or reject we return content set by "message ="
3993 There is currently no limit on recursion; this would have us call
3994 acl_check_internal() directly and get a current level from somewhere.
3995 See also the acl expansion condition ECOND_ACL and the traditional
3996 acl modifier ACLC_ACL.
3997 Assume that the function has side-effects on the store that must be preserved.
4001 /* ${acl {name} {arg1}{arg2}...} */
4003 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4006 switch(read_subs(sub, nelem(sub), 1, &s, skipping, TRUE, US"acl",
4009 case 1: goto EXPAND_FAILED_CURLY;
4011 case 3: goto EXPAND_FAILED;
4013 if (skipping) continue;
4016 switch(eval_acl(sub, nelem(sub), &user_msg))
4021 debug_printf("acl expansion yield: %s\n", user_msg);
4023 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
4027 expand_string_forcedfail = TRUE;
4029 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
4034 /* Handle conditionals - preserve the values of the numerical expansion
4035 variables in case they get changed by a regular expression match in the
4036 condition. If not, they retain their external settings. At the end
4037 of this "if" section, they get restored to their previous values. */
4042 const uschar *next_s;
4043 int save_expand_nmax =
4044 save_expand_strings(save_expand_nstring, save_expand_nlength);
4046 while (isspace(*s)) s++;
4047 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
4048 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4051 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
4052 cond? "true" : "false");
4056 /* The handling of "yes" and "no" result strings is now in a separate
4057 function that is also used by ${lookup} and ${extract} and ${run}. */
4059 switch(process_yesno(
4060 skipping, /* were previously skipping */
4061 cond, /* success/failure indicator */
4062 lookup_value, /* value to reset for string2 */
4063 &s, /* input pointer */
4064 &yield, /* output pointer */
4065 &size, /* output size */
4066 &ptr, /* output current point */
4067 US"if", /* condition type */
4070 case 1: goto EXPAND_FAILED; /* when all is well, the */
4071 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4074 /* Restore external setting of expansion variables for continuation
4077 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4078 save_expand_nlength);
4082 #ifdef EXPERIMENTAL_INTERNATIONAL
4083 case EITEM_IMAPFOLDER:
4084 { /* ${imapfolder {name}{sep]{specials}} */
4088 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, skipping, TRUE, name,
4091 case 1: goto EXPAND_FAILED_CURLY;
4093 case 3: goto EXPAND_FAILED;
4096 if (sub_arg[1] == NULL) /* One argument */
4098 sub_arg[1] = US"/"; /* default separator */
4101 else if (Ustrlen(sub_arg[1]) != 1)
4103 expand_string_message =
4105 "IMAP folder separator must be one character, found \"%s\"",
4110 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4111 sub_arg[1][0], sub_arg[2], &expand_string_message)))
4114 yield = string_cat(yield, &size, &ptr, encoded, Ustrlen(encoded));
4119 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4120 expanding an internal string that isn't actually going to be used. All we
4121 need to do is check the syntax, so don't do a lookup at all. Preserve the
4122 values of the numerical expansion variables in case they get changed by a
4123 partial lookup. If not, they retain their external settings. At the end
4124 of this "lookup" section, they get restored to their previous values. */
4128 int stype, partial, affixlen, starflags;
4129 int expand_setup = 0;
4131 uschar *key, *filename;
4132 const uschar *affix;
4133 uschar *save_lookup_value = lookup_value;
4134 int save_expand_nmax =
4135 save_expand_strings(save_expand_nstring, save_expand_nlength);
4137 if ((expand_forbid & RDO_LOOKUP) != 0)
4139 expand_string_message = US"lookup expansions are not permitted";
4143 /* Get the key we are to look up for single-key+file style lookups.
4144 Otherwise set the key NULL pro-tem. */
4146 while (isspace(*s)) s++;
4147 if (*s == '{') /*}*/
4149 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4150 if (key == NULL) goto EXPAND_FAILED; /*{*/
4151 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4152 while (isspace(*s)) s++;
4156 /* Find out the type of database */
4160 expand_string_message = US"missing lookup type";
4164 /* The type is a string that may contain special characters of various
4165 kinds. Allow everything except space or { to appear; the actual content
4166 is checked by search_findtype_partial. */ /*}*/
4168 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4170 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4174 while (isspace(*s)) s++;
4176 /* Now check for the individual search type and any partial or default
4177 options. Only those types that are actually in the binary are valid. */
4179 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4183 expand_string_message = search_error_message;
4187 /* Check that a key was provided for those lookup types that need it,
4188 and was not supplied for those that use the query style. */
4190 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4194 expand_string_message = string_sprintf("missing {key} for single-"
4195 "key \"%s\" lookup", name);
4203 expand_string_message = string_sprintf("a single key was given for "
4204 "lookup type \"%s\", which is not a single-key lookup type", name);
4209 /* Get the next string in brackets and expand it. It is the file name for
4210 single-key+file lookups, and the whole query otherwise. In the case of
4211 queries that also require a file name (e.g. sqlite), the file name comes
4214 if (*s != '{') goto EXPAND_FAILED_CURLY;
4215 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4216 if (filename == NULL) goto EXPAND_FAILED;
4217 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4218 while (isspace(*s)) s++;
4220 /* If this isn't a single-key+file lookup, re-arrange the variables
4221 to be appropriate for the search_ functions. For query-style lookups,
4222 there is just a "key", and no file name. For the special query-style +
4223 file types, the query (i.e. "key") starts with a file name. */
4227 while (isspace(*filename)) filename++;
4230 if (mac_islookup(stype, lookup_querystyle))
4236 if (*filename != '/')
4238 expand_string_message = string_sprintf(
4239 "absolute file name expected for \"%s\" lookup", name);
4242 while (*key != 0 && !isspace(*key)) key++;
4243 if (*key != 0) *key++ = 0;
4247 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4248 the entry was not found. Note that there is no search_close() function.
4249 Files are left open in case of re-use. At suitable places in higher logic,
4250 search_tidyup() is called to tidy all open files. This can save opening
4251 the same file several times. However, files may also get closed when
4252 others are opened, if too many are open at once. The rule is that a
4253 handle should not be used after a second search_open().
4255 Request that a partial search sets up $1 and maybe $2 by passing
4256 expand_setup containing zero. If its value changes, reset expand_nmax,
4257 since new variables will have been set. Note that at the end of this
4258 "lookup" section, the old numeric variables are restored. */
4261 lookup_value = NULL;
4264 void *handle = search_open(filename, stype, 0, NULL, NULL);
4267 expand_string_message = search_error_message;
4270 lookup_value = search_find(handle, filename, key, partial, affix,
4271 affixlen, starflags, &expand_setup);
4272 if (search_find_defer)
4274 expand_string_message =
4275 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4276 string_printing2(key, FALSE), search_error_message);
4279 if (expand_setup > 0) expand_nmax = expand_setup;
4282 /* The handling of "yes" and "no" result strings is now in a separate
4283 function that is also used by ${if} and ${extract}. */
4285 switch(process_yesno(
4286 skipping, /* were previously skipping */
4287 lookup_value != NULL, /* success/failure indicator */
4288 save_lookup_value, /* value to reset for string2 */
4289 &s, /* input pointer */
4290 &yield, /* output pointer */
4291 &size, /* output size */
4292 &ptr, /* output current point */
4293 US"lookup", /* condition type */
4296 case 1: goto EXPAND_FAILED; /* when all is well, the */
4297 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4300 /* Restore external setting of expansion variables for carrying on
4301 at this level, and continue. */
4303 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4304 save_expand_nlength);
4308 /* If Perl support is configured, handle calling embedded perl subroutines,
4309 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4310 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4311 arguments (defined below). */
4313 #define EXIM_PERL_MAX_ARGS 8
4317 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4318 "is not included in this binary";
4321 #else /* EXIM_PERL */
4323 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4326 if ((expand_forbid & RDO_PERL) != 0)
4328 expand_string_message = US"Perl calls are not permitted";
4332 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4333 US"perl", &resetok))
4335 case 1: goto EXPAND_FAILED_CURLY;
4337 case 3: goto EXPAND_FAILED;
4340 /* If skipping, we don't actually do anything */
4342 if (skipping) continue;
4344 /* Start the interpreter if necessary */
4346 if (!opt_perl_started)
4349 if (opt_perl_startup == NULL)
4351 expand_string_message = US"A setting of perl_startup is needed when "
4352 "using the Perl interpreter";
4355 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4356 initerror = init_perl(opt_perl_startup);
4357 if (initerror != NULL)
4359 expand_string_message =
4360 string_sprintf("error in perl_startup code: %s\n", initerror);
4363 opt_perl_started = TRUE;
4366 /* Call the function */
4368 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4369 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4370 sub_arg[0], sub_arg + 1);
4372 /* NULL yield indicates failure; if the message pointer has been set to
4373 NULL, the yield was undef, indicating a forced failure. Otherwise the
4374 message will indicate some kind of Perl error. */
4376 if (new_yield == NULL)
4378 if (expand_string_message == NULL)
4380 expand_string_message =
4381 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4382 "failure", sub_arg[0]);
4383 expand_string_forcedfail = TRUE;
4388 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4389 set during a callback from Perl. */
4391 expand_string_forcedfail = FALSE;
4395 #endif /* EXIM_PERL */
4397 /* Transform email address to "prvs" scheme to use
4398 as BATV-signed return path */
4405 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4407 case 1: goto EXPAND_FAILED_CURLY;
4409 case 3: goto EXPAND_FAILED;
4412 /* If skipping, we don't actually do anything */
4413 if (skipping) continue;
4415 /* sub_arg[0] is the address */
4416 domain = Ustrrchr(sub_arg[0],'@');
4417 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4419 expand_string_message = US"prvs first argument must be a qualified email address";
4423 /* Calculate the hash. The second argument must be a single-digit
4424 key number, or unset. */
4426 if (sub_arg[2] != NULL &&
4427 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4429 expand_string_message = US"prvs second argument must be a single digit";
4433 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4436 expand_string_message = US"prvs hmac-sha1 conversion failed";
4440 /* Now separate the domain from the local part */
4443 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4444 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4445 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4446 string_cat(yield,&size,&ptr,p,6);
4447 string_cat(yield,&size,&ptr,US"=",1);
4448 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4449 string_cat(yield,&size,&ptr,US"@",1);
4450 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4455 /* Check a prvs-encoded address for validity */
4457 case EITEM_PRVSCHECK:
4460 int mysize = 0, myptr = 0;
4464 /* TF: Ugliness: We want to expand parameter 1 first, then set
4465 up expansion variables that are used in the expansion of
4466 parameter 2. So we clone the string for the first
4467 expansion, where we only expand parameter 1.
4469 PH: Actually, that isn't necessary. The read_subs() function is
4470 designed to work this way for the ${if and ${lookup expansions. I've
4474 /* Reset expansion variables */
4475 prvscheck_result = NULL;
4476 prvscheck_address = NULL;
4477 prvscheck_keynum = NULL;
4479 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4481 case 1: goto EXPAND_FAILED_CURLY;
4483 case 3: goto EXPAND_FAILED;
4486 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4489 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4491 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4492 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4493 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4494 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4495 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4497 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4498 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4499 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4500 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4501 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4503 /* Set up expansion variables */
4504 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4505 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4506 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4507 prvscheck_address[myptr] = '\0';
4508 prvscheck_keynum = string_copy(key_num);
4510 /* Now expand the second argument */
4511 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4513 case 1: goto EXPAND_FAILED_CURLY;
4515 case 3: goto EXPAND_FAILED;
4518 /* Now we have the key and can check the address. */
4520 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4525 expand_string_message = US"hmac-sha1 conversion failed";
4529 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4530 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4532 if (Ustrcmp(p,hash) == 0)
4534 /* Success, valid BATV address. Now check the expiry date. */
4535 uschar *now = prvs_daystamp(0);
4536 unsigned int inow = 0,iexpire = 1;
4538 (void)sscanf(CS now,"%u",&inow);
4539 (void)sscanf(CS daystamp,"%u",&iexpire);
4541 /* When "iexpire" is < 7, a "flip" has occured.
4542 Adjust "inow" accordingly. */
4543 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4545 if (iexpire >= inow)
4547 prvscheck_result = US"1";
4548 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4552 prvscheck_result = NULL;
4553 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4558 prvscheck_result = NULL;
4559 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4562 /* Now expand the final argument. We leave this till now so that
4563 it can include $prvscheck_result. */
4565 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4567 case 1: goto EXPAND_FAILED_CURLY;
4569 case 3: goto EXPAND_FAILED;
4572 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4573 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4575 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4577 /* Reset the "internal" variables afterwards, because they are in
4578 dynamic store that will be reclaimed if the expansion succeeded. */
4580 prvscheck_address = NULL;
4581 prvscheck_keynum = NULL;
4585 /* Does not look like a prvs encoded address, return the empty string.
4586 We need to make sure all subs are expanded first, so as to skip over
4589 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4591 case 1: goto EXPAND_FAILED_CURLY;
4593 case 3: goto EXPAND_FAILED;
4600 /* Handle "readfile" to insert an entire file */
4602 case EITEM_READFILE:
4607 if ((expand_forbid & RDO_READFILE) != 0)
4609 expand_string_message = US"file insertions are not permitted";
4613 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4615 case 1: goto EXPAND_FAILED_CURLY;
4617 case 3: goto EXPAND_FAILED;
4620 /* If skipping, we don't actually do anything */
4622 if (skipping) continue;
4624 /* Open the file and read it */
4626 f = Ufopen(sub_arg[0], "rb");
4629 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4633 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4638 /* Handle "readsocket" to insert data from a Unix domain socket */
4640 case EITEM_READSOCK:
4646 struct sockaddr_un sockun; /* don't call this "sun" ! */
4650 if ((expand_forbid & RDO_READSOCK) != 0)
4652 expand_string_message = US"socket insertions are not permitted";
4656 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4657 because there may be a string for expansion on failure. */
4659 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4661 case 1: goto EXPAND_FAILED_CURLY;
4662 case 2: /* Won't occur: no end check */
4663 case 3: goto EXPAND_FAILED;
4666 /* Sort out timeout, if given */
4668 if (sub_arg[2] != NULL)
4670 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4673 expand_string_message = string_sprintf("bad time value %s",
4678 else sub_arg[3] = NULL; /* No eol if no timeout */
4680 /* If skipping, we don't actually do anything. Otherwise, arrange to
4681 connect to either an IP or a Unix socket. */
4685 /* Handle an IP (internet) domain */
4687 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4690 uschar *server_name = sub_arg[0] + 5;
4691 uschar *port_name = Ustrrchr(server_name, ':');
4693 /* Sort out the port */
4695 if (port_name == NULL)
4697 expand_string_message =
4698 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4701 *port_name++ = 0; /* Terminate server name */
4703 if (isdigit(*port_name))
4706 port = Ustrtol(port_name, &end, 0);
4707 if (end != port_name + Ustrlen(port_name))
4709 expand_string_message =
4710 string_sprintf("invalid port number %s", port_name);
4716 struct servent *service_info = getservbyname(CS port_name, "tcp");
4717 if (service_info == NULL)
4719 expand_string_message = string_sprintf("unknown port \"%s\"",
4723 port = ntohs(service_info->s_port);
4726 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4727 timeout, NULL, &expand_string_message)) < 0)
4731 /* Handle a Unix domain socket */
4736 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4738 expand_string_message = string_sprintf("failed to create socket: %s",
4743 sockun.sun_family = AF_UNIX;
4744 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4747 sigalrm_seen = FALSE;
4749 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4753 expand_string_message = US "socket connect timed out";
4758 expand_string_message = string_sprintf("failed to connect to socket "
4759 "%s: %s", sub_arg[0], strerror(errno));
4764 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4766 /* Allow sequencing of test actions */
4767 if (running_in_test_harness) millisleep(100);
4769 /* Write the request string, if not empty */
4771 if (sub_arg[1][0] != 0)
4773 int len = Ustrlen(sub_arg[1]);
4774 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4776 if (write(fd, sub_arg[1], len) != len)
4778 expand_string_message = string_sprintf("request write to socket "
4779 "failed: %s", strerror(errno));
4784 /* Shut down the sending side of the socket. This helps some servers to
4785 recognise that it is their turn to do some work. Just in case some
4786 system doesn't have this function, make it conditional. */
4789 shutdown(fd, SHUT_WR);
4792 if (running_in_test_harness) millisleep(100);
4794 /* Now we need to read from the socket, under a timeout. The function
4795 that reads a file can be used. */
4797 f = fdopen(fd, "rb");
4798 sigalrm_seen = FALSE;
4800 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4804 /* After a timeout, we restore the pointer in the result, that is,
4805 make sure we add nothing from the socket. */
4810 expand_string_message = US "socket read timed out";
4815 /* The whole thing has worked (or we were skipping). If there is a
4816 failure string following, we need to skip it. */
4820 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4822 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4823 while (isspace(*s)) s++;
4825 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4828 /* Come here on failure to create socket, connect socket, write to the
4829 socket, or timeout on reading. If another substring follows, expand and
4830 use it. Otherwise, those conditions give expand errors. */
4833 if (*s != '{') goto EXPAND_FAILED;
4834 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4835 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4836 if (arg == NULL) goto EXPAND_FAILED;
4837 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4838 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4839 while (isspace(*s)) s++;
4840 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4844 /* Handle "run" to execute a program. */
4850 const uschar **argv;
4856 if ((expand_forbid & RDO_RUN) != 0)
4858 expand_string_message = US"running a command is not permitted";
4862 while (isspace(*s)) s++;
4863 if (*s != '{') goto EXPAND_FAILED_CURLY;
4864 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4865 if (arg == NULL) goto EXPAND_FAILED;
4866 while (isspace(*s)) s++;
4867 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4869 if (skipping) /* Just pretend it worked when we're skipping */
4875 if (!transport_set_up_command(&argv, /* anchor for arg list */
4876 arg, /* raw command */
4877 FALSE, /* don't expand the arguments */
4878 0, /* not relevant when... */
4879 NULL, /* no transporting address */
4880 US"${run} expansion", /* for error messages */
4881 &expand_string_message)) /* where to put error message */
4886 /* Create the child process, making it a group leader. */
4888 pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4892 expand_string_message =
4893 string_sprintf("couldn't create child process: %s", strerror(errno));
4897 /* Nothing is written to the standard input. */
4901 /* Read the pipe to get the command's output into $value (which is kept
4902 in lookup_value). Read during execution, so that if the output exceeds
4903 the OS pipe buffer limit, we don't block forever. */
4905 f = fdopen(fd_out, "rb");
4906 sigalrm_seen = FALSE;
4908 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4912 /* Wait for the process to finish, applying the timeout, and inspect its
4913 return code for serious disasters. Simple non-zero returns are passed on.
4916 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4918 if (sigalrm_seen == TRUE || runrc == -256)
4920 expand_string_message = string_sprintf("command timed out");
4921 killpg(pid, SIGKILL); /* Kill the whole process group */
4924 else if (runrc == -257)
4925 expand_string_message = string_sprintf("wait() failed: %s",
4929 expand_string_message = string_sprintf("command killed by signal %d",
4936 /* Process the yes/no strings; $value may be useful in both cases */
4938 switch(process_yesno(
4939 skipping, /* were previously skipping */
4940 runrc == 0, /* success/failure indicator */
4941 lookup_value, /* value to reset for string2 */
4942 &s, /* input pointer */
4943 &yield, /* output pointer */
4944 &size, /* output size */
4945 &ptr, /* output current point */
4946 US"run", /* condition type */
4949 case 1: goto EXPAND_FAILED; /* when all is well, the */
4950 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4956 /* Handle character translation for "tr" */
4964 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4966 case 1: goto EXPAND_FAILED_CURLY;
4968 case 3: goto EXPAND_FAILED;
4971 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4972 o2m = Ustrlen(sub[2]) - 1;
4974 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4976 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4980 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4987 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4988 expanded arguments. */
4998 int val[2] = { 0, -1 };
5001 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5002 Ensure that sub[2] is set in the ${length } case. */
5005 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
5006 TRUE, name, &resetok))
5008 case 1: goto EXPAND_FAILED_CURLY;
5010 case 3: goto EXPAND_FAILED;
5013 /* Juggle the arguments if there are only two of them: always move the
5014 string to the last position and make ${length{n}{str}} equivalent to
5015 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5021 if (item_type == EITEM_LENGTH)
5028 for (i = 0; i < 2; i++)
5030 if (sub[i] == NULL) continue;
5031 val[i] = (int)Ustrtol(sub[i], &ret, 10);
5032 if (*ret != 0 || (i != 0 && val[i] < 0))
5034 expand_string_message = string_sprintf("\"%s\" is not a%s number "
5035 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5041 (item_type == EITEM_HASH)?
5042 compute_hash(sub[2], val[0], val[1], &len) :
5043 (item_type == EITEM_NHASH)?
5044 compute_nhash(sub[2], val[0], val[1], &len) :
5045 extract_substr(sub[2], val[0], val[1], &len);
5047 if (ret == NULL) goto EXPAND_FAILED;
5048 yield = string_cat(yield, &size, &ptr, ret, len);
5052 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5053 This code originally contributed by Steve Haslam. It currently supports
5054 the use of MD5 and SHA-1 hashes.
5056 We need some workspace that is large enough to handle all the supported
5057 hash types. Use macros to set the sizes rather than be too elaborate. */
5059 #define MAX_HASHLEN 20
5060 #define MAX_HASHBLOCKLEN 64
5069 int hashlen; /* Number of octets for the hash algorithm's output */
5070 int hashblocklen; /* Number of octets the hash algorithm processes */
5072 unsigned int keylen;
5074 uschar keyhash[MAX_HASHLEN];
5075 uschar innerhash[MAX_HASHLEN];
5076 uschar finalhash[MAX_HASHLEN];
5077 uschar finalhash_hex[2*MAX_HASHLEN];
5078 uschar innerkey[MAX_HASHBLOCKLEN];
5079 uschar outerkey[MAX_HASHBLOCKLEN];
5081 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5083 case 1: goto EXPAND_FAILED_CURLY;
5085 case 3: goto EXPAND_FAILED;
5088 if (Ustrcmp(sub[0], "md5") == 0)
5091 use_base = &md5_base;
5095 else if (Ustrcmp(sub[0], "sha1") == 0)
5098 use_base = &sha1_base;
5104 expand_string_message =
5105 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5110 keylen = Ustrlen(keyptr);
5112 /* If the key is longer than the hash block length, then hash the key
5115 if (keylen > hashblocklen)
5117 chash_start(type, use_base);
5118 chash_end(type, use_base, keyptr, keylen, keyhash);
5123 /* Now make the inner and outer key values */
5125 memset(innerkey, 0x36, hashblocklen);
5126 memset(outerkey, 0x5c, hashblocklen);
5128 for (i = 0; i < keylen; i++)
5130 innerkey[i] ^= keyptr[i];
5131 outerkey[i] ^= keyptr[i];
5134 /* Now do the hashes */
5136 chash_start(type, use_base);
5137 chash_mid(type, use_base, innerkey);
5138 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5140 chash_start(type, use_base);
5141 chash_mid(type, use_base, outerkey);
5142 chash_end(type, use_base, innerhash, hashlen, finalhash);
5144 /* Encode the final hash as a hex string */
5147 for (i = 0; i < hashlen; i++)
5149 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5150 *p++ = hex_digits[finalhash[i] & 0x0f];
5153 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5154 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5156 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5161 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5162 We have to save the numerical variables and restore them afterwards. */
5167 int moffset, moffsetextra, slen;
5170 const uschar *rerror;
5173 int save_expand_nmax =
5174 save_expand_strings(save_expand_nstring, save_expand_nlength);
5176 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5178 case 1: goto EXPAND_FAILED_CURLY;
5180 case 3: goto EXPAND_FAILED;
5183 /* Compile the regular expression */
5185 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5190 expand_string_message = string_sprintf("regular expression error in "
5191 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5195 /* Now run a loop to do the substitutions as often as necessary. It ends
5196 when there are no more matches. Take care over matches of the null string;
5197 do the same thing as Perl does. */
5200 slen = Ustrlen(sub[0]);
5201 moffset = moffsetextra = 0;
5206 int ovector[3*(EXPAND_MAXN+1)];
5207 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5208 PCRE_EOPT | emptyopt, ovector, nelem(ovector));
5212 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5213 is not necessarily the end. We want to repeat the match from one
5214 character further along, but leaving the basic offset the same (for
5215 copying below). We can't be at the end of the string - that was checked
5216 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5217 finished; copy the remaining string and end the loop. */
5227 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5231 /* Match - set up for expanding the replacement. */
5233 if (n == 0) n = EXPAND_MAXN + 1;
5235 for (nn = 0; nn < n*2; nn += 2)
5237 expand_nstring[expand_nmax] = subject + ovector[nn];
5238 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5242 /* Copy the characters before the match, plus the expanded insertion. */
5244 yield = string_cat(yield, &size, &ptr, subject + moffset,
5245 ovector[0] - moffset);
5246 insert = expand_string(sub[2]);
5247 if (insert == NULL) goto EXPAND_FAILED;
5248 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5250 moffset = ovector[1];
5254 /* If we have matched an empty string, first check to see if we are at
5255 the end of the subject. If so, the loop is over. Otherwise, mimic
5256 what Perl's /g options does. This turns out to be rather cunning. First
5257 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5258 string at the same point. If this fails (picked up above) we advance to
5259 the next character. */
5261 if (ovector[0] == ovector[1])
5263 if (ovector[0] == slen) break;
5264 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5268 /* All done - restore numerical variables. */
5270 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5271 save_expand_nlength);
5275 /* Handle keyed and numbered substring extraction. If the first argument
5276 consists entirely of digits, then a numerical extraction is assumed. */
5282 int field_number = 1;
5283 BOOL field_number_set = FALSE;
5284 uschar *save_lookup_value = lookup_value;
5286 int save_expand_nmax =
5287 save_expand_strings(save_expand_nstring, save_expand_nlength);
5289 /* Read the arguments */
5291 for (i = 0; i < j; i++)
5293 while (isspace(*s)) s++;
5294 if (*s == '{') /*}*/
5296 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5297 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5298 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5300 /* After removal of leading and trailing white space, the first
5301 argument must not be empty; if it consists entirely of digits
5302 (optionally preceded by a minus sign), this is a numerical
5303 extraction, and we expect 3 arguments. */
5311 while (isspace(*p)) p++;
5315 while (len > 0 && isspace(p[len-1])) len--;
5322 expand_string_message = US"first argument of \"extract\" must "
5332 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5336 j = 3; /* Need 3 args */
5337 field_number_set = TRUE;
5342 else goto EXPAND_FAILED_CURLY;
5345 /* Extract either the numbered or the keyed substring into $value. If
5346 skipping, just pretend the extraction failed. */
5348 lookup_value = skipping? NULL : field_number_set?
5349 expand_gettokened(field_number, sub[1], sub[2]) :
5350 expand_getkeyed(sub[0], sub[1]);
5352 /* If no string follows, $value gets substituted; otherwise there can
5353 be yes/no strings, as for lookup or if. */
5355 switch(process_yesno(
5356 skipping, /* were previously skipping */
5357 lookup_value != NULL, /* success/failure indicator */
5358 save_lookup_value, /* value to reset for string2 */
5359 &s, /* input pointer */
5360 &yield, /* output pointer */
5361 &size, /* output size */
5362 &ptr, /* output current point */
5363 US"extract", /* condition type */
5366 case 1: goto EXPAND_FAILED; /* when all is well, the */
5367 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5370 /* All done - restore numerical variables. */
5372 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5373 save_expand_nlength);
5378 /* return the Nth item from a list */
5380 case EITEM_LISTEXTRACT:
5383 int field_number = 1;
5384 uschar *save_lookup_value = lookup_value;
5386 int save_expand_nmax =
5387 save_expand_strings(save_expand_nstring, save_expand_nlength);
5389 /* Read the field & list arguments */
5391 for (i = 0; i < 2; i++)
5393 while (isspace(*s)) s++;
5394 if (*s != '{') /*}*/
5395 goto EXPAND_FAILED_CURLY;
5397 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5398 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5399 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5401 /* After removal of leading and trailing white space, the first
5402 argument must be numeric and nonempty. */
5410 while (isspace(*p)) p++;
5414 while (len > 0 && isspace(p[len-1])) len--;
5417 if (!*p && !skipping)
5419 expand_string_message = US"first argument of \"listextract\" must "
5429 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5432 expand_string_message = US"first argument of \"listextract\" must "
5440 /* Extract the numbered element into $value. If
5441 skipping, just pretend the extraction failed. */
5443 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5445 /* If no string follows, $value gets substituted; otherwise there can
5446 be yes/no strings, as for lookup or if. */
5448 switch(process_yesno(
5449 skipping, /* were previously skipping */
5450 lookup_value != NULL, /* success/failure indicator */
5451 save_lookup_value, /* value to reset for string2 */
5452 &s, /* input pointer */
5453 &yield, /* output pointer */
5454 &size, /* output size */
5455 &ptr, /* output current point */
5456 US"extract", /* condition type */
5459 case 1: goto EXPAND_FAILED; /* when all is well, the */
5460 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5463 /* All done - restore numerical variables. */
5465 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5466 save_expand_nlength);
5472 case EITEM_CERTEXTRACT:
5474 uschar *save_lookup_value = lookup_value;
5476 int save_expand_nmax =
5477 save_expand_strings(save_expand_nstring, save_expand_nlength);
5479 /* Read the field argument */
5480 while (isspace(*s)) s++;
5481 if (*s != '{') /*}*/
5482 goto EXPAND_FAILED_CURLY;
5483 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5484 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5485 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5486 /* strip spaces fore & aft */
5491 while (isspace(*p)) p++;
5495 while (len > 0 && isspace(p[len-1])) len--;
5499 /* inspect the cert argument */
5500 while (isspace(*s)) s++;
5501 if (*s != '{') /*}*/
5502 goto EXPAND_FAILED_CURLY;
5505 expand_string_message = US"second argument of \"certextract\" must "
5506 "be a certificate variable";
5509 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5510 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5511 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5514 lookup_value = NULL;
5517 lookup_value = expand_getcertele(sub[0], sub[1]);
5518 if (*expand_string_message) goto EXPAND_FAILED;
5520 switch(process_yesno(
5521 skipping, /* were previously skipping */
5522 lookup_value != NULL, /* success/failure indicator */
5523 save_lookup_value, /* value to reset for string2 */
5524 &s, /* input pointer */
5525 &yield, /* output pointer */
5526 &size, /* output size */
5527 &ptr, /* output current point */
5528 US"extract", /* condition type */
5531 case 1: goto EXPAND_FAILED; /* when all is well, the */
5532 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5535 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5536 save_expand_nlength);
5539 #endif /*SUPPORT_TLS*/
5541 /* Handle list operations */
5549 uschar outsep[2] = { '\0', '\0' };
5550 const uschar *list, *expr, *temp;
5551 uschar *save_iterate_item = iterate_item;
5552 uschar *save_lookup_value = lookup_value;
5554 while (isspace(*s)) s++;
5555 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5557 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5558 if (list == NULL) goto EXPAND_FAILED;
5559 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5561 if (item_type == EITEM_REDUCE)
5564 while (isspace(*s)) s++;
5565 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5566 t = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5567 if (!t) goto EXPAND_FAILED;
5569 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5572 while (isspace(*s)) s++;
5573 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5577 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5578 if scanning a "false" part). This allows us to find the end of the
5579 condition, because if the list is empty, we won't actually evaluate the
5580 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5581 the normal internal expansion function. */
5583 if (item_type == EITEM_FILTER)
5585 temp = eval_condition(expr, &resetok, NULL);
5586 if (temp != NULL) s = temp;
5589 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5593 expand_string_message = string_sprintf("%s inside \"%s\" item",
5594 expand_string_message, name);
5598 while (isspace(*s)) s++;
5601 expand_string_message = string_sprintf("missing } at end of condition "
5602 "or expression inside \"%s\"", name);
5606 while (isspace(*s)) s++; /*{*/
5609 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5614 /* If we are skipping, we can now just move on to the next item. When
5615 processing for real, we perform the iteration. */
5617 if (skipping) continue;
5618 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5620 *outsep = (uschar)sep; /* Separator as a string */
5622 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5624 if (item_type == EITEM_FILTER)
5627 if (eval_condition(expr, &resetok, &condresult) == NULL)
5629 iterate_item = save_iterate_item;
5630 lookup_value = save_lookup_value;
5631 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5632 expand_string_message, name);
5635 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5636 condresult? "true":"false");
5638 temp = iterate_item; /* TRUE => include this item */
5640 continue; /* FALSE => skip this item */
5643 /* EITEM_MAP and EITEM_REDUCE */
5647 uschar * t = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5651 iterate_item = save_iterate_item;
5652 expand_string_message = string_sprintf("%s inside \"%s\" item",
5653 expand_string_message, name);
5656 if (item_type == EITEM_REDUCE)
5658 lookup_value = t; /* Update the value of $value */
5659 continue; /* and continue the iteration */
5663 /* We reach here for FILTER if the condition is true, always for MAP,
5664 and never for REDUCE. The value in "temp" is to be added to the output
5665 list that is being created, ensuring that any occurrences of the
5666 separator character are doubled. Unless we are dealing with the first
5667 item of the output list, add in a space if the new item begins with the
5668 separator character, or is an empty string. */
5670 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5671 yield = string_cat(yield, &size, &ptr, US" ", 1);
5673 /* Add the string in "temp" to the output list that we are building,
5674 This is done in chunks by searching for the separator character. */
5678 size_t seglen = Ustrcspn(temp, outsep);
5679 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5681 /* If we got to the end of the string we output one character
5682 too many; backup and end the loop. Otherwise arrange to double the
5685 if (temp[seglen] == '\0') { ptr--; break; }
5686 yield = string_cat(yield, &size, &ptr, outsep, 1);
5690 /* Output a separator after the string: we will remove the redundant
5691 final one at the end. */
5693 yield = string_cat(yield, &size, &ptr, outsep, 1);
5694 } /* End of iteration over the list loop */
5696 /* REDUCE has generated no output above: output the final value of
5699 if (item_type == EITEM_REDUCE)
5701 yield = string_cat(yield, &size, &ptr, lookup_value,
5702 Ustrlen(lookup_value));
5703 lookup_value = save_lookup_value; /* Restore $value */
5706 /* FILTER and MAP generate lists: if they have generated anything, remove
5707 the redundant final separator. Even though an empty item at the end of a
5708 list does not count, this is tidier. */
5710 else if (ptr != save_ptr) ptr--;
5712 /* Restore preserved $item */
5714 iterate_item = save_iterate_item;
5721 const uschar *srclist, *cmp, *xtract;
5723 const uschar *dstlist = NULL, *dstkeylist = NULL;
5725 uschar *save_iterate_item = iterate_item;
5727 while (isspace(*s)) s++;
5728 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5730 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5731 if (!srclist) goto EXPAND_FAILED;
5732 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5734 while (isspace(*s)) s++;
5735 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5737 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5738 if (!cmp) goto EXPAND_FAILED;
5739 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5741 while (isspace(*s)) s++;
5742 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5745 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5746 if (!tmp) goto EXPAND_FAILED;
5747 xtract = string_copyn(xtract, s - xtract);
5749 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5753 expand_string_message = US"missing } at end of \"sort\"";
5757 if (skipping) continue;
5759 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5762 uschar * newlist = NULL;
5763 uschar * newkeylist = NULL;
5766 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, srcitem);
5768 /* extract field for comparisons */
5769 iterate_item = srcitem;
5770 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5774 expand_string_message = string_sprintf(
5775 "field-extract in sort: \"%s\"", xtract);
5779 /* Insertion sort */
5781 /* copy output list until new-item < list-item */
5782 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5788 /* field for comparison */
5789 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5792 /* build and run condition string */
5793 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
5795 DEBUG(D_expand) debug_printf("%s: cond = \"%s\"\n", name, expr);
5796 if (!eval_condition(expr, &resetok, &before))
5798 expand_string_message = string_sprintf("comparison in sort: %s",
5805 /* New-item sorts before this dst-item. Append new-item,
5806 then dst-item, then remainder of dst list. */
5808 newlist = string_append_listele(newlist, sep, srcitem);
5809 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5812 newlist = string_append_listele(newlist, sep, dstitem);
5813 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5815 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5817 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5819 newlist = string_append_listele(newlist, sep, dstitem);
5820 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5826 newlist = string_append_listele(newlist, sep, dstitem);
5827 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5830 /* If we ran out of dstlist without consuming srcitem, append it */
5833 newlist = string_append_listele(newlist, sep, srcitem);
5834 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5838 dstkeylist = newkeylist;
5840 DEBUG(D_expand) debug_printf("%s: dstlist = \"%s\"\n", name, dstlist);
5841 DEBUG(D_expand) debug_printf("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
5845 yield = string_cat(yield, &size, &ptr, dstlist, Ustrlen(dstlist));
5847 /* Restore preserved $item */
5848 iterate_item = save_iterate_item;
5852 expand_string_message = US"Internal error in sort (list mismatch)";
5857 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5858 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5859 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5860 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5862 #define EXPAND_DLFUNC_MAX_ARGS 8
5865 #ifndef EXPAND_DLFUNC
5866 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5867 "is not included in this binary";
5870 #else /* EXPAND_DLFUNC */
5873 exim_dlfunc_t *func;
5876 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5878 if ((expand_forbid & RDO_DLFUNC) != 0)
5880 expand_string_message =
5881 US"dynamically-loaded functions are not permitted";
5885 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5886 TRUE, US"dlfunc", &resetok))
5888 case 1: goto EXPAND_FAILED_CURLY;
5890 case 3: goto EXPAND_FAILED;
5893 /* If skipping, we don't actually do anything */
5895 if (skipping) continue;
5897 /* Look up the dynamically loaded object handle in the tree. If it isn't
5898 found, dlopen() the file and put the handle in the tree for next time. */
5900 t = tree_search(dlobj_anchor, argv[0]);
5903 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5906 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5907 argv[0], dlerror());
5908 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5911 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5912 Ustrcpy(t->name, argv[0]);
5913 t->data.ptr = handle;
5914 (void)tree_insertnode(&dlobj_anchor, t);
5917 /* Having obtained the dynamically loaded object handle, look up the
5918 function pointer. */
5920 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5923 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5924 "%s", argv[1], argv[0], dlerror());
5925 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5929 /* Call the function and work out what to do with the result. If it
5930 returns OK, we have a replacement string; if it returns DEFER then
5931 expansion has failed in a non-forced manner; if it returns FAIL then
5932 failure was forced; if it returns ERROR or any other value there's a
5933 problem, so panic slightly. In any case, assume that the function has
5934 side-effects on the store that must be preserved. */
5938 for (argc = 0; argv[argc] != NULL; argc++);
5939 status = func(&result, argc - 2, &argv[2]);
5942 if (result == NULL) result = US"";
5943 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5948 expand_string_message = result == NULL ? US"(no message)" : result;
5949 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5950 else if(status != FAIL)
5951 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5952 argv[0], argv[1], status, expand_string_message);
5956 #endif /* EXPAND_DLFUNC */
5958 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */
5961 uschar *save_lookup_value = lookup_value;
5963 while (isspace(*s)) s++;
5964 if (*s != '{') /*}*/
5967 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5968 if (!key) goto EXPAND_FAILED; /*{*/
5969 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5971 lookup_value = US getenv(CS key);
5973 switch(process_yesno(
5974 skipping, /* were previously skipping */
5975 lookup_value != NULL, /* success/failure indicator */
5976 save_lookup_value, /* value to reset for string2 */
5977 &s, /* input pointer */
5978 &yield, /* output pointer */
5979 &size, /* output size */
5980 &ptr, /* output current point */
5981 US"env", /* condition type */
5984 case 1: goto EXPAND_FAILED; /* when all is well, the */
5985 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5989 } /* EITEM_* switch */
5991 /* Control reaches here if the name is not recognized as one of the more
5992 complicated expansion items. Check for the "operator" syntax (name terminated
5993 by a colon). Some of the operators have arguments, separated by _ from the
6001 var_entry *vp = NULL;
6003 /* Owing to an historical mis-design, an underscore may be part of the
6004 operator name, or it may introduce arguments. We therefore first scan the
6005 table of names that contain underscores. If there is no match, we cut off
6006 the arguments and then scan the main table. */
6008 if ((c = chop_match(name, op_table_underscore,
6009 nelem(op_table_underscore))) < 0)
6011 arg = Ustrchr(name, '_');
6012 if (arg != NULL) *arg = 0;
6013 c = chop_match(name, op_table_main, nelem(op_table_main));
6014 if (c >= 0) c += nelem(op_table_underscore);
6015 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
6018 /* Deal specially with operators that might take a certificate variable
6019 as we do not want to do the usual expansion. For most, expand the string.*/
6028 const uschar * s1 = s;
6029 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
6031 if (!sub) goto EXPAND_FAILED; /*{*/
6032 if (*s1 != '}') goto EXPAND_FAILED_CURLY;
6033 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
6043 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
6044 if (!sub) goto EXPAND_FAILED;
6049 /* If we are skipping, we don't need to perform the operation at all.
6050 This matters for operations like "mask", because the data may not be
6051 in the correct format when skipping. For example, the expression may test
6052 for the existence of $sender_host_address before trying to mask it. For
6053 other operations, doing them may not fail, but it is a waste of time. */
6055 if (skipping && c >= 0) continue;
6057 /* Otherwise, switch on the operator type */
6064 unsigned long int n = Ustrtoul(sub, &t, 10);
6067 expand_string_message = string_sprintf("argument for base62 "
6068 "operator is \"%s\", which is not a decimal number", sub);
6071 t = string_base62(n);
6072 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6076 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6082 unsigned long int n = 0;
6085 uschar *t = Ustrchr(base62_chars, *tt++);
6088 expand_string_message = string_sprintf("argument for base62d "
6089 "operator is \"%s\", which is not a base %d number", sub,
6093 n = n * BASE_62 + (t - base62_chars);
6095 (void)sprintf(CS buf, "%ld", n);
6096 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
6102 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
6103 if (expanded == NULL)
6105 expand_string_message =
6106 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6107 expand_string_message);
6110 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
6117 uschar *t = sub - 1;
6118 while (*(++t) != 0) { *t = tolower(*t); count++; }
6119 yield = string_cat(yield, &size, &ptr, sub, count);
6126 uschar *t = sub - 1;
6127 while (*(++t) != 0) { *t = toupper(*t); count++; }
6128 yield = string_cat(yield, &size, &ptr, sub, count);
6134 if (vp && *(void **)vp->value)
6136 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6137 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6147 md5_end(&base, sub, Ustrlen(sub), digest);
6148 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6149 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6155 if (vp && *(void **)vp->value)
6157 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6158 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6168 sha1_end(&base, sub, Ustrlen(sub), digest);
6169 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6170 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6176 if (vp && *(void **)vp->value)
6178 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6179 yield = string_cat(yield, &size, &ptr, cp, (int)Ustrlen(cp));
6183 expand_string_message = US"sha256 only supported for certificates";
6186 /* Convert hex encoding to base64 encoding */
6196 for (enc = sub; *enc != 0; enc++)
6198 if (!isxdigit(*enc))
6200 expand_string_message = string_sprintf("\"%s\" is not a hex "
6209 expand_string_message = string_sprintf("\"%s\" contains an odd "
6210 "number of characters", sub);
6214 while ((c = *in++) != 0)
6216 if (isdigit(c)) c -= '0';
6217 else c = toupper(c) - 'A' + 10;
6229 enc = auth_b64encode(sub, out - sub);
6230 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
6234 /* Convert octets outside 0x21..0x7E to \xXX form */
6238 uschar *t = sub - 1;
6241 if (*t < 0x21 || 0x7E < *t)
6242 yield = string_cat(yield, &size, &ptr,
6243 string_sprintf("\\x%02x", *t), 4);
6245 yield = string_cat(yield, &size, &ptr, t, 1);
6250 /* count the number of list elements */
6259 while (string_nextinlist(CUSS &sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6260 cp = string_sprintf("%d", cnt);
6261 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6265 /* expand a named list given the name */
6266 /* handles nested named lists; requotes as colon-sep list */
6270 tree_node *t = NULL;
6271 const uschar * list;
6274 uschar * suffix = US"";
6275 BOOL needsep = FALSE;
6278 if (*sub == '+') sub++;
6279 if (arg == NULL) /* no-argument version */
6281 if (!(t = tree_search(addresslist_anchor, sub)) &&
6282 !(t = tree_search(domainlist_anchor, sub)) &&
6283 !(t = tree_search(hostlist_anchor, sub)))
6284 t = tree_search(localpartlist_anchor, sub);
6286 else switch(*arg) /* specific list-type version */
6288 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6289 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6290 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6291 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6293 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6299 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6301 : *arg=='a'?"address "
6302 : *arg=='d'?"domain "
6304 : *arg=='l'?"localpart "
6309 list = ((namedlist_block *)(t->data.ptr))->string;
6311 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6313 uschar * buf = US" : ";
6315 yield = string_cat(yield, &size, &ptr, buf, 3);
6319 if (*item == '+') /* list item is itself a named list */
6321 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6322 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6324 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6328 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6329 while ((cp= strpbrk((const char *)item, tok)))
6331 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
6332 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6334 yield = string_cat(yield, &size, &ptr, US"::", 2);
6335 item = (uschar *)cp;
6337 else /* sep in item; should already be doubled; emit once */
6339 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
6340 if (*cp == sep) cp++;
6341 item = (uschar *)cp;
6345 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
6350 /* mask applies a mask to an IP address; for example the result of
6351 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6358 int mask, maskoffset;
6359 int type = string_is_ip_address(sub, &maskoffset);
6364 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6369 if (maskoffset == 0)
6371 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6376 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6378 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6380 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6385 /* Convert the address to binary integer(s) and apply the mask */
6387 sub[maskoffset] = 0;
6388 count = host_aton(sub, binary);
6389 host_mask(count, binary, mask);
6391 /* Convert to masked textual format and add to output. */
6393 yield = string_cat(yield, &size, &ptr, buffer,
6394 host_nmtoa(count, binary, mask, buffer, '.'));
6399 case EOP_LOCAL_PART:
6403 int start, end, domain;
6404 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6408 if (c != EOP_DOMAIN)
6410 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6411 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
6413 else if (domain != 0)
6416 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
6424 uschar outsep[2] = { ':', '\0' };
6425 uschar *address, *error;
6427 int start, end, domain; /* Not really used */
6429 while (isspace(*sub)) sub++;
6430 if (*sub == '>') { *outsep = *++sub; ++sub; }
6431 parse_allow_group = TRUE;
6435 uschar *p = parse_find_address_end(sub, FALSE);
6436 uschar saveend = *p;
6438 address = parse_extract_address(sub, &error, &start, &end, &domain,
6442 /* Add the address to the output list that we are building. This is
6443 done in chunks by searching for the separator character. At the
6444 start, unless we are dealing with the first address of the output
6445 list, add in a space if the new address begins with the separator
6446 character, or is an empty string. */
6448 if (address != NULL)
6450 if (ptr != save_ptr && address[0] == *outsep)
6451 yield = string_cat(yield, &size, &ptr, US" ", 1);
6455 size_t seglen = Ustrcspn(address, outsep);
6456 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
6458 /* If we got to the end of the string we output one character
6461 if (address[seglen] == '\0') { ptr--; break; }
6462 yield = string_cat(yield, &size, &ptr, outsep, 1);
6463 address += seglen + 1;
6466 /* Output a separator after the string: we will remove the
6467 redundant final one at the end. */
6469 yield = string_cat(yield, &size, &ptr, outsep, 1);
6472 if (saveend == '\0') break;
6476 /* If we have generated anything, remove the redundant final
6479 if (ptr != save_ptr) ptr--;
6480 parse_allow_group = FALSE;
6485 /* quote puts a string in quotes if it is empty or contains anything
6486 other than alphamerics, underscore, dot, or hyphen.
6488 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6489 be quoted in order to be a valid local part.
6491 In both cases, newlines and carriage returns are converted into \n and \r
6495 case EOP_QUOTE_LOCAL_PART:
6498 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6499 uschar *t = sub - 1;
6503 while (!needs_quote && *(++t) != 0)
6504 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6506 else /* EOP_QUOTE_LOCAL_PART */
6508 while (!needs_quote && *(++t) != 0)
6509 needs_quote = !isalnum(*t) &&
6510 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6511 (*t != '.' || t == sub || t[1] == 0);
6516 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6521 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6522 else if (*t == '\r')
6523 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6526 if (*t == '\\' || *t == '"')
6527 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6528 yield = string_cat(yield, &size, &ptr, t, 1);
6531 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6533 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6537 /* quote_lookuptype does lookup-specific quoting */
6542 uschar *opt = Ustrchr(arg, '_');
6544 if (opt != NULL) *opt++ = 0;
6546 n = search_findtype(arg, Ustrlen(arg));
6549 expand_string_message = search_error_message;
6553 if (lookup_list[n]->quote != NULL)
6554 sub = (lookup_list[n]->quote)(sub, opt);
6555 else if (opt != NULL) sub = NULL;
6559 expand_string_message = string_sprintf(
6560 "\"%s\" unrecognized after \"${quote_%s\"",
6565 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6569 /* rx quote sticks in \ before any non-alphameric character so that
6570 the insertion works in a regular expression. */
6574 uschar *t = sub - 1;
6578 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6579 yield = string_cat(yield, &size, &ptr, t, 1);
6584 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6585 prescribed by the RFC, if there are characters that need to be encoded */
6589 uschar buffer[2048];
6590 const uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6591 buffer, sizeof(buffer), FALSE);
6592 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6596 /* RFC 2047 decode */
6602 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6603 headers_charset, '?', &len, &error);
6606 expand_string_message = error;
6609 yield = string_cat(yield, &size, &ptr, decoded, len);
6613 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6623 if (c > 255) c = '_';
6625 yield = string_cat(yield, &size, &ptr, buff, 1);
6630 /* replace illegal UTF-8 sequences by replacement character */
6632 #define UTF8_REPLACEMENT_CHAR US"?"
6636 int seq_len = 0, index = 0;
6638 long codepoint = -1;
6639 uschar seq_buff[4]; /* accumulate utf-8 here */
6648 if ((c & 0xc0) != 0x80)
6649 /* wrong continuation byte; invalidate all bytes */
6650 complete = 1; /* error */
6653 codepoint = (codepoint << 6) | (c & 0x3f);
6654 seq_buff[index++] = c;
6655 if (--bytes_left == 0) /* codepoint complete */
6656 if(codepoint > 0x10FFFF) /* is it too large? */
6657 complete = -1; /* error (RFC3629 limit) */
6659 { /* finished; output utf-8 sequence */
6660 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6665 else /* no bytes left: new sequence */
6667 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6669 yield = string_cat(yield, &size, &ptr, &c, 1);
6672 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6674 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6679 codepoint = c & 0x1f;
6682 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6685 codepoint = c & 0x0f;
6687 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6690 codepoint = c & 0x07;
6692 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6695 seq_buff[index++] = c;
6696 seq_len = bytes_left + 1;
6697 } /* if(bytes_left) */
6701 bytes_left = index = 0;
6702 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6704 if ((complete == 1) && ((c & 0x80) == 0))
6705 /* ASCII character follows incomplete sequence */
6706 yield = string_cat(yield, &size, &ptr, &c, 1);
6711 #ifdef EXPERIMENTAL_INTERNATIONAL
6712 case EOP_UTF8_DOMAIN_TO_ALABEL:
6714 uschar * error = NULL;
6715 uschar * s = string_domain_utf8_to_alabel(sub, &error);
6718 expand_string_message = string_sprintf(
6719 "error converting utf8 (%s) to alabel: %s",
6720 string_printing(sub), error);
6723 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6727 case EOP_UTF8_DOMAIN_FROM_ALABEL:
6729 uschar * error = NULL;
6730 uschar * s = string_domain_alabel_to_utf8(sub, &error);
6733 expand_string_message = string_sprintf(
6734 "error converting alabel (%s) to utf8: %s",
6735 string_printing(sub), error);
6738 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6742 case EOP_UTF8_LOCALPART_TO_ALABEL:
6744 uschar * error = NULL;
6745 uschar * s = string_localpart_utf8_to_alabel(sub, &error);
6748 expand_string_message = string_sprintf(
6749 "error converting utf8 (%s) to alabel: %s",
6750 string_printing(sub), error);
6753 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6754 DEBUG(D_expand) debug_printf("yield: '%s'\n", yield);
6758 case EOP_UTF8_LOCALPART_FROM_ALABEL:
6760 uschar * error = NULL;
6761 uschar * s = string_localpart_alabel_to_utf8(sub, &error);
6764 expand_string_message = string_sprintf(
6765 "error converting alabel (%s) to utf8: %s",
6766 string_printing(sub), error);
6769 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6772 #endif /* EXPERIMENTAL_INTERNATIONAL */
6774 /* escape turns all non-printing characters into escape sequences. */
6778 const uschar *t = string_printing(sub);
6779 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6783 /* Handle numeric expression evaluation */
6788 uschar *save_sub = sub;
6789 uschar *error = NULL;
6790 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6793 expand_string_message = string_sprintf("error in expression "
6794 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6798 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6799 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6803 /* Handle time period formating */
6807 int n = readconf_readtime(sub, 0, FALSE);
6810 expand_string_message = string_sprintf("string \"%s\" is not an "
6811 "Exim time interval in \"%s\" operator", sub, name);
6814 sprintf(CS var_buffer, "%d", n);
6815 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6819 case EOP_TIME_INTERVAL:
6822 uschar *t = read_number(&n, sub);
6823 if (*t != 0) /* Not A Number*/
6825 expand_string_message = string_sprintf("string \"%s\" is not a "
6826 "positive number in \"%s\" operator", sub, name);
6829 t = readconf_printtime(n);
6830 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6834 /* Convert string to base64 encoding */
6838 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6839 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6843 /* strlen returns the length of the string */
6848 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6849 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6853 /* length_n or l_n takes just the first n characters or the whole string,
6854 whichever is the shorter;
6856 substr_m_n, and s_m_n take n characters from offset m; negative m take
6857 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6858 takes the rest, either to the right or to the left.
6860 hash_n or h_n makes a hash of length n from the string, yielding n
6861 characters from the set a-z; hash_n_m makes a hash of length n, but
6862 uses m characters from the set a-zA-Z0-9.
6864 nhash_n returns a single number between 0 and n-1 (in text form), while
6865 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6866 between 0 and n-1 and the second between 0 and m-1. */
6886 expand_string_message = string_sprintf("missing values after %s",
6891 /* "length" has only one argument, effectively being synonymous with
6894 if (c == EOP_LENGTH || c == EOP_L)
6900 /* The others have one or two arguments; for "substr" the first may be
6901 negative. The second being negative means "not supplied". */
6906 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6909 /* Read up to two numbers, separated by underscores */
6914 if (arg != ret && *arg == '_' && pn == &value1)
6918 if (arg[1] != 0) arg++;
6920 else if (!isdigit(*arg))
6922 expand_string_message =
6923 string_sprintf("non-digit after underscore in \"%s\"", name);
6926 else *pn = (*pn)*10 + *arg++ - '0';
6930 /* Perform the required operation */
6933 (c == EOP_HASH || c == EOP_H)?
6934 compute_hash(sub, value1, value2, &len) :
6935 (c == EOP_NHASH || c == EOP_NH)?
6936 compute_nhash(sub, value1, value2, &len) :
6937 extract_substr(sub, value1, value2, &len);
6939 if (ret == NULL) goto EXPAND_FAILED;
6940 yield = string_cat(yield, &size, &ptr, ret, len);
6950 uschar **modetable[3];
6955 if ((expand_forbid & RDO_EXISTS) != 0)
6957 expand_string_message = US"Use of the stat() expansion is not permitted";
6961 if (stat(CS sub, &st) < 0)
6963 expand_string_message = string_sprintf("stat(%s) failed: %s",
6964 sub, strerror(errno));
6968 switch (mode & S_IFMT)
6970 case S_IFIFO: smode[0] = 'p'; break;
6971 case S_IFCHR: smode[0] = 'c'; break;
6972 case S_IFDIR: smode[0] = 'd'; break;
6973 case S_IFBLK: smode[0] = 'b'; break;
6974 case S_IFREG: smode[0] = '-'; break;
6975 default: smode[0] = '?'; break;
6978 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6979 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6980 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6982 for (i = 0; i < 3; i++)
6984 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6989 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6990 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6991 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6992 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6993 (long)st.st_gid, st.st_size, (long)st.st_atime,
6994 (long)st.st_mtime, (long)st.st_ctime);
6995 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6999 /* vaguely random number less than N */
7003 int_eximarith_t max;
7006 max = expanded_string_integer(sub, TRUE);
7007 if (expand_string_message != NULL)
7009 s = string_sprintf("%d", vaguely_random_number((int)max));
7010 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
7014 /* Reverse IP, including IPv6 to dotted-nibble */
7016 case EOP_REVERSE_IP:
7018 int family, maskptr;
7019 uschar reversed[128];
7021 family = string_is_ip_address(sub, &maskptr);
7024 expand_string_message = string_sprintf(
7025 "reverse_ip() not given an IP address [%s]", sub);
7028 invert_address(reversed, sub);
7029 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
7033 /* Unknown operator */
7036 expand_string_message =
7037 string_sprintf("unknown expansion operator \"%s\"", name);
7042 /* Handle a plain name. If this is the first thing in the expansion, release
7043 the pre-allocated buffer. If the result data is known to be in a new buffer,
7044 newsize will be set to the size of that buffer, and we can just point at that
7045 store instead of copying. Many expansion strings contain just one reference,
7046 so this is a useful optimization, especially for humungous headers
7047 ($message_headers). */
7055 if (resetok) store_reset(yield);
7059 value = find_variable(name, FALSE, skipping, &newsize);
7062 expand_string_message =
7063 string_sprintf("unknown variable in \"${%s}\"", name);
7064 check_variable_error_message(name);
7067 len = Ustrlen(value);
7068 if (yield == NULL && newsize != 0)
7074 else yield = string_cat(yield, &size, &ptr, value, len);
7078 /* Else there's something wrong */
7080 expand_string_message =
7081 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7082 "in a variable reference)", name);
7086 /* If we hit the end of the string when ket_ends is set, there is a missing
7087 terminating brace. */
7089 if (ket_ends && *s == 0)
7091 expand_string_message = malformed_header?
7092 US"missing } at end of string - could be header name not terminated by colon"
7094 US"missing } at end of string";
7098 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7099 added to the string. If so, set up an empty string. Add a terminating zero. If
7100 left != NULL, return a pointer to the terminator. */
7102 if (yield == NULL) yield = store_get(1);
7104 if (left != NULL) *left = s;
7106 /* Any stacking store that was used above the final string is no longer needed.
7107 In many cases the final string will be the first one that was got and so there
7108 will be optimal store usage. */
7110 if (resetok) store_reset(yield + ptr + 1);
7111 else if (resetok_p) *resetok_p = FALSE;
7115 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
7117 if (skipping) debug_printf("skipping: result is not used\n");
7121 /* This is the failure exit: easiest to program with a goto. We still need
7122 to update the pointer to the terminator, for cases of nested calls with "fail".
7125 EXPAND_FAILED_CURLY:
7126 expand_string_message = malformed_header?
7127 US"missing or misplaced { or } - could be header name not terminated by colon"
7129 US"missing or misplaced { or }";
7131 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7132 that is a bad idea, because expand_string_message is in dynamic store. */
7135 if (left != NULL) *left = s;
7138 debug_printf("failed to expand: %s\n", string);
7139 debug_printf(" error message: %s\n", expand_string_message);
7140 if (expand_string_forcedfail) debug_printf("failure was forced\n");
7142 if (resetok_p) *resetok_p = resetok;
7147 /* This is the external function call. Do a quick check for any expansion
7148 metacharacters, and if there are none, just return the input string.
7150 Argument: the string to be expanded
7151 Returns: the expanded string, or NULL if expansion failed; if failure was
7152 due to a lookup deferring, search_find_defer will be TRUE
7156 expand_string(uschar *string)
7158 search_find_defer = FALSE;
7159 malformed_header = FALSE;
7160 return (Ustrpbrk(string, "$\\") == NULL)? string :
7161 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7167 expand_cstring(const uschar *string)
7169 search_find_defer = FALSE;
7170 malformed_header = FALSE;
7171 return (Ustrpbrk(string, "$\\") == NULL)? string :
7172 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7177 /*************************************************
7179 *************************************************/
7181 /* Now and again we want to expand a string and be sure that the result is in a
7182 new bit of store. This function does that.
7183 Since we know it has been copied, the de-const cast is safe.
7185 Argument: the string to be expanded
7186 Returns: the expanded string, always in a new bit of store, or NULL
7190 expand_string_copy(const uschar *string)
7192 const uschar *yield = expand_cstring(string);
7193 if (yield == string) yield = string_copy(string);
7199 /*************************************************
7200 * Expand and interpret as an integer *
7201 *************************************************/
7203 /* Expand a string, and convert the result into an integer.
7206 string the string to be expanded
7207 isplus TRUE if a non-negative number is expected
7209 Returns: the integer value, or
7210 -1 for an expansion error ) in both cases, message in
7211 -2 for an integer interpretation error ) expand_string_message
7212 expand_string_message is set NULL for an OK integer
7216 expand_string_integer(uschar *string, BOOL isplus)
7218 return expanded_string_integer(expand_string(string), isplus);
7222 /*************************************************
7223 * Interpret string as an integer *
7224 *************************************************/
7226 /* Convert a string (that has already been expanded) into an integer.
7228 This function is used inside the expansion code.
7231 s the string to be expanded
7232 isplus TRUE if a non-negative number is expected
7234 Returns: the integer value, or
7235 -1 if string is NULL (which implies an expansion error)
7236 -2 for an integer interpretation error
7237 expand_string_message is set NULL for an OK integer
7240 static int_eximarith_t
7241 expanded_string_integer(const uschar *s, BOOL isplus)
7243 int_eximarith_t value;
7244 uschar *msg = US"invalid integer \"%s\"";
7247 /* If expansion failed, expand_string_message will be set. */
7249 if (s == NULL) return -1;
7251 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7252 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7253 systems, so we set it zero ourselves. */
7256 expand_string_message = NULL; /* Indicates no error */
7258 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7259 equal to 0. Unfortunately, people actually relied upon that, so preserve
7260 the behaviour explicitly. Stripping leading whitespace is a harmless
7261 noop change since strtol skips it anyway (provided that there is a number
7265 while (isspace(*s)) ++s;
7269 debug_printf("treating blank string as number 0\n");
7274 value = strtoll(CS s, CSS &endptr, 10);
7278 msg = US"integer expected but \"%s\" found";
7280 else if (value < 0 && isplus)
7282 msg = US"non-negative integer expected but \"%s\" found";
7286 switch (tolower(*endptr))
7291 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7296 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7297 else value *= 1024*1024;
7301 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7302 else value *= 1024*1024*1024;
7306 if (errno == ERANGE)
7307 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7310 while (isspace(*endptr)) endptr++;
7311 if (*endptr == 0) return value;
7315 expand_string_message = string_sprintf(CS msg, s);
7320 /* These values are usually fixed boolean values, but they are permitted to be
7324 addr address being routed
7325 mtype the module type
7326 mname the module name
7327 dbg_opt debug selectors
7328 oname the option name
7329 bvalue the router's boolean value
7330 svalue the router's string value
7331 rvalue where to put the returned value
7333 Returns: OK value placed in rvalue
7334 DEFER expansion failed
7338 exp_bool(address_item *addr,
7339 uschar *mtype, uschar *mname, unsigned dbg_opt,
7340 uschar *oname, BOOL bvalue,
7341 uschar *svalue, BOOL *rvalue)
7344 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7346 expanded = expand_string(svalue);
7347 if (expanded == NULL)
7349 if (expand_string_forcedfail)
7351 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7355 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7356 oname, mname, mtype, expand_string_message);
7357 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7361 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7364 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7366 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7370 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7371 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7381 /*************************************************
7382 **************************************************
7383 * Stand-alone test program *
7384 **************************************************
7385 *************************************************/
7391 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7393 int ovector[3*(EXPAND_MAXN+1)];
7394 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7395 ovector, nelem(ovector));
7396 BOOL yield = n >= 0;
7397 if (n == 0) n = EXPAND_MAXN + 1;
7401 expand_nmax = (setup < 0)? 0 : setup + 1;
7402 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7404 expand_nstring[expand_nmax] = subject + ovector[nn];
7405 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7413 int main(int argc, uschar **argv)
7416 uschar buffer[1024];
7418 debug_selector = D_v;
7419 debug_file = stderr;
7420 debug_fd = fileno(debug_file);
7421 big_buffer = malloc(big_buffer_size);
7423 for (i = 1; i < argc; i++)
7425 if (argv[i][0] == '+')
7427 debug_trace_memory = 2;
7430 if (isdigit(argv[i][0]))
7431 debug_selector = Ustrtol(argv[i], NULL, 0);
7433 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7437 eldap_default_servers = argv[i];
7440 mysql_servers = argv[i];
7443 pgsql_servers = argv[i];
7445 #ifdef EXPERIMENTAL_REDIS
7446 redis_servers = argv[i];
7450 else opt_perl_startup = argv[i];
7454 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7456 expand_nstring[1] = US"string 1....";
7457 expand_nlength[1] = 8;
7461 if (opt_perl_startup != NULL)
7464 printf("Starting Perl interpreter\n");
7465 errstr = init_perl(opt_perl_startup);
7468 printf("** error in perl_startup code: %s\n", errstr);
7469 return EXIT_FAILURE;
7472 #endif /* EXIM_PERL */
7474 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7476 void *reset_point = store_get(0);
7477 uschar *yield = expand_string(buffer);
7480 printf("%s\n", yield);
7481 store_reset(reset_point);
7485 if (search_find_defer) printf("search_find deferred\n");
7486 printf("Failed: %s\n", expand_string_message);
7487 if (expand_string_forcedfail) printf("Forced failure\n");
7501 /* End of expand.c */