1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2022 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for reading the configuration file, and for displaying
10 overall configuration values. Thanks to Brian Candler for the original
11 implementation of the conditional .ifdef etc. */
16 # include "macro_predef.h"
19 #define READCONF_DEBUG if (FALSE) /* Change to TRUE to enable */
22 static uschar * syslog_facility_str;
23 static void fn_smtp_receive_timeout(const uschar *, const uschar *, unsigned);
25 /*************************************************
26 * Main configuration options *
27 *************************************************/
29 /* The list of options that can be set in the main configuration file. This
30 must be in alphabetic order because it is searched by binary chop. */
32 static optionlist optionlist_config[] = {
33 { "*set_exim_group", opt_bool|opt_hidden, {&exim_gid_set} },
34 { "*set_exim_user", opt_bool|opt_hidden, {&exim_uid_set} },
35 { "*set_system_filter_group", opt_bool|opt_hidden, {&system_filter_gid_set} },
36 { "*set_system_filter_user", opt_bool|opt_hidden, {&system_filter_uid_set} },
37 { "accept_8bitmime", opt_bool, {&accept_8bitmime} },
38 { "acl_not_smtp", opt_stringptr, {&acl_not_smtp} },
39 #ifdef WITH_CONTENT_SCAN
40 { "acl_not_smtp_mime", opt_stringptr, {&acl_not_smtp_mime} },
42 { "acl_not_smtp_start", opt_stringptr, {&acl_not_smtp_start} },
43 { "acl_smtp_auth", opt_stringptr, {&acl_smtp_auth} },
44 { "acl_smtp_connect", opt_stringptr, {&acl_smtp_connect} },
45 { "acl_smtp_data", opt_stringptr, {&acl_smtp_data} },
47 { "acl_smtp_data_prdr", opt_stringptr, {&acl_smtp_data_prdr} },
50 { "acl_smtp_dkim", opt_stringptr, {&acl_smtp_dkim} },
52 { "acl_smtp_etrn", opt_stringptr, {&acl_smtp_etrn} },
53 { "acl_smtp_expn", opt_stringptr, {&acl_smtp_expn} },
54 { "acl_smtp_helo", opt_stringptr, {&acl_smtp_helo} },
55 { "acl_smtp_mail", opt_stringptr, {&acl_smtp_mail} },
56 { "acl_smtp_mailauth", opt_stringptr, {&acl_smtp_mailauth} },
57 #ifdef WITH_CONTENT_SCAN
58 { "acl_smtp_mime", opt_stringptr, {&acl_smtp_mime} },
60 { "acl_smtp_notquit", opt_stringptr, {&acl_smtp_notquit} },
61 { "acl_smtp_predata", opt_stringptr, {&acl_smtp_predata} },
62 { "acl_smtp_quit", opt_stringptr, {&acl_smtp_quit} },
63 { "acl_smtp_rcpt", opt_stringptr, {&acl_smtp_rcpt} },
65 { "acl_smtp_starttls", opt_stringptr, {&acl_smtp_starttls} },
67 { "acl_smtp_vrfy", opt_stringptr, {&acl_smtp_vrfy} },
68 { "add_environment", opt_stringptr, {&add_environment} },
69 { "admin_groups", opt_gidlist, {&admin_groups} },
70 { "allow_domain_literals", opt_bool, {&allow_domain_literals} },
71 { "allow_mx_to_ip", opt_bool, {&allow_mx_to_ip} },
72 { "allow_utf8_domains", opt_bool, {&allow_utf8_domains} },
73 { "auth_advertise_hosts", opt_stringptr, {&auth_advertise_hosts} },
74 { "auto_thaw", opt_time, {&auto_thaw} },
75 #ifdef WITH_CONTENT_SCAN
76 { "av_scanner", opt_stringptr, {&av_scanner} },
78 { "bi_command", opt_stringptr, {&bi_command} },
79 #ifdef EXPERIMENTAL_BRIGHTMAIL
80 { "bmi_config_file", opt_stringptr, {&bmi_config_file} },
82 { "bounce_message_file", opt_stringptr, {&bounce_message_file} },
83 { "bounce_message_text", opt_stringptr, {&bounce_message_text} },
84 { "bounce_return_body", opt_bool, {&bounce_return_body} },
85 { "bounce_return_linesize_limit", opt_mkint, {&bounce_return_linesize_limit} },
86 { "bounce_return_message", opt_bool, {&bounce_return_message} },
87 { "bounce_return_size_limit", opt_mkint, {&bounce_return_size_limit} },
88 { "bounce_sender_authentication",opt_stringptr,{&bounce_sender_authentication} },
89 { "callout_domain_negative_expire", opt_time, {&callout_cache_domain_negative_expire} },
90 { "callout_domain_positive_expire", opt_time, {&callout_cache_domain_positive_expire} },
91 { "callout_negative_expire", opt_time, {&callout_cache_negative_expire} },
92 { "callout_positive_expire", opt_time, {&callout_cache_positive_expire} },
93 { "callout_random_local_part",opt_stringptr, {&callout_random_local_part} },
94 { "check_log_inodes", opt_int, {&check_log_inodes} },
95 { "check_log_space", opt_Kint, {&check_log_space} },
96 { "check_rfc2047_length", opt_bool, {&check_rfc2047_length} },
97 { "check_spool_inodes", opt_int, {&check_spool_inodes} },
98 { "check_spool_space", opt_Kint, {&check_spool_space} },
99 { "chunking_advertise_hosts", opt_stringptr, {&chunking_advertise_hosts} },
100 { "commandline_checks_require_admin", opt_bool,{&commandline_checks_require_admin} },
101 { "daemon_smtp_port", opt_stringptr|opt_hidden, {&daemon_smtp_port} },
102 { "daemon_smtp_ports", opt_stringptr, {&daemon_smtp_port} },
103 { "daemon_startup_retries", opt_int, {&daemon_startup_retries} },
104 { "daemon_startup_sleep", opt_time, {&daemon_startup_sleep} },
105 #ifdef EXPERIMENTAL_DCC
106 { "dcc_direct_add_header", opt_bool, {&dcc_direct_add_header} },
107 { "dccifd_address", opt_stringptr, {&dccifd_address} },
108 { "dccifd_options", opt_stringptr, {&dccifd_options} },
110 { "debug_store", opt_bool, {&debug_store} },
111 { "delay_warning", opt_timelist, {&delay_warning} },
112 { "delay_warning_condition", opt_stringptr, {&delay_warning_condition} },
113 { "deliver_drop_privilege", opt_bool, {&deliver_drop_privilege} },
114 { "deliver_queue_load_max", opt_fixed, {&deliver_queue_load_max} },
115 { "delivery_date_remove", opt_bool, {&delivery_date_remove} },
116 #ifdef ENABLE_DISABLE_FSYNC
117 { "disable_fsync", opt_bool, {&disable_fsync} },
119 { "disable_ipv6", opt_bool, {&disable_ipv6} },
121 { "dkim_verify_hashes", opt_stringptr, {&dkim_verify_hashes} },
122 { "dkim_verify_keytypes", opt_stringptr, {&dkim_verify_keytypes} },
123 { "dkim_verify_min_keysizes", opt_stringptr, {&dkim_verify_min_keysizes} },
124 { "dkim_verify_minimal", opt_bool, {&dkim_verify_minimal} },
125 { "dkim_verify_signers", opt_stringptr, {&dkim_verify_signers} },
128 { "dmarc_forensic_sender", opt_stringptr, {&dmarc_forensic_sender} },
129 { "dmarc_history_file", opt_stringptr, {&dmarc_history_file} },
130 { "dmarc_tld_file", opt_stringptr, {&dmarc_tld_file} },
132 { "dns_again_means_nonexist", opt_stringptr, {&dns_again_means_nonexist} },
133 { "dns_check_names_pattern", opt_stringptr, {&check_dns_names_pattern} },
134 { "dns_cname_loops", opt_int, {&dns_cname_loops} },
135 { "dns_csa_search_limit", opt_int, {&dns_csa_search_limit} },
136 { "dns_csa_use_reverse", opt_bool, {&dns_csa_use_reverse} },
137 { "dns_dnssec_ok", opt_int, {&dns_dnssec_ok} },
138 { "dns_ipv4_lookup", opt_stringptr, {&dns_ipv4_lookup} },
139 { "dns_retrans", opt_time, {&dns_retrans} },
140 { "dns_retry", opt_int, {&dns_retry} },
141 { "dns_trust_aa", opt_stringptr, {&dns_trust_aa} },
142 { "dns_use_edns0", opt_int, {&dns_use_edns0} },
143 /* This option is now a no-op, retained for compatibility */
144 { "drop_cr", opt_bool, {&drop_cr} },
145 /*********************************************************/
146 { "dsn_advertise_hosts", opt_stringptr, {&dsn_advertise_hosts} },
147 { "dsn_from", opt_stringptr, {&dsn_from} },
148 { "envelope_to_remove", opt_bool, {&envelope_to_remove} },
149 { "errors_copy", opt_stringptr, {&errors_copy} },
150 { "errors_reply_to", opt_stringptr, {&errors_reply_to} },
151 #ifndef DISABLE_EVENT
152 { "event_action", opt_stringptr, {&event_action} },
154 { "exim_group", opt_gid, {&exim_gid} },
155 { "exim_path", opt_stringptr, {&exim_path} },
156 { "exim_user", opt_uid, {&exim_uid} },
157 { "exim_version", opt_stringptr, {&version_string} },
158 { "extra_local_interfaces", opt_stringptr, {&extra_local_interfaces} },
159 { "extract_addresses_remove_arguments", opt_bool, {&extract_addresses_remove_arguments} },
160 { "finduser_retries", opt_int, {&finduser_retries} },
161 { "freeze_tell", opt_stringptr, {&freeze_tell} },
162 { "gecos_name", opt_stringptr, {&gecos_name} },
163 { "gecos_pattern", opt_stringptr, {&gecos_pattern} },
165 { "gnutls_allow_auto_pkcs11", opt_bool, {&gnutls_allow_auto_pkcs11} },
166 { "gnutls_compat_mode", opt_bool, {&gnutls_compat_mode} },
168 { "header_line_maxsize", opt_int, {&header_line_maxsize} },
169 { "header_maxsize", opt_int, {&header_maxsize} },
170 { "headers_charset", opt_stringptr, {&headers_charset} },
171 { "helo_accept_junk_hosts", opt_stringptr, {&helo_accept_junk_hosts} },
172 { "helo_allow_chars", opt_stringptr, {&helo_allow_chars} },
173 { "helo_lookup_domains", opt_stringptr, {&helo_lookup_domains} },
174 { "helo_try_verify_hosts", opt_stringptr, {&helo_try_verify_hosts} },
175 { "helo_verify_hosts", opt_stringptr, {&helo_verify_hosts} },
176 { "hold_domains", opt_stringptr, {&hold_domains} },
177 { "host_lookup", opt_stringptr, {&host_lookup} },
178 { "host_lookup_order", opt_stringptr, {&host_lookup_order} },
179 { "host_reject_connection", opt_stringptr, {&host_reject_connection} },
180 { "hosts_connection_nolog", opt_stringptr, {&hosts_connection_nolog} },
182 { "hosts_proxy", opt_stringptr, {&hosts_proxy} },
185 { "hosts_require_alpn", opt_stringptr, {&hosts_require_alpn} },
187 { "hosts_require_helo", opt_stringptr, {&hosts_require_helo} },
188 { "hosts_treat_as_local", opt_stringptr, {&hosts_treat_as_local} },
190 { "ibase_servers", opt_stringptr, {&ibase_servers} },
192 { "ignore_bounce_errors_after", opt_time, {&ignore_bounce_errors_after} },
193 { "ignore_fromline_hosts", opt_stringptr, {&ignore_fromline_hosts} },
194 { "ignore_fromline_local", opt_bool, {&ignore_fromline_local} },
195 { "keep_environment", opt_stringptr, {&keep_environment} },
196 { "keep_malformed", opt_time, {&keep_malformed} },
198 { "ldap_ca_cert_dir", opt_stringptr, {&eldap_ca_cert_dir} },
199 { "ldap_ca_cert_file", opt_stringptr, {&eldap_ca_cert_file} },
200 { "ldap_cert_file", opt_stringptr, {&eldap_cert_file} },
201 { "ldap_cert_key", opt_stringptr, {&eldap_cert_key} },
202 { "ldap_cipher_suite", opt_stringptr, {&eldap_cipher_suite} },
203 { "ldap_default_servers", opt_stringptr, {&eldap_default_servers} },
204 { "ldap_require_cert", opt_stringptr, {&eldap_require_cert} },
205 { "ldap_start_tls", opt_bool, {&eldap_start_tls} },
206 { "ldap_version", opt_int, {&eldap_version} },
208 #ifdef EXPERIMENTAL_ESMTP_LIMITS
209 { "limits_advertise_hosts", opt_stringptr, {&limits_advertise_hosts} },
211 { "local_from_check", opt_bool, {&local_from_check} },
212 { "local_from_prefix", opt_stringptr, {&local_from_prefix} },
213 { "local_from_suffix", opt_stringptr, {&local_from_suffix} },
214 { "local_interfaces", opt_stringptr, {&local_interfaces} },
215 #ifdef HAVE_LOCAL_SCAN
216 { "local_scan_timeout", opt_time, {&local_scan_timeout} },
218 { "local_sender_retain", opt_bool, {&local_sender_retain} },
219 { "localhost_number", opt_stringptr, {&host_number_string} },
220 { "log_file_path", opt_stringptr, {&log_file_path} },
221 { "log_selector", opt_stringptr, {&log_selector_string} },
222 { "log_timezone", opt_bool, {&log_timezone} },
223 { "lookup_open_max", opt_int, {&lookup_open_max} },
224 { "max_username_length", opt_int, {&max_username_length} },
225 { "message_body_newlines", opt_bool, {&message_body_newlines} },
226 { "message_body_visible", opt_mkint, {&message_body_visible} },
227 { "message_id_header_domain", opt_stringptr, {&message_id_domain} },
228 { "message_id_header_text", opt_stringptr, {&message_id_text} },
229 { "message_logs", opt_bool, {&message_logs} },
230 { "message_size_limit", opt_stringptr, {&message_size_limit} },
231 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
232 { "move_frozen_messages", opt_bool, {&move_frozen_messages} },
234 { "mua_wrapper", opt_bool, {&mua_wrapper} },
236 { "mysql_servers", opt_stringptr, {&mysql_servers} },
238 { "never_users", opt_uidlist, {&never_users} },
239 { "notifier_socket", opt_stringptr, {¬ifier_socket} },
241 { "openssl_options", opt_stringptr, {&openssl_options} },
244 { "oracle_servers", opt_stringptr, {&oracle_servers} },
246 { "panic_coredump", opt_bool, {&panic_coredump} },
247 { "percent_hack_domains", opt_stringptr, {&percent_hack_domains} },
249 { "perl_at_start", opt_bool, {&opt_perl_at_start} },
250 { "perl_startup", opt_stringptr, {&opt_perl_startup} },
251 { "perl_taintmode", opt_bool, {&opt_perl_taintmode} },
254 { "pgsql_servers", opt_stringptr, {&pgsql_servers} },
256 { "pid_file_path", opt_stringptr, {&pid_file_path} },
257 { "pipelining_advertise_hosts", opt_stringptr, {&pipelining_advertise_hosts} },
258 #ifndef DISABLE_PIPE_CONNECT
259 { "pipelining_connect_advertise_hosts", opt_stringptr,
260 {&pipe_connect_advertise_hosts} },
263 { "prdr_enable", opt_bool, {&prdr_enable} },
265 { "preserve_message_logs", opt_bool, {&preserve_message_logs} },
266 { "primary_hostname", opt_stringptr, {&primary_hostname} },
267 { "print_topbitchars", opt_bool, {&print_topbitchars} },
268 { "process_log_path", opt_stringptr, {&process_log_path} },
269 { "prod_requires_admin", opt_bool, {&prod_requires_admin} },
271 { "proxy_protocol_timeout", opt_time, {&proxy_protocol_timeout} },
273 { "qualify_domain", opt_stringptr, {&qualify_domain_sender} },
274 { "qualify_recipient", opt_stringptr, {&qualify_domain_recipient} },
275 { "queue_domains", opt_stringptr, {&queue_domains} },
276 #ifndef DISABLE_QUEUE_RAMP
277 { "queue_fast_ramp", opt_bool, {&queue_fast_ramp} },
279 { "queue_list_requires_admin",opt_bool, {&queue_list_requires_admin} },
280 { "queue_only", opt_bool, {&queue_only} },
281 { "queue_only_file", opt_stringptr, {&queue_only_file} },
282 { "queue_only_load", opt_fixed, {&queue_only_load} },
283 { "queue_only_load_latch", opt_bool, {&queue_only_load_latch} },
284 { "queue_only_override", opt_bool, {&queue_only_override} },
285 { "queue_run_in_order", opt_bool, {&queue_run_in_order} },
286 { "queue_run_max", opt_stringptr, {&queue_run_max} },
287 { "queue_smtp_domains", opt_stringptr, {&queue_smtp_domains} },
288 { "receive_timeout", opt_time, {&receive_timeout} },
289 { "received_header_text", opt_stringptr, {&received_header_text} },
290 { "received_headers_max", opt_int, {&received_headers_max} },
291 { "recipient_unqualified_hosts", opt_stringptr, {&recipient_unqualified_hosts} },
292 { "recipients_max", opt_int, {&recipients_max} },
293 { "recipients_max_reject", opt_bool, {&recipients_max_reject} },
295 { "redis_servers", opt_stringptr, {&redis_servers} },
297 { "remote_max_parallel", opt_int, {&remote_max_parallel} },
298 { "remote_sort_domains", opt_stringptr, {&remote_sort_domains} },
299 { "retry_data_expire", opt_time, {&retry_data_expire} },
300 { "retry_interval_max", opt_time, {&retry_interval_max} },
301 { "return_path_remove", opt_bool, {&return_path_remove} },
302 { "return_size_limit", opt_mkint|opt_hidden, {&bounce_return_size_limit} },
303 { "rfc1413_hosts", opt_stringptr, {&rfc1413_hosts} },
304 { "rfc1413_query_timeout", opt_time, {&rfc1413_query_timeout} },
305 { "sender_unqualified_hosts", opt_stringptr, {&sender_unqualified_hosts} },
306 { "slow_lookup_log", opt_int, {&slow_lookup_log} },
307 { "smtp_accept_keepalive", opt_bool, {&smtp_accept_keepalive} },
308 { "smtp_accept_max", opt_int, {&smtp_accept_max} },
309 { "smtp_accept_max_nonmail", opt_int, {&smtp_accept_max_nonmail} },
310 { "smtp_accept_max_nonmail_hosts", opt_stringptr, {&smtp_accept_max_nonmail_hosts} },
311 { "smtp_accept_max_per_connection", opt_stringptr, {&smtp_accept_max_per_connection} },
312 { "smtp_accept_max_per_host", opt_stringptr, {&smtp_accept_max_per_host} },
313 { "smtp_accept_queue", opt_int, {&smtp_accept_queue} },
314 { "smtp_accept_queue_per_connection", opt_int, {&smtp_accept_queue_per_connection} },
315 { "smtp_accept_reserve", opt_int, {&smtp_accept_reserve} },
316 { "smtp_active_hostname", opt_stringptr, {&raw_active_hostname} },
317 { "smtp_backlog_monitor", opt_int, {&smtp_backlog_monitor} },
318 { "smtp_banner", opt_stringptr, {&smtp_banner} },
319 { "smtp_check_spool_space", opt_bool, {&smtp_check_spool_space} },
320 { "smtp_connect_backlog", opt_int, {&smtp_connect_backlog} },
321 { "smtp_enforce_sync", opt_bool, {&smtp_enforce_sync} },
322 { "smtp_etrn_command", opt_stringptr, {&smtp_etrn_command} },
323 { "smtp_etrn_serialize", opt_bool, {&smtp_etrn_serialize} },
324 { "smtp_load_reserve", opt_fixed, {&smtp_load_reserve} },
325 { "smtp_max_synprot_errors", opt_int, {&smtp_max_synprot_errors} },
326 { "smtp_max_unknown_commands",opt_int, {&smtp_max_unknown_commands} },
327 { "smtp_ratelimit_hosts", opt_stringptr, {&smtp_ratelimit_hosts} },
328 { "smtp_ratelimit_mail", opt_stringptr, {&smtp_ratelimit_mail} },
329 { "smtp_ratelimit_rcpt", opt_stringptr, {&smtp_ratelimit_rcpt} },
330 { "smtp_receive_timeout", opt_func, {.fn = &fn_smtp_receive_timeout} },
331 { "smtp_reserve_hosts", opt_stringptr, {&smtp_reserve_hosts} },
332 { "smtp_return_error_details",opt_bool, {&smtp_return_error_details} },
334 { "smtputf8_advertise_hosts", opt_stringptr, {&smtputf8_advertise_hosts} },
336 #ifdef WITH_CONTENT_SCAN
337 { "spamd_address", opt_stringptr, {&spamd_address} },
340 { "spf_guess", opt_stringptr, {&spf_guess} },
341 { "spf_smtp_comment_template",opt_stringptr, {&spf_smtp_comment_template} },
343 { "split_spool_directory", opt_bool, {&split_spool_directory} },
344 { "spool_directory", opt_stringptr, {&spool_directory} },
345 { "spool_wireformat", opt_bool, {&spool_wireformat} },
347 { "sqlite_dbfile", opt_stringptr, {&sqlite_dbfile} },
348 { "sqlite_lock_timeout", opt_int, {&sqlite_lock_timeout} },
350 { "strict_acl_vars", opt_bool, {&strict_acl_vars} },
351 { "strip_excess_angle_brackets", opt_bool, {&strip_excess_angle_brackets} },
352 { "strip_trailing_dot", opt_bool, {&strip_trailing_dot} },
353 { "syslog_duplication", opt_bool, {&syslog_duplication} },
354 { "syslog_facility", opt_stringptr, {&syslog_facility_str} },
355 { "syslog_pid", opt_bool, {&syslog_pid} },
356 { "syslog_processname", opt_stringptr, {&syslog_processname} },
357 { "syslog_timestamp", opt_bool, {&syslog_timestamp} },
358 { "system_filter", opt_stringptr, {&system_filter} },
359 { "system_filter_directory_transport", opt_stringptr,{&system_filter_directory_transport} },
360 { "system_filter_file_transport",opt_stringptr,{&system_filter_file_transport} },
361 { "system_filter_group", opt_gid, {&system_filter_gid} },
362 { "system_filter_pipe_transport",opt_stringptr,{&system_filter_pipe_transport} },
363 { "system_filter_reply_transport",opt_stringptr,{&system_filter_reply_transport} },
364 { "system_filter_user", opt_uid, {&system_filter_uid} },
365 { "tcp_nodelay", opt_bool, {&tcp_nodelay} },
366 #ifdef USE_TCP_WRAPPERS
367 { "tcp_wrappers_daemon_name", opt_stringptr, {&tcp_wrappers_daemon_name} },
369 { "timeout_frozen_after", opt_time, {&timeout_frozen_after} },
370 { "timezone", opt_stringptr, {&timezone_string} },
371 { "tls_advertise_hosts", opt_stringptr, {&tls_advertise_hosts} },
373 { "tls_alpn", opt_stringptr, {&tls_alpn} },
374 { "tls_certificate", opt_stringptr, {&tls_certificate} },
375 { "tls_crl", opt_stringptr, {&tls_crl} },
376 { "tls_dh_max_bits", opt_int, {&tls_dh_max_bits} },
377 { "tls_dhparam", opt_stringptr, {&tls_dhparam} },
378 { "tls_eccurve", opt_stringptr, {&tls_eccurve} },
379 # ifndef DISABLE_OCSP
380 { "tls_ocsp_file", opt_stringptr, {&tls_ocsp_file} },
382 { "tls_on_connect_ports", opt_stringptr, {&tls_in.on_connect_ports} },
383 { "tls_privatekey", opt_stringptr, {&tls_privatekey} },
384 { "tls_remember_esmtp", opt_bool, {&tls_remember_esmtp} },
385 { "tls_require_ciphers", opt_stringptr, {&tls_require_ciphers} },
386 # ifndef DISABLE_TLS_RESUME
387 { "tls_resumption_hosts", opt_stringptr, {&tls_resumption_hosts} },
389 { "tls_try_verify_hosts", opt_stringptr, {&tls_try_verify_hosts} },
390 { "tls_verify_certificates", opt_stringptr, {&tls_verify_certificates} },
391 { "tls_verify_hosts", opt_stringptr, {&tls_verify_hosts} },
393 { "trusted_groups", opt_gidlist, {&trusted_groups} },
394 { "trusted_users", opt_uidlist, {&trusted_users} },
395 { "unknown_login", opt_stringptr, {&unknown_login} },
396 { "unknown_username", opt_stringptr, {&unknown_username} },
397 { "untrusted_set_sender", opt_stringptr, {&untrusted_set_sender} },
398 { "uucp_from_pattern", opt_stringptr, {&uucp_from_pattern} },
399 { "uucp_from_sender", opt_stringptr, {&uucp_from_sender} },
400 { "warn_message_file", opt_stringptr, {&warn_message_file} },
401 { "write_rejectlog", opt_bool, {&write_rejectlog} }
405 static int optionlist_config_size = nelem(optionlist_config);
412 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags) {/*Dummy*/}
417 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
423 uschar buf[EXIM_DRIVERNAME_MAX];
425 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
427 for (struct auth_info * ai = auths_available; ai->driver_name[0]; ai++)
429 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
430 builtin_macro_create(buf);
431 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
433 if (ai->macros_create) (ai->macros_create)();
438 options_logging(void)
440 uschar buf[EXIM_DRIVERNAME_MAX];
442 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
444 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
445 builtin_macro_create(buf);
450 #else /*!MACRO_PREDEF*/
452 extern char **environ;
454 static void save_config_line(const uschar* line);
455 static void save_config_position(const uschar *file, int line);
456 static void print_config(BOOL admin, BOOL terse);
459 #define CSTATE_STACK_SIZE 10
461 const uschar *config_directory = NULL;
464 /* Structure for chain (stack) of .included files */
466 typedef struct config_file_item {
467 struct config_file_item *next;
468 const uschar *filename;
469 const uschar *directory;
474 /* Structure for chain of configuration lines (-bP config) */
476 typedef struct config_line_item {
477 struct config_line_item *next;
481 static config_line_item* config_lines;
483 /* Structure of table of conditional words and their state transitions */
485 typedef struct cond_item {
493 /* Structure of table of syslog facility names and values */
495 typedef struct syslog_fac_item {
501 static const uschar * const hidden = US"<value not displayable>";
503 /* Static variables */
505 static config_file_item *config_file_stack = NULL; /* For includes */
507 static uschar *syslog_facility_str = NULL;
508 static uschar next_section[24];
509 static uschar time_buffer[24];
511 /* State variables for conditional loading (.ifdef / .else / .endif) */
513 static int cstate = 0;
514 static int cstate_stack_ptr = -1;
515 static int cstate_stack[CSTATE_STACK_SIZE];
517 /* Table of state transitions for handling conditional inclusions. There are
518 four possible state transitions:
522 .elifdef true (or .else)
525 .endif just causes the previous cstate to be popped off the stack */
527 static int next_cstate[3][4] =
529 /* State 0: reading from file, or reading until next .else or .endif */
531 /* State 1: condition failed, skipping until next .else or .endif */
533 /* State 2: skipping until .endif */
537 /* Table of conditionals and the states to set. For each name, there are four
538 values: the length of the name (to save computing it each time), the state to
539 set if a macro was found in the line, the state to set if a macro was not found
540 in the line, and a stack manipulation setting which is:
542 -1 pull state value off the stack
543 0 don't alter the stack
544 +1 push value onto stack, before setting new state
547 static cond_item cond_list[] = {
548 { US"ifdef", 5, 0, 1, 1 },
549 { US"ifndef", 6, 1, 0, 1 },
550 { US"elifdef", 7, 2, 3, 0 },
551 { US"elifndef", 8, 3, 2, 0 },
552 { US"else", 4, 2, 2, 0 },
553 { US"endif", 5, 0, 0, -1 }
556 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
558 /* Table of syslog facility names and their values */
560 static syslog_fac_item syslog_list[] = {
561 { US"mail", LOG_MAIL },
562 { US"user", LOG_USER },
563 { US"news", LOG_NEWS },
564 { US"uucp", LOG_UUCP },
565 { US"local0", LOG_LOCAL0 },
566 { US"local1", LOG_LOCAL1 },
567 { US"local2", LOG_LOCAL2 },
568 { US"local3", LOG_LOCAL3 },
569 { US"local4", LOG_LOCAL4 },
570 { US"local5", LOG_LOCAL5 },
571 { US"local6", LOG_LOCAL6 },
572 { US"local7", LOG_LOCAL7 },
573 { US"daemon", LOG_DAEMON }
576 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
579 #define opt_fn_print BIT(0)
580 #define opt_fn_print_label BIT(1)
583 /*************************************************
584 * Find the name of an option *
585 *************************************************/
587 /* This function is to aid debugging. Various functions take arguments that are
588 pointer variables in the options table or in option tables for various drivers.
589 For debugging output, it is useful to be able to find the name of the option
590 which is currently being processed. This function finds it, if it exists, by
591 searching the table(s).
593 Arguments: a value that is presumed to be in the table above
594 Returns: the option name, or an empty string
598 readconf_find_option(void *p)
600 for (int i = 0; i < nelem(optionlist_config); i++)
601 if (p == optionlist_config[i].v.value) return US optionlist_config[i].name;
603 for (router_instance * r = routers; r; r = r->next)
605 router_info *ri = r->info;
606 for (int i = 0; i < *ri->options_count; i++)
608 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
609 if (p == CS (r->options_block) + ri->options[i].v.offset)
610 return US ri->options[i].name;
614 for (transport_instance * t = transports; t; t = t->next)
616 transport_info *ti = t->info;
617 for (int i = 0; i < *ti->options_count; i++)
619 optionlist * op = &ti->options[i];
620 if ((op->type & opt_mask) != opt_stringptr) continue;
621 if (p == ( op->type & opt_public
623 : CS t->options_block
636 /*************************************************
637 * Deal with an assignment to a macro *
638 *************************************************/
640 /* We have a new definition; append to the list.
643 name Name of the macro; will be copied
644 val Expansion result for the macro; will be copied
648 macro_create(const uschar * name, const uschar * val, BOOL command_line)
650 macro_item * m = store_get(sizeof(macro_item), GET_UNTAINTED);
652 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
654 m->command_line = command_line;
655 m->namelen = Ustrlen(name);
656 m->replen = Ustrlen(val);
657 m->name = string_copy(name);
658 m->replacement = string_copy(val);
670 /* This function is called when a line that starts with an upper case letter is
671 encountered. The argument "line" should contain a complete logical line, and
672 start with the first letter of the macro name. The macro name and the
673 replacement text are extracted and stored. Redefinition of existing,
674 non-command line, macros is permitted using '==' instead of '='.
677 s points to the start of the logical line
679 Returns: FALSE iff fatal error
683 macro_read_assignment(uschar *s)
685 uschar name[EXIM_DRIVERNAME_MAX];
690 while (isalnum(*s) || *s == '_')
692 if (namelen >= sizeof(name) - 1)
694 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
695 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
698 name[namelen++] = *s++;
702 Uskip_whitespace(&s);
705 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
714 Uskip_whitespace(&s);
716 /* If an existing macro of the same name was defined on the command line, we
717 just skip this definition. It's an error to attempt to redefine a macro without
718 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
719 It is also an error to define a macro whose name begins with the name of a
720 previously defined macro. This is the requirement that make using a tree
721 for macros hard; we must check all macros for the substring. Perhaps a
722 sorted list, and a bsearch, would work?
723 Note: it is documented that the other way round works. */
725 for (m = macros; m; m = m->next)
727 if (Ustrcmp(m->name, name) == 0)
729 if (!m->command_line && !redef)
731 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
732 "defined (use \"==\" if you want to redefine it)", name);
738 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
740 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
741 "a macro because previously defined macro \"%s\" is a substring",
746 /* We cannot have this test, because it is documented that a substring
747 macro is permitted (there is even an example).
749 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
750 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
751 * "a macro because it is a substring of previously defined macro \"%s\"",
756 /* Check for an overriding command-line definition. */
758 if (m && m->command_line) return TRUE;
760 /* Redefinition must refer to an existing macro. */
765 m->replen = Ustrlen(s);
766 m->replacement = string_copy(s);
770 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
775 /* We have a new definition. */
777 (void) macro_create(name, s, FALSE);
785 /* Process line for macros. The line is in big_buffer starting at offset len.
786 Expand big_buffer if needed. Handle definitions of new macros, and
787 macro expansions, rewriting the line in the buffer.
790 len Offset in buffer of start of line
791 newlen Pointer to offset of end of line, updated on return
792 macro_found Pointer to return that a macro was expanded
794 Return: pointer to first nonblank char in line
798 macros_expand(int len, int * newlen, BOOL * macro_found)
800 uschar * ss = big_buffer + len;
803 /* Find the true start of the physical line - leading spaces are always
806 Uskip_whitespace(&ss);
808 /* Process the physical line for macros. If this is the start of the logical
809 line, skip over initial text at the start of the line if it starts with an
810 upper case character followed by a sequence of name characters and an equals
811 sign, because that is the definition of a new macro, and we don't do
812 replacement therein. */
815 if (len == 0 && isupper(*s))
817 while (isalnum(*s) || *s == '_') s++;
818 if (Uskip_whitespace(&s) != '=') s = ss; /* Not a macro definition */
821 /* Skip leading chars which cannot start a macro name, to avoid multiple
822 pointless rescans in Ustrstr calls. */
824 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
826 /* For each defined macro, scan the line (from after XXX= if present),
827 replacing all occurrences of the macro. */
829 *macro_found = FALSE;
830 if (*s) for (macro_item * m = *s == '_' ? macros : macros_user; m; m = m->next)
835 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
839 while ((p = Ustrstr(t, m->name)) != NULL)
843 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
844 m->name, (int) Ustrlen(ss)-1, ss);
845 /* Expand the buffer if necessary */
847 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
849 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
850 uschar *newbuffer = store_malloc(newsize);
851 memcpy(newbuffer, big_buffer, *newlen + 1);
852 p = newbuffer + (p - big_buffer);
853 s = newbuffer + (s - big_buffer);
854 ss = newbuffer + (ss - big_buffer);
855 t = newbuffer + (t - big_buffer);
856 big_buffer_size = newsize;
857 store_free(big_buffer);
858 big_buffer = newbuffer;
861 /* Shuffle the remaining characters up or down in the buffer before
862 copying in the replacement text. Don't rescan the replacement for this
866 if ((moveby = m->replen - m->namelen) != 0)
868 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
871 Ustrncpy(p, m->replacement, m->replen);
873 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
878 /* An empty macro replacement at the start of a line could mean that ss no
879 longer points to the first non-blank character. */
881 Uskip_whitespace(&ss);
885 /*************************************************
886 * Read configuration line *
887 *************************************************/
889 /* A logical line of text is read from the configuration file into the big
890 buffer, taking account of macros, .includes, and continuations. The size of
891 big_buffer is increased if necessary. The count of configuration lines is
892 maintained. Physical input lines starting with # (ignoring leading white space,
893 and after macro replacement) and empty logical lines are always ignored.
894 Leading and trailing spaces are removed.
896 If we hit a line of the form "begin xxxx", the xxxx is placed in the
897 next_section vector, and the function returns NULL, indicating the end of a
898 configuration section. On end-of-file, NULL is returned with next_section
903 Returns: a pointer to the first non-blank in the line,
904 or NULL if eof or end of section is reached
908 get_config_line(void)
910 int startoffset = 0; /* To first non-blank char in logical line */
911 int len = 0; /* Of logical line so far */
916 /* Loop for handling continuation lines, skipping comments, and dealing with
921 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
923 if (config_file_stack != NULL) /* EOF inside .include */
925 (void)fclose(config_file);
926 config_file = config_file_stack->file;
927 config_filename = config_file_stack->filename;
928 config_directory = config_file_stack->directory;
929 config_lineno = config_file_stack->lineno;
930 config_file_stack = config_file_stack->next;
932 save_config_position(config_filename, config_lineno);
936 /* EOF at top level */
938 if (cstate_stack_ptr >= 0)
939 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
940 "Unexpected end of configuration file: .endif missing");
942 if (len != 0) break; /* EOF after continuation */
943 next_section[0] = 0; /* EOF at start of logical line */
948 newlen = len + Ustrlen(big_buffer + len);
950 if (config_lines && config_lineno == 1)
951 save_config_position(config_filename, config_lineno);
953 /* Handle pathologically long physical lines - yes, it did happen - by
954 extending big_buffer at this point. The code also copes with very long
957 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
960 big_buffer_size += BIG_BUFFER_SIZE;
961 newbuffer = store_malloc(big_buffer_size);
963 /* This use of strcpy is OK because we know that the string in the old
964 buffer is shorter than the new buffer. */
966 Ustrcpy(newbuffer, big_buffer);
967 store_free(big_buffer);
968 big_buffer = newbuffer;
969 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
971 newlen += Ustrlen(big_buffer + newlen);
974 ss = macros_expand(len, &newlen, ¯o_found);
976 /* Check for comment lines - these are physical lines. */
978 if (*ss == '#') continue;
980 /* Handle conditionals, which are also applied to physical lines. Conditions
981 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
982 expansion occurred on the rest of the line. A preliminary test for the leading
983 '.' saves effort on most lines. */
989 /* Search the list of conditional directives */
991 for (i = 0; i < cond_list_size; i++)
994 cond_item *c = cond_list+i;
995 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
997 /* The following character must be white space or end of string */
999 n = ss[1 + c->namelen];
1000 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
1002 /* .ifdef and .ifndef push the current state onto the stack, then set
1003 a new one from the table. Stack overflow is an error */
1007 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
1008 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1009 ".%s nested too deeply", c->name);
1010 cstate_stack[++cstate_stack_ptr] = cstate;
1011 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
1014 /* For any of the others, stack underflow is an error. The next state
1015 comes either from the stack (.endif) or from the table. */
1019 if (cstate_stack_ptr < 0)
1020 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1021 ".%s without matching .ifdef", c->name);
1022 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1023 next_cstate[cstate][macro_found? c->action1 : c->action2];
1026 /* Having dealt with a directive, break the loop */
1031 /* If we have handled a conditional directive, continue with the next
1032 physical line. Otherwise, fall through. */
1034 if (i < cond_list_size) continue;
1037 /* If the conditional state is not 0 (actively using these lines), ignore
1040 if (cstate != 0) continue; /* Conditional skip */
1042 /* Handle .include lines - these are also physical lines. */
1044 if (Ustrncmp(ss, ".include", 8) == 0 &&
1046 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1049 int include_if_exists = isspace(ss[8])? 0 : 10;
1050 config_file_item *save;
1051 struct stat statbuf;
1053 ss += 9 + include_if_exists;
1054 Uskip_whitespace(&ss);
1055 t = ss + Ustrlen(ss);
1056 while (t > ss && isspace(t[-1])) t--;
1057 if (*ss == '\"' && t[-1] == '\"')
1064 /* We allow relative file names. For security reasons currently
1065 relative names not allowed with .include_if_exists. For .include_if_exists
1066 we need to check the permissions/ownership of the containing folder */
1068 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1069 "absolute path \"%s\"", ss);
1072 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1073 ss = string_from_gstring(g);
1076 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1079 save_config_position(config_filename, config_lineno);
1080 save = store_get(sizeof(config_file_item), GET_UNTAINTED);
1081 save->next = config_file_stack;
1082 config_file_stack = save;
1083 save->file = config_file;
1084 save->filename = config_filename;
1085 save->directory = config_directory;
1086 save->lineno = config_lineno;
1088 if (!(config_file = Ufopen(ss, "rb")))
1089 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1090 "configuration file %s", ss);
1092 config_filename = string_copy(ss);
1093 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1098 /* If this is the start of the logical line, remember where the non-blank
1099 data starts. Otherwise shuffle down continuation lines to remove leading
1103 startoffset = ss - big_buffer;
1106 s = big_buffer + len;
1109 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1114 /* Accept the new addition to the line. Remove trailing white space. */
1117 while (len > 0 && isspace(big_buffer[len-1])) len--;
1118 big_buffer[len] = 0;
1120 /* We are done if the line does not end in backslash and contains some data.
1121 Empty logical lines are ignored. For continuations, remove the backslash and
1122 go round the loop to read the continuation line. */
1126 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1127 big_buffer[--len] = 0; /* Remove backslash */
1129 } /* Loop for reading multiple physical lines */
1131 /* We now have a logical line. Test for the end of a configuration section (or,
1132 more accurately, for the start of the next section). Place the name of the next
1133 section in next_section, and return NULL. If the name given is longer than
1134 next_section, truncate it. It will be unrecognized later, because all the known
1135 section names do fit. Leave space for pluralizing. */
1137 s = big_buffer + startoffset; /* First non-space character */
1140 save_config_line(s);
1142 if (strncmpic(s, US"begin ", 6) == 0)
1145 Uskip_whitespace(&s);
1146 if (big_buffer + len - s > sizeof(next_section) - 2)
1147 s[sizeof(next_section) - 2] = 0;
1148 Ustrcpy(next_section, s);
1152 /* Return the first non-blank character. */
1159 /*************************************************
1161 *************************************************/
1163 /* The yield is the pointer to the next uschar. Names longer than the
1164 output space are silently truncated. This function is also used from acl.c when
1168 name where to put the name
1172 Returns: new input pointer
1176 readconf_readname(uschar * name, int len, const uschar * s)
1179 BOOL broken = FALSE;
1181 if (isalpha(Uskip_whitespace(&s)))
1182 while (isalnum(*s) || *s == '_')
1184 if (p < len-1) name[p++] = *s;
1194 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1195 "exim item name too long (>%d), unable to use \"%s\" (truncated)",
1198 Uskip_whitespace(&s);
1205 /*************************************************
1206 * Read a time value *
1207 *************************************************/
1209 /* This function is also called from outside, to read argument
1210 time values. The format of a time value is:
1212 [<n>w][<n>d][<n>h][<n>m][<n>s]
1214 as long as at least one is present. If a format error is encountered,
1215 return a negative value. The value must be terminated by the given
1220 terminator required terminating character
1221 return_msec if TRUE, allow fractional seconds and return milliseconds
1223 Returns: the time value, or -1 on syntax error
1224 value is seconds if return_msec is FALSE
1225 value is milliseconds if return_msec is TRUE
1229 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1237 if (!isdigit(*s)) return -1;
1238 (void)sscanf(CCS s, "%d%n", &value, &count);
1243 case 'w': value *= 7;
1244 case 'd': value *= 24;
1245 case 'h': value *= 60;
1246 case 'm': value *= 60;
1251 if (!return_msec) return -1;
1252 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1254 if (*s++ != 's') return -1;
1255 yield += (int)(fraction * 1000.0);
1261 if (return_msec) value *= 1000;
1263 if (*s == terminator) return yield;
1265 /* Control never reaches here. */
1270 /*************************************************
1271 * Read a fixed point value *
1272 *************************************************/
1274 /* The value is returned *1000
1278 terminator required terminator
1280 Returns: the value, or -1 on error
1284 readconf_readfixed(const uschar *s, int terminator)
1288 if (!isdigit(*s)) return -1;
1289 (void)sscanf(CS s, "%d%n", &value, &count);
1291 yield = value * 1000;
1295 while (isdigit((*(++s))))
1297 yield += (*s - '0') * m;
1302 return (*s == terminator)? yield : (-1);
1307 /*************************************************
1308 * Find option in list *
1309 *************************************************/
1311 /* The lists are always in order, so binary chop can be used.
1314 name the option name to search for
1315 ol the first entry in the option list
1316 last one more than the offset of the last entry in the option list
1318 Returns: pointer to an option entry, or NULL if not found
1322 find_option(const uschar *name, optionlist *ol, int last)
1325 while (last > first)
1327 int middle = (first + last)/2;
1328 int c = Ustrcmp(name, ol[middle].name);
1330 if (c == 0) return ol + middle;
1331 else if (c > 0) first = middle + 1;
1339 /*************************************************
1340 * Find a set flag in option list *
1341 *************************************************/
1343 /* Because some versions of Unix make no restrictions on the values of uids and
1344 gids (even negative ones), we cannot represent "unset" by a special value.
1345 There is therefore a separate boolean variable for each one indicating whether
1346 a value is set or not. This function returns a pointer to the boolean, given
1347 the original option name. It is a major disaster if the flag cannot be found.
1350 name the name of the uid or gid option
1351 oltop points to the start of the relevant option list
1352 last one more than the offset of the last item in the option list
1353 data_block NULL when reading main options => data values in the option
1354 list are absolute addresses; otherwise they are byte offsets
1355 in data_block (used for driver options)
1357 Returns: a pointer to the boolean flag.
1361 get_set_flag(const uschar *name, optionlist *oltop, int last, void *data_block)
1364 uschar name2[EXIM_DRIVERNAME_MAX];
1365 sprintf(CS name2, "*set_%.50s", name);
1366 if (!(ol = find_option(name2, oltop, last)))
1367 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1368 "Exim internal error: missing set flag for %s", name);
1370 ? (BOOL *)(US data_block + ol->v.offset) : (BOOL *)ol->v.value;
1376 /*************************************************
1377 * Output extra characters message and die *
1378 *************************************************/
1380 /* Called when an option line has junk on the end. Sometimes this is because
1381 the sysadmin thinks comments are permitted.
1384 s points to the extra characters
1385 t1..t3 strings to insert in the log message
1387 Returns: doesn't return; dies
1391 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1393 uschar *comment = US"";
1394 if (*s == '#') comment = US" (# is comment only at line start)";
1395 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1396 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1401 /*************************************************
1402 * Read rewrite information *
1403 *************************************************/
1405 /* Each line of rewrite information contains:
1407 . A complete address in the form user@domain, possibly with
1408 leading * for each part; or alternatively, a regex.
1410 . A replacement string (which will be expanded).
1412 . An optional sequence of one-letter flags, indicating which
1413 headers etc. to apply this rule to.
1415 All this is decoded and placed into a control block. The OR of the flags is
1416 maintained in a common word.
1419 p points to the string that makes up the rule
1420 existflags points to the overall flag word
1421 isglobal TRUE if reading global rewrite rules
1423 Returns: the control block for the parsed rule.
1426 static rewrite_rule *
1427 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1429 rewrite_rule * next = store_get(sizeof(rewrite_rule), GET_UNTAINTED);
1432 next->key = string_dequote(&p);
1434 Uskip_whitespace(&p);
1436 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1437 "missing rewrite replacement string");
1440 next->replacement = string_dequote(&p);
1442 while (*p) switch (*p++)
1444 case ' ': case '\t': break;
1446 case 'q': next->flags |= rewrite_quit; break;
1447 case 'w': next->flags |= rewrite_whole; break;
1449 case 'h': next->flags |= rewrite_all_headers; break;
1450 case 's': next->flags |= rewrite_sender; break;
1451 case 'f': next->flags |= rewrite_from; break;
1452 case 't': next->flags |= rewrite_to; break;
1453 case 'c': next->flags |= rewrite_cc; break;
1454 case 'b': next->flags |= rewrite_bcc; break;
1455 case 'r': next->flags |= rewrite_replyto; break;
1457 case 'E': next->flags |= rewrite_all_envelope; break;
1458 case 'F': next->flags |= rewrite_envfrom; break;
1459 case 'T': next->flags |= rewrite_envto; break;
1461 case 'Q': next->flags |= rewrite_qualify; break;
1462 case 'R': next->flags |= rewrite_repeat; break;
1465 next->flags |= rewrite_smtp;
1466 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1467 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1468 "rewrite rule has the S flag but is not a regular expression");
1472 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1473 "unknown rewrite flag character '%c' "
1474 "(could be missing quotes round replacement item)", p[-1]);
1478 /* If no action flags are set, set all the "normal" rewrites. */
1480 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1481 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1483 /* Remember which exist, for optimization, and return the rule */
1485 *existflags |= next->flags;
1492 /*************************************************
1493 * Read global rewrite information *
1494 *************************************************/
1496 /* Each line is a single rewrite rule; it is parsed into a control block
1497 by readconf_one_rewrite(), and its flags are ORed into the global flag
1498 word rewrite_existflags. */
1501 readconf_rewrites(void)
1503 rewrite_rule **chain = &global_rewrite_rules;
1506 while ((p = get_config_line()) != NULL)
1508 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1510 chain = &(next->next);
1516 /*************************************************
1518 *************************************************/
1520 /* Strings are read into the normal store pool. As long we aren't too
1521 near the end of the current block, the string will just use what is necessary
1522 on the top of the stacking pool, because string_cat() uses the extension
1526 s the rest of the input line
1527 name the option name (for errors)
1529 Returns: pointer to the string
1533 read_string(const uschar *s, const uschar *name)
1538 if (*s != '\"') return string_copy(s);
1541 yield = string_dequote(&s);
1543 if (s == ss+1 || s[-1] != '\"')
1544 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1545 "missing quote at end of string value for %s", name);
1547 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1553 /*************************************************
1554 * Custom-handler options *
1555 *************************************************/
1557 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags)
1559 if (flags & opt_fn_print)
1561 if (flags & opt_fn_print_label) printf("%s = ", name);
1562 printf("%s\n", smtp_receive_timeout_s
1563 ? string_printing2(smtp_receive_timeout_s, SP_TAB)
1564 : readconf_printtime(smtp_receive_timeout));
1566 else if (*str == '$')
1567 smtp_receive_timeout_s = string_copy(str);
1570 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1571 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1572 if (smtp_receive_timeout < 0)
1573 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1578 /*************************************************
1579 * Handle option line *
1580 *************************************************/
1582 /* This function is called from several places to process a line containing the
1583 setting of an option. The first argument is the line to be decoded; it has been
1584 checked not to be empty and not to start with '#'. Trailing newlines and white
1585 space have been removed. The second argument is a pointer to the list of
1586 variable names that are to be recognized, together with their types and
1587 locations, and the third argument gives the number of entries in the list.
1589 The fourth argument is a pointer to a data block. If it is NULL, then the data
1590 values in the options list are absolute addresses. Otherwise, they are byte
1591 offsets in the data block.
1593 String option data may continue onto several lines; this function reads further
1594 data from config_file if necessary.
1596 The yield of this function is normally zero. If a string continues onto
1597 multiple lines, then the data value is permitted to be followed by a comma
1598 or a semicolon (for use in drivers) and the yield is that character.
1601 buffer contains the configuration line to be handled
1602 oltop points to the start of the relevant option list
1603 last one more than the offset of the last item in the option list
1604 data_block NULL when reading main options => data values in the option
1605 list are absolute addresses; otherwise they are byte offsets
1606 in data_block when they have opt_public set; otherwise
1607 they are byte offsets in data_block->options_block.
1608 unknown_txt format string to use in panic message for unknown option;
1609 must contain %s for option name
1610 if given as NULL, don't panic on unknown option
1612 Returns: TRUE if an option was read successfully,
1613 FALSE false for an unknown option if unknown_txt == NULL,
1614 otherwise panic and die on an unknown option
1618 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1619 void *data_block, uschar *unknown_txt)
1623 int count, type, value;
1627 BOOL boolvalue = TRUE;
1628 BOOL freesptr = TRUE;
1629 optionlist *ol, *ol2;
1633 uschar *inttype = US"";
1635 const uschar * s = buffer;
1636 uschar **str_target;
1637 uschar name[EXIM_DRIVERNAME_MAX];
1638 uschar name2[EXIM_DRIVERNAME_MAX];
1640 /* There may be leading spaces; thereafter, we expect an option name starting
1643 while (isspace(*s)) s++;
1645 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1647 /* Read the name of the option, and skip any subsequent white space. If
1648 it turns out that what we read was "hide", set the flag indicating that
1649 this is a secure option, and loop to read the next word. */
1651 for (int n = 0; n < 2; n++)
1653 while (isalnum(*s) || *s == '_')
1655 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1659 while (isspace(*s)) s++;
1660 if (Ustrcmp(name, "hide") != 0) break;
1661 issecure = opt_secure;
1665 /* Deal with "no_" or "not_" here for booleans */
1667 if (Ustrncmp(name, "no_", 3) == 0)
1673 if (Ustrncmp(name, "not_", 4) == 0)
1679 /* Search the list for the given name. A non-existent name, or an option that
1680 is set twice, is a disaster. */
1682 if (!(ol = find_option(name + offset, oltop, last)))
1684 if (!unknown_txt) return FALSE;
1685 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1688 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1689 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1690 "\"%s\" option set for the second time", name);
1692 ol->type |= opt_set | issecure;
1693 type = ol->type & opt_mask;
1695 /* Types with data values must be followed by '='; the "no[t]_" prefix
1696 applies only to boolean values. */
1698 if (type < opt_bool || type > opt_bool_last)
1701 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1702 "negation prefix applied to a non-boolean option");
1704 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1705 "unexpected end of line (data missing) after %s", name);
1707 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1710 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1711 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1712 ultimately expands to one of those values. */
1714 else if (*s && (offset != 0 || *s != '='))
1715 extra_chars_error(s, US"boolean option ", name, US"");
1717 /* Skip white space after = */
1719 if (*s == '=') while (isspace((*(++s))));
1721 /* If there is a data block and the opt_public flag is not set, change
1722 the data block pointer to the private options block. */
1724 if (data_block && !(ol->type & opt_public))
1725 data_block = (void *)(((driver_instance *)data_block)->options_block);
1727 /* Now get the data according to the type. */
1731 /* If a string value is not enclosed in quotes, it consists of
1732 the rest of the current line, verbatim. Otherwise, string escapes
1735 A transport is specified as a string, which is then looked up in the
1736 list of transports. A search type is specified as one of a number of
1739 A set or rewrite rules for a driver is specified as a string, which is
1740 then parsed into a suitable chain of control blocks.
1742 Uids and gids are specified as strings which are then looked up in the
1743 passwd file. Lists of uids and gids are similarly specified as colon-
1744 separated strings. */
1749 case opt_expand_uid:
1750 case opt_expand_gid:
1755 reset_point = store_mark();
1756 sptr = read_string(s, name);
1758 /* Having read a string, we now have several different ways of using it,
1759 depending on the data type, so do another switch. If keeping the actual
1760 string is not required (because it is interpreted), freesptr is set TRUE,
1761 and at the end we reset the pool. */
1765 /* If this was a string, set the variable to point to the new string,
1766 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1767 rules, we still keep the string (for printing), and parse the rules into a
1768 control block and flags word. */
1771 str_target = data_block ? USS (US data_block + ol->v.offset)
1773 if (ol->type & opt_rep_con)
1775 uschar * saved_condition;
1776 /* We already have a condition, we're conducting a crude hack to let
1777 multiple condition rules be chained together, despite storing them in
1779 *str_target = string_copy_perm( (saved_condition = *str_target)
1780 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1781 saved_condition, sptr)
1784 /* TODO(pdp): there is a memory leak here and just below
1785 when we set 3 or more conditions; I still don't
1786 understand the store mechanism enough to know
1787 what's the safe way to free content from an earlier store.
1788 AFAICT, stores stack, so freeing an early stored item also stores
1789 all data alloc'd after it. If we knew conditions were adjacent,
1790 we could survive that, but we don't. So I *think* we need to take
1791 another bit from opt_type to indicate "malloced"; this seems like
1792 quite a hack, especially for this one case. It also means that
1793 we can't ever reclaim the store from the *first* condition.
1795 Because we only do this once, near process start-up, I'm prepared to
1796 let this slide for the time being, even though it rankles. */
1798 else if (ol->type & opt_rep_str)
1801 Ustrncmp(name, "headers_add", 11) == 0 ? '\n'
1802 : Ustrncmp(name, "set", 3) == 0 ? ';'
1804 int sep_i = -(int)sep_o;
1805 const uschar * list = sptr;
1807 gstring * list_o = NULL;
1811 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1812 list_o = string_cat(list_o, *str_target);
1815 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1816 list_o = string_append_listele(list_o, sep_o, s);
1819 *str_target = string_copy_perm(string_from_gstring(list_o), FALSE);
1830 *USS (US data_block + ol->v.offset) = sptr;
1832 *USS ol->v.value = sptr;
1834 if (type == opt_rewrite)
1839 rewrite_rule **chain;
1842 sprintf(CS name2, "*%.50s_rules", name);
1843 ol2 = find_option(name2, oltop, last);
1844 sprintf(CS name2, "*%.50s_flags", name);
1845 ol3 = find_option(name2, oltop, last);
1848 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1849 "rewrite rules not available for driver");
1853 chain = (rewrite_rule **)(US data_block + ol2->v.offset);
1854 flagptr = (int *)(US data_block + ol3->v.offset);
1858 chain = (rewrite_rule **)ol2->v.value;
1859 flagptr = (int *)ol3->v.value;
1862 /* This will trap if sptr is tainted. Not sure if that can happen */
1863 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1865 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1867 chain = &(next->next);
1870 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1871 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1872 "non-header rewrite - not allowed at transport time -");
1876 /* If it was an expanded uid, see if there is any expansion to be
1877 done by checking for the presence of a $ character. If there is, save it
1878 in the corresponding *expand_user option field. Otherwise, fall through
1879 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1882 case opt_expand_uid:
1883 sprintf(CS name2, "*expand_%.50s", name);
1884 if ((ol2 = find_option(name2, oltop, last)))
1886 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1889 *(USS(US data_block + ol2->v.offset)) = ss;
1891 *(USS ol2->v.value) = ss;
1895 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1901 /* Look up a fixed uid, and also make use of the corresponding gid
1902 if a passwd entry is returned and the gid has not been set. */
1905 if (!route_finduser(sptr, &pw, &uid))
1906 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1908 *(uid_t *)(US data_block + ol->v.offset) = uid;
1910 *(uid_t *)ol->v.value = uid;
1912 /* Set the flag indicating a fixed value is set */
1914 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1916 /* Handle matching gid if we have a passwd entry: done by finding the
1917 same name with terminating "user" changed to "group"; if not found,
1918 ignore. Also ignore if the value is already set. */
1920 if (pw == NULL) break;
1921 Ustrcpy(name+Ustrlen(name)-4, US"group");
1922 ol2 = find_option(name, oltop, last);
1923 if (ol2 && ((ol2->type & opt_mask) == opt_gid ||
1924 (ol2->type & opt_mask) == opt_expand_gid))
1926 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1930 *((gid_t *)(US data_block + ol2->v.offset)) = pw->pw_gid;
1932 *((gid_t *)ol2->v.value) = pw->pw_gid;
1938 /* If it was an expanded gid, see if there is any expansion to be
1939 done by checking for the presence of a $ character. If there is, save it
1940 in the corresponding *expand_user option field. Otherwise, fall through
1941 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1944 case opt_expand_gid:
1945 sprintf(CS name2, "*expand_%.50s", name);
1946 if ((ol2 = find_option(name2, oltop, last)))
1948 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1951 *(USS(US data_block + ol2->v.offset)) = ss;
1953 *(USS ol2->v.value) = ss;
1957 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1963 /* Handle freestanding gid */
1966 if (!route_findgroup(sptr, &gid))
1967 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1969 *((gid_t *)(US data_block + ol->v.offset)) = gid;
1971 *((gid_t *)ol->v.value) = gid;
1972 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1975 /* If it was a uid list, look up each individual entry, and build
1976 a vector of uids, with a count in the first element. Put the vector
1977 in malloc store so we can free the string. (We are reading into
1978 permanent store already.) */
1986 const uschar *op = expand_string (sptr);
1989 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1990 name, expand_string_message);
1993 if (*p != 0) count++;
1994 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1995 list = store_malloc(count*sizeof(uid_t));
1996 list[ptr++] = (uid_t)(count - 1);
1999 *((uid_t **)(US data_block + ol->v.offset)) = list;
2001 *((uid_t **)ol->v.value) = list;
2007 /* If p is tainted we trap. Not sure that can happen */
2008 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2009 if (!route_finduser(big_buffer, NULL, &uid))
2010 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
2017 /* If it was a gid list, look up each individual entry, and build
2018 a vector of gids, with a count in the first element. Put the vector
2019 in malloc store so we can free the string. (We are reading into permanent
2028 const uschar *op = expand_string (sptr);
2031 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2032 name, expand_string_message);
2035 if (*p != 0) count++;
2036 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2037 list = store_malloc(count*sizeof(gid_t));
2038 list[ptr++] = (gid_t)(count - 1);
2041 *((gid_t **)(US data_block + ol->v.offset)) = list;
2043 *((gid_t **)ol->v.value) = list;
2049 /* If p is tainted we trap. Not sure that can happen */
2050 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2051 if (!route_findgroup(big_buffer, &gid))
2052 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2060 /* Release store if the value of the string doesn't need to be kept. */
2062 if (freesptr) reset_point = store_reset(reset_point);
2065 /* Expanded boolean: if no characters follow, or if there are no dollar
2066 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2067 save the string for later expansion in the alternate place. */
2069 case opt_expand_bool:
2070 if (*s && Ustrchr(s, '$') != 0)
2072 sprintf(CS name2, "*expand_%.50s", name);
2073 if ((ol2 = find_option(name2, oltop, last)))
2075 reset_point = store_mark();
2076 sptr = read_string(s, name);
2078 *(USS(US data_block + ol2->v.offset)) = sptr;
2080 *(USS ol2->v.value) = sptr;
2087 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2088 look for yes/not/true/false. Some booleans are stored in a single bit in
2089 a single int. There's a special fudge for verify settings; without a suffix
2090 they set both xx_sender and xx_recipient. The table points to the sender
2091 value; search subsequently for the recipient. There's another special case:
2092 opt_bool_set also notes when a boolean has been set. */
2096 case opt_bool_verify:
2100 s = readconf_readname(name2, EXIM_DRIVERNAME_MAX, s);
2101 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2103 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2105 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2106 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2107 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2108 US"for boolean option ", name);
2111 /* Handle single-bit type. */
2113 if (type == opt_bit)
2115 int bit = 1 << ((ol->type >> 16) & 31);
2116 int * ptr = data_block
2117 ? (int *)(US data_block + ol->v.offset)
2118 : (int *)ol->v.value;
2119 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2123 /* Handle full BOOL types */
2126 *((BOOL *)(US data_block + ol->v.offset)) = boolvalue;
2128 *((BOOL *)ol->v.value) = boolvalue;
2132 if (type == opt_bool_verify)
2134 sprintf(CS name2, "%.50s_recipient", name + offset);
2135 if ((ol2 = find_option(name2, oltop, last)))
2137 *((BOOL *)(US data_block + ol2->v.offset)) = boolvalue;
2139 *((BOOL *)ol2->v.value) = boolvalue;
2142 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2144 else if (type == opt_bool_set)
2146 sprintf(CS name2, "*set_%.50s", name + offset);
2147 if ((ol2 = find_option(name2, oltop, last)))
2149 *((BOOL *)(US data_block + ol2->v.offset)) = TRUE;
2151 *((BOOL *)ol2->v.value) = TRUE;
2159 inttype = US"octal ";
2161 /* Integer: a simple(ish) case; allow octal and hex formats, and
2162 suffixes K, M, G, and T. The different types affect output, not input. */
2171 lvalue = strtol(CS s, CSS &endptr, intbase);
2174 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2177 if (errno != ERANGE && *endptr)
2179 uschar * mp = US"TtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2181 if ((mp = Ustrchr(mp, *endptr)))
2186 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2197 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2198 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2199 "absolute value of integer \"%s\" is too large (overflow)", s);
2201 while (isspace(*endptr)) endptr++;
2203 extra_chars_error(endptr, inttype, US"integer value for ", name);
2205 value = (int)lvalue;
2209 *(int *)(US data_block + ol->v.offset) = value;
2211 *(int *)ol->v.value = value;
2214 /* Integer held in K: again, allow formats and suffixes as above. */
2220 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2223 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2226 if (errno != ERANGE && *endptr)
2228 uschar * mp = US"ZzEePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2230 if ((mp = Ustrchr(mp, *endptr)))
2235 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2244 lvalue = (lvalue + 512)/1024;
2247 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2248 "absolute value of integer \"%s\" is too large (overflow)", s);
2250 while (isspace(*endptr)) endptr++;
2252 extra_chars_error(endptr, inttype, US"integer value for ", name);
2255 *(int_eximarith_t *)(US data_block + ol->v.offset) = lvalue;
2257 *(int_eximarith_t *)ol->v.value = lvalue;
2261 /* Fixed-point number: held to 3 decimal places. */
2264 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2265 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2266 "fixed-point number expected for %s", name);
2268 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2269 "integer \"%s\" is too large (overflow)", s);
2273 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2274 "integer \"%s\" is too large (overflow)", s);
2276 /* We get a coverity error here for using count, as it derived
2277 from the tainted buffer pointed to by s, as parsed by sscanf().
2278 By the definition of sscanf we must be accessing between start
2279 and end of s (assuming it is nul-terminated...) so ignore the error. */
2280 /* coverity[tainted_data] */
2281 if (s[count] == '.')
2284 while (isdigit(s[++count]))
2286 value += (s[count] - '0') * d;
2291 while (isspace(s[count])) count++;
2294 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2297 *((int *)(US data_block + ol->v.offset)) = value;
2299 *((int *)ol->v.value) = value;
2302 /* There's a special routine to read time values. */
2305 value = readconf_readtime(s, 0, FALSE);
2307 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2310 *((int *)(US data_block + ol->v.offset)) = value;
2312 *((int *)ol->v.value) = value;
2315 /* A time list is a list of colon-separated times, with the first
2316 element holding the size of the list and the second the number of
2322 int * list = data_block
2323 ? (int *)(US data_block + ol->v.offset)
2324 : (int *)ol->v.value;
2326 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2329 uschar *snext = Ustrchr(s, ':');
2333 while (ss > s && isspace(ss[-1])) ss--;
2336 value = readconf_readtime(s, terminator, FALSE);
2338 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2340 if (count > 1 && value <= list[count])
2341 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2342 "time value out of order for %s", name);
2343 list[count+1] = value;
2344 if (snext == NULL) break;
2346 while (isspace(*s)) s++;
2349 if (count > list[0] - 2)
2350 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2352 if (count > 0 && list[2] == 0) count = 0;
2359 void (*fn)() = ol->v.fn;
2370 /*************************************************
2371 * Print a time value *
2372 *************************************************/
2375 Argument: a time value in seconds
2376 Returns: pointer to a fixed buffer containing the time as a string,
2377 in readconf_readtime() format
2381 readconf_printtime(int t)
2384 uschar *p = time_buffer;
2401 if (w > 0) p += sprintf(CS p, "%dw", w);
2402 if (d > 0) p += sprintf(CS p, "%dd", d);
2403 if (h > 0) p += sprintf(CS p, "%dh", h);
2404 if (m > 0) p += sprintf(CS p, "%dm", m);
2405 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2412 /*************************************************
2413 * Print an individual option value *
2414 *************************************************/
2416 /* This is used by the -bP option, so prints to the standard output.
2417 The entire options list is passed in as an argument, because some options come
2418 in pairs - typically uid/gid settings, which can either be explicit numerical
2419 values, or strings to be expanded later. If the numerical value is unset,
2420 search for "*expand_<name>" to see if there is a string equivalent.
2423 ol option entry, or NULL for an unknown option
2425 options_block NULL for main configuration options; otherwise points to
2426 a driver block; if the option doesn't have opt_public
2427 set, then options_block->options_block is where the item
2429 oltop points to the option list in which ol exists
2430 last one more than the offset of the last entry in optop
2431 no_labels do not show "foo = " at the start.
2433 Returns: boolean success
2437 print_ol(optionlist *ol, const uschar *name, void *options_block,
2438 optionlist *oltop, int last, BOOL no_labels)
2447 uschar name2[EXIM_DRIVERNAME_MAX];
2451 printf("%s is not a known option\n", name);
2455 /* Non-admin callers cannot see options that have been flagged secure by the
2458 if (!f.admin_user && ol->type & opt_secure)
2461 printf("%s\n", CCS hidden);
2463 printf("%s = %s\n", name, CCS hidden);
2467 /* Else show the value of the option */
2469 value = ol->v.value;
2472 if (!(ol->type & opt_public))
2473 options_block = (void *)(((driver_instance *)options_block)->options_block);
2474 value = (void *)(US options_block + (long int)value);
2477 switch(ol->type & opt_mask)
2480 case opt_rewrite: /* Show the text value */
2482 if (!no_labels) printf("%s = ", name);
2483 printf("%s\n", s ? string_printing2(s, SP_TAB) : US"");
2487 if (!no_labels) printf("%s = ", name);
2488 printf("%d\n", *((int *)value));
2493 int x = *((int *)value);
2494 if (x != 0 && (x & 1023) == 0)
2498 if ((x & 1023) == 0)
2503 if (!no_labels) printf("%s = ", name);
2504 printf("%d%c\n", x, c);
2508 if (!no_labels) printf("%s = ", name);
2516 int_eximarith_t x = *((int_eximarith_t *)value);
2517 if (!no_labels) printf("%s = ", name);
2518 if (x == 0) printf("0\n");
2519 else if ((x & ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH "T\n", x >> 30);
2520 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2521 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2522 else printf(PR_EXIM_ARITH "K\n", x);
2527 if (!no_labels) printf("%s = ", name);
2528 printf("%#o\n", *((int *)value));
2531 /* Can be negative only when "unset", in which case integer */
2535 int x = *((int *)value);
2538 if (x < 0) printf("%s =\n", name); else
2540 if (!no_labels) printf("%s = ", name);
2541 printf("%d.", x/1000);
2554 /* If the numerical value is unset, try for the string value */
2556 case opt_expand_uid:
2557 if (! *get_set_flag(name, oltop, last, options_block))
2559 sprintf(CS name2, "*expand_%.50s", name);
2560 if ((ol2 = find_option(name2, oltop, last)))
2563 s = *USS (US options_block + ol2->v.offset);
2565 s = *USS ol2->v.value;
2566 if (!no_labels) printf("%s = ", name);
2567 printf("%s\n", s ? string_printing(s) : US"");
2572 /* Else fall through */
2575 if (!no_labels) printf("%s = ", name);
2576 if (! *get_set_flag(name, oltop, last, options_block))
2579 if ((pw = getpwuid(*((uid_t *)value))))
2580 printf("%s\n", pw->pw_name);
2582 printf("%ld\n", (long int)(*((uid_t *)value)));
2585 /* If the numerical value is unset, try for the string value */
2587 case opt_expand_gid:
2588 if (! *get_set_flag(name, oltop, last, options_block))
2590 sprintf(CS name2, "*expand_%.50s", name);
2591 if ( (ol2 = find_option(name2, oltop, last))
2592 && (ol2->type & opt_mask) == opt_stringptr)
2595 s = *USS (US options_block + ol2->v.offset);
2597 s = *USS ol2->v.value;
2598 if (!no_labels) printf("%s = ", name);
2599 printf("%s\n", s ? string_printing(s) : US"");
2604 /* Else fall through */
2607 if (!no_labels) printf("%s = ", name);
2608 if (! *get_set_flag(name, oltop, last, options_block))
2611 if ((gr = getgrgid(*((int *)value))))
2612 printf("%s\n", gr->gr_name);
2614 printf("%ld\n", (long int)(*((int *)value)));
2618 uidlist = *((uid_t **)value);
2619 if (!no_labels) printf("%s =", name);
2622 uschar sep = no_labels ? '\0' : ' ';
2623 for (int i = 1; i <= (int)(uidlist[0]); i++)
2625 uschar *name = NULL;
2626 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2627 if (sep != '\0') printf("%c", sep);
2628 if (name) printf("%s", name);
2629 else printf("%ld", (long int)(uidlist[i]));
2637 gidlist = *((gid_t **)value);
2638 if (!no_labels) printf("%s =", name);
2641 uschar sep = no_labels ? '\0' : ' ';
2642 for (int i = 1; i <= (int)(gidlist[0]); i++)
2644 uschar *name = NULL;
2645 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2646 if (sep != '\0') printf("%c", sep);
2647 if (name) printf("%s", name);
2648 else printf("%ld", (long int)(gidlist[i]));
2656 if (!no_labels) printf("%s = ", name);
2657 printf("%s\n", readconf_printtime(*((int *)value)));
2662 int *list = (int *)value;
2663 if (!no_labels) printf("%s = ", name);
2664 for (int i = 0; i < list[1]; i++)
2665 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2671 printf("%s%s\n", (*((int *)value)) & (1 << ((ol->type >> 16) & 31))
2672 ? "" : "no_", name);
2675 case opt_expand_bool:
2676 sprintf(CS name2, "*expand_%.50s", name);
2677 if ((ol2 = find_option(name2, oltop, last)) && ol2->v.value)
2680 s = *USS (US options_block + ol2->v.offset);
2682 s = *USS ol2->v.value;
2685 if (!no_labels) printf("%s = ", name);
2686 printf("%s\n", string_printing(s));
2689 /* s == NULL => string not set; fall through */
2695 case opt_bool_verify:
2697 printf("%s%s\n", *((BOOL *)value) ? "" : "no_", name);
2701 ol->v.fn(name, NULL, no_labels ? opt_fn_print : opt_fn_print|opt_fn_print_label);
2709 /*************************************************
2710 * Print value from main configuration *
2711 *************************************************/
2713 /* This function, called as a result of encountering the -bP option,
2714 causes the value of any main configuration variable to be output if the
2715 second argument is NULL. There are some special values:
2717 all print all main configuration options
2718 config_file print the name of the configuration file
2719 (configure_file will still work, for backward
2721 routers print the routers' configurations
2722 transports print the transports' configuration
2723 authenticators print the authenticators' configuration
2724 macros print the macros' configuration
2725 router_list print a list of router names
2726 transport_list print a list of transport names
2727 authenticator_list print a list of authentication mechanism names
2728 macro_list print a list of macro names
2729 +name print a named list item
2730 local_scan print the local_scan options
2731 config print the configuration as it is parsed
2732 environment print the used execution environment
2734 If the second argument is not NULL, it must be one of "router", "transport",
2735 "authenticator" or "macro" in which case the first argument identifies the
2736 driver whose options are to be printed.
2739 name option name if type == NULL; else driver name
2740 type NULL or driver type name, as described above
2741 no_labels avoid the "foo = " at the start of an item
2743 Returns: Boolean success
2747 readconf_print(const uschar *name, uschar *type, BOOL no_labels)
2749 BOOL names_only = FALSE;
2750 optionlist *ol2 = NULL;
2751 driver_instance *d = NULL;
2760 static uschar *types[] = { US"address", US"domain", US"host",
2762 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2763 &hostlist_anchor, &localpartlist_anchor };
2765 for (int i = 0; i < 4; i++)
2766 if ((t = tree_search(*(anchors[i]), name+1)))
2768 namedlist_block * nb = t->data.ptr;
2769 const uschar * s = nb->hide ? hidden : nb->string;
2772 printf("%s\n", CCS s);
2774 printf("%slist %s = %s\n", types[i], name+1, CCS s);
2778 printf("no address, domain, host, or local part list called \"%s\" "
2779 "exists\n", name+1);
2784 if ( Ustrcmp(name, "configure_file") == 0
2785 || Ustrcmp(name, "config_file") == 0)
2787 printf("%s\n", CS config_main_filename);
2791 if (Ustrcmp(name, "all") == 0)
2793 for (optionlist * ol = optionlist_config;
2794 ol < optionlist_config + nelem(optionlist_config); ol++)
2795 if (!(ol->type & opt_hidden))
2796 (void) print_ol(ol, US ol->name, NULL,
2797 optionlist_config, nelem(optionlist_config),
2802 if (Ustrcmp(name, "local_scan") == 0)
2804 #ifndef LOCAL_SCAN_HAS_OPTIONS
2805 printf("local_scan() options are not supported\n");
2808 for (optionlist * ol = local_scan_options;
2809 ol < local_scan_options + local_scan_options_count; ol++)
2810 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2811 local_scan_options_count, no_labels);
2816 if (Ustrcmp(name, "config") == 0)
2818 print_config(f.admin_user, no_labels);
2822 if (Ustrcmp(name, "routers") == 0)
2827 else if (Ustrcmp(name, "transports") == 0)
2829 type = US"transport";
2832 else if (Ustrcmp(name, "authenticators") == 0)
2834 type = US"authenticator";
2837 else if (Ustrcmp(name, "macros") == 0)
2842 else if (Ustrcmp(name, "router_list") == 0)
2848 else if (Ustrcmp(name, "transport_list") == 0)
2850 type = US"transport";
2854 else if (Ustrcmp(name, "authenticator_list") == 0)
2856 type = US"authenticator";
2860 else if (Ustrcmp(name, "macro_list") == 0)
2866 else if (Ustrcmp(name, "environment") == 0)
2871 for (p = USS environ; *p; p++) ;
2872 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2874 for (p = USS environ; *p; p++)
2877 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2885 return print_ol(find_option(name,
2886 optionlist_config, nelem(optionlist_config)),
2887 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2890 /* Handle the options for a router or transport. Skip options that are flagged
2891 as hidden. Some of these are options with names starting with '*', used for
2892 internal alternative representations of other options (which the printing
2893 function will sort out). Others are synonyms kept for backward compatibility.
2896 if (Ustrcmp(type, "router") == 0)
2898 d = (driver_instance *)routers;
2899 ol2 = optionlist_routers;
2900 size = optionlist_routers_size;
2902 else if (Ustrcmp(type, "transport") == 0)
2904 d = (driver_instance *)transports;
2905 ol2 = optionlist_transports;
2906 size = optionlist_transports_size;
2908 else if (Ustrcmp(type, "authenticator") == 0)
2910 d = (driver_instance *)auths;
2911 ol2 = optionlist_auths;
2912 size = optionlist_auths_size;
2915 else if (Ustrcmp(type, "macro") == 0)
2917 /* People store passwords in macros and they were previously not available
2918 for printing. So we have an admin_users restriction. */
2921 fprintf(stderr, "exim: permission denied\n");
2924 for (macro_item * m = macros; m; m = m->next)
2925 if (!name || Ustrcmp(name, m->name) == 0)
2928 printf("%s\n", CS m->name);
2930 printf("%s\n", CS m->replacement);
2932 printf("%s=%s\n", CS m->name, CS m->replacement);
2936 if (!name) return TRUE;
2938 printf("%s %s not found\n", type, name);
2944 for (; d; d = d->next) printf("%s\n", CS d->name);
2948 /* Either search for a given driver, or print all of them */
2950 for (; d; d = d->next)
2954 printf("\n%s %s:\n", d->name, type);
2955 else if (Ustrcmp(d->name, name) != 0) continue;
2957 for (optionlist * ol = ol2; ol < ol2 + size; ol++)
2958 if (!(ol->type & opt_hidden))
2959 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2961 for (optionlist * ol = d->info->options;
2962 ol < d->info->options + *(d->info->options_count); ol++)
2963 if (!(ol->type & opt_hidden))
2964 rc |= print_ol(ol, US ol->name, d, d->info->options,
2965 *d->info->options_count, no_labels);
2967 if (name) return rc;
2969 if (!name) return TRUE;
2971 printf("%s %s not found\n", type, name);
2977 /*************************************************
2978 * Read a named list item *
2979 *************************************************/
2981 /* This function reads a name and a list (i.e. string). The name is used to
2982 save the list in a tree, sorted by its name. Each entry also has a number,
2983 which can be used for caching tests, but if the string contains any expansion
2984 items other than $key, the number is set negative to inhibit caching. This
2985 mechanism is used for domain, host, and address lists that are referenced by
2989 anchorp points to the tree anchor
2990 numberp points to the current number for this tree
2991 max the maximum number permitted
2992 s the text of the option line, starting immediately after the name
2994 tname the name of the list type, for messages
2995 hide do not output value on "-bP"
3001 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
3002 uschar *tname, BOOL hide)
3004 BOOL forcecache = FALSE;
3007 namedlist_block * nb = store_get_perm(sizeof(namedlist_block), FALSE);
3009 if (Ustrncmp(s, "_cache", 6) == 0)
3016 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
3018 if (*numberp >= max)
3019 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3022 Uskip_whitespace(&s);
3024 while (isalnum(*s) || *s == '_') s++;
3025 t = store_get(sizeof(tree_node) + s-ss, ss);
3026 Ustrncpy(t->name, ss, s-ss);
3028 Uskip_whitespace(&s);
3030 if (!tree_insertnode(anchorp, t))
3031 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3032 "duplicate name \"%s\" for a named %s", t->name, tname);
3035 nb->number = *numberp;
3039 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3040 "missing '=' after \"%s\"", t->name);
3041 Uskip_whitespace(&s);
3042 nb->string = read_string(s, t->name);
3043 nb->cache_data = NULL;
3045 /* Check the string for any expansions; if any are found, mark this list
3046 uncacheable unless the user has explicited forced caching. */
3048 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3054 /*************************************************
3055 * Unpick data for a rate limit *
3056 *************************************************/
3058 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3062 s string, in the form t,b,f,l
3063 where t is the threshold (integer)
3064 b is the initial delay (time)
3065 f is the multiplicative factor (fixed point)
3066 k is the maximum time (time)
3067 threshold where to store threshold
3068 base where to store base in milliseconds
3069 factor where to store factor in milliseconds
3070 limit where to store limit
3072 Returns: nothing (panics on error)
3076 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3079 uschar bstring[16], lstring[16];
3081 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3082 factor, lstring) == 4)
3084 *base = readconf_readtime(bstring, 0, TRUE);
3085 *limit = readconf_readtime(lstring, 0, TRUE);
3086 if (*base >= 0 && *limit >= 0) return;
3088 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3094 /*************************************************
3095 * Read main configuration options *
3096 *************************************************/
3098 /* This function is the first to be called for configuration reading. It
3099 opens the configuration file and reads general configuration settings until
3100 it reaches the end of the configuration section. The file is then left open so
3101 that the remaining configuration data can subsequently be read if needed for
3104 The configuration file must be owned either by root or exim, and be writeable
3105 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3106 in the config file, so the test is done on the compiled in values. A slight
3107 anomaly, to be carefully documented.
3109 The name of the configuration file is taken from a list that is included in the
3110 binary of Exim. It can be altered from the command line, but if that is done,
3111 root privilege is immediately withdrawn unless the caller is root or exim.
3112 The first file on the list that exists is used.
3114 For use on multiple systems that share file systems, first look for a
3115 configuration file whose name has the current node name on the end. If that is
3116 not found, try the generic name. For really contorted configurations, that run
3117 multiple Exims with different uid settings, first try adding the effective uid
3118 before the node name. These complications are going to waste resources on most
3119 systems. Therefore they are available only when requested by compile-time
3123 readconf_main(BOOL nowarn)
3126 struct stat statbuf;
3127 uschar *s, *filename;
3128 const uschar *list = config_main_filelist;
3130 /* Loop through the possible file names */
3132 /* Should never be a tainted list */
3133 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3136 /* Cut out all the fancy processing unless specifically wanted */
3138 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3139 uschar *suffix = filename + Ustrlen(filename);
3141 /* Try for the node-specific file if a node name exists */
3143 # ifdef CONFIGURE_FILE_USE_NODE
3145 if (uname(&uts) >= 0)
3147 # ifdef CONFIGURE_FILE_USE_EUID
3148 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3149 if (!(config_file = Ufopen(filename, "rb")))
3150 # endif /* CONFIGURE_FILE_USE_EUID */
3152 sprintf(CS suffix, ".%.256s", uts.nodename);
3153 config_file = Ufopen(filename, "rb");
3156 # endif /* CONFIGURE_FILE_USE_NODE */
3158 /* Otherwise, try the generic name, possibly with the euid added */
3160 # ifdef CONFIGURE_FILE_USE_EUID
3163 sprintf(CS suffix, ".%ld", (long int)original_euid);
3164 config_file = Ufopen(filename, "rb");
3166 # endif /* CONFIGURE_FILE_USE_EUID */
3168 /* Finally, try the unadorned name */
3173 config_file = Ufopen(filename, "rb");
3175 #else /* if neither defined */
3177 /* This is the common case when the fancy processing is not included. */
3179 config_file = Ufopen(filename, "rb");
3182 /* If the file does not exist, continue to try any others. For any other
3183 error, break out (and die). */
3185 if (config_file || errno != ENOENT) break;
3188 /* On success, save the name for verification; config_filename is used when
3189 logging configuration errors (it changes for .included files) whereas
3190 config_main_filename is the name shown by -bP. Failure to open a configuration
3191 file is a serious disaster. */
3195 uschar *last_slash = Ustrrchr(filename, '/');
3196 config_filename = config_main_filename = string_copy(filename);
3198 /* The config_main_directory we need for the $config_dir expansion.
3199 config_main_filename we need for $config_file expansion.
3200 And config_dir is the directory of the current configuration, used for
3201 relative .includes. We do need to know it's name, as we change our working
3204 if (filename[0] == '/')
3205 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3208 /* relative configuration file name: working dir + / + basename(filename) */
3210 uschar buf[PATH_MAX];
3213 if (os_getcwd(buf, PATH_MAX) == NULL)
3215 perror("exim: getcwd");
3218 g = string_cat(NULL, buf);
3220 /* If the dir does not end with a "/", append one */
3221 if (g->s[g->ptr-1] != '/')
3222 g = string_catn(g, US"/", 1);
3224 /* If the config file contains a "/", extract the directory part */
3226 g = string_catn(g, filename, last_slash - filename);
3228 config_main_directory = string_from_gstring(g);
3230 config_directory = config_main_directory;
3234 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3235 "%s", config_main_filelist);
3237 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
3238 string_open_failed("configuration file %s", filename));
3240 /* Now, once we found and opened our configuration file, we change the directory
3241 to a safe place. Later we change to $spool_directory. */
3243 if (Uchdir("/") < 0)
3245 perror("exim: chdir `/': ");
3249 /* Check the status of the file we have opened, if we have retained root
3250 privileges and the file isn't /dev/null (which *should* be 0666). */
3252 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3254 if (fstat(fileno(config_file), &statbuf) != 0)
3255 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3258 if ( statbuf.st_uid != root_uid /* owner not root */
3259 #ifdef CONFIGURE_OWNER
3260 && statbuf.st_uid != config_uid /* owner not the special one */
3263 statbuf.st_gid != root_gid /* group not root & */
3264 #ifdef CONFIGURE_GROUP
3265 && statbuf.st_gid != config_gid /* group not the special one */
3267 && (statbuf.st_mode & 020) != 0 /* group writeable */
3269 (statbuf.st_mode & 2) != 0 /* world writeable */
3271 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3272 "wrong owner, group, or mode", big_buffer);
3274 /* Do a dummy store-allocation of a size related to the (toplevel) file size.
3275 This assumes we will need this much storage to handle all the allocations
3276 during startup; it won't help when .include is being used. When it does, it
3277 will cut down on the number of store blocks (and malloc calls, and sbrk
3278 syscalls). It also assume we're on the relevant pool. */
3280 if (statbuf.st_size > 8192)
3282 rmark r = store_mark();
3283 void * dummy = store_get((int)statbuf.st_size, GET_UNTAINTED);
3288 /* Process the main configuration settings. They all begin with a lower case
3289 letter. If we see something starting with an upper case letter, it is taken as
3290 a macro definition. */
3292 while ((s = get_config_line()))
3297 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3298 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3299 "found unexpected BOM (Byte Order Mark)");
3303 if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE);
3307 t = (hide = Ustrncmp(s, "hide", 4) == 0 && isspace(s[4])) ? s + 5 : s;
3309 if (Ustrncmp(t, "domainlist", 10) == 0)
3310 read_named_list(&domainlist_anchor, &domainlist_count,
3311 MAX_NAMED_LIST, t+10, US"domain list", hide);
3313 else if (Ustrncmp(t, "hostlist", 8) == 0)
3314 read_named_list(&hostlist_anchor, &hostlist_count,
3315 MAX_NAMED_LIST, t+8, US"host list", hide);
3317 else if (Ustrncmp(t, "addresslist", 11) == 0)
3318 read_named_list(&addresslist_anchor, &addresslist_count,
3319 MAX_NAMED_LIST, t+11, US"address list", hide);
3321 else if (Ustrncmp(t, "localpartlist", 13) == 0)
3322 read_named_list(&localpartlist_anchor, &localpartlist_count,
3323 MAX_NAMED_LIST, t+13, US"local part list", hide);
3326 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3327 NULL, US"main option \"%s\" unknown");
3331 /* If local_sender_retain is set, local_from_check must be unset. */
3333 if (local_sender_retain && local_from_check)
3334 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3335 "local_sender_retain are set; this combination is not allowed");
3337 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3340 if (timezone_string && !*timezone_string) timezone_string = NULL;
3342 /* The max retry interval must not be greater than 24 hours. */
3344 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3346 /* remote_max_parallel must be > 0 */
3348 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3350 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3351 start of a new SMTP message. */
3353 freeze_tell_config = freeze_tell;
3355 /* The primary host name may be required for expansion of spool_directory
3356 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3357 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3358 canonize it. Some people like upper case letters in their host names, so we
3359 don't force the case. */
3361 if (!primary_hostname)
3363 const uschar * hostname;
3366 if (uname(&uts) < 0)
3367 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3368 hostname = US uts.nodename;
3370 if (Ustrchr(hostname, '.') == NULL)
3373 struct hostent *hostdata;
3377 && ( !dns_ipv4_lookup
3378 || match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3379 MCL_DOMAIN, TRUE, NULL) != OK))
3386 # if HAVE_GETIPNODEBYNAME
3388 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3390 hostdata = gethostbyname2(CS hostname, af);
3393 hostdata = gethostbyname(CS hostname);
3397 { hostname = US hostdata->h_name; break; }
3399 if (af == AF_INET) break;
3404 primary_hostname = string_copy(hostname);
3407 /* Set up default value for smtp_active_hostname */
3409 smtp_active_hostname = primary_hostname;
3411 /* If spool_directory wasn't set in the build-time configuration, it must have
3412 got set above. Of course, writing to the log may not work if log_file_path is
3413 not set, but it will at least get to syslog or somewhere, with any luck. */
3415 if (!*spool_directory)
3416 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3419 /* Expand the spool directory name; it may, for example, contain the primary
3420 host name. Same comment about failure. */
3422 if (!(s = expand_string(spool_directory)))
3423 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3424 "\"%s\": %s", spool_directory, expand_string_message);
3425 spool_directory = s;
3427 /* Expand log_file_path, which must contain "%s" in any component that isn't
3428 the null string or "syslog". It is also allowed to contain one instance of %D
3429 or %M. However, it must NOT contain % followed by anything else. */
3433 const uschar *ss, *sss;
3434 int sep = ':'; /* Fixed for log file path */
3435 if (!(s = expand_string(log_file_path)))
3436 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3437 "\"%s\": %s", log_file_path, expand_string_message);
3440 /* should never be a tainted list */
3441 while ((sss = string_nextinlist(&ss, &sep, big_buffer, big_buffer_size)))
3444 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3445 if (!(t = Ustrstr(sss, "%s")))
3446 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3447 "contain \"%%s\"", sss);
3449 if ((t = Ustrchr(sss, '%')))
3450 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3451 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3452 "unexpected \"%%\" character", s);
3458 /* Interpret syslog_facility into an integer argument for 'ident' param to
3459 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3462 if (syslog_facility_str)
3465 uschar *s = syslog_facility_str;
3467 if ((Ustrlen(syslog_facility_str) >= 4) &&
3468 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3471 for (i = 0; i < syslog_list_size; i++)
3472 if (strcmpic(s, syslog_list[i].name) == 0)
3474 syslog_facility = syslog_list[i].value;
3478 if (i >= syslog_list_size)
3479 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3480 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3483 /* Expand pid_file_path */
3487 if (!(s = expand_string(pid_file_path)))
3488 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3489 "\"%s\": %s", pid_file_path, expand_string_message);
3493 /* Set default value of process_log_path */
3495 if (!process_log_path || !*process_log_path)
3496 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3498 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3501 regex_From = regex_must_compile(uucp_from_pattern, MCS_NOFLAGS, TRUE);
3503 /* Unpick the SMTP rate limiting options, if set */
3505 if (smtp_ratelimit_mail)
3506 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3507 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3509 if (smtp_ratelimit_rcpt)
3510 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3511 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3513 /* The qualify domains default to the primary host name */
3515 if (!qualify_domain_sender)
3516 qualify_domain_sender = primary_hostname;
3517 if (!qualify_domain_recipient)
3518 qualify_domain_recipient = qualify_domain_sender;
3520 /* Setting system_filter_user in the configuration sets the gid as well if a
3521 name is given, but a numerical value does not. */
3523 if (system_filter_uid_set && !system_filter_gid_set)
3525 struct passwd *pw = getpwuid(system_filter_uid);
3527 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3528 (long int)system_filter_uid);
3529 system_filter_gid = pw->pw_gid;
3530 system_filter_gid_set = TRUE;
3533 /* If the errors_reply_to field is set, check that it is syntactically valid
3534 and ensure it contains a domain. */
3536 if (errors_reply_to)
3539 int start, end, domain;
3540 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3541 &start, &end, &domain, FALSE);
3544 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3545 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3548 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3549 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3552 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3553 smtp_accept_max must also be set. */
3555 if (smtp_accept_max == 0 && (smtp_accept_queue > 0 || smtp_accept_max_per_host))
3556 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3557 "smtp_accept_max must be set if smtp_accept_queue or "
3558 "smtp_accept_max_per_host is set");
3560 /* Set up the host number if anything is specified. It is an expanded string
3561 so that it can be computed from the host name, for example. We do this last
3562 so as to ensure that everything else is set up before the expansion. */
3564 if (host_number_string)
3568 uschar *s = expand_string(host_number_string);
3571 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3572 "failed to expand localhost_number \"%s\": %s",
3573 host_number_string, expand_string_message);
3574 n = Ustrtol(s, &end, 0);
3575 while (isspace(*end)) end++;
3577 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3578 "localhost_number value is not a number: %s", s);
3579 if (n > LOCALHOST_MAX)
3580 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3581 "localhost_number is greater than the maximum allowed value (%d)",
3587 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3589 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3590 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3591 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3592 tls_verify_hosts ? "" : "try_");
3594 /* Magic number: at time of writing, 1024 has been the long-standing value
3595 used by so many clients, and what Exim used to use always, that it makes
3596 sense to just min-clamp this max-clamp at that. */
3597 if (tls_dh_max_bits < 1024)
3598 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3599 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3601 /* If openssl_options is set, validate it */
3602 if (openssl_options)
3605 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3606 "openssl_options is set but we're using GnuTLS");
3609 if (!tls_openssl_options_parse(openssl_options, &dummy))
3610 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3611 "openssl_options parse error: %s", openssl_options);
3614 #endif /*DISABLE_TLS*/
3616 if (!nowarn && !keep_environment && environ && *environ)
3617 log_write(0, LOG_MAIN,
3618 "Warning: purging the environment.\n"
3619 " Suggested action: use keep_environment.");
3624 /*************************************************
3625 * Initialize one driver *
3626 *************************************************/
3628 /* This is called once the driver's generic options, if any, have been read.
3629 We can now find the driver, set up defaults for the private options, and
3630 unset any "set" bits in the private options table (which might have been
3631 set by another incarnation of the same driver).
3634 d pointer to driver instance block, with generic
3636 drivers_available vector of available drivers
3637 size_of_info size of each block in drivers_available
3638 class class of driver, for error message
3640 Returns: pointer to the driver info block
3643 static driver_info *
3644 init_driver(driver_instance *d, driver_info *drivers_available,
3645 int size_of_info, uschar *class)
3647 for (driver_info * dd = drivers_available; dd->driver_name[0] != 0;
3648 dd = (driver_info *)((US dd) + size_of_info))
3649 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3651 int len = dd->options_len;
3653 d->options_block = store_get_perm(len, FALSE);
3654 memcpy(d->options_block, dd->options_block, len);
3655 for (int i = 0; i < *(dd->options_count); i++)
3656 dd->options[i].type &= ~opt_set;
3660 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3661 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3663 return NULL; /* never obeyed */
3670 driver_init_fini(driver_instance * d, const uschar * class)
3672 if (!d->driver_name)
3673 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3674 "no driver defined for %s \"%s\"", class, d->name);
3679 /*************************************************
3680 * Initialize driver list *
3681 *************************************************/
3683 /* This function is called for routers, transports, and authentication
3684 mechanisms. It reads the data from the current point in the configuration file
3685 up to the end of the section, and sets up a chain of instance blocks according
3686 to the file's contents. The file will already have been opened by a call to
3687 readconf_main, and must be left open for subsequent reading of further data.
3689 Any errors cause a panic crash. Note that the blocks with names driver_info and
3690 driver_instance must map the first portions of all the _info and _instance
3691 blocks for this shared code to work.
3694 class "router", "transport", or "authenticator"
3695 anchor &routers, &transports, &auths
3696 drivers_available available drivers
3697 size_of_info size of each info block
3698 instance_default points to default data for an instance
3699 instance_size size of instance block
3700 driver_optionlist generic option list
3701 driver_optionlist_count count of generic option list
3707 readconf_driver_init(
3709 driver_instance **anchor,
3710 driver_info *drivers_available,
3712 void *instance_default,
3714 optionlist *driver_optionlist,
3715 int driver_optionlist_count)
3717 driver_instance ** p = anchor;
3718 driver_instance * d = NULL;
3721 while ((buffer = get_config_line()))
3723 uschar name[EXIM_DRIVERNAME_MAX];
3726 /* Read the first name on the line and test for the start of a new driver. A
3727 macro definition indicates the end of the previous driver. If this isn't the
3728 start of a new driver, the line will be re-read. */
3730 s = readconf_readname(name, sizeof(name), buffer);
3732 /* Handle macro definition, first finishing off the initialization of the
3733 previous driver, if any. */
3735 if (isupper(*name) && *s == '=')
3739 /* s is using big_buffer, so this call had better not */
3740 driver_init_fini(d, class);
3743 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE);
3747 /* If the line starts with a name terminated by a colon, we are at the
3748 start of the definition of a new driver. The rest of the line must be
3753 /* Finish off initializing the previous driver. */
3756 driver_init_fini(d, class);
3758 /* Check that we haven't already got a driver of this name */
3760 for (d = *anchor; d; d = d->next)
3761 if (Ustrcmp(name, d->name) == 0)
3762 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3763 "there are two %ss called \"%s\"", class, name);
3765 /* Set up a new driver instance data block on the chain, with
3766 its default values installed. */
3768 d = store_get_perm(instance_size, FALSE);
3769 memcpy(d, instance_default, instance_size);
3772 d->name = string_copy(name);
3773 d->srcfile = config_filename;
3774 d->srcline = config_lineno;
3776 /* Clear out the "set" bits in the generic options */
3778 for (int i = 0; i < driver_optionlist_count; i++)
3779 driver_optionlist[i].type &= ~opt_set;
3781 /* Check nothing more on this line, then do the next loop iteration. */
3783 Uskip_whitespace(&s);
3784 if (*s) extra_chars_error(s, US"driver name ", name, US"");
3788 /* Not the start of a new driver. Give an error if we have not set up a
3789 current driver yet. */
3792 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3794 /* First look to see if this is a generic option; if it is "driver",
3795 initialize the driver. If is it not a generic option, we can look for a
3796 private option provided that the driver has been previously set up. */
3798 if (readconf_handle_option(buffer, driver_optionlist,
3799 driver_optionlist_count, d, NULL))
3801 if (!d->info && d->driver_name)
3802 init_driver(d, drivers_available, size_of_info, class);
3805 /* Handle private options - pass the generic block because some may
3806 live therein. A flag with each option indicates if it is in the public
3810 readconf_handle_option(buffer, d->info->options,
3811 *(d->info->options_count), d, US"option \"%s\" unknown");
3813 /* The option is not generic and the driver name has not yet been given. */
3815 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3816 "(\"driver\" must be specified before any private options)", name);
3819 /* Run the initialization function for the final driver. */
3822 driver_init_fini(d, class);
3827 /*************************************************
3828 * Check driver dependency *
3829 *************************************************/
3831 /* This function is passed a driver instance and a string. It checks whether
3832 any of the string options for the driver contains the given string as an
3836 d points to a driver instance block
3837 s the string to search for
3839 Returns: TRUE if a dependency is found
3843 readconf_depends(driver_instance *d, uschar *s)
3845 int count = *(d->info->options_count);
3848 for (optionlist * ol = d->info->options; ol < d->info->options + count; ol++)
3849 if ((ol->type & opt_mask) == opt_stringptr)
3851 void * options_block = ol->type & opt_public ? (void *)d : d->options_block;
3852 uschar * value = *USS(US options_block + ol->v.offset);
3854 if (value && (ss = Ustrstr(value, s)) != NULL)
3856 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3857 isalnum(ss[Ustrlen(s)])) continue;
3858 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3859 d->name, ol->name, s);
3864 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3871 /*************************************************
3872 * Decode an error type for retries *
3873 *************************************************/
3875 /* This function is global because it is also called from the main
3876 program when testing retry information. It decodes strings such as "quota_7d"
3877 into numerical error codes.
3880 pp points to start of text
3881 p points past end of text
3882 basic_errno points to an int to receive the main error number
3883 more_errno points to an int to receive the secondary error data
3885 Returns: NULL if decoded correctly; else points to error text
3889 readconf_retry_error(const uschar *pp, const uschar *p,
3890 int *basic_errno, int *more_errno)
3893 const uschar *q = pp;
3894 while (q < p && *q != '_') q++;
3897 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3899 *basic_errno = ERRNO_EXIMQUOTA;
3900 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3901 return US"bad time value";
3904 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3906 *basic_errno = ECONNREFUSED;
3909 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3910 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3911 else return US"A or MX expected after \"refused\"";
3915 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3917 *basic_errno = ETIMEDOUT;
3921 int xlen = p - q - 1;
3922 const uschar *x = q + 1;
3924 static uschar *extras[] =
3925 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3926 static int values[] =
3927 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3929 for (i = 0; i < nelem(extras); i++)
3930 if (strncmpic(x, extras[i], xlen) == 0)
3932 *more_errno = values[i];
3936 if (i >= nelem(extras))
3937 if (strncmpic(x, US"DNS", xlen) == 0)
3938 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3939 "available in retry rules (it has never worked) - treated as "
3942 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3946 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3947 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3948 strncmpic(pp, US"data_4", 6) == 0)
3951 int x = 255; /* means "any 4xx code" */
3952 if (p != pp + 8) bad = TRUE; else
3954 int a = pp[6], b = pp[7];
3958 if (isdigit(b)) x += b - '0';
3959 else if (b == 'x') x += 100;
3962 else if (a != 'x' || b != 'x') bad = TRUE;
3966 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3967 "x is literal and d is any digit", pp);
3969 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3970 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3971 *more_errno = x << 8;
3974 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3975 strncmpic(q+1, US"failed", p-q-1) == 0)
3976 *basic_errno = ERRNO_AUTHFAIL;
3978 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3979 *basic_errno = ERRNO_SMTPCLOSED;
3981 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3982 *basic_errno = ERRNO_TLSREQUIRED;
3984 else if (strncmpic(pp, US"lookup", p - pp) == 0)
3985 *basic_errno = ERRNO_UNKNOWNHOST;
3987 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3988 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3996 /*************************************************
3997 * Read retry information *
3998 *************************************************/
4000 /* Each line of retry information contains:
4002 . A domain name pattern or an address pattern;
4004 . An error name, possibly with additional data, or *;
4006 . An optional sequence of retry items, each consisting of an identifying
4007 letter, a cutoff time, and optional parameters.
4009 All this is decoded and placed into a control block. */
4012 /* Subroutine to read an argument, preceded by a comma and terminated
4013 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4014 1 = fixed point number (returned *1000).
4017 paddr pointer to pointer to current character; updated
4018 type 0 => read a time; 1 => read a fixed point number
4020 Returns: time in seconds or fixed point number * 1000
4024 retry_arg(const uschar **paddr, int type)
4026 const uschar *p = *paddr;
4029 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4031 Uskip_whitespace(&p);
4033 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4035 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4036 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4041 case 0: return readconf_readtime(pp, *p, FALSE);
4042 case 1: return readconf_readfixed(pp, *p);
4044 return 0; /* Keep picky compilers happy */
4047 /* The function proper */
4050 readconf_retries(void)
4052 retry_config **chain = &retries;
4056 while ((p = get_config_line()))
4058 retry_rule **rchain;
4062 next = store_get(sizeof(retry_config), GET_UNTAINTED);
4065 chain = &(next->next);
4066 next->basic_errno = next->more_errno = 0;
4067 next->senders = NULL;
4069 rchain = &(next->rules);
4071 next->pattern = string_dequote(&p);
4072 Uskip_whitespace(&p);
4074 while (mac_isgraph(*p)) p++;
4075 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4076 "missing error type in retry rule");
4078 /* Test error names for things we understand. */
4080 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4081 &next->more_errno)))
4082 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4084 /* There may be an optional address list of senders to be used as another
4085 constraint on the rule. This was added later, so the syntax is a bit of a
4086 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4089 Uskip_whitespace(&p);
4090 if (Ustrncmp(p, "senders", 7) == 0)
4093 Uskip_whitespace(&p);
4094 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4095 "\"=\" expected after \"senders\" in retry rule");
4096 Uskip_whitespace(&p);
4097 next->senders = string_dequote(&p);
4100 /* Now the retry rules. Keep the maximum timeout encountered. */
4102 Uskip_whitespace(&p);
4106 retry_rule * rule = store_get(sizeof(retry_rule), GET_UNTAINTED);
4108 rchain = &(rule->next);
4110 rule->rule = toupper(*p++);
4111 rule->timeout = retry_arg(&p, 0);
4112 if (rule->timeout > retry_maximum_timeout)
4113 retry_maximum_timeout = rule->timeout;
4117 case 'F': /* Fixed interval */
4118 rule->p1 = retry_arg(&p, 0);
4121 case 'G': /* Geometrically increasing intervals */
4122 case 'H': /* Ditto, but with randomness */
4123 rule->p1 = retry_arg(&p, 0);
4124 rule->p2 = retry_arg(&p, 1);
4128 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4132 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4133 (rule->rule != 'F' && rule->p2 < 1000))
4134 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4135 "bad parameters for retry rule");
4137 if (Uskip_whitespace(&p) == ';')
4140 Uskip_whitespace(&p);
4143 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4150 /*************************************************
4151 * Initialize authenticators *
4152 *************************************************/
4154 /* Read the authenticators section of the configuration file.
4163 #ifndef DISABLE_PIPE_CONNECT
4167 readconf_driver_init(US"authenticator",
4168 (driver_instance **)(&auths), /* chain anchor */
4169 (driver_info *)auths_available, /* available drivers */
4170 sizeof(auth_info), /* size of info block */
4171 &auth_defaults, /* default values for generic options */
4172 sizeof(auth_instance), /* size of instance block */
4173 optionlist_auths, /* generic options */
4174 optionlist_auths_size);
4176 for (auth_instance * au = auths; au; au = au->next)
4178 if (!au->public_name)
4179 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4180 "the %s authenticator", au->name);
4182 for (auth_instance * bu = au->next; bu; bu = bu->next)
4183 if (strcmpic(au->public_name, bu->public_name) == 0)
4184 if ( au->client && bu->client
4185 || au->server && bu->server)
4186 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4187 "(%s and %s) have the same public name (%s)",
4188 au->client && bu->client ? US"client" : US"server",
4189 au->name, bu->name, au->public_name);
4190 #ifndef DISABLE_PIPE_CONNECT
4194 #ifndef DISABLE_PIPE_CONNECT
4195 f.smtp_in_early_pipe_no_auth = nauths > 16;
4200 /* For error messages, a string describing the config location associated
4201 with current processing. NULL if we are not in an authenticator. */
4204 authenticator_current_name(void)
4206 if (!authenticator_name) return NULL;
4207 return string_sprintf(" (authenticator %s, %s %d)", authenticator_name, driver_srcfile, driver_srcline);
4214 /*************************************************
4215 * Read ACL information *
4216 *************************************************/
4218 /* If this run of Exim is not doing something that involves receiving a
4219 message, we can just skip over the ACL information. No need to parse it.
4221 First, we have a function for acl_read() to call back to get the next line. We
4222 need to remember the line we passed, because at the end it will contain the
4223 name of the next ACL. */
4225 static uschar *acl_line;
4230 acl_line = get_config_line();
4235 /* Now the main function:
4244 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4247 acl_line = get_config_line();
4251 uschar name[EXIM_DRIVERNAME_MAX];
4254 const uschar * p = readconf_readname(name, sizeof(name), acl_line);
4256 if (isupper(*name) && *p == '=')
4258 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE);
4259 acl_line = get_config_line();
4263 if (*p != ':' || name[0] == 0)
4264 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4266 node = store_get_perm(sizeof(tree_node) + Ustrlen(name), name);
4267 Ustrcpy(node->name, name);
4268 if (!tree_insertnode(&acl_anchor, node))
4269 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4270 "there are two ACLs called \"%s\"", name);
4272 node->data.ptr = acl_read(acl_callback, &error);
4274 if (node->data.ptr == NULL && error != NULL)
4275 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4281 /*************************************************
4282 * Read configuration for local_scan() *
4283 *************************************************/
4285 /* This function is called after "begin local_scan" is encountered in the
4286 configuration file. If the local_scan() function allows for configuration
4287 options, we can process them. Otherwise, we expire in a panic.
4294 local_scan_init(void)
4296 #ifndef LOCAL_SCAN_HAS_OPTIONS
4297 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4298 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4302 while ((p = get_config_line()))
4303 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4304 NULL, US"local_scan option \"%s\" unknown");
4310 /*************************************************
4311 * Read rest of configuration (after main) *
4312 *************************************************/
4314 /* This function reads the rest of the runtime configuration, after the main
4315 configuration. It is called only when actually needed. Each subsequent section
4316 of the configuration starts with a line of the form
4320 where the name is "routers", "transports", etc. A section is terminated by
4321 hitting the next "begin" line, and the next name is left in next_section.
4322 Because it may confuse people as to whether the names are singular or plural,
4323 we add "s" if it's missing. There is always enough room in next_section for
4324 this. This function is basically just a switch.
4330 static uschar *section_list[] = {
4344 while(next_section[0] != 0)
4348 int last = nelem(section_list);
4350 int n = Ustrlen(next_section);
4352 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, US"s");
4356 int c = strcmpic(next_section, section_list[mid]);
4358 if (c > 0) first = mid + 1; else last = mid;
4360 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4361 "\"%.*s\" is not a known configuration section name", n, next_section);
4362 mid = (last + first)/2;
4366 if (((had ^= bit) & bit) == 0)
4367 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4368 "\"%.*s\" section is repeated in the configuration file", n,
4373 case 0: readconf_acl(); break;
4374 case 1: auths_init(); break;
4375 case 2: local_scan_init(); break;
4376 case 3: readconf_retries(); break;
4377 case 4: readconf_rewrites(); break;
4378 case 5: route_init(); break;
4379 case 6: transport_init(); break;
4383 (void)fclose(config_file);
4386 /* Init the storage for the pre-parsed config lines */
4388 readconf_save_config(const uschar *s)
4390 save_config_line(string_sprintf("# Exim Configuration (%s)",
4391 f.running_in_test_harness ? US"X" : s));
4395 save_config_position(const uschar *file, int line)
4397 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4400 /* Append a pre-parsed logical line to the config lines store,
4401 this operates on a global (static) list that holds all the pre-parsed
4402 config lines, we do no further processing here, output formatting and
4403 honouring of <hide> or macros will be done during output */
4406 save_config_line(const uschar* line)
4408 static config_line_item *current;
4409 config_line_item *next;
4411 next = (config_line_item*) store_get(sizeof(config_line_item), GET_UNTAINTED);
4412 next->line = string_copy(line);
4415 if (!config_lines) config_lines = next;
4416 else current->next = next;
4421 /* List the parsed config lines, care about nice formatting and
4422 hide the <hide> values unless we're the admin user */
4424 print_config(BOOL admin, BOOL terse)
4426 const int TS = terse ? 0 : 2;
4430 for (const config_line_item * i = config_lines; i; i = i->next)
4432 uschar * current, * p;
4434 if (r) store_reset(r);
4437 /* skip over to the first non-space */
4438 for (current = string_copy(i->line); *current && isspace(*current); ++current)
4444 /* Collapse runs of spaces. We stop this if we encounter one of the
4445 following characters: "'$, as this may indicate careful formatting */
4447 for (p = current; *p; p++) if (isspace(*p))
4450 if (*p != ' ') *p = ' ';
4452 for (next = p; isspace(*next); ++next)
4456 memmove(p+1, next, Ustrlen(next)+1);
4458 if (*next == '"' || *next == '\'' || *next == '$')
4463 if (current[0] == '#')
4466 /* begin lines are left aligned */
4467 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4469 if (!terse) puts("");
4474 /* router/acl/transport block names */
4475 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4477 if (!terse) puts("");
4478 printf("%*s%s\n", TS, "", current);
4482 /* hidden lines (all MACROS or lines prefixed with "hide") */
4484 && ( isupper(*current)
4485 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4489 if ((p = Ustrchr(current, '=')))
4492 printf("%*s%s= %s\n", indent, "", current, CCS hidden);
4494 /* e.g.: hide split_spool_directory */
4496 printf("%*s\n", indent, CCS hidden);
4500 /* rest is public */
4501 printf("%*s%s\n", indent, "", current);
4503 if (r) store_reset(r);
4506 #endif /*!MACRO_PREDEF*/
4509 /* End of readconf.c */