1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 */
7 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for reading the configuration file, and for displaying
10 overall configuration values. Thanks to Brian Candler for the original
11 implementation of the conditional .ifdef etc. */
16 # include "macro_predef.h"
19 #define READCONF_DEBUG if (FALSE) /* Change to TRUE to enable */
22 static uschar * syslog_facility_str;
23 static void fn_smtp_receive_timeout(const uschar *, const uschar *, unsigned);
25 /*************************************************
26 * Main configuration options *
27 *************************************************/
29 /* The list of options that can be set in the main configuration file. This
30 must be in alphabetic order because it is searched by binary chop. */
32 static optionlist optionlist_config[] = {
33 { "*set_exim_group", opt_bool|opt_hidden, {&exim_gid_set} },
34 { "*set_exim_user", opt_bool|opt_hidden, {&exim_uid_set} },
35 { "*set_system_filter_group", opt_bool|opt_hidden, {&system_filter_gid_set} },
36 { "*set_system_filter_user", opt_bool|opt_hidden, {&system_filter_uid_set} },
37 { "accept_8bitmime", opt_bool, {&accept_8bitmime} },
38 { "acl_not_smtp", opt_stringptr, {&acl_not_smtp} },
39 #ifdef WITH_CONTENT_SCAN
40 { "acl_not_smtp_mime", opt_stringptr, {&acl_not_smtp_mime} },
42 { "acl_not_smtp_start", opt_stringptr, {&acl_not_smtp_start} },
43 { "acl_smtp_auth", opt_stringptr, {&acl_smtp_auth} },
44 { "acl_smtp_connect", opt_stringptr, {&acl_smtp_connect} },
45 { "acl_smtp_data", opt_stringptr, {&acl_smtp_data} },
47 { "acl_smtp_data_prdr", opt_stringptr, {&acl_smtp_data_prdr} },
50 { "acl_smtp_dkim", opt_stringptr, {&acl_smtp_dkim} },
52 { "acl_smtp_etrn", opt_stringptr, {&acl_smtp_etrn} },
53 { "acl_smtp_expn", opt_stringptr, {&acl_smtp_expn} },
54 { "acl_smtp_helo", opt_stringptr, {&acl_smtp_helo} },
55 { "acl_smtp_mail", opt_stringptr, {&acl_smtp_mail} },
56 { "acl_smtp_mailauth", opt_stringptr, {&acl_smtp_mailauth} },
57 #ifdef WITH_CONTENT_SCAN
58 { "acl_smtp_mime", opt_stringptr, {&acl_smtp_mime} },
60 { "acl_smtp_notquit", opt_stringptr, {&acl_smtp_notquit} },
61 { "acl_smtp_predata", opt_stringptr, {&acl_smtp_predata} },
62 { "acl_smtp_quit", opt_stringptr, {&acl_smtp_quit} },
63 { "acl_smtp_rcpt", opt_stringptr, {&acl_smtp_rcpt} },
65 { "acl_smtp_starttls", opt_stringptr, {&acl_smtp_starttls} },
67 { "acl_smtp_vrfy", opt_stringptr, {&acl_smtp_vrfy} },
68 { "add_environment", opt_stringptr, {&add_environment} },
69 { "admin_groups", opt_gidlist, {&admin_groups} },
70 { "allow_domain_literals", opt_bool, {&allow_domain_literals} },
71 #ifdef ALLOW_INSECURE_TAINTED_DATA
72 { "allow_insecure_tainted_data", opt_bool, {&allow_insecure_tainted_data} },
74 { "allow_mx_to_ip", opt_bool, {&allow_mx_to_ip} },
75 { "allow_utf8_domains", opt_bool, {&allow_utf8_domains} },
76 { "auth_advertise_hosts", opt_stringptr, {&auth_advertise_hosts} },
77 { "auto_thaw", opt_time, {&auto_thaw} },
78 #ifdef WITH_CONTENT_SCAN
79 { "av_scanner", opt_stringptr, {&av_scanner} },
81 { "bi_command", opt_stringptr, {&bi_command} },
82 #ifdef EXPERIMENTAL_BRIGHTMAIL
83 { "bmi_config_file", opt_stringptr, {&bmi_config_file} },
85 { "bounce_message_file", opt_stringptr, {&bounce_message_file} },
86 { "bounce_message_text", opt_stringptr, {&bounce_message_text} },
87 { "bounce_return_body", opt_bool, {&bounce_return_body} },
88 { "bounce_return_linesize_limit", opt_mkint, {&bounce_return_linesize_limit} },
89 { "bounce_return_message", opt_bool, {&bounce_return_message} },
90 { "bounce_return_size_limit", opt_mkint, {&bounce_return_size_limit} },
91 { "bounce_sender_authentication",opt_stringptr,{&bounce_sender_authentication} },
92 { "callout_domain_negative_expire", opt_time, {&callout_cache_domain_negative_expire} },
93 { "callout_domain_positive_expire", opt_time, {&callout_cache_domain_positive_expire} },
94 { "callout_negative_expire", opt_time, {&callout_cache_negative_expire} },
95 { "callout_positive_expire", opt_time, {&callout_cache_positive_expire} },
96 { "callout_random_local_part",opt_stringptr, {&callout_random_local_part} },
97 { "check_log_inodes", opt_int, {&check_log_inodes} },
98 { "check_log_space", opt_Kint, {&check_log_space} },
99 { "check_rfc2047_length", opt_bool, {&check_rfc2047_length} },
100 { "check_spool_inodes", opt_int, {&check_spool_inodes} },
101 { "check_spool_space", opt_Kint, {&check_spool_space} },
102 { "chunking_advertise_hosts", opt_stringptr, {&chunking_advertise_hosts} },
103 { "commandline_checks_require_admin", opt_bool,{&commandline_checks_require_admin} },
104 { "daemon_smtp_port", opt_stringptr|opt_hidden, {&daemon_smtp_port} },
105 { "daemon_smtp_ports", opt_stringptr, {&daemon_smtp_port} },
106 { "daemon_startup_retries", opt_int, {&daemon_startup_retries} },
107 { "daemon_startup_sleep", opt_time, {&daemon_startup_sleep} },
108 #ifdef EXPERIMENTAL_DCC
109 { "dcc_direct_add_header", opt_bool, {&dcc_direct_add_header} },
110 { "dccifd_address", opt_stringptr, {&dccifd_address} },
111 { "dccifd_options", opt_stringptr, {&dccifd_options} },
113 { "debug_store", opt_bool, {&debug_store} },
114 { "delay_warning", opt_timelist, {&delay_warning} },
115 { "delay_warning_condition", opt_stringptr, {&delay_warning_condition} },
116 { "deliver_drop_privilege", opt_bool, {&deliver_drop_privilege} },
117 { "deliver_queue_load_max", opt_fixed, {&deliver_queue_load_max} },
118 { "delivery_date_remove", opt_bool, {&delivery_date_remove} },
119 #ifdef ENABLE_DISABLE_FSYNC
120 { "disable_fsync", opt_bool, {&disable_fsync} },
122 { "disable_ipv6", opt_bool, {&disable_ipv6} },
124 { "dkim_verify_hashes", opt_stringptr, {&dkim_verify_hashes} },
125 { "dkim_verify_keytypes", opt_stringptr, {&dkim_verify_keytypes} },
126 { "dkim_verify_min_keysizes", opt_stringptr, {&dkim_verify_min_keysizes} },
127 { "dkim_verify_minimal", opt_bool, {&dkim_verify_minimal} },
128 { "dkim_verify_signers", opt_stringptr, {&dkim_verify_signers} },
131 { "dmarc_forensic_sender", opt_stringptr, {&dmarc_forensic_sender} },
132 { "dmarc_history_file", opt_stringptr, {&dmarc_history_file} },
133 { "dmarc_tld_file", opt_stringptr, {&dmarc_tld_file} },
135 { "dns_again_means_nonexist", opt_stringptr, {&dns_again_means_nonexist} },
136 { "dns_check_names_pattern", opt_stringptr, {&check_dns_names_pattern} },
137 { "dns_cname_loops", opt_int, {&dns_cname_loops} },
138 { "dns_csa_search_limit", opt_int, {&dns_csa_search_limit} },
139 { "dns_csa_use_reverse", opt_bool, {&dns_csa_use_reverse} },
140 { "dns_dnssec_ok", opt_int, {&dns_dnssec_ok} },
141 { "dns_ipv4_lookup", opt_stringptr, {&dns_ipv4_lookup} },
142 { "dns_retrans", opt_time, {&dns_retrans} },
143 { "dns_retry", opt_int, {&dns_retry} },
144 { "dns_trust_aa", opt_stringptr, {&dns_trust_aa} },
145 { "dns_use_edns0", opt_int, {&dns_use_edns0} },
146 /* This option is now a no-op, retained for compatibility */
147 { "drop_cr", opt_bool, {&drop_cr} },
148 /*********************************************************/
149 { "dsn_advertise_hosts", opt_stringptr, {&dsn_advertise_hosts} },
150 { "dsn_from", opt_stringptr, {&dsn_from} },
151 { "envelope_to_remove", opt_bool, {&envelope_to_remove} },
152 { "errors_copy", opt_stringptr, {&errors_copy} },
153 { "errors_reply_to", opt_stringptr, {&errors_reply_to} },
154 #ifndef DISABLE_EVENT
155 { "event_action", opt_stringptr, {&event_action} },
157 { "exim_group", opt_gid, {&exim_gid} },
158 { "exim_path", opt_stringptr, {&exim_path} },
159 { "exim_user", opt_uid, {&exim_uid} },
160 { "exim_version", opt_stringptr, {&version_string} },
161 { "extra_local_interfaces", opt_stringptr, {&extra_local_interfaces} },
162 { "extract_addresses_remove_arguments", opt_bool, {&extract_addresses_remove_arguments} },
163 { "finduser_retries", opt_int, {&finduser_retries} },
164 { "freeze_tell", opt_stringptr, {&freeze_tell} },
165 { "gecos_name", opt_stringptr, {&gecos_name} },
166 { "gecos_pattern", opt_stringptr, {&gecos_pattern} },
168 { "gnutls_allow_auto_pkcs11", opt_bool, {&gnutls_allow_auto_pkcs11} },
169 { "gnutls_compat_mode", opt_bool, {&gnutls_compat_mode} },
171 { "header_line_maxsize", opt_int, {&header_line_maxsize} },
172 { "header_maxsize", opt_int, {&header_maxsize} },
173 { "headers_charset", opt_stringptr, {&headers_charset} },
174 { "helo_accept_junk_hosts", opt_stringptr, {&helo_accept_junk_hosts} },
175 { "helo_allow_chars", opt_stringptr, {&helo_allow_chars} },
176 { "helo_lookup_domains", opt_stringptr, {&helo_lookup_domains} },
177 { "helo_try_verify_hosts", opt_stringptr, {&helo_try_verify_hosts} },
178 { "helo_verify_hosts", opt_stringptr, {&helo_verify_hosts} },
179 { "hold_domains", opt_stringptr, {&hold_domains} },
180 { "host_lookup", opt_stringptr, {&host_lookup} },
181 { "host_lookup_order", opt_stringptr, {&host_lookup_order} },
182 { "host_reject_connection", opt_stringptr, {&host_reject_connection} },
183 { "hosts_connection_nolog", opt_stringptr, {&hosts_connection_nolog} },
185 { "hosts_proxy", opt_stringptr, {&hosts_proxy} },
187 { "hosts_require_helo", opt_stringptr, {&hosts_require_helo} },
188 { "hosts_treat_as_local", opt_stringptr, {&hosts_treat_as_local} },
190 { "ibase_servers", opt_stringptr, {&ibase_servers} },
192 { "ignore_bounce_errors_after", opt_time, {&ignore_bounce_errors_after} },
193 { "ignore_fromline_hosts", opt_stringptr, {&ignore_fromline_hosts} },
194 { "ignore_fromline_local", opt_bool, {&ignore_fromline_local} },
195 { "keep_environment", opt_stringptr, {&keep_environment} },
196 { "keep_malformed", opt_time, {&keep_malformed} },
198 { "ldap_ca_cert_dir", opt_stringptr, {&eldap_ca_cert_dir} },
199 { "ldap_ca_cert_file", opt_stringptr, {&eldap_ca_cert_file} },
200 { "ldap_cert_file", opt_stringptr, {&eldap_cert_file} },
201 { "ldap_cert_key", opt_stringptr, {&eldap_cert_key} },
202 { "ldap_cipher_suite", opt_stringptr, {&eldap_cipher_suite} },
203 { "ldap_default_servers", opt_stringptr, {&eldap_default_servers} },
204 { "ldap_require_cert", opt_stringptr, {&eldap_require_cert} },
205 { "ldap_start_tls", opt_bool, {&eldap_start_tls} },
206 { "ldap_version", opt_int, {&eldap_version} },
208 #ifdef EXPERIMENTAL_ESMTP_LIMITS
209 { "limits_advertise_hosts", opt_stringptr, {&limits_advertise_hosts} },
211 { "local_from_check", opt_bool, {&local_from_check} },
212 { "local_from_prefix", opt_stringptr, {&local_from_prefix} },
213 { "local_from_suffix", opt_stringptr, {&local_from_suffix} },
214 { "local_interfaces", opt_stringptr, {&local_interfaces} },
215 #ifdef HAVE_LOCAL_SCAN
216 { "local_scan_timeout", opt_time, {&local_scan_timeout} },
218 { "local_sender_retain", opt_bool, {&local_sender_retain} },
219 { "localhost_number", opt_stringptr, {&host_number_string} },
220 { "log_file_path", opt_stringptr, {&log_file_path} },
221 { "log_selector", opt_stringptr, {&log_selector_string} },
222 { "log_timezone", opt_bool, {&log_timezone} },
223 { "lookup_open_max", opt_int, {&lookup_open_max} },
224 { "max_username_length", opt_int, {&max_username_length} },
225 { "message_body_newlines", opt_bool, {&message_body_newlines} },
226 { "message_body_visible", opt_mkint, {&message_body_visible} },
227 { "message_id_header_domain", opt_stringptr, {&message_id_domain} },
228 { "message_id_header_text", opt_stringptr, {&message_id_text} },
229 { "message_logs", opt_bool, {&message_logs} },
230 { "message_size_limit", opt_stringptr, {&message_size_limit} },
231 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
232 { "move_frozen_messages", opt_bool, {&move_frozen_messages} },
234 { "mua_wrapper", opt_bool, {&mua_wrapper} },
236 { "mysql_servers", opt_stringptr, {&mysql_servers} },
238 { "never_users", opt_uidlist, {&never_users} },
239 { "notifier_socket", opt_stringptr, {¬ifier_socket} },
241 { "openssl_options", opt_stringptr, {&openssl_options} },
244 { "oracle_servers", opt_stringptr, {&oracle_servers} },
246 { "percent_hack_domains", opt_stringptr, {&percent_hack_domains} },
248 { "perl_at_start", opt_bool, {&opt_perl_at_start} },
249 { "perl_startup", opt_stringptr, {&opt_perl_startup} },
250 { "perl_taintmode", opt_bool, {&opt_perl_taintmode} },
253 { "pgsql_servers", opt_stringptr, {&pgsql_servers} },
255 { "pid_file_path", opt_stringptr, {&pid_file_path} },
256 { "pipelining_advertise_hosts", opt_stringptr, {&pipelining_advertise_hosts} },
257 #ifndef DISABLE_PIPE_CONNECT
258 { "pipelining_connect_advertise_hosts", opt_stringptr,
259 {&pipe_connect_advertise_hosts} },
262 { "prdr_enable", opt_bool, {&prdr_enable} },
264 { "preserve_message_logs", opt_bool, {&preserve_message_logs} },
265 { "primary_hostname", opt_stringptr, {&primary_hostname} },
266 { "print_topbitchars", opt_bool, {&print_topbitchars} },
267 { "process_log_path", opt_stringptr, {&process_log_path} },
268 { "prod_requires_admin", opt_bool, {&prod_requires_admin} },
270 { "proxy_protocol_timeout", opt_time, {&proxy_protocol_timeout} },
272 { "qualify_domain", opt_stringptr, {&qualify_domain_sender} },
273 { "qualify_recipient", opt_stringptr, {&qualify_domain_recipient} },
274 { "queue_domains", opt_stringptr, {&queue_domains} },
275 #ifndef DISABLE_QUEUE_RAMP
276 { "queue_fast_ramp", opt_bool, {&queue_fast_ramp} },
278 { "queue_list_requires_admin",opt_bool, {&queue_list_requires_admin} },
279 { "queue_only", opt_bool, {&queue_only} },
280 { "queue_only_file", opt_stringptr, {&queue_only_file} },
281 { "queue_only_load", opt_fixed, {&queue_only_load} },
282 { "queue_only_load_latch", opt_bool, {&queue_only_load_latch} },
283 { "queue_only_override", opt_bool, {&queue_only_override} },
284 { "queue_run_in_order", opt_bool, {&queue_run_in_order} },
285 { "queue_run_max", opt_stringptr, {&queue_run_max} },
286 { "queue_smtp_domains", opt_stringptr, {&queue_smtp_domains} },
287 { "receive_timeout", opt_time, {&receive_timeout} },
288 { "received_header_text", opt_stringptr, {&received_header_text} },
289 { "received_headers_max", opt_int, {&received_headers_max} },
290 { "recipient_unqualified_hosts", opt_stringptr, {&recipient_unqualified_hosts} },
291 { "recipients_max", opt_int, {&recipients_max} },
292 { "recipients_max_reject", opt_bool, {&recipients_max_reject} },
294 { "redis_servers", opt_stringptr, {&redis_servers} },
296 { "remote_max_parallel", opt_int, {&remote_max_parallel} },
297 { "remote_sort_domains", opt_stringptr, {&remote_sort_domains} },
298 { "retry_data_expire", opt_time, {&retry_data_expire} },
299 { "retry_interval_max", opt_time, {&retry_interval_max} },
300 { "return_path_remove", opt_bool, {&return_path_remove} },
301 { "return_size_limit", opt_mkint|opt_hidden, {&bounce_return_size_limit} },
302 { "rfc1413_hosts", opt_stringptr, {&rfc1413_hosts} },
303 { "rfc1413_query_timeout", opt_time, {&rfc1413_query_timeout} },
304 { "sender_unqualified_hosts", opt_stringptr, {&sender_unqualified_hosts} },
305 { "slow_lookup_log", opt_int, {&slow_lookup_log} },
306 { "smtp_accept_keepalive", opt_bool, {&smtp_accept_keepalive} },
307 { "smtp_accept_max", opt_int, {&smtp_accept_max} },
308 { "smtp_accept_max_nonmail", opt_int, {&smtp_accept_max_nonmail} },
309 { "smtp_accept_max_nonmail_hosts", opt_stringptr, {&smtp_accept_max_nonmail_hosts} },
310 { "smtp_accept_max_per_connection", opt_stringptr, {&smtp_accept_max_per_connection} },
311 { "smtp_accept_max_per_host", opt_stringptr, {&smtp_accept_max_per_host} },
312 { "smtp_accept_queue", opt_int, {&smtp_accept_queue} },
313 { "smtp_accept_queue_per_connection", opt_int, {&smtp_accept_queue_per_connection} },
314 { "smtp_accept_reserve", opt_int, {&smtp_accept_reserve} },
315 { "smtp_active_hostname", opt_stringptr, {&raw_active_hostname} },
316 { "smtp_backlog_monitor", opt_int, {&smtp_backlog_monitor} },
317 { "smtp_banner", opt_stringptr, {&smtp_banner} },
318 { "smtp_check_spool_space", opt_bool, {&smtp_check_spool_space} },
319 { "smtp_connect_backlog", opt_int, {&smtp_connect_backlog} },
320 { "smtp_enforce_sync", opt_bool, {&smtp_enforce_sync} },
321 { "smtp_etrn_command", opt_stringptr, {&smtp_etrn_command} },
322 { "smtp_etrn_serialize", opt_bool, {&smtp_etrn_serialize} },
323 { "smtp_load_reserve", opt_fixed, {&smtp_load_reserve} },
324 { "smtp_max_synprot_errors", opt_int, {&smtp_max_synprot_errors} },
325 { "smtp_max_unknown_commands",opt_int, {&smtp_max_unknown_commands} },
326 { "smtp_ratelimit_hosts", opt_stringptr, {&smtp_ratelimit_hosts} },
327 { "smtp_ratelimit_mail", opt_stringptr, {&smtp_ratelimit_mail} },
328 { "smtp_ratelimit_rcpt", opt_stringptr, {&smtp_ratelimit_rcpt} },
329 { "smtp_receive_timeout", opt_func, {.fn = &fn_smtp_receive_timeout} },
330 { "smtp_reserve_hosts", opt_stringptr, {&smtp_reserve_hosts} },
331 { "smtp_return_error_details",opt_bool, {&smtp_return_error_details} },
333 { "smtputf8_advertise_hosts", opt_stringptr, {&smtputf8_advertise_hosts} },
335 #ifdef WITH_CONTENT_SCAN
336 { "spamd_address", opt_stringptr, {&spamd_address} },
339 { "spf_guess", opt_stringptr, {&spf_guess} },
340 { "spf_smtp_comment_template",opt_stringptr, {&spf_smtp_comment_template} },
342 { "split_spool_directory", opt_bool, {&split_spool_directory} },
343 { "spool_directory", opt_stringptr, {&spool_directory} },
344 { "spool_wireformat", opt_bool, {&spool_wireformat} },
346 { "sqlite_dbfile", opt_stringptr, {&sqlite_dbfile} },
347 { "sqlite_lock_timeout", opt_int, {&sqlite_lock_timeout} },
349 #ifdef EXPERIMENTAL_SRS_ALT
350 { "srs_config", opt_stringptr, {&srs_config} },
351 { "srs_hashlength", opt_int, {&srs_hashlength} },
352 { "srs_hashmin", opt_int, {&srs_hashmin} },
353 { "srs_maxage", opt_int, {&srs_maxage} },
354 { "srs_secrets", opt_stringptr, {&srs_secrets} },
355 { "srs_usehash", opt_bool, {&srs_usehash} },
356 { "srs_usetimestamp", opt_bool, {&srs_usetimestamp} },
358 { "strict_acl_vars", opt_bool, {&strict_acl_vars} },
359 { "strip_excess_angle_brackets", opt_bool, {&strip_excess_angle_brackets} },
360 { "strip_trailing_dot", opt_bool, {&strip_trailing_dot} },
361 { "syslog_duplication", opt_bool, {&syslog_duplication} },
362 { "syslog_facility", opt_stringptr, {&syslog_facility_str} },
363 { "syslog_pid", opt_bool, {&syslog_pid} },
364 { "syslog_processname", opt_stringptr, {&syslog_processname} },
365 { "syslog_timestamp", opt_bool, {&syslog_timestamp} },
366 { "system_filter", opt_stringptr, {&system_filter} },
367 { "system_filter_directory_transport", opt_stringptr,{&system_filter_directory_transport} },
368 { "system_filter_file_transport",opt_stringptr,{&system_filter_file_transport} },
369 { "system_filter_group", opt_gid, {&system_filter_gid} },
370 { "system_filter_pipe_transport",opt_stringptr,{&system_filter_pipe_transport} },
371 { "system_filter_reply_transport",opt_stringptr,{&system_filter_reply_transport} },
372 { "system_filter_user", opt_uid, {&system_filter_uid} },
373 { "tcp_nodelay", opt_bool, {&tcp_nodelay} },
374 #ifdef USE_TCP_WRAPPERS
375 { "tcp_wrappers_daemon_name", opt_stringptr, {&tcp_wrappers_daemon_name} },
377 { "timeout_frozen_after", opt_time, {&timeout_frozen_after} },
378 { "timezone", opt_stringptr, {&timezone_string} },
379 { "tls_advertise_hosts", opt_stringptr, {&tls_advertise_hosts} },
381 { "tls_certificate", opt_stringptr, {&tls_certificate} },
382 { "tls_crl", opt_stringptr, {&tls_crl} },
383 { "tls_dh_max_bits", opt_int, {&tls_dh_max_bits} },
384 { "tls_dhparam", opt_stringptr, {&tls_dhparam} },
385 { "tls_eccurve", opt_stringptr, {&tls_eccurve} },
386 # ifndef DISABLE_OCSP
387 { "tls_ocsp_file", opt_stringptr, {&tls_ocsp_file} },
389 { "tls_on_connect_ports", opt_stringptr, {&tls_in.on_connect_ports} },
390 { "tls_privatekey", opt_stringptr, {&tls_privatekey} },
391 { "tls_remember_esmtp", opt_bool, {&tls_remember_esmtp} },
392 { "tls_require_ciphers", opt_stringptr, {&tls_require_ciphers} },
393 # ifndef DISABLE_TLS_RESUME
394 { "tls_resumption_hosts", opt_stringptr, {&tls_resumption_hosts} },
396 { "tls_try_verify_hosts", opt_stringptr, {&tls_try_verify_hosts} },
397 { "tls_verify_certificates", opt_stringptr, {&tls_verify_certificates} },
398 { "tls_verify_hosts", opt_stringptr, {&tls_verify_hosts} },
400 { "trusted_groups", opt_gidlist, {&trusted_groups} },
401 { "trusted_users", opt_uidlist, {&trusted_users} },
402 { "unknown_login", opt_stringptr, {&unknown_login} },
403 { "unknown_username", opt_stringptr, {&unknown_username} },
404 { "untrusted_set_sender", opt_stringptr, {&untrusted_set_sender} },
405 { "uucp_from_pattern", opt_stringptr, {&uucp_from_pattern} },
406 { "uucp_from_sender", opt_stringptr, {&uucp_from_sender} },
407 { "warn_message_file", opt_stringptr, {&warn_message_file} },
408 { "write_rejectlog", opt_bool, {&write_rejectlog} }
412 static int optionlist_config_size = nelem(optionlist_config);
419 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags) {/*Dummy*/}
424 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
430 uschar buf[EXIM_DRIVERNAME_MAX];
432 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
434 for (struct auth_info * ai = auths_available; ai->driver_name[0]; ai++)
436 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
437 builtin_macro_create(buf);
438 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
440 if (ai->macros_create) (ai->macros_create)();
445 options_logging(void)
447 uschar buf[EXIM_DRIVERNAME_MAX];
449 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
451 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
452 builtin_macro_create(buf);
457 #else /*!MACRO_PREDEF*/
459 extern char **environ;
461 static void save_config_line(const uschar* line);
462 static void save_config_position(const uschar *file, int line);
463 static void print_config(BOOL admin, BOOL terse);
466 #define CSTATE_STACK_SIZE 10
468 const uschar *config_directory = NULL;
471 /* Structure for chain (stack) of .included files */
473 typedef struct config_file_item {
474 struct config_file_item *next;
475 const uschar *filename;
476 const uschar *directory;
481 /* Structure for chain of configuration lines (-bP config) */
483 typedef struct config_line_item {
484 struct config_line_item *next;
488 static config_line_item* config_lines;
490 /* Structure of table of conditional words and their state transitions */
492 typedef struct cond_item {
500 /* Structure of table of syslog facility names and values */
502 typedef struct syslog_fac_item {
508 static const uschar * const hidden = US"<value not displayable>";
510 /* Static variables */
512 static config_file_item *config_file_stack = NULL; /* For includes */
514 static uschar *syslog_facility_str = NULL;
515 static uschar next_section[24];
516 static uschar time_buffer[24];
518 /* State variables for conditional loading (.ifdef / .else / .endif) */
520 static int cstate = 0;
521 static int cstate_stack_ptr = -1;
522 static int cstate_stack[CSTATE_STACK_SIZE];
524 /* Table of state transitions for handling conditional inclusions. There are
525 four possible state transitions:
529 .elifdef true (or .else)
532 .endif just causes the previous cstate to be popped off the stack */
534 static int next_cstate[3][4] =
536 /* State 0: reading from file, or reading until next .else or .endif */
538 /* State 1: condition failed, skipping until next .else or .endif */
540 /* State 2: skipping until .endif */
544 /* Table of conditionals and the states to set. For each name, there are four
545 values: the length of the name (to save computing it each time), the state to
546 set if a macro was found in the line, the state to set if a macro was not found
547 in the line, and a stack manipulation setting which is:
549 -1 pull state value off the stack
550 0 don't alter the stack
551 +1 push value onto stack, before setting new state
554 static cond_item cond_list[] = {
555 { US"ifdef", 5, 0, 1, 1 },
556 { US"ifndef", 6, 1, 0, 1 },
557 { US"elifdef", 7, 2, 3, 0 },
558 { US"elifndef", 8, 3, 2, 0 },
559 { US"else", 4, 2, 2, 0 },
560 { US"endif", 5, 0, 0, -1 }
563 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
565 /* Table of syslog facility names and their values */
567 static syslog_fac_item syslog_list[] = {
568 { US"mail", LOG_MAIL },
569 { US"user", LOG_USER },
570 { US"news", LOG_NEWS },
571 { US"uucp", LOG_UUCP },
572 { US"local0", LOG_LOCAL0 },
573 { US"local1", LOG_LOCAL1 },
574 { US"local2", LOG_LOCAL2 },
575 { US"local3", LOG_LOCAL3 },
576 { US"local4", LOG_LOCAL4 },
577 { US"local5", LOG_LOCAL5 },
578 { US"local6", LOG_LOCAL6 },
579 { US"local7", LOG_LOCAL7 },
580 { US"daemon", LOG_DAEMON }
583 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
586 #define opt_fn_print BIT(0)
587 #define opt_fn_print_label BIT(1)
590 /*************************************************
591 * Find the name of an option *
592 *************************************************/
594 /* This function is to aid debugging. Various functions take arguments that are
595 pointer variables in the options table or in option tables for various drivers.
596 For debugging output, it is useful to be able to find the name of the option
597 which is currently being processed. This function finds it, if it exists, by
598 searching the table(s).
600 Arguments: a value that is presumed to be in the table above
601 Returns: the option name, or an empty string
605 readconf_find_option(void *p)
607 for (int i = 0; i < nelem(optionlist_config); i++)
608 if (p == optionlist_config[i].v.value) return US optionlist_config[i].name;
610 for (router_instance * r = routers; r; r = r->next)
612 router_info *ri = r->info;
613 for (int i = 0; i < *ri->options_count; i++)
615 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
616 if (p == CS (r->options_block) + ri->options[i].v.offset)
617 return US ri->options[i].name;
621 for (transport_instance * t = transports; t; t = t->next)
623 transport_info *ti = t->info;
624 for (int i = 0; i < *ti->options_count; i++)
626 optionlist * op = &ti->options[i];
627 if ((op->type & opt_mask) != opt_stringptr) continue;
628 if (p == ( op->type & opt_public
630 : CS t->options_block
643 /*************************************************
644 * Deal with an assignment to a macro *
645 *************************************************/
647 /* We have a new definition; append to the list.
650 name Name of the macro; will be copied
651 val Expansion result for the macro; will be copied
655 macro_create(const uschar * name, const uschar * val, BOOL command_line)
657 macro_item * m = store_get(sizeof(macro_item), FALSE);
659 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
661 m->command_line = command_line;
662 m->namelen = Ustrlen(name);
663 m->replen = Ustrlen(val);
664 m->name = string_copy(name);
665 m->replacement = string_copy(val);
677 /* This function is called when a line that starts with an upper case letter is
678 encountered. The argument "line" should contain a complete logical line, and
679 start with the first letter of the macro name. The macro name and the
680 replacement text are extracted and stored. Redefinition of existing,
681 non-command line, macros is permitted using '==' instead of '='.
684 s points to the start of the logical line
686 Returns: FALSE iff fatal error
690 macro_read_assignment(uschar *s)
692 uschar name[EXIM_DRIVERNAME_MAX];
697 while (isalnum(*s) || *s == '_')
699 if (namelen >= sizeof(name) - 1)
701 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
702 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
705 name[namelen++] = *s++;
709 Uskip_whitespace(&s);
712 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
721 Uskip_whitespace(&s);
723 /* If an existing macro of the same name was defined on the command line, we
724 just skip this definition. It's an error to attempt to redefine a macro without
725 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
726 It is also an error to define a macro whose name begins with the name of a
727 previously defined macro. This is the requirement that make using a tree
728 for macros hard; we must check all macros for the substring. Perhaps a
729 sorted list, and a bsearch, would work?
730 Note: it is documented that the other way round works. */
732 for (m = macros; m; m = m->next)
734 if (Ustrcmp(m->name, name) == 0)
736 if (!m->command_line && !redef)
738 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
739 "defined (use \"==\" if you want to redefine it)", name);
745 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
747 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
748 "a macro because previously defined macro \"%s\" is a substring",
753 /* We cannot have this test, because it is documented that a substring
754 macro is permitted (there is even an example).
756 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
757 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
758 * "a macro because it is a substring of previously defined macro \"%s\"",
763 /* Check for an overriding command-line definition. */
765 if (m && m->command_line) return TRUE;
767 /* Redefinition must refer to an existing macro. */
772 m->replen = Ustrlen(s);
773 m->replacement = string_copy(s);
777 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
782 /* We have a new definition. */
784 (void) macro_create(name, s, FALSE);
792 /* Process line for macros. The line is in big_buffer starting at offset len.
793 Expand big_buffer if needed. Handle definitions of new macros, and
794 macro expansions, rewriting the line in the buffer.
797 len Offset in buffer of start of line
798 newlen Pointer to offset of end of line, updated on return
799 macro_found Pointer to return that a macro was expanded
801 Return: pointer to first nonblank char in line
805 macros_expand(int len, int * newlen, BOOL * macro_found)
807 uschar * ss = big_buffer + len;
810 /* Find the true start of the physical line - leading spaces are always
813 Uskip_whitespace(&ss);
815 /* Process the physical line for macros. If this is the start of the logical
816 line, skip over initial text at the start of the line if it starts with an
817 upper case character followed by a sequence of name characters and an equals
818 sign, because that is the definition of a new macro, and we don't do
819 replacement therein. */
822 if (len == 0 && isupper(*s))
824 while (isalnum(*s) || *s == '_') s++;
825 if (Uskip_whitespace(&s) != '=') s = ss; /* Not a macro definition */
828 /* Skip leading chars which cannot start a macro name, to avoid multiple
829 pointless rescans in Ustrstr calls. */
831 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
833 /* For each defined macro, scan the line (from after XXX= if present),
834 replacing all occurrences of the macro. */
836 *macro_found = FALSE;
837 if (*s) for (macro_item * m = *s == '_' ? macros : macros_user; m; m = m->next)
842 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
846 while ((p = Ustrstr(t, m->name)) != NULL)
850 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
851 m->name, (int) Ustrlen(ss)-1, ss);
852 /* Expand the buffer if necessary */
854 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
856 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
857 uschar *newbuffer = store_malloc(newsize);
858 memcpy(newbuffer, big_buffer, *newlen + 1);
859 p = newbuffer + (p - big_buffer);
860 s = newbuffer + (s - big_buffer);
861 ss = newbuffer + (ss - big_buffer);
862 t = newbuffer + (t - big_buffer);
863 big_buffer_size = newsize;
864 store_free(big_buffer);
865 big_buffer = newbuffer;
868 /* Shuffle the remaining characters up or down in the buffer before
869 copying in the replacement text. Don't rescan the replacement for this
873 if ((moveby = m->replen - m->namelen) != 0)
875 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
878 Ustrncpy(p, m->replacement, m->replen);
880 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
885 /* An empty macro replacement at the start of a line could mean that ss no
886 longer points to the first non-blank character. */
888 Uskip_whitespace(&ss);
892 /*************************************************
893 * Read configuration line *
894 *************************************************/
896 /* A logical line of text is read from the configuration file into the big
897 buffer, taking account of macros, .includes, and continuations. The size of
898 big_buffer is increased if necessary. The count of configuration lines is
899 maintained. Physical input lines starting with # (ignoring leading white space,
900 and after macro replacement) and empty logical lines are always ignored.
901 Leading and trailing spaces are removed.
903 If we hit a line of the form "begin xxxx", the xxxx is placed in the
904 next_section vector, and the function returns NULL, indicating the end of a
905 configuration section. On end-of-file, NULL is returned with next_section
910 Returns: a pointer to the first non-blank in the line,
911 or NULL if eof or end of section is reached
915 get_config_line(void)
917 int startoffset = 0; /* To first non-blank char in logical line */
918 int len = 0; /* Of logical line so far */
923 /* Loop for handling continuation lines, skipping comments, and dealing with
928 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
930 if (config_file_stack != NULL) /* EOF inside .include */
932 (void)fclose(config_file);
933 config_file = config_file_stack->file;
934 config_filename = config_file_stack->filename;
935 config_directory = config_file_stack->directory;
936 config_lineno = config_file_stack->lineno;
937 config_file_stack = config_file_stack->next;
939 save_config_position(config_filename, config_lineno);
943 /* EOF at top level */
945 if (cstate_stack_ptr >= 0)
946 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
947 "Unexpected end of configuration file: .endif missing");
949 if (len != 0) break; /* EOF after continuation */
950 next_section[0] = 0; /* EOF at start of logical line */
955 newlen = len + Ustrlen(big_buffer + len);
957 if (config_lines && config_lineno == 1)
958 save_config_position(config_filename, config_lineno);
960 /* Handle pathologically long physical lines - yes, it did happen - by
961 extending big_buffer at this point. The code also copes with very long
964 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
967 big_buffer_size += BIG_BUFFER_SIZE;
968 newbuffer = store_malloc(big_buffer_size);
970 /* This use of strcpy is OK because we know that the string in the old
971 buffer is shorter than the new buffer. */
973 Ustrcpy(newbuffer, big_buffer);
974 store_free(big_buffer);
975 big_buffer = newbuffer;
976 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
978 newlen += Ustrlen(big_buffer + newlen);
981 ss = macros_expand(len, &newlen, ¯o_found);
983 /* Check for comment lines - these are physical lines. */
985 if (*ss == '#') continue;
987 /* Handle conditionals, which are also applied to physical lines. Conditions
988 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
989 expansion occurred on the rest of the line. A preliminary test for the leading
990 '.' saves effort on most lines. */
996 /* Search the list of conditional directives */
998 for (i = 0; i < cond_list_size; i++)
1001 cond_item *c = cond_list+i;
1002 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
1004 /* The following character must be white space or end of string */
1006 n = ss[1 + c->namelen];
1007 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
1009 /* .ifdef and .ifndef push the current state onto the stack, then set
1010 a new one from the table. Stack overflow is an error */
1014 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
1015 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1016 ".%s nested too deeply", c->name);
1017 cstate_stack[++cstate_stack_ptr] = cstate;
1018 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
1021 /* For any of the others, stack underflow is an error. The next state
1022 comes either from the stack (.endif) or from the table. */
1026 if (cstate_stack_ptr < 0)
1027 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1028 ".%s without matching .ifdef", c->name);
1029 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1030 next_cstate[cstate][macro_found? c->action1 : c->action2];
1033 /* Having dealt with a directive, break the loop */
1038 /* If we have handled a conditional directive, continue with the next
1039 physical line. Otherwise, fall through. */
1041 if (i < cond_list_size) continue;
1044 /* If the conditional state is not 0 (actively using these lines), ignore
1047 if (cstate != 0) continue; /* Conditional skip */
1049 /* Handle .include lines - these are also physical lines. */
1051 if (Ustrncmp(ss, ".include", 8) == 0 &&
1053 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1056 int include_if_exists = isspace(ss[8])? 0 : 10;
1057 config_file_item *save;
1058 struct stat statbuf;
1060 ss += 9 + include_if_exists;
1061 Uskip_whitespace(&ss);
1062 t = ss + Ustrlen(ss);
1063 while (t > ss && isspace(t[-1])) t--;
1064 if (*ss == '\"' && t[-1] == '\"')
1071 /* We allow relative file names. For security reasons currently
1072 relative names not allowed with .include_if_exists. For .include_if_exists
1073 we need to check the permissions/ownership of the containing folder */
1075 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1076 "absolute path \"%s\"", ss);
1079 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1080 ss = string_from_gstring(g);
1083 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1086 save_config_position(config_filename, config_lineno);
1087 save = store_get(sizeof(config_file_item), FALSE);
1088 save->next = config_file_stack;
1089 config_file_stack = save;
1090 save->file = config_file;
1091 save->filename = config_filename;
1092 save->directory = config_directory;
1093 save->lineno = config_lineno;
1095 if (!(config_file = Ufopen(ss, "rb")))
1096 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1097 "configuration file %s", ss);
1099 config_filename = string_copy(ss);
1100 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1105 /* If this is the start of the logical line, remember where the non-blank
1106 data starts. Otherwise shuffle down continuation lines to remove leading
1110 startoffset = ss - big_buffer;
1113 s = big_buffer + len;
1116 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1121 /* Accept the new addition to the line. Remove trailing white space. */
1124 while (len > 0 && isspace(big_buffer[len-1])) len--;
1125 big_buffer[len] = 0;
1127 /* We are done if the line does not end in backslash and contains some data.
1128 Empty logical lines are ignored. For continuations, remove the backslash and
1129 go round the loop to read the continuation line. */
1133 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1134 big_buffer[--len] = 0; /* Remove backslash */
1136 } /* Loop for reading multiple physical lines */
1138 /* We now have a logical line. Test for the end of a configuration section (or,
1139 more accurately, for the start of the next section). Place the name of the next
1140 section in next_section, and return NULL. If the name given is longer than
1141 next_section, truncate it. It will be unrecognized later, because all the known
1142 section names do fit. Leave space for pluralizing. */
1144 s = big_buffer + startoffset; /* First non-space character */
1147 save_config_line(s);
1149 if (strncmpic(s, US"begin ", 6) == 0)
1152 Uskip_whitespace(&s);
1153 if (big_buffer + len - s > sizeof(next_section) - 2)
1154 s[sizeof(next_section) - 2] = 0;
1155 Ustrcpy(next_section, s);
1159 /* Return the first non-blank character. */
1166 /*************************************************
1168 *************************************************/
1170 /* The yield is the pointer to the next uschar. Names longer than the
1171 output space are silently truncated. This function is also used from acl.c when
1175 name where to put the name
1179 Returns: new input pointer
1183 readconf_readname(uschar *name, int len, uschar *s)
1186 BOOL broken = FALSE;
1188 if (isalpha(Uskip_whitespace(&s)))
1189 while (isalnum(*s) || *s == '_')
1191 if (p < len-1) name[p++] = *s;
1201 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1202 "exim item name too long (>%d), unable to use \"%s\" (truncated)",
1205 Uskip_whitespace(&s);
1212 /*************************************************
1213 * Read a time value *
1214 *************************************************/
1216 /* This function is also called from outside, to read argument
1217 time values. The format of a time value is:
1219 [<n>w][<n>d][<n>h][<n>m][<n>s]
1221 as long as at least one is present. If a format error is encountered,
1222 return a negative value. The value must be terminated by the given
1227 terminator required terminating character
1228 return_msec if TRUE, allow fractional seconds and return milliseconds
1230 Returns: the time value, or -1 on syntax error
1231 value is seconds if return_msec is FALSE
1232 value is milliseconds if return_msec is TRUE
1236 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1244 if (!isdigit(*s)) return -1;
1245 (void)sscanf(CCS s, "%d%n", &value, &count);
1250 case 'w': value *= 7;
1251 case 'd': value *= 24;
1252 case 'h': value *= 60;
1253 case 'm': value *= 60;
1258 if (!return_msec) return -1;
1259 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1261 if (*s++ != 's') return -1;
1262 yield += (int)(fraction * 1000.0);
1268 if (return_msec) value *= 1000;
1270 if (*s == terminator) return yield;
1272 /* Control never reaches here. */
1277 /*************************************************
1278 * Read a fixed point value *
1279 *************************************************/
1281 /* The value is returned *1000
1285 terminator required terminator
1287 Returns: the value, or -1 on error
1291 readconf_readfixed(const uschar *s, int terminator)
1295 if (!isdigit(*s)) return -1;
1296 (void)sscanf(CS s, "%d%n", &value, &count);
1298 yield = value * 1000;
1302 while (isdigit((*(++s))))
1304 yield += (*s - '0') * m;
1309 return (*s == terminator)? yield : (-1);
1314 /*************************************************
1315 * Find option in list *
1316 *************************************************/
1318 /* The lists are always in order, so binary chop can be used.
1321 name the option name to search for
1322 ol the first entry in the option list
1323 last one more than the offset of the last entry in the option list
1325 Returns: pointer to an option entry, or NULL if not found
1329 find_option(const uschar *name, optionlist *ol, int last)
1332 while (last > first)
1334 int middle = (first + last)/2;
1335 int c = Ustrcmp(name, ol[middle].name);
1337 if (c == 0) return ol + middle;
1338 else if (c > 0) first = middle + 1;
1346 /*************************************************
1347 * Find a set flag in option list *
1348 *************************************************/
1350 /* Because some versions of Unix make no restrictions on the values of uids and
1351 gids (even negative ones), we cannot represent "unset" by a special value.
1352 There is therefore a separate boolean variable for each one indicating whether
1353 a value is set or not. This function returns a pointer to the boolean, given
1354 the original option name. It is a major disaster if the flag cannot be found.
1357 name the name of the uid or gid option
1358 oltop points to the start of the relevant option list
1359 last one more than the offset of the last item in the option list
1360 data_block NULL when reading main options => data values in the option
1361 list are absolute addresses; otherwise they are byte offsets
1362 in data_block (used for driver options)
1364 Returns: a pointer to the boolean flag.
1368 get_set_flag(const uschar *name, optionlist *oltop, int last, void *data_block)
1371 uschar name2[EXIM_DRIVERNAME_MAX];
1372 sprintf(CS name2, "*set_%.50s", name);
1373 if (!(ol = find_option(name2, oltop, last)))
1374 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1375 "Exim internal error: missing set flag for %s", name);
1377 ? (BOOL *)(US data_block + ol->v.offset) : (BOOL *)ol->v.value;
1383 /*************************************************
1384 * Output extra characters message and die *
1385 *************************************************/
1387 /* Called when an option line has junk on the end. Sometimes this is because
1388 the sysadmin thinks comments are permitted.
1391 s points to the extra characters
1392 t1..t3 strings to insert in the log message
1394 Returns: doesn't return; dies
1398 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1400 uschar *comment = US"";
1401 if (*s == '#') comment = US" (# is comment only at line start)";
1402 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1403 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1408 /*************************************************
1409 * Read rewrite information *
1410 *************************************************/
1412 /* Each line of rewrite information contains:
1414 . A complete address in the form user@domain, possibly with
1415 leading * for each part; or alternatively, a regex.
1417 . A replacement string (which will be expanded).
1419 . An optional sequence of one-letter flags, indicating which
1420 headers etc. to apply this rule to.
1422 All this is decoded and placed into a control block. The OR of the flags is
1423 maintained in a common word.
1426 p points to the string that makes up the rule
1427 existflags points to the overall flag word
1428 isglobal TRUE if reading global rewrite rules
1430 Returns: the control block for the parsed rule.
1433 static rewrite_rule *
1434 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1436 rewrite_rule *next = store_get(sizeof(rewrite_rule), FALSE);
1439 next->key = string_dequote(&p);
1441 Uskip_whitespace(&p);
1443 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1444 "missing rewrite replacement string");
1447 next->replacement = string_dequote(&p);
1449 while (*p) switch (*p++)
1451 case ' ': case '\t': break;
1453 case 'q': next->flags |= rewrite_quit; break;
1454 case 'w': next->flags |= rewrite_whole; break;
1456 case 'h': next->flags |= rewrite_all_headers; break;
1457 case 's': next->flags |= rewrite_sender; break;
1458 case 'f': next->flags |= rewrite_from; break;
1459 case 't': next->flags |= rewrite_to; break;
1460 case 'c': next->flags |= rewrite_cc; break;
1461 case 'b': next->flags |= rewrite_bcc; break;
1462 case 'r': next->flags |= rewrite_replyto; break;
1464 case 'E': next->flags |= rewrite_all_envelope; break;
1465 case 'F': next->flags |= rewrite_envfrom; break;
1466 case 'T': next->flags |= rewrite_envto; break;
1468 case 'Q': next->flags |= rewrite_qualify; break;
1469 case 'R': next->flags |= rewrite_repeat; break;
1472 next->flags |= rewrite_smtp;
1473 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1474 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1475 "rewrite rule has the S flag but is not a regular expression");
1479 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1480 "unknown rewrite flag character '%c' "
1481 "(could be missing quotes round replacement item)", p[-1]);
1485 /* If no action flags are set, set all the "normal" rewrites. */
1487 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1488 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1490 /* Remember which exist, for optimization, and return the rule */
1492 *existflags |= next->flags;
1499 /*************************************************
1500 * Read global rewrite information *
1501 *************************************************/
1503 /* Each line is a single rewrite rule; it is parsed into a control block
1504 by readconf_one_rewrite(), and its flags are ORed into the global flag
1505 word rewrite_existflags. */
1508 readconf_rewrites(void)
1510 rewrite_rule **chain = &global_rewrite_rules;
1513 while ((p = get_config_line()) != NULL)
1515 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1517 chain = &(next->next);
1523 /*************************************************
1525 *************************************************/
1527 /* Strings are read into the normal store pool. As long we aren't too
1528 near the end of the current block, the string will just use what is necessary
1529 on the top of the stacking pool, because string_cat() uses the extension
1533 s the rest of the input line
1534 name the option name (for errors)
1536 Returns: pointer to the string
1540 read_string(const uschar *s, const uschar *name)
1545 if (*s != '\"') return string_copy(s);
1548 yield = string_dequote(&s);
1550 if (s == ss+1 || s[-1] != '\"')
1551 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1552 "missing quote at end of string value for %s", name);
1554 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1560 /*************************************************
1561 * Custom-handler options *
1562 *************************************************/
1564 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags)
1566 if (flags & opt_fn_print)
1568 if (flags & opt_fn_print_label) printf("%s = ", name);
1569 printf("%s\n", smtp_receive_timeout_s
1570 ? string_printing2(smtp_receive_timeout_s, SP_TAB)
1571 : readconf_printtime(smtp_receive_timeout));
1573 else if (*str == '$')
1574 smtp_receive_timeout_s = string_copy(str);
1577 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1578 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1579 if (smtp_receive_timeout < 0)
1580 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1585 /*************************************************
1586 * Handle option line *
1587 *************************************************/
1589 /* This function is called from several places to process a line containing the
1590 setting of an option. The first argument is the line to be decoded; it has been
1591 checked not to be empty and not to start with '#'. Trailing newlines and white
1592 space have been removed. The second argument is a pointer to the list of
1593 variable names that are to be recognized, together with their types and
1594 locations, and the third argument gives the number of entries in the list.
1596 The fourth argument is a pointer to a data block. If it is NULL, then the data
1597 values in the options list are absolute addresses. Otherwise, they are byte
1598 offsets in the data block.
1600 String option data may continue onto several lines; this function reads further
1601 data from config_file if necessary.
1603 The yield of this function is normally zero. If a string continues onto
1604 multiple lines, then the data value is permitted to be followed by a comma
1605 or a semicolon (for use in drivers) and the yield is that character.
1608 buffer contains the configuration line to be handled
1609 oltop points to the start of the relevant option list
1610 last one more than the offset of the last item in the option list
1611 data_block NULL when reading main options => data values in the option
1612 list are absolute addresses; otherwise they are byte offsets
1613 in data_block when they have opt_public set; otherwise
1614 they are byte offsets in data_block->options_block.
1615 unknown_txt format string to use in panic message for unknown option;
1616 must contain %s for option name
1617 if given as NULL, don't panic on unknown option
1619 Returns: TRUE if an option was read successfully,
1620 FALSE false for an unknown option if unknown_txt == NULL,
1621 otherwise panic and die on an unknown option
1625 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1626 void *data_block, uschar *unknown_txt)
1630 int count, type, value;
1634 BOOL boolvalue = TRUE;
1635 BOOL freesptr = TRUE;
1636 optionlist *ol, *ol2;
1640 uschar *inttype = US"";
1643 uschar **str_target;
1644 uschar name[EXIM_DRIVERNAME_MAX];
1645 uschar name2[EXIM_DRIVERNAME_MAX];
1647 /* There may be leading spaces; thereafter, we expect an option name starting
1650 while (isspace(*s)) s++;
1652 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1654 /* Read the name of the option, and skip any subsequent white space. If
1655 it turns out that what we read was "hide", set the flag indicating that
1656 this is a secure option, and loop to read the next word. */
1658 for (int n = 0; n < 2; n++)
1660 while (isalnum(*s) || *s == '_')
1662 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1666 while (isspace(*s)) s++;
1667 if (Ustrcmp(name, "hide") != 0) break;
1668 issecure = opt_secure;
1672 /* Deal with "no_" or "not_" here for booleans */
1674 if (Ustrncmp(name, "no_", 3) == 0)
1680 if (Ustrncmp(name, "not_", 4) == 0)
1686 /* Search the list for the given name. A non-existent name, or an option that
1687 is set twice, is a disaster. */
1689 if (!(ol = find_option(name + offset, oltop, last)))
1691 if (!unknown_txt) return FALSE;
1692 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1695 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1696 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1697 "\"%s\" option set for the second time", name);
1699 ol->type |= opt_set | issecure;
1700 type = ol->type & opt_mask;
1702 /* Types with data values must be followed by '='; the "no[t]_" prefix
1703 applies only to boolean values. */
1705 if (type < opt_bool || type > opt_bool_last)
1708 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1709 "negation prefix applied to a non-boolean option");
1711 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1712 "unexpected end of line (data missing) after %s", name);
1714 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1717 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1718 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1719 ultimately expands to one of those values. */
1721 else if (*s && (offset != 0 || *s != '='))
1722 extra_chars_error(s, US"boolean option ", name, US"");
1724 /* Skip white space after = */
1726 if (*s == '=') while (isspace((*(++s))));
1728 /* If there is a data block and the opt_public flag is not set, change
1729 the data block pointer to the private options block. */
1731 if (data_block && !(ol->type & opt_public))
1732 data_block = (void *)(((driver_instance *)data_block)->options_block);
1734 /* Now get the data according to the type. */
1738 /* If a string value is not enclosed in quotes, it consists of
1739 the rest of the current line, verbatim. Otherwise, string escapes
1742 A transport is specified as a string, which is then looked up in the
1743 list of transports. A search type is specified as one of a number of
1746 A set or rewrite rules for a driver is specified as a string, which is
1747 then parsed into a suitable chain of control blocks.
1749 Uids and gids are specified as strings which are then looked up in the
1750 passwd file. Lists of uids and gids are similarly specified as colon-
1751 separated strings. */
1756 case opt_expand_uid:
1757 case opt_expand_gid:
1762 reset_point = store_mark();
1763 sptr = read_string(s, name);
1765 /* Having read a string, we now have several different ways of using it,
1766 depending on the data type, so do another switch. If keeping the actual
1767 string is not required (because it is interpreted), freesptr is set TRUE,
1768 and at the end we reset the pool. */
1772 /* If this was a string, set the variable to point to the new string,
1773 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1774 rules, we still keep the string (for printing), and parse the rules into a
1775 control block and flags word. */
1778 str_target = data_block ? USS (US data_block + ol->v.offset)
1780 if (ol->type & opt_rep_con)
1782 uschar * saved_condition;
1783 /* We already have a condition, we're conducting a crude hack to let
1784 multiple condition rules be chained together, despite storing them in
1786 *str_target = string_copy_perm( (saved_condition = *str_target)
1787 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1788 saved_condition, sptr)
1791 /* TODO(pdp): there is a memory leak here and just below
1792 when we set 3 or more conditions; I still don't
1793 understand the store mechanism enough to know
1794 what's the safe way to free content from an earlier store.
1795 AFAICT, stores stack, so freeing an early stored item also stores
1796 all data alloc'd after it. If we knew conditions were adjacent,
1797 we could survive that, but we don't. So I *think* we need to take
1798 another bit from opt_type to indicate "malloced"; this seems like
1799 quite a hack, especially for this one case. It also means that
1800 we can't ever reclaim the store from the *first* condition.
1802 Because we only do this once, near process start-up, I'm prepared to
1803 let this slide for the time being, even though it rankles. */
1805 else if (ol->type & opt_rep_str)
1808 Ustrncmp(name, "headers_add", 11) == 0 ? '\n'
1809 : Ustrncmp(name, "set", 3) == 0 ? ';'
1811 int sep_i = -(int)sep_o;
1812 const uschar * list = sptr;
1814 gstring * list_o = NULL;
1818 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1819 list_o = string_cat(list_o, *str_target);
1822 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1823 list_o = string_append_listele(list_o, sep_o, s);
1826 *str_target = string_copy_perm(string_from_gstring(list_o), FALSE);
1837 *USS (US data_block + ol->v.offset) = sptr;
1839 *USS ol->v.value = sptr;
1841 if (type == opt_rewrite)
1846 rewrite_rule **chain;
1849 sprintf(CS name2, "*%.50s_rules", name);
1850 ol2 = find_option(name2, oltop, last);
1851 sprintf(CS name2, "*%.50s_flags", name);
1852 ol3 = find_option(name2, oltop, last);
1855 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1856 "rewrite rules not available for driver");
1860 chain = (rewrite_rule **)(US data_block + ol2->v.offset);
1861 flagptr = (int *)(US data_block + ol3->v.offset);
1865 chain = (rewrite_rule **)ol2->v.value;
1866 flagptr = (int *)ol3->v.value;
1869 /* This will trap if sptr is tainted. Not sure if that can happen */
1870 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1872 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1874 chain = &(next->next);
1877 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1878 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1879 "non-header rewrite - not allowed at transport time -");
1883 /* If it was an expanded uid, see if there is any expansion to be
1884 done by checking for the presence of a $ character. If there is, save it
1885 in the corresponding *expand_user option field. Otherwise, fall through
1886 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1889 case opt_expand_uid:
1890 sprintf(CS name2, "*expand_%.50s", name);
1891 if ((ol2 = find_option(name2, oltop, last)))
1893 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1896 *(USS(US data_block + ol2->v.offset)) = ss;
1898 *(USS ol2->v.value) = ss;
1902 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1908 /* Look up a fixed uid, and also make use of the corresponding gid
1909 if a passwd entry is returned and the gid has not been set. */
1912 if (!route_finduser(sptr, &pw, &uid))
1913 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1915 *(uid_t *)(US data_block + ol->v.offset) = uid;
1917 *(uid_t *)ol->v.value = uid;
1919 /* Set the flag indicating a fixed value is set */
1921 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1923 /* Handle matching gid if we have a passwd entry: done by finding the
1924 same name with terminating "user" changed to "group"; if not found,
1925 ignore. Also ignore if the value is already set. */
1927 if (pw == NULL) break;
1928 Ustrcpy(name+Ustrlen(name)-4, US"group");
1929 ol2 = find_option(name, oltop, last);
1930 if (ol2 && ((ol2->type & opt_mask) == opt_gid ||
1931 (ol2->type & opt_mask) == opt_expand_gid))
1933 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1937 *((gid_t *)(US data_block + ol2->v.offset)) = pw->pw_gid;
1939 *((gid_t *)ol2->v.value) = pw->pw_gid;
1945 /* If it was an expanded gid, see if there is any expansion to be
1946 done by checking for the presence of a $ character. If there is, save it
1947 in the corresponding *expand_user option field. Otherwise, fall through
1948 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1951 case opt_expand_gid:
1952 sprintf(CS name2, "*expand_%.50s", name);
1953 if ((ol2 = find_option(name2, oltop, last)))
1955 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1958 *(USS(US data_block + ol2->v.offset)) = ss;
1960 *(USS ol2->v.value) = ss;
1964 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1970 /* Handle freestanding gid */
1973 if (!route_findgroup(sptr, &gid))
1974 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1976 *((gid_t *)(US data_block + ol->v.offset)) = gid;
1978 *((gid_t *)ol->v.value) = gid;
1979 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1982 /* If it was a uid list, look up each individual entry, and build
1983 a vector of uids, with a count in the first element. Put the vector
1984 in malloc store so we can free the string. (We are reading into
1985 permanent store already.) */
1993 const uschar *op = expand_string (sptr);
1996 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1997 name, expand_string_message);
2000 if (*p != 0) count++;
2001 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2002 list = store_malloc(count*sizeof(uid_t));
2003 list[ptr++] = (uid_t)(count - 1);
2006 *((uid_t **)(US data_block + ol->v.offset)) = list;
2008 *((uid_t **)ol->v.value) = list;
2014 /* If p is tainted we trap. Not sure that can happen */
2015 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2016 if (!route_finduser(big_buffer, NULL, &uid))
2017 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
2024 /* If it was a gid list, look up each individual entry, and build
2025 a vector of gids, with a count in the first element. Put the vector
2026 in malloc store so we can free the string. (We are reading into permanent
2035 const uschar *op = expand_string (sptr);
2038 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2039 name, expand_string_message);
2042 if (*p != 0) count++;
2043 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2044 list = store_malloc(count*sizeof(gid_t));
2045 list[ptr++] = (gid_t)(count - 1);
2048 *((gid_t **)(US data_block + ol->v.offset)) = list;
2050 *((gid_t **)ol->v.value) = list;
2056 /* If p is tainted we trap. Not sure that can happen */
2057 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2058 if (!route_findgroup(big_buffer, &gid))
2059 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2067 /* Release store if the value of the string doesn't need to be kept. */
2069 if (freesptr) reset_point = store_reset(reset_point);
2072 /* Expanded boolean: if no characters follow, or if there are no dollar
2073 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2074 save the string for later expansion in the alternate place. */
2076 case opt_expand_bool:
2077 if (*s && Ustrchr(s, '$') != 0)
2079 sprintf(CS name2, "*expand_%.50s", name);
2080 if ((ol2 = find_option(name2, oltop, last)))
2082 reset_point = store_mark();
2083 sptr = read_string(s, name);
2085 *(USS(US data_block + ol2->v.offset)) = sptr;
2087 *(USS ol2->v.value) = sptr;
2094 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2095 look for yes/not/true/false. Some booleans are stored in a single bit in
2096 a single int. There's a special fudge for verify settings; without a suffix
2097 they set both xx_sender and xx_recipient. The table points to the sender
2098 value; search subsequently for the recipient. There's another special case:
2099 opt_bool_set also notes when a boolean has been set. */
2103 case opt_bool_verify:
2107 s = readconf_readname(name2, EXIM_DRIVERNAME_MAX, s);
2108 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2110 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2112 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2113 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2114 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2115 US"for boolean option ", name);
2118 /* Handle single-bit type. */
2120 if (type == opt_bit)
2122 int bit = 1 << ((ol->type >> 16) & 31);
2123 int * ptr = data_block
2124 ? (int *)(US data_block + ol->v.offset)
2125 : (int *)ol->v.value;
2126 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2130 /* Handle full BOOL types */
2133 *((BOOL *)(US data_block + ol->v.offset)) = boolvalue;
2135 *((BOOL *)ol->v.value) = boolvalue;
2139 if (type == opt_bool_verify)
2141 sprintf(CS name2, "%.50s_recipient", name + offset);
2142 if ((ol2 = find_option(name2, oltop, last)))
2144 *((BOOL *)(US data_block + ol2->v.offset)) = boolvalue;
2146 *((BOOL *)ol2->v.value) = boolvalue;
2149 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2151 else if (type == opt_bool_set)
2153 sprintf(CS name2, "*set_%.50s", name + offset);
2154 if ((ol2 = find_option(name2, oltop, last)))
2156 *((BOOL *)(US data_block + ol2->v.offset)) = TRUE;
2158 *((BOOL *)ol2->v.value) = TRUE;
2166 inttype = US"octal ";
2168 /* Integer: a simple(ish) case; allow octal and hex formats, and
2169 suffixes K, M, G, and T. The different types affect output, not input. */
2178 lvalue = strtol(CS s, CSS &endptr, intbase);
2181 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2184 if (errno != ERANGE && *endptr)
2186 uschar * mp = US"TtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2188 if ((mp = Ustrchr(mp, *endptr)))
2193 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2204 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2205 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2206 "absolute value of integer \"%s\" is too large (overflow)", s);
2208 while (isspace(*endptr)) endptr++;
2210 extra_chars_error(endptr, inttype, US"integer value for ", name);
2212 value = (int)lvalue;
2216 *(int *)(US data_block + ol->v.offset) = value;
2218 *(int *)ol->v.value = value;
2221 /* Integer held in K: again, allow formats and suffixes as above. */
2227 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2230 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2233 if (errno != ERANGE && *endptr)
2235 uschar * mp = US"ZzEePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2237 if ((mp = Ustrchr(mp, *endptr)))
2242 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2251 lvalue = (lvalue + 512)/1024;
2254 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2255 "absolute value of integer \"%s\" is too large (overflow)", s);
2257 while (isspace(*endptr)) endptr++;
2259 extra_chars_error(endptr, inttype, US"integer value for ", name);
2262 *(int_eximarith_t *)(US data_block + ol->v.offset) = lvalue;
2264 *(int_eximarith_t *)ol->v.value = lvalue;
2268 /* Fixed-point number: held to 3 decimal places. */
2271 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2272 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2273 "fixed-point number expected for %s", name);
2275 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2276 "integer \"%s\" is too large (overflow)", s);
2280 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2281 "integer \"%s\" is too large (overflow)", s);
2283 /* We get a coverity error here for using count, as it derived
2284 from the tainted buffer pointed to by s, as parsed by sscanf().
2285 By the definition of sscanf we must be accessing between start
2286 and end of s (assuming it is nul-terminated...) so ignore the error. */
2287 /* coverity[tainted_data] */
2288 if (s[count] == '.')
2291 while (isdigit(s[++count]))
2293 value += (s[count] - '0') * d;
2298 while (isspace(s[count])) count++;
2301 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2304 *((int *)(US data_block + ol->v.offset)) = value;
2306 *((int *)ol->v.value) = value;
2309 /* There's a special routine to read time values. */
2312 value = readconf_readtime(s, 0, FALSE);
2314 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2317 *((int *)(US data_block + ol->v.offset)) = value;
2319 *((int *)ol->v.value) = value;
2322 /* A time list is a list of colon-separated times, with the first
2323 element holding the size of the list and the second the number of
2329 int * list = data_block
2330 ? (int *)(US data_block + ol->v.offset)
2331 : (int *)ol->v.value;
2333 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2336 uschar *snext = Ustrchr(s, ':');
2340 while (ss > s && isspace(ss[-1])) ss--;
2343 value = readconf_readtime(s, terminator, FALSE);
2345 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2347 if (count > 1 && value <= list[count])
2348 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2349 "time value out of order for %s", name);
2350 list[count+1] = value;
2351 if (snext == NULL) break;
2353 while (isspace(*s)) s++;
2356 if (count > list[0] - 2)
2357 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2359 if (count > 0 && list[2] == 0) count = 0;
2366 void (*fn)() = ol->v.fn;
2377 /*************************************************
2378 * Print a time value *
2379 *************************************************/
2382 Argument: a time value in seconds
2383 Returns: pointer to a fixed buffer containing the time as a string,
2384 in readconf_readtime() format
2388 readconf_printtime(int t)
2391 uschar *p = time_buffer;
2408 if (w > 0) p += sprintf(CS p, "%dw", w);
2409 if (d > 0) p += sprintf(CS p, "%dd", d);
2410 if (h > 0) p += sprintf(CS p, "%dh", h);
2411 if (m > 0) p += sprintf(CS p, "%dm", m);
2412 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2419 /*************************************************
2420 * Print an individual option value *
2421 *************************************************/
2423 /* This is used by the -bP option, so prints to the standard output.
2424 The entire options list is passed in as an argument, because some options come
2425 in pairs - typically uid/gid settings, which can either be explicit numerical
2426 values, or strings to be expanded later. If the numerical value is unset,
2427 search for "*expand_<name>" to see if there is a string equivalent.
2430 ol option entry, or NULL for an unknown option
2432 options_block NULL for main configuration options; otherwise points to
2433 a driver block; if the option doesn't have opt_public
2434 set, then options_block->options_block is where the item
2436 oltop points to the option list in which ol exists
2437 last one more than the offset of the last entry in optop
2438 no_labels do not show "foo = " at the start.
2440 Returns: boolean success
2444 print_ol(optionlist *ol, const uschar *name, void *options_block,
2445 optionlist *oltop, int last, BOOL no_labels)
2454 uschar name2[EXIM_DRIVERNAME_MAX];
2458 printf("%s is not a known option\n", name);
2462 /* Non-admin callers cannot see options that have been flagged secure by the
2465 if (!f.admin_user && ol->type & opt_secure)
2468 printf("%s\n", CCS hidden);
2470 printf("%s = %s\n", name, CCS hidden);
2474 /* Else show the value of the option */
2476 value = ol->v.value;
2479 if (!(ol->type & opt_public))
2480 options_block = (void *)(((driver_instance *)options_block)->options_block);
2481 value = (void *)(US options_block + (long int)value);
2484 switch(ol->type & opt_mask)
2487 case opt_rewrite: /* Show the text value */
2489 if (!no_labels) printf("%s = ", name);
2490 printf("%s\n", s ? string_printing2(s, SP_TAB) : US"");
2494 if (!no_labels) printf("%s = ", name);
2495 printf("%d\n", *((int *)value));
2500 int x = *((int *)value);
2501 if (x != 0 && (x & 1023) == 0)
2505 if ((x & 1023) == 0)
2510 if (!no_labels) printf("%s = ", name);
2511 printf("%d%c\n", x, c);
2515 if (!no_labels) printf("%s = ", name);
2523 int_eximarith_t x = *((int_eximarith_t *)value);
2524 if (!no_labels) printf("%s = ", name);
2525 if (x == 0) printf("0\n");
2526 else if ((x & ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH "T\n", x >> 30);
2527 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2528 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2529 else printf(PR_EXIM_ARITH "K\n", x);
2534 if (!no_labels) printf("%s = ", name);
2535 printf("%#o\n", *((int *)value));
2538 /* Can be negative only when "unset", in which case integer */
2542 int x = *((int *)value);
2545 if (x < 0) printf("%s =\n", name); else
2547 if (!no_labels) printf("%s = ", name);
2548 printf("%d.", x/1000);
2561 /* If the numerical value is unset, try for the string value */
2563 case opt_expand_uid:
2564 if (! *get_set_flag(name, oltop, last, options_block))
2566 sprintf(CS name2, "*expand_%.50s", name);
2567 if ((ol2 = find_option(name2, oltop, last)))
2570 s = *USS (US options_block + ol2->v.offset);
2572 s = *USS ol2->v.value;
2573 if (!no_labels) printf("%s = ", name);
2574 printf("%s\n", s ? string_printing(s) : US"");
2579 /* Else fall through */
2582 if (!no_labels) printf("%s = ", name);
2583 if (! *get_set_flag(name, oltop, last, options_block))
2586 if ((pw = getpwuid(*((uid_t *)value))))
2587 printf("%s\n", pw->pw_name);
2589 printf("%ld\n", (long int)(*((uid_t *)value)));
2592 /* If the numerical value is unset, try for the string value */
2594 case opt_expand_gid:
2595 if (! *get_set_flag(name, oltop, last, options_block))
2597 sprintf(CS name2, "*expand_%.50s", name);
2598 if ( (ol2 = find_option(name2, oltop, last))
2599 && (ol2->type & opt_mask) == opt_stringptr)
2602 s = *USS (US options_block + ol2->v.offset);
2604 s = *USS ol2->v.value;
2605 if (!no_labels) printf("%s = ", name);
2606 printf("%s\n", s ? string_printing(s) : US"");
2611 /* Else fall through */
2614 if (!no_labels) printf("%s = ", name);
2615 if (! *get_set_flag(name, oltop, last, options_block))
2618 if ((gr = getgrgid(*((int *)value))))
2619 printf("%s\n", gr->gr_name);
2621 printf("%ld\n", (long int)(*((int *)value)));
2625 uidlist = *((uid_t **)value);
2626 if (!no_labels) printf("%s =", name);
2629 uschar sep = no_labels ? '\0' : ' ';
2630 for (int i = 1; i <= (int)(uidlist[0]); i++)
2632 uschar *name = NULL;
2633 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2634 if (sep != '\0') printf("%c", sep);
2635 if (name) printf("%s", name);
2636 else printf("%ld", (long int)(uidlist[i]));
2644 gidlist = *((gid_t **)value);
2645 if (!no_labels) printf("%s =", name);
2648 uschar sep = no_labels ? '\0' : ' ';
2649 for (int i = 1; i <= (int)(gidlist[0]); i++)
2651 uschar *name = NULL;
2652 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2653 if (sep != '\0') printf("%c", sep);
2654 if (name) printf("%s", name);
2655 else printf("%ld", (long int)(gidlist[i]));
2663 if (!no_labels) printf("%s = ", name);
2664 printf("%s\n", readconf_printtime(*((int *)value)));
2669 int *list = (int *)value;
2670 if (!no_labels) printf("%s = ", name);
2671 for (int i = 0; i < list[1]; i++)
2672 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2678 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2682 case opt_expand_bool:
2683 sprintf(CS name2, "*expand_%.50s", name);
2684 if ((ol2 = find_option(name2, oltop, last)) && ol2->v.value)
2687 s = *USS (US options_block + ol2->v.offset);
2689 s = *USS ol2->v.value;
2692 if (!no_labels) printf("%s = ", name);
2693 printf("%s\n", string_printing(s));
2696 /* s == NULL => string not set; fall through */
2702 case opt_bool_verify:
2704 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2708 ol->v.fn(name, NULL, no_labels ? opt_fn_print : opt_fn_print|opt_fn_print_label);
2716 /*************************************************
2717 * Print value from main configuration *
2718 *************************************************/
2720 /* This function, called as a result of encountering the -bP option,
2721 causes the value of any main configuration variable to be output if the
2722 second argument is NULL. There are some special values:
2724 all print all main configuration options
2725 config_file print the name of the configuration file
2726 (configure_file will still work, for backward
2728 routers print the routers' configurations
2729 transports print the transports' configuration
2730 authenticators print the authenticators' configuration
2731 macros print the macros' configuration
2732 router_list print a list of router names
2733 transport_list print a list of transport names
2734 authenticator_list print a list of authentication mechanism names
2735 macro_list print a list of macro names
2736 +name print a named list item
2737 local_scan print the local_scan options
2738 config print the configuration as it is parsed
2739 environment print the used execution environment
2741 If the second argument is not NULL, it must be one of "router", "transport",
2742 "authenticator" or "macro" in which case the first argument identifies the
2743 driver whose options are to be printed.
2746 name option name if type == NULL; else driver name
2747 type NULL or driver type name, as described above
2748 no_labels avoid the "foo = " at the start of an item
2750 Returns: Boolean success
2754 readconf_print(const uschar *name, uschar *type, BOOL no_labels)
2756 BOOL names_only = FALSE;
2757 optionlist *ol2 = NULL;
2758 driver_instance *d = NULL;
2767 static uschar *types[] = { US"address", US"domain", US"host",
2769 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2770 &hostlist_anchor, &localpartlist_anchor };
2772 for (int i = 0; i < 4; i++)
2773 if ((t = tree_search(*(anchors[i]), name+1)))
2775 namedlist_block * nb = t->data.ptr;
2776 const uschar * s = nb->hide ? hidden : nb->string;
2779 printf("%s\n", CCS s);
2781 printf("%slist %s = %s\n", types[i], name+1, CCS s);
2785 printf("no address, domain, host, or local part list called \"%s\" "
2786 "exists\n", name+1);
2791 if ( Ustrcmp(name, "configure_file") == 0
2792 || Ustrcmp(name, "config_file") == 0)
2794 printf("%s\n", CS config_main_filename);
2798 if (Ustrcmp(name, "all") == 0)
2800 for (optionlist * ol = optionlist_config;
2801 ol < optionlist_config + nelem(optionlist_config); ol++)
2802 if (!(ol->type & opt_hidden))
2803 (void) print_ol(ol, US ol->name, NULL,
2804 optionlist_config, nelem(optionlist_config),
2809 if (Ustrcmp(name, "local_scan") == 0)
2811 #ifndef LOCAL_SCAN_HAS_OPTIONS
2812 printf("local_scan() options are not supported\n");
2815 for (optionlist * ol = local_scan_options;
2816 ol < local_scan_options + local_scan_options_count; ol++)
2817 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2818 local_scan_options_count, no_labels);
2823 if (Ustrcmp(name, "config") == 0)
2825 print_config(f.admin_user, no_labels);
2829 if (Ustrcmp(name, "routers") == 0)
2834 else if (Ustrcmp(name, "transports") == 0)
2836 type = US"transport";
2839 else if (Ustrcmp(name, "authenticators") == 0)
2841 type = US"authenticator";
2844 else if (Ustrcmp(name, "macros") == 0)
2849 else if (Ustrcmp(name, "router_list") == 0)
2855 else if (Ustrcmp(name, "transport_list") == 0)
2857 type = US"transport";
2861 else if (Ustrcmp(name, "authenticator_list") == 0)
2863 type = US"authenticator";
2867 else if (Ustrcmp(name, "macro_list") == 0)
2873 else if (Ustrcmp(name, "environment") == 0)
2878 for (p = USS environ; *p; p++) ;
2879 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2881 for (p = USS environ; *p; p++)
2884 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2892 return print_ol(find_option(name,
2893 optionlist_config, nelem(optionlist_config)),
2894 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2897 /* Handle the options for a router or transport. Skip options that are flagged
2898 as hidden. Some of these are options with names starting with '*', used for
2899 internal alternative representations of other options (which the printing
2900 function will sort out). Others are synonyms kept for backward compatibility.
2903 if (Ustrcmp(type, "router") == 0)
2905 d = (driver_instance *)routers;
2906 ol2 = optionlist_routers;
2907 size = optionlist_routers_size;
2909 else if (Ustrcmp(type, "transport") == 0)
2911 d = (driver_instance *)transports;
2912 ol2 = optionlist_transports;
2913 size = optionlist_transports_size;
2915 else if (Ustrcmp(type, "authenticator") == 0)
2917 d = (driver_instance *)auths;
2918 ol2 = optionlist_auths;
2919 size = optionlist_auths_size;
2922 else if (Ustrcmp(type, "macro") == 0)
2924 /* People store passwords in macros and they were previously not available
2925 for printing. So we have an admin_users restriction. */
2928 fprintf(stderr, "exim: permission denied\n");
2931 for (macro_item * m = macros; m; m = m->next)
2932 if (!name || Ustrcmp(name, m->name) == 0)
2935 printf("%s\n", CS m->name);
2937 printf("%s\n", CS m->replacement);
2939 printf("%s=%s\n", CS m->name, CS m->replacement);
2943 if (!name) return TRUE;
2945 printf("%s %s not found\n", type, name);
2951 for (; d; d = d->next) printf("%s\n", CS d->name);
2955 /* Either search for a given driver, or print all of them */
2957 for (; d; d = d->next)
2961 printf("\n%s %s:\n", d->name, type);
2962 else if (Ustrcmp(d->name, name) != 0) continue;
2964 for (optionlist * ol = ol2; ol < ol2 + size; ol++)
2965 if (!(ol->type & opt_hidden))
2966 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2968 for (optionlist * ol = d->info->options;
2969 ol < d->info->options + *(d->info->options_count); ol++)
2970 if (!(ol->type & opt_hidden))
2971 rc |= print_ol(ol, US ol->name, d, d->info->options,
2972 *d->info->options_count, no_labels);
2974 if (name) return rc;
2976 if (!name) return TRUE;
2978 printf("%s %s not found\n", type, name);
2984 /*************************************************
2985 * Read a named list item *
2986 *************************************************/
2988 /* This function reads a name and a list (i.e. string). The name is used to
2989 save the list in a tree, sorted by its name. Each entry also has a number,
2990 which can be used for caching tests, but if the string contains any expansion
2991 items other than $key, the number is set negative to inhibit caching. This
2992 mechanism is used for domain, host, and address lists that are referenced by
2996 anchorp points to the tree anchor
2997 numberp points to the current number for this tree
2998 max the maximum number permitted
2999 s the text of the option line, starting immediately after the name
3001 tname the name of the list type, for messages
3002 hide do not output value on "-bP"
3008 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
3009 uschar *tname, BOOL hide)
3011 BOOL forcecache = FALSE;
3014 namedlist_block * nb = store_get_perm(sizeof(namedlist_block), FALSE);
3016 if (Ustrncmp(s, "_cache", 6) == 0)
3023 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
3025 if (*numberp >= max)
3026 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3029 Uskip_whitespace(&s);
3031 while (isalnum(*s) || *s == '_') s++;
3032 t = store_get(sizeof(tree_node) + s-ss, is_tainted(ss));
3033 Ustrncpy(t->name, ss, s-ss);
3035 Uskip_whitespace(&s);
3037 if (!tree_insertnode(anchorp, t))
3038 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3039 "duplicate name \"%s\" for a named %s", t->name, tname);
3042 nb->number = *numberp;
3046 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3047 "missing '=' after \"%s\"", t->name);
3048 Uskip_whitespace(&s);
3049 nb->string = read_string(s, t->name);
3050 nb->cache_data = NULL;
3052 /* Check the string for any expansions; if any are found, mark this list
3053 uncacheable unless the user has explicited forced caching. */
3055 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3061 /*************************************************
3062 * Unpick data for a rate limit *
3063 *************************************************/
3065 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3069 s string, in the form t,b,f,l
3070 where t is the threshold (integer)
3071 b is the initial delay (time)
3072 f is the multiplicative factor (fixed point)
3073 k is the maximum time (time)
3074 threshold where to store threshold
3075 base where to store base in milliseconds
3076 factor where to store factor in milliseconds
3077 limit where to store limit
3079 Returns: nothing (panics on error)
3083 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3086 uschar bstring[16], lstring[16];
3088 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3089 factor, lstring) == 4)
3091 *base = readconf_readtime(bstring, 0, TRUE);
3092 *limit = readconf_readtime(lstring, 0, TRUE);
3093 if (*base >= 0 && *limit >= 0) return;
3095 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3101 /*************************************************
3102 * Read main configuration options *
3103 *************************************************/
3105 /* This function is the first to be called for configuration reading. It
3106 opens the configuration file and reads general configuration settings until
3107 it reaches the end of the configuration section. The file is then left open so
3108 that the remaining configuration data can subsequently be read if needed for
3111 The configuration file must be owned either by root or exim, and be writeable
3112 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3113 in the config file, so the test is done on the compiled in values. A slight
3114 anomaly, to be carefully documented.
3116 The name of the configuration file is taken from a list that is included in the
3117 binary of Exim. It can be altered from the command line, but if that is done,
3118 root privilege is immediately withdrawn unless the caller is root or exim.
3119 The first file on the list that exists is used.
3121 For use on multiple systems that share file systems, first look for a
3122 configuration file whose name has the current node name on the end. If that is
3123 not found, try the generic name. For really contorted configurations, that run
3124 multiple Exims with different uid settings, first try adding the effective uid
3125 before the node name. These complications are going to waste resources on most
3126 systems. Therefore they are available only when requested by compile-time
3130 readconf_main(BOOL nowarn)
3133 struct stat statbuf;
3134 uschar *s, *filename;
3135 const uschar *list = config_main_filelist;
3137 /* Loop through the possible file names */
3139 /* Should never be a tainted list */
3140 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3143 /* Cut out all the fancy processing unless specifically wanted */
3145 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3146 uschar *suffix = filename + Ustrlen(filename);
3148 /* Try for the node-specific file if a node name exists */
3150 # ifdef CONFIGURE_FILE_USE_NODE
3152 if (uname(&uts) >= 0)
3154 # ifdef CONFIGURE_FILE_USE_EUID
3155 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3156 if (!(config_file = Ufopen(filename, "rb")))
3157 # endif /* CONFIGURE_FILE_USE_EUID */
3159 sprintf(CS suffix, ".%.256s", uts.nodename);
3160 config_file = Ufopen(filename, "rb");
3163 # endif /* CONFIGURE_FILE_USE_NODE */
3165 /* Otherwise, try the generic name, possibly with the euid added */
3167 # ifdef CONFIGURE_FILE_USE_EUID
3170 sprintf(CS suffix, ".%ld", (long int)original_euid);
3171 config_file = Ufopen(filename, "rb");
3173 # endif /* CONFIGURE_FILE_USE_EUID */
3175 /* Finally, try the unadorned name */
3180 config_file = Ufopen(filename, "rb");
3182 #else /* if neither defined */
3184 /* This is the common case when the fancy processing is not included. */
3186 config_file = Ufopen(filename, "rb");
3189 /* If the file does not exist, continue to try any others. For any other
3190 error, break out (and die). */
3192 if (config_file || errno != ENOENT) break;
3195 /* On success, save the name for verification; config_filename is used when
3196 logging configuration errors (it changes for .included files) whereas
3197 config_main_filename is the name shown by -bP. Failure to open a configuration
3198 file is a serious disaster. */
3202 uschar *last_slash = Ustrrchr(filename, '/');
3203 config_filename = config_main_filename = string_copy(filename);
3205 /* The config_main_directory we need for the $config_dir expansion.
3206 config_main_filename we need for $config_file expansion.
3207 And config_dir is the directory of the current configuration, used for
3208 relative .includes. We do need to know it's name, as we change our working
3211 if (filename[0] == '/')
3212 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3215 /* relative configuration file name: working dir + / + basename(filename) */
3217 uschar buf[PATH_MAX];
3220 if (os_getcwd(buf, PATH_MAX) == NULL)
3222 perror("exim: getcwd");
3225 g = string_cat(NULL, buf);
3227 /* If the dir does not end with a "/", append one */
3228 if (g->s[g->ptr-1] != '/')
3229 g = string_catn(g, US"/", 1);
3231 /* If the config file contains a "/", extract the directory part */
3233 g = string_catn(g, filename, last_slash - filename);
3235 config_main_directory = string_from_gstring(g);
3237 config_directory = config_main_directory;
3241 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3242 "%s", config_main_filelist);
3244 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
3245 string_open_failed("configuration file %s", filename));
3247 /* Now, once we found and opened our configuration file, we change the directory
3248 to a safe place. Later we change to $spool_directory. */
3250 if (Uchdir("/") < 0)
3252 perror("exim: chdir `/': ");
3256 /* Check the status of the file we have opened, if we have retained root
3257 privileges and the file isn't /dev/null (which *should* be 0666). */
3259 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3261 if (fstat(fileno(config_file), &statbuf) != 0)
3262 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3265 if ( statbuf.st_uid != root_uid /* owner not root */
3266 #ifdef CONFIGURE_OWNER
3267 && statbuf.st_uid != config_uid /* owner not the special one */
3270 statbuf.st_gid != root_gid /* group not root & */
3271 #ifdef CONFIGURE_GROUP
3272 && statbuf.st_gid != config_gid /* group not the special one */
3274 && (statbuf.st_mode & 020) != 0 /* group writeable */
3276 (statbuf.st_mode & 2) != 0 /* world writeable */
3278 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3279 "wrong owner, group, or mode", big_buffer);
3281 /* Do a dummy store-allocation of a size related to the (toplevel) file size.
3282 This assumes we will need this much storage to handle all the allocations
3283 during startup; it won't help when .include is being used. When it does, it
3284 will cut down on the number of store blocks (and malloc calls, and sbrk
3285 syscalls). It also assume we're on the relevant pool. */
3287 if (statbuf.st_size > 8192)
3289 rmark r = store_mark();
3290 void * dummy = store_get((int)statbuf.st_size, FALSE);
3295 /* Process the main configuration settings. They all begin with a lower case
3296 letter. If we see something starting with an upper case letter, it is taken as
3297 a macro definition. */
3299 while ((s = get_config_line()))
3304 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3305 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3306 "found unexpected BOM (Byte Order Mark)");
3310 if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE);
3314 t = (hide = Ustrncmp(s, "hide", 4) == 0 && isspace(s[4])) ? s + 5 : s;
3316 if (Ustrncmp(t, "domainlist", 10) == 0)
3317 read_named_list(&domainlist_anchor, &domainlist_count,
3318 MAX_NAMED_LIST, t+10, US"domain list", hide);
3320 else if (Ustrncmp(t, "hostlist", 8) == 0)
3321 read_named_list(&hostlist_anchor, &hostlist_count,
3322 MAX_NAMED_LIST, t+8, US"host list", hide);
3324 else if (Ustrncmp(t, "addresslist", 11) == 0)
3325 read_named_list(&addresslist_anchor, &addresslist_count,
3326 MAX_NAMED_LIST, t+11, US"address list", hide);
3328 else if (Ustrncmp(t, "localpartlist", 13) == 0)
3329 read_named_list(&localpartlist_anchor, &localpartlist_count,
3330 MAX_NAMED_LIST, t+13, US"local part list", hide);
3333 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3334 NULL, US"main option \"%s\" unknown");
3338 /* If local_sender_retain is set, local_from_check must be unset. */
3340 if (local_sender_retain && local_from_check)
3341 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3342 "local_sender_retain are set; this combination is not allowed");
3344 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3347 if (timezone_string && !*timezone_string) timezone_string = NULL;
3349 /* The max retry interval must not be greater than 24 hours. */
3351 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3353 /* remote_max_parallel must be > 0 */
3355 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3357 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3358 start of a new SMTP message. */
3360 freeze_tell_config = freeze_tell;
3362 /* The primary host name may be required for expansion of spool_directory
3363 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3364 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3365 canonize it. Some people like upper case letters in their host names, so we
3366 don't force the case. */
3368 if (!primary_hostname)
3370 const uschar * hostname;
3373 if (uname(&uts) < 0)
3374 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3375 hostname = US uts.nodename;
3377 if (Ustrchr(hostname, '.') == NULL)
3380 struct hostent *hostdata;
3384 && ( !dns_ipv4_lookup
3385 || match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3386 MCL_DOMAIN, TRUE, NULL) != OK))
3393 # if HAVE_GETIPNODEBYNAME
3395 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3397 hostdata = gethostbyname2(CS hostname, af);
3400 hostdata = gethostbyname(CS hostname);
3404 { hostname = US hostdata->h_name; break; }
3406 if (af == AF_INET) break;
3411 primary_hostname = string_copy(hostname);
3414 /* Set up default value for smtp_active_hostname */
3416 smtp_active_hostname = primary_hostname;
3418 /* If spool_directory wasn't set in the build-time configuration, it must have
3419 got set above. Of course, writing to the log may not work if log_file_path is
3420 not set, but it will at least get to syslog or somewhere, with any luck. */
3422 if (!*spool_directory)
3423 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3426 /* Expand the spool directory name; it may, for example, contain the primary
3427 host name. Same comment about failure. */
3429 if (!(s = expand_string(spool_directory)))
3430 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3431 "\"%s\": %s", spool_directory, expand_string_message);
3432 spool_directory = s;
3434 /* Expand log_file_path, which must contain "%s" in any component that isn't
3435 the null string or "syslog". It is also allowed to contain one instance of %D
3436 or %M. However, it must NOT contain % followed by anything else. */
3440 const uschar *ss, *sss;
3441 int sep = ':'; /* Fixed for log file path */
3442 if (!(s = expand_string(log_file_path)))
3443 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3444 "\"%s\": %s", log_file_path, expand_string_message);
3447 /* should never be a tainted list */
3448 while ((sss = string_nextinlist(&ss, &sep, big_buffer, big_buffer_size)))
3451 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3452 if (!(t = Ustrstr(sss, "%s")))
3453 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3454 "contain \"%%s\"", sss);
3456 if ((t = Ustrchr(sss, '%')))
3457 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3458 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3459 "unexpected \"%%\" character", s);
3465 /* Interpret syslog_facility into an integer argument for 'ident' param to
3466 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3469 if (syslog_facility_str)
3472 uschar *s = syslog_facility_str;
3474 if ((Ustrlen(syslog_facility_str) >= 4) &&
3475 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3478 for (i = 0; i < syslog_list_size; i++)
3479 if (strcmpic(s, syslog_list[i].name) == 0)
3481 syslog_facility = syslog_list[i].value;
3485 if (i >= syslog_list_size)
3486 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3487 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3490 /* Expand pid_file_path */
3494 if (!(s = expand_string(pid_file_path)))
3495 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3496 "\"%s\": %s", pid_file_path, expand_string_message);
3500 /* Set default value of process_log_path */
3502 if (!process_log_path || !*process_log_path)
3503 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3505 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3508 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3510 /* Unpick the SMTP rate limiting options, if set */
3512 if (smtp_ratelimit_mail)
3513 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3514 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3516 if (smtp_ratelimit_rcpt)
3517 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3518 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3520 /* The qualify domains default to the primary host name */
3522 if (!qualify_domain_sender)
3523 qualify_domain_sender = primary_hostname;
3524 if (!qualify_domain_recipient)
3525 qualify_domain_recipient = qualify_domain_sender;
3527 /* Setting system_filter_user in the configuration sets the gid as well if a
3528 name is given, but a numerical value does not. */
3530 if (system_filter_uid_set && !system_filter_gid_set)
3532 struct passwd *pw = getpwuid(system_filter_uid);
3534 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3535 (long int)system_filter_uid);
3536 system_filter_gid = pw->pw_gid;
3537 system_filter_gid_set = TRUE;
3540 /* If the errors_reply_to field is set, check that it is syntactically valid
3541 and ensure it contains a domain. */
3543 if (errors_reply_to)
3546 int start, end, domain;
3547 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3548 &start, &end, &domain, FALSE);
3551 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3552 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3555 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3556 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3559 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3560 smtp_accept_max must also be set. */
3562 if (smtp_accept_max == 0 && (smtp_accept_queue > 0 || smtp_accept_max_per_host))
3563 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3564 "smtp_accept_max must be set if smtp_accept_queue or "
3565 "smtp_accept_max_per_host is set");
3567 /* Set up the host number if anything is specified. It is an expanded string
3568 so that it can be computed from the host name, for example. We do this last
3569 so as to ensure that everything else is set up before the expansion. */
3571 if (host_number_string)
3575 uschar *s = expand_string(host_number_string);
3578 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3579 "failed to expand localhost_number \"%s\": %s",
3580 host_number_string, expand_string_message);
3581 n = Ustrtol(s, &end, 0);
3582 while (isspace(*end)) end++;
3584 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3585 "localhost_number value is not a number: %s", s);
3586 if (n > LOCALHOST_MAX)
3587 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3588 "localhost_number is greater than the maximum allowed value (%d)",
3594 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3596 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3597 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3598 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3599 tls_verify_hosts ? "" : "try_");
3601 /* Magic number: at time of writing, 1024 has been the long-standing value
3602 used by so many clients, and what Exim used to use always, that it makes
3603 sense to just min-clamp this max-clamp at that. */
3604 if (tls_dh_max_bits < 1024)
3605 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3606 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3608 /* If openssl_options is set, validate it */
3609 if (openssl_options)
3612 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3613 "openssl_options is set but we're using GnuTLS");
3616 if (!tls_openssl_options_parse(openssl_options, &dummy))
3617 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3618 "openssl_options parse error: %s", openssl_options);
3621 #endif /*DISABLE_TLS*/
3623 if (!nowarn && !keep_environment && environ && *environ)
3624 log_write(0, LOG_MAIN,
3625 "Warning: purging the environment.\n"
3626 " Suggested action: use keep_environment.");
3631 /*************************************************
3632 * Initialize one driver *
3633 *************************************************/
3635 /* This is called once the driver's generic options, if any, have been read.
3636 We can now find the driver, set up defaults for the private options, and
3637 unset any "set" bits in the private options table (which might have been
3638 set by another incarnation of the same driver).
3641 d pointer to driver instance block, with generic
3643 drivers_available vector of available drivers
3644 size_of_info size of each block in drivers_available
3645 class class of driver, for error message
3647 Returns: pointer to the driver info block
3650 static driver_info *
3651 init_driver(driver_instance *d, driver_info *drivers_available,
3652 int size_of_info, uschar *class)
3654 for (driver_info * dd = drivers_available; dd->driver_name[0] != 0;
3655 dd = (driver_info *)((US dd) + size_of_info))
3656 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3658 int len = dd->options_len;
3660 d->options_block = store_get_perm(len, FALSE);
3661 memcpy(d->options_block, dd->options_block, len);
3662 for (int i = 0; i < *(dd->options_count); i++)
3663 dd->options[i].type &= ~opt_set;
3667 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3668 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3670 return NULL; /* never obeyed */
3677 driver_init_fini(driver_instance * d, const uschar * class)
3679 if (!d->driver_name)
3680 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3681 "no driver defined for %s \"%s\"", class, d->name);
3686 /*************************************************
3687 * Initialize driver list *
3688 *************************************************/
3690 /* This function is called for routers, transports, and authentication
3691 mechanisms. It reads the data from the current point in the configuration file
3692 up to the end of the section, and sets up a chain of instance blocks according
3693 to the file's contents. The file will already have been opened by a call to
3694 readconf_main, and must be left open for subsequent reading of further data.
3696 Any errors cause a panic crash. Note that the blocks with names driver_info and
3697 driver_instance must map the first portions of all the _info and _instance
3698 blocks for this shared code to work.
3701 class "router", "transport", or "authenticator"
3702 anchor &routers, &transports, &auths
3703 drivers_available available drivers
3704 size_of_info size of each info block
3705 instance_default points to default data for an instance
3706 instance_size size of instance block
3707 driver_optionlist generic option list
3708 driver_optionlist_count count of generic option list
3714 readconf_driver_init(
3716 driver_instance **anchor,
3717 driver_info *drivers_available,
3719 void *instance_default,
3721 optionlist *driver_optionlist,
3722 int driver_optionlist_count)
3724 driver_instance **p = anchor;
3725 driver_instance *d = NULL;
3728 while ((buffer = get_config_line()))
3730 uschar name[EXIM_DRIVERNAME_MAX];
3733 /* Read the first name on the line and test for the start of a new driver. A
3734 macro definition indicates the end of the previous driver. If this isn't the
3735 start of a new driver, the line will be re-read. */
3737 s = readconf_readname(name, sizeof(name), buffer);
3739 /* Handle macro definition, first finishing off the initialization of the
3740 previous driver, if any. */
3742 if (isupper(*name) && *s == '=')
3746 /* s is using big_buffer, so this call had better not */
3747 driver_init_fini(d, class);
3750 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE);
3754 /* If the line starts with a name terminated by a colon, we are at the
3755 start of the definition of a new driver. The rest of the line must be
3760 /* Finish off initializing the previous driver. */
3763 driver_init_fini(d, class);
3765 /* Check that we haven't already got a driver of this name */
3767 for (d = *anchor; d; d = d->next)
3768 if (Ustrcmp(name, d->name) == 0)
3769 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3770 "there are two %ss called \"%s\"", class, name);
3772 /* Set up a new driver instance data block on the chain, with
3773 its default values installed. */
3775 d = store_get_perm(instance_size, FALSE);
3776 memcpy(d, instance_default, instance_size);
3779 d->name = string_copy(name);
3781 /* Clear out the "set" bits in the generic options */
3783 for (int i = 0; i < driver_optionlist_count; i++)
3784 driver_optionlist[i].type &= ~opt_set;
3786 /* Check nothing more on this line, then do the next loop iteration. */
3788 Uskip_whitespace(&s);
3789 if (*s) extra_chars_error(s, US"driver name ", name, US"");
3793 /* Not the start of a new driver. Give an error if we have not set up a
3794 current driver yet. */
3797 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3799 /* First look to see if this is a generic option; if it is "driver",
3800 initialize the driver. If is it not a generic option, we can look for a
3801 private option provided that the driver has been previously set up. */
3803 if (readconf_handle_option(buffer, driver_optionlist,
3804 driver_optionlist_count, d, NULL))
3806 if (!d->info && d->driver_name)
3807 init_driver(d, drivers_available, size_of_info, class);
3810 /* Handle private options - pass the generic block because some may
3811 live therein. A flag with each option indicates if it is in the public
3815 readconf_handle_option(buffer, d->info->options,
3816 *(d->info->options_count), d, US"option \"%s\" unknown");
3818 /* The option is not generic and the driver name has not yet been given. */
3820 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3821 "(\"driver\" must be specified before any private options)", name);
3824 /* Run the initialization function for the final driver. */
3827 driver_init_fini(d, class);
3832 /*************************************************
3833 * Check driver dependency *
3834 *************************************************/
3836 /* This function is passed a driver instance and a string. It checks whether
3837 any of the string options for the driver contains the given string as an
3841 d points to a driver instance block
3842 s the string to search for
3844 Returns: TRUE if a dependency is found
3848 readconf_depends(driver_instance *d, uschar *s)
3850 int count = *(d->info->options_count);
3853 for (optionlist * ol = d->info->options; ol < d->info->options + count; ol++)
3854 if ((ol->type & opt_mask) == opt_stringptr)
3856 void * options_block = ol->type & opt_public ? (void *)d : d->options_block;
3857 uschar * value = *USS(US options_block + ol->v.offset);
3859 if (value && (ss = Ustrstr(value, s)) != NULL)
3861 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3862 isalnum(ss[Ustrlen(s)])) continue;
3863 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3864 d->name, ol->name, s);
3869 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3876 /*************************************************
3877 * Decode an error type for retries *
3878 *************************************************/
3880 /* This function is global because it is also called from the main
3881 program when testing retry information. It decodes strings such as "quota_7d"
3882 into numerical error codes.
3885 pp points to start of text
3886 p points past end of text
3887 basic_errno points to an int to receive the main error number
3888 more_errno points to an int to receive the secondary error data
3890 Returns: NULL if decoded correctly; else points to error text
3894 readconf_retry_error(const uschar *pp, const uschar *p,
3895 int *basic_errno, int *more_errno)
3898 const uschar *q = pp;
3899 while (q < p && *q != '_') q++;
3902 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3904 *basic_errno = ERRNO_EXIMQUOTA;
3905 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3906 return US"bad time value";
3909 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3911 *basic_errno = ECONNREFUSED;
3914 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3915 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3916 else return US"A or MX expected after \"refused\"";
3920 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3922 *basic_errno = ETIMEDOUT;
3926 int xlen = p - q - 1;
3927 const uschar *x = q + 1;
3929 static uschar *extras[] =
3930 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3931 static int values[] =
3932 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3934 for (i = 0; i < nelem(extras); i++)
3935 if (strncmpic(x, extras[i], xlen) == 0)
3937 *more_errno = values[i];
3941 if (i >= nelem(extras))
3942 if (strncmpic(x, US"DNS", xlen) == 0)
3943 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3944 "available in retry rules (it has never worked) - treated as "
3947 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3951 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3952 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3953 strncmpic(pp, US"data_4", 6) == 0)
3956 int x = 255; /* means "any 4xx code" */
3957 if (p != pp + 8) bad = TRUE; else
3959 int a = pp[6], b = pp[7];
3963 if (isdigit(b)) x += b - '0';
3964 else if (b == 'x') x += 100;
3967 else if (a != 'x' || b != 'x') bad = TRUE;
3971 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3972 "x is literal and d is any digit", pp);
3974 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3975 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3976 *more_errno = x << 8;
3979 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3980 strncmpic(q+1, US"failed", p-q-1) == 0)
3981 *basic_errno = ERRNO_AUTHFAIL;
3983 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3984 *basic_errno = ERRNO_SMTPCLOSED;
3986 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3987 *basic_errno = ERRNO_TLSREQUIRED;
3989 else if (strncmpic(pp, US"lookup", p - pp) == 0)
3990 *basic_errno = ERRNO_UNKNOWNHOST;
3992 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3993 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4001 /*************************************************
4002 * Read retry information *
4003 *************************************************/
4005 /* Each line of retry information contains:
4007 . A domain name pattern or an address pattern;
4009 . An error name, possibly with additional data, or *;
4011 . An optional sequence of retry items, each consisting of an identifying
4012 letter, a cutoff time, and optional parameters.
4014 All this is decoded and placed into a control block. */
4017 /* Subroutine to read an argument, preceded by a comma and terminated
4018 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4019 1 = fixed point number (returned *1000).
4022 paddr pointer to pointer to current character; updated
4023 type 0 => read a time; 1 => read a fixed point number
4025 Returns: time in seconds or fixed point number * 1000
4029 retry_arg(const uschar **paddr, int type)
4031 const uschar *p = *paddr;
4034 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4036 Uskip_whitespace(&p);
4038 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4040 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4041 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4046 case 0: return readconf_readtime(pp, *p, FALSE);
4047 case 1: return readconf_readfixed(pp, *p);
4049 return 0; /* Keep picky compilers happy */
4052 /* The function proper */
4055 readconf_retries(void)
4057 retry_config **chain = &retries;
4061 while ((p = get_config_line()))
4063 retry_rule **rchain;
4067 next = store_get(sizeof(retry_config), FALSE);
4070 chain = &(next->next);
4071 next->basic_errno = next->more_errno = 0;
4072 next->senders = NULL;
4074 rchain = &(next->rules);
4076 next->pattern = string_dequote(&p);
4077 Uskip_whitespace(&p);
4079 while (mac_isgraph(*p)) p++;
4080 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4081 "missing error type in retry rule");
4083 /* Test error names for things we understand. */
4085 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4086 &next->more_errno)))
4087 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4089 /* There may be an optional address list of senders to be used as another
4090 constraint on the rule. This was added later, so the syntax is a bit of a
4091 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4094 Uskip_whitespace(&p);
4095 if (Ustrncmp(p, "senders", 7) == 0)
4098 Uskip_whitespace(&p);
4099 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4100 "\"=\" expected after \"senders\" in retry rule");
4101 Uskip_whitespace(&p);
4102 next->senders = string_dequote(&p);
4105 /* Now the retry rules. Keep the maximum timeout encountered. */
4107 Uskip_whitespace(&p);
4111 retry_rule *rule = store_get(sizeof(retry_rule), FALSE);
4113 rchain = &(rule->next);
4115 rule->rule = toupper(*p++);
4116 rule->timeout = retry_arg(&p, 0);
4117 if (rule->timeout > retry_maximum_timeout)
4118 retry_maximum_timeout = rule->timeout;
4122 case 'F': /* Fixed interval */
4123 rule->p1 = retry_arg(&p, 0);
4126 case 'G': /* Geometrically increasing intervals */
4127 case 'H': /* Ditto, but with randomness */
4128 rule->p1 = retry_arg(&p, 0);
4129 rule->p2 = retry_arg(&p, 1);
4133 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4137 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4138 (rule->rule != 'F' && rule->p2 < 1000))
4139 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4140 "bad parameters for retry rule");
4142 if (Uskip_whitespace(&p) == ';')
4145 Uskip_whitespace(&p);
4148 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4155 /*************************************************
4156 * Initialize authenticators *
4157 *************************************************/
4159 /* Read the authenticators section of the configuration file.
4168 #ifndef DISABLE_PIPE_CONNECT
4172 readconf_driver_init(US"authenticator",
4173 (driver_instance **)(&auths), /* chain anchor */
4174 (driver_info *)auths_available, /* available drivers */
4175 sizeof(auth_info), /* size of info block */
4176 &auth_defaults, /* default values for generic options */
4177 sizeof(auth_instance), /* size of instance block */
4178 optionlist_auths, /* generic options */
4179 optionlist_auths_size);
4181 for (auth_instance * au = auths; au; au = au->next)
4183 if (!au->public_name)
4184 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4185 "the %s authenticator", au->name);
4187 for (auth_instance * bu = au->next; bu; bu = bu->next)
4188 if (strcmpic(au->public_name, bu->public_name) == 0)
4189 if ((au->client && bu->client) || (au->server && bu->server))
4190 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4191 "(%s and %s) have the same public name (%s)",
4192 au->client ? US"client" : US"server", au->name, bu->name,
4194 #ifndef DISABLE_PIPE_CONNECT
4198 #ifndef DISABLE_PIPE_CONNECT
4199 f.smtp_in_early_pipe_no_auth = nauths > 16;
4206 /*************************************************
4207 * Read ACL information *
4208 *************************************************/
4210 /* If this run of Exim is not doing something that involves receiving a
4211 message, we can just skip over the ACL information. No need to parse it.
4213 First, we have a function for acl_read() to call back to get the next line. We
4214 need to remember the line we passed, because at the end it will contain the
4215 name of the next ACL. */
4217 static uschar *acl_line;
4222 acl_line = get_config_line();
4227 /* Now the main function:
4238 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4241 acl_line = get_config_line();
4245 uschar name[EXIM_DRIVERNAME_MAX];
4249 p = readconf_readname(name, sizeof(name), acl_line);
4250 if (isupper(*name) && *p == '=')
4252 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE);
4253 acl_line = get_config_line();
4257 if (*p != ':' || name[0] == 0)
4258 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4260 node = store_get_perm(sizeof(tree_node) + Ustrlen(name), is_tainted(name));
4261 Ustrcpy(node->name, name);
4262 if (!tree_insertnode(&acl_anchor, node))
4263 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4264 "there are two ACLs called \"%s\"", name);
4266 node->data.ptr = acl_read(acl_callback, &error);
4268 if (node->data.ptr == NULL && error != NULL)
4269 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4275 /*************************************************
4276 * Read configuration for local_scan() *
4277 *************************************************/
4279 /* This function is called after "begin local_scan" is encountered in the
4280 configuration file. If the local_scan() function allows for configuration
4281 options, we can process them. Otherwise, we expire in a panic.
4288 local_scan_init(void)
4290 #ifndef LOCAL_SCAN_HAS_OPTIONS
4291 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4292 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4296 while ((p = get_config_line()))
4297 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4298 NULL, US"local_scan option \"%s\" unknown");
4304 /*************************************************
4305 * Read rest of configuration (after main) *
4306 *************************************************/
4308 /* This function reads the rest of the runtime configuration, after the main
4309 configuration. It is called only when actually needed. Each subsequent section
4310 of the configuration starts with a line of the form
4314 where the name is "routers", "transports", etc. A section is terminated by
4315 hitting the next "begin" line, and the next name is left in next_section.
4316 Because it may confuse people as to whether the names are singular or plural,
4317 we add "s" if it's missing. There is always enough room in next_section for
4318 this. This function is basically just a switch.
4324 static uschar *section_list[] = {
4338 while(next_section[0] != 0)
4342 int last = nelem(section_list);
4344 int n = Ustrlen(next_section);
4346 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, US"s");
4350 int c = strcmpic(next_section, section_list[mid]);
4352 if (c > 0) first = mid + 1; else last = mid;
4354 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4355 "\"%.*s\" is not a known configuration section name", n, next_section);
4356 mid = (last + first)/2;
4360 if (((had ^= bit) & bit) == 0)
4361 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4362 "\"%.*s\" section is repeated in the configuration file", n,
4367 case 0: readconf_acl(); break;
4368 case 1: auths_init(); break;
4369 case 2: local_scan_init(); break;
4370 case 3: readconf_retries(); break;
4371 case 4: readconf_rewrites(); break;
4372 case 5: route_init(); break;
4373 case 6: transport_init(); break;
4377 (void)fclose(config_file);
4380 /* Init the storage for the pre-parsed config lines */
4382 readconf_save_config(const uschar *s)
4384 save_config_line(string_sprintf("# Exim Configuration (%s)",
4385 f.running_in_test_harness ? US"X" : s));
4389 save_config_position(const uschar *file, int line)
4391 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4394 /* Append a pre-parsed logical line to the config lines store,
4395 this operates on a global (static) list that holds all the pre-parsed
4396 config lines, we do no further processing here, output formatting and
4397 honouring of <hide> or macros will be done during output */
4400 save_config_line(const uschar* line)
4402 static config_line_item *current;
4403 config_line_item *next;
4405 next = (config_line_item*) store_get(sizeof(config_line_item), FALSE);
4406 next->line = string_copy(line);
4409 if (!config_lines) config_lines = next;
4410 else current->next = next;
4415 /* List the parsed config lines, care about nice formatting and
4416 hide the <hide> values unless we're the admin user */
4418 print_config(BOOL admin, BOOL terse)
4420 const int TS = terse ? 0 : 2;
4424 for (const config_line_item * i = config_lines; i; i = i->next)
4426 uschar * current, * p;
4428 if (r) store_reset(r);
4431 /* skip over to the first non-space */
4432 for (current = string_copy(i->line); *current && isspace(*current); ++current)
4438 /* Collapse runs of spaces. We stop this if we encounter one of the
4439 following characters: "'$, as this may indicate careful formatting */
4441 for (p = current; *p; p++) if (isspace(*p))
4444 if (*p != ' ') *p = ' ';
4446 for (next = p; isspace(*next); ++next)
4450 memmove(p+1, next, Ustrlen(next)+1);
4452 if (*next == '"' || *next == '\'' || *next == '$')
4457 if (current[0] == '#')
4460 /* begin lines are left aligned */
4461 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4463 if (!terse) puts("");
4468 /* router/acl/transport block names */
4469 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4471 if (!terse) puts("");
4472 printf("%*s%s\n", TS, "", current);
4476 /* hidden lines (all MACROS or lines prefixed with "hide") */
4478 && ( isupper(*current)
4479 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4483 if ((p = Ustrchr(current, '=')))
4486 printf("%*s%s= %s\n", indent, "", current, CCS hidden);
4488 /* e.g.: hide split_spool_directory */
4490 printf("%*s\n", indent, CCS hidden);
4494 /* rest is public */
4495 printf("%*s%s\n", indent, "", current);
4497 if (r) store_reset(r);
4500 #endif /*!MACRO_PREDEF*/
4503 /* End of readconf.c */