1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar
*expand_string_internal(const uschar
*, BOOL
, const uschar
**, BOOL
, BOOL
, BOOL
*);
17 static int_eximarith_t
expanded_string_integer(const uschar
*, BOOL
);
20 # ifndef SUPPORT_CRYPTEQ
21 # define SUPPORT_CRYPTEQ
26 # include "lookups/ldap.h"
29 #ifdef SUPPORT_CRYPTEQ
34 extern char* crypt16(char*, char*);
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. Characters after the first 16 are ignored. It always generates
50 a 16-byte hash, which is expressed together with the salt as a string
51 of 24 base 64 digits. Here are some links to peruse:
53 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
54 http://seclists.org/bugtraq/1999/Mar/0076.html
56 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
57 and OSF/1. This is the same as the standard crypt if given a password
58 of 8 characters or less. If given more, it first does the same as crypt
59 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
60 using as salt the first two base 64 digits from the first hash block.
61 If the password is more than 16 characters then it crypts the 17th to 24th
62 characters using as salt the first two base 64 digits from the second hash
63 block. And so on: I've seen references to it cutting off the password at
64 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
66 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
67 http://seclists.org/bugtraq/1999/Mar/0109.html
68 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
69 TET1_html/sec.c222.html#no_id_208
71 Exim has something it calls "crypt16". It will either use a native
72 crypt16 or its own implementation. A native crypt16 will presumably
73 be the one that I called "crypt16" above. The internal "crypt16"
74 function, however, is a two-block-maximum implementation of what I called
75 "bigcrypt". The documentation matches the internal code.
77 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
78 that crypt16 and bigcrypt were different things.
80 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
81 to whatever it is using under that name. This unfortunately sets a
82 precedent for using "{crypt16}" to identify two incompatible algorithms
83 whose output can't be distinguished. With "{crypt16}" thus rendered
84 ambiguous, I suggest you deprecate it and invent two new identifiers
85 for the two algorithms.
87 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
88 of the password separately means they can be cracked separately, so
89 the double-length hash only doubles the cracking effort instead of
90 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar
*item_table
[] = {
166 /* Tables of operator names, and corresponding switch numbers. The names must be
167 in alphabetical order. There are two tables, because underscore is used in some
168 cases to introduce arguments, whereas for other it is part of the name. This is
169 an historical mis-design. */
171 static uschar
*op_table_underscore
[] = {
174 US
"quote_local_part",
179 ,US
"utf8_domain_from_alabel",
180 US
"utf8_domain_to_alabel",
181 US
"utf8_localpart_from_alabel",
182 US
"utf8_localpart_to_alabel"
189 EOP_QUOTE_LOCAL_PART
,
194 ,EOP_UTF8_DOMAIN_FROM_ALABEL
,
195 EOP_UTF8_DOMAIN_TO_ALABEL
,
196 EOP_UTF8_LOCALPART_FROM_ALABEL
,
197 EOP_UTF8_LOCALPART_TO_ALABEL
201 static uschar
*op_table_main
[] = {
248 EOP_ADDRESS
= nelem(op_table_underscore
),
294 /* Table of condition names, and corresponding switch numbers. The names must
295 be in alphabetical order. */
297 static uschar
*cond_table
[] = {
301 US
"==", /* Backward compatibility */
334 US
"match_local_part",
359 ECOND_FIRST_DELIVERY
,
380 ECOND_MATCH_LOCAL_PART
,
390 /* Types of table entry */
393 vtype_int
, /* value is address of int */
394 vtype_filter_int
, /* ditto, but recognized only when filtering */
395 vtype_ino
, /* value is address of ino_t (not always an int) */
396 vtype_uid
, /* value is address of uid_t (not always an int) */
397 vtype_gid
, /* value is address of gid_t (not always an int) */
398 vtype_bool
, /* value is address of bool */
399 vtype_stringptr
, /* value is address of pointer to string */
400 vtype_msgbody
, /* as stringptr, but read when first required */
401 vtype_msgbody_end
, /* ditto, the end of the message */
402 vtype_msgheaders
, /* the message's headers, processed */
403 vtype_msgheaders_raw
, /* the message's headers, unprocessed */
404 vtype_localpart
, /* extract local part from string */
405 vtype_domain
, /* extract domain from string */
406 vtype_string_func
, /* value is string returned by given function */
407 vtype_todbsdin
, /* value not used; generate BSD inbox tod */
408 vtype_tode
, /* value not used; generate tod in epoch format */
409 vtype_todel
, /* value not used; generate tod in epoch/usec format */
410 vtype_todf
, /* value not used; generate full tod */
411 vtype_todl
, /* value not used; generate log tod */
412 vtype_todlf
, /* value not used; generate log file datestamp tod */
413 vtype_todzone
, /* value not used; generate time zone only */
414 vtype_todzulu
, /* value not used; generate zulu tod */
415 vtype_reply
, /* value not used; get reply from headers */
416 vtype_pid
, /* value not used; result is pid */
417 vtype_host_lookup
, /* value not used; get host name */
418 vtype_load_avg
, /* value not used; result is int from os_getloadavg */
419 vtype_pspace
, /* partition space; value is T/F for spool/log */
420 vtype_pinodes
, /* partition inodes; value is T/F for spool/log */
421 vtype_cert
/* SSL certificate */
423 ,vtype_dkim
/* Lookup of value in DKIM signature */
427 /* Type for main variable table */
435 /* Type for entries pointing to address/length pairs. Not currently
443 static uschar
* fn_recipients(void);
445 /* This table must be kept in alphabetical order. */
447 static var_entry var_table
[] = {
448 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
449 they will be confused with user-creatable ACL variables. */
450 { "acl_arg1", vtype_stringptr
, &acl_arg
[0] },
451 { "acl_arg2", vtype_stringptr
, &acl_arg
[1] },
452 { "acl_arg3", vtype_stringptr
, &acl_arg
[2] },
453 { "acl_arg4", vtype_stringptr
, &acl_arg
[3] },
454 { "acl_arg5", vtype_stringptr
, &acl_arg
[4] },
455 { "acl_arg6", vtype_stringptr
, &acl_arg
[5] },
456 { "acl_arg7", vtype_stringptr
, &acl_arg
[6] },
457 { "acl_arg8", vtype_stringptr
, &acl_arg
[7] },
458 { "acl_arg9", vtype_stringptr
, &acl_arg
[8] },
459 { "acl_narg", vtype_int
, &acl_narg
},
460 { "acl_verify_message", vtype_stringptr
, &acl_verify_message
},
461 { "address_data", vtype_stringptr
, &deliver_address_data
},
462 { "address_file", vtype_stringptr
, &address_file
},
463 { "address_pipe", vtype_stringptr
, &address_pipe
},
464 #ifdef EXPERIMENTAL_ARC
465 { "arc_domains", vtype_string_func
, &fn_arc_domains
},
466 { "arc_oldest_pass", vtype_int
, &arc_oldest_pass
},
467 { "arc_state", vtype_stringptr
, &arc_state
},
468 { "arc_state_reason", vtype_stringptr
, &arc_state_reason
},
470 { "authenticated_fail_id",vtype_stringptr
, &authenticated_fail_id
},
471 { "authenticated_id", vtype_stringptr
, &authenticated_id
},
472 { "authenticated_sender",vtype_stringptr
, &authenticated_sender
},
473 { "authentication_failed",vtype_int
, &authentication_failed
},
474 #ifdef WITH_CONTENT_SCAN
475 { "av_failed", vtype_int
, &av_failed
},
477 #ifdef EXPERIMENTAL_BRIGHTMAIL
478 { "bmi_alt_location", vtype_stringptr
, &bmi_alt_location
},
479 { "bmi_base64_tracker_verdict", vtype_stringptr
, &bmi_base64_tracker_verdict
},
480 { "bmi_base64_verdict", vtype_stringptr
, &bmi_base64_verdict
},
481 { "bmi_deliver", vtype_int
, &bmi_deliver
},
483 { "body_linecount", vtype_int
, &body_linecount
},
484 { "body_zerocount", vtype_int
, &body_zerocount
},
485 { "bounce_recipient", vtype_stringptr
, &bounce_recipient
},
486 { "bounce_return_size_limit", vtype_int
, &bounce_return_size_limit
},
487 { "caller_gid", vtype_gid
, &real_gid
},
488 { "caller_uid", vtype_uid
, &real_uid
},
489 { "callout_address", vtype_stringptr
, &callout_address
},
490 { "compile_date", vtype_stringptr
, &version_date
},
491 { "compile_number", vtype_stringptr
, &version_cnumber
},
492 { "config_dir", vtype_stringptr
, &config_main_directory
},
493 { "config_file", vtype_stringptr
, &config_main_filename
},
494 { "csa_status", vtype_stringptr
, &csa_status
},
495 #ifdef EXPERIMENTAL_DCC
496 { "dcc_header", vtype_stringptr
, &dcc_header
},
497 { "dcc_result", vtype_stringptr
, &dcc_result
},
500 { "dkim_algo", vtype_dkim
, (void *)DKIM_ALGO
},
501 { "dkim_bodylength", vtype_dkim
, (void *)DKIM_BODYLENGTH
},
502 { "dkim_canon_body", vtype_dkim
, (void *)DKIM_CANON_BODY
},
503 { "dkim_canon_headers", vtype_dkim
, (void *)DKIM_CANON_HEADERS
},
504 { "dkim_copiedheaders", vtype_dkim
, (void *)DKIM_COPIEDHEADERS
},
505 { "dkim_created", vtype_dkim
, (void *)DKIM_CREATED
},
506 { "dkim_cur_signer", vtype_stringptr
, &dkim_cur_signer
},
507 { "dkim_domain", vtype_stringptr
, &dkim_signing_domain
},
508 { "dkim_expires", vtype_dkim
, (void *)DKIM_EXPIRES
},
509 { "dkim_headernames", vtype_dkim
, (void *)DKIM_HEADERNAMES
},
510 { "dkim_identity", vtype_dkim
, (void *)DKIM_IDENTITY
},
511 { "dkim_key_granularity",vtype_dkim
, (void *)DKIM_KEY_GRANULARITY
},
512 { "dkim_key_length", vtype_int
, &dkim_key_length
},
513 { "dkim_key_nosubdomains",vtype_dkim
, (void *)DKIM_NOSUBDOMAINS
},
514 { "dkim_key_notes", vtype_dkim
, (void *)DKIM_KEY_NOTES
},
515 { "dkim_key_srvtype", vtype_dkim
, (void *)DKIM_KEY_SRVTYPE
},
516 { "dkim_key_testing", vtype_dkim
, (void *)DKIM_KEY_TESTING
},
517 { "dkim_selector", vtype_stringptr
, &dkim_signing_selector
},
518 { "dkim_signers", vtype_stringptr
, &dkim_signers
},
519 { "dkim_verify_reason", vtype_stringptr
, &dkim_verify_reason
},
520 { "dkim_verify_status", vtype_stringptr
, &dkim_verify_status
},
522 #ifdef EXPERIMENTAL_DMARC
523 { "dmarc_domain_policy", vtype_stringptr
, &dmarc_domain_policy
},
524 { "dmarc_status", vtype_stringptr
, &dmarc_status
},
525 { "dmarc_status_text", vtype_stringptr
, &dmarc_status_text
},
526 { "dmarc_used_domain", vtype_stringptr
, &dmarc_used_domain
},
528 { "dnslist_domain", vtype_stringptr
, &dnslist_domain
},
529 { "dnslist_matched", vtype_stringptr
, &dnslist_matched
},
530 { "dnslist_text", vtype_stringptr
, &dnslist_text
},
531 { "dnslist_value", vtype_stringptr
, &dnslist_value
},
532 { "domain", vtype_stringptr
, &deliver_domain
},
533 { "domain_data", vtype_stringptr
, &deliver_domain_data
},
534 #ifndef DISABLE_EVENT
535 { "event_data", vtype_stringptr
, &event_data
},
537 /*XXX want to use generic vars for as many of these as possible*/
538 { "event_defer_errno", vtype_int
, &event_defer_errno
},
540 { "event_name", vtype_stringptr
, &event_name
},
542 { "exim_gid", vtype_gid
, &exim_gid
},
543 { "exim_path", vtype_stringptr
, &exim_path
},
544 { "exim_uid", vtype_uid
, &exim_uid
},
545 { "exim_version", vtype_stringptr
, &version_string
},
546 { "headers_added", vtype_string_func
, &fn_hdrs_added
},
547 { "home", vtype_stringptr
, &deliver_home
},
548 { "host", vtype_stringptr
, &deliver_host
},
549 { "host_address", vtype_stringptr
, &deliver_host_address
},
550 { "host_data", vtype_stringptr
, &host_data
},
551 { "host_lookup_deferred",vtype_int
, &host_lookup_deferred
},
552 { "host_lookup_failed", vtype_int
, &host_lookup_failed
},
553 { "host_port", vtype_int
, &deliver_host_port
},
554 { "initial_cwd", vtype_stringptr
, &initial_cwd
},
555 { "inode", vtype_ino
, &deliver_inode
},
556 { "interface_address", vtype_stringptr
, &interface_address
},
557 { "interface_port", vtype_int
, &interface_port
},
558 { "item", vtype_stringptr
, &iterate_item
},
560 { "ldap_dn", vtype_stringptr
, &eldap_dn
},
562 { "load_average", vtype_load_avg
, NULL
},
563 { "local_part", vtype_stringptr
, &deliver_localpart
},
564 { "local_part_data", vtype_stringptr
, &deliver_localpart_data
},
565 { "local_part_prefix", vtype_stringptr
, &deliver_localpart_prefix
},
566 { "local_part_suffix", vtype_stringptr
, &deliver_localpart_suffix
},
567 #ifdef HAVE_LOCAL_SCAN
568 { "local_scan_data", vtype_stringptr
, &local_scan_data
},
570 { "local_user_gid", vtype_gid
, &local_user_gid
},
571 { "local_user_uid", vtype_uid
, &local_user_uid
},
572 { "localhost_number", vtype_int
, &host_number
},
573 { "log_inodes", vtype_pinodes
, (void *)FALSE
},
574 { "log_space", vtype_pspace
, (void *)FALSE
},
575 { "lookup_dnssec_authenticated",vtype_stringptr
,&lookup_dnssec_authenticated
},
576 { "mailstore_basename", vtype_stringptr
, &mailstore_basename
},
577 #ifdef WITH_CONTENT_SCAN
578 { "malware_name", vtype_stringptr
, &malware_name
},
580 { "max_received_linelength", vtype_int
, &max_received_linelength
},
581 { "message_age", vtype_int
, &message_age
},
582 { "message_body", vtype_msgbody
, &message_body
},
583 { "message_body_end", vtype_msgbody_end
, &message_body_end
},
584 { "message_body_size", vtype_int
, &message_body_size
},
585 { "message_exim_id", vtype_stringptr
, &message_id
},
586 { "message_headers", vtype_msgheaders
, NULL
},
587 { "message_headers_raw", vtype_msgheaders_raw
, NULL
},
588 { "message_id", vtype_stringptr
, &message_id
},
589 { "message_linecount", vtype_int
, &message_linecount
},
590 { "message_size", vtype_int
, &message_size
},
592 { "message_smtputf8", vtype_bool
, &message_smtputf8
},
594 #ifdef WITH_CONTENT_SCAN
595 { "mime_anomaly_level", vtype_int
, &mime_anomaly_level
},
596 { "mime_anomaly_text", vtype_stringptr
, &mime_anomaly_text
},
597 { "mime_boundary", vtype_stringptr
, &mime_boundary
},
598 { "mime_charset", vtype_stringptr
, &mime_charset
},
599 { "mime_content_description", vtype_stringptr
, &mime_content_description
},
600 { "mime_content_disposition", vtype_stringptr
, &mime_content_disposition
},
601 { "mime_content_id", vtype_stringptr
, &mime_content_id
},
602 { "mime_content_size", vtype_int
, &mime_content_size
},
603 { "mime_content_transfer_encoding",vtype_stringptr
, &mime_content_transfer_encoding
},
604 { "mime_content_type", vtype_stringptr
, &mime_content_type
},
605 { "mime_decoded_filename", vtype_stringptr
, &mime_decoded_filename
},
606 { "mime_filename", vtype_stringptr
, &mime_filename
},
607 { "mime_is_coverletter", vtype_int
, &mime_is_coverletter
},
608 { "mime_is_multipart", vtype_int
, &mime_is_multipart
},
609 { "mime_is_rfc822", vtype_int
, &mime_is_rfc822
},
610 { "mime_part_count", vtype_int
, &mime_part_count
},
612 { "n0", vtype_filter_int
, &filter_n
[0] },
613 { "n1", vtype_filter_int
, &filter_n
[1] },
614 { "n2", vtype_filter_int
, &filter_n
[2] },
615 { "n3", vtype_filter_int
, &filter_n
[3] },
616 { "n4", vtype_filter_int
, &filter_n
[4] },
617 { "n5", vtype_filter_int
, &filter_n
[5] },
618 { "n6", vtype_filter_int
, &filter_n
[6] },
619 { "n7", vtype_filter_int
, &filter_n
[7] },
620 { "n8", vtype_filter_int
, &filter_n
[8] },
621 { "n9", vtype_filter_int
, &filter_n
[9] },
622 { "original_domain", vtype_stringptr
, &deliver_domain_orig
},
623 { "original_local_part", vtype_stringptr
, &deliver_localpart_orig
},
624 { "originator_gid", vtype_gid
, &originator_gid
},
625 { "originator_uid", vtype_uid
, &originator_uid
},
626 { "parent_domain", vtype_stringptr
, &deliver_domain_parent
},
627 { "parent_local_part", vtype_stringptr
, &deliver_localpart_parent
},
628 { "pid", vtype_pid
, NULL
},
630 { "prdr_requested", vtype_bool
, &prdr_requested
},
632 { "primary_hostname", vtype_stringptr
, &primary_hostname
},
633 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
634 { "proxy_external_address",vtype_stringptr
, &proxy_external_address
},
635 { "proxy_external_port", vtype_int
, &proxy_external_port
},
636 { "proxy_local_address", vtype_stringptr
, &proxy_local_address
},
637 { "proxy_local_port", vtype_int
, &proxy_local_port
},
638 { "proxy_session", vtype_bool
, &proxy_session
},
640 { "prvscheck_address", vtype_stringptr
, &prvscheck_address
},
641 { "prvscheck_keynum", vtype_stringptr
, &prvscheck_keynum
},
642 { "prvscheck_result", vtype_stringptr
, &prvscheck_result
},
643 { "qualify_domain", vtype_stringptr
, &qualify_domain_sender
},
644 { "qualify_recipient", vtype_stringptr
, &qualify_domain_recipient
},
645 { "queue_name", vtype_stringptr
, &queue_name
},
646 { "rcpt_count", vtype_int
, &rcpt_count
},
647 { "rcpt_defer_count", vtype_int
, &rcpt_defer_count
},
648 { "rcpt_fail_count", vtype_int
, &rcpt_fail_count
},
649 { "received_count", vtype_int
, &received_count
},
650 { "received_for", vtype_stringptr
, &received_for
},
651 { "received_ip_address", vtype_stringptr
, &interface_address
},
652 { "received_port", vtype_int
, &interface_port
},
653 { "received_protocol", vtype_stringptr
, &received_protocol
},
654 { "received_time", vtype_int
, &received_time
.tv_sec
},
655 { "recipient_data", vtype_stringptr
, &recipient_data
},
656 { "recipient_verify_failure",vtype_stringptr
,&recipient_verify_failure
},
657 { "recipients", vtype_string_func
, &fn_recipients
},
658 { "recipients_count", vtype_int
, &recipients_count
},
659 #ifdef WITH_CONTENT_SCAN
660 { "regex_match_string", vtype_stringptr
, ®ex_match_string
},
662 { "reply_address", vtype_reply
, NULL
},
663 { "return_path", vtype_stringptr
, &return_path
},
664 { "return_size_limit", vtype_int
, &bounce_return_size_limit
},
665 { "router_name", vtype_stringptr
, &router_name
},
666 { "runrc", vtype_int
, &runrc
},
667 { "self_hostname", vtype_stringptr
, &self_hostname
},
668 { "sender_address", vtype_stringptr
, &sender_address
},
669 { "sender_address_data", vtype_stringptr
, &sender_address_data
},
670 { "sender_address_domain", vtype_domain
, &sender_address
},
671 { "sender_address_local_part", vtype_localpart
, &sender_address
},
672 { "sender_data", vtype_stringptr
, &sender_data
},
673 { "sender_fullhost", vtype_stringptr
, &sender_fullhost
},
674 { "sender_helo_dnssec", vtype_bool
, &sender_helo_dnssec
},
675 { "sender_helo_name", vtype_stringptr
, &sender_helo_name
},
676 { "sender_host_address", vtype_stringptr
, &sender_host_address
},
677 { "sender_host_authenticated",vtype_stringptr
, &sender_host_authenticated
},
678 { "sender_host_dnssec", vtype_bool
, &sender_host_dnssec
},
679 { "sender_host_name", vtype_host_lookup
, NULL
},
680 { "sender_host_port", vtype_int
, &sender_host_port
},
681 { "sender_ident", vtype_stringptr
, &sender_ident
},
682 { "sender_rate", vtype_stringptr
, &sender_rate
},
683 { "sender_rate_limit", vtype_stringptr
, &sender_rate_limit
},
684 { "sender_rate_period", vtype_stringptr
, &sender_rate_period
},
685 { "sender_rcvhost", vtype_stringptr
, &sender_rcvhost
},
686 { "sender_verify_failure",vtype_stringptr
, &sender_verify_failure
},
687 { "sending_ip_address", vtype_stringptr
, &sending_ip_address
},
688 { "sending_port", vtype_int
, &sending_port
},
689 { "smtp_active_hostname", vtype_stringptr
, &smtp_active_hostname
},
690 { "smtp_command", vtype_stringptr
, &smtp_cmd_buffer
},
691 { "smtp_command_argument", vtype_stringptr
, &smtp_cmd_argument
},
692 { "smtp_command_history", vtype_string_func
, &smtp_cmd_hist
},
693 { "smtp_count_at_connection_start", vtype_int
, &smtp_accept_count
},
694 { "smtp_notquit_reason", vtype_stringptr
, &smtp_notquit_reason
},
695 { "sn0", vtype_filter_int
, &filter_sn
[0] },
696 { "sn1", vtype_filter_int
, &filter_sn
[1] },
697 { "sn2", vtype_filter_int
, &filter_sn
[2] },
698 { "sn3", vtype_filter_int
, &filter_sn
[3] },
699 { "sn4", vtype_filter_int
, &filter_sn
[4] },
700 { "sn5", vtype_filter_int
, &filter_sn
[5] },
701 { "sn6", vtype_filter_int
, &filter_sn
[6] },
702 { "sn7", vtype_filter_int
, &filter_sn
[7] },
703 { "sn8", vtype_filter_int
, &filter_sn
[8] },
704 { "sn9", vtype_filter_int
, &filter_sn
[9] },
705 #ifdef WITH_CONTENT_SCAN
706 { "spam_action", vtype_stringptr
, &spam_action
},
707 { "spam_bar", vtype_stringptr
, &spam_bar
},
708 { "spam_report", vtype_stringptr
, &spam_report
},
709 { "spam_score", vtype_stringptr
, &spam_score
},
710 { "spam_score_int", vtype_stringptr
, &spam_score_int
},
713 { "spf_guess", vtype_stringptr
, &spf_guess
},
714 { "spf_header_comment", vtype_stringptr
, &spf_header_comment
},
715 { "spf_received", vtype_stringptr
, &spf_received
},
716 { "spf_result", vtype_stringptr
, &spf_result
},
717 { "spf_result_guessed", vtype_bool
, &spf_result_guessed
},
718 { "spf_smtp_comment", vtype_stringptr
, &spf_smtp_comment
},
720 { "spool_directory", vtype_stringptr
, &spool_directory
},
721 { "spool_inodes", vtype_pinodes
, (void *)TRUE
},
722 { "spool_space", vtype_pspace
, (void *)TRUE
},
723 #ifdef EXPERIMENTAL_SRS
724 { "srs_db_address", vtype_stringptr
, &srs_db_address
},
725 { "srs_db_key", vtype_stringptr
, &srs_db_key
},
726 { "srs_orig_recipient", vtype_stringptr
, &srs_orig_recipient
},
727 { "srs_orig_sender", vtype_stringptr
, &srs_orig_sender
},
728 { "srs_recipient", vtype_stringptr
, &srs_recipient
},
729 { "srs_status", vtype_stringptr
, &srs_status
},
731 { "thisaddress", vtype_stringptr
, &filter_thisaddress
},
733 /* The non-(in,out) variables are now deprecated */
734 { "tls_bits", vtype_int
, &tls_in
.bits
},
735 { "tls_certificate_verified", vtype_int
, &tls_in
.certificate_verified
},
736 { "tls_cipher", vtype_stringptr
, &tls_in
.cipher
},
738 { "tls_in_bits", vtype_int
, &tls_in
.bits
},
739 { "tls_in_certificate_verified", vtype_int
, &tls_in
.certificate_verified
},
740 { "tls_in_cipher", vtype_stringptr
, &tls_in
.cipher
},
741 { "tls_in_ocsp", vtype_int
, &tls_in
.ocsp
},
742 { "tls_in_ourcert", vtype_cert
, &tls_in
.ourcert
},
743 { "tls_in_peercert", vtype_cert
, &tls_in
.peercert
},
744 { "tls_in_peerdn", vtype_stringptr
, &tls_in
.peerdn
},
745 #if defined(SUPPORT_TLS)
746 { "tls_in_sni", vtype_stringptr
, &tls_in
.sni
},
748 { "tls_out_bits", vtype_int
, &tls_out
.bits
},
749 { "tls_out_certificate_verified", vtype_int
,&tls_out
.certificate_verified
},
750 { "tls_out_cipher", vtype_stringptr
, &tls_out
.cipher
},
752 { "tls_out_dane", vtype_bool
, &tls_out
.dane_verified
},
754 { "tls_out_ocsp", vtype_int
, &tls_out
.ocsp
},
755 { "tls_out_ourcert", vtype_cert
, &tls_out
.ourcert
},
756 { "tls_out_peercert", vtype_cert
, &tls_out
.peercert
},
757 { "tls_out_peerdn", vtype_stringptr
, &tls_out
.peerdn
},
758 #if defined(SUPPORT_TLS)
759 { "tls_out_sni", vtype_stringptr
, &tls_out
.sni
},
762 { "tls_out_tlsa_usage", vtype_int
, &tls_out
.tlsa_usage
},
765 { "tls_peerdn", vtype_stringptr
, &tls_in
.peerdn
}, /* mind the alphabetical order! */
766 #if defined(SUPPORT_TLS)
767 { "tls_sni", vtype_stringptr
, &tls_in
.sni
}, /* mind the alphabetical order! */
770 { "tod_bsdinbox", vtype_todbsdin
, NULL
},
771 { "tod_epoch", vtype_tode
, NULL
},
772 { "tod_epoch_l", vtype_todel
, NULL
},
773 { "tod_full", vtype_todf
, NULL
},
774 { "tod_log", vtype_todl
, NULL
},
775 { "tod_logfile", vtype_todlf
, NULL
},
776 { "tod_zone", vtype_todzone
, NULL
},
777 { "tod_zulu", vtype_todzulu
, NULL
},
778 { "transport_name", vtype_stringptr
, &transport_name
},
779 { "value", vtype_stringptr
, &lookup_value
},
780 { "verify_mode", vtype_stringptr
, &verify_mode
},
781 { "version_number", vtype_stringptr
, &version_string
},
782 { "warn_message_delay", vtype_stringptr
, &warnmsg_delay
},
783 { "warn_message_recipient",vtype_stringptr
, &warnmsg_recipients
},
784 { "warn_message_recipients",vtype_stringptr
,&warnmsg_recipients
},
785 { "warnmsg_delay", vtype_stringptr
, &warnmsg_delay
},
786 { "warnmsg_recipient", vtype_stringptr
, &warnmsg_recipients
},
787 { "warnmsg_recipients", vtype_stringptr
, &warnmsg_recipients
}
790 static int var_table_size
= nelem(var_table
);
791 static uschar var_buffer
[256];
792 static BOOL malformed_header
;
794 /* For textual hashes */
796 static const char *hashcodes
= "abcdefghijklmnopqrtsuvwxyz"
797 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
800 enum { HMAC_MD5
, HMAC_SHA1
};
802 /* For numeric hashes */
804 static unsigned int prime
[] = {
805 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
806 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
807 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
809 /* For printing modes in symbolic form */
811 static uschar
*mtable_normal
[] =
812 { US
"---", US
"--x", US
"-w-", US
"-wx", US
"r--", US
"r-x", US
"rw-", US
"rwx" };
814 static uschar
*mtable_setid
[] =
815 { US
"--S", US
"--s", US
"-wS", US
"-ws", US
"r-S", US
"r-s", US
"rwS", US
"rws" };
817 static uschar
*mtable_sticky
[] =
818 { US
"--T", US
"--t", US
"-wT", US
"-wt", US
"r-T", US
"r-t", US
"rwT", US
"rwt" };
820 /* flags for find_header() */
821 #define FH_EXISTS_ONLY BIT(0)
822 #define FH_WANT_RAW BIT(1)
823 #define FH_WANT_LIST BIT(2)
826 /*************************************************
827 * Tables for UTF-8 support *
828 *************************************************/
830 /* Table of the number of extra characters, indexed by the first character
831 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
834 static uschar utf8_table1
[] = {
835 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
836 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
837 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
838 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
840 /* These are the masks for the data bits in the first byte of a character,
841 indexed by the number of additional bytes. */
843 static int utf8_table2
[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
845 /* Get the next UTF-8 character, advancing the pointer. */
847 #define GETUTF8INC(c, ptr) \
849 if ((c & 0xc0) == 0xc0) \
851 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
853 c = (c & utf8_table2[a]) << s; \
857 c |= (*ptr++ & 0x3f) << s; \
863 static uschar
* base32_chars
= US
"abcdefghijklmnopqrstuvwxyz234567";
865 /*************************************************
866 * Binary chop search on a table *
867 *************************************************/
869 /* This is used for matching expansion items and operators.
872 name the name that is being sought
873 table the table to search
874 table_size the number of items in the table
876 Returns: the offset in the table, or -1
880 chop_match(uschar
*name
, uschar
**table
, int table_size
)
882 uschar
**bot
= table
;
883 uschar
**top
= table
+ table_size
;
887 uschar
**mid
= bot
+ (top
- bot
)/2;
888 int c
= Ustrcmp(name
, *mid
);
889 if (c
== 0) return mid
- table
;
890 if (c
> 0) bot
= mid
+ 1; else top
= mid
;
898 /*************************************************
899 * Check a condition string *
900 *************************************************/
902 /* This function is called to expand a string, and test the result for a "true"
903 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
904 forced fail or lookup defer.
906 We used to release all store used, but this is not not safe due
907 to ${dlfunc } and ${acl }. In any case expand_string_internal()
908 is reasonably careful to release what it can.
910 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
913 condition the condition string
914 m1 text to be incorporated in panic error
917 Returns: TRUE if condition is met, FALSE if not
921 expand_check_condition(uschar
*condition
, uschar
*m1
, uschar
*m2
)
924 uschar
*ss
= expand_string(condition
);
927 if (!expand_string_forcedfail
&& !search_find_defer
)
928 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand condition \"%s\" "
929 "for %s %s: %s", condition
, m1
, m2
, expand_string_message
);
932 rc
= ss
[0] != 0 && Ustrcmp(ss
, "0") != 0 && strcmpic(ss
, US
"no") != 0 &&
933 strcmpic(ss
, US
"false") != 0;
940 /*************************************************
941 * Pseudo-random number generation *
942 *************************************************/
944 /* Pseudo-random number generation. The result is not "expected" to be
945 cryptographically strong but not so weak that someone will shoot themselves
946 in the foot using it as a nonce in some email header scheme or whatever
947 weirdness they'll twist this into. The result should ideally handle fork().
949 However, if we're stuck unable to provide this, then we'll fall back to
950 appallingly bad randomness.
952 If SUPPORT_TLS is defined then this will not be used except as an emergency
957 Returns a random number in range [0, max-1]
961 # define vaguely_random_number vaguely_random_number_fallback
964 vaguely_random_number(int max
)
967 # undef vaguely_random_number
969 static pid_t pid
= 0;
971 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
981 #ifdef HAVE_ARC4RANDOM
982 /* cryptographically strong randomness, common on *BSD platforms, not
983 so much elsewhere. Alas. */
984 #ifndef NOT_HAVE_ARC4RANDOM_STIR
987 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
988 #ifdef HAVE_SRANDOMDEV
989 /* uses random(4) for seeding */
992 gettimeofday(&tv
, NULL
);
993 srandom(tv
.tv_sec
| tv
.tv_usec
| getpid());
996 /* Poor randomness and no seeding here */
1003 #ifdef HAVE_ARC4RANDOM
1004 return arc4random() % max
;
1005 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1006 return random() % max
;
1008 /* This one returns a 16-bit number, definitely not crypto-strong */
1009 return random_number(max
);
1016 /*************************************************
1017 * Pick out a name from a string *
1018 *************************************************/
1020 /* If the name is too long, it is silently truncated.
1023 name points to a buffer into which to put the name
1024 max is the length of the buffer
1025 s points to the first alphabetic character of the name
1026 extras chars other than alphanumerics to permit
1028 Returns: pointer to the first character after the name
1030 Note: The test for *s != 0 in the while loop is necessary because
1031 Ustrchr() yields non-NULL if the character is zero (which is not something
1034 static const uschar
*
1035 read_name(uschar
*name
, int max
, const uschar
*s
, uschar
*extras
)
1038 while (*s
!= 0 && (isalnum(*s
) || Ustrchr(extras
, *s
) != NULL
))
1040 if (ptr
< max
-1) name
[ptr
++] = *s
;
1049 /*************************************************
1050 * Pick out the rest of a header name *
1051 *************************************************/
1053 /* A variable name starting $header_ (or just $h_ for those who like
1054 abbreviations) might not be the complete header name because headers can
1055 contain any printing characters in their names, except ':'. This function is
1056 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1057 on the end, if the name was terminated by white space.
1060 name points to a buffer in which the name read so far exists
1061 max is the length of the buffer
1062 s points to the first character after the name so far, i.e. the
1063 first non-alphameric character after $header_xxxxx
1065 Returns: a pointer to the first character after the header name
1068 static const uschar
*
1069 read_header_name(uschar
*name
, int max
, const uschar
*s
)
1071 int prelen
= Ustrchr(name
, '_') - name
+ 1;
1072 int ptr
= Ustrlen(name
) - prelen
;
1073 if (ptr
> 0) memmove(name
, name
+prelen
, ptr
);
1074 while (mac_isgraph(*s
) && *s
!= ':')
1076 if (ptr
< max
-1) name
[ptr
++] = *s
;
1087 /*************************************************
1088 * Pick out a number from a string *
1089 *************************************************/
1092 n points to an integer into which to put the number
1093 s points to the first digit of the number
1095 Returns: a pointer to the character after the last digit
1097 /*XXX consider expanding to int_eximarith_t. But the test for
1098 "overbig numbers" in 0002 still needs to overflow it. */
1101 read_number(int *n
, uschar
*s
)
1104 while (isdigit(*s
)) *n
= *n
* 10 + (*s
++ - '0');
1108 static const uschar
*
1109 read_cnumber(int *n
, const uschar
*s
)
1112 while (isdigit(*s
)) *n
= *n
* 10 + (*s
++ - '0');
1118 /*************************************************
1119 * Extract keyed subfield from a string *
1120 *************************************************/
1122 /* The yield is in dynamic store; NULL means that the key was not found.
1125 key points to the name of the key
1126 s points to the string from which to extract the subfield
1128 Returns: NULL if the subfield was not found, or
1129 a pointer to the subfield's data
1133 expand_getkeyed(uschar
*key
, const uschar
*s
)
1135 int length
= Ustrlen(key
);
1136 while (isspace(*s
)) s
++;
1138 /* Loop to search for the key */
1144 const uschar
*dkey
= s
;
1146 while (*s
!= 0 && *s
!= '=' && !isspace(*s
)) s
++;
1147 dkeylength
= s
- dkey
;
1148 while (isspace(*s
)) s
++;
1149 if (*s
== '=') while (isspace((*(++s
))));
1151 data
= string_dequote(&s
);
1152 if (length
== dkeylength
&& strncmpic(key
, dkey
, length
) == 0)
1155 while (isspace(*s
)) s
++;
1164 find_var_ent(uschar
* name
)
1167 int last
= var_table_size
;
1169 while (last
> first
)
1171 int middle
= (first
+ last
)/2;
1172 int c
= Ustrcmp(name
, var_table
[middle
].name
);
1174 if (c
> 0) { first
= middle
+ 1; continue; }
1175 if (c
< 0) { last
= middle
; continue; }
1176 return &var_table
[middle
];
1181 /*************************************************
1182 * Extract numbered subfield from string *
1183 *************************************************/
1185 /* Extracts a numbered field from a string that is divided by tokens - for
1186 example a line from /etc/passwd is divided by colon characters. First field is
1187 numbered one. Negative arguments count from the right. Zero returns the whole
1188 string. Returns NULL if there are insufficient tokens in the string
1191 Modifies final argument - this is a dynamically generated string, so that's OK.
1194 field number of field to be extracted,
1195 first field = 1, whole string = 0, last field = -1
1196 separators characters that are used to break string into tokens
1197 s points to the string from which to extract the subfield
1199 Returns: NULL if the field was not found,
1200 a pointer to the field's data inside s (modified to add 0)
1204 expand_gettokened (int field
, uschar
*separators
, uschar
*s
)
1209 uschar
*fieldtext
= NULL
;
1211 if (field
== 0) return s
;
1213 /* Break the line up into fields in place; for field > 0 we stop when we have
1214 done the number of fields we want. For field < 0 we continue till the end of
1215 the string, counting the number of fields. */
1217 count
= (field
> 0)? field
: INT_MAX
;
1223 /* Previous field was the last one in the string. For a positive field
1224 number, this means there are not enough fields. For a negative field number,
1225 check that there are enough, and scan back to find the one that is wanted. */
1229 if (field
> 0 || (-field
) > (INT_MAX
- count
- 1)) return NULL
;
1230 if ((-field
) == (INT_MAX
- count
- 1)) return s
;
1234 while (ss
[-1] != 0) ss
--;
1240 /* Previous field was not last in the string; save its start and put a
1244 len
= Ustrcspn(ss
, separators
);
1255 expand_getlistele(int field
, const uschar
* list
)
1257 const uschar
* tlist
= list
;
1263 for(field
++; string_nextinlist(&tlist
, &sep
, &dummy
, 1); ) field
++;
1266 if(field
==0) return NULL
;
1267 while(--field
>0 && (string_nextinlist(&list
, &sep
, &dummy
, 1))) ;
1268 return string_nextinlist(&list
, &sep
, NULL
, 0);
1272 /* Certificate fields, by name. Worry about by-OID later */
1273 /* Names are chosen to not have common prefixes */
1280 uschar
* (*getfn
)(void * cert
, uschar
* mod
);
1282 static certfield certfields
[] =
1283 { /* linear search; no special order */
1284 { US
"version", 7, &tls_cert_version
},
1285 { US
"serial_number", 13, &tls_cert_serial_number
},
1286 { US
"subject", 7, &tls_cert_subject
},
1287 { US
"notbefore", 9, &tls_cert_not_before
},
1288 { US
"notafter", 8, &tls_cert_not_after
},
1289 { US
"issuer", 6, &tls_cert_issuer
},
1290 { US
"signature", 9, &tls_cert_signature
},
1291 { US
"sig_algorithm", 13, &tls_cert_signature_algorithm
},
1292 { US
"subj_altname", 12, &tls_cert_subject_altname
},
1293 { US
"ocsp_uri", 8, &tls_cert_ocsp_uri
},
1294 { US
"crl_uri", 7, &tls_cert_crl_uri
},
1298 expand_getcertele(uschar
* field
, uschar
* certvar
)
1303 if (!(vp
= find_var_ent(certvar
)))
1305 expand_string_message
=
1306 string_sprintf("no variable named \"%s\"", certvar
);
1307 return NULL
; /* Unknown variable name */
1309 /* NB this stops us passing certs around in variable. Might
1310 want to do that in future */
1311 if (vp
->type
!= vtype_cert
)
1313 expand_string_message
=
1314 string_sprintf("\"%s\" is not a certificate", certvar
);
1315 return NULL
; /* Unknown variable name */
1317 if (!*(void **)vp
->value
)
1320 if (*field
>= '0' && *field
<= '9')
1321 return tls_cert_ext_by_oid(*(void **)vp
->value
, field
, 0);
1323 for(cp
= certfields
;
1324 cp
< certfields
+ nelem(certfields
);
1326 if (Ustrncmp(cp
->name
, field
, cp
->namelen
) == 0)
1328 uschar
* modifier
= *(field
+= cp
->namelen
) == ','
1330 return (*cp
->getfn
)( *(void **)vp
->value
, modifier
);
1333 expand_string_message
=
1334 string_sprintf("bad field selector \"%s\" for certextract", field
);
1337 #endif /*SUPPORT_TLS*/
1339 /*************************************************
1340 * Extract a substring from a string *
1341 *************************************************/
1343 /* Perform the ${substr or ${length expansion operations.
1346 subject the input string
1347 value1 the offset from the start of the input string to the start of
1348 the output string; if negative, count from the right.
1349 value2 the length of the output string, or negative (-1) for unset
1350 if value1 is positive, unset means "all after"
1351 if value1 is negative, unset means "all before"
1352 len set to the length of the returned string
1354 Returns: pointer to the output string, or NULL if there is an error
1358 extract_substr(uschar
*subject
, int value1
, int value2
, int *len
)
1360 int sublen
= Ustrlen(subject
);
1362 if (value1
< 0) /* count from right */
1366 /* If the position is before the start, skip to the start, and adjust the
1367 length. If the length ends up negative, the substring is null because nothing
1368 can precede. This falls out naturally when the length is unset, meaning "all
1374 if (value2
< 0) value2
= 0;
1378 /* Otherwise an unset length => characters before value1 */
1380 else if (value2
< 0)
1387 /* For a non-negative offset, if the starting position is past the end of the
1388 string, the result will be the null string. Otherwise, an unset length means
1389 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1393 if (value1
> sublen
)
1398 else if (value2
< 0) value2
= sublen
;
1401 /* Cut the length down to the maximum possible for the offset value, and get
1402 the required characters. */
1404 if (value1
+ value2
> sublen
) value2
= sublen
- value1
;
1406 return subject
+ value1
;
1412 /*************************************************
1413 * Old-style hash of a string *
1414 *************************************************/
1416 /* Perform the ${hash expansion operation.
1419 subject the input string (an expanded substring)
1420 value1 the length of the output string; if greater or equal to the
1421 length of the input string, the input string is returned
1422 value2 the number of hash characters to use, or 26 if negative
1423 len set to the length of the returned string
1425 Returns: pointer to the output string, or NULL if there is an error
1429 compute_hash(uschar
*subject
, int value1
, int value2
, int *len
)
1431 int sublen
= Ustrlen(subject
);
1433 if (value2
< 0) value2
= 26;
1434 else if (value2
> Ustrlen(hashcodes
))
1436 expand_string_message
=
1437 string_sprintf("hash count \"%d\" too big", value2
);
1441 /* Calculate the hash text. We know it is shorter than the original string, so
1442 can safely place it in subject[] (we know that subject is always itself an
1443 expanded substring). */
1445 if (value1
< sublen
)
1450 while ((c
= (subject
[j
])) != 0)
1452 int shift
= (c
+ j
++) & 7;
1453 subject
[i
] ^= (c
<< shift
) | (c
>> (8-shift
));
1454 if (++i
>= value1
) i
= 0;
1456 for (i
= 0; i
< value1
; i
++)
1457 subject
[i
] = hashcodes
[(subject
[i
]) % value2
];
1459 else value1
= sublen
;
1468 /*************************************************
1469 * Numeric hash of a string *
1470 *************************************************/
1472 /* Perform the ${nhash expansion operation. The first characters of the
1473 string are treated as most important, and get the highest prime numbers.
1476 subject the input string
1477 value1 the maximum value of the first part of the result
1478 value2 the maximum value of the second part of the result,
1479 or negative to produce only a one-part result
1480 len set to the length of the returned string
1482 Returns: pointer to the output string, or NULL if there is an error.
1486 compute_nhash (uschar
*subject
, int value1
, int value2
, int *len
)
1488 uschar
*s
= subject
;
1490 unsigned long int total
= 0; /* no overflow */
1494 if (i
== 0) i
= nelem(prime
) - 1;
1495 total
+= prime
[i
--] * (unsigned int)(*s
++);
1498 /* If value2 is unset, just compute one number */
1501 s
= string_sprintf("%lu", total
% value1
);
1503 /* Otherwise do a div/mod hash */
1507 total
= total
% (value1
* value2
);
1508 s
= string_sprintf("%lu/%lu", total
/value2
, total
% value2
);
1519 /*************************************************
1520 * Find the value of a header or headers *
1521 *************************************************/
1523 /* Multiple instances of the same header get concatenated, and this function
1524 can also return a concatenation of all the header lines. When concatenating
1525 specific headers that contain lists of addresses, a comma is inserted between
1526 them. Otherwise we use a straight concatenation. Because some messages can have
1527 pathologically large number of lines, there is a limit on the length that is
1531 name the name of the header, without the leading $header_ or $h_,
1532 or NULL if a concatenation of all headers is required
1533 newsize return the size of memory block that was obtained; may be NULL
1534 if exists_only is TRUE
1535 flags FH_EXISTS_ONLY
1536 set if called from a def: test; don't need to build a string;
1537 just return a string that is not "" and not "0" if the header
1540 set if called for $rh_ or $rheader_ items; no processing,
1541 other than concatenating, will be done on the header. Also used
1542 for $message_headers_raw.
1544 Double colon chars in the content, and replace newline with
1545 colon between each element when concatenating; returning a
1546 colon-sep list (elements might contain newlines)
1547 charset name of charset to translate MIME words to; used only if
1548 want_raw is false; if NULL, no translation is done (this is
1549 used for $bh_ and $bheader_)
1551 Returns: NULL if the header does not exist, else a pointer to a new
1556 find_header(uschar
*name
, int *newsize
, unsigned flags
, uschar
*charset
)
1559 int len
= name
? Ustrlen(name
) : 0;
1564 for (h
= header_list
; h
; h
= h
->next
)
1565 if (h
->type
!= htype_old
&& h
->text
) /* NULL => Received: placeholder */
1566 if (!name
|| (len
<= h
->slen
&& strncmpic(name
, h
->text
, len
) == 0))
1571 if (flags
& FH_EXISTS_ONLY
)
1572 return US
"1"; /* don't need actual string */
1575 s
= h
->text
+ len
; /* text to insert */
1576 if (!(flags
& FH_WANT_RAW
)) /* unless wanted raw, */
1577 while (isspace(*s
)) s
++; /* remove leading white space */
1578 t
= h
->text
+ h
->slen
; /* end-point */
1580 /* Unless wanted raw, remove trailing whitespace, including the
1583 if (flags
& FH_WANT_LIST
)
1584 while (t
> s
&& t
[-1] == '\n') t
--;
1585 else if (!(flags
& FH_WANT_RAW
))
1587 while (t
> s
&& isspace(t
[-1])) t
--;
1589 /* Set comma if handling a single header and it's one of those
1590 that contains an address list, except when asked for raw headers. Only
1591 need to do this once. */
1593 if (name
&& !comma
&& Ustrchr("BCFRST", h
->type
)) comma
= TRUE
;
1596 /* Trim the header roughly if we're approaching limits */
1598 if ((g
? g
->ptr
: 0) + inc
> header_insert_maxlen
)
1599 inc
= header_insert_maxlen
- (g
? g
->ptr
: 0);
1601 /* For raw just copy the data; for a list, add the data as a colon-sep
1602 list-element; for comma-list add as an unchecked comma,newline sep
1603 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1604 stripped trailing WS above including the newline). We ignore the potential
1605 expansion due to colon-doubling, just leaving the loop if the limit is met
1608 if (flags
& FH_WANT_LIST
)
1609 g
= string_append_listele_n(g
, ':', s
, (unsigned)inc
);
1610 else if (flags
& FH_WANT_RAW
)
1612 g
= string_catn(g
, s
, (unsigned)inc
);
1613 (void) string_from_gstring(g
);
1617 g
= string_append2_listele_n(g
, US
",\n", s
, (unsigned)inc
);
1619 g
= string_append2_listele_n(g
, US
"\n", s
, (unsigned)inc
);
1621 if (g
&& g
->ptr
>= header_insert_maxlen
) break;
1624 if (!found
) return NULL
; /* No header found */
1625 if (!g
) return US
"";
1627 /* That's all we do for raw header expansion. */
1630 if (flags
& FH_WANT_RAW
)
1633 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1634 The rfc2047_decode2() function can return an error with decoded data if the
1635 charset translation fails. If decoding fails, it returns NULL. */
1639 uschar
*decoded
, *error
;
1641 decoded
= rfc2047_decode2(g
->s
, check_rfc2047_length
, charset
, '?', NULL
,
1645 DEBUG(D_any
) debug_printf("*** error in RFC 2047 decoding: %s\n"
1646 " input was: %s\n", error
, g
->s
);
1648 return decoded
? decoded
: g
->s
;
1655 /* Append a "local" element to an Authentication-Results: header
1656 if this was a non-smtp message.
1660 authres_local(gstring
* g
, const uschar
* sysname
)
1662 if (!authentication_local
)
1664 g
= string_append(g
, 3, US
";\n\tlocal=pass (non-smtp, ", sysname
, US
")");
1665 if (authenticated_id
) g
= string_append(g
, 2, " u=", authenticated_id
);
1670 /* Append an "iprev" element to an Authentication-Results: header
1671 if we have attempted to get the calling host's name.
1675 authres_iprev(gstring
* g
)
1677 if (sender_host_name
)
1678 return string_append(g
, sender_host_address
? 5 : 3,
1679 US
";\n\tiprev=pass (", sender_host_name
, US
")",
1680 US
" smtp.client-ip=", sender_host_address
);
1681 if (host_lookup_deferred
)
1682 return string_catn(g
, US
";\n\tiprev=temperror", 19);
1683 if (host_lookup_failed
)
1684 return string_catn(g
, US
";\n\tiprev=fail", 13);
1690 /*************************************************
1691 * Return list of recipients *
1692 *************************************************/
1693 /* A recipients list is available only during system message filtering,
1694 during ACL processing after DATA, and while expanding pipe commands
1695 generated from a system filter, but not elsewhere. */
1704 if (!enable_dollar_recipients
) return NULL
;
1706 for (i
= 0; i
< recipients_count
; i
++)
1708 s
= recipients_list
[i
].address
;
1709 g
= string_append2_listele_n(g
, US
", ", s
, Ustrlen(s
));
1711 return g
? g
->s
: NULL
;
1715 /*************************************************
1716 * Find value of a variable *
1717 *************************************************/
1719 /* The table of variables is kept in alphabetic order, so we can search it
1720 using a binary chop. The "choplen" variable is nothing to do with the binary
1724 name the name of the variable being sought
1725 exists_only TRUE if this is a def: test; passed on to find_header()
1726 skipping TRUE => skip any processing evaluation; this is not the same as
1727 exists_only because def: may test for values that are first
1729 newsize pointer to an int which is initially zero; if the answer is in
1730 a new memory buffer, *newsize is set to its size
1732 Returns: NULL if the variable does not exist, or
1733 a pointer to the variable's contents, or
1734 something non-NULL if exists_only is TRUE
1738 find_variable(uschar
*name
, BOOL exists_only
, BOOL skipping
, int *newsize
)
1745 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1746 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1747 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1748 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1749 (this gave backwards compatibility at the changeover). There may be built-in
1750 variables whose names start acl_ but they should never start in this way. This
1751 slightly messy specification is a consequence of the history, needless to say.
1753 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1754 set, in which case give an error. */
1756 if ((Ustrncmp(name
, "acl_c", 5) == 0 || Ustrncmp(name
, "acl_m", 5) == 0) &&
1760 tree_search((name
[4] == 'c')? acl_var_c
: acl_var_m
, name
+ 4);
1761 return node
? node
->data
.ptr
: strict_acl_vars
? NULL
: US
"";
1764 /* Handle $auth<n> variables. */
1766 if (Ustrncmp(name
, "auth", 4) == 0)
1769 int n
= Ustrtoul(name
+ 4, &endptr
, 10);
1770 if (*endptr
== 0 && n
!= 0 && n
<= AUTH_VARS
)
1771 return !auth_vars
[n
-1] ? US
"" : auth_vars
[n
-1];
1773 else if (Ustrncmp(name
, "regex", 5) == 0)
1776 int n
= Ustrtoul(name
+ 5, &endptr
, 10);
1777 if (*endptr
== 0 && n
!= 0 && n
<= REGEX_VARS
)
1778 return !regex_vars
[n
-1] ? US
"" : regex_vars
[n
-1];
1781 /* For all other variables, search the table */
1783 if (!(vp
= find_var_ent(name
)))
1784 return NULL
; /* Unknown variable name */
1786 /* Found an existing variable. If in skipping state, the value isn't needed,
1787 and we want to avoid processing (such as looking up the host name). */
1795 case vtype_filter_int
:
1796 if (!filter_running
) return NULL
;
1800 sprintf(CS var_buffer
, "%d", *(int *)(val
)); /* Integer */
1804 sprintf(CS var_buffer
, "%ld", (long int)(*(ino_t
*)(val
))); /* Inode */
1808 sprintf(CS var_buffer
, "%ld", (long int)(*(gid_t
*)(val
))); /* gid */
1812 sprintf(CS var_buffer
, "%ld", (long int)(*(uid_t
*)(val
))); /* uid */
1816 sprintf(CS var_buffer
, "%s", *(BOOL
*)(val
) ? "yes" : "no"); /* bool */
1819 case vtype_stringptr
: /* Pointer to string */
1820 return (s
= *((uschar
**)(val
))) ? s
: US
"";
1823 sprintf(CS var_buffer
, "%d", (int)getpid()); /* pid */
1826 case vtype_load_avg
:
1827 sprintf(CS var_buffer
, "%d", OS_GETLOADAVG()); /* load_average */
1830 case vtype_host_lookup
: /* Lookup if not done so */
1831 if ( !sender_host_name
&& sender_host_address
1832 && !host_lookup_failed
&& host_name_lookup() == OK
)
1833 host_build_sender_fullhost();
1834 return sender_host_name
? sender_host_name
: US
"";
1836 case vtype_localpart
: /* Get local part from address */
1837 s
= *((uschar
**)(val
));
1838 if (s
== NULL
) return US
"";
1839 domain
= Ustrrchr(s
, '@');
1840 if (domain
== NULL
) return s
;
1841 if (domain
- s
> sizeof(var_buffer
) - 1)
1842 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "local part longer than " SIZE_T_FMT
1843 " in string expansion", sizeof(var_buffer
));
1844 Ustrncpy(var_buffer
, s
, domain
- s
);
1845 var_buffer
[domain
- s
] = 0;
1848 case vtype_domain
: /* Get domain from address */
1849 s
= *((uschar
**)(val
));
1850 if (s
== NULL
) return US
"";
1851 domain
= Ustrrchr(s
, '@');
1852 return (domain
== NULL
)? US
"" : domain
+ 1;
1854 case vtype_msgheaders
:
1855 return find_header(NULL
, newsize
, exists_only
? FH_EXISTS_ONLY
: 0, NULL
);
1857 case vtype_msgheaders_raw
:
1858 return find_header(NULL
, newsize
,
1859 exists_only
? FH_EXISTS_ONLY
|FH_WANT_RAW
: FH_WANT_RAW
, NULL
);
1861 case vtype_msgbody
: /* Pointer to msgbody string */
1862 case vtype_msgbody_end
: /* Ditto, the end of the msg */
1863 ss
= (uschar
**)(val
);
1864 if (!*ss
&& deliver_datafile
>= 0) /* Read body when needed */
1867 off_t start_offset
= SPOOL_DATA_START_OFFSET
;
1868 int len
= message_body_visible
;
1869 if (len
> message_size
) len
= message_size
;
1870 *ss
= body
= store_malloc(len
+1);
1872 if (vp
->type
== vtype_msgbody_end
)
1874 struct stat statbuf
;
1875 if (fstat(deliver_datafile
, &statbuf
) == 0)
1877 start_offset
= statbuf
.st_size
- len
;
1878 if (start_offset
< SPOOL_DATA_START_OFFSET
)
1879 start_offset
= SPOOL_DATA_START_OFFSET
;
1882 if (lseek(deliver_datafile
, start_offset
, SEEK_SET
) < 0)
1883 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "deliver_datafile lseek: %s",
1885 len
= read(deliver_datafile
, body
, len
);
1889 if (message_body_newlines
) /* Separate loops for efficiency */
1891 { if (body
[--len
] == 0) body
[len
] = ' '; }
1894 { if (body
[--len
] == '\n' || body
[len
] == 0) body
[len
] = ' '; }
1897 return *ss
? *ss
: US
"";
1899 case vtype_todbsdin
: /* BSD inbox time of day */
1900 return tod_stamp(tod_bsdin
);
1902 case vtype_tode
: /* Unix epoch time of day */
1903 return tod_stamp(tod_epoch
);
1905 case vtype_todel
: /* Unix epoch/usec time of day */
1906 return tod_stamp(tod_epoch_l
);
1908 case vtype_todf
: /* Full time of day */
1909 return tod_stamp(tod_full
);
1911 case vtype_todl
: /* Log format time of day */
1912 return tod_stamp(tod_log_bare
); /* (without timezone) */
1914 case vtype_todzone
: /* Time zone offset only */
1915 return tod_stamp(tod_zone
);
1917 case vtype_todzulu
: /* Zulu time */
1918 return tod_stamp(tod_zulu
);
1920 case vtype_todlf
: /* Log file datestamp tod */
1921 return tod_stamp(tod_log_datestamp_daily
);
1923 case vtype_reply
: /* Get reply address */
1924 s
= find_header(US
"reply-to:", newsize
,
1925 exists_only
? FH_EXISTS_ONLY
|FH_WANT_RAW
: FH_WANT_RAW
,
1927 if (s
) while (isspace(*s
)) s
++;
1930 *newsize
= 0; /* For the *s==0 case */
1931 s
= find_header(US
"from:", newsize
,
1932 exists_only
? FH_EXISTS_ONLY
|FH_WANT_RAW
: FH_WANT_RAW
,
1938 while (isspace(*s
)) s
++;
1939 for (t
= s
; *t
!= 0; t
++) if (*t
== '\n') *t
= ' ';
1940 while (t
> s
&& isspace(t
[-1])) t
--;
1943 return s
? s
: US
"";
1945 case vtype_string_func
:
1947 uschar
* (*fn
)() = val
;
1954 sprintf(CS var_buffer
, "%d",
1955 receive_statvfs(val
== (void *)TRUE
, &inodes
));
1962 (void) receive_statvfs(val
== (void *)TRUE
, &inodes
);
1963 sprintf(CS var_buffer
, "%d", inodes
);
1968 return *(void **)val
? US
"<cert>" : US
"";
1970 #ifndef DISABLE_DKIM
1972 return dkim_exim_expand_query((int)(long)val
);
1977 return NULL
; /* Unknown variable. Silences static checkers. */
1984 modify_variable(uschar
*name
, void * value
)
1987 if ((vp
= find_var_ent(name
))) vp
->value
= value
;
1988 return; /* Unknown variable name, fail silently */
1996 /*************************************************
1997 * Read and expand substrings *
1998 *************************************************/
2000 /* This function is called to read and expand argument substrings for various
2001 expansion items. Some have a minimum requirement that is less than the maximum;
2002 in these cases, the first non-present one is set to NULL.
2005 sub points to vector of pointers to set
2006 n maximum number of substrings
2008 sptr points to current string pointer
2009 skipping the skipping flag
2010 check_end if TRUE, check for final '}'
2011 name name of item, for error message
2012 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2015 Returns: 0 OK; string pointer updated
2016 1 curly bracketing error (too few arguments)
2017 2 too many arguments (only if check_end is set); message set
2018 3 other error (expansion failure)
2022 read_subs(uschar
**sub
, int n
, int m
, const uschar
**sptr
, BOOL skipping
,
2023 BOOL check_end
, uschar
*name
, BOOL
*resetok
)
2026 const uschar
*s
= *sptr
;
2028 while (isspace(*s
)) s
++;
2029 for (i
= 0; i
< n
; i
++)
2035 expand_string_message
= string_sprintf("Not enough arguments for '%s' "
2036 "(min is %d)", name
, m
);
2042 if (!(sub
[i
] = expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, resetok
)))
2044 if (*s
++ != '}') return 1;
2045 while (isspace(*s
)) s
++;
2047 if (check_end
&& *s
++ != '}')
2051 expand_string_message
= string_sprintf("Too many arguments for '%s' "
2052 "(max is %d)", name
, n
);
2055 expand_string_message
= string_sprintf("missing '}' after '%s'", name
);
2066 /*************************************************
2067 * Elaborate message for bad variable *
2068 *************************************************/
2070 /* For the "unknown variable" message, take a look at the variable's name, and
2071 give additional information about possible ACL variables. The extra information
2072 is added on to expand_string_message.
2074 Argument: the name of the variable
2079 check_variable_error_message(uschar
*name
)
2081 if (Ustrncmp(name
, "acl_", 4) == 0)
2082 expand_string_message
= string_sprintf("%s (%s)", expand_string_message
,
2083 (name
[4] == 'c' || name
[4] == 'm')?
2085 US
"6th character of a user-defined ACL variable must be a digit or underscore" :
2086 US
"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2088 US
"user-defined ACL variables must start acl_c or acl_m");
2094 Load args from sub array to globals, and call acl_check().
2095 Sub array will be corrupted on return.
2097 Returns: OK access is granted by an ACCEPT verb
2098 DISCARD access is (apparently) granted by a DISCARD verb
2099 FAIL access is denied
2100 FAIL_DROP access is denied; drop the connection
2101 DEFER can't tell at the moment
2105 eval_acl(uschar
** sub
, int nsub
, uschar
** user_msgp
)
2108 int sav_narg
= acl_narg
;
2110 uschar
* dummy_logmsg
;
2111 extern int acl_where
;
2113 if(--nsub
> nelem(acl_arg
)) nsub
= nelem(acl_arg
);
2114 for (i
= 0; i
< nsub
&& sub
[i
+1]; i
++)
2116 uschar
* tmp
= acl_arg
[i
];
2117 acl_arg
[i
] = sub
[i
+1]; /* place callers args in the globals */
2118 sub
[i
+1] = tmp
; /* stash the old args using our caller's storage */
2123 sub
[i
+1] = acl_arg
[i
];
2124 acl_arg
[i
++] = NULL
;
2128 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2130 acl_narg
>0 ? acl_arg
[0] : US
"<none>",
2131 acl_narg
>1 ? " +more" : "");
2133 ret
= acl_eval(acl_where
, sub
[0], user_msgp
, &dummy_logmsg
);
2135 for (i
= 0; i
< nsub
; i
++)
2136 acl_arg
[i
] = sub
[i
+1]; /* restore old args */
2137 acl_narg
= sav_narg
;
2145 /*************************************************
2146 * Read and evaluate a condition *
2147 *************************************************/
2151 s points to the start of the condition text
2152 resetok points to a BOOL which is written false if it is unsafe to
2153 free memory. Certain condition types (acl) may have side-effect
2154 allocation which must be preserved.
2155 yield points to a BOOL to hold the result of the condition test;
2156 if NULL, we are just reading through a condition that is
2157 part of an "or" combination to check syntax, or in a state
2158 where the answer isn't required
2160 Returns: a pointer to the first character after the condition, or
2164 static const uschar
*
2165 eval_condition(const uschar
*s
, BOOL
*resetok
, BOOL
*yield
)
2167 BOOL testfor
= TRUE
;
2168 BOOL tempcond
, combined_cond
;
2170 BOOL sub2_honour_dollar
= TRUE
;
2171 int i
, rc
, cond_type
, roffset
;
2172 int_eximarith_t num
[2];
2173 struct stat statbuf
;
2175 const uschar
*sub
[10];
2178 const uschar
*rerror
;
2182 while (isspace(*s
)) s
++;
2183 if (*s
== '!') { testfor
= !testfor
; s
++; } else break;
2186 /* Numeric comparisons are symbolic */
2188 if (*s
== '=' || *s
== '>' || *s
== '<')
2200 /* All other conditions are named */
2202 else s
= read_name(name
, 256, s
, US
"_");
2204 /* If we haven't read a name, it means some non-alpha character is first. */
2208 expand_string_message
= string_sprintf("condition name expected, "
2209 "but found \"%.16s\"", s
);
2213 /* Find which condition we are dealing with, and switch on it */
2215 cond_type
= chop_match(name
, cond_table
, nelem(cond_table
));
2218 /* def: tests for a non-empty variable, or for the existence of a header. If
2219 yield == NULL we are in a skipping state, and don't care about the answer. */
2227 expand_string_message
= US
"\":\" expected after \"def\"";
2231 s
= read_name(name
, 256, s
+1, US
"_");
2233 /* Test for a header's existence. If the name contains a closing brace
2234 character, this may be a user error where the terminating colon has been
2235 omitted. Set a flag to adjust a subsequent error message in this case. */
2237 if ( ( *(t
= name
) == 'h'
2238 || (*t
== 'r' || *t
== 'l' || *t
== 'b') && *++t
== 'h'
2240 && (*++t
== '_' || Ustrncmp(t
, "eader_", 6) == 0)
2243 s
= read_header_name(name
, 256, s
);
2244 /* {-for-text-editors */
2245 if (Ustrchr(name
, '}') != NULL
) malformed_header
= TRUE
;
2247 (find_header(name
, NULL
, FH_EXISTS_ONLY
, NULL
) != NULL
) == testfor
;
2250 /* Test for a variable's having a non-empty value. A non-existent variable
2251 causes an expansion failure. */
2255 if (!(t
= find_variable(name
, TRUE
, yield
== NULL
, NULL
)))
2257 expand_string_message
= (name
[0] == 0)?
2258 string_sprintf("variable name omitted after \"def:\"") :
2259 string_sprintf("unknown variable \"%s\" after \"def:\"", name
);
2260 check_variable_error_message(name
);
2263 if (yield
) *yield
= (t
[0] != 0) == testfor
;
2270 /* first_delivery tests for first delivery attempt */
2272 case ECOND_FIRST_DELIVERY
:
2273 if (yield
!= NULL
) *yield
= deliver_firsttime
== testfor
;
2277 /* queue_running tests for any process started by a queue runner */
2279 case ECOND_QUEUE_RUNNING
:
2280 if (yield
!= NULL
) *yield
= (queue_run_pid
!= (pid_t
)0) == testfor
;
2284 /* exists: tests for file existence
2285 isip: tests for any IP address
2286 isip4: tests for an IPv4 address
2287 isip6: tests for an IPv6 address
2288 pam: does PAM authentication
2289 radius: does RADIUS authentication
2290 ldapauth: does LDAP authentication
2291 pwcheck: does Cyrus SASL pwcheck authentication
2300 case ECOND_LDAPAUTH
:
2303 while (isspace(*s
)) s
++;
2304 if (*s
!= '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2306 sub
[0] = expand_string_internal(s
+1, TRUE
, &s
, yield
== NULL
, TRUE
, resetok
);
2307 if (sub
[0] == NULL
) return NULL
;
2308 /* {-for-text-editors */
2309 if (*s
++ != '}') goto COND_FAILED_CURLY_END
;
2311 if (yield
== NULL
) return s
; /* No need to run the test if skipping */
2316 if ((expand_forbid
& RDO_EXISTS
) != 0)
2318 expand_string_message
= US
"File existence tests are not permitted";
2321 *yield
= (Ustat(sub
[0], &statbuf
) == 0) == testfor
;
2327 rc
= string_is_ip_address(sub
[0], NULL
);
2328 *yield
= ((cond_type
== ECOND_ISIP
)? (rc
!= 0) :
2329 (cond_type
== ECOND_ISIP4
)? (rc
== 4) : (rc
== 6)) == testfor
;
2332 /* Various authentication tests - all optionally compiled */
2336 rc
= auth_call_pam(sub
[0], &expand_string_message
);
2339 goto COND_FAILED_NOT_COMPILED
;
2340 #endif /* SUPPORT_PAM */
2343 #ifdef RADIUS_CONFIG_FILE
2344 rc
= auth_call_radius(sub
[0], &expand_string_message
);
2347 goto COND_FAILED_NOT_COMPILED
;
2348 #endif /* RADIUS_CONFIG_FILE */
2350 case ECOND_LDAPAUTH
:
2353 /* Just to keep the interface the same */
2355 int old_pool
= store_pool
;
2356 store_pool
= POOL_SEARCH
;
2357 rc
= eldapauth_find((void *)(-1), NULL
, sub
[0], Ustrlen(sub
[0]), NULL
,
2358 &expand_string_message
, &do_cache
);
2359 store_pool
= old_pool
;
2363 goto COND_FAILED_NOT_COMPILED
;
2364 #endif /* LOOKUP_LDAP */
2367 #ifdef CYRUS_PWCHECK_SOCKET
2368 rc
= auth_call_pwcheck(sub
[0], &expand_string_message
);
2371 goto COND_FAILED_NOT_COMPILED
;
2372 #endif /* CYRUS_PWCHECK_SOCKET */
2374 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2375 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2377 if (rc
== ERROR
|| rc
== DEFER
) return NULL
;
2378 *yield
= (rc
== OK
) == testfor
;
2384 /* call ACL (in a conditional context). Accept true, deny false.
2385 Defer is a forced-fail. Anything set by message= goes to $value.
2386 Up to ten parameters are used; we use the braces round the name+args
2387 like the saslauthd condition does, to permit a variable number of args.
2388 See also the expansion-item version EITEM_ACL and the traditional
2389 acl modifier ACLC_ACL.
2390 Since the ACL may allocate new global variables, tell our caller to not
2395 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2401 while (isspace(*s
)) s
++;
2402 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /*}*/
2404 switch(read_subs(sub
, nelem(sub
), 1,
2405 &s
, yield
== NULL
, TRUE
, US
"acl", resetok
))
2407 case 1: expand_string_message
= US
"too few arguments or bracketing "
2410 case 3: return NULL
;
2415 *resetok
= FALSE
; /* eval_acl() might allocate; do not reclaim */
2416 switch(eval_acl(sub
, nelem(sub
), &user_msg
))
2421 lookup_value
= NULL
;
2423 lookup_value
= string_copy(user_msg
);
2424 *yield
= cond
== testfor
;
2428 expand_string_forcedfail
= TRUE
;
2431 expand_string_message
= string_sprintf("error from acl \"%s\"", sub
[0]);
2439 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2441 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2443 However, the last two are optional. That is why the whole set is enclosed
2444 in their own set of braces. */
2446 case ECOND_SASLAUTHD
:
2447 #ifndef CYRUS_SASLAUTHD_SOCKET
2448 goto COND_FAILED_NOT_COMPILED
;
2452 while (isspace(*s
)) s
++;
2453 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2454 switch(read_subs(sub
, nelem(sub
), 2, &s
, yield
== NULL
, TRUE
, US
"saslauthd",
2457 case 1: expand_string_message
= US
"too few arguments or bracketing "
2458 "error for saslauthd";
2460 case 3: return NULL
;
2462 if (sub
[2] == NULL
) sub
[3] = NULL
; /* realm if no service */
2465 int rc
= auth_call_saslauthd(sub
[0], sub
[1], sub
[2], sub
[3],
2466 &expand_string_message
);
2467 if (rc
== ERROR
|| rc
== DEFER
) return NULL
;
2468 *yield
= (rc
== OK
) == testfor
;
2472 #endif /* CYRUS_SASLAUTHD_SOCKET */
2475 /* symbolic operators for numeric and string comparison, and a number of
2476 other operators, all requiring two arguments.
2478 crypteq: encrypts plaintext and compares against an encrypted text,
2479 using crypt(), crypt16(), MD5 or SHA-1
2480 inlist/inlisti: checks if first argument is in the list of the second
2481 match: does a regular expression match and sets up the numerical
2482 variables if it succeeds
2483 match_address: matches in an address list
2484 match_domain: matches in a domain list
2485 match_ip: matches a host list that is restricted to IP addresses
2486 match_local_part: matches in a local part list
2489 case ECOND_MATCH_ADDRESS
:
2490 case ECOND_MATCH_DOMAIN
:
2491 case ECOND_MATCH_IP
:
2492 case ECOND_MATCH_LOCAL_PART
:
2493 #ifndef EXPAND_LISTMATCH_RHS
2494 sub2_honour_dollar
= FALSE
;
2503 case ECOND_NUM_L
: /* Numerical comparisons */
2510 case ECOND_STR_LT
: /* String comparisons */
2521 for (i
= 0; i
< 2; i
++)
2523 /* Sometimes, we don't expand substrings; too many insecure configurations
2524 created using match_address{}{} and friends, where the second param
2525 includes information from untrustworthy sources. */
2526 BOOL honour_dollar
= TRUE
;
2527 if ((i
> 0) && !sub2_honour_dollar
)
2528 honour_dollar
= FALSE
;
2530 while (isspace(*s
)) s
++;
2533 if (i
== 0) goto COND_FAILED_CURLY_START
;
2534 expand_string_message
= string_sprintf("missing 2nd string in {} "
2535 "after \"%s\"", name
);
2538 if (!(sub
[i
] = expand_string_internal(s
+1, TRUE
, &s
, yield
== NULL
,
2539 honour_dollar
, resetok
)))
2541 DEBUG(D_expand
) if (i
== 1 && !sub2_honour_dollar
&& Ustrchr(sub
[1], '$'))
2542 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2543 " for security reasons\n");
2544 if (*s
++ != '}') goto COND_FAILED_CURLY_END
;
2546 /* Convert to numerical if required; we know that the names of all the
2547 conditions that compare numbers do not start with a letter. This just saves
2548 checking for them individually. */
2550 if (!isalpha(name
[0]) && yield
!= NULL
)
2555 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2559 num
[i
] = expanded_string_integer(sub
[i
], FALSE
);
2560 if (expand_string_message
!= NULL
) return NULL
;
2564 /* Result not required */
2566 if (yield
== NULL
) return s
;
2568 /* Do an appropriate comparison */
2574 tempcond
= (num
[0] == num
[1]);
2578 tempcond
= (num
[0] > num
[1]);
2582 tempcond
= (num
[0] >= num
[1]);
2586 tempcond
= (num
[0] < num
[1]);
2590 tempcond
= (num
[0] <= num
[1]);
2594 tempcond
= (Ustrcmp(sub
[0], sub
[1]) < 0);
2598 tempcond
= (strcmpic(sub
[0], sub
[1]) < 0);
2602 tempcond
= (Ustrcmp(sub
[0], sub
[1]) <= 0);
2606 tempcond
= (strcmpic(sub
[0], sub
[1]) <= 0);
2610 tempcond
= (Ustrcmp(sub
[0], sub
[1]) == 0);
2614 tempcond
= (strcmpic(sub
[0], sub
[1]) == 0);
2618 tempcond
= (Ustrcmp(sub
[0], sub
[1]) > 0);
2622 tempcond
= (strcmpic(sub
[0], sub
[1]) > 0);
2626 tempcond
= (Ustrcmp(sub
[0], sub
[1]) >= 0);
2630 tempcond
= (strcmpic(sub
[0], sub
[1]) >= 0);
2633 case ECOND_MATCH
: /* Regular expression match */
2634 re
= pcre_compile(CS sub
[1], PCRE_COPT
, (const char **)&rerror
, &roffset
,
2638 expand_string_message
= string_sprintf("regular expression error in "
2639 "\"%s\": %s at offset %d", sub
[1], rerror
, roffset
);
2642 tempcond
= regex_match_and_setup(re
, sub
[0], 0, -1);
2645 case ECOND_MATCH_ADDRESS
: /* Match in an address list */
2646 rc
= match_address_list(sub
[0], TRUE
, FALSE
, &(sub
[1]), NULL
, -1, 0, NULL
);
2647 goto MATCHED_SOMETHING
;
2649 case ECOND_MATCH_DOMAIN
: /* Match in a domain list */
2650 rc
= match_isinlist(sub
[0], &(sub
[1]), 0, &domainlist_anchor
, NULL
,
2651 MCL_DOMAIN
+ MCL_NOEXPAND
, TRUE
, NULL
);
2652 goto MATCHED_SOMETHING
;
2654 case ECOND_MATCH_IP
: /* Match IP address in a host list */
2655 if (sub
[0][0] != 0 && string_is_ip_address(sub
[0], NULL
) == 0)
2657 expand_string_message
= string_sprintf("\"%s\" is not an IP address",
2663 unsigned int *nullcache
= NULL
;
2664 check_host_block cb
;
2666 cb
.host_name
= US
"";
2667 cb
.host_address
= sub
[0];
2669 /* If the host address starts off ::ffff: it is an IPv6 address in
2670 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2673 cb
.host_ipv4
= (Ustrncmp(cb
.host_address
, "::ffff:", 7) == 0)?
2674 cb
.host_address
+ 7 : cb
.host_address
;
2676 rc
= match_check_list(
2677 &sub
[1], /* the list */
2678 0, /* separator character */
2679 &hostlist_anchor
, /* anchor pointer */
2680 &nullcache
, /* cache pointer */
2681 check_host
, /* function for testing */
2682 &cb
, /* argument for function */
2683 MCL_HOST
, /* type of check */
2684 sub
[0], /* text for debugging */
2685 NULL
); /* where to pass back data */
2687 goto MATCHED_SOMETHING
;
2689 case ECOND_MATCH_LOCAL_PART
:
2690 rc
= match_isinlist(sub
[0], &(sub
[1]), 0, &localpartlist_anchor
, NULL
,
2691 MCL_LOCALPART
+ MCL_NOEXPAND
, TRUE
, NULL
);
2706 expand_string_message
= string_sprintf("unable to complete match "
2707 "against \"%s\": %s", sub
[1], search_error_message
);
2713 /* Various "encrypted" comparisons. If the second string starts with
2714 "{" then an encryption type is given. Default to crypt() or crypt16()
2715 (build-time choice). */
2716 /* }-for-text-editors */
2719 #ifndef SUPPORT_CRYPTEQ
2720 goto COND_FAILED_NOT_COMPILED
;
2722 if (strncmpic(sub
[1], US
"{md5}", 5) == 0)
2724 int sublen
= Ustrlen(sub
[1]+5);
2729 md5_end(&base
, sub
[0], Ustrlen(sub
[0]), digest
);
2731 /* If the length that we are comparing against is 24, the MD5 digest
2732 is expressed as a base64 string. This is the way LDAP does it. However,
2733 some other software uses a straightforward hex representation. We assume
2734 this if the length is 32. Other lengths fail. */
2738 uschar
*coded
= b64encode(digest
, 16);
2739 DEBUG(D_auth
) debug_printf("crypteq: using MD5+B64 hashing\n"
2740 " subject=%s\n crypted=%s\n", coded
, sub
[1]+5);
2741 tempcond
= (Ustrcmp(coded
, sub
[1]+5) == 0);
2743 else if (sublen
== 32)
2747 for (i
= 0; i
< 16; i
++) sprintf(CS (coded
+2*i
), "%02X", digest
[i
]);
2749 DEBUG(D_auth
) debug_printf("crypteq: using MD5+hex hashing\n"
2750 " subject=%s\n crypted=%s\n", coded
, sub
[1]+5);
2751 tempcond
= (strcmpic(coded
, sub
[1]+5) == 0);
2755 DEBUG(D_auth
) debug_printf("crypteq: length for MD5 not 24 or 32: "
2756 "fail\n crypted=%s\n", sub
[1]+5);
2761 else if (strncmpic(sub
[1], US
"{sha1}", 6) == 0)
2763 int sublen
= Ustrlen(sub
[1]+6);
2768 sha1_end(&h
, sub
[0], Ustrlen(sub
[0]), digest
);
2770 /* If the length that we are comparing against is 28, assume the SHA1
2771 digest is expressed as a base64 string. If the length is 40, assume a
2772 straightforward hex representation. Other lengths fail. */
2776 uschar
*coded
= b64encode(digest
, 20);
2777 DEBUG(D_auth
) debug_printf("crypteq: using SHA1+B64 hashing\n"
2778 " subject=%s\n crypted=%s\n", coded
, sub
[1]+6);
2779 tempcond
= (Ustrcmp(coded
, sub
[1]+6) == 0);
2781 else if (sublen
== 40)
2785 for (i
= 0; i
< 20; i
++) sprintf(CS (coded
+2*i
), "%02X", digest
[i
]);
2787 DEBUG(D_auth
) debug_printf("crypteq: using SHA1+hex hashing\n"
2788 " subject=%s\n crypted=%s\n", coded
, sub
[1]+6);
2789 tempcond
= (strcmpic(coded
, sub
[1]+6) == 0);
2793 DEBUG(D_auth
) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2794 "fail\n crypted=%s\n", sub
[1]+6);
2799 else /* {crypt} or {crypt16} and non-{ at start */
2800 /* }-for-text-editors */
2805 if (strncmpic(sub
[1], US
"{crypt}", 7) == 0)
2810 else if (strncmpic(sub
[1], US
"{crypt16}", 9) == 0)
2815 else if (sub
[1][0] == '{') /* }-for-text-editors */
2817 expand_string_message
= string_sprintf("unknown encryption mechanism "
2818 "in \"%s\"", sub
[1]);
2824 case 0: coded
= US
DEFAULT_CRYPT(CS sub
[0], CS sub
[1]); break;
2825 case 1: coded
= US
crypt(CS sub
[0], CS sub
[1]); break;
2826 default: coded
= US
crypt16(CS sub
[0], CS sub
[1]); break;
2830 #define XSTR(s) STR(s)
2831 DEBUG(D_auth
) debug_printf("crypteq: using %s()\n"
2832 " subject=%s\n crypted=%s\n",
2833 which
== 0 ? XSTR(DEFAULT_CRYPT
) : which
== 1 ? "crypt" : "crypt16",
2838 /* If the encrypted string contains fewer than two characters (for the
2839 salt), force failure. Otherwise we get false positives: with an empty
2840 string the yield of crypt() is an empty string! */
2843 tempcond
= Ustrlen(sub
[1]) < 2 ? FALSE
: Ustrcmp(coded
, sub
[1]) == 0;
2844 else if (errno
== EINVAL
)
2848 expand_string_message
= string_sprintf("crypt error: %s\n",
2849 US
strerror(errno
));
2854 #endif /* SUPPORT_CRYPTEQ */
2859 const uschar
* list
= sub
[1];
2861 uschar
*save_iterate_item
= iterate_item
;
2862 int (*compare
)(const uschar
*, const uschar
*);
2864 DEBUG(D_expand
) debug_printf_indent("condition: %s item: %s\n", name
, sub
[0]);
2867 compare
= cond_type
== ECOND_INLISTI
2868 ? strcmpic
: (int (*)(const uschar
*, const uschar
*)) strcmp
;
2870 while ((iterate_item
= string_nextinlist(&list
, &sep
, NULL
, 0)))
2872 DEBUG(D_expand
) debug_printf_indent(" compare %s\n", iterate_item
);
2873 if (compare(sub
[0], iterate_item
) == 0)
2879 iterate_item
= save_iterate_item
;
2882 } /* Switch for comparison conditions */
2884 *yield
= tempcond
== testfor
;
2885 return s
; /* End of comparison conditions */
2888 /* and/or: computes logical and/or of several conditions */
2892 subcondptr
= (yield
== NULL
)? NULL
: &tempcond
;
2893 combined_cond
= (cond_type
== ECOND_AND
);
2895 while (isspace(*s
)) s
++;
2896 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2900 while (isspace(*s
)) s
++;
2901 /* {-for-text-editors */
2902 if (*s
== '}') break;
2903 if (*s
!= '{') /* }-for-text-editors */
2905 expand_string_message
= string_sprintf("each subcondition "
2906 "inside an \"%s{...}\" condition must be in its own {}", name
);
2910 if (!(s
= eval_condition(s
+1, resetok
, subcondptr
)))
2912 expand_string_message
= string_sprintf("%s inside \"%s{...}\" condition",
2913 expand_string_message
, name
);
2916 while (isspace(*s
)) s
++;
2918 /* {-for-text-editors */
2921 /* {-for-text-editors */
2922 expand_string_message
= string_sprintf("missing } at end of condition "
2923 "inside \"%s\" group", name
);
2929 if (cond_type
== ECOND_AND
)
2931 combined_cond
&= tempcond
;
2932 if (!combined_cond
) subcondptr
= NULL
; /* once false, don't */
2933 } /* evaluate any more */
2936 combined_cond
|= tempcond
;
2937 if (combined_cond
) subcondptr
= NULL
; /* once true, don't */
2938 } /* evaluate any more */
2942 if (yield
!= NULL
) *yield
= (combined_cond
== testfor
);
2946 /* forall/forany: iterates a condition with different values */
2951 const uschar
* list
;
2953 uschar
*save_iterate_item
= iterate_item
;
2955 DEBUG(D_expand
) debug_printf_indent("condition: %s\n", name
);
2957 while (isspace(*s
)) s
++;
2958 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2959 sub
[0] = expand_string_internal(s
, TRUE
, &s
, (yield
== NULL
), TRUE
, resetok
);
2960 if (sub
[0] == NULL
) return NULL
;
2961 /* {-for-text-editors */
2962 if (*s
++ != '}') goto COND_FAILED_CURLY_END
;
2964 while (isspace(*s
)) s
++;
2965 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2969 /* Call eval_condition once, with result discarded (as if scanning a
2970 "false" part). This allows us to find the end of the condition, because if
2971 the list it empty, we won't actually evaluate the condition for real. */
2973 if (!(s
= eval_condition(sub
[1], resetok
, NULL
)))
2975 expand_string_message
= string_sprintf("%s inside \"%s\" condition",
2976 expand_string_message
, name
);
2979 while (isspace(*s
)) s
++;
2981 /* {-for-text-editors */
2984 /* {-for-text-editors */
2985 expand_string_message
= string_sprintf("missing } at end of condition "
2986 "inside \"%s\"", name
);
2990 if (yield
!= NULL
) *yield
= !testfor
;
2992 while ((iterate_item
= string_nextinlist(&list
, &sep
, NULL
, 0)) != NULL
)
2994 DEBUG(D_expand
) debug_printf_indent("%s: $item = \"%s\"\n", name
, iterate_item
);
2995 if (!eval_condition(sub
[1], resetok
, &tempcond
))
2997 expand_string_message
= string_sprintf("%s inside \"%s\" condition",
2998 expand_string_message
, name
);
2999 iterate_item
= save_iterate_item
;
3002 DEBUG(D_expand
) debug_printf_indent("%s: condition evaluated to %s\n", name
,
3003 tempcond
? "true":"false");
3005 if (yield
!= NULL
) *yield
= (tempcond
== testfor
);
3006 if (tempcond
== (cond_type
== ECOND_FORANY
)) break;
3009 iterate_item
= save_iterate_item
;
3014 /* The bool{} expansion condition maps a string to boolean.
3015 The values supported should match those supported by the ACL condition
3016 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3017 of true/false. Note that Router "condition" rules have a different
3018 interpretation, where general data can be used and only a few values
3020 Note that readconf.c boolean matching, for boolean configuration options,
3021 only matches true/yes/false/no.
3022 The bool_lax{} condition matches the Router logic, which is much more
3025 case ECOND_BOOL_LAX
:
3031 BOOL boolvalue
= FALSE
;
3032 while (isspace(*s
)) s
++;
3033 if (*s
!= '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
3034 ourname
= cond_type
== ECOND_BOOL_LAX
? US
"bool_lax" : US
"bool";
3035 switch(read_subs(sub_arg
, 1, 1, &s
, yield
== NULL
, FALSE
, ourname
, resetok
))
3037 case 1: expand_string_message
= string_sprintf(
3038 "too few arguments or bracketing error for %s",
3042 case 3: return NULL
;
3045 while (isspace(*t
)) t
++;
3049 /* trailing whitespace: seems like a good idea to ignore it too */
3051 while (isspace(*t2
)) t2
--;
3052 if (t2
!= (t
+ len
))
3059 debug_printf_indent("considering %s: %s\n", ourname
, len
? t
: US
"<empty>");
3060 /* logic for the lax case from expand_check_condition(), which also does
3061 expands, and the logic is both short and stable enough that there should
3062 be no maintenance burden from replicating it. */
3066 ? Ustrspn(t
+1, "0123456789") == len
-1
3067 : Ustrspn(t
, "0123456789") == len
)
3069 boolvalue
= (Uatoi(t
) == 0) ? FALSE
: TRUE
;
3070 /* expand_check_condition only does a literal string "0" check */
3071 if ((cond_type
== ECOND_BOOL_LAX
) && (len
> 1))
3074 else if (strcmpic(t
, US
"true") == 0 || strcmpic(t
, US
"yes") == 0)
3076 else if (strcmpic(t
, US
"false") == 0 || strcmpic(t
, US
"no") == 0)
3078 else if (cond_type
== ECOND_BOOL_LAX
)
3082 expand_string_message
= string_sprintf("unrecognised boolean "
3086 DEBUG(D_expand
) debug_printf_indent("%s: condition evaluated to %s\n", ourname
,
3087 boolvalue
? "true":"false");
3088 if (yield
!= NULL
) *yield
= (boolvalue
== testfor
);
3092 /* Unknown condition */
3095 expand_string_message
= string_sprintf("unknown condition \"%s\"", name
);
3097 } /* End switch on condition type */
3099 /* Missing braces at start and end of data */
3101 COND_FAILED_CURLY_START
:
3102 expand_string_message
= string_sprintf("missing { after \"%s\"", name
);
3105 COND_FAILED_CURLY_END
:
3106 expand_string_message
= string_sprintf("missing } at end of \"%s\" condition",
3110 /* A condition requires code that is not compiled */
3112 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3113 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3114 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3115 COND_FAILED_NOT_COMPILED
:
3116 expand_string_message
= string_sprintf("support for \"%s\" not compiled",
3125 /*************************************************
3126 * Save numerical variables *
3127 *************************************************/
3129 /* This function is called from items such as "if" that want to preserve and
3130 restore the numbered variables.
3133 save_expand_string points to an array of pointers to set
3134 save_expand_nlength points to an array of ints for the lengths
3136 Returns: the value of expand max to save
3140 save_expand_strings(uschar
**save_expand_nstring
, int *save_expand_nlength
)
3143 for (i
= 0; i
<= expand_nmax
; i
++)
3145 save_expand_nstring
[i
] = expand_nstring
[i
];
3146 save_expand_nlength
[i
] = expand_nlength
[i
];
3153 /*************************************************
3154 * Restore numerical variables *
3155 *************************************************/
3157 /* This function restored saved values of numerical strings.
3160 save_expand_nmax the number of strings to restore
3161 save_expand_string points to an array of pointers
3162 save_expand_nlength points to an array of ints
3168 restore_expand_strings(int save_expand_nmax
, uschar
**save_expand_nstring
,
3169 int *save_expand_nlength
)
3172 expand_nmax
= save_expand_nmax
;
3173 for (i
= 0; i
<= expand_nmax
; i
++)
3175 expand_nstring
[i
] = save_expand_nstring
[i
];
3176 expand_nlength
[i
] = save_expand_nlength
[i
];
3184 /*************************************************
3185 * Handle yes/no substrings *
3186 *************************************************/
3188 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3189 alternative substrings that depend on whether or not the condition was true,
3190 or the lookup or extraction succeeded. The substrings always have to be
3191 expanded, to check their syntax, but "skipping" is set when the result is not
3192 needed - this avoids unnecessary nested lookups.
3195 skipping TRUE if we were skipping when this item was reached
3196 yes TRUE if the first string is to be used, else use the second
3197 save_lookup a value to put back into lookup_value before the 2nd expansion
3198 sptr points to the input string pointer
3199 yieldptr points to the output growable-string pointer
3200 type "lookup", "if", "extract", "run", "env", "listextract" or
3201 "certextract" for error message
3202 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3205 Returns: 0 OK; lookup_value has been reset to save_lookup
3207 2 expansion failed because of bracketing error
3211 process_yesno(BOOL skipping
, BOOL yes
, uschar
*save_lookup
, const uschar
**sptr
,
3212 gstring
** yieldptr
, uschar
*type
, BOOL
*resetok
)
3215 const uschar
*s
= *sptr
; /* Local value */
3216 uschar
*sub1
, *sub2
;
3217 const uschar
* errwhere
;
3219 /* If there are no following strings, we substitute the contents of $value for
3220 lookups and for extractions in the success case. For the ${if item, the string
3221 "true" is substituted. In the fail case, nothing is substituted for all three
3224 while (isspace(*s
)) s
++;
3229 if (yes
&& !skipping
)
3230 *yieldptr
= string_catn(*yieldptr
, US
"true", 4);
3234 if (yes
&& lookup_value
&& !skipping
)
3235 *yieldptr
= string_cat(*yieldptr
, lookup_value
);
3236 lookup_value
= save_lookup
;
3242 /* The first following string must be braced. */
3246 errwhere
= US
"'yes' part did not start with '{'";
3250 /* Expand the first substring. Forced failures are noticed only if we actually
3251 want this string. Set skipping in the call in the fail case (this will always
3252 be the case if we were already skipping). */
3254 sub1
= expand_string_internal(s
, TRUE
, &s
, !yes
, TRUE
, resetok
);
3255 if (sub1
== NULL
&& (yes
|| !expand_string_forcedfail
)) goto FAILED
;
3256 expand_string_forcedfail
= FALSE
;
3259 errwhere
= US
"'yes' part did not end with '}'";
3263 /* If we want the first string, add it to the output */
3266 *yieldptr
= string_cat(*yieldptr
, sub1
);
3268 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3269 $value to what it was at the start of the item, so that it has this value
3270 during the second string expansion. For the call from "if" or "run" to this
3271 function, save_lookup is set to lookup_value, so that this statement does
3274 lookup_value
= save_lookup
;
3276 /* There now follows either another substring, or "fail", or nothing. This
3277 time, forced failures are noticed only if we want the second string. We must
3278 set skipping in the nested call if we don't want this string, or if we were
3279 already skipping. */
3281 while (isspace(*s
)) s
++;
3284 sub2
= expand_string_internal(s
+1, TRUE
, &s
, yes
|| skipping
, TRUE
, resetok
);
3285 if (sub2
== NULL
&& (!yes
|| !expand_string_forcedfail
)) goto FAILED
;
3286 expand_string_forcedfail
= FALSE
;
3289 errwhere
= US
"'no' part did not start with '{'";
3293 /* If we want the second string, add it to the output */
3296 *yieldptr
= string_cat(*yieldptr
, sub2
);
3299 /* If there is no second string, but the word "fail" is present when the use of
3300 the second string is wanted, set a flag indicating it was a forced failure
3301 rather than a syntactic error. Swallow the terminating } in case this is nested
3302 inside another lookup or if or extract. */
3307 /* deconst cast ok here as source is s anyway */
3308 s
= US
read_name(name
, sizeof(name
), s
, US
"_");
3309 if (Ustrcmp(name
, "fail") == 0)
3311 if (!yes
&& !skipping
)
3313 while (isspace(*s
)) s
++;
3316 errwhere
= US
"did not close with '}' after forcedfail";
3319 expand_string_message
=
3320 string_sprintf("\"%s\" failed and \"fail\" requested", type
);
3321 expand_string_forcedfail
= TRUE
;
3327 expand_string_message
=
3328 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type
);
3333 /* All we have to do now is to check on the final closing brace. */
3335 while (isspace(*s
)) s
++;
3338 errwhere
= US
"did not close with '}'";
3344 /* Update the input pointer value before returning */
3349 /* Get here if there is a bracketing failure */
3350 expand_string_message
= string_sprintf(
3351 "curly-bracket problem in conditional yes/no parsing: %s\n"
3352 " remaining string is '%s'", errwhere
, --s
);
3357 /* Get here for other failures */
3365 /*************************************************
3366 * Handle MD5 or SHA-1 computation for HMAC *
3367 *************************************************/
3369 /* These are some wrapping functions that enable the HMAC code to be a bit
3370 cleaner. A good compiler will spot the tail recursion.
3373 type HMAC_MD5 or HMAC_SHA1
3374 remaining are as for the cryptographic hash functions
3380 chash_start(int type
, void *base
)
3382 if (type
== HMAC_MD5
)
3383 md5_start((md5
*)base
);
3385 sha1_start((hctx
*)base
);
3389 chash_mid(int type
, void *base
, uschar
*string
)
3391 if (type
== HMAC_MD5
)
3392 md5_mid((md5
*)base
, string
);
3394 sha1_mid((hctx
*)base
, string
);
3398 chash_end(int type
, void *base
, uschar
*string
, int length
, uschar
*digest
)
3400 if (type
== HMAC_MD5
)
3401 md5_end((md5
*)base
, string
, length
, digest
);
3403 sha1_end((hctx
*)base
, string
, length
, digest
);
3410 /********************************************************
3411 * prvs: Get last three digits of days since Jan 1, 1970 *
3412 ********************************************************/
3414 /* This is needed to implement the "prvs" BATV reverse
3417 Argument: integer "days" offset to add or substract to
3418 or from the current number of days.
3420 Returns: pointer to string containing the last three
3421 digits of the number of days since Jan 1, 1970,
3422 modified by the offset argument, NULL if there
3423 was an error in the conversion.
3428 prvs_daystamp(int day_offset
)
3430 uschar
*days
= store_get(32); /* Need at least 24 for cases */
3431 (void)string_format(days
, 32, TIME_T_FMT
, /* where TIME_T_FMT is %lld */
3432 (time(NULL
) + day_offset
*86400)/86400);
3433 return (Ustrlen(days
) >= 3) ? &days
[Ustrlen(days
)-3] : US
"100";
3438 /********************************************************
3439 * prvs: perform HMAC-SHA1 computation of prvs bits *
3440 ********************************************************/
3442 /* This is needed to implement the "prvs" BATV reverse
3446 address RFC2821 Address to use
3447 key The key to use (must be less than 64 characters
3449 key_num Single-digit key number to use. Defaults to
3452 Returns: pointer to string containing the first three
3453 bytes of the final hash in hex format, NULL if
3454 there was an error in the process.
3458 prvs_hmac_sha1(uschar
*address
, uschar
*key
, uschar
*key_num
, uschar
*daystamp
)
3460 gstring
* hash_source
;
3464 uschar innerhash
[20];
3465 uschar finalhash
[20];
3466 uschar innerkey
[64];
3467 uschar outerkey
[64];
3468 uschar
*finalhash_hex
= store_get(40);
3470 if (key_num
== NULL
)
3473 if (Ustrlen(key
) > 64)
3476 hash_source
= string_catn(NULL
, key_num
, 1);
3477 hash_source
= string_catn(hash_source
, daystamp
, 3);
3478 hash_source
= string_cat(hash_source
, address
);
3479 (void) string_from_gstring(hash_source
);
3482 debug_printf_indent("prvs: hash source is '%s'\n", hash_source
->s
);
3484 memset(innerkey
, 0x36, 64);
3485 memset(outerkey
, 0x5c, 64);
3487 for (i
= 0; i
< Ustrlen(key
); i
++)
3489 innerkey
[i
] ^= key
[i
];
3490 outerkey
[i
] ^= key
[i
];
3493 chash_start(HMAC_SHA1
, &h
);
3494 chash_mid(HMAC_SHA1
, &h
, innerkey
);
3495 chash_end(HMAC_SHA1
, &h
, hash_source
->s
, hash_source
->ptr
, innerhash
);
3497 chash_start(HMAC_SHA1
, &h
);
3498 chash_mid(HMAC_SHA1
, &h
, outerkey
);
3499 chash_end(HMAC_SHA1
, &h
, innerhash
, 20, finalhash
);
3502 for (i
= 0; i
< 3; i
++)
3504 *p
++ = hex_digits
[(finalhash
[i
] & 0xf0) >> 4];
3505 *p
++ = hex_digits
[finalhash
[i
] & 0x0f];
3509 return finalhash_hex
;
3515 /*************************************************
3516 * Join a file onto the output string *
3517 *************************************************/
3519 /* This is used for readfile/readsock and after a run expansion.
3520 It joins the contents of a file onto the output string, globally replacing
3521 newlines with a given string (optionally).
3525 yield pointer to the expandable string struct
3526 eol newline replacement string, or NULL
3528 Returns: new pointer for expandable string, terminated if non-null
3532 cat_file(FILE *f
, gstring
*yield
, uschar
*eol
)
3534 uschar buffer
[1024];
3536 while (Ufgets(buffer
, sizeof(buffer
), f
))
3538 int len
= Ustrlen(buffer
);
3539 if (eol
&& buffer
[len
-1] == '\n') len
--;
3540 yield
= string_catn(yield
, buffer
, len
);
3541 if (eol
&& buffer
[len
])
3542 yield
= string_cat(yield
, eol
);
3545 (void) string_from_gstring(yield
);
3552 /*************************************************
3553 * Evaluate numeric expression *
3554 *************************************************/
3556 /* This is a set of mutually recursive functions that evaluate an arithmetic
3557 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3558 these functions that is called from elsewhere is eval_expr, whose interface is:
3561 sptr pointer to the pointer to the string - gets updated
3562 decimal TRUE if numbers are to be assumed decimal
3563 error pointer to where to put an error message - must be NULL on input
3564 endket TRUE if ')' must terminate - FALSE for external call
3566 Returns: on success: the value of the expression, with *error still NULL
3567 on failure: an undefined value, with *error = a message
3570 static int_eximarith_t
eval_op_or(uschar
**, BOOL
, uschar
**);
3573 static int_eximarith_t
3574 eval_expr(uschar
**sptr
, BOOL decimal
, uschar
**error
, BOOL endket
)
3577 int_eximarith_t x
= eval_op_or(&s
, decimal
, error
);
3583 *error
= US
"expecting closing parenthesis";
3585 while (isspace(*(++s
)));
3587 else if (*s
!= 0) *error
= US
"expecting operator";
3594 static int_eximarith_t
3595 eval_number(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3600 while (isspace(*s
)) s
++;
3605 (void)sscanf(CS s
, (decimal
? SC_EXIM_DEC
"%n" : SC_EXIM_ARITH
"%n"), &n
, &count
);
3607 switch (tolower(*s
))
3610 case 'k': n
*= 1024; s
++; break;
3611 case 'm': n
*= 1024*1024; s
++; break;
3612 case 'g': n
*= 1024*1024*1024; s
++; break;
3614 while (isspace (*s
)) s
++;
3619 n
= eval_expr(&s
, decimal
, error
, 1);
3623 *error
= US
"expecting number or opening parenthesis";
3631 static int_eximarith_t
3632 eval_op_unary(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3636 while (isspace(*s
)) s
++;
3637 if (*s
== '+' || *s
== '-' || *s
== '~')
3640 x
= eval_op_unary(&s
, decimal
, error
);
3641 if (op
== '-') x
= -x
;
3642 else if (op
== '~') x
= ~x
;
3646 x
= eval_number(&s
, decimal
, error
);
3653 static int_eximarith_t
3654 eval_op_mult(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3657 int_eximarith_t x
= eval_op_unary(&s
, decimal
, error
);
3660 while (*s
== '*' || *s
== '/' || *s
== '%')
3663 int_eximarith_t y
= eval_op_unary(&s
, decimal
, error
);
3664 if (*error
!= NULL
) break;
3665 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3666 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3667 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3668 * -N*M is INT_MIN will yield INT_MIN.
3669 * Since we don't support floating point, this is somewhat simpler.
3670 * Ideally, we'd return an error, but since we overflow for all other
3671 * arithmetic, consistency suggests otherwise, but what's the correct value
3672 * to use? There is none.
3673 * The C standard guarantees overflow for unsigned arithmetic but signed
3674 * overflow invokes undefined behaviour; in practice, this is overflow
3675 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3676 * that long/longlong larger than int are available, or we could just work
3677 * with larger types. We should consider whether to guarantee 32bit eval
3678 * and 64-bit working variables, with errors returned. For now ...
3679 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3680 * can just let the other invalid results occur otherwise, as they have
3681 * until now. For this one case, we can coerce.
3683 if (y
== -1 && x
== EXIM_ARITH_MIN
&& op
!= '*')
3686 debug_printf("Integer exception dodging: " PR_EXIM_ARITH
"%c-1 coerced to " PR_EXIM_ARITH
"\n",
3687 EXIM_ARITH_MIN
, op
, EXIM_ARITH_MAX
);
3697 *error
= (op
== '/') ? US
"divide by zero" : US
"modulo by zero";
3713 static int_eximarith_t
3714 eval_op_sum(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3717 int_eximarith_t x
= eval_op_mult(&s
, decimal
, error
);
3720 while (*s
== '+' || *s
== '-')
3723 int_eximarith_t y
= eval_op_mult(&s
, decimal
, error
);
3725 if ( (x
>= EXIM_ARITH_MAX
/2 && x
>= EXIM_ARITH_MAX
/2)
3726 || (x
<= -(EXIM_ARITH_MAX
/2) && y
<= -(EXIM_ARITH_MAX
/2)))
3727 { /* over-conservative check */
3729 ? US
"overflow in sum" : US
"overflow in difference";
3732 if (op
== '+') x
+= y
; else x
-= y
;
3740 static int_eximarith_t
3741 eval_op_shift(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3744 int_eximarith_t x
= eval_op_sum(&s
, decimal
, error
);
3747 while ((*s
== '<' || *s
== '>') && s
[1] == s
[0])
3752 y
= eval_op_sum(&s
, decimal
, error
);
3753 if (*error
!= NULL
) break;
3754 if (op
== '<') x
<<= y
; else x
>>= y
;
3762 static int_eximarith_t
3763 eval_op_and(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3766 int_eximarith_t x
= eval_op_shift(&s
, decimal
, error
);
3773 y
= eval_op_shift(&s
, decimal
, error
);
3774 if (*error
!= NULL
) break;
3783 static int_eximarith_t
3784 eval_op_xor(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3787 int_eximarith_t x
= eval_op_and(&s
, decimal
, error
);
3794 y
= eval_op_and(&s
, decimal
, error
);
3795 if (*error
!= NULL
) break;
3804 static int_eximarith_t
3805 eval_op_or(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3808 int_eximarith_t x
= eval_op_xor(&s
, decimal
, error
);
3815 y
= eval_op_xor(&s
, decimal
, error
);
3816 if (*error
!= NULL
) break;
3826 /*************************************************
3828 *************************************************/
3830 /* Returns either an unchanged string, or the expanded string in stacking pool
3831 store. Interpreted sequences are:
3833 \... normal escaping rules
3834 $name substitutes the variable
3836 ${op:string} operates on the expanded string value
3837 ${item{arg1}{arg2}...} expands the args and then does the business
3838 some literal args are not enclosed in {}
3840 There are now far too many operators and item types to make it worth listing
3841 them here in detail any more.
3843 We use an internal routine recursively to handle embedded substrings. The
3844 external function follows. The yield is NULL if the expansion failed, and there
3845 are two cases: if something collapsed syntactically, or if "fail" was given
3846 as the action on a lookup failure. These can be distinguished by looking at the
3847 variable expand_string_forcedfail, which is TRUE in the latter case.
3849 The skipping flag is set true when expanding a substring that isn't actually
3850 going to be used (after "if" or "lookup") and it prevents lookups from
3851 happening lower down.
3853 Store usage: At start, a store block of the length of the input plus 64
3854 is obtained. This is expanded as necessary by string_cat(), which might have to
3855 get a new block, or might be able to expand the original. At the end of the
3856 function we can release any store above that portion of the yield block that
3857 was actually used. In many cases this will be optimal.
3859 However: if the first item in the expansion is a variable name or header name,
3860 we reset the store before processing it; if the result is in fresh store, we
3861 use that without copying. This is helpful for expanding strings like
3862 $message_headers which can get very long.
3864 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3865 since resetting the store at the end of the expansion will free store that was
3866 allocated by the plugin code as well as the slop after the expanded string. So
3867 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3868 and, given the acl condition, ${if }. This is an unfortunate consequence of
3869 string expansion becoming too powerful.
3872 string the string to be expanded
3873 ket_ends true if expansion is to stop at }
3874 left if not NULL, a pointer to the first character after the
3875 expansion is placed here (typically used with ket_ends)
3876 skipping TRUE for recursive calls when the value isn't actually going
3877 to be used (to allow for optimisation)
3878 honour_dollar TRUE if $ is to be expanded,
3879 FALSE if it's just another character
3880 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3883 Returns: NULL if expansion fails:
3884 expand_string_forcedfail is set TRUE if failure was forced
3885 expand_string_message contains a textual error message
3886 a pointer to the expanded string on success
3890 expand_string_internal(const uschar
*string
, BOOL ket_ends
, const uschar
**left
,
3891 BOOL skipping
, BOOL honour_dollar
, BOOL
*resetok_p
)
3893 gstring
* yield
= string_get(Ustrlen(string
) + 64);
3895 const uschar
*s
= string
;
3896 uschar
*save_expand_nstring
[EXPAND_MAXN
+1];
3897 int save_expand_nlength
[EXPAND_MAXN
+1];
3898 BOOL resetok
= TRUE
;
3902 debug_printf_indent(UTF8_DOWN_RIGHT
"%s: %s\n",
3904 ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
"scanning"
3908 expand_string_forcedfail
= FALSE
;
3909 expand_string_message
= US
"";
3916 /* \ escapes the next character, which must exist, or else
3917 the expansion fails. There's a special escape, \N, which causes
3918 copying of the subject verbatim up to the next \N. Otherwise,
3919 the escapes are the standard set. */
3925 expand_string_message
= US
"\\ at end of string";
3931 const uschar
* t
= s
+ 2;
3932 for (s
= t
; *s
!= 0; s
++) if (*s
== '\\' && s
[1] == 'N') break;
3933 yield
= string_catn(yield
, t
, s
- t
);
3934 if (*s
!= 0) s
+= 2;
3940 ch
[0] = string_interpret_escape(&s
);
3942 yield
= string_catn(yield
, ch
, 1);
3949 /* Anything other than $ is just copied verbatim, unless we are
3950 looking for a terminating } character. */
3953 if (ket_ends
&& *s
== '}') break;
3955 if (*s
!= '$' || !honour_dollar
)
3957 yield
= string_catn(yield
, s
++, 1);
3961 /* No { after the $ - must be a plain name or a number for string
3962 match variable. There has to be a fudge for variables that are the
3963 names of header fields preceded by "$header_" because header field
3964 names can contain any printing characters except space and colon.
3965 For those that don't like typing this much, "$h_" is a synonym for
3966 "$header_". A non-existent header yields a NULL value; nothing is
3969 if (isalpha((*(++s
))))
3976 s
= read_name(name
, sizeof(name
), s
, US
"_");
3978 /* If this is the first thing to be expanded, release the pre-allocated
3982 g
= store_get(sizeof(gstring
));
3983 else if (yield
->ptr
== 0)
3985 if (resetok
) store_reset(yield
);
3987 g
= store_get(sizeof(gstring
)); /* alloc _before_ calling find_variable() */
3992 if ( ( *(t
= name
) == 'h'
3993 || (*t
== 'r' || *t
== 'l' || *t
== 'b') && *++t
== 'h'
3995 && (*++t
== '_' || Ustrncmp(t
, "eader_", 6) == 0)
3998 unsigned flags
= *name
== 'r' ? FH_WANT_RAW
3999 : *name
== 'l' ? FH_WANT_RAW
|FH_WANT_LIST
4001 uschar
* charset
= *name
== 'b' ? NULL
: headers_charset
;
4003 s
= read_header_name(name
, sizeof(name
), s
);
4004 value
= find_header(name
, &newsize
, flags
, charset
);
4006 /* If we didn't find the header, and the header contains a closing brace
4007 character, this may be a user error where the terminating colon
4008 has been omitted. Set a flag to adjust the error message in this case.
4009 But there is no error here - nothing gets inserted. */
4013 if (Ustrchr(name
, '}') != NULL
) malformed_header
= TRUE
;
4020 else if (!(value
= find_variable(name
, FALSE
, skipping
, &newsize
)))
4022 expand_string_message
=
4023 string_sprintf("unknown variable name \"%s\"", name
);
4024 check_variable_error_message(name
);
4028 /* If the data is known to be in a new buffer, newsize will be set to the
4029 size of that buffer. If this is the first thing in an expansion string,
4030 yield will be NULL; just point it at the new store instead of copying. Many
4031 expansion strings contain just one reference, so this is a useful
4032 optimization, especially for humungous headers. We need to use a gstring
4033 structure that is not allocated after that new-buffer, else a later store
4034 reset in the middle of the buffer will make it inaccessible. */
4036 len
= Ustrlen(value
);
4037 if (!yield
&& newsize
!= 0)
4040 yield
->size
= newsize
;
4045 yield
= string_catn(yield
, value
, len
);
4053 s
= read_cnumber(&n
, s
);
4054 if (n
>= 0 && n
<= expand_nmax
)
4055 yield
= string_catn(yield
, expand_nstring
[n
], expand_nlength
[n
]);
4059 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
4061 if (*s
!= '{') /*}*/
4063 expand_string_message
= US
"$ not followed by letter, digit, or {"; /*}*/
4067 /* After { there can be various things, but they all start with
4068 an initial word, except for a number for a string match variable. */
4070 if (isdigit((*(++s
))))
4073 s
= read_cnumber(&n
, s
); /*{*/
4076 expand_string_message
= US
"} expected after number";
4079 if (n
>= 0 && n
<= expand_nmax
)
4080 yield
= string_catn(yield
, expand_nstring
[n
], expand_nlength
[n
]);
4086 expand_string_message
= US
"letter or digit expected after ${"; /*}*/
4090 /* Allow "-" in names to cater for substrings with negative
4091 arguments. Since we are checking for known names after { this is
4094 s
= read_name(name
, sizeof(name
), s
, US
"_-");
4095 item_type
= chop_match(name
, item_table
, nelem(item_table
));
4099 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4100 If the ACL returns accept or reject we return content set by "message ="
4101 There is currently no limit on recursion; this would have us call
4102 acl_check_internal() directly and get a current level from somewhere.
4103 See also the acl expansion condition ECOND_ACL and the traditional
4104 acl modifier ACLC_ACL.
4105 Assume that the function has side-effects on the store that must be preserved.
4109 /* ${acl {name} {arg1}{arg2}...} */
4111 uschar
*sub
[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4114 switch(read_subs(sub
, nelem(sub
), 1, &s
, skipping
, TRUE
, US
"acl",
4117 case 1: goto EXPAND_FAILED_CURLY
;
4119 case 3: goto EXPAND_FAILED
;
4121 if (skipping
) continue;
4124 switch(eval_acl(sub
, nelem(sub
), &user_msg
))
4129 debug_printf_indent("acl expansion yield: %s\n", user_msg
);
4131 yield
= string_cat(yield
, user_msg
);
4135 expand_string_forcedfail
= TRUE
;
4138 expand_string_message
= string_sprintf("error from acl \"%s\"", sub
[0]);
4143 case EITEM_AUTHRESULTS
:
4144 /* ${authresults {mysystemname}} */
4148 switch(read_subs(sub_arg
, nelem(sub_arg
), 1, &s
, skipping
, TRUE
, name
,
4151 case 1: goto EXPAND_FAILED_CURLY
;
4153 case 3: goto EXPAND_FAILED
;
4156 yield
= string_append(yield
, 3,
4157 US
"Authentication-Results: ", sub_arg
[0], US
"; none");
4160 yield
= authres_local(yield
, sub_arg
[0]);
4161 yield
= authres_iprev(yield
);
4162 yield
= authres_smtpauth(yield
);
4164 yield
= authres_spf(yield
);
4166 #ifndef DISABLE_DKIM
4167 yield
= authres_dkim(yield
);
4169 #ifdef EXPERIMENTAL_DMARC
4170 yield
= authres_dmarc(yield
);
4172 #ifdef EXPERIMENTAL_ARC
4173 yield
= authres_arc(yield
);
4178 /* Handle conditionals - preserve the values of the numerical expansion
4179 variables in case they get changed by a regular expression match in the
4180 condition. If not, they retain their external settings. At the end
4181 of this "if" section, they get restored to their previous values. */
4186 const uschar
*next_s
;
4187 int save_expand_nmax
=
4188 save_expand_strings(save_expand_nstring
, save_expand_nlength
);
4190 while (isspace(*s
)) s
++;
4191 next_s
= eval_condition(s
, &resetok
, skipping
? NULL
: &cond
);
4192 if (next_s
== NULL
) goto EXPAND_FAILED
; /* message already set */
4196 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4197 "condition: %.*s\n",
4198 (int)(next_s
- s
), s
);
4199 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
4200 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
4202 cond
? "true" : "false");
4207 /* The handling of "yes" and "no" result strings is now in a separate
4208 function that is also used by ${lookup} and ${extract} and ${run}. */
4210 switch(process_yesno(
4211 skipping
, /* were previously skipping */
4212 cond
, /* success/failure indicator */
4213 lookup_value
, /* value to reset for string2 */
4214 &s
, /* input pointer */
4215 &yield
, /* output pointer */
4216 US
"if", /* condition type */
4219 case 1: goto EXPAND_FAILED
; /* when all is well, the */
4220 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
4223 /* Restore external setting of expansion variables for continuation
4226 restore_expand_strings(save_expand_nmax
, save_expand_nstring
,
4227 save_expand_nlength
);
4232 case EITEM_IMAPFOLDER
:
4233 { /* ${imapfolder {name}{sep]{specials}} */
4237 switch(read_subs(sub_arg
, nelem(sub_arg
), 1, &s
, skipping
, TRUE
, name
,
4240 case 1: goto EXPAND_FAILED_CURLY
;
4242 case 3: goto EXPAND_FAILED
;
4245 if (sub_arg
[1] == NULL
) /* One argument */
4247 sub_arg
[1] = US
"/"; /* default separator */
4250 else if (Ustrlen(sub_arg
[1]) != 1)
4252 expand_string_message
=
4254 "IMAP folder separator must be one character, found \"%s\"",
4261 if (!(encoded
= imap_utf7_encode(sub_arg
[0], headers_charset
,
4262 sub_arg
[1][0], sub_arg
[2], &expand_string_message
)))
4264 yield
= string_cat(yield
, encoded
);
4270 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4271 expanding an internal string that isn't actually going to be used. All we
4272 need to do is check the syntax, so don't do a lookup at all. Preserve the
4273 values of the numerical expansion variables in case they get changed by a
4274 partial lookup. If not, they retain their external settings. At the end
4275 of this "lookup" section, they get restored to their previous values. */
4279 int stype
, partial
, affixlen
, starflags
;
4280 int expand_setup
= 0;
4282 uschar
*key
, *filename
;
4283 const uschar
*affix
;
4284 uschar
*save_lookup_value
= lookup_value
;
4285 int save_expand_nmax
=
4286 save_expand_strings(save_expand_nstring
, save_expand_nlength
);
4288 if ((expand_forbid
& RDO_LOOKUP
) != 0)
4290 expand_string_message
= US
"lookup expansions are not permitted";
4294 /* Get the key we are to look up for single-key+file style lookups.
4295 Otherwise set the key NULL pro-tem. */
4297 while (isspace(*s
)) s
++;
4298 if (*s
== '{') /*}*/
4300 key
= expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
4301 if (!key
) goto EXPAND_FAILED
; /*{{*/
4304 expand_string_message
= US
"missing '}' after lookup key";
4305 goto EXPAND_FAILED_CURLY
;
4307 while (isspace(*s
)) s
++;
4311 /* Find out the type of database */
4315 expand_string_message
= US
"missing lookup type";
4319 /* The type is a string that may contain special characters of various
4320 kinds. Allow everything except space or { to appear; the actual content
4321 is checked by search_findtype_partial. */ /*}*/
4323 while (*s
!= 0 && *s
!= '{' && !isspace(*s
)) /*}*/
4325 if (nameptr
< sizeof(name
) - 1) name
[nameptr
++] = *s
;
4329 while (isspace(*s
)) s
++;
4331 /* Now check for the individual search type and any partial or default
4332 options. Only those types that are actually in the binary are valid. */
4334 stype
= search_findtype_partial(name
, &partial
, &affix
, &affixlen
,
4338 expand_string_message
= search_error_message
;
4342 /* Check that a key was provided for those lookup types that need it,
4343 and was not supplied for those that use the query style. */
4345 if (!mac_islookup(stype
, lookup_querystyle
|lookup_absfilequery
))
4349 expand_string_message
= string_sprintf("missing {key} for single-"
4350 "key \"%s\" lookup", name
);
4358 expand_string_message
= string_sprintf("a single key was given for "
4359 "lookup type \"%s\", which is not a single-key lookup type", name
);
4364 /* Get the next string in brackets and expand it. It is the file name for
4365 single-key+file lookups, and the whole query otherwise. In the case of
4366 queries that also require a file name (e.g. sqlite), the file name comes
4371 expand_string_message
= US
"missing '{' for lookup file-or-query arg";
4372 goto EXPAND_FAILED_CURLY
;
4374 filename
= expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
4375 if (filename
== NULL
) goto EXPAND_FAILED
;
4378 expand_string_message
= US
"missing '}' closing lookup file-or-query arg";
4379 goto EXPAND_FAILED_CURLY
;
4381 while (isspace(*s
)) s
++;
4383 /* If this isn't a single-key+file lookup, re-arrange the variables
4384 to be appropriate for the search_ functions. For query-style lookups,
4385 there is just a "key", and no file name. For the special query-style +
4386 file types, the query (i.e. "key") starts with a file name. */
4390 while (isspace(*filename
)) filename
++;
4393 if (mac_islookup(stype
, lookup_querystyle
))
4397 if (*filename
!= '/')
4399 expand_string_message
= string_sprintf(
4400 "absolute file name expected for \"%s\" lookup", name
);
4403 while (*key
!= 0 && !isspace(*key
)) key
++;
4404 if (*key
!= 0) *key
++ = 0;
4408 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4409 the entry was not found. Note that there is no search_close() function.
4410 Files are left open in case of re-use. At suitable places in higher logic,
4411 search_tidyup() is called to tidy all open files. This can save opening
4412 the same file several times. However, files may also get closed when
4413 others are opened, if too many are open at once. The rule is that a
4414 handle should not be used after a second search_open().
4416 Request that a partial search sets up $1 and maybe $2 by passing
4417 expand_setup containing zero. If its value changes, reset expand_nmax,
4418 since new variables will have been set. Note that at the end of this
4419 "lookup" section, the old numeric variables are restored. */
4422 lookup_value
= NULL
;
4425 void *handle
= search_open(filename
, stype
, 0, NULL
, NULL
);
4428 expand_string_message
= search_error_message
;
4431 lookup_value
= search_find(handle
, filename
, key
, partial
, affix
,
4432 affixlen
, starflags
, &expand_setup
);
4433 if (search_find_defer
)
4435 expand_string_message
=
4436 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4437 string_printing2(key
, FALSE
), search_error_message
);
4440 if (expand_setup
> 0) expand_nmax
= expand_setup
;
4443 /* The handling of "yes" and "no" result strings is now in a separate
4444 function that is also used by ${if} and ${extract}. */
4446 switch(process_yesno(
4447 skipping
, /* were previously skipping */
4448 lookup_value
!= NULL
, /* success/failure indicator */
4449 save_lookup_value
, /* value to reset for string2 */
4450 &s
, /* input pointer */
4451 &yield
, /* output pointer */
4452 US
"lookup", /* condition type */
4455 case 1: goto EXPAND_FAILED
; /* when all is well, the */
4456 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
4459 /* Restore external setting of expansion variables for carrying on
4460 at this level, and continue. */
4462 restore_expand_strings(save_expand_nmax
, save_expand_nstring
,
4463 save_expand_nlength
);
4467 /* If Perl support is configured, handle calling embedded perl subroutines,
4468 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4469 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4470 arguments (defined below). */
4472 #define EXIM_PERL_MAX_ARGS 8
4476 expand_string_message
= US
"\"${perl\" encountered, but this facility " /*}*/
4477 "is not included in this binary";
4480 #else /* EXIM_PERL */
4482 uschar
*sub_arg
[EXIM_PERL_MAX_ARGS
+ 2];
4485 if ((expand_forbid
& RDO_PERL
) != 0)
4487 expand_string_message
= US
"Perl calls are not permitted";
4491 switch(read_subs(sub_arg
, EXIM_PERL_MAX_ARGS
+ 1, 1, &s
, skipping
, TRUE
,
4492 US
"perl", &resetok
))
4494 case 1: goto EXPAND_FAILED_CURLY
;
4496 case 3: goto EXPAND_FAILED
;
4499 /* If skipping, we don't actually do anything */
4501 if (skipping
) continue;
4503 /* Start the interpreter if necessary */
4505 if (!opt_perl_started
)
4508 if (opt_perl_startup
== NULL
)
4510 expand_string_message
= US
"A setting of perl_startup is needed when "
4511 "using the Perl interpreter";
4514 DEBUG(D_any
) debug_printf("Starting Perl interpreter\n");
4515 initerror
= init_perl(opt_perl_startup
);
4516 if (initerror
!= NULL
)
4518 expand_string_message
=
4519 string_sprintf("error in perl_startup code: %s\n", initerror
);
4522 opt_perl_started
= TRUE
;
4525 /* Call the function */
4527 sub_arg
[EXIM_PERL_MAX_ARGS
+ 1] = NULL
;
4528 new_yield
= call_perl_cat(yield
, &expand_string_message
,
4529 sub_arg
[0], sub_arg
+ 1);
4531 /* NULL yield indicates failure; if the message pointer has been set to
4532 NULL, the yield was undef, indicating a forced failure. Otherwise the
4533 message will indicate some kind of Perl error. */
4535 if (new_yield
== NULL
)
4537 if (expand_string_message
== NULL
)
4539 expand_string_message
=
4540 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4541 "failure", sub_arg
[0]);
4542 expand_string_forcedfail
= TRUE
;
4547 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4548 set during a callback from Perl. */
4550 expand_string_forcedfail
= FALSE
;
4554 #endif /* EXIM_PERL */
4556 /* Transform email address to "prvs" scheme to use
4557 as BATV-signed return path */
4564 switch(read_subs(sub_arg
, 3, 2, &s
, skipping
, TRUE
, US
"prvs", &resetok
))
4566 case 1: goto EXPAND_FAILED_CURLY
;
4568 case 3: goto EXPAND_FAILED
;
4571 /* If skipping, we don't actually do anything */
4572 if (skipping
) continue;
4574 /* sub_arg[0] is the address */
4575 if ( !(domain
= Ustrrchr(sub_arg
[0],'@'))
4576 || domain
== sub_arg
[0] || Ustrlen(domain
) == 1)
4578 expand_string_message
= US
"prvs first argument must be a qualified email address";
4582 /* Calculate the hash. The third argument must be a single-digit
4583 key number, or unset. */
4586 && (!isdigit(sub_arg
[2][0]) || sub_arg
[2][1] != 0))
4588 expand_string_message
= US
"prvs third argument must be a single digit";
4592 p
= prvs_hmac_sha1(sub_arg
[0], sub_arg
[1], sub_arg
[2], prvs_daystamp(7));
4595 expand_string_message
= US
"prvs hmac-sha1 conversion failed";
4599 /* Now separate the domain from the local part */
4602 yield
= string_catn(yield
, US
"prvs=", 5);
4603 yield
= string_catn(yield
, sub_arg
[2] ? sub_arg
[2] : US
"0", 1);
4604 yield
= string_catn(yield
, prvs_daystamp(7), 3);
4605 yield
= string_catn(yield
, p
, 6);
4606 yield
= string_catn(yield
, US
"=", 1);
4607 yield
= string_cat (yield
, sub_arg
[0]);
4608 yield
= string_catn(yield
, US
"@", 1);
4609 yield
= string_cat (yield
, domain
);
4614 /* Check a prvs-encoded address for validity */
4616 case EITEM_PRVSCHECK
:
4623 /* TF: Ugliness: We want to expand parameter 1 first, then set
4624 up expansion variables that are used in the expansion of
4625 parameter 2. So we clone the string for the first
4626 expansion, where we only expand parameter 1.
4628 PH: Actually, that isn't necessary. The read_subs() function is
4629 designed to work this way for the ${if and ${lookup expansions. I've
4633 /* Reset expansion variables */
4634 prvscheck_result
= NULL
;
4635 prvscheck_address
= NULL
;
4636 prvscheck_keynum
= NULL
;
4638 switch(read_subs(sub_arg
, 1, 1, &s
, skipping
, FALSE
, US
"prvs", &resetok
))
4640 case 1: goto EXPAND_FAILED_CURLY
;
4642 case 3: goto EXPAND_FAILED
;
4645 re
= regex_must_compile(US
"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4648 if (regex_match_and_setup(re
,sub_arg
[0],0,-1))
4650 uschar
*local_part
= string_copyn(expand_nstring
[4],expand_nlength
[4]);
4651 uschar
*key_num
= string_copyn(expand_nstring
[1],expand_nlength
[1]);
4652 uschar
*daystamp
= string_copyn(expand_nstring
[2],expand_nlength
[2]);
4653 uschar
*hash
= string_copyn(expand_nstring
[3],expand_nlength
[3]);
4654 uschar
*domain
= string_copyn(expand_nstring
[5],expand_nlength
[5]);
4656 DEBUG(D_expand
) debug_printf_indent("prvscheck localpart: %s\n", local_part
);
4657 DEBUG(D_expand
) debug_printf_indent("prvscheck key number: %s\n", key_num
);
4658 DEBUG(D_expand
) debug_printf_indent("prvscheck daystamp: %s\n", daystamp
);
4659 DEBUG(D_expand
) debug_printf_indent("prvscheck hash: %s\n", hash
);
4660 DEBUG(D_expand
) debug_printf_indent("prvscheck domain: %s\n", domain
);
4662 /* Set up expansion variables */
4663 g
= string_cat (NULL
, local_part
);
4664 g
= string_catn(g
, US
"@", 1);
4665 g
= string_cat (g
, domain
);
4666 prvscheck_address
= string_from_gstring(g
);
4667 prvscheck_keynum
= string_copy(key_num
);
4669 /* Now expand the second argument */
4670 switch(read_subs(sub_arg
, 1, 1, &s
, skipping
, FALSE
, US
"prvs", &resetok
))
4672 case 1: goto EXPAND_FAILED_CURLY
;
4674 case 3: goto EXPAND_FAILED
;
4677 /* Now we have the key and can check the address. */
4679 p
= prvs_hmac_sha1(prvscheck_address
, sub_arg
[0], prvscheck_keynum
,
4684 expand_string_message
= US
"hmac-sha1 conversion failed";
4688 DEBUG(D_expand
) debug_printf_indent("prvscheck: received hash is %s\n", hash
);
4689 DEBUG(D_expand
) debug_printf_indent("prvscheck: own hash is %s\n", p
);
4691 if (Ustrcmp(p
,hash
) == 0)
4693 /* Success, valid BATV address. Now check the expiry date. */
4694 uschar
*now
= prvs_daystamp(0);
4695 unsigned int inow
= 0,iexpire
= 1;
4697 (void)sscanf(CS now
,"%u",&inow
);
4698 (void)sscanf(CS daystamp
,"%u",&iexpire
);
4700 /* When "iexpire" is < 7, a "flip" has occured.
4701 Adjust "inow" accordingly. */
4702 if ( (iexpire
< 7) && (inow
>= 993) ) inow
= 0;
4704 if (iexpire
>= inow
)
4706 prvscheck_result
= US
"1";
4707 DEBUG(D_expand
) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
4711 prvscheck_result
= NULL
;
4712 DEBUG(D_expand
) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
4717 prvscheck_result
= NULL
;
4718 DEBUG(D_expand
) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
4721 /* Now expand the final argument. We leave this till now so that
4722 it can include $prvscheck_result. */
4724 switch(read_subs(sub_arg
, 1, 0, &s
, skipping
, TRUE
, US
"prvs", &resetok
))
4726 case 1: goto EXPAND_FAILED_CURLY
;
4728 case 3: goto EXPAND_FAILED
;
4731 yield
= string_cat(yield
,
4732 !sub_arg
[0] || !*sub_arg
[0] ? prvscheck_address
: sub_arg
[0]);
4734 /* Reset the "internal" variables afterwards, because they are in
4735 dynamic store that will be reclaimed if the expansion succeeded. */
4737 prvscheck_address
= NULL
;
4738 prvscheck_keynum
= NULL
;
4741 /* Does not look like a prvs encoded address, return the empty string.
4742 We need to make sure all subs are expanded first, so as to skip over
4745 switch(read_subs(sub_arg
, 2, 1, &s
, skipping
, TRUE
, US
"prvs", &resetok
))
4747 case 1: goto EXPAND_FAILED_CURLY
;
4749 case 3: goto EXPAND_FAILED
;
4755 /* Handle "readfile" to insert an entire file */
4757 case EITEM_READFILE
:
4762 if ((expand_forbid
& RDO_READFILE
) != 0)
4764 expand_string_message
= US
"file insertions are not permitted";
4768 switch(read_subs(sub_arg
, 2, 1, &s
, skipping
, TRUE
, US
"readfile", &resetok
))
4770 case 1: goto EXPAND_FAILED_CURLY
;
4772 case 3: goto EXPAND_FAILED
;
4775 /* If skipping, we don't actually do anything */
4777 if (skipping
) continue;
4779 /* Open the file and read it */
4781 if (!(f
= Ufopen(sub_arg
[0], "rb")))
4783 expand_string_message
= string_open_failed(errno
, "%s", sub_arg
[0]);
4787 yield
= cat_file(f
, yield
, sub_arg
[1]);
4792 /* Handle "readsocket" to insert data from a socket, either
4793 Inet or Unix domain */
4795 case EITEM_READSOCK
:
4799 int save_ptr
= yield
->ptr
;
4803 BOOL do_shutdown
= TRUE
;
4806 if (expand_forbid
& RDO_READSOCK
)
4808 expand_string_message
= US
"socket insertions are not permitted";
4812 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4813 because there may be a string for expansion on failure. */
4815 switch(read_subs(sub_arg
, 4, 2, &s
, skipping
, FALSE
, US
"readsocket", &resetok
))
4817 case 1: goto EXPAND_FAILED_CURLY
;
4818 case 2: /* Won't occur: no end check */
4819 case 3: goto EXPAND_FAILED
;
4822 /* Grab the request string, if any */
4824 reqstr
.data
= sub_arg
[1];
4825 reqstr
.len
= Ustrlen(sub_arg
[1]);
4827 /* Sort out timeout, if given. The second arg is a list with the first element
4828 being a time value. Any more are options of form "name=value". Currently the
4829 only option recognised is "shutdown". */
4833 const uschar
* list
= sub_arg
[2];
4837 item
= string_nextinlist(&list
, &sep
, NULL
, 0);
4838 if ((timeout
= readconf_readtime(item
, 0, FALSE
)) < 0)
4840 expand_string_message
= string_sprintf("bad time value %s", item
);
4844 while ((item
= string_nextinlist(&list
, &sep
, NULL
, 0)))
4845 if (Ustrncmp(item
, US
"shutdown=", 9) == 0)
4846 if (Ustrcmp(item
+ 9, US
"no") == 0)
4847 do_shutdown
= FALSE
;
4849 else sub_arg
[3] = NULL
; /* No eol if no timeout */
4851 /* If skipping, we don't actually do anything. Otherwise, arrange to
4852 connect to either an IP or a Unix socket. */
4856 /* Handle an IP (internet) domain */
4858 if (Ustrncmp(sub_arg
[0], "inet:", 5) == 0)
4861 uschar
* server_name
= sub_arg
[0] + 5;
4862 uschar
* port_name
= Ustrrchr(server_name
, ':');
4864 /* Sort out the port */
4868 expand_string_message
=
4869 string_sprintf("missing port for readsocket %s", sub_arg
[0]);
4872 *port_name
++ = 0; /* Terminate server name */
4874 if (isdigit(*port_name
))
4877 port
= Ustrtol(port_name
, &end
, 0);
4878 if (end
!= port_name
+ Ustrlen(port_name
))
4880 expand_string_message
=
4881 string_sprintf("invalid port number %s", port_name
);
4887 struct servent
*service_info
= getservbyname(CS port_name
, "tcp");
4890 expand_string_message
= string_sprintf("unknown port \"%s\"",
4894 port
= ntohs(service_info
->s_port
);
4897 fd
= ip_connectedsocket(SOCK_STREAM
, server_name
, port
, port
,
4898 timeout
, NULL
, &expand_string_message
, &reqstr
);
4899 callout_address
= NULL
;
4905 /* Handle a Unix domain socket */
4909 struct sockaddr_un sockun
; /* don't call this "sun" ! */
4912 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) == -1)
4914 expand_string_message
= string_sprintf("failed to create socket: %s",
4919 sockun
.sun_family
= AF_UNIX
;
4920 sprintf(sockun
.sun_path
, "%.*s", (int)(sizeof(sockun
.sun_path
)-1),
4923 sigalrm_seen
= FALSE
;
4925 rc
= connect(fd
, (struct sockaddr
*)(&sockun
), sizeof(sockun
));
4929 expand_string_message
= US
"socket connect timed out";
4934 expand_string_message
= string_sprintf("failed to connect to socket "
4935 "%s: %s", sub_arg
[0], strerror(errno
));
4940 DEBUG(D_expand
) debug_printf_indent("connected to socket %s\n", sub_arg
[0]);
4942 /* Allow sequencing of test actions */
4943 if (running_in_test_harness
) millisleep(100);
4945 /* Write the request string, if not empty or already done */
4949 DEBUG(D_expand
) debug_printf_indent("writing \"%s\" to socket\n",
4951 if (write(fd
, reqstr
.data
, reqstr
.len
) != reqstr
.len
)
4953 expand_string_message
= string_sprintf("request write to socket "
4954 "failed: %s", strerror(errno
));
4959 /* Shut down the sending side of the socket. This helps some servers to
4960 recognise that it is their turn to do some work. Just in case some
4961 system doesn't have this function, make it conditional. */
4964 if (do_shutdown
) shutdown(fd
, SHUT_WR
);
4967 if (running_in_test_harness
) millisleep(100);
4969 /* Now we need to read from the socket, under a timeout. The function
4970 that reads a file can be used. */
4972 f
= fdopen(fd
, "rb");
4973 sigalrm_seen
= FALSE
;
4975 yield
= cat_file(f
, yield
, sub_arg
[3]);
4979 /* After a timeout, we restore the pointer in the result, that is,
4980 make sure we add nothing from the socket. */
4984 yield
->ptr
= save_ptr
;
4985 expand_string_message
= US
"socket read timed out";
4990 /* The whole thing has worked (or we were skipping). If there is a
4991 failure string following, we need to skip it. */
4995 if (expand_string_internal(s
+1, TRUE
, &s
, TRUE
, TRUE
, &resetok
) == NULL
)
4999 expand_string_message
= US
"missing '}' closing failstring for readsocket";
5000 goto EXPAND_FAILED_CURLY
;
5002 while (isspace(*s
)) s
++;
5008 expand_string_message
= US
"missing '}' closing readsocket";
5009 goto EXPAND_FAILED_CURLY
;
5013 /* Come here on failure to create socket, connect socket, write to the
5014 socket, or timeout on reading. If another substring follows, expand and
5015 use it. Otherwise, those conditions give expand errors. */
5018 if (*s
!= '{') goto EXPAND_FAILED
;
5019 DEBUG(D_any
) debug_printf("%s\n", expand_string_message
);
5020 if (!(arg
= expand_string_internal(s
+1, TRUE
, &s
, FALSE
, TRUE
, &resetok
)))
5022 yield
= string_cat(yield
, arg
);
5025 expand_string_message
= US
"missing '}' closing failstring for readsocket";
5026 goto EXPAND_FAILED_CURLY
;
5028 while (isspace(*s
)) s
++;
5032 /* Handle "run" to execute a program. */
5038 const uschar
**argv
;
5042 if ((expand_forbid
& RDO_RUN
) != 0)
5044 expand_string_message
= US
"running a command is not permitted";
5048 while (isspace(*s
)) s
++;
5051 expand_string_message
= US
"missing '{' for command arg of run";
5052 goto EXPAND_FAILED_CURLY
;
5054 arg
= expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
5055 if (arg
== NULL
) goto EXPAND_FAILED
;
5056 while (isspace(*s
)) s
++;
5059 expand_string_message
= US
"missing '}' closing command arg of run";
5060 goto EXPAND_FAILED_CURLY
;
5063 if (skipping
) /* Just pretend it worked when we're skipping */
5066 lookup_value
= NULL
;
5070 if (!transport_set_up_command(&argv
, /* anchor for arg list */
5071 arg
, /* raw command */
5072 FALSE
, /* don't expand the arguments */
5073 0, /* not relevant when... */
5074 NULL
, /* no transporting address */
5075 US
"${run} expansion", /* for error messages */
5076 &expand_string_message
)) /* where to put error message */
5079 /* Create the child process, making it a group leader. */
5081 if ((pid
= child_open(USS argv
, NULL
, 0077, &fd_in
, &fd_out
, TRUE
)) < 0)
5083 expand_string_message
=
5084 string_sprintf("couldn't create child process: %s", strerror(errno
));
5088 /* Nothing is written to the standard input. */
5092 /* Read the pipe to get the command's output into $value (which is kept
5093 in lookup_value). Read during execution, so that if the output exceeds
5094 the OS pipe buffer limit, we don't block forever. Remember to not release
5095 memory just allocated for $value. */
5098 f
= fdopen(fd_out
, "rb");
5099 sigalrm_seen
= FALSE
;
5101 lookup_value
= string_from_gstring(cat_file(f
, NULL
, NULL
));
5105 /* Wait for the process to finish, applying the timeout, and inspect its
5106 return code for serious disasters. Simple non-zero returns are passed on.
5109 if (sigalrm_seen
|| (runrc
= child_close(pid
, 30)) < 0)
5111 if (sigalrm_seen
|| runrc
== -256)
5113 expand_string_message
= string_sprintf("command timed out");
5114 killpg(pid
, SIGKILL
); /* Kill the whole process group */
5117 else if (runrc
== -257)
5118 expand_string_message
= string_sprintf("wait() failed: %s",
5122 expand_string_message
= string_sprintf("command killed by signal %d",
5129 /* Process the yes/no strings; $value may be useful in both cases */
5131 switch(process_yesno(
5132 skipping
, /* were previously skipping */
5133 runrc
== 0, /* success/failure indicator */
5134 lookup_value
, /* value to reset for string2 */
5135 &s
, /* input pointer */
5136 &yield
, /* output pointer */
5137 US
"run", /* condition type */
5140 case 1: goto EXPAND_FAILED
; /* when all is well, the */
5141 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
5147 /* Handle character translation for "tr" */
5151 int oldptr
= yield
->ptr
;
5155 switch(read_subs(sub
, 3, 3, &s
, skipping
, TRUE
, US
"tr", &resetok
))
5157 case 1: goto EXPAND_FAILED_CURLY
;
5159 case 3: goto EXPAND_FAILED
;
5162 yield
= string_cat(yield
, sub
[0]);
5163 o2m
= Ustrlen(sub
[2]) - 1;
5165 if (o2m
>= 0) for (; oldptr
< yield
->ptr
; oldptr
++)
5167 uschar
*m
= Ustrrchr(sub
[1], yield
->s
[oldptr
]);
5171 yield
->s
[oldptr
] = sub
[2][(o
< o2m
)? o
: o2m
];
5178 /* Handle "hash", "length", "nhash", and "substr" when they are given with
5179 expanded arguments. */
5189 int val
[2] = { 0, -1 };
5192 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5193 Ensure that sub[2] is set in the ${length } case. */
5196 switch(read_subs(sub
, (item_type
== EITEM_LENGTH
)? 2:3, 2, &s
, skipping
,
5197 TRUE
, name
, &resetok
))
5199 case 1: goto EXPAND_FAILED_CURLY
;
5201 case 3: goto EXPAND_FAILED
;
5204 /* Juggle the arguments if there are only two of them: always move the
5205 string to the last position and make ${length{n}{str}} equivalent to
5206 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5212 if (item_type
== EITEM_LENGTH
)
5219 for (i
= 0; i
< 2; i
++)
5221 if (sub
[i
] == NULL
) continue;
5222 val
[i
] = (int)Ustrtol(sub
[i
], &ret
, 10);
5223 if (*ret
!= 0 || (i
!= 0 && val
[i
] < 0))
5225 expand_string_message
= string_sprintf("\"%s\" is not a%s number "
5226 "(in \"%s\" expansion)", sub
[i
], (i
!= 0)? " positive" : "", name
);
5232 (item_type
== EITEM_HASH
)?
5233 compute_hash(sub
[2], val
[0], val
[1], &len
) :
5234 (item_type
== EITEM_NHASH
)?
5235 compute_nhash(sub
[2], val
[0], val
[1], &len
) :
5236 extract_substr(sub
[2], val
[0], val
[1], &len
);
5238 if (ret
== NULL
) goto EXPAND_FAILED
;
5239 yield
= string_catn(yield
, ret
, len
);
5243 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5244 This code originally contributed by Steve Haslam. It currently supports
5245 the use of MD5 and SHA-1 hashes.
5247 We need some workspace that is large enough to handle all the supported
5248 hash types. Use macros to set the sizes rather than be too elaborate. */
5250 #define MAX_HASHLEN 20
5251 #define MAX_HASHBLOCKLEN 64
5260 int hashlen
; /* Number of octets for the hash algorithm's output */
5261 int hashblocklen
; /* Number of octets the hash algorithm processes */
5263 unsigned int keylen
;
5265 uschar keyhash
[MAX_HASHLEN
];
5266 uschar innerhash
[MAX_HASHLEN
];
5267 uschar finalhash
[MAX_HASHLEN
];
5268 uschar finalhash_hex
[2*MAX_HASHLEN
];
5269 uschar innerkey
[MAX_HASHBLOCKLEN
];
5270 uschar outerkey
[MAX_HASHBLOCKLEN
];
5272 switch (read_subs(sub
, 3, 3, &s
, skipping
, TRUE
, name
, &resetok
))
5274 case 1: goto EXPAND_FAILED_CURLY
;
5276 case 3: goto EXPAND_FAILED
;
5281 if (Ustrcmp(sub
[0], "md5") == 0)
5284 use_base
= &md5_base
;
5288 else if (Ustrcmp(sub
[0], "sha1") == 0)
5291 use_base
= &sha1_ctx
;
5297 expand_string_message
=
5298 string_sprintf("hmac algorithm \"%s\" is not recognised", sub
[0]);
5303 keylen
= Ustrlen(keyptr
);
5305 /* If the key is longer than the hash block length, then hash the key
5308 if (keylen
> hashblocklen
)
5310 chash_start(type
, use_base
);
5311 chash_end(type
, use_base
, keyptr
, keylen
, keyhash
);
5316 /* Now make the inner and outer key values */
5318 memset(innerkey
, 0x36, hashblocklen
);
5319 memset(outerkey
, 0x5c, hashblocklen
);
5321 for (i
= 0; i
< keylen
; i
++)
5323 innerkey
[i
] ^= keyptr
[i
];
5324 outerkey
[i
] ^= keyptr
[i
];
5327 /* Now do the hashes */
5329 chash_start(type
, use_base
);
5330 chash_mid(type
, use_base
, innerkey
);
5331 chash_end(type
, use_base
, sub
[2], Ustrlen(sub
[2]), innerhash
);
5333 chash_start(type
, use_base
);
5334 chash_mid(type
, use_base
, outerkey
);
5335 chash_end(type
, use_base
, innerhash
, hashlen
, finalhash
);
5337 /* Encode the final hash as a hex string */
5340 for (i
= 0; i
< hashlen
; i
++)
5342 *p
++ = hex_digits
[(finalhash
[i
] & 0xf0) >> 4];
5343 *p
++ = hex_digits
[finalhash
[i
] & 0x0f];
5346 DEBUG(D_any
) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5347 sub
[0], (int)keylen
, keyptr
, sub
[2], hashlen
*2, finalhash_hex
);
5349 yield
= string_catn(yield
, finalhash_hex
, hashlen
*2);
5354 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5355 We have to save the numerical variables and restore them afterwards. */
5360 int moffset
, moffsetextra
, slen
;
5363 const uschar
*rerror
;
5366 int save_expand_nmax
=
5367 save_expand_strings(save_expand_nstring
, save_expand_nlength
);
5369 switch(read_subs(sub
, 3, 3, &s
, skipping
, TRUE
, US
"sg", &resetok
))
5371 case 1: goto EXPAND_FAILED_CURLY
;
5373 case 3: goto EXPAND_FAILED
;
5376 /* Compile the regular expression */
5378 re
= pcre_compile(CS sub
[1], PCRE_COPT
, (const char **)&rerror
, &roffset
,
5383 expand_string_message
= string_sprintf("regular expression error in "
5384 "\"%s\": %s at offset %d", sub
[1], rerror
, roffset
);
5388 /* Now run a loop to do the substitutions as often as necessary. It ends
5389 when there are no more matches. Take care over matches of the null string;
5390 do the same thing as Perl does. */
5393 slen
= Ustrlen(sub
[0]);
5394 moffset
= moffsetextra
= 0;
5399 int ovector
[3*(EXPAND_MAXN
+1)];
5400 int n
= pcre_exec(re
, NULL
, CS subject
, slen
, moffset
+ moffsetextra
,
5401 PCRE_EOPT
| emptyopt
, ovector
, nelem(ovector
));
5405 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5406 is not necessarily the end. We want to repeat the match from one
5407 character further along, but leaving the basic offset the same (for
5408 copying below). We can't be at the end of the string - that was checked
5409 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5410 finished; copy the remaining string and end the loop. */
5420 yield
= string_catn(yield
, subject
+moffset
, slen
-moffset
);
5424 /* Match - set up for expanding the replacement. */
5426 if (n
== 0) n
= EXPAND_MAXN
+ 1;
5428 for (nn
= 0; nn
< n
*2; nn
+= 2)
5430 expand_nstring
[expand_nmax
] = subject
+ ovector
[nn
];
5431 expand_nlength
[expand_nmax
++] = ovector
[nn
+1] - ovector
[nn
];
5435 /* Copy the characters before the match, plus the expanded insertion. */
5437 yield
= string_catn(yield
, subject
+ moffset
, ovector
[0] - moffset
);
5438 insert
= expand_string(sub
[2]);
5439 if (insert
== NULL
) goto EXPAND_FAILED
;
5440 yield
= string_cat(yield
, insert
);
5442 moffset
= ovector
[1];
5446 /* If we have matched an empty string, first check to see if we are at
5447 the end of the subject. If so, the loop is over. Otherwise, mimic
5448 what Perl's /g options does. This turns out to be rather cunning. First
5449 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5450 string at the same point. If this fails (picked up above) we advance to
5451 the next character. */
5453 if (ovector
[0] == ovector
[1])
5455 if (ovector
[0] == slen
) break;
5456 emptyopt
= PCRE_NOTEMPTY
| PCRE_ANCHORED
;
5460 /* All done - restore numerical variables. */
5462 restore_expand_strings(save_expand_nmax
, save_expand_nstring
,
5463 save_expand_nlength
);
5467 /* Handle keyed and numbered substring extraction. If the first argument
5468 consists entirely of digits, then a numerical extraction is assumed. */
5474 int field_number
= 1;
5475 BOOL field_number_set
= FALSE
;
5476 uschar
*save_lookup_value
= lookup_value
;
5478 int save_expand_nmax
=
5479 save_expand_strings(save_expand_nstring
, save_expand_nlength
);
5481 /* While skipping we cannot rely on the data for expansions being
5482 available (eg. $item) hence cannot decide on numeric vs. keyed.
5483 Read a maximum of 5 arguments (including the yes/no) */
5487 while (isspace(*s
)) s
++;
5488 for (j
= 5; j
> 0 && *s
== '{'; j
--)
5490 if (!expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
))
5491 goto EXPAND_FAILED
; /*{*/
5494 expand_string_message
= US
"missing '{' for arg of extract";
5495 goto EXPAND_FAILED_CURLY
;
5497 while (isspace(*s
)) s
++;
5499 if ( Ustrncmp(s
, "fail", 4) == 0
5500 && (s
[4] == '}' || s
[4] == ' ' || s
[4] == '\t' || !s
[4])
5504 while (isspace(*s
)) s
++;
5508 expand_string_message
= US
"missing '}' closing extract";
5509 goto EXPAND_FAILED_CURLY
;
5513 else for (i
= 0, j
= 2; i
< j
; i
++) /* Read the proper number of arguments */
5515 while (isspace(*s
)) s
++;
5516 if (*s
== '{') /*}*/
5518 sub
[i
] = expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
5519 if (sub
[i
] == NULL
) goto EXPAND_FAILED
; /*{*/
5522 expand_string_message
= string_sprintf(
5523 "missing '}' closing arg %d of extract", i
+1);
5524 goto EXPAND_FAILED_CURLY
;
5527 /* After removal of leading and trailing white space, the first
5528 argument must not be empty; if it consists entirely of digits
5529 (optionally preceded by a minus sign), this is a numerical
5530 extraction, and we expect 3 arguments. */
5538 while (isspace(*p
)) p
++;
5542 while (len
> 0 && isspace(p
[len
-1])) len
--;
5547 expand_string_message
= US
"first argument of \"extract\" must "
5557 while (*p
!= 0 && isdigit(*p
)) x
= x
* 10 + *p
++ - '0';
5561 j
= 3; /* Need 3 args */
5562 field_number_set
= TRUE
;
5568 expand_string_message
= string_sprintf(
5569 "missing '{' for arg %d of extract", i
+1);
5570 goto EXPAND_FAILED_CURLY
;
5574 /* Extract either the numbered or the keyed substring into $value. If
5575 skipping, just pretend the extraction failed. */
5577 lookup_value
= skipping
? NULL
: field_number_set
?
5578 expand_gettokened(field_number
, sub
[1], sub
[2]) :
5579 expand_getkeyed(sub
[0], sub
[1]);
5581 /* If no string follows, $value gets substituted; otherwise there can
5582 be yes/no strings, as for lookup or if. */
5584 switch(process_yesno(
5585 skipping
, /* were previously skipping */
5586 lookup_value
!= NULL
, /* success/failure indicator */
5587 save_lookup_value
, /* value to reset for string2 */
5588 &s
, /* input pointer */
5589 &yield
, /* output pointer */
5590 US
"extract", /* condition type */
5593 case 1: goto EXPAND_FAILED
; /* when all is well, the */
5594 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
5597 /* All done - restore numerical variables. */
5599 restore_expand_strings(save_expand_nmax
, save_expand_nstring
,
5600 save_expand_nlength
);
5605 /* return the Nth item from a list */
5607 case EITEM_LISTEXTRACT
:
5610 int field_number
= 1;
5611 uschar
*save_lookup_value
= lookup_value
;
5613 int save_expand_nmax
=
5614 save_expand_strings(save_expand_nstring
, save_expand_nlength
);
5616 /* Read the field & list arguments */
5618 for (i
= 0; i
< 2; i
++)
5620 while (isspace(*s
)) s
++;
5621 if (*s
!= '{') /*}*/
5623 expand_string_message
= string_sprintf(
5624 "missing '{' for arg %d of listextract", i
+1);
5625 goto EXPAND_FAILED_CURLY
;
5628 sub
[i
] = expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
5629 if (!sub
[i
]) goto EXPAND_FAILED
; /*{*/
5632 expand_string_message
= string_sprintf(
5633 "missing '}' closing arg %d of listextract", i
+1);
5634 goto EXPAND_FAILED_CURLY
;
5637 /* After removal of leading and trailing white space, the first
5638 argument must be numeric and nonempty. */
5646 while (isspace(*p
)) p
++;
5650 while (len
> 0 && isspace(p
[len
-1])) len
--;
5653 if (!*p
&& !skipping
)
5655 expand_string_message
= US
"first argument of \"listextract\" must "
5665 while (*p
&& isdigit(*p
)) x
= x
* 10 + *p
++ - '0';
5668 expand_string_message
= US
"first argument of \"listextract\" must "
5676 /* Extract the numbered element into $value. If
5677 skipping, just pretend the extraction failed. */
5679 lookup_value
= skipping
? NULL
: expand_getlistele(field_number
, sub
[1]);
5681 /* If no string follows, $value gets substituted; otherwise there can
5682 be yes/no strings, as for lookup or if. */
5684 switch(process_yesno(
5685 skipping
, /* were previously skipping */
5686 lookup_value
!= NULL
, /* success/failure indicator */
5687 save_lookup_value
, /* value to reset for string2 */
5688 &s
, /* input pointer */
5689 &yield
, /* output pointer */
5690 US
"listextract", /* condition type */
5693 case 1: goto EXPAND_FAILED
; /* when all is well, the */
5694 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
5697 /* All done - restore numerical variables. */
5699 restore_expand_strings(save_expand_nmax
, save_expand_nstring
,
5700 save_expand_nlength
);
5706 case EITEM_CERTEXTRACT
:
5708 uschar
*save_lookup_value
= lookup_value
;
5710 int save_expand_nmax
=
5711 save_expand_strings(save_expand_nstring
, save_expand_nlength
);
5713 /* Read the field argument */
5714 while (isspace(*s
)) s
++;
5715 if (*s
!= '{') /*}*/
5717 expand_string_message
= US
"missing '{' for field arg of certextract";
5718 goto EXPAND_FAILED_CURLY
;
5720 sub
[0] = expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
5721 if (!sub
[0]) goto EXPAND_FAILED
; /*{*/
5724 expand_string_message
= US
"missing '}' closing field arg of certextract";
5725 goto EXPAND_FAILED_CURLY
;
5727 /* strip spaces fore & aft */
5732 while (isspace(*p
)) p
++;
5736 while (len
> 0 && isspace(p
[len
-1])) len
--;
5740 /* inspect the cert argument */
5741 while (isspace(*s
)) s
++;
5742 if (*s
!= '{') /*}*/
5744 expand_string_message
= US
"missing '{' for cert variable arg of certextract";
5745 goto EXPAND_FAILED_CURLY
;
5749 expand_string_message
= US
"second argument of \"certextract\" must "
5750 "be a certificate variable";
5753 sub
[1] = expand_string_internal(s
+1, TRUE
, &s
, skipping
, FALSE
, &resetok
);
5754 if (!sub
[1]) goto EXPAND_FAILED
; /*{*/
5757 expand_string_message
= US
"missing '}' closing cert variable arg of certextract";
5758 goto EXPAND_FAILED_CURLY
;
5762 lookup_value
= NULL
;
5765 lookup_value
= expand_getcertele(sub
[0], sub
[1]);
5766 if (*expand_string_message
) goto EXPAND_FAILED
;
5768 switch(process_yesno(
5769 skipping
, /* were previously skipping */
5770 lookup_value
!= NULL
, /* success/failure indicator */
5771 save_lookup_value
, /* value to reset for string2 */
5772 &s
, /* input pointer */
5773 &yield
, /* output pointer */
5774 US
"certextract", /* condition type */
5777 case 1: goto EXPAND_FAILED
; /* when all is well, the */
5778 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
5781 restore_expand_strings(save_expand_nmax
, save_expand_nstring
,
5782 save_expand_nlength
);
5785 #endif /*SUPPORT_TLS*/
5787 /* Handle list operations */
5794 int save_ptr
= yield
->ptr
;
5795 uschar outsep
[2] = { '\0', '\0' };
5796 const uschar
*list
, *expr
, *temp
;
5797 uschar
*save_iterate_item
= iterate_item
;
5798 uschar
*save_lookup_value
= lookup_value
;
5800 while (isspace(*s
)) s
++;
5803 expand_string_message
=
5804 string_sprintf("missing '{' for first arg of %s", name
);
5805 goto EXPAND_FAILED_CURLY
;
5808 list
= expand_string_internal(s
, TRUE
, &s
, skipping
, TRUE
, &resetok
);
5809 if (list
== NULL
) goto EXPAND_FAILED
;
5812 expand_string_message
=
5813 string_sprintf("missing '}' closing first arg of %s", name
);
5814 goto EXPAND_FAILED_CURLY
;
5817 if (item_type
== EITEM_REDUCE
)
5820 while (isspace(*s
)) s
++;
5823 expand_string_message
= US
"missing '{' for second arg of reduce";
5824 goto EXPAND_FAILED_CURLY
;
5826 t
= expand_string_internal(s
, TRUE
, &s
, skipping
, TRUE
, &resetok
);
5827 if (!t
) goto EXPAND_FAILED
;
5831 expand_string_message
= US
"missing '}' closing second arg of reduce";
5832 goto EXPAND_FAILED_CURLY
;
5836 while (isspace(*s
)) s
++;
5839 expand_string_message
=
5840 string_sprintf("missing '{' for last arg of %s", name
);
5841 goto EXPAND_FAILED_CURLY
;
5846 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5847 if scanning a "false" part). This allows us to find the end of the
5848 condition, because if the list is empty, we won't actually evaluate the
5849 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5850 the normal internal expansion function. */
5852 if (item_type
== EITEM_FILTER
)
5854 temp
= eval_condition(expr
, &resetok
, NULL
);
5855 if (temp
!= NULL
) s
= temp
;
5858 temp
= expand_string_internal(s
, TRUE
, &s
, TRUE
, TRUE
, &resetok
);
5862 expand_string_message
= string_sprintf("%s inside \"%s\" item",
5863 expand_string_message
, name
);
5867 while (isspace(*s
)) s
++;
5870 expand_string_message
= string_sprintf("missing } at end of condition "
5871 "or expression inside \"%s\"; could be an unquoted } in the content",
5876 while (isspace(*s
)) s
++; /*{*/
5879 expand_string_message
= string_sprintf("missing } at end of \"%s\"",
5884 /* If we are skipping, we can now just move on to the next item. When
5885 processing for real, we perform the iteration. */
5887 if (skipping
) continue;
5888 while ((iterate_item
= string_nextinlist(&list
, &sep
, NULL
, 0)))
5890 *outsep
= (uschar
)sep
; /* Separator as a string */
5892 DEBUG(D_expand
) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",
5893 name
, iterate_item
, lookup_value
);
5895 if (item_type
== EITEM_FILTER
)
5898 if (eval_condition(expr
, &resetok
, &condresult
) == NULL
)
5900 iterate_item
= save_iterate_item
;
5901 lookup_value
= save_lookup_value
;
5902 expand_string_message
= string_sprintf("%s inside \"%s\" condition",
5903 expand_string_message
, name
);
5906 DEBUG(D_expand
) debug_printf_indent("%s: condition is %s\n", name
,
5907 condresult
? "true":"false");
5909 temp
= iterate_item
; /* TRUE => include this item */
5911 continue; /* FALSE => skip this item */
5914 /* EITEM_MAP and EITEM_REDUCE */
5918 uschar
* t
= expand_string_internal(expr
, TRUE
, NULL
, skipping
, TRUE
, &resetok
);
5922 iterate_item
= save_iterate_item
;
5923 expand_string_message
= string_sprintf("%s inside \"%s\" item",
5924 expand_string_message
, name
);
5927 if (item_type
== EITEM_REDUCE
)
5929 lookup_value
= t
; /* Update the value of $value */
5930 continue; /* and continue the iteration */
5934 /* We reach here for FILTER if the condition is true, always for MAP,
5935 and never for REDUCE. The value in "temp" is to be added to the output
5936 list that is being created, ensuring that any occurrences of the
5937 separator character are doubled. Unless we are dealing with the first
5938 item of the output list, add in a space if the new item begins with the
5939 separator character, or is an empty string. */
5941 if (yield
->ptr
!= save_ptr
&& (temp
[0] == *outsep
|| temp
[0] == 0))
5942 yield
= string_catn(yield
, US
" ", 1);
5944 /* Add the string in "temp" to the output list that we are building,
5945 This is done in chunks by searching for the separator character. */
5949 size_t seglen
= Ustrcspn(temp
, outsep
);
5951 yield
= string_catn(yield
, temp
, seglen
+ 1);
5953 /* If we got to the end of the string we output one character
5954 too many; backup and end the loop. Otherwise arrange to double the
5957 if (temp
[seglen
] == '\0') { yield
->ptr
--; break; }
5958 yield
= string_catn(yield
, outsep
, 1);
5962 /* Output a separator after the string: we will remove the redundant
5963 final one at the end. */
5965 yield
= string_catn(yield
, outsep
, 1);
5966 } /* End of iteration over the list loop */
5968 /* REDUCE has generated no output above: output the final value of
5971 if (item_type
== EITEM_REDUCE
)
5973 yield
= string_cat(yield
, lookup_value
);
5974 lookup_value
= save_lookup_value
; /* Restore $value */
5977 /* FILTER and MAP generate lists: if they have generated anything, remove
5978 the redundant final separator. Even though an empty item at the end of a
5979 list does not count, this is tidier. */
5981 else if (yield
->ptr
!= save_ptr
) yield
->ptr
--;
5983 /* Restore preserved $item */
5985 iterate_item
= save_iterate_item
;
5992 const uschar
*srclist
, *cmp
, *xtract
;
5994 const uschar
*dstlist
= NULL
, *dstkeylist
= NULL
;
5996 uschar
*save_iterate_item
= iterate_item
;
5998 while (isspace(*s
)) s
++;
6001 expand_string_message
= US
"missing '{' for list arg of sort";
6002 goto EXPAND_FAILED_CURLY
;
6005 srclist
= expand_string_internal(s
, TRUE
, &s
, skipping
, TRUE
, &resetok
);
6006 if (!srclist
) goto EXPAND_FAILED
;
6009 expand_string_message
= US
"missing '}' closing list arg of sort";
6010 goto EXPAND_FAILED_CURLY
;
6013 while (isspace(*s
)) s
++;
6016 expand_string_message
= US
"missing '{' for comparator arg of sort";
6017 goto EXPAND_FAILED_CURLY
;
6020 cmp
= expand_string_internal(s
, TRUE
, &s
, skipping
, FALSE
, &resetok
);
6021 if (!cmp
) goto EXPAND_FAILED
;
6024 expand_string_message
= US
"missing '}' closing comparator arg of sort";
6025 goto EXPAND_FAILED_CURLY
;
6028 while (isspace(*s
)) s
++;
6031 expand_string_message
= US
"missing '{' for extractor arg of sort";
6032 goto EXPAND_FAILED_CURLY
;
6036 tmp
= expand_string_internal(s
, TRUE
, &s
, TRUE
, TRUE
, &resetok
);
6037 if (!tmp
) goto EXPAND_FAILED
;
6038 xtract
= string_copyn(xtract
, s
- xtract
);
6042 expand_string_message
= US
"missing '}' closing extractor arg of sort";
6043 goto EXPAND_FAILED_CURLY
;
6048 expand_string_message
= US
"missing } at end of \"sort\"";
6052 if (skipping
) continue;
6054 while ((srcitem
= string_nextinlist(&srclist
, &sep
, NULL
, 0)))
6057 gstring
* newlist
= NULL
;
6058 gstring
* newkeylist
= NULL
;
6061 DEBUG(D_expand
) debug_printf_indent("%s: $item = \"%s\"\n", name
, srcitem
);
6063 /* extract field for comparisons */
6064 iterate_item
= srcitem
;
6065 if ( !(srcfield
= expand_string_internal(xtract
, FALSE
, NULL
, FALSE
,
6069 expand_string_message
= string_sprintf(
6070 "field-extract in sort: \"%s\"", xtract
);
6074 /* Insertion sort */
6076 /* copy output list until new-item < list-item */
6077 while ((dstitem
= string_nextinlist(&dstlist
, &sep
, NULL
, 0)))
6083 /* field for comparison */
6084 if (!(dstfield
= string_nextinlist(&dstkeylist
, &sep
, NULL
, 0)))
6087 /* build and run condition string */
6088 expr
= string_sprintf("%s{%s}{%s}", cmp
, srcfield
, dstfield
);
6090 DEBUG(D_expand
) debug_printf_indent("%s: cond = \"%s\"\n", name
, expr
);
6091 if (!eval_condition(expr
, &resetok
, &before
))
6093 expand_string_message
= string_sprintf("comparison in sort: %s",
6100 /* New-item sorts before this dst-item. Append new-item,
6101 then dst-item, then remainder of dst list. */
6103 newlist
= string_append_listele(newlist
, sep
, srcitem
);
6104 newkeylist
= string_append_listele(newkeylist
, sep
, srcfield
);
6107 newlist
= string_append_listele(newlist
, sep
, dstitem
);
6108 newkeylist
= string_append_listele(newkeylist
, sep
, dstfield
);
6110 while ((dstitem
= string_nextinlist(&dstlist
, &sep
, NULL
, 0)))
6112 if (!(dstfield
= string_nextinlist(&dstkeylist
, &sep
, NULL
, 0)))
6114 newlist
= string_append_listele(newlist
, sep
, dstitem
);
6115 newkeylist
= string_append_listele(newkeylist
, sep
, dstfield
);
6121 newlist
= string_append_listele(newlist
, sep
, dstitem
);
6122 newkeylist
= string_append_listele(newkeylist
, sep
, dstfield
);
6125 /* If we ran out of dstlist without consuming srcitem, append it */
6128 newlist
= string_append_listele(newlist
, sep
, srcitem
);
6129 newkeylist
= string_append_listele(newkeylist
, sep
, srcfield
);
6132 dstlist
= newlist
->s
;
6133 dstkeylist
= newkeylist
->s
;
6135 DEBUG(D_expand
) debug_printf_indent("%s: dstlist = \"%s\"\n", name
, dstlist
);
6136 DEBUG(D_expand
) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name
, dstkeylist
);
6140 yield
= string_cat(yield
, dstlist
);
6142 /* Restore preserved $item */
6143 iterate_item
= save_iterate_item
;
6147 expand_string_message
= US
"Internal error in sort (list mismatch)";
6152 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6153 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6154 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6155 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6157 #define EXPAND_DLFUNC_MAX_ARGS 8
6160 #ifndef EXPAND_DLFUNC
6161 expand_string_message
= US
"\"${dlfunc\" encountered, but this facility " /*}*/
6162 "is not included in this binary";
6165 #else /* EXPAND_DLFUNC */
6168 exim_dlfunc_t
*func
;
6171 uschar
*argv
[EXPAND_DLFUNC_MAX_ARGS
+ 3];
6173 if ((expand_forbid
& RDO_DLFUNC
) != 0)
6175 expand_string_message
=
6176 US
"dynamically-loaded functions are not permitted";
6180 switch(read_subs(argv
, EXPAND_DLFUNC_MAX_ARGS
+ 2, 2, &s
, skipping
,
6181 TRUE
, US
"dlfunc", &resetok
))
6183 case 1: goto EXPAND_FAILED_CURLY
;
6185 case 3: goto EXPAND_FAILED
;
6188 /* If skipping, we don't actually do anything */
6190 if (skipping
) continue;
6192 /* Look up the dynamically loaded object handle in the tree. If it isn't
6193 found, dlopen() the file and put the handle in the tree for next time. */
6195 t
= tree_search(dlobj_anchor
, argv
[0]);
6198 void *handle
= dlopen(CS argv
[0], RTLD_LAZY
);
6201 expand_string_message
= string_sprintf("dlopen \"%s\" failed: %s",
6202 argv
[0], dlerror());
6203 log_write(0, LOG_MAIN
|LOG_PANIC
, "%s", expand_string_message
);
6206 t
= store_get_perm(sizeof(tree_node
) + Ustrlen(argv
[0]));
6207 Ustrcpy(t
->name
, argv
[0]);
6208 t
->data
.ptr
= handle
;
6209 (void)tree_insertnode(&dlobj_anchor
, t
);
6212 /* Having obtained the dynamically loaded object handle, look up the
6213 function pointer. */
6215 func
= (exim_dlfunc_t
*)dlsym(t
->data
.ptr
, CS argv
[1]);
6218 expand_string_message
= string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6219 "%s", argv
[1], argv
[0], dlerror());
6220 log_write(0, LOG_MAIN
|LOG_PANIC
, "%s", expand_string_message
);
6224 /* Call the function and work out what to do with the result. If it
6225 returns OK, we have a replacement string; if it returns DEFER then
6226 expansion has failed in a non-forced manner; if it returns FAIL then
6227 failure was forced; if it returns ERROR or any other value there's a
6228 problem, so panic slightly. In any case, assume that the function has
6229 side-effects on the store that must be preserved. */
6233 for (argc
= 0; argv
[argc
] != NULL
; argc
++);
6234 status
= func(&result
, argc
- 2, &argv
[2]);
6237 if (result
== NULL
) result
= US
"";
6238 yield
= string_cat(yield
, result
);
6243 expand_string_message
= result
== NULL
? US
"(no message)" : result
;
6244 if(status
== FAIL_FORCED
) expand_string_forcedfail
= TRUE
;
6245 else if(status
!= FAIL
)
6246 log_write(0, LOG_MAIN
|LOG_PANIC
, "dlfunc{%s}{%s} failed (%d): %s",
6247 argv
[0], argv
[1], status
, expand_string_message
);
6251 #endif /* EXPAND_DLFUNC */
6253 case EITEM_ENV
: /* ${env {name} {val_if_found} {val_if_unfound}} */
6256 uschar
*save_lookup_value
= lookup_value
;
6258 while (isspace(*s
)) s
++;
6259 if (*s
!= '{') /*}*/
6262 key
= expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
6263 if (!key
) goto EXPAND_FAILED
; /*{*/
6266 expand_string_message
= US
"missing '{' for name arg of env";
6267 goto EXPAND_FAILED_CURLY
;
6270 lookup_value
= US
getenv(CS key
);
6272 switch(process_yesno(
6273 skipping
, /* were previously skipping */
6274 lookup_value
!= NULL
, /* success/failure indicator */
6275 save_lookup_value
, /* value to reset for string2 */
6276 &s
, /* input pointer */
6277 &yield
, /* output pointer */
6278 US
"env", /* condition type */
6281 case 1: goto EXPAND_FAILED
; /* when all is well, the */
6282 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
6286 } /* EITEM_* switch */
6288 /* Control reaches here if the name is not recognized as one of the more
6289 complicated expansion items. Check for the "operator" syntax (name terminated
6290 by a colon). Some of the operators have arguments, separated by _ from the
6298 var_entry
*vp
= NULL
;
6300 /* Owing to an historical mis-design, an underscore may be part of the
6301 operator name, or it may introduce arguments. We therefore first scan the
6302 table of names that contain underscores. If there is no match, we cut off
6303 the arguments and then scan the main table. */
6305 if ((c
= chop_match(name
, op_table_underscore
,
6306 nelem(op_table_underscore
))) < 0)
6308 arg
= Ustrchr(name
, '_');
6309 if (arg
!= NULL
) *arg
= 0;
6310 c
= chop_match(name
, op_table_main
, nelem(op_table_main
));
6311 if (c
>= 0) c
+= nelem(op_table_underscore
);
6312 if (arg
!= NULL
) *arg
++ = '_'; /* Put back for error messages */
6315 /* Deal specially with operators that might take a certificate variable
6316 as we do not want to do the usual expansion. For most, expand the string.*/
6326 const uschar
* s1
= s
;
6327 sub
= expand_string_internal(s
+2, TRUE
, &s1
, skipping
,
6329 if (!sub
) goto EXPAND_FAILED
; /*{*/
6332 expand_string_message
=
6333 string_sprintf("missing '}' closing cert arg of %s", name
);
6334 goto EXPAND_FAILED_CURLY
;
6336 if ((vp
= find_var_ent(sub
)) && vp
->type
== vtype_cert
)
6346 sub
= expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
6347 if (!sub
) goto EXPAND_FAILED
;
6352 /* If we are skipping, we don't need to perform the operation at all.
6353 This matters for operations like "mask", because the data may not be
6354 in the correct format when skipping. For example, the expression may test
6355 for the existence of $sender_host_address before trying to mask it. For
6356 other operations, doing them may not fail, but it is a waste of time. */
6358 if (skipping
&& c
>= 0) continue;
6360 /* Otherwise, switch on the operator type */
6367 unsigned long int n
= Ustrtoul(sub
, &t
, 10);
6372 expand_string_message
= string_sprintf("argument for base32 "
6373 "operator is \"%s\", which is not a decimal number", sub
);
6377 g
= string_catn(g
, &base32_chars
[n
& 0x1f], 1);
6379 if (g
) while (g
->ptr
> 0) yield
= string_catn(yield
, &g
->s
[--g
->ptr
], 1);
6386 unsigned long int n
= 0;
6390 uschar
* t
= Ustrchr(base32_chars
, *tt
++);
6393 expand_string_message
= string_sprintf("argument for base32d "
6394 "operator is \"%s\", which is not a base 32 number", sub
);
6397 n
= n
* 32 + (t
- base32_chars
);
6399 s
= string_sprintf("%ld", n
);
6400 yield
= string_cat(yield
, s
);
6407 unsigned long int n
= Ustrtoul(sub
, &t
, 10);
6410 expand_string_message
= string_sprintf("argument for base62 "
6411 "operator is \"%s\", which is not a decimal number", sub
);
6414 t
= string_base62(n
);
6415 yield
= string_cat(yield
, t
);
6419 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6425 unsigned long int n
= 0;
6428 uschar
*t
= Ustrchr(base62_chars
, *tt
++);
6431 expand_string_message
= string_sprintf("argument for base62d "
6432 "operator is \"%s\", which is not a base %d number", sub
,
6436 n
= n
* BASE_62
+ (t
- base62_chars
);
6438 (void)sprintf(CS buf
, "%ld", n
);
6439 yield
= string_cat(yield
, buf
);
6445 uschar
*expanded
= expand_string_internal(sub
, FALSE
, NULL
, skipping
, TRUE
, &resetok
);
6446 if (expanded
== NULL
)
6448 expand_string_message
=
6449 string_sprintf("internal expansion of \"%s\" failed: %s", sub
,
6450 expand_string_message
);
6453 yield
= string_cat(yield
, expanded
);
6460 uschar
*t
= sub
- 1;
6461 while (*(++t
) != 0) { *t
= tolower(*t
); count
++; }
6462 yield
= string_catn(yield
, sub
, count
);
6469 uschar
*t
= sub
- 1;
6470 while (*(++t
) != 0) { *t
= toupper(*t
); count
++; }
6471 yield
= string_catn(yield
, sub
, count
);
6477 if (vp
&& *(void **)vp
->value
)
6479 uschar
* cp
= tls_cert_fprt_md5(*(void **)vp
->value
);
6480 yield
= string_cat(yield
, cp
);
6490 md5_end(&base
, sub
, Ustrlen(sub
), digest
);
6491 for(j
= 0; j
< 16; j
++) sprintf(st
+2*j
, "%02x", digest
[j
]);
6492 yield
= string_cat(yield
, US st
);
6498 if (vp
&& *(void **)vp
->value
)
6500 uschar
* cp
= tls_cert_fprt_sha1(*(void **)vp
->value
);
6501 yield
= string_cat(yield
, cp
);
6511 sha1_end(&h
, sub
, Ustrlen(sub
), digest
);
6512 for(j
= 0; j
< 20; j
++) sprintf(st
+2*j
, "%02X", digest
[j
]);
6513 yield
= string_catn(yield
, US st
, 40);
6518 #ifdef EXIM_HAVE_SHA2
6519 if (vp
&& *(void **)vp
->value
)
6521 uschar
* cp
= tls_cert_fprt_sha256(*(void **)vp
->value
);
6522 yield
= string_cat(yield
, cp
);
6530 if (!exim_sha_init(&h
, HASH_SHA2_256
))
6532 expand_string_message
= US
"unrecognised sha256 variant";
6535 exim_sha_update(&h
, sub
, Ustrlen(sub
));
6536 exim_sha_finish(&h
, &b
);
6539 sprintf(st
, "%02X", *b
.data
++);
6540 yield
= string_catn(yield
, US st
, 2);
6544 expand_string_message
= US
"sha256 only supported with TLS";
6549 #ifdef EXIM_HAVE_SHA3
6554 hashmethod m
= !arg
? HASH_SHA3_256
6555 : Ustrcmp(arg
, "224") == 0 ? HASH_SHA3_224
6556 : Ustrcmp(arg
, "256") == 0 ? HASH_SHA3_256
6557 : Ustrcmp(arg
, "384") == 0 ? HASH_SHA3_384
6558 : Ustrcmp(arg
, "512") == 0 ? HASH_SHA3_512
6561 if (m
== HASH_BADTYPE
|| !exim_sha_init(&h
, m
))
6563 expand_string_message
= US
"unrecognised sha3 variant";
6567 exim_sha_update(&h
, sub
, Ustrlen(sub
));
6568 exim_sha_finish(&h
, &b
);
6571 sprintf(st
, "%02X", *b
.data
++);
6572 yield
= string_catn(yield
, US st
, 2);
6577 expand_string_message
= US
"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
6581 /* Convert hex encoding to base64 encoding */
6591 for (enc
= sub
; *enc
!= 0; enc
++)
6593 if (!isxdigit(*enc
))
6595 expand_string_message
= string_sprintf("\"%s\" is not a hex "
6604 expand_string_message
= string_sprintf("\"%s\" contains an odd "
6605 "number of characters", sub
);
6609 while ((c
= *in
++) != 0)
6611 if (isdigit(c
)) c
-= '0';
6612 else c
= toupper(c
) - 'A' + 10;
6624 enc
= b64encode(sub
, out
- sub
);
6625 yield
= string_cat(yield
, enc
);
6629 /* Convert octets outside 0x21..0x7E to \xXX form */
6633 uschar
*t
= sub
- 1;
6636 if (*t
< 0x21 || 0x7E < *t
)
6637 yield
= string_catn(yield
, string_sprintf("\\x%02x", *t
), 4);
6639 yield
= string_catn(yield
, t
, 1);
6644 /* count the number of list elements */
6653 while (string_nextinlist(CUSS
&sub
, &sep
, buffer
, sizeof(buffer
)) != NULL
) cnt
++;
6654 cp
= string_sprintf("%d", cnt
);
6655 yield
= string_cat(yield
, cp
);
6659 /* expand a named list given the name */
6660 /* handles nested named lists; requotes as colon-sep list */
6664 tree_node
*t
= NULL
;
6665 const uschar
* list
;
6668 uschar
* suffix
= US
"";
6669 BOOL needsep
= FALSE
;
6672 if (*sub
== '+') sub
++;
6673 if (arg
== NULL
) /* no-argument version */
6675 if (!(t
= tree_search(addresslist_anchor
, sub
)) &&
6676 !(t
= tree_search(domainlist_anchor
, sub
)) &&
6677 !(t
= tree_search(hostlist_anchor
, sub
)))
6678 t
= tree_search(localpartlist_anchor
, sub
);
6680 else switch(*arg
) /* specific list-type version */
6682 case 'a': t
= tree_search(addresslist_anchor
, sub
); suffix
= US
"_a"; break;
6683 case 'd': t
= tree_search(domainlist_anchor
, sub
); suffix
= US
"_d"; break;
6684 case 'h': t
= tree_search(hostlist_anchor
, sub
); suffix
= US
"_h"; break;
6685 case 'l': t
= tree_search(localpartlist_anchor
, sub
); suffix
= US
"_l"; break;
6687 expand_string_message
= string_sprintf("bad suffix on \"list\" operator");
6693 expand_string_message
= string_sprintf("\"%s\" is not a %snamed list",
6695 : *arg
=='a'?"address "
6696 : *arg
=='d'?"domain "
6698 : *arg
=='l'?"localpart "
6703 list
= ((namedlist_block
*)(t
->data
.ptr
))->string
;
6705 while ((item
= string_nextinlist(&list
, &sep
, buffer
, sizeof(buffer
))))
6707 uschar
* buf
= US
" : ";
6709 yield
= string_catn(yield
, buf
, 3);
6713 if (*item
== '+') /* list item is itself a named list */
6715 uschar
* sub
= string_sprintf("${listnamed%s:%s}", suffix
, item
);
6716 item
= expand_string_internal(sub
, FALSE
, NULL
, FALSE
, TRUE
, &resetok
);
6718 else if (sep
!= ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6722 tok
[0] = sep
; tok
[1] = ':'; tok
[2] = 0;
6723 while ((cp
= strpbrk(CCS item
, tok
)))
6725 yield
= string_catn(yield
, item
, cp
- CS item
);
6726 if (*cp
++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6728 yield
= string_catn(yield
, US
"::", 2);
6731 else /* sep in item; should already be doubled; emit once */
6733 yield
= string_catn(yield
, US tok
, 1);
6734 if (*cp
== sep
) cp
++;
6739 yield
= string_cat(yield
, item
);
6744 /* mask applies a mask to an IP address; for example the result of
6745 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6752 int mask
, maskoffset
;
6753 int type
= string_is_ip_address(sub
, &maskoffset
);
6758 expand_string_message
= string_sprintf("\"%s\" is not an IP address",
6763 if (maskoffset
== 0)
6765 expand_string_message
= string_sprintf("missing mask value in \"%s\"",
6770 mask
= Ustrtol(sub
+ maskoffset
+ 1, &endptr
, 10);
6772 if (*endptr
!= 0 || mask
< 0 || mask
> ((type
== 4)? 32 : 128))
6774 expand_string_message
= string_sprintf("mask value too big in \"%s\"",
6779 /* Convert the address to binary integer(s) and apply the mask */
6781 sub
[maskoffset
] = 0;
6782 count
= host_aton(sub
, binary
);
6783 host_mask(count
, binary
, mask
);
6785 /* Convert to masked textual format and add to output. */
6787 yield
= string_catn(yield
, buffer
,
6788 host_nmtoa(count
, binary
, mask
, buffer
, '.'));
6793 case EOP_IPV6DENORM
:
6795 int type
= string_is_ip_address(sub
, NULL
);
6802 (void) host_aton(sub
, binary
);
6805 case 4: /* convert to IPv4-mapped IPv6 */
6806 binary
[0] = binary
[1] = 0;
6807 binary
[2] = 0x0000ffff;
6808 (void) host_aton(sub
, binary
+3);
6812 expand_string_message
=
6813 string_sprintf("\"%s\" is not an IP address", sub
);
6817 yield
= string_catn(yield
, buffer
, c
== EOP_IPV6NORM
6818 ? ipv6_nmtoa(binary
, buffer
)
6819 : host_nmtoa(4, binary
, -1, buffer
, ':')
6825 case EOP_LOCAL_PART
:
6829 int start
, end
, domain
;
6830 uschar
* t
= parse_extract_address(sub
, &error
, &start
, &end
, &domain
,
6833 if (c
!= EOP_DOMAIN
)
6835 if (c
== EOP_LOCAL_PART
&& domain
!= 0) end
= start
+ domain
- 1;
6836 yield
= string_catn(yield
, sub
+start
, end
-start
);
6838 else if (domain
!= 0)
6841 yield
= string_catn(yield
, sub
+domain
, end
-domain
);
6848 uschar outsep
[2] = { ':', '\0' };
6849 uschar
*address
, *error
;
6850 int save_ptr
= yield
->ptr
;
6851 int start
, end
, domain
; /* Not really used */
6853 while (isspace(*sub
)) sub
++;
6855 if (*outsep
= *++sub
) ++sub
;
6858 expand_string_message
= string_sprintf("output separator "
6859 "missing in expanding ${addresses:%s}", --sub
);
6862 parse_allow_group
= TRUE
;
6866 uschar
*p
= parse_find_address_end(sub
, FALSE
);
6867 uschar saveend
= *p
;
6869 address
= parse_extract_address(sub
, &error
, &start
, &end
, &domain
,
6873 /* Add the address to the output list that we are building. This is
6874 done in chunks by searching for the separator character. At the
6875 start, unless we are dealing with the first address of the output
6876 list, add in a space if the new address begins with the separator
6877 character, or is an empty string. */
6879 if (address
!= NULL
)
6881 if (yield
->ptr
!= save_ptr
&& address
[0] == *outsep
)
6882 yield
= string_catn(yield
, US
" ", 1);
6886 size_t seglen
= Ustrcspn(address
, outsep
);
6887 yield
= string_catn(yield
, address
, seglen
+ 1);
6889 /* If we got to the end of the string we output one character
6892 if (address
[seglen
] == '\0') { yield
->ptr
--; break; }
6893 yield
= string_catn(yield
, outsep
, 1);
6894 address
+= seglen
+ 1;
6897 /* Output a separator after the string: we will remove the
6898 redundant final one at the end. */
6900 yield
= string_catn(yield
, outsep
, 1);
6903 if (saveend
== '\0') break;
6907 /* If we have generated anything, remove the redundant final
6910 if (yield
->ptr
!= save_ptr
) yield
->ptr
--;
6911 parse_allow_group
= FALSE
;
6916 /* quote puts a string in quotes if it is empty or contains anything
6917 other than alphamerics, underscore, dot, or hyphen.
6919 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6920 be quoted in order to be a valid local part.
6922 In both cases, newlines and carriage returns are converted into \n and \r
6926 case EOP_QUOTE_LOCAL_PART
:
6929 BOOL needs_quote
= (*sub
== 0); /* TRUE for empty string */
6930 uschar
*t
= sub
- 1;
6934 while (!needs_quote
&& *(++t
) != 0)
6935 needs_quote
= !isalnum(*t
) && !strchr("_-.", *t
);
6937 else /* EOP_QUOTE_LOCAL_PART */
6939 while (!needs_quote
&& *(++t
) != 0)
6940 needs_quote
= !isalnum(*t
) &&
6941 strchr("!#$%&'*+-/=?^_`{|}~", *t
) == NULL
&&
6942 (*t
!= '.' || t
== sub
|| t
[1] == 0);
6947 yield
= string_catn(yield
, US
"\"", 1);
6952 yield
= string_catn(yield
, US
"\\n", 2);
6953 else if (*t
== '\r')
6954 yield
= string_catn(yield
, US
"\\r", 2);
6957 if (*t
== '\\' || *t
== '"')
6958 yield
= string_catn(yield
, US
"\\", 1);
6959 yield
= string_catn(yield
, t
, 1);
6962 yield
= string_catn(yield
, US
"\"", 1);
6964 else yield
= string_cat(yield
, sub
);
6968 /* quote_lookuptype does lookup-specific quoting */
6973 uschar
*opt
= Ustrchr(arg
, '_');
6975 if (opt
!= NULL
) *opt
++ = 0;
6977 n
= search_findtype(arg
, Ustrlen(arg
));
6980 expand_string_message
= search_error_message
;
6984 if (lookup_list
[n
]->quote
!= NULL
)
6985 sub
= (lookup_list
[n
]->quote
)(sub
, opt
);
6986 else if (opt
!= NULL
) sub
= NULL
;
6990 expand_string_message
= string_sprintf(
6991 "\"%s\" unrecognized after \"${quote_%s\"",
6996 yield
= string_cat(yield
, sub
);
7000 /* rx quote sticks in \ before any non-alphameric character so that
7001 the insertion works in a regular expression. */
7005 uschar
*t
= sub
- 1;
7009 yield
= string_catn(yield
, US
"\\", 1);
7010 yield
= string_catn(yield
, t
, 1);
7015 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7016 prescribed by the RFC, if there are characters that need to be encoded */
7020 uschar buffer
[2048];
7021 const uschar
*string
= parse_quote_2047(sub
, Ustrlen(sub
), headers_charset
,
7022 buffer
, sizeof(buffer
), FALSE
);
7023 yield
= string_cat(yield
, string
);
7027 /* RFC 2047 decode */
7033 uschar
*decoded
= rfc2047_decode(sub
, check_rfc2047_length
,
7034 headers_charset
, '?', &len
, &error
);
7037 expand_string_message
= error
;
7040 yield
= string_catn(yield
, decoded
, len
);
7044 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7054 if (c
> 255) c
= '_';
7056 yield
= string_catn(yield
, buff
, 1);
7061 /* replace illegal UTF-8 sequences by replacement character */
7063 #define UTF8_REPLACEMENT_CHAR US"?"
7067 int seq_len
= 0, index
= 0;
7069 long codepoint
= -1;
7070 uschar seq_buff
[4]; /* accumulate utf-8 here */
7079 if ((c
& 0xc0) != 0x80)
7080 /* wrong continuation byte; invalidate all bytes */
7081 complete
= 1; /* error */
7084 codepoint
= (codepoint
<< 6) | (c
& 0x3f);
7085 seq_buff
[index
++] = c
;
7086 if (--bytes_left
== 0) /* codepoint complete */
7087 if(codepoint
> 0x10FFFF) /* is it too large? */
7088 complete
= -1; /* error (RFC3629 limit) */
7090 { /* finished; output utf-8 sequence */
7091 yield
= string_catn(yield
, seq_buff
, seq_len
);
7096 else /* no bytes left: new sequence */
7098 if((c
& 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
7100 yield
= string_catn(yield
, &c
, 1);
7103 if((c
& 0xe0) == 0xc0) /* 2-byte sequence */
7105 if(c
== 0xc0 || c
== 0xc1) /* 0xc0 and 0xc1 are illegal */
7110 codepoint
= c
& 0x1f;
7113 else if((c
& 0xf0) == 0xe0) /* 3-byte sequence */
7116 codepoint
= c
& 0x0f;
7118 else if((c
& 0xf8) == 0xf0) /* 4-byte sequence */
7121 codepoint
= c
& 0x07;
7123 else /* invalid or too long (RFC3629 allows only 4 bytes) */
7126 seq_buff
[index
++] = c
;
7127 seq_len
= bytes_left
+ 1;
7128 } /* if(bytes_left) */
7132 bytes_left
= index
= 0;
7133 yield
= string_catn(yield
, UTF8_REPLACEMENT_CHAR
, 1);
7135 if ((complete
== 1) && ((c
& 0x80) == 0))
7136 /* ASCII character follows incomplete sequence */
7137 yield
= string_catn(yield
, &c
, 1);
7143 case EOP_UTF8_DOMAIN_TO_ALABEL
:
7145 uschar
* error
= NULL
;
7146 uschar
* s
= string_domain_utf8_to_alabel(sub
, &error
);
7149 expand_string_message
= string_sprintf(
7150 "error converting utf8 (%s) to alabel: %s",
7151 string_printing(sub
), error
);
7154 yield
= string_cat(yield
, s
);
7158 case EOP_UTF8_DOMAIN_FROM_ALABEL
:
7160 uschar
* error
= NULL
;
7161 uschar
* s
= string_domain_alabel_to_utf8(sub
, &error
);
7164 expand_string_message
= string_sprintf(
7165 "error converting alabel (%s) to utf8: %s",
7166 string_printing(sub
), error
);
7169 yield
= string_cat(yield
, s
);
7173 case EOP_UTF8_LOCALPART_TO_ALABEL
:
7175 uschar
* error
= NULL
;
7176 uschar
* s
= string_localpart_utf8_to_alabel(sub
, &error
);
7179 expand_string_message
= string_sprintf(
7180 "error converting utf8 (%s) to alabel: %s",
7181 string_printing(sub
), error
);
7184 yield
= string_cat(yield
, s
);
7185 DEBUG(D_expand
) debug_printf_indent("yield: '%s'\n", yield
->s
);
7189 case EOP_UTF8_LOCALPART_FROM_ALABEL
:
7191 uschar
* error
= NULL
;
7192 uschar
* s
= string_localpart_alabel_to_utf8(sub
, &error
);
7195 expand_string_message
= string_sprintf(
7196 "error converting alabel (%s) to utf8: %s",
7197 string_printing(sub
), error
);
7200 yield
= string_cat(yield
, s
);
7203 #endif /* EXPERIMENTAL_INTERNATIONAL */
7205 /* escape turns all non-printing characters into escape sequences. */
7209 const uschar
* t
= string_printing(sub
);
7210 yield
= string_cat(yield
, t
);
7214 case EOP_ESCAPE8BIT
:
7216 const uschar
* s
= sub
;
7219 for (s
= sub
; (c
= *s
); s
++)
7220 yield
= c
< 127 && c
!= '\\'
7221 ? string_catn(yield
, s
, 1)
7222 : string_catn(yield
, string_sprintf("\\%03o", c
), 4);
7226 /* Handle numeric expression evaluation */
7231 uschar
*save_sub
= sub
;
7232 uschar
*error
= NULL
;
7233 int_eximarith_t n
= eval_expr(&sub
, (c
== EOP_EVAL10
), &error
, FALSE
);
7236 expand_string_message
= string_sprintf("error in expression "
7237 "evaluation: %s (after processing \"%.*s\")", error
,
7238 (int)(sub
-save_sub
), save_sub
);
7241 sprintf(CS var_buffer
, PR_EXIM_ARITH
, n
);
7242 yield
= string_cat(yield
, var_buffer
);
7246 /* Handle time period formating */
7250 int n
= readconf_readtime(sub
, 0, FALSE
);
7253 expand_string_message
= string_sprintf("string \"%s\" is not an "
7254 "Exim time interval in \"%s\" operator", sub
, name
);
7257 sprintf(CS var_buffer
, "%d", n
);
7258 yield
= string_cat(yield
, var_buffer
);
7262 case EOP_TIME_INTERVAL
:
7265 uschar
*t
= read_number(&n
, sub
);
7266 if (*t
!= 0) /* Not A Number*/
7268 expand_string_message
= string_sprintf("string \"%s\" is not a "
7269 "positive number in \"%s\" operator", sub
, name
);
7272 t
= readconf_printtime(n
);
7273 yield
= string_cat(yield
, t
);
7277 /* Convert string to base64 encoding */
7283 uschar
* s
= vp
&& *(void **)vp
->value
7284 ? tls_cert_der_b64(*(void **)vp
->value
)
7285 : b64encode(sub
, Ustrlen(sub
));
7287 uschar
* s
= b64encode(sub
, Ustrlen(sub
));
7289 yield
= string_cat(yield
, s
);
7296 int len
= b64decode(sub
, &s
);
7299 expand_string_message
= string_sprintf("string \"%s\" is not "
7300 "well-formed for \"%s\" operator", sub
, name
);
7303 yield
= string_cat(yield
, s
);
7307 /* strlen returns the length of the string */
7312 (void)sprintf(CS buff
, "%d", Ustrlen(sub
));
7313 yield
= string_cat(yield
, buff
);
7317 /* length_n or l_n takes just the first n characters or the whole string,
7318 whichever is the shorter;
7320 substr_m_n, and s_m_n take n characters from offset m; negative m take
7321 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
7322 takes the rest, either to the right or to the left.
7324 hash_n or h_n makes a hash of length n from the string, yielding n
7325 characters from the set a-z; hash_n_m makes a hash of length n, but
7326 uses m characters from the set a-zA-Z0-9.
7328 nhash_n returns a single number between 0 and n-1 (in text form), while
7329 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
7330 between 0 and n-1 and the second between 0 and m-1. */
7350 expand_string_message
= string_sprintf("missing values after %s",
7355 /* "length" has only one argument, effectively being synonymous with
7358 if (c
== EOP_LENGTH
|| c
== EOP_L
)
7364 /* The others have one or two arguments; for "substr" the first may be
7365 negative. The second being negative means "not supplied". */
7370 if (name
[0] == 's' && *arg
== '-') { sign
= -1; arg
++; }
7373 /* Read up to two numbers, separated by underscores */
7378 if (arg
!= ret
&& *arg
== '_' && pn
== &value1
)
7382 if (arg
[1] != 0) arg
++;
7384 else if (!isdigit(*arg
))
7386 expand_string_message
=
7387 string_sprintf("non-digit after underscore in \"%s\"", name
);
7390 else *pn
= (*pn
)*10 + *arg
++ - '0';
7394 /* Perform the required operation */
7397 (c
== EOP_HASH
|| c
== EOP_H
)?
7398 compute_hash(sub
, value1
, value2
, &len
) :
7399 (c
== EOP_NHASH
|| c
== EOP_NH
)?
7400 compute_nhash(sub
, value1
, value2
, &len
) :
7401 extract_substr(sub
, value1
, value2
, &len
);
7403 if (ret
== NULL
) goto EXPAND_FAILED
;
7404 yield
= string_catn(yield
, ret
, len
);
7414 uschar
**modetable
[3];
7419 if ((expand_forbid
& RDO_EXISTS
) != 0)
7421 expand_string_message
= US
"Use of the stat() expansion is not permitted";
7425 if (stat(CS sub
, &st
) < 0)
7427 expand_string_message
= string_sprintf("stat(%s) failed: %s",
7428 sub
, strerror(errno
));
7432 switch (mode
& S_IFMT
)
7434 case S_IFIFO
: smode
[0] = 'p'; break;
7435 case S_IFCHR
: smode
[0] = 'c'; break;
7436 case S_IFDIR
: smode
[0] = 'd'; break;
7437 case S_IFBLK
: smode
[0] = 'b'; break;
7438 case S_IFREG
: smode
[0] = '-'; break;
7439 default: smode
[0] = '?'; break;
7442 modetable
[0] = ((mode
& 01000) == 0)? mtable_normal
: mtable_sticky
;
7443 modetable
[1] = ((mode
& 02000) == 0)? mtable_normal
: mtable_setid
;
7444 modetable
[2] = ((mode
& 04000) == 0)? mtable_normal
: mtable_setid
;
7446 for (i
= 0; i
< 3; i
++)
7448 memcpy(CS(smode
+ 7 - i
*3), CS(modetable
[i
][mode
& 7]), 3);
7453 s
= string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7454 "uid=%ld gid=%ld size=" OFF_T_FMT
" atime=%ld mtime=%ld ctime=%ld",
7455 (long)(st
.st_mode
& 077777), smode
, (long)st
.st_ino
,
7456 (long)st
.st_dev
, (long)st
.st_nlink
, (long)st
.st_uid
,
7457 (long)st
.st_gid
, st
.st_size
, (long)st
.st_atime
,
7458 (long)st
.st_mtime
, (long)st
.st_ctime
);
7459 yield
= string_cat(yield
, s
);
7463 /* vaguely random number less than N */
7467 int_eximarith_t max
;
7470 max
= expanded_string_integer(sub
, TRUE
);
7471 if (expand_string_message
!= NULL
)
7473 s
= string_sprintf("%d", vaguely_random_number((int)max
));
7474 yield
= string_cat(yield
, s
);
7478 /* Reverse IP, including IPv6 to dotted-nibble */
7480 case EOP_REVERSE_IP
:
7482 int family
, maskptr
;
7483 uschar reversed
[128];
7485 family
= string_is_ip_address(sub
, &maskptr
);
7488 expand_string_message
= string_sprintf(
7489 "reverse_ip() not given an IP address [%s]", sub
);
7492 invert_address(reversed
, sub
);
7493 yield
= string_cat(yield
, reversed
);
7497 /* Unknown operator */
7500 expand_string_message
=
7501 string_sprintf("unknown expansion operator \"%s\"", name
);
7506 /* Handle a plain name. If this is the first thing in the expansion, release
7507 the pre-allocated buffer. If the result data is known to be in a new buffer,
7508 newsize will be set to the size of that buffer, and we can just point at that
7509 store instead of copying. Many expansion strings contain just one reference,
7510 so this is a useful optimization, especially for humungous headers
7511 ($message_headers). */
7520 g
= store_get(sizeof(gstring
));
7521 else if (yield
->ptr
== 0)
7523 if (resetok
) store_reset(yield
);
7525 g
= store_get(sizeof(gstring
)); /* alloc _before_ calling find_variable() */
7527 if (!(value
= find_variable(name
, FALSE
, skipping
, &newsize
)))
7529 expand_string_message
=
7530 string_sprintf("unknown variable in \"${%s}\"", name
);
7531 check_variable_error_message(name
);
7534 len
= Ustrlen(value
);
7535 if (!yield
&& newsize
)
7538 yield
->size
= newsize
;
7543 yield
= string_catn(yield
, value
, len
);
7547 /* Else there's something wrong */
7549 expand_string_message
=
7550 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7551 "in a variable reference)", name
);
7555 /* If we hit the end of the string when ket_ends is set, there is a missing
7556 terminating brace. */
7558 if (ket_ends
&& *s
== 0)
7560 expand_string_message
= malformed_header
7561 ? US
"missing } at end of string - could be header name not terminated by colon"
7562 : US
"missing } at end of string";
7566 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7567 added to the string. If so, set up an empty string. Add a terminating zero. If
7568 left != NULL, return a pointer to the terminator. */
7571 yield
= string_get(1);
7572 (void) string_from_gstring(yield
);
7573 if (left
) *left
= s
;
7575 /* Any stacking store that was used above the final string is no longer needed.
7576 In many cases the final string will be the first one that was got and so there
7577 will be optimal store usage. */
7579 if (resetok
) store_reset(yield
->s
+ (yield
->size
= yield
->ptr
+ 1));
7580 else if (resetok_p
) *resetok_p
= FALSE
;
7584 debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
7585 "expanding: %.*s\n",
7586 (int)(s
- string
), string
);
7587 debug_printf_indent("%s"
7588 UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7590 skipping
? UTF8_VERT_RIGHT
: UTF8_UP_RIGHT
,
7593 debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7594 "skipping: result is not used\n");
7599 /* This is the failure exit: easiest to program with a goto. We still need
7600 to update the pointer to the terminator, for cases of nested calls with "fail".
7603 EXPAND_FAILED_CURLY
:
7604 if (malformed_header
)
7605 expand_string_message
=
7606 US
"missing or misplaced { or } - could be header name not terminated by colon";
7608 else if (!expand_string_message
|| !*expand_string_message
)
7609 expand_string_message
= US
"missing or misplaced { or }";
7611 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7612 that is a bad idea, because expand_string_message is in dynamic store. */
7615 if (left
) *left
= s
;
7618 debug_printf_indent(UTF8_VERT_RIGHT
"failed to expand: %s\n",
7620 debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
7621 "error message: %s\n",
7622 expand_string_forcedfail
? UTF8_VERT_RIGHT
: UTF8_UP_RIGHT
,
7623 expand_string_message
);
7624 if (expand_string_forcedfail
)
7625 debug_printf_indent(UTF8_UP_RIGHT
"failure was forced\n");
7627 if (resetok_p
&& !resetok
) *resetok_p
= FALSE
;
7633 /* This is the external function call. Do a quick check for any expansion
7634 metacharacters, and if there are none, just return the input string.
7636 Argument: the string to be expanded
7637 Returns: the expanded string, or NULL if expansion failed; if failure was
7638 due to a lookup deferring, search_find_defer will be TRUE
7642 expand_cstring(const uschar
* string
)
7644 if (Ustrpbrk(string
, "$\\") != NULL
)
7646 int old_pool
= store_pool
;
7649 search_find_defer
= FALSE
;
7650 malformed_header
= FALSE
;
7651 store_pool
= POOL_MAIN
;
7652 s
= expand_string_internal(string
, FALSE
, NULL
, FALSE
, TRUE
, NULL
);
7653 store_pool
= old_pool
;
7661 expand_string(uschar
* string
)
7663 return US
expand_cstring(CUS string
);
7670 /*************************************************
7672 *************************************************/
7674 /* Now and again we want to expand a string and be sure that the result is in a
7675 new bit of store. This function does that.
7676 Since we know it has been copied, the de-const cast is safe.
7678 Argument: the string to be expanded
7679 Returns: the expanded string, always in a new bit of store, or NULL
7683 expand_string_copy(const uschar
*string
)
7685 const uschar
*yield
= expand_cstring(string
);
7686 if (yield
== string
) yield
= string_copy(string
);
7692 /*************************************************
7693 * Expand and interpret as an integer *
7694 *************************************************/
7696 /* Expand a string, and convert the result into an integer.
7699 string the string to be expanded
7700 isplus TRUE if a non-negative number is expected
7702 Returns: the integer value, or
7703 -1 for an expansion error ) in both cases, message in
7704 -2 for an integer interpretation error ) expand_string_message
7705 expand_string_message is set NULL for an OK integer
7709 expand_string_integer(uschar
*string
, BOOL isplus
)
7711 return expanded_string_integer(expand_string(string
), isplus
);
7715 /*************************************************
7716 * Interpret string as an integer *
7717 *************************************************/
7719 /* Convert a string (that has already been expanded) into an integer.
7721 This function is used inside the expansion code.
7724 s the string to be expanded
7725 isplus TRUE if a non-negative number is expected
7727 Returns: the integer value, or
7728 -1 if string is NULL (which implies an expansion error)
7729 -2 for an integer interpretation error
7730 expand_string_message is set NULL for an OK integer
7733 static int_eximarith_t
7734 expanded_string_integer(const uschar
*s
, BOOL isplus
)
7736 int_eximarith_t value
;
7737 uschar
*msg
= US
"invalid integer \"%s\"";
7740 /* If expansion failed, expand_string_message will be set. */
7742 if (s
== NULL
) return -1;
7744 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7745 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7746 systems, so we set it zero ourselves. */
7749 expand_string_message
= NULL
; /* Indicates no error */
7751 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7752 equal to 0. Unfortunately, people actually relied upon that, so preserve
7753 the behaviour explicitly. Stripping leading whitespace is a harmless
7754 noop change since strtol skips it anyway (provided that there is a number
7758 while (isspace(*s
)) ++s
;
7762 debug_printf_indent("treating blank string as number 0\n");
7767 value
= strtoll(CS s
, CSS
&endptr
, 10);
7771 msg
= US
"integer expected but \"%s\" found";
7773 else if (value
< 0 && isplus
)
7775 msg
= US
"non-negative integer expected but \"%s\" found";
7779 switch (tolower(*endptr
))
7784 if (value
> EXIM_ARITH_MAX
/1024 || value
< EXIM_ARITH_MIN
/1024) errno
= ERANGE
;
7789 if (value
> EXIM_ARITH_MAX
/(1024*1024) || value
< EXIM_ARITH_MIN
/(1024*1024)) errno
= ERANGE
;
7790 else value
*= 1024*1024;
7794 if (value
> EXIM_ARITH_MAX
/(1024*1024*1024) || value
< EXIM_ARITH_MIN
/(1024*1024*1024)) errno
= ERANGE
;
7795 else value
*= 1024*1024*1024;
7799 if (errno
== ERANGE
)
7800 msg
= US
"absolute value of integer \"%s\" is too large (overflow)";
7803 while (isspace(*endptr
)) endptr
++;
7804 if (*endptr
== 0) return value
;
7808 expand_string_message
= string_sprintf(CS msg
, s
);
7813 /* These values are usually fixed boolean values, but they are permitted to be
7817 addr address being routed
7818 mtype the module type
7819 mname the module name
7820 dbg_opt debug selectors
7821 oname the option name
7822 bvalue the router's boolean value
7823 svalue the router's string value
7824 rvalue where to put the returned value
7826 Returns: OK value placed in rvalue
7827 DEFER expansion failed
7831 exp_bool(address_item
*addr
,
7832 uschar
*mtype
, uschar
*mname
, unsigned dbg_opt
,
7833 uschar
*oname
, BOOL bvalue
,
7834 uschar
*svalue
, BOOL
*rvalue
)
7837 if (svalue
== NULL
) { *rvalue
= bvalue
; return OK
; }
7839 expanded
= expand_string(svalue
);
7840 if (expanded
== NULL
)
7842 if (expand_string_forcedfail
)
7844 DEBUG(dbg_opt
) debug_printf("expansion of \"%s\" forced failure\n", oname
);
7848 addr
->message
= string_sprintf("failed to expand \"%s\" in %s %s: %s",
7849 oname
, mname
, mtype
, expand_string_message
);
7850 DEBUG(dbg_opt
) debug_printf("%s\n", addr
->message
);
7854 DEBUG(dbg_opt
) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname
,
7857 if (strcmpic(expanded
, US
"true") == 0 || strcmpic(expanded
, US
"yes") == 0)
7859 else if (strcmpic(expanded
, US
"false") == 0 || strcmpic(expanded
, US
"no") == 0)
7863 addr
->message
= string_sprintf("\"%s\" is not a valid value for the "
7864 "\"%s\" option in the %s %s", expanded
, oname
, mname
, mtype
);
7873 /* Avoid potentially exposing a password in a string about to be logged */
7876 expand_hide_passwords(uschar
* s
)
7878 return ( ( Ustrstr(s
, "failed to expand") != NULL
7879 || Ustrstr(s
, "expansion of ") != NULL
7881 && ( Ustrstr(s
, "mysql") != NULL
7882 || Ustrstr(s
, "pgsql") != NULL
7883 || Ustrstr(s
, "redis") != NULL
7884 || Ustrstr(s
, "sqlite") != NULL
7885 || Ustrstr(s
, "ldap:") != NULL
7886 || Ustrstr(s
, "ldaps:") != NULL
7887 || Ustrstr(s
, "ldapi:") != NULL
7888 || Ustrstr(s
, "ldapdn:") != NULL
7889 || Ustrstr(s
, "ldapm:") != NULL
7891 ? US
"Temporary internal error" : s
;
7895 /* Read given named file into big_buffer. Use for keying material etc.
7896 The content will have an ascii NUL appended.
7901 Return: pointer to buffer, or NULL on error.
7905 expand_file_big_buffer(const uschar
* filename
)
7907 int fd
, off
= 0, len
;
7909 if ((fd
= open(CS filename
, O_RDONLY
)) < 0)
7911 log_write(0, LOG_MAIN
| LOG_PANIC
, "unable to open file for reading: %s",
7918 if ((len
= read(fd
, big_buffer
+ off
, big_buffer_size
- 2 - off
)) < 0)
7921 log_write(0, LOG_MAIN
|LOG_PANIC
, "unable to read file: %s", filename
);
7929 big_buffer
[off
] = '\0';
7935 /*************************************************
7936 * Error-checking for testsuite *
7937 *************************************************/
7939 uschar
* region_start
;
7940 uschar
* region_end
;
7941 const uschar
*var_name
;
7942 const uschar
*var_data
;
7946 assert_variable_notin(uschar
* var_name
, uschar
* var_data
, void * ctx
)
7949 if (var_data
>= e
->region_start
&& var_data
< e
->region_end
)
7951 e
->var_name
= CUS var_name
;
7952 e
->var_data
= CUS var_data
;
7957 assert_no_variables(void * ptr
, int len
, const char * filename
, int linenumber
)
7959 err_ctx e
= { .region_start
= ptr
, .region_end
= US ptr
+ len
,
7960 .var_name
= NULL
, .var_data
= NULL
};
7964 /* check acl_ variables */
7965 tree_walk(acl_var_c
, assert_variable_notin
, &e
);
7966 tree_walk(acl_var_m
, assert_variable_notin
, &e
);
7968 /* check auth<n> variables */
7969 for (i
= 0; i
< AUTH_VARS
; i
++) if (auth_vars
[i
])
7970 assert_variable_notin(US
"auth<n>", auth_vars
[i
], &e
);
7972 /* check regex<n> variables */
7973 for (i
= 0; i
< REGEX_VARS
; i
++) if (regex_vars
[i
])
7974 assert_variable_notin(US
"regex<n>", regex_vars
[i
], &e
);
7976 /* check known-name variables */
7977 for (v
= var_table
; v
< var_table
+ var_table_size
; v
++)
7978 if (v
->type
== vtype_stringptr
)
7979 assert_variable_notin(US v
->name
, *(USS v
->value
), &e
);
7981 /* check dns and address trees */
7982 tree_walk(tree_dns_fails
, assert_variable_notin
, &e
);
7983 tree_walk(tree_duplicates
, assert_variable_notin
, &e
);
7984 tree_walk(tree_nonrecipients
, assert_variable_notin
, &e
);
7985 tree_walk(tree_unusable
, assert_variable_notin
, &e
);
7988 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
,
7989 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
7990 e
.var_name
, filename
, linenumber
, e
.var_data
);
7995 /*************************************************
7996 **************************************************
7997 * Stand-alone test program *
7998 **************************************************
7999 *************************************************/
8005 regex_match_and_setup(const pcre
*re
, uschar
*subject
, int options
, int setup
)
8007 int ovector
[3*(EXPAND_MAXN
+1)];
8008 int n
= pcre_exec(re
, NULL
, subject
, Ustrlen(subject
), 0, PCRE_EOPT
|options
,
8009 ovector
, nelem(ovector
));
8010 BOOL yield
= n
>= 0;
8011 if (n
== 0) n
= EXPAND_MAXN
+ 1;
8015 expand_nmax
= (setup
< 0)? 0 : setup
+ 1;
8016 for (nn
= (setup
< 0)? 0 : 2; nn
< n
*2; nn
+= 2)
8018 expand_nstring
[expand_nmax
] = subject
+ ovector
[nn
];
8019 expand_nlength
[expand_nmax
++] = ovector
[nn
+1] - ovector
[nn
];
8027 int main(int argc
, uschar
**argv
)
8030 uschar buffer
[1024];
8032 debug_selector
= D_v
;
8033 debug_file
= stderr
;
8034 debug_fd
= fileno(debug_file
);
8035 big_buffer
= malloc(big_buffer_size
);
8037 for (i
= 1; i
< argc
; i
++)
8039 if (argv
[i
][0] == '+')
8041 debug_trace_memory
= 2;
8044 if (isdigit(argv
[i
][0]))
8045 debug_selector
= Ustrtol(argv
[i
], NULL
, 0);
8047 if (Ustrspn(argv
[i
], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8051 eldap_default_servers
= argv
[i
];
8054 mysql_servers
= argv
[i
];
8057 pgsql_servers
= argv
[i
];
8060 redis_servers
= argv
[i
];
8064 else opt_perl_startup
= argv
[i
];
8068 printf("Testing string expansion: debug_level = %d\n\n", debug_level
);
8070 expand_nstring
[1] = US
"string 1....";
8071 expand_nlength
[1] = 8;
8075 if (opt_perl_startup
!= NULL
)
8078 printf("Starting Perl interpreter\n");
8079 errstr
= init_perl(opt_perl_startup
);
8082 printf("** error in perl_startup code: %s\n", errstr
);
8083 return EXIT_FAILURE
;
8086 #endif /* EXIM_PERL */
8088 while (fgets(buffer
, sizeof(buffer
), stdin
) != NULL
)
8090 void *reset_point
= store_get(0);
8091 uschar
*yield
= expand_string(buffer
);
8094 printf("%s\n", yield
);
8095 store_reset(reset_point
);
8099 if (search_find_defer
) printf("search_find deferred\n");
8100 printf("Failed: %s\n", expand_string_message
);
8101 if (expand_string_forcedfail
) printf("Forced failure\n");
8115 /* End of expand.c */