1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for reading the configuration file, and for displaying
9 overall configuration values. Thanks to Brian Candler for the original
10 implementation of the conditional .ifdef etc. */
15 # include "macro_predef.h"
18 #define READCONF_DEBUG if (FALSE) /* Change to TRUE to enable */
21 static uschar * syslog_facility_str;
22 static void fn_smtp_receive_timeout(const uschar *, const uschar *, unsigned);
24 /*************************************************
25 * Main configuration options *
26 *************************************************/
28 /* The list of options that can be set in the main configuration file. This
29 must be in alphabetic order because it is searched by binary chop. */
31 static optionlist optionlist_config[] = {
32 { "*set_exim_group", opt_bool|opt_hidden, {&exim_gid_set} },
33 { "*set_exim_user", opt_bool|opt_hidden, {&exim_uid_set} },
34 { "*set_system_filter_group", opt_bool|opt_hidden, {&system_filter_gid_set} },
35 { "*set_system_filter_user", opt_bool|opt_hidden, {&system_filter_uid_set} },
36 { "accept_8bitmime", opt_bool, {&accept_8bitmime} },
37 { "acl_not_smtp", opt_stringptr, {&acl_not_smtp} },
38 #ifdef WITH_CONTENT_SCAN
39 { "acl_not_smtp_mime", opt_stringptr, {&acl_not_smtp_mime} },
41 { "acl_not_smtp_start", opt_stringptr, {&acl_not_smtp_start} },
42 { "acl_smtp_auth", opt_stringptr, {&acl_smtp_auth} },
43 { "acl_smtp_connect", opt_stringptr, {&acl_smtp_connect} },
44 { "acl_smtp_data", opt_stringptr, {&acl_smtp_data} },
46 { "acl_smtp_data_prdr", opt_stringptr, {&acl_smtp_data_prdr} },
49 { "acl_smtp_dkim", opt_stringptr, {&acl_smtp_dkim} },
51 { "acl_smtp_etrn", opt_stringptr, {&acl_smtp_etrn} },
52 { "acl_smtp_expn", opt_stringptr, {&acl_smtp_expn} },
53 { "acl_smtp_helo", opt_stringptr, {&acl_smtp_helo} },
54 { "acl_smtp_mail", opt_stringptr, {&acl_smtp_mail} },
55 { "acl_smtp_mailauth", opt_stringptr, {&acl_smtp_mailauth} },
56 #ifdef WITH_CONTENT_SCAN
57 { "acl_smtp_mime", opt_stringptr, {&acl_smtp_mime} },
59 { "acl_smtp_notquit", opt_stringptr, {&acl_smtp_notquit} },
60 { "acl_smtp_predata", opt_stringptr, {&acl_smtp_predata} },
61 { "acl_smtp_quit", opt_stringptr, {&acl_smtp_quit} },
62 { "acl_smtp_rcpt", opt_stringptr, {&acl_smtp_rcpt} },
64 { "acl_smtp_starttls", opt_stringptr, {&acl_smtp_starttls} },
66 { "acl_smtp_vrfy", opt_stringptr, {&acl_smtp_vrfy} },
67 { "add_environment", opt_stringptr, {&add_environment} },
68 { "admin_groups", opt_gidlist, {&admin_groups} },
69 { "allow_domain_literals", opt_bool, {&allow_domain_literals} },
70 { "allow_mx_to_ip", opt_bool, {&allow_mx_to_ip} },
71 { "allow_utf8_domains", opt_bool, {&allow_utf8_domains} },
72 { "auth_advertise_hosts", opt_stringptr, {&auth_advertise_hosts} },
73 { "auto_thaw", opt_time, {&auto_thaw} },
74 #ifdef WITH_CONTENT_SCAN
75 { "av_scanner", opt_stringptr, {&av_scanner} },
77 { "bi_command", opt_stringptr, {&bi_command} },
78 #ifdef EXPERIMENTAL_BRIGHTMAIL
79 { "bmi_config_file", opt_stringptr, {&bmi_config_file} },
81 { "bounce_message_file", opt_stringptr, {&bounce_message_file} },
82 { "bounce_message_text", opt_stringptr, {&bounce_message_text} },
83 { "bounce_return_body", opt_bool, {&bounce_return_body} },
84 { "bounce_return_linesize_limit", opt_mkint, {&bounce_return_linesize_limit} },
85 { "bounce_return_message", opt_bool, {&bounce_return_message} },
86 { "bounce_return_size_limit", opt_mkint, {&bounce_return_size_limit} },
87 { "bounce_sender_authentication",opt_stringptr,{&bounce_sender_authentication} },
88 { "callout_domain_negative_expire", opt_time, {&callout_cache_domain_negative_expire} },
89 { "callout_domain_positive_expire", opt_time, {&callout_cache_domain_positive_expire} },
90 { "callout_negative_expire", opt_time, {&callout_cache_negative_expire} },
91 { "callout_positive_expire", opt_time, {&callout_cache_positive_expire} },
92 { "callout_random_local_part",opt_stringptr, {&callout_random_local_part} },
93 { "check_log_inodes", opt_int, {&check_log_inodes} },
94 { "check_log_space", opt_Kint, {&check_log_space} },
95 { "check_rfc2047_length", opt_bool, {&check_rfc2047_length} },
96 { "check_spool_inodes", opt_int, {&check_spool_inodes} },
97 { "check_spool_space", opt_Kint, {&check_spool_space} },
98 { "chunking_advertise_hosts", opt_stringptr, {&chunking_advertise_hosts} },
99 { "commandline_checks_require_admin", opt_bool,{&commandline_checks_require_admin} },
100 { "daemon_smtp_port", opt_stringptr|opt_hidden, {&daemon_smtp_port} },
101 { "daemon_smtp_ports", opt_stringptr, {&daemon_smtp_port} },
102 { "daemon_startup_retries", opt_int, {&daemon_startup_retries} },
103 { "daemon_startup_sleep", opt_time, {&daemon_startup_sleep} },
104 #ifdef EXPERIMENTAL_DCC
105 { "dcc_direct_add_header", opt_bool, {&dcc_direct_add_header} },
106 { "dccifd_address", opt_stringptr, {&dccifd_address} },
107 { "dccifd_options", opt_stringptr, {&dccifd_options} },
109 { "debug_store", opt_bool, {&debug_store} },
110 { "delay_warning", opt_timelist, {&delay_warning} },
111 { "delay_warning_condition", opt_stringptr, {&delay_warning_condition} },
112 { "deliver_drop_privilege", opt_bool, {&deliver_drop_privilege} },
113 { "deliver_queue_load_max", opt_fixed, {&deliver_queue_load_max} },
114 { "delivery_date_remove", opt_bool, {&delivery_date_remove} },
115 #ifdef ENABLE_DISABLE_FSYNC
116 { "disable_fsync", opt_bool, {&disable_fsync} },
118 { "disable_ipv6", opt_bool, {&disable_ipv6} },
120 { "dkim_verify_hashes", opt_stringptr, {&dkim_verify_hashes} },
121 { "dkim_verify_keytypes", opt_stringptr, {&dkim_verify_keytypes} },
122 { "dkim_verify_minimal", opt_bool, {&dkim_verify_minimal} },
123 { "dkim_verify_signers", opt_stringptr, {&dkim_verify_signers} },
126 { "dmarc_forensic_sender", opt_stringptr, {&dmarc_forensic_sender} },
127 { "dmarc_history_file", opt_stringptr, {&dmarc_history_file} },
128 { "dmarc_tld_file", opt_stringptr, {&dmarc_tld_file} },
130 { "dns_again_means_nonexist", opt_stringptr, {&dns_again_means_nonexist} },
131 { "dns_check_names_pattern", opt_stringptr, {&check_dns_names_pattern} },
132 { "dns_cname_loops", opt_int, {&dns_cname_loops} },
133 { "dns_csa_search_limit", opt_int, {&dns_csa_search_limit} },
134 { "dns_csa_use_reverse", opt_bool, {&dns_csa_use_reverse} },
135 { "dns_dnssec_ok", opt_int, {&dns_dnssec_ok} },
136 { "dns_ipv4_lookup", opt_stringptr, {&dns_ipv4_lookup} },
137 { "dns_retrans", opt_time, {&dns_retrans} },
138 { "dns_retry", opt_int, {&dns_retry} },
139 { "dns_trust_aa", opt_stringptr, {&dns_trust_aa} },
140 { "dns_use_edns0", opt_int, {&dns_use_edns0} },
141 /* This option is now a no-op, retained for compatibility */
142 { "drop_cr", opt_bool, {&drop_cr} },
143 /*********************************************************/
144 { "dsn_advertise_hosts", opt_stringptr, {&dsn_advertise_hosts} },
145 { "dsn_from", opt_stringptr, {&dsn_from} },
146 { "envelope_to_remove", opt_bool, {&envelope_to_remove} },
147 { "errors_copy", opt_stringptr, {&errors_copy} },
148 { "errors_reply_to", opt_stringptr, {&errors_reply_to} },
149 #ifndef DISABLE_EVENT
150 { "event_action", opt_stringptr, {&event_action} },
152 { "exim_group", opt_gid, {&exim_gid} },
153 { "exim_path", opt_stringptr, {&exim_path} },
154 { "exim_user", opt_uid, {&exim_uid} },
155 { "exim_version", opt_stringptr, {&version_string} },
156 { "extra_local_interfaces", opt_stringptr, {&extra_local_interfaces} },
157 { "extract_addresses_remove_arguments", opt_bool, {&extract_addresses_remove_arguments} },
158 { "finduser_retries", opt_int, {&finduser_retries} },
159 { "freeze_tell", opt_stringptr, {&freeze_tell} },
160 { "gecos_name", opt_stringptr, {&gecos_name} },
161 { "gecos_pattern", opt_stringptr, {&gecos_pattern} },
163 { "gnutls_allow_auto_pkcs11", opt_bool, {&gnutls_allow_auto_pkcs11} },
164 { "gnutls_compat_mode", opt_bool, {&gnutls_compat_mode} },
166 { "header_line_maxsize", opt_int, {&header_line_maxsize} },
167 { "header_maxsize", opt_int, {&header_maxsize} },
168 { "headers_charset", opt_stringptr, {&headers_charset} },
169 { "helo_accept_junk_hosts", opt_stringptr, {&helo_accept_junk_hosts} },
170 { "helo_allow_chars", opt_stringptr, {&helo_allow_chars} },
171 { "helo_lookup_domains", opt_stringptr, {&helo_lookup_domains} },
172 { "helo_try_verify_hosts", opt_stringptr, {&helo_try_verify_hosts} },
173 { "helo_verify_hosts", opt_stringptr, {&helo_verify_hosts} },
174 { "hold_domains", opt_stringptr, {&hold_domains} },
175 { "host_lookup", opt_stringptr, {&host_lookup} },
176 { "host_lookup_order", opt_stringptr, {&host_lookup_order} },
177 { "host_reject_connection", opt_stringptr, {&host_reject_connection} },
178 { "hosts_connection_nolog", opt_stringptr, {&hosts_connection_nolog} },
180 { "hosts_proxy", opt_stringptr, {&hosts_proxy} },
182 { "hosts_treat_as_local", opt_stringptr, {&hosts_treat_as_local} },
184 { "ibase_servers", opt_stringptr, {&ibase_servers} },
186 { "ignore_bounce_errors_after", opt_time, {&ignore_bounce_errors_after} },
187 { "ignore_fromline_hosts", opt_stringptr, {&ignore_fromline_hosts} },
188 { "ignore_fromline_local", opt_bool, {&ignore_fromline_local} },
189 { "keep_environment", opt_stringptr, {&keep_environment} },
190 { "keep_malformed", opt_time, {&keep_malformed} },
192 { "ldap_ca_cert_dir", opt_stringptr, {&eldap_ca_cert_dir} },
193 { "ldap_ca_cert_file", opt_stringptr, {&eldap_ca_cert_file} },
194 { "ldap_cert_file", opt_stringptr, {&eldap_cert_file} },
195 { "ldap_cert_key", opt_stringptr, {&eldap_cert_key} },
196 { "ldap_cipher_suite", opt_stringptr, {&eldap_cipher_suite} },
197 { "ldap_default_servers", opt_stringptr, {&eldap_default_servers} },
198 { "ldap_require_cert", opt_stringptr, {&eldap_require_cert} },
199 { "ldap_start_tls", opt_bool, {&eldap_start_tls} },
200 { "ldap_version", opt_int, {&eldap_version} },
202 { "local_from_check", opt_bool, {&local_from_check} },
203 { "local_from_prefix", opt_stringptr, {&local_from_prefix} },
204 { "local_from_suffix", opt_stringptr, {&local_from_suffix} },
205 { "local_interfaces", opt_stringptr, {&local_interfaces} },
206 #ifdef HAVE_LOCAL_SCAN
207 { "local_scan_timeout", opt_time, {&local_scan_timeout} },
209 { "local_sender_retain", opt_bool, {&local_sender_retain} },
210 { "localhost_number", opt_stringptr, {&host_number_string} },
211 { "log_file_path", opt_stringptr, {&log_file_path} },
212 { "log_selector", opt_stringptr, {&log_selector_string} },
213 { "log_timezone", opt_bool, {&log_timezone} },
214 { "lookup_open_max", opt_int, {&lookup_open_max} },
215 { "max_username_length", opt_int, {&max_username_length} },
216 { "message_body_newlines", opt_bool, {&message_body_newlines} },
217 { "message_body_visible", opt_mkint, {&message_body_visible} },
218 { "message_id_header_domain", opt_stringptr, {&message_id_domain} },
219 { "message_id_header_text", opt_stringptr, {&message_id_text} },
220 { "message_logs", opt_bool, {&message_logs} },
221 { "message_size_limit", opt_stringptr, {&message_size_limit} },
222 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
223 { "move_frozen_messages", opt_bool, {&move_frozen_messages} },
225 { "mua_wrapper", opt_bool, {&mua_wrapper} },
227 { "mysql_servers", opt_stringptr, {&mysql_servers} },
229 { "never_users", opt_uidlist, {&never_users} },
230 { "notifier_socket", opt_stringptr, {¬ifier_socket} },
232 { "openssl_options", opt_stringptr, {&openssl_options} },
235 { "oracle_servers", opt_stringptr, {&oracle_servers} },
237 { "percent_hack_domains", opt_stringptr, {&percent_hack_domains} },
239 { "perl_at_start", opt_bool, {&opt_perl_at_start} },
240 { "perl_startup", opt_stringptr, {&opt_perl_startup} },
241 { "perl_taintmode", opt_bool, {&opt_perl_taintmode} },
244 { "pgsql_servers", opt_stringptr, {&pgsql_servers} },
246 { "pid_file_path", opt_stringptr, {&pid_file_path} },
247 { "pipelining_advertise_hosts", opt_stringptr, {&pipelining_advertise_hosts} },
248 #ifndef DISABLE_PIPE_CONNECT
249 { "pipelining_connect_advertise_hosts", opt_stringptr,
250 {&pipe_connect_advertise_hosts} },
253 { "prdr_enable", opt_bool, {&prdr_enable} },
255 { "preserve_message_logs", opt_bool, {&preserve_message_logs} },
256 { "primary_hostname", opt_stringptr, {&primary_hostname} },
257 { "print_topbitchars", opt_bool, {&print_topbitchars} },
258 { "process_log_path", opt_stringptr, {&process_log_path} },
259 { "prod_requires_admin", opt_bool, {&prod_requires_admin} },
260 { "qualify_domain", opt_stringptr, {&qualify_domain_sender} },
261 { "qualify_recipient", opt_stringptr, {&qualify_domain_recipient} },
262 { "queue_domains", opt_stringptr, {&queue_domains} },
263 #ifdef EXPERIMENTAL_QUEUE_RAMP
264 { "queue_fast_ramp", opt_bool, {&queue_fast_ramp} },
266 { "queue_list_requires_admin",opt_bool, {&queue_list_requires_admin} },
267 { "queue_only", opt_bool, {&queue_only} },
268 { "queue_only_file", opt_stringptr, {&queue_only_file} },
269 { "queue_only_load", opt_fixed, {&queue_only_load} },
270 { "queue_only_load_latch", opt_bool, {&queue_only_load_latch} },
271 { "queue_only_override", opt_bool, {&queue_only_override} },
272 { "queue_run_in_order", opt_bool, {&queue_run_in_order} },
273 { "queue_run_max", opt_stringptr, {&queue_run_max} },
274 { "queue_smtp_domains", opt_stringptr, {&queue_smtp_domains} },
275 { "receive_timeout", opt_time, {&receive_timeout} },
276 { "received_header_text", opt_stringptr, {&received_header_text} },
277 { "received_headers_max", opt_int, {&received_headers_max} },
278 { "recipient_unqualified_hosts", opt_stringptr, {&recipient_unqualified_hosts} },
279 { "recipients_max", opt_int, {&recipients_max} },
280 { "recipients_max_reject", opt_bool, {&recipients_max_reject} },
282 { "redis_servers", opt_stringptr, {&redis_servers} },
284 { "remote_max_parallel", opt_int, {&remote_max_parallel} },
285 { "remote_sort_domains", opt_stringptr, {&remote_sort_domains} },
286 { "retry_data_expire", opt_time, {&retry_data_expire} },
287 { "retry_interval_max", opt_time, {&retry_interval_max} },
288 { "return_path_remove", opt_bool, {&return_path_remove} },
289 { "return_size_limit", opt_mkint|opt_hidden, {&bounce_return_size_limit} },
290 { "rfc1413_hosts", opt_stringptr, {&rfc1413_hosts} },
291 { "rfc1413_query_timeout", opt_time, {&rfc1413_query_timeout} },
292 { "sender_unqualified_hosts", opt_stringptr, {&sender_unqualified_hosts} },
293 { "slow_lookup_log", opt_int, {&slow_lookup_log} },
294 { "smtp_accept_keepalive", opt_bool, {&smtp_accept_keepalive} },
295 { "smtp_accept_max", opt_int, {&smtp_accept_max} },
296 { "smtp_accept_max_nonmail", opt_int, {&smtp_accept_max_nonmail} },
297 { "smtp_accept_max_nonmail_hosts", opt_stringptr, {&smtp_accept_max_nonmail_hosts} },
298 { "smtp_accept_max_per_connection", opt_int, {&smtp_accept_max_per_connection} },
299 { "smtp_accept_max_per_host", opt_stringptr, {&smtp_accept_max_per_host} },
300 { "smtp_accept_queue", opt_int, {&smtp_accept_queue} },
301 { "smtp_accept_queue_per_connection", opt_int, {&smtp_accept_queue_per_connection} },
302 { "smtp_accept_reserve", opt_int, {&smtp_accept_reserve} },
303 { "smtp_active_hostname", opt_stringptr, {&raw_active_hostname} },
304 { "smtp_banner", opt_stringptr, {&smtp_banner} },
305 { "smtp_check_spool_space", opt_bool, {&smtp_check_spool_space} },
306 { "smtp_connect_backlog", opt_int, {&smtp_connect_backlog} },
307 { "smtp_enforce_sync", opt_bool, {&smtp_enforce_sync} },
308 { "smtp_etrn_command", opt_stringptr, {&smtp_etrn_command} },
309 { "smtp_etrn_serialize", opt_bool, {&smtp_etrn_serialize} },
310 { "smtp_load_reserve", opt_fixed, {&smtp_load_reserve} },
311 { "smtp_max_synprot_errors", opt_int, {&smtp_max_synprot_errors} },
312 { "smtp_max_unknown_commands",opt_int, {&smtp_max_unknown_commands} },
313 { "smtp_ratelimit_hosts", opt_stringptr, {&smtp_ratelimit_hosts} },
314 { "smtp_ratelimit_mail", opt_stringptr, {&smtp_ratelimit_mail} },
315 { "smtp_ratelimit_rcpt", opt_stringptr, {&smtp_ratelimit_rcpt} },
316 { "smtp_receive_timeout", opt_func, {.fn = &fn_smtp_receive_timeout} },
317 { "smtp_reserve_hosts", opt_stringptr, {&smtp_reserve_hosts} },
318 { "smtp_return_error_details",opt_bool, {&smtp_return_error_details} },
320 { "smtputf8_advertise_hosts", opt_stringptr, {&smtputf8_advertise_hosts} },
322 #ifdef WITH_CONTENT_SCAN
323 { "spamd_address", opt_stringptr, {&spamd_address} },
326 { "spf_guess", opt_stringptr, {&spf_guess} },
328 { "split_spool_directory", opt_bool, {&split_spool_directory} },
329 { "spool_directory", opt_stringptr, {&spool_directory} },
330 { "spool_wireformat", opt_bool, {&spool_wireformat} },
332 { "sqlite_dbfile", opt_stringptr, {&sqlite_dbfile} },
333 { "sqlite_lock_timeout", opt_int, {&sqlite_lock_timeout} },
335 #ifdef EXPERIMENTAL_SRS
336 { "srs_config", opt_stringptr, {&srs_config} },
337 { "srs_hashlength", opt_int, {&srs_hashlength} },
338 { "srs_hashmin", opt_int, {&srs_hashmin} },
339 { "srs_maxage", opt_int, {&srs_maxage} },
340 { "srs_secrets", opt_stringptr, {&srs_secrets} },
341 { "srs_usehash", opt_bool, {&srs_usehash} },
342 { "srs_usetimestamp", opt_bool, {&srs_usetimestamp} },
344 { "strict_acl_vars", opt_bool, {&strict_acl_vars} },
345 { "strip_excess_angle_brackets", opt_bool, {&strip_excess_angle_brackets} },
346 { "strip_trailing_dot", opt_bool, {&strip_trailing_dot} },
347 { "syslog_duplication", opt_bool, {&syslog_duplication} },
348 { "syslog_facility", opt_stringptr, {&syslog_facility_str} },
349 { "syslog_pid", opt_bool, {&syslog_pid} },
350 { "syslog_processname", opt_stringptr, {&syslog_processname} },
351 { "syslog_timestamp", opt_bool, {&syslog_timestamp} },
352 { "system_filter", opt_stringptr, {&system_filter} },
353 { "system_filter_directory_transport", opt_stringptr,{&system_filter_directory_transport} },
354 { "system_filter_file_transport",opt_stringptr,{&system_filter_file_transport} },
355 { "system_filter_group", opt_gid, {&system_filter_gid} },
356 { "system_filter_pipe_transport",opt_stringptr,{&system_filter_pipe_transport} },
357 { "system_filter_reply_transport",opt_stringptr,{&system_filter_reply_transport} },
358 { "system_filter_user", opt_uid, {&system_filter_uid} },
359 { "tcp_nodelay", opt_bool, {&tcp_nodelay} },
360 #ifdef USE_TCP_WRAPPERS
361 { "tcp_wrappers_daemon_name", opt_stringptr, {&tcp_wrappers_daemon_name} },
363 { "timeout_frozen_after", opt_time, {&timeout_frozen_after} },
364 { "timezone", opt_stringptr, {&timezone_string} },
365 { "tls_advertise_hosts", opt_stringptr, {&tls_advertise_hosts} },
367 { "tls_certificate", opt_stringptr, {&tls_certificate} },
368 { "tls_crl", opt_stringptr, {&tls_crl} },
369 { "tls_dh_max_bits", opt_int, {&tls_dh_max_bits} },
370 { "tls_dhparam", opt_stringptr, {&tls_dhparam} },
371 { "tls_eccurve", opt_stringptr, {&tls_eccurve} },
372 # ifndef DISABLE_OCSP
373 { "tls_ocsp_file", opt_stringptr, {&tls_ocsp_file} },
375 { "tls_on_connect_ports", opt_stringptr, {&tls_in.on_connect_ports} },
376 { "tls_privatekey", opt_stringptr, {&tls_privatekey} },
377 { "tls_remember_esmtp", opt_bool, {&tls_remember_esmtp} },
378 { "tls_require_ciphers", opt_stringptr, {&tls_require_ciphers} },
379 # ifdef EXPERIMENTAL_TLS_RESUME
380 { "tls_resumption_hosts", opt_stringptr, {&tls_resumption_hosts} },
382 { "tls_try_verify_hosts", opt_stringptr, {&tls_try_verify_hosts} },
383 { "tls_verify_certificates", opt_stringptr, {&tls_verify_certificates} },
384 { "tls_verify_hosts", opt_stringptr, {&tls_verify_hosts} },
386 { "trusted_groups", opt_gidlist, {&trusted_groups} },
387 { "trusted_users", opt_uidlist, {&trusted_users} },
388 { "unknown_login", opt_stringptr, {&unknown_login} },
389 { "unknown_username", opt_stringptr, {&unknown_username} },
390 { "untrusted_set_sender", opt_stringptr, {&untrusted_set_sender} },
391 { "uucp_from_pattern", opt_stringptr, {&uucp_from_pattern} },
392 { "uucp_from_sender", opt_stringptr, {&uucp_from_sender} },
393 { "warn_message_file", opt_stringptr, {&warn_message_file} },
394 { "write_rejectlog", opt_bool, {&write_rejectlog} }
398 static int optionlist_config_size = nelem(optionlist_config);
405 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags) {/*Dummy*/}
410 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
418 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
420 for (struct auth_info * ai = auths_available; ai->driver_name[0]; ai++)
422 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
423 builtin_macro_create(buf);
424 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
426 if (ai->macros_create) (ai->macros_create)();
431 options_logging(void)
435 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
437 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
438 builtin_macro_create(buf);
443 #else /*!MACRO_PREDEF*/
445 extern char **environ;
447 static void save_config_line(const uschar* line);
448 static void save_config_position(const uschar *file, int line);
449 static void print_config(BOOL admin, BOOL terse);
452 #define CSTATE_STACK_SIZE 10
454 const uschar *config_directory = NULL;
457 /* Structure for chain (stack) of .included files */
459 typedef struct config_file_item {
460 struct config_file_item *next;
461 const uschar *filename;
462 const uschar *directory;
467 /* Structure for chain of configuration lines (-bP config) */
469 typedef struct config_line_item {
470 struct config_line_item *next;
474 static config_line_item* config_lines;
476 /* Structure of table of conditional words and their state transitions */
478 typedef struct cond_item {
486 /* Structure of table of syslog facility names and values */
488 typedef struct syslog_fac_item {
494 static const uschar * const hidden = US"<value not displayable>";
496 /* Static variables */
498 static config_file_item *config_file_stack = NULL; /* For includes */
500 static uschar *syslog_facility_str = NULL;
501 static uschar next_section[24];
502 static uschar time_buffer[24];
504 /* State variables for conditional loading (.ifdef / .else / .endif) */
506 static int cstate = 0;
507 static int cstate_stack_ptr = -1;
508 static int cstate_stack[CSTATE_STACK_SIZE];
510 /* Table of state transitions for handling conditional inclusions. There are
511 four possible state transitions:
515 .elifdef true (or .else)
518 .endif just causes the previous cstate to be popped off the stack */
520 static int next_cstate[3][4] =
522 /* State 0: reading from file, or reading until next .else or .endif */
524 /* State 1: condition failed, skipping until next .else or .endif */
526 /* State 2: skipping until .endif */
530 /* Table of conditionals and the states to set. For each name, there are four
531 values: the length of the name (to save computing it each time), the state to
532 set if a macro was found in the line, the state to set if a macro was not found
533 in the line, and a stack manipulation setting which is:
535 -1 pull state value off the stack
536 0 don't alter the stack
537 +1 push value onto stack, before setting new state
540 static cond_item cond_list[] = {
541 { US"ifdef", 5, 0, 1, 1 },
542 { US"ifndef", 6, 1, 0, 1 },
543 { US"elifdef", 7, 2, 3, 0 },
544 { US"elifndef", 8, 3, 2, 0 },
545 { US"else", 4, 2, 2, 0 },
546 { US"endif", 5, 0, 0, -1 }
549 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
551 /* Table of syslog facility names and their values */
553 static syslog_fac_item syslog_list[] = {
554 { US"mail", LOG_MAIL },
555 { US"user", LOG_USER },
556 { US"news", LOG_NEWS },
557 { US"uucp", LOG_UUCP },
558 { US"local0", LOG_LOCAL0 },
559 { US"local1", LOG_LOCAL1 },
560 { US"local2", LOG_LOCAL2 },
561 { US"local3", LOG_LOCAL3 },
562 { US"local4", LOG_LOCAL4 },
563 { US"local5", LOG_LOCAL5 },
564 { US"local6", LOG_LOCAL6 },
565 { US"local7", LOG_LOCAL7 },
566 { US"daemon", LOG_DAEMON }
569 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
572 #define opt_fn_print BIT(0)
573 #define opt_fn_print_label BIT(1)
576 /*************************************************
577 * Find the name of an option *
578 *************************************************/
580 /* This function is to aid debugging. Various functions take arguments that are
581 pointer variables in the options table or in option tables for various drivers.
582 For debugging output, it is useful to be able to find the name of the option
583 which is currently being processed. This function finds it, if it exists, by
584 searching the table(s).
586 Arguments: a value that is presumed to be in the table above
587 Returns: the option name, or an empty string
591 readconf_find_option(void *p)
593 for (int i = 0; i < nelem(optionlist_config); i++)
594 if (p == optionlist_config[i].v.value) return US optionlist_config[i].name;
596 for (router_instance * r = routers; r; r = r->next)
598 router_info *ri = r->info;
599 for (int i = 0; i < *ri->options_count; i++)
601 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
602 if (p == CS (r->options_block) + ri->options[i].v.offset)
603 return US ri->options[i].name;
607 for (transport_instance * t = transports; t; t = t->next)
609 transport_info *ti = t->info;
610 for (int i = 0; i < *ti->options_count; i++)
612 optionlist * op = &ti->options[i];
613 if ((op->type & opt_mask) != opt_stringptr) continue;
614 if (p == ( op->type & opt_public
616 : CS t->options_block
629 /*************************************************
630 * Deal with an assignment to a macro *
631 *************************************************/
633 /* We have a new definition; append to the list.
636 name Name of the macro; will be copied
637 val Expansion result for the macro; will be copied
641 macro_create(const uschar * name, const uschar * val, BOOL command_line)
643 macro_item * m = store_get(sizeof(macro_item), FALSE);
645 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
647 m->command_line = command_line;
648 m->namelen = Ustrlen(name);
649 m->replen = Ustrlen(val);
650 m->name = string_copy(name);
651 m->replacement = string_copy(val);
663 /* This function is called when a line that starts with an upper case letter is
664 encountered. The argument "line" should contain a complete logical line, and
665 start with the first letter of the macro name. The macro name and the
666 replacement text are extracted and stored. Redefinition of existing,
667 non-command line, macros is permitted using '==' instead of '='.
670 s points to the start of the logical line
672 Returns: FALSE iff fatal error
676 macro_read_assignment(uschar *s)
683 while (isalnum(*s) || *s == '_')
685 if (namelen >= sizeof(name) - 1)
687 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
688 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
691 name[namelen++] = *s++;
695 while (isspace(*s)) s++;
698 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
707 while (isspace(*s)) s++;
709 /* If an existing macro of the same name was defined on the command line, we
710 just skip this definition. It's an error to attempt to redefine a macro without
711 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
712 It is also an error to define a macro whose name begins with the name of a
713 previously defined macro. This is the requirement that make using a tree
714 for macros hard; we must check all macros for the substring. Perhaps a
715 sorted list, and a bsearch, would work?
716 Note: it is documented that the other way round works. */
718 for (m = macros; m; m = m->next)
720 if (Ustrcmp(m->name, name) == 0)
722 if (!m->command_line && !redef)
724 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
725 "defined (use \"==\" if you want to redefine it)", name);
731 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
733 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
734 "a macro because previously defined macro \"%s\" is a substring",
739 /* We cannot have this test, because it is documented that a substring
740 macro is permitted (there is even an example).
742 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
743 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
744 * "a macro because it is a substring of previously defined macro \"%s\"",
749 /* Check for an overriding command-line definition. */
751 if (m && m->command_line) return TRUE;
753 /* Redefinition must refer to an existing macro. */
758 m->replen = Ustrlen(s);
759 m->replacement = string_copy(s);
763 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
768 /* We have a new definition. */
770 (void) macro_create(name, s, FALSE);
778 /* Process line for macros. The line is in big_buffer starting at offset len.
779 Expand big_buffer if needed. Handle definitions of new macros, and
780 macro expansions, rewriting the line in the buffer.
783 len Offset in buffer of start of line
784 newlen Pointer to offset of end of line, updated on return
785 macro_found Pointer to return that a macro was expanded
787 Return: pointer to first nonblank char in line
791 macros_expand(int len, int * newlen, BOOL * macro_found)
793 uschar * ss = big_buffer + len;
796 /* Find the true start of the physical line - leading spaces are always
799 while (isspace(*ss)) ss++;
801 /* Process the physical line for macros. If this is the start of the logical
802 line, skip over initial text at the start of the line if it starts with an
803 upper case character followed by a sequence of name characters and an equals
804 sign, because that is the definition of a new macro, and we don't do
805 replacement therein. */
808 if (len == 0 && isupper(*s))
810 while (isalnum(*s) || *s == '_') s++;
811 while (isspace(*s)) s++;
812 if (*s != '=') s = ss; /* Not a macro definition */
815 /* Skip leading chars which cannot start a macro name, to avoid multiple
816 pointless rescans in Ustrstr calls. */
818 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
820 /* For each defined macro, scan the line (from after XXX= if present),
821 replacing all occurrences of the macro. */
823 *macro_found = FALSE;
824 if (*s) for (macro_item * m = *s == '_' ? macros : macros_user; m; m = m->next)
829 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
833 while ((p = Ustrstr(t, m->name)) != NULL)
837 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
838 m->name, (int) Ustrlen(ss)-1, ss);
839 /* Expand the buffer if necessary */
841 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
843 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
844 uschar *newbuffer = store_malloc(newsize);
845 memcpy(newbuffer, big_buffer, *newlen + 1);
846 p = newbuffer + (p - big_buffer);
847 s = newbuffer + (s - big_buffer);
848 ss = newbuffer + (ss - big_buffer);
849 t = newbuffer + (t - big_buffer);
850 big_buffer_size = newsize;
851 store_free(big_buffer);
852 big_buffer = newbuffer;
855 /* Shuffle the remaining characters up or down in the buffer before
856 copying in the replacement text. Don't rescan the replacement for this
860 if ((moveby = m->replen - m->namelen) != 0)
862 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
865 Ustrncpy(p, m->replacement, m->replen);
867 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
872 /* An empty macro replacement at the start of a line could mean that ss no
873 longer points to the first non-blank character. */
875 while (isspace(*ss)) ss++;
879 /*************************************************
880 * Read configuration line *
881 *************************************************/
883 /* A logical line of text is read from the configuration file into the big
884 buffer, taking account of macros, .includes, and continuations. The size of
885 big_buffer is increased if necessary. The count of configuration lines is
886 maintained. Physical input lines starting with # (ignoring leading white space,
887 and after macro replacement) and empty logical lines are always ignored.
888 Leading and trailing spaces are removed.
890 If we hit a line of the form "begin xxxx", the xxxx is placed in the
891 next_section vector, and the function returns NULL, indicating the end of a
892 configuration section. On end-of-file, NULL is returned with next_section
897 Returns: a pointer to the first non-blank in the line,
898 or NULL if eof or end of section is reached
902 get_config_line(void)
904 int startoffset = 0; /* To first non-blank char in logical line */
905 int len = 0; /* Of logical line so far */
910 /* Loop for handling continuation lines, skipping comments, and dealing with
915 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
917 if (config_file_stack != NULL) /* EOF inside .include */
919 (void)fclose(config_file);
920 config_file = config_file_stack->file;
921 config_filename = config_file_stack->filename;
922 config_directory = config_file_stack->directory;
923 config_lineno = config_file_stack->lineno;
924 config_file_stack = config_file_stack->next;
926 save_config_position(config_filename, config_lineno);
930 /* EOF at top level */
932 if (cstate_stack_ptr >= 0)
933 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
934 "Unexpected end of configuration file: .endif missing");
936 if (len != 0) break; /* EOF after continuation */
937 next_section[0] = 0; /* EOF at start of logical line */
942 newlen = len + Ustrlen(big_buffer + len);
944 if (config_lines && config_lineno == 1)
945 save_config_position(config_filename, config_lineno);
947 /* Handle pathologically long physical lines - yes, it did happen - by
948 extending big_buffer at this point. The code also copes with very long
951 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
954 big_buffer_size += BIG_BUFFER_SIZE;
955 newbuffer = store_malloc(big_buffer_size);
957 /* This use of strcpy is OK because we know that the string in the old
958 buffer is shorter than the new buffer. */
960 Ustrcpy(newbuffer, big_buffer);
961 store_free(big_buffer);
962 big_buffer = newbuffer;
963 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
965 newlen += Ustrlen(big_buffer + newlen);
968 ss = macros_expand(len, &newlen, ¯o_found);
970 /* Check for comment lines - these are physical lines. */
972 if (*ss == '#') continue;
974 /* Handle conditionals, which are also applied to physical lines. Conditions
975 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
976 expansion occurred on the rest of the line. A preliminary test for the leading
977 '.' saves effort on most lines. */
983 /* Search the list of conditional directives */
985 for (i = 0; i < cond_list_size; i++)
988 cond_item *c = cond_list+i;
989 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
991 /* The following character must be white space or end of string */
993 n = ss[1 + c->namelen];
994 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
996 /* .ifdef and .ifndef push the current state onto the stack, then set
997 a new one from the table. Stack overflow is an error */
1001 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
1002 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1003 ".%s nested too deeply", c->name);
1004 cstate_stack[++cstate_stack_ptr] = cstate;
1005 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
1008 /* For any of the others, stack underflow is an error. The next state
1009 comes either from the stack (.endif) or from the table. */
1013 if (cstate_stack_ptr < 0)
1014 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1015 ".%s without matching .ifdef", c->name);
1016 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1017 next_cstate[cstate][macro_found? c->action1 : c->action2];
1020 /* Having dealt with a directive, break the loop */
1025 /* If we have handled a conditional directive, continue with the next
1026 physical line. Otherwise, fall through. */
1028 if (i < cond_list_size) continue;
1031 /* If the conditional state is not 0 (actively using these lines), ignore
1034 if (cstate != 0) continue; /* Conditional skip */
1036 /* Handle .include lines - these are also physical lines. */
1038 if (Ustrncmp(ss, ".include", 8) == 0 &&
1040 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1043 int include_if_exists = isspace(ss[8])? 0 : 10;
1044 config_file_item *save;
1045 struct stat statbuf;
1047 ss += 9 + include_if_exists;
1048 while (isspace(*ss)) ss++;
1049 t = ss + Ustrlen(ss);
1050 while (t > ss && isspace(t[-1])) t--;
1051 if (*ss == '\"' && t[-1] == '\"')
1058 /* We allow relative file names. For security reasons currently
1059 relative names not allowed with .include_if_exists. For .include_if_exists
1060 we need to check the permissions/ownership of the containing folder */
1062 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1063 "absolute path \"%s\"", ss);
1066 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1067 ss = string_from_gstring(g);
1070 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1073 save_config_position(config_filename, config_lineno);
1074 save = store_get(sizeof(config_file_item), FALSE);
1075 save->next = config_file_stack;
1076 config_file_stack = save;
1077 save->file = config_file;
1078 save->filename = config_filename;
1079 save->directory = config_directory;
1080 save->lineno = config_lineno;
1082 if (!(config_file = Ufopen(ss, "rb")))
1083 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1084 "configuration file %s", ss);
1086 config_filename = string_copy(ss);
1087 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1092 /* If this is the start of the logical line, remember where the non-blank
1093 data starts. Otherwise shuffle down continuation lines to remove leading
1097 startoffset = ss - big_buffer;
1100 s = big_buffer + len;
1103 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1108 /* Accept the new addition to the line. Remove trailing white space. */
1111 while (len > 0 && isspace(big_buffer[len-1])) len--;
1112 big_buffer[len] = 0;
1114 /* We are done if the line does not end in backslash and contains some data.
1115 Empty logical lines are ignored. For continuations, remove the backslash and
1116 go round the loop to read the continuation line. */
1120 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1121 big_buffer[--len] = 0; /* Remove backslash */
1123 } /* Loop for reading multiple physical lines */
1125 /* We now have a logical line. Test for the end of a configuration section (or,
1126 more accurately, for the start of the next section). Place the name of the next
1127 section in next_section, and return NULL. If the name given is longer than
1128 next_section, truncate it. It will be unrecognized later, because all the known
1129 section names do fit. Leave space for pluralizing. */
1131 s = big_buffer + startoffset; /* First non-space character */
1134 save_config_line(s);
1136 if (strncmpic(s, US"begin ", 6) == 0)
1139 while (isspace(*s)) s++;
1140 if (big_buffer + len - s > sizeof(next_section) - 2)
1141 s[sizeof(next_section) - 2] = 0;
1142 Ustrcpy(next_section, s);
1146 /* Return the first non-blank character. */
1153 /*************************************************
1155 *************************************************/
1157 /* The yield is the pointer to the next uschar. Names longer than the
1158 output space are silently truncated. This function is also used from acl.c when
1162 name where to put the name
1166 Returns: new input pointer
1170 readconf_readname(uschar *name, int len, uschar *s)
1173 while (isspace(*s)) s++;
1176 while (isalnum(*s) || *s == '_')
1178 if (p < len-1) name[p++] = *s;
1183 while (isspace(*s)) s++;
1190 /*************************************************
1191 * Read a time value *
1192 *************************************************/
1194 /* This function is also called from outside, to read argument
1195 time values. The format of a time value is:
1197 [<n>w][<n>d][<n>h][<n>m][<n>s]
1199 as long as at least one is present. If a format error is encountered,
1200 return a negative value. The value must be terminated by the given
1205 terminator required terminating character
1206 return_msec if TRUE, allow fractional seconds and return milliseconds
1208 Returns: the time value, or -1 on syntax error
1209 value is seconds if return_msec is FALSE
1210 value is milliseconds if return_msec is TRUE
1214 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1222 if (!isdigit(*s)) return -1;
1223 (void)sscanf(CCS s, "%d%n", &value, &count);
1228 case 'w': value *= 7;
1229 case 'd': value *= 24;
1230 case 'h': value *= 60;
1231 case 'm': value *= 60;
1236 if (!return_msec) return -1;
1237 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1239 if (*s++ != 's') return -1;
1240 yield += (int)(fraction * 1000.0);
1246 if (return_msec) value *= 1000;
1248 if (*s == terminator) return yield;
1250 /* Control never reaches here. */
1255 /*************************************************
1256 * Read a fixed point value *
1257 *************************************************/
1259 /* The value is returned *1000
1263 terminator required terminator
1265 Returns: the value, or -1 on error
1269 readconf_readfixed(const uschar *s, int terminator)
1273 if (!isdigit(*s)) return -1;
1274 (void)sscanf(CS s, "%d%n", &value, &count);
1276 yield = value * 1000;
1280 while (isdigit((*(++s))))
1282 yield += (*s - '0') * m;
1287 return (*s == terminator)? yield : (-1);
1292 /*************************************************
1293 * Find option in list *
1294 *************************************************/
1296 /* The lists are always in order, so binary chop can be used.
1299 name the option name to search for
1300 ol the first entry in the option list
1301 last one more than the offset of the last entry in the option list
1303 Returns: pointer to an option entry, or NULL if not found
1307 find_option(uschar *name, optionlist *ol, int last)
1310 while (last > first)
1312 int middle = (first + last)/2;
1313 int c = Ustrcmp(name, ol[middle].name);
1315 if (c == 0) return ol + middle;
1316 else if (c > 0) first = middle + 1;
1324 /*************************************************
1325 * Find a set flag in option list *
1326 *************************************************/
1328 /* Because some versions of Unix make no restrictions on the values of uids and
1329 gids (even negative ones), we cannot represent "unset" by a special value.
1330 There is therefore a separate boolean variable for each one indicating whether
1331 a value is set or not. This function returns a pointer to the boolean, given
1332 the original option name. It is a major disaster if the flag cannot be found.
1335 name the name of the uid or gid option
1336 oltop points to the start of the relevant option list
1337 last one more than the offset of the last item in the option list
1338 data_block NULL when reading main options => data values in the option
1339 list are absolute addresses; otherwise they are byte offsets
1340 in data_block (used for driver options)
1342 Returns: a pointer to the boolean flag.
1346 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1350 sprintf(CS name2, "*set_%.50s", name);
1351 if (!(ol = find_option(name2, oltop, last)))
1352 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1353 "Exim internal error: missing set flag for %s", name);
1355 ? (BOOL *)(US data_block + ol->v.offset) : (BOOL *)ol->v.value;
1361 /*************************************************
1362 * Output extra characters message and die *
1363 *************************************************/
1365 /* Called when an option line has junk on the end. Sometimes this is because
1366 the sysadmin thinks comments are permitted.
1369 s points to the extra characters
1370 t1..t3 strings to insert in the log message
1372 Returns: doesn't return; dies
1376 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1378 uschar *comment = US"";
1379 if (*s == '#') comment = US" (# is comment only at line start)";
1380 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1381 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1386 /*************************************************
1387 * Read rewrite information *
1388 *************************************************/
1390 /* Each line of rewrite information contains:
1392 . A complete address in the form user@domain, possibly with
1393 leading * for each part; or alternatively, a regex.
1395 . A replacement string (which will be expanded).
1397 . An optional sequence of one-letter flags, indicating which
1398 headers etc. to apply this rule to.
1400 All this is decoded and placed into a control block. The OR of the flags is
1401 maintained in a common word.
1404 p points to the string that makes up the rule
1405 existflags points to the overall flag word
1406 isglobal TRUE if reading global rewrite rules
1408 Returns: the control block for the parsed rule.
1411 static rewrite_rule *
1412 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1414 rewrite_rule *next = store_get(sizeof(rewrite_rule), FALSE);
1417 next->key = string_dequote(&p);
1419 while (isspace(*p)) p++;
1421 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1422 "missing rewrite replacement string");
1425 next->replacement = string_dequote(&p);
1427 while (*p != 0) switch (*p++)
1429 case ' ': case '\t': break;
1431 case 'q': next->flags |= rewrite_quit; break;
1432 case 'w': next->flags |= rewrite_whole; break;
1434 case 'h': next->flags |= rewrite_all_headers; break;
1435 case 's': next->flags |= rewrite_sender; break;
1436 case 'f': next->flags |= rewrite_from; break;
1437 case 't': next->flags |= rewrite_to; break;
1438 case 'c': next->flags |= rewrite_cc; break;
1439 case 'b': next->flags |= rewrite_bcc; break;
1440 case 'r': next->flags |= rewrite_replyto; break;
1442 case 'E': next->flags |= rewrite_all_envelope; break;
1443 case 'F': next->flags |= rewrite_envfrom; break;
1444 case 'T': next->flags |= rewrite_envto; break;
1446 case 'Q': next->flags |= rewrite_qualify; break;
1447 case 'R': next->flags |= rewrite_repeat; break;
1450 next->flags |= rewrite_smtp;
1451 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1452 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1453 "rewrite rule has the S flag but is not a regular expression");
1457 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1458 "unknown rewrite flag character '%c' "
1459 "(could be missing quotes round replacement item)", p[-1]);
1463 /* If no action flags are set, set all the "normal" rewrites. */
1465 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1466 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1468 /* Remember which exist, for optimization, and return the rule */
1470 *existflags |= next->flags;
1477 /*************************************************
1478 * Read global rewrite information *
1479 *************************************************/
1481 /* Each line is a single rewrite rule; it is parsed into a control block
1482 by readconf_one_rewrite(), and its flags are ORed into the global flag
1483 word rewrite_existflags. */
1486 readconf_rewrites(void)
1488 rewrite_rule **chain = &global_rewrite_rules;
1491 while ((p = get_config_line()) != NULL)
1493 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1495 chain = &(next->next);
1501 /*************************************************
1503 *************************************************/
1505 /* Strings are read into the normal store pool. As long we aren't too
1506 near the end of the current block, the string will just use what is necessary
1507 on the top of the stacking pool, because string_cat() uses the extension
1511 s the rest of the input line
1512 name the option name (for errors)
1514 Returns: pointer to the string
1518 read_string(const uschar *s, const uschar *name)
1523 if (*s != '\"') return string_copy(s);
1526 yield = string_dequote(&s);
1528 if (s == ss+1 || s[-1] != '\"')
1529 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1530 "missing quote at end of string value for %s", name);
1532 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1538 /*************************************************
1539 * Custom-handler options *
1540 *************************************************/
1542 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags)
1544 if (flags & opt_fn_print)
1546 if (flags & opt_fn_print_label) printf("%s = ", name);
1547 printf("%s\n", smtp_receive_timeout_s
1548 ? string_printing2(smtp_receive_timeout_s, FALSE)
1549 : readconf_printtime(smtp_receive_timeout));
1551 else if (*str == '$')
1552 smtp_receive_timeout_s = string_copy(str);
1555 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1556 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1557 if (smtp_receive_timeout < 0)
1558 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1563 /*************************************************
1564 * Handle option line *
1565 *************************************************/
1567 /* This function is called from several places to process a line containing the
1568 setting of an option. The first argument is the line to be decoded; it has been
1569 checked not to be empty and not to start with '#'. Trailing newlines and white
1570 space have been removed. The second argument is a pointer to the list of
1571 variable names that are to be recognized, together with their types and
1572 locations, and the third argument gives the number of entries in the list.
1574 The fourth argument is a pointer to a data block. If it is NULL, then the data
1575 values in the options list are absolute addresses. Otherwise, they are byte
1576 offsets in the data block.
1578 String option data may continue onto several lines; this function reads further
1579 data from config_file if necessary.
1581 The yield of this function is normally zero. If a string continues onto
1582 multiple lines, then the data value is permitted to be followed by a comma
1583 or a semicolon (for use in drivers) and the yield is that character.
1586 buffer contains the configuration line to be handled
1587 oltop points to the start of the relevant option list
1588 last one more than the offset of the last item in the option list
1589 data_block NULL when reading main options => data values in the option
1590 list are absolute addresses; otherwise they are byte offsets
1591 in data_block when they have opt_public set; otherwise
1592 they are byte offsets in data_block->options_block.
1593 unknown_txt format string to use in panic message for unknown option;
1594 must contain %s for option name
1595 if given as NULL, don't panic on unknown option
1597 Returns: TRUE if an option was read successfully,
1598 FALSE false for an unknown option if unknown_txt == NULL,
1599 otherwise panic and die on an unknown option
1603 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1604 void *data_block, uschar *unknown_txt)
1608 int count, type, value;
1612 BOOL boolvalue = TRUE;
1613 BOOL freesptr = TRUE;
1614 optionlist *ol, *ol2;
1618 uschar *inttype = US"";
1621 uschar **str_target;
1625 /* There may be leading spaces; thereafter, we expect an option name starting
1628 while (isspace(*s)) s++;
1630 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1632 /* Read the name of the option, and skip any subsequent white space. If
1633 it turns out that what we read was "hide", set the flag indicating that
1634 this is a secure option, and loop to read the next word. */
1636 for (int n = 0; n < 2; n++)
1638 while (isalnum(*s) || *s == '_')
1640 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1644 while (isspace(*s)) s++;
1645 if (Ustrcmp(name, "hide") != 0) break;
1646 issecure = opt_secure;
1650 /* Deal with "no_" or "not_" here for booleans */
1652 if (Ustrncmp(name, "no_", 3) == 0)
1658 if (Ustrncmp(name, "not_", 4) == 0)
1664 /* Search the list for the given name. A non-existent name, or an option that
1665 is set twice, is a disaster. */
1667 if (!(ol = find_option(name + offset, oltop, last)))
1669 if (!unknown_txt) return FALSE;
1670 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1673 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1674 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1675 "\"%s\" option set for the second time", name);
1677 ol->type |= opt_set | issecure;
1678 type = ol->type & opt_mask;
1680 /* Types with data values must be followed by '='; the "no[t]_" prefix
1681 applies only to boolean values. */
1683 if (type < opt_bool || type > opt_bool_last)
1686 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1687 "negation prefix applied to a non-boolean option");
1689 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1690 "unexpected end of line (data missing) after %s", name);
1692 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1695 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1696 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1697 ultimately expands to one of those values. */
1699 else if (*s && (offset != 0 || *s != '='))
1700 extra_chars_error(s, US"boolean option ", name, US"");
1702 /* Skip white space after = */
1704 if (*s == '=') while (isspace((*(++s))));
1706 /* If there is a data block and the opt_public flag is not set, change
1707 the data block pointer to the private options block. */
1709 if (data_block && !(ol->type & opt_public))
1710 data_block = (void *)(((driver_instance *)data_block)->options_block);
1712 /* Now get the data according to the type. */
1716 /* If a string value is not enclosed in quotes, it consists of
1717 the rest of the current line, verbatim. Otherwise, string escapes
1720 A transport is specified as a string, which is then looked up in the
1721 list of transports. A search type is specified as one of a number of
1724 A set or rewrite rules for a driver is specified as a string, which is
1725 then parsed into a suitable chain of control blocks.
1727 Uids and gids are specified as strings which are then looked up in the
1728 passwd file. Lists of uids and gids are similarly specified as colon-
1729 separated strings. */
1734 case opt_expand_uid:
1735 case opt_expand_gid:
1740 reset_point = store_mark();
1741 sptr = read_string(s, name);
1743 /* Having read a string, we now have several different ways of using it,
1744 depending on the data type, so do another switch. If keeping the actual
1745 string is not required (because it is interpreted), freesptr is set TRUE,
1746 and at the end we reset the pool. */
1750 /* If this was a string, set the variable to point to the new string,
1751 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1752 rules, we still keep the string (for printing), and parse the rules into a
1753 control block and flags word. */
1756 str_target = data_block ? USS (US data_block + ol->v.offset)
1758 if (ol->type & opt_rep_con)
1760 uschar * saved_condition;
1761 /* We already have a condition, we're conducting a crude hack to let
1762 multiple condition rules be chained together, despite storing them in
1764 *str_target = string_copy_perm( (saved_condition = *str_target)
1765 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1766 saved_condition, sptr)
1769 /* TODO(pdp): there is a memory leak here and just below
1770 when we set 3 or more conditions; I still don't
1771 understand the store mechanism enough to know
1772 what's the safe way to free content from an earlier store.
1773 AFAICT, stores stack, so freeing an early stored item also stores
1774 all data alloc'd after it. If we knew conditions were adjacent,
1775 we could survive that, but we don't. So I *think* we need to take
1776 another bit from opt_type to indicate "malloced"; this seems like
1777 quite a hack, especially for this one case. It also means that
1778 we can't ever reclaim the store from the *first* condition.
1780 Because we only do this once, near process start-up, I'm prepared to
1781 let this slide for the time being, even though it rankles. */
1783 else if (ol->type & opt_rep_str)
1786 Ustrncmp(name, "headers_add", 11) == 0 ? '\n'
1787 : Ustrncmp(name, "set", 3) == 0 ? ';'
1789 int sep_i = -(int)sep_o;
1790 const uschar * list = sptr;
1792 gstring * list_o = NULL;
1796 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1797 list_o = string_cat(list_o, *str_target);
1800 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1801 list_o = string_append_listele(list_o, sep_o, s);
1804 *str_target = string_copy_perm(string_from_gstring(list_o), FALSE);
1815 *USS (US data_block + ol->v.offset) = sptr;
1817 *USS ol->v.value = sptr;
1819 if (type == opt_rewrite)
1824 rewrite_rule **chain;
1827 sprintf(CS name2, "*%.50s_rules", name);
1828 ol2 = find_option(name2, oltop, last);
1829 sprintf(CS name2, "*%.50s_flags", name);
1830 ol3 = find_option(name2, oltop, last);
1833 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1834 "rewrite rules not available for driver");
1838 chain = (rewrite_rule **)(US data_block + ol2->v.offset);
1839 flagptr = (int *)(US data_block + ol3->v.offset);
1843 chain = (rewrite_rule **)ol2->v.value;
1844 flagptr = (int *)ol3->v.value;
1847 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1849 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1851 chain = &(next->next);
1854 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1855 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1856 "non-header rewrite - not allowed at transport time -");
1860 /* If it was an expanded uid, see if there is any expansion to be
1861 done by checking for the presence of a $ character. If there is, save it
1862 in the corresponding *expand_user option field. Otherwise, fall through
1863 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1866 case opt_expand_uid:
1867 sprintf(CS name2, "*expand_%.50s", name);
1868 if ((ol2 = find_option(name2, oltop, last)))
1870 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1873 *(USS(US data_block + ol2->v.offset)) = ss;
1875 *(USS ol2->v.value) = ss;
1879 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1885 /* Look up a fixed uid, and also make use of the corresponding gid
1886 if a passwd entry is returned and the gid has not been set. */
1889 if (!route_finduser(sptr, &pw, &uid))
1890 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1892 *(uid_t *)(US data_block + ol->v.offset) = uid;
1894 *(uid_t *)ol->v.value = uid;
1896 /* Set the flag indicating a fixed value is set */
1898 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1900 /* Handle matching gid if we have a passwd entry: done by finding the
1901 same name with terminating "user" changed to "group"; if not found,
1902 ignore. Also ignore if the value is already set. */
1904 if (pw == NULL) break;
1905 Ustrcpy(name+Ustrlen(name)-4, US"group");
1906 ol2 = find_option(name, oltop, last);
1907 if (ol2 && ((ol2->type & opt_mask) == opt_gid ||
1908 (ol2->type & opt_mask) == opt_expand_gid))
1910 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1914 *((gid_t *)(US data_block + ol2->v.offset)) = pw->pw_gid;
1916 *((gid_t *)ol2->v.value) = pw->pw_gid;
1922 /* If it was an expanded gid, see if there is any expansion to be
1923 done by checking for the presence of a $ character. If there is, save it
1924 in the corresponding *expand_user option field. Otherwise, fall through
1925 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1928 case opt_expand_gid:
1929 sprintf(CS name2, "*expand_%.50s", name);
1930 if ((ol2 = find_option(name2, oltop, last)))
1932 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1935 *(USS(US data_block + ol2->v.offset)) = ss;
1937 *(USS ol2->v.value) = ss;
1941 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1947 /* Handle freestanding gid */
1950 if (!route_findgroup(sptr, &gid))
1951 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1953 *((gid_t *)(US data_block + ol->v.offset)) = gid;
1955 *((gid_t *)ol->v.value) = gid;
1956 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1959 /* If it was a uid list, look up each individual entry, and build
1960 a vector of uids, with a count in the first element. Put the vector
1961 in malloc store so we can free the string. (We are reading into
1962 permanent store already.) */
1970 const uschar *op = expand_string (sptr);
1973 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1974 name, expand_string_message);
1977 if (*p != 0) count++;
1978 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1979 list = store_malloc(count*sizeof(uid_t));
1980 list[ptr++] = (uid_t)(count - 1);
1983 *((uid_t **)(US data_block + ol->v.offset)) = list;
1985 *((uid_t **)ol->v.value) = list;
1991 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1992 if (!route_finduser(big_buffer, NULL, &uid))
1993 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
2000 /* If it was a gid list, look up each individual entry, and build
2001 a vector of gids, with a count in the first element. Put the vector
2002 in malloc store so we can free the string. (We are reading into permanent
2011 const uschar *op = expand_string (sptr);
2014 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2015 name, expand_string_message);
2018 if (*p != 0) count++;
2019 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2020 list = store_malloc(count*sizeof(gid_t));
2021 list[ptr++] = (gid_t)(count - 1);
2024 *((gid_t **)(US data_block + ol->v.offset)) = list;
2026 *((gid_t **)ol->v.value) = list;
2032 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2033 if (!route_findgroup(big_buffer, &gid))
2034 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2042 /* Release store if the value of the string doesn't need to be kept. */
2044 if (freesptr) reset_point = store_reset(reset_point);
2047 /* Expanded boolean: if no characters follow, or if there are no dollar
2048 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2049 save the string for later expansion in the alternate place. */
2051 case opt_expand_bool:
2052 if (*s && Ustrchr(s, '$') != 0)
2054 sprintf(CS name2, "*expand_%.50s", name);
2055 if ((ol2 = find_option(name2, oltop, last)))
2057 reset_point = store_mark();
2058 sptr = read_string(s, name);
2060 *(USS(US data_block + ol2->v.offset)) = sptr;
2062 *(USS ol2->v.value) = sptr;
2069 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2070 look for yes/not/true/false. Some booleans are stored in a single bit in
2071 a single int. There's a special fudge for verify settings; without a suffix
2072 they set both xx_sender and xx_recipient. The table points to the sender
2073 value; search subsequently for the recipient. There's another special case:
2074 opt_bool_set also notes when a boolean has been set. */
2078 case opt_bool_verify:
2082 s = readconf_readname(name2, 64, s);
2083 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2085 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2087 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2088 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2089 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2090 US"for boolean option ", name);
2093 /* Handle single-bit type. */
2095 if (type == opt_bit)
2097 int bit = 1 << ((ol->type >> 16) & 31);
2098 int * ptr = data_block
2099 ? (int *)(US data_block + ol->v.offset)
2100 : (int *)ol->v.value;
2101 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2105 /* Handle full BOOL types */
2108 *((BOOL *)(US data_block + ol->v.offset)) = boolvalue;
2110 *((BOOL *)ol->v.value) = boolvalue;
2114 if (type == opt_bool_verify)
2116 sprintf(CS name2, "%.50s_recipient", name + offset);
2117 if ((ol2 = find_option(name2, oltop, last)))
2119 *((BOOL *)(US data_block + ol2->v.offset)) = boolvalue;
2121 *((BOOL *)ol2->v.value) = boolvalue;
2124 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2126 else if (type == opt_bool_set)
2128 sprintf(CS name2, "*set_%.50s", name + offset);
2129 if ((ol2 = find_option(name2, oltop, last)))
2131 *((BOOL *)(US data_block + ol2->v.offset)) = TRUE;
2133 *((BOOL *)ol2->v.value) = TRUE;
2141 inttype = US"octal ";
2143 /* Integer: a simple(ish) case; allow octal and hex formats, and
2144 suffixes K, M, G, and T. The different types affect output, not input. */
2153 lvalue = strtol(CS s, CSS &endptr, intbase);
2156 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2159 if (errno != ERANGE && *endptr)
2161 uschar * mp = US"TtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2163 if ((mp = Ustrchr(mp, *endptr)))
2168 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2179 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2180 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2181 "absolute value of integer \"%s\" is too large (overflow)", s);
2183 while (isspace(*endptr)) endptr++;
2185 extra_chars_error(endptr, inttype, US"integer value for ", name);
2187 value = (int)lvalue;
2191 *(int *)(US data_block + ol->v.offset) = value;
2193 *(int *)ol->v.value = value;
2196 /* Integer held in K: again, allow formats and suffixes as above. */
2202 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2205 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2208 if (errno != ERANGE && *endptr)
2210 uschar * mp = US"ZzEePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2212 if ((mp = Ustrchr(mp, *endptr)))
2217 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2226 lvalue = (lvalue + 512)/1024;
2229 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2230 "absolute value of integer \"%s\" is too large (overflow)", s);
2232 while (isspace(*endptr)) endptr++;
2234 extra_chars_error(endptr, inttype, US"integer value for ", name);
2237 *(int_eximarith_t *)(US data_block + ol->v.offset) = lvalue;
2239 *(int_eximarith_t *)ol->v.value = lvalue;
2243 /* Fixed-point number: held to 3 decimal places. */
2246 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2247 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2248 "fixed-point number expected for %s", name);
2250 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2251 "integer \"%s\" is too large (overflow)", s);
2255 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2256 "integer \"%s\" is too large (overflow)", s);
2258 /* We get a coverity error here for using count, as it derived
2259 from the tainted buffer pointed to by s, as parsed by sscanf().
2260 By the definition of sscanf we must be accessing between start
2261 and end of s (assuming it is nul-terminated...) so ignore the error. */
2262 /* coverity[tainted_data] */
2263 if (s[count] == '.')
2266 while (isdigit(s[++count]))
2268 value += (s[count] - '0') * d;
2273 while (isspace(s[count])) count++;
2276 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2279 *((int *)(US data_block + ol->v.offset)) = value;
2281 *((int *)ol->v.value) = value;
2284 /* There's a special routine to read time values. */
2287 value = readconf_readtime(s, 0, FALSE);
2289 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2292 *((int *)(US data_block + ol->v.offset)) = value;
2294 *((int *)ol->v.value) = value;
2297 /* A time list is a list of colon-separated times, with the first
2298 element holding the size of the list and the second the number of
2304 int * list = data_block
2305 ? (int *)(US data_block + ol->v.offset)
2306 : (int *)ol->v.value;
2308 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2311 uschar *snext = Ustrchr(s, ':');
2315 while (ss > s && isspace(ss[-1])) ss--;
2318 value = readconf_readtime(s, terminator, FALSE);
2320 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2322 if (count > 1 && value <= list[count])
2323 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2324 "time value out of order for %s", name);
2325 list[count+1] = value;
2326 if (snext == NULL) break;
2328 while (isspace(*s)) s++;
2331 if (count > list[0] - 2)
2332 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2334 if (count > 0 && list[2] == 0) count = 0;
2341 void (*fn)() = ol->v.fn;
2352 /*************************************************
2353 * Print a time value *
2354 *************************************************/
2357 Argument: a time value in seconds
2358 Returns: pointer to a fixed buffer containing the time as a string,
2359 in readconf_readtime() format
2363 readconf_printtime(int t)
2366 uschar *p = time_buffer;
2383 if (w > 0) p += sprintf(CS p, "%dw", w);
2384 if (d > 0) p += sprintf(CS p, "%dd", d);
2385 if (h > 0) p += sprintf(CS p, "%dh", h);
2386 if (m > 0) p += sprintf(CS p, "%dm", m);
2387 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2394 /*************************************************
2395 * Print an individual option value *
2396 *************************************************/
2398 /* This is used by the -bP option, so prints to the standard output.
2399 The entire options list is passed in as an argument, because some options come
2400 in pairs - typically uid/gid settings, which can either be explicit numerical
2401 values, or strings to be expanded later. If the numerical value is unset,
2402 search for "*expand_<name>" to see if there is a string equivalent.
2405 ol option entry, or NULL for an unknown option
2407 options_block NULL for main configuration options; otherwise points to
2408 a driver block; if the option doesn't have opt_public
2409 set, then options_block->options_block is where the item
2411 oltop points to the option list in which ol exists
2412 last one more than the offset of the last entry in optop
2413 no_labels do not show "foo = " at the start.
2415 Returns: boolean success
2419 print_ol(optionlist *ol, uschar *name, void *options_block,
2420 optionlist *oltop, int last, BOOL no_labels)
2433 printf("%s is not a known option\n", name);
2437 /* Non-admin callers cannot see options that have been flagged secure by the
2440 if (!f.admin_user && ol->type & opt_secure)
2443 printf("%s\n", CCS hidden);
2445 printf("%s = %s\n", name, CCS hidden);
2449 /* Else show the value of the option */
2451 value = ol->v.value;
2454 if (!(ol->type & opt_public))
2455 options_block = (void *)(((driver_instance *)options_block)->options_block);
2456 value = (void *)(US options_block + (long int)value);
2459 switch(ol->type & opt_mask)
2462 case opt_rewrite: /* Show the text value */
2464 if (!no_labels) printf("%s = ", name);
2465 printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2469 if (!no_labels) printf("%s = ", name);
2470 printf("%d\n", *((int *)value));
2475 int x = *((int *)value);
2476 if (x != 0 && (x & 1023) == 0)
2480 if ((x & 1023) == 0)
2485 if (!no_labels) printf("%s = ", name);
2486 printf("%d%c\n", x, c);
2490 if (!no_labels) printf("%s = ", name);
2498 int_eximarith_t x = *((int_eximarith_t *)value);
2499 if (!no_labels) printf("%s = ", name);
2500 if (x == 0) printf("0\n");
2501 else if ((x & ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH "T\n", x >> 30);
2502 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2503 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2504 else printf(PR_EXIM_ARITH "K\n", x);
2509 if (!no_labels) printf("%s = ", name);
2510 printf("%#o\n", *((int *)value));
2513 /* Can be negative only when "unset", in which case integer */
2517 int x = *((int *)value);
2520 if (x < 0) printf("%s =\n", name); else
2522 if (!no_labels) printf("%s = ", name);
2523 printf("%d.", x/1000);
2536 /* If the numerical value is unset, try for the string value */
2538 case opt_expand_uid:
2539 if (! *get_set_flag(name, oltop, last, options_block))
2541 sprintf(CS name2, "*expand_%.50s", name);
2542 if ((ol2 = find_option(name2, oltop, last)))
2545 s = *USS (US options_block + ol2->v.offset);
2547 s = *USS ol2->v.value;
2548 if (!no_labels) printf("%s = ", name);
2549 printf("%s\n", s ? string_printing(s) : US"");
2554 /* Else fall through */
2557 if (!no_labels) printf("%s = ", name);
2558 if (! *get_set_flag(name, oltop, last, options_block))
2561 if ((pw = getpwuid(*((uid_t *)value))))
2562 printf("%s\n", pw->pw_name);
2564 printf("%ld\n", (long int)(*((uid_t *)value)));
2567 /* If the numerical value is unset, try for the string value */
2569 case opt_expand_gid:
2570 if (! *get_set_flag(name, oltop, last, options_block))
2572 sprintf(CS name2, "*expand_%.50s", name);
2573 if ( (ol2 = find_option(name2, oltop, last))
2574 && (ol2->type & opt_mask) == opt_stringptr)
2577 s = *USS (US options_block + ol2->v.offset);
2579 s = *USS ol2->v.value;
2580 if (!no_labels) printf("%s = ", name);
2581 printf("%s\n", s ? string_printing(s) : US"");
2586 /* Else fall through */
2589 if (!no_labels) printf("%s = ", name);
2590 if (! *get_set_flag(name, oltop, last, options_block))
2593 if ((gr = getgrgid(*((int *)value))))
2594 printf("%s\n", gr->gr_name);
2596 printf("%ld\n", (long int)(*((int *)value)));
2600 uidlist = *((uid_t **)value);
2601 if (!no_labels) printf("%s =", name);
2604 uschar sep = no_labels ? '\0' : ' ';
2605 for (int i = 1; i <= (int)(uidlist[0]); i++)
2607 uschar *name = NULL;
2608 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2609 if (sep != '\0') printf("%c", sep);
2610 if (name) printf("%s", name);
2611 else printf("%ld", (long int)(uidlist[i]));
2619 gidlist = *((gid_t **)value);
2620 if (!no_labels) printf("%s =", name);
2623 uschar sep = no_labels ? '\0' : ' ';
2624 for (int i = 1; i <= (int)(gidlist[0]); i++)
2626 uschar *name = NULL;
2627 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2628 if (sep != '\0') printf("%c", sep);
2629 if (name) printf("%s", name);
2630 else printf("%ld", (long int)(gidlist[i]));
2638 if (!no_labels) printf("%s = ", name);
2639 printf("%s\n", readconf_printtime(*((int *)value)));
2644 int *list = (int *)value;
2645 if (!no_labels) printf("%s = ", name);
2646 for (int i = 0; i < list[1]; i++)
2647 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2653 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2657 case opt_expand_bool:
2658 sprintf(CS name2, "*expand_%.50s", name);
2659 if ((ol2 = find_option(name2, oltop, last)) && ol2->v.value)
2662 s = *USS (US options_block + ol2->v.offset);
2664 s = *USS ol2->v.value;
2667 if (!no_labels) printf("%s = ", name);
2668 printf("%s\n", string_printing(s));
2671 /* s == NULL => string not set; fall through */
2677 case opt_bool_verify:
2679 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2683 ol->v.fn(name, NULL, no_labels ? opt_fn_print : opt_fn_print|opt_fn_print_label);
2691 /*************************************************
2692 * Print value from main configuration *
2693 *************************************************/
2695 /* This function, called as a result of encountering the -bP option,
2696 causes the value of any main configuration variable to be output if the
2697 second argument is NULL. There are some special values:
2699 all print all main configuration options
2700 config_file print the name of the configuration file
2701 (configure_file will still work, for backward
2703 routers print the routers' configurations
2704 transports print the transports' configuration
2705 authenticators print the authenticators' configuration
2706 macros print the macros' configuration
2707 router_list print a list of router names
2708 transport_list print a list of transport names
2709 authenticator_list print a list of authentication mechanism names
2710 macro_list print a list of macro names
2711 +name print a named list item
2712 local_scan print the local_scan options
2713 config print the configuration as it is parsed
2714 environment print the used execution environment
2716 If the second argument is not NULL, it must be one of "router", "transport",
2717 "authenticator" or "macro" in which case the first argument identifies the
2718 driver whose options are to be printed.
2721 name option name if type == NULL; else driver name
2722 type NULL or driver type name, as described above
2723 no_labels avoid the "foo = " at the start of an item
2725 Returns: Boolean success
2729 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2731 BOOL names_only = FALSE;
2732 optionlist *ol2 = NULL;
2733 driver_instance *d = NULL;
2742 static uschar *types[] = { US"address", US"domain", US"host",
2744 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2745 &hostlist_anchor, &localpartlist_anchor };
2747 for (int i = 0; i < 4; i++)
2748 if ((t = tree_search(*(anchors[i]), name+1)))
2750 namedlist_block * nb = t->data.ptr;
2751 const uschar * s = nb->hide ? hidden : nb->string;
2754 printf("%s\n", CCS s);
2756 printf("%slist %s = %s\n", types[i], name+1, CCS s);
2760 printf("no address, domain, host, or local part list called \"%s\" "
2761 "exists\n", name+1);
2766 if ( Ustrcmp(name, "configure_file") == 0
2767 || Ustrcmp(name, "config_file") == 0)
2769 printf("%s\n", CS config_main_filename);
2773 if (Ustrcmp(name, "all") == 0)
2775 for (optionlist * ol = optionlist_config;
2776 ol < optionlist_config + nelem(optionlist_config); ol++)
2777 if (!(ol->type & opt_hidden))
2778 (void) print_ol(ol, US ol->name, NULL,
2779 optionlist_config, nelem(optionlist_config),
2784 if (Ustrcmp(name, "local_scan") == 0)
2786 #ifndef LOCAL_SCAN_HAS_OPTIONS
2787 printf("local_scan() options are not supported\n");
2790 for (optionlist * ol = local_scan_options;
2791 ol < local_scan_options + local_scan_options_count; ol++)
2792 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2793 local_scan_options_count, no_labels);
2798 if (Ustrcmp(name, "config") == 0)
2800 print_config(f.admin_user, no_labels);
2804 if (Ustrcmp(name, "routers") == 0)
2809 else if (Ustrcmp(name, "transports") == 0)
2811 type = US"transport";
2814 else if (Ustrcmp(name, "authenticators") == 0)
2816 type = US"authenticator";
2819 else if (Ustrcmp(name, "macros") == 0)
2824 else if (Ustrcmp(name, "router_list") == 0)
2830 else if (Ustrcmp(name, "transport_list") == 0)
2832 type = US"transport";
2836 else if (Ustrcmp(name, "authenticator_list") == 0)
2838 type = US"authenticator";
2842 else if (Ustrcmp(name, "macro_list") == 0)
2848 else if (Ustrcmp(name, "environment") == 0)
2853 for (p = USS environ; *p; p++) ;
2854 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2856 for (p = USS environ; *p; p++)
2859 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2867 return print_ol(find_option(name,
2868 optionlist_config, nelem(optionlist_config)),
2869 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2872 /* Handle the options for a router or transport. Skip options that are flagged
2873 as hidden. Some of these are options with names starting with '*', used for
2874 internal alternative representations of other options (which the printing
2875 function will sort out). Others are synonyms kept for backward compatibility.
2878 if (Ustrcmp(type, "router") == 0)
2880 d = (driver_instance *)routers;
2881 ol2 = optionlist_routers;
2882 size = optionlist_routers_size;
2884 else if (Ustrcmp(type, "transport") == 0)
2886 d = (driver_instance *)transports;
2887 ol2 = optionlist_transports;
2888 size = optionlist_transports_size;
2890 else if (Ustrcmp(type, "authenticator") == 0)
2892 d = (driver_instance *)auths;
2893 ol2 = optionlist_auths;
2894 size = optionlist_auths_size;
2897 else if (Ustrcmp(type, "macro") == 0)
2899 /* People store passwords in macros and they were previously not available
2900 for printing. So we have an admin_users restriction. */
2903 fprintf(stderr, "exim: permission denied\n");
2906 for (macro_item * m = macros; m; m = m->next)
2907 if (!name || Ustrcmp(name, m->name) == 0)
2910 printf("%s\n", CS m->name);
2912 printf("%s\n", CS m->replacement);
2914 printf("%s=%s\n", CS m->name, CS m->replacement);
2918 if (!name) return TRUE;
2920 printf("%s %s not found\n", type, name);
2926 for (; d; d = d->next) printf("%s\n", CS d->name);
2930 /* Either search for a given driver, or print all of them */
2932 for (; d; d = d->next)
2936 printf("\n%s %s:\n", d->name, type);
2937 else if (Ustrcmp(d->name, name) != 0) continue;
2939 for (optionlist * ol = ol2; ol < ol2 + size; ol++)
2940 if (!(ol->type & opt_hidden))
2941 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2943 for (optionlist * ol = d->info->options;
2944 ol < d->info->options + *(d->info->options_count); ol++)
2945 if (!(ol->type & opt_hidden))
2946 rc |= print_ol(ol, US ol->name, d, d->info->options,
2947 *d->info->options_count, no_labels);
2949 if (name) return rc;
2951 if (!name) return TRUE;
2953 printf("%s %s not found\n", type, name);
2959 /*************************************************
2960 * Read a named list item *
2961 *************************************************/
2963 /* This function reads a name and a list (i.e. string). The name is used to
2964 save the list in a tree, sorted by its name. Each entry also has a number,
2965 which can be used for caching tests, but if the string contains any expansion
2966 items other than $key, the number is set negative to inhibit caching. This
2967 mechanism is used for domain, host, and address lists that are referenced by
2971 anchorp points to the tree anchor
2972 numberp points to the current number for this tree
2973 max the maximum number permitted
2974 s the text of the option line, starting immediately after the name
2976 tname the name of the list type, for messages
2977 hide do not output value on "-bP"
2983 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2984 uschar *tname, BOOL hide)
2986 BOOL forcecache = FALSE;
2989 namedlist_block * nb = store_get(sizeof(namedlist_block), FALSE);
2991 if (Ustrncmp(s, "_cache", 6) == 0)
2998 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
3000 if (*numberp >= max)
3001 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3004 while (isspace(*s)) s++;
3006 while (isalnum(*s) || *s == '_') s++;
3007 t = store_get(sizeof(tree_node) + s-ss, is_tainted(ss));
3008 Ustrncpy(t->name, ss, s-ss);
3010 while (isspace(*s)) s++;
3012 if (!tree_insertnode(anchorp, t))
3013 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3014 "duplicate name \"%s\" for a named %s", t->name, tname);
3017 nb->number = *numberp;
3021 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3022 "missing '=' after \"%s\"", t->name);
3023 while (isspace(*s)) s++;
3024 nb->string = read_string(s, t->name);
3025 nb->cache_data = NULL;
3027 /* Check the string for any expansions; if any are found, mark this list
3028 uncacheable unless the user has explicited forced caching. */
3030 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3036 /*************************************************
3037 * Unpick data for a rate limit *
3038 *************************************************/
3040 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3044 s string, in the form t,b,f,l
3045 where t is the threshold (integer)
3046 b is the initial delay (time)
3047 f is the multiplicative factor (fixed point)
3048 k is the maximum time (time)
3049 threshold where to store threshold
3050 base where to store base in milliseconds
3051 factor where to store factor in milliseconds
3052 limit where to store limit
3054 Returns: nothing (panics on error)
3058 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3061 uschar bstring[16], lstring[16];
3063 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3064 factor, lstring) == 4)
3066 *base = readconf_readtime(bstring, 0, TRUE);
3067 *limit = readconf_readtime(lstring, 0, TRUE);
3068 if (*base >= 0 && *limit >= 0) return;
3070 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3076 /*************************************************
3077 * Read main configuration options *
3078 *************************************************/
3080 /* This function is the first to be called for configuration reading. It
3081 opens the configuration file and reads general configuration settings until
3082 it reaches the end of the configuration section. The file is then left open so
3083 that the remaining configuration data can subsequently be read if needed for
3086 The configuration file must be owned either by root or exim, and be writeable
3087 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3088 in the config file, so the test is done on the compiled in values. A slight
3089 anomaly, to be carefully documented.
3091 The name of the configuration file is taken from a list that is included in the
3092 binary of Exim. It can be altered from the command line, but if that is done,
3093 root privilege is immediately withdrawn unless the caller is root or exim.
3094 The first file on the list that exists is used.
3096 For use on multiple systems that share file systems, first look for a
3097 configuration file whose name has the current node name on the end. If that is
3098 not found, try the generic name. For really contorted configurations, that run
3099 multiple Exims with different uid settings, first try adding the effective uid
3100 before the node name. These complications are going to waste resources on most
3101 systems. Therefore they are available only when requested by compile-time
3105 readconf_main(BOOL nowarn)
3108 struct stat statbuf;
3109 uschar *s, *filename;
3110 const uschar *list = config_main_filelist;
3112 /* Loop through the possible file names */
3114 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3117 /* Cut out all the fancy processing unless specifically wanted */
3119 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3120 uschar *suffix = filename + Ustrlen(filename);
3122 /* Try for the node-specific file if a node name exists */
3124 #ifdef CONFIGURE_FILE_USE_NODE
3126 if (uname(&uts) >= 0)
3128 #ifdef CONFIGURE_FILE_USE_EUID
3129 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3130 config_file = Ufopen(filename, "rb");
3131 if (config_file == NULL)
3132 #endif /* CONFIGURE_FILE_USE_EUID */
3134 sprintf(CS suffix, ".%.256s", uts.nodename);
3135 config_file = Ufopen(filename, "rb");
3138 #endif /* CONFIGURE_FILE_USE_NODE */
3140 /* Otherwise, try the generic name, possibly with the euid added */
3142 #ifdef CONFIGURE_FILE_USE_EUID
3143 if (config_file == NULL)
3145 sprintf(CS suffix, ".%ld", (long int)original_euid);
3146 config_file = Ufopen(filename, "rb");
3148 #endif /* CONFIGURE_FILE_USE_EUID */
3150 /* Finally, try the unadorned name */
3152 if (config_file == NULL)
3155 config_file = Ufopen(filename, "rb");
3157 #else /* if neither defined */
3159 /* This is the common case when the fancy processing is not included. */
3161 config_file = Ufopen(filename, "rb");
3164 /* If the file does not exist, continue to try any others. For any other
3165 error, break out (and die). */
3167 if (config_file != NULL || errno != ENOENT) break;
3170 /* On success, save the name for verification; config_filename is used when
3171 logging configuration errors (it changes for .included files) whereas
3172 config_main_filename is the name shown by -bP. Failure to open a configuration
3173 file is a serious disaster. */
3177 uschar *last_slash = Ustrrchr(filename, '/');
3178 config_filename = config_main_filename = string_copy(filename);
3180 /* The config_main_directory we need for the $config_dir expansion.
3181 config_main_filename we need for $config_file expansion.
3182 And config_dir is the directory of the current configuration, used for
3183 relative .includes. We do need to know it's name, as we change our working
3186 if (filename[0] == '/')
3187 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3190 /* relative configuration file name: working dir + / + basename(filename) */
3192 uschar buf[PATH_MAX];
3195 if (os_getcwd(buf, PATH_MAX) == NULL)
3197 perror("exim: getcwd");
3200 g = string_cat(NULL, buf);
3202 /* If the dir does not end with a "/", append one */
3203 if (g->s[g->ptr-1] != '/')
3204 g = string_catn(g, US"/", 1);
3206 /* If the config file contains a "/", extract the directory part */
3208 g = string_catn(g, filename, last_slash - filename);
3210 config_main_directory = string_from_gstring(g);
3212 config_directory = config_main_directory;
3216 if (filename == NULL)
3217 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3218 "%s", config_main_filelist);
3220 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3221 "configuration file %s", filename));
3224 /* Now, once we found and opened our configuration file, we change the directory
3225 to a safe place. Later we change to $spool_directory. */
3227 if (Uchdir("/") < 0)
3229 perror("exim: chdir `/': ");
3233 /* Check the status of the file we have opened, if we have retained root
3234 privileges and the file isn't /dev/null (which *should* be 0666). */
3236 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3238 if (fstat(fileno(config_file), &statbuf) != 0)
3239 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3242 if ((statbuf.st_uid != root_uid /* owner not root */
3243 #ifdef CONFIGURE_OWNER
3244 && statbuf.st_uid != config_uid /* owner not the special one */
3247 (statbuf.st_gid != root_gid /* group not root & */
3248 #ifdef CONFIGURE_GROUP
3249 && statbuf.st_gid != config_gid /* group not the special one */
3251 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3253 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3255 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3256 "wrong owner, group, or mode", big_buffer);
3258 /* Do a dummy store-allocation of a size related to the (toplevel) file size.
3259 This assumes we will need this much storage to handle all the allocations
3260 during startup; it won't help when .include is being used. When it does, it
3261 will cut down on the number of store blocks (and malloc calls, and sbrk
3262 syscalls). It also assume we're on the relevant pool. */
3264 if (statbuf.st_size > 8192)
3266 rmark r = store_mark();
3267 void * dummy = store_get((int)statbuf.st_size, FALSE);
3272 /* Process the main configuration settings. They all begin with a lower case
3273 letter. If we see something starting with an upper case letter, it is taken as
3274 a macro definition. */
3276 while ((s = get_config_line()))
3281 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3282 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3283 "found unexpected BOM (Byte Order Mark)");
3287 if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE);
3291 t = (hide = Ustrncmp(s, "hide", 4) == 0 && isspace(s[4])) ? s + 5 : s;
3293 if (Ustrncmp(t, "domainlist", 10) == 0)
3294 read_named_list(&domainlist_anchor, &domainlist_count,
3295 MAX_NAMED_LIST, t+10, US"domain list", hide);
3297 else if (Ustrncmp(t, "hostlist", 8) == 0)
3298 read_named_list(&hostlist_anchor, &hostlist_count,
3299 MAX_NAMED_LIST, t+8, US"host list", hide);
3301 else if (Ustrncmp(t, US"addresslist", 11) == 0)
3302 read_named_list(&addresslist_anchor, &addresslist_count,
3303 MAX_NAMED_LIST, t+11, US"address list", hide);
3305 else if (Ustrncmp(t, US"localpartlist", 13) == 0)
3306 read_named_list(&localpartlist_anchor, &localpartlist_count,
3307 MAX_NAMED_LIST, t+13, US"local part list", hide);
3310 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3311 NULL, US"main option \"%s\" unknown");
3315 /* If local_sender_retain is set, local_from_check must be unset. */
3317 if (local_sender_retain && local_from_check)
3318 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3319 "local_sender_retain are set; this combination is not allowed");
3321 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3324 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3326 /* The max retry interval must not be greater than 24 hours. */
3328 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3330 /* remote_max_parallel must be > 0 */
3332 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3334 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3335 start of a new SMTP message. */
3337 freeze_tell_config = freeze_tell;
3339 /* The primary host name may be required for expansion of spool_directory
3340 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3341 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3342 canonize it. Some people like upper case letters in their host names, so we
3343 don't force the case. */
3345 if (primary_hostname == NULL)
3347 const uschar *hostname;
3349 if (uname(&uts) < 0)
3350 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3351 hostname = US uts.nodename;
3353 if (Ustrchr(hostname, '.') == NULL)
3356 struct hostent *hostdata;
3359 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3360 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3361 MCL_DOMAIN, TRUE, NULL) != OK))
3370 #if HAVE_GETIPNODEBYNAME
3372 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3374 hostdata = gethostbyname2(CS hostname, af);
3377 hostdata = gethostbyname(CS hostname);
3380 if (hostdata != NULL)
3382 hostname = US hostdata->h_name;
3386 if (af == AF_INET) break;
3391 primary_hostname = string_copy(hostname);
3394 /* Set up default value for smtp_active_hostname */
3396 smtp_active_hostname = primary_hostname;
3398 /* If spool_directory wasn't set in the build-time configuration, it must have
3399 got set above. Of course, writing to the log may not work if log_file_path is
3400 not set, but it will at least get to syslog or somewhere, with any luck. */
3402 if (!*spool_directory)
3403 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3406 /* Expand the spool directory name; it may, for example, contain the primary
3407 host name. Same comment about failure. */
3409 if (!(s = expand_string(spool_directory)))
3410 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3411 "\"%s\": %s", spool_directory, expand_string_message);
3412 spool_directory = s;
3414 /* Expand log_file_path, which must contain "%s" in any component that isn't
3415 the null string or "syslog". It is also allowed to contain one instance of %D
3416 or %M. However, it must NOT contain % followed by anything else. */
3420 const uschar *ss, *sss;
3421 int sep = ':'; /* Fixed for log file path */
3422 if (!(s = expand_string(log_file_path)))
3423 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3424 "\"%s\": %s", log_file_path, expand_string_message);
3427 while ((sss = string_nextinlist(&ss, &sep, big_buffer, big_buffer_size)))
3430 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3431 if (!(t = Ustrstr(sss, "%s")))
3432 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3433 "contain \"%%s\"", sss);
3435 if ((t = Ustrchr(sss, '%')))
3436 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3437 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3438 "unexpected \"%%\" character", s);
3444 /* Interpret syslog_facility into an integer argument for 'ident' param to
3445 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3448 if (syslog_facility_str)
3451 uschar *s = syslog_facility_str;
3453 if ((Ustrlen(syslog_facility_str) >= 4) &&
3454 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3457 for (i = 0; i < syslog_list_size; i++)
3458 if (strcmpic(s, syslog_list[i].name) == 0)
3460 syslog_facility = syslog_list[i].value;
3464 if (i >= syslog_list_size)
3465 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3466 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3469 /* Expand pid_file_path */
3471 if (*pid_file_path != 0)
3473 if (!(s = expand_string(pid_file_path)))
3474 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3475 "\"%s\": %s", pid_file_path, expand_string_message);
3479 /* Set default value of process_log_path */
3481 if (!process_log_path || *process_log_path =='\0')
3482 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3484 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3487 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3489 /* Unpick the SMTP rate limiting options, if set */
3491 if (smtp_ratelimit_mail)
3492 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3493 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3495 if (smtp_ratelimit_rcpt)
3496 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3497 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3499 /* The qualify domains default to the primary host name */
3501 if (!qualify_domain_sender)
3502 qualify_domain_sender = primary_hostname;
3503 if (!qualify_domain_recipient)
3504 qualify_domain_recipient = qualify_domain_sender;
3506 /* Setting system_filter_user in the configuration sets the gid as well if a
3507 name is given, but a numerical value does not. */
3509 if (system_filter_uid_set && !system_filter_gid_set)
3511 struct passwd *pw = getpwuid(system_filter_uid);
3513 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3514 (long int)system_filter_uid);
3515 system_filter_gid = pw->pw_gid;
3516 system_filter_gid_set = TRUE;
3519 /* If the errors_reply_to field is set, check that it is syntactically valid
3520 and ensure it contains a domain. */
3522 if (errors_reply_to)
3525 int start, end, domain;
3526 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3527 &start, &end, &domain, FALSE);
3530 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3531 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3534 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3535 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3538 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3539 smtp_accept_max must also be set. */
3541 if (smtp_accept_max == 0 &&
3542 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3543 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3544 "smtp_accept_max must be set if smtp_accept_queue or "
3545 "smtp_accept_max_per_host is set");
3547 /* Set up the host number if anything is specified. It is an expanded string
3548 so that it can be computed from the host name, for example. We do this last
3549 so as to ensure that everything else is set up before the expansion. */
3551 if (host_number_string)
3555 uschar *s = expand_string(host_number_string);
3558 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3559 "failed to expand localhost_number \"%s\": %s",
3560 host_number_string, expand_string_message);
3561 n = Ustrtol(s, &end, 0);
3562 while (isspace(*end)) end++;
3564 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3565 "localhost_number value is not a number: %s", s);
3566 if (n > LOCALHOST_MAX)
3567 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3568 "localhost_number is greater than the maximum allowed value (%d)",
3574 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3576 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3577 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3578 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3579 tls_verify_hosts ? "" : "try_");
3581 /* Magic number: at time of writing, 1024 has been the long-standing value
3582 used by so many clients, and what Exim used to use always, that it makes
3583 sense to just min-clamp this max-clamp at that. */
3584 if (tls_dh_max_bits < 1024)
3585 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3586 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3588 /* If openssl_options is set, validate it */
3589 if (openssl_options)
3592 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3593 "openssl_options is set but we're using GnuTLS");
3596 if (!tls_openssl_options_parse(openssl_options, &dummy))
3597 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3598 "openssl_options parse error: %s", openssl_options);
3601 #endif /*DISABLE_TLS*/
3603 if (!nowarn && !keep_environment && environ && *environ)
3604 log_write(0, LOG_MAIN,
3605 "Warning: purging the environment.\n"
3606 " Suggested action: use keep_environment.");
3611 /*************************************************
3612 * Initialize one driver *
3613 *************************************************/
3615 /* This is called once the driver's generic options, if any, have been read.
3616 We can now find the driver, set up defaults for the private options, and
3617 unset any "set" bits in the private options table (which might have been
3618 set by another incarnation of the same driver).
3621 d pointer to driver instance block, with generic
3623 drivers_available vector of available drivers
3624 size_of_info size of each block in drivers_available
3625 class class of driver, for error message
3627 Returns: pointer to the driver info block
3630 static driver_info *
3631 init_driver(driver_instance *d, driver_info *drivers_available,
3632 int size_of_info, uschar *class)
3634 for (driver_info * dd = drivers_available; dd->driver_name[0] != 0;
3635 dd = (driver_info *)((US dd) + size_of_info))
3636 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3638 int len = dd->options_len;
3640 d->options_block = store_get(len, FALSE);
3641 memcpy(d->options_block, dd->options_block, len);
3642 for (int i = 0; i < *(dd->options_count); i++)
3643 dd->options[i].type &= ~opt_set;
3647 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3648 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3650 return NULL; /* never obeyed */
3656 /*************************************************
3657 * Initialize driver list *
3658 *************************************************/
3660 /* This function is called for routers, transports, and authentication
3661 mechanisms. It reads the data from the current point in the configuration file
3662 up to the end of the section, and sets up a chain of instance blocks according
3663 to the file's contents. The file will already have been opened by a call to
3664 readconf_main, and must be left open for subsequent reading of further data.
3666 Any errors cause a panic crash. Note that the blocks with names driver_info and
3667 driver_instance must map the first portions of all the _info and _instance
3668 blocks for this shared code to work.
3671 class "router", "transport", or "authenticator"
3672 anchor &routers, &transports, &auths
3673 drivers_available available drivers
3674 size_of_info size of each info block
3675 instance_default points to default data for an instance
3676 instance_size size of instance block
3677 driver_optionlist generic option list
3678 driver_optionlist_count count of generic option list
3684 readconf_driver_init(
3686 driver_instance **anchor,
3687 driver_info *drivers_available,
3689 void *instance_default,
3691 optionlist *driver_optionlist,
3692 int driver_optionlist_count)
3694 driver_instance **p = anchor;
3695 driver_instance *d = NULL;
3698 while ((buffer = get_config_line()))
3703 /* Read the first name on the line and test for the start of a new driver. A
3704 macro definition indicates the end of the previous driver. If this isn't the
3705 start of a new driver, the line will be re-read. */
3707 s = readconf_readname(name, sizeof(name), buffer);
3709 /* Handle macro definition, first finishing off the initialization of the
3710 previous driver, if any. */
3712 if (isupper(*name) && *s == '=')
3716 if (!d->driver_name)
3717 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3718 "no driver defined for %s \"%s\"", class, d->name);
3719 /* s is using big_buffer, so this call had better not */
3723 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE);
3727 /* If the line starts with a name terminated by a colon, we are at the
3728 start of the definition of a new driver. The rest of the line must be
3733 /* Finish off initializing the previous driver. */
3737 if (!d->driver_name)
3738 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3739 "no driver defined for %s \"%s\"", class, d->name);
3743 /* Check that we haven't already got a driver of this name */
3745 for (d = *anchor; d; d = d->next)
3746 if (Ustrcmp(name, d->name) == 0)
3747 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3748 "there are two %ss called \"%s\"", class, name);
3750 /* Set up a new driver instance data block on the chain, with
3751 its default values installed. */
3753 d = store_get(instance_size, FALSE);
3754 memcpy(d, instance_default, instance_size);
3757 d->name = string_copy(name);
3759 /* Clear out the "set" bits in the generic options */
3761 for (int i = 0; i < driver_optionlist_count; i++)
3762 driver_optionlist[i].type &= ~opt_set;
3764 /* Check nothing more on this line, then do the next loop iteration. */
3766 while (isspace(*s)) s++;
3767 if (*s) extra_chars_error(s, US"driver name ", name, US"");
3771 /* Not the start of a new driver. Give an error if we have not set up a
3772 current driver yet. */
3775 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3777 /* First look to see if this is a generic option; if it is "driver",
3778 initialize the driver. If is it not a generic option, we can look for a
3779 private option provided that the driver has been previously set up. */
3781 if (readconf_handle_option(buffer, driver_optionlist,
3782 driver_optionlist_count, d, NULL))
3784 if (!d->info && d->driver_name)
3785 init_driver(d, drivers_available, size_of_info, class);
3788 /* Handle private options - pass the generic block because some may
3789 live therein. A flag with each option indicates if it is in the public
3793 readconf_handle_option(buffer, d->info->options,
3794 *(d->info->options_count), d, US"option \"%s\" unknown");
3796 /* The option is not generic and the driver name has not yet been given. */
3798 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3799 "(\"driver\" must be specified before any private options)", name);
3802 /* Run the initialization function for the final driver. */
3806 if (!d->driver_name)
3807 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3808 "no driver defined for %s \"%s\"", class, d->name);
3815 /*************************************************
3816 * Check driver dependency *
3817 *************************************************/
3819 /* This function is passed a driver instance and a string. It checks whether
3820 any of the string options for the driver contains the given string as an
3824 d points to a driver instance block
3825 s the string to search for
3827 Returns: TRUE if a dependency is found
3831 readconf_depends(driver_instance *d, uschar *s)
3833 int count = *(d->info->options_count);
3836 for (optionlist * ol = d->info->options; ol < d->info->options + count; ol++)
3837 if ((ol->type & opt_mask) == opt_stringptr)
3839 void * options_block = ol->type & opt_public ? (void *)d : d->options_block;
3840 uschar * value = *USS(US options_block + ol->v.offset);
3842 if (value && (ss = Ustrstr(value, s)) != NULL)
3844 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3845 isalnum(ss[Ustrlen(s)])) continue;
3846 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3847 d->name, ol->name, s);
3852 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3859 /*************************************************
3860 * Decode an error type for retries *
3861 *************************************************/
3863 /* This function is global because it is also called from the main
3864 program when testing retry information. It decodes strings such as "quota_7d"
3865 into numerical error codes.
3868 pp points to start of text
3869 p points past end of text
3870 basic_errno points to an int to receive the main error number
3871 more_errno points to an int to receive the secondary error data
3873 Returns: NULL if decoded correctly; else points to error text
3877 readconf_retry_error(const uschar *pp, const uschar *p,
3878 int *basic_errno, int *more_errno)
3881 const uschar *q = pp;
3882 while (q < p && *q != '_') q++;
3885 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3887 *basic_errno = ERRNO_EXIMQUOTA;
3888 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3889 return US"bad time value";
3892 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3894 *basic_errno = ECONNREFUSED;
3897 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3898 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3899 else return US"A or MX expected after \"refused\"";
3903 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3905 *basic_errno = ETIMEDOUT;
3909 int xlen = p - q - 1;
3910 const uschar *x = q + 1;
3912 static uschar *extras[] =
3913 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3914 static int values[] =
3915 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3917 for (i = 0; i < nelem(extras); i++)
3918 if (strncmpic(x, extras[i], xlen) == 0)
3920 *more_errno = values[i];
3924 if (i >= nelem(extras))
3925 if (strncmpic(x, US"DNS", xlen) == 0)
3926 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3927 "available in retry rules (it has never worked) - treated as "
3930 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3934 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3935 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3936 strncmpic(pp, US"data_4", 6) == 0)
3939 int x = 255; /* means "any 4xx code" */
3940 if (p != pp + 8) bad = TRUE; else
3942 int a = pp[6], b = pp[7];
3946 if (isdigit(b)) x += b - '0';
3947 else if (b == 'x') x += 100;
3950 else if (a != 'x' || b != 'x') bad = TRUE;
3954 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3955 "x is literal and d is any digit", pp);
3957 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3958 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3959 *more_errno = x << 8;
3962 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3963 strncmpic(q+1, US"failed", p-q-1) == 0)
3964 *basic_errno = ERRNO_AUTHFAIL;
3966 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3967 *basic_errno = ERRNO_SMTPCLOSED;
3969 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3970 *basic_errno = ERRNO_TLSREQUIRED;
3972 else if (strncmpic(pp, US"lookup", p - pp) == 0)
3973 *basic_errno = ERRNO_UNKNOWNHOST;
3975 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3976 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3984 /*************************************************
3985 * Read retry information *
3986 *************************************************/
3988 /* Each line of retry information contains:
3990 . A domain name pattern or an address pattern;
3992 . An error name, possibly with additional data, or *;
3994 . An optional sequence of retry items, each consisting of an identifying
3995 letter, a cutoff time, and optional parameters.
3997 All this is decoded and placed into a control block. */
4000 /* Subroutine to read an argument, preceded by a comma and terminated
4001 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4002 1 = fixed point number (returned *1000).
4005 paddr pointer to pointer to current character; updated
4006 type 0 => read a time; 1 => read a fixed point number
4008 Returns: time in seconds or fixed point number * 1000
4012 retry_arg(const uschar **paddr, int type)
4014 const uschar *p = *paddr;
4017 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4019 while (isspace(*p)) p++;
4021 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4023 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4024 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4029 case 0: return readconf_readtime(pp, *p, FALSE);
4030 case 1: return readconf_readfixed(pp, *p);
4032 return 0; /* Keep picky compilers happy */
4035 /* The function proper */
4038 readconf_retries(void)
4040 retry_config **chain = &retries;
4044 while ((p = get_config_line()))
4046 retry_rule **rchain;
4050 next = store_get(sizeof(retry_config), FALSE);
4053 chain = &(next->next);
4054 next->basic_errno = next->more_errno = 0;
4055 next->senders = NULL;
4057 rchain = &(next->rules);
4059 next->pattern = string_dequote(&p);
4060 while (isspace(*p)) p++;
4062 while (mac_isgraph(*p)) p++;
4063 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4064 "missing error type in retry rule");
4066 /* Test error names for things we understand. */
4068 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4069 &next->more_errno)))
4070 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4072 /* There may be an optional address list of senders to be used as another
4073 constraint on the rule. This was added later, so the syntax is a bit of a
4074 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4077 while (isspace(*p)) p++;
4078 if (Ustrncmp(p, "senders", 7) == 0)
4081 while (isspace(*p)) p++;
4082 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4083 "\"=\" expected after \"senders\" in retry rule");
4084 while (isspace(*p)) p++;
4085 next->senders = string_dequote(&p);
4088 /* Now the retry rules. Keep the maximum timeout encountered. */
4090 while (isspace(*p)) p++;
4094 retry_rule *rule = store_get(sizeof(retry_rule), FALSE);
4096 rchain = &(rule->next);
4098 rule->rule = toupper(*p++);
4099 rule->timeout = retry_arg(&p, 0);
4100 if (rule->timeout > retry_maximum_timeout)
4101 retry_maximum_timeout = rule->timeout;
4105 case 'F': /* Fixed interval */
4106 rule->p1 = retry_arg(&p, 0);
4109 case 'G': /* Geometrically increasing intervals */
4110 case 'H': /* Ditto, but with randomness */
4111 rule->p1 = retry_arg(&p, 0);
4112 rule->p2 = retry_arg(&p, 1);
4116 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4120 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4121 (rule->rule != 'F' && rule->p2 < 1000))
4122 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4123 "bad parameters for retry rule");
4125 while (isspace(*p)) p++;
4129 while (isspace(*p)) p++;
4132 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4139 /*************************************************
4140 * Initialize authenticators *
4141 *************************************************/
4143 /* Read the authenticators section of the configuration file.
4152 #ifndef DISABLE_PIPE_CONNECT
4156 readconf_driver_init(US"authenticator",
4157 (driver_instance **)(&auths), /* chain anchor */
4158 (driver_info *)auths_available, /* available drivers */
4159 sizeof(auth_info), /* size of info block */
4160 &auth_defaults, /* default values for generic options */
4161 sizeof(auth_instance), /* size of instance block */
4162 optionlist_auths, /* generic options */
4163 optionlist_auths_size);
4165 for (auth_instance * au = auths; au; au = au->next)
4167 if (!au->public_name)
4168 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4169 "the %s authenticator", au->name);
4171 for (auth_instance * bu = au->next; bu; bu = bu->next)
4172 if (strcmpic(au->public_name, bu->public_name) == 0)
4173 if ((au->client && bu->client) || (au->server && bu->server))
4174 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4175 "(%s and %s) have the same public name (%s)",
4176 au->client ? US"client" : US"server", au->name, bu->name,
4178 #ifndef DISABLE_PIPE_CONNECT
4182 #ifndef DISABLE_PIPE_CONNECT
4183 f.smtp_in_early_pipe_no_auth = nauths > 16;
4190 /*************************************************
4191 * Read ACL information *
4192 *************************************************/
4194 /* If this run of Exim is not doing something that involves receiving a
4195 message, we can just skip over the ACL information. No need to parse it.
4197 First, we have a function for acl_read() to call back to get the next line. We
4198 need to remember the line we passed, because at the end it will contain the
4199 name of the next ACL. */
4201 static uschar *acl_line;
4206 acl_line = get_config_line();
4211 /* Now the main function:
4222 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4225 acl_line = get_config_line();
4233 p = readconf_readname(name, sizeof(name), acl_line);
4234 if (isupper(*name) && *p == '=')
4236 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE);
4237 acl_line = get_config_line();
4241 if (*p != ':' || name[0] == 0)
4242 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4244 node = store_get(sizeof(tree_node) + Ustrlen(name), is_tainted(name));
4245 Ustrcpy(node->name, name);
4246 if (!tree_insertnode(&acl_anchor, node))
4247 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4248 "there are two ACLs called \"%s\"", name);
4250 node->data.ptr = acl_read(acl_callback, &error);
4252 if (node->data.ptr == NULL && error != NULL)
4253 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4259 /*************************************************
4260 * Read configuration for local_scan() *
4261 *************************************************/
4263 /* This function is called after "begin local_scan" is encountered in the
4264 configuration file. If the local_scan() function allows for configuration
4265 options, we can process them. Otherwise, we expire in a panic.
4272 local_scan_init(void)
4274 #ifndef LOCAL_SCAN_HAS_OPTIONS
4275 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4276 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4280 while ((p = get_config_line()))
4281 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4282 NULL, US"local_scan option \"%s\" unknown");
4288 /*************************************************
4289 * Read rest of configuration (after main) *
4290 *************************************************/
4292 /* This function reads the rest of the runtime configuration, after the main
4293 configuration. It is called only when actually needed. Each subsequent section
4294 of the configuration starts with a line of the form
4298 where the name is "routers", "transports", etc. A section is terminated by
4299 hitting the next "begin" line, and the next name is left in next_section.
4300 Because it may confuse people as to whether the names are singular or plural,
4301 we add "s" if it's missing. There is always enough room in next_section for
4302 this. This function is basically just a switch.
4308 static uschar *section_list[] = {
4322 while(next_section[0] != 0)
4326 int last = nelem(section_list);
4328 int n = Ustrlen(next_section);
4330 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, US"s");
4334 int c = strcmpic(next_section, section_list[mid]);
4336 if (c > 0) first = mid + 1; else last = mid;
4338 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4339 "\"%.*s\" is not a known configuration section name", n, next_section);
4340 mid = (last + first)/2;
4344 if (((had ^= bit) & bit) == 0)
4345 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4346 "\"%.*s\" section is repeated in the configuration file", n,
4351 case 0: readconf_acl(); break;
4352 case 1: auths_init(); break;
4353 case 2: local_scan_init(); break;
4354 case 3: readconf_retries(); break;
4355 case 4: readconf_rewrites(); break;
4356 case 5: route_init(); break;
4357 case 6: transport_init(); break;
4361 (void)fclose(config_file);
4364 /* Init the storage for the pre-parsed config lines */
4366 readconf_save_config(const uschar *s)
4368 save_config_line(string_sprintf("# Exim Configuration (%s)",
4369 f.running_in_test_harness ? US"X" : s));
4373 save_config_position(const uschar *file, int line)
4375 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4378 /* Append a pre-parsed logical line to the config lines store,
4379 this operates on a global (static) list that holds all the pre-parsed
4380 config lines, we do no further processing here, output formatting and
4381 honouring of <hide> or macros will be done during output */
4384 save_config_line(const uschar* line)
4386 static config_line_item *current;
4387 config_line_item *next;
4389 next = (config_line_item*) store_get(sizeof(config_line_item), FALSE);
4390 next->line = string_copy(line);
4393 if (!config_lines) config_lines = next;
4394 else current->next = next;
4399 /* List the parsed config lines, care about nice formatting and
4400 hide the <hide> values unless we're the admin user */
4402 print_config(BOOL admin, BOOL terse)
4404 const int TS = terse ? 0 : 2;
4407 for (config_line_item * i = config_lines; i; i = i->next)
4412 /* skip over to the first non-space */
4413 for (current = i->line; *current && isspace(*current); ++current)
4416 if (*current == '\0')
4419 /* Collapse runs of spaces. We stop this if we encounter one of the
4420 * following characters: "'$, as this may indicate careful formatting */
4421 for (p = current; *p; ++p)
4424 if (!isspace(*p)) continue;
4425 if (*p != ' ') *p = ' ';
4427 for (next = p; isspace(*next); ++next)
4431 memmove(p+1, next, Ustrlen(next)+1);
4433 if (*next == '"' || *next == '\'' || *next == '$')
4438 if (current[0] == '#')
4441 /* begin lines are left aligned */
4442 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4444 if (!terse) puts("");
4449 /* router/acl/transport block names */
4450 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4452 if (!terse) puts("");
4453 printf("%*s%s\n", TS, "", current);
4457 /* hidden lines (all MACROS or lines prefixed with "hide") */
4459 && ( isupper(*current)
4460 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4464 if ((p = Ustrchr(current, '=')))
4467 printf("%*s%s= %s\n", indent, "", current, CCS hidden);
4469 /* e.g.: hide split_spool_directory */
4471 printf("%*s\n", indent, CCS hidden);
4475 /* rest is public */
4476 printf("%*s%s\n", indent, "", current);
4480 #endif /*!MACRO_PREDEF*/
4483 /* End of readconf.c */