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_min_keysizes", opt_stringptr, {&dkim_verify_min_keysizes} },
123 { "dkim_verify_minimal", opt_bool, {&dkim_verify_minimal} },
124 { "dkim_verify_signers", opt_stringptr, {&dkim_verify_signers} },
127 { "dmarc_forensic_sender", opt_stringptr, {&dmarc_forensic_sender} },
128 { "dmarc_history_file", opt_stringptr, {&dmarc_history_file} },
129 { "dmarc_tld_file", opt_stringptr, {&dmarc_tld_file} },
131 { "dns_again_means_nonexist", opt_stringptr, {&dns_again_means_nonexist} },
132 { "dns_check_names_pattern", opt_stringptr, {&check_dns_names_pattern} },
133 { "dns_cname_loops", opt_int, {&dns_cname_loops} },
134 { "dns_csa_search_limit", opt_int, {&dns_csa_search_limit} },
135 { "dns_csa_use_reverse", opt_bool, {&dns_csa_use_reverse} },
136 { "dns_dnssec_ok", opt_int, {&dns_dnssec_ok} },
137 { "dns_ipv4_lookup", opt_stringptr, {&dns_ipv4_lookup} },
138 { "dns_retrans", opt_time, {&dns_retrans} },
139 { "dns_retry", opt_int, {&dns_retry} },
140 { "dns_trust_aa", opt_stringptr, {&dns_trust_aa} },
141 { "dns_use_edns0", opt_int, {&dns_use_edns0} },
142 /* This option is now a no-op, retained for compatibility */
143 { "drop_cr", opt_bool, {&drop_cr} },
144 /*********************************************************/
145 { "dsn_advertise_hosts", opt_stringptr, {&dsn_advertise_hosts} },
146 { "dsn_from", opt_stringptr, {&dsn_from} },
147 { "envelope_to_remove", opt_bool, {&envelope_to_remove} },
148 { "errors_copy", opt_stringptr, {&errors_copy} },
149 { "errors_reply_to", opt_stringptr, {&errors_reply_to} },
150 #ifndef DISABLE_EVENT
151 { "event_action", opt_stringptr, {&event_action} },
153 { "exim_group", opt_gid, {&exim_gid} },
154 { "exim_path", opt_stringptr, {&exim_path} },
155 { "exim_user", opt_uid, {&exim_uid} },
156 { "exim_version", opt_stringptr, {&version_string} },
157 { "extra_local_interfaces", opt_stringptr, {&extra_local_interfaces} },
158 { "extract_addresses_remove_arguments", opt_bool, {&extract_addresses_remove_arguments} },
159 { "finduser_retries", opt_int, {&finduser_retries} },
160 { "freeze_tell", opt_stringptr, {&freeze_tell} },
161 { "gecos_name", opt_stringptr, {&gecos_name} },
162 { "gecos_pattern", opt_stringptr, {&gecos_pattern} },
164 { "gnutls_allow_auto_pkcs11", opt_bool, {&gnutls_allow_auto_pkcs11} },
165 { "gnutls_compat_mode", opt_bool, {&gnutls_compat_mode} },
167 { "header_line_maxsize", opt_int, {&header_line_maxsize} },
168 { "header_maxsize", opt_int, {&header_maxsize} },
169 { "headers_charset", opt_stringptr, {&headers_charset} },
170 { "helo_accept_junk_hosts", opt_stringptr, {&helo_accept_junk_hosts} },
171 { "helo_allow_chars", opt_stringptr, {&helo_allow_chars} },
172 { "helo_lookup_domains", opt_stringptr, {&helo_lookup_domains} },
173 { "helo_try_verify_hosts", opt_stringptr, {&helo_try_verify_hosts} },
174 { "helo_verify_hosts", opt_stringptr, {&helo_verify_hosts} },
175 { "hold_domains", opt_stringptr, {&hold_domains} },
176 { "host_lookup", opt_stringptr, {&host_lookup} },
177 { "host_lookup_order", opt_stringptr, {&host_lookup_order} },
178 { "host_reject_connection", opt_stringptr, {&host_reject_connection} },
179 { "hosts_connection_nolog", opt_stringptr, {&hosts_connection_nolog} },
181 { "hosts_proxy", opt_stringptr, {&hosts_proxy} },
183 { "hosts_treat_as_local", opt_stringptr, {&hosts_treat_as_local} },
185 { "ibase_servers", opt_stringptr, {&ibase_servers} },
187 { "ignore_bounce_errors_after", opt_time, {&ignore_bounce_errors_after} },
188 { "ignore_fromline_hosts", opt_stringptr, {&ignore_fromline_hosts} },
189 { "ignore_fromline_local", opt_bool, {&ignore_fromline_local} },
190 { "keep_environment", opt_stringptr, {&keep_environment} },
191 { "keep_malformed", opt_time, {&keep_malformed} },
193 { "ldap_ca_cert_dir", opt_stringptr, {&eldap_ca_cert_dir} },
194 { "ldap_ca_cert_file", opt_stringptr, {&eldap_ca_cert_file} },
195 { "ldap_cert_file", opt_stringptr, {&eldap_cert_file} },
196 { "ldap_cert_key", opt_stringptr, {&eldap_cert_key} },
197 { "ldap_cipher_suite", opt_stringptr, {&eldap_cipher_suite} },
198 { "ldap_default_servers", opt_stringptr, {&eldap_default_servers} },
199 { "ldap_require_cert", opt_stringptr, {&eldap_require_cert} },
200 { "ldap_start_tls", opt_bool, {&eldap_start_tls} },
201 { "ldap_version", opt_int, {&eldap_version} },
203 { "local_from_check", opt_bool, {&local_from_check} },
204 { "local_from_prefix", opt_stringptr, {&local_from_prefix} },
205 { "local_from_suffix", opt_stringptr, {&local_from_suffix} },
206 { "local_interfaces", opt_stringptr, {&local_interfaces} },
207 #ifdef HAVE_LOCAL_SCAN
208 { "local_scan_timeout", opt_time, {&local_scan_timeout} },
210 { "local_sender_retain", opt_bool, {&local_sender_retain} },
211 { "localhost_number", opt_stringptr, {&host_number_string} },
212 { "log_file_path", opt_stringptr, {&log_file_path} },
213 { "log_selector", opt_stringptr, {&log_selector_string} },
214 { "log_timezone", opt_bool, {&log_timezone} },
215 { "lookup_open_max", opt_int, {&lookup_open_max} },
216 { "max_username_length", opt_int, {&max_username_length} },
217 { "message_body_newlines", opt_bool, {&message_body_newlines} },
218 { "message_body_visible", opt_mkint, {&message_body_visible} },
219 { "message_id_header_domain", opt_stringptr, {&message_id_domain} },
220 { "message_id_header_text", opt_stringptr, {&message_id_text} },
221 { "message_logs", opt_bool, {&message_logs} },
222 { "message_size_limit", opt_stringptr, {&message_size_limit} },
223 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
224 { "move_frozen_messages", opt_bool, {&move_frozen_messages} },
226 { "mua_wrapper", opt_bool, {&mua_wrapper} },
228 { "mysql_servers", opt_stringptr, {&mysql_servers} },
230 { "never_users", opt_uidlist, {&never_users} },
231 { "notifier_socket", opt_stringptr, {¬ifier_socket} },
233 { "openssl_options", opt_stringptr, {&openssl_options} },
236 { "oracle_servers", opt_stringptr, {&oracle_servers} },
238 { "percent_hack_domains", opt_stringptr, {&percent_hack_domains} },
240 { "perl_at_start", opt_bool, {&opt_perl_at_start} },
241 { "perl_startup", opt_stringptr, {&opt_perl_startup} },
242 { "perl_taintmode", opt_bool, {&opt_perl_taintmode} },
245 { "pgsql_servers", opt_stringptr, {&pgsql_servers} },
247 { "pid_file_path", opt_stringptr, {&pid_file_path} },
248 { "pipelining_advertise_hosts", opt_stringptr, {&pipelining_advertise_hosts} },
249 #ifndef DISABLE_PIPE_CONNECT
250 { "pipelining_connect_advertise_hosts", opt_stringptr,
251 {&pipe_connect_advertise_hosts} },
254 { "prdr_enable", opt_bool, {&prdr_enable} },
256 { "preserve_message_logs", opt_bool, {&preserve_message_logs} },
257 { "primary_hostname", opt_stringptr, {&primary_hostname} },
258 { "print_topbitchars", opt_bool, {&print_topbitchars} },
259 { "process_log_path", opt_stringptr, {&process_log_path} },
260 { "prod_requires_admin", opt_bool, {&prod_requires_admin} },
261 { "qualify_domain", opt_stringptr, {&qualify_domain_sender} },
262 { "qualify_recipient", opt_stringptr, {&qualify_domain_recipient} },
263 { "queue_domains", opt_stringptr, {&queue_domains} },
264 #ifdef EXPERIMENTAL_QUEUE_RAMP
265 { "queue_fast_ramp", opt_bool, {&queue_fast_ramp} },
267 { "queue_list_requires_admin",opt_bool, {&queue_list_requires_admin} },
268 { "queue_only", opt_bool, {&queue_only} },
269 { "queue_only_file", opt_stringptr, {&queue_only_file} },
270 { "queue_only_load", opt_fixed, {&queue_only_load} },
271 { "queue_only_load_latch", opt_bool, {&queue_only_load_latch} },
272 { "queue_only_override", opt_bool, {&queue_only_override} },
273 { "queue_run_in_order", opt_bool, {&queue_run_in_order} },
274 { "queue_run_max", opt_stringptr, {&queue_run_max} },
275 { "queue_smtp_domains", opt_stringptr, {&queue_smtp_domains} },
276 { "receive_timeout", opt_time, {&receive_timeout} },
277 { "received_header_text", opt_stringptr, {&received_header_text} },
278 { "received_headers_max", opt_int, {&received_headers_max} },
279 { "recipient_unqualified_hosts", opt_stringptr, {&recipient_unqualified_hosts} },
280 { "recipients_max", opt_int, {&recipients_max} },
281 { "recipients_max_reject", opt_bool, {&recipients_max_reject} },
283 { "redis_servers", opt_stringptr, {&redis_servers} },
285 { "remote_max_parallel", opt_int, {&remote_max_parallel} },
286 { "remote_sort_domains", opt_stringptr, {&remote_sort_domains} },
287 { "retry_data_expire", opt_time, {&retry_data_expire} },
288 { "retry_interval_max", opt_time, {&retry_interval_max} },
289 { "return_path_remove", opt_bool, {&return_path_remove} },
290 { "return_size_limit", opt_mkint|opt_hidden, {&bounce_return_size_limit} },
291 { "rfc1413_hosts", opt_stringptr, {&rfc1413_hosts} },
292 { "rfc1413_query_timeout", opt_time, {&rfc1413_query_timeout} },
293 { "sender_unqualified_hosts", opt_stringptr, {&sender_unqualified_hosts} },
294 { "slow_lookup_log", opt_int, {&slow_lookup_log} },
295 { "smtp_accept_keepalive", opt_bool, {&smtp_accept_keepalive} },
296 { "smtp_accept_max", opt_int, {&smtp_accept_max} },
297 { "smtp_accept_max_nonmail", opt_int, {&smtp_accept_max_nonmail} },
298 { "smtp_accept_max_nonmail_hosts", opt_stringptr, {&smtp_accept_max_nonmail_hosts} },
299 { "smtp_accept_max_per_connection", opt_int, {&smtp_accept_max_per_connection} },
300 { "smtp_accept_max_per_host", opt_stringptr, {&smtp_accept_max_per_host} },
301 { "smtp_accept_queue", opt_int, {&smtp_accept_queue} },
302 { "smtp_accept_queue_per_connection", opt_int, {&smtp_accept_queue_per_connection} },
303 { "smtp_accept_reserve", opt_int, {&smtp_accept_reserve} },
304 { "smtp_active_hostname", opt_stringptr, {&raw_active_hostname} },
305 { "smtp_banner", opt_stringptr, {&smtp_banner} },
306 { "smtp_check_spool_space", opt_bool, {&smtp_check_spool_space} },
307 { "smtp_connect_backlog", opt_int, {&smtp_connect_backlog} },
308 { "smtp_enforce_sync", opt_bool, {&smtp_enforce_sync} },
309 { "smtp_etrn_command", opt_stringptr, {&smtp_etrn_command} },
310 { "smtp_etrn_serialize", opt_bool, {&smtp_etrn_serialize} },
311 { "smtp_load_reserve", opt_fixed, {&smtp_load_reserve} },
312 { "smtp_max_synprot_errors", opt_int, {&smtp_max_synprot_errors} },
313 { "smtp_max_unknown_commands",opt_int, {&smtp_max_unknown_commands} },
314 { "smtp_ratelimit_hosts", opt_stringptr, {&smtp_ratelimit_hosts} },
315 { "smtp_ratelimit_mail", opt_stringptr, {&smtp_ratelimit_mail} },
316 { "smtp_ratelimit_rcpt", opt_stringptr, {&smtp_ratelimit_rcpt} },
317 { "smtp_receive_timeout", opt_func, {.fn = &fn_smtp_receive_timeout} },
318 { "smtp_reserve_hosts", opt_stringptr, {&smtp_reserve_hosts} },
319 { "smtp_return_error_details",opt_bool, {&smtp_return_error_details} },
321 { "smtputf8_advertise_hosts", opt_stringptr, {&smtputf8_advertise_hosts} },
323 #ifdef WITH_CONTENT_SCAN
324 { "spamd_address", opt_stringptr, {&spamd_address} },
327 { "spf_guess", opt_stringptr, {&spf_guess} },
329 { "split_spool_directory", opt_bool, {&split_spool_directory} },
330 { "spool_directory", opt_stringptr, {&spool_directory} },
331 { "spool_wireformat", opt_bool, {&spool_wireformat} },
333 { "sqlite_dbfile", opt_stringptr, {&sqlite_dbfile} },
334 { "sqlite_lock_timeout", opt_int, {&sqlite_lock_timeout} },
336 #ifdef EXPERIMENTAL_SRS
337 { "srs_config", opt_stringptr, {&srs_config} },
338 { "srs_hashlength", opt_int, {&srs_hashlength} },
339 { "srs_hashmin", opt_int, {&srs_hashmin} },
340 { "srs_maxage", opt_int, {&srs_maxage} },
341 { "srs_secrets", opt_stringptr, {&srs_secrets} },
342 { "srs_usehash", opt_bool, {&srs_usehash} },
343 { "srs_usetimestamp", opt_bool, {&srs_usetimestamp} },
345 { "strict_acl_vars", opt_bool, {&strict_acl_vars} },
346 { "strip_excess_angle_brackets", opt_bool, {&strip_excess_angle_brackets} },
347 { "strip_trailing_dot", opt_bool, {&strip_trailing_dot} },
348 { "syslog_duplication", opt_bool, {&syslog_duplication} },
349 { "syslog_facility", opt_stringptr, {&syslog_facility_str} },
350 { "syslog_pid", opt_bool, {&syslog_pid} },
351 { "syslog_processname", opt_stringptr, {&syslog_processname} },
352 { "syslog_timestamp", opt_bool, {&syslog_timestamp} },
353 { "system_filter", opt_stringptr, {&system_filter} },
354 { "system_filter_directory_transport", opt_stringptr,{&system_filter_directory_transport} },
355 { "system_filter_file_transport",opt_stringptr,{&system_filter_file_transport} },
356 { "system_filter_group", opt_gid, {&system_filter_gid} },
357 { "system_filter_pipe_transport",opt_stringptr,{&system_filter_pipe_transport} },
358 { "system_filter_reply_transport",opt_stringptr,{&system_filter_reply_transport} },
359 { "system_filter_user", opt_uid, {&system_filter_uid} },
360 { "tcp_nodelay", opt_bool, {&tcp_nodelay} },
361 #ifdef USE_TCP_WRAPPERS
362 { "tcp_wrappers_daemon_name", opt_stringptr, {&tcp_wrappers_daemon_name} },
364 { "timeout_frozen_after", opt_time, {&timeout_frozen_after} },
365 { "timezone", opt_stringptr, {&timezone_string} },
366 { "tls_advertise_hosts", opt_stringptr, {&tls_advertise_hosts} },
368 { "tls_certificate", opt_stringptr, {&tls_certificate} },
369 { "tls_crl", opt_stringptr, {&tls_crl} },
370 { "tls_dh_max_bits", opt_int, {&tls_dh_max_bits} },
371 { "tls_dhparam", opt_stringptr, {&tls_dhparam} },
372 { "tls_eccurve", opt_stringptr, {&tls_eccurve} },
373 # ifndef DISABLE_OCSP
374 { "tls_ocsp_file", opt_stringptr, {&tls_ocsp_file} },
376 { "tls_on_connect_ports", opt_stringptr, {&tls_in.on_connect_ports} },
377 { "tls_privatekey", opt_stringptr, {&tls_privatekey} },
378 { "tls_remember_esmtp", opt_bool, {&tls_remember_esmtp} },
379 { "tls_require_ciphers", opt_stringptr, {&tls_require_ciphers} },
380 # ifdef EXPERIMENTAL_TLS_RESUME
381 { "tls_resumption_hosts", opt_stringptr, {&tls_resumption_hosts} },
383 { "tls_try_verify_hosts", opt_stringptr, {&tls_try_verify_hosts} },
384 { "tls_verify_certificates", opt_stringptr, {&tls_verify_certificates} },
385 { "tls_verify_hosts", opt_stringptr, {&tls_verify_hosts} },
387 { "trusted_groups", opt_gidlist, {&trusted_groups} },
388 { "trusted_users", opt_uidlist, {&trusted_users} },
389 { "unknown_login", opt_stringptr, {&unknown_login} },
390 { "unknown_username", opt_stringptr, {&unknown_username} },
391 { "untrusted_set_sender", opt_stringptr, {&untrusted_set_sender} },
392 { "uucp_from_pattern", opt_stringptr, {&uucp_from_pattern} },
393 { "uucp_from_sender", opt_stringptr, {&uucp_from_sender} },
394 { "warn_message_file", opt_stringptr, {&warn_message_file} },
395 { "write_rejectlog", opt_bool, {&write_rejectlog} }
399 static int optionlist_config_size = nelem(optionlist_config);
406 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags) {/*Dummy*/}
411 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
419 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
421 for (struct auth_info * ai = auths_available; ai->driver_name[0]; ai++)
423 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
424 builtin_macro_create(buf);
425 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
427 if (ai->macros_create) (ai->macros_create)();
432 options_logging(void)
436 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
438 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
439 builtin_macro_create(buf);
444 #else /*!MACRO_PREDEF*/
446 extern char **environ;
448 static void save_config_line(const uschar* line);
449 static void save_config_position(const uschar *file, int line);
450 static void print_config(BOOL admin, BOOL terse);
453 #define CSTATE_STACK_SIZE 10
455 const uschar *config_directory = NULL;
458 /* Structure for chain (stack) of .included files */
460 typedef struct config_file_item {
461 struct config_file_item *next;
462 const uschar *filename;
463 const uschar *directory;
468 /* Structure for chain of configuration lines (-bP config) */
470 typedef struct config_line_item {
471 struct config_line_item *next;
475 static config_line_item* config_lines;
477 /* Structure of table of conditional words and their state transitions */
479 typedef struct cond_item {
487 /* Structure of table of syslog facility names and values */
489 typedef struct syslog_fac_item {
495 static const uschar * const hidden = US"<value not displayable>";
497 /* Static variables */
499 static config_file_item *config_file_stack = NULL; /* For includes */
501 static uschar *syslog_facility_str = NULL;
502 static uschar next_section[24];
503 static uschar time_buffer[24];
505 /* State variables for conditional loading (.ifdef / .else / .endif) */
507 static int cstate = 0;
508 static int cstate_stack_ptr = -1;
509 static int cstate_stack[CSTATE_STACK_SIZE];
511 /* Table of state transitions for handling conditional inclusions. There are
512 four possible state transitions:
516 .elifdef true (or .else)
519 .endif just causes the previous cstate to be popped off the stack */
521 static int next_cstate[3][4] =
523 /* State 0: reading from file, or reading until next .else or .endif */
525 /* State 1: condition failed, skipping until next .else or .endif */
527 /* State 2: skipping until .endif */
531 /* Table of conditionals and the states to set. For each name, there are four
532 values: the length of the name (to save computing it each time), the state to
533 set if a macro was found in the line, the state to set if a macro was not found
534 in the line, and a stack manipulation setting which is:
536 -1 pull state value off the stack
537 0 don't alter the stack
538 +1 push value onto stack, before setting new state
541 static cond_item cond_list[] = {
542 { US"ifdef", 5, 0, 1, 1 },
543 { US"ifndef", 6, 1, 0, 1 },
544 { US"elifdef", 7, 2, 3, 0 },
545 { US"elifndef", 8, 3, 2, 0 },
546 { US"else", 4, 2, 2, 0 },
547 { US"endif", 5, 0, 0, -1 }
550 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
552 /* Table of syslog facility names and their values */
554 static syslog_fac_item syslog_list[] = {
555 { US"mail", LOG_MAIL },
556 { US"user", LOG_USER },
557 { US"news", LOG_NEWS },
558 { US"uucp", LOG_UUCP },
559 { US"local0", LOG_LOCAL0 },
560 { US"local1", LOG_LOCAL1 },
561 { US"local2", LOG_LOCAL2 },
562 { US"local3", LOG_LOCAL3 },
563 { US"local4", LOG_LOCAL4 },
564 { US"local5", LOG_LOCAL5 },
565 { US"local6", LOG_LOCAL6 },
566 { US"local7", LOG_LOCAL7 },
567 { US"daemon", LOG_DAEMON }
570 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
573 #define opt_fn_print BIT(0)
574 #define opt_fn_print_label BIT(1)
577 /*************************************************
578 * Find the name of an option *
579 *************************************************/
581 /* This function is to aid debugging. Various functions take arguments that are
582 pointer variables in the options table or in option tables for various drivers.
583 For debugging output, it is useful to be able to find the name of the option
584 which is currently being processed. This function finds it, if it exists, by
585 searching the table(s).
587 Arguments: a value that is presumed to be in the table above
588 Returns: the option name, or an empty string
592 readconf_find_option(void *p)
594 for (int i = 0; i < nelem(optionlist_config); i++)
595 if (p == optionlist_config[i].v.value) return US optionlist_config[i].name;
597 for (router_instance * r = routers; r; r = r->next)
599 router_info *ri = r->info;
600 for (int i = 0; i < *ri->options_count; i++)
602 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
603 if (p == CS (r->options_block) + ri->options[i].v.offset)
604 return US ri->options[i].name;
608 for (transport_instance * t = transports; t; t = t->next)
610 transport_info *ti = t->info;
611 for (int i = 0; i < *ti->options_count; i++)
613 optionlist * op = &ti->options[i];
614 if ((op->type & opt_mask) != opt_stringptr) continue;
615 if (p == ( op->type & opt_public
617 : CS t->options_block
630 /*************************************************
631 * Deal with an assignment to a macro *
632 *************************************************/
634 /* We have a new definition; append to the list.
637 name Name of the macro; will be copied
638 val Expansion result for the macro; will be copied
642 macro_create(const uschar * name, const uschar * val, BOOL command_line)
644 macro_item * m = store_get(sizeof(macro_item), FALSE);
646 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
648 m->command_line = command_line;
649 m->namelen = Ustrlen(name);
650 m->replen = Ustrlen(val);
651 m->name = string_copy(name);
652 m->replacement = string_copy(val);
664 /* This function is called when a line that starts with an upper case letter is
665 encountered. The argument "line" should contain a complete logical line, and
666 start with the first letter of the macro name. The macro name and the
667 replacement text are extracted and stored. Redefinition of existing,
668 non-command line, macros is permitted using '==' instead of '='.
671 s points to the start of the logical line
673 Returns: FALSE iff fatal error
677 macro_read_assignment(uschar *s)
684 while (isalnum(*s) || *s == '_')
686 if (namelen >= sizeof(name) - 1)
688 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
689 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
692 name[namelen++] = *s++;
696 Uskip_whitespace(&s);
699 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
708 Uskip_whitespace(&s);
710 /* If an existing macro of the same name was defined on the command line, we
711 just skip this definition. It's an error to attempt to redefine a macro without
712 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
713 It is also an error to define a macro whose name begins with the name of a
714 previously defined macro. This is the requirement that make using a tree
715 for macros hard; we must check all macros for the substring. Perhaps a
716 sorted list, and a bsearch, would work?
717 Note: it is documented that the other way round works. */
719 for (m = macros; m; m = m->next)
721 if (Ustrcmp(m->name, name) == 0)
723 if (!m->command_line && !redef)
725 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
726 "defined (use \"==\" if you want to redefine it)", name);
732 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
734 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
735 "a macro because previously defined macro \"%s\" is a substring",
740 /* We cannot have this test, because it is documented that a substring
741 macro is permitted (there is even an example).
743 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
744 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
745 * "a macro because it is a substring of previously defined macro \"%s\"",
750 /* Check for an overriding command-line definition. */
752 if (m && m->command_line) return TRUE;
754 /* Redefinition must refer to an existing macro. */
759 m->replen = Ustrlen(s);
760 m->replacement = string_copy(s);
764 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
769 /* We have a new definition. */
771 (void) macro_create(name, s, FALSE);
779 /* Process line for macros. The line is in big_buffer starting at offset len.
780 Expand big_buffer if needed. Handle definitions of new macros, and
781 macro expansions, rewriting the line in the buffer.
784 len Offset in buffer of start of line
785 newlen Pointer to offset of end of line, updated on return
786 macro_found Pointer to return that a macro was expanded
788 Return: pointer to first nonblank char in line
792 macros_expand(int len, int * newlen, BOOL * macro_found)
794 uschar * ss = big_buffer + len;
797 /* Find the true start of the physical line - leading spaces are always
800 Uskip_whitespace(&ss);
802 /* Process the physical line for macros. If this is the start of the logical
803 line, skip over initial text at the start of the line if it starts with an
804 upper case character followed by a sequence of name characters and an equals
805 sign, because that is the definition of a new macro, and we don't do
806 replacement therein. */
809 if (len == 0 && isupper(*s))
811 while (isalnum(*s) || *s == '_') s++;
812 if (Uskip_whitespace(&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 Uskip_whitespace(&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 Uskip_whitespace(&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 Uskip_whitespace(&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)
1174 if (isalpha(Uskip_whitespace(&s)))
1175 while (isalnum(*s) || *s == '_')
1177 if (p < len-1) name[p++] = *s;
1182 Uskip_whitespace(&s);
1189 /*************************************************
1190 * Read a time value *
1191 *************************************************/
1193 /* This function is also called from outside, to read argument
1194 time values. The format of a time value is:
1196 [<n>w][<n>d][<n>h][<n>m][<n>s]
1198 as long as at least one is present. If a format error is encountered,
1199 return a negative value. The value must be terminated by the given
1204 terminator required terminating character
1205 return_msec if TRUE, allow fractional seconds and return milliseconds
1207 Returns: the time value, or -1 on syntax error
1208 value is seconds if return_msec is FALSE
1209 value is milliseconds if return_msec is TRUE
1213 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1221 if (!isdigit(*s)) return -1;
1222 (void)sscanf(CCS s, "%d%n", &value, &count);
1227 case 'w': value *= 7;
1228 case 'd': value *= 24;
1229 case 'h': value *= 60;
1230 case 'm': value *= 60;
1235 if (!return_msec) return -1;
1236 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1238 if (*s++ != 's') return -1;
1239 yield += (int)(fraction * 1000.0);
1245 if (return_msec) value *= 1000;
1247 if (*s == terminator) return yield;
1249 /* Control never reaches here. */
1254 /*************************************************
1255 * Read a fixed point value *
1256 *************************************************/
1258 /* The value is returned *1000
1262 terminator required terminator
1264 Returns: the value, or -1 on error
1268 readconf_readfixed(const uschar *s, int terminator)
1272 if (!isdigit(*s)) return -1;
1273 (void)sscanf(CS s, "%d%n", &value, &count);
1275 yield = value * 1000;
1279 while (isdigit((*(++s))))
1281 yield += (*s - '0') * m;
1286 return (*s == terminator)? yield : (-1);
1291 /*************************************************
1292 * Find option in list *
1293 *************************************************/
1295 /* The lists are always in order, so binary chop can be used.
1298 name the option name to search for
1299 ol the first entry in the option list
1300 last one more than the offset of the last entry in the option list
1302 Returns: pointer to an option entry, or NULL if not found
1306 find_option(uschar *name, optionlist *ol, int last)
1309 while (last > first)
1311 int middle = (first + last)/2;
1312 int c = Ustrcmp(name, ol[middle].name);
1314 if (c == 0) return ol + middle;
1315 else if (c > 0) first = middle + 1;
1323 /*************************************************
1324 * Find a set flag in option list *
1325 *************************************************/
1327 /* Because some versions of Unix make no restrictions on the values of uids and
1328 gids (even negative ones), we cannot represent "unset" by a special value.
1329 There is therefore a separate boolean variable for each one indicating whether
1330 a value is set or not. This function returns a pointer to the boolean, given
1331 the original option name. It is a major disaster if the flag cannot be found.
1334 name the name of the uid or gid option
1335 oltop points to the start of the relevant option list
1336 last one more than the offset of the last item in the option list
1337 data_block NULL when reading main options => data values in the option
1338 list are absolute addresses; otherwise they are byte offsets
1339 in data_block (used for driver options)
1341 Returns: a pointer to the boolean flag.
1345 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1349 sprintf(CS name2, "*set_%.50s", name);
1350 if (!(ol = find_option(name2, oltop, last)))
1351 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1352 "Exim internal error: missing set flag for %s", name);
1354 ? (BOOL *)(US data_block + ol->v.offset) : (BOOL *)ol->v.value;
1360 /*************************************************
1361 * Output extra characters message and die *
1362 *************************************************/
1364 /* Called when an option line has junk on the end. Sometimes this is because
1365 the sysadmin thinks comments are permitted.
1368 s points to the extra characters
1369 t1..t3 strings to insert in the log message
1371 Returns: doesn't return; dies
1375 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1377 uschar *comment = US"";
1378 if (*s == '#') comment = US" (# is comment only at line start)";
1379 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1380 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1385 /*************************************************
1386 * Read rewrite information *
1387 *************************************************/
1389 /* Each line of rewrite information contains:
1391 . A complete address in the form user@domain, possibly with
1392 leading * for each part; or alternatively, a regex.
1394 . A replacement string (which will be expanded).
1396 . An optional sequence of one-letter flags, indicating which
1397 headers etc. to apply this rule to.
1399 All this is decoded and placed into a control block. The OR of the flags is
1400 maintained in a common word.
1403 p points to the string that makes up the rule
1404 existflags points to the overall flag word
1405 isglobal TRUE if reading global rewrite rules
1407 Returns: the control block for the parsed rule.
1410 static rewrite_rule *
1411 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1413 rewrite_rule *next = store_get(sizeof(rewrite_rule), FALSE);
1416 next->key = string_dequote(&p);
1418 Uskip_whitespace(&p);
1420 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1421 "missing rewrite replacement string");
1424 next->replacement = string_dequote(&p);
1426 while (*p) switch (*p++)
1428 case ' ': case '\t': break;
1430 case 'q': next->flags |= rewrite_quit; break;
1431 case 'w': next->flags |= rewrite_whole; break;
1433 case 'h': next->flags |= rewrite_all_headers; break;
1434 case 's': next->flags |= rewrite_sender; break;
1435 case 'f': next->flags |= rewrite_from; break;
1436 case 't': next->flags |= rewrite_to; break;
1437 case 'c': next->flags |= rewrite_cc; break;
1438 case 'b': next->flags |= rewrite_bcc; break;
1439 case 'r': next->flags |= rewrite_replyto; break;
1441 case 'E': next->flags |= rewrite_all_envelope; break;
1442 case 'F': next->flags |= rewrite_envfrom; break;
1443 case 'T': next->flags |= rewrite_envto; break;
1445 case 'Q': next->flags |= rewrite_qualify; break;
1446 case 'R': next->flags |= rewrite_repeat; break;
1449 next->flags |= rewrite_smtp;
1450 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1451 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1452 "rewrite rule has the S flag but is not a regular expression");
1456 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1457 "unknown rewrite flag character '%c' "
1458 "(could be missing quotes round replacement item)", p[-1]);
1462 /* If no action flags are set, set all the "normal" rewrites. */
1464 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1465 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1467 /* Remember which exist, for optimization, and return the rule */
1469 *existflags |= next->flags;
1476 /*************************************************
1477 * Read global rewrite information *
1478 *************************************************/
1480 /* Each line is a single rewrite rule; it is parsed into a control block
1481 by readconf_one_rewrite(), and its flags are ORed into the global flag
1482 word rewrite_existflags. */
1485 readconf_rewrites(void)
1487 rewrite_rule **chain = &global_rewrite_rules;
1490 while ((p = get_config_line()) != NULL)
1492 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1494 chain = &(next->next);
1500 /*************************************************
1502 *************************************************/
1504 /* Strings are read into the normal store pool. As long we aren't too
1505 near the end of the current block, the string will just use what is necessary
1506 on the top of the stacking pool, because string_cat() uses the extension
1510 s the rest of the input line
1511 name the option name (for errors)
1513 Returns: pointer to the string
1517 read_string(const uschar *s, const uschar *name)
1522 if (*s != '\"') return string_copy(s);
1525 yield = string_dequote(&s);
1527 if (s == ss+1 || s[-1] != '\"')
1528 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1529 "missing quote at end of string value for %s", name);
1531 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1537 /*************************************************
1538 * Custom-handler options *
1539 *************************************************/
1541 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags)
1543 if (flags & opt_fn_print)
1545 if (flags & opt_fn_print_label) printf("%s = ", name);
1546 printf("%s\n", smtp_receive_timeout_s
1547 ? string_printing2(smtp_receive_timeout_s, FALSE)
1548 : readconf_printtime(smtp_receive_timeout));
1550 else if (*str == '$')
1551 smtp_receive_timeout_s = string_copy(str);
1554 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1555 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1556 if (smtp_receive_timeout < 0)
1557 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1562 /*************************************************
1563 * Handle option line *
1564 *************************************************/
1566 /* This function is called from several places to process a line containing the
1567 setting of an option. The first argument is the line to be decoded; it has been
1568 checked not to be empty and not to start with '#'. Trailing newlines and white
1569 space have been removed. The second argument is a pointer to the list of
1570 variable names that are to be recognized, together with their types and
1571 locations, and the third argument gives the number of entries in the list.
1573 The fourth argument is a pointer to a data block. If it is NULL, then the data
1574 values in the options list are absolute addresses. Otherwise, they are byte
1575 offsets in the data block.
1577 String option data may continue onto several lines; this function reads further
1578 data from config_file if necessary.
1580 The yield of this function is normally zero. If a string continues onto
1581 multiple lines, then the data value is permitted to be followed by a comma
1582 or a semicolon (for use in drivers) and the yield is that character.
1585 buffer contains the configuration line to be handled
1586 oltop points to the start of the relevant option list
1587 last one more than the offset of the last item in the option list
1588 data_block NULL when reading main options => data values in the option
1589 list are absolute addresses; otherwise they are byte offsets
1590 in data_block when they have opt_public set; otherwise
1591 they are byte offsets in data_block->options_block.
1592 unknown_txt format string to use in panic message for unknown option;
1593 must contain %s for option name
1594 if given as NULL, don't panic on unknown option
1596 Returns: TRUE if an option was read successfully,
1597 FALSE false for an unknown option if unknown_txt == NULL,
1598 otherwise panic and die on an unknown option
1602 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1603 void *data_block, uschar *unknown_txt)
1607 int count, type, value;
1611 BOOL boolvalue = TRUE;
1612 BOOL freesptr = TRUE;
1613 optionlist *ol, *ol2;
1617 uschar *inttype = US"";
1620 uschar **str_target;
1624 /* There may be leading spaces; thereafter, we expect an option name starting
1627 while (isspace(*s)) s++;
1629 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1631 /* Read the name of the option, and skip any subsequent white space. If
1632 it turns out that what we read was "hide", set the flag indicating that
1633 this is a secure option, and loop to read the next word. */
1635 for (int n = 0; n < 2; n++)
1637 while (isalnum(*s) || *s == '_')
1639 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1643 while (isspace(*s)) s++;
1644 if (Ustrcmp(name, "hide") != 0) break;
1645 issecure = opt_secure;
1649 /* Deal with "no_" or "not_" here for booleans */
1651 if (Ustrncmp(name, "no_", 3) == 0)
1657 if (Ustrncmp(name, "not_", 4) == 0)
1663 /* Search the list for the given name. A non-existent name, or an option that
1664 is set twice, is a disaster. */
1666 if (!(ol = find_option(name + offset, oltop, last)))
1668 if (!unknown_txt) return FALSE;
1669 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1672 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1673 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1674 "\"%s\" option set for the second time", name);
1676 ol->type |= opt_set | issecure;
1677 type = ol->type & opt_mask;
1679 /* Types with data values must be followed by '='; the "no[t]_" prefix
1680 applies only to boolean values. */
1682 if (type < opt_bool || type > opt_bool_last)
1685 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1686 "negation prefix applied to a non-boolean option");
1688 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1689 "unexpected end of line (data missing) after %s", name);
1691 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1694 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1695 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1696 ultimately expands to one of those values. */
1698 else if (*s && (offset != 0 || *s != '='))
1699 extra_chars_error(s, US"boolean option ", name, US"");
1701 /* Skip white space after = */
1703 if (*s == '=') while (isspace((*(++s))));
1705 /* If there is a data block and the opt_public flag is not set, change
1706 the data block pointer to the private options block. */
1708 if (data_block && !(ol->type & opt_public))
1709 data_block = (void *)(((driver_instance *)data_block)->options_block);
1711 /* Now get the data according to the type. */
1715 /* If a string value is not enclosed in quotes, it consists of
1716 the rest of the current line, verbatim. Otherwise, string escapes
1719 A transport is specified as a string, which is then looked up in the
1720 list of transports. A search type is specified as one of a number of
1723 A set or rewrite rules for a driver is specified as a string, which is
1724 then parsed into a suitable chain of control blocks.
1726 Uids and gids are specified as strings which are then looked up in the
1727 passwd file. Lists of uids and gids are similarly specified as colon-
1728 separated strings. */
1733 case opt_expand_uid:
1734 case opt_expand_gid:
1739 reset_point = store_mark();
1740 sptr = read_string(s, name);
1742 /* Having read a string, we now have several different ways of using it,
1743 depending on the data type, so do another switch. If keeping the actual
1744 string is not required (because it is interpreted), freesptr is set TRUE,
1745 and at the end we reset the pool. */
1749 /* If this was a string, set the variable to point to the new string,
1750 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1751 rules, we still keep the string (for printing), and parse the rules into a
1752 control block and flags word. */
1755 str_target = data_block ? USS (US data_block + ol->v.offset)
1757 if (ol->type & opt_rep_con)
1759 uschar * saved_condition;
1760 /* We already have a condition, we're conducting a crude hack to let
1761 multiple condition rules be chained together, despite storing them in
1763 *str_target = string_copy_perm( (saved_condition = *str_target)
1764 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1765 saved_condition, sptr)
1768 /* TODO(pdp): there is a memory leak here and just below
1769 when we set 3 or more conditions; I still don't
1770 understand the store mechanism enough to know
1771 what's the safe way to free content from an earlier store.
1772 AFAICT, stores stack, so freeing an early stored item also stores
1773 all data alloc'd after it. If we knew conditions were adjacent,
1774 we could survive that, but we don't. So I *think* we need to take
1775 another bit from opt_type to indicate "malloced"; this seems like
1776 quite a hack, especially for this one case. It also means that
1777 we can't ever reclaim the store from the *first* condition.
1779 Because we only do this once, near process start-up, I'm prepared to
1780 let this slide for the time being, even though it rankles. */
1782 else if (ol->type & opt_rep_str)
1785 Ustrncmp(name, "headers_add", 11) == 0 ? '\n'
1786 : Ustrncmp(name, "set", 3) == 0 ? ';'
1788 int sep_i = -(int)sep_o;
1789 const uschar * list = sptr;
1791 gstring * list_o = NULL;
1795 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1796 list_o = string_cat(list_o, *str_target);
1799 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1800 list_o = string_append_listele(list_o, sep_o, s);
1803 *str_target = string_copy_perm(string_from_gstring(list_o), FALSE);
1814 *USS (US data_block + ol->v.offset) = sptr;
1816 *USS ol->v.value = sptr;
1818 if (type == opt_rewrite)
1823 rewrite_rule **chain;
1826 sprintf(CS name2, "*%.50s_rules", name);
1827 ol2 = find_option(name2, oltop, last);
1828 sprintf(CS name2, "*%.50s_flags", name);
1829 ol3 = find_option(name2, oltop, last);
1832 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1833 "rewrite rules not available for driver");
1837 chain = (rewrite_rule **)(US data_block + ol2->v.offset);
1838 flagptr = (int *)(US data_block + ol3->v.offset);
1842 chain = (rewrite_rule **)ol2->v.value;
1843 flagptr = (int *)ol3->v.value;
1846 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1848 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1850 chain = &(next->next);
1853 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1854 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1855 "non-header rewrite - not allowed at transport time -");
1859 /* If it was an expanded uid, see if there is any expansion to be
1860 done by checking for the presence of a $ character. If there is, save it
1861 in the corresponding *expand_user option field. Otherwise, fall through
1862 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1865 case opt_expand_uid:
1866 sprintf(CS name2, "*expand_%.50s", name);
1867 if ((ol2 = find_option(name2, oltop, last)))
1869 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1872 *(USS(US data_block + ol2->v.offset)) = ss;
1874 *(USS ol2->v.value) = ss;
1878 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1884 /* Look up a fixed uid, and also make use of the corresponding gid
1885 if a passwd entry is returned and the gid has not been set. */
1888 if (!route_finduser(sptr, &pw, &uid))
1889 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1891 *(uid_t *)(US data_block + ol->v.offset) = uid;
1893 *(uid_t *)ol->v.value = uid;
1895 /* Set the flag indicating a fixed value is set */
1897 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1899 /* Handle matching gid if we have a passwd entry: done by finding the
1900 same name with terminating "user" changed to "group"; if not found,
1901 ignore. Also ignore if the value is already set. */
1903 if (pw == NULL) break;
1904 Ustrcpy(name+Ustrlen(name)-4, US"group");
1905 ol2 = find_option(name, oltop, last);
1906 if (ol2 && ((ol2->type & opt_mask) == opt_gid ||
1907 (ol2->type & opt_mask) == opt_expand_gid))
1909 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1913 *((gid_t *)(US data_block + ol2->v.offset)) = pw->pw_gid;
1915 *((gid_t *)ol2->v.value) = pw->pw_gid;
1921 /* If it was an expanded gid, see if there is any expansion to be
1922 done by checking for the presence of a $ character. If there is, save it
1923 in the corresponding *expand_user option field. Otherwise, fall through
1924 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1927 case opt_expand_gid:
1928 sprintf(CS name2, "*expand_%.50s", name);
1929 if ((ol2 = find_option(name2, oltop, last)))
1931 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1934 *(USS(US data_block + ol2->v.offset)) = ss;
1936 *(USS ol2->v.value) = ss;
1940 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1946 /* Handle freestanding gid */
1949 if (!route_findgroup(sptr, &gid))
1950 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1952 *((gid_t *)(US data_block + ol->v.offset)) = gid;
1954 *((gid_t *)ol->v.value) = gid;
1955 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1958 /* If it was a uid list, look up each individual entry, and build
1959 a vector of uids, with a count in the first element. Put the vector
1960 in malloc store so we can free the string. (We are reading into
1961 permanent store already.) */
1969 const uschar *op = expand_string (sptr);
1972 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1973 name, expand_string_message);
1976 if (*p != 0) count++;
1977 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1978 list = store_malloc(count*sizeof(uid_t));
1979 list[ptr++] = (uid_t)(count - 1);
1982 *((uid_t **)(US data_block + ol->v.offset)) = list;
1984 *((uid_t **)ol->v.value) = list;
1990 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1991 if (!route_finduser(big_buffer, NULL, &uid))
1992 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1999 /* If it was a gid list, look up each individual entry, and build
2000 a vector of gids, with a count in the first element. Put the vector
2001 in malloc store so we can free the string. (We are reading into permanent
2010 const uschar *op = expand_string (sptr);
2013 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2014 name, expand_string_message);
2017 if (*p != 0) count++;
2018 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2019 list = store_malloc(count*sizeof(gid_t));
2020 list[ptr++] = (gid_t)(count - 1);
2023 *((gid_t **)(US data_block + ol->v.offset)) = list;
2025 *((gid_t **)ol->v.value) = list;
2031 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2032 if (!route_findgroup(big_buffer, &gid))
2033 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2041 /* Release store if the value of the string doesn't need to be kept. */
2043 if (freesptr) reset_point = store_reset(reset_point);
2046 /* Expanded boolean: if no characters follow, or if there are no dollar
2047 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2048 save the string for later expansion in the alternate place. */
2050 case opt_expand_bool:
2051 if (*s && Ustrchr(s, '$') != 0)
2053 sprintf(CS name2, "*expand_%.50s", name);
2054 if ((ol2 = find_option(name2, oltop, last)))
2056 reset_point = store_mark();
2057 sptr = read_string(s, name);
2059 *(USS(US data_block + ol2->v.offset)) = sptr;
2061 *(USS ol2->v.value) = sptr;
2068 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2069 look for yes/not/true/false. Some booleans are stored in a single bit in
2070 a single int. There's a special fudge for verify settings; without a suffix
2071 they set both xx_sender and xx_recipient. The table points to the sender
2072 value; search subsequently for the recipient. There's another special case:
2073 opt_bool_set also notes when a boolean has been set. */
2077 case opt_bool_verify:
2081 s = readconf_readname(name2, 64, s);
2082 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2084 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2086 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2087 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2088 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2089 US"for boolean option ", name);
2092 /* Handle single-bit type. */
2094 if (type == opt_bit)
2096 int bit = 1 << ((ol->type >> 16) & 31);
2097 int * ptr = data_block
2098 ? (int *)(US data_block + ol->v.offset)
2099 : (int *)ol->v.value;
2100 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2104 /* Handle full BOOL types */
2107 *((BOOL *)(US data_block + ol->v.offset)) = boolvalue;
2109 *((BOOL *)ol->v.value) = boolvalue;
2113 if (type == opt_bool_verify)
2115 sprintf(CS name2, "%.50s_recipient", name + offset);
2116 if ((ol2 = find_option(name2, oltop, last)))
2118 *((BOOL *)(US data_block + ol2->v.offset)) = boolvalue;
2120 *((BOOL *)ol2->v.value) = boolvalue;
2123 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2125 else if (type == opt_bool_set)
2127 sprintf(CS name2, "*set_%.50s", name + offset);
2128 if ((ol2 = find_option(name2, oltop, last)))
2130 *((BOOL *)(US data_block + ol2->v.offset)) = TRUE;
2132 *((BOOL *)ol2->v.value) = TRUE;
2140 inttype = US"octal ";
2142 /* Integer: a simple(ish) case; allow octal and hex formats, and
2143 suffixes K, M, G, and T. The different types affect output, not input. */
2152 lvalue = strtol(CS s, CSS &endptr, intbase);
2155 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2158 if (errno != ERANGE && *endptr)
2160 uschar * mp = US"TtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2162 if ((mp = Ustrchr(mp, *endptr)))
2167 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2178 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2179 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2180 "absolute value of integer \"%s\" is too large (overflow)", s);
2182 while (isspace(*endptr)) endptr++;
2184 extra_chars_error(endptr, inttype, US"integer value for ", name);
2186 value = (int)lvalue;
2190 *(int *)(US data_block + ol->v.offset) = value;
2192 *(int *)ol->v.value = value;
2195 /* Integer held in K: again, allow formats and suffixes as above. */
2201 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2204 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2207 if (errno != ERANGE && *endptr)
2209 uschar * mp = US"ZzEePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2211 if ((mp = Ustrchr(mp, *endptr)))
2216 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2225 lvalue = (lvalue + 512)/1024;
2228 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2229 "absolute value of integer \"%s\" is too large (overflow)", s);
2231 while (isspace(*endptr)) endptr++;
2233 extra_chars_error(endptr, inttype, US"integer value for ", name);
2236 *(int_eximarith_t *)(US data_block + ol->v.offset) = lvalue;
2238 *(int_eximarith_t *)ol->v.value = lvalue;
2242 /* Fixed-point number: held to 3 decimal places. */
2245 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2246 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2247 "fixed-point number expected for %s", name);
2249 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2250 "integer \"%s\" is too large (overflow)", s);
2254 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2255 "integer \"%s\" is too large (overflow)", s);
2257 /* We get a coverity error here for using count, as it derived
2258 from the tainted buffer pointed to by s, as parsed by sscanf().
2259 By the definition of sscanf we must be accessing between start
2260 and end of s (assuming it is nul-terminated...) so ignore the error. */
2261 /* coverity[tainted_data] */
2262 if (s[count] == '.')
2265 while (isdigit(s[++count]))
2267 value += (s[count] - '0') * d;
2272 while (isspace(s[count])) count++;
2275 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2278 *((int *)(US data_block + ol->v.offset)) = value;
2280 *((int *)ol->v.value) = value;
2283 /* There's a special routine to read time values. */
2286 value = readconf_readtime(s, 0, FALSE);
2288 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2291 *((int *)(US data_block + ol->v.offset)) = value;
2293 *((int *)ol->v.value) = value;
2296 /* A time list is a list of colon-separated times, with the first
2297 element holding the size of the list and the second the number of
2303 int * list = data_block
2304 ? (int *)(US data_block + ol->v.offset)
2305 : (int *)ol->v.value;
2307 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2310 uschar *snext = Ustrchr(s, ':');
2314 while (ss > s && isspace(ss[-1])) ss--;
2317 value = readconf_readtime(s, terminator, FALSE);
2319 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2321 if (count > 1 && value <= list[count])
2322 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2323 "time value out of order for %s", name);
2324 list[count+1] = value;
2325 if (snext == NULL) break;
2327 while (isspace(*s)) s++;
2330 if (count > list[0] - 2)
2331 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2333 if (count > 0 && list[2] == 0) count = 0;
2340 void (*fn)() = ol->v.fn;
2351 /*************************************************
2352 * Print a time value *
2353 *************************************************/
2356 Argument: a time value in seconds
2357 Returns: pointer to a fixed buffer containing the time as a string,
2358 in readconf_readtime() format
2362 readconf_printtime(int t)
2365 uschar *p = time_buffer;
2382 if (w > 0) p += sprintf(CS p, "%dw", w);
2383 if (d > 0) p += sprintf(CS p, "%dd", d);
2384 if (h > 0) p += sprintf(CS p, "%dh", h);
2385 if (m > 0) p += sprintf(CS p, "%dm", m);
2386 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2393 /*************************************************
2394 * Print an individual option value *
2395 *************************************************/
2397 /* This is used by the -bP option, so prints to the standard output.
2398 The entire options list is passed in as an argument, because some options come
2399 in pairs - typically uid/gid settings, which can either be explicit numerical
2400 values, or strings to be expanded later. If the numerical value is unset,
2401 search for "*expand_<name>" to see if there is a string equivalent.
2404 ol option entry, or NULL for an unknown option
2406 options_block NULL for main configuration options; otherwise points to
2407 a driver block; if the option doesn't have opt_public
2408 set, then options_block->options_block is where the item
2410 oltop points to the option list in which ol exists
2411 last one more than the offset of the last entry in optop
2412 no_labels do not show "foo = " at the start.
2414 Returns: boolean success
2418 print_ol(optionlist *ol, uschar *name, void *options_block,
2419 optionlist *oltop, int last, BOOL no_labels)
2432 printf("%s is not a known option\n", name);
2436 /* Non-admin callers cannot see options that have been flagged secure by the
2439 if (!f.admin_user && ol->type & opt_secure)
2442 printf("%s\n", CCS hidden);
2444 printf("%s = %s\n", name, CCS hidden);
2448 /* Else show the value of the option */
2450 value = ol->v.value;
2453 if (!(ol->type & opt_public))
2454 options_block = (void *)(((driver_instance *)options_block)->options_block);
2455 value = (void *)(US options_block + (long int)value);
2458 switch(ol->type & opt_mask)
2461 case opt_rewrite: /* Show the text value */
2463 if (!no_labels) printf("%s = ", name);
2464 printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2468 if (!no_labels) printf("%s = ", name);
2469 printf("%d\n", *((int *)value));
2474 int x = *((int *)value);
2475 if (x != 0 && (x & 1023) == 0)
2479 if ((x & 1023) == 0)
2484 if (!no_labels) printf("%s = ", name);
2485 printf("%d%c\n", x, c);
2489 if (!no_labels) printf("%s = ", name);
2497 int_eximarith_t x = *((int_eximarith_t *)value);
2498 if (!no_labels) printf("%s = ", name);
2499 if (x == 0) printf("0\n");
2500 else if ((x & ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH "T\n", x >> 30);
2501 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2502 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2503 else printf(PR_EXIM_ARITH "K\n", x);
2508 if (!no_labels) printf("%s = ", name);
2509 printf("%#o\n", *((int *)value));
2512 /* Can be negative only when "unset", in which case integer */
2516 int x = *((int *)value);
2519 if (x < 0) printf("%s =\n", name); else
2521 if (!no_labels) printf("%s = ", name);
2522 printf("%d.", x/1000);
2535 /* If the numerical value is unset, try for the string value */
2537 case opt_expand_uid:
2538 if (! *get_set_flag(name, oltop, last, options_block))
2540 sprintf(CS name2, "*expand_%.50s", name);
2541 if ((ol2 = find_option(name2, oltop, last)))
2544 s = *USS (US options_block + ol2->v.offset);
2546 s = *USS ol2->v.value;
2547 if (!no_labels) printf("%s = ", name);
2548 printf("%s\n", s ? string_printing(s) : US"");
2553 /* Else fall through */
2556 if (!no_labels) printf("%s = ", name);
2557 if (! *get_set_flag(name, oltop, last, options_block))
2560 if ((pw = getpwuid(*((uid_t *)value))))
2561 printf("%s\n", pw->pw_name);
2563 printf("%ld\n", (long int)(*((uid_t *)value)));
2566 /* If the numerical value is unset, try for the string value */
2568 case opt_expand_gid:
2569 if (! *get_set_flag(name, oltop, last, options_block))
2571 sprintf(CS name2, "*expand_%.50s", name);
2572 if ( (ol2 = find_option(name2, oltop, last))
2573 && (ol2->type & opt_mask) == opt_stringptr)
2576 s = *USS (US options_block + ol2->v.offset);
2578 s = *USS ol2->v.value;
2579 if (!no_labels) printf("%s = ", name);
2580 printf("%s\n", s ? string_printing(s) : US"");
2585 /* Else fall through */
2588 if (!no_labels) printf("%s = ", name);
2589 if (! *get_set_flag(name, oltop, last, options_block))
2592 if ((gr = getgrgid(*((int *)value))))
2593 printf("%s\n", gr->gr_name);
2595 printf("%ld\n", (long int)(*((int *)value)));
2599 uidlist = *((uid_t **)value);
2600 if (!no_labels) printf("%s =", name);
2603 uschar sep = no_labels ? '\0' : ' ';
2604 for (int i = 1; i <= (int)(uidlist[0]); i++)
2606 uschar *name = NULL;
2607 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2608 if (sep != '\0') printf("%c", sep);
2609 if (name) printf("%s", name);
2610 else printf("%ld", (long int)(uidlist[i]));
2618 gidlist = *((gid_t **)value);
2619 if (!no_labels) printf("%s =", name);
2622 uschar sep = no_labels ? '\0' : ' ';
2623 for (int i = 1; i <= (int)(gidlist[0]); i++)
2625 uschar *name = NULL;
2626 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2627 if (sep != '\0') printf("%c", sep);
2628 if (name) printf("%s", name);
2629 else printf("%ld", (long int)(gidlist[i]));
2637 if (!no_labels) printf("%s = ", name);
2638 printf("%s\n", readconf_printtime(*((int *)value)));
2643 int *list = (int *)value;
2644 if (!no_labels) printf("%s = ", name);
2645 for (int i = 0; i < list[1]; i++)
2646 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2652 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2656 case opt_expand_bool:
2657 sprintf(CS name2, "*expand_%.50s", name);
2658 if ((ol2 = find_option(name2, oltop, last)) && ol2->v.value)
2661 s = *USS (US options_block + ol2->v.offset);
2663 s = *USS ol2->v.value;
2666 if (!no_labels) printf("%s = ", name);
2667 printf("%s\n", string_printing(s));
2670 /* s == NULL => string not set; fall through */
2676 case opt_bool_verify:
2678 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2682 ol->v.fn(name, NULL, no_labels ? opt_fn_print : opt_fn_print|opt_fn_print_label);
2690 /*************************************************
2691 * Print value from main configuration *
2692 *************************************************/
2694 /* This function, called as a result of encountering the -bP option,
2695 causes the value of any main configuration variable to be output if the
2696 second argument is NULL. There are some special values:
2698 all print all main configuration options
2699 config_file print the name of the configuration file
2700 (configure_file will still work, for backward
2702 routers print the routers' configurations
2703 transports print the transports' configuration
2704 authenticators print the authenticators' configuration
2705 macros print the macros' configuration
2706 router_list print a list of router names
2707 transport_list print a list of transport names
2708 authenticator_list print a list of authentication mechanism names
2709 macro_list print a list of macro names
2710 +name print a named list item
2711 local_scan print the local_scan options
2712 config print the configuration as it is parsed
2713 environment print the used execution environment
2715 If the second argument is not NULL, it must be one of "router", "transport",
2716 "authenticator" or "macro" in which case the first argument identifies the
2717 driver whose options are to be printed.
2720 name option name if type == NULL; else driver name
2721 type NULL or driver type name, as described above
2722 no_labels avoid the "foo = " at the start of an item
2724 Returns: Boolean success
2728 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2730 BOOL names_only = FALSE;
2731 optionlist *ol2 = NULL;
2732 driver_instance *d = NULL;
2741 static uschar *types[] = { US"address", US"domain", US"host",
2743 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2744 &hostlist_anchor, &localpartlist_anchor };
2746 for (int i = 0; i < 4; i++)
2747 if ((t = tree_search(*(anchors[i]), name+1)))
2749 namedlist_block * nb = t->data.ptr;
2750 const uschar * s = nb->hide ? hidden : nb->string;
2753 printf("%s\n", CCS s);
2755 printf("%slist %s = %s\n", types[i], name+1, CCS s);
2759 printf("no address, domain, host, or local part list called \"%s\" "
2760 "exists\n", name+1);
2765 if ( Ustrcmp(name, "configure_file") == 0
2766 || Ustrcmp(name, "config_file") == 0)
2768 printf("%s\n", CS config_main_filename);
2772 if (Ustrcmp(name, "all") == 0)
2774 for (optionlist * ol = optionlist_config;
2775 ol < optionlist_config + nelem(optionlist_config); ol++)
2776 if (!(ol->type & opt_hidden))
2777 (void) print_ol(ol, US ol->name, NULL,
2778 optionlist_config, nelem(optionlist_config),
2783 if (Ustrcmp(name, "local_scan") == 0)
2785 #ifndef LOCAL_SCAN_HAS_OPTIONS
2786 printf("local_scan() options are not supported\n");
2789 for (optionlist * ol = local_scan_options;
2790 ol < local_scan_options + local_scan_options_count; ol++)
2791 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2792 local_scan_options_count, no_labels);
2797 if (Ustrcmp(name, "config") == 0)
2799 print_config(f.admin_user, no_labels);
2803 if (Ustrcmp(name, "routers") == 0)
2808 else if (Ustrcmp(name, "transports") == 0)
2810 type = US"transport";
2813 else if (Ustrcmp(name, "authenticators") == 0)
2815 type = US"authenticator";
2818 else if (Ustrcmp(name, "macros") == 0)
2823 else if (Ustrcmp(name, "router_list") == 0)
2829 else if (Ustrcmp(name, "transport_list") == 0)
2831 type = US"transport";
2835 else if (Ustrcmp(name, "authenticator_list") == 0)
2837 type = US"authenticator";
2841 else if (Ustrcmp(name, "macro_list") == 0)
2847 else if (Ustrcmp(name, "environment") == 0)
2852 for (p = USS environ; *p; p++) ;
2853 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2855 for (p = USS environ; *p; p++)
2858 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2866 return print_ol(find_option(name,
2867 optionlist_config, nelem(optionlist_config)),
2868 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2871 /* Handle the options for a router or transport. Skip options that are flagged
2872 as hidden. Some of these are options with names starting with '*', used for
2873 internal alternative representations of other options (which the printing
2874 function will sort out). Others are synonyms kept for backward compatibility.
2877 if (Ustrcmp(type, "router") == 0)
2879 d = (driver_instance *)routers;
2880 ol2 = optionlist_routers;
2881 size = optionlist_routers_size;
2883 else if (Ustrcmp(type, "transport") == 0)
2885 d = (driver_instance *)transports;
2886 ol2 = optionlist_transports;
2887 size = optionlist_transports_size;
2889 else if (Ustrcmp(type, "authenticator") == 0)
2891 d = (driver_instance *)auths;
2892 ol2 = optionlist_auths;
2893 size = optionlist_auths_size;
2896 else if (Ustrcmp(type, "macro") == 0)
2898 /* People store passwords in macros and they were previously not available
2899 for printing. So we have an admin_users restriction. */
2902 fprintf(stderr, "exim: permission denied\n");
2905 for (macro_item * m = macros; m; m = m->next)
2906 if (!name || Ustrcmp(name, m->name) == 0)
2909 printf("%s\n", CS m->name);
2911 printf("%s\n", CS m->replacement);
2913 printf("%s=%s\n", CS m->name, CS m->replacement);
2917 if (!name) return TRUE;
2919 printf("%s %s not found\n", type, name);
2925 for (; d; d = d->next) printf("%s\n", CS d->name);
2929 /* Either search for a given driver, or print all of them */
2931 for (; d; d = d->next)
2935 printf("\n%s %s:\n", d->name, type);
2936 else if (Ustrcmp(d->name, name) != 0) continue;
2938 for (optionlist * ol = ol2; ol < ol2 + size; ol++)
2939 if (!(ol->type & opt_hidden))
2940 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2942 for (optionlist * ol = d->info->options;
2943 ol < d->info->options + *(d->info->options_count); ol++)
2944 if (!(ol->type & opt_hidden))
2945 rc |= print_ol(ol, US ol->name, d, d->info->options,
2946 *d->info->options_count, no_labels);
2948 if (name) return rc;
2950 if (!name) return TRUE;
2952 printf("%s %s not found\n", type, name);
2958 /*************************************************
2959 * Read a named list item *
2960 *************************************************/
2962 /* This function reads a name and a list (i.e. string). The name is used to
2963 save the list in a tree, sorted by its name. Each entry also has a number,
2964 which can be used for caching tests, but if the string contains any expansion
2965 items other than $key, the number is set negative to inhibit caching. This
2966 mechanism is used for domain, host, and address lists that are referenced by
2970 anchorp points to the tree anchor
2971 numberp points to the current number for this tree
2972 max the maximum number permitted
2973 s the text of the option line, starting immediately after the name
2975 tname the name of the list type, for messages
2976 hide do not output value on "-bP"
2982 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2983 uschar *tname, BOOL hide)
2985 BOOL forcecache = FALSE;
2988 namedlist_block * nb = store_get(sizeof(namedlist_block), FALSE);
2990 if (Ustrncmp(s, "_cache", 6) == 0)
2997 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2999 if (*numberp >= max)
3000 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3003 Uskip_whitespace(&s);
3005 while (isalnum(*s) || *s == '_') s++;
3006 t = store_get(sizeof(tree_node) + s-ss, is_tainted(ss));
3007 Ustrncpy(t->name, ss, s-ss);
3009 Uskip_whitespace(&s);
3011 if (!tree_insertnode(anchorp, t))
3012 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3013 "duplicate name \"%s\" for a named %s", t->name, tname);
3016 nb->number = *numberp;
3020 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3021 "missing '=' after \"%s\"", t->name);
3022 Uskip_whitespace(&s);
3023 nb->string = read_string(s, t->name);
3024 nb->cache_data = NULL;
3026 /* Check the string for any expansions; if any are found, mark this list
3027 uncacheable unless the user has explicited forced caching. */
3029 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3035 /*************************************************
3036 * Unpick data for a rate limit *
3037 *************************************************/
3039 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3043 s string, in the form t,b,f,l
3044 where t is the threshold (integer)
3045 b is the initial delay (time)
3046 f is the multiplicative factor (fixed point)
3047 k is the maximum time (time)
3048 threshold where to store threshold
3049 base where to store base in milliseconds
3050 factor where to store factor in milliseconds
3051 limit where to store limit
3053 Returns: nothing (panics on error)
3057 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3060 uschar bstring[16], lstring[16];
3062 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3063 factor, lstring) == 4)
3065 *base = readconf_readtime(bstring, 0, TRUE);
3066 *limit = readconf_readtime(lstring, 0, TRUE);
3067 if (*base >= 0 && *limit >= 0) return;
3069 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3075 /*************************************************
3076 * Read main configuration options *
3077 *************************************************/
3079 /* This function is the first to be called for configuration reading. It
3080 opens the configuration file and reads general configuration settings until
3081 it reaches the end of the configuration section. The file is then left open so
3082 that the remaining configuration data can subsequently be read if needed for
3085 The configuration file must be owned either by root or exim, and be writeable
3086 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3087 in the config file, so the test is done on the compiled in values. A slight
3088 anomaly, to be carefully documented.
3090 The name of the configuration file is taken from a list that is included in the
3091 binary of Exim. It can be altered from the command line, but if that is done,
3092 root privilege is immediately withdrawn unless the caller is root or exim.
3093 The first file on the list that exists is used.
3095 For use on multiple systems that share file systems, first look for a
3096 configuration file whose name has the current node name on the end. If that is
3097 not found, try the generic name. For really contorted configurations, that run
3098 multiple Exims with different uid settings, first try adding the effective uid
3099 before the node name. These complications are going to waste resources on most
3100 systems. Therefore they are available only when requested by compile-time
3104 readconf_main(BOOL nowarn)
3107 struct stat statbuf;
3108 uschar *s, *filename;
3109 const uschar *list = config_main_filelist;
3111 /* Loop through the possible file names */
3113 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3116 /* Cut out all the fancy processing unless specifically wanted */
3118 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3119 uschar *suffix = filename + Ustrlen(filename);
3121 /* Try for the node-specific file if a node name exists */
3123 #ifdef CONFIGURE_FILE_USE_NODE
3125 if (uname(&uts) >= 0)
3127 #ifdef CONFIGURE_FILE_USE_EUID
3128 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3129 config_file = Ufopen(filename, "rb");
3130 if (config_file == NULL)
3131 #endif /* CONFIGURE_FILE_USE_EUID */
3133 sprintf(CS suffix, ".%.256s", uts.nodename);
3134 config_file = Ufopen(filename, "rb");
3137 #endif /* CONFIGURE_FILE_USE_NODE */
3139 /* Otherwise, try the generic name, possibly with the euid added */
3141 #ifdef CONFIGURE_FILE_USE_EUID
3142 if (config_file == NULL)
3144 sprintf(CS suffix, ".%ld", (long int)original_euid);
3145 config_file = Ufopen(filename, "rb");
3147 #endif /* CONFIGURE_FILE_USE_EUID */
3149 /* Finally, try the unadorned name */
3151 if (config_file == NULL)
3154 config_file = Ufopen(filename, "rb");
3156 #else /* if neither defined */
3158 /* This is the common case when the fancy processing is not included. */
3160 config_file = Ufopen(filename, "rb");
3163 /* If the file does not exist, continue to try any others. For any other
3164 error, break out (and die). */
3166 if (config_file != NULL || errno != ENOENT) break;
3169 /* On success, save the name for verification; config_filename is used when
3170 logging configuration errors (it changes for .included files) whereas
3171 config_main_filename is the name shown by -bP. Failure to open a configuration
3172 file is a serious disaster. */
3176 uschar *last_slash = Ustrrchr(filename, '/');
3177 config_filename = config_main_filename = string_copy(filename);
3179 /* The config_main_directory we need for the $config_dir expansion.
3180 config_main_filename we need for $config_file expansion.
3181 And config_dir is the directory of the current configuration, used for
3182 relative .includes. We do need to know it's name, as we change our working
3185 if (filename[0] == '/')
3186 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3189 /* relative configuration file name: working dir + / + basename(filename) */
3191 uschar buf[PATH_MAX];
3194 if (os_getcwd(buf, PATH_MAX) == NULL)
3196 perror("exim: getcwd");
3199 g = string_cat(NULL, buf);
3201 /* If the dir does not end with a "/", append one */
3202 if (g->s[g->ptr-1] != '/')
3203 g = string_catn(g, US"/", 1);
3205 /* If the config file contains a "/", extract the directory part */
3207 g = string_catn(g, filename, last_slash - filename);
3209 config_main_directory = string_from_gstring(g);
3211 config_directory = config_main_directory;
3215 if (filename == NULL)
3216 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3217 "%s", config_main_filelist);
3219 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3220 "configuration file %s", filename));
3223 /* Now, once we found and opened our configuration file, we change the directory
3224 to a safe place. Later we change to $spool_directory. */
3226 if (Uchdir("/") < 0)
3228 perror("exim: chdir `/': ");
3232 /* Check the status of the file we have opened, if we have retained root
3233 privileges and the file isn't /dev/null (which *should* be 0666). */
3235 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3237 if (fstat(fileno(config_file), &statbuf) != 0)
3238 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3241 if ((statbuf.st_uid != root_uid /* owner not root */
3242 #ifdef CONFIGURE_OWNER
3243 && statbuf.st_uid != config_uid /* owner not the special one */
3246 (statbuf.st_gid != root_gid /* group not root & */
3247 #ifdef CONFIGURE_GROUP
3248 && statbuf.st_gid != config_gid /* group not the special one */
3250 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3252 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3254 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3255 "wrong owner, group, or mode", big_buffer);
3257 /* Do a dummy store-allocation of a size related to the (toplevel) file size.
3258 This assumes we will need this much storage to handle all the allocations
3259 during startup; it won't help when .include is being used. When it does, it
3260 will cut down on the number of store blocks (and malloc calls, and sbrk
3261 syscalls). It also assume we're on the relevant pool. */
3263 if (statbuf.st_size > 8192)
3265 rmark r = store_mark();
3266 void * dummy = store_get((int)statbuf.st_size, FALSE);
3271 /* Process the main configuration settings. They all begin with a lower case
3272 letter. If we see something starting with an upper case letter, it is taken as
3273 a macro definition. */
3275 while ((s = get_config_line()))
3280 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3281 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3282 "found unexpected BOM (Byte Order Mark)");
3286 if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE);
3290 t = (hide = Ustrncmp(s, "hide", 4) == 0 && isspace(s[4])) ? s + 5 : s;
3292 if (Ustrncmp(t, "domainlist", 10) == 0)
3293 read_named_list(&domainlist_anchor, &domainlist_count,
3294 MAX_NAMED_LIST, t+10, US"domain list", hide);
3296 else if (Ustrncmp(t, "hostlist", 8) == 0)
3297 read_named_list(&hostlist_anchor, &hostlist_count,
3298 MAX_NAMED_LIST, t+8, US"host list", hide);
3300 else if (Ustrncmp(t, US"addresslist", 11) == 0)
3301 read_named_list(&addresslist_anchor, &addresslist_count,
3302 MAX_NAMED_LIST, t+11, US"address list", hide);
3304 else if (Ustrncmp(t, US"localpartlist", 13) == 0)
3305 read_named_list(&localpartlist_anchor, &localpartlist_count,
3306 MAX_NAMED_LIST, t+13, US"local part list", hide);
3309 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3310 NULL, US"main option \"%s\" unknown");
3314 /* If local_sender_retain is set, local_from_check must be unset. */
3316 if (local_sender_retain && local_from_check)
3317 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3318 "local_sender_retain are set; this combination is not allowed");
3320 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3323 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3325 /* The max retry interval must not be greater than 24 hours. */
3327 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3329 /* remote_max_parallel must be > 0 */
3331 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3333 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3334 start of a new SMTP message. */
3336 freeze_tell_config = freeze_tell;
3338 /* The primary host name may be required for expansion of spool_directory
3339 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3340 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3341 canonize it. Some people like upper case letters in their host names, so we
3342 don't force the case. */
3344 if (primary_hostname == NULL)
3346 const uschar *hostname;
3348 if (uname(&uts) < 0)
3349 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3350 hostname = US uts.nodename;
3352 if (Ustrchr(hostname, '.') == NULL)
3355 struct hostent *hostdata;
3358 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3359 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3360 MCL_DOMAIN, TRUE, NULL) != OK))
3369 #if HAVE_GETIPNODEBYNAME
3371 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3373 hostdata = gethostbyname2(CS hostname, af);
3376 hostdata = gethostbyname(CS hostname);
3379 if (hostdata != NULL)
3381 hostname = US hostdata->h_name;
3385 if (af == AF_INET) break;
3390 primary_hostname = string_copy(hostname);
3393 /* Set up default value for smtp_active_hostname */
3395 smtp_active_hostname = primary_hostname;
3397 /* If spool_directory wasn't set in the build-time configuration, it must have
3398 got set above. Of course, writing to the log may not work if log_file_path is
3399 not set, but it will at least get to syslog or somewhere, with any luck. */
3401 if (!*spool_directory)
3402 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3405 /* Expand the spool directory name; it may, for example, contain the primary
3406 host name. Same comment about failure. */
3408 if (!(s = expand_string(spool_directory)))
3409 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3410 "\"%s\": %s", spool_directory, expand_string_message);
3411 spool_directory = s;
3413 /* Expand log_file_path, which must contain "%s" in any component that isn't
3414 the null string or "syslog". It is also allowed to contain one instance of %D
3415 or %M. However, it must NOT contain % followed by anything else. */
3419 const uschar *ss, *sss;
3420 int sep = ':'; /* Fixed for log file path */
3421 if (!(s = expand_string(log_file_path)))
3422 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3423 "\"%s\": %s", log_file_path, expand_string_message);
3426 while ((sss = string_nextinlist(&ss, &sep, big_buffer, big_buffer_size)))
3429 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3430 if (!(t = Ustrstr(sss, "%s")))
3431 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3432 "contain \"%%s\"", sss);
3434 if ((t = Ustrchr(sss, '%')))
3435 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3436 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3437 "unexpected \"%%\" character", s);
3443 /* Interpret syslog_facility into an integer argument for 'ident' param to
3444 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3447 if (syslog_facility_str)
3450 uschar *s = syslog_facility_str;
3452 if ((Ustrlen(syslog_facility_str) >= 4) &&
3453 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3456 for (i = 0; i < syslog_list_size; i++)
3457 if (strcmpic(s, syslog_list[i].name) == 0)
3459 syslog_facility = syslog_list[i].value;
3463 if (i >= syslog_list_size)
3464 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3465 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3468 /* Expand pid_file_path */
3470 if (*pid_file_path != 0)
3472 if (!(s = expand_string(pid_file_path)))
3473 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3474 "\"%s\": %s", pid_file_path, expand_string_message);
3478 /* Set default value of process_log_path */
3480 if (!process_log_path || *process_log_path =='\0')
3481 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3483 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3486 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3488 /* Unpick the SMTP rate limiting options, if set */
3490 if (smtp_ratelimit_mail)
3491 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3492 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3494 if (smtp_ratelimit_rcpt)
3495 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3496 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3498 /* The qualify domains default to the primary host name */
3500 if (!qualify_domain_sender)
3501 qualify_domain_sender = primary_hostname;
3502 if (!qualify_domain_recipient)
3503 qualify_domain_recipient = qualify_domain_sender;
3505 /* Setting system_filter_user in the configuration sets the gid as well if a
3506 name is given, but a numerical value does not. */
3508 if (system_filter_uid_set && !system_filter_gid_set)
3510 struct passwd *pw = getpwuid(system_filter_uid);
3512 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3513 (long int)system_filter_uid);
3514 system_filter_gid = pw->pw_gid;
3515 system_filter_gid_set = TRUE;
3518 /* If the errors_reply_to field is set, check that it is syntactically valid
3519 and ensure it contains a domain. */
3521 if (errors_reply_to)
3524 int start, end, domain;
3525 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3526 &start, &end, &domain, FALSE);
3529 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3530 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3533 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3534 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3537 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3538 smtp_accept_max must also be set. */
3540 if (smtp_accept_max == 0 &&
3541 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3542 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3543 "smtp_accept_max must be set if smtp_accept_queue or "
3544 "smtp_accept_max_per_host is set");
3546 /* Set up the host number if anything is specified. It is an expanded string
3547 so that it can be computed from the host name, for example. We do this last
3548 so as to ensure that everything else is set up before the expansion. */
3550 if (host_number_string)
3554 uschar *s = expand_string(host_number_string);
3557 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3558 "failed to expand localhost_number \"%s\": %s",
3559 host_number_string, expand_string_message);
3560 n = Ustrtol(s, &end, 0);
3561 while (isspace(*end)) end++;
3563 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3564 "localhost_number value is not a number: %s", s);
3565 if (n > LOCALHOST_MAX)
3566 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3567 "localhost_number is greater than the maximum allowed value (%d)",
3573 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3575 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3576 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3577 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3578 tls_verify_hosts ? "" : "try_");
3580 /* Magic number: at time of writing, 1024 has been the long-standing value
3581 used by so many clients, and what Exim used to use always, that it makes
3582 sense to just min-clamp this max-clamp at that. */
3583 if (tls_dh_max_bits < 1024)
3584 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3585 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3587 /* If openssl_options is set, validate it */
3588 if (openssl_options)
3591 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3592 "openssl_options is set but we're using GnuTLS");
3595 if (!tls_openssl_options_parse(openssl_options, &dummy))
3596 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3597 "openssl_options parse error: %s", openssl_options);
3600 #endif /*DISABLE_TLS*/
3602 if (!nowarn && !keep_environment && environ && *environ)
3603 log_write(0, LOG_MAIN,
3604 "Warning: purging the environment.\n"
3605 " Suggested action: use keep_environment.");
3610 /*************************************************
3611 * Initialize one driver *
3612 *************************************************/
3614 /* This is called once the driver's generic options, if any, have been read.
3615 We can now find the driver, set up defaults for the private options, and
3616 unset any "set" bits in the private options table (which might have been
3617 set by another incarnation of the same driver).
3620 d pointer to driver instance block, with generic
3622 drivers_available vector of available drivers
3623 size_of_info size of each block in drivers_available
3624 class class of driver, for error message
3626 Returns: pointer to the driver info block
3629 static driver_info *
3630 init_driver(driver_instance *d, driver_info *drivers_available,
3631 int size_of_info, uschar *class)
3633 for (driver_info * dd = drivers_available; dd->driver_name[0] != 0;
3634 dd = (driver_info *)((US dd) + size_of_info))
3635 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3637 int len = dd->options_len;
3639 d->options_block = store_get(len, FALSE);
3640 memcpy(d->options_block, dd->options_block, len);
3641 for (int i = 0; i < *(dd->options_count); i++)
3642 dd->options[i].type &= ~opt_set;
3646 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3647 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3649 return NULL; /* never obeyed */
3655 /*************************************************
3656 * Initialize driver list *
3657 *************************************************/
3659 /* This function is called for routers, transports, and authentication
3660 mechanisms. It reads the data from the current point in the configuration file
3661 up to the end of the section, and sets up a chain of instance blocks according
3662 to the file's contents. The file will already have been opened by a call to
3663 readconf_main, and must be left open for subsequent reading of further data.
3665 Any errors cause a panic crash. Note that the blocks with names driver_info and
3666 driver_instance must map the first portions of all the _info and _instance
3667 blocks for this shared code to work.
3670 class "router", "transport", or "authenticator"
3671 anchor &routers, &transports, &auths
3672 drivers_available available drivers
3673 size_of_info size of each info block
3674 instance_default points to default data for an instance
3675 instance_size size of instance block
3676 driver_optionlist generic option list
3677 driver_optionlist_count count of generic option list
3683 readconf_driver_init(
3685 driver_instance **anchor,
3686 driver_info *drivers_available,
3688 void *instance_default,
3690 optionlist *driver_optionlist,
3691 int driver_optionlist_count)
3693 driver_instance **p = anchor;
3694 driver_instance *d = NULL;
3697 while ((buffer = get_config_line()))
3702 /* Read the first name on the line and test for the start of a new driver. A
3703 macro definition indicates the end of the previous driver. If this isn't the
3704 start of a new driver, the line will be re-read. */
3706 s = readconf_readname(name, sizeof(name), buffer);
3708 /* Handle macro definition, first finishing off the initialization of the
3709 previous driver, if any. */
3711 if (isupper(*name) && *s == '=')
3715 if (!d->driver_name)
3716 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3717 "no driver defined for %s \"%s\"", class, d->name);
3718 /* s is using big_buffer, so this call had better not */
3722 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE);
3726 /* If the line starts with a name terminated by a colon, we are at the
3727 start of the definition of a new driver. The rest of the line must be
3732 /* Finish off initializing the previous driver. */
3736 if (!d->driver_name)
3737 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3738 "no driver defined for %s \"%s\"", class, d->name);
3742 /* Check that we haven't already got a driver of this name */
3744 for (d = *anchor; d; d = d->next)
3745 if (Ustrcmp(name, d->name) == 0)
3746 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3747 "there are two %ss called \"%s\"", class, name);
3749 /* Set up a new driver instance data block on the chain, with
3750 its default values installed. */
3752 d = store_get(instance_size, FALSE);
3753 memcpy(d, instance_default, instance_size);
3756 d->name = string_copy(name);
3758 /* Clear out the "set" bits in the generic options */
3760 for (int i = 0; i < driver_optionlist_count; i++)
3761 driver_optionlist[i].type &= ~opt_set;
3763 /* Check nothing more on this line, then do the next loop iteration. */
3765 Uskip_whitespace(&s);
3766 if (*s) extra_chars_error(s, US"driver name ", name, US"");
3770 /* Not the start of a new driver. Give an error if we have not set up a
3771 current driver yet. */
3774 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3776 /* First look to see if this is a generic option; if it is "driver",
3777 initialize the driver. If is it not a generic option, we can look for a
3778 private option provided that the driver has been previously set up. */
3780 if (readconf_handle_option(buffer, driver_optionlist,
3781 driver_optionlist_count, d, NULL))
3783 if (!d->info && d->driver_name)
3784 init_driver(d, drivers_available, size_of_info, class);
3787 /* Handle private options - pass the generic block because some may
3788 live therein. A flag with each option indicates if it is in the public
3792 readconf_handle_option(buffer, d->info->options,
3793 *(d->info->options_count), d, US"option \"%s\" unknown");
3795 /* The option is not generic and the driver name has not yet been given. */
3797 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3798 "(\"driver\" must be specified before any private options)", name);
3801 /* Run the initialization function for the final driver. */
3805 if (!d->driver_name)
3806 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3807 "no driver defined for %s \"%s\"", class, d->name);
3814 /*************************************************
3815 * Check driver dependency *
3816 *************************************************/
3818 /* This function is passed a driver instance and a string. It checks whether
3819 any of the string options for the driver contains the given string as an
3823 d points to a driver instance block
3824 s the string to search for
3826 Returns: TRUE if a dependency is found
3830 readconf_depends(driver_instance *d, uschar *s)
3832 int count = *(d->info->options_count);
3835 for (optionlist * ol = d->info->options; ol < d->info->options + count; ol++)
3836 if ((ol->type & opt_mask) == opt_stringptr)
3838 void * options_block = ol->type & opt_public ? (void *)d : d->options_block;
3839 uschar * value = *USS(US options_block + ol->v.offset);
3841 if (value && (ss = Ustrstr(value, s)) != NULL)
3843 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3844 isalnum(ss[Ustrlen(s)])) continue;
3845 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3846 d->name, ol->name, s);
3851 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3858 /*************************************************
3859 * Decode an error type for retries *
3860 *************************************************/
3862 /* This function is global because it is also called from the main
3863 program when testing retry information. It decodes strings such as "quota_7d"
3864 into numerical error codes.
3867 pp points to start of text
3868 p points past end of text
3869 basic_errno points to an int to receive the main error number
3870 more_errno points to an int to receive the secondary error data
3872 Returns: NULL if decoded correctly; else points to error text
3876 readconf_retry_error(const uschar *pp, const uschar *p,
3877 int *basic_errno, int *more_errno)
3880 const uschar *q = pp;
3881 while (q < p && *q != '_') q++;
3884 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3886 *basic_errno = ERRNO_EXIMQUOTA;
3887 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3888 return US"bad time value";
3891 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3893 *basic_errno = ECONNREFUSED;
3896 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3897 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3898 else return US"A or MX expected after \"refused\"";
3902 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3904 *basic_errno = ETIMEDOUT;
3908 int xlen = p - q - 1;
3909 const uschar *x = q + 1;
3911 static uschar *extras[] =
3912 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3913 static int values[] =
3914 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3916 for (i = 0; i < nelem(extras); i++)
3917 if (strncmpic(x, extras[i], xlen) == 0)
3919 *more_errno = values[i];
3923 if (i >= nelem(extras))
3924 if (strncmpic(x, US"DNS", xlen) == 0)
3925 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3926 "available in retry rules (it has never worked) - treated as "
3929 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3933 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3934 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3935 strncmpic(pp, US"data_4", 6) == 0)
3938 int x = 255; /* means "any 4xx code" */
3939 if (p != pp + 8) bad = TRUE; else
3941 int a = pp[6], b = pp[7];
3945 if (isdigit(b)) x += b - '0';
3946 else if (b == 'x') x += 100;
3949 else if (a != 'x' || b != 'x') bad = TRUE;
3953 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3954 "x is literal and d is any digit", pp);
3956 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3957 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3958 *more_errno = x << 8;
3961 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3962 strncmpic(q+1, US"failed", p-q-1) == 0)
3963 *basic_errno = ERRNO_AUTHFAIL;
3965 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3966 *basic_errno = ERRNO_SMTPCLOSED;
3968 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3969 *basic_errno = ERRNO_TLSREQUIRED;
3971 else if (strncmpic(pp, US"lookup", p - pp) == 0)
3972 *basic_errno = ERRNO_UNKNOWNHOST;
3974 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3975 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3983 /*************************************************
3984 * Read retry information *
3985 *************************************************/
3987 /* Each line of retry information contains:
3989 . A domain name pattern or an address pattern;
3991 . An error name, possibly with additional data, or *;
3993 . An optional sequence of retry items, each consisting of an identifying
3994 letter, a cutoff time, and optional parameters.
3996 All this is decoded and placed into a control block. */
3999 /* Subroutine to read an argument, preceded by a comma and terminated
4000 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4001 1 = fixed point number (returned *1000).
4004 paddr pointer to pointer to current character; updated
4005 type 0 => read a time; 1 => read a fixed point number
4007 Returns: time in seconds or fixed point number * 1000
4011 retry_arg(const uschar **paddr, int type)
4013 const uschar *p = *paddr;
4016 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4018 Uskip_whitespace(&p);
4020 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4022 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4023 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4028 case 0: return readconf_readtime(pp, *p, FALSE);
4029 case 1: return readconf_readfixed(pp, *p);
4031 return 0; /* Keep picky compilers happy */
4034 /* The function proper */
4037 readconf_retries(void)
4039 retry_config **chain = &retries;
4043 while ((p = get_config_line()))
4045 retry_rule **rchain;
4049 next = store_get(sizeof(retry_config), FALSE);
4052 chain = &(next->next);
4053 next->basic_errno = next->more_errno = 0;
4054 next->senders = NULL;
4056 rchain = &(next->rules);
4058 next->pattern = string_dequote(&p);
4059 Uskip_whitespace(&p);
4061 while (mac_isgraph(*p)) p++;
4062 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4063 "missing error type in retry rule");
4065 /* Test error names for things we understand. */
4067 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4068 &next->more_errno)))
4069 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4071 /* There may be an optional address list of senders to be used as another
4072 constraint on the rule. This was added later, so the syntax is a bit of a
4073 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4076 Uskip_whitespace(&p);
4077 if (Ustrncmp(p, "senders", 7) == 0)
4080 Uskip_whitespace(&p);
4081 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4082 "\"=\" expected after \"senders\" in retry rule");
4083 Uskip_whitespace(&p);
4084 next->senders = string_dequote(&p);
4087 /* Now the retry rules. Keep the maximum timeout encountered. */
4089 Uskip_whitespace(&p);
4093 retry_rule *rule = store_get(sizeof(retry_rule), FALSE);
4095 rchain = &(rule->next);
4097 rule->rule = toupper(*p++);
4098 rule->timeout = retry_arg(&p, 0);
4099 if (rule->timeout > retry_maximum_timeout)
4100 retry_maximum_timeout = rule->timeout;
4104 case 'F': /* Fixed interval */
4105 rule->p1 = retry_arg(&p, 0);
4108 case 'G': /* Geometrically increasing intervals */
4109 case 'H': /* Ditto, but with randomness */
4110 rule->p1 = retry_arg(&p, 0);
4111 rule->p2 = retry_arg(&p, 1);
4115 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4119 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4120 (rule->rule != 'F' && rule->p2 < 1000))
4121 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4122 "bad parameters for retry rule");
4124 if (Uskip_whitespace(&p) == ';')
4127 Uskip_whitespace(&p);
4130 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4137 /*************************************************
4138 * Initialize authenticators *
4139 *************************************************/
4141 /* Read the authenticators section of the configuration file.
4150 #ifndef DISABLE_PIPE_CONNECT
4154 readconf_driver_init(US"authenticator",
4155 (driver_instance **)(&auths), /* chain anchor */
4156 (driver_info *)auths_available, /* available drivers */
4157 sizeof(auth_info), /* size of info block */
4158 &auth_defaults, /* default values for generic options */
4159 sizeof(auth_instance), /* size of instance block */
4160 optionlist_auths, /* generic options */
4161 optionlist_auths_size);
4163 for (auth_instance * au = auths; au; au = au->next)
4165 if (!au->public_name)
4166 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4167 "the %s authenticator", au->name);
4169 for (auth_instance * bu = au->next; bu; bu = bu->next)
4170 if (strcmpic(au->public_name, bu->public_name) == 0)
4171 if ((au->client && bu->client) || (au->server && bu->server))
4172 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4173 "(%s and %s) have the same public name (%s)",
4174 au->client ? US"client" : US"server", au->name, bu->name,
4176 #ifndef DISABLE_PIPE_CONNECT
4180 #ifndef DISABLE_PIPE_CONNECT
4181 f.smtp_in_early_pipe_no_auth = nauths > 16;
4188 /*************************************************
4189 * Read ACL information *
4190 *************************************************/
4192 /* If this run of Exim is not doing something that involves receiving a
4193 message, we can just skip over the ACL information. No need to parse it.
4195 First, we have a function for acl_read() to call back to get the next line. We
4196 need to remember the line we passed, because at the end it will contain the
4197 name of the next ACL. */
4199 static uschar *acl_line;
4204 acl_line = get_config_line();
4209 /* Now the main function:
4220 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4223 acl_line = get_config_line();
4231 p = readconf_readname(name, sizeof(name), acl_line);
4232 if (isupper(*name) && *p == '=')
4234 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE);
4235 acl_line = get_config_line();
4239 if (*p != ':' || name[0] == 0)
4240 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4242 node = store_get(sizeof(tree_node) + Ustrlen(name), is_tainted(name));
4243 Ustrcpy(node->name, name);
4244 if (!tree_insertnode(&acl_anchor, node))
4245 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4246 "there are two ACLs called \"%s\"", name);
4248 node->data.ptr = acl_read(acl_callback, &error);
4250 if (node->data.ptr == NULL && error != NULL)
4251 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4257 /*************************************************
4258 * Read configuration for local_scan() *
4259 *************************************************/
4261 /* This function is called after "begin local_scan" is encountered in the
4262 configuration file. If the local_scan() function allows for configuration
4263 options, we can process them. Otherwise, we expire in a panic.
4270 local_scan_init(void)
4272 #ifndef LOCAL_SCAN_HAS_OPTIONS
4273 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4274 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4278 while ((p = get_config_line()))
4279 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4280 NULL, US"local_scan option \"%s\" unknown");
4286 /*************************************************
4287 * Read rest of configuration (after main) *
4288 *************************************************/
4290 /* This function reads the rest of the runtime configuration, after the main
4291 configuration. It is called only when actually needed. Each subsequent section
4292 of the configuration starts with a line of the form
4296 where the name is "routers", "transports", etc. A section is terminated by
4297 hitting the next "begin" line, and the next name is left in next_section.
4298 Because it may confuse people as to whether the names are singular or plural,
4299 we add "s" if it's missing. There is always enough room in next_section for
4300 this. This function is basically just a switch.
4306 static uschar *section_list[] = {
4320 while(next_section[0] != 0)
4324 int last = nelem(section_list);
4326 int n = Ustrlen(next_section);
4328 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, US"s");
4332 int c = strcmpic(next_section, section_list[mid]);
4334 if (c > 0) first = mid + 1; else last = mid;
4336 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4337 "\"%.*s\" is not a known configuration section name", n, next_section);
4338 mid = (last + first)/2;
4342 if (((had ^= bit) & bit) == 0)
4343 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4344 "\"%.*s\" section is repeated in the configuration file", n,
4349 case 0: readconf_acl(); break;
4350 case 1: auths_init(); break;
4351 case 2: local_scan_init(); break;
4352 case 3: readconf_retries(); break;
4353 case 4: readconf_rewrites(); break;
4354 case 5: route_init(); break;
4355 case 6: transport_init(); break;
4359 (void)fclose(config_file);
4362 /* Init the storage for the pre-parsed config lines */
4364 readconf_save_config(const uschar *s)
4366 save_config_line(string_sprintf("# Exim Configuration (%s)",
4367 f.running_in_test_harness ? US"X" : s));
4371 save_config_position(const uschar *file, int line)
4373 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4376 /* Append a pre-parsed logical line to the config lines store,
4377 this operates on a global (static) list that holds all the pre-parsed
4378 config lines, we do no further processing here, output formatting and
4379 honouring of <hide> or macros will be done during output */
4382 save_config_line(const uschar* line)
4384 static config_line_item *current;
4385 config_line_item *next;
4387 next = (config_line_item*) store_get(sizeof(config_line_item), FALSE);
4388 next->line = string_copy(line);
4391 if (!config_lines) config_lines = next;
4392 else current->next = next;
4397 /* List the parsed config lines, care about nice formatting and
4398 hide the <hide> values unless we're the admin user */
4400 print_config(BOOL admin, BOOL terse)
4402 const int TS = terse ? 0 : 2;
4405 for (config_line_item * i = config_lines; i; i = i->next)
4410 /* skip over to the first non-space */
4411 for (current = i->line; *current && isspace(*current); ++current)
4414 if (*current == '\0')
4417 /* Collapse runs of spaces. We stop this if we encounter one of the
4418 * following characters: "'$, as this may indicate careful formatting */
4419 for (p = current; *p; ++p)
4422 if (!isspace(*p)) continue;
4423 if (*p != ' ') *p = ' ';
4425 for (next = p; isspace(*next); ++next)
4429 memmove(p+1, next, Ustrlen(next)+1);
4431 if (*next == '"' || *next == '\'' || *next == '$')
4436 if (current[0] == '#')
4439 /* begin lines are left aligned */
4440 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4442 if (!terse) puts("");
4447 /* router/acl/transport block names */
4448 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4450 if (!terse) puts("");
4451 printf("%*s%s\n", TS, "", current);
4455 /* hidden lines (all MACROS or lines prefixed with "hide") */
4457 && ( isupper(*current)
4458 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4462 if ((p = Ustrchr(current, '=')))
4465 printf("%*s%s= %s\n", indent, "", current, CCS hidden);
4467 /* e.g.: hide split_spool_directory */
4469 printf("%*s\n", indent, CCS hidden);
4473 /* rest is public */
4474 printf("%*s%s\n", indent, "", current);
4478 #endif /*!MACRO_PREDEF*/
4481 /* End of readconf.c */