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);
438 for (driver_info * di = (driver_info *)auths_available; di; di = di->next)
440 auth_info * ai = (auth_info *)di;
442 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", di->driver_name);
443 builtin_macro_create(buf);
444 options_from_list(di->options, (unsigned)*di->options_count,
445 US"AUTHENTICATOR", di->driver_name);
447 if (ai->macros_create) (ai->macros_create)();
452 options_logging(void)
454 uschar buf[EXIM_DRIVERNAME_MAX];
456 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
458 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
459 builtin_macro_create(buf);
464 #else /*!MACRO_PREDEF*/
466 extern char **environ;
468 static void save_config_line(const uschar* line);
469 static void save_config_position(const uschar *file, int line);
470 static void print_config(BOOL admin, BOOL terse);
473 #define CSTATE_STACK_SIZE 10
475 const uschar *config_directory = NULL;
478 /* Structure for chain (stack) of .included files */
480 typedef struct config_file_item {
481 struct config_file_item *next;
482 const uschar *filename;
483 const uschar *directory;
488 /* Structure for chain of configuration lines (-bP config) */
490 typedef struct config_line_item {
491 struct config_line_item *next;
495 static config_line_item* config_lines;
497 /* Structure of table of conditional words and their state transitions */
499 typedef struct cond_item {
507 /* Structure of table of syslog facility names and values */
509 typedef struct syslog_fac_item {
515 static const uschar * const hidden = US"<value not displayable>";
517 /* Static variables */
519 static config_file_item *config_file_stack = NULL; /* For includes */
521 static uschar *syslog_facility_str = NULL;
522 static uschar next_section[24];
523 static uschar time_buffer[24];
525 /* State variables for conditional loading (.ifdef / .else / .endif) */
527 static int cstate = 0;
528 static int cstate_stack_ptr = -1;
529 static int cstate_stack[CSTATE_STACK_SIZE];
531 /* Table of state transitions for handling conditional inclusions. There are
532 four possible state transitions:
536 .elifdef true (or .else)
539 .endif just causes the previous cstate to be popped off the stack */
541 static int next_cstate[3][4] =
543 /* State 0: reading from file, or reading until next .else or .endif */
545 /* State 1: condition failed, skipping until next .else or .endif */
547 /* State 2: skipping until .endif */
551 /* Table of conditionals and the states to set. For each name, there are four
552 values: the length of the name (to save computing it each time), the state to
553 set if a macro was found in the line, the state to set if a macro was not found
554 in the line, and a stack manipulation setting which is:
556 -1 pull state value off the stack
557 0 don't alter the stack
558 +1 push value onto stack, before setting new state
561 static cond_item cond_list[] = {
562 { US"ifdef", 5, 0, 1, 1 },
563 { US"ifndef", 6, 1, 0, 1 },
564 { US"elifdef", 7, 2, 3, 0 },
565 { US"elifndef", 8, 3, 2, 0 },
566 { US"else", 4, 2, 2, 0 },
567 { US"endif", 5, 0, 0, -1 }
570 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
572 /* Table of syslog facility names and their values */
574 static syslog_fac_item syslog_list[] = {
575 { US"mail", LOG_MAIL },
576 { US"user", LOG_USER },
577 { US"news", LOG_NEWS },
578 { US"uucp", LOG_UUCP },
579 { US"local0", LOG_LOCAL0 },
580 { US"local1", LOG_LOCAL1 },
581 { US"local2", LOG_LOCAL2 },
582 { US"local3", LOG_LOCAL3 },
583 { US"local4", LOG_LOCAL4 },
584 { US"local5", LOG_LOCAL5 },
585 { US"local6", LOG_LOCAL6 },
586 { US"local7", LOG_LOCAL7 },
587 { US"daemon", LOG_DAEMON }
590 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
593 #define opt_fn_print BIT(0)
594 #define opt_fn_print_label BIT(1)
597 /*************************************************
598 * Find the name of an option *
599 *************************************************/
601 /* This function is to aid debugging. Various functions take arguments that are
602 pointer variables in the options table or in option tables for various drivers.
603 For debugging output, it is useful to be able to find the name of the option
604 which is currently being processed. This function finds it, if it exists, by
605 searching the table(s) for a value with the given content.
607 Arguments: a value that is presumed to be in the table above
608 Returns: the option name, or an empty string
612 readconf_find_option(void * listptr)
614 uschar * list = * USS listptr;
615 const uschar * name = NULL, * drname = NULL;
617 for (optionlist * o = optionlist_config; /* main-config options */
618 o < optionlist_config + optionlist_config_size; o++)
619 if (listptr == o->v.value)
623 for (const driver_instance * rd = (driver_instance *)routers;
624 rd; rd = rd->next) if (Ustrcmp(rd->name, router_name) == 0)
626 const router_instance * r = (router_instance *)rd;
627 const router_info * ri = (router_info *)rd->info;
629 /* Check for a listptr match first */
631 for (optionlist * o = optionlist_routers; /* generic options */
632 o < optionlist_routers + optionlist_routers_size; o++)
633 if ( (o->type & opt_mask) == opt_stringptr
634 && listptr == CS r + o->v.offset)
637 for (optionlist * o = ri->drinfo.options; /* private options */
638 o < ri->drinfo.options + *ri->drinfo.options_count; o++)
639 if ( (o->type & opt_mask) == opt_stringptr
640 && listptr == CS rd->options_block + o->v.offset)
643 /* Check for a list addr match, unless null */
647 for (optionlist * o = optionlist_routers; /* generic options */
648 o < optionlist_routers + optionlist_routers_size; o++)
649 if ( (o->type & opt_mask) == opt_stringptr
650 && list == * USS(CS r + o->v.offset))
652 return string_sprintf("DUP: %s %s vs. %s %s",
653 drname, name, rd->name, o->name);
655 { name = US o->name; drname = rd->name; }
657 for (optionlist * o = ri->drinfo.options; /* private options */
658 o < ri->drinfo.options + *ri->drinfo.options_count; o++)
659 if ( (o->type & opt_mask) == opt_stringptr
660 && list == * USS(CS rd->options_block + o->v.offset))
662 return string_sprintf("DUP: %s %s vs. %s %s",
663 drname, name, rd->name, o->name);
665 { name = US o->name; drname = rd->name; }
669 for (transport_instance * t = transports; t; t = t->drinst.next)
670 if (Ustrcmp(t->drinst.name, transport_name) == 0)
672 const transport_info * ti = t->drinst.info;
674 /* Check for a listptr match first */
676 for (optionlist * o = optionlist_transports; /* generic options */
677 o < optionlist_transports + optionlist_transports_size; o++)
678 if ( (o->type & opt_mask) == opt_stringptr
679 && listptr == CS t + o->v.offset)
682 for (optionlist * o = ti->drinfo.options; /* private options */
683 o < ti->drinfo.options + *ti->drinfo.options_count; o++)
684 if ( (o->type & opt_mask) == opt_stringptr
685 && listptr == CS t->drinst.options_block + o->v.offset)
688 /* Check for a list addr match, unless null */
692 for (optionlist * o = optionlist_transports; /* generic options */
693 o < optionlist_transports + optionlist_transports_size; o++)
694 if ( (o->type & opt_mask) == opt_stringptr
695 && list == * USS(CS t + o->v.offset))
697 return string_sprintf("DUP: %s %s vs. %s %s",
698 drname, name, t->drinst.name, o->name);
700 { name = US o->name; drname = t->drinst.name; }
702 for (optionlist * o = ti->drinfo.options; /* private options */
703 o < ti->drinfo.options + *ti->drinfo.options_count; o++)
704 if ( (o->type & opt_mask) == opt_stringptr
705 && list == * USS(CS t->drinst.options_block + o->v.offset))
707 return string_sprintf("DUP: %s %s vs. %s %s",
708 drname, name, t->drinst.name, o->name);
710 { name = US o->name; drname = t->drinst.name; }
713 return name ? name : US"";
719 /*************************************************
720 * Deal with an assignment to a macro *
721 *************************************************/
723 /* We have a new definition; append to the list.
726 name Name of the macro; will be copied
727 val Expansion result for the macro; will be copied
731 macro_create(const uschar * name, const uschar * val, BOOL command_line)
733 macro_item * m = store_get(sizeof(macro_item), GET_UNTAINTED);
735 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
737 m->command_line = command_line;
738 m->namelen = Ustrlen(name);
739 m->replen = Ustrlen(val);
740 m->name = string_copy(name);
741 m->replacement = string_copy(val);
753 /* This function is called when a line that starts with an upper case letter is
754 encountered. The argument "line" should contain a complete logical line, and
755 start with the first letter of the macro name. The macro name and the
756 replacement text are extracted and stored. Redefinition of existing,
757 non-command line, macros is permitted using '==' instead of '='.
760 s points to the start of the logical line
762 Returns: FALSE iff fatal error
766 macro_read_assignment(uschar *s)
768 uschar name[EXIM_DRIVERNAME_MAX];
773 while (isalnum(*s) || *s == '_')
775 if (namelen >= sizeof(name) - 1)
777 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
778 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
781 name[namelen++] = *s++;
785 Uskip_whitespace(&s);
788 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
797 Uskip_whitespace(&s);
799 /* If an existing macro of the same name was defined on the command line, we
800 just skip this definition. It's an error to attempt to redefine a macro without
801 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
802 It is also an error to define a macro whose name begins with the name of a
803 previously defined macro. This is the requirement that make using a tree
804 for macros hard; we must check all macros for the substring. Perhaps a
805 sorted list, and a bsearch, would work?
806 Note: it is documented that the other way round works. */
808 for (m = macros; m; m = m->next)
810 if (Ustrcmp(m->name, name) == 0)
812 if (!m->command_line && !redef)
814 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
815 "defined (use \"==\" if you want to redefine it)", name);
821 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
823 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
824 "a macro because previously defined macro \"%s\" is a substring",
829 /* We cannot have this test, because it is documented that a substring
830 macro is permitted (there is even an example).
832 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
833 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
834 * "a macro because it is a substring of previously defined macro \"%s\"",
839 /* Check for an overriding command-line definition. */
841 if (m && m->command_line) return TRUE;
843 /* Redefinition must refer to an existing macro. */
848 m->replen = Ustrlen(s);
849 m->replacement = string_copy(s);
853 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
858 /* We have a new definition. */
860 (void) macro_create(name, s, FALSE);
868 /* Process line for macros. The line is in big_buffer starting at offset len.
869 Expand big_buffer if needed. Handle definitions of new macros, and
870 macro expansions, rewriting the line in the buffer.
873 len Offset in buffer of start of line
874 newlen Pointer to offset of end of line, updated on return
875 macro_found Pointer to return that a macro was expanded
877 Return: pointer to first nonblank char in line
881 macros_expand(int len, int * newlen, BOOL * macro_found)
883 uschar * ss = big_buffer + len;
886 /* Find the true start of the physical line - leading spaces are always
889 Uskip_whitespace(&ss);
891 /* Process the physical line for macros. If this is the start of the logical
892 line, skip over initial text at the start of the line if it starts with an
893 upper case character followed by a sequence of name characters and an equals
894 sign, because that is the definition of a new macro, and we don't do
895 replacement therein. */
898 if (len == 0 && isupper(*s))
900 while (isalnum(*s) || *s == '_') s++;
901 if (Uskip_whitespace(&s) != '=') s = ss; /* Not a macro definition */
904 /* Skip leading chars which cannot start a macro name, to avoid multiple
905 pointless rescans in Ustrstr calls. */
907 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
909 /* For each defined macro, scan the line (from after XXX= if present),
910 replacing all occurrences of the macro. */
912 *macro_found = FALSE;
913 if (*s) for (macro_item * m = *s == '_' ? macros : macros_user; m; m = m->next)
918 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
922 while ((p = Ustrstr(t, m->name)) != NULL)
926 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
927 m->name, (int) Ustrlen(ss)-1, ss);
928 /* Expand the buffer if necessary */
930 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
932 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
933 uschar *newbuffer = store_malloc(newsize);
934 memcpy(newbuffer, big_buffer, *newlen + 1);
935 p = newbuffer + (p - big_buffer);
936 s = newbuffer + (s - big_buffer);
937 ss = newbuffer + (ss - big_buffer);
938 t = newbuffer + (t - big_buffer);
939 big_buffer_size = newsize;
940 store_free(big_buffer);
941 big_buffer = newbuffer;
944 /* Shuffle the remaining characters up or down in the buffer before
945 copying in the replacement text. Don't rescan the replacement for this
949 if ((moveby = m->replen - m->namelen) != 0)
951 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
954 Ustrncpy(p, m->replacement, m->replen);
956 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
961 /* An empty macro replacement at the start of a line could mean that ss no
962 longer points to the first non-blank character. */
964 Uskip_whitespace(&ss);
968 /*************************************************
969 * Read configuration line *
970 *************************************************/
972 /* A logical line of text is read from the configuration file into the big
973 buffer, taking account of macros, .includes, and continuations. The size of
974 big_buffer is increased if necessary. The count of configuration lines is
975 maintained. Physical input lines starting with # (ignoring leading white space,
976 and after macro replacement) and empty logical lines are always ignored.
977 Leading and trailing spaces are removed.
979 If we hit a line of the form "begin xxxx", the xxxx is placed in the
980 next_section vector, and the function returns NULL, indicating the end of a
981 configuration section. On end-of-file, NULL is returned with next_section
986 Returns: a pointer to the first non-blank in the line,
987 or NULL if eof or end of section is reached
991 get_config_line(void)
993 int startoffset = 0; /* To first non-blank char in logical line */
994 int len = 0; /* Of logical line so far */
999 /* Loop for handling continuation lines, skipping comments, and dealing with
1004 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
1006 if (config_file_stack != NULL) /* EOF inside .include */
1008 (void)fclose(config_file);
1009 config_file = config_file_stack->file;
1010 config_filename = config_file_stack->filename;
1011 config_directory = config_file_stack->directory;
1012 config_lineno = config_file_stack->lineno;
1013 config_file_stack = config_file_stack->next;
1015 save_config_position(config_filename, config_lineno);
1019 /* EOF at top level */
1021 if (cstate_stack_ptr >= 0)
1022 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1023 "Unexpected end of configuration file: .endif missing");
1025 if (len != 0) break; /* EOF after continuation */
1026 next_section[0] = 0; /* EOF at start of logical line */
1031 newlen = len + Ustrlen(big_buffer + len);
1033 if (config_lines && config_lineno == 1)
1034 save_config_position(config_filename, config_lineno);
1036 /* Handle pathologically long physical lines - yes, it did happen - by
1037 extending big_buffer at this point. The code also copes with very long
1040 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
1043 big_buffer_size += BIG_BUFFER_SIZE;
1044 newbuffer = store_malloc(big_buffer_size);
1046 /* This use of strcpy is OK because we know that the string in the old
1047 buffer is shorter than the new buffer. */
1049 Ustrcpy(newbuffer, big_buffer);
1050 store_free(big_buffer);
1051 big_buffer = newbuffer;
1052 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
1054 newlen += Ustrlen(big_buffer + newlen);
1057 ss = macros_expand(len, &newlen, ¯o_found);
1059 /* Check for comment lines - these are physical lines. */
1061 if (*ss == '#') continue;
1063 /* Handle conditionals, which are also applied to physical lines. Conditions
1064 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
1065 expansion occurred on the rest of the line. A preliminary test for the leading
1066 '.' saves effort on most lines. */
1072 /* Search the list of conditional directives */
1074 for (i = 0; i < cond_list_size; i++)
1077 cond_item *c = cond_list+i;
1078 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
1080 /* The following character must be white space or end of string */
1082 n = ss[1 + c->namelen];
1083 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
1085 /* .ifdef and .ifndef push the current state onto the stack, then set
1086 a new one from the table. Stack overflow is an error */
1090 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
1091 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1092 ".%s nested too deeply", c->name);
1093 cstate_stack[++cstate_stack_ptr] = cstate;
1094 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
1097 /* For any of the others, stack underflow is an error. The next state
1098 comes either from the stack (.endif) or from the table. */
1102 if (cstate_stack_ptr < 0)
1103 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1104 ".%s without matching .ifdef", c->name);
1105 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1106 next_cstate[cstate][macro_found? c->action1 : c->action2];
1109 /* Having dealt with a directive, break the loop */
1114 /* If we have handled a conditional directive, continue with the next
1115 physical line. Otherwise, fall through. */
1117 if (i < cond_list_size) continue;
1120 /* If the conditional state is not 0 (actively using these lines), ignore
1123 if (cstate != 0) continue; /* Conditional skip */
1125 /* Handle .include lines - these are also physical lines. */
1127 if (Ustrncmp(ss, ".include", 8) == 0 &&
1129 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1132 int include_if_exists = isspace(ss[8]) ? 0 : 10;
1133 config_file_item *save;
1134 struct stat statbuf;
1136 ss += 9 + include_if_exists;
1137 Uskip_whitespace(&ss);
1138 t = ss + Ustrlen(ss);
1139 while (t > ss && isspace(t[-1])) t--;
1140 if (*ss == '\"' && t[-1] == '\"')
1147 /* We allow relative file names. For security reasons currently
1148 relative names not allowed with .include_if_exists. For .include_if_exists
1149 we need to check the permissions/ownership of the containing folder */
1151 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1152 "absolute path \"%s\"", ss);
1155 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1156 ss = string_from_gstring(g);
1159 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1162 save_config_position(config_filename, config_lineno);
1163 save = store_get(sizeof(config_file_item), GET_UNTAINTED);
1164 save->next = config_file_stack;
1165 config_file_stack = save;
1166 save->file = config_file;
1167 save->filename = config_filename;
1168 save->directory = config_directory;
1169 save->lineno = config_lineno;
1171 if (!(config_file = Ufopen(ss, "rb")))
1172 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1173 "configuration file %s", ss);
1175 config_filename = string_copy(ss);
1176 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1181 /* If this is the start of the logical line, remember where the non-blank
1182 data starts. Otherwise shuffle down continuation lines to remove leading
1186 startoffset = ss - big_buffer;
1189 s = big_buffer + len;
1192 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1197 /* Accept the new addition to the line. Remove trailing white space. */
1200 while (len > 0 && isspace(big_buffer[len-1])) len--;
1201 big_buffer[len] = 0;
1203 /* We are done if the line does not end in backslash and contains some data.
1204 Empty logical lines are ignored. For continuations, remove the backslash and
1205 go round the loop to read the continuation line. */
1209 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1210 big_buffer[--len] = 0; /* Remove backslash */
1212 } /* Loop for reading multiple physical lines */
1214 /* We now have a logical line. Test for the end of a configuration section (or,
1215 more accurately, for the start of the next section). Place the name of the next
1216 section in next_section, and return NULL. If the name given is longer than
1217 next_section, truncate it. It will be unrecognized later, because all the known
1218 section names do fit. Leave space for pluralizing. */
1220 s = big_buffer + startoffset; /* First non-space character */
1223 save_config_line(s);
1225 if (strncmpic(s, US"begin ", 6) == 0)
1228 Uskip_whitespace(&s);
1229 if (big_buffer + len - s > sizeof(next_section) - 2)
1230 s[sizeof(next_section) - 2] = 0;
1231 Ustrcpy(next_section, s);
1235 #ifdef LOOKUP_MODULE_DIR
1236 /* Check for any required module load operations */
1238 //mod_load_check(s);
1241 /* Return the first non-blank character. */
1248 /*************************************************
1250 *************************************************/
1252 /* The yield is the pointer to the next uschar. Names longer than the
1253 output space are silently truncated. This function is also used from acl.c when
1257 name where to put the name
1261 Returns: new input pointer
1265 readconf_readname(uschar * name, int len, const uschar * s)
1268 BOOL broken = FALSE;
1270 if (isalpha(Uskip_whitespace(&s)))
1271 while (isalnum(*s) || *s == '_')
1273 if (p < len-1) name[p++] = *s;
1283 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1284 "exim item name too long (>%d), unable to use \"%s\" (truncated)",
1287 Uskip_whitespace(&s);
1294 /*************************************************
1295 * Read a time value *
1296 *************************************************/
1298 /* This function is also called from outside, to read argument
1299 time values. The format of a time value is:
1301 [<n>w][<n>d][<n>h][<n>m][<n>s]
1303 as long as at least one is present. If a format error is encountered,
1304 return a negative value. The value must be terminated by the given
1309 terminator required terminating character
1310 return_msec if TRUE, allow fractional seconds and return milliseconds
1312 Returns: the time value, or -1 on syntax error
1313 value is seconds if return_msec is FALSE
1314 value is milliseconds if return_msec is TRUE
1318 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1326 if (!isdigit(*s)) return -1;
1327 (void)sscanf(CCS s, "%d%n", &value, &count);
1332 case 'w': value *= 7;
1333 case 'd': value *= 24;
1334 case 'h': value *= 60;
1335 case 'm': value *= 60;
1340 if (!return_msec) return -1;
1341 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1343 if (*s++ != 's') return -1;
1344 yield += (int)(fraction * 1000.0);
1350 if (return_msec) value *= 1000;
1352 if (*s == terminator) return yield;
1354 /* Control never reaches here. */
1359 /*************************************************
1360 * Read a fixed point value *
1361 *************************************************/
1363 /* The value is returned *1000
1367 terminator required terminator
1369 Returns: the value, or -1 on error
1373 readconf_readfixed(const uschar *s, int terminator)
1377 if (!isdigit(*s)) return -1;
1378 (void)sscanf(CS s, "%d%n", &value, &count);
1380 yield = value * 1000;
1384 while (isdigit((*(++s))))
1386 yield += (*s - '0') * m;
1391 return (*s == terminator)? yield : (-1);
1396 /*************************************************
1397 * Find option in list *
1398 *************************************************/
1400 /* The lists are always in order, so binary chop can be used.
1403 name the option name to search for
1404 ol the first entry in the option list
1405 last one more than the offset of the last entry in the option list
1407 Returns: pointer to an option entry, or NULL if not found
1411 find_option(const uschar *name, optionlist *ol, int last)
1414 while (last > first)
1416 int middle = (first + last)/2;
1417 int c = Ustrcmp(name, ol[middle].name);
1419 if (c == 0) return ol + middle;
1420 else if (c > 0) first = middle + 1;
1428 /*************************************************
1429 * Find a set flag in option list *
1430 *************************************************/
1432 /* Because some versions of Unix make no restrictions on the values of uids and
1433 gids (even negative ones), we cannot represent "unset" by a special value.
1434 There is therefore a separate boolean variable for each one indicating whether
1435 a value is set or not. This function returns a pointer to the boolean, given
1436 the original option name. It is a major disaster if the flag cannot be found.
1439 name the name of the uid or gid option
1440 oltop points to the start of the relevant option list
1441 last one more than the offset of the last item in the option list
1442 data_block NULL when reading main options => data values in the option
1443 list are absolute addresses; otherwise they are byte offsets
1444 in data_block (used for driver options)
1446 Returns: a pointer to the boolean flag.
1450 get_set_flag(const uschar *name, optionlist *oltop, int last, void *data_block)
1453 uschar name2[EXIM_DRIVERNAME_MAX];
1454 sprintf(CS name2, "*set_%.50s", name);
1455 if (!(ol = find_option(name2, oltop, last)))
1456 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1457 "Exim internal error: missing set flag for %s", name);
1459 ? (BOOL *)(US data_block + ol->v.offset) : (BOOL *)ol->v.value;
1465 /*************************************************
1466 * Output extra characters message and die *
1467 *************************************************/
1469 /* Called when an option line has junk on the end. Sometimes this is because
1470 the sysadmin thinks comments are permitted.
1473 s points to the extra characters
1474 t1..t3 strings to insert in the log message
1476 Returns: doesn't return; dies
1480 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1482 uschar *comment = US"";
1483 if (*s == '#') comment = US" (# is comment only at line start)";
1484 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1485 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1490 /*************************************************
1491 * Read rewrite information *
1492 *************************************************/
1494 /* Each line of rewrite information contains:
1496 . A complete address in the form user@domain, possibly with
1497 leading * for each part; or alternatively, a regex.
1499 . A replacement string (which will be expanded).
1501 . An optional sequence of one-letter flags, indicating which
1502 headers etc. to apply this rule to.
1504 All this is decoded and placed into a control block. The OR of the flags is
1505 maintained in a common word.
1508 p points to the string that makes up the rule
1509 existflags points to the overall flag word
1510 isglobal TRUE if reading global rewrite rules
1512 Returns: the control block for the parsed rule.
1515 static rewrite_rule *
1516 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1518 rewrite_rule * next = store_get(sizeof(rewrite_rule), GET_UNTAINTED);
1521 next->key = string_dequote(&p);
1523 Uskip_whitespace(&p);
1525 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1526 "missing rewrite replacement string");
1529 next->replacement = string_dequote(&p);
1531 while (*p) switch (*p++)
1533 case ' ': case '\t': break;
1535 case 'q': next->flags |= rewrite_quit; break;
1536 case 'w': next->flags |= rewrite_whole; break;
1538 case 'h': next->flags |= rewrite_all_headers; break;
1539 case 's': next->flags |= rewrite_sender; break;
1540 case 'f': next->flags |= rewrite_from; break;
1541 case 't': next->flags |= rewrite_to; break;
1542 case 'c': next->flags |= rewrite_cc; break;
1543 case 'b': next->flags |= rewrite_bcc; break;
1544 case 'r': next->flags |= rewrite_replyto; break;
1546 case 'E': next->flags |= rewrite_all_envelope; break;
1547 case 'F': next->flags |= rewrite_envfrom; break;
1548 case 'T': next->flags |= rewrite_envto; break;
1550 case 'Q': next->flags |= rewrite_qualify; break;
1551 case 'R': next->flags |= rewrite_repeat; break;
1554 next->flags |= rewrite_smtp;
1555 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1556 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1557 "rewrite rule has the S flag but is not a regular expression");
1561 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1562 "unknown rewrite flag character '%c' "
1563 "(could be missing quotes round replacement item)", p[-1]);
1567 /* If no action flags are set, set all the "normal" rewrites. */
1569 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1570 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1572 /* Remember which exist, for optimization, and return the rule */
1574 *existflags |= next->flags;
1581 /*************************************************
1582 * Read global rewrite information *
1583 *************************************************/
1585 /* Each line is a single rewrite rule; it is parsed into a control block
1586 by readconf_one_rewrite(), and its flags are ORed into the global flag
1587 word rewrite_existflags. */
1590 readconf_rewrites(void)
1592 rewrite_rule **chain = &global_rewrite_rules;
1595 while ((p = get_config_line()) != NULL)
1597 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1599 chain = &(next->next);
1605 /*************************************************
1607 *************************************************/
1609 /* Strings are read into the normal store pool. As long we aren't too
1610 near the end of the current block, the string will just use what is necessary
1611 on the top of the stacking pool, because string_cat() uses the extension
1615 s the rest of the input line
1616 name the option name (for errors)
1618 Returns: pointer to the string
1622 read_string(const uschar *s, const uschar *name)
1627 if (*s != '\"') return string_copy(s);
1630 yield = string_dequote(&s);
1632 if (s == ss+1 || s[-1] != '\"')
1633 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1634 "missing quote at end of string value for %s", name);
1636 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1642 /*************************************************
1643 * Custom-handler options *
1644 *************************************************/
1646 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags)
1648 if (flags & opt_fn_print)
1650 if (flags & opt_fn_print_label) printf("%s = ", name);
1651 printf("%s\n", smtp_receive_timeout_s
1652 ? string_printing2(smtp_receive_timeout_s, SP_TAB)
1653 : readconf_printtime(smtp_receive_timeout));
1655 else if (*str == '$')
1656 smtp_receive_timeout_s = string_copy(str);
1659 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1660 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1661 if (smtp_receive_timeout < 0)
1662 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1667 /*************************************************
1668 * Handle option line *
1669 *************************************************/
1671 /* This function is called from several places to process a line containing the
1672 setting of an option. The first argument is the line to be decoded; it has been
1673 checked not to be empty and not to start with '#'. Trailing newlines and white
1674 space have been removed. The second argument is a pointer to the list of
1675 variable names that are to be recognized, together with their types and
1676 locations, and the third argument gives the number of entries in the list.
1678 The fourth argument is a pointer to a data block. If it is NULL, then the data
1679 values in the options list are absolute addresses. Otherwise, they are byte
1680 offsets in the data block.
1682 String option data may continue onto several lines; this function reads further
1683 data from config_file if necessary.
1685 The yield of this function is normally zero. If a string continues onto
1686 multiple lines, then the data value is permitted to be followed by a comma
1687 or a semicolon (for use in drivers) and the yield is that character.
1690 buffer contains the configuration line to be handled
1691 oltop points to the start of the relevant option list
1692 last one more than the offset of the last item in the option list
1693 data_block NULL when reading main options => data values in the option
1694 list are absolute addresses; otherwise they are byte offsets
1695 in data_block when they have opt_public set; otherwise
1696 they are byte offsets in data_block->options_block.
1697 unknown_txt format string to use in panic message for unknown option;
1698 must contain %s for option name
1699 if given as NULL, don't panic on unknown option
1701 Returns: TRUE if an option was read successfully,
1702 FALSE false for an unknown option if unknown_txt == NULL,
1703 otherwise panic and die on an unknown option
1707 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1708 void *data_block, uschar *unknown_txt)
1712 int count, type, value;
1716 BOOL boolvalue = TRUE;
1717 BOOL freesptr = TRUE;
1718 optionlist *ol, *ol2;
1722 uschar *inttype = US"";
1724 const uschar * s = buffer;
1725 uschar **str_target;
1726 uschar name[EXIM_DRIVERNAME_MAX];
1727 uschar name2[EXIM_DRIVERNAME_MAX];
1729 /* There may be leading spaces; thereafter, we expect an option name starting
1732 if (!isalpha( Uskip_whitespace(&s) ))
1733 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1735 /* Read the name of the option, and skip any subsequent white space. If
1736 it turns out that what we read was "hide", set the flag indicating that
1737 this is a secure option, and loop to read the next word. */
1739 for (int n = 0; n < 2; n++)
1741 while (isalnum(*s) || *s == '_')
1743 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1747 Uskip_whitespace(&s);
1748 if (Ustrcmp(name, "hide") != 0) break;
1749 issecure = opt_secure;
1753 /* Deal with "no_" or "not_" here for booleans */
1755 if (Ustrncmp(name, "no_", 3) == 0)
1761 if (Ustrncmp(name, "not_", 4) == 0)
1767 /* Search the list for the given name. A non-existent name, or an option that
1768 is set twice, is a disaster. */
1770 if (!(ol = find_option(name + offset, oltop, last)))
1772 if (!unknown_txt) return FALSE;
1773 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1776 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1777 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1778 "\"%s\" option set for the second time", name);
1780 ol->type |= opt_set | issecure;
1781 type = ol->type & opt_mask;
1783 /* Types with data values must be followed by '='; the "no[t]_" prefix
1784 applies only to boolean values. */
1786 if (type < opt_bool || type > opt_bool_last)
1789 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1790 "negation prefix applied to a non-boolean option");
1792 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1793 "unexpected end of line (data missing) after %s", name);
1795 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1798 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1799 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1800 ultimately expands to one of those values. */
1802 else if (*s && (offset != 0 || *s != '='))
1803 extra_chars_error(s, US"boolean option ", name, US"");
1805 /* Skip white space after = */
1807 if (*s == '=') while (isspace(*++s));
1809 /* If there is a data block and the opt_public flag is not set, change
1810 the data block pointer to the private options block. */
1812 if (data_block && !(ol->type & opt_public))
1813 data_block = (void *)(((driver_instance *)data_block)->options_block);
1815 /* Now get the data according to the type. */
1819 /* If a string value is not enclosed in quotes, it consists of
1820 the rest of the current line, verbatim. Otherwise, string escapes
1823 A transport is specified as a string, which is then looked up in the
1824 list of transports. A search type is specified as one of a number of
1827 A set or rewrite rules for a driver is specified as a string, which is
1828 then parsed into a suitable chain of control blocks.
1830 Uids and gids are specified as strings which are then looked up in the
1831 passwd file. Lists of uids and gids are similarly specified as colon-
1832 separated strings. */
1837 case opt_expand_uid:
1838 case opt_expand_gid:
1843 reset_point = store_mark();
1844 sptr = read_string(s, name);
1846 /* Having read a string, we now have several different ways of using it,
1847 depending on the data type, so do another switch. If keeping the actual
1848 string is not required (because it is interpreted), freesptr is set TRUE,
1849 and at the end we reset the pool. */
1853 /* If this was a string, set the variable to point to the new string,
1854 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1855 rules, we still keep the string (for printing), and parse the rules into a
1856 control block and flags word. */
1859 str_target = data_block ? USS (US data_block + ol->v.offset)
1861 if (ol->type & opt_rep_con)
1863 uschar * saved_condition;
1864 /* We already have a condition, we're conducting a crude hack to let
1865 multiple condition rules be chained together, despite storing them in
1867 *str_target = string_copy_perm( (saved_condition = *str_target)
1868 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1869 saved_condition, sptr)
1872 /* TODO(pdp): there is a memory leak here and just below
1873 when we set 3 or more conditions; I still don't
1874 understand the store mechanism enough to know
1875 what's the safe way to free content from an earlier store.
1876 AFAICT, stores stack, so freeing an early stored item also stores
1877 all data alloc'd after it. If we knew conditions were adjacent,
1878 we could survive that, but we don't. So I *think* we need to take
1879 another bit from opt_type to indicate "malloced"; this seems like
1880 quite a hack, especially for this one case. It also means that
1881 we can't ever reclaim the store from the *first* condition.
1883 Because we only do this once, near process start-up, I'm prepared to
1884 let this slide for the time being, even though it rankles. */
1886 else if (ol->type & opt_rep_str)
1889 Ustrncmp(name, "headers_add", 11) == 0 ? '\n'
1890 : Ustrncmp(name, "set", 3) == 0 ? ';'
1892 int sep_i = -(int)sep_o;
1893 const uschar * list = sptr;
1895 gstring * list_o = NULL;
1899 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1900 list_o = string_cat(list_o, *str_target);
1903 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1904 list_o = string_append_listele(list_o, sep_o, s);
1907 *str_target = string_copy_perm(string_from_gstring(list_o), FALSE);
1918 *USS (US data_block + ol->v.offset) = sptr;
1920 *USS ol->v.value = sptr;
1922 if (type == opt_rewrite)
1927 rewrite_rule **chain;
1930 sprintf(CS name2, "*%.50s_rules", name);
1931 ol2 = find_option(name2, oltop, last);
1932 sprintf(CS name2, "*%.50s_flags", name);
1933 ol3 = find_option(name2, oltop, last);
1936 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1937 "rewrite rules not available for driver");
1941 chain = (rewrite_rule **)(US data_block + ol2->v.offset);
1942 flagptr = (int *)(US data_block + ol3->v.offset);
1946 chain = (rewrite_rule **)ol2->v.value;
1947 flagptr = (int *)ol3->v.value;
1950 /* This will trap if sptr is tainted. Not sure if that can happen */
1951 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1953 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1955 chain = &(next->next);
1958 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1959 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1960 "non-header rewrite - not allowed at transport time -");
1964 /* If it was an expanded uid, see if there is any expansion to be
1965 done by checking for the presence of a $ character. If there is, save it
1966 in the corresponding *expand_user option field. Otherwise, fall through
1967 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1970 case opt_expand_uid:
1971 sprintf(CS name2, "*expand_%.50s", name);
1972 if ((ol2 = find_option(name2, oltop, last)))
1974 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1977 *(USS(US data_block + ol2->v.offset)) = ss;
1979 *(USS ol2->v.value) = ss;
1983 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1989 /* Look up a fixed uid, and also make use of the corresponding gid
1990 if a passwd entry is returned and the gid has not been set. */
1993 if (!route_finduser(sptr, &pw, &uid))
1994 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1996 *(uid_t *)(US data_block + ol->v.offset) = uid;
1998 *(uid_t *)ol->v.value = uid;
2000 /* Set the flag indicating a fixed value is set */
2002 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
2004 /* Handle matching gid if we have a passwd entry: done by finding the
2005 same name with terminating "user" changed to "group"; if not found,
2006 ignore. Also ignore if the value is already set. */
2008 if (pw == NULL) break;
2009 Ustrcpy(name+Ustrlen(name)-4, US"group");
2010 ol2 = find_option(name, oltop, last);
2011 if (ol2 && ((ol2->type & opt_mask) == opt_gid ||
2012 (ol2->type & opt_mask) == opt_expand_gid))
2014 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
2018 *((gid_t *)(US data_block + ol2->v.offset)) = pw->pw_gid;
2020 *((gid_t *)ol2->v.value) = pw->pw_gid;
2026 /* If it was an expanded gid, see if there is any expansion to be
2027 done by checking for the presence of a $ character. If there is, save it
2028 in the corresponding *expand_user option field. Otherwise, fall through
2029 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
2032 case opt_expand_gid:
2033 sprintf(CS name2, "*expand_%.50s", name);
2034 if ((ol2 = find_option(name2, oltop, last)))
2036 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
2039 *(USS(US data_block + ol2->v.offset)) = ss;
2041 *(USS ol2->v.value) = ss;
2045 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
2051 /* Handle freestanding gid */
2054 if (!route_findgroup(sptr, &gid))
2055 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
2057 *((gid_t *)(US data_block + ol->v.offset)) = gid;
2059 *((gid_t *)ol->v.value) = gid;
2060 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
2063 /* If it was a uid list, look up each individual entry, and build
2064 a vector of uids, with a count in the first element. Put the vector
2065 in malloc store so we can free the string. (We are reading into
2066 permanent store already.) */
2074 const uschar *op = expand_string (sptr);
2077 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2078 name, expand_string_message);
2081 if (*p != 0) count++;
2082 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2083 list = store_malloc(count*sizeof(uid_t));
2084 list[ptr++] = (uid_t)(count - 1);
2087 *((uid_t **)(US data_block + ol->v.offset)) = list;
2089 *((uid_t **)ol->v.value) = list;
2095 /* If p is tainted we trap. Not sure that can happen */
2096 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2097 if (!route_finduser(big_buffer, NULL, &uid))
2098 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
2105 /* If it was a gid list, look up each individual entry, and build
2106 a vector of gids, with a count in the first element. Put the vector
2107 in malloc store so we can free the string. (We are reading into permanent
2116 const uschar *op = expand_string (sptr);
2119 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2120 name, expand_string_message);
2123 if (*p != 0) count++;
2124 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2125 list = store_malloc(count*sizeof(gid_t));
2126 list[ptr++] = (gid_t)(count - 1);
2129 *((gid_t **)(US data_block + ol->v.offset)) = list;
2131 *((gid_t **)ol->v.value) = list;
2137 /* If p is tainted we trap. Not sure that can happen */
2138 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2139 if (!route_findgroup(big_buffer, &gid))
2140 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2148 /* Release store if the value of the string doesn't need to be kept. */
2150 if (freesptr) reset_point = store_reset(reset_point);
2153 /* Expanded boolean: if no characters follow, or if there are no dollar
2154 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2155 save the string for later expansion in the alternate place. */
2157 case opt_expand_bool:
2158 if (*s && Ustrchr(s, '$') != 0)
2160 sprintf(CS name2, "*expand_%.50s", name);
2161 if ((ol2 = find_option(name2, oltop, last)))
2163 reset_point = store_mark();
2164 sptr = read_string(s, name);
2166 *(USS(US data_block + ol2->v.offset)) = sptr;
2168 *(USS ol2->v.value) = sptr;
2175 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2176 look for yes/not/true/false. Some booleans are stored in a single bit in
2177 a single int. There's a special fudge for verify settings; without a suffix
2178 they set both xx_sender and xx_recipient. The table points to the sender
2179 value; search subsequently for the recipient. There's another special case:
2180 opt_bool_set also notes when a boolean has been set. */
2184 case opt_bool_verify:
2188 s = readconf_readname(name2, EXIM_DRIVERNAME_MAX, s);
2189 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2191 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2193 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2194 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2195 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2196 US"for boolean option ", name);
2199 /* Handle single-bit type. */
2201 if (type == opt_bit)
2203 int bit = 1 << ((ol->type >> 16) & 31);
2204 int * ptr = data_block
2205 ? (int *)(US data_block + ol->v.offset)
2206 : (int *)ol->v.value;
2207 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2211 /* Handle full BOOL types */
2214 *((BOOL *)(US data_block + ol->v.offset)) = boolvalue;
2216 *((BOOL *)ol->v.value) = boolvalue;
2220 if (type == opt_bool_verify)
2222 sprintf(CS name2, "%.50s_recipient", name + offset);
2223 if ((ol2 = find_option(name2, oltop, last)))
2225 *((BOOL *)(US data_block + ol2->v.offset)) = boolvalue;
2227 *((BOOL *)ol2->v.value) = boolvalue;
2230 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2232 else if (type == opt_bool_set)
2234 sprintf(CS name2, "*set_%.50s", name + offset);
2235 if ((ol2 = find_option(name2, oltop, last)))
2237 *((BOOL *)(US data_block + ol2->v.offset)) = TRUE;
2239 *((BOOL *)ol2->v.value) = TRUE;
2247 inttype = US"octal ";
2249 /* Integer: a simple(ish) case; allow octal and hex formats, and
2250 suffixes K, M, G, and T. The different types affect output, not input. */
2259 lvalue = strtol(CS s, CSS &endptr, intbase);
2262 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2265 if (errno != ERANGE && *endptr)
2267 uschar * mp = US"TtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2269 if ((mp = Ustrchr(mp, *endptr)))
2274 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2285 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2286 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2287 "absolute value of integer \"%s\" is too large (overflow)", s);
2289 if (Uskip_whitespace(&endptr))
2290 extra_chars_error(endptr, inttype, US"integer value for ", name);
2292 value = (int)lvalue;
2296 *(int *)(US data_block + ol->v.offset) = value;
2298 *(int *)ol->v.value = value;
2301 /* Integer held in K: again, allow formats and suffixes as above. */
2307 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2310 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2313 if (errno != ERANGE && *endptr)
2315 uschar * mp = US"ZzEePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2317 if ((mp = Ustrchr(mp, *endptr)))
2322 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2331 lvalue = (lvalue + 512)/1024;
2334 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2335 "absolute value of integer \"%s\" is too large (overflow)", s);
2337 if (Uskip_whitespace(&endptr))
2338 extra_chars_error(endptr, inttype, US"integer value for ", name);
2341 *(int_eximarith_t *)(US data_block + ol->v.offset) = lvalue;
2343 *(int_eximarith_t *)ol->v.value = lvalue;
2347 /* Fixed-point number: held to 3 decimal places. */
2350 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2351 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2352 "fixed-point number expected for %s", name);
2354 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2355 "integer \"%s\" is too large (overflow)", s);
2359 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2360 "integer \"%s\" is too large (overflow)", s);
2362 /* We get a coverity error here for using count, as it derived
2363 from the tainted buffer pointed to by s, as parsed by sscanf().
2364 By the definition of sscanf we must be accessing between start
2365 and end of s (assuming it is nul-terminated...) so ignore the error. */
2366 /* coverity[tainted_data] */
2367 if (s[count] == '.')
2370 while (isdigit(s[++count]))
2372 value += (s[count] - '0') * d;
2377 while (isspace(s[count])) count++;
2380 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2383 *((int *)(US data_block + ol->v.offset)) = value;
2385 *((int *)ol->v.value) = value;
2388 /* There's a special routine to read time values. */
2391 value = readconf_readtime(s, 0, FALSE);
2393 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2396 *((int *)(US data_block + ol->v.offset)) = value;
2398 *((int *)ol->v.value) = value;
2401 /* A time list is a list of colon-separated times, with the first
2402 element holding the size of the list and the second the number of
2408 int * list = data_block
2409 ? (int *)(US data_block + ol->v.offset)
2410 : (int *)ol->v.value;
2412 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2415 uschar *snext = Ustrchr(s, ':');
2419 while (ss > s && isspace(ss[-1])) ss--;
2422 value = readconf_readtime(s, terminator, FALSE);
2424 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2426 if (count > 1 && value <= list[count])
2427 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2428 "time value out of order for %s", name);
2429 list[count+1] = value;
2430 if (snext == NULL) break;
2432 Uskip_whitespace(&s);
2435 if (count > list[0] - 2)
2436 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2438 if (count > 0 && list[2] == 0) count = 0;
2444 ol->v.fn(name, s, 0);
2453 /*************************************************
2454 * Print a time value *
2455 *************************************************/
2458 Argument: a time value in seconds
2459 Returns: pointer to a fixed buffer containing the time as a string,
2460 in readconf_readtime() format
2464 readconf_printtime(int t)
2467 uschar *p = time_buffer;
2469 if (t < 0) *p++ = '-', t = -t;
2480 if (w > 0) p += sprintf(CS p, "%dw", w);
2481 if (d > 0) p += sprintf(CS p, "%dd", d);
2482 if (h > 0) p += sprintf(CS p, "%dh", h);
2483 if (m > 0) p += sprintf(CS p, "%dm", m);
2484 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2491 /*************************************************
2492 * Print an individual option value *
2493 *************************************************/
2495 /* This is used by the -bP option, so prints to the standard output.
2496 The entire options list is passed in as an argument, because some options come
2497 in pairs - typically uid/gid settings, which can either be explicit numerical
2498 values, or strings to be expanded later. If the numerical value is unset,
2499 search for "*expand_<name>" to see if there is a string equivalent.
2502 ol option entry, or NULL for an unknown option
2504 options_block NULL for main configuration options; otherwise points to
2505 a driver block; if the option doesn't have opt_public
2506 set, then options_block->options_block is where the item
2508 oltop points to the option list in which ol exists
2509 last one more than the offset of the last entry in optop
2510 no_labels do not show "foo = " at the start.
2512 Returns: boolean success
2516 print_ol(optionlist *ol, const uschar *name, void *options_block,
2517 optionlist *oltop, int last, BOOL no_labels)
2526 uschar name2[EXIM_DRIVERNAME_MAX];
2530 printf("%s is not a known option\n", name);
2534 /* Non-admin callers cannot see options that have been flagged secure by the
2537 if (!f.admin_user && ol->type & opt_secure)
2540 printf("%s\n", CCS hidden);
2542 printf("%s = %s\n", name, CCS hidden);
2546 /* Else show the value of the option */
2548 value = ol->v.value;
2551 if (!(ol->type & opt_public))
2552 options_block = (void *)(((driver_instance *)options_block)->options_block);
2553 value = (void *)(US options_block + (long int)value);
2556 switch(ol->type & opt_mask)
2559 case opt_rewrite: /* Show the text value */
2561 if (!no_labels) printf("%s = ", name);
2562 printf("%s\n", s ? string_printing2(s, SP_TAB) : US"");
2566 if (!no_labels) printf("%s = ", name);
2567 printf("%d\n", *((int *)value));
2572 int x = *((int *)value);
2573 if (x != 0 && (x & 1023) == 0)
2577 if ((x & 1023) == 0)
2582 if (!no_labels) printf("%s = ", name);
2583 printf("%d%c\n", x, c);
2587 if (!no_labels) printf("%s = ", name);
2595 int_eximarith_t x = *((int_eximarith_t *)value);
2596 if (!no_labels) printf("%s = ", name);
2597 if (x == 0) printf("0\n");
2598 else if ((x & ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH "T\n", x >> 30);
2599 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2600 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2601 else printf(PR_EXIM_ARITH "K\n", x);
2606 if (!no_labels) printf("%s = ", name);
2607 printf("%#o\n", *((int *)value));
2610 /* Can be negative only when "unset", in which case integer */
2614 int x = *((int *)value);
2617 if (x < 0) printf("%s =\n", name); else
2619 if (!no_labels) printf("%s = ", name);
2620 printf("%d.", x/1000);
2633 /* If the numerical value is unset, try for the string value */
2635 case opt_expand_uid:
2636 if (! *get_set_flag(name, oltop, last, options_block))
2638 sprintf(CS name2, "*expand_%.50s", name);
2639 if ((ol2 = find_option(name2, oltop, last)))
2642 s = *USS (US options_block + ol2->v.offset);
2644 s = *USS ol2->v.value;
2645 if (!no_labels) printf("%s = ", name);
2646 printf("%s\n", s ? string_printing(s) : US"");
2651 /* Else fall through */
2654 if (!no_labels) printf("%s = ", name);
2655 if (! *get_set_flag(name, oltop, last, options_block))
2658 if ((pw = getpwuid(*((uid_t *)value))))
2659 printf("%s\n", pw->pw_name);
2661 printf("%ld\n", (long int)(*((uid_t *)value)));
2664 /* If the numerical value is unset, try for the string value */
2666 case opt_expand_gid:
2667 if (! *get_set_flag(name, oltop, last, options_block))
2669 sprintf(CS name2, "*expand_%.50s", name);
2670 if ( (ol2 = find_option(name2, oltop, last))
2671 && (ol2->type & opt_mask) == opt_stringptr)
2674 s = *USS (US options_block + ol2->v.offset);
2676 s = *USS ol2->v.value;
2677 if (!no_labels) printf("%s = ", name);
2678 printf("%s\n", s ? string_printing(s) : US"");
2683 /* Else fall through */
2686 if (!no_labels) printf("%s = ", name);
2687 if (! *get_set_flag(name, oltop, last, options_block))
2690 if ((gr = getgrgid(*((int *)value))))
2691 printf("%s\n", gr->gr_name);
2693 printf("%ld\n", (long int)(*((int *)value)));
2697 uidlist = *((uid_t **)value);
2698 if (!no_labels) printf("%s =", name);
2701 uschar sep = no_labels ? '\0' : ' ';
2702 for (int i = 1; i <= (int)(uidlist[0]); i++)
2704 uschar *name = NULL;
2705 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2706 if (sep != '\0') printf("%c", sep);
2707 if (name) printf("%s", name);
2708 else printf("%ld", (long int)(uidlist[i]));
2716 gidlist = *((gid_t **)value);
2717 if (!no_labels) printf("%s =", name);
2720 uschar sep = no_labels ? '\0' : ' ';
2721 for (int i = 1; i <= (int)(gidlist[0]); i++)
2723 uschar *name = NULL;
2724 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2725 if (sep != '\0') printf("%c", sep);
2726 if (name) printf("%s", name);
2727 else printf("%ld", (long int)(gidlist[i]));
2735 if (!no_labels) printf("%s = ", name);
2736 printf("%s\n", readconf_printtime(*((int *)value)));
2741 int *list = (int *)value;
2742 if (!no_labels) printf("%s = ", name);
2743 for (int i = 0; i < list[1]; i++)
2744 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2750 printf("%s%s\n", (*((int *)value)) & (1 << ((ol->type >> 16) & 31))
2751 ? "" : "no_", name);
2754 case opt_expand_bool:
2755 sprintf(CS name2, "*expand_%.50s", name);
2756 if ((ol2 = find_option(name2, oltop, last)) && ol2->v.value)
2759 s = *USS (US options_block + ol2->v.offset);
2761 s = *USS ol2->v.value;
2764 if (!no_labels) printf("%s = ", name);
2765 printf("%s\n", string_printing(s));
2768 /* s == NULL => string not set; fall through */
2774 case opt_bool_verify:
2776 printf("%s%s\n", *((BOOL *)value) ? "" : "no_", name);
2780 ol->v.fn(name, NULL, no_labels ? opt_fn_print : opt_fn_print|opt_fn_print_label);
2788 /*************************************************
2789 * Print value from main configuration *
2790 *************************************************/
2792 /* This function, called as a result of encountering the -bP option,
2793 causes the value of any main configuration variable to be output if the
2794 second argument is NULL. There are some special values:
2796 all print all main configuration options
2797 config_file print the name of the configuration file
2798 (configure_file will still work, for backward
2800 routers print the routers' configurations
2801 transports print the transports' configuration
2802 authenticators print the authenticators' configuration
2803 macros print the macros' configuration
2804 router_list print a list of router names
2805 transport_list print a list of transport names
2806 authenticator_list print a list of authentication mechanism names
2807 macro_list print a list of macro names
2808 +name print a named list item
2809 local_scan print the local_scan options
2810 config print the configuration as it is parsed
2811 environment print the used execution environment
2813 If the second argument is not NULL, it must be one of "router", "transport",
2814 "authenticator" or "macro" in which case the first argument identifies the
2815 driver whose options are to be printed.
2818 name option name if type == NULL; else driver name
2819 type NULL or driver type name, as described above
2820 no_labels avoid the "foo = " at the start of an item
2822 Returns: Boolean success
2826 readconf_print(const uschar * name, const uschar * type, BOOL no_labels)
2828 BOOL names_only = FALSE;
2829 optionlist *ol2 = NULL;
2830 driver_instance *d = NULL;
2839 static uschar *types[] = { US"address", US"domain", US"host",
2841 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2842 &hostlist_anchor, &localpartlist_anchor };
2844 for (int i = 0; i < 4; i++)
2845 if ((t = tree_search(*(anchors[i]), name+1)))
2847 namedlist_block * nb = t->data.ptr;
2848 const uschar * s = nb->hide ? hidden : nb->string;
2851 printf("%s\n", CCS s);
2853 printf("%slist %s = %s\n", types[i], name+1, CCS s);
2857 printf("no address, domain, host, or local part list called \"%s\" "
2858 "exists\n", name+1);
2863 if ( Ustrcmp(name, "configure_file") == 0
2864 || Ustrcmp(name, "config_file") == 0)
2866 printf("%s\n", CS config_main_filename);
2870 if (Ustrcmp(name, "all") == 0)
2872 for (optionlist * ol = optionlist_config;
2873 ol < optionlist_config + nelem(optionlist_config); ol++)
2874 if (!(ol->type & opt_hidden))
2875 (void) print_ol(ol, US ol->name, NULL,
2876 optionlist_config, nelem(optionlist_config),
2881 if (Ustrcmp(name, "local_scan") == 0)
2883 #ifndef LOCAL_SCAN_HAS_OPTIONS
2884 printf("local_scan() options are not supported\n");
2887 for (optionlist * ol = local_scan_options;
2888 ol < local_scan_options + local_scan_options_count; ol++)
2889 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2890 local_scan_options_count, no_labels);
2895 if (Ustrcmp(name, "config") == 0)
2897 print_config(f.admin_user, no_labels);
2901 if (Ustrcmp(name, "routers") == 0)
2906 else if (Ustrcmp(name, "transports") == 0)
2908 type = US"transport";
2911 else if (Ustrcmp(name, "authenticators") == 0)
2913 type = US"authenticator";
2916 else if (Ustrcmp(name, "macros") == 0)
2921 else if (Ustrcmp(name, "router_list") == 0)
2927 else if (Ustrcmp(name, "transport_list") == 0)
2929 type = US"transport";
2933 else if (Ustrcmp(name, "authenticator_list") == 0)
2935 type = US"authenticator";
2939 else if (Ustrcmp(name, "macro_list") == 0)
2945 else if (Ustrcmp(name, "environment") == 0)
2950 for (p = USS environ; *p; p++) ;
2951 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2953 for (p = USS environ; *p; p++)
2956 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2964 return print_ol(find_option(name,
2965 optionlist_config, nelem(optionlist_config)),
2966 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2969 /* Handle the options for a router or transport. Skip options that are flagged
2970 as hidden. Some of these are options with names starting with '*', used for
2971 internal alternative representations of other options (which the printing
2972 function will sort out). Others are synonyms kept for backward compatibility.
2975 if (Ustrcmp(type, "router") == 0)
2977 d = (driver_instance *)routers;
2978 ol2 = optionlist_routers;
2979 size = optionlist_routers_size;
2981 else if (Ustrcmp(type, "transport") == 0)
2983 d = (driver_instance *)transports;
2984 ol2 = optionlist_transports;
2985 size = optionlist_transports_size;
2987 else if (Ustrcmp(type, "authenticator") == 0)
2989 d = (driver_instance *)auths;
2990 ol2 = optionlist_auths;
2991 size = optionlist_auths_size;
2994 else if (Ustrcmp(type, "macro") == 0)
2996 /* People store passwords in macros and they were previously not available
2997 for printing. So we have an admin_users restriction. */
3000 fprintf(stderr, "exim: permission denied; not admin\n");
3003 for (macro_item * m = macros; m; m = m->next)
3004 if (!name || Ustrcmp(name, m->name) == 0)
3007 printf("%s\n", CS m->name);
3009 printf("%s\n", CS m->replacement);
3011 printf("%s=%s\n", CS m->name, CS m->replacement);
3015 if (!name) return TRUE;
3017 printf("%s %s not found\n", type, name);
3023 for (; d; d = d->next) printf("%s\n", CS d->name);
3027 /* Either search for a given driver, or print all of them */
3029 for (; d; d = d->next)
3032 driver_info * di = d->info;
3035 printf("\n%s %s:\n", d->name, type);
3036 else if (Ustrcmp(d->name, name) != 0) continue;
3038 for (optionlist * ol = ol2; ol < ol2 + size; ol++)
3039 if (!(ol->type & opt_hidden))
3040 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
3042 for (optionlist * ol = di->options;
3043 ol < di->options + *di->options_count; ol++)
3044 if (!(ol->type & opt_hidden))
3045 rc |= print_ol(ol, US ol->name, d, di->options,
3046 *di->options_count, no_labels);
3048 if (name) return rc;
3050 if (!name) return TRUE;
3052 printf("%s %s not found\n", type, name);
3058 /*************************************************
3059 * Read a named list item *
3060 *************************************************/
3062 /* This function reads a name and a list (i.e. string). The name is used to
3063 save the list in a tree, sorted by its name. Each entry also has a number,
3064 which can be used for caching tests, but if the string contains any expansion
3065 items other than $key, the number is set negative to inhibit caching. This
3066 mechanism is used for domain, host, and address lists that are referenced by
3070 anchorp points to the tree anchor
3071 numberp points to the current number for this tree
3072 max the maximum number permitted
3073 s the text of the option line, starting immediately after the name
3075 tname the name of the list type, for messages
3076 hide do not output value on "-bP"
3082 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
3083 uschar *tname, BOOL hide)
3085 BOOL forcecache = FALSE;
3088 namedlist_block * nb = store_get_perm(sizeof(namedlist_block), GET_UNTAINTED);
3090 if (Ustrncmp(s, "_cache", 6) == 0)
3097 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
3099 if (*numberp >= max)
3100 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3103 Uskip_whitespace(&s);
3105 while (isalnum(*s) || *s == '_') s++;
3106 t = store_get(sizeof(tree_node) + s-ss, ss);
3107 Ustrncpy(t->name, ss, s-ss);
3109 Uskip_whitespace(&s);
3111 if (!tree_insertnode(anchorp, t))
3112 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3113 "duplicate name \"%s\" for a named %s", t->name, tname);
3116 nb->number = *numberp;
3120 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3121 "missing '=' after \"%s\"", t->name);
3122 Uskip_whitespace(&s);
3123 nb->string = read_string(s, t->name);
3124 nb->cache_data = NULL;
3126 /* Check the string for any expansions; if any are found, mark this list
3127 uncacheable unless the user has explicited forced caching. */
3129 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3135 /*************************************************
3136 * Unpick data for a rate limit *
3137 *************************************************/
3139 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3143 s string, in the form t,b,f,l
3144 where t is the threshold (integer)
3145 b is the initial delay (time)
3146 f is the multiplicative factor (fixed point)
3147 k is the maximum time (time)
3148 threshold where to store threshold
3149 base where to store base in milliseconds
3150 factor where to store factor in milliseconds
3151 limit where to store limit
3153 Returns: nothing (panics on error)
3157 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3160 uschar bstring[16], lstring[16];
3162 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3163 factor, lstring) == 4)
3165 *base = readconf_readtime(bstring, 0, TRUE);
3166 *limit = readconf_readtime(lstring, 0, TRUE);
3167 if (*base >= 0 && *limit >= 0) return;
3169 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3175 /*************************************************
3176 * Read main configuration options *
3177 *************************************************/
3179 /* This function is the first to be called for configuration reading. It
3180 opens the configuration file and reads general configuration settings until
3181 it reaches the end of the configuration section. The file is then left open so
3182 that the remaining configuration data can subsequently be read if needed for
3185 The configuration file must be owned either by root or exim, and be writeable
3186 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3187 in the config file, so the test is done on the compiled in values. A slight
3188 anomaly, to be carefully documented.
3190 The name of the configuration file is taken from a list that is included in the
3191 binary of Exim. It can be altered from the command line, but if that is done,
3192 root privilege is immediately withdrawn unless the caller is root or exim.
3193 The first file on the list that exists is used.
3195 For use on multiple systems that share file systems, first look for a
3196 configuration file whose name has the current node name on the end. If that is
3197 not found, try the generic name. For really contorted configurations, that run
3198 multiple Exims with different uid settings, first try adding the effective uid
3199 before the node name. These complications are going to waste resources on most
3200 systems. Therefore they are available only when requested by compile-time
3204 readconf_main(BOOL nowarn)
3207 struct stat statbuf;
3208 uschar * s, * filename;
3209 const uschar * list = config_main_filelist;
3211 /* Loop through the possible file names */
3213 /* Should never be a tainted list */
3214 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3217 /* Cut out all the fancy processing unless specifically wanted */
3219 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3220 uschar *suffix = filename + Ustrlen(filename);
3222 /* Try for the node-specific file if a node name exists */
3224 # ifdef CONFIGURE_FILE_USE_NODE
3226 if (uname(&uts) >= 0)
3228 # ifdef CONFIGURE_FILE_USE_EUID
3229 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3230 if (!(config_file = Ufopen(filename, "rb")))
3231 # endif /* CONFIGURE_FILE_USE_EUID */
3233 sprintf(CS suffix, ".%.256s", uts.nodename);
3234 config_file = Ufopen(filename, "rb");
3237 # endif /* CONFIGURE_FILE_USE_NODE */
3239 /* Otherwise, try the generic name, possibly with the euid added */
3241 # ifdef CONFIGURE_FILE_USE_EUID
3244 sprintf(CS suffix, ".%ld", (long int)original_euid);
3245 config_file = Ufopen(filename, "rb");
3247 # endif /* CONFIGURE_FILE_USE_EUID */
3249 /* Finally, try the unadorned name */
3254 config_file = Ufopen(filename, "rb");
3256 #else /* if neither defined */
3258 /* This is the common case when the fancy processing is not included. */
3260 config_file = Ufopen(filename, "rb");
3263 /* If the file does not exist, continue to try any others. For any other
3264 error, break out (and die). */
3266 if (config_file || errno != ENOENT) break;
3269 /* On success, save the name for verification; config_filename is used when
3270 logging configuration errors (it changes for .included files) whereas
3271 config_main_filename is the name shown by -bP. Failure to open a configuration
3272 file is a serious disaster. */
3276 uschar *last_slash = Ustrrchr(filename, '/');
3277 config_filename = config_main_filename = string_copy(filename);
3279 /* The config_main_directory we need for the $config_dir expansion.
3280 config_main_filename we need for $config_file expansion.
3281 And config_dir is the directory of the current configuration, used for
3282 relative .includes. We do need to know it's name, as we change our working
3285 if (filename[0] == '/')
3286 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3289 /* relative configuration file name: working dir + / + basename(filename) */
3291 uschar buf[PATH_MAX];
3294 if (os_getcwd(buf, PATH_MAX) == NULL)
3296 perror("exim: getcwd");
3297 exim_exit(EXIT_FAILURE);
3299 g = string_cat(NULL, buf);
3301 /* If the dir does not end with a "/", append one */
3302 if (gstring_last_char(g) != '/')
3303 g = string_catn(g, US"/", 1);
3305 /* If the config file contains a "/", extract the directory part */
3307 g = string_catn(g, filename, last_slash - filename);
3309 config_main_directory = string_from_gstring(g);
3311 config_directory = config_main_directory;
3315 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3316 "%s", config_main_filelist);
3318 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
3319 string_open_failed("configuration file %s", filename));
3321 /* Now, once we found and opened our configuration file, we change the directory
3322 to a safe place. Later we change to $spool_directory. */
3324 if (Uchdir("/") < 0)
3326 perror("exim: chdir `/': ");
3327 exim_exit(EXIT_FAILURE);
3330 /* Check the status of the file we have opened, if we have retained root
3331 privileges and the file isn't /dev/null (which *should* be 0666). */
3333 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3335 if (fstat(fileno(config_file), &statbuf) != 0)
3336 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3339 if ( statbuf.st_uid != root_uid /* owner not root */
3340 #ifdef CONFIGURE_OWNER
3341 && statbuf.st_uid != config_uid /* owner not the special one */
3344 statbuf.st_gid != root_gid /* group not root & */
3345 #ifdef CONFIGURE_GROUP
3346 && statbuf.st_gid != config_gid /* group not the special one */
3348 && (statbuf.st_mode & 020) != 0 /* group writeable */
3350 (statbuf.st_mode & 2) != 0 /* world writeable */
3352 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3353 "wrong owner, group, or mode", big_buffer);
3355 /* Do a dummy store-allocation of a size related to the (toplevel) file size.
3356 This assumes we will need this much storage to handle all the allocations
3357 during startup; it won't help when .include is being used. When it does, it
3358 will cut down on the number of store blocks (and malloc calls, and sbrk
3359 syscalls). It also assume we're on the relevant pool. */
3361 if (statbuf.st_size > 8192)
3363 rmark r = store_mark();
3364 void * dummy = store_get((int)statbuf.st_size, GET_UNTAINTED);
3369 /* Process the main configuration settings. They all begin with a lower case
3370 letter. If we see something starting with an upper case letter, it is taken as
3371 a macro definition. */
3373 while ((s = get_config_line()))
3378 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3379 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3380 "found unexpected BOM (Byte Order Mark)");
3384 if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE);
3388 t = (hide = Ustrncmp(s, "hide", 4) == 0 && isspace(s[4])) ? s + 5 : s;
3390 if (Ustrncmp(t, "domainlist", 10) == 0)
3391 read_named_list(&domainlist_anchor, &domainlist_count,
3392 MAX_NAMED_LIST, t+10, US"domain list", hide);
3394 else if (Ustrncmp(t, "hostlist", 8) == 0)
3395 read_named_list(&hostlist_anchor, &hostlist_count,
3396 MAX_NAMED_LIST, t+8, US"host list", hide);
3398 else if (Ustrncmp(t, "addresslist", 11) == 0)
3399 read_named_list(&addresslist_anchor, &addresslist_count,
3400 MAX_NAMED_LIST, t+11, US"address list", hide);
3402 else if (Ustrncmp(t, "localpartlist", 13) == 0)
3403 read_named_list(&localpartlist_anchor, &localpartlist_count,
3404 MAX_NAMED_LIST, t+13, US"local part list", hide);
3407 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3408 NULL, US"main option \"%s\" unknown");
3412 /* If local_sender_retain is set, local_from_check must be unset. */
3414 if (local_sender_retain && local_from_check)
3415 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3416 "local_sender_retain are set; this combination is not allowed");
3418 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3421 if (timezone_string && !*timezone_string) timezone_string = NULL;
3423 /* The max retry interval must not be greater than 24 hours. */
3425 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3427 /* remote_max_parallel must be > 0 */
3429 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3431 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3432 start of a new SMTP message. */
3434 freeze_tell_config = freeze_tell;
3436 /* The primary host name may be required for expansion of spool_directory
3437 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3438 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3439 canonize it. Some people like upper case letters in their host names, so we
3440 don't force the case. */
3442 if (!primary_hostname)
3444 const uschar * hostname;
3447 if (uname(&uts) < 0)
3448 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3449 hostname = US uts.nodename;
3451 if (Ustrchr(hostname, '.') == NULL)
3454 struct hostent *hostdata;
3458 && ( !dns_ipv4_lookup
3459 || match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3460 MCL_DOMAIN, TRUE, NULL) != OK))
3467 # if HAVE_GETIPNODEBYNAME
3469 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3471 hostdata = gethostbyname2(CS hostname, af);
3474 hostdata = gethostbyname(CS hostname);
3478 { hostname = US hostdata->h_name; break; }
3480 if (af == AF_INET) break;
3485 primary_hostname = string_copy(hostname);
3488 /* Set up default value for smtp_active_hostname */
3490 smtp_active_hostname = primary_hostname;
3492 /* If spool_directory wasn't set in the build-time configuration, it must have
3493 got set above. Of course, writing to the log may not work if log_file_path is
3494 not set, but it will at least get to syslog or somewhere, with any luck. */
3496 if (!*spool_directory)
3497 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3500 /* Expand the spool directory name; it may, for example, contain the primary
3501 host name. Same comment about failure. */
3503 if (!(s = expand_string(spool_directory)))
3504 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3505 "\"%s\": %s", spool_directory, expand_string_message);
3506 spool_directory = s;
3508 /* Expand log_file_path, which must contain "%s" in any component that isn't
3509 the null string or "syslog". It is also allowed to contain one instance of %D
3510 or %M. However, it must NOT contain % followed by anything else. */
3514 const uschar *ss, *sss;
3515 int sep = ':'; /* Fixed for log file path */
3516 if (!(s = expand_string(log_file_path)))
3517 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3518 "\"%s\": %s", log_file_path, expand_string_message);
3521 /* should never be a tainted list */
3522 while ((sss = string_nextinlist(&ss, &sep, big_buffer, big_buffer_size)))
3525 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3526 if (!(t = Ustrstr(sss, "%s")))
3527 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3528 "contain \"%%s\"", sss);
3530 if ((t = Ustrchr(sss, '%')))
3531 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3532 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3533 "unexpected \"%%\" character", s);
3539 /* Interpret syslog_facility into an integer argument for 'ident' param to
3540 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3543 if (syslog_facility_str)
3546 uschar * s = syslog_facility_str;
3548 if ((Ustrlen(syslog_facility_str) >= 4) &&
3549 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3552 for (i = 0; i < syslog_list_size; i++)
3553 if (strcmpic(s, syslog_list[i].name) == 0)
3555 syslog_facility = syslog_list[i].value;
3559 if (i >= syslog_list_size)
3560 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3561 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3564 /* Expand pid_file_path */
3568 const uschar * t = expand_cstring(pid_file_path);
3570 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3571 "\"%s\": %s", pid_file_path, expand_string_message);
3575 /* Set default value of process_log_path */
3577 if (!process_log_path || !*process_log_path)
3578 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3580 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3583 regex_From = regex_must_compile(uucp_from_pattern, MCS_NOFLAGS, TRUE);
3585 /* Unpick the SMTP rate limiting options, if set */
3587 if (smtp_ratelimit_mail)
3588 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3589 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3591 if (smtp_ratelimit_rcpt)
3592 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3593 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3595 /* The qualify domains default to the primary host name */
3597 if (!qualify_domain_sender)
3598 qualify_domain_sender = primary_hostname;
3599 if (!qualify_domain_recipient)
3600 qualify_domain_recipient = qualify_domain_sender;
3602 /* Setting system_filter_user in the configuration sets the gid as well if a
3603 name is given, but a numerical value does not. */
3605 if (system_filter_uid_set && !system_filter_gid_set)
3607 struct passwd *pw = getpwuid(system_filter_uid);
3609 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3610 (long int)system_filter_uid);
3611 system_filter_gid = pw->pw_gid;
3612 system_filter_gid_set = TRUE;
3615 /* If the errors_reply_to field is set, check that it is syntactically valid
3616 and ensure it contains a domain. */
3618 if (errors_reply_to)
3621 int start, end, domain;
3622 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3623 &start, &end, &domain, FALSE);
3626 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3627 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3630 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3631 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3634 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3635 smtp_accept_max must also be set. */
3637 if (smtp_accept_max == 0 && (smtp_accept_queue > 0 || smtp_accept_max_per_host))
3638 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3639 "smtp_accept_max must be set if smtp_accept_queue or "
3640 "smtp_accept_max_per_host is set");
3642 /* Set up the host number if anything is specified. It is an expanded string
3643 so that it can be computed from the host name, for example. We do this last
3644 so as to ensure that everything else is set up before the expansion. */
3646 if (host_number_string)
3650 uschar *s = expand_string(host_number_string);
3653 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3654 "failed to expand localhost_number \"%s\": %s",
3655 host_number_string, expand_string_message);
3656 n = Ustrtol(s, &end, 0);
3657 if (Uskip_whitespace(&end))
3658 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3659 "localhost_number value is not a number: %s", s);
3660 if (n > LOCALHOST_MAX)
3661 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3662 "localhost_number is greater than the maximum allowed value (%d)",
3668 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3670 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3671 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3672 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3673 tls_verify_hosts ? "" : "try_");
3675 /* Magic number: at time of writing, 1024 has been the long-standing value
3676 used by so many clients, and what Exim used to use always, that it makes
3677 sense to just min-clamp this max-clamp at that. */
3678 if (tls_dh_max_bits < 1024)
3679 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3680 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3682 /* If openssl_options is set, validate it */
3683 if (openssl_options)
3686 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3687 "openssl_options is set but we're using GnuTLS");
3690 if (!tls_openssl_options_parse(openssl_options, &dummy))
3691 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3692 "openssl_options parse error: %s", openssl_options);
3695 #endif /*DISABLE_TLS*/
3697 if (!nowarn && !keep_environment && environ && *environ)
3698 log_write(0, LOG_MAIN,
3699 "Warning: purging the environment.\n"
3700 " Suggested action: use keep_environment.");
3705 /* Add a driver info struct to a list. */
3708 add_driver_info(driver_info ** drlist_p, const driver_info * newent,
3711 driver_info * listent = store_get(size, newent);
3712 memcpy(listent, newent, size);
3713 listent->next = *drlist_p;
3717 /*************************************************
3718 * Initialize one driver *
3719 *************************************************/
3721 /* This is called once the driver's generic options, if any, have been read.
3722 We can now find the driver, set up defaults for the private options, and
3723 unset any "set" bits in the private options table (which might have been
3724 set by another incarnation of the same driver).
3727 d pointer to driver instance block, with generic
3729 info_anchor list of available drivers
3730 size_of_info size of each block in drivers_available
3731 class class of driver
3733 Returns: pointer to the driver info block
3736 static driver_info *
3737 init_driver(driver_instance * d, driver_info ** info_anchor,
3738 int size_of_info, const uschar * class)
3744 /* First scan the list of driver seen so far. */
3746 for (di = *info_anchor; di; di = di->next)
3747 if (Ustrcmp(d->driver_name, di->driver_name) == 0)
3750 #ifdef LOOKUP_MODULE_DIR
3751 /* Potentially a loadable module. Look for a file with the right name. */
3753 if (!(dd = exim_opendir(CUS LOOKUP_MODULE_DIR)))
3755 log_write(0, LOG_MAIN|LOG_PANIC,
3756 "Couldn't open %s: not loading driver modules\n", LOOKUP_MODULE_DIR);
3760 uschar * fname = string_sprintf("%s_%s." DYNLIB_FN_EXT, d->driver_name, class), * sname;
3761 const char * errormsg;
3763 DEBUG(D_any) debug_printf("Loading %s %s driver from %s\n",
3764 d->driver_name, class, LOOKUP_MODULE_DIR);
3766 for(struct dirent * ent; ent = readdir(dd); ) if (Ustrcmp(ent->d_name, fname) == 0)
3768 void * dl = dlopen(CS string_sprintf(LOOKUP_MODULE_DIR "/%s", fname), RTLD_NOW);
3769 static driver_magics dm[] = {
3770 { ROUTER_MAGIC, US"router" },
3771 { TRANSPORT_MAGIC, US"transport" },
3772 { AUTH_MAGIC, US"auth" },
3777 errormsg = dlerror();
3778 log_write(0, LOG_MAIN|LOG_PANIC, "Error loading %s %s driver: %s\n",
3779 d->driver_name, class, errormsg);
3782 (void) dlerror(); /* cf. comment in init_lookup_list() */
3784 di = (driver_info *) dlsym(dl, CS string_sprintf("_%s_info", class));
3785 if ((errormsg = dlerror()))
3787 log_write(0, LOG_MAIN|LOG_PANIC,
3788 "%s does not appear to be a %s module (%s)\n", fname, class, errormsg);
3792 for(driver_magics * dmp = dm; dmp < dm + nelem(dm); dmp++)
3793 if(Ustrcmp(dmp->class, class) == 0 && dmp->magic == di->dyn_magic)
3795 int old_pool = store_pool;
3796 store_pool = POOL_PERM;
3797 add_driver_info(info_anchor, di, size_of_info);
3798 store_pool = old_pool;
3799 DEBUG(D_any) debug_printf("Loaded %s %s\n", d->driver_name, class);
3804 log_write(0, LOG_MAIN|LOG_PANIC,
3805 "%s module %s is not compatible with this version of Exim\n",
3806 class, d->driver_name);
3812 #endif /* LOOKUP_MODULE_DIR */
3814 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3815 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3819 len = di->options_len;
3821 d->options_block = store_get_perm(len, GET_UNTAINTED);
3822 memcpy(d->options_block, di->options_block, len);
3823 for (int i = 0; i < *di->options_count; i++)
3824 di->options[i].type &= ~opt_set;
3832 driver_init_fini(driver_instance * d, const uschar * class)
3834 driver_info * di = d->info;
3836 if (!d->driver_name)
3837 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3838 "no driver defined for %s \"%s\"", class, d->name);
3843 /*************************************************
3844 * Initialize driver list *
3845 *************************************************/
3847 /* This function is called for routers, transports, and authentication
3848 mechanisms. It reads the data from the current point in the configuration file
3849 up to the end of the section, and sets up a chain of instance blocks according
3850 to the file's contents. The file will already have been opened by a call to
3851 readconf_main, and must be left open for subsequent reading of further data.
3853 Any errors cause a panic crash. Note that the blocks with names driver_info and
3854 driver_instance must map the first portions of all the _info and _instance
3855 blocks for this shared code to work.
3858 anchor &routers, &transports, &auths
3859 info_anchor available drivers
3860 size_of_info size of each info block
3861 instance_default points to default data for an instance
3862 instance_size size of instance block
3863 driver_optionlist generic option list
3864 driver_optionlist_count count of generic option list
3865 class "router", "transport", or "auth"
3866 for filename component (and error message)
3872 readconf_driver_init(
3873 driver_instance ** anchor,
3874 driver_info ** info_anchor,
3876 void * instance_default,
3878 optionlist * driver_optionlist,
3879 int driver_optionlist_count,
3880 const uschar * class)
3882 driver_instance ** p = anchor;
3883 driver_instance * d = NULL;
3886 while ((buffer = get_config_line()))
3888 uschar name[EXIM_DRIVERNAME_MAX];
3891 /* Read the first name on the line and test for the start of a new driver. A
3892 macro definition indicates the end of the previous driver. If this isn't the
3893 start of a new driver, the line will be re-read. */
3895 s = readconf_readname(name, sizeof(name), buffer);
3897 /* Handle macro definition, first finishing off the initialization of the
3898 previous driver, if any. */
3900 if (isupper(*name) && *s == '=')
3904 /* s is using big_buffer, so this call had better not */
3905 driver_init_fini(d, class);
3908 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE);
3912 /* If the line starts with a name terminated by a colon, we are at the
3913 start of the definition of a new driver. The rest of the line must be
3918 /* Finish off initializing the previous driver. */
3921 driver_init_fini(d, class);
3923 /* Check that we haven't already got a driver of this name */
3925 for (d = *anchor; d; d = d->next)
3926 if (Ustrcmp(name, d->name) == 0)
3927 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3928 "there are two %ss called \"%s\"", class, name);
3930 /* Set up a new driver instance data block on the chain, with
3931 its default values installed. */
3933 d = store_get_perm(instance_size, GET_UNTAINTED);
3934 memcpy(d, instance_default, instance_size);
3936 p = (driver_instance **)&d->next;
3937 d->name = string_copy(name);
3938 d->srcfile = config_filename;
3939 d->srcline = config_lineno;
3941 /* Clear out the "set" bits in the generic options */
3943 for (int i = 0; i < driver_optionlist_count; i++)
3944 driver_optionlist[i].type &= ~opt_set;
3946 /* Check nothing more on this line, then do the next loop iteration. */
3948 Uskip_whitespace(&s);
3949 if (*s) extra_chars_error(s, US"driver name ", name, US"");
3953 /* Not the start of a new driver. Give an error if we have not set up a
3954 current driver yet. */
3957 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3959 /* First look to see if this is a generic option; if it is "driver",
3960 initialize the driver. If is it not a generic option, we can look for a
3961 private option provided that the driver has been previously set up. */
3963 if (readconf_handle_option(buffer, driver_optionlist,
3964 driver_optionlist_count, d, NULL))
3966 if (!d->info && d->driver_name)
3967 init_driver(d, info_anchor, size_of_info, class);
3970 /* Handle private options - pass the generic block because some may
3971 live therein. A flag with each option indicates if it is in the public
3976 driver_info * di = d->info;
3977 readconf_handle_option(buffer, di->options,
3978 *di->options_count, d, US"option \"%s\" unknown");
3981 /* The option is not generic and the driver name has not yet been given. */
3983 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3984 "(\"driver\" must be specified before any private options)", name);
3987 /* Run the initialization function for the final driver. */
3990 driver_init_fini(d, class);
3995 /*************************************************
3996 * Check driver dependency *
3997 *************************************************/
3999 /* This function is passed a driver instance and a string. It checks whether
4000 any of the string options for the driver contains the given string as an
4004 d points to a driver instance block
4005 s the string to search for
4007 Returns: TRUE if a dependency is found
4011 readconf_depends(driver_instance * d, uschar * s)
4013 driver_info * di = d->info;
4014 int count = *di->options_count;
4017 for (optionlist * ol = di->options; ol < di->options + count; ol++)
4018 if ((ol->type & opt_mask) == opt_stringptr)
4020 void * options_block = ol->type & opt_public ? (void *)d : d->options_block;
4021 uschar * value = *USS(US options_block + ol->v.offset);
4023 if (value && (ss = Ustrstr(value, s)) != NULL)
4025 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
4026 isalnum(ss[Ustrlen(s)])) continue;
4027 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
4028 d->name, ol->name, s);
4033 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
4040 /*************************************************
4041 * Decode an error type for retries *
4042 *************************************************/
4044 /* This function is global because it is also called from the main
4045 program when testing retry information. It decodes strings such as "quota_7d"
4046 into numerical error codes.
4049 pp points to start of text
4050 p points past end of text
4051 basic_errno points to an int to receive the main error number
4052 more_errno points to an int to receive the secondary error data
4054 Returns: NULL if decoded correctly; else points to error text
4058 readconf_retry_error(const uschar *pp, const uschar *p,
4059 int *basic_errno, int *more_errno)
4062 const uschar *q = pp;
4063 while (q < p && *q != '_') q++;
4066 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
4068 *basic_errno = ERRNO_EXIMQUOTA;
4069 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
4070 return US"bad time value";
4073 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
4075 *basic_errno = ECONNREFUSED;
4078 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
4079 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
4080 else return US"A or MX expected after \"refused\"";
4084 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
4086 *basic_errno = ETIMEDOUT;
4090 int xlen = p - q - 1;
4091 const uschar *x = q + 1;
4093 static uschar *extras[] =
4094 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
4095 static int values[] =
4096 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
4098 for (i = 0; i < nelem(extras); i++)
4099 if (strncmpic(x, extras[i], xlen) == 0)
4101 *more_errno = values[i];
4105 if (i >= nelem(extras))
4106 if (strncmpic(x, US"DNS", xlen) == 0)
4107 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
4108 "available in retry rules (it has never worked) - treated as "
4111 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
4115 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
4116 strncmpic(pp, US"rcpt_4", 6) == 0 ||
4117 strncmpic(pp, US"data_4", 6) == 0)
4120 int x = 255; /* means "any 4xx code" */
4121 if (p != pp + 8) bad = TRUE; else
4123 int a = pp[6], b = pp[7];
4127 if (isdigit(b)) x += b - '0';
4128 else if (b == 'x') x += 100;
4131 else if (a != 'x' || b != 'x') bad = TRUE;
4135 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
4136 "x is literal and d is any digit", pp);
4138 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4139 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4140 *more_errno = x << 8;
4143 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4144 strncmpic(q+1, US"failed", p-q-1) == 0)
4145 *basic_errno = ERRNO_AUTHFAIL;
4147 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4148 *basic_errno = ERRNO_SMTPCLOSED;
4150 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4151 *basic_errno = ERRNO_TLSREQUIRED;
4153 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4154 *basic_errno = ERRNO_UNKNOWNHOST;
4156 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4157 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4165 /*************************************************
4166 * Read retry information *
4167 *************************************************/
4169 /* Each line of retry information contains:
4171 . A domain name pattern or an address pattern;
4173 . An error name, possibly with additional data, or *;
4175 . An optional sequence of retry items, each consisting of an identifying
4176 letter, a cutoff time, and optional parameters.
4178 All this is decoded and placed into a control block. */
4181 /* Subroutine to read an argument, preceded by a comma and terminated
4182 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4183 1 = fixed point number (returned *1000).
4186 paddr pointer to pointer to current character; updated
4187 type 0 => read a time; 1 => read a fixed point number
4189 Returns: time in seconds or fixed point number * 1000
4193 retry_arg(const uschar ** paddr, int type)
4195 const uschar * p = *paddr, * pp;
4197 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4199 Uskip_whitespace(&p);
4201 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4203 if (*p && !isspace(*p) && *p != ',' && *p != ';')
4204 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4209 case 0: return readconf_readtime(pp, *p, FALSE);
4210 case 1: return readconf_readfixed(pp, *p);
4212 return 0; /* Keep picky compilers happy */
4215 /* The function proper */
4218 readconf_retries(void)
4220 retry_config **chain = &retries;
4224 while ((p = get_config_line()))
4226 retry_rule **rchain;
4230 next = store_get(sizeof(retry_config), GET_UNTAINTED);
4233 chain = &(next->next);
4234 next->basic_errno = next->more_errno = 0;
4235 next->senders = NULL;
4237 rchain = &(next->rules);
4239 next->pattern = string_dequote(&p);
4240 Uskip_whitespace(&p);
4242 while (mac_isgraph(*p)) p++;
4243 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4244 "missing error type in retry rule");
4246 /* Test error names for things we understand. */
4248 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4249 &next->more_errno)))
4250 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4252 /* There may be an optional address list of senders to be used as another
4253 constraint on the rule. This was added later, so the syntax is a bit of a
4254 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4257 Uskip_whitespace(&p);
4258 if (Ustrncmp(p, "senders", 7) == 0)
4261 Uskip_whitespace(&p);
4262 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4263 "\"=\" expected after \"senders\" in retry rule");
4264 Uskip_whitespace(&p);
4265 next->senders = string_dequote(&p);
4268 /* Now the retry rules. Keep the maximum timeout encountered. */
4270 Uskip_whitespace(&p);
4274 retry_rule * rule = store_get(sizeof(retry_rule), GET_UNTAINTED);
4276 rchain = &(rule->next);
4278 rule->rule = toupper(*p++);
4279 rule->timeout = retry_arg(&p, 0);
4280 if (rule->timeout > retry_maximum_timeout)
4281 retry_maximum_timeout = rule->timeout;
4285 case 'F': /* Fixed interval */
4286 rule->p1 = retry_arg(&p, 0);
4289 case 'G': /* Geometrically increasing intervals */
4290 case 'H': /* Ditto, but with randomness */
4291 rule->p1 = retry_arg(&p, 0);
4292 rule->p2 = retry_arg(&p, 1);
4296 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4300 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4301 (rule->rule != 'F' && rule->p2 < 1000))
4302 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4303 "bad parameters for retry rule");
4305 if (Uskip_whitespace(&p) == ';')
4308 Uskip_whitespace(&p);
4311 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4318 /*************************************************
4319 * Initialize authenticators *
4320 *************************************************/
4322 /* Read the authenticators section of the configuration file.
4331 #ifndef DISABLE_PIPE_CONNECT
4334 int old_pool = store_pool;
4335 store_pool = POOL_PERM;
4337 driver_info ** anchor = (driver_info **) &auths_available;
4338 extern auth_info cram_md5_auth_info;
4339 extern auth_info cyrus_sasl_auth_info;
4340 extern auth_info dovecot_auth_info;
4341 extern auth_info external_auth_info;
4342 extern auth_info gsasl_auth_info;
4343 extern auth_info heimdal_gssapi_auth_info;
4344 extern auth_info plaintext_auth_info;
4345 extern auth_info spa_auth_info;
4346 extern auth_info tls_auth_info;
4348 /* Add the transport drivers that are built for static linkage to the
4349 list of availables. */
4351 #if defined(AUTH_CRAM_MD5) && AUTH_CRAM_MD5!=2
4352 add_driver_info(anchor, &cram_md5_auth_info.drinfo, sizeof(auth_info));
4354 #if defined(AUTH_CYRUS_SASL) && AUTH_CYRUS_SASL!=2
4355 add_driver_info(anchor, &cyrus_sasl_auth_info.drinfo, sizeof(auth_info));
4357 #if defined(AUTH_DOVECOT) && AUTH_DOVECOT!=2
4358 add_driver_info(anchor, &dovecot_auth_info.drinfo, sizeof(auth_info));
4360 #if defined(AUTH_EXTERNAL) && AUTH_EXTERNAL!=2
4361 add_driver_info(anchor, &external_auth_info.drinfo, sizeof(auth_info));
4363 #if defined(AUTH_GSASL) && AUTH_GSASL!=2
4364 add_driver_info(anchor, &gsasl_auth_info.drinfo, sizeof(auth_info));
4366 #if defined(AUTH_HEIMDAL_GSSAPI) && AUTH_HEIMDAL_GSSAPI!=2
4367 add_driver_info(anchor, &heimdal_gssapi_auth_info.drinfo, sizeof(auth_info));
4369 #if defined(AUTH_PLAINTEXT) && AUTH_PLAINTEXT!=2
4370 add_driver_info(anchor, &plaintext_auth_info.drinfo, sizeof(auth_info));
4372 #if defined(AUTH_SPA) && AUTH_SPA!=2
4373 add_driver_info(anchor, &spa_auth_info.drinfo, sizeof(auth_info));
4375 #if defined(AUTH_TLS) && AUTH_TLS!=2
4376 add_driver_info(anchor, &tls_auth_info.drinfo, sizeof(auth_info));
4379 store_pool = old_pool;
4381 /* Read the config file "authenticators" section, creating an auth instance list.
4382 For any yet-undiscovered driver, check for a loadable module and add it to
4385 readconf_driver_init((driver_instance **)&auths, /* chain anchor */
4386 (driver_info **)&auths_available, /* available drivers */
4387 sizeof(auth_info), /* size of info block */
4388 &auth_defaults, /* default values for generic options */
4389 sizeof(auth_instance), /* size of instance block */
4390 optionlist_auths, /* generic options */
4391 optionlist_auths_size,
4394 for (auth_instance * au = auths; au; au = au->drinst.next)
4396 if (!au->public_name)
4397 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4398 "the %s authenticator", au->drinst.name);
4400 for (auth_instance * bu = au->drinst.next; bu; bu = bu->drinst.next)
4401 if (strcmpic(au->public_name, bu->public_name) == 0)
4402 if ( au->client && bu->client
4403 || au->server && bu->server)
4404 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4405 "(%s and %s) have the same public name (%s)",
4406 au->client && bu->client ? US"client" : US"server",
4407 au->drinst.name, bu->drinst.name, au->public_name);
4408 #ifndef DISABLE_PIPE_CONNECT
4412 #ifndef DISABLE_PIPE_CONNECT
4413 f.smtp_in_early_pipe_no_auth = nauths > 16; /* bits in bitmap limit */
4418 /* For error messages, a string describing the config location associated
4419 with current processing. NULL if we are not in an authenticator. */
4422 authenticator_current_name(void)
4424 if (!authenticator_name) return NULL;
4425 return string_sprintf(" (authenticator %s, %s %d)", authenticator_name, driver_srcfile, driver_srcline);
4432 /*************************************************
4433 * Read ACL information *
4434 *************************************************/
4436 /* If this run of Exim is not doing something that involves receiving a
4437 message, we can just skip over the ACL information. No need to parse it.
4439 First, we have a function for acl_read() to call back to get the next line. We
4440 need to remember the line we passed, because at the end it will contain the
4441 name of the next ACL. */
4443 static uschar *acl_line;
4448 acl_line = get_config_line();
4453 /* Now the main function:
4462 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4465 acl_line = get_config_line();
4469 uschar name[EXIM_DRIVERNAME_MAX];
4472 const uschar * p = readconf_readname(name, sizeof(name), acl_line);
4474 if (isupper(*name) && *p == '=')
4476 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE);
4477 acl_line = get_config_line();
4481 if (*p != ':' || name[0] == 0)
4482 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4484 node = store_get_perm(sizeof(tree_node) + Ustrlen(name), name);
4485 Ustrcpy(node->name, name);
4486 if (!tree_insertnode(&acl_anchor, node))
4487 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4488 "there are two ACLs called \"%s\"", name);
4490 node->data.ptr = acl_read(acl_callback, &error);
4492 if (node->data.ptr == NULL && error != NULL)
4493 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4499 /*************************************************
4500 * Read configuration for local_scan() *
4501 *************************************************/
4503 /* This function is called after "begin local_scan" is encountered in the
4504 configuration file. If the local_scan() function allows for configuration
4505 options, we can process them. Otherwise, we expire in a panic.
4512 local_scan_init(void)
4514 #ifndef LOCAL_SCAN_HAS_OPTIONS
4515 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4516 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4520 while ((p = get_config_line()))
4521 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4522 NULL, US"local_scan option \"%s\" unknown");
4528 /*************************************************
4529 * Read rest of configuration (after main) *
4530 *************************************************/
4532 /* This function reads the rest of the runtime configuration, after the main
4533 configuration. It is called only when actually needed. Each subsequent section
4534 of the configuration starts with a line of the form
4538 where the name is "routers", "transports", etc. A section is terminated by
4539 hitting the next "begin" line, and the next name is left in next_section.
4540 Because it may confuse people as to whether the names are singular or plural,
4541 we add "s" if it's missing. There is always enough room in next_section for
4542 this. This function is basically just a switch.
4548 static uschar *section_list[] = {
4562 while(next_section[0] != 0)
4566 int last = nelem(section_list);
4568 int n = Ustrlen(next_section);
4570 READCONF_DEBUG fprintf(stderr, "%s: %s\n", __FUNCTION__, next_section);
4571 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, US"s");
4575 int c = strcmpic(next_section, section_list[mid]);
4577 if (c > 0) first = mid + 1; else last = mid;
4579 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4580 "\"%.*s\" is not a known configuration section name", n, next_section);
4581 mid = (last + first)/2;
4585 if (((had ^= bit) & bit) == 0)
4586 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4587 "\"%.*s\" section is repeated in the configuration file", n,
4592 case 0: readconf_acl(); break;
4593 case 1: auths_init(); break;
4594 case 2: local_scan_init(); break;
4595 case 3: readconf_retries(); break;
4596 case 4: readconf_rewrites(); break;
4597 case 5: route_init(); break;
4598 case 6: transport_init(); break;
4602 (void)fclose(config_file);
4605 /* Init the storage for the pre-parsed config lines */
4607 readconf_save_config(const uschar *s)
4609 save_config_line(string_sprintf("# Exim Configuration (%s)",
4610 f.running_in_test_harness ? US"X" : s));
4614 save_config_position(const uschar *file, int line)
4616 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4619 /* Append a pre-parsed logical line to the config lines store,
4620 this operates on a global (static) list that holds all the pre-parsed
4621 config lines, we do no further processing here, output formatting and
4622 honouring of <hide> or macros will be done during output */
4625 save_config_line(const uschar* line)
4627 static config_line_item *current;
4628 config_line_item *next;
4630 next = (config_line_item*) store_get(sizeof(config_line_item), GET_UNTAINTED);
4631 next->line = string_copy(line);
4634 if (!config_lines) config_lines = next;
4635 else current->next = next;
4640 /* List the parsed config lines, care about nice formatting and
4641 hide the <hide> values unless we're the admin user */
4643 print_config(BOOL admin, BOOL terse)
4645 const int TS = terse ? 0 : 2;
4649 for (const config_line_item * i = config_lines; i; i = i->next)
4651 uschar * current, * p;
4653 if (r) store_reset(r);
4656 /* skip over to the first non-space */
4657 current = string_copy(i->line);
4658 if (!Uskip_whitespace(¤t))
4661 /* Collapse runs of spaces. We stop this if we encounter one of the
4662 following characters: "'$, as this may indicate careful formatting */
4664 for (p = current; *p; p++) if (isspace(*p))
4667 if (*p != ' ') *p = ' ';
4669 Uskip_whitespace(&p);
4672 memmove(p+1, next, Ustrlen(next)+1);
4674 if (*next == '"' || *next == '\'' || *next == '$')
4679 if (current[0] == '#')
4682 /* begin lines are left aligned */
4683 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4685 if (!terse) puts("");
4690 /* router/acl/transport block names */
4691 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4693 if (!terse) puts("");
4694 printf("%*s%s\n", TS, "", current);
4698 /* hidden lines (all MACROS or lines prefixed with "hide") */
4700 && ( isupper(*current)
4701 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4705 if ((p = Ustrchr(current, '=')))
4708 printf("%*s%s= %s\n", indent, "", current, CCS hidden);
4710 /* e.g.: hide split_spool_directory */
4712 printf("%*s\n", indent, CCS hidden);
4716 /* rest is public */
4717 printf("%*s%s\n", indent, "", current);
4719 if (r) store_reset(r);
4722 #endif /*!MACRO_PREDEF*/
4725 /* End of readconf.c */