1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar
*expand_string_internal(const uschar
*, BOOL
, const uschar
**, BOOL
, BOOL
, BOOL
*);
17 static int_eximarith_t
expanded_string_integer(const uschar
*, BOOL
);
20 # ifndef SUPPORT_CRYPTEQ
21 # define SUPPORT_CRYPTEQ
26 # include "lookups/ldap.h"
29 #ifdef SUPPORT_CRYPTEQ
34 extern char* crypt16(char*, char*);
38 /* The handling of crypt16() is a mess. I will record below the analysis of the
39 mess that was sent to me. We decided, however, to make changing this very low
40 priority, because in practice people are moving away from the crypt()
41 algorithms nowadays, so it doesn't seem worth it.
44 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
45 the first 8 characters of the password using a 20-round version of crypt
46 (standard crypt does 25 rounds). It then crypts the next 8 characters,
47 or an empty block if the password is less than 9 characters, using a
48 20-round version of crypt and the same salt as was used for the first
49 block. Characters after the first 16 are ignored. It always generates
50 a 16-byte hash, which is expressed together with the salt as a string
51 of 24 base 64 digits. Here are some links to peruse:
53 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
54 http://seclists.org/bugtraq/1999/Mar/0076.html
56 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
57 and OSF/1. This is the same as the standard crypt if given a password
58 of 8 characters or less. If given more, it first does the same as crypt
59 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
60 using as salt the first two base 64 digits from the first hash block.
61 If the password is more than 16 characters then it crypts the 17th to 24th
62 characters using as salt the first two base 64 digits from the second hash
63 block. And so on: I've seen references to it cutting off the password at
64 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
66 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
67 http://seclists.org/bugtraq/1999/Mar/0109.html
68 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
69 TET1_html/sec.c222.html#no_id_208
71 Exim has something it calls "crypt16". It will either use a native
72 crypt16 or its own implementation. A native crypt16 will presumably
73 be the one that I called "crypt16" above. The internal "crypt16"
74 function, however, is a two-block-maximum implementation of what I called
75 "bigcrypt". The documentation matches the internal code.
77 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
78 that crypt16 and bigcrypt were different things.
80 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
81 to whatever it is using under that name. This unfortunately sets a
82 precedent for using "{crypt16}" to identify two incompatible algorithms
83 whose output can't be distinguished. With "{crypt16}" thus rendered
84 ambiguous, I suggest you deprecate it and invent two new identifiers
85 for the two algorithms.
87 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
88 of the password separately means they can be cracked separately, so
89 the double-length hash only doubles the cracking effort instead of
90 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar
*item_table
[] = {
166 /* Tables of operator names, and corresponding switch numbers. The names must be
167 in alphabetical order. There are two tables, because underscore is used in some
168 cases to introduce arguments, whereas for other it is part of the name. This is
169 an historical mis-design. */
171 static uschar
*op_table_underscore
[] = {
174 US
"quote_local_part",
179 ,US
"utf8_domain_from_alabel",
180 US
"utf8_domain_to_alabel",
181 US
"utf8_localpart_from_alabel",
182 US
"utf8_localpart_to_alabel"
189 EOP_QUOTE_LOCAL_PART
,
194 ,EOP_UTF8_DOMAIN_FROM_ALABEL
,
195 EOP_UTF8_DOMAIN_TO_ALABEL
,
196 EOP_UTF8_LOCALPART_FROM_ALABEL
,
197 EOP_UTF8_LOCALPART_TO_ALABEL
201 static uschar
*op_table_main
[] = {
248 EOP_ADDRESS
= nelem(op_table_underscore
),
294 /* Table of condition names, and corresponding switch numbers. The names must
295 be in alphabetical order. */
297 static uschar
*cond_table
[] = {
301 US
"==", /* Backward compatibility */
334 US
"match_local_part",
359 ECOND_FIRST_DELIVERY
,
380 ECOND_MATCH_LOCAL_PART
,
390 /* Types of table entry */
393 vtype_int
, /* value is address of int */
394 vtype_filter_int
, /* ditto, but recognized only when filtering */
395 vtype_ino
, /* value is address of ino_t (not always an int) */
396 vtype_uid
, /* value is address of uid_t (not always an int) */
397 vtype_gid
, /* value is address of gid_t (not always an int) */
398 vtype_bool
, /* value is address of bool */
399 vtype_stringptr
, /* value is address of pointer to string */
400 vtype_msgbody
, /* as stringptr, but read when first required */
401 vtype_msgbody_end
, /* ditto, the end of the message */
402 vtype_msgheaders
, /* the message's headers, processed */
403 vtype_msgheaders_raw
, /* the message's headers, unprocessed */
404 vtype_localpart
, /* extract local part from string */
405 vtype_domain
, /* extract domain from string */
406 vtype_string_func
, /* value is string returned by given function */
407 vtype_todbsdin
, /* value not used; generate BSD inbox tod */
408 vtype_tode
, /* value not used; generate tod in epoch format */
409 vtype_todel
, /* value not used; generate tod in epoch/usec format */
410 vtype_todf
, /* value not used; generate full tod */
411 vtype_todl
, /* value not used; generate log tod */
412 vtype_todlf
, /* value not used; generate log file datestamp tod */
413 vtype_todzone
, /* value not used; generate time zone only */
414 vtype_todzulu
, /* value not used; generate zulu tod */
415 vtype_reply
, /* value not used; get reply from headers */
416 vtype_pid
, /* value not used; result is pid */
417 vtype_host_lookup
, /* value not used; get host name */
418 vtype_load_avg
, /* value not used; result is int from os_getloadavg */
419 vtype_pspace
, /* partition space; value is T/F for spool/log */
420 vtype_pinodes
, /* partition inodes; value is T/F for spool/log */
421 vtype_cert
/* SSL certificate */
423 ,vtype_dkim
/* Lookup of value in DKIM signature */
427 /* Type for main variable table */
435 /* Type for entries pointing to address/length pairs. Not currently
443 static uschar
* fn_recipients(void);
445 /* This table must be kept in alphabetical order. */
447 static var_entry var_table
[] = {
448 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
449 they will be confused with user-creatable ACL variables. */
450 { "acl_arg1", vtype_stringptr
, &acl_arg
[0] },
451 { "acl_arg2", vtype_stringptr
, &acl_arg
[1] },
452 { "acl_arg3", vtype_stringptr
, &acl_arg
[2] },
453 { "acl_arg4", vtype_stringptr
, &acl_arg
[3] },
454 { "acl_arg5", vtype_stringptr
, &acl_arg
[4] },
455 { "acl_arg6", vtype_stringptr
, &acl_arg
[5] },
456 { "acl_arg7", vtype_stringptr
, &acl_arg
[6] },
457 { "acl_arg8", vtype_stringptr
, &acl_arg
[7] },
458 { "acl_arg9", vtype_stringptr
, &acl_arg
[8] },
459 { "acl_narg", vtype_int
, &acl_narg
},
460 { "acl_verify_message", vtype_stringptr
, &acl_verify_message
},
461 { "address_data", vtype_stringptr
, &deliver_address_data
},
462 { "address_file", vtype_stringptr
, &address_file
},
463 { "address_pipe", vtype_stringptr
, &address_pipe
},
464 #ifdef EXPERIMENTAL_ARC
465 { "arc_domains", vtype_string_func
, &fn_arc_domains
},
466 { "arc_oldest_pass", vtype_int
, &arc_oldest_pass
},
467 { "arc_state", vtype_stringptr
, &arc_state
},
468 { "arc_state_reason", vtype_stringptr
, &arc_state_reason
},
470 { "authenticated_fail_id",vtype_stringptr
, &authenticated_fail_id
},
471 { "authenticated_id", vtype_stringptr
, &authenticated_id
},
472 { "authenticated_sender",vtype_stringptr
, &authenticated_sender
},
473 { "authentication_failed",vtype_int
, &authentication_failed
},
474 #ifdef WITH_CONTENT_SCAN
475 { "av_failed", vtype_int
, &av_failed
},
477 #ifdef EXPERIMENTAL_BRIGHTMAIL
478 { "bmi_alt_location", vtype_stringptr
, &bmi_alt_location
},
479 { "bmi_base64_tracker_verdict", vtype_stringptr
, &bmi_base64_tracker_verdict
},
480 { "bmi_base64_verdict", vtype_stringptr
, &bmi_base64_verdict
},
481 { "bmi_deliver", vtype_int
, &bmi_deliver
},
483 { "body_linecount", vtype_int
, &body_linecount
},
484 { "body_zerocount", vtype_int
, &body_zerocount
},
485 { "bounce_recipient", vtype_stringptr
, &bounce_recipient
},
486 { "bounce_return_size_limit", vtype_int
, &bounce_return_size_limit
},
487 { "caller_gid", vtype_gid
, &real_gid
},
488 { "caller_uid", vtype_uid
, &real_uid
},
489 { "callout_address", vtype_stringptr
, &callout_address
},
490 { "compile_date", vtype_stringptr
, &version_date
},
491 { "compile_number", vtype_stringptr
, &version_cnumber
},
492 { "config_dir", vtype_stringptr
, &config_main_directory
},
493 { "config_file", vtype_stringptr
, &config_main_filename
},
494 { "csa_status", vtype_stringptr
, &csa_status
},
495 #ifdef EXPERIMENTAL_DCC
496 { "dcc_header", vtype_stringptr
, &dcc_header
},
497 { "dcc_result", vtype_stringptr
, &dcc_result
},
500 { "dkim_algo", vtype_dkim
, (void *)DKIM_ALGO
},
501 { "dkim_bodylength", vtype_dkim
, (void *)DKIM_BODYLENGTH
},
502 { "dkim_canon_body", vtype_dkim
, (void *)DKIM_CANON_BODY
},
503 { "dkim_canon_headers", vtype_dkim
, (void *)DKIM_CANON_HEADERS
},
504 { "dkim_copiedheaders", vtype_dkim
, (void *)DKIM_COPIEDHEADERS
},
505 { "dkim_created", vtype_dkim
, (void *)DKIM_CREATED
},
506 { "dkim_cur_signer", vtype_stringptr
, &dkim_cur_signer
},
507 { "dkim_domain", vtype_stringptr
, &dkim_signing_domain
},
508 { "dkim_expires", vtype_dkim
, (void *)DKIM_EXPIRES
},
509 { "dkim_headernames", vtype_dkim
, (void *)DKIM_HEADERNAMES
},
510 { "dkim_identity", vtype_dkim
, (void *)DKIM_IDENTITY
},
511 { "dkim_key_granularity",vtype_dkim
, (void *)DKIM_KEY_GRANULARITY
},
512 { "dkim_key_length", vtype_int
, &dkim_key_length
},
513 { "dkim_key_nosubdomains",vtype_dkim
, (void *)DKIM_NOSUBDOMAINS
},
514 { "dkim_key_notes", vtype_dkim
, (void *)DKIM_KEY_NOTES
},
515 { "dkim_key_srvtype", vtype_dkim
, (void *)DKIM_KEY_SRVTYPE
},
516 { "dkim_key_testing", vtype_dkim
, (void *)DKIM_KEY_TESTING
},
517 { "dkim_selector", vtype_stringptr
, &dkim_signing_selector
},
518 { "dkim_signers", vtype_stringptr
, &dkim_signers
},
519 { "dkim_verify_reason", vtype_stringptr
, &dkim_verify_reason
},
520 { "dkim_verify_status", vtype_stringptr
, &dkim_verify_status
},
522 #ifdef EXPERIMENTAL_DMARC
523 { "dmarc_domain_policy", vtype_stringptr
, &dmarc_domain_policy
},
524 { "dmarc_status", vtype_stringptr
, &dmarc_status
},
525 { "dmarc_status_text", vtype_stringptr
, &dmarc_status_text
},
526 { "dmarc_used_domain", vtype_stringptr
, &dmarc_used_domain
},
528 { "dnslist_domain", vtype_stringptr
, &dnslist_domain
},
529 { "dnslist_matched", vtype_stringptr
, &dnslist_matched
},
530 { "dnslist_text", vtype_stringptr
, &dnslist_text
},
531 { "dnslist_value", vtype_stringptr
, &dnslist_value
},
532 { "domain", vtype_stringptr
, &deliver_domain
},
533 { "domain_data", vtype_stringptr
, &deliver_domain_data
},
534 #ifndef DISABLE_EVENT
535 { "event_data", vtype_stringptr
, &event_data
},
537 /*XXX want to use generic vars for as many of these as possible*/
538 { "event_defer_errno", vtype_int
, &event_defer_errno
},
540 { "event_name", vtype_stringptr
, &event_name
},
542 { "exim_gid", vtype_gid
, &exim_gid
},
543 { "exim_path", vtype_stringptr
, &exim_path
},
544 { "exim_uid", vtype_uid
, &exim_uid
},
545 { "exim_version", vtype_stringptr
, &version_string
},
546 { "headers_added", vtype_string_func
, &fn_hdrs_added
},
547 { "home", vtype_stringptr
, &deliver_home
},
548 { "host", vtype_stringptr
, &deliver_host
},
549 { "host_address", vtype_stringptr
, &deliver_host_address
},
550 { "host_data", vtype_stringptr
, &host_data
},
551 { "host_lookup_deferred",vtype_int
, &host_lookup_deferred
},
552 { "host_lookup_failed", vtype_int
, &host_lookup_failed
},
553 { "host_port", vtype_int
, &deliver_host_port
},
554 { "initial_cwd", vtype_stringptr
, &initial_cwd
},
555 { "inode", vtype_ino
, &deliver_inode
},
556 { "interface_address", vtype_stringptr
, &interface_address
},
557 { "interface_port", vtype_int
, &interface_port
},
558 { "item", vtype_stringptr
, &iterate_item
},
560 { "ldap_dn", vtype_stringptr
, &eldap_dn
},
562 { "load_average", vtype_load_avg
, NULL
},
563 { "local_part", vtype_stringptr
, &deliver_localpart
},
564 { "local_part_data", vtype_stringptr
, &deliver_localpart_data
},
565 { "local_part_prefix", vtype_stringptr
, &deliver_localpart_prefix
},
566 { "local_part_suffix", vtype_stringptr
, &deliver_localpart_suffix
},
567 #ifdef HAVE_LOCAL_SCAN
568 { "local_scan_data", vtype_stringptr
, &local_scan_data
},
570 { "local_user_gid", vtype_gid
, &local_user_gid
},
571 { "local_user_uid", vtype_uid
, &local_user_uid
},
572 { "localhost_number", vtype_int
, &host_number
},
573 { "log_inodes", vtype_pinodes
, (void *)FALSE
},
574 { "log_space", vtype_pspace
, (void *)FALSE
},
575 { "lookup_dnssec_authenticated",vtype_stringptr
,&lookup_dnssec_authenticated
},
576 { "mailstore_basename", vtype_stringptr
, &mailstore_basename
},
577 #ifdef WITH_CONTENT_SCAN
578 { "malware_name", vtype_stringptr
, &malware_name
},
580 { "max_received_linelength", vtype_int
, &max_received_linelength
},
581 { "message_age", vtype_int
, &message_age
},
582 { "message_body", vtype_msgbody
, &message_body
},
583 { "message_body_end", vtype_msgbody_end
, &message_body_end
},
584 { "message_body_size", vtype_int
, &message_body_size
},
585 { "message_exim_id", vtype_stringptr
, &message_id
},
586 { "message_headers", vtype_msgheaders
, NULL
},
587 { "message_headers_raw", vtype_msgheaders_raw
, NULL
},
588 { "message_id", vtype_stringptr
, &message_id
},
589 { "message_linecount", vtype_int
, &message_linecount
},
590 { "message_size", vtype_int
, &message_size
},
592 { "message_smtputf8", vtype_bool
, &message_smtputf8
},
594 #ifdef WITH_CONTENT_SCAN
595 { "mime_anomaly_level", vtype_int
, &mime_anomaly_level
},
596 { "mime_anomaly_text", vtype_stringptr
, &mime_anomaly_text
},
597 { "mime_boundary", vtype_stringptr
, &mime_boundary
},
598 { "mime_charset", vtype_stringptr
, &mime_charset
},
599 { "mime_content_description", vtype_stringptr
, &mime_content_description
},
600 { "mime_content_disposition", vtype_stringptr
, &mime_content_disposition
},
601 { "mime_content_id", vtype_stringptr
, &mime_content_id
},
602 { "mime_content_size", vtype_int
, &mime_content_size
},
603 { "mime_content_transfer_encoding",vtype_stringptr
, &mime_content_transfer_encoding
},
604 { "mime_content_type", vtype_stringptr
, &mime_content_type
},
605 { "mime_decoded_filename", vtype_stringptr
, &mime_decoded_filename
},
606 { "mime_filename", vtype_stringptr
, &mime_filename
},
607 { "mime_is_coverletter", vtype_int
, &mime_is_coverletter
},
608 { "mime_is_multipart", vtype_int
, &mime_is_multipart
},
609 { "mime_is_rfc822", vtype_int
, &mime_is_rfc822
},
610 { "mime_part_count", vtype_int
, &mime_part_count
},
612 { "n0", vtype_filter_int
, &filter_n
[0] },
613 { "n1", vtype_filter_int
, &filter_n
[1] },
614 { "n2", vtype_filter_int
, &filter_n
[2] },
615 { "n3", vtype_filter_int
, &filter_n
[3] },
616 { "n4", vtype_filter_int
, &filter_n
[4] },
617 { "n5", vtype_filter_int
, &filter_n
[5] },
618 { "n6", vtype_filter_int
, &filter_n
[6] },
619 { "n7", vtype_filter_int
, &filter_n
[7] },
620 { "n8", vtype_filter_int
, &filter_n
[8] },
621 { "n9", vtype_filter_int
, &filter_n
[9] },
622 { "original_domain", vtype_stringptr
, &deliver_domain_orig
},
623 { "original_local_part", vtype_stringptr
, &deliver_localpart_orig
},
624 { "originator_gid", vtype_gid
, &originator_gid
},
625 { "originator_uid", vtype_uid
, &originator_uid
},
626 { "parent_domain", vtype_stringptr
, &deliver_domain_parent
},
627 { "parent_local_part", vtype_stringptr
, &deliver_localpart_parent
},
628 { "pid", vtype_pid
, NULL
},
630 { "prdr_requested", vtype_bool
, &prdr_requested
},
632 { "primary_hostname", vtype_stringptr
, &primary_hostname
},
633 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
634 { "proxy_external_address",vtype_stringptr
, &proxy_external_address
},
635 { "proxy_external_port", vtype_int
, &proxy_external_port
},
636 { "proxy_local_address", vtype_stringptr
, &proxy_local_address
},
637 { "proxy_local_port", vtype_int
, &proxy_local_port
},
638 { "proxy_session", vtype_bool
, &proxy_session
},
640 { "prvscheck_address", vtype_stringptr
, &prvscheck_address
},
641 { "prvscheck_keynum", vtype_stringptr
, &prvscheck_keynum
},
642 { "prvscheck_result", vtype_stringptr
, &prvscheck_result
},
643 { "qualify_domain", vtype_stringptr
, &qualify_domain_sender
},
644 { "qualify_recipient", vtype_stringptr
, &qualify_domain_recipient
},
645 { "queue_name", vtype_stringptr
, &queue_name
},
646 { "rcpt_count", vtype_int
, &rcpt_count
},
647 { "rcpt_defer_count", vtype_int
, &rcpt_defer_count
},
648 { "rcpt_fail_count", vtype_int
, &rcpt_fail_count
},
649 { "received_count", vtype_int
, &received_count
},
650 { "received_for", vtype_stringptr
, &received_for
},
651 { "received_ip_address", vtype_stringptr
, &interface_address
},
652 { "received_port", vtype_int
, &interface_port
},
653 { "received_protocol", vtype_stringptr
, &received_protocol
},
654 { "received_time", vtype_int
, &received_time
.tv_sec
},
655 { "recipient_data", vtype_stringptr
, &recipient_data
},
656 { "recipient_verify_failure",vtype_stringptr
,&recipient_verify_failure
},
657 { "recipients", vtype_string_func
, &fn_recipients
},
658 { "recipients_count", vtype_int
, &recipients_count
},
659 #ifdef WITH_CONTENT_SCAN
660 { "regex_match_string", vtype_stringptr
, ®ex_match_string
},
662 { "reply_address", vtype_reply
, NULL
},
663 { "return_path", vtype_stringptr
, &return_path
},
664 { "return_size_limit", vtype_int
, &bounce_return_size_limit
},
665 { "router_name", vtype_stringptr
, &router_name
},
666 { "runrc", vtype_int
, &runrc
},
667 { "self_hostname", vtype_stringptr
, &self_hostname
},
668 { "sender_address", vtype_stringptr
, &sender_address
},
669 { "sender_address_data", vtype_stringptr
, &sender_address_data
},
670 { "sender_address_domain", vtype_domain
, &sender_address
},
671 { "sender_address_local_part", vtype_localpart
, &sender_address
},
672 { "sender_data", vtype_stringptr
, &sender_data
},
673 { "sender_fullhost", vtype_stringptr
, &sender_fullhost
},
674 { "sender_helo_dnssec", vtype_bool
, &sender_helo_dnssec
},
675 { "sender_helo_name", vtype_stringptr
, &sender_helo_name
},
676 { "sender_host_address", vtype_stringptr
, &sender_host_address
},
677 { "sender_host_authenticated",vtype_stringptr
, &sender_host_authenticated
},
678 { "sender_host_dnssec", vtype_bool
, &sender_host_dnssec
},
679 { "sender_host_name", vtype_host_lookup
, NULL
},
680 { "sender_host_port", vtype_int
, &sender_host_port
},
681 { "sender_ident", vtype_stringptr
, &sender_ident
},
682 { "sender_rate", vtype_stringptr
, &sender_rate
},
683 { "sender_rate_limit", vtype_stringptr
, &sender_rate_limit
},
684 { "sender_rate_period", vtype_stringptr
, &sender_rate_period
},
685 { "sender_rcvhost", vtype_stringptr
, &sender_rcvhost
},
686 { "sender_verify_failure",vtype_stringptr
, &sender_verify_failure
},
687 { "sending_ip_address", vtype_stringptr
, &sending_ip_address
},
688 { "sending_port", vtype_int
, &sending_port
},
689 { "smtp_active_hostname", vtype_stringptr
, &smtp_active_hostname
},
690 { "smtp_command", vtype_stringptr
, &smtp_cmd_buffer
},
691 { "smtp_command_argument", vtype_stringptr
, &smtp_cmd_argument
},
692 { "smtp_command_history", vtype_string_func
, &smtp_cmd_hist
},
693 { "smtp_count_at_connection_start", vtype_int
, &smtp_accept_count
},
694 { "smtp_notquit_reason", vtype_stringptr
, &smtp_notquit_reason
},
695 { "sn0", vtype_filter_int
, &filter_sn
[0] },
696 { "sn1", vtype_filter_int
, &filter_sn
[1] },
697 { "sn2", vtype_filter_int
, &filter_sn
[2] },
698 { "sn3", vtype_filter_int
, &filter_sn
[3] },
699 { "sn4", vtype_filter_int
, &filter_sn
[4] },
700 { "sn5", vtype_filter_int
, &filter_sn
[5] },
701 { "sn6", vtype_filter_int
, &filter_sn
[6] },
702 { "sn7", vtype_filter_int
, &filter_sn
[7] },
703 { "sn8", vtype_filter_int
, &filter_sn
[8] },
704 { "sn9", vtype_filter_int
, &filter_sn
[9] },
705 #ifdef WITH_CONTENT_SCAN
706 { "spam_action", vtype_stringptr
, &spam_action
},
707 { "spam_bar", vtype_stringptr
, &spam_bar
},
708 { "spam_report", vtype_stringptr
, &spam_report
},
709 { "spam_score", vtype_stringptr
, &spam_score
},
710 { "spam_score_int", vtype_stringptr
, &spam_score_int
},
713 { "spf_guess", vtype_stringptr
, &spf_guess
},
714 { "spf_header_comment", vtype_stringptr
, &spf_header_comment
},
715 { "spf_received", vtype_stringptr
, &spf_received
},
716 { "spf_result", vtype_stringptr
, &spf_result
},
717 { "spf_result_guessed", vtype_bool
, &spf_result_guessed
},
718 { "spf_smtp_comment", vtype_stringptr
, &spf_smtp_comment
},
720 { "spool_directory", vtype_stringptr
, &spool_directory
},
721 { "spool_inodes", vtype_pinodes
, (void *)TRUE
},
722 { "spool_space", vtype_pspace
, (void *)TRUE
},
723 #ifdef EXPERIMENTAL_SRS
724 { "srs_db_address", vtype_stringptr
, &srs_db_address
},
725 { "srs_db_key", vtype_stringptr
, &srs_db_key
},
726 { "srs_orig_recipient", vtype_stringptr
, &srs_orig_recipient
},
727 { "srs_orig_sender", vtype_stringptr
, &srs_orig_sender
},
728 { "srs_recipient", vtype_stringptr
, &srs_recipient
},
729 { "srs_status", vtype_stringptr
, &srs_status
},
731 { "thisaddress", vtype_stringptr
, &filter_thisaddress
},
733 /* The non-(in,out) variables are now deprecated */
734 { "tls_bits", vtype_int
, &tls_in
.bits
},
735 { "tls_certificate_verified", vtype_int
, &tls_in
.certificate_verified
},
736 { "tls_cipher", vtype_stringptr
, &tls_in
.cipher
},
738 { "tls_in_bits", vtype_int
, &tls_in
.bits
},
739 { "tls_in_certificate_verified", vtype_int
, &tls_in
.certificate_verified
},
740 { "tls_in_cipher", vtype_stringptr
, &tls_in
.cipher
},
741 { "tls_in_ocsp", vtype_int
, &tls_in
.ocsp
},
742 { "tls_in_ourcert", vtype_cert
, &tls_in
.ourcert
},
743 { "tls_in_peercert", vtype_cert
, &tls_in
.peercert
},
744 { "tls_in_peerdn", vtype_stringptr
, &tls_in
.peerdn
},
745 #if defined(SUPPORT_TLS)
746 { "tls_in_sni", vtype_stringptr
, &tls_in
.sni
},
748 { "tls_out_bits", vtype_int
, &tls_out
.bits
},
749 { "tls_out_certificate_verified", vtype_int
,&tls_out
.certificate_verified
},
750 { "tls_out_cipher", vtype_stringptr
, &tls_out
.cipher
},
752 { "tls_out_dane", vtype_bool
, &tls_out
.dane_verified
},
754 { "tls_out_ocsp", vtype_int
, &tls_out
.ocsp
},
755 { "tls_out_ourcert", vtype_cert
, &tls_out
.ourcert
},
756 { "tls_out_peercert", vtype_cert
, &tls_out
.peercert
},
757 { "tls_out_peerdn", vtype_stringptr
, &tls_out
.peerdn
},
758 #if defined(SUPPORT_TLS)
759 { "tls_out_sni", vtype_stringptr
, &tls_out
.sni
},
762 { "tls_out_tlsa_usage", vtype_int
, &tls_out
.tlsa_usage
},
765 { "tls_peerdn", vtype_stringptr
, &tls_in
.peerdn
}, /* mind the alphabetical order! */
766 #if defined(SUPPORT_TLS)
767 { "tls_sni", vtype_stringptr
, &tls_in
.sni
}, /* mind the alphabetical order! */
770 { "tod_bsdinbox", vtype_todbsdin
, NULL
},
771 { "tod_epoch", vtype_tode
, NULL
},
772 { "tod_epoch_l", vtype_todel
, NULL
},
773 { "tod_full", vtype_todf
, NULL
},
774 { "tod_log", vtype_todl
, NULL
},
775 { "tod_logfile", vtype_todlf
, NULL
},
776 { "tod_zone", vtype_todzone
, NULL
},
777 { "tod_zulu", vtype_todzulu
, NULL
},
778 { "transport_name", vtype_stringptr
, &transport_name
},
779 { "value", vtype_stringptr
, &lookup_value
},
780 { "verify_mode", vtype_stringptr
, &verify_mode
},
781 { "version_number", vtype_stringptr
, &version_string
},
782 { "warn_message_delay", vtype_stringptr
, &warnmsg_delay
},
783 { "warn_message_recipient",vtype_stringptr
, &warnmsg_recipients
},
784 { "warn_message_recipients",vtype_stringptr
,&warnmsg_recipients
},
785 { "warnmsg_delay", vtype_stringptr
, &warnmsg_delay
},
786 { "warnmsg_recipient", vtype_stringptr
, &warnmsg_recipients
},
787 { "warnmsg_recipients", vtype_stringptr
, &warnmsg_recipients
}
790 static int var_table_size
= nelem(var_table
);
791 static uschar var_buffer
[256];
792 static BOOL malformed_header
;
794 /* For textual hashes */
796 static const char *hashcodes
= "abcdefghijklmnopqrtsuvwxyz"
797 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
800 enum { HMAC_MD5
, HMAC_SHA1
};
802 /* For numeric hashes */
804 static unsigned int prime
[] = {
805 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
806 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
807 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
809 /* For printing modes in symbolic form */
811 static uschar
*mtable_normal
[] =
812 { US
"---", US
"--x", US
"-w-", US
"-wx", US
"r--", US
"r-x", US
"rw-", US
"rwx" };
814 static uschar
*mtable_setid
[] =
815 { US
"--S", US
"--s", US
"-wS", US
"-ws", US
"r-S", US
"r-s", US
"rwS", US
"rws" };
817 static uschar
*mtable_sticky
[] =
818 { US
"--T", US
"--t", US
"-wT", US
"-wt", US
"r-T", US
"r-t", US
"rwT", US
"rwt" };
820 /* flags for find_header() */
821 #define FH_EXISTS_ONLY BIT(0)
822 #define FH_WANT_RAW BIT(1)
823 #define FH_WANT_LIST BIT(2)
826 /*************************************************
827 * Tables for UTF-8 support *
828 *************************************************/
830 /* Table of the number of extra characters, indexed by the first character
831 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
834 static uschar utf8_table1
[] = {
835 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
836 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
837 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
838 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
840 /* These are the masks for the data bits in the first byte of a character,
841 indexed by the number of additional bytes. */
843 static int utf8_table2
[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
845 /* Get the next UTF-8 character, advancing the pointer. */
847 #define GETUTF8INC(c, ptr) \
849 if ((c & 0xc0) == 0xc0) \
851 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
853 c = (c & utf8_table2[a]) << s; \
857 c |= (*ptr++ & 0x3f) << s; \
863 static uschar
* base32_chars
= US
"abcdefghijklmnopqrstuvwxyz234567";
865 /*************************************************
866 * Binary chop search on a table *
867 *************************************************/
869 /* This is used for matching expansion items and operators.
872 name the name that is being sought
873 table the table to search
874 table_size the number of items in the table
876 Returns: the offset in the table, or -1
880 chop_match(uschar
*name
, uschar
**table
, int table_size
)
882 uschar
**bot
= table
;
883 uschar
**top
= table
+ table_size
;
887 uschar
**mid
= bot
+ (top
- bot
)/2;
888 int c
= Ustrcmp(name
, *mid
);
889 if (c
== 0) return mid
- table
;
890 if (c
> 0) bot
= mid
+ 1; else top
= mid
;
898 /*************************************************
899 * Check a condition string *
900 *************************************************/
902 /* This function is called to expand a string, and test the result for a "true"
903 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
904 forced fail or lookup defer.
906 We used to release all store used, but this is not not safe due
907 to ${dlfunc } and ${acl }. In any case expand_string_internal()
908 is reasonably careful to release what it can.
910 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
913 condition the condition string
914 m1 text to be incorporated in panic error
917 Returns: TRUE if condition is met, FALSE if not
921 expand_check_condition(uschar
*condition
, uschar
*m1
, uschar
*m2
)
924 uschar
*ss
= expand_string(condition
);
927 if (!expand_string_forcedfail
&& !search_find_defer
)
928 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand condition \"%s\" "
929 "for %s %s: %s", condition
, m1
, m2
, expand_string_message
);
932 rc
= ss
[0] != 0 && Ustrcmp(ss
, "0") != 0 && strcmpic(ss
, US
"no") != 0 &&
933 strcmpic(ss
, US
"false") != 0;
940 /*************************************************
941 * Pseudo-random number generation *
942 *************************************************/
944 /* Pseudo-random number generation. The result is not "expected" to be
945 cryptographically strong but not so weak that someone will shoot themselves
946 in the foot using it as a nonce in some email header scheme or whatever
947 weirdness they'll twist this into. The result should ideally handle fork().
949 However, if we're stuck unable to provide this, then we'll fall back to
950 appallingly bad randomness.
952 If SUPPORT_TLS is defined then this will not be used except as an emergency
957 Returns a random number in range [0, max-1]
961 # define vaguely_random_number vaguely_random_number_fallback
964 vaguely_random_number(int max
)
967 # undef vaguely_random_number
969 static pid_t pid
= 0;
971 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
981 #ifdef HAVE_ARC4RANDOM
982 /* cryptographically strong randomness, common on *BSD platforms, not
983 so much elsewhere. Alas. */
984 #ifndef NOT_HAVE_ARC4RANDOM_STIR
987 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
988 #ifdef HAVE_SRANDOMDEV
989 /* uses random(4) for seeding */
992 gettimeofday(&tv
, NULL
);
993 srandom(tv
.tv_sec
| tv
.tv_usec
| getpid());
996 /* Poor randomness and no seeding here */
1003 #ifdef HAVE_ARC4RANDOM
1004 return arc4random() % max
;
1005 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1006 return random() % max
;
1008 /* This one returns a 16-bit number, definitely not crypto-strong */
1009 return random_number(max
);
1016 /*************************************************
1017 * Pick out a name from a string *
1018 *************************************************/
1020 /* If the name is too long, it is silently truncated.
1023 name points to a buffer into which to put the name
1024 max is the length of the buffer
1025 s points to the first alphabetic character of the name
1026 extras chars other than alphanumerics to permit
1028 Returns: pointer to the first character after the name
1030 Note: The test for *s != 0 in the while loop is necessary because
1031 Ustrchr() yields non-NULL if the character is zero (which is not something
1034 static const uschar
*
1035 read_name(uschar
*name
, int max
, const uschar
*s
, uschar
*extras
)
1038 while (*s
!= 0 && (isalnum(*s
) || Ustrchr(extras
, *s
) != NULL
))
1040 if (ptr
< max
-1) name
[ptr
++] = *s
;
1049 /*************************************************
1050 * Pick out the rest of a header name *
1051 *************************************************/
1053 /* A variable name starting $header_ (or just $h_ for those who like
1054 abbreviations) might not be the complete header name because headers can
1055 contain any printing characters in their names, except ':'. This function is
1056 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1057 on the end, if the name was terminated by white space.
1060 name points to a buffer in which the name read so far exists
1061 max is the length of the buffer
1062 s points to the first character after the name so far, i.e. the
1063 first non-alphameric character after $header_xxxxx
1065 Returns: a pointer to the first character after the header name
1068 static const uschar
*
1069 read_header_name(uschar
*name
, int max
, const uschar
*s
)
1071 int prelen
= Ustrchr(name
, '_') - name
+ 1;
1072 int ptr
= Ustrlen(name
) - prelen
;
1073 if (ptr
> 0) memmove(name
, name
+prelen
, ptr
);
1074 while (mac_isgraph(*s
) && *s
!= ':')
1076 if (ptr
< max
-1) name
[ptr
++] = *s
;
1087 /*************************************************
1088 * Pick out a number from a string *
1089 *************************************************/
1092 n points to an integer into which to put the number
1093 s points to the first digit of the number
1095 Returns: a pointer to the character after the last digit
1097 /*XXX consider expanding to int_eximarith_t. But the test for
1098 "overbig numbers" in 0002 still needs to overflow it. */
1101 read_number(int *n
, uschar
*s
)
1104 while (isdigit(*s
)) *n
= *n
* 10 + (*s
++ - '0');
1108 static const uschar
*
1109 read_cnumber(int *n
, const uschar
*s
)
1112 while (isdigit(*s
)) *n
= *n
* 10 + (*s
++ - '0');
1118 /*************************************************
1119 * Extract keyed subfield from a string *
1120 *************************************************/
1122 /* The yield is in dynamic store; NULL means that the key was not found.
1125 key points to the name of the key
1126 s points to the string from which to extract the subfield
1128 Returns: NULL if the subfield was not found, or
1129 a pointer to the subfield's data
1133 expand_getkeyed(uschar
*key
, const uschar
*s
)
1135 int length
= Ustrlen(key
);
1136 while (isspace(*s
)) s
++;
1138 /* Loop to search for the key */
1144 const uschar
*dkey
= s
;
1146 while (*s
!= 0 && *s
!= '=' && !isspace(*s
)) s
++;
1147 dkeylength
= s
- dkey
;
1148 while (isspace(*s
)) s
++;
1149 if (*s
== '=') while (isspace((*(++s
))));
1151 data
= string_dequote(&s
);
1152 if (length
== dkeylength
&& strncmpic(key
, dkey
, length
) == 0)
1155 while (isspace(*s
)) s
++;
1164 find_var_ent(uschar
* name
)
1167 int last
= var_table_size
;
1169 while (last
> first
)
1171 int middle
= (first
+ last
)/2;
1172 int c
= Ustrcmp(name
, var_table
[middle
].name
);
1174 if (c
> 0) { first
= middle
+ 1; continue; }
1175 if (c
< 0) { last
= middle
; continue; }
1176 return &var_table
[middle
];
1181 /*************************************************
1182 * Extract numbered subfield from string *
1183 *************************************************/
1185 /* Extracts a numbered field from a string that is divided by tokens - for
1186 example a line from /etc/passwd is divided by colon characters. First field is
1187 numbered one. Negative arguments count from the right. Zero returns the whole
1188 string. Returns NULL if there are insufficient tokens in the string
1191 Modifies final argument - this is a dynamically generated string, so that's OK.
1194 field number of field to be extracted,
1195 first field = 1, whole string = 0, last field = -1
1196 separators characters that are used to break string into tokens
1197 s points to the string from which to extract the subfield
1199 Returns: NULL if the field was not found,
1200 a pointer to the field's data inside s (modified to add 0)
1204 expand_gettokened (int field
, uschar
*separators
, uschar
*s
)
1209 uschar
*fieldtext
= NULL
;
1211 if (field
== 0) return s
;
1213 /* Break the line up into fields in place; for field > 0 we stop when we have
1214 done the number of fields we want. For field < 0 we continue till the end of
1215 the string, counting the number of fields. */
1217 count
= (field
> 0)? field
: INT_MAX
;
1223 /* Previous field was the last one in the string. For a positive field
1224 number, this means there are not enough fields. For a negative field number,
1225 check that there are enough, and scan back to find the one that is wanted. */
1229 if (field
> 0 || (-field
) > (INT_MAX
- count
- 1)) return NULL
;
1230 if ((-field
) == (INT_MAX
- count
- 1)) return s
;
1234 while (ss
[-1] != 0) ss
--;
1240 /* Previous field was not last in the string; save its start and put a
1244 len
= Ustrcspn(ss
, separators
);
1255 expand_getlistele(int field
, const uschar
* list
)
1257 const uschar
* tlist
= list
;
1263 for(field
++; string_nextinlist(&tlist
, &sep
, &dummy
, 1); ) field
++;
1266 if(field
==0) return NULL
;
1267 while(--field
>0 && (string_nextinlist(&list
, &sep
, &dummy
, 1))) ;
1268 return string_nextinlist(&list
, &sep
, NULL
, 0);
1272 /* Certificate fields, by name. Worry about by-OID later */
1273 /* Names are chosen to not have common prefixes */
1280 uschar
* (*getfn
)(void * cert
, uschar
* mod
);
1282 static certfield certfields
[] =
1283 { /* linear search; no special order */
1284 { US
"version", 7, &tls_cert_version
},
1285 { US
"serial_number", 13, &tls_cert_serial_number
},
1286 { US
"subject", 7, &tls_cert_subject
},
1287 { US
"notbefore", 9, &tls_cert_not_before
},
1288 { US
"notafter", 8, &tls_cert_not_after
},
1289 { US
"issuer", 6, &tls_cert_issuer
},
1290 { US
"signature", 9, &tls_cert_signature
},
1291 { US
"sig_algorithm", 13, &tls_cert_signature_algorithm
},
1292 { US
"subj_altname", 12, &tls_cert_subject_altname
},
1293 { US
"ocsp_uri", 8, &tls_cert_ocsp_uri
},
1294 { US
"crl_uri", 7, &tls_cert_crl_uri
},
1298 expand_getcertele(uschar
* field
, uschar
* certvar
)
1303 if (!(vp
= find_var_ent(certvar
)))
1305 expand_string_message
=
1306 string_sprintf("no variable named \"%s\"", certvar
);
1307 return NULL
; /* Unknown variable name */
1309 /* NB this stops us passing certs around in variable. Might
1310 want to do that in future */
1311 if (vp
->type
!= vtype_cert
)
1313 expand_string_message
=
1314 string_sprintf("\"%s\" is not a certificate", certvar
);
1315 return NULL
; /* Unknown variable name */
1317 if (!*(void **)vp
->value
)
1320 if (*field
>= '0' && *field
<= '9')
1321 return tls_cert_ext_by_oid(*(void **)vp
->value
, field
, 0);
1323 for(cp
= certfields
;
1324 cp
< certfields
+ nelem(certfields
);
1326 if (Ustrncmp(cp
->name
, field
, cp
->namelen
) == 0)
1328 uschar
* modifier
= *(field
+= cp
->namelen
) == ','
1330 return (*cp
->getfn
)( *(void **)vp
->value
, modifier
);
1333 expand_string_message
=
1334 string_sprintf("bad field selector \"%s\" for certextract", field
);
1337 #endif /*SUPPORT_TLS*/
1339 /*************************************************
1340 * Extract a substring from a string *
1341 *************************************************/
1343 /* Perform the ${substr or ${length expansion operations.
1346 subject the input string
1347 value1 the offset from the start of the input string to the start of
1348 the output string; if negative, count from the right.
1349 value2 the length of the output string, or negative (-1) for unset
1350 if value1 is positive, unset means "all after"
1351 if value1 is negative, unset means "all before"
1352 len set to the length of the returned string
1354 Returns: pointer to the output string, or NULL if there is an error
1358 extract_substr(uschar
*subject
, int value1
, int value2
, int *len
)
1360 int sublen
= Ustrlen(subject
);
1362 if (value1
< 0) /* count from right */
1366 /* If the position is before the start, skip to the start, and adjust the
1367 length. If the length ends up negative, the substring is null because nothing
1368 can precede. This falls out naturally when the length is unset, meaning "all
1374 if (value2
< 0) value2
= 0;
1378 /* Otherwise an unset length => characters before value1 */
1380 else if (value2
< 0)
1387 /* For a non-negative offset, if the starting position is past the end of the
1388 string, the result will be the null string. Otherwise, an unset length means
1389 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1393 if (value1
> sublen
)
1398 else if (value2
< 0) value2
= sublen
;
1401 /* Cut the length down to the maximum possible for the offset value, and get
1402 the required characters. */
1404 if (value1
+ value2
> sublen
) value2
= sublen
- value1
;
1406 return subject
+ value1
;
1412 /*************************************************
1413 * Old-style hash of a string *
1414 *************************************************/
1416 /* Perform the ${hash expansion operation.
1419 subject the input string (an expanded substring)
1420 value1 the length of the output string; if greater or equal to the
1421 length of the input string, the input string is returned
1422 value2 the number of hash characters to use, or 26 if negative
1423 len set to the length of the returned string
1425 Returns: pointer to the output string, or NULL if there is an error
1429 compute_hash(uschar
*subject
, int value1
, int value2
, int *len
)
1431 int sublen
= Ustrlen(subject
);
1433 if (value2
< 0) value2
= 26;
1434 else if (value2
> Ustrlen(hashcodes
))
1436 expand_string_message
=
1437 string_sprintf("hash count \"%d\" too big", value2
);
1441 /* Calculate the hash text. We know it is shorter than the original string, so
1442 can safely place it in subject[] (we know that subject is always itself an
1443 expanded substring). */
1445 if (value1
< sublen
)
1450 while ((c
= (subject
[j
])) != 0)
1452 int shift
= (c
+ j
++) & 7;
1453 subject
[i
] ^= (c
<< shift
) | (c
>> (8-shift
));
1454 if (++i
>= value1
) i
= 0;
1456 for (i
= 0; i
< value1
; i
++)
1457 subject
[i
] = hashcodes
[(subject
[i
]) % value2
];
1459 else value1
= sublen
;
1468 /*************************************************
1469 * Numeric hash of a string *
1470 *************************************************/
1472 /* Perform the ${nhash expansion operation. The first characters of the
1473 string are treated as most important, and get the highest prime numbers.
1476 subject the input string
1477 value1 the maximum value of the first part of the result
1478 value2 the maximum value of the second part of the result,
1479 or negative to produce only a one-part result
1480 len set to the length of the returned string
1482 Returns: pointer to the output string, or NULL if there is an error.
1486 compute_nhash (uschar
*subject
, int value1
, int value2
, int *len
)
1488 uschar
*s
= subject
;
1490 unsigned long int total
= 0; /* no overflow */
1494 if (i
== 0) i
= nelem(prime
) - 1;
1495 total
+= prime
[i
--] * (unsigned int)(*s
++);
1498 /* If value2 is unset, just compute one number */
1501 s
= string_sprintf("%lu", total
% value1
);
1503 /* Otherwise do a div/mod hash */
1507 total
= total
% (value1
* value2
);
1508 s
= string_sprintf("%lu/%lu", total
/value2
, total
% value2
);
1519 /*************************************************
1520 * Find the value of a header or headers *
1521 *************************************************/
1523 /* Multiple instances of the same header get concatenated, and this function
1524 can also return a concatenation of all the header lines. When concatenating
1525 specific headers that contain lists of addresses, a comma is inserted between
1526 them. Otherwise we use a straight concatenation. Because some messages can have
1527 pathologically large number of lines, there is a limit on the length that is
1528 returned. Also, to avoid massive store use which would result from using
1529 string_cat() as it copies and extends strings, we do a preliminary pass to find
1530 out exactly how much store will be needed. On "normal" messages this will be
1534 name the name of the header, without the leading $header_ or $h_,
1535 or NULL if a concatenation of all headers is required
1536 newsize return the size of memory block that was obtained; may be NULL
1537 if exists_only is TRUE
1538 flags FH_EXISTS_ONLY
1539 set if called from a def: test; don't need to build a string;
1540 just return a string that is not "" and not "0" if the header
1543 set if called for $rh_ or $rheader_ variables; no processing,
1544 other than concatenating, will be done on the header. Also used
1545 for $message_headers_raw.
1547 Double colon chars in the content, and replace newline with
1548 colon between each element when concatenating; returning a
1549 colon-sep list (elements might contain newlines)
1550 charset name of charset to translate MIME words to; used only if
1551 want_raw is false; if NULL, no translation is done (this is
1552 used for $bh_ and $bheader_)
1554 Returns: NULL if the header does not exist, else a pointer to a new
1559 find_header(uschar
*name
, int *newsize
, unsigned flags
, uschar
*charset
)
1562 int len
= name ?
Ustrlen(name
) : 0;
1567 for (h
= header_list
; h
; h
= h
->next
)
1568 if (h
->type
!= htype_old
&& h
->text
) /* NULL => Received: placeholder */
1569 if (!name
|| (len
<= h
->slen
&& strncmpic(name
, h
->text
, len
) == 0))
1574 if (flags
& FH_EXISTS_ONLY
)
1575 return US
"1"; /* don't need actual string */
1578 s
= h
->text
+ len
; /* text to insert */
1579 if (!(flags
& FH_WANT_RAW
)) /* unless wanted raw, */
1580 while (isspace(*s
)) s
++; /* remove leading white space */
1581 t
= h
->text
+ h
->slen
; /* end-point */
1583 /* Unless wanted raw, remove trailing whitespace, including the
1586 if (flags
& FH_WANT_LIST
)
1587 while (t
> s
&& t
[-1] == '\n') t
--;
1588 else if (!(flags
& FH_WANT_RAW
))
1590 while (t
> s
&& isspace(t
[-1])) t
--;
1592 /* Set comma if handling a single header and it's one of those
1593 that contains an address list, except when asked for raw headers. Only
1594 need to do this once. */
1596 if (name
&& !comma
&& Ustrchr("BCFRST", h
->type
)) comma
= TRUE
;
1599 /* Trim the header roughly if we're approaching limits */
1601 if ((g ? g
->ptr
: 0) + inc
> header_insert_maxlen
)
1602 inc
= header_insert_maxlen
- (g ? g
->ptr
: 0);
1604 /* For raw just copy the data; for a list, add the data as a colon-sep
1605 list-element; for comma-list add as an unchecked comma,newline sep
1606 list-elemment; for other nonraw add as an unchecked newline-sep list (we
1607 stripped trailing WS above including the newline). We ignore the potential
1608 expansion due to colon-doubling, just leaving the loop if the limit is met
1611 if (flags
& FH_WANT_LIST
)
1612 g
= string_append_listele_n(g
, ':', s
, (unsigned)inc
);
1613 else if (flags
& FH_WANT_RAW
)
1615 g
= string_catn(g
, s
, (unsigned)inc
);
1616 (void) string_from_gstring(g
);
1620 g
= string_append2_listele_n(g
, US
",\n", s
, (unsigned)inc
);
1622 g
= string_append2_listele_n(g
, US
"\n", s
, (unsigned)inc
);
1624 if (g
&& g
->ptr
>= header_insert_maxlen
) break;
1627 if (!found
) return NULL
; /* No header found */
1628 if (!g
) return US
"";
1630 /* That's all we do for raw header expansion. */
1633 if (flags
& FH_WANT_RAW
)
1636 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1637 The rfc2047_decode2() function can return an error with decoded data if the
1638 charset translation fails. If decoding fails, it returns NULL. */
1642 uschar
*decoded
, *error
;
1644 decoded
= rfc2047_decode2(g
->s
, check_rfc2047_length
, charset
, '?', NULL
,
1648 DEBUG(D_any
) debug_printf("*** error in RFC 2047 decoding: %s\n"
1649 " input was: %s\n", error
, g
->s
);
1651 return decoded ? decoded
: g
->s
;
1658 /* Append a "local" element to an Authentication-Results: header
1659 if this was a non-smtp message.
1663 authres_local(gstring
* g
, const uschar
* sysname
)
1665 if (!authentication_local
)
1667 g
= string_append(g
, 3, US
";\n\tlocal=pass (non-smtp, ", sysname
, US
")");
1668 if (authenticated_id
) g
= string_append(g
, 2, " u=", authenticated_id
);
1673 /* Append an "iprev" element to an Authentication-Results: header
1674 if we have attempted to get the calling host's name.
1678 authres_iprev(gstring
* g
)
1680 if (sender_host_name
)
1681 return string_append(g
, sender_host_address ?
5 : 3,
1682 US
";\n\tiprev=pass (", sender_host_name
, US
")",
1683 US
" smtp.client-ip=", sender_host_address
);
1684 if (host_lookup_deferred
)
1685 return string_catn(g
, US
";\n\tiprev=temperror", 19);
1686 if (host_lookup_failed
)
1687 return string_catn(g
, US
";\n\tiprev=fail", 13);
1693 /*************************************************
1694 * Return list of recipients *
1695 *************************************************/
1696 /* A recipients list is available only during system message filtering,
1697 during ACL processing after DATA, and while expanding pipe commands
1698 generated from a system filter, but not elsewhere. */
1707 if (!enable_dollar_recipients
) return NULL
;
1709 for (i
= 0; i
< recipients_count
; i
++)
1711 s
= recipients_list
[i
].address
;
1712 g
= string_append2_listele_n(g
, US
", ", s
, Ustrlen(s
));
1714 return g ? g
->s
: NULL
;
1718 /*************************************************
1719 * Find value of a variable *
1720 *************************************************/
1722 /* The table of variables is kept in alphabetic order, so we can search it
1723 using a binary chop. The "choplen" variable is nothing to do with the binary
1727 name the name of the variable being sought
1728 exists_only TRUE if this is a def: test; passed on to find_header()
1729 skipping TRUE => skip any processing evaluation; this is not the same as
1730 exists_only because def: may test for values that are first
1732 newsize pointer to an int which is initially zero; if the answer is in
1733 a new memory buffer, *newsize is set to its size
1735 Returns: NULL if the variable does not exist, or
1736 a pointer to the variable's contents, or
1737 something non-NULL if exists_only is TRUE
1741 find_variable(uschar
*name
, BOOL exists_only
, BOOL skipping
, int *newsize
)
1748 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1749 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1750 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1751 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1752 (this gave backwards compatibility at the changeover). There may be built-in
1753 variables whose names start acl_ but they should never start in this way. This
1754 slightly messy specification is a consequence of the history, needless to say.
1756 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1757 set, in which case give an error. */
1759 if ((Ustrncmp(name
, "acl_c", 5) == 0 || Ustrncmp(name
, "acl_m", 5) == 0) &&
1763 tree_search((name
[4] == 'c')? acl_var_c
: acl_var_m
, name
+ 4);
1764 return node ? node
->data
.ptr
: strict_acl_vars ? NULL
: US
"";
1767 /* Handle $auth<n> variables. */
1769 if (Ustrncmp(name
, "auth", 4) == 0)
1772 int n
= Ustrtoul(name
+ 4, &endptr
, 10);
1773 if (*endptr
== 0 && n
!= 0 && n
<= AUTH_VARS
)
1774 return !auth_vars
[n
-1] ? US
"" : auth_vars
[n
-1];
1776 else if (Ustrncmp(name
, "regex", 5) == 0)
1779 int n
= Ustrtoul(name
+ 5, &endptr
, 10);
1780 if (*endptr
== 0 && n
!= 0 && n
<= REGEX_VARS
)
1781 return !regex_vars
[n
-1] ? US
"" : regex_vars
[n
-1];
1784 /* For all other variables, search the table */
1786 if (!(vp
= find_var_ent(name
)))
1787 return NULL
; /* Unknown variable name */
1789 /* Found an existing variable. If in skipping state, the value isn't needed,
1790 and we want to avoid processing (such as looking up the host name). */
1798 case vtype_filter_int
:
1799 if (!filter_running
) return NULL
;
1803 sprintf(CS var_buffer
, "%d", *(int *)(val
)); /* Integer */
1807 sprintf(CS var_buffer
, "%ld", (long int)(*(ino_t
*)(val
))); /* Inode */
1811 sprintf(CS var_buffer
, "%ld", (long int)(*(gid_t
*)(val
))); /* gid */
1815 sprintf(CS var_buffer
, "%ld", (long int)(*(uid_t
*)(val
))); /* uid */
1819 sprintf(CS var_buffer
, "%s", *(BOOL
*)(val
) ?
"yes" : "no"); /* bool */
1822 case vtype_stringptr
: /* Pointer to string */
1823 return (s
= *((uschar
**)(val
))) ? s
: US
"";
1826 sprintf(CS var_buffer
, "%d", (int)getpid()); /* pid */
1829 case vtype_load_avg
:
1830 sprintf(CS var_buffer
, "%d", OS_GETLOADAVG()); /* load_average */
1833 case vtype_host_lookup
: /* Lookup if not done so */
1834 if ( !sender_host_name
&& sender_host_address
1835 && !host_lookup_failed
&& host_name_lookup() == OK
)
1836 host_build_sender_fullhost();
1837 return sender_host_name ? sender_host_name
: US
"";
1839 case vtype_localpart
: /* Get local part from address */
1840 s
= *((uschar
**)(val
));
1841 if (s
== NULL
) return US
"";
1842 domain
= Ustrrchr(s
, '@');
1843 if (domain
== NULL
) return s
;
1844 if (domain
- s
> sizeof(var_buffer
) - 1)
1845 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "local part longer than " SIZE_T_FMT
1846 " in string expansion", sizeof(var_buffer
));
1847 Ustrncpy(var_buffer
, s
, domain
- s
);
1848 var_buffer
[domain
- s
] = 0;
1851 case vtype_domain
: /* Get domain from address */
1852 s
= *((uschar
**)(val
));
1853 if (s
== NULL
) return US
"";
1854 domain
= Ustrrchr(s
, '@');
1855 return (domain
== NULL
)? US
"" : domain
+ 1;
1857 case vtype_msgheaders
:
1858 return find_header(NULL
, newsize
, exists_only ? FH_EXISTS_ONLY
: 0, NULL
);
1860 case vtype_msgheaders_raw
:
1861 return find_header(NULL
, newsize
,
1862 exists_only ? FH_EXISTS_ONLY
|FH_WANT_RAW
: FH_WANT_RAW
, NULL
);
1864 case vtype_msgbody
: /* Pointer to msgbody string */
1865 case vtype_msgbody_end
: /* Ditto, the end of the msg */
1866 ss
= (uschar
**)(val
);
1867 if (!*ss
&& deliver_datafile
>= 0) /* Read body when needed */
1870 off_t start_offset
= SPOOL_DATA_START_OFFSET
;
1871 int len
= message_body_visible
;
1872 if (len
> message_size
) len
= message_size
;
1873 *ss
= body
= store_malloc(len
+1);
1875 if (vp
->type
== vtype_msgbody_end
)
1877 struct stat statbuf
;
1878 if (fstat(deliver_datafile
, &statbuf
) == 0)
1880 start_offset
= statbuf
.st_size
- len
;
1881 if (start_offset
< SPOOL_DATA_START_OFFSET
)
1882 start_offset
= SPOOL_DATA_START_OFFSET
;
1885 if (lseek(deliver_datafile
, start_offset
, SEEK_SET
) < 0)
1886 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "deliver_datafile lseek: %s",
1888 len
= read(deliver_datafile
, body
, len
);
1892 if (message_body_newlines
) /* Separate loops for efficiency */
1894 { if (body
[--len
] == 0) body
[len
] = ' '; }
1897 { if (body
[--len
] == '\n' || body
[len
] == 0) body
[len
] = ' '; }
1900 return *ss ?
*ss
: US
"";
1902 case vtype_todbsdin
: /* BSD inbox time of day */
1903 return tod_stamp(tod_bsdin
);
1905 case vtype_tode
: /* Unix epoch time of day */
1906 return tod_stamp(tod_epoch
);
1908 case vtype_todel
: /* Unix epoch/usec time of day */
1909 return tod_stamp(tod_epoch_l
);
1911 case vtype_todf
: /* Full time of day */
1912 return tod_stamp(tod_full
);
1914 case vtype_todl
: /* Log format time of day */
1915 return tod_stamp(tod_log_bare
); /* (without timezone) */
1917 case vtype_todzone
: /* Time zone offset only */
1918 return tod_stamp(tod_zone
);
1920 case vtype_todzulu
: /* Zulu time */
1921 return tod_stamp(tod_zulu
);
1923 case vtype_todlf
: /* Log file datestamp tod */
1924 return tod_stamp(tod_log_datestamp_daily
);
1926 case vtype_reply
: /* Get reply address */
1927 s
= find_header(US
"reply-to:", newsize
,
1928 exists_only ? FH_EXISTS_ONLY
|FH_WANT_RAW
: FH_WANT_RAW
,
1930 if (s
) while (isspace(*s
)) s
++;
1933 *newsize
= 0; /* For the *s==0 case */
1934 s
= find_header(US
"from:", newsize
,
1935 exists_only ? FH_EXISTS_ONLY
|FH_WANT_RAW
: FH_WANT_RAW
,
1941 while (isspace(*s
)) s
++;
1942 for (t
= s
; *t
!= 0; t
++) if (*t
== '\n') *t
= ' ';
1943 while (t
> s
&& isspace(t
[-1])) t
--;
1946 return s ? s
: US
"";
1948 case vtype_string_func
:
1950 uschar
* (*fn
)() = val
;
1957 sprintf(CS var_buffer
, "%d",
1958 receive_statvfs(val
== (void *)TRUE
, &inodes
));
1965 (void) receive_statvfs(val
== (void *)TRUE
, &inodes
);
1966 sprintf(CS var_buffer
, "%d", inodes
);
1971 return *(void **)val ? US
"<cert>" : US
"";
1973 #ifndef DISABLE_DKIM
1975 return dkim_exim_expand_query((int)(long)val
);
1980 return NULL
; /* Unknown variable. Silences static checkers. */
1987 modify_variable(uschar
*name
, void * value
)
1990 if ((vp
= find_var_ent(name
))) vp
->value
= value
;
1991 return; /* Unknown variable name, fail silently */
1999 /*************************************************
2000 * Read and expand substrings *
2001 *************************************************/
2003 /* This function is called to read and expand argument substrings for various
2004 expansion items. Some have a minimum requirement that is less than the maximum;
2005 in these cases, the first non-present one is set to NULL.
2008 sub points to vector of pointers to set
2009 n maximum number of substrings
2011 sptr points to current string pointer
2012 skipping the skipping flag
2013 check_end if TRUE, check for final '}'
2014 name name of item, for error message
2015 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2018 Returns: 0 OK; string pointer updated
2019 1 curly bracketing error (too few arguments)
2020 2 too many arguments (only if check_end is set); message set
2021 3 other error (expansion failure)
2025 read_subs(uschar
**sub
, int n
, int m
, const uschar
**sptr
, BOOL skipping
,
2026 BOOL check_end
, uschar
*name
, BOOL
*resetok
)
2029 const uschar
*s
= *sptr
;
2031 while (isspace(*s
)) s
++;
2032 for (i
= 0; i
< n
; i
++)
2038 expand_string_message
= string_sprintf("Not enough arguments for '%s' "
2039 "(min is %d)", name
, m
);
2045 if (!(sub
[i
] = expand_string_internal(s
+1, TRUE
, &s
, skipping
, TRUE
, resetok
)))
2047 if (*s
++ != '}') return 1;
2048 while (isspace(*s
)) s
++;
2050 if (check_end
&& *s
++ != '}')
2054 expand_string_message
= string_sprintf("Too many arguments for '%s' "
2055 "(max is %d)", name
, n
);
2058 expand_string_message
= string_sprintf("missing '}' after '%s'", name
);
2069 /*************************************************
2070 * Elaborate message for bad variable *
2071 *************************************************/
2073 /* For the "unknown variable" message, take a look at the variable's name, and
2074 give additional information about possible ACL variables. The extra information
2075 is added on to expand_string_message.
2077 Argument: the name of the variable
2082 check_variable_error_message(uschar
*name
)
2084 if (Ustrncmp(name
, "acl_", 4) == 0)
2085 expand_string_message
= string_sprintf("%s (%s)", expand_string_message
,
2086 (name
[4] == 'c' || name
[4] == 'm')?
2088 US
"6th character of a user-defined ACL variable must be a digit or underscore" :
2089 US
"strict_acl_vars is set" /* Syntax is OK, it has to be this */
2091 US
"user-defined ACL variables must start acl_c or acl_m");
2097 Load args from sub array to globals, and call acl_check().
2098 Sub array will be corrupted on return.
2100 Returns: OK access is granted by an ACCEPT verb
2101 DISCARD access is (apparently) granted by a DISCARD verb
2102 FAIL access is denied
2103 FAIL_DROP access is denied; drop the connection
2104 DEFER can't tell at the moment
2108 eval_acl(uschar
** sub
, int nsub
, uschar
** user_msgp
)
2111 int sav_narg
= acl_narg
;
2113 uschar
* dummy_logmsg
;
2114 extern int acl_where
;
2116 if(--nsub
> nelem(acl_arg
)) nsub
= nelem(acl_arg
);
2117 for (i
= 0; i
< nsub
&& sub
[i
+1]; i
++)
2119 uschar
* tmp
= acl_arg
[i
];
2120 acl_arg
[i
] = sub
[i
+1]; /* place callers args in the globals */
2121 sub
[i
+1] = tmp
; /* stash the old args using our caller's storage */
2126 sub
[i
+1] = acl_arg
[i
];
2127 acl_arg
[i
++] = NULL
;
2131 debug_printf_indent("expanding: acl: %s arg: %s%s\n",
2133 acl_narg
>0 ? acl_arg
[0] : US
"<none>",
2134 acl_narg
>1 ?
" +more" : "");
2136 ret
= acl_eval(acl_where
, sub
[0], user_msgp
, &dummy_logmsg
);
2138 for (i
= 0; i
< nsub
; i
++)
2139 acl_arg
[i
] = sub
[i
+1]; /* restore old args */
2140 acl_narg
= sav_narg
;
2148 /*************************************************
2149 * Read and evaluate a condition *
2150 *************************************************/
2154 s points to the start of the condition text
2155 resetok points to a BOOL which is written false if it is unsafe to
2156 free memory. Certain condition types (acl) may have side-effect
2157 allocation which must be preserved.
2158 yield points to a BOOL to hold the result of the condition test;
2159 if NULL, we are just reading through a condition that is
2160 part of an "or" combination to check syntax, or in a state
2161 where the answer isn't required
2163 Returns: a pointer to the first character after the condition, or
2167 static const uschar
*
2168 eval_condition(const uschar
*s
, BOOL
*resetok
, BOOL
*yield
)
2170 BOOL testfor
= TRUE
;
2171 BOOL tempcond
, combined_cond
;
2173 BOOL sub2_honour_dollar
= TRUE
;
2174 int i
, rc
, cond_type
, roffset
;
2175 int_eximarith_t num
[2];
2176 struct stat statbuf
;
2178 const uschar
*sub
[10];
2181 const uschar
*rerror
;
2185 while (isspace(*s
)) s
++;
2186 if (*s
== '!') { testfor
= !testfor
; s
++; } else break;
2189 /* Numeric comparisons are symbolic */
2191 if (*s
== '=' || *s
== '>' || *s
== '<')
2203 /* All other conditions are named */
2205 else s
= read_name(name
, 256, s
, US
"_");
2207 /* If we haven't read a name, it means some non-alpha character is first. */
2211 expand_string_message
= string_sprintf("condition name expected, "
2212 "but found \"%.16s\"", s
);
2216 /* Find which condition we are dealing with, and switch on it */
2218 cond_type
= chop_match(name
, cond_table
, nelem(cond_table
));
2221 /* def: tests for a non-empty variable, or for the existence of a header. If
2222 yield == NULL we are in a skipping state, and don't care about the answer. */
2230 expand_string_message
= US
"\":\" expected after \"def\"";
2234 s
= read_name(name
, 256, s
+1, US
"_");
2236 /* Test for a header's existence. If the name contains a closing brace
2237 character, this may be a user error where the terminating colon has been
2238 omitted. Set a flag to adjust a subsequent error message in this case. */
2240 if ( ( *(t
= name
) == 'h'
2241 || (*t
== 'r' || *t
== 'l' || *t
== 'b') && *++t
== 'h'
2243 && (*++t
== '_' || Ustrncmp(t
, "eader_", 6) == 0)
2246 s
= read_header_name(name
, 256, s
);
2247 /* {-for-text-editors */
2248 if (Ustrchr(name
, '}') != NULL
) malformed_header
= TRUE
;
2250 (find_header(name
, NULL
, FH_EXISTS_ONLY
, NULL
) != NULL
) == testfor
;
2253 /* Test for a variable's having a non-empty value. A non-existent variable
2254 causes an expansion failure. */
2258 if (!(t
= find_variable(name
, TRUE
, yield
== NULL
, NULL
)))
2260 expand_string_message
= (name
[0] == 0)?
2261 string_sprintf("variable name omitted after \"def:\"") :
2262 string_sprintf("unknown variable \"%s\" after \"def:\"", name
);
2263 check_variable_error_message(name
);
2266 if (yield
) *yield
= (t
[0] != 0) == testfor
;
2273 /* first_delivery tests for first delivery attempt */
2275 case ECOND_FIRST_DELIVERY
:
2276 if (yield
!= NULL
) *yield
= deliver_firsttime
== testfor
;
2280 /* queue_running tests for any process started by a queue runner */
2282 case ECOND_QUEUE_RUNNING
:
2283 if (yield
!= NULL
) *yield
= (queue_run_pid
!= (pid_t
)0) == testfor
;
2287 /* exists: tests for file existence
2288 isip: tests for any IP address
2289 isip4: tests for an IPv4 address
2290 isip6: tests for an IPv6 address
2291 pam: does PAM authentication
2292 radius: does RADIUS authentication
2293 ldapauth: does LDAP authentication
2294 pwcheck: does Cyrus SASL pwcheck authentication
2303 case ECOND_LDAPAUTH
:
2306 while (isspace(*s
)) s
++;
2307 if (*s
!= '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2309 sub
[0] = expand_string_internal(s
+1, TRUE
, &s
, yield
== NULL
, TRUE
, resetok
);
2310 if (sub
[0] == NULL
) return NULL
;
2311 /* {-for-text-editors */
2312 if (*s
++ != '}') goto COND_FAILED_CURLY_END
;
2314 if (yield
== NULL
) return s
; /* No need to run the test if skipping */
2319 if ((expand_forbid
& RDO_EXISTS
) != 0)
2321 expand_string_message
= US
"File existence tests are not permitted";
2324 *yield
= (Ustat(sub
[0], &statbuf
) == 0) == testfor
;
2330 rc
= string_is_ip_address(sub
[0], NULL
);
2331 *yield
= ((cond_type
== ECOND_ISIP
)?
(rc
!= 0) :
2332 (cond_type
== ECOND_ISIP4
)?
(rc
== 4) : (rc
== 6)) == testfor
;
2335 /* Various authentication tests - all optionally compiled */
2339 rc
= auth_call_pam(sub
[0], &expand_string_message
);
2342 goto COND_FAILED_NOT_COMPILED
;
2343 #endif /* SUPPORT_PAM */
2346 #ifdef RADIUS_CONFIG_FILE
2347 rc
= auth_call_radius(sub
[0], &expand_string_message
);
2350 goto COND_FAILED_NOT_COMPILED
;
2351 #endif /* RADIUS_CONFIG_FILE */
2353 case ECOND_LDAPAUTH
:
2356 /* Just to keep the interface the same */
2358 int old_pool
= store_pool
;
2359 store_pool
= POOL_SEARCH
;
2360 rc
= eldapauth_find((void *)(-1), NULL
, sub
[0], Ustrlen(sub
[0]), NULL
,
2361 &expand_string_message
, &do_cache
);
2362 store_pool
= old_pool
;
2366 goto COND_FAILED_NOT_COMPILED
;
2367 #endif /* LOOKUP_LDAP */
2370 #ifdef CYRUS_PWCHECK_SOCKET
2371 rc
= auth_call_pwcheck(sub
[0], &expand_string_message
);
2374 goto COND_FAILED_NOT_COMPILED
;
2375 #endif /* CYRUS_PWCHECK_SOCKET */
2377 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2378 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2380 if (rc
== ERROR
|| rc
== DEFER
) return NULL
;
2381 *yield
= (rc
== OK
) == testfor
;
2387 /* call ACL (in a conditional context). Accept true, deny false.
2388 Defer is a forced-fail. Anything set by message= goes to $value.
2389 Up to ten parameters are used; we use the braces round the name+args
2390 like the saslauthd condition does, to permit a variable number of args.
2391 See also the expansion-item version EITEM_ACL and the traditional
2392 acl modifier ACLC_ACL.
2393 Since the ACL may allocate new global variables, tell our caller to not
2398 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2404 while (isspace(*s
)) s
++;
2405 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /*}*/
2407 switch(read_subs(sub
, nelem(sub
), 1,
2408 &s
, yield
== NULL
, TRUE
, US
"acl", resetok
))
2410 case 1: expand_string_message
= US
"too few arguments or bracketing "
2413 case 3: return NULL
;
2418 *resetok
= FALSE
; /* eval_acl() might allocate; do not reclaim */
2419 switch(eval_acl(sub
, nelem(sub
), &user_msg
))
2424 lookup_value
= NULL
;
2426 lookup_value
= string_copy(user_msg
);
2427 *yield
= cond
== testfor
;
2431 expand_string_forcedfail
= TRUE
;
2434 expand_string_message
= string_sprintf("error from acl \"%s\"", sub
[0]);
2442 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2444 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2446 However, the last two are optional. That is why the whole set is enclosed
2447 in their own set of braces. */
2449 case ECOND_SASLAUTHD
:
2450 #ifndef CYRUS_SASLAUTHD_SOCKET
2451 goto COND_FAILED_NOT_COMPILED
;
2455 while (isspace(*s
)) s
++;
2456 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2457 switch(read_subs(sub
, nelem(sub
), 2, &s
, yield
== NULL
, TRUE
, US
"saslauthd",
2460 case 1: expand_string_message
= US
"too few arguments or bracketing "
2461 "error for saslauthd";
2463 case 3: return NULL
;
2465 if (sub
[2] == NULL
) sub
[3] = NULL
; /* realm if no service */
2468 int rc
= auth_call_saslauthd(sub
[0], sub
[1], sub
[2], sub
[3],
2469 &expand_string_message
);
2470 if (rc
== ERROR
|| rc
== DEFER
) return NULL
;
2471 *yield
= (rc
== OK
) == testfor
;
2475 #endif /* CYRUS_SASLAUTHD_SOCKET */
2478 /* symbolic operators for numeric and string comparison, and a number of
2479 other operators, all requiring two arguments.
2481 crypteq: encrypts plaintext and compares against an encrypted text,
2482 using crypt(), crypt16(), MD5 or SHA-1
2483 inlist/inlisti: checks if first argument is in the list of the second
2484 match: does a regular expression match and sets up the numerical
2485 variables if it succeeds
2486 match_address: matches in an address list
2487 match_domain: matches in a domain list
2488 match_ip: matches a host list that is restricted to IP addresses
2489 match_local_part: matches in a local part list
2492 case ECOND_MATCH_ADDRESS
:
2493 case ECOND_MATCH_DOMAIN
:
2494 case ECOND_MATCH_IP
:
2495 case ECOND_MATCH_LOCAL_PART
:
2496 #ifndef EXPAND_LISTMATCH_RHS
2497 sub2_honour_dollar
= FALSE
;
2506 case ECOND_NUM_L
: /* Numerical comparisons */
2513 case ECOND_STR_LT
: /* String comparisons */
2524 for (i
= 0; i
< 2; i
++)
2526 /* Sometimes, we don't expand substrings; too many insecure configurations
2527 created using match_address{}{} and friends, where the second param
2528 includes information from untrustworthy sources. */
2529 BOOL honour_dollar
= TRUE
;
2530 if ((i
> 0) && !sub2_honour_dollar
)
2531 honour_dollar
= FALSE
;
2533 while (isspace(*s
)) s
++;
2536 if (i
== 0) goto COND_FAILED_CURLY_START
;
2537 expand_string_message
= string_sprintf("missing 2nd string in {} "
2538 "after \"%s\"", name
);
2541 if (!(sub
[i
] = expand_string_internal(s
+1, TRUE
, &s
, yield
== NULL
,
2542 honour_dollar
, resetok
)))
2544 DEBUG(D_expand
) if (i
== 1 && !sub2_honour_dollar
&& Ustrchr(sub
[1], '$'))
2545 debug_printf_indent("WARNING: the second arg is NOT expanded,"
2546 " for security reasons\n");
2547 if (*s
++ != '}') goto COND_FAILED_CURLY_END
;
2549 /* Convert to numerical if required; we know that the names of all the
2550 conditions that compare numbers do not start with a letter. This just saves
2551 checking for them individually. */
2553 if (!isalpha(name
[0]) && yield
!= NULL
)
2558 debug_printf_indent("empty string cast to zero for numerical comparison\n");
2562 num
[i
] = expanded_string_integer(sub
[i
], FALSE
);
2563 if (expand_string_message
!= NULL
) return NULL
;
2567 /* Result not required */
2569 if (yield
== NULL
) return s
;
2571 /* Do an appropriate comparison */
2577 tempcond
= (num
[0] == num
[1]);
2581 tempcond
= (num
[0] > num
[1]);
2585 tempcond
= (num
[0] >= num
[1]);
2589 tempcond
= (num
[0] < num
[1]);
2593 tempcond
= (num
[0] <= num
[1]);
2597 tempcond
= (Ustrcmp(sub
[0], sub
[1]) < 0);
2601 tempcond
= (strcmpic(sub
[0], sub
[1]) < 0);
2605 tempcond
= (Ustrcmp(sub
[0], sub
[1]) <= 0);
2609 tempcond
= (strcmpic(sub
[0], sub
[1]) <= 0);
2613 tempcond
= (Ustrcmp(sub
[0], sub
[1]) == 0);
2617 tempcond
= (strcmpic(sub
[0], sub
[1]) == 0);
2621 tempcond
= (Ustrcmp(sub
[0], sub
[1]) > 0);
2625 tempcond
= (strcmpic(sub
[0], sub
[1]) > 0);
2629 tempcond
= (Ustrcmp(sub
[0], sub
[1]) >= 0);
2633 tempcond
= (strcmpic(sub
[0], sub
[1]) >= 0);
2636 case ECOND_MATCH
: /* Regular expression match */
2637 re
= pcre_compile(CS sub
[1], PCRE_COPT
, (const char **)&rerror
, &roffset
,
2641 expand_string_message
= string_sprintf("regular expression error in "
2642 "\"%s\": %s at offset %d", sub
[1], rerror
, roffset
);
2645 tempcond
= regex_match_and_setup(re
, sub
[0], 0, -1);
2648 case ECOND_MATCH_ADDRESS
: /* Match in an address list */
2649 rc
= match_address_list(sub
[0], TRUE
, FALSE
, &(sub
[1]), NULL
, -1, 0, NULL
);
2650 goto MATCHED_SOMETHING
;
2652 case ECOND_MATCH_DOMAIN
: /* Match in a domain list */
2653 rc
= match_isinlist(sub
[0], &(sub
[1]), 0, &domainlist_anchor
, NULL
,
2654 MCL_DOMAIN
+ MCL_NOEXPAND
, TRUE
, NULL
);
2655 goto MATCHED_SOMETHING
;
2657 case ECOND_MATCH_IP
: /* Match IP address in a host list */
2658 if (sub
[0][0] != 0 && string_is_ip_address(sub
[0], NULL
) == 0)
2660 expand_string_message
= string_sprintf("\"%s\" is not an IP address",
2666 unsigned int *nullcache
= NULL
;
2667 check_host_block cb
;
2669 cb
.host_name
= US
"";
2670 cb
.host_address
= sub
[0];
2672 /* If the host address starts off ::ffff: it is an IPv6 address in
2673 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2676 cb
.host_ipv4
= (Ustrncmp(cb
.host_address
, "::ffff:", 7) == 0)?
2677 cb
.host_address
+ 7 : cb
.host_address
;
2679 rc
= match_check_list(
2680 &sub
[1], /* the list */
2681 0, /* separator character */
2682 &hostlist_anchor
, /* anchor pointer */
2683 &nullcache
, /* cache pointer */
2684 check_host
, /* function for testing */
2685 &cb
, /* argument for function */
2686 MCL_HOST
, /* type of check */
2687 sub
[0], /* text for debugging */
2688 NULL
); /* where to pass back data */
2690 goto MATCHED_SOMETHING
;
2692 case ECOND_MATCH_LOCAL_PART
:
2693 rc
= match_isinlist(sub
[0], &(sub
[1]), 0, &localpartlist_anchor
, NULL
,
2694 MCL_LOCALPART
+ MCL_NOEXPAND
, TRUE
, NULL
);
2709 expand_string_message
= string_sprintf("unable to complete match "
2710 "against \"%s\": %s", sub
[1], search_error_message
);
2716 /* Various "encrypted" comparisons. If the second string starts with
2717 "{" then an encryption type is given. Default to crypt() or crypt16()
2718 (build-time choice). */
2719 /* }-for-text-editors */
2722 #ifndef SUPPORT_CRYPTEQ
2723 goto COND_FAILED_NOT_COMPILED
;
2725 if (strncmpic(sub
[1], US
"{md5}", 5) == 0)
2727 int sublen
= Ustrlen(sub
[1]+5);
2732 md5_end(&base
, sub
[0], Ustrlen(sub
[0]), digest
);
2734 /* If the length that we are comparing against is 24, the MD5 digest
2735 is expressed as a base64 string. This is the way LDAP does it. However,
2736 some other software uses a straightforward hex representation. We assume
2737 this if the length is 32. Other lengths fail. */
2741 uschar
*coded
= b64encode(digest
, 16);
2742 DEBUG(D_auth
) debug_printf("crypteq: using MD5+B64 hashing\n"
2743 " subject=%s\n crypted=%s\n", coded
, sub
[1]+5);
2744 tempcond
= (Ustrcmp(coded
, sub
[1]+5) == 0);
2746 else if (sublen
== 32)
2750 for (i
= 0; i
< 16; i
++) sprintf(CS (coded
+2*i
), "%02X", digest
[i
]);
2752 DEBUG(D_auth
) debug_printf("crypteq: using MD5+hex hashing\n"
2753 " subject=%s\n crypted=%s\n", coded
, sub
[1]+5);
2754 tempcond
= (strcmpic(coded
, sub
[1]+5) == 0);
2758 DEBUG(D_auth
) debug_printf("crypteq: length for MD5 not 24 or 32: "
2759 "fail\n crypted=%s\n", sub
[1]+5);
2764 else if (strncmpic(sub
[1], US
"{sha1}", 6) == 0)
2766 int sublen
= Ustrlen(sub
[1]+6);
2771 sha1_end(&h
, sub
[0], Ustrlen(sub
[0]), digest
);
2773 /* If the length that we are comparing against is 28, assume the SHA1
2774 digest is expressed as a base64 string. If the length is 40, assume a
2775 straightforward hex representation. Other lengths fail. */
2779 uschar
*coded
= b64encode(digest
, 20);
2780 DEBUG(D_auth
) debug_printf("crypteq: using SHA1+B64 hashing\n"
2781 " subject=%s\n crypted=%s\n", coded
, sub
[1]+6);
2782 tempcond
= (Ustrcmp(coded
, sub
[1]+6) == 0);
2784 else if (sublen
== 40)
2788 for (i
= 0; i
< 20; i
++) sprintf(CS (coded
+2*i
), "%02X", digest
[i
]);
2790 DEBUG(D_auth
) debug_printf("crypteq: using SHA1+hex hashing\n"
2791 " subject=%s\n crypted=%s\n", coded
, sub
[1]+6);
2792 tempcond
= (strcmpic(coded
, sub
[1]+6) == 0);
2796 DEBUG(D_auth
) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2797 "fail\n crypted=%s\n", sub
[1]+6);
2802 else /* {crypt} or {crypt16} and non-{ at start */
2803 /* }-for-text-editors */
2808 if (strncmpic(sub
[1], US
"{crypt}", 7) == 0)
2813 else if (strncmpic(sub
[1], US
"{crypt16}", 9) == 0)
2818 else if (sub
[1][0] == '{') /* }-for-text-editors */
2820 expand_string_message
= string_sprintf("unknown encryption mechanism "
2821 "in \"%s\"", sub
[1]);
2827 case 0: coded
= US
DEFAULT_CRYPT(CS sub
[0], CS sub
[1]); break;
2828 case 1: coded
= US
crypt(CS sub
[0], CS sub
[1]); break;
2829 default: coded
= US
crypt16(CS sub
[0], CS sub
[1]); break;
2833 #define XSTR(s) STR(s)
2834 DEBUG(D_auth
) debug_printf("crypteq: using %s()\n"
2835 " subject=%s\n crypted=%s\n",
2836 which
== 0 ?
XSTR(DEFAULT_CRYPT
) : which
== 1 ?
"crypt" : "crypt16",
2841 /* If the encrypted string contains fewer than two characters (for the
2842 salt), force failure. Otherwise we get false positives: with an empty
2843 string the yield of crypt() is an empty string! */
2846 tempcond
= Ustrlen(sub
[1]) < 2 ? FALSE
: Ustrcmp(coded
, sub
[1]) == 0;
2847 else if (errno
== EINVAL
)
2851 expand_string_message
= string_sprintf("crypt error: %s\n",
2852 US
strerror(errno
));
2857 #endif /* SUPPORT_CRYPTEQ */
2862 const uschar
* list
= sub
[1];
2864 uschar
*save_iterate_item
= iterate_item
;
2865 int (*compare
)(const uschar
*, const uschar
*);
2867 DEBUG(D_expand
) debug_printf_indent("condition: %s item: %s\n", name
, sub
[0]);
2870 compare
= cond_type
== ECOND_INLISTI
2871 ? strcmpic
: (int (*)(const uschar
*, const uschar
*)) strcmp
;
2873 while ((iterate_item
= string_nextinlist(&list
, &sep
, NULL
, 0)))
2875 DEBUG(D_expand
) debug_printf_indent(" compare %s\n", iterate_item
);
2876 if (compare(sub
[0], iterate_item
) == 0)
2882 iterate_item
= save_iterate_item
;
2885 } /* Switch for comparison conditions */
2887 *yield
= tempcond
== testfor
;
2888 return s
; /* End of comparison conditions */
2891 /* and/or: computes logical and/or of several conditions */
2895 subcondptr
= (yield
== NULL
)? NULL
: &tempcond
;
2896 combined_cond
= (cond_type
== ECOND_AND
);
2898 while (isspace(*s
)) s
++;
2899 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2903 while (isspace(*s
)) s
++;
2904 /* {-for-text-editors */
2905 if (*s
== '}') break;
2906 if (*s
!= '{') /* }-for-text-editors */
2908 expand_string_message
= string_sprintf("each subcondition "
2909 "inside an \"%s{...}\" condition must be in its own {}", name
);
2913 if (!(s
= eval_condition(s
+1, resetok
, subcondptr
)))
2915 expand_string_message
= string_sprintf("%s inside \"%s{...}\" condition",
2916 expand_string_message
, name
);
2919 while (isspace(*s
)) s
++;
2921 /* {-for-text-editors */
2924 /* {-for-text-editors */
2925 expand_string_message
= string_sprintf("missing } at end of condition "
2926 "inside \"%s\" group", name
);
2932 if (cond_type
== ECOND_AND
)
2934 combined_cond
&= tempcond
;
2935 if (!combined_cond
) subcondptr
= NULL
; /* once false, don't */
2936 } /* evaluate any more */
2939 combined_cond
|= tempcond
;
2940 if (combined_cond
) subcondptr
= NULL
; /* once true, don't */
2941 } /* evaluate any more */
2945 if (yield
!= NULL
) *yield
= (combined_cond
== testfor
);
2949 /* forall/forany: iterates a condition with different values */
2954 const uschar
* list
;
2956 uschar
*save_iterate_item
= iterate_item
;
2958 DEBUG(D_expand
) debug_printf_indent("condition: %s\n", name
);
2960 while (isspace(*s
)) s
++;
2961 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2962 sub
[0] = expand_string_internal(s
, TRUE
, &s
, (yield
== NULL
), TRUE
, resetok
);
2963 if (sub
[0] == NULL
) return NULL
;
2964 /* {-for-text-editors */
2965 if (*s
++ != '}') goto COND_FAILED_CURLY_END
;
2967 while (isspace(*s
)) s
++;
2968 if (*s
++ != '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
2972 /* Call eval_condition once, with result discarded (as if scanning a
2973 "false" part). This allows us to find the end of the condition, because if
2974 the list it empty, we won't actually evaluate the condition for real. */
2976 if (!(s
= eval_condition(sub
[1], resetok
, NULL
)))
2978 expand_string_message
= string_sprintf("%s inside \"%s\" condition",
2979 expand_string_message
, name
);
2982 while (isspace(*s
)) s
++;
2984 /* {-for-text-editors */
2987 /* {-for-text-editors */
2988 expand_string_message
= string_sprintf("missing } at end of condition "
2989 "inside \"%s\"", name
);
2993 if (yield
!= NULL
) *yield
= !testfor
;
2995 while ((iterate_item
= string_nextinlist(&list
, &sep
, NULL
, 0)) != NULL
)
2997 DEBUG(D_expand
) debug_printf_indent("%s: $item = \"%s\"\n", name
, iterate_item
);
2998 if (!eval_condition(sub
[1], resetok
, &tempcond
))
3000 expand_string_message
= string_sprintf("%s inside \"%s\" condition",
3001 expand_string_message
, name
);
3002 iterate_item
= save_iterate_item
;
3005 DEBUG(D_expand
) debug_printf_indent("%s: condition evaluated to %s\n", name
,
3006 tempcond?
"true":"false");
3008 if (yield
!= NULL
) *yield
= (tempcond
== testfor
);
3009 if (tempcond
== (cond_type
== ECOND_FORANY
)) break;
3012 iterate_item
= save_iterate_item
;
3017 /* The bool{} expansion condition maps a string to boolean.
3018 The values supported should match those supported by the ACL condition
3019 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3020 of true/false. Note that Router "condition" rules have a different
3021 interpretation, where general data can be used and only a few values
3023 Note that readconf.c boolean matching, for boolean configuration options,
3024 only matches true/yes/false/no.
3025 The bool_lax{} condition matches the Router logic, which is much more
3028 case ECOND_BOOL_LAX
:
3034 BOOL boolvalue
= FALSE
;
3035 while (isspace(*s
)) s
++;
3036 if (*s
!= '{') goto COND_FAILED_CURLY_START
; /* }-for-text-editors */
3037 ourname
= cond_type
== ECOND_BOOL_LAX ? US
"bool_lax" : US
"bool";
3038 switch(read_subs(sub_arg
, 1, 1, &s
, yield
== NULL
, FALSE
, ourname
, resetok
))
3040 case 1: expand_string_message
= string_sprintf(
3041 "too few arguments or bracketing error for %s",
3045 case 3: return NULL
;
3048 while (isspace(*t
)) t
++;
3052 /* trailing whitespace: seems like a good idea to ignore it too */
3054 while (isspace(*t2
)) t2
--;
3055 if (t2
!= (t
+ len
))
3062 debug_printf_indent("considering %s: %s\n", ourname
, len ? t
: US
"<empty>");
3063 /* logic for the lax case from expand_check_condition(), which also does
3064 expands, and the logic is both short and stable enough that there should
3065 be no maintenance burden from replicating it. */
3069 ?
Ustrspn(t
+1, "0123456789") == len
-1
3070 : Ustrspn(t
, "0123456789") == len
)
3072 boolvalue
= (Uatoi(t
) == 0) ? FALSE
: TRUE
;
3073 /* expand_check_condition only does a literal string "0" check */
3074 if ((cond_type
== ECOND_BOOL_LAX
) && (len
> 1))
3077 else if (strcmpic(t
, US
"true") == 0 || strcmpic(t
, US
"yes") == 0)
3079 else if (strcmpic(t
, US
"false") == 0 || strcmpic(t
, US
"no") == 0)
3081 else if (cond_type
== ECOND_BOOL_LAX
)
3085 expand_string_message
= string_sprintf("unrecognised boolean "
3089 DEBUG(D_expand
) debug_printf_indent("%s: condition evaluated to %s\n", ourname
,
3090 boolvalue?
"true":"false");
3091 if (yield
!= NULL
) *yield
= (boolvalue
== testfor
);
3095 /* Unknown condition */
3098 expand_string_message
= string_sprintf("unknown condition \"%s\"", name
);
3100 } /* End switch on condition type */
3102 /* Missing braces at start and end of data */
3104 COND_FAILED_CURLY_START
:
3105 expand_string_message
= string_sprintf("missing { after \"%s\"", name
);
3108 COND_FAILED_CURLY_END
:
3109 expand_string_message
= string_sprintf("missing } at end of \"%s\" condition",
3113 /* A condition requires code that is not compiled */
3115 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3116 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3117 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3118 COND_FAILED_NOT_COMPILED
:
3119 expand_string_message
= string_sprintf("support for \"%s\" not compiled",
3128 /*************************************************
3129 * Save numerical variables *
3130 *************************************************/
3132 /* This function is called from items such as "if" that want to preserve and
3133 restore the numbered variables.
3136 save_expand_string points to an array of pointers to set
3137 save_expand_nlength points to an array of ints for the lengths
3139 Returns: the value of expand max to save
3143 save_expand_strings(uschar
**save_expand_nstring
, int *save_expand_nlength
)
3146 for (i
= 0; i
<= expand_nmax
; i
++)
3148 save_expand_nstring
[i
] = expand_nstring
[i
];
3149 save_expand_nlength
[i
] = expand_nlength
[i
];
3156 /*************************************************
3157 * Restore numerical variables *
3158 *************************************************/
3160 /* This function restored saved values of numerical strings.
3163 save_expand_nmax the number of strings to restore
3164 save_expand_string points to an array of pointers
3165 save_expand_nlength points to an array of ints
3171 restore_expand_strings(int save_expand_nmax
, uschar
**save_expand_nstring
,
3172 int *save_expand_nlength
)
3175 expand_nmax
= save_expand_nmax
;
3176 for (i
= 0; i
<= expand_nmax
; i
++)
3178 expand_nstring
[i
] = save_expand_nstring
[i
];
3179 expand_nlength
[i
] = save_expand_nlength
[i
];
3187 /*************************************************
3188 * Handle yes/no substrings *
3189 *************************************************/
3191 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3192 alternative substrings that depend on whether or not the condition was true,
3193 or the lookup or extraction succeeded. The substrings always have to be
3194 expanded, to check their syntax, but "skipping" is set when the result is not
3195 needed - this avoids unnecessary nested lookups.
3198 skipping TRUE if we were skipping when this item was reached
3199 yes TRUE if the first string is to be used, else use the second
3200 save_lookup a value to put back into lookup_value before the 2nd expansion
3201 sptr points to the input string pointer
3202 yieldptr points to the output growable-string pointer
3203 type "lookup", "if", "extract", "run", "env", "listextract" or
3204 "certextract" for error message
3205 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3208 Returns: 0 OK; lookup_value has been reset to save_lookup
3210 2 expansion failed because of bracketing error
3214 process_yesno(BOOL skipping
, BOOL yes
, uschar
*save_lookup
, const uschar
**sptr
,
3215 gstring
** yieldptr
, uschar
*type
, BOOL
*resetok
)
3218 const uschar
*s
= *sptr
; /* Local value */
3219 uschar
*sub1
, *sub2
;
3220 const uschar
* errwhere
;
3222 /* If there are no following strings, we substitute the contents of $value for
3223 lookups and for extractions in the success case. For the ${if item, the string
3224 "true" is substituted. In the fail case, nothing is substituted for all three
3227 while (isspace(*s
)) s
++;
3232 if (yes
&& !skipping
)
3233 *yieldptr
= string_catn(*yieldptr
, US
"true", 4);
3237 if (yes
&& lookup_value
&& !skipping
)
3238 *yieldptr
= string_cat(*yieldptr
, lookup_value
);
3239 lookup_value
= save_lookup
;
3245 /* The first following string must be braced. */
3249 errwhere
= US
"'yes' part did not start with '{'";
3253 /* Expand the first substring. Forced failures are noticed only if we actually
3254 want this string. Set skipping in the call in the fail case (this will always
3255 be the case if we were already skipping). */
3257 sub1
= expand_string_internal(s
, TRUE
, &s
, !yes
, TRUE
, resetok
);
3258 if (sub1
== NULL
&& (yes
|| !expand_string_forcedfail
)) goto FAILED
;
3259 expand_string_forcedfail
= FALSE
;
3262 errwhere
= US
"'yes' part did not end with '}'";
3266 /* If we want the first string, add it to the output */
3269 *yieldptr
= string_cat(*yieldptr
, sub1
);
3271 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3272 $value to what it was at the start of the item, so that it has this value
3273 during the second string expansion. For the call from "if" or "run" to this
3274 function, save_lookup is set to lookup_value, so that this statement does
3277 lookup_value
= save_lookup
;
3279 /* There now follows either another substring, or "fail", or nothing. This
3280 time, forced failures are noticed only if we want the second string. We must
3281 set skipping in the nested call if we don't want this string, or if we were
3282 already skipping. */
3284 while (isspace(*s
)) s
++;
3287 sub2
= expand_string_internal(s
+1, TRUE
, &s
, yes
|| skipping
, TRUE
, resetok
);
3288 if (sub2
== NULL
&& (!yes
|| !expand_string_forcedfail
)) goto FAILED
;
3289 expand_string_forcedfail
= FALSE
;
3292 errwhere
= US
"'no' part did not start with '{'";
3296 /* If we want the second string, add it to the output */
3299 *yieldptr
= string_cat(*yieldptr
, sub2
);
3302 /* If there is no second string, but the word "fail" is present when the use of
3303 the second string is wanted, set a flag indicating it was a forced failure
3304 rather than a syntactic error. Swallow the terminating } in case this is nested
3305 inside another lookup or if or extract. */
3310 /* deconst cast ok here as source is s anyway */
3311 s
= US
read_name(name
, sizeof(name
), s
, US
"_");
3312 if (Ustrcmp(name
, "fail") == 0)
3314 if (!yes
&& !skipping
)
3316 while (isspace(*s
)) s
++;
3319 errwhere
= US
"did not close with '}' after forcedfail";
3322 expand_string_message
=
3323 string_sprintf("\"%s\" failed and \"fail\" requested", type
);
3324 expand_string_forcedfail
= TRUE
;
3330 expand_string_message
=
3331 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type
);
3336 /* All we have to do now is to check on the final closing brace. */
3338 while (isspace(*s
)) s
++;
3341 errwhere
= US
"did not close with '}'";
3347 /* Update the input pointer value before returning */
3352 /* Get here if there is a bracketing failure */
3353 expand_string_message
= string_sprintf(
3354 "curly-bracket problem in conditional yes/no parsing: %s\n"
3355 " remaining string is '%s'", errwhere
, --s
);
3360 /* Get here for other failures */
3368 /*************************************************