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_bar", vtype_stringptr, &spam_bar },
659 { "spam_report", vtype_stringptr, &spam_report },
660 { "spam_score", vtype_stringptr, &spam_score },
661 { "spam_score_int", vtype_stringptr, &spam_score_int },
663 #ifdef EXPERIMENTAL_SPF
664 { "spf_guess", vtype_stringptr, &spf_guess },
665 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
666 { "spf_received", vtype_stringptr, &spf_received },
667 { "spf_result", vtype_stringptr, &spf_result },
668 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
670 { "spool_directory", vtype_stringptr, &spool_directory },
671 { "spool_inodes", vtype_pinodes, (void *)TRUE },
672 { "spool_space", vtype_pspace, (void *)TRUE },
673 #ifdef EXPERIMENTAL_SRS
674 { "srs_db_address", vtype_stringptr, &srs_db_address },
675 { "srs_db_key", vtype_stringptr, &srs_db_key },
676 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
677 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
678 { "srs_recipient", vtype_stringptr, &srs_recipient },
679 { "srs_status", vtype_stringptr, &srs_status },
681 { "thisaddress", vtype_stringptr, &filter_thisaddress },
683 /* The non-(in,out) variables are now deprecated */
684 { "tls_bits", vtype_int, &tls_in.bits },
685 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
686 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
688 { "tls_in_bits", vtype_int, &tls_in.bits },
689 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
690 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
691 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },
692 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
693 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
694 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
695 #if defined(SUPPORT_TLS)
696 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
698 { "tls_out_bits", vtype_int, &tls_out.bits },
699 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
700 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
701 #ifdef EXPERIMENTAL_DANE
702 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },
704 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },
705 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
706 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
707 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
708 #if defined(SUPPORT_TLS)
709 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
711 #ifdef EXPERIMENTAL_DANE
712 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },
715 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
716 #if defined(SUPPORT_TLS)
717 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
720 { "tod_bsdinbox", vtype_todbsdin, NULL },
721 { "tod_epoch", vtype_tode, NULL },
722 { "tod_epoch_l", vtype_todel, NULL },
723 { "tod_full", vtype_todf, NULL },
724 { "tod_log", vtype_todl, NULL },
725 { "tod_logfile", vtype_todlf, NULL },
726 { "tod_zone", vtype_todzone, NULL },
727 { "tod_zulu", vtype_todzulu, NULL },
728 { "transport_name", vtype_stringptr, &transport_name },
729 { "value", vtype_stringptr, &lookup_value },
730 { "verify_mode", vtype_stringptr, &verify_mode },
731 { "version_number", vtype_stringptr, &version_string },
732 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
733 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
734 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
735 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
736 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
737 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
740 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
741 static uschar var_buffer[256];
742 static BOOL malformed_header;
744 /* For textual hashes */
746 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
747 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
750 enum { HMAC_MD5, HMAC_SHA1 };
752 /* For numeric hashes */
754 static unsigned int prime[] = {
755 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
756 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
757 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
759 /* For printing modes in symbolic form */
761 static uschar *mtable_normal[] =
762 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
764 static uschar *mtable_setid[] =
765 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
767 static uschar *mtable_sticky[] =
768 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
772 /*************************************************
773 * Tables for UTF-8 support *
774 *************************************************/
776 /* Table of the number of extra characters, indexed by the first character
777 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
780 static uschar utf8_table1[] = {
781 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
782 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
783 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
784 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
786 /* These are the masks for the data bits in the first byte of a character,
787 indexed by the number of additional bytes. */
789 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
791 /* Get the next UTF-8 character, advancing the pointer. */
793 #define GETUTF8INC(c, ptr) \
795 if ((c & 0xc0) == 0xc0) \
797 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
799 c = (c & utf8_table2[a]) << s; \
803 c |= (*ptr++ & 0x3f) << s; \
808 /*************************************************
809 * Binary chop search on a table *
810 *************************************************/
812 /* This is used for matching expansion items and operators.
815 name the name that is being sought
816 table the table to search
817 table_size the number of items in the table
819 Returns: the offset in the table, or -1
823 chop_match(uschar *name, uschar **table, int table_size)
825 uschar **bot = table;
826 uschar **top = table + table_size;
830 uschar **mid = bot + (top - bot)/2;
831 int c = Ustrcmp(name, *mid);
832 if (c == 0) return mid - table;
833 if (c > 0) bot = mid + 1; else top = mid;
841 /*************************************************
842 * Check a condition string *
843 *************************************************/
845 /* This function is called to expand a string, and test the result for a "true"
846 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
847 forced fail or lookup defer.
849 We used to release all store used, but this is not not safe due
850 to ${dlfunc } and ${acl }. In any case expand_string_internal()
851 is reasonably careful to release what it can.
853 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
856 condition the condition string
857 m1 text to be incorporated in panic error
860 Returns: TRUE if condition is met, FALSE if not
864 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
867 uschar *ss = expand_string(condition);
870 if (!expand_string_forcedfail && !search_find_defer)
871 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
872 "for %s %s: %s", condition, m1, m2, expand_string_message);
875 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
876 strcmpic(ss, US"false") != 0;
883 /*************************************************
884 * Pseudo-random number generation *
885 *************************************************/
887 /* Pseudo-random number generation. The result is not "expected" to be
888 cryptographically strong but not so weak that someone will shoot themselves
889 in the foot using it as a nonce in some email header scheme or whatever
890 weirdness they'll twist this into. The result should ideally handle fork().
892 However, if we're stuck unable to provide this, then we'll fall back to
893 appallingly bad randomness.
895 If SUPPORT_TLS is defined then this will not be used except as an emergency
900 Returns a random number in range [0, max-1]
904 # define vaguely_random_number vaguely_random_number_fallback
907 vaguely_random_number(int max)
910 # undef vaguely_random_number
912 static pid_t pid = 0;
914 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
924 #ifdef HAVE_ARC4RANDOM
925 /* cryptographically strong randomness, common on *BSD platforms, not
926 so much elsewhere. Alas. */
927 #ifndef NOT_HAVE_ARC4RANDOM_STIR
930 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
931 #ifdef HAVE_SRANDOMDEV
932 /* uses random(4) for seeding */
935 gettimeofday(&tv, NULL);
936 srandom(tv.tv_sec | tv.tv_usec | getpid());
939 /* Poor randomness and no seeding here */
946 #ifdef HAVE_ARC4RANDOM
947 return arc4random() % max;
948 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
949 return random() % max;
951 /* This one returns a 16-bit number, definitely not crypto-strong */
952 return random_number(max);
959 /*************************************************
960 * Pick out a name from a string *
961 *************************************************/
963 /* If the name is too long, it is silently truncated.
966 name points to a buffer into which to put the name
967 max is the length of the buffer
968 s points to the first alphabetic character of the name
969 extras chars other than alphanumerics to permit
971 Returns: pointer to the first character after the name
973 Note: The test for *s != 0 in the while loop is necessary because
974 Ustrchr() yields non-NULL if the character is zero (which is not something
978 read_name(uschar *name, int max, uschar *s, uschar *extras)
981 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
983 if (ptr < max-1) name[ptr++] = *s;
992 /*************************************************
993 * Pick out the rest of a header name *
994 *************************************************/
996 /* A variable name starting $header_ (or just $h_ for those who like
997 abbreviations) might not be the complete header name because headers can
998 contain any printing characters in their names, except ':'. This function is
999 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1000 on the end, if the name was terminated by white space.
1003 name points to a buffer in which the name read so far exists
1004 max is the length of the buffer
1005 s points to the first character after the name so far, i.e. the
1006 first non-alphameric character after $header_xxxxx
1008 Returns: a pointer to the first character after the header name
1012 read_header_name(uschar *name, int max, uschar *s)
1014 int prelen = Ustrchr(name, '_') - name + 1;
1015 int ptr = Ustrlen(name) - prelen;
1016 if (ptr > 0) memmove(name, name+prelen, ptr);
1017 while (mac_isgraph(*s) && *s != ':')
1019 if (ptr < max-1) name[ptr++] = *s;
1030 /*************************************************
1031 * Pick out a number from a string *
1032 *************************************************/
1035 n points to an integer into which to put the number
1036 s points to the first digit of the number
1038 Returns: a pointer to the character after the last digit
1042 read_number(int *n, uschar *s)
1045 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1051 /*************************************************
1052 * Extract keyed subfield from a string *
1053 *************************************************/
1055 /* The yield is in dynamic store; NULL means that the key was not found.
1058 key points to the name of the key
1059 s points to the string from which to extract the subfield
1061 Returns: NULL if the subfield was not found, or
1062 a pointer to the subfield's data
1066 expand_getkeyed(uschar *key, uschar *s)
1068 int length = Ustrlen(key);
1069 while (isspace(*s)) s++;
1071 /* Loop to search for the key */
1079 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1080 dkeylength = s - dkey;
1081 while (isspace(*s)) s++;
1082 if (*s == '=') while (isspace((*(++s))));
1084 data = string_dequote(&s);
1085 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1088 while (isspace(*s)) s++;
1097 find_var_ent(uschar * name)
1100 int last = var_table_size;
1102 while (last > first)
1104 int middle = (first + last)/2;
1105 int c = Ustrcmp(name, var_table[middle].name);
1107 if (c > 0) { first = middle + 1; continue; }
1108 if (c < 0) { last = middle; continue; }
1109 return &var_table[middle];
1114 /*************************************************
1115 * Extract numbered subfield from string *
1116 *************************************************/
1118 /* Extracts a numbered field from a string that is divided by tokens - for
1119 example a line from /etc/passwd is divided by colon characters. First field is
1120 numbered one. Negative arguments count from the right. Zero returns the whole
1121 string. Returns NULL if there are insufficient tokens in the string
1124 Modifies final argument - this is a dynamically generated string, so that's OK.
1127 field number of field to be extracted,
1128 first field = 1, whole string = 0, last field = -1
1129 separators characters that are used to break string into tokens
1130 s points to the string from which to extract the subfield
1132 Returns: NULL if the field was not found,
1133 a pointer to the field's data inside s (modified to add 0)
1137 expand_gettokened (int field, uschar *separators, uschar *s)
1142 uschar *fieldtext = NULL;
1144 if (field == 0) return s;
1146 /* Break the line up into fields in place; for field > 0 we stop when we have
1147 done the number of fields we want. For field < 0 we continue till the end of
1148 the string, counting the number of fields. */
1150 count = (field > 0)? field : INT_MAX;
1156 /* Previous field was the last one in the string. For a positive field
1157 number, this means there are not enough fields. For a negative field number,
1158 check that there are enough, and scan back to find the one that is wanted. */
1162 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1163 if ((-field) == (INT_MAX - count - 1)) return s;
1167 while (ss[-1] != 0) ss--;
1173 /* Previous field was not last in the string; save its start and put a
1177 len = Ustrcspn(ss, separators);
1188 expand_getlistele(int field, uschar * list)
1190 uschar * tlist= list;
1196 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1199 if(field==0) return NULL;
1200 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1201 return string_nextinlist(&list, &sep, NULL, 0);
1205 /* Certificate fields, by name. Worry about by-OID later */
1206 /* Names are chosen to not have common prefixes */
1213 uschar * (*getfn)(void * cert, uschar * mod);
1215 static certfield certfields[] =
1216 { /* linear search; no special order */
1217 { US"version", 7, &tls_cert_version },
1218 { US"serial_number", 13, &tls_cert_serial_number },
1219 { US"subject", 7, &tls_cert_subject },
1220 { US"notbefore", 9, &tls_cert_not_before },
1221 { US"notafter", 8, &tls_cert_not_after },
1222 { US"issuer", 6, &tls_cert_issuer },
1223 { US"signature", 9, &tls_cert_signature },
1224 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },
1225 { US"subj_altname", 12, &tls_cert_subject_altname },
1226 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },
1227 { US"crl_uri", 7, &tls_cert_crl_uri },
1231 expand_getcertele(uschar * field, uschar * certvar)
1236 if (!(vp = find_var_ent(certvar)))
1238 expand_string_message =
1239 string_sprintf("no variable named \"%s\"", certvar);
1240 return NULL; /* Unknown variable name */
1242 /* NB this stops us passing certs around in variable. Might
1243 want to do that in future */
1244 if (vp->type != vtype_cert)
1246 expand_string_message =
1247 string_sprintf("\"%s\" is not a certificate", certvar);
1248 return NULL; /* Unknown variable name */
1250 if (!*(void **)vp->value)
1253 if (*field >= '0' && *field <= '9')
1254 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1256 for(cp = certfields;
1257 cp < certfields + nelements(certfields);
1259 if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1261 uschar * modifier = *(field += cp->namelen) == ','
1263 return (*cp->getfn)( *(void **)vp->value, modifier );
1266 expand_string_message =
1267 string_sprintf("bad field selector \"%s\" for certextract", field);
1270 #endif /*SUPPORT_TLS*/
1272 /*************************************************
1273 * Extract a substring from a string *
1274 *************************************************/
1276 /* Perform the ${substr or ${length expansion operations.
1279 subject the input string
1280 value1 the offset from the start of the input string to the start of
1281 the output string; if negative, count from the right.
1282 value2 the length of the output string, or negative (-1) for unset
1283 if value1 is positive, unset means "all after"
1284 if value1 is negative, unset means "all before"
1285 len set to the length of the returned string
1287 Returns: pointer to the output string, or NULL if there is an error
1291 extract_substr(uschar *subject, int value1, int value2, int *len)
1293 int sublen = Ustrlen(subject);
1295 if (value1 < 0) /* count from right */
1299 /* If the position is before the start, skip to the start, and adjust the
1300 length. If the length ends up negative, the substring is null because nothing
1301 can precede. This falls out naturally when the length is unset, meaning "all
1307 if (value2 < 0) value2 = 0;
1311 /* Otherwise an unset length => characters before value1 */
1313 else if (value2 < 0)
1320 /* For a non-negative offset, if the starting position is past the end of the
1321 string, the result will be the null string. Otherwise, an unset length means
1322 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1326 if (value1 > sublen)
1331 else if (value2 < 0) value2 = sublen;
1334 /* Cut the length down to the maximum possible for the offset value, and get
1335 the required characters. */
1337 if (value1 + value2 > sublen) value2 = sublen - value1;
1339 return subject + value1;
1345 /*************************************************
1346 * Old-style hash of a string *
1347 *************************************************/
1349 /* Perform the ${hash expansion operation.
1352 subject the input string (an expanded substring)
1353 value1 the length of the output string; if greater or equal to the
1354 length of the input string, the input string is returned
1355 value2 the number of hash characters to use, or 26 if negative
1356 len set to the length of the returned string
1358 Returns: pointer to the output string, or NULL if there is an error
1362 compute_hash(uschar *subject, int value1, int value2, int *len)
1364 int sublen = Ustrlen(subject);
1366 if (value2 < 0) value2 = 26;
1367 else if (value2 > Ustrlen(hashcodes))
1369 expand_string_message =
1370 string_sprintf("hash count \"%d\" too big", value2);
1374 /* Calculate the hash text. We know it is shorter than the original string, so
1375 can safely place it in subject[] (we know that subject is always itself an
1376 expanded substring). */
1378 if (value1 < sublen)
1383 while ((c = (subject[j])) != 0)
1385 int shift = (c + j++) & 7;
1386 subject[i] ^= (c << shift) | (c >> (8-shift));
1387 if (++i >= value1) i = 0;
1389 for (i = 0; i < value1; i++)
1390 subject[i] = hashcodes[(subject[i]) % value2];
1392 else value1 = sublen;
1401 /*************************************************
1402 * Numeric hash of a string *
1403 *************************************************/
1405 /* Perform the ${nhash expansion operation. The first characters of the
1406 string are treated as most important, and get the highest prime numbers.
1409 subject the input string
1410 value1 the maximum value of the first part of the result
1411 value2 the maximum value of the second part of the result,
1412 or negative to produce only a one-part result
1413 len set to the length of the returned string
1415 Returns: pointer to the output string, or NULL if there is an error.
1419 compute_nhash (uschar *subject, int value1, int value2, int *len)
1421 uschar *s = subject;
1423 unsigned long int total = 0; /* no overflow */
1427 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1428 total += prime[i--] * (unsigned int)(*s++);
1431 /* If value2 is unset, just compute one number */
1435 s = string_sprintf("%d", total % value1);
1438 /* Otherwise do a div/mod hash */
1442 total = total % (value1 * value2);
1443 s = string_sprintf("%d/%d", total/value2, total % value2);
1454 /*************************************************
1455 * Find the value of a header or headers *
1456 *************************************************/
1458 /* Multiple instances of the same header get concatenated, and this function
1459 can also return a concatenation of all the header lines. When concatenating
1460 specific headers that contain lists of addresses, a comma is inserted between
1461 them. Otherwise we use a straight concatenation. Because some messages can have
1462 pathologically large number of lines, there is a limit on the length that is
1463 returned. Also, to avoid massive store use which would result from using
1464 string_cat() as it copies and extends strings, we do a preliminary pass to find
1465 out exactly how much store will be needed. On "normal" messages this will be
1469 name the name of the header, without the leading $header_ or $h_,
1470 or NULL if a concatenation of all headers is required
1471 exists_only TRUE if called from a def: test; don't need to build a string;
1472 just return a string that is not "" and not "0" if the header
1474 newsize return the size of memory block that was obtained; may be NULL
1475 if exists_only is TRUE
1476 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1477 other than concatenating, will be done on the header. Also used
1478 for $message_headers_raw.
1479 charset name of charset to translate MIME words to; used only if
1480 want_raw is false; if NULL, no translation is done (this is
1481 used for $bh_ and $bheader_)
1483 Returns: NULL if the header does not exist, else a pointer to a new
1488 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1491 BOOL found = name == NULL;
1493 int len = found? 0 : Ustrlen(name);
1495 uschar *yield = NULL;
1498 /* Loop for two passes - saves code repetition */
1500 for (i = 0; i < 2; i++)
1505 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1507 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1509 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1514 if (exists_only) return US"1"; /* don't need actual string */
1516 t = h->text + len; /* text to insert */
1517 if (!want_raw) /* unless wanted raw, */
1518 while (isspace(*t)) t++; /* remove leading white space */
1519 ilen = h->slen - (t - h->text); /* length to insert */
1521 /* Unless wanted raw, remove trailing whitespace, including the
1525 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1527 /* Set comma = 1 if handling a single header and it's one of those
1528 that contains an address list, except when asked for raw headers. Only
1529 need to do this once. */
1531 if (!want_raw && name != NULL && comma == 0 &&
1532 Ustrchr("BCFRST", h->type) != NULL)
1535 /* First pass - compute total store needed; second pass - compute
1536 total store used, including this header. */
1538 size += ilen + comma + 1; /* +1 for the newline */
1540 /* Second pass - concatentate the data, up to a maximum. Note that
1541 the loop stops when size hits the limit. */
1545 if (size > header_insert_maxlen)
1547 ilen -= size - header_insert_maxlen - 1;
1550 Ustrncpy(ptr, t, ilen);
1553 /* For a non-raw header, put in the comma if needed, then add
1554 back the newline we removed above, provided there was some text in
1557 if (!want_raw && ilen > 0)
1559 if (comma != 0) *ptr++ = ',';
1567 /* At end of first pass, return NULL if no header found. Then truncate size
1568 if necessary, and get the buffer to hold the data, returning the buffer size.
1573 if (!found) return NULL;
1574 if (size > header_insert_maxlen) size = header_insert_maxlen;
1575 *newsize = size + 1;
1576 ptr = yield = store_get(*newsize);
1580 /* That's all we do for raw header expansion. */
1587 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1588 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1589 function can return an error with decoded data if the charset translation
1590 fails. If decoding fails, it returns NULL. */
1594 uschar *decoded, *error;
1595 if (ptr > yield && ptr[-1] == '\n') ptr--;
1596 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1598 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1602 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1603 " input was: %s\n", error, yield);
1605 if (decoded != NULL) yield = decoded;
1614 /*************************************************
1615 * Return list of recipients *
1616 *************************************************/
1617 /* A recipients list is available only during system message filtering,
1618 during ACL processing after DATA, and while expanding pipe commands
1619 generated from a system filter, but not elsewhere. */
1624 if (!enable_dollar_recipients) return NULL; else
1629 uschar * s = store_get(size);
1630 for (i = 0; i < recipients_count; i++)
1632 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1633 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1634 Ustrlen(recipients_list[i].address));
1636 s[ptr] = 0; /* string_cat() leaves room */
1642 /*************************************************
1643 * Find value of a variable *
1644 *************************************************/
1646 /* The table of variables is kept in alphabetic order, so we can search it
1647 using a binary chop. The "choplen" variable is nothing to do with the binary
1651 name the name of the variable being sought
1652 exists_only TRUE if this is a def: test; passed on to find_header()
1653 skipping TRUE => skip any processing evaluation; this is not the same as
1654 exists_only because def: may test for values that are first
1656 newsize pointer to an int which is initially zero; if the answer is in
1657 a new memory buffer, *newsize is set to its size
1659 Returns: NULL if the variable does not exist, or
1660 a pointer to the variable's contents, or
1661 something non-NULL if exists_only is TRUE
1665 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1672 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1673 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1674 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1675 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1676 (this gave backwards compatibility at the changeover). There may be built-in
1677 variables whose names start acl_ but they should never start in this way. This
1678 slightly messy specification is a consequence of the history, needless to say.
1680 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1681 set, in which case give an error. */
1683 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1687 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1688 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1691 /* Handle $auth<n> variables. */
1693 if (Ustrncmp(name, "auth", 4) == 0)
1696 int n = Ustrtoul(name + 4, &endptr, 10);
1697 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1698 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1701 /* For all other variables, search the table */
1703 if (!(vp = find_var_ent(name)))
1704 return NULL; /* Unknown variable name */
1706 /* Found an existing variable. If in skipping state, the value isn't needed,
1707 and we want to avoid processing (such as looking up the host name). */
1715 case vtype_filter_int:
1716 if (!filter_running) return NULL;
1720 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1724 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1728 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1732 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1736 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1739 case vtype_stringptr: /* Pointer to string */
1740 s = *((uschar **)(val));
1741 return (s == NULL)? US"" : s;
1744 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1747 case vtype_load_avg:
1748 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1751 case vtype_host_lookup: /* Lookup if not done so */
1752 if (sender_host_name == NULL && sender_host_address != NULL &&
1753 !host_lookup_failed && host_name_lookup() == OK)
1754 host_build_sender_fullhost();
1755 return (sender_host_name == NULL)? US"" : sender_host_name;
1757 case vtype_localpart: /* Get local part from address */
1758 s = *((uschar **)(val));
1759 if (s == NULL) return US"";
1760 domain = Ustrrchr(s, '@');
1761 if (domain == NULL) return s;
1762 if (domain - s > sizeof(var_buffer) - 1)
1763 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1764 " in string expansion", sizeof(var_buffer));
1765 Ustrncpy(var_buffer, s, domain - s);
1766 var_buffer[domain - s] = 0;
1769 case vtype_domain: /* Get domain from address */
1770 s = *((uschar **)(val));
1771 if (s == NULL) return US"";
1772 domain = Ustrrchr(s, '@');
1773 return (domain == NULL)? US"" : domain + 1;
1775 case vtype_msgheaders:
1776 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1778 case vtype_msgheaders_raw:
1779 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1781 case vtype_msgbody: /* Pointer to msgbody string */
1782 case vtype_msgbody_end: /* Ditto, the end of the msg */
1783 ss = (uschar **)(val);
1784 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1787 off_t start_offset = SPOOL_DATA_START_OFFSET;
1788 int len = message_body_visible;
1789 if (len > message_size) len = message_size;
1790 *ss = body = store_malloc(len+1);
1792 if (vp->type == vtype_msgbody_end)
1794 struct stat statbuf;
1795 if (fstat(deliver_datafile, &statbuf) == 0)
1797 start_offset = statbuf.st_size - len;
1798 if (start_offset < SPOOL_DATA_START_OFFSET)
1799 start_offset = SPOOL_DATA_START_OFFSET;
1802 lseek(deliver_datafile, start_offset, SEEK_SET);
1803 len = read(deliver_datafile, body, len);
1807 if (message_body_newlines) /* Separate loops for efficiency */
1810 { if (body[--len] == 0) body[len] = ' '; }
1815 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1819 return (*ss == NULL)? US"" : *ss;
1821 case vtype_todbsdin: /* BSD inbox time of day */
1822 return tod_stamp(tod_bsdin);
1824 case vtype_tode: /* Unix epoch time of day */
1825 return tod_stamp(tod_epoch);
1827 case vtype_todel: /* Unix epoch/usec time of day */
1828 return tod_stamp(tod_epoch_l);
1830 case vtype_todf: /* Full time of day */
1831 return tod_stamp(tod_full);
1833 case vtype_todl: /* Log format time of day */
1834 return tod_stamp(tod_log_bare); /* (without timezone) */
1836 case vtype_todzone: /* Time zone offset only */
1837 return tod_stamp(tod_zone);
1839 case vtype_todzulu: /* Zulu time */
1840 return tod_stamp(tod_zulu);
1842 case vtype_todlf: /* Log file datestamp tod */
1843 return tod_stamp(tod_log_datestamp_daily);
1845 case vtype_reply: /* Get reply address */
1846 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1848 if (s != NULL) while (isspace(*s)) s++;
1849 if (s == NULL || *s == 0)
1851 *newsize = 0; /* For the *s==0 case */
1852 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1857 while (isspace(*s)) s++;
1858 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1859 while (t > s && isspace(t[-1])) t--;
1862 return (s == NULL)? US"" : s;
1864 case vtype_string_func:
1866 uschar * (*fn)() = val;
1873 sprintf(CS var_buffer, "%d",
1874 receive_statvfs(val == (void *)TRUE, &inodes));
1881 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1882 sprintf(CS var_buffer, "%d", inodes);
1887 return *(void **)val ? US"<cert>" : US"";
1889 #ifndef DISABLE_DKIM
1891 return dkim_exim_expand_query((int)(long)val);
1896 return NULL; /* Unknown variable. Silences static checkers. */
1903 modify_variable(uschar *name, void * value)
1906 if ((vp = find_var_ent(name))) vp->value = value;
1907 return; /* Unknown variable name, fail silently */
1914 /*************************************************
1915 * Read and expand substrings *
1916 *************************************************/
1918 /* This function is called to read and expand argument substrings for various
1919 expansion items. Some have a minimum requirement that is less than the maximum;
1920 in these cases, the first non-present one is set to NULL.
1923 sub points to vector of pointers to set
1924 n maximum number of substrings
1926 sptr points to current string pointer
1927 skipping the skipping flag
1928 check_end if TRUE, check for final '}'
1929 name name of item, for error message
1930 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1933 Returns: 0 OK; string pointer updated
1934 1 curly bracketing error (too few arguments)
1935 2 too many arguments (only if check_end is set); message set
1936 3 other error (expansion failure)
1940 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1941 BOOL check_end, uschar *name, BOOL *resetok)
1946 while (isspace(*s)) s++;
1947 for (i = 0; i < n; i++)
1951 if (i < m) return 1;
1955 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
1956 if (sub[i] == NULL) return 3;
1957 if (*s++ != '}') return 1;
1958 while (isspace(*s)) s++;
1960 if (check_end && *s++ != '}')
1964 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1965 "(max is %d)", name, n);
1978 /*************************************************
1979 * Elaborate message for bad variable *
1980 *************************************************/
1982 /* For the "unknown variable" message, take a look at the variable's name, and
1983 give additional information about possible ACL variables. The extra information
1984 is added on to expand_string_message.
1986 Argument: the name of the variable
1991 check_variable_error_message(uschar *name)
1993 if (Ustrncmp(name, "acl_", 4) == 0)
1994 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1995 (name[4] == 'c' || name[4] == 'm')?
1997 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1998 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2000 US"user-defined ACL variables must start acl_c or acl_m");
2006 Load args from sub array to globals, and call acl_check().
2007 Sub array will be corrupted on return.
2009 Returns: OK access is granted by an ACCEPT verb
2010 DISCARD access is granted by a DISCARD verb
2011 FAIL access is denied
2012 FAIL_DROP access is denied; drop the connection
2013 DEFER can't tell at the moment
2017 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2021 int sav_narg = acl_narg;
2023 extern int acl_where;
2025 if(--nsub > sizeof(acl_arg)/sizeof(*acl_arg)) nsub = sizeof(acl_arg)/sizeof(*acl_arg);
2026 for (i = 0; i < nsub && sub[i+1]; i++)
2029 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2030 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2035 sub[i+1] = acl_arg[i];
2036 acl_arg[i++] = NULL;
2040 debug_printf("expanding: acl: %s arg: %s%s\n",
2042 acl_narg>0 ? acl_arg[0] : US"<none>",
2043 acl_narg>1 ? " +more" : "");
2045 ret = acl_eval(acl_where, sub[0], user_msgp, &tmp);
2047 for (i = 0; i < nsub; i++)
2048 acl_arg[i] = sub[i+1]; /* restore old args */
2049 acl_narg = sav_narg;
2057 /*************************************************
2058 * Read and evaluate a condition *
2059 *************************************************/
2063 s points to the start of the condition text
2064 resetok points to a BOOL which is written false if it is unsafe to
2065 free memory. Certain condition types (acl) may have side-effect
2066 allocation which must be preserved.
2067 yield points to a BOOL to hold the result of the condition test;
2068 if NULL, we are just reading through a condition that is
2069 part of an "or" combination to check syntax, or in a state
2070 where the answer isn't required
2072 Returns: a pointer to the first character after the condition, or
2077 eval_condition(uschar *s, BOOL *resetok, BOOL *yield)
2079 BOOL testfor = TRUE;
2080 BOOL tempcond, combined_cond;
2082 BOOL sub2_honour_dollar = TRUE;
2083 int i, rc, cond_type, roffset;
2084 int_eximarith_t num[2];
2085 struct stat statbuf;
2090 const uschar *rerror;
2094 while (isspace(*s)) s++;
2095 if (*s == '!') { testfor = !testfor; s++; } else break;
2098 /* Numeric comparisons are symbolic */
2100 if (*s == '=' || *s == '>' || *s == '<')
2112 /* All other conditions are named */
2114 else s = read_name(name, 256, s, US"_");
2116 /* If we haven't read a name, it means some non-alpha character is first. */
2120 expand_string_message = string_sprintf("condition name expected, "
2121 "but found \"%.16s\"", s);
2125 /* Find which condition we are dealing with, and switch on it */
2127 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
2130 /* def: tests for a non-empty variable, or for the existence of a header. If
2131 yield == NULL we are in a skipping state, and don't care about the answer. */
2136 expand_string_message = US"\":\" expected after \"def\"";
2140 s = read_name(name, 256, s+1, US"_");
2142 /* Test for a header's existence. If the name contains a closing brace
2143 character, this may be a user error where the terminating colon has been
2144 omitted. Set a flag to adjust a subsequent error message in this case. */
2146 if (Ustrncmp(name, "h_", 2) == 0 ||
2147 Ustrncmp(name, "rh_", 3) == 0 ||
2148 Ustrncmp(name, "bh_", 3) == 0 ||
2149 Ustrncmp(name, "header_", 7) == 0 ||
2150 Ustrncmp(name, "rheader_", 8) == 0 ||
2151 Ustrncmp(name, "bheader_", 8) == 0)
2153 s = read_header_name(name, 256, s);
2154 /* {-for-text-editors */
2155 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2156 if (yield != NULL) *yield =
2157 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2160 /* Test for a variable's having a non-empty value. A non-existent variable
2161 causes an expansion failure. */
2165 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2168 expand_string_message = (name[0] == 0)?
2169 string_sprintf("variable name omitted after \"def:\"") :
2170 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2171 check_variable_error_message(name);
2174 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2180 /* first_delivery tests for first delivery attempt */
2182 case ECOND_FIRST_DELIVERY:
2183 if (yield != NULL) *yield = deliver_firsttime == testfor;
2187 /* queue_running tests for any process started by a queue runner */
2189 case ECOND_QUEUE_RUNNING:
2190 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2194 /* exists: tests for file existence
2195 isip: tests for any IP address
2196 isip4: tests for an IPv4 address
2197 isip6: tests for an IPv6 address
2198 pam: does PAM authentication
2199 radius: does RADIUS authentication
2200 ldapauth: does LDAP authentication
2201 pwcheck: does Cyrus SASL pwcheck authentication
2210 case ECOND_LDAPAUTH:
2213 while (isspace(*s)) s++;
2214 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2216 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2217 if (sub[0] == NULL) return NULL;
2218 /* {-for-text-editors */
2219 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2221 if (yield == NULL) return s; /* No need to run the test if skipping */
2226 if ((expand_forbid & RDO_EXISTS) != 0)
2228 expand_string_message = US"File existence tests are not permitted";
2231 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2237 rc = string_is_ip_address(sub[0], NULL);
2238 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2239 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2242 /* Various authentication tests - all optionally compiled */
2246 rc = auth_call_pam(sub[0], &expand_string_message);
2249 goto COND_FAILED_NOT_COMPILED;
2250 #endif /* SUPPORT_PAM */
2253 #ifdef RADIUS_CONFIG_FILE
2254 rc = auth_call_radius(sub[0], &expand_string_message);
2257 goto COND_FAILED_NOT_COMPILED;
2258 #endif /* RADIUS_CONFIG_FILE */
2260 case ECOND_LDAPAUTH:
2263 /* Just to keep the interface the same */
2265 int old_pool = store_pool;
2266 store_pool = POOL_SEARCH;
2267 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2268 &expand_string_message, &do_cache);
2269 store_pool = old_pool;
2273 goto COND_FAILED_NOT_COMPILED;
2274 #endif /* LOOKUP_LDAP */
2277 #ifdef CYRUS_PWCHECK_SOCKET
2278 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2281 goto COND_FAILED_NOT_COMPILED;
2282 #endif /* CYRUS_PWCHECK_SOCKET */
2284 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2285 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2287 if (rc == ERROR || rc == DEFER) return NULL;
2288 *yield = (rc == OK) == testfor;
2294 /* call ACL (in a conditional context). Accept true, deny false.
2295 Defer is a forced-fail. Anything set by message= goes to $value.
2296 Up to ten parameters are used; we use the braces round the name+args
2297 like the saslauthd condition does, to permit a variable number of args.
2298 See also the expansion-item version EITEM_ACL and the traditional
2299 acl modifier ACLC_ACL.
2300 Since the ACL may allocate new global variables, tell our caller to not
2305 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2312 while (isspace(*s)) s++;
2313 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2315 switch(read_subs(sub, sizeof(sub)/sizeof(*sub), 1,
2316 &s, yield == NULL, TRUE, US"acl", resetok))
2318 case 1: expand_string_message = US"too few arguments or bracketing "
2321 case 3: return NULL;
2325 if (yield != NULL) switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
2330 lookup_value = NULL;
2333 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2334 lookup_value[ptr] = '\0';
2336 *yield = cond == testfor;
2340 expand_string_forcedfail = TRUE;
2342 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2349 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2351 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2353 However, the last two are optional. That is why the whole set is enclosed
2354 in their own set of braces. */
2356 case ECOND_SASLAUTHD:
2357 #ifndef CYRUS_SASLAUTHD_SOCKET
2358 goto COND_FAILED_NOT_COMPILED;
2360 while (isspace(*s)) s++;
2361 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2362 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd", resetok))
2364 case 1: expand_string_message = US"too few arguments or bracketing "
2365 "error for saslauthd";
2367 case 3: return NULL;
2369 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2373 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2374 &expand_string_message);
2375 if (rc == ERROR || rc == DEFER) return NULL;
2376 *yield = (rc == OK) == testfor;
2379 #endif /* CYRUS_SASLAUTHD_SOCKET */
2382 /* symbolic operators for numeric and string comparison, and a number of
2383 other operators, all requiring two arguments.
2385 crypteq: encrypts plaintext and compares against an encrypted text,
2386 using crypt(), crypt16(), MD5 or SHA-1
2387 inlist/inlisti: checks if first argument is in the list of the second
2388 match: does a regular expression match and sets up the numerical
2389 variables if it succeeds
2390 match_address: matches in an address list
2391 match_domain: matches in a domain list
2392 match_ip: matches a host list that is restricted to IP addresses
2393 match_local_part: matches in a local part list
2396 case ECOND_MATCH_ADDRESS:
2397 case ECOND_MATCH_DOMAIN:
2398 case ECOND_MATCH_IP:
2399 case ECOND_MATCH_LOCAL_PART:
2400 #ifndef EXPAND_LISTMATCH_RHS
2401 sub2_honour_dollar = FALSE;
2410 case ECOND_NUM_L: /* Numerical comparisons */
2417 case ECOND_STR_LT: /* String comparisons */
2428 for (i = 0; i < 2; i++)
2430 /* Sometimes, we don't expand substrings; too many insecure configurations
2431 created using match_address{}{} and friends, where the second param
2432 includes information from untrustworthy sources. */
2433 BOOL honour_dollar = TRUE;
2434 if ((i > 0) && !sub2_honour_dollar)
2435 honour_dollar = FALSE;
2437 while (isspace(*s)) s++;
2440 if (i == 0) goto COND_FAILED_CURLY_START;
2441 expand_string_message = string_sprintf("missing 2nd string in {} "
2442 "after \"%s\"", name);
2445 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2446 honour_dollar, resetok);
2447 if (sub[i] == NULL) return NULL;
2448 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2450 /* Convert to numerical if required; we know that the names of all the
2451 conditions that compare numbers do not start with a letter. This just saves
2452 checking for them individually. */
2454 if (!isalpha(name[0]) && yield != NULL)
2460 debug_printf("empty string cast to zero for numerical comparison\n");
2464 num[i] = expanded_string_integer(sub[i], FALSE);
2465 if (expand_string_message != NULL) return NULL;
2470 /* Result not required */
2472 if (yield == NULL) return s;
2474 /* Do an appropriate comparison */
2480 tempcond = (num[0] == num[1]);
2484 tempcond = (num[0] > num[1]);
2488 tempcond = (num[0] >= num[1]);
2492 tempcond = (num[0] < num[1]);
2496 tempcond = (num[0] <= num[1]);
2500 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2504 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2508 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2512 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2516 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2520 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2524 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2528 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2532 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2536 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2539 case ECOND_MATCH: /* Regular expression match */
2540 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2544 expand_string_message = string_sprintf("regular expression error in "
2545 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2548 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2551 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2552 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2553 goto MATCHED_SOMETHING;
2555 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2556 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2557 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2558 goto MATCHED_SOMETHING;
2560 case ECOND_MATCH_IP: /* Match IP address in a host list */
2561 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2563 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2569 unsigned int *nullcache = NULL;
2570 check_host_block cb;
2572 cb.host_name = US"";
2573 cb.host_address = sub[0];
2575 /* If the host address starts off ::ffff: it is an IPv6 address in
2576 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2579 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2580 cb.host_address + 7 : cb.host_address;
2582 rc = match_check_list(
2583 &sub[1], /* the list */
2584 0, /* separator character */
2585 &hostlist_anchor, /* anchor pointer */
2586 &nullcache, /* cache pointer */
2587 check_host, /* function for testing */
2588 &cb, /* argument for function */
2589 MCL_HOST, /* type of check */
2590 sub[0], /* text for debugging */
2591 NULL); /* where to pass back data */
2593 goto MATCHED_SOMETHING;
2595 case ECOND_MATCH_LOCAL_PART:
2596 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2597 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2612 expand_string_message = string_sprintf("unable to complete match "
2613 "against \"%s\": %s", sub[1], search_error_message);
2619 /* Various "encrypted" comparisons. If the second string starts with
2620 "{" then an encryption type is given. Default to crypt() or crypt16()
2621 (build-time choice). */
2622 /* }-for-text-editors */
2625 #ifndef SUPPORT_CRYPTEQ
2626 goto COND_FAILED_NOT_COMPILED;
2628 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2630 int sublen = Ustrlen(sub[1]+5);
2635 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2637 /* If the length that we are comparing against is 24, the MD5 digest
2638 is expressed as a base64 string. This is the way LDAP does it. However,
2639 some other software uses a straightforward hex representation. We assume
2640 this if the length is 32. Other lengths fail. */
2644 uschar *coded = auth_b64encode((uschar *)digest, 16);
2645 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2646 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2647 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2649 else if (sublen == 32)
2653 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2655 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2656 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2657 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2661 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2662 "fail\n crypted=%s\n", sub[1]+5);
2667 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2669 int sublen = Ustrlen(sub[1]+6);
2674 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2676 /* If the length that we are comparing against is 28, assume the SHA1
2677 digest is expressed as a base64 string. If the length is 40, assume a
2678 straightforward hex representation. Other lengths fail. */
2682 uschar *coded = auth_b64encode((uschar *)digest, 20);
2683 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2684 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2685 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2687 else if (sublen == 40)
2691 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2693 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2694 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2695 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2699 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2700 "fail\n crypted=%s\n", sub[1]+6);
2705 else /* {crypt} or {crypt16} and non-{ at start */
2706 /* }-for-text-editors */
2711 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2716 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2721 else if (sub[1][0] == '{') /* }-for-text-editors */
2723 expand_string_message = string_sprintf("unknown encryption mechanism "
2724 "in \"%s\"", sub[1]);
2730 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2731 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2732 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2736 #define XSTR(s) STR(s)
2737 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2738 " subject=%s\n crypted=%s\n",
2739 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2744 /* If the encrypted string contains fewer than two characters (for the
2745 salt), force failure. Otherwise we get false positives: with an empty
2746 string the yield of crypt() is an empty string! */
2748 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2749 (Ustrcmp(coded, sub[1]) == 0);
2752 #endif /* SUPPORT_CRYPTEQ */
2758 uschar *save_iterate_item = iterate_item;
2759 int (*compare)(const uschar *, const uschar *);
2761 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2764 if (cond_type == ECOND_INLISTI)
2767 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2769 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2770 if (compare(sub[0], iterate_item) == 0)
2775 iterate_item = save_iterate_item;
2778 } /* Switch for comparison conditions */
2780 *yield = tempcond == testfor;
2781 return s; /* End of comparison conditions */
2784 /* and/or: computes logical and/or of several conditions */
2788 subcondptr = (yield == NULL)? NULL : &tempcond;
2789 combined_cond = (cond_type == ECOND_AND);
2791 while (isspace(*s)) s++;
2792 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2796 while (isspace(*s)) s++;
2797 /* {-for-text-editors */
2798 if (*s == '}') break;
2799 if (*s != '{') /* }-for-text-editors */
2801 expand_string_message = string_sprintf("each subcondition "
2802 "inside an \"%s{...}\" condition must be in its own {}", name);
2806 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2808 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2809 expand_string_message, name);
2812 while (isspace(*s)) s++;
2814 /* {-for-text-editors */
2817 /* {-for-text-editors */
2818 expand_string_message = string_sprintf("missing } at end of condition "
2819 "inside \"%s\" group", name);
2825 if (cond_type == ECOND_AND)
2827 combined_cond &= tempcond;
2828 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2829 } /* evaluate any more */
2832 combined_cond |= tempcond;
2833 if (combined_cond) subcondptr = NULL; /* once true, don't */
2834 } /* evaluate any more */
2838 if (yield != NULL) *yield = (combined_cond == testfor);
2842 /* forall/forany: iterates a condition with different values */
2848 uschar *save_iterate_item = iterate_item;
2850 DEBUG(D_expand) debug_printf("condition: %s\n", name);
2852 while (isspace(*s)) s++;
2853 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2854 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2855 if (sub[0] == NULL) return NULL;
2856 /* {-for-text-editors */
2857 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2859 while (isspace(*s)) s++;
2860 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2864 /* Call eval_condition once, with result discarded (as if scanning a
2865 "false" part). This allows us to find the end of the condition, because if
2866 the list it empty, we won't actually evaluate the condition for real. */
2868 if (!(s = eval_condition(sub[1], resetok, NULL)))
2870 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2871 expand_string_message, name);
2874 while (isspace(*s)) s++;
2876 /* {-for-text-editors */
2879 /* {-for-text-editors */
2880 expand_string_message = string_sprintf("missing } at end of condition "
2881 "inside \"%s\"", name);
2885 if (yield != NULL) *yield = !testfor;
2886 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2888 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2889 if (!eval_condition(sub[1], resetok, &tempcond))
2891 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2892 expand_string_message, name);
2893 iterate_item = save_iterate_item;
2896 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2897 tempcond? "true":"false");
2899 if (yield != NULL) *yield = (tempcond == testfor);
2900 if (tempcond == (cond_type == ECOND_FORANY)) break;
2903 iterate_item = save_iterate_item;
2908 /* The bool{} expansion condition maps a string to boolean.
2909 The values supported should match those supported by the ACL condition
2910 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2911 of true/false. Note that Router "condition" rules have a different
2912 interpretation, where general data can be used and only a few values
2914 Note that readconf.c boolean matching, for boolean configuration options,
2915 only matches true/yes/false/no.
2916 The bool_lax{} condition matches the Router logic, which is much more
2919 case ECOND_BOOL_LAX:
2925 BOOL boolvalue = FALSE;
2926 while (isspace(*s)) s++;
2927 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2928 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2929 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2931 case 1: expand_string_message = string_sprintf(
2932 "too few arguments or bracketing error for %s",
2936 case 3: return NULL;
2939 while (isspace(*t)) t++;
2943 /* trailing whitespace: seems like a good idea to ignore it too */
2945 while (isspace(*t2)) t2--;
2946 if (t2 != (t + len))
2953 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2954 /* logic for the lax case from expand_check_condition(), which also does
2955 expands, and the logic is both short and stable enough that there should
2956 be no maintenance burden from replicating it. */
2960 ? Ustrspn(t+1, "0123456789") == len-1
2961 : Ustrspn(t, "0123456789") == len)
2963 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2964 /* expand_check_condition only does a literal string "0" check */
2965 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2968 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2970 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2972 else if (cond_type == ECOND_BOOL_LAX)
2976 expand_string_message = string_sprintf("unrecognised boolean "
2980 if (yield != NULL) *yield = (boolvalue == testfor);
2984 /* Unknown condition */
2987 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2989 } /* End switch on condition type */
2991 /* Missing braces at start and end of data */
2993 COND_FAILED_CURLY_START:
2994 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2997 COND_FAILED_CURLY_END:
2998 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3002 /* A condition requires code that is not compiled */
3004 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3005 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3006 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3007 COND_FAILED_NOT_COMPILED:
3008 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3017 /*************************************************
3018 * Save numerical variables *
3019 *************************************************/
3021 /* This function is called from items such as "if" that want to preserve and
3022 restore the numbered variables.
3025 save_expand_string points to an array of pointers to set
3026 save_expand_nlength points to an array of ints for the lengths
3028 Returns: the value of expand max to save
3032 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3035 for (i = 0; i <= expand_nmax; i++)
3037 save_expand_nstring[i] = expand_nstring[i];
3038 save_expand_nlength[i] = expand_nlength[i];
3045 /*************************************************
3046 * Restore numerical variables *
3047 *************************************************/
3049 /* This function restored saved values of numerical strings.
3052 save_expand_nmax the number of strings to restore
3053 save_expand_string points to an array of pointers
3054 save_expand_nlength points to an array of ints
3060 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3061 int *save_expand_nlength)
3064 expand_nmax = save_expand_nmax;
3065 for (i = 0; i <= expand_nmax; i++)
3067 expand_nstring[i] = save_expand_nstring[i];
3068 expand_nlength[i] = save_expand_nlength[i];
3076 /*************************************************
3077 * Handle yes/no substrings *
3078 *************************************************/
3080 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3081 alternative substrings that depend on whether or not the condition was true,
3082 or the lookup or extraction succeeded. The substrings always have to be
3083 expanded, to check their syntax, but "skipping" is set when the result is not
3084 needed - this avoids unnecessary nested lookups.
3087 skipping TRUE if we were skipping when this item was reached
3088 yes TRUE if the first string is to be used, else use the second
3089 save_lookup a value to put back into lookup_value before the 2nd expansion
3090 sptr points to the input string pointer
3091 yieldptr points to the output string pointer
3092 sizeptr points to the output string size
3093 ptrptr points to the output string pointer
3094 type "lookup" or "if" or "extract" or "run", for error message
3095 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3098 Returns: 0 OK; lookup_value has been reset to save_lookup
3100 2 expansion failed because of bracketing error
3104 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
3105 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3108 uschar *s = *sptr; /* Local value */
3109 uschar *sub1, *sub2;
3111 /* If there are no following strings, we substitute the contents of $value for
3112 lookups and for extractions in the success case. For the ${if item, the string
3113 "true" is substituted. In the fail case, nothing is substituted for all three
3116 while (isspace(*s)) s++;
3121 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3125 if (yes && lookup_value != NULL)
3126 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3127 Ustrlen(lookup_value));
3128 lookup_value = save_lookup;
3134 /* The first following string must be braced. */
3136 if (*s++ != '{') goto FAILED_CURLY;
3138 /* Expand the first substring. Forced failures are noticed only if we actually
3139 want this string. Set skipping in the call in the fail case (this will always
3140 be the case if we were already skipping). */
3142 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3143 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3144 expand_string_forcedfail = FALSE;
3145 if (*s++ != '}') goto FAILED_CURLY;
3147 /* If we want the first string, add it to the output */
3150 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3152 /* If this is called from a lookup or an extract, we want to restore $value to
3153 what it was at the start of the item, so that it has this value during the
3154 second string expansion. For the call from "if" or "run" to this function,
3155 save_lookup is set to lookup_value, so that this statement does nothing. */
3157 lookup_value = save_lookup;
3159 /* There now follows either another substring, or "fail", or nothing. This
3160 time, forced failures are noticed only if we want the second string. We must
3161 set skipping in the nested call if we don't want this string, or if we were
3162 already skipping. */
3164 while (isspace(*s)) s++;
3167 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3168 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3169 expand_string_forcedfail = FALSE;
3170 if (*s++ != '}') goto FAILED_CURLY;
3172 /* If we want the second string, add it to the output */
3175 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3178 /* If there is no second string, but the word "fail" is present when the use of
3179 the second string is wanted, set a flag indicating it was a forced failure
3180 rather than a syntactic error. Swallow the terminating } in case this is nested
3181 inside another lookup or if or extract. */
3186 s = read_name(name, sizeof(name), s, US"_");
3187 if (Ustrcmp(name, "fail") == 0)
3189 if (!yes && !skipping)
3191 while (isspace(*s)) s++;
3192 if (*s++ != '}') goto FAILED_CURLY;
3193 expand_string_message =
3194 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3195 expand_string_forcedfail = TRUE;
3201 expand_string_message =
3202 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3207 /* All we have to do now is to check on the final closing brace. */
3209 while (isspace(*s)) s++;
3210 if (*s++ == '}') goto RETURN;
3212 /* Get here if there is a bracketing failure */
3217 /* Get here for other failures */
3222 /* Update the input pointer value before returning */
3232 /*************************************************
3233 * Handle MD5 or SHA-1 computation for HMAC *
3234 *************************************************/
3236 /* These are some wrapping functions that enable the HMAC code to be a bit
3237 cleaner. A good compiler will spot the tail recursion.
3240 type HMAC_MD5 or HMAC_SHA1
3241 remaining are as for the cryptographic hash functions
3247 chash_start(int type, void *base)
3249 if (type == HMAC_MD5)
3250 md5_start((md5 *)base);
3252 sha1_start((sha1 *)base);
3256 chash_mid(int type, void *base, uschar *string)
3258 if (type == HMAC_MD5)
3259 md5_mid((md5 *)base, string);
3261 sha1_mid((sha1 *)base, string);
3265 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3267 if (type == HMAC_MD5)
3268 md5_end((md5 *)base, string, length, digest);
3270 sha1_end((sha1 *)base, string, length, digest);
3277 /********************************************************
3278 * prvs: Get last three digits of days since Jan 1, 1970 *
3279 ********************************************************/
3281 /* This is needed to implement the "prvs" BATV reverse
3284 Argument: integer "days" offset to add or substract to
3285 or from the current number of days.
3287 Returns: pointer to string containing the last three
3288 digits of the number of days since Jan 1, 1970,
3289 modified by the offset argument, NULL if there
3290 was an error in the conversion.
3295 prvs_daystamp(int day_offset)
3297 uschar *days = store_get(32); /* Need at least 24 for cases */
3298 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3299 (time(NULL) + day_offset*86400)/86400);
3300 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3305 /********************************************************
3306 * prvs: perform HMAC-SHA1 computation of prvs bits *
3307 ********************************************************/
3309 /* This is needed to implement the "prvs" BATV reverse
3313 address RFC2821 Address to use
3314 key The key to use (must be less than 64 characters
3316 key_num Single-digit key number to use. Defaults to
3319 Returns: pointer to string containing the first three
3320 bytes of the final hash in hex format, NULL if
3321 there was an error in the process.
3325 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3327 uschar *hash_source, *p;
3328 int size = 0,offset = 0,i;
3330 void *use_base = &sha1_base;
3331 uschar innerhash[20];
3332 uschar finalhash[20];
3333 uschar innerkey[64];
3334 uschar outerkey[64];
3335 uschar *finalhash_hex = store_get(40);
3337 if (key_num == NULL)
3340 if (Ustrlen(key) > 64)
3343 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3344 string_cat(hash_source,&size,&offset,daystamp,3);
3345 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3346 hash_source[offset] = '\0';
3348 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3350 memset(innerkey, 0x36, 64);
3351 memset(outerkey, 0x5c, 64);
3353 for (i = 0; i < Ustrlen(key); i++)
3355 innerkey[i] ^= key[i];
3356 outerkey[i] ^= key[i];
3359 chash_start(HMAC_SHA1, use_base);
3360 chash_mid(HMAC_SHA1, use_base, innerkey);
3361 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3363 chash_start(HMAC_SHA1, use_base);
3364 chash_mid(HMAC_SHA1, use_base, outerkey);
3365 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3368 for (i = 0; i < 3; i++)
3370 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3371 *p++ = hex_digits[finalhash[i] & 0x0f];
3375 return finalhash_hex;
3381 /*************************************************
3382 * Join a file onto the output string *
3383 *************************************************/
3385 /* This is used for readfile and after a run expansion. It joins the contents
3386 of a file onto the output string, globally replacing newlines with a given
3387 string (optionally). The file is closed at the end.
3391 yield pointer to the expandable string
3392 sizep pointer to the current size
3393 ptrp pointer to the current position
3394 eol newline replacement string, or NULL
3396 Returns: new value of string pointer
3400 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3403 uschar buffer[1024];
3405 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3407 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3409 int len = Ustrlen(buffer);
3410 if (eol != NULL && buffer[len-1] == '\n') len--;
3411 yield = string_cat(yield, sizep, ptrp, buffer, len);
3412 if (buffer[len] != 0)
3413 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3416 if (yield != NULL) yield[*ptrp] = 0;
3424 /*************************************************
3425 * Evaluate numeric expression *
3426 *************************************************/
3428 /* This is a set of mutually recursive functions that evaluate an arithmetic
3429 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3430 these functions that is called from elsewhere is eval_expr, whose interface is:
3433 sptr pointer to the pointer to the string - gets updated
3434 decimal TRUE if numbers are to be assumed decimal
3435 error pointer to where to put an error message - must be NULL on input
3436 endket TRUE if ')' must terminate - FALSE for external call
3438 Returns: on success: the value of the expression, with *error still NULL
3439 on failure: an undefined value, with *error = a message
3442 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3445 static int_eximarith_t
3446 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3449 int_eximarith_t x = eval_op_or(&s, decimal, error);
3455 *error = US"expecting closing parenthesis";
3457 while (isspace(*(++s)));
3459 else if (*s != 0) *error = US"expecting operator";
3466 static int_eximarith_t
3467 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3472 while (isspace(*s)) s++;
3477 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3479 switch (tolower(*s))
3482 case 'k': n *= 1024; s++; break;
3483 case 'm': n *= 1024*1024; s++; break;
3484 case 'g': n *= 1024*1024*1024; s++; break;
3486 while (isspace (*s)) s++;
3491 n = eval_expr(&s, decimal, error, 1);
3495 *error = US"expecting number or opening parenthesis";
3503 static int_eximarith_t
3504 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3508 while (isspace(*s)) s++;
3509 if (*s == '+' || *s == '-' || *s == '~')
3512 x = eval_op_unary(&s, decimal, error);
3513 if (op == '-') x = -x;
3514 else if (op == '~') x = ~x;
3518 x = eval_number(&s, decimal, error);
3525 static int_eximarith_t
3526 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3529 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3532 while (*s == '*' || *s == '/' || *s == '%')
3535 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3536 if (*error != NULL) break;
3537 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3538 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3539 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3540 * -N*M is INT_MIN will yielf INT_MIN.
3541 * Since we don't support floating point, this is somewhat simpler.
3542 * Ideally, we'd return an error, but since we overflow for all other
3543 * arithmetic, consistency suggests otherwise, but what's the correct value
3544 * to use? There is none.
3545 * The C standard guarantees overflow for unsigned arithmetic but signed
3546 * overflow invokes undefined behaviour; in practice, this is overflow
3547 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3548 * that long/longlong larger than int are available, or we could just work
3549 * with larger types. We should consider whether to guarantee 32bit eval
3550 * and 64-bit working variables, with errors returned. For now ...
3551 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3552 * can just let the other invalid results occur otherwise, as they have
3553 * until now. For this one case, we can coerce.
3555 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3558 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3559 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3569 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3585 static int_eximarith_t
3586 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3589 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3592 while (*s == '+' || *s == '-')
3595 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3596 if (*error != NULL) break;
3597 if (op == '+') x += y; else x -= y;
3605 static int_eximarith_t
3606 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3609 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3612 while ((*s == '<' || *s == '>') && s[1] == s[0])
3617 y = eval_op_sum(&s, decimal, error);
3618 if (*error != NULL) break;
3619 if (op == '<') x <<= y; else x >>= y;
3627 static int_eximarith_t
3628 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3631 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3638 y = eval_op_shift(&s, decimal, error);
3639 if (*error != NULL) break;
3648 static int_eximarith_t
3649 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3652 int_eximarith_t x = eval_op_and(&s, decimal, error);
3659 y = eval_op_and(&s, decimal, error);
3660 if (*error != NULL) break;
3669 static int_eximarith_t
3670 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3673 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3680 y = eval_op_xor(&s, decimal, error);
3681 if (*error != NULL) break;
3691 /*************************************************
3693 *************************************************/
3695 /* Returns either an unchanged string, or the expanded string in stacking pool
3696 store. Interpreted sequences are:
3698 \... normal escaping rules
3699 $name substitutes the variable
3701 ${op:string} operates on the expanded string value
3702 ${item{arg1}{arg2}...} expands the args and then does the business
3703 some literal args are not enclosed in {}
3705 There are now far too many operators and item types to make it worth listing
3706 them here in detail any more.
3708 We use an internal routine recursively to handle embedded substrings. The
3709 external function follows. The yield is NULL if the expansion failed, and there
3710 are two cases: if something collapsed syntactically, or if "fail" was given
3711 as the action on a lookup failure. These can be distinguised by looking at the
3712 variable expand_string_forcedfail, which is TRUE in the latter case.
3714 The skipping flag is set true when expanding a substring that isn't actually
3715 going to be used (after "if" or "lookup") and it prevents lookups from
3716 happening lower down.
3718 Store usage: At start, a store block of the length of the input plus 64
3719 is obtained. This is expanded as necessary by string_cat(), which might have to
3720 get a new block, or might be able to expand the original. At the end of the
3721 function we can release any store above that portion of the yield block that
3722 was actually used. In many cases this will be optimal.
3724 However: if the first item in the expansion is a variable name or header name,
3725 we reset the store before processing it; if the result is in fresh store, we
3726 use that without copying. This is helpful for expanding strings like
3727 $message_headers which can get very long.
3729 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3730 since resetting the store at the end of the expansion will free store that was
3731 allocated by the plugin code as well as the slop after the expanded string. So
3732 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3733 and, given the acl condition, ${if }. This is an unfortunate consequence of
3734 string expansion becoming too powerful.
3737 string the string to be expanded
3738 ket_ends true if expansion is to stop at }
3739 left if not NULL, a pointer to the first character after the
3740 expansion is placed here (typically used with ket_ends)
3741 skipping TRUE for recursive calls when the value isn't actually going
3742 to be used (to allow for optimisation)
3743 honour_dollar TRUE if $ is to be expanded,
3744 FALSE if it's just another character
3745 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3748 Returns: NULL if expansion fails:
3749 expand_string_forcedfail is set TRUE if failure was forced
3750 expand_string_message contains a textual error message
3751 a pointer to the expanded string on success
3755 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3756 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3759 int size = Ustrlen(string)+ 64;
3761 uschar *yield = store_get(size);
3763 uschar *save_expand_nstring[EXPAND_MAXN+1];
3764 int save_expand_nlength[EXPAND_MAXN+1];
3765 BOOL resetok = TRUE;
3767 expand_string_forcedfail = FALSE;
3768 expand_string_message = US"";
3775 /* \ escapes the next character, which must exist, or else
3776 the expansion fails. There's a special escape, \N, which causes
3777 copying of the subject verbatim up to the next \N. Otherwise,
3778 the escapes are the standard set. */
3784 expand_string_message = US"\\ at end of string";
3791 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3792 yield = string_cat(yield, &size, &ptr, t, s - t);
3793 if (*s != 0) s += 2;
3799 ch[0] = string_interpret_escape(&s);
3801 yield = string_cat(yield, &size, &ptr, ch, 1);
3808 /* Anything other than $ is just copied verbatim, unless we are
3809 looking for a terminating } character. */
3812 if (ket_ends && *s == '}') break;
3814 if (*s != '$' || !honour_dollar)
3816 yield = string_cat(yield, &size, &ptr, s++, 1);
3820 /* No { after the $ - must be a plain name or a number for string
3821 match variable. There has to be a fudge for variables that are the
3822 names of header fields preceded by "$header_" because header field
3823 names can contain any printing characters except space and colon.
3824 For those that don't like typing this much, "$h_" is a synonym for
3825 "$header_". A non-existent header yields a NULL value; nothing is
3828 if (isalpha((*(++s))))
3833 s = read_name(name, sizeof(name), s, US"_");
3835 /* If this is the first thing to be expanded, release the pre-allocated
3838 if (ptr == 0 && yield != NULL)
3840 if (resetok) store_reset(yield);
3847 if (Ustrncmp(name, "h_", 2) == 0 ||
3848 Ustrncmp(name, "rh_", 3) == 0 ||
3849 Ustrncmp(name, "bh_", 3) == 0 ||
3850 Ustrncmp(name, "header_", 7) == 0 ||
3851 Ustrncmp(name, "rheader_", 8) == 0 ||
3852 Ustrncmp(name, "bheader_", 8) == 0)
3854 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3855 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3856 s = read_header_name(name, sizeof(name), s);
3857 value = find_header(name, FALSE, &newsize, want_raw, charset);
3859 /* If we didn't find the header, and the header contains a closing brace
3860 character, this may be a user error where the terminating colon
3861 has been omitted. Set a flag to adjust the error message in this case.
3862 But there is no error here - nothing gets inserted. */
3866 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3875 value = find_variable(name, FALSE, skipping, &newsize);
3878 expand_string_message =
3879 string_sprintf("unknown variable name \"%s\"", name);
3880 check_variable_error_message(name);
3885 /* If the data is known to be in a new buffer, newsize will be set to the
3886 size of that buffer. If this is the first thing in an expansion string,
3887 yield will be NULL; just point it at the new store instead of copying. Many
3888 expansion strings contain just one reference, so this is a useful
3889 optimization, especially for humungous headers. */
3891 len = Ustrlen(value);
3892 if (yield == NULL && newsize != 0)
3898 else yield = string_cat(yield, &size, &ptr, value, len);
3906 s = read_number(&n, s);
3907 if (n >= 0 && n <= expand_nmax)
3908 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3913 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3915 if (*s != '{') /*}*/
3917 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3921 /* After { there can be various things, but they all start with
3922 an initial word, except for a number for a string match variable. */
3924 if (isdigit((*(++s))))
3927 s = read_number(&n, s); /*{*/
3930 expand_string_message = US"} expected after number";
3933 if (n >= 0 && n <= expand_nmax)
3934 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3941 expand_string_message = US"letter or digit expected after ${"; /*}*/
3945 /* Allow "-" in names to cater for substrings with negative
3946 arguments. Since we are checking for known names after { this is
3949 s = read_name(name, sizeof(name), s, US"_-");
3950 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3954 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3955 If the ACL returns accept or reject we return content set by "message ="
3956 There is currently no limit on recursion; this would have us call
3957 acl_check_internal() directly and get a current level from somewhere.
3958 See also the acl expansion condition ECOND_ACL and the traditional
3959 acl modifier ACLC_ACL.
3960 Assume that the function has side-effects on the store that must be preserved.
3964 /* ${acl {name} {arg1}{arg2}...} */
3966 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
3969 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl", &resetok))
3971 case 1: goto EXPAND_FAILED_CURLY;
3973 case 3: goto EXPAND_FAILED;
3975 if (skipping) continue;
3978 switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
3983 debug_printf("acl expansion yield: %s\n", user_msg);
3985 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3989 expand_string_forcedfail = TRUE;
3991 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
3996 /* Handle conditionals - preserve the values of the numerical expansion
3997 variables in case they get changed by a regular expression match in the
3998 condition. If not, they retain their external settings. At the end
3999 of this "if" section, they get restored to their previous values. */
4005 int save_expand_nmax =
4006 save_expand_strings(save_expand_nstring, save_expand_nlength);
4008 while (isspace(*s)) s++;
4009 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
4010 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
4013 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
4014 cond? "true" : "false");
4018 /* The handling of "yes" and "no" result strings is now in a separate
4019 function that is also used by ${lookup} and ${extract} and ${run}. */
4021 switch(process_yesno(
4022 skipping, /* were previously skipping */
4023 cond, /* success/failure indicator */
4024 lookup_value, /* value to reset for string2 */
4025 &s, /* input pointer */
4026 &yield, /* output pointer */
4027 &size, /* output size */
4028 &ptr, /* output current point */
4029 US"if", /* condition type */
4032 case 1: goto EXPAND_FAILED; /* when all is well, the */
4033 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4036 /* Restore external setting of expansion variables for continuation
4039 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4040 save_expand_nlength);
4044 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4045 expanding an internal string that isn't actually going to be used. All we
4046 need to do is check the syntax, so don't do a lookup at all. Preserve the
4047 values of the numerical expansion variables in case they get changed by a
4048 partial lookup. If not, they retain their external settings. At the end
4049 of this "lookup" section, they get restored to their previous values. */
4053 int stype, partial, affixlen, starflags;
4054 int expand_setup = 0;
4056 uschar *key, *filename, *affix;
4057 uschar *save_lookup_value = lookup_value;
4058 int save_expand_nmax =
4059 save_expand_strings(save_expand_nstring, save_expand_nlength);
4061 if ((expand_forbid & RDO_LOOKUP) != 0)
4063 expand_string_message = US"lookup expansions are not permitted";
4067 /* Get the key we are to look up for single-key+file style lookups.
4068 Otherwise set the key NULL pro-tem. */
4070 while (isspace(*s)) s++;
4071 if (*s == '{') /*}*/
4073 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4074 if (key == NULL) goto EXPAND_FAILED; /*{*/
4075 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4076 while (isspace(*s)) s++;
4080 /* Find out the type of database */
4084 expand_string_message = US"missing lookup type";
4088 /* The type is a string that may contain special characters of various
4089 kinds. Allow everything except space or { to appear; the actual content
4090 is checked by search_findtype_partial. */ /*}*/
4092 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4094 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4098 while (isspace(*s)) s++;
4100 /* Now check for the individual search type and any partial or default
4101 options. Only those types that are actually in the binary are valid. */
4103 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4107 expand_string_message = search_error_message;
4111 /* Check that a key was provided for those lookup types that need it,
4112 and was not supplied for those that use the query style. */
4114 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4118 expand_string_message = string_sprintf("missing {key} for single-"
4119 "key \"%s\" lookup", name);
4127 expand_string_message = string_sprintf("a single key was given for "
4128 "lookup type \"%s\", which is not a single-key lookup type", name);
4133 /* Get the next string in brackets and expand it. It is the file name for
4134 single-key+file lookups, and the whole query otherwise. In the case of
4135 queries that also require a file name (e.g. sqlite), the file name comes
4138 if (*s != '{') goto EXPAND_FAILED_CURLY;
4139 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4140 if (filename == NULL) goto EXPAND_FAILED;
4141 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4142 while (isspace(*s)) s++;
4144 /* If this isn't a single-key+file lookup, re-arrange the variables
4145 to be appropriate for the search_ functions. For query-style lookups,
4146 there is just a "key", and no file name. For the special query-style +
4147 file types, the query (i.e. "key") starts with a file name. */
4151 while (isspace(*filename)) filename++;
4154 if (mac_islookup(stype, lookup_querystyle))
4160 if (*filename != '/')
4162 expand_string_message = string_sprintf(
4163 "absolute file name expected for \"%s\" lookup", name);
4166 while (*key != 0 && !isspace(*key)) key++;
4167 if (*key != 0) *key++ = 0;
4171 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4172 the entry was not found. Note that there is no search_close() function.
4173 Files are left open in case of re-use. At suitable places in higher logic,
4174 search_tidyup() is called to tidy all open files. This can save opening
4175 the same file several times. However, files may also get closed when
4176 others are opened, if too many are open at once. The rule is that a
4177 handle should not be used after a second search_open().
4179 Request that a partial search sets up $1 and maybe $2 by passing
4180 expand_setup containing zero. If its value changes, reset expand_nmax,
4181 since new variables will have been set. Note that at the end of this
4182 "lookup" section, the old numeric variables are restored. */
4185 lookup_value = NULL;
4188 void *handle = search_open(filename, stype, 0, NULL, NULL);
4191 expand_string_message = search_error_message;
4194 lookup_value = search_find(handle, filename, key, partial, affix,
4195 affixlen, starflags, &expand_setup);
4196 if (search_find_defer)
4198 expand_string_message =
4199 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4200 string_printing2(key, FALSE), search_error_message);
4203 if (expand_setup > 0) expand_nmax = expand_setup;
4206 /* The handling of "yes" and "no" result strings is now in a separate
4207 function that is also used by ${if} and ${extract}. */
4209 switch(process_yesno(
4210 skipping, /* were previously skipping */
4211 lookup_value != NULL, /* success/failure indicator */
4212 save_lookup_value, /* value to reset for string2 */
4213 &s, /* input pointer */
4214 &yield, /* output pointer */
4215 &size, /* output size */
4216 &ptr, /* output current point */
4217 US"lookup", /* condition type */
4220 case 1: goto EXPAND_FAILED; /* when all is well, the */
4221 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4224 /* Restore external setting of expansion variables for carrying on
4225 at this level, and continue. */
4227 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4228 save_expand_nlength);
4232 /* If Perl support is configured, handle calling embedded perl subroutines,
4233 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4234 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4235 arguments (defined below). */
4237 #define EXIM_PERL_MAX_ARGS 8
4241 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4242 "is not included in this binary";
4245 #else /* EXIM_PERL */
4247 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4250 if ((expand_forbid & RDO_PERL) != 0)
4252 expand_string_message = US"Perl calls are not permitted";
4256 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4257 US"perl", &resetok))
4259 case 1: goto EXPAND_FAILED_CURLY;
4261 case 3: goto EXPAND_FAILED;
4264 /* If skipping, we don't actually do anything */
4266 if (skipping) continue;
4268 /* Start the interpreter if necessary */
4270 if (!opt_perl_started)
4273 if (opt_perl_startup == NULL)
4275 expand_string_message = US"A setting of perl_startup is needed when "
4276 "using the Perl interpreter";
4279 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4280 initerror = init_perl(opt_perl_startup);
4281 if (initerror != NULL)
4283 expand_string_message =
4284 string_sprintf("error in perl_startup code: %s\n", initerror);
4287 opt_perl_started = TRUE;
4290 /* Call the function */
4292 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4293 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4294 sub_arg[0], sub_arg + 1);
4296 /* NULL yield indicates failure; if the message pointer has been set to
4297 NULL, the yield was undef, indicating a forced failure. Otherwise the
4298 message will indicate some kind of Perl error. */
4300 if (new_yield == NULL)
4302 if (expand_string_message == NULL)
4304 expand_string_message =
4305 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4306 "failure", sub_arg[0]);
4307 expand_string_forcedfail = TRUE;
4312 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4313 set during a callback from Perl. */
4315 expand_string_forcedfail = FALSE;
4319 #endif /* EXIM_PERL */
4321 /* Transform email address to "prvs" scheme to use
4322 as BATV-signed return path */
4329 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4331 case 1: goto EXPAND_FAILED_CURLY;
4333 case 3: goto EXPAND_FAILED;
4336 /* If skipping, we don't actually do anything */
4337 if (skipping) continue;
4339 /* sub_arg[0] is the address */
4340 domain = Ustrrchr(sub_arg[0],'@');
4341 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4343 expand_string_message = US"prvs first argument must be a qualified email address";
4347 /* Calculate the hash. The second argument must be a single-digit
4348 key number, or unset. */
4350 if (sub_arg[2] != NULL &&
4351 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4353 expand_string_message = US"prvs second argument must be a single digit";
4357 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4360 expand_string_message = US"prvs hmac-sha1 conversion failed";
4364 /* Now separate the domain from the local part */
4367 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4368 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4369 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4370 string_cat(yield,&size,&ptr,p,6);
4371 string_cat(yield,&size,&ptr,US"=",1);
4372 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4373 string_cat(yield,&size,&ptr,US"@",1);
4374 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4379 /* Check a prvs-encoded address for validity */
4381 case EITEM_PRVSCHECK:
4384 int mysize = 0, myptr = 0;
4388 /* TF: Ugliness: We want to expand parameter 1 first, then set
4389 up expansion variables that are used in the expansion of
4390 parameter 2. So we clone the string for the first
4391 expansion, where we only expand parameter 1.
4393 PH: Actually, that isn't necessary. The read_subs() function is
4394 designed to work this way for the ${if and ${lookup expansions. I've
4398 /* Reset expansion variables */
4399 prvscheck_result = NULL;
4400 prvscheck_address = NULL;
4401 prvscheck_keynum = NULL;
4403 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4405 case 1: goto EXPAND_FAILED_CURLY;
4407 case 3: goto EXPAND_FAILED;
4410 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4413 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4415 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4416 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4417 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4418 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4419 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4421 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4422 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4423 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4424 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4425 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4427 /* Set up expansion variables */
4428 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4429 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4430 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4431 prvscheck_address[myptr] = '\0';
4432 prvscheck_keynum = string_copy(key_num);
4434 /* Now expand the second argument */
4435 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4437 case 1: goto EXPAND_FAILED_CURLY;
4439 case 3: goto EXPAND_FAILED;
4442 /* Now we have the key and can check the address. */
4444 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4449 expand_string_message = US"hmac-sha1 conversion failed";
4453 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4454 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4456 if (Ustrcmp(p,hash) == 0)
4458 /* Success, valid BATV address. Now check the expiry date. */
4459 uschar *now = prvs_daystamp(0);
4460 unsigned int inow = 0,iexpire = 1;
4462 (void)sscanf(CS now,"%u",&inow);
4463 (void)sscanf(CS daystamp,"%u",&iexpire);
4465 /* When "iexpire" is < 7, a "flip" has occured.
4466 Adjust "inow" accordingly. */
4467 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4469 if (iexpire >= inow)
4471 prvscheck_result = US"1";
4472 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4476 prvscheck_result = NULL;
4477 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4482 prvscheck_result = NULL;
4483 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4486 /* Now expand the final argument. We leave this till now so that
4487 it can include $prvscheck_result. */
4489 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4491 case 1: goto EXPAND_FAILED_CURLY;
4493 case 3: goto EXPAND_FAILED;
4496 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4497 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4499 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4501 /* Reset the "internal" variables afterwards, because they are in
4502 dynamic store that will be reclaimed if the expansion succeeded. */
4504 prvscheck_address = NULL;
4505 prvscheck_keynum = NULL;
4509 /* Does not look like a prvs encoded address, return the empty string.
4510 We need to make sure all subs are expanded first, so as to skip over
4513 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4515 case 1: goto EXPAND_FAILED_CURLY;
4517 case 3: goto EXPAND_FAILED;
4524 /* Handle "readfile" to insert an entire file */
4526 case EITEM_READFILE:
4531 if ((expand_forbid & RDO_READFILE) != 0)
4533 expand_string_message = US"file insertions are not permitted";
4537 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4539 case 1: goto EXPAND_FAILED_CURLY;
4541 case 3: goto EXPAND_FAILED;
4544 /* If skipping, we don't actually do anything */
4546 if (skipping) continue;
4548 /* Open the file and read it */
4550 f = Ufopen(sub_arg[0], "rb");
4553 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4557 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4562 /* Handle "readsocket" to insert data from a Unix domain socket */
4564 case EITEM_READSOCK:
4570 struct sockaddr_un sockun; /* don't call this "sun" ! */
4574 if ((expand_forbid & RDO_READSOCK) != 0)
4576 expand_string_message = US"socket insertions are not permitted";
4580 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4581 because there may be a string for expansion on failure. */
4583 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4585 case 1: goto EXPAND_FAILED_CURLY;
4586 case 2: /* Won't occur: no end check */
4587 case 3: goto EXPAND_FAILED;
4590 /* Sort out timeout, if given */
4592 if (sub_arg[2] != NULL)
4594 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4597 expand_string_message = string_sprintf("bad time value %s",
4602 else sub_arg[3] = NULL; /* No eol if no timeout */
4604 /* If skipping, we don't actually do anything. Otherwise, arrange to
4605 connect to either an IP or a Unix socket. */
4609 /* Handle an IP (internet) domain */
4611 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4614 uschar *server_name = sub_arg[0] + 5;
4615 uschar *port_name = Ustrrchr(server_name, ':');
4617 /* Sort out the port */
4619 if (port_name == NULL)
4621 expand_string_message =
4622 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4625 *port_name++ = 0; /* Terminate server name */
4627 if (isdigit(*port_name))
4630 port = Ustrtol(port_name, &end, 0);
4631 if (end != port_name + Ustrlen(port_name))
4633 expand_string_message =
4634 string_sprintf("invalid port number %s", port_name);
4640 struct servent *service_info = getservbyname(CS port_name, "tcp");
4641 if (service_info == NULL)
4643 expand_string_message = string_sprintf("unknown port \"%s\"",
4647 port = ntohs(service_info->s_port);
4650 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4651 timeout, NULL, &expand_string_message)) < 0)
4655 /* Handle a Unix domain socket */
4660 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4662 expand_string_message = string_sprintf("failed to create socket: %s",
4667 sockun.sun_family = AF_UNIX;
4668 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4671 sigalrm_seen = FALSE;
4673 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4677 expand_string_message = US "socket connect timed out";
4682 expand_string_message = string_sprintf("failed to connect to socket "
4683 "%s: %s", sub_arg[0], strerror(errno));
4688 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4690 /* Allow sequencing of test actions */
4691 if (running_in_test_harness) millisleep(100);
4693 /* Write the request string, if not empty */
4695 if (sub_arg[1][0] != 0)
4697 int len = Ustrlen(sub_arg[1]);
4698 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4700 if (write(fd, sub_arg[1], len) != len)
4702 expand_string_message = string_sprintf("request write to socket "
4703 "failed: %s", strerror(errno));
4708 /* Shut down the sending side of the socket. This helps some servers to
4709 recognise that it is their turn to do some work. Just in case some
4710 system doesn't have this function, make it conditional. */
4713 shutdown(fd, SHUT_WR);
4716 if (running_in_test_harness) millisleep(100);
4718 /* Now we need to read from the socket, under a timeout. The function
4719 that reads a file can be used. */
4721 f = fdopen(fd, "rb");
4722 sigalrm_seen = FALSE;
4724 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4728 /* After a timeout, we restore the pointer in the result, that is,
4729 make sure we add nothing from the socket. */
4734 expand_string_message = US "socket read timed out";
4739 /* The whole thing has worked (or we were skipping). If there is a
4740 failure string following, we need to skip it. */
4744 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4746 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4747 while (isspace(*s)) s++;
4749 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4752 /* Come here on failure to create socket, connect socket, write to the
4753 socket, or timeout on reading. If another substring follows, expand and
4754 use it. Otherwise, those conditions give expand errors. */
4757 if (*s != '{') goto EXPAND_FAILED;
4758 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4759 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4760 if (arg == NULL) goto EXPAND_FAILED;
4761 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4762 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4763 while (isspace(*s)) s++;
4764 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4768 /* Handle "run" to execute a program. */
4780 if ((expand_forbid & RDO_RUN) != 0)
4782 expand_string_message = US"running a command is not permitted";
4786 while (isspace(*s)) s++;
4787 if (*s != '{') goto EXPAND_FAILED_CURLY;
4788 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4789 if (arg == NULL) goto EXPAND_FAILED;
4790 while (isspace(*s)) s++;
4791 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4793 if (skipping) /* Just pretend it worked when we're skipping */
4799 if (!transport_set_up_command(&argv, /* anchor for arg list */
4800 arg, /* raw command */
4801 FALSE, /* don't expand the arguments */
4802 0, /* not relevant when... */
4803 NULL, /* no transporting address */
4804 US"${run} expansion", /* for error messages */
4805 &expand_string_message)) /* where to put error message */
4810 /* Create the child process, making it a group leader. */
4812 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4816 expand_string_message =
4817 string_sprintf("couldn't create child process: %s", strerror(errno));
4821 /* Nothing is written to the standard input. */
4825 /* Read the pipe to get the command's output into $value (which is kept
4826 in lookup_value). Read during execution, so that if the output exceeds
4827 the OS pipe buffer limit, we don't block forever. */
4829 f = fdopen(fd_out, "rb");
4830 sigalrm_seen = FALSE;
4832 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4836 /* Wait for the process to finish, applying the timeout, and inspect its
4837 return code for serious disasters. Simple non-zero returns are passed on.
4840 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4842 if (sigalrm_seen == TRUE || runrc == -256)
4844 expand_string_message = string_sprintf("command timed out");
4845 killpg(pid, SIGKILL); /* Kill the whole process group */
4848 else if (runrc == -257)
4849 expand_string_message = string_sprintf("wait() failed: %s",
4853 expand_string_message = string_sprintf("command killed by signal %d",
4860 /* Process the yes/no strings; $value may be useful in both cases */
4862 switch(process_yesno(
4863 skipping, /* were previously skipping */
4864 runrc == 0, /* success/failure indicator */
4865 lookup_value, /* value to reset for string2 */
4866 &s, /* input pointer */
4867 &yield, /* output pointer */
4868 &size, /* output size */
4869 &ptr, /* output current point */
4870 US"run", /* condition type */
4873 case 1: goto EXPAND_FAILED; /* when all is well, the */
4874 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4880 /* Handle character translation for "tr" */
4888 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4890 case 1: goto EXPAND_FAILED_CURLY;
4892 case 3: goto EXPAND_FAILED;
4895 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4896 o2m = Ustrlen(sub[2]) - 1;
4898 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4900 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4904 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4911 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4912 expanded arguments. */
4922 int val[2] = { 0, -1 };
4925 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4926 Ensure that sub[2] is set in the ${length } case. */
4929 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4930 TRUE, name, &resetok))
4932 case 1: goto EXPAND_FAILED_CURLY;
4934 case 3: goto EXPAND_FAILED;
4937 /* Juggle the arguments if there are only two of them: always move the
4938 string to the last position and make ${length{n}{str}} equivalent to
4939 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4945 if (item_type == EITEM_LENGTH)
4952 for (i = 0; i < 2; i++)
4954 if (sub[i] == NULL) continue;
4955 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4956 if (*ret != 0 || (i != 0 && val[i] < 0))
4958 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4959 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4965 (item_type == EITEM_HASH)?
4966 compute_hash(sub[2], val[0], val[1], &len) :
4967 (item_type == EITEM_NHASH)?
4968 compute_nhash(sub[2], val[0], val[1], &len) :
4969 extract_substr(sub[2], val[0], val[1], &len);
4971 if (ret == NULL) goto EXPAND_FAILED;
4972 yield = string_cat(yield, &size, &ptr, ret, len);
4976 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4977 This code originally contributed by Steve Haslam. It currently supports
4978 the use of MD5 and SHA-1 hashes.
4980 We need some workspace that is large enough to handle all the supported
4981 hash types. Use macros to set the sizes rather than be too elaborate. */
4983 #define MAX_HASHLEN 20
4984 #define MAX_HASHBLOCKLEN 64
4993 int hashlen; /* Number of octets for the hash algorithm's output */
4994 int hashblocklen; /* Number of octets the hash algorithm processes */
4996 unsigned int keylen;
4998 uschar keyhash[MAX_HASHLEN];
4999 uschar innerhash[MAX_HASHLEN];
5000 uschar finalhash[MAX_HASHLEN];
5001 uschar finalhash_hex[2*MAX_HASHLEN];
5002 uschar innerkey[MAX_HASHBLOCKLEN];
5003 uschar outerkey[MAX_HASHBLOCKLEN];
5005 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
5007 case 1: goto EXPAND_FAILED_CURLY;
5009 case 3: goto EXPAND_FAILED;
5012 if (Ustrcmp(sub[0], "md5") == 0)
5015 use_base = &md5_base;
5019 else if (Ustrcmp(sub[0], "sha1") == 0)
5022 use_base = &sha1_base;
5028 expand_string_message =
5029 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5034 keylen = Ustrlen(keyptr);
5036 /* If the key is longer than the hash block length, then hash the key
5039 if (keylen > hashblocklen)
5041 chash_start(type, use_base);
5042 chash_end(type, use_base, keyptr, keylen, keyhash);
5047 /* Now make the inner and outer key values */
5049 memset(innerkey, 0x36, hashblocklen);
5050 memset(outerkey, 0x5c, hashblocklen);
5052 for (i = 0; i < keylen; i++)
5054 innerkey[i] ^= keyptr[i];
5055 outerkey[i] ^= keyptr[i];
5058 /* Now do the hashes */
5060 chash_start(type, use_base);
5061 chash_mid(type, use_base, innerkey);
5062 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5064 chash_start(type, use_base);
5065 chash_mid(type, use_base, outerkey);
5066 chash_end(type, use_base, innerhash, hashlen, finalhash);
5068 /* Encode the final hash as a hex string */
5071 for (i = 0; i < hashlen; i++)
5073 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5074 *p++ = hex_digits[finalhash[i] & 0x0f];
5077 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5078 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5080 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5085 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5086 We have to save the numerical variables and restore them afterwards. */
5091 int moffset, moffsetextra, slen;
5094 const uschar *rerror;
5097 int save_expand_nmax =
5098 save_expand_strings(save_expand_nstring, save_expand_nlength);
5100 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5102 case 1: goto EXPAND_FAILED_CURLY;
5104 case 3: goto EXPAND_FAILED;
5107 /* Compile the regular expression */
5109 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5114 expand_string_message = string_sprintf("regular expression error in "
5115 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5119 /* Now run a loop to do the substitutions as often as necessary. It ends
5120 when there are no more matches. Take care over matches of the null string;
5121 do the same thing as Perl does. */
5124 slen = Ustrlen(sub[0]);
5125 moffset = moffsetextra = 0;
5130 int ovector[3*(EXPAND_MAXN+1)];
5131 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5132 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
5136 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5137 is not necessarily the end. We want to repeat the match from one
5138 character further along, but leaving the basic offset the same (for
5139 copying below). We can't be at the end of the string - that was checked
5140 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5141 finished; copy the remaining string and end the loop. */
5151 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5155 /* Match - set up for expanding the replacement. */
5157 if (n == 0) n = EXPAND_MAXN + 1;
5159 for (nn = 0; nn < n*2; nn += 2)
5161 expand_nstring[expand_nmax] = subject + ovector[nn];
5162 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5166 /* Copy the characters before the match, plus the expanded insertion. */
5168 yield = string_cat(yield, &size, &ptr, subject + moffset,
5169 ovector[0] - moffset);
5170 insert = expand_string(sub[2]);
5171 if (insert == NULL) goto EXPAND_FAILED;
5172 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5174 moffset = ovector[1];
5178 /* If we have matched an empty string, first check to see if we are at
5179 the end of the subject. If so, the loop is over. Otherwise, mimic
5180 what Perl's /g options does. This turns out to be rather cunning. First
5181 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5182 string at the same point. If this fails (picked up above) we advance to
5183 the next character. */
5185 if (ovector[0] == ovector[1])
5187 if (ovector[0] == slen) break;
5188 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5192 /* All done - restore numerical variables. */
5194 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5195 save_expand_nlength);
5199 /* Handle keyed and numbered substring extraction. If the first argument
5200 consists entirely of digits, then a numerical extraction is assumed. */
5206 int field_number = 1;
5207 BOOL field_number_set = FALSE;
5208 uschar *save_lookup_value = lookup_value;
5210 int save_expand_nmax =
5211 save_expand_strings(save_expand_nstring, save_expand_nlength);
5213 /* Read the arguments */
5215 for (i = 0; i < j; i++)
5217 while (isspace(*s)) s++;
5218 if (*s == '{') /*}*/
5220 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5221 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5222 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5224 /* After removal of leading and trailing white space, the first
5225 argument must not be empty; if it consists entirely of digits
5226 (optionally preceded by a minus sign), this is a numerical
5227 extraction, and we expect 3 arguments. */
5235 while (isspace(*p)) p++;
5239 while (len > 0 && isspace(p[len-1])) len--;
5246 expand_string_message = US"first argument of \"extract\" must "
5256 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5260 j = 3; /* Need 3 args */
5261 field_number_set = TRUE;
5266 else goto EXPAND_FAILED_CURLY;
5269 /* Extract either the numbered or the keyed substring into $value. If
5270 skipping, just pretend the extraction failed. */
5272 lookup_value = skipping? NULL : field_number_set?
5273 expand_gettokened(field_number, sub[1], sub[2]) :
5274 expand_getkeyed(sub[0], sub[1]);
5276 /* If no string follows, $value gets substituted; otherwise there can
5277 be yes/no strings, as for lookup or if. */
5279 switch(process_yesno(
5280 skipping, /* were previously skipping */
5281 lookup_value != NULL, /* success/failure indicator */
5282 save_lookup_value, /* value to reset for string2 */
5283 &s, /* input pointer */
5284 &yield, /* output pointer */
5285 &size, /* output size */
5286 &ptr, /* output current point */
5287 US"extract", /* condition type */
5290 case 1: goto EXPAND_FAILED; /* when all is well, the */
5291 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5294 /* All done - restore numerical variables. */
5296 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5297 save_expand_nlength);
5302 /* return the Nth item from a list */
5304 case EITEM_LISTEXTRACT:
5307 int field_number = 1;
5308 uschar *save_lookup_value = lookup_value;
5310 int save_expand_nmax =
5311 save_expand_strings(save_expand_nstring, save_expand_nlength);
5313 /* Read the field & list arguments */
5315 for (i = 0; i < 2; i++)
5317 while (isspace(*s)) s++;
5318 if (*s != '{') /*}*/
5319 goto EXPAND_FAILED_CURLY;
5321 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5322 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5323 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5325 /* After removal of leading and trailing white space, the first
5326 argument must be numeric and nonempty. */
5334 while (isspace(*p)) p++;
5338 while (len > 0 && isspace(p[len-1])) len--;
5341 if (!*p && !skipping)
5343 expand_string_message = US"first argument of \"listextract\" must "
5353 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5356 expand_string_message = US"first argument of \"listextract\" must "
5364 /* Extract the numbered element into $value. If
5365 skipping, just pretend the extraction failed. */
5367 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5369 /* If no string follows, $value gets substituted; otherwise there can
5370 be yes/no strings, as for lookup or if. */
5372 switch(process_yesno(
5373 skipping, /* were previously skipping */
5374 lookup_value != NULL, /* success/failure indicator */
5375 save_lookup_value, /* value to reset for string2 */
5376 &s, /* input pointer */
5377 &yield, /* output pointer */
5378 &size, /* output size */
5379 &ptr, /* output current point */
5380 US"extract", /* condition type */
5383 case 1: goto EXPAND_FAILED; /* when all is well, the */
5384 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5387 /* All done - restore numerical variables. */
5389 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5390 save_expand_nlength);
5396 case EITEM_CERTEXTRACT:
5398 uschar *save_lookup_value = lookup_value;
5400 int save_expand_nmax =
5401 save_expand_strings(save_expand_nstring, save_expand_nlength);
5403 /* Read the field argument */
5404 while (isspace(*s)) s++;
5405 if (*s != '{') /*}*/
5406 goto EXPAND_FAILED_CURLY;
5407 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5408 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5409 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5410 /* strip spaces fore & aft */
5415 while (isspace(*p)) p++;
5419 while (len > 0 && isspace(p[len-1])) len--;
5423 /* inspect the cert argument */
5424 while (isspace(*s)) s++;
5425 if (*s != '{') /*}*/
5426 goto EXPAND_FAILED_CURLY;
5429 expand_string_message = US"second argument of \"certextract\" must "
5430 "be a certificate variable";
5433 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5434 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5435 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5438 lookup_value = NULL;
5441 lookup_value = expand_getcertele(sub[0], sub[1]);
5442 if (*expand_string_message) goto EXPAND_FAILED;
5444 switch(process_yesno(
5445 skipping, /* were previously skipping */
5446 lookup_value != NULL, /* success/failure indicator */
5447 save_lookup_value, /* value to reset for string2 */
5448 &s, /* input pointer */
5449 &yield, /* output pointer */
5450 &size, /* output size */
5451 &ptr, /* output current point */
5452 US"extract", /* condition type */
5455 case 1: goto EXPAND_FAILED; /* when all is well, the */
5456 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5459 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5460 save_expand_nlength);
5463 #endif /*SUPPORT_TLS*/
5465 /* Handle list operations */
5473 uschar outsep[2] = { '\0', '\0' };
5474 uschar *list, *expr, *temp;
5475 uschar *save_iterate_item = iterate_item;
5476 uschar *save_lookup_value = lookup_value;
5478 while (isspace(*s)) s++;
5479 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5481 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5482 if (list == NULL) goto EXPAND_FAILED;
5483 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5485 if (item_type == EITEM_REDUCE)
5487 while (isspace(*s)) s++;
5488 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5489 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5490 if (temp == NULL) goto EXPAND_FAILED;
5491 lookup_value = temp;
5492 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5495 while (isspace(*s)) s++;
5496 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5500 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5501 if scanning a "false" part). This allows us to find the end of the
5502 condition, because if the list is empty, we won't actually evaluate the
5503 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5504 the normal internal expansion function. */
5506 if (item_type == EITEM_FILTER)
5508 temp = eval_condition(expr, &resetok, NULL);
5509 if (temp != NULL) s = temp;
5513 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5518 expand_string_message = string_sprintf("%s inside \"%s\" item",
5519 expand_string_message, name);
5523 while (isspace(*s)) s++;
5526 expand_string_message = string_sprintf("missing } at end of condition "
5527 "or expression inside \"%s\"", name);
5531 while (isspace(*s)) s++; /*{*/
5534 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5539 /* If we are skipping, we can now just move on to the next item. When
5540 processing for real, we perform the iteration. */
5542 if (skipping) continue;
5543 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5545 *outsep = (uschar)sep; /* Separator as a string */
5547 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5549 if (item_type == EITEM_FILTER)
5552 if (eval_condition(expr, &resetok, &condresult) == NULL)
5554 iterate_item = save_iterate_item;
5555 lookup_value = save_lookup_value;
5556 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5557 expand_string_message, name);
5560 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5561 condresult? "true":"false");
5563 temp = iterate_item; /* TRUE => include this item */
5565 continue; /* FALSE => skip this item */
5568 /* EITEM_MAP and EITEM_REDUCE */
5572 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5575 iterate_item = save_iterate_item;
5576 expand_string_message = string_sprintf("%s inside \"%s\" item",
5577 expand_string_message, name);
5580 if (item_type == EITEM_REDUCE)
5582 lookup_value = temp; /* Update the value of $value */
5583 continue; /* and continue the iteration */
5587 /* We reach here for FILTER if the condition is true, always for MAP,
5588 and never for REDUCE. The value in "temp" is to be added to the output
5589 list that is being created, ensuring that any occurrences of the
5590 separator character are doubled. Unless we are dealing with the first
5591 item of the output list, add in a space if the new item begins with the
5592 separator character, or is an empty string. */
5594 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5595 yield = string_cat(yield, &size, &ptr, US" ", 1);
5597 /* Add the string in "temp" to the output list that we are building,
5598 This is done in chunks by searching for the separator character. */
5602 size_t seglen = Ustrcspn(temp, outsep);
5603 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5605 /* If we got to the end of the string we output one character
5606 too many; backup and end the loop. Otherwise arrange to double the
5609 if (temp[seglen] == '\0') { ptr--; break; }
5610 yield = string_cat(yield, &size, &ptr, outsep, 1);
5614 /* Output a separator after the string: we will remove the redundant
5615 final one at the end. */
5617 yield = string_cat(yield, &size, &ptr, outsep, 1);
5618 } /* End of iteration over the list loop */
5620 /* REDUCE has generated no output above: output the final value of
5623 if (item_type == EITEM_REDUCE)
5625 yield = string_cat(yield, &size, &ptr, lookup_value,
5626 Ustrlen(lookup_value));
5627 lookup_value = save_lookup_value; /* Restore $value */
5630 /* FILTER and MAP generate lists: if they have generated anything, remove
5631 the redundant final separator. Even though an empty item at the end of a
5632 list does not count, this is tidier. */
5634 else if (ptr != save_ptr) ptr--;
5636 /* Restore preserved $item */
5638 iterate_item = save_iterate_item;
5645 uschar *srclist, *cmp, *xtract;
5647 uschar *dstlist = NULL;
5648 uschar *dstkeylist = NULL;
5650 uschar *save_iterate_item = iterate_item;
5652 while (isspace(*s)) s++;
5653 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5655 srclist = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5656 if (!srclist) goto EXPAND_FAILED;
5657 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5659 while (isspace(*s)) s++;
5660 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5662 cmp = expand_string_internal(s, TRUE, &s, skipping, FALSE, &resetok);
5663 if (!cmp) goto EXPAND_FAILED;
5664 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5666 while (isspace(*s)) s++;
5667 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5670 tmp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5671 if (!tmp) goto EXPAND_FAILED;
5672 xtract = string_copyn(xtract, s - xtract);
5674 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5678 expand_string_message = US"missing } at end of \"sort\"";
5682 if (skipping) continue;
5684 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
5687 uschar * newlist = NULL;
5688 uschar * newkeylist = NULL;
5691 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, srcitem);
5693 /* extract field for comparisons */
5694 iterate_item = srcitem;
5695 if ( !(srcfield = expand_string_internal(xtract, FALSE, NULL, FALSE,
5699 expand_string_message = string_sprintf(
5700 "field-extract in sort: \"%s\"", xtract);
5704 /* Insertion sort */
5706 /* copy output list until new-item < list-item */
5707 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5713 /* field for comparison */
5714 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5717 /* build and run condition string */
5718 expr = string_sprintf("%s{%s}{%s}", cmp, srcfield, dstfield);
5720 DEBUG(D_expand) debug_printf("%s: cond = \"%s\"\n", name, expr);
5721 if (!eval_condition(expr, &resetok, &before))
5723 expand_string_message = string_sprintf("comparison in sort: %s",
5730 /* New-item sorts before this dst-item. Append new-item,
5731 then dst-item, then remainder of dst list. */
5733 newlist = string_append_listele(newlist, sep, srcitem);
5734 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5737 newlist = string_append_listele(newlist, sep, dstitem);
5738 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5740 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
5742 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
5744 newlist = string_append_listele(newlist, sep, dstitem);
5745 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5751 newlist = string_append_listele(newlist, sep, dstitem);
5752 newkeylist = string_append_listele(newkeylist, sep, dstfield);
5755 /* If we ran out of dstlist without consuming srcitem, append it */
5758 newlist = string_append_listele(newlist, sep, srcitem);
5759 newkeylist = string_append_listele(newkeylist, sep, srcfield);
5763 dstkeylist = newkeylist;
5765 DEBUG(D_expand) debug_printf("%s: dstlist = \"%s\"\n", name, dstlist);
5766 DEBUG(D_expand) debug_printf("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
5770 yield = string_cat(yield, &size, &ptr, dstlist, Ustrlen(dstlist));
5772 /* Restore preserved $item */
5773 iterate_item = save_iterate_item;
5777 expand_string_message = US"Internal error in sort (list mismatch)";
5782 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5783 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5784 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5785 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5787 #define EXPAND_DLFUNC_MAX_ARGS 8
5790 #ifndef EXPAND_DLFUNC
5791 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5792 "is not included in this binary";
5795 #else /* EXPAND_DLFUNC */
5798 exim_dlfunc_t *func;
5801 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5803 if ((expand_forbid & RDO_DLFUNC) != 0)
5805 expand_string_message =
5806 US"dynamically-loaded functions are not permitted";
5810 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5811 TRUE, US"dlfunc", &resetok))
5813 case 1: goto EXPAND_FAILED_CURLY;
5815 case 3: goto EXPAND_FAILED;
5818 /* If skipping, we don't actually do anything */
5820 if (skipping) continue;
5822 /* Look up the dynamically loaded object handle in the tree. If it isn't
5823 found, dlopen() the file and put the handle in the tree for next time. */
5825 t = tree_search(dlobj_anchor, argv[0]);
5828 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5831 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5832 argv[0], dlerror());
5833 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5836 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5837 Ustrcpy(t->name, argv[0]);
5838 t->data.ptr = handle;
5839 (void)tree_insertnode(&dlobj_anchor, t);
5842 /* Having obtained the dynamically loaded object handle, look up the
5843 function pointer. */
5845 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5848 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5849 "%s", argv[1], argv[0], dlerror());
5850 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5854 /* Call the function and work out what to do with the result. If it
5855 returns OK, we have a replacement string; if it returns DEFER then
5856 expansion has failed in a non-forced manner; if it returns FAIL then
5857 failure was forced; if it returns ERROR or any other value there's a
5858 problem, so panic slightly. In any case, assume that the function has
5859 side-effects on the store that must be preserved. */
5863 for (argc = 0; argv[argc] != NULL; argc++);
5864 status = func(&result, argc - 2, &argv[2]);
5867 if (result == NULL) result = US"";
5868 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5873 expand_string_message = result == NULL ? US"(no message)" : result;
5874 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5875 else if(status != FAIL)
5876 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5877 argv[0], argv[1], status, expand_string_message);
5881 #endif /* EXPAND_DLFUNC */
5882 } /* EITEM_* switch */
5884 /* Control reaches here if the name is not recognized as one of the more
5885 complicated expansion items. Check for the "operator" syntax (name terminated
5886 by a colon). Some of the operators have arguments, separated by _ from the
5894 var_entry *vp = NULL;
5896 /* Owing to an historical mis-design, an underscore may be part of the
5897 operator name, or it may introduce arguments. We therefore first scan the
5898 table of names that contain underscores. If there is no match, we cut off
5899 the arguments and then scan the main table. */
5901 if ((c = chop_match(name, op_table_underscore,
5902 sizeof(op_table_underscore)/sizeof(uschar *))) < 0)
5904 arg = Ustrchr(name, '_');
5905 if (arg != NULL) *arg = 0;
5906 c = chop_match(name, op_table_main,
5907 sizeof(op_table_main)/sizeof(uschar *));
5908 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5909 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5912 /* Deal specially with operators that might take a certificate variable
5913 as we do not want to do the usual expansion. For most, expand the string.*/
5923 sub = expand_string_internal(s+2, TRUE, &s1, skipping,
5925 if (!sub) goto EXPAND_FAILED; /*{*/
5926 if (*s1 != '}') goto EXPAND_FAILED_CURLY;
5927 if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
5937 sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5938 if (!sub) goto EXPAND_FAILED;
5943 /* If we are skipping, we don't need to perform the operation at all.
5944 This matters for operations like "mask", because the data may not be
5945 in the correct format when skipping. For example, the expression may test
5946 for the existence of $sender_host_address before trying to mask it. For
5947 other operations, doing them may not fail, but it is a waste of time. */
5949 if (skipping && c >= 0) continue;
5951 /* Otherwise, switch on the operator type */
5958 unsigned long int n = Ustrtoul(sub, &t, 10);
5961 expand_string_message = string_sprintf("argument for base62 "
5962 "operator is \"%s\", which is not a decimal number", sub);
5965 t = string_base62(n);
5966 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5970 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5976 unsigned long int n = 0;
5979 uschar *t = Ustrchr(base62_chars, *tt++);
5982 expand_string_message = string_sprintf("argument for base62d "
5983 "operator is \"%s\", which is not a base %d number", sub,
5987 n = n * BASE_62 + (t - base62_chars);
5989 (void)sprintf(CS buf, "%ld", n);
5990 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5996 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
5997 if (expanded == NULL)
5999 expand_string_message =
6000 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
6001 expand_string_message);
6004 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
6011 uschar *t = sub - 1;
6012 while (*(++t) != 0) { *t = tolower(*t); count++; }
6013 yield = string_cat(yield, &size, &ptr, sub, count);
6020 uschar *t = sub - 1;
6021 while (*(++t) != 0) { *t = toupper(*t); count++; }
6022 yield = string_cat(yield, &size, &ptr, sub, count);
6028 if (vp && *(void **)vp->value)
6030 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
6031 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6041 md5_end(&base, sub, Ustrlen(sub), digest);
6042 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
6043 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6049 if (vp && *(void **)vp->value)
6051 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
6052 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6062 sha1_end(&base, sub, Ustrlen(sub), digest);
6063 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
6064 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
6070 if (vp && *(void **)vp->value)
6072 uschar * cp = tls_cert_fprt_sha256(*(void **)vp->value);
6073 yield = string_cat(yield, &size, &ptr, cp, (int)Ustrlen(cp));
6077 expand_string_message = US"sha256 only supported for certificates";
6080 /* Convert hex encoding to base64 encoding */
6090 for (enc = sub; *enc != 0; enc++)
6092 if (!isxdigit(*enc))
6094 expand_string_message = string_sprintf("\"%s\" is not a hex "
6103 expand_string_message = string_sprintf("\"%s\" contains an odd "
6104 "number of characters", sub);
6108 while ((c = *in++) != 0)
6110 if (isdigit(c)) c -= '0';
6111 else c = toupper(c) - 'A' + 10;
6123 enc = auth_b64encode(sub, out - sub);
6124 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
6128 /* Convert octets outside 0x21..0x7E to \xXX form */
6132 uschar *t = sub - 1;
6135 if (*t < 0x21 || 0x7E < *t)
6136 yield = string_cat(yield, &size, &ptr,
6137 string_sprintf("\\x%02x", *t), 4);
6139 yield = string_cat(yield, &size, &ptr, t, 1);
6144 /* count the number of list elements */
6153 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
6154 cp = string_sprintf("%d", cnt);
6155 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
6159 /* expand a named list given the name */
6160 /* handles nested named lists; requotes as colon-sep list */
6164 tree_node *t = NULL;
6168 uschar * suffix = US"";
6169 BOOL needsep = FALSE;
6172 if (*sub == '+') sub++;
6173 if (arg == NULL) /* no-argument version */
6175 if (!(t = tree_search(addresslist_anchor, sub)) &&
6176 !(t = tree_search(domainlist_anchor, sub)) &&
6177 !(t = tree_search(hostlist_anchor, sub)))
6178 t = tree_search(localpartlist_anchor, sub);
6180 else switch(*arg) /* specific list-type version */
6182 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
6183 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
6184 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
6185 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
6187 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
6193 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
6195 : *arg=='a'?"address "
6196 : *arg=='d'?"domain "
6198 : *arg=='l'?"localpart "
6203 list = ((namedlist_block *)(t->data.ptr))->string;
6205 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
6207 uschar * buf = US" : ";
6209 yield = string_cat(yield, &size, &ptr, buf, 3);
6213 if (*item == '+') /* list item is itself a named list */
6215 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
6216 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
6218 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6222 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
6223 while ((cp= strpbrk((const char *)item, tok)))
6225 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
6226 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6228 yield = string_cat(yield, &size, &ptr, US"::", 2);
6229 item = (uschar *)cp;
6231 else /* sep in item; should already be doubled; emit once */
6233 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
6234 if (*cp == sep) cp++;
6235 item = (uschar *)cp;
6239 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
6244 /* mask applies a mask to an IP address; for example the result of
6245 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6252 int mask, maskoffset;
6253 int type = string_is_ip_address(sub, &maskoffset);
6258 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6263 if (maskoffset == 0)
6265 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6270 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6272 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6274 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6279 /* Convert the address to binary integer(s) and apply the mask */
6281 sub[maskoffset] = 0;
6282 count = host_aton(sub, binary);
6283 host_mask(count, binary, mask);
6285 /* Convert to masked textual format and add to output. */
6287 yield = string_cat(yield, &size, &ptr, buffer,
6288 host_nmtoa(count, binary, mask, buffer, '.'));
6293 case EOP_LOCAL_PART:
6297 int start, end, domain;
6298 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6302 if (c != EOP_DOMAIN)
6304 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6305 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
6307 else if (domain != 0)
6310 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
6318 uschar outsep[2] = { ':', '\0' };
6319 uschar *address, *error;
6321 int start, end, domain; /* Not really used */
6323 while (isspace(*sub)) sub++;
6324 if (*sub == '>') { *outsep = *++sub; ++sub; }
6325 parse_allow_group = TRUE;
6329 uschar *p = parse_find_address_end(sub, FALSE);
6330 uschar saveend = *p;
6332 address = parse_extract_address(sub, &error, &start, &end, &domain,
6336 /* Add the address to the output list that we are building. This is
6337 done in chunks by searching for the separator character. At the
6338 start, unless we are dealing with the first address of the output
6339 list, add in a space if the new address begins with the separator
6340 character, or is an empty string. */
6342 if (address != NULL)
6344 if (ptr != save_ptr && address[0] == *outsep)
6345 yield = string_cat(yield, &size, &ptr, US" ", 1);
6349 size_t seglen = Ustrcspn(address, outsep);
6350 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
6352 /* If we got to the end of the string we output one character
6355 if (address[seglen] == '\0') { ptr--; break; }
6356 yield = string_cat(yield, &size, &ptr, outsep, 1);
6357 address += seglen + 1;
6360 /* Output a separator after the string: we will remove the
6361 redundant final one at the end. */
6363 yield = string_cat(yield, &size, &ptr, outsep, 1);
6366 if (saveend == '\0') break;
6370 /* If we have generated anything, remove the redundant final
6373 if (ptr != save_ptr) ptr--;
6374 parse_allow_group = FALSE;
6379 /* quote puts a string in quotes if it is empty or contains anything
6380 other than alphamerics, underscore, dot, or hyphen.
6382 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6383 be quoted in order to be a valid local part.
6385 In both cases, newlines and carriage returns are converted into \n and \r
6389 case EOP_QUOTE_LOCAL_PART:
6392 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6393 uschar *t = sub - 1;
6397 while (!needs_quote && *(++t) != 0)
6398 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6400 else /* EOP_QUOTE_LOCAL_PART */
6402 while (!needs_quote && *(++t) != 0)
6403 needs_quote = !isalnum(*t) &&
6404 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6405 (*t != '.' || t == sub || t[1] == 0);
6410 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6415 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6416 else if (*t == '\r')
6417 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6420 if (*t == '\\' || *t == '"')
6421 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6422 yield = string_cat(yield, &size, &ptr, t, 1);
6425 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6427 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6431 /* quote_lookuptype does lookup-specific quoting */
6436 uschar *opt = Ustrchr(arg, '_');
6438 if (opt != NULL) *opt++ = 0;
6440 n = search_findtype(arg, Ustrlen(arg));
6443 expand_string_message = search_error_message;
6447 if (lookup_list[n]->quote != NULL)
6448 sub = (lookup_list[n]->quote)(sub, opt);
6449 else if (opt != NULL) sub = NULL;
6453 expand_string_message = string_sprintf(
6454 "\"%s\" unrecognized after \"${quote_%s\"",
6459 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6463 /* rx quote sticks in \ before any non-alphameric character so that
6464 the insertion works in a regular expression. */
6468 uschar *t = sub - 1;
6472 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6473 yield = string_cat(yield, &size, &ptr, t, 1);
6478 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6479 prescribed by the RFC, if there are characters that need to be encoded */
6483 uschar buffer[2048];
6484 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6485 buffer, sizeof(buffer), FALSE);
6486 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6490 /* RFC 2047 decode */
6496 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6497 headers_charset, '?', &len, &error);
6500 expand_string_message = error;
6503 yield = string_cat(yield, &size, &ptr, decoded, len);
6507 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6517 if (c > 255) c = '_';
6519 yield = string_cat(yield, &size, &ptr, buff, 1);
6524 /* replace illegal UTF-8 sequences by replacement character */
6526 #define UTF8_REPLACEMENT_CHAR US"?"
6530 int seq_len = 0, index = 0;
6532 long codepoint = -1;
6533 uschar seq_buff[4]; /* accumulate utf-8 here */
6542 if ((c & 0xc0) != 0x80)
6544 /* wrong continuation byte; invalidate all bytes */
6545 complete = 1; /* error */
6549 codepoint = (codepoint << 6) | (c & 0x3f);
6550 seq_buff[index++] = c;
6551 if (--bytes_left == 0) /* codepoint complete */
6553 if(codepoint > 0x10FFFF) /* is it too large? */
6554 complete = -1; /* error (RFC3629 limit) */
6556 { /* finished; output utf-8 sequence */
6557 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6563 else /* no bytes left: new sequence */
6565 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6567 yield = string_cat(yield, &size, &ptr, &c, 1);
6570 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6572 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6577 codepoint = c & 0x1f;
6580 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6583 codepoint = c & 0x0f;
6585 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6588 codepoint = c & 0x07;
6590 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6593 seq_buff[index++] = c;
6594 seq_len = bytes_left + 1;
6595 } /* if(bytes_left) */
6599 bytes_left = index = 0;
6600 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6602 if ((complete == 1) && ((c & 0x80) == 0))
6603 { /* ASCII character follows incomplete sequence */
6604 yield = string_cat(yield, &size, &ptr, &c, 1);
6610 /* escape turns all non-printing characters into escape sequences. */
6614 uschar *t = string_printing(sub);
6615 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6619 /* Handle numeric expression evaluation */
6624 uschar *save_sub = sub;
6625 uschar *error = NULL;
6626 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6629 expand_string_message = string_sprintf("error in expression "
6630 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6634 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6635 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6639 /* Handle time period formating */
6643 int n = readconf_readtime(sub, 0, FALSE);
6646 expand_string_message = string_sprintf("string \"%s\" is not an "
6647 "Exim time interval in \"%s\" operator", sub, name);
6650 sprintf(CS var_buffer, "%d", n);
6651 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6655 case EOP_TIME_INTERVAL:
6658 uschar *t = read_number(&n, sub);
6659 if (*t != 0) /* Not A Number*/
6661 expand_string_message = string_sprintf("string \"%s\" is not a "
6662 "positive number in \"%s\" operator", sub, name);
6665 t = readconf_printtime(n);
6666 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6670 /* Convert string to base64 encoding */
6674 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6675 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6679 /* strlen returns the length of the string */
6684 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6685 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6689 /* length_n or l_n takes just the first n characters or the whole string,
6690 whichever is the shorter;
6692 substr_m_n, and s_m_n take n characters from offset m; negative m take
6693 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6694 takes the rest, either to the right or to the left.
6696 hash_n or h_n makes a hash of length n from the string, yielding n
6697 characters from the set a-z; hash_n_m makes a hash of length n, but
6698 uses m characters from the set a-zA-Z0-9.
6700 nhash_n returns a single number between 0 and n-1 (in text form), while
6701 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6702 between 0 and n-1 and the second between 0 and m-1. */
6722 expand_string_message = string_sprintf("missing values after %s",
6727 /* "length" has only one argument, effectively being synonymous with
6730 if (c == EOP_LENGTH || c == EOP_L)
6736 /* The others have one or two arguments; for "substr" the first may be
6737 negative. The second being negative means "not supplied". */
6742 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6745 /* Read up to two numbers, separated by underscores */
6750 if (arg != ret && *arg == '_' && pn == &value1)
6754 if (arg[1] != 0) arg++;
6756 else if (!isdigit(*arg))
6758 expand_string_message =
6759 string_sprintf("non-digit after underscore in \"%s\"", name);
6762 else *pn = (*pn)*10 + *arg++ - '0';
6766 /* Perform the required operation */
6769 (c == EOP_HASH || c == EOP_H)?
6770 compute_hash(sub, value1, value2, &len) :
6771 (c == EOP_NHASH || c == EOP_NH)?
6772 compute_nhash(sub, value1, value2, &len) :
6773 extract_substr(sub, value1, value2, &len);
6775 if (ret == NULL) goto EXPAND_FAILED;
6776 yield = string_cat(yield, &size, &ptr, ret, len);
6786 uschar **modetable[3];
6791 if ((expand_forbid & RDO_EXISTS) != 0)
6793 expand_string_message = US"Use of the stat() expansion is not permitted";
6797 if (stat(CS sub, &st) < 0)
6799 expand_string_message = string_sprintf("stat(%s) failed: %s",
6800 sub, strerror(errno));
6804 switch (mode & S_IFMT)
6806 case S_IFIFO: smode[0] = 'p'; break;
6807 case S_IFCHR: smode[0] = 'c'; break;
6808 case S_IFDIR: smode[0] = 'd'; break;
6809 case S_IFBLK: smode[0] = 'b'; break;
6810 case S_IFREG: smode[0] = '-'; break;
6811 default: smode[0] = '?'; break;
6814 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6815 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6816 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6818 for (i = 0; i < 3; i++)
6820 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6825 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6826 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6827 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6828 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6829 (long)st.st_gid, st.st_size, (long)st.st_atime,
6830 (long)st.st_mtime, (long)st.st_ctime);
6831 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6835 /* vaguely random number less than N */
6839 int_eximarith_t max;
6842 max = expanded_string_integer(sub, TRUE);
6843 if (expand_string_message != NULL)
6845 s = string_sprintf("%d", vaguely_random_number((int)max));
6846 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6850 /* Reverse IP, including IPv6 to dotted-nibble */
6852 case EOP_REVERSE_IP:
6854 int family, maskptr;
6855 uschar reversed[128];
6857 family = string_is_ip_address(sub, &maskptr);
6860 expand_string_message = string_sprintf(
6861 "reverse_ip() not given an IP address [%s]", sub);
6864 invert_address(reversed, sub);
6865 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6869 /* Unknown operator */
6872 expand_string_message =
6873 string_sprintf("unknown expansion operator \"%s\"", name);
6878 /* Handle a plain name. If this is the first thing in the expansion, release
6879 the pre-allocated buffer. If the result data is known to be in a new buffer,
6880 newsize will be set to the size of that buffer, and we can just point at that
6881 store instead of copying. Many expansion strings contain just one reference,
6882 so this is a useful optimization, especially for humungous headers
6883 ($message_headers). */
6891 if (resetok) store_reset(yield);
6895 value = find_variable(name, FALSE, skipping, &newsize);
6898 expand_string_message =
6899 string_sprintf("unknown variable in \"${%s}\"", name);
6900 check_variable_error_message(name);
6903 len = Ustrlen(value);
6904 if (yield == NULL && newsize != 0)
6910 else yield = string_cat(yield, &size, &ptr, value, len);
6914 /* Else there's something wrong */
6916 expand_string_message =
6917 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6918 "in a variable reference)", name);
6922 /* If we hit the end of the string when ket_ends is set, there is a missing
6923 terminating brace. */
6925 if (ket_ends && *s == 0)
6927 expand_string_message = malformed_header?
6928 US"missing } at end of string - could be header name not terminated by colon"
6930 US"missing } at end of string";
6934 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6935 added to the string. If so, set up an empty string. Add a terminating zero. If
6936 left != NULL, return a pointer to the terminator. */
6938 if (yield == NULL) yield = store_get(1);
6940 if (left != NULL) *left = s;
6942 /* Any stacking store that was used above the final string is no longer needed.
6943 In many cases the final string will be the first one that was got and so there
6944 will be optimal store usage. */
6946 if (resetok) store_reset(yield + ptr + 1);
6947 else if (resetok_p) *resetok_p = FALSE;
6951 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6953 if (skipping) debug_printf("skipping: result is not used\n");
6957 /* This is the failure exit: easiest to program with a goto. We still need
6958 to update the pointer to the terminator, for cases of nested calls with "fail".
6961 EXPAND_FAILED_CURLY:
6962 expand_string_message = malformed_header?
6963 US"missing or misplaced { or } - could be header name not terminated by colon"
6965 US"missing or misplaced { or }";
6967 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6968 that is a bad idea, because expand_string_message is in dynamic store. */
6971 if (left != NULL) *left = s;
6974 debug_printf("failed to expand: %s\n", string);
6975 debug_printf(" error message: %s\n", expand_string_message);
6976 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6978 if (resetok_p) *resetok_p = resetok;
6983 /* This is the external function call. Do a quick check for any expansion
6984 metacharacters, and if there are none, just return the input string.
6986 Argument: the string to be expanded
6987 Returns: the expanded string, or NULL if expansion failed; if failure was
6988 due to a lookup deferring, search_find_defer will be TRUE
6992 expand_string(uschar *string)
6994 search_find_defer = FALSE;
6995 malformed_header = FALSE;
6996 return (Ustrpbrk(string, "$\\") == NULL)? string :
6997 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
7002 /*************************************************
7004 *************************************************/
7006 /* Now and again we want to expand a string and be sure that the result is in a
7007 new bit of store. This function does that.
7009 Argument: the string to be expanded
7010 Returns: the expanded string, always in a new bit of store, or NULL
7014 expand_string_copy(uschar *string)
7016 uschar *yield = expand_string(string);
7017 if (yield == string) yield = string_copy(string);
7023 /*************************************************
7024 * Expand and interpret as an integer *
7025 *************************************************/
7027 /* Expand a string, and convert the result into an integer.
7030 string the string to be expanded
7031 isplus TRUE if a non-negative number is expected
7033 Returns: the integer value, or
7034 -1 for an expansion error ) in both cases, message in
7035 -2 for an integer interpretation error ) expand_string_message
7036 expand_string_message is set NULL for an OK integer
7040 expand_string_integer(uschar *string, BOOL isplus)
7042 return expanded_string_integer(expand_string(string), isplus);
7046 /*************************************************
7047 * Interpret string as an integer *
7048 *************************************************/
7050 /* Convert a string (that has already been expanded) into an integer.
7052 This function is used inside the expansion code.
7055 s the string to be expanded
7056 isplus TRUE if a non-negative number is expected
7058 Returns: the integer value, or
7059 -1 if string is NULL (which implies an expansion error)
7060 -2 for an integer interpretation error
7061 expand_string_message is set NULL for an OK integer
7064 static int_eximarith_t
7065 expanded_string_integer(uschar *s, BOOL isplus)
7067 int_eximarith_t value;
7068 uschar *msg = US"invalid integer \"%s\"";
7071 /* If expansion failed, expand_string_message will be set. */
7073 if (s == NULL) return -1;
7075 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7076 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7077 systems, so we set it zero ourselves. */
7080 expand_string_message = NULL; /* Indicates no error */
7082 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7083 equal to 0. Unfortunately, people actually relied upon that, so preserve
7084 the behaviour explicitly. Stripping leading whitespace is a harmless
7085 noop change since strtol skips it anyway (provided that there is a number
7089 while (isspace(*s)) ++s;
7093 debug_printf("treating blank string as number 0\n");
7098 value = strtoll(CS s, CSS &endptr, 10);
7102 msg = US"integer expected but \"%s\" found";
7104 else if (value < 0 && isplus)
7106 msg = US"non-negative integer expected but \"%s\" found";
7110 switch (tolower(*endptr))
7115 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
7120 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
7121 else value *= 1024*1024;
7125 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
7126 else value *= 1024*1024*1024;
7130 if (errno == ERANGE)
7131 msg = US"absolute value of integer \"%s\" is too large (overflow)";
7134 while (isspace(*endptr)) endptr++;
7135 if (*endptr == 0) return value;
7139 expand_string_message = string_sprintf(CS msg, s);
7144 /* These values are usually fixed boolean values, but they are permitted to be
7148 addr address being routed
7149 mtype the module type
7150 mname the module name
7151 dbg_opt debug selectors
7152 oname the option name
7153 bvalue the router's boolean value
7154 svalue the router's string value
7155 rvalue where to put the returned value
7157 Returns: OK value placed in rvalue
7158 DEFER expansion failed
7162 exp_bool(address_item *addr,
7163 uschar *mtype, uschar *mname, unsigned dbg_opt,
7164 uschar *oname, BOOL bvalue,
7165 uschar *svalue, BOOL *rvalue)
7168 if (svalue == NULL) { *rvalue = bvalue; return OK; }
7170 expanded = expand_string(svalue);
7171 if (expanded == NULL)
7173 if (expand_string_forcedfail)
7175 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
7179 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
7180 oname, mname, mtype, expand_string_message);
7181 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
7185 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
7188 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
7190 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
7194 addr->message = string_sprintf("\"%s\" is not a valid value for the "
7195 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
7205 /*************************************************
7206 **************************************************
7207 * Stand-alone test program *
7208 **************************************************
7209 *************************************************/
7215 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
7217 int ovector[3*(EXPAND_MAXN+1)];
7218 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
7219 ovector, sizeof(ovector)/sizeof(int));
7220 BOOL yield = n >= 0;
7221 if (n == 0) n = EXPAND_MAXN + 1;
7225 expand_nmax = (setup < 0)? 0 : setup + 1;
7226 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
7228 expand_nstring[expand_nmax] = subject + ovector[nn];
7229 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
7237 int main(int argc, uschar **argv)
7240 uschar buffer[1024];
7242 debug_selector = D_v;
7243 debug_file = stderr;
7244 debug_fd = fileno(debug_file);
7245 big_buffer = malloc(big_buffer_size);
7247 for (i = 1; i < argc; i++)
7249 if (argv[i][0] == '+')
7251 debug_trace_memory = 2;
7254 if (isdigit(argv[i][0]))
7255 debug_selector = Ustrtol(argv[i], NULL, 0);
7257 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7261 eldap_default_servers = argv[i];
7264 mysql_servers = argv[i];
7267 pgsql_servers = argv[i];
7269 #ifdef EXPERIMENTAL_REDIS
7270 redis_servers = argv[i];
7274 else opt_perl_startup = argv[i];
7278 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
7280 expand_nstring[1] = US"string 1....";
7281 expand_nlength[1] = 8;
7285 if (opt_perl_startup != NULL)
7288 printf("Starting Perl interpreter\n");
7289 errstr = init_perl(opt_perl_startup);
7292 printf("** error in perl_startup code: %s\n", errstr);
7293 return EXIT_FAILURE;
7296 #endif /* EXIM_PERL */
7298 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
7300 void *reset_point = store_get(0);
7301 uschar *yield = expand_string(buffer);
7304 printf("%s\n", yield);
7305 store_reset(reset_point);
7309 if (search_find_defer) printf("search_find deferred\n");
7310 printf("Failed: %s\n", expand_string_message);
7311 if (expand_string_forcedfail) printf("Forced failure\n");
7325 /* End of expand.c */