1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2014 */
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(uschar *, BOOL, uschar **, BOOL, BOOL, BOOL *);
17 static int_eximarith_t expanded_string_integer(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
98 # define nelements(arr) (sizeof(arr) / sizeof(*arr))
101 /*************************************************
102 * Local statics and tables *
103 *************************************************/
105 /* Table of item names, and corresponding switch numbers. The names must be in
106 alphabetical order. */
108 static uschar *item_table[] = {
160 /* Tables of operator names, and corresponding switch numbers. The names must be
161 in alphabetical order. There are two tables, because underscore is used in some
162 cases to introduce arguments, whereas for other it is part of the name. This is
163 an historical mis-design. */
165 static uschar *op_table_underscore[] = {
168 US"quote_local_part",
176 EOP_QUOTE_LOCAL_PART,
181 static uschar *op_table_main[] = {
220 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
258 /* Table of condition names, and corresponding switch numbers. The names must
259 be in alphabetical order. */
261 static uschar *cond_table[] = {
265 US"==", /* Backward compatibility */
298 US"match_local_part",
323 ECOND_FIRST_DELIVERY,
344 ECOND_MATCH_LOCAL_PART,
354 /* Types of table entry */
357 vtype_int, /* value is address of int */
358 vtype_filter_int, /* ditto, but recognized only when filtering */
359 vtype_ino, /* value is address of ino_t (not always an int) */
360 vtype_uid, /* value is address of uid_t (not always an int) */
361 vtype_gid, /* value is address of gid_t (not always an int) */
362 vtype_bool, /* value is address of bool */
363 vtype_stringptr, /* value is address of pointer to string */
364 vtype_msgbody, /* as stringptr, but read when first required */
365 vtype_msgbody_end, /* ditto, the end of the message */
366 vtype_msgheaders, /* the message's headers, processed */
367 vtype_msgheaders_raw, /* the message's headers, unprocessed */
368 vtype_localpart, /* extract local part from string */
369 vtype_domain, /* extract domain from string */
370 vtype_string_func, /* value is string returned by given function */
371 vtype_todbsdin, /* value not used; generate BSD inbox tod */
372 vtype_tode, /* value not used; generate tod in epoch format */
373 vtype_todel, /* value not used; generate tod in epoch/usec format */
374 vtype_todf, /* value not used; generate full tod */
375 vtype_todl, /* value not used; generate log tod */
376 vtype_todlf, /* value not used; generate log file datestamp tod */
377 vtype_todzone, /* value not used; generate time zone only */
378 vtype_todzulu, /* value not used; generate zulu tod */
379 vtype_reply, /* value not used; get reply from headers */
380 vtype_pid, /* value not used; result is pid */
381 vtype_host_lookup, /* value not used; get host name */
382 vtype_load_avg, /* value not used; result is int from os_getloadavg */
383 vtype_pspace, /* partition space; value is T/F for spool/log */
384 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
385 vtype_cert /* SSL certificate */
387 ,vtype_dkim /* Lookup of value in DKIM signature */
391 /* Type for main variable table */
399 /* Type for entries pointing to address/length pairs. Not currently
407 static uschar * fn_recipients(void);
409 /* This table must be kept in alphabetical order. */
411 static var_entry var_table[] = {
412 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
413 they will be confused with user-creatable ACL variables. */
414 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
415 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
416 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
417 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
418 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
419 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
420 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
421 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
422 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
423 { "acl_narg", vtype_int, &acl_narg },
424 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
425 { "address_data", vtype_stringptr, &deliver_address_data },
426 { "address_file", vtype_stringptr, &address_file },
427 { "address_pipe", vtype_stringptr, &address_pipe },
428 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
429 { "authenticated_id", vtype_stringptr, &authenticated_id },
430 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
431 { "authentication_failed",vtype_int, &authentication_failed },
432 #ifdef WITH_CONTENT_SCAN
433 { "av_failed", vtype_int, &av_failed },
435 #ifdef EXPERIMENTAL_BRIGHTMAIL
436 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
437 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
438 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
439 { "bmi_deliver", vtype_int, &bmi_deliver },
441 { "body_linecount", vtype_int, &body_linecount },
442 { "body_zerocount", vtype_int, &body_zerocount },
443 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
444 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
445 { "caller_gid", vtype_gid, &real_gid },
446 { "caller_uid", vtype_uid, &real_uid },
447 { "compile_date", vtype_stringptr, &version_date },
448 { "compile_number", vtype_stringptr, &version_cnumber },
449 { "config_dir", vtype_stringptr, &config_main_directory },
450 { "config_file", vtype_stringptr, &config_main_filename },
451 { "csa_status", vtype_stringptr, &csa_status },
452 #ifdef EXPERIMENTAL_DCC
453 { "dcc_header", vtype_stringptr, &dcc_header },
454 { "dcc_result", vtype_stringptr, &dcc_result },
456 #ifdef WITH_OLD_DEMIME
457 { "demime_errorlevel", vtype_int, &demime_errorlevel },
458 { "demime_reason", vtype_stringptr, &demime_reason },
461 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
462 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
463 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
464 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
465 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
466 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
467 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
468 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
469 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
470 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
471 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
472 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
473 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
474 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
475 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
476 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
477 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
478 { "dkim_signers", vtype_stringptr, &dkim_signers },
479 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
480 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
482 #ifdef EXPERIMENTAL_DMARC
483 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
484 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
485 { "dmarc_status", vtype_stringptr, &dmarc_status },
486 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
487 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
489 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
490 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
491 { "dnslist_text", vtype_stringptr, &dnslist_text },
492 { "dnslist_value", vtype_stringptr, &dnslist_value },
493 { "domain", vtype_stringptr, &deliver_domain },
494 { "domain_data", vtype_stringptr, &deliver_domain_data },
495 #ifdef EXPERIMENTAL_EVENT
496 { "event_data", vtype_stringptr, &event_data },
498 /*XXX want to use generic vars for as many of these as possible*/
499 { "event_defer_errno", vtype_int, &event_defer_errno },
501 { "event_name", vtype_stringptr, &event_name },
503 { "exim_gid", vtype_gid, &exim_gid },
504 { "exim_path", vtype_stringptr, &exim_path },
505 { "exim_uid", vtype_uid, &exim_uid },
506 #ifdef WITH_OLD_DEMIME
507 { "found_extension", vtype_stringptr, &found_extension },
509 { "headers_added", vtype_string_func, &fn_hdrs_added },
510 { "home", vtype_stringptr, &deliver_home },
511 { "host", vtype_stringptr, &deliver_host },
512 { "host_address", vtype_stringptr, &deliver_host_address },
513 { "host_data", vtype_stringptr, &host_data },
514 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
515 { "host_lookup_failed", vtype_int, &host_lookup_failed },
516 { "host_port", vtype_int, &deliver_host_port },
517 { "inode", vtype_ino, &deliver_inode },
518 { "interface_address", vtype_stringptr, &interface_address },
519 { "interface_port", vtype_int, &interface_port },
520 { "item", vtype_stringptr, &iterate_item },
522 { "ldap_dn", vtype_stringptr, &eldap_dn },
524 { "load_average", vtype_load_avg, NULL },
525 { "local_part", vtype_stringptr, &deliver_localpart },
526 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
527 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
528 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
529 { "local_scan_data", vtype_stringptr, &local_scan_data },
530 { "local_user_gid", vtype_gid, &local_user_gid },
531 { "local_user_uid", vtype_uid, &local_user_uid },
532 { "localhost_number", vtype_int, &host_number },
533 { "log_inodes", vtype_pinodes, (void *)FALSE },
534 { "log_space", vtype_pspace, (void *)FALSE },
535 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
536 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
537 #ifdef WITH_CONTENT_SCAN
538 { "malware_name", vtype_stringptr, &malware_name },
540 { "max_received_linelength", vtype_int, &max_received_linelength },
541 { "message_age", vtype_int, &message_age },
542 { "message_body", vtype_msgbody, &message_body },
543 { "message_body_end", vtype_msgbody_end, &message_body_end },
544 { "message_body_size", vtype_int, &message_body_size },
545 { "message_exim_id", vtype_stringptr, &message_id },
546 { "message_headers", vtype_msgheaders, NULL },
547 { "message_headers_raw", vtype_msgheaders_raw, NULL },
548 { "message_id", vtype_stringptr, &message_id },
549 { "message_linecount", vtype_int, &message_linecount },
550 { "message_size", vtype_int, &message_size },
551 #ifdef WITH_CONTENT_SCAN
552 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
553 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
554 { "mime_boundary", vtype_stringptr, &mime_boundary },
555 { "mime_charset", vtype_stringptr, &mime_charset },
556 { "mime_content_description", vtype_stringptr, &mime_content_description },
557 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
558 { "mime_content_id", vtype_stringptr, &mime_content_id },
559 { "mime_content_size", vtype_int, &mime_content_size },
560 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
561 { "mime_content_type", vtype_stringptr, &mime_content_type },
562 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
563 { "mime_filename", vtype_stringptr, &mime_filename },
564 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
565 { "mime_is_multipart", vtype_int, &mime_is_multipart },
566 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
567 { "mime_part_count", vtype_int, &mime_part_count },
569 { "n0", vtype_filter_int, &filter_n[0] },
570 { "n1", vtype_filter_int, &filter_n[1] },
571 { "n2", vtype_filter_int, &filter_n[2] },
572 { "n3", vtype_filter_int, &filter_n[3] },
573 { "n4", vtype_filter_int, &filter_n[4] },
574 { "n5", vtype_filter_int, &filter_n[5] },
575 { "n6", vtype_filter_int, &filter_n[6] },
576 { "n7", vtype_filter_int, &filter_n[7] },
577 { "n8", vtype_filter_int, &filter_n[8] },
578 { "n9", vtype_filter_int, &filter_n[9] },
579 { "original_domain", vtype_stringptr, &deliver_domain_orig },
580 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
581 { "originator_gid", vtype_gid, &originator_gid },
582 { "originator_uid", vtype_uid, &originator_uid },
583 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
584 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
585 { "pid", vtype_pid, NULL },
586 { "primary_hostname", vtype_stringptr, &primary_hostname },
587 #ifdef EXPERIMENTAL_PROXY
588 { "proxy_host_address", vtype_stringptr, &proxy_host_address },
589 { "proxy_host_port", vtype_int, &proxy_host_port },
590 { "proxy_session", vtype_bool, &proxy_session },
591 { "proxy_target_address",vtype_stringptr, &proxy_target_address },
592 { "proxy_target_port", vtype_int, &proxy_target_port },
594 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
595 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
596 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
597 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
598 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
599 { "rcpt_count", vtype_int, &rcpt_count },
600 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
601 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
602 { "received_count", vtype_int, &received_count },
603 { "received_for", vtype_stringptr, &received_for },
604 { "received_ip_address", vtype_stringptr, &interface_address },
605 { "received_port", vtype_int, &interface_port },
606 { "received_protocol", vtype_stringptr, &received_protocol },
607 { "received_time", vtype_int, &received_time },
608 { "recipient_data", vtype_stringptr, &recipient_data },
609 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
610 { "recipients", vtype_string_func, &fn_recipients },
611 { "recipients_count", vtype_int, &recipients_count },
612 #ifdef WITH_CONTENT_SCAN
613 { "regex_match_string", vtype_stringptr, ®ex_match_string },
615 { "reply_address", vtype_reply, NULL },
616 { "return_path", vtype_stringptr, &return_path },
617 { "return_size_limit", vtype_int, &bounce_return_size_limit },
618 { "router_name", vtype_stringptr, &router_name },
619 { "runrc", vtype_int, &runrc },
620 { "self_hostname", vtype_stringptr, &self_hostname },
621 { "sender_address", vtype_stringptr, &sender_address },
622 { "sender_address_data", vtype_stringptr, &sender_address_data },
623 { "sender_address_domain", vtype_domain, &sender_address },
624 { "sender_address_local_part", vtype_localpart, &sender_address },
625 { "sender_data", vtype_stringptr, &sender_data },
626 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
627 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
628 { "sender_host_address", vtype_stringptr, &sender_host_address },
629 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
630 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
631 { "sender_host_name", vtype_host_lookup, NULL },
632 { "sender_host_port", vtype_int, &sender_host_port },
633 { "sender_ident", vtype_stringptr, &sender_ident },
634 { "sender_rate", vtype_stringptr, &sender_rate },
635 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
636 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
637 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
638 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
639 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
640 { "sending_port", vtype_int, &sending_port },
641 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
642 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
643 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
644 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
645 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
646 { "sn0", vtype_filter_int, &filter_sn[0] },
647 { "sn1", vtype_filter_int, &filter_sn[1] },
648 { "sn2", vtype_filter_int, &filter_sn[2] },
649 { "sn3", vtype_filter_int, &filter_sn[3] },
650 { "sn4", vtype_filter_int, &filter_sn[4] },
651 { "sn5", vtype_filter_int, &filter_sn[5] },
652 { "sn6", vtype_filter_int, &filter_sn[6] },
653 { "sn7", vtype_filter_int, &filter_sn[7] },
654 { "sn8", vtype_filter_int, &filter_sn[8] },
655 { "sn9", vtype_filter_int, &filter_sn[9] },
656 #ifdef WITH_CONTENT_SCAN
657 { "spam_bar", vtype_stringptr, &spam_bar },
658 { "spam_report", vtype_stringptr, &spam_report },
659 { "spam_score", vtype_stringptr, &spam_score },
660 { "spam_score_int", vtype_stringptr, &spam_score_int },
662 #ifdef EXPERIMENTAL_SPF
663 { "spf_guess", vtype_stringptr, &spf_guess },
664 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
665 { "spf_received", vtype_stringptr, &spf_received },
666 { "spf_result", vtype_stringptr, &spf_result },
667 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
669 { "spool_directory", vtype_stringptr, &spool_directory },
670 { "spool_inodes", vtype_pinodes, (void *)TRUE },
671 { "spool_space", vtype_pspace, (void *)TRUE },
672 #ifdef EXPERIMENTAL_SRS
673 { "srs_db_address", vtype_stringptr, &srs_db_address },
674 { "srs_db_key", vtype_stringptr, &srs_db_key },
675 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
676 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
677 { "srs_recipient", vtype_stringptr, &srs_recipient },
678 { "srs_status", vtype_stringptr, &srs_status },
680 { "thisaddress", vtype_stringptr, &filter_thisaddress },
682 /* The non-(in,out) variables are now deprecated */
683 { "tls_bits", vtype_int, &tls_in.bits },
684 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
685 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
687 { "tls_in_bits", vtype_int, &tls_in.bits },
688 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
689 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
690 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
691 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
692 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
693 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
694 #if defined(SUPPORT_TLS)
695 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
697 { "tls_out_bits", vtype_int, &tls_out.bits },
698 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
699 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
700 #ifdef EXPERIMENTAL_DANE
701 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
703 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
704 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
705 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
706 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
707 #if defined(SUPPORT_TLS)
708 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
710 #ifdef EXPERIMENTAL_DANE
711 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
714 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
715 #if defined(SUPPORT_TLS)
716 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
719 { "tod_bsdinbox", vtype_todbsdin, NULL },
720 { "tod_epoch", vtype_tode, NULL },
721 { "tod_epoch_l", vtype_todel, NULL },
722 { "tod_full", vtype_todf, NULL },
723 { "tod_log", vtype_todl, NULL },
724 { "tod_logfile", vtype_todlf, NULL },
725 { "tod_zone", vtype_todzone, NULL },
726 { "tod_zulu", vtype_todzulu, NULL },
727 { "transport_name", vtype_stringptr, &transport_name },
728 { "value", vtype_stringptr, &lookup_value },
729 { "verify_mode", vtype_stringptr, &verify_mode },
730 { "version_number", vtype_stringptr, &version_string },
731 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
732 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
733 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
734 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
735 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
736 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
739 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
740 static uschar var_buffer[256];
741 static BOOL malformed_header;
743 /* For textual hashes */
745 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
746 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
749 enum { HMAC_MD5, HMAC_SHA1 };
751 /* For numeric hashes */
753 static unsigned int prime[] = {
754 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
755 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
756 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
758 /* For printing modes in symbolic form */
760 static uschar *mtable_normal[] =
761 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
763 static uschar *mtable_setid[] =
764 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
766 static uschar *mtable_sticky[] =
767 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
771 /*************************************************
772 * Tables for UTF-8 support *
773 *************************************************/
775 /* Table of the number of extra characters, indexed by the first character
776 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
779 static uschar utf8_table1[] = {
780 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
781 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
782 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
783 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
785 /* These are the masks for the data bits in the first byte of a character,
786 indexed by the number of additional bytes. */
788 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
790 /* Get the next UTF-8 character, advancing the pointer. */
792 #define GETUTF8INC(c, ptr) \
794 if ((c & 0xc0) == 0xc0) \
796 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
798 c = (c & utf8_table2[a]) << s; \
802 c |= (*ptr++ & 0x3f) << s; \
807 /*************************************************
808 * Binary chop search on a table *
809 *************************************************/
811 /* This is used for matching expansion items and operators.
814 name the name that is being sought
815 table the table to search
816 table_size the number of items in the table
818 Returns: the offset in the table, or -1
822 chop_match(uschar *name, uschar **table, int table_size)
824 uschar **bot = table;
825 uschar **top = table + table_size;
829 uschar **mid = bot + (top - bot)/2;
830 int c = Ustrcmp(name, *mid);
831 if (c == 0) return mid - table;
832 if (c > 0) bot = mid + 1; else top = mid;
840 /*************************************************
841 * Check a condition string *
842 *************************************************/
844 /* This function is called to expand a string, and test the result for a "true"
845 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
846 forced fail or lookup defer.
848 We used to release all store used, but this is not not safe due
849 to ${dlfunc } and ${acl }. In any case expand_string_internal()
850 is reasonably careful to release what it can.
852 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
855 condition the condition string
856 m1 text to be incorporated in panic error
859 Returns: TRUE if condition is met, FALSE if not
863 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
866 uschar *ss = expand_string(condition);
869 if (!expand_string_forcedfail && !search_find_defer)
870 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
871 "for %s %s: %s", condition, m1, m2, expand_string_message);
874 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
875 strcmpic(ss, US"false") != 0;
882 /*************************************************
883 * Pseudo-random number generation *
884 *************************************************/
886 /* Pseudo-random number generation. The result is not "expected" to be
887 cryptographically strong but not so weak that someone will shoot themselves
888 in the foot using it as a nonce in some email header scheme or whatever
889 weirdness they'll twist this into. The result should ideally handle fork().
891 However, if we're stuck unable to provide this, then we'll fall back to
892 appallingly bad randomness.
894 If SUPPORT_TLS is defined then this will not be used except as an emergency
899 Returns a random number in range [0, max-1]
903 # define vaguely_random_number vaguely_random_number_fallback
906 vaguely_random_number(int max)
909 # undef vaguely_random_number
911 static pid_t pid = 0;
913 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
923 #ifdef HAVE_ARC4RANDOM
924 /* cryptographically strong randomness, common on *BSD platforms, not
925 so much elsewhere. Alas. */
926 #ifndef NOT_HAVE_ARC4RANDOM_STIR
929 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
930 #ifdef HAVE_SRANDOMDEV
931 /* uses random(4) for seeding */
934 gettimeofday(&tv, NULL);
935 srandom(tv.tv_sec | tv.tv_usec | getpid());
938 /* Poor randomness and no seeding here */
945 #ifdef HAVE_ARC4RANDOM
946 return arc4random() % max;
947 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
948 return random() % max;
950 /* This one returns a 16-bit number, definitely not crypto-strong */
951 return random_number(max);
958 /*************************************************
959 * Pick out a name from a string *
960 *************************************************/
962 /* If the name is too long, it is silently truncated.
965 name points to a buffer into which to put the name
966 max is the length of the buffer
967 s points to the first alphabetic character of the name
968 extras chars other than alphanumerics to permit
970 Returns: pointer to the first character after the name
972 Note: The test for *s != 0 in the while loop is necessary because
973 Ustrchr() yields non-NULL if the character is zero (which is not something
977 read_name(uschar *name, int max, uschar *s, uschar *extras)
980 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
982 if (ptr < max-1) name[ptr++] = *s;
991 /*************************************************
992 * Pick out the rest of a header name *
993 *************************************************/
995 /* A variable name starting $header_ (or just $h_ for those who like
996 abbreviations) might not be the complete header name because headers can
997 contain any printing characters in their names, except ':'. This function is
998 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
999 on the end, if the name was terminated by white space.
1002 name points to a buffer in which the name read so far exists
1003 max is the length of the buffer
1004 s points to the first character after the name so far, i.e. the
1005 first non-alphameric character after $header_xxxxx
1007 Returns: a pointer to the first character after the header name
1011 read_header_name(uschar *name, int max, uschar *s)
1013 int prelen = Ustrchr(name, '_') - name + 1;
1014 int ptr = Ustrlen(name) - prelen;
1015 if (ptr > 0) memmove(name, name+prelen, ptr);
1016 while (mac_isgraph(*s) && *s != ':')
1018 if (ptr < max-1) name[ptr++] = *s;
1029 /*************************************************
1030 * Pick out a number from a string *
1031 *************************************************/
1034 n points to an integer into which to put the number
1035 s points to the first digit of the number
1037 Returns: a pointer to the character after the last digit
1041 read_number(int *n, uschar *s)
1044 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1050 /*************************************************
1051 * Extract keyed subfield from a string *
1052 *************************************************/
1054 /* The yield is in dynamic store; NULL means that the key was not found.
1057 key points to the name of the key
1058 s points to the string from which to extract the subfield
1060 Returns: NULL if the subfield was not found, or
1061 a pointer to the subfield's data
1065 expand_getkeyed(uschar *key, uschar *s)
1067 int length = Ustrlen(key);
1068 while (isspace(*s)) s++;
1070 /* Loop to search for the key */
1078 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1079 dkeylength = s - dkey;
1080 while (isspace(*s)) s++;
1081 if (*s == '=') while (isspace((*(++s))));
1083 data = string_dequote(&s);
1084 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1087 while (isspace(*s)) s++;
1096 find_var_ent(uschar * name)
1099 int last = var_table_size;
1101 while (last > first)
1103 int middle = (first + last)/2;
1104 int c = Ustrcmp(name, var_table[middle].name);
1106 if (c > 0) { first = middle + 1; continue; }
1107 if (c < 0) { last = middle; continue; }
1108 return &var_table[middle];
1113 /*************************************************
1114 * Extract numbered subfield from string *
1115 *************************************************/
1117 /* Extracts a numbered field from a string that is divided by tokens - for
1118 example a line from /etc/passwd is divided by colon characters. First field is
1119 numbered one. Negative arguments count from the right. Zero returns the whole
1120 string. Returns NULL if there are insufficient tokens in the string
1123 Modifies final argument - this is a dynamically generated string, so that's OK.
1126 field number of field to be extracted,
1127 first field = 1, whole string = 0, last field = -1
1128 separators characters that are used to break string into tokens
1129 s points to the string from which to extract the subfield
1131 Returns: NULL if the field was not found,
1132 a pointer to the field's data inside s (modified to add 0)
1136 expand_gettokened (int field, uschar *separators, uschar *s)
1141 uschar *fieldtext = NULL;
1143 if (field == 0) return s;
1145 /* Break the line up into fields in place; for field > 0 we stop when we have
1146 done the number of fields we want. For field < 0 we continue till the end of
1147 the string, counting the number of fields. */
1149 count = (field > 0)? field : INT_MAX;
1155 /* Previous field was the last one in the string. For a positive field
1156 number, this means there are not enough fields. For a negative field number,
1157 check that there are enough, and scan back to find the one that is wanted. */
1161 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1162 if ((-field) == (INT_MAX - count - 1)) return s;
1166 while (ss[-1] != 0) ss--;
1172 /* Previous field was not last in the string; save its start and put a
1176 len = Ustrcspn(ss, separators);
1187 expand_getlistele(int field, uschar * list)
1189 uschar * tlist= list;
1195 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1198 if(field==0) return NULL;
1199 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1200 return string_nextinlist(&list, &sep, NULL, 0);
1204 /* Certificate fields, by name. Worry about by-OID later */
1205 /* Names are chosen to not have common prefixes */
1212 uschar * (*getfn)(void * cert, uschar * mod);
1214 static certfield certfields[] =
1215 { /* linear search; no special order */
1216 { US"version", 7, &tls_cert_version },
1217 { US"serial_number", 13, &tls_cert_serial_number },
1218 { US"subject", 7, &tls_cert_subject },
1219 { US"notbefore", 9, &tls_cert_not_before },
1220 { US"notafter", 8, &tls_cert_not_after },
1221 { US"issuer", 6, &tls_cert_issuer },
1222 { US"signature", 9, &tls_cert_signature },
1223 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1224 { US"subj_altname", 12, &tls_cert_subject_altname },
1225 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1226 { US"crl_uri", 7, &tls_cert_crl_uri },
1230 expand_getcertele(uschar * field, uschar * certvar)
1235 if (!(vp = find_var_ent(certvar)))
1237 expand_string_message =
1238 string_sprintf("no variable named \"%s\"", certvar);
1239 return NULL; /* Unknown variable name */
1241 /* NB this stops us passing certs around in variable. Might
1242 want to do that in future */
1243 if (vp->type != vtype_cert)
1245 expand_string_message =
1246 string_sprintf("\"%s\" is not a certificate", certvar);
1247 return NULL; /* Unknown variable name */
1249 if (!*(void **)vp->value)
1252 if (*field >= '0' && *field <= '9')
1253 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1255 for(cp = certfields;
1256 cp < certfields + nelements(certfields);
1258 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1260 uschar * modifier = *(field += cp->namelen) == ','
1262 return (*cp->getfn)( *(void **)vp->value, modifier );
1265 expand_string_message =
1266 string_sprintf("bad field selector \"%s\" for certextract", field);
1269 #endif /*SUPPORT_TLS*/
1271 /*************************************************
1272 * Extract a substring from a string *
1273 *************************************************/
1275 /* Perform the ${substr or ${length expansion operations.
1278 subject the input string
1279 value1 the offset from the start of the input string to the start of
1280 the output string; if negative, count from the right.
1281 value2 the length of the output string, or negative (-1) for unset
1282 if value1 is positive, unset means "all after"
1283 if value1 is negative, unset means "all before"
1284 len set to the length of the returned string
1286 Returns: pointer to the output string, or NULL if there is an error
1290 extract_substr(uschar *subject, int value1, int value2, int *len)
1292 int sublen = Ustrlen(subject);
1294 if (value1 < 0) /* count from right */
1298 /* If the position is before the start, skip to the start, and adjust the
1299 length. If the length ends up negative, the substring is null because nothing
1300 can precede. This falls out naturally when the length is unset, meaning "all
1306 if (value2 < 0) value2 = 0;
1310 /* Otherwise an unset length => characters before value1 */
1312 else if (value2 < 0)
1319 /* For a non-negative offset, if the starting position is past the end of the
1320 string, the result will be the null string. Otherwise, an unset length means
1321 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1325 if (value1 > sublen)
1330 else if (value2 < 0) value2 = sublen;
1333 /* Cut the length down to the maximum possible for the offset value, and get
1334 the required characters. */
1336 if (value1 + value2 > sublen) value2 = sublen - value1;
1338 return subject + value1;
1344 /*************************************************
1345 * Old-style hash of a string *
1346 *************************************************/
1348 /* Perform the ${hash expansion operation.
1351 subject the input string (an expanded substring)
1352 value1 the length of the output string; if greater or equal to the
1353 length of the input string, the input string is returned
1354 value2 the number of hash characters to use, or 26 if negative
1355 len set to the length of the returned string
1357 Returns: pointer to the output string, or NULL if there is an error
1361 compute_hash(uschar *subject, int value1, int value2, int *len)
1363 int sublen = Ustrlen(subject);
1365 if (value2 < 0) value2 = 26;
1366 else if (value2 > Ustrlen(hashcodes))
1368 expand_string_message =
1369 string_sprintf("hash count \"%d\" too big", value2);
1373 /* Calculate the hash text. We know it is shorter than the original string, so
1374 can safely place it in subject[] (we know that subject is always itself an
1375 expanded substring). */
1377 if (value1 < sublen)
1382 while ((c = (subject[j])) != 0)
1384 int shift = (c + j++) & 7;
1385 subject[i] ^= (c << shift) | (c >> (8-shift));
1386 if (++i >= value1) i = 0;
1388 for (i = 0; i < value1; i++)
1389 subject[i] = hashcodes[(subject[i]) % value2];
1391 else value1 = sublen;
1400 /*************************************************
1401 * Numeric hash of a string *
1402 *************************************************/
1404 /* Perform the ${nhash expansion operation. The first characters of the
1405 string are treated as most important, and get the highest prime numbers.
1408 subject the input string
1409 value1 the maximum value of the first part of the result
1410 value2 the maximum value of the second part of the result,
1411 or negative to produce only a one-part result
1412 len set to the length of the returned string
1414 Returns: pointer to the output string, or NULL if there is an error.
1418 compute_nhash (uschar *subject, int value1, int value2, int *len)
1420 uschar *s = subject;
1422 unsigned long int total = 0; /* no overflow */
1426 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1427 total += prime[i--] * (unsigned int)(*s++);
1430 /* If value2 is unset, just compute one number */
1434 s = string_sprintf("%d", total % value1);
1437 /* Otherwise do a div/mod hash */
1441 total = total % (value1 * value2);
1442 s = string_sprintf("%d/%d", total/value2, total % value2);
1453 /*************************************************
1454 * Find the value of a header or headers *
1455 *************************************************/
1457 /* Multiple instances of the same header get concatenated, and this function
1458 can also return a concatenation of all the header lines. When concatenating
1459 specific headers that contain lists of addresses, a comma is inserted between
1460 them. Otherwise we use a straight concatenation. Because some messages can have
1461 pathologically large number of lines, there is a limit on the length that is
1462 returned. Also, to avoid massive store use which would result from using
1463 string_cat() as it copies and extends strings, we do a preliminary pass to find
1464 out exactly how much store will be needed. On "normal" messages this will be
1468 name the name of the header, without the leading $header_ or $h_,
1469 or NULL if a concatenation of all headers is required
1470 exists_only TRUE if called from a def: test; don't need to build a string;
1471 just return a string that is not "" and not "0" if the header
1473 newsize return the size of memory block that was obtained; may be NULL
1474 if exists_only is TRUE
1475 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1476 other than concatenating, will be done on the header. Also used
1477 for $message_headers_raw.
1478 charset name of charset to translate MIME words to; used only if
1479 want_raw is false; if NULL, no translation is done (this is
1480 used for $bh_ and $bheader_)
1482 Returns: NULL if the header does not exist, else a pointer to a new
1487 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1490 BOOL found = name == NULL;
1492 int len = found? 0 : Ustrlen(name);
1494 uschar *yield = NULL;
1497 /* Loop for two passes - saves code repetition */
1499 for (i = 0; i < 2; i++)
1504 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1506 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1508 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1513 if (exists_only) return US"1"; /* don't need actual string */
1515 t = h->text + len; /* text to insert */
1516 if (!want_raw) /* unless wanted raw, */
1517 while (isspace(*t)) t++; /* remove leading white space */
1518 ilen = h->slen - (t - h->text); /* length to insert */
1520 /* Unless wanted raw, remove trailing whitespace, including the
1524 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1526 /* Set comma = 1 if handling a single header and it's one of those
1527 that contains an address list, except when asked for raw headers. Only
1528 need to do this once. */
1530 if (!want_raw && name != NULL && comma == 0 &&
1531 Ustrchr("BCFRST", h->type) != NULL)
1534 /* First pass - compute total store needed; second pass - compute
1535 total store used, including this header. */
1537 size += ilen + comma + 1; /* +1 for the newline */
1539 /* Second pass - concatentate the data, up to a maximum. Note that
1540 the loop stops when size hits the limit. */
1544 if (size > header_insert_maxlen)
1546 ilen -= size - header_insert_maxlen - 1;
1549 Ustrncpy(ptr, t, ilen);
1552 /* For a non-raw header, put in the comma if needed, then add
1553 back the newline we removed above, provided there was some text in
1556 if (!want_raw && ilen > 0)
1558 if (comma != 0) *ptr++ = ',';
1566 /* At end of first pass, return NULL if no header found. Then truncate size
1567 if necessary, and get the buffer to hold the data, returning the buffer size.
1572 if (!found) return NULL;
1573 if (size > header_insert_maxlen) size = header_insert_maxlen;
1574 *newsize = size + 1;
1575 ptr = yield = store_get(*newsize);
1579 /* That's all we do for raw header expansion. */
1586 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1587 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1588 function can return an error with decoded data if the charset translation
1589 fails. If decoding fails, it returns NULL. */
1593 uschar *decoded, *error;
1594 if (ptr > yield && ptr[-1] == '\n') ptr--;
1595 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1597 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1601 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1602 " input was: %s\n", error, yield);
1604 if (decoded != NULL) yield = decoded;
1613 /*************************************************
1614 * Return list of recipients *
1615 *************************************************/
1616 /* A recipients list is available only during system message filtering,
1617 during ACL processing after DATA, and while expanding pipe commands
1618 generated from a system filter, but not elsewhere. */
1623 if (!enable_dollar_recipients) return NULL; else
1628 uschar * s = store_get(size);
1629 for (i = 0; i < recipients_count; i++)
1631 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1632 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1633 Ustrlen(recipients_list[i].address));
1635 s[ptr] = 0; /* string_cat() leaves room */
1641 /*************************************************
1642 * Find value of a variable *
1643 *************************************************/
1645 /* The table of variables is kept in alphabetic order, so we can search it
1646 using a binary chop. The "choplen" variable is nothing to do with the binary
1650 name the name of the variable being sought
1651 exists_only TRUE if this is a def: test; passed on to find_header()
1652 skipping TRUE => skip any processing evaluation; this is not the same as
1653 exists_only because def: may test for values that are first
1655 newsize pointer to an int which is initially zero; if the answer is in
1656 a new memory buffer, *newsize is set to its size
1658 Returns: NULL if the variable does not exist, or
1659 a pointer to the variable's contents, or
1660 something non-NULL if exists_only is TRUE
1664 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1671 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1672 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1673 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1674 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1675 (this gave backwards compatibility at the changeover). There may be built-in
1676 variables whose names start acl_ but they should never start in this way. This
1677 slightly messy specification is a consequence of the history, needless to say.
1679 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1680 set, in which case give an error. */
1682 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1686 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1687 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1690 /* Handle $auth<n> variables. */
1692 if (Ustrncmp(name, "auth", 4) == 0)
1695 int n = Ustrtoul(name + 4, &endptr, 10);
1696 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1697 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1700 /* For all other variables, search the table */
1702 if (!(vp = find_var_ent(name)))
1703 return NULL; /* Unknown variable name */
1705 /* Found an existing variable. If in skipping state, the value isn't needed,
1706 and we want to avoid processing (such as looking up the host name). */
1714 case vtype_filter_int:
1715 if (!filter_running) return NULL;
1719 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1723 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1727 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1731 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1735 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1738 case vtype_stringptr: /* Pointer to string */
1739 s = *((uschar **)(val));
1740 return (s == NULL)? US"" : s;
1743 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1746 case vtype_load_avg:
1747 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1750 case vtype_host_lookup: /* Lookup if not done so */
1751 if (sender_host_name == NULL && sender_host_address != NULL &&
1752 !host_lookup_failed && host_name_lookup() == OK)
1753 host_build_sender_fullhost();
1754 return (sender_host_name == NULL)? US"" : sender_host_name;
1756 case vtype_localpart: /* Get local part from address */
1757 s = *((uschar **)(val));
1758 if (s == NULL) return US"";
1759 domain = Ustrrchr(s, '@');
1760 if (domain == NULL) return s;
1761 if (domain - s > sizeof(var_buffer) - 1)
1762 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1763 " in string expansion", sizeof(var_buffer));
1764 Ustrncpy(var_buffer, s, domain - s);
1765 var_buffer[domain - s] = 0;
1768 case vtype_domain: /* Get domain from address */
1769 s = *((uschar **)(val));
1770 if (s == NULL) return US"";
1771 domain = Ustrrchr(s, '@');
1772 return (domain == NULL)? US"" : domain + 1;
1774 case vtype_msgheaders:
1775 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1777 case vtype_msgheaders_raw:
1778 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1780 case vtype_msgbody: /* Pointer to msgbody string */
1781 case vtype_msgbody_end: /* Ditto, the end of the msg */
1782 ss = (uschar **)(val);
1783 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1786 off_t start_offset = SPOOL_DATA_START_OFFSET;
1787 int len = message_body_visible;
1788 if (len > message_size) len = message_size;
1789 *ss = body = store_malloc(len+1);
1791 if (vp->type == vtype_msgbody_end)
1793 struct stat statbuf;
1794 if (fstat(deliver_datafile, &statbuf) == 0)
1796 start_offset = statbuf.st_size - len;
1797 if (start_offset < SPOOL_DATA_START_OFFSET)
1798 start_offset = SPOOL_DATA_START_OFFSET;
1801 lseek(deliver_datafile, start_offset, SEEK_SET);
1802 len = read(deliver_datafile, body, len);
1806 if (message_body_newlines) /* Separate loops for efficiency */
1809 { if (body[--len] == 0) body[len] = ' '; }
1814 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1818 return (*ss == NULL)? US"" : *ss;
1820 case vtype_todbsdin: /* BSD inbox time of day */
1821 return tod_stamp(tod_bsdin);
1823 case vtype_tode: /* Unix epoch time of day */
1824 return tod_stamp(tod_epoch);
1826 case vtype_todel: /* Unix epoch/usec time of day */
1827 return tod_stamp(tod_epoch_l);
1829 case vtype_todf: /* Full time of day */
1830 return tod_stamp(tod_full);
1832 case vtype_todl: /* Log format time of day */
1833 return tod_stamp(tod_log_bare); /* (without timezone) */
1835 case vtype_todzone: /* Time zone offset only */
1836 return tod_stamp(tod_zone);
1838 case vtype_todzulu: /* Zulu time */
1839 return tod_stamp(tod_zulu);
1841 case vtype_todlf: /* Log file datestamp tod */
1842 return tod_stamp(tod_log_datestamp_daily);
1844 case vtype_reply: /* Get reply address */
1845 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1847 if (s != NULL) while (isspace(*s)) s++;
1848 if (s == NULL || *s == 0)
1850 *newsize = 0; /* For the *s==0 case */
1851 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1856 while (isspace(*s)) s++;
1857 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1858 while (t > s && isspace(t[-1])) t--;
1861 return (s == NULL)? US"" : s;
1863 case vtype_string_func:
1865 uschar * (*fn)() = val;
1872 sprintf(CS var_buffer, "%d",
1873 receive_statvfs(val == (void *)TRUE, &inodes));
1880 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1881 sprintf(CS var_buffer, "%d", inodes);
1886 return *(void **)val ? US"<cert>" : US"";
1888 #ifndef DISABLE_DKIM
1890 return dkim_exim_expand_query((int)(long)val);
1895 return NULL; /* Unknown variable. Silences static checkers. */
1902 modify_variable(uschar *name, void * value)
1905 if ((vp = find_var_ent(name))) vp->value = value;
1906 return; /* Unknown variable name, fail silently */
1913 /*************************************************
1914 * Read and expand substrings *
1915 *************************************************/
1917 /* This function is called to read and expand argument substrings for various
1918 expansion items. Some have a minimum requirement that is less than the maximum;
1919 in these cases, the first non-present one is set to NULL.
1922 sub points to vector of pointers to set
1923 n maximum number of substrings
1925 sptr points to current string pointer
1926 skipping the skipping flag
1927 check_end if TRUE, check for final '}'
1928 name name of item, for error message
1929 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1932 Returns: 0 OK; string pointer updated
1933 1 curly bracketing error (too few arguments)
1934 2 too many arguments (only if check_end is set); message set
1935 3 other error (expansion failure)
1939 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1940 BOOL check_end, uschar *name, BOOL *resetok)
1945 while (isspace(*s)) s++;
1946 for (i = 0; i < n; i++)
1950 if (i < m) return 1;
1954 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
1955 if (sub[i] == NULL) return 3;
1956 if (*s++ != '}') return 1;
1957 while (isspace(*s)) s++;
1959 if (check_end && *s++ != '}')
1963 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1964 "(max is %d)", name, n);
1977 /*************************************************
1978 * Elaborate message for bad variable *
1979 *************************************************/
1981 /* For the "unknown variable" message, take a look at the variable's name, and
1982 give additional information about possible ACL variables. The extra information
1983 is added on to expand_string_message.
1985 Argument: the name of the variable
1990 check_variable_error_message(uschar *name)
1992 if (Ustrncmp(name, "acl_", 4) == 0)
1993 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1994 (name[4] == 'c' || name[4] == 'm')?
1996 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1997 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1999 US"user-defined ACL variables must start acl_c or acl_m");
2005 Load args from sub array to globals, and call acl_check().
2006 Sub array will be corrupted on return.
2008 Returns: OK access is granted by an ACCEPT verb
2009 DISCARD access is granted by a DISCARD verb
2010 FAIL access is denied
2011 FAIL_DROP access is denied; drop the connection
2012 DEFER can't tell at the moment
2016 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2019 uschar * tmp = NULL;
2020 int sav_narg = acl_narg;
2022 extern int acl_where;
2024 if(--nsub > sizeof(acl_arg)/sizeof(*acl_arg)) nsub = sizeof(acl_arg)/sizeof(*acl_arg);
2025 for (i = 0; i < nsub && sub[i+1]; i++)
2028 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2029 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2034 sub[i+1] = acl_arg[i];
2035 acl_arg[i++] = NULL;
2039 debug_printf("expanding: acl: %s arg: %s%s\n",
2041 acl_narg>0 ? acl_arg[0] : US"<none>",
2042 acl_narg>1 ? " +more" : "");
2044 ret = acl_eval(acl_where, sub[0], user_msgp, &tmp);
2046 for (i = 0; i < nsub; i++)
2047 acl_arg[i] = sub[i+1]; /* restore old args */
2048 acl_narg = sav_narg;
2056 /*************************************************
2057 * Read and evaluate a condition *
2058 *************************************************/
2062 s points to the start of the condition text
2063 resetok points to a BOOL which is written false if it is unsafe to
2064 free memory. Certain condition types (acl) may have side-effect
2065 allocation which must be preserved.
2066 yield points to a BOOL to hold the result of the condition test;
2067 if NULL, we are just reading through a condition that is
2068 part of an "or" combination to check syntax, or in a state
2069 where the answer isn't required
2071 Returns: a pointer to the first character after the condition, or
2076 eval_condition(uschar *s, BOOL *resetok, BOOL *yield)
2078 BOOL testfor = TRUE;
2079 BOOL tempcond, combined_cond;
2081 BOOL sub2_honour_dollar = TRUE;
2082 int i, rc, cond_type, roffset;
2083 int_eximarith_t num[2];
2084 struct stat statbuf;
2089 const uschar *rerror;
2093 while (isspace(*s)) s++;
2094 if (*s == '!') { testfor = !testfor; s++; } else break;
2097 /* Numeric comparisons are symbolic */
2099 if (*s == '=' || *s == '>' || *s == '<')
2111 /* All other conditions are named */
2113 else s = read_name(name, 256, s, US"_");
2115 /* If we haven't read a name, it means some non-alpha character is first. */
2119 expand_string_message = string_sprintf("condition name expected, "
2120 "but found \"%.16s\"", s);
2124 /* Find which condition we are dealing with, and switch on it */
2126 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
2129 /* def: tests for a non-empty variable, or for the existence of a header. If
2130 yield == NULL we are in a skipping state, and don't care about the answer. */
2135 expand_string_message = US"\":\" expected after \"def\"";
2139 s = read_name(name, 256, s+1, US"_");
2141 /* Test for a header's existence. If the name contains a closing brace
2142 character, this may be a user error where the terminating colon has been
2143 omitted. Set a flag to adjust a subsequent error message in this case. */
2145 if (Ustrncmp(name, "h_", 2) == 0 ||
2146 Ustrncmp(name, "rh_", 3) == 0 ||
2147 Ustrncmp(name, "bh_", 3) == 0 ||
2148 Ustrncmp(name, "header_", 7) == 0 ||
2149 Ustrncmp(name, "rheader_", 8) == 0 ||
2150 Ustrncmp(name, "bheader_", 8) == 0)
2152 s = read_header_name(name, 256, s);
2153 /* {-for-text-editors */
2154 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2155 if (yield != NULL) *yield =
2156 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2159 /* Test for a variable's having a non-empty value. A non-existent variable
2160 causes an expansion failure. */
2164 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2167 expand_string_message = (name[0] == 0)?
2168 string_sprintf("variable name omitted after \"def:\"") :
2169 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2170 check_variable_error_message(name);
2173 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2179 /* first_delivery tests for first delivery attempt */
2181 case ECOND_FIRST_DELIVERY:
2182 if (yield != NULL) *yield = deliver_firsttime == testfor;
2186 /* queue_running tests for any process started by a queue runner */
2188 case ECOND_QUEUE_RUNNING:
2189 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2193 /* exists: tests for file existence
2194 isip: tests for any IP address
2195 isip4: tests for an IPv4 address
2196 isip6: tests for an IPv6 address
2197 pam: does PAM authentication
2198 radius: does RADIUS authentication
2199 ldapauth: does LDAP authentication
2200 pwcheck: does Cyrus SASL pwcheck authentication
2209 case ECOND_LDAPAUTH:
2212 while (isspace(*s)) s++;
2213 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2215 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2216 if (sub[0] == NULL) return NULL;
2217 /* {-for-text-editors */
2218 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2220 if (yield == NULL) return s; /* No need to run the test if skipping */
2225 if ((expand_forbid & RDO_EXISTS) != 0)
2227 expand_string_message = US"File existence tests are not permitted";
2230 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2236 rc = string_is_ip_address(sub[0], NULL);
2237 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2238 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2241 /* Various authentication tests - all optionally compiled */
2245 rc = auth_call_pam(sub[0], &expand_string_message);
2248 goto COND_FAILED_NOT_COMPILED;
2249 #endif /* SUPPORT_PAM */
2252 #ifdef RADIUS_CONFIG_FILE
2253 rc = auth_call_radius(sub[0], &expand_string_message);
2256 goto COND_FAILED_NOT_COMPILED;
2257 #endif /* RADIUS_CONFIG_FILE */
2259 case ECOND_LDAPAUTH:
2262 /* Just to keep the interface the same */
2264 int old_pool = store_pool;
2265 store_pool = POOL_SEARCH;
2266 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2267 &expand_string_message, &do_cache);
2268 store_pool = old_pool;
2272 goto COND_FAILED_NOT_COMPILED;
2273 #endif /* LOOKUP_LDAP */
2276 #ifdef CYRUS_PWCHECK_SOCKET
2277 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2280 goto COND_FAILED_NOT_COMPILED;
2281 #endif /* CYRUS_PWCHECK_SOCKET */
2283 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2284 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2286 if (rc == ERROR || rc == DEFER) return NULL;
2287 *yield = (rc == OK) == testfor;
2293 /* call ACL (in a conditional context). Accept true, deny false.
2294 Defer is a forced-fail. Anything set by message= goes to $value.
2295 Up to ten parameters are used; we use the braces round the name+args
2296 like the saslauthd condition does, to permit a variable number of args.
2297 See also the expansion-item version EITEM_ACL and the traditional
2298 acl modifier ACLC_ACL.
2299 Since the ACL may allocate new global variables, tell our caller to not
2304 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2311 while (isspace(*s)) s++;
2312 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2314 switch(read_subs(sub, sizeof(sub)/sizeof(*sub), 1,
2315 &s, yield == NULL, TRUE, US"acl", resetok))
2317 case 1: expand_string_message = US"too few arguments or bracketing "
2320 case 3: return NULL;
2324 if (yield != NULL) switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
2329 lookup_value = NULL;
2332 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2333 lookup_value[ptr] = '\0';
2335 *yield = cond == testfor;
2339 expand_string_forcedfail = TRUE;
2341 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2348 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2350 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2352 However, the last two are optional. That is why the whole set is enclosed
2353 in their own set of braces. */
2355 case ECOND_SASLAUTHD:
2356 #ifndef CYRUS_SASLAUTHD_SOCKET
2357 goto COND_FAILED_NOT_COMPILED;
2359 while (isspace(*s)) s++;
2360 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2361 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd", resetok))
2363 case 1: expand_string_message = US"too few arguments or bracketing "
2364 "error for saslauthd";
2366 case 3: return NULL;
2368 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2372 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2373 &expand_string_message);
2374 if (rc == ERROR || rc == DEFER) return NULL;
2375 *yield = (rc == OK) == testfor;
2378 #endif /* CYRUS_SASLAUTHD_SOCKET */
2381 /* symbolic operators for numeric and string comparison, and a number of
2382 other operators, all requiring two arguments.
2384 crypteq: encrypts plaintext and compares against an encrypted text,
2385 using crypt(), crypt16(), MD5 or SHA-1
2386 inlist/inlisti: checks if first argument is in the list of the second
2387 match: does a regular expression match and sets up the numerical
2388 variables if it succeeds
2389 match_address: matches in an address list
2390 match_domain: matches in a domain list
2391 match_ip: matches a host list that is restricted to IP addresses
2392 match_local_part: matches in a local part list
2395 case ECOND_MATCH_ADDRESS:
2396 case ECOND_MATCH_DOMAIN:
2397 case ECOND_MATCH_IP:
2398 case ECOND_MATCH_LOCAL_PART:
2399 #ifndef EXPAND_LISTMATCH_RHS
2400 sub2_honour_dollar = FALSE;
2409 case ECOND_NUM_L: /* Numerical comparisons */
2416 case ECOND_STR_LT: /* String comparisons */
2427 for (i = 0; i < 2; i++)
2429 /* Sometimes, we don't expand substrings; too many insecure configurations
2430 created using match_address{}{} and friends, where the second param
2431 includes information from untrustworthy sources. */
2432 BOOL honour_dollar = TRUE;
2433 if ((i > 0) && !sub2_honour_dollar)
2434 honour_dollar = FALSE;
2436 while (isspace(*s)) s++;
2439 if (i == 0) goto COND_FAILED_CURLY_START;
2440 expand_string_message = string_sprintf("missing 2nd string in {} "
2441 "after \"%s\"", name);
2444 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2445 honour_dollar, resetok);
2446 if (sub[i] == NULL) return NULL;
2447 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2449 /* Convert to numerical if required; we know that the names of all the
2450 conditions that compare numbers do not start with a letter. This just saves
2451 checking for them individually. */
2453 if (!isalpha(name[0]) && yield != NULL)
2459 debug_printf("empty string cast to zero for numerical comparison\n");
2463 num[i] = expanded_string_integer(sub[i], FALSE);
2464 if (expand_string_message != NULL) return NULL;
2469 /* Result not required */
2471 if (yield == NULL) return s;
2473 /* Do an appropriate comparison */
2479 tempcond = (num[0] == num[1]);
2483 tempcond = (num[0] > num[1]);
2487 tempcond = (num[0] >= num[1]);
2491 tempcond = (num[0] < num[1]);
2495 tempcond = (num[0] <= num[1]);
2499 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2503 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2507 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2511 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2515 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2519 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2523 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2527 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2531 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2535 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2538 case ECOND_MATCH: /* Regular expression match */
2539 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2543 expand_string_message = string_sprintf("regular expression error in "
2544 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2547 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2550 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2551 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2552 goto MATCHED_SOMETHING;
2554 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2555 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2556 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2557 goto MATCHED_SOMETHING;
2559 case ECOND_MATCH_IP: /* Match IP address in a host list */
2560 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2562 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2568 unsigned int *nullcache = NULL;
2569 check_host_block cb;
2571 cb.host_name = US"";
2572 cb.host_address = sub[0];
2574 /* If the host address starts off ::ffff: it is an IPv6 address in
2575 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2578 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2579 cb.host_address + 7 : cb.host_address;
2581 rc = match_check_list(
2582 &sub[1], /* the list */
2583 0, /* separator character */
2584 &hostlist_anchor, /* anchor pointer */
2585 &nullcache, /* cache pointer */
2586 check_host, /* function for testing */
2587 &cb, /* argument for function */
2588 MCL_HOST, /* type of check */
2589 sub[0], /* text for debugging */
2590 NULL); /* where to pass back data */
2592 goto MATCHED_SOMETHING;
2594 case ECOND_MATCH_LOCAL_PART:
2595 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2596 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2611 expand_string_message = string_sprintf("unable to complete match "
2612 "against \"%s\": %s", sub[1], search_error_message);
2618 /* Various "encrypted" comparisons. If the second string starts with
2619 "{" then an encryption type is given. Default to crypt() or crypt16()
2620 (build-time choice). */
2621 /* }-for-text-editors */
2624 #ifndef SUPPORT_CRYPTEQ
2625 goto COND_FAILED_NOT_COMPILED;
2627 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2629 int sublen = Ustrlen(sub[1]+5);
2634 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2636 /* If the length that we are comparing against is 24, the MD5 digest
2637 is expressed as a base64 string. This is the way LDAP does it. However,
2638 some other software uses a straightforward hex representation. We assume
2639 this if the length is 32. Other lengths fail. */
2643 uschar *coded = auth_b64encode((uschar *)digest, 16);
2644 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2645 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2646 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2648 else if (sublen == 32)
2652 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2654 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2655 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2656 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2660 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2661 "fail\n crypted=%s\n", sub[1]+5);
2666 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2668 int sublen = Ustrlen(sub[1]+6);
2673 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2675 /* If the length that we are comparing against is 28, assume the SHA1
2676 digest is expressed as a base64 string. If the length is 40, assume a
2677 straightforward hex representation. Other lengths fail. */
2681 uschar *coded = auth_b64encode((uschar *)digest, 20);
2682 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2683 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2684 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2686 else if (sublen == 40)
2690 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2692 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2693 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2694 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2698 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2699 "fail\n crypted=%s\n", sub[1]+6);
2704 else /* {crypt} or {crypt16} and non-{ at start */
2705 /* }-for-text-editors */
2710 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2715 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2720 else if (sub[1][0] == '{') /* }-for-text-editors */
2722 expand_string_message = string_sprintf("unknown encryption mechanism "
2723 "in \"%s\"", sub[1]);
2729 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2730 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2731 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2735 #define XSTR(s) STR(s)
2736 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2737 " subject=%s\n crypted=%s\n",
2738 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2743 /* If the encrypted string contains fewer than two characters (for the
2744 salt), force failure. Otherwise we get false positives: with an empty
2745 string the yield of crypt() is an empty string! */
2747 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2748 (Ustrcmp(coded, sub[1]) == 0);
2751 #endif /* SUPPORT_CRYPTEQ */
2757 uschar *save_iterate_item = iterate_item;
2758 int (*compare)(const uschar *, const uschar *);
2760 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2763 if (cond_type == ECOND_INLISTI)
2766 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2768 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2769 if (compare(sub[0], iterate_item) == 0)
2774 iterate_item = save_iterate_item;
2777 } /* Switch for comparison conditions */
2779 *yield = tempcond == testfor;
2780 return s; /* End of comparison conditions */
2783 /* and/or: computes logical and/or of several conditions */
2787 subcondptr = (yield == NULL)? NULL : &tempcond;
2788 combined_cond = (cond_type == ECOND_AND);
2790 while (isspace(*s)) s++;
2791 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2795 while (isspace(*s)) s++;
2796 /* {-for-text-editors */
2797 if (*s == '}') break;
2798 if (*s != '{') /* }-for-text-editors */
2800 expand_string_message = string_sprintf("each subcondition "
2801 "inside an \"%s{...}\" condition must be in its own {}", name);
2805 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2807 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2808 expand_string_message, name);
2811 while (isspace(*s)) s++;
2813 /* {-for-text-editors */
2816 /* {-for-text-editors */
2817 expand_string_message = string_sprintf("missing } at end of condition "
2818 "inside \"%s\" group", name);
2824 if (cond_type == ECOND_AND)
2826 combined_cond &= tempcond;
2827 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2828 } /* evaluate any more */
2831 combined_cond |= tempcond;
2832 if (combined_cond) subcondptr = NULL; /* once true, don't */
2833 } /* evaluate any more */
2837 if (yield != NULL) *yield = (combined_cond == testfor);
2841 /* forall/forany: iterates a condition with different values */
2847 uschar *save_iterate_item = iterate_item;
2849 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2851 while (isspace(*s)) s++;
2852 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2853 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2854 if (sub[0] == NULL) return NULL;
2855 /* {-for-text-editors */
2856 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2858 while (isspace(*s)) s++;
2859 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2863 /* Call eval_condition once, with result discarded (as if scanning a
2864 "false" part). This allows us to find the end of the condition, because if
2865 the list it empty, we won't actually evaluate the condition for real. */
2867 if (!(s = eval_condition(sub[1], resetok, NULL)))
2869 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2870 expand_string_message, name);
2873 while (isspace(*s)) s++;
2875 /* {-for-text-editors */
2878 /* {-for-text-editors */
2879 expand_string_message = string_sprintf("missing } at end of condition "
2880 "inside \"%s\"", name);
2884 if (yield != NULL) *yield = !testfor;
2885 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2887 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2888 if (!eval_condition(sub[1], resetok, &tempcond))
2890 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2891 expand_string_message, name);
2892 iterate_item = save_iterate_item;
2895 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2896 tempcond? "true":"false");
2898 if (yield != NULL) *yield = (tempcond == testfor);
2899 if (tempcond == (cond_type == ECOND_FORANY)) break;
2902 iterate_item = save_iterate_item;
2907 /* The bool{} expansion condition maps a string to boolean.
2908 The values supported should match those supported by the ACL condition
2909 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2910 of true/false. Note that Router "condition" rules have a different
2911 interpretation, where general data can be used and only a few values
2913 Note that readconf.c boolean matching, for boolean configuration options,
2914 only matches true/yes/false/no.
2915 The bool_lax{} condition matches the Router logic, which is much more
2918 case ECOND_BOOL_LAX:
2924 BOOL boolvalue = FALSE;
2925 while (isspace(*s)) s++;
2926 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2927 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2928 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2930 case 1: expand_string_message = string_sprintf(
2931 "too few arguments or bracketing error for %s",
2935 case 3: return NULL;
2938 while (isspace(*t)) t++;
2942 /* trailing whitespace: seems like a good idea to ignore it too */
2944 while (isspace(*t2)) t2--;
2945 if (t2 != (t + len))
2952 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2953 /* logic for the lax case from expand_check_condition(), which also does
2954 expands, and the logic is both short and stable enough that there should
2955 be no maintenance burden from replicating it. */
2959 ? Ustrspn(t+1, "0123456789") == len-1
2960 : Ustrspn(t, "0123456789") == len)
2962 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2963 /* expand_check_condition only does a literal string "0" check */
2964 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2967 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2969 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2971 else if (cond_type == ECOND_BOOL_LAX)
2975 expand_string_message = string_sprintf("unrecognised boolean "
2979 if (yield != NULL) *yield = (boolvalue == testfor);
2983 /* Unknown condition */
2986 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2988 } /* End switch on condition type */
2990 /* Missing braces at start and end of data */
2992 COND_FAILED_CURLY_START:
2993 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2996 COND_FAILED_CURLY_END:
2997 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3001 /* A condition requires code that is not compiled */
3003 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3004 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3005 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3006 COND_FAILED_NOT_COMPILED:
3007 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3016 /*************************************************
3017 * Save numerical variables *
3018 *************************************************/
3020 /* This function is called from items such as "if" that want to preserve and
3021 restore the numbered variables.
3024 save_expand_string points to an array of pointers to set
3025 save_expand_nlength points to an array of ints for the lengths
3027 Returns: the value of expand max to save
3031 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3034 for (i = 0; i <= expand_nmax; i++)
3036 save_expand_nstring[i] = expand_nstring[i];
3037 save_expand_nlength[i] = expand_nlength[i];
3044 /*************************************************
3045 * Restore numerical variables *
3046 *************************************************/
3048 /* This function restored saved values of numerical strings.
3051 save_expand_nmax the number of strings to restore
3052 save_expand_string points to an array of pointers
3053 save_expand_nlength points to an array of ints
3059 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3060 int *save_expand_nlength)
3063 expand_nmax = save_expand_nmax;
3064 for (i = 0; i <= expand_nmax; i++)
3066 expand_nstring[i] = save_expand_nstring[i];
3067 expand_nlength[i] = save_expand_nlength[i];
3075 /*************************************************
3076 * Handle yes/no substrings *
3077 *************************************************/
3079 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3080 alternative substrings that depend on whether or not the condition was true,
3081 or the lookup or extraction succeeded. The substrings always have to be
3082 expanded, to check their syntax, but "skipping" is set when the result is not
3083 needed - this avoids unnecessary nested lookups.
3086 skipping TRUE if we were skipping when this item was reached
3087 yes TRUE if the first string is to be used, else use the second
3088 save_lookup a value to put back into lookup_value before the 2nd expansion
3089 sptr points to the input string pointer
3090 yieldptr points to the output string pointer
3091 sizeptr points to the output string size
3092 ptrptr points to the output string pointer
3093 type "lookup" or "if" or "extract" or "run", for error message
3094 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3097 Returns: 0 OK; lookup_value has been reset to save_lookup
3099 2 expansion failed because of bracketing error
3103 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
3104 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3107 uschar *s = *sptr; /* Local value */
3108 uschar *sub1, *sub2;
3110 /* If there are no following strings, we substitute the contents of $value for
3111 lookups and for extractions in the success case. For the ${if item, the string
3112 "true" is substituted. In the fail case, nothing is substituted for all three
3115 while (isspace(*s)) s++;
3120 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3124 if (yes && lookup_value != NULL)
3125 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3126 Ustrlen(lookup_value));
3127 lookup_value = save_lookup;
3133 /* The first following string must be braced. */
3135 if (*s++ != '{') goto FAILED_CURLY;
3137 /* Expand the first substring. Forced failures are noticed only if we actually
3138 want this string. Set skipping in the call in the fail case (this will always
3139 be the case if we were already skipping). */
3141 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3142 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3143 expand_string_forcedfail = FALSE;
3144 if (*s++ != '}') goto FAILED_CURLY;
3146 /* If we want the first string, add it to the output */
3149 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3151 /* If this is called from a lookup or an extract, we want to restore $value to
3152 what it was at the start of the item, so that it has this value during the
3153 second string expansion. For the call from "if" or "run" to this function,
3154 save_lookup is set to lookup_value, so that this statement does nothing. */
3156 lookup_value = save_lookup;
3158 /* There now follows either another substring, or "fail", or nothing. This
3159 time, forced failures are noticed only if we want the second string. We must
3160 set skipping in the nested call if we don't want this string, or if we were
3161 already skipping. */
3163 while (isspace(*s)) s++;
3166 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3167 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3168 expand_string_forcedfail = FALSE;
3169 if (*s++ != '}') goto FAILED_CURLY;
3171 /* If we want the second string, add it to the output */
3174 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3177 /* If there is no second string, but the word "fail" is present when the use of
3178 the second string is wanted, set a flag indicating it was a forced failure
3179 rather than a syntactic error. Swallow the terminating } in case this is nested
3180 inside another lookup or if or extract. */
3185 s = read_name(name, sizeof(name), s, US"_");
3186 if (Ustrcmp(name, "fail") == 0)
3188 if (!yes && !skipping)
3190 while (isspace(*s)) s++;
3191 if (*s++ != '}') goto FAILED_CURLY;
3192 expand_string_message =
3193 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3194 expand_string_forcedfail = TRUE;
3200 expand_string_message =
3201 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3206 /* All we have to do now is to check on the final closing brace. */
3208 while (isspace(*s)) s++;
3209 if (*s++ == '}') goto RETURN;
3211 /* Get here if there is a bracketing failure */
3216 /* Get here for other failures */
3221 /* Update the input pointer value before returning */
3231 /*************************************************
3232 * Handle MD5 or SHA-1 computation for HMAC *
3233 *************************************************/
3235 /* These are some wrapping functions that enable the HMAC code to be a bit
3236 cleaner. A good compiler will spot the tail recursion.
3239 type HMAC_MD5 or HMAC_SHA1
3240 remaining are as for the cryptographic hash functions
3246 chash_start(int type, void *base)
3248 if (type == HMAC_MD5)
3249 md5_start((md5 *)base);
3251 sha1_start((sha1 *)base);
3255 chash_mid(int type, void *base, uschar *string)
3257 if (type == HMAC_MD5)
3258 md5_mid((md5 *)base, string);
3260 sha1_mid((sha1 *)base, string);
3264 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3266 if (type == HMAC_MD5)
3267 md5_end((md5 *)base, string, length, digest);
3269 sha1_end((sha1 *)base, string, length, digest);
3276 /********************************************************
3277 * prvs: Get last three digits of days since Jan 1, 1970 *
3278 ********************************************************/
3280 /* This is needed to implement the "prvs" BATV reverse
3283 Argument: integer "days" offset to add or substract to
3284 or from the current number of days.
3286 Returns: pointer to string containing the last three
3287 digits of the number of days since Jan 1, 1970,
3288 modified by the offset argument, NULL if there
3289 was an error in the conversion.
3294 prvs_daystamp(int day_offset)
3296 uschar *days = store_get(32); /* Need at least 24 for cases */
3297 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3298 (time(NULL) + day_offset*86400)/86400);
3299 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3304 /********************************************************
3305 * prvs: perform HMAC-SHA1 computation of prvs bits *
3306 ********************************************************/
3308 /* This is needed to implement the "prvs" BATV reverse
3312 address RFC2821 Address to use
3313 key The key to use (must be less than 64 characters
3315 key_num Single-digit key number to use. Defaults to
3318 Returns: pointer to string containing the first three
3319 bytes of the final hash in hex format, NULL if
3320 there was an error in the process.
3324 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3326 uschar *hash_source, *p;
3327 int size = 0,offset = 0,i;
3329 void *use_base = &sha1_base;
3330 uschar innerhash[20];
3331 uschar finalhash[20];
3332 uschar innerkey[64];
3333 uschar outerkey[64];
3334 uschar *finalhash_hex = store_get(40);
3336 if (key_num == NULL)
3339 if (Ustrlen(key) > 64)
3342 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3343 string_cat(hash_source,&size,&offset,daystamp,3);
3344 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3345 hash_source[offset] = '\0';
3347 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3349 memset(innerkey, 0x36, 64);
3350 memset(outerkey, 0x5c, 64);
3352 for (i = 0; i < Ustrlen(key); i++)
3354 innerkey[i] ^= key[i];
3355 outerkey[i] ^= key[i];
3358 chash_start(HMAC_SHA1, use_base);
3359 chash_mid(HMAC_SHA1, use_base, innerkey);
3360 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3362 chash_start(HMAC_SHA1, use_base);
3363 chash_mid(HMAC_SHA1, use_base, outerkey);
3364 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3367 for (i = 0; i < 3; i++)
3369 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3370 *p++ = hex_digits[finalhash[i] & 0x0f];
3374 return finalhash_hex;
3380 /*************************************************
3381 * Join a file onto the output string *
3382 *************************************************/
3384 /* This is used for readfile and after a run expansion. It joins the contents
3385 of a file onto the output string, globally replacing newlines with a given
3386 string (optionally). The file is closed at the end.
3390 yield pointer to the expandable string
3391 sizep pointer to the current size
3392 ptrp pointer to the current position
3393 eol newline replacement string, or NULL
3395 Returns: new value of string pointer
3399 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3402 uschar buffer[1024];
3404 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3406 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3408 int len = Ustrlen(buffer);
3409 if (eol != NULL && buffer[len-1] == '\n') len--;
3410 yield = string_cat(yield, sizep, ptrp, buffer, len);
3411 if (buffer[len] != 0)
3412 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3415 if (yield != NULL) yield[*ptrp] = 0;
3423 /*************************************************
3424 * Evaluate numeric expression *
3425 *************************************************/
3427 /* This is a set of mutually recursive functions that evaluate an arithmetic
3428 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3429 these functions that is called from elsewhere is eval_expr, whose interface is:
3432 sptr pointer to the pointer to the string - gets updated
3433 decimal TRUE if numbers are to be assumed decimal
3434 error pointer to where to put an error message - must be NULL on input
3435 endket TRUE if ')' must terminate - FALSE for external call
3437 Returns: on success: the value of the expression, with *error still NULL
3438 on failure: an undefined value, with *error = a message
3441 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3444 static int_eximarith_t
3445 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3448 int_eximarith_t x = eval_op_or(&s, decimal, error);
3454 *error = US"expecting closing parenthesis";
3456 while (isspace(*(++s)));
3458 else if (*s != 0) *error = US"expecting operator";
3465 static int_eximarith_t
3466 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3471 while (isspace(*s)) s++;
3476 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3478 switch (tolower(*s))
3481 case 'k': n *= 1024; s++; break;
3482 case 'm': n *= 1024*1024; s++; break;
3483 case 'g': n *= 1024*1024*1024; s++; break;
3485 while (isspace (*s)) s++;
3490 n = eval_expr(&s, decimal, error, 1);
3494 *error = US"expecting number or opening parenthesis";
3502 static int_eximarith_t
3503 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3507 while (isspace(*s)) s++;
3508 if (*s == '+' || *s == '-' || *s == '~')
3511 x = eval_op_unary(&s, decimal, error);
3512 if (op == '-') x = -x;
3513 else if (op == '~') x = ~x;
3517 x = eval_number(&s, decimal, error);
3524 static int_eximarith_t
3525 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3528 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3531 while (*s == '*' || *s == '/' || *s == '%')
3534 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3535 if (*error != NULL) break;
3536 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3537 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3538 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3539 * -N*M is INT_MIN will yielf INT_MIN.
3540 * Since we don't support floating point, this is somewhat simpler.
3541 * Ideally, we'd return an error, but since we overflow for all other
3542 * arithmetic, consistency suggests otherwise, but what's the correct value
3543 * to use? There is none.
3544 * The C standard guarantees overflow for unsigned arithmetic but signed
3545 * overflow invokes undefined behaviour; in practice, this is overflow
3546 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3547 * that long/longlong larger than int are available, or we could just work
3548 * with larger types. We should consider whether to guarantee 32bit eval
3549 * and 64-bit working variables, with errors returned. For now ...
3550 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3551 * can just let the other invalid results occur otherwise, as they have
3552 * until now. For this one case, we can coerce.
3554 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3557 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3558 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3568 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3584 static int_eximarith_t
3585 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3588 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3591 while (*s == '+' || *s == '-')
3594 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3595 if (*error != NULL) break;
3596 if (op == '+') x += y; else x -= y;
3604 static int_eximarith_t
3605 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3608 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3611 while ((*s == '<' || *s == '>') && s[1] == s[0])
3616 y = eval_op_sum(&s, decimal, error);
3617 if (*error != NULL) break;
3618 if (op == '<') x <<= y; else x >>= y;
3626 static int_eximarith_t
3627 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3630 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3637 y = eval_op_shift(&s, decimal, error);
3638 if (*error != NULL) break;
3647 static int_eximarith_t
3648 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3651 int_eximarith_t x = eval_op_and(&s, decimal, error);
3658 y = eval_op_and(&s, decimal, error);
3659 if (*error != NULL) break;
3668 static int_eximarith_t
3669 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3672 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3679 y = eval_op_xor(&s, decimal, error);
3680 if (*error != NULL) break;
3690 /*************************************************
3692 *************************************************/
3694 /* Returns either an unchanged string, or the expanded string in stacking pool
3695 store. Interpreted sequences are:
3697 \... normal escaping rules
3698 $name substitutes the variable
3700 ${op:string} operates on the expanded string value
3701 ${item{arg1}{arg2}...} expands the args and then does the business
3702 some literal args are not enclosed in {}
3704 There are now far too many operators and item types to make it worth listing
3705 them here in detail any more.
3707 We use an internal routine recursively to handle embedded substrings. The
3708 external function follows. The yield is NULL if the expansion failed, and there
3709 are two cases: if something collapsed syntactically, or if "fail" was given
3710 as the action on a lookup failure. These can be distinguised by looking at the
3711 variable expand_string_forcedfail, which is TRUE in the latter case.
3713 The skipping flag is set true when expanding a substring that isn't actually
3714 going to be used (after "if" or "lookup") and it prevents lookups from
3715 happening lower down.
3717 Store usage: At start, a store block of the length of the input plus 64
3718 is obtained. This is expanded as necessary by string_cat(), which might have to
3719 get a new block, or might be able to expand the original. At the end of the
3720 function we can release any store above that portion of the yield block that
3721 was actually used. In many cases this will be optimal.
3723 However: if the first item in the expansion is a variable name or header name,
3724 we reset the store before processing it; if the result is in fresh store, we
3725 use that without copying. This is helpful for expanding strings like
3726 $message_headers which can get very long.
3728 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3729 since resetting the store at the end of the expansion will free store that was
3730 allocated by the plugin code as well as the slop after the expanded string. So
3731 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3732 and, given the acl condition, ${if }. This is an unfortunate consequence of
3733 string expansion becoming too powerful.
3736 string the string to be expanded
3737 ket_ends true if expansion is to stop at }
3738 left if not NULL, a pointer to the first character after the
3739 expansion is placed here (typically used with ket_ends)
3740 skipping TRUE for recursive calls when the value isn't actually going
3741 to be used (to allow for optimisation)
3742 honour_dollar TRUE if $ is to be expanded,
3743 FALSE if it's just another character
3744 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3747 Returns: NULL if expansion fails:
3748 expand_string_forcedfail is set TRUE if failure was forced
3749 expand_string_message contains a textual error message
3750 a pointer to the expanded string on success
3754 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3755 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3758 int size = Ustrlen(string)+ 64;
3760 uschar *yield = store_get(size);
3762 uschar *save_expand_nstring[EXPAND_MAXN+1];
3763 int save_expand_nlength[EXPAND_MAXN+1];
3764 BOOL resetok = TRUE;
3766 expand_string_forcedfail = FALSE;
3767 expand_string_message = US"";
3774 /* \ escapes the next character, which must exist, or else
3775 the expansion fails. There's a special escape, \N, which causes
3776 copying of the subject verbatim up to the next \N. Otherwise,
3777 the escapes are the standard set. */
3783 expand_string_message = US"\\ at end of string";
3790 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3791 yield = string_cat(yield, &size, &ptr, t, s - t);
3792 if (*s != 0) s += 2;
3798 ch[0] = string_interpret_escape(&s);
3800 yield = string_cat(yield, &size, &ptr, ch, 1);
3807 /* Anything other than $ is just copied verbatim, unless we are
3808 looking for a terminating } character. */
3811 if (ket_ends && *s == '}') break;
3813 if (*s != '$' || !honour_dollar)
3815 yield = string_cat(yield, &size, &ptr, s++, 1);
3819 /* No { after the $ - must be a plain name or a number for string
3820 match variable. There has to be a fudge for variables that are the
3821 names of header fields preceded by "$header_" because header field
3822 names can contain any printing characters except space and colon.
3823 For those that don't like typing this much, "$h_" is a synonym for
3824 "$header_". A non-existent header yields a NULL value; nothing is
3827 if (isalpha((*(++s))))
3832 s = read_name(name, sizeof(name), s, US"_");
3834 /* If this is the first thing to be expanded, release the pre-allocated
3837 if (ptr == 0 && yield != NULL)
3839 if (resetok) store_reset(yield);
3846 if (Ustrncmp(name, "h_", 2) == 0 ||
3847 Ustrncmp(name, "rh_", 3) == 0 ||
3848 Ustrncmp(name, "bh_", 3) == 0 ||
3849 Ustrncmp(name, "header_", 7) == 0 ||
3850 Ustrncmp(name, "rheader_", 8) == 0 ||
3851 Ustrncmp(name, "bheader_", 8) == 0)
3853 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3854 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3855 s = read_header_name(name, sizeof(name), s);
3856 value = find_header(name, FALSE, &newsize, want_raw, charset);
3858 /* If we didn't find the header, and the header contains a closing brace
3859 character, this may be a user error where the terminating colon
3860 has been omitted. Set a flag to adjust the error message in this case.
3861 But there is no error here - nothing gets inserted. */
3865 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3874 value = find_variable(name, FALSE, skipping, &newsize);
3877 expand_string_message =
3878 string_sprintf("unknown variable name \"%s\"", name);
3879 check_variable_error_message(name);
3884 /* If the data is known to be in a new buffer, newsize will be set to the
3885 size of that buffer. If this is the first thing in an expansion string,
3886 yield will be NULL; just point it at the new store instead of copying. Many
3887 expansion strings contain just one reference, so this is a useful
3888 optimization, especially for humungous headers. */
3890 len = Ustrlen(value);
3891 if (yield == NULL && newsize != 0)
3897 else yield = string_cat(yield, &size, &ptr, value, len);
3905 s = read_number(&n, s);
3906 if (n >= 0 && n <= expand_nmax)
3907 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3912 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3914 if (*s != '{') /*}*/
3916 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3920 /* After { there can be various things, but they all start with
3921 an initial word, except for a number for a string match variable. */
3923 if (isdigit((*(++s))))
3926 s = read_number(&n, s); /*{*/
3929 expand_string_message = US"} expected after number";
3932 if (n >= 0 && n <= expand_nmax)
3933 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3940 expand_string_message = US"letter or digit expected after ${"; /*}*/
3944 /* Allow "-" in names to cater for substrings with negative
3945 arguments. Since we are checking for known names after { this is
3948 s = read_name(name, sizeof(name), s, US"_-");
3949 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3953 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3954 If the ACL returns accept or reject we return content set by "message ="
3955 There is currently no limit on recursion; this would have us call
3956 acl_check_internal() directly and get a current level from somewhere.
3957 See also the acl expansion condition ECOND_ACL and the traditional
3958 acl modifier ACLC_ACL.
3959 Assume that the function has side-effects on the store that must be preserved.
3963 /* ${acl {name} {arg1}{arg2}...} */
3965 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
3968 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl", &resetok))
3970 case 1: goto EXPAND_FAILED_CURLY;
3972 case 3: goto EXPAND_FAILED;
3974 if (skipping) continue;
3977 switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
3982 debug_printf("acl expansion yield: %s\n", user_msg);
3984 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3988 expand_string_forcedfail = TRUE;
3990 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
3995 /* Handle conditionals - preserve the values of the numerical expansion
3996 variables in case they get changed by a regular expression match in the
3997 condition. If not, they retain their external settings. At the end
3998 of this "if" section, they get restored to their previous values. */
4004 int save_expand_nmax =
4005 save_expand_strings(save_expand_nstring, save_expand_nlength);
4007 while (isspace(*s)) s++;
4008 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
4009 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4012 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
4013 cond? "true" : "false");
4017 /* The handling of "yes" and "no" result strings is now in a separate
4018 function that is also used by ${lookup} and ${extract} and ${run}. */
4020 switch(process_yesno(
4021 skipping, /* were previously skipping */
4022 cond, /* success/failure indicator */
4023 lookup_value, /* value to reset for string2 */
4024 &s, /* input pointer */
4025 &yield, /* output pointer */
4026 &size, /* output size */
4027 &ptr, /* output current point */
4028 US"if", /* condition type */
4031 case 1: goto EXPAND_FAILED; /* when all is well, the */
4032 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4035 /* Restore external setting of expansion variables for continuation
4038 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4039 save_expand_nlength);
4043 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4044 expanding an internal string that isn't actually going to be used. All we
4045 need to do is check the syntax, so don't do a lookup at all. Preserve the
4046 values of the numerical expansion variables in case they get changed by a
4047 partial lookup. If not, they retain their external settings. At the end
4048 of this "lookup" section, they get restored to their previous values. */
4052 int stype, partial, affixlen, starflags;
4053 int expand_setup = 0;
4055 uschar *key, *filename, *affix;
4056 uschar *save_lookup_value = lookup_value;
4057 int save_expand_nmax =
4058 save_expand_strings(save_expand_nstring, save_expand_nlength);
4060 if ((expand_forbid & RDO_LOOKUP) != 0)
4062 expand_string_message = US"lookup expansions are not permitted";
4066 /* Get the key we are to look up for single-key+file style lookups.
4067 Otherwise set the key NULL pro-tem. */
4069 while (isspace(*s)) s++;
4070 if (*s == '{') /*}*/
4072 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4073 if (key == NULL) goto EXPAND_FAILED; /*{*/
4074 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4075 while (isspace(*s)) s++;
4079 /* Find out the type of database */
4083 expand_string_message = US"missing lookup type";
4087 /* The type is a string that may contain special characters of various
4088 kinds. Allow everything except space or { to appear; the actual content
4089 is checked by search_findtype_partial. */ /*}*/
4091 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4093 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4097 while (isspace(*s)) s++;
4099 /* Now check for the individual search type and any partial or default
4100 options. Only those types that are actually in the binary are valid. */
4102 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4106 expand_string_message = search_error_message;
4110 /* Check that a key was provided for those lookup types that need it,
4111 and was not supplied for those that use the query style. */
4113 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4117 expand_string_message = string_sprintf("missing {key} for single-"
4118 "key \"%s\" lookup", name);
4126 expand_string_message = string_sprintf("a single key was given for "
4127 "lookup type \"%s\", which is not a single-key lookup type", name);
4132 /* Get the next string in brackets and expand it. It is the file name for
4133 single-key+file lookups, and the whole query otherwise. In the case of
4134 queries that also require a file name (e.g. sqlite), the file name comes
4137 if (*s != '{') goto EXPAND_FAILED_CURLY;
4138 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4139 if (filename == NULL) goto EXPAND_FAILED;
4140 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4141 while (isspace(*s)) s++;
4143 /* If this isn't a single-key+file lookup, re-arrange the variables
4144 to be appropriate for the search_ functions. For query-style lookups,
4145 there is just a "key", and no file name. For the special query-style +
4146 file types, the query (i.e. "key") starts with a file name. */
4150 while (isspace(*filename)) filename++;
4153 if (mac_islookup(stype, lookup_querystyle))
4159 if (*filename != '/')
4161 expand_string_message = string_sprintf(
4162 "absolute file name expected for \"%s\" lookup", name);
4165 while (*key != 0 && !isspace(*key)) key++;
4166 if (*key != 0) *key++ = 0;
4170 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4171 the entry was not found. Note that there is no search_close() function.
4172 Files are left open in case of re-use. At suitable places in higher logic,
4173 search_tidyup() is called to tidy all open files. This can save opening
4174 the same file several times. However, files may also get closed when
4175 others are opened, if too many are open at once. The rule is that a
4176 handle should not be used after a second search_open().
4178 Request that a partial search sets up $1 and maybe $2 by passing
4179 expand_setup containing zero. If its value changes, reset expand_nmax,
4180 since new variables will have been set. Note that at the end of this
4181 "lookup" section, the old numeric variables are restored. */
4184 lookup_value = NULL;
4187 void *handle = search_open(filename, stype, 0, NULL, NULL);
4190 expand_string_message = search_error_message;
4193 lookup_value = search_find(handle, filename, key, partial, affix,
4194 affixlen, starflags, &expand_setup);
4195 if (search_find_defer)
4197 expand_string_message =
4198 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4199 string_printing2(key, FALSE), search_error_message);
4202 if (expand_setup > 0) expand_nmax = expand_setup;
4205 /* The handling of "yes" and "no" result strings is now in a separate
4206 function that is also used by ${if} and ${extract}. */
4208 switch(process_yesno(
4209 skipping, /* were previously skipping */
4210 lookup_value != NULL, /* success/failure indicator */
4211 save_lookup_value, /* value to reset for string2 */
4212 &s, /* input pointer */
4213 &yield, /* output pointer */
4214 &size, /* output size */
4215 &ptr, /* output current point */
4216 US"lookup", /* condition type */
4219 case 1: goto EXPAND_FAILED; /* when all is well, the */
4220 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4223 /* Restore external setting of expansion variables for carrying on
4224 at this level, and continue. */
4226 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4227 save_expand_nlength);
4231 /* If Perl support is configured, handle calling embedded perl subroutines,
4232 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4233 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4234 arguments (defined below). */
4236 #define EXIM_PERL_MAX_ARGS 8
4240 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4241 "is not included in this binary";
4244 #else /* EXIM_PERL */
4246 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4249 if ((expand_forbid & RDO_PERL) != 0)
4251 expand_string_message = US"Perl calls are not permitted";
4255 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4256 US"perl", &resetok))
4258 case 1: goto EXPAND_FAILED_CURLY;
4260 case 3: goto EXPAND_FAILED;
4263 /* If skipping, we don't actually do anything */
4265 if (skipping) continue;
4267 /* Start the interpreter if necessary */
4269 if (!opt_perl_started)
4272 if (opt_perl_startup == NULL)
4274 expand_string_message = US"A setting of perl_startup is needed when "
4275 "using the Perl interpreter";
4278 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4279 initerror = init_perl(opt_perl_startup);
4280 if (initerror != NULL)
4282 expand_string_message =
4283 string_sprintf("error in perl_startup code: %s\n", initerror);
4286 opt_perl_started = TRUE;
4289 /* Call the function */
4291 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4292 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4293 sub_arg[0], sub_arg + 1);
4295 /* NULL yield indicates failure; if the message pointer has been set to
4296 NULL, the yield was undef, indicating a forced failure. Otherwise the
4297 message will indicate some kind of Perl error. */
4299 if (new_yield == NULL)
4301 if (expand_string_message == NULL)
4303 expand_string_message =
4304 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4305 "failure", sub_arg[0]);
4306 expand_string_forcedfail = TRUE;
4311 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4312 set during a callback from Perl. */
4314 expand_string_forcedfail = FALSE;
4318 #endif /* EXIM_PERL */
4320 /* Transform email address to "prvs" scheme to use
4321 as BATV-signed return path */
4328 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4330 case 1: goto EXPAND_FAILED_CURLY;
4332 case 3: goto EXPAND_FAILED;
4335 /* If skipping, we don't actually do anything */
4336 if (skipping) continue;
4338 /* sub_arg[0] is the address */
4339 domain = Ustrrchr(sub_arg[0],'@');
4340 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4342 expand_string_message = US"prvs first argument must be a qualified email address";
4346 /* Calculate the hash. The second argument must be a single-digit
4347 key number, or unset. */
4349 if (sub_arg[2] != NULL &&
4350 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4352 expand_string_message = US"prvs second argument must be a single digit";
4356 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4359 expand_string_message = US"prvs hmac-sha1 conversion failed";
4363 /* Now separate the domain from the local part */
4366 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4367 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4368 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4369 string_cat(yield,&size,&ptr,p,6);
4370 string_cat(yield,&size,&ptr,US"=",1);
4371 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4372 string_cat(yield,&size,&ptr,US"@",1);
4373 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4378 /* Check a prvs-encoded address for validity */
4380 case EITEM_PRVSCHECK:
4383 int mysize = 0, myptr = 0;
4387 /* TF: Ugliness: We want to expand parameter 1 first, then set
4388 up expansion variables that are used in the expansion of
4389 parameter 2. So we clone the string for the first
4390 expansion, where we only expand parameter 1.
4392 PH: Actually, that isn't necessary. The read_subs() function is
4393 designed to work this way for the ${if and ${lookup expansions. I've
4397 /* Reset expansion variables */
4398 prvscheck_result = NULL;
4399 prvscheck_address = NULL;
4400 prvscheck_keynum = NULL;
4402 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4404 case 1: goto EXPAND_FAILED_CURLY;
4406 case 3: goto EXPAND_FAILED;
4409 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4412 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4414 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4415 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4416 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4417 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4418 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4420 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4421 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4422 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4423 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4424 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4426 /* Set up expansion variables */
4427 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4428 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4429 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4430 prvscheck_address[myptr] = '\0';
4431 prvscheck_keynum = string_copy(key_num);
4433 /* Now expand the second argument */
4434 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4436 case 1: goto EXPAND_FAILED_CURLY;
4438 case 3: goto EXPAND_FAILED;
4441 /* Now we have the key and can check the address. */
4443 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4448 expand_string_message = US"hmac-sha1 conversion failed";
4452 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4453 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4455 if (Ustrcmp(p,hash) == 0)
4457 /* Success, valid BATV address. Now check the expiry date. */
4458 uschar *now = prvs_daystamp(0);
4459 unsigned int inow = 0,iexpire = 1;
4461 (void)sscanf(CS now,"%u",&inow);
4462 (void)sscanf(CS daystamp,"%u",&iexpire);
4464 /* When "iexpire" is < 7, a "flip" has occured.
4465 Adjust "inow" accordingly. */
4466 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4468 if (iexpire >= inow)
4470 prvscheck_result = US"1";
4471 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4475 prvscheck_result = NULL;
4476 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4481 prvscheck_result = NULL;
4482 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4485 /* Now expand the final argument. We leave this till now so that
4486 it can include $prvscheck_result. */
4488 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4490 case 1: goto EXPAND_FAILED_CURLY;
4492 case 3: goto EXPAND_FAILED;
4495 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4496 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4498 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4500 /* Reset the "internal" variables afterwards, because they are in
4501 dynamic store that will be reclaimed if the expansion succeeded. */
4503 prvscheck_address = NULL;
4504 prvscheck_keynum = NULL;
4508 /* Does not look like a prvs encoded address, return the empty string.
4509 We need to make sure all subs are expanded first, so as to skip over
4512 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4514 case 1: goto EXPAND_FAILED_CURLY;
4516 case 3: goto EXPAND_FAILED;
4523 /* Handle "readfile" to insert an entire file */
4525 case EITEM_READFILE:
4530 if ((expand_forbid & RDO_READFILE) != 0)
4532 expand_string_message = US"file insertions are not permitted";
4536 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4538 case 1: goto EXPAND_FAILED_CURLY;
4540 case 3: goto EXPAND_FAILED;
4543 /* If skipping, we don't actually do anything */
4545 if (skipping) continue;
4547 /* Open the file and read it */
4549 f = Ufopen(sub_arg[0], "rb");
4552 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4556 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4561 /* Handle "readsocket" to insert data from a Unix domain socket */
4563 case EITEM_READSOCK:
4569 struct sockaddr_un sockun; /* don't call this "sun" ! */
4573 if ((expand_forbid & RDO_READSOCK) != 0)
4575 expand_string_message = US"socket insertions are not permitted";
4579 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4580 because there may be a string for expansion on failure. */
4582 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4584 case 1: goto EXPAND_FAILED_CURLY;
4585 case 2: /* Won't occur: no end check */
4586 case 3: goto EXPAND_FAILED;
4589 /* Sort out timeout, if given */
4591 if (sub_arg[2] != NULL)
4593 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4596 expand_string_message = string_sprintf("bad time value %s",
4601 else sub_arg[3] = NULL; /* No eol if no timeout */
4603 /* If skipping, we don't actually do anything. Otherwise, arrange to
4604 connect to either an IP or a Unix socket. */
4608 /* Handle an IP (internet) domain */
4610 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4613 uschar *server_name = sub_arg[0] + 5;
4614 uschar *port_name = Ustrrchr(server_name, ':');
4616 /* Sort out the port */
4618 if (port_name == NULL)
4620 expand_string_message =
4621 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4624 *port_name++ = 0; /* Terminate server name */
4626 if (isdigit(*port_name))
4629 port = Ustrtol(port_name, &end, 0);
4630 if (end != port_name + Ustrlen(port_name))
4632 expand_string_message =
4633 string_sprintf("invalid port number %s", port_name);
4639 struct servent *service_info = getservbyname(CS port_name, "tcp");
4640 if (service_info == NULL)
4642 expand_string_message = string_sprintf("unknown port \"%s\"",
4646 port = ntohs(service_info->s_port);
4649 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4650 timeout, NULL, &expand_string_message)) < 0)
4654 /* Handle a Unix domain socket */
4659 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4661 expand_string_message = string_sprintf("failed to create socket: %s",
4666 sockun.sun_family = AF_UNIX;
4667 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4670 sigalrm_seen = FALSE;
4672 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4676 expand_string_message = US "socket connect timed out";
4681 expand_string_message = string_sprintf("failed to connect to socket "
4682 "%s: %s", sub_arg[0], strerror(errno));
4687 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4689 /* Allow sequencing of test actions */
4690 if (running_in_test_harness) millisleep(100);
4692 /* Write the request string, if not empty */
4694 if (sub_arg[1][0] != 0)
4696 int len = Ustrlen(sub_arg[1]);
4697 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4699 if (write(fd, sub_arg[1], len) != len)
4701 expand_string_message = string_sprintf("request write to socket "
4702 "failed: %s", strerror(errno));
4707 /* Shut down the sending side of the socket. This helps some servers to
4708 recognise that it is their turn to do some work. Just in case some
4709 system doesn't have this function, make it conditional. */
4712 shutdown(fd, SHUT_WR);
4715 if (running_in_test_harness) millisleep(100);
4717 /* Now we need to read from the socket, under a timeout. The function
4718 that reads a file can be used. */
4720 f = fdopen(fd, "rb");
4721 sigalrm_seen = FALSE;
4723 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4727 /* After a timeout, we restore the pointer in the result, that is,
4728 make sure we add nothing from the socket. */
4733 expand_string_message = US "socket read timed out";
4738 /* The whole thing has worked (or we were skipping). If there is a
4739 failure string following, we need to skip it. */
4743 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4745 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4746 while (isspace(*s)) s++;
4748 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4751 /* Come here on failure to create socket, connect socket, write to the
4752 socket, or timeout on reading. If another substring follows, expand and
4753 use it. Otherwise, those conditions give expand errors. */
4756 if (*s != '{') goto EXPAND_FAILED;
4757 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4758 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4759 if (arg == NULL) goto EXPAND_FAILED;
4760 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4761 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4762 while (isspace(*s)) s++;
4763 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4767 /* Handle "run" to execute a program. */
4779 if ((expand_forbid & RDO_RUN) != 0)
4781 expand_string_message = US"running a command is not permitted";
4785 while (isspace(*s)) s++;
4786 if (*s != '{') goto EXPAND_FAILED_CURLY;
4787 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4788 if (arg == NULL) goto EXPAND_FAILED;
4789 while (isspace(*s)) s++;
4790 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4792 if (skipping) /* Just pretend it worked when we're skipping */
4798 if (!transport_set_up_command(&argv, /* anchor for arg list */
4799 arg, /* raw command */
4800 FALSE, /* don't expand the arguments */
4801 0, /* not relevant when... */
4802 NULL, /* no transporting address */
4803 US"${run} expansion", /* for error messages */
4804 &expand_string_message)) /* where to put error message */
4809 /* Create the child process, making it a group leader. */
4811 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4815 expand_string_message =
4816 string_sprintf("couldn't create child process: %s", strerror(errno));
4820 /* Nothing is written to the standard input. */
4824 /* Read the pipe to get the command's output into $value (which is kept
4825 in lookup_value). Read during execution, so that if the output exceeds
4826 the OS pipe buffer limit, we don't block forever. */
4828 f = fdopen(fd_out, "rb");
4829 sigalrm_seen = FALSE;
4831 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4835 /* Wait for the process to finish, applying the timeout, and inspect its
4836 return code for serious disasters. Simple non-zero returns are passed on.
4839 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4841 if (sigalrm_seen == TRUE || runrc == -256)
4843 expand_string_message = string_sprintf("command timed out");
4844 killpg(pid, SIGKILL); /* Kill the whole process group */
4847 else if (runrc == -257)
4848 expand_string_message = string_sprintf("wait() failed: %s",
4852 expand_string_message = string_sprintf("command killed by signal %d",
4859 /* Process the yes/no strings; $value may be useful in both cases */
4861 switch(process_yesno(
4862 skipping, /* were previously skipping */
4863 runrc == 0, /* success/failure indicator */
4864 lookup_value, /* value to reset for string2 */
4865 &s, /* input pointer */
4866 &yield, /* output pointer */
4867 &size, /* output size */
4868 &ptr, /* output current point */
4869 US"run", /* condition type */
4872 case 1: goto EXPAND_FAILED; /* when all is well, the */
4873 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4879 /* Handle character translation for "tr" */
4887 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4889 case 1: goto EXPAND_FAILED_CURLY;
4891 case 3: goto EXPAND_FAILED;
4894 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4895 o2m = Ustrlen(sub[2]) - 1;
4897 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4899 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4903 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4910 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4911 expanded arguments. */
4921 int val[2] = { 0, -1 };
4924 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4925 Ensure that sub[2] is set in the ${length } case. */
4928 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4929 TRUE, name, &resetok))
4931 case 1: goto EXPAND_FAILED_CURLY;
4933 case 3: goto EXPAND_FAILED;
4936 /* Juggle the arguments if there are only two of them: always move the
4937 string to the last position and make ${length{n}{str}} equivalent to
4938 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4944 if (item_type == EITEM_LENGTH)
4951 for (i = 0; i < 2; i++)
4953 if (sub[i] == NULL) continue;
4954 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4955 if (*ret != 0 || (i != 0 && val[i] < 0))
4957 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4958 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4964 (item_type == EITEM_HASH)?
4965 compute_hash(sub[2], val[0], val[1], &len) :
4966 (item_type == EITEM_NHASH)?
4967 compute_nhash(sub[2], val[0], val[1], &len) :
4968 extract_substr(sub[2], val[0], val[1], &len);
4970 if (ret == NULL) goto EXPAND_FAILED;
4971 yield = string_cat(yield, &size, &ptr, ret, len);
4975 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4976 This code originally contributed by Steve Haslam. It currently supports
4977 the use of MD5 and SHA-1 hashes.
4979 We need some workspace that is large enough to handle all the supported
4980 hash types. Use macros to set the sizes rather than be too elaborate. */
4982 #define MAX_HASHLEN 20
4983 #define MAX_HASHBLOCKLEN 64
4992 int hashlen; /* Number of octets for the hash algorithm's output */
4993 int hashblocklen; /* Number of octets the hash algorithm processes */
4995 unsigned int keylen;
4997 uschar keyhash[MAX_HASHLEN];
4998 uschar innerhash[MAX_HASHLEN];
4999 uschar finalhash[MAX_HASHLEN];
5000 uschar finalhash_hex[2*MAX_HASHLEN];
5001 uschar innerkey[MAX_HASHBLOCKLEN];
5002 uschar outerkey[MAX_HASHBLOCKLEN];
5004 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5006 case 1: goto EXPAND_FAILED_CURLY;
5008 case 3: goto EXPAND_FAILED;
5011 if (Ustrcmp(sub[0], "md5") == 0)
5014 use_base = &md5_base;
5018 else if (Ustrcmp(sub[0], "sha1") == 0)
5021 use_base = &sha1_base;
5027 expand_string_message =
5028 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5033 keylen = Ustrlen(keyptr);
5035 /* If the key is longer than the hash block length, then hash the key
5038 if (keylen > hashblocklen)
5040 chash_start(type, use_base);
5041 chash_end(type, use_base, keyptr, keylen, keyhash);
5046 /* Now make the inner and outer key values */
5048 memset(innerkey, 0x36, hashblocklen);
5049 memset(outerkey, 0x5c, hashblocklen);
5051 for (i = 0; i < keylen; i++)
5053 innerkey[i] ^= keyptr[i];
5054 outerkey[i] ^= keyptr[i];
5057 /* Now do the hashes */
5059 chash_start(type, use_base);
5060 chash_mid(type, use_base, innerkey);
5061 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5063 chash_start(type, use_base);
5064 chash_mid(type, use_base, outerkey);
5065 chash_end(type, use_base, innerhash, hashlen, finalhash);
5067 /* Encode the final hash as a hex string */
5070 for (i = 0; i < hashlen; i++)
5072 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5073 *p++ = hex_digits[finalhash[i] & 0x0f];
5076 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5077 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5079 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5084 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5085 We have to save the numerical variables and restore them afterwards. */
5090 int moffset, moffsetextra, slen;
5093 const uschar *rerror;
5096 int save_expand_nmax =
5097 save_expand_strings(save_expand_nstring, save_expand_nlength);
5099 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5101 case 1: goto EXPAND_FAILED_CURLY;
5103 case 3: goto EXPAND_FAILED;
5106 /* Compile the regular expression */
5108 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5113 expand_string_message = string_sprintf("regular expression error in "
5114 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5118 /* Now run a loop to do the substitutions as often as necessary. It ends
5119 when there are no more matches. Take care over matches of the null string;
5120 do the same thing as Perl does. */
5123 slen = Ustrlen(sub[0]);
5124 moffset = moffsetextra = 0;
5129 int ovector[3*(EXPAND_MAXN+1)];
5130 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5131 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
5135 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5136 is not necessarily the end. We want to repeat the match from one
5137 character further along, but leaving the basic offset the same (for
5138 copying below). We can't be at the end of the string - that was checked
5139 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5140 finished; copy the remaining string and end the loop. */
5150 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5154 /* Match - set up for expanding the replacement. */
5156 if (n == 0) n = EXPAND_MAXN + 1;
5158 for (nn = 0; nn < n*2; nn += 2)
5160 expand_nstring[expand_nmax] = subject + ovector[nn];
5161 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5165 /* Copy the characters before the match, plus the expanded insertion. */
5167 yield = string_cat(yield, &size, &ptr, subject + moffset,
5168 ovector[0] - moffset);
5169 insert = expand_string(sub[2]);
5170 if (insert == NULL) goto EXPAND_FAILED;
5171 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5173 moffset = ovector[1];
5177 /* If we have matched an empty string, first check to see if we are at
5178 the end of the subject. If so, the loop is over. Otherwise, mimic
5179 what Perl's /g options does. This turns out to be rather cunning. First
5180 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5181 string at the same point. If this fails (picked up above) we advance to
5182 the next character. */
5184 if (ovector[0] == ovector[1])
5186 if (ovector[0] == slen) break;
5187 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5191 /* All done - restore numerical variables. */
5193 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5194 save_expand_nlength);
5198 /* Handle keyed and numbered substring extraction. If the first argument
5199 consists entirely of digits, then a numerical extraction is assumed. */
5205 int field_number = 1;
5206 BOOL field_number_set = FALSE;
5207 uschar *save_lookup_value = lookup_value;
5209 int save_expand_nmax =
5210 save_expand_strings(save_expand_nstring, save_expand_nlength);
5212 /* Read the arguments */
5214 for (i = 0; i < j; i++)
5216 while (isspace(*s)) s++;
5217 if (*s == '{') /*}*/
5219 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5220 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5221 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5223 /* After removal of leading and trailing white space, the first
5224 argument must not be empty; if it consists entirely of digits
5225 (optionally preceded by a minus sign), this is a numerical
5226 extraction, and we expect 3 arguments. */
5234 while (isspace(*p)) p++;
5238 while (len > 0 && isspace(p[len-1])) len--;
5245 expand_string_message = US"first argument of \"extract\" must "
5255 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5259 j = 3; /* Need 3 args */
5260 field_number_set = TRUE;
5265 else goto EXPAND_FAILED_CURLY;
5268 /* Extract either the numbered or the keyed substring into $value. If
5269 skipping, just pretend the extraction failed. */
5271 lookup_value = skipping? NULL : field_number_set?
5272 expand_gettokened(field_number, sub[1], sub[2]) :
5273 expand_getkeyed(sub[0], sub[1]);
5275 /* If no string follows, $value gets substituted; otherwise there can
5276 be yes/no strings, as for lookup or if. */
5278 switch(process_yesno(
5279 skipping, /* were previously skipping */
5280 lookup_value != NULL, /* success/failure indicator */
5281 save_lookup_value, /* value to reset for string2 */
5282 &s, /* input pointer */
5283 &yield, /* output pointer */
5284 &size, /* output size */
5285 &ptr, /* output current point */
5286 US"extract", /* condition type */
5289 case 1: goto EXPAND_FAILED; /* when all is well, the */
5290 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5293 /* All done - restore numerical variables. */
5295 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5296 save_expand_nlength);
5301 /* return the Nth item from a list */
5303 case EITEM_LISTEXTRACT:
5306 int field_number = 1;
5307 uschar *save_lookup_value = lookup_value;
5309 int save_expand_nmax =
5310 save_expand_strings(save_expand_nstring, save_expand_nlength);
5312 /* Read the field & list arguments */
5314 for (i = 0; i < 2; i++)
5316 while (isspace(*s)) s++;
5317 if (*s != '{') /*}*/
5318 goto EXPAND_FAILED_CURLY;
5320 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5321 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5322 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5324 /* After removal of leading and trailing white space, the first
5325 argument must be numeric and nonempty. */
5333 while (isspace(*p)) p++;
5337 while (len > 0 && isspace(p[len-1])) len--;
5340 if (!*p && !skipping)
5342 expand_string_message = US"first argument of \"listextract\" must "
5352 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5355 expand_string_message = US"first argument of \"listextract\" must "
5363 /* Extract the numbered element into $value. If
5364 skipping, just pretend the extraction failed. */
5366 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5368 /* If no string follows, $value gets substituted; otherwise there can
5369 be yes/no strings, as for lookup or if. */
5371 switch(process_yesno(
5372 skipping, /* were previously skipping */
5373 lookup_value != NULL, /* success/failure indicator */
5374 save_lookup_value, /* value to reset for string2 */
5375 &s, /* input pointer */
5376 &yield, /* output pointer */
5377 &size, /* output size */
5378 &ptr, /* output current point */
5379 US"extract", /* condition type */
5382 case 1: goto EXPAND_FAILED; /* when all is well, the */
5383 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5386 /* All done - restore numerical variables. */
5388 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5389 save_expand_nlength);
5395 case EITEM_CERTEXTRACT:
5397 uschar *save_lookup_value = lookup_value;
5399 int save_expand_nmax =
5400 save_expand_strings(save_expand_nstring, save_expand_nlength);
5402 /* Read the field argument */
5403 while (isspace(*s)) s++;
5404 if (*s != '{') /*}*/
5405 goto EXPAND_FAILED_CURLY;
5406 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5407 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5408 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5409 /* strip spaces fore & aft */
5414 while (isspace(*p)) p++;
5418 while (len > 0 && isspace(p[len-1])) len--;
5422 /* inspect the cert argument */
5423 while (isspace(*s)) s++;
5424 if (*s != '{') /*}*/
5425 goto EXPAND_FAILED_CURLY;
5428 expand_string_message = US"second argument of \"certextract\" must "
5429 "be a certificate variable";
5432 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5433 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5434 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5437 lookup_value = NULL;
5440 lookup_value = expand_getcertele(sub[0], sub[1]);
5441 if (*expand_string_message) goto EXPAND_FAILED;
5443 switch(process_yesno(
5444 skipping, /* were previously skipping */
5445 lookup_value != NULL, /* success/failure indicator */
5446 save_lookup_value, /* value to reset for string2 */
5447 &s, /* input pointer */
5448 &yield, /* output pointer */
5449 &size, /* output size */
5450 &ptr, /* output current point */
5451 US"extract", /* condition type */
5454 case 1: goto EXPAND_FAILED; /* when all is well, the */
5455 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5458 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5459 save_expand_nlength);
5462 #endif /*SUPPORT_TLS*/
5464 /* Handle list operations */
5472 uschar outsep[2] = { '\0', '\0' };
5473 uschar *list, *expr, *temp;
5474 uschar *save_iterate_item = iterate_item;
5475 uschar *save_lookup_value = lookup_value;
5477 while (isspace(*s)) s++;
5478 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5480 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5481 if (list == NULL) goto EXPAND_FAILED;
5482 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5484 if (item_type == EITEM_REDUCE)
5486 while (isspace(*s)) s++;
5487 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5488 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5489 if (temp == NULL) goto EXPAND_FAILED;
5490 lookup_value = temp;
5491 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5494 while (isspace(*s)) s++;
5495 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5499 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5500 if scanning a "false" part). This allows us to find the end of the
5501 condition, because if the list is empty, we won't actually evaluate the
5502 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5503 the normal internal expansion function. */
5505 if (item_type == EITEM_FILTER)
5507 temp = eval_condition(expr, &resetok, NULL);
5508 if (temp != NULL) s = temp;
5512 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5517 expand_string_message = string_sprintf("%s inside \"%s\" item",
5518 expand_string_message, name);
5522 while (isspace(*s)) s++;
5525 expand_string_message = string_sprintf("missing } at end of condition "
5526 "or expression inside \"%s\"", name);
5530 while (isspace(*s)) s++; /*{*/
5533 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5538 /* If we are skipping, we can now just move on to the next item. When
5539 processing for real, we perform the iteration. */
5541 if (skipping) continue;
5542 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5544 *outsep = (uschar)sep; /* Separator as a string */
5546 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5548 if (item_type == EITEM_FILTER)
5551 if (eval_condition(expr, &resetok, &condresult) == NULL)
5553 iterate_item = save_iterate_item;
5554 lookup_value = save_lookup_value;
5555 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5556 expand_string_message, name);
5559 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5560 condresult? "true":"false");
5562 temp = iterate_item; /* TRUE => include this item */
5564 continue; /* FALSE => skip this item */
5567 /* EITEM_MAP and EITEM_REDUCE */
5571 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5574 iterate_item = save_iterate_item;
5575 expand_string_message = string_sprintf("%s inside \"%s\" item",
5576 expand_string_message, name);
5579 if (item_type == EITEM_REDUCE)
5581 lookup_value = temp; /* Update the value of $value */
5582 continue; /* and continue the iteration */
5586 /* We reach here for FILTER if the condition is true, always for MAP,
5587 and never for REDUCE. The value in "temp" is to be added to the output
5588 list that is being created, ensuring that any occurrences of the
5589 separator character are doubled. Unless we are dealing with the first
5590 item of the output list, add in a space if the new item begins with the
5591 separator character, or is an empty string. */
5593 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5594 yield = string_cat(yield, &size, &ptr, US" ", 1);
5596 /* Add the string in "temp" to the output list that we are building,
5597 This is done in chunks by searching for the separator character. */
5601 size_t seglen = Ustrcspn(temp, outsep);
5602 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5604 /* If we got to the end of the string we output one character
5605 too many; backup and end the loop. Otherwise arrange to double the
5608 if (temp[seglen] == '\0') { ptr--; break; }
5609 yield = string_cat(yield, &size, &ptr, outsep, 1);
5613 /* Output a separator after the string: we will remove the redundant
5614 final one at the end. */
5616 yield = string_cat(yield, &size, &ptr, outsep, 1);
5617 } /* End of iteration over the list loop */
5619 /* REDUCE has generated no output above: output the final value of
5622 if (item_type == EITEM_REDUCE)
5624 yield = string_cat(yield, &size, &ptr, lookup_value,
5625 Ustrlen(lookup_value));
5626 lookup_value = save_lookup_value; /* Restore $value */
5629 /* FILTER and MAP generate lists: if they have generated anything, remove
5630 the redundant final separator. Even though an empty item at the end of a
5631 list does not count, this is tidier. */
5633 else if (ptr != save_ptr) ptr--;
5635 /* Restore preserved $item */
5637 iterate_item = save_iterate_item;
5644 uschar *srclist, *cmp, *xtract;
5646 uschar *dstlist = NULL;
5647 uschar *dstkeylist = NULL;
5649 uschar *save_iterate_item = iterate_item;
5651 while (isspace(*s)) s++;
5652 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5654 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5655 if (!srclist) goto EXPAND_FAILED;
5656 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5658 while (isspace(*s)) s++;
5659 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5661 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5662 if (!cmp) goto EXPAND_FAILED;
5663 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5665 while (isspace(*s)) s++;
5666 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5669 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5670 if (!tmp) goto EXPAND_FAILED;
5671 xtract = string_copyn(xtract, s - xtract);
5673 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5677 expand_string_message = US"missing } at end of \"sort\"";
5681 if (skipping) continue;
5683 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5686 uschar * newlist = NULL;
5687 uschar * newkeylist = NULL;
5690 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, srcitem);
5692 /* extract field for comparisons */
5693 iterate_item = srcitem;
5694 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5698 expand_string_message = string_sprintf(
5699 "field-extract in sort: \"%s\"", xtract);
5703 /* Insertion sort */
5705 /* copy output list until new-item < list-item */
5706 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5712 /* field for comparison */
5713 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5716 /* build and run condition string */
5717 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
5719 DEBUG(D_expand) debug_printf("%s: cond = \"%s\"\n", name, expr);
5720 if (!eval_condition(expr, &resetok, &before))
5722 expand_string_message = string_sprintf("comparison in sort: %s",
5729 /* New-item sorts before this dst-item. Append new-item,
5730 then dst-item, then remainder of dst list. */
5732 newlist = string_append_listele(newlist, sep, srcitem);
5733 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5736 newlist = string_append_listele(newlist, sep, dstitem);
5737 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5739 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5741 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5743 newlist = string_append_listele(newlist, sep, dstitem);
5744 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5750 newlist = string_append_listele(newlist, sep, dstitem);
5751 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5754 /* If we ran out of dstlist without consuming srcitem, append it */
5757 newlist = string_append_listele(newlist, sep, srcitem);
5758 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5762 dstkeylist = newkeylist;
5764 DEBUG(D_expand) debug_printf("%s: dstlist = \"%s\"\n", name, dstlist);
5765 DEBUG(D_expand) debug_printf("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
5769 yield = string_cat(yield, &size, &ptr, dstlist, Ustrlen(dstlist));
5771 /* Restore preserved $item */
5772 iterate_item = save_iterate_item;
5776 expand_string_message = US"Internal error in sort (list mismatch)";
5781 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5782 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5783 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5784 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5786 #define EXPAND_DLFUNC_MAX_ARGS 8
5789 #ifndef EXPAND_DLFUNC
5790 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5791 "is not included in this binary";
5794 #else /* EXPAND_DLFUNC */
5797 exim_dlfunc_t *func;
5800 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5802 if ((expand_forbid & RDO_DLFUNC) != 0)
5804 expand_string_message =
5805 US"dynamically-loaded functions are not permitted";
5809 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5810 TRUE, US"dlfunc", &resetok))
5812 case 1: goto EXPAND_FAILED_CURLY;
5814 case 3: goto EXPAND_FAILED;
5817 /* If skipping, we don't actually do anything */
5819 if (skipping) continue;
5821 /* Look up the dynamically loaded object handle in the tree. If it isn't
5822 found, dlopen() the file and put the handle in the tree for next time. */
5824 t = tree_search(dlobj_anchor, argv[0]);
5827 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5830 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5831 argv[0], dlerror());
5832 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5835 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5836 Ustrcpy(t->name, argv[0]);
5837 t->data.ptr = handle;
5838 (void)tree_insertnode(&dlobj_anchor, t);
5841 /* Having obtained the dynamically loaded object handle, look up the
5842 function pointer. */
5844 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5847 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5848 "%s", argv[1], argv[0], dlerror());
5849 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5853 /* Call the function and work out what to do with the result. If it
5854 returns OK, we have a replacement string; if it returns DEFER then
5855 expansion has failed in a non-forced manner; if it returns FAIL then
5856 failure was forced; if it returns ERROR or any other value there's a
5857 problem, so panic slightly. In any case, assume that the function has
5858 side-effects on the store that must be preserved. */
5862 for (argc = 0; argv[argc] != NULL; argc++);
5863 status = func(&result, argc - 2, &argv[2]);
5866 if (result == NULL) result = US"";
5867 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5872 expand_string_message = result == NULL ? US"(no message)" : result;
5873 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5874 else if(status != FAIL)
5875 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5876 argv[0], argv[1], status, expand_string_message);
5880 #endif /* EXPAND_DLFUNC */
5881 } /* EITEM_* switch */
5883 /* Control reaches here if the name is not recognized as one of the more
5884 complicated expansion items. Check for the "operator" syntax (name terminated
5885 by a colon). Some of the operators have arguments, separated by _ from the
5893 var_entry *vp = NULL;
5895 /* Owing to an historical mis-design, an underscore may be part of the
5896 operator name, or it may introduce arguments. We therefore first scan the
5897 table of names that contain underscores. If there is no match, we cut off
5898 the arguments and then scan the main table. */
5900 if ((c = chop_match(name, op_table_underscore,
5901 sizeof(op_table_underscore)/sizeof(uschar *))) < 0)
5903 arg = Ustrchr(name, '_');
5904 if (arg != NULL) *arg = 0;
5905 c = chop_match(name, op_table_main,
5906 sizeof(op_table_main)/sizeof(uschar *));
5907 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5908 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5911 /* Deal specially with operators that might take a certificate variable
5912 as we do not want to do the usual expansion. For most, expand the string.*/
5922 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
5924 if (!sub) goto EXPAND_FAILED; /*{*/
5925 if (*s1 != '}') goto EXPAND_FAILED_CURLY;
5926 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
5936 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5937 if (!sub) goto EXPAND_FAILED;
5942 /* If we are skipping, we don't need to perform the operation at all.
5943 This matters for operations like "mask", because the data may not be
5944 in the correct format when skipping. For example, the expression may test
5945 for the existence of $sender_host_address before trying to mask it. For
5946 other operations, doing them may not fail, but it is a waste of time. */
5948 if (skipping && c >= 0) continue;
5950 /* Otherwise, switch on the operator type */
5957 unsigned long int n = Ustrtoul(sub, &t, 10);
5960 expand_string_message = string_sprintf("argument for base62 "
5961 "operator is \"%s\", which is not a decimal number", sub);
5964 t = string_base62(n);
5965 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5969 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5975 unsigned long int n = 0;
5978 uschar *t = Ustrchr(base62_chars, *tt++);
5981 expand_string_message = string_sprintf("argument for base62d "
5982 "operator is \"%s\", which is not a base %d number", sub,
5986 n = n * BASE_62 + (t - base62_chars);
5988 (void)sprintf(CS buf, "%ld", n);
5989 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5995 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
5996 if (expanded == NULL)
5998 expand_string_message =
5999 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6000 expand_string_message);
6003 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
6010 uschar *t = sub - 1;
6011 while (*(++t) != 0) { *t = tolower(*t); count++; }
6012 yield = string_cat(yield, &size, &ptr, sub, count);
6019 uschar *t = sub - 1;
6020 while (*(++t) != 0) { *t = toupper(*t); count++; }
6021 yield = string_cat(yield, &size, &ptr, sub, count);
6027 if (vp && *(void **)vp->value)
6029 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6030 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6040 md5_end(&base, sub, Ustrlen(sub), digest);
6041 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6042 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6048 if (vp && *(void **)vp->value)
6050 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6051 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6061 sha1_end(&base, sub, Ustrlen(sub), digest);
6062 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6063 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6069 if (vp && *(void **)vp->value)
6071 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6072 yield = string_cat(yield, &size, &ptr, cp, (int)Ustrlen(cp));
6076 expand_string_message = US"sha256 only supported for certificates";
6079 /* Convert hex encoding to base64 encoding */
6089 for (enc = sub; *enc != 0; enc++)
6091 if (!isxdigit(*enc))
6093 expand_string_message = string_sprintf("\"%s\" is not a hex "
6102 expand_string_message = string_sprintf("\"%s\" contains an odd "
6103 "number of characters", sub);
6107 while ((c = *in++) != 0)
6109 if (isdigit(c)) c -= '0';
6110 else c = toupper(c) - 'A' + 10;
6122 enc = auth_b64encode(sub, out - sub);
6123 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
6127 /* Convert octets outside 0x21..0x7E to \xXX form */
6131 uschar *t = sub - 1;
6134 if (*t < 0x21 || 0x7E < *t)
6135 yield = string_cat(yield, &size, &ptr,
6136 string_sprintf("\\x%02x", *t), 4);
6138 yield = string_cat(yield, &size, &ptr, t, 1);
6143 /* count the number of list elements */
6152 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6153 cp = string_sprintf("%d", cnt);
6154 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6158 /* expand a named list given the name */
6159 /* handles nested named lists; requotes as colon-sep list */
6163 tree_node *t = NULL;
6167 uschar * suffix = US"";
6168 BOOL needsep = FALSE;
6171 if (*sub == '+') sub++;
6172 if (arg == NULL) /* no-argument version */
6174 if (!(t = tree_search(addresslist_anchor, sub)) &&
6175 !(t = tree_search(domainlist_anchor, sub)) &&
6176 !(t = tree_search(hostlist_anchor, sub)))
6177 t = tree_search(localpartlist_anchor, sub);
6179 else switch(*arg) /* specific list-type version */
6181 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6182 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6183 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6184 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6186 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6192 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6194 : *arg=='a'?"address "
6195 : *arg=='d'?"domain "
6197 : *arg=='l'?"localpart "
6202 list = ((namedlist_block *)(t->data.ptr))->string;
6204 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6206 uschar * buf = US" : ";
6208 yield = string_cat(yield, &size, &ptr, buf, 3);
6212 if (*item == '+') /* list item is itself a named list */
6214 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6215 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6217 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6221 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6222 while ((cp= strpbrk((const char *)item, tok)))
6224 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
6225 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6227 yield = string_cat(yield, &size, &ptr, US"::", 2);
6228 item = (uschar *)cp;
6230 else /* sep in item; should already be doubled; emit once */
6232 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
6233 if (*cp == sep) cp++;
6234 item = (uschar *)cp;
6238 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
6243 /* mask applies a mask to an IP address; for example the result of
6244 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6251 int mask, maskoffset;
6252 int type = string_is_ip_address(sub, &maskoffset);
6257 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6262 if (maskoffset == 0)
6264 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6269 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6271 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6273 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6278 /* Convert the address to binary integer(s) and apply the mask */
6280 sub[maskoffset] = 0;
6281 count = host_aton(sub, binary);
6282 host_mask(count, binary, mask);
6284 /* Convert to masked textual format and add to output. */
6286 yield = string_cat(yield, &size, &ptr, buffer,
6287 host_nmtoa(count, binary, mask, buffer, '.'));
6292 case EOP_LOCAL_PART:
6296 int start, end, domain;
6297 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6301 if (c != EOP_DOMAIN)
6303 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6304 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
6306 else if (domain != 0)
6309 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
6317 uschar outsep[2] = { ':', '\0' };
6318 uschar *address, *error;
6320 int start, end, domain; /* Not really used */
6322 while (isspace(*sub)) sub++;
6323 if (*sub == '>') { *outsep = *++sub; ++sub; }
6324 parse_allow_group = TRUE;
6328 uschar *p = parse_find_address_end(sub, FALSE);
6329 uschar saveend = *p;
6331 address = parse_extract_address(sub, &error, &start, &end, &domain,
6335 /* Add the address to the output list that we are building. This is
6336 done in chunks by searching for the separator character. At the
6337 start, unless we are dealing with the first address of the output
6338 list, add in a space if the new address begins with the separator
6339 character, or is an empty string. */
6341 if (address != NULL)
6343 if (ptr != save_ptr && address[0] == *outsep)
6344 yield = string_cat(yield, &size, &ptr, US" ", 1);
6348 size_t seglen = Ustrcspn(address, outsep);
6349 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
6351 /* If we got to the end of the string we output one character
6354 if (address[seglen] == '\0') { ptr--; break; }
6355 yield = string_cat(yield, &size, &ptr, outsep, 1);
6356 address += seglen + 1;
6359 /* Output a separator after the string: we will remove the
6360 redundant final one at the end. */
6362 yield = string_cat(yield, &size, &ptr, outsep, 1);
6365 if (saveend == '\0') break;
6369 /* If we have generated anything, remove the redundant final
6372 if (ptr != save_ptr) ptr--;
6373 parse_allow_group = FALSE;
6378 /* quote puts a string in quotes if it is empty or contains anything
6379 other than alphamerics, underscore, dot, or hyphen.
6381 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6382 be quoted in order to be a valid local part.
6384 In both cases, newlines and carriage returns are converted into \n and \r
6388 case EOP_QUOTE_LOCAL_PART:
6391 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6392 uschar *t = sub - 1;
6396 while (!needs_quote && *(++t) != 0)
6397 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6399 else /* EOP_QUOTE_LOCAL_PART */
6401 while (!needs_quote && *(++t) != 0)
6402 needs_quote = !isalnum(*t) &&
6403 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6404 (*t != '.' || t == sub || t[1] == 0);
6409 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6414 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6415 else if (*t == '\r')
6416 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6419 if (*t == '\\' || *t == '"')
6420 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6421 yield = string_cat(yield, &size, &ptr, t, 1);
6424 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6426 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6430 /* quote_lookuptype does lookup-specific quoting */
6435 uschar *opt = Ustrchr(arg, '_');
6437 if (opt != NULL) *opt++ = 0;
6439 n = search_findtype(arg, Ustrlen(arg));
6442 expand_string_message = search_error_message;
6446 if (lookup_list[n]->quote != NULL)
6447 sub = (lookup_list[n]->quote)(sub, opt);
6448 else if (opt != NULL) sub = NULL;
6452 expand_string_message = string_sprintf(
6453 "\"%s\" unrecognized after \"${quote_%s\"",
6458 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6462 /* rx quote sticks in \ before any non-alphameric character so that
6463 the insertion works in a regular expression. */
6467 uschar *t = sub - 1;
6471 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6472 yield = string_cat(yield, &size, &ptr, t, 1);
6477 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6478 prescribed by the RFC, if there are characters that need to be encoded */
6482 uschar buffer[2048];
6483 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6484 buffer, sizeof(buffer), FALSE);
6485 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6489 /* RFC 2047 decode */
6495 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6496 headers_charset, '?', &len, &error);
6499 expand_string_message = error;
6502 yield = string_cat(yield, &size, &ptr, decoded, len);
6506 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6516 if (c > 255) c = '_';
6518 yield = string_cat(yield, &size, &ptr, buff, 1);
6523 /* replace illegal UTF-8 sequences by replacement character */
6525 #define UTF8_REPLACEMENT_CHAR US"?"
6529 int seq_len = 0, index = 0;
6531 long codepoint = -1;
6532 uschar seq_buff[4]; /* accumulate utf-8 here */
6541 if ((c & 0xc0) != 0x80)
6543 /* wrong continuation byte; invalidate all bytes */
6544 complete = 1; /* error */
6548 codepoint = (codepoint << 6) | (c & 0x3f);
6549 seq_buff[index++] = c;
6550 if (--bytes_left == 0) /* codepoint complete */
6552 if(codepoint > 0x10FFFF) /* is it too large? */
6553 complete = -1; /* error (RFC3629 limit) */
6555 { /* finished; output utf-8 sequence */
6556 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6562 else /* no bytes left: new sequence */
6564 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6566 yield = string_cat(yield, &size, &ptr, &c, 1);
6569 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6571 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6576 codepoint = c & 0x1f;
6579 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6582 codepoint = c & 0x0f;
6584 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6587 codepoint = c & 0x07;
6589 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6592 seq_buff[index++] = c;
6593 seq_len = bytes_left + 1;
6594 } /* if(bytes_left) */
6598 bytes_left = index = 0;
6599 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6601 if ((complete == 1) && ((c & 0x80) == 0))
6602 { /* ASCII character follows incomplete sequence */
6603 yield = string_cat(yield, &size, &ptr, &c, 1);
6609 /* escape turns all non-printing characters into escape sequences. */
6613 uschar *t = string_printing(sub);
6614 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6618 /* Handle numeric expression evaluation */
6623 uschar *save_sub = sub;
6624 uschar *error = NULL;
6625 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6628 expand_string_message = string_sprintf("error in expression "
6629 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6633 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6634 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6638 /* Handle time period formating */
6642 int n = readconf_readtime(sub, 0, FALSE);
6645 expand_string_message = string_sprintf("string \"%s\" is not an "
6646 "Exim time interval in \"%s\" operator", sub, name);
6649 sprintf(CS var_buffer, "%d", n);
6650 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6654 case EOP_TIME_INTERVAL:
6657 uschar *t = read_number(&n, sub);
6658 if (*t != 0) /* Not A Number*/
6660 expand_string_message = string_sprintf("string \"%s\" is not a "
6661 "positive number in \"%s\" operator", sub, name);
6664 t = readconf_printtime(n);
6665 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6669 /* Convert string to base64 encoding */
6673 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6674 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6678 /* strlen returns the length of the string */
6683 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6684 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6688 /* length_n or l_n takes just the first n characters or the whole string,
6689 whichever is the shorter;
6691 substr_m_n, and s_m_n take n characters from offset m; negative m take
6692 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6693 takes the rest, either to the right or to the left.
6695 hash_n or h_n makes a hash of length n from the string, yielding n
6696 characters from the set a-z; hash_n_m makes a hash of length n, but
6697 uses m characters from the set a-zA-Z0-9.
6699 nhash_n returns a single number between 0 and n-1 (in text form), while
6700 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6701 between 0 and n-1 and the second between 0 and m-1. */
6721 expand_string_message = string_sprintf("missing values after %s",
6726 /* "length" has only one argument, effectively being synonymous with
6729 if (c == EOP_LENGTH || c == EOP_L)
6735 /* The others have one or two arguments; for "substr" the first may be
6736 negative. The second being negative means "not supplied". */
6741 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6744 /* Read up to two numbers, separated by underscores */
6749 if (arg != ret && *arg == '_' && pn == &value1)
6753 if (arg[1] != 0) arg++;
6755 else if (!isdigit(*arg))
6757 expand_string_message =
6758 string_sprintf("non-digit after underscore in \"%s\"", name);
6761 else *pn = (*pn)*10 + *arg++ - '0';
6765 /* Perform the required operation */
6768 (c == EOP_HASH || c == EOP_H)?
6769 compute_hash(sub, value1, value2, &len) :
6770 (c == EOP_NHASH || c == EOP_NH)?
6771 compute_nhash(sub, value1, value2, &len) :
6772 extract_substr(sub, value1, value2, &len);
6774 if (ret == NULL) goto EXPAND_FAILED;
6775 yield = string_cat(yield, &size, &ptr, ret, len);
6785 uschar **modetable[3];
6790 if ((expand_forbid & RDO_EXISTS) != 0)
6792 expand_string_message = US"Use of the stat() expansion is not permitted";
6796 if (stat(CS sub, &st) < 0)
6798 expand_string_message = string_sprintf("stat(%s) failed: %s",
6799 sub, strerror(errno));
6803 switch (mode & S_IFMT)
6805 case S_IFIFO: smode[0] = 'p'; break;
6806 case S_IFCHR: smode[0] = 'c'; break;
6807 case S_IFDIR: smode[0] = 'd'; break;
6808 case S_IFBLK: smode[0] = 'b'; break;
6809 case S_IFREG: smode[0] = '-'; break;
6810 default: smode[0] = '?'; break;
6813 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6814 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6815 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6817 for (i = 0; i < 3; i++)
6819 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6824 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6825 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6826 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6827 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6828 (long)st.st_gid, st.st_size, (long)st.st_atime,
6829 (long)st.st_mtime, (long)st.st_ctime);
6830 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6834 /* vaguely random number less than N */
6838 int_eximarith_t max;
6841 max = expanded_string_integer(sub, TRUE);
6842 if (expand_string_message != NULL)
6844 s = string_sprintf("%d", vaguely_random_number((int)max));
6845 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6849 /* Reverse IP, including IPv6 to dotted-nibble */
6851 case EOP_REVERSE_IP:
6853 int family, maskptr;
6854 uschar reversed[128];
6856 family = string_is_ip_address(sub, &maskptr);
6859 expand_string_message = string_sprintf(
6860 "reverse_ip() not given an IP address [%s]", sub);
6863 invert_address(reversed, sub);
6864 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6868 /* Unknown operator */
6871 expand_string_message =
6872 string_sprintf("unknown expansion operator \"%s\"", name);
6877 /* Handle a plain name. If this is the first thing in the expansion, release
6878 the pre-allocated buffer. If the result data is known to be in a new buffer,
6879 newsize will be set to the size of that buffer, and we can just point at that
6880 store instead of copying. Many expansion strings contain just one reference,
6881 so this is a useful optimization, especially for humungous headers
6882 ($message_headers). */
6890 if (resetok) store_reset(yield);
6894 value = find_variable(name, FALSE, skipping, &newsize);
6897 expand_string_message =
6898 string_sprintf("unknown variable in \"${%s}\"", name);
6899 check_variable_error_message(name);
6902 len = Ustrlen(value);
6903 if (yield == NULL && newsize != 0)
6909 else yield = string_cat(yield, &size, &ptr, value, len);
6913 /* Else there's something wrong */
6915 expand_string_message =
6916 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6917 "in a variable reference)", name);
6921 /* If we hit the end of the string when ket_ends is set, there is a missing
6922 terminating brace. */
6924 if (ket_ends && *s == 0)
6926 expand_string_message = malformed_header?
6927 US"missing } at end of string - could be header name not terminated by colon"
6929 US"missing } at end of string";
6933 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6934 added to the string. If so, set up an empty string. Add a terminating zero. If
6935 left != NULL, return a pointer to the terminator. */
6937 if (yield == NULL) yield = store_get(1);
6939 if (left != NULL) *left = s;
6941 /* Any stacking store that was used above the final string is no longer needed.
6942 In many cases the final string will be the first one that was got and so there
6943 will be optimal store usage. */
6945 if (resetok) store_reset(yield + ptr + 1);
6946 else if (resetok_p) *resetok_p = FALSE;
6950 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6952 if (skipping) debug_printf("skipping: result is not used\n");
6956 /* This is the failure exit: easiest to program with a goto. We still need
6957 to update the pointer to the terminator, for cases of nested calls with "fail".
6960 EXPAND_FAILED_CURLY:
6961 expand_string_message = malformed_header?
6962 US"missing or misplaced { or } - could be header name not terminated by colon"
6964 US"missing or misplaced { or }";
6966 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6967 that is a bad idea, because expand_string_message is in dynamic store. */
6970 if (left != NULL) *left = s;
6973 debug_printf("failed to expand: %s\n", string);
6974 debug_printf(" error message: %s\n", expand_string_message);
6975 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6977 if (resetok_p) *resetok_p = resetok;
6982 /* This is the external function call. Do a quick check for any expansion
6983 metacharacters, and if there are none, just return the input string.
6985 Argument: the string to be expanded
6986 Returns: the expanded string, or NULL if expansion failed; if failure was
6987 due to a lookup deferring, search_find_defer will be TRUE
6991 expand_string(uschar *string)
6993 search_find_defer = FALSE;
6994 malformed_header = FALSE;
6995 return (Ustrpbrk(string, "$\\") == NULL)? string :
6996 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7001 /*************************************************
7003 *************************************************/
7005 /* Now and again we want to expand a string and be sure that the result is in a
7006 new bit of store. This function does that.
7008 Argument: the string to be expanded
7009 Returns: the expanded string, always in a new bit of store, or NULL
7013 expand_string_copy(uschar *string)
7015 uschar *yield = expand_string(string);
7016 if (yield == string) yield = string_copy(string);
7022 /*************************************************
7023 * Expand and interpret as an integer *
7024 *************************************************/
7026 /* Expand a string, and convert the result into an integer.
7029 string the string to be expanded
7030 isplus TRUE if a non-negative number is expected
7032 Returns: the integer value, or
7033 -1 for an expansion error ) in both cases, message in
7034 -2 for an integer interpretation error ) expand_string_message
7035 expand_string_message is set NULL for an OK integer
7039 expand_string_integer(uschar *string, BOOL isplus)
7041 return expanded_string_integer(expand_string(string), isplus);
7045 /*************************************************
7046 * Interpret string as an integer *
7047 *************************************************/
7049 /* Convert a string (that has already been expanded) into an integer.
7051 This function is used inside the expansion code.
7054 s the string to be expanded
7055 isplus TRUE if a non-negative number is expected
7057 Returns: the integer value, or
7058 -1 if string is NULL (which implies an expansion error)
7059 -2 for an integer interpretation error
7060 expand_string_message is set NULL for an OK integer
7063 static int_eximarith_t
7064 expanded_string_integer(uschar *s, BOOL isplus)
7066 int_eximarith_t value;
7067 uschar *msg = US"invalid integer \"%s\"";
7070 /* If expansion failed, expand_string_message will be set. */
7072 if (s == NULL) return -1;
7074 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7075 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7076 systems, so we set it zero ourselves. */
7079 expand_string_message = NULL; /* Indicates no error */
7081 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7082 equal to 0. Unfortunately, people actually relied upon that, so preserve
7083 the behaviour explicitly. Stripping leading whitespace is a harmless
7084 noop change since strtol skips it anyway (provided that there is a number
7088 while (isspace(*s)) ++s;
7092 debug_printf("treating blank string as number 0\n");
7097 value = strtoll(CS s, CSS &endptr, 10);
7101 msg = US"integer expected but \"%s\" found";
7103 else if (value < 0 && isplus)
7105 msg = US"non-negative integer expected but \"%s\" found";
7109 switch (tolower(*endptr))
7114 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7119 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7120 else value *= 1024*1024;
7124 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7125 else value *= 1024*1024*1024;
7129 if (errno == ERANGE)
7130 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7133 while (isspace(*endptr)) endptr++;
7134 if (*endptr == 0) return value;
7138 expand_string_message = string_sprintf(CS msg, s);
7143 /* These values are usually fixed boolean values, but they are permitted to be
7147 addr address being routed
7148 mtype the module type
7149 mname the module name
7150 dbg_opt debug selectors
7151 oname the option name
7152 bvalue the router's boolean value
7153 svalue the router's string value
7154 rvalue where to put the returned value
7156 Returns: OK value placed in rvalue
7157 DEFER expansion failed
7161 exp_bool(address_item *addr,
7162 uschar *mtype, uschar *mname, unsigned dbg_opt,
7163 uschar *oname, BOOL bvalue,
7164 uschar *svalue, BOOL *rvalue)
7167 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7169 expanded = expand_string(svalue);
7170 if (expanded == NULL)
7172 if (expand_string_forcedfail)
7174 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7178 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7179 oname, mname, mtype, expand_string_message);
7180 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7184 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7187 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7189 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7193 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7194 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7204 /*************************************************
7205 **************************************************
7206 * Stand-alone test program *
7207 **************************************************
7208 *************************************************/
7214 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7216 int ovector[3*(EXPAND_MAXN+1)];
7217 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7218 ovector, sizeof(ovector)/sizeof(int));
7219 BOOL yield = n >= 0;
7220 if (n == 0) n = EXPAND_MAXN + 1;
7224 expand_nmax = (setup < 0)? 0 : setup + 1;
7225 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7227 expand_nstring[expand_nmax] = subject + ovector[nn];
7228 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7236 int main(int argc, uschar **argv)
7239 uschar buffer[1024];
7241 debug_selector = D_v;
7242 debug_file = stderr;
7243 debug_fd = fileno(debug_file);
7244 big_buffer = malloc(big_buffer_size);
7246 for (i = 1; i < argc; i++)
7248 if (argv[i][0] == '+')
7250 debug_trace_memory = 2;
7253 if (isdigit(argv[i][0]))
7254 debug_selector = Ustrtol(argv[i], NULL, 0);
7256 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7260 eldap_default_servers = argv[i];
7263 mysql_servers = argv[i];
7266 pgsql_servers = argv[i];
7268 #ifdef EXPERIMENTAL_REDIS
7269 redis_servers = argv[i];
7273 else opt_perl_startup = argv[i];
7277 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7279 expand_nstring[1] = US"string 1....";
7280 expand_nlength[1] = 8;
7284 if (opt_perl_startup != NULL)
7287 printf("Starting Perl interpreter\n");
7288 errstr = init_perl(opt_perl_startup);
7291 printf("** error in perl_startup code: %s\n", errstr);
7292 return EXIT_FAILURE;
7295 #endif /* EXIM_PERL */
7297 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7299 void *reset_point = store_get(0);
7300 uschar *yield = expand_string(buffer);
7303 printf("%s\n", yield);
7304 store_reset(reset_point);
7308 if (search_find_defer) printf("search_find deferred\n");
7309 printf("Failed: %s\n", expand_string_message);
7310 if (expand_string_forcedfail) printf("Forced failure\n");
7324 /* End of expand.c */