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 { "exim_version", vtype_stringptr, &version_string },
507 #ifdef WITH_OLD_DEMIME
508 { "found_extension", vtype_stringptr, &found_extension },
510 { "headers_added", vtype_string_func, &fn_hdrs_added },
511 { "home", vtype_stringptr, &deliver_home },
512 { "host", vtype_stringptr, &deliver_host },
513 { "host_address", vtype_stringptr, &deliver_host_address },
514 { "host_data", vtype_stringptr, &host_data },
515 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
516 { "host_lookup_failed", vtype_int, &host_lookup_failed },
517 { "host_port", vtype_int, &deliver_host_port },
518 { "inode", vtype_ino, &deliver_inode },
519 { "interface_address", vtype_stringptr, &interface_address },
520 { "interface_port", vtype_int, &interface_port },
521 { "item", vtype_stringptr, &iterate_item },
523 { "ldap_dn", vtype_stringptr, &eldap_dn },
525 { "load_average", vtype_load_avg, NULL },
526 { "local_part", vtype_stringptr, &deliver_localpart },
527 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
528 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
529 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
530 { "local_scan_data", vtype_stringptr, &local_scan_data },
531 { "local_user_gid", vtype_gid, &local_user_gid },
532 { "local_user_uid", vtype_uid, &local_user_uid },
533 { "localhost_number", vtype_int, &host_number },
534 { "log_inodes", vtype_pinodes, (void *)FALSE },
535 { "log_space", vtype_pspace, (void *)FALSE },
536 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
537 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
538 #ifdef WITH_CONTENT_SCAN
539 { "malware_name", vtype_stringptr, &malware_name },
541 { "max_received_linelength", vtype_int, &max_received_linelength },
542 { "message_age", vtype_int, &message_age },
543 { "message_body", vtype_msgbody, &message_body },
544 { "message_body_end", vtype_msgbody_end, &message_body_end },
545 { "message_body_size", vtype_int, &message_body_size },
546 { "message_exim_id", vtype_stringptr, &message_id },
547 { "message_headers", vtype_msgheaders, NULL },
548 { "message_headers_raw", vtype_msgheaders_raw, NULL },
549 { "message_id", vtype_stringptr, &message_id },
550 { "message_linecount", vtype_int, &message_linecount },
551 { "message_size", vtype_int, &message_size },
552 #ifdef WITH_CONTENT_SCAN
553 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
554 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
555 { "mime_boundary", vtype_stringptr, &mime_boundary },
556 { "mime_charset", vtype_stringptr, &mime_charset },
557 { "mime_content_description", vtype_stringptr, &mime_content_description },
558 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
559 { "mime_content_id", vtype_stringptr, &mime_content_id },
560 { "mime_content_size", vtype_int, &mime_content_size },
561 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
562 { "mime_content_type", vtype_stringptr, &mime_content_type },
563 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
564 { "mime_filename", vtype_stringptr, &mime_filename },
565 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
566 { "mime_is_multipart", vtype_int, &mime_is_multipart },
567 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
568 { "mime_part_count", vtype_int, &mime_part_count },
570 { "n0", vtype_filter_int, &filter_n[0] },
571 { "n1", vtype_filter_int, &filter_n[1] },
572 { "n2", vtype_filter_int, &filter_n[2] },
573 { "n3", vtype_filter_int, &filter_n[3] },
574 { "n4", vtype_filter_int, &filter_n[4] },
575 { "n5", vtype_filter_int, &filter_n[5] },
576 { "n6", vtype_filter_int, &filter_n[6] },
577 { "n7", vtype_filter_int, &filter_n[7] },
578 { "n8", vtype_filter_int, &filter_n[8] },
579 { "n9", vtype_filter_int, &filter_n[9] },
580 { "original_domain", vtype_stringptr, &deliver_domain_orig },
581 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
582 { "originator_gid", vtype_gid, &originator_gid },
583 { "originator_uid", vtype_uid, &originator_uid },
584 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
585 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
586 { "pid", vtype_pid, NULL },
587 { "primary_hostname", vtype_stringptr, &primary_hostname },
588 #ifdef EXPERIMENTAL_PROXY
589 { "proxy_host_address", vtype_stringptr, &proxy_host_address },
590 { "proxy_host_port", vtype_int, &proxy_host_port },
591 { "proxy_session", vtype_bool, &proxy_session },
592 { "proxy_target_address",vtype_stringptr, &proxy_target_address },
593 { "proxy_target_port", vtype_int, &proxy_target_port },
595 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
596 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
597 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
598 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
599 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
600 { "rcpt_count", vtype_int, &rcpt_count },
601 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
602 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
603 { "received_count", vtype_int, &received_count },
604 { "received_for", vtype_stringptr, &received_for },
605 { "received_ip_address", vtype_stringptr, &interface_address },
606 { "received_port", vtype_int, &interface_port },
607 { "received_protocol", vtype_stringptr, &received_protocol },
608 { "received_time", vtype_int, &received_time },
609 { "recipient_data", vtype_stringptr, &recipient_data },
610 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
611 { "recipients", vtype_string_func, &fn_recipients },
612 { "recipients_count", vtype_int, &recipients_count },
613 #ifdef WITH_CONTENT_SCAN
614 { "regex_match_string", vtype_stringptr, ®ex_match_string },
616 { "reply_address", vtype_reply, NULL },
617 { "return_path", vtype_stringptr, &return_path },
618 { "return_size_limit", vtype_int, &bounce_return_size_limit },
619 { "router_name", vtype_stringptr, &router_name },
620 { "runrc", vtype_int, &runrc },
621 { "self_hostname", vtype_stringptr, &self_hostname },
622 { "sender_address", vtype_stringptr, &sender_address },
623 { "sender_address_data", vtype_stringptr, &sender_address_data },
624 { "sender_address_domain", vtype_domain, &sender_address },
625 { "sender_address_local_part", vtype_localpart, &sender_address },
626 { "sender_data", vtype_stringptr, &sender_data },
627 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
628 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
629 { "sender_host_address", vtype_stringptr, &sender_host_address },
630 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
631 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
632 { "sender_host_name", vtype_host_lookup, NULL },
633 { "sender_host_port", vtype_int, &sender_host_port },
634 { "sender_ident", vtype_stringptr, &sender_ident },
635 { "sender_rate", vtype_stringptr, &sender_rate },
636 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
637 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
638 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
639 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
640 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
641 { "sending_port", vtype_int, &sending_port },
642 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
643 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
644 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
645 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
646 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
647 { "sn0", vtype_filter_int, &filter_sn[0] },
648 { "sn1", vtype_filter_int, &filter_sn[1] },
649 { "sn2", vtype_filter_int, &filter_sn[2] },
650 { "sn3", vtype_filter_int, &filter_sn[3] },
651 { "sn4", vtype_filter_int, &filter_sn[4] },
652 { "sn5", vtype_filter_int, &filter_sn[5] },
653 { "sn6", vtype_filter_int, &filter_sn[6] },
654 { "sn7", vtype_filter_int, &filter_sn[7] },
655 { "sn8", vtype_filter_int, &filter_sn[8] },
656 { "sn9", vtype_filter_int, &filter_sn[9] },
657 #ifdef WITH_CONTENT_SCAN
658 { "spam_action", vtype_stringptr, &spam_action },
659 { "spam_bar", vtype_stringptr, &spam_bar },
660 { "spam_report", vtype_stringptr, &spam_report },
661 { "spam_score", vtype_stringptr, &spam_score },
662 { "spam_score_int", vtype_stringptr, &spam_score_int },
664 #ifdef EXPERIMENTAL_SPF
665 { "spf_guess", vtype_stringptr, &spf_guess },
666 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
667 { "spf_received", vtype_stringptr, &spf_received },
668 { "spf_result", vtype_stringptr, &spf_result },
669 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
671 { "spool_directory", vtype_stringptr, &spool_directory },
672 { "spool_inodes", vtype_pinodes, (void *)TRUE },
673 { "spool_space", vtype_pspace, (void *)TRUE },
674 #ifdef EXPERIMENTAL_SRS
675 { "srs_db_address", vtype_stringptr, &srs_db_address },
676 { "srs_db_key", vtype_stringptr, &srs_db_key },
677 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
678 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
679 { "srs_recipient", vtype_stringptr, &srs_recipient },
680 { "srs_status", vtype_stringptr, &srs_status },
682 { "thisaddress", vtype_stringptr, &filter_thisaddress },
684 /* The non-(in,out) variables are now deprecated */
685 { "tls_bits", vtype_int, &tls_in.bits },
686 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
687 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
689 { "tls_in_bits", vtype_int, &tls_in.bits },
690 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
691 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
692 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
693 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
694 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
695 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
696 #if defined(SUPPORT_TLS)
697 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
699 { "tls_out_bits", vtype_int, &tls_out.bits },
700 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
701 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
702 #ifdef EXPERIMENTAL_DANE
703 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
705 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
706 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
707 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
708 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
709 #if defined(SUPPORT_TLS)
710 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
712 #ifdef EXPERIMENTAL_DANE
713 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
716 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
717 #if defined(SUPPORT_TLS)
718 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
721 { "tod_bsdinbox", vtype_todbsdin, NULL },
722 { "tod_epoch", vtype_tode, NULL },
723 { "tod_epoch_l", vtype_todel, NULL },
724 { "tod_full", vtype_todf, NULL },
725 { "tod_log", vtype_todl, NULL },
726 { "tod_logfile", vtype_todlf, NULL },
727 { "tod_zone", vtype_todzone, NULL },
728 { "tod_zulu", vtype_todzulu, NULL },
729 { "transport_name", vtype_stringptr, &transport_name },
730 { "value", vtype_stringptr, &lookup_value },
731 { "verify_mode", vtype_stringptr, &verify_mode },
732 { "version_number", vtype_stringptr, &version_string },
733 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
734 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
735 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
736 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
737 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
738 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
741 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
742 static uschar var_buffer[256];
743 static BOOL malformed_header;
745 /* For textual hashes */
747 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
748 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
751 enum { HMAC_MD5, HMAC_SHA1 };
753 /* For numeric hashes */
755 static unsigned int prime[] = {
756 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
757 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
758 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
760 /* For printing modes in symbolic form */
762 static uschar *mtable_normal[] =
763 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
765 static uschar *mtable_setid[] =
766 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
768 static uschar *mtable_sticky[] =
769 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
773 /*************************************************
774 * Tables for UTF-8 support *
775 *************************************************/
777 /* Table of the number of extra characters, indexed by the first character
778 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
781 static uschar utf8_table1[] = {
782 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
783 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
784 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
785 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
787 /* These are the masks for the data bits in the first byte of a character,
788 indexed by the number of additional bytes. */
790 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
792 /* Get the next UTF-8 character, advancing the pointer. */
794 #define GETUTF8INC(c, ptr) \
796 if ((c & 0xc0) == 0xc0) \
798 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
800 c = (c & utf8_table2[a]) << s; \
804 c |= (*ptr++ & 0x3f) << s; \
809 /*************************************************
810 * Binary chop search on a table *
811 *************************************************/
813 /* This is used for matching expansion items and operators.
816 name the name that is being sought
817 table the table to search
818 table_size the number of items in the table
820 Returns: the offset in the table, or -1
824 chop_match(uschar *name, uschar **table, int table_size)
826 uschar **bot = table;
827 uschar **top = table + table_size;
831 uschar **mid = bot + (top - bot)/2;
832 int c = Ustrcmp(name, *mid);
833 if (c == 0) return mid - table;
834 if (c > 0) bot = mid + 1; else top = mid;
842 /*************************************************
843 * Check a condition string *
844 *************************************************/
846 /* This function is called to expand a string, and test the result for a "true"
847 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
848 forced fail or lookup defer.
850 We used to release all store used, but this is not not safe due
851 to ${dlfunc } and ${acl }. In any case expand_string_internal()
852 is reasonably careful to release what it can.
854 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
857 condition the condition string
858 m1 text to be incorporated in panic error
861 Returns: TRUE if condition is met, FALSE if not
865 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
868 uschar *ss = expand_string(condition);
871 if (!expand_string_forcedfail && !search_find_defer)
872 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
873 "for %s %s: %s", condition, m1, m2, expand_string_message);
876 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
877 strcmpic(ss, US"false") != 0;
884 /*************************************************
885 * Pseudo-random number generation *
886 *************************************************/
888 /* Pseudo-random number generation. The result is not "expected" to be
889 cryptographically strong but not so weak that someone will shoot themselves
890 in the foot using it as a nonce in some email header scheme or whatever
891 weirdness they'll twist this into. The result should ideally handle fork().
893 However, if we're stuck unable to provide this, then we'll fall back to
894 appallingly bad randomness.
896 If SUPPORT_TLS is defined then this will not be used except as an emergency
901 Returns a random number in range [0, max-1]
905 # define vaguely_random_number vaguely_random_number_fallback
908 vaguely_random_number(int max)
911 # undef vaguely_random_number
913 static pid_t pid = 0;
915 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
925 #ifdef HAVE_ARC4RANDOM
926 /* cryptographically strong randomness, common on *BSD platforms, not
927 so much elsewhere. Alas. */
928 #ifndef NOT_HAVE_ARC4RANDOM_STIR
931 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
932 #ifdef HAVE_SRANDOMDEV
933 /* uses random(4) for seeding */
936 gettimeofday(&tv, NULL);
937 srandom(tv.tv_sec | tv.tv_usec | getpid());
940 /* Poor randomness and no seeding here */
947 #ifdef HAVE_ARC4RANDOM
948 return arc4random() % max;
949 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
950 return random() % max;
952 /* This one returns a 16-bit number, definitely not crypto-strong */
953 return random_number(max);
960 /*************************************************
961 * Pick out a name from a string *
962 *************************************************/
964 /* If the name is too long, it is silently truncated.
967 name points to a buffer into which to put the name
968 max is the length of the buffer
969 s points to the first alphabetic character of the name
970 extras chars other than alphanumerics to permit
972 Returns: pointer to the first character after the name
974 Note: The test for *s != 0 in the while loop is necessary because
975 Ustrchr() yields non-NULL if the character is zero (which is not something
979 read_name(uschar *name, int max, uschar *s, uschar *extras)
982 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
984 if (ptr < max-1) name[ptr++] = *s;
993 /*************************************************
994 * Pick out the rest of a header name *
995 *************************************************/
997 /* A variable name starting $header_ (or just $h_ for those who like
998 abbreviations) might not be the complete header name because headers can
999 contain any printing characters in their names, except ':'. This function is
1000 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1001 on the end, if the name was terminated by white space.
1004 name points to a buffer in which the name read so far exists
1005 max is the length of the buffer
1006 s points to the first character after the name so far, i.e. the
1007 first non-alphameric character after $header_xxxxx
1009 Returns: a pointer to the first character after the header name
1013 read_header_name(uschar *name, int max, uschar *s)
1015 int prelen = Ustrchr(name, '_') - name + 1;
1016 int ptr = Ustrlen(name) - prelen;
1017 if (ptr > 0) memmove(name, name+prelen, ptr);
1018 while (mac_isgraph(*s) && *s != ':')
1020 if (ptr < max-1) name[ptr++] = *s;
1031 /*************************************************
1032 * Pick out a number from a string *
1033 *************************************************/
1036 n points to an integer into which to put the number
1037 s points to the first digit of the number
1039 Returns: a pointer to the character after the last digit
1043 read_number(int *n, uschar *s)
1046 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1052 /*************************************************
1053 * Extract keyed subfield from a string *
1054 *************************************************/
1056 /* The yield is in dynamic store; NULL means that the key was not found.
1059 key points to the name of the key
1060 s points to the string from which to extract the subfield
1062 Returns: NULL if the subfield was not found, or
1063 a pointer to the subfield's data
1067 expand_getkeyed(uschar *key, uschar *s)
1069 int length = Ustrlen(key);
1070 while (isspace(*s)) s++;
1072 /* Loop to search for the key */
1080 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1081 dkeylength = s - dkey;
1082 while (isspace(*s)) s++;
1083 if (*s == '=') while (isspace((*(++s))));
1085 data = string_dequote(&s);
1086 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1089 while (isspace(*s)) s++;
1098 find_var_ent(uschar * name)
1101 int last = var_table_size;
1103 while (last > first)
1105 int middle = (first + last)/2;
1106 int c = Ustrcmp(name, var_table[middle].name);
1108 if (c > 0) { first = middle + 1; continue; }
1109 if (c < 0) { last = middle; continue; }
1110 return &var_table[middle];
1115 /*************************************************
1116 * Extract numbered subfield from string *
1117 *************************************************/
1119 /* Extracts a numbered field from a string that is divided by tokens - for
1120 example a line from /etc/passwd is divided by colon characters. First field is
1121 numbered one. Negative arguments count from the right. Zero returns the whole
1122 string. Returns NULL if there are insufficient tokens in the string
1125 Modifies final argument - this is a dynamically generated string, so that's OK.
1128 field number of field to be extracted,
1129 first field = 1, whole string = 0, last field = -1
1130 separators characters that are used to break string into tokens
1131 s points to the string from which to extract the subfield
1133 Returns: NULL if the field was not found,
1134 a pointer to the field's data inside s (modified to add 0)
1138 expand_gettokened (int field, uschar *separators, uschar *s)
1143 uschar *fieldtext = NULL;
1145 if (field == 0) return s;
1147 /* Break the line up into fields in place; for field > 0 we stop when we have
1148 done the number of fields we want. For field < 0 we continue till the end of
1149 the string, counting the number of fields. */
1151 count = (field > 0)? field : INT_MAX;
1157 /* Previous field was the last one in the string. For a positive field
1158 number, this means there are not enough fields. For a negative field number,
1159 check that there are enough, and scan back to find the one that is wanted. */
1163 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1164 if ((-field) == (INT_MAX - count - 1)) return s;
1168 while (ss[-1] != 0) ss--;
1174 /* Previous field was not last in the string; save its start and put a
1178 len = Ustrcspn(ss, separators);
1189 expand_getlistele(int field, uschar * list)
1191 uschar * tlist= list;
1197 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1200 if(field==0) return NULL;
1201 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1202 return string_nextinlist(&list, &sep, NULL, 0);
1206 /* Certificate fields, by name. Worry about by-OID later */
1207 /* Names are chosen to not have common prefixes */
1214 uschar * (*getfn)(void * cert, uschar * mod);
1216 static certfield certfields[] =
1217 { /* linear search; no special order */
1218 { US"version", 7, &tls_cert_version },
1219 { US"serial_number", 13, &tls_cert_serial_number },
1220 { US"subject", 7, &tls_cert_subject },
1221 { US"notbefore", 9, &tls_cert_not_before },
1222 { US"notafter", 8, &tls_cert_not_after },
1223 { US"issuer", 6, &tls_cert_issuer },
1224 { US"signature", 9, &tls_cert_signature },
1225 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1226 { US"subj_altname", 12, &tls_cert_subject_altname },
1227 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1228 { US"crl_uri", 7, &tls_cert_crl_uri },
1232 expand_getcertele(uschar * field, uschar * certvar)
1237 if (!(vp = find_var_ent(certvar)))
1239 expand_string_message =
1240 string_sprintf("no variable named \"%s\"", certvar);
1241 return NULL; /* Unknown variable name */
1243 /* NB this stops us passing certs around in variable. Might
1244 want to do that in future */
1245 if (vp->type != vtype_cert)
1247 expand_string_message =
1248 string_sprintf("\"%s\" is not a certificate", certvar);
1249 return NULL; /* Unknown variable name */
1251 if (!*(void **)vp->value)
1254 if (*field >= '0' && *field <= '9')
1255 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1257 for(cp = certfields;
1258 cp < certfields + nelements(certfields);
1260 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1262 uschar * modifier = *(field += cp->namelen) == ','
1264 return (*cp->getfn)( *(void **)vp->value, modifier );
1267 expand_string_message =
1268 string_sprintf("bad field selector \"%s\" for certextract", field);
1271 #endif /*SUPPORT_TLS*/
1273 /*************************************************
1274 * Extract a substring from a string *
1275 *************************************************/
1277 /* Perform the ${substr or ${length expansion operations.
1280 subject the input string
1281 value1 the offset from the start of the input string to the start of
1282 the output string; if negative, count from the right.
1283 value2 the length of the output string, or negative (-1) for unset
1284 if value1 is positive, unset means "all after"
1285 if value1 is negative, unset means "all before"
1286 len set to the length of the returned string
1288 Returns: pointer to the output string, or NULL if there is an error
1292 extract_substr(uschar *subject, int value1, int value2, int *len)
1294 int sublen = Ustrlen(subject);
1296 if (value1 < 0) /* count from right */
1300 /* If the position is before the start, skip to the start, and adjust the
1301 length. If the length ends up negative, the substring is null because nothing
1302 can precede. This falls out naturally when the length is unset, meaning "all
1308 if (value2 < 0) value2 = 0;
1312 /* Otherwise an unset length => characters before value1 */
1314 else if (value2 < 0)
1321 /* For a non-negative offset, if the starting position is past the end of the
1322 string, the result will be the null string. Otherwise, an unset length means
1323 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1327 if (value1 > sublen)
1332 else if (value2 < 0) value2 = sublen;
1335 /* Cut the length down to the maximum possible for the offset value, and get
1336 the required characters. */
1338 if (value1 + value2 > sublen) value2 = sublen - value1;
1340 return subject + value1;
1346 /*************************************************
1347 * Old-style hash of a string *
1348 *************************************************/
1350 /* Perform the ${hash expansion operation.
1353 subject the input string (an expanded substring)
1354 value1 the length of the output string; if greater or equal to the
1355 length of the input string, the input string is returned
1356 value2 the number of hash characters to use, or 26 if negative
1357 len set to the length of the returned string
1359 Returns: pointer to the output string, or NULL if there is an error
1363 compute_hash(uschar *subject, int value1, int value2, int *len)
1365 int sublen = Ustrlen(subject);
1367 if (value2 < 0) value2 = 26;
1368 else if (value2 > Ustrlen(hashcodes))
1370 expand_string_message =
1371 string_sprintf("hash count \"%d\" too big", value2);
1375 /* Calculate the hash text. We know it is shorter than the original string, so
1376 can safely place it in subject[] (we know that subject is always itself an
1377 expanded substring). */
1379 if (value1 < sublen)
1384 while ((c = (subject[j])) != 0)
1386 int shift = (c + j++) & 7;
1387 subject[i] ^= (c << shift) | (c >> (8-shift));
1388 if (++i >= value1) i = 0;
1390 for (i = 0; i < value1; i++)
1391 subject[i] = hashcodes[(subject[i]) % value2];
1393 else value1 = sublen;
1402 /*************************************************
1403 * Numeric hash of a string *
1404 *************************************************/
1406 /* Perform the ${nhash expansion operation. The first characters of the
1407 string are treated as most important, and get the highest prime numbers.
1410 subject the input string
1411 value1 the maximum value of the first part of the result
1412 value2 the maximum value of the second part of the result,
1413 or negative to produce only a one-part result
1414 len set to the length of the returned string
1416 Returns: pointer to the output string, or NULL if there is an error.
1420 compute_nhash (uschar *subject, int value1, int value2, int *len)
1422 uschar *s = subject;
1424 unsigned long int total = 0; /* no overflow */
1428 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1429 total += prime[i--] * (unsigned int)(*s++);
1432 /* If value2 is unset, just compute one number */
1436 s = string_sprintf("%d", total % value1);
1439 /* Otherwise do a div/mod hash */
1443 total = total % (value1 * value2);
1444 s = string_sprintf("%d/%d", total/value2, total % value2);
1455 /*************************************************
1456 * Find the value of a header or headers *
1457 *************************************************/
1459 /* Multiple instances of the same header get concatenated, and this function
1460 can also return a concatenation of all the header lines. When concatenating
1461 specific headers that contain lists of addresses, a comma is inserted between
1462 them. Otherwise we use a straight concatenation. Because some messages can have
1463 pathologically large number of lines, there is a limit on the length that is
1464 returned. Also, to avoid massive store use which would result from using
1465 string_cat() as it copies and extends strings, we do a preliminary pass to find
1466 out exactly how much store will be needed. On "normal" messages this will be
1470 name the name of the header, without the leading $header_ or $h_,
1471 or NULL if a concatenation of all headers is required
1472 exists_only TRUE if called from a def: test; don't need to build a string;
1473 just return a string that is not "" and not "0" if the header
1475 newsize return the size of memory block that was obtained; may be NULL
1476 if exists_only is TRUE
1477 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1478 other than concatenating, will be done on the header. Also used
1479 for $message_headers_raw.
1480 charset name of charset to translate MIME words to; used only if
1481 want_raw is false; if NULL, no translation is done (this is
1482 used for $bh_ and $bheader_)
1484 Returns: NULL if the header does not exist, else a pointer to a new
1489 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1492 BOOL found = name == NULL;
1494 int len = found? 0 : Ustrlen(name);
1496 uschar *yield = NULL;
1499 /* Loop for two passes - saves code repetition */
1501 for (i = 0; i < 2; i++)
1506 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1508 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1510 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1515 if (exists_only) return US"1"; /* don't need actual string */
1517 t = h->text + len; /* text to insert */
1518 if (!want_raw) /* unless wanted raw, */
1519 while (isspace(*t)) t++; /* remove leading white space */
1520 ilen = h->slen - (t - h->text); /* length to insert */
1522 /* Unless wanted raw, remove trailing whitespace, including the
1526 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1528 /* Set comma = 1 if handling a single header and it's one of those
1529 that contains an address list, except when asked for raw headers. Only
1530 need to do this once. */
1532 if (!want_raw && name != NULL && comma == 0 &&
1533 Ustrchr("BCFRST", h->type) != NULL)
1536 /* First pass - compute total store needed; second pass - compute
1537 total store used, including this header. */
1539 size += ilen + comma + 1; /* +1 for the newline */
1541 /* Second pass - concatentate the data, up to a maximum. Note that
1542 the loop stops when size hits the limit. */
1546 if (size > header_insert_maxlen)
1548 ilen -= size - header_insert_maxlen - 1;
1551 Ustrncpy(ptr, t, ilen);
1554 /* For a non-raw header, put in the comma if needed, then add
1555 back the newline we removed above, provided there was some text in
1558 if (!want_raw && ilen > 0)
1560 if (comma != 0) *ptr++ = ',';
1568 /* At end of first pass, return NULL if no header found. Then truncate size
1569 if necessary, and get the buffer to hold the data, returning the buffer size.
1574 if (!found) return NULL;
1575 if (size > header_insert_maxlen) size = header_insert_maxlen;
1576 *newsize = size + 1;
1577 ptr = yield = store_get(*newsize);
1581 /* That's all we do for raw header expansion. */
1588 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1589 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1590 function can return an error with decoded data if the charset translation
1591 fails. If decoding fails, it returns NULL. */
1595 uschar *decoded, *error;
1596 if (ptr > yield && ptr[-1] == '\n') ptr--;
1597 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1599 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1603 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1604 " input was: %s\n", error, yield);
1606 if (decoded != NULL) yield = decoded;
1615 /*************************************************
1616 * Return list of recipients *
1617 *************************************************/
1618 /* A recipients list is available only during system message filtering,
1619 during ACL processing after DATA, and while expanding pipe commands
1620 generated from a system filter, but not elsewhere. */
1625 if (!enable_dollar_recipients) return NULL; else
1630 uschar * s = store_get(size);
1631 for (i = 0; i < recipients_count; i++)
1633 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1634 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1635 Ustrlen(recipients_list[i].address));
1637 s[ptr] = 0; /* string_cat() leaves room */
1643 /*************************************************
1644 * Find value of a variable *
1645 *************************************************/
1647 /* The table of variables is kept in alphabetic order, so we can search it
1648 using a binary chop. The "choplen" variable is nothing to do with the binary
1652 name the name of the variable being sought
1653 exists_only TRUE if this is a def: test; passed on to find_header()
1654 skipping TRUE => skip any processing evaluation; this is not the same as
1655 exists_only because def: may test for values that are first
1657 newsize pointer to an int which is initially zero; if the answer is in
1658 a new memory buffer, *newsize is set to its size
1660 Returns: NULL if the variable does not exist, or
1661 a pointer to the variable's contents, or
1662 something non-NULL if exists_only is TRUE
1666 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1673 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1674 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1675 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1676 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1677 (this gave backwards compatibility at the changeover). There may be built-in
1678 variables whose names start acl_ but they should never start in this way. This
1679 slightly messy specification is a consequence of the history, needless to say.
1681 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1682 set, in which case give an error. */
1684 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1688 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1689 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1692 /* Handle $auth<n> variables. */
1694 if (Ustrncmp(name, "auth", 4) == 0)
1697 int n = Ustrtoul(name + 4, &endptr, 10);
1698 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1699 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1702 /* For all other variables, search the table */
1704 if (!(vp = find_var_ent(name)))
1705 return NULL; /* Unknown variable name */
1707 /* Found an existing variable. If in skipping state, the value isn't needed,
1708 and we want to avoid processing (such as looking up the host name). */
1716 case vtype_filter_int:
1717 if (!filter_running) return NULL;
1721 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1725 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1729 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1733 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1737 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1740 case vtype_stringptr: /* Pointer to string */
1741 s = *((uschar **)(val));
1742 return (s == NULL)? US"" : s;
1745 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1748 case vtype_load_avg:
1749 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1752 case vtype_host_lookup: /* Lookup if not done so */
1753 if (sender_host_name == NULL && sender_host_address != NULL &&
1754 !host_lookup_failed && host_name_lookup() == OK)
1755 host_build_sender_fullhost();
1756 return (sender_host_name == NULL)? US"" : sender_host_name;
1758 case vtype_localpart: /* Get local part from address */
1759 s = *((uschar **)(val));
1760 if (s == NULL) return US"";
1761 domain = Ustrrchr(s, '@');
1762 if (domain == NULL) return s;
1763 if (domain - s > sizeof(var_buffer) - 1)
1764 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1765 " in string expansion", sizeof(var_buffer));
1766 Ustrncpy(var_buffer, s, domain - s);
1767 var_buffer[domain - s] = 0;
1770 case vtype_domain: /* Get domain from address */
1771 s = *((uschar **)(val));
1772 if (s == NULL) return US"";
1773 domain = Ustrrchr(s, '@');
1774 return (domain == NULL)? US"" : domain + 1;
1776 case vtype_msgheaders:
1777 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1779 case vtype_msgheaders_raw:
1780 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1782 case vtype_msgbody: /* Pointer to msgbody string */
1783 case vtype_msgbody_end: /* Ditto, the end of the msg */
1784 ss = (uschar **)(val);
1785 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1788 off_t start_offset = SPOOL_DATA_START_OFFSET;
1789 int len = message_body_visible;
1790 if (len > message_size) len = message_size;
1791 *ss = body = store_malloc(len+1);
1793 if (vp->type == vtype_msgbody_end)
1795 struct stat statbuf;
1796 if (fstat(deliver_datafile, &statbuf) == 0)
1798 start_offset = statbuf.st_size - len;
1799 if (start_offset < SPOOL_DATA_START_OFFSET)
1800 start_offset = SPOOL_DATA_START_OFFSET;
1803 lseek(deliver_datafile, start_offset, SEEK_SET);
1804 len = read(deliver_datafile, body, len);
1808 if (message_body_newlines) /* Separate loops for efficiency */
1811 { if (body[--len] == 0) body[len] = ' '; }
1816 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1820 return (*ss == NULL)? US"" : *ss;
1822 case vtype_todbsdin: /* BSD inbox time of day */
1823 return tod_stamp(tod_bsdin);
1825 case vtype_tode: /* Unix epoch time of day */
1826 return tod_stamp(tod_epoch);
1828 case vtype_todel: /* Unix epoch/usec time of day */
1829 return tod_stamp(tod_epoch_l);
1831 case vtype_todf: /* Full time of day */
1832 return tod_stamp(tod_full);
1834 case vtype_todl: /* Log format time of day */
1835 return tod_stamp(tod_log_bare); /* (without timezone) */
1837 case vtype_todzone: /* Time zone offset only */
1838 return tod_stamp(tod_zone);
1840 case vtype_todzulu: /* Zulu time */
1841 return tod_stamp(tod_zulu);
1843 case vtype_todlf: /* Log file datestamp tod */
1844 return tod_stamp(tod_log_datestamp_daily);
1846 case vtype_reply: /* Get reply address */
1847 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1849 if (s != NULL) while (isspace(*s)) s++;
1850 if (s == NULL || *s == 0)
1852 *newsize = 0; /* For the *s==0 case */
1853 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1858 while (isspace(*s)) s++;
1859 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1860 while (t > s && isspace(t[-1])) t--;
1863 return (s == NULL)? US"" : s;
1865 case vtype_string_func:
1867 uschar * (*fn)() = val;
1874 sprintf(CS var_buffer, "%d",
1875 receive_statvfs(val == (void *)TRUE, &inodes));
1882 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1883 sprintf(CS var_buffer, "%d", inodes);
1888 return *(void **)val ? US"<cert>" : US"";
1890 #ifndef DISABLE_DKIM
1892 return dkim_exim_expand_query((int)(long)val);
1897 return NULL; /* Unknown variable. Silences static checkers. */
1904 modify_variable(uschar *name, void * value)
1907 if ((vp = find_var_ent(name))) vp->value = value;
1908 return; /* Unknown variable name, fail silently */
1915 /*************************************************
1916 * Read and expand substrings *
1917 *************************************************/
1919 /* This function is called to read and expand argument substrings for various
1920 expansion items. Some have a minimum requirement that is less than the maximum;
1921 in these cases, the first non-present one is set to NULL.
1924 sub points to vector of pointers to set
1925 n maximum number of substrings
1927 sptr points to current string pointer
1928 skipping the skipping flag
1929 check_end if TRUE, check for final '}'
1930 name name of item, for error message
1931 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1934 Returns: 0 OK; string pointer updated
1935 1 curly bracketing error (too few arguments)
1936 2 too many arguments (only if check_end is set); message set
1937 3 other error (expansion failure)
1941 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1942 BOOL check_end, uschar *name, BOOL *resetok)
1947 while (isspace(*s)) s++;
1948 for (i = 0; i < n; i++)
1952 if (i < m) return 1;
1956 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
1957 if (sub[i] == NULL) return 3;
1958 if (*s++ != '}') return 1;
1959 while (isspace(*s)) s++;
1961 if (check_end && *s++ != '}')
1965 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1966 "(max is %d)", name, n);
1979 /*************************************************
1980 * Elaborate message for bad variable *
1981 *************************************************/
1983 /* For the "unknown variable" message, take a look at the variable's name, and
1984 give additional information about possible ACL variables. The extra information
1985 is added on to expand_string_message.
1987 Argument: the name of the variable
1992 check_variable_error_message(uschar *name)
1994 if (Ustrncmp(name, "acl_", 4) == 0)
1995 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1996 (name[4] == 'c' || name[4] == 'm')?
1998 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1999 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2001 US"user-defined ACL variables must start acl_c or acl_m");
2007 Load args from sub array to globals, and call acl_check().
2008 Sub array will be corrupted on return.
2010 Returns: OK access is granted by an ACCEPT verb
2011 DISCARD access is granted by a DISCARD verb
2012 FAIL access is denied
2013 FAIL_DROP access is denied; drop the connection
2014 DEFER can't tell at the moment
2018 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2021 uschar * tmp = NULL;
2022 int sav_narg = acl_narg;
2024 extern int acl_where;
2026 if(--nsub > sizeof(acl_arg)/sizeof(*acl_arg)) nsub = sizeof(acl_arg)/sizeof(*acl_arg);
2027 for (i = 0; i < nsub && sub[i+1]; i++)
2030 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2031 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2036 sub[i+1] = acl_arg[i];
2037 acl_arg[i++] = NULL;
2041 debug_printf("expanding: acl: %s arg: %s%s\n",
2043 acl_narg>0 ? acl_arg[0] : US"<none>",
2044 acl_narg>1 ? " +more" : "");
2046 ret = acl_eval(acl_where, sub[0], user_msgp, &tmp);
2048 for (i = 0; i < nsub; i++)
2049 acl_arg[i] = sub[i+1]; /* restore old args */
2050 acl_narg = sav_narg;
2058 /*************************************************
2059 * Read and evaluate a condition *
2060 *************************************************/
2064 s points to the start of the condition text
2065 resetok points to a BOOL which is written false if it is unsafe to
2066 free memory. Certain condition types (acl) may have side-effect
2067 allocation which must be preserved.
2068 yield points to a BOOL to hold the result of the condition test;
2069 if NULL, we are just reading through a condition that is
2070 part of an "or" combination to check syntax, or in a state
2071 where the answer isn't required
2073 Returns: a pointer to the first character after the condition, or
2078 eval_condition(uschar *s, BOOL *resetok, BOOL *yield)
2080 BOOL testfor = TRUE;
2081 BOOL tempcond, combined_cond;
2083 BOOL sub2_honour_dollar = TRUE;
2084 int i, rc, cond_type, roffset;
2085 int_eximarith_t num[2];
2086 struct stat statbuf;
2091 const uschar *rerror;
2095 while (isspace(*s)) s++;
2096 if (*s == '!') { testfor = !testfor; s++; } else break;
2099 /* Numeric comparisons are symbolic */
2101 if (*s == '=' || *s == '>' || *s == '<')
2113 /* All other conditions are named */
2115 else s = read_name(name, 256, s, US"_");
2117 /* If we haven't read a name, it means some non-alpha character is first. */
2121 expand_string_message = string_sprintf("condition name expected, "
2122 "but found \"%.16s\"", s);
2126 /* Find which condition we are dealing with, and switch on it */
2128 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
2131 /* def: tests for a non-empty variable, or for the existence of a header. If
2132 yield == NULL we are in a skipping state, and don't care about the answer. */
2137 expand_string_message = US"\":\" expected after \"def\"";
2141 s = read_name(name, 256, s+1, US"_");
2143 /* Test for a header's existence. If the name contains a closing brace
2144 character, this may be a user error where the terminating colon has been
2145 omitted. Set a flag to adjust a subsequent error message in this case. */
2147 if (Ustrncmp(name, "h_", 2) == 0 ||
2148 Ustrncmp(name, "rh_", 3) == 0 ||
2149 Ustrncmp(name, "bh_", 3) == 0 ||
2150 Ustrncmp(name, "header_", 7) == 0 ||
2151 Ustrncmp(name, "rheader_", 8) == 0 ||
2152 Ustrncmp(name, "bheader_", 8) == 0)
2154 s = read_header_name(name, 256, s);
2155 /* {-for-text-editors */
2156 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2157 if (yield != NULL) *yield =
2158 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2161 /* Test for a variable's having a non-empty value. A non-existent variable
2162 causes an expansion failure. */
2166 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2169 expand_string_message = (name[0] == 0)?
2170 string_sprintf("variable name omitted after \"def:\"") :
2171 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2172 check_variable_error_message(name);
2175 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2181 /* first_delivery tests for first delivery attempt */
2183 case ECOND_FIRST_DELIVERY:
2184 if (yield != NULL) *yield = deliver_firsttime == testfor;
2188 /* queue_running tests for any process started by a queue runner */
2190 case ECOND_QUEUE_RUNNING:
2191 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2195 /* exists: tests for file existence
2196 isip: tests for any IP address
2197 isip4: tests for an IPv4 address
2198 isip6: tests for an IPv6 address
2199 pam: does PAM authentication
2200 radius: does RADIUS authentication
2201 ldapauth: does LDAP authentication
2202 pwcheck: does Cyrus SASL pwcheck authentication
2211 case ECOND_LDAPAUTH:
2214 while (isspace(*s)) s++;
2215 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2217 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2218 if (sub[0] == NULL) return NULL;
2219 /* {-for-text-editors */
2220 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2222 if (yield == NULL) return s; /* No need to run the test if skipping */
2227 if ((expand_forbid & RDO_EXISTS) != 0)
2229 expand_string_message = US"File existence tests are not permitted";
2232 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2238 rc = string_is_ip_address(sub[0], NULL);
2239 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2240 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2243 /* Various authentication tests - all optionally compiled */
2247 rc = auth_call_pam(sub[0], &expand_string_message);
2250 goto COND_FAILED_NOT_COMPILED;
2251 #endif /* SUPPORT_PAM */
2254 #ifdef RADIUS_CONFIG_FILE
2255 rc = auth_call_radius(sub[0], &expand_string_message);
2258 goto COND_FAILED_NOT_COMPILED;
2259 #endif /* RADIUS_CONFIG_FILE */
2261 case ECOND_LDAPAUTH:
2264 /* Just to keep the interface the same */
2266 int old_pool = store_pool;
2267 store_pool = POOL_SEARCH;
2268 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2269 &expand_string_message, &do_cache);
2270 store_pool = old_pool;
2274 goto COND_FAILED_NOT_COMPILED;
2275 #endif /* LOOKUP_LDAP */
2278 #ifdef CYRUS_PWCHECK_SOCKET
2279 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2282 goto COND_FAILED_NOT_COMPILED;
2283 #endif /* CYRUS_PWCHECK_SOCKET */
2285 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2286 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2288 if (rc == ERROR || rc == DEFER) return NULL;
2289 *yield = (rc == OK) == testfor;
2295 /* call ACL (in a conditional context). Accept true, deny false.
2296 Defer is a forced-fail. Anything set by message= goes to $value.
2297 Up to ten parameters are used; we use the braces round the name+args
2298 like the saslauthd condition does, to permit a variable number of args.
2299 See also the expansion-item version EITEM_ACL and the traditional
2300 acl modifier ACLC_ACL.
2301 Since the ACL may allocate new global variables, tell our caller to not
2306 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2313 while (isspace(*s)) s++;
2314 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2316 switch(read_subs(sub, sizeof(sub)/sizeof(*sub), 1,
2317 &s, yield == NULL, TRUE, US"acl", resetok))
2319 case 1: expand_string_message = US"too few arguments or bracketing "
2322 case 3: return NULL;
2326 if (yield != NULL) switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
2331 lookup_value = NULL;
2334 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2335 lookup_value[ptr] = '\0';
2337 *yield = cond == testfor;
2341 expand_string_forcedfail = TRUE;
2343 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2350 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2352 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2354 However, the last two are optional. That is why the whole set is enclosed
2355 in their own set of braces. */
2357 case ECOND_SASLAUTHD:
2358 #ifndef CYRUS_SASLAUTHD_SOCKET
2359 goto COND_FAILED_NOT_COMPILED;
2361 while (isspace(*s)) s++;
2362 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2363 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd", resetok))
2365 case 1: expand_string_message = US"too few arguments or bracketing "
2366 "error for saslauthd";
2368 case 3: return NULL;
2370 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2374 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2375 &expand_string_message);
2376 if (rc == ERROR || rc == DEFER) return NULL;
2377 *yield = (rc == OK) == testfor;
2380 #endif /* CYRUS_SASLAUTHD_SOCKET */
2383 /* symbolic operators for numeric and string comparison, and a number of
2384 other operators, all requiring two arguments.
2386 crypteq: encrypts plaintext and compares against an encrypted text,
2387 using crypt(), crypt16(), MD5 or SHA-1
2388 inlist/inlisti: checks if first argument is in the list of the second
2389 match: does a regular expression match and sets up the numerical
2390 variables if it succeeds
2391 match_address: matches in an address list
2392 match_domain: matches in a domain list
2393 match_ip: matches a host list that is restricted to IP addresses
2394 match_local_part: matches in a local part list
2397 case ECOND_MATCH_ADDRESS:
2398 case ECOND_MATCH_DOMAIN:
2399 case ECOND_MATCH_IP:
2400 case ECOND_MATCH_LOCAL_PART:
2401 #ifndef EXPAND_LISTMATCH_RHS
2402 sub2_honour_dollar = FALSE;
2411 case ECOND_NUM_L: /* Numerical comparisons */
2418 case ECOND_STR_LT: /* String comparisons */
2429 for (i = 0; i < 2; i++)
2431 /* Sometimes, we don't expand substrings; too many insecure configurations
2432 created using match_address{}{} and friends, where the second param
2433 includes information from untrustworthy sources. */
2434 BOOL honour_dollar = TRUE;
2435 if ((i > 0) && !sub2_honour_dollar)
2436 honour_dollar = FALSE;
2438 while (isspace(*s)) s++;
2441 if (i == 0) goto COND_FAILED_CURLY_START;
2442 expand_string_message = string_sprintf("missing 2nd string in {} "
2443 "after \"%s\"", name);
2446 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2447 honour_dollar, resetok);
2448 if (sub[i] == NULL) return NULL;
2449 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2451 /* Convert to numerical if required; we know that the names of all the
2452 conditions that compare numbers do not start with a letter. This just saves
2453 checking for them individually. */
2455 if (!isalpha(name[0]) && yield != NULL)
2461 debug_printf("empty string cast to zero for numerical comparison\n");
2465 num[i] = expanded_string_integer(sub[i], FALSE);
2466 if (expand_string_message != NULL) return NULL;
2471 /* Result not required */
2473 if (yield == NULL) return s;
2475 /* Do an appropriate comparison */
2481 tempcond = (num[0] == num[1]);
2485 tempcond = (num[0] > num[1]);
2489 tempcond = (num[0] >= num[1]);
2493 tempcond = (num[0] < num[1]);
2497 tempcond = (num[0] <= num[1]);
2501 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2505 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2509 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2513 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2517 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2521 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2525 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2529 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2533 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2537 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2540 case ECOND_MATCH: /* Regular expression match */
2541 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2545 expand_string_message = string_sprintf("regular expression error in "
2546 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2549 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2552 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2553 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2554 goto MATCHED_SOMETHING;
2556 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2557 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2558 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2559 goto MATCHED_SOMETHING;
2561 case ECOND_MATCH_IP: /* Match IP address in a host list */
2562 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2564 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2570 unsigned int *nullcache = NULL;
2571 check_host_block cb;
2573 cb.host_name = US"";
2574 cb.host_address = sub[0];
2576 /* If the host address starts off ::ffff: it is an IPv6 address in
2577 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2580 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2581 cb.host_address + 7 : cb.host_address;
2583 rc = match_check_list(
2584 &sub[1], /* the list */
2585 0, /* separator character */
2586 &hostlist_anchor, /* anchor pointer */
2587 &nullcache, /* cache pointer */
2588 check_host, /* function for testing */
2589 &cb, /* argument for function */
2590 MCL_HOST, /* type of check */
2591 sub[0], /* text for debugging */
2592 NULL); /* where to pass back data */
2594 goto MATCHED_SOMETHING;
2596 case ECOND_MATCH_LOCAL_PART:
2597 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2598 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2613 expand_string_message = string_sprintf("unable to complete match "
2614 "against \"%s\": %s", sub[1], search_error_message);
2620 /* Various "encrypted" comparisons. If the second string starts with
2621 "{" then an encryption type is given. Default to crypt() or crypt16()
2622 (build-time choice). */
2623 /* }-for-text-editors */
2626 #ifndef SUPPORT_CRYPTEQ
2627 goto COND_FAILED_NOT_COMPILED;
2629 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2631 int sublen = Ustrlen(sub[1]+5);
2636 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2638 /* If the length that we are comparing against is 24, the MD5 digest
2639 is expressed as a base64 string. This is the way LDAP does it. However,
2640 some other software uses a straightforward hex representation. We assume
2641 this if the length is 32. Other lengths fail. */
2645 uschar *coded = auth_b64encode((uschar *)digest, 16);
2646 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2647 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2648 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2650 else if (sublen == 32)
2654 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2656 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2657 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2658 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2662 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2663 "fail\n crypted=%s\n", sub[1]+5);
2668 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2670 int sublen = Ustrlen(sub[1]+6);
2675 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2677 /* If the length that we are comparing against is 28, assume the SHA1
2678 digest is expressed as a base64 string. If the length is 40, assume a
2679 straightforward hex representation. Other lengths fail. */
2683 uschar *coded = auth_b64encode((uschar *)digest, 20);
2684 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2685 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2686 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2688 else if (sublen == 40)
2692 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2694 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2695 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2696 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2700 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2701 "fail\n crypted=%s\n", sub[1]+6);
2706 else /* {crypt} or {crypt16} and non-{ at start */
2707 /* }-for-text-editors */
2712 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2717 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2722 else if (sub[1][0] == '{') /* }-for-text-editors */
2724 expand_string_message = string_sprintf("unknown encryption mechanism "
2725 "in \"%s\"", sub[1]);
2731 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2732 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2733 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2737 #define XSTR(s) STR(s)
2738 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2739 " subject=%s\n crypted=%s\n",
2740 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2745 /* If the encrypted string contains fewer than two characters (for the
2746 salt), force failure. Otherwise we get false positives: with an empty
2747 string the yield of crypt() is an empty string! */
2749 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2750 (Ustrcmp(coded, sub[1]) == 0);
2753 #endif /* SUPPORT_CRYPTEQ */
2759 uschar *save_iterate_item = iterate_item;
2760 int (*compare)(const uschar *, const uschar *);
2762 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2765 if (cond_type == ECOND_INLISTI)
2768 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2770 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2771 if (compare(sub[0], iterate_item) == 0)
2776 iterate_item = save_iterate_item;
2779 } /* Switch for comparison conditions */
2781 *yield = tempcond == testfor;
2782 return s; /* End of comparison conditions */
2785 /* and/or: computes logical and/or of several conditions */
2789 subcondptr = (yield == NULL)? NULL : &tempcond;
2790 combined_cond = (cond_type == ECOND_AND);
2792 while (isspace(*s)) s++;
2793 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2797 while (isspace(*s)) s++;
2798 /* {-for-text-editors */
2799 if (*s == '}') break;
2800 if (*s != '{') /* }-for-text-editors */
2802 expand_string_message = string_sprintf("each subcondition "
2803 "inside an \"%s{...}\" condition must be in its own {}", name);
2807 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2809 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2810 expand_string_message, name);
2813 while (isspace(*s)) s++;
2815 /* {-for-text-editors */
2818 /* {-for-text-editors */
2819 expand_string_message = string_sprintf("missing } at end of condition "
2820 "inside \"%s\" group", name);
2826 if (cond_type == ECOND_AND)
2828 combined_cond &= tempcond;
2829 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2830 } /* evaluate any more */
2833 combined_cond |= tempcond;
2834 if (combined_cond) subcondptr = NULL; /* once true, don't */
2835 } /* evaluate any more */
2839 if (yield != NULL) *yield = (combined_cond == testfor);
2843 /* forall/forany: iterates a condition with different values */
2849 uschar *save_iterate_item = iterate_item;
2851 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2853 while (isspace(*s)) s++;
2854 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2855 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2856 if (sub[0] == NULL) return NULL;
2857 /* {-for-text-editors */
2858 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2860 while (isspace(*s)) s++;
2861 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2865 /* Call eval_condition once, with result discarded (as if scanning a
2866 "false" part). This allows us to find the end of the condition, because if
2867 the list it empty, we won't actually evaluate the condition for real. */
2869 if (!(s = eval_condition(sub[1], resetok, NULL)))
2871 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2872 expand_string_message, name);
2875 while (isspace(*s)) s++;
2877 /* {-for-text-editors */
2880 /* {-for-text-editors */
2881 expand_string_message = string_sprintf("missing } at end of condition "
2882 "inside \"%s\"", name);
2886 if (yield != NULL) *yield = !testfor;
2887 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2889 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2890 if (!eval_condition(sub[1], resetok, &tempcond))
2892 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2893 expand_string_message, name);
2894 iterate_item = save_iterate_item;
2897 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2898 tempcond? "true":"false");
2900 if (yield != NULL) *yield = (tempcond == testfor);
2901 if (tempcond == (cond_type == ECOND_FORANY)) break;
2904 iterate_item = save_iterate_item;
2909 /* The bool{} expansion condition maps a string to boolean.
2910 The values supported should match those supported by the ACL condition
2911 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2912 of true/false. Note that Router "condition" rules have a different
2913 interpretation, where general data can be used and only a few values
2915 Note that readconf.c boolean matching, for boolean configuration options,
2916 only matches true/yes/false/no.
2917 The bool_lax{} condition matches the Router logic, which is much more
2920 case ECOND_BOOL_LAX:
2926 BOOL boolvalue = FALSE;
2927 while (isspace(*s)) s++;
2928 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2929 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2930 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2932 case 1: expand_string_message = string_sprintf(
2933 "too few arguments or bracketing error for %s",
2937 case 3: return NULL;
2940 while (isspace(*t)) t++;
2944 /* trailing whitespace: seems like a good idea to ignore it too */
2946 while (isspace(*t2)) t2--;
2947 if (t2 != (t + len))
2954 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2955 /* logic for the lax case from expand_check_condition(), which also does
2956 expands, and the logic is both short and stable enough that there should
2957 be no maintenance burden from replicating it. */
2961 ? Ustrspn(t+1, "0123456789") == len-1
2962 : Ustrspn(t, "0123456789") == len)
2964 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2965 /* expand_check_condition only does a literal string "0" check */
2966 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2969 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2971 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2973 else if (cond_type == ECOND_BOOL_LAX)
2977 expand_string_message = string_sprintf("unrecognised boolean "
2981 if (yield != NULL) *yield = (boolvalue == testfor);
2985 /* Unknown condition */
2988 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2990 } /* End switch on condition type */
2992 /* Missing braces at start and end of data */
2994 COND_FAILED_CURLY_START:
2995 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2998 COND_FAILED_CURLY_END:
2999 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3003 /* A condition requires code that is not compiled */
3005 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3006 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3007 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3008 COND_FAILED_NOT_COMPILED:
3009 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3018 /*************************************************
3019 * Save numerical variables *
3020 *************************************************/
3022 /* This function is called from items such as "if" that want to preserve and
3023 restore the numbered variables.
3026 save_expand_string points to an array of pointers to set
3027 save_expand_nlength points to an array of ints for the lengths
3029 Returns: the value of expand max to save
3033 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3036 for (i = 0; i <= expand_nmax; i++)
3038 save_expand_nstring[i] = expand_nstring[i];
3039 save_expand_nlength[i] = expand_nlength[i];
3046 /*************************************************
3047 * Restore numerical variables *
3048 *************************************************/
3050 /* This function restored saved values of numerical strings.
3053 save_expand_nmax the number of strings to restore
3054 save_expand_string points to an array of pointers
3055 save_expand_nlength points to an array of ints
3061 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3062 int *save_expand_nlength)
3065 expand_nmax = save_expand_nmax;
3066 for (i = 0; i <= expand_nmax; i++)
3068 expand_nstring[i] = save_expand_nstring[i];
3069 expand_nlength[i] = save_expand_nlength[i];
3077 /*************************************************
3078 * Handle yes/no substrings *
3079 *************************************************/
3081 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3082 alternative substrings that depend on whether or not the condition was true,
3083 or the lookup or extraction succeeded. The substrings always have to be
3084 expanded, to check their syntax, but "skipping" is set when the result is not
3085 needed - this avoids unnecessary nested lookups.
3088 skipping TRUE if we were skipping when this item was reached
3089 yes TRUE if the first string is to be used, else use the second
3090 save_lookup a value to put back into lookup_value before the 2nd expansion
3091 sptr points to the input string pointer
3092 yieldptr points to the output string pointer
3093 sizeptr points to the output string size
3094 ptrptr points to the output string pointer
3095 type "lookup" or "if" or "extract" or "run", for error message
3096 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3099 Returns: 0 OK; lookup_value has been reset to save_lookup
3101 2 expansion failed because of bracketing error
3105 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
3106 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3109 uschar *s = *sptr; /* Local value */
3110 uschar *sub1, *sub2;
3112 /* If there are no following strings, we substitute the contents of $value for
3113 lookups and for extractions in the success case. For the ${if item, the string
3114 "true" is substituted. In the fail case, nothing is substituted for all three
3117 while (isspace(*s)) s++;
3122 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3126 if (yes && lookup_value != NULL)
3127 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3128 Ustrlen(lookup_value));
3129 lookup_value = save_lookup;
3135 /* The first following string must be braced. */
3137 if (*s++ != '{') goto FAILED_CURLY;
3139 /* Expand the first substring. Forced failures are noticed only if we actually
3140 want this string. Set skipping in the call in the fail case (this will always
3141 be the case if we were already skipping). */
3143 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3144 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3145 expand_string_forcedfail = FALSE;
3146 if (*s++ != '}') goto FAILED_CURLY;
3148 /* If we want the first string, add it to the output */
3151 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3153 /* If this is called from a lookup or an extract, we want to restore $value to
3154 what it was at the start of the item, so that it has this value during the
3155 second string expansion. For the call from "if" or "run" to this function,
3156 save_lookup is set to lookup_value, so that this statement does nothing. */
3158 lookup_value = save_lookup;
3160 /* There now follows either another substring, or "fail", or nothing. This
3161 time, forced failures are noticed only if we want the second string. We must
3162 set skipping in the nested call if we don't want this string, or if we were
3163 already skipping. */
3165 while (isspace(*s)) s++;
3168 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3169 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3170 expand_string_forcedfail = FALSE;
3171 if (*s++ != '}') goto FAILED_CURLY;
3173 /* If we want the second string, add it to the output */
3176 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3179 /* If there is no second string, but the word "fail" is present when the use of
3180 the second string is wanted, set a flag indicating it was a forced failure
3181 rather than a syntactic error. Swallow the terminating } in case this is nested
3182 inside another lookup or if or extract. */
3187 s = read_name(name, sizeof(name), s, US"_");
3188 if (Ustrcmp(name, "fail") == 0)
3190 if (!yes && !skipping)
3192 while (isspace(*s)) s++;
3193 if (*s++ != '}') goto FAILED_CURLY;
3194 expand_string_message =
3195 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3196 expand_string_forcedfail = TRUE;
3202 expand_string_message =
3203 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3208 /* All we have to do now is to check on the final closing brace. */
3210 while (isspace(*s)) s++;
3211 if (*s++ == '}') goto RETURN;
3213 /* Get here if there is a bracketing failure */
3218 /* Get here for other failures */
3223 /* Update the input pointer value before returning */
3233 /*************************************************
3234 * Handle MD5 or SHA-1 computation for HMAC *
3235 *************************************************/
3237 /* These are some wrapping functions that enable the HMAC code to be a bit
3238 cleaner. A good compiler will spot the tail recursion.
3241 type HMAC_MD5 or HMAC_SHA1
3242 remaining are as for the cryptographic hash functions
3248 chash_start(int type, void *base)
3250 if (type == HMAC_MD5)
3251 md5_start((md5 *)base);
3253 sha1_start((sha1 *)base);
3257 chash_mid(int type, void *base, uschar *string)
3259 if (type == HMAC_MD5)
3260 md5_mid((md5 *)base, string);
3262 sha1_mid((sha1 *)base, string);
3266 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3268 if (type == HMAC_MD5)
3269 md5_end((md5 *)base, string, length, digest);
3271 sha1_end((sha1 *)base, string, length, digest);
3278 /********************************************************
3279 * prvs: Get last three digits of days since Jan 1, 1970 *
3280 ********************************************************/
3282 /* This is needed to implement the "prvs" BATV reverse
3285 Argument: integer "days" offset to add or substract to
3286 or from the current number of days.
3288 Returns: pointer to string containing the last three
3289 digits of the number of days since Jan 1, 1970,
3290 modified by the offset argument, NULL if there
3291 was an error in the conversion.
3296 prvs_daystamp(int day_offset)
3298 uschar *days = store_get(32); /* Need at least 24 for cases */
3299 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3300 (time(NULL) + day_offset*86400)/86400);
3301 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3306 /********************************************************
3307 * prvs: perform HMAC-SHA1 computation of prvs bits *
3308 ********************************************************/
3310 /* This is needed to implement the "prvs" BATV reverse
3314 address RFC2821 Address to use
3315 key The key to use (must be less than 64 characters
3317 key_num Single-digit key number to use. Defaults to
3320 Returns: pointer to string containing the first three
3321 bytes of the final hash in hex format, NULL if
3322 there was an error in the process.
3326 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3328 uschar *hash_source, *p;
3329 int size = 0,offset = 0,i;
3331 void *use_base = &sha1_base;
3332 uschar innerhash[20];
3333 uschar finalhash[20];
3334 uschar innerkey[64];
3335 uschar outerkey[64];
3336 uschar *finalhash_hex = store_get(40);
3338 if (key_num == NULL)
3341 if (Ustrlen(key) > 64)
3344 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3345 string_cat(hash_source,&size,&offset,daystamp,3);
3346 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3347 hash_source[offset] = '\0';
3349 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3351 memset(innerkey, 0x36, 64);
3352 memset(outerkey, 0x5c, 64);
3354 for (i = 0; i < Ustrlen(key); i++)
3356 innerkey[i] ^= key[i];
3357 outerkey[i] ^= key[i];
3360 chash_start(HMAC_SHA1, use_base);
3361 chash_mid(HMAC_SHA1, use_base, innerkey);
3362 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3364 chash_start(HMAC_SHA1, use_base);
3365 chash_mid(HMAC_SHA1, use_base, outerkey);
3366 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3369 for (i = 0; i < 3; i++)
3371 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3372 *p++ = hex_digits[finalhash[i] & 0x0f];
3376 return finalhash_hex;
3382 /*************************************************
3383 * Join a file onto the output string *
3384 *************************************************/
3386 /* This is used for readfile and after a run expansion. It joins the contents
3387 of a file onto the output string, globally replacing newlines with a given
3388 string (optionally). The file is closed at the end.
3392 yield pointer to the expandable string
3393 sizep pointer to the current size
3394 ptrp pointer to the current position
3395 eol newline replacement string, or NULL
3397 Returns: new value of string pointer
3401 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3404 uschar buffer[1024];
3406 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3408 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3410 int len = Ustrlen(buffer);
3411 if (eol != NULL && buffer[len-1] == '\n') len--;
3412 yield = string_cat(yield, sizep, ptrp, buffer, len);
3413 if (buffer[len] != 0)
3414 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3417 if (yield != NULL) yield[*ptrp] = 0;
3425 /*************************************************
3426 * Evaluate numeric expression *
3427 *************************************************/
3429 /* This is a set of mutually recursive functions that evaluate an arithmetic
3430 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3431 these functions that is called from elsewhere is eval_expr, whose interface is:
3434 sptr pointer to the pointer to the string - gets updated
3435 decimal TRUE if numbers are to be assumed decimal
3436 error pointer to where to put an error message - must be NULL on input
3437 endket TRUE if ')' must terminate - FALSE for external call
3439 Returns: on success: the value of the expression, with *error still NULL
3440 on failure: an undefined value, with *error = a message
3443 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3446 static int_eximarith_t
3447 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3450 int_eximarith_t x = eval_op_or(&s, decimal, error);
3456 *error = US"expecting closing parenthesis";
3458 while (isspace(*(++s)));
3460 else if (*s != 0) *error = US"expecting operator";
3467 static int_eximarith_t
3468 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3473 while (isspace(*s)) s++;
3478 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3480 switch (tolower(*s))
3483 case 'k': n *= 1024; s++; break;
3484 case 'm': n *= 1024*1024; s++; break;
3485 case 'g': n *= 1024*1024*1024; s++; break;
3487 while (isspace (*s)) s++;
3492 n = eval_expr(&s, decimal, error, 1);
3496 *error = US"expecting number or opening parenthesis";
3504 static int_eximarith_t
3505 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3509 while (isspace(*s)) s++;
3510 if (*s == '+' || *s == '-' || *s == '~')
3513 x = eval_op_unary(&s, decimal, error);
3514 if (op == '-') x = -x;
3515 else if (op == '~') x = ~x;
3519 x = eval_number(&s, decimal, error);
3526 static int_eximarith_t
3527 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3530 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3533 while (*s == '*' || *s == '/' || *s == '%')
3536 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3537 if (*error != NULL) break;
3538 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3539 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3540 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3541 * -N*M is INT_MIN will yielf INT_MIN.
3542 * Since we don't support floating point, this is somewhat simpler.
3543 * Ideally, we'd return an error, but since we overflow for all other
3544 * arithmetic, consistency suggests otherwise, but what's the correct value
3545 * to use? There is none.
3546 * The C standard guarantees overflow for unsigned arithmetic but signed
3547 * overflow invokes undefined behaviour; in practice, this is overflow
3548 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3549 * that long/longlong larger than int are available, or we could just work
3550 * with larger types. We should consider whether to guarantee 32bit eval
3551 * and 64-bit working variables, with errors returned. For now ...
3552 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3553 * can just let the other invalid results occur otherwise, as they have
3554 * until now. For this one case, we can coerce.
3556 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3559 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3560 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3570 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3586 static int_eximarith_t
3587 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3590 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3593 while (*s == '+' || *s == '-')
3596 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3597 if (*error != NULL) break;
3598 if (op == '+') x += y; else x -= y;
3606 static int_eximarith_t
3607 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3610 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3613 while ((*s == '<' || *s == '>') && s[1] == s[0])
3618 y = eval_op_sum(&s, decimal, error);
3619 if (*error != NULL) break;
3620 if (op == '<') x <<= y; else x >>= y;
3628 static int_eximarith_t
3629 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3632 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3639 y = eval_op_shift(&s, decimal, error);
3640 if (*error != NULL) break;
3649 static int_eximarith_t
3650 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3653 int_eximarith_t x = eval_op_and(&s, decimal, error);
3660 y = eval_op_and(&s, decimal, error);
3661 if (*error != NULL) break;
3670 static int_eximarith_t
3671 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3674 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3681 y = eval_op_xor(&s, decimal, error);
3682 if (*error != NULL) break;
3692 /*************************************************
3694 *************************************************/
3696 /* Returns either an unchanged string, or the expanded string in stacking pool
3697 store. Interpreted sequences are:
3699 \... normal escaping rules
3700 $name substitutes the variable
3702 ${op:string} operates on the expanded string value
3703 ${item{arg1}{arg2}...} expands the args and then does the business
3704 some literal args are not enclosed in {}
3706 There are now far too many operators and item types to make it worth listing
3707 them here in detail any more.
3709 We use an internal routine recursively to handle embedded substrings. The
3710 external function follows. The yield is NULL if the expansion failed, and there
3711 are two cases: if something collapsed syntactically, or if "fail" was given
3712 as the action on a lookup failure. These can be distinguised by looking at the
3713 variable expand_string_forcedfail, which is TRUE in the latter case.
3715 The skipping flag is set true when expanding a substring that isn't actually
3716 going to be used (after "if" or "lookup") and it prevents lookups from
3717 happening lower down.
3719 Store usage: At start, a store block of the length of the input plus 64
3720 is obtained. This is expanded as necessary by string_cat(), which might have to
3721 get a new block, or might be able to expand the original. At the end of the
3722 function we can release any store above that portion of the yield block that
3723 was actually used. In many cases this will be optimal.
3725 However: if the first item in the expansion is a variable name or header name,
3726 we reset the store before processing it; if the result is in fresh store, we
3727 use that without copying. This is helpful for expanding strings like
3728 $message_headers which can get very long.
3730 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3731 since resetting the store at the end of the expansion will free store that was
3732 allocated by the plugin code as well as the slop after the expanded string. So
3733 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3734 and, given the acl condition, ${if }. This is an unfortunate consequence of
3735 string expansion becoming too powerful.
3738 string the string to be expanded
3739 ket_ends true if expansion is to stop at }
3740 left if not NULL, a pointer to the first character after the
3741 expansion is placed here (typically used with ket_ends)
3742 skipping TRUE for recursive calls when the value isn't actually going
3743 to be used (to allow for optimisation)
3744 honour_dollar TRUE if $ is to be expanded,
3745 FALSE if it's just another character
3746 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3749 Returns: NULL if expansion fails:
3750 expand_string_forcedfail is set TRUE if failure was forced
3751 expand_string_message contains a textual error message
3752 a pointer to the expanded string on success
3756 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3757 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3760 int size = Ustrlen(string)+ 64;
3762 uschar *yield = store_get(size);
3764 uschar *save_expand_nstring[EXPAND_MAXN+1];
3765 int save_expand_nlength[EXPAND_MAXN+1];
3766 BOOL resetok = TRUE;
3768 expand_string_forcedfail = FALSE;
3769 expand_string_message = US"";
3776 /* \ escapes the next character, which must exist, or else
3777 the expansion fails. There's a special escape, \N, which causes
3778 copying of the subject verbatim up to the next \N. Otherwise,
3779 the escapes are the standard set. */
3785 expand_string_message = US"\\ at end of string";
3792 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3793 yield = string_cat(yield, &size, &ptr, t, s - t);
3794 if (*s != 0) s += 2;
3800 ch[0] = string_interpret_escape(&s);
3802 yield = string_cat(yield, &size, &ptr, ch, 1);
3809 /* Anything other than $ is just copied verbatim, unless we are
3810 looking for a terminating } character. */
3813 if (ket_ends && *s == '}') break;
3815 if (*s != '$' || !honour_dollar)
3817 yield = string_cat(yield, &size, &ptr, s++, 1);
3821 /* No { after the $ - must be a plain name or a number for string
3822 match variable. There has to be a fudge for variables that are the
3823 names of header fields preceded by "$header_" because header field
3824 names can contain any printing characters except space and colon.
3825 For those that don't like typing this much, "$h_" is a synonym for
3826 "$header_". A non-existent header yields a NULL value; nothing is
3829 if (isalpha((*(++s))))
3834 s = read_name(name, sizeof(name), s, US"_");
3836 /* If this is the first thing to be expanded, release the pre-allocated
3839 if (ptr == 0 && yield != NULL)
3841 if (resetok) store_reset(yield);
3848 if (Ustrncmp(name, "h_", 2) == 0 ||
3849 Ustrncmp(name, "rh_", 3) == 0 ||
3850 Ustrncmp(name, "bh_", 3) == 0 ||
3851 Ustrncmp(name, "header_", 7) == 0 ||
3852 Ustrncmp(name, "rheader_", 8) == 0 ||
3853 Ustrncmp(name, "bheader_", 8) == 0)
3855 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3856 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3857 s = read_header_name(name, sizeof(name), s);
3858 value = find_header(name, FALSE, &newsize, want_raw, charset);
3860 /* If we didn't find the header, and the header contains a closing brace
3861 character, this may be a user error where the terminating colon
3862 has been omitted. Set a flag to adjust the error message in this case.
3863 But there is no error here - nothing gets inserted. */
3867 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3876 value = find_variable(name, FALSE, skipping, &newsize);
3879 expand_string_message =
3880 string_sprintf("unknown variable name \"%s\"", name);
3881 check_variable_error_message(name);
3886 /* If the data is known to be in a new buffer, newsize will be set to the
3887 size of that buffer. If this is the first thing in an expansion string,
3888 yield will be NULL; just point it at the new store instead of copying. Many
3889 expansion strings contain just one reference, so this is a useful
3890 optimization, especially for humungous headers. */
3892 len = Ustrlen(value);
3893 if (yield == NULL && newsize != 0)
3899 else yield = string_cat(yield, &size, &ptr, value, len);
3907 s = read_number(&n, s);
3908 if (n >= 0 && n <= expand_nmax)
3909 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3914 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3916 if (*s != '{') /*}*/
3918 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3922 /* After { there can be various things, but they all start with
3923 an initial word, except for a number for a string match variable. */
3925 if (isdigit((*(++s))))
3928 s = read_number(&n, s); /*{*/
3931 expand_string_message = US"} expected after number";
3934 if (n >= 0 && n <= expand_nmax)
3935 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3942 expand_string_message = US"letter or digit expected after ${"; /*}*/
3946 /* Allow "-" in names to cater for substrings with negative
3947 arguments. Since we are checking for known names after { this is
3950 s = read_name(name, sizeof(name), s, US"_-");
3951 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3955 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3956 If the ACL returns accept or reject we return content set by "message ="
3957 There is currently no limit on recursion; this would have us call
3958 acl_check_internal() directly and get a current level from somewhere.
3959 See also the acl expansion condition ECOND_ACL and the traditional
3960 acl modifier ACLC_ACL.
3961 Assume that the function has side-effects on the store that must be preserved.
3965 /* ${acl {name} {arg1}{arg2}...} */
3967 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
3970 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl", &resetok))
3972 case 1: goto EXPAND_FAILED_CURLY;
3974 case 3: goto EXPAND_FAILED;
3976 if (skipping) continue;
3979 switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
3984 debug_printf("acl expansion yield: %s\n", user_msg);
3986 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3990 expand_string_forcedfail = TRUE;
3992 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
3997 /* Handle conditionals - preserve the values of the numerical expansion
3998 variables in case they get changed by a regular expression match in the
3999 condition. If not, they retain their external settings. At the end
4000 of this "if" section, they get restored to their previous values. */
4006 int save_expand_nmax =
4007 save_expand_strings(save_expand_nstring, save_expand_nlength);
4009 while (isspace(*s)) s++;
4010 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
4011 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4014 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
4015 cond? "true" : "false");
4019 /* The handling of "yes" and "no" result strings is now in a separate
4020 function that is also used by ${lookup} and ${extract} and ${run}. */
4022 switch(process_yesno(
4023 skipping, /* were previously skipping */
4024 cond, /* success/failure indicator */
4025 lookup_value, /* value to reset for string2 */
4026 &s, /* input pointer */
4027 &yield, /* output pointer */
4028 &size, /* output size */
4029 &ptr, /* output current point */
4030 US"if", /* condition type */
4033 case 1: goto EXPAND_FAILED; /* when all is well, the */
4034 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4037 /* Restore external setting of expansion variables for continuation
4040 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4041 save_expand_nlength);
4045 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4046 expanding an internal string that isn't actually going to be used. All we
4047 need to do is check the syntax, so don't do a lookup at all. Preserve the
4048 values of the numerical expansion variables in case they get changed by a
4049 partial lookup. If not, they retain their external settings. At the end
4050 of this "lookup" section, they get restored to their previous values. */
4054 int stype, partial, affixlen, starflags;
4055 int expand_setup = 0;
4057 uschar *key, *filename, *affix;
4058 uschar *save_lookup_value = lookup_value;
4059 int save_expand_nmax =
4060 save_expand_strings(save_expand_nstring, save_expand_nlength);
4062 if ((expand_forbid & RDO_LOOKUP) != 0)
4064 expand_string_message = US"lookup expansions are not permitted";
4068 /* Get the key we are to look up for single-key+file style lookups.
4069 Otherwise set the key NULL pro-tem. */
4071 while (isspace(*s)) s++;
4072 if (*s == '{') /*}*/
4074 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4075 if (key == NULL) goto EXPAND_FAILED; /*{*/
4076 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4077 while (isspace(*s)) s++;
4081 /* Find out the type of database */
4085 expand_string_message = US"missing lookup type";
4089 /* The type is a string that may contain special characters of various
4090 kinds. Allow everything except space or { to appear; the actual content
4091 is checked by search_findtype_partial. */ /*}*/
4093 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4095 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4099 while (isspace(*s)) s++;
4101 /* Now check for the individual search type and any partial or default
4102 options. Only those types that are actually in the binary are valid. */
4104 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4108 expand_string_message = search_error_message;
4112 /* Check that a key was provided for those lookup types that need it,
4113 and was not supplied for those that use the query style. */
4115 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4119 expand_string_message = string_sprintf("missing {key} for single-"
4120 "key \"%s\" lookup", name);
4128 expand_string_message = string_sprintf("a single key was given for "
4129 "lookup type \"%s\", which is not a single-key lookup type", name);
4134 /* Get the next string in brackets and expand it. It is the file name for
4135 single-key+file lookups, and the whole query otherwise. In the case of
4136 queries that also require a file name (e.g. sqlite), the file name comes
4139 if (*s != '{') goto EXPAND_FAILED_CURLY;
4140 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4141 if (filename == NULL) goto EXPAND_FAILED;
4142 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4143 while (isspace(*s)) s++;
4145 /* If this isn't a single-key+file lookup, re-arrange the variables
4146 to be appropriate for the search_ functions. For query-style lookups,
4147 there is just a "key", and no file name. For the special query-style +
4148 file types, the query (i.e. "key") starts with a file name. */
4152 while (isspace(*filename)) filename++;
4155 if (mac_islookup(stype, lookup_querystyle))
4161 if (*filename != '/')
4163 expand_string_message = string_sprintf(
4164 "absolute file name expected for \"%s\" lookup", name);
4167 while (*key != 0 && !isspace(*key)) key++;
4168 if (*key != 0) *key++ = 0;
4172 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4173 the entry was not found. Note that there is no search_close() function.
4174 Files are left open in case of re-use. At suitable places in higher logic,
4175 search_tidyup() is called to tidy all open files. This can save opening
4176 the same file several times. However, files may also get closed when
4177 others are opened, if too many are open at once. The rule is that a
4178 handle should not be used after a second search_open().
4180 Request that a partial search sets up $1 and maybe $2 by passing
4181 expand_setup containing zero. If its value changes, reset expand_nmax,
4182 since new variables will have been set. Note that at the end of this
4183 "lookup" section, the old numeric variables are restored. */
4186 lookup_value = NULL;
4189 void *handle = search_open(filename, stype, 0, NULL, NULL);
4192 expand_string_message = search_error_message;
4195 lookup_value = search_find(handle, filename, key, partial, affix,
4196 affixlen, starflags, &expand_setup);
4197 if (search_find_defer)
4199 expand_string_message =
4200 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4201 string_printing2(key, FALSE), search_error_message);
4204 if (expand_setup > 0) expand_nmax = expand_setup;
4207 /* The handling of "yes" and "no" result strings is now in a separate
4208 function that is also used by ${if} and ${extract}. */
4210 switch(process_yesno(
4211 skipping, /* were previously skipping */
4212 lookup_value != NULL, /* success/failure indicator */
4213 save_lookup_value, /* value to reset for string2 */
4214 &s, /* input pointer */
4215 &yield, /* output pointer */
4216 &size, /* output size */
4217 &ptr, /* output current point */
4218 US"lookup", /* condition type */
4221 case 1: goto EXPAND_FAILED; /* when all is well, the */
4222 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4225 /* Restore external setting of expansion variables for carrying on
4226 at this level, and continue. */
4228 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4229 save_expand_nlength);
4233 /* If Perl support is configured, handle calling embedded perl subroutines,
4234 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4235 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4236 arguments (defined below). */
4238 #define EXIM_PERL_MAX_ARGS 8
4242 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4243 "is not included in this binary";
4246 #else /* EXIM_PERL */
4248 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4251 if ((expand_forbid & RDO_PERL) != 0)
4253 expand_string_message = US"Perl calls are not permitted";
4257 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4258 US"perl", &resetok))
4260 case 1: goto EXPAND_FAILED_CURLY;
4262 case 3: goto EXPAND_FAILED;
4265 /* If skipping, we don't actually do anything */
4267 if (skipping) continue;
4269 /* Start the interpreter if necessary */
4271 if (!opt_perl_started)
4274 if (opt_perl_startup == NULL)
4276 expand_string_message = US"A setting of perl_startup is needed when "
4277 "using the Perl interpreter";
4280 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4281 initerror = init_perl(opt_perl_startup);
4282 if (initerror != NULL)
4284 expand_string_message =
4285 string_sprintf("error in perl_startup code: %s\n", initerror);
4288 opt_perl_started = TRUE;
4291 /* Call the function */
4293 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4294 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4295 sub_arg[0], sub_arg + 1);
4297 /* NULL yield indicates failure; if the message pointer has been set to
4298 NULL, the yield was undef, indicating a forced failure. Otherwise the
4299 message will indicate some kind of Perl error. */
4301 if (new_yield == NULL)
4303 if (expand_string_message == NULL)
4305 expand_string_message =
4306 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4307 "failure", sub_arg[0]);
4308 expand_string_forcedfail = TRUE;
4313 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4314 set during a callback from Perl. */
4316 expand_string_forcedfail = FALSE;
4320 #endif /* EXIM_PERL */
4322 /* Transform email address to "prvs" scheme to use
4323 as BATV-signed return path */
4330 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4332 case 1: goto EXPAND_FAILED_CURLY;
4334 case 3: goto EXPAND_FAILED;
4337 /* If skipping, we don't actually do anything */
4338 if (skipping) continue;
4340 /* sub_arg[0] is the address */
4341 domain = Ustrrchr(sub_arg[0],'@');
4342 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4344 expand_string_message = US"prvs first argument must be a qualified email address";
4348 /* Calculate the hash. The second argument must be a single-digit
4349 key number, or unset. */
4351 if (sub_arg[2] != NULL &&
4352 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4354 expand_string_message = US"prvs second argument must be a single digit";
4358 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4361 expand_string_message = US"prvs hmac-sha1 conversion failed";
4365 /* Now separate the domain from the local part */
4368 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4369 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4370 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4371 string_cat(yield,&size,&ptr,p,6);
4372 string_cat(yield,&size,&ptr,US"=",1);
4373 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4374 string_cat(yield,&size,&ptr,US"@",1);
4375 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4380 /* Check a prvs-encoded address for validity */
4382 case EITEM_PRVSCHECK:
4385 int mysize = 0, myptr = 0;
4389 /* TF: Ugliness: We want to expand parameter 1 first, then set
4390 up expansion variables that are used in the expansion of
4391 parameter 2. So we clone the string for the first
4392 expansion, where we only expand parameter 1.
4394 PH: Actually, that isn't necessary. The read_subs() function is
4395 designed to work this way for the ${if and ${lookup expansions. I've
4399 /* Reset expansion variables */
4400 prvscheck_result = NULL;
4401 prvscheck_address = NULL;
4402 prvscheck_keynum = NULL;
4404 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4406 case 1: goto EXPAND_FAILED_CURLY;
4408 case 3: goto EXPAND_FAILED;
4411 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4414 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4416 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4417 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4418 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4419 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4420 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4422 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4423 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4424 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4425 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4426 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4428 /* Set up expansion variables */
4429 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4430 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4431 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4432 prvscheck_address[myptr] = '\0';
4433 prvscheck_keynum = string_copy(key_num);
4435 /* Now expand the second argument */
4436 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4438 case 1: goto EXPAND_FAILED_CURLY;
4440 case 3: goto EXPAND_FAILED;
4443 /* Now we have the key and can check the address. */
4445 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4450 expand_string_message = US"hmac-sha1 conversion failed";
4454 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4455 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4457 if (Ustrcmp(p,hash) == 0)
4459 /* Success, valid BATV address. Now check the expiry date. */
4460 uschar *now = prvs_daystamp(0);
4461 unsigned int inow = 0,iexpire = 1;
4463 (void)sscanf(CS now,"%u",&inow);
4464 (void)sscanf(CS daystamp,"%u",&iexpire);
4466 /* When "iexpire" is < 7, a "flip" has occured.
4467 Adjust "inow" accordingly. */
4468 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4470 if (iexpire >= inow)
4472 prvscheck_result = US"1";
4473 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4477 prvscheck_result = NULL;
4478 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4483 prvscheck_result = NULL;
4484 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4487 /* Now expand the final argument. We leave this till now so that
4488 it can include $prvscheck_result. */
4490 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4492 case 1: goto EXPAND_FAILED_CURLY;
4494 case 3: goto EXPAND_FAILED;
4497 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4498 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4500 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4502 /* Reset the "internal" variables afterwards, because they are in
4503 dynamic store that will be reclaimed if the expansion succeeded. */
4505 prvscheck_address = NULL;
4506 prvscheck_keynum = NULL;
4510 /* Does not look like a prvs encoded address, return the empty string.
4511 We need to make sure all subs are expanded first, so as to skip over
4514 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4516 case 1: goto EXPAND_FAILED_CURLY;
4518 case 3: goto EXPAND_FAILED;
4525 /* Handle "readfile" to insert an entire file */
4527 case EITEM_READFILE:
4532 if ((expand_forbid & RDO_READFILE) != 0)
4534 expand_string_message = US"file insertions are not permitted";
4538 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4540 case 1: goto EXPAND_FAILED_CURLY;
4542 case 3: goto EXPAND_FAILED;
4545 /* If skipping, we don't actually do anything */
4547 if (skipping) continue;
4549 /* Open the file and read it */
4551 f = Ufopen(sub_arg[0], "rb");
4554 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4558 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4563 /* Handle "readsocket" to insert data from a Unix domain socket */
4565 case EITEM_READSOCK:
4571 struct sockaddr_un sockun; /* don't call this "sun" ! */
4575 if ((expand_forbid & RDO_READSOCK) != 0)
4577 expand_string_message = US"socket insertions are not permitted";
4581 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4582 because there may be a string for expansion on failure. */
4584 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4586 case 1: goto EXPAND_FAILED_CURLY;
4587 case 2: /* Won't occur: no end check */
4588 case 3: goto EXPAND_FAILED;
4591 /* Sort out timeout, if given */
4593 if (sub_arg[2] != NULL)
4595 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4598 expand_string_message = string_sprintf("bad time value %s",
4603 else sub_arg[3] = NULL; /* No eol if no timeout */
4605 /* If skipping, we don't actually do anything. Otherwise, arrange to
4606 connect to either an IP or a Unix socket. */
4610 /* Handle an IP (internet) domain */
4612 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4615 uschar *server_name = sub_arg[0] + 5;
4616 uschar *port_name = Ustrrchr(server_name, ':');
4618 /* Sort out the port */
4620 if (port_name == NULL)
4622 expand_string_message =
4623 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4626 *port_name++ = 0; /* Terminate server name */
4628 if (isdigit(*port_name))
4631 port = Ustrtol(port_name, &end, 0);
4632 if (end != port_name + Ustrlen(port_name))
4634 expand_string_message =
4635 string_sprintf("invalid port number %s", port_name);
4641 struct servent *service_info = getservbyname(CS port_name, "tcp");
4642 if (service_info == NULL)
4644 expand_string_message = string_sprintf("unknown port \"%s\"",
4648 port = ntohs(service_info->s_port);
4651 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4652 timeout, NULL, &expand_string_message)) < 0)
4656 /* Handle a Unix domain socket */
4661 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4663 expand_string_message = string_sprintf("failed to create socket: %s",
4668 sockun.sun_family = AF_UNIX;
4669 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4672 sigalrm_seen = FALSE;
4674 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4678 expand_string_message = US "socket connect timed out";
4683 expand_string_message = string_sprintf("failed to connect to socket "
4684 "%s: %s", sub_arg[0], strerror(errno));
4689 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4691 /* Allow sequencing of test actions */
4692 if (running_in_test_harness) millisleep(100);
4694 /* Write the request string, if not empty */
4696 if (sub_arg[1][0] != 0)
4698 int len = Ustrlen(sub_arg[1]);
4699 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4701 if (write(fd, sub_arg[1], len) != len)
4703 expand_string_message = string_sprintf("request write to socket "
4704 "failed: %s", strerror(errno));
4709 /* Shut down the sending side of the socket. This helps some servers to
4710 recognise that it is their turn to do some work. Just in case some
4711 system doesn't have this function, make it conditional. */
4714 shutdown(fd, SHUT_WR);
4717 if (running_in_test_harness) millisleep(100);
4719 /* Now we need to read from the socket, under a timeout. The function
4720 that reads a file can be used. */
4722 f = fdopen(fd, "rb");
4723 sigalrm_seen = FALSE;
4725 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4729 /* After a timeout, we restore the pointer in the result, that is,
4730 make sure we add nothing from the socket. */
4735 expand_string_message = US "socket read timed out";
4740 /* The whole thing has worked (or we were skipping). If there is a
4741 failure string following, we need to skip it. */
4745 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4747 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4748 while (isspace(*s)) s++;
4750 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4753 /* Come here on failure to create socket, connect socket, write to the
4754 socket, or timeout on reading. If another substring follows, expand and
4755 use it. Otherwise, those conditions give expand errors. */
4758 if (*s != '{') goto EXPAND_FAILED;
4759 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4760 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4761 if (arg == NULL) goto EXPAND_FAILED;
4762 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4763 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4764 while (isspace(*s)) s++;
4765 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4769 /* Handle "run" to execute a program. */
4781 if ((expand_forbid & RDO_RUN) != 0)
4783 expand_string_message = US"running a command is not permitted";
4787 while (isspace(*s)) s++;
4788 if (*s != '{') goto EXPAND_FAILED_CURLY;
4789 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4790 if (arg == NULL) goto EXPAND_FAILED;
4791 while (isspace(*s)) s++;
4792 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4794 if (skipping) /* Just pretend it worked when we're skipping */
4800 if (!transport_set_up_command(&argv, /* anchor for arg list */
4801 arg, /* raw command */
4802 FALSE, /* don't expand the arguments */
4803 0, /* not relevant when... */
4804 NULL, /* no transporting address */
4805 US"${run} expansion", /* for error messages */
4806 &expand_string_message)) /* where to put error message */
4811 /* Create the child process, making it a group leader. */
4813 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4817 expand_string_message =
4818 string_sprintf("couldn't create child process: %s", strerror(errno));
4822 /* Nothing is written to the standard input. */
4826 /* Read the pipe to get the command's output into $value (which is kept
4827 in lookup_value). Read during execution, so that if the output exceeds
4828 the OS pipe buffer limit, we don't block forever. */
4830 f = fdopen(fd_out, "rb");
4831 sigalrm_seen = FALSE;
4833 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4837 /* Wait for the process to finish, applying the timeout, and inspect its
4838 return code for serious disasters. Simple non-zero returns are passed on.
4841 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4843 if (sigalrm_seen == TRUE || runrc == -256)
4845 expand_string_message = string_sprintf("command timed out");
4846 killpg(pid, SIGKILL); /* Kill the whole process group */
4849 else if (runrc == -257)
4850 expand_string_message = string_sprintf("wait() failed: %s",
4854 expand_string_message = string_sprintf("command killed by signal %d",
4861 /* Process the yes/no strings; $value may be useful in both cases */
4863 switch(process_yesno(
4864 skipping, /* were previously skipping */
4865 runrc == 0, /* success/failure indicator */
4866 lookup_value, /* value to reset for string2 */
4867 &s, /* input pointer */
4868 &yield, /* output pointer */
4869 &size, /* output size */
4870 &ptr, /* output current point */
4871 US"run", /* condition type */
4874 case 1: goto EXPAND_FAILED; /* when all is well, the */
4875 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4881 /* Handle character translation for "tr" */
4889 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4891 case 1: goto EXPAND_FAILED_CURLY;
4893 case 3: goto EXPAND_FAILED;
4896 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4897 o2m = Ustrlen(sub[2]) - 1;
4899 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4901 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4905 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4912 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4913 expanded arguments. */
4923 int val[2] = { 0, -1 };
4926 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4927 Ensure that sub[2] is set in the ${length } case. */
4930 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4931 TRUE, name, &resetok))
4933 case 1: goto EXPAND_FAILED_CURLY;
4935 case 3: goto EXPAND_FAILED;
4938 /* Juggle the arguments if there are only two of them: always move the
4939 string to the last position and make ${length{n}{str}} equivalent to
4940 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4946 if (item_type == EITEM_LENGTH)
4953 for (i = 0; i < 2; i++)
4955 if (sub[i] == NULL) continue;
4956 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4957 if (*ret != 0 || (i != 0 && val[i] < 0))
4959 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4960 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4966 (item_type == EITEM_HASH)?
4967 compute_hash(sub[2], val[0], val[1], &len) :
4968 (item_type == EITEM_NHASH)?
4969 compute_nhash(sub[2], val[0], val[1], &len) :
4970 extract_substr(sub[2], val[0], val[1], &len);
4972 if (ret == NULL) goto EXPAND_FAILED;
4973 yield = string_cat(yield, &size, &ptr, ret, len);
4977 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4978 This code originally contributed by Steve Haslam. It currently supports
4979 the use of MD5 and SHA-1 hashes.
4981 We need some workspace that is large enough to handle all the supported
4982 hash types. Use macros to set the sizes rather than be too elaborate. */
4984 #define MAX_HASHLEN 20
4985 #define MAX_HASHBLOCKLEN 64
4994 int hashlen; /* Number of octets for the hash algorithm's output */
4995 int hashblocklen; /* Number of octets the hash algorithm processes */
4997 unsigned int keylen;
4999 uschar keyhash[MAX_HASHLEN];
5000 uschar innerhash[MAX_HASHLEN];
5001 uschar finalhash[MAX_HASHLEN];
5002 uschar finalhash_hex[2*MAX_HASHLEN];
5003 uschar innerkey[MAX_HASHBLOCKLEN];
5004 uschar outerkey[MAX_HASHBLOCKLEN];
5006 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5008 case 1: goto EXPAND_FAILED_CURLY;
5010 case 3: goto EXPAND_FAILED;
5013 if (Ustrcmp(sub[0], "md5") == 0)
5016 use_base = &md5_base;
5020 else if (Ustrcmp(sub[0], "sha1") == 0)
5023 use_base = &sha1_base;
5029 expand_string_message =
5030 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5035 keylen = Ustrlen(keyptr);
5037 /* If the key is longer than the hash block length, then hash the key
5040 if (keylen > hashblocklen)
5042 chash_start(type, use_base);
5043 chash_end(type, use_base, keyptr, keylen, keyhash);
5048 /* Now make the inner and outer key values */
5050 memset(innerkey, 0x36, hashblocklen);
5051 memset(outerkey, 0x5c, hashblocklen);
5053 for (i = 0; i < keylen; i++)
5055 innerkey[i] ^= keyptr[i];
5056 outerkey[i] ^= keyptr[i];
5059 /* Now do the hashes */
5061 chash_start(type, use_base);
5062 chash_mid(type, use_base, innerkey);
5063 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5065 chash_start(type, use_base);
5066 chash_mid(type, use_base, outerkey);
5067 chash_end(type, use_base, innerhash, hashlen, finalhash);
5069 /* Encode the final hash as a hex string */
5072 for (i = 0; i < hashlen; i++)
5074 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5075 *p++ = hex_digits[finalhash[i] & 0x0f];
5078 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5079 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5081 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5086 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5087 We have to save the numerical variables and restore them afterwards. */
5092 int moffset, moffsetextra, slen;
5095 const uschar *rerror;
5098 int save_expand_nmax =
5099 save_expand_strings(save_expand_nstring, save_expand_nlength);
5101 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5103 case 1: goto EXPAND_FAILED_CURLY;
5105 case 3: goto EXPAND_FAILED;
5108 /* Compile the regular expression */
5110 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5115 expand_string_message = string_sprintf("regular expression error in "
5116 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5120 /* Now run a loop to do the substitutions as often as necessary. It ends
5121 when there are no more matches. Take care over matches of the null string;
5122 do the same thing as Perl does. */
5125 slen = Ustrlen(sub[0]);
5126 moffset = moffsetextra = 0;
5131 int ovector[3*(EXPAND_MAXN+1)];
5132 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5133 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
5137 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5138 is not necessarily the end. We want to repeat the match from one
5139 character further along, but leaving the basic offset the same (for
5140 copying below). We can't be at the end of the string - that was checked
5141 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5142 finished; copy the remaining string and end the loop. */
5152 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5156 /* Match - set up for expanding the replacement. */
5158 if (n == 0) n = EXPAND_MAXN + 1;
5160 for (nn = 0; nn < n*2; nn += 2)
5162 expand_nstring[expand_nmax] = subject + ovector[nn];
5163 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5167 /* Copy the characters before the match, plus the expanded insertion. */
5169 yield = string_cat(yield, &size, &ptr, subject + moffset,
5170 ovector[0] - moffset);
5171 insert = expand_string(sub[2]);
5172 if (insert == NULL) goto EXPAND_FAILED;
5173 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5175 moffset = ovector[1];
5179 /* If we have matched an empty string, first check to see if we are at
5180 the end of the subject. If so, the loop is over. Otherwise, mimic
5181 what Perl's /g options does. This turns out to be rather cunning. First
5182 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5183 string at the same point. If this fails (picked up above) we advance to
5184 the next character. */
5186 if (ovector[0] == ovector[1])
5188 if (ovector[0] == slen) break;
5189 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5193 /* All done - restore numerical variables. */
5195 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5196 save_expand_nlength);
5200 /* Handle keyed and numbered substring extraction. If the first argument
5201 consists entirely of digits, then a numerical extraction is assumed. */
5207 int field_number = 1;
5208 BOOL field_number_set = FALSE;
5209 uschar *save_lookup_value = lookup_value;
5211 int save_expand_nmax =
5212 save_expand_strings(save_expand_nstring, save_expand_nlength);
5214 /* Read the arguments */
5216 for (i = 0; i < j; i++)
5218 while (isspace(*s)) s++;
5219 if (*s == '{') /*}*/
5221 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5222 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5223 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5225 /* After removal of leading and trailing white space, the first
5226 argument must not be empty; if it consists entirely of digits
5227 (optionally preceded by a minus sign), this is a numerical
5228 extraction, and we expect 3 arguments. */
5236 while (isspace(*p)) p++;
5240 while (len > 0 && isspace(p[len-1])) len--;
5247 expand_string_message = US"first argument of \"extract\" must "
5257 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5261 j = 3; /* Need 3 args */
5262 field_number_set = TRUE;
5267 else goto EXPAND_FAILED_CURLY;
5270 /* Extract either the numbered or the keyed substring into $value. If
5271 skipping, just pretend the extraction failed. */
5273 lookup_value = skipping? NULL : field_number_set?
5274 expand_gettokened(field_number, sub[1], sub[2]) :
5275 expand_getkeyed(sub[0], sub[1]);
5277 /* If no string follows, $value gets substituted; otherwise there can
5278 be yes/no strings, as for lookup or if. */
5280 switch(process_yesno(
5281 skipping, /* were previously skipping */
5282 lookup_value != NULL, /* success/failure indicator */
5283 save_lookup_value, /* value to reset for string2 */
5284 &s, /* input pointer */
5285 &yield, /* output pointer */
5286 &size, /* output size */
5287 &ptr, /* output current point */
5288 US"extract", /* condition type */
5291 case 1: goto EXPAND_FAILED; /* when all is well, the */
5292 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5295 /* All done - restore numerical variables. */
5297 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5298 save_expand_nlength);
5303 /* return the Nth item from a list */
5305 case EITEM_LISTEXTRACT:
5308 int field_number = 1;
5309 uschar *save_lookup_value = lookup_value;
5311 int save_expand_nmax =
5312 save_expand_strings(save_expand_nstring, save_expand_nlength);
5314 /* Read the field & list arguments */
5316 for (i = 0; i < 2; i++)
5318 while (isspace(*s)) s++;
5319 if (*s != '{') /*}*/
5320 goto EXPAND_FAILED_CURLY;
5322 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5323 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5324 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5326 /* After removal of leading and trailing white space, the first
5327 argument must be numeric and nonempty. */
5335 while (isspace(*p)) p++;
5339 while (len > 0 && isspace(p[len-1])) len--;
5342 if (!*p && !skipping)
5344 expand_string_message = US"first argument of \"listextract\" must "
5354 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5357 expand_string_message = US"first argument of \"listextract\" must "
5365 /* Extract the numbered element into $value. If
5366 skipping, just pretend the extraction failed. */
5368 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5370 /* If no string follows, $value gets substituted; otherwise there can
5371 be yes/no strings, as for lookup or if. */
5373 switch(process_yesno(
5374 skipping, /* were previously skipping */
5375 lookup_value != NULL, /* success/failure indicator */
5376 save_lookup_value, /* value to reset for string2 */
5377 &s, /* input pointer */
5378 &yield, /* output pointer */
5379 &size, /* output size */
5380 &ptr, /* output current point */
5381 US"extract", /* condition type */
5384 case 1: goto EXPAND_FAILED; /* when all is well, the */
5385 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5388 /* All done - restore numerical variables. */
5390 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5391 save_expand_nlength);
5397 case EITEM_CERTEXTRACT:
5399 uschar *save_lookup_value = lookup_value;
5401 int save_expand_nmax =
5402 save_expand_strings(save_expand_nstring, save_expand_nlength);
5404 /* Read the field argument */
5405 while (isspace(*s)) s++;
5406 if (*s != '{') /*}*/
5407 goto EXPAND_FAILED_CURLY;
5408 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5409 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5410 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5411 /* strip spaces fore & aft */
5416 while (isspace(*p)) p++;
5420 while (len > 0 && isspace(p[len-1])) len--;
5424 /* inspect the cert argument */
5425 while (isspace(*s)) s++;
5426 if (*s != '{') /*}*/
5427 goto EXPAND_FAILED_CURLY;
5430 expand_string_message = US"second argument of \"certextract\" must "
5431 "be a certificate variable";
5434 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5435 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5436 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5439 lookup_value = NULL;
5442 lookup_value = expand_getcertele(sub[0], sub[1]);
5443 if (*expand_string_message) goto EXPAND_FAILED;
5445 switch(process_yesno(
5446 skipping, /* were previously skipping */
5447 lookup_value != NULL, /* success/failure indicator */
5448 save_lookup_value, /* value to reset for string2 */
5449 &s, /* input pointer */
5450 &yield, /* output pointer */
5451 &size, /* output size */
5452 &ptr, /* output current point */
5453 US"extract", /* condition type */
5456 case 1: goto EXPAND_FAILED; /* when all is well, the */
5457 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5460 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5461 save_expand_nlength);
5464 #endif /*SUPPORT_TLS*/
5466 /* Handle list operations */
5474 uschar outsep[2] = { '\0', '\0' };
5475 uschar *list, *expr, *temp;
5476 uschar *save_iterate_item = iterate_item;
5477 uschar *save_lookup_value = lookup_value;
5479 while (isspace(*s)) s++;
5480 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5482 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5483 if (list == NULL) goto EXPAND_FAILED;
5484 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5486 if (item_type == EITEM_REDUCE)
5488 while (isspace(*s)) s++;
5489 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5490 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5491 if (temp == NULL) goto EXPAND_FAILED;
5492 lookup_value = temp;
5493 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5496 while (isspace(*s)) s++;
5497 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5501 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5502 if scanning a "false" part). This allows us to find the end of the
5503 condition, because if the list is empty, we won't actually evaluate the
5504 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5505 the normal internal expansion function. */
5507 if (item_type == EITEM_FILTER)
5509 temp = eval_condition(expr, &resetok, NULL);
5510 if (temp != NULL) s = temp;
5514 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5519 expand_string_message = string_sprintf("%s inside \"%s\" item",
5520 expand_string_message, name);
5524 while (isspace(*s)) s++;
5527 expand_string_message = string_sprintf("missing } at end of condition "
5528 "or expression inside \"%s\"", name);
5532 while (isspace(*s)) s++; /*{*/
5535 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5540 /* If we are skipping, we can now just move on to the next item. When
5541 processing for real, we perform the iteration. */
5543 if (skipping) continue;
5544 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5546 *outsep = (uschar)sep; /* Separator as a string */
5548 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5550 if (item_type == EITEM_FILTER)
5553 if (eval_condition(expr, &resetok, &condresult) == NULL)
5555 iterate_item = save_iterate_item;
5556 lookup_value = save_lookup_value;
5557 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5558 expand_string_message, name);
5561 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5562 condresult? "true":"false");
5564 temp = iterate_item; /* TRUE => include this item */
5566 continue; /* FALSE => skip this item */
5569 /* EITEM_MAP and EITEM_REDUCE */
5573 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5576 iterate_item = save_iterate_item;
5577 expand_string_message = string_sprintf("%s inside \"%s\" item",
5578 expand_string_message, name);
5581 if (item_type == EITEM_REDUCE)
5583 lookup_value = temp; /* Update the value of $value */
5584 continue; /* and continue the iteration */
5588 /* We reach here for FILTER if the condition is true, always for MAP,
5589 and never for REDUCE. The value in "temp" is to be added to the output
5590 list that is being created, ensuring that any occurrences of the
5591 separator character are doubled. Unless we are dealing with the first
5592 item of the output list, add in a space if the new item begins with the
5593 separator character, or is an empty string. */
5595 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5596 yield = string_cat(yield, &size, &ptr, US" ", 1);
5598 /* Add the string in "temp" to the output list that we are building,
5599 This is done in chunks by searching for the separator character. */
5603 size_t seglen = Ustrcspn(temp, outsep);
5604 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5606 /* If we got to the end of the string we output one character
5607 too many; backup and end the loop. Otherwise arrange to double the
5610 if (temp[seglen] == '\0') { ptr--; break; }
5611 yield = string_cat(yield, &size, &ptr, outsep, 1);
5615 /* Output a separator after the string: we will remove the redundant
5616 final one at the end. */
5618 yield = string_cat(yield, &size, &ptr, outsep, 1);
5619 } /* End of iteration over the list loop */
5621 /* REDUCE has generated no output above: output the final value of
5624 if (item_type == EITEM_REDUCE)
5626 yield = string_cat(yield, &size, &ptr, lookup_value,
5627 Ustrlen(lookup_value));
5628 lookup_value = save_lookup_value; /* Restore $value */
5631 /* FILTER and MAP generate lists: if they have generated anything, remove
5632 the redundant final separator. Even though an empty item at the end of a
5633 list does not count, this is tidier. */
5635 else if (ptr != save_ptr) ptr--;
5637 /* Restore preserved $item */
5639 iterate_item = save_iterate_item;
5646 uschar *srclist, *cmp, *xtract;
5648 uschar *dstlist = NULL;
5649 uschar *dstkeylist = NULL;
5651 uschar *save_iterate_item = iterate_item;
5653 while (isspace(*s)) s++;
5654 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5656 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5657 if (!srclist) goto EXPAND_FAILED;
5658 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5660 while (isspace(*s)) s++;
5661 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5663 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5664 if (!cmp) goto EXPAND_FAILED;
5665 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5667 while (isspace(*s)) s++;
5668 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5671 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5672 if (!tmp) goto EXPAND_FAILED;
5673 xtract = string_copyn(xtract, s - xtract);
5675 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5679 expand_string_message = US"missing } at end of \"sort\"";
5683 if (skipping) continue;
5685 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5688 uschar * newlist = NULL;
5689 uschar * newkeylist = NULL;
5692 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, srcitem);
5694 /* extract field for comparisons */
5695 iterate_item = srcitem;
5696 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5700 expand_string_message = string_sprintf(
5701 "field-extract in sort: \"%s\"", xtract);
5705 /* Insertion sort */
5707 /* copy output list until new-item < list-item */
5708 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5714 /* field for comparison */
5715 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5718 /* build and run condition string */
5719 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
5721 DEBUG(D_expand) debug_printf("%s: cond = \"%s\"\n", name, expr);
5722 if (!eval_condition(expr, &resetok, &before))
5724 expand_string_message = string_sprintf("comparison in sort: %s",
5731 /* New-item sorts before this dst-item. Append new-item,
5732 then dst-item, then remainder of dst list. */
5734 newlist = string_append_listele(newlist, sep, srcitem);
5735 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5738 newlist = string_append_listele(newlist, sep, dstitem);
5739 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5741 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5743 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5745 newlist = string_append_listele(newlist, sep, dstitem);
5746 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5752 newlist = string_append_listele(newlist, sep, dstitem);
5753 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5756 /* If we ran out of dstlist without consuming srcitem, append it */
5759 newlist = string_append_listele(newlist, sep, srcitem);
5760 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5764 dstkeylist = newkeylist;
5766 DEBUG(D_expand) debug_printf("%s: dstlist = \"%s\"\n", name, dstlist);
5767 DEBUG(D_expand) debug_printf("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
5771 yield = string_cat(yield, &size, &ptr, dstlist, Ustrlen(dstlist));
5773 /* Restore preserved $item */
5774 iterate_item = save_iterate_item;
5778 expand_string_message = US"Internal error in sort (list mismatch)";
5783 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5784 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5785 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5786 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5788 #define EXPAND_DLFUNC_MAX_ARGS 8
5791 #ifndef EXPAND_DLFUNC
5792 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5793 "is not included in this binary";
5796 #else /* EXPAND_DLFUNC */
5799 exim_dlfunc_t *func;
5802 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5804 if ((expand_forbid & RDO_DLFUNC) != 0)
5806 expand_string_message =
5807 US"dynamically-loaded functions are not permitted";
5811 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5812 TRUE, US"dlfunc", &resetok))
5814 case 1: goto EXPAND_FAILED_CURLY;
5816 case 3: goto EXPAND_FAILED;
5819 /* If skipping, we don't actually do anything */
5821 if (skipping) continue;
5823 /* Look up the dynamically loaded object handle in the tree. If it isn't
5824 found, dlopen() the file and put the handle in the tree for next time. */
5826 t = tree_search(dlobj_anchor, argv[0]);
5829 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5832 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5833 argv[0], dlerror());
5834 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5837 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5838 Ustrcpy(t->name, argv[0]);
5839 t->data.ptr = handle;
5840 (void)tree_insertnode(&dlobj_anchor, t);
5843 /* Having obtained the dynamically loaded object handle, look up the
5844 function pointer. */
5846 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5849 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5850 "%s", argv[1], argv[0], dlerror());
5851 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5855 /* Call the function and work out what to do with the result. If it
5856 returns OK, we have a replacement string; if it returns DEFER then
5857 expansion has failed in a non-forced manner; if it returns FAIL then
5858 failure was forced; if it returns ERROR or any other value there's a
5859 problem, so panic slightly. In any case, assume that the function has
5860 side-effects on the store that must be preserved. */
5864 for (argc = 0; argv[argc] != NULL; argc++);
5865 status = func(&result, argc - 2, &argv[2]);
5868 if (result == NULL) result = US"";
5869 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5874 expand_string_message = result == NULL ? US"(no message)" : result;
5875 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5876 else if(status != FAIL)
5877 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5878 argv[0], argv[1], status, expand_string_message);
5882 #endif /* EXPAND_DLFUNC */
5883 } /* EITEM_* switch */
5885 /* Control reaches here if the name is not recognized as one of the more
5886 complicated expansion items. Check for the "operator" syntax (name terminated
5887 by a colon). Some of the operators have arguments, separated by _ from the
5895 var_entry *vp = NULL;
5897 /* Owing to an historical mis-design, an underscore may be part of the
5898 operator name, or it may introduce arguments. We therefore first scan the
5899 table of names that contain underscores. If there is no match, we cut off
5900 the arguments and then scan the main table. */
5902 if ((c = chop_match(name, op_table_underscore,
5903 sizeof(op_table_underscore)/sizeof(uschar *))) < 0)
5905 arg = Ustrchr(name, '_');
5906 if (arg != NULL) *arg = 0;
5907 c = chop_match(name, op_table_main,
5908 sizeof(op_table_main)/sizeof(uschar *));
5909 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5910 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5913 /* Deal specially with operators that might take a certificate variable
5914 as we do not want to do the usual expansion. For most, expand the string.*/
5924 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
5926 if (!sub) goto EXPAND_FAILED; /*{*/
5927 if (*s1 != '}') goto EXPAND_FAILED_CURLY;
5928 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
5938 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5939 if (!sub) goto EXPAND_FAILED;
5944 /* If we are skipping, we don't need to perform the operation at all.
5945 This matters for operations like "mask", because the data may not be
5946 in the correct format when skipping. For example, the expression may test
5947 for the existence of $sender_host_address before trying to mask it. For
5948 other operations, doing them may not fail, but it is a waste of time. */
5950 if (skipping && c >= 0) continue;
5952 /* Otherwise, switch on the operator type */
5959 unsigned long int n = Ustrtoul(sub, &t, 10);
5962 expand_string_message = string_sprintf("argument for base62 "
5963 "operator is \"%s\", which is not a decimal number", sub);
5966 t = string_base62(n);
5967 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5971 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5977 unsigned long int n = 0;
5980 uschar *t = Ustrchr(base62_chars, *tt++);
5983 expand_string_message = string_sprintf("argument for base62d "
5984 "operator is \"%s\", which is not a base %d number", sub,
5988 n = n * BASE_62 + (t - base62_chars);
5990 (void)sprintf(CS buf, "%ld", n);
5991 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5997 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
5998 if (expanded == NULL)
6000 expand_string_message =
6001 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6002 expand_string_message);
6005 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
6012 uschar *t = sub - 1;
6013 while (*(++t) != 0) { *t = tolower(*t); count++; }
6014 yield = string_cat(yield, &size, &ptr, sub, count);
6021 uschar *t = sub - 1;
6022 while (*(++t) != 0) { *t = toupper(*t); count++; }
6023 yield = string_cat(yield, &size, &ptr, sub, count);
6029 if (vp && *(void **)vp->value)
6031 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6032 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6042 md5_end(&base, sub, Ustrlen(sub), digest);
6043 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6044 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6050 if (vp && *(void **)vp->value)
6052 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6053 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6063 sha1_end(&base, sub, Ustrlen(sub), digest);
6064 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6065 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6071 if (vp && *(void **)vp->value)
6073 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6074 yield = string_cat(yield, &size, &ptr, cp, (int)Ustrlen(cp));
6078 expand_string_message = US"sha256 only supported for certificates";
6081 /* Convert hex encoding to base64 encoding */
6091 for (enc = sub; *enc != 0; enc++)
6093 if (!isxdigit(*enc))
6095 expand_string_message = string_sprintf("\"%s\" is not a hex "
6104 expand_string_message = string_sprintf("\"%s\" contains an odd "
6105 "number of characters", sub);
6109 while ((c = *in++) != 0)
6111 if (isdigit(c)) c -= '0';
6112 else c = toupper(c) - 'A' + 10;
6124 enc = auth_b64encode(sub, out - sub);
6125 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
6129 /* Convert octets outside 0x21..0x7E to \xXX form */
6133 uschar *t = sub - 1;
6136 if (*t < 0x21 || 0x7E < *t)
6137 yield = string_cat(yield, &size, &ptr,
6138 string_sprintf("\\x%02x", *t), 4);
6140 yield = string_cat(yield, &size, &ptr, t, 1);
6145 /* count the number of list elements */
6154 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6155 cp = string_sprintf("%d", cnt);
6156 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6160 /* expand a named list given the name */
6161 /* handles nested named lists; requotes as colon-sep list */
6165 tree_node *t = NULL;
6169 uschar * suffix = US"";
6170 BOOL needsep = FALSE;
6173 if (*sub == '+') sub++;
6174 if (arg == NULL) /* no-argument version */
6176 if (!(t = tree_search(addresslist_anchor, sub)) &&
6177 !(t = tree_search(domainlist_anchor, sub)) &&
6178 !(t = tree_search(hostlist_anchor, sub)))
6179 t = tree_search(localpartlist_anchor, sub);
6181 else switch(*arg) /* specific list-type version */
6183 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6184 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6185 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6186 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6188 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6194 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6196 : *arg=='a'?"address "
6197 : *arg=='d'?"domain "
6199 : *arg=='l'?"localpart "
6204 list = ((namedlist_block *)(t->data.ptr))->string;
6206 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6208 uschar * buf = US" : ";
6210 yield = string_cat(yield, &size, &ptr, buf, 3);
6214 if (*item == '+') /* list item is itself a named list */
6216 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6217 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6219 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6223 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6224 while ((cp= strpbrk((const char *)item, tok)))
6226 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
6227 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6229 yield = string_cat(yield, &size, &ptr, US"::", 2);
6230 item = (uschar *)cp;
6232 else /* sep in item; should already be doubled; emit once */
6234 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
6235 if (*cp == sep) cp++;
6236 item = (uschar *)cp;
6240 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
6245 /* mask applies a mask to an IP address; for example the result of
6246 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6253 int mask, maskoffset;
6254 int type = string_is_ip_address(sub, &maskoffset);
6259 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6264 if (maskoffset == 0)
6266 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6271 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6273 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6275 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6280 /* Convert the address to binary integer(s) and apply the mask */
6282 sub[maskoffset] = 0;
6283 count = host_aton(sub, binary);
6284 host_mask(count, binary, mask);
6286 /* Convert to masked textual format and add to output. */
6288 yield = string_cat(yield, &size, &ptr, buffer,
6289 host_nmtoa(count, binary, mask, buffer, '.'));
6294 case EOP_LOCAL_PART:
6298 int start, end, domain;
6299 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6303 if (c != EOP_DOMAIN)
6305 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6306 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
6308 else if (domain != 0)
6311 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
6319 uschar outsep[2] = { ':', '\0' };
6320 uschar *address, *error;
6322 int start, end, domain; /* Not really used */
6324 while (isspace(*sub)) sub++;
6325 if (*sub == '>') { *outsep = *++sub; ++sub; }
6326 parse_allow_group = TRUE;
6330 uschar *p = parse_find_address_end(sub, FALSE);
6331 uschar saveend = *p;
6333 address = parse_extract_address(sub, &error, &start, &end, &domain,
6337 /* Add the address to the output list that we are building. This is
6338 done in chunks by searching for the separator character. At the
6339 start, unless we are dealing with the first address of the output
6340 list, add in a space if the new address begins with the separator
6341 character, or is an empty string. */
6343 if (address != NULL)
6345 if (ptr != save_ptr && address[0] == *outsep)
6346 yield = string_cat(yield, &size, &ptr, US" ", 1);
6350 size_t seglen = Ustrcspn(address, outsep);
6351 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
6353 /* If we got to the end of the string we output one character
6356 if (address[seglen] == '\0') { ptr--; break; }
6357 yield = string_cat(yield, &size, &ptr, outsep, 1);
6358 address += seglen + 1;
6361 /* Output a separator after the string: we will remove the
6362 redundant final one at the end. */
6364 yield = string_cat(yield, &size, &ptr, outsep, 1);
6367 if (saveend == '\0') break;
6371 /* If we have generated anything, remove the redundant final
6374 if (ptr != save_ptr) ptr--;
6375 parse_allow_group = FALSE;
6380 /* quote puts a string in quotes if it is empty or contains anything
6381 other than alphamerics, underscore, dot, or hyphen.
6383 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6384 be quoted in order to be a valid local part.
6386 In both cases, newlines and carriage returns are converted into \n and \r
6390 case EOP_QUOTE_LOCAL_PART:
6393 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6394 uschar *t = sub - 1;
6398 while (!needs_quote && *(++t) != 0)
6399 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6401 else /* EOP_QUOTE_LOCAL_PART */
6403 while (!needs_quote && *(++t) != 0)
6404 needs_quote = !isalnum(*t) &&
6405 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6406 (*t != '.' || t == sub || t[1] == 0);
6411 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6416 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6417 else if (*t == '\r')
6418 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6421 if (*t == '\\' || *t == '"')
6422 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6423 yield = string_cat(yield, &size, &ptr, t, 1);
6426 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6428 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6432 /* quote_lookuptype does lookup-specific quoting */
6437 uschar *opt = Ustrchr(arg, '_');
6439 if (opt != NULL) *opt++ = 0;
6441 n = search_findtype(arg, Ustrlen(arg));
6444 expand_string_message = search_error_message;
6448 if (lookup_list[n]->quote != NULL)
6449 sub = (lookup_list[n]->quote)(sub, opt);
6450 else if (opt != NULL) sub = NULL;
6454 expand_string_message = string_sprintf(
6455 "\"%s\" unrecognized after \"${quote_%s\"",
6460 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6464 /* rx quote sticks in \ before any non-alphameric character so that
6465 the insertion works in a regular expression. */
6469 uschar *t = sub - 1;
6473 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6474 yield = string_cat(yield, &size, &ptr, t, 1);
6479 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6480 prescribed by the RFC, if there are characters that need to be encoded */
6484 uschar buffer[2048];
6485 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6486 buffer, sizeof(buffer), FALSE);
6487 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6491 /* RFC 2047 decode */
6497 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6498 headers_charset, '?', &len, &error);
6501 expand_string_message = error;
6504 yield = string_cat(yield, &size, &ptr, decoded, len);
6508 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6518 if (c > 255) c = '_';
6520 yield = string_cat(yield, &size, &ptr, buff, 1);
6525 /* replace illegal UTF-8 sequences by replacement character */
6527 #define UTF8_REPLACEMENT_CHAR US"?"
6531 int seq_len = 0, index = 0;
6533 long codepoint = -1;
6534 uschar seq_buff[4]; /* accumulate utf-8 here */
6543 if ((c & 0xc0) != 0x80)
6545 /* wrong continuation byte; invalidate all bytes */
6546 complete = 1; /* error */
6550 codepoint = (codepoint << 6) | (c & 0x3f);
6551 seq_buff[index++] = c;
6552 if (--bytes_left == 0) /* codepoint complete */
6554 if(codepoint > 0x10FFFF) /* is it too large? */
6555 complete = -1; /* error (RFC3629 limit) */
6557 { /* finished; output utf-8 sequence */
6558 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6564 else /* no bytes left: new sequence */
6566 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6568 yield = string_cat(yield, &size, &ptr, &c, 1);
6571 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6573 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6578 codepoint = c & 0x1f;
6581 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6584 codepoint = c & 0x0f;
6586 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6589 codepoint = c & 0x07;
6591 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6594 seq_buff[index++] = c;
6595 seq_len = bytes_left + 1;
6596 } /* if(bytes_left) */
6600 bytes_left = index = 0;
6601 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6603 if ((complete == 1) && ((c & 0x80) == 0))
6604 { /* ASCII character follows incomplete sequence */
6605 yield = string_cat(yield, &size, &ptr, &c, 1);
6611 /* escape turns all non-printing characters into escape sequences. */
6615 uschar *t = string_printing(sub);
6616 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6620 /* Handle numeric expression evaluation */
6625 uschar *save_sub = sub;
6626 uschar *error = NULL;
6627 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6630 expand_string_message = string_sprintf("error in expression "
6631 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6635 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6636 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6640 /* Handle time period formating */
6644 int n = readconf_readtime(sub, 0, FALSE);
6647 expand_string_message = string_sprintf("string \"%s\" is not an "
6648 "Exim time interval in \"%s\" operator", sub, name);
6651 sprintf(CS var_buffer, "%d", n);
6652 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6656 case EOP_TIME_INTERVAL:
6659 uschar *t = read_number(&n, sub);
6660 if (*t != 0) /* Not A Number*/
6662 expand_string_message = string_sprintf("string \"%s\" is not a "
6663 "positive number in \"%s\" operator", sub, name);
6666 t = readconf_printtime(n);
6667 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6671 /* Convert string to base64 encoding */
6675 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6676 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6680 /* strlen returns the length of the string */
6685 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6686 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6690 /* length_n or l_n takes just the first n characters or the whole string,
6691 whichever is the shorter;
6693 substr_m_n, and s_m_n take n characters from offset m; negative m take
6694 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6695 takes the rest, either to the right or to the left.
6697 hash_n or h_n makes a hash of length n from the string, yielding n
6698 characters from the set a-z; hash_n_m makes a hash of length n, but
6699 uses m characters from the set a-zA-Z0-9.
6701 nhash_n returns a single number between 0 and n-1 (in text form), while
6702 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6703 between 0 and n-1 and the second between 0 and m-1. */
6723 expand_string_message = string_sprintf("missing values after %s",
6728 /* "length" has only one argument, effectively being synonymous with
6731 if (c == EOP_LENGTH || c == EOP_L)
6737 /* The others have one or two arguments; for "substr" the first may be
6738 negative. The second being negative means "not supplied". */
6743 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6746 /* Read up to two numbers, separated by underscores */
6751 if (arg != ret && *arg == '_' && pn == &value1)
6755 if (arg[1] != 0) arg++;
6757 else if (!isdigit(*arg))
6759 expand_string_message =
6760 string_sprintf("non-digit after underscore in \"%s\"", name);
6763 else *pn = (*pn)*10 + *arg++ - '0';
6767 /* Perform the required operation */
6770 (c == EOP_HASH || c == EOP_H)?
6771 compute_hash(sub, value1, value2, &len) :
6772 (c == EOP_NHASH || c == EOP_NH)?
6773 compute_nhash(sub, value1, value2, &len) :
6774 extract_substr(sub, value1, value2, &len);
6776 if (ret == NULL) goto EXPAND_FAILED;
6777 yield = string_cat(yield, &size, &ptr, ret, len);
6787 uschar **modetable[3];
6792 if ((expand_forbid & RDO_EXISTS) != 0)
6794 expand_string_message = US"Use of the stat() expansion is not permitted";
6798 if (stat(CS sub, &st) < 0)
6800 expand_string_message = string_sprintf("stat(%s) failed: %s",
6801 sub, strerror(errno));
6805 switch (mode & S_IFMT)
6807 case S_IFIFO: smode[0] = 'p'; break;
6808 case S_IFCHR: smode[0] = 'c'; break;
6809 case S_IFDIR: smode[0] = 'd'; break;
6810 case S_IFBLK: smode[0] = 'b'; break;
6811 case S_IFREG: smode[0] = '-'; break;
6812 default: smode[0] = '?'; break;
6815 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6816 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6817 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6819 for (i = 0; i < 3; i++)
6821 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6826 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6827 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6828 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6829 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6830 (long)st.st_gid, st.st_size, (long)st.st_atime,
6831 (long)st.st_mtime, (long)st.st_ctime);
6832 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6836 /* vaguely random number less than N */
6840 int_eximarith_t max;
6843 max = expanded_string_integer(sub, TRUE);
6844 if (expand_string_message != NULL)
6846 s = string_sprintf("%d", vaguely_random_number((int)max));
6847 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6851 /* Reverse IP, including IPv6 to dotted-nibble */
6853 case EOP_REVERSE_IP:
6855 int family, maskptr;
6856 uschar reversed[128];
6858 family = string_is_ip_address(sub, &maskptr);
6861 expand_string_message = string_sprintf(
6862 "reverse_ip() not given an IP address [%s]", sub);
6865 invert_address(reversed, sub);
6866 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6870 /* Unknown operator */
6873 expand_string_message =
6874 string_sprintf("unknown expansion operator \"%s\"", name);
6879 /* Handle a plain name. If this is the first thing in the expansion, release
6880 the pre-allocated buffer. If the result data is known to be in a new buffer,
6881 newsize will be set to the size of that buffer, and we can just point at that
6882 store instead of copying. Many expansion strings contain just one reference,
6883 so this is a useful optimization, especially for humungous headers
6884 ($message_headers). */
6892 if (resetok) store_reset(yield);
6896 value = find_variable(name, FALSE, skipping, &newsize);
6899 expand_string_message =
6900 string_sprintf("unknown variable in \"${%s}\"", name);
6901 check_variable_error_message(name);
6904 len = Ustrlen(value);
6905 if (yield == NULL && newsize != 0)
6911 else yield = string_cat(yield, &size, &ptr, value, len);
6915 /* Else there's something wrong */
6917 expand_string_message =
6918 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6919 "in a variable reference)", name);
6923 /* If we hit the end of the string when ket_ends is set, there is a missing
6924 terminating brace. */
6926 if (ket_ends && *s == 0)
6928 expand_string_message = malformed_header?
6929 US"missing } at end of string - could be header name not terminated by colon"
6931 US"missing } at end of string";
6935 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6936 added to the string. If so, set up an empty string. Add a terminating zero. If
6937 left != NULL, return a pointer to the terminator. */
6939 if (yield == NULL) yield = store_get(1);
6941 if (left != NULL) *left = s;
6943 /* Any stacking store that was used above the final string is no longer needed.
6944 In many cases the final string will be the first one that was got and so there
6945 will be optimal store usage. */
6947 if (resetok) store_reset(yield + ptr + 1);
6948 else if (resetok_p) *resetok_p = FALSE;
6952 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6954 if (skipping) debug_printf("skipping: result is not used\n");
6958 /* This is the failure exit: easiest to program with a goto. We still need
6959 to update the pointer to the terminator, for cases of nested calls with "fail".
6962 EXPAND_FAILED_CURLY:
6963 expand_string_message = malformed_header?
6964 US"missing or misplaced { or } - could be header name not terminated by colon"
6966 US"missing or misplaced { or }";
6968 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6969 that is a bad idea, because expand_string_message is in dynamic store. */
6972 if (left != NULL) *left = s;
6975 debug_printf("failed to expand: %s\n", string);
6976 debug_printf(" error message: %s\n", expand_string_message);
6977 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6979 if (resetok_p) *resetok_p = resetok;
6984 /* This is the external function call. Do a quick check for any expansion
6985 metacharacters, and if there are none, just return the input string.
6987 Argument: the string to be expanded
6988 Returns: the expanded string, or NULL if expansion failed; if failure was
6989 due to a lookup deferring, search_find_defer will be TRUE
6993 expand_string(uschar *string)
6995 search_find_defer = FALSE;
6996 malformed_header = FALSE;
6997 return (Ustrpbrk(string, "$\\") == NULL)? string :
6998 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7003 /*************************************************
7005 *************************************************/
7007 /* Now and again we want to expand a string and be sure that the result is in a
7008 new bit of store. This function does that.
7010 Argument: the string to be expanded
7011 Returns: the expanded string, always in a new bit of store, or NULL
7015 expand_string_copy(uschar *string)
7017 uschar *yield = expand_string(string);
7018 if (yield == string) yield = string_copy(string);
7024 /*************************************************
7025 * Expand and interpret as an integer *
7026 *************************************************/
7028 /* Expand a string, and convert the result into an integer.
7031 string the string to be expanded
7032 isplus TRUE if a non-negative number is expected
7034 Returns: the integer value, or
7035 -1 for an expansion error ) in both cases, message in
7036 -2 for an integer interpretation error ) expand_string_message
7037 expand_string_message is set NULL for an OK integer
7041 expand_string_integer(uschar *string, BOOL isplus)
7043 return expanded_string_integer(expand_string(string), isplus);
7047 /*************************************************
7048 * Interpret string as an integer *
7049 *************************************************/
7051 /* Convert a string (that has already been expanded) into an integer.
7053 This function is used inside the expansion code.
7056 s the string to be expanded
7057 isplus TRUE if a non-negative number is expected
7059 Returns: the integer value, or
7060 -1 if string is NULL (which implies an expansion error)
7061 -2 for an integer interpretation error
7062 expand_string_message is set NULL for an OK integer
7065 static int_eximarith_t
7066 expanded_string_integer(uschar *s, BOOL isplus)
7068 int_eximarith_t value;
7069 uschar *msg = US"invalid integer \"%s\"";
7072 /* If expansion failed, expand_string_message will be set. */
7074 if (s == NULL) return -1;
7076 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7077 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7078 systems, so we set it zero ourselves. */
7081 expand_string_message = NULL; /* Indicates no error */
7083 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7084 equal to 0. Unfortunately, people actually relied upon that, so preserve
7085 the behaviour explicitly. Stripping leading whitespace is a harmless
7086 noop change since strtol skips it anyway (provided that there is a number
7090 while (isspace(*s)) ++s;
7094 debug_printf("treating blank string as number 0\n");
7099 value = strtoll(CS s, CSS &endptr, 10);
7103 msg = US"integer expected but \"%s\" found";
7105 else if (value < 0 && isplus)
7107 msg = US"non-negative integer expected but \"%s\" found";
7111 switch (tolower(*endptr))
7116 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7121 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7122 else value *= 1024*1024;
7126 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7127 else value *= 1024*1024*1024;
7131 if (errno == ERANGE)
7132 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7135 while (isspace(*endptr)) endptr++;
7136 if (*endptr == 0) return value;
7140 expand_string_message = string_sprintf(CS msg, s);
7145 /* These values are usually fixed boolean values, but they are permitted to be
7149 addr address being routed
7150 mtype the module type
7151 mname the module name
7152 dbg_opt debug selectors
7153 oname the option name
7154 bvalue the router's boolean value
7155 svalue the router's string value
7156 rvalue where to put the returned value
7158 Returns: OK value placed in rvalue
7159 DEFER expansion failed
7163 exp_bool(address_item *addr,
7164 uschar *mtype, uschar *mname, unsigned dbg_opt,
7165 uschar *oname, BOOL bvalue,
7166 uschar *svalue, BOOL *rvalue)
7169 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7171 expanded = expand_string(svalue);
7172 if (expanded == NULL)
7174 if (expand_string_forcedfail)
7176 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7180 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7181 oname, mname, mtype, expand_string_message);
7182 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7186 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7189 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7191 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7195 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7196 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7206 /*************************************************
7207 **************************************************
7208 * Stand-alone test program *
7209 **************************************************
7210 *************************************************/
7216 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7218 int ovector[3*(EXPAND_MAXN+1)];
7219 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7220 ovector, sizeof(ovector)/sizeof(int));
7221 BOOL yield = n >= 0;
7222 if (n == 0) n = EXPAND_MAXN + 1;
7226 expand_nmax = (setup < 0)? 0 : setup + 1;
7227 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7229 expand_nstring[expand_nmax] = subject + ovector[nn];
7230 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7238 int main(int argc, uschar **argv)
7241 uschar buffer[1024];
7243 debug_selector = D_v;
7244 debug_file = stderr;
7245 debug_fd = fileno(debug_file);
7246 big_buffer = malloc(big_buffer_size);
7248 for (i = 1; i < argc; i++)
7250 if (argv[i][0] == '+')
7252 debug_trace_memory = 2;
7255 if (isdigit(argv[i][0]))
7256 debug_selector = Ustrtol(argv[i], NULL, 0);
7258 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7262 eldap_default_servers = argv[i];
7265 mysql_servers = argv[i];
7268 pgsql_servers = argv[i];
7270 #ifdef EXPERIMENTAL_REDIS
7271 redis_servers = argv[i];
7275 else opt_perl_startup = argv[i];
7279 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7281 expand_nstring[1] = US"string 1....";
7282 expand_nlength[1] = 8;
7286 if (opt_perl_startup != NULL)
7289 printf("Starting Perl interpreter\n");
7290 errstr = init_perl(opt_perl_startup);
7293 printf("** error in perl_startup code: %s\n", errstr);
7294 return EXIT_FAILURE;
7297 #endif /* EXIM_PERL */
7299 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7301 void *reset_point = store_get(0);
7302 uschar *yield = expand_string(buffer);
7305 printf("%s\n", yield);
7306 store_reset(reset_point);
7310 if (search_find_defer) printf("search_find deferred\n");
7311 printf("Failed: %s\n", expand_string_message);
7312 if (expand_string_forcedfail) printf("Forced failure\n");
7326 /* End of expand.c */