1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2024 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
10 /* Functions for reading the configuration file, and for displaying
11 overall configuration values. Thanks to Brian Candler for the original
12 implementation of the conditional .ifdef etc. */
17 # include "macro_predef.h"
20 #define READCONF_DEBUG if (FALSE) /* Change to TRUE to enable */
23 static uschar * syslog_facility_str;
24 static void fn_smtp_receive_timeout(const uschar *, const uschar *, unsigned);
26 /*************************************************
27 * Main configuration options *
28 *************************************************/
30 /* The list of options that can be set in the main configuration file. This
31 must be in alphabetic order because it is searched by binary chop. */
33 static optionlist optionlist_config[] = {
34 { "*set_exim_group", opt_bool|opt_hidden, {&exim_gid_set} },
35 { "*set_exim_user", opt_bool|opt_hidden, {&exim_uid_set} },
36 { "*set_system_filter_group", opt_bool|opt_hidden, {&system_filter_gid_set} },
37 { "*set_system_filter_user", opt_bool|opt_hidden, {&system_filter_uid_set} },
38 { "accept_8bitmime", opt_bool, {&accept_8bitmime} },
39 { "acl_not_smtp", opt_stringptr, {&acl_not_smtp} },
40 #ifdef WITH_CONTENT_SCAN
41 { "acl_not_smtp_mime", opt_stringptr, {&acl_not_smtp_mime} },
43 { "acl_not_smtp_start", opt_stringptr, {&acl_not_smtp_start} },
44 { "acl_smtp_auth", opt_stringptr, {&acl_smtp_auth} },
45 { "acl_smtp_connect", opt_stringptr, {&acl_smtp_connect} },
46 { "acl_smtp_data", opt_stringptr, {&acl_smtp_data} },
48 { "acl_smtp_data_prdr", opt_stringptr, {&acl_smtp_data_prdr} },
51 { "acl_smtp_dkim", opt_stringptr, {&acl_smtp_dkim} },
53 { "acl_smtp_etrn", opt_stringptr, {&acl_smtp_etrn} },
54 { "acl_smtp_expn", opt_stringptr, {&acl_smtp_expn} },
55 { "acl_smtp_helo", opt_stringptr, {&acl_smtp_helo} },
56 { "acl_smtp_mail", opt_stringptr, {&acl_smtp_mail} },
57 { "acl_smtp_mailauth", opt_stringptr, {&acl_smtp_mailauth} },
58 #ifdef WITH_CONTENT_SCAN
59 { "acl_smtp_mime", opt_stringptr, {&acl_smtp_mime} },
61 { "acl_smtp_notquit", opt_stringptr, {&acl_smtp_notquit} },
62 { "acl_smtp_predata", opt_stringptr, {&acl_smtp_predata} },
63 { "acl_smtp_quit", opt_stringptr, {&acl_smtp_quit} },
64 { "acl_smtp_rcpt", opt_stringptr, {&acl_smtp_rcpt} },
66 { "acl_smtp_starttls", opt_stringptr, {&acl_smtp_starttls} },
68 { "acl_smtp_vrfy", opt_stringptr, {&acl_smtp_vrfy} },
69 #ifndef DISABLE_WELLKNOWN
70 { "acl_smtp_wellknown", opt_stringptr, {&acl_smtp_wellknown} },
72 { "add_environment", opt_stringptr, {&add_environment} },
73 { "admin_groups", opt_gidlist, {&admin_groups} },
74 { "allow_domain_literals", opt_bool, {&allow_domain_literals} },
75 { "allow_mx_to_ip", opt_bool, {&allow_mx_to_ip} },
76 { "allow_utf8_domains", opt_bool, {&allow_utf8_domains} },
77 { "auth_advertise_hosts", opt_stringptr, {&auth_advertise_hosts} },
78 { "auto_thaw", opt_time, {&auto_thaw} },
79 #ifdef WITH_CONTENT_SCAN
80 { "av_scanner", opt_stringptr, {&av_scanner} },
82 { "bi_command", opt_stringptr, {&bi_command} },
83 #ifdef EXPERIMENTAL_BRIGHTMAIL
84 { "bmi_config_file", opt_stringptr, {&bmi_config_file} },
86 { "bounce_message_file", opt_stringptr, {&bounce_message_file} },
87 { "bounce_message_text", opt_stringptr, {&bounce_message_text} },
88 { "bounce_return_body", opt_bool, {&bounce_return_body} },
89 { "bounce_return_linesize_limit", opt_mkint, {&bounce_return_linesize_limit} },
90 { "bounce_return_message", opt_bool, {&bounce_return_message} },
91 { "bounce_return_size_limit", opt_mkint, {&bounce_return_size_limit} },
92 { "bounce_sender_authentication",opt_stringptr,{&bounce_sender_authentication} },
93 { "callout_domain_negative_expire", opt_time, {&callout_cache_domain_negative_expire} },
94 { "callout_domain_positive_expire", opt_time, {&callout_cache_domain_positive_expire} },
95 { "callout_negative_expire", opt_time, {&callout_cache_negative_expire} },
96 { "callout_positive_expire", opt_time, {&callout_cache_positive_expire} },
97 { "callout_random_local_part",opt_stringptr, {&callout_random_local_part} },
98 { "check_log_inodes", opt_int, {&check_log_inodes} },
99 { "check_log_space", opt_Kint, {&check_log_space} },
100 { "check_rfc2047_length", opt_bool, {&check_rfc2047_length} },
101 { "check_spool_inodes", opt_int, {&check_spool_inodes} },
102 { "check_spool_space", opt_Kint, {&check_spool_space} },
103 { "chunking_advertise_hosts", opt_stringptr, {&chunking_advertise_hosts} },
104 { "commandline_checks_require_admin", opt_bool,{&commandline_checks_require_admin} },
105 { "daemon_smtp_port", opt_stringptr|opt_hidden, {&daemon_smtp_port} },
106 { "daemon_smtp_ports", opt_stringptr, {&daemon_smtp_port} },
107 { "daemon_startup_retries", opt_int, {&daemon_startup_retries} },
108 { "daemon_startup_sleep", opt_time, {&daemon_startup_sleep} },
109 #ifdef EXPERIMENTAL_DCC
110 { "dcc_direct_add_header", opt_bool, {&dcc_direct_add_header} },
111 { "dccifd_address", opt_stringptr, {&dccifd_address} },
112 { "dccifd_options", opt_stringptr, {&dccifd_options} },
114 { "debug_store", opt_bool, {&debug_store} },
115 { "delay_warning", opt_timelist, {&delay_warning} },
116 { "delay_warning_condition", opt_stringptr, {&delay_warning_condition} },
117 { "deliver_drop_privilege", opt_bool, {&deliver_drop_privilege} },
118 { "deliver_queue_load_max", opt_fixed, {&deliver_queue_load_max} },
119 { "delivery_date_remove", opt_bool, {&delivery_date_remove} },
120 #ifdef ENABLE_DISABLE_FSYNC
121 { "disable_fsync", opt_bool, {&disable_fsync} },
123 { "disable_ipv6", opt_bool, {&disable_ipv6} },
125 { "dkim_verify_hashes", opt_stringptr, {&dkim_verify_hashes} },
126 { "dkim_verify_keytypes", opt_stringptr, {&dkim_verify_keytypes} },
127 { "dkim_verify_min_keysizes", opt_stringptr, {&dkim_verify_min_keysizes} },
128 { "dkim_verify_minimal", opt_bool, {&dkim_verify_minimal} },
129 { "dkim_verify_signers", opt_stringptr, {&dkim_verify_signers} },
132 { "dmarc_forensic_sender", opt_stringptr, {&dmarc_forensic_sender} },
133 { "dmarc_history_file", opt_stringptr, {&dmarc_history_file} },
134 { "dmarc_tld_file", opt_stringptr, {&dmarc_tld_file} },
136 { "dns_again_means_nonexist", opt_stringptr, {&dns_again_means_nonexist} },
137 { "dns_check_names_pattern", opt_stringptr, {&check_dns_names_pattern} },
138 { "dns_cname_loops", opt_int, {&dns_cname_loops} },
139 { "dns_csa_search_limit", opt_int, {&dns_csa_search_limit} },
140 { "dns_csa_use_reverse", opt_bool, {&dns_csa_use_reverse} },
141 { "dns_dnssec_ok", opt_int, {&dns_dnssec_ok} },
142 { "dns_ipv4_lookup", opt_stringptr, {&dns_ipv4_lookup} },
143 { "dns_retrans", opt_time, {&dns_retrans} },
144 { "dns_retry", opt_int, {&dns_retry} },
145 { "dns_trust_aa", opt_stringptr, {&dns_trust_aa} },
146 { "dns_use_edns0", opt_int, {&dns_use_edns0} },
147 /* This option is now a no-op, retained for compatibility */
148 { "drop_cr", opt_bool, {&drop_cr} },
149 /*********************************************************/
150 { "dsn_advertise_hosts", opt_stringptr, {&dsn_advertise_hosts} },
151 { "dsn_from", opt_stringptr, {&dsn_from} },
152 { "envelope_to_remove", opt_bool, {&envelope_to_remove} },
153 { "errors_copy", opt_stringptr, {&errors_copy} },
154 { "errors_reply_to", opt_stringptr, {&errors_reply_to} },
155 #ifndef DISABLE_EVENT
156 { "event_action", opt_stringptr, {&event_action} },
158 { "exim_group", opt_gid, {&exim_gid} },
159 { "exim_path", opt_stringptr, {&exim_path} },
160 { "exim_user", opt_uid, {&exim_uid} },
161 { "exim_version", opt_stringptr, {&version_string} },
162 { "extra_local_interfaces", opt_stringptr, {&extra_local_interfaces} },
163 { "extract_addresses_remove_arguments", opt_bool, {&extract_addresses_remove_arguments} },
164 { "finduser_retries", opt_int, {&finduser_retries} },
165 { "freeze_tell", opt_stringptr, {&freeze_tell} },
166 { "gecos_name", opt_stringptr, {&gecos_name} },
167 { "gecos_pattern", opt_stringptr, {&gecos_pattern} },
169 { "gnutls_allow_auto_pkcs11", opt_bool, {&gnutls_allow_auto_pkcs11} },
170 { "gnutls_compat_mode", opt_bool, {&gnutls_compat_mode} },
172 { "header_line_maxsize", opt_int, {&header_line_maxsize} },
173 { "header_maxsize", opt_int, {&header_maxsize} },
174 { "headers_charset", opt_stringptr, {&headers_charset} },
175 { "helo_accept_junk_hosts", opt_stringptr, {&helo_accept_junk_hosts} },
176 { "helo_allow_chars", opt_stringptr, {&helo_allow_chars} },
177 { "helo_lookup_domains", opt_stringptr, {&helo_lookup_domains} },
178 { "helo_try_verify_hosts", opt_stringptr, {&helo_try_verify_hosts} },
179 { "helo_verify_hosts", opt_stringptr, {&helo_verify_hosts} },
180 { "hold_domains", opt_stringptr, {&hold_domains} },
181 { "host_lookup", opt_stringptr, {&host_lookup} },
182 { "host_lookup_order", opt_stringptr, {&host_lookup_order} },
183 { "host_reject_connection", opt_stringptr, {&host_reject_connection} },
184 { "hosts_connection_nolog", opt_stringptr, {&hosts_connection_nolog} },
186 { "hosts_proxy", opt_stringptr, {&hosts_proxy} },
189 { "hosts_require_alpn", opt_stringptr, {&hosts_require_alpn} },
191 { "hosts_require_helo", opt_stringptr, {&hosts_require_helo} },
192 { "hosts_treat_as_local", opt_stringptr, {&hosts_treat_as_local} },
193 #ifdef EXPERIMENTAL_XCLIENT
194 { "hosts_xclient", opt_stringptr, {&hosts_xclient} },
197 { "ibase_servers", opt_stringptr, {&ibase_servers} },
199 { "ignore_bounce_errors_after", opt_time, {&ignore_bounce_errors_after} },
200 { "ignore_fromline_hosts", opt_stringptr, {&ignore_fromline_hosts} },
201 { "ignore_fromline_local", opt_bool, {&ignore_fromline_local} },
202 { "keep_environment", opt_stringptr, {&keep_environment} },
203 { "keep_malformed", opt_time, {&keep_malformed} },
205 { "ldap_ca_cert_dir", opt_stringptr, {&eldap_ca_cert_dir} },
206 { "ldap_ca_cert_file", opt_stringptr, {&eldap_ca_cert_file} },
207 { "ldap_cert_file", opt_stringptr, {&eldap_cert_file} },
208 { "ldap_cert_key", opt_stringptr, {&eldap_cert_key} },
209 { "ldap_cipher_suite", opt_stringptr, {&eldap_cipher_suite} },
210 { "ldap_default_servers", opt_stringptr, {&eldap_default_servers} },
211 { "ldap_require_cert", opt_stringptr, {&eldap_require_cert} },
212 { "ldap_start_tls", opt_bool, {&eldap_start_tls} },
213 { "ldap_version", opt_int, {&eldap_version} },
215 #ifndef DISABLE_ESMTP_LIMITS
216 { "limits_advertise_hosts", opt_stringptr, {&limits_advertise_hosts} },
218 { "local_from_check", opt_bool, {&local_from_check} },
219 { "local_from_prefix", opt_stringptr, {&local_from_prefix} },
220 { "local_from_suffix", opt_stringptr, {&local_from_suffix} },
221 { "local_interfaces", opt_stringptr, {&local_interfaces} },
222 #ifdef HAVE_LOCAL_SCAN
223 { "local_scan_timeout", opt_time, {&local_scan_timeout} },
225 { "local_sender_retain", opt_bool, {&local_sender_retain} },
226 { "localhost_number", opt_stringptr, {&host_number_string} },
227 { "log_file_path", opt_stringptr, {&log_file_path} },
228 { "log_selector", opt_stringptr, {&log_selector_string} },
229 { "log_timezone", opt_bool, {&log_timezone} },
230 { "lookup_open_max", opt_int, {&lookup_open_max} },
231 { "max_username_length", opt_int, {&max_username_length} },
232 { "message_body_newlines", opt_bool, {&message_body_newlines} },
233 { "message_body_visible", opt_mkint, {&message_body_visible} },
234 { "message_id_header_domain", opt_stringptr, {&message_id_domain} },
235 { "message_id_header_text", opt_stringptr, {&message_id_text} },
236 { "message_logs", opt_bool, {&message_logs} },
237 { "message_size_limit", opt_stringptr, {&message_size_limit} },
238 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
239 { "move_frozen_messages", opt_bool, {&move_frozen_messages} },
241 { "mua_wrapper", opt_bool, {&mua_wrapper} },
243 { "mysql_servers", opt_stringptr, {&mysql_servers} },
245 { "never_users", opt_uidlist, {&never_users} },
246 { "notifier_socket", opt_stringptr, {¬ifier_socket} },
248 { "openssl_options", opt_stringptr, {&openssl_options} },
251 { "oracle_servers", opt_stringptr, {&oracle_servers} },
253 { "panic_coredump", opt_bool, {&panic_coredump} },
254 { "percent_hack_domains", opt_stringptr, {&percent_hack_domains} },
256 { "perl_at_start", opt_bool, {&opt_perl_at_start} },
257 { "perl_startup", opt_stringptr, {&opt_perl_startup} },
258 { "perl_taintmode", opt_bool, {&opt_perl_taintmode} },
261 { "pgsql_servers", opt_stringptr, {&pgsql_servers} },
263 { "pid_file_path", opt_stringptr, {&pid_file_path} },
264 { "pipelining_advertise_hosts", opt_stringptr, {&pipelining_advertise_hosts} },
265 #ifndef DISABLE_PIPE_CONNECT
266 { "pipelining_connect_advertise_hosts", opt_stringptr,
267 {&pipe_connect_advertise_hosts} },
270 { "prdr_enable", opt_bool, {&prdr_enable} },
272 { "preserve_message_logs", opt_bool, {&preserve_message_logs} },
273 { "primary_hostname", opt_stringptr, {&primary_hostname} },
274 { "print_topbitchars", opt_bool, {&print_topbitchars} },
275 { "process_log_path", opt_stringptr, {&process_log_path} },
276 { "prod_requires_admin", opt_bool, {&prod_requires_admin} },
278 { "proxy_protocol_timeout", opt_time, {&proxy_protocol_timeout} },
280 { "qualify_domain", opt_stringptr, {&qualify_domain_sender} },
281 { "qualify_recipient", opt_stringptr, {&qualify_domain_recipient} },
282 { "queue_domains", opt_stringptr, {&queue_domains} },
283 #ifndef DISABLE_QUEUE_RAMP
284 { "queue_fast_ramp", opt_bool, {&queue_fast_ramp} },
286 { "queue_list_requires_admin",opt_bool, {&queue_list_requires_admin} },
287 { "queue_only", opt_bool, {&queue_only} },
288 { "queue_only_file", opt_stringptr, {&queue_only_file} },
289 { "queue_only_load", opt_fixed, {&queue_only_load} },
290 { "queue_only_load_latch", opt_bool, {&queue_only_load_latch} },
291 { "queue_only_override", opt_bool, {&queue_only_override} },
292 { "queue_run_in_order", opt_bool, {&queue_run_in_order} },
293 { "queue_run_max", opt_stringptr, {&queue_run_max} },
294 { "queue_smtp_domains", opt_stringptr, {&queue_smtp_domains} },
295 { "receive_timeout", opt_time, {&receive_timeout} },
296 { "received_header_text", opt_stringptr, {&received_header_text} },
297 { "received_headers_max", opt_int, {&received_headers_max} },
298 { "recipient_unqualified_hosts", opt_stringptr, {&recipient_unqualified_hosts} },
299 { "recipients_max", opt_stringptr, {&recipients_max} },
300 { "recipients_max_reject", opt_bool, {&recipients_max_reject} },
302 { "redis_servers", opt_stringptr, {&redis_servers} },
304 { "remote_max_parallel", opt_int, {&remote_max_parallel} },
305 { "remote_sort_domains", opt_stringptr, {&remote_sort_domains} },
306 { "retry_data_expire", opt_time, {&retry_data_expire} },
307 { "retry_interval_max", opt_time, {&retry_interval_max} },
308 { "return_path_remove", opt_bool, {&return_path_remove} },
309 { "return_size_limit", opt_mkint|opt_hidden, {&bounce_return_size_limit} },
310 { "rfc1413_hosts", opt_stringptr, {&rfc1413_hosts} },
311 { "rfc1413_query_timeout", opt_time, {&rfc1413_query_timeout} },
312 { "sender_unqualified_hosts", opt_stringptr, {&sender_unqualified_hosts} },
313 { "slow_lookup_log", opt_int, {&slow_lookup_log} },
314 { "smtp_accept_keepalive", opt_bool, {&smtp_accept_keepalive} },
315 { "smtp_accept_max", opt_int, {&smtp_accept_max} },
316 { "smtp_accept_max_nonmail", opt_int, {&smtp_accept_max_nonmail} },
317 { "smtp_accept_max_nonmail_hosts", opt_stringptr, {&smtp_accept_max_nonmail_hosts} },
318 { "smtp_accept_max_per_connection", opt_stringptr, {&smtp_accept_max_per_connection} },
319 { "smtp_accept_max_per_host", opt_stringptr, {&smtp_accept_max_per_host} },
320 { "smtp_accept_queue", opt_int, {&smtp_accept_queue} },
321 { "smtp_accept_queue_per_connection", opt_int, {&smtp_accept_queue_per_connection} },
322 { "smtp_accept_reserve", opt_int, {&smtp_accept_reserve} },
323 { "smtp_active_hostname", opt_stringptr, {&raw_active_hostname} },
324 { "smtp_backlog_monitor", opt_int, {&smtp_backlog_monitor} },
325 { "smtp_banner", opt_stringptr, {&smtp_banner} },
326 { "smtp_check_spool_space", opt_bool, {&smtp_check_spool_space} },
327 { "smtp_connect_backlog", opt_int, {&smtp_connect_backlog} },
328 { "smtp_enforce_sync", opt_bool, {&smtp_enforce_sync} },
329 { "smtp_etrn_command", opt_stringptr, {&smtp_etrn_command} },
330 { "smtp_etrn_serialize", opt_bool, {&smtp_etrn_serialize} },
331 { "smtp_load_reserve", opt_fixed, {&smtp_load_reserve} },
332 { "smtp_max_synprot_errors", opt_int, {&smtp_max_synprot_errors} },
333 { "smtp_max_unknown_commands",opt_int, {&smtp_max_unknown_commands} },
334 { "smtp_ratelimit_hosts", opt_stringptr, {&smtp_ratelimit_hosts} },
335 { "smtp_ratelimit_mail", opt_stringptr, {&smtp_ratelimit_mail} },
336 { "smtp_ratelimit_rcpt", opt_stringptr, {&smtp_ratelimit_rcpt} },
337 { "smtp_receive_timeout", opt_func, {.fn = &fn_smtp_receive_timeout} },
338 { "smtp_reserve_hosts", opt_stringptr, {&smtp_reserve_hosts} },
339 { "smtp_return_error_details",opt_bool, {&smtp_return_error_details} },
341 { "smtputf8_advertise_hosts", opt_stringptr, {&smtputf8_advertise_hosts} },
343 #ifdef WITH_CONTENT_SCAN
344 { "spamd_address", opt_stringptr, {&spamd_address} },
347 { "spf_guess", opt_stringptr, {&spf_guess} },
348 { "spf_smtp_comment_template",opt_stringptr, {&spf_smtp_comment_template} },
350 { "split_spool_directory", opt_bool, {&split_spool_directory} },
351 { "spool_directory", opt_stringptr, {&spool_directory} },
352 { "spool_wireformat", opt_bool, {&spool_wireformat} },
354 { "sqlite_dbfile", opt_stringptr, {&sqlite_dbfile} },
355 { "sqlite_lock_timeout", opt_int, {&sqlite_lock_timeout} },
357 { "strict_acl_vars", opt_bool, {&strict_acl_vars} },
358 { "strip_excess_angle_brackets", opt_bool, {&strip_excess_angle_brackets} },
359 { "strip_trailing_dot", opt_bool, {&strip_trailing_dot} },
360 { "syslog_duplication", opt_bool, {&syslog_duplication} },
361 { "syslog_facility", opt_stringptr, {&syslog_facility_str} },
362 { "syslog_pid", opt_bool, {&syslog_pid} },
363 { "syslog_processname", opt_stringptr, {&syslog_processname} },
364 { "syslog_timestamp", opt_bool, {&syslog_timestamp} },
365 { "system_filter", opt_stringptr, {&system_filter} },
366 { "system_filter_directory_transport", opt_stringptr,{&system_filter_directory_transport} },
367 { "system_filter_file_transport",opt_stringptr,{&system_filter_file_transport} },
368 { "system_filter_group", opt_gid, {&system_filter_gid} },
369 { "system_filter_pipe_transport",opt_stringptr,{&system_filter_pipe_transport} },
370 { "system_filter_reply_transport",opt_stringptr,{&system_filter_reply_transport} },
371 { "system_filter_user", opt_uid, {&system_filter_uid} },
372 { "tcp_nodelay", opt_bool, {&tcp_nodelay} },
373 #ifdef USE_TCP_WRAPPERS
374 { "tcp_wrappers_daemon_name", opt_stringptr, {&tcp_wrappers_daemon_name} },
376 { "timeout_frozen_after", opt_time, {&timeout_frozen_after} },
377 { "timezone", opt_stringptr, {&timezone_string} },
378 { "tls_advertise_hosts", opt_stringptr, {&tls_advertise_hosts} },
380 { "tls_alpn", opt_stringptr, {&tls_alpn} },
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 #ifndef DISABLE_WELLKNOWN
409 { "wellknown_advertise_hosts",opt_stringptr, {&wellknown_advertise_hosts} },
411 { "write_rejectlog", opt_bool, {&write_rejectlog} },
415 static int optionlist_config_size = nelem(optionlist_config);
422 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags) {/*Dummy*/}
427 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
433 uschar buf[EXIM_DRIVERNAME_MAX];
435 options_from_list(optionlist_auths, optionlist_auths_size,
436 US"AUTHENTICATORS", NULL);
439 for (struct auth_info * ai = auths_available; ai->drinfo.driver_name[0]; ai++)
441 for (driver_info * di = (driver_info *)auths_available_newlist; di; di = di->next)
443 auth_info * ai = (auth_info *)di;
445 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", di->driver_name);
446 builtin_macro_create(buf);
447 options_from_list(di->options, (unsigned)*di->options_count,
448 US"AUTHENTICATOR", di->driver_name);
450 if (ai->macros_create) (ai->macros_create)();
455 options_logging(void)
457 uschar buf[EXIM_DRIVERNAME_MAX];
459 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
461 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
462 builtin_macro_create(buf);
467 #else /*!MACRO_PREDEF*/
469 extern char **environ;
471 static void save_config_line(const uschar* line);
472 static void save_config_position(const uschar *file, int line);
473 static void print_config(BOOL admin, BOOL terse);
476 #define CSTATE_STACK_SIZE 10
478 const uschar *config_directory = NULL;
481 /* Structure for chain (stack) of .included files */
483 typedef struct config_file_item {
484 struct config_file_item *next;
485 const uschar *filename;
486 const uschar *directory;
491 /* Structure for chain of configuration lines (-bP config) */
493 typedef struct config_line_item {
494 struct config_line_item *next;
498 static config_line_item* config_lines;
500 /* Structure of table of conditional words and their state transitions */
502 typedef struct cond_item {
510 /* Structure of table of syslog facility names and values */
512 typedef struct syslog_fac_item {
518 static const uschar * const hidden = US"<value not displayable>";
520 /* Static variables */
522 static config_file_item *config_file_stack = NULL; /* For includes */
524 static uschar *syslog_facility_str = NULL;
525 static uschar next_section[24];
526 static uschar time_buffer[24];
528 /* State variables for conditional loading (.ifdef / .else / .endif) */
530 static int cstate = 0;
531 static int cstate_stack_ptr = -1;
532 static int cstate_stack[CSTATE_STACK_SIZE];
534 /* Table of state transitions for handling conditional inclusions. There are
535 four possible state transitions:
539 .elifdef true (or .else)
542 .endif just causes the previous cstate to be popped off the stack */
544 static int next_cstate[3][4] =
546 /* State 0: reading from file, or reading until next .else or .endif */
548 /* State 1: condition failed, skipping until next .else or .endif */
550 /* State 2: skipping until .endif */
554 /* Table of conditionals and the states to set. For each name, there are four
555 values: the length of the name (to save computing it each time), the state to
556 set if a macro was found in the line, the state to set if a macro was not found
557 in the line, and a stack manipulation setting which is:
559 -1 pull state value off the stack
560 0 don't alter the stack
561 +1 push value onto stack, before setting new state
564 static cond_item cond_list[] = {
565 { US"ifdef", 5, 0, 1, 1 },
566 { US"ifndef", 6, 1, 0, 1 },
567 { US"elifdef", 7, 2, 3, 0 },
568 { US"elifndef", 8, 3, 2, 0 },
569 { US"else", 4, 2, 2, 0 },
570 { US"endif", 5, 0, 0, -1 }
573 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
575 /* Table of syslog facility names and their values */
577 static syslog_fac_item syslog_list[] = {
578 { US"mail", LOG_MAIL },
579 { US"user", LOG_USER },
580 { US"news", LOG_NEWS },
581 { US"uucp", LOG_UUCP },
582 { US"local0", LOG_LOCAL0 },
583 { US"local1", LOG_LOCAL1 },
584 { US"local2", LOG_LOCAL2 },
585 { US"local3", LOG_LOCAL3 },
586 { US"local4", LOG_LOCAL4 },
587 { US"local5", LOG_LOCAL5 },
588 { US"local6", LOG_LOCAL6 },
589 { US"local7", LOG_LOCAL7 },
590 { US"daemon", LOG_DAEMON }
593 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
596 #define opt_fn_print BIT(0)
597 #define opt_fn_print_label BIT(1)
600 /*************************************************
601 * Find the name of an option *
602 *************************************************/
604 /* This function is to aid debugging. Various functions take arguments that are
605 pointer variables in the options table or in option tables for various drivers.
606 For debugging output, it is useful to be able to find the name of the option
607 which is currently being processed. This function finds it, if it exists, by
608 searching the table(s) for a value with the given content.
610 Arguments: a value that is presumed to be in the table above
611 Returns: the option name, or an empty string
615 readconf_find_option(void * listptr)
617 uschar * list = * USS listptr;
618 const uschar * name = NULL, * drname = NULL;
620 for (optionlist * o = optionlist_config; /* main-config options */
621 o < optionlist_config + optionlist_config_size; o++)
622 if (listptr == o->v.value)
626 for (const driver_instance * rd = (driver_instance *)routers;
627 rd; rd = rd->next) if (Ustrcmp(rd->name, router_name) == 0)
629 const router_instance * r = (router_instance *)rd;
630 const router_info * ri = (router_info *)rd->info;
632 /* Check for a listptr match first */
634 for (optionlist * o = optionlist_routers; /* generic options */
635 o < optionlist_routers + optionlist_routers_size; o++)
636 if ( (o->type & opt_mask) == opt_stringptr
637 && listptr == CS r + o->v.offset)
640 for (optionlist * o = ri->drinfo.options; /* private options */
641 o < ri->drinfo.options + *ri->drinfo.options_count; o++)
642 if ( (o->type & opt_mask) == opt_stringptr
643 && listptr == CS rd->options_block + o->v.offset)
646 /* Check for a list addr match, unless null */
650 for (optionlist * o = optionlist_routers; /* generic options */
651 o < optionlist_routers + optionlist_routers_size; o++)
652 if ( (o->type & opt_mask) == opt_stringptr
653 && list == * USS(CS r + o->v.offset))
655 return string_sprintf("DUP: %s %s vs. %s %s",
656 drname, name, rd->name, o->name);
658 { name = US o->name; drname = rd->name; }
660 for (optionlist * o = ri->drinfo.options; /* private options */
661 o < ri->drinfo.options + *ri->drinfo.options_count; o++)
662 if ( (o->type & opt_mask) == opt_stringptr
663 && list == * USS(CS rd->options_block + o->v.offset))
665 return string_sprintf("DUP: %s %s vs. %s %s",
666 drname, name, rd->name, o->name);
668 { name = US o->name; drname = rd->name; }
672 for (transport_instance * t = transports; t; t = t->drinst.next)
673 if (Ustrcmp(t->drinst.name, transport_name) == 0)
675 const transport_info * ti = t->drinst.info;
677 /* Check for a listptr match first */
679 for (optionlist * o = optionlist_transports; /* generic options */
680 o < optionlist_transports + optionlist_transports_size; o++)
681 if ( (o->type & opt_mask) == opt_stringptr
682 && listptr == CS t + o->v.offset)
685 for (optionlist * o = ti->drinfo.options; /* private options */
686 o < ti->drinfo.options + *ti->drinfo.options_count; o++)
687 if ( (o->type & opt_mask) == opt_stringptr
688 && listptr == CS t->drinst.options_block + o->v.offset)
691 /* Check for a list addr match, unless null */
695 for (optionlist * o = optionlist_transports; /* generic options */
696 o < optionlist_transports + optionlist_transports_size; o++)
697 if ( (o->type & opt_mask) == opt_stringptr
698 && list == * USS(CS t + o->v.offset))
700 return string_sprintf("DUP: %s %s vs. %s %s",
701 drname, name, t->drinst.name, o->name);
703 { name = US o->name; drname = t->drinst.name; }
705 for (optionlist * o = ti->drinfo.options; /* private options */
706 o < ti->drinfo.options + *ti->drinfo.options_count; o++)
707 if ( (o->type & opt_mask) == opt_stringptr
708 && list == * USS(CS t->drinst.options_block + o->v.offset))
710 return string_sprintf("DUP: %s %s vs. %s %s",
711 drname, name, t->drinst.name, o->name);
713 { name = US o->name; drname = t->drinst.name; }
716 return name ? name : US"";
722 /*************************************************
723 * Deal with an assignment to a macro *
724 *************************************************/
726 /* We have a new definition; append to the list.
729 name Name of the macro; will be copied
730 val Expansion result for the macro; will be copied
734 macro_create(const uschar * name, const uschar * val, BOOL command_line)
736 macro_item * m = store_get(sizeof(macro_item), GET_UNTAINTED);
738 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
740 m->command_line = command_line;
741 m->namelen = Ustrlen(name);
742 m->replen = Ustrlen(val);
743 m->name = string_copy(name);
744 m->replacement = string_copy(val);
756 /* This function is called when a line that starts with an upper case letter is
757 encountered. The argument "line" should contain a complete logical line, and
758 start with the first letter of the macro name. The macro name and the
759 replacement text are extracted and stored. Redefinition of existing,
760 non-command line, macros is permitted using '==' instead of '='.
763 s points to the start of the logical line
765 Returns: FALSE iff fatal error
769 macro_read_assignment(uschar *s)
771 uschar name[EXIM_DRIVERNAME_MAX];
776 while (isalnum(*s) || *s == '_')
778 if (namelen >= sizeof(name) - 1)
780 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
781 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
784 name[namelen++] = *s++;
788 Uskip_whitespace(&s);
791 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
800 Uskip_whitespace(&s);
802 /* If an existing macro of the same name was defined on the command line, we
803 just skip this definition. It's an error to attempt to redefine a macro without
804 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
805 It is also an error to define a macro whose name begins with the name of a
806 previously defined macro. This is the requirement that make using a tree
807 for macros hard; we must check all macros for the substring. Perhaps a
808 sorted list, and a bsearch, would work?
809 Note: it is documented that the other way round works. */
811 for (m = macros; m; m = m->next)
813 if (Ustrcmp(m->name, name) == 0)
815 if (!m->command_line && !redef)
817 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
818 "defined (use \"==\" if you want to redefine it)", name);
824 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
826 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
827 "a macro because previously defined macro \"%s\" is a substring",
832 /* We cannot have this test, because it is documented that a substring
833 macro is permitted (there is even an example).
835 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
836 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
837 * "a macro because it is a substring of previously defined macro \"%s\"",
842 /* Check for an overriding command-line definition. */
844 if (m && m->command_line) return TRUE;
846 /* Redefinition must refer to an existing macro. */
851 m->replen = Ustrlen(s);
852 m->replacement = string_copy(s);
856 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
861 /* We have a new definition. */
863 (void) macro_create(name, s, FALSE);
871 /* Process line for macros. The line is in big_buffer starting at offset len.
872 Expand big_buffer if needed. Handle definitions of new macros, and
873 macro expansions, rewriting the line in the buffer.
876 len Offset in buffer of start of line
877 newlen Pointer to offset of end of line, updated on return
878 macro_found Pointer to return that a macro was expanded
880 Return: pointer to first nonblank char in line
884 macros_expand(int len, int * newlen, BOOL * macro_found)
886 uschar * ss = big_buffer + len;
889 /* Find the true start of the physical line - leading spaces are always
892 Uskip_whitespace(&ss);
894 /* Process the physical line for macros. If this is the start of the logical
895 line, skip over initial text at the start of the line if it starts with an
896 upper case character followed by a sequence of name characters and an equals
897 sign, because that is the definition of a new macro, and we don't do
898 replacement therein. */
901 if (len == 0 && isupper(*s))
903 while (isalnum(*s) || *s == '_') s++;
904 if (Uskip_whitespace(&s) != '=') s = ss; /* Not a macro definition */
907 /* Skip leading chars which cannot start a macro name, to avoid multiple
908 pointless rescans in Ustrstr calls. */
910 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
912 /* For each defined macro, scan the line (from after XXX= if present),
913 replacing all occurrences of the macro. */
915 *macro_found = FALSE;
916 if (*s) for (macro_item * m = *s == '_' ? macros : macros_user; m; m = m->next)
921 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
925 while ((p = Ustrstr(t, m->name)) != NULL)
929 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
930 m->name, (int) Ustrlen(ss)-1, ss);
931 /* Expand the buffer if necessary */
933 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
935 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
936 uschar *newbuffer = store_malloc(newsize);
937 memcpy(newbuffer, big_buffer, *newlen + 1);
938 p = newbuffer + (p - big_buffer);
939 s = newbuffer + (s - big_buffer);
940 ss = newbuffer + (ss - big_buffer);
941 t = newbuffer + (t - big_buffer);
942 big_buffer_size = newsize;
943 store_free(big_buffer);
944 big_buffer = newbuffer;
947 /* Shuffle the remaining characters up or down in the buffer before
948 copying in the replacement text. Don't rescan the replacement for this
952 if ((moveby = m->replen - m->namelen) != 0)
954 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
957 Ustrncpy(p, m->replacement, m->replen);
959 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
964 /* An empty macro replacement at the start of a line could mean that ss no
965 longer points to the first non-blank character. */
967 Uskip_whitespace(&ss);
971 /*************************************************
972 * Read configuration line *
973 *************************************************/
975 /* A logical line of text is read from the configuration file into the big
976 buffer, taking account of macros, .includes, and continuations. The size of
977 big_buffer is increased if necessary. The count of configuration lines is
978 maintained. Physical input lines starting with # (ignoring leading white space,
979 and after macro replacement) and empty logical lines are always ignored.
980 Leading and trailing spaces are removed.
982 If we hit a line of the form "begin xxxx", the xxxx is placed in the
983 next_section vector, and the function returns NULL, indicating the end of a
984 configuration section. On end-of-file, NULL is returned with next_section
989 Returns: a pointer to the first non-blank in the line,
990 or NULL if eof or end of section is reached
994 get_config_line(void)
996 int startoffset = 0; /* To first non-blank char in logical line */
997 int len = 0; /* Of logical line so far */
1002 /* Loop for handling continuation lines, skipping comments, and dealing with
1007 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
1009 if (config_file_stack != NULL) /* EOF inside .include */
1011 (void)fclose(config_file);
1012 config_file = config_file_stack->file;
1013 config_filename = config_file_stack->filename;
1014 config_directory = config_file_stack->directory;
1015 config_lineno = config_file_stack->lineno;
1016 config_file_stack = config_file_stack->next;
1018 save_config_position(config_filename, config_lineno);
1022 /* EOF at top level */
1024 if (cstate_stack_ptr >= 0)
1025 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1026 "Unexpected end of configuration file: .endif missing");
1028 if (len != 0) break; /* EOF after continuation */
1029 next_section[0] = 0; /* EOF at start of logical line */
1034 newlen = len + Ustrlen(big_buffer + len);
1036 if (config_lines && config_lineno == 1)
1037 save_config_position(config_filename, config_lineno);
1039 /* Handle pathologically long physical lines - yes, it did happen - by
1040 extending big_buffer at this point. The code also copes with very long
1043 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
1046 big_buffer_size += BIG_BUFFER_SIZE;
1047 newbuffer = store_malloc(big_buffer_size);
1049 /* This use of strcpy is OK because we know that the string in the old
1050 buffer is shorter than the new buffer. */
1052 Ustrcpy(newbuffer, big_buffer);
1053 store_free(big_buffer);
1054 big_buffer = newbuffer;
1055 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
1057 newlen += Ustrlen(big_buffer + newlen);
1060 ss = macros_expand(len, &newlen, ¯o_found);
1062 /* Check for comment lines - these are physical lines. */
1064 if (*ss == '#') continue;
1066 /* Handle conditionals, which are also applied to physical lines. Conditions
1067 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
1068 expansion occurred on the rest of the line. A preliminary test for the leading
1069 '.' saves effort on most lines. */
1075 /* Search the list of conditional directives */
1077 for (i = 0; i < cond_list_size; i++)
1080 cond_item *c = cond_list+i;
1081 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
1083 /* The following character must be white space or end of string */
1085 n = ss[1 + c->namelen];
1086 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
1088 /* .ifdef and .ifndef push the current state onto the stack, then set
1089 a new one from the table. Stack overflow is an error */
1093 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
1094 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1095 ".%s nested too deeply", c->name);
1096 cstate_stack[++cstate_stack_ptr] = cstate;
1097 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
1100 /* For any of the others, stack underflow is an error. The next state
1101 comes either from the stack (.endif) or from the table. */
1105 if (cstate_stack_ptr < 0)
1106 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1107 ".%s without matching .ifdef", c->name);
1108 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1109 next_cstate[cstate][macro_found? c->action1 : c->action2];
1112 /* Having dealt with a directive, break the loop */
1117 /* If we have handled a conditional directive, continue with the next
1118 physical line. Otherwise, fall through. */
1120 if (i < cond_list_size) continue;
1123 /* If the conditional state is not 0 (actively using these lines), ignore
1126 if (cstate != 0) continue; /* Conditional skip */
1128 /* Handle .include lines - these are also physical lines. */
1130 if (Ustrncmp(ss, ".include", 8) == 0 &&
1132 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1135 int include_if_exists = isspace(ss[8]) ? 0 : 10;
1136 config_file_item *save;
1137 struct stat statbuf;
1139 ss += 9 + include_if_exists;
1140 Uskip_whitespace(&ss);
1141 t = ss + Ustrlen(ss);
1142 while (t > ss && isspace(t[-1])) t--;
1143 if (*ss == '\"' && t[-1] == '\"')
1150 /* We allow relative file names. For security reasons currently
1151 relative names not allowed with .include_if_exists. For .include_if_exists
1152 we need to check the permissions/ownership of the containing folder */
1154 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1155 "absolute path \"%s\"", ss);
1158 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1159 ss = string_from_gstring(g);
1162 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1165 save_config_position(config_filename, config_lineno);
1166 save = store_get(sizeof(config_file_item), GET_UNTAINTED);
1167 save->next = config_file_stack;
1168 config_file_stack = save;
1169 save->file = config_file;
1170 save->filename = config_filename;
1171 save->directory = config_directory;
1172 save->lineno = config_lineno;
1174 if (!(config_file = Ufopen(ss, "rb")))
1175 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1176 "configuration file %s", ss);
1178 config_filename = string_copy(ss);
1179 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1184 /* If this is the start of the logical line, remember where the non-blank
1185 data starts. Otherwise shuffle down continuation lines to remove leading
1189 startoffset = ss - big_buffer;
1192 s = big_buffer + len;
1195 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1200 /* Accept the new addition to the line. Remove trailing white space. */
1203 while (len > 0 && isspace(big_buffer[len-1])) len--;
1204 big_buffer[len] = 0;
1206 /* We are done if the line does not end in backslash and contains some data.
1207 Empty logical lines are ignored. For continuations, remove the backslash and
1208 go round the loop to read the continuation line. */
1212 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1213 big_buffer[--len] = 0; /* Remove backslash */
1215 } /* Loop for reading multiple physical lines */
1217 /* We now have a logical line. Test for the end of a configuration section (or,
1218 more accurately, for the start of the next section). Place the name of the next
1219 section in next_section, and return NULL. If the name given is longer than
1220 next_section, truncate it. It will be unrecognized later, because all the known
1221 section names do fit. Leave space for pluralizing. */
1223 s = big_buffer + startoffset; /* First non-space character */
1226 save_config_line(s);
1228 if (strncmpic(s, US"begin ", 6) == 0)
1231 Uskip_whitespace(&s);
1232 if (big_buffer + len - s > sizeof(next_section) - 2)
1233 s[sizeof(next_section) - 2] = 0;
1234 Ustrcpy(next_section, s);
1238 /* Return the first non-blank character. */
1245 /*************************************************
1247 *************************************************/
1249 /* The yield is the pointer to the next uschar. Names longer than the
1250 output space are silently truncated. This function is also used from acl.c when
1254 name where to put the name
1258 Returns: new input pointer
1262 readconf_readname(uschar * name, int len, const uschar * s)
1265 BOOL broken = FALSE;
1267 if (isalpha(Uskip_whitespace(&s)))
1268 while (isalnum(*s) || *s == '_')
1270 if (p < len-1) name[p++] = *s;
1280 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1281 "exim item name too long (>%d), unable to use \"%s\" (truncated)",
1284 Uskip_whitespace(&s);
1291 /*************************************************
1292 * Read a time value *
1293 *************************************************/
1295 /* This function is also called from outside, to read argument
1296 time values. The format of a time value is:
1298 [<n>w][<n>d][<n>h][<n>m][<n>s]
1300 as long as at least one is present. If a format error is encountered,
1301 return a negative value. The value must be terminated by the given
1306 terminator required terminating character
1307 return_msec if TRUE, allow fractional seconds and return milliseconds
1309 Returns: the time value, or -1 on syntax error
1310 value is seconds if return_msec is FALSE
1311 value is milliseconds if return_msec is TRUE
1315 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1323 if (!isdigit(*s)) return -1;
1324 (void)sscanf(CCS s, "%d%n", &value, &count);
1329 case 'w': value *= 7;
1330 case 'd': value *= 24;
1331 case 'h': value *= 60;
1332 case 'm': value *= 60;
1337 if (!return_msec) return -1;
1338 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1340 if (*s++ != 's') return -1;
1341 yield += (int)(fraction * 1000.0);
1347 if (return_msec) value *= 1000;
1349 if (*s == terminator) return yield;
1351 /* Control never reaches here. */
1356 /*************************************************
1357 * Read a fixed point value *
1358 *************************************************/
1360 /* The value is returned *1000
1364 terminator required terminator
1366 Returns: the value, or -1 on error
1370 readconf_readfixed(const uschar *s, int terminator)
1374 if (!isdigit(*s)) return -1;
1375 (void)sscanf(CS s, "%d%n", &value, &count);
1377 yield = value * 1000;
1381 while (isdigit((*(++s))))
1383 yield += (*s - '0') * m;
1388 return (*s == terminator)? yield : (-1);
1393 /*************************************************
1394 * Find option in list *
1395 *************************************************/
1397 /* The lists are always in order, so binary chop can be used.
1400 name the option name to search for
1401 ol the first entry in the option list
1402 last one more than the offset of the last entry in the option list
1404 Returns: pointer to an option entry, or NULL if not found
1408 find_option(const uschar *name, optionlist *ol, int last)
1411 while (last > first)
1413 int middle = (first + last)/2;
1414 int c = Ustrcmp(name, ol[middle].name);
1416 if (c == 0) return ol + middle;
1417 else if (c > 0) first = middle + 1;
1425 /*************************************************
1426 * Find a set flag in option list *
1427 *************************************************/
1429 /* Because some versions of Unix make no restrictions on the values of uids and
1430 gids (even negative ones), we cannot represent "unset" by a special value.
1431 There is therefore a separate boolean variable for each one indicating whether
1432 a value is set or not. This function returns a pointer to the boolean, given
1433 the original option name. It is a major disaster if the flag cannot be found.
1436 name the name of the uid or gid option
1437 oltop points to the start of the relevant option list
1438 last one more than the offset of the last item in the option list
1439 data_block NULL when reading main options => data values in the option
1440 list are absolute addresses; otherwise they are byte offsets
1441 in data_block (used for driver options)
1443 Returns: a pointer to the boolean flag.
1447 get_set_flag(const uschar *name, optionlist *oltop, int last, void *data_block)
1450 uschar name2[EXIM_DRIVERNAME_MAX];
1451 sprintf(CS name2, "*set_%.50s", name);
1452 if (!(ol = find_option(name2, oltop, last)))
1453 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1454 "Exim internal error: missing set flag for %s", name);
1456 ? (BOOL *)(US data_block + ol->v.offset) : (BOOL *)ol->v.value;
1462 /*************************************************
1463 * Output extra characters message and die *
1464 *************************************************/
1466 /* Called when an option line has junk on the end. Sometimes this is because
1467 the sysadmin thinks comments are permitted.
1470 s points to the extra characters
1471 t1..t3 strings to insert in the log message
1473 Returns: doesn't return; dies
1477 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1479 uschar *comment = US"";
1480 if (*s == '#') comment = US" (# is comment only at line start)";
1481 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1482 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1487 /*************************************************
1488 * Read rewrite information *
1489 *************************************************/
1491 /* Each line of rewrite information contains:
1493 . A complete address in the form user@domain, possibly with
1494 leading * for each part; or alternatively, a regex.
1496 . A replacement string (which will be expanded).
1498 . An optional sequence of one-letter flags, indicating which
1499 headers etc. to apply this rule to.
1501 All this is decoded and placed into a control block. The OR of the flags is
1502 maintained in a common word.
1505 p points to the string that makes up the rule
1506 existflags points to the overall flag word
1507 isglobal TRUE if reading global rewrite rules
1509 Returns: the control block for the parsed rule.
1512 static rewrite_rule *
1513 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1515 rewrite_rule * next = store_get(sizeof(rewrite_rule), GET_UNTAINTED);
1518 next->key = string_dequote(&p);
1520 Uskip_whitespace(&p);
1522 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1523 "missing rewrite replacement string");
1526 next->replacement = string_dequote(&p);
1528 while (*p) switch (*p++)
1530 case ' ': case '\t': break;
1532 case 'q': next->flags |= rewrite_quit; break;
1533 case 'w': next->flags |= rewrite_whole; break;
1535 case 'h': next->flags |= rewrite_all_headers; break;
1536 case 's': next->flags |= rewrite_sender; break;
1537 case 'f': next->flags |= rewrite_from; break;
1538 case 't': next->flags |= rewrite_to; break;
1539 case 'c': next->flags |= rewrite_cc; break;
1540 case 'b': next->flags |= rewrite_bcc; break;
1541 case 'r': next->flags |= rewrite_replyto; break;
1543 case 'E': next->flags |= rewrite_all_envelope; break;
1544 case 'F': next->flags |= rewrite_envfrom; break;
1545 case 'T': next->flags |= rewrite_envto; break;
1547 case 'Q': next->flags |= rewrite_qualify; break;
1548 case 'R': next->flags |= rewrite_repeat; break;
1551 next->flags |= rewrite_smtp;
1552 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1553 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1554 "rewrite rule has the S flag but is not a regular expression");
1558 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1559 "unknown rewrite flag character '%c' "
1560 "(could be missing quotes round replacement item)", p[-1]);
1564 /* If no action flags are set, set all the "normal" rewrites. */
1566 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1567 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1569 /* Remember which exist, for optimization, and return the rule */
1571 *existflags |= next->flags;
1578 /*************************************************
1579 * Read global rewrite information *
1580 *************************************************/
1582 /* Each line is a single rewrite rule; it is parsed into a control block
1583 by readconf_one_rewrite(), and its flags are ORed into the global flag
1584 word rewrite_existflags. */
1587 readconf_rewrites(void)
1589 rewrite_rule **chain = &global_rewrite_rules;
1592 while ((p = get_config_line()) != NULL)
1594 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1596 chain = &(next->next);
1602 /*************************************************
1604 *************************************************/
1606 /* Strings are read into the normal store pool. As long we aren't too
1607 near the end of the current block, the string will just use what is necessary
1608 on the top of the stacking pool, because string_cat() uses the extension
1612 s the rest of the input line
1613 name the option name (for errors)
1615 Returns: pointer to the string
1619 read_string(const uschar *s, const uschar *name)
1624 if (*s != '\"') return string_copy(s);
1627 yield = string_dequote(&s);
1629 if (s == ss+1 || s[-1] != '\"')
1630 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1631 "missing quote at end of string value for %s", name);
1633 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1639 /*************************************************
1640 * Custom-handler options *
1641 *************************************************/
1643 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags)
1645 if (flags & opt_fn_print)
1647 if (flags & opt_fn_print_label) printf("%s = ", name);
1648 printf("%s\n", smtp_receive_timeout_s
1649 ? string_printing2(smtp_receive_timeout_s, SP_TAB)
1650 : readconf_printtime(smtp_receive_timeout));
1652 else if (*str == '$')
1653 smtp_receive_timeout_s = string_copy(str);
1656 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1657 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1658 if (smtp_receive_timeout < 0)
1659 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1664 /*************************************************
1665 * Handle option line *
1666 *************************************************/
1668 /* This function is called from several places to process a line containing the
1669 setting of an option. The first argument is the line to be decoded; it has been
1670 checked not to be empty and not to start with '#'. Trailing newlines and white
1671 space have been removed. The second argument is a pointer to the list of
1672 variable names that are to be recognized, together with their types and
1673 locations, and the third argument gives the number of entries in the list.
1675 The fourth argument is a pointer to a data block. If it is NULL, then the data
1676 values in the options list are absolute addresses. Otherwise, they are byte
1677 offsets in the data block.
1679 String option data may continue onto several lines; this function reads further
1680 data from config_file if necessary.
1682 The yield of this function is normally zero. If a string continues onto
1683 multiple lines, then the data value is permitted to be followed by a comma
1684 or a semicolon (for use in drivers) and the yield is that character.
1687 buffer contains the configuration line to be handled
1688 oltop points to the start of the relevant option list
1689 last one more than the offset of the last item in the option list
1690 data_block NULL when reading main options => data values in the option
1691 list are absolute addresses; otherwise they are byte offsets
1692 in data_block when they have opt_public set; otherwise
1693 they are byte offsets in data_block->options_block.
1694 unknown_txt format string to use in panic message for unknown option;
1695 must contain %s for option name
1696 if given as NULL, don't panic on unknown option
1698 Returns: TRUE if an option was read successfully,
1699 FALSE false for an unknown option if unknown_txt == NULL,
1700 otherwise panic and die on an unknown option
1704 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1705 void *data_block, uschar *unknown_txt)
1709 int count, type, value;
1713 BOOL boolvalue = TRUE;
1714 BOOL freesptr = TRUE;
1715 optionlist *ol, *ol2;
1719 uschar *inttype = US"";
1721 const uschar * s = buffer;
1722 uschar **str_target;
1723 uschar name[EXIM_DRIVERNAME_MAX];
1724 uschar name2[EXIM_DRIVERNAME_MAX];
1726 /* There may be leading spaces; thereafter, we expect an option name starting
1729 if (!isalpha( Uskip_whitespace(&s) ))
1730 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1732 /* Read the name of the option, and skip any subsequent white space. If
1733 it turns out that what we read was "hide", set the flag indicating that
1734 this is a secure option, and loop to read the next word. */
1736 for (int n = 0; n < 2; n++)
1738 while (isalnum(*s) || *s == '_')
1740 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1744 Uskip_whitespace(&s);
1745 if (Ustrcmp(name, "hide") != 0) break;
1746 issecure = opt_secure;
1750 /* Deal with "no_" or "not_" here for booleans */
1752 if (Ustrncmp(name, "no_", 3) == 0)
1758 if (Ustrncmp(name, "not_", 4) == 0)
1764 /* Search the list for the given name. A non-existent name, or an option that
1765 is set twice, is a disaster. */
1767 if (!(ol = find_option(name + offset, oltop, last)))
1769 if (!unknown_txt) return FALSE;
1770 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1773 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1774 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1775 "\"%s\" option set for the second time", name);
1777 ol->type |= opt_set | issecure;
1778 type = ol->type & opt_mask;
1780 /* Types with data values must be followed by '='; the "no[t]_" prefix
1781 applies only to boolean values. */
1783 if (type < opt_bool || type > opt_bool_last)
1786 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1787 "negation prefix applied to a non-boolean option");
1789 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1790 "unexpected end of line (data missing) after %s", name);
1792 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1795 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1796 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1797 ultimately expands to one of those values. */
1799 else if (*s && (offset != 0 || *s != '='))
1800 extra_chars_error(s, US"boolean option ", name, US"");
1802 /* Skip white space after = */
1804 if (*s == '=') while (isspace(*++s));
1806 /* If there is a data block and the opt_public flag is not set, change
1807 the data block pointer to the private options block. */
1809 if (data_block && !(ol->type & opt_public))
1810 data_block = (void *)(((driver_instance *)data_block)->options_block);
1812 /* Now get the data according to the type. */
1816 /* If a string value is not enclosed in quotes, it consists of
1817 the rest of the current line, verbatim. Otherwise, string escapes
1820 A transport is specified as a string, which is then looked up in the
1821 list of transports. A search type is specified as one of a number of
1824 A set or rewrite rules for a driver is specified as a string, which is
1825 then parsed into a suitable chain of control blocks.
1827 Uids and gids are specified as strings which are then looked up in the
1828 passwd file. Lists of uids and gids are similarly specified as colon-
1829 separated strings. */
1834 case opt_expand_uid:
1835 case opt_expand_gid:
1840 reset_point = store_mark();
1841 sptr = read_string(s, name);
1843 /* Having read a string, we now have several different ways of using it,
1844 depending on the data type, so do another switch. If keeping the actual
1845 string is not required (because it is interpreted), freesptr is set TRUE,
1846 and at the end we reset the pool. */
1850 /* If this was a string, set the variable to point to the new string,
1851 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1852 rules, we still keep the string (for printing), and parse the rules into a
1853 control block and flags word. */
1856 str_target = data_block ? USS (US data_block + ol->v.offset)
1858 if (ol->type & opt_rep_con)
1860 uschar * saved_condition;
1861 /* We already have a condition, we're conducting a crude hack to let
1862 multiple condition rules be chained together, despite storing them in
1864 *str_target = string_copy_perm( (saved_condition = *str_target)
1865 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1866 saved_condition, sptr)
1869 /* TODO(pdp): there is a memory leak here and just below
1870 when we set 3 or more conditions; I still don't
1871 understand the store mechanism enough to know
1872 what's the safe way to free content from an earlier store.
1873 AFAICT, stores stack, so freeing an early stored item also stores
1874 all data alloc'd after it. If we knew conditions were adjacent,
1875 we could survive that, but we don't. So I *think* we need to take
1876 another bit from opt_type to indicate "malloced"; this seems like
1877 quite a hack, especially for this one case. It also means that
1878 we can't ever reclaim the store from the *first* condition.
1880 Because we only do this once, near process start-up, I'm prepared to
1881 let this slide for the time being, even though it rankles. */
1883 else if (ol->type & opt_rep_str)
1886 Ustrncmp(name, "headers_add", 11) == 0 ? '\n'
1887 : Ustrncmp(name, "set", 3) == 0 ? ';'
1889 int sep_i = -(int)sep_o;
1890 const uschar * list = sptr;
1892 gstring * list_o = NULL;
1896 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1897 list_o = string_cat(list_o, *str_target);
1900 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1901 list_o = string_append_listele(list_o, sep_o, s);
1904 *str_target = string_copy_perm(string_from_gstring(list_o), FALSE);
1915 *USS (US data_block + ol->v.offset) = sptr;
1917 *USS ol->v.value = sptr;
1919 if (type == opt_rewrite)
1924 rewrite_rule **chain;
1927 sprintf(CS name2, "*%.50s_rules", name);
1928 ol2 = find_option(name2, oltop, last);
1929 sprintf(CS name2, "*%.50s_flags", name);
1930 ol3 = find_option(name2, oltop, last);
1933 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1934 "rewrite rules not available for driver");
1938 chain = (rewrite_rule **)(US data_block + ol2->v.offset);
1939 flagptr = (int *)(US data_block + ol3->v.offset);
1943 chain = (rewrite_rule **)ol2->v.value;
1944 flagptr = (int *)ol3->v.value;
1947 /* This will trap if sptr is tainted. Not sure if that can happen */
1948 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1950 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1952 chain = &(next->next);
1955 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1956 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1957 "non-header rewrite - not allowed at transport time -");
1961 /* If it was an expanded uid, see if there is any expansion to be
1962 done by checking for the presence of a $ character. If there is, save it
1963 in the corresponding *expand_user option field. Otherwise, fall through
1964 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1967 case opt_expand_uid:
1968 sprintf(CS name2, "*expand_%.50s", name);
1969 if ((ol2 = find_option(name2, oltop, last)))
1971 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1974 *(USS(US data_block + ol2->v.offset)) = ss;
1976 *(USS ol2->v.value) = ss;
1980 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1986 /* Look up a fixed uid, and also make use of the corresponding gid
1987 if a passwd entry is returned and the gid has not been set. */
1990 if (!route_finduser(sptr, &pw, &uid))
1991 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1993 *(uid_t *)(US data_block + ol->v.offset) = uid;
1995 *(uid_t *)ol->v.value = uid;
1997 /* Set the flag indicating a fixed value is set */
1999 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
2001 /* Handle matching gid if we have a passwd entry: done by finding the
2002 same name with terminating "user" changed to "group"; if not found,
2003 ignore. Also ignore if the value is already set. */
2005 if (pw == NULL) break;
2006 Ustrcpy(name+Ustrlen(name)-4, US"group");
2007 ol2 = find_option(name, oltop, last);
2008 if (ol2 && ((ol2->type & opt_mask) == opt_gid ||
2009 (ol2->type & opt_mask) == opt_expand_gid))
2011 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
2015 *((gid_t *)(US data_block + ol2->v.offset)) = pw->pw_gid;
2017 *((gid_t *)ol2->v.value) = pw->pw_gid;
2023 /* If it was an expanded gid, see if there is any expansion to be
2024 done by checking for the presence of a $ character. If there is, save it
2025 in the corresponding *expand_user option field. Otherwise, fall through
2026 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
2029 case opt_expand_gid:
2030 sprintf(CS name2, "*expand_%.50s", name);
2031 if ((ol2 = find_option(name2, oltop, last)))
2033 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
2036 *(USS(US data_block + ol2->v.offset)) = ss;
2038 *(USS ol2->v.value) = ss;
2042 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
2048 /* Handle freestanding gid */
2051 if (!route_findgroup(sptr, &gid))
2052 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
2054 *((gid_t *)(US data_block + ol->v.offset)) = gid;
2056 *((gid_t *)ol->v.value) = gid;
2057 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
2060 /* If it was a uid list, look up each individual entry, and build
2061 a vector of uids, with a count in the first element. Put the vector
2062 in malloc store so we can free the string. (We are reading into
2063 permanent store already.) */
2071 const uschar *op = expand_string (sptr);
2074 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2075 name, expand_string_message);
2078 if (*p != 0) count++;
2079 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2080 list = store_malloc(count*sizeof(uid_t));
2081 list[ptr++] = (uid_t)(count - 1);
2084 *((uid_t **)(US data_block + ol->v.offset)) = list;
2086 *((uid_t **)ol->v.value) = list;
2092 /* If p is tainted we trap. Not sure that can happen */
2093 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2094 if (!route_finduser(big_buffer, NULL, &uid))
2095 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
2102 /* If it was a gid list, look up each individual entry, and build
2103 a vector of gids, with a count in the first element. Put the vector
2104 in malloc store so we can free the string. (We are reading into permanent
2113 const uschar *op = expand_string (sptr);
2116 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2117 name, expand_string_message);
2120 if (*p != 0) count++;
2121 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2122 list = store_malloc(count*sizeof(gid_t));
2123 list[ptr++] = (gid_t)(count - 1);
2126 *((gid_t **)(US data_block + ol->v.offset)) = list;
2128 *((gid_t **)ol->v.value) = list;
2134 /* If p is tainted we trap. Not sure that can happen */
2135 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2136 if (!route_findgroup(big_buffer, &gid))
2137 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2145 /* Release store if the value of the string doesn't need to be kept. */
2147 if (freesptr) reset_point = store_reset(reset_point);
2150 /* Expanded boolean: if no characters follow, or if there are no dollar
2151 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2152 save the string for later expansion in the alternate place. */
2154 case opt_expand_bool:
2155 if (*s && Ustrchr(s, '$') != 0)
2157 sprintf(CS name2, "*expand_%.50s", name);
2158 if ((ol2 = find_option(name2, oltop, last)))
2160 reset_point = store_mark();
2161 sptr = read_string(s, name);
2163 *(USS(US data_block + ol2->v.offset)) = sptr;
2165 *(USS ol2->v.value) = sptr;
2172 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2173 look for yes/not/true/false. Some booleans are stored in a single bit in
2174 a single int. There's a special fudge for verify settings; without a suffix
2175 they set both xx_sender and xx_recipient. The table points to the sender
2176 value; search subsequently for the recipient. There's another special case:
2177 opt_bool_set also notes when a boolean has been set. */
2181 case opt_bool_verify:
2185 s = readconf_readname(name2, EXIM_DRIVERNAME_MAX, s);
2186 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2188 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2190 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2191 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2192 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2193 US"for boolean option ", name);
2196 /* Handle single-bit type. */
2198 if (type == opt_bit)
2200 int bit = 1 << ((ol->type >> 16) & 31);
2201 int * ptr = data_block
2202 ? (int *)(US data_block + ol->v.offset)
2203 : (int *)ol->v.value;
2204 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2208 /* Handle full BOOL types */
2211 *((BOOL *)(US data_block + ol->v.offset)) = boolvalue;
2213 *((BOOL *)ol->v.value) = boolvalue;
2217 if (type == opt_bool_verify)
2219 sprintf(CS name2, "%.50s_recipient", name + offset);
2220 if ((ol2 = find_option(name2, oltop, last)))
2222 *((BOOL *)(US data_block + ol2->v.offset)) = boolvalue;
2224 *((BOOL *)ol2->v.value) = boolvalue;
2227 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2229 else if (type == opt_bool_set)
2231 sprintf(CS name2, "*set_%.50s", name + offset);
2232 if ((ol2 = find_option(name2, oltop, last)))
2234 *((BOOL *)(US data_block + ol2->v.offset)) = TRUE;
2236 *((BOOL *)ol2->v.value) = TRUE;
2244 inttype = US"octal ";
2246 /* Integer: a simple(ish) case; allow octal and hex formats, and
2247 suffixes K, M, G, and T. The different types affect output, not input. */
2256 lvalue = strtol(CS s, CSS &endptr, intbase);
2259 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2262 if (errno != ERANGE && *endptr)
2264 uschar * mp = US"TtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2266 if ((mp = Ustrchr(mp, *endptr)))
2271 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2282 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2283 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2284 "absolute value of integer \"%s\" is too large (overflow)", s);
2286 if (Uskip_whitespace(&endptr))
2287 extra_chars_error(endptr, inttype, US"integer value for ", name);
2289 value = (int)lvalue;
2293 *(int *)(US data_block + ol->v.offset) = value;
2295 *(int *)ol->v.value = value;
2298 /* Integer held in K: again, allow formats and suffixes as above. */
2304 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2307 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2310 if (errno != ERANGE && *endptr)
2312 uschar * mp = US"ZzEePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2314 if ((mp = Ustrchr(mp, *endptr)))
2319 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2328 lvalue = (lvalue + 512)/1024;
2331 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2332 "absolute value of integer \"%s\" is too large (overflow)", s);
2334 if (Uskip_whitespace(&endptr))
2335 extra_chars_error(endptr, inttype, US"integer value for ", name);
2338 *(int_eximarith_t *)(US data_block + ol->v.offset) = lvalue;
2340 *(int_eximarith_t *)ol->v.value = lvalue;
2344 /* Fixed-point number: held to 3 decimal places. */
2347 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2348 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2349 "fixed-point number expected for %s", name);
2351 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2352 "integer \"%s\" is too large (overflow)", s);
2356 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2357 "integer \"%s\" is too large (overflow)", s);
2359 /* We get a coverity error here for using count, as it derived
2360 from the tainted buffer pointed to by s, as parsed by sscanf().
2361 By the definition of sscanf we must be accessing between start
2362 and end of s (assuming it is nul-terminated...) so ignore the error. */
2363 /* coverity[tainted_data] */
2364 if (s[count] == '.')
2367 while (isdigit(s[++count]))
2369 value += (s[count] - '0') * d;
2374 while (isspace(s[count])) count++;
2377 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2380 *((int *)(US data_block + ol->v.offset)) = value;
2382 *((int *)ol->v.value) = value;
2385 /* There's a special routine to read time values. */
2388 value = readconf_readtime(s, 0, FALSE);
2390 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2393 *((int *)(US data_block + ol->v.offset)) = value;
2395 *((int *)ol->v.value) = value;
2398 /* A time list is a list of colon-separated times, with the first
2399 element holding the size of the list and the second the number of
2405 int * list = data_block
2406 ? (int *)(US data_block + ol->v.offset)
2407 : (int *)ol->v.value;
2409 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2412 uschar *snext = Ustrchr(s, ':');
2416 while (ss > s && isspace(ss[-1])) ss--;
2419 value = readconf_readtime(s, terminator, FALSE);
2421 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2423 if (count > 1 && value <= list[count])
2424 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2425 "time value out of order for %s", name);
2426 list[count+1] = value;
2427 if (snext == NULL) break;
2429 Uskip_whitespace(&s);
2432 if (count > list[0] - 2)
2433 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2435 if (count > 0 && list[2] == 0) count = 0;
2441 ol->v.fn(name, s, 0);
2450 /*************************************************
2451 * Print a time value *
2452 *************************************************/
2455 Argument: a time value in seconds
2456 Returns: pointer to a fixed buffer containing the time as a string,
2457 in readconf_readtime() format
2461 readconf_printtime(int t)
2464 uschar *p = time_buffer;
2466 if (t < 0) *p++ = '-', t = -t;
2477 if (w > 0) p += sprintf(CS p, "%dw", w);
2478 if (d > 0) p += sprintf(CS p, "%dd", d);
2479 if (h > 0) p += sprintf(CS p, "%dh", h);
2480 if (m > 0) p += sprintf(CS p, "%dm", m);
2481 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2488 /*************************************************
2489 * Print an individual option value *
2490 *************************************************/
2492 /* This is used by the -bP option, so prints to the standard output.
2493 The entire options list is passed in as an argument, because some options come
2494 in pairs - typically uid/gid settings, which can either be explicit numerical
2495 values, or strings to be expanded later. If the numerical value is unset,
2496 search for "*expand_<name>" to see if there is a string equivalent.
2499 ol option entry, or NULL for an unknown option
2501 options_block NULL for main configuration options; otherwise points to
2502 a driver block; if the option doesn't have opt_public
2503 set, then options_block->options_block is where the item
2505 oltop points to the option list in which ol exists
2506 last one more than the offset of the last entry in optop
2507 no_labels do not show "foo = " at the start.
2509 Returns: boolean success
2513 print_ol(optionlist *ol, const uschar *name, void *options_block,
2514 optionlist *oltop, int last, BOOL no_labels)
2523 uschar name2[EXIM_DRIVERNAME_MAX];
2527 printf("%s is not a known option\n", name);
2531 /* Non-admin callers cannot see options that have been flagged secure by the
2534 if (!f.admin_user && ol->type & opt_secure)
2537 printf("%s\n", CCS hidden);
2539 printf("%s = %s\n", name, CCS hidden);
2543 /* Else show the value of the option */
2545 value = ol->v.value;
2548 if (!(ol->type & opt_public))
2549 options_block = (void *)(((driver_instance *)options_block)->options_block);
2550 value = (void *)(US options_block + (long int)value);
2553 switch(ol->type & opt_mask)
2556 case opt_rewrite: /* Show the text value */
2558 if (!no_labels) printf("%s = ", name);
2559 printf("%s\n", s ? string_printing2(s, SP_TAB) : US"");
2563 if (!no_labels) printf("%s = ", name);
2564 printf("%d\n", *((int *)value));
2569 int x = *((int *)value);
2570 if (x != 0 && (x & 1023) == 0)
2574 if ((x & 1023) == 0)
2579 if (!no_labels) printf("%s = ", name);
2580 printf("%d%c\n", x, c);
2584 if (!no_labels) printf("%s = ", name);
2592 int_eximarith_t x = *((int_eximarith_t *)value);
2593 if (!no_labels) printf("%s = ", name);
2594 if (x == 0) printf("0\n");
2595 else if ((x & ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH "T\n", x >> 30);
2596 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2597 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2598 else printf(PR_EXIM_ARITH "K\n", x);
2603 if (!no_labels) printf("%s = ", name);
2604 printf("%#o\n", *((int *)value));
2607 /* Can be negative only when "unset", in which case integer */
2611 int x = *((int *)value);
2614 if (x < 0) printf("%s =\n", name); else
2616 if (!no_labels) printf("%s = ", name);
2617 printf("%d.", x/1000);
2630 /* If the numerical value is unset, try for the string value */
2632 case opt_expand_uid:
2633 if (! *get_set_flag(name, oltop, last, options_block))
2635 sprintf(CS name2, "*expand_%.50s", name);
2636 if ((ol2 = find_option(name2, oltop, last)))
2639 s = *USS (US options_block + ol2->v.offset);
2641 s = *USS ol2->v.value;
2642 if (!no_labels) printf("%s = ", name);
2643 printf("%s\n", s ? string_printing(s) : US"");
2648 /* Else fall through */
2651 if (!no_labels) printf("%s = ", name);
2652 if (! *get_set_flag(name, oltop, last, options_block))
2655 if ((pw = getpwuid(*((uid_t *)value))))
2656 printf("%s\n", pw->pw_name);
2658 printf("%ld\n", (long int)(*((uid_t *)value)));
2661 /* If the numerical value is unset, try for the string value */
2663 case opt_expand_gid:
2664 if (! *get_set_flag(name, oltop, last, options_block))
2666 sprintf(CS name2, "*expand_%.50s", name);
2667 if ( (ol2 = find_option(name2, oltop, last))
2668 && (ol2->type & opt_mask) == opt_stringptr)
2671 s = *USS (US options_block + ol2->v.offset);
2673 s = *USS ol2->v.value;
2674 if (!no_labels) printf("%s = ", name);
2675 printf("%s\n", s ? string_printing(s) : US"");
2680 /* Else fall through */
2683 if (!no_labels) printf("%s = ", name);
2684 if (! *get_set_flag(name, oltop, last, options_block))
2687 if ((gr = getgrgid(*((int *)value))))
2688 printf("%s\n", gr->gr_name);
2690 printf("%ld\n", (long int)(*((int *)value)));
2694 uidlist = *((uid_t **)value);
2695 if (!no_labels) printf("%s =", name);
2698 uschar sep = no_labels ? '\0' : ' ';
2699 for (int i = 1; i <= (int)(uidlist[0]); i++)
2701 uschar *name = NULL;
2702 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2703 if (sep != '\0') printf("%c", sep);
2704 if (name) printf("%s", name);
2705 else printf("%ld", (long int)(uidlist[i]));
2713 gidlist = *((gid_t **)value);
2714 if (!no_labels) printf("%s =", name);
2717 uschar sep = no_labels ? '\0' : ' ';
2718 for (int i = 1; i <= (int)(gidlist[0]); i++)
2720 uschar *name = NULL;
2721 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2722 if (sep != '\0') printf("%c", sep);
2723 if (name) printf("%s", name);
2724 else printf("%ld", (long int)(gidlist[i]));
2732 if (!no_labels) printf("%s = ", name);
2733 printf("%s\n", readconf_printtime(*((int *)value)));
2738 int *list = (int *)value;
2739 if (!no_labels) printf("%s = ", name);
2740 for (int i = 0; i < list[1]; i++)
2741 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2747 printf("%s%s\n", (*((int *)value)) & (1 << ((ol->type >> 16) & 31))
2748 ? "" : "no_", name);
2751 case opt_expand_bool:
2752 sprintf(CS name2, "*expand_%.50s", name);
2753 if ((ol2 = find_option(name2, oltop, last)) && ol2->v.value)
2756 s = *USS (US options_block + ol2->v.offset);
2758 s = *USS ol2->v.value;
2761 if (!no_labels) printf("%s = ", name);
2762 printf("%s\n", string_printing(s));
2765 /* s == NULL => string not set; fall through */
2771 case opt_bool_verify:
2773 printf("%s%s\n", *((BOOL *)value) ? "" : "no_", name);
2777 ol->v.fn(name, NULL, no_labels ? opt_fn_print : opt_fn_print|opt_fn_print_label);
2785 /*************************************************
2786 * Print value from main configuration *
2787 *************************************************/
2789 /* This function, called as a result of encountering the -bP option,
2790 causes the value of any main configuration variable to be output if the
2791 second argument is NULL. There are some special values:
2793 all print all main configuration options
2794 config_file print the name of the configuration file
2795 (configure_file will still work, for backward
2797 routers print the routers' configurations
2798 transports print the transports' configuration
2799 authenticators print the authenticators' configuration
2800 macros print the macros' configuration
2801 router_list print a list of router names
2802 transport_list print a list of transport names
2803 authenticator_list print a list of authentication mechanism names
2804 macro_list print a list of macro names
2805 +name print a named list item
2806 local_scan print the local_scan options
2807 config print the configuration as it is parsed
2808 environment print the used execution environment
2810 If the second argument is not NULL, it must be one of "router", "transport",
2811 "authenticator" or "macro" in which case the first argument identifies the
2812 driver whose options are to be printed.
2815 name option name if type == NULL; else driver name
2816 type NULL or driver type name, as described above
2817 no_labels avoid the "foo = " at the start of an item
2819 Returns: Boolean success
2823 readconf_print(const uschar * name, const uschar * type, BOOL no_labels)
2825 BOOL names_only = FALSE;
2826 optionlist *ol2 = NULL;
2827 driver_instance *d = NULL;
2836 static uschar *types[] = { US"address", US"domain", US"host",
2838 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2839 &hostlist_anchor, &localpartlist_anchor };
2841 for (int i = 0; i < 4; i++)
2842 if ((t = tree_search(*(anchors[i]), name+1)))
2844 namedlist_block * nb = t->data.ptr;
2845 const uschar * s = nb->hide ? hidden : nb->string;
2848 printf("%s\n", CCS s);
2850 printf("%slist %s = %s\n", types[i], name+1, CCS s);
2854 printf("no address, domain, host, or local part list called \"%s\" "
2855 "exists\n", name+1);
2860 if ( Ustrcmp(name, "configure_file") == 0
2861 || Ustrcmp(name, "config_file") == 0)
2863 printf("%s\n", CS config_main_filename);
2867 if (Ustrcmp(name, "all") == 0)
2869 for (optionlist * ol = optionlist_config;
2870 ol < optionlist_config + nelem(optionlist_config); ol++)
2871 if (!(ol->type & opt_hidden))
2872 (void) print_ol(ol, US ol->name, NULL,
2873 optionlist_config, nelem(optionlist_config),
2878 if (Ustrcmp(name, "local_scan") == 0)
2880 #ifndef LOCAL_SCAN_HAS_OPTIONS
2881 printf("local_scan() options are not supported\n");
2884 for (optionlist * ol = local_scan_options;
2885 ol < local_scan_options + local_scan_options_count; ol++)
2886 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2887 local_scan_options_count, no_labels);
2892 if (Ustrcmp(name, "config") == 0)
2894 print_config(f.admin_user, no_labels);
2898 if (Ustrcmp(name, "routers") == 0)
2903 else if (Ustrcmp(name, "transports") == 0)
2905 type = US"transport";
2908 else if (Ustrcmp(name, "authenticators") == 0)
2910 type = US"authenticator";
2913 else if (Ustrcmp(name, "macros") == 0)
2918 else if (Ustrcmp(name, "router_list") == 0)
2924 else if (Ustrcmp(name, "transport_list") == 0)
2926 type = US"transport";
2930 else if (Ustrcmp(name, "authenticator_list") == 0)
2932 type = US"authenticator";
2936 else if (Ustrcmp(name, "macro_list") == 0)
2942 else if (Ustrcmp(name, "environment") == 0)
2947 for (p = USS environ; *p; p++) ;
2948 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2950 for (p = USS environ; *p; p++)
2953 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2961 return print_ol(find_option(name,
2962 optionlist_config, nelem(optionlist_config)),
2963 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2966 /* Handle the options for a router or transport. Skip options that are flagged
2967 as hidden. Some of these are options with names starting with '*', used for
2968 internal alternative representations of other options (which the printing
2969 function will sort out). Others are synonyms kept for backward compatibility.
2972 if (Ustrcmp(type, "router") == 0)
2974 d = (driver_instance *)routers;
2975 ol2 = optionlist_routers;
2976 size = optionlist_routers_size;
2978 else if (Ustrcmp(type, "transport") == 0)
2980 d = (driver_instance *)transports;
2981 ol2 = optionlist_transports;
2982 size = optionlist_transports_size;
2984 else if (Ustrcmp(type, "authenticator") == 0)
2986 d = (driver_instance *)auths;
2987 ol2 = optionlist_auths;
2988 size = optionlist_auths_size;
2991 else if (Ustrcmp(type, "macro") == 0)
2993 /* People store passwords in macros and they were previously not available
2994 for printing. So we have an admin_users restriction. */
2997 fprintf(stderr, "exim: permission denied; not admin\n");
3000 for (macro_item * m = macros; m; m = m->next)
3001 if (!name || Ustrcmp(name, m->name) == 0)
3004 printf("%s\n", CS m->name);
3006 printf("%s\n", CS m->replacement);
3008 printf("%s=%s\n", CS m->name, CS m->replacement);
3012 if (!name) return TRUE;
3014 printf("%s %s not found\n", type, name);
3020 for (; d; d = d->next) printf("%s\n", CS d->name);
3024 /* Either search for a given driver, or print all of them */
3026 for (; d; d = d->next)
3029 driver_info * di = d->info;
3032 printf("\n%s %s:\n", d->name, type);
3033 else if (Ustrcmp(d->name, name) != 0) continue;
3035 for (optionlist * ol = ol2; ol < ol2 + size; ol++)
3036 if (!(ol->type & opt_hidden))
3037 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
3039 for (optionlist * ol = di->options;
3040 ol < di->options + *di->options_count; ol++)
3041 if (!(ol->type & opt_hidden))
3042 rc |= print_ol(ol, US ol->name, d, di->options,
3043 *di->options_count, no_labels);
3045 if (name) return rc;
3047 if (!name) return TRUE;
3049 printf("%s %s not found\n", type, name);
3055 /*************************************************
3056 * Read a named list item *
3057 *************************************************/
3059 /* This function reads a name and a list (i.e. string). The name is used to
3060 save the list in a tree, sorted by its name. Each entry also has a number,
3061 which can be used for caching tests, but if the string contains any expansion
3062 items other than $key, the number is set negative to inhibit caching. This
3063 mechanism is used for domain, host, and address lists that are referenced by
3067 anchorp points to the tree anchor
3068 numberp points to the current number for this tree
3069 max the maximum number permitted
3070 s the text of the option line, starting immediately after the name
3072 tname the name of the list type, for messages
3073 hide do not output value on "-bP"
3079 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
3080 uschar *tname, BOOL hide)
3082 BOOL forcecache = FALSE;
3085 namedlist_block * nb = store_get_perm(sizeof(namedlist_block), GET_UNTAINTED);
3087 if (Ustrncmp(s, "_cache", 6) == 0)
3094 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
3096 if (*numberp >= max)
3097 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3100 Uskip_whitespace(&s);
3102 while (isalnum(*s) || *s == '_') s++;
3103 t = store_get(sizeof(tree_node) + s-ss, ss);
3104 Ustrncpy(t->name, ss, s-ss);
3106 Uskip_whitespace(&s);
3108 if (!tree_insertnode(anchorp, t))
3109 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3110 "duplicate name \"%s\" for a named %s", t->name, tname);
3113 nb->number = *numberp;
3117 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3118 "missing '=' after \"%s\"", t->name);
3119 Uskip_whitespace(&s);
3120 nb->string = read_string(s, t->name);
3121 nb->cache_data = NULL;
3123 /* Check the string for any expansions; if any are found, mark this list
3124 uncacheable unless the user has explicited forced caching. */
3126 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3132 /*************************************************
3133 * Unpick data for a rate limit *
3134 *************************************************/
3136 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3140 s string, in the form t,b,f,l
3141 where t is the threshold (integer)
3142 b is the initial delay (time)
3143 f is the multiplicative factor (fixed point)
3144 k is the maximum time (time)
3145 threshold where to store threshold
3146 base where to store base in milliseconds
3147 factor where to store factor in milliseconds
3148 limit where to store limit
3150 Returns: nothing (panics on error)
3154 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3157 uschar bstring[16], lstring[16];
3159 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3160 factor, lstring) == 4)
3162 *base = readconf_readtime(bstring, 0, TRUE);
3163 *limit = readconf_readtime(lstring, 0, TRUE);
3164 if (*base >= 0 && *limit >= 0) return;
3166 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3172 /*************************************************
3173 * Read main configuration options *
3174 *************************************************/
3176 /* This function is the first to be called for configuration reading. It
3177 opens the configuration file and reads general configuration settings until
3178 it reaches the end of the configuration section. The file is then left open so
3179 that the remaining configuration data can subsequently be read if needed for
3182 The configuration file must be owned either by root or exim, and be writeable
3183 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3184 in the config file, so the test is done on the compiled in values. A slight
3185 anomaly, to be carefully documented.
3187 The name of the configuration file is taken from a list that is included in the
3188 binary of Exim. It can be altered from the command line, but if that is done,
3189 root privilege is immediately withdrawn unless the caller is root or exim.
3190 The first file on the list that exists is used.
3192 For use on multiple systems that share file systems, first look for a
3193 configuration file whose name has the current node name on the end. If that is
3194 not found, try the generic name. For really contorted configurations, that run
3195 multiple Exims with different uid settings, first try adding the effective uid
3196 before the node name. These complications are going to waste resources on most
3197 systems. Therefore they are available only when requested by compile-time
3201 readconf_main(BOOL nowarn)
3204 struct stat statbuf;
3205 uschar * s, * filename;
3206 const uschar * list = config_main_filelist;
3208 /* Loop through the possible file names */
3210 /* Should never be a tainted list */
3211 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3214 /* Cut out all the fancy processing unless specifically wanted */
3216 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3217 uschar *suffix = filename + Ustrlen(filename);
3219 /* Try for the node-specific file if a node name exists */
3221 # ifdef CONFIGURE_FILE_USE_NODE
3223 if (uname(&uts) >= 0)
3225 # ifdef CONFIGURE_FILE_USE_EUID
3226 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3227 if (!(config_file = Ufopen(filename, "rb")))
3228 # endif /* CONFIGURE_FILE_USE_EUID */
3230 sprintf(CS suffix, ".%.256s", uts.nodename);
3231 config_file = Ufopen(filename, "rb");
3234 # endif /* CONFIGURE_FILE_USE_NODE */
3236 /* Otherwise, try the generic name, possibly with the euid added */
3238 # ifdef CONFIGURE_FILE_USE_EUID
3241 sprintf(CS suffix, ".%ld", (long int)original_euid);
3242 config_file = Ufopen(filename, "rb");
3244 # endif /* CONFIGURE_FILE_USE_EUID */
3246 /* Finally, try the unadorned name */
3251 config_file = Ufopen(filename, "rb");
3253 #else /* if neither defined */
3255 /* This is the common case when the fancy processing is not included. */
3257 config_file = Ufopen(filename, "rb");
3260 /* If the file does not exist, continue to try any others. For any other
3261 error, break out (and die). */
3263 if (config_file || errno != ENOENT) break;
3266 /* On success, save the name for verification; config_filename is used when
3267 logging configuration errors (it changes for .included files) whereas
3268 config_main_filename is the name shown by -bP. Failure to open a configuration
3269 file is a serious disaster. */
3273 uschar *last_slash = Ustrrchr(filename, '/');
3274 config_filename = config_main_filename = string_copy(filename);
3276 /* The config_main_directory we need for the $config_dir expansion.
3277 config_main_filename we need for $config_file expansion.
3278 And config_dir is the directory of the current configuration, used for
3279 relative .includes. We do need to know it's name, as we change our working
3282 if (filename[0] == '/')
3283 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3286 /* relative configuration file name: working dir + / + basename(filename) */
3288 uschar buf[PATH_MAX];
3291 if (os_getcwd(buf, PATH_MAX) == NULL)
3293 perror("exim: getcwd");
3294 exim_exit(EXIT_FAILURE);
3296 g = string_cat(NULL, buf);
3298 /* If the dir does not end with a "/", append one */
3299 if (gstring_last_char(g) != '/')
3300 g = string_catn(g, US"/", 1);
3302 /* If the config file contains a "/", extract the directory part */
3304 g = string_catn(g, filename, last_slash - filename);
3306 config_main_directory = string_from_gstring(g);
3308 config_directory = config_main_directory;
3312 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3313 "%s", config_main_filelist);
3315 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
3316 string_open_failed("configuration file %s", filename));
3318 /* Now, once we found and opened our configuration file, we change the directory
3319 to a safe place. Later we change to $spool_directory. */
3321 if (Uchdir("/") < 0)
3323 perror("exim: chdir `/': ");
3324 exim_exit(EXIT_FAILURE);
3327 /* Check the status of the file we have opened, if we have retained root
3328 privileges and the file isn't /dev/null (which *should* be 0666). */
3330 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3332 if (fstat(fileno(config_file), &statbuf) != 0)
3333 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3336 if ( statbuf.st_uid != root_uid /* owner not root */
3337 #ifdef CONFIGURE_OWNER
3338 && statbuf.st_uid != config_uid /* owner not the special one */
3341 statbuf.st_gid != root_gid /* group not root & */
3342 #ifdef CONFIGURE_GROUP
3343 && statbuf.st_gid != config_gid /* group not the special one */
3345 && (statbuf.st_mode & 020) != 0 /* group writeable */
3347 (statbuf.st_mode & 2) != 0 /* world writeable */
3349 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3350 "wrong owner, group, or mode", big_buffer);
3352 /* Do a dummy store-allocation of a size related to the (toplevel) file size.
3353 This assumes we will need this much storage to handle all the allocations
3354 during startup; it won't help when .include is being used. When it does, it
3355 will cut down on the number of store blocks (and malloc calls, and sbrk
3356 syscalls). It also assume we're on the relevant pool. */
3358 if (statbuf.st_size > 8192)
3360 rmark r = store_mark();
3361 void * dummy = store_get((int)statbuf.st_size, GET_UNTAINTED);
3366 /* Process the main configuration settings. They all begin with a lower case
3367 letter. If we see something starting with an upper case letter, it is taken as
3368 a macro definition. */
3370 while ((s = get_config_line()))
3375 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3376 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3377 "found unexpected BOM (Byte Order Mark)");
3381 if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE);
3385 t = (hide = Ustrncmp(s, "hide", 4) == 0 && isspace(s[4])) ? s + 5 : s;
3387 if (Ustrncmp(t, "domainlist", 10) == 0)
3388 read_named_list(&domainlist_anchor, &domainlist_count,
3389 MAX_NAMED_LIST, t+10, US"domain list", hide);
3391 else if (Ustrncmp(t, "hostlist", 8) == 0)
3392 read_named_list(&hostlist_anchor, &hostlist_count,
3393 MAX_NAMED_LIST, t+8, US"host list", hide);
3395 else if (Ustrncmp(t, "addresslist", 11) == 0)
3396 read_named_list(&addresslist_anchor, &addresslist_count,
3397 MAX_NAMED_LIST, t+11, US"address list", hide);
3399 else if (Ustrncmp(t, "localpartlist", 13) == 0)
3400 read_named_list(&localpartlist_anchor, &localpartlist_count,
3401 MAX_NAMED_LIST, t+13, US"local part list", hide);
3404 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3405 NULL, US"main option \"%s\" unknown");
3409 /* If local_sender_retain is set, local_from_check must be unset. */
3411 if (local_sender_retain && local_from_check)
3412 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3413 "local_sender_retain are set; this combination is not allowed");
3415 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3418 if (timezone_string && !*timezone_string) timezone_string = NULL;
3420 /* The max retry interval must not be greater than 24 hours. */
3422 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3424 /* remote_max_parallel must be > 0 */
3426 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3428 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3429 start of a new SMTP message. */
3431 freeze_tell_config = freeze_tell;
3433 /* The primary host name may be required for expansion of spool_directory
3434 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3435 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3436 canonize it. Some people like upper case letters in their host names, so we
3437 don't force the case. */
3439 if (!primary_hostname)
3441 const uschar * hostname;
3444 if (uname(&uts) < 0)
3445 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3446 hostname = US uts.nodename;
3448 if (Ustrchr(hostname, '.') == NULL)
3451 struct hostent *hostdata;
3455 && ( !dns_ipv4_lookup
3456 || match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3457 MCL_DOMAIN, TRUE, NULL) != OK))
3464 # if HAVE_GETIPNODEBYNAME
3466 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3468 hostdata = gethostbyname2(CS hostname, af);
3471 hostdata = gethostbyname(CS hostname);
3475 { hostname = US hostdata->h_name; break; }
3477 if (af == AF_INET) break;
3482 primary_hostname = string_copy(hostname);
3485 /* Set up default value for smtp_active_hostname */
3487 smtp_active_hostname = primary_hostname;
3489 /* If spool_directory wasn't set in the build-time configuration, it must have
3490 got set above. Of course, writing to the log may not work if log_file_path is
3491 not set, but it will at least get to syslog or somewhere, with any luck. */
3493 if (!*spool_directory)
3494 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3497 /* Expand the spool directory name; it may, for example, contain the primary
3498 host name. Same comment about failure. */
3500 if (!(s = expand_string(spool_directory)))
3501 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3502 "\"%s\": %s", spool_directory, expand_string_message);
3503 spool_directory = s;
3505 /* Expand log_file_path, which must contain "%s" in any component that isn't
3506 the null string or "syslog". It is also allowed to contain one instance of %D
3507 or %M. However, it must NOT contain % followed by anything else. */
3511 const uschar *ss, *sss;
3512 int sep = ':'; /* Fixed for log file path */
3513 if (!(s = expand_string(log_file_path)))
3514 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3515 "\"%s\": %s", log_file_path, expand_string_message);
3518 /* should never be a tainted list */
3519 while ((sss = string_nextinlist(&ss, &sep, big_buffer, big_buffer_size)))
3522 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3523 if (!(t = Ustrstr(sss, "%s")))
3524 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3525 "contain \"%%s\"", sss);
3527 if ((t = Ustrchr(sss, '%')))
3528 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3529 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3530 "unexpected \"%%\" character", s);
3536 /* Interpret syslog_facility into an integer argument for 'ident' param to
3537 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3540 if (syslog_facility_str)
3543 uschar * s = syslog_facility_str;
3545 if ((Ustrlen(syslog_facility_str) >= 4) &&
3546 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3549 for (i = 0; i < syslog_list_size; i++)
3550 if (strcmpic(s, syslog_list[i].name) == 0)
3552 syslog_facility = syslog_list[i].value;
3556 if (i >= syslog_list_size)
3557 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3558 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3561 /* Expand pid_file_path */
3565 const uschar * t = expand_cstring(pid_file_path);
3567 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3568 "\"%s\": %s", pid_file_path, expand_string_message);
3572 /* Set default value of process_log_path */
3574 if (!process_log_path || !*process_log_path)
3575 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3577 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3580 regex_From = regex_must_compile(uucp_from_pattern, MCS_NOFLAGS, TRUE);
3582 /* Unpick the SMTP rate limiting options, if set */
3584 if (smtp_ratelimit_mail)
3585 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3586 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3588 if (smtp_ratelimit_rcpt)
3589 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3590 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3592 /* The qualify domains default to the primary host name */
3594 if (!qualify_domain_sender)
3595 qualify_domain_sender = primary_hostname;
3596 if (!qualify_domain_recipient)
3597 qualify_domain_recipient = qualify_domain_sender;
3599 /* Setting system_filter_user in the configuration sets the gid as well if a
3600 name is given, but a numerical value does not. */
3602 if (system_filter_uid_set && !system_filter_gid_set)
3604 struct passwd *pw = getpwuid(system_filter_uid);
3606 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3607 (long int)system_filter_uid);
3608 system_filter_gid = pw->pw_gid;
3609 system_filter_gid_set = TRUE;
3612 /* If the errors_reply_to field is set, check that it is syntactically valid
3613 and ensure it contains a domain. */
3615 if (errors_reply_to)
3618 int start, end, domain;
3619 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3620 &start, &end, &domain, FALSE);
3623 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3624 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3627 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3628 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3631 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3632 smtp_accept_max must also be set. */
3634 if (smtp_accept_max == 0 && (smtp_accept_queue > 0 || smtp_accept_max_per_host))
3635 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3636 "smtp_accept_max must be set if smtp_accept_queue or "
3637 "smtp_accept_max_per_host is set");
3639 /* Set up the host number if anything is specified. It is an expanded string
3640 so that it can be computed from the host name, for example. We do this last
3641 so as to ensure that everything else is set up before the expansion. */
3643 if (host_number_string)
3647 uschar *s = expand_string(host_number_string);
3650 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3651 "failed to expand localhost_number \"%s\": %s",
3652 host_number_string, expand_string_message);
3653 n = Ustrtol(s, &end, 0);
3654 if (Uskip_whitespace(&end))
3655 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3656 "localhost_number value is not a number: %s", s);
3657 if (n > LOCALHOST_MAX)
3658 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3659 "localhost_number is greater than the maximum allowed value (%d)",
3665 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3667 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3668 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3669 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3670 tls_verify_hosts ? "" : "try_");
3672 /* Magic number: at time of writing, 1024 has been the long-standing value
3673 used by so many clients, and what Exim used to use always, that it makes
3674 sense to just min-clamp this max-clamp at that. */
3675 if (tls_dh_max_bits < 1024)
3676 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3677 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3679 /* If openssl_options is set, validate it */
3680 if (openssl_options)
3683 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3684 "openssl_options is set but we're using GnuTLS");
3687 if (!tls_openssl_options_parse(openssl_options, &dummy))
3688 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3689 "openssl_options parse error: %s", openssl_options);
3692 #endif /*DISABLE_TLS*/
3694 if (!nowarn && !keep_environment && environ && *environ)
3695 log_write(0, LOG_MAIN,
3696 "Warning: purging the environment.\n"
3697 " Suggested action: use keep_environment.");
3702 /*************************************************
3703 * Initialize one driver *
3704 *************************************************/
3706 /* This is called once the driver's generic options, if any, have been read.
3707 We can now find the driver, set up defaults for the private options, and
3708 unset any "set" bits in the private options table (which might have been
3709 set by another incarnation of the same driver).
3712 d pointer to driver instance block, with generic
3714 drivers_available vector of available drivers
3715 size_of_info size of each block in drivers_available
3716 class class of driver, for error message
3718 Returns: pointer to the driver info block
3721 static driver_info *
3722 init_driver(driver_instance * d, driver_info * drivers_available,
3723 int size_of_info, const uschar * class)
3725 /*XXX if dynamic, the _info entry will be here but code may or may not
3726 be loaded. How to tell? What's the entry point? init call?
3727 Currently that is IN the _info entry.
3729 For lookups it does it by pulling the info entry out of the dlopen()d
3730 file (for dynamic) or direct from the lookup .o file (for static).
3731 It builds a linked-list with those two classes,
3732 then an array sorted by (? name) and discards the list.
3733 The array is the _info list.
3735 We'd rather not have to do two passes over the config file(s) section.
3736 With the number of drivers I see no point in sorting,
3737 so we could stick with a one-pass build of an _info linked-list.
3738 This does mean converting any code using the current array.
3741 Rename the array to old. For now, walk it once and build a linked-list.
3742 Find and convert all the uses,
3744 Move all the element defns to driver code files.
3745 Change the init/build to scan them.
3747 Move the scan to the place-of-use reading the config,
3748 only load if not already on linked-list.
3750 Add the build-dynamic wrapper,
3751 and scan from dlopen if marked dynamic.
3755 /*XXX walk the old array */
3756 for (driver_info * dd = drivers_available; dd->driver_name[0] != 0;
3757 dd = (driver_info *)((US dd) + size_of_info))
3760 for (driver_info * dd = drivers_available; dd; dd = dd->next)
3761 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3763 int len = dd->options_len;
3765 d->options_block = store_get_perm(len, GET_UNTAINTED);
3766 memcpy(d->options_block, dd->options_block, len);
3767 for (int i = 0; i < *dd->options_count; i++)
3768 dd->options[i].type &= ~opt_set;
3772 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3773 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3775 return NULL; /* never obeyed */
3782 driver_init_fini(driver_instance * d, const uschar * class)
3784 driver_info * di = d->info;
3786 if (!d->driver_name)
3787 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3788 "no driver defined for %s \"%s\"", class, d->name);
3793 /*************************************************
3794 * Initialize driver list *
3795 *************************************************/
3797 /* This function is called for routers, transports, and authentication
3798 mechanisms. It reads the data from the current point in the configuration file
3799 up to the end of the section, and sets up a chain of instance blocks according
3800 to the file's contents. The file will already have been opened by a call to
3801 readconf_main, and must be left open for subsequent reading of further data.
3803 Any errors cause a panic crash. Note that the blocks with names driver_info and
3804 driver_instance must map the first portions of all the _info and _instance
3805 blocks for this shared code to work.
3808 anchor &routers, &transports, &auths
3809 drivers_available available drivers
3810 size_of_info size of each info block
3811 instance_default points to default data for an instance
3812 instance_size size of instance block
3813 driver_optionlist generic option list
3814 driver_optionlist_count count of generic option list
3815 class "router", "transport", or "authenticator"
3822 readconf_driver_init(
3823 driver_instance ** anchor,
3824 driver_info * drivers_available, /*XXX now list not array */
3826 void * instance_default,
3828 optionlist * driver_optionlist,
3829 int driver_optionlist_count,
3830 const uschar * class)
3832 driver_instance ** p = anchor;
3833 driver_instance * d = NULL;
3836 while ((buffer = get_config_line()))
3838 uschar name[EXIM_DRIVERNAME_MAX];
3841 /* Read the first name on the line and test for the start of a new driver. A
3842 macro definition indicates the end of the previous driver. If this isn't the
3843 start of a new driver, the line will be re-read. */
3845 s = readconf_readname(name, sizeof(name), buffer);
3847 /* Handle macro definition, first finishing off the initialization of the
3848 previous driver, if any. */
3850 if (isupper(*name) && *s == '=')
3854 /* s is using big_buffer, so this call had better not */
3855 driver_init_fini(d, class);
3858 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE);
3862 /* If the line starts with a name terminated by a colon, we are at the
3863 start of the definition of a new driver. The rest of the line must be
3868 /* Finish off initializing the previous driver. */
3871 driver_init_fini(d, class);
3873 /* Check that we haven't already got a driver of this name */
3875 for (d = *anchor; d; d = d->next)
3876 if (Ustrcmp(name, d->name) == 0)
3877 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3878 "there are two %ss called \"%s\"", class, name);
3880 /* Set up a new driver instance data block on the chain, with
3881 its default values installed. */
3883 d = store_get_perm(instance_size, GET_UNTAINTED);
3884 memcpy(d, instance_default, instance_size);
3886 p = (driver_instance **)&d->next;
3887 d->name = string_copy(name);
3888 d->srcfile = config_filename;
3889 d->srcline = config_lineno;
3891 /* Clear out the "set" bits in the generic options */
3893 for (int i = 0; i < driver_optionlist_count; i++)
3894 driver_optionlist[i].type &= ~opt_set;
3896 /* Check nothing more on this line, then do the next loop iteration. */
3898 Uskip_whitespace(&s);
3899 if (*s) extra_chars_error(s, US"driver name ", name, US"");
3903 /* Not the start of a new driver. Give an error if we have not set up a
3904 current driver yet. */
3907 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3909 /* First look to see if this is a generic option; if it is "driver",
3910 initialize the driver. If is it not a generic option, we can look for a
3911 private option provided that the driver has been previously set up. */
3913 if (readconf_handle_option(buffer, driver_optionlist,
3914 driver_optionlist_count, d, NULL))
3916 if (!d->info && d->driver_name)
3917 init_driver(d, drivers_available, size_of_info, class);
3920 /* Handle private options - pass the generic block because some may
3921 live therein. A flag with each option indicates if it is in the public
3926 driver_info * di = d->info;
3927 readconf_handle_option(buffer, di->options,
3928 *di->options_count, d, US"option \"%s\" unknown");
3931 /* The option is not generic and the driver name has not yet been given. */
3933 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3934 "(\"driver\" must be specified before any private options)", name);
3937 /* Run the initialization function for the final driver. */
3940 driver_init_fini(d, class);
3945 /*************************************************
3946 * Check driver dependency *
3947 *************************************************/
3949 /* This function is passed a driver instance and a string. It checks whether
3950 any of the string options for the driver contains the given string as an
3954 d points to a driver instance block
3955 s the string to search for
3957 Returns: TRUE if a dependency is found
3961 readconf_depends(driver_instance * d, uschar * s)
3963 driver_info * di = d->info;
3964 int count = *di->options_count;
3967 for (optionlist * ol = di->options; ol < di->options + count; ol++)
3968 if ((ol->type & opt_mask) == opt_stringptr)
3970 void * options_block = ol->type & opt_public ? (void *)d : d->options_block;
3971 uschar * value = *USS(US options_block + ol->v.offset);
3973 if (value && (ss = Ustrstr(value, s)) != NULL)
3975 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3976 isalnum(ss[Ustrlen(s)])) continue;
3977 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3978 d->name, ol->name, s);
3983 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3990 /*************************************************
3991 * Decode an error type for retries *
3992 *************************************************/
3994 /* This function is global because it is also called from the main
3995 program when testing retry information. It decodes strings such as "quota_7d"
3996 into numerical error codes.
3999 pp points to start of text
4000 p points past end of text
4001 basic_errno points to an int to receive the main error number
4002 more_errno points to an int to receive the secondary error data
4004 Returns: NULL if decoded correctly; else points to error text
4008 readconf_retry_error(const uschar *pp, const uschar *p,
4009 int *basic_errno, int *more_errno)
4012 const uschar *q = pp;
4013 while (q < p && *q != '_') q++;
4016 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
4018 *basic_errno = ERRNO_EXIMQUOTA;
4019 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
4020 return US"bad time value";
4023 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
4025 *basic_errno = ECONNREFUSED;
4028 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
4029 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
4030 else return US"A or MX expected after \"refused\"";
4034 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
4036 *basic_errno = ETIMEDOUT;
4040 int xlen = p - q - 1;
4041 const uschar *x = q + 1;
4043 static uschar *extras[] =
4044 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
4045 static int values[] =
4046 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
4048 for (i = 0; i < nelem(extras); i++)
4049 if (strncmpic(x, extras[i], xlen) == 0)
4051 *more_errno = values[i];
4055 if (i >= nelem(extras))
4056 if (strncmpic(x, US"DNS", xlen) == 0)
4057 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
4058 "available in retry rules (it has never worked) - treated as "
4061 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
4065 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
4066 strncmpic(pp, US"rcpt_4", 6) == 0 ||
4067 strncmpic(pp, US"data_4", 6) == 0)
4070 int x = 255; /* means "any 4xx code" */
4071 if (p != pp + 8) bad = TRUE; else
4073 int a = pp[6], b = pp[7];
4077 if (isdigit(b)) x += b - '0';
4078 else if (b == 'x') x += 100;
4081 else if (a != 'x' || b != 'x') bad = TRUE;
4085 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
4086 "x is literal and d is any digit", pp);
4088 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4089 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4090 *more_errno = x << 8;
4093 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4094 strncmpic(q+1, US"failed", p-q-1) == 0)
4095 *basic_errno = ERRNO_AUTHFAIL;
4097 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4098 *basic_errno = ERRNO_SMTPCLOSED;
4100 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4101 *basic_errno = ERRNO_TLSREQUIRED;
4103 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4104 *basic_errno = ERRNO_UNKNOWNHOST;
4106 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4107 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4115 /*************************************************
4116 * Read retry information *
4117 *************************************************/
4119 /* Each line of retry information contains:
4121 . A domain name pattern or an address pattern;
4123 . An error name, possibly with additional data, or *;
4125 . An optional sequence of retry items, each consisting of an identifying
4126 letter, a cutoff time, and optional parameters.
4128 All this is decoded and placed into a control block. */
4131 /* Subroutine to read an argument, preceded by a comma and terminated
4132 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4133 1 = fixed point number (returned *1000).
4136 paddr pointer to pointer to current character; updated
4137 type 0 => read a time; 1 => read a fixed point number
4139 Returns: time in seconds or fixed point number * 1000
4143 retry_arg(const uschar ** paddr, int type)
4145 const uschar * p = *paddr, * pp;
4147 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4149 Uskip_whitespace(&p);
4151 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4153 if (*p && !isspace(*p) && *p != ',' && *p != ';')
4154 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4159 case 0: return readconf_readtime(pp, *p, FALSE);
4160 case 1: return readconf_readfixed(pp, *p);
4162 return 0; /* Keep picky compilers happy */
4165 /* The function proper */
4168 readconf_retries(void)
4170 retry_config **chain = &retries;
4174 while ((p = get_config_line()))
4176 retry_rule **rchain;
4180 next = store_get(sizeof(retry_config), GET_UNTAINTED);
4183 chain = &(next->next);
4184 next->basic_errno = next->more_errno = 0;
4185 next->senders = NULL;
4187 rchain = &(next->rules);
4189 next->pattern = string_dequote(&p);
4190 Uskip_whitespace(&p);
4192 while (mac_isgraph(*p)) p++;
4193 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4194 "missing error type in retry rule");
4196 /* Test error names for things we understand. */
4198 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4199 &next->more_errno)))
4200 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4202 /* There may be an optional address list of senders to be used as another
4203 constraint on the rule. This was added later, so the syntax is a bit of a
4204 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4207 Uskip_whitespace(&p);
4208 if (Ustrncmp(p, "senders", 7) == 0)
4211 Uskip_whitespace(&p);
4212 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4213 "\"=\" expected after \"senders\" in retry rule");
4214 Uskip_whitespace(&p);
4215 next->senders = string_dequote(&p);
4218 /* Now the retry rules. Keep the maximum timeout encountered. */
4220 Uskip_whitespace(&p);
4224 retry_rule * rule = store_get(sizeof(retry_rule), GET_UNTAINTED);
4226 rchain = &(rule->next);
4228 rule->rule = toupper(*p++);
4229 rule->timeout = retry_arg(&p, 0);
4230 if (rule->timeout > retry_maximum_timeout)
4231 retry_maximum_timeout = rule->timeout;
4235 case 'F': /* Fixed interval */
4236 rule->p1 = retry_arg(&p, 0);
4239 case 'G': /* Geometrically increasing intervals */
4240 case 'H': /* Ditto, but with randomness */
4241 rule->p1 = retry_arg(&p, 0);
4242 rule->p2 = retry_arg(&p, 1);
4246 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4250 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4251 (rule->rule != 'F' && rule->p2 < 1000))
4252 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4253 "bad parameters for retry rule");
4255 if (Uskip_whitespace(&p) == ';')
4258 Uskip_whitespace(&p);
4261 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4268 /*************************************************
4269 * Initialize authenticators *
4270 *************************************************/
4272 /* Read the authenticators section of the configuration file.
4281 #ifndef DISABLE_PIPE_CONNECT
4285 /*XXX temp loop just copying the old array to build the new list.
4286 Will replace with haul from either static build file or dyn module
4287 done by readconf_driver_init() */
4288 for (auth_info * tblent = auths_available_oldarray;
4289 *tblent->drinfo.driver_name; tblent++)
4291 driver_info * listent = store_get(sizeof(auth_info), tblent);
4292 memcpy(listent, tblent, sizeof(auth_info));
4293 listent->next = (driver_info *)auths_available_newlist;
4294 auths_available_newlist = (auth_info *)listent;
4298 readconf_driver_init((driver_instance **)&auths, /* chain anchor */
4299 (driver_info *)auths_available_newlist, /* available drivers */
4300 sizeof(auth_info), /* size of info block */
4301 &auth_defaults, /* default values for generic options */
4302 sizeof(auth_instance), /* size of instance block */
4303 optionlist_auths, /* generic options */
4304 optionlist_auths_size,
4307 for (auth_instance * au = auths; au; au = au->drinst.next)
4309 if (!au->public_name)
4310 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4311 "the %s authenticator", au->drinst.name);
4313 for (auth_instance * bu = au->drinst.next; bu; bu = bu->drinst.next)
4314 if (strcmpic(au->public_name, bu->public_name) == 0)
4315 if ( au->client && bu->client
4316 || au->server && bu->server)
4317 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4318 "(%s and %s) have the same public name (%s)",
4319 au->client && bu->client ? US"client" : US"server",
4320 au->drinst.name, bu->drinst.name, au->public_name);
4321 #ifndef DISABLE_PIPE_CONNECT
4325 #ifndef DISABLE_PIPE_CONNECT
4326 f.smtp_in_early_pipe_no_auth = nauths > 16;
4331 /* For error messages, a string describing the config location associated
4332 with current processing. NULL if we are not in an authenticator. */
4335 authenticator_current_name(void)
4337 if (!authenticator_name) return NULL;
4338 return string_sprintf(" (authenticator %s, %s %d)", authenticator_name, driver_srcfile, driver_srcline);
4345 /*************************************************
4346 * Read ACL information *
4347 *************************************************/
4349 /* If this run of Exim is not doing something that involves receiving a
4350 message, we can just skip over the ACL information. No need to parse it.
4352 First, we have a function for acl_read() to call back to get the next line. We
4353 need to remember the line we passed, because at the end it will contain the
4354 name of the next ACL. */
4356 static uschar *acl_line;
4361 acl_line = get_config_line();
4366 /* Now the main function:
4375 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4378 acl_line = get_config_line();
4382 uschar name[EXIM_DRIVERNAME_MAX];
4385 const uschar * p = readconf_readname(name, sizeof(name), acl_line);
4387 if (isupper(*name) && *p == '=')
4389 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE);
4390 acl_line = get_config_line();
4394 if (*p != ':' || name[0] == 0)
4395 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4397 node = store_get_perm(sizeof(tree_node) + Ustrlen(name), name);
4398 Ustrcpy(node->name, name);
4399 if (!tree_insertnode(&acl_anchor, node))
4400 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4401 "there are two ACLs called \"%s\"", name);
4403 node->data.ptr = acl_read(acl_callback, &error);
4405 if (node->data.ptr == NULL && error != NULL)
4406 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4412 /*************************************************
4413 * Read configuration for local_scan() *
4414 *************************************************/
4416 /* This function is called after "begin local_scan" is encountered in the
4417 configuration file. If the local_scan() function allows for configuration
4418 options, we can process them. Otherwise, we expire in a panic.
4425 local_scan_init(void)
4427 #ifndef LOCAL_SCAN_HAS_OPTIONS
4428 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4429 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4433 while ((p = get_config_line()))
4434 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4435 NULL, US"local_scan option \"%s\" unknown");
4441 /*************************************************
4442 * Read rest of configuration (after main) *
4443 *************************************************/
4445 /* This function reads the rest of the runtime configuration, after the main
4446 configuration. It is called only when actually needed. Each subsequent section
4447 of the configuration starts with a line of the form
4451 where the name is "routers", "transports", etc. A section is terminated by
4452 hitting the next "begin" line, and the next name is left in next_section.
4453 Because it may confuse people as to whether the names are singular or plural,
4454 we add "s" if it's missing. There is always enough room in next_section for
4455 this. This function is basically just a switch.
4461 static uschar *section_list[] = {
4475 while(next_section[0] != 0)
4479 int last = nelem(section_list);
4481 int n = Ustrlen(next_section);
4483 READCONF_DEBUG fprintf(stderr, "%s: %s\n", __FUNCTION__, next_section);
4484 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, US"s");
4488 int c = strcmpic(next_section, section_list[mid]);
4490 if (c > 0) first = mid + 1; else last = mid;
4492 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4493 "\"%.*s\" is not a known configuration section name", n, next_section);
4494 mid = (last + first)/2;
4498 if (((had ^= bit) & bit) == 0)
4499 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4500 "\"%.*s\" section is repeated in the configuration file", n,
4505 case 0: readconf_acl(); break;
4506 case 1: auths_init(); break;
4507 case 2: local_scan_init(); break;
4508 case 3: readconf_retries(); break;
4509 case 4: readconf_rewrites(); break;
4510 case 5: route_init(); break;
4511 case 6: transport_init(); break;
4515 (void)fclose(config_file);
4518 /* Init the storage for the pre-parsed config lines */
4520 readconf_save_config(const uschar *s)
4522 save_config_line(string_sprintf("# Exim Configuration (%s)",
4523 f.running_in_test_harness ? US"X" : s));
4527 save_config_position(const uschar *file, int line)
4529 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4532 /* Append a pre-parsed logical line to the config lines store,
4533 this operates on a global (static) list that holds all the pre-parsed
4534 config lines, we do no further processing here, output formatting and
4535 honouring of <hide> or macros will be done during output */
4538 save_config_line(const uschar* line)
4540 static config_line_item *current;
4541 config_line_item *next;
4543 next = (config_line_item*) store_get(sizeof(config_line_item), GET_UNTAINTED);
4544 next->line = string_copy(line);
4547 if (!config_lines) config_lines = next;
4548 else current->next = next;
4553 /* List the parsed config lines, care about nice formatting and
4554 hide the <hide> values unless we're the admin user */
4556 print_config(BOOL admin, BOOL terse)
4558 const int TS = terse ? 0 : 2;
4562 for (const config_line_item * i = config_lines; i; i = i->next)
4564 uschar * current, * p;
4566 if (r) store_reset(r);
4569 /* skip over to the first non-space */
4570 current = string_copy(i->line);
4571 if (!Uskip_whitespace(¤t))
4574 /* Collapse runs of spaces. We stop this if we encounter one of the
4575 following characters: "'$, as this may indicate careful formatting */
4577 for (p = current; *p; p++) if (isspace(*p))
4580 if (*p != ' ') *p = ' ';
4582 Uskip_whitespace(&p);
4585 memmove(p+1, next, Ustrlen(next)+1);
4587 if (*next == '"' || *next == '\'' || *next == '$')
4592 if (current[0] == '#')
4595 /* begin lines are left aligned */
4596 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4598 if (!terse) puts("");
4603 /* router/acl/transport block names */
4604 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4606 if (!terse) puts("");
4607 printf("%*s%s\n", TS, "", current);
4611 /* hidden lines (all MACROS or lines prefixed with "hide") */
4613 && ( isupper(*current)
4614 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4618 if ((p = Ustrchr(current, '=')))
4621 printf("%*s%s= %s\n", indent, "", current, CCS hidden);
4623 /* e.g.: hide split_spool_directory */
4625 printf("%*s\n", indent, CCS hidden);
4629 /* rest is public */
4630 printf("%*s%s\n", indent, "", current);
4632 if (r) store_reset(r);
4635 #endif /*!MACRO_PREDEF*/
4638 /* End of readconf.c */