1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar
*expand_string_internal(const uschar
*, BOOL
, const uschar
**, BOOL
, BOOL
, BOOL
*);
17 static int_eximarith_t
expanded_string_integer(const uschar
*, BOOL
);
20 #ifndef SUPPORT_CRYPTEQ
21 #define SUPPORT_CRYPTEQ
26 #include "lookups/ldap.h"
29 #ifdef SUPPORT_CRYPTEQ
34 extern char* crypt16(char*, char*);
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. Charaters after the first 16 are ignored. It always generates
50 a 16-byte hash, which is expressed together with the salt as a string
51 of 24 base 64 digits. Here are some links to peruse:
53 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
54 http://seclists.org/bugtraq/1999/Mar/0076.html
56 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
57 and OSF/1. This is the same as the standard crypt if given a password
58 of 8 characters or less. If given more, it first does the same as crypt
59 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
60 using as salt the first two base 64 digits from the first hash block.
61 If the password is more than 16 characters then it crypts the 17th to 24th
62 characters using as salt the first two base 64 digits from the second hash
63 block. And so on: I've seen references to it cutting off the password at
64 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
66 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
67 http://seclists.org/bugtraq/1999/Mar/0109.html
68 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
69 TET1_html/sec.c222.html#no_id_208
71 Exim has something it calls "crypt16". It will either use a native
72 crypt16 or its own implementation. A native crypt16 will presumably
73 be the one that I called "crypt16" above. The internal "crypt16"
74 function, however, is a two-block-maximum implementation of what I called
75 "bigcrypt". The documentation matches the internal code.
77 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
78 that crypt16 and bigcrypt were different things.
80 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
81 to whatever it is using under that name. This unfortunately sets a
82 precedent for using "{crypt16}" to identify two incompatible algorithms
83 whose output can't be distinguished. With "{crypt16}" thus rendered
84 ambiguous, I suggest you deprecate it and invent two new identifiers
85 for the two algorithms.
87 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
88 of the password separately means they can be cracked separately, so
89 the double-length hash only doubles the cracking effort instead of
90 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar
*item_table
[] = {
114 #ifdef EXPERIMENTAL_INTERNATIONAL
144 #ifdef EXPERIMENTAL_INTERNATIONAL
164 /* Tables of operator names, and corresponding switch numbers. The names must be
165 in alphabetical order. There are two tables, because underscore is used in some
166 cases to introduce arguments, whereas for other it is part of the name. This is
167 an historical mis-design. */
169 static uschar
*op_table_underscore
[] = {
172 US
"quote_local_part",
176 #ifdef EXPERIMENTAL_INTERNATIONAL
177 ,US
"utf8_domain_from_alabel",
178 US
"utf8_domain_to_alabel",
179 US
"utf8_localpart_from_alabel",
180 US
"utf8_localpart_to_alabel"
187 EOP_QUOTE_LOCAL_PART
,
191 #ifdef EXPERIMENTAL_INTERNATIONAL
192 ,EOP_UTF8_DOMAIN_FROM_ALABEL
,
193 EOP_UTF8_DOMAIN_TO_ALABEL
,
194 EOP_UTF8_LOCALPART_FROM_ALABEL
,
195 EOP_UTF8_LOCALPART_TO_ALABEL
199 static uschar
*op_table_main
[] = {
238 EOP_ADDRESS
= nelem(op_table_underscore
),
276 /* Table of condition names, and corresponding switch numbers. The names must
277 be in alphabetical order. */
279 static uschar
*cond_table
[] = {
283 US
"==", /* Backward compatibility */
316 US
"match_local_part",
341 ECOND_FIRST_DELIVERY
,
362 ECOND_MATCH_LOCAL_PART
,
372 /* Types of table entry */
375 vtype_int
, /* value is address of int */
376 vtype_filter_int
, /* ditto, but recognized only when filtering */
377 vtype_ino
, /* value is address of ino_t (not always an int) */
378 vtype_uid
, /* value is address of uid_t (not always an int) */
379 vtype_gid
, /* value is address of gid_t (not always an int) */
380 vtype_bool
, /* value is address of bool */
381 vtype_stringptr
, /* value is address of pointer to string */
382 vtype_msgbody
, /* as stringptr, but read when first required */
383 vtype_msgbody_end
, /* ditto, the end of the message */
384 vtype_msgheaders
, /* the message's headers, processed */
385 vtype_msgheaders_raw
, /* the message's headers, unprocessed */
386 vtype_localpart
, /* extract local part from string */
387 vtype_domain
, /* extract domain from string */
388 vtype_string_func
, /* value is string returned by given function */
389 vtype_todbsdin
, /* value not used; generate BSD inbox tod */
390 vtype_tode
, /* value not used; generate tod in epoch format */
391 vtype_todel
, /* value not used; generate tod in epoch/usec format */
392 vtype_todf
, /* value not used; generate full tod */
393 vtype_todl
, /* value not used; generate log tod */
394 vtype_todlf
, /* value not used; generate log file datestamp tod */
395 vtype_todzone
, /* value not used; generate time zone only */
396 vtype_todzulu
, /* value not used; generate zulu tod */
397 vtype_reply
, /* value not used; get reply from headers */
398 vtype_pid
, /* value not used; result is pid */
399 vtype_host_lookup
, /* value not used; get host name */
400 vtype_load_avg
, /* value not used; result is int from os_getloadavg */
401 vtype_pspace
, /* partition space; value is T/F for spool/log */
402 vtype_pinodes
, /* partition inodes; value is T/F for spool/log */
403 vtype_cert
/* SSL certificate */
405 ,vtype_dkim
/* Lookup of value in DKIM signature */
409 /* Type for main variable table */
417 /* Type for entries pointing to address/length pairs. Not currently
425 static uschar
* fn_recipients(void);
427 /* This table must be kept in alphabetical order. */
429 static var_entry var_table
[] = {
430 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
431 they will be confused with user-creatable ACL variables. */
432 { "acl_arg1", vtype_stringptr
, &acl_arg
[0] },
433 { "acl_arg2", vtype_stringptr
, &acl_arg
[1] },
434 { "acl_arg3", vtype_stringptr
, &acl_arg
[2] },
435 { "acl_arg4", vtype_stringptr
, &acl_arg
[3] },
436 { "acl_arg5", vtype_stringptr
, &acl_arg
[4] },
437 { "acl_arg6", vtype_stringptr
, &acl_arg
[5] },
438 { "acl_arg7", vtype_stringptr
, &acl_arg
[6] },
439 { "acl_arg8", vtype_stringptr
, &acl_arg
[7] },
440 { "acl_arg9", vtype_stringptr
, &acl_arg
[8] },
441 { "acl_narg", vtype_int
, &acl_narg
},
442 { "acl_verify_message", vtype_stringptr
, &acl_verify_message
},
443 { "address_data", vtype_stringptr
, &deliver_address_data
},
444 { "address_file", vtype_stringptr
, &address_file
},
445 { "address_pipe", vtype_stringptr
, &address_pipe
},
446 { "authenticated_fail_id",vtype_stringptr
, &authenticated_fail_id
},
447 { "authenticated_id", vtype_stringptr
, &authenticated_id
},
448 { "authenticated_sender",vtype_stringptr
, &authenticated_sender
},
449 { "authentication_failed",vtype_int
, &authentication_failed
},
450 #ifdef WITH_CONTENT_SCAN
451 { "av_failed", vtype_int
, &av_failed
},
453 #ifdef EXPERIMENTAL_BRIGHTMAIL
454 { "bmi_alt_location", vtype_stringptr
, &bmi_alt_location
},
455 { "bmi_base64_tracker_verdict", vtype_stringptr
, &bmi_base64_tracker_verdict
},
456 { "bmi_base64_verdict", vtype_stringptr
, &bmi_base64_verdict
},
457 { "bmi_deliver", vtype_int
, &bmi_deliver
},
459 { "body_linecount", vtype_int
, &body_linecount
},
460 { "body_zerocount", vtype_int
, &body_zerocount
},
461 { "bounce_recipient", vtype_stringptr
, &bounce_recipient
},
462 { "bounce_return_size_limit", vtype_int
, &bounce_return_size_limit
},
463 { "caller_gid", vtype_gid
, &real_gid
},
464 { "caller_uid", vtype_uid
, &real_uid
},
465 { "callout_address", vtype_stringptr
, &callout_address
},
466 { "compile_date", vtype_stringptr
, &version_date
},
467 { "compile_number", vtype_stringptr
, &version_cnumber
},
468 { "config_dir", vtype_stringptr
, &config_main_directory
},
469 { "config_file", vtype_stringptr
, &config_main_filename
},
470 { "csa_status", vtype_stringptr
, &csa_status
},
471 #ifdef EXPERIMENTAL_DCC
472 { "dcc_header", vtype_stringptr
, &dcc_header
},
473 { "dcc_result", vtype_stringptr
, &dcc_result
},
475 #ifdef WITH_OLD_DEMIME
476 { "demime_errorlevel", vtype_int
, &demime_errorlevel
},
477 { "demime_reason", vtype_stringptr
, &demime_reason
},
480 { "dkim_algo", vtype_dkim
, (void *)DKIM_ALGO
},
481 { "dkim_bodylength", vtype_dkim
, (void *)DKIM_BODYLENGTH
},
482 { "dkim_canon_body", vtype_dkim
, (void *)DKIM_CANON_BODY
},
483 { "dkim_canon_headers", vtype_dkim
, (void *)DKIM_CANON_HEADERS
},
484 { "dkim_copiedheaders", vtype_dkim
, (void *)DKIM_COPIEDHEADERS
},
485 { "dkim_created", vtype_dkim
, (void *)DKIM_CREATED
},
486 { "dkim_cur_signer", vtype_stringptr
, &dkim_cur_signer
},
487 { "dkim_domain", vtype_stringptr
, &dkim_signing_domain
},
488 { "dkim_expires", vtype_dkim
, (void *)DKIM_EXPIRES
},
489 { "dkim_headernames", vtype_dkim
, (void *)DKIM_HEADERNAMES
},
490 { "dkim_identity", vtype_dkim
, (void *)DKIM_IDENTITY
},
491 { "dkim_key_granularity",vtype_dkim
, (void *)DKIM_KEY_GRANULARITY
},
492 { "dkim_key_nosubdomains",vtype_dkim
, (void *)DKIM_NOSUBDOMAINS
},
493 { "dkim_key_notes", vtype_dkim
, (void *)DKIM_KEY_NOTES
},
494 { "dkim_key_srvtype", vtype_dkim
, (void *)DKIM_KEY_SRVTYPE
},
495 { "dkim_key_testing", vtype_dkim
, (void *)DKIM_KEY_TESTING
},
496 { "dkim_selector", vtype_stringptr
, &dkim_signing_selector
},
497 { "dkim_signers", vtype_stringptr
, &dkim_signers
},
498 { "dkim_verify_reason", vtype_dkim
, (void *)DKIM_VERIFY_REASON
},
499 { "dkim_verify_status", vtype_dkim
, (void *)DKIM_VERIFY_STATUS
},
501 #ifdef EXPERIMENTAL_DMARC
502 { "dmarc_ar_header", vtype_stringptr
, &dmarc_ar_header
},
503 { "dmarc_domain_policy", vtype_stringptr
, &dmarc_domain_policy
},
504 { "dmarc_status", vtype_stringptr
, &dmarc_status
},
505 { "dmarc_status_text", vtype_stringptr
, &dmarc_status_text
},
506 { "dmarc_used_domain", vtype_stringptr
, &dmarc_used_domain
},
508 { "dnslist_domain", vtype_stringptr
, &dnslist_domain
},
509 { "dnslist_matched", vtype_stringptr
, &dnslist_matched
},
510 { "dnslist_text", vtype_stringptr
, &dnslist_text
},
511 { "dnslist_value", vtype_stringptr
, &dnslist_value
},
512 { "domain", vtype_stringptr
, &deliver_domain
},
513 { "domain_data", vtype_stringptr
, &deliver_domain_data
},
514 #ifdef EXPERIMENTAL_EVENT
515 { "event_data", vtype_stringptr
, &event_data
},
517 /*XXX want to use generic vars for as many of these as possible*/
518 { "event_defer_errno", vtype_int
, &event_defer_errno
},
520 { "event_name", vtype_stringptr
, &event_name
},
522 { "exim_gid", vtype_gid
, &exim_gid
},
523 { "exim_path", vtype_stringptr
, &exim_path
},
524 { "exim_uid", vtype_uid
, &exim_uid
},
525 { "exim_version", vtype_stringptr
, &version_string
},
526 #ifdef WITH_OLD_DEMIME
527 { "found_extension", vtype_stringptr
, &found_extension
},
529 { "headers_added", vtype_string_func
, &fn_hdrs_added
},
530 { "home", vtype_stringptr
, &deliver_home
},
531 { "host", vtype_stringptr
, &deliver_host
},
532 { "host_address", vtype_stringptr
, &deliver_host_address
},
533 { "host_data", vtype_stringptr
, &host_data
},
534 { "host_lookup_deferred",vtype_int
, &host_lookup_deferred
},
535 { "host_lookup_failed", vtype_int
, &host_lookup_failed
},
536 { "host_port", vtype_int
, &deliver_host_port
},
537 { "inode", vtype_ino
, &deliver_inode
},
538 { "interface_address", vtype_stringptr
, &interface_address
},
539 { "interface_port", vtype_int
, &interface_port
},
540 { "item", vtype_stringptr
, &iterate_item
},
542 { "ldap_dn", vtype_stringptr
, &eldap_dn
},
544 { "load_average", vtype_load_avg
, NULL
},
545 { "local_part", vtype_stringptr
, &deliver_localpart
},
546 { "local_part_data", vtype_stringptr
, &deliver_localpart_data
},
547 { "local_part_prefix", vtype_stringptr
, &deliver_localpart_prefix
},
548 { "local_part_suffix", vtype_stringptr
, &deliver_localpart_suffix
},
549 { "local_scan_data", vtype_stringptr
, &local_scan_data
},
550 { "local_user_gid", vtype_gid
, &local_user_gid
},
551 { "local_user_uid", vtype_uid
, &local_user_uid
},
552 { "localhost_number", vtype_int
, &host_number
},
553 { "log_inodes", vtype_pinodes
, (void *)FALSE
},
554 { "log_space", vtype_pspace
, (void *)FALSE
},
555 { "lookup_dnssec_authenticated",vtype_stringptr
,&lookup_dnssec_authenticated
},
556 { "mailstore_basename", vtype_stringptr
, &mailstore_basename
},
557 #ifdef WITH_CONTENT_SCAN
558 { "malware_name", vtype_stringptr
, &malware_name
},
560 { "max_received_linelength", vtype_int
, &max_received_linelength
},
561 { "message_age", vtype_int
, &message_age
},
562 { "message_body", vtype_msgbody
, &message_body
},
563 { "message_body_end", vtype_msgbody_end
, &message_body_end
},
564 { "message_body_size", vtype_int
, &message_body_size
},
565 { "message_exim_id", vtype_stringptr
, &message_id
},
566 { "message_headers", vtype_msgheaders
, NULL
},
567 { "message_headers_raw", vtype_msgheaders_raw
, NULL
},
568 { "message_id", vtype_stringptr
, &message_id
},
569 { "message_linecount", vtype_int
, &message_linecount
},
570 { "message_size", vtype_int
, &message_size
},
571 #ifdef EXPERIMENTAL_INTERNATIONAL
572 { "message_smtputf8", vtype_bool
, &message_smtputf8
},
574 #ifdef WITH_CONTENT_SCAN
575 { "mime_anomaly_level", vtype_int
, &mime_anomaly_level
},
576 { "mime_anomaly_text", vtype_stringptr
, &mime_anomaly_text
},
577 { "mime_boundary", vtype_stringptr
, &mime_boundary
},
578 { "mime_charset", vtype_stringptr
, &mime_charset
},
579 { "mime_content_description", vtype_stringptr
, &mime_content_description
},
580 { "mime_content_disposition", vtype_stringptr
, &mime_content_disposition
},
581 { "mime_content_id", vtype_stringptr
, &mime_content_id
},
582 { "mime_content_size", vtype_int
, &mime_content_size
},
583 { "mime_content_transfer_encoding",vtype_stringptr
, &mime_content_transfer_encoding
},
584 { "mime_content_type", vtype_stringptr
, &mime_content_type
},
585 { "mime_decoded_filename", vtype_stringptr
, &mime_decoded_filename
},
586 { "mime_filename", vtype_stringptr
, &mime_filename
},
587 { "mime_is_coverletter", vtype_int
, &mime_is_coverletter
},
588 { "mime_is_multipart", vtype_int
, &mime_is_multipart
},
589 { "mime_is_rfc822", vtype_int
, &mime_is_rfc822
},
590 { "mime_part_count", vtype_int
, &mime_part_count
},
592 { "n0", vtype_filter_int
, &filter_n
[0] },
593 { "n1", vtype_filter_int
, &filter_n
[1] },
594 { "n2", vtype_filter_int
, &filter_n
[2] },
595 { "n3", vtype_filter_int
, &filter_n
[3] },
596 { "n4", vtype_filter_int
, &filter_n
[4] },
597 { "n5", vtype_filter_int
, &filter_n
[5] },
598 { "n6", vtype_filter_int
, &filter_n
[6] },
599 { "n7", vtype_filter_int
, &filter_n
[7] },
600 { "n8", vtype_filter_int
, &filter_n
[8] },
601 { "n9", vtype_filter_int
, &filter_n
[9] },
602 { "original_domain", vtype_stringptr
, &deliver_domain_orig
},
603 { "original_local_part", vtype_stringptr
, &deliver_localpart_orig
},
604 { "originator_gid", vtype_gid
, &originator_gid
},
605 { "originator_uid", vtype_uid
, &originator_uid
},
606 { "parent_domain", vtype_stringptr
, &deliver_domain_parent
},
607 { "parent_local_part", vtype_stringptr
, &deliver_localpart_parent
},
608 { "pid", vtype_pid
, NULL
},
610 { "prdr_requested", vtype_bool
, &prdr_requested
},
612 { "primary_hostname", vtype_stringptr
, &primary_hostname
},
613 #ifdef EXPERIMENTAL_PROXY
614 { "proxy_host_address", vtype_stringptr
, &proxy_host_address
},
615 { "proxy_host_port", vtype_int
, &proxy_host_port
},
616 { "proxy_session", vtype_bool
, &proxy_session
},
617 { "proxy_target_address",vtype_stringptr
, &proxy_target_address
},
618 { "proxy_target_port", vtype_int
, &proxy_target_port
},
620 { "prvscheck_address", vtype_stringptr
, &prvscheck_address
},
621 { "prvscheck_keynum", vtype_stringptr
, &prvscheck_keynum
},
622 { "prvscheck_result", vtype_stringptr
, &prvscheck_result
},
623 { "qualify_domain", vtype_stringptr
, &qualify_domain_sender
},
624 { "qualify_recipient", vtype_stringptr
, &qualify_domain_recipient
},
625 { "rcpt_count", vtype_int
, &rcpt_count
},
626 { "rcpt_defer_count", vtype_int
, &rcpt_defer_count
},
627 { "rcpt_fail_count", vtype_int
, &rcpt_fail_count
},
628 { "received_count", vtype_int
, &received_count
},
629 { "received_for", vtype_stringptr
, &received_for
},
630 { "received_ip_address", vtype_stringptr
, &interface_address
},
631 { "received_port", vtype_int
, &interface_port
},
632 { "received_protocol", vtype_stringptr
, &received_protocol
},
633 { "received_time", vtype_int
, &received_time
},
634 { "recipient_data", vtype_stringptr
, &recipient_data
},
635 { "recipient_verify_failure",vtype_stringptr
,&recipient_verify_failure
},
636 { "recipients", vtype_string_func
, &fn_recipients
},
637 { "recipients_count", vtype_int
, &recipients_count
},
638 #ifdef WITH_CONTENT_SCAN
639 { "regex_match_string", vtype_stringptr
, ®ex_match_string
},
641 { "reply_address", vtype_reply
, NULL
},
642 { "return_path", vtype_stringptr
, &return_path
},
643 { "return_size_limit", vtype_int
, &bounce_return_size_limit
},
644 { "router_name", vtype_stringptr
, &router_name
},
645 { "runrc", vtype_int
, &runrc
},
646 { "self_hostname", vtype_stringptr
, &self_hostname
},
647 { "sender_address", vtype_stringptr
, &sender_address
},
648 { "sender_address_data", vtype_stringptr
, &sender_address_data
},
649 { "sender_address_domain", vtype_domain
, &sender_address
},
650 { "sender_address_local_part", vtype_localpart
, &sender_address
},
651 { "sender_data", vtype_stringptr
, &sender_data
},
652 { "sender_fullhost", vtype_stringptr
, &sender_fullhost
},
653 { "sender_helo_dnssec", vtype_bool
, &sender_helo_dnssec
},
654 { "sender_helo_name", vtype_stringptr
, &sender_helo_name
},
655 { "sender_host_address", vtype_stringptr
, &sender_host_address
},
656 { "sender_host_authenticated",vtype_stringptr
, &sender_host_authenticated
},
657 { "sender_host_dnssec", vtype_bool
, &sender_host_dnssec
},
658 { "sender_host_name", vtype_host_lookup
, NULL
},
659 { "sender_host_port", vtype_int
, &sender_host_port
},
660 { "sender_ident", vtype_stringptr
, &sender_ident
},
661 { "sender_rate", vtype_stringptr
, &sender_rate
},
662 { "sender_rate_limit", vtype_stringptr
, &sender_rate_limit
},
663 { "sender_rate_period", vtype_stringptr
, &sender_rate_period
},
664 { "sender_rcvhost", vtype_stringptr
, &sender_rcvhost
},
665 { "sender_verify_failure",vtype_stringptr
, &sender_verify_failure
},
666 { "sending_ip_address", vtype_stringptr
, &sending_ip_address
},
667 { "sending_port", vtype_int
, &sending_port
},
668 { "smtp_active_hostname", vtype_stringptr
, &smtp_active_hostname
},
669 { "smtp_command", vtype_stringptr
, &smtp_cmd_buffer
},
670 { "smtp_command_argument", vtype_stringptr
, &smtp_cmd_argument
},
671 { "smtp_count_at_connection_start", vtype_int
, &smtp_accept_count
},
672 { "smtp_notquit_reason", vtype_stringptr
, &smtp_notquit_reason
},
673 { "sn0", vtype_filter_int
, &filter_sn
[0] },
674 { "sn1", vtype_filter_int
, &filter_sn
[1] },
675 { "sn2", vtype_filter_int
, &filter_sn
[2] },
676 { "sn3", vtype_filter_int
, &filter_sn
[3] },
677 { "sn4", vtype_filter_int
, &filter_sn
[4] },
678 { "sn5", vtype_filter_int
, &filter_sn
[5] },
679 { "sn6", vtype_filter_int
, &filter_sn
[6] },
680 { "sn7", vtype_filter_int
, &filter_sn
[7] },
681 { "sn8", vtype_filter_int
, &filter_sn
[8] },
682 { "sn9", vtype_filter_int
, &filter_sn
[9] },
683 #ifdef WITH_CONTENT_SCAN
684 { "spam_action", vtype_stringptr
, &spam_action
},
685 { "spam_bar", vtype_stringptr
, &spam_bar
},
686 { "spam_report", vtype_stringptr
, &spam_report
},
687 { "spam_score", vtype_stringptr
, &spam_score
},
688 { "spam_score_int", vtype_stringptr
, &spam_score_int
},
690 #ifdef EXPERIMENTAL_SPF
691 { "spf_guess", vtype_stringptr
, &spf_guess
},
692 { "spf_header_comment", vtype_stringptr
, &spf_header_comment
},
693 { "spf_received", vtype_stringptr
, &spf_received
},
694 { "spf_result", vtype_stringptr
, &spf_result
},
695 { "spf_smtp_comment", vtype_stringptr
, &spf_smtp_comment
},
697 { "spool_directory", vtype_stringptr
, &spool_directory
},
698 { "spool_inodes", vtype_pinodes
, (void *)TRUE
},
699 { "spool_space", vtype_pspace
, (void *)TRUE
},
700 #ifdef EXPERIMENTAL_SRS
701 { "srs_db_address", vtype_stringptr
, &srs_db_address
},
702 { "srs_db_key", vtype_stringptr
, &srs_db_key
},
703 { "srs_orig_recipient", vtype_stringptr
, &srs_orig_recipient
},
704 { "srs_orig_sender", vtype_stringptr
, &srs_orig_sender
},
705 { "srs_recipient", vtype_stringptr
, &srs_recipient
},
706 { "srs_status", vtype_stringptr
, &srs_status
},
708 { "thisaddress", vtype_stringptr
, &filter_thisaddress
},
710 /* The non-(in,out) variables are now deprecated */
711 { "tls_bits", vtype_int
, &tls_in
.bits
},
712 { "tls_certificate_verified", vtype_int
, &tls_in
.certificate_verified
},
713 { "tls_cipher", vtype_stringptr
, &tls_in
.cipher
},
715 { "tls_in_bits", vtype_int
, &tls_in
.bits
},
716 { "tls_in_certificate_verified", vtype_int
, &tls_in
.certificate_verified
},
717 { "tls_in_cipher", vtype_stringptr
, &tls_in
.cipher
},
718 { "tls_in_ocsp", vtype_int
, &tls_in
.ocsp
},
719 { "tls_in_ourcert", vtype_cert
, &tls_in
.ourcert
},
720 { "tls_in_peercert", vtype_cert
, &tls_in
.peercert
},
721 { "tls_in_peerdn", vtype_stringptr
, &tls_in
.peerdn
},
722 #if defined(SUPPORT_TLS)
723 { "tls_in_sni", vtype_stringptr
, &tls_in
.sni
},
725 { "tls_out_bits", vtype_int
, &tls_out
.bits
},
726 { "tls_out_certificate_verified", vtype_int
,&tls_out
.certificate_verified
},
727 { "tls_out_cipher", vtype_stringptr
, &tls_out
.cipher
},
728 #ifdef EXPERIMENTAL_DANE
729 { "tls_out_dane", vtype_bool
, &tls_out
.dane_verified
},
731 { "tls_out_ocsp", vtype_int
, &tls_out
.ocsp
},
732 { "tls_out_ourcert", vtype_cert
, &tls_out
.ourcert
},
733 { "tls_out_peercert", vtype_cert
, &tls_out
.peercert
},
734 { "tls_out_peerdn", vtype_stringptr
, &tls_out
.peerdn
},
735 #if defined(SUPPORT_TLS)
736 { "tls_out_sni", vtype_stringptr
, &tls_out
.sni
},
738 #ifdef EXPERIMENTAL_DANE
739 { "tls_out_tlsa_usage", vtype_int
, &tls_out
.tlsa_usage
},
742 { "tls_peerdn", vtype_stringptr
, &tls_in
.peerdn
}, /* mind the alphabetical order! */
743 #if defined(SUPPORT_TLS)
744 { "tls_sni", vtype_stringptr
, &tls_in
.sni
}, /* mind the alphabetical order! */
747 { "tod_bsdinbox", vtype_todbsdin
, NULL
},
748 { "tod_epoch", vtype_tode
, NULL
},
749 { "tod_epoch_l", vtype_todel
, NULL
},
750 { "tod_full", vtype_todf
, NULL
},
751 { "tod_log", vtype_todl
, NULL
},
752 { "tod_logfile", vtype_todlf
, NULL
},
753 { "tod_zone", vtype_todzone
, NULL
},
754 { "tod_zulu", vtype_todzulu
, NULL
},
755 { "transport_name", vtype_stringptr
, &transport_name
},
756 { "value", vtype_stringptr
, &lookup_value
},
757 { "verify_mode", vtype_stringptr
, &verify_mode
},
758 { "version_number", vtype_stringptr
, &version_string
},
759 { "warn_message_delay", vtype_stringptr
, &warnmsg_delay
},
760 { "warn_message_recipient",vtype_stringptr
, &warnmsg_recipients
},
761 { "warn_message_recipients",vtype_stringptr
,&warnmsg_recipients
},
762 { "warnmsg_delay", vtype_stringptr
, &warnmsg_delay
},
763 { "warnmsg_recipient", vtype_stringptr
, &warnmsg_recipients
},
764 { "warnmsg_recipients", vtype_stringptr
, &warnmsg_recipients
}
767 static int var_table_size
= nelem(var_table
);
768 static uschar var_buffer
[256];
769 static BOOL malformed_header
;
771 /* For textual hashes */
773 static const char *hashcodes
= "abcdefghijklmnopqrtsuvwxyz"
774 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
777 enum { HMAC_MD5
, HMAC_SHA1
};
779 /* For numeric hashes */
781 static unsigned int prime
[] = {
782 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
783 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
784 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
786 /* For printing modes in symbolic form */
788 static uschar
*mtable_normal
[] =
789 { US
"---", US
"--x", US
"-w-", US
"-wx", US
"r--", US
"r-x", US
"rw-", US
"rwx" };
791 static uschar
*mtable_setid
[] =
792 { US
"--S", US
"--s", US
"-wS", US
"-ws", US
"r-S", US
"r-s", US
"rwS", US
"rws" };
794 static uschar
*mtable_sticky
[] =
795 { US
"--T", US
"--t", US
"-wT", US
"-wt", US
"r-T", US
"r-t", US
"rwT", US
"rwt" };
799 /*************************************************
800 * Tables for UTF-8 support *
801 *************************************************/
803 /* Table of the number of extra characters, indexed by the first character
804 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
807 static uschar utf8_table1
[] = {
808 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
809 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
810 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
811 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
813 /* These are the masks for the data bits in the first byte of a character,
814 indexed by the number of additional bytes. */
816 static int utf8_table2
[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
818 /* Get the next UTF-8 character, advancing the pointer. */
820 #define GETUTF8INC(c, ptr) \
822 if ((c & 0xc0) == 0xc0) \
824 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
826 c = (c & utf8_table2[a]) << s; \
830 c |= (*ptr++ & 0x3f) << s; \
835 /*************************************************
836 * Binary chop search on a table *
837 *************************************************/
839 /* This is used for matching expansion items and operators.
842 name the name that is being sought
843 table the table to search
844 table_size the number of items in the table
846 Returns: the offset in the table, or -1
850 chop_match(uschar
*name
, uschar
**table
, int table_size
)
852 uschar
**bot
= table
;
853 uschar
**top
= table
+ table_size
;
857 uschar
**mid
= bot
+ (top
- bot
)/2;
858 int c
= Ustrcmp(name
, *mid
);
859 if (c
== 0) return mid
- table
;
860 if (c
> 0) bot
= mid
+ 1; else top
= mid
;
868 /*************************************************
869 * Check a condition string *
870 *************************************************/
872 /* This function is called to expand a string, and test the result for a "true"
873 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
874 forced fail or lookup defer.
876 We used to release all store used, but this is not not safe due
877 to ${dlfunc } and ${acl }. In any case expand_string_internal()
878 is reasonably careful to release what it can.
880 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
883 condition the condition string
884 m1 text to be incorporated in panic error
887 Returns: TRUE if condition is met, FALSE if not
891 expand_check_condition(uschar
*condition
, uschar
*m1
, uschar
*m2
)
894 uschar
*ss
= expand_string(condition
);
897 if (!expand_string_forcedfail
&& !search_find_defer
)
898 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand condition \"%s\" "
899 "for %s %s: %s", condition
, m1
, m2
, expand_string_message
);
902 rc
= ss
[0] != 0 && Ustrcmp(ss
, "0") != 0 && strcmpic(ss
, US
"no") != 0 &&
903 strcmpic(ss
, US
"false") != 0;
910 /*************************************************
911 * Pseudo-random number generation *
912 *************************************************/
914 /* Pseudo-random number generation. The result is not "expected" to be
915 cryptographically strong but not so weak that someone will shoot themselves
916 in the foot using it as a nonce in some email header scheme or whatever
917 weirdness they'll twist this into. The result should ideally handle fork().
919 However, if we're stuck unable to provide this, then we'll fall back to
920 appallingly bad randomness.
922 If SUPPORT_TLS is defined then this will not be used except as an emergency
927 Returns a random number in range [0, max-1]
931 # define vaguely_random_number vaguely_random_number_fallback
934 vaguely_random_number(int max
)
937 # undef vaguely_random_number
939 static pid_t pid
= 0;
941 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
951 #ifdef HAVE_ARC4RANDOM
952 /* cryptographically strong randomness, common on *BSD platforms, not
953 so much elsewhere. Alas. */
954 #ifndef NOT_HAVE_ARC4RANDOM_STIR
957 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
958 #ifdef HAVE_SRANDOMDEV
959 /* uses random(4) for seeding */
962 gettimeofday(&tv
, NULL
);
963 srandom(tv
.tv_sec
| tv
.tv_usec
| getpid());
966 /* Poor randomness and no seeding here */
973 #ifdef HAVE_ARC4RANDOM
974 return arc4random() % max
;
975 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
976 return random() % max
;
978 /* This one returns a 16-bit number, definitely not crypto-strong */
979 return random_number(max
);
986 /*************************************************
987 * Pick out a name from a string *
988 *************************************************/
990 /* If the name is too long, it is silently truncated.
993 name points to a buffer into which to put the name
994 max is the length of the buffer
995 s points to the first alphabetic character of the name
996 extras chars other than alphanumerics to permit
998 Returns: pointer to the first character after the name
1000 Note: The test for *s != 0 in the while loop is necessary because
1001 Ustrchr() yields non-NULL if the character is zero (which is not something
1004 static const uschar
*
1005 read_name(uschar
*name
, int max
, const uschar
*s
, uschar
*extras
)
1008 while (*s
!= 0 && (isalnum(*s
) || Ustrchr(extras
, *s
) != NULL
))
1010 if (ptr
< max
-1) name
[ptr
++] = *s
;
1019 /*************************************************
1020 * Pick out the rest of a header name *
1021 *************************************************/
1023 /* A variable name starting $header_ (or just $h_ for those who like
1024 abbreviations) might not be the complete header name because headers can
1025 contain any printing characters in their names, except ':'. This function is
1026 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1027 on the end, if the name was terminated by white space.
1030 name points to a buffer in which the name read so far exists
1031 max is the length of the buffer
1032 s points to the first character after the name so far, i.e. the
1033 first non-alphameric character after $header_xxxxx
1035 Returns: a pointer to the first character after the header name
1038 static const uschar
*
1039 read_header_name(uschar
*name
, int max
, const uschar
*s
)
1041 int prelen
= Ustrchr(name
, '_') - name
+ 1;
1042 int ptr
= Ustrlen(name
) - prelen
;
1043 if (ptr
> 0) memmove(name
, name
+prelen
, ptr
);
1044 while (mac_isgraph(*s
) && *s
!= ':')
1046 if (ptr
< max
-1) name
[ptr
++] = *s
;
1057 /*************************************************
1058 * Pick out a number from a string *
1059 *************************************************/
1062 n points to an integer into which to put the number
1063 s points to the first digit of the number
1065 Returns: a pointer to the character after the last digit
1069 read_number(int *n
, uschar
*s
)
1072 while (isdigit(*s
)) *n
= *n
* 10 + (*s
++ - '0');
1076 static const uschar
*
1077 read_cnumber(int *n
, const uschar
*s
)
1080 while (isdigit(*s
)) *n
= *n
* 10 + (*s
++ - '0');
1086 /*************************************************
1087 * Extract keyed subfield from a string *
1088 *************************************************/
1090 /* The yield is in dynamic store; NULL means that the key was not found.
1093 key points to the name of the key
1094 s points to the string from which to extract the subfield
1096 Returns: NULL if the subfield was not found, or
1097 a pointer to the subfield's data
1101 expand_getkeyed(uschar
*key
, const uschar
*s
)
1103 int length
= Ustrlen(key
);
1104 while (isspace(*s
)) s
++;
1106 /* Loop to search for the key */
1112 const uschar
*dkey
= s
;
1114 while (*s
!= 0 && *s
!= '=' && !isspace(*s
)) s
++;
1115 dkeylength
= s
- dkey
;
1116 while (isspace(*s
)) s
++;
1117 if (*s
== '=') while (isspace((*(++s
))));
1119 data
= string_dequote(&s
);
1120 if (length
== dkeylength
&& strncmpic(key
, dkey
, length
) == 0)
1123 while (isspace(*s
)) s
++;
1132 find_var_ent(uschar
* name
)
1135 int last
= var_table_size
;
1137 while (last
> first
)
1139 int middle
= (first
+ last
)/2;
1140 int c
= Ustrcmp(name
, var_table
[middle
].name
);
1142 if (c
> 0) { first
= middle
+ 1; continue; }
1143 if (c
< 0) { last
= middle
; continue; }
1144 return &var_table
[middle
];
1149 /*************************************************
1150 * Extract numbered subfield from string *
1151 *************************************************/
1153 /* Extracts a numbered field from a string that is divided by tokens - for
1154 example a line from /etc/passwd is divided by colon characters. First field is
1155 numbered one. Negative arguments count from the right. Zero returns the whole
1156 string. Returns NULL if there are insufficient tokens in the string
1159 Modifies final argument - this is a dynamically generated string, so that's OK.
1162 field number of field to be extracted,
1163 first field = 1, whole string = 0, last field = -1
1164 separators characters that are used to break string into tokens
1165 s points to the string from which to extract the subfield
1167 Returns: NULL if the field was not found,
1168 a pointer to the field's data inside s (modified to add 0)
1172 expand_gettokened (int field
, uschar
*separators
, uschar
*s
)
1177 uschar
*fieldtext
= NULL
;
1179 if (field
== 0) return s
;
1181 /* Break the line up into fields in place; for field > 0 we stop when we have
1182 done the number of fields we want. For field < 0 we continue till the end of
1183 the string, counting the number of fields. */
1185 count
= (field
> 0)? field
: INT_MAX
;
1191 /* Previous field was the last one in the string. For a positive field
1192 number, this means there are not enough fields. For a negative field number,
1193 check that there are enough, and scan back to find the one that is wanted. */
1197 if (field
> 0 || (-field
) > (INT_MAX
- count
- 1)) return NULL
;
1198 if ((-field
) == (INT_MAX
- count
- 1)) return s
;
1202 while (ss
[-1] != 0) ss
--;
1208 /* Previous field was not last in the string; save its start and put a
1212 len
= Ustrcspn(ss
, separators
);
1223 expand_getlistele(int field
, const uschar
* list
)
1225 const uschar
* tlist
= list
;
1231 for(field
++; string_nextinlist(&tlist
, &sep
, &dummy
, 1); ) field
++;
1234 if(field
==0) return NULL
;
1235 while(--field
>0 && (string_nextinlist(&list
, &sep
, &dummy
, 1))) ;
1236 return string_nextinlist(&list
, &sep
, NULL
, 0);
1240 /* Certificate fields, by name. Worry about by-OID later */
1241 /* Names are chosen to not have common prefixes */
1248 uschar
* (*getfn
)(void * cert
, uschar
* mod
);
1250 static certfield certfields
[] =
1251 { /* linear search; no special order */
1252 { US
"version", 7, &tls_cert_version
},
1253 { US
"serial_number", 13, &tls_cert_serial_number
},
1254 { US
"subject", 7, &tls_cert_subject
},
1255 { US
"notbefore", 9, &tls_cert_not_before
},
1256 { US
"notafter", 8, &tls_cert_not_after
},
1257 { US
"issuer", 6, &tls_cert_issuer
},
1258 { US
"signature", 9, &tls_cert_signature
},
1259 { US
"sig_algorithm", 13, &tls_cert_signature_algorithm
},
1260 { US
"subj_altname", 12, &tls_cert_subject_altname
},
1261 { US
"ocsp_uri", 8, &tls_cert_ocsp_uri
},
1262 { US
"crl_uri", 7, &tls_cert_crl_uri
},
1266 expand_getcertele(uschar
* field
, uschar
* certvar
)
1271 if (!(vp
= find_var_ent(certvar
)))
1273 expand_string_message
=
1274 string_sprintf("no variable named \"%s\"", certvar
);
1275 return NULL
; /* Unknown variable name */
1277 /* NB this stops us passing certs around in variable. Might
1278 want to do that in future */
1279 if (vp
->type
!= vtype_cert
)
1281 expand_string_message
=
1282 string_sprintf("\"%s\" is not a certificate", certvar
);
1283 return NULL
; /* Unknown variable name */
1285 if (!*(void **)vp
->value
)
1288 if (*field
>= '0' && *field
<= '9')
1289 return tls_cert_ext_by_oid(*(void **)vp
->value
, field
, 0);
1291 for(cp
= certfields
;
1292 cp
< certfields
+ nelem(certfields
);
1294 if (Ustrncmp(cp
->name
, field
, cp
->namelen
) == 0)
1296 uschar
* modifier
= *(field
+= cp
->namelen
) == ','
1298 return (*cp
->getfn
)( *(void **)vp
->value
, modifier
);
1301 expand_string_message
=
1302 string_sprintf("bad field selector \"%s\" for certextract", field
);
1305 #endif /*SUPPORT_TLS*/
1307 /*************************************************
1308 * Extract a substring from a string *
1309 *************************************************/
1311 /* Perform the ${substr or ${length expansion operations.
1314 subject the input string
1315 value1 the offset from the start of the input string to the start of
1316 the output string; if negative, count from the right.
1317 value2 the length of the output string, or negative (-1) for unset
1318 if value1 is positive, unset means "all after"
1319 if value1 is negative, unset means "all before"
1320 len set to the length of the returned string
1322 Returns: pointer to the output string, or NULL if there is an error
1326 extract_substr(uschar
*subject
, int value1
, int value2
, int *len
)
1328 int sublen
= Ustrlen(subject
);
1330 if (value1
< 0) /* count from right */
1334 /* If the position is before the start, skip to the start, and adjust the
1335 length. If the length ends up negative, the substring is null because nothing
1336 can precede. This falls out naturally when the length is unset, meaning "all
1342 if (value2
< 0) value2
= 0;
1346 /* Otherwise an unset length => characters before value1 */
1348 else if (value2
< 0)
1355 /* For a non-negative offset, if the starting position is past the end of the
1356 string, the result will be the null string. Otherwise, an unset length means
1357 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1361 if (value1
> sublen
)
1366 else if (value2
< 0) value2
= sublen
;
1369 /* Cut the length down to the maximum possible for the offset value, and get
1370 the required characters. */
1372 if (value1
+ value2
> sublen
) value2
= sublen
- value1
;
1374 return subject
+ value1
;
1380 /*************************************************
1381 * Old-style hash of a string *
1382 *************************************************/
1384 /* Perform the ${hash expansion operation.
1387 subject the input string (an expanded substring)
1388 value1 the length of the output string; if greater or equal to the
1389 length of the input string, the input string is returned
1390 value2 the number of hash characters to use, or 26 if negative
1391 len set to the length of the returned string
1393 Returns: pointer to the output string, or NULL if there is an error
1397 compute_hash(uschar
*subject
, int value1
, int value2
, int *len
)
1399 int sublen
= Ustrlen(subject
);
1401 if (value2
< 0) value2
= 26;
1402 else if (value2
> Ustrlen(hashcodes
))
1404 expand_string_message
=
1405 string_sprintf("hash count \"%d\" too big", value2
);
1409 /* Calculate the hash text. We know it is shorter than the original string, so
1410 can safely place it in subject[] (we know that subject is always itself an
1411 expanded substring). */
1413 if (value1
< sublen
)
1418 while ((c
= (subject
[j
])) != 0)
1420 int shift
= (c
+ j
++) & 7;
1421 subject
[i
] ^= (c
<< shift
) | (c
>> (8-shift
));
1422 if (++i
>= value1
) i
= 0;
1424 for (i
= 0; i
< value1
; i
++)
1425 subject
[i
] = hashcodes
[(subject
[i
]) % value2
];
1427 else value1
= sublen
;
1436 /*************************************************
1437 * Numeric hash of a string *
1438 *************************************************/
1440 /* Perform the ${nhash expansion operation. The first characters of the
1441 string are treated as most important, and get the highest prime numbers.
1444 subject the input string
1445 value1 the maximum value of the first part of the result
1446 value2 the maximum value of the second part of the result,
1447 or negative to produce only a one-part result
1448 len set to the length of the returned string
1450 Returns: pointer to the output string, or NULL if there is an error.
1454 compute_nhash (uschar
*subject
, int value1
, int value2
, int *len
)
1456 uschar
*s
= subject
;
1458 unsigned long int total
= 0; /* no overflow */
1462 if (i
== 0) i
= nelem(prime
) - 1;
1463 total
+= prime
[i
--] * (unsigned int)(*s
++);
1466 /* If value2 is unset, just compute one number */
1470 s
= string_sprintf("%d", total
% value1
);
1473 /* Otherwise do a div/mod hash */
1477 total
= total
% (value1
* value2
);
1478 s
= string_sprintf("%d/%d", total
/value2
, total
% value2
);
1489 /*************************************************
1490 * Find the value of a header or headers *
1491 *************************************************/
1493 /* Multiple instances of the same header get concatenated, and this function
1494 can also return a concatenation of all the header lines. When concatenating
1495 specific headers that contain lists of addresses, a comma is inserted between
1496 them. Otherwise we use a straight concatenation. Because some messages can have
1497 pathologically large number of lines, there is a limit on the length that is
1498 returned. Also, to avoid massive store use which would result from using
1499 string_cat() as it copies and extends strings, we do a preliminary pass to find
1500 out exactly how much store will be needed. On "normal" messages this will be
1504 name the name of the header, without the leading $header_ or $h_,
1505 or NULL if a concatenation of all headers is required
1506 exists_only TRUE if called from a def: test; don't need to build a string;
1507 just return a string that is not "" and not "0" if the header
1509 newsize return the size of memory block that was obtained; may be NULL
1510 if exists_only is TRUE
1511 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1512 other than concatenating, will be done on the header. Also used
1513 for $message_headers_raw.
1514 charset name of charset to translate MIME words to; used only if
1515 want_raw is false; if NULL, no translation is done (this is
1516 used for $bh_ and $bheader_)
1518 Returns: NULL if the header does not exist, else a pointer to a new
1523 find_header(uschar
*name
, BOOL exists_only
, int *newsize
, BOOL want_raw
,
1526 BOOL found
= name
== NULL
;
1528 int len
= found
? 0 : Ustrlen(name
);
1530 uschar
*yield
= NULL
;
1533 /* Loop for two passes - saves code repetition */
1535 for (i
= 0; i
< 2; i
++)
1540 for (h
= header_list
; size
< header_insert_maxlen
&& h
!= NULL
; h
= h
->next
)
1542 if (h
->type
!= htype_old
&& h
->text
!= NULL
) /* NULL => Received: placeholder */
1544 if (name
== NULL
|| (len
<= h
->slen
&& strncmpic(name
, h
->text
, len
) == 0))
1549 if (exists_only
) return US
"1"; /* don't need actual string */
1551 t
= h
->text
+ len
; /* text to insert */
1552 if (!want_raw
) /* unless wanted raw, */
1553 while (isspace(*t
)) t
++; /* remove leading white space */
1554 ilen
= h
->slen
- (t
- h
->text
); /* length to insert */
1556 /* Unless wanted raw, remove trailing whitespace, including the
1560 while (ilen
> 0 && isspace(t
[ilen
-1])) ilen
--;
1562 /* Set comma = 1 if handling a single header and it's one of those
1563 that contains an address list, except when asked for raw headers. Only
1564 need to do this once. */
1566 if (!want_raw
&& name
!= NULL
&& comma
== 0 &&
1567 Ustrchr("BCFRST", h
->type
) != NULL
)
1570 /* First pass - compute total store needed; second pass - compute
1571 total store used, including this header. */
1573 size
+= ilen
+ comma
+ 1; /* +1 for the newline */
1575 /* Second pass - concatentate the data, up to a maximum. Note that
1576 the loop stops when size hits the limit. */
1580 if (size
> header_insert_maxlen
)
1582 ilen
-= size
- header_insert_maxlen
- 1;
1585 Ustrncpy(ptr
, t
, ilen
);
1588 /* For a non-raw header, put in the comma if needed, then add
1589 back the newline we removed above, provided there was some text in
1592 if (!want_raw
&& ilen
> 0)
1594 if (comma
!= 0) *ptr
++ = ',';
1602 /* At end of first pass, return NULL if no header found. Then truncate size
1603 if necessary, and get the buffer to hold the data, returning the buffer size.
1608 if (!found
) return NULL
;
1609 if (size
> header_insert_maxlen
) size
= header_insert_maxlen
;
1610 *newsize
= size
+ 1;
1611 ptr
= yield
= store_get(*newsize
);
1615 /* That's all we do for raw header expansion. */
1622 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1623 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1624 function can return an error with decoded data if the charset translation
1625 fails. If decoding fails, it returns NULL. */
1629 uschar
*decoded
, *error
;
1630 if (ptr
> yield
&& ptr
[-1] == '\n') ptr
--;
1631 if (ptr
> yield
&& comma
!= 0 && ptr
[-1] == ',') ptr
--;
1633 decoded
= rfc2047_decode2(yield
, check_rfc2047_length
, charset
, '?', NULL
,
1637 DEBUG(D_any
) debug_printf("*** error in RFC 2047 decoding: %s\n"
1638 " input was: %s\n", error
, yield
);
1640 if (decoded
!= NULL
) yield
= decoded
;
1649 /*************************************************
1650 * Return list of recipients *
1651 *************************************************/
1652 /* A recipients list is available only during system message filtering,
1653 during ACL processing after DATA, and while expanding pipe commands
1654 generated from a system filter, but not elsewhere. */
1659 if (!enable_dollar_recipients
) return NULL
; else
1664 uschar
* s
= store_get(size
);
1665 for (i
= 0; i
< recipients_count
; i
++)
1667 if (i
!= 0) s
= string_cat(s
, &size
, &ptr
, US
", ", 2);
1668 s
= string_cat(s
, &size
, &ptr
, recipients_list
[i
].address
,
1669 Ustrlen(recipients_list
[i
].address
));
1671 s
[ptr
] = 0; /* string_cat() leaves room */
1677 /*************************************************
1678 * Find value of a variable *
1679 *************************************************/
1681 /* The table of variables is kept in alphabetic order, so we can search it
1682 using a binary chop. The "choplen" variable is nothing to do with the binary
1686 name the name of the variable being sought
1687 exists_only TRUE if this is a def: test; passed on to find_header()
1688 skipping TRUE => skip any processing evaluation; this is not the same as
1689 exists_only because def: may test for values that are first
1691 newsize pointer to an int which is initially zero; if the answer is in
1692 a new memory buffer, *newsize is set to its size
1694 Returns: NULL if the variable does not exist, or
1695 a pointer to the variable's contents, or
1696 something non-NULL if exists_only is TRUE
1700 find_variable(uschar
*name
, BOOL exists_only
, BOOL skipping
, int *newsize
)
1707 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1708 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1709 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1710 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1711 (this gave backwards compatibility at the changeover). There may be built-in
1712 variables whose names start acl_ but they should never start in this way. This
1713 slightly messy specification is a consequence of the history, needless to say.
1715 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1716 set, in which case give an error. */
1718 if ((Ustrncmp(name
, "acl_c", 5) == 0 || Ustrncmp(name
, "acl_m", 5) == 0) &&
1722 tree_search((name
[4] == 'c')? acl_var_c
: acl_var_m
, name
+ 4);
1723 return (node
== NULL
)? (strict_acl_vars
? NULL
: US
"") : node
->data
.ptr
;
1726 /* Handle $auth<n> variables. */
1728 if (Ustrncmp(name
, "auth", 4) == 0)
1731 int n
= Ustrtoul(name
+ 4, &endptr
, 10);
1732 if (*endptr
== 0 && n
!= 0 && n
<= AUTH_VARS
)
1733 return !auth_vars
[n
-1] ? US
"" : auth_vars
[n
-1];
1735 else if (Ustrncmp(name
, "regex", 5) == 0)
1738 int n
= Ustrtoul(name
+ 5, &endptr
, 10);
1739 if (*endptr
== 0 && n
!= 0 && n
<= REGEX_VARS
)
1740 return !regex_vars
[n
-1] ? US
"" : regex_vars
[n
-1];
1743 /* For all other variables, search the table */
1745 if (!(vp
= find_var_ent(name
)))
1746 return NULL
; /* Unknown variable name */
1748 /* Found an existing variable. If in skipping state, the value isn't needed,
1749 and we want to avoid processing (such as looking up the host name). */
1757 case vtype_filter_int
:
1758 if (!filter_running
) return NULL
;
1762 sprintf(CS var_buffer
, "%d", *(int *)(val
)); /* Integer */
1766 sprintf(CS var_buffer
, "%ld", (long int)(*(ino_t
*)(val
))); /* Inode */
1770 sprintf(CS var_buffer
, "%ld", (long int)(*(gid_t
*)(val
))); /* gid */
1774 sprintf(CS var_buffer
, "%ld", (long int)(*(uid_t
*)(val
))); /* uid */
1778 sprintf(CS var_buffer
, "%s", *(BOOL
*)(val
) ? "yes" : "no"); /* bool */
1781 case vtype_stringptr
: /* Pointer to string */
1782 s
= *((uschar
**)(val
));
1783 return (s
== NULL
)? US
"" : s
;
1786 sprintf(CS var_buffer
, "%d", (int)getpid()); /* pid */
1789 case vtype_load_avg
:
1790 sprintf(CS var_buffer
, "%d", OS_GETLOADAVG()); /* load_average */
1793 case vtype_host_lookup
: /* Lookup if not done so */
1794 if (sender_host_name
== NULL
&& sender_host_address
!= NULL
&&
1795 !host_lookup_failed
&& host_name_lookup() == OK
)
1796 host_build_sender_fullhost();
1797 return (sender_host_name
== NULL
)? US
"" : sender_host_name
;
1799 case vtype_localpart
: /* Get local part from address */
1800 s
= *((uschar
**)(val
));
1801 if (s
== NULL
) return US
"";
1802 domain
= Ustrrchr(s
, '@');
1803 if (domain
== NULL
) return s
;
1804 if (domain
- s
> sizeof(var_buffer
) - 1)
1805 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "local part longer than " SIZE_T_FMT
1806 " in string expansion", sizeof(var_buffer
));
1807 Ustrncpy(var_buffer
, s
, domain
- s
);
1808 var_buffer
[domain
- s
] = 0;
1811 case vtype_domain
: /* Get domain from address */
1812 s
= *((uschar
**)(val
));
1813 if (s
== NULL
) return US
"";
1814 domain
= Ustrrchr(s
, '@');
1815 return (domain
== NULL
)? US
"" : domain
+ 1;
1817 case vtype_msgheaders
:
1818 return find_header(NULL
, exists_only
, newsize
, FALSE
, NULL
);
1820 case vtype_msgheaders_raw
:
1821 return find_header(NULL
, exists_only
, newsize
, TRUE
, NULL
);
1823 case vtype_msgbody
: /* Pointer to msgbody string */
1824 case vtype_msgbody_end
: /* Ditto, the end of the msg */
1825 ss
= (uschar
**)(val
);
1826 if (*ss
== NULL
&& deliver_datafile
>= 0) /* Read body when needed */
1829 off_t start_offset
= SPOOL_DATA_START_OFFSET
;
1830 int len
= message_body_visible
;
1831 if (len
> message_size
) len
= message_size
;
1832 *ss
= body
= store_malloc(len
+1);
1834 if (vp
->type
== vtype_msgbody_end
)
1836 struct stat statbuf
;
1837 if (fstat(deliver_datafile
, &statbuf
) == 0)
1839 start_offset
= statbuf
.st_size
- len
;
1840 if (start_offset
< SPOOL_DATA_START_OFFSET
)
1841 start_offset
= SPOOL_DATA_START_OFFSET
;
1844 lseek(deliver_datafile
, start_offset
, SEEK_SET
);
1845 len
= read(deliver_datafile
, body
, len
);
1849 if (message_body_newlines
) /* Separate loops for efficiency */
1852 { if (body
[--len
] == 0) body
[len
] = ' '; }
1857 { if (body
[--len
] == '\n' || body
[len
] == 0) body
[len
] = ' '; }
1861 return (*ss
== NULL
)? US
"" : *ss
;
1863 case vtype_todbsdin
: /* BSD inbox time of day */
1864 return tod_stamp(tod_bsdin
);
1866 case vtype_tode
: /* Unix epoch time of day */
1867 return tod_stamp(tod_epoch
);
1869 case vtype_todel
: /* Unix epoch/usec time of day */
1870 return tod_stamp(tod_epoch_l
);
1872 case vtype_todf
: /* Full time of day */
1873 return tod_stamp(tod_full
);
1875 case vtype_todl
: /* Log format time of day */
1876 return tod_stamp(tod_log_bare
); /* (without timezone) */
1878 case vtype_todzone
: /* Time zone offset only */
1879 return tod_stamp(tod_zone
);
1881 case vtype_todzulu
: /* Zulu time */
1882 return tod_stamp(tod_zulu
);
1884 case vtype_todlf
: /* Log file datestamp tod */
1885 return tod_stamp(tod_log_datestamp_daily
);
1887 case vtype_reply
: /* Get reply address */
1888 s
= find_header(US
"reply-to:", exists_only
, newsize
, TRUE
,
1890 if (s
!= NULL
) while (isspace(*s
)) s
++;
1891 if (s
== NULL
|| *s
== 0)
1893 *newsize
= 0; /* For the *s==0 case */
1894 s
= find_header(US
"from:", exists_only
, newsize
, TRUE
, headers_charset
);
1899 while (isspace(*s
)) s
++;
1900 for (t
= s
; *t
!= 0; t
++) if (*t
== '\n') *t
= ' ';
1901 while (t
> s
&& isspace(t
[-1])) t
--;
1904 return (s
== NULL
)? US
"" : s
;
1906 case vtype_string_func
:
1908 uschar
* (*fn
)() = val
;
1915 sprintf(CS var_buffer
, "%d",
1916 receive_statvfs(val
== (void *)TRUE
, &inodes
));
1923 (void) receive_statvfs(val
== (void *)TRUE
, &inodes
);
1924 sprintf(CS var_buffer
, "%d", inodes
);
1929 return *(void **)val
? US
"<cert>" : US
"";
1931 #ifndef DISABLE_DKIM
1933 return dkim_exim_expand_query((int)(long)val
);
1938 return NULL
; /* Unknown variable. Silences static checkers. */
1945 modify_variable(uschar
*name
, void * value
)
1948 if ((vp
= find_var_ent(name
))) vp
->value
= value
;
1949 return; /* Unknown variable name, fail silently */
1956 /*************************************************
1957 * Read and expand substrings *
1958 *************************************************/
1960 /* This function is called to read and expand argument substrings for various
1961 expansion items. Some have a minimum requirement that is less than the maximum;
1962 in these cases, the first non-present one is set to NULL.
1965 sub points to vector of pointers to set
1966 n maximum number of substrings
1968 sptr points to current string pointer
1969 skipping the skipping flag
1970 check_end if TRUE, check for final '}'
1971 name name of item, for error message
1972 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1975 Returns: 0 OK; string pointer updated
1976 1 curly bracketing error (too few arguments)
1977 2 too many arguments (only if check_end is set); message set
1978 3 other error (expansion failure)
1982 read_subs(uschar
**sub
, int n
, int m
, const uschar
**sptr
, BOOL skipping
,
1983 BOOL check_end
, uschar
*name
, BOOL
*resetok
)
1986 const uschar
*s
= *sptr
;
1988 while (isspace(*s
)) s
++;
1989 for (i
= 0; i
< n
; i
++)
1993 if (i
< m
) return 1;
1997 sub
[i
] = expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, resetok
);
1998 if (sub
[i
] == NULL
) return 3;
1999 if (*s
++ != '}') return 1;
2000 while (isspace(*s
)) s
++;
2002 if (check_end
&& *s
++ != '}')
2006 expand_string_message
= string_sprintf("Too many arguments for \"%s\" "
2007 "(max is %d)", name
, n
);
2020 /*************************************************
2021 * Elaborate message for bad variable *
2022 *************************************************/
2024 /* For the "unknown variable" message, take a look at the variable's name, and
2025 give additional information about possible ACL variables. The extra information
2026 is added on to expand_string_message.
2028 Argument: the name of the variable
2033 check_variable_error_message(uschar
*name
)
2035 if (Ustrncmp(name
, "acl_", 4) == 0)
2036 expand_string_message
= string_sprintf("%s (%s)", expand_string_message
,
2037 (name
[4] == 'c' || name
[4] == 'm')?
2039 US
"6th character of a user-defined ACL variable must be a digit or underscore" :
2040 US
"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2042 US
"user-defined ACL variables must start acl_c or acl_m");
2048 Load args from sub array to globals, and call acl_check().
2049 Sub array will be corrupted on return.
2051 Returns: OK access is granted by an ACCEPT verb
2052 DISCARD access is granted by a DISCARD verb
2053 FAIL access is denied
2054 FAIL_DROP access is denied; drop the connection
2055 DEFER can't tell at the moment
2059 eval_acl(uschar
** sub
, int nsub
, uschar
** user_msgp
)
2062 int sav_narg
= acl_narg
;
2064 uschar
* dummy_logmsg
;
2065 extern int acl_where
;
2067 if(--nsub
> nelem(acl_arg
)) nsub
= nelem(acl_arg
);
2068 for (i
= 0; i
< nsub
&& sub
[i
+1]; i
++)
2070 uschar
* tmp
= acl_arg
[i
];
2071 acl_arg
[i
] = sub
[i
+1]; /* place callers args in the globals */
2072 sub
[i
+1] = tmp
; /* stash the old args using our caller's storage */
2077 sub
[i
+1] = acl_arg
[i
];
2078 acl_arg
[i
++] = NULL
;
2082 debug_printf("expanding: acl: %s arg: %s%s\n",
2084 acl_narg
>0 ? acl_arg
[0] : US
"<none>",
2085 acl_narg
>1 ? " +more" : "");
2087 ret
= acl_eval(acl_where
, sub
[0], user_msgp
, &dummy_logmsg
);
2089 for (i
= 0; i
< nsub
; i
++)
2090 acl_arg
[i
] = sub
[i
+1]; /* restore old args */
2091 acl_narg
= sav_narg
;
2099 /*************************************************
2100 * Read and evaluate a condition *
2101 *************************************************/
2105 s points to the start of the condition text
2106 resetok points to a BOOL which is written false if it is unsafe to
2107 free memory. Certain condition types (acl) may have side-effect
2108 allocation which must be preserved.
2109 yield points to a BOOL to hold the result of the condition test;
2110 if NULL, we are just reading through a condition that is
2111 part of an "or" combination to check syntax, or in a state
2112 where the answer isn't required
2114 Returns: a pointer to the first character after the condition, or
2118 static const uschar
*
2119 eval_condition(const uschar
*s
, BOOL
*resetok
, BOOL
*yield
)
2121 BOOL testfor
= TRUE
;
2122 BOOL tempcond
, combined_cond
;
2124 BOOL sub2_honour_dollar
= TRUE
;
2125 int i
, rc
, cond_type
, roffset
;
2126 int_eximarith_t num
[2];
2127 struct stat statbuf
;
2129 const uschar
*sub
[10];
2132 const uschar
*rerror
;
2136 while (isspace(*s
)) s
++;
2137 if (*s
== '!') { testfor
= !testfor
; s
++; } else break;
2140 /* Numeric comparisons are symbolic */
2142 if (*s
== '=' || *s
== '>' || *s
== '<')
2154 /* All other conditions are named */
2156 else s
= read_name(name
, 256, s
, US
"_");
2158 /* If we haven't read a name, it means some non-alpha character is first. */
2162 expand_string_message
= string_sprintf("condition name expected, "
2163 "but found \"%.16s\"", s
);
2167 /* Find which condition we are dealing with, and switch on it */
2169 cond_type
= chop_match(name
, cond_table
, nelem(cond_table
));
2172 /* def: tests for a non-empty variable, or for the existence of a header. If
2173 yield == NULL we are in a skipping state, and don't care about the answer. */
2178 expand_string_message
= US
"\":\" expected after \"def\"";
2182 s
= read_name(name
, 256, s
+1, US
"_");
2184 /* Test for a header's existence. If the name contains a closing brace
2185 character, this may be a user error where the terminating colon has been
2186 omitted. Set a flag to adjust a subsequent error message in this case. */
2188 if (Ustrncmp(name
, "h_", 2) == 0 ||
2189 Ustrncmp(name
, "rh_", 3) == 0 ||
2190 Ustrncmp(name
, "bh_", 3) == 0 ||
2191 Ustrncmp(name
, "header_", 7) == 0 ||
2192 Ustrncmp(name
, "rheader_", 8) == 0 ||
2193 Ustrncmp(name
, "bheader_", 8) == 0)
2195 s
= read_header_name(name
, 256, s
);
2196 /* {-for-text-editors */
2197 if (Ustrchr(name
, '}') != NULL
) malformed_header
= TRUE
;
2198 if (yield
!= NULL
) *yield
=
2199 (find_header(name
, TRUE
, NULL
, FALSE
, NULL
) != NULL
) == testfor
;
2202 /* Test for a variable's having a non-empty value. A non-existent variable
2203 causes an expansion failure. */
2207 uschar
*value
= find_variable(name
, TRUE
, yield
== NULL
, NULL
);
2210 expand_string_message
= (name
[0] == 0)?
2211 string_sprintf("variable name omitted after \"def:\"") :
2212 string_sprintf("unknown variable \"%s\" after \"def:\"", name
);
2213 check_variable_error_message(name
);
2216 if (yield
!= NULL
) *yield
= (value
[0] != 0) == testfor
;
2222 /* first_delivery tests for first delivery attempt */
2224 case ECOND_FIRST_DELIVERY
:
2225 if (yield
!= NULL
) *yield
= deliver_firsttime
== testfor
;
2229 /* queue_running tests for any process started by a queue runner */
2231 case ECOND_QUEUE_RUNNING
:
2232 if (yield
!= NULL
) *yield
= (queue_run_pid
!= (pid_t
)0) == testfor
;
2236 /* exists: tests for file existence
2237 isip: tests for any IP address
2238 isip4: tests for an IPv4 address
2239 isip6: tests for an IPv6 address
2240 pam: does PAM authentication
2241 radius: does RADIUS authentication
2242 ldapauth: does LDAP authentication
2243 pwcheck: does Cyrus SASL pwcheck authentication
2252 case ECOND_LDAPAUTH
:
2255 while (isspace(*s
)) s
++;
2256 if (*s
!= '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2258 sub
[0] = expand_string_internal(s
+1, TRUE
, &s
, yield
== NULL
, TRUE
, resetok
);
2259 if (sub
[0] == NULL
) return NULL
;
2260 /* {-for-text-editors */
2261 if (*s
++ != '}') goto COND_FAILED_CURLY_END
;
2263 if (yield
== NULL
) return s
; /* No need to run the test if skipping */
2268 if ((expand_forbid
& RDO_EXISTS
) != 0)
2270 expand_string_message
= US
"File existence tests are not permitted";
2273 *yield
= (Ustat(sub
[0], &statbuf
) == 0) == testfor
;
2279 rc
= string_is_ip_address(sub
[0], NULL
);
2280 *yield
= ((cond_type
== ECOND_ISIP
)? (rc
!= 0) :
2281 (cond_type
== ECOND_ISIP4
)? (rc
== 4) : (rc
== 6)) == testfor
;
2284 /* Various authentication tests - all optionally compiled */
2288 rc
= auth_call_pam(sub
[0], &expand_string_message
);
2291 goto COND_FAILED_NOT_COMPILED
;
2292 #endif /* SUPPORT_PAM */
2295 #ifdef RADIUS_CONFIG_FILE
2296 rc
= auth_call_radius(sub
[0], &expand_string_message
);
2299 goto COND_FAILED_NOT_COMPILED
;
2300 #endif /* RADIUS_CONFIG_FILE */
2302 case ECOND_LDAPAUTH
:
2305 /* Just to keep the interface the same */
2307 int old_pool
= store_pool
;
2308 store_pool
= POOL_SEARCH
;
2309 rc
= eldapauth_find((void *)(-1), NULL
, sub
[0], Ustrlen(sub
[0]), NULL
,
2310 &expand_string_message
, &do_cache
);
2311 store_pool
= old_pool
;
2315 goto COND_FAILED_NOT_COMPILED
;
2316 #endif /* LOOKUP_LDAP */
2319 #ifdef CYRUS_PWCHECK_SOCKET
2320 rc
= auth_call_pwcheck(sub
[0], &expand_string_message
);
2323 goto COND_FAILED_NOT_COMPILED
;
2324 #endif /* CYRUS_PWCHECK_SOCKET */
2326 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2327 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2329 if (rc
== ERROR
|| rc
== DEFER
) return NULL
;
2330 *yield
= (rc
== OK
) == testfor
;
2336 /* call ACL (in a conditional context). Accept true, deny false.
2337 Defer is a forced-fail. Anything set by message= goes to $value.
2338 Up to ten parameters are used; we use the braces round the name+args
2339 like the saslauthd condition does, to permit a variable number of args.
2340 See also the expansion-item version EITEM_ACL and the traditional
2341 acl modifier ACLC_ACL.
2342 Since the ACL may allocate new global variables, tell our caller to not
2347 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2355 while (isspace(*s
)) s
++;
2356 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /*}*/
2358 switch(read_subs(sub
, nelem(sub
), 1,
2359 &s
, yield
== NULL
, TRUE
, US
"acl", resetok
))
2361 case 1: expand_string_message
= US
"too few arguments or bracketing "
2364 case 3: return NULL
;
2368 if (yield
!= NULL
) switch(eval_acl(sub
, nelem(sub
), &user_msg
))
2373 lookup_value
= NULL
;
2376 lookup_value
= string_cat(NULL
, &size
, &ptr
, user_msg
, Ustrlen(user_msg
));
2377 lookup_value
[ptr
] = '\0';
2379 *yield
= cond
== testfor
;
2383 expand_string_forcedfail
= TRUE
;
2385 expand_string_message
= string_sprintf("error from acl \"%s\"", sub
[0]);
2392 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2394 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2396 However, the last two are optional. That is why the whole set is enclosed
2397 in their own set of braces. */
2399 case ECOND_SASLAUTHD
:
2400 #ifndef CYRUS_SASLAUTHD_SOCKET
2401 goto COND_FAILED_NOT_COMPILED
;
2405 while (isspace(*s
)) s
++;
2406 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2407 switch(read_subs(sub
, nelem(sub
), 2, &s
, yield
== NULL
, TRUE
, US
"saslauthd",
2410 case 1: expand_string_message
= US
"too few arguments or bracketing "
2411 "error for saslauthd";
2413 case 3: return NULL
;
2415 if (sub
[2] == NULL
) sub
[3] = NULL
; /* realm if no service */
2418 int rc
= auth_call_saslauthd(sub
[0], sub
[1], sub
[2], sub
[3],
2419 &expand_string_message
);
2420 if (rc
== ERROR
|| rc
== DEFER
) return NULL
;
2421 *yield
= (rc
== OK
) == testfor
;
2425 #endif /* CYRUS_SASLAUTHD_SOCKET */
2428 /* symbolic operators for numeric and string comparison, and a number of
2429 other operators, all requiring two arguments.
2431 crypteq: encrypts plaintext and compares against an encrypted text,
2432 using crypt(), crypt16(), MD5 or SHA-1
2433 inlist/inlisti: checks if first argument is in the list of the second
2434 match: does a regular expression match and sets up the numerical
2435 variables if it succeeds
2436 match_address: matches in an address list
2437 match_domain: matches in a domain list
2438 match_ip: matches a host list that is restricted to IP addresses
2439 match_local_part: matches in a local part list
2442 case ECOND_MATCH_ADDRESS
:
2443 case ECOND_MATCH_DOMAIN
:
2444 case ECOND_MATCH_IP
:
2445 case ECOND_MATCH_LOCAL_PART
:
2446 #ifndef EXPAND_LISTMATCH_RHS
2447 sub2_honour_dollar
= FALSE
;
2456 case ECOND_NUM_L
: /* Numerical comparisons */
2463 case ECOND_STR_LT
: /* String comparisons */
2474 for (i
= 0; i
< 2; i
++)
2476 /* Sometimes, we don't expand substrings; too many insecure configurations
2477 created using match_address{}{} and friends, where the second param
2478 includes information from untrustworthy sources. */
2479 BOOL honour_dollar
= TRUE
;
2480 if ((i
> 0) && !sub2_honour_dollar
)
2481 honour_dollar
= FALSE
;
2483 while (isspace(*s
)) s
++;
2486 if (i
== 0) goto COND_FAILED_CURLY_START
;
2487 expand_string_message
= string_sprintf("missing 2nd string in {} "
2488 "after \"%s\"", name
);
2491 sub
[i
] = expand_string_internal(s
+1, TRUE
, &s
, yield
== NULL
,
2492 honour_dollar
, resetok
);
2493 if (sub
[i
] == NULL
) return NULL
;
2494 if (*s
++ != '}') goto COND_FAILED_CURLY_END
;
2496 /* Convert to numerical if required; we know that the names of all the
2497 conditions that compare numbers do not start with a letter. This just saves
2498 checking for them individually. */
2500 if (!isalpha(name
[0]) && yield
!= NULL
)
2506 debug_printf("empty string cast to zero for numerical comparison\n");
2510 num
[i
] = expanded_string_integer(sub
[i
], FALSE
);
2511 if (expand_string_message
!= NULL
) return NULL
;
2516 /* Result not required */
2518 if (yield
== NULL
) return s
;
2520 /* Do an appropriate comparison */
2526 tempcond
= (num
[0] == num
[1]);
2530 tempcond
= (num
[0] > num
[1]);
2534 tempcond
= (num
[0] >= num
[1]);
2538 tempcond
= (num
[0] < num
[1]);
2542 tempcond
= (num
[0] <= num
[1]);
2546 tempcond
= (Ustrcmp(sub
[0], sub
[1]) < 0);
2550 tempcond
= (strcmpic(sub
[0], sub
[1]) < 0);
2554 tempcond
= (Ustrcmp(sub
[0], sub
[1]) <= 0);
2558 tempcond
= (strcmpic(sub
[0], sub
[1]) <= 0);
2562 tempcond
= (Ustrcmp(sub
[0], sub
[1]) == 0);
2566 tempcond
= (strcmpic(sub
[0], sub
[1]) == 0);
2570 tempcond
= (Ustrcmp(sub
[0], sub
[1]) > 0);
2574 tempcond
= (strcmpic(sub
[0], sub
[1]) > 0);
2578 tempcond
= (Ustrcmp(sub
[0], sub
[1]) >= 0);
2582 tempcond
= (strcmpic(sub
[0], sub
[1]) >= 0);
2585 case ECOND_MATCH
: /* Regular expression match */
2586 re
= pcre_compile(CS sub
[1], PCRE_COPT
, (const char **)&rerror
, &roffset
,
2590 expand_string_message
= string_sprintf("regular expression error in "
2591 "\"%s\": %s at offset %d", sub
[1], rerror
, roffset
);
2594 tempcond
= regex_match_and_setup(re
, sub
[0], 0, -1);
2597 case ECOND_MATCH_ADDRESS
: /* Match in an address list */
2598 rc
= match_address_list(sub
[0], TRUE
, FALSE
, &(sub
[1]), NULL
, -1, 0, NULL
);
2599 goto MATCHED_SOMETHING
;
2601 case ECOND_MATCH_DOMAIN
: /* Match in a domain list */
2602 rc
= match_isinlist(sub
[0], &(sub
[1]), 0, &domainlist_anchor
, NULL
,
2603 MCL_DOMAIN
+ MCL_NOEXPAND
, TRUE
, NULL
);
2604 goto MATCHED_SOMETHING
;
2606 case ECOND_MATCH_IP
: /* Match IP address in a host list */
2607 if (sub
[0][0] != 0 && string_is_ip_address(sub
[0], NULL
) == 0)
2609 expand_string_message
= string_sprintf("\"%s\" is not an IP address",
2615 unsigned int *nullcache
= NULL
;
2616 check_host_block cb
;
2618 cb
.host_name
= US
"";
2619 cb
.host_address
= sub
[0];
2621 /* If the host address starts off ::ffff: it is an IPv6 address in
2622 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2625 cb
.host_ipv4
= (Ustrncmp(cb
.host_address
, "::ffff:", 7) == 0)?
2626 cb
.host_address
+ 7 : cb
.host_address
;
2628 rc
= match_check_list(
2629 &sub
[1], /* the list */
2630 0, /* separator character */
2631 &hostlist_anchor
, /* anchor pointer */
2632 &nullcache
, /* cache pointer */
2633 check_host
, /* function for testing */
2634 &cb
, /* argument for function */
2635 MCL_HOST
, /* type of check */
2636 sub
[0], /* text for debugging */
2637 NULL
); /* where to pass back data */
2639 goto MATCHED_SOMETHING
;
2641 case ECOND_MATCH_LOCAL_PART
:
2642 rc
= match_isinlist(sub
[0], &(sub
[1]), 0, &localpartlist_anchor
, NULL
,
2643 MCL_LOCALPART
+ MCL_NOEXPAND
, TRUE
, NULL
);
2658 expand_string_message
= string_sprintf("unable to complete match "
2659 "against \"%s\": %s", sub
[1], search_error_message
);
2665 /* Various "encrypted" comparisons. If the second string starts with
2666 "{" then an encryption type is given. Default to crypt() or crypt16()
2667 (build-time choice). */
2668 /* }-for-text-editors */
2671 #ifndef SUPPORT_CRYPTEQ
2672 goto COND_FAILED_NOT_COMPILED
;
2674 if (strncmpic(sub
[1], US
"{md5}", 5) == 0)
2676 int sublen
= Ustrlen(sub
[1]+5);
2681 md5_end(&base
, (uschar
*)sub
[0], Ustrlen(sub
[0]), digest
);
2683 /* If the length that we are comparing against is 24, the MD5 digest
2684 is expressed as a base64 string. This is the way LDAP does it. However,
2685 some other software uses a straightforward hex representation. We assume
2686 this if the length is 32. Other lengths fail. */
2690 uschar
*coded
= auth_b64encode((uschar
*)digest
, 16);
2691 DEBUG(D_auth
) debug_printf("crypteq: using MD5+B64 hashing\n"
2692 " subject=%s\n crypted=%s\n", coded
, sub
[1]+5);
2693 tempcond
= (Ustrcmp(coded
, sub
[1]+5) == 0);
2695 else if (sublen
== 32)
2699 for (i
= 0; i
< 16; i
++) sprintf(CS (coded
+2*i
), "%02X", digest
[i
]);
2701 DEBUG(D_auth
) debug_printf("crypteq: using MD5+hex hashing\n"
2702 " subject=%s\n crypted=%s\n", coded
, sub
[1]+5);
2703 tempcond
= (strcmpic(coded
, sub
[1]+5) == 0);
2707 DEBUG(D_auth
) debug_printf("crypteq: length for MD5 not 24 or 32: "
2708 "fail\n crypted=%s\n", sub
[1]+5);
2713 else if (strncmpic(sub
[1], US
"{sha1}", 6) == 0)
2715 int sublen
= Ustrlen(sub
[1]+6);
2720 sha1_end(&base
, (uschar
*)sub
[0], Ustrlen(sub
[0]), digest
);
2722 /* If the length that we are comparing against is 28, assume the SHA1
2723 digest is expressed as a base64 string. If the length is 40, assume a
2724 straightforward hex representation. Other lengths fail. */
2728 uschar
*coded
= auth_b64encode((uschar
*)digest
, 20);
2729 DEBUG(D_auth
) debug_printf("crypteq: using SHA1+B64 hashing\n"
2730 " subject=%s\n crypted=%s\n", coded
, sub
[1]+6);
2731 tempcond
= (Ustrcmp(coded
, sub
[1]+6) == 0);
2733 else if (sublen
== 40)
2737 for (i
= 0; i
< 20; i
++) sprintf(CS (coded
+2*i
), "%02X", digest
[i
]);
2739 DEBUG(D_auth
) debug_printf("crypteq: using SHA1+hex hashing\n"
2740 " subject=%s\n crypted=%s\n", coded
, sub
[1]+6);
2741 tempcond
= (strcmpic(coded
, sub
[1]+6) == 0);
2745 DEBUG(D_auth
) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2746 "fail\n crypted=%s\n", sub
[1]+6);
2751 else /* {crypt} or {crypt16} and non-{ at start */
2752 /* }-for-text-editors */
2757 if (strncmpic(sub
[1], US
"{crypt}", 7) == 0)
2762 else if (strncmpic(sub
[1], US
"{crypt16}", 9) == 0)
2767 else if (sub
[1][0] == '{') /* }-for-text-editors */
2769 expand_string_message
= string_sprintf("unknown encryption mechanism "
2770 "in \"%s\"", sub
[1]);
2776 case 0: coded
= US
DEFAULT_CRYPT(CS sub
[0], CS sub
[1]); break;
2777 case 1: coded
= US
crypt(CS sub
[0], CS sub
[1]); break;
2778 default: coded
= US
crypt16(CS sub
[0], CS sub
[1]); break;
2782 #define XSTR(s) STR(s)
2783 DEBUG(D_auth
) debug_printf("crypteq: using %s()\n"
2784 " subject=%s\n crypted=%s\n",
2785 (which
== 0)? XSTR(DEFAULT_CRYPT
) : (which
== 1)? "crypt" : "crypt16",
2790 /* If the encrypted string contains fewer than two characters (for the
2791 salt), force failure. Otherwise we get false positives: with an empty
2792 string the yield of crypt() is an empty string! */
2794 tempcond
= (Ustrlen(sub
[1]) < 2)? FALSE
:
2795 (Ustrcmp(coded
, sub
[1]) == 0);
2798 #endif /* SUPPORT_CRYPTEQ */
2803 const uschar
* list
= sub
[1];
2805 uschar
*save_iterate_item
= iterate_item
;
2806 int (*compare
)(const uschar
*, const uschar
*);
2808 DEBUG(D_expand
) debug_printf("condition: %s\n", name
);
2811 compare
= cond_type
== ECOND_INLISTI
2812 ? strcmpic
: (int (*)(const uschar
*, const uschar
*)) strcmp
;
2814 while ((iterate_item
= string_nextinlist(&list
, &sep
, NULL
, 0)))
2815 if (compare(sub
[0], iterate_item
) == 0)
2820 iterate_item
= save_iterate_item
;
2823 } /* Switch for comparison conditions */
2825 *yield
= tempcond
== testfor
;
2826 return s
; /* End of comparison conditions */
2829 /* and/or: computes logical and/or of several conditions */
2833 subcondptr
= (yield
== NULL
)? NULL
: &tempcond
;
2834 combined_cond
= (cond_type
== ECOND_AND
);
2836 while (isspace(*s
)) s
++;
2837 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2841 while (isspace(*s
)) s
++;
2842 /* {-for-text-editors */
2843 if (*s
== '}') break;
2844 if (*s
!= '{') /* }-for-text-editors */
2846 expand_string_message
= string_sprintf("each subcondition "
2847 "inside an \"%s{...}\" condition must be in its own {}", name
);
2851 if (!(s
= eval_condition(s
+1, resetok
, subcondptr
)))
2853 expand_string_message
= string_sprintf("%s inside \"%s{...}\" condition",
2854 expand_string_message
, name
);
2857 while (isspace(*s
)) s
++;
2859 /* {-for-text-editors */
2862 /* {-for-text-editors */
2863 expand_string_message
= string_sprintf("missing } at end of condition "
2864 "inside \"%s\" group", name
);
2870 if (cond_type
== ECOND_AND
)
2872 combined_cond
&= tempcond
;
2873 if (!combined_cond
) subcondptr
= NULL
; /* once false, don't */
2874 } /* evaluate any more */
2877 combined_cond
|= tempcond
;
2878 if (combined_cond
) subcondptr
= NULL
; /* once true, don't */
2879 } /* evaluate any more */
2883 if (yield
!= NULL
) *yield
= (combined_cond
== testfor
);
2887 /* forall/forany: iterates a condition with different values */
2892 const uschar
* list
;
2894 uschar
*save_iterate_item
= iterate_item
;
2896 DEBUG(D_expand
) debug_printf("condition: %s\n", name
);
2898 while (isspace(*s
)) s
++;
2899 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2900 sub
[0] = expand_string_internal(s
, TRUE
, &s
, (yield
== NULL
), TRUE
, resetok
);
2901 if (sub
[0] == NULL
) return NULL
;
2902 /* {-for-text-editors */
2903 if (*s
++ != '}') goto COND_FAILED_CURLY_END
;
2905 while (isspace(*s
)) s
++;
2906 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2910 /* Call eval_condition once, with result discarded (as if scanning a
2911 "false" part). This allows us to find the end of the condition, because if
2912 the list it empty, we won't actually evaluate the condition for real. */
2914 if (!(s
= eval_condition(sub
[1], resetok
, NULL
)))
2916 expand_string_message
= string_sprintf("%s inside \"%s\" condition",
2917 expand_string_message
, name
);
2920 while (isspace(*s
)) s
++;
2922 /* {-for-text-editors */
2925 /* {-for-text-editors */
2926 expand_string_message
= string_sprintf("missing } at end of condition "
2927 "inside \"%s\"", name
);
2931 if (yield
!= NULL
) *yield
= !testfor
;
2933 while ((iterate_item
= string_nextinlist(&list
, &sep
, NULL
, 0)) != NULL
)
2935 DEBUG(D_expand
) debug_printf("%s: $item = \"%s\"\n", name
, iterate_item
);
2936 if (!eval_condition(sub
[1], resetok
, &tempcond
))
2938 expand_string_message
= string_sprintf("%s inside \"%s\" condition",
2939 expand_string_message
, name
);
2940 iterate_item
= save_iterate_item
;
2943 DEBUG(D_expand
) debug_printf("%s: condition evaluated to %s\n", name
,
2944 tempcond
? "true":"false");
2946 if (yield
!= NULL
) *yield
= (tempcond
== testfor
);
2947 if (tempcond
== (cond_type
== ECOND_FORANY
)) break;
2950 iterate_item
= save_iterate_item
;
2955 /* The bool{} expansion condition maps a string to boolean.
2956 The values supported should match those supported by the ACL condition
2957 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2958 of true/false. Note that Router "condition" rules have a different
2959 interpretation, where general data can be used and only a few values
2961 Note that readconf.c boolean matching, for boolean configuration options,
2962 only matches true/yes/false/no.
2963 The bool_lax{} condition matches the Router logic, which is much more
2966 case ECOND_BOOL_LAX
:
2972 BOOL boolvalue
= FALSE
;
2973 while (isspace(*s
)) s
++;
2974 if (*s
!= '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2975 ourname
= cond_type
== ECOND_BOOL_LAX
? US
"bool_lax" : US
"bool";
2976 switch(read_subs(sub_arg
, 1, 1, &s
, yield
== NULL
, FALSE
, ourname
, resetok
))
2978 case 1: expand_string_message
= string_sprintf(
2979 "too few arguments or bracketing error for %s",
2983 case 3: return NULL
;
2986 while (isspace(*t
)) t
++;
2990 /* trailing whitespace: seems like a good idea to ignore it too */
2992 while (isspace(*t2
)) t2
--;
2993 if (t2
!= (t
+ len
))
3000 debug_printf("considering %s: %s\n", ourname
, len
? t
: US
"<empty>");
3001 /* logic for the lax case from expand_check_condition(), which also does
3002 expands, and the logic is both short and stable enough that there should
3003 be no maintenance burden from replicating it. */
3007 ? Ustrspn(t
+1, "0123456789") == len
-1
3008 : Ustrspn(t
, "0123456789") == len
)
3010 boolvalue
= (Uatoi(t
) == 0) ? FALSE
: TRUE
;
3011 /* expand_check_condition only does a literal string "0" check */
3012 if ((cond_type
== ECOND_BOOL_LAX
) && (len
> 1))
3015 else if (strcmpic(t
, US
"true") == 0 || strcmpic(t
, US
"yes") == 0)
3017 else if (strcmpic(t
, US
"false") == 0 || strcmpic(t
, US
"no") == 0)
3019 else if (cond_type
== ECOND_BOOL_LAX
)
3023 expand_string_message
= string_sprintf("unrecognised boolean "
3027 if (yield
!= NULL
) *yield
= (boolvalue
== testfor
);
3031 /* Unknown condition */
3034 expand_string_message
= string_sprintf("unknown condition \"%s\"", name
);
3036 } /* End switch on condition type */
3038 /* Missing braces at start and end of data */
3040 COND_FAILED_CURLY_START
:
3041 expand_string_message
= string_sprintf("missing { after \"%s\"", name
);
3044 COND_FAILED_CURLY_END
:
3045 expand_string_message
= string_sprintf("missing } at end of \"%s\" condition",
3049 /* A condition requires code that is not compiled */
3051 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3052 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3053 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3054 COND_FAILED_NOT_COMPILED
:
3055 expand_string_message
= string_sprintf("support for \"%s\" not compiled",
3064 /*************************************************
3065 * Save numerical variables *
3066 *************************************************/
3068 /* This function is called from items such as "if" that want to preserve and
3069 restore the numbered variables.
3072 save_expand_string points to an array of pointers to set
3073 save_expand_nlength points to an array of ints for the lengths
3075 Returns: the value of expand max to save
3079 save_expand_strings(uschar
**save_expand_nstring
, int *save_expand_nlength
)
3082 for (i
= 0; i
<= expand_nmax
; i
++)
3084 save_expand_nstring
[i
] = expand_nstring
[i
];
3085 save_expand_nlength
[i
] = expand_nlength
[i
];
3092 /*************************************************
3093 * Restore numerical variables *
3094 *************************************************/
3096 /* This function restored saved values of numerical strings.
3099 save_expand_nmax the number of strings to restore
3100 save_expand_string points to an array of pointers
3101 save_expand_nlength points to an array of ints
3107 restore_expand_strings(int save_expand_nmax
, uschar
**save_expand_nstring
,
3108 int *save_expand_nlength
)
3111 expand_nmax
= save_expand_nmax
;
3112 for (i
= 0; i
<= expand_nmax
; i
++)
3114 expand_nstring
[i
] = save_expand_nstring
[i
];
3115 expand_nlength
[i
] = save_expand_nlength
[i
];
3123 /*************************************************
3124 * Handle yes/no substrings *
3125 *************************************************/
3127 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3128 alternative substrings that depend on whether or not the condition was true,
3129 or the lookup or extraction succeeded. The substrings always have to be
3130 expanded, to check their syntax, but "skipping" is set when the result is not
3131 needed - this avoids unnecessary nested lookups.
3134 skipping TRUE if we were skipping when this item was reached
3135 yes TRUE if the first string is to be used, else use the second
3136 save_lookup a value to put back into lookup_value before the 2nd expansion
3137 sptr points to the input string pointer
3138 yieldptr points to the output string pointer
3139 sizeptr points to the output string size
3140 ptrptr points to the output string pointer
3141 type "lookup" or "if" or "extract" or "run", for error message
3142 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3145 Returns: 0 OK; lookup_value has been reset to save_lookup
3147 2 expansion failed because of bracketing error
3151 process_yesno(BOOL skipping
, BOOL yes
, uschar
*save_lookup
, const uschar
**sptr
,
3152 uschar
**yieldptr
, int *sizeptr
, int *ptrptr
, uschar
*type
, BOOL
*resetok
)
3155 const uschar
*s
= *sptr
; /* Local value */
3156 uschar
*sub1
, *sub2
;
3158 /* If there are no following strings, we substitute the contents of $value for
3159 lookups and for extractions in the success case. For the ${if item, the string
3160 "true" is substituted. In the fail case, nothing is substituted for all three
3163 while (isspace(*s
)) s
++;
3168 if (yes
) *yieldptr
= string_cat(*yieldptr
, sizeptr
, ptrptr
, US
"true", 4);
3172 if (yes
&& lookup_value
!= NULL
)
3173 *yieldptr
= string_cat(*yieldptr
, sizeptr
, ptrptr
, lookup_value
,
3174 Ustrlen(lookup_value
));
3175 lookup_value
= save_lookup
;
3181 /* The first following string must be braced. */
3183 if (*s
++ != '{') goto FAILED_CURLY
;
3185 /* Expand the first substring. Forced failures are noticed only if we actually
3186 want this string. Set skipping in the call in the fail case (this will always
3187 be the case if we were already skipping). */
3189 sub1
= expand_string_internal(s
, TRUE
, &s
, !yes
, TRUE
, resetok
);
3190 if (sub1
== NULL
&& (yes
|| !expand_string_forcedfail
)) goto FAILED
;
3191 expand_string_forcedfail
= FALSE
;
3192 if (*s
++ != '}') goto FAILED_CURLY
;
3194 /* If we want the first string, add it to the output */
3197 *yieldptr
= string_cat(*yieldptr
, sizeptr
, ptrptr
, sub1
, Ustrlen(sub1
));
3199 /* If this is called from a lookup or an extract, we want to restore $value to
3200 what it was at the start of the item, so that it has this value during the
3201 second string expansion. For the call from "if" or "run" to this function,
3202 save_lookup is set to lookup_value, so that this statement does nothing. */
3204 lookup_value
= save_lookup
;
3206 /* There now follows either another substring, or "fail", or nothing. This
3207 time, forced failures are noticed only if we want the second string. We must
3208 set skipping in the nested call if we don't want this string, or if we were
3209 already skipping. */
3211 while (isspace(*s
)) s
++;
3214 sub2
= expand_string_internal(s
+1, TRUE
, &s
, yes
|| skipping
, TRUE
, resetok
);
3215 if (sub2
== NULL
&& (!yes
|| !expand_string_forcedfail
)) goto FAILED
;
3216 expand_string_forcedfail
= FALSE
;
3217 if (*s
++ != '}') goto FAILED_CURLY
;
3219 /* If we want the second string, add it to the output */
3222 *yieldptr
= string_cat(*yieldptr
, sizeptr
, ptrptr
, sub2
, Ustrlen(sub2
));
3225 /* If there is no second string, but the word "fail" is present when the use of
3226 the second string is wanted, set a flag indicating it was a forced failure
3227 rather than a syntactic error. Swallow the terminating } in case this is nested
3228 inside another lookup or if or extract. */
3233 /* deconst cast ok here as source is s anyway */
3234 s
= US
read_name(name
, sizeof(name
), s
, US
"_");
3235 if (Ustrcmp(name
, "fail") == 0)
3237 if (!yes
&& !skipping
)
3239 while (isspace(*s
)) s
++;
3240 if (*s
++ != '}') goto FAILED_CURLY
;
3241 expand_string_message
=
3242 string_sprintf("\"%s\" failed and \"fail\" requested", type
);
3243 expand_string_forcedfail
= TRUE
;
3249 expand_string_message
=
3250 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type
);
3255 /* All we have to do now is to check on the final closing brace. */
3257 while (isspace(*s
)) s
++;
3258 if (*s
++ == '}') goto RETURN
;
3260 /* Get here if there is a bracketing failure */
3265 /* Get here for other failures */
3270 /* Update the input pointer value before returning */
3280 /*************************************************
3281 * Handle MD5 or SHA-1 computation for HMAC *
3282 *************************************************/
3284 /* These are some wrapping functions that enable the HMAC code to be a bit
3285 cleaner. A good compiler will spot the tail recursion.
3288 type HMAC_MD5 or HMAC_SHA1
3289 remaining are as for the cryptographic hash functions
3295 chash_start(int type
, void *base
)
3297 if (type
== HMAC_MD5
)
3298 md5_start((md5
*)base
);
3300 sha1_start((sha1
*)base
);
3304 chash_mid(int type
, void *base
, uschar
*string
)
3306 if (type
== HMAC_MD5
)
3307 md5_mid((md5
*)base
, string
);
3309 sha1_mid((sha1
*)base
, string
);
3313 chash_end(int type
, void *base
, uschar
*string
, int length
, uschar
*digest
)
3315 if (type
== HMAC_MD5
)
3316 md5_end((md5
*)base
, string
, length
, digest
);
3318 sha1_end((sha1
*)base
, string
, length
, digest
);
3325 /********************************************************
3326 * prvs: Get last three digits of days since Jan 1, 1970 *
3327 ********************************************************/
3329 /* This is needed to implement the "prvs" BATV reverse
3332 Argument: integer "days" offset to add or substract to
3333 or from the current number of days.
3335 Returns: pointer to string containing the last three
3336 digits of the number of days since Jan 1, 1970,
3337 modified by the offset argument, NULL if there
3338 was an error in the conversion.
3343 prvs_daystamp(int day_offset
)
3345 uschar
*days
= store_get(32); /* Need at least 24 for cases */
3346 (void)string_format(days
, 32, TIME_T_FMT
, /* where TIME_T_FMT is %lld */
3347 (time(NULL
) + day_offset
*86400)/86400);
3348 return (Ustrlen(days
) >= 3) ? &days
[Ustrlen(days
)-3] : US
"100";
3353 /********************************************************
3354 * prvs: perform HMAC-SHA1 computation of prvs bits *
3355 ********************************************************/
3357 /* This is needed to implement the "prvs" BATV reverse
3361 address RFC2821 Address to use
3362 key The key to use (must be less than 64 characters
3364 key_num Single-digit key number to use. Defaults to
3367 Returns: pointer to string containing the first three
3368 bytes of the final hash in hex format, NULL if
3369 there was an error in the process.
3373 prvs_hmac_sha1(uschar
*address
, uschar
*key
, uschar
*key_num
, uschar
*daystamp
)
3375 uschar
*hash_source
, *p
;
3376 int size
= 0,offset
= 0,i
;
3378 void *use_base
= &sha1_base
;
3379 uschar innerhash
[20];
3380 uschar finalhash
[20];
3381 uschar innerkey
[64];
3382 uschar outerkey
[64];
3383 uschar
*finalhash_hex
= store_get(40);
3385 if (key_num
== NULL
)
3388 if (Ustrlen(key
) > 64)
3391 hash_source
= string_cat(NULL
,&size
,&offset
,key_num
,1);
3392 string_cat(hash_source
,&size
,&offset
,daystamp
,3);
3393 string_cat(hash_source
,&size
,&offset
,address
,Ustrlen(address
));
3394 hash_source
[offset
] = '\0';
3396 DEBUG(D_expand
) debug_printf("prvs: hash source is '%s'\n", hash_source
);
3398 memset(innerkey
, 0x36, 64);
3399 memset(outerkey
, 0x5c, 64);
3401 for (i
= 0; i
< Ustrlen(key
); i
++)
3403 innerkey
[i
] ^= key
[i
];
3404 outerkey
[i
] ^= key
[i
];
3407 chash_start(HMAC_SHA1
, use_base
);
3408 chash_mid(HMAC_SHA1
, use_base
, innerkey
);
3409 chash_end(HMAC_SHA1
, use_base
, hash_source
, offset
, innerhash
);
3411 chash_start(HMAC_SHA1
, use_base
);
3412 chash_mid(HMAC_SHA1
, use_base
, outerkey
);
3413 chash_end(HMAC_SHA1
, use_base
, innerhash
, 20, finalhash
);
3416 for (i
= 0; i
< 3; i
++)
3418 *p
++ = hex_digits
[(finalhash
[i
] & 0xf0) >> 4];
3419 *p
++ = hex_digits
[finalhash
[i
] & 0x0f];
3423 return finalhash_hex
;
3429 /*************************************************
3430 * Join a file onto the output string *
3431 *************************************************/
3433 /* This is used for readfile and after a run expansion. It joins the contents
3434 of a file onto the output string, globally replacing newlines with a given
3435 string (optionally). The file is closed at the end.
3439 yield pointer to the expandable string
3440 sizep pointer to the current size
3441 ptrp pointer to the current position
3442 eol newline replacement string, or NULL
3444 Returns: new value of string pointer
3448 cat_file(FILE *f
, uschar
*yield
, int *sizep
, int *ptrp
, uschar
*eol
)
3451 uschar buffer
[1024];
3453 eollen
= (eol
== NULL
)? 0 : Ustrlen(eol
);
3455 while (Ufgets(buffer
, sizeof(buffer
), f
) != NULL
)
3457 int len
= Ustrlen(buffer
);
3458 if (eol
!= NULL
&& buffer
[len
-1] == '\n') len
--;
3459 yield
= string_cat(yield
, sizep
, ptrp
, buffer
, len
);
3460 if (buffer
[len
] != 0)
3461 yield
= string_cat(yield
, sizep
, ptrp
, eol
, eollen
);
3464 if (yield
!= NULL
) yield
[*ptrp
] = 0;
3472 /*************************************************
3473 * Evaluate numeric expression *
3474 *************************************************/
3476 /* This is a set of mutually recursive functions that evaluate an arithmetic
3477 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3478 these functions that is called from elsewhere is eval_expr, whose interface is:
3481 sptr pointer to the pointer to the string - gets updated
3482 decimal TRUE if numbers are to be assumed decimal
3483 error pointer to where to put an error message - must be NULL on input
3484 endket TRUE if ')' must terminate - FALSE for external call
3486 Returns: on success: the value of the expression, with *error still NULL
3487 on failure: an undefined value, with *error = a message
3490 static int_eximarith_t
eval_op_or(uschar
**, BOOL
, uschar
**);
3493 static int_eximarith_t
3494 eval_expr(uschar
**sptr
, BOOL decimal
, uschar
**error
, BOOL endket
)
3497 int_eximarith_t x
= eval_op_or(&s
, decimal
, error
);
3503 *error
= US
"expecting closing parenthesis";
3505 while (isspace(*(++s
)));
3507 else if (*s
!= 0) *error
= US
"expecting operator";
3514 static int_eximarith_t
3515 eval_number(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3520 while (isspace(*s
)) s
++;
3525 (void)sscanf(CS s
, (decimal
? SC_EXIM_DEC
"%n" : SC_EXIM_ARITH
"%n"), &n
, &count
);
3527 switch (tolower(*s
))
3530 case 'k': n
*= 1024; s
++; break;
3531 case 'm': n
*= 1024*1024; s
++; break;
3532 case 'g': n
*= 1024*1024*1024; s
++; break;
3534 while (isspace (*s
)) s
++;
3539 n
= eval_expr(&s
, decimal
, error
, 1);
3543 *error
= US
"expecting number or opening parenthesis";
3551 static int_eximarith_t
3552 eval_op_unary(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3556 while (isspace(*s
)) s
++;
3557 if (*s
== '+' || *s
== '-' || *s
== '~')
3560 x
= eval_op_unary(&s
, decimal
, error
);
3561 if (op
== '-') x
= -x
;
3562 else if (op
== '~') x
= ~x
;
3566 x
= eval_number(&s
, decimal
, error
);
3573 static int_eximarith_t
3574 eval_op_mult(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3577 int_eximarith_t x
= eval_op_unary(&s
, decimal
, error
);
3580 while (*s
== '*' || *s
== '/' || *s
== '%')
3583 int_eximarith_t y
= eval_op_unary(&s
, decimal
, error
);
3584 if (*error
!= NULL
) break;
3585 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3586 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3587 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3588 * -N*M is INT_MIN will yielf INT_MIN.
3589 * Since we don't support floating point, this is somewhat simpler.
3590 * Ideally, we'd return an error, but since we overflow for all other
3591 * arithmetic, consistency suggests otherwise, but what's the correct value
3592 * to use? There is none.
3593 * The C standard guarantees overflow for unsigned arithmetic but signed
3594 * overflow invokes undefined behaviour; in practice, this is overflow
3595 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3596 * that long/longlong larger than int are available, or we could just work
3597 * with larger types. We should consider whether to guarantee 32bit eval
3598 * and 64-bit working variables, with errors returned. For now ...
3599 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3600 * can just let the other invalid results occur otherwise, as they have
3601 * until now. For this one case, we can coerce.
3603 if (y
== -1 && x
== EXIM_ARITH_MIN
&& op
!= '*')
3606 debug_printf("Integer exception dodging: " PR_EXIM_ARITH
"%c-1 coerced to " PR_EXIM_ARITH
"\n",
3607 EXIM_ARITH_MIN
, op
, EXIM_ARITH_MAX
);
3617 *error
= (op
== '/') ? US
"divide by zero" : US
"modulo by zero";
3633 static int_eximarith_t
3634 eval_op_sum(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3637 int_eximarith_t x
= eval_op_mult(&s
, decimal
, error
);
3640 while (*s
== '+' || *s
== '-')
3643 int_eximarith_t y
= eval_op_mult(&s
, decimal
, error
);
3644 if (*error
!= NULL
) break;
3645 if (op
== '+') x
+= y
; else x
-= y
;
3653 static int_eximarith_t
3654 eval_op_shift(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3657 int_eximarith_t x
= eval_op_sum(&s
, decimal
, error
);
3660 while ((*s
== '<' || *s
== '>') && s
[1] == s
[0])
3665 y
= eval_op_sum(&s
, decimal
, error
);
3666 if (*error
!= NULL
) break;
3667 if (op
== '<') x
<<= y
; else x
>>= y
;
3675 static int_eximarith_t
3676 eval_op_and(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3679 int_eximarith_t x
= eval_op_shift(&s
, decimal
, error
);
3686 y
= eval_op_shift(&s
, decimal
, error
);
3687 if (*error
!= NULL
) break;
3696 static int_eximarith_t
3697 eval_op_xor(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3700 int_eximarith_t x
= eval_op_and(&s
, decimal
, error
);
3707 y
= eval_op_and(&s
, decimal
, error
);
3708 if (*error
!= NULL
) break;
3717 static int_eximarith_t
3718 eval_op_or(uschar
**sptr
, BOOL decimal
, uschar
**error
)
3721 int_eximarith_t x
= eval_op_xor(&s
, decimal
, error
);
3728 y
= eval_op_xor(&s
, decimal
, error
);
3729 if (*error
!= NULL
) break;
3739 /*************************************************
3741 *************************************************/
3743 /* Returns either an unchanged string, or the expanded string in stacking pool
3744 store. Interpreted sequences are:
3746 \... normal escaping rules
3747 $name substitutes the variable
3749 ${op:string} operates on the expanded string value
3750 ${item{arg1}{arg2}...} expands the args and then does the business
3751 some literal args are not enclosed in {}
3753 There are now far too many operators and item types to make it worth listing
3754 them here in detail any more.
3756 We use an internal routine recursively to handle embedded substrings. The
3757 external function follows. The yield is NULL if the expansion failed, and there
3758 are two cases: if something collapsed syntactically, or if "fail" was given
3759 as the action on a lookup failure. These can be distinguised by looking at the
3760 variable expand_string_forcedfail, which is TRUE in the latter case.
3762 The skipping flag is set true when expanding a substring that isn't actually
3763 going to be used (after "if" or "lookup") and it prevents lookups from
3764 happening lower down.
3766 Store usage: At start, a store block of the length of the input plus 64
3767 is obtained. This is expanded as necessary by string_cat(), which might have to
3768 get a new block, or might be able to expand the original. At the end of the
3769 function we can release any store above that portion of the yield block that
3770 was actually used. In many cases this will be optimal.
3772 However: if the first item in the expansion is a variable name or header name,
3773 we reset the store before processing it; if the result is in fresh store, we
3774 use that without copying. This is helpful for expanding strings like
3775 $message_headers which can get very long.
3777 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3778 since resetting the store at the end of the expansion will free store that was
3779 allocated by the plugin code as well as the slop after the expanded string. So
3780 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3781 and, given the acl condition, ${if }. This is an unfortunate consequence of
3782 string expansion becoming too powerful.
3785 string the string to be expanded
3786 ket_ends true if expansion is to stop at }
3787 left if not NULL, a pointer to the first character after the
3788 expansion is placed here (typically used with ket_ends)
3789 skipping TRUE for recursive calls when the value isn't actually going
3790 to be used (to allow for optimisation)
3791 honour_dollar TRUE if $ is to be expanded,
3792 FALSE if it's just another character
3793 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3796 Returns: NULL if expansion fails:
3797 expand_string_forcedfail is set TRUE if failure was forced
3798 expand_string_message contains a textual error message
3799 a pointer to the expanded string on success
3803 expand_string_internal(const uschar
*string
, BOOL ket_ends
, const uschar
**left
,
3804 BOOL skipping
, BOOL honour_dollar
, BOOL
*resetok_p
)
3807 int size
= Ustrlen(string
)+ 64;
3809 uschar
*yield
= store_get(size
);
3810 const uschar
*s
= string
;
3811 uschar
*save_expand_nstring
[EXPAND_MAXN
+1];
3812 int save_expand_nlength
[EXPAND_MAXN
+1];
3813 BOOL resetok
= TRUE
;
3815 expand_string_forcedfail
= FALSE
;
3816 expand_string_message
= US
"";
3823 /* \ escapes the next character, which must exist, or else
3824 the expansion fails. There's a special escape, \N, which causes
3825 copying of the subject verbatim up to the next \N. Otherwise,
3826 the escapes are the standard set. */
3832 expand_string_message
= US
"\\ at end of string";
3838 const uschar
* t
= s
+ 2;
3839 for (s
= t
; *s
!= 0; s
++) if (*s
== '\\' && s
[1] == 'N') break;
3840 yield
= string_cat(yield
, &size
, &ptr
, t
, s
- t
);
3841 if (*s
!= 0) s
+= 2;
3847 ch
[0] = string_interpret_escape(&s
);
3849 yield
= string_cat(yield
, &size
, &ptr
, ch
, 1);
3856 /* Anything other than $ is just copied verbatim, unless we are
3857 looking for a terminating } character. */
3860 if (ket_ends
&& *s
== '}') break;
3862 if (*s
!= '$' || !honour_dollar
)
3864 yield
= string_cat(yield
, &size
, &ptr
, s
++, 1);
3868 /* No { after the $ - must be a plain name or a number for string
3869 match variable. There has to be a fudge for variables that are the
3870 names of header fields preceded by "$header_" because header field
3871 names can contain any printing characters except space and colon.
3872 For those that don't like typing this much, "$h_" is a synonym for
3873 "$header_". A non-existent header yields a NULL value; nothing is
3876 if (isalpha((*(++s
))))
3881 s
= read_name(name
, sizeof(name
), s
, US
"_");
3883 /* If this is the first thing to be expanded, release the pre-allocated
3886 if (ptr
== 0 && yield
!= NULL
)
3888 if (resetok
) store_reset(yield
);
3895 if (Ustrncmp(name
, "h_", 2) == 0 ||
3896 Ustrncmp(name
, "rh_", 3) == 0 ||
3897 Ustrncmp(name
, "bh_", 3) == 0 ||
3898 Ustrncmp(name
, "header_", 7) == 0 ||
3899 Ustrncmp(name
, "rheader_", 8) == 0 ||
3900 Ustrncmp(name
, "bheader_", 8) == 0)
3902 BOOL want_raw
= (name
[0] == 'r')? TRUE
: FALSE
;
3903 uschar
*charset
= (name
[0] == 'b')? NULL
: headers_charset
;
3904 s
= read_header_name(name
, sizeof(name
), s
);
3905 value
= find_header(name
, FALSE
, &newsize
, want_raw
, charset
);
3907 /* If we didn't find the header, and the header contains a closing brace
3908 character, this may be a user error where the terminating colon
3909 has been omitted. Set a flag to adjust the error message in this case.
3910 But there is no error here - nothing gets inserted. */
3914 if (Ustrchr(name
, '}') != NULL
) malformed_header
= TRUE
;
3923 value
= find_variable(name
, FALSE
, skipping
, &newsize
);
3926 expand_string_message
=
3927 string_sprintf("unknown variable name \"%s\"", name
);
3928 check_variable_error_message(name
);
3933 /* If the data is known to be in a new buffer, newsize will be set to the
3934 size of that buffer. If this is the first thing in an expansion string,
3935 yield will be NULL; just point it at the new store instead of copying. Many
3936 expansion strings contain just one reference, so this is a useful
3937 optimization, especially for humungous headers. */
3939 len
= Ustrlen(value
);
3940 if (yield
== NULL
&& newsize
!= 0)
3946 else yield
= string_cat(yield
, &size
, &ptr
, value
, len
);
3954 s
= read_cnumber(&n
, s
);
3955 if (n
>= 0 && n
<= expand_nmax
)
3956 yield
= string_cat(yield
, &size
, &ptr
, expand_nstring
[n
],
3961 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3963 if (*s
!= '{') /*}*/
3965 expand_string_message
= US
"$ not followed by letter, digit, or {"; /*}*/
3969 /* After { there can be various things, but they all start with
3970 an initial word, except for a number for a string match variable. */
3972 if (isdigit((*(++s
))))
3975 s
= read_cnumber(&n
, s
); /*{*/
3978 expand_string_message
= US
"} expected after number";
3981 if (n
>= 0 && n
<= expand_nmax
)
3982 yield
= string_cat(yield
, &size
, &ptr
, expand_nstring
[n
],
3989 expand_string_message
= US
"letter or digit expected after ${"; /*}*/
3993 /* Allow "-" in names to cater for substrings with negative
3994 arguments. Since we are checking for known names after { this is
3997 s
= read_name(name
, sizeof(name
), s
, US
"_-");
3998 item_type
= chop_match(name
, item_table
, nelem(item_table
));
4002 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
4003 If the ACL returns accept or reject we return content set by "message ="
4004 There is currently no limit on recursion; this would have us call
4005 acl_check_internal() directly and get a current level from somewhere.
4006 See also the acl expansion condition ECOND_ACL and the traditional
4007 acl modifier ACLC_ACL.
4008 Assume that the function has side-effects on the store that must be preserved.
4012 /* ${acl {name} {arg1}{arg2}...} */
4014 uschar
*sub
[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4017 switch(read_subs(sub
, nelem(sub
), 1, &s
, skipping
, TRUE
, US
"acl",
4020 case 1: goto EXPAND_FAILED_CURLY
;
4022 case 3: goto EXPAND_FAILED
;
4024 if (skipping
) continue;
4027 switch(eval_acl(sub
, nelem(sub
), &user_msg
))
4032 debug_printf("acl expansion yield: %s\n", user_msg
);
4034 yield
= string_cat(yield
, &size
, &ptr
, user_msg
, Ustrlen(user_msg
));
4038 expand_string_forcedfail
= TRUE
;
4040 expand_string_message
= string_sprintf("error from acl \"%s\"", sub
[0]);
4045 /* Handle conditionals - preserve the values of the numerical expansion
4046 variables in case they get changed by a regular expression match in the
4047 condition. If not, they retain their external settings. At the end
4048 of this "if" section, they get restored to their previous values. */
4053 const uschar
*next_s
;
4054 int save_expand_nmax
=
4055 save_expand_strings(save_expand_nstring
, save_expand_nlength
);
4057 while (isspace(*s
)) s
++;
4058 next_s
= eval_condition(s
, &resetok
, skipping
? NULL
: &cond
);
4059 if (next_s
== NULL
) goto EXPAND_FAILED
; /* message already set */
4062 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s
- s
), s
,
4063 cond
? "true" : "false");
4067 /* The handling of "yes" and "no" result strings is now in a separate
4068 function that is also used by ${lookup} and ${extract} and ${run}. */
4070 switch(process_yesno(
4071 skipping
, /* were previously skipping */
4072 cond
, /* success/failure indicator */
4073 lookup_value
, /* value to reset for string2 */
4074 &s
, /* input pointer */
4075 &yield
, /* output pointer */
4076 &size
, /* output size */
4077 &ptr
, /* output current point */
4078 US
"if", /* condition type */
4081 case 1: goto EXPAND_FAILED
; /* when all is well, the */
4082 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
4085 /* Restore external setting of expansion variables for continuation
4088 restore_expand_strings(save_expand_nmax
, save_expand_nstring
,
4089 save_expand_nlength
);
4093 #ifdef EXPERIMENTAL_INTERNATIONAL
4094 case EITEM_IMAPFOLDER
:
4095 { /* ${imapfolder {name}{sep]{specials}} */
4099 switch(read_subs(sub_arg
, nelem(sub_arg
), 1, &s
, skipping
, TRUE
, name
,
4102 case 1: goto EXPAND_FAILED_CURLY
;
4104 case 3: goto EXPAND_FAILED
;
4107 if (sub_arg
[1] == NULL
) /* One argument */
4109 sub_arg
[1] = US
"/"; /* default separator */
4112 else if (Ustrlen(sub_arg
[1]) != 1)
4114 expand_string_message
=
4116 "IMAP folder separator must be one character, found \"%s\"",
4121 if (!(encoded
= imap_utf7_encode(sub_arg
[0], headers_charset
,
4122 sub_arg
[1][0], sub_arg
[2], &expand_string_message
)))
4125 yield
= string_cat(yield
, &size
, &ptr
, encoded
, Ustrlen(encoded
));
4130 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4131 expanding an internal string that isn't actually going to be used. All we
4132 need to do is check the syntax, so don't do a lookup at all. Preserve the
4133 values of the numerical expansion variables in case they get changed by a
4134 partial lookup. If not, they retain their external settings. At the end
4135 of this "lookup" section, they get restored to their previous values. */
4139 int stype
, partial
, affixlen
, starflags
;
4140 int expand_setup
= 0;
4142 uschar
*key
, *filename
;
4143 const uschar
*affix
;
4144 uschar
*save_lookup_value
= lookup_value
;
4145 int save_expand_nmax
=
4146 save_expand_strings(save_expand_nstring
, save_expand_nlength
);
4148 if ((expand_forbid
& RDO_LOOKUP
) != 0)
4150 expand_string_message
= US
"lookup expansions are not permitted";
4154 /* Get the key we are to look up for single-key+file style lookups.
4155 Otherwise set the key NULL pro-tem. */
4157 while (isspace(*s
)) s
++;
4158 if (*s
== '{') /*}*/
4160 key
= expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
4161 if (key
== NULL
) goto EXPAND_FAILED
; /*{*/
4162 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
4163 while (isspace(*s
)) s
++;
4167 /* Find out the type of database */
4171 expand_string_message
= US
"missing lookup type";
4175 /* The type is a string that may contain special characters of various
4176 kinds. Allow everything except space or { to appear; the actual content
4177 is checked by search_findtype_partial. */ /*}*/
4179 while (*s
!= 0 && *s
!= '{' && !isspace(*s
)) /*}*/
4181 if (nameptr
< sizeof(name
) - 1) name
[nameptr
++] = *s
;
4185 while (isspace(*s
)) s
++;
4187 /* Now check for the individual search type and any partial or default
4188 options. Only those types that are actually in the binary are valid. */
4190 stype
= search_findtype_partial(name
, &partial
, &affix
, &affixlen
,
4194 expand_string_message
= search_error_message
;
4198 /* Check that a key was provided for those lookup types that need it,
4199 and was not supplied for those that use the query style. */
4201 if (!mac_islookup(stype
, lookup_querystyle
|lookup_absfilequery
))
4205 expand_string_message
= string_sprintf("missing {key} for single-"
4206 "key \"%s\" lookup", name
);
4214 expand_string_message
= string_sprintf("a single key was given for "
4215 "lookup type \"%s\", which is not a single-key lookup type", name
);
4220 /* Get the next string in brackets and expand it. It is the file name for
4221 single-key+file lookups, and the whole query otherwise. In the case of
4222 queries that also require a file name (e.g. sqlite), the file name comes
4225 if (*s
!= '{') goto EXPAND_FAILED_CURLY
;
4226 filename
= expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
4227 if (filename
== NULL
) goto EXPAND_FAILED
;
4228 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
4229 while (isspace(*s
)) s
++;
4231 /* If this isn't a single-key+file lookup, re-arrange the variables
4232 to be appropriate for the search_ functions. For query-style lookups,
4233 there is just a "key", and no file name. For the special query-style +
4234 file types, the query (i.e. "key") starts with a file name. */
4238 while (isspace(*filename
)) filename
++;
4241 if (mac_islookup(stype
, lookup_querystyle
))
4247 if (*filename
!= '/')
4249 expand_string_message
= string_sprintf(
4250 "absolute file name expected for \"%s\" lookup", name
);
4253 while (*key
!= 0 && !isspace(*key
)) key
++;
4254 if (*key
!= 0) *key
++ = 0;
4258 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4259 the entry was not found. Note that there is no search_close() function.
4260 Files are left open in case of re-use. At suitable places in higher logic,
4261 search_tidyup() is called to tidy all open files. This can save opening
4262 the same file several times. However, files may also get closed when
4263 others are opened, if too many are open at once. The rule is that a
4264 handle should not be used after a second search_open().
4266 Request that a partial search sets up $1 and maybe $2 by passing
4267 expand_setup containing zero. If its value changes, reset expand_nmax,
4268 since new variables will have been set. Note that at the end of this
4269 "lookup" section, the old numeric variables are restored. */
4272 lookup_value
= NULL
;
4275 void *handle
= search_open(filename
, stype
, 0, NULL
, NULL
);
4278 expand_string_message
= search_error_message
;
4281 lookup_value
= search_find(handle
, filename
, key
, partial
, affix
,
4282 affixlen
, starflags
, &expand_setup
);
4283 if (search_find_defer
)
4285 expand_string_message
=
4286 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4287 string_printing2(key
, FALSE
), search_error_message
);
4290 if (expand_setup
> 0) expand_nmax
= expand_setup
;
4293 /* The handling of "yes" and "no" result strings is now in a separate
4294 function that is also used by ${if} and ${extract}. */
4296 switch(process_yesno(
4297 skipping
, /* were previously skipping */
4298 lookup_value
!= NULL
, /* success/failure indicator */
4299 save_lookup_value
, /* value to reset for string2 */
4300 &s
, /* input pointer */
4301 &yield
, /* output pointer */
4302 &size
, /* output size */
4303 &ptr
, /* output current point */
4304 US
"lookup", /* condition type */
4307 case 1: goto EXPAND_FAILED
; /* when all is well, the */
4308 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
4311 /* Restore external setting of expansion variables for carrying on
4312 at this level, and continue. */
4314 restore_expand_strings(save_expand_nmax
, save_expand_nstring
,
4315 save_expand_nlength
);
4319 /* If Perl support is configured, handle calling embedded perl subroutines,
4320 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4321 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4322 arguments (defined below). */
4324 #define EXIM_PERL_MAX_ARGS 8
4328 expand_string_message
= US
"\"${perl\" encountered, but this facility " /*}*/
4329 "is not included in this binary";
4332 #else /* EXIM_PERL */
4334 uschar
*sub_arg
[EXIM_PERL_MAX_ARGS
+ 2];
4337 if ((expand_forbid
& RDO_PERL
) != 0)
4339 expand_string_message
= US
"Perl calls are not permitted";
4343 switch(read_subs(sub_arg
, EXIM_PERL_MAX_ARGS
+ 1, 1, &s
, skipping
, TRUE
,
4344 US
"perl", &resetok
))
4346 case 1: goto EXPAND_FAILED_CURLY
;
4348 case 3: goto EXPAND_FAILED
;
4351 /* If skipping, we don't actually do anything */
4353 if (skipping
) continue;
4355 /* Start the interpreter if necessary */
4357 if (!opt_perl_started
)
4360 if (opt_perl_startup
== NULL
)
4362 expand_string_message
= US
"A setting of perl_startup is needed when "
4363 "using the Perl interpreter";
4366 DEBUG(D_any
) debug_printf("Starting Perl interpreter\n");
4367 initerror
= init_perl(opt_perl_startup
);
4368 if (initerror
!= NULL
)
4370 expand_string_message
=
4371 string_sprintf("error in perl_startup code: %s\n", initerror
);
4374 opt_perl_started
= TRUE
;
4377 /* Call the function */
4379 sub_arg
[EXIM_PERL_MAX_ARGS
+ 1] = NULL
;
4380 new_yield
= call_perl_cat(yield
, &size
, &ptr
, &expand_string_message
,
4381 sub_arg
[0], sub_arg
+ 1);
4383 /* NULL yield indicates failure; if the message pointer has been set to
4384 NULL, the yield was undef, indicating a forced failure. Otherwise the
4385 message will indicate some kind of Perl error. */
4387 if (new_yield
== NULL
)
4389 if (expand_string_message
== NULL
)
4391 expand_string_message
=
4392 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4393 "failure", sub_arg
[0]);
4394 expand_string_forcedfail
= TRUE
;
4399 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4400 set during a callback from Perl. */
4402 expand_string_forcedfail
= FALSE
;
4406 #endif /* EXIM_PERL */
4408 /* Transform email address to "prvs" scheme to use
4409 as BATV-signed return path */
4416 switch(read_subs(sub_arg
, 3, 2, &s
, skipping
, TRUE
, US
"prvs", &resetok
))
4418 case 1: goto EXPAND_FAILED_CURLY
;
4420 case 3: goto EXPAND_FAILED
;
4423 /* If skipping, we don't actually do anything */
4424 if (skipping
) continue;
4426 /* sub_arg[0] is the address */
4427 domain
= Ustrrchr(sub_arg
[0],'@');
4428 if ( (domain
== NULL
) || (domain
== sub_arg
[0]) || (Ustrlen(domain
) == 1) )
4430 expand_string_message
= US
"prvs first argument must be a qualified email address";
4434 /* Calculate the hash. The second argument must be a single-digit
4435 key number, or unset. */
4437 if (sub_arg
[2] != NULL
&&
4438 (!isdigit(sub_arg
[2][0]) || sub_arg
[2][1] != 0))
4440 expand_string_message
= US
"prvs second argument must be a single digit";
4444 p
= prvs_hmac_sha1(sub_arg
[0],sub_arg
[1],sub_arg
[2],prvs_daystamp(7));
4447 expand_string_message
= US
"prvs hmac-sha1 conversion failed";
4451 /* Now separate the domain from the local part */
4454 yield
= string_cat(yield
,&size
,&ptr
,US
"prvs=",5);
4455 string_cat(yield
,&size
,&ptr
,(sub_arg
[2] != NULL
) ? sub_arg
[2] : US
"0", 1);
4456 string_cat(yield
,&size
,&ptr
,prvs_daystamp(7),3);
4457 string_cat(yield
,&size
,&ptr
,p
,6);
4458 string_cat(yield
,&size
,&ptr
,US
"=",1);
4459 string_cat(yield
,&size
,&ptr
,sub_arg
[0],Ustrlen(sub_arg
[0]));
4460 string_cat(yield
,&size
,&ptr
,US
"@",1);
4461 string_cat(yield
,&size
,&ptr
,domain
,Ustrlen(domain
));
4466 /* Check a prvs-encoded address for validity */
4468 case EITEM_PRVSCHECK
:
4471 int mysize
= 0, myptr
= 0;
4475 /* TF: Ugliness: We want to expand parameter 1 first, then set
4476 up expansion variables that are used in the expansion of
4477 parameter 2. So we clone the string for the first
4478 expansion, where we only expand parameter 1.
4480 PH: Actually, that isn't necessary. The read_subs() function is
4481 designed to work this way for the ${if and ${lookup expansions. I've
4485 /* Reset expansion variables */
4486 prvscheck_result
= NULL
;
4487 prvscheck_address
= NULL
;
4488 prvscheck_keynum
= NULL
;
4490 switch(read_subs(sub_arg
, 1, 1, &s
, skipping
, FALSE
, US
"prvs", &resetok
))
4492 case 1: goto EXPAND_FAILED_CURLY
;
4494 case 3: goto EXPAND_FAILED
;
4497 re
= regex_must_compile(US
"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4500 if (regex_match_and_setup(re
,sub_arg
[0],0,-1))
4502 uschar
*local_part
= string_copyn(expand_nstring
[4],expand_nlength
[4]);
4503 uschar
*key_num
= string_copyn(expand_nstring
[1],expand_nlength
[1]);
4504 uschar
*daystamp
= string_copyn(expand_nstring
[2],expand_nlength
[2]);
4505 uschar
*hash
= string_copyn(expand_nstring
[3],expand_nlength
[3]);
4506 uschar
*domain
= string_copyn(expand_nstring
[5],expand_nlength
[5]);
4508 DEBUG(D_expand
) debug_printf("prvscheck localpart: %s\n", local_part
);
4509 DEBUG(D_expand
) debug_printf("prvscheck key number: %s\n", key_num
);
4510 DEBUG(D_expand
) debug_printf("prvscheck daystamp: %s\n", daystamp
);
4511 DEBUG(D_expand
) debug_printf("prvscheck hash: %s\n", hash
);
4512 DEBUG(D_expand
) debug_printf("prvscheck domain: %s\n", domain
);
4514 /* Set up expansion variables */
4515 prvscheck_address
= string_cat(NULL
, &mysize
, &myptr
, local_part
, Ustrlen(local_part
));
4516 string_cat(prvscheck_address
,&mysize
,&myptr
,US
"@",1);
4517 string_cat(prvscheck_address
,&mysize
,&myptr
,domain
,Ustrlen(domain
));
4518 prvscheck_address
[myptr
] = '\0';
4519 prvscheck_keynum
= string_copy(key_num
);
4521 /* Now expand the second argument */
4522 switch(read_subs(sub_arg
, 1, 1, &s
, skipping
, FALSE
, US
"prvs", &resetok
))
4524 case 1: goto EXPAND_FAILED_CURLY
;
4526 case 3: goto EXPAND_FAILED
;
4529 /* Now we have the key and can check the address. */
4531 p
= prvs_hmac_sha1(prvscheck_address
, sub_arg
[0], prvscheck_keynum
,
4536 expand_string_message
= US
"hmac-sha1 conversion failed";
4540 DEBUG(D_expand
) debug_printf("prvscheck: received hash is %s\n", hash
);
4541 DEBUG(D_expand
) debug_printf("prvscheck: own hash is %s\n", p
);
4543 if (Ustrcmp(p
,hash
) == 0)
4545 /* Success, valid BATV address. Now check the expiry date. */
4546 uschar
*now
= prvs_daystamp(0);
4547 unsigned int inow
= 0,iexpire
= 1;
4549 (void)sscanf(CS now
,"%u",&inow
);
4550 (void)sscanf(CS daystamp
,"%u",&iexpire
);
4552 /* When "iexpire" is < 7, a "flip" has occured.
4553 Adjust "inow" accordingly. */
4554 if ( (iexpire
< 7) && (inow
>= 993) ) inow
= 0;
4556 if (iexpire
>= inow
)
4558 prvscheck_result
= US
"1";
4559 DEBUG(D_expand
) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4563 prvscheck_result
= NULL
;
4564 DEBUG(D_expand
) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4569 prvscheck_result
= NULL
;
4570 DEBUG(D_expand
) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4573 /* Now expand the final argument. We leave this till now so that
4574 it can include $prvscheck_result. */
4576 switch(read_subs(sub_arg
, 1, 0, &s
, skipping
, TRUE
, US
"prvs", &resetok
))
4578 case 1: goto EXPAND_FAILED_CURLY
;
4580 case 3: goto EXPAND_FAILED
;
4583 if (sub_arg
[0] == NULL
|| *sub_arg
[0] == '\0')
4584 yield
= string_cat(yield
,&size
,&ptr
,prvscheck_address
,Ustrlen(prvscheck_address
));
4586 yield
= string_cat(yield
,&size
,&ptr
,sub_arg
[0],Ustrlen(sub_arg
[0]));
4588 /* Reset the "internal" variables afterwards, because they are in
4589 dynamic store that will be reclaimed if the expansion succeeded. */
4591 prvscheck_address
= NULL
;
4592 prvscheck_keynum
= NULL
;
4596 /* Does not look like a prvs encoded address, return the empty string.
4597 We need to make sure all subs are expanded first, so as to skip over
4600 switch(read_subs(sub_arg
, 2, 1, &s
, skipping
, TRUE
, US
"prvs", &resetok
))
4602 case 1: goto EXPAND_FAILED_CURLY
;
4604 case 3: goto EXPAND_FAILED
;
4611 /* Handle "readfile" to insert an entire file */
4613 case EITEM_READFILE
:
4618 if ((expand_forbid
& RDO_READFILE
) != 0)
4620 expand_string_message
= US
"file insertions are not permitted";
4624 switch(read_subs(sub_arg
, 2, 1, &s
, skipping
, TRUE
, US
"readfile", &resetok
))
4626 case 1: goto EXPAND_FAILED_CURLY
;
4628 case 3: goto EXPAND_FAILED
;
4631 /* If skipping, we don't actually do anything */
4633 if (skipping
) continue;
4635 /* Open the file and read it */
4637 f
= Ufopen(sub_arg
[0], "rb");
4640 expand_string_message
= string_open_failed(errno
, "%s", sub_arg
[0]);
4644 yield
= cat_file(f
, yield
, &size
, &ptr
, sub_arg
[1]);
4649 /* Handle "readsocket" to insert data from a Unix domain socket */
4651 case EITEM_READSOCK
:
4657 struct sockaddr_un sockun
; /* don't call this "sun" ! */
4661 if ((expand_forbid
& RDO_READSOCK
) != 0)
4663 expand_string_message
= US
"socket insertions are not permitted";
4667 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4668 because there may be a string for expansion on failure. */
4670 switch(read_subs(sub_arg
, 4, 2, &s
, skipping
, FALSE
, US
"readsocket", &resetok
))
4672 case 1: goto EXPAND_FAILED_CURLY
;
4673 case 2: /* Won't occur: no end check */
4674 case 3: goto EXPAND_FAILED
;
4677 /* Sort out timeout, if given */
4679 if (sub_arg
[2] != NULL
)
4681 timeout
= readconf_readtime(sub_arg
[2], 0, FALSE
);
4684 expand_string_message
= string_sprintf("bad time value %s",
4689 else sub_arg
[3] = NULL
; /* No eol if no timeout */
4691 /* If skipping, we don't actually do anything. Otherwise, arrange to
4692 connect to either an IP or a Unix socket. */
4696 /* Handle an IP (internet) domain */
4698 if (Ustrncmp(sub_arg
[0], "inet:", 5) == 0)
4701 uschar
*server_name
= sub_arg
[0] + 5;
4702 uschar
*port_name
= Ustrrchr(server_name
, ':');
4704 /* Sort out the port */
4706 if (port_name
== NULL
)
4708 expand_string_message
=
4709 string_sprintf("missing port for readsocket %s", sub_arg
[0]);
4712 *port_name
++ = 0; /* Terminate server name */
4714 if (isdigit(*port_name
))
4717 port
= Ustrtol(port_name
, &end
, 0);
4718 if (end
!= port_name
+ Ustrlen(port_name
))
4720 expand_string_message
=
4721 string_sprintf("invalid port number %s", port_name
);
4727 struct servent
*service_info
= getservbyname(CS port_name
, "tcp");
4728 if (service_info
== NULL
)
4730 expand_string_message
= string_sprintf("unknown port \"%s\"",
4734 port
= ntohs(service_info
->s_port
);
4737 if ((fd
= ip_connectedsocket(SOCK_STREAM
, server_name
, port
, port
,
4738 timeout
, NULL
, &expand_string_message
)) < 0)
4742 /* Handle a Unix domain socket */
4747 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) == -1)
4749 expand_string_message
= string_sprintf("failed to create socket: %s",
4754 sockun
.sun_family
= AF_UNIX
;
4755 sprintf(sockun
.sun_path
, "%.*s", (int)(sizeof(sockun
.sun_path
)-1),
4758 sigalrm_seen
= FALSE
;
4760 rc
= connect(fd
, (struct sockaddr
*)(&sockun
), sizeof(sockun
));
4764 expand_string_message
= US
"socket connect timed out";
4769 expand_string_message
= string_sprintf("failed to connect to socket "
4770 "%s: %s", sub_arg
[0], strerror(errno
));
4775 DEBUG(D_expand
) debug_printf("connected to socket %s\n", sub_arg
[0]);
4777 /* Allow sequencing of test actions */
4778 if (running_in_test_harness
) millisleep(100);
4780 /* Write the request string, if not empty */
4782 if (sub_arg
[1][0] != 0)
4784 int len
= Ustrlen(sub_arg
[1]);
4785 DEBUG(D_expand
) debug_printf("writing \"%s\" to socket\n",
4787 if (write(fd
, sub_arg
[1], len
) != len
)
4789 expand_string_message
= string_sprintf("request write to socket "
4790 "failed: %s", strerror(errno
));
4795 /* Shut down the sending side of the socket. This helps some servers to
4796 recognise that it is their turn to do some work. Just in case some
4797 system doesn't have this function, make it conditional. */
4800 shutdown(fd
, SHUT_WR
);
4803 if (running_in_test_harness
) millisleep(100);
4805 /* Now we need to read from the socket, under a timeout. The function
4806 that reads a file can be used. */
4808 f
= fdopen(fd
, "rb");
4809 sigalrm_seen
= FALSE
;
4811 yield
= cat_file(f
, yield
, &size
, &ptr
, sub_arg
[3]);
4815 /* After a timeout, we restore the pointer in the result, that is,
4816 make sure we add nothing from the socket. */
4821 expand_string_message
= US
"socket read timed out";
4826 /* The whole thing has worked (or we were skipping). If there is a
4827 failure string following, we need to skip it. */
4831 if (expand_string_internal(s
+1, TRUE
, &s
, TRUE
, TRUE
, &resetok
) == NULL
)
4833 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
4834 while (isspace(*s
)) s
++;
4836 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
4839 /* Come here on failure to create socket, connect socket, write to the
4840 socket, or timeout on reading. If another substring follows, expand and
4841 use it. Otherwise, those conditions give expand errors. */
4844 if (*s
!= '{') goto EXPAND_FAILED
;
4845 DEBUG(D_any
) debug_printf("%s\n", expand_string_message
);
4846 arg
= expand_string_internal(s
+1, TRUE
, &s
, FALSE
, TRUE
, &resetok
);
4847 if (arg
== NULL
) goto EXPAND_FAILED
;
4848 yield
= string_cat(yield
, &size
, &ptr
, arg
, Ustrlen(arg
));
4849 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
4850 while (isspace(*s
)) s
++;
4851 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
4855 /* Handle "run" to execute a program. */
4861 const uschar
**argv
;
4867 if ((expand_forbid
& RDO_RUN
) != 0)
4869 expand_string_message
= US
"running a command is not permitted";
4873 while (isspace(*s
)) s
++;
4874 if (*s
!= '{') goto EXPAND_FAILED_CURLY
;
4875 arg
= expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
4876 if (arg
== NULL
) goto EXPAND_FAILED
;
4877 while (isspace(*s
)) s
++;
4878 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
4880 if (skipping
) /* Just pretend it worked when we're skipping */
4886 if (!transport_set_up_command(&argv
, /* anchor for arg list */
4887 arg
, /* raw command */
4888 FALSE
, /* don't expand the arguments */
4889 0, /* not relevant when... */
4890 NULL
, /* no transporting address */
4891 US
"${run} expansion", /* for error messages */
4892 &expand_string_message
)) /* where to put error message */
4897 /* Create the child process, making it a group leader. */
4899 pid
= child_open(USS argv
, NULL
, 0077, &fd_in
, &fd_out
, TRUE
);
4903 expand_string_message
=
4904 string_sprintf("couldn't create child process: %s", strerror(errno
));
4908 /* Nothing is written to the standard input. */
4912 /* Read the pipe to get the command's output into $value (which is kept
4913 in lookup_value). Read during execution, so that if the output exceeds
4914 the OS pipe buffer limit, we don't block forever. */
4916 f
= fdopen(fd_out
, "rb");
4917 sigalrm_seen
= FALSE
;
4919 lookup_value
= cat_file(f
, lookup_value
, &lsize
, &lptr
, NULL
);
4923 /* Wait for the process to finish, applying the timeout, and inspect its
4924 return code for serious disasters. Simple non-zero returns are passed on.
4927 if (sigalrm_seen
== TRUE
|| (runrc
= child_close(pid
, 30)) < 0)
4929 if (sigalrm_seen
== TRUE
|| runrc
== -256)
4931 expand_string_message
= string_sprintf("command timed out");
4932 killpg(pid
, SIGKILL
); /* Kill the whole process group */
4935 else if (runrc
== -257)
4936 expand_string_message
= string_sprintf("wait() failed: %s",
4940 expand_string_message
= string_sprintf("command killed by signal %d",
4947 /* Process the yes/no strings; $value may be useful in both cases */
4949 switch(process_yesno(
4950 skipping
, /* were previously skipping */
4951 runrc
== 0, /* success/failure indicator */
4952 lookup_value
, /* value to reset for string2 */
4953 &s
, /* input pointer */
4954 &yield
, /* output pointer */
4955 &size
, /* output size */
4956 &ptr
, /* output current point */
4957 US
"run", /* condition type */
4960 case 1: goto EXPAND_FAILED
; /* when all is well, the */
4961 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
4967 /* Handle character translation for "tr" */
4975 switch(read_subs(sub
, 3, 3, &s
, skipping
, TRUE
, US
"tr", &resetok
))
4977 case 1: goto EXPAND_FAILED_CURLY
;
4979 case 3: goto EXPAND_FAILED
;
4982 yield
= string_cat(yield
, &size
, &ptr
, sub
[0], Ustrlen(sub
[0]));
4983 o2m
= Ustrlen(sub
[2]) - 1;
4985 if (o2m
>= 0) for (; oldptr
< ptr
; oldptr
++)
4987 uschar
*m
= Ustrrchr(sub
[1], yield
[oldptr
]);
4991 yield
[oldptr
] = sub
[2][(o
< o2m
)? o
: o2m
];
4998 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4999 expanded arguments. */
5009 int val
[2] = { 0, -1 };
5012 /* "length" takes only 2 arguments whereas the others take 2 or 3.
5013 Ensure that sub[2] is set in the ${length } case. */
5016 switch(read_subs(sub
, (item_type
== EITEM_LENGTH
)? 2:3, 2, &s
, skipping
,
5017 TRUE
, name
, &resetok
))
5019 case 1: goto EXPAND_FAILED_CURLY
;
5021 case 3: goto EXPAND_FAILED
;
5024 /* Juggle the arguments if there are only two of them: always move the
5025 string to the last position and make ${length{n}{str}} equivalent to
5026 ${substr{0}{n}{str}}. See the defaults for val[] above. */
5032 if (item_type
== EITEM_LENGTH
)
5039 for (i
= 0; i
< 2; i
++)
5041 if (sub
[i
] == NULL
) continue;
5042 val
[i
] = (int)Ustrtol(sub
[i
], &ret
, 10);
5043 if (*ret
!= 0 || (i
!= 0 && val
[i
] < 0))
5045 expand_string_message
= string_sprintf("\"%s\" is not a%s number "
5046 "(in \"%s\" expansion)", sub
[i
], (i
!= 0)? " positive" : "", name
);
5052 (item_type
== EITEM_HASH
)?
5053 compute_hash(sub
[2], val
[0], val
[1], &len
) :
5054 (item_type
== EITEM_NHASH
)?
5055 compute_nhash(sub
[2], val
[0], val
[1], &len
) :
5056 extract_substr(sub
[2], val
[0], val
[1], &len
);
5058 if (ret
== NULL
) goto EXPAND_FAILED
;
5059 yield
= string_cat(yield
, &size
, &ptr
, ret
, len
);
5063 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5064 This code originally contributed by Steve Haslam. It currently supports
5065 the use of MD5 and SHA-1 hashes.
5067 We need some workspace that is large enough to handle all the supported
5068 hash types. Use macros to set the sizes rather than be too elaborate. */
5070 #define MAX_HASHLEN 20
5071 #define MAX_HASHBLOCKLEN 64
5080 int hashlen
; /* Number of octets for the hash algorithm's output */
5081 int hashblocklen
; /* Number of octets the hash algorithm processes */
5083 unsigned int keylen
;
5085 uschar keyhash
[MAX_HASHLEN
];
5086 uschar innerhash
[MAX_HASHLEN
];
5087 uschar finalhash
[MAX_HASHLEN
];
5088 uschar finalhash_hex
[2*MAX_HASHLEN
];
5089 uschar innerkey
[MAX_HASHBLOCKLEN
];
5090 uschar outerkey
[MAX_HASHBLOCKLEN
];
5092 switch (read_subs(sub
, 3, 3, &s
, skipping
, TRUE
, name
, &resetok
))
5094 case 1: goto EXPAND_FAILED_CURLY
;
5096 case 3: goto EXPAND_FAILED
;
5099 if (Ustrcmp(sub
[0], "md5") == 0)
5102 use_base
= &md5_base
;
5106 else if (Ustrcmp(sub
[0], "sha1") == 0)
5109 use_base
= &sha1_base
;
5115 expand_string_message
=
5116 string_sprintf("hmac algorithm \"%s\" is not recognised", sub
[0]);
5121 keylen
= Ustrlen(keyptr
);
5123 /* If the key is longer than the hash block length, then hash the key
5126 if (keylen
> hashblocklen
)
5128 chash_start(type
, use_base
);
5129 chash_end(type
, use_base
, keyptr
, keylen
, keyhash
);
5134 /* Now make the inner and outer key values */
5136 memset(innerkey
, 0x36, hashblocklen
);
5137 memset(outerkey
, 0x5c, hashblocklen
);
5139 for (i
= 0; i
< keylen
; i
++)
5141 innerkey
[i
] ^= keyptr
[i
];
5142 outerkey
[i
] ^= keyptr
[i
];
5145 /* Now do the hashes */
5147 chash_start(type
, use_base
);
5148 chash_mid(type
, use_base
, innerkey
);
5149 chash_end(type
, use_base
, sub
[2], Ustrlen(sub
[2]), innerhash
);
5151 chash_start(type
, use_base
);
5152 chash_mid(type
, use_base
, outerkey
);
5153 chash_end(type
, use_base
, innerhash
, hashlen
, finalhash
);
5155 /* Encode the final hash as a hex string */
5158 for (i
= 0; i
< hashlen
; i
++)
5160 *p
++ = hex_digits
[(finalhash
[i
] & 0xf0) >> 4];
5161 *p
++ = hex_digits
[finalhash
[i
] & 0x0f];
5164 DEBUG(D_any
) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub
[0],
5165 (int)keylen
, keyptr
, Ustrlen(sub
[2]), sub
[2], hashlen
*2, finalhash_hex
);
5167 yield
= string_cat(yield
, &size
, &ptr
, finalhash_hex
, hashlen
*2);
5172 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5173 We have to save the numerical variables and restore them afterwards. */
5178 int moffset
, moffsetextra
, slen
;
5181 const uschar
*rerror
;
5184 int save_expand_nmax
=
5185 save_expand_strings(save_expand_nstring
, save_expand_nlength
);
5187 switch(read_subs(sub
, 3, 3, &s
, skipping
, TRUE
, US
"sg", &resetok
))
5189 case 1: goto EXPAND_FAILED_CURLY
;
5191 case 3: goto EXPAND_FAILED
;
5194 /* Compile the regular expression */
5196 re
= pcre_compile(CS sub
[1], PCRE_COPT
, (const char **)&rerror
, &roffset
,
5201 expand_string_message
= string_sprintf("regular expression error in "
5202 "\"%s\": %s at offset %d", sub
[1], rerror
, roffset
);
5206 /* Now run a loop to do the substitutions as often as necessary. It ends
5207 when there are no more matches. Take care over matches of the null string;
5208 do the same thing as Perl does. */
5211 slen
= Ustrlen(sub
[0]);
5212 moffset
= moffsetextra
= 0;
5217 int ovector
[3*(EXPAND_MAXN
+1)];
5218 int n
= pcre_exec(re
, NULL
, CS subject
, slen
, moffset
+ moffsetextra
,
5219 PCRE_EOPT
| emptyopt
, ovector
, nelem(ovector
));
5223 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5224 is not necessarily the end. We want to repeat the match from one
5225 character further along, but leaving the basic offset the same (for
5226 copying below). We can't be at the end of the string - that was checked
5227 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5228 finished; copy the remaining string and end the loop. */
5238 yield
= string_cat(yield
, &size
, &ptr
, subject
+moffset
, slen
-moffset
);
5242 /* Match - set up for expanding the replacement. */
5244 if (n
== 0) n
= EXPAND_MAXN
+ 1;
5246 for (nn
= 0; nn
< n
*2; nn
+= 2)
5248 expand_nstring
[expand_nmax
] = subject
+ ovector
[nn
];
5249 expand_nlength
[expand_nmax
++] = ovector
[nn
+1] - ovector
[nn
];
5253 /* Copy the characters before the match, plus the expanded insertion. */
5255 yield
= string_cat(yield
, &size
, &ptr
, subject
+ moffset
,
5256 ovector
[0] - moffset
);
5257 insert
= expand_string(sub
[2]);
5258 if (insert
== NULL
) goto EXPAND_FAILED
;
5259 yield
= string_cat(yield
, &size
, &ptr
, insert
, Ustrlen(insert
));
5261 moffset
= ovector
[1];
5265 /* If we have matched an empty string, first check to see if we are at
5266 the end of the subject. If so, the loop is over. Otherwise, mimic
5267 what Perl's /g options does. This turns out to be rather cunning. First
5268 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5269 string at the same point. If this fails (picked up above) we advance to
5270 the next character. */
5272 if (ovector
[0] == ovector
[1])
5274 if (ovector
[0] == slen
) break;
5275 emptyopt
= PCRE_NOTEMPTY
| PCRE_ANCHORED
;
5279 /* All done - restore numerical variables. */
5281 restore_expand_strings(save_expand_nmax
, save_expand_nstring
,
5282 save_expand_nlength
);
5286 /* Handle keyed and numbered substring extraction. If the first argument
5287 consists entirely of digits, then a numerical extraction is assumed. */
5293 int field_number
= 1;
5294 BOOL field_number_set
= FALSE
;
5295 uschar
*save_lookup_value
= lookup_value
;
5297 int save_expand_nmax
=
5298 save_expand_strings(save_expand_nstring
, save_expand_nlength
);
5300 /* Read the arguments */
5302 for (i
= 0; i
< j
; i
++)
5304 while (isspace(*s
)) s
++;
5305 if (*s
== '{') /*}*/
5307 sub
[i
] = expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
5308 if (sub
[i
] == NULL
) goto EXPAND_FAILED
; /*{*/
5309 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
5311 /* After removal of leading and trailing white space, the first
5312 argument must not be empty; if it consists entirely of digits
5313 (optionally preceded by a minus sign), this is a numerical
5314 extraction, and we expect 3 arguments. */
5322 while (isspace(*p
)) p
++;
5326 while (len
> 0 && isspace(p
[len
-1])) len
--;
5333 expand_string_message
= US
"first argument of \"extract\" must "
5343 while (*p
!= 0 && isdigit(*p
)) x
= x
* 10 + *p
++ - '0';
5347 j
= 3; /* Need 3 args */
5348 field_number_set
= TRUE
;
5353 else goto EXPAND_FAILED_CURLY
;
5356 /* Extract either the numbered or the keyed substring into $value. If
5357 skipping, just pretend the extraction failed. */
5359 lookup_value
= skipping
? NULL
: field_number_set
?
5360 expand_gettokened(field_number
, sub
[1], sub
[2]) :
5361 expand_getkeyed(sub
[0], sub
[1]);
5363 /* If no string follows, $value gets substituted; otherwise there can
5364 be yes/no strings, as for lookup or if. */
5366 switch(process_yesno(
5367 skipping
, /* were previously skipping */
5368 lookup_value
!= NULL
, /* success/failure indicator */
5369 save_lookup_value
, /* value to reset for string2 */
5370 &s
, /* input pointer */
5371 &yield
, /* output pointer */
5372 &size
, /* output size */
5373 &ptr
, /* output current point */
5374 US
"extract", /* condition type */
5377 case 1: goto EXPAND_FAILED
; /* when all is well, the */
5378 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
5381 /* All done - restore numerical variables. */
5383 restore_expand_strings(save_expand_nmax
, save_expand_nstring
,
5384 save_expand_nlength
);
5389 /* return the Nth item from a list */
5391 case EITEM_LISTEXTRACT
:
5394 int field_number
= 1;
5395 uschar
*save_lookup_value
= lookup_value
;
5397 int save_expand_nmax
=
5398 save_expand_strings(save_expand_nstring
, save_expand_nlength
);
5400 /* Read the field & list arguments */
5402 for (i
= 0; i
< 2; i
++)
5404 while (isspace(*s
)) s
++;
5405 if (*s
!= '{') /*}*/
5406 goto EXPAND_FAILED_CURLY
;
5408 sub
[i
] = expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
5409 if (!sub
[i
]) goto EXPAND_FAILED
; /*{*/
5410 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
5412 /* After removal of leading and trailing white space, the first
5413 argument must be numeric and nonempty. */
5421 while (isspace(*p
)) p
++;
5425 while (len
> 0 && isspace(p
[len
-1])) len
--;
5428 if (!*p
&& !skipping
)
5430 expand_string_message
= US
"first argument of \"listextract\" must "
5440 while (*p
&& isdigit(*p
)) x
= x
* 10 + *p
++ - '0';
5443 expand_string_message
= US
"first argument of \"listextract\" must "
5451 /* Extract the numbered element into $value. If
5452 skipping, just pretend the extraction failed. */
5454 lookup_value
= skipping
? NULL
: expand_getlistele(field_number
, sub
[1]);
5456 /* If no string follows, $value gets substituted; otherwise there can
5457 be yes/no strings, as for lookup or if. */
5459 switch(process_yesno(
5460 skipping
, /* were previously skipping */
5461 lookup_value
!= NULL
, /* success/failure indicator */
5462 save_lookup_value
, /* value to reset for string2 */
5463 &s
, /* input pointer */
5464 &yield
, /* output pointer */
5465 &size
, /* output size */
5466 &ptr
, /* output current point */
5467 US
"extract", /* condition type */
5470 case 1: goto EXPAND_FAILED
; /* when all is well, the */
5471 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
5474 /* All done - restore numerical variables. */
5476 restore_expand_strings(save_expand_nmax
, save_expand_nstring
,
5477 save_expand_nlength
);
5483 case EITEM_CERTEXTRACT
:
5485 uschar
*save_lookup_value
= lookup_value
;
5487 int save_expand_nmax
=
5488 save_expand_strings(save_expand_nstring
, save_expand_nlength
);
5490 /* Read the field argument */
5491 while (isspace(*s
)) s
++;
5492 if (*s
!= '{') /*}*/
5493 goto EXPAND_FAILED_CURLY
;
5494 sub
[0] = expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
5495 if (!sub
[0]) goto EXPAND_FAILED
; /*{*/
5496 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
5497 /* strip spaces fore & aft */
5502 while (isspace(*p
)) p
++;
5506 while (len
> 0 && isspace(p
[len
-1])) len
--;
5510 /* inspect the cert argument */
5511 while (isspace(*s
)) s
++;
5512 if (*s
!= '{') /*}*/
5513 goto EXPAND_FAILED_CURLY
;
5516 expand_string_message
= US
"second argument of \"certextract\" must "
5517 "be a certificate variable";
5520 sub
[1] = expand_string_internal(s
+1, TRUE
, &s
, skipping
, FALSE
, &resetok
);
5521 if (!sub
[1]) goto EXPAND_FAILED
; /*{*/
5522 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
5525 lookup_value
= NULL
;
5528 lookup_value
= expand_getcertele(sub
[0], sub
[1]);
5529 if (*expand_string_message
) goto EXPAND_FAILED
;
5531 switch(process_yesno(
5532 skipping
, /* were previously skipping */
5533 lookup_value
!= NULL
, /* success/failure indicator */
5534 save_lookup_value
, /* value to reset for string2 */
5535 &s
, /* input pointer */
5536 &yield
, /* output pointer */
5537 &size
, /* output size */
5538 &ptr
, /* output current point */
5539 US
"extract", /* condition type */
5542 case 1: goto EXPAND_FAILED
; /* when all is well, the */
5543 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
5546 restore_expand_strings(save_expand_nmax
, save_expand_nstring
,
5547 save_expand_nlength
);
5550 #endif /*SUPPORT_TLS*/
5552 /* Handle list operations */
5560 uschar outsep
[2] = { '\0', '\0' };
5561 const uschar
*list
, *expr
, *temp
;
5562 uschar
*save_iterate_item
= iterate_item
;
5563 uschar
*save_lookup_value
= lookup_value
;
5565 while (isspace(*s
)) s
++;
5566 if (*s
++ != '{') goto EXPAND_FAILED_CURLY
;
5568 list
= expand_string_internal(s
, TRUE
, &s
, skipping
, TRUE
, &resetok
);
5569 if (list
== NULL
) goto EXPAND_FAILED
;
5570 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
5572 if (item_type
== EITEM_REDUCE
)
5575 while (isspace(*s
)) s
++;
5576 if (*s
++ != '{') goto EXPAND_FAILED_CURLY
;
5577 t
= expand_string_internal(s
, TRUE
, &s
, skipping
, TRUE
, &resetok
);
5578 if (!t
) goto EXPAND_FAILED
;
5580 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
5583 while (isspace(*s
)) s
++;
5584 if (*s
++ != '{') goto EXPAND_FAILED_CURLY
;
5588 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5589 if scanning a "false" part). This allows us to find the end of the
5590 condition, because if the list is empty, we won't actually evaluate the
5591 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5592 the normal internal expansion function. */
5594 if (item_type
== EITEM_FILTER
)
5596 temp
= eval_condition(expr
, &resetok
, NULL
);
5597 if (temp
!= NULL
) s
= temp
;
5600 temp
= expand_string_internal(s
, TRUE
, &s
, TRUE
, TRUE
, &resetok
);
5604 expand_string_message
= string_sprintf("%s inside \"%s\" item",
5605 expand_string_message
, name
);
5609 while (isspace(*s
)) s
++;
5612 expand_string_message
= string_sprintf("missing } at end of condition "
5613 "or expression inside \"%s\"", name
);
5617 while (isspace(*s
)) s
++; /*{*/
5620 expand_string_message
= string_sprintf("missing } at end of \"%s\"",
5625 /* If we are skipping, we can now just move on to the next item. When
5626 processing for real, we perform the iteration. */
5628 if (skipping
) continue;
5629 while ((iterate_item
= string_nextinlist(&list
, &sep
, NULL
, 0)) != NULL
)
5631 *outsep
= (uschar
)sep
; /* Separator as a string */
5633 DEBUG(D_expand
) debug_printf("%s: $item = \"%s\"\n", name
, iterate_item
);
5635 if (item_type
== EITEM_FILTER
)
5638 if (eval_condition(expr
, &resetok
, &condresult
) == NULL
)
5640 iterate_item
= save_iterate_item
;
5641 lookup_value
= save_lookup_value
;
5642 expand_string_message
= string_sprintf("%s inside \"%s\" condition",
5643 expand_string_message
, name
);
5646 DEBUG(D_expand
) debug_printf("%s: condition is %s\n", name
,
5647 condresult
? "true":"false");
5649 temp
= iterate_item
; /* TRUE => include this item */
5651 continue; /* FALSE => skip this item */
5654 /* EITEM_MAP and EITEM_REDUCE */
5658 uschar
* t
= expand_string_internal(expr
, TRUE
, NULL
, skipping
, TRUE
, &resetok
);
5662 iterate_item
= save_iterate_item
;
5663 expand_string_message
= string_sprintf("%s inside \"%s\" item",
5664 expand_string_message
, name
);
5667 if (item_type
== EITEM_REDUCE
)
5669 lookup_value
= t
; /* Update the value of $value */
5670 continue; /* and continue the iteration */
5674 /* We reach here for FILTER if the condition is true, always for MAP,
5675 and never for REDUCE. The value in "temp" is to be added to the output
5676 list that is being created, ensuring that any occurrences of the
5677 separator character are doubled. Unless we are dealing with the first
5678 item of the output list, add in a space if the new item begins with the
5679 separator character, or is an empty string. */
5681 if (ptr
!= save_ptr
&& (temp
[0] == *outsep
|| temp
[0] == 0))
5682 yield
= string_cat(yield
, &size
, &ptr
, US
" ", 1);
5684 /* Add the string in "temp" to the output list that we are building,
5685 This is done in chunks by searching for the separator character. */
5689 size_t seglen
= Ustrcspn(temp
, outsep
);
5690 yield
= string_cat(yield
, &size
, &ptr
, temp
, seglen
+ 1);
5692 /* If we got to the end of the string we output one character
5693 too many; backup and end the loop. Otherwise arrange to double the
5696 if (temp
[seglen
] == '\0') { ptr
--; break; }
5697 yield
= string_cat(yield
, &size
, &ptr
, outsep
, 1);
5701 /* Output a separator after the string: we will remove the redundant
5702 final one at the end. */
5704 yield
= string_cat(yield
, &size
, &ptr
, outsep
, 1);
5705 } /* End of iteration over the list loop */
5707 /* REDUCE has generated no output above: output the final value of
5710 if (item_type
== EITEM_REDUCE
)
5712 yield
= string_cat(yield
, &size
, &ptr
, lookup_value
,
5713 Ustrlen(lookup_value
));
5714 lookup_value
= save_lookup_value
; /* Restore $value */
5717 /* FILTER and MAP generate lists: if they have generated anything, remove
5718 the redundant final separator. Even though an empty item at the end of a
5719 list does not count, this is tidier. */
5721 else if (ptr
!= save_ptr
) ptr
--;
5723 /* Restore preserved $item */
5725 iterate_item
= save_iterate_item
;
5732 const uschar
*srclist
, *cmp
, *xtract
;
5734 const uschar
*dstlist
= NULL
, *dstkeylist
= NULL
;
5736 uschar
*save_iterate_item
= iterate_item
;
5738 while (isspace(*s
)) s
++;
5739 if (*s
++ != '{') goto EXPAND_FAILED_CURLY
;
5741 srclist
= expand_string_internal(s
, TRUE
, &s
, skipping
, TRUE
, &resetok
);
5742 if (!srclist
) goto EXPAND_FAILED
;
5743 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
5745 while (isspace(*s
)) s
++;
5746 if (*s
++ != '{') goto EXPAND_FAILED_CURLY
;
5748 cmp
= expand_string_internal(s
, TRUE
, &s
, skipping
, FALSE
, &resetok
);
5749 if (!cmp
) goto EXPAND_FAILED
;
5750 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
5752 while (isspace(*s
)) s
++;
5753 if (*s
++ != '{') goto EXPAND_FAILED_CURLY
;
5756 tmp
= expand_string_internal(s
, TRUE
, &s
, TRUE
, TRUE
, &resetok
);
5757 if (!tmp
) goto EXPAND_FAILED
;
5758 xtract
= string_copyn(xtract
, s
- xtract
);
5760 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
5764 expand_string_message
= US
"missing } at end of \"sort\"";
5768 if (skipping
) continue;
5770 while ((srcitem
= string_nextinlist(&srclist
, &sep
, NULL
, 0)))
5773 uschar
* newlist
= NULL
;
5774 uschar
* newkeylist
= NULL
;
5777 DEBUG(D_expand
) debug_printf("%s: $item = \"%s\"\n", name
, srcitem
);
5779 /* extract field for comparisons */
5780 iterate_item
= srcitem
;
5781 if ( !(srcfield
= expand_string_internal(xtract
, FALSE
, NULL
, FALSE
,
5785 expand_string_message
= string_sprintf(
5786 "field-extract in sort: \"%s\"", xtract
);
5790 /* Insertion sort */
5792 /* copy output list until new-item < list-item */
5793 while ((dstitem
= string_nextinlist(&dstlist
, &sep
, NULL
, 0)))
5799 /* field for comparison */
5800 if (!(dstfield
= string_nextinlist(&dstkeylist
, &sep
, NULL
, 0)))
5803 /* build and run condition string */
5804 expr
= string_sprintf("%s{%s}{%s}", cmp
, srcfield
, dstfield
);
5806 DEBUG(D_expand
) debug_printf("%s: cond = \"%s\"\n", name
, expr
);
5807 if (!eval_condition(expr
, &resetok
, &before
))
5809 expand_string_message
= string_sprintf("comparison in sort: %s",
5816 /* New-item sorts before this dst-item. Append new-item,
5817 then dst-item, then remainder of dst list. */
5819 newlist
= string_append_listele(newlist
, sep
, srcitem
);
5820 newkeylist
= string_append_listele(newkeylist
, sep
, srcfield
);
5823 newlist
= string_append_listele(newlist
, sep
, dstitem
);
5824 newkeylist
= string_append_listele(newkeylist
, sep
, dstfield
);
5826 while ((dstitem
= string_nextinlist(&dstlist
, &sep
, NULL
, 0)))
5828 if (!(dstfield
= string_nextinlist(&dstkeylist
, &sep
, NULL
, 0)))
5830 newlist
= string_append_listele(newlist
, sep
, dstitem
);
5831 newkeylist
= string_append_listele(newkeylist
, sep
, dstfield
);
5837 newlist
= string_append_listele(newlist
, sep
, dstitem
);
5838 newkeylist
= string_append_listele(newkeylist
, sep
, dstfield
);
5841 /* If we ran out of dstlist without consuming srcitem, append it */
5844 newlist
= string_append_listele(newlist
, sep
, srcitem
);
5845 newkeylist
= string_append_listele(newkeylist
, sep
, srcfield
);
5849 dstkeylist
= newkeylist
;
5851 DEBUG(D_expand
) debug_printf("%s: dstlist = \"%s\"\n", name
, dstlist
);
5852 DEBUG(D_expand
) debug_printf("%s: dstkeylist = \"%s\"\n", name
, dstkeylist
);
5856 yield
= string_cat(yield
, &size
, &ptr
, dstlist
, Ustrlen(dstlist
));
5858 /* Restore preserved $item */
5859 iterate_item
= save_iterate_item
;
5863 expand_string_message
= US
"Internal error in sort (list mismatch)";
5868 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5869 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5870 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5871 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5873 #define EXPAND_DLFUNC_MAX_ARGS 8
5876 #ifndef EXPAND_DLFUNC
5877 expand_string_message
= US
"\"${dlfunc\" encountered, but this facility " /*}*/
5878 "is not included in this binary";
5881 #else /* EXPAND_DLFUNC */
5884 exim_dlfunc_t
*func
;
5887 uschar
*argv
[EXPAND_DLFUNC_MAX_ARGS
+ 3];
5889 if ((expand_forbid
& RDO_DLFUNC
) != 0)
5891 expand_string_message
=
5892 US
"dynamically-loaded functions are not permitted";
5896 switch(read_subs(argv
, EXPAND_DLFUNC_MAX_ARGS
+ 2, 2, &s
, skipping
,
5897 TRUE
, US
"dlfunc", &resetok
))
5899 case 1: goto EXPAND_FAILED_CURLY
;
5901 case 3: goto EXPAND_FAILED
;
5904 /* If skipping, we don't actually do anything */
5906 if (skipping
) continue;
5908 /* Look up the dynamically loaded object handle in the tree. If it isn't
5909 found, dlopen() the file and put the handle in the tree for next time. */
5911 t
= tree_search(dlobj_anchor
, argv
[0]);
5914 void *handle
= dlopen(CS argv
[0], RTLD_LAZY
);
5917 expand_string_message
= string_sprintf("dlopen \"%s\" failed: %s",
5918 argv
[0], dlerror());
5919 log_write(0, LOG_MAIN
|LOG_PANIC
, "%s", expand_string_message
);
5922 t
= store_get_perm(sizeof(tree_node
) + Ustrlen(argv
[0]));
5923 Ustrcpy(t
->name
, argv
[0]);
5924 t
->data
.ptr
= handle
;
5925 (void)tree_insertnode(&dlobj_anchor
, t
);
5928 /* Having obtained the dynamically loaded object handle, look up the
5929 function pointer. */
5931 func
= (exim_dlfunc_t
*)dlsym(t
->data
.ptr
, CS argv
[1]);
5934 expand_string_message
= string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5935 "%s", argv
[1], argv
[0], dlerror());
5936 log_write(0, LOG_MAIN
|LOG_PANIC
, "%s", expand_string_message
);
5940 /* Call the function and work out what to do with the result. If it
5941 returns OK, we have a replacement string; if it returns DEFER then
5942 expansion has failed in a non-forced manner; if it returns FAIL then
5943 failure was forced; if it returns ERROR or any other value there's a
5944 problem, so panic slightly. In any case, assume that the function has
5945 side-effects on the store that must be preserved. */
5949 for (argc
= 0; argv
[argc
] != NULL
; argc
++);
5950 status
= func(&result
, argc
- 2, &argv
[2]);
5953 if (result
== NULL
) result
= US
"";
5954 yield
= string_cat(yield
, &size
, &ptr
, result
, Ustrlen(result
));
5959 expand_string_message
= result
== NULL
? US
"(no message)" : result
;
5960 if(status
== FAIL_FORCED
) expand_string_forcedfail
= TRUE
;
5961 else if(status
!= FAIL
)
5962 log_write(0, LOG_MAIN
|LOG_PANIC
, "dlfunc{%s}{%s} failed (%d): %s",
5963 argv
[0], argv
[1], status
, expand_string_message
);
5967 #endif /* EXPAND_DLFUNC */
5969 case EITEM_ENV
: /* ${env {name} {val_if_found} {val_if_unfound}} */
5972 uschar
*save_lookup_value
= lookup_value
;
5974 while (isspace(*s
)) s
++;
5975 if (*s
!= '{') /*}*/
5978 key
= expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
5979 if (!key
) goto EXPAND_FAILED
; /*{*/
5980 if (*s
++ != '}') goto EXPAND_FAILED_CURLY
;
5982 lookup_value
= US
getenv(CS key
);
5984 switch(process_yesno(
5985 skipping
, /* were previously skipping */
5986 lookup_value
!= NULL
, /* success/failure indicator */
5987 save_lookup_value
, /* value to reset for string2 */
5988 &s
, /* input pointer */
5989 &yield
, /* output pointer */
5990 &size
, /* output size */
5991 &ptr
, /* output current point */
5992 US
"env", /* condition type */
5995 case 1: goto EXPAND_FAILED
; /* when all is well, the */
5996 case 2: goto EXPAND_FAILED_CURLY
; /* returned value is 0 */
6000 } /* EITEM_* switch */
6002 /* Control reaches here if the name is not recognized as one of the more
6003 complicated expansion items. Check for the "operator" syntax (name terminated
6004 by a colon). Some of the operators have arguments, separated by _ from the
6012 var_entry
*vp
= NULL
;
6014 /* Owing to an historical mis-design, an underscore may be part of the
6015 operator name, or it may introduce arguments. We therefore first scan the
6016 table of names that contain underscores. If there is no match, we cut off
6017 the arguments and then scan the main table. */
6019 if ((c
= chop_match(name
, op_table_underscore
,
6020 nelem(op_table_underscore
))) < 0)
6022 arg
= Ustrchr(name
, '_');
6023 if (arg
!= NULL
) *arg
= 0;
6024 c
= chop_match(name
, op_table_main
, nelem(op_table_main
));
6025 if (c
>= 0) c
+= nelem(op_table_underscore
);
6026 if (arg
!= NULL
) *arg
++ = '_'; /* Put back for error messages */
6029 /* Deal specially with operators that might take a certificate variable
6030 as we do not want to do the usual expansion. For most, expand the string.*/
6039 const uschar
* s1
= s
;
6040 sub
= expand_string_internal(s
+2, TRUE
, &s1
, skipping
,
6042 if (!sub
) goto EXPAND_FAILED
; /*{*/
6043 if (*s1
!= '}') goto EXPAND_FAILED_CURLY
;
6044 if ((vp
= find_var_ent(sub
)) && vp
->type
== vtype_cert
)
6054 sub
= expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, &resetok
);
6055 if (!sub
) goto EXPAND_FAILED
;
6060 /* If we are skipping, we don't need to perform the operation at all.
6061 This matters for operations like "mask", because the data may not be
6062 in the correct format when skipping. For example, the expression may test
6063 for the existence of $sender_host_address before trying to mask it. For
6064 other operations, doing them may not fail, but it is a waste of time. */
6066 if (skipping
&& c
>= 0) continue;
6068 /* Otherwise, switch on the operator type */
6075 unsigned long int n
= Ustrtoul(sub
, &t
, 10);
6078 expand_string_message
= string_sprintf("argument for base62 "
6079 "operator is \"%s\", which is not a decimal number", sub
);
6082 t
= string_base62(n
);
6083 yield
= string_cat(yield
, &size
, &ptr
, t
, Ustrlen(t
));
6087 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
6093 unsigned long int n
= 0;
6096 uschar
*t
= Ustrchr(base62_chars
, *tt
++);
6099 expand_string_message
= string_sprintf("argument for base62d "
6100 "operator is \"%s\", which is not a base %d number", sub
,
6104 n
= n
* BASE_62
+ (t
- base62_chars
);
6106 (void)sprintf(CS buf
, "%ld", n
);
6107 yield
= string_cat(yield
, &size
, &ptr
, buf
, Ustrlen(buf
));
6113 uschar
*expanded
= expand_string_internal(sub
, FALSE
, NULL
, skipping
, TRUE
, &resetok
);
6114 if (expanded
== NULL
)
6116 expand_string_message
=
6117 string_sprintf("internal expansion of \"%s\" failed: %s", sub
,
6118 expand_string_message
);
6121 yield
= string_cat(yield
, &size
, &ptr
, expanded
, Ustrlen(expanded
));
6128 uschar
*t
= sub
- 1;
6129 while (*(++t
) != 0) { *t
= tolower(*t
); count
++; }
6130 yield
= string_cat(yield
, &size
, &ptr
, sub
, count
);
6137 uschar
*t
= sub
- 1;
6138 while (*(++t
) != 0) { *t
= toupper(*t
); count
++; }
6139 yield
= string_cat(yield
, &size
, &ptr
, sub
, count
);
6145 if (vp
&& *(void **)vp
->value
)
6147 uschar
* cp
= tls_cert_fprt_md5(*(void **)vp
->value
);
6148 yield
= string_cat(yield
, &size
, &ptr
, cp
, Ustrlen(cp
));
6158 md5_end(&base
, sub
, Ustrlen(sub
), digest
);
6159 for(j
= 0; j
< 16; j
++) sprintf(st
+2*j
, "%02x", digest
[j
]);
6160 yield
= string_cat(yield
, &size
, &ptr
, US st
, (int)strlen(st
));
6166 if (vp
&& *(void **)vp
->value
)
6168 uschar
* cp
= tls_cert_fprt_sha1(*(void **)vp
->value
);
6169 yield
= string_cat(yield
, &size
, &ptr
, cp
, Ustrlen(cp
));
6179 sha1_end(&base
, sub
, Ustrlen(sub
), digest
);
6180 for(j
= 0; j
< 20; j
++) sprintf(st
+2*j
, "%02X", digest
[j
]);
6181 yield
= string_cat(yield
, &size
, &ptr
, US st
, (int)strlen(st
));
6187 if (vp
&& *(void **)vp
->value
)
6189 uschar
* cp
= tls_cert_fprt_sha256(*(void **)vp
->value
);
6190 yield
= string_cat(yield
, &size
, &ptr
, cp
, (int)Ustrlen(cp
));
6194 expand_string_message
= US
"sha256 only supported for certificates";
6197 /* Convert hex encoding to base64 encoding */
6207 for (enc
= sub
; *enc
!= 0; enc
++)
6209 if (!isxdigit(*enc
))
6211 expand_string_message
= string_sprintf("\"%s\" is not a hex "
6220 expand_string_message
= string_sprintf("\"%s\" contains an odd "
6221 "number of characters", sub
);
6225 while ((c
= *in
++) != 0)
6227 if (isdigit(c
)) c
-= '0';
6228 else c
= toupper(c
) - 'A' + 10;
6240 enc
= auth_b64encode(sub
, out
- sub
);
6241 yield
= string_cat(yield
, &size
, &ptr
, enc
, Ustrlen(enc
));
6245 /* Convert octets outside 0x21..0x7E to \xXX form */
6249 uschar
*t
= sub
- 1;
6252 if (*t
< 0x21 || 0x7E < *t
)
6253 yield
= string_cat(yield
, &size
, &ptr
,
6254 string_sprintf("\\x%02x", *t
), 4);
6256 yield
= string_cat(yield
, &size
, &ptr
, t
, 1);
6261 /* count the number of list elements */
6270 while (string_nextinlist(CUSS
&sub
, &sep
, buffer
, sizeof(buffer
)) != NULL
) cnt
++;
6271 cp
= string_sprintf("%d", cnt
);
6272 yield
= string_cat(yield
, &size
, &ptr
, cp
, Ustrlen(cp
));
6276 /* expand a named list given the name */
6277 /* handles nested named lists; requotes as colon-sep list */
6281 tree_node
*t
= NULL
;
6282 const uschar
* list
;
6285 uschar
* suffix
= US
"";
6286 BOOL needsep
= FALSE
;
6289 if (*sub
== '+') sub
++;
6290 if (arg
== NULL
) /* no-argument version */
6292 if (!(t
= tree_search(addresslist_anchor
, sub
)) &&
6293 !(t
= tree_search(domainlist_anchor
, sub
)) &&
6294 !(t
= tree_search(hostlist_anchor
, sub
)))
6295 t
= tree_search(localpartlist_anchor
, sub
);
6297 else switch(*arg
) /* specific list-type version */
6299 case 'a': t
= tree_search(addresslist_anchor
, sub
); suffix
= US
"_a"; break;
6300 case 'd': t
= tree_search(domainlist_anchor
, sub
); suffix
= US
"_d"; break;
6301 case 'h': t
= tree_search(hostlist_anchor
, sub
); suffix
= US
"_h"; break;
6302 case 'l': t
= tree_search(localpartlist_anchor
, sub
); suffix
= US
"_l"; break;
6304 expand_string_message
= string_sprintf("bad suffix on \"list\" operator");
6310 expand_string_message
= string_sprintf("\"%s\" is not a %snamed list",
6312 : *arg
=='a'?"address "
6313 : *arg
=='d'?"domain "
6315 : *arg
=='l'?"localpart "
6320 list
= ((namedlist_block
*)(t
->data
.ptr
))->string
;
6322 while ((item
= string_nextinlist(&list
, &sep
, buffer
, sizeof(buffer
))) != NULL
)
6324 uschar
* buf
= US
" : ";
6326 yield
= string_cat(yield
, &size
, &ptr
, buf
, 3);
6330 if (*item
== '+') /* list item is itself a named list */
6332 uschar
* sub
= string_sprintf("${listnamed%s:%s}", suffix
, item
);
6333 item
= expand_string_internal(sub
, FALSE
, NULL
, FALSE
, TRUE
, &resetok
);
6335 else if (sep
!= ':') /* item from non-colon-sep list, re-quote for colon list-separator */
6339 tok
[0] = sep
; tok
[1] = ':'; tok
[2] = 0;
6340 while ((cp
= strpbrk((const char *)item
, tok
)))
6342 yield
= string_cat(yield
, &size
, &ptr
, item
, cp
-(char *)item
);
6343 if (*cp
++ == ':') /* colon in a non-colon-sep list item, needs doubling */
6345 yield
= string_cat(yield
, &size
, &ptr
, US
"::", 2);
6346 item
= (uschar
*)cp
;
6348 else /* sep in item; should already be doubled; emit once */
6350 yield
= string_cat(yield
, &size
, &ptr
, (uschar
*)tok
, 1);
6351 if (*cp
== sep
) cp
++;
6352 item
= (uschar
*)cp
;
6356 yield
= string_cat(yield
, &size
, &ptr
, item
, Ustrlen(item
));
6361 /* mask applies a mask to an IP address; for example the result of
6362 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6369 int mask
, maskoffset
;
6370 int type
= string_is_ip_address(sub
, &maskoffset
);
6375 expand_string_message
= string_sprintf("\"%s\" is not an IP address",
6380 if (maskoffset
== 0)
6382 expand_string_message
= string_sprintf("missing mask value in \"%s\"",
6387 mask
= Ustrtol(sub
+ maskoffset
+ 1, &endptr
, 10);
6389 if (*endptr
!= 0 || mask
< 0 || mask
> ((type
== 4)? 32 : 128))
6391 expand_string_message
= string_sprintf("mask value too big in \"%s\"",
6396 /* Convert the address to binary integer(s) and apply the mask */
6398 sub
[maskoffset
] = 0;
6399 count
= host_aton(sub
, binary
);
6400 host_mask(count
, binary
, mask
);
6402 /* Convert to masked textual format and add to output. */
6404 yield
= string_cat(yield
, &size
, &ptr
, buffer
,
6405 host_nmtoa(count
, binary
, mask
, buffer
, '.'));
6410 case EOP_LOCAL_PART
:
6414 int start
, end
, domain
;
6415 uschar
*t
= parse_extract_address(sub
, &error
, &start
, &end
, &domain
,
6419 if (c
!= EOP_DOMAIN
)
6421 if (c
== EOP_LOCAL_PART
&& domain
!= 0) end
= start
+ domain
- 1;
6422 yield
= string_cat(yield
, &size
, &ptr
, sub
+start
, end
-start
);
6424 else if (domain
!= 0)
6427 yield
= string_cat(yield
, &size
, &ptr
, sub
+domain
, end
-domain
);
6435 uschar outsep
[2] = { ':', '\0' };
6436 uschar
*address
, *error
;
6438 int start
, end
, domain
; /* Not really used */
6440 while (isspace(*sub
)) sub
++;
6441 if (*sub
== '>') { *outsep
= *++sub
; ++sub
; }
6442 parse_allow_group
= TRUE
;
6446 uschar
*p
= parse_find_address_end(sub
, FALSE
);
6447 uschar saveend
= *p
;
6449 address
= parse_extract_address(sub
, &error
, &start
, &end
, &domain
,
6453 /* Add the address to the output list that we are building. This is
6454 done in chunks by searching for the separator character. At the
6455 start, unless we are dealing with the first address of the output
6456 list, add in a space if the new address begins with the separator
6457 character, or is an empty string. */
6459 if (address
!= NULL
)
6461 if (ptr
!= save_ptr
&& address
[0] == *outsep
)
6462 yield
= string_cat(yield
, &size
, &ptr
, US
" ", 1);
6466 size_t seglen
= Ustrcspn(address
, outsep
);
6467 yield
= string_cat(yield
, &size
, &ptr
, address
, seglen
+ 1);
6469 /* If we got to the end of the string we output one character
6472 if (address
[seglen
] == '\0') { ptr
--; break; }
6473 yield
= string_cat(yield
, &size
, &ptr
, outsep
, 1);
6474 address
+= seglen
+ 1;
6477 /* Output a separator after the string: we will remove the
6478 redundant final one at the end. */
6480 yield
= string_cat(yield
, &size
, &ptr
, outsep
, 1);
6483 if (saveend
== '\0') break;
6487 /* If we have generated anything, remove the redundant final
6490 if (ptr
!= save_ptr
) ptr
--;
6491 parse_allow_group
= FALSE
;
6496 /* quote puts a string in quotes if it is empty or contains anything
6497 other than alphamerics, underscore, dot, or hyphen.
6499 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6500 be quoted in order to be a valid local part.
6502 In both cases, newlines and carriage returns are converted into \n and \r
6506 case EOP_QUOTE_LOCAL_PART
:
6509 BOOL needs_quote
= (*sub
== 0); /* TRUE for empty string */
6510 uschar
*t
= sub
- 1;
6514 while (!needs_quote
&& *(++t
) != 0)
6515 needs_quote
= !isalnum(*t
) && !strchr("_-.", *t
);
6517 else /* EOP_QUOTE_LOCAL_PART */
6519 while (!needs_quote
&& *(++t
) != 0)
6520 needs_quote
= !isalnum(*t
) &&
6521 strchr("!#$%&'*+-/=?^_`{|}~", *t
) == NULL
&&
6522 (*t
!= '.' || t
== sub
|| t
[1] == 0);
6527 yield
= string_cat(yield
, &size
, &ptr
, US
"\"", 1);
6532 yield
= string_cat(yield
, &size
, &ptr
, US
"\\n", 2);
6533 else if (*t
== '\r')
6534 yield
= string_cat(yield
, &size
, &ptr
, US
"\\r", 2);
6537 if (*t
== '\\' || *t
== '"')
6538 yield
= string_cat(yield
, &size
, &ptr
, US
"\\", 1);
6539 yield
= string_cat(yield
, &size
, &ptr
, t
, 1);
6542 yield
= string_cat(yield
, &size
, &ptr
, US
"\"", 1);
6544 else yield
= string_cat(yield
, &size
, &ptr
, sub
, Ustrlen(sub
));
6548 /* quote_lookuptype does lookup-specific quoting */
6553 uschar
*opt
= Ustrchr(arg
, '_');
6555 if (opt
!= NULL
) *opt
++ = 0;
6557 n
= search_findtype(arg
, Ustrlen(arg
));
6560 expand_string_message
= search_error_message
;
6564 if (lookup_list
[n
]->quote
!= NULL
)
6565 sub
= (lookup_list
[n
]->quote
)(sub
, opt
);
6566 else if (opt
!= NULL
) sub
= NULL
;
6570 expand_string_message
= string_sprintf(
6571 "\"%s\" unrecognized after \"${quote_%s\"",
6576 yield
= string_cat(yield
, &size
, &ptr
, sub
, Ustrlen(sub
));
6580 /* rx quote sticks in \ before any non-alphameric character so that
6581 the insertion works in a regular expression. */
6585 uschar
*t
= sub
- 1;
6589 yield
= string_cat(yield
, &size
, &ptr
, US
"\\", 1);
6590 yield
= string_cat(yield
, &size
, &ptr
, t
, 1);
6595 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6596 prescribed by the RFC, if there are characters that need to be encoded */
6600 uschar buffer
[2048];
6601 const uschar
*string
= parse_quote_2047(sub
, Ustrlen(sub
), headers_charset
,
6602 buffer
, sizeof(buffer
), FALSE
);
6603 yield
= string_cat(yield
, &size
, &ptr
, string
, Ustrlen(string
));
6607 /* RFC 2047 decode */
6613 uschar
*decoded
= rfc2047_decode(sub
, check_rfc2047_length
,
6614 headers_charset
, '?', &len
, &error
);
6617 expand_string_message
= error
;
6620 yield
= string_cat(yield
, &size
, &ptr
, decoded
, len
);
6624 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6634 if (c
> 255) c
= '_';
6636 yield
= string_cat(yield
, &size
, &ptr
, buff
, 1);
6641 /* replace illegal UTF-8 sequences by replacement character */
6643 #define UTF8_REPLACEMENT_CHAR US"?"
6647 int seq_len
= 0, index
= 0;
6649 long codepoint
= -1;
6650 uschar seq_buff
[4]; /* accumulate utf-8 here */
6659 if ((c
& 0xc0) != 0x80)
6660 /* wrong continuation byte; invalidate all bytes */
6661 complete
= 1; /* error */
6664 codepoint
= (codepoint
<< 6) | (c
& 0x3f);
6665 seq_buff
[index
++] = c
;
6666 if (--bytes_left
== 0) /* codepoint complete */
6667 if(codepoint
> 0x10FFFF) /* is it too large? */
6668 complete
= -1; /* error (RFC3629 limit) */
6670 { /* finished; output utf-8 sequence */
6671 yield
= string_cat(yield
, &size
, &ptr
, seq_buff
, seq_len
);
6676 else /* no bytes left: new sequence */
6678 if((c
& 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6680 yield
= string_cat(yield
, &size
, &ptr
, &c
, 1);
6683 if((c
& 0xe0) == 0xc0) /* 2-byte sequence */
6685 if(c
== 0xc0 || c
== 0xc1) /* 0xc0 and 0xc1 are illegal */
6690 codepoint
= c
& 0x1f;
6693 else if((c
& 0xf0) == 0xe0) /* 3-byte sequence */
6696 codepoint
= c
& 0x0f;
6698 else if((c
& 0xf8) == 0xf0) /* 4-byte sequence */
6701 codepoint
= c
& 0x07;
6703 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6706 seq_buff
[index
++] = c
;
6707 seq_len
= bytes_left
+ 1;
6708 } /* if(bytes_left) */
6712 bytes_left
= index
= 0;
6713 yield
= string_cat(yield
, &size
, &ptr
, UTF8_REPLACEMENT_CHAR
, 1);
6715 if ((complete
== 1) && ((c
& 0x80) == 0))
6716 /* ASCII character follows incomplete sequence */
6717 yield
= string_cat(yield
, &size
, &ptr
, &c
, 1);
6722 #ifdef EXPERIMENTAL_INTERNATIONAL
6723 case EOP_UTF8_DOMAIN_TO_ALABEL
:
6725 uschar
* error
= NULL
;
6726 uschar
* s
= string_domain_utf8_to_alabel(sub
, &error
);
6729 expand_string_message
= string_sprintf(
6730 "error converting utf8 (%s) to alabel: %s",
6731 string_printing(sub
), error
);
6734 yield
= string_cat(yield
, &size
, &ptr
, s
, Ustrlen(s
));
6738 case EOP_UTF8_DOMAIN_FROM_ALABEL
:
6740 uschar
* error
= NULL
;
6741 uschar
* s
= string_domain_alabel_to_utf8(sub
, &error
);
6744 expand_string_message
= string_sprintf(
6745 "error converting alabel (%s) to utf8: %s",
6746 string_printing(sub
), error
);
6749 yield
= string_cat(yield
, &size
, &ptr
, s
, Ustrlen(s
));
6753 case EOP_UTF8_LOCALPART_TO_ALABEL
:
6755 uschar
* error
= NULL
;
6756 uschar
* s
= string_localpart_utf8_to_alabel(sub
, &error
);
6759 expand_string_message
= string_sprintf(
6760 "error converting utf8 (%s) to alabel: %s",
6761 string_printing(sub
), error
);
6764 yield
= string_cat(yield
, &size
, &ptr
, s
, Ustrlen(s
));
6765 DEBUG(D_expand
) debug_printf("yield: '%s'\n", yield
);
6769 case EOP_UTF8_LOCALPART_FROM_ALABEL
:
6771 uschar
* error
= NULL
;
6772 uschar
* s
= string_localpart_alabel_to_utf8(sub
, &error
);
6775 expand_string_message
= string_sprintf(
6776 "error converting alabel (%s) to utf8: %s",
6777 string_printing(sub
), error
);
6780 yield
= string_cat(yield
, &size
, &ptr
, s
, Ustrlen(s
));
6783 #endif /* EXPERIMENTAL_INTERNATIONAL */
6785 /* escape turns all non-printing characters into escape sequences. */
6789 const uschar
*t
= string_printing(sub
);
6790 yield
= string_cat(yield
, &size
, &ptr
, t
, Ustrlen(t
));
6794 /* Handle numeric expression evaluation */
6799 uschar
*save_sub
= sub
;
6800 uschar
*error
= NULL
;
6801 int_eximarith_t n
= eval_expr(&sub
, (c
== EOP_EVAL10
), &error
, FALSE
);
6804 expand_string_message
= string_sprintf("error in expression "
6805 "evaluation: %s (after processing \"%.*s\")", error
, sub
-save_sub
,
6809 sprintf(CS var_buffer
, PR_EXIM_ARITH
, n
);
6810 yield
= string_cat(yield
, &size
, &ptr
, var_buffer
, Ustrlen(var_buffer
));
6814 /* Handle time period formating */
6818 int n
= readconf_readtime(sub
, 0, FALSE
);
6821 expand_string_message
= string_sprintf("string \"%s\" is not an "
6822 "Exim time interval in \"%s\" operator", sub
, name
);
6825 sprintf(CS var_buffer
, "%d", n
);
6826 yield
= string_cat(yield
, &size
, &ptr
, var_buffer
, Ustrlen(var_buffer
));
6830 case EOP_TIME_INTERVAL
:
6833 uschar
*t
= read_number(&n
, sub
);
6834 if (*t
!= 0) /* Not A Number*/
6836 expand_string_message
= string_sprintf("string \"%s\" is not a "
6837 "positive number in \"%s\" operator", sub
, name
);
6840 t
= readconf_printtime(n
);
6841 yield
= string_cat(yield
, &size
, &ptr
, t
, Ustrlen(t
));
6845 /* Convert string to base64 encoding */
6849 uschar
*encstr
= auth_b64encode(sub
, Ustrlen(sub
));
6850 yield
= string_cat(yield
, &size
, &ptr
, encstr
, Ustrlen(encstr
));
6854 /* strlen returns the length of the string */
6859 (void)sprintf(CS buff
, "%d", Ustrlen(sub
));
6860 yield
= string_cat(yield
, &size
, &ptr
, buff
, Ustrlen(buff
));
6864 /* length_n or l_n takes just the first n characters or the whole string,
6865 whichever is the shorter;
6867 substr_m_n, and s_m_n take n characters from offset m; negative m take
6868 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6869 takes the rest, either to the right or to the left.
6871 hash_n or h_n makes a hash of length n from the string, yielding n
6872 characters from the set a-z; hash_n_m makes a hash of length n, but
6873 uses m characters from the set a-zA-Z0-9.
6875 nhash_n returns a single number between 0 and n-1 (in text form), while
6876 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6877 between 0 and n-1 and the second between 0 and m-1. */
6897 expand_string_message
= string_sprintf("missing values after %s",
6902 /* "length" has only one argument, effectively being synonymous with
6905 if (c
== EOP_LENGTH
|| c
== EOP_L
)
6911 /* The others have one or two arguments; for "substr" the first may be
6912 negative. The second being negative means "not supplied". */
6917 if (name
[0] == 's' && *arg
== '-') { sign
= -1; arg
++; }
6920 /* Read up to two numbers, separated by underscores */
6925 if (arg
!= ret
&& *arg
== '_' && pn
== &value1
)
6929 if (arg
[1] != 0) arg
++;
6931 else if (!isdigit(*arg
))
6933 expand_string_message
=
6934 string_sprintf("non-digit after underscore in \"%s\"", name
);
6937 else *pn
= (*pn
)*10 + *arg
++ - '0';
6941 /* Perform the required operation */
6944 (c
== EOP_HASH
|| c
== EOP_H
)?
6945 compute_hash(sub
, value1
, value2
, &len
) :
6946 (c
== EOP_NHASH
|| c
== EOP_NH
)?
6947 compute_nhash(sub
, value1
, value2
, &len
) :
6948 extract_substr(sub
, value1
, value2
, &len
);
6950 if (ret
== NULL
) goto EXPAND_FAILED
;
6951 yield
= string_cat(yield
, &size
, &ptr
, ret
, len
);
6961 uschar
**modetable
[3];
6966 if ((expand_forbid
& RDO_EXISTS
) != 0)
6968 expand_string_message
= US
"Use of the stat() expansion is not permitted";
6972 if (stat(CS sub
, &st
) < 0)
6974 expand_string_message
= string_sprintf("stat(%s) failed: %s",
6975 sub
, strerror(errno
));
6979 switch (mode
& S_IFMT
)
6981 case S_IFIFO
: smode
[0] = 'p'; break;
6982 case S_IFCHR
: smode
[0] = 'c'; break;
6983 case S_IFDIR
: smode
[0] = 'd'; break;
6984 case S_IFBLK
: smode
[0] = 'b'; break;
6985 case S_IFREG
: smode
[0] = '-'; break;
6986 default: smode
[0] = '?'; break;
6989 modetable
[0] = ((mode
& 01000) == 0)? mtable_normal
: mtable_sticky
;
6990 modetable
[1] = ((mode
& 02000) == 0)? mtable_normal
: mtable_setid
;
6991 modetable
[2] = ((mode
& 04000) == 0)? mtable_normal
: mtable_setid
;
6993 for (i
= 0; i
< 3; i
++)
6995 memcpy(CS(smode
+ 7 - i
*3), CS(modetable
[i
][mode
& 7]), 3);
7000 s
= string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
7001 "uid=%ld gid=%ld size=" OFF_T_FMT
" atime=%ld mtime=%ld ctime=%ld",
7002 (long)(st
.st_mode
& 077777), smode
, (long)st
.st_ino
,
7003 (long)st
.st_dev
, (long)st
.st_nlink
, (long)st
.st_uid
,
7004 (long)st
.st_gid
, st
.st_size
, (long)st
.st_atime
,
7005 (long)st
.st_mtime
, (long)st
.st_ctime
);
7006 yield
= string_cat(yield
, &size
, &ptr
, s
, Ustrlen(s
));
7010 /* vaguely random number less than N */
7014 int_eximarith_t max
;
7017 max
= expanded_string_integer(sub
, TRUE
);
7018 if (expand_string_message
!= NULL
)
7020 s
= string_sprintf("%d", vaguely_random_number((int)max
));
7021 yield
= string_cat(yield
, &size
, &ptr
, s
, Ustrlen(s
));
7025 /* Reverse IP, including IPv6 to dotted-nibble */
7027 case EOP_REVERSE_IP
:
7029 int family
, maskptr
;
7030 uschar reversed
[128];
7032 family
= string_is_ip_address(sub
, &maskptr
);
7035 expand_string_message
= string_sprintf(
7036 "reverse_ip() not given an IP address [%s]", sub
);
7039 invert_address(reversed
, sub
);
7040 yield
= string_cat(yield
, &size
, &ptr
, reversed
, Ustrlen(reversed
));
7044 /* Unknown operator */
7047 expand_string_message
=
7048 string_sprintf("unknown expansion operator \"%s\"", name
);
7053 /* Handle a plain name. If this is the first thing in the expansion, release
7054 the pre-allocated buffer. If the result data is known to be in a new buffer,
7055 newsize will be set to the size of that buffer, and we can just point at that
7056 store instead of copying. Many expansion strings contain just one reference,
7057 so this is a useful optimization, especially for humungous headers
7058 ($message_headers). */
7066 if (resetok
) store_reset(yield
);
7070 value
= find_variable(name
, FALSE
, skipping
, &newsize
);
7073 expand_string_message
=
7074 string_sprintf("unknown variable in \"${%s}\"", name
);
7075 check_variable_error_message(name
);
7078 len
= Ustrlen(value
);
7079 if (yield
== NULL
&& newsize
!= 0)
7085 else yield
= string_cat(yield
, &size
, &ptr
, value
, len
);
7089 /* Else there's something wrong */
7091 expand_string_message
=
7092 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
7093 "in a variable reference)", name
);
7097 /* If we hit the end of the string when ket_ends is set, there is a missing
7098 terminating brace. */
7100 if (ket_ends
&& *s
== 0)
7102 expand_string_message
= malformed_header
?
7103 US
"missing } at end of string - could be header name not terminated by colon"
7105 US
"missing } at end of string";
7109 /* Expansion succeeded; yield may still be NULL here if nothing was actually
7110 added to the string. If so, set up an empty string. Add a terminating zero. If
7111 left != NULL, return a pointer to the terminator. */
7113 if (yield
== NULL
) yield
= store_get(1);
7115 if (left
!= NULL
) *left
= s
;
7117 /* Any stacking store that was used above the final string is no longer needed.
7118 In many cases the final string will be the first one that was got and so there
7119 will be optimal store usage. */
7121 if (resetok
) store_reset(yield
+ ptr
+ 1);
7122 else if (resetok_p
) *resetok_p
= FALSE
;
7126 debug_printf("expanding: %.*s\n result: %s\n", (int)(s
- string
), string
,
7128 if (skipping
) debug_printf("skipping: result is not used\n");
7132 /* This is the failure exit: easiest to program with a goto. We still need
7133 to update the pointer to the terminator, for cases of nested calls with "fail".
7136 EXPAND_FAILED_CURLY
:
7137 expand_string_message
= malformed_header
?
7138 US
"missing or misplaced { or } - could be header name not terminated by colon"
7140 US
"missing or misplaced { or }";
7142 /* At one point, Exim reset the store to yield (if yield was not NULL), but
7143 that is a bad idea, because expand_string_message is in dynamic store. */
7146 if (left
!= NULL
) *left
= s
;
7149 debug_printf("failed to expand: %s\n", string
);
7150 debug_printf(" error message: %s\n", expand_string_message
);
7151 if (expand_string_forcedfail
) debug_printf("failure was forced\n");
7153 if (resetok_p
) *resetok_p
= resetok
;
7158 /* This is the external function call. Do a quick check for any expansion
7159 metacharacters, and if there are none, just return the input string.
7161 Argument: the string to be expanded
7162 Returns: the expanded string, or NULL if expansion failed; if failure was
7163 due to a lookup deferring, search_find_defer will be TRUE
7167 expand_string(uschar
*string
)
7169 search_find_defer
= FALSE
;
7170 malformed_header
= FALSE
;
7171 return (Ustrpbrk(string
, "$\\") == NULL
)? string
:
7172 expand_string_internal(string
, FALSE
, NULL
, FALSE
, TRUE
, NULL
);
7178 expand_cstring(const uschar
*string
)
7180 search_find_defer
= FALSE
;
7181 malformed_header
= FALSE
;
7182 return (Ustrpbrk(string
, "$\\") == NULL
)? string
:
7183 expand_string_internal(string
, FALSE
, NULL
, FALSE
, TRUE
, NULL
);
7188 /*************************************************
7190 *************************************************/
7192 /* Now and again we want to expand a string and be sure that the result is in a
7193 new bit of store. This function does that.
7194 Since we know it has been copied, the de-const cast is safe.
7196 Argument: the string to be expanded
7197 Returns: the expanded string, always in a new bit of store, or NULL
7201 expand_string_copy(const uschar
*string
)
7203 const uschar
*yield
= expand_cstring(string
);
7204 if (yield
== string
) yield
= string_copy(string
);
7210 /*************************************************
7211 * Expand and interpret as an integer *
7212 *************************************************/
7214 /* Expand a string, and convert the result into an integer.
7217 string the string to be expanded
7218 isplus TRUE if a non-negative number is expected
7220 Returns: the integer value, or
7221 -1 for an expansion error ) in both cases, message in
7222 -2 for an integer interpretation error ) expand_string_message
7223 expand_string_message is set NULL for an OK integer
7227 expand_string_integer(uschar
*string
, BOOL isplus
)
7229 return expanded_string_integer(expand_string(string
), isplus
);
7233 /*************************************************
7234 * Interpret string as an integer *
7235 *************************************************/
7237 /* Convert a string (that has already been expanded) into an integer.
7239 This function is used inside the expansion code.
7242 s the string to be expanded
7243 isplus TRUE if a non-negative number is expected
7245 Returns: the integer value, or
7246 -1 if string is NULL (which implies an expansion error)
7247 -2 for an integer interpretation error
7248 expand_string_message is set NULL for an OK integer
7251 static int_eximarith_t
7252 expanded_string_integer(const uschar
*s
, BOOL isplus
)
7254 int_eximarith_t value
;
7255 uschar
*msg
= US
"invalid integer \"%s\"";
7258 /* If expansion failed, expand_string_message will be set. */
7260 if (s
== NULL
) return -1;
7262 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
7263 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
7264 systems, so we set it zero ourselves. */
7267 expand_string_message
= NULL
; /* Indicates no error */
7269 /* Before Exim 4.64, strings consisting entirely of whitespace compared
7270 equal to 0. Unfortunately, people actually relied upon that, so preserve
7271 the behaviour explicitly. Stripping leading whitespace is a harmless
7272 noop change since strtol skips it anyway (provided that there is a number
7276 while (isspace(*s
)) ++s
;
7280 debug_printf("treating blank string as number 0\n");
7285 value
= strtoll(CS s
, CSS
&endptr
, 10);
7289 msg
= US
"integer expected but \"%s\" found";
7291 else if (value
< 0 && isplus
)
7293 msg
= US
"non-negative integer expected but \"%s\" found";
7297 switch (tolower(*endptr
))
7302 if (value
> EXIM_ARITH_MAX
/1024 || value
< EXIM_ARITH_MIN
/1024) errno
= ERANGE
;
7307 if (value
> EXIM_ARITH_MAX
/(1024*1024) || value
< EXIM_ARITH_MIN
/(1024*1024)) errno
= ERANGE
;
7308 else value
*= 1024*1024;
7312 if (value
> EXIM_ARITH_MAX
/(1024*1024*1024) || value
< EXIM_ARITH_MIN
/(1024*1024*1024)) errno
= ERANGE
;
7313 else value
*= 1024*1024*1024;
7317 if (errno
== ERANGE
)
7318 msg
= US
"absolute value of integer \"%s\" is too large (overflow)";
7321 while (isspace(*endptr
)) endptr
++;
7322 if (*endptr
== 0) return value
;
7326 expand_string_message
= string_sprintf(CS msg
, s
);
7331 /* These values are usually fixed boolean values, but they are permitted to be
7335 addr address being routed
7336 mtype the module type
7337 mname the module name
7338 dbg_opt debug selectors
7339 oname the option name
7340 bvalue the router's boolean value
7341 svalue the router's string value
7342 rvalue where to put the returned value
7344 Returns: OK value placed in rvalue
7345 DEFER expansion failed
7349 exp_bool(address_item
*addr
,
7350 uschar
*mtype
, uschar
*mname
, unsigned dbg_opt
,
7351 uschar
*oname
, BOOL bvalue
,
7352 uschar
*svalue
, BOOL
*rvalue
)
7355 if (svalue
== NULL
) { *rvalue
= bvalue
; return OK
; }
7357 expanded
= expand_string(svalue
);
7358 if (expanded
== NULL
)
7360 if (expand_string_forcedfail
)
7362 DEBUG(dbg_opt
) debug_printf("expansion of \"%s\" forced failure\n", oname
);
7366 addr
->message
= string_sprintf("failed to expand \"%s\" in %s %s: %s",
7367 oname
, mname
, mtype
, expand_string_message
);
7368 DEBUG(dbg_opt
) debug_printf("%s\n", addr
->message
);
7372 DEBUG(dbg_opt
) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname
,
7375 if (strcmpic(expanded
, US
"true") == 0 || strcmpic(expanded
, US
"yes") == 0)
7377 else if (strcmpic(expanded
, US
"false") == 0 || strcmpic(expanded
, US
"no") == 0)
7381 addr
->message
= string_sprintf("\"%s\" is not a valid value for the "
7382 "\"%s\" option in the %s %s", expanded
, oname
, mname
, mtype
);
7392 /*************************************************
7393 **************************************************
7394 * Stand-alone test program *
7395 **************************************************
7396 *************************************************/
7402 regex_match_and_setup(const pcre
*re
, uschar
*subject
, int options
, int setup
)
7404 int ovector
[3*(EXPAND_MAXN
+1)];
7405 int n
= pcre_exec(re
, NULL
, subject
, Ustrlen(subject
), 0, PCRE_EOPT
|options
,
7406 ovector
, nelem(ovector
));
7407 BOOL yield
= n
>= 0;
7408 if (n
== 0) n
= EXPAND_MAXN
+ 1;
7412 expand_nmax
= (setup
< 0)? 0 : setup
+ 1;
7413 for (nn
= (setup
< 0)? 0 : 2; nn
< n
*2; nn
+= 2)
7415 expand_nstring
[expand_nmax
] = subject
+ ovector
[nn
];
7416 expand_nlength
[expand_nmax
++] = ovector
[nn
+1] - ovector
[nn
];
7424 int main(int argc
, uschar
**argv
)
7427 uschar buffer
[1024];
7429 debug_selector
= D_v
;
7430 debug_file
= stderr
;
7431 debug_fd
= fileno(debug_file
);
7432 big_buffer
= malloc(big_buffer_size
);
7434 for (i
= 1; i
< argc
; i
++)
7436 if (argv
[i
][0] == '+')
7438 debug_trace_memory
= 2;
7441 if (isdigit(argv
[i
][0]))
7442 debug_selector
= Ustrtol(argv
[i
], NULL
, 0);
7444 if (Ustrspn(argv
[i
], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
7448 eldap_default_servers
= argv
[i
];
7451 mysql_servers
= argv
[i
];
7454 pgsql_servers
= argv
[i
];
7456 #ifdef EXPERIMENTAL_REDIS
7457 redis_servers
= argv
[i
];
7461 else opt_perl_startup
= argv
[i
];
7465 printf("Testing string expansion: debug_level = %d\n\n", debug_level
);
7467 expand_nstring
[1] = US
"string 1....";
7468 expand_nlength
[1] = 8;
7472 if (opt_perl_startup
!= NULL
)
7475 printf("Starting Perl interpreter\n");
7476 errstr
= init_perl(opt_perl_startup
);
7479 printf("** error in perl_startup code: %s\n", errstr
);
7480 return EXIT_FAILURE
;
7483 #endif /* EXIM_PERL */
7485 while (fgets(buffer
, sizeof(buffer
), stdin
) != NULL
)
7487 void *reset_point
= store_get(0);
7488 uschar
*yield
= expand_string(buffer
);
7491 printf("%s\n", yield
);
7492 store_reset(reset_point
);
7496 if (search_find_defer
) printf("search_find deferred\n");
7497 printf("Failed: %s\n", expand_string_message
);
7498 if (expand_string_forcedfail
) printf("Forced failure\n");
7512 /* End of expand.c */